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 

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

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

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

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

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

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

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

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

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

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

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

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

Reference .

General .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Core .

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

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

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

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

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

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

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

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

 You  can remove them afterwards with the strip_non_ascii method.stristr strlen strpos strrev strrpos strspn strtolower strtoupper substr substr_replace to_unicode transliterate_to_ascii utf8::transliterate_to_ascii() replaces many (not all) special/accented characters by  their ASCII equivalents.').  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. Special characters that are unknown to this method are left untouched. // Output: Jerome est un garcon.  .

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

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

Addons .

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

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

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

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

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

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

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

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

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

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

Libraries .

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

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

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

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>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

}

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

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

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

• • •

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

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

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

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

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

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

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

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

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

Session Library
Enables applications to persist user state across pages. 

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

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

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

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

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

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

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

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

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

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

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

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

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 .

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

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

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

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

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

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

  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.

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

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

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

time().(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() .(60*60*24*7*50). print Kohana::debug(date::timespan($timestamp. 'years. 'minutes')).days. print Kohana::debug(date::timespan($timestamp.months. 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 .days')). // timestamp of 651 days ago $timestamp2 = time() .Kohana::debug(date::timespan($timestamp.weeks. 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. $timestamp2)). print 'minutes: '.minutes. // timestamp of 350 days ago print Kohana::debug(date::timespan($timestamp)).hours.

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

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

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

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

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

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

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

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

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

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

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

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

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 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Sign up to vote on this title
UsefulNot useful