Application Delegate Class Methods

Permissions
	getPermissions (Dataface_Record $record)
	Returns associative array of permissions that should be granted to the current user on the specified record.
	getRoles (Dataface_Record $record)
	Returns one or more roles that are to be granted to the current user for the specified record.
Triggers
	after_action_activate ()
	after_action_login ()
	after_action_logout ()
	after_action_edit ()
	after_action_new ()
	after_action_delete ()
	before_authenticate ()
	beforeHandleRequest ()
	startSession ()
Registration
	afterRegister (Dataface_Record $user)
	validateRegistrationForm (array $values)
	sendRegistrationActivationEmail (Dataface_Record $user, $activationURL)
	getRegistrationActivationEmailInfo (Dataface_Record $user, $activationURL)
	getRegistrationActivationEmailSubject (Dataface_Record $user, $activationURL)
	getRegistrationActivationEmailMessage (Dataface_Record $user, $activationURL)
	getRegistrationActivationEmailParameters (Dataface_Record $user, $activationURL)
	getRegistrationActivationEmailHeaders (Dataface_Record $user, $activationURL)
Forgot Password
	getPasswordChangedEmailInfo (Dataface_Record $user, $password)
	getResetPasswordEmailInfo (Dataface_Record $user, $reset_url)
RSS Feed Customization
	getFeedItem (Dataface_Record $record)
	getFeed (array $query)
	getFeedSource (??)
	getRelatedFeed (??)
	getRSSDescription (Dataface_Record $record)
Template Customization
	block__blockname ()
	getNavItem ($key, $label)
	navItemIsSelected ($key)
	getTemplateContext ()
Valuelist Customization
	valuelist__valuelistname ()

---

Function Documentation

after_action_activate

(

)

after_action_delete

(

)

after_action_edit

(

)

after_action_login

(

)

after_action_logout

(

)

after_action_new

(

)

afterRegister

(

Dataface_Record $

user

)

before_authenticate

(

)

beforeHandleRequest

(

)

block__blockname

(

)

getFeed

(

array $

query

)

getFeedItem

(

Dataface_Record $

record

)

getFeedSource

(

??

)

getNavItem	(	$	key,
		$	label
	)

getPasswordChangedEmailInfo	(	Dataface_Record $	user,
		$	password
	)

getPermissions

(

Dataface_Record $

record

)

Returns associative array of permissions that should be granted to the current user on the specified record.

Parameters:

Dataface_Record

$record

The record on which we are granting permissions.

Returns:

array Associative array of permissions that are granted. The keys of this array are the names of permissions (defined in the permissions.ini file) and values are boolean (0 or 1) to indicate whether or not the permission is granted. This method may also return null to indicate that it has no opinion on the permissions to use - i.e. it will default to the permissions defined in the ApplicationDelegateClass.

Since:

0.5

Flowchart

The following flowchart shows the flow of control Xataface uses to determine the record-level permissions for a record. (click here to enlarge):

See also:

http://xataface.com/documentation/tutorial/getting_started/permissions

DelegateClass::getPermissions()

getRoles()

Dataface_Record::getPermissions()

Dataface_Table::getPermissions()

Dataface_PermissionsTool

http://xataface.com/wiki/permissions.ini_file

getRegistrationActivationEmailHeaders	(	Dataface_Record $	user,
		$	activationURL
	)

getRegistrationActivationEmailInfo	(	Dataface_Record $	user,
		$	activationURL
	)

getRegistrationActivationEmailMessage	(	Dataface_Record $	user,
		$	activationURL
	)

getRegistrationActivationEmailParameters	(	Dataface_Record $	user,
		$	activationURL
	)

getRegistrationActivationEmailSubject	(	Dataface_Record $	user,
		$	activationURL
	)

getRelatedFeed

(

??

)

getResetPasswordEmailInfo	(	Dataface_Record $	user,
		$	reset_url
	)

getRoles

(

Dataface_Record $

record

)

Returns one or more roles that are to be granted to the current user for the specified record.

Parameters:

Dataface_Record

$record

The record on which the roles are to be granted.

Returns:

mixed Either a string with a single role or an array of strings representing roles that are assigned to the current user on the given record.

Since:

1.0

Synopsis

Attention:

Note that the results of this method are always superceded by the results of getPermissions() if defined.

Flowchart

The following flowchart shows the flow of control Xataface uses to determine the record-level permissions for a record. (click here to enlarge):

See also:

getPermissions()

Dataface_Record::getRoles()

http://xataface.com/documentation/tutorial/getting_started/permissions

Dataface_PermissionsTool

http://xataface.com/wiki/permissions.ini_file

DelegateClass::getRoles()

getRSSDescription

(

Dataface_Record $

record

)

getTemplateContext

(

)

navItemIsSelected

(

$

key

)

sendRegistrationActivationEmail	(	Dataface_Record $	user,
		$	activationURL
	)

startSession

(

)

validateRegistrationForm

(

array $

values

)

valuelist__valuelistname

(

)