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 

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

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

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

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

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

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

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

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

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

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

4. make it Page_Model 2. The file names should also  have the same caps as the class name (without the core).  References to those classes need to be capitalized to match the library calls (without the core). Example: html::anchor() instead of anchor() Example: url::base instead of base_url() Example: form::open() instead of form_open() The default helpers are available in system/helpers If you have custom helpers they need to be changed. be sure to call parent::__construct() Libraries Base Controllers If you have a base controller for your application (in the libraries folder) your will need to:  1.  Helpers Change all your helper calls to the new syntax: helper::function()  1.  Note also that the CodeIgniter helpers and libraries typically have this line at the top of the script:  <?php if (!defined('BASEPATH')) exit('No direct script access allowed'). prepend public static in front of all the function names Calls are now made via foo::function(). new  View()) without including the class first. Kohana uses auto loading so you can instantiate an object (e.g. Change all your model loads to just model name: $this→load→model('page') 3. Change references to MY_Controller in your controllers to Controller 3. Use the PHP5 syntax for the constructor in your base controller URI The CI function uri_to_assoc($offset) becomes segment_array($offset. if your old model was PageModel. wrap all the functions in the file in class foo { } 2. $associative) with $associative set to TRUE. If you add a __construct() function. For example. 3.php:  1. 2. Note: This also applies to Models! Rename all your models to {NAME}_Model  1.  This is not valid for Kohana so if you have copied this line for your own helpers etc you need to  .3.  Other Class names need to have _Core appended to them and be capitalized.  $this→load→ is deprecated. Change the MY_Controller extends Controller to Controller extends Controller_Core 2. Assuming your helper file is foo.

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

Reference .

General .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Core .

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

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

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

Config Class
Provides methods for working with configuration items. 

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

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

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

Note:

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

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

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

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

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

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

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

You can also create entirely new events this way: 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.  Example:  echo utf8::transliterate_to_ascii('Jérôme est un garçon. You  can remove them afterwards with the strip_non_ascii method.'). Special characters that are unknown to this method are left untouched.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.  .

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

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

Addons .

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

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

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

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

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

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

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

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

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

float: right.php to display the menu:  <html> <head> <title><?php echo $title. border: 1px solid lightgreen. ?></title> </head> <body> <?php echo $menu ?> <?php echo $content ?> <?php echo $copyright.<div style="width: 100px."> <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    .

Libraries .

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

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

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

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

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

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

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

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

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

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

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

20 27

21 28

22 29

23 30

24 31

25 26 1 2

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

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

Table of Contents
• • • • • • •

  Configuration     Connecting     Querying     Query Builder     Query Result     Metadata     Query Caching  

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

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

echo $row->email; }

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

}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

print Kohana::debug(date::seconds(100.'<br />').400)).'<br />'). print Kohana::debug(date::seconds(2. 'MST'). It will result in HTML as:  Array ( [0] => 0 [1] => 1 [2] => 2 [3] => 3 [4] => 4 [5] => 5 [6] => 6 [7] => 7 [8] => 8 [9] => 9 [10] => 10 [11] => 11 [12] => 12 [13] => 13 [14] => 14 [15] => 15 [16] => 16 [17] => 17 [18] => 18 [19] => 19 [20] => 20 [21] => 21 [22] => 22 [23] => 23 [24] => 24 [25] => 25 [26] => 26 [27] => 27 [28] => 28 [29] => 29 . print (date::offset('UTC'.'<br />').200. 'GMT'). 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()).// Please note that the print() statements are for display purposes only // This example was executed in the EST timezone print (date::offset('CST'). print (date::offset('CST'.7)).1.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Sign up to vote on this title
UsefulNot useful