Arikaim CMS

PackageInterface

Package interface, all packages type should impelement it.

Table of Contents

Methods

disable()  : bool
Disable package
enable()  : bool
Enable package
getDrivers()  : array<string|int, mixed>
Get drivers classes list
getName()  : string
Return package name
getProperties()  : Collection
Return package properties
getRequire()  : CollectionInterface
Get require property
getType()  : string|null
Get package type
getVersion()  : string
Get Package version
install()  : mixed
Install package
isInstalled()  : bool
Return true if package is installed
postInstall()  : bool
Run post install actions
setPrimary()  : bool
Set package as primary
unInstall()  : bool
Unintsll package
validate()  : bool
Validate package properties

Methods

getDrivers()

Get drivers classes list

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

getName()

Return package name

public getName() : string
Return values
string

getProperties()

Return package properties

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

getRequire()

Get require property

public getRequire() : CollectionInterface
Return values
CollectionInterface

getType()

Get package type

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

getVersion()

Get Package version

public getVersion() : string
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

setPrimary()

Set package as primary

public setPrimary() : bool
Return values
bool

unInstall()

Unintsll package

public unInstall() : bool
Return values
bool

validate()

Validate package properties

public validate() : bool
Return values
bool

        
On this page

Search results