security_public Class Reference

Inheritance diagram for security_public:

Public Member Functions
	isLogged ()
	login ($prm=null, $page=null)
	logout ($prm=null)
	addRole ($role)
	hasRole ($role=null)
	delRole ($role=null)
	check (array $url=null, $redirect=true)
	getLoginForm (array $prm=array())
	protect ($page=null)
	getPage ($type='login', $uri=false)
	getAttr ($name)
	setAttr ($name, $value)
	getCfg ()

Protected Member Functions
	afterInit ()
	hook ($name)
	isContained (array $url, array $checks)
	beforeInit ()

Protected Attributes
	$cfg

Detailed Description

Security class to check user rights, which allow everything to anybody by default

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

Member Function Documentation

addRole()

addRole

(

$role

)

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

afterInit()

afterInit ( )

protectedinherited

Definition at line 12 of file security/abstract.class.php.

beforeInit()

beforeInit ( )

protectedinherited

Call just before the configuration initialisation

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

check()

check	(	array	$url = null,
			$redirect = true
	)

Definition at line 38 of file public.class.php.

delRole()

delRole

(

$role = null

)

Definition at line 34 of file public.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.

getLoginForm()

getLoginForm

(

array

$prm = array()

)

Definition at line 55 of file public.class.php.

getPage()

getPage (   $type = 'login',   $uri = false  )

inherited

Get a configured page

Parameters

string	$type	Pagename (login, logged, logout, forbidden)
bool	$uri	Indiciate if the url should be parsed with request::uri to be used directly

Returns

string The page url

Definition at line 101 of file security/abstract.class.php.

hasRole()

hasRole

(

$role = null

)

Definition at line 30 of file public.class.php.

hook()

hook (   $name )

protectedinherited

Function to be rewritten in eventual child to change the way security works Available actions:

• autoLogin
• autoLoginSession
• login
• redirectError
• logout

Parameters

string

$action

Definition at line 117 of file security/abstract.class.php.

isContained()

isContained ( array  $url, array  $checks  )

protectedinherited

Indicate if a configuration array is contained in the url

Parameters

array	$url
array	$checks

Returns

bool True if a line in $checks matches the $url

Definition at line 126 of file security/abstract.class.php.

isLogged()

isLogged

(

)

Definition at line 12 of file public.class.php.

login()

login	(		$prm = null,
			$page = null
	)

Definition at line 16 of file public.class.php.

logout()

logout

(

$prm = null

)

Definition at line 21 of file public.class.php.

protect()

protect (   $page = null )

inherited

Redirect the user if not logged

Parameters

null | string

$page

Page to redirect or configured page forbidden if not provided

Returns

true|void True if allowed, will be redirected if not

Definition at line 88 of file security/abstract.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.

---

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

• public.class.php