Modules

  1. –Kohana
    2. Debug
    3. I18n
    4. Kohana
    5. Kohana_Core
    6. Request
    7. Request_Client
    8. Request_Client_External
    9. Request_Client_Internal
    10. Response
    11. Route
    12. UTF8
    13. View
    14. +Cache
      1. Cache_Xcache
    15. +Configuration
      1. Config
      2. Config_File
      3. Config_Reader
    16. +Controller
      1. Controller
      2. Controller_REST
      3. Controller_Template
      4. Controller_Welcome
    17. +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. Kohana_Request_Exception
      28. Kohana_View_Exception
      29. Validation_Exception
    18. –HTTP
      1. HTTP
      2. HTTP_Header
      3. HTTP_Header_Value
    19. +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
    20. +Logging
      1. Log
      2. Log_File
      3. Log_StdErr
      4. Log_StdOut
      5. Log_Syslog
      6. Log_Writer
    21. +Models
      1. Model
    22. +Security
      1. Encrypt
      2. Security
      3. Valid
      4. Validation
    23. +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_Eaccelerator
    5. Cache_File
    6. Cache_Memcache
    7. Cache_MemcacheTag
    8. Cache_Sqlite
    9. Cache_Wincache
    10. Kohana_Cache_Exception
    11. Kohana_Cache_GarbageCollect
    12. Kohana_Cache_Tagging
  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
    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
  7. +Kohana/ORM
    2. ORM
    3. ORM_Validation_Exception
  8. +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
  9. +[Unknown]
    2. HTTP_Interaction
    3. HTTP_Request
    4. HTTP_Response

HTTP_Header_Value
extends Kohana_HTTP_Header_Value

Kohana_HTTP_Header_Value represents a value assigned to an HTTP header, i.e.

?
Accept: [key=]value[; property[=property_value][; ...]]

Values are either single values,

package
Kohana
category
HTTP
author
Kohana Team
since
3.1.0
copyright
© 2008-2012 Kohana Team
license
http://kohanaphp.com/license

Class declared in SYSPATH/classes/http/header/value.php on line 3.

Constants

  • None

Properties

Methods

Properties

public static float $default_quality

The default quality header property value

float 1

public void|string $key

public array $properties

public array $value

Methods

public __construct( mixed $value [, boolean $no_parse = bool FALSE ] ) (defined in Kohana_HTTP_Header_Value)

Builds the header field

Parameters

  • mixed $value required - Value configuration array passed
  • boolean $no_parse = bool FALSE - No_parse skip parsing of the string (i.e. user-agent)

Tags

Source Code

?
public function __construct($value, $no_parse = FALSE)
{
    // If no parse is set, set the value and get out of here (user-agent)
    if ($no_parse)
    {
        $this->key = NULL;
        $this->value = $value;
        return;
    }
 
    // If configuration array passed
    if (is_array($value))
    {
        // Parse each value
        foreach ($value as $k => $v)
        {
            // If the key is a property
            if (property_exists($this, $k))
            {
                // Map values
                $this->$k = $v;
            }
        }
 
    }
    // If value is a string
    elseif (is_string($value))
    {
        // Detect properties
        if (strpos($value, ';') !== FALSE)
        {
            // Remove properties from the string
            $parts = explode(';', $value);
            $value = array_shift($parts);
 
            // Parse the properties
            $properties = array();
 
            // Foreach part
            foreach ($parts as $part)
            {
                // Merge the parsed values
                $properties = array_merge(HTTP_Header_Value::parse_key_value($part), $properties);
            }
 
            // Apply the parsed values
            $this->properties = $properties;
        }
 
        // Parse the value and get key
        $value = HTTP_Header_Value::parse_key_value($value);
        $key = key($value);
 
        // If the key is a string
        if (is_string($key))
        {
            // Apply the key as a property
            $this->key = $key;
        }
 
        // Apply the value
        $this->value = current($value);
    }
    // Unrecognised value type
    else
    {
        throw new HTTP_Exception_500(__METHOD__.' unknown header value type: :type. array or string allowed.', array(':type' => gettype($value)));
    }
}

public __toString( ) (defined in Kohana_HTTP_Header_Value)

Magic method to handle object being cast to string. Produces the following header value syntax

?
[key=]value[; property[=property_value][; ... ]]

Return Values

  • string

Source Code

?
public function __toString()
{
 
    $string = ($this->key !== NULL) ? ($this->key.'='.$this->value) : $this->value;
 
    if ($this->properties)
    {
        $props = array($string);
        foreach ($this->properties as $k => $v)
        {
            $props[] = is_int($k) ? $v : ($k.'='.$v);
        }
        $string = implode('; ', $props);
    }
 
    return $string;
}

public key( [ string $key = NULL ] ) (defined in Kohana_HTTP_Header_Value)

Provides direct access to the key of this header value

Parameters

  • string $key = NULL - Key value to set

Return Values

  • mixed

Source Code

?
public function key($key = NULL)
{
    if ($key === NULL)
    {
        return $this->key;
    }
    else
    {
        $this->key = $key;
        return $this;
    }
}

public static parse_key_value( string $string [, string $separator = string(1) "=" ] ) (defined in Kohana_HTTP_Header_Value)

Detects and returns key/value pairs

Parameters

  • string $string required - String to parse
  • string $separator = string(1) "=" - $separator

Return Values

  • array

Source Code

?
public static function parse_key_value($string, $separator = '=')
{
    $parts = explode($separator, trim($string), 2);
 
    if (count($parts) == 1)
    {
        return $parts;
    }
    else
    {
        return array($parts[0] => $parts[1]);
    }
}

public properties( [ array $properties = array(0) ] ) (defined in Kohana_HTTP_Header_Value)

Provides direct access to the properties of this header value

Parameters

  • array $properties = array(0) - Properties to set to this value

Return Values

  • mixed

Source Code

?
public function properties(array $properties = array())
{
    if ( ! $properties)
    {
        return $this->properties;
    }
    else
    {
        $this->properties = $properties;
        return $this;
    }
}

public value( [ string $value = NULL ] ) (defined in Kohana_HTTP_Header_Value)

Provides direct access to the value of this header value

Parameters

  • string $value = NULL - Value to set

Return Values

  • mixed

Source Code

?
public function value($value = NULL)
{
    if ($value === NULL)
    {
        return $this->value;
    }
    else
    {
        $this->value = $value;
        return $this;
    }
}