What is Kohana?

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

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

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

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

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

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

community feedback. 

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

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

Features
• • • • • • •

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

Technology
• • • • •

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

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

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

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

phputf8 is © 2005 Harry Fuecks. 

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

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

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

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

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

Kohana 2.1.x
• •

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

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

The Good Old Days
September ­ October 2007 

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

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

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

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

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

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

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

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

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

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

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

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

Reference .

General .

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

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

  hooks See Hooks. See Internationalization.  helpers See Helpers.  config All configuration files that are read by the Config class must be stored here.  Built in directories cache By default. 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. log files generated by the Log class are stored in the application/logs directory. the Cache library uses this directory to store its caches when using the File driver. See  Libraries for more information.  logs By default.  controllers All controllers to be directed to by the router must go in here.  libraries See Libraries.  views See Views.  .  models See Models. They are split up into sub­directories using  the country code and locale as the name.See Configuration and Internationalization for more information on this.  i18n Language files read by Kohana::lang() are stored here.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Core .

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

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

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

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

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

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

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

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

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

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

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

Addons .

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

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

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

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

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

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

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

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

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

?></title> </head> <body> <?php echo $menu ?> <?php echo $content ?> <?php echo $copyright.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    .<div style="width: 100px. float: right."> <ul> <li>menu 1</li> <li>menu 1</li> </ul> </div> Alter /application/views/base_page. border: 1px solid lightgreen.

Libraries .

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

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

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

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>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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 

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

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

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

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

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

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

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

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

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

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

} Using PHP functions on fields Precede the rule with =.30] ­ same as required| Return FALSE if form field is  min_length[1]|max_length[30] or  empty. Please review the following issues with your form and resubmit it. 'one').g. ?> <p>Your form failed validation.</p> <ul> <?php echo $validation->error_string ?> </ul> <?php } } set_message() Allows customization of the error message that is displayed upon failed validation for a specific  function. Using your own custom callbacks Precede the rule with callback_  Example  array('First Name'. $this->validation->add_error(__FUNCTION__.").  public function _tester($value) { $this->validation->set_message(__FUNCTION__. Note: The key name has to match the function name that it corresponds to. $validation->error_format("<li>{message}</li>").30]'). //will effectively call $this->validation->valid_password($data). 'omg callback error').  array('First Name'. This is very  useful when utilizing custom callback validation functions.{ } else { print("Your form successfully validated. '=trim|required[2. 'callback_valid_password|required[2.30]'). Rules Rule  required  Parameter  Yes  Description  Example  required[1.  E. or length value is out of  required[30] ­ same as required| range parameters exact_length[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.Array Helper The Array helper assists in transforming arrays via the rotate() and remove() methods. print Kohana::debug($optical_discs). '780'). 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'. print Kohana::debug($optical_discs). FALSE). It will result in HTML as:  Array ( [CD] => Array ( [0] => 700 [1] => 780 ) [DVD] => Array ( [0] => 4700 [1] => 650 ) [BD] => Array ( [0] => 25000 [1] => 405 ) ) Array ( [0] => Array ( [CD] => 700 [DVD] => 4700 . print ('<br /><br />'). 'DVD' => array('4700'.'650').'405') ). $optical_discs = arr::rotate($optical_discs. 'BD' => array('25000'.

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

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

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

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

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

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

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 . 9)). TRUE. date('g'))). TRUE. print Kohana::debug(date::hours(1. 22)).// 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.

2007)).ampm() 'ampm' calculates whether the supplied integer makes the hour AM or PM The one argument is:  • [int] hour to calculate Example:  // Please note that the print() statements are for display only // This example ran at 5:45PM EST print Kohana::debug(date::ampm(1)). print Kohana::debug(date::ampm(13)). 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. 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 .

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

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

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

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

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

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

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

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

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

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

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

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

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

I am cute:  I am single:  I am rich:  submit() Creates a 'submit' type 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'. 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'). when using a name [string] a string to be attached to the end of the attributes Example:  print form::submit('submit'.  The parameters are:  • • • [string/array] input name or an array of HTML attributes [string] input value. Results in HTML  <input type="submit" id="submit" name="submit" value="Send" /> button() Creates a button for the form.  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  <label for="imageup">Image Uploads</label> . 'Does not do Much').  The parameters are:  • • • [string/array] input name or an array of HTML attributes [string] input value. 'Send'). 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 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. It will result in HTML as:  <a href="irc://localhost/kohana">Join us on our custom IRC!</a> mailto() 'mailto' prints a <a href=“mailto:”></a> tag but escapes all characters of the e­mail address into  HTML. 'The Public Linux Archive'. 'ftp'). 'id="id432"'. . – This is only necessary if you need to  change the protocol from 'http' Example 1:  echo html::file_anchor('media/files/2007-12-magazine. 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'. '/kohana'. etc. hex or raw randomly to help prevent spam and e­mail harvesting. It will result in HTML as:  <a href="http://localhost/media/files/2007-12-magazine. – This is only necessary if it's an  internal page with a non­absolute link for the first argument and you need to change the  protocol from 'http' [string] An internal or external page that you would like to link to [string] The title you would like to have show up as the hyperlink [string] Attributes to add to your anchor Example:  echo html::panchor('irc'. but accepts the protocol attribute first instead of last The four arguments are:  • • • • [string] The protocol your link will use: ''ftp'. 'Join us on our custom IRC!'). 'irc'. It will result in HTML as:  <a href="ftp://localhost/pub/index.pdf'.com').html" id="id432">The Public Linux Archive</a> panchor() Similar to 'anchor'.pdf">Check out our latest magazine!</a> Example 2:  echo html::file_anchor('pub/index.html'. 'Check out our latest magazine!'). 'irc'.

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

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

It will result in HTML as:  <a href="http://localhost/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"'). html::image('media/images/thumbs/01.html).png" rel="lightbox"><img src="http://localhost/media/images/thumbs/01. 'alt' => 'Thumbnail')). border-bottom: 1px solid #000.png').png'.  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. border-bottom: 1px solid #000. 'rel' => 'lightbox'.  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. 'class' => 'image' ) ).png'.com/tutorials/video/working_with_media_files.png'). 'height' => 100.png" /> echo html::image(array('src' => 'media/images/thumbs/01. It will result in HTML as:  <img src="http://localhost/media/images/thumbs/01.png" /></a> Important Don't forget to add a final TRUE parameter if your Kohana frameworks still need “index. <img src="http://localhost/media/images/thumbs/01. 'width' => '100'.image() 'image' creates a 'img' HTML tag.'.php/' included in the link (to use views to  serve images using Kohana) Example 1:  echo html::image('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." rel="lightbox" class="image" .

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

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

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

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

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

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

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

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

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

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

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

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

Sign up to vote on this title
UsefulNot useful