Class Notifications

Xoops\Module\Helper\HelperAbstract

Extended by

Notifications

Copyright: XOOPS Project (http://xoops.org)
License: GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
Author: trabis lusopoemas@gmail.com
Version: $Id$
Located at odules/notifications/class/helper.php

Methods summary
`public null\|`	# `init( )` Init the module Init the module Returns null\| Overrides `Xoops\Module\Helper\HelperAbstract::init()`
`public static string`	# `getInstance( )` Returns string Overrides `Xoops\Module\Helper\HelperAbstract::getInstance()`
`public NotificationsNotificationHandler`	# `getHandlerNotification( )` Returns `NotificationsNotificationHandler`
`public boolean`	# `enabled( string $style, null\|string $module_dirname = null )` Parameters `$style` `$module_dirname` Returns boolean
`public array\|boolean`	# `getItem( string $category, integer $item_id, string $dirname = null )` Parameters `$category` `$item_id` `$dirname` Module dirname Returns array\|boolean
`public array\|boolean`	# `getTags( string $category, integer $item_id, string $event, string $dirname = null )` Parameters `$category` `$item_id` `$event` `$dirname` Module dirname Returns array\|boolean
`public mixed`	# `getCategory( string $category_name = '', string $dirname = null )` Get an associative array of info for a particular notification category in the selected module. If no category is selected, return an array of info for all categories. Get an associative array of info for a particular notification category in the selected module. If no category is selected, return an array of info for all categories. Parameters `$category_name` Category name (default all categories) `$dirname` ID of the module (default current module) Returns mixed
`public mixed`	# `getCommentsCategory( string $dirname = null )` Get associative array of info for the category to which comment events belong. Get associative array of info for the category to which comment events belong. todo, this belongs in the comment module no? - trabis Parameters `$dirname` Dirname of the module (default current module) Returns mixed Associative array of category info
`public mixed`	# `getEvents( string $category_name, boolean $enabled_only, string $dirname = null )` Get an array of info for all events (each event has associative array) in the selected category of the selected module. Get an array of info for all events (each event has associative array) in the selected category of the selected module. Parameters `$category_name` Category name `$enabled_only` If true, return only enabled events `$dirname` Dirname of the module (default current module) Returns mixed
`public boolean`	# `eventEnabled( array & $category, array & $event, string $dirname )` Determine whether a particular notification event is enabled. Depends on module config options. Determine whether a particular notification event is enabled. Depends on module config options. Parameters `$category` $category Category info array `$event` $event Event info array `$dirname` Module Returns boolean
`public mixed`	# `getEvent( string $category_name, string $event_name, string $module_dirname = null )` Get associative array of info for the selected event in the selected category (for the selected module). Get associative array of info for the selected event in the selected category (for the selected module). Parameters `$category_name` Notification category `$event_name` Notification event `$module_dirname` Dirname of the module (default current module) Returns mixed
`public mixed`	# `getSubscribableCategories( string $module_dirname = null )` Get an array of associative info arrays for subscribable categories for the selected module. Get an array of associative info arrays for subscribable categories for the selected module. Parameters `$module_dirname` ID of the module Returns mixed
`public boolean\|string`	# `generateConfig( array & $category, array & $event, string $type )` Generate module config info for a particular category, event pair. The selectable config options are given names depending on the category and event names, and the text depends on the category and event titles. These are pieced together in this function in case we wish to alter the syntax. Generate module config info for a particular category, event pair. The selectable config options are given names depending on the category and event names, and the text depends on the category and event titles. These are pieced together in this function in case we wish to alter the syntax. Parameters `$category` $category Array of category info `$event` $event Array of event info `$type` The particular name to generate Returns boolean\|string
`public`	# `insertModuleRelations( Xoops\Core\Kernel\Handlers\XoopsModule $module )` Parameters `$module`
`public`	# `deleteModuleRelations( Xoops\Core\Kernel\Handlers\XoopsModule $module )` Parameters `$module`
`public array`	# `getPluginableConfigs( Xoops\Core\Kernel\Handlers\XoopsModule $module )` Parameters `$module` Returns array

Methods inherited from Xoops\Module\Helper\HelperAbstract
`_addLog(), disableCache(), getConfig(), getConfigs(), getForm(), getHandler(), getModule(), isCurrentModule(), isUserAdmin(), loadLanguage(), loadLocale(), path(), redirect(), setDebug(), setDirname(), url(), xoops()`

Properties inherited from Xoops\Module\Helper\HelperAbstract
`$_debug, $_dirname, $_module`