App Class Info:

Class Declaration:

class App extends Object

File name:
cake/libs/configure.php
Description:

Class/file loader and path management.

Class Inheritance

Object

Link
http://book.cakephp.org/view/933/The-App-Class
Since

CakePHP(tm) v 1.2.0.6001

Package
cake
Subpackage
cake.cake.libs

Properties:

Show/Hide parent properties

  • behaviors array

    List of additional path(s) where behavior files reside.

  • __cache boolean

    Determines if $__maps and $__paths cache should be written.

  • components array

    List of additional path(s) where component files reside.

  • controllers array

    List of additional path(s) where controller files reside.

  • datasources array

    List of additional path(s) where datasource files reside.

  • helpers array

    List of additional path(s) where helper files reside.

  • libs array

    List of additional path(s) where libs files reside.

  • __loaded array

    Holds loaded files.

  • locales array

    List of additional path(s) where locale files reside.

  • __map array

    Holds key/value pairs of $type => file path.

  • models array

    List of additional path(s) where model files reside.

  • __objects array

    Holds and key => value array of object types.

  • __paths array

    Holds paths for deep searching of files.

  • plugins array

    List of additional path(s) where plugins reside.

  • return boolean

    Whether or not to return the file that is loaded.

  • search array

    Paths to search for files.

  • shells array

    List of additional path(s) where console shell files reside.

  • types array

    List of object types and their properties

  • vendors array

    List of additional path(s) where vendor packages reside.

  • views array

    List of additional path(s) where view files reside.

Method Summary:

Show/Hide parent methods

build

top

Build path references. Merges the supplied $paths with the base paths and the default core paths.

Parameters:
  • array $paths optional array ( )

    paths defines in config/bootstrap.php

  • boolean $reset optional false

    true will set paths, false merges paths [default] false

Method defined in:
cake/libs/configure.php on line 649
Return

void

Access

public

cakeError

top

Used to report user friendly errors. If there is a file app/error.php or app/app_error.php this file will be loaded error.php is the AppError class it should extend ErrorHandler class.

Parameters:
  • string $method required

    Method to be called in the error class (AppError or ErrorHandler classes)

  • array $messages optional array ( )

    Message that is to be displayed by the error class

Method defined in:
cake/libs/object.php on line 187
Return

error message

Access

public

__construct

top

Class constructor, overridden in descendant classes.

Method defined in:
cake/libs/object.php on line 54

core

top

Returns a key/value list of all paths where core libs are found. Passing $type only returns the values for a given value of $key.

Parameters:
  • string $type optional NULL

    valid values are: 'model', 'behavior', 'controller', 'component', 'view', 'helper', 'datasource', 'libs', and 'cake'

Method defined in:
cake/libs/configure.php on line 728
Return

array numeric keyed array of core lib paths

Access

public

__destruct

top

Object destructor.

Writes cache file if changes have been made to the $__map or $__paths

Method defined in:
cake/libs/configure.php on line 1281
Return

void

Access

private

dispatchMethod

top

Calls a method on this object with the given parameters. Provides an OO wrapper for call_user_func_array

Parameters:
  • string $method required

    Name of the method to call

  • array $params optional array ( )

    Parameter list to use when calling $method

Method defined in:
cake/libs/object.php on line 107
Return

mixed Returns the result of the method call

Access

public

__find

top

Locates the $file in $__paths, searches recursively.

Parameters:
  • string $file required

    full file name

  • boolean $recursive optional true

    search $__paths recursively

Method defined in:
cake/libs/configure.php on line 980
Return

mixed boolean on fail, $file directory path on success

Access

private

getInstance

top

Returns a single instance of App.

Method defined in:
cake/libs/configure.php on line 963
Return

object

Access

public

import

top

Finds classes based on $name or specific file(s) to search.

Parameters:
  • mixed $type optional NULL

    The type of Class if passed as a string, or all params can be passed as an single array to $type,

  • string $name optional NULL

    Name of the Class or a unique name for the file

  • mixed $parent optional true

    boolean true if Class Parent should be searched, accepts key => value array('parent' => $parent ,'file' => $file, 'search' => $search, 'ext' => '$ext'); $ext allows setting the extension of the file name based on Inflector::underscore($name) . ".$ext";

  • array $search optional array ( )

    paths to search for files, array('path 1', 'path 2', 'path 3');

  • string $file optional NULL

    full name of the file to search for including extension

  • $return optional false

Method defined in:
cake/libs/configure.php on line 843
Link
http://book.cakephp.org/view/934/Using-App-import
Return

boolean true if Class is already in memory or if file is found and loaded, false if not

Access

public

__list

top

Returns an array of filenames of PHP files in the given directory.

Parameters:
  • string $path required

    Path to scan for files

  • string $suffix optional false

    if false, return only directories. if string, match and return files

  • $extension optional false

Method defined in:
cake/libs/configure.php on line 1247
Return

array List of directories or files in directory

Access

private

__load

top

Attempts to load $file.

Parameters:
  • string $file required

    full path to file including file name

Method defined in:
cake/libs/configure.php on line 1035
Return

boolean

Access

private

log

top

Convience method to write a message to CakeLog. See CakeLog::write() for more information on writing to logs.

Parameters:
  • string $msg required

    Log message

  • integer $type optional 2

    Error type constant. Defined in app/config/core.php.

Method defined in:
cake/libs/object.php on line 148
Return

boolean Success of log write

Access

public

__map

top

Maps the $name to the $file.

Parameters:
  • string $file required

    full path to file

  • string $name required

    unique name for this map

  • string $type required

    type object being mapped

  • string $plugin required

    camelized if object is from a plugin, the name of the plugin

Method defined in:
cake/libs/configure.php on line 1062
Return

void

Access

private

__mapped

top

Returns a file's complete path.

Parameters:
  • string $name required

    unique name

  • string $type required

    type object

  • string $plugin required

    camelized if object is from a plugin, the name of the plugin

Method defined in:
cake/libs/configure.php on line 1079
Return

mixed, file path if found, false otherwise

Access

private

Object

top

A hack to support __construct() on PHP 4 Hint: descendant classes have no PHP4 class_name() constructors, so this constructor gets called first and calls the top-layer __construct() which (if present) should call parent::__construct()

Method defined in:
cake/libs/object.php on line 43
Return

Object

objects

top

Returns an index of objects of the given type, with the physical path to each object.

Parameters:
  • string $type required

    Type of object, i.e. 'model', 'controller', 'helper', or 'plugin'

  • mixed $path optional NULL

    Optional Scan only the path given. If null, paths for the chosen type will be used.

  • boolean $cache optional true

    Set to false to rescan objects of the chosen type. Defaults to true.

Method defined in:
cake/libs/configure.php on line 770
Return

mixed Either false on incorrect / miss. Or an array of found objects.

Access

public

__openPersistent

top

Open the persistent class file for reading Used by Object::_persist()

Parameters:
  • string $name required

    Name of persisted class

  • string $type optional NULL

    Type of persistance (e.g: registry)

Method defined in:
cake/libs/object.php on line 268
Return

void

Access

private

__overload

top

Used to overload objects as needed.

Parameters:
  • string $type required

    Model or Helper

  • string $name required

    Class name to overload

  • $parent required

Method defined in:
cake/libs/configure.php on line 1100
Access

private

path

top

Used to read information stored path

Usage:

App::path('models'); will return all paths for models

Parameters:
  • string $type required

    type of path

Method defined in:
cake/libs/configure.php on line 632
Return

string array

Access

public

__paths

top

Returns default search paths.

Parameters:
  • string $type required

    type of object to be searched

Method defined in:
cake/libs/configure.php on line 1209
Return

array list of paths

Access

private

_persist

top

Checks for a persistent class file, if found file is opened and true returned If file is not found a file is created and false returned If used in other locations of the model you should choose a unique name for the persistent file There are many uses for this method, see manual for examples

Parameters:
  • string $name required

    name of the class to persist

  • $return required

  • string $object required

    the object to persist

  • $type optional NULL

Method defined in:
cake/libs/object.php on line 218
Return

boolean Success

Access

protected

Todo

add examples to manual

pluginPath

top

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

Parameters:
  • string $plugin required

    CamelCased plugin name to find the path of.

Method defined in:
cake/libs/configure.php on line 708
Return

string full path to the plugin.

__remove

top

Removes file location from map if the file has been deleted.

Parameters:
  • string $name required

    name of object

  • string $type required

    type of object

  • string $plugin required

    camelized name of plugin

Method defined in:
cake/libs/configure.php on line 1231
Return

void

Access

private

requestAction

top

Calls a controller's method from any location. Can be used to connect controllers together or tie plugins into a main application. requestAction can be used to return rendered views or fetch the return value from controller actions.

Parameters:
  • mixed $url required

    String or array-based url.

  • array $extra optional array ( )

    if array includes the key "return" it sets the AutoRender to true.

Method defined in:
cake/libs/object.php on line 80
Return

mixed Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.

Access

public

_savePersistent

top

You should choose a unique name for the persistent file

There are many uses for this method, see manual for examples

Parameters:
  • string $name required

    name used for object to cache

  • object $object required

    the object to persist

Method defined in:
cake/libs/object.php on line 247
Return

boolean true on save, throws error if file can not be created

Access

protected

_set

top

Allows setting of multiple properties of the object in a single line of code. Will only set properties that are part of a class declaration.

Parameters:
  • array $properties optional array ( )

    An associative array containing properties and corresponding values.

Method defined in:
cake/libs/object.php on line 166
Return

void

Access

protected

__settings

top

Loads parent classes based on $type. Returns a prefix or suffix needed for loading files.

Parameters:
  • string $type required

    type of object

  • string $plugin required

    camelized name of plugin

  • boolean $parent required

    false will not attempt to load parent

Method defined in:
cake/libs/configure.php on line 1116
Return

array

Access

private

_stop

top

Stop execution of the current script. Wraps exit() making testing easier.

Parameters:
  • $status optional 0

Method defined in:
cake/libs/object.php on line 135
Return

void

Access

public

toString

top

Object-to-string conversion. Each class can override this method as necessary.

Method defined in:
cake/libs/object.php on line 64
Return

string The name of this class

Access

public