PHP Interface Caffeinated\Modules\Contracts\Repository

Afficher le fichier Open project: caffeinated/modules Interface Usage Examples

Méthodes publiques

Méthode 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 méthode

Get all modules.
public all ( ) : Collection
Résultat Collection

count() public méthode

Returns a count of all modules.
public count ( ) : integer
Résultat integer

disable() public méthode

Disables the specified module.
public disable ( string $slug ) : boolean
$slug string
Résultat boolean

disabled() public méthode

Get all disabled modules.
public disabled ( ) : Collection
Résultat Collection

enable() public méthode

Enables the specified module.
public enable ( string $slug ) : boolean
$slug string
Résultat boolean

enabled() public méthode

Get all enabled modules.
public enabled ( ) : Collection
Résultat Collection

exists() public méthode

Determines if the given module exists.
public exists ( string $slug ) : boolean
$slug string
Résultat boolean

get() public méthode

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

getManifest() public méthode

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

isDisabled() public méthode

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

isEnabled() public méthode

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

optimize() public méthode

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

set() public méthode

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

slugs() public méthode

Get all module slugs.
public slugs ( ) : Collection
Résultat Collection

sortBy() public méthode

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

sortByDesc() public méthode

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

where() public méthode

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