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. 

Features
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.

Goals
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. 

MVC
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.

Features
• • • • • • •

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

Technology
• • • • •

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

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

CodeIgniter
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. 

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

phputf8 is © 2005 Harry Fuecks. 

Popoon
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 

SwiftMailer
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 

History
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 

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

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

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

0 to 2. • autoload has been renamed to preload.  You could consider naming your system folder with the version number: 'system_2. • output_compression has been added. and $example = new Example_Model(). You can then simply revert to a previous version if there are  any issues.2 Upgrading Configuration • preload in config.Kohana.  Then continue with the changes in other files (if needed) stated below.1 Upgrading There are a number of changes to the main 'index. The '$kohana_system' should  point to the new versioned system folder.0. Replace it with the system folder from the version you wish to upgrade to.php: .  1.php' system  file. Changes to config/session.php' and your application  'config. The quickest way to upgrade is make a backup of your 'index. e.g.  Install the new 'index. 2. The Pagination create_links() method has been renamed to render() 2.php' and 'application/config. Changes to config/database. and update any values  in them to reflect the changes you made in your original files. Delete the contents of your system folder. 2.  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.  Configuration • • • Changes to config/config.1' rather  than copying the new one over the top.php: • display_errors has been added.you will need to apply your changes again after upgrading if you use this method. Call the backups file_name_version. • include_paths has been renamed to modules. Libraries • • Loader library has been removed. Follow the instructions from the relevant pages for your upgrade in the list above.php has been removed.of.php: • name should only contain alphanumeric characters with at least one letter. 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. 3.1 to 2.php' file.php_2.1.php' file and the 'config. • gc_probability has been added.php' files. index.

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

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

 and can help with SEO./modules'. and modules directories at least one level  above your document root directory (typically public_html or www). ./system'.  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.  To accomplish this in Kohana. First... • $kohana_modules = '.system +.php From URLs Removing the index. do the following:  1.example.modules +.com/. you will need to create a . however. The same goes for this particular task and. you can use relative or  absolute directories when specifying directory locations. move your Kohana system.php | . 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.application +. • $kohana_system = '.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.com/kohana/. as is always the  case./application'. but can be adapted for other HTTP servers.index. Note: This example assumes one­level above public_html.  Your final directory structure will look similar to this:  yourdomain_root_directory +. . modify the following lines in your index.htaccess Removing index.php from your website URLs look better.public_html (web server document root) | . each has its own pros and cons.php file:  • $kohana_application = '. You could also create a set of  common modules used across all of your web sites. 2.htaccess document to enable URL rewriting: # Turn on URL rewriting RewriteEngine On # Put your installation directory here: # If your URL is www.not be a problem. application. use / # If your URL is www. Let's look at a few to help you decide which is best for your  situation. Note: This tutorial only focuses on Apache..example..

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

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

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

  Helpers Change all your helper calls to the new syntax: helper::function()  1. Kohana uses auto loading so you can instantiate an object (e. Use the PHP5 syntax for the constructor in your base controller URI The CI function uri_to_assoc($offset) becomes segment_array($offset. $associative) with $associative set to TRUE. 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.  $this→load→ is deprecated. Change references to MY_Controller in your controllers to Controller 3. wrap all the functions in the file in class foo { } 2.php:  1. Change the MY_Controller extends Controller to Controller extends Controller_Core 2.g. 2. make it Page_Model 2. For example. If you add a __construct() function.  This is not valid for Kohana so if you have copied this line for your own helpers etc you need to  . The file names should also  have the same caps as the class name (without the core). new  View()) without including the class first. if your old model was PageModel.  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'). prepend public static in front of all the function names Calls are now made via foo::function().3. 3. 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. Assuming your helper file is foo.  References to those classes need to be capitalized to match the library calls (without the core). 4. Change all your model loads to just model name: $this→load→model('page') 3.  Other Class names need to have _Core appended to them and be capitalized. Note: This also applies to Models! Rename all your models to {NAME}_Model  1.

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

Reference .

General .

controllers | +. Views as used as data­to­HTML rendering layers. Helpers are used for simple.config | +. Session.g. either in the  form of an array (e.. access the same as config (file.config | +. making a URI  into a URL. such as ORM  (database table) or Archive (filesystem).key) Language (i18n) files.. such as a database row in a specific  table.i18n | +.helpers | +.libraries | +. or an HTML form. Configuration files.media | +.  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 +.controllers | +.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. Kohana adds the following supporting structure:  • • • The Basics First of all you should get acquainted with the directory structure of a default Kohana installation.cache | +. repetitive tasks.logs | +... simple static arrays that are accessed by convention (file.application | +. and handle how a URI is converted into an  application.libraries ..key) Hooks. Validation. +.system | +.libraries | +.helpers | +.views | +. which can be used to “hook into” Kohana during very early processes In addition.config | +.controllers | +. such as creating HTML tags. Input) or some other data structure. or validating an email address.helpers | +.hooks | +.core | +..modules | +. Libraries are used for as a tool that operate on some form of pre­existing data.models | +. Controllers are used as the “entry point”.

php MUST reside in the application/config directory. This is because Kohana has a cascading filesystem.index. the one in system/views will be returned when searched for. if you have a view file called layout.| +.  See Modules on how to set these up.models | +. Entries in files greater up the order still override those of which are in  files lower down.  The core files as part of system/core are also not cascading. They are hardcoded into the  Kohana startup procedures and will not be overridden by files higher up the include path. It will not be read if it  exists within a module or the system directory.vendor | +.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.  For example.  . 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.  The application and system directories can be thought of as hardcoded modules.  See the cascading filesystem in action. If you then delete that file from  application/views.php in the application/views and  system/views directories. This means that custom directories can be inserted along  the include path to be scanned when a file is searched for.  Modular The Kohana filesystem is also modular. They are  treated no differently from regular modules apart from the exceptions listed below.php is  searched for as it is highest in the include path order. 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.views | +. the one in application will be returned when layout.  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.  Exceptions There are 2 main exceptions in the filesystem:  config.

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

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

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

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

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

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

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

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

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

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

yoursite.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. E. have localhost/about/me map to  http://localhost/articles/view/1  See Routing for more information on this. $data ) .g. // you'd retrieve the article from the database here normally } } When you call www. bypassing  the default URI to method mapping.g.  Special methods index index() is the method that will be called when there is no other method call. } public function view($title. Kohana will include the  subdirectory in the mapping to the controller. if your controller  is called Welcome_Controller.  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 overview() { echo 'Article list goes here!'. $title. then all requests to the controller are sent to it.' .  _remap If you have this method in you controller.your-article-title Controllers and subdirectories If you put a controller in a subdirectory of the /controllers/ directory.com/welcome  then the index method is called.g.{ } echo 'Hello World!'. E.com/article/view/your­article­title/1 it will display  1 . and the following url is called http://example. a file in  application/controllers/admin/user.$id) { echo $id . E.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Core .

  print_r(Benchmark::get('benchmark1'.  Methods start() Benchmark::start($name) is used to start a new benchmark. Supply an unique name.  Returns an array with the results: time is expressed in seconds.  print_r(Benchmark::get('benchmark1')).Benchmark Class The benchmark class allows you to time your code. // Output: Array ( [477f51931a33e_total_execution] => Array ( [time] => 0. It is automatically loaded during the system  setup and all its methods are static. // Output: Array ( [time] => 0.  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. 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.  Note: Benchmark does not have to be loaded nor instanced. Its default value is 4.023 .0078 [memory] => 472 ) The $decimal parameter is optional. stop() Benchmark::stop($name) is used to stop a benchmark.  Benchmark::start('benchmark1'). Returns void.  print_r(Benchmark::get(TRUE. Supply the name given when the  benchmark was started. get() Benchmark::get($name.007802 [memory] => 472 ) If you set the $name parameter to TRUE.  Benchmark::stop('benchmark1'). memory in bytes. 3)). $decimals) is used to retrieve the results of a benchmark. all benchmarks will be returned. 6)). // Output: Array ( [time] => 0.  Returns void.

[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' => '' );

Methods
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. 
config::set('locale.language','nl_NL');

Note:

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. 
config::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. 
config::load('locale');

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. 

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

add
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'));

add_before
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. 

add_after
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. 

replace
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. 

get
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
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. 

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

 Kohana::lang('cache.resources') maps to  i18n/en_US/cache. 'b' => 'aab'.childnode.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. //outputs is locale is set to en_US // Caching of resources is impossible. 'c' => 'aac' ). 'leveltwo2' => array . 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()). It displays an overview of files and functions called so you can  spot the source of the error.  lang() Using Kohana::lang() languages strings can be retrieved. because resources cannot be serialized.resources').anothernode' [array] Array to search in.  Example  echo Kohana::lang('cache. Should be in form of 'rootnode. da diese nicht serialisiert werden können. Very useful for debugging. //If locale is set to de_DE // Das Cachen von Ressourcen ist nicht möglich.Methods debug() Returns HTML formatted strings of variables that can be echo to screen nicely. It takes:  • • [string] Key to search for. Prints out the POST variable  backtrace() Will be called when an error occurs. In the case of en_US.

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

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

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

'c').  Example:  echo utf8::strip_ascii_ctrl("a\0b".var_dump(utf8::is_ascii("a\0b".chr(7).  Example:  echo utf8::strip_non_ascii('Clichés'). // 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.chr(128). // Output: abc strip_non_ascii utf8::strip_non_ascii() removes all non­ASCII characters from a string. // Output: Clichs .'c')).

  Example:  echo utf8::transliterate_to_ascii('Jérôme est un garçon. Special characters that are unknown to this method are left untouched. // Output: Jerome est un garcon.  . Further reading: Wikipedia on transliteration  trim ucfirst ucwords View Class For a more in depth overview of views see General/Views. 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.

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

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

Addons .

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

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

  Form_Input Create input Create an input.  ->value('input_value') . Method is chainable.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. Method is chainable.  ->rules('list|of|validation|rules') Input validation using Kohana Validation helper You can utlize rules from Validation helper by prefixing the rule with valid_. Method is chainable.  ->label(TRUE). Input validation Set the validation rules for the field.error_format() html() Returns a rendered form as a string. a rule normally  accessible by calling valid::ip would be utilized as:  ->rules('valid_ip') Input value Set the default value for the element.  $form->input('input_name'). Also you can pass the custom label name. or  ->label('Custom input name'). Thus. Method is chainable. Input label Show the field label or not. If the argument is boolean the input label will be based on the input  name.  In Kohana 2.

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

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

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

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

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

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

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

Libraries .

 etc)  dynamically. It can persist them to the file system.  Currently it only supports Zip Archives. or it can send the binary file directly to the user  without saving to the hard drive. $this->archive->save("myarchive.zip"). Relative paths must be relative to the root website dir. .  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'). Relative paths must be relative to the root website dir.  • [string] name to be given to the archive file $this->archive->download("myarchive.txt").  Methods add() add() adds files and directories to your archive.  [boolean] whether to scan the dir recursively – default = TRUE This will result in file. Tar Files.zip").  • [string] path to save the archive file. It accepts the following parameter:  • • [string] path to file or dir.txt being added to the archive:  $this->archive->add("files/uploads/file. save() save() saves the archive you've been creating to the disk.Archive Library Overview The Archive Library is a convenient way of constructing Archives (Zip Files. 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. download() download() offers the archive as a download to the user. Currently only a driver for Zip archives is available.

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

  $tagsdefaults to none. $data=array('Jean Paul Sartre'.array('french')).$tags).'French wine'. print_r($this->cache->find('french')). 'Simone de Beauvoir').caches. returns the data or NULL  print_r($this->cache->get('existentialists')). //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'). returns a boolean  $this->cache->delete_tag('french'). returns a boolean  $this->cache->delete('food').  • • • • $id The id should be unique $data If $data is not a string it will be serialized for storage. 'Albert Camus'.$data.  $food=array('French bread'. If none given the default lifetime from the  configuration file will be used.$food. $this->cache->set('food'. .'philosophy'. 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. $lifetime specific lifetime can be set. an array should be supplied. delete_tag $this→cache→delete_tag($tag) deletes all cache items with a given tag. $tags=array('existentialism'.'French cheese'). This is useful when grouping caches  together. $this->cache->set('existentialists'. retrieves all caches with the given tag.

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

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
Overview
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)

Example
$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); }

}

Template
<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>

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

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

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

  Example:  // Save image and overwrite the input image file $this->image->save(). // Save image to a new file. '/'. 350. Full Example Place this code into a controller  // The original image is located in folder /application/upload. The default is to  overwrite the input image file.percentage is from 75 to 85./upload')).jpg'). $_COOKIE and $_SERVER are all converted to utf­8.jpg').'moo. Default is to overwrite input file. 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. // Instantiate the library $image->resize(400. Global GET.  . Example:  // Reduce image quality to 75 percent of original $this->image->quality(75). $image = new Image($dir.'/. // apply image manipulations $image->save($dir. $dir = str_replace('\\'. 'top')->sharpen(20)->quality(75). It is  accessed by $this→input in the controller scope. // Display some useful info about the operation **for debugging only**. // $this->image->save('.'/'. realpath(dirname(__FILE__). $_GET. This method is NOT chainable. 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.'super-cow-crop. save() save() Is used to save the image to a file on disk. Accepts a relative or absolute file path. There is no default. NULL)->crop(400.jpg')../new-image.  • [string] The file path and output image file name.  $_POST. // Write the changed image to a new file in the original input folder echo Kohana::debug($image).

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

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

11 xss_clean() allows you to clean a string to make sure it is safe. $name)->count_records('users').print $this->input->user_agent(). ORM Library The ORM library is the Object­Relational mapper for Kohana. For example:  public function username_exists($name) { return (bool) self::$db->where('username'. 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. you need to access the Kohana database  library methods as “self::$db→___”. U.0. This could result in HTML as:  Mozilla/5. rv:1.8.0.0 (Windows. It provides ways to handle records in  your database as if they were objects and it manages relationships between your tables. Windows NT 6.11) Gecko/20071127 Firefox/2. } } Without passing the $id to the parent.  . } ORM conventions In order for ORM to work properly there are some conventions that must be upheld.0.  • [string/array] The string or the array of strings to clean echo $this->input->xss_clean($suspect_input). ORM won't work. nl.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).1. if you have a table users (plural)  you would have a model User_Model (singular) in your application/models directory as follows:  user. For example. if you  create a custom method in a Model that extends ORM. It is not  loaded like other libraries but works in the model. Therefore.

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

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

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

com delete delete deletes the current object. $user->email='test@test. $user->save(). $user->delete(). to remove a dog $pet_enthusiast->remove_dog( $dog ). //alternate syntax $user->delete(ALL).  $user=new User_Model.com' Update example  $user=new User_Model. If it doesn't exist it uses an INSERT statement.com'). $user->find_by_email('test@test.  Insert example  $user=new User_Model. 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.  . if it does it  uses an UPDATE statement.  $user=new User_Model. $user->find(1). //will insert a new user into the table with email being 'test@test. $user->delete_all().com user with a new email example@example. save save saves an object to the database. delete_all delete_all deletes all records in the table. $user->save(). $user->email('example@example.com'). //will update a the test@test.Example // For the pet enthusiast.com'.

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

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

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

$this->pagination->create_links('digg'). // Just echoing it is enough to display the links (__toString() rocks!) echo 'Classic style: '. 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         » . digg.$this->pagination. // You can also use the create_links() method and pick a style on the fly if you want echo '<hr />Digg style: '. // use db count query here of course 'items_per_page' => 10. extended. // it may be handy to set defaults for stuff like this in config/pagination.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/'. punbb. echo '<hr />PunBB style: '. // pass a string as uri_segment to trigger former 'label' functionality 'total_items' => 254.$this->pagination->create_links('punbb'). echo 'done in {execution_time} seconds'.php 'style' => 'classic' // pick one from: classic (default). echo '<hr />Extended style: '. or add your own! )).$this->pagination->create_links('extended'). // base_url will default to current uri 'uri_segment' => 'page'.

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

After you remove the non­required config lines.  Attributes The payment library has a set of default attributes it uses to send payments to the gateway. but it differs for each driver. It has many features:  1. Just set the fields required by your driver.php there is a sample config for each payment gateway we support.g. These  attributes are fairly self explanatory and are listed below. Usually this  will include some sort of API username/password combination. $payment->card_num = '1234567890123456'. if ($status = $payment->process() === TRUE) { // Report successful transaction } else { // $status has the error message.  • • • • card_num exp_date cvv description . modify your driver config as needed. 2. 3. The  library can support using more than one driver per application by passing the driver name to the  constructor:  $paypal_payment = new Payment('Paypal'). and process().  $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.  Simply copy this file to your application directory. 4.  $payment = new Payment(). you must reference the new  custom filename when creating your pagination links (e. $authorize_payment = new Payment('Authorize').Note: If you create a new pagination style (by renaming the file). 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. and remove the drivers you are not using. $payment->exp_date = '0510'. so display an error page based on it } Configuration In system/config/payment.

 It is up to you  how to handle the failure. It currently supports the following gateways:  . 'exp_date' = '0510' }. They may also have driver specific fields  that are noted in the Driver section.  $payment = new Payment().  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. 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->set_fields($attributes).  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. $attributes = array ( 'card_num' = '1234567890123456'. simply call this method in an if test. The  method returns TRUE on successful payment transaction or an error string on failure.

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

PayPal
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->profiler->disable()

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 

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

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

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

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

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

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

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

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

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

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

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

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 .

 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'. 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 . print Kohana::debug($optical_discs). '780'). $optical_discs = arr::rotate($optical_discs. 'BD' => array('25000'.'405') ). FALSE). print ('<br /><br />'). print Kohana::debug($optical_discs).'650'). 'DVD' => array('4700'.Array Helper The Array helper assists in transforming arrays via the rotate() and remove() methods.  Methods rotate() 'rotate' rotates an array (two­dimensional) matrix.

$cd = arr::remove('CD'.  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 Kohana::debug($optical_discs). print Kohana::debug($cd). 'DVD' => array('4700'.[BD] => 25000 ) [1] => Array ( [CD] => 780 [DVD] => 650 [BD] => 405 ) ) remove() 'remove' removes a key from an array and returns it. $optical_discs). 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 ) ) . 'BD' => array('25000'.'405') ).'650'). print ('<br />'). '780'). print Kohana::debug($optical_discs). print ('<br />').

 The four arguments are:  • • • • [mixed] The value you want to find. or simply return FALSE (the default) [boolean] Sort the array before searching Example:  $my_array = array('10'.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. TRUE). it returns the key of the array  value it finds. $my_array). // FALSE (not found) echo arr::binary_search('45'. '30'.  . // 3 echo arr::binary_search('35'. $my_array). By default. // 3 echo arr::binary_search('45'. '20'. '50'. echo arr::binary_search('50'. '80'). [array] The sorted array you want to search in [boolean] Return the nearest value. $my_array. // 2 range() Cookie Helper Provides methods for working with COOKIE data. $my_array. TRUE).

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

print ($time). 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:  . 0. 0. print ($time). 10. $time = date::unix2dos($time). print ($time). $time = date::dos2unix($time). Date Helper The Date helper assists in formating dates and times allowing for addition and conversion between  different formats.cookie::delete('stale_cookie'). 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.  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. 31. 1987).

print (date::offset('CST'. print Kohana::debug(date::seconds(2. 'GMT').'<br />').200. print Kohana::debug(date::seconds(100.'<br />').// Please note that the print() statements are for display purposes only // This example was executed in the EST timezone print (date::offset('CST').400)).1. 'MST'). 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 . 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()).'<br />'). print (date::offset('UTC'.7)).

  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:  .) [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.

// Please note that the print() statements are for display purposes only // This example ran at 6:10PM EST print Kohana::debug(date::hours()). TRUE. 22)). // 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 . TRUE. 9)). print Kohana::debug(date::hours(1. date('g'))). print Kohana::debug(date::hours(1. print Kohana::debug(date::hours(1. TRUE.

// 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.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)). 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 .2007)). print Kohana::debug(date::ampm(date('G'))). print Kohana::debug(date::ampm(13)).

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.  Example:  // Please note that the print() statement is for display purposes only print Kohana::debug(date::months()).2002)). 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()). print Kohana::debug(date::years(1998.) [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. It will result in HTML as:  Array ( [2002] [2003] [2004] [2005] [2006] => => => => => 2002 2003 2004 2005 2006 .

'years.days.seconds' Example:  // Please note that the print() statements are for display purposes only // This example ran in 2007 $timestamp = time() . // timestamp of 350 days ago print Kohana::debug(date::timespan($timestamp)).hours. time().(60*60*24*7*31*3). time().days')).minutes. print Kohana::debug(date::timespan($timestamp. 'minutes')).) [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. print 'minutes: '.weeks. print Kohana::debug(date::timespan($timestamp.(60*60*24*7*50).months.Kohana::debug(date::timespan($timestamp. 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 . $timestamp2)). // timestamp of 651 days ago $timestamp2 = time() .

// For a file located in application/downloads // Use relative path download::force('./application/downloads/file.txt'). 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.'downloads/file. // OR use the defined application path download::force(APPPATH. 'PM')). .[hours] => 0 [minutes] => 0 [seconds] => 0 ) minutes: 937440 adjust() 'adjust' converts an hour integer into 24­hour format from a non­24­hour format.  Methods force() 'force' forces a download of a file to the user's browser.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. 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.

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

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

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

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

')'.file::mime($file). Example:  $file = 'humpty_dumpty. in MB.Example:  echo file::extension('/etc/apache2/apache2. // output name echo file::join($file_in.ogg' echo $file. The parameters are:  • • • param: [string] split filename. for each chunk to be return: [integar] The number of pieces that were created. without .$file_out). // from our last example $file_out = 'humpty_dumpty-back_together_again. . if different then an the filename return: [integar] The number of pieces that were joined.mp3'. Example:  $file_in = 'humpty_dumpty.mp3.' ('.001 humpty_dumpty.ogg (application/ogg) split() 'split' splits a file into pieces matching a specific size indicated in megabytes.mp3. // pretend it is 7.conf').mp3.004 join() 'join' joins splited files (possibly by file::split()). 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 . defaults to the same directory as the file param: [integar] size. The parameters are:  • • • • param: [string] file to be split param: [string] directory to output to.mp3.000 extension param: [string] output filename.FALSE.mp3'. my_movie.php).002 humpty_dumpty. FALSE if not found Example:  $file = 'my_movie. 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.mp3'.003 humpty_dumpty.### extension.8 MB large echo (file_exists($file)) ? file::split($file.mp3 humpty_dumpty. The parameters are:  • • param: [string] filename to check MIME­type of return: [mixed] string if found.2) : 'can not find file!' .

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

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

'id'=>'fieldId'. 'path/to/local/file') Result in HTML:  ."fieldValue". $array=array('name'=>'fieldName'."fieldValue")). echo form::upload($attributes.' id="fieldId"')). print Kohana::debug(form::password("fieldName". print Kohana::debug(form::password($array)).'field2'=>'value2'). 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.'class'=> 'formField').'value'=>'fieldValue'. $array=array('field1'=>'value1'. 'class' => 'your-class')."fieldValue")). 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'. print Kohana::debug(form::hidden($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".• [string] value of the field – default = ””  Example:  // Please note that the print() statements are for display purposes only print Kohana::debug(form::hidden("fieldName".

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

The parameters are:  • • • • [string/array] input name or an array of HTML attributes [string] input value. '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_rich'). 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'. 'is_single'. 'I am cute: '). TRUE). 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'. form::radio('radio_rich_box'. 'I am rich: '). 'is_cute').'<br />'. form::label('radio_rich_box'. 'I am single: '). form::checkbox('check_spam_box'. 'Always send me Spam (Opt in): '). form::checkbox('check_money_box'. form::radio('radio_single_box'.  The parameters are:  • • • • [string/array] input name or an array of HTML attributes [string] input value.'<br />'. 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. form::radio('radio_cute_box'. form::label('radio_single_box'. but allows for easier multiple selections. 'Never send me Money (Opt out): '). similar to checkbox. TRUE). form::label('check_money_box'.'<br />'. 'send_spam').

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

attributes()
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

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

Outputs 
id="input_name" class="submission"

open_fieldset()
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

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

Results in HTML 
<fieldset class="important">

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

Results in HTML 
</fieldset>

legend()
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

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

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

close()
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: 
</form></div>

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

Methods
specialchars()
'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: 
• •

Example: 
$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;

query_string()
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

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

It will result in HTML as: 
id=12&page=home

anchor()
'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>

file_anchor()
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 

'Join us on our custom IRC!').html" id="id432">The Public Linux Archive</a> panchor() Similar to 'anchor'. etc. 'irc'. 'The Public Linux Archive'.com'). 'Check out our latest magazine!'). 'irc'. – 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'.pdf'. 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="ftp://localhost/pub/index.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'. 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. 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. – This is only necessary if you need to  change the protocol from 'http' Example 1:  echo html::file_anchor('media/files/2007-12-magazine.html'. . etc. hex or raw randomly to help prevent spam and e­mail harvesting. '/kohana'. 'ftp').pdf">Check out our latest magazine!</a> Example 2:  echo html::file_anchor('pub/index. 'id="id432"'. It will result in HTML as:  <a href="http://localhost/media/files/2007-12-magazine.

&#x61 . 'media/css/menu' ).com/tutorials/video/working_with_media_files. stylesheet. 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.&#101.html).css" media="screen" /> <link rel="stylesheet" href="http://localhost/media/css/menu. defaults to FALSE [string or array] Either a string or array with values for the 'media' attribute (print. 'print' or 'aural' [boolean] Set to TRUE if you want to have the index.&#111.&#105.&#x78.fo&#x40.mp&#108. array ( 'screen'. It will result in HTML as:  <link rel="stylesheet" href="http://localhost/media/css/default.g.&#058.php” in the  URL (this will be the case until you modify this setting as explained in the tutorial from Christophe  http://kohanaphp.  alternate) [string or array] Either a string or array with values for the 'type' attribute  (application/rss+xml etc.&#108.&#x6f.</a> stylesheet() 'stylesheet' calls CSS files internally and will suffix .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'.It will result in HTML as:  <a href="&#109. screen  etc.">i&#x6e.&#x6f.i&#x6e.&#109.&#109.&#101. FALSE).&#x61. 'print' ).) .e&#x2e.mp&#108.&#116.&#097.&#x78. Will render the <link> tag.) [boolean] set to TRUE to specify the suffix of the file.css" media="print" /> Important Don't forget to add a final TRUE parameter if your Kohana frameworks still need “index.e&# x2e.fo&#x40.&#x63.  link() 'link' calls files such as feeds internally.&#x63.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'.

html).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. array('application/rss+xml'.'application/atom+xml') .js"></script> <script type="text/javascript" src="http://localhost/media/js/iefixes.com/tutorials/video/working_with_media_files.php” in the  URL (this will be the case until you modify this setting as explained in the tutorial from Christophe  http://kohanaphp. 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. FALSE).  .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'. 'media/js/iefixes.com/tutorials/video/working_with_media_files.  script() 'script' calls JavaScript files internally and will suffix .html).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'.js' ). FALSE).php” in the  URL (this will be the case until you modify this setting as explained in the tutorial from Christophe  http://kohanaphp.• [boolean] Set to TRUE if you want to have the index.js"></script> Important Don't forget to add a final TRUE parameter if your Kohana frameworks still need “index. It will result in HTML as:  <script type="text/javascript" src="http://localhost/media/js/login. 'alternate'. 'welcome/home/atom' ).

png" width="100" height="100" alt="Thumbnail" /> Example 2 (with html::anchor and lightbox):  echo html::file_anchor('media/images/01.png'. 'width' => '100'. border-bottom: 1px solid #000.png'). 'rel="lightbox"').png" /></a> Important Don't forget to add a final TRUE parameter if your Kohana frameworks still need “index.php” in the  URL (this will be the case until you modify this setting as explained in the tutorial from Christophe  http://kohanaphp. border-bottom: 1px solid #000. 'class' => 'image' ) ).png').png'. <img src="http://localhost/media/images/thumbs/01. 'alt' => 'Thumbnail')).png" /> echo html::image(array('src' => 'media/images/thumbs/01.'.  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.image() 'image' creates a 'img' HTML tag. It will result in HTML as:  <a href="http://localhost/media/images/01. It will result in HTML as:  style="font-size: 20px. 'height' => 100. It will result in HTML as:  <img src="http://localhost/media/images/thumbs/01." rel="lightbox" class="image" .com/tutorials/video/working_with_media_files.png" rel="lightbox"><img src="http://localhost/media/images/thumbs/01.html).php/' included in the link (to use views to  serve images using Kohana) Example 1:  echo html::image('media/images/thumbs/01. 'rel' => 'lightbox'. html::image('media/images/thumbs/01.  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.

 located into the system/i18n/en_EN/ folder  (or the language specified in the config item 'locale. Arguments:  • segments to use as breadcrumbs.png'.php file. border-bottom: 4px solid #000. //returns TRUE inflector::uncountable('book'). defaults to using Router::$segments Example:  echo Kohana::debug(html::breadcrumb()).  This method uses a words list from the inflector.  Methods uncountable() inflector::uncountable($string) checks whether the given string is an uncountable  word. Returns TRUE or FALSE. 'rel' => 'lightbox'. 'See my picture!'.png" style="font-size: 20px. html::attributes( array ( 'style' => 'font-size: 20px. borderbottom: 4px solid #000. It will result in HTML as:  <a href="http://localhost/home/images/01. //returns FALSE . 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.'.Example 2 (with html::anchor):  echo html::file_anchor('home/images/01. 'class' => 'image' ) ) )." rel="lightbox" class="image">See my picture!</a> breadcrumb() The function returns an array of links for each segment.language')  inflector::uncountable('money').

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

3.9.5.example.example. and a nearest integer number to  round too.com/example. defaults to 5. An integer to round.jpg" />'. It will result in HTML as:  <b>Check this image:</b> http://www.Methods round() num::round() accepts two arguments. <p>Rounding numbers to nearest 5</p> <?php foreach ($numbers as $number): ?> <p>Round <?php echo $number ?> to <?php echo num::round($number.99.999).  • [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.  • [string] String to be stripped $string = '<b>Check this image:</b> <img src="http://www. print Kohana::debug(security::strip_image_tags($string)).jpg .  Methods xss_clean() 'xss_clean' behaves the same as xss_clean in the Input library. 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.com/example.  Example  // Given an input of: $numbers = array(1.

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

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

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

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

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

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

} It will result in HTML as:  Invalid IP $ip="65. }else{ echo "Invalid IP".181. if(valid::alpha($string) == true){ echo "Valid string". } . if(valid::ip($ip) == true){ echo "Valid IP".  • [string] IP­address to be validated $ip="123.912".678. } It will result in HTML as:  Valid URL ip() 'ip' validates an IP­address to make sure it could exist. }else{ echo "Invalid IP".echo "Invalid URL". but does not guarantee it actually does. if(valid::alpha($string) == true){ echo "Valid string". }else{ echo "Invalid string". } 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".130.456. if(valid::ip($ip) == true){ echo "Valid IP".41". } It will result in HTML as:  Invalid string $string="KohanaPHPiscool". }else{ echo "Invalid string".

}else{ echo "Invalid string". } It will result in HTML as:  Invalid string $string="KohanaPHPVersion2iscool". 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". }else{ echo "Invalid string". }else{ echo "Invalid string". if(valid::alpha_dash($string) == true){ echo "Valid string". } It will result in HTML as:  Invalid string $string="KohanaPHP_Version-2-is_cool". if(valid::alpha_numeric($string) == true){ echo "Valid string". }else{ echo "Invalid string". numbers. if(valid::alpha_numeric($string) == true){ echo "Valid string".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". if(valid::alpha_dash($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.

}else{ echo "Invalid". } It will result in HTML as:  Valid standard_text() . }else{ echo "Invalid". } 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". }else{ echo "Invalid". } It will result in HTML as:  Invalid $digits = "2342432". if(valid::digit($digits) == true){ echo "Valid". if(valid::digit($digits) == true){ echo "Valid".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.32".

Sign up to vote on this title
UsefulNot useful