?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Linux multi-monitor fullscreen support
[ryzomcore.git] / web / public_php / webtt / cake / basics.php
blobac3f02ae07432f38658acff053a682752db537d0
1 <?php
2 /**
3 * Basic Cake functionality.
4 *
5 * Core functions for including other source files, loading models and so forth.
6 *
7 * PHP versions 4 and 5
8 *
9 * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
10 * Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org)
11 *
12 * Licensed under The MIT License
13 * Redistributions of files must retain the above copyright notice.
14 *
15 * @copyright Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org)
16 * @link http://cakephp.org CakePHP(tm) Project
17 * @package cake
18 * @subpackage cake.cake
19 * @since CakePHP(tm) v 0.2.9
20 * @license MIT License (http://www.opensource.org/licenses/mit-license.php)
21 */
22
23 /**
24 * Basic defines for timing functions.
25 */
26 define('SECOND', 1);
27 define('MINUTE', 60);
28 define('HOUR', 3600);
29 define('DAY', 86400);
30 define('WEEK', 604800);
31 define('MONTH', 2592000);
32 define('YEAR', 31536000);
33
34 /**
35 * Patch for PHP < 5.0
36 */
37 if (!function_exists('clone')) {
38 if (version_compare(PHP_VERSION, '5.0') < 0) {
39 eval ('
40 function clone($object)
41 {
42 return $object;
43 }');
44 }
45 }
46
47 /**
48 * Loads configuration files. Receives a set of configuration files
49 * to load.
50 * Example:
51 *
52 * `config('config1', 'config2');`
53 *
54 * @return boolean Success
55 * @link http://book.cakephp.org/view/1125/config
56 */
57 function config() {
58 $args = func_get_args();
59 foreach ($args as $arg) {
60 if ($arg === 'database' && file_exists(CONFIGS . 'database.php')) {
61 include_once(CONFIGS . $arg . '.php');
62 } elseif (file_exists(CONFIGS . $arg . '.php')) {
63 include_once(CONFIGS . $arg . '.php');
64
65 if (count($args) == 1) {
66 return true;
67 }
68 } else {
69 if (count($args) == 1) {
70 return false;
71 }
72 }
73 }
74 return true;
75 }
76
77 /**
78 * Loads component/components from LIBS. Takes optional number of parameters.
79 *
80 * Example:
81 *
82 * `uses('flay', 'time');`
83 *
84 * @param string $name Filename without the .php part
85 * @deprecated Will be removed in 2.0
86 * @link http://book.cakephp.org/view/1140/uses
87 */
88 function uses() {
89 $args = func_get_args();
90 foreach ($args as $file) {
91 require_once(LIBS . strtolower($file) . '.php');
92 }
93 }
94
95 /**
96 * Prints out debug information about given variable.
97 *
98 * Only runs if debug level is greater than zero.
99 *
100 * @param boolean $var Variable to show debug information for.
101 * @param boolean $showHtml If set to true, the method prints the debug data in a screen-friendly way.
102 * @param boolean $showFrom If set to true, the method prints from where the function was called.
103 * @link http://book.cakephp.org/view/1190/Basic-Debugging
104 * @link http://book.cakephp.org/view/1128/debug
105 */
106 function debug($var = false, $showHtml = false, $showFrom = true) {
107 if (Configure::read() > 0) {
108 if ($showFrom) {
109 $calledFrom = debug_backtrace();
110 echo '<strong>' . substr(str_replace(ROOT, '', $calledFrom[0]['file']), 1) . '</strong>';
111 echo ' (line <strong>' . $calledFrom[0]['line'] . '</strong>)';
112 }
113 echo "\n<pre class=\"cake-debug\">\n";
114
115 $var = print_r($var, true);
116 if ($showHtml) {
117 $var = str_replace('<', '&lt;', str_replace('>', '&gt;', $var));
118 }
119 echo $var . "\n</pre>\n";
120 }
121 }
122 if (!function_exists('getMicrotime')) {
123
124 /**
125 * Returns microtime for execution time checking
126 *
127 * @return float Microtime
128 */
129 function getMicrotime() {
130 list($usec, $sec) = explode(' ', microtime());
131 return ((float)$usec + (float)$sec);
132 }
133 }
134 if (!function_exists('sortByKey')) {
135
136 /**
137 * Sorts given $array by key $sortby.
138 *
139 * @param array $array Array to sort
140 * @param string $sortby Sort by this key
141 * @param string $order Sort order asc/desc (ascending or descending).
142 * @param integer $type Type of sorting to perform
143 * @return mixed Sorted array
144 */
145 function sortByKey(&$array, $sortby, $order = 'asc', $type = SORT_NUMERIC) {
146 if (!is_array($array)) {
147 return null;
148 }
149
150 foreach ($array as $key => $val) {
151 $sa[$key] = $val[$sortby];
152 }
153
154 if ($order == 'asc') {
155 asort($sa, $type);
156 } else {
157 arsort($sa, $type);
158 }
159
160 foreach ($sa as $key => $val) {
161 $out[] = $array[$key];
162 }
163 return $out;
164 }
165 }
166 if (!function_exists('array_combine')) {
167
168 /**
169 * Combines given identical arrays by using the first array's values as keys,
170 * and the second one's values as values. (Implemented for backwards compatibility with PHP4)
171 *
172 * @param array $a1 Array to use for keys
173 * @param array $a2 Array to use for values
174 * @return mixed Outputs either combined array or false.
175 * @deprecated Will be removed in 2.0
176 */
177 function array_combine($a1, $a2) {
178 $a1 = array_values($a1);
179 $a2 = array_values($a2);
180 $c1 = count($a1);
181 $c2 = count($a2);
182
183 if ($c1 != $c2) {
184 return false;
185 }
186 if ($c1 <= 0) {
187 return false;
188 }
189 $output = array();
190
191 for ($i = 0; $i < $c1; $i++) {
192 $output[$a1[$i]] = $a2[$i];
193 }
194 return $output;
195 }
196 }
197
198 /**
199 * Convenience method for htmlspecialchars.
200 *
201 * @param string $text Text to wrap through htmlspecialchars
202 * @param string $charset Character set to use when escaping. Defaults to config value in 'App.encoding' or 'UTF-8'
203 * @return string Wrapped text
204 * @link http://book.cakephp.org/view/1132/h
205 */
206 function h($text, $charset = null) {
207 if (is_array($text)) {
208 return array_map('h', $text);
209 }
210
211 static $defaultCharset = false;
212 if ($defaultCharset === false) {
213 $defaultCharset = Configure::read('App.encoding');
214 if ($defaultCharset === null) {
215 $defaultCharset = 'UTF-8';
216 }
217 }
218 if ($charset) {
219 return htmlspecialchars($text, ENT_QUOTES, $charset);
220 } else {
221 return htmlspecialchars($text, ENT_QUOTES, $defaultCharset);
222 }
223 }
224
225 /**
226 * Splits a dot syntax plugin name into its plugin and classname.
227 * If $name does not have a dot, then index 0 will be null.
228 *
229 * Commonly used like `list($plugin, $name) = pluginSplit($name);`
230 *
231 * @param string $name The name you want to plugin split.
232 * @param boolean $dotAppend Set to true if you want the plugin to have a '.' appended to it.
233 * @param string $plugin Optional default plugin to use if no plugin is found. Defaults to null.
234 * @return array Array with 2 indexes. 0 => plugin name, 1 => classname
235 */
236 function pluginSplit($name, $dotAppend = false, $plugin = null) {
237 if (strpos($name, '.') !== false) {
238 $parts = explode('.', $name, 2);
239 if ($dotAppend) {
240 $parts[0] .= '.';
241 }
242 return $parts;
243 }
244 return array($plugin, $name);
245 }
246
247 /**
248 * Returns an array of all the given parameters.
249 *
250 * Example:
251 *
252 * `a('a', 'b')`
253 *
254 * Would return:
255 *
256 * `array('a', 'b')`
257 *
258 * @return array Array of given parameters
259 * @link http://book.cakephp.org/view/1122/a
260 * @deprecated Will be removed in 2.0
261 */
262 function a() {
263 $args = func_get_args();
264 return $args;
265 }
266
267 /**
268 * Constructs associative array from pairs of arguments.
269 *
270 * Example:
271 *
272 * `aa('a','b')`
273 *
274 * Would return:
275 *
276 * `array('a'=>'b')`
277 *
278 * @return array Associative array
279 * @link http://book.cakephp.org/view/1123/aa
280 * @deprecated Will be removed in 2.0
281 */
282 function aa() {
283 $args = func_get_args();
284 $argc = count($args);
285 for ($i = 0; $i < $argc; $i++) {
286 if ($i + 1 < $argc) {
287 $a[$args[$i]] = $args[$i + 1];
288 } else {
289 $a[$args[$i]] = null;
290 }
291 $i++;
292 }
293 return $a;
294 }
295
296 /**
297 * Convenience method for echo().
298 *
299 * @param string $text String to echo
300 * @link http://book.cakephp.org/view/1129/e
301 * @deprecated Will be removed in 2.0
302 */
303 function e($text) {
304 echo $text;
305 }
306
307 /**
308 * Convenience method for strtolower().
309 *
310 * @param string $str String to lowercase
311 * @return string Lowercased string
312 * @link http://book.cakephp.org/view/1134/low
313 * @deprecated Will be removed in 2.0
314 */
315 function low($str) {
316 return strtolower($str);
317 }
318
319 /**
320 * Convenience method for strtoupper().
321 *
322 * @param string $str String to uppercase
323 * @return string Uppercased string
324 * @link http://book.cakephp.org/view/1139/up
325 * @deprecated Will be removed in 2.0
326 */
327 function up($str) {
328 return strtoupper($str);
329 }
330
331 /**
332 * Convenience method for str_replace().
333 *
334 * @param string $search String to be replaced
335 * @param string $replace String to insert
336 * @param string $subject String to search
337 * @return string Replaced string
338 * @link http://book.cakephp.org/view/1137/r
339 * @deprecated Will be removed in 2.0
340 */
341 function r($search, $replace, $subject) {
342 return str_replace($search, $replace, $subject);
343 }
344
345 /**
346 * Print_r convenience function, which prints out <PRE> tags around
347 * the output of given array. Similar to debug().
348 *
349 * @see debug()
350 * @param array $var Variable to print out
351 * @link http://book.cakephp.org/view/1136/pr
352 */
353 function pr($var) {
354 if (Configure::read() > 0) {
355 echo '<pre>';
356 print_r($var);
357 echo '</pre>';
358 }
359 }
360
361 /**
362 * Display parameters.
363 *
364 * @param mixed $p Parameter as string or array
365 * @return string
366 * @deprecated Will be removed in 2.0
367 */
368 function params($p) {
369 if (!is_array($p) || count($p) == 0) {
370 return null;
371 }
372 if (is_array($p[0]) && count($p) == 1) {
373 return $p[0];
374 }
375 return $p;
376 }
377
378 /**
379 * Merge a group of arrays
380 *
381 * @param array First array
382 * @param array Second array
383 * @param array Third array
384 * @param array Etc...
385 * @return array All array parameters merged into one
386 * @link http://book.cakephp.org/view/1124/am
387 */
388 function am() {
389 $r = array();
390 $args = func_get_args();
391 foreach ($args as $a) {
392 if (!is_array($a)) {
393 $a = array($a);
394 }
395 $r = array_merge($r, $a);
396 }
397 return $r;
398 }
399
400 /**
401 * Gets an environment variable from available sources, and provides emulation
402 * for unsupported or inconsistent environment variables (i.e. DOCUMENT_ROOT on
403 * IIS, or SCRIPT_NAME in CGI mode). Also exposes some additional custom
404 * environment information.
405 *
406 * @param string $key Environment variable name.
407 * @return string Environment variable setting.
408 * @link http://book.cakephp.org/view/1130/env
409 */
410 function env($key) {
411 if ($key == 'HTTPS') {
412 if (isset($_SERVER['HTTPS'])) {
413 return (!empty($_SERVER['HTTPS']) && $_SERVER['HTTPS'] !== 'off');
414 }
415 return (strpos(env('SCRIPT_URI'), 'https://') === 0);
416 }
417
418 if ($key == 'SCRIPT_NAME') {
419 if (env('CGI_MODE') && isset($_ENV['SCRIPT_URL'])) {
420 $key = 'SCRIPT_URL';
421 }
422 }
423
424 $val = null;
425 if (isset($_SERVER[$key])) {
426 $val = $_SERVER[$key];
427 } elseif (isset($_ENV[$key])) {
428 $val = $_ENV[$key];
429 } elseif (getenv($key) !== false) {
430 $val = getenv($key);
431 }
432
433 if ($key === 'REMOTE_ADDR' && $val === env('SERVER_ADDR')) {
434 $addr = env('HTTP_PC_REMOTE_ADDR');
435 if ($addr !== null) {
436 $val = $addr;
437 }
438 }
439
440 if ($val !== null) {
441 return $val;
442 }
443
444 switch ($key) {
445 case 'SCRIPT_FILENAME':
446 if (defined('SERVER_IIS') && SERVER_IIS === true) {
447 return str_replace('\\\\', '\\', env('PATH_TRANSLATED'));
448 }
449 break;
450 case 'DOCUMENT_ROOT':
451 $name = env('SCRIPT_NAME');
452 $filename = env('SCRIPT_FILENAME');
453 $offset = 0;
454 if (!strpos($name, '.php')) {
455 $offset = 4;
456 }
457 return substr($filename, 0, strlen($filename) - (strlen($name) + $offset));
458 break;
459 case 'PHP_SELF':
460 return str_replace(env('DOCUMENT_ROOT'), '', env('SCRIPT_FILENAME'));
461 break;
462 case 'CGI_MODE':
463 return (PHP_SAPI === 'cgi');
464 break;
465 case 'HTTP_BASE':
466 $host = env('HTTP_HOST');
467 $parts = explode('.', $host);
468 $count = count($parts);
469
470 if ($count === 1) {
471 return '.' . $host;
472 } elseif ($count === 2) {
473 return '.' . $host;
474 } elseif ($count === 3) {
475 $gTLD = array('aero', 'asia', 'biz', 'cat', 'com', 'coop', 'edu', 'gov', 'info', 'int', 'jobs', 'mil', 'mobi', 'museum', 'name', 'net', 'org', 'pro', 'tel', 'travel', 'xxx');
476 if (in_array($parts[1], $gTLD)) {
477 return '.' . $host;
478 }
479 }
480 array_shift($parts);
481 return '.' . implode('.', $parts);
482 break;
483 }
484 return null;
485 }
486 if (!function_exists('file_put_contents')) {
487
488 /**
489 * Writes data into file.
490 *
491 * If file exists, it will be overwritten. If data is an array, it will be implode()ed with an empty string.
492 *
493 * @param string $fileName File name.
494 * @param mixed $data String or array.
495 * @return boolean Success
496 * @deprecated Will be removed in 2.0
497 */
498 function file_put_contents($fileName, $data) {
499 if (is_array($data)) {
500 $data = implode('', $data);
501 }
502 $res = @fopen($fileName, 'w+b');
503
504 if ($res) {
505 $write = @fwrite($res, $data);
506 if ($write === false) {
507 return false;
508 } else {
509 @fclose($res);
510 return $write;
511 }
512 }
513 return false;
514 }
515 }
516
517 /**
518 * Reads/writes temporary data to cache files or session.
519 *
520 * @param string $path File path within /tmp to save the file.
521 * @param mixed $data The data to save to the temporary file.
522 * @param mixed $expires A valid strtotime string when the data expires.
523 * @param string $target The target of the cached data; either 'cache' or 'public'.
524 * @return mixed The contents of the temporary file.
525 * @deprecated Please use Cache::write() instead
526 */
527 function cache($path, $data = null, $expires = '+1 day', $target = 'cache') {
528 if (Configure::read('Cache.disable')) {
529 return null;
530 }
531 $now = time();
532
533 if (!is_numeric($expires)) {
534 $expires = strtotime($expires, $now);
535 }
536
537 switch (strtolower($target)) {
538 case 'cache':
539 $filename = CACHE . $path;
540 break;
541 case 'public':
542 $filename = WWW_ROOT . $path;
543 break;
544 case 'tmp':
545 $filename = TMP . $path;
546 break;
547 }
548 $timediff = $expires - $now;
549 $filetime = false;
550
551 if (file_exists($filename)) {
552 $filetime = @filemtime($filename);
553 }
554
555 if ($data === null) {
556 if (file_exists($filename) && $filetime !== false) {
557 if ($filetime + $timediff < $now) {
558 @unlink($filename);
559 } else {
560 $data = @file_get_contents($filename);
561 }
562 }
563 } elseif (is_writable(dirname($filename))) {
564 @file_put_contents($filename, $data);
565 }
566 return $data;
567 }
568
569 /**
570 * Used to delete files in the cache directories, or clear contents of cache directories
571 *
572 * @param mixed $params As String name to be searched for deletion, if name is a directory all files in
573 * directory will be deleted. If array, names to be searched for deletion. If clearCache() without params,
574 * all files in app/tmp/cache/views will be deleted
575 * @param string $type Directory in tmp/cache defaults to view directory
576 * @param string $ext The file extension you are deleting
577 * @return true if files found and deleted false otherwise
578 */
579 function clearCache($params = null, $type = 'views', $ext = '.php') {
580 if (is_string($params) || $params === null) {
581 $params = preg_replace('/\/\//', '/', $params);
582 $cache = CACHE . $type . DS . $params;
583
584 if (is_file($cache . $ext)) {
585 @unlink($cache . $ext);
586 return true;
587 } elseif (is_dir($cache)) {
588 $files = glob($cache . '*');
589
590 if ($files === false) {
591 return false;
592 }
593
594 foreach ($files as $file) {
595 if (is_file($file) && strrpos($file, DS . 'empty') !== strlen($file) - 6) {
596 @unlink($file);
597 }
598 }
599 return true;
600 } else {
601 $cache = array(
602 CACHE . $type . DS . '*' . $params . $ext,
603 CACHE . $type . DS . '*' . $params . '_*' . $ext
604 );
605 $files = array();
606 while ($search = array_shift($cache)) {
607 $results = glob($search);
608 if ($results !== false) {
609 $files = array_merge($files, $results);
610 }
611 }
612 if (empty($files)) {
613 return false;
614 }
615 foreach ($files as $file) {
616 if (is_file($file) && strrpos($file, DS . 'empty') !== strlen($file) - 6) {
617 @unlink($file);
618 }
619 }
620 return true;
621 }
622 } elseif (is_array($params)) {
623 foreach ($params as $file) {
624 clearCache($file, $type, $ext);
625 }
626 return true;
627 }
628 return false;
629 }
630
631 /**
632 * Recursively strips slashes from all values in an array
633 *
634 * @param array $values Array of values to strip slashes
635 * @return mixed What is returned from calling stripslashes
636 * @link http://book.cakephp.org/view/1138/stripslashes_deep
637 */
638 function stripslashes_deep($values) {
639 if (is_array($values)) {
640 foreach ($values as $key => $value) {
641 $values[$key] = stripslashes_deep($value);
642 }
643 } else {
644 $values = stripslashes($values);
645 }
646 return $values;
647 }
648
649 /**
650 * Returns a translated string if one is found; Otherwise, the submitted message.
651 *
652 * @param string $singular Text to translate
653 * @param boolean $return Set to true to return translated string, or false to echo
654 * @return mixed translated string if $return is false string will be echoed
655 * @link http://book.cakephp.org/view/1121/__
656 */
657 function __($singular, $return = false) {
658 if (!$singular) {
659 return;
660 }
661 if (!class_exists('I18n')) {
662 App::import('Core', 'i18n');
663 }
664
665 if ($return === false) {
666 echo I18n::translate($singular);
667 } else {
668 return I18n::translate($singular);
669 }
670 }
671
672 /**
673 * Returns correct plural form of message identified by $singular and $plural for count $count.
674 * Some languages have more than one form for plural messages dependent on the count.
675 *
676 * @param string $singular Singular text to translate
677 * @param string $plural Plural text
678 * @param integer $count Count
679 * @param boolean $return true to return, false to echo
680 * @return mixed plural form of translated string if $return is false string will be echoed
681 */
682 function __n($singular, $plural, $count, $return = false) {
683 if (!$singular) {
684 return;
685 }
686 if (!class_exists('I18n')) {
687 App::import('Core', 'i18n');
688 }
689
690 if ($return === false) {
691 echo I18n::translate($singular, $plural, null, 6, $count);
692 } else {
693 return I18n::translate($singular, $plural, null, 6, $count);
694 }
695 }
696
697 /**
698 * Allows you to override the current domain for a single message lookup.
699 *
700 * @param string $domain Domain
701 * @param string $msg String to translate
702 * @param string $return true to return, false to echo
703 * @return translated string if $return is false string will be echoed
704 */
705 function __d($domain, $msg, $return = false) {
706 if (!$msg) {
707 return;
708 }
709 if (!class_exists('I18n')) {
710 App::import('Core', 'i18n');
711 }
712
713 if ($return === false) {
714 echo I18n::translate($msg, null, $domain);
715 } else {
716 return I18n::translate($msg, null, $domain);
717 }
718 }
719
720 /**
721 * Allows you to override the current domain for a single plural message lookup.
722 * Returns correct plural form of message identified by $singular and $plural for count $count
723 * from domain $domain.
724 *
725 * @param string $domain Domain
726 * @param string $singular Singular string to translate
727 * @param string $plural Plural
728 * @param integer $count Count
729 * @param boolean $return true to return, false to echo
730 * @return plural form of translated string if $return is false string will be echoed
731 */
732 function __dn($domain, $singular, $plural, $count, $return = false) {
733 if (!$singular) {
734 return;
735 }
736 if (!class_exists('I18n')) {
737 App::import('Core', 'i18n');
738 }
739
740 if ($return === false) {
741 echo I18n::translate($singular, $plural, $domain, 6, $count);
742 } else {
743 return I18n::translate($singular, $plural, $domain, 6, $count);
744 }
745 }
746
747 /**
748 * Allows you to override the current domain for a single message lookup.
749 * It also allows you to specify a category.
750 *
751 * The category argument allows a specific category of the locale settings to be used for fetching a message.
752 * Valid categories are: LC_CTYPE, LC_NUMERIC, LC_TIME, LC_COLLATE, LC_MONETARY, LC_MESSAGES and LC_ALL.
753 *
754 * Note that the category must be specified with a numeric value, instead of the constant name. The values are:
755 *
756 * - LC_ALL 0
757 * - LC_COLLATE 1
758 * - LC_CTYPE 2
759 * - LC_MONETARY 3
760 * - LC_NUMERIC 4
761 * - LC_TIME 5
762 * - LC_MESSAGES 6
763 *
764 * @param string $domain Domain
765 * @param string $msg Message to translate
766 * @param integer $category Category
767 * @param boolean $return true to return, false to echo
768 * @return translated string if $return is false string will be echoed
769 */
770 function __dc($domain, $msg, $category, $return = false) {
771 if (!$msg) {
772 return;
773 }
774 if (!class_exists('I18n')) {
775 App::import('Core', 'i18n');
776 }
777
778 if ($return === false) {
779 echo I18n::translate($msg, null, $domain, $category);
780 } else {
781 return I18n::translate($msg, null, $domain, $category);
782 }
783 }
784
785 /**
786 * Allows you to override the current domain for a single plural message lookup.
787 * It also allows you to specify a category.
788 * Returns correct plural form of message identified by $singular and $plural for count $count
789 * from domain $domain.
790 *
791 * The category argument allows a specific category of the locale settings to be used for fetching a message.
792 * Valid categories are: LC_CTYPE, LC_NUMERIC, LC_TIME, LC_COLLATE, LC_MONETARY, LC_MESSAGES and LC_ALL.
793 *
794 * Note that the category must be specified with a numeric value, instead of the constant name. The values are:
795 *
796 * - LC_ALL 0
797 * - LC_COLLATE 1
798 * - LC_CTYPE 2
799 * - LC_MONETARY 3
800 * - LC_NUMERIC 4
801 * - LC_TIME 5
802 * - LC_MESSAGES 6
803 *
804 * @param string $domain Domain
805 * @param string $singular Singular string to translate
806 * @param string $plural Plural
807 * @param integer $count Count
808 * @param integer $category Category
809 * @param boolean $return true to return, false to echo
810 * @return plural form of translated string if $return is false string will be echoed
811 */
812 function __dcn($domain, $singular, $plural, $count, $category, $return = false) {
813 if (!$singular) {
814 return;
815 }
816 if (!class_exists('I18n')) {
817 App::import('Core', 'i18n');
818 }
819
820 if ($return === false) {
821 echo I18n::translate($singular, $plural, $domain, $category, $count);
822 } else {
823 return I18n::translate($singular, $plural, $domain, $category, $count);
824 }
825 }
826
827 /**
828 * The category argument allows a specific category of the locale settings to be used for fetching a message.
829 * Valid categories are: LC_CTYPE, LC_NUMERIC, LC_TIME, LC_COLLATE, LC_MONETARY, LC_MESSAGES and LC_ALL.
830 *
831 * Note that the category must be specified with a numeric value, instead of the constant name. The values are:
832 *
833 * - LC_ALL 0
834 * - LC_COLLATE 1
835 * - LC_CTYPE 2
836 * - LC_MONETARY 3
837 * - LC_NUMERIC 4
838 * - LC_TIME 5
839 * - LC_MESSAGES 6
840 *
841 * @param string $msg String to translate
842 * @param integer $category Category
843 * @param string $return true to return, false to echo
844 * @return translated string if $return is false string will be echoed
845 */
846 function __c($msg, $category, $return = false) {
847 if (!$msg) {
848 return;
849 }
850 if (!class_exists('I18n')) {
851 App::import('Core', 'i18n');
852 }
853
854 if ($return === false) {
855 echo I18n::translate($msg, null, null, $category);
856 } else {
857 return I18n::translate($msg, null, null, $category);
858 }
859 }
860
861 /**
862 * Computes the difference of arrays using keys for comparison.
863 *
864 * @param array First array
865 * @param array Second array
866 * @return array Array with different keys
867 * @deprecated Will be removed in 2.0
868 */
869 if (!function_exists('array_diff_key')) {
870 function array_diff_key() {
871 $valuesDiff = array();
872
873 $argc = func_num_args();
874 if ($argc < 2) {
875 return false;
876 }
877
878 $args = func_get_args();
879 foreach ($args as $param) {
880 if (!is_array($param)) {
881 return false;
882 }
883 }
884
885 foreach ($args[0] as $valueKey => $valueData) {
886 for ($i = 1; $i < $argc; $i++) {
887 if (array_key_exists($valueKey, $args[$i])) {
888 continue 2;
889 }
890 }
891 $valuesDiff[$valueKey] = $valueData;
892 }
893 return $valuesDiff;
894 }
895 }
896
897 /**
898 * Computes the intersection of arrays using keys for comparison
899 *
900 * @param array First array
901 * @param array Second array
902 * @return array Array with interesected keys
903 * @deprecated Will be removed in 2.0
904 */
905 if (!function_exists('array_intersect_key')) {
906 function array_intersect_key($arr1, $arr2) {
907 $res = array();
908 foreach ($arr1 as $key => $value) {
909 if (array_key_exists($key, $arr2)) {
910 $res[$key] = $arr1[$key];
911 }
912 }
913 return $res;
914 }
915 }
916
917 /**
918 * Shortcut to Log::write.
919 *
920 * @param string $message Message to write to log
921 */
922 function LogError($message) {
923 if (!class_exists('CakeLog')) {
924 App::import('Core', 'CakeLog');
925 }
926 $bad = array("\n", "\r", "\t");
927 $good = ' ';
928 CakeLog::write('error', str_replace($bad, $good, $message));
929 }
930
931 /**
932 * Searches include path for files.
933 *
934 * @param string $file File to look for
935 * @return Full path to file if exists, otherwise false
936 * @link http://book.cakephp.org/view/1131/fileExistsInPath
937 */
938 function fileExistsInPath($file) {
939 $paths = explode(PATH_SEPARATOR, ini_get('include_path'));
940 foreach ($paths as $path) {
941 $fullPath = $path . DS . $file;
942
943 if (file_exists($fullPath)) {
944 return $fullPath;
945 } elseif (file_exists($file)) {
946 return $file;
947 }
948 }
949 return false;
950 }
951
952 /**
953 * Convert forward slashes to underscores and removes first and last underscores in a string
954 *
955 * @param string String to convert
956 * @return string with underscore remove from start and end of string
957 * @link http://book.cakephp.org/view/1126/convertSlash
958 */
959 function convertSlash($string) {
960 $string = trim($string, '/');
961 $string = preg_replace('/\/\//', '/', $string);
962 $string = str_replace('/', '_', $string);
963 return $string;
964 }
965
966 /**
967 * Implements http_build_query for PHP4.
968 *
969 * @param string $data Data to set in query string
970 * @param string $prefix If numeric indices, prepend this to index for elements in base array.
971 * @param string $argSep String used to separate arguments
972 * @param string $baseKey Base key
973 * @return string URL encoded query string
974 * @see http://php.net/http_build_query
975 * @deprecated Will be removed in 2.0
976 */
977 if (!function_exists('http_build_query')) {
978 function http_build_query($data, $prefix = null, $argSep = null, $baseKey = null) {
979 if (empty($argSep)) {
980 $argSep = ini_get('arg_separator.output');
981 }
982 if (is_object($data)) {
983 $data = get_object_vars($data);
984 }
985 $out = array();
986
987 foreach ((array)$data as $key => $v) {
988 if (is_numeric($key) && !empty($prefix)) {
989 $key = $prefix . $key;
990 }
991 $key = urlencode($key);
992
993 if (!empty($baseKey)) {
994 $key = $baseKey . '[' . $key . ']';
995 }
996
997 if (is_array($v) || is_object($v)) {
998 $out[] = http_build_query($v, $prefix, $argSep, $key);
999 } else {
1000 $out[] = $key . '=' . urlencode($v);
1001 }
1002 }
1003 return implode($argSep, $out);
1004 }
1005 }
1006
1007 /**
1008 * Wraps ternary operations. If $condition is a non-empty value, $val1 is returned, otherwise $val2.
1009 * Don't use for isset() conditions, or wrap your variable with @ operator:
1010 * Example:
1011 *
1012 * `ife(isset($variable), @$variable, 'default');`
1013 *
1014 * @param mixed $condition Conditional expression
1015 * @param mixed $val1 Value to return in case condition matches
1016 * @param mixed $val2 Value to return if condition doesn't match
1017 * @return mixed $val1 or $val2, depending on whether $condition evaluates to a non-empty expression.
1018 * @link http://book.cakephp.org/view/1133/ife
1019 * @deprecated Will be removed in 2.0
1020 */
1021 function ife($condition, $val1 = null, $val2 = null) {
1022 if (!empty($condition)) {
1023 return $val1;
1024 }
1025 return $val2;
1026 }