JLibraryManifest
Extends \JObjectJoomla! Library Manifest File
This class allows for simple but smart objects with get and set methods and an internal error handler.
| package |
Joomla.Platform |
|---|---|
| subpackage |
Installer |
| since |
11.1 |
Methods
__construct
Class constructor, overridden in descendant classes.
__construct(mixed $properties = null)
| since |
11.1 |
|---|
Arguments
- $properties
mixedEither and associative array or another object to set the initial properties of the object.
__toString
Magic method to convert the object to a string gracefully.
__toString() : string
| since |
11.1 |
|---|---|
| deprecated |
12.3 Classes should provide their own __toString() implementation. |
Response
stringThe classname.
def
Sets a default value if not alreay assigned
def(string $property, mixed $default = null) : mixed
| since |
11.1 |
|---|
Arguments
- $property
stringThe name of the property.- $default
mixedThe default value.
Response
mixed
get
Returns a property of the object or the default value if the property is not set.
get(string $property, mixed $default = null) : mixed
| since |
11.1 |
|---|---|
| see | \JObject::getProperties() |
Arguments
- $property
stringThe name of the property.- $default
mixedThe default value.
Response
mixedThe value of the property.
getError
Get the most recent error message.
getError(integer $i = null, boolean $toString = true) : string
| since |
11.1 |
|---|---|
| see | \JError |
| deprecated |
12.3 JError has been deprecated |
Arguments
- $i
integerOption error index.- $toString
booleanIndicates if JError objects should return their error message.
Response
stringError message
getErrors
Return all errors, if any.
getErrors() : array
| since |
11.1 |
|---|---|
| see | \JError |
| deprecated |
12.3 JError has been deprecated |
Response
arrayArray of error messages or JErrors.
getProperties
Returns an associative array of object properties.
getProperties(boolean $public = true) : array
| since |
11.1 |
|---|---|
| see | \JObject::get() |
Arguments
- $public
booleanIf true, returns only the public properties.
Response
array
loadManifestFromXML
Load a manifest from a file
loadManifestFromXML(string $xmlfile) : boolean
| since |
11.1 |
|---|
Arguments
- $xmlfile
stringPath to file to load
Response
boolean
set
Modifies a property of the object, creating it if it does not already exist.
set(string $property, mixed $value = null) : mixed
| since |
11.1 |
|---|
Arguments
- $property
stringThe name of the property.- $value
mixedThe value of the property to set.
Response
mixedPrevious value of the property.
setError
Add an error message.
setError(string $error) : void
| since |
11.1 |
|---|---|
| see | \JError |
| deprecated |
12.3 JError has been deprecated |
Arguments
- $error
stringError message.
setProperties
Set the object properties based on a named array/hash.
setProperties(mixed $properties) : boolean
| since |
11.1 |
|---|---|
| see | \JObject::set() |
Arguments
- $properties
mixedEither an associative array or another object.
Response
boolean
toString
Converts the object to a string (the class name).
toString() : string
Properties
name
name Name of Library
Type(s)
string
libraryname
libraryname File system name of the library
Type(s)
string
version
version Version of the library
Type(s)
string
description
description Description of the library
Type(s)
string
creationDate
creationDate Creation Date of the extension
Type(s)
\date
copyright
copyright Copyright notice for the extension
Type(s)
string
license
license License for the extension
Type(s)
string
author
author Author for the extension
Type(s)
string
authoremail
authoremail Author email for the extension
Type(s)
string
authorurl
authorurl Author url for the extension
Type(s)
string
packager
packager Name of the packager for the library (may also be porter)
Type(s)
string
packagerurl
packagerurl URL of the packager for the library (may also be porter)
Type(s)
string
update
update URL of the update site
Type(s)
string
filelist
filelist List of files in the library
Type(s)
array<mixed,string>
manifest_file
manifest_file Path to manifest file
Type(s)
string
_errors
An array of error messages or Exception objects.