Docs For Class mosAbstractTasker

Description

Legacy class, will be replaced by full MVC implementation in 1.2

deprecated: As of version 1.1

Located in /common/legacy/classes.php (line 439)

Variable Summary

string $_acoSection

string $_acoSectionValue

string $_message

array $_methods

string $_redirect

string $_task

array $_taskMap

Method Summary

mosAbstractTasker mosAbstractTasker ([string $default = ''])

void accessCheck (mixed $task)

string getTask ()

null methodNotFound (string $name)

null notAllowed (string $name)

mixed performTask (string $task)

void redirect ()

void registerDefaultTask (string $method)

void registerTask (string $task, string $method)

void setAccessControl (string $section, [string $value = null])

void setRedirect (string $url, [mixed $msg = null])

null taskNotFound (string $task)

Variables

string $_acoSection = null (line 454)

var: The ACO Section

string $_acoSectionValue = null (line 456)

var: The ACO Section value

string $_message = null (line 449)

var: A message about the operation of the task

array $_methods = null (line 445)

var: An array of the class methods

string $_redirect = null (line 447)

var: A url to redirect to

string $_task = null (line 443)

var: The name of the current task

array $_taskMap = null (line 441)

var: An array of the class methods to call for a task

Methods

Constructor mosAbstractTasker (line 462)

Constructor

mosAbstractTasker mosAbstractTasker ([string $default = ''])

string $default: Set the default task

accessCheck (line 491)

Access control check

void accessCheck (mixed $task)

getTask (line 571)

Get the last task that was to be performed

return: The task that was or is being performed

string getTask ()

methodNotFound (line 588)

Basic method if the registered method is not found

null methodNotFound (string $name)

string $name: The name of the method in the derived class

notAllowed (line 597)

Basic method if access is not permitted to the task

null notAllowed (string $name)

string $name: The name of the method in the derived class

performTask (line 549)

Perform a task by triggering a method in the derived class

return: The value returned by the function

mixed performTask (string $task)

string $task: The task to perform

redirect (line 520)

Redirects the browser

void redirect ()

registerDefaultTask (line 541)

Register the default task to perfrom if a mapping is not found

void registerDefaultTask (string $method)

string $method: The name of the method in the derived class to perform if the task is not found

registerTask (line 530)

Register (map) a task to a method in the class

void registerTask (string $task, string $method)

string $task: The task
string $method: The name of the method in the derived class to perform for this task

setAccessControl (line 484)

Sets the access control levels

void setAccessControl (string $section, [string $value = null])

string $section: The ACO section (eg, the component)
string $value: The ACO section value (if using a constant value)

setRedirect (line 511)

Set a URL to redirect the browser to

void setRedirect (string $url, [mixed $msg = null])

string $url: A URL

taskNotFound (line 579)

Basic method if the task is not found

null taskNotFound (string $task)

string $task: The task