API Documentation

Json/Server/Cache.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Json  
subpackage
Server  
version
$Id: Cache.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Json_Server_Cache

Zend_Json_Server_Cache: cache Zend_Json_Server server definition and SMD

Extends from
\Zend_Server_Cache
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Json  
subpackage
Server  

Methods

methodpublicdelete( string $filename ) : boolean
static

Remove a cache file

Inherited from: \Zend_Server_Cache::delete()
Parameters
Name Type Description
$filename string
Returns
Type Description
boolean
methodpublicdeleteSmd( string $filename ) : bool
static

Delete a file containing a cached SMD

Parameters
Name Type Description
$filename string
Returns
Type Description
bool
methodpublicget( string $filename, \Zend_Server_Interface $server ) : bool
static

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
Name Type Description
$filename string
$server \Zend_Server_Interface
Returns
Type Description
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
Name Type Description
$filename string
Returns
Type Description
stringfalse
methodpublicsave( string $filename, \Zend_Server_Interface $server ) : bool
static

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
Name Type Description
$filename string
$server \Zend_Server_Interface
Returns
Type Description
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
Name Type Description
$filename string
$server \Zend_Json_Server
Returns
Type Description
boolean
Documentation was generated by DocBlox 0.13.3.