Geeklog
[ class tree: Geeklog ] [ index: Geeklog ] [ all elements ]

Procedural File: plugins.php

Source Location: /public_html/admin/plugins.php



Page Details:

This is the plugin administration page. Here you can install, uninstall, upgrade, enable, disable, and upload plugins.



Includes:

require_once('../lib-common.php') [line 45]
Geeklog common function library

require_once('auth.inc.php') [line 50]
Security check to ensure user even belongs on this page






UPLOAD_ERR_CANT_WRITE [line 62]

UPLOAD_ERR_CANT_WRITE = 7

[ Top ]



UPLOAD_ERR_EXTENSION [line 65]

UPLOAD_ERR_EXTENSION = 8

[ Top ]



UPLOAD_ERR_NO_TMP_DIR [line 59]

UPLOAD_ERR_NO_TMP_DIR = 6

[ Top ]




changePluginStatus [line 218]

void changePluginStatus( array $plugin_name)

Toggle plugin status from enabled to disabled and back



Parameters

array   $plugin_name   name of the plugin to be toggled
[ Top ]



change_load_order [line 529]

void change_load_order( [string $pi_name = ''], [mixed $where = ''])

Change the load order of a plugin



Parameters

string   $pi_name   Name of the plugin
mixed   $where   Where to move the plugin specified by $pi_name. Valid values are "up" and "dn", which stand for "Move 'Up' or 'Down' through the load order" or any integer between 0 and 10000.
[ Top ]



continue_upgrade [line 914]

string continue_upgrade( string $plugin, string $pi_version, string $code_version)

Continue a plugin upgrade that started in plugin_upload()



Tags:

return:  HTML refresh
see:  plugin_upload()


Parameters

string   $plugin   plugin name
string   $pi_version   current plugin version
string   $code_version   plugin version to be upgraded to
[ Top ]



do_uninstall [line 387]

string do_uninstall( string $pi_name)

Uninstall a plugin (call its uninstall function).



Tags:

return:  HTML for error or success message


Parameters

string   $pi_name   name of the plugin to uninstall
[ Top ]



do_update [line 350]

string do_update( string $pi_name)

Updates a plugin (call its upgrade function).



Tags:

return:  HTML for error or success message


Parameters

string   $pi_name   name of the plugin to uninstall
[ Top ]



listplugins [line 421]

string listplugins( string $token)

List available plugins



Tags:

return:  formatted list of plugins


Parameters

string   $token   Security token
[ Top ]



plugin_autoinstall [line 998]

boolean plugin_autoinstall( string $plugin)

Prepare and perform plugin auto install



Tags:

return:  true on success, false otherwise


Parameters

string   $plugin   Plugin name (internal name, i.e. directory name)
[ Top ]



plugin_do_autoinstall [line 1048]

boolean plugin_do_autoinstall( string $plugin, array $inst_parms, [boolean $verbose = true])

Do the actual plugin auto install



Tags:

return:  true on success, false otherwise


Parameters

string   $plugin   Plugin name
array   $inst_parms   Installation parameters for the plugin
boolean   $verbose   true: enable verbose logging
[ Top ]



plugin_getUploadError [line 575]

mixed plugin_getUploadError( array $mFile)

Check if an error occured while uploading a file



Tags:

return:  Returns the error string if an error occured, returns false if no error occured


Parameters

array   $mFile   $_FILE['uploaded_file']
[ Top ]



plugin_get_pluginname [line 1293]

string plugin_get_pluginname( string $plugin)

See if we can figure out the plugin's real name



Tags:

return:  real or beautified name


Parameters

string   $plugin   internal name / directory name
[ Top ]



plugin_info_installed [line 85]

string plugin_info_installed( string $pi_name)

Shows the plugin information center for installed plugins



Tags:

return:  HTML for plugin editor form or error message
todo:  FIXME Move that COM_errorLog message to the language files ...


Parameters

string   $pi_name   Plugin name
[ Top ]



plugin_info_uninstalled [line 171]

string plugin_info_uninstalled( string $pi_name)

Shows the plugin information center for uninstalled plugins



Tags:

return:  HTML for plugin editor form or error message


Parameters

string   $pi_name   Plugin name
[ Top ]



plugin_main [line 963]

string plugin_main( [string $message = ''], [string $token = ''])

Show main plugin screen: installed and uninstalled plugins, upload form



Tags:

return:  HTML for the plugin screen


Parameters

string   $message   (optional) message to display
string   $token   an optional csrf token
[ Top ]



plugin_show_uploadform [line 637]

string plugin_show_uploadform( string $token)

Display upload form



Tags:

return:  HTML for the upload form


Parameters

string   $token   Security token
[ Top ]



plugin_upload [line 676]

string plugin_upload( )

Handle uploaded plugin



Tags:

return:  HTML: redirect or main plugin screen + error message


[ Top ]



plugin_upload_enabled [line 599]

array plugin_upload_enabled( )

Check if uploads are possible



Tags:

return:  a list of errors or an empty array, if there weren't any.


[ Top ]



reorderplugins [line 502]

void reorderplugins( )

Re-orders all plugins by load order in increments of 10



[ Top ]



show_newplugins [line 253]

string show_newplugins( string $token)

Creates list of uninstalled plugins (if any) and offers install link to them.



Tags:

return:  HTML containing list of uninstalled plugins


Parameters

string   $token   Security token to use in list
[ Top ]



Documentation generated on Sun, 02 Oct 2016 07:53:30 +0000 by phpDocumentor 1.4.3