File models/behaviors/delete_object.php | BEdita API doc

  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185

<?php
/*-----8<--------------------------------------------------------------------
 *
 * BEdita - a semantic content management framework
 *
 * Copyright 2008-2014 ChannelWeb Srl, Chialab Srl
 *
 * This file is part of BEdita: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * BEdita is distributed WITHOUT ANY WARRANTY; without even the implied
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU Lesser General Public License for more details.
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with BEdita (see LICENSE.LGPL).
 * If not, see <http://gnu.org/licenses/lgpl-3.0.html>.
 *
 *------------------------------------------------------------------->8-----
 */

/**
 * DeleteObjectBehavior class
 *
 * Delete object using dependence of foreign key.
 * Delete only the record of base table then database's referential integrity do the rest
 *
 */
class DeleteObjectBehavior extends ModelBehavior {

    /**
     * contain base table
     */
    public $config = array();

    public function setup(&$model, $config = array()) {
        $this->config[$model->name] = $config;
    }

    /**
     * Delete all associations, they will be re-established after deleting
     * Considering foreignKeys among tables, force deleting records on table 'objects'
     *
     * if specified delete related object too
     *
     * @param Model $model
     * @return boolean
     */
    public function beforeDelete(&$model) {
        // prepare objects to delete from cache
        if ($model->BEObject->isCacheableOn()) {
            $model->BEObject->setObjectsToClean($model->id);
        }

        $model->tmpTable = $model->table;
        if (empty($model->tmpAssociations)) {
            $model->tmpAssociations = array();

            $associations = array('hasOne', 'hasMany', 'belongsTo', 'hasAndBelongsToMany');
            foreach ($associations as $association) {
                $model->tmpAssociations[$association] = $model->$association;
                $model->$association = array();
            }
        }
        $configure = $this->config[$model->name];

        if (!empty($configure)) {
            if (is_string($configure)) {
                $model->table = $configure;
            } elseif (is_array($configure) && count($configure) == 1) {

                if (is_string(key($configure))) {

                    $model->table = key($configure);
                    if (!empty($configure[$model->table]['relatedObjects'])) {
                        $this->delRelatedObjects($configure[$model->table]['relatedObjects'], $model->id);
                    }

                } else {
                    $model->table = array_shift($configure);
                }
            }
        }

        $model->table = (isset($configure) && is_string($configure)) ? $configure : $model->table;

        // Delete object references on tree as well
        $Tree = ClassRegistry::init('Tree');
        $ok = true;
        if ($model instanceof BeditaCollectionModel) {
            $ok = $model->deleteCollection($model->id);
        } else {
            $parentIds = $Tree->getParents($model->id);
            foreach ($parentIds as $parentId) {
                $ok = $Tree->removeChild($model->id, $parentId) && $ok;
            }
        }
        if (!$ok) {
            throw new BeditaException(__('Error deleting tree references', true));
        }

        $st = ClassRegistry::init('SearchText');
        $st->removeObject($model->id);
        $this->deleteAnnotations($model->id);
        return true;
    }

    /**
     * Re-establish associations (insert associations)
     *
     */
    public function afterDelete(&$model) {
        if (!empty($model->tmpTable)) {
            $model->table = $model->tmpTable;
            unset($model->tmpTable);
        }
        if (!empty($model->tmpAssociations)) {
            // Re-establish associations
            foreach ($model->tmpAssociations as $association => $v) {
                $model->$association = $v;
            }
            unset($model->tmpAssociations);
        }

        // clear cache
        if ($model->BEObject->isCacheableOn()) {
            $model->BEObject->clearCache($model->id, false);
        }
    }

    /**
     * Delete related objects
     *
     * @param array $relations: array of relations type.
     *                          The object related to main object by a relation in $relations will be deleted
     * @param int $object_id: main object that has to be deleted
     */
    private function delRelatedObjects($relations, $object_id) {
        $o = ClassRegistry::init('BEObject') ;
        $res = $o->find('first', array(
            'contain' => array('RelatedObject'),
            'conditions' => array('BEObject.id' => $object_id)
        ));

        if (!empty($res['RelatedObject'])) {
            $conf = Configure::getInstance();
            foreach ($res['RelatedObject'] as $obj) {
                if (in_array($obj['switch'], $relations)) {
                    $modelClass = $o->getType($obj['object_id']);
                    $model = ClassRegistry::init($modelClass);
                    if (!$model->delete($obj['object_id'])) {
                        throw new BeditaException(__('Error deleting related object ', true), 'id: ' . $obj['object_id'] . ', switch: ' . $obj['switch']);
                    }
                }
            }
        }
    }

    /**
     * delete annotation objects like Comment, EditorNote, etc... related to main object
     *
     * @param int $object_id main object
     */
    private function deleteAnnotations($object_id) {
        // delete annotations
        $annotation = ClassRegistry::init('Annotation');
        $aList = $annotation->find('list', array(
            'fields' => array('id'),
            'conditions' => array('object_id' => $object_id)
        ));

        if (!empty($aList)) {
            $o = ClassRegistry::init('BEObject');
            foreach ($aList as $id) {
                $modelClass = $o->getType($id);
                $model = ClassRegistry::init($modelClass);
                if (!$model->delete($id)) {
                    throw new BeditaException(__('Error deleting annotation ' . $modelClass, true), 'id: ' . $id);
                }
            }
        }
    }

}

Classes

Interfaces

Exceptions