Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Référence de la classe ComponentHelper

Fonctions membres publiques statiques

static getComponent ($option, $strict=false)
 
static isEnabled ($option)
 
static isInstalled ($option)
 
static getParams ($option, $strict=false)
 
static filterText ($text)
 
static getComponents ()
 
static getComponentName ($object, string $alternativeName)
 

Attributs protégés statiques

static $components = array()
 

Description détaillée

Component helper class

Depuis
1.5

Documentation des fonctions membres

◆ filterText()

static filterText (   $text)
static

Applies the global text filters to arbitrary text as per settings for current user groups

Paramètres
string$textThe string to filter
Renvoie
string The filtered string
Depuis
2.5

Références $attributes, $config, $filters, $text, $user, elseif, Access\getGroupsByUser(), InputFilter\getInstance(), Factory\getUser(), InputFilter\ONLY_BLOCK_DEFINED_ATTRIBUTES, et InputFilter\ONLY_BLOCK_DEFINED_TAGS.

◆ getComponent()

static getComponent (   $option,
  $strict = false 
)
static

Get the component information.

Paramètres
string$optionThe component option.
boolean$strictIf set and the component does not exist, the enabled attribute will be set to false.
Renvoie
ComponentRecord An object with the information for the component.
Depuis
1.5

Références $option, $result, et false.

Référencé par Joomla\__construct(), RouteHelper\_findItem(), ActionlogModel\addLog(), MenuRules\buildLookup(), JsonapiView\displayList(), RouteHelper\findItem(), DatabaseModel\fixDefaultTextFilters(), ComponentModel\getComponent(), ItemModel\getItem(), RouteHelper\getItemid(), PrivacyStatusHelper\getNumberUrgentRequests(), RequestsModel\getNumberUrgentRequests(), et ItemController\setType().

◆ getComponentName()

static getComponentName (   $object,
string  $alternativeName 
)
static

Returns the component name (eg. com_content) for the given object based on the class name. If the object is not namespaced, then the alternative name is used.

Paramètres
object$objectThe object controller or model
string$alternativeNameMostly the value of getName() from the object
Renvoie
string The name
Depuis
4.0.0

Références class.

Référencé par ComponentDispatcher\__construct(), AdminController\__construct(), BaseDatabaseModel\__construct(), FormController\__construct(), ApiController\__construct(), et RouterView\getName().

◆ getComponents()

static getComponents ( )
static

Get installed components

Renvoie
ComponentRecord[] The components property
Depuis
3.6.3

Référencé par MenusHelper\getPresets(), et Access\preloadComponents().

◆ getParams()

static getParams (   $option,
  $strict = false 
)
static

Gets the parameter object for the component

Paramètres
string$optionThe option for the component.
boolean$strictIf set and the component does not exist, false will be returned
Renvoie
Registry A Registry object.
Voir également
Registry
Depuis
1.5

Références $option.

Référencé par Response\__construct(), TagField\__construct(), Router\__construct(), Result\__construct(), PlgUserJoomla\_getUser(), Task\acquireLock(), RegistrationModel\activate(), Tag\ajaxfield(), UpdateModel\applyUpdateSite(), IndexerController\batch(), LinksController\batch(), LinksModel\batchProcess(), ContactModel\buildContactExtendedData(), QueryHelper\buildVotingQuery(), Mfa\canAddEditMethod(), TemplateHelper\canUpload(), MediaHelper\canUpload(), LinkTable\check(), UpdateModel\checkCompatibility(), ApiController\checkContent(), MediaController\checkContent(), MediaHelper\checkFileExtension(), TemplateModel\checkFormat(), MediaHelper\checkMimeType(), BannerModel\click(), Help\createUrl(), OpensearchView\display(), DisplayController\display(), HtmlView\display(), CaptiveModel\getAllowedModulePositions(), UserModel\getAssignedGroups(), CMSHelper\getCurrentLanguage(), ContentHelper\getCurrentLanguage(), ApplicationModel\getData(), InstalledModel\getData(), RegistrationModel\getData(), Joomla\Component\Media\Administrator\Provider\getDefaultAdapterName(), Helper\getDefaultLanguage(), SysinfoModel\getDirectory(), ArticlesModel\getFilterForm(), ActionlogsModel\getFilterForm(), LinkModel\getForm(), TemplateModel\getForm(), ProfileModel\getForm(), UserModel\getForm(), Access\getGroupsByUser(), NumberField\getInput(), TextField\getInput(), LanguagesModel\getInstalledlangs(), PlgSampledataMultilang\getInstalledlangs(), ArticlesModel\getItems(), TagsHelper\getItemTags(), MediaField\getLayoutData(), TagsPopularHelper\getList(), ArticlesPopularHelper\getList(), BannersHelper\getList(), TagsSimilarHelper\getList(), ArticlesCategoryHelper\getList(), BannersModel\getListQuery(), TagsModel\getListQuery(), ClientsModel\getListQuery(), TasksModel\getListQuery(), TagModel\getListQuery(), ArticlesModel\getListQuery(), ModuleHelper\getModules(), LanguageField\getOptions(), ListField\getOptions(), TagField\getOptions(), CaptiveModel\getPageTitle(), SiteApplication\getParams(), PrivacyStatusHelper\getRequestFormPublished(), Indexer\getState(), SuggestionsController\getSuggestions(), UpdateModel\getUpdateInformation(), BannersModel\impress(), AdministratorApplication\initialiseApp(), SiteApplication\initialiseApp(), ModuleHelper\isAdminMultilang(), Helper\isCommon(), ApiModel\isMediaFile(), Joomla\CMS\Workflow\isWorkflowActive(), FinderHelper\logSearch(), PlgSampledataMultilang\onAjaxSampledataApplyStep6(), PlgContentJoomla\onContentAfterSave(), PlgSystemHighlight\onFinderResult(), ConfigModel\populateState(), SelectModel\populateState(), SearchesModel\populateState(), ClientsModel\populateState(), PositionsModel\populateState(), GroupsModel\populateState(), LevelsModel\populateState(), StylesModel\populateState(), TemplatesModel\populateState(), LanguagesModel\populateState(), PluginsModel\populateState(), TracksModel\populateState(), ModulesModel\populateState(), TagModel\populateState(), LanguageModel\populateState(), NewsfeedsModel\populateState(), ItemsModel\populateState(), UsersModel\populateState(), ArticlesModel\populateState(), TagsModel\populateState(), LinksModel\populateState(), StyleModel\populateState(), MenuModel\populateState(), InstalledModel\populateState(), CapabilitiesModel\populateState(), DebuggroupModel\populateState(), DebuguserModel\populateState(), ModuleModel\populateState(), FiltersModel\populateState(), RequestsModel\populateState(), SuggestionsModel\populateState(), ConsentsModel\populateState(), FeaturedModel\populateState(), CategoryModel\populateState(), RemoveModel\populateState(), TaskModel\populateState(), BannersModel\populateState(), MapsModel\populateState(), HistoryModel\populateState(), ExportModel\populateState(), IndexModel\populateState(), TemplateModel\populateState(), FieldModel\populateState(), ItemModel\populateState(), AdminModel\populateState(), Menu\preprocess(), CssMenu\preprocess(), ProfileModel\preprocessForm(), RegistrationModel\preprocessForm(), Query\processString(), InstalledModel\publish(), UpdateModel\refreshUpdates(), RegistrationModel\register(), ModuleHelper\renderModule(), ProfileModel\save(), MessageModel\save(), MailModel\send(), IndexerController\sendResponse(), LanguagesModel\setDefault(), UploaddirsField\setup(), PasswordField\setup(), LanguageAdapter\setupUninstall(), Joomla\CMS\MVC\Model\setUpWorkflow(), IndexerController\start(), Helper\stem(), Versioning\store(), ApplicationHelper\stringURLSafe(), ContactEmailMessageRule\test(), ContactEmailRule\test(), ContactEmailSubjectRule\test(), PasswordRule\test(), EmailRule\test(), Helper\tokenize(), et Indexer\tokenizeToDbShort().

◆ isEnabled()

◆ isInstalled()

static isInstalled (   $option)
static

Checks if a component is installed

Paramètres
string$optionThe component option.
Renvoie
integer
Depuis
3.4

Références $option.

Documentation des champs

◆ $components

$components = array()
staticprotected

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