enmi-conf.org: comparison wp/wp-includes/class-wp-block-parser.php

equal deleted inserted replaced

-:7b1b88e27a20
+:48c4eec2b7e6
 /**
 * Block Serialization Parser
 *
 * @package WordPress
 */
-/**
-* Class WP_Block_Parser_Block
-*
-* Holds the block structure in memory
-*
-* @since 5.0.0
-*/
-class WP_Block_Parser_Block {
-	/**
-	 * Name of block
-	 *
-	 * @example "core/paragraph"
-	 *
-	 * @since 5.0.0
-	 * @var string
-	 */
-	public $blockName;
-	/**
-	 * Optional set of attributes from block comment delimiters
-	 *
-	 * @example null
-	 * @example array( 'columns' => 3 )
-	 *
-	 * @since 5.0.0
-	 * @var array|null
-	 */
-	public $attrs;
-	/**
-	 * List of inner blocks (of this same class)
-	 *
-	 * @since 5.0.0
-	 * @var WP_Block_Parser_Block[]
-	 */
-	public $innerBlocks;
-	/**
-	 * Resultant HTML from inside block comment delimiters
-	 * after removing inner blocks
-	 *
-	 * @example "...Just <!-- wp:test /--> testing..." -> "Just testing..."
-	 *
-	 * @since 5.0.0
-	 * @var string
-	 */
-	public $innerHTML;
-	/**
-	 * List of string fragments and null markers where inner blocks were found
-	 *
-	 * @example array(
-	 *   'innerHTML'    => 'BeforeInnerAfter',
-	 *   'innerBlocks'  => array( block, block ),
-	 *   'innerContent' => array( 'Before', null, 'Inner', null, 'After' ),
-	 * )
-	 *
-	 * @since 4.2.0
-	 * @var array
-	 */
-	public $innerContent;
-	/**
-	 * Constructor.
-	 *
-	 * Will populate object properties from the provided arguments.
-	 *
-	 * @since 5.0.0
-	 *
-	 * @param string $name         Name of block.
-	 * @param array  $attrs        Optional set of attributes from block comment delimiters.
-	 * @param array  $innerBlocks  List of inner blocks (of this same class).
-	 * @param string $innerHTML    Resultant HTML from inside block comment delimiters after removing inner blocks.
-	 * @param array  $innerContent List of string fragments and null markers where inner blocks were found.
-	 */
-	function __construct( $name, $attrs, $innerBlocks, $innerHTML, $innerContent ) {
-		$this->blockName    = $name;
-		$this->attrs        = $attrs;
-		$this->innerBlocks  = $innerBlocks;
-		$this->innerHTML    = $innerHTML;
-		$this->innerContent = $innerContent;
-	}
-}
-/**
-* Class WP_Block_Parser_Frame
-*
-* Holds partial blocks in memory while parsing
-*
-* @internal
-* @since 5.0.0
-*/
-class WP_Block_Parser_Frame {
-	/**
-	 * Full or partial block
-	 *
-	 * @since 5.0.0
-	 * @var WP_Block_Parser_Block
-	 */
-	public $block;
-	/**
-	 * Byte offset into document for start of parse token
-	 *
-	 * @since 5.0.0
-	 * @var int
-	 */
-	public $token_start;
-	/**
-	 * Byte length of entire parse token string
-	 *
-	 * @since 5.0.0
-	 * @var int
-	 */
-	public $token_length;
-	/**
-	 * Byte offset into document for after parse token ends
-	 * (used during reconstruction of stack into parse production)
-	 *
-	 * @since 5.0.0
-	 * @var int
-	 */
-	public $prev_offset;
-	/**
-	 * Byte offset into document where leading HTML before token starts
-	 *
-	 * @since 5.0.0
-	 * @var int
-	 */
-	public $leading_html_start;
-	/**
-	 * Constructor
-	 *
-	 * Will populate object properties from the provided arguments.
-	 *
-	 * @since 5.0.0
-	 *
-	 * @param WP_Block_Parser_Block $block              Full or partial block.
-	 * @param int                   $token_start        Byte offset into document for start of parse token.
-	 * @param int                   $token_length       Byte length of entire parse token string.
-	 * @param int                   $prev_offset        Byte offset into document for after parse token ends.
-	 * @param int                   $leading_html_start Byte offset into document where leading HTML before token starts.
-	 */
-	function __construct( $block, $token_start, $token_length, $prev_offset = null, $leading_html_start = null ) {
-		$this->block              = $block;
-		$this->token_start        = $token_start;
-		$this->token_length       = $token_length;
-		$this->prev_offset        = isset( $prev_offset ) ? $prev_offset : $token_start + $token_length;
-		$this->leading_html_start = $leading_html_start;
-	}
-}
 /**
 * Class WP_Block_Parser
 *
 * Parses a document and constructs a list of parsed block objects
 	 * @var WP_Block_Parser_Frame[]
 	 */
 	public $stack;
 	/**
-	 * Empty associative array, here due to PHP quirks
-	 *
-	 * @since 4.4.0
-	 * @var array empty associative array
-	 */
-	public $empty_attrs;
-	/**
 	 * Parses a document and returns a list of block structures
 	 *
 	 * When encountering an invalid parse will return a best-effort
 	 * parse. In contrast to the specification parser this does not
 	 * return an error on invalid inputs.
 	 *
 	 * @since 5.0.0
 	 *
 	 * @param string $document Input document being parsed.
-	 * @return WP_Block_Parser_Block[]
+	 * @return array[]
 	 */
-	function parse( $document ) {
+	public function parse( $document ) {
-		$this->document    = $document;
+		$this->document = $document;
-		$this->offset      = 0;
+		$this->offset   = 0;
-		$this->output      = array();
+		$this->output   = array();
-		$this->stack       = array();
+		$this->stack    = array();
-		$this->empty_attrs = json_decode( '{}', true );
+		while ( $this->proceed() ) {
-		do {
+			continue;
-			// twiddle our thumbs.
+		}
-		} while ( $this->proceed() );
 		return $this->output;
 	}
 	/**
 	 *
 	 * @internal
 	 * @since 5.0.0
 	 * @return bool
 	 */
-	function proceed() {
+	public function proceed() {
 		$next_token = $this->next_token();
 		list( $token_type, $block_name, $attrs, $start_offset, $token_length ) = $next_token;
 		$stack_depth = count( $this->stack );
 		// we may have some HTML soup before the next block.
 	 * @internal
 	 * @since 5.0.0
 	 * @since 4.6.1 fixed a bug in attribute parsing which caused catastrophic backtracking on invalid block comments
 	 * @return array
 	 */
-	function next_token() {
+	public function next_token() {
 		$matches = null;
 		/*
 		 * aye the magic
 		 * we're using a single RegExp to tokenize the block comment delimiters
 		 * Fun fact! It's not trivial in PHP to create "an empty associative array" since all arrays
 		 * are associative arrays. If we use `array()` we get a JSON `[]`
 		 */
 		$attrs = $has_attrs
 			? json_decode( $matches['attrs'][0], /* as-associative */ true )
-			: $this->empty_attrs;
+			: array();
 		/*
 		 * This state isn't allowed
 		 * This is an error
 		 */
 	 * Returns a new block object for freeform HTML
 	 *
 	 * @internal
 	 * @since 3.9.0
 	 *
-	 * @param string $innerHTML HTML content of block.
+	 * @param string $inner_html HTML content of block.
 	 * @return WP_Block_Parser_Block freeform block object.
 	 */
-	function freeform( $innerHTML ) {
+	public function freeform( $inner_html ) {
-		return new WP_Block_Parser_Block( null, $this->empty_attrs, array(), $innerHTML, array( $innerHTML ) );
+		return new WP_Block_Parser_Block( null, array(), array(), $inner_html, array( $inner_html ) );
 	}
 	/**
 	 * Pushes a length of text from the input document
 	 * to the output list as a freeform block.
 	 *
 	 * @internal
 	 * @since 5.0.0
 	 * @param null $length how many bytes of document text to output.
 	 */
-	function add_freeform( $length = null ) {
+	public function add_freeform( $length = null ) {
 		$length = $length ? $length : strlen( $this->document ) - $this->offset;
 		if ( 0 === $length ) {
 			return;
 		}
 	 * @param WP_Block_Parser_Block $block        The block to add to the output.
 	 * @param int                   $token_start  Byte offset into the document where the first token for the block starts.
 	 * @param int                   $token_length Byte length of entire block from start of opening token to end of closing token.
 	 * @param int|null              $last_offset  Last byte offset into document if continuing form earlier output.
 	 */
-	function add_inner_block( WP_Block_Parser_Block $block, $token_start, $token_length, $last_offset = null ) {
+	public function add_inner_block( WP_Block_Parser_Block $block, $token_start, $token_length, $last_offset = null ) {
 		$parent                       = $this->stack[ count( $this->stack ) - 1 ];
 		$parent->block->innerBlocks[] = (array) $block;
 		$html                         = substr( $this->document, $parent->prev_offset, $token_start - $parent->prev_offset );
 		if ( ! empty( $html ) ) {
 	 *
 	 * @internal
 	 * @since 5.0.0
 	 * @param int|null $end_offset byte offset into document for where we should stop sending text output as HTML.
 	 */
-	function add_block_from_stack( $end_offset = null ) {
+	public function add_block_from_stack( $end_offset = null ) {
 		$stack_top   = array_pop( $this->stack );
 		$prev_offset = $stack_top->prev_offset;
 		$html = isset( $end_offset )
 			? substr( $this->document, $prev_offset, $end_offset - $prev_offset )
 		}
 		$this->output[] = (array) $stack_top->block;
 	}
 }
+/**
+* WP_Block_Parser_Block class.
+*
+* Required for backward compatibility in WordPress Core.
+*/
+require_once __DIR__ . '/class-wp-block-parser-block.php';
+/**
+* WP_Block_Parser_Frame class.
+*
+* Required for backward compatibility in WordPress Core.
+*/
+require_once __DIR__ . '/class-wp-block-parser-frame.php';

changeset 21	48c4eec2b7e6
parent 18	be944660c56a