Ibuildings - Docs For Class atkSessionStore

static atkSessionStore	getInstance()	Get the current instance for the session storage
static mixed	getKeyFromSession()	Try to get the current key from the session
static mixed	getRowKeyFromSelector()	Get rowkey from an ATK/SQL selector
static mixed	getSessionManager()	Get the sessionmanager to use
static boolean	isValidRowKey()	Check if the given row key is valid
atkSessionStore	__construct()	Create a new sessionstore
mixed	addDataRow()	Add a row to the current sessionstore.
bool	deleteDataRowForSelector()	Delete a row in the session for a given ATK/SQL selector
mixed	getData()	Get all the data in the session for the current key
mixed	getDataRowForSelector()	Get a data row from the session for an ATK/SQL selector
mixed	getKey()	Get the key for the current sessionstore
mixed	setData()	Set ALL data in the session for the current key
mixed	updateDataRowForSelector()	Update (set) a row in the session for an ATK/SQL selector

[ Top ]

Properties

static array $_instances = array() [line 14]

Instances of the session store, indexed by key

API Tags:

Access:

private

[ Top ]

mixed $_key [line 21]

Key to use

API Tags:

Access:

private

[ Top ]

Methods

static method getInstance [line 30]

static atkSessionStore getInstance(
[mixed
$key = false], [bool
$reset = false] 
)

Get the current instance for the session storage

Parameters:

mixed	$key:	Key to use
bool	$reset:	Wether to reset the singleton

API Tags:

Return:	Storage
Access:	public

[ Top ]

static method getKeyFromSession [line 44]

static mixed getKeyFromSession(
)

Try to get the current key from the session

API Tags:

Return:	Key to use, false if we don't have a key
Access:	private

[ Top ]

static method getRowKeyFromSelector [line 221]

static mixed getRowKeyFromSelector(
string
$selector 
)

Get rowkey from an ATK/SQL selector

We sneak rowkeys in the selectors as negative ids.

Parameters:

string

$selector:

API Tags:

Return:	Key in negative int form or false if we failed to get the key
Access:	private

[ Top ]

static method getSessionManager [line 172]

static mixed getSessionManager(
)

Get the sessionmanager to use

API Tags:

Return:	Sessionmanager or false if we don't have a session
Access:	protected

[ Top ]

static method isValidRowKey [line 239]

static boolean isValidRowKey(
int
$rowKey, array
$data 
)

Check if the given row key is valid

Parameters:

int	$rowKey:	Row key
array	$data:	Data array

API Tags:

Access:

private

[ Top ]

Constructor __construct [line 60]

atkSessionStore __construct(
mixed
$key, [boolean
$reset = false] 
)

Create a new sessionstore

Parameters:

mixed	$key:	Key to use
boolean	$reset:	Reset data

API Tags:

Access:

private

[ Top ]

addDataRow [line 82]

mixed addDataRow(
array
$row, string
$primary_key_field 
)

Add a row to the current sessionstore.

Also sets the primary key field to a fake negative id

Parameters:

array	$row:	Row to store in the session
string	$primary_key_field:	Primary key field to use and set with the row key

API Tags:

Return:	Primary key for the added record, or false if we don't have a session
Access:	public

[ Top ]

deleteDataRowForSelector [line 149]

bool deleteDataRowForSelector(
string
$selector 
)

Delete a row in the session for a given ATK/SQL selector

Parameters:

string

$selector:

ATK/SQL selector

API Tags:

Return:	Wether the deleting succeeded
Access:	public

[ Top ]

getData [line 184]

mixed getData(
)

Get all the data in the session for the current key

API Tags:

Return:	Data in array form or false if we don't have a key or session
Access:	public

[ Top ]

getDataRowForSelector [line 103]

mixed getDataRowForSelector(
string
$selector 
)

Get a data row from the session for an ATK/SQL selector

Parameters:

string

$selector:

API Tags:

Return:	Row or false if there is nothing
Access:	public

[ Top ]

getKey [line 71]

mixed getKey(
)

Get the key for the current sessionstore

API Tags:

Return:	Key
Access:	public

[ Top ]

setData [line 202]

mixed setData(
array
$data 
)

Set ALL data in the session for the current key

Parameters:

array

$data:

Data to set

API Tags:

Return:	Data that was set or false if we don't have a key or session
Access:	public

[ Top ]

updateDataRowForSelector [line 125]

mixed updateDataRowForSelector(
string
$selector, array
$row 
)

Update (set) a row in the session for an ATK/SQL selector

Parameters:

string	$selector:	ATK/SQL selector
array	$row:	New row

API Tags:

Return:	Updated row or false if updating failed
Access:	public

[ Top ]