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 

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

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

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

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

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

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

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

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

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

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

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

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

Reference .

General .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Core .

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

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

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

Config Class
Provides methods for working with configuration items. 

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

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

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

Note:

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

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

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

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

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

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

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

You can also create entirely new events this way: 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Addons .

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

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

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

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

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

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

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

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

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

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

Libraries .

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

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

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

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

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

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

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

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

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

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

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

20 27

21 28

22 29

23 30

24 31

25 26 1 2

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

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

Table of Contents
• • • • • • •

  Configuration     Connecting     Querying     Query Builder     Query Result     Metadata     Query Caching  

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

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

echo $row->email; }

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

}

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

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

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

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

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

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

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

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

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

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

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

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

  • Defaults to FALSE $user=new User_Model. Using DB Builder methods In Kohana's ORM you can still use some of the methods of the DB builder  Example  //Fetch the latest 10 articles $articles=new Article_Model(). $user->find_by_email('example@example.'admin').com').  . $user->where('role'.com'). $articles=$articles->orderby('id'. Will add extra criterion.'desc')->limit(10)->find_all(). find_all() or find(). 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. $user->find_by_email('example@example. If it's set to FALSE and you don't call save() means losing changes made to  the object.  $user=new User_Model.  auto_save If set to TRUE execute save() on the destruction of the object.  select Which fields to fetch  $user=new User_Model. $user->auto_save=TRUE.Properties where Which criteria should the query use. $user->select('email'). Will only select the email field. role should be admin. find_by() etc. You then don't have to call  save() manually.

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

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

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

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

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

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

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

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

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

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

}

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

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

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

• • •

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

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

How to disable
The automatic rendering of the output can be disabled with the following code: 
$this->profiler->disable()

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

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

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

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

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

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

Session Library
Enables applications to persist user state across pages. 

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

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

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

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

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

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

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

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

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

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

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

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

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 .

Array Helper The Array helper assists in transforming arrays via the rotate() and remove() methods.'405') ).  Methods rotate() 'rotate' rotates an array (two­dimensional) matrix. print Kohana::debug($optical_discs). It will result in HTML as:  Array ( [CD] => Array ( [0] => 700 [1] => 780 ) [DVD] => Array ( [0] => 4700 [1] => 650 ) [BD] => Array ( [0] => 25000 [1] => 405 ) ) Array ( [0] => Array ( [CD] => 700 [DVD] => 4700 . 'DVD' => array('4700'. FALSE). '780'). 'BD' => array('25000'. print Kohana::debug($optical_discs). $optical_discs = arr::rotate($optical_discs.'650'). print ('<br /><br />'). 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 ('<br />'). print Kohana::debug($optical_discs).'650'). print Kohana::debug($cd).'405') ). It will result in HTML as:  Array ( [CD] => Array ( [0] => 700 [1] => 780 ) [DVD] => Array ( [0] => 4700 [1] => 650 ) [BD] => Array ( [0] => 25000 [1] => 405 ) ) . 'BD' => array('25000'. '780').[BD] => 25000 ) [1] => Array ( [CD] => 780 [DVD] => 650 [BD] => 405 ) ) remove() 'remove' removes a key from an array and returns it. print ('<br />'). $cd = arr::remove('CD'. 'DVD' => array('4700'. $optical_discs).  The two arguments are:  • • [string] The key you want removed from an array [array] The array you want the key to be removed from Example:  // Please note that the print() statements are for display only $optical_discs = array ( 'CD' => array('700'. print Kohana::debug($optical_discs).

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

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

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

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

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

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

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

) [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.  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 .2002)). The two arguments are:  • • [int] start year– default = current year ­ 5 [int] end year – default = current year + 5  Example:  // Please note that the print() statements are for display purposes only // This example ran in 2007 print Kohana::debug(date::years()). 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.

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

/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. // For a file located in application/downloads // Use relative path download::force('.'downloads/file.txt'). // OR use the defined application path download::force(APPPATH.  Methods force() 'force' forces a download of a file to the user's browser.  • • $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. . 'PM')). 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.txt"). This function is binary­safe and will work  with any MIME type that Kohana is aware of.txt'). The two arguments  are:  • • [int] hour in non­24­hour format [string] AM or PM Example:  // Please note that the print() statements are for display only print Kohana::debug(date::adjust(11.

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

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

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

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

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

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

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

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

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

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

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

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 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Sign up to vote on this title
UsefulNot useful