Server : Apache System : Linux server2.corals.io 4.18.0-348.2.1.el8_5.x86_64 #1 SMP Mon Nov 15 09:17:08 EST 2021 x86_64 User : corals ( 1002) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system Directory : /home/corals/old/vendor/laminas/laminas-view/src/Helper/Placeholder/Container/ |
<?php
declare(strict_types=1);
namespace Laminas\View\Helper\Placeholder\Container;
use ArrayObject;
use Laminas\View\Exception;
use ReturnTypeWillChange;
use function array_keys;
use function array_shift;
use function array_unshift;
use function count;
use function implode;
use function is_int;
use function is_scalar;
use function max;
use function ob_get_clean;
use function ob_start;
use function preg_replace;
use function str_repeat;
/**
* Abstract class representing container for placeholder values
*
* @template TKey of array-key
* @template TValue
* @extends ArrayObject<TKey, TValue>
*/
abstract class AbstractContainer extends ArrayObject
{
/**
* Whether to override all contents of placeholder
*
* @const string
*/
public const SET = 'SET';
/**
* Whether to append contents to placeholder
*
* @const string
*/
public const APPEND = 'APPEND';
/**
* Whether to prepend contents to placeholder
*
* @const string
*/
public const PREPEND = 'PREPEND';
/**
* Key to which to capture content
*
* @var TKey|null
*/
protected $captureKey;
/**
* Whether or not we're already capturing for this given container
*
* @var bool
*/
protected $captureLock = false;
/**
* What type of capture (overwrite (set), append, prepend) to use
*
* @var string|null
*/
protected $captureType;
/**
* What string to use as the indentation of output, this will typically be spaces. Eg: ' '
*
* @var string
*/
protected $indent = '';
/**
* What text to append the placeholder with when rendering
*
* @var string
*/
protected $postfix = '';
/**
* What text to prefix the placeholder with when rendering
*
* @var string
*/
protected $prefix = '';
/**
* What string to use between individual items in the placeholder when rendering
*
* @var string
*/
protected $separator = '';
/**
* Constructor - This is needed so that we can attach a class member as the ArrayObject container
*
* @final
*/
public function __construct()
{
parent::__construct([], parent::ARRAY_AS_PROPS);
}
/**
* Serialize object to string
*
* @return string
*/
public function __toString()
{
return $this->toString();
}
/**
* Render the placeholder
*
* @param null|int|string $indent
* @return string
*/
public function toString($indent = null)
{
// If we don't have items - do not show prefix and postfix
if (! count($this)) {
return '';
}
$indent = $indent === null
? $this->getIndent()
: $this->getWhitespace($indent);
$items = $this->getArrayCopy();
$return = $indent
. $this->getPrefix()
. implode($this->getSeparator(), $items)
. $this->getPostfix();
$return = preg_replace("/(\r\n?|\n)/", '$1' . $indent, $return);
return $return;
}
/**
* Start capturing content to push into placeholder
*
* @param string $type How to capture content into placeholder; append, prepend, or set
* @param TKey $key Key to which to capture content
* @throws Exception\RuntimeException If nested captures detected.
* @return void
*/
public function captureStart($type = self::APPEND, $key = null)
{
if ($this->captureLock) {
throw new Exception\RuntimeException(
'Cannot nest placeholder captures for the same placeholder'
);
}
$this->captureLock = true;
$this->captureType = $type;
if (is_scalar($key)) {
$this->captureKey = $key;
}
ob_start();
}
/**
* End content capture
*
* @return void
*/
public function captureEnd()
{
$data = ob_get_clean();
$key = $this->captureKey;
$this->captureLock = false;
switch ($this->captureType) {
case self::SET:
if (null !== $key) {
$this[$key] = $data;
} else {
$this->exchangeArray([$data]);
}
break;
case self::PREPEND:
if (null !== $key) {
$array = [$key => $data];
$values = $this->getArrayCopy();
$final = $array + $values;
$this->exchangeArray($final);
} else {
$this->prepend($data);
}
break;
case self::APPEND:
default:
if (null !== $key) {
if (empty($this[$key])) {
$this[$key] = $data;
} else {
$this[$key] .= $data;
}
} else {
$this[$this->nextIndex()] = $data;
}
break;
}
}
/**
* Get keys
*
* @return list<TKey>
*/
public function getKeys()
{
return array_keys($this->getArrayCopy());
}
/**
* Retrieve container value
*
* If single element registered, returns that element; otherwise,
* serializes to array.
*
* @return TValue|array<TKey, TValue>
*/
public function getValue()
{
if (1 === count($this)) {
$keys = $this->getKeys();
$key = array_shift($keys);
return $this[$key];
}
return $this->getArrayCopy();
}
/**
* Retrieve whitespace representation of $indent
*
* @param int|string $indent
* @return string
*/
public function getWhitespace($indent)
{
if (is_int($indent)) {
$indent = str_repeat(' ', $indent);
}
return $indent;
}
/**
* Set a single value
*
* @param TValue $value
* @return $this
*/
public function set($value)
{
$this->exchangeArray([$value]);
return $this;
}
/**
* Prepend a value to the top of the container
*
* @param TValue $value
* @return $this
*/
public function prepend($value)
{
$values = $this->getArrayCopy();
array_unshift($values, $value);
$this->exchangeArray($values);
return $this;
}
/**
* Append a value to the end of the container
*
* @param TValue $value
* @return $this
*/
#[ReturnTypeWillChange]
public function append($value)
{
parent::append($value);
return $this;
}
/**
* Next Index as defined by the PHP manual
*
* @return int
*/
public function nextIndex()
{
$keys = $this->getKeys();
if (empty($keys)) {
return 0;
}
return max($keys) + 1;
}
/**
* Set the indentation string for __toString() serialization,
* optionally, if a number is passed, it will be the number of spaces
*
* @param string|int $indent
* @return $this
*/
public function setIndent($indent)
{
$this->indent = $this->getWhitespace($indent);
return $this;
}
/**
* Retrieve indentation
*
* @return string
*/
public function getIndent()
{
return $this->indent;
}
/**
* Set postfix for __toString() serialization
*
* @param string $postfix
* @return $this
*/
public function setPostfix($postfix)
{
$this->postfix = (string) $postfix;
return $this;
}
/**
* Retrieve postfix
*
* @return string
*/
public function getPostfix()
{
return $this->postfix;
}
/**
* Set prefix for __toString() serialization
*
* @param string $prefix
* @return $this
*/
public function setPrefix($prefix)
{
$this->prefix = (string) $prefix;
return $this;
}
/**
* Retrieve prefix
*
* @return string
*/
public function getPrefix()
{
return $this->prefix;
}
/**
* Set separator for __toString() serialization
*
* Used to implode elements in container
*
* @param string $separator
* @return $this
*/
public function setSeparator($separator)
{
$this->separator = (string) $separator;
return $this;
}
/**
* Retrieve separator
*
* @return string
*/
public function getSeparator()
{
return $this->separator;
}
}