basics.php File Reference


Namespaces
namespace	cake
Enumerations
enum	DAY
enum	HOUR
enum	MINUTE
enum	MONTH
enum	SECOND
enum	WEEK
enum	YEAR
Functions
	a ()
	aa ()
	am ()
	cache ($path, $data=null, $expires= '+1 day', $target= 'cache')
	clearCache ($params=null, $type= 'views', $ext= '.php')
	config ()
	convertSlash ($string)
	debug ($var=false, $showHtml=false, $showFrom=true)
	e ($text)
	env ($key)
	fileExistsInPath ($file)
	ife ($condition, $val1=null, $val2=null)
	listClasses ($path)
	loadBehavior ($name)
	loadComponent ($name)
	loadController ($name)
	loadControllers ()
	loadHelper ($name)
	loadModel ($name=null)
	loadModels ()
	loadPluginComponent ($plugin, $component)
	loadPluginHelper ($plugin, $helper)
	loadPluginModels ($plugin)
	loadView ($name)
	low ($str)
	params ($p)
	paths ()
	pr ($var)
	r ($search, $replace, $subject)
	setUri ()
	setUrl ()
	stripslashes_deep ($value)
	up ($str)
	uses ()
	vendor ()
Variables
	$a2 = array_values($a2)
	$bad = array("\n", "\r", "\t")
	$c1 = count($a1)
	$c2 = count($a2)
	$good = ' '
	$out = array()
	$res = @fopen($fileName, 'w+b')
return	$write
return	false

Enumeration Type Documentation

enum DAY

Definition at line 35 of file basics.php.

enum HOUR

Definition at line 34 of file basics.php.

enum MINUTE

Definition at line 33 of file basics.php.

enum MONTH

Definition at line 37 of file basics.php.

enum SECOND

Basic defines for timing functions.

Definition at line 32 of file basics.php.

enum WEEK

Definition at line 36 of file basics.php.

enum YEAR

Definition at line 38 of file basics.php.

Function Documentation

a ( )

Returns an array of all the given parameters.

Example: a('a', 'b')

Would return: array('a', 'b')

Returns:: array Array of given parameters

Definition at line 225 of file basics.php.

Referenced by BakeShell::all(), XmlNode::append(), ControllerTask::bakeActions(), ProjectTask::cakeAdmin(), Debugger::checkSessionKey(), String::cleanInsert(), ContainableBehavior::containments(), Folder::create(), AclShell::create(), Validation::custom(), ModelTask::doAssociations(), Validation::email(), Set::extract(), ModelTask::fixture(), TextHelper::flay(), Model::getColumnTypes(), ClassRegistry::init(), AuthComponent::isAuthorized(), ConsoleShell::main(), BakeShell::main(), ApiShell::main(), I18nShell::main(), Xml::parse(), Router::parse(), ShellDispatcher::parseParams(), SchemaShell::run(), TreeBehavior::setparent(), I18nShell::startup(), TextHelper::stripLinks(), TextHelper::truncate(), Validation::url(), TreeBehavior::verify(), SessionHelper::write(), and Router::writeRoute().

aa ( )

Constructs associative array from pairs of arguments.

Example: aa('a','b')

Would return: array('a'=>'b')

Returns:: array Associative array

Definition at line 244 of file basics.php.

am ( )

Merge a group of arrays

Parameters:

	array	First array
	array	Second array
	array	Third array
	array	Etc...

Returns:: array All array parameters merged into one

Definition at line 334 of file basics.php.

Referenced by Model::_deleteDependent(), Model::_findThreaded(), String::cleanInsert(), ContainableBehavior::contain(), FormHelper::dateTime(), Model::deconstruct(), Set::extract(), loadControllers(), loadModels(), JavascriptHelper::object(), and Object::requestAction().

cache	(	$	path,
		$	data = `null`,
		$	expires = `'+1 day'`,
		$	target = `'cache'`
	)

Reads/writes temporary data to cache files or session.

Parameters:

	string	$path File path within /tmp to save the file.
	mixed	$data The data to save to the temporary file.
	mixed	$expires A valid strtotime string when the data expires.
	string	$target The target of the cached data; either 'cache' or 'public'.

Returns:: mixed The contents of the temporary file.

Deprecated:: Please use Cache::write() instead

Definition at line 450 of file basics.php.

References $filename, low(), and Configure::read().

Referenced by View::_render(), Object::_savePersistent(), View::element(), ApiShell::initialize(), View::render(), and JavascriptHelper::writeEvents().

clearCache	(	$	params = `null`,
		$	type = `'views'`,
		$	ext = `'.php'`
	)

Used to delete files in the cache directories, or clear contents of cache directories

Parameters:

	mixed	$params As String name to be searched for deletion, if name is a directory all files in directory will be deleted. If array, names to be searched for deletion. If clearCache() without params, all files in app/tmp/cache/views will be deleted
	string	$type Directory in tmp/cache defaults to view directory
	string	$ext The file extension you are deleting

Returns:: true if files found and deleted false otherwise

Definition at line 502 of file basics.php.

References $file.

Referenced by Model::_clearCache().

config ( )

Loads configuration files. Receives a set of configuration files to load. Example: config('config1', 'config2');

Returns:: boolean Success

Definition at line 61 of file basics.php.

Referenced by Shell::_loadDbConfig(), CakeSocket::address(), CakeSocket::addresses(), IniAcl::check(), Debugger::checkSessionKey(), HttpSocket::configUri(), CakeSocket::connect(), DboSybase::connect(), DboSqlite::connect(), DboPostgres::connect(), DboOracle::connect(), DboOdbc::connect(), DboMysqli::connect(), DboMysql::connect(), DboMssql::connect(), DboFirebird::connect(), DboDb2::connect(), DboAdodb::connect(), ConnectionManager::enumConnectionObjects(), ProjectTask::execute(), DboSource::fullTableName(), Shell::getAdmin(), ConnectionManager::getDataSource(), CakeSocket::host(), DbConfigTask::initialize(), ModelTask::listAll(), ControllerTask::listAll(), DboSqlite::listSources(), DboPostgres::listSources(), DboMysqli::listSources(), DboMysql::listSources(), DataSource::listSources(), Configure::load(), ConsoleShell::main(), BakeShell::main(), CakeSchema::read(), DboSource::reconnect(), HttpSocket::request(), ProjectTask::securitySalt(), DataSource::setConfig(), Model::setDataSource(), AclShell::startup(), I18nShell::startup(), HttpSocket::url(), and Configure::version().

convertSlash ( $ string )

Convert forward slashes to underscores and removes first and last underscores in a string

Parameters:

string

String to convert

Returns:: string with underscore remove from start and end of string

Definition at line 855 of file basics.php.

debug	(	$	var = `false`,
		$	showHtml = `false`,
		$	showFrom = `true`
	)

Prints out debug information about given variable.

Only runs if debug level is non-zero.

Parameters:

	boolean	$var Variable to show debug information for.
	boolean	$showHtml If set to true, the method prints the debug data in a screen-friendly way.
	boolean	$showFrom If set to true, the method prints from where the function was called.

Definition at line 105 of file basics.php.

References r(), and Configure::read().

Referenced by Xml::error(), ExtractTask::execute(), ExtractTask::help(), Configure::read(), and CakeLog::write().

e ( $ text )

Convenience method for echo().

Parameters:

string

$text String to echo

Definition at line 261 of file basics.php.

Referenced by AjaxHelper::afterRender(), ConsoleShell::main(), DboSource::queryAssociation(), DboOracle::queryAssociation(), and DboSource::showQuery().

env ( $ key )

Gets an environment variable from available sources, and provides emulation for unsupported or inconsisten environment variables (i.e. DOCUMENT_ROOT on IIS, or SCRIPT_NAME in CGI mode). Also exposes some additional custom environment information.

Parameters:

string

$key Environment variable name.

Returns:: string Environment variable setting.

Definition at line 353 of file basics.php.

References r().

Referenced by AjaxHelper::afterRender(), Dispatcher::baseUrl(), Dispatcher::cached(), DboMssql::connect(), AjaxHelper::div(), AjaxHelper::divEnd(), SecurityComponent::loginCredentials(), Router::matchRoute(), Dispatcher::parseParams(), Controller::referer(), MediaView::render(), AuthComponent::startup(), Dispatcher::uri(), String::uuid(), and Helper::webroot().

fileExistsInPath ( $ file )

Searches include path for files

Parameters:

string

$file File to look for

Returns:: Full path to file if exists, otherwise false

Definition at line 836 of file basics.php.

References $file.

Referenced by ConnectionManager::loadDataSource().

ife	(	$	condition,
		$	val1 = `null`,
		$	val2 = `null`
	)

Wraps ternary operations. If $condition is a non-empty value, $val1 is returned, otherwise $val2. Don't use for isset() conditions, or wrap your variable with @ operator: Example: ife(isset($variable), $variable, 'default');

Parameters:

	mixed	$condition Conditional expression
	mixed	$val1 Value to return in case condition matches
	mixed	$val2 Value to return if condition doesn't match

Returns:: mixed $val1 or $val2, depending on whether $condition evaluates to a non-empty expression.

Definition at line 913 of file basics.php.

Referenced by TranslateBehavior::afterFind(), TranslateBehavior::beforeFind(), TranslateBehavior::beforeValidate(), JavascriptHelper::blockEnd(), PaginatorHelper::counter(), FormHelper::create(), View::entity(), TextHelper::excerpt(), Debugger::exportVar(), Model::find(), AclShell::getPath(), DboOracle::index(), DboMysql::index(), Model::invalidFields(), Router::mapResources(), AclShell::nodeExists(), Folder::realpath(), Controller::redirect(), ContainableBehavior::setup(), AjaxHelper::sortable(), Multibyte::strripos(), Multibyte::strrpos(), Multibyte::utf8(), JavascriptHelper::value(), AclShell::view(), and Cache::write().

listClasses ( $ path )

	array	$var Variable to print out
	boolean	$showFrom If set to true, the method prints from where the function was called

	string	$search String to be replaced
	string	$replace String to insert
	string	$subject String to search

loadPluginComponent	(	$	plugin,
		$	component
	)

loadPluginHelper	(	$	plugin,
		$	helper
	)

The API

basics.php File Reference

Namespaces

Enumerations

Functions

Variables

Enumeration Type Documentation

Function Documentation

Variable Documentation