What is Kohana?

Kohana is a PHP5 framework that uses the Model View Controller architectural pattern. It aims to  be secure, lightweight, and easy to use. 

1. Strict PHP5 OOP. Offers many benefits: visibility protection, automatic class loading,  overloading, interfaces, abstracts, singletons, etc. 2. Community, not company, driven. Kohana is driven by community discussion, ideas, and  code. Kohana developers are from all around the world, each with their own talents. This  allows a rapid and flexible development cycle that can respond to new bugs and requests  within hours. 3. GET, POST, COOKIE, and SESSION arrays all work as expected. Kohana does not  limit your access to global data, but provides XSS filtering and sanity checking of all global  data. 4. Cascading resources, modules, and inheritance. Controllers, models, libraries, helpers,  and views can be loaded from any location within your system, application, or module paths.  Configuration options are inherited and can by dynamically overwritten by each application. 5. No namespace conflicts. Class suffixes and prefixes are used to prevent namespace  conflicts. 6. Auto­loading of classes. All classes in Kohana are automatically loaded by the framework,  and never have to be manually included. 7. API consistency. Classes that require access to different protocols use “drivers” to keep the  the visible API completely consistent, even when the back­end changes. 8. Powerful event handler. Kohana events can transparently be: added, replaced, or even  removed completely.

To be secure means to use best practices regarding security, at all times: 
• •

Kohana comes with built­in XSS protection, and can also use HTMLPurfier as an XSS filter. All data inserted into the database is escaped using database­specific functions, like  mysql_real_escape_string, to protect against SQL injection attacks. magic quotes are  disabled by Kohana. All POST, GET, and COOKIE data is sanitized to prevent malicious behavior. Kohana uses convention over configuration as much as possible. Sane defaults and highly optimized environment detection routines allow Kohana to run in  almost any PHP5 environment.   Loose coupling   is used to always load the minimum number of files, reducing resource  usage. A clean API and using native functions whenever possible makes Kohana one of the fastest  PHP5 frameworks available.

To be lightweight means to provide the highest amount of flexibility in the most efficient manner: 
• • • •

To be easy to use means to provide understandable API and usage documentation, based on 

community feedback. 

Kohana uses the Model View Controller architectural pattern. This keeps application logic separate  from the presentation and allows for cleaner and easier to work with code.  In Kohana this means: 
• • •

A Model represents a data structure, usually this is a table in a database. A View contains presentation code such as HTML, CSS and JavaScript. A Controller contains the page logic to tie everything together and generate the page the  user sees.

• • • • • • •

Highly secure Extremely lightweight Short learning curve Uses the MVC pattern 100% UTF­8 compatible Loosely coupled architecture Extremely easy to extend

• • • • •

Strict PHP5 OOP Simple database abstraction using SQL helpers Multiple session drivers (native, database, and cookie) Powerful event handler allows small modifications dynamically Originally based on CodeIgniter

Most of the Kohana source code is written by the Kohana Team. There are a few notable credits,  however. 

Kohana was originally a fork of CodeIgniter (CI), which is an open­source product of EllisLab.  There are still many similarities between CI and Kohana, particularly in naming conventions and  filesystem design, but all of the code is either new or completely rewritten.  CodeIgniter is © 2006 EllisLab, Inc. 

All of the Kohana UTF­8 functions are ported from the phputf8 project. 

phputf8 is © 2005 Harry Fuecks. 

The default XSS filter used by Kohana was originally created by Christian Stocker for the popoon  framework. The original file is called externalinput.php.  popoon is © 2001­2006 Bitflux GmbH 

HTML Purifier
The alternative XSS filter used by Kohana is HTML Purifier. This is an optional download.  HTML Purifier is © 2006­2007 Edward Z. Yang 

The recommended way to send emails in Kohana is using SwiftMailer. This is an optional  download.  SwiftMailer is © Chris Corbyn 

PHP Markdown
Markdown is a simple text­to­HTML formatting tool. Kohana includes PHP Markdown as an  optional download.  PHP Markdown is © 2006 Michel Fortin  Those who cannot remember the past are condemned to repeat it. George Santayana 

The history of Kohana is told backwards, because we are looking forward. 

Kohana 2.1.x
• •

February 7, 2008 ­ Release of Kohana 2.1.1 February 5, 2008 ­ Release of Kohana 2.1

Kohana 2.0
November 2007  Kohana version 2.0 is released. PHP5 based. New fully OOP framework, no legacy code, includes  modules, built on the cascading resources concept. 

The Good Old Days
September ­ October 2007 

We get a BDFL.0 June ­ July 2007 Kohana is re­released as version 1.0.  Basic Requirements Kohana will run in almost any environment with minimal configuration. An HTTP server. Our Project leader goes walkabout.  Kohana June 2007. forum.0+.   PCRE   must be compiled with –enable-utf8 and –enable-unicode-properties for UTF­8 functions to work properly. There are a few minimum  server requirements:  1. with CI. .  In The Beginning BlueFlame. new life. with addition drivers planned. Apache 2. without documentation. new goals.  May 31 2007 BlueFlame announced  Before The Beginning Up until May 2007  The founding members of Kohana are from the Codeigniter community.  Reactions and responses. not much happens.3+. you will need a database server. Almost total rewrite undertaken by  developers. There are  database drivers for MySQL and PostgreSQL. decision to go PHP5 only.  Kohana 1. Server with Unicode support 2.  Our initial happiness. The fork splits.3 3. (All three of them)  The Worst of Times August 2007. and later unhappiness.  Lots of ideas and discussions on the way forward.  A new Name. PHP version >= 5. a community fork of CodeIgniter is released. Trac. lighttpd. and  MS IIS Optionally.1. Kohana is known to work with: Apache 1. if you wish to use a database with Kohana.  Required Extensions 1.

 or ask for assistance in the  community forums. please read  the Troubleshooting page of the user guide. If you're new to  Kohana you should first read all articles in the user guide under the 'General' section.php to  application/config/database. Make the application/logs directory writeable. Edit the global configuration file application/config/config. 3. 7. Unzip the package you downloaded.php in the directory that you  would like Kohana accessible from.php for Apache webserver   Additional Configuration You can provide your installation with additional configuration by copying files from the system/ config directory to the application/config directory. Chmod to 666.  •   Tutorial ­ Remove index.2.   iconv   is required for UTF­8 transliteration. 3.php and edit the database connection details. Make the application/cache directory writeable if you use the cache library. For example if you want to  configure a database connection. visit the Kohana Wiki. 1) SPL Recommended Extensions 1. 4. placing index.php 5. Chmod  to 666. note that the  mbstring extension must not be overloading PHP's native string functions! Install Kohana Kohana is installed in several easy steps:  1.  .   mcrypt   is required for encryption. 2. Upload the Kohana files to your webserver. However.   Download   a copy of Kohana.     is required for several core libraries.  Experiencing Problems? If you were not able to view the Kohana Welcome page on your server after installing. This should create a kohana directory.php in each URL this is possible.php from URL's If you want really clean URL's and therefore remove the index. 4. Test your installation by opening the URL you set as the base_url in your favorite  browser If you see the Welcome page. your Kohana installation is complete!  Removing index.   mbstring   will dramatically speed up Kohana's UTF­8 functions. 6.  After installation After installation you're ready to build your first web application with Kohana. you can copy over system/config/database.

php in the webroot. image and javascript files. Open index.0 to 2. or your webserver is  compromised. B etc.[moveTo: Troubleshooting] The Kohana Team tries to make sure that Kohana is as free from bugs as  possible.2     2.1   Basic Instructions These instructions assume that you have not edited your system folder in any way. If you have found a bug. also makes it more easily accessible by  multiple Kohana applications. For your application's index. simply follow these steps. and all other files outside  of it. Simply refer to the same system in the $kohana_system in application  A.1 to 2. You can now point all of your applications to this one system folder for easy upgrades. change the $kohana_system variable to the  relative or absolute path of where you put the system folder. This  allows for easy upgrades.  It is considered a good security practice to move application. So you can use the same system for multiple applications. to prevent potential public access. Put the system folder somewhere on your server.  Upgrading • •   2.php file.php file in an editor 3. 3. If you have then  . Delete the system folder in your current application. Moving system and application directory out of webroot 'webroot' is defined as the top level directory to which a webserver will allow public access.  In a few steps this can be accomplished  1. Static content.  For Experienced Users To use a multi­site Kohana install.  1. such as stylesheet. 5.php in 2. are typically placed within  webroot. preferably outside of your webserver's  document root. Set the variable $kohana_system to the system directory you're using Note that moving the system directory out of webroot. should PHP be disabled. system and modules out of  the webroot.php file) 4. Kohana enables you to place the index. please report it. This  makes your life a whole lot easier when you have 10+ kohana sites on your server. 2.   Download   a copy of Kohana. 4. A  correctly configured server will not allow public access to files or directories above webroot in the  directory tree. Set the variable $kohana_application to the application directory you're using (must  contain config/config. Move the directories out of the webroot but leave index.

Delete the contents of your system folder. You can then simply revert to a previous version if there are  any issues. 2.you will need to apply your changes again after upgrading if you use this method.  Then continue with the changes in other files (if needed) stated below.  Configuration • • • Changes to config/config. and update any values  in them to reflect the changes you made in your original files. Call the backups file_name_version.php: • display_errors has been added. and $example = new Example_Model().  Install the new 'index.2 Upgrading Configuration • preload in config.php has been removed.php' system  file.php' files.php' and 'application/config. 2. 3. The quickest way to upgrade is make a backup of your 'index.of. The Pagination create_links() method has been renamed to render() 2.1 to 2. index.1 Upgrading There are a number of changes to the main 'index.php' file.php' file and the 'config. Follow the instructions from the relevant pages for your upgrade in the list above.php: • name should only contain alphanumeric characters with at least one letter.  1.  You could consider naming your system folder with the version number: 'system_2.1. Libraries and models must now be created using the  following syntax: $example = new Example(). You must now manually instance the  libraries you want to use.php_2. Changes to config/session. The '$kohana_system' should  point to the new versioned system folder.php' and your application  'config.1' rather  than copying the new one over the top. Libraries • • Loader library has been removed. • autoload has been renamed to preload.Kohana. e.  This method is more reliable than making incremental changes to existing files based on a list ­ and  you can simple swap back to the old version if things go wrong.0.php: .0 to 2. Replace it with the system folder from the version you wish to upgrade to. • output_compression has been added.g. • include_paths has been renamed to modules. Changes to config/database. • gc_probability has been added.

 Kohana makes this one easy: • Throw variables at Kohana::debug(). • Turn on the Profiler to see global variables and the executed queries. Database • • join($table.php from the URL in html helpers now defaults to false. '=trim'). $query→num_rows() has been removed. $type). If your using MySQL turning on query logging will help you understand what queries  Kohana is running on your database. Isolate the problem. sha1 Validation rules must now be preceded by = (e. Use count(query) instead. Use $this→pagination→sql_offset instead of  $this→pagination→sql_offset(). Troubleshooting Programming is art? So is debugging! A few tips to keep your code bug free and how Kohana can  help.net Can't figure things out on your own?  • • Deploying Kohana to Production: Here are a few items you should keep in mind before deploying your Kohana application to a  .  • • • • See what you're doing. $cond. Eliminate possible causes of the bug. md5.g. The parameter to add index. Drop in at #kohana on irc. it  needs to be specified as TRUE if you require it. Post your problem in the Kohana Forum (after having searched first. $key. Validation • • trim. Deprecated stuff • • • Use http_build_query() instead of html::query_string(). of course). $type) has changed to join($table.• show_errors has been removed. Check the Kohana log files.freenode. $value. Use $this→pagination→sql_limit instead of  $this→pagination→sql_limit(). Helpers • • Helpers must be renamed from helper_name to helper_name_Core if they need to  be extended. Validation rule 'regex' must now specify the delimiter.

php ­ set or verify $config['driver'].  1. Move Kohana core directories outside of the document root If your host does not allow this structure.php application/controllers/welcome. Here  are a few that should be removed:  • • • • application/controllers/examples.php ­ change the default $config['key'] modules/auth/config/auth.  $config['name'].. Since  most web hosts give you access to at least one level above the web server document root.php ­ change the default salt offsets in  $config['salt_pattern'] (if you use the Auth module) system/config/cookie. but can slow down your application. You can still check error messages in your log file. to disable error messages from being  displayed. it is considered a good security  practice to place as few files as possible in your public web server document root directory. Modify your configuration files Kohana provides various default configuration files in the system/config directory. set $config['display_errors'] = FALSE.php ­ configure your custom database connections (if  required) system/config/log.php ­ set your $config['domain'] system/config/session. You should always try to create custom versions of the following files:  • • • • • You should also consider creating custom versions of the following files:  • • 3.php (if enabled in  $config['modules']) 2.php to be sure. Check your settings in  config/log.htaccess file to protect the core directories. $config['expiration'] system/config/database. use an .  Modify your application/config.php:  • • change $config['site_domain'] from your development setting to the production  domain. this should  .  Although this is an optional step and not required by Kohana. you have the option to either utilize the default  configuration file versions or override these files with your own custom versions by creating a copy  in the application/config directory.php (if it is not used) modules/auth/controllers/auth.php ­ set your $config['_default'] to your default  controller system/config/encryption.  system/config/routes. Higher threshold levels will log less  critical notices and information. Remove the various demo and example controllers Kohana bundles a various demos and example controllers to help users when getting started. Since  Kohana utilizes a cascading file system. This sets  your log threshold to a suitable level for production.php (if enabled in $config['modules']) modules/forge/controllers/forge_demo.production environment. $config['encryption'].php ­ set your $config['threshold'] = 1.

php From URLs Removing the index.example.htaccess document to enable URL rewriting: # Turn on URL rewriting RewriteEngine On # Put your installation directory here: # If your URL is www. 2.  Moving your core Kohana directories also gives you the ability to utilize one central Kohana  codebase on your server that can be shared by multiple websites./application'. do the following:  1. Note: This example assumes one­level above public_html. each has its own pros and cons. Note: This tutorial only focuses on Apache. First. You could also create a set of  common modules used across all of your web sites.php from your website URLs look better. ..com/. use / # If your URL is www./modules'.com/kohana/. you can use relative or  absolute directories when specifying directory locations.application +.system +. The same goes for this particular task and.php file:  • $kohana_application = './system'. move your Kohana system. Let's look at a few to help you decide which is best for your  situation. and modules directories at least one level  above your document root directory (typically public_html or www). application..example.modules +. you will need to create a . but can be adapted for other HTTP servers.not be a problem. • $kohana_modules = '. modify the following lines in your index.  To accomplish this in Kohana.  Your final directory structure will look similar to this:  yourdomain_root_directory +.php | ..public_html (web server document root) | . and can help with SEO.htaccess We should start out by reminding you that in programming and computing there is always more than  one way to accomplish the same job.. as is always the  case. however.htaccess Removing index. . use /kohana/ RewriteBase / # Do not enable rewriting for files or directories that exist RewriteCond %{REQUEST_FILENAME} !-f RewriteCond %{REQUEST_FILENAME} !-d # For reuests that are not actual files or directories. • $kohana_system = '.index.

com/kohana/.  So someone could enter. use / RewriteBase /kohana/ # Protect application and system files from being viewed RewriteCond $1 ^(application|system) # Rewrite to index. or any other files you do not want accessed.php/$1 [PT. this approach does not protect your more sensitive an unintended PHP files against access. use /kohana/ # If your URL is www.*)$ index.example.L]   controllers/access_denied. Ideally.php­less Kohana URLs are).*)$ index.com/application/views/ and get a list of all your view files. but you get consistency in your error  pages site wide.example. However.php/access_denied/.  Read "Moving system and application directory out of webroot" at  http://doc. Any files and directories that exist under  your document root will be served. If you find that you do not have proper access on your server to change your  file system setup.L] # Do not enable rewriting for other files that exist RewriteCond %{REQUEST_FILENAME} !-f RewriteCond %{REQUEST_FILENAME} !-d # Rewrite to index.L]   This example is quite dynamic in that you can add files and directories to your document root as you  desire and you'll never need to modify the rewrite rules. If a request is made for a non­existant file or directory (which is  really what the index.com/. Finally. But some servers  are setup such that your access to the server is restricted to document root and you have no choice.htaccess Let's protect against direct access to these files: # Turn on URL rewriting RewriteEngine On # Put your installation directory here: # If your URL is www.php/$1 [PT. Let's create one now: . If it can be routed by Kohana. you should never have your system or application  directories.php Because we are rewriting the URL to index. the page is served.kohanaphp.php/URL RewriteRule ^(.# Rewrite to index.php transparently. http://www.example. . under your document root. continue on in this tutorial for other options.*)$ index.php/access_denied/$1 [PT.php/access_denied/URL RewriteRule ^(.com/installation to learn how to move system/ and application/ out of  your document root. a Kohana error page (ex:  404) is displayed. the request is rewritten to be routed through  index. if it wasn't a  request for an existing file or directory and could not be routed by Kohana. we will need a  Controller to handle these URLs.php/URL RewriteRule ^(. So you not only have dynamic rewrite rules. for example.

 However. } }   Now. cannot be accessed directly. ''.index.$path. $this->uri->string()).php our of our URL.robots.example. use /kohana/ # If your URL is www. working solution that keeps index.html::anchor(''.'</tt>. and rewriting everything else. use / RewriteBase /kohana/ # Protect application and system files from being viewed RewriteCond $1 ^(application|system) # Rewrite to index.txt . . 'You may return to the '.php/access_denied/$1 [PT.com/kohana/.L] # # # # # Allow these directories and files to be displayed directly: . we can still make this more secure.htaccess # Turn on URL rewriting RewriteEngine On # Put your installation directory here: # If your URL is www. '. <tt>'. 'home page'). Now we have a good.*)$ index. // Display an error page throw new Kohana_User_Exception ( 'Direct Access Denied'. and prevents  access to protected files.' ).' at any time.<?php class Access_denied_Controller extends Controller { function _remap() { // Attempted access path.php/access_denied/URL RewriteRule ^(.example.  an error page will be displayed.Any file inside of the images/.ico .php (DO NOT FORGET THIS!) . when a user attempts to access any file or directory inside of application/ or system/. by only allowing specific  files to be displayed. with "access_denied/" removed $path = preg_replace('|^access_denied/|'. js/. or css/ directories . 'The file or directory you are attempting to access.favicon.com/.

function __construct() instead of function Page() 2.*)$ .  specific needs are. if your old controller was  Page. Note: Don't feel like you have to use the most secure solution. or any of these solutions.x migrating to Kohana 2. Review the User Guide: Configuration page Logging The logs directory needs to be writable by the webserver or you can turn logging off.x (“Blueflame”) or CodeIgniter 1. If you want more information about mod_rewrite.  Installation Starting with a fresh Kohana install. the main configuration files for your  application 3.php|robots\. and copy your existing  application folder to the same location. Migration Users of Kohana version 1. Copy the application/config directory from Kohana 2.[PT. parent::__construct() instead of parent::Controller() .php.*)$ index. check the Apache  Documentation. You can change the allowed files and directories to whatever your own.RewriteCond $1 ^(index\. Choose the  .  Make your Controller contructors PHP5 if needed:  1.  Configuration Remove your old config folder.txt|favicon\.L]   Now we are really done. Edit application/config/config. For example.php/$1 [PT.x to  application/config 2.L] # Rewrite all other URLs to index.ico|images|js| css) # No rewriting RewriteRule ^(.php/URL RewriteRule ^(. Each of the examples here will work better for some  situations than others.htaccess file that best suits your needs.  Class Names Rename all your controllers to {NAME}_Controller. make it Page_Controller.0 can follow  these steps to migrate their application.  1. delete application folder.

 be sure to call parent::__construct() Libraries Base Controllers If you have a base controller for your application (in the libraries folder) your will need to:  1. new  View()) without including the class first.  Other Class names need to have _Core appended to them and be capitalized.  $this→load→ is deprecated. Change all your model loads to just model name: $this→load→model('page') 3. Use the PHP5 syntax for the constructor in your base controller URI The CI function uri_to_assoc($offset) becomes segment_array($offset.  References to those classes need to be capitalized to match the library calls (without the core). prepend public static in front of all the function names Calls are now made via foo::function().  Helpers Change all your helper calls to the new syntax: helper::function()  1. Example: html::anchor() instead of anchor() Example: url::base instead of base_url() Example: form::open() instead of form_open() The default helpers are available in system/helpers If you have custom helpers they need to be changed. make it Page_Model 2.3. Kohana uses auto loading so you can instantiate an object (e. 2.php:  1. Change references to MY_Controller in your controllers to Controller 3. 3. For example. If you add a __construct() function.g. wrap all the functions in the file in class foo { } 2. $associative) with $associative set to TRUE. The file names should also  have the same caps as the class name (without the core). Assuming your helper file is foo. if your old model was PageModel.  This is not valid for Kohana so if you have copied this line for your own helpers etc you need to  .  Note also that the CodeIgniter helpers and libraries typically have this line at the top of the script:  <?php if (!defined('BASEPATH')) exit('No direct script access allowed'). 4. Note: This also applies to Models! Rename all your models to {NAME}_Model  1. Change the MY_Controller extends Controller to Controller extends Controller_Core 2.

 and easier “view­in­view” handling. in kohana only the db library is loaded on a model.  Models There is a important note. // Displays the view $view->render(TRUE).  Views Views are now treated somewhat differently. If you need more libraries you  have two options:  // Create a new object with the library $uri = new Uri. array('title' => 'User Details')).This example is the "template" view from above --> <h1><?php echo $title ?> for <?php echo $username ?></h1> <div id="visits"><?php echo $visits ?></div> In the above example. .  // Load the view and set the $title variable $view = new View('template'. array('user_id' => 3)). // Renders the view to a string $str_view = $view->render(). $value = $uri->segment(3).'). a View object. This is very useful in  Views:  <!-.change it to the following to work in Kohana:  <?php defined('SYSPATH') or die('No direct access allowed.  This allows much greater flexibility. $visits. // Can not use $this->uri->segment(3) as used in CI // Use the instance of your controller $value = Kohana::instance()->uri->segment(3). // Sets the $username variable in the view $view->username = 'JohnDoe'. in CI you can use the $this in the model and you have the same libraries  as your controller. This syntax is encouraged  because it is very short and readable when mixed with HTML. Note: Using print or echo on a View will cause it to render into a string. // Sets the $visits variable to another view $view->visits = new View('user/visits'. Instead of being “flat” files. views are now objects. was used as a string.

Reference .

General .

libraries . Views as used as data­to­HTML rendering layers. +. making a URI  into a URL.. and handle how a URI is converted into an  application.controllers | +. such as a database row in a specific  table.models | +.helpers | +. or an HTML form. which can be used to “hook into” Kohana during very early processes In addition.cache | +.Kohana Filesystem File types Strictly from Kohana's interpretation of MVC­Lh (MVC ­ Libraries helpers):  • • • • • Models are used to represent a specific piece of data. Helpers are used for simple. or validating an email address.logs | +.libraries | +..system | +. Input) or some other data structure..  Once you have unpacked it you will see this (note: the contents of your modules directory will vary  according to the options you select on the download page):  root +. Session...application | +.media | +. Validation. Libraries are used for as a tool that operate on some form of pre­existing data.g. repetitive tasks.controllers | +.key) Language (i18n) files. Configuration files.libraries | +. simple static arrays that are accessed by convention (file.controllers | +.config | +. either in the  form of an array (e. Controllers are used as the “entry point”.config | +. such as ORM  (database table) or Archive (filesystem).key) Hooks. Kohana adds the following supporting structure:  • • • The Basics First of all you should get acquainted with the directory structure of a default Kohana installation.core | +.views | +.helpers | +.i18n | +.config | +. access the same as config (file..hooks | +. such as creating HTML tags.helpers | +.modules | +.

  Exceptions There are 2 main exceptions in the filesystem:  config. This is because Kohana has a cascading filesystem.index. which goes as follows:  application > modules > system Files that are in directories higher up the include path order take precedence over files of the same  name lower down the order. If you then delete that file from  application/views. It will not be read if it  exists within a module or the system directory.| +. if you have a view file called layout.  Modular The Kohana filesystem is also modular.  The application and system directories can be thought of as hardcoded modules. the one in system/views will be returned when searched for. The reason for this is that it contains the  modules setting which must be read before all others so the framework knows where the rest of  the config files are along the include path.php You will notice that a lot of the directories in the application and system directories are  exactly the same.  Cascading The Kohana filesystem is made up of a single directory structure that is mirrored in all directories  along what we call the include path. This means that custom directories can be inserted along  the include path to be scanned when a file is searched for. the one in application will be returned when layout.  .  For example.  The core files as part of system/core are also not cascading.vendor | +.models | +.  See Modules on how to set these up. They are hardcoded into the  Kohana startup procedures and will not be overridden by files higher up the include path. Entries in files greater up the order still override those of which are in  files lower down.  Configuration and i18n Files These files are special as their content entries are merged when multiple files of the same name are  found along the include path.views | +.  See the cascading filesystem in action. They are  treated no differently from regular modules apart from the exceptions listed below.php MUST reside in the application/config directory.php is  searched for as it is highest in the include path order.php in the application/views and  system/views directories.

  i18n Language files read by Kohana::lang() are stored here. See Internationalization.  config All configuration files that are read by the Config class must be stored here.  controllers All controllers to be directed to by the router must go in here. It  should also be where you store any custom cached data from your application.  models See Models. See  Libraries for more information. the Cache library uses this directory to store its caches when using the File driver.  vendor 3rd party libraries and scripts that are not integrated into Kohana should be stored here.  .See Configuration and Internationalization for more information on this.  views See Views.  Built in directories cache By default. They are split up into sub­directories using  the country code and locale as the name.  hooks See Hooks.  libraries See Libraries.  logs By default. log files generated by the Log class are stored in the application/logs directory.  helpers See Helpers.

php Sets the cache driver. usually HTTP .domain and installation directory .  application > modules > system Meaning that configuration files in the application directory take precedence over those in modules  take precedence over those in the system directory.g. cache lifetime and garbage collection. can be removed with URL .protocol used to access the site. Keys of this array are the actual configuration  items e.enable or disable setting of Config items .Configuration Information on retrieving and setting configuration items can be found on the config page.libraries and models to be loaded with the controller Configuration files cache. See for more information the Cache  library.render the statistics information in the final page .filename prefix for library extensions .enable or disable XSS attack filtering on all user . File structure of config files The file structure of config files follows Kohana's file structure. The one exception is config.name of the front controller.  .php Config.  /* * Options: * site_domain * site_protocol * index_page rewriting * url_suffix * allow_config_set * global_xss_filtering input * render_stats output * extension_prefix * modules * autoload */ .  Example  $config['site_domain'] = 'localhost/'.extra Kohana resource paths.  Structure of config files Configuration files contain an array named $config.  config.an extension that will be added to all generated URLs .php which is  hardcoded into the application/config directory and cannot be moved elsewhere.find_file> .php is hardcoded into Kohana. see <Kohana. meaning it has to be in the application/config directory.

 See for more information the Cookie helper. See the Log page.php Sets pagination settings.php Sets payment settings.php Sets the routes Kohana should use.php Sets the locale and timezone of an application.php Sets session settings including the session driver. See the database  configuration page.php Sets the available mime­types.  upload.php Enable or disable hooks. See Internationalization page. See User Agent  .php Sets the information the profiler should show.  database. See the Profiler page.  locale. See Session.  mimes.php Sets defaults for cookies.  routes.cookie. See the Pagination page. Multiple configurations are possbile. See Routing  session. See Hooks page.  user_agents.  payment. Includes _default and _allowed.php Sets available user agents including robots and mobile browsers.  log.  profiler.php Sets upload directory.  hooks. (See the validation/upload page?)  pagination.php Sets the logging threshold.php Sets database connection settings.

view. } function index() { } function edit($id.  . If a non­existing method is set it will try to call _default() or trigger an 404.  Example  http://localhost/index. $this->load->view('articles/edit'). } } Segments As said. E.  Example  class Articles_Controller extends Controller { function __construct(){ parent::__construct().php Allowed file types (deprecated?)  Kohana URLs URLs in Kohana are composed of segments. a controller method.php If no second segment is set it will call the  index() method.php ­ see Controllers for more information  The second segment maps to a method edit in the Articles_Controller class in  application/controllers/articles. A typical segmented URL is  http://localhost/control/action/arg1/arg2  The segments correspond (in order ) to a controller. and the method arguments.  The third and fourth segment refer to arguments given to the edit() method.$title){ //get the article from the database and edit it echo $id.php?/articles/edit/1/my-first-article // or the same URL with url rewriting on http://localhost/articles/edit/1/my-first-article When you segmentize this url it becomes  • • • • articles (the controller) edit (the action) 1 (first argument) my­first­article (second argument) This will correspond to the controller articles found for example in  application/controllers/articles.$title)  An example of what a controller would look like when this url is used. Kohana urls contain segments.g. edit($id.

 and various other operations.  Suffix Kohana allows you to set a suffix to your urls. You can simply append your urls with ? var=value to pass it on.php/topic.0. determine the current url segment. You can set the allowed characters in the  config/routes.com/tutorials/remove_index.Example  http://localhost/articles/edit/1/my-first-article Contains the segments  • • • • articles edit 1 my­first­article A URI class and a URL helper provide methods to make working with a url easier.html     http://forumarchive.  Query strings and GET support Query strings and GET support are enabled in Kohana.php?/articles/edit/1/my-first-article // or the same URL with url rewriting on http://localhost/articles/edit/1/my-first-article The latter looks nicer and is SEO proof.  The following urls might be of interest when setting up such a system:  • •   http://kohanaphp.php. See for more information the routing page.php file.html Setting this can be done in the application/config/config. See the difference between the following urls.  .  http://localhost/index.kohanaphp. Kohana urls contain index.php?/articles/edit/1/my-first-article.com/index. The keys and values are inspected and cleansed by the Input library when  global_xss is on.html   They offer slightly different solutions but each should work equally good.php file under url_suffix  Allowed characters Some characters are not allowed in urls.  URL rewriting By default.246.  Example  http://localhost/index. You can retrieve  segments. This does not look very nice and also is not optimized  for search engines.

 where you might want to change this behaviour. The routing feature of  Kohana allows you to change how URIs are mapped to controllers and methods.  . you can also specify your own routes.  Specifying your own routes In addition to the default route above.  There are cases.com/test in a web browser.example. the welcome controller  would be used even though it wasn't specified in the URI.example. which is an argument. if your Kohana web application were installed at www.. The result would be the same as if the  browser had gone to www.example. When changing  this.com/foo/bar. and class/method would replace it.example.  So.com/class/function/arg1/arg2 The first segment refers to the controller class.  The default routes. for example.example.com/welcome. a URI will map to a controller class and method on a one­to­one basis and provide  arguments where necessary.  Kohana's routing configuration In order to alter routing you have to have a copy of routes.php in your  application/config directory.example. you may  want to use URIs like this: www.com/article/22. For example. Here.Routing Typically. where route is the URI you want to route.  http://www. If it is not already there copy the one from the  system/config directory.:_'. if your web application is at  www. however. the second segment of the  URI is an article number.  $config['_default'] = 'welcome'.php will have two entries:  $config['_allowed'] = '-a-z 0-9~%. For example. not a controller method. For example.com and you visit this address with a web browser. The basic format for a  routing rule is:  $config['route'] = 'class/method'. It is used to indicate which controller  should be used when a URI contains no segments. you would see the page at  www.example. $config['_default'] specifies the default route.com and you  had the following routing rule:  $config['test'] = 'foo/bar'. the second to a method in that class and any other  segments become that method's arguments. $config['_allowed'] determines which characters are allowed in a URI. and you visited www. take care not to allow characters in the URI that could compromise your application.

 Kohana  employs this functionality.com/news/show/22 had been visited. which would match URIs starting with “article/” followed by some numeric digits.2 $this→load() is deprecated  Autoloading PHP has functionality to automatically load files if a certain class has not been loaded yet. you might want to start the Session library on every  page. Using regular expressions. on every pageload. $cache = new Cache().example. we will use the news controller and call it's show() method passing in the article  number as the first argument. They are:  • • :any matches any non­blank string of characters :num matches any number These can be used in place of the sub­pattern in the regular expression.  This is best described with an example.  . and you can make use of the sub­ pattern back referencing technique to re­use parts of the URI in it's replacement. $this->layout = new View('layout'). which looks much neater.1.  Examples Loading resources Since Kohana 2.example.com/article/22 example.com/article/22 is routed to  www.  Shortcuts In addition to being able to use regular expressions. you can  be more selective about which URIs will match your routing rules. it is as if the  URL www. html::stylesheet().example. Kohana's autoloading will load a certain library.  Example  $user = new User_Model. so in the previous example  where www. we could have used the following routing rule:  $config['article/(:num)'] = 'news/show/$1'.Using regular expressions The route part of a routing rule is actually a regular expression. etc.example. If you are unfamiliar with regular  expressions you can read more about them at the PHP website. Note: This is not the same as Kohana autoloading.  model. For example.com/news/show/22. Suppose we wanted to make the URL  www. If the URI takes  this form. In the www.example. there are also two shortcuts provided. we might use a routing rule like this:  $config['article/([0-9]+)'] = 'news/show/$1'.com/article/22 work.

 Just call method as a static method. More on views can be found on the views page Information on the  view class can be found on the view class page. PHP5's nifty auto_load function Loading database Apart from the aforementioned methods loading the database can also be done like this  $this->load->database(). The actual rendering of a view is  not done when you load one. There is more than one syntax to load a view.  . Loading models To load a model there is more than one method. it won't work and will  trigger a debug error in the log.Loading libraries Libraries can be loaded in general in two different ways. Loading views Views are the final output of Kohana. Note: in models the database is loaded automatically. //will render the view $this->layout->render(TRUE). For example loading the session library:  $this->load->library('session'). echo $session->id(). They can be embedded into each other so as to help you in  making your site.php //alternate syntax $this->layout=$this->load->view('layouts/layout').  Loading helpers Note: Loading a helper using $this→load→helper() is deprecated. // will load the file views/layouts/layout.  Using a helper is fairly simple. These are the basic methods. more can be found on  the Models page.  Example  $this->layout=new View('layouts/layout'). The class will be loaded  automatically  echo url::base().g. echo $this->session->id() // this is the CodeIgniter compatible approach // another possiblity using $session = new Session. // the object can be approached with $this->session e.

  Controller naming and anatomy A controller's filename can be basically anything.php The loading  of the model happens in the controller.  In the application/config/config. Use a base controller  instead. Controllers pass on the information of the model to the views.g. e.  $config['preload'] = array ( 'libraries' => 'database. updates and deletes for data change and database selects for information  retrieval.php controller class must map to filename and capitalized. the filename would be models/user. They pass information on  to the model when data needs to be changed and they request information from the model. Preloading resources This functionality is deprecated and will no longer be available in Kohana 2.php you can configure which libraries or models should be  automatically loaded on each page load. Router and Input. the views contain the final  output for the users. For  example database inserts. session'.  Controllers are called by an url.g.For instance your model is User_Model. 'models' => 'book' ) Multiple entries should be separated by commas. $name = $user->get_user_name($id). $name = $this->user->get_user_name($id). //get_user_name is a method defined in User_Model // alternative syntax $this->load->model('user'). and must be appended with  _Controller.  Controllers Controllers stand in between the models and the views in an application. e. Articles_Controller must have the Controller class as (grand)parent controller methods preceded by '_' (e. The name of the controller class must correspond  to the filename.2. Example  $user = new User_Model.  Conventions for a controller  • • • • • must reside in a controllers (sub­)directory  controller filename must be lowercase. _do_something() ) cannot be called by the URI  mapping .  Note: Some libraries are always loaded automatically: URI. see for more information Urls for more information. articles.g.

com/article/overview it will display  Article list goes here! Controller with arguments Say we want to display a specific article.php  class Article_Controller extends Controller { public function index() { echo 'Hello World!'. the index method is called. It will show Hello World on the screen.yoursite.com/article/view/your­article­title/1 The last two segments  of the url are passed on to the view() method.  More advanced controller In the example above the index() method is called by the www.com/article url. for example the article with the title being yourarticle-title and the id of the article is 1. It would also be called by the following url:  www.com/article you should see  Hello World That's it.php  class Article_Controller extends Controller { public function index() .php  class Article_Controller extends Controller { public function index() { echo 'Hello World!'.yoursite.  The url would look like www.  application/controllers/article. You can see all conventions are applied.yoursite. it determines which method of the controller is called.A simple controller We start with a simple controller.  application/controllers/article. If the second  segment of the url is empty.com/article/index  If the second segment of the url is not empty. } } Now if you enter www.yoursite.yoursite. } public function overview() { echo 'Article list goes here!'. your first controller. } } Now if you call the url www.  application/controllers/article.

 have localhost/about/me map to  http://localhost/articles/view/1  See Routing for more information on this. $data ) . a file in  application/controllers/admin/user. Kohana will include the  subdirectory in the mapping to the controller.$id) { echo $id .g. E.  _remap If you have this method in you controller. if your controller  is called Welcome_Controller. // you'd retrieve the article from the database here normally } } When you call www.yoursite.  Special methods index index() is the method that will be called when there is no other method call.com/welcome  then the index method is called.php will correspond to the url http://localhost/ admin/user  Routing controllers elsewhere If for some reason the mapping from the URI to the controller and method is not right for you you  can use routing to map a URI to another controller. bypassing  the default URI to method mapping. E.  The method is passed two parameters which can be handled as in the example below:  class Article_Controller extends Controller { public function _remap( $method. } public function view($title. $title. and the following url is called http://example. E. then all requests to the controller are sent to it.your-article-title Controllers and subdirectories If you put a controller in a subdirectory of the /controllers/ directory.{ } echo 'Hello World!'.g.g. ' .com/article/view/your­article­title/1 it will display  1 . public function overview() { echo 'Article list goes here!'.' .

 This can be done by declaring methods private and/or  prepending them with _  application/controllers/home.domain. but this shows how _remap works.  You would not use _remap if your URI schema was this simple. // it'll be index if there is no segment following the controller name // or the segment if there is // the $data param is an array of the remaining uri segments (if any) // otherwise it is an empty array } } Examples www.g.domain. http:// example.{ // method is the first part of the uri.  Private methods Sometimes you want some methods in your controller which should not be available on your  website.com/welcome/sthrandom90923 . This is handy if you want to trigger a 404 for example.com/article returns:  method = index  data = none  www.domain. } . E.  _default _default() is the method called when a method of a controller is called that doesn't exist.php  class Article_Controller extends Controller { public function index() { echo 'Hello World!'.com/article/read returns:  method = read  data = none  www. They are only used internally.  There is also a tutorial showing the use of _remap. the method sthrandom90923 doesn't exist so if it exists  _default() will be called.com/article/read/1 returns:  method = index  data = array( '1' ).

 you have to call the parent constructor.  application/controllers/home. public function __construct() { parent::__construct(). } } This example also shows how you can retrieve an article from the database using URL segments. it will retrieve the article whose id is 5.  Example MY_Controller. //this must be included $this->db = new Database.com/article/view/5 . useful for authenticating and authorizing users for example or doing session  magic. $this->session = new Session.php  <?php class Controller extends Controller_Core { . protected $session.yoursite. You can execute code on every  page for example.  Class constructors If you declare a constructor in your controller.yoursite. array('id' => $article_id)). $article = $this->db->getwhere('articles'.com/article/_article_form you'll encounter a 404. If  you call www. } public function index() { $this->session->get('user_id').private function _article_form() { echo 'Article form'.php  class Article_Controller extends Controller { protected $db. } public function view($article_id) { $article_id = (int) $article_id. } } When you call www. for example to load some resources for the entire  controller.  Special Controllers Using a base controller for your application Using a base controller for your application can be very helpful.

  Note: The prefix MY_ can be configured in application/config/config. see the page on Loading.e. you can just add the following line to your controller's constructor:  $this->profiler = new Profiler. You might create the  following file:  . the first letter must be a upper­case) For a new library.1. to load and  use the Profiler library. Library class names must be all capitalized (I.php by  changing the $config['extension_prefix']  Libraries The following Kohana libraries are loaded automatically by the framework and should always be  available to you:  • • • Loader URI Input Other libraries can be loaded automatically by Kohana when they are used. Alternatively.  in modules/libraries) Library files must be named the same as the library class (but without any ”_Core” suffix). these are the conventions that are suggested:  • • • • Library files should be put in application/libraries (or if you're creating a module.2.public function __construct() { parent::__construct(). For example. For example. lets suppose that you wanted to create a new “book” library. the class name can have ”_Core” appended to the end to enable you to  extend it in the same way you can with Kohana's built­in libraries.. // authentication goes here for example } public function do_something() { // method available in all controllers } } The file should be named MY_Controller.  For more information. if you wish to load libraries manually. you can do the following:  $this->load->library('some_library').php It should then be placed in  application/libraries This class has all the methods of the original Controller plus your  own. Note: using the above “manual” method of loading libraries is deprecated since Kohana 2.  Adding your own libraries When creating your own libraries.

 such as site­wide behaviour. Lets say. see the  configuration page. or change the way they work. You may wish to implement an authentication mechanism. This prefix is configurable. or templating methods to a controller.  You can also extend your own libraries.  with a couple of exceptions:  • • The filename must be prefixed with ”MY_”.php  <?php defined('SYSPATH') or die('No direct script access.File: application/libraries/Book. The class name must be the same as the class name you are extending and must not have  ”_Core” appended to it.'). If you wish to implement  behaviour that should apply to a kohana class. You might do the  following:  File: application/libraries/MY_Controller. the conventions are the same as for when you are creating a new library.  Here are some examples of why you might want to extend Kohana's Controller class in particular:  • • • You may wish to implement site­wide page caching. Instead you can create a new library that extends a built­in library. this is the preferred way  to achieve it. class Book_Core { // add constructor/methods/properties here } ?> Extending libraries Kohana also allows you to extended it's built­in libraries so that you can add your own functionality  to them.'). but is expected. These could be  implemented in your extended controller and would be accessible to every controller in the  . } } ?> Extending the core classes is not only allowed in Kohana.  When extending a library.php  <?php defined('SYSPATH') or die('No direct script access. that you want to extend Kohana's controller class. You should never change the files in  system/libraries. class Controller extends Controller_Core { public function __construct() { // don't for get to call the parent constructor! parent::__construct(). You might want to provide layout. so long as you have added ”_Core” to the end of their  class names. for example.

'some_class') For more information.php  <?php defined('SYSPATH') or die('No direct script access. If so. You might do the following:  $this->load->library('some_lib'). The conventions are the same as when you are adding your own library.  // make sure you put this somewhere before loading a Zend Framework component ini_set('include_path'.  Replacing Kohana's built­in libraries It is also possible (although probably less often required) to replacing one of Kohana's built­in  libraries entirely. for example. The deprecated preload configuration option (which pre­loads libraries and models) has been  replaced by this method.ini_get('include_path'). Zend Framework Zend Framework's files may struggle to load it's dependencies which will be loaded incorrectly  without further configuration. If the zend folder is in applications/vendor/zend the  following code can be used. you can use an  alternative method of loading.').PATH_SEPARATOR.'vendor/ze nd/library/').  sometimes renaming the file and the class name is all that is necessary. with one  exception:  • Appending ”_Core” to the class name is not optional ­ you must do it! If. The same behaviour can be achieved by extending the core Controller class  and loading any libraries and models from the constructor. class Profiler_Core { // define your own profiler here } ?> 3rd­party libraries If you should require 3rd­party libraries (such as Simplepie. you might do the following:  // example .APPPATH. Loading them from Kohana is simple. see the Kohana class page. To include a Zend Framework component.application.  You might do the following:  Kohana::find_file('vendors'. Zend Framework. or Pear libraries) you  can place these in the application/vendors directory. you want to replace the Profiler library. you might create the following file:  File: application/libraries/Profiler.  Note that some 3rd party libraries can be adjusted to be Kohana libraries without much effort.

 in  modules/helpers) Helper files must be named the same as the helper class (but without any ”_Core” suffix). Note that it also can be placed in the SYSPATH folder but it then might be overwritten by a new  version of Kohana.ini_get('include_path'). Helper class names must be all lowercase. In this case use  ini_set('include_path'. the helper classes are automatically loaded by the framework when they are used.  As with libraries.  so there is no need to load them yourself. but there is a subtle difference. As with most of Kohana.PATH_SEPARATOR. you might create  the following file:  File: application/helpers/javascript. Helpers are declared as static methods of  a class.SYSPATH.php  <?php defined('SYSPATH') or die('No direct script access. Module folders will do as well. Helpers Helpers are simply “handy” functions that help you with development.php'. For a new helper.'vendor/ze nd/library/'). class javascript_Core { public static function alert($message) { return "alert('$message'). $acl = new Zend_Acl(). // or another example require_once 'Zend/Acl. You can think of them as “global functions”. suppose that you wanted to create a helper to help with JavaScript. so there is no need to instantiate the class. these are the conventions that are suggested:  • • • • Helper files should be put in application/helpers (or if you're creating a module.  Here is an example call to a helper:  // show the location of this Kohana installation echo url::base().'). you have to  create an instance of the library's class to use its methods. } } .require_once 'Zend/Service/Flickr. For example. the class name can have ”_Core” appended to the end to enable you to  extend it in the same way you can with Kohana's built­in helpers.  Helpers are similar to library methods. you can add your own helpers and replace or extend Kohana's built­in  ones.php'.  Adding your own helpers When creating your own helpers. With a library.\n".

 so long as you have added ”_Core” to the end of their class  names. see the configuration page. for example.php  <?php defined('SYSPATH') or die('No direct script access.  When extending a helper.  You can also extend your own helpers. you would do the following:  javascript::alert("Oh no!"). class html extends html_Core { public static function your_custom_method() { } } ?> Extending the core classes is not only allowed in Kohana. the conventions are the same as for when you are creating a new helper. you can create a new  helper that extends a built­in helper.').'). You should never change the files in system/helpers! Instead. Extending helpers Kohana also allows you to extended its built­in helpers so that you can add your own functionality to  them. The class name must be the same as the class name you are extending and must not have  ”_Core” appended to it.  Replacing Kohana's built­in helpers It is also possible (although probably less often required) to replacing one of Kohana's built­in  helpers entirely. lets suppose that you want to extend Kohana's HTML helper. with one  exception:  • Appending ”_Core” to the class name is not optional ­ you must do it! If. This prefix is configurable. but is expected. you want to replace the url helper.  with a couple of exceptions:  • • The filename must be the same as the helper you're extending. For example. except it must have ”MY_”  prefixed to it.php  <?php defined('SYSPATH') or die('No direct script access. class url_Core { // define your own url helper here . The conventions are the same as when you are adding your own helper.?> and then to use your helper. you might do something like:  File: application/helpers/url. You might do the  following:  File: application/helpers/MY_html.

 Views are  executed in the Controller namespace so you have access to all resources you have loaded into  $this→  When this view is rendered it is executed just as any PHP script would and the output from it is  returned (or sent to the browser if you so wish).} ?> Views See View class for more in depth information on using views in your code.  Creating views Views need to be placed in the views directory.  New object Create a new instance of the class.  While this is true.php in sub-directory 'products' $view = new View('products/list'). For example. at this point the view file has not been read and no output is created. views themselves can contain code used for displaying the data you pass into  them. This is most commonly  HTML. It is important to note that this simply creates an instance of the  View class. . CSS and JavaScript but can be anything you require such as XML or Json for AJAX output.  Overview Views are files that contain the display information for your application.  Examples  // Filename home. This only happens  when it is rendered. // Filename list.  The purpose of views is to keep this information separate from your application logic for easy  reusability and cleaner code. Views are still PHP files so you can use any code you normally would. Loading views There are 3 ways to load a view.php $view = new View('home').  $view = new View('welcome'). The filename minus the extension becomes the  view's name. looping through an array of product information and display each one on a new  table row. Views can be arranged in sub­directories if needed but the path must be specified  when loading them.

  Use the built in loader.  $view = View::factory('welcome'). // Render the view $view->render(TRUE). The loader method is mainly provided for easier migration  from CodeIgniter. Passing data into your views Data is passed from the controller to the view by way of an an object. Using the factory method is preferred over this as it does the exact same  thing but factory is shorter and clearer.?></p> </body> </html> Note: Use of arrays (CodeIgniter style) is still possible in Kohana.2 loader is deprecated. see more examples below Note: You cannot use $view→data = $data. } } Now open your view file and add variables:  <html> <head> <title><?php echo $title.?></title> </head> <body> <h1><?php echo $heading.?></h1> <p><?php echo $content.Factory Use the factory() static method. $view->content = "My content here. $view->heading = "My Heading". .  $view = $this->load->view('welcome').1. // Adding variables to the object that will be displayed in the view $view->title = "Welcome to Kohana !". This is essentially the same as creating a new object except it is  immediately returned so method chaining is possible.".  Let's look at the Controller:  class Welcome_Controller extends Controller { function index() { // Load the view as an object $view = new View('yourview'). Loader Since Kohana 2.

php $view->content->heading = 'Heading of your page'. // string for variable $heading in view footer.php  <?php echo $copyright. $view->footer = new View('footer'). $view->content = new View('content'). // string for variable $heading in view content. You may also need custom helpers to generate navigation. ?></h1> View: footer.php $view->render(TRUE).Views within views To load views within other views:  // Example of code inside your Controller $view = new View('template'). $view->header = new View('header').php $view->footer->copyright = 'Copyright'.php  <?php echo $header.php  <html> <head> <title><?php echo $title. ?></title> </head> View: content. $view->header->title = 'Title of page'. // string for variable $title in view header. using stylesheets and applying them to divs within your layout would give the exact  design you want. View: template.php and  . ?> </body> </html> Output:  <html> <head> <title>Title of page</title> </head> <body> <h1>Heading of your page</h1> Copyright </body> </html> Of course.php  <body> <h1><?php echo $heading. this can merge the header. ?> View: header. ?> <?php echo $footer. breadcrumbs and  dynamic content (banners. customized ads) to add a professional touch. ?> <?php echo $content.  Note: Please also consider using the Template_Controller.

 The products list view is loaded and the variables title and  products are set. echo '</td><td>' .php  $products = array( array( 'name' => 'Product1'. echo $product['name']. $products).footer. The view is rendered and outputted straight to the browser.php  <html> <head> <title><?= $title ?></title> </head> <body> <h1><?= $title ?></h1> <table> <?php foreach ($products as $product) { echo '<tr><td>'. $view = new View('products/list'). $view->title = 'Products'. 'quantity' => '3' ). array( 'name' => 'Product2'. 'quantity' => '7' ) ). $view->set('products'. Complete Example Controller: products.  Examples Ex 1: Render on View instance  $view = new View('sample'). $view->render(TRUE). Ex 2: Render on View::factory  View::factory('sample')->render(TRUE). An array of product data is defined.  Data scope Rendering Execute the render method on the view instance.php into one file. $view->render(TRUE).  View: products/list.

  Output:  <html> <head> <title>Products</title> </head> <body> <h1>Products</h1> <table> <tr><td>Product1</td><td>3</td></tr> <tr><td>Product2</td><td>7</td></tr> </table> </body> </html> Models What are models? Models are classes designed to work with information given by or asked for by the controller. does have _Model appended to it and should be the  singular form of the name. you have a guestbook. If you choose not to use them. Example Suppose that you have a table in the database called users (which is a plural name). there are other. The model  .} ?> </table> </body> </html> echo $product['quantity']. The title variable is echo'd. For  example. Model filenames are lowercase. update existing ones or even delete some. These are:  • • • • Models go into the application/models/ directory. the  model returns those entries to the controller who passes them on to a view. more specific.  Naming models Kohana uses specific rules for the naming of models. do not have _model appended to them and should be the  singular form of the name. The model class name is capitalized. echo '</td></tr>'. The products array is iterated over and each product is echo'd  within table row and column tags. conventions. For models that use ORM.  Note that Kohana doesn't force you to use models. the controller will ask the model to retrieve the last ten entries. The controller might  also send new entries to the model. you are free to do  so.

 you use the Kohana Template_Controller and need access to your model from all  descendant controllers. you can add the following to the Template_Controller constructor:  $this->user = new User_Model. } } Loading models The generally accepted way of loading a Model in Kohana is to do so within your Controller.php add the  following to your controller:  $user = new User_Model.2.  The file would initially look something like this:  <?php defined('SYSPATH') or die('No direct script access. like  this:  $name = $user->get_user_name($id). to load the user model (above) from application/models/user.1 and will no  longer be supported in Kohana 2.that represents the users table would reside in the file application/models/user. $name = $user->get_user_name($id). You can then access the user model from any controller that extends the Template_Controller.php and the class would be called User_Model (which are both singular names).1 $this->load->model('user').  For instance. User_Model // get_user_name is a method defined in Deprecated The following alternative method using the Loader library is deprecated in Kohana 2.  // Model name is called without _Model. User_Model // get_user_name is a method defined in Inheriting If. for example. case doesn't matter // Deprecated as of Kohana 2.'). Usage A model might look something like this:  class User_Model extends Model { . class User_Model extends Model { public function __construct() { // load database library into $this->db (can be omitted if not required) parent::__construct(). $name = $this->user->get_user_name($id).

$data) { $this->db->where('user_id'. You can use all of the database's functions with the  $this→db object. * array( 'name' => 'test'. } } Note: When utilizing data from a form always use $this→input→post('var_name'. $data). } /** * Add a new user. This can be done  . $this->db->update('users'.. 'email' => 'test@example. return $this->db->get('users'). } /** * Get information about a user. } /** * Replace user details.com' ) * @return void */ public function insert_user($data) { $this->db->insert('users'. Learn more about the Input library.public function __construct($id = NULL) { // load database library into $this->db (can be omitted if not required) parent::__construct($id). E. you can integrate this model into your controller as follows:  1...com' ) * @return void */ public function update_user($user_id. Assumes an auto incrementing user_id in the database.  Using a model in your controller Using the example model above. $data).g. * @param array user data. TRUE) to ensure data is sanitized before using. * array( 'name' => 'test'. the default database  functionality will be loaded into $this→db. 'email' => 'test@example.g. * @param array user data. given their user_id * @param integer the user_id * @return the result object */ public function get_user($user_id) { $this->db->where('user_id'. E. Create an instance of the model in your controller to make it accessible. $user_id). $user_id).  Using a database in your model If your model's constructor contains the line parent::__construct().

  system. Nothing is attached  to this event by default. The pre­defined actions for these events  are added in Kohana::setup. The $user variable now contains a database result set  object (for the user with id = 1) that can be passed to your View.ready Called immediately after hooks are loaded. you can now retrieve user information from your  database within any of your controller methods with: $user = $this→user→get_user(1). 3.name. you can access specific user data  elements within your View in the form $user→name.  System Events The following events are defined in the Kohana core files.routing Processes the URL and does routing. See Database Library for more  information. All of the core events are prefixed as system. find_all_by_lastname) commonly used in a  model as well as support for relationships between tables. A controller object will be created. If you used the constructor method above. Another aspect of ORM is that it turns a  record from a database into an object. as an instance of Kohana. Hooks are loaded before this point.2 Triggered after all routing is done so interventions in routing can be done here. Names usually include a prefix with the name 1). This is the earliest attachable event.  system. but  are not required to. removing and using custom events.  system.  Kohana events consist of a name and callback. running.  Events See Event for information on adding. If you passed the entire $user variable to your View. it will also have some basic functions (find($id).  Calls Kohana::instance by default. ORM See for more information  •   ORM   ORM is a special kind of model.directly in a controller method as $user = new User_Model. Based on its name it will derive for example the table it is a model  for. If you want the model  accessible from all of your controller methods.post_routing Kohana 2. 2. Calls Router::find_uri and Router::setup by default.execute Controller locating and initialization.  system. If  . create an instance of the model in your  controller constructor: $this→user = new User_Model.

 just before PHP starts to shut down.execute.php core/Benchmark.  system. controllers are  loaded so you can check for for example authentication early in Kohana.404 Called when a page cannot be found.  system. to be more specific they are loaded in the  Kohana::setup() method.  system. after the controller file is loaded. Runs the Kohana::shutdown method by  default.Router::$controller is empty after this event a 404 is triggered. but headers have already been  sent. so their methods can be used  • • • index. At this time these files are loaded.shutdown Last event to run. and views can be loaded.execute.  system.  system. Calls Kohana::show_404 by default.g. before any content is displayed. Writing  cookies is not possible after this point.name Hooks Hooks are basically files included at the start of Kohana.display Displays the output that Kohana has generated. Events and hooks go hand  in hand since in hooks you can attach code to events. The rendered output can be manipulated as Event::$data. Kohana::instance will return the  controller at this point.execute. and Session data will not be saved.post_controller Called within system. See for more information the Hooks page. after the controller object is created. after the controller constructor has been called. Views can be loaded. but before an object is created.  system.send_headers Called just before the global output buffer is closed.pre_controller Called within system.  1) An example of a “prefix” is prefix.  Hooks Hooks are included early in Kohana and can be used to execute code before e.php  .  system. Kohana::instance will  return the controller at this point. and views can be loaded.post_controller_constructor Called within system.php core/Bootstrap. Controller methods have not been called  yet.

php  class Power { public function Kohana(){ Event::$data=Event::$data. Set $config['enable'] to TRUE and all files in the hooks directory  (application/hooks) will be included and the code will be executed.  Constants When using hooks you might need to get under the hood of Kohana. If the file is not there  copy the one from system/config.'<!-. the first to be started is system.php  $config['enable'] = FALSE. It utilizes the  Event::$data to manipulate the final output.  Configuring hooks To configure hooks edit 'hooks. When the hooks are loaded  . array('Power'.php  core/Config.  It will look something like this:  File: hooks.php $config['enable'] = array('page_cache'). 'Kohana')).display'.  Set $config['enable'] to an array with filenames and those and only those files will be  included. Hooks and events The power of hooks mainly comes from the Events class.Powered by Kohana-->'. This will add a small notice to the bottom of each page (<!– Powered by Kohana–>).php  No event has been started yet.• • • • • core/utf8.php  core/Kohana.  Example hooks.php  //To include all files in application/hooks $config['enable'] = TRUE.php  core/Log.php  core/Event. //or to load page_cache. } } Event::add('system.php in your application/config directory. Hooks are loaded before any of the events  are started so you can attach a hook to an event. For example you load the following file as a hook  Example hooks/power.ready  Hook files should be put in application/hooks or similarly in a module folder.

Config. During development you'd want to set this to TRUE. Defaults to '.php  • • • • • • EXT ­ contains the default file extension used for files in Kohana.php' KOHANA ­ basename DOCROOT ­ dirname APPPATH ­ path to the application directory SYSPATH ­ path to the system directory MODPATH ­ path to the modules directory Error Handling See for more information  •   Log class   explanation of the log class.php file there is a setting display_errors. // Throw a $lang['division_by_zero'] exception in .. There are three types of  exceptions: Kohana_Exception.  Syntax /** * @param string i18n language key for the message * @param array addition line parameters */ throw new Kohana_Exception(string $i18_lang_key [.php // "Cannot divide by zero. string $message]). // Throw a $lang['math']['negative_number'] exception in ." else if($x < 0) throw new Kohana_Exception('general. Example //.these constants are set in index. but in  production set this to FALSE so as to prevent users from seeing errors. To throw a Kohana_Exception an i18n  language file must exist. if($x == 0) throw new Kohana_Exception('math.division_by_zero')./i18n/en_US/general../i18n/en_US/math.. Kohana_User_Exception and Kohana_404_Exception.math.display_errors In the index. This won't affect logging of  errors. . This determines whether errors should be  outputted to the screen or not. $x).  Exceptions Exceptions in Kohana are handled by the Kohana Exception classes.  Kohana_Exception Kohana_Exception extends Exception.negative_number'.php and pass the message $x // "The number passed was negative: -5" //..

. Kohana_404_Exception Kohana_404_Exception extends Kohana_Exception. This exception will display a 404  error message to the user. Triggering errors Custom error pages The system/views/kohana_error_page. //.php is the default error page. // "The page you requested. string $message [. string $template]]). 'You passed a zero'). if($x == 0) throw new Kohana_User_Exception('Cannot divide by zero'.. else if($x < 0) throw new Kohana_User_Exception('Number Type Exception'. You can overload  this one by having a kohana_error_page. Example //." //. string $template]).  Syntax /** * @param string URL of page * @param string custom error template */ throw new Kohana_404_Exception([string $page [..  . if($x == 0) throw new Kohana_404_Exception('divide by zero'). This is similar to  Kohana_Exception except that the exception messages do not have to be in the i18n structure.Kohana_User_Exception Kohana_User_Exception extends the Kohana_Exception. Example //. "Cannot use a negative number $x"). could not be found...  Syntax /** * @param string exception title string * @param string exception message string * @param string custom error template */ throw new Kohana_User_Exception(string $title.php in your application/views directory or  in a similar modules directory. Cannot divide by zero....

views | +.models | +. For instance.  Example  // Paths are relative to the docroot. You may want to re­use some helpers or  add authentication across multiple applications. Place it in a module folder and you can copy it with  ease or have multiple applications use the same module directory.auth | +.helpers | | +.libraries | | +. debug messages and informational messages.views | | | +.The default error page will show you the error as well as a stack trace if available.models | | +.php See for more information on logging the Log class. but absolute paths are also possible $config['modules'] => array .php file using the 'modules' setting. we created a module for ACL (access  control lists) and authentication (auth) since we want to reuse it across applications.system +.modules | +.helpers | +.  Modules Kohana is easily extendable using modules.php Configuring Only placing modules in the modules directory won't load them.  Logging Kohana can log errors.vendor | +. The setting can be found in  application/config/log.  The Filesystem page should be read before this one to understand it properly.  root +.acl | | +. Modules are reusable collections of related files that  together add a particular functionality to an application.i18n | +.index.application +. This can be done in the application/config/config.vendor | | +.  Setting up It is most common to have a directory called modules in the same directory as the  application and system directories.libraries | +. they must be configured for  Kohana to use them.i18n | | +.

php | | | +. English files are in  en_US.net/timezones  File structure root +. ) In the cascading filesystem.cache. files in modules that are higher up the list take precedence over those  lower down just as files in the application directory do over those in modules and the system directory. if it's not there copy the one from the system/config directory.php | | | +.i18n | +.coffee.php .application | +. $config['language'] sets the language that should be used.coffee. $config['timezone'] = ''.php sets which locale will be used.de_DE | | +.  Internationalization Internationalization files can be found in the i18n directories.en_US | | +.zh_CN | | +.  In the i18n directories the directories with the language files can be found.i18n | +. 'modules/auth'. The file can be found in the  application/config directory.php | | | +.de_DE | | +.cache. These directories can be found in  system.cache. application or modules directories.  The file will look somewhat like this  $config['language'] = 'en_US'.php | | | +. Kohana's own internationalization files can be found in  the system directory.( 'modules/acl'. see for more information  http://php.coffee.  Locale setting The configuration file locale. German in de_DE etc.php | +.en_US | | +.system | +. It maps to the directories in the  i18n directory. Dutch in nl_NL. $config['timezone'] sets the timezone.zh_CN | | +.

 add the directory of the locale and add the file with the language strings.java'). da diese nicht serialisiert werden können. => 'Coffee is created from beans.resources') maps to  i18n/en_US/cache.beans'). => 'Coffee goes in here'. because resources cannot be serialized. not the programming These language strings can now be called from your application  Example  echo Kohana::lang('coffee. Simply add a directory  i18n. Kohana::lang('cache. => 'Place where coffee comes from. Name the file coffee. //outputs is locale is set to en_US // Caching of resources is impossible.php and place it in application/i18n/en_US/  Format of the file  $lang = array ( 'cup' 'beans' 'java' language'. echo Kohana::lang('coffee.'. ).cup'). echo Kohana::lang('coffee. . Example  echo Kohana::lang('cache. For example. you  want to have language strings for coffee and stuff related to coffee.php and within this file to $lang['resources']  Kohana also allows to give extra arguments to Kohana::lang()  Setting your own language strings It is possible to have your own language strings in your application/module.resources'). In the case of en_US. //If locale is set to de_DE // Das Cachen von Ressourcen ist nicht möglich.Retrieving language strings Using Kohana::lang() languages strings can be retrieved.

Core .

  Returns void.0078 [memory] => 472 ) The $decimal parameter is optional.007802 [memory] => 472 ) If you set the $name parameter to TRUE. // Output: Array ( [477f51931a33e_total_execution] => Array ( [time] => 0. By default several benchmarks are run:  • • • • • • Kohana Loading  Environment Setup  System Initialization  Controller Setup  Controller Execution  Total Execution  The results of the benchmarks will be outputted by the Profiler. // Output: Array ( [time] => 0.  print_r(Benchmark::get('benchmark1'. Returns void. stop() Benchmark::stop($name) is used to stop a benchmark. // Output: Array ( [time] => 0. $decimals) is used to retrieve the results of a benchmark. Supply the name given when the  benchmark was started.  print_r(Benchmark::get(TRUE. Supply an unique name. Its default value is 4. 3)). memory in bytes.023 . It is automatically loaded during the system  setup and all its methods are static.  print_r(Benchmark::get('benchmark1')).  Benchmark::stop('benchmark1').Benchmark Class The benchmark class allows you to time your code.  Methods start() Benchmark::start($name) is used to start a new benchmark.  Note: Benchmark does not have to be loaded nor instanced.  Returns an array with the results: time is expressed in seconds. get() Benchmark::get($name. 6)).  Benchmark::start('benchmark1').  If a view is rendered {execution_time} and {memory_usage} can be used in the view to be replaced  by the actual execution time and memory usage. all benchmarks will be returned.

[memory] => 618940 ) [477f51931a33e_kohana_loading] => Array ( [time] => 0.012 [memory] => 369104 ) [477f51931a33e_environment_setup] => Array ( [time] => 0.002 [memory] => 54300 ) [477f51931a33e_system_initialization] => Array ( [time] => 0.003 [memory] => 65884 ) [477f51931a33e_controller_setup] => Array ( [time] => 0.008 [memory] => 177688 ) [477f51931a33e_controller_execution] => Array ( [time] => 0.000 [memory] => 4236 ) [benchmark1] => Array ( [time] => 0.008 [memory] => 472 ) )

Note: If for some reason the memory_get_usage() function is not available on your system, memory will  be set to 0. 

Config Class
Provides methods for working with configuration items. 

Where to put the configuration?
Configuration files must be placed in a folder named config, this folder can reside in system,  application or a module. Application is more important than system and will override it. Modules  override system files but are overridden by application files.  The config file must be in this format: 
$config = array ( 'language' => 'en_US', 'timezone' => '' );

Retrieving configuration items
Config::item($key, $slash = FALSE, $required = TRUE) retrieves a  configuration item, can return a string, array or boolean. $slash will force a forward slash at the end  of the item. $required determines whether an item is required or not. 
config::item('locale.language'); //returns the language from the **locale.php** file and returns the config['language'] item.

Setting a configuration item
For setting configuration items in realtime you must enable this setting in the config.php file.  (core.allow_config_set)  Config::set($key, $value) sets a configuration item, returns TRUE on success or FALSE  when it didn't succeed. 


If you want to set a configuration in realtime make sure the config.allow_config_set is set to  TRUE in application/config.php 

Getting the include paths
Config::include_paths($process= FALSE) gets the include paths and returns an array.  First in the array is the application path, last will be the system path, other items will be include  paths set in the configuration item 'core.include_paths'. $process, if true, will reprocess the  include_paths. 

Load a configuration file
Config::load($name, $required = TRUE) loads a configuration file. Config::item()  loads them as well if they're not already loaded and retrieves the items straightaway. 

Event Class
For an overview for a programming overview of events, please see Event_handler and Event_loop.  Kohana stores events in queues, as opposed to stacks. This simply means that, by default, new  events will be processed after existing events. 

What is an Event?
Kohana events consist of a unique name and a callback. By default, there are several events defined  by Kohana. Names are completely freeform, but the convention is to use a prefix.name to make  event names more unique. All pre­defined events are prefixed as system.name, eg:  system.post_controller. 

All Event methods are static, and Event should never be instanced. 

Used to add a new callback to an event. If the event does not already exist, it will be created. 
// Calls the function "foo" after the controller method is executed Event::add('system.post_controller', 'foo'); // Calls the static method "Foo::bar" after the controller method is executed Event::add('system.post_controller', array('foo', 'bar')); // Calls the "bar" method in the "$foo" object when the output is rendered Event::add('system.display', array($foo, 'bar'));

You can also create entirely new events this way: 

// Creates a custom user.login event Event::add('user.login', array($user, 'login'));

Used to add a callback immediately before another callback in an event. 
// Add the function "faa" to be executed before "foo" Event::add_before('system.post_controller', 'foo', 'faa');

If the event you are inserting before does not exist, add_before will functional exactly the same  as add. 

Used to add a callback immediately after another callback in an event. 
// Add the function "fzz" to be after "foo" Event::add_after('system.post_controller', 'foo', 'fzz');

If the event you are inserting after does not exist, add_after will functional exactly the same as  add. 

Used to replace a callback with another callback in an event. 
// Replace the "foo" function with the "oof" function Event::replace('system.post_controller', 'foo', 'oof');

If the event you are replacing does not exist, no event will be added. 

Returns of the callbacks as a simple array. 
// Returns of the callbacks for system.post_controller $events = Event::get('system.post_controller'); // Loop through each event and call it foreach ($events as $event) { $return_value = call_user_func($event); }

If no events exist, and empty array will be returned. It is recommended to use empty if you need to  validate that events exist. 

Clear one or all callbacks from an event. 
// Clears the "oof" function from system.post_controller Event::clear('system.post_controller', 'oof');

If this method is called without a second argument, it will clear the entire queue for the given event. 

  header('Content-type: text/html. and can be manipulated by all of the callbacks.  // Run the system. // Run the post_controller event with data Event::run('system. This can is useful to make an event run only once.post_controller'). It loads up the Router.post_controller') or Event::run('system.post_controller')) { echo 'post_controller has been run. } // Run the post controller event if it has not already been run Event::has_run('system. dispatches to the controller and  does the final output.  Character set The class also sets a utf­8 header.  // Debug the data echo Kohana::debug($data). charset=iso-8859-1').post_controller').post_controller'. and can only be accessed during  callback execution. $data). Data Event::data is a special variable that can be set when using Event::run.  Kohana Class The Kohana class is at the center of Kohana.post_controller event Event::run('system. . If you want a different charset you can override it by placing this  in for example your controller.  // Test if the event has already run if (Event::has_run('system.run Execute all of the callbacks attached to an event. has_run Checks if an event has already been run. The data is assigned by  reference. Event data is cleared immediately after all of the callbacks are run. The browser will interpret the page with the new charset. // Display the changed data echo Kohana::debug($data).'.

 It displays an overview of files and functions called so you can  spot the source of the error. 'b' => 'aab'. Should be in form of 'rootnode. In the case of en_US.  lang() Using Kohana::lang() languages strings can be retrieved. //If locale is set to de_DE // Das Cachen von Ressourcen ist nicht möglich. because resources cannot be serialized.Methods debug() Returns HTML formatted strings of variables that can be echo to screen nicely.resources') maps to  i18n/en_US/cache. 'leveltwo2' => array . It takes:  • • [string] Key to search for.anothernode' [array] Array to search in. da diese nicht serialisiert werden können. Kohana::lang('cache. //outputs is locale is set to en_US // Caching of resources is impossible. Prints out the POST variable  backtrace() Will be called when an error occurs.childnode. Should be an array of values and/or another arrays to represent  nodes Example  $a = array ( 'levelone1' => array ( 'leveltwo1' => array ( 'a' => 'aaa'.  echo Kohana::debug($this->input->post()). Very useful for debugging.resources').php and within this file to $lang['resources']  Kohana also allows to give extra arguments to Kohana::lang()  key_string() Searches for given key in a nested array. 'c' => 'aac' ).  Example  echo Kohana::lang('cache.

. TRUE or FALSE (defaults to FALSE) Returns an array if the type is i18n or a configuration file. Result is that you can copy half a language file  from the system directory and place it in the application directory.php' in the 'controllers' directory.  Example  $controllers = Kohana::list_files('controllers'. 'levelone2' => array ( 'a' => 'ba'. //Returns 'abc' Kohana::key_string('levelone2. $a).c'.  This method uses the cascading filesystem of Kohana. 'foo' => 'bar' ) Kohana::key_string('levelone1. Exception to this is the i18n files and the config files. //Returns 'aab' Kohana::key_string('levelone1.'article')). defaults to FALSE) It returns array of file paths to found files. $a).foo'. When file is found it returns a string with  the path to the file. this means it will first look in the application  directory to see if a file exists.  Example  // find a file named 'article. 'c' => 'abc' ). 'b' => 'abb'.php file and then the system directory. // Now $controllers is an array containing paths to all controllers in your Kohana installation find_file() Find a resource file in a given directory using Kohana's cascading filesystem. ) ).( 'a' => 'aba'. throws an error if this is true and the file cannot be found [bool] Use a custom file extension. then any module that exists in order they are supplied in the  config. 'b' => 'bb'.leveltwo1. TRUE). include (Kohana::find_file('controllers'. It takes two parameters:  • • [string] In which directory to search in [bool] Should find_files be recursive? (TRUE or FALSE. $a).  • • • • [string] Directory to search in [string] Filename to look for (including extension if 4th parameter is TRUE) [bool] Is the file required.leveltwo2.b'.  They are loaded from the system directory upwards. //Returns 'bar' list_files() Iterates through all directories of a given name and returns found files. It will return FALSE if the file is not found. variables declared in the system  directory will be supplanted by the one in the application directory.

 By default nothing is logged to level 2 or 3 by Kohana.  Configuration The configuration file Log.  • • • • • 0 ­ Logging is disabled 1 ­ Error messages including PHP errors 2 ­ Application Alert messages (changed level) 3 ­ Application Information messages (changed level) 4 ­ Debug messages (new level) .  Important setting the level to 2 or 3 can slow down your application significantly. $config['format'] = 'Y-m-d H:i:s'. $config['directory'] = 'logs'.  There are three settings for the Log class:  $config['threshold'] = 0. See for more information on the  Config page.Example  // find a file named 'database.php' in the 'config' directory. include (Kohana::find_file('config'. or absolute. If it's not  there it can be copied from the system/config directory. it will log all libraries loaded and any errors.  $config['directory'] log file directory. Nothing is logged to level 3 by Kohana by  default.2 makes a small change to the logging threshold order.'database')).  Level 1 is recommended in production use as it will only log errors. Level 2 is useful while  debugging. $config['threshold'] can be set at four levels:  • • • • 0 ­ Logging is disabled 1 ­ Error messages including PHP errors 2 ­ Debug messages 3 ­ Informational messages When set to 3 it will also log 2 and 1. Same goes for 2. Log Class Provides methods to work with logging. relative to application/.php can be found in the application/config directory. but can be used for custom logging by applications. levels 2 and 3 can be used without  the overhead of debug.  $config['format'] format for the timestamps according to date()  Kohana 2.

 See for more  information on events the Event page. This method is also used internally in the utf8 class to determine when  to use native functions or UTF­8 functions.  Note: The clean() method is automatically applied to the GET. COOKIE and SERVER globals.shutdown). It returns TRUE if  it does so. // returns void Unicode Functions Provides static methods to work with UTF­8 strings as PHP is not yet natively capable of doing that. // returns void Writing the log entries to the file Log::write() is called by default on the shutdown event (event. // returns void Log::add('debug'. The mbstring extension is highly recommended. There is typically no need to call it manually. objects. FALSE otherwise.  Example:  var_dump(utf8::is_ascii("a\0b".Methods Adding entries to the log file Log::add($type.chr(127).info). It removes ASCII control  characters (strip_ascii_ctrl) and converts to UTF­8 while silently discarding incompatible  UTF­8 characters.  Log::add('error'. and strings. // bool(true) . 'Query went wrong'). However. $message) logs the message according to the type given  (error. the item will be preceded by a timestamp formatted according to  $config['format'].  Requirements:  • • •   PCRE   needs to be compiled with UTF­8 support.debug. 'Custom library X loaded').  from_unicode is_ascii utf8::is_ascii() checks whether a string contains only 7bit ASCII bytes. The iconv extension needs to be loaded.'c')). Methods clean utf8::clean() recursively cleans arrays.  Log::write(). it must not be overloading string  functions. POST.

  Example:  echo utf8::strip_ascii_ctrl("a\0b". // bool(false) ltrim ord rtrim str_ireplace str_pad str_split strcasecmp strcspn strip_ascii_ctrl utf8::strip_ascii_ctrl() removes all ASCII control characters from a string. // Output: abc strip_non_ascii utf8::strip_non_ascii() removes all non­ASCII characters from a string.var_dump(utf8::is_ascii("a\0b".chr(128).'c')). // Output: Clichs .  Example:  echo utf8::strip_non_ascii('Clichés').'c').chr(7).

// Output: Jerome est un garcon. Special characters that are unknown to this method are left untouched.  . Further reading: Wikipedia on transliteration  trim ucfirst ucwords View Class For a more in depth overview of views see General/Views.  Example:  echo utf8::transliterate_to_ascii('Jérôme est un garçon. You  can remove them afterwards with the strip_non_ascii method.stristr strlen strpos strrev strrpos strspn strtolower strtoupper substr substr_replace to_unicode transliterate_to_ascii utf8::transliterate_to_ascii() replaces many (not all) special/accented characters by  their ASCII equivalents.').

$var).php $view->render(TRUE).  $view = new View('welcome'). no browser output $this->template->content = $this->session->get_once('message'). render() render() renders the output of the View. $view->render(true).$content- . Setting data Methods set() set() can be used to set a variable in a view. default. This  means you can use it with views in views for example. // set variable $title for example in view header. $this→view→your_variable can be used to accomplish the same. $var='Some value'.  // render and store. $var='Another value'. $view->set('title'.Creating an instance Creating an instance of the view class.  $view = new View('welcome'). You can also supply an array and the keys and values  will be treated as variables. // setting variables in all views $view->set_global('title'. //The 'title' variable will contain 'Another value' set_global() set_global() is like set only that the variables set are available throughout all views.  $view = new View('welcome'). 'Elvis lives'). 'Title of page').  // loading views $view = new View('page'). $view->header = new View('header'). $view->bind('title'. bind() bind() is like set only the variable is assigned by reference.

set_filename() This method only exists in version 2.  public function _add_breadcrumb() { $crumbs = View::factory('admin/breadcrumb') ->set('crumbs'. html::breadcrumb()) ->render(). Parameters are the same as creating a new instance. factory() This method is static. // render output of view to browser $this->template->render(TRUE). } else { $view->set_filename('html_view'). .$this->template->content. if(request::is_ajax()) //request helper also exists in 2.2 { $view->set_filename('ajax_view'). } $this->template->content = $crumbs.  $view=new View.  It creates a View instance and immediately returns it so method chaining is possible.>render(). } $view->render(TRUE).2  set_filename() sets the name of the file used for the view.

Addons .

'post'). if false. You can create forms with built­ in validation in one go.  $form->set_attr('class'.Auth Module The Auth module is a simple module to enable authentication on your site. the second is the form title. completely destroy the session. do not delete the session.  • [boolean] If true. If you're new to Kohana the  code of Auth might help you to get started. It employs ORM and Forge. Forge coexists with the Form helpers. it doesn't replace it. the form helper provides methods to create  forms. all of which are  optional. the third argument is the  form submittal method. validating and filtering forms. 'POST'. The Forge class will accept up to four arguments.  Say we want to change the class and method attribute of the form. $remember) validates a user's authentication  credentials and logs a user in. the last of which is obviously the attribute array. Forge provides  help with rendering. 'Add article'.  logout() $this→auth→logout($destroy) logs a user out by removing the appropriate session  variables. You  can also set any of these attributes after the fact or on the fly by using the method below.  multiple roles per user and auto­logins. It supports users. array('id' => 'article_form')). 'form_class')->set_attr('method'. but only  remove the authentication information from the session. Take a look at the controller and the models to see how  simple applications work. The first argument is the form action. and the last argument is an array of attributes. This is the start of each form.  Methods auto_login() login() $this→auth→login($user. hash_password() Forge Module (Form Generation) The Forge module is a module to easily create and manage forms.  Here you see only three arguments being used. $password. .  Creating a form Creating a form is done by instantiating the Forge class  $form = new Forge(''.

} Form methods set_attr() set_attr() set an attribute of the <form> element. Useful for putting your form values  into the database. $form->submit('submit').  . } else { echo $form->html(). $form->set_attr('class'. $form->input('title')->label(true)->rules('required|length[3. 'post'.40]| valid_alpha_numeric').'id' => 'article_form')).Adding elements Next step is adding elements. 'Add article'. $form->set_attr('class'. Now we set a label and add rules. $form->set_attr(array('class' => 'form_class'. if($form->validate()) { echo $form->title->value. There are two parameters:  • • [array]/[string] Either the attribute name or an array of attribute names and values [string] Attribute value (Default NULL) $form = new Forge(''. 'article_form')). This is the basis of adding elements.  $form->input('title'). 'form_class')->set_attr('method'.array('id'. takes no arguments. 'form_class'). A complete form $form = new Forge(''.array('id' => 'article_form')). 'post').  $form->input('title')->label(true)->rules('required|length[3.'POST'. $form->input('article')->label('Article text')->rules('required|| valid_alpha_numeric'). validate() validate() validates a form. 'Add article'. echo $form->article->value.  as_array() as_array() returns an array with input names and values. Returns boolean.40]| valid_alpha_numeric')->value('title').

or  ->label('Custom input name').  ->label(TRUE).  ->rules('list|of|validation|rules') Input validation using Kohana Validation helper You can utlize rules from Validation helper by prefixing the rule with valid_. a rule normally  accessible by calling valid::ip would be utilized as:  ->rules('valid_ip') Input value Set the default value for the element.  In Kohana 2. Method is chainable. Also you can pass the custom label name. Input validation Set the validation rules for the field.  ->value('input_value') . Thus.2 changed to render()  Form Elements Note that all elements except for Form_Group inherit from Form_Input so methods below apply to  all of them. If the argument is boolean the input label will be based on the input  name.  Form_Input Create input Create an input. Method is chainable.error_format() html() Returns a rendered form as a string.  $form->input('input_name'). Method is chainable. Input label Show the field label or not. Method is chainable.

  Form_Dateselect Example $form->dateselect('date')->label(TRUE)->years(date('Y')-3. wrap it in the PHP strtotime function. Example $form->input('title')->label(TRUE)->rules('required|length[0.  * Dateselect uses Unix timestamp format internally to calculate dates. date('Y')+5)>value(strtotime($your_date_var)).255]')>value($this->page->title). Form_Checkbox By default a checkbox checked status is off to turn on just call the checked method and set to true. true| false)} where 'value' will be the value of the checkbox. 'Margarita'))- .  example  $form->input('title')->label(TRUE)->class('input_size').  Form_Dropdown You can set dropdown with single array or with two­dimensional array. Form_Checklist Example $form->checklist('blocks')->label('Blocks available')->options($option)>rules('required').  Example $form->checkbox('test')->label(TRUE)->value('1')->checked(TRUE).Extra Attributes You can add extra attributes to input and all other form elements by using attribute name.  Example $form->dropdown('pizzas')->label(TRUE)->options(array('Hawaiian'. * $option should be sent as an array with each value in the format {'value' = array('label'. To pass a MySQL date field  to the value() method. 'label' will be used as the label and the true| false indicates if the item is checked by default. * In the above example we are instructing Forge to generate years ranging from 3 years prior and 5  years after the current year. The key will be the option  value and the value will be the option text.

32]')->matches($form->password). In the view groups get special attention and are rendered differently.  Example $form->input('password')->label(TRUE). You can use groups for  example when you need to group some form elements within a `<fieldset>` tag.  Form_Hidden In the default template hidden forms are added straight after the <form> tag. All methods of the Forge  class are available save html(). 'MA'=>'Margarita'))->selected('1'). $group->dropdown('pizzas')->label(TRUE)->options(array('Hawaiian'. 'Stuffed'))->selected('2'). $form->input('passconf')->label('Password Confirmation')->rules('required| length[5. Form_Group Is an instance of the Forge class so you can have groups in your forms. 'Pan'.>selected('1').  Example $form->hidden('id')->value(1). Form_Textarea Example $form->textarea('description')->label(TRUE)->rules('length[0. .255]')>value($this->page->description). $form->dropdown('pizzas')->label(TRUE)->options(array('HA'=>'Hawaiian'.  Example $group = $form->group('pizzas')->label(TRUE). 'Margarita'))->selected('1'). Form_Password The method 'matches' matches a form field with another form field. $group->dropdown('bases')->label(TRUE)->options(array('Thin'. Form_Submit Example $form->submit('Submit Button Name').

  Otherwise it will create an unique name.  Using Custom Form Templates If you need more control over your form. The default upload path is configured your upload.php config file (system/config/upload. $form->input('username')->label(TRUE)->rules('required'). you can utilize a custom form template.kohanaphp. TRUE). specifies to View: application/views/login_form. it will overwrite this file. TRUE)->label(TRUE)->rules('required|size[200KB]| allow[jpg.html#msg3841  Example Controller: application/controllers/your_controller. $form->password('password')->label(TRUE)->rules('required').616.msg3841.Form_Upload Example If the file exists and the second argument of upload() method is TRUE.php  $form = new Forge().  from: http://forumarchive.g.php). You can write the HTML for label or form input fields  directly into your form view (e. but still want to take advantage of the automated validation  and field re­population provided by the Forge library.php  <form method="post" action="<?= url::site('login') ?>"> <?= $username->label() ?> <br /> <?= $username->html() ?> <br /> <?= $username_errors ?> <br /><br /> <?= $password->label() ?> <br /> <?= $password->html() ?> <br /> <?= $password_errors ?> <br /> <input type="submit" value="Login" /> </form> Note: You don't have to use →label().png.gif]').php/topic.com/index. Use $username→value to fill in the  values for input fields. if ($form->validate()) { // Do stuff } echo $form->html('login_form'. use a custom form // Only this is different.  . <label for=”…”>). This  allows you to design the form however you want using HTML.  $form->upload('file'.

php.  Once the module has been enabled in the standard way. It's workings are simple.css" type="text/css" /> <script type="text/javascript" src="/media/js/jquery. //defaults to true.sheet3. 'sheet3'))?> <?=media::script(array('jquery'. See http://learn.  Example: application/controllers/home. it will intercept requests for  /media/css/… and /media/js/… transforming the results as specified in the config file  media. renders the template after the controller method is done public function __construct() { . 'sheet2'.Saving forms as a library Using Forge you can save forms as a library and thus have access to your form throughout your  application.js"></script> Template Controller Template Controller Using the template controller you can set a template for your site.php  class Home_Controller extends Template_Controller{ public $template = 'template'.sheet2. It does not support images at the current time.  Media Module The Media Module is used to reduce the number and bandwidth of queries for CSS and JavaScript  files.dojo.com/2008/03/13/saving­forms­as­libraries/ for a short  tutorial. 'dojo'))?> Not to confuse matters the above is simply a helper for writing the following:  <link rel="stylesheet" href="/media/css/sheet1.  You then use the helpers to include them from your view pages like this:  <?=media::stylesheet(array('sheet1'.kohanaphp. //defaults to template but you can set your own view file public $auto_render = TRUE.  Configuration read the config for now  Usage Place all CSS files into the directory /application/views/media/css/ and all JavaScript files into  /application/views/media/js/.

 This all means you can change the  template and auto­render all in realtime.". $this->template->copyright = "&#169.php which extends the  template controller. //necessary } public function index() { $this->template->content= 'index page in a template'.php  class Test_Controller extends Template_Controller { public $template = 'base_page'.parent::__construct(). Me.= '<br><a href="test_2">page 2</a>'. so the template // is set up and ready for this pages content. // now create this page (Test) $test->heading = "Test :: Index Heading". 2008". } } The example illustrates a file application/controllers/home. Auto­render renders the template during the  post_controller event which is executed after the controller.  Save this as /application/controllers/test. . // // Load this page (Test) view $test = new View('test'). $test->content .  For a more detailed discussion of Template Learning Kohana: Template  Example 1 This is a simple example that shows the magic of the Template class. } function index() { // // don't forget that the __construct() is run // before this method. // All pages have some things in common such as // the page title: $this->template->title = "Welcome to Kohana!". this is the same as uncommenting the following line: $this->template = new View('base_page'). public function __construct() { parent::__construct(). The template controller can be found in  system/controllers/template. // add our content to the template view: $this->template->content = $test. It defaults to  'template' which is found in views/template. // // // // the template page 'base_page' is loaded by default.php. You set the template file in $template. $test->content = "Test :: Index :: content here.php.

?></title> </head> <body> <?php echo $content ?> <?php echo $copyright. alter the method:  public function __construct() { parent::__construct(). which views/test. Think of base_page as your base object.php inherits from. // add our content to the base view: $this->template->content = $test.php  <h1><?php echo $heading. } Save this as /application/views/test_menu. ?> </body> </html> Save this as /application/views/test. $test->content = "Test :: test_2 :: content here. Me.0.  Example 2 It is easy to add more interesting things in the construct() such as custom navigation menus for  this 'test section' of your website.php  . // the view is auto-render by default } } This uses the following 2 views:  Save this as /application/views/base_page. $this->template->copyright = "&#169.} // the view is auto-render by default function test_2() { // Load this page (Test) view $test = new View('test').php  <html> <head> <title><?php echo $title.1/Kohana/test/test_2  The Template class is nice because it removes the need to split a template into two files. 2008". // Look: $this->template->menu = new View('test_menu').= '<br><a href="index">page 1</a>'.0.".1/Kohana/test/ and http://127.0. // now create this page (Test) $test->heading = "Test :: test_2 :: Heading". $this->template->title = "Welcome to Kohana!".0. header and  footer. ?></h1> <p><?= $content ?></p> To test this browse to http://127. For example. $test->content .

float: right. ?></title> </head> <body> <?php echo $menu ?> <?php echo $content ?> <?php echo $copyright. border: 1px solid lightgreen.php to display the menu:  <html> <head> <title><?php echo $title. ?> </body> </html> Obviously you'll need to add some meaningful content to the views    ."> <ul> <li>menu 1</li> <li>menu 1</li> </ul> </div> Alter /application/views/base_page.<div style="width: 100px.

Libraries .

 Relative paths must be relative to the root website dir.txt").  Loading the archive library The Archive class is loaded into your controller using $this→load→library :  //load the archive class with the Zip driver to create Zip archives $this->archive=new Archive('zip'). or it can send the binary file directly to the user  without saving to the hard drive. save() save() saves the archive you've been creating to the disk. It accepts the following parameter:  • • [string] path to file or dir. download() download() offers the archive as a download to the user. .zip"). Relative paths must be relative to the root website dir.zip"). Access to the library is available through $this→archive  The second argument of the load­library function contains the name of the archive driver you want  to use.  • [string] path to save the archive file.  Methods add() add() adds files and directories to your archive.Archive Library Overview The Archive Library is a convenient way of constructing Archives (Zip Files. etc)  dynamically. Currently only a driver for Zip archives is available.  Currently it only supports Zip Archives.  • [string] name to be given to the archive file $this->archive->download("myarchive.txt being added to the archive:  $this->archive->add("files/uploads/file.  [boolean] whether to scan the dir recursively – default = TRUE This will result in file. $this->archive->save("myarchive. It can persist them to the file system. Tar Files.

$data.  $config['driver'] = 'file'.php file. $config['lifetime'] = 1800. Setting caches set $this→cache→set($id. It utilizes tags and id's to identify caches. $lifetime = NULL) is used to set  .  $config['params'] driver specific parameters (in above example ­ path to server writable  cache dir) $config['lifetime'] sets the lifetime of the cache.  Configuration Configuration is done in the application/config/cache.Cache Library Kohana's cache library can currently store caches in a file or SQlite. 0 means it will never be deleted automatically  $config['requests'] average number of requests before automatic garbage collection  begins. $config['params'] = APPPATH .  For the API documentation:  • not available yet View the page caching screencast from Woody Gilk (Shadowhand). config['driver'] sets the driver.$tags = NULL. if it's not there take the one from  system/config and copy it. Currently only file and SQlite are available. This is configurable by setting  the driver. $config['requests'] = 1000. Set to a negative number will disable automatic garbage collection  Available drivers • • • • • • APC ­ Alternative Php Cache Eaccelerator File Memcache SQlite Xcache Methods Loading the library $this->cache= new Cache. 'cache'. Specific lifetime can be set  when creating a new cache.

'French cheese'). delete_tag $this→cache→delete_tag($tag) deletes all cache items with a given tag.$tags). If none given the default lifetime from the  configuration file will be used. returns a boolean  $this->cache->delete('food'). print_r($this->cache->find('french')).array('french')).  $tagsdefaults to none. . returns a boolean  $this->cache->delete_tag('french').$data. $lifetime specific lifetime can be set. $tags=array('existentialism'. 'Simone de Beauvoir'). 'Albert Camus'. $this->cache->set('existentialists'.  • • • • $id The id should be unique $data If $data is not a string it will be serialized for storage.'philosophy'. returns the data or NULL  print_r($this->cache->get('existentialists')).caches.$food. retrieves all caches with the given tag.  $food=array('French bread'. $data=array('Jean Paul Sartre'. Finding and getting caches get $this→cache→get($id) retrieves a cache with the given $id. //returns: // Array ( [0] => Jean Paul Sartre [1] => Albert Camus [2] => Simone de Beauvoir ) find $this→cache→find($tag) supply with a string. //returns //Array ( [existentialists] => Array ( [0] => Jean Paul Sartre [1] => Albert Camus [2] => Simone de Beauvoir ) [food] => Array ( [0] => French bread [1] => French wine [2] => French cheese) ) Deleting caches There are several methods to delete caches  delete $this→cache→delete($id) deletes a cache item by id.'french'). an array should be supplied.'French wine'. This is useful when grouping caches  together. $this->cache->set('food'.

delete_all $this→cache→delete_all() deletes all cache items, returns a boolean 

SQLite Driver Schema
If you use the SQlite driver to store the caches the table can be constructed with this query. 
CREATE TABLE caches( id varchar(127), hash char(40), tags varchar(255), expiration int, cache blob);

Calendar Library
Provides methods for generating and working with a calendar. The library outputs a calendar month  in HTML, for use in the system view system/views/kohana_calendar.php 

Loading the calendar library
The Calendar class is loaded into your controller using: 
$this->calendar = new Calendar();

Access to the library is available through $this→calendar  The parameters of this constructor are: 
• • •

[integer] month [integer] year [boolean] put this argument on TRUE if you want weeks to start on monday (depends of  your localization)

$cal = new Calendar(1,2008); // January, 2008. The default is current month and year echo $cal->render(); // the view is automatically rendered from the library

Produces an HTML calendar  January 2008 Sun 28 6 13 Mon 29 7 14 Tue 1 8 15 Wed 2 9 16 Thu 3 10 17 Fri 4 11 18 Sat 5 12 19

20 27

21 28

22 29

23 30

24 31

25 26 1 2

Adjusting the calendar
The layout of the calendar can be adjusted by creating the following file: application/views/ kohana_calendar.php The native Kohana calendar file can be copied from  system/views/kohana_calendar.php to have template to start working from. 

Database Library
The database library provides database access to your application using drivers.  Currently we have the following drivers available:  1. 2. 3. 4. MySQL MySQLi PostgreSQL PDOSqlite (available in SVN)

Table of Contents
• • • • • • •

  Configuration     Connecting     Querying     Query Builder     Query Result     Metadata     Query Caching  

Quick Examples
The following is example code for using common database functionality. For more in depth help  please read the individual topics linked above.  Initializing the database
$db = new Database(); // or $db = new Database('groupname'); given // "default" is assumed if groupname is not

Simple Query
$result = $db->query('SELECT username,password,email FROM users'); foreach ($result as $row) { echo $row->username; echo $row->password;

echo $row->email; }

Quick Example 2
This demonstrates using the query results in a template.  Query
class Clients_Controller extends Controller { public function index() { $db = new Database; $result = $db->query('SELECT name, code FROM clients'); $v = new View('clients'); $v->result = $result; $v->render(TRUE); }


<html> <head> <style> /* * Zebra rows: When CSS3 is done we could simply use: * tr :nth-child(odd) { background-color: #D0D0D0; } * but for now we use PHP and CSS */ table.db tr { background-color: #F0F0F0; } table.db tr.odd { background-color: #D0D0D0; } table.db th { color: #f0f0f0; background-color: #303030; } </style> </head> <body> <h2>Client List</h2> <hr/> <table class="db"> <tr> <th>Client</th> <th>ID</th> </tr> <?php foreach( $result as $row ):?> <tr <?= text::alternate( '', ' class="odd"' ) ?>> <td><?= $row->name ?> </td> <td><?= $row->code ?> </td> </tr> <?php endforeach; ?> </table> </body>

net/mcrypt for more information.  $config['key'] = 'YOUR CYPHER KEY'.  $encrypted_text = $this->encrypt->encode('The Answer is 42'). .  $config['cipher'] sets the cipher to be used for encryption.  Loading the encryption library The Encryption class is loaded into your controller using $this→load→library :  $this->encrypt=new Encrypt.  You can choose what cypher you'd like the algorithm to use and you can specify your own key for  the encryption. decode($encrypted) $this→encrypt→decode($encrypted) returns a decrypted version of $encrypted using  the cipher and key specified in the configuration file. $config['mode'] = MCRYPT_MODE_NOFB. Access to the library is available through $this→encrypt  Configuration Configuration is done in application/config/encryption.Encrypt Library Overview The Encrypt Library provides an easy way to encrypt and decrypt data using symmetric keys. $config['cipher'] = MCRYPT_RIJNDAEL_128. $config['mode'] the MCrypt encryption mode to use.  $encrypted_text = $this->encrypt->encode('The Answer is 42').php if it's not there take the  one from system/config and copy it. echo $encrypted_text. It should be at least 16 characters long and  contain letters. and symbols. but you probably won't need to change this. numbers.  See http://php.  Methods encode($data) $this→encrypt→encode($data) returns an encrypted version of $data using the cipher  and key specified in the configuration file. config['key'] sets the key used for encryption. echo $this->encrypt->decode($encrypted_text).

 This method is chainable. [integer] Height in pixels of the resized image. (relative or absolute) must be passed as a  parameter. a path to the image file.  sharpen. the temporary image being written to a specified image file. Image::NONE) //Note: The output image is resized to width of 400 and height of 200. [integer] Master dimension. 200.  Methods resize() resize() is used to resize an image. using height to maintain aspect ratio./photo. 200. the aspect ratio will be  maintained automatically.Image Library Provides methods for the dynamic manipulation of images. Image::HEIGHT) // Note: Passing width = 400 has no effect on the resized width. Various image formats such as JPEG.  Load the Image Library in your controller using the new keyword:  $this->image = new Image('. cropped.  Image::HEIGHT. ImageMagick may be used if available. default is Auto.  All image manipulations are applied to a temporary image. rotated and sharpened. By default 'top' and 'left' use the 'center' offset. without maintaining the aspect ratio crop() crop() is used to crop an image to a specific width and height. Image::AUTO. maintain aspect ratio on height $this->image->resize(400. $this->image->resize(400.  Image manipulation methods can be chained efficiently. quality and rotate or flip  Loading the Image library Uses a driver. crop.  PNG. Access to the library is available through $this→image Some methods are chainable.  bundled with PHP.  When loading the library. configured in config/image. Image::WIDTH Example:  // Resize original image to Height of 200 pixels. By default.  The top and left offsets may be specified.php. The default driver uses the GD2 library. Recommended order: resize.jpg'). Options : Image::NONE. and GIF can be resized. This method is chainable. Only the save() method is  permanent.  • • • [integer] Width in pixels of the resized image. which is controlled by the 3rd argument.  .

 saving bandwidth and load time. This method is  chainable. quality() quality() Is used to adjust the image quality by a specified percentage. [integer] Height in pixels of the cropped image. Vertical = 6 Example:  // Rotate the image along the vertical access.• • • • [integer] Width in pixels of the cropped image. 'right'. Optimal amount is  about 20. sharpen() sharpen() Is used to sharpen an image by a specified amount.  • [integer] Degrees to rotate. by a maximum of 180 degrees. [integer] Left offset of input image. $this->image->crop(400. $this->image->rotate(-45) flip() flip() is used to rotate an image along the horizontal or vertical axis. Range is between 1 and 100. Horizontal = 5.  The image may be rotated clockwise or anti­clockwise. $this->image->sharpen(15). [integer] Top offset of input image. This method is chainable. (negative rotates anti­clockwise) There is no default. starting from the 'center' of the image from the 'top' and the 'center' of the image from the 'left' // to a width of 400 and height of 350. 'bottom'. 'center'. Example:  // Crop from the original image. 'center'.  • [integer] Percentage amount to adjust quality. The method is chainable. in order to reduce the file size of the  image. 350) rotate() rotate() is used to rotate an image by a specified number of degrees. Example:  // Rotate the image by 45 degrees to the 'left' or anti-clockwise. Optimal  .  • [integer] Sharpen amount to apply to image. pixel value or one of 'left'. Example:  // Sharpen the image by an amount of 15. Range is between 1 and 100. It cannot be used to actually improve the quality of an input  image. $this->image->flip(6).  Note: The method is for reducing the quality of an image. pixel value or one of 'top'.  • [integer] Direction. This method is chainable. There is no default.

 The default is to  overwrite the input image file. This method is NOT chainable.  • [string] The file path and output image file name.jpg').  $_POST./new-image. // Write the changed image to a new file in the original input folder echo Kohana::debug($image)./upload')). save() save() Is used to save the image to a file on disk. Full Example Place this code into a controller  // The original image is located in folder /application/upload.jpg'). '/'. $dir = str_replace('\\'. Example:  // Reduce image quality to 75 percent of original $this->image->quality(75). Input Library The input library is useful for two things: ­ pre­process global input for security ­ provide some  useful functions for retrieving input data  Note:  • • • The $_REQUEST and $_GLOBAL variables are not available within Kohana. Default is to overwrite input file.'moo. 350. // apply image manipulations $image->save($dir. It is  accessed by $this→input in the controller scope. // Instantiate the library $image->resize(400. realpath(dirname(__FILE__). POST and COOKIE data are sanitized when the Input library is loaded Loading the library This library is automatically loaded by the controller so you don't need to load it yourself.'/'. $image = new Image($dir.'super-cow-crop. // Display some useful info about the operation **for debugging only**. Accepts a relative or absolute file path.. // Save image to a new file. $_GET. NULL)->crop(400. There is no default. Global GET.jpg').percentage is from 75 to 85. // $this->image->save('.'/. 'top')->sharpen(20)->quality(75).  . $_COOKIE and $_SERVER are all converted to utf­8.  Example:  // Save image and overwrite the input image file $this->image->save().

  • [string] variable to retrieve – default = empty array (returns all variables) //POST variables are articleId=123 and file=text. It will result in HTML as:  Array ( [articleId] => 123 [file] => text.txt ) text.php?articleId=123&file=text.Methods get() allows you to retrieve GET variables.txt ) text.txt //Note that print statements are for documentation purpose only print Kohana::debug($this->input->get()). if global XSS filtering is on (config) then data returned by  this function will be filtered. print Kohana::debug($this->input->get('file')).  cookie() allows you to retrieve COOKIE variables. if global XSS filtering is on (config) then data returned  by this function will be filtered.  post() allows you to retrieve POST variables. if global XSS filtering is on (config) then data returned by this  function will be filtered.txt You can also manually XSS clean the request by passing TRUE as the second parameter.  • [string] variable to retrieve – default = empty array (returns all variables) //URL is http://www. print Kohana::debug($this->input->post('file')). It will result in HTML as:  Array ( [articleId] => 123 [file] => text.  • [string] variable to retrieve – default = empty array (returns all variables) .txt You can also manually XSS clean the request by passing TRUE as the second parameter.txt //Note that print statements are for documentation purpose only print Kohana::debug($this->input->post()).example.com/index.

0.  • [string] IP address to be validated This function is identical to the IP address validation helper.0'  if there's no IP.1 valid_ip() 'valid_ip' will check whether the specified IP is a valid IPV4 ip­address according to the RFC  specifications. Be careful! Even if global XSS filtering is  on. the data returned by this function will not be filtered!  .//COOKIE name is "username" and the contents of this cookie is "aart-jan". if global XSS filtering is on (config) then data returned  by this function will be filtered. print Kohana::debug($this->input->cookie('username')).  print $this->input->ip_address().  server() allows you to retrieve SERVER variables.0.  ip_address() 'ip_address' returns the IP­address of the user visiting using your webapplication. It returns '0. //this example ran on a local server It will result in HTML as:  localhost You can also manually XSS clean the request by passing TRUE as the second parameter. //this example ran on a local server It will result in HTML as:  127. It will result in HTML as:  Array ( [username] => aart-jan ) aart-jan You can also manually XSS clean the request by passing TRUE as the second parameter.0.  user_agent() 'user_agent' returns the user agent of the current request. //Note that print statements are for documentation purpose only print Kohana::debug($this->input->cookie()).  • [string] variable to retrieve – default = empty array (returns all variables) //Note that print statements are for documentation purpose only print Kohana::debug($this->input->server('HTTP_HOST')).0.

U. Windows NT 6. For example:  public function username_exists($name) { return (bool) self::$db->where('username'.0 (Windows. For example.11) Gecko/20071127 Firefox/2.  . ORM won't work.0. You do not need to put a construct method in every model!  Tutorial: Learn the Basics of the Kohana ORM Library  Important: The ORM library is a complete replacement of the Kohana Model library (it does not  extend the Model class) and creates a “static” connection to the database object.8. Therefore. This could result in HTML as:  Mozilla/5.  • [string/array] The string or the array of strings to clean echo $this->input->xss_clean($suspect_input).11 xss_clean() allows you to clean a string to make sure it is safe. } ORM conventions In order for ORM to work properly there are some conventions that must be upheld.print $this->input->user_agent().0.php  class User_Model extends ORM { } If you plan to override the constructor of the ORM model you need this code:  class User_Model extends ORM { public function __construct($id=FALSE) { parent::__construct($id). rv:1. It is not  loaded like other libraries but works in the model. ORM Library The ORM library is the Object­Relational mapper for Kohana. if you  create a custom method in a Model that extends ORM. It provides ways to handle records in  your database as if they were objects and it manages relationships between your tables.0. if you have a table users (plural)  you would have a model User_Model (singular) in your application/models directory as follows:  user. you need to access the Kohana database  library methods as “self::$db→___”. } } Without passing the $id to the parent. nl. $name)->count_records('users').1.

  • • A tutorial on the has_one/belongs_to relationship A tutorial on the has_many/belongs_to relationship A note about ORM relationships in Kohana: In ORM. when a relationship starts with “has_” it shows “ownership”. or if you want to think of it  another way. So. The primary reason for this is  to enable the ORM library to choosewhich table name comes first in a joining/pivot table. .//plural .g. For instance. then the table is albums_tracks.com'). e. //equivalent to $user=new User_Model. Relationships Relationships are declared in the model. ORM does not yet support this from both  directions.a student belongs to (one) dorm } These tutorials can help you with relationships in ORM. users Model names are the singular of the table name (e. . if tracks belongs_to_many  albums. $users=$user->find_all_by_email('example@example. the users  has_and_belong_to_many roles.g  Class Dorm_Model{ protected $has_many=array('students').  $users=ORM::factory('user')->find_all_by_email('example@example. e. //singular. $has_and_belongs_to_many = array().• • • • • Table names are plural. but roles just belong_to_many users.  In theory.  ORM Factory method You can also use the factory method to make chaining of methods easier. In the  example of users and roles. the table is called users_roles. user_id.com'). “parent” and “child”.g. $belongs_to = array(). you could flip the relationship. when you have users and roles. E. In reality.a dorm has many students } class Student_Model{ protected $belongs_to=array('dorm'). book_id Join tables are in the form {parent}_{child}. user) with _Model appended to the  model name. but you would be able to do $role→find_related_users().g. User_Model Each table has a primary key id (except for join tables) Foreign keys in a table are in the form of {related}_id. e. if you used roles as the “owner” object. you would not be able to do  $user→find_related_roles().g. because users “own” roles.  protected protected protected protected protected $has_one = array(). but ORM restricts finding to objects that “own” other  objects. It is vital you use pluralization and singularization correctly.g. it  makes sense that the user can find the roles they own. e. $has_many = array(). $belongs_to_many = array().

com'. You can use any number of values. or  $user->find_by_email_or_username('example@example.com'. } //output emails of all users find_by find_by sets the model to the first record that matches the criterion. but you can only use either _and_ or _or_. 'example').It gets the user model. eg:  $user->find_by_email_and_password('example@example. find_all find_all is equal to find(ALL)  foreach($user->find_all() as $person){ echo $person->email. // see find_all(). //equivalent to $user=new User_Model(1).1). Get the user with id=1 and delete it in the second line. $user->delete().  Methods find() find() is used to find a single record in a table if you supply the id of the record. $user->delete().  find_all_by find_all_by returns an array of all records that match the criterion  .  $user=new User_Model.com').  $user=ORM::factory('user'. This method is chainable. You can also use the second  argument to quickly find a record. echo $user->email. 'secret'). $user->find(1). Can also return  all records if you supply the constant ALL  Example  $user=new User_Model(). not both. A variation is you can use multiple values. //outputs the field email of table users of record with id = 1 $user->find(ALL). finds all records with a certain email address. $user->find_by_email('example@example.

an array of strings which associate to object models. an array of strings which associate to object models. $user->find_related_pages(). You must set a relationship in the model for this  to work. just like find_by (see above). remove Removes the $dog from the $pet_enthusiast.  For example if $has_many = array('dogs') then you can test for a relationship  if($pet_enthusiast->has_dog($dog)) { echo 'He has a dog!'.  Syntax /** * @param mixed $var Can be an object. . or a string which will be found using $model->find($var) * @return bool Can also return the boolean result from $model->save() */ $object->add_$model(mixed $var).com').  For example if $has_many = array('dogs') then you may  $pet_enthusiast→add_dog($dog).  find_related_ find_related_ returns the all related records. } add Used with the relationships defined in the model to provide handy relationship methods. //finds all related pages to user with id = 1 has Test for existence of relationship.  $user=new User_Model. or a string which will be found using $model->find($var) * @return bool Can also return the boolean result from $model->save() */ $object->remove_$model(mixed $var). $users = $user->find_all_by_email('example@example. $user->find(1).$user=new User_Model. You can use _and_ or _or_.  Syntax /** * @param mixed $var Can be an object.

  $user=new User_Model. //will update a the test@test. //alternate syntax $user->delete(ALL).com').com' Update example  $user=new User_Model. if it does it  uses an UPDATE statement. $user->delete_all().com user with a new email example@example.  Insert example  $user=new User_Model. delete_all delete_all deletes all records in the table. $user->find(1).com'. $user->find_by_email('test@test. $user->email='test@test. //will insert a new user into the table with email being 'test@test.  . to remove a dog $pet_enthusiast->remove_dog( $dog ). $user->save(). save save saves an object to the database.  $user=new User_Model. $user->save().com delete delete deletes the current object. If it doesn't exist it uses an INSERT statement.Example // For the pet enthusiast. $user->delete(). loaded clear Empties an object setting its properties to ' '. Also resets select and where  as_array Returns the object as an array with key/value pairs.com'). $user->email('example@example.

  auto_save If set to TRUE execute save() on the destruction of the object. You then don't have to call  save() manually.'desc')->limit(10)->find_all().  • Defaults to FALSE $user=new User_Model. role should be admin. needs to be last since it  will execute the actual query.  select Which fields to fetch  $user=new User_Model. $articles=$articles->orderby('id'. The following db builder methods cannot be used  • • • • query get list_fields field_data Note: when chaining methods like this.Properties where Which criteria should the query use. Will only select the email field. $user->auto_save=TRUE.com').'admin'). $user->find_by_email('example@example. Using DB Builder methods In Kohana's ORM you can still use some of the methods of the DB builder  Example  //Fetch the latest 10 articles $articles=new Article_Model(). Will add extra criterion. $user->select('email'). If it's set to FALSE and you don't call save() means losing changes made to  the object. find_all() or find().  $user=new User_Model. $user->where('role'. $user->find_by_email('example@example.com'). find_by() etc.  .

  The links refer to the Page number and Not the offset of the data. A method is provided to  help calculate SQL offsets. find(1)  will return the record with id=1.  user. Four  styles are provided. I. You may edit these to suit your needs. it generates links.  .php  class User_Model extends ORM { protected function where_key($id = NULL) { return 'name'.php  protected function where_key($id = NULL) { if ( ! empty($id) AND is_string($id) AND ! ctype_digit($id)) { return valid::email($id) ? 'email' : 'username'.  Please note that the library does not interact with your data in any way. « First   <  1  2  3  4  5  >   Last »  for navigating through pages in a website. } Now the method will check if the argument is a string. it will check for email validity and if  true will say the where_key is 'email' if not it is 'username'.  Pagination Library The Pagination library automatically generates styled links like.  The library is easily configurable. You can override the system settings by creating a  pagination config file in your application/config or by passing configuration settings to the  library at run time. If the argument is not a string it is taken  to be an digit and therefore an id and therefore the parent will return the where_key as being 'id'. If so. The  developer must write the code that fetches the data referred to by the links. Default Pagination Settings are located in  system/config/pagination. In your model you  can override the where_key() method so you can change the default criterion field.e.Changing the where key Be default the find() method will use the 'id' field as a criterion for selecting records.  You can expand this method for some extra tricks. You may also override the system styles by copying the views to your  application/views/pagination directory. } } Now find('your_username') as well as new User_Model('your_username') will work. custom  pagination view.  user. The same goes for new User_Model(1) syntax. or you can create a new. } return parent::where_key($id).  The page links are generated using a View file located in system/views/pagination.php.

create_links() In Kohana 2.  echo $this->pagination->sql_limit(). Allows  you to select the pagination style dynamically.  $this→pagination→sql_limit() is used to automatically generate SQL code.  // Will overwrite only the existing setting for this config item $this->pagination->initialize(array('uri_segment' => 'pages')).  $this→pagination→sql_offset() is used to calculate the offset of the row to fetch.  $this->pagination = new Pagination($config). from the  current page number and the configured items­per­page setting.  $this->pagination->sql_offset(). // returns sql row offset as an integer sql_limit() Note: this method is deprecated in version 2.2 create_links() has been renamed to render(). Access to the library is available through $this→pagination  Methods initialize() $this→pagination→initialize() is used to dynamically set pagination configuration.  unless you wish to overwrite a config setting dynamically. with the  correct LIMIT and OFFSET clause for the selected page number. This method will automatically calculate the required row offset for you. for the  selected link page number. The generated pagination links refer to a logical page number.  $this→pagination→create_links() is used to generate the link output for display. so there is no need to call this method explicitly. // outputs the SQL below .1 – use $this→pagination→sql_limit property  instead. It is  automatically called by the library constructor.Loading the Pagination library Load the Pagination class in your controller using the new keyword  Configuration settings are obtained from config/pagination.1 – use $this→pagination→sql_offset property instead. not an  SQL row number. Please note: The links may also be output by simply  echoing $this→pagination  // Will overwrite the default 'classic' style with 'digg' style $this->pagination->create_links('digg')). sql_offset() Note: this method is deprecated in version 2.php Settings may also be  passed dynamically to the class as an array.

echo 'done in {execution_time} seconds'. // pass a string as uri_segment to trigger former 'label' functionality 'total_items' => 254.$this->pagination->create_links('digg'). // it may be handy to set defaults for stuff like this in config/pagination. digg. // Just echoing it is enough to display the links (__toString() rocks!) echo 'Classic style: '. echo '<hr />PunBB style: '. // base_url will default to current uri 'uri_segment' => 'page'.$this->pagination->create_links('punbb'). extended. // use db count query here of course 'items_per_page' => 10.$this->pagination->create_links('extended').$this->pagination. // You can also use the create_links() method and pick a style on the fly if you want echo '<hr />Digg style: '. or add your own! )). This will output:  Classic style:  1 2 3 4 5 6 7 8 9 10 11 13 14 15 16 17 18 19 20 21 22 23 24 25 26 > last         › Digg style:  « previous 1 2 3 4 5 6 7 8 9 10 … 25 26 next         » . echo '<hr />Extended style: '.php 'style' => 'classic' // pick one from: classic (default). punbb.LIMIT 3 OFFSET 6 Pagination class properties The following pagination class properties are available for use in your controller:  • • • • • • • • • • • url current_page total_pages  current_first_item  current_last_item  first_page  last_page  previous_page  next_page sql_offset  sql_limit Example One $this->pagination = new Pagination(array( // 'base_url' => 'welcome/pagination_example/page/'.

10).Extended style:  « previous | page 1 of 26 | items 1–10 of 254 | next         » PunBB style:  pages: 1 2 3 … 26  If you are seeing “pagination. // Our URI will look something like http://domain/items/page/19 'total_items' => count($items->get_item_count()) // Total number of items. You have the option to either rename the existing pagination style to create a completely new  style (e. . Create a new directory called application/views/pagination 2. number of items to get $this->pagination = new Pagination(array( 'base_url' => 'items/page/'. // page to get starting at offset. do the following:  1. $content->items = $items->get_items($page_no.php) or keep the same name to override one of the default styles. } Excerpt from the View. $items = new Items_Model.g  classic.  To customize an existing style or create a new pagination style. Copy one of the existing pagination styles from system/views/pagination (e.next”. )). custom. // Note that other config items are obtained from the pagination config file. Pagination locale text is stored in “system/i18n/[your_locale]/pagination.  <h3>Items</h3> <?php echo $this->pagination->create_links() ?> Creating Customized Pagination Styles The default Kohana pagination styles are located in the system/views/pagination directory.php) to application/views/pagination 3.g. // Set our base URL to controller 'items' and method 'page' 'uri_segment' => 'page'. this is because Pagination uses Kohana::lang to look up the text  from your locale.php”  Example Two Excerpt from the controller method  public function page($page_no) { $content = new View('pages/items'). 'content' => $content )). $this->template->set(array( 'title' => 'Items'. showing how to display the links.

 you must reference the new  custom filename when creating your pagination links (e.  $payment = new Payment(). After you remove the non­required config lines.g. 3. An extremely easy API (only one method required to process a transaction!) Detailed error reporting Extensible with backend drivers to connect to many different payment gateways Support for credit card gateways as well as PayPal­like gateways Using the library is very simple. The  library can support using more than one driver per application by passing the driver name to the  constructor:  $paypal_payment = new Payment('Paypal'). $payment->card_num = '1234567890123456'.Note: If you create a new pagination style (by renaming the file).  Attributes The payment library has a set of default attributes it uses to send payments to the gateway.php there is a sample config for each payment gateway we support. $payment->exp_date = '0510'. Usually this  will include some sort of API username/password combination. and remove the drivers you are not using.  $this→pagination→create_links('custom'))  Payment Library Overview The payment library allows you to easily process e­commerce transactions without having to worry  about all the backend details of connecting and setting up the cURL options. so display an error page based on it } Configuration In system/config/payment. $authorize_payment = new Payment('Authorize'). if ($status = $payment->process() === TRUE) { // Report successful transaction } else { // $status has the error message. It has many features:  1. and process(). modify your driver config as needed. 2. Just set the fields required by your driver.  • • • • card_num exp_date cvv description . These  attributes are fairly self explanatory and are listed below. 4.  Simply copy this file to your application directory. but it differs for each driver.

 They may also have driver specific fields  that are noted in the Driver section.  Drivers The payment library uses drivers much like the Database library does in order to keep the API  consistent between payment gateways. After you set your attributes. It currently supports the following gateways:  . It is up to you  how to handle the failure. $attributes = array ( 'card_num' = '1234567890123456'. 'exp_date' = '0510' }. $payment->set_fields($attributes).  Methods The payment library has a minimal set of methods to use:  set_fields() This method allows you to set bulk payment attributes with an array. simply call this method in an if test. process() This method does the magic.• • • • • • • • • • • • • • • • • • • • amount tax shipping first_name last_name company address city state zip email phone fax  ship_to_first_name ship_to_last_name ship_to_company ship_to_address ship_to_city ship_to_state ship_to_zip Specific drivers may require some or all of these fields.  $payment = new Payment(). The  method returns TRUE on successful payment transaction or an error string on failure.

net Trident Gateway TrustCommerce YourPay. Tax and Shipping get added to the amount to form the grand total  inside the driver. exp_date 3. exp_date 3. 4. amount YourPay. 5. card_num 2. exp_date 3.net Required Fields 1.net Required Fields 1.net PayPal Authorize. amount TrustCommerce Required Fields 1. card_num exp_date amount tax shipping cvv Driver Specific Details The amount above is the subtotal. amount Trident Gateway Required Fields 1. 3. 3. Authorize.1. 2. 6. 5. card_num 2.  . 2. 4. card_num 2.

Required Fields 1. amount 2. payerid (after paypal authentication) Driver Specific Details Using the PayPal driver is a little different than a normal credit card transaction. It requires two  process() commands to be run. The first one will send the user to PayPal to authenticate, and the  second one will actually run the transaction. Below is an example of this. 
class Paypal_Controller extends Controller { // This will demo a simple paypal transaction. It really only comes down to two steps. function __construct() { parent::__construct(); } login $this->paypal = new Payment();

// This will set up the transaction and redirect the user to paypal to function index() { $this->paypal->amount = 5; $this->paypal->process(); }

// Once the user logs in, paypal redirects them here (set in the config file), which processes the payment function return_test() { $this->paypal->amount = 5; $this->paypal->payerid = $this->input->get('payerid'); echo ($this->paypal->process()) ? "WORKED" : "FAILED"; } // This is the cancel URL (set from the config file) function cancel_test() { echo 'cancelled'; } // Just some utility functions. function reset_session() { $this->session->destroy(); url::redirect('paypal/index'); } function session_status() { echo '<pre>'.print_r($this->session->get(), true); }


Writing Your Own Driver
There are many more payment gateways than there are drivers provided by Kohana. We encourage  you to write your own when you encounter a gateway not supported by the library. An easy way to  do it is like so:  1. Add a new entry in config/payment.php with your driver details. Use the previous entries as  an example. 2. Copy the Trident Gateway driver and rename it to *Gateway Name*.php 3. Alter the required fields array as instructed in the gateway's API manual (You have this,  right? ;) 4. Modify the fields array to include all the available relevant fields for the gateway 5. Modify the constructor to set default values from the config file (API username/password for  example) 6. Modify the set_fields() method to do variable translation (for example if your gateway names  cc_num something different. Look in your API manual for details.) 7. Modify the $post_url ternary statement to include the correct test and live mode API URLs 8. Modify how the return statement handles success and error based on what the specific  gateway status message is (Look in you API manual)

Profiler Library
The Profiler adds useful information to the bottom of the current page for debugging and  optimization purposes. 
• •

Benchmarks: The times and memory usage of benchmarks run by the Benchmark library. Database Queries: The raw SQL of queries executed through the Database library as well  as the time taken and number of affected rows. POST Data: The names and values of any POST data submitted to the current page. Session Data: All data stored in the current session if using the Session library. Cookie Data: The names and values of any cookies found for the current domain.

• • •

How to use
To enable the profiler output on your pages simply load the library: 
$this->profiler = new Profiler;

When loaded the profiler will add itself to the system.display event, calling the render() method when the page is being displayed and attaching the output to the bottom of the page.  The profiler can also be added to the library autoload list in config.php and it will automatically  be run on every page of your site. 

How to disable
The automatic rendering of the output can be disabled with the following code: 

This is mostly useful when autoloading the profiler to disable the output for certain pages. 

Getting the output
The rendered output may be returned as a string at any time during the page execution by passing  TRUE as the first parameter in render(): 
$output = $this->profiler->render(TRUE)

Note: This will stop any benchmarks currently being run. Only benchmarks and queries that have  been run up until this call will be shown in the output. 

Configure the profiler
Edit config/profiler.php to configure which items (post, cookie, session, database,  benchmarks) the profiler will show.  This change is made to application/config/profiler.php so as to apply only to the  specific application. 
/** * Show everything except database queries. (Other entries are default TRUE, read from system profiler config. */ $config['database'] = FALSE;

A complete profiler.php would look like this 
<?php defined('SYSPATH') or die('No direct script access.'); $config['post'] = FALSE; $config['cookie'] = FALSE; $config['session'] = FALSE; $config['database'] = FALSE; $config['benchmarks'] = TRUE;

Remember to set at least one of the items to TRUE otherwise the profiler will die in a trace error. 

Session Library
Enables applications to persist user state across pages. 

What are sessions?
Sessions enable you to store and retrieve data between requests on a per­user basis. Typically, since  each web page (or AJAX request, etc) is an individual request, there is no way to set a variable in  one request and get it's value in another. Sessions are one of several mechanisms that exist to  overcome this limitation.  Sessions are useful where a small amount of data needs to be persisted across most pages and that  data is specific to the particular browser session. For example, if your website has a “login” page,  you may wish to remember, for one specific web browser only, that a particular user has logged­in.  If you want to store more general data between requests and it is less of an issue that the data be 

$this->session->id(). or to a particular  controller method: Add the code:  $this->session = new Session.associated with only one browser session. a new  session is automatically started. The above line of code has two effects:  • • The Session library will be available via $this→session. Simply loading the Session library  is enough to create a new session.  id() $this→session→id() retrieves the ID of the current session.  Note that you do not need to call this method to enable sessions. If any current session data exists.  . other mechanisms may be more appropriate:  • •   Kohana's Cache library   PHP's shared memory facility Starting a Session To load the Session library. or retrieve data from an existing session. add the following code to your controller constructor.regenerate config value). including the browser cookie that is  used to identify it. Working with sessions The following methods are available in the Session library:  create() $this→session→create() can be called to create a new session. regenerate() $this→session→regenerate() causes the session ID to be regenerated whilst keeping all  the current session data intact. If no session data exists. It will destroy any current  session data.  Note. this is done automatically by the framework after a number of requests for security purposes  (set by the session.  For example.  destroy() $this→session→destroy() destroys all session data. it will become available.  echo 'Current session ID: ' .

$value = $this->session->get('foo'. get() returns an array containing all of the data in the current session. . or it can be an  array of “key ⇒ value” pairs (in which case the $val argument is ignored). the Session library also provides it's own methods to deal with session data. $_SESSION. For example. $val specifies the value of  that data. // set several pieces of session data at once by passing an array to set() $this->session->set(array('fish' => 5. to use the session  libraries driver. 'some_value').  For example. returns the string 'bar' instead.  // returns value of foo and deletes foo from the session.  // returns value of foo.  For example. In addition to this.  • • [mixed] $keys can either specify the name of the data to set in the session.Working with session data The Session library arranges for PHP's inbuilt sessions array.  • • [mixed] $key specifies the name of the data to retrieve from the session. // set some session data $_SESSION['fish'] = 5. If it doesn't exist. $value = $this->session->get_once('foo'). get_once() $this→session→get_once($key) works the same as get() except that it also deletes the  data from the current session afterwards. If $key is  FALSE. $val = FALSE) is used to set data in the current session. This means that accessing session data can be done in the normal way.  // set some_var to some_val $this->session->set('some_var'.'bar'). set() $this→session→set($keys. [mixed] if $keys is the name of the data to set in the session.  // get some session data $data = $_SESSION['fish']. For example. 'foo' => 'bar')).  These are:  get() $this→session→get($key = FALSE. $default = FALSE) retrieves a named value  from the session data. [mixed] $default specifies a default value to be returned if the named data does not exist  in the session.

 $val specifies the value of  that data.  As with other session data. // Don't delete the user_message this request $this->session->keep_flash('user_message').  • [mixed] $keys specifies the name of the piece of data to delete from the session. [mixed] if $keys is the name of the data to set in the session.  you wouldn't want to delete your user_message in the example above because it wouldn't have  been shown to the user by the AJAX request.del() In Kohana 2. It could.  // delete foo $this->session->del('foo'). keep_flash() Usually. 'bas')). 'Hello. 'fish' => 5)).  $this→session→keep_flash($keys) can be used to keep flash session data for one more  request (aka “freshening” flash data).2 del() has been renamed to delete(). Sometimes this behaviour is not  desired. // delete several pieces of data from the session by passing an array $this->session->del(array('bar'.  // set user_message flash session data $this->session->set_flash('user_message'. // set several pieces of flash session data at once by passing an array $this->session->set_flash(array('user_message' => 'How are you?'. "Flash" session Data “Flash” session data is data that persists only until the next request.  $this→session→del($keys) is used to delete a piece of data from the current session. For example. for example.  • • [mixed] $keys can either specify the name of the data to set in the session. It can also  be an array of several keys to be deleted. be used to  show a message to a user only once.  set_flash() $this→session→set_flash($keys. For example. or it can be an  array of “key ⇒ value” pairs (in which case the $val argument is ignored). flash data is automatically deleted after the next request.  • [string] $keys specifies the name(s) of the flash session variables to keep. though. // Don't delete messages 1-3 . For example. In this case. how are you?'). you retrieve flash data using $this→session→get(). $val = FALSE) sets flash data in the current  session. the next request might be an AJAX request for some data.

'regenerate' => 3.Session storage parameter. 'validate' => array('user_agent').php using the same name. Freshening multiple or all flash session variables is Kohana 2.Session parameters to validate * encryption .Default session name * validate .Encryption key. 'gc_probability' => 2 ). 'database' or 'native'.Percentage probability that garbage collection will be executed */ $config = array ( 'driver' => 'cookie'.Session driver name: 'cookie'.$this->session->keep_flash('message1'.php.2 functionality.'database' or 'native' * storage .php  /* * File: Session * * Options: * driver . 'storage' => ''. Session Storage By default session data is stored in a cookie. 'encryption' => FALSE. 'message3'). 'expiration' => 7200.  // Don't delete any flash variable $this->session->keep_flash(). You can change this in the file  config/session.  Using a Database The storage setting in config/session.Number of seconds that each session will last (set to 0 for session which expires on browser exit) * regenerate . 'message2'. set to FALSE to disable session encryption * expiration . The driver can be set to 'cookie'. used by drivers * name .  Table schema CREATE TABLE `kohana_session` ( `session_id` varchar(40) NOT NULL. Session name and  other configuration options can also be set here.Number of page loads before the session is regenerated (set to 0 for NO automatic regeneration) * gc_probability . .  Configuring a Session Edit the config file application/config/session. 'name' => 'kohanasession'.php must be set to the name of the database table. If you don't supply any arguments to the function all current flash session variables will be  freshened. if this is not  found it will use the default.  Optionally you can add a group in config/database.

PRIMARY KEY (`session_id`) ) Using a Cache The storage setting in config/session.php must be set to  Cache config $config['driver'] = 'cache'. $config['storage'] = array( 'driver' => 'apc'. Returns  $default when the segment does not exist. 'item value'). article 2. 'requests' => 10000 ).  $session=Session::instance(). No need to do it yourself  Methods segment() segment($index = 1. Session::instance()->set('session_item'. URI Library The URI class provides the methods for working with URI's and URI segments. `data` text NOT NULL.example. $default = FALSE) retrieves a specific URI segment.php/article/paris/hilton/ The segments would be:  1.  //url: http://www. $var = $session->get('session_item).com/index. Lifetime does not need to be set as it is overridden by the session expiration setting. paris .  $var = Session::instance()->get('session_item'). If no instance is  available one will be created.  Note: This library is initialized automatically by Kohana.`last_activity` int(10) UNSIGNED NOT NULL. If you use routing it  also has methods to work with rerouted URI's.  Instance To retrieve the instantiated session library you can use the instance() method. Session instance methods can be called directly.

// Returns FALSE rsegment() Identical to segment() except that it uses the rerouted URI to retrieve the segments from. When a string is given as first argument. // returns: hilton argument() argument() returns the requested arguments. 'spears'). it will return the  segment following the string. hilton echo $this->uri->segment(3). // returns: article/paris/hilton/ last_segment() last_segment() returns the last segment of an URI  echo $this->uri->last_segment(). //returns 3 string() string() returns the entire URI as a string  echo $this->uri->string(). // Returns 'spears' Note: this method also accepts strings. // returns: array( 'hilton' ) . // Returns 'hilton' echo $this->uri->segment('hilton'). This differs from segments as it will only look at  the arguments given and skip the controller and method segment.$associative) returns an array of all the URI segments  total_segments() total_segments() returns the number of segments  echo $this->uri->total_segments(). // Returns 'paris' echo $this->uri->segment('paris').  echo $this->uri->segment('article'). // Returns 'hilton' echo $this->uri->segment(4.  echo $this->uri->argument(1).  segment_array() segment_array($offset.3. // returns: hilton argument_array() argument_array() returns an array containing all arguments  echo $this->uri->argument_array().

  echo $this->uri->total_arguments(). Pocket IE or Opera mini). and returns  TRUE if this is the case. and returns TRUE if this is the case. // returns: 1 build_array() This method only exists in version 2.  Loading the library $this->user_agent = new User_agent.  if ($this->User_agent->is_mobile() == TRUE) { echo 'Hello mobile!'. a search engine spider).g. It can then be accessed through $this→user_agent. and  returns TRUE if this is the case.g.  Methods is_browser() Checks if the current request is being made by a webbrowser.  if ($this->User_agent->is_browser() == TRUE) { echo 'Hello browser!'. All methods in this library rely on data provided  by the visitor's webbrowser. } .  if ($this->User_agent->is_robot() == TRUE) { echo 'Hello robot!'.2. so it could be faked. } is_robot() Checks if the current request is begin made by a robot(e. It's functionality will move  to the Kohana core class. } is_mobile() Checks if the current request is begin made by a mobile browser(e.total_arguments() total_arguments() returns the total number of arguments.2  User Agent Library This library is deprecated and will no longer be available in Kohana 2.

 anf alse if this is not the case.g. and  FALSE if it isn't. } Properties browser Contains the name of the browser. 'Firefox' or 'Internet Explorer') print Kohana::debug($this->User_agent->browser).11) Gecko/20071127 Firefox/2. The accept_lang checks the Accept­Language header for the specified language. and returns TRUE if it is.0. It could result in HTML as:  Mozilla/5.0. The accept_charset function checks if the specified charset is found in this header.  print Kohana::debug($this->User_agent->agent).  • [string] Charset to check for – default = “utf­8” if ($this->User_agent->accept_charset('utf-8') == TRUE) { echo 'I\'m glad you accept UTF-8 charset!'.11 . U. } else { // Send result in English echo 'Hello world!'. and  returns TRUE if this language is in the Accept­Language Header. agent Contains the complete user agent string. } accept_charset() The Accept­Charset header specifies the visitor's accepted charsets. nl. } else { echo 'Please start supporting UTF-8'.0.8. rv:1.1.accept_lang() The Accept­Language header specifies in which language the visitor would like his request to be  returned.  // Prints name of the browser on screen (e.  • [string] Language to check for – default = 'en' if ($this->User_agent->accept_lang('nl') == TRUE) { // Send result in Dutch if accepted echo 'Hallo wereld!'.0 (Windows. Windows NT 6.

 but you'll probably want to handle this differently. the first record. That's up to you. The associated value is an array with 2 records.2.kohanaphp.11 referrer Contains the referer string. The  . This  probably should be the same one you called it when telling the user what to put in that field.  The friendly name. check the validation helper. if the request has been made by a mobile device.com/2008/02/23/a­peek­at­kohanas­new­ validation­library/  Getting started Load the Library In the code below.2  A new validation library will be released in Kohana 2. $somearray is an array passed to the validation class for approval.  Information on its syntax:http://learn.  print Kohana::debug($this->User_agent->version).mobile Contains the name of the mobile browser. The associative array has several keys given the  name of a field assigned in the HTML of the form.  This library will see significant API changes in Kohana 2. Setup the Rules The rules are setup as an associative array of arrays. is the name you'd like to be used in the error message. It can simply  be $_POST if you desire. It is available in the subversion repository  and is a complete rewrite of the current library.  print Kohana::debug($this->User_agent->mobile). It could result in HTML as:  2. Validation Library If you're searching for some pre­made validation functions. It could result in HTML as:  Opera Mini version Contains the browser version.0.  $validation = new Validation($somearray).0.  print Kohana::debug($this->User_agent->referer).

 such as putting them in a list. Validating Input Run the validation Use  $validation->run().30]'). if ($validation->run()) .  $validation->set_rules(array( // Format: // key friendly name. '=trim|required[2.50]| valid_email_rfc'). Notice that the string {message} is replaced by the actual error message. '=trim|required[2. 'Email' => array('Email Address'. validation rules 'FirstName' => array('First Name'. )). to return the error in validation. to run the comparison of your $array that you passed when you initialized the validation.'=trim|required[5. Rules are a pipe delimited series of methods that are applied to  the string.30]'). If you wanted to simply  add a horizontal rule after each one you could code that like this:  $validation->error_format("{message}<hr/>"). 'Email' => array('Email Address'.30]').  $validation->error_format("<li>{message}</li>"). Complete Example Code $validation = new Validation($_POST). 'LastName' => array('Last Name'. validation rules 'FirstName' => array('First Name'. you  can run this code before displaying the error string. )).  Report the Errors Use the code  $validation->error_string. These are returned in a format that you can show to your users.'=trim|required[2.second part is the validation rules. This will  return true if the array had no validation errors in it. If this is desired. if ( ! empty($_POST)) { $validation->set_rules(array ( // Format: // key friendly name.50]|valid_email_rfc'). but  you may want to format this a bit more closely. '=trim|required[5. '=trim|required[2.30]'). 'LastName' => array('Last Name'. It will return false if there was an issue.

 Note: The key name has to match the function name that it corresponds to.g.  array('First Name'.30]'). or length value is out of  required[30] ­ same as required| range parameters exact_length[30]  . $validation->error_format("<li>{message}</li>"). 'omg callback error'). //will effectively call $this->validation->valid_password($data). This is very  useful when utilizing custom callback validation functions. 'callback_valid_password|required[2. Rules Rule  required  Parameter  Yes  Description  Example  required[1.30] ­ same as required| Return FALSE if form field is  min_length[1]|max_length[30] or  empty. } Using PHP functions on fields Precede the rule with =. ?> <p>Your form failed validation. Please review the following issues with your form and resubmit it.  E.{ } else { print("Your form successfully validated."). Using your own custom callbacks Precede the rule with callback_  Example  array('First Name'.30]'). '=trim|required[2.  public function _tester($value) { $this->validation->set_message(__FUNCTION__.</p> <ul> <?php echo $validation->error_string ?> </ul> <?php } } set_message() Allows customization of the error message that is displayed upon failed validation for a specific  function. 'one'). $this->validation->add_error(__FUNCTION__.

min_length Yes  max_length  Yes  exact_length  Yes  valid_email_ No  rfc  valid_email  No  valid_url  valid_ip  alpha  utf8_alpha  alpha_nume ric  utf8_alpha_ numeric  alpha_dash  utf8_alpha_ dash  digit  utf8_digit  numeric  No  regex  No  depends_on  Yes  range  No  Yes  No  Yes  Return FALSE if length field  value is less than parameter  Return FALSE if length field  value is greater than parameter  Return FALSE if length field  value is not same as parameter  Return FALSE if email is not  rfc822 valid  Return FALSE if email is not  valid  Return FALSE if url is not valid  Return FALSE if ip is not valid  Return FALSE if form field  does not consist only of  alphabetical characters  Return FALSE if form field  does not consist only of  alphabetical or numeric  characters  Returns FALSE if form fields  defined in parameter is not  filled in  depends_on[field_name]  Variable prepping Name  Parameter  Description  prep_for_form  prep_for_url  strip_image_tags  xss_clean  encode_php_tags  .

Helpers .

print Kohana::debug($optical_discs). The two arguments are:  • • [array] The array you want to rotate [boolean] Do you want to keep the same keys in the rotated array? – TRUE by default Example:  // Please note that the print() statements are for display only $optical_discs = array ( 'CD' => array('700'.  Methods rotate() 'rotate' rotates an array (two­dimensional) matrix. print ('<br /><br />'). print Kohana::debug($optical_discs). FALSE). '780'). 'DVD' => array('4700'. It will result in HTML as:  Array ( [CD] => Array ( [0] => 700 [1] => 780 ) [DVD] => Array ( [0] => 4700 [1] => 650 ) [BD] => Array ( [0] => 25000 [1] => 405 ) ) Array ( [0] => Array ( [CD] => 700 [DVD] => 4700 .'405') ).Array Helper The Array helper assists in transforming arrays via the rotate() and remove() methods. $optical_discs = arr::rotate($optical_discs. 'BD' => array('25000'.'650').

$cd = arr::remove('CD'. print Kohana::debug($cd). 'BD' => array('25000'. 'DVD' => array('4700'. It will result in HTML as:  Array ( [CD] => Array ( [0] => 700 [1] => 780 ) [DVD] => Array ( [0] => 4700 [1] => 650 ) [BD] => Array ( [0] => 25000 [1] => 405 ) ) .'650'). print ('<br />'). $optical_discs). '780').  The two arguments are:  • • [string] The key you want removed from an array [array] The array you want the key to be removed from Example:  // Please note that the print() statements are for display only $optical_discs = array ( 'CD' => array('700'. print ('<br />').[BD] => 25000 ) [1] => Array ( [CD] => 780 [DVD] => 650 [BD] => 405 ) ) remove() 'remove' removes a key from an array and returns it. print Kohana::debug($optical_discs).'405') ). print Kohana::debug($optical_discs).

// FALSE (not found) echo arr::binary_search('45'. '50'. '30'. $my_array). it returns the key of the array  value it finds. [array] The sorted array you want to search in [boolean] Return the nearest value. // 3 echo arr::binary_search('35'. or simply return FALSE (the default) [boolean] Sort the array before searching Example:  $my_array = array('10'. '80'). echo arr::binary_search('50'. $my_array.  . TRUE). TRUE). // 2 range() Cookie Helper Provides methods for working with COOKIE data. // 3 echo arr::binary_search('45'. $my_array. By default. '20'. The four arguments are:  • • • • [mixed] The value you want to find.Array ( [0] => 700 [1] => 780 ) Array ( [DVD] => Array ( [0] => 4700 [1] => 650 ) [BD] => Array ( [0] => 25000 [1] => 405 ) ) binary_search() 'binary_search' performs a basic binary search on an array. $my_array).

example. Note: Requires at least PHP version 5. get() cookie::get() accepts multiple parameters. ). for which the cookie may be written. 5. secure: The cookie will only be allowed over a secure transfer protocol (HTTPS). cookie::set($cookie_params). $domain.  $cookie_value = cookie::get($cookie_name. For site­wide cookies. Only the cookie name is required. $value. domain: A valid domain. and not via client scripts. $xss_clean = FALSE). $secure. $httponly.php. Default is  FALSE. $path. starting from when the cookie is set. $expire. $prefix.com 3.  Returns FALSE if the cookie item does not exist. path: A valid path for which the cookie may be written. $prefix). 2.2. until  expired by the browser. 'expire' => '86500'. Or you may pass an associative array of values as a parameter:  $cookie_params = array( 'name' => 'Very_Important_Cookie'. only the cookie name and value are required.example. You may  override these settings by passing parameters to the helper. Set the number of seconds the cookie should persist.0 Methods set() cookie::set() accepts multiple parameters. Note: Set to 0 (zero) seconds  for a cookie which expires when the browser is closed. This  method is identical cookie::set() but sets the cookie value to '' effectively deleting it. You  may pass parameters to this method as discrete values:  cookie::set($name. Default is ''. Default is the root directory '/' 4. Setting the third parameter to TRUE will filter the cookie for unsafe data. Only the cookie name is required. Default is  FALSE.  . Default is '' (Use on  localhost). httponly: The cookie can be accessed via HTTP only.  delete() cookie::delete() accepts multiple parameters. 'prefix' => 'one_'. prefix your domain with a period .Configuration Default settings for cookies are specified in application/config/cookie.  1. 6. 'path' => '/'.com'. expire: The cookie lifetime. 'domain' => '. prefix: A prefix may be set to avoid name collisions. 'value' => 'Choclate Flavoured Mint Delight'.

10. print ($time). It will result in HTML as:  616046400 317325312 dos2unix() 'dos2unix' converts DOS time into UNIX time The one arguments is:  • [int] DOS timestamp Example:  // Please note that the print() statements are for display purposes only $time = 317325312.cookie::delete('stale_cookie'). It will result in HTML as:  317325312 616046400 offset() 'offset' calculates the seconds between two timezones The two arguments are:  • • [int] remote timezone [mixed] use local time? – default is TRUE – else enter your own  Example:  . print ($time). 31. 0. 0. Date Helper The Date helper assists in formating dates and times allowing for addition and conversion between  different formats. print ($time). $time = date::dos2unix($time). print ($time). $time = date::unix2dos($time). 1987).  Methods unix2dos() 'unix2dos' converts UNIX time into DOS time The one arguments is:  • [int] UNIX timestamp Example:  // Please note that the print() statements are for display purposes only $time = mktime(0.

'<br />'). print Kohana::debug(date::seconds(2.1.400)). 'GMT'). print Kohana::debug(date::seconds(100. It will result in HTML as:  -3600 3600 0 seconds() 'seconds' creates an array of numbers based on your input The three arguments are:  • • • [int] step (count by) – default = 1 [int] start number – default = 0 [int] end number – default = 60 Example:  // Please note that the print() statements are for display purposes only print Kohana::debug(date::seconds()). print (date::offset('CST'.200.7)).// Please note that the print() statements are for display purposes only // This example was executed in the EST timezone print (date::offset('CST').'<br />'). 'MST').'<br />'). It will result in HTML as:  Array ( [0] => 0 [1] => 1 [2] => 2 [3] => 3 [4] => 4 [5] => 5 [6] => 6 [7] => 7 [8] => 8 [9] => 9 [10] => 10 [11] => 11 [12] => 12 [13] => 13 [14] => 14 [15] => 15 [16] => 16 [17] => 17 [18] => 18 [19] => 19 [20] => 20 [21] => 21 [22] => 22 [23] => 23 [24] => 24 [25] => 25 [26] => 26 [27] => 27 [28] => 28 [29] => 29 . print (date::offset('UTC'.

) [30] [31] [32] [33] [34] [35] [36] [37] [38] [39] [40] [41] [42] [43] [44] [45] [46] [47] [48] [49] [50] [51] [52] [53] [54] [55] [56] [57] [58] [59] => => => => => => => => => => => => => => => => => => => => => => => => => => => => => => 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 Array ( [1] => 1 [3] => 3 [5] => 5 ) Array ( [200] => 200 [300] => 300 ) minutes() Please see seconds.  hours() 'hours' counts the number of hours there are left in a day or from a specific start point The three  arguments are:  • • • [int] step (count by) – default = 1 [boolean] 24­hour time? – default = FALSE [int] start hour – default = 1 Example:  .

TRUE. date('g'))). print Kohana::debug(date::hours(1. print Kohana::debug(date::hours(1.// Please note that the print() statements are for display purposes only // This example ran at 6:10PM EST print Kohana::debug(date::hours()). print Kohana::debug(date::hours(1. // 24-hour format of an hour without leading zeros It will result in HTML as:  Array ( [1] => 1 [2] => 2 [3] => 3 [4] => 4 [5] => 5 [6] => 6 [7] => 7 [8] => 8 [9] => 9 [10] => 10 [11] => 11 [12] => 12 ) Array ( [9] => 9 [10] => 10 [11] => 11 [12] => 12 [13] => 13 [14] => 14 [15] => 15 [16] => 16 [17] => 17 [18] => 18 [19] => 19 [20] => 20 [21] => 21 [22] => 22 [23] => 23 ) Array ( [22] => 22 [23] => 23 ) Array ( [18] [19] [20] [21] [22] [23] ) => => => => => => 18 19 20 21 22 23 . 9)). TRUE. 22)). TRUE.

print Kohana::debug(date::ampm(13)). // 24-hour format of an hour without leading zeros It will result in HTML as:  AM PM PM days() 'days' counts the number of days there are in a specific month of a specific year The two arguments  are:  • • [int] month (1­12) [int] year – default: current year Example:  // Please note that the print() statement is for display purposes only print Kohana::debug(date::days(5.2007)). It will result in HTML as:  Array ( [1] => 1 [2] => 2 [3] => 3 [4] => 4 [5] => 5 [6] => 6 [7] => 7 [8] => 8 [9] => 9 [10] => 10 [11] => 11 [12] => 12 [13] => 13 [14] => 14 [15] => 15 [16] => 16 [17] => 17 [18] => 18 [19] => 19 [20] => 20 [21] => 21 [22] => 22 [23] => 23 .ampm() 'ampm' calculates whether the supplied integer makes the hour AM or PM The one argument is:  • [int] hour to calculate Example:  // Please note that the print() statements are for display only // This example ran at 5:45PM EST print Kohana::debug(date::ampm(1)). print Kohana::debug(date::ampm(date('G'))).

2002)). It will result in HTML as:  Array ( [2002] [2003] [2004] [2005] [2006] => => => => => 2002 2003 2004 2005 2006 . print Kohana::debug(date::years(1998. It will result in HTML as:  Array ( [1] => 1 [2] => 2 [3] => 3 [4] => 4 [5] => 5 [6] => 6 [7] => 7 [8] => 8 [9] => 9 [10] => 10 [11] => 11 [12] => 12 ) years() 'years' returns an array with the years between the specified years.) [24] [25] [26] [27] [28] [29] [30] [31] => => => => => => => => 24 25 26 27 28 29 30 31 months() 'months' returns an mirrored array with the month­numbers of the year. The two arguments are:  • • [int] start year– default = current year ­ 5 [int] end year – default = current year + 5  Example:  // Please note that the print() statements are for display purposes only // This example ran in 2007 print Kohana::debug(date::years()).  Example:  // Please note that the print() statement is for display purposes only print Kohana::debug(date::months()).

days.days')). print Kohana::debug(date::timespan($timestamp. // timestamp of 651 days ago $timestamp2 = time() .) [2007] [2008] [2009] [2010] [2011] [2012] => => => => => => 2007 2008 2009 2010 2011 2012 Array ( [1998] [1999] [2000] [2001] [2002] ) => => => => => 1998 1999 2000 2001 2002 timespan() 'timespan' returns the time between two timestamps in a human readable format The arguments are:  • • • [int] timestamp 1  [int] timestamp 2 – default: current timestamp [string] format – default: 'years.months. print Kohana::debug(date::timespan($timestamp. time().seconds' Example:  // Please note that the print() statements are for display purposes only // This example ran in 2007 $timestamp = time() .(60*60*24*7*31*3). print 'minutes: '. 'minutes')).weeks. 'years. $timestamp2)). // timestamp of 350 days ago print Kohana::debug(date::timespan($timestamp)). time().minutes.Kohana::debug(date::timespan($timestamp.hours. It will result in HTML as:  Array ( [years] => 1 [months] => 9 [weeks] => 2 [days] => 2 [hours] => 0 [minutes] => 0 [seconds] => 0 ) Array ( [years] => 1 [days] => 286 ) Array ( [years] => 0 [months] => 10 [weeks] => 0 [days] => 1 .(60*60*24*7*50).

// For a file located in application/downloads // Use relative path download::force('.  Methods force() 'force' forces a download of a file to the user's browser.txt'). // OR use the defined application path download::force(APPPATH.txt').txt").  • • $filename ­ [string] filename of the file to be downloaded – default = ”” $data ­ [string] data to be sent if the filename does not exists – default = ”” Example:  // File path is relative to the front controller download::force("file. . This function is binary­safe and will work  with any MIME type that Kohana is aware of. It will result in HTML as:  23 Download Helper The download helper assists in forcing downloading of files by presenting users with the “save as”  dialog./application/downloads/file. The two arguments  are:  • • [int] hour in non­24­hour format [string] AM or PM Example:  // Please note that the print() statements are for display only print Kohana::debug(date::adjust(11.[hours] => 0 [minutes] => 0 [seconds] => 0 ) minutes: 937440 adjust() 'adjust' converts an hour integer into 24­hour format from a non­24­hour format.'downloads/file. 'PM')).

$message.  . The page is  retrieved by the browser from it's own cache. If not. 'username'=>'yourusername'.php file you can select the driver type which are native. More information on client­side page  caching can be found at caching­php­performance  Allows setting a page cache time by sending Last­Modified and Expires headers for the page.com'. the page is expired and a new  page must be ouput. email::send($to. $from.com'. 'port'=>'25'). 'password'=>'yourpassword'. If so. Example:  $to 'Name') $from $subject $message = 'from@example.com'. TRUE).php  Inside the config/email. = 'This is an <strong>example</strong> message'.  Configuration The swiftmailer configuration for this helper is found in config/email. $subject. $config['options'] = array('hostname'=>'yourhostname'. The parameters are:  • • • • • [string] address to send email to [string] address to send email from [string] subject of the email [string] body of the email [boolean] send email as HTML (defaults to false) = 'to@example.Email Helper An Email helper to work with the Swift email library. Expires Helper Provides methods for managing browser aware page caching. a 304 not­modified status header and NO data is sent. smtp  Example: using smtp  $config['driver'] = 'smtp'. sendmail. // Address can also be array('to@example.  Allows checking if the page is older than the page cache time. = 'This is an example subject'. Methods connect() send () 'send' sends an e­mail using the specified information.

 Default is 60 seconds. The objective is to cache the page for ten  seconds.'). */ class Welcome_Controller extends Controller { public function index() { .  Example  if (expires::check_headers()) echo 'Safe to send Expires header'. the cached page data should be displayed.  * [integer] The time in seconds.  Example  expires::set(300). Called internally by  expires::check() You would not normally call this function directly.  Example  expires::prevent_output() // will set Kohana::$output = ''. Default is 60 seconds. browser page cache. The single parameter is. until page expires. in seconds. check() expires::check() Determines if a cached page needs to be refreshed.  Controller:  <?php defined('SYSPATH') or die('No direct script access. The single parameter is:  • [integer] The time. Full Example The controller outputs a page from a single method. to add to the last modified time. prevent_output() expires::prevent_output() Has no parameters. as it clears the Kohana  output buffer.Methods set() expires::set() Sets an expiry time for a local. If the page is reloaded within ten seconds.  Example  if (expires::check(300) === FALSE) check_headers() expires::check_headers() Has no parameters. Called internally by expires::set() Returns boolean TRUE if a Last­Modified or Expires header has NOT been sent. /** * Default Kohana controller.

org/rss/1.example. 08 Dec 2007 12:57:56 GMT</pubDate> </item> .example.0" encoding="UTF-8"?> <rss xmlns:content="http://purl. Use the code above on this RSS feed:  <?xml version="1.  • • [string] remote feed url.if (expires::check(10) === FALSE) expires::set(10).com/article546</link> <description>This article is really cool too!</description> <author>Aart-Jan Boor</author> <pubDate>Sat.com/article34</link> <description>This article is really cool!</description> <author>Aart-Jan Boor</author> <pubDate>Sat. $welcome->render(TRUE).xml".org/feedburner/ext/1. but the browser that fetches a locally cached page $welcome->now = date(DATE_RFC822).0"> <channel> <item> <title>Some feed item</title> <link>http://www.0" version="2.  Methods parse() 'parse' parses a RSS feed and returns the parsed feed as an array. print Kohana::debug(feed::parse($feed)).0/modules/content/" xmlns:feedburner="http://rssnamespace. it is not this data that is cached. // We should only see the time updated in the view after 10 seconds // note. } } View:  <h2>Welcome!</h2> <p>It is now <?php echo $now ?></p> <hr/> Feed Helper The Feed helper assist in the parsing of remote RSS feeds. or local file path [int] maximum amount of items to parse – default = 0 (infinite) $feed = "feed. 08 Dec 2007 13:28:11 GMT</pubDate> </item> <item> <title>Some feed item2</title> <link>http://www. $welcome = new View('welcome').

08 Dec 2007 12:39:42 GMT</pubDate> </item> </channel> </rss> It will result in HTML as:  Array ( [0] => Array ( [title] => Some feed item [link] => http://www. 08 Dec 2007 12:57:56 GMT ) [2] => Array ( [title] => Some feed item3 [link] => http://www.<item> <title>Some feed item3</title> <link>http://www.example.  Methods extension() 'extension' runs a regular expression check. returning the entire string after the last period (. 08 Dec 2007 13:28:11 GMT ) [1] => Array ( [title] => Some feed item2 [link] => http://www.com/article34 [description] => This article is really cool! [author] => Aart-Jan Boor [pubDate] => Sat.example. 08 Dec 2007 12:39:42 GMT ) ) File Helper A helper designed to manipulate files and filenames.) .) – also  known as the file extension The parameters are:  • • param: [string] filename to check extension of return: [string] entire string after last period (.com/article4523 [description] => This article is the best! [author] => Aart-Jan Boor [pubDate] => Sat.com/article4523</link> <description>This article is the best!</description> <author>Aart-Jan Boor</author> <pubDate>Sat.example.com/article546 [description] => This article is really cool too! [author] => Aart-Jan Boor [pubDate] => Sat.example.

mp3'.8 MB large echo (file_exists($file)) ? file::split($file. Example:  $file = 'humpty_dumpty. // output name echo file::join($file_in. without .mp3'. for each chunk to be return: [integar] The number of pieces that were created.$file_out). conf mime() 'mime' finds the MIME­type of a file first by using PHP's built­in database and then Kohana's  MIME configuration file (system/config/mimes. . assuming a .mp3.003 humpty_dumpty. 4 Directory listing:  -rwxrwxrwx -rw-r--r--rw-r--r--rw-r--r--rw-r--r-1 1 1 1 1 www-data www-data www-data www-data www-data www-data www-data www-data www-data www-data 8186302 2097152 2097152 2097152 1894846 2008-05-06 2008-05-06 2008-05-06 2008-05-06 2008-05-06 20:11 20:15 20:15 20:15 20:15 humpty_dumpty. my_movie.')'. Example:  $file_in = 'humpty_dumpty.php).ogg' echo $file.ogg (application/ogg) split() 'split' splits a file into pieces matching a specific size indicated in megabytes. // from our last example $file_out = 'humpty_dumpty-back_together_again.004 join() 'join' joins splited files (possibly by file::split()).FALSE. if different then an the filename return: [integar] The number of pieces that were joined.conf').Example:  echo file::extension('/etc/apache2/apache2.mp3 humpty_dumpty.mp3.002 humpty_dumpty. in MB.mp3'.001 humpty_dumpty.mp3.2) : 'can not find file!' .mp3. // pretend it is 7.' ('.000 extension param: [string] output filename. The parameters are:  • • • • param: [string] file to be split param: [string] directory to output to. The parameters are:  • • • param: [string] split filename. FALSE if not found Example:  $file = 'my_movie.### extension. defaults to the same directory as the file param: [integar] size.file::mime($file). The parameters are:  • • param: [string] filename to check MIME­type of return: [mixed] string if found.

 using POST to submit  the form to the current page.  print form::open(string $submit.4 Directory listing:  -rwxrwxrwx 1 www-data www-data -rw-r--r-.001 humpty_dumpty.html // CSS class 'search_form' is applied print form::open('products/search'. $options. Where $submit is a relative URL like '/class/method' and $attr is an array with attributes.mp3 8186302 2097152 2097152 2097152 1894846 8186302 2008-05-06 2008-05-06 2008-05-06 2008-05-06 2008-05-06 2008-05-06 20:11 20:15 20:15 20:15 20:15 20:17 humpty_dumpty.  the submission URL will be assumed to be the page being submitted from. It does not do validation or  filtering.1 www-data www-data -rw-r--r-. All three can be left blank. like  array('id' ⇒ 'forumid'. array $hidden ).mp3. array $attr. If you want to generate your forms with validation and filtering you can do so with the  Forge library  Getting Started You'll need to use a line like this to begin the form. array('class'=>'search_form')).004 humpty_dumpty- Form Helper The Form helper provides methods to assist you in creating forms. $hidden is an array of  hidden form fields.tld/products/search.1 www-data www-data -rw-r--r-.  print form::open() To add attributes:  // Submits the page to: domain.mp3. $selected) print form::textarea($data) print form::input($data) Methods open() In order to open the form. Here are some examples.  print form::dropdown($data.mp3 humpty_dumpty. If you leave the first blank.003 humpty_dumpty.002 humpty_dumpty. you simply need to: This uses the default values.1 www-data www-data -rw-r--r-.mp3. but the option exists to create them using  php. 'class'⇒'login_form').  Adding Fields You may add form fields as you would in straight HTML.mp3.1 www-data www-data back_together_again. .1 www-data www-data -rw-r--r-.

array('type'=>'product')). You must specify an encoding type attribute of  'multipart/form­data'. The parameters are:  • [string]/[array] data for key attributes . 'field_value').php/welcome" enctype="multipart/form-data" method="post"> input() Creates an HTML form input tag. // use only 1 parametr . and add a hidden input field named 'type' with value: 'product' print form::open(''.// Stay on the current page.  Example:  print print print name. array('enctype' => 'multipart/form-data')). when using a name [string] extra string attached to the end of the attributes Example:  print form::input('field_name'. form::input(). Results in HTML  <form action="http://localhost/index. Defaults to a text type. array('method'=>'get'))." /> It's not necessary to use all parameters.  Examples:  // Submits multipart form data to the current page print form::open(''. // use only 2 parameters . // don't use parameters form::input('field_name'). ' style="text-align: right. 'field_value'. array(). open_multipart() Opens a form for submitting binary data via POST.for name and id form::input('field_name'. The parameters are:  • • • [string]/[array] data input name and id or an array of HTML attributes [string] input value."').for id and value Result in HTML:  <input type="text" id="" name="" value="" /> <input type="text" id="field_name" name="field_name" value="" /> <input type="text" id="field_name" name="field_name" value="field_value" /> hidden() 'hidden' generates a hidden form field. // Sending a form to the current page using GET print form::open(''. Result in HTML:  <input type="text" id="field_name" name="field_name" value="field_value" style="text-align: right.

' id="fieldId"'))."fieldValue")). It will result in HTML as:  <input type="hidden" id="fieldName" name="fieldName" value="fieldValue" /> <input type="hidden" id="field1" name="field1" value="value1" /> <input type="hidden" id="field2" name="field2" value="value2" /> password() 'password' generates a password form field. $array=array('name'=>'fieldName'."fieldValue")).'value'=>'fieldValue'. 'class' => 'your-class').'class'=> 'formField'). 'path/to/local/file') Result in HTML:  .'field2'=>'value2'). $array=array('field1'=>'value1'."fieldValue". print Kohana::debug(form::hidden($array)). It will result in HTML as:  <input type="password" id="fieldName" name="fieldName" value="fieldValue" /> <input type="password" id="fieldName" name="fieldName" value="fieldValue"id="fieldId" /> <input type="password" id="fieldId" name="fieldName" value="fieldValue" class="formField" /> upload() Generate HTML form input tag type “file” for upload files:  The parameters are:  • • • [string]/[array] ­ attribute name or array of attributes [string] ­ attribute value [optional] [string] ­ extra additional [optional] Example  $attributes = array('name' => 'file_1'.'id'=>'fieldId'. print Kohana::debug(form::password($array)). The parameters are:  • • • [string]/[array] data for key attributes [string] value of the field – default = ”” [string] extra string to be added to the end of the attributes – default = ”” Example:  // Please note that the print() statements are for display purposes only print Kohana::debug(form::password("fieldName". echo form::upload($attributes. print Kohana::debug(form::password("fieldName".• [string] value of the field – default = ””  Example:  // Please note that the print() statements are for display purposes only print Kohana::debug(form::hidden("fieldName".

  . string $value) The parameters are:  • • [string]/[array] textarea name or an array of HTML attributes  [string] textarea value.  print form::textarea(string/array $data. Result in HTML:  <textarea name="field_name">field_value</textarea> We can also use array for the first parameter. The parameters are:  • • • • [string]/[array] input name or array of HTML attributes [array] the select options. 'class' => 'our_class')). 'field_value'). 'custom' => 'Custom'). Look at this example:  print form::textarea(array('name' => 'field_name'. 'value' => 'field_value'. when using input name [string] the option to be selected by default [string] extra string to be added to the end of the attributes – default = ”” Example:  $selection = array('basic' =>'Basic'. // The 'standard' option will be the default selection print form::dropdown('input_dropdown'. Results in HTML  <select id="input_dropdown" name="input_dropdown"> <option value="basic">Basic</option> <option value="standard" selected="selected">Standard</option> <option value="custom">Custom</option> </select> checkbox() Creates a 'tick box' type selection box.'standard').<input type="file" name="file_1" value="path/to/local/file" class="your-class" / > textarea() Creates an HTML form textarea tag. when using a name Example  print form::textarea('field_name'. Result in HTML:  <textarea name="field_name" class="our_class">field_value</textarea> dropdown() Creates a drop down selection box. 'standard' => 'Standard'.$selection.

'is_rich'). form::checkbox('check_money_box'. form::radio('radio_cute_box'. 'Always send me Spam (Opt in): '). TRUE).The parameters are:  • • • • [string/array] input name or an array of HTML attributes [string] input value. form::label('radio_single_box'. 'I am rich: '). 'I am cute: '). when using a name [boolean] make the checkbox checked by default [string] a string to be attached to the end of the attributes form::label('check_spam_box'. 'Never send me Money (Opt out): '). form::radio('radio_single_box'. TRUE). when using a name [boolean] make the radio selected by default [string] a string to be attached to the end of the attributes form::label('radio_cute_box'.'<br />'. 'is_cute'). 'I am single: '). Example:  print print print print Results in HTML  <label for="check_spam_box">Always send me Spam (Opt in): </label> <input type="checkbox" id="check_spam_box" name="check_spam_box" value="send_spam" /> <label for="check_money_box">Never send me Money (Opt out): </label> <input type="checkbox" id="check_money_box" name="check_money_box" value="send_no_money" checked="checked" /> Browser output:  Always send me Spam (Opt in): Never send me Money (Opt out):  radio() Generates a 'radio' type selection box.  The parameters are:  • • • • [string/array] input name or an array of HTML attributes [string] input value.'<br />'. 'send_spam'). form::radio('radio_rich_box'. form::label('radio_rich_box'. form::label('check_money_box'. but allows for easier multiple selections. 'send_no_money'. Example:  print print print print print print Results in HTML  <label for="radio_cute_box">I am cute: </label> <input type="radio" id="radio_cute_box" name="radio_cute_box" value="is_cute" / ><br /> <label for="radio_single_box">I am single: </label> <input type="radio" id="radio_single_box" name="radio_single_box" value="is_single" checked="checked" /><br /> <label for="radio_rich_box">I am rich: </label> <input type="radio" id="radio_rich_box" name="radio_rich_box" value="is_rich" / ><br /> Browser output  . 'is_single'. form::checkbox('check_spam_box'. similar to checkbox.'<br />'.

Results in HTML  <input type="submit" id="submit" name="submit" value="Send" /> button() Creates a button for the form. Results in HTML  <button type="button" id="button" name="button">Does not do Much</button> label() Creates a label for a form entry field. 'Send'). 'Does not do Much'). when using a name [string] a string to be attached to the end of the attributes Example:  print form::button('button'. Results in HTML  <label for="imageup">Image Uploads</label> . Note this is not the same as the button associated with input type  'submit' or 'reset'.  The parameters are:  • • • [string/array] input name or an array of HTML attributes [string] input value.  The parameters are:  • • • [string/array] input name or an array of HTML attributes [string] input value. 'Image Uploads').I am cute:  I am single:  I am rich:  submit() Creates a 'submit' type button for the form.  The parameters are:  • • • [string/array] label “for” name or an array of HTML attributes [string] label text or HTML [string] a string to be attached to the end of the attributes Example:  print form::label('imageup'. when using a name [string] a string to be attached to the end of the attributes Example:  print form::submit('submit'.

Returns an attribute string, from an array of HTML attributes in key/value format, sorted by form  attributes first.  The parameters are: 

[array] HTML attributes array

print form::attributes(array('id' => 'input_name', 'class' => 'submission'));

id="input_name" class="submission"

Creates a fieldset opening tag  The parameters are: 
• •

[array] an array of HTML attributes [string] a string to be attached to the end of the attributes

print form::open_fieldset(array('class' => 'important'));

Results in HTML 
<fieldset class="important">

Generates a fieldset closing tag  Example: 
print form::close_fieldset();

Results in HTML 

Creates a legend for describing a fieldset.  The parameters are: 
• • •

[string] legend text or HTML [array] an array of HTML attributes [string] a string to be attached to the end of the attributes

print form::legend('More about you', array('id' => 'more_infos'));

Results in HTML 
<legend id="more_infos">More about you</legend>

In order to close the form, you simply need to: 
print form::close()

Or you can set parameter: 
print form::close('</div>')

Result in HTML: 

HTML Helper
The HTML helper assists in calling various elements such as stylesheet, javascript, image links and  anchor links into position. 

'specialchars' is similar to PHP's htmlspecialchars() function. However, there are some small  differences: 
• • •

It will automatically use the UTF­8 character set in conversion (instead of ISO­8859­1). It will automatically translate both single and double quotes to HTML entities (instead of  only double quotes). It provides built­in fallback functionality for not double encoding existing HTML entities  (for PHP versions older than 5.2.3). [string] The string you want to encode [boolean] Do you want to encode existing HTML entities? – TRUE by default

The two arguments are: 
• •

$string = '<p>"I\'m hungry"&mdash;Cookie Monster said.</p>'; echo html::specialchars($string);

It will result in the following HTML: 
&lt;p&gt;&quot;I&#039;m hungry&quot;&amp;mdash;Cookie Monster said.&lt;/p&gt;

When setting the second parameter to FALSE, existing HTML entities are preserved. Look closely  at &mdash;. 
echo html::specialchars($string, FALSE);

&lt;p&gt;&quot;I&#39;m hungry&quot;&mdash;Cookie Monster said.&lt;/p&gt;

This method is deprecated and will not be available in Kohana 2.2. Use PHP function  http_build_query() instead  'query_string' creates a HTML query string from an array. The one argument is: 

[array] The string you want to encode

echo html::query_string(array ( 'id' => 12, 'page' => 'home' ));

It will result in HTML as: 

'anchor' creates a HTML anchor (<a href=””></a>), linking an internal page or external site  automatically The four arguments are: 
• • • •

[string] An internal or external page that you would like to link to [string] The title you would like to have show up as the hyperlink [string] Attributes to add to your anchor [string] The protocol your link will use: 'ftp', 'irc', etc. – This is only necessary if it's an  internal page with a non­absolute link for the first argument and you need to change the  protocol from 'http'

Example 1: 
echo html::anchor('home/news', 'Go to our news section!');

It will result in HTML as: 
<a href="http://localhost/home/news">Go to our news section!</a>

Example 2: 
echo html::anchor('irc://irc.freenode.net/kohana', 'Join us on IRC!', 'style="font-size: 20px;"');

It will result in HTML as: 
<a href="irc://irc.freenode.net/kohana" style="font-size: 20px;">Join us on IRC! </a>

Similar to 'anchor', 'file_anchor' creates a HTML anchor (<a href=””></a>) linking to non­Kohana  resources. Therefore, it will always prefix the site's URL to the path of your file The four arguments 

'/kohana'.html'. etc. . hex or raw randomly to help prevent spam and e­mail harvesting. 'ftp'). 'irc'. It will result in HTML as:  <a href="http://localhost/media/files/2007-12-magazine. 'Join us on our custom IRC!').com').html" id="id432">The Public Linux Archive</a> panchor() Similar to 'anchor'. – This is only necessary if you need to  change the protocol from 'http' Example 1:  echo html::file_anchor('media/files/2007-12-magazine. 'Check out our latest magazine!'). The three arguments are:  • • • [string] E­mail address [string] The title you would like to have show up as the hyperlink [string] Attributes to add to your anchor Example:  echo html::mailto('info@example. 'irc'.are:  • • • • [string] An internal file that you would like to link to [string] The title you would like to have show up as the hyperlink [string] Attributes to add to your anchor [string] The protocol your link will use: 'ftp'. etc. It will result in HTML as:  <a href="ftp://localhost/pub/index. 'The Public Linux Archive'.pdf'. – This is only necessary if it's an  internal page with a non­absolute link for the first argument and you need to change the  protocol from 'http' [string] An internal or external page that you would like to link to [string] The title you would like to have show up as the hyperlink [string] Attributes to add to your anchor Example:  echo html::panchor('irc'. but accepts the protocol attribute first instead of last The four arguments are:  • • • • [string] The protocol your link will use: ''ftp'. It will result in HTML as:  <a href="irc://localhost/kohana">Join us on our custom IRC!</a> mailto() 'mailto' prints a <a href=“mailto:”></a> tag but escapes all characters of the e­mail address into  HTML. 'id="id432"'.pdf">Check out our latest magazine!</a> Example 2:  echo html::file_anchor('pub/index.

&#101.It will result in HTML as:  <a href="&#109.">i&#x6e.&#116.&#x78.&#101.com/tutorials/video/working_with_media_files.  alternate) [string or array] Either a string or array with values for the 'type' attribute  (application/rss+xml etc.</a> stylesheet() 'stylesheet' calls CSS files internally and will suffix .&#109. screen  etc.) [boolean] set to TRUE to specify the suffix of the file. Will render the <link> tag.php file included in the link – This  makes the difference between processing the request through Kohana (usually a media  controller) or simply calling the file with an absolute path Example:  echo html::stylesheet(array ( 'media/css/default'.g. It will result in HTML as:  <link rel="stylesheet" href="http://localhost/media/css/default.  link() 'link' calls files such as feeds internally.e&#x2e.) .&#108.&#109. Linking to stylesheets also uses  the <link> tag but the html::stylesheet() helper can be used for those Arguments  • • • • • [string or array] Either a string with the file's location or an array of files [string or array] Either a string or array with values for the 'rel' attribute (e.&#x6f. 'media/css/menu' ).&#x63.&#x63.&#111. 'print' or 'aural' [boolean] Set to TRUE if you want to have the index.fo&#x40.i&#x6e. 'print' ). defaults to FALSE [string or array] Either a string or array with values for the 'media' attribute (print.&#105. FALSE).css if it is not already present The three  arguments are:  • • • [string or array] Either a string with the file's location or an array of files [string or array] Media type such as 'screen'.&#x61 .mp&#108.mp&#108.html).&#x61.e&# x2e.&#097.&#058.fo&#x40. stylesheet.php” in the  URL (this will be the case until you modify this setting as explained in the tutorial from Christophe  http://kohanaphp.css" media="print" /> Important Don't forget to add a final TRUE parameter if your Kohana frameworks still need “index. array ( 'screen'.&#x6f.css" media="screen" /> <link rel="stylesheet" href="http://localhost/media/css/menu.&#x78.

array('application/rss+xml'. FALSE).php” in the  URL (this will be the case until you modify this setting as explained in the tutorial from Christophe  http://kohanaphp.'application/atom+xml') .com/tutorials/video/working_with_media_files.php file included in the link – This  makes the difference between processing the request through Kohana (usually a media  controller) or simply calling the file with an absolute path Example:  echo html::link(array ( 'welcome/home/rss'. FALSE). It will result in HTML as:  <script type="text/javascript" src="http://localhost/media/js/login.com/tutorials/video/working_with_media_files. 'alternate'. It will result in HTML as:  <link rel="alternate" type="application/rss+xml" href="http://localhost/welcome/ home/rss" /> <link rel="alternate" type="application/atom+xml" href="http://localhost/welcome/home/atom" /> Important Don't forget to add a final TRUE parameter if your Kohana frameworks still need “index.php file included in the link – This  makes the difference between processing the request through Kohana (usually a media  controller) or simply calling the file with an absolute path Example:  echo html::script(array ( 'media/js/login'. 'media/js/iefixes.js' ).• [boolean] Set to TRUE if you want to have the index.js"></script> <script type="text/javascript" src="http://localhost/media/js/iefixes.html).html).js"></script> Important Don't forget to add a final TRUE parameter if your Kohana frameworks still need “index. 'welcome/home/atom' ).  .js if not present in your file call There are two  arguments are:  • • [string or array] Either a string with the file's location or an array of files [boolean] Set to TRUE if you want to have the index.  script() 'script' calls JavaScript files internally and will suffix .php” in the  URL (this will be the case until you modify this setting as explained in the tutorial from Christophe  http://kohanaphp.

com/tutorials/video/working_with_media_files. 'rel="lightbox"'). It will result in HTML as:  <img src="http://localhost/media/images/thumbs/01.png'.png" width="100" height="100" alt="Thumbnail" /> Example 2 (with html::anchor and lightbox):  echo html::file_anchor('media/images/01.png" /></a> Important Don't forget to add a final TRUE parameter if your Kohana frameworks still need “index.png'.'.html). border-bottom: 1px solid #000. 'class' => 'image' ) ).image() 'image' creates a 'img' HTML tag. border-bottom: 1px solid #000.php” in the  URL (this will be the case until you modify this setting as explained in the tutorial from Christophe  http://kohanaphp.  There are two arguments are:  • • [string or array] A string to specify the image 'src' attribute or an array of attributes [boolean] Set to TRUE if you want to have '/index.php/' included in the link (to use views to  serve images using Kohana) Example 1:  echo html::image('media/images/thumbs/01. It will result in HTML as:  <a href="http://localhost/media/images/01. 'alt' => 'Thumbnail')). html::image('media/images/thumbs/01.png" /> echo html::image(array('src' => 'media/images/thumbs/01. 'height' => 100.  attributes() 'attributes' parses attributes for a HTML tag from an array There are two arguments are:  • [array] An array of attributes you'd like to add to a HTML tag Example 1:  echo html::attributes( array ( 'style' => 'font-size: 20px. It will result in HTML as:  style="font-size: 20px.png').png')." rel="lightbox" class="image" . 'rel' => 'lightbox'. <img src="http://localhost/media/images/thumbs/01.png" rel="lightbox"><img src="http://localhost/media/images/thumbs/01. 'width' => '100'.

'rel' => 'lightbox'. borderbottom: 4px solid #000. //returns TRUE inflector::uncountable('book').png'." rel="lightbox" class="image">See my picture!</a> breadcrumb() The function returns an array of links for each segment.'.language')  inflector::uncountable('money'). border-bottom: 4px solid #000.php file. will produce the following output:  Array ( [0] => <a href="http://localhost/ajax">Ajax</a> [1] => <a href="http://localhost/ajax/welcome">Welcome</a> [2] => <a href="http://localhost/welcome/text">Text</a> ) Inflector Helper Provides methods for working with the pluralization and singularization of words as well as other  methods to work with phrases. Arguments:  • segments to use as breadcrumbs.Example 2 (with html::anchor):  echo html::file_anchor('home/images/01. It will result in HTML as:  <a href="http://localhost/home/images/01. 'class' => 'image' ) ) ).png" style="font-size: 20px. html::attributes( array ( 'style' => 'font-size: 20px.  Methods uncountable() inflector::uncountable($string) checks whether the given string is an uncountable  word. //returns FALSE . defaults to using Router::$segments Example:  echo Kohana::debug(html::breadcrumb()). 'See my picture!'. Returns TRUE or FALSE.  This method uses a words list from the inflector. located into the system/i18n/en_EN/ folder  (or the language specified in the config item 'locale.

 Returns the string. Note: this function  works for English words only. If a string is uncountable it will return the string without modification. //returns 'book' plural() inflector::plural($string) will attempt to pluralize the given string. //returns 'books' camelize() inflector::camelize($string) will attempt to camelize the given string. Returns the  string. //returns 'Underscores_a_phrase.  inflector::camelize('system_initialization'). //returns 'Remove underscores from a phrase. Note: this function works for  English words only. Returns the  string.').  Returns the string.'). Returns the string. //returns 'systemInitialization' underscore() inflector::underscore($string) makes a phrase underscored instead of spaced.  inflector::plural('book').singular() inflector::singular($string) will attempt to singularize the given string.' humanize() inflector::humanize($string) makes a phrase human­readable instead of dashed or  underscored. //returns 'Remove dashes from a phrase.' Number Helper Provides methods for rounding integer numbers.' inflector::humanize('Remove-dashes-from-a-phrase.  inflector::singular('books').  .').  inflector::humanize('Remove_underscores_from_a_phrase.  inflector::underscore('Underscores a phrase. //returns 'systemInitialization' inflector::camelize('system initialization').  If a string is uncountable it will return the string without modification.

 and a nearest integer number to  round too.  • [string] String to be stripped $string = '<b>Check this image:</b> <img src="http://www.com/example.9.3. 5) ?> </p> <?php endforeach ?> This will output as HTML  <p>Rounding numbers to nearest 5</p> <p>Round 1 to 0 </p> <p>Round 3 to 5 </p> <p>Round 5 to 5 </p> <p>Round 9 to 10 </p> <p>Round 99 to 100 </p> <p>Round 999 to 1000 </p> Security Helper The security helper assist in verifying the security of use input.example.jpg .  Example  // Given an input of: $numbers = array(1.  Methods xss_clean() 'xss_clean' behaves the same as xss_clean in the Input library.5.  • [string] String to be cleansed strip_image_tags() 'strip_image_tags()' strips the image tags out of a string and returns the string trimmed without the  image tags.jpg" />'. defaults to 5.99.com/example.Methods round() num::round() accepts two arguments. print Kohana::debug(security::strip_image_tags($string)).999). It will result in HTML as:  <b>Check this image:</b> http://www. An integer to round. <p>Rounding numbers to nearest 5</p> <?php foreach ($numbers as $number): ?> <p>Round <?php echo $number ?> to <?php echo num::round($number.example.

encode_php_tags() 'encode_php_tags' replaces PHP tags in a string with their corresponding HTML entities. $short_description = text::limit_words($long_description. print Kohana::debug(security::encode_php_tags($string)).  $long_description = 'The rain in Spain falls mainly in the plain'.'.'. The number of parameters determines the  . Text Helper Provides methods for working with Text.  $long_description = 'The rain in Spain falls mainly in the plain'. $limit = 4. Generates:  The r alternate() text::alternate() accepts multiple parameters. Generates:  The rain in Spain limit_chars() text::limit_chars() accepts multiple parameters. $end_char = '&amp. Only the input string is required. $end_char. $limit. $end_char = '&amp.?php echo "<b>Hello World!</b>" ?&gt. $short_description = text::limit_chars($long_description.nbsp. Only the input string is required. $end_char). It will result in HTML as:  &lt. $preserve_words = FALSE. $limit = 4. The  default end character is the ellipsis. $preserve_words).nbsp.  Methods limit_words() text::limit_words() accepts multiple parameters.  • [string] String to santize $string = '<?php echo "<b>Hello World!</b>" ?>'. The  default end character is the ellipsis. $limit.

echo text::random($type = 'alnum'. The input string and an array of marker  words is required.  • $bytes ­ Supply the number of bites .$force_unit. $replace_partial_words = FALSE). For values that don't match any of the above. a­z and A­Z alpha ­ a­z. bytes() text::bytes($bytes.$si) Returns a human readable size. the characters passed in will be used. $replacement.  $str = 'The income tax is a three letter word. $badwords.alternation.'. // Outputs: path/to/something ?> censor() text::censor() accepts multiple optional parameters. echo reduce_slashes($str). Returns a random text string of specified  length.'boom'). Generates:  The income *** is a three letter word.  Possible values for $type are:  • • • • • • alnum ­ 0­9.  <?php $str = "path/to//something". } //returns 12boom12 random() text::random() accepts multiple optional parameters. 'scum'). reduce_slashes() text::reduce_slashes() reduces multiple slashes in a string to single slashes. A­Z numeric ­ 0­9 nozero ­ 1­9 distinct ­ Only distinct characters that can't be mistaken for others. $badwords = array('tax'. but telemarketers are scum. Returns a string with the marker words censored by the specified replacement  character. $replacement = '*'. This is handy if you loop through something and you for example want to alternate the  color of a table row.'2'. $length = 10).$format. echo text::censor($str. but telemarketers are ****.  for($i=0:$i<5:$i++) { echo text::alternate('1'.

'GiB'). //returns 2.NULL. Donec . Generates  http://localhost/kohana/ url::base() accepts two optional parameters. Generates  . GB etc) text::bytes('2048'). NULL.php. //returns 4.'kB'). $format ­ format of the return string $si ­ Defaults to TRUE.php. Set the first parameter to TRUE if you want to  append the index_page defined in config. 'https'). A widow word is a single word at the end of a paragraph on a new line.  Methods base() url::base() returns the base URL defined by the site_protocol and site_domain in  config.php' echo url::base(TRUE.  • $string ­ String with potential widow words $paragraph='Lorem ipsum dolor sit amet.. URL Helper Provides methods for working with URL(s).30 kB text::bytes('4194304'.  It's considered bad style.php to the base URL. consectetuer adipiscing elit.00 MiB echo echo echo echo widont() text::widont() Returns a string without widow words by inserting a non­breaking space  between the last two words.  // site_domain = 'localhost/kohana/' // site_protocol = 'http' echo url::base().) else  will return SI prefixes (kB.'. FALSE)..• • • $force_unit ­ defaults to NULL when supplied the function will return in those units. MB. MiB etc. Via the second parameter  you can overwrite the default site_protocol from config. Cras id dolor. //returns 0. $paragraph=text::widont($paragraph). when FALSE function will return IEC prefixes (KiB.05 kB text::bytes('4194304'.00 GiB text::bytes('4194304'. //returns 4194.  // site_domain = 'localhost/kohana/' // site_protocol = 'http' // index_page = 'index.

html current() url::current() returns the current URI string. You can pass URL segments via the first one.html' // Current URL: http://localhost/kohana/index. 'https').php.https://localhost/kohana/index.php.php' url_suffix = '.html url::site() accepts two optional parameters. Returns  welcome/home While  echo url::current(TRUE). Generates  http://localhost/kohana/index.php/welcome/home. This method accepts one optional parameter. Generates  https://localhost/kohana/admin/login.  url_suffix defined in config.  // // // // site_domain = 'localhost/kohana/' site_protocol = 'http' index_page = 'index.php site() url::site() returns a URL based on the site_protocol.php/.html?query=string echo url::current().html' echo url::site('admin/login'. If  you set it to TRUE the query string will be included in the return value.php' url_suffix = '.  The second one allows you to overwrite the default site_protocol from config. Returns  welcome/home?query=string . index_page.  // // // // site_domain = 'localhost/kohana/' site_protocol = 'http' index_page = '' url_suffix = '.  // // // // site_domain = 'localhost/kohana/' site_protocol = 'http' index_page = 'index.html' echo url::site(). site_domain.

300). ip's. digits/numbers and text.  url's.  Valid Helper Provides methods for validating inputs.whitehouse.kohana. The first parameter.  url::redirect('http://www. However. by default site_domain defined in config. which will redirect the browser to a  specified URL. provide an array of URIs to the redirect  method:  url::redirect(array('aboutus'. Will redirect with a 301 header to http://localhost/kohana/aboutus. Generates:  eclectic_titles_entered_by_crazed_users What happens to the input title? All non­alphanumeric characters. The optional second parameter is used to set the separator character. Will redirect the browser to the White House website. the input  title string.  redirect() url::redirect() generates an HTTP Server Header (302). You can only change this to an underscore. non­ascii characters will first be  transliterated (for example: à becomes a) in order to keep the URL title as readable as possible. Generally the browser will follow the  location header and this list will never be seen.  The optional second parameter can be used to set the redirect method.  $input_title = ' __Ecléçtic__ title\'s echo url::title($input_title. 301).?> '. the URL title is converted to lowercase.  All of the URIs will then be output in a HTML unordered list.php/').  . except for dashes or underscores  (depending on the second parameter). The first URI in the array is considered the preferred URI and will be placed in the Location header.gov').php. entered by cràzed users. is mandatory. However.  Finally.  url::redirect() will always call the php exit function to prevent further script execution. It currently features validation for email­addresses. for use in a URI.title() url::title() returns a properly formatted title.  If you wish to send a Multiple Choice (300) redirect. '_').'http://www.  // site_domain = 'localhost/kohana/' // site_protocol = 'http' url::redirect('aboutus'. The default is 302. will be deleted. there is no standard defined behavior for  what a user agent should do upon receiving a 300 and the list could be used to present the user with  the choices you have given. By  default this is a dash.

"ftp") == true){ echo "Valid URL".w3.  • [string] Email address to validate $email = 'bill@gates.com'. if(valid::email($email) == true){ echo "Valid email".  • • [string] URL to be validated [string] protocol of the URL (e.g. }else{ echo "Invalid URL". if(valid::url($url) == true){ echo "Valid URL". } It will result in HTML as:  Valid URL $url = 'ftp://ftp.Methods email() 'email' check whether an emailaddress is valid. }else{ echo "Invalid email".com'. } It will result in HTML as:  Valid email email_rfc() 'email_rfc' validates an emailaddress based on the RFC specifications  (http://www. http. This validation is less strict than the valid::email() function.  • [string] Email address to validate $email = 'bill@gates. }else{ .com'.kohanaphp.ftp) – default = “http” $url = 'http://www.kohanaphp.com'. if(valid::url($url. It is more strict then the valid::email_rfc() method. if(valid::email($email) == true){ echo "Valid email".org/Protocols/rfc822/). } It will result in HTML as:  Valid email url() 'url' does some simple validation on an URL to find out it if it could be existing. }else{ echo "Invalid email".

if(valid::ip($ip) == true){ echo "Valid IP".130. }else{ echo "Invalid string".41".  • [string] IP­address to be validated $ip="123. } It will result in HTML as:  Invalid string $string="KohanaPHPiscool". } It will result in HTML as:  Valid URL ip() 'ip' validates an IP­address to make sure it could exist. } It will result in HTML as:  Valid IP alpha() 'alpha' checks whether a string consists of alphabetical characters only  • • [string] String to be validated [boolean] If true UTF­8 mode will be used – default = FALSE $string="KohanaPHP is cool".678. if(valid::alpha($string) == true){ echo "Valid string". }else{ echo "Invalid string". }else{ echo "Invalid IP".181. } .912". }else{ echo "Invalid IP".echo "Invalid URL". if(valid::ip($ip) == true){ echo "Valid IP". } It will result in HTML as:  Invalid IP $ip="65.456. but does not guarantee it actually does. if(valid::alpha($string) == true){ echo "Valid string".

if(valid::alpha_numeric($string) == true){ echo "Valid string". } It will result in HTML as:  Valid string alpha_dash() 'alpha_dash' checks whether a string consists of alphabetical characters.It will result in HTML as:  Valid string alpha_numeric() 'alpha_numeric' checks whether a string consists of alphabetical characters and numbers only  • • [string] String to be validated [boolean] If true UTF­8 mode will be used – default = FALSE $string="KohanaPHP Version 2 is cool". }else{ echo "Invalid string". underscores and  dashes only  • • [string] String to be validated [boolean] If true UTF­8 mode will be used – default = FALSE $string="KohanaPHP Version 2 is cool". } It will result in HTML as:  Invalid string $string="KohanaPHP_Version-2-is_cool". }else{ echo "Invalid string". } . if(valid::alpha_numeric($string) == true){ echo "Valid string". }else{ echo "Invalid string". }else{ echo "Invalid string". if(valid::alpha_dash($string) == true){ echo "Valid string". if(valid::alpha_dash($string) == true){ echo "Valid string". } It will result in HTML as:  Invalid string $string="KohanaPHPVersion2iscool". numbers.

32". }else{ echo "Invalid". } It will result in HTML as:  Valid standard_text() .It will result in HTML as:  Valid string digit() 'digit' checks whether a string consists of digits only (no dots or dashes)  • • [string] String to be validated [boolean] If true UTF­8 mode will be used – default = FALSE $digits = "23424. }else{ echo "Invalid". if(valid::digit($digits) == true){ echo "Valid". if(valid::digit($digits) == true){ echo "Valid". } It will result in HTML as:  Valid numeric() 'numeric' checks whether a string is a valid number (negative and decimal numbers allowed)  $number = "-23424.32". if(valid::numeric($number) == true){ echo "Valid". } It will result in HTML as:  Invalid $digits = "2342432". }else{ echo "Invalid".

Sign up to vote on this title
UsefulNot useful