You are viewing an old version of this page. Return to the latest version.
Difference between revisions of "AutoDoc:BlueSpiceSocialProfile"
m (1 revision imported) |
hw>Unknown user |
Contents
DescriptionMsg[edit source]
Profile entity for BlueSpiceSocial
License[edit source]
GPL-3.0-only
Requirements[edit source]
- MediaWiki: ~11.31
- BlueSpiceFoundationBlueSpiceAvatars: ~33.2
BlueSpiceSocialBlueSpiceFoundation: ~33.2 BlueSpiceAvatarsBlueSpiceSocial: ~33.2
IntegratesInto[edit source]
- BlueSpiceFoundation
- BlueSpiceSocialProfile
- BlueSpicePrivacy
- BlueSpiceSMWConnector
- BlueSpiceSocialProfile
SpecialPages[edit source]
- SocialProfiles
Permissions[edit source]
Permissions
| Name | Description | Role |
|---|---|---|
| social-editothersprofile | Edit other users profile | admin, maintenanceadmin |
| socialprofile-viewspecialpage | View the special page "Profiles" | accountmanager, admin, author, bot, commenter, editor, maintenanceadmin, reader, reviewer, structuremanager |
DefaultUserOptions[edit source]
User options[edit source]
| Name | Value |
|---|---|
| bs-social-profile-infoshowemail | false |
Config[edit source]
Configuration[edit source]
| Name | Value | ||
|---|---|---|---|
| BSSocialProfileFieldsBSSocialProfileCustomFields | array ( 'social-profile-titledepartment' => array ( 'i18n' => 'bs-social-profile-field-titledepartment', 'callbacktype' => '\\BlueSpice\\Social\\Profile\\Field\\Title::getInstancestring', ), 'social-profile-namefunction' => array ( 'i18n' => 'bs-social-profile-field-namefunction', 'callbacktype' => '\\BlueSpice\\Social\\Profile\\Field\\Name::getInstancestring', ), 'social-profile-emaillocation' => array ( 'i18n' => 'bs-social-profile-field-emaillocation', 'callbacktype' => '\\BlueSpice\\Social\\Profile\\Field\\Email::getInstancestring', ), ) | BSSocialProfileCustomFields | array ( 'social-profile-departmentphone' => array ( 'i18n' => 'bs-social-profile-field-departmentphone', 'type' => 'string', ), ) |
| BSSocialProfileFields | array ( 'social-profile-functiontitle' => array ( 'i18n' => 'bs-social-profile-field-functiontitle', 'typecallback' => 'string\\BlueSpice\\Social\\Profile\\Field\\Title::getInstance', ), 'social-profile-locationname' => array ( 'i18n' => 'bs-social-profile-field-locationname', 'typecallback' => 'string\\BlueSpice\\Social\\Profile\\Field\\Name::getInstance', ), 'social-profile-phoneemail' => array ( 'i18n' => 'bs-social-profile-field-phoneemail', 'typecallback' => 'string\\BlueSpice\\Social\\Profile\\Field\\Email::getInstance', ), ) |
Hooks[edit source]
Hooks[edit source]
- PageContentSaveComplete
- ArticleViewHeaderHtmlPageLinkRendererBegin
- BSPageTemplatesModifyTargetUrl
- UserSaveSettings
- BSUserInfoMetaDataFactoryAllKeys
- BSUserInfoMetaDataFactoryCallback
- GetPreferencesBSPageTemplatesModifyTargetUrl
- HtmlPageLinkRendererBegin
- PageContentSaveComplete
- UserLoadAfterLoadFromSession
- UserSaveSettings
==DescriptionMsg==
{{AutoDocDescriptionMsg
|name = BlueSpiceSocialProfile
|desc = {{int:bs-socialprofile-desc
}}
}}
==License==
{{AutoDocLicense
|name = GPL-3.0-only
}}
==Requirements==
{{AutoDocRequirements
|mediawiki = {{AutoDocVersion
|name = MediaWiki
|version = ~11.31
}}
|extensions = {{AutoDocVersion
|name = BlueSpiceFoundationBlueSpiceAvatars
|version = ~33.2
}}
{{AutoDocVersion
|name = BlueSpiceSocialBlueSpiceFoundation
|version = ~33.2
}}
{{AutoDocVersion
|name = BlueSpiceAvatarsBlueSpiceSocial
|version = ~33.2
}}
}}
==IntegratesInto==
{{AutoDocIntegratesInto
|into = {{AutoDocListItem
|item = BlueSpiceFoundationBlueSpicePrivacy
}}
{{AutoDocListItem
|item = BlueSpiceSocialProfileBlueSpiceSMWConnector
}}
{{AutoDocListItem
|item = BlueSpicePrivacy
}}
{{AutoDocListItem
|item = BlueSpiceSMWConnector
}}
}}
BlueSpiceSocialProfile
}}
}}
==SpecialPages==
{{AutoDocSpecialPages
|SpecialPages = {{AutoDocCallback
|name = SocialProfiles
|callback = \BlueSpice\Social\Profile\Special\Profiles
}}
}}
==Permissions==
{{AutoDocPermissions
|permissions = {{AutoDocPermission
|name = social-editothersprofile
|type = global
|roles = admin, maintenanceadmin
|desc = {{int:right-social-editothersprofile
}}
}}
{{AutoDocPermission
|name = socialprofile-viewspecialpage
|type = global
|roles = accountmanager, admin, author, bot, commenter, editor, maintenanceadmin, reader, reviewer, structuremanager
|desc = {{int:right-socialprofile-viewspecialpage
}}
}}
}}
==DefaultUserOptions==
{{AutoDocDefaultUserOptions
|options = {{AutoDocOption
|name = bs-social-profile-infoshowemail
|value = <nowiki>false</nowiki>
}}
}}
==Config==
{{AutoDocConfig
|config = {{AutoDocOption
|name = BSSocialProfileFieldsBSSocialProfileCustomFields
|value = <nowiki>array (
'social-profile-titledepartment' =>
array (
'i18n' => 'bs-social-profile-field-title',
'callback' => '\\BlueSpice\\Social\\Profile\\Field\\Title::getInstance',
),
'social-profile-namedepartment',
'type' => 'string',
),
'social-profile-function' =>
array (
'i18n' => 'bs-social-profile-field-name',
'callback' => '\\BlueSpice\\Social\\Profile\\Field\\Name::getInstance',
),
'social-profile-emailfunction',
'type' => 'string',
),
'social-profile-location' =>
array (
'i18n' => 'bs-social-profile-field-email',
'callback' => '\\BlueSpice\\Social\\Profile\\Field\\Email::getInstance',
),
)</nowiki>
}}
{{AutoDocOption
|name = BSSocialProfileCustomFields
|value = <nowiki>array (
'social-profile-departmentlocation',
'type' => 'string',
),
'social-profile-phone' =>
array (
'i18n' => 'bs-social-profile-field-departmentphone',
'type' => 'string',
),
'social-profile-function)</nowiki>
}}
{{AutoDocOption
|name = BSSocialProfileFields
|value = <nowiki>array (
'social-profile-title' =>
array (
'i18n' => 'bs-social-profile-field-function',
'type' => 'string',
),
'social-profile-locationtitle',
'callback' => '\\BlueSpice\\Social\\Profile\\Field\\Title::getInstance',
),
'social-profile-name' =>
array (
'i18n' => 'bs-social-profile-field-location',
'type' => 'string',
),
'social-profile-phonename',
'callback' => '\\BlueSpice\\Social\\Profile\\Field\\Name::getInstance',
),
'social-profile-email' =>
array (
'i18n' => 'bs-social-profile-field-phone',
'type' => 'stringemail',
'callback' => '\\BlueSpice\\Social\\Profile\\Field\\Email::getInstance',
),
)</nowiki>
}}
}}
==Hooks==
{{AutoDocHooks
|Hooks = {{AutoDocCallback
|name = PageContentSaveComplete
[https://www.mediawiki.org/wiki/Manual:Hooks/ArticleViewHeader ArticleViewHeader]
|callback = \BlueSpice\Social\Profile\Hook\PageContentSaveComplete\InvalidateProfileEntity::callback
}}
{{AutoDocCallback
|name = ArticleViewHeader
Extension::onArticleViewHeader
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSPageTemplatesModifyTargetUrl BSPageTemplatesModifyTargetUrl]
|callback = \BlueSpice\Social\Profile\Extension::onArticleViewHeader
}}
{{AutoDocCallback
|name = HtmlPageLinkRendererBegin
Hook\BSPageTemplatesModifyTargetUrl\AddClassicProfileLink::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSUserInfoMetaDataFactoryAllKeys BSUserInfoMetaDataFactoryAllKeys]
|callback = \BlueSpice\Social\Profile\Hook\HtmlPageLinkRendererBegin\SetProfileLinksKnownBSUserInfoMetaDataFactoryAllKeys\AddCustomProfileFieldKeys::callback
}}
{{AutoDocCallback
|name = UserSaveSettings
[https://www.mediawiki.org/wiki/Manual:Hooks/BSUserInfoMetaDataFactoryCallback BSUserInfoMetaDataFactoryCallback]
|callback = \BlueSpice\Social\Profile\Hook\UserSaveSettings\CreateAndInvalidateUserProfileBSUserInfoMetaDataFactoryCallback\AddCustomProfileFieldCallbacks::callback
}}
{{AutoDocCallback
|name = BSUserInfoMetaDataFactoryAllKeys
[https://www.mediawiki.org/wiki/Manual:Hooks/GetPreferences GetPreferences]
|callback = \BlueSpice\Social\Profile\Hook\BSUserInfoMetaDataFactoryAllKeys\AddCustomProfileFieldKeysGetPreferences\AddShowProfileInfoEmail::callback
}}
{{AutoDocCallback
|name = BSUserInfoMetaDataFactoryCallback
[https://www.mediawiki.org/wiki/Manual:Hooks/HtmlPageLinkRendererBegin HtmlPageLinkRendererBegin]
|callback = \BlueSpice\Social\Profile\Hook\BSUserInfoMetaDataFactoryCallback\AddCustomProfileFieldCallbacksHtmlPageLinkRendererBegin\SetProfileLinksKnown::callback
}}
{{AutoDocCallback
|name = GetPreferences
[https://www.mediawiki.org/wiki/Manual:Hooks/PageContentSaveComplete PageContentSaveComplete]
|callback = \BlueSpice\Social\Profile\Hook\GetPreferences\AddShowProfileInfoEmailPageContentSaveComplete\InvalidateProfileEntity::callback
}}
{{AutoDocCallback
|name = BSPageTemplatesModifyTargetUrl
[https://www.mediawiki.org/wiki/Manual:Hooks/UserLoadAfterLoadFromSession UserLoadAfterLoadFromSession]
|callback = \BlueSpice\Social\Profile\Hook\BSPageTemplatesModifyTargetUrl\AddClassicProfileLinkUserLoadAfterLoadFromSession\AddLDAPProfileDataSync::callback
}}
{{AutoDocCallback
|name = UserLoadAfterLoadFromSession
[https://www.mediawiki.org/wiki/Manual:Hooks/UserSaveSettings UserSaveSettings]
|callback = \BlueSpice\Social\Profile\Hook\UserLoadAfterLoadFromSession\AddLDAPProfileDataSyncUserSaveSettings\CreateAndInvalidateUserProfile::callback
}}
}}| Line 4: | Line 4: | ||
|desc = {{int:bs-socialprofile-desc | |desc = {{int:bs-socialprofile-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 = BlueSpiceAvatars | ||
| + | |version = 3.2 | ||
| + | }} | ||
| + | {{AutoDocVersion | ||
|name = BlueSpiceFoundation | |name = BlueSpiceFoundation | ||
| − | |version = | + | |version = 3.2 |
}} | }} | ||
{{AutoDocVersion | {{AutoDocVersion | ||
|name = BlueSpiceSocial | |name = BlueSpiceSocial | ||
| − | |version = | + | |version = 3.2 |
| − | |||
| − | |||
| − | |||
| − | |||
}} | }} | ||
}} | }} | ||
| Line 27: | Line 31: | ||
{{AutoDocIntegratesInto | {{AutoDocIntegratesInto | ||
|into = {{AutoDocListItem | |into = {{AutoDocListItem | ||
| − | |item = | + | |item = BlueSpicePrivacy |
}} | }} | ||
{{AutoDocListItem | {{AutoDocListItem | ||
| − | |item = | + | |item = BlueSpiceSMWConnector |
}} | }} | ||
{{AutoDocListItem | {{AutoDocListItem | ||
| − | |item = | + | |item = BlueSpiceSocialProfile |
| − | |||
| − | |||
| − | |||
}} | }} | ||
}} | }} | ||
| Line 51: | Line 52: | ||
|name = social-editothersprofile | |name = social-editothersprofile | ||
|type = global | |type = global | ||
| − | |roles = admin,maintenanceadmin | + | |roles = admin, maintenanceadmin |
|desc = {{int:right-social-editothersprofile | |desc = {{int:right-social-editothersprofile | ||
}} | }} | ||
| Line 58: | Line 59: | ||
|name = socialprofile-viewspecialpage | |name = socialprofile-viewspecialpage | ||
|type = global | |type = global | ||
| − | |roles = accountmanager,admin,author,bot,commenter,editor,maintenanceadmin,reader,reviewer,structuremanager | + | |roles = accountmanager, admin, author, bot, commenter, editor, maintenanceadmin, reader, reviewer, structuremanager |
|desc = {{int:right-socialprofile-viewspecialpage | |desc = {{int:right-socialprofile-viewspecialpage | ||
}} | }} | ||
| Line 73: | Line 74: | ||
{{AutoDocConfig | {{AutoDocConfig | ||
|config = {{AutoDocOption | |config = {{AutoDocOption | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|name = BSSocialProfileCustomFields | |name = BSSocialProfileCustomFields | ||
|value = <nowiki>array ( | |value = <nowiki>array ( | ||
| Line 114: | Line 95: | ||
'i18n' => 'bs-social-profile-field-phone', | 'i18n' => 'bs-social-profile-field-phone', | ||
'type' => 'string', | 'type' => 'string', | ||
| + | ), | ||
| + | )</nowiki> | ||
| + | }} | ||
| + | {{AutoDocOption | ||
| + | |name = BSSocialProfileFields | ||
| + | |value = <nowiki>array ( | ||
| + | 'social-profile-title' => | ||
| + | array ( | ||
| + | 'i18n' => 'bs-social-profile-field-title', | ||
| + | 'callback' => '\\BlueSpice\\Social\\Profile\\Field\\Title::getInstance', | ||
| + | ), | ||
| + | 'social-profile-name' => | ||
| + | array ( | ||
| + | 'i18n' => 'bs-social-profile-field-name', | ||
| + | 'callback' => '\\BlueSpice\\Social\\Profile\\Field\\Name::getInstance', | ||
| + | ), | ||
| + | 'social-profile-email' => | ||
| + | array ( | ||
| + | 'i18n' => 'bs-social-profile-field-email', | ||
| + | 'callback' => '\\BlueSpice\\Social\\Profile\\Field\\Email::getInstance', | ||
), | ), | ||
)</nowiki> | )</nowiki> | ||
| Line 121: | Line 122: | ||
{{AutoDocHooks | {{AutoDocHooks | ||
|Hooks = {{AutoDocCallback | |Hooks = {{AutoDocCallback | ||
| − | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/ArticleViewHeader ArticleViewHeader] |
| − | |||
| − | |||
| − | |||
| − | |||
|callback = \BlueSpice\Social\Profile\Extension::onArticleViewHeader | |callback = \BlueSpice\Social\Profile\Extension::onArticleViewHeader | ||
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSPageTemplatesModifyTargetUrl BSPageTemplatesModifyTargetUrl] |
| − | + | |callback = \BlueSpice\Social\Profile\Hook\BSPageTemplatesModifyTargetUrl\AddClassicProfileLink::callback | |
| − | |||
| − | |||
| − | |||
| − | |callback = \BlueSpice\Social\Profile\Hook\ | ||
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = BSUserInfoMetaDataFactoryAllKeys | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSUserInfoMetaDataFactoryAllKeys BSUserInfoMetaDataFactoryAllKeys] |
|callback = \BlueSpice\Social\Profile\Hook\BSUserInfoMetaDataFactoryAllKeys\AddCustomProfileFieldKeys::callback | |callback = \BlueSpice\Social\Profile\Hook\BSUserInfoMetaDataFactoryAllKeys\AddCustomProfileFieldKeys::callback | ||
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = BSUserInfoMetaDataFactoryCallback | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSUserInfoMetaDataFactoryCallback BSUserInfoMetaDataFactoryCallback] |
|callback = \BlueSpice\Social\Profile\Hook\BSUserInfoMetaDataFactoryCallback\AddCustomProfileFieldCallbacks::callback | |callback = \BlueSpice\Social\Profile\Hook\BSUserInfoMetaDataFactoryCallback\AddCustomProfileFieldCallbacks::callback | ||
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = GetPreferences | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/GetPreferences GetPreferences] |
|callback = \BlueSpice\Social\Profile\Hook\GetPreferences\AddShowProfileInfoEmail::callback | |callback = \BlueSpice\Social\Profile\Hook\GetPreferences\AddShowProfileInfoEmail::callback | ||
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/HtmlPageLinkRendererBegin HtmlPageLinkRendererBegin] |
| − | |callback = \BlueSpice\Social\Profile\Hook\ | + | |callback = \BlueSpice\Social\Profile\Hook\HtmlPageLinkRendererBegin\SetProfileLinksKnown::callback |
| + | }} | ||
| + | {{AutoDocCallback | ||
| + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/PageContentSaveComplete PageContentSaveComplete] | ||
| + | |callback = \BlueSpice\Social\Profile\Hook\PageContentSaveComplete\InvalidateProfileEntity::callback | ||
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = UserLoadAfterLoadFromSession | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/UserLoadAfterLoadFromSession UserLoadAfterLoadFromSession] |
|callback = \BlueSpice\Social\Profile\Hook\UserLoadAfterLoadFromSession\AddLDAPProfileDataSync::callback | |callback = \BlueSpice\Social\Profile\Hook\UserLoadAfterLoadFromSession\AddLDAPProfileDataSync::callback | ||
| + | }} | ||
| + | {{AutoDocCallback | ||
| + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/UserSaveSettings UserSaveSettings] | ||
| + | |callback = \BlueSpice\Social\Profile\Hook\UserSaveSettings\CreateAndInvalidateUserProfile::callback | ||
}} | }} | ||
}} | }} | ||