includes/parser/PPCustomFrame_Hash.php

   1 <?php
   2 /**
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16  * http://www.gnu.org/copyleft/gpl.html
  17  *
  18  * @file
  19  * @ingroup Parser
  20  */
  21
  22 /**
  23  * Expansion frame with custom arguments
  24  * @ingroup Parser
  25  */
  26 // phpcs:ignore Squiz.Classes.ValidClassName.NotCamelCaps
  27 class PPCustomFrame_Hash extends PPFrame_Hash {
  28
  29         public $args;
  30
  31         public function __construct( $preprocessor, $args ) {
  32                 parent::__construct( $preprocessor );
  33                 $this->args = $args;
  34         }
  35
  36         public function __toString() {
  37                 $s = 'cstmframe{';
  38                 $first = true;
  39                 foreach ( $this->args as $name => $value ) {
  40                         if ( $first ) {
  41                                 $first = false;
  42                         } else {
  43                                 $s .= ', ';
  44                         }
  45                         $s .= "\"$name\":\"" .
  46                                 str_replace( '"', '\\"', $value->__toString() ) . '"';
  47                 }
  48                 $s .= '}';
  49                 return $s;
  50         }
  51
  52         /**
  53          * @return bool
  54          */
  55         public function isEmpty() {
  56                 return !count( $this->args );
  57         }
  58
  59         /**
  60          * @param int|string $index
  61          * @return string|bool
  62          */
  63         public function getArgument( $index ) {
  64                 return $this->args[$index] ?? false;
  65         }
  66
  67         public function getArguments() {
  68                 return $this->args;
  69         }
  70 }