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 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 <?php
/*-----8<--------------------------------------------------------------------
*
* BEdita - a semantic content management framework
*
* Copyright 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-----
*/
/**
* Migration behavior to translate basic Cake callbacks to BeCallbackManager events.
*
* When this behavior is attached to a model `MyModel`, all enabled behaviors with a name like
* `MyModelSomethingCallbackBehavior` (where `Something` can be replaced with anything you want)
* will be automatically attached to `MyModel`'s events.
*
* You can also attach a callback behavior to *all* object type using the `BEObject` reserved name:
* for instance, you might create a `BEObjectSomethingCallbackBehavior` to attach callback operations
* to every core and plugin object type at once.
*
* If this behavior is attached with configuration key `callbackManager` explicitely set to false,
* callbacks behaviors will be attached using CakePHP's built in associations.
* Otherwise, public callback behaviors' methods will be treated as listeners for corresponding events,
* thus allowing finer control on event propagation and details, as well as detachment of
* single methods within a behavior.
*
* @see BeCallbackManager
*/
class CallbackBehavior extends ModelBehavior {
/**
* Standard configuration.
*
* @var array
* @access private
*/
private $stdConfig = array(
'callbackManager' => true,
'_behaviors' => array(),
'_listeners' => array(),
);
/**
* Configuration.
*
* @var array
* @access protected
*/
protected $config = array();
/**
* Callback Manager.
*
* @var BeCallbackManager
* @access private
*/
private $manager = null;
/**
* Behaviors list.
*
* @var array
* @access private
*/
private $behaviors = null;
/**
* Initialize and return callback manager.
*
* @return BeCallbackManager
* @access private
*/
private function manager() {
if (is_null($this->manager)) {
$this->manager = BeLib::getObject('BeCallbackManager');
}
return $this->manager;
}
/**
* Load and return behaviors list.
*
* @return array
* @access private
*/
private function behaviors() {
if (is_null($this->behaviors)) {
$this->behaviors = App::objects('behavior');
}
return $this->behaviors;
}
/**
* Setup callback behavior.
*
* @param Model $model Model.
* @param array $config Configuration.
* @access public
*/
public function setup(Model &$model, array $config = array()) {
if (array_key_exists($model->alias, $this->config)) {
// Already configured.
return;
}
$objectTypes = Set::classicExtract(Configure::read('objectTypes'), '{n}.model') ?: array();
if (!in_array($model->alias, $objectTypes)) {
// Not a BE Object.
return;
}
// Setup config.
$this->config[$model->alias] = array_merge($this->stdConfig, $config);
// Filter behaviors by their name, and attach them to model.
// #723 - Use `BEObject` as a reserved name for wildcard callbacks.
$behaviors = preg_grep("/^(?:BEObject|{$model->alias})\w+Callback$/", $this->behaviors());
foreach ($behaviors as $beh) {
if ($this->config[$model->alias]['callbackManager']) {
// Attach listeners using callback manager.
// Import.
$import = App::import('Behavior', $beh);
$class = $beh . 'Behavior';
if (!$import || !class_exists($class)) {
// Failed.
continue;
}
// Initialize behavior.
$behavior = null;
if (ClassRegistry::isKeySet($class)) {
$behavior = ClassRegistry::getObject($class);
} else {
$behavior = new $class();
ClassRegistry::addObject($class, $behavior);
}
$behavior->setup($model);
// Bind listeners.
$methods = array_diff(get_class_methods($behavior), array(
'cakeError', 'log', 'requestAction', 'toString',
'Object', 'dispatchMethod', 'onError', 'setup', 'cleanup',
));
foreach ($methods as $meth) {
if ($meth[0] == '_') {
continue;
}
$eventName = $model->alias . '.' . Inflector::camelize($meth);
$listener = array($class, $meth);
$this->manager()->bind($eventName, $listener);
if (!array_key_exists($eventName, $this->config[$model->alias]['_listeners'])) {
$this->config[$model->alias]['_listeners'][$eventName] = array();
}
array_push($this->config[$model->alias]['_listeners'][$eventName], $listener);
}
unset($behavior);
} else {
// Simply attach behavior.
$model->Behaviors->attach($beh);
array_push($this->config[$model->alias]['_behaviors'], $beh);
}
}
}
/**
* Detach callback behavior.
*
* @param Model $model Model.
* @access public
*/
public function cleanup(Model &$model) {
foreach ($this->config[$model->alias]['_behaviors'] as $beh) {
// Detach previously attached behaviors.
$model->Behaviors->detach($beh);
}
foreach ($this->config[$model->alias]['_listeners'] as $eventName => $callbacks) {
// Unbind previously binded listeners.
foreach ($callbacks as $callback) {
$this->manager()->unbind($eventName, $callback);
}
}
unset($this->config[$model->alias]);
}
/**
* Migration helper for event `beforeFind`.
*
* @param Model $model Model.
* @param array $query Query.
* @return mixed Result.
* @access public
*/
public function beforeFind(Model &$model, array $query) {
$evt = $this->manager()->trigger("{$model->alias}.BeforeFind", array(
'model' => &$model,
'query' => $query,
));
return $evt->result;
}
/**
* Migration helper for event `afterFind`.
*
* @param Model $model Model.
* @param mixed $results Results.
* @param bool $primary Primary.
* @return mixed Result.
* @access public
*/
public function afterFind(Model &$model, $results, $primary) {
$evt = $this->manager()->trigger("{$model->alias}.AfterFind", array(
'model' => &$model,
'results' => $results,
'primary' => $primary,
));
return $evt->result;
}
/**
* Migration helper for event `beforeValidate`.
*
* @param Model $model Model.
* @return mixed Result.
* @access public
*/
public function beforeValidate(Model &$model) {
$evt = $this->manager()->trigger("{$model->alias}.BeforeValidate", array(
'model' => &$model,
));
return $evt->result;
}
/**
* Migration helper for event `beforeSave`.
*
* @param Model $model Model.
* @return mixed Result.
* @access public
*/
public function beforeSave(Model &$model) {
$evt = $this->manager()->trigger("{$model->alias}.BeforeSave", array(
'model' => &$model,
));
return $evt->result;
}
/**
* Migration helper for event `afterSave`.
*
* @param Model $model Model.
* @param bool $created Created.
* @return mixed Result.
* @access public
*/
public function afterSave(Model &$model, $created) {
$evt = $this->manager()->trigger("{$model->alias}.AfterSave", array(
'model' => &$model,
'created' => $created,
));
return $evt->result;
}
/**
* Migration helper for event `beforeDelete`.
*
* @param Model $model Model.
* @param bool $cascade Cascade.
* @return mixed Result.
* @access public
*/
public function beforeDelete(Model &$model, $cascade = true) {
$evt = $this->manager()->trigger("{$model->alias}.BeforeDelete", array(
'model' => &$model,
'cascade' => $cascade,
));
return $evt->result;
}
/**
* Migration helper for event `afterDelete`.
*
* @param Model $model Model.
* @return mixed Result.
* @access public
*/
public function afterDelete(Model &$model) {
$evt = $this->manager()->trigger("{$model->alias}.AfterDelete", array(
'model' => &$model,
));
return $evt->result;
}
}