PHP Класс Pimcore\Placeholder\AbstractPlaceholder

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

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

Свойство Тип Описание
$contentString string The Content as string
$document Pimcore\Model\Document | null The passed Document Object
$locale Zend_Locale
$params array All dynamic parameters which are passed to the Placeholder
$placeholderConfig Zend_Config_Json The config object passed from the placeholder If no config object was passed a empty \Zend_Config_Json is passed
$placeholderKey string The placeholder key passed to determine the dynamic parameter
$placeholderString string The placeholder string e.g "%Object(object_id,{"method" : "getName"})"

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

Метод Описание
getContentString ( ) : null | string returns the full content string
getDocument ( ) : Document | null Returns the Document
getEmptyValue ( ) : string Will be used as replacement if the passed parameter is empty
getLanguage ( ) : string Returns the current language
getLocale ( ) : Zend_Locale Returns the current locale
getParam ( string $key ) : mixed Returns a specific parameter
getParams ( ) : array Returns the Parameters ob the Placeholder object
getPlaceholderConfig ( ) : Zend_Config_Json Returns the Placeholder config object
getPlaceholderKey ( ) : string Returns the Placehodler key
getPlaceholderString ( ) : string
getReplacement ( ) : string Has to return the placeholder with the corresponding value
getTestValue ( ) : string Has to return an appropriate value for a test replacement
getValue ( ) : mixed Returns the the value of the current Placeholder parameter
setContentString ( $contentString )
setDocument ( $document )
setLocale ( $locale = null ) Try to set the locale from different sources
setParams ( $params )
setPlaceholderConfig ( Zend_Config_Json $config )
setPlaceholderKey ( $key )
setPlaceholderString ( $string )

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

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

returns the full content string
public getContentString ( ) : null | string
Результат null | string

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

Returns the Document
public getDocument ( ) : Document | null
Результат Pimcore\Model\Document | null

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

Will be used as replacement if the passed parameter is empty
public getEmptyValue ( ) : string
Результат string

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

Returns the current language
public getLanguage ( ) : string
Результат string

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

Returns the current locale
public getLocale ( ) : Zend_Locale
Результат Zend_Locale

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

Returns a specific parameter
public getParam ( string $key ) : mixed
$key string
Результат mixed

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

Returns the Parameters ob the Placeholder object
public getParams ( ) : array
Результат array

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

Returns the Placeholder config object
public getPlaceholderConfig ( ) : Zend_Config_Json
Результат Zend_Config_Json

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

Returns the Placehodler key
public getPlaceholderKey ( ) : string
Результат string

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

public getPlaceholderString ( ) : string
Результат string

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

Has to return the placeholder with the corresponding value
abstract public getReplacement ( ) : string
Результат string

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

Has to return an appropriate value for a test replacement
abstract public getTestValue ( ) : string
Результат string

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

Returns the the value of the current Placeholder parameter
public getValue ( ) : mixed
Результат mixed

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

public setContentString ( $contentString )
$contentString

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

public setDocument ( $document )
$document

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

Try to set the locale from different sources
public setLocale ( $locale = null )
$locale

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

public setParams ( $params )
$params

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

public setPlaceholderConfig ( Zend_Config_Json $config )
$config Zend_Config_Json

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

public setPlaceholderKey ( $key )
$key

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

public setPlaceholderString ( $string )
$string

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

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

The Content as string
protected string $contentString
Результат string

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

The passed Document Object
protected Document,Pimcore\Model|null $document
Результат Pimcore\Model\Document | null

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

protected Zend_Locale $locale
Результат Zend_Locale

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

All dynamic parameters which are passed to the Placeholder
protected array $params
Результат array

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

The config object passed from the placeholder If no config object was passed a empty \Zend_Config_Json is passed
protected Zend_Config_Json $placeholderConfig
Результат Zend_Config_Json

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

The placeholder key passed to determine the dynamic parameter
protected string $placeholderKey
Результат string

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

The placeholder string e.g "%Object(object_id,{"method" : "getName"})"
protected string $placeholderString
Результат string