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

ModulePackage

class ModulePackage extends Package implements PackageInterface

Module Package class

Traits

Drivers
Get package drivers.
Jobs
Package jobs trait
ConsoleCommands
Console commands trait

Constants

SERVICE

PACKAGE

MIDDLEWARE

TYPE_NAME

Module type

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 module console commands class list.

from Drivers
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

from Package
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)

Get module package properties

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 module

bool
postInstall()

Run post install actions

from Package
bool
unInstall()

Uninstall module

bool
enable()

Enable module

bool
disable()

Disable module

bool
savePackageProperties()

Save package properties file

from Package
string
getDriversPath()

Get module drivers path

from Drivers
string
getJobsPath()

Get extension jobs path

from Jobs
array
getPackageJobs()

Get extension jobs

from Jobs
array
getConsoleCommands()

Get package console commands

from ConsoleCommands
string
getClass()

Get module class

static integer
getTypeId(string $typeName)

Get type id

string
getConsolePath()

Get module console commands path

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 Drivers at line 24
array getDrivers()

Get module console commands class list.

Return Value

array

at line 85
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

in Package at line 106
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

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

Get module 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 97
bool install(bool|null $primary = null)

Install module

Parameters

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

Return Value

bool

Exceptions

Exception

in Package at line 223
bool postInstall()

Run post install actions

Return Value

bool

at line 187
bool unInstall()

Uninstall module

Return Value

bool

at line 199
bool enable()

Enable module

Return Value

bool

at line 209
bool disable()

Disable module

Return Value

bool

in Package at line 263
bool savePackageProperties()

Save package properties file

Return Value

bool

in Drivers at line 52
string getDriversPath()

Get module drivers path

Return Value

string

in Jobs at line 26
string getJobsPath()

Get extension jobs path

Return Value

string

in Jobs at line 36
array getPackageJobs()

Get extension jobs

Return Value

array

in ConsoleCommands at line 24
array getConsoleCommands()

Get package console commands

Return Value

array

at line 47
string getClass()

Get module class

Return Value

string

at line 220
static integer getTypeId(string $typeName)

Get type id

Parameters

string $typeName

Return Value

integer

at line 230
string getConsolePath()

Get module console commands path

Return Value

string