Arikaim CMS

ComponentsLibraryPackage extends Package
in package
implements PackageInterface Uses ViewComponents

UI components library package 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
$viewPath  : string|null
View path

Methods

__construct()  : mixed
Constructor
disable()  : bool
Disable package
enable()  : bool
Enable package
getComponentPath()  : string
Get component path
getComponents()  : array<string|int, mixed>
Scan directory and return components list
getComponentsPath()  : string
Get components path
getComponentsRecursive()  : array<string|int, mixed>
Scan directory and return components list
getDrivers()  : array<string|int, mixed>
Get drivers classes list
getEmails()  : array<string|int, mixed>
Scan directory and return emails list
getEmailsPath()  : string
Get emails components path
getInstalOrder()  : mixed
Get install order
getLanguages()  : array<string|int, mixed>|null
Get suppported languages
getMacros()  : array<string|int, mixed>
Scan directory and return macros list
getMacrosPath()  : string
Get macros path
getName()  : string
Return package name
getPages()  : array<string|int, mixed>
Scan directory and return pages list
getPagesPath()  : string
Get pages path
getParams()  : array<string|int, mixed>
Get library params
getPath()  : string
Get package root path
getProperties()  : Collection
Get extension package properties
getProperty()  : mixed
Get package property
getRequire()  : CollectionInterface
Get require property
getType()  : string|null
Get package type
getVersion()  : string
Get Package version
getViewPath()  : string
Get view path
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

$path

Package root path

protected string $path

Methods

disable()

Disable package

public disable() : bool
Return values
bool

enable()

Enable package

public enable() : bool
Return values
bool

getComponentPath()

Get component path

public getComponentPath(string|null $componentName[, string $type = 'components' ]) : string
Parameters
$componentName : string|null
$type : string = 'components'
Return values
string

getComponents()

Scan directory and return components list

public getComponents([string|null $parent = null ][, string $type = 'components' ]) : array<string|int, mixed>
Parameters
$parent : string|null = null
$type : string = 'components'
Return values
array<string|int, mixed>

getComponentsPath()

Get components path

public getComponentsPath() : string
Return values
string

getComponentsRecursive()

Scan directory and return components list

public getComponentsRecursive([string|null $path = null ]) : array<string|int, mixed>
Parameters
$path : string|null = null
Return values
array<string|int, mixed>

getDrivers()

Get drivers classes list

public getDrivers() : array<string|int, mixed>
Return values
array<string|int, mixed>

getEmails()

Scan directory and return emails list

public getEmails([string|null $parent = null ]) : array<string|int, mixed>
Parameters
$parent : string|null = null
Return values
array<string|int, mixed>

getEmailsPath()

Get emails components path

public getEmailsPath() : string
Return values
string

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>|null

getMacros()

Scan directory and return macros list

public getMacros([string|null $path = null ]) : array<string|int, mixed>
Parameters
$path : string|null = null
Return values
array<string|int, mixed>

getMacrosPath()

Get macros path

public getMacrosPath() : string
Return values
string

getName()

Return package name

public getName() : string
Return values
string

getPages()

Scan directory and return pages list

public getPages([string|null $parent = null ]) : array<string|int, mixed>
Parameters
$parent : string|null = null
Return values
array<string|int, mixed>

getPagesPath()

Get pages path

public getPagesPath() : string
Return values
string

getParams()

Get library params

public getParams() : array<string|int, mixed>
Return values
array<string|int, mixed>

getPath()

Get package root path

public getPath() : string
Return values
string

getProperties()

Get extension package properties

public getProperties([bool $full = false ]) : Collection
Parameters
$full : bool = false
Return values
Collection

getProperty()

Get package property

public getProperty(string $name[, mixed $default = null ]) : mixed
Parameters
$name : string
$default : mixed = null

getType()

Get package type

public getType() : string|null
Return values
string|null

getVersion()

Get Package version

public getVersion() : string
Return values
string

getViewPath()

Get view path

public getViewPath([string|null $componentsType = null ]) : string
Parameters
$componentsType : string|null = null
Return values
string

install()

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
bool

postInstall()

Run post install actions

public postInstall() : bool
Return values
bool

savePackageProperties()

Save package properties file

public savePackageProperties() : bool
Return values
bool

setPrimary()

Set package as primary

public setPrimary() : bool
Return values
bool

unInstall()

UnInstall package

public unInstall() : bool
Return values
bool

validate()

Validate package properties

public validate() : bool
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results