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 

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

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

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

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

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

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

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

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

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

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

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

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

Reference .

General .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Core .

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

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

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

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

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

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

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

chr(128). // 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.'c')).'c').var_dump(utf8::is_ascii("a\0b".chr(7).  Example:  echo utf8::strip_non_ascii('Clichés').  Example:  echo utf8::strip_ascii_ctrl("a\0b".

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

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

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

Addons .

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

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

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

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

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

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

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

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

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

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

Libraries .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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 .

'405') ). print ('<br /><br />'). 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.Array Helper The Array helper assists in transforming arrays via the rotate() and remove() methods. print Kohana::debug($optical_discs). print Kohana::debug($optical_discs). FALSE).  Methods rotate() 'rotate' rotates an array (two­dimensional) matrix. '780'). 'DVD' => array('4700'.'650'). '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'.

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

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

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

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

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

  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.

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

2007)). // 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.ampm() 'ampm' calculates whether the supplied integer makes the hour AM or PM The one argument is:  • [int] hour to calculate Example:  // Please note that the print() statements are for display only // This example ran at 5:45PM EST print Kohana::debug(date::ampm(1)). print Kohana::debug(date::ampm(13)). It will result in HTML as:  Array ( [1] => 1 [2] => 2 [3] => 3 [4] => 4 [5] => 5 [6] => 6 [7] => 7 [8] => 8 [9] => 9 [10] => 10 [11] => 11 [12] => 12 [13] => 13 [14] => 14 [15] => 15 [16] => 16 [17] => 17 [18] => 18 [19] => 19 [20] => 20 [21] => 21 [22] => 22 [23] => 23 . print Kohana::debug(date::ampm(date('G'))).

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

minutes.(60*60*24*7*31*3). // timestamp of 651 days ago $timestamp2 = time() . time().days')). print 'minutes: '. // timestamp of 350 days ago print Kohana::debug(date::timespan($timestamp)). print Kohana::debug(date::timespan($timestamp.months.Kohana::debug(date::timespan($timestamp.) [2007] [2008] [2009] [2010] [2011] [2012] => => => => => => 2007 2008 2009 2010 2011 2012 Array ( [1998] [1999] [2000] [2001] [2002] ) => => => => => 1998 1999 2000 2001 2002 timespan() 'timespan' returns the time between two timestamps in a human readable format The arguments are:  • • • [int] timestamp 1  [int] timestamp 2 – default: current timestamp [string] format – default: 'years. $timestamp2)).days.hours. print Kohana::debug(date::timespan($timestamp. time(). 'minutes')).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 . 'years.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).

  • • $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. This function is binary­safe and will work  with any MIME type that Kohana is aware of. .'downloads/file. // OR use the defined application path download::force(APPPATH. // For a file located in application/downloads // Use relative path download::force('. 'PM')).txt").  Methods force() 'force' forces a download of a file to the user's browser.[hours] => 0 [minutes] => 0 [seconds] => 0 ) minutes: 937440 adjust() 'adjust' converts an hour integer into 24­hour format from a non­24­hour format.txt')./application/downloads/file.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. 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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

'https').php.php' url_suffix = '.php' url_suffix = '.php/.php. Returns  welcome/home While  echo url::current(TRUE).html?query=string echo url::current(). You can pass URL segments via the first one.  // // // // site_domain = 'localhost/kohana/' site_protocol = 'http' index_page = 'index.  // // // // site_domain = 'localhost/kohana/' site_protocol = 'http' index_page = 'index.  // // // // site_domain = 'localhost/kohana/' site_protocol = 'http' index_page = '' url_suffix = '. index_page.html' echo url::site('admin/login'. 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. Generates  http://localhost/kohana/index. This method accepts one optional parameter.  url_suffix defined in config.html' echo url::site().https://localhost/kohana/index. site_domain. Returns  welcome/home?query=string .php site() url::site() returns a URL based on the site_protocol. Generates  https://localhost/kohana/admin/login.html' // Current URL: http://localhost/kohana/index.html url::site() accepts two optional parameters.php/welcome/home.html current() url::current() returns the current URI string.

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

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

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

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

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

Sign up to vote on this title
UsefulNot useful