|
| | __construct () |
| | base constructor. Most plugins will just use this More...
|
| |
|
| RegisterMenus () |
| | Customize submenus.
|
| |
| | Initialize () |
| | This is called before the plugin is used. It should assume that Install() was already run one time (possibly years ago and not during this object's creation). More...
|
| |
| | returnSortOrder () |
| | Get sorting orders. More...
|
| |
| | checkAdvanceSearch ($coord, $revisionName, $namespaceName, $typeName, $providerName) |
| | Check for Advance Search. More...
|
| |
| | Install () |
| | This function (when defined) is only called when the plugin is first installed. It should make sure all requirements are available and create anything it needs to run. It returns 0 on success, non-zero on failure. A failed install is not inserted in the system. More...
|
| |
|
| Remove () |
| | This function (when defined) is only called once, when the plugin is removed. It should uninstall and remove all items that are only used by this plugin. There should be no residues – if the plugin is ever installed again, it should act like a clean install. Thus, any DB, files, or state variables specific to this plugin must be removed. This function must always succeed.
|
| |
| | PostInitialize () |
| | This function is called before the plugin is used and after all plugins have been initialized. If there is any initialization step that is dependent on other plugins, put it here. More...
|
| |
|
| Destroy () |
| | This is a destructor called after the plugin is no longer needed. It should assume that PostInitialize() was already run one time (this session) and succeeded. This function must always succeed.
|
| |
|
| OutputOpen () |
| | This function is called when user output is requested. This function is responsible for assigning headers.
|
| |
|
| OutputUnSet () |
| | Similar to OutputClose, this ends the output type for this object. However, this does NOT change any global settings. This is called when this object is a dependency for another object.
|
| |
| | getResponse () |
| |
|
| Output () |
| | This function is called when user output is requested. This function is responsible for content. (OutputOpen and Output are separated so one plugin can call another plugin's Output.)
|
| |
|
| getTemplateName () |
| |
| | renderString ($templateName, $vars=null) |
| |
| | renderScripts ($scripts) |
| | Render JavaScript in the template's footer. More...
|
| |
| | getRequest () |
| |
|
| execute () |
| |
|
| preInstall () |
| |
|
| postInstall () |
| |
|
| unInstall () |
| |
| | getName () |
| |
|
| __toString () |
| |
Definition at line 27 of file ui-spasht.php.
◆ __construct()
| ui_spasht::__construct |
( |
| ) |
|
base constructor. Most plugins will just use this
Makes sure the plugin is in the correct state. If so, the plugin is inserted into the Plugins data structure.
The constructor assumes that Install() was already run one time (possibly years ago and not during this object's creation).
- Returns
- true on success, false on failure.
On failure the plugin is not used by the system. NOTE: This function must NOT assume that other plugins are installed. See PostInitialize.
Reimplemented from FO_Plugin.
Definition at line 48 of file ui-spasht.php.
◆ checkAdvanceSearch()
| ui_spasht::checkAdvanceSearch |
( |
|
$coord, |
|
|
|
$revisionName, |
|
|
|
$namespaceName, |
|
|
|
$typeName, |
|
|
|
$providerName |
|
) |
| |
Check for Advance Search.
- Parameters
-
| Coordinate | $coord | Coordinates searched |
| string | $revisionName | Revision searched |
| string | $namespaceName | Namespace searched |
| string | $typeName | Type searched |
| string | $providerName | Provider searched |
- Returns
- boolean
Definition at line 426 of file ui-spasht.php.
◆ getFileListing()
| ui_spasht::getFileListing |
( |
|
$Uploadtree_pk, |
|
|
|
$Uri, |
|
|
|
$uploadtree_tablename, |
|
|
|
$Agent_pk, |
|
|
|
$upload_pk |
|
) |
| |
|
protected |
- Parameters
-
| int | $Uploadtree_pk | Uploadtree id |
| string | $Uri | URI |
| string | $uploadtree_tablename | Uploadtree table name |
| int | $Agent_pk | Agent id |
| int | $upload_pk | Upload id |
- Returns
- array
Definition at line 349 of file ui-spasht.php.
◆ handleNewSelection()
| ui_spasht::handleNewSelection |
( |
|
$optionSelect, |
|
|
|
$uploadId |
|
) |
| |
|
private |
Handle new selection from user, store it in DB and schedule the agent.
- Parameters
-
| string | $optionSelect | Option selected by user |
- Returns
- NULL|string null if new selection inserted, name otherwise.
Definition at line 453 of file ui-spasht.php.
◆ Initialize()
| ui_spasht::Initialize |
( |
| ) |
|
This is called before the plugin is used. It should assume that Install() was already run one time (possibly years ago and not during this object's creation).
- Returns
- boolean true on success, false on failure. A failed initialize is not used by the system.
- Note
- This function must NOT assume that other plugins are installed.
- See also
- FO_Plugin::Initialize()
Reimplemented from FO_Plugin.
Definition at line 100 of file ui-spasht.php.
◆ isADirectory()
| ui_spasht::isADirectory |
( |
|
$Uploadtree_pk | ) |
|
|
protected |
Check if passed element is a directory.
- Parameters
-
| int | $Uploadtree_pk | Uploadtree id of the element |
- Returns
- boolean True if it is a directory, false otherwise
Definition at line 399 of file ui-spasht.php.
◆ returnSortOrder()
| ui_spasht::returnSortOrder |
( |
| ) |
|
Get sorting orders.
- Returns
- string[][]
Definition at line 409 of file ui-spasht.php.
◆ $agentDao
◆ $spashtDao
◆ $viewName
| string ui_spasht::$viewName |
|
protected |
The documentation for this class was generated from the following file:
Public Member Functions inherited from FO_Plugin
1.9.1