Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
Référence de la classe AssociationsHelper
+ Graphe d'héritage de AssociationsHelper:

Fonctions membres publiques statiques

static getAssociationList ($extensionName, $typeName, $itemId)
 
static getExtensionHelper ($extensionName)
 
static getItem ($extensionName, $typeName, $itemId)
 
static hasSupport ($extensionName)
 
static getAssociationHtmlList ($extensionName, $typeName, $itemId, $itemLanguage, $addLink=true, $assocLanguages=true)
 
static getSupportedExtensions ()
 
static getSupportedExtension ($extensionName)
 
static getContentLanguages ()
 
static allowEdit ($extensionName, $typeName, $itemId)
 
static allowAdd ($extensionName, $typeName)
 
static isCheckoutItem ($extensionName, $typeName, $itemId)
 
static canCheckinItem ($extensionName, $typeName, $itemId)
 
static typeSupportsCheckout ($extensionName, $typeName)
 
static getTypeFieldName ($extensionName, $typeName, $fieldName)
 
static getLanguagefilterPluginId ()
 

Attributs publics statiques

static $extensionsSupport = null
 
static $supportedExtensionsList = array()
 

Fonctions membres privées statiques

static getExtensionHelperClassName ($extensionName)
 
static getExtensionRealName ($extensionName)
 
static getEnabledExtensions ()
 

Description détaillée

Associations component helper.

Depuis
3.7.0

Documentation des fonctions membres

◆ allowAdd()

static allowAdd (   $extensionName,
  $typeName 
)
static

Check if user is allowed to create items.

Paramètres
string$extensionNameThe extension name with com_
string$typeNameThe item type
Renvoie
boolean True on allowed.
Depuis
3.7.0

Référencé par JFormFieldItemLanguage\getOptions().

◆ allowEdit()

static allowEdit (   $extensionName,
  $typeName,
  $itemId 
)
static

Get the associated items for an item

Paramètres
string$extensionNameThe extension name with com_
string$typeNameThe item type
int$itemIdThe id of item for which we need the associated items
Renvoie
bool
Depuis
3.7.0

Références $itemId.

Référencé par AssociationsControllerAssociation\edit(), et JFormFieldItemLanguage\getOptions().

◆ canCheckinItem()

static canCheckinItem (   $extensionName,
  $typeName,
  $itemId 
)
static

Check if user can checkin an item.

Paramètres
string$extensionNameThe extension name with com_
string$typeNameThe item type
int$itemIdThe id of item for which we need the associated items
Renvoie
boolean True on allowed.
Depuis
3.7.0

Références $item, $itemId, et $userId.

Référencé par AssociationsControllerAssociations\checkin(), et JFormFieldItemLanguage\getOptions().

◆ getAssociationHtmlList()

static getAssociationHtmlList (   $extensionName,
  $typeName,
  $itemId,
  $itemLanguage,
  $addLink = true,
  $assocLanguages = true 
)
static

Get the associated language edit links Html.

Paramètres
string$extensionNameExtension Name
string$typeNameItemType
integer$itemIdItem id.
string$itemLanguageItem language code.
boolean$addLinkTrue for adding edit links. False for just text.
boolean$assocLanguagesTrue for showing non associated content languages. False only languages with associations.
Renvoie
string The language HTML
Depuis
3.7.0

Références $canCreate, $classes, $db, $itemId, $items, $labelClass, $language, Language\$languages, $options, $query, $target, $text, $title, $tooltip, $url, elseif, ENT_QUOTES, et LanguageHelper\getContentLanguages().

◆ getAssociationList()

static getAssociationList (   $extensionName,
  $typeName,
  $itemId 
)
static

Get the associated items for an item

Paramètres
string$extensionNameThe extension name with com_
string$typeNameThe item type
int$itemIdThe id of item for which we need the associated items
Renvoie
array
Depuis
3.7.0

Références $itemId.

Référencé par JFormFieldItemLanguage\getOptions().

◆ getContentLanguages()

static getContentLanguages ( )
static

Get all the content languages.

Renvoie
array Array of objects all content languages by language code.
Depuis
3.7.0

Références LanguageHelper\getContentLanguages().

◆ getEnabledExtensions()

static getEnabledExtensions ( )
staticprivate

Get all installed and enabled extensions

Renvoie
mixed
Depuis
3.7.0

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

◆ getExtensionHelper()

static getExtensionHelper (   $extensionName)
static

Get the the instance of the extension helper class

Paramètres
string$extensionNameThe extension name with com_
Renvoie
HelperClass|null
Depuis
3.7.0

Références null.

Référencé par AssociationsViewAssociation\addToolbar(), AssociationsViewAssociations\addToolbar(), et JFormFieldItemLanguage\getOptions().

◆ getExtensionHelperClassName()

static getExtensionHelperClassName (   $extensionName)
staticprivate

Get the extension specific helper class name

Paramètres
string$extensionNameThe extension name with com_
Renvoie
bool
Depuis
3.7.0

◆ getExtensionRealName()

static getExtensionRealName (   $extensionName)
staticprivate

Get the real extension name. This means without com_

Paramètres
string$extensionNameThe extension name with com_
Renvoie
string
Depuis
3.7.0

◆ getItem()

static getItem (   $extensionName,
  $typeName,
  $itemId 
)
static

Get item information

Paramètres
string$extensionNameThe extension name with com_
string$typeNameThe item type
int$itemIdThe id of item for which we need the associated items
Renvoie
JTable|null
Depuis
3.7.0

Références $itemId.

Référencé par AssociationsControllerAssociation\cancel(), AssociationsControllerAssociations\checkin(), AssociationsViewAssociation\display(), et JFormFieldItemLanguage\getOptions().

◆ getLanguagefilterPluginId()

static getLanguagefilterPluginId ( )
static

Gets the language filter system plugin extension id.

Renvoie
int The language filter system plugin extension id.
Depuis
3.7.2

Références $db, $query, et JError\raiseWarning().

Référencé par AssociationsViewAssociations\display().

◆ getSupportedExtension()

static getSupportedExtension (   $extensionName)
static

Get item context based on the item key.

Paramètres
string$extensionNameThe extension identifier.
Renvoie
Joomla The item properties.
Depuis
3.7.0

Références $context, $lang, $title, Registry\def(), JPATH_ADMINISTRATOR, et null.

Référencé par AssociationsControllerAssociations\checkin(), AssociationsViewAssociations\display(), AssociationsViewAssociation\display(), et AssociationsModelAssociations\getListQuery().

◆ getSupportedExtensions()

static getSupportedExtensions ( )
static

Get all extensions with associations support.

Renvoie
array The extensions.
Depuis
3.7.0

Références $extension.

Référencé par JFormFieldItemType\getGroups().

◆ getTypeFieldName()

static getTypeFieldName (   $extensionName,
  $typeName,
  $fieldName 
)
static

Get a table field name for a type

Paramètres
string$extensionNameThe extension name with com_
string$typeNameThe item type
string$fieldNameThe item type
Renvoie
boolean True on allowed.
Depuis
3.7.0

Référencé par AssociationsViewAssociation\display().

◆ hasSupport()

static hasSupport (   $extensionName)
static

Check if extension supports associations

Paramètres
string$extensionNameThe extension name with com_
Renvoie
bool
Depuis
3.7.0

◆ isCheckoutItem()

static isCheckoutItem (   $extensionName,
  $typeName,
  $itemId 
)
static

Check if an item is checked out

Paramètres
string$extensionNameThe extension name with com_
string$typeNameThe item type
int$itemIdThe id of item for which we need the associated items
Renvoie
boolean True if item is checked out.
Depuis
3.7.0

Références $item, et $itemId.

◆ typeSupportsCheckout()

static typeSupportsCheckout (   $extensionName,
  $typeName 
)
static

Check if the type supports checkout

Paramètres
string$extensionNameThe extension name with com_
string$typeNameThe item type
Renvoie
boolean True on allowed.
Depuis
3.7.0

Référencé par AssociationsControllerAssociation\cancel(), et AssociationsControllerAssociations\checkin().

Documentation des champs

◆ $extensionsSupport

$extensionsSupport = null
static

Array of Registry objects of extensions

var array $extensionsSupport

Depuis
3.7.0

◆ $supportedExtensionsList

$supportedExtensionsList = array()
static

List of extensions name with support

var array $supportedExtensionsList

Depuis
3.7.0

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