BEdita API doc | 4-cactus
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Download

Namespaces

  • BEdita
    • API
      • Auth
      • Controller
        • Admin
        • Component
        • Model
      • Error
      • Event
      • Exception
      • Middleware
      • Model
        • Action
      • Network
        • Exception
      • Shell
      • TestSuite
      • Utility
    • Core
      • Configure
        • Engine
      • Database
        • Type
      • Exception
      • Filesystem
        • Adapter
        • Exception
        • Thumbnail
      • I18n
      • Job
        • Service
      • Mailer
        • Preview
        • Transport
      • Model
        • Action
        • Behavior
        • Entity
        • Table
        • Validation
      • ORM
        • Inheritance
        • Locator
        • Rule
      • Shell
        • Task
      • State
      • TestSuite
        • Fixture
      • Utility

Classes

  • AddAssociatedAction
  • AddRelatedObjectsAction
  • BaseAction
  • ChangeCredentialsAction
  • ChangeCredentialsRequestAction
  • DeleteEntityAction
  • DeleteObjectAction
  • GetEntityAction
  • GetObjectAction
  • ListEntitiesAction
  • ListObjectsAction
  • ListRelatedFoldersAction
  • RemoveAssociatedAction
  • RemoveRelatedObjectsAction
  • SaveEntityAction
  • SetAssociatedAction
  • SetRelatedObjectsAction
  • SignupUserActivationAction
  • UpdateAssociatedAction

Class SetAssociatedAction

Command to replace all entities associated to another entity.

BEdita\Core\Model\Action\BaseAction uses Cake\Core\InstanceConfigTrait (not available)
Extended by BEdita\Core\Model\Action\UpdateAssociatedAction
Extended by BEdita\Core\Model\Action\SetAssociatedAction uses BEdita\Core\Model\Action\AssociatedTrait (not available)
Namespace: BEdita\Core\Model\Action
Since: 4.0.0
Located at Core/src/Model/Action/SetAssociatedAction.php

Methods summary

protected integer|false
# update( Cake\Datasource\EntityInterface $entity, Cake\Datasource\EntityInterface|Cake\Datasource\EntityInterface[]|null $relatedEntities )

Replace existing relations.

Replace existing relations.

Parameters

$entity
Source entity.
$relatedEntities
Related entity(-ies).

Returns

integer|false
Number of updated relationships, or false on failure.

Throws

RuntimeException
Throws an exception if an unsupported association is passed.
protected integer|false
# toMany( Cake\Datasource\EntityInterface $entity, array $relatedEntities )

Process action for to-many relationships.

Process action for to-many relationships.

Parameters

$entity
Source entity.
$relatedEntities
Related entities.

Returns

integer|false
protected integer|false
# belongsTo( Cake\Datasource\EntityInterface $entity, Cake\Datasource\EntityInterface $relatedEntity = null )

Process action for "belongs to" relationships.

Process action for "belongs to" relationships.

Parameters

$entity
Source entity.
$relatedEntity
Related entity.

Returns

integer|false
protected integer|false
# hasOne( Cake\Datasource\EntityInterface $entity, Cake\Datasource\EntityInterface $relatedEntity = null )

Process action for "has one" relationships.

Process action for "has one" relationships.

Parameters

$entity
Source entity.
$relatedEntity
Related entity.

Returns

integer|false

Methods inherited from BEdita\Core\Model\Action\UpdateAssociatedAction

execute(), initialize()

Methods inherited from BEdita\Core\Model\Action\BaseAction

__construct(), __invoke()

Properties summary

Properties inherited from BEdita\Core\Model\Action\UpdateAssociatedAction

$Association

Properties inherited from BEdita\Core\Model\Action\BaseAction

$_defaultConfig

Magic properties inherited from BEdita\Core\Model\Action\UpdateAssociatedAction

$Association

BEdita API doc | 4-cactus API documentation generated by ApiGen