PHP Class Pimcore\Model\Object\ClassDefinition\Data\Relations\AbstractRelations

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

Public Properties

Property Type Description
$classes array Set of allowed classes
$lazyLoading boolean
$pathFormatterClass null | string Optional path formatter class
$remoteOwner boolean

Public Methods

Method Description
getClasses ( ) : array
getLazyLoading ( ) : boolean
getPathFormatterClass ( ) : null | string
isRemoteOwner ( ) : boolean
load ( $object, array $params = [] ) : null
rewriteIdsService ( mixed $data, array $idMapping ) : array Rewrites id from source to target, $idMapping contains array( "document" => array( SOURCE_ID => TARGET_ID, SOURCE_ID => TARGET_ID ), "object" => array(.
save ( $object, array $params = [] )
setClasses ( array $classes )
setLazyLoading ( $lazyLoading )
setPathFormatterClass ( null | string $pathFormatterClass )

Protected Methods

Method Description
allowAssetRelation ( Asset $asset ) : boolean Checks if an asset is an allowed relation
allowDocumentRelation ( Document $document ) : boolean Checks if an document is an allowed relation
allowObjectRelation ( AbstractObject $object ) : boolean Checks if an object is an allowed relation
enrichRelation ( $object, $params, &$classId, array &$relation = [] ) Enrich relation with type-specific data.

Method Details

allowAssetRelation() protected method

Checks if an asset is an allowed relation
protected allowAssetRelation ( Asset $asset ) : boolean
$asset Asset
return boolean

allowDocumentRelation() protected method

Checks if an document is an allowed relation
protected allowDocumentRelation ( Document $document ) : boolean
$document Document
return boolean

allowObjectRelation() protected method

Checks if an object is an allowed relation
protected allowObjectRelation ( AbstractObject $object ) : boolean
$object Pimcore\Model\Object\AbstractObject
return boolean

enrichRelation() protected method

Enrich relation with type-specific data.
protected enrichRelation ( $object, $params, &$classId, array &$relation = [] )
$object
$params
$classId
$relation array

getClasses() public method

public getClasses ( ) : array
return array

getLazyLoading() public method

public getLazyLoading ( ) : boolean
return boolean

getPathFormatterClass() public method

public getPathFormatterClass ( ) : null | string
return null | string

isRemoteOwner() public method

public isRemoteOwner ( ) : boolean
return boolean

load() public method

public load ( $object, array $params = [] ) : null
$object
$params array
return null

rewriteIdsService() public method

..), "asset" => array(...) )
public rewriteIdsService ( mixed $data, array $idMapping ) : array
$data mixed
$idMapping array
return array

save() public method

public save ( $object, array $params = [] )
$object
$params array

setClasses() public method

public setClasses ( array $classes )
$classes array

setLazyLoading() public method

public setLazyLoading ( $lazyLoading )
$lazyLoading

setPathFormatterClass() public method

public setPathFormatterClass ( null | string $pathFormatterClass )
$pathFormatterClass null | string

Property Details

$classes public property

Set of allowed classes
public array $classes
return array

$lazyLoading public property

public bool $lazyLoading
return boolean

$pathFormatterClass public property

Optional path formatter class
public null|string $pathFormatterClass
return null | string

$remoteOwner public static property

public static bool $remoteOwner
return boolean