1. interface
  2. Arikaim
  3. \
  4. Core
  5. \
  6. Packages
  7. \
  8. Interfaces
  9. \
  10. PackageInterface

PackageInterface

interface PackageInterface

Package interface, all packages type should impelement it.

Methods

array
getDrivers()

Get drivers classes list

bool
isInstalled()

Return true if package is installed

string
getName()

Return package name

string
getVersion()

Get Package version

string|null
getType()

Get package type

Collection
getProperties(bool $full = false)

Return package properties

bool
validate()

Validate package properties

bool
install(bool|null $primary = null)

Install package

bool
postInstall()

Run post install actions

bool
unInstall()

Unintsll package

bool
enable()

Enable package

bool
disable()

Disable package

bool
setPrimary()

Set package as primary

CollectionInterface
getRequire()

Get require property

Details

at line 22
array getDrivers()

Get drivers classes list

Return Value

array

at line 29
bool isInstalled()

Return true if package is installed

Return Value

bool

at line 36
string getName()

Return package name

Return Value

string

at line 43
string getVersion()

Get Package version

Return Value

string

at line 50
string|null getType()

Get package type

Return Value

string|null

at line 58
Collection getProperties(bool $full = false)

Return package properties

Parameters

bool $full

Return Value

Collection

at line 65
bool validate()

Validate package properties

Return Value

bool

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

Install package

Parameters

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

Return Value

bool

at line 80
bool postInstall()

Run post install actions

Return Value

bool

at line 87
bool unInstall()

Unintsll package

Return Value

bool

at line 94
bool enable()

Enable package

Return Value

bool

at line 101
bool disable()

Disable package

Return Value

bool

at line 108
bool setPrimary()

Set package as primary

Return Value

bool

at line 115
CollectionInterface getRequire()

Get require property

Return Value

CollectionInterface