mundschenk-at / php-typography

src/class-dom.php

Doc Comments +2 added lines, -2 removed lines

@@ -160,8 +160,8 @@
 	 * Retrieves a character from the given \DOMNode.
 	 *
 	 * @param  \DOMNode $node         Required.
-	 * @param  [type]   $position     The position parameter for `substr`.
-	 * @param  [type]   $length       The length parameter for `substr`.
+	 * @param  integer   $position     The position parameter for `substr`.
+	 * @param  integer   $length       The length parameter for `substr`.
 	 * @param  callable $get_textnode A function to retrieve the \DOMText from the node.
 	 *
 	 * @return string The character or an empty string.

Spacing +68 added lines, -68 removed lines

@@ -48,13 +48,13 @@ 
 	 *
 	 * @return array
 	 */
-	public static function block_tags( $reset = false ) {
-		if ( empty( self::$block_tags ) || $reset ) {
+	public static function block_tags($reset = false) {
+		if (empty(self::$block_tags) || $reset) {
 			self::$block_tags = array_merge(
-				array_flip( array_filter( array_keys( \Masterminds\HTML5\Elements::$html5 ), function( $tag ) {
-					return \Masterminds\HTML5\Elements::isA( $tag, \Masterminds\HTML5\Elements::BLOCK_TAG );
-				} ) ),
-				array_flip( [ 'li', 'td', 'dt' ] ) // not included as "block tags" in current HTML5-PHP version.
+				array_flip(array_filter(array_keys(\Masterminds\HTML5\Elements::$html5), function($tag) {
+					return \Masterminds\HTML5\Elements::isA($tag, \Masterminds\HTML5\Elements::BLOCK_TAG);
+				} )),
+				array_flip(['li', 'td', 'dt']) // not included as "block tags" in current HTML5-PHP version.
 			);
 		}
 
@@ -69,11 +69,11 @@ 
 	 *
 	 * @return array An associative array in the form ( $spl_object_hash => $node ).
 	 */
-	public static function nodelist_to_array( \DOMNodeList $list ) {
+	public static function nodelist_to_array(\DOMNodeList $list) {
 		$out = [];
 
-		foreach ( $list as $node ) {
-			$out[ spl_object_hash( $node ) ] = $node;
+		foreach ($list as $node) {
+			$out[spl_object_hash($node)] = $node;
 		}
 
 		return $out;
@@ -87,10 +87,10 @@ 
 	 *
 	 * @return array An array of \DOMNode.
 	 */
-	public static function get_ancestors( \DOMNode $node ) {
+	public static function get_ancestors(\DOMNode $node) {
 		$result = [];
 
-		while ( ( $node = $node->parentNode ) && ( $node instanceof \DOMElement ) ) { // @codingStandardsIgnoreLine.
+		while (($node = $node->parentNode) && ($node instanceof \DOMElement)) { // @codingStandardsIgnoreLine.
 			$result[] = $node;
 		}
 
@@ -106,26 +106,26 @@ 
 	 *
 	 * @return boolean True if the element has any of the given class(es).
 	 */
-	public static function has_class( \DOMNode $tag, $classnames ) {
-		if ( $tag instanceof \DOMText ) {
+	public static function has_class(\DOMNode $tag, $classnames) {
+		if ($tag instanceof \DOMText) {
 			$tag = $tag->parentNode; // @codingStandardsIgnoreLine.
 		}
 
 		// Bail if we are not working with a tag or if there is no classname.
-		if ( ! ( $tag instanceof \DOMElement ) || empty( $classnames ) ) {
+		if ( ! ($tag instanceof \DOMElement) || empty($classnames)) {
 			return false;
 		}
 
 		// Ensure we always have an array of classnames.
-		if ( ! is_array( $classnames ) ) {
-			$classnames = [ $classnames ];
+		if ( ! is_array($classnames)) {
+			$classnames = [$classnames];
 		}
 
-		if ( $tag->hasAttribute( 'class' ) ) {
-			$tag_classes = array_flip( explode( ' ', $tag->getAttribute( 'class' ) ) );
+		if ($tag->hasAttribute('class')) {
+			$tag_classes = array_flip(explode(' ', $tag->getAttribute('class')));
 
-			foreach ( $classnames as $classname ) {
-				if ( isset( $tag_classes[ $classname ] ) ) {
+			foreach ($classnames as $classname) {
+				if (isset($tag_classes[$classname])) {
 					return true;
 				}
 			}
@@ -141,8 +141,8 @@ 
 	 *
 	 * @return string A single character (or the empty string).
 	 */
-	public static function get_prev_chr( \DOMNode $element ) {
-		return self::get_adjacent_chr( $element, -1, 1, [ __CLASS__, 'get_previous_textnode' ] );
+	public static function get_prev_chr(\DOMNode $element) {
+		return self::get_adjacent_chr($element, -1, 1, [__CLASS__, 'get_previous_textnode']);
 	}
 
 	/**
@@ -152,8 +152,8 @@ 
 	 *
 	 * @return string A single character (or the empty string).
 	 */
-	public static function get_next_chr( \DOMNode $element ) {
-		return self::get_adjacent_chr( $element, 0, 1, [ __CLASS__, 'get_next_textnode' ] );
+	public static function get_next_chr(\DOMNode $element) {
+		return self::get_adjacent_chr($element, 0, 1, [__CLASS__, 'get_next_textnode']);
 	}
 
 	/**
@@ -166,15 +166,15 @@ 
 	 *
 	 * @return string The character or an empty string.
 	 */
-	private static function get_adjacent_chr( \DOMNode $node, $position, $length, callable $get_textnode ) {
-		$textnode = $get_textnode( $node );
+	private static function get_adjacent_chr(\DOMNode $node, $position, $length, callable $get_textnode) {
+		$textnode = $get_textnode($node);
 
-		if ( isset( $textnode ) && isset( $textnode->data ) ) {
+		if (isset($textnode) && isset($textnode->data)) {
 			// Determine encoding.
-			$func = Strings::functions( $textnode->data );
+			$func = Strings::functions($textnode->data);
 
-			if ( ! empty( $func ) ) {
-				return preg_replace( '/\p{C}/Su', '', $func['substr']( $textnode->data, $position, $length ) );
+			if ( ! empty($func)) {
+				return preg_replace('/\p{C}/Su', '', $func['substr']($textnode->data, $position, $length));
 			}
 		}
 
@@ -188,11 +188,11 @@ 
 	 *
 	 * @return \DOMText|null Null if $element is a block-level element or no text sibling exists.
 	 */
-	public static function get_previous_textnode( \DOMNode $element = null ) {
-		return self::get_adjacent_textnode( function( &$node = null ) {
+	public static function get_previous_textnode(\DOMNode $element = null) {
+		return self::get_adjacent_textnode(function(&$node = null) {
 			$node = $node->previousSibling;
-			return self::get_last_textnode( $node );
-		}, __METHOD__, $element );
+			return self::get_last_textnode($node);
+		}, __METHOD__, $element);
 	}
 
 	/**
@@ -202,11 +202,11 @@ 
 	 *
 	 * @return \DOMText|null Null if $element is a block-level element or no text sibling exists.
 	 */
-	public static function get_next_textnode( \DOMNode $element = null ) {
-		return self::get_adjacent_textnode( function( &$node = null ) {
+	public static function get_next_textnode(\DOMNode $element = null) {
+		return self::get_adjacent_textnode(function(&$node = null) {
 			$node = $node->nextSibling;
-			return self::get_first_textnode( $node );
-		}, __METHOD__, $element );
+			return self::get_first_textnode($node);
+		}, __METHOD__, $element);
 	}
 
 	/**
@@ -218,22 +218,22 @@ 
 	 *
 	 * @return \DOMText|null Null if $element is a block-level element or no text sibling exists.
 	 */
-	private static function get_adjacent_textnode( callable $iterate, callable $get_adjacent_parent, \DOMNode $element = null ) {
-		if ( ! isset( $element ) ) {
+	private static function get_adjacent_textnode(callable $iterate, callable $get_adjacent_parent, \DOMNode $element = null) {
+		if ( ! isset($element)) {
 			return null;
-		} elseif ( $element instanceof \DOMElement && isset( self::$block_tags[ $element->tagName ] ) ) {
+		} elseif ($element instanceof \DOMElement && isset(self::$block_tags[$element->tagName])) {
 			return null;
 		}
 
 		$adjacent = null;
 		$node     = $element;
 
-		while ( ! empty( $node ) && empty( $adjacent ) ) {
-			$adjacent = $iterate( $node );
+		while ( ! empty($node) && empty($adjacent)) {
+			$adjacent = $iterate($node);
 		}
 
-		if ( empty( $adjacent ) ) {
-			$adjacent = $get_adjacent_parent( $element->parentNode );
+		if (empty($adjacent)) {
+			$adjacent = $get_adjacent_parent($element->parentNode);
 		}
 
 		return $adjacent;
@@ -247,15 +247,15 @@ 
 	 *
 	 * @return \DOMText|null The first child of type \DOMText, the element itself if it is of type \DOMText or null.
 	 */
-	public static function get_first_textnode( \DOMNode $element = null, $recursive = false ) {
-		return self::get_edge_textnode( function( \DOMNodeList $children, \DOMText &$first_textnode = null ) {
+	public static function get_first_textnode(\DOMNode $element = null, $recursive = false) {
+		return self::get_edge_textnode(function(\DOMNodeList $children, \DOMText & $first_textnode = null) {
 			$i = 0;
 
-			while ( $i < $children->length && empty( $first_textnode ) ) {
-				$first_textnode = self::get_first_textnode( $children->item( $i ), true );
+			while ($i < $children->length && empty($first_textnode)) {
+				$first_textnode = self::get_first_textnode($children->item($i), true);
 				$i++;
 			}
-		}, $element, $recursive );
+		}, $element, $recursive);
 	}
 
 	/**
@@ -266,15 +266,15 @@ 
 	 *
 	 * @return \DOMText|null The last child of type \DOMText, the element itself if it is of type \DOMText or null.
 	 */
-	public static function get_last_textnode( \DOMNode $element = null, $recursive = false ) {
-		return self::get_edge_textnode( function( \DOMNodeList $children, \DOMText &$last_textnode = null ) {
+	public static function get_last_textnode(\DOMNode $element = null, $recursive = false) {
+		return self::get_edge_textnode(function(\DOMNodeList $children, \DOMText & $last_textnode = null) {
 			$i = $children->length - 1;
 
-			while ( $i >= 0 && empty( $last_textnode ) ) {
-				$last_textnode = self::get_last_textnode( $children->item( $i ), true );
+			while ($i >= 0 && empty($last_textnode)) {
+				$last_textnode = self::get_last_textnode($children->item($i), true);
 				$i--;
 			}
-		}, $element, $recursive );
+		}, $element, $recursive);
 	}
 
 	/**
@@ -288,24 +288,24 @@ 
 	 *
 	 * @return \DOMText|null The last child of type \DOMText, the element itself if it is of type \DOMText or null.
 	 */
-	private static function get_edge_textnode( callable $iteration, \DOMNode $element = null, $recursive = false ) {
-		if ( ! isset( $element ) ) {
+	private static function get_edge_textnode(callable $iteration, \DOMNode $element = null, $recursive = false) {
+		if ( ! isset($element)) {
 			return null;
 		}
 
-		if ( $element instanceof \DOMText ) {
+		if ($element instanceof \DOMText) {
 			return $element;
-		} elseif ( ! $element instanceof \DOMElement ) {
+		} elseif ( ! $element instanceof \DOMElement) {
 			// Return null if $element is neither \DOMText nor \DOMElement.
 			return null;
-		} elseif ( $recursive && isset( self::$block_tags[ $element->tagName ] ) ) {
+		} elseif ($recursive && isset(self::$block_tags[$element->tagName])) {
 			return null;
 		}
 
 		$edge_textnode = null;
 
-		if ( $element->hasChildNodes() ) {
-			$iteration( $element->childNodes, $edge_textnode );
+		if ($element->hasChildNodes()) {
+			$iteration($element->childNodes, $edge_textnode);
 		}
 
 		return $edge_textnode;
@@ -318,13 +318,13 @@ 
 	 *
 	 * @return \DOMElement|null
 	 */
-	public static function get_block_parent( \DOMNode $element ) {
+	public static function get_block_parent(\DOMNode $element) {
 		$parent = $element->parentNode;
-		if ( ! $parent instanceof \DOMElement ) {
+		if ( ! $parent instanceof \DOMElement) {
 			return null;
 		}
 
-		while ( ! isset( self::$block_tags[ $parent->tagName ] ) && ! empty( $parent->parentNode ) && $parent->parentNode instanceof \DOMElement ) {
+		while ( ! isset(self::$block_tags[$parent->tagName]) && ! empty($parent->parentNode) && $parent->parentNode instanceof \DOMElement) {
 			$parent = $parent->parentNode;
 		}
 
@@ -338,10 +338,10 @@ 
 
 	 * @return string The tag name (or the empty string).
 	 */
-	public static function get_block_parent_name( \DOMNode $element ) {
-		$parent = self::get_block_parent( $element );
+	public static function get_block_parent_name(\DOMNode $element) {
+		$parent = self::get_block_parent($element);
 
-		if ( ! empty( $parent ) ) {
+		if ( ! empty($parent)) {
 			return $parent->tagName;
 		} else {
 			return '';