<?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

 * @package    Zend_Serializer

 * @subpackage Adapter

 * @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)

 * @license    http://framework.zend.com/license/new-bsd     New BSD License

 * @version    $Id: AdapterInterface.php 24593 2012-01-05 20:35:02Z matthew $

 */

/**

 * @category   Zend

 * @package    Zend_Serializer

 * @subpackage Adapter

 * @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)

 * @license    http://framework.zend.com/license/new-bsd     New BSD License

 */

interface Zend_Serializer_Adapter_AdapterInterface

{

    /**

     * Constructor

     *

     * @param  array|Zend_Config $opts Serializer options

     * @return void

     */

    public function __construct($opts = array());

    /**

     * Set serializer options

     *

     * @param  array|Zend_Config $opts Serializer options

     * @return Zend_Serializer_Adapter_AdapterInterface

     */

    public function setOptions($opts);

    /**

     * Set a serializer option

     *

     * @param  string $name Option name

     * @param  mixed $value Option value

     * @return Zend_Serializer_Adapter_AdapterInterface

     */

    public function setOption($name, $value);

    /**

     * Get serializer options

     *

     * @return array

     */

    public function getOptions();

    /**

     * Get a serializer option

     *

     * @param  string $name

     * @return mixed

     * @throws Zend_Serializer_Exception

     */

    public function getOption($name);

    /**

     * Generates a storable representation of a value.

     *

     * @param  mixed $value Data to serialize

     * @param  array $options Serialize options

     * @return string

     * @throws Zend_Serializer_Exception

     */

    public function serialize($value, array $options = array());

    /**

     * Creates a PHP value from a stored representation.

     *

     * @param  string $serialized Serialized string

     * @param  array $options Unserialize options

     * @return mixed

     * @throws Zend_Serializer_Exception

     */

    public function unserialize($serialized, array $options = array());

}