code
stringlengths
31
1.39M
docstring
stringlengths
23
16.8k
func_name
stringlengths
1
126
language
stringclasses
1 value
repo
stringlengths
7
63
path
stringlengths
7
166
url
stringlengths
50
220
license
stringclasses
7 values
function __setLanguage($language = null) { $langKey = null; if ($language !== null && isset($this->__l10nMap[$language]) && isset($this->__l10nCatalog[$this->__l10nMap[$language]])) { $langKey = $this->__l10nMap[$language]; } else if ($language !== null && isset($this->__l10nCatalog[$language])) { $langKey = $language; } else if (defined('DEFAULT_LANGUAGE')) { $langKey = $language = DEFAULT_LANGUAGE; } if ($langKey !== null && isset($this->__l10nCatalog[$langKey])) { $this->language = $this->__l10nCatalog[$langKey]['language']; $this->languagePath = array( $this->__l10nCatalog[$langKey]['locale'], $this->__l10nCatalog[$langKey]['localeFallback'] ); $this->lang = $language; $this->locale = $this->__l10nCatalog[$langKey]['locale']; $this->charset = $this->__l10nCatalog[$langKey]['charset']; $this->direction = $this->__l10nCatalog[$langKey]['direction']; } else { $this->lang = $language; $this->languagePath = array($language); } if ($this->default) { if (isset($this->__l10nMap[$this->default]) && isset($this->__l10nCatalog[$this->__l10nMap[$this->default]])) { $this->languagePath[] = $this->__l10nCatalog[$this->__l10nMap[$this->default]]['localeFallback']; } else if (isset($this->__l10nCatalog[$this->default])) { $this->languagePath[] = $this->__l10nCatalog[$this->default]['localeFallback']; } } $this->found = true; if (Configure::read('Config.language') === null) { Configure::write('Config.language', $this->lang); } if ($language) { return $language; } }
Sets the class vars to correct values for $language. If $language is null it will use the DEFAULT_LANGUAGE if defined @param string $language Language (if null will use DEFAULT_LANGUAGE if defined) @access private
__setLanguage
php
Datawalke/Coordino
cake/libs/l10n.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/l10n.php
MIT
function __autoLanguage() { $_detectableLanguages = preg_split('/[,;]/', env('HTTP_ACCEPT_LANGUAGE')); foreach ($_detectableLanguages as $key => $langKey) { $langKey = strtolower($langKey); if (strpos($langKey, '_') !== false) { $langKey = str_replace('_', '-', $langKey); } if (isset($this->__l10nCatalog[$langKey])) { $this->__setLanguage($langKey); return true; } else if (strpos($langKey, '-') !== false) { $langKey = substr($langKey, 0, 2); if (isset($this->__l10nCatalog[$langKey])) { $this->__setLanguage($langKey); return true; } } } return false; }
Attempts to find the locale settings based on the HTTP_ACCEPT_LANGUAGE variable @return boolean Success @access private
__autoLanguage
php
Datawalke/Coordino
cake/libs/l10n.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/l10n.php
MIT
function map($mixed = null) { if (is_array($mixed)) { $result = array(); foreach ($mixed as $_mixed) { if ($_result = $this->map($_mixed)) { $result[$_mixed] = $_result; } } return $result; } else if (is_string($mixed)) { if (strlen($mixed) === 2 && in_array($mixed, $this->__l10nMap)) { return array_search($mixed, $this->__l10nMap); } else if (isset($this->__l10nMap[$mixed])) { return $this->__l10nMap[$mixed]; } return false; } return $this->__l10nMap; }
Attempts to find locale for language, or language for locale @param mixed $mixed 2/3 char string (language/locale), array of those strings, or null @return mixed string language/locale, array of those values, whole map as an array, or false when language/locale doesn't exist @access public
map
php
Datawalke/Coordino
cake/libs/l10n.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/l10n.php
MIT
function catalog($language = null) { if (is_array($language)) { $result = array(); foreach ($language as $_language) { if ($_result = $this->catalog($_language)) { $result[$_language] = $_result; } } return $result; } else if (is_string($language)) { if (isset($this->__l10nCatalog[$language])) { return $this->__l10nCatalog[$language]; } else if (isset($this->__l10nMap[$language]) && isset($this->__l10nCatalog[$this->__l10nMap[$language]])) { return $this->__l10nCatalog[$this->__l10nMap[$language]]; } return false; } return $this->__l10nCatalog; }
Attempts to find catalog record for requested language @param mixed $language string requested language, array of requested languages, or null for whole catalog @return mixed array catalog record for requested language, array of catalog records, whole catalog, or false when language doesn't exist @access public
catalog
php
Datawalke/Coordino
cake/libs/l10n.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/l10n.php
MIT
function read($magicDb = null) { if (!is_string($magicDb) && !is_array($magicDb)) { return false; } if (is_array($magicDb) || strpos($magicDb, '# FILE_ID DB') === 0) { $data = $magicDb; } else { $File =& new File($magicDb); if (!$File->exists()) { return false; } if ($File->ext() == 'php') { include($File->pwd()); $data = $magicDb; } else { // @TODO: Needs test coverage $data = $File->read(); } } $magicDb = $this->toArray($data); if (!$this->validates($magicDb)) { return false; } return !!($this->db = $magicDb); }
Reads a MagicDb from various formats @var $magicDb mixed Can be an array containing the db, a magic db as a string, or a filename pointing to a magic db in .db or magic.db.php format @return boolean Returns false if reading / validation failed or true on success. @author Felix
read
php
Datawalke/Coordino
cake/libs/magic_db.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/magic_db.php
MIT
function toArray($data = null) { if (is_array($data)) { return $data; } if ($data === null) { return $this->db; } if (strpos($data, '# FILE_ID DB') !== 0) { return array(); } $lines = explode("\r\n", $data); $db = array(); $validHeader = count($lines) > 3 && preg_match('/^# Date:([0-9]{4}-[0-9]{2}-[0-9]{2})$/', $lines[1], $date) && preg_match('/^# Source:(.+)$/', $lines[2], $source) && strlen($lines[3]) == 0; if (!$validHeader) { return $db; } $db = array('header' => array('Date' => $date[1], 'Source' => $source[1]), 'database' => array()); $lines = array_splice($lines, 3); $format = array(); while (!empty($lines)) { $line = array_shift($lines); if (isset($line[0]) && $line[0] == '#' || empty($line)) { continue; } $columns = explode("\t", $line); if (in_array($columns[0]{0}, array('>', '&'))) { $format[] = $columns; } elseif (!empty($format)) { $db['database'][] = $format; $format = array($columns); } else { $format = array($columns); } } return $db; }
Parses a MagicDb $data string into an array or returns the current MagicDb instance as an array @param string $data A MagicDb string to turn into an array @return array A parsed MagicDb array or an empty array if the $data param was invalid. Returns the db property if $data is not set. @access public
toArray
php
Datawalke/Coordino
cake/libs/magic_db.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/magic_db.php
MIT
function validates($magicDb = null) { if (is_null($magicDb)) { $magicDb = $this->db; } elseif (!is_array($magicDb)) { $magicDb = $this->toArray($magicDb); } return isset($magicDb['header'], $magicDb['database']) && is_array($magicDb['header']) && is_array($magicDb['database']); }
Returns true if the MagicDb instance or the passed $magicDb is valid @param mixed $magicDb A $magicDb string / array to validate (optional) @return boolean True if the $magicDb / instance db validates, false if not @access public
validates
php
Datawalke/Coordino
cake/libs/magic_db.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/magic_db.php
MIT
function analyze($file, $options = array()) { if (!is_string($file)) { return false; } $matches = array(); $MagicFileResource =& new MagicFileResource($file); foreach ($this->db['database'] as $format) { $magic = $format[0]; $match = $MagicFileResource->test($magic); if ($match === false) { continue; } $matches[] = $magic; } return $matches; }
Analyzes a given $file using the currently loaded MagicDb information based on the desired $options @param string $file Absolute path to the file to analyze @param array $options TBT @return mixed @access public
analyze
php
Datawalke/Coordino
cake/libs/magic_db.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/magic_db.php
MIT
function __construct($file) { if (file_exists($file)) { $this->resource =& new File($file); } else { $this->resource = $file; } }
undocumented function @param unknown $file @return void @access public
__construct
php
Datawalke/Coordino
cake/libs/magic_db.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/magic_db.php
MIT
function test($magic) { $offset = null; $type = null; $expected = null; $comment = null; if (isset($magic[0])) { $offset = $magic[0]; } if (isset($magic[1])) { $type = $magic[1]; } if (isset($magic[2])) { $expected = $magic[2]; } if (isset($magic[3])) { $comment = $magic[3]; } $val = $this->extract($offset, $type, $expected); return $val == $expected; }
undocumented function @param unknown $magic @return void @access public
test
php
Datawalke/Coordino
cake/libs/magic_db.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/magic_db.php
MIT
function read($length = null) { if (!is_object($this->resource)) { return substr($this->resource, $this->offset, $length); } return $this->resource->read($length); }
undocumented function @param unknown $type @param unknown $length @return void @access public
read
php
Datawalke/Coordino
cake/libs/magic_db.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/magic_db.php
MIT
function extract($offset, $type, $expected) { switch ($type) { case 'string': $this->offset($offset); $val = $this->read(strlen($expected)); if ($val === $expected) { return true; } break; } }
undocumented function @param unknown $type @param unknown $expected @return void @access public
extract
php
Datawalke/Coordino
cake/libs/magic_db.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/magic_db.php
MIT
function offset($offset = null) { if (is_null($offset)) { if (!is_object($this->resource)) { return $this->offset; } return $this->offset; } if (!ctype_digit($offset)) { return false; } if (is_object($this->resource)) { $this->resource->offset($offset); } else { $this->offset = $offset; } }
undocumented function @param unknown $offset @param unknown $whence @return void @access public
offset
php
Datawalke/Coordino
cake/libs/magic_db.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/magic_db.php
MIT
function &getInstance() { static $instance = array(); if (!$instance) { $instance[0] =& new Multibyte(); } return $instance[0]; }
Gets a reference to the Multibyte object instance @return object Multibyte instance @access public @static
getInstance
php
Datawalke/Coordino
cake/libs/multibyte.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/multibyte.php
MIT
function utf8($string) { $map = array(); $values = array(); $find = 1; $length = strlen($string); for ($i = 0; $i < $length; $i++) { $value = ord($string[$i]); if ($value < 128) { $map[] = $value; } else { if (empty($values)) { $find = ($value < 224) ? 2 : 3; } $values[] = $value; if (count($values) === $find) { if ($find == 3) { $map[] = (($values[0] % 16) * 4096) + (($values[1] % 64) * 64) + ($values[2] % 64); } else { $map[] = (($values[0] % 32) * 64) + ($values[1] % 64); } $values = array(); $find = 1; } } } return $map; }
Converts a multibyte character string to the decimal value of the character @param multibyte string $string @return array @access public @static
utf8
php
Datawalke/Coordino
cake/libs/multibyte.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/multibyte.php
MIT
function ascii($array) { $ascii = ''; foreach ($array as $utf8) { if ($utf8 < 128) { $ascii .= chr($utf8); } elseif ($utf8 < 2048) { $ascii .= chr(192 + (($utf8 - ($utf8 % 64)) / 64)); $ascii .= chr(128 + ($utf8 % 64)); } else { $ascii .= chr(224 + (($utf8 - ($utf8 % 4096)) / 4096)); $ascii .= chr(128 + ((($utf8 % 4096) - ($utf8 % 64)) / 64)); $ascii .= chr(128 + ($utf8 % 64)); } } return $ascii; }
Converts the decimal value of a multibyte character string to a string @param array $array @return string @access public @static
ascii
php
Datawalke/Coordino
cake/libs/multibyte.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/multibyte.php
MIT
function stripos($haystack, $needle, $offset = 0) { if (!PHP5 || Multibyte::checkMultibyte($haystack)) { $haystack = Multibyte::strtoupper($haystack); $needle = Multibyte::strtoupper($needle); return Multibyte::strpos($haystack, $needle, $offset); } return stripos($haystack, $needle, $offset); }
Find position of first occurrence of a case-insensitive string. @param multi-byte string $haystack The string from which to get the position of the first occurrence of $needle. @param multi-byte string $needle The string to find in $haystack. @param integer $offset The position in $haystack to start searching. @return integer|boolean The numeric position of the first occurrence of $needle in the $haystack string, or false if $needle is not found. @access public @static
stripos
php
Datawalke/Coordino
cake/libs/multibyte.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/multibyte.php
MIT
function stristr($haystack, $needle, $part = false) { $php = (PHP_VERSION < 5.3); if (($php && $part) || Multibyte::checkMultibyte($haystack)) { $check = Multibyte::strtoupper($haystack); $check = Multibyte::utf8($check); $found = false; $haystack = Multibyte::utf8($haystack); $haystackCount = count($haystack); $needle = Multibyte::strtoupper($needle); $needle = Multibyte::utf8($needle); $needleCount = count($needle); $parts = array(); $position = 0; while (($found === false) && ($position < $haystackCount)) { if (isset($needle[0]) && $needle[0] === $check[$position]) { for ($i = 1; $i < $needleCount; $i++) { if ($needle[$i] !== $check[$position + $i]) { break; } } if ($i === $needleCount) { $found = true; } } if (!$found) { $parts[] = $haystack[$position]; unset($haystack[$position]); } $position++; } if ($found && $part && !empty($parts)) { return Multibyte::ascii($parts); } elseif ($found && !empty($haystack)) { return Multibyte::ascii($haystack); } return false; } if (!$php) { return stristr($haystack, $needle, $part); } return stristr($haystack, $needle); }
Finds first occurrence of a string within another, case insensitive. @param string $haystack The string from which to get the first occurrence of $needle. @param string $needle The string to find in $haystack. @param boolean $part Determines which portion of $haystack this function returns. If set to true, it returns all of $haystack from the beginning to the first occurrence of $needle. If set to false, it returns all of $haystack from the first occurrence of $needle to the end, Default value is false. @return int|boolean The portion of $haystack, or false if $needle is not found. @access public @static
stristr
php
Datawalke/Coordino
cake/libs/multibyte.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/multibyte.php
MIT
function strlen($string) { if (Multibyte::checkMultibyte($string)) { $string = Multibyte::utf8($string); return count($string); } return strlen($string); }
Get string length. @param string $string The string being checked for length. @return integer The number of characters in string $string @access public @static
strlen
php
Datawalke/Coordino
cake/libs/multibyte.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/multibyte.php
MIT
function strpos($haystack, $needle, $offset = 0) { if (Multibyte::checkMultibyte($haystack)) { $found = false; $haystack = Multibyte::utf8($haystack); $haystackCount = count($haystack); $needle = Multibyte::utf8($needle); $needleCount = count($needle); $position = $offset; while (($found === false) && ($position < $haystackCount)) { if (isset($needle[0]) && $needle[0] === $haystack[$position]) { for ($i = 1; $i < $needleCount; $i++) { if ($needle[$i] !== $haystack[$position + $i]) { break; } } if ($i === $needleCount) { $found = true; $position--; } } $position++; } if ($found) { return $position; } return false; } return strpos($haystack, $needle, $offset); }
Find position of first occurrence of a string. @param string $haystack The string being checked. @param string $needle The position counted from the beginning of haystack. @param integer $offset The search offset. If it is not specified, 0 is used. @return integer|boolean The numeric position of the first occurrence of $needle in the $haystack string. If $needle is not found, it returns false. @access public @static
strpos
php
Datawalke/Coordino
cake/libs/multibyte.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/multibyte.php
MIT
function strrchr($haystack, $needle, $part = false) { $check = Multibyte::utf8($haystack); $found = false; $haystack = Multibyte::utf8($haystack); $haystackCount = count($haystack); $matches = array_count_values($check); $needle = Multibyte::utf8($needle); $needleCount = count($needle); $parts = array(); $position = 0; while (($found === false) && ($position < $haystackCount)) { if (isset($needle[0]) && $needle[0] === $check[$position]) { for ($i = 1; $i < $needleCount; $i++) { if ($needle[$i] !== $check[$position + $i]) { if ($needle[$i] === $check[($position + $i) -1]) { $found = true; } unset($parts[$position - 1]); $haystack = array_merge(array($haystack[$position]), $haystack); break; } } if (isset($matches[$needle[0]]) && $matches[$needle[0]] > 1) { $matches[$needle[0]] = $matches[$needle[0]] - 1; } elseif ($i === $needleCount) { $found = true; } } if (!$found && isset($haystack[$position])) { $parts[] = $haystack[$position]; unset($haystack[$position]); } $position++; } if ($found && $part && !empty($parts)) { return Multibyte::ascii($parts); } elseif ($found && !empty($haystack)) { return Multibyte::ascii($haystack); } return false; }
Finds the last occurrence of a character in a string within another. @param string $haystack The string from which to get the last occurrence of $needle. @param string $needle The string to find in $haystack. @param boolean $part Determines which portion of $haystack this function returns. If set to true, it returns all of $haystack from the beginning to the last occurrence of $needle. If set to false, it returns all of $haystack from the last occurrence of $needle to the end, Default value is false. @return string|boolean The portion of $haystack. or false if $needle is not found. @access public @static
strrchr
php
Datawalke/Coordino
cake/libs/multibyte.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/multibyte.php
MIT
function strrichr($haystack, $needle, $part = false) { $check = Multibyte::strtoupper($haystack); $check = Multibyte::utf8($check); $found = false; $haystack = Multibyte::utf8($haystack); $haystackCount = count($haystack); $matches = array_count_values($check); $needle = Multibyte::strtoupper($needle); $needle = Multibyte::utf8($needle); $needleCount = count($needle); $parts = array(); $position = 0; while (($found === false) && ($position < $haystackCount)) { if (isset($needle[0]) && $needle[0] === $check[$position]) { for ($i = 1; $i < $needleCount; $i++) { if ($needle[$i] !== $check[$position + $i]) { if ($needle[$i] === $check[($position + $i) -1]) { $found = true; } unset($parts[$position - 1]); $haystack = array_merge(array($haystack[$position]), $haystack); break; } } if (isset($matches[$needle[0]]) && $matches[$needle[0]] > 1) { $matches[$needle[0]] = $matches[$needle[0]] - 1; } elseif ($i === $needleCount) { $found = true; } } if (!$found && isset($haystack[$position])) { $parts[] = $haystack[$position]; unset($haystack[$position]); } $position++; } if ($found && $part && !empty($parts)) { return Multibyte::ascii($parts); } elseif ($found && !empty($haystack)) { return Multibyte::ascii($haystack); } return false; }
Finds the last occurrence of a character in a string within another, case insensitive. @param string $haystack The string from which to get the last occurrence of $needle. @param string $needle The string to find in $haystack. @param boolean $part Determines which portion of $haystack this function returns. If set to true, it returns all of $haystack from the beginning to the last occurrence of $needle. If set to false, it returns all of $haystack from the last occurrence of $needle to the end, Default value is false. @return string|boolean The portion of $haystack. or false if $needle is not found. @access public @static
strrichr
php
Datawalke/Coordino
cake/libs/multibyte.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/multibyte.php
MIT
function strripos($haystack, $needle, $offset = 0) { if (!PHP5 || Multibyte::checkMultibyte($haystack)) { $found = false; $haystack = Multibyte::strtoupper($haystack); $haystack = Multibyte::utf8($haystack); $haystackCount = count($haystack); $matches = array_count_values($haystack); $needle = Multibyte::strtoupper($needle); $needle = Multibyte::utf8($needle); $needleCount = count($needle); $position = $offset; while (($found === false) && ($position < $haystackCount)) { if (isset($needle[0]) && $needle[0] === $haystack[$position]) { for ($i = 1; $i < $needleCount; $i++) { if ($needle[$i] !== $haystack[$position + $i]) { if ($needle[$i] === $haystack[($position + $i) -1]) { $position--; $found = true; continue; } } } if (!$offset && isset($matches[$needle[0]]) && $matches[$needle[0]] > 1) { $matches[$needle[0]] = $matches[$needle[0]] - 1; } elseif ($i === $needleCount) { $found = true; $position--; } } $position++; } return ($found) ? $position : false; } return strripos($haystack, $needle, $offset); }
Finds position of last occurrence of a string within another, case insensitive @param string $haystack The string from which to get the position of the last occurrence of $needle. @param string $needle The string to find in $haystack. @param integer $offset The position in $haystack to start searching. @return integer|boolean The numeric position of the last occurrence of $needle in the $haystack string, or false if $needle is not found. @access public @static
strripos
php
Datawalke/Coordino
cake/libs/multibyte.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/multibyte.php
MIT
function strrpos($haystack, $needle, $offset = 0) { if (!PHP5 || Multibyte::checkMultibyte($haystack)) { $found = false; $haystack = Multibyte::utf8($haystack); $haystackCount = count($haystack); $matches = array_count_values($haystack); $needle = Multibyte::utf8($needle); $needleCount = count($needle); $position = $offset; while (($found === false) && ($position < $haystackCount)) { if (isset($needle[0]) && $needle[0] === $haystack[$position]) { for ($i = 1; $i < $needleCount; $i++) { if ($needle[$i] !== $haystack[$position + $i]) { if ($needle[$i] === $haystack[($position + $i) -1]) { $position--; $found = true; continue; } } } if (!$offset && isset($matches[$needle[0]]) && $matches[$needle[0]] > 1) { $matches[$needle[0]] = $matches[$needle[0]] - 1; } elseif ($i === $needleCount) { $found = true; $position--; } } $position++; } return ($found) ? $position : false; } return strrpos($haystack, $needle, $offset); }
Find position of last occurrence of a string in a string. @param string $haystack The string being checked, for the last occurrence of $needle. @param string $needle The string to find in $haystack. @param integer $offset May be specified to begin searching an arbitrary number of characters into the string. Negative values will stop searching at an arbitrary point prior to the end of the string. @return integer|boolean The numeric position of the last occurrence of $needle in the $haystack string. If $needle is not found, it returns false. @access public @static
strrpos
php
Datawalke/Coordino
cake/libs/multibyte.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/multibyte.php
MIT
function strstr($haystack, $needle, $part = false) { $php = (PHP_VERSION < 5.3); if (($php && $part) || Multibyte::checkMultibyte($haystack)) { $check = Multibyte::utf8($haystack); $found = false; $haystack = Multibyte::utf8($haystack); $haystackCount = count($haystack); $needle = Multibyte::utf8($needle); $needleCount = count($needle); $parts = array(); $position = 0; while (($found === false) && ($position < $haystackCount)) { if (isset($needle[0]) && $needle[0] === $check[$position]) { for ($i = 1; $i < $needleCount; $i++) { if ($needle[$i] !== $check[$position + $i]) { break; } } if ($i === $needleCount) { $found = true; } } if (!$found) { $parts[] = $haystack[$position]; unset($haystack[$position]); } $position++; } if ($found && $part && !empty($parts)) { return Multibyte::ascii($parts); } elseif ($found && !empty($haystack)) { return Multibyte::ascii($haystack); } return false; } if (!$php) { return strstr($haystack, $needle, $part); } return strstr($haystack, $needle); }
Finds first occurrence of a string within another @param string $haystack The string from which to get the first occurrence of $needle. @param string $needle The string to find in $haystack @param boolean $part Determines which portion of $haystack this function returns. If set to true, it returns all of $haystack from the beginning to the first occurrence of $needle. If set to false, it returns all of $haystack from the first occurrence of $needle to the end, Default value is FALSE. @return string|boolean The portion of $haystack, or true if $needle is not found. @access public @static
strstr
php
Datawalke/Coordino
cake/libs/multibyte.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/multibyte.php
MIT
function strtolower($string) { $_this =& Multibyte::getInstance(); $utf8Map = Multibyte::utf8($string); $length = count($utf8Map); $lowerCase = array(); $matched = false; for ($i = 0 ; $i < $length; $i++) { $char = $utf8Map[$i]; if ($char < 128) { $str = strtolower(chr($char)); $strlen = strlen($str); for ($ii = 0 ; $ii < $strlen; $ii++) { $lower = ord(substr($str, $ii, 1)); } $lowerCase[] = $lower; $matched = true; } else { $matched = false; $keys = $_this->__find($char, 'upper'); if (!empty($keys)) { foreach ($keys as $key => $value) { if ($keys[$key]['upper'] == $char && count($keys[$key]['lower'][0]) === 1) { $lowerCase[] = $keys[$key]['lower'][0]; $matched = true; break 1; } } } } if ($matched === false) { $lowerCase[] = $char; } } return Multibyte::ascii($lowerCase); }
Make a string lowercase @param string $string The string being lowercased. @return string with all alphabetic characters converted to lowercase. @access public @static
strtolower
php
Datawalke/Coordino
cake/libs/multibyte.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/multibyte.php
MIT
function substrCount($haystack, $needle) { $count = 0; $haystack = Multibyte::utf8($haystack); $haystackCount = count($haystack); $matches = array_count_values($haystack); $needle = Multibyte::utf8($needle); $needleCount = count($needle); if ($needleCount === 1 && isset($matches[$needle[0]])) { return $matches[$needle[0]]; } for ($i = 0; $i < $haystackCount; $i++) { if (isset($needle[0]) && $needle[0] === $haystack[$i]) { for ($ii = 1; $ii < $needleCount; $ii++) { if ($needle[$ii] === $haystack[$i + 1]) { if ((isset($needle[$ii + 1]) && $haystack[$i + 2]) && $needle[$ii + 1] !== $haystack[$i + 2]) { $count--; } else { $count++; } } } } } return $count; }
Count the number of substring occurrences @param string $haystack The string being checked. @param string $needle The string being found. @return integer The number of times the $needle substring occurs in the $haystack string. @access public @static
substrCount
php
Datawalke/Coordino
cake/libs/multibyte.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/multibyte.php
MIT
function substr($string, $start, $length = null) { if ($start === 0 && $length === null) { return $string; } $string = Multibyte::utf8($string); $stringCount = count($string); for ($i = 1; $i <= $start; $i++) { unset($string[$i - 1]); } if ($length === null || count($string) < $length) { return Multibyte::ascii($string); } $string = array_values($string); $value = array(); for ($i = 0; $i < $length; $i++) { $value[] = $string[$i]; } return Multibyte::ascii($value); }
Get part of string @param string $string The string being checked. @param integer $start The first position used in $string. @param integer $length The maximum length of the returned string. @return string The portion of $string specified by the $string and $length parameters. @access public @static
substr
php
Datawalke/Coordino
cake/libs/multibyte.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/multibyte.php
MIT
function mimeEncode($string, $charset = null, $newline = "\r\n") { if (!Multibyte::checkMultibyte($string) && strlen($string) < 75) { return $string; } if (empty($charset)) { $charset = Configure::read('App.encoding'); } $charset = strtoupper($charset); $start = '=?' . $charset . '?B?'; $end = '?='; $spacer = $end . $newline . ' ' . $start; $length = 75 - strlen($start) - strlen($end); $length = $length - ($length % 4); if ($charset == 'UTF-8') { $parts = array(); $maxchars = floor(($length * 3) / 4); while (strlen($string) > $maxchars) { $i = (int)$maxchars; $test = ord($string[$i]); while ($test >= 128 && $test <= 191) { $i--; $test = ord($string[$i]); } $parts[] = base64_encode(substr($string, 0, $i)); $string = substr($string, $i); } $parts[] = base64_encode($string); $string = implode($spacer, $parts); } else { $string = chunk_split(base64_encode($string), $length, $spacer); $string = preg_replace('/' . preg_quote($spacer) . '$/', '', $string); } return $start . $string . $end; }
Prepare a string for mail transport, using the provided encoding @param string $string value to encode @param string $charset charset to use for encoding. defaults to UTF-8 @param string $newline @return string @access public @static @TODO: add support for 'Q'('Quoted Printable') encoding
mimeEncode
php
Datawalke/Coordino
cake/libs/multibyte.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/multibyte.php
MIT
function __codepoint($decimal) { if ($decimal > 128 && $decimal < 256) { $return = '0080_00ff'; // Latin-1 Supplement } elseif ($decimal < 384) { $return = '0100_017f'; // Latin Extended-A } elseif ($decimal < 592) { $return = '0180_024F'; // Latin Extended-B } elseif ($decimal < 688) { $return = '0250_02af'; // IPA Extensions } elseif ($decimal >= 880 && $decimal < 1024) { $return = '0370_03ff'; // Greek and Coptic } elseif ($decimal < 1280) { $return = '0400_04ff'; // Cyrillic } elseif ($decimal < 1328) { $return = '0500_052f'; // Cyrillic Supplement } elseif ($decimal < 1424) { $return = '0530_058f'; // Armenian } elseif ($decimal >= 7680 && $decimal < 7936) { $return = '1e00_1eff'; // Latin Extended Additional } elseif ($decimal < 8192) { $return = '1f00_1fff'; // Greek Extended } elseif ($decimal >= 8448 && $decimal < 8528) { $return = '2100_214f'; // Letterlike Symbols } elseif ($decimal < 8592) { $return = '2150_218f'; // Number Forms } elseif ($decimal >= 9312 && $decimal < 9472) { $return = '2460_24ff'; // Enclosed Alphanumerics } elseif ($decimal >= 11264 && $decimal < 11360) { $return = '2c00_2c5f'; // Glagolitic } elseif ($decimal < 11392) { $return = '2c60_2c7f'; // Latin Extended-C } elseif ($decimal < 11520) { $return = '2c80_2cff'; // Coptic } elseif ($decimal >= 65280 && $decimal < 65520) { $return = 'ff00_ffef'; // Halfwidth and Fullwidth Forms } else { $return = false; } $this->__codeRange[$decimal] = $return; return $return; }
Return the Code points range for Unicode characters @param interger $decimal @return string @access private
__codepoint
php
Datawalke/Coordino
cake/libs/multibyte.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/multibyte.php
MIT
function __find($char, $type = 'lower') { $value = false; $found = array(); if (!isset($this->__codeRange[$char])) { $range = $this->__codepoint($char); if ($range === false) { return null; } Configure::load('unicode' . DS . 'casefolding' . DS . $range); $this->__caseFold[$range] = Configure::read($range); Configure::delete($range); } if (!$this->__codeRange[$char]) { return null; } $this->__table = $this->__codeRange[$char]; $count = count($this->__caseFold[$this->__table]); for ($i = 0; $i < $count; $i++) { if ($type === 'lower' && $this->__caseFold[$this->__table][$i][$type][0] === $char) { $found[] = $this->__caseFold[$this->__table][$i]; } elseif ($type === 'upper' && $this->__caseFold[$this->__table][$i][$type] === $char) { $found[] = $this->__caseFold[$this->__table][$i]; } } return $found; }
Find the related code folding values for $char @param integer $char decimal value of character @param string $type @return array @access private
__find
php
Datawalke/Coordino
cake/libs/multibyte.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/multibyte.php
MIT
function checkMultibyte($string) { $length = strlen($string); for ($i = 0; $i < $length; $i++ ) { $value = ord(($string[$i])); if ($value > 128) { return true; } } return false; }
Check the $string for multibyte characters @param string $string value to test @return boolean @access public @static
checkMultibyte
php
Datawalke/Coordino
cake/libs/multibyte.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/multibyte.php
MIT
function Object() { $args = func_get_args(); if (method_exists($this, '__destruct')) { register_shutdown_function (array(&$this, '__destruct')); } call_user_func_array(array(&$this, '__construct'), $args); }
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() @return Object
Object
php
Datawalke/Coordino
cake/libs/object.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/object.php
MIT
function toString() { $class = get_class($this); return $class; }
Object-to-string conversion. Each class can override this method as necessary. @return string The name of this class @access public
toString
php
Datawalke/Coordino
cake/libs/object.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/object.php
MIT
function requestAction($url, $extra = array()) { if (empty($url)) { return false; } if (!class_exists('dispatcher')) { require CAKE . 'dispatcher.php'; } if (in_array('return', $extra, true)) { $extra = array_merge($extra, array('return' => 0, 'autoRender' => 1)); } if (is_array($url) && !isset($extra['url'])) { $extra['url'] = array(); } $params = array_merge(array('autoRender' => 0, 'return' => 1, 'bare' => 1, 'requested' => 1), $extra); $dispatcher = new Dispatcher; return $dispatcher->dispatch($url, $params); }
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. @param mixed $url String or array-based url. @param array $extra if array includes the key "return" it sets the AutoRender to true. @return mixed Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra. @access public
requestAction
php
Datawalke/Coordino
cake/libs/object.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/object.php
MIT
function dispatchMethod($method, $params = array()) { switch (count($params)) { case 0: return $this->{$method}(); case 1: return $this->{$method}($params[0]); case 2: return $this->{$method}($params[0], $params[1]); case 3: return $this->{$method}($params[0], $params[1], $params[2]); case 4: return $this->{$method}($params[0], $params[1], $params[2], $params[3]); case 5: return $this->{$method}($params[0], $params[1], $params[2], $params[3], $params[4]); default: return call_user_func_array(array(&$this, $method), $params); break; } }
Calls a method on this object with the given parameters. Provides an OO wrapper for `call_user_func_array` @param string $method Name of the method to call @param array $params Parameter list to use when calling $method @return mixed Returns the result of the method call @access public
dispatchMethod
php
Datawalke/Coordino
cake/libs/object.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/object.php
MIT
function log($msg, $type = LOG_ERROR) { if (!class_exists('CakeLog')) { require LIBS . 'cake_log.php'; } if (!is_string($msg)) { $msg = print_r($msg, true); } return CakeLog::write($type, $msg); }
Convience method to write a message to CakeLog. See CakeLog::write() for more information on writing to logs. @param string $msg Log message @param integer $type Error type constant. Defined in app/config/core.php. @return boolean Success of log write @access public
log
php
Datawalke/Coordino
cake/libs/object.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/object.php
MIT
function _set($properties = array()) { if (is_array($properties) && !empty($properties)) { $vars = get_object_vars($this); foreach ($properties as $key => $val) { if (array_key_exists($key, $vars)) { $this->{$key} = $val; } } } }
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. @param array $properties An associative array containing properties and corresponding values. @return void @access protected
_set
php
Datawalke/Coordino
cake/libs/object.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/object.php
MIT
function cakeError($method, $messages = array()) { if (!class_exists('ErrorHandler')) { App::import('Core', 'Error'); if (file_exists(APP . 'error.php')) { include_once (APP . 'error.php'); } elseif (file_exists(APP . 'app_error.php')) { include_once (APP . 'app_error.php'); } } if (class_exists('AppError')) { $error = new AppError($method, $messages); } else { $error = new ErrorHandler($method, $messages); } return $error; }
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. @param string $method Method to be called in the error class (AppError or ErrorHandler classes) @param array $messages Message that is to be displayed by the error class @return error message @access public
cakeError
php
Datawalke/Coordino
cake/libs/object.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/object.php
MIT
function _persist($name, $return = null, &$object, $type = null) { $file = CACHE . 'persistent' . DS . strtolower($name) . '.php'; if ($return === null) { if (!file_exists($file)) { return false; } else { return true; } } if (!file_exists($file)) { $this->_savePersistent($name, $object); return false; } else { $this->__openPersistent($name, $type); return true; } }
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 @param string $name name of the class to persist @param string $object the object to persist @return boolean Success @access protected @todo add examples to manual
_persist
php
Datawalke/Coordino
cake/libs/object.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/object.php
MIT
function _savePersistent($name, &$object) { $file = 'persistent' . DS . strtolower($name) . '.php'; $objectArray = array(&$object); $data = str_replace('\\', '\\\\', serialize($objectArray)); $data = '<?php $' . $name . ' = \'' . str_replace('\'', '\\\'', $data) . '\' ?>'; $duration = '+999 days'; if (Configure::read() >= 1) { $duration = '+10 seconds'; } cache($file, $data, $duration); }
You should choose a unique name for the persistent file There are many uses for this method, see manual for examples @param string $name name used for object to cache @param object $object the object to persist @return boolean true on save, throws error if file can not be created @access protected
_savePersistent
php
Datawalke/Coordino
cake/libs/object.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/object.php
MIT
function __openPersistent($name, $type = null) { $file = CACHE . 'persistent' . DS . strtolower($name) . '.php'; include($file); switch ($type) { case 'registry': $vars = unserialize(${$name}); foreach ($vars['0'] as $key => $value) { if (strpos($key, '_behavior') !== false) { App::import('Behavior', Inflector::classify(substr($key, 0, -9))); } else { App::import('Model', Inflector::camelize($key)); } unset ($value); } unset($vars); $vars = unserialize(${$name}); foreach ($vars['0'] as $key => $value) { ClassRegistry::addObject($key, $value); unset ($value); } unset($vars); break; default: $vars = unserialize(${$name}); $this->{$name} = $vars['0']; unset($vars); break; } }
Open the persistent class file for reading Used by Object::_persist() @param string $name Name of persisted class @param string $type Type of persistance (e.g: registry) @return void @access private
__openPersistent
php
Datawalke/Coordino
cake/libs/object.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/object.php
MIT
function __call($method, $params, &$return) { if (!method_exists($this, 'call__')) { trigger_error(sprintf(__('Magic method handler call__ not defined in %s', true), get_class($this)), E_USER_ERROR); } $return = $this->call__($method, $params); return true; }
Magic method handler. @param string $method Method name @param array $params Parameters to send to method @param mixed $return Where to store return value from method @return boolean Success @access private
__call
php
Datawalke/Coordino
cake/libs/overloadable_php4.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/overloadable_php4.php
MIT
function __call($method, $params, &$return) { if (!method_exists($this, 'call__')) { trigger_error(sprintf(__('Magic method handler call__ not defined in %s', true), get_class($this)), E_USER_ERROR); } $return = $this->call__($method, $params); return true; }
Magic method handler. @param string $method Method name @param array $params Parameters to send to method @param mixed $return Where to store return value from method @return boolean Success @access private
__call
php
Datawalke/Coordino
cake/libs/overloadable_php4.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/overloadable_php4.php
MIT
function __get($name, &$value) { $value = $this->get__($name); return true; }
Getter. @param mixed $name What to get @param mixed $value Where to store returned value @return boolean Success @access private
__get
php
Datawalke/Coordino
cake/libs/overloadable_php4.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/overloadable_php4.php
MIT
function __set($name, $value) { $this->set__($name, $value); return true; }
Setter. @param mixed $name What to set @param mixed $value Value to set @return boolean Success @access private
__set
php
Datawalke/Coordino
cake/libs/overloadable_php4.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/overloadable_php4.php
MIT
function __call($method, $params) { if (!method_exists($this, 'call__')) { trigger_error(sprintf(__('Magic method handler call__ not defined in %s', true), get_class($this)), E_USER_ERROR); } return $this->call__($method, $params); }
Magic method handler. @param string $method Method name @param array $params Parameters to send to method @return mixed Return value from method @access private
__call
php
Datawalke/Coordino
cake/libs/overloadable_php5.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/overloadable_php5.php
MIT
function __call($method, $params) { if (!method_exists($this, 'call__')) { trigger_error(sprintf(__('Magic method handler call__ not defined in %s', true), get_class($this)), E_USER_ERROR); } return $this->call__($method, $params); }
Magic method handler. @param string $method Method name @param array $params Parameters to send to method @return mixed Return value from method @access private
__call
php
Datawalke/Coordino
cake/libs/overloadable_php5.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/overloadable_php5.php
MIT
function __get($name) { return $this->get__($name); }
Getter. @param mixed $name What to get @param mixed $value Where to store returned value @return boolean Success @access private
__get
php
Datawalke/Coordino
cake/libs/overloadable_php5.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/overloadable_php5.php
MIT
function __set($name, $value) { return $this->set__($name, $value); }
Setter. @param mixed $name What to set @param mixed $value Value to set @return boolean Success @access private
__set
php
Datawalke/Coordino
cake/libs/overloadable_php5.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/overloadable_php5.php
MIT
function __setPrefixes() { $routing = Configure::read('Routing'); if (!empty($routing['admin'])) { $this->__prefixes[] = $routing['admin']; } if (!empty($routing['prefixes'])) { $this->__prefixes = array_merge($this->__prefixes, (array)$routing['prefixes']); } }
Sets the Routing prefixes. Includes compatibility for existing Routing.admin configurations. @return void @access private @todo Remove support for Routing.admin in future versions.
__setPrefixes
php
Datawalke/Coordino
cake/libs/router.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/router.php
MIT
function &getInstance() { static $instance = array(); if (!$instance) { $instance[0] =& new Router(); } return $instance[0]; }
Gets a reference to the Router object instance @return Router Instance of the Router. @access public @static
getInstance
php
Datawalke/Coordino
cake/libs/router.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/router.php
MIT
function getNamedExpressions() { $self =& Router::getInstance(); return $self->__named; }
Gets the named route elements for use in app/config/routes.php @return array Named route elements @access public @see Router::$__named @static
getNamedExpressions
php
Datawalke/Coordino
cake/libs/router.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/router.php
MIT
function connect($route, $defaults = array(), $options = array()) { $self =& Router::getInstance(); foreach ($self->__prefixes as $prefix) { if (isset($defaults[$prefix])) { $defaults['prefix'] = $prefix; break; } } if (isset($defaults['prefix'])) { $self->__prefixes[] = $defaults['prefix']; $self->__prefixes = array_keys(array_flip($self->__prefixes)); } $defaults += array('plugin' => null); if (empty($options['action'])) { $defaults += array('action' => 'index'); } $routeClass = 'CakeRoute'; if (isset($options['routeClass'])) { $routeClass = $options['routeClass']; unset($options['routeClass']); } //TODO 2.0 refactor this to use a string class name, throw exception, and then construct. $Route =& new $routeClass($route, $defaults, $options); if ($routeClass !== 'CakeRoute' && !is_subclass_of($Route, 'CakeRoute')) { trigger_error(__('Route classes must extend CakeRoute', true), E_USER_WARNING); return false; } $self->routes[] =& $Route; return $self->routes; }
Connects a new Route in the router. Routes are a way of connecting request urls to objects in your application. At their core routes are a set or regular expressions that are used to match requests to destinations. Examples: `Router::connect('/:controller/:action/*');` The first parameter will be used as a controller name while the second is used as the action name. the '/*' syntax makes this route greedy in that it will match requests like `/posts/index` as well as requests like `/posts/edit/1/foo/bar`. `Router::connect('/home-page', array('controller' => 'pages', 'action' => 'display', 'home'));` The above shows the use of route parameter defaults. And providing routing parameters for a static route. {{{ Router::connect( '/:lang/:controller/:action/:id', array(), array('id' => '[0-9]+', 'lang' => '[a-z]{3}') ); }}} Shows connecting a route with custom route parameters as well as providing patterns for those parameters. Patterns for routing parameters do not need capturing groups, as one will be added for each route params. $options offers three 'special' keys. `pass`, `persist` and `routeClass` have special meaning in the $options array. `pass` is used to define which of the routed parameters should be shifted into the pass array. Adding a parameter to pass will remove it from the regular route array. Ex. `'pass' => array('slug')` `persist` is used to define which route parameters should be automatically included when generating new urls. You can override persistent parameters by redefining them in a url or remove them by setting the parameter to `false`. Ex. `'persist' => array('lang')` `routeClass` is used to extend and change how individual routes parse requests and handle reverse routing, via a custom routing class. Ex. `'routeClass' => 'SlugRoute'` @param string $route A string describing the template of the route @param array $defaults An array describing the default route parameters. These parameters will be used by default and can supply routing parameters that are not dynamic. See above. @param array $options An array matching the named elements in the route to regular expressions which that element should match. Also contains additional parameters such as which routed parameters should be shifted into the passed arguments, supplying patterns for routing parameters and supplying the name of a custom routing class. @see routes @return array Array of routes @access public @static
connect
php
Datawalke/Coordino
cake/libs/router.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/router.php
MIT
function connectNamed($named, $options = array()) { $self =& Router::getInstance(); if (isset($options['argSeparator'])) { $self->named['separator'] = $options['argSeparator']; unset($options['argSeparator']); } if ($named === true || $named === false) { $options = array_merge(array('default' => $named, 'reset' => true, 'greedy' => $named), $options); $named = array(); } else { $options = array_merge(array('default' => false, 'reset' => false, 'greedy' => true), $options); } if ($options['reset'] == true || $self->named['rules'] === false) { $self->named['rules'] = array(); } if ($options['default']) { $named = array_merge($named, $self->named['default']); } foreach ($named as $key => $val) { if (is_numeric($key)) { $self->named['rules'][$val] = true; } else { $self->named['rules'][$key] = $val; } } $self->named['greedy'] = $options['greedy']; return $self->named; }
Specifies what named parameters CakePHP should be parsing. The most common setups are: Do not parse any named parameters: {{{ Router::connectNamed(false); }}} Parse only default parameters used for CakePHP's pagination: {{{ Router::connectNamed(false, array('default' => true)); }}} Parse only the page parameter if its value is a number: {{{ Router::connectNamed(array('page' => '[\d]+'), array('default' => false, 'greedy' => false)); }}} Parse only the page parameter no mater what. {{{ Router::connectNamed(array('page'), array('default' => false, 'greedy' => false)); }}} Parse only the page parameter if the current action is 'index'. {{{ Router::connectNamed( array('page' => array('action' => 'index')), array('default' => false, 'greedy' => false) ); }}} Parse only the page parameter if the current action is 'index' and the controller is 'pages'. {{{ Router::connectNamed( array('page' => array('action' => 'index', 'controller' => 'pages')), array('default' => false, 'greedy' => false) ); }}} @param array $named A list of named parameters. Key value pairs are accepted where values are either regex strings to match, or arrays as seen above. @param array $options Allows to control all settings: separator, greedy, reset, default @return array @access public @static
connectNamed
php
Datawalke/Coordino
cake/libs/router.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/router.php
MIT
function defaults($connect = true) { $self =& Router::getInstance(); $self->__connectDefaults = $connect; }
Tell router to connect or not connect the default routes. If default routes are disabled all automatic route generation will be disabled and you will need to manually configure all the routes you want. @param boolean $connect Set to true or false depending on whether you want or don't want default routes. @return void @access public @static
defaults
php
Datawalke/Coordino
cake/libs/router.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/router.php
MIT
function mapResources($controller, $options = array()) { $self =& Router::getInstance(); $options = array_merge(array('prefix' => '/', 'id' => $self->__named['ID'] . '|' . $self->__named['UUID']), $options); $prefix = $options['prefix']; foreach ((array)$controller as $ctlName) { $urlName = Inflector::underscore($ctlName); foreach ($self->__resourceMap as $params) { extract($params); $url = $prefix . $urlName . (($id) ? '/:id' : ''); Router::connect($url, array('controller' => $urlName, 'action' => $action, '[method]' => $params['method']), array('id' => $options['id'], 'pass' => array('id')) ); } $self->__resourceMapped[] = $urlName; } }
Creates REST resource routes for the given controller(s) ### Options: - 'id' - The regular expression fragment to use when matching IDs. By default, matches integer values and UUIDs. - 'prefix' - URL prefix to use for the generated routes. Defaults to '/'. @param mixed $controller A controller name or array of controller names (i.e. "Posts" or "ListItems") @param array $options Options to use when generating REST routes @return void @access public @static
mapResources
php
Datawalke/Coordino
cake/libs/router.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/router.php
MIT
function prefixes() { $self =& Router::getInstance(); return $self->__prefixes; }
Returns the list of prefixes used in connected routes @return array A list of prefixes used in connected routes @access public @static
prefixes
php
Datawalke/Coordino
cake/libs/router.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/router.php
MIT
function parse($url) { $self =& Router::getInstance(); if (!$self->__defaultsMapped && $self->__connectDefaults) { $self->__connectDefaultRoutes(); } $out = array( 'pass' => array(), 'named' => array(), ); $r = $ext = null; if (ini_get('magic_quotes_gpc') === '1') { $url = stripslashes_deep($url); } if ($url && strpos($url, '/') !== 0) { $url = '/' . $url; } if (strpos($url, '?') !== false) { $url = substr($url, 0, strpos($url, '?')); } extract($self->__parseExtension($url)); for ($i = 0, $len = count($self->routes); $i < $len; $i++) { $route =& $self->routes[$i]; if (($r = $route->parse($url)) !== false) { $self->__currentRoute[] =& $route; $params = $route->options; $argOptions = array(); if (array_key_exists('named', $params)) { $argOptions['named'] = $params['named']; unset($params['named']); } if (array_key_exists('greedy', $params)) { $argOptions['greedy'] = $params['greedy']; unset($params['greedy']); } $out = $r; if (isset($out['_args_'])) { $argOptions['context'] = array('action' => $out['action'], 'controller' => $out['controller']); $parsedArgs = $self->getArgs($out['_args_'], $argOptions); $out['pass'] = array_merge($out['pass'], $parsedArgs['pass']); $out['named'] = $parsedArgs['named']; unset($out['_args_']); } if (isset($params['pass'])) { $j = count($params['pass']); while($j--) { if (isset($out[$params['pass'][$j]])) { array_unshift($out['pass'], $out[$params['pass'][$j]]); } } } break; } } if (!empty($ext) && !isset($out['url']['ext'])) { $out['url']['ext'] = $ext; } return $out; }
Parses given URL and returns an array of controller, action and parameters taken from that URL. @param string $url URL to be parsed @return array Parsed elements from URL @access public @static
parse
php
Datawalke/Coordino
cake/libs/router.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/router.php
MIT
function __parseExtension($url) { $ext = null; if ($this->__parseExtensions) { if (preg_match('/\.[0-9a-zA-Z]*$/', $url, $match) === 1) { $match = substr($match[0], 1); if (empty($this->__validExtensions)) { $url = substr($url, 0, strpos($url, '.' . $match)); $ext = $match; } else { foreach ($this->__validExtensions as $name) { if (strcasecmp($name, $match) === 0) { $url = substr($url, 0, strpos($url, '.' . $name)); $ext = $match; break; } } } } if (empty($ext)) { $ext = 'html'; } } return compact('ext', 'url'); }
Parses a file extension out of a URL, if Router::parseExtensions() is enabled. @param string $url @return array Returns an array containing the altered URL and the parsed extension. @access private
__parseExtension
php
Datawalke/Coordino
cake/libs/router.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/router.php
MIT
function __connectDefaultRoutes() { if ($plugins = App::objects('plugin')) { foreach ($plugins as $key => $value) { $plugins[$key] = Inflector::underscore($value); } $pluginPattern = implode('|', $plugins); $match = array('plugin' => $pluginPattern); $shortParams = array('routeClass' => 'PluginShortRoute', 'plugin' => $pluginPattern); foreach ($this->__prefixes as $prefix) { $params = array('prefix' => $prefix, $prefix => true); $indexParams = $params + array('action' => 'index'); $this->connect("/{$prefix}/:plugin", $indexParams, $shortParams); $this->connect("/{$prefix}/:plugin/:controller", $indexParams, $match); $this->connect("/{$prefix}/:plugin/:controller/:action/*", $params, $match); } $this->connect('/:plugin', array('action' => 'index'), $shortParams); $this->connect('/:plugin/:controller', array('action' => 'index'), $match); $this->connect('/:plugin/:controller/:action/*', array(), $match); } foreach ($this->__prefixes as $prefix) { $params = array('prefix' => $prefix, $prefix => true); $indexParams = $params + array('action' => 'index'); $this->connect("/{$prefix}/:controller", $indexParams); $this->connect("/{$prefix}/:controller/:action/*", $params); } $this->connect('/:controller', array('action' => 'index')); $this->connect('/:controller/:action/*'); if ($this->named['rules'] === false) { $this->connectNamed(true); } $this->__defaultsMapped = true; }
Connects the default, built-in routes, including prefix and plugin routes. The following routes are created in the order below: For each of the Routing.prefixes the following routes are created. Routes containing `:plugin` are only created when your application has one or more plugins. - `/:prefix/:plugin` a plugin shortcut route. - `/:prefix/:plugin/:action/*` a plugin shortcut route. - `/:prefix/:plugin/:controller` - `/:prefix/:plugin/:controller/:action/*` - `/:prefix/:controller` - `/:prefix/:controller/:action/*` If plugins are found in your application the following routes are created: - `/:plugin` a plugin shortcut route. - `/:plugin/:action/*` a plugin shortcut route. - `/:plugin/:controller` - `/:plugin/:controller/:action/*` And lastly the following catch-all routes are connected. - `/:controller' - `/:controller/:action/*' You can disable the connection of default routes with Router::defaults(). @return void @access private
__connectDefaultRoutes
php
Datawalke/Coordino
cake/libs/router.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/router.php
MIT
function setRequestInfo($params) { $self =& Router::getInstance(); $defaults = array('plugin' => null, 'controller' => null, 'action' => null); $params[0] = array_merge($defaults, (array)$params[0]); $params[1] = array_merge($defaults, (array)$params[1]); list($self->__params[], $self->__paths[]) = $params; if (count($self->__paths)) { if (isset($self->__paths[0]['namedArgs'])) { foreach ($self->__paths[0]['namedArgs'] as $arg => $value) { $self->named['rules'][$arg] = true; } } } }
Takes parameter and path information back from the Dispatcher, sets these parameters as the current request parameters that are merged with url arrays created later in the request. @param array $params Parameters and path information @return void @access public @static
setRequestInfo
php
Datawalke/Coordino
cake/libs/router.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/router.php
MIT
function getParams($current = false) { $self =& Router::getInstance(); if ($current) { return $self->__params[count($self->__params) - 1]; } if (isset($self->__params[0])) { return $self->__params[0]; } return array(); }
Gets parameter information @param boolean $current Get current request parameter, useful when using requestAction @return array Parameter information @access public @static
getParams
php
Datawalke/Coordino
cake/libs/router.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/router.php
MIT
function getParam($name = 'controller', $current = false) { $params = Router::getParams($current); if (isset($params[$name])) { return $params[$name]; } return null; }
Gets URL parameter by name @param string $name Parameter name @param boolean $current Current parameter, useful when using requestAction @return string Parameter value @access public @static
getParam
php
Datawalke/Coordino
cake/libs/router.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/router.php
MIT
function getPaths($current = false) { $self =& Router::getInstance(); if ($current) { return $self->__paths[count($self->__paths) - 1]; } if (!isset($self->__paths[0])) { return array('base' => null); } return $self->__paths[0]; }
Gets path information @param boolean $current Current parameter, useful when using requestAction @return array @access public @static
getPaths
php
Datawalke/Coordino
cake/libs/router.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/router.php
MIT
function reload() { $self =& Router::getInstance(); foreach (get_class_vars('Router') as $key => $val) { $self->{$key} = $val; } $self->__setPrefixes(); }
Reloads default Router settings. Resets all class variables and removes all connected routes. @access public @return void @static
reload
php
Datawalke/Coordino
cake/libs/router.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/router.php
MIT
function promote($which = null) { $self =& Router::getInstance(); if ($which === null) { $which = count($self->routes) - 1; } if (!isset($self->routes[$which])) { return false; } $route =& $self->routes[$which]; unset($self->routes[$which]); array_unshift($self->routes, $route); return true; }
Promote a route (by default, the last one added) to the beginning of the list @param $which A zero-based array index representing the route to move. For example, if 3 routes have been added, the last route would be 2. @return boolean Returns false if no route exists at the position specified by $which. @access public @static
promote
php
Datawalke/Coordino
cake/libs/router.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/router.php
MIT
function url($url = null, $full = false) { $self =& Router::getInstance(); $defaults = $params = array('plugin' => null, 'controller' => null, 'action' => 'index'); if (is_bool($full)) { $escape = false; } else { extract($full + array('escape' => false, 'full' => false)); } if (!empty($self->__params)) { if (isset($this) && !isset($this->params['requested'])) { $params = $self->__params[0]; } else { $params = end($self->__params); } } $path = array('base' => null); if (!empty($self->__paths)) { if (isset($this) && !isset($this->params['requested'])) { $path = $self->__paths[0]; } else { $path = end($self->__paths); } } $base = $path['base']; $extension = $output = $mapped = $q = $frag = null; if (is_array($url)) { if (isset($url['base']) && $url['base'] === false) { $base = null; unset($url['base']); } if (isset($url['full_base']) && $url['full_base'] === true) { $full = true; unset($url['full_base']); } if (isset($url['?'])) { $q = $url['?']; unset($url['?']); } if (isset($url['#'])) { $frag = '#' . urlencode($url['#']); unset($url['#']); } if (empty($url['action'])) { if (empty($url['controller']) || $params['controller'] === $url['controller']) { $url['action'] = $params['action']; } else { $url['action'] = 'index'; } } $prefixExists = (array_intersect_key($url, array_flip($self->__prefixes))); foreach ($self->__prefixes as $prefix) { if (!empty($params[$prefix]) && !$prefixExists) { $url[$prefix] = true; } elseif (isset($url[$prefix]) && !$url[$prefix]) { unset($url[$prefix]); } if (isset($url[$prefix]) && strpos($url['action'], $prefix . '_') === 0) { $url['action'] = substr($url['action'], strlen($prefix) + 1); } } $url += array('controller' => $params['controller'], 'plugin' => $params['plugin']); if (isset($url['ext'])) { $extension = '.' . $url['ext']; unset($url['ext']); } $match = false; for ($i = 0, $len = count($self->routes); $i < $len; $i++) { $originalUrl = $url; if (isset($self->routes[$i]->options['persist'], $params)) { $url = $self->routes[$i]->persistParams($url, $params); } if ($match = $self->routes[$i]->match($url)) { $output = trim($match, '/'); break; } $url = $originalUrl; } if ($match === false) { $output = $self->_handleNoRoute($url); } $output = str_replace('//', '/', $base . '/' . $output); } else { if (((strpos($url, '://')) !== false || (strpos($url, 'javascript:') === 0) || (strpos($url, 'mailto:') === 0)) || (!strncmp($url, '#', 1))) { return $url; } if (empty($url)) { if (!isset($path['here'])) { $path['here'] = '/'; } $output = $path['here']; } elseif (substr($url, 0, 1) === '/') { $output = $base . $url; } else { $output = $base . '/'; foreach ($self->__prefixes as $prefix) { if (isset($params[$prefix])) { $output .= $prefix . '/'; break; } } if (!empty($params['plugin']) && $params['plugin'] !== $params['controller']) { $output .= Inflector::underscore($params['plugin']) . '/'; } $output .= Inflector::underscore($params['controller']) . '/' . $url; } $output = str_replace('//', '/', $output); } if ($full && defined('FULL_BASE_URL')) { $output = FULL_BASE_URL . $output; } if (!empty($extension) && substr($output, -1) === '/') { $output = substr($output, 0, -1); } return $output . $extension . $self->queryString($q, array(), $escape) . $frag; }
Finds URL for specified action. Returns an URL pointing to a combination of controller and action. Param $url can be: - Empty - the method will find address to actual controller/action. - '/' - the method will find base URL of application. - A combination of controller/action - the method will find url for it. There are a few 'special' parameters that can change the final URL string that is generated - `base` - Set to false to remove the base path from the generated url. If your application is not in the root directory, this can be used to generate urls that are 'cake relative'. cake relative urls are required when using requestAction. - `?` - Takes an array of query string parameters - `#` - Allows you to set url hash fragments. - `full_base` - If true the `FULL_BASE_URL` constant will be prepended to generated urls. @param mixed $url Cake-relative URL, like "/products/edit/92" or "/presidents/elect/4" or an array specifying any of the following: 'controller', 'action', and/or 'plugin', in addition to named arguments (keyed array elements), and standard URL arguments (indexed array elements) @param mixed $full If (bool) true, the full base URL will be prepended to the result. If an array accepts the following keys - escape - used when making urls embedded in html escapes query string '&' - full - if true the full base URL will be prepended. @return string Full translated URL with base path. @access public @static
url
php
Datawalke/Coordino
cake/libs/router.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/router.php
MIT
function _handleNoRoute($url) { $named = $args = array(); $skip = array_merge( array('bare', 'action', 'controller', 'plugin', 'prefix'), $this->__prefixes ); $keys = array_values(array_diff(array_keys($url), $skip)); $count = count($keys); // Remove this once parsed URL parameters can be inserted into 'pass' for ($i = 0; $i < $count; $i++) { if (is_numeric($keys[$i])) { $args[] = $url[$keys[$i]]; } else { $named[$keys[$i]] = $url[$keys[$i]]; } } list($args, $named) = array(Set::filter($args, true), Set::filter($named, true)); foreach ($this->__prefixes as $prefix) { if (!empty($url[$prefix])) { $url['action'] = str_replace($prefix . '_', '', $url['action']); break; } } if (empty($named) && empty($args) && (!isset($url['action']) || $url['action'] === 'index')) { $url['action'] = null; } $urlOut = array_filter(array($url['controller'], $url['action'])); if (isset($url['plugin'])) { array_unshift($urlOut, $url['plugin']); } foreach ($this->__prefixes as $prefix) { if (isset($url[$prefix])) { array_unshift($urlOut, $prefix); break; } } $output = implode('/', $urlOut); if (!empty($args)) { $output .= '/' . implode('/', $args); } if (!empty($named)) { foreach ($named as $name => $value) { if (is_array($value)) { $flattend = Set::flatten($value, ']['); foreach ($flattend as $namedKey => $namedValue) { $output .= '/' . $name . "[$namedKey]" . $this->named['separator'] . $namedValue; } } else { $output .= '/' . $name . $this->named['separator'] . $value; } } } return $output; }
A special fallback method that handles url arrays that cannot match any defined routes. @param array $url A url that didn't match any routes @return string A generated url for the array @access protected @see Router::url()
_handleNoRoute
php
Datawalke/Coordino
cake/libs/router.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/router.php
MIT
function getNamedElements($params, $controller = null, $action = null) { $self =& Router::getInstance(); $named = array(); foreach ($params as $param => $val) { if (isset($self->named['rules'][$param])) { $rule = $self->named['rules'][$param]; if (Router::matchNamed($param, $val, $rule, compact('controller', 'action'))) { $named[$param] = $val; unset($params[$param]); } } } return array($named, $params); }
Takes an array of URL parameters and separates the ones that can be used as named arguments @param array $params Associative array of URL parameters. @param string $controller Name of controller being routed. Used in scoping. @param string $action Name of action being routed. Used in scoping. @return array @access public @static
getNamedElements
php
Datawalke/Coordino
cake/libs/router.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/router.php
MIT
function matchNamed($param, $val, $rule, $context = array()) { if ($rule === true || $rule === false) { return $rule; } if (is_string($rule)) { $rule = array('match' => $rule); } if (!is_array($rule)) { return false; } $controllerMatches = !isset($rule['controller'], $context['controller']) || in_array($context['controller'], (array)$rule['controller']); if (!$controllerMatches) { return false; } $actionMatches = !isset($rule['action'], $context['action']) || in_array($context['action'], (array)$rule['action']); if (!$actionMatches) { return false; } return (!isset($rule['match']) || preg_match('/' . $rule['match'] . '/', $val)); }
Return true if a given named $param's $val matches a given $rule depending on $context. Currently implemented rule types are controller, action and match that can be combined with each other. @param string $param The name of the named parameter @param string $val The value of the named parameter @param array $rule The rule(s) to apply, can also be a match string @param string $context An array with additional context information (controller / action) @return boolean @access public @static
matchNamed
php
Datawalke/Coordino
cake/libs/router.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/router.php
MIT
function queryString($q, $extra = array(), $escape = false) { if (empty($q) && empty($extra)) { return null; } $join = '&'; if ($escape === true) { $join = '&amp;'; } $out = ''; if (is_array($q)) { $q = array_merge($extra, $q); } else { $out = $q; $q = $extra; } $out .= http_build_query($q, null, $join); if (isset($out[0]) && $out[0] != '?') { $out = '?' . $out; } return $out; }
Generates a well-formed querystring from $q @param mixed $q Query string @param array $extra Extra querystring parameters. @param bool $escape Whether or not to use escaped & @return array @access public @static
queryString
php
Datawalke/Coordino
cake/libs/router.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/router.php
MIT
function reverse($params) { $pass = $params['pass']; $named = $params['named']; $url = $params['url']; unset( $params['pass'], $params['named'], $params['paging'], $params['models'], $params['url'], $url['url'], $params['autoRender'], $params['bare'], $params['requested'], $params['return'] ); $params = array_merge($params, $pass, $named); if (!empty($url)) { $params['?'] = $url; } return Router::url($params); }
Reverses a parsed parameter array into a string. Works similarly to Router::url(), but Since parsed URL's contain additional 'pass' and 'named' as well as 'url.url' keys. Those keys need to be specially handled in order to reverse a params array into a string url. This will strip out 'autoRender', 'bare', 'requested', and 'return' param names as those are used for CakePHP internals and should not normally be part of an output url. @param array $param The params array that needs to be reversed. @return string The string that is the reversed result of the array @access public @static
reverse
php
Datawalke/Coordino
cake/libs/router.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/router.php
MIT
function normalize($url = '/') { if (is_array($url)) { $url = Router::url($url); } elseif (preg_match('/^[a-z\-]+:\/\//', $url)) { return $url; } $paths = Router::getPaths(); if (!empty($paths['base']) && stristr($url, $paths['base'])) { $url = preg_replace('/^' . preg_quote($paths['base'], '/') . '/', '', $url, 1); } $url = '/' . $url; while (strpos($url, '//') !== false) { $url = str_replace('//', '/', $url); } $url = preg_replace('/(?:(\/$))/', '', $url); if (empty($url)) { return '/'; } return $url; }
Normalizes a URL for purposes of comparison. Will strip the base path off and replace any double /'s. It will not unify the casing and underscoring of the input value. @param mixed $url URL to normalize Either an array or a string url. @return string Normalized URL @access public @static
normalize
php
Datawalke/Coordino
cake/libs/router.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/router.php
MIT
function &requestRoute() { $self =& Router::getInstance(); return $self->__currentRoute[0]; }
Returns the route matching the current request URL. @return CakeRoute Matching route object. @access public @static
requestRoute
php
Datawalke/Coordino
cake/libs/router.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/router.php
MIT
function &currentRoute() { $self =& Router::getInstance(); return $self->__currentRoute[count($self->__currentRoute) - 1]; }
Returns the route matching the current request (useful for requestAction traces) @return CakeRoute Matching route object. @access public @static
currentRoute
php
Datawalke/Coordino
cake/libs/router.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/router.php
MIT
function stripPlugin($base, $plugin = null) { if ($plugin != null) { $base = preg_replace('/(?:' . $plugin . ')/', '', $base); $base = str_replace('//', '', $base); $pos1 = strrpos($base, '/'); $char = strlen($base) - 1; if ($pos1 === $char) { $base = substr($base, 0, $char); } } return $base; }
Removes the plugin name from the base URL. @param string $base Base URL @param string $plugin Plugin name @return base url with plugin name removed if present @access public @static
stripPlugin
php
Datawalke/Coordino
cake/libs/router.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/router.php
MIT
function parseExtensions() { $self =& Router::getInstance(); $self->__parseExtensions = true; if (func_num_args() > 0) { $self->__validExtensions = func_get_args(); } }
Instructs the router to parse out file extensions from the URL. For example, http://example.com/posts.rss would yield an file extension of "rss". The file extension itself is made available in the controller as $this->params['url']['ext'], and is used by the RequestHandler component to automatically switch to alternate layouts and templates, and load helpers corresponding to the given content, i.e. RssHelper. A list of valid extension can be passed to this method, i.e. Router::parseExtensions('rss', 'xml'); If no parameters are given, anything after the first . (dot) after the last / in the URL will be parsed, excluding querystring parameters (i.e. ?q=...). @access public @return void @static
parseExtensions
php
Datawalke/Coordino
cake/libs/router.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/router.php
MIT
function getArgs($args, $options = array()) { $self =& Router::getInstance(); $pass = $named = array(); $args = explode('/', $args); $greedy = isset($options['greedy']) ? $options['greedy'] : $self->named['greedy']; $context = array(); if (isset($options['context'])) { $context = $options['context']; } $rules = $self->named['rules']; if (isset($options['named'])) { $greedy = isset($options['greedy']) && $options['greedy'] === true; foreach ((array)$options['named'] as $key => $val) { if (is_numeric($key)) { $rules[$val] = true; continue; } $rules[$key] = $val; } } foreach ($args as $param) { if (empty($param) && $param !== '0' && $param !== 0) { continue; } $separatorIsPresent = strpos($param, $self->named['separator']) !== false; if ((!isset($options['named']) || !empty($options['named'])) && $separatorIsPresent) { list($key, $val) = explode($self->named['separator'], $param, 2); $hasRule = isset($rules[$key]); $passIt = (!$hasRule && !$greedy) || ($hasRule && !$self->matchNamed($key, $val, $rules[$key], $context)); if ($passIt) { $pass[] = $param; } else { $named[$key] = $val; } } else { $pass[] = $param; } } return compact('pass', 'named'); }
Takes a passed params and converts it to args @param array $params @return array Array containing passed and named parameters @access public @static
getArgs
php
Datawalke/Coordino
cake/libs/router.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/router.php
MIT
function CakeRoute($template, $defaults = array(), $options = array()) { $this->template = $template; $this->defaults = (array)$defaults; $this->options = (array)$options; }
Constructor for a Route @param string $template Template string with parameter placeholders @param array $defaults Array of defaults for the route. @param string $params Array of parameters and additional options for the Route @return void @access public
CakeRoute
php
Datawalke/Coordino
cake/libs/router.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/router.php
MIT
function compiled() { return !empty($this->_compiledRoute); }
Check if a Route has been compiled into a regular expression. @return boolean @access public
compiled
php
Datawalke/Coordino
cake/libs/router.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/router.php
MIT
function compile() { if ($this->compiled()) { return $this->_compiledRoute; } $this->_writeRoute(); return $this->_compiledRoute; }
Compiles the route's regular expression. Modifies defaults property so all necessary keys are set and populates $this->names with the named routing elements. @return array Returns a string regular expression of the compiled route. @access public
compile
php
Datawalke/Coordino
cake/libs/router.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/router.php
MIT
function _writeRoute() { if (empty($this->template) || ($this->template === '/')) { $this->_compiledRoute = '#^/*$#'; $this->keys = array(); return; } $route = $this->template; $names = $routeParams = array(); $parsed = preg_quote($this->template, '#'); $parsed = str_replace('\\-', '-', $parsed); preg_match_all('#:([A-Za-z0-9_-]+[A-Z0-9a-z])#', $parsed, $namedElements); foreach ($namedElements[1] as $i => $name) { $search = '\\' . $namedElements[0][$i]; if (isset($this->options[$name])) { $option = null; if ($name !== 'plugin' && array_key_exists($name, $this->defaults)) { $option = '?'; } $slashParam = '/\\' . $namedElements[0][$i]; if (strpos($parsed, $slashParam) !== false) { $routeParams[$slashParam] = '(?:/(' . $this->options[$name] . ')' . $option . ')' . $option; } else { $routeParams[$search] = '(?:(' . $this->options[$name] . ')' . $option . ')' . $option; } } else { $routeParams[$search] = '(?:([^/]+))'; } $names[] = $name; } if (preg_match('#\/\*$#', $route, $m)) { $parsed = preg_replace('#/\\\\\*$#', '(?:/(?P<_args_>.*))?', $parsed); $this->_greedy = true; } krsort($routeParams); $parsed = str_replace(array_keys($routeParams), array_values($routeParams), $parsed); $this->_compiledRoute = '#^' . $parsed . '[/]*$#'; $this->keys = $names; }
Builds a route regular expression. Uses the template, defaults and options properties to compile a regular expression that can be used to parse request strings. @return void @access protected
_writeRoute
php
Datawalke/Coordino
cake/libs/router.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/router.php
MIT
function parse($url) { if (!$this->compiled()) { $this->compile(); } if (!preg_match($this->_compiledRoute, $url, $parsed)) { return false; } else { foreach ($this->defaults as $key => $val) { if ($key[0] === '[' && preg_match('/^\[(\w+)\]$/', $key, $header)) { if (isset($this->__headerMap[$header[1]])) { $header = $this->__headerMap[$header[1]]; } else { $header = 'http_' . $header[1]; } $val = (array)$val; $h = false; foreach ($val as $v) { if (env(strtoupper($header)) === $v) { $h = true; } } if (!$h) { return false; } } } array_shift($parsed); $route = array(); foreach ($this->keys as $i => $key) { if (isset($parsed[$i])) { $route[$key] = $parsed[$i]; } } $route['pass'] = $route['named'] = array(); $route += $this->defaults; if (isset($parsed['_args_'])) { $route['_args_'] = $parsed['_args_']; } foreach ($route as $key => $value) { if (is_integer($key)) { $route['pass'][] = $value; unset($route[$key]); } } return $route; } }
Checks to see if the given URL can be parsed by this route. If the route can be parsed an array of parameters will be returned; if not, false will be returned. String urls are parsed if they match a routes regular expression. @param string $url The url to attempt to parse. @return mixed Boolean false on failure, otherwise an array or parameters @access public
parse
php
Datawalke/Coordino
cake/libs/router.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/router.php
MIT
function match($url) { if (!$this->compiled()) { $this->compile(); } $defaults = $this->defaults; if (isset($defaults['prefix'])) { $url['prefix'] = $defaults['prefix']; } //check that all the key names are in the url $keyNames = array_flip($this->keys); if (array_intersect_key($keyNames, $url) != $keyNames) { return false; } $diffUnfiltered = Set::diff($url, $defaults); $diff = array(); foreach ($diffUnfiltered as $key => $var) { if ($var === 0 || $var === '0' || !empty($var)) { $diff[$key] = $var; } } //if a not a greedy route, no extra params are allowed. if (!$this->_greedy && array_diff_key($diff, $keyNames) != array()) { return false; } //remove defaults that are also keys. They can cause match failures foreach ($this->keys as $key) { unset($defaults[$key]); } $filteredDefaults = array_filter($defaults); //if the difference between the url diff and defaults contains keys from defaults its not a match if (array_intersect_key($filteredDefaults, $diffUnfiltered) !== array()) { return false; } $passedArgsAndParams = array_diff_key($diff, $filteredDefaults, $keyNames); list($named, $params) = Router::getNamedElements($passedArgsAndParams, $url['controller'], $url['action']); //remove any pass params, they have numeric indexes, skip any params that are in the defaults $pass = array(); $i = 0; while (isset($url[$i])) { if (!isset($diff[$i])) { $i++; continue; } $pass[] = $url[$i]; unset($url[$i], $params[$i]); $i++; } //still some left over parameters that weren't named or passed args, bail. if (!empty($params)) { return false; } //check patterns for routed params if (!empty($this->options)) { foreach ($this->options as $key => $pattern) { if (array_key_exists($key, $url) && !preg_match('#^' . $pattern . '$#', $url[$key])) { return false; } } } return $this->_writeUrl(array_merge($url, compact('pass', 'named'))); }
Attempt to match a url array. If the url matches the route parameters and settings, then return a generated string url. If the url doesn't match the route parameters, false will be returned. This method handles the reverse routing or conversion of url arrays into string urls. @param array $url An array of parameters to check matching with. @return mixed Either a string url for the parameters if they match or false. @access public
match
php
Datawalke/Coordino
cake/libs/router.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/router.php
MIT
function _writeUrl($params) { if (isset($params['prefix'], $params['action'])) { $params['action'] = str_replace($params['prefix'] . '_', '', $params['action']); unset($params['prefix']); } if (is_array($params['pass'])) { $params['pass'] = implode('/', $params['pass']); } $instance =& Router::getInstance(); $separator = $instance->named['separator']; if (!empty($params['named']) && is_array($params['named'])) { $named = array(); foreach ($params['named'] as $key => $value) { $named[] = $key . $separator . $value; } $params['pass'] = $params['pass'] . '/' . implode('/', $named); } $out = $this->template; $search = $replace = array(); foreach ($this->keys as $key) { $string = null; if (isset($params[$key])) { $string = $params[$key]; } elseif (strpos($out, $key) != strlen($out) - strlen($key)) { $key .= '/'; } $search[] = ':' . $key; $replace[] = $string; } $out = str_replace($search, $replace, $out); if (strpos($this->template, '*')) { $out = str_replace('*', $params['pass'], $out); } $out = str_replace('//', '/', $out); return $out; }
Converts a matching route array into a url string. Composes the string url using the template used to create the route. @param array $params The params to convert to a string url. @return string Composed route string. @access protected
_writeUrl
php
Datawalke/Coordino
cake/libs/router.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/router.php
MIT
function parse($url) { $params = parent::parse($url); if (!$params) { return false; } $params['controller'] = $params['plugin']; return $params; }
Parses a string url into an array. If a plugin key is found, it will be copied to the controller parameter @param string $url The url to parse @return mixed false on failure, or an array of request parameters
parse
php
Datawalke/Coordino
cake/libs/router.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/router.php
MIT
function match($url) { if (isset($url['controller']) && isset($url['plugin']) && $url['plugin'] != $url['controller']) { return false; } $this->defaults['controller'] = $url['controller']; $result = parent::match($url); unset($this->defaults['controller']); return $result; }
Reverse route plugin shortcut urls. If the plugin and controller are not the same the match is an auto fail. @param array $url Array of parameters to convert to a string. @return mixed either false or a string url.
match
php
Datawalke/Coordino
cake/libs/router.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/router.php
MIT
function paranoid($string, $allowed = array()) { $allow = null; if (!empty($allowed)) { foreach ($allowed as $value) { $allow .= "\\$value"; } } if (is_array($string)) { $cleaned = array(); foreach ($string as $key => $clean) { $cleaned[$key] = preg_replace("/[^{$allow}a-zA-Z0-9]/", '', $clean); } } else { $cleaned = preg_replace("/[^{$allow}a-zA-Z0-9]/", '', $string); } return $cleaned; }
Removes any non-alphanumeric characters. @param string $string String to sanitize @param array $allowed An array of additional characters that are not to be removed. @return string Sanitized string @access public @static
paranoid
php
Datawalke/Coordino
cake/libs/sanitize.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/sanitize.php
MIT
function escape($string, $connection = 'default') { $db =& ConnectionManager::getDataSource($connection); if (is_numeric($string) || $string === null || is_bool($string)) { return $string; } $string = substr($db->value($string), 1); $string = substr($string, 0, -1); return $string; }
Makes a string SQL-safe. @param string $string String to sanitize @param string $connection Database connection being used @return string SQL safe string @access public @static
escape
php
Datawalke/Coordino
cake/libs/sanitize.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/sanitize.php
MIT
function html($string, $options = array()) { static $defaultCharset = false; if ($defaultCharset === false) { $defaultCharset = Configure::read('App.encoding'); if ($defaultCharset === null) { $defaultCharset = 'UTF-8'; } } $default = array( 'remove' => false, 'charset' => $defaultCharset, 'quotes' => ENT_QUOTES ); $options = array_merge($default, $options); if ($options['remove']) { $string = strip_tags($string); } return htmlentities($string, $options['quotes'], $options['charset']); }
Returns given string safe for display as HTML. Renders entities. strip_tags() does not validating HTML syntax or structure, so it might strip whole passages with broken HTML. ### Options: - remove (boolean) if true strips all HTML tags before encoding - charset (string) the charset used to encode the string - quotes (int) see http://php.net/manual/en/function.htmlentities.php @param string $string String from where to strip tags @param array $options Array of options to use. @return string Sanitized string @access public @static
html
php
Datawalke/Coordino
cake/libs/sanitize.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/sanitize.php
MIT
function stripWhitespace($str) { $r = preg_replace('/[\n\r\t]+/', '', $str); return preg_replace('/\s{2,}/u', ' ', $r); }
Strips extra whitespace from output @param string $str String to sanitize @return string whitespace sanitized string @access public @static
stripWhitespace
php
Datawalke/Coordino
cake/libs/sanitize.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/sanitize.php
MIT
function stripImages($str) { $str = preg_replace('/(<a[^>]*>)(<img[^>]+alt=")([^"]*)("[^>]*>)(<\/a>)/i', '$1$3$5<br />', $str); $str = preg_replace('/(<img[^>]+alt=")([^"]*)("[^>]*>)/i', '$2<br />', $str); $str = preg_replace('/<img[^>]*>/i', '', $str); return $str; }
Strips image tags from output @param string $str String to sanitize @return string Sting with images stripped. @access public @static
stripImages
php
Datawalke/Coordino
cake/libs/sanitize.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/sanitize.php
MIT
function stripScripts($str) { return preg_replace('/(<link[^>]+rel="[^"]*stylesheet"[^>]*>|<img[^>]*>|style="[^"]*")|<script[^>]*>.*?<\/script>|<style[^>]*>.*?<\/style>|<!--.*?-->/is', '', $str); }
Strips scripts and stylesheets from output @param string $str String to sanitize @return string String with <script>, <style>, <link>, <img> elements removed. @access public @static
stripScripts
php
Datawalke/Coordino
cake/libs/sanitize.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/sanitize.php
MIT
function stripAll($str) { $str = Sanitize::stripWhitespace($str); $str = Sanitize::stripImages($str); $str = Sanitize::stripScripts($str); return $str; }
Strips extra whitespace, images, scripts and stylesheets from output @param string $str String to sanitize @return string sanitized string @access public
stripAll
php
Datawalke/Coordino
cake/libs/sanitize.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/sanitize.php
MIT
function stripTags() { $params = params(func_get_args()); $str = $params[0]; for ($i = 1, $count = count($params); $i < $count; $i++) { $str = preg_replace('/<' . $params[$i] . '\b[^>]*>/i', '', $str); $str = preg_replace('/<\/' . $params[$i] . '[^>]*>/i', '', $str); } return $str; }
Strips the specified tags from output. First parameter is string from where to remove tags. All subsequent parameters are tags. Ex.`$clean = Sanitize::stripTags($dirty, 'b', 'p', 'div');` Will remove all `<b>`, `<p>`, and `<div>` tags from the $dirty string. @param string $str String to sanitize @param string $tag Tag to remove (add more parameters as needed) @return string sanitized String @access public @static
stripTags
php
Datawalke/Coordino
cake/libs/sanitize.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/sanitize.php
MIT
function clean($data, $options = array()) { if (empty($data)) { return $data; } if (is_string($options)) { $options = array('connection' => $options); } else if (!is_array($options)) { $options = array(); } $options = array_merge(array( 'connection' => 'default', 'odd_spaces' => true, 'remove_html' => false, 'encode' => true, 'dollar' => true, 'carriage' => true, 'unicode' => true, 'escape' => true, 'backslash' => true ), $options); if (is_array($data)) { foreach ($data as $key => $val) { $data[$key] = Sanitize::clean($val, $options); } return $data; } else { if ($options['odd_spaces']) { $data = str_replace(chr(0xCA), '', $data); } if ($options['encode']) { $data = Sanitize::html($data, array('remove' => $options['remove_html'])); } if ($options['dollar']) { $data = str_replace("\\\$", "$", $data); } if ($options['carriage']) { $data = str_replace("\r", "", $data); } if ($options['unicode']) { $data = preg_replace("/&amp;#([0-9]+);/s", "&#\\1;", $data); } if ($options['escape']) { $data = Sanitize::escape($data, $options['connection']); } if ($options['backslash']) { $data = preg_replace("/\\\(?!&amp;#|\?#)/", "\\", $data); } return $data; } }
Sanitizes given array or value for safe input. Use the options to specify the connection to use, and what filters should be applied (with a boolean value). Valid filters: - odd_spaces - removes any non space whitespace characters - encode - Encode any html entities. Encode must be true for the `remove_html` to work. - dollar - Escape `$` with `\$` - carriage - Remove `\r` - unicode - - escape - Should the string be SQL escaped. - backslash - - remove_html - Strip HTML with strip_tags. `encode` must be true for this option to work. @param mixed $data Data to sanitize @param mixed $options If string, DB connection being used, otherwise set of options @return mixed Sanitized data @access public @static
clean
php
Datawalke/Coordino
cake/libs/sanitize.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/sanitize.php
MIT
function formatColumns(&$model) { foreach ($model->data as $name => $values) { if ($name == $model->alias) { $curModel =& $model; } elseif (isset($model->{$name}) && is_object($model->{$name}) && is_subclass_of($model->{$name}, 'Model')) { $curModel =& $model->{$name}; } else { $curModel = null; } if ($curModel != null) { foreach ($values as $column => $data) { $colType = $curModel->getColumnType($column); if ($colType != null) { $db =& ConnectionManager::getDataSource($curModel->useDbConfig); $colData = $db->columns[$colType]; if (isset($colData['limit']) && strlen(strval($data)) > $colData['limit']) { $data = substr(strval($data), 0, $colData['limit']); } if (isset($colData['formatter']) || isset($colData['format'])) { switch (strtolower($colData['formatter'])) { case 'date': $data = date($colData['format'], strtotime($data)); break; case 'sprintf': $data = sprintf($colData['format'], $data); break; case 'intval': $data = intval($data); break; case 'floatval': $data = floatval($data); break; } } $model->data[$name][$column]=$data; /* switch ($colType) { case 'integer': case 'int': return $data; break; case 'string': case 'text': case 'binary': case 'date': case 'time': case 'datetime': case 'timestamp': case 'date': return "'" . $data . "'"; break; } */ } } } } }
Formats column data from definition in DBO's $columns array @param Model $model The model containing the data to be formatted @access public @static
formatColumns
php
Datawalke/Coordino
cake/libs/sanitize.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/sanitize.php
MIT
function &getInstance() { static $instance = array(); if (!$instance) { $instance[0] =& new Security; } return $instance[0]; }
Singleton implementation to get object instance. @return object @access public @static
getInstance
php
Datawalke/Coordino
cake/libs/security.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/security.php
MIT
function inactiveMins() { switch (Configure::read('Security.level')) { case 'high': return 10; break; case 'medium': return 100; break; case 'low': default: return 300; break; } }
Get allowed minutes of inactivity based on security level. @return integer Allowed inactivity in minutes @access public @static
inactiveMins
php
Datawalke/Coordino
cake/libs/security.php
https://github.com/Datawalke/Coordino/blob/master/cake/libs/security.php
MIT