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 

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

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

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

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

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

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

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

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

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

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

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

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

Reference .

General .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Core .

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

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

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

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

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

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

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

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

 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. Special characters that are unknown to this method are left untouched.  .'). Further reading: Wikipedia on transliteration  trim ucfirst ucwords View Class For a more in depth overview of views see General/Views. // Output: Jerome est un garcon.

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

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

Addons .

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

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

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. Input validation Set the validation rules for the field.  ->value('input_value') . or  ->label('Custom input name'). Thus.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. If the argument is boolean the input label will be based on the input  name.  ->rules('list|of|validation|rules') Input validation using Kohana Validation helper You can utlize rules from Validation helper by prefixing the rule with valid_. Method is chainable. Method is chainable. Method is chainable. Input label Show the field label or not.  $form->input('input_name'). Also you can pass the custom label name.  ->label(TRUE).  In Kohana 2.

date('Y')+5)>value(strtotime($your_date_var)). wrap it in the PHP strtotime function.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.  Example $form->checkbox('test')->label(TRUE)->value('1')->checked(TRUE). Form_Checklist Example $form->checklist('blocks')->label('Blocks available')->options($option)>rules('required').255]')>value($this->page->title). Example $form->input('title')->label(TRUE)->rules('required|length[0.  example  $form->input('title')->label(TRUE)->class('input_size').  Form_Dropdown You can set dropdown with single array or with two­dimensional array. To pass a MySQL date field  to the value() method. true| false)} where 'value' will be the value of the checkbox. 'label' will be used as the label and the true| false indicates if the item is checked by default.  * Dateselect uses Unix timestamp format internally to calculate dates.  Example $form->dropdown('pizzas')->label(TRUE)->options(array('Hawaiian'. 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. * $option should be sent as an array with each value in the format {'value' = array('label'. Form_Checkbox By default a checkbox checked status is off to turn on just call the checked method and set to true.

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

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

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

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

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

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

Libraries .

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

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

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

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>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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 

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

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

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

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

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

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

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

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

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

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

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

min_length Yes  max_length  Yes  exact_length  Yes  valid_email_ No  rfc  valid_email  No  valid_url  valid_ip  alpha  utf8_alpha  alpha_nume ric  utf8_alpha_ numeric  alpha_dash  utf8_alpha_ dash  digit  utf8_digit  numeric  No  regex  No  depends_on  Yes  range  No  Yes  No  Yes  Return FALSE if length field  value is less than parameter  Return FALSE if length field  value is greater than parameter  Return FALSE if length field  value is not same as parameter  Return FALSE if email is not  rfc822 valid  Return FALSE if email is not  valid  Return FALSE if url is not valid  Return FALSE if ip is not valid  Return FALSE if form field  does not consist only of  alphabetical characters  Return FALSE if form field  does not consist only of  alphabetical or numeric  characters  Returns FALSE if form fields  defined in parameter is not  filled in  depends_on[field_name]  Variable prepping Name  Parameter  Description  prep_for_form  prep_for_url  strip_image_tags  xss_clean  encode_php_tags  .

Helpers .

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

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

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

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

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

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

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

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

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

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

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

[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'). 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.txt")./application/downloads/file.  • • $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. . 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. // For a file located in application/downloads // Use relative path download::force('.'downloads/file. This function is binary­safe and will work  with any MIME type that Kohana is aware of. 'PM')).  Methods force() 'force' forces a download of a file to the user's browser.txt'). // OR use the defined application path download::force(APPPATH.

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

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

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

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

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

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

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

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

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

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

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

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 

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

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

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

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

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

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

3. print Kohana::debug(security::strip_image_tags($string)). <p>Rounding numbers to nearest 5</p> <?php foreach ($numbers as $number): ?> <p>Round <?php echo $number ?> to <?php echo num::round($number.example.jpg .jpg" />'.  • [string] String to be cleansed strip_image_tags() 'strip_image_tags()' strips the image tags out of a string and returns the string trimmed without the  image tags.999). and a nearest integer number to  round too.com/example.  • [string] String to be stripped $string = '<b>Check this image:</b> <img src="http://www.5.example. defaults to 5. An integer to round.Methods round() num::round() accepts two arguments.99.com/example. 5) ?> </p> <?php endforeach ?> This will output as HTML  <p>Rounding numbers to nearest 5</p> <p>Round 1 to 0 </p> <p>Round 3 to 5 </p> <p>Round 5 to 5 </p> <p>Round 9 to 10 </p> <p>Round 99 to 100 </p> <p>Round 999 to 1000 </p> Security Helper The security helper assist in verifying the security of use input.9.  Example  // Given an input of: $numbers = array(1. 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.

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

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

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

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

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

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

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

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

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

Sign up to vote on this title
UsefulNot useful