PHP 클래스 Pimcore\Placeholder\AbstractPlaceholder

파일 보기 프로젝트 열기: pimcore/pimcore

보호된 프로퍼티들

프로퍼티 타입 설명
$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