Class App

Constants summary

• string
  APPEND ¶
  'append'
• string
  PREPEND ¶
  'prepend'
• boolean
  RESET ¶
  true

Properties summary

• $_cacheChange protected static
  boolean
  Indicates whether the class cache should be stored again because of an addition to it
• $_classMap protected static
  array
  Holds the location of each class
• $_map protected static
  array
  Holds key/value pairs of $type => file path.
• $_objectCacheChange protected static
  boolean
  Indicates whether the object cache should be stored again because of an addition to it
• $_objects protected static
  array
  Holds and key => value array of object types.
• $_packageFormat protected static
  array
  Holds the templates for each customizable package path in the application
• $_packages protected static
  array
  Holds the possible paths for each package name
• $bootstrapping public static
  boolean

  Indicates the the Application is in the bootstrapping process. Used to better cache loaded classes while the cache libraries have not been yet initialized

• $legacy public static
  array
  Maps an old style CakePHP class type to the corresponding package
• $return public static
  boolean
  Whether or not to return the file that is loaded.
• $search public static
  array
  Paths to search for files.
• $types public static
  array
  List of object types and their properties

Method Summary

• _loadClass() protected static

  Helper function to include classes This is a compatibility wrapper around using App::uses() and automatic class loading

• _loadFile() protected static

  Helper function to include single files

• _loadVendor() protected static

  Helper function to load files from vendors folders

• _map() protected static

  Maps the $name to the $file.

• _mapped() protected static

  Returns a file's complete path.

• _packageFormat() protected static

  Sets then returns the templates for each customizable package path

• build() public static

  Sets up each package location on the file system. You can configure multiple search paths for each package, those will be used to look for files one folder at a time in the specified order All paths should be terminated with a Directory separator

• core() public static

  Returns the full path to a package inside the CakePHP core

• import() public static

  Finds classes based on $name or specific file(s) to search. Calling App::import() will not construct any classes contained in the files. It will only find and require() the file.

• init() public static

  Initializes the cache for App, registers a shutdown function.

• load() public static

  Method to handle the automatic class loading. It will look for each class' package defined using App::uses() and with this information it will resolve the package name to a full path to load the class from. File name for each class should follow the class name. For instance, if a class is name MyCustomClass the file name should be MyCustomClass.php

• location() public static

  Returns the package name where a class was defined to be located at

• objects() public static

  Returns an array of objects of the given type.

• path() public static

  Used to read information stored path

• paths() public static

  Get all the currently loaded paths from App. Useful for inspecting or storing all paths App knows about. For a paths to a specific package use App::path()

• pluginPath() public static

  Gets the path that a plugin is on. Searches through the defined plugin paths.

• shutdown() public static

  Object destructor.

• themePath() public static

  Finds the path that a theme is on. Searches through the defined theme paths.

• uses() public static

  Declares a package for a class. This package location will be used by the automatic class loader if the class is tried to be used

Method Detail

Properties detail

false

array()

array()

false

array()

array()

array()

false

array(
    'models' => 'Model',
    'behaviors' => 'Model/Behavior',
    'datasources' => 'Model/Datasource',
    'controllers' => 'Controller',
    'components' => 'Controller/Component',
    'views' => 'View',
    'helpers' => 'View/Helper',
    'shells' => 'Console/Command',
    'libs' => 'Lib',
    'vendors' => 'Vendor',
    'plugins' => 'Plugin',
)

false

array()

array(
    'class' => array('extends' => null, 'core' => true),
    'file' => array('extends' => null, 'core' => true),
    'model' => array('extends' => 'AppModel', 'core' => false),
    'behavior' => array('suffix' => 'Behavior', 'extends' => 'Model/ModelBehavior', 'core' => true),
    'controller' => array('suffix' => 'Controller', 'extends' => 'AppController', 'core' => true),
    'component' => array('suffix' => 'Component', 'extends' => null, 'core' => true),
    'lib' => array('extends' => null, 'core' => true),
    'view' => array('suffix' => 'View', 'extends' => null, 'core' => true),
    'helper' => array('suffix' => 'Helper', 'extends' => 'AppHelper', 'core' => true),
    'vendor' => array('extends' => null, 'core' => true),
    'shell' => array('suffix' => 'Shell', 'extends' => 'AppShell', 'core' => true),
    'plugin' => array('extends' => null, 'core' => true)
)