Modules

  1. –Kohana
    2. Debug
    3. HTTP_Cache
    4. I18n
    5. Kohana
    6. Kohana_Config_Writer
    7. Kohana_Core
    8. Request
    9. Request_Client
    10. Request_Client_Curl
    11. Request_Client_External
    12. Request_Client_HTTP
    13. Request_Client_Internal
    14. Request_Client_Stream
    15. Response
    16. Route
    17. UTF8
    18. View
    19. +Configuration
      1. Config
      2. Config_File
      3. Config_Group
      4. Kohana_Config_File_Reader
      5. Kohana_Config_Reader
      6. Kohana_Config_Source
    20. +Controller
      1. Controller
      2. Controller_Template
      3. Controller_Welcome
    21. +Exceptions
      1. HTTP_Exception
      2. HTTP_Exception_400
      3. HTTP_Exception_401
      4. HTTP_Exception_402
      5. HTTP_Exception_403
      6. HTTP_Exception_404
      7. HTTP_Exception_405
      8. HTTP_Exception_406
      9. HTTP_Exception_407
      10. HTTP_Exception_408
      11. HTTP_Exception_409
      12. HTTP_Exception_410
      13. HTTP_Exception_411
      14. HTTP_Exception_412
      15. HTTP_Exception_413
      16. HTTP_Exception_414
      17. HTTP_Exception_415
      18. HTTP_Exception_416
      19. HTTP_Exception_417
      20. HTTP_Exception_500
      21. HTTP_Exception_501
      22. HTTP_Exception_502
      23. HTTP_Exception_503
      24. HTTP_Exception_504
      25. HTTP_Exception_505
      26. Kohana_Exception
      27. Request_Exception
      28. Session_Exception
      29. UTF8_Exception
      30. Validation_Exception
      31. View_Exception
    22. +HTTP
      1. HTTP
      2. HTTP_Header
      3. HTTP_Message
      4. HTTP_Request
      5. HTTP_Response
    23. +Helpers
      1. Arr
      2. CLI
      3. Cookie
      4. Date
      5. Feed
      6. File
      7. Form
      8. Fragment
      9. HTML
      10. Inflector
      11. Num
      12. Profiler
      13. Text
      14. URL
      15. Upload
    24. +Logging
      1. Log
      2. Log_File
      3. Log_StdErr
      4. Log_StdOut
      5. Log_Syslog
      6. Log_Writer
    25. +Models
      1. Model
    26. +Security
      1. Encrypt
      2. Security
      3. Valid
      4. Validation
    27. +Session
      1. Session
      2. Session_Cookie
      3. Session_Native
  2. +Kohana/Auth
    2. Auth
    3. Auth_File
    4. Auth_ORM
    5. Model_Auth_Role
    6. Model_Auth_User
    7. Model_Auth_User_Token
    8. Model_Role
    9. Model_User
    10. Model_User_Token
  3. +Kohana/Cache
    2. Cache
    3. Cache_Apc
    4. Cache_Arithmetic
    5. Cache_Exception
    6. Cache_File
    7. Cache_GarbageCollect
    8. Cache_Memcache
    9. Cache_MemcacheTag
    10. Cache_Sqlite
    11. Cache_Tagging
    12. Cache_Wincache
  4. +Kohana/Codebench
    2. Codebench
    3. +Controllers
      1. Controller_Codebench
    4. +Tests
      1. Bench_ArrCallback
      2. Bench_AutoLinkEmails
      3. Bench_DateSpan
      4. Bench_ExplodeLimit
      5. Bench_GruberURL
      6. Bench_LtrimDigits
      7. Bench_MDDoBaseURL
      8. Bench_MDDoImageURL
      9. Bench_MDDoIncludeViews
      10. Bench_StripNullBytes
      11. Bench_Transliterate
      12. Bench_URLSite
      13. Bench_UserFuncArray
      14. Bench_ValidColor
      15. Bench_ValidURL
  5. +Kohana/Database
    2. DB
    3. Database
    4. Database_Expression
    5. +Configuration
      1. Config_Database
      2. Config_Database_Reader
      3. Config_Database_Writer
    6. +Drivers
      1. Database_MySQL
      2. Database_PDO
    7. +Exceptions
      1. Database_Exception
    8. +Models
      1. Model_Database
    9. +Query
      1. Database_Query
      2. Database_Query_Builder
      3. Database_Query_Builder_Delete
      4. Database_Query_Builder_Insert
      5. Database_Query_Builder_Join
      6. Database_Query_Builder_Select
      7. Database_Query_Builder_Update
      8. Database_Query_Builder_Where
    10. +Query/Result
      1. Database_MySQL_Result
      2. Database_Result
      3. Database_Result_Cached
    11. +Session
      1. Session_Database
  6. +Kohana/Image
    2. Image
    3. +Drivers
      1. Image_GD
      2. Image_Imagick
  7. +Kohana/ORM
    2. ORM
    3. ORM_Validation_Exception
  8. +Kohana/UnitTest
    2. Unittest_Database_TestCase
    3. Unittest_Tests
  9. +Kohana/Userguide
    2. Kodoc
    3. Kodoc_Class
    4. Kodoc_Markdown
    5. Kodoc_Method
    6. Kodoc_Method_Param
    7. Kodoc_Property
    8. +Controllers
      1. Controller_Userguide
    9. +Undocumented
      1. Kodoc_Missing
  10. +[Unknown]
    2. Unittest_Helpers
    3. Unittest_TestCase
    4. Unittest_TestSuite

View
extends Kohana_View

Acts as an object wrapper for HTML pages with embedded PHP, called "views". Variables can be assigned with the view object and referenced locally within the view.

package
Kohana
category
Base
author
Kohana Team
copyright
© 2008-2012 Kohana Team
license
http://kohanaframework.org/license

Class declared in SYSPATH/classes/view.php on line 3.

Constants

  • None

Properties

Methods

Properties

protected $_data

protected $_file

protected static $_global_data

array(0)

Methods

public __construct( [ string $file = NULL , array $data = NULL ] ) (defined in Kohana_View)

Sets the initial view filename and local data. Views should almost always only be created using View::factory.

?
$view = new View($file);

Parameters

  • string $file = NULL - View filename
  • array $data = NULL - Array of values

Tags

Return Values

  • void

Source Code

?
public function __construct($file = NULL, array $data = NULL)
{
    if ($file !== NULL)
    {
        $this->set_filename($file);
    }
 
    if ($data !== NULL)
    {
        // Add the values to the current data
        $this->_data = $data + $this->_data;
    }
}

public __get( string $key ) (defined in Kohana_View)

Magic method, searches for the given variable and returns its value. Local variables will be returned before global variables.

?
$value = $view->foo;

If the variable has not yet been set, an exception will be thrown.

Parameters

  • string $key required - Variable name

Tags

Return Values

  • mixed

Source Code

?
public function & __get($key)
{
    if (array_key_exists($key, $this->_data))
    {
        return $this->_data[$key];
    }
    elseif (array_key_exists($key, View::$_global_data))
    {
        return View::$_global_data[$key];
    }
    else
    {
        throw new Kohana_Exception('View variable is not set: :var',
            array(':var' => $key));
    }
}

public __isset( string $key ) (defined in Kohana_View)

Magic method, determines if a variable is set.

?
isset($view->foo);

NULL variables are not considered to be set by isset.

Parameters

  • string $key required - Variable name

Return Values

  • boolean

Source Code

?
public function __isset($key)
{
    return (isset($this->_data[$key]) OR isset(View::$_global_data[$key]));
}

public __set( string $key , mixed $value ) (defined in Kohana_View)

Magic method, calls View::set with the same parameters.

?
$view->foo = 'something';

Parameters

  • string $key required - Variable name
  • mixed $value required - Value

Return Values

  • void

Source Code

?
public function __set($key, $value)
{
    $this->set($key, $value);
}

public __toString( ) (defined in Kohana_View)

Magic method, returns the output of View::render.

Tags

Return Values

  • string

Source Code

?
public function __toString()
{
    try
    {
        return $this->render();
    }
    catch (Exception $e)
    {
        // Display the exception message
        Kohana_Exception::handler($e);
 
        return '';
    }
}

public __unset( string $key ) (defined in Kohana_View)

Magic method, unsets a given variable.

?
unset($view->foo);

Parameters

  • string $key required - Variable name

Return Values

  • void

Source Code

?
public function __unset($key)
{
    unset($this->_data[$key], View::$_global_data[$key]);
}

public bind( string $key , mixed & $value ) (defined in Kohana_View)

Assigns a value by reference. The benefit of binding is that values can be altered without re-setting them. It is also possible to bind variables before they have values. Assigned values will be available as a variable within the view file:

?
// This reference can be accessed as $ref within the view
$view->bind('ref', $bar);

Parameters

  • string $key required - Variable name
  • byref mixed $value required - Referenced variable

Return Values

  • $this

Source Code

?
public function bind($key, & $value)
{
    $this->_data[$key] =& $value;
 
    return $this;
}

public static bind_global( string $key , mixed & $value ) (defined in Kohana_View)

Assigns a global variable by reference, similar to View::bind, except that the variable will be accessible to all views.

?
View::bind_global($key, $value);

Parameters

  • string $key required - Variable name
  • byref mixed $value required - Referenced variable

Return Values

  • void

Source Code

?
public static function bind_global($key, & $value)
{
    View::$_global_data[$key] =& $value;
}

public static factory( [ string $file = NULL , array $data = NULL ] ) (defined in Kohana_View)

Returns a new View object. If you do not define the "file" parameter, you must call View::set_filename.

?
$view = View::factory($file);

Parameters

  • string $file = NULL - View filename
  • array $data = NULL - Array of values

Return Values

  • View

Source Code

?
public static function factory($file = NULL, array $data = NULL)
{
    return new View($file, $data);
}

public render( [ string $file = NULL ] ) (defined in Kohana_View)

Renders the view object to a string. Global and local data are merged and extracted to create local variables within the view file.

?
$output = $view->render();

Global variables with the same key name as local variables will be overwritten by the local variable.

Parameters

  • string $file = NULL - View filename

Tags

Return Values

  • string

Source Code

?
public function render($file = NULL)
{
    if ($file !== NULL)
    {
        $this->set_filename($file);
    }
 
    if (empty($this->_file))
    {
        throw new View_Exception('You must set the file to use within your view before rendering');
    }
 
    // Combine local and global data and capture the output
    return View::capture($this->_file, $this->_data);
}

public set( string $key [, mixed $value = NULL ] ) (defined in Kohana_View)

Assigns a variable by name. Assigned values will be available as a variable within the view file:

?
// This value can be accessed as $foo within the view
$view->set('foo', 'my value');

You can also use an array to set several values at once:

?
// Create the values $food and $beverage in the view
$view->set(array('food' => 'bread', 'beverage' => 'water'));

Parameters

  • string $key required - Variable name or an array of variables
  • mixed $value = NULL - Value

Return Values

  • $this

Source Code

?
public function set($key, $value = NULL)
{
    if (is_array($key))
    {
        foreach ($key as $name => $value)
        {
            $this->_data[$name] = $value;
        }
    }
    else
    {
        $this->_data[$key] = $value;
    }
 
    return $this;
}

public set_filename( string $file ) (defined in Kohana_View)

Sets the view filename.

?
$view->set_filename($file);

Parameters

  • string $file required - View filename

Tags

Return Values

  • View

Source Code

?
public function set_filename($file)
{
    if (($path = Kohana::find_file('views', $file)) === FALSE)
    {
        throw new View_Exception('The requested view :file could not be found', array(
            ':file' => $file,
        ));
    }
 
    // Store the file path locally
    $this->_file = $path;
 
    return $this;
}

public static set_global( string $key [, mixed $value = NULL ] ) (defined in Kohana_View)

Sets a global variable, similar to View::set, except that the variable will be accessible to all views.

?
View::set_global($name, $value);

Parameters

  • string $key required - Variable name or an array of variables
  • mixed $value = NULL - Value

Return Values

  • void

Source Code

?
public static function set_global($key, $value = NULL)
{
    if (is_array($key))
    {
        foreach ($key as $key2 => $value)
        {
            View::$_global_data[$key2] = $value;
        }
    }
    else
    {
        View::$_global_data[$key] = $value;
    }
}

protected static capture( string $kohana_view_filename , array $kohana_view_data ) (defined in Kohana_View)

Captures the output that is generated when a view is included. The view data will be extracted to make local variables. This method is static to prevent object scope resolution.

?
$output = View::capture($file, $data);

Parameters

  • string $kohana_view_filename required - Filename
  • array $kohana_view_data required - Variables

Return Values

  • string

Source Code

?
protected static function capture($kohana_view_filename, array $kohana_view_data)
{
    // Import the view variables to local namespace
    extract($kohana_view_data, EXTR_SKIP);
 
    if (View::$_global_data)
    {
        // Import the global view variables to local namespace
        extract(View::$_global_data, EXTR_SKIP | EXTR_REFS);
    }
 
    // Capture the view output
    ob_start();
 
    try
    {
        // Load the view within the current scope
        include $kohana_view_filename;
    }
    catch (Exception $e)
    {
        // Delete the output buffer
        ob_end_clean();
 
        // Re-throw the exception
        throw $e;
    }
 
    // Get the captured output and close the buffer
    return ob_get_clean();
}