Overview

Namespaces

  • None
  • Xmf
    • Database
    • Module
      • Helper
    • Template
  • Xoops
    • Auth
    • Core
      • Cache
      • Database
        • Logging
        • Schema
      • Exception
      • Handler
        • Scheme
      • Kernel
        • Dtype
        • Handlers
        • Model
      • Lists
      • Locale
        • Punic
      • Service
        • Contract
      • Session
      • Text
        • Sanitizer
          • Extensions
      • Theme
        • Plugins
    • Form
    • Html
    • Locale
    • Module
      • Helper
      • Plugin

Classes

  • ArtObject
  • ArtObjectHandler
  • Avatars
  • AvatarsAvatar
  • AvatarsAvatar_userForm
  • AvatarsAvatarForm
  • AvatarsAvatarHandler
  • AvatarsLocale
  • AvatarsLocaleEn_US
  • AvatarsPreload
  • AvatarsProvider
  • AvatarsUserlink
  • AvatarsUserlinkHandler
  • AwesomeButton
  • BannerRender
  • Banners
  • BannersBanner
  • BannersBannerclient
  • BannersBannerclientForm
  • BannersBannerclientHandler
  • BannersBannerForm
  • BannersBannerHandler
  • BannersPreload
  • BloggerApi
  • CodexMenusPlugin
  • CodexSearchPlugin
  • CodexSystemPlugin
  • CodexUserconfigsPlugin
  • Comments
  • CommentsComment
  • CommentsCommentForm
  • CommentsCommentHandler
  • CommentsCommentRenderer
  • CommentsPreload
  • CommentsSystemPlugin
  • CommentsUserconfigsPlugin
  • Cookie
  • CountryFlagProvider
  • Criteria
  • CriteriaCompo
  • CriteriaElement
  • DebugbarLogger
  • DebugbarPreload
  • DebugbarUserconfigsPlugin
  • DefaultThemeLocale
  • DefaultThemeLocaleEn_US
  • FormDhtmlTextArea
  • FormTextArea
  • GravatarsPreload
  • GravatarsProvider
  • htmLawed
  • HtmlToPdfProvider
  • imageLib
  • Images
  • ImagesCategory
  • ImagesCategory_imagemanagerForm
  • ImagesCategoryForm
  • ImagesCategoryHandler
  • ImagesCategoryselectForm
  • ImagesImage
  • ImagesImage_Body
  • ImagesImage_imagemanagerForm
  • ImagesImagebody
  • ImagesImagebodyHandler
  • ImagesImageForm
  • ImagesImageHandler
  • ImagesPreload
  • JUpload
  • LegacyLogger
  • LoggerPreload
  • LoggerUserconfigsPlugin
  • Maintenance
  • MaintenanceMaintenanceForm
  • Menus
  • MenusBuilder
  • MenusConstantDecorator
  • MenusDecorator
  • MenusDecoratorAbstract
  • MenusDefaultDecorator
  • MenusDynamicDecorator
  • MenusMenu
  • MenusMenuHandler
  • MenusMenus
  • MenusMenus_menuForm
  • MenusMenus_menusForm
  • MenusMenusHandler
  • MenusPreload
  • MenusSmartyDecorator
  • MetaWeblogApi
  • MonologLogger
  • MonologPreload
  • MonologUserconfigsPlugin
  • MovableTypeApi
  • MyTextSanitizer
  • MyTextSanitizerExtended
  • Notifications
  • NotificationsNotification
  • NotificationsNotificationHandler
  • NotificationsPreload
  • NotificationsSystemPlugin
  • Page
  • PageCommentsPlugin
  • PageGroupPermHandler
  • PageLocale
  • PageLocaleEn_US
  • PageNotificationsPlugin
  • PagePage_content
  • PagePage_contentForm
  • PagePage_contentHandler
  • PagePage_rating
  • PagePage_ratingHandler
  • PagePage_related
  • PagePage_related_link
  • PagePage_related_linkHandler
  • PagePage_relatedForm
  • PagePage_relatedHandler
  • PagePreload
  • PageSearchPlugin
  • PageSystemPlugin
  • PdfPreload
  • PmMessage
  • PmMessageHandler
  • PmPreload
  • ProfileCategory
  • ProfileCategoryForm
  • ProfileCategoryHandler
  • ProfileCorePreload
  • ProfileField
  • ProfileFieldForm
  • ProfileFieldHandler
  • ProfileMenusPlugin
  • ProfileProfile
  • ProfileProfileHandler
  • ProfileRegstep
  • ProfileRegstepForm
  • ProfileRegstepHandler
  • ProfileVisibility
  • ProfileVisibilityHandler
  • Protector
  • protector_bruteforce_overrun_message
  • protector_crawler_overrun_message
  • protector_f5attack_overrun_message
  • protector_postcommon_post_deny_by_httpbl
  • protector_postcommon_post_deny_by_rbl
  • protector_postcommon_post_htmlpurify4everyone
  • protector_postcommon_post_htmlpurify4guest
  • protector_postcommon_post_need_multibyte
  • protector_postcommon_post_register_moratorium
  • protector_postcommon_register_insert_js_check
  • protector_precommon_badip_errorlog
  • protector_precommon_badip_message
  • protector_precommon_badip_redirection
  • protector_precommon_bwlimit_errorlog
  • protector_precommon_bwlimit_message
  • protector_prepurge_exit_message
  • protector_spamcheck_overrun_message
  • ProtectorCenterForm
  • ProtectorCorePreload
  • ProtectorFilterAbstract
  • ProtectorFilterHandler
  • ProtectorMySQLDatabase
  • Publisher
  • PublisherBlockForm
  • PublisherCategory
  • PublisherCategoryForm
  • PublisherCategoryHandler
  • PublisherCommentsPlugin
  • PublisherFile
  • PublisherFileForm
  • PublisherFileHandler
  • PublisherFormDateTime
  • PublisherGroupPermHandler
  • PublisherItem
  • PublisherItemForm
  • PublisherItemHandler
  • PublisherMenusPlugin
  • PublisherMetagen
  • PublisherMimetype
  • PublisherMimetypeHandler
  • PublisherNotificationsPlugin
  • PublisherPermissionHandler
  • PublisherPreload
  • PublisherRating
  • PublisherRatingHandler
  • PublisherSearchPlugin
  • PublisherSystemPlugin
  • PublisherUtils
  • QrcodePreload
  • QrcodeProvider
  • ReCaptchaResponse
  • RpcArrayHandler
  • RpcBase64Handler
  • RpcBooleanHandler
  • RpcDateTimeHandler
  • RpcDoubleHandler
  • RpcIntHandler
  • RpcMemberHandler
  • RpcMethodNameHandler
  • RpcNameHandler
  • RpcStringHandler
  • RpcStructHandler
  • RpcValueHandler
  • RssAuthorHandler
  • RssCategoryHandler
  • RssChannelHandler
  • RssCommentsHandler
  • RssCopyrightHandler
  • RssDescriptionHandler
  • RssDocsHandler
  • RssGeneratorHandler
  • RssGuidHandler
  • RssHeightHandler
  • RssImageHandler
  • RssItemHandler
  • RssLanguageHandler
  • RssLastBuildDateHandler
  • RssLinkHandler
  • RssManagingEditorHandler
  • RssNameHandler
  • RssPubDateHandler
  • RssSourceHandler
  • RssTextInputHandler
  • RssTitleHandler
  • RssTtlHandler
  • RssUrlHandler
  • RssWebMasterHandler
  • RssWidthHandler
  • SaxParser
  • Search
  • SearchPreload
  • SearchSearchForm
  • Smarty_Resource_Admin
  • Smarty_Resource_Block
  • Smarty_Resource_Db
  • Smarty_Resource_Module
  • Smilies
  • SmiliesPreload
  • SmiliesProvider
  • SmiliesSmiley
  • SmiliesSmileyHandler
  • SmiliesSmiliesForm
  • Snoopy
  • SqlUtility
  • System
  • SystemBlockForm
  • SystemBreadcrumb
  • SystemExtension
  • SystemGroupForm
  • SystemLocale
  • SystemLocaleEn_US
  • SystemMenuHandler
  • SystemModule
  • SystemPreferencesForm
  • SystemPreload
  • SystemUserForm
  • tar
  • ThemeSetAuthorHandler
  • ThemeSetDateCreatedHandler
  • ThemeSetDescriptionHandler
  • ThemeSetEmailHandler
  • ThemeSetFileTypeHandler
  • ThemeSetGeneratorHandler
  • ThemeSetImageHandler
  • ThemeSetLinkHandler
  • ThemeSetModuleHandler
  • ThemeSetNameHandler
  • ThemeSetTagHandler
  • ThemeSetTemplateHandler
  • Thumbs
  • ThumbsPreload
  • ThumbsProvider
  • TinyMCE
  • Userconfigs
  • UserconfigsConfigHandler
  • UserconfigsConfigsForm
  • UserconfigsItem
  • UserconfigsItemHandler
  • UserconfigsMenusPlugin
  • UserconfigsModulesForm
  • UserconfigsOption
  • UserconfigsOptionHandler
  • UserconfigsPreload
  • UserconfigsSystemPlugin
  • UserrankPreload
  • UserRankProvider
  • UserrankRank
  • UserrankRankHandler
  • UserrankRanksForm
  • Xcaptcha
  • XcaptchaCaptchaForm
  • XcaptchaImage
  • XcaptchaImageForm
  • XcaptchaRecaptcha
  • XcaptchaRecaptchaForm
  • XcaptchaText
  • XcaptchaTextForm
  • Xlanguage
  • XlanguageLanguage
  • XlanguageLanguageForm
  • XlanguagePreload
  • XlanguageTinymceForm
  • XlanguageXlanguageHandler
  • Xmf\Database\TableLoad
  • Xmf\Database\Tables
  • Xmf\Debug
  • Xmf\FilterInput
  • Xmf\Highlighter
  • Xmf\Language
  • Xmf\Loader
  • Xmf\Metagen
  • Xmf\Module\Admin
  • Xmf\Module\Cache
  • Xmf\Module\Helper
  • Xmf\Module\Helper\AbstractHelper
  • Xmf\Module\Helper\GenericHelper
  • Xmf\Module\Permission
  • Xmf\Module\Session
  • Xmf\Request
  • Xmf\Template\AbstractTemplate
  • Xmf\Template\Breadcrumb
  • Xmf\Template\Buttonbox
  • Xmf\Template\Feed
  • Xmf\Template\PrintContent
  • Xmf\Utilities
  • Xmf\Yaml
  • XmfPreload
  • XmlTagHandler
  • Xoops
  • Xoops\Auth\Ads
  • Xoops\Auth\AuthAbstract
  • Xoops\Auth\Factory
  • Xoops\Auth\Ldap
  • Xoops\Auth\Provisioning
  • Xoops\Auth\Xoops
  • Xoops\Cache
  • Xoops\Core\Assets
  • Xoops\Core\Cache\Access
  • Xoops\Core\Cache\CacheManager
  • Xoops\Core\Cache\DriverList
  • Xoops\Core\Cache\Legacy
  • Xoops\Core\ComposerUtility
  • Xoops\Core\Database\Connection
  • Xoops\Core\Database\Factory
  • Xoops\Core\Database\Logging\XoopsDebugStack
  • Xoops\Core\Database\QueryBuilder
  • Xoops\Core\Database\Schema\ExportVisitor
  • Xoops\Core\Database\Schema\ImportSchema
  • Xoops\Core\Database\Schema\PrefixStripper
  • Xoops\Core\Database\Schema\RemovePrefixes
  • Xoops\Core\Events
  • Xoops\Core\FilterInput
  • Xoops\Core\FixedGroups
  • Xoops\Core\Handler\Factory
  • Xoops\Core\Handler\FactorySpec
  • Xoops\Core\Handler\Scheme\FQN
  • Xoops\Core\Handler\Scheme\Kernel
  • Xoops\Core\Handler\Scheme\LegacyModule
  • Xoops\Core\HttpRequest
  • Xoops\Core\Kernel\Criteria
  • Xoops\Core\Kernel\CriteriaCompo
  • Xoops\Core\Kernel\CriteriaElement
  • Xoops\Core\Kernel\Dtype
  • Xoops\Core\Kernel\Dtype\DtypeAbstract
  • Xoops\Core\Kernel\Dtype\DtypeArray
  • Xoops\Core\Kernel\Dtype\DtypeDateTime
  • Xoops\Core\Kernel\Dtype\DtypeDecimal
  • Xoops\Core\Kernel\Dtype\DtypeEmail
  • Xoops\Core\Kernel\Dtype\DtypeEnumeration
  • Xoops\Core\Kernel\Dtype\DtypeFloat
  • Xoops\Core\Kernel\Dtype\DtypeInt
  • Xoops\Core\Kernel\Dtype\DtypeJson
  • Xoops\Core\Kernel\Dtype\DtypeMoney
  • Xoops\Core\Kernel\Dtype\DtypeOther
  • Xoops\Core\Kernel\Dtype\DtypeSimpleTime
  • Xoops\Core\Kernel\Dtype\DtypeSource
  • Xoops\Core\Kernel\Dtype\DtypeTextArea
  • Xoops\Core\Kernel\Dtype\DtypeTextBox
  • Xoops\Core\Kernel\Dtype\DtypeTimeZone
  • Xoops\Core\Kernel\Dtype\DtypeUrl
  • Xoops\Core\Kernel\Handlers\XoopsBlock
  • Xoops\Core\Kernel\Handlers\XoopsBlockHandler
  • Xoops\Core\Kernel\Handlers\XoopsBlockModuleLink
  • Xoops\Core\Kernel\Handlers\XoopsBlockModuleLinkHandler
  • Xoops\Core\Kernel\Handlers\XoopsConfigHandler
  • Xoops\Core\Kernel\Handlers\XoopsConfigItem
  • Xoops\Core\Kernel\Handlers\XoopsConfigItemHandler
  • Xoops\Core\Kernel\Handlers\XoopsConfigOption
  • Xoops\Core\Kernel\Handlers\XoopsConfigOptionHandler
  • Xoops\Core\Kernel\Handlers\XoopsGroup
  • Xoops\Core\Kernel\Handlers\XoopsGroupHandler
  • Xoops\Core\Kernel\Handlers\XoopsGroupPerm
  • Xoops\Core\Kernel\Handlers\XoopsGroupPermHandler
  • Xoops\Core\Kernel\Handlers\XoopsMemberHandler
  • Xoops\Core\Kernel\Handlers\XoopsMembership
  • Xoops\Core\Kernel\Handlers\XoopsMembershipHandler
  • Xoops\Core\Kernel\Handlers\XoopsModule
  • Xoops\Core\Kernel\Handlers\XoopsModuleHandler
  • Xoops\Core\Kernel\Handlers\XoopsOnline
  • Xoops\Core\Kernel\Handlers\XoopsOnlineHandler
  • Xoops\Core\Kernel\Handlers\XoopsPrivateMessage
  • Xoops\Core\Kernel\Handlers\XoopsPrivateMessageHandler
  • Xoops\Core\Kernel\Handlers\XoopsTplFile
  • Xoops\Core\Kernel\Handlers\XoopsTplFileHandler
  • Xoops\Core\Kernel\Handlers\XoopsTplSet
  • Xoops\Core\Kernel\Handlers\XoopsTplSetHandler
  • Xoops\Core\Kernel\Handlers\XoopsUser
  • Xoops\Core\Kernel\Handlers\XoopsUserHandler
  • Xoops\Core\Kernel\Model\Joint
  • Xoops\Core\Kernel\Model\Read
  • Xoops\Core\Kernel\Model\Stats
  • Xoops\Core\Kernel\Model\Sync
  • Xoops\Core\Kernel\Model\Write
  • Xoops\Core\Kernel\XoopsModelAbstract
  • Xoops\Core\Kernel\XoopsModelFactory
  • Xoops\Core\Kernel\XoopsObject
  • Xoops\Core\Kernel\XoopsObjectHandler
  • Xoops\Core\Kernel\XoopsPersistableObjectHandler
  • Xoops\Core\Lists\Country
  • Xoops\Core\Lists\Directory
  • Xoops\Core\Lists\Editor
  • Xoops\Core\Lists\File
  • Xoops\Core\Lists\HtmlFile
  • Xoops\Core\Lists\ImageFile
  • Xoops\Core\Lists\ListAbstract
  • Xoops\Core\Lists\Locale
  • Xoops\Core\Lists\Module
  • Xoops\Core\Lists\Month
  • Xoops\Core\Lists\SubjectIcon
  • Xoops\Core\Lists\SubSet
  • Xoops\Core\Lists\Theme
  • Xoops\Core\Lists\Time
  • Xoops\Core\Lists\TimeZone
  • Xoops\Core\Locale\LegacyCodes
  • Xoops\Core\Locale\Punic\Calendar
  • Xoops\Core\Locale\Time
  • Xoops\Core\Logger
  • Xoops\Core\MediaUploader
  • Xoops\Core\MimeTypes
  • Xoops\Core\PreloadItem
  • Xoops\Core\Psr0ClassLoader
  • Xoops\Core\Psr4ClassLoader
  • Xoops\Core\Random
  • Xoops\Core\Registry
  • Xoops\Core\Request
  • Xoops\Core\Security
  • Xoops\Core\Service\AbstractContract
  • Xoops\Core\Service\Manager
  • Xoops\Core\Service\NullProvider
  • Xoops\Core\Service\Provider
  • Xoops\Core\Service\Response
  • Xoops\Core\Session\Fingerprint
  • Xoops\Core\Session\Handler
  • Xoops\Core\Session\Manager
  • Xoops\Core\Session\RememberMe
  • Xoops\Core\Session\SessionUser
  • Xoops\Core\Text\Sanitizer
  • Xoops\Core\Text\Sanitizer\Configuration
  • Xoops\Core\Text\Sanitizer\ConfigurationAbstract
  • Xoops\Core\Text\Sanitizer\DefaultConfiguration
  • Xoops\Core\Text\Sanitizer\ExtensionAbstract
  • Xoops\Core\Text\Sanitizer\Extensions\Censor
  • Xoops\Core\Text\Sanitizer\Extensions\Clickable
  • Xoops\Core\Text\Sanitizer\Extensions\Embed
  • Xoops\Core\Text\Sanitizer\Extensions\Flash
  • Xoops\Core\Text\Sanitizer\Extensions\Iframe
  • Xoops\Core\Text\Sanitizer\Extensions\Image
  • Xoops\Core\Text\Sanitizer\Extensions\Mms
  • Xoops\Core\Text\Sanitizer\Extensions\Mp3
  • Xoops\Core\Text\Sanitizer\Extensions\Quote
  • Xoops\Core\Text\Sanitizer\Extensions\Rtsp
  • Xoops\Core\Text\Sanitizer\Extensions\SoundCloud
  • Xoops\Core\Text\Sanitizer\Extensions\SyntaxHighlight
  • Xoops\Core\Text\Sanitizer\Extensions\TextFilter
  • Xoops\Core\Text\Sanitizer\Extensions\UnorderedList
  • Xoops\Core\Text\Sanitizer\Extensions\Wiki
  • Xoops\Core\Text\Sanitizer\Extensions\Wmp
  • Xoops\Core\Text\Sanitizer\Extensions\XoopsCode
  • Xoops\Core\Text\Sanitizer\Extensions\Xss
  • Xoops\Core\Text\Sanitizer\Extensions\YouTube
  • Xoops\Core\Text\Sanitizer\FilterAbstract
  • Xoops\Core\Text\Sanitizer\NullExtension
  • Xoops\Core\Text\Sanitizer\NullFilter
  • Xoops\Core\Text\Sanitizer\SanitizerComponent
  • Xoops\Core\Text\Sanitizer\SanitizerConfigurable
  • Xoops\Core\Text\ShortCodes
  • Xoops\Core\Theme\AdminFactory
  • Xoops\Core\Theme\Factory
  • Xoops\Core\Theme\NullTheme
  • Xoops\Core\Theme\PluginAbstract
  • Xoops\Core\Theme\Plugins\Blocks
  • Xoops\Core\Theme\XoopsTheme
  • Xoops\Core\XoopsTpl
  • Xoops\Core\Yaml
  • Xoops\Form\BlockForm
  • Xoops\Form\Button
  • Xoops\Form\ButtonTray
  • Xoops\Form\Captcha
  • Xoops\Form\Checkbox
  • Xoops\Form\ColorPicker
  • Xoops\Form\DateSelect
  • Xoops\Form\DateTime
  • Xoops\Form\DhtmlTextArea
  • Xoops\Form\Editor
  • Xoops\Form\Element
  • Xoops\Form\ElementFactory
  • Xoops\Form\ElementTray
  • Xoops\Form\File
  • Xoops\Form\Form
  • Xoops\Form\GroupCheckbox
  • Xoops\Form\GroupFormCheckbox
  • Xoops\Form\GroupPermissionForm
  • Xoops\Form\Hidden
  • Xoops\Form\Label
  • Xoops\Form\Mail
  • Xoops\Form\OptionElement
  • Xoops\Form\Password
  • Xoops\Form\Radio
  • Xoops\Form\RadioYesNo
  • Xoops\Form\Raw
  • Xoops\Form\Select
  • Xoops\Form\SelectCountry
  • Xoops\Form\SelectEditor
  • Xoops\Form\SelectGroup
  • Xoops\Form\SelectLanguage
  • Xoops\Form\SelectLocale
  • Xoops\Form\SelectMatchOption
  • Xoops\Form\SelectTheme
  • Xoops\Form\SelectTimeZone
  • Xoops\Form\SelectUser
  • Xoops\Form\SimpleForm
  • Xoops\Form\Tab
  • Xoops\Form\TableForm
  • Xoops\Form\TabTray
  • Xoops\Form\Text
  • Xoops\Form\TextArea
  • Xoops\Form\ThemeForm
  • Xoops\Form\Token
  • Xoops\Form\Url
  • Xoops\Html\Attributes
  • Xoops\Html\Img
  • Xoops\Locale
  • Xoops\Locale\AbstractLocale
  • Xoops\Module\Admin
  • Xoops\Module\Helper
  • Xoops\Module\Helper\Dummy
  • Xoops\Module\Helper\HelperAbstract
  • Xoops\Module\Plugin
  • Xoops\Module\Plugin\ConfigCollector
  • Xoops\Module\Plugin\PluginAbstract
  • Xoops\Utils
  • Xoops_Locale_Mailer_Abstract
  • XoopsAdminThemeFactory
  • XoopsApi
  • XoopsArt
  • XoopsBaseConfig
  • XoopsBlock
  • XoopsBlockHandler
  • XoopsBlockmodulelink
  • XoopsBlockmodulelinkHandler
  • XoopsCache
  • XoopsCaptcha
  • XoopsCaptchaImage
  • XoopsCaptchaImageHandler
  • XoopsCaptchaMethod
  • XoopsCaptchaRecaptcha
  • XoopsCaptchaText
  • XoopsConfigHandler
  • XoopsConfigItem
  • XoopsConfigItemHandler
  • XoopsConfigOption
  • XoopsConfigOptionHandler
  • XoopsDatabase
  • XoopsDatabaseFactory
  • XoopsDatabaseManager
  • XoopsDownloader
  • XoopsEditor
  • XoopsEditorHandler
  • XoopsFile
  • XoopsFileHandler
  • XoopsFilterInput
  • XoopsFolderHandler
  • XoopsForm
  • XoopsFormButton
  • XoopsFormButtonTray
  • XoopsFormCaptcha
  • XoopsFormCheckBox
  • XoopsFormColorPicker
  • XoopsFormDateTime
  • XoopsFormDhtmlTextArea
  • XoopsFormEditor
  • XoopsFormElement
  • XoopsFormElementTray
  • XoopsFormFile
  • XoopsFormHidden
  • XoopsFormHiddenToken
  • XoopsFormLabel
  • XoopsFormPassword
  • XoopsFormRadio
  • XoopsFormRadioYN
  • XoopsFormSelect
  • XoopsFormSelectCheckGroup
  • XoopsFormSelectCountry
  • XoopsFormSelectEditor
  • XoopsFormSelectGroup
  • XoopsFormSelectLang
  • XoopsFormSelectMatchOption
  • XoopsFormSelectTheme
  • XoopsFormSelectTimezone
  • XoopsFormSelectUser
  • XoopsFormText
  • XoopsFormTextArea
  • XoopsFormTextDateSelect
  • XoopsFormTinymce
  • XoopsFormTinymce4
  • XoopsGroup
  • XoopsGroupHandler
  • XoopsGroupPerm
  • XoopsGroupPermForm
  • XoopsGroupPermHandler
  • XoopsGTicket
  • XoopsGuiDefault
  • XoopsInstallWizard
  • XoopsLists
  • XoopsLoad
  • XoopsLocal
  • XoopsLocale
  • XoopsLocaleEn_US
  • XoopsLogger
  • XoopsMailer
  • XoopsMailerLocal
  • XoopsMailerLocale
  • XoopsMediaUploader
  • XoopsMemberHandler
  • XoopsMembership
  • XoopsMembershipHandler
  • XoopsModule
  • XoopsModuleHandler
  • XoopsMultiMailer
  • XoopsMySQLDatabase
  • XoopsMySQLDatabaseProxy
  • XoopsMySQLDatabaseSafe
  • XoopsObject
  • XoopsObjectHandler
  • XoopsObjectTree
  • XoopsOnline
  • XoopsOnlineHandler
  • XoopsPageNav
  • XoopsPathController
  • XoopsPersistableObjectHandler
  • XoopsPreload
  • XoopsPreloadItem
  • XoopsPrivmessage
  • XoopsPrivmessageHandler
  • XoopsRequest
  • XoopsSecurity
  • XoopsSimpleForm
  • XoopsTableForm
  • XoopsTarDownloader
  • XoopsTheme
  • XoopsThemeBlocksPlugin
  • XoopsThemeFactory
  • XoopsThemeForm
  • XoopsThemePlugin
  • XoopsThemeSetParser
  • XoopsTpl
  • XoopsTplfile
  • XoopsTplfileHandler
  • XoopsTplset
  • XoopsTplsetHandler
  • XoopsUser
  • XoopsUserHandler
  • XoopsUserUtility
  • XoopsUtility
  • XoopsXmlRpcApi
  • XoopsXmlRpcArray
  • XoopsXmlRpcBase64
  • XoopsXmlRpcBoolean
  • XoopsXmlRpcDatetime
  • XoopsXmlRpcDocument
  • XoopsXmlRpcDouble
  • XoopsXmlRpcFault
  • XoopsXmlRpcInt
  • XoopsXmlRpcParser
  • XoopsXmlRpcRequest
  • XoopsXmlRpcResponse
  • XoopsXmlRpcString
  • XoopsXmlRpcStruct
  • XoopsXmlRpcTag
  • XoopsXmlRss2Parser
  • XoopsZipDownloader
  • zipfile

Interfaces

  • CommentsPluginInterface
  • MenusDecoratorInterface
  • MenusPluginInterface
  • NotificationsPluginInterface
  • SearchPluginInterface
  • SystemPluginInterface
  • UserconfigsPluginInterface
  • Xoops\Core\AttributeInterface
  • Xoops\Core\Handler\Scheme\SchemeInterface
  • Xoops\Core\Service\Contract\AvatarInterface
  • Xoops\Core\Service\Contract\CountryflagInterface
  • Xoops\Core\Service\Contract\EmojiInterface
  • Xoops\Core\Service\Contract\HtmlToPdfInterface
  • Xoops\Core\Service\Contract\QrcodeInterface
  • Xoops\Core\Service\Contract\ThumbnailInterface
  • Xoops\Core\Service\Contract\UserRankInterface
  • Xoops\Core\Session\FingerprintInterface
  • Xoops\Form\ContainerInterface

Exceptions

  • Xoops\Core\Exception\InvalidHandlerSpecException
  • Xoops\Core\Exception\NoHandlerException

Functions

  • _changeMimeValue
  • _clearAddSessionVars
  • _clearEditSessionVars
  • _ee
  • _recaptcha_aes_encrypt
  • _recaptcha_aes_pad
  • _recaptcha_http_post
  • _recaptcha_mailhide_email_parts
  • _recaptcha_mailhide_urlbase64
  • _recaptcha_qsencode
  • _tt
  • add
  • addCriteria
  • admin_refcheck
  • b_comments_edit
  • b_comments_show
  • b_notification_show
  • b_search_show
  • b_system_info_edit
  • b_system_info_show
  • b_system_login_show
  • b_system_main_edit
  • b_system_main_show
  • b_system_newmembers_edit
  • b_system_newmembers_show
  • b_system_online_show
  • b_system_themes_edit
  • b_system_themes_show
  • b_system_topposters_edit
  • b_system_topposters_show
  • b_system_user_show
  • b_system_waiting_show
  • b_xlanguage_select_edit
  • b_xlanguage_select_show
  • banners_blocks_edit
  • banners_blocks_show
  • base_url
  • buildRssFeedCache
  • buildTable
  • check_files_extensions_on_path
  • check_files_extensions_on_phar
  • checkEmail
  • clearAddSession
  • clearEditSession
  • config_loading
  • create_folder
  • create_img
  • create_img_gd
  • createConfigform
  • createDir
  • createThemeform
  • dateSort
  • debugger
  • delete
  • deleteDir
  • duplicate_file
  • edit
  • endsWith
  • exception_handler
  • extensionSort
  • file_put_contents
  • filenameSort
  • filescount
  • fix_dirname
  • fix_filename
  • fix_get_params
  • fix_path
  • fix_strtolower
  • fix_strtoupper
  • foldersize
  • formatTimestamp
  • formatURL
  • genPathCheckHtml
  • get_file_by_url
  • get_writeoks_from_protector
  • getBrightness
  • getDbConnection
  • getDbConnectionParams
  • getDirList
  • handle_uploaded_files
  • http_response_code
  • image_check_memory_usage
  • install_acceptUser
  • install_finalize
  • installHtmlSpecialCharacters
  • is_function_callable
  • is_really_writable
  • load_functions
  • load_object
  • load_objectHandler
  • loadModuleAdminMenu
  • makeSize
  • manage
  • menus_block_edit
  • menus_block_show
  • menus_mainmenu_show
  • mod_clearCacheFile
  • mod_clearConfg
  • mod_clearConfig
  • mod_clearFile
  • mod_clearSmartyCache
  • mod_constant
  • mod_createCacheFile
  • mod_createCacheFile_byGroup
  • mod_createFile
  • mod_DB_prefix
  • mod_fetchConfg
  • mod_fetchConfig
  • mod_generateCacheId
  • mod_generateCacheId_byGroup
  • mod_getDirname
  • mod_getMysqlVersion
  • mod_isModuleAction
  • mod_loadCacheFile
  • mod_loadCacheFile_byGroup
  • mod_loadConfg
  • mod_loadConfig
  • mod_loadFile
  • mod_loadFunctions
  • mod_loadRenderer
  • mod_message
  • modify_chmod
  • new_thumbnails_creation
  • normalizeColor
  • page_blocks_edit
  • page_blocks_show
  • profile_getRegisterForm
  • profile_getUserForm
  • profile_install_addCategory
  • profile_install_addField
  • profile_install_addStep
  • profile_install_initializeProfiles
  • profile_install_setPermissions
  • protector_ip_cmp
  • protector_postcheck
  • protector_precheck
  • publisher_category_items_sel_edit
  • publisher_category_items_sel_show
  • publisher_cloneFileFolder
  • publisher_createLogo
  • publisher_date_to_date_edit
  • publisher_date_to_date_show
  • publisher_displayCategory
  • publisher_editCat
  • publisher_editFile
  • publisher_editItem
  • publisher_items_columns_edit
  • publisher_items_columns_show
  • publisher_items_menu_edit
  • publisher_items_menu_show
  • publisher_items_new_edit
  • publisher_items_new_show
  • publisher_items_random_item_show
  • publisher_items_recent_edit
  • publisher_items_recent_show
  • publisher_items_spot_edit
  • publisher_items_spot_show
  • publisher_latest_files_edit
  • publisher_latest_files_show
  • publisher_latest_news_edit
  • publisher_latest_news_show
  • publisher_mk_chkbox
  • publisher_mk_select
  • publisher_pagewrap_upload
  • publisher_search
  • publisher_search_show
  • publisher_tag_iteminfo
  • publisher_tag_synchronization
  • rcopy
  • recaptcha_check_answer
  • recaptcha_get_html
  • recaptcha_get_signup_url
  • recaptcha_mailhide_html
  • recaptcha_mailhide_url
  • redirect_header
  • rename_file
  • rename_folder
  • rrename
  • rrename_after_cleaner
  • search
  • sizeSort
  • smarty_block_assets
  • smarty_block_noshortcodes
  • smarty_compiler_xoAdminIcons
  • smarty_compiler_xoAdminNav
  • smarty_compiler_xoAppUrl
  • smarty_compiler_xoImgUrl
  • smarty_compiler_xoModuleIcons16
  • smarty_compiler_xoModuleIcons32
  • smarty_compiler_xoModuleIconsBookmarks
  • smarty_function_addBaseScript
  • smarty_function_addBaseStylesheet
  • smarty_function_securityToken
  • smarty_function_thumbnail
  • smarty_function_translate
  • smarty_function_translateTheme
  • smarty_function_xoblock
  • smarty_function_xoInboxCount
  • smarty_function_xoMemberInfo
  • smarty_function_xoops_link
  • smarty_function_xoPageNav
  • smarty_modifier_datetime
  • smarty_modifier_debug_print_var
  • smarty_outputfilter_shortcodes
  • synchronize
  • system_AdminIcons
  • system_adminVersion
  • system_cleanVars
  • system_loadLanguage
  • system_loadTemplate
  • updateMimeValue
  • userTimeToServerTime
  • xhtmlspecialchars
  • xlanguage_convert_encoding
  • xlanguage_convert_item
  • xlanguage_copyfile
  • xlanguage_detectLang
  • xlanguage_encoding
  • xlanguage_lang_detect
  • xlanguage_mkdirs
  • xlanguage_ml
  • xlanguage_ml_escape_bracket
  • xlanguage_select_show
  • xoBoolField
  • xoDiag
  • xoDiagBoolSetting
  • xoDiagIfWritable
  • xoFormField
  • xoops_comment_count
  • xoops_comment_delete
  • xoops_confirm
  • xoops_convert_encoding
  • xoops_cp_footer
  • xoops_cp_header
  • xoops_error
  • xoops_footer
  • xoops_getActiveModules
  • xoops_getbanner
  • xoops_getBaseDomain
  • xoops_getConfigOption
  • xoops_getcss
  • xoops_getenv
  • xoops_getHandler
  • xoops_getMailer
  • xoops_getModuleHandler
  • xoops_getModuleOption
  • xoops_getOption
  • xoops_getrank
  • xoops_getUrlDomain
  • xoops_getUserTimestamp
  • xoops_groupperm_deletebymoditem
  • xoops_header
  • xoops_isActiveModule
  • xoops_load
  • xoops_loadLanguage
  • xoops_makepass
  • xoops_message
  • xoops_module_install_avatars
  • xoops_module_install_banners
  • xoops_module_install_comments
  • xoops_module_install_debugbar
  • xoops_module_install_notifications
  • xoops_module_install_page
  • xoops_module_install_pm
  • xoops_module_install_profile
  • xoops_module_install_publisher
  • xoops_module_install_smilies
  • xoops_module_install_system
  • xoops_module_install_userrank
  • xoops_module_install_xlanguage
  • xoops_module_pre_uninstall_comments
  • xoops_module_pre_uninstall_notifications
  • xoops_module_update_comments
  • xoops_module_update_debugbar
  • xoops_module_update_notifications
  • xoops_module_update_pm
  • xoops_module_update_profile
  • xoops_module_update_publisher
  • xoops_module_update_search
  • xoops_module_update_system
  • xoops_module_update_xlanguage
  • xoops_notification_deletebyitem
  • xoops_notification_deletebymodule
  • xoops_notification_deletebyuser
  • xoops_result
  • xoops_setActiveModules
  • xoops_setConfigOption
  • xoops_substr
  • xoops_template_clear_module_cache
  • xoops_template_touch
  • xoops_trim
  • xoops_utf8_encode
  • xoopseditor_get_rootpath
  • xoPassField
  • xoPhpVersion
  • Overview
  • Namespace
  • Class
  • Tree
  1: <?php
  2: /*
  3:  You may not change or alter any portion of this comment or credits
  4:  of supporting developers from this source code or any supporting source code
  5:  which is considered copyrighted (c) material of the original comment or credit authors.
  6: 
  7:  This program is distributed in the hope that it will be useful,
  8:  but WITHOUT ANY WARRANTY; without even the implied warranty of
  9:  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 10: */
 11: 
 12: use Xoops\Core\Database\Connection;
 13: use Xoops\Core\Kernel\Criteria;
 14: use Xoops\Core\Kernel\CriteriaCompo;
 15: use Xoops\Core\Kernel\CriteriaElement;
 16: use Xoops\Core\Kernel\XoopsObject;
 17: use Xoops\Core\Kernel\XoopsPersistableObjectHandler;
 18: use Xoops\Core\Kernel\Handlers\XoopsUser;
 19: 
 20: /**
 21:  * A Notification
 22:  *
 23:  * @category  Module
 24:  * @package   Notifications
 25:  * @author    Michael van Dam <mvandam@caltech.edu>
 26:  * @author    Kazumi Ono (AKA onokazu) http://www.myweb.ne.jp/, http://jp.xoops.org/
 27:  * @author    trabis <lusopoemas@gmail.com>
 28:  * @copyright 2000-2013 XOOPS Project (http://xoops.org)
 29:  * @license   GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
 30:  * @link      http://xoops.org
 31:  * @since     2.0.0
 32:  */
 33: class NotificationsNotification extends XoopsObject
 34: {
 35:     /**
 36:      * Constructor
 37:      **/
 38:     public function __construct()
 39:     {
 40:         $this->initVar('id', XOBJ_DTYPE_INT, null, false);
 41:         $this->initVar('modid', XOBJ_DTYPE_INT, null, false);
 42:         $this->initVar('category', XOBJ_DTYPE_TXTBOX, null, false, 30);
 43:         $this->initVar('itemid', XOBJ_DTYPE_INT, 0, false);
 44:         $this->initVar('event', XOBJ_DTYPE_TXTBOX, null, false, 30);
 45:         $this->initVar('uid', XOBJ_DTYPE_INT, 0, true);
 46:         $this->initVar('mode', XOBJ_DTYPE_INT, 0, false);
 47:     }
 48: 
 49:     // FIXME:???
 50:     // To send email to multiple users simultaneously, we would need to move
 51:     // the notify functionality to the handler class.  BUT, some of the tags
 52:     // are user-dependent, so every email msg will be unique.  (Unless maybe use
 53:     // smarty for email templates in the future.)  Also we would have to keep
 54:     // track if each user wanted email or PM.
 55: 
 56:     /**
 57:      * Send a notification message to the user
 58:      *
 59:      * @param string $template_dir Template directory
 60:      * @param string $template     Template name
 61:      * @param string $subject      Subject line for notification message
 62:      * @param array  $tags         Array of substitutions for template variables
 63:      *
 64:      * @return bool true if success, false if error
 65:      **/
 66:     public function notifyUser($template_dir, $template, $subject, $tags)
 67:     {
 68:         //todo fix this for mail module
 69:         $xoops = xoops::getInstance();
 70:         $helper = Notifications::getInstance();
 71: 
 72:         // Check the user's notification preference.
 73:         $member_handler = $xoops->getHandlerMember();
 74:         $user = $member_handler->getUser($this->getVar('uid'));
 75:         if (!is_object($user)) {
 76:             return true;
 77:         }
 78:         //todo, remove this from user profile
 79:         $method = $user->getVar('notify_method');
 80: 
 81:         $xoopsMailer = $xoops->getMailer();
 82:         switch ($method) {
 83:             case NOTIFICATIONS_METHOD_PM:
 84:                 $xoopsMailer->usePM();
 85:                 //todo, is this config in core or in mail module?
 86:                 $xoopsMailer->setFromUser($member_handler->getUser($xoops->getConfig('fromuid')));
 87:                 foreach ($tags as $k => $v) {
 88:                     $xoopsMailer->assign($k, $v);
 89:                 }
 90:                 break;
 91:             case NOTIFICATIONS_METHOD_EMAIL:
 92:                 $xoopsMailer->useMail();
 93:                 foreach ($tags as $k => $v) {
 94:                     $xoopsMailer->assign($k, preg_replace("/&amp;/i", '&', $v));
 95:                 }
 96:                 break;
 97:             default:
 98:                 return true; // report error in user's profile??
 99:                 break;
100:         }
101: 
102:         // Set up the mailer
103:         $xoopsMailer->setTemplateDir($template_dir);
104:         $xoopsMailer->setTemplate($template);
105:         $xoopsMailer->setToUsers($user);
106:         //global $xoopsConfig;
107:         //$xoopsMailer->setFromEmail($xoopsConfig['adminmail']);
108:         //$xoopsMailer->setFromName($xoopsConfig['sitename']);
109:         $xoopsMailer->setSubject($subject);
110:         $success = $xoopsMailer->send();
111: 
112:         // If send-once-then-delete, delete notification
113:         // If send-once-then-wait, disable notification
114:         $notification_handler = $helper->getHandlerNotification();
115: 
116:         if ($this->getVar('mode') == NOTIFICATIONS_MODE_SENDONCETHENDELETE) {
117:             $notification_handler->delete($this);
118:             return $success;
119:         }
120: 
121:         if ($this->getVar('mode') == NOTIFICATIONS_MODE_SENDONCETHENWAIT) {
122:             $this->setVar('mode', NOTIFICATIONS_MODE_WAITFORLOGIN);
123:             $notification_handler->insert($this);
124:         }
125:         return $success;
126:     }
127: }
128: 
129: /**
130:  * XOOPS notification handler class.
131:  * This class is responsible for providing data access mechanisms to the data source
132:  * of XOOPS notification class objects.
133:  *
134:  * @package       Notifications
135:  * @author        Michael van Dam <mvandam@caltech.edu>
136:  * @copyright     copyright (c) 2000-2003 XOOPS.org
137:  */
138: class NotificationsNotificationHandler extends XoopsPersistableObjectHandler
139: {
140:     /**
141:      * Constructor
142:      *
143:      * @param Connection|null $db {@link Connection}
144:      */
145:     public function __construct(Connection $db = null)
146:     {
147:         parent::__construct($db, 'notifications', 'NotificationsNotification', 'id', 'itemid');
148:     }
149: 
150:     /**
151:      * Get some {@link NotificationsNotification}s
152:      *
153:      * @param CriteriaElement|null $criteria  criteria object
154:      * @param bool                 $id_as_key Use IDs as keys into the array?
155:      *
156:      * @return  array   Array of {@link NotificationsNotification} objects
157:      */
158:     public function getObjectsArray(CriteriaElement $criteria = null, $id_as_key = false)
159:     {
160:         $qb = $this->db2->createXoopsQueryBuilder()
161:             ->select('*')
162:             ->from($this->table, null);
163:         if (isset($criteria) && ($criteria instanceof CriteriaElement)) {
164:             $criteria->renderQb($qb);
165:         }
166:         $result = $qb->execute();
167:         $ret = array();
168:         if (!$result) {
169:             return $ret;
170:         }
171:         while ($myrow = $result->fetch(\PDO::FETCH_ASSOC)) {
172:             $notification = new NotificationsNotification();
173:             $notification->assignVars($myrow);
174:             if (!$id_as_key) {
175:                 $ret[] = $notification;
176:             } else {
177:                 $ret[$myrow['id']] = $notification;
178:             }
179:             unset($notification);
180:         }
181:         return $ret;
182:     }
183: 
184:     /**
185:      * getNotification
186:      *
187:      * @param int    $module_id module
188:      * @param string $category  category
189:      * @param int    $item_id   item
190:      * @param string $event     event
191:      * @param int    $user_id   user
192:      *
193:      * @return NotificationsNotification|bool
194:      *
195:      * @todo rename this
196:      * @todo Also, should we have get by module, get by category, etc...??
197:      */
198:     public function getNotification($module_id, $category, $item_id, $event, $user_id)
199:     {
200:         $criteria = new CriteriaCompo();
201:         $criteria->add(new Criteria('modid', (int)($module_id)));
202:         $criteria->add(new Criteria('category', $category));
203:         $criteria->add(new Criteria('itemid', (int)($item_id)));
204:         $criteria->add(new Criteria('event', $event));
205:         $criteria->add(new Criteria('uid', (int)($user_id)));
206:         $objects = $this->getObjectsArray($criteria);
207:         if (count($objects) == 1) {
208:             return $objects[0];
209:         }
210:         $inst = false;
211:         return $inst;
212:     }
213: 
214:     /**
215:      * Determine if a user is subscribed to a particular event in
216:      * a particular module.
217:      *
218:      * @param string $category  Category of notification event
219:      * @param int    $item_id   Item ID of notification event
220:      * @param string $event     Event
221:      * @param int    $module_id ID of module (default current module)
222:      * @param int    $user_id   ID of user (default current user)
223:      *
224:      * @return int  0 if not subscribe; non-zero if subscribed
225:      */
226:     public function isSubscribed($category, $item_id, $event, $module_id, $user_id)
227:     {
228:         $criteria = new CriteriaCompo();
229:         $criteria->add(new Criteria('modid', (int)($module_id)));
230:         $criteria->add(new Criteria('category', $category));
231:         $criteria->add(new Criteria('itemid', (int)($item_id)));
232:         $criteria->add(new Criteria('event', $event));
233:         $criteria->add(new Criteria('uid', (int)($user_id)));
234:         return $this->getCount($criteria);
235:     }
236: 
237:     /**
238:      * Subscribe for notification for an event(s)
239:      *
240:      * @param string $category  category of notification
241:      * @param int    $item_id   ID of the item
242:      * @param mixed  $events    event string or array of events
243:      * @param int    $mode      force a particular notification mode
244:      *                          (e.g. once_only) (default to current user preference)
245:      * @param int    $module_id ID of the module (default to current module)
246:      * @param int    $user_id   ID of the user (default to current user)
247:      *
248:      * @return bool
249:      *
250:      * @todo: how about a function to subscribe a whole group of users???
251:      *      e.g. if we want to add all moderators to be notified of subscription
252:      *      of new threads...
253:      */
254:     public function subscribe($category, $item_id, $events, $mode = null, $module_id = null, $user_id = null)
255:     {
256:         $xoops = Xoops::getInstance();
257:         if (!isset($user_id)) {
258:             if (!$xoops->isUser()) {
259:                 return false; // anonymous cannot subscribe
260:             } else {
261:                 $user_id = $xoops->user->getVar('uid');
262:             }
263:         }
264: 
265:         if (!isset($module_id)) {
266:             $module_id = $xoops->module->getVar('mid');
267:         }
268: 
269:         //todo, remove this from user profile
270:         if (!isset($mode)) {
271:             $user = new XoopsUser($user_id);
272:             $mode = $user->getVar('notify_mode');
273:         }
274: 
275:         if (!is_array($events)) {
276:             $events = array($events);
277:         }
278:         foreach ($events as $event) {
279:             if ($notification = $this->getNotification($module_id, $category, $item_id, $event, $user_id)) {
280:                 if ($notification->getVar('mode') != $mode) {
281:                     $this->updateByField($notification, 'mode', $mode);
282:                 }
283:             } else {
284:                 $notification = $this->create();
285:                 $notification->setVar('modid', $module_id);
286:                 $notification->setVar('category', $category);
287:                 $notification->setVar('itemid', $item_id);
288:                 $notification->setVar('uid', $user_id);
289:                 $notification->setVar('event', $event);
290:                 $notification->setVar('mode', $mode);
291:                 $this->insert($notification);
292:             }
293:         }
294:         return true;
295:     }
296: 
297:     /**
298:      * Get a list of notifications by user ID
299:      *
300:      * @param int $user_id ID of the user
301:      *
302:      * @return array Array of {@link NotificationsNotification} objects
303:      *
304:      * @todo this will be to provide a list of everything a particular
305:      *       user has subscribed to... e.g. for on the 'Profile' page, similar
306:      *       to how we see the various posts etc. that the user has made.
307:      *       We may also want to have a function where we can specify module id
308:      **/
309:     public function getByUser($user_id)
310:     {
311:         $criteria = new Criteria('uid', $user_id);
312:         return $this->getObjectsArray($criteria, true);
313:     }
314: 
315:     /**
316:      * Get a list of notification events for the current item/mod/user
317:      *
318:      * @param string $category  caategory
319:      * @param int    $item_id   id
320:      * @param int    $module_id module
321:      * @param int    $user_id   user
322:      *
323:      * @return array
324:      *
325:      * @todo rename this?
326:      */
327:     public function getSubscribedEvents($category, $item_id, $module_id, $user_id)
328:     {
329:         $criteria = new CriteriaCompo();
330:         $criteria->add(new Criteria('modid', (int)($module_id)));
331:         $criteria->add(new Criteria('category', $category));
332:         if ($item_id) {
333:             $criteria->add(new Criteria('itemid', (int)($item_id)));
334:         }
335:         $criteria->add(new Criteria('uid', (int)($user_id)));
336:         $results = $this->getObjectsArray($criteria, true);
337:         $ret = array();
338:         /* @var NotificationsNotification $result*/
339:         foreach ($results as $result) {
340:             $ret[] = $result->getVar('event');
341:         }
342:         return $ret;
343:     }
344: 
345:     /**
346:      * Retrieve items by their ID
347:      *
348:      * @param int    $module_id Module ID
349:      * @param int    $item_id   Item ID
350:      * @param string $order     Sort order
351:      * @param int    $status    status
352:      *
353:      * @return  array   Array of {@link NotificationsNotification} objects
354:      *
355:      * @todo is this a useful function?? (Copied from comment_handler)
356:      */
357:     public function getByItemId($module_id, $item_id, $order = null, $status = null)
358:     {
359:         $criteria = new CriteriaCompo(new Criteria('modid', (int)($module_id)));
360:         $criteria->add(new Criteria('itemid', (int)($item_id)));
361:         if (isset($status)) {
362:             $criteria->add(new Criteria('status', (int)($status)));
363:         }
364:         if (isset($order)) {
365:             $criteria->setOrder($order);
366:         }
367:         return $this->getObjectsArray($criteria);
368:     }
369: 
370:     /**
371:      * Send notifications to users
372:      *
373:      * @param string $category     notification category
374:      * @param int    $item_id      ID of the item
375:      * @param string $events       notification event
376:      * @param array  $extra_tags   array of substitutions for template to be
377:      *                             merged with the one from function..
378:      * @param array  $user_list    only notify the selected users
379:      * @param int    $module_id    ID of the module
380:      * @param int    $omit_user_id ID of the user to omit from notifications. (default to
381:      *                              current user).  set to 0 for all users to receive notification.
382:      *
383:      * @return void
384:      *
385:      * @todo(?) - pass in an event LIST.  This will help to avoid
386:      *      problem of sending people multiple emails for similar events.
387:      *      BUT, then we need an array of mail templates, etc...  Unless
388:      *      mail templates can include logic in the future, then we can
389:      *      tailor the mail so it makes sense for any of the possible
390:      *      (or combination of) events.
391:      */
392:     public function triggerEvents(
393:         $category,
394:         $item_id,
395:         $events,
396:         $extra_tags = array(),
397:         $user_list = array(),
398:         $module_id = null,
399:         $omit_user_id = null
400:     ) {
401:         if (!is_array($events)) {
402:             $events = array($events);
403:         }
404:         foreach ($events as $event) {
405:             $this->triggerEvent($category, $item_id, $event, $extra_tags, $user_list, $module_id, $omit_user_id);
406:         }
407:     }
408: 
409:     /**
410:      * triggerEvent
411:      *
412:      * @param int   $category     notification category
413:      * @param int   $item_id      ID of the item
414:      * @param int   $event        notification event
415:      * @param array $extra_tags   array of substitutions for template
416:      * @param array $user_list    users to notify
417:      * @param int   $module_id    module
418:      * @param int   $omit_user_id users to not notify
419:      *
420:      * @return bool
421:      */
422:     public function triggerEvent(
423:         $category,
424:         $item_id,
425:         $event,
426:         $extra_tags = array(),
427:         $user_list = array(),
428:         $module_id = null,
429:         $omit_user_id = null
430:     ) {
431:         $xoops = xoops::getInstance();
432:         $helper = Notifications::getInstance();
433: 
434:         if (!isset($module_id)) {
435:             $module = $xoops->module;
436:             $module_id = $xoops->isModule() ? $xoops->module->getVar('mid') : 0;
437:         } else {
438:             $module = $xoops->getHandlerModule()->get($module_id);
439:         }
440: 
441:         // Check if event is enabled
442:         $mod_config = $xoops->getHandlerConfig()->getConfigsByModule($module->getVar('mid'));
443:         if (empty($mod_config['notifications_enabled'])) {
444:             return false;
445:         }
446:         $category_info = $helper->getCategory($category, $module->getVar('dirname'));
447:         $event_info = $helper->getEvent($category, $event, $module->getVar('dirname'));
448:         if (!in_array(
449:             $helper->generateConfig($category_info, $event_info, 'option_name'),
450:             $mod_config['notification_events']
451:         ) && empty($event_info['invisible'])) {
452:             return false;
453:         }
454: 
455:         if (!isset($omit_user_id)) {
456:             if ($xoops->isUser()) {
457:                 $omit_user_id = $xoops->user->getVar('uid');
458:             } else {
459:                 $omit_user_id = 0;
460:             }
461:         }
462:         $criteria = new CriteriaCompo();
463:         $criteria->add(new Criteria('modid', (int)($module_id)));
464:         $criteria->add(new Criteria('category', $category));
465:         $criteria->add(new Criteria('itemid', (int)($item_id)));
466:         $criteria->add(new Criteria('event', $event));
467:         $mode_criteria = new CriteriaCompo();
468:         $mode_criteria->add(new Criteria('mode', NOTIFICATIONS_MODE_SENDALWAYS), 'OR');
469:         $mode_criteria->add(new Criteria('mode', NOTIFICATIONS_MODE_SENDONCETHENDELETE), 'OR');
470:         $mode_criteria->add(new Criteria('mode', NOTIFICATIONS_MODE_SENDONCETHENWAIT), 'OR');
471:         $criteria->add($mode_criteria);
472:         if (!empty($user_list)) {
473:             $user_criteria = new CriteriaCompo();
474:             foreach ($user_list as $user) {
475:                 $user_criteria->add(new Criteria('uid', (int)($user)), 'OR');
476:             }
477:             $criteria->add($user_criteria);
478:         }
479:         $notifications = $this->getObjectsArray($criteria);
480:         if (empty($notifications)) {
481:             return false;
482:         }
483: 
484:         $item_info = $helper->getEvent($category, $item_id, $module->getVar('dirname'));
485: 
486:         // Add some tag substitutions here
487:         $tags = $helper->getTags($category, $item_id, $event, $module->getVar('dirname'));
488: 
489:         $tags['X_ITEM_NAME']
490:             = !empty($item_info['name']) ? $item_info['name'] : '[' . _MD_NOTIFICATIONS_ITEMNAMENOTAVAILABLE . ']';
491:         $tags['X_ITEM_URL']
492:             = !empty($item_info['url']) ? $item_info['url'] : '[' . _MD_NOTIFICATIONS_ITEMURLNOTAVAILABLE . ']';
493:         $tags['X_ITEM_TYPE']
494:             = !empty($category_info['item_name']) ? $category_info['title'] : '['
495:             . _MD_NOTIFICATIONS_ITEMTYPENOTAVAILABLE . ']';
496:         $tags['X_MODULE'] = $module->getVar('name');
497:         $tags['X_MODULE_URL'] = \XoopsBaseConfig::get('url') . '/modules/' . $module->getVar('dirname') . '/';
498:         $tags['X_NOTIFY_CATEGORY'] = $category;
499:         $tags['X_NOTIFY_EVENT'] = $event;
500: 
501:         $template_dir = $event_info['mail_template_dir'];
502:         $template = $event_info['mail_template'] . '.tpl';
503:         $subject = $event_info['mail_subject'];
504: 
505:         foreach ($notifications as $notification) {
506:             /* @var $notification NotificationsNotification */
507:             if (empty($omit_user_id) || $notification->getVar('uid') != $omit_user_id) {
508:                 // user-specific tags
509:                 //$tags['X_UNSUBSCRIBE_URL'] = 'TODO';
510:                 // TODO: don't show unsubscribe link if it is 'one-time' ??
511:                 $tags['X_UNSUBSCRIBE_URL'] = $helper->url('index.php');
512:                 $tags = array_merge($tags, $extra_tags);
513:                 $notification->notifyUser($template_dir, $template, $subject, $tags);
514:             }
515:         }
516:         return true;
517:     }
518: 
519:     /**
520:      * Delete all notifications for one user
521:      *
522:      * @param int $user_id ID of the user
523:      *
524:      * @return  bool
525:      **/
526:     public function unsubscribeByUser($user_id)
527:     {
528:         $criteria = new Criteria('uid', (int)($user_id));
529:         return $this->deleteAll($criteria);
530:     }
531: 
532:     /**
533:      * Unsubscribe notifications for an event(s).
534:      *
535:      * @param string $category  category of the events
536:      * @param int    $item_id   ID of the item
537:      * @param mixed  $events    event string or array of events
538:      * @param int    $module_id ID of the module (default current module)
539:      * @param int    $user_id   UID of the user (default current user)
540:      *
541:      * @return bool
542:      *
543:      * @todo allow these to use current module, etc...
544:      */
545:     public function unsubscribe($category, $item_id, $events, $module_id = null, $user_id = null)
546:     {
547:         $xoops = Xoops::getInstance();
548:         if (!isset($user_id)) {
549:             if (!$xoops->isUser()) {
550:                 return false; // anonymous cannot subscribe
551:             } else {
552:                 $user_id = $xoops->user->getVar('uid');
553:             }
554:         }
555:         if (!isset($module_id)) {
556:             $module_id = $xoops->module->getVar('mid');
557:         }
558:         $criteria = new CriteriaCompo();
559:         $criteria->add(new Criteria('modid', (int)($module_id)));
560:         $criteria->add(new Criteria('category', $category));
561:         $criteria->add(new Criteria('itemid', (int)($item_id)));
562:         $criteria->add(new Criteria('uid', (int)($user_id)));
563:         if (!is_array($events)) {
564:             $events = array($events);
565:         }
566:         $event_criteria = new CriteriaCompo();
567:         foreach ($events as $event) {
568:             $event_criteria->add(new Criteria('event', $event), 'OR');
569:         }
570:         $criteria->add($event_criteria);
571:         return $this->deleteAll($criteria);
572:     }
573: 
574:     /**
575:      * Delete all notifications for a particular module
576:      *
577:      * @param int $module_id ID of the module
578:      *
579:      * @return  bool
580:      *
581:      * @todo When 'update' a module, may need to switch around some
582:      **/
583:     public function unsubscribeByModule($module_id)
584:     {
585:         $criteria = new Criteria('modid', (int)($module_id));
586:         return $this->deleteAll($criteria);
587:     }
588: 
589:     /**
590:      * Delete all subscriptions for a particular item.
591:      *
592:      * @param int    $module_id ID of the module to which item belongs
593:      * @param string $category  Notification category of the item
594:      * @param int    $item_id   ID of the item
595:      *
596:      * @return bool
597:      **/
598:     public function unsubscribeByItem($module_id, $category, $item_id)
599:     {
600:         $criteria = new CriteriaCompo();
601:         $criteria->add(new Criteria('modid', (int)($module_id)));
602:         $criteria->add(new Criteria('category', $category));
603:         $criteria->add(new Criteria('itemid', (int)($item_id)));
604:         return $this->deleteAll($criteria);
605:     }
606: 
607:     /**
608:      * Perform notification maintenance activites at login time.
609:      * In particular, any notifications for the newly logged-in
610:      * user with mode NOTIFICATIONS_MODE_WAITFORLOGIN are
611:      * switched to mode NOTIFICATIONS_MODE_SENDONCETHENWAIT.
612:      *
613:      * @param int $user_id ID of the user being logged in
614:      *
615:      * @return void
616:      **/
617:     public function doLoginMaintenance($user_id)
618:     {
619:         $criteria = new CriteriaCompo();
620:         $criteria->add(new Criteria('uid', (int)($user_id)));
621:         $criteria->add(new Criteria('mode', NOTIFICATIONS_MODE_WAITFORLOGIN));
622: 
623:         $notifications = $this->getObjectsArray($criteria, true);
624:         foreach ($notifications as $n) {
625:             /* @var $n NotificationsNotification */
626:             $n->setVar('mode', NOTIFICATIONS_MODE_SENDONCETHENWAIT);
627:             $this->insert($n);
628:         }
629:     }
630: 
631:     /**
632:      * Update
633:      *
634:      * @param NotificationsNotification $notification {@link NotificationsNotification} object
635:      * @param string                    $field_name   Name of the field
636:      * @param mixed                     $field_value  Value to write
637:      *
638:      * @return bool
639:      **/
640:     public function updateByField(NotificationsNotification $notification, $field_name, $field_value)
641:     {
642:         $notification->unsetNew();
643:         $notification->setVar($field_name, $field_value);
644:         return $this->insert($notification);
645:     }
646: }
647: 
API documentation generated by ApiGen