http_cookie Class Reference

Inheritance diagram for http_cookie:

Public Member Functions
	changeCfg (array $prm)
	doNotSave ($doNotSave=null)
	check ()
	get ($fromBrowser=false)
	set ($value)
	del ()
	save ()
	getRawName ()
	getAttr ($name)
	setAttr ($name, $value)
	getCfg ()

Protected Member Functions
	afterInit ()
	beforeInit ()

Protected Attributes
	$saved = false
	$doNotSave = false
	$cfg

Detailed Description

To manipulate cookie

Definition at line 10 of file cookie.class.php.

Member Function Documentation

afterInit()

afterInit ( )

protected

Definition at line 26 of file cookie.class.php.

beforeInit()

beforeInit ( )

protectedinherited

Call just before the configuration initialisation

Definition at line 35 of file object.class.php.

changeCfg()

changeCfg

(

array

$prm

)

Alter the configuration with an array

Parameters

array

$prm

Definition at line 41 of file cookie.class.php.

check()

check

(

)

Check if the cookie is already set

Returns

bool

Definition at line 64 of file cookie.class.php.

del()

del

(

)

Delete the cookie

Definition at line 98 of file cookie.class.php.

doNotSave()

doNotSave

(

$doNotSave = null

)

get or set the doNotSave attribute

Parameters

nul | bool

$doNotSave

null to get or booleand to set

Returns

void|bool

Definition at line 52 of file cookie.class.php.

get()

get

(

$fromBrowser = false

)

Get the current cookie value

Parameters

bool

$fromBrowser

True if force to get the value from the browser

Returns

mixed|null The value or null if not set

Definition at line 74 of file cookie.class.php.

getAttr()

getAttr (   $name )

inherited

Get an attribute

Parameters

string

$name

Attribute name

Returns

mixed|null The attribute or null if not set

Definition at line 48 of file object.class.php.

getCfg()

getCfg ( )

inherited

Get the configuration object

Returns

config

Definition at line 67 of file object.class.php.

getRawName()

getRawName

(

)

Get the raw cookie name (with the prefix)

Returns

string

Definition at line 131 of file cookie.class.php.

save()

save

(

)

Save the cookie. Should be call by the response only

Returns

bool True if already saved or successful saved, False if not saved

Definition at line 108 of file cookie.class.php.

set()

set

(

$value

)

Set the cookie value

Parameters

mixed

$value

The cookie value

Definition at line 88 of file cookie.class.php.

setAttr()

setAttr (   $name,   $value  )

inherited

Set an attribute

Parameters

string	$name	Attribute name
mixed	$value	Attribute value

Definition at line 58 of file object.class.php.

Field Documentation

$cfg

$cfg	protectedinherited

Definition at line 17 of file object.class.php.

$doNotSave

$doNotSave = false

protected

Definition at line 24 of file cookie.class.php.

$saved

$saved = false

protected

Definition at line 17 of file cookie.class.php.

---

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

• cookie.class.php