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

Inheritance: extends Pimcore\Model\Object\ClassDefinition\Data\Relations\AbstractRelations
Show file Open project: pimcore/pimcore

Public Properties

Property Type Description
$assetTypes array Allowed asset types
$assetUploadPath string
$assetsAllowed boolean
$documentTypes array Allowed document types
$documentsAllowed boolean
$fieldtype string Static type of this element
$objectsAllowed boolean
$phpdocType string Type for the generated phpdoc
$queryColumnType array Type for the column to query
$relationType boolean
$width integer

Public Methods

Method Description
checkValidity ( mixed $data, boolean $omitMandatoryCheck = false ) Checks if data is valid for current data field
getAssetTypes ( ) : array
getAssetUploadPath ( ) : string
getAssetsAllowed ( ) : boolean
getCacheTags ( mixed $data, array $tags = [] ) : array This is a dummy and is mostly implemented by relation types
getDataForEditmode ( Asset | Document | AbstractObject $data, null | AbstractObject $object = null, mixed $params = [] ) : array
getDataForGrid ( $data, $object = null, $params = [] )
getDataForQueryResource ( Asset | Document | AbstractObject $data, null | AbstractObject $object = null, mixed $params = [] ) : array
getDataForResource ( $data, null | AbstractObject $object = null, mixed $params = [] ) : array
getDataFromEditmode ( array $data, null | AbstractObject $object = null, mixed $params = [] ) : Asset | Document | AbstractObject
getDataFromResource ( array $data, null | AbstractObject $object = null, mixed $params = [], $notRelationTable = false ) : Asset | Document | AbstractObject
getDocumentTypes ( ) : array
getDocumentsAllowed ( ) : boolean
getForCsvExport ( AbstractObject $object, array $params = [] ) : string converts object data to a simple string value or CSV Export
getForWebserviceExport ( string $object, mixed $params = [] ) : mixed converts data to be exposed via webservices
getFromCsvImport ( $importValue, null | AbstractObject $object = null, mixed $params = [] ) : mixed | null | Asset | Document | Pimcore\Model\Element\ElementInterface
getFromWebserviceImport ( mixed $value, null $relatedObject = null, mixed $params = [], null $idMapper = null ) : mixed | void
getObjectsAllowed ( ) : boolean
getPhpdocType ( ) : string
getVersionPreview ( $data, null | AbstractObject $object = null, mixed $params = [] ) : string
getWidth ( ) : integer
isDiffChangeAllowed ( string $object, mixed $params = [] ) : boolean True if change is allowed in edit mode.
marshal ( mixed $value, AbstractObject $object = null, mixed $params = [] ) : mixed Encode value for packing it into a single column.
preGetData ( $object, array $params = [] ) : null | AbstractData | Concrete | Pimcore\Model\Object\Objectbrick\Data\
preSetData ( $object, $data, array $params = [] ) : mixed
resolveDependencies ( $data ) : array
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(.
setAssetTypes ( array $assetTypes )
setAssetUploadPath ( $assetUploadPath )
setAssetsAllowed ( boolean $assetsAllowed )
setDocumentTypes ( array $documentTypes )
setDocumentsAllowed ( boolean $documentsAllowed )
setObjectsAllowed ( boolean $objectsAllowed )
setWidth ( integer $width )
synchronizeWithMasterDefinition ( Data $masterDefinition )
unmarshal ( mixed $value, AbstractObject $object = null, mixed $params = [] ) : mixed See marshal

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

getAssetTypes() public method

public getAssetTypes ( ) : array
return array

getAssetUploadPath() public method

public getAssetUploadPath ( ) : string
return string

getAssetsAllowed() public method

public getAssetsAllowed ( ) : boolean
return 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 ( Asset | Document | AbstractObject $data, null | AbstractObject $object = null, mixed $params = [] ) : array
$data Pimcore\Model\Asset | Pimcore\Model\Document | Pimcore\Model\Object\AbstractObject
$object null | Pimcore\Model\Object\AbstractObject
$params mixed
return array

getDataForGrid() public method

public getDataForGrid ( $data, $object = null, $params = [] )

getDataForQueryResource() public method

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

getDataForResource() public method

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

getDataFromEditmode() public method

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

getDataFromResource() public method

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

getDocumentTypes() public method

public getDocumentTypes ( ) : array
return array

getDocumentsAllowed() public method

public getDocumentsAllowed ( ) : boolean
return boolean

getForCsvExport() public method

converts object data to a simple string value or CSV Export
public getForCsvExport ( AbstractObject $object, array $params = [] ) : string
$object Pimcore\Model\Object\AbstractObject
$params array
return string

getForWebserviceExport() public method

converts data to be exposed via webservices
public getForWebserviceExport ( string $object, mixed $params = [] ) : mixed
$object string
$params mixed
return mixed

getFromCsvImport() public method

public getFromCsvImport ( $importValue, null | AbstractObject $object = null, mixed $params = [] ) : mixed | null | Asset | Document | Pimcore\Model\Element\ElementInterface
$importValue
$object null | Pimcore\Model\Object\AbstractObject
$params mixed
return mixed | null | Pimcore\Model\Asset | Pimcore\Model\Document | Pimcore\Model\Element\ElementInterface

getFromWebserviceImport() public method

public getFromWebserviceImport ( mixed $value, null $relatedObject = null, mixed $params = [], null $idMapper = null ) : mixed | void
$value mixed
$relatedObject null
$params mixed
$idMapper null
return mixed | void

getObjectsAllowed() public method

public getObjectsAllowed ( ) : boolean
return boolean

getPhpdocType() public method

public getPhpdocType ( ) : string
return string

getVersionPreview() public method

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

getWidth() public method

public getWidth ( ) : integer
return integer

isDiffChangeAllowed() public method

True if change is allowed in edit mode.
public isDiffChangeAllowed ( string $object, mixed $params = [] ) : boolean
$object string
$params mixed
return boolean

marshal() public method

Encode value for packing it into a single column.
public marshal ( mixed $value, AbstractObject $object = null, mixed $params = [] ) : mixed
$value mixed
$object Pimcore\Model\Object\AbstractObject
$params mixed
return mixed

preGetData() public method

public preGetData ( $object, array $params = [] ) : null | AbstractData | Concrete | Pimcore\Model\Object\Objectbrick\Data\
$object
$params array
return null | AbstractData | Pimcore\Model\Object\Concrete | Pimcore\Model\Object\Objectbrick\Data\

preSetData() public method

public preSetData ( $object, $data, array $params = [] ) : mixed
$object
$data
$params array
return mixed

resolveDependencies() public method

public resolveDependencies ( $data ) : array
$data
return array

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

setAssetTypes() public method

public setAssetTypes ( array $assetTypes )
$assetTypes array

setAssetUploadPath() public method

public setAssetUploadPath ( $assetUploadPath )
$assetUploadPath

setAssetsAllowed() public method

public setAssetsAllowed ( boolean $assetsAllowed )
$assetsAllowed boolean

setDocumentTypes() public method

public setDocumentTypes ( array $documentTypes )
$documentTypes array

setDocumentsAllowed() public method

public setDocumentsAllowed ( boolean $documentsAllowed )
$documentsAllowed boolean

setObjectsAllowed() public method

public setObjectsAllowed ( boolean $objectsAllowed )
$objectsAllowed boolean

setWidth() public method

public setWidth ( integer $width )
$width integer

synchronizeWithMasterDefinition() public method

public synchronizeWithMasterDefinition ( Data $masterDefinition )
$masterDefinition Pimcore\Model\Object\ClassDefinition\Data

unmarshal() public method

See marshal
public unmarshal ( mixed $value, AbstractObject $object = null, mixed $params = [] ) : mixed
$value mixed
$object Pimcore\Model\Object\AbstractObject
$params mixed
return mixed

Property Details

$assetTypes public property

Allowed asset types
public array $assetTypes
return array

$assetUploadPath public property

public string $assetUploadPath
return string

$assetsAllowed public property

public bool $assetsAllowed
return boolean

$documentTypes public property

Allowed document types
public array $documentTypes
return array

$documentsAllowed public property

public bool $documentsAllowed
return boolean

$fieldtype public property

Static type of this element
public string $fieldtype
return string

$objectsAllowed public property

public bool $objectsAllowed
return boolean

$phpdocType public property

Type for the generated phpdoc
public string $phpdocType
return string

$queryColumnType public property

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

$relationType public property

public bool $relationType
return boolean

$width public property

public int $width
return integer