Documentation

CRM_Extension_System
in package

This class glues together the various parts of the extension system.

Tags
copyright

CiviCRM LLC https://civicrm.org/licensing

Table of Contents

Constants

DEFAULT_MAX_DEPTH  = 3

Properties

$parameters  : array<string|int, mixed>
$_repoUrl  : string|false
The URL of the remote extensions repository.
$browser  : mixed
$cache  : mixed
$classLoader  : CRM_Extension_ClassLoader
$defaultContainer  : mixed
$downloader  : mixed
$fullContainer  : mixed
$manager  : mixed
$mapper  : mixed
$mixinLoader  : mixed
$singleton  : mixed

Methods

__construct()  : mixed
Class constructor.
createExtendedInfo()  : array<string|int, mixed>
Take an extension's raw XML info and add information about the extension's status on the local system.
getBrowser()  : CRM_Extension_Browser
Get the service for finding remotely-available extensions
getCache()  : CRM_Utils_Cache_Interface
Get the cache object.
getClassLoader()  : CRM_Extension_ClassLoader
getCompatibilityInfo()  : array<string|int, mixed>
Returns a list keyed by extension key
getDefaultContainer()  : CRM_Extension_Container_Default|false
Get the container to which new extensions are installed.
getDownloader()  : CRM_Extension_Downloader
Get the service for loading code from remotely-available extensions
getFullContainer()  : CRM_Extension_Container_Interface
Get a container which represents all available extensions.
getManager()  : CRM_Extension_Manager
Get the service for enabling and disabling extensions.
getMapper()  : CRM_Extension_Mapper
Get the service which provides runtime information about extensions.
getMixinLoader()  : mixed
getRepositoryUrl()  : string|false
Determine the URL which provides a feed of available extensions.
isNotTestExtension()  : mixed
setSingleton()  : mixed
singleton()  : CRM_Extension_System

Constants

DEFAULT_MAX_DEPTH

public mixed DEFAULT_MAX_DEPTH = 3

Properties

$parameters

protected array<string|int, mixed> $parameters

Construction parameters. These are primarily retained so that they can influence the cache name.

$_repoUrl

The URL of the remote extensions repository.

private string|false $_repoUrl = \NULL

$browser

private mixed $browser = \NULL

$cache

private mixed $cache = \NULL

$defaultContainer

private mixed $defaultContainer = \NULL

$downloader

private mixed $downloader = \NULL

$fullContainer

private mixed $fullContainer = \NULL

$manager

private mixed $manager = \NULL

$mapper

private mixed $mapper = \NULL

$mixinLoader

private mixed $mixinLoader = \NULL

$singleton

private static mixed $singleton

Methods

__construct()

Class constructor.

public __construct([array<string|int, mixed> $parameters = [] ]) : mixed
Parameters
$parameters : array<string|int, mixed> = []

List of configuration values required by the extension system. Missing values will be guessed based on $config.

createExtendedInfo()

Take an extension's raw XML info and add information about the extension's status on the local system.

public static createExtendedInfo(CRM_Extension_Info $obj) : array<string|int, mixed>

The result format resembles the old CRM_Core_Extensions_Extension.

Parameters
$obj : CRM_Extension_Info
Return values
array<string|int, mixed>

getCompatibilityInfo()

Returns a list keyed by extension key

public static getCompatibilityInfo() : array<string|int, mixed>
Return values
array<string|int, mixed>

getMixinLoader()

public getMixinLoader() : mixed
Tags
@return

CRM_Extension_MixinLoader;

getRepositoryUrl()

Determine the URL which provides a feed of available extensions.

public getRepositoryUrl() : string|false
Return values
string|false 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results