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.2 API

  • Overview
  • Tree
  • Deprecated
  • Version:
    • 2.2
      • 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

Classes

  • CakeErrorController
  • Component
  • ComponentCollection
  • Controller
  • Scaffold

Class ComponentCollection

Components collection is used as a registry for loaded components and handles loading and constructing component class objects.

ObjectCollection
Extended by ComponentCollection implements CakeEventListener
Package: Cake\Controller
Copyright: Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
License: License (http://www.opensource.org/licenses/mit-license.php)
Location: Cake/Controller/ComponentCollection.php

Properties summary

  • $_Controller protected
    Controller
    The controller that this collection was initialized with.

Inherited Properties

  • _enabled, _loaded, defaultPriority

Method Summary

  • getController() public
    Get the controller associated with the collection.
  • implementedEvents() public

    Returns the implemented events that will get routed to the trigger function in order to dispatch them separately on each component

  • init() public

    Initializes all the Components for a controller. Attaches a reference of each component to the Controller.

  • load() public

    Loads/constructs a component. Will return the instance in the registry if it already exists. You can use $settings['enabled'] = false to disable callbacks on a component when loading it. Callbacks default to on. Disabled component methods work as normal, only callbacks are disabled.

Method Detail

getController() public ¶

getController( )

Get the controller associated with the collection.

Returns
Controller.

implementedEvents() public ¶

implementedEvents( )

Returns the implemented events that will get routed to the trigger function in order to dispatch them separately on each component

Returns
array
Implementation of
CakeEventListener::implementedEvents()

init() public ¶

init( Controller $Controller )

Initializes all the Components for a controller. Attaches a reference of each component to the Controller.

Parameters
Controller $Controller
Controller to initialize components for.

load() public ¶

load( string $component , array $settings = array() )

Loads/constructs a component. Will return the instance in the registry if it already exists. You can use $settings['enabled'] = false to disable callbacks on a component when loading it. Callbacks default to on. Disabled component methods work as normal, only callbacks are disabled.

You can alias your component as an existing component by setting the 'className' key, i.e., {{{ public $components = array( 'Email' => array( 'className' => 'AliasedEmail' ); ); }}} All calls to the Email component would use AliasedEmail instead.

Parameters
string $component
Component name to load
array $settings optional array()
Settings for the component.
Returns
Component
A component object, Either the existing loaded component or a new one.
Throws
MissingComponentException
when the component could not be found

Methods inherited from ObjectCollection

__get() public ¶

__get( string $name )

Provide public read access to the loaded objects

Parameters
string $name
Name of property to read
Returns
mixed

__isset() public ¶

__isset( string $name )

Provide isset access to _loaded

Parameters
string $name
Name of object being checked.
Returns
boolean

attached() public ¶

attached( string $name = null )

Gets the list of attached objects, or, whether the given object is attached

Parameters
string $name optional null

Optional. The name of the behavior to check the status of. If omitted, returns an array of currently-attached behaviors

Returns
mixed

If $name is specified, returns the boolean status of the corresponding behavior. Otherwise, returns an array of all attached behaviors.


disable() public ¶

disable( string|array $name )

Disables callbacks on a object or array of objects. Public object methods are still callable as normal.

Parameters
string|array $name
CamelCased name of the objects(s) to disable (string or array)

enable() public ¶

enable( string|array $name , boolean $prioritize = true )

Enables callbacks on an object or array of objects

Parameters
string|array $name
CamelCased name of the object(s) to enable (string or array)
boolean $prioritize optional true
enabled list after enabling object(s)

enabled() public ¶

enabled( string $name = null )

Gets the list of currently-enabled objects, or, the current status of a single objects

Parameters
string $name optional null

Optional. The name of the object to check the status of. If omitted, returns an array of currently-enabled object

Returns
mixed

If $name is specified, returns the boolean status of the corresponding object. Otherwise, returns an array of all enabled objects.


normalizeObjectArray() public static ¶

normalizeObjectArray( array $objects )

Normalizes an object array, creates an array that makes lazy loading easier

Parameters
array $objects
Array of child objects to normalize.
Returns
array
Array of normalized objects.

prioritize() public ¶

prioritize( )

Prioritize list of enabled object

Returns
array
Prioritized list of object

set() public ¶

set( string $name = null , Object $object = null )

Adds or overwrites an instantiated object to the collection

Parameters
string $name optional null
Name of the object
Object $object optional null
The object to use
Returns
array
Loaded objects

setPriority() public ¶

setPriority( string|array $name , integer|null $priority = null )

Set priority for an object or array of objects

Parameters
string|array $name

CamelCased name of the object(s) to enable (string or array) If string the second param $priority is used else it should be an associative array with keys as object names and values as priorities to set.

integer|null $priority optional null
priority to set or null for default

trigger() public ¶

trigger( string $callback , array $params = array() , array $options = array() )

Trigger a callback method on every object in the collection. Used to trigger methods on objects in the collection. Will fire the methods in the order they were attached.

Options

  • breakOn Set to the value or values you want the callback propagation to stop on. Can either be a scalar value, or an array of values to break on. Defaults to false.

  • break Set to true to enabled breaking. When a trigger is broken, the last returned value will be returned. If used in combination with collectReturn the collected results will be returned. Defaults to false.

  • collectReturn Set to true to collect the return of each object into an array. This array of return values will be returned from the trigger() call. Defaults to false.

  • modParams Allows each object the callback gets called on to modify the parameters to the next object. Setting modParams to an integer value will allow you to modify the parameter with that index. Any non-null value will modify the parameter index indicated. Defaults to false.

Parameters
string $callback

$callback|CakeEvent Method to fire on all the objects. Its assumed all the objects implement the method you are calling. If an instance of CakeEvent is provided, then then Event name will parsed to get the callback name. This is done by getting the last word after any dot in the event name (eg. Model.afterSave event will trigger the afterSave callback)

array $params optional array()
Array of parameters for the triggered callback.
array $options optional array()
Array of options.
Returns
mixed
Either the last result or all results if collectReturn is on.
Throws
CakeException
when modParams is used with an index that does not exist.

unload() public ¶

unload( string $name )

Name of the object to remove from the collection

Parameters
string $name
Name of the object to delete.

Properties detail

$_Controller ¶

protected Controller

The controller that this collection was initialized with.

null
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