PHP Class Pimcore\Model\Object\ClassDefinition\Data\Wysiwyg

Inheritance: extends Pimcore\Model\Object\ClassDefinition\Data, use trait Pimcore\Model\Object\ClassDefinition\Data\Extension\Text
Show file Open project: pimcore/pimcore

Public Properties

Property Type Description
$columnType string Type for the column
$fieldtype string Static type of this element
$height integer
$phpdocType string Type for the generated phpdoc
$queryColumnType string Type for the column to query
$toolbarConfig string
$width integer

Public Methods

Method Description
checkValidity ( mixed $data, boolean $omitMandatoryCheck = false ) Checks if data is valid for current data field
getCacheTags ( mixed $data, array $tags = [] ) : array This is a dummy and is mostly implemented by relation types
getDataForEditmode ( string $data, null | AbstractObject $object = null, mixed $params = [] ) : string
getDataForQueryResource ( string $data, null | AbstractObject $object = null, mixed $params = [] ) : string
getDataForResource ( string $data, null | AbstractObject $object = null, mixed $params = [] ) : string
getDataFromEditmode ( string $data, null | AbstractObject $object = null, mixed $params = [] ) : string
getDataFromResource ( string $data, null | AbstractObject $object = null, mixed $params = [] ) : string
getDiffVersionPreview ( $data, null $object = null, mixed $params = [] ) : array | string Generates a pretty version preview (similar to getVersionPreview) can be either html or a image URL. See the ObjectMerger plugin documentation for details
getHeight ( ) : integer
getToolbarConfig ( ) : string
getWidth ( ) : integer
preGetData ( Concrete $object, $params = [] ) : string
resolveDependencies ( mixed $data )
rewriteIds ( mixed $object, array $idMapping, array $params = [] ) : Pimcore\Model\Element\ElementInterface Rewrites id from source to target, $idMapping contains array( "document" => array( SOURCE_ID => TARGET_ID, SOURCE_ID => TARGET_ID ), "object" => array(.
setHeight ( integer $height )
setToolbarConfig ( string $toolbarConfig )
setWidth ( integer $width )

Method Details

checkValidity() public method

Checks if data is valid for current data field
public checkValidity ( mixed $data, boolean $omitMandatoryCheck = false )
$data mixed
$omitMandatoryCheck boolean

getCacheTags() public method

This is a dummy and is mostly implemented by relation types
public getCacheTags ( mixed $data, array $tags = [] ) : array
$data mixed
$tags array
return array

getDataForEditmode() public method

See also: Object\ClassDefinition\Data::getDataForEditmode
public getDataForEditmode ( string $data, null | AbstractObject $object = null, mixed $params = [] ) : string
$data string
$object null | Pimcore\Model\Object\AbstractObject
$params mixed
return string

getDataForQueryResource() public method

See also: Object\ClassDefinition\Data::getDataForQueryResource
public getDataForQueryResource ( string $data, null | AbstractObject $object = null, mixed $params = [] ) : string
$data string
$object null | Pimcore\Model\Object\AbstractObject
$params mixed
return string

getDataForResource() public method

See also: Object\ClassDefinition\Data::getDataForResource
public getDataForResource ( string $data, null | AbstractObject $object = null, mixed $params = [] ) : string
$data string
$object null | Pimcore\Model\Object\AbstractObject
$params mixed
return string

getDataFromEditmode() public method

See also: Model\Object\ClassDefinition\Data::getDataFromEditmode
public getDataFromEditmode ( string $data, null | AbstractObject $object = null, mixed $params = [] ) : string
$data string
$object null | Pimcore\Model\Object\AbstractObject
$params mixed
return string

getDataFromResource() public method

See also: Object\ClassDefinition\Data::getDataFromResource
public getDataFromResource ( string $data, null | AbstractObject $object = null, mixed $params = [] ) : string
$data string
$object null | Pimcore\Model\Object\AbstractObject
$params mixed
return string

getDiffVersionPreview() public method

Generates a pretty version preview (similar to getVersionPreview) can be either html or a image URL. See the ObjectMerger plugin documentation for details
public getDiffVersionPreview ( $data, null $object = null, mixed $params = [] ) : array | string
$data
$object null
$params mixed
return array | string

getHeight() public method

public getHeight ( ) : integer
return integer

getToolbarConfig() public method

public getToolbarConfig ( ) : string
return string

getWidth() public method

public getWidth ( ) : integer
return integer

preGetData() public method

public preGetData ( Concrete $object, $params = [] ) : string
$object Pimcore\Model\Object\Concrete
return string

resolveDependencies() public method

public resolveDependencies ( mixed $data )
$data mixed

rewriteIds() public method

..), "asset" => array(...) )
public rewriteIds ( mixed $object, array $idMapping, array $params = [] ) : Pimcore\Model\Element\ElementInterface
$object mixed
$idMapping array
$params array
return Pimcore\Model\Element\ElementInterface

setHeight() public method

public setHeight ( integer $height )
$height integer

setToolbarConfig() public method

public setToolbarConfig ( string $toolbarConfig )
$toolbarConfig string

setWidth() public method

public setWidth ( integer $width )
$width integer

Property Details

$columnType public property

Type for the column
public string $columnType
return string

$fieldtype public property

Static type of this element
public string $fieldtype
return string

$height public property

public int $height
return integer

$phpdocType public property

Type for the generated phpdoc
public string $phpdocType
return string

$queryColumnType public property

Type for the column to query
public string $queryColumnType
return string

$toolbarConfig public property

public string $toolbarConfig
return string

$width public property

public int $width
return integer