Command's help - PSF1/pharinix GitHub Wiki
Command's list
Module 'Pharinix'
Licence: GNU GENERAL PUBLIC LICENSE Version 2
[email protected])
core version 2.11.12, Copyright (c), 2015, Pedro Pelaez (Light weight framework with many interesting features. Data model with unix like security, configurable with it self, URL rewrite and mapping, etc... it's the perfect backend to your application. See more information.
It add 162 command(s):
APCClear
Clear PHP APC cache.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
addBlockToPage
Add a block to a page.
Parameters
string
/page
: Name ID of page.string
/idcol
: Column ID where put the block.string
/cmd
: Command to execute.string
/parameters
: Parameters of command, it must be a URL encoded string.integer
/priority
: Order of blocks. Default 0, first.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
addBooting
Add a command, with parameters, to the boot process. This will executed with each user petition.
Parameters
string
/cmd
: Command to executestring
/parameters
: Post string to put in the command.integer
/priority
: Priority of execution.
Responses
string
/uid
: Unique ID, with that we can delete the boot command later.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
addFieldFormat
Add a new field formatter.
Parameters
string
/cmd
: Command that can format the field.string
/type
: Basic type to format.boolean
/isread
: Can format field to read only.boolean
/iswrite
: Can format field to read & write.boolean
/isdefault
: This formatter is the default formatter to this type.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
addGroup
Add a new user group to Pharinix.
Parameters
string
/group
: Group name
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
addNode
Add a new node.
Parameters
args
/any
: A parameter for each field of the type.string
/nodetype
: Node type is from.
Responses
boolean
/ok
: True/False node addedstring
/msg
: If error, it's a message about errorinteger
/nid
: ID of new node
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
addNodeField
Add a new field to a node type. It need update permission over the node type.
Parameters
string
/name
: Field namestring
/type
: Field type: longtext, bool, datetime, double, integer, string, password, htmltext, nodesec or other node typeboolean
/iskey
: Any other record can have some value. This functionality is not using database implementation.integer
/len
: Field length if need itboolean
/required
: True/false Required fieldboolean
/readonly
: True/false Not writable fieldboolean
/locked
: True/false System fieldboolean
/multi
: True/false multivalue field, only applicable on relations with other node types.string
/node_type
: Node type namestring
/default
: Default valuestring
/label
: Label to showstring
/help
: Help about field
Responses
boolean
/ok
: True/False field addedstring
/msg
: If error, it's a message about error
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
addNodeType
Add a new node type, with a default string field with name 'title'.
Parameters
string
/name
: Node type nameboolean
/locked
: True/false System field. Optional, default false.string
/label_field
: Name of the field used how label to list nodes. Optional, default 'title'.
Responses
boolean
/ok
: True/False field addedstring
/msg
: If error, it's a message about errorinteger
/nid
: ID of new node type
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
addPage
Add a new page.
Parameters
string
/name
: ID of page.string
/template
: Optional, path to the XML template file.string
/title
: Page title.string
/description
: Page description.string
/keys
: Page meta key words.string
/url
: Optional page URL.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
addUrl
Add a new URL to the rewrite list.
Parameters
string
/url
: The new URL, relative at root. Ex. home to http://127.0.0.1/homestring
/cmd
: POST's encoded string with command and parameters. Ex. command=pageToHTML&page=home
Responses
boolean
/ok
: TRUE if new URL added.string
/msg
: If FALSE contain the error message.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
addUser
Add a new user. All parameters are requires.
Parameters
string
/mail
: The user mail.string
/pass
: The password in plain text.string
/name
: User name or nick.string
/title
: User complete name.string
/group
: Default group. It get the value 'user' if not set.
Responses
boolean
/ok
: TRUE if the user is added.string
/msg
: If ok is FALSE contains the error message.integer
/nid
: If ok is TRUE contains the new user ID.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
batch
Execute a serial of commands. The output of a command will be the input parameters of the next command. Always call to captureEndAll at the end.
(Do a direct output to the client.)
Parameters
array
/starter
: Array of parameters to merge at the start.array
/commands
: Array of commands and default parameters. This parameters, if any, will be merged with de output of previous command, with priority to this, and passed how combined parameters. Ex, [['nothing' => 'ignoredparam1=A&ignoredparam2=B'], ['nothing' => 'ignoredparam1=A&ignoredparam2=B'], ...]. If you pass how command '#clean' then batch clear the merged output.string
/echoed
: If is empty or not define the output will out in response, else will be passed how parameters to the command in this parameter. Ex: 'echoed' => 'echoJson' will echo to the browser a json representation of the response.
Responses
args
/any
: The final response of the batch.boolean
/ok
: If error is set to FALSE, else will be unset.string
/msg
: If error is set to the error message, else will be unset.string
/error
: If error is set to a string with the command and her input parameters, else will be unset.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
captureEnd
If any, capture the actual echo buffer and return.
Responses
string
/buffer
: The string captured.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
captureEndAll
Ensure that all the echo buffer are close ignoring her contents.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
captureStart
Start a echo buffered capture. The capture methods have control about stack of calls, please execute 'captureEndAll' to ensure that all this buffers are closed.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
cfgAddComment
Add a comment to configuration.
Parameters
string
/section
: Section.string
/comment
: Configuration comment.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
cfgAddPath
Add a new command path.
Parameters
string
/path
: New path to add.
Responses
Path
: Value of commands path.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
cfgAddSection
Add a new section to configuration.
Parameters
string
/section
: Section name, it must be "[name]".
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
cfgDelComment
Del a comment to configuration.
Parameters
string
/section
: Section.string
/comment
: Configuration comment to delete.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
cfgDelKey
Del a key/value of configuration.
Parameters
string
/section
: Section.string
/key
: Configuration key to delete.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
cfgDelPath
Delete a commands path.
Parameters
string
/path
: Path to erase.
Responses
Path
: Value of commands path.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
cfgDelSection
Del a section of configuration, and all her content.
Parameters
string
/section
: Section.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
cfgGetConfigPath
Return configuration file path.
Responses
string
/path
: Configuration file path.string
/best
: The best file path.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
cfgGetKeys
Return a list of keys in a section in configuration.
Parameters
string
/section
: Section to list.
Responses
array
/keys
: Array of section names.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
cfgGetPath
Return commands path.
Responses
Path
: Value of commands path.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
cfgGetSections
Return a list of sections in configuration.
Responses
string
/sections
: Array of section names.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
cfgGetValue
Return value of a configuration.
Parameters
string
/section
: Section to list.string
/key
: Key to read.
Responses
string
/value
: Value of configuration.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
cfgSetValue
Set, or add, a value of configuration.
Parameters
string
/section
: Section to list.string
/key
: Configuration key.string
/value
: Value to write.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
chCRUDNode
To change permission of node type or node that is owned by you.
Parameters
string
/nodetype
: Node type that you need change permission.integer
/nid
: Node ID of the node that you need change. Optional, if it's set try change a node, else try change a node type.integer
/segment
: Flag segment to alter, the segments index are ALL = 0, GROUP = 4, OWNER = 8.boolean
/create
: Create flag.boolean
/read
: Read flag.boolean
/update
: Update flag.boolean
/delete
: Delete flag.
Responses
boolean
/ok
: TRUE if changed.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
chmod
To change permission of command that is owned by you. To execute commands only Execution is considered.
Parameters
string
/cmd
: Command that you need change permission.integer
/flags
: Integer with the new permissions.
Responses
boolean
/ok
: TRUE if changed.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
chmodNode
To change permission of node type or node that is owned by you.
Parameters
string
/nodetype
: Node type that you need change permission.integer
/nid
: Node ID of the node that you need change. Optional, if it's set try change a node, else try change a node type.integer
/flags
: Integer with the new permissions.
Responses
boolean
/ok
: TRUE if changed.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
chown
To change owner, and/or group, of the command.
Parameters
string
/cmd
: Command that you need change ownership.string
/owner
: Mail of the user or ID of the new owner. If it's null, or it is not set, command don't change it, to set to root you must value how 0, zero.string
/group
: Title or ID of the group. If it's null, or it is not set, command don't change it, to set to root you must value how 0, zero.
Responses
boolean
/ok
: TRUE if changed.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
chownNode
To change owner, and/or group, of the node types or nodes.
Parameters
string
/nodetype
: Node type that you need change ownership or type of the node to change.integer
/nid
: Node ID of the node that you need change. Optional, if it's set try change a node, else try change a node type.string
/owner
: Mail of the user or ID of the new owner. If it's null, or it is not set, command don't change it, to set to root you must value how 0, zero.string
/group
: Title or ID of the group. If it's null, or it is not set, command don't change it, to set to root you must value how 0, zero.
Responses
boolean
/ok
: TRUE if changed.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
commandHelp
Display commands help.
(Do a direct output to the client.)
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
commandHelpWikiExport
Export commands help to a GitHub Wiki file.
Parameters
string
/path
: File path where export.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
curlGetFile
Download a remote file from a HTTP or HTTPS URL. (Requires cURL installed in PHP.)
Parameters
string
/url
: URL of the file to download.
Responses
booelan
/ok
: TRUE if the download is OK.string
/msg
: If download error this contains the error message.string
/file
: If download ok, contains the downloaded file path. Please remove the temporal file when finish with it.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
delBooting
Delete a command from boot process.
Parameters
string
/uid
: Reference ID of the boot command.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
delNode
Delete a node.
Parameters
integer
/nid
: Node ID to erase.string
/nodetype
: Node type is from.
Responses
boolean
/ok
: True/False node erasedstring
/msg
: If error, it's a message about error
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
delNodeField
Erase a node field. It need delete permission over the node type.
Parameters
string
/nodetype
: Node type namestring
/name
: Node field name to erase
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
delNodeType
Erase a node type. Note: This command alter the execution time limit and reset it to the php.ini default value.
Parameters
string
/name
: Node type to erase.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
delPage
Del a page.
Parameters
string
/name
: ID of page.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
delUrl
Del URL to the rewrite list.
Parameters
string
/url
: The URL to erase, relative at root. Ex. home to http://127.0.0.1/home
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
delUser
Delete a user by ID or mail.
Parameters
integer
/uid
: The user id.string
/mail
: The user mail.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
echo
Echo the parameters to HTML. This command allow see parameters that come to a command in a pageToHTML block.
(Do a direct output to the client.)
(Designed to be a communication interface.)
Parameters
args
/any
: Some parameters.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
echoHTML
Eval, echo, a HTML+PHP code
(Do a direct output to the client.)
Parameters
string
/html
: String to evaluate.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
echoJson
Echo to browser the JSON representation of parameters, try to change the HTTP header to Content-type: application/json.
(Do a direct output to the client.)
(Designed to be a communication interface.)
Parameters
args
/some
: It can receive any amount of parameters.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
echoSimpleXML
Echo to browser the XML representation of parameters, try to change the HTTP header to Content-type: application/xml.
(Do a direct output to the client.)
(Designed to be a communication interface.)
Parameters
args
/some
: It can receive any amount of parameters.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
echoText
Echo to browser the print_r() representation of parameters, try to change the HTTP header to Content-type: text/plain.
(Do a direct output to the client.)
(Designed to be a communication interface.)
Parameters
args
/some
: It can receive any amount of parameters.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
endSession
Close the user session.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
execForm
Show a form to execute a command.
(Do a direct output to the client.)
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
executeCommandOnline
Show a form to define the command to execute.
(Do a direct output to the client.)
Parameters
string
/post
: Post's parameters encoded as string.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
fileMkdir
Create a new folder in server.
Parameters
string
/path
: Path to create.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
fileRm
Remove a file from server.
Parameters
string
/path
: File path to remove.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
formatFieldBool
Format boolean field to read or write.
(Do a direct output to the client.)
Parameters
string
/fieldname
: Field name to the form control.boolean
/toread
: Caller need a read form.boolean
/towrite
: Caller need a write form.string
/value
: Field value.integer
/length
: Field max length.boolean
/required
: Is a required field.boolean
/readonly
: Is a read only field.boolean
/system
: Is a system field, it isn't allow write.boolean
/multivalued
: Is a multi valued field.string
/default
: Default value.string
/label
: Label.string
/help
: Help to write forms.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
formatFieldCRUD
Format nodesec field to read or write.
(Do a direct output to the client.)
Parameters
string
/fieldname
: Field name to the form control.boolean
/toread
: Caller need a read form.boolean
/towrite
: Caller need a write form.string
/value
: Field value.integer
/length
: Field max length.boolean
/required
: Is a required field.boolean
/readonly
: Is a read only field.boolean
/system
: Is a system field, it isn't allow write.boolean
/multivalued
: Is a multi valued field.string
/default
: Default value.string
/label
: Label.string
/help
: Help to write forms.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
formatFieldCRUDAll
Format nodesec all segment field to read or write.
(Do a direct output to the client.)
Parameters
string
/fieldname
: Field name to the form control.boolean
/toread
: Caller need a read form.boolean
/towrite
: Caller need a write form.string
/value
: Field value.integer
/length
: Field max length.boolean
/required
: Is a required field.boolean
/readonly
: Is a read only field.boolean
/system
: Is a system field, it isn't allow write.boolean
/multivalued
: Is a multi valued field.string
/default
: Default value.string
/label
: Label.string
/help
: Help to write forms.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
formatFieldCRUDGroup
Format nodesec owner group field to read or write.
(Do a direct output to the client.)
Parameters
string
/fieldname
: Field name to the form control.boolean
/toread
: Caller need a read form.boolean
/towrite
: Caller need a write form.string
/value
: Field value.integer
/length
: Field max length.boolean
/required
: Is a required field.boolean
/readonly
: Is a read only field.boolean
/system
: Is a system field, it isn't allow write.boolean
/multivalued
: Is a multi valued field.string
/default
: Default value.string
/label
: Label.string
/help
: Help to write forms.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
formatFieldCRUDOwner
Format nodesec owner field to read or write.
(Do a direct output to the client.)
Parameters
string
/fieldname
: Field name to the form control.boolean
/toread
: Caller need a read form.boolean
/towrite
: Caller need a write form.string
/value
: Field value.integer
/length
: Field max length.boolean
/required
: Is a required field.boolean
/readonly
: Is a read only field.boolean
/system
: Is a system field, it isn't allow write.boolean
/multivalued
: Is a multi valued field.string
/default
: Default value.string
/label
: Label.string
/help
: Help to write forms.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
formatFieldDate
Format datetime field to read or write how date.
(Do a direct output to the client.)
Parameters
string
/fieldname
: Field name to the form control.boolean
/toread
: Caller need a read form.boolean
/towrite
: Caller need a write form.string
/value
: Field value.integer
/length
: Field max length.boolean
/required
: Is a required field.boolean
/readonly
: Is a read only field.boolean
/system
: Is a system field, it isn't allow write.boolean
/multivalued
: Is a multi valued field.string
/default
: Default value.string
/label
: Label.string
/help
: Help to write forms.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
formatFieldDouble
Format decimal field to read or write.
(Do a direct output to the client.)
Parameters
string
/fieldname
: Field name to the form control.boolean
/toread
: Caller need a read form.boolean
/towrite
: Caller need a write form.string
/value
: Field value.integer
/length
: Field max length.boolean
/required
: Is a required field.boolean
/readonly
: Is a read only field.boolean
/system
: Is a system field, it isn't allow write.boolean
/multivalued
: Is a multi valued field.string
/default
: Default value.string
/label
: Label.string
/help
: Help to write forms.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
formatFieldHtmltext
Format HTML text field to read or write.
(Do a direct output to the client.)
Parameters
string
/fieldname
: Field name to the form control.boolean
/toread
: Caller need a read form.boolean
/towrite
: Caller need a write form.string
/value
: Field value.integer
/length
: Field max length.boolean
/required
: Is a required field.boolean
/readonly
: Is a read only field.boolean
/system
: Is a system field, it isn't allow write.boolean
/multivalued
: Is a multi valued field.string
/default
: Default value.string
/label
: Label.string
/help
: Help to write forms.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
formatFieldInteger
Format integer field to read or write.
(Do a direct output to the client.)
Parameters
string
/fieldname
: Field name to the form control.boolean
/toread
: Caller need a read form.boolean
/towrite
: Caller need a write form.string
/value
: Field value.integer
/length
: Field max length.boolean
/required
: Is a required field.boolean
/readonly
: Is a read only field.boolean
/system
: Is a system field, it isn't allow write.boolean
/multivalued
: Is a multi valued field.string
/default
: Default value.string
/label
: Label.string
/help
: Help to write forms.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
formatFieldLongtext
Format longtext field to read or write.
(Do a direct output to the client.)
Parameters
string
/fieldname
: Field name to the form control.boolean
/toread
: Caller need a read form.boolean
/towrite
: Caller need a write form.string
/value
: Field value.integer
/length
: Field max length.boolean
/required
: Is a required field.boolean
/readonly
: Is a read only field.boolean
/system
: Is a system field, it isn't allow write.boolean
/multivalued
: Is a multi valued field.string
/default
: Default value.string
/label
: Label.string
/help
: Help to write forms.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
formatFieldPassword
Format password field to read or write.
(Do a direct output to the client.)
Parameters
string
/fieldname
: Field name to the form control.boolean
/toread
: Caller need a read form.boolean
/towrite
: Caller need a write form.string
/value
: Field value.integer
/length
: Field max length.boolean
/required
: Is a required field.boolean
/readonly
: Is a read only field.boolean
/system
: Is a system field, it isn't allow write.boolean
/multivalued
: Is a multi valued field.string
/default
: Default value.string
/label
: Label.string
/help
: Help to write forms.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
formatFieldString
Format string field to read or write.
(Do a direct output to the client.)
Parameters
string
/fieldname
: Field name to the form control.boolean
/toread
: Caller need a read form.boolean
/towrite
: Caller need a write form.string
/value
: Field value.integer
/length
: Field max length.boolean
/required
: Is a required field.boolean
/readonly
: Is a read only field.boolean
/system
: Is a system field, it isn't allow write.boolean
/multivalued
: Is a multi valued field.string
/default
: Default value.string
/label
: Label.string
/help
: Help to write forms.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
getBaseJS
Echo base javascript assets with a content-type header of application/javascript.
(Do a direct output to the client.)
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
getBlocksFromTemplate
Parse a page template and return her blocks places.
Parameters
string
/page
: XML page to parse
Responses
array
/blocks
: Array of blocks places.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
getCommandHelp
Command's help as array.
Responses
array
/help
: Help grouped by bin path. array('bin/html' => array...)
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
getCommandList
Command's list as array filter by startby parameter.
Parameters
string
/startby
: Filter by start of command name.
Responses
array
/commands
: Result list
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
getNode
Return the node content.
Parameters
string
/nodetype
: Node type.integer
/node
: Node ID.
Responses
array
/node
: Array with node content indexed by field name.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
getNodeHtml
Show node content in HTML.
(Do a direct output to the client.)
Parameters
string
/nodetype
: Node type.integer
/node
: Node ID.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
getNodeTypeDef
Get array definition of node type.
Parameters
string
/nodetype
: Node type name
Responses
integer
/id
: Node type IDstring
/name
: Node type nameboolean
/locked
: True/false, is a system node type?string
/label_field
: Name of field used how label to lists.array
/fields
: Array with field's definitions. Each field is a array with this elements: 'name', 'type', 'iskey', 'len', 'required', 'readonly', 'locked', 'default', 'label', 'help', 'multi'.datetime
/created
: Creation date.integer
/creator_node_user
: Creator ID.datetime
/modified
: Modification date.integer
/modifier_node_user
: Modifier ID.integer
/user_owner
: ID of owner user.integer
/group_owner
: ID of owner group.integer
/access
: Access flags. (nodesec)
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
getNodeTypeDefHtml
Display definition of node type.
(Do a direct output to the client.)
Parameters
string
/nodetype
: Node type name
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
getNodeTypeId
Search ID of node type by name
Parameters
string
/name
: Node type name to search.
Responses
integer
/id
: ID of the node type. False if not found.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
getNodeTypeList
Return a list of node types.
Responses
array
/types
: Array with node type names.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
getNodes
Return list of nodes from a node type. All field's names must be enclosed with '`'
Parameters
string
/nodetype
: Node type.boolean
/count
: Bool, If true then return number, in a 'amount' field, of nodes but without node data.string
/fields
: Comma separated string list. Optional, default '*'.string
/where
: Where condition.string
/order
: Order by fields.string
/group
: Group by fields.integer
/offset
: Index of first node to return. Optional, default 0.integer
/length
: Number of nodes to return from the offset. Optional, default 100.
Responses
array
/rs
: Node array with the ID how index. Multivalued fields will be returned how related ID's array.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
getPages
Get the list of page definitions.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
getRWUrls
Return a complete list of URL rewrites.
Responses
array
/list
: List of URLs
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
getSession
Return user session data. Warning! It can display sensible data.
Responses
array
/data
: Session array
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
getVersion
Return Pharinix version.
Responses
string
/version
: Pharinix version.string
/meta
: Meta data information.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
gettextCoreExtract
Scan Pharinix to find text in gettext functions: (), e(), n(), n__e(), p(), p__e(). This explore all PHP and JS files.
Parameters
string
/language
: Language code of the file.string
/reportMsgidBugsTo
: Contact information to report translation bugs.string
/lastTranslator
: Last translator name and mail.string
/languageTeam
: Language team.
Responses
array
/info
: Information about each folder scan.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
gettextExtract
Scan a folder to find text in gettext functions: (), e(), n(), n__e(), p(), p__e(). This explore all PHP, HTML, HTM and JS files, HTML and HTM files will be explored how a PHP file, please, don't insert JavaScript in it.
Parameters
string
/path
: Root file path to scan, relative to Pharinix root folder.string
/language
: Language code of the file.string
/projectIdVersion
: Translated software version.string
/reportMsgidBugsTo
: Contact information to report translation bugs.string
/lastTranslator
: Last translator name and mail.string
/languageTeam
: Language team.string
/po
: PO file where write results.
Responses
string
/previous
: Number of items before scan.string
/items
: Number of items after scan.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
gettextGetCoreTranslation
Return all Pharinix translation items.
Parameters
string
/language
: Language code.
Responses
string
/items
: List of items translated.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
gettextGetTranslation
Return all translation items.
Parameters
string
/po
: PO file to read.
Responses
string
/items
: List of items translated.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
gettextModExtract
Scan a module to find text in gettext functions: (), e(), n(), n__e(), p(), p__e(). This explore all PHP and JS files.
Parameters
string
/slugname
: Module slug name.string
/language
: Language code of the file.string
/reportMsgidBugsTo
: Contact information to report translation bugs.string
/lastTranslator
: Last translator name and mail.string
/languageTeam
: Language team.
Responses
array
/info
: Information about each folder scan.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
gettextModNodeTypeExtract
Scan the module's node types to find text in labels and help literals. This use the meta.json file to select node types to explore.
Parameters
string
/slugname
: Module to explore.string
/language
: Language code of the file.string
/reportMsgidBugsTo
: Contact information to report translation bugs.string
/lastTranslator
: Last translator name and mail.string
/languageTeam
: Language team.
Responses
string
/previous
: Number of items before scan.string
/items
: Number of items after scan.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
gettextNodeTypeExtract
Scan a node type to find text in labels and help literals.
Parameters
string
/nodetype
: Node type to explore.string
/language
: Language code of the file.string
/projectIdVersion
: Translated software version.string
/reportMsgidBugsTo
: Contact information to report translation bugs.string
/lastTranslator
: Last translator name and mail.string
/languageTeam
: Language team.string
/po
: PO file where write results.
Responses
string
/previous
: Number of items before scan.string
/items
: Number of items after scan.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
gettextSetCoreTranslation
Save a translation and compile in a MO file.
Parameters
string
/language
: Language code.string
/original
: Orinignal, english, text.string
/translation
: Tranlated text.
Responses
boolean
/ok
: TRUE if ok.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
goHome
Redirect the browser to home.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
goTo
Execute a command and redirect the browser to a 'local' URL.
Parameters
string
/gtpath
: The URL path to go to. Ex. 'help/console' to go to the console.string
/cmd
: A optional command to execute before go to the URL.args
/any
: Any number of parameters to pass to the command.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
hooksAddPermanent
Add a permanent hook handler.
Parameters
string
/hook
: The hook to hand.string
/file
: File path with the handler code.string
/func
: Function or method that handle the hook. Ex. foo, or clas::foo
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
hooksDelPermanent
Remove a permanent hook handler.
Parameters
string
/hook
: The hook to hand.string
/file
: File path with the handler code.string
/func
: Function or method that handle the hook. Ex. foo, or clas::foo
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
hooksGetRegistered
Get info about registered hook handlers.
Responses
array
/hooks
: Hooks list.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
iconsList
Display reference icon's list.
(Do a direct output to the client.)
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
inlineExitRootForm
(Do a direct output to the client.)
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
inlineGetRootForm
(Do a direct output to the client.)
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
inlineLoginForm
(Do a direct output to the client.)
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
inlineLogoutForm
(Do a direct output to the client.)
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
inlineSubNodeTypesForm
(Do a direct output to the client.)
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
install
Install Pharinix
(Do a direct output to the client.)
Parameters
string
/root
: Root user email.string
/rootpass
: Root user password.string
/dbhost
: MySQL server address.string
/dbschema
: MySQL data base name.string
/dbuser
: MySQL user.string
/dbpass
: MySQL password.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
isBasicNodeFieldType
Identify a field's node type how basic type or it's a reference to another node type.
Parameters
string
/type
: The type name to test.
Responses
boolean
/basic
: True/False is a basic type
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
isUrl
Query the rewrite list and return if the url is rewrited.
Parameters
string
/url
: The URL to test.
Responses
boolean
/ok
: TRUE if the URL exist.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
listBooting
Get a list of commands from boot process.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
localSQLExec
Do a direct query to the local data base. IMPORTANT: This command is so dangerous !! Protect it with restrictive permissions, only root must execute it.
Parameters
string
/sql
: Query.
Responses
array
/recordset
: Array with results.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
logClear
Clear a file.
Parameters
string
/path
: File path.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
logTail
Output the last part of file.
Parameters
string
/path
: File path.integer
/n
: Number of lines, default 25.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
lpClose
Close a monitor process.
Parameters
string
/id
: Monitor ID.
Responses
boolean
/ok
: TRUE if exist and it's closed.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
lpDemo
Start a long time process to allow see Monitor alive.
Parameters
integer
/step
: Sleep seconds in each step. This demo have 100 steps.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
lpRead
Read the state of a monitor process.
Parameters
string
/id
: Monitor ID.
Responses
object
/monitor
: Monitor object.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
lpReadAll
Read all active monitors process.
Parameters
boolean
/content
: Like you state too?
Responses
array
/monitors
: List of monitors objects.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
lpStart
Start a new monitor process. Monitors are safe mode compatible. Only login users can call this command.
Parameters
string
/label
: Global process label.
Responses
object
/monitor
: Monitor object. The ID is in the id attribute.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
lpViewer
HTML monitor process viewer.
(Do a direct output to the client.)
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
man
Get help about a command how array. Ex. man ('cmd' => 'man'). Get this help.
Parameters
string
/cmd
: The command to query.
Responses
array.
/help
: The help array.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
manHTML
Echo help about a command how HTML. Ex. manHTML ('cmd' => 'manHTML'), echo this help.
(Do a direct output to the client.)
Parameters
string
/cmd
: The command to query.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
manHelpOnline
Show a form to get help about a command.
(Do a direct output to the client.)
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
menuInlineToHTML
Default inline navigation bar
(Do a direct output to the client.)
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
mnuAdd
Add a new menu option.
Parameters
string
/slugname
: A required unique name used how referencebool
/isbrand
: Show this option how a menu title, or brandbool
/isnotsudoed
: Show option if the user is not rootbool
/isnotloged
: Show option if the user is not logedbool
/havegroup
: Show option if the user have the group setup in the field paramsbool
/issudoed
: Show option if the user is rootstring
/linkto
: URL linked from this option, if set value 'command' it execute the command, and parameters, associatedinteger
/parent
: Owner optionstring
/title
: A title string for this node.bool
/isloged
: Show option if the user is loggedlongtext
/params
: Command parameters if linkto value is 'command'string
/cmd
: Command to execute if linkto value is 'command'bool
/opennew
: Open in a new window or tabbool
/onlyparent
: TRUE if it's only a parent option without actioninteger
/order
: Order value, 0 first.string
/aling
: Menu alignment, it could be center, left or right
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
mnuDel
Remove a menu option.
Parameters
string
/slugname
: A required unique name used how referenceboolean
/recursive
: If TRUE remove submenus too. Default FALSE.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
mnuRenderBrand
Render a menu in HTML how brand items.
(Do a direct output to the client.)
Parameters
string
/menu
: Menu ID, slugname, to render.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
mnuRenderHead
Render a menu in HTML how inline navigation bar
(Do a direct output to the client.)
Parameters
string
/menu
: Menu ID, slugname, to render.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
mnuRenderList
Render a menu in HTML how unorderer list.
(Do a direct output to the client.)
Parameters
string
/menu
: Menu ID, slugname, to render.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
modGetMeta
Get meta data from a module.
Parameters
slugname
: Module name.
Responses
array
/meta
: Module meta information.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
modGetPath
Get the instalation path of a module.
Parameters
string
/name
: Module name.
Responses
string
/path
: Module path.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
modGetVersion
Get the version of a module.
Parameters
string
/name
: Module name.
Responses
string
/ver
: Module version.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
modInstall
Install a module.
Parameters
string
/path
: Optional path where install the module, relative to Pharinix root path. If not defined the default path is 'usr/'string
/zip
: Path to the ZIP file with the new module.
Responses
booelan
/ok
: TRUE if the installation is OK.string
/msg
: If install error this contains the error message.string
/path
: If install ok contains the install path.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
modInstallFromGitHub
Install a module from GitHub project, it must be from a tag release ZIP file. (Requires cURL.)
Parameters
string
/path
: Optional path where install the module, relative to Pharinix root path. If not defined the default path is 'usr/'string
/url
: URL of the module's GitHub ZIP file.
Responses
booelan
/ok
: TRUE if the installation is OK.string
/msg
: If install error this contains the error message.string
/path
: If install ok contains the install path.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
modInstallFromLocalFolder
Install a module from a local folder.
Parameters
string
/path
: Optional path where install the module, relative to Pharinix root path. If not defined the default path is 'usr/'string
/folder
: Path to the folder with the new module.
Responses
booelan
/ok
: TRUE if the installation is OK.string
/msg
: If install error this contains the error message.string
/path
: If install ok contains the install path.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
modInstalled
List installed modules. Only root can read the list from the database.
Responses
array
/modules
: List of modules.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
modUninstall
Remove a module.
Parameters
string
/name
: Slugname of the module to uninstall.
Responses
booelan
/ok
: TRUE if the uninstallation is OK.string
/msg
: If uninstall error this contains the error message.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
newID
Return a new unique ID as string.
Responses
string
/id
: The new unique ID string.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
nodeList
List nodes.
(Do a direct output to the client.)
Parameters
string
/nodetype
: Node type is from.string
/fields
: Comma separated string list. Optional, default '*'.string
/where
: Where condition.string
/order
: Order by fields.string
/group
: Group by fields.integer
/offset
: Index of first node to return. Optional, default 0.integer
/length
: Number of nodes to return from the offset. Optional, default 100.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
nothing
Nothing to do
(Designed to be a communication interface.)
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
obfPass
Obfuscate a password.
Parameters
string
/pass
: Password to obfuscate.
Responses
string
/pass
: Raw password.string
/obf
: Obfuscated password.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
opCacheClear
Clear PHP Opcache.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
pageToHTML
Transform a page to HTML
(Do a direct output to the client.)
Parameters
string
/page
: Page to convert, see 'url_rewrite' table.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
phpInfo
Display phpInfo() response.
(Do a direct output to the client.)
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
poweredBy
Show the power by Pharinix label.
(Do a direct output to the client.)
Parameters
string
/align
: Text align: left, center, right. Default "left".
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
queryDB
Do a direct query to a data base. IMPORTANT: This command is so dangerous !! Protect it with restrictive permissions, only root must execute it.
Parameters
string
/host
: DB host name.string
/name
: Database name.string
/user
: Username.string
/pass
: Password.string
/sql
: Query.
Responses
array
/recordset
: Array with results.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
registerDebug
Return the content of the commandDriver register.
Responses
array
/val
: The commandDriver register array.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
remoteAPICall
Call a remote API method
(Do a direct output to the client.)
Parameters
string
/host
: Remote host to call.string
/rcmd
: Command to execute.string
/iface
: Remote interface type.args
/any
: Other parameters.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
rewriteBasicList
Echo a list of URLs in the system.
(Do a direct output to the client.)
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
rewriteContext
Return the URLs context.
Parameters
boolean
/html
: Echo response how HTML too.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
setMyLang
Set the session language.
Parameters
string
/lang
: The language code, if is '' then set the client default languages.
Responses
boolean
/ok
: TRUE if ok.array
/lang
: The session language set.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
showAreas
Change the debug show_areas configuration to pageToHTML.
Parameters
boolean
/show
: True to show areas.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
sleep
Sleep some seconds, no more that 30s.
Parameters
integer
/s
: Seconds to sleep, no more that 30.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
smartyRender
Render a page using Smarty engine.
(Do a direct output to the client.)
Parameters
string
/page
: Optional. Page to convert, see 'url_rewrite' table.string
/tpl
: Template file to render, Default file document.tpl.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
startSession
Start the user session.
Parameters
string
/user
: User email to login.string
/pass
: User password to login.
Responses
boolean
/ok
: TRUE if session started.string
/id
: Session ID to use how auth_token.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
sudo
Change active user without logout and login. This is the unique method to get root access, super administration. A user can do sudo when it have sudoers group.
Parameters
string
/user
: User email to supplant. Root is 'root@localhost'. If this parameter is empty then we exit sudo.
Responses
boolean
/ok
: TRUE if session started.
Permissions
Owner
: rootGroup
: sudoersFlags
: Owner: Group:Execute All:
templateEditor
Show template grid editor.
(Do a direct output to the client.)
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
templateEditorList
Echo a json list of templates. ['default', ...]}
(Do a direct output to the client.)
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
templateEditorSave
Save a user template from the template editor.
(Do a direct output to the client.)
Parameters
string
/tpl
: Base 64 encoded HTML definition of the template.string
/name
: Template name, It must be a compatible file name.string
/title
: Template default title.string
/head
: Base 64 encoded meta information to add to the HTML head area.
Responses
boolean
/ok
: TRUE if is ok.string
/msg
: In case of error the error message.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
templateToArray
Transform a XML template to HTML, it not build blocks.
Parameters
string
/template
: XML to convert
Responses
string
/name
: Template name.string
/title
: Default page title.string
/head
: Head contentstring
/body
: Body structure in HTML, it's parsed to template editor.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
textUrlEncoder
Encode/Decode a string as a URL.The URL Decoder/Encoder is licensed under a Creative Commons Attribution-ShareAlike 2.0 License, http://creativecommons.org/licenses/by-sa/2.0/, by Eric Meyer, http://meyerweb.com/eric/tools/dencoder/.
(Do a direct output to the client.)
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
timeLimit
Change the PHP execution time limit. WARNING: Handle with care, a bad use of time limit can halt the server.
Parameters
integer
/s
: Seconds of new execution time limit. If is upper of 7200s, or is 0, the limit is set to 7200s.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
toJson
Translate parameters to JSON string.
Parameters
args
/some
: It can receive any amount of parameters.
Responses
string
/json
: The json string.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
trace
Add a new trace message
Parameters
string
/command
: Executed commandarray
/parameters
: Array of original parametersarray
/return
: Array of responses
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
traceToHTML
Print trace information in HTML format
(Do a direct output to the client.)
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
translate
Translate a string.
(Do a direct output to the client.)
Parameters
string
/str
: String to translate.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
updateNode
Update a node
Parameters
string
/nodetype
: Node type of node to update.integer
/nid
: ID of node.args
/any
: A parameter for each field of the type.
Responses
boolean
/ok
: True/False node updatedstring
/msg
: If error, it's a message about error
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
usageEnd
Capture final resources consumed
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
usageToHTML
Print resource consume in HTML format
(Do a direct output to the client.)
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
whereis
Get path where a command is.
Parameters
string
/cmd
: The command to query.
Responses
array.
/path
: The command's path.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
Module 'DataTables 1.10.11'
Licence: MIT license
[email protected])
datatables version 1.0, Copyright © 2008-2016, SpryMedia Ltd. - datatables.net/license, Pharinix module by Pedro Pelaez (DataTables is a plug-in for the jQuery Javascript library. It is a highly flexible tool, based upon the foundations of progressive enhancement, and will add advanced interaction controls to any HTML table. See more information.
It add 2 command(s):
dtList
Show table interface
(Do a direct output to the client.)
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
incDataTables
Import datatable library.
(Do a direct output to the client.)
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
Module 'Bootstrap 3 dialog'
Licence: MIT License
[email protected], Copyright (c), 2015, Pedro Pelaez ([email protected])
pharinix_mod_bootstrap3_dialog version 1.0, Copyright 2015Make use of Bootstrap Modal more monkey-friendly. See more information.
It add 1 command(s):
incBS3Dialog
Print HTML includes to Bootstrap 3 dialog.
(Do a direct output to the client.)
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
Module 'Bootstrap modal'
Licence: Apache License Version 2.0, January 2004
[email protected])
pharinix_mod_bootstrap_modal version 2.2.6, Copyright 2012 Jordan Schroter, Copyright (c), 2015, Pedro Pelaez (Extends the default Bootstrap Modal class. Responsive, stackable, ajax and more. See more information.
It add 1 command(s):
incBSModal
Print HTML includes to Bootstrap modal.
(Do a direct output to the client.)
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
Module 'Bootstrap dual listbox'
Licence: Apache License, Version 2.0
[email protected])
pharinix_mod_bootstrap_duallistbox version 3.0.2, Copyright 2013-2014 István Ujj-Mészáros, Copyright (c), 2015, Pedro Pelaez (Responsive dual listbox widget optimized for Twitter Bootstrap. See more information.
It add 1 command(s):
incDualListbox
Print HTML includes to duallistbox.
(Do a direct output to the client.)
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
Module 'Bootstrap form validator'
Licence: MIT
[email protected])
pharinix_mod_bootstrapvalidator version 0.5.2, (c) 2013 - 2014 Nguyen Huu Phuoc, Copyright (c), 2015, Pedro Pelaez (The best jQuery plugin to validate form fields. Designed to use with Bootstrap 3. See more information.
It add 1 command(s):
incFormValidator
Print HTML includes to bootstrapvalidator.
(Do a direct output to the client.)
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
Module 'Metis Menu'
Licence: MIT
pharinix_mod_metismenu version 2.0.4, Osman Nuri Okumu?
A jQuery menu plugin. See more information.
It add 2 command(s):
incMetisMenu
Print HTML includes to metis menu.
(Do a direct output to the client.)
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
mmRenderSidebar
Render a menu in HTML how sidebar navigation
(Do a direct output to the client.)
Parameters
string
/menu
: Menu ID, slugname, to render.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
Module 'Raphaël - JavaScript Vector Library'
Licence: MIT License
http://raphaeljs.com), Copyright © 2008-2012 Sencha Labs (http://sencha.com)
raphael_js version 2.1.4, Copyright © 2008-2012 Dmitry Baranovskiy (Small JavaScript library that should simplify your work with vector graphics on the web. See more information.
It add 1 command(s):
incRaphaelJS
Print HTML includes to Raphael JS.
(Do a direct output to the client.)
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
Module 'File manager'
Licence: GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007
[email protected])
pharinix_mod_file_manager version 1.0, Copyright (c), 2016, Pedro Pelaez (Pharinix file manager of folders with minimum data base usage. It use CRUD node types access management to access to files. See more information.
It add 6 command(s):
pfmDownload
Give download to a file if user can do it.
(Do a direct output to the client.)
Parameters
string
/path
: Virtual path.boolean
/inline
: FALSE to force download the file to the client computer, TRUE to integrate in browser.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
pfmGetRoots
Get list of root folders.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
pfmGetRootsSpace
Get list of root folders, and disk space information.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
pfmMount
Add a new root folder.
Parameters
string
/path
: Real path.string
/name
: Name to use how root.
Responses
boolean
/ok
: TRUE if ok
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
pfmShowSpace
Show list of root folders, and disk space information.
(Do a direct output to the client.)
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
pfmTests
Test the driver.
(Do a direct output to the client.)
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
Module 'phpSysInfo v 3.2.2'
Licence: GNU GENERAL PUBLIC LICENSE Version 2, June 1991
[email protected]), Copyright (c), 1999-2009, Michael Cramer ([email protected]), Copyright (c), 2007-2008, Audun Larsen ([email protected]), Copyright (c), 2007-2015, Erkan Valentin, Copyright (c), 2009-2015, Mieczyslaw Nalewaj ([email protected]), Copyright (c), 2010-2012, Damien Roth ([email protected]), Pharinix mod Copyright (c), 2015, Pedro Pelaez ([email protected])
phpsysinfo version 1.5, Copyright (c), 1999-2008, Uriah Welcome (phpSysInfo: a customizable PHP script that displays information about your system nicely. See more information.
It add 11 command(s):
psiAddHost
Add a new Pharinix host to host's list, node type 'psihost'.
Parameters
string
/title
: Host label.string
/url
: Pharinix host's URL.string
/user
: Username.string
/pass
: Password.
Permissions
Owner
: rootGroup
: phpsysinfoFlags
: Owner: Group:Execute All:
psiAddHostForm
Show a add host form.
(Do a direct output to the client.)
Permissions
Owner
: rootGroup
: phpsysinfoFlags
: Owner: Group:Execute All:
psiAgilmonSidebar
Display host list control how HTML.
(Do a direct output to the client.)
Permissions
Owner
: rootGroup
: phpsysinfoFlags
: Owner: Group:Execute All:
psiBlock
Display server information how HTML.
(Do a direct output to the client.)
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
psiDelHost
Delete a Pharinix host from host's list.
Parameters
string
/id
: Pharinix host ID.
Responses
boolean
/ok
: TRUE if ok.array
/trace
: Delete node responses.
Permissions
Owner
: rootGroup
: phpsysinfoFlags
: Owner: Group:Execute All:
psiEditHostForm
Show edit host form.
(Do a direct output to the client.)
Parameters
integer
/id
: Host ID to edit.
Permissions
Owner
: rootGroup
: phpsysinfoFlags
: Owner: Group:Execute All:
psiGetIcon
Download a system icon.
(Do a direct output to the client.)
Parameters
string
/file
: PNG system icon to download.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
psiInfo
Retrieve system information. If phpSysInfo get on error then return a array in 'errors'.
Parameters
string
/plugin
: Plugin to use. See 'usr/phpsysinfo/drivers/phpsysinfo.ini'string
/filters
: Comma separated list of sections to show or not. To show all sections set to '', empty (default). In case-sensitive each section name can be: Vitals, Network, Hardware, Memory, Filesystems, Mbinfo, Upsinfo.'
Responses
array
/errors
: List of errors.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group:Execute All:
psiInfoRemote
Retrieve system information from remote Pharinix. If phpSysInfo get on error then return a array in 'errors'.
Parameters
integer
/hostid
: Local PSI Host ID.string
/plugin
: Plugin to use. See 'usr/phpsysinfo/drivers/phpsysinfo.ini'string
/filters
: Comma separated list of sections to show or not. To show all sections set to '', empty (default). In case-sensitive each section name can be: Vitals, Network, Hardware, Memory, Filesystems, Mbinfo, Upsinfo.'
Responses
array
/errors
: List of errors.
Permissions
Owner
: rootGroup
: phpsysinfoFlags
: Owner: Group:Execute All:
psiPingRemote
Do a ping to a remote host.
Parameters
integer
/hostid
: Local PSI Host ID.
Responses
integer
/secs
: Query delay in seconds
Permissions
Owner
: rootGroup
: phpsysinfoFlags
: Owner: Group:Execute All:
psiUpdateHost
Update a Pharinix host in host's list.
Parameters
integer
/id
: Host id.string
/title
: Host label.string
/url
: Pharinix host's URL.string
/user
: Username.string
/pass
: Password.
Permissions
Owner
: rootGroup
: phpsysinfoFlags
: Owner: Group:Execute All:
Module 'User GUI'
Licence: GNU GENERAL PUBLIC LICENSE Version 2, June 1991
[email protected])
pharinix_mod_usergui version 1.0, Copyright (c), 2015, Pedro Pelaez (Pharinix visual user management. [See more information.]( "See more information.")
It add 8 command(s):
uauiAddUser
Show a add user form.
(Do a direct output to the client.)
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
uauiAdminUsers
Show a user management form.
(Do a direct output to the client.)
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
uauiEditMyAccount
Show a form to edit the current user.
(Do a direct output to the client.)
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
uauiEditUser
Show edit user form.
(Do a direct output to the client.)
Parameters
integer
/user
: User ID to edit.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
uauiGetCookies
Get server cookies content.
Responses
array
/cookies
: Cookies content
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
uauiInstall
Install modulo requirements.
Permissions
Owner
: rootGroup
: rootFlags
: Owner:Read,Write,Execute Group:Read, All:
uauiLoginForm
Show login form.
(Do a direct output to the client.)
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
uauiNavLoginForm
Show login form to integrate in navbar.
Permissions
Owner
: rootGroup
: rootFlags
: Owner: Group: All:Execute
Exported 196 commands by commandHelpWikiExport
at 2016-12-22 12:02:46