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 

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

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

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

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

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

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

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

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

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

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

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

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

Reference .

General .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Core .

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

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

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

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

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

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

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

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

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

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

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

Addons .

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

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

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

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

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

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

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

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

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

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

Libraries .

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

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

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

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>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

 The  method returns TRUE on successful payment transaction or an error string on failure.• • • • • • • • • • • • • • • • • • • • 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. $attributes = array ( 'card_num' = '1234567890123456'. $payment->set_fields($attributes). They may also have driver specific fields  that are noted in the Driver section.  Drivers The payment library uses drivers much like the Database library does in order to keep the API  consistent between payment gateways. It currently supports the following gateways:  .  $payment = new Payment(). process() This method does the magic. After you set your attributes. 'exp_date' = '0510' }. It is up to you  how to handle the failure. simply call this method in an if test.  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.

net Required Fields 1. exp_date 3. Tax and Shipping get added to the amount to form the grand total  inside the driver. Authorize. amount YourPay.net Trident Gateway TrustCommerce YourPay.net PayPal Authorize.1. 5. 3. amount Trident Gateway Required Fields 1.  . exp_date 3. 4. amount TrustCommerce Required Fields 1. 2. 4. 6.net Required Fields 1. 5. exp_date 3. 2. card_num 2. card_num exp_date amount tax shipping cvv Driver Specific Details The amount above is the subtotal. card_num 2. card_num 2. 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.regenerate config value). other mechanisms may be more appropriate:  • •   Kohana's Cache library   PHP's shared memory facility Starting a Session To load the Session library. If no session data exists.associated with only one browser session. a new  session is automatically started.  For example.  echo 'Current session ID: ' . including the browser cookie that is  used to identify it. Simply loading the Session library  is enough to create a new session. It will destroy any current  session data. it will become available. $this->session->id().  . or to a particular  controller method: Add the code:  $this->session = new Session.  destroy() $this→session→destroy() destroys all session data. Working with sessions The following methods are available in the Session library:  create() $this→session→create() can be called to create a new session.  Note. this is done automatically by the framework after a number of requests for security purposes  (set by the session. add the following code to your controller constructor. The above line of code has two effects:  • • The Session library will be available via $this→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. or retrieve data from an existing session. If any current session data exists.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

It will result in HTML as:  317325312 616046400 offset() 'offset' calculates the seconds between two timezones The two arguments are:  • • [int] remote timezone [mixed] use local time? – default is TRUE – else enter your own  Example:  . print ($time). print ($time). $time = date::dos2unix($time). 1987). print ($time). print ($time). 10. 0.  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. $time = date::unix2dos($time). 0.cookie::delete('stale_cookie'). 31. 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. Date Helper The Date helper assists in formating dates and times allowing for addition and conversion between  different formats.

'<br />'). print Kohana::debug(date::seconds(100. It will result in HTML as:  -3600 3600 0 seconds() 'seconds' creates an array of numbers based on your input The three arguments are:  • • • [int] step (count by) – default = 1 [int] start number – default = 0 [int] end number – default = 60 Example:  // Please note that the print() statements are for display purposes only print Kohana::debug(date::seconds()). 'GMT').400)). print Kohana::debug(date::seconds(2. print (date::offset('CST'. 'MST').1. print (date::offset('UTC'.'<br />').// Please note that the print() statements are for display purposes only // This example was executed in the EST timezone print (date::offset('CST').200. 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 .'<br />').7)).

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

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

print Kohana::debug(date::ampm(date('G'))). // 24-hour format of an hour without leading zeros It will result in HTML as:  AM PM PM days() 'days' counts the number of days there are in a specific month of a specific year The two arguments  are:  • • [int] month (1­12) [int] year – default: current year Example:  // Please note that the print() statement is for display purposes only print Kohana::debug(date::days(5.2007)). It will result in HTML as:  Array ( [1] => 1 [2] => 2 [3] => 3 [4] => 4 [5] => 5 [6] => 6 [7] => 7 [8] => 8 [9] => 9 [10] => 10 [11] => 11 [12] => 12 [13] => 13 [14] => 14 [15] => 15 [16] => 16 [17] => 17 [18] => 18 [19] => 19 [20] => 20 [21] => 21 [22] => 22 [23] => 23 . print Kohana::debug(date::ampm(13)).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)).

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. It will result in HTML as:  Array ( [1] => 1 [2] => 2 [3] => 3 [4] => 4 [5] => 5 [6] => 6 [7] => 7 [8] => 8 [9] => 9 [10] => 10 [11] => 11 [12] => 12 ) years() 'years' returns an array with the years between the specified years.) [24] [25] [26] [27] [28] [29] [30] [31] => => => => => => => => 24 25 26 27 28 29 30 31 months() 'months' returns an mirrored array with the month­numbers of the year. It will result in HTML as:  Array ( [2002] [2003] [2004] [2005] [2006] => => => => => 2002 2003 2004 2005 2006 .  Example:  // Please note that the print() statement is for display purposes only print Kohana::debug(date::months()).

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

It will result in HTML as:  23 Download Helper The download helper assists in forcing downloading of files by presenting users with the “save as”  dialog./application/downloads/file.txt").'downloads/file.  Methods force() 'force' forces a download of a file to the user's browser.[hours] => 0 [minutes] => 0 [seconds] => 0 ) minutes: 937440 adjust() 'adjust' converts an hour integer into 24­hour format from a non­24­hour format. // For a file located in application/downloads // Use relative path download::force('. . // OR use the defined application path download::force(APPPATH. 'PM')).  • • $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.txt').txt'). 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. This function is binary­safe and will work  with any MIME type that Kohana is aware of.

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

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

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

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

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

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

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

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

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

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

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

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 

'The Public Linux Archive'. It will result in HTML as:  <a href="http://localhost/media/files/2007-12-magazine. etc. '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'. 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.com'). hex or raw randomly to help prevent spam and e­mail harvesting. '/kohana'. but accepts the protocol attribute first instead of last The four arguments are:  • • • • [string] The protocol your link will use: ''ftp'. 'ftp'). 'irc'. 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. 'Join us on our custom IRC!'). It will result in HTML as:  <a href="ftp://localhost/pub/index. .html" id="id432">The Public Linux Archive</a> panchor() Similar to 'anchor'. etc.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'.pdf'.pdf">Check out our latest magazine!</a> Example 2:  echo html::file_anchor('pub/index. 'id="id432"'. 'Check out our latest magazine!').html'.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

32".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". if(valid::numeric($number) == true){ echo "Valid". } It will result in HTML as:  Valid numeric() 'numeric' checks whether a string is a valid number (negative and decimal numbers allowed)  $number = "-23424. } It will result in HTML as:  Invalid $digits = "2342432". } It will result in HTML as:  Valid standard_text() . if(valid::digit($digits) == true){ echo "Valid". }else{ echo "Invalid". if(valid::digit($digits) == true){ echo "Valid". }else{ echo "Invalid". }else{ echo "Invalid".