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

ComponentsLibraryPackage

class ComponentsLibraryPackage extends Package implements PackageInterface

UI components library package class

Traits

ViewComponents
View components trait

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

from Package
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 extension 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 package.

from Package
bool
postInstall()

Run post install actions

from Package
bool
unInstall()

UnInstall package

from Package
bool
enable()

Enable package

from Package
bool
disable()

Disable package

from Package
bool
savePackageProperties()

Save package properties file

from Package
string
getViewPath(string|null $componentsType = null)

Get view path

from ViewComponents
string
getComponentsPath()

Get components path

from ViewComponents
string
getPagesPath()

Get pages path

from ViewComponents
string
getEmailsPath()

Get emails components path

from ViewComponents
string
getMacrosPath()

Get macros path

from ViewComponents
array
getMacros(string|null $path = null)

Scan directory and return macros list

from ViewComponents
array
getPages(string|null $parent = null)

Scan directory and return pages list

from ViewComponents
array
getEmails(string|null $parent = null)

Scan directory and return emails list

from ViewComponents
string
getComponentPath(string|null $componentName, string $type = 'components')

Get component path

from ViewComponents
array
getComponents(string|null $parent = null, string $type = 'components')

Scan directory and return components list

from ViewComponents
array
getComponentsRecursive(string|null $path = null)

Scan directory and return components list

from ViewComponents
array
getParams()

Get library params

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

in Package at line 76
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 40
Collection getProperties(bool $full = false)

Get extension 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

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

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

in ViewComponents at line 25
string getViewPath(string|null $componentsType = null)

Get view path

Parameters

string|null $componentsType

Return Value

string

in ViewComponents at line 47
string getComponentsPath()

Get components path

Return Value

string

in ViewComponents at line 57
string getPagesPath()

Get pages path

Return Value

string

in ViewComponents at line 67
string getEmailsPath()

Get emails components path

Return Value

string

in ViewComponents at line 77
string getMacrosPath()

Get macros path

Return Value

string

in ViewComponents at line 88
array getMacros(string|null $path = null)

Scan directory and return macros list

Parameters

string|null $path

Return Value

array

in ViewComponents at line 115
array getPages(string|null $parent = null)

Scan directory and return pages list

Parameters

string|null $parent

Return Value

array

in ViewComponents at line 126
array getEmails(string|null $parent = null)

Scan directory and return emails list

Parameters

string|null $parent

Return Value

array

in ViewComponents at line 138
string getComponentPath(string|null $componentName, string $type = 'components')

Get component path

Parameters

string|null $componentName
string $type

Return Value

string

in ViewComponents at line 153
array getComponents(string|null $parent = null, string $type = 'components')

Scan directory and return components list

Parameters

string|null $parent
string $type

Return Value

array

in ViewComponents at line 186
array getComponentsRecursive(string|null $path = null)

Scan directory and return components list

Parameters

string|null $path

Return Value

array

at line 29
array getParams()

Get library params

Return Value

array