Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Référence de la classe PlgSampledataMultilang
+ Graphe d'héritage de PlgSampledataMultilang:

Fonctions membres publiques

 onSampledataGetOverview ()
 
 onAjaxSampledataApplyStep1 ()
 
 onAjaxSampledataApplyStep2 ()
 
 onAjaxSampledataApplyStep3 ()
 
 onAjaxSampledataApplyStep4 ()
 
 onAjaxSampledataApplyStep5 ()
 
 onAjaxSampledataApplyStep6 ()
 
 onAjaxSampledataApplyStep7 ()
 
 onAjaxSampledataApplyStep8 ()
 
 addCategory ($itemLanguage)
 
 getInstalledlangsAdministrator ()
 
 getInstalledlangsFrontend ()
 
- Fonctions membres publiques hérités de CMSPlugin
 __construct (&$subject, $config=array())
 
 loadLanguage ($extension='', $basePath=JPATH_ADMINISTRATOR)
 
 setApplication (CMSApplicationInterface $application)
 
- Fonctions membres publiques hérités de DispatcherAwareInterface
 setDispatcher (DispatcherInterface $dispatcher)
 
- Fonctions membres publiques hérités de PluginInterface
 registerListeners ()
 

Fonctions membres protégées

 getInstalledlangs ($clientName='administrator')
 
 getLanguageList ($clientId=1)
 
 compareLanguages ($lang1, $lang2)
 
 getPath ()
 
 getClient ($client='administrator')
 
- Fonctions membres protégées hérités de CMSPlugin
 registerLegacyListener (string $methodName)
 
 registerListener (string $methodName)
 
 getApplication ()
 

Attributs protégés

 $db
 
 $app
 
 $autoloadLanguage = true
 
 $path = null
 
 $adminId
 
- Attributs protégés hérités de CMSPlugin
 $_name = null
 
 $_type = null
 
 $autoloadLanguage = false
 
 $allowLegacyListeners = true
 

Fonctions membres privées

 enablePlugin ($pluginName)
 
 disableModuleMainMenu ()
 
 addModuleLanguageSwitcher ()
 
 addModuleMenu ($itemLanguage)
 
 addMenuGroup ($itemLanguage)
 
 addAllCategoriesMenuItem ($itemLanguage)
 
 addBlogMenuItem ($itemLanguage, $categoryId)
 
 addAssociations ($groupedAssociations)
 
 addModuleInModuleMenu ($moduleId)
 
 addArticle ($itemLanguage, $categoryId)
 
 publishContentLanguages ()
 
 getAdminId ()
 

Membres hérités additionnels

- Champs de données hérités de CMSPlugin
 $params = null
 

Description détaillée

Sampledata - Multilang Plugin

Depuis
4.0.0

Documentation des fonctions membres

◆ addAllCategoriesMenuItem()

addAllCategoriesMenuItem (   $itemLanguage)
private

Add List All Categories Menu Item for new router.

Paramètres
stdClass$itemLanguageLanguage Object.
Renvoie
Table|boolean Menu Item Object. False otherwise.
Depuis
4.0.0

Références $title, et JPATH_ADMINISTRATOR.

◆ addArticle()

addArticle (   $itemLanguage,
  $categoryId 
)
private

Create an article in a specific language.

Paramètres
stdClass$itemLanguageLanguage Object.
integer$categoryIdThe id of the category where we want to add the article.
Renvoie
Table|boolean Article Object. False otherwise.
Depuis
4.0.0

Références $article, $currentDate, $data, $db, $query, $title, Joomla\CMS\MVC\Model\$workflow, Factory\getDate(), JPATH_ADMINISTRATOR, null, et ApplicationHelper\stringURLSafe().

◆ addAssociations()

addAssociations (   $groupedAssociations)
private

Create the language associations.

Paramètres
array$groupedAssociationsArray of language associations for all items.
Renvoie
boolean True on success.
Depuis
4.0.0

Références $context, $db, $id, $key, $language, $query, ParameterType\INTEGER, et ParameterType\STRING.

◆ addBlogMenuItem()

addBlogMenuItem (   $itemLanguage,
  $categoryId 
)
private

Add Blog Menu Item.

Paramètres
stdClass$itemLanguageLanguage Object.
integer$categoryIdThe id of the category displayed by the blog.
Renvoie
Table|boolean Menu Item Object. False otherwise.
Depuis
4.0.0

Références $title, et JPATH_ADMINISTRATOR.

◆ addCategory()

addCategory (   $itemLanguage)

Method to create a category for a specific language.

Paramètres
stdClass$itemLanguageLanguage Object.
Renvoie
Table|boolean Category Object. False otherwise.
Depuis
4.0.0

Références $app, $category, $data, $title, Factory\getApplication(), Factory\getDate(), JPATH_ADMINISTRATOR, et ApplicationHelper\stringURLSafe().

◆ addMenuGroup()

addMenuGroup (   $itemLanguage)
private

Add Menu Group.

Paramètres
stdClass$itemLanguageLanguage Object.
Renvoie
boolean
Depuis
4.0.0

◆ addModuleInModuleMenu()

addModuleInModuleMenu (   $moduleId)
private

Add a Module in Module menus.

Paramètres
integer$moduleIdThe Id of module.
Renvoie
boolean
Depuis
4.0.0

Références $db, $moduleId, $query, et ParameterType\INTEGER.

◆ addModuleLanguageSwitcher()

addModuleLanguageSwitcher ( )
private

Enable the Language Switcher Module.

Renvoie
boolean
Depuis
4.0.0

◆ addModuleMenu()

addModuleMenu (   $itemLanguage)
private

Add Module Menu.

Paramètres
stdClass$itemLanguageLanguage Object.
Renvoie
boolean
Depuis
4.0.0

Références $title.

◆ compareLanguages()

compareLanguages (   $lang1,
  $lang2 
)
protected

Compare two languages in order to sort them.

Paramètres
object$lang1The first language.
object$lang2The second language.
Renvoie
integer
Depuis
4.0.0

◆ disableModuleMainMenu()

disableModuleMainMenu ( )
private

Disable Default Main Menu Module.

Renvoie
boolean
Depuis
4.0.0

Références $db, et $query.

◆ enablePlugin()

enablePlugin (   $pluginName)
private

Enable a Joomla plugin.

Paramètres
string$pluginNameThe name of plugin.
Renvoie
boolean
Depuis
4.0.0

Références $db, $params, et $query.

◆ getAdminId()

getAdminId ( )
private

Retrieve the admin user id.

Renvoie
integer|boolean One Administrator ID.
Depuis
4.0.0

Références $db, $id, et $query.

◆ getClient()

getClient (   $client = 'administrator')
protected

Get the client object of Administrator or Frontend.

Paramètres
string$clientName of the client object.
Renvoie
object
Depuis
4.0.0

Références $client, et ApplicationHelper\getClientInfo().

◆ getInstalledlangs()

getInstalledlangs (   $clientName = 'administrator')
protected

Get Installed Languages.

Paramètres
string$clientNameName of the cms client.
Renvoie
array
Depuis
4.0.0

Références $client, $data, $info, $key, $lang, $params, $path, $this, $value, ComponentHelper\getParams(), null, et Installer\parseXMLInstallFile().

◆ getInstalledlangsAdministrator()

getInstalledlangsAdministrator ( )

Get Languages item data for the Administrator.

Renvoie
array
Depuis
4.0.0

◆ getInstalledlangsFrontend()

getInstalledlangsFrontend ( )

Get Languages item data for the Frontend.

Renvoie
array List of installed languages in the frontend application.
Depuis
4.0.0

◆ getLanguageList()

getLanguageList (   $clientId = 1)
protected

Get installed languages data.

Paramètres
integer$clientIdThe client ID to retrieve data for.
Renvoie
object The language data.
Depuis
4.0.0

Références $clientId, $db, $query, et ParameterType\INTEGER.

◆ getPath()

getPath ( )
protected

Get the languages folder path.

Renvoie
string The path to the languages folders.
Depuis
4.0.0

Références $client, $path, LanguageHelper\getLanguagePath(), null, et path.

◆ onAjaxSampledataApplyStep1()

onAjaxSampledataApplyStep1 ( )

First step to enable the Language filter plugin.

Renvoie
array|void Will be converted into the JSON response to the module.
Depuis
4.0.0

Références $lang, $languages, $message, Text\_(), Joomla\Application\checkToken(), JPATH_ADMINISTRATOR, et Text\sprintf().

◆ onAjaxSampledataApplyStep2()

onAjaxSampledataApplyStep2 ( )

Second step to add a language switcher module

Renvoie
array|void Will be converted into the JSON response to the module.
Depuis
4.0.0

Références $lang, $message, Text\_(), Joomla\Application\checkToken(), ComponentHelper\isEnabled(), JPATH_SITE, et Text\sprintf().

◆ onAjaxSampledataApplyStep3()

onAjaxSampledataApplyStep3 ( )

Third step to make sure all content languages are published

Renvoie
array|void Will be converted into the JSON response to the module.
Depuis
4.0.0

Références Text\_(), Joomla\Application\checkToken(), ComponentHelper\isEnabled(), et Text\sprintf().

◆ onAjaxSampledataApplyStep4()

onAjaxSampledataApplyStep4 ( )

Fourth step to create Menus and list all categories menu items

Renvoie
array|void Will be converted into the JSON response to the module.
Depuis
4.0.0

Références Text\_(), Joomla\Application\checkToken(), ComponentHelper\isEnabled(), et Text\sprintf().

◆ onAjaxSampledataApplyStep5()

onAjaxSampledataApplyStep5 ( )

Fifth step to add menu modules

Renvoie
array|void Will be converted into the JSON response to the module.
Depuis
4.0.0

Références Text\_(), Joomla\Application\checkToken(), ComponentHelper\isEnabled(), et Text\sprintf().

◆ onAjaxSampledataApplyStep6()

onAjaxSampledataApplyStep6 ( )

Sixth step to add workflow, categories, articles and blog menu items

Renvoie
array|void Will be converted into the JSON response to the module.
Depuis
4.0.0

Références Text\_(), Joomla\Application\checkToken(), ComponentHelper\getParams(), ComponentHelper\isEnabled(), et Text\sprintf().

◆ onAjaxSampledataApplyStep7()

onAjaxSampledataApplyStep7 ( )

Seventh step to disable the mainmenu module whose home page is set to All languages.

Renvoie
array|void Will be converted into the JSON response to the module.
Depuis
4.0.0

Références Text\_(), Joomla\Application\checkToken(), ComponentHelper\isEnabled(), et Text\sprintf().

◆ onAjaxSampledataApplyStep8()

onAjaxSampledataApplyStep8 ( )

Final step to show completion of sampledata.

Renvoie
array|void Will be converted into the JSON response to the module.
Depuis
4.0.0

Références Text\_().

◆ onSampledataGetOverview()

onSampledataGetOverview ( )

Get an overview of the proposed sampledata.

Renvoie
stdClass|void Will be converted into the JSON response to the module.
Depuis
4.0.0

Références $data, et Text\_().

◆ publishContentLanguages()

publishContentLanguages ( )
private

Publish the Installed Content Languages.

Renvoie
boolean
Depuis
4.0.0

Références Text\sprintf().

Documentation des champs

◆ $adminId

$adminId
protected

◆ $app

$app
protected

◆ $autoloadLanguage

$autoloadLanguage = true
protected

◆ $db

$db
protected

◆ $path

$path = null
protected

La documentation de cette classe a été générée à partir du fichier suivant :