CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Reporting Security Issues
    • Privacy Policy
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Get Involved
    • Issues (GitHub)
    • Bakery
    • Featured Resources
    • Training
    • Meetups
    • My CakePHP
    • CakeFest
    • Newsletter
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • Help & Support
    • Forum
    • Stack Overflow
    • Slack
    • Paid Support
CakePHP

C CakePHP 2.10 API

  • Overview
  • Tree
  • Deprecated
  • Version:
    • 2.10
      • 4.2
      • 4.1
      • 4.0
      • 3.9
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

Packages

  • Cake
    • Cache
      • Engine
    • Configure
    • Console
      • Command
        • Task
    • Controller
      • Component
        • Acl
        • Auth
    • Core
    • Error
    • Event
    • I18n
    • Log
      • Engine
    • Model
      • Behavior
      • Datasource
        • Database
        • Session
      • Validator
    • Network
      • Email
      • Http
    • Routing
      • Filter
      • Route
    • TestSuite
      • Coverage
      • Fixture
      • Reporter
    • Utility
    • View
      • Helper
  • None

Classes

  • CakeNumber
  • CakeText
  • CakeTime
  • ClassRegistry
  • Debugger
  • File
  • Folder
  • Hash
  • Inflector
  • ObjectCollection
  • Sanitize
  • Security
  • Set
  • String
  • Validation
  • Xml
  1: <?php
  2: /**
  3:  * CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
  4:  * Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
  5:  *
  6:  * Licensed under The MIT License
  7:  * For full copyright and license information, please see the LICENSE.txt
  8:  * Redistributions of files must retain the above copyright notice.
  9:  *
 10:  * @copyright     Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
 11:  * @link          https://cakephp.org CakePHP(tm) Project
 12:  * @license       https://opensource.org/licenses/mit-license.php MIT License
 13:  */
 14: 
 15: /**
 16:  * Deals with Collections of objects. Keeping registries of those objects,
 17:  * loading and constructing new objects and triggering callbacks. Each subclass needs
 18:  * to implement its own load() functionality.
 19:  *
 20:  * All core subclasses of ObjectCollection by convention loaded objects are stored
 21:  * in `$this->_loaded`. Enabled objects are stored in `$this->_enabled`. In addition,
 22:  * they all support an `enabled` option that controls the enabled/disabled state of the object
 23:  * when loaded.
 24:  *
 25:  * @package       Cake.Utility
 26:  * @since CakePHP(tm) v 2.0
 27:  */
 28: abstract class ObjectCollection {
 29: 
 30: /**
 31:  * List of the currently-enabled objects
 32:  *
 33:  * @var array
 34:  */
 35:     protected $_enabled = array();
 36: 
 37: /**
 38:  * A hash of loaded objects, indexed by name
 39:  *
 40:  * @var array
 41:  */
 42:     protected $_loaded = array();
 43: 
 44: /**
 45:  * Default object priority. A non zero integer.
 46:  *
 47:  * @var int
 48:  */
 49:     public $defaultPriority = 10;
 50: 
 51: /**
 52:  * Loads a new object onto the collection. Can throw a variety of exceptions
 53:  *
 54:  * Implementations of this class support a `$options['enabled']` flag which enables/disables
 55:  * a loaded object.
 56:  *
 57:  * @param string $name Name of object to load.
 58:  * @param array $options Array of configuration options for the object to be constructed.
 59:  * @return CakeObject the constructed object
 60:  */
 61:     abstract public function load($name, $options = array());
 62: 
 63: /**
 64:  * Trigger a callback method on every object in the collection.
 65:  * Used to trigger methods on objects in the collection. Will fire the methods in the
 66:  * order they were attached.
 67:  *
 68:  * ### Options
 69:  *
 70:  * - `breakOn` Set to the value or values you want the callback propagation to stop on.
 71:  *    Can either be a scalar value, or an array of values to break on. Defaults to `false`.
 72:  *
 73:  * - `break` Set to true to enabled breaking. When a trigger is broken, the last returned value
 74:  *    will be returned. If used in combination with `collectReturn` the collected results will be returned.
 75:  *    Defaults to `false`.
 76:  *
 77:  * - `collectReturn` Set to true to collect the return of each object into an array.
 78:  *    This array of return values will be returned from the trigger() call. Defaults to `false`.
 79:  *
 80:  * - `modParams` Allows each object the callback gets called on to modify the parameters to the next object.
 81:  *    Setting modParams to an integer value will allow you to modify the parameter with that index.
 82:  *    Any non-null value will modify the parameter index indicated.
 83:  *    Defaults to false.
 84:  *
 85:  * @param string|CakeEvent $callback Method to fire on all the objects. Its assumed all the objects implement
 86:  *   the method you are calling. If an instance of CakeEvent is provided, then then Event name will parsed to
 87:  *   get the callback name. This is done by getting the last word after any dot in the event name
 88:  *   (eg. `Model.afterSave` event will trigger the `afterSave` callback)
 89:  * @param array $params Array of parameters for the triggered callback.
 90:  * @param array $options Array of options.
 91:  * @return mixed Either the last result or all results if collectReturn is on.
 92:  * @throws CakeException when modParams is used with an index that does not exist.
 93:  */
 94:     public function trigger($callback, $params = array(), $options = array()) {
 95:         if (empty($this->_enabled)) {
 96:             return true;
 97:         }
 98:         $subject = null;
 99:         if ($callback instanceof CakeEvent) {
100:             $event = $callback;
101:             if (is_array($event->data)) {
102:                 $params =& $event->data;
103:             }
104:             if (empty($event->omitSubject)) {
105:                 $subject = $event->subject();
106:             }
107: 
108:             foreach (array('break', 'breakOn', 'collectReturn', 'modParams') as $opt) {
109:                 if (isset($event->{$opt})) {
110:                     $options[$opt] = $event->{$opt};
111:                 }
112:             }
113:             $parts = explode('.', $event->name());
114:             $callback = array_pop($parts);
115:         }
116:         $options += array(
117:             'break' => false,
118:             'breakOn' => false,
119:             'collectReturn' => false,
120:             'modParams' => false
121:         );
122:         $collected = array();
123:         $list = array_keys($this->_enabled);
124:         if ($options['modParams'] !== false && !isset($params[$options['modParams']])) {
125:             throw new CakeException(__d('cake_dev', 'Cannot use modParams with indexes that do not exist.'));
126:         }
127:         $result = null;
128:         foreach ($list as $name) {
129:             $result = call_user_func_array(array($this->_loaded[$name], $callback), array_values(array_filter(compact('subject')) + $params));
130:             if ($options['collectReturn'] === true) {
131:                 $collected[] = $result;
132:             }
133:             if ($options['break'] && ($result === $options['breakOn'] ||
134:                 (is_array($options['breakOn']) && in_array($result, $options['breakOn'], true)))
135:             ) {
136:                 return $result;
137:             } elseif ($options['modParams'] !== false && !in_array($result, array(true, false, null), true)) {
138:                 $params[$options['modParams']] = $result;
139:             }
140:         }
141:         if ($options['modParams'] !== false) {
142:             return $params[$options['modParams']];
143:         }
144:         return $options['collectReturn'] ? $collected : $result;
145:     }
146: 
147: /**
148:  * Provide public read access to the loaded objects
149:  *
150:  * @param string $name Name of property to read
151:  * @return mixed
152:  */
153:     public function __get($name) {
154:         if (isset($this->_loaded[$name])) {
155:             return $this->_loaded[$name];
156:         }
157:         return null;
158:     }
159: 
160: /**
161:  * Provide isset access to _loaded
162:  *
163:  * @param string $name Name of object being checked.
164:  * @return bool
165:  */
166:     public function __isset($name) {
167:         return isset($this->_loaded[$name]);
168:     }
169: 
170: /**
171:  * Enables callbacks on an object or array of objects
172:  *
173:  * @param string|array $name CamelCased name of the object(s) to enable (string or array)
174:  * @param bool $prioritize Prioritize enabled list after enabling object(s)
175:  * @return void
176:  */
177:     public function enable($name, $prioritize = true) {
178:         $enabled = false;
179:         foreach ((array)$name as $object) {
180:             list(, $object) = pluginSplit($object);
181:             if (isset($this->_loaded[$object]) && !isset($this->_enabled[$object])) {
182:                 $priority = $this->defaultPriority;
183:                 if (isset($this->_loaded[$object]->settings['priority'])) {
184:                     $priority = $this->_loaded[$object]->settings['priority'];
185:                 }
186:                 $this->_enabled[$object] = array($priority);
187:                 $enabled = true;
188:             }
189:         }
190:         if ($prioritize && $enabled) {
191:             $this->prioritize();
192:         }
193:     }
194: 
195: /**
196:  * Prioritize list of enabled object
197:  *
198:  * @return array Prioritized list of object
199:  */
200:     public function prioritize() {
201:         $i = 1;
202:         foreach ($this->_enabled as $name => $priority) {
203:             $priority[1] = $i++;
204:             $this->_enabled[$name] = $priority;
205:         }
206:         asort($this->_enabled);
207:         return $this->_enabled;
208:     }
209: 
210: /**
211:  * Set priority for an object or array of objects
212:  *
213:  * @param string|array $name CamelCased name of the object(s) to enable (string or array)
214:  *  If string the second param $priority is used else it should be an associative array
215:  *  with keys as object names and values as priorities to set.
216:  * @param int|null $priority Integer priority to set or null for default
217:  * @return void
218:  */
219:     public function setPriority($name, $priority = null) {
220:         if (is_string($name)) {
221:             $name = array($name => $priority);
222:         }
223:         foreach ($name as $object => $objectPriority) {
224:             list(, $object) = pluginSplit($object);
225:             if (isset($this->_loaded[$object])) {
226:                 if ($objectPriority === null) {
227:                     $objectPriority = $this->defaultPriority;
228:                 }
229:                 $this->_loaded[$object]->settings['priority'] = $objectPriority;
230:                 if (isset($this->_enabled[$object])) {
231:                     $this->_enabled[$object] = array($objectPriority);
232:                 }
233:             }
234:         }
235:         $this->prioritize();
236:     }
237: 
238: /**
239:  * Disables callbacks on an object or array of objects. Public object methods are still
240:  * callable as normal.
241:  *
242:  * @param string|array $name CamelCased name of the objects(s) to disable (string or array)
243:  * @return void
244:  */
245:     public function disable($name) {
246:         foreach ((array)$name as $object) {
247:             list(, $object) = pluginSplit($object);
248:             unset($this->_enabled[$object]);
249:         }
250:     }
251: 
252: /**
253:  * Gets the list of currently-enabled objects, or, the current status of a single objects
254:  *
255:  * @param string $name Optional. The name of the object to check the status of. If omitted,
256:  *   returns an array of currently-enabled object
257:  * @return mixed If $name is specified, returns the boolean status of the corresponding object.
258:  *   Otherwise, returns an array of all enabled objects.
259:  */
260:     public function enabled($name = null) {
261:         if (!empty($name)) {
262:             list(, $name) = pluginSplit($name);
263:             return isset($this->_enabled[$name]);
264:         }
265:         return array_keys($this->_enabled);
266:     }
267: 
268: /**
269:  * Gets the list of attached objects, or, whether the given object is attached
270:  *
271:  * @param string $name Optional. The name of the object to check the status of. If omitted,
272:  *   returns an array of currently-attached objects
273:  * @return mixed If $name is specified, returns the boolean status of the corresponding object.
274:  *    Otherwise, returns an array of all attached objects.
275:  * @deprecated 3.0.0 Will be removed in 3.0. Use loaded instead.
276:  */
277:     public function attached($name = null) {
278:         return $this->loaded($name);
279:     }
280: 
281: /**
282:  * Gets the list of loaded objects, or, whether the given object is loaded
283:  *
284:  * @param string $name Optional. The name of the object to check the status of. If omitted,
285:  *   returns an array of currently-loaded objects
286:  * @return mixed If $name is specified, returns the boolean status of the corresponding object.
287:  *    Otherwise, returns an array of all loaded objects.
288:  */
289:     public function loaded($name = null) {
290:         if (!empty($name)) {
291:             list(, $name) = pluginSplit($name);
292:             return isset($this->_loaded[$name]);
293:         }
294:         return array_keys($this->_loaded);
295:     }
296: 
297: /**
298:  * Name of the object to remove from the collection
299:  *
300:  * @param string $name Name of the object to delete.
301:  * @return void
302:  */
303:     public function unload($name) {
304:         list(, $name) = pluginSplit($name);
305:         unset($this->_loaded[$name], $this->_enabled[$name]);
306:     }
307: 
308: /**
309:  * Adds or overwrites an instantiated object to the collection
310:  *
311:  * @param string $name Name of the object
312:  * @param CakeObject $object The object to use
313:  * @return array Loaded objects
314:  */
315:     public function set($name = null, $object = null) {
316:         if (!empty($name) && !empty($object)) {
317:             list(, $name) = pluginSplit($name);
318:             $this->_loaded[$name] = $object;
319:         }
320:         return $this->_loaded;
321:     }
322: 
323: /**
324:  * Normalizes an object array, creates an array that makes lazy loading
325:  * easier
326:  *
327:  * @param array $objects Array of child objects to normalize.
328:  * @return array Array of normalized objects.
329:  */
330:     public static function normalizeObjectArray($objects) {
331:         $normal = array();
332:         foreach ($objects as $i => $objectName) {
333:             $options = array();
334:             if (!is_int($i)) {
335:                 $options = (array)$objectName;
336:                 $objectName = $i;
337:             }
338:             list(, $name) = pluginSplit($objectName);
339:             $normal[$name] = array('class' => $objectName, 'settings' => $options);
340:         }
341:         return $normal;
342:     }
343: 
344: }
345: 
OpenHub
Rackspace
Rackspace
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Reporting Security Issues
  • Privacy Policy
  • Logos & Trademarks
  • Community
  • Get Involved
  • Issues (GitHub)
  • Bakery
  • Featured Resources
  • Training
  • Meetups
  • My CakePHP
  • CakeFest
  • Newsletter
  • Linkedin
  • YouTube
  • Facebook
  • Twitter
  • Mastodon
  • Help & Support
  • Forum
  • Stack Overflow
  • Slack
  • Paid Support

Generated using CakePHP API Docs