PHP Класс Pimcore\Placeholder

Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство Тип Описание
$document Contains the document object
$placeholderClassPrefixes string Prefixes for the Placeholder Classes
$placeholderPrefix string Prefix for the Placeholders
$placeholderSuffix string Suffix for the Placeholders

Открытые методы

Метод Описание
addPlaceholderClassPrefix ( $classPrefix )
detectPlaceholders ( string $contentString, null | array $params, $document = null ) : array Detects the Placeholders in a string and returns an array with the placeholder information
getPlaceholderClassPrefixes ( ) : array Returns the Placeholder class prefixes
getPlaceholderPrefix ( ) : string Returns the Placeholder prefix
getPlaceholderSuffix ( ) : string Returns the Placeholder suffix
getWebsiteClassPrefix ( ) : string Returns the website class prefix for the Placeholder Classes
removePlaceholderClassPrefix ( $classPrefix ) : boolean
replacePlaceholders ( $mixed, array $params = [], $document = null, $enableLayoutOnPlaceholderReplacement = true ) : string Helper to simply replace the placeholders with their value
setPlaceholderPrefix ( string $prefix ) : void Set a custom Placeholder prefix
setPlaceholderSuffix ( $suffix )
setWebsiteClassPrefix ( $string ) Sets a custom website class prefix for the Placeholder Classes

Защищенные методы

Метод Описание
replacePlaceholdersFromStack ( array $placeholderStack = [] ) : string Creates the Placeholder objects and replaces the placeholder string with the rendered content of the placeholder object

Описание методов

addPlaceholderClassPrefix() публичный статический Метод

public static addPlaceholderClassPrefix ( $classPrefix )
$classPrefix

detectPlaceholders() публичный Метод

Detects the Placeholders in a string and returns an array with the placeholder information
public detectPlaceholders ( string $contentString, null | array $params, $document = null ) : array
$contentString string
$params null | array
Результат array

getPlaceholderClassPrefixes() публичный статический Метод

Returns the Placeholder class prefixes
public static getPlaceholderClassPrefixes ( ) : array
Результат array

getPlaceholderPrefix() публичный статический Метод

Returns the Placeholder prefix
public static getPlaceholderPrefix ( ) : string
Результат string

getPlaceholderSuffix() публичный статический Метод

Returns the Placeholder suffix
public static getPlaceholderSuffix ( ) : string
Результат string

getWebsiteClassPrefix() публичный статический Метод

Returns the website class prefix for the Placeholder Classes
Устаревший: deprecated since version 1.4.6
public static getWebsiteClassPrefix ( ) : string
Результат string

removePlaceholderClassPrefix() публичный статический Метод

public static removePlaceholderClassPrefix ( $classPrefix ) : boolean
$classPrefix
Результат boolean

replacePlaceholders() публичный Метод

Helper to simply replace the placeholders with their value
public replacePlaceholders ( $mixed, array $params = [], $document = null, $enableLayoutOnPlaceholderReplacement = true ) : string
$params array
Результат string

replacePlaceholdersFromStack() защищенный Метод

Creates the Placeholder objects and replaces the placeholder string with the rendered content of the placeholder object
protected replacePlaceholdersFromStack ( array $placeholderStack = [] ) : string
$placeholderStack array
Результат string

setPlaceholderPrefix() публичный статический Метод

Set a custom Placeholder prefix
Устаревший: deprecated since version 1.4.6
public static setPlaceholderPrefix ( string $prefix ) : void
$prefix string
Результат void

setPlaceholderSuffix() публичный Метод

public setPlaceholderSuffix ( $suffix )
$suffix

setWebsiteClassPrefix() публичный статический Метод

Sets a custom website class prefix for the Placeholder Classes
Устаревший: deprecated since version 1.4.6
public static setWebsiteClassPrefix ( $string )
$string

Описание свойств

$document защищенное свойство

Contains the document object
protected $document

$placeholderClassPrefixes защищенное статическое свойство

Prefixes for the Placeholder Classes
protected static string $placeholderClassPrefixes
Результат string

$placeholderPrefix защищенное статическое свойство

Prefix for the Placeholders
protected static string $placeholderPrefix
Результат string

$placeholderSuffix защищенное статическое свойство

Suffix for the Placeholders
protected static string $placeholderSuffix
Результат string