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 

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

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

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

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

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

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

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

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

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

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

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

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

Reference .

General .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Core .

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

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

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

Config Class
Provides methods for working with configuration items. 

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

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

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

Note:

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

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

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

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

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

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

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

You can also create entirely new events this way: 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

 Special characters that are unknown to this method are left untouched. You  can remove them afterwards with the strip_non_ascii method.  Example:  echo utf8::transliterate_to_ascii('Jérôme est un garçon.'). // Output: Jerome est un garcon.  . Further reading: Wikipedia on transliteration  trim ucfirst ucwords View Class For a more in depth overview of views see General/Views.stristr strlen strpos strrev strrpos strspn strtolower strtoupper substr substr_replace to_unicode transliterate_to_ascii utf8::transliterate_to_ascii() replaces many (not all) special/accented characters by  their ASCII equivalents.

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

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

Addons .

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

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

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

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

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

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

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

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

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

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

Libraries .

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

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

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

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>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

// base_url will default to current uri 'uri_segment' => 'page'.$this->pagination->create_links('digg'). echo '<hr />Extended style: '. digg. // pass a string as uri_segment to trigger former 'label' functionality 'total_items' => 254. echo '<hr />PunBB style: '. echo 'done in {execution_time} seconds'.$this->pagination->create_links('punbb').$this->pagination.php 'style' => 'classic' // pick one from: classic (default). punbb. // Just echoing it is enough to display the links (__toString() rocks!) echo 'Classic style: '.$this->pagination->create_links('extended'). // use db count query here of course 'items_per_page' => 10. 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         » . // it may be handy to set defaults for stuff like this in config/pagination. // You can also use the create_links() method and pick a style on the fly if you want echo '<hr />Digg style: '.LIMIT 3 OFFSET 6 Pagination class properties The following pagination class properties are available for use in your controller:  • • • • • • • • • • • url current_page total_pages  current_first_item  current_last_item  first_page  last_page  previous_page  next_page sql_offset  sql_limit Example One $this->pagination = new Pagination(array( // 'base_url' => 'welcome/pagination_example/page/'. or add your own! )).

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

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

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

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

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

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

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

}

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

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

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

• • •

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

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

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

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

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

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

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

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

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

Session Library
Enables applications to persist user state across pages. 

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

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

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

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

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

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

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

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

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

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

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

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

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

Helpers .

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

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

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

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

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

It will result in HTML as:  Array ( [0] => 0 [1] => 1 [2] => 2 [3] => 3 [4] => 4 [5] => 5 [6] => 6 [7] => 7 [8] => 8 [9] => 9 [10] => 10 [11] => 11 [12] => 12 [13] => 13 [14] => 14 [15] => 15 [16] => 16 [17] => 17 [18] => 18 [19] => 19 [20] => 20 [21] => 21 [22] => 22 [23] => 23 [24] => 24 [25] => 25 [26] => 26 [27] => 27 [28] => 28 [29] => 29 .200. It will result in HTML as:  -3600 3600 0 seconds() 'seconds' creates an array of numbers based on your input The three arguments are:  • • • [int] step (count by) – default = 1 [int] start number – default = 0 [int] end number – default = 60 Example:  // Please note that the print() statements are for display purposes only print Kohana::debug(date::seconds()).1.// Please note that the print() statements are for display purposes only // This example was executed in the EST timezone print (date::offset('CST').7)). print (date::offset('UTC'.'<br />'). 'MST'). print (date::offset('CST'. 'GMT'). print Kohana::debug(date::seconds(100.'<br />'). print Kohana::debug(date::seconds(2.400)).'<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.

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

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)). // 24-hour format of an hour without leading zeros It will result in HTML as:  AM PM PM days() 'days' counts the number of days there are in a specific month of a specific year The two arguments  are:  • • [int] month (1­12) [int] year – default: current year Example:  // Please note that the print() statement is for display purposes only print Kohana::debug(date::days(5. It will result in HTML as:  Array ( [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'))).2007)).

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

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

// OR use the defined application path download::force(APPPATH. 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.'downloads/file.txt").txt')./application/downloads/file.[hours] => 0 [minutes] => 0 [seconds] => 0 ) minutes: 937440 adjust() 'adjust' converts an hour integer into 24­hour format from a non­24­hour format. 'PM')).  • • $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.  Methods force() 'force' forces a download of a file to the user's browser. // For a file located in application/downloads // Use relative path download::force('. The two arguments  are:  • • [int] hour in non­24­hour format [string] AM or PM Example:  // Please note that the print() statements are for display only print Kohana::debug(date::adjust(11.txt'). .

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

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

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

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

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

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

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

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

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

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

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

attributes()
Returns an attribute string, from an array of HTML attributes in key/value format, sorted by form  attributes first.  The parameters are: 

[array] HTML attributes array

Example: 
print form::attributes(array('id' => 'input_name', 'class' => 'submission'));

Outputs 
id="input_name" class="submission"

open_fieldset()
Creates a fieldset opening tag  The parameters are: 
• •

[array] an array of HTML attributes [string] a string to be attached to the end of the attributes

Example: 
print form::open_fieldset(array('class' => 'important'));

Results in HTML 
<fieldset class="important">

close_fieldset()
Generates a fieldset closing tag  Example: 
print form::close_fieldset();

Results in HTML 
</fieldset>

legend()
Creates a legend for describing a fieldset.  The parameters are: 
• • •

[string] legend text or HTML [array] an array of HTML attributes [string] a string to be attached to the end of the attributes

Example: 
print form::legend('More about you', array('id' => 'more_infos'));

Results in HTML 
<legend id="more_infos">More about you</legend>

close()
In order to close the form, you simply need to: 
print form::close()

Or you can set parameter: 
print form::close('</div>')

Result in HTML: 
</form></div>

HTML Helper
The HTML helper assists in calling various elements such as stylesheet, javascript, image links and  anchor links into position. 

Methods
specialchars()
'specialchars' is similar to PHP's htmlspecialchars() function. However, there are some small  differences: 
• • •

It will automatically use the UTF­8 character set in conversion (instead of ISO­8859­1). It will automatically translate both single and double quotes to HTML entities (instead of  only double quotes). It provides built­in fallback functionality for not double encoding existing HTML entities  (for PHP versions older than 5.2.3). [string] The string you want to encode [boolean] Do you want to encode existing HTML entities? – TRUE by default

The two arguments are: 
• •

Example: 
$string = '<p>"I\'m hungry"&mdash;Cookie Monster said.</p>'; echo html::specialchars($string);

It will result in the following HTML: 
&lt;p&gt;&quot;I&#039;m hungry&quot;&amp;mdash;Cookie Monster said.&lt;/p&gt;

When setting the second parameter to FALSE, existing HTML entities are preserved. Look closely  at &mdash;. 
echo html::specialchars($string, FALSE);

&lt;p&gt;&quot;I&#39;m hungry&quot;&mdash;Cookie Monster said.&lt;/p&gt;

query_string()
This method is deprecated and will not be available in Kohana 2.2. Use PHP function  http_build_query() instead  'query_string' creates a HTML query string from an array. The one argument is: 

[array] The string you want to encode

Example: 
echo html::query_string(array ( 'id' => 12, 'page' => 'home' ));

It will result in HTML as: 
id=12&page=home

anchor()
'anchor' creates a HTML anchor (<a href=””></a>), linking an internal page or external site  automatically The four arguments are: 
• • • •

[string] An internal or external page that you would like to link to [string] The title you would like to have show up as the hyperlink [string] Attributes to add to your anchor [string] The protocol your link will use: 'ftp', 'irc', etc. – This is only necessary if it's an  internal page with a non­absolute link for the first argument and you need to change the  protocol from 'http'

Example 1: 
echo html::anchor('home/news', 'Go to our news section!');

It will result in HTML as: 
<a href="http://localhost/home/news">Go to our news section!</a>

Example 2: 
echo html::anchor('irc://irc.freenode.net/kohana', 'Join us on IRC!', 'style="font-size: 20px;"');

It will result in HTML as: 
<a href="irc://irc.freenode.net/kohana" style="font-size: 20px;">Join us on IRC! </a>

file_anchor()
Similar to 'anchor', 'file_anchor' creates a HTML anchor (<a href=””></a>) linking to non­Kohana  resources. Therefore, it will always prefix the site's URL to the path of your file The four arguments 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Sign up to vote on this title
UsefulNot useful