| [ Index ] |
PHP Cross Reference of Nucleus CMS v3.51 code documentation |
[Source view] [Print]
(no description)
| File Size: | 681 lines (23 kb) |
| Included or required: | 1 time |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
NucleusPlugin:: (68 methods):
getName()
getAuthor()
getURL()
getVersion()
getDescription()
getMinNucleusVersion()
getMinNucleusPatchLevel()
getEventList()
getTableList()
hasAdminArea()
install()
unInstall()
init()
doSkinVar()
doTemplateVar()
doTemplateCommentsVar()
doAction()
doIf()
doItemVar()
supportsFeature()
getPluginDep()
createOption()
createBlogOption()
createMemberOption()
createCategoryOption()
createItemOption()
deleteOption()
deleteBlogOption()
deleteMemberOption()
deleteCategoryOption()
deleteItemOption()
setOption()
setBlogOption()
setMemberOption()
setCategoryOption()
setItemOption()
getOption()
getBlogOption()
getMemberOption()
getCategoryOption()
getItemOption()
getAllBlogOptions()
getAllMemberOptions()
getAllCategoryOptions()
getAllItemOptions()
getBlogOptionTop()
getMemberOptionTop()
getCategoryOptionTop()
getItemOptionTop()
getID()
getAdminURL()
getDirectory()
getShortName()
clearOptionValueCache()
NucleusPlugin()
_getOptionTop()
_createOption()
_deleteOption()
_setOption()
_getOption()
_getAllOptions()
_getOID()
_getDefVal()
_deleteOptionValues()
getOptionMeta()
getOptionSelectValues()
subscribtionListIsUptodate()
_applyPluginOptions()
Class: NucleusPlugin - X-Ref
This is an (abstract) class of which all Nucleus Plugins must inherit| getName() X-Ref |
| No description |
| getAuthor() X-Ref |
| No description |
| getURL() X-Ref |
| No description |
| getVersion() X-Ref |
| No description |
| getDescription() X-Ref |
| No description |
| getMinNucleusVersion() X-Ref |
| No description |
| getMinNucleusPatchLevel() X-Ref |
| No description |
| getEventList() X-Ref |
| No description |
| getTableList() X-Ref |
| No description |
| hasAdminArea() X-Ref |
| No description |
| install() X-Ref |
| No description |
| unInstall() X-Ref |
| No description |
| init() X-Ref |
| No description |
| doSkinVar($skinType) X-Ref |
| No description |
| doTemplateVar(&$item) X-Ref |
| No description |
| doTemplateCommentsVar(&$item, &$comment) X-Ref |
| No description |
| doAction($type) X-Ref |
| No description |
| doIf($key,$value) X-Ref |
| No description |
| doItemVar(&$item) X-Ref |
| No description |
| supportsFeature($feature) X-Ref |
| Checks if a plugin supports a certain feature. returns: 1 if the feature is reported, 0 if not param: $feature |
| getPluginDep() X-Ref |
| Report a list of plugin that is required to function returns: an array of names of plugin, an empty array indicates no dependency |
| createOption($name, $desc, $type, $defValue = '', $typeExtras = '') X-Ref |
| Creates a new option for this plugin param: name param: description param: type param: value |
| createBlogOption($name, $desc, $type, $defValue = '', $typeExtras = '') X-Ref |
| No description |
| createMemberOption($name, $desc, $type, $defValue = '', $typeExtras = '') X-Ref |
| No description |
| createCategoryOption($name, $desc, $type, $defValue = '', $typeExtras = '') X-Ref |
| No description |
| createItemOption($name, $desc, $type, $defValue = '', $typeExtras = '') X-Ref |
| No description |
| deleteOption($name) X-Ref |
| Removes the option from the database Note: Options get erased automatically on plugin uninstall |
| deleteBlogOption($name) X-Ref |
| No description |
| deleteMemberOption($name) X-Ref |
| No description |
| deleteCategoryOption($name) X-Ref |
| No description |
| deleteItemOption($name) X-Ref |
| No description |
| setOption($name, $value) X-Ref |
| Sets the value of an option to something new |
| setBlogOption($blogid, $name, $value) X-Ref |
| No description |
| setMemberOption($memberid, $name, $value) X-Ref |
| No description |
| setCategoryOption($catid, $name, $value) X-Ref |
| No description |
| setItemOption($itemid, $name, $value) X-Ref |
| No description |
| getOption($name) X-Ref |
| Retrieves the current value for an option |
| getBlogOption($blogid, $name) X-Ref |
| No description |
| getMemberOption($memberid, $name) X-Ref |
| No description |
| getCategoryOption($catid, $name) X-Ref |
| No description |
| getItemOption($itemid, $name) X-Ref |
| No description |
| getAllBlogOptions($name) X-Ref |
| Retrieves an associative array with the option value for each context id |
| getAllMemberOptions($name) X-Ref |
| No description |
| getAllCategoryOptions($name) X-Ref |
| No description |
| getAllItemOptions($name) X-Ref |
| No description |
| getBlogOptionTop($name, $amount = 10, $sort = 'desc') X-Ref |
| Retrieves an indexed array with the top (or bottom) of an option (delegates to _getOptionTop()) |
| getMemberOptionTop($name, $amount = 10, $sort = 'desc') X-Ref |
| No description |
| getCategoryOptionTop($name, $amount = 10, $sort = 'desc') X-Ref |
| No description |
| getItemOptionTop($name, $amount = 10, $sort = 'desc') X-Ref |
| No description |
| getID() X-Ref |
| Returns the plugin ID public |
| getAdminURL() X-Ref |
| Returns the URL of the admin area for this plugin (in case there's no such area, the returned information is invalid) public |
| getDirectory() X-Ref |
| Returns the directory where the admin directory is located and where the plugin can maintain his extra files public |
| getShortName() X-Ref |
| Derives the short name for the plugin from the classname (all lowercase) public |
| clearOptionValueCache() X-Ref |
| Clears the option value cache which saves the option values during the plugin execution. This function is usefull if the options has changed during the plugin execution (especially in association with the PrePluginOptionsUpdate and the PostPluginOptionsUpdate events) public |
| NucleusPlugin() X-Ref |
| Class constructor: Initializes some internal data |
| _getOptionTop($context, $name, $amount = 10, $sort = 'desc') X-Ref |
| Retrieves an array of the top (or bottom) of an option from a plugin. author: TeRanEX param: string $context the context for the option: item, blog, member,... param: string $name the name of the option param: int $amount how many rows must be returned param: string $sort desc or asc return: array array with both values and contextid's |
| _createOption($context, $name, $desc, $type, $defValue, $typeExtras = '') X-Ref |
| Creates an option in the database table plugin_option_desc private |
| _deleteOption($context, $name) X-Ref |
| Deletes an option from the database tables plugin_option and plugin_option_desc private |
| _setOption($context, $contextid, $name, $value) X-Ref |
| Update an option in the database table plugin_option returns: 1 on success, 0 on failure private |
| _getOption($context, $contextid, $name) X-Ref |
| Get an option from Cache or database - if not in the option Cache read it from the database - if not in the database write default values into the database private |
| _getAllOptions($context, $name) X-Ref |
| Returns assoc array with all values for a given option (one option per possible context id) private |
| _getOID($context, $name) X-Ref |
| Gets the 'option identifier' that corresponds to a given option name. When this method is called for the first time, all the OIDs for the plugin are loaded into memory, to avoid re-doing the same query all over. |
| _getDefVal($context, $name) X-Ref |
| No description |
| _deleteOptionValues($context, $contextid) X-Ref |
| Deletes all option values for a given context and contextid (used when e.g. a blog, member or category is deleted) (static method) |
| getOptionMeta($typeExtra) X-Ref |
| splits the option's typeextra field (at ;'s) to split the meta collection author: TeRanEX param: string $typeExtra the value of the typeExtra field of an option return: array array of the meta-key/value-pairs |
| getOptionSelectValues($typeExtra) X-Ref |
| filters the selectlists out of the meta collection author: TeRanEX param: string $typeExtra the value of the typeExtra field of an option return: string the selectlist |
| subscribtionListIsUptodate() X-Ref |
| checks if the eventlist in the database is up-to-date author: TeRanEX return: bool if it is up-to-date it return true, else false |
| _applyPluginOptions(&$aOptions, $newContextid = 0) X-Ref |
param: $aOptions: array ( 'oid' => array( 'contextid' => 'value')) param: $newContextid: integer (accepts a contextid when it is for a new |
| Generated: Sun Aug 1 03:56:06 2010 |