PHP Class Webiny\Component\Entity\Attribute\Many2ManyAttribute

Inheritance: extends AbstractCollectionAttribute, use trait Webiny\Component\Mongo\MongoTrait

Protected Properties

Property	Type	Description
$addedItems
$intermediateCollection

Method	Description
__construct ( $attribute = null, AbstractEntity $entity = null, $collectionName )
getValue ( array $params = [], boolean $processCallbacks = true ) : null \| EntityCollection	Get attribute value
hasValue ( )
save ( )	Insert links into DB
setValue ( null $value = null, boolean $fromDb = false )	Set or get attribute value
unlink ( string \| AbstractEntity $item ) : boolean	Remove item from many2many collection (removes the link between entities)
unlinkAll ( ) : boolean	Remove all items from man2many collection (removes the links between entities)

Method	Description
extractClassName ( $class ) : string	Extract short class name from class namespace
load ( ) : EntityCollection	Load many2many attribute value (prepares MongoCursor, lazy loads data)
unlinkItem ( string \| AbstractEntity $item ) : boolean	Unlink given item (only removes the aggregation record)

public __construct ( $attribute = null, AbstractEntity $entity = null, $collectionName )
$entity	Webiny\Component\Entity\AbstractEntity

Extract short class name from class namespace

protected extractClassName ( $class ) : string
$class
return	string

Get attribute value

public getValue ( array $params = [], boolean $processCallbacks = true ) : null \| EntityCollection
$params	array
$processCallbacks	boolean
return	null \| Webiny\Component\Entity\EntityCollection

public hasValue ( )

Load many2many attribute value (prepares MongoCursor, lazy loads data)

protected load ( ) : EntityCollection
return	Webiny\Component\Entity\EntityCollection

Insert links into DB

public save ( )

Set or get attribute value

public setValue ( null $value = null, boolean $fromDb = false )
$value	null
$fromDb	boolean

Remove item from many2many collection (removes the link between entities)

public unlink ( string \| AbstractEntity $item ) : boolean
$item	string \| Webiny\Component\Entity\AbstractEntity	Entity ID or instance of AbstractEntity
return	boolean

Remove all items from man2many collection (removes the links between entities)

public unlinkAll ( ) : boolean
return	boolean

Unlink given item (only removes the aggregation record)

protected unlinkItem ( string \| AbstractEntity $item ) : boolean
$item	string \| Webiny\Component\Entity\AbstractEntity
return	boolean

protected $addedItems

protected $intermediateCollection