/library/Zend/Oauth2/Config.php

<?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_Oauth2
 * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 * @version    $Id: Config.php 20232 2010-01-12 17:56:33Z matthew $
 */

/**
 * @category   Zend
 * @package    Zend_Oauth2
 * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 */
class Zend_Oauth2_Config
{

    /**
     * The URL root to append default OAuth endpoint paths.
     *
     * @var string
     */
    protected $_siteUrl = null;

    /**
     * This optional value is used to define where the user is redirected to
     *
     * @var string
     */
    protected $_callbackUrl = null;

    /**
     * An OAuth application's client id
     *
     * @var string
     */
    protected $_clientId = null;

    /**
     * An OAuth application's client secret
     *
     * @var string
     */
    protected $_clientSecret = null;

    /**
     *
     * @var string
     */
    protected $_type = 'web_server';

    /**
     * the secret type
     *
     * @var string
     */
    protected $_secretType = null;

    /**
     *
     * @var string
     */
    protected $_state = null;

    /**
     *
     * @var string
     */
    protected $_immediate = null;

    /**
     * rights that the application wants to get from website, can be string (single) or array (multiple)
     *
     * @var string|array
     */
    protected $_requestedRights = null;

    /**
     * Constructor; create a new object with an optional array|Zend_Config
     * instance containing initialising options.
     *
     * @param  array|Zend_Config $options
     * @return void
     */
    public function __construct($options = null)
    {
        if (!is_null($options)) {
            if ($options instanceof Zend_Config) {
                $options = $options->toArray();
            }
            $this->setOptions($options);
        }
    }

    /**
     * Parse option array or Zend_Config instance and setup options using their
     * relevant mutators.
     *
     * @param  array|Zend_Config $options
     * @return Zend_Oauth_Config
     */
    public function setOptions(array $options)
    {
        foreach ($options as $key => $value) {
            switch ($key) {
                case 'siteUrl':
                    $this->setSiteUrl($value);
                    break;
                case 'callbackUrl':
                    $this->setCallbackUrl($value);
                    break;
                case 'clientId':
                    $this->setClientId($value);
                    break;
                case 'clientSecret':
                    $this->setClientSecret($value);
                    break;
                case 'type':
                    $this->setType($value);
                    break;
                case 'secretType':
                    $this->setSecretType($value);
                    break;
                case 'state':
                    $this->setState($value);
                    break;
                case 'immediate':
                    $this->setImmediate($value);
                    break;
                case 'requestedRights':
                    $this->setRequestedRights($value);
                    break;
            }
        }

        return $this;
    }

    /**
     * Set site url
     *
     * @param  string $key
     * @return Zend_Oauth2_Config
     */
    public function setSiteUrl($siteUrl)
    {
        $this->_siteUrl = $siteUrl;
        return $this;
    }

    /**
     * Get site url
     *
     * @return string
     */
    public function getSiteUrl()
    {
        return $this->_siteUrl;
    }

    /**
     * Set callback url
     *
     * @param  string $callbackUrl
     * @return Zend_Oauth2_Config
     */
    public function setCallbackUrl($callbackUrl)
    {
        $this->_callbackUrl = $callbackUrl;
        return $this;
    }

    /**
     * Get callback url
     *
     * @return string
     */
    public function getCallbackUrl()
    {
        return $this->_callbackUrl;
    }

    /**
     * Set client id
     *
     * @param  string $id
     * @return Zend_Oauth2_Config
     */
    public function setClientId($clientId)
    {
        $this->_clientId = $clientId;
        return $this;
    }

    /**
     * Get client id
     *
     * @return string
     */
    public function getClientId()
    {
        return $this->_clientId;
    }

    /**
     * Set client secret
     *
     * @param  string $id
     * @return Zend_Oauth2_Config
     */
    public function setClientSecret($clientSecret)
    {
        $this->_clientSecret = $clientSecret;
        return $this;
    }

    /**
     * Get client secret
     *
     * @return string
     */
    public function getClientSecret()
    {
        return $this->_clientSecret;
    }

    /**
     * Set type
     *
     * @param  array rights
     * @return Zend_Oauth2_Config
     */
    public function setType($type)
    {
        $this->_type = $type;
        return $this;
    }

    /**
     * Get type
     *
     * @return string
     */
    public function getType()
    {
        return $this->_type;
    }

    /**
     * Set secret type
     *
     * @param  array rights
     * @return Zend_Oauth2_Config
     */
    public function setSecretType($secretType)
    {
        $this->_secretType = $secretType;
        return $this;
    }

    /**
     * Get secret type
     *
     * @return string
     */
    public function getSecretType()
    {
        return $this->_secretType;
    }

    /**
     * Set state
     *
     * @param  string
     * @return Zend_Oauth2_Config
     */
    public function setState($state)
    {
        $this->_state = $state;
        return $this;
    }

    /**
     * Get state
     *
     * @return string
     */
    public function getState()
    {
        return $this->_state;
    }

    /**
     * Set immediate
     *
     * @param  string
     * @return Zend_Oauth2_Config
     */
    public function setImmediate($immediate)
    {
        $this->_immediate = $immediate;
        return $this;
    }

    /**
     * Get immediate
     *
     * @return string
     */
    public function getImmediate()
    {
        return $this->_immediate;
    }

    /**
     * Set requested rights
     *
     * @param  string|array
     * @return Zend_Oauth2_Config
     */
    public function setRequestedRights($rights)
    {
        $this->_requestedRights = $rights;
        return $this;
    }

    /**
     * Get requested rights
     *
     * @return string|array
     */
    public function getRequestedRights()
    {
        return $this->_requestedRights;
    }

}