Modules

abstract Kohana_Request_Client

Request Client

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

Class declared in SYSPATH/classes/kohana/request/client.php on line 12.

Properties

protected boolean $_allow_private_cache

Defines whether this client should cache private cache directives

protected Cache $_cache

Caching library for request caching

protected int $_request_time

The timestamp of the request

protected int $_response_time

The timestamp of the response

Methods

public __construct( [ array $params = array(0) ] ) (defined in Kohana_Request_Client)

Creates a new Request_Client object, allows for dependency injection.

Parameters

  • array $params = array(0) - Params

Source Code

public function __construct(array $params = array())
{
	if ($params)
	{
		foreach ($params as $key => $value)
		{
			if (method_exists($this, $key))
			{
				if (property_exists($this, $key) OR property_exists($this, '_'.$key))
				{
					$method = trim($key, '_');
					$this->$method($value);
				}
			}
		}
	}
}

public allow_private_cache( [ boolean $setting = NULL ] ) (defined in Kohana_Request_Client)

Gets or sets the Request_Client::allow_private_cache setting. If set to TRUE, the client will also cache cache-control directives that have the private setting.

Parameters

  • boolean $setting = NULL - Allow caching of privately marked responses

Tags

  • See - http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9

Return Values

  • boolean
  • [Request_Client]

Source Code

public function allow_private_cache($setting = NULL)
{
	if ($setting === NULL)
		return $this->_allow_private_cache;

	$this->_allow_private_cache = (bool) $setting;
	return $this;
}

public cache( [ Kohana_Cache $cache = NULL ] ) (defined in Kohana_Request_Client)

Getter and setter for the internal caching engine, used to cache responses if available and valid.

Parameters

  • Kohana_Cache $cache = NULL - Cache engine to use for caching

Return Values

  • Kohana_Cache
  • Kohana_Request_Client

Source Code

public function cache(Cache $cache = NULL)
{
	if ($cache === NULL)
		return $this->_cache;

	$this->_cache = $cache;
	return $this;
}

public cache_lifetime( Response $response ) (defined in Kohana_Request_Client)

Calculates the total Time To Live based on the specification RFC 2616 cache lifetime rules.

Parameters

  • Response $response required - Response to evaluate

Return Values

  • mixed - TTL value or false if the response should not be cached

Source Code

public function cache_lifetime(Response $response)
{
	// Get out of here if this cannot be cached
	if ( ! $this->set_cache($response))
		return FALSE;

	// Calculate apparent age
	if ($date = $response->headers('date'))
	{
		$apparent_age = max(0, $this->_response_time - strtotime( (string) $date));
	}
	else
	{
		$apparent_age = max(0, $this->_response_time);
	}

	// Calculate corrected received age
	if ($age = $response->headers('age'))
	{
		$corrected_received_age = max($apparent_age, intval( (string) $age));
	}
	else
	{
		$corrected_received_age = $apparent_age;
	}

	// Corrected initial age
	$corrected_initial_age = $corrected_received_age + $this->request_execution_time();

	// Resident time
	$resident_time = time() - $this->_response_time;

	// Current age
	$current_age = $corrected_initial_age + $resident_time;

	// Prepare the cache freshness lifetime
	$ttl = NULL;

	// Cache control overrides
	if ($cache_control = $response->headers('cache-control'))
	{
		// Parse the cache control header
		$cache_control = Response::parse_cache_control( (string) $cache_control);

		if (isset($cache_control['max-age']))
		{
			$ttl = (int) $cache_control['max-age'];
		}

		if (isset($cache_control['s-maxage']) AND isset($cache_control['private']) AND $this->_allow_private_cache)
		{
			$ttl = (int) $cache_control['s-maxage'];
		}

		if (isset($cache_control['max-stale']) AND ! isset($cache_control['must-revalidate']))
		{
			$ttl = $current_age + (int) $cache_control['max-stale'];
		}
	}

	// If we have a TTL at this point, return
	if ($ttl !== NULL)
		return $ttl;

	if ($expires = $response->headers('expires'))
		return strtotime( (string) $expires) - $current_age;

	return FALSE;
}

public cache_response( Request $request [, Response $response = NULL ] ) (defined in Kohana_Request_Client)

Caches a Response using the supplied Cache and the key generated by Request_Client::_create_cache_key.

If not response is supplied, the cache will be checked for an existing one that is available.

Parameters

  • Request $request required - The request
  • Response $response = NULL - Response

Return Values

  • mixed

Source Code

public function cache_response(Request $request, Response $response = NULL)
{
	if ( ! $this->_cache instanceof Cache)
		return FALSE;

	// Check for Pragma: no-cache
	if ($pragma = $request->headers('pragma'))
	{
		if ($pragma instanceof HTTP_Header_Value and $pragma->key == 'no-cache')
			return FALSE;
		elseif (is_array($pragma) and isset($pragma['no-cache']))
			return FALSE;
	}

	if ( ! $response)
	{
		$response = $this->_cache->get($this->create_cache_key($request));
		return ($response !== NULL) ? $response : FALSE;
	}
	else
	{
		if (($ttl = $this->cache_lifetime($response)) === FALSE)
			return FALSE;

		return $this->_cache->set($this->create_cache_key($request), $response, $ttl);
	}
}

public create_cache_key( Request $request ) (defined in Kohana_Request_Client)

Creates a cache key for the request to use for caching Kohana_Response returned by Request::execute.

Parameters

  • Request $request required - Request

Return Values

  • string
  • boolean

Source Code

public function create_cache_key(Request $request)
{
	return sha1($request->url());
}

abstract public execute( Request $request ) (defined in Kohana_Request_Client)

Processes the request, executing the controller action that handles this request, determined by the Route.

  1. Before the controller action is called, the Controller::before method will be called.
  2. Next the controller action will be called.
  3. After the controller action is called, the Controller::after method will be called.

By default, the output from the controller is captured and returned, and no headers are sent.

$request->execute();

Parameters

  • Request $request required - $request

Tags

Return Values

  • Response

Source Code

abstract public function execute(Request $request);

public invalidate_cache( Request $request ) (defined in Kohana_Request_Client)

Invalidate a cached response for the Request supplied. This has the effect of deleting the response from the Cache entry.

Parameters

  • Request $request required - Response to remove from cache

Return Values

  • void

Source Code

public function invalidate_cache(Request $request)
{
	if ( ! $this->_cache instanceof Cache)
		return;

	$this->_cache->delete($this->_create_cache_key($request));

	return;
}

public request_execution_time( ) (defined in Kohana_Request_Client)

Returns the duration of the last request execution. Either returns the time of completed requests or FALSE if the request hasn't finished executing, or is yet to be run.

Return Values

  • mixed

Source Code

public function request_execution_time()
{
	if ($this->_request_time === NULL OR $this->_response_time === NULL)
		return FALSE;

	return $this->_response_time - $this->_request_time;
}

public set_cache( Response $response ) (defined in Kohana_Request_Client)

Controls whether the response can be cached. Uses HTTP protocol to determine whether the response can be cached.

Parameters

  • Response $response required - The Response

Tags

  • See - RFC 2616 http://www.w3.org/Protocols/rfc2616/

Return Values

  • boolean

Source Code

public function set_cache(Response $response)
{
	$headers = (array) $response->headers();
	if ($cache_control = arr::get($headers, 'cache-control'))
	{
		// Parse the cache control
		$cache_control = Response::parse_cache_control( (string) $cache_control);

		// If the no-cache or no-store directive is set, return
		if (array_intersect_key($cache_control, array('no-cache' => NULL, 'no-store' => NULL)))
			return FALSE;

		// Get the directives
		$directives = array_keys($cache_control);

		// Check for private cache and get out of here if invalid
		if ( ! $this->_allow_private_cache and in_array('private', $directives))
		{
			if ( ! isset($cache_control['s-maxage']))
				return FALSE;

			// If there is a s-maxage directive we can use that
			$cache_control['max-age'] = $cache_control['s-maxage'];
		}

		// Check that max-age has been set and if it is valid for caching
		if (isset($cache_control['max-age']) and (int) $cache_control['max-age'] < 1)
			return FALSE;
	}

	if ($expires = arr::get($headers, 'expires') and ! isset($cache_control['max-age']))
	{
		// Can't cache things that have expired already
		if (strtotime( (string) $expires) <= time())
			return FALSE;
	}

	return TRUE;
}