Package
in package
implements
PackageInterface
Package base class
Table of Contents
Interfaces
- PackageInterface
- Package interface, all packages type should impelement it.
Properties
- $packageRegistry : PackageRegistryInterface|null
- Package Registry Interface
- $path : string
- Package root path
- $properties : CollectionInterface
- Package properties
Methods
- __construct() : mixed
- Constructor
- disable() : bool
- Disable package
- enable() : bool
- Enable package
- getDrivers() : array<string|int, mixed>
- Get drivers classes list
- getInstalOrder() : mixed
- Get install order
- getLanguages() : array<string|int, mixed>|null
- Get suppported languages
- getName() : string
- Return package name
- getPath() : string
- Get package root path
- getProperties() : CollectionInterface
- Return package properties
- getProperty() : mixed
- Get package property
- getRequire() : CollectionInterface
- Get require property
- getType() : string|null
- Get package type
- getVersion() : string
- Get Package version
- install() : mixed
- Install package.
- isInstalled() : bool
- Return true if package is installed
- postInstall() : bool
- Run post install actions
- savePackageProperties() : bool
- Save package properties file
- setPrimary() : bool
- Set package as primary
- unInstall() : bool
- UnInstall package
- validate() : bool
- Validate package properties
- validator() : PackageValidator
- Create package validator
Properties
$packageRegistry
Package Registry Interface
protected
PackageRegistryInterface|null
$packageRegistry
$path
Package root path
protected
string
$path
$properties
Package properties
protected
CollectionInterface
$properties
Methods
__construct()
Constructor
public
__construct(string $path, CollectionInterface $properties[, PackageRegistryInterface|null $packageRegistry = null ]) : mixed
Parameters
- $path : string
- $properties : CollectionInterface
- $packageRegistry : PackageRegistryInterface|null = null
disable()
Disable package
public
disable() : bool
Return values
boolenable()
Enable package
public
enable() : bool
Return values
boolgetDrivers()
Get drivers classes list
public
getDrivers() : array<string|int, mixed>
Return values
array<string|int, mixed>getInstalOrder()
Get install order
public
getInstalOrder([mixed|null $default = null ]) : mixed
Parameters
- $default : mixed|null = null
getLanguages()
Get suppported languages
public
getLanguages() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|nullgetName()
Return package name
public
getName() : string
Return values
stringgetPath()
Get package root path
public
getPath() : string
Return values
stringgetProperties()
Return package properties
public
getProperties([bool $full = false ]) : CollectionInterface
Parameters
- $full : bool = false
Return values
CollectionInterfacegetProperty()
Get package property
public
getProperty(string $name[, mixed $default = null ]) : mixed
Parameters
- $name : string
- $default : mixed = null
getRequire()
Get require property
public
getRequire() : CollectionInterface
Return values
CollectionInterfacegetType()
Get package type
public
getType() : string|null
Return values
string|nullgetVersion()
Get Package version
public
getVersion() : string
Return values
stringinstall()
Install package.
public
install([bool|null $primary = null ]) : mixed
Parameters
- $primary : bool|null = null
-
Primary package replaces routes or other params
isInstalled()
Return true if package is installed
public
isInstalled() : bool
Return values
boolpostInstall()
Run post install actions
public
postInstall() : bool
Return values
boolsavePackageProperties()
Save package properties file
public
savePackageProperties() : bool
Return values
boolsetPrimary()
Set package as primary
public
setPrimary() : bool
Return values
boolunInstall()
UnInstall package
public
unInstall() : bool
Return values
boolvalidate()
Validate package properties
public
validate() : bool
Return values
boolvalidator()
Create package validator
public
validator() : PackageValidator