static boolean checkControllerDefExists(
string
$controllerName
)
|
|
Checks that the definition for the controller classname provided exists. Will also return true if you pass "/" for the root of the web application.
Parameters:
API Tags:
Information Tags:
static boolean checkIfAccessingFromSecureURL(
)
|
|
Static function for determining if the current request URL is a secure one (has a tk string or not)
API Tags:
Return: | True if the current URL contains a tk value, false otherwise |
Access: | public |
Information Tags:
static boolean checkSecurityFields(
)
|
|
Method to check the validity of the two hidden form security fields which aim to ensure that a post to the controller is being sent from the same server that is hosting it.
API Tags:
Information Tags:
static array generateSecurityFields(
)
|
|
Generates the two security fields to prevent remote form processing.
API Tags:
Return: | An array containing the two fields |
Access: | public |
Information Tags:
static string getCustomControllerName(
string
$BOName, string
$mode
)
|
|
Returns the name of a custom controller if one is found, otherwise returns null.
Parameters:
string |
$BOName: |
The classname of the business object |
string |
$mode: |
The mode of the controller (create, view, edit) |
API Tags:
Information Tags:
static void loadControllerDef(
string
$controllerName
)
|
|
Loads the definition for the controller classname provided.
Parameters:
API Tags:
Information Tags:
Since: | 1.0 |
Throws: | IllegalArguementException |
AlphaController __construct(
[string
$visibility = 'Public']
)
|
|
Constructor for the AlphaController that starts a new session if required, and handles the population of new/dirty objects from the session when available. Accepts the name of the rights group that has access to this controller, 'Public' by default.
Parameters:
string |
$visibility: |
The name of the rights group that can access this controller. |
API Tags:
Information Tags:
Redefined in descendants as:
Method to clearup a cancelled unit of work.
API Tags:
Information Tags:
Throws: | AlphaException |
Since: | 1.0 |
Method to display an access error for trespassing users. HTTP response header code will be 403.
API Tags:
Information Tags:
Checks the user rights of the currently logged-in person against the page visibility set for this controller. Will return false if the user has not got the correct rights.
API Tags:
Information Tags:
Redefined in descendants as:
-
Install::checkRights()
: Custom version of the check rights method that only checks for a session for the config admin username/password, when the system database is not set-up
Commits (saves) all of the new and modified (dirty) objects in the unit of work to the database.
API Tags:
Information Tags:
Throws: | FailedUnitCommitException |
Since: | 1.0 |
Get the BO for this controller (if any).
API Tags:
Information Tags:
Getter for the page description.
API Tags:
Information Tags:
Getter for the dirty objects array.
API Tags:
Information Tags:
Getter for the unit end time.
API Tags:
Information Tags:
Gets the name of the first job in this unit of work.
API Tags:
Information Tags:
Getter for the page keywords.
API Tags:
Information Tags:
Gets the name of the last job in this unit of work.
API Tags:
Information Tags:
Getter for the unit of work MAX duration.
API Tags:
Information Tags:
Get the name of the unit of work job.
API Tags:
Information Tags:
Getter for the new objects array.
API Tags:
Information Tags:
Gets the name of the next job in this unit of work
API Tags:
Information Tags:
Gets the name of the previous job in this unit of work
API Tags:
Information Tags:
Getter for the unit start time.
API Tags:
Information Tags:
string getStatusMessage(
)
|
|
Gets the current status message for this controller. Note that by getting the current status message, you clear out the value stored in _SESSION so this method can only be used to get the status message once for display purposes.
API Tags:
Information Tags:
Getter for the page title.
API Tags:
Information Tags:
integer getUnitDuration(
)
|
|
Calculates and returns the unit of work current duration in seconds.
API Tags:
Information Tags:
Get the name of the rights group that has access to this controller.
API Tags:
Information Tags:
void loadCustomController(
string
$BOName, string
$mode
)
|
|
Does a HTTP redirect to a custom controller if one is found.
Parameters:
string |
$BOName: |
The classname of the business object |
string |
$mode: |
The mode of the controller (create, view, edit) |
API Tags:
Information Tags:
Throws: | FileNotFoundException |
Since: | 1.0 |
Adds the supplied business object to the dirtyObjects array in the session.
Parameters:
API Tags:
Information Tags:
Adds a newly created business object to the newObjects array in the session.
Parameters:
API Tags:
Information Tags:
Setter for the BO for this controller.
Parameters:
API Tags:
Information Tags:
void setDescription(
string
$description
)
|
|
Setter for the page description.
Parameters:
API Tags:
Information Tags:
void setKeywords(
string
$keywords
)
|
|
Setter for the page keywords, should pass a comma-seperated list as a string.
Parameters:
API Tags:
Information Tags:
void setName(
string
$name
)
|
|
Setter for the unit of work job name.
Parameters:
API Tags:
Information Tags:
void setStatusMessage(
string
$message
)
|
|
Set the status message in the _SESSION to the value provided.
Parameters:
API Tags:
Information Tags:
void setTitle(
string
$title
)
|
|
Setter for the page title.
Parameters:
API Tags:
Information Tags:
void setUnitEndTime(
integer
$year, integer
$month, integer
$day, integer
$hour, integer
$minute, integer
$second
)
|
|
Setter for the unit end time (value will be stored in the session as key unitEndTime).
Parameters:
integer |
$year: |
|
integer |
$month: |
|
integer |
$day: |
|
integer |
$hour: |
|
integer |
$minute: |
|
integer |
$second: |
|
API Tags:
Information Tags:
void setUnitMAXDuration(
integer
$duration
)
|
|
Setter for the unit MAX duration.
Parameters:
integer |
$duration: |
The desired duration in seconds. |
API Tags:
Information Tags:
void setUnitOfWork(
array
$jobs
)
|
|
Sets the name of the controller job sequence to the values in the supplied array (and stores the array in the session).
Parameters:
array |
$jobs: |
The names of the controllers in this unit of work sequence. |
API Tags:
Information Tags:
Throws: | IllegalArguementException |
Since: | 1.0 |
void setUnitStartTime(
integer
$year, integer
$month, integer
$day, integer
$hour, integer
$minute, integer
$second
)
|
|
Setter for the unit start time (value will be stored in the session as key unitStartTime).
Parameters:
integer |
$year: |
|
integer |
$month: |
|
integer |
$day: |
|
integer |
$hour: |
|
integer |
$minute: |
|
integer |
$second: |
|
API Tags:
Information Tags:
void setVisibility(
string
$visibility
)
|
|
Setter for the name of the rights group that has access to this controller.
Parameters:
API Tags:
Information Tags: