enmi-conf.org: comparison wp/wp-includes/class-wp-token-map.php

equal deleted inserted replaced

-:48c4eec2b7e6
+:8c2e4d02f4ef
 	 * @param int   $key_length Determines the group key length. Leave at the default value
 	 *                          of 2 unless there's an empirical reason to change it.
 	 *
 	 * @return WP_Token_Map|null Token map, unless unable to create it.
 	 */
-	public static function from_array( $mappings, $key_length = 2 ) {
+	public static function from_array( array $mappings, int $key_length = 2 ): ?WP_Token_Map {
 		$map             = new WP_Token_Map();
 		$map->key_length = $key_length;
 		// Start by grouping words.
 		 */
 		usort( $shorts, 'WP_Token_Map::longest_first_then_alphabetical' );
 		foreach ( $groups as $group_key => $group ) {
 			usort(
 				$groups[ $group_key ],
-				static function ( $a, $b ) {
+				static function ( array $a, array $b ): int {
 					return self::longest_first_then_alphabetical( $a[0], $b[0] );
 				}
 			);
 		}
 	 *     @type array  $small_mappings  Small word mappings.
 	 * }
 	 *
 	 * @return WP_Token_Map Map with precomputed data loaded.
 	 */
-	public static function from_precomputed_table( $state ) {
+	public static function from_precomputed_table( $state ): ?WP_Token_Map {
 		$has_necessary_state = isset(
 			$state['storage_version'],
 			$state['key_length'],
 			$state['groups'],
 			$state['large_words'],
 	 *
 	 * @param string $word             Determine if this word is a lookup key in the map.
 	 * @param string $case_sensitivity Optional. Pass 'ascii-case-insensitive' to ignore ASCII case when matching. Default 'case-sensitive'.
 	 * @return bool Whether there's an entry for the given word in the map.
 	 */
-	public function contains( $word, $case_sensitivity = 'case-sensitive' ) {
+	public function contains( string $word, string $case_sensitivity = 'case-sensitive' ): bool {
 		$ignore_case = 'ascii-case-insensitive' === $case_sensitivity;
 		if ( $this->key_length >= strlen( $word ) ) {
 			if ( 0 === strlen( $this->small_words ) ) {
 				return false;
 	 *         $output .= "{$prefix}{$smily}";
 	 *     }
 	 *
 	 * @since 6.6.0
 	 *
-	 * @param string  $text                       String in which to search for a lookup key.
+	 * @param string   $text                       String in which to search for a lookup key.
-	 * @param int     $offset                     Optional. How many bytes into the string where the lookup key ought to start. Default 0.
+	 * @param int      $offset                     Optional. How many bytes into the string where the lookup key ought to start. Default 0.
-	 * @param ?int    &$matched_token_byte_length Optional. Holds byte-length of found token matched, otherwise not set. Default null.
+	 * @param int|null &$matched_token_byte_length Optional. Holds byte-length of found token matched, otherwise not set. Default null.
-	 * @param string  $case_sensitivity           Optional. Pass 'ascii-case-insensitive' to ignore ASCII case when matching. Default 'case-sensitive'.
+	 * @param string   $case_sensitivity           Optional. Pass 'ascii-case-insensitive' to ignore ASCII case when matching. Default 'case-sensitive'.
+	 *
 	 * @return string|null Mapped value of lookup key if found, otherwise `null`.
 	 */
-	public function read_token( $text, $offset = 0, &$matched_token_byte_length = null, $case_sensitivity = 'case-sensitive' ) {
+	public function read_token( string $text, int $offset = 0, &$matched_token_byte_length = null, $case_sensitivity = 'case-sensitive' ): ?string {
 		$ignore_case = 'ascii-case-insensitive' === $case_sensitivity;
 		$text_length = strlen( $text );
 		// Search for a long word first, if the text is long enough, and if that fails, a short one.
 		if ( $text_length > $this->key_length ) {
 	}
 	/**
 	 * Finds a match for a short word at the index.
 	 *
-	 * @since 6.6.0.
+	 * @since 6.6.0
 	 *
-	 * @param string $text                       String in which to search for a lookup key.
+	 * @param string   $text                       String in which to search for a lookup key.
-	 * @param int    $offset                     Optional. How many bytes into the string where the lookup key ought to start. Default 0.
+	 * @param int      $offset                     Optional. How many bytes into the string where the lookup key ought to start. Default 0.
-	 * @param ?int   &$matched_token_byte_length Optional. Holds byte-length of found lookup key if matched, otherwise not set. Default null.
+	 * @param int|null &$matched_token_byte_length Optional. Holds byte-length of found lookup key if matched, otherwise not set. Default null.
-	 * @param string $case_sensitivity           Optional. Pass 'ascii-case-insensitive' to ignore ASCII case when matching. Default 'case-sensitive'.
+	 * @param string   $case_sensitivity           Optional. Pass 'ascii-case-insensitive' to ignore ASCII case when matching. Default 'case-sensitive'.
+	 *
 	 * @return string|null Mapped value of lookup key if found, otherwise `null`.
 	 */
-	private function read_small_token( $text, $offset, &$matched_token_byte_length, $case_sensitivity = 'case-sensitive' ) {
+	private function read_small_token( string $text, int $offset = 0, &$matched_token_byte_length = null, $case_sensitivity = 'case-sensitive' ): ?string {
 		$ignore_case  = 'ascii-case-insensitive' === $case_sensitivity;
 		$small_length = strlen( $this->small_words );
 		$search_text  = substr( $text, $offset, $this->key_length );
 		if ( $ignore_case ) {
 			$search_text = strtoupper( $search_text );
 	 *         ':?' => '😕',
 	 *     );
 	 *
 	 * @return array The lookup key/substitution values as an associate array.
 	 */
-	public function to_array() {
+	public function to_array(): array {
 		$tokens = array();
 		$at            = 0;
 		$small_mapping = 0;
 		$small_length  = strlen( $this->small_words );
 	 * @since 6.6.0
 	 *
 	 * @param string $indent Optional. Use this string for indentation, or rely on the default horizontal tab character. Default "\t".
 	 * @return string Value which can be pasted into a PHP source file for quick loading of table.
 	 */
-	public function precomputed_php_source_table( $indent = "\t" ) {
+	public function precomputed_php_source_table( string $indent = "\t" ): string {
 		$i1 = $indent;
 		$i2 = $i1 . $indent;
 		$i3 = $i2 . $indent;
 		$class_version = self::STORAGE_VERSION;
 	 *
 	 * @param string $a First string to compare.
 	 * @param string $b Second string to compare.
 	 * @return int -1 or lower if `$a` is less than `$b`; 1 or greater if `$a` is greater than `$b`, and 0 if they are equal.
 	 */
-	private static function longest_first_then_alphabetical( $a, $b ) {
+	private static function longest_first_then_alphabetical( string $a, string $b ): int {
 		if ( $a === $b ) {
 			return 0;
 		}
 		$length_a = strlen( $a );

changeset 22	8c2e4d02f4ef
parent 21	48c4eec2b7e6