Implements cascading deletes for dependent associations.
Included by HasOne and HasMany association classes.
cascadeDelete(\Cake\Datasource\EntityInterface $entity, array $options = array()) : boolean
Cascade a delete to remove dependent records.
This method does nothing if the association is not dependent.
| \Cake\Datasource\EntityInterface | $entity | The entity that started the cascaded delete. |
| array | $options | The options for the original delete. |
Success.
<?php
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 3.0.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\ORM\Association;
use Cake\Datasource\EntityInterface;
use Cake\ORM\Association\DependentDeleteHelper;
/**
* Implements cascading deletes for dependent associations.
*
* Included by HasOne and HasMany association classes.
*
* @deprecated 3.5.0 Unused in CakePHP now. This class will be removed in 4.0.0
*/
trait DependentDeleteTrait
{
/**
* Cascade a delete to remove dependent records.
*
* This method does nothing if the association is not dependent.
*
* @param \Cake\Datasource\EntityInterface $entity The entity that started the cascaded delete.
* @param array $options The options for the original delete.
* @return bool Success.
*/
public function cascadeDelete(EntityInterface $entity, array $options = [])
{
deprecationWarning(
'The DependentDeleteTrait is deprecated. ' .
'You should use Cake\ORM\Association\DependentDeleteHelper instead.'
);
$helper = new DependentDeleteHelper();
return $helper->cascadeDelete($this, $entity, $options);
}
}