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

Inheritance: extends Objects
Show file Open project: pimcore/pimcore

Public Properties

Property Type Description
$lazyLoading boolean NonOwnerObjects must be lazy loading!
$ownerClassId number
$ownerClassName string
$ownerFieldName string
$remoteOwner boolean

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
getDataForQueryResource ( array $data, null | AbstractObject $object = null, mixed $params = [] ) : string
getDataForResource ( array $data, null | AbstractObject $object = null, mixed $params = [] ) : array
getForCsvExport ( AbstractObject $object, array $params = [] ) : string converts object data to a simple string value or CSV Export
getForWebserviceExport ( AbstractObject $object, mixed $params = [] ) : array | null
getFromCsvImport ( string $importValue, null | AbstractObject $object = null, mixed $params = [] ) : Data fills object field data values from CSV Import String
getFromWebserviceImport ( mixed $value, null | AbstractObject $object = null, mixed $params = [], $idMapper = null ) : mixed converts data to be imported via webservices
getLazyLoading ( ) : boolean
getOwnerClassId ( ) : number
getOwnerClassName ( ) : string
getOwnerFieldName ( ) : string
isRemoteOwner ( ) : boolean
resolveDependencies ( mixed $data ) : array
setClasses ( array $classes )
setLazyLoading ( $lazyLoading )
setOwnerClassName ( string $ownerClassName )
setOwnerFieldName ( string $fieldName )

Protected Methods

Method Description
allowObjectRelation ( AbstractObject $object ) : boolean Checks if an object is an allowed relation

Method Details

allowObjectRelation() protected method

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

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

getDataForQueryResource() public method

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

getDataForResource() public method

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

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

public getForWebserviceExport ( AbstractObject $object, mixed $params = [] ) : array | null
$object Pimcore\Model\Object\AbstractObject
$params mixed
return array | null

getFromCsvImport() public method

fills object field data values from CSV Import String
public getFromCsvImport ( string $importValue, null | AbstractObject $object = null, mixed $params = [] ) : Data
$importValue string
$object null | Pimcore\Model\Object\AbstractObject
$params mixed
return Pimcore\Model\Object\ClassDefinition\Data

getFromWebserviceImport() public method

converts data to be imported via webservices
public getFromWebserviceImport ( mixed $value, null | AbstractObject $object = null, mixed $params = [], $idMapper = null ) : mixed
$value mixed
$object null | Pimcore\Model\Object\AbstractObject
$params mixed
return mixed

getLazyLoading() public method

public getLazyLoading ( ) : boolean
return boolean

getOwnerClassId() public method

public getOwnerClassId ( ) : number
return number

getOwnerClassName() public method

public getOwnerClassName ( ) : string
return string

getOwnerFieldName() public method

public getOwnerFieldName ( ) : string
return string

isRemoteOwner() public method

public isRemoteOwner ( ) : boolean
return boolean

resolveDependencies() public method

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

setClasses() public method

public setClasses ( array $classes )
$classes array

setLazyLoading() public method

public setLazyLoading ( $lazyLoading )
$lazyLoading

setOwnerClassName() public method

public setOwnerClassName ( string $ownerClassName )
$ownerClassName string

setOwnerFieldName() public method

public setOwnerFieldName ( string $fieldName )
$fieldName string

Property Details

$lazyLoading public property

NonOwnerObjects must be lazy loading!
public bool $lazyLoading
return boolean

$ownerClassId public property

public number $ownerClassId
return number

$ownerClassName public property

public string $ownerClassName
return string

$ownerFieldName public property

public string $ownerFieldName
return string

$remoteOwner public static property

public static bool $remoteOwner
return boolean