Class: oops_session

Source Location: /modules/module_oops.php

Class oops_session

Class Overview

OOPs session class

Located in /modules/module_oops.php [line 258]

Properties

Methods

[ Top ]

Property Summary

mixed	$keyvault
mixed	$selfdestruct

[ Top ]

Method Summary

static mixed	smarty_oops_session_get()	Smarty get version of the store get
string	clear()	Clear a value from the store
string	get()	Retrieve a key from the vault
string	get_object()	Retrieve an object from a key from the vault
object instance	instance()	Instantiate the session class
string	set()	Store a key in the vault
void	set_message()	Shortcut for a message selfdestruct key
void	set_selfdestruct()	Store a key in the vault, but let it be deleted once it is read once

[ Top ]

Properties

mixed $keyvault = false [line 263]

API Tags:

Access:

protected

[ Top ]

mixed $selfdestruct = false [line 264]

API Tags:

Access:

protected

[ Top ]

Methods

static method smarty_oops_session_get [line 404]

static mixed smarty_oops_session_get(
array
$params, 
&$smarty, object
$smarty 
)

Smarty get version of the store get

Parameters:

array	$params:	smarty tag parameters
object	$smarty:	smarty instance
	&$smarty:

API Tags:

Return:	value of the store contents
Access:	public

[ Top ]

clear [line 385]

string clear(
string
$name, [
$default = NULL] 
)

Clear a value from the store

Parameters:

string	$name:	name of the key to clear
	$default:

API Tags:

Return:	old value of the store or the 'default'
Access:	public

[ Top ]

get [line 304]

string get(
string
$name, [string
$default = NULL] 
)

Retrieve a key from the vault

Parameters:

string	$name:	name of the key to retrieve
string	$default:	value to return if no such key exists

API Tags:

Return:	value of the key or the 'default'
Access:	public

[ Top ]

get_object [line 323]

string get_object(
string
$name, [string
$default = NULL] 
)

Retrieve an object from a key from the vault

Parameters:

string	$name:	name of the key to retrieve
string	$default:	value to return if no such key exists

API Tags:

Return:	value of the key or the 'default'
Access:	public

[ Top ]

instance [line 289]

object instance instance(
)

Instantiate the session class

API Tags:

Return:	of the session class
Access:	public

[ Top ]

set [line 353]

string set(
string
$name, string
$value 
)

Store a key in the vault

Parameters:

string	$name:	name of the key to store
string	$value:	value to store

API Tags:

Return:	old value of the store or NULL if none existed
Access:	public

[ Top ]

set_message [line 375]

void set_message(
string
$message 
)

Shortcut for a message selfdestruct key

Parameters:

string

$message:

message to store

API Tags:

Access:

public

[ Top ]

set_selfdestruct [line 365]

void set_selfdestruct(
string
$name, string
$value 
)

Store a key in the vault, but let it be deleted once it is read once

Parameters:

string	$name:	name of the key to store
string	$value:	value to store

API Tags:

Access:

public

[ Top ]

Documentation generated on Thu, 17 May 2012 01:07:21 +0200 by phpDocumentor 1.4.3

	pivotx

[ class tree: pivotx ] [ index: pivotx ] [ all elements ]