Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
The action code to execute. If not specified, the default one should be used
Return:
A __ModelAndView instance as a result of executing the requested action
Access:
public
getCode
string getCode(
)
Gets the code associated to the current action controller.
Return:
The code assigned to current action controller
Access:
public
getRequireSsl
boolean getRequireSsl(
)
Getter for _require_ssl member Get if current action controller requires SSL protocol to be executed.
Return:
If current action controller requires SSL protocol to be executed
Access:
public
getValidRequestMethod
integer getValidRequestMethod(
)
Get the allowed request methods to execute current action controller.
Return:
A code that identify all valid request methods to execute current action controller
Access:
public
isHistoriable
boolean isHistoriable(
)
Get if current action can be logged in the history registry or not.
Return:
If current action can be logged in the history registry
Access:
public
isRequestable
boolean isRequestable(
)
Get if current action controller can be requested directly by the user or not.
Return:
If current action controller can be requested directly by the user
Access:
public
postExecute
void postExecute(
)
Access:
public
preExecute
void preExecute(
)
Access:
public
setCode
void setCode(
$code, string
$action_code
)
Sets an unike code for current action controller.
Parameters:
Type
Name
Description
$code
string
$action_code
An unike code for current action controller
Access:
public
setHistoriable
void setHistoriable(
boolean
$is_historiable
)
Set if current action can be logged in the history registry or not.
Parameters:
Type
Name
Description
boolean
$is_historiable
If current action can be logged in the history registry
Access:
public
setRequestable
void setRequestable(
boolean
$is_requestable
)
Set if an action controller can be selected and executed by the __FrontController in response to dispatching the user request.
In other words: if an action controller is requestable directly by the user or not.
<p>i.e.: imagine that the request to the url http://yourdomain/showcars.action is resolved by the __FrontController by executing the "showcars" action controller, in that case, that action should be requestable. Otherwise it will raise an exception.
Parameters:
Type
Name
Description
boolean
$is_requestable
If current action controller can be requested directly by the user
Access:
public
setRequireSsl
void setRequireSsl(
boolean
$require_ssl
)
Set if current action controller requires SSL protocol to be executed.
Parameters:
Type
Name
Description
boolean
$require_ssl
If current action controller requires SSL protocol to be executed
