PPTemplateFrame_Hash.php

Go to the documentation of this file.

<?php
// phpcs:ignore Squiz.Classes.ValidClassName.NotCamelCaps
class PPTemplateFrame_Hash extends PPFrame_Hash {
 
    public $numberedArgs;
    public $namedArgs;
    public $parent;
    public $numberedExpansionCache;
    public $namedExpansionCache;
 
    public function __construct( $preprocessor, $parent = false, $numberedArgs = [],
        $namedArgs = [], $title = false
    ) {
        parent::__construct( $preprocessor );
        '@phan-var PPFrame_Hash $parent';
 
        $this->parent = $parent;
        $this->numberedArgs = $numberedArgs;
        $this->namedArgs = $namedArgs;
        $this->title = $title;
        $pdbk = $title ? $title->getPrefixedDBkey() : false;
        $this->titleCache = $parent->titleCache;
        $this->titleCache[] = $pdbk;
        $this->loopCheckHash = /*clone*/ $parent->loopCheckHash;
        if ( $pdbk !== false ) {
            $this->loopCheckHash[$pdbk] = true;
        }
        $this->depth = $parent->depth + 1;
        $this->numberedExpansionCache = $this->namedExpansionCache = [];
    }
 
    public function __toString() {
        $s = 'tplframe{';
        $first = true;
        $args = $this->numberedArgs + $this->namedArgs;
        foreach ( $args as $name => $value ) {
            if ( $first ) {
                $first = false;
            } else {
                $s .= ', ';
            }
            $s .= "\"$name\":\"" .
                str_replace( '"', '\\"', $value->__toString() ) . '"';
        }
        $s .= '}';
        return $s;
    }
 
    public function cachedExpand( $key, $root, $flags = 0 ) {
        if ( isset( $this->parent->childExpansionCache[$key] ) ) {
            return $this->parent->childExpansionCache[$key];
        }
        $retval = $this->expand( $root, $flags );
        if ( !$this->isVolatile() ) {
            $this->parent->childExpansionCache[$key] = $retval;
        }
        return $retval;
    }
 
    public function isEmpty() {
        return !count( $this->numberedArgs ) && !count( $this->namedArgs );
    }
 
    public function getArguments() {
        $arguments = [];
        foreach ( array_merge(
                array_keys( $this->numberedArgs ),
                array_keys( $this->namedArgs ) ) as $key ) {
            $arguments[$key] = $this->getArgument( $key );
        }
        return $arguments;
    }
 
    public function getNumberedArguments() {
        $arguments = [];
        foreach ( array_keys( $this->numberedArgs ) as $key ) {
            $arguments[$key] = $this->getArgument( $key );
        }
        return $arguments;
    }
 
    public function getNamedArguments() {
        $arguments = [];
        foreach ( array_keys( $this->namedArgs ) as $key ) {
            $arguments[$key] = $this->getArgument( $key );
        }
        return $arguments;
    }
 
    public function getNumberedArgument( $index ) {
        if ( !isset( $this->numberedArgs[$index] ) ) {
            return false;
        }
        if ( !isset( $this->numberedExpansionCache[$index] ) ) {
            # No trimming for unnamed arguments
            $this->numberedExpansionCache[$index] = $this->parent->expand(
                $this->numberedArgs[$index],
                PPFrame::STRIP_COMMENTS
            );
        }
        return $this->numberedExpansionCache[$index];
    }
 
    public function getNamedArgument( $name ) {
        if ( !isset( $this->namedArgs[$name] ) ) {
            return false;
        }
        if ( !isset( $this->namedExpansionCache[$name] ) ) {
            # Trim named arguments post-expand, for backwards compatibility
            $this->namedExpansionCache[$name] = trim(
                // @phan-suppress-next-line SecurityCheck-XSS
                $this->parent->expand( $this->namedArgs[$name], PPFrame::STRIP_COMMENTS ) );
        }
        return $this->namedExpansionCache[$name];
    }
 
    public function getArgument( $name ) {
        $text = $this->getNumberedArgument( $name );
        if ( $text === false ) {
            $text = $this->getNamedArgument( $name );
        }
        return $text;
    }
 
    public function isTemplate() {
        return true;
    }
 
    public function setVolatile( $flag = true ) {
        parent::setVolatile( $flag );
        $this->parent->setVolatile( $flag );
    }
 
    public function setTTL( $ttl ) {
        parent::setTTL( $ttl );
        $this->parent->setTTL( $ttl );
    }
}