Zend Framework: Zend_UserAgent Component Proposal

Proposed Component Name	Zend_UserAgent
Developer Notes	http://framework.zend.com/wiki/display/ZFDEV/Zend_UserAgent
Proposers	Christer Edvartsen
Revision	0.1 - 23 January 2008: Created initial proposal page (wiki revision: 9)

<?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_UserAgent
 * @copyright  Copyright (c) 2005-2007 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 */

/**
 * Decide the type of a user agent
 *
 * @category   Zend
 * @package    Zend_UserAgent
 * @copyright  Copyright (c) 2005-2007 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 */
class Zend_UserAgent
{
    /**
     * List of user agents
     *
     * The list is an array with the name of the user agents as keys, and the type of the agent as
     * value.
     *
     * @var array
     */
    protected $_list = array();

    /**
     * Singleton instance
     *
     * Property is protected to allow extension by overriding {@link getInstance()}.
     *
     * @var Zend_Controller_Front
     */
    protected static $_instance = null;

    /**
     * The string of the current client
     *
     * @var string
     */
    protected $_userAgentString = null;

    /**
     * Type used for browsers
     *
     * @var int
     */
    const TYPE_BROWSER = 1;

    /**
     * Type used for mobile devices
     *
     * @var int
     */
    const TYPE_MOBILE = 2;

    /**
     * Type used for RSS readers
     *
     * @var int
     */
    const TYPE_RSS_READER = 4;

    /**
     * Type used for robots
     *
     * @var int
     */
    const TYPE_ROBOT = 8;

    /**
     * Type used for unknown agents
     *
     * @var int
     */
    const TYPE_UNKNOWN = 16;

    /**
     * When used as a string, the name of the user agent will be returned
     *
     * @return string
     */
    public function __toString()
    {
        return $this->_userAgentString;
    }

    /**
     * Private constructor
     *
     * Calls up the {@link _setup()}; method that sets up the user agent string and loads the list
     * of known user agents.
     */
    protected function __construct()
    {
        $this->_setup();
    }

    /**
     * Setup the object
     *
     * This method will set the user agent string to the one found in the $_SERVER superglobal. If
     * the superglobal is not present this method will throw an exception. The method also loads up
     * the list of known user agents using the {@link _loadList()}; method.
     *
     * @throws Zend_UserAgent_Exception
     */
    protected function _setup()
    {
        if (!isset($_SERVER) || !isset($_SERVER['HTTP_USER_AGENT'])) {
            /** @see Zend_UserAgent_Exception */
            require_once 'Zend/UserAgent/Exception.php';

            throw new Zend_UserAgent_Exception('The $_SERVER superglobal is not present.');
        }

        /* Set the default user agent string using the _SERVER superglobal */
        $this->setUserAgentString($_SERVER['HTTP_USER_AGENT']);

        /* Load the list of user agents */
        $this->_loadList();
    }

    /**
     * Load the list of user agents
     *
     * This method will populate the $_list array that will hold the user agents.
     *
     */
    protected function _loadList()
    {
        /* Populate the list of user agents */
        $this->_list = array( /* ... */ );
    }

    /**
     * Prevent cloning of the object
     */
    private function __clone()
    {
    }

    /**
     * Singleton instance
     *
     * @return Zend_UserAgent
     */
    public static function getInstance()
    {
        if (self::$_instance === null) {
            self::$_instance = new self();
        }

        return self::$_instance;
    }

    /**
     * Set the user agent string
     *
     * This method lowercases $string and stores it as the user agent
     *
     * @param string $string
     * @return Zend_UserAgent
     */
    public function setUserAgentString($string)
    {
        $this->_userAgentString = $string;

        return $this;
    }

    /**
     * Get the user agent string
     *
     * @return string
     */
    public function getUserAgentString()
    {
        return $this->_userAgentString;
    }

    /**
     * See if the user agent is a mobile phone
     *
     * @return boolean
     */
    public function isMobile()
    {
        return (isset($this->_list[$this->_userAgentString]) && $this->_list[$this->_userAgentString] === self::TYPE_MOBILE);
    }

    /**
     * See if the user agent is a regular browser
     *
     * @return boolean
     */
    public function isBrowser()
    {
        return (isset($this->_list[$this->_userAgentString]) && $this->_list[$this->_userAgentString] === self::TYPE_BROWSER);
    }

    /**
     * See if the user agent is an RSS reader
     *
     * @return boolean
     */
    public function isRssReader()
    {
        return (isset($this->_list[$this->_userAgentString]) && $this->_list[$this->_userAgentString] === self::TYPE_RSS_READER);
    }

    /**
     * See if the user agent is a robot
     *
     * @return boolean
     */
    public function isRobot()
    {
        return (isset($this->_list[$this->_userAgentString]) && $this->_list[$this->_userAgentString] === self::TYPE_ROBOT);
    }

    /**
     * Get the type of the user agent
     *
     * @return int
     */
    public function getType()
    {
        if (!isset($this->_list[$this->_userAgentString])) {
            return self::TYPE_UNKNOWN;
        }

        return $this->_list[$this->_userAgentString];
    }
}

<?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_UserAgent
 * @copyright  Copyright (c) 2005-2007 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 */

/** @see Zend_Exception */
require_once 'Zend/Exception.php';

/**
 * @category   Zend
 * @package    Zend_UserAgent
 * @copyright  Copyright (c) 2005-2007 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 */
class Zend_UserAgent_Exception extends Zend_Exception
{}

Page Operations

Browse Space

Zend_UserAgent - Christer Edvartsen

Labels

Zend Framework: Zend_UserAgent Component Proposal

Table of Contents

1. Overview

2. References

3. Component Requirements, Constraints, and Acceptance Criteria

4. Dependencies on Other Framework Components

5. Theory of Operation

6. Milestones / Tasks

7. Class Index

8. Use Cases

9. Class Skeletons