|
| | buildStruct (array $struct, array $array) |
| | Normalizes an array into the structure specified. More...
|
| |
Definition at line 18 of file ElggPluginManifest.php.
◆ __construct()
| ElggPluginManifest::__construct |
( |
|
$manifest, |
|
|
|
$plugin_id = null |
|
) |
| |
Load a manifest file, XmlElement or path to manifest.xml file.
- Parameters
-
| mixed | $manifest | A string, XmlElement, or path of a manifest file. |
| string | $plugin_id | Optional ID of the owning plugin. Used to fill in some values automatically. |
- Exceptions
-
Definition at line 151 of file ElggPluginManifest.php.
◆ buildStruct()
| ElggPluginManifest::buildStruct |
( |
array |
$struct, |
|
|
array |
$array |
|
) |
| |
|
protected |
Normalizes an array into the structure specified.
- Parameters
-
| array | $struct | The struct to normalize $element to. |
| array | $array | The array |
- Returns
- array
Definition at line 718 of file ElggPluginManifest.php.
◆ getActivateOnInstall()
| ElggPluginManifest::getActivateOnInstall |
( |
| ) |
|
◆ getApiVersion()
| ElggPluginManifest::getApiVersion |
( |
| ) |
|
◆ getAuthor()
| ElggPluginManifest::getAuthor |
( |
| ) |
|
◆ getBlurb()
| ElggPluginManifest::getBlurb |
( |
| ) |
|
◆ getBugTrackerURL()
| ElggPluginManifest::getBugTrackerURL |
( |
| ) |
|
◆ getCategories()
| ElggPluginManifest::getCategories |
( |
| ) |
|
◆ getConflicts()
| ElggPluginManifest::getConflicts |
( |
| ) |
|
◆ getContributors()
| ElggPluginManifest::getContributors |
( |
| ) |
|
◆ getCopyright()
| ElggPluginManifest::getCopyright |
( |
| ) |
|
◆ getDescription()
| ElggPluginManifest::getDescription |
( |
| ) |
|
◆ getDonationsPageURL()
| ElggPluginManifest::getDonationsPageURL |
( |
| ) |
|
◆ getFriendlyCategory()
| static ElggPluginManifest::getFriendlyCategory |
( |
|
$category | ) |
|
|
static |
Returns a category's friendly name.
This can be localized by defining the string 'admin:plugins:category:<category>'. If no localization is found, returns the category with _ and - converted to ' ' and then ucwords()'d.
- Parameters
-
| string | $category | The category as defined in the manifest. |
- Returns
- string A human-readable category
Definition at line 737 of file ElggPluginManifest.php.
◆ getID()
| ElggPluginManifest::getID |
( |
| ) |
|
Return the plugin ID required by the author.
If getPluginID() does not match this, the plugin should not be started.
- Returns
- string empty string if not empty/not defined
Definition at line 271 of file ElggPluginManifest.php.
◆ getLicense()
| ElggPluginManifest::getLicense |
( |
| ) |
|
◆ getManifest()
| ElggPluginManifest::getManifest |
( |
| ) |
|
Returns the manifest array.
Used for backward compatibility. Specific methods should be called instead.
- Returns
- array
Definition at line 242 of file ElggPluginManifest.php.
◆ getName()
| ElggPluginManifest::getName |
( |
| ) |
|
◆ getPluginID()
| ElggPluginManifest::getPluginID |
( |
| ) |
|
◆ getProvides()
| ElggPluginManifest::getProvides |
( |
| ) |
|
◆ getRepositoryURL()
| ElggPluginManifest::getRepositoryURL |
( |
| ) |
|
◆ getRequires()
| ElggPluginManifest::getRequires |
( |
| ) |
|
◆ getScreenshots()
| ElggPluginManifest::getScreenshots |
( |
| ) |
|
◆ getSuggests()
| ElggPluginManifest::getSuggests |
( |
| ) |
|
◆ getVersion()
| ElggPluginManifest::getVersion |
( |
| ) |
|
◆ getWebsite()
| ElggPluginManifest::getWebsite |
( |
| ) |
|
◆ $apiVersion
| ElggPluginManifest::$apiVersion |
|
protected |
◆ $namespace_root
| ElggPluginManifest::$namespace_root = 'http://www.elgg.org/plugin_manifest/' |
|
protected |
◆ $parser
| ElggPluginManifest::$parser |
|
protected |
◆ $pluginID
| ElggPluginManifest::$pluginID |
|
protected |
The documentation for this class was generated from the following file:
