oxUtilsServer Class Reference

Inheritance diagram for oxUtilsServer:

Inheritance graph
[legend]
Collaboration diagram for oxUtilsServer:

Collaboration graph
[legend]

List of all members.


Detailed Description

Server data manipulation class

Definition at line 6 of file oxutilsserver.php.


Public Member Functions

 setOxCookie ($sName, $sValue="", $iExpire=0, $sPath= '/')
 getOxCookie ($sName=null)
 getRemoteAddress ()
 getServerVar ($sServVar=null)
 setUserCookie ($sUser, $sPassword, $sShopId=null, $iTimeout=31536000)
 deleteUserCookie ($sShopId=null)
 getUserCookie ($sShopId=null)

Static Public Member Functions

static getInstance ()

Protected Attributes

 $_aUserCookie = array()

Static Private Attributes

static $_instance = null

Member Function Documentation

static oxUtilsServer.getInstance (  )  [static]

Returns server utils instance

Returns:
oxUtilsServer

Definition at line 27 of file oxutilsserver.php.

oxUtilsServer.setOxCookie ( sName,
sValue = "",
iExpire = 0,
sPath = '/' 
)

sets cookie

Parameters:
string $sName cookie name
string $sValue value
int $iExpire expire time
string $sPath The path on the server in which the cookie will be available on
Returns:
bool

Definition at line 54 of file oxutilsserver.php.

oxUtilsServer.getOxCookie ( sName = null  ) 

Returns cookie $sName value. If optional parameter $sName is not set then getCookie() returns whole cookie array

Parameters:
string $sName cookie param name
Returns:
mixed

Definition at line 80 of file oxutilsserver.php.

oxUtilsServer.getRemoteAddress (  ) 

Returns remote IP address

Returns:
string

Definition at line 98 of file oxutilsserver.php.

oxUtilsServer.getServerVar ( sServVar = null  ) 

returns a server constant

Parameters:
string $sServVar optional - which server var should be returned, if null returns whole $_SERVER
Returns:
mixed

Definition at line 117 of file oxutilsserver.php.

oxUtilsServer.setUserCookie ( sUser,
sPassword,
sShopId = null,
iTimeout = 31536000 
)

Sets user info into cookie

Parameters:
string $sUser user ID
string $sPassword password
string $sShopId shop ID (default null)
integer $iTimeout timeout value (default 31536000)
Returns:
null

Definition at line 140 of file oxutilsserver.php.

oxUtilsServer.deleteUserCookie ( sShopId = null  ) 

Deletes user cookie data

Parameters:
string $sShopId shop ID (default null)
Returns:
null

Definition at line 154 of file oxutilsserver.php.

oxUtilsServer.getUserCookie ( sShopId = null  ) 

Returns cookie stored used login data

Parameters:
string $sShopId shop ID (default null)
Returns:
string

Definition at line 168 of file oxutilsserver.php.


Member Data Documentation

oxUtilsServer.$_instance = null [static, private]

Definition at line 13 of file oxutilsserver.php.

oxUtilsServer.$_aUserCookie = array() [protected]

Definition at line 20 of file oxutilsserver.php.


The documentation for this class was generated from the following file:

Generated on Wed Apr 22 12:33:15 2009 for OXID eShop CE by  doxygen 1.5.5