PHP Interface Caffeinated\Modules\Contracts\Repository

Show file Open project: caffeinated/modules Interface Usage Examples

Public Methods

Method Description
all ( ) : Collection Get all modules.
count ( ) : integer Returns a count of all modules.
disable ( string $slug ) : boolean Disables the specified module.
disabled ( ) : Collection Get all disabled modules.
enable ( string $slug ) : boolean Enables the specified module.
enabled ( ) : Collection Get all enabled modules.
exists ( string $slug ) : boolean Determines if the given module exists.
get ( string $property, mixed | null $default = null ) : mixed | null Returns the given module property.
getManifest ( string $slug ) : Collection Returns the modules defined manifest properties.
isDisabled ( string $slug ) : boolean Determines if the specified module is disabled.
isEnabled ( string $slug ) : boolean Determines if the specified module is enabled.
optimize ( ) : boolean Get all module manifest properties and store in the respective container.
set ( string $property, mixed $value ) : boolean Set the given module property value.
slugs ( ) : Collection Get all module slugs.
sortBy ( string $key ) : Collection Sort modules by given key in ascending order.
sortByDesc ( string $key ) : Collection Sort modules by given key in ascending order.
where ( string $key, mixed $value ) : Collection Get modules based on where clause.

Method Details

all() public method

Get all modules.
public all ( ) : Collection
return Collection

count() public method

Returns a count of all modules.
public count ( ) : integer
return integer

disable() public method

Disables the specified module.
public disable ( string $slug ) : boolean
$slug string
return boolean

disabled() public method

Get all disabled modules.
public disabled ( ) : Collection
return Collection

enable() public method

Enables the specified module.
public enable ( string $slug ) : boolean
$slug string
return boolean

enabled() public method

Get all enabled modules.
public enabled ( ) : Collection
return Collection

exists() public method

Determines if the given module exists.
public exists ( string $slug ) : boolean
$slug string
return boolean

get() public method

Returns the given module property.
public get ( string $property, mixed | null $default = null ) : mixed | null
$property string
$default mixed | null
return mixed | null

getManifest() public method

Returns the modules defined manifest properties.
public getManifest ( string $slug ) : Collection
$slug string
return Collection

isDisabled() public method

Determines if the specified module is disabled.
public isDisabled ( string $slug ) : boolean
$slug string
return boolean

isEnabled() public method

Determines if the specified module is enabled.
public isEnabled ( string $slug ) : boolean
$slug string
return boolean

optimize() public method

Get all module manifest properties and store in the respective container.
public optimize ( ) : boolean
return boolean

set() public method

Set the given module property value.
public set ( string $property, mixed $value ) : boolean
$property string
$value mixed
return boolean

slugs() public method

Get all module slugs.
public slugs ( ) : Collection
return Collection

sortBy() public method

Sort modules by given key in ascending order.
public sortBy ( string $key ) : Collection
$key string
return Collection

sortByDesc() public method

Sort modules by given key in ascending order.
public sortByDesc ( string $key ) : Collection
$key string
return Collection

where() public method

Get modules based on where clause.
public where ( string $key, mixed $value ) : Collection
$key string
$value mixed
return Collection