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. 

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.

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. 

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.

• • • • • • •

Highly secure Extremely lightweight Short learning curve Uses the MVC pattern 100% UTF­8 compatible Loosely coupled architecture Extremely easy to extend

• • • • •

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

Most of the Kohana source code is written by the Kohana Team. There are a few notable credits,  however. 

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. 

All of the Kohana UTF­8 functions are ported from the phputf8 project. 

phputf8 is © 2005 Harry Fuecks. 

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 

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 

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 

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

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

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

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

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

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

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

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

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

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

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

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

Reference .

General .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

User_Model // get_user_name is a method defined in Inheriting If.  The file would initially look something like this:  <?php defined('SYSPATH') or die('No direct script access. you can add the following to the Template_Controller constructor:  $this->user = new User_Model. case doesn't matter // Deprecated as of Kohana 2.php and the class would be called User_Model (which are both singular names). 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.  // Model name is called without _Model. for example.1 $this->load->model('user').php add the  following to your controller:  $user = new User_Model. } } Loading models The generally accepted way of loading a Model in Kohana is to do so within your Controller.'). $name = $user->get_user_name($id). you use the Kohana Template_Controller and need access to your model from all  descendant controllers.  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. $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().2. like  this:  $name = $user->get_user_name($id).that represents the users table would reside in the file application/models/user. to load the user model (above) from application/models/user.

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

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

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

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

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

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

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

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

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

Core .

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

[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' => '' );

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. 


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. 

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. 

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. 

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

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'));

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. 

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. 

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. 

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 one or all callbacks from an event. 
// Clears the "oof" function from system.post_controller Event::clear('system.post_controller', 'oof');

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

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

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

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

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

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

'c').chr(7).  Example:  echo utf8::strip_ascii_ctrl("a\0b". // 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. // Output: abc strip_non_ascii utf8::strip_non_ascii() removes all non­ASCII characters from a string.var_dump(utf8::is_ascii("a\0b". // Output: Clichs .'c')).  Example:  echo utf8::strip_non_ascii('Clichés').chr(128).

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

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

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

Addons .

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

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

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

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

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

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

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

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

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

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

Libraries .

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

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

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

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

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
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)

$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); }


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  Drivers The payment library uses drivers much like the Database library does in order to keep the API  consistent between payment gateways. It currently supports the following gateways:  . They may also have driver specific fields  that are noted in the Driver section.• • • • • • • • • • • • • • • • • • • • amount tax shipping first_name last_name company address city state zip email phone fax  ship_to_first_name ship_to_last_name ship_to_company ship_to_address ship_to_city ship_to_state ship_to_zip Specific drivers may require some or all of these fields.  Methods The payment library has a minimal set of methods to use:  set_fields() This method allows you to set bulk payment attributes with an array. simply call this method in an if test.  $payment = new Payment(). process() This method does the magic. $attributes = array ( 'card_num' = '1234567890123456'. 'exp_date' = '0510' }. $payment->set_fields($attributes). After you set your attributes. The  method returns TRUE on successful payment transaction or an error string on failure. It is up to you  how to handle the failure.

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

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

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

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

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

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

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

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

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

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

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

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

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

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 .

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

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

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

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

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

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

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

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

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

2002)).  Example:  // Please note that the print() statement is for display purposes only print Kohana::debug(date::months()). print Kohana::debug(date::years(1998. It will result in HTML as:  Array ( [2002] [2003] [2004] [2005] [2006] => => => => => 2002 2003 2004 2005 2006 . 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. 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()).) [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.

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

txt').'downloads/file. The two arguments  are:  • • [int] hour in non­24­hour format [string] AM or PM Example:  // Please note that the print() statements are for display only print Kohana::debug(date::adjust(11. It will result in HTML as:  23 Download Helper The download helper assists in forcing downloading of files by presenting users with the “save as”  dialog.  Methods force() 'force' forces a download of a file to the user's browser.[hours] => 0 [minutes] => 0 [seconds] => 0 ) minutes: 937440 adjust() 'adjust' converts an hour integer into 24­hour format from a non­24­hour format. . // OR use the defined application path download::force(APPPATH.txt'). 'PM')). This function is binary­safe and will work  with any MIME type that Kohana is aware of. // For a file located in application/downloads // Use relative path download::force('./application/downloads/file.  • • $filename ­ [string] filename of the file to be downloaded – default = ”” $data ­ [string] data to be sent if the filename does not exists – default = ”” Example:  // File path is relative to the front controller download::force("file.txt").

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

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

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

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

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

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

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

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

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

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

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

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

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

id="input_name" class="submission"

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

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

Results in HTML 
<fieldset class="important">

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

Results in HTML 

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

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

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

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: 

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

'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: 
• •

$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;

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

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

It will result in HTML as: 

'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>

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 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Sign up to vote on this title
UsefulNot useful