You are viewing an old version of this page. Return to the latest version.
Difference between revisions of "AutoDoc:BlueSpicePrivacy"
m (1 revision imported) |
hw>Unknown user |
Contents
DescriptionMsg[edit source]
Management page for user privacy settings
License[edit source]
GPL-3.0-only
Requirements[edit source]
- MediaWiki: ~11.31
- BlueSpiceFoundation: ~33.2
IntegratesInto[edit source]
- BlueSpiceFoundation
- BlueSpicePrivacy
SpecialPages[edit source]
- PrivacyAdmin
- PrivacyCenterPrivacyAdmin
- PrivacyConsent
Permissions[edit source]
Permissions
| Name | Description | Role |
|---|---|---|
| bs-privacy-admin | Execute Privacy administrative action | admin, accountmanager |
Config[edit source]
Configuration[edit source]
| Name | Value | |
|---|---|---|
| PrivacyEnableRequests | true | |
| PrivacyDeleteUsername | 'DeletedUser' | |
| PrivacyRequestDeadline | 30 | |
| PrivacyConsentTypes | array ( 'privacy-policy' => 'bs-privacy-prefs-consent-privacy-policy', 'terms-of-service' => 'bs-privacy-prefs-consent-tos', ) | |
| PrivacyCookieAcceptMandatory | true | |
| PrivacyCookieConsentProvider | 'native-mw' | |
| PrivacyCookieAcceptMandatory | PrivacyDeleteUsername | 'DeletedUser' |
| PrivacyEnableRequests | true | |
| PrivacyPrivacyPolicyMandatory | false | |
| PrivacyRequestDeadline | 30 |
ApiModules[edit source]
API Modules[edit source]
- bs-privacy
- bs-privacy-get-requestsall-consents
- bs-privacy-get-all-consentsrequests
Hooks[edit source]
Hooks[edit source]
- PersonalUrlsBeforePageDisplay
- GetPreferences
- LoadExtensionSchemaUpdatesGetPreferences
- OutputPageParserOutputBeforePageDisplay
- PersonalUrls
- SkinTemplateOutputPageBeforeExec
- SpecialPageBeforeExecute
- WebResponseSetCookie
- SkinTemplateOutputPageBeforeExec
==DescriptionMsg==
{{AutoDocDescriptionMsg
|name = BlueSpicePrivacy
|desc = {{int:bs-privacy-desc
}}
}}
==License==
{{AutoDocLicense
|name = GPL-3.0-only
}}
==Requirements==
{{AutoDocRequirements
|mediawiki = {{AutoDocVersion
|name = MediaWiki
|version = ~11.31
}}
|extensions = {{AutoDocVersion
|name = BlueSpiceFoundation
|version = ~33.2
}}
}}
==IntegratesInto==
{{AutoDocIntegratesInto
|into = {{AutoDocListItem
|item = BlueSpiceFoundation
}}
{{AutoDocListItem
|item = BlueSpicePrivacy
}}
}}
==SpecialPages==
{{AutoDocSpecialPages
|SpecialPages = {{AutoDocCallback
|name = PrivacyAdmin
|callback = \BlueSpice\Privacy\Special\PrivacyAdmin
}}
{{AutoDocCallback
|name = PrivacyCenter
|callback = \BlueSpice\Privacy\Special\PrivacyCenter
}}
{{AutoDocCallback
|name = PrivacyAdminPrivacyConsent
|callback = \BlueSpice\Privacy\Special\PrivacyAdminPrivacyConsent
}}
}}
==Permissions==
{{AutoDocPermissions
|permissions = {{AutoDocPermission
|name = bs-privacy-admin
|type = global
|roles = admin, accountmanager
|desc = {{int:right-bs-privacy-admin
}}
}}
}}
==Config==
{{AutoDocConfig
|config = {{AutoDocOption
|name = PrivacyEnableRequests
|value = <nowiki>true</nowiki>
}}
{{AutoDocOption
|name = PrivacyDeleteUsername
|value = <nowiki>'DeletedUser'</nowiki>
}}
{{AutoDocOption
|name = PrivacyRequestDeadline
|value = <nowiki>30</nowiki>
}}
{{AutoDocOption
|name = PrivacyConsentTypes
|value = <nowiki>array (
'privacy-policy' => 'bs-privacy-prefs-consent-privacy-policy',
'terms-of-service' => 'bs-privacy-prefs-consent-tos',
)</nowiki>
}}
{{AutoDocOption
|name = PrivacyCookieAcceptMandatory
|value = <nowiki>true</nowiki>
}}
{{AutoDocOption
|name = PrivacyCookieConsentProvider
|value = <nowiki>'native-mw'</nowiki>
}}
{{AutoDocOption
|name = PrivacyCookieAcceptMandatoryPrivacyDeleteUsername
|value = <nowiki>'DeletedUser'</nowiki>
}}
{{AutoDocOption
|name = PrivacyEnableRequests
|value = <nowiki>true</nowiki>
}}
{{AutoDocOption
|name = PrivacyPrivacyPolicyMandatory
|value = <nowiki>false</nowiki>
}}
}}
{{AutoDocOption
|name = PrivacyRequestDeadline
|value = <nowiki>30</nowiki>
}}
}}
==ApiModules==
{{AutoDocApiModules
|APIModules = {{AutoDocCallback
|name = bs-privacy
|callback = \BlueSpice\Privacy\Api\PrivacyApi
}}
{{AutoDocCallback
|name = bs-privacy-get-requestsall-consents
|callback = \BlueSpice\Privacy\Api\GetRequestsGetAllConsents
}}
{{AutoDocCallback
|name = bs-privacy-get-all-consentsrequests
|callback = \BlueSpice\Privacy\Api\GetAllConsentsGetRequests
}}
}}
==Hooks==
{{AutoDocHooks
|Hooks = {{AutoDocCallback
|name = PersonalUrls
[https://www.mediawiki.org/wiki/Manual:Hooks/BeforePageDisplay BeforePageDisplay]
|callback = \BlueSpice\Privacy\Hook\PersonalUrls\AddPrivacyUrlsBeforePageDisplay\AddCookieConsent::callback
}}
{{AutoDocCallback
|name = LoadExtensionSchemaUpdates
[https://www.mediawiki.org/wiki/Manual:Hooks/GetPreferences GetPreferences]
|callback = \BlueSpice\Privacy\Hook\LoadExtensionSchemaUpdates\AddPrivacyRequestTableGetPreferences\AddConsentPrefs::callback
}}
{{AutoDocCallback
|name = GetPreferences
[https://www.mediawiki.org/wiki/Manual:Hooks/LoadExtensionSchemaUpdates LoadExtensionSchemaUpdates]
|callback = \BlueSpice\Privacy\Hook\GetPreferences\AddConsentPrefsLoadExtensionSchemaUpdates\AddPrivacyRequestTable::callback
}}
{{AutoDocCallback
|name = BeforePageDisplay
[https://www.mediawiki.org/wiki/Manual:Hooks/OutputPageParserOutput OutputPageParserOutput]
|callback = \BlueSpice\Privacy\Hook\BeforePageDisplay\AddCookieConsentOutputPageParserOutput\RedirectToConsent::callback
}}
{{AutoDocCallback
|name = WebResponseSetCookie
[https://www.mediawiki.org/wiki/Manual:Hooks/PersonalUrls PersonalUrls]
|callback = \BlueSpice\Privacy\Hook\WebResponseSetCookie\BlockCookiePersonalUrls\AddPrivacyUrls::callback
}}
{{AutoDocCallback
|name = SkinTemplateOutputPageBeforeExec
[https://www.mediawiki.org/wiki/Manual:Hooks/SkinTemplateOutputPageBeforeExec SkinTemplateOutputPageBeforeExec]
|callback = \BlueSpice\Privacy\Hook\SkinTemplateOutputPageBeforeExec\AddCookieConsentFooterLink::callback
}}
}}{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/SpecialPageBeforeExecute SpecialPageBeforeExecute]
|callback = \BlueSpice\Privacy\Hook\SpecialPageBeforeExecute\RedirectToConsent::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/WebResponseSetCookie WebResponseSetCookie]
|callback = \BlueSpice\Privacy\Hook\WebResponseSetCookie\BlockCookie::callback
}}
}}| Line 4: | Line 4: | ||
|desc = {{int:bs-privacy-desc | |desc = {{int:bs-privacy-desc | ||
}} | }} | ||
| + | }} | ||
| + | ==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 |
}} | }} | ||
}} | }} | ||
| Line 19: | Line 23: | ||
{{AutoDocIntegratesInto | {{AutoDocIntegratesInto | ||
|into = {{AutoDocListItem | |into = {{AutoDocListItem | ||
| − | |||
| − | |||
| − | |||
|item = BlueSpicePrivacy | |item = BlueSpicePrivacy | ||
}} | }} | ||
| Line 28: | Line 29: | ||
{{AutoDocSpecialPages | {{AutoDocSpecialPages | ||
|SpecialPages = {{AutoDocCallback | |SpecialPages = {{AutoDocCallback | ||
| + | |name = PrivacyAdmin | ||
| + | |callback = \BlueSpice\Privacy\Special\PrivacyAdmin | ||
| + | }} | ||
| + | {{AutoDocCallback | ||
|name = PrivacyCenter | |name = PrivacyCenter | ||
|callback = \BlueSpice\Privacy\Special\PrivacyCenter | |callback = \BlueSpice\Privacy\Special\PrivacyCenter | ||
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = | + | |name = PrivacyConsent |
| − | |callback = \BlueSpice\Privacy\Special\ | + | |callback = \BlueSpice\Privacy\Special\PrivacyConsent |
}} | }} | ||
}} | }} | ||
| Line 41: | Line 46: | ||
|name = bs-privacy-admin | |name = bs-privacy-admin | ||
|type = global | |type = global | ||
| − | |roles = admin,accountmanager | + | |roles = admin, accountmanager |
|desc = {{int:right-bs-privacy-admin | |desc = {{int:right-bs-privacy-admin | ||
}} | }} | ||
| Line 49: | Line 54: | ||
{{AutoDocConfig | {{AutoDocConfig | ||
|config = {{AutoDocOption | |config = {{AutoDocOption | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|name = PrivacyConsentTypes | |name = PrivacyConsentTypes | ||
|value = <nowiki>array ( | |value = <nowiki>array ( | ||
| Line 66: | Line 59: | ||
'terms-of-service' => 'bs-privacy-prefs-consent-tos', | 'terms-of-service' => 'bs-privacy-prefs-consent-tos', | ||
)</nowiki> | )</nowiki> | ||
| + | }} | ||
| + | {{AutoDocOption | ||
| + | |name = PrivacyCookieAcceptMandatory | ||
| + | |value = <nowiki>true</nowiki> | ||
}} | }} | ||
{{AutoDocOption | {{AutoDocOption | ||
| Line 72: | Line 69: | ||
}} | }} | ||
{{AutoDocOption | {{AutoDocOption | ||
| − | |name = | + | |name = PrivacyDeleteUsername |
| + | |value = <nowiki>'DeletedUser'</nowiki> | ||
| + | }} | ||
| + | {{AutoDocOption | ||
| + | |name = PrivacyEnableRequests | ||
|value = <nowiki>true</nowiki> | |value = <nowiki>true</nowiki> | ||
}} | }} | ||
| Line 78: | Line 79: | ||
|name = PrivacyPrivacyPolicyMandatory | |name = PrivacyPrivacyPolicyMandatory | ||
|value = <nowiki>false</nowiki> | |value = <nowiki>false</nowiki> | ||
| + | }} | ||
| + | {{AutoDocOption | ||
| + | |name = PrivacyRequestDeadline | ||
| + | |value = <nowiki>30</nowiki> | ||
}} | }} | ||
}} | }} | ||
| Line 85: | Line 90: | ||
|name = bs-privacy | |name = bs-privacy | ||
|callback = \BlueSpice\Privacy\Api\PrivacyApi | |callback = \BlueSpice\Privacy\Api\PrivacyApi | ||
| + | }} | ||
| + | {{AutoDocCallback | ||
| + | |name = bs-privacy-get-all-consents | ||
| + | |callback = \BlueSpice\Privacy\Api\GetAllConsents | ||
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
|name = bs-privacy-get-requests | |name = bs-privacy-get-requests | ||
|callback = \BlueSpice\Privacy\Api\GetRequests | |callback = \BlueSpice\Privacy\Api\GetRequests | ||
| − | |||
| − | |||
| − | |||
| − | |||
}} | }} | ||
}} | }} | ||
| Line 98: | Line 103: | ||
{{AutoDocHooks | {{AutoDocHooks | ||
|Hooks = {{AutoDocCallback | |Hooks = {{AutoDocCallback | ||
| − | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/BeforePageDisplay BeforePageDisplay] |
| − | |callback = \BlueSpice\Privacy\Hook\ | + | |callback = \BlueSpice\Privacy\Hook\BeforePageDisplay\AddCookieConsent::callback |
| + | }} | ||
| + | {{AutoDocCallback | ||
| + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/GetPreferences GetPreferences] | ||
| + | |callback = \BlueSpice\Privacy\Hook\GetPreferences\AddConsentPrefs::callback | ||
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = LoadExtensionSchemaUpdates | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/LoadExtensionSchemaUpdates LoadExtensionSchemaUpdates] |
|callback = \BlueSpice\Privacy\Hook\LoadExtensionSchemaUpdates\AddPrivacyRequestTable::callback | |callback = \BlueSpice\Privacy\Hook\LoadExtensionSchemaUpdates\AddPrivacyRequestTable::callback | ||
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/OutputPageParserOutput OutputPageParserOutput] |
| − | |callback = \BlueSpice\Privacy\Hook\ | + | |callback = \BlueSpice\Privacy\Hook\OutputPageParserOutput\RedirectToConsent::callback |
| + | }} | ||
| + | {{AutoDocCallback | ||
| + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/PersonalUrls PersonalUrls] | ||
| + | |callback = \BlueSpice\Privacy\Hook\PersonalUrls\AddPrivacyUrls::callback | ||
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/SkinTemplateOutputPageBeforeExec SkinTemplateOutputPageBeforeExec] |
| − | |callback = \BlueSpice\Privacy\Hook\ | + | |callback = \BlueSpice\Privacy\Hook\SkinTemplateOutputPageBeforeExec\AddCookieConsentFooterLink::callback |
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/SpecialPageBeforeExecute SpecialPageBeforeExecute] |
| − | |callback = \BlueSpice\Privacy\Hook\ | + | |callback = \BlueSpice\Privacy\Hook\SpecialPageBeforeExecute\RedirectToConsent::callback |
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/WebResponseSetCookie WebResponseSetCookie] |
| − | |callback = \BlueSpice\Privacy\Hook\ | + | |callback = \BlueSpice\Privacy\Hook\WebResponseSetCookie\BlockCookie::callback |
}} | }} | ||
}} | }} | ||