|
| | Set ($name, &$parent) |
| |
| | completeSet (&$parent) |
| |
| | complete () |
| |
| | Read ($k, $d="") |
| |
| | Register ($k, $v) |
| |
| | Unregister ($k) |
| |
| | actRead ($k, $d="") |
| |
| | actRegister ($k, $v) |
| |
| | actUnregister ($k) |
| |
| | PreInsert () |
| |
| | PreUpdate () |
| |
| | getParam ($name, $def="") |
| |
| | setParamU ($name, $val) |
| |
| | getImageUrl ($name, $detectstyle=true, $size=null) |
| |
| | getFilteredImageUrl ($name) |
| |
| | getImageFile ($name) |
| |
| | addLogMsg ($msg, $cut=0) |
| |
| | addWarningMsg ($msg) |
| |
| | addActionDone ($actdone, $arg="") |
| |
| | clearActionDone () |
| |
| | getActionDone (&$actdone, &$arg) |
| |
| | getIcon ($name, $text, $width="", $height="") |
| |
| | getLayoutFile ($layname) |
| |
| | exists ($name, $idapp, $id_func=0) |
| |
| | hasPermission ($acl_name="", $app_name="", $strict=false) |
| |
| | canExecute ($actname, $appid="") |
| |
| | getAcl ($actname, $appid="") |
| |
| | execute () |
| |
| | exitError ($texterr, $exit=true, $code="") |
| |
| | exitForbidden ($texterr) |
| |
| | clearError () |
| |
| | Init ($app, $action_desc, $update=false) |
| |
| | debug ($msg) |
| |
| | info ($msg) |
| |
| | warning ($msg) |
| |
| | error ($msg) |
| |
| | fatal ($msg) |
| |
| | appInstalled ($appname) |
| |
| | getAvailableApplication () |
| |
| | __construct ($dbaccess= '', $id= '', $res= '', $dbid=0) |
| |
| | Select ($id) |
| |
| | getValues () |
| |
| | affectColumn ($fields, $reset=true) |
| |
| | affect ($array, $more=false, $reset=true) |
| |
| | isAffected () |
| |
| | Complete () |
| |
| | preInsert () |
| |
| | postInsert () |
| |
| | preUpdate () |
| |
| | postUpdate () |
| |
| | preDelete () |
| |
| | postDelete () |
| |
| | preSelect ($id) |
| |
| | postSelect ($id) |
| |
| | Add ($nopost=false, $nopre=false) |
| |
| | modify ($nopost=false, $sfields="", $nopre=false) |
| |
| | delete ($nopost=false) |
| |
| | Adds (&$tcopy, $nopost=false) |
| |
| | lw ($prop) |
| |
| | CloseConnect () |
| |
| | Create ($nopost=false) |
| |
| | postInit () |
| |
| | init_dbid () |
| |
| | exec_query ($sql, $lvl=0, $prepare=false) |
| |
| | numrows () |
| |
| | fetch_array ($c, $type=PGSQL_ASSOC) |
| |
| | update () |
| |
| | setError ($moreerr= '') |
| |
| | autoUpdate () |
| |
| | savePoint ($point) |
| |
| | lockPoint ($exclusiveLock, $exclusiveLockPrefix= '') |
| |
| | setMasterLock ($useLock) |
| |
| | rollbackPoint ($point) |
| |
| | commitPoint ($point) |
| |
manage Action Action is part of Application
- See Also
- Application
Definition at line 24 of file Class.Action.php.
| addActionDone |
( |
|
$actdone, |
|
|
|
$arg = "" |
|
) |
| |
store action done to be use in refreshing main window interface
- Parameters
-
| string | $actdone | the code of action |
| string | $arg | the argument of action |
Definition at line 385 of file Class.Action.php.
| addLogMsg |
( |
|
$msg, |
|
|
|
$cut = 0 |
|
) |
| |
verify if an application is really installed in localhost
- Parameters
-
| string | $appname | application reference name |
- Returns
- bool true if application is installed
Definition at line 848 of file Class.Action.php.
| canExecute |
( |
|
$actname, |
|
|
|
$appid = "" |
|
) |
| |
Check if the current user can execute the specified action.
- Api:
- verify if an action can be executed
- Parameters
-
| string | $actname | action name |
| string | $appid | application name or application id (default is the current application) |
- Returns
- string with error message if the user cannot execute the given action, or an empty string if the user can execute the action
Definition at line 485 of file Class.Action.php.
clear action done to be use in refreshing main window interface
Definition at line 399 of file Class.Action.php.
execute the action test if current user can execute it
- Exceptions
-
| Dcp\Core\Exception | |
| Dcp\Exception | |
- Returns
- string the composed associated layout
Definition at line 531 of file Class.Action.php.
| exists |
( |
|
$name, |
|
|
|
$idapp, |
|
|
|
$id_func = 0 |
|
) |
| |
Verify if action exists
- Parameters
-
| string | $name | action name |
| int | $idapp | application numeric identifier |
| int | $id_func | action identifier - when test itself @ internal purpose |
- Returns
- bool true if exists
Definition at line 449 of file Class.Action.php.
| exitError |
( |
|
$texterr, |
|
|
|
$exit = true, |
|
|
|
$code = "" |
|
) |
| |
display error to user and stop execution
- Parameters
-
| string | $texterr | the error message |
| bool | $exit | if false , no exit are performed |
| string | $code | error code (ref to error log) |
- Exceptions
-
- Api:
- abort action execution
Definition at line 615 of file Class.Action.php.
| exitForbidden |
( |
|
$texterr | ) |
|
| getAcl |
( |
|
$actname, |
|
|
|
$appid = "" |
|
) |
| |
return acl name for an action
- Parameters
-
| string | $actname | action name |
| string | $appid | application id (default itself) |
- Returns
- string (false if not found)
Definition at line 511 of file Class.Action.php.
| getActionDone |
( |
& |
$actdone, |
|
|
& |
$arg |
|
) |
| |
get action code and argument for action code done to be use in refreshing main window interface
- Parameters
-
| string | &$actdone | the code of action |
| string | &$arg | the argument of action |
Definition at line 410 of file Class.Action.php.
| static getArgument |
( |
|
$k, |
|
|
|
$def = '' |
|
) |
| |
|
static |
retrieve the value of an argument fot the action in web mode the value comes from http variable and in shell mode comes from args variable
- Parameters
-
| string | $k | the argument name |
| mixed | $def | default value if no argument is not set |
- Returns
- mixed|string
Definition at line 775 of file Class.Action.php.
| getAvailableApplication |
( |
| ) |
|
return available Applications for current user
- Returns
- array
Definition at line 859 of file Class.Action.php.
| getFilteredImageUrl |
( |
|
$name | ) |
|
| getIcon |
( |
|
$name, |
|
|
|
$text, |
|
|
|
$width = "", |
|
|
|
$height = "" |
|
) |
| |
get image HTML fragment
- Parameters
-
| string | $name | icon filename |
| string | $text | alternative text |
| string | $width | icon width |
| string | $height | icon Height |
- Returns
- string HTML fragment image tag
Definition at line 423 of file Class.Action.php.
| getImageUrl |
( |
|
$name, |
|
|
|
$detectstyle = true, |
|
|
|
$size = null |
|
) |
| |
| getLayoutFile |
( |
|
$layname | ) |
|
| getParam |
( |
|
$name, |
|
|
|
$def = "" |
|
) |
| |
| hasPermission |
( |
|
$acl_name = "", |
|
|
|
$app_name = "", |
|
|
|
$strict = false |
|
) |
| |
Verify acl grant for current user
- Parameters
-
| string | $acl_name | acl name |
| string | $app_name | app name to specify another appname (else current app name) |
| bool | $strict | to not use substitute account information |
- Returns
- bool true if current user has acl privilege
Definition at line 472 of file Class.Action.php.
| Init |
( |
|
$app, |
|
|
|
$action_desc, |
|
|
|
$update = false |
|
) |
| |
record/update action
- Parameters
-
| Application | $app | application |
| array | $action_desc | action description |
| bool | $update | set to true if update only |
- Returns
- string none
PhpUnusedLocalVariableInspection
Definition at line 686 of file Class.Action.php.
read a session variable
- Parameters
-
| string | $k | key variable |
| string | $d | default value |
- Returns
- string
Definition at line 234 of file Class.Action.php.
record a session variable
- Parameters
-
| string | $k | key variable |
| string | $v | value to set |
- Returns
- bool return true if ok
Definition at line 248 of file Class.Action.php.
initialize Action object need set action to execute it
$myAct->set("ONEFAM_LIST", $one);
- Parameters
-
| string | $name | action name reference |
| Application | $parent | application object where action depends |
- Exceptions
-
| Dcp\Core\Exception | if action not exists |
Definition at line 168 of file Class.Action.php.
| setParamU |
( |
|
$name, |
|
|
|
$val |
|
) |
| |
translate text use gettext catalog
- Parameters
-
| string | $code | text to translate |
- Returns
- string
Definition at line 788 of file Class.Action.php.
remove variable from current session
- Parameters
-
- Returns
- bool return true if ok
Definition at line 261 of file Class.Action.php.
Initial value:= array(
"name" => array(
"libelle" => "Nom",
"type" => "TXT"
)
)
Definition at line 116 of file Class.Action.php.
Initial value:= array(
"criteria" => "",
"order_by" => "name"
)
Definition at line 111 of file Class.Action.php.
Initial value:= array(
"id",
"id_application",
"name",
"short_name",
"long_name",
"script",
"function",
"layout",
"available",
"acl",
"grant_level",
"openaccess",
"root",
"icon",
"toc",
"father",
"toc_order"
)
Definition at line 30 of file Class.Action.php.
Initial value:= array(
"id",
"id_application",
"name"
)
Definition at line 74 of file Class.Action.php.
Initial value:= '
create table action (id int not null,
primary key (id),
id_application int not null,
name text not null,
short_name text ,
long_name text,
script text,
function text,
layout text ,
available char,
acl text,
grant_level int,
openaccess char,
root char,
icon text,
toc char,
father int ,
toc_order int);
create index action_idx1 on action(id);
create index action_idx2 on action(id_application);
create index action_idx3 on action(name);
create sequence SEQ_ID_ACTION;
'
Definition at line 82 of file Class.Action.php.
fake ACL to allow an action to be access free without its application being access_free
Definition at line 29 of file Class.Action.php.
The documentation for this class was generated from the following file:
Inheritance diagram for Action:
