Json/Server/Cache.php

Show: PublicProtectedPrivateinherited
Table of Contents
Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Json  
Subpackage
Server  
Version
$Id: Cache.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Json_Server_Cache

Package: Zend\Json\Server
Zend_Json_Server_Cache: cache Zend_Json_Server server definition and SMD
Parent(s)
\Zend_Server_Cache
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotectedarray $_skipMethods = array()
staticinherited

Methods to skip when caching server

Inherited from: \Zend_Server_Cache::$$_skipMethods
Default valuearray()Details
Type
array
Inherited_from
\Zend_Server_Cache::$$_skipMethods  

Methods

methodpublicdelete(string $filename) : boolean
staticinherited

Remove a cache file

Inherited from: \Zend_Server_Cache::delete()
Parameters
NameTypeDescription
$filenamestring
Returns
TypeDescription
boolean
methodpublicdeleteSmd(string $filename) : bool
static

Delete a file containing a cached SMD

Parameters
NameTypeDescription
$filenamestring
Returns
TypeDescription
bool
methodpublicget(string $filename, \Zend_Server_Interface $server) : bool
staticinherited

Load server definition from a file

Inherited from: \Zend_Server_Cache::get()

Unserializes a stored server definition from $filename. Returns false if it fails in any way, true on success.

Useful to prevent needing to build the server definition on each request. Sample usage:

if (!Zend_Server_Cache::get($filename, $server)) {
    require_once 'Some/Service/Class.php';
    require_once 'Another/Service/Class.php';

    // Attach Some_Service_Class with namespace 'some'
    $server->attach('Some_Service_Class', 'some');

    // Attach Another_Service_Class with namespace 'another'
    $server->attach('Another_Service_Class', 'another');

    Zend_Server_Cache::save($filename, $server);
}

$response = $server->handle();
echo $response;
Parameters
NameTypeDescription
$filenamestring
$server\Zend_Server_Interface
Returns
TypeDescription
bool
methodpublicgetSmd(string $filename) : string | false
static

Retrieve a cached SMD

On success, returns the cached SMD (a JSON string); an failure, returns boolean false.

Parameters
NameTypeDescription
$filenamestring
Returns
TypeDescription
string | false
methodpublicsave(string $filename, \Zend_Server_Interface $server) : bool
staticinherited

Cache a file containing the dispatch list.

Inherited from: \Zend_Server_Cache::save()

Serializes the server definition stores the information in $filename.

Returns false on any error (typically, inability to write to file), true on success.

Parameters
NameTypeDescription
$filenamestring
$server\Zend_Server_Interface
Returns
TypeDescription
bool
methodpublicsaveSmd(string $filename, \Zend_Json_Server $server) : boolean
static

Cache a service map description (SMD) to a file

Returns true on success, false on failure

Parameters
NameTypeDescription
$filenamestring
$server\Zend_Json_Server
Returns
TypeDescription
boolean
Documentation was generated by phpDocumentor 2.0.0a12.