[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/administrator/components/com_associations/src/Helper/ -> AssociationsHelper.php (summary)

(no description)

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

Defines 1 class

AssociationsHelper:: (19 methods):
  getAssociationList()
  getExtensionHelper()
  getItem()
  hasSupport()
  loadHelper()
  getExtensionHelperClassName()
  getExtensionRealName()
  getAssociationHtmlList()
  getSupportedExtensions()
  getSupportedExtension()
  getEnabledExtensions()
  getContentLanguages()
  allowEdit()
  allowAdd()
  isCheckoutItem()
  canCheckinItem()
  typeSupportsCheckout()
  getTypeFieldName()
  getLanguagefilterPluginId()


Class: AssociationsHelper  - X-Ref

Associations component helper.

getAssociationList($extensionName, $typeName, $itemId)   X-Ref
Get the associated items for an item

param: string  $extensionName  The extension name with com_
param: string  $typeName       The item type
param: int     $itemId         The id of item for which we need the associated items
return: array

getExtensionHelper($extensionName)   X-Ref
Get the the instance of the extension helper class

param: string  $extensionName  The extension name with com_
return: \Joomla\CMS\Association\AssociationExtensionHelper|null

getItem($extensionName, $typeName, $itemId)   X-Ref
Get item information

param: string  $extensionName  The extension name with com_
param: string  $typeName       The item type
param: int     $itemId         The id of item for which we need the associated items
return: \Joomla\CMS\Table\Table|null

hasSupport($extensionName)   X-Ref
Check if extension supports associations

param: string  $extensionName  The extension name with com_
return: boolean

loadHelper($extensionName)   X-Ref
Loads the helper for the given class.

param: string  $extensionName  The extension name with com_
return: AssociationExtensionInterface|null

getExtensionHelperClassName($extensionName)   X-Ref
Get the extension specific helper class name

param: string  $extensionName  The extension name with com_
return: string

getExtensionRealName($extensionName)   X-Ref
Get the real extension name. This means without com_

param: string  $extensionName  The extension name with com_
return: string

getAssociationHtmlList($extensionName, $typeName, $itemId, $itemLanguage, $addLink = true, $assocLanguages = true)   X-Ref
Get the associated language edit links Html.

param: string   $extensionName   Extension Name
param: string   $typeName        ItemType
param: integer  $itemId          Item id.
param: string   $itemLanguage    Item language code.
param: boolean  $addLink         True for adding edit links. False for just text.
param: boolean  $assocLanguages  True for showing non associated content languages. False only languages with associations.
return: string   The language HTML

getSupportedExtensions()   X-Ref
Get all extensions with associations support.

return: array  The extensions.

getSupportedExtension($extensionName)   X-Ref
Get item context based on the item key.

param: string  $extensionName  The extension identifier.
return: \Joomla\Registry\Registry  The item properties.

getEnabledExtensions()   X-Ref
Get all installed and enabled extensions

return: mixed

getContentLanguages()   X-Ref
Get all the content languages.

return: array  Array of objects all content languages by language code.

allowEdit($extensionName, $typeName, $itemId)   X-Ref
Get the associated items for an item

param: string  $extensionName  The extension name with com_
param: string  $typeName       The item type
param: int     $itemId         The id of item for which we need the associated items
return: boolean

allowAdd($extensionName, $typeName)   X-Ref
Check if user is allowed to create items.

param: string  $extensionName  The extension name with com_
param: string  $typeName       The item type
return: boolean  True on allowed.

isCheckoutItem($extensionName, $typeName, $itemId)   X-Ref
Check if an item is checked out

param: string  $extensionName  The extension name with com_
param: string  $typeName       The item type
param: int     $itemId         The id of item for which we need the associated items
return: boolean  True if item is checked out.

canCheckinItem($extensionName, $typeName, $itemId)   X-Ref
Check if user can checkin an item.

param: string  $extensionName  The extension name with com_
param: string  $typeName       The item type
param: int     $itemId         The id of item for which we need the associated items
return: boolean  True on allowed.

typeSupportsCheckout($extensionName, $typeName)   X-Ref
Check if the type supports checkout

param: string  $extensionName  The extension name with com_
param: string  $typeName       The item type
return: boolean  True on allowed.

getTypeFieldName($extensionName, $typeName, $fieldName)   X-Ref
Get a table field name for a type

param: string  $extensionName  The extension name with com_
param: string  $typeName       The item type
param: string  $fieldName      The item type
return: boolean  True on allowed.

getLanguagefilterPluginId()   X-Ref
Gets the language filter system plugin extension id.

return: integer  The language filter system plugin extension id.



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