Docs For Class atkUrlVault

Home

Documentation home

Atk index

Docs For Class atkUrlVault [ package: atk ]

Class: atkUrlVault

Source Location: /security/class.atkurlvault.inc

Class atkUrlVault

Class Overview

Vault for URLs

This class is a 'vault' where you can store urls, and check if a given url is in the vault. By adding all urls to the vault that are displayed on screen and checking the url on each request, you can guard an application against unauthorized url manipulation.

The vault stores its state in the session, so it works across requests.

Located in /security/class.atkurlvault.inc [line 32]

Wiki documentation

Author(s):

Ivo Jansch <ivo@achievo.org>

Information Tags:

Properties

Methods

[ Top ]

Property Summary

array	$m_vault	The array containing all urls in the vault.
int	$m_vaultsize	The maximum capacity of the vault.

[ Top ]

Method Summary

static atkUrlVault	&getInstance()	Get an instance of the vault.
atkUrlVault	atkUrlVault()	Constructor. Do not use directly, atkUrlVault is a singleton.
void	addUrl()	Add a URL to the vault.
True	containsUrl()	Check if an url is in the vault.
int	getSize()	Get the size of the vault.
void	setSize()	Set the size of the vault.
void	_purge()	Remove superfluous URLS from the vault.

[ Top ]

Properties

array $m_vault [line 39]

The array containing all urls in the vault.

API Tags:

Access:

private

[ Top ]

int $m_vaultsize = 100 [line 46]

The maximum capacity of the vault.

API Tags:

Access:

private

[ Top ]

Methods

static method getInstance [line 67]

static atkUrlVault &getInstance(
)

Get an instance of the vault.

[ Top ]

Constructor atkUrlVault [line 53]

atkUrlVault atkUrlVault(
)

Constructor. Do not use directly, atkUrlVault is a singleton.

API Tags:

Access:

private

[ Top ]

addUrl [line 86]

void addUrl(
String
$url 
)

Add a URL to the vault.

If there are more URLS in the vault than its capacity, the oldest URLS are purged.

Parameters:

String

$url:

The url to add to the vault.

[ Top ]

containsUrl [line 98]

True containsUrl(
String
$url 
)

Check if an url is in the vault.

Parameters:

String

$url:

API Tags:

Return:

if the url is in the vault. False if not.

[ Top ]

getSize [line 134]

int getSize(
)

Get the size of the vault.

API Tags:

Return:

The current capacity

[ Top ]

setSize [line 123]

void setSize(
int
$size 
)

Set the size of the vault.

The default size is 100. Note that if the vaultsize is decreased, any items in the vault that do not fit the new capacity are purged.

Parameters:

int

$size:

The new size.

[ Top ]

_purge [line 107]

void _purge(
)

Remove superfluous URLS from the vault.

API Tags:

Access:

private

[ Top ]