[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/plugins/sampledata/multilang/ -> multilang.php (summary)

(no description)

Copyright: (C) 2018 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
File Size: 1322 lines (44 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

PlgSampledataMultilang:: (29 methods):
  onSampledataGetOverview()
  onAjaxSampledataApplyStep1()
  onAjaxSampledataApplyStep2()
  onAjaxSampledataApplyStep3()
  onAjaxSampledataApplyStep4()
  onAjaxSampledataApplyStep5()
  onAjaxSampledataApplyStep6()
  onAjaxSampledataApplyStep7()
  onAjaxSampledataApplyStep8()
  enablePlugin()
  disableModuleMainMenu()
  addModuleLanguageSwitcher()
  addModuleMenu()
  addMenuGroup()
  addAllCategoriesMenuItem()
  addBlogMenuItem()
  addAssociations()
  addModuleInModuleMenu()
  addCategory()
  addArticle()
  publishContentLanguages()
  getInstalledlangsAdministrator()
  getInstalledlangsFrontend()
  getInstalledlangs()
  getLanguageList()
  compareLanguages()
  getPath()
  getClient()
  getAdminId()


Class: PlgSampledataMultilang  - X-Ref

Sampledata - Multilang Plugin

onSampledataGetOverview()   X-Ref
Get an overview of the proposed sampledata.

return: stdClass|void  Will be converted into the JSON response to the module.

onAjaxSampledataApplyStep1()   X-Ref
First step to enable the Language filter plugin.

return: array|void  Will be converted into the JSON response to the module.

onAjaxSampledataApplyStep2()   X-Ref
Second step to add a language switcher module

return: array|void  Will be converted into the JSON response to the module.

onAjaxSampledataApplyStep3()   X-Ref
Third step to make sure all content languages are published

return: array|void  Will be converted into the JSON response to the module.

onAjaxSampledataApplyStep4()   X-Ref
Fourth step to create Menus and list all categories menu items

return: array|void  Will be converted into the JSON response to the module.

onAjaxSampledataApplyStep5()   X-Ref
Fifth step to add menu modules

return: array|void  Will be converted into the JSON response to the module.

onAjaxSampledataApplyStep6()   X-Ref
Sixth step to add workflow, categories, articles and blog menu items

return: array|void  Will be converted into the JSON response to the module.

onAjaxSampledataApplyStep7()   X-Ref
Seventh step to disable the mainmenu module whose home page is set to All languages.

return: array|void  Will be converted into the JSON response to the module.

onAjaxSampledataApplyStep8()   X-Ref
Final step to show completion of sampledata.

return: array|void  Will be converted into the JSON response to the module.

enablePlugin($pluginName)   X-Ref
Enable a Joomla plugin.

param: string  $pluginName  The name of plugin.
return: boolean

disableModuleMainMenu()   X-Ref
Disable Default Main Menu Module.

return: boolean

addModuleLanguageSwitcher()   X-Ref
Enable the Language Switcher Module.

return: boolean

addModuleMenu($itemLanguage)   X-Ref
Add Module Menu.

param: stdClass  $itemLanguage  Language Object.
return: boolean

addMenuGroup($itemLanguage)   X-Ref
Add Menu Group.

param: stdClass  $itemLanguage  Language Object.
return: boolean

addAllCategoriesMenuItem($itemLanguage)   X-Ref
Add List All Categories Menu Item for new router.

param: stdClass  $itemLanguage  Language Object.
return: Table|boolean Menu Item Object. False otherwise.

addBlogMenuItem($itemLanguage, $categoryId)   X-Ref
Add Blog Menu Item.

param: stdClass  $itemLanguage  Language Object.
param: integer   $categoryId    The id of the category displayed by the blog.
return: Table|boolean Menu Item Object. False otherwise.

addAssociations($groupedAssociations)   X-Ref
Create the language associations.

param: array  $groupedAssociations  Array of language associations for all items.
return: boolean  True on success.

addModuleInModuleMenu($moduleId)   X-Ref
Add a Module in Module menus.

param: integer  $moduleId  The Id of module.
return: boolean

addCategory($itemLanguage)   X-Ref
Method to create a category for a specific language.

param: stdClass  $itemLanguage  Language Object.
return: Table|boolean Category Object. False otherwise.

addArticle($itemLanguage, $categoryId)   X-Ref
Create an article in a specific language.

param: stdClass  $itemLanguage  Language Object.
param: integer   $categoryId    The id of the category where we want to add the article.
return: Table|boolean Article Object. False otherwise.

publishContentLanguages()   X-Ref
Publish the Installed Content Languages.

return: boolean

getInstalledlangsAdministrator()   X-Ref
Get Languages item data for the Administrator.

return: array

getInstalledlangsFrontend()   X-Ref
Get Languages item data for the Frontend.

return: array  List of installed languages in the frontend application.

getInstalledlangs($clientName = 'administrator')   X-Ref
Get Installed Languages.

param: string  $clientName  Name of the cms client.
return: array

getLanguageList($clientId = 1)   X-Ref
Get installed languages data.

param: integer  $clientId  The client ID to retrieve data for.
return: object  The language data.

compareLanguages($lang1, $lang2)   X-Ref
Compare two languages in order to sort them.

param: object  $lang1  The first language.
param: object  $lang2  The second language.
return: integer

getPath()   X-Ref
Get the languages folder path.

return: string  The path to the languages folders.

getClient($client = 'administrator')   X-Ref
Get the client object of Administrator or Frontend.

param: string  $client  Name of the client object.
return: object

getAdminId()   X-Ref
Retrieve the admin user id.

return: integer|boolean  One Administrator ID.



Generated: Wed Sep 7 05:41:13 2022 Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer