You are viewing an old version of this page. Return to the latest version.
Difference between revisions of "AutoDoc:BlueSpiceEchoConnector"
m (1 revision imported) |
hw>Unknown user |
Contents
DescriptionMsg[edit source]
Connects BlueSpice with Echo
License[edit source]
GPL-3.0-only
Requirements[edit source]
- MediaWiki: ~11.31
- BlueSpiceFoundation: ~33.2
Echo: *
IntegratesInto[edit source]
- BlueSpiceFoundation
- BlueSpiceEchoConnector
Config[edit source]
Configuration[edit source]
Name | Value |
---|---|
EchoHtmlMailTemplatePath | '/templates' |
EchoHtmlMailTemplateNames | array ( 'single' => 'SingleMail', 'digest' => 'Digest', 'primary_link' => 'PrimaryLink', 'secondary_link' => 'SecondaryLink', 'digest_list' => 'DigestList', ) |
UseJobQueueForNotifications | false |
ForceJobQueueForLargeAudienceThreshold | 499 |
EchoEmailFormatterClasses | array ( 'plain-text' => 'BlueSpice\\EchoConnector\\Formatter\\EchoPlainTextEmailFormatter', 'plain-text-digest' => 'BlueSpice\\EchoConnector\\Formatter\\EchoPlainTextDigestEmailFormatter', 'html' => 'BlueSpice\\EchoConnector\\Formatter\\EchoHTMLEmailFormatter', 'html-digest' => 'BlueSpice\\EchoConnector\\Formatter\\EchoHtmlDigestEmailFormatter', ) |
EchoHtmlMailTemplateNames | array ( 'single' => 'SingleMail', 'digest' => 'Digest', 'primary_link' => 'PrimaryLink', 'secondary_link' => 'SecondaryLink', 'digest_list' => 'DigestList', ) |
EchoHtmlMailTemplatePath | '/templates' |
ForceJobQueueForLargeAudienceThreshold | 499 |
UseJobQueueForNotifications | false |
Hooks[edit source]
Hooks[edit source]
- ArticleDeleteCompleteTitleMoveComplete
- BSUserManagerAfterAddUserPageContentSaveComplete
- EchoGetBundleRules
- BSUserManagerAfterAddUser
- EchoGetNotificationTypesEchoGetBundleRules
- GetPreferences
- LocalUserCreatedGetPreferences
- PageContentSaveComplete
- TitleMoveComplete
==DescriptionMsg== {{AutoDocDescriptionMsg |name = BlueSpiceEchoConnector |desc = {{int:bs-echoconnector-extension-description }} }} ==License== {{AutoDocLicense |name = GPL-3.0-only }} ==Requirements== {{AutoDocRequirements |mediawiki = {{AutoDocVersion |name = MediaWiki |version = ~11.31 }} |extensions = {{AutoDocVersion |name = BlueSpiceFoundation |version = ~33.2 }} {{AutoDocVersion |name = Echo |version = * }} }} ==IntegratesInto== {{AutoDocIntegratesInto |into = {{AutoDocListItem |item = BlueSpiceFoundation }} {{AutoDocListItem |item = BlueSpiceEchoConnector }} }} ==Config== {{AutoDocConfig |config = {{AutoDocOption |name = EchoHtmlMailTemplatePathEchoEmailFormatterClasses |value = <nowiki>'/templates'array ( 'plain-text' => 'BlueSpice\\EchoConnector\\Formatter\\EchoPlainTextEmailFormatter', 'plain-text-digest' => 'BlueSpice\\EchoConnector\\Formatter\\EchoPlainTextDigestEmailFormatter', 'html' => 'BlueSpice\\EchoConnector\\Formatter\\EchoHTMLEmailFormatter', 'html-digest' => 'BlueSpice\\EchoConnector\\Formatter\\EchoHtmlDigestEmailFormatter', )</nowiki> }} {{AutoDocOption |name = EchoHtmlMailTemplateNames |value = <nowiki>array ( 'single' => 'SingleMail', 'digest' => 'Digest', 'primary_link' => 'PrimaryLink', 'secondary_link' => 'SecondaryLink', 'digest_list' => 'DigestList', )</nowiki> }} {{AutoDocOption |name = UseJobQueueForNotificationsEchoHtmlMailTemplatePath |value = <nowiki>false'/templates'</nowiki> }} {{AutoDocOption |name = ForceJobQueueForLargeAudienceThreshold |value = <nowiki>499</nowiki> }} {{AutoDocOption |name = EchoEmailFormatterClassesUseJobQueueForNotifications |value = <nowiki>array ( 'plain-text' => 'BlueSpice\\EchoConnector\\Formatter\\EchoPlainTextEmailFormatter', 'plain-text-digest' => 'BlueSpice\\EchoConnector\\Formatter\\EchoPlainTextDigestEmailFormatter', 'html' => 'BlueSpice\\EchoConnector\\Formatter\\EchoHTMLEmailFormatter', 'html-digest' => 'BlueSpice\\EchoConnector\\Formatter\\EchoHtmlDigestEmailFormatter', )false</nowiki> }} }} ==Hooks== {{AutoDocHooks |Hooks = {{AutoDocCallback |name = ArticleDeleteComplete [https://www.mediawiki.org/wiki/Manual:Hooks/ArticleDeleteComplete ArticleDeleteComplete] |callback = \BlueSpice\EchoConnector\Hook\ArticleDeleteComplete\NotifyUsers::callback }} {{AutoDocCallback |name = TitleMoveComplete [https://www.mediawiki.org/wiki/Manual:Hooks/BSUserManagerAfterAddUser BSUserManagerAfterAddUser] |callback = \BlueSpice\EchoConnector\Hook\TitleMoveCompleteBSUserManagerAfterAddUser\NotifyUsers::callback }} {{AutoDocCallback |name = PageContentSaveComplete [https://www.mediawiki.org/wiki/Manual:Hooks/EchoGetBundleRules EchoGetBundleRules] |callback = \BlueSpice\EchoConnector\Hook\PageContentSaveComplete\NotifyUsersEchoGetBundleRules\GetBundleRules::callback }} {{AutoDocCallback |name = BSUserManagerAfterAddUser [https://www.mediawiki.org/wiki/Manual:Hooks/EchoGetNotificationTypes EchoGetNotificationTypes] |callback = \BlueSpice\EchoConnector\Hook\BSUserManagerAfterAddUser\NotifyUsersEchoGetNotificationTypes\GetNotificationTypesForEvent::callback }} {{AutoDocCallback |name = EchoGetNotificationTypes [https://www.mediawiki.org/wiki/Manual:Hooks/GetPreferences GetPreferences] |callback = \BlueSpice\EchoConnector\Hook\EchoGetNotificationTypes\GetNotificationTypesForEventGetPreferences\AddNotificationMatrix::callback }} {{AutoDocCallback |name = EchoGetBundleRules [https://www.mediawiki.org/wiki/Manual:Hooks/LocalUserCreated LocalUserCreated] |callback = \BlueSpice\EchoConnector\Hook\EchoGetBundleRules\GetBundleRulesLocalUserCreated\NotifyUsers::callback }} {{AutoDocCallback |name = LocalUserCreated [https://www.mediawiki.org/wiki/Manual:Hooks/PageContentSaveComplete PageContentSaveComplete] |callback = \BlueSpice\EchoConnector\Hook\LocalUserCreatedPageContentSaveComplete\NotifyUsers::callback }} {{AutoDocCallback |name = GetPreferences [https://www.mediawiki.org/wiki/Manual:Hooks/TitleMoveComplete TitleMoveComplete] |callback = \BlueSpice\EchoConnector\Hook\GetPreferences\AddNotificationMatrixTitleMoveComplete\NotifyUsers::callback }} }}
Line 4: | Line 4: | ||
|desc = {{int:bs-echoconnector-extension-description | |desc = {{int:bs-echoconnector-extension-description | ||
}} | }} | ||
+ | }} | ||
+ | ==License== | ||
+ | {{AutoDocLicense | ||
+ | |name = GPL-3.0-only | ||
}} | }} | ||
==Requirements== | ==Requirements== | ||
Line 9: | Line 13: | ||
|mediawiki = {{AutoDocVersion | |mediawiki = {{AutoDocVersion | ||
|name = MediaWiki | |name = MediaWiki | ||
− | |version = | + | |version = 1.31 |
}} | }} | ||
|extensions = {{AutoDocVersion | |extensions = {{AutoDocVersion | ||
|name = BlueSpiceFoundation | |name = BlueSpiceFoundation | ||
− | |version = | + | |version = 3.2 |
}} | }} | ||
{{AutoDocVersion | {{AutoDocVersion | ||
Line 24: | Line 28: | ||
{{AutoDocIntegratesInto | {{AutoDocIntegratesInto | ||
|into = {{AutoDocListItem | |into = {{AutoDocListItem | ||
− | |||
− | |||
− | |||
|item = BlueSpiceEchoConnector | |item = BlueSpiceEchoConnector | ||
}} | }} | ||
Line 33: | Line 34: | ||
{{AutoDocConfig | {{AutoDocConfig | ||
|config = {{AutoDocOption | |config = {{AutoDocOption | ||
− | |name = | + | |name = EchoEmailFormatterClasses |
− | |value = <nowiki>' | + | |value = <nowiki>array ( |
+ | 'plain-text' => 'BlueSpice\\EchoConnector\\Formatter\\EchoPlainTextEmailFormatter', | ||
+ | 'plain-text-digest' => 'BlueSpice\\EchoConnector\\Formatter\\EchoPlainTextDigestEmailFormatter', | ||
+ | 'html' => 'BlueSpice\\EchoConnector\\Formatter\\EchoHTMLEmailFormatter', | ||
+ | 'html-digest' => 'BlueSpice\\EchoConnector\\Formatter\\EchoHtmlDigestEmailFormatter', | ||
+ | )</nowiki> | ||
}} | }} | ||
{{AutoDocOption | {{AutoDocOption | ||
Line 47: | Line 53: | ||
}} | }} | ||
{{AutoDocOption | {{AutoDocOption | ||
− | |name = | + | |name = EchoHtmlMailTemplatePath |
− | |value = <nowiki> | + | |value = <nowiki>'/templates'</nowiki> |
}} | }} | ||
{{AutoDocOption | {{AutoDocOption | ||
Line 55: | Line 61: | ||
}} | }} | ||
{{AutoDocOption | {{AutoDocOption | ||
− | |name = | + | |name = UseJobQueueForNotifications |
− | |value = <nowiki> | + | |value = <nowiki>false</nowiki> |
− | |||
− | |||
− | |||
− | |||
− | |||
}} | }} | ||
}} | }} | ||
Line 67: | Line 68: | ||
{{AutoDocHooks | {{AutoDocHooks | ||
|Hooks = {{AutoDocCallback | |Hooks = {{AutoDocCallback | ||
− | |name = ArticleDeleteComplete | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/ArticleDeleteComplete ArticleDeleteComplete] |
|callback = \BlueSpice\EchoConnector\Hook\ArticleDeleteComplete\NotifyUsers::callback | |callback = \BlueSpice\EchoConnector\Hook\ArticleDeleteComplete\NotifyUsers::callback | ||
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
− | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSUserManagerAfterAddUser BSUserManagerAfterAddUser] |
− | |callback = \BlueSpice\EchoConnector\Hook\ | + | |callback = \BlueSpice\EchoConnector\Hook\BSUserManagerAfterAddUser\NotifyUsers::callback |
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
− | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/EchoGetBundleRules EchoGetBundleRules] |
− | |callback = \BlueSpice\EchoConnector\Hook\ | + | |callback = \BlueSpice\EchoConnector\Hook\EchoGetBundleRules\GetBundleRules::callback |
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
− | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/EchoGetNotificationTypes EchoGetNotificationTypes] |
− | |callback = \BlueSpice\EchoConnector\Hook\ | + | |callback = \BlueSpice\EchoConnector\Hook\EchoGetNotificationTypes\GetNotificationTypesForEvent::callback |
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
− | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/GetPreferences GetPreferences] |
− | |callback = \BlueSpice\EchoConnector\Hook\ | + | |callback = \BlueSpice\EchoConnector\Hook\GetPreferences\AddNotificationMatrix::callback |
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
− | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/LocalUserCreated LocalUserCreated] |
− | |callback = \BlueSpice\EchoConnector\Hook\ | + | |callback = \BlueSpice\EchoConnector\Hook\LocalUserCreated\NotifyUsers::callback |
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
− | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/PageContentSaveComplete PageContentSaveComplete] |
− | |callback = \BlueSpice\EchoConnector\Hook\ | + | |callback = \BlueSpice\EchoConnector\Hook\PageContentSaveComplete\NotifyUsers::callback |
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
− | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/TitleMoveComplete TitleMoveComplete] |
− | |callback = \BlueSpice\EchoConnector\Hook\ | + | |callback = \BlueSpice\EchoConnector\Hook\TitleMoveComplete\NotifyUsers::callback |
}} | }} | ||
}} | }} |