API Documentation

Session/Validator/HttpUserAgent.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_Session  
since
Preview Release 0.2  
version
$Id: HttpUserAgent.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Session_Validator_HttpUserAgent

Zend_Session_Validator_HttpUserAgent

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

Methods

methodprotectedgetValidData( ) : mixed

GetValidData() - This method should be used to retrieve the environment variables that will be needed to 'validate' a session.

Inherited from: \Zend_Session_Validator_Abstract::getValidData()
Returns
Type Description
mixed
methodprotectedsetValidData( mixed $data ) : void

SetValidData() - This method should be used to store the environment variables that will be needed in order to validate the session later in the validate() method.

Inherited from: \Zend_Session_Validator_Abstract::setValidData()

These values are stored in the session in the __ZF namespace, in an array named VALID

Parameters
Name Type Description
$data mixed
methodpublicsetup( ) : void

Setup() - this method will get the current user agent and store it in the session as 'valid data'

methodpublicvalidate( ) : bool

Validate() - this method will determine if the current user agent matches the user agent we stored when we initialized this variable.

Returns
Type Description
bool
Documentation was generated by DocBlox 0.13.3.