Skip to content

Commit

Permalink
Adding example docs for Kohana core.
Browse files Browse the repository at this point in the history
  • Loading branch information
zombor committed Feb 26, 2010
1 parent c695174 commit 4a72dbb
Show file tree
Hide file tree
Showing 2 changed files with 115 additions and 31 deletions.
4 changes: 2 additions & 2 deletions application/Bootstrap.php
View file
Expand Up @@ -55,5 +55,5 @@ final class Kohana_Config extends Kohana_Config_Core {}
// End system_initialization // End system_initialization
Benchmark::stop(SYSTEM_BENCHMARK.'_system_initialization'); Benchmark::stop(SYSTEM_BENCHMARK.'_system_initialization');


// Make the magic happen! // Make the magic happen!!
Event::run('system.execute'); Event::run('system.execute');
142 changes: 113 additions & 29 deletions system/core/Kohana.php
View file
Expand Up @@ -18,22 +18,52 @@ abstract class Kohana_Core {
const CHARSET = 'UTF-8'; const CHARSET = 'UTF-8';
const LOCALE = 'en_US'; const LOCALE = 'en_US';


// The singleton instance of the controller /**
* The singleton instance of the controller
*
* @var object
* @static
*/
public static $instance; public static $instance;


// Output buffering level /**
* Output buffering level
*
* @var int
* @static
*/
protected static $buffer_level; protected static $buffer_level;


// The final output that will displayed by Kohana /**
* The final output that will displayed by Kohana
*
* @var string
* @static
*/
public static $output = ''; public static $output = '';


// The current locale /**
* The current locale
*
* @var string
* @static
*/
public static $locale; public static $locale;


// Include paths /**
* Include paths
*
* @var array
* @static
*/
protected static $include_paths; protected static $include_paths;


// Cache lifetime /**
* Cache lifetime
*
* @var int
* @static
*/
protected static $cache_lifetime; protected static $cache_lifetime;


// Internal caches and write status // Internal caches and write status
Expand All @@ -43,7 +73,12 @@ abstract class Kohana_Core {
protected static $internal_cache_key; protected static $internal_cache_key;
protected static $internal_cache_encrypt; protected static $internal_cache_encrypt;


// Server API that PHP is using. Allows testing of different APIs. /**
* Server API that PHP is using. Allows testing of different APIs.
*
* @var string
* @static
*/
public static $server_api = PHP_SAPI; public static $server_api = PHP_SAPI;


/** /**
Expand Down Expand Up @@ -94,7 +129,7 @@ public static function setup()
if (Kohana::$cache_lifetime = Kohana::config('core.internal_cache')) if (Kohana::$cache_lifetime = Kohana::config('core.internal_cache'))
{ {
// Are we using encryption for caches? // Are we using encryption for caches?
Kohana::$internal_cache_encrypt = Kohana::config('core.internal_cache_encrypt'); Kohana::$internal_cache_encrypt = Kohana::config('core.internal_cache_encrypt');


if(Kohana::$internal_cache_encrypt===TRUE) if(Kohana::$internal_cache_encrypt===TRUE)
{ {
Expand Down Expand Up @@ -411,28 +446,27 @@ public static function cache($name, $lifetime)
if ((time() - filemtime($path)) < $lifetime) if ((time() - filemtime($path)) < $lifetime)
{ {
// Cache is valid! Now, do we need to decrypt it? // Cache is valid! Now, do we need to decrypt it?
if(Kohana::$internal_cache_encrypt===TRUE) if(Kohana::$internal_cache_encrypt === TRUE)
{ {
$data = file_get_contents($path); $data = file_get_contents($path);

$iv_size = mcrypt_get_iv_size(MCRYPT_RIJNDAEL_256, MCRYPT_MODE_ECB);
$iv_size = mcrypt_get_iv_size(MCRYPT_RIJNDAEL_256, MCRYPT_MODE_ECB); $iv = mcrypt_create_iv($iv_size, MCRYPT_RAND);
$iv = mcrypt_create_iv($iv_size, MCRYPT_RAND);


$decrypted_text = mcrypt_decrypt(MCRYPT_RIJNDAEL_256, Kohana::$internal_cache_key, $data, MCRYPT_MODE_ECB, $iv); $decrypted_text = mcrypt_decrypt(MCRYPT_RIJNDAEL_256, Kohana::$internal_cache_key, $data, MCRYPT_MODE_ECB, $iv);


$cache = unserialize($decrypted_text); $cache = unserialize($decrypted_text);


// If the key changed, delete the cache file // If the key changed, delete the cache file
if(!$cache) if( ! $cache)
{
unlink($path); unlink($path);
}


// If cache is false (as above) return NULL, otherwise, return the cache // If cache is false (as above) return NULL, otherwise, return the cache
return ($cache ? $cache : NULL); return ($cache ? $cache : NULL);
} }
else else
{
return unserialize(file_get_contents($path)); return unserialize(file_get_contents($path));
}
} }
else else
{ {
Expand Down Expand Up @@ -470,14 +504,14 @@ public static function cache_save($name, $data, $lifetime)
else else
{ {
// Using encryption? Encrypt the data when we write it // Using encryption? Encrypt the data when we write it
if(Kohana::$internal_cache_encrypt===TRUE) if(Kohana::$internal_cache_encrypt === TRUE)
{ {
// Encrypt and write data to cache file // Encrypt and write data to cache file
$iv_size = mcrypt_get_iv_size(MCRYPT_RIJNDAEL_256, MCRYPT_MODE_ECB); $iv_size = mcrypt_get_iv_size(MCRYPT_RIJNDAEL_256, MCRYPT_MODE_ECB);
$iv = mcrypt_create_iv($iv_size, MCRYPT_RAND); $iv = mcrypt_create_iv($iv_size, MCRYPT_RAND);


// Serialize and encrypt! // Serialize and encrypt!
$encrypted_text = mcrypt_encrypt(MCRYPT_RIJNDAEL_256, Kohana::$internal_cache_key, serialize($data), MCRYPT_MODE_ECB, $iv); $encrypted_text = mcrypt_encrypt(MCRYPT_RIJNDAEL_256, Kohana::$internal_cache_key, serialize($data), MCRYPT_MODE_ECB, $iv);


return (bool) file_put_contents($path, $encrypted_text); return (bool) file_put_contents($path, $encrypted_text);
} }
Expand Down Expand Up @@ -537,7 +571,7 @@ public static function close_buffers($flush = TRUE)
} }


/** /**
* Triggers the shutdown of Kohana by closing the output buffer, runs the system.display event. * Triggers the shutdown of Kohana by closing the output buffer, runs the system.shutdown and system.display event.
* *
* @return void * @return void
*/ */
Expand Down Expand Up @@ -643,7 +677,16 @@ public static function render($output)
} }


/** /**
* Provides class auto-loading. * Auto-loads a file in the cascading file system.
* Mainly called manually for loading driver files.
* Used by spl_autoload_register for native class autoloading
*
* ##### Example
*
* echo var_dump(Kohana::auto_load('Log_File_Driver');
*
* // Output:
* (integer) true
* *
* @throws Kohana_Exception * @throws Kohana_Exception
* @param string name of class * @param string name of class
Expand Down Expand Up @@ -736,9 +779,24 @@ public static function auto_load($class)


/** /**
* Find a resource file in a given directory. Files will be located according * Find a resource file in a given directory. Files will be located according
* to the order of the include paths. Configuration and i18n files will be * to the order of the include paths. Configuration, messages and i18n files will be
* returned in reverse order. * returned in reverse order.
* *
* Returns a full path name to the file, or an array of path names for config, messages and i18n.
*
* ##### Example
*
* // Extending a controller in a sub-directory (controllers/admin/admin_website.php)
* <?php
* include Kohana::find_file('controllers', 'admin/admin_website');
* class Home_Controller extends Admin_Website_Controller {}
*
* // Finding a list of all configuration files
* echo Kohana::debug(Kohana::find_file('config', 'testing'));
*
* // Output:
* array('/full/path/to/testing.php', '/different/full/path/to/testing.php')
*
* @throws Kohana_Exception if file is required and not found * @throws Kohana_Exception if file is required and not found
* @param string directory to search in * @param string directory to search in
* @param string filename to look for (without extension) * @param string filename to look for (without extension)
Expand Down Expand Up @@ -891,9 +949,18 @@ public static function list_files($directory, $recursive = FALSE, $ext = EXT, $p




/** /**
* Fetch a message item. * Fetch a message item. You can specify a folder name by using a / seperator
* Uses the standard dot seperated key syntax to access the data in the file.
*
* #### Example
* *
* @param string language key to fetch * // Fetches a message item from a file in messages/testing/my_test.php
* echo Kohana::message('testing/my_test.key1');
*
* //Output:
* 'Whatever is in key1'
*
* @param string message key to fetch
* @param array additional information to insert into the line * @param array additional information to insert into the line
* @return string i18n language string, or the requested key if the i18n item is not found * @return string i18n language string, or the requested key if the i18n item is not found
*/ */
Expand Down Expand Up @@ -947,6 +1014,14 @@ public static function message($key, $args = array())
/** /**
* Returns the value of a key, defined by a 'dot-noted' string, from an array. * Returns the value of a key, defined by a 'dot-noted' string, from an array.
* *
* #### Exampls
*
* $source = array('key1' => array('key2' => 'foobar'))
* echo Kohana::key_string($source, 'key1.key2');
*
* //Output:
* 'foobar'
*
* @param array array to search * @param array array to search
* @param string dot-noted string: foo.bar.baz * @param string dot-noted string: foo.bar.baz
* @return string if the key is found * @return string if the key is found
Expand Down Expand Up @@ -992,6 +1067,15 @@ public static function key_string($array, $keys)
/** /**
* Sets values in an array by using a 'dot-noted' string. * Sets values in an array by using a 'dot-noted' string.
* *
* #### Exampls
*
* $source = array('key1' => array('key2' => 'foobar'))
* Kohana::key_string_set($source, 'key1.key2', 'bar');
* echo Kohana::key_string($source, 'key1.key2');
*
* //Output:
* 'bar'
*
* @param array array to set keys in (reference) * @param array array to set keys in (reference)
* @param string dot-noted string: foo.bar.baz * @param string dot-noted string: foo.bar.baz
* @return mixed fill value for the key * @return mixed fill value for the key
Expand Down Expand Up @@ -1087,7 +1171,7 @@ public static function debug()
} }


/** /**
* Saves the internal caches: configuration, include paths, etc. * Saves the internal caches: configuration, include paths, etc. Used internally
* *
* @return boolean * @return boolean
*/ */
Expand Down Expand Up @@ -1117,4 +1201,4 @@ public static function internal_cache_save()
return $written; return $written;
} }


} // End Kohana } // End Kohana

0 comments on commit 4a72dbb

Please sign in to comment.