API Documentation

Serializer/Adapter/Igbinary.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_Serializer  
subpackage
Adapter  
version
$Id: Igbinary.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Serializer_Adapter_Igbinary

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

Properties

Propertyprivatestring  $_serializedNull= 'null'
static

Serialized null value
Default valuenullDetails
Type
string

Methods

methodpublic__construct( array|\Zend_Config $opts = array ) : void

Constructor

Parameters
Name Type Description
$opts array|\Zend_Config
Throws
Exception Description
\Zend_Serializer_Exception If igbinary extension is not present
methodpublicgetOption( string $name ) : mixed

Get a serializer option

Inherited from: \Zend_Serializer_Adapter_AdapterAbstract::getOption()
Parameters
Name Type Description
$name string
Returns
Type Description
mixed
Throws
Exception Description
\Zend_Serializer_Exception
methodpublicgetOptions( ) : array

Get serializer options

Inherited from: \Zend_Serializer_Adapter_AdapterAbstract::getOptions()
Returns
Type Description
array
methodpublicserialize( mixed $value, array $opts = array ) : string

Serialize PHP value to igbinary

Parameters
Name Type Description
$value mixed
$opts array
Returns
Type Description
string
Throws
Exception Description
\Zend_Serializer_Exception on igbinary error
methodpublicsetOption( string $name, mixed $value ) : \Zend_Serializer_Adapter_AdapterAbstract

Set a serializer option

Inherited from: \Zend_Serializer_Adapter_AdapterAbstract::setOption()
Parameters
Name Type Description
$name string Option name
$value mixed Option value
Returns
Type Description
\Zend_Serializer_Adapter_AdapterAbstract
methodpublicsetOptions( array|\Zend_Config $opts ) : \Zend_Serializer_Adapter_AdapterAbstract

Set serializer options

Inherited from: \Zend_Serializer_Adapter_AdapterAbstract::setOptions()
Parameters
Name Type Description
$opts array|\Zend_Config Serializer options
Returns
Type Description
\Zend_Serializer_Adapter_AdapterAbstract
methodpublicunserialize( string|\binary $serialized, array $opts = array ) : mixed

Deserialize igbinary string to PHP value

Parameters
Name Type Description
$serialized string|\binary
$opts array
Returns
Type Description
mixed
Throws
Exception Description
\Zend_Serializer_Exception on igbinary error
Documentation was generated by DocBlox 0.13.3.