1. class
  2. Arikaim
  3. \
  4. Core
  5. \
  6. Packages
  7. \
  8. ComposerPackage

ComposerPackage

class ComposerPackage extends Package implements PackageInterface

Composer package base class

Properties

protected CollectionInterface $properties Package properties from Package
protected PackageRegistryInterface|null $packageRegistry Package Registry Interface from Package
protected string $path Package root path from Package

Methods

__construct(string $path, CollectionInterface $properties, PackageRegistryInterface|null $packageRegistry = null)

Constructor

from Package
array
getDrivers()

Get drivers classes list

from Package
bool
isInstalled()

Return true if package is installed

PackageValidator
validator()

Create package validator

from Package
string
getPath()

Get package root path

from Package
string
getVersion()

Get Package version

array|null
getLanguages()

Get suppported languages

from Package
bool
setPrimary()

Set package as primary

from Package
string|null
getType()

Get package type

from Package
mixed
getInstalOrder(mixed|null $default = null)

Get install order

from Package
string
getName()

Return package name

from Package
Collection
getProperties(bool $full = false)

Return package properties

from Package
CollectionInterface
getRequire()

Get require property

from Package
mixed
getProperty(string $name, mixed $default = null)

Get package property

from Package
bool
validate()

Validate package properties

from Package
bool
install(bool|null $primary = null)

Install package.

bool
postInstall()

Run post install actions

from Package
bool
unInstall()

UnInstall package

bool
enable()

Enable package

from Package
bool
disable()

Disable package

from Package
bool
savePackageProperties()

Save package properties file

from Package
mixed
getDetails()

Get installed composer package details

Details

in Package at line 53
__construct(string $path, CollectionInterface $properties, PackageRegistryInterface|null $packageRegistry = null)

Constructor

Parameters

string $path
CollectionInterface $properties
PackageRegistryInterface|null $packageRegistry

in Package at line 66
array getDrivers()

Get drivers classes list

Return Value

array

at line 35
bool isInstalled()

Return true if package is installed

Return Value

bool

in Package at line 86
PackageValidator validator()

Create package validator

Return Value

PackageValidator

in Package at line 96
string getPath()

Get package root path

Return Value

string

at line 45
string getVersion()

Get Package version

Return Value

string

in Package at line 116
array|null getLanguages()

Get suppported languages

Return Value

array|null

in Package at line 126
bool setPrimary()

Set package as primary

Return Value

bool

in Package at line 136
string|null getType()

Get package type

Return Value

string|null

in Package at line 147
mixed getInstalOrder(mixed|null $default = null)

Get install order

Parameters

mixed|null $default

Return Value

mixed

in Package at line 157
string getName()

Return package name

Return Value

string

in Package at line 168
Collection getProperties(bool $full = false)

Return package properties

Parameters

bool $full

Return Value

Collection

in Package at line 178
CollectionInterface getRequire()

Get require property

Return Value

CollectionInterface

in Package at line 192
mixed getProperty(string $name, mixed $default = null)

Get package property

Parameters

string $name
mixed $default

Return Value

mixed

in Package at line 202
bool validate()

Validate package properties

Return Value

bool

at line 56
bool install(bool|null $primary = null)

Install package.

Parameters

bool|null $primary Primary package replaces routes or other params

Return Value

bool

in Package at line 223
bool postInstall()

Run post install actions

Return Value

bool

at line 68
bool unInstall()

UnInstall package

Return Value

bool

in Package at line 243
bool enable()

Enable package

Return Value

bool

in Package at line 253
bool disable()

Disable package

Return Value

bool

in Package at line 263
bool savePackageProperties()

Save package properties file

Return Value

bool

at line 25
mixed getDetails()

Get installed composer package details

Return Value

mixed