mundschenk-at / php-typography

src/class-re.php

Spacing +10 added lines, -10 removed lines

@@ -103,23 +103,23 @@ 
 	 *
 	 * @return string A list of top-level domains concatenated with '|'.
 	 */
-	private static function get_top_level_domains_from_file( $path ) {
+	private static function get_top_level_domains_from_file($path) {
 		$domains = [];
 
-		if ( file_exists( $path ) ) {
-			$file = new \SplFileObject( $path );
+		if (file_exists($path)) {
+			$file = new \SplFileObject($path);
 
-			while ( ! $file->eof() ) {
+			while ( ! $file->eof()) {
 				$line = $file->fgets();
 
-				if ( preg_match( '#^[a-zA-Z0-9][a-zA-Z0-9-]*$#', $line, $matches ) ) {
-					$domains[] = strtolower( $matches[0] );
+				if (preg_match('#^[a-zA-Z0-9][a-zA-Z0-9-]*$#', $line, $matches)) {
+					$domains[] = strtolower($matches[0]);
 				}
 			}
 		}
 
-		if ( count( $domains ) > 0 ) {
-			return implode( '|', $domains );
+		if (count($domains) > 0) {
+			return implode('|', $domains);
 		} else {
 			return 'ac|ad|aero|ae|af|ag|ai|al|am|an|ao|aq|arpa|ar|asia|as|at|au|aw|ax|az|ba|bb|bd|be|bf|bg|bh|biz|bi|bj|bm|bn|bo|br|bs|bt|bv|bw|by|bz|cat|ca|cc|cd|cf|cg|ch|ci|ck|cl|cm|cn|com|coop|co|cr|cu|cv|cx|cy|cz|de|dj|dk|dm|do|dz|ec|edu|ee|eg|er|es|et|eu|fi|fj|fk|fm|fo|fr|ga|gb|gd|ge|gf|gg|gh|gi|gl|gm|gn|gov|gp|gq|gr|gs|gt|gu|gw|gy|hk|hm|hn|hr|ht|hu|id|ie|il|im|info|int|in|io|iq|ir|is|it|je|jm|jobs|jo|jp|ke|kg|kh|ki|km|kn|kp|kr|kw|ky|kz|la|lb|lc|li|lk|lr|ls|lt|lu|lv|ly|ma|mc|md|me|mg|mh|mil|mk|ml|mm|mn|mobi|mo|mp|mq|mr|ms|mt|museum|mu|mv|mw|mx|my|mz|name|na|nc|net|ne|nf|ng|ni|nl|no|np|nr|nu|nz|om|org|pa|pe|pf|pg|ph|pk|pl|pm|pn|pro|pr|ps|pt|pw|py|qa|re|ro|rs|ru|rw|sa|sb|sc|sd|se|sg|sh|si|sj|sk|sl|sm|sn|so|sr|st|su|sv|sy|sz|tc|td|tel|tf|tg|th|tj|tk|tl|tm|tn|to|tp|travel|tr|tt|tv|tw|tz|ua|ug|uk|um|us|uy|uz|va|vc|ve|vg|vi|vn|vu|wf|ws|ye|yt|yu|za|zm|zw';
 		}
@@ -131,9 +131,9 @@ 
 	 * @return string
 	 */
 	public static function top_level_domains() {
-		if ( empty( self::$top_level_domains_pattern ) ) {
+		if (empty(self::$top_level_domains_pattern)) {
 			// Initialize valid top level domains from IANA list.
-			self::$top_level_domains_pattern = self::get_top_level_domains_from_file( __DIR__ . '/IANA/tlds-alpha-by-domain.txt' );
+			self::$top_level_domains_pattern = self::get_top_level_domains_from_file(__DIR__ . '/IANA/tlds-alpha-by-domain.txt');
 		}
 
 		return self::$top_level_domains_pattern;

src/settings/class-simple-quotes.php

Spacing +1 added lines, -1 removed lines

@@ -55,7 +55,7 @@
 	 * @param string $open  Opening quote character(s).
 	 * @param string $close Closing quote character(s).
 	 */
-	public function __construct( $open, $close ) {
+	public function __construct($open, $close) {
 		$this->open  = $open;
 		$this->close = $close;
 	}

src/settings/class-simple-dashes.php

Spacing +1 added lines, -1 removed lines

@@ -71,7 +71,7 @@
 	 * @param string $interval            The dash character used for interval dashes.
 	 * @param string $interval_space      The space character used around interval dashes.
 	 */
-	public function __construct( $parenthetical, $parenthetical_space, $interval, $interval_space ) {
+	public function __construct($parenthetical, $parenthetical_space, $interval, $interval_space) {
 		$this->parenthetical_dash  = $parenthetical;
 		$this->parenthetical_space = $parenthetical_space;
 		$this->interval_dash       = $interval;

src/settings/class-quote-style.php

Spacing +5 added lines, -5 removed lines

@@ -149,15 +149,15 @@
 	 *
 	 * @return Quotes|null Returns null in case of an invalid $style parameter.
 	 */
-	public static function get_styled_quotes( $style, Settings $settings ) {
-		if ( isset( self::$styles[ $style ] ) ) {
-			return new Simple_Quotes( self::$styles[ $style ][ self::_OPEN ], self::$styles[ $style ][ self::_CLOSE ] );
+	public static function get_styled_quotes($style, Settings $settings) {
+		if (isset(self::$styles[$style])) {
+			return new Simple_Quotes(self::$styles[$style][self::_OPEN], self::$styles[$style][self::_CLOSE]);
 		}
 
-		if ( self::DOUBLE_GUILLEMETS_FRENCH === $style ) {
+		if (self::DOUBLE_GUILLEMETS_FRENCH === $style) {
 			$space = $settings->no_break_narrow_space();
 
-			return new Simple_Quotes( U::GUILLEMET_OPEN . $space, $space . U::GUILLEMET_CLOSE );
+			return new Simple_Quotes(U::GUILLEMET_OPEN . $space, $space . U::GUILLEMET_CLOSE);
 		}
 
 		return null;

Doc Comments +1 added lines, -1 removed lines

@@ -147,7 +147,7 @@
 	 * @param string   $style    The quote style.
 	 * @param Settings $settings The current settings.
 	 *
-	 * @return Quotes|null Returns null in case of an invalid $style parameter.
+	 * @return Simple_Quotes|null Returns null in case of an invalid $style parameter.
 	 */
 	public static function get_styled_quotes( $style, Settings $settings ) {
 		if ( isset( self::$styles[ $style ] ) ) {

src/class-hyphenator.php

Spacing +72 added lines, -72 removed lines

@@ -92,14 +92,14 @@ 
 	 * @param string|null $language   Optional. Short-form language name. Default null.
 	 * @param array       $exceptions Optional. Custom hyphenation exceptions. Default empty array.
 	 */
-	public function __construct( $language = null, array $exceptions = [] ) {
+	public function __construct($language = null, array $exceptions = []) {
 
-		if ( ! empty( $language ) ) {
-			$this->set_language( $language );
+		if ( ! empty($language)) {
+			$this->set_language($language);
 		}
 
-		if ( ! empty( $exceptions ) ) {
-			$this->set_custom_exceptions( $exceptions );
+		if ( ! empty($exceptions)) {
+			$this->set_custom_exceptions($exceptions);
 		}
 	}
 
@@ -108,31 +108,31 @@ 
 	 *
 	 * @param array $exceptions Optional. An array of words with all hyphenation points marked with a hard hyphen. Default empty array.
 	 */
-	public function set_custom_exceptions( array $exceptions = [] ) {
-		if ( empty( $exceptions ) && empty( $this->custom_exceptions ) ) {
+	public function set_custom_exceptions(array $exceptions = []) {
+		if (empty($exceptions) && empty($this->custom_exceptions)) {
 			return; // Nothing to do at all.
 		}
 
 		// Calculate hash & check against previous exceptions.
-		$new_hash = self::get_object_hash( $exceptions );
-		if ( $this->custom_exceptions_hash === $new_hash ) {
+		$new_hash = self::get_object_hash($exceptions);
+		if ($this->custom_exceptions_hash === $new_hash) {
 			return; // No need to update exceptions.
 		}
 
 		// Do our thing.
 		$exception_keys = [];
-		foreach ( $exceptions as $exception ) {
-			$func = Strings::functions( $exception );
-			if ( empty( $func ) ) {
+		foreach ($exceptions as $exception) {
+			$func = Strings::functions($exception);
+			if (empty($func)) {
 				continue; // unknown encoding, abort.
 			}
 
-			$exception = $func['strtolower']( $exception );
-			$exception_keys[ $exception ] = preg_replace( "#-#{$func['u']}", '', $exception );
+			$exception = $func['strtolower']($exception);
+			$exception_keys[$exception] = preg_replace("#-#{$func['u']}", '', $exception);
 		}
 
 		// Update exceptions.
-		$this->custom_exceptions      = array_flip( $exception_keys );
+		$this->custom_exceptions      = array_flip($exception_keys);
 		$this->custom_exceptions_hash = $new_hash;
 
 		// Force remerging of patgen and custom exception patterns.
@@ -146,8 +146,8 @@ 
 	 *
 	 * @return string
 	 */
-	protected static function get_object_hash( $object ) {
-		return md5( json_encode( $object ), false );
+	protected static function get_object_hash($object) {
+		return md5(json_encode($object), false);
 	}
 
 	/**
@@ -157,23 +157,23 @@ 
 	 *
 	 * @return bool Whether loading the pattern file was successful.
 	 */
-	public function set_language( $lang = 'en-US' ) {
-		if ( isset( $this->language ) && $this->language === $lang ) {
+	public function set_language($lang = 'en-US') {
+		if (isset($this->language) && $this->language === $lang) {
 			return true; // Bail out, no need to do anything.
 		}
 
 		$success = false;
-		$language_file_name = dirname( __FILE__ ) . '/lang/' . $lang . '.json';
+		$language_file_name = dirname(__FILE__) . '/lang/' . $lang . '.json';
 
-		if ( file_exists( $language_file_name ) ) {
-			$raw_language_file = file_get_contents( $language_file_name );
+		if (file_exists($language_file_name)) {
+			$raw_language_file = file_get_contents($language_file_name);
 
-			if ( false !== $raw_language_file ) {
-				$language_file = json_decode( $raw_language_file, true );
+			if (false !== $raw_language_file) {
+				$language_file = json_decode($raw_language_file, true);
 
-				if ( false !== $language_file ) {
+				if (false !== $language_file) {
 					$this->language           = $lang;
-					$this->pattern_trie       = Trie_Node::build_trie( $language_file['patterns'] );
+					$this->pattern_trie       = Trie_Node::build_trie($language_file['patterns']);
 					$this->pattern_exceptions = $language_file['exceptions'];
 
 					$success = true;
@@ -182,7 +182,7 @@ 
 		}
 
 		// Clean up.
-		if ( ! $success ) {
+		if ( ! $success) {
 			$this->language = null;
 			$this->pattern_trie = null;
 			$this->pattern_exceptions = [];
@@ -206,18 +206,18 @@ 
 	 *
 	 * @return array The modified text tokens.
 	 */
-	public function hyphenate( $parsed_text_tokens, $hyphen = '-', $hyphenate_title_case = false, $min_length = 2, $min_before = 2, $min_after = 2 ) {
-		if ( empty( $min_length ) || empty( $min_before ) || ! isset( $this->pattern_trie ) || ! isset( $this->pattern_exceptions ) ) {
+	public function hyphenate($parsed_text_tokens, $hyphen = '-', $hyphenate_title_case = false, $min_length = 2, $min_before = 2, $min_after = 2) {
+		if (empty($min_length) || empty($min_before) || ! isset($this->pattern_trie) || ! isset($this->pattern_exceptions)) {
 			return $parsed_text_tokens;
 		}
 
 		// Make sure we have full exceptions list.
-		if ( ! isset( $this->merged_exception_patterns ) ) {
+		if ( ! isset($this->merged_exception_patterns)) {
 			$this->merge_hyphenation_exceptions();
 		}
 
-		foreach ( $parsed_text_tokens as $key => $text_token ) {
-			$parsed_text_tokens[ $key ] = $text_token->with_value( $this->hyphenate_word( $text_token->value, $hyphen, $hyphenate_title_case, $min_length, $min_before, $min_after ) );
+		foreach ($parsed_text_tokens as $key => $text_token) {
+			$parsed_text_tokens[$key] = $text_token->with_value($this->hyphenate_word($text_token->value, $hyphen, $hyphenate_title_case, $min_length, $min_before, $min_after));
 		}
 
 		return $parsed_text_tokens;
@@ -235,48 +235,48 @@ 
 	 *
 	 * @return string
 	 */
-	protected function hyphenate_word( $word, $hyphen, $hyphenate_title_case, $min_length, $min_before, $min_after ) {
+	protected function hyphenate_word($word, $hyphen, $hyphenate_title_case, $min_length, $min_before, $min_after) {
 		// Quickly reference string functions according to encoding.
-		$func = Strings::functions( $word );
-		if ( empty( $func ) ) {
+		$func = Strings::functions($word);
+		if (empty($func)) {
 			return $word; // unknown encoding, abort.
 		}
 
 		// Check word length.
-		$word_length = $func['strlen']( $word );
-		if ( $word_length < $min_length ) {
+		$word_length = $func['strlen']($word);
+		if ($word_length < $min_length) {
 			return $word;
 		}
 
 		// Trie lookup requires a lowercase search term.
-		$the_key = $func['strtolower']( $word );
+		$the_key = $func['strtolower']($word);
 
 		// If this is a capitalized word, and settings do not allow hyphenation of such, abort!
 		// Note: This is different than uppercase words, where we are looking for title case.
-		if ( ! $hyphenate_title_case && $func['substr']( $the_key, 0, 1 ) !== $func['substr']( $word, 0, 1 ) ) {
+		if ( ! $hyphenate_title_case && $func['substr']($the_key, 0, 1) !== $func['substr']($word, 0, 1)) {
 			return $word;
 		}
 
 		// Give exceptions preference.
-		if ( isset( $this->merged_exception_patterns[ $the_key ] ) ) {
-			$word_pattern = $this->merged_exception_patterns[ $the_key ];
+		if (isset($this->merged_exception_patterns[$the_key])) {
+			$word_pattern = $this->merged_exception_patterns[$the_key];
 		}
 
 		// Lookup word pattern if there is no exception.
-		if ( ! isset( $word_pattern ) ) {
-			$word_pattern = $this->lookup_word_pattern( $the_key, $func['strlen'], $func['str_split'] );
+		if ( ! isset($word_pattern)) {
+			$word_pattern = $this->lookup_word_pattern($the_key, $func['strlen'], $func['str_split']);
 		}
 
 		// Add hyphen character based on $word_pattern.
-		$word_parts      = $func['str_split']( $word, 1 );
+		$word_parts      = $func['str_split']($word, 1);
 		$hyphenated_word = '';
 
-		for ( $i = 0; $i < $word_length; $i++ ) {
-			if ( isset( $word_pattern[ $i ] ) && self::is_odd( $word_pattern[ $i ] ) && ( $i >= $min_before) && ( $i <= $word_length - $min_after ) ) {
+		for ($i = 0; $i < $word_length; $i++) {
+			if (isset($word_pattern[$i]) && self::is_odd($word_pattern[$i]) && ($i >= $min_before) && ($i <= $word_length - $min_after)) {
 				$hyphenated_word .= $hyphen;
 			}
 
-			$hyphenated_word .= $word_parts[ $i ];
+			$hyphenated_word .= $word_parts[$i];
 		}
 
 		return $hyphenated_word;
@@ -291,33 +291,33 @@ 
 	 *
 	 * @return array The hyphenation pattern.
 	 */
-	protected function lookup_word_pattern( $key, callable $strlen, callable $str_split ) {
+	protected function lookup_word_pattern($key, callable $strlen, callable $str_split) {
 		// Add underscores to make out-of-index checks unnecessary,
 		// also hyphenation is done in lower case.
 		$search        = '_' . $key . '_';
-		$search_length = $strlen( $search );
-		$chars         = $str_split( $search );
+		$search_length = $strlen($search);
+		$chars         = $str_split($search);
 		$word_pattern  = [];
 
-		for ( $start = 0; $start < $search_length; ++$start ) {
+		for ($start = 0; $start < $search_length; ++$start) {
 			// Start from the trie root node.
 			$node = $this->pattern_trie;
 
 			// Walk through the trie while storing detected patterns.
-			for ( $step = $start; $step < $search_length; ++$step ) {
+			for ($step = $start; $step < $search_length; ++$step) {
 				// No further path in the trie.
-				if ( ! $node->exists( $chars[ $step ] ) ) {
+				if ( ! $node->exists($chars[$step])) {
 					break;
 				}
 
 				// Look for next character.
-				$node = $node->get_node( $chars[ $step ] );
+				$node = $node->get_node($chars[$step]);
 
 				// Merge different offset values and keep maximum.
-				foreach ( $node->offsets() as $pattern_offset ) {
+				foreach ($node->offsets() as $pattern_offset) {
 					$value  = $pattern_offset[0];
 					$offset = $pattern_offset[1] + $start - 1;
-					$word_pattern[ $offset ] = isset( $word_pattern[ $offset ] ) ? max( $word_pattern[ $offset ], $value ) : $value;
+					$word_pattern[$offset] = isset($word_pattern[$offset]) ? max($word_pattern[$offset], $value) : $value;
 				}
 			}
 		}
@@ -333,18 +333,18 @@ 
 		$exceptions = [];
 
 		// Merge custom and language specific word hyphenations.
-		if ( ! empty( $this->pattern_exceptions ) && ! empty( $this->custom_exceptions ) ) {
-			$exceptions = array_merge( $this->custom_exceptions, $this->pattern_exceptions );
-		} elseif ( ! empty( $this->pattern_exceptions ) ) {
+		if ( ! empty($this->pattern_exceptions) && ! empty($this->custom_exceptions)) {
+			$exceptions = array_merge($this->custom_exceptions, $this->pattern_exceptions);
+		} elseif ( ! empty($this->pattern_exceptions)) {
 			$exceptions = $this->pattern_exceptions;
-		} elseif ( ! empty( $this->custom_exceptions ) ) {
+		} elseif ( ! empty($this->custom_exceptions)) {
 			$exceptions = $this->custom_exceptions;
 		}
 
 		// Update patterns as well.
 		$exception_patterns = [];
-		foreach ( $exceptions as $exception_key => $exception ) {
-			$exception_patterns[ $exception_key ] = self::convert_hyphenation_exception_to_pattern( $exception );
+		foreach ($exceptions as $exception_key => $exception) {
+			$exception_patterns[$exception_key] = self::convert_hyphenation_exception_to_pattern($exception);
 		}
 
 		$this->merged_exception_patterns = $exception_patterns;
@@ -357,22 +357,22 @@ 
 	 *
 	 * @return array|null Returns the hyphenation pattern or null if `$exception` is using an invalid encoding.
 	 */
-	protected static function convert_hyphenation_exception_to_pattern( $exception ) {
-		$func = Strings::functions( $exception );
-		if ( empty( $func ) ) {
+	protected static function convert_hyphenation_exception_to_pattern($exception) {
+		$func = Strings::functions($exception);
+		if (empty($func)) {
 			return null; // unknown encoding, abort.
 		}
 
 		// Set the word_pattern - this method keeps any contextually important capitalization.
-		$lowercase_hyphened_word_parts  = $func['str_split']( $exception, 1 );
-		$lowercase_hyphened_word_length = $func['strlen']( $exception );
+		$lowercase_hyphened_word_parts  = $func['str_split']($exception, 1);
+		$lowercase_hyphened_word_length = $func['strlen']($exception);
 
 		$word_pattern = [];
 		$index = 0;
 
-		for ( $i = 0; $i < $lowercase_hyphened_word_length; $i++ ) {
-			if ( '-' === $lowercase_hyphened_word_parts[ $i ] ) {
-				$word_pattern[ $index ] = 9;
+		for ($i = 0; $i < $lowercase_hyphened_word_length; $i++) {
+			if ('-' === $lowercase_hyphened_word_parts[$i]) {
+				$word_pattern[$index] = 9;
 			} else {
 				$index++;
 			}
@@ -388,7 +388,7 @@ 
 	 *
 	 * @return bool true if $number is odd, false if it is even.
 	 */
-	protected static function is_odd( $number ) {
-		return (bool) ( $number % 2 );
+	protected static function is_odd($number) {
+		return (bool) ($number % 2);
 	}
 }

src/fixes/class-node-fix.php

Spacing +1 added lines, -1 removed lines

@@ -46,7 +46,7 @@
 	 *
 	 * @return void
 	 */
-	public function apply( \DOMText $textnode, Settings $settings, $is_title = false );
+	public function apply(\DOMText $textnode, Settings $settings, $is_title = false);
 
 	/**
 	 * Determines whether the fix should be applied to (RSS) feeds.

src/fixes/class-token-fix.php

Spacing +1 added lines, -1 removed lines

@@ -52,7 +52,7 @@
 	 *
 	 * @return array An array of tokens.
 	 */
-	public function apply( array $tokens, Settings $settings, $is_title = false, \DOMText $textnode = null );
+	public function apply(array $tokens, Settings $settings, $is_title = false, \DOMText $textnode = null);
 
 	/**
 	 * Determines whether the fix should be applied to (RSS) feeds.

src/fixes/node-fixes/class-numbered-abbreviation-spacing-fix.php

Spacing +2 added lines, -2 removed lines

@@ -80,7 +80,7 @@
 	 *
 	 * @param bool $feed_compatible Optional. Default false.
 	 */
-	public function __construct( $feed_compatible = false ) {
-		parent::__construct( self::REGEX, self::REPLACEMENT, self::SETTING, $feed_compatible );
+	public function __construct($feed_compatible = false) {
+		parent::__construct(self::REGEX, self::REPLACEMENT, self::SETTING, $feed_compatible);
 	}
 }

src/fixes/node-fixes/class-single-character-word-spacing-fix.php

Spacing +8 added lines, -8 removed lines

@@ -56,25 +56,25 @@
 	 * @param Settings $settings Required.
 	 * @param bool     $is_title Optional. Default false.
 	 */
-	public function apply( \DOMText $textnode, Settings $settings, $is_title = false ) {
-		if ( empty( $settings['singleCharacterWordSpacing'] ) ) {
+	public function apply(\DOMText $textnode, Settings $settings, $is_title = false) {
+		if (empty($settings['singleCharacterWordSpacing'])) {
 			return;
 		}
 
 		// Add $next_character and $previous_character for context.
-		$previous_character = DOM::get_prev_chr( $textnode );
-		if ( '' !== $previous_character ) {
+		$previous_character = DOM::get_prev_chr($textnode);
+		if ('' !== $previous_character) {
 			$textnode->data = $previous_character . $textnode->data;
 		}
 
-		$next_character = DOM::get_next_chr( $textnode );
-		if ( '' !== $next_character ) {
+		$next_character = DOM::get_next_chr($textnode);
+		if ('' !== $next_character) {
 			$textnode->data = $textnode->data . $next_character;
 		}
 
-		$textnode->data = preg_replace( self::REGEX, '$1$2' . U::NO_BREAK_SPACE, $textnode->data );
+		$textnode->data = preg_replace(self::REGEX, '$1$2' . U::NO_BREAK_SPACE, $textnode->data);
 
 		// If we have adjacent characters remove them from the text.
-		$textnode->data = self::remove_adjacent_characters( $textnode->data, $previous_character, $next_character );
+		$textnode->data = self::remove_adjacent_characters($textnode->data, $previous_character, $next_character);
 	}
 }