PHP Interface Nwidart\Modules\Contracts\RepositoryInterface

Show file Open project: nwidart/laravel-modules

Public Methods

Method Description
all ( ) : mixed Get all modules.
count ( ) : integer Get count from all modules.
disabled ( ) : mixed Get list of disabled modules.
enabled ( ) : mixed Get list of enabled modules.
find ( $name ) : mixed Find a specific module.
findOrFail ( $name ) : mixed Find a specific module. If there return that, otherwise throw exception.
getByStatus ( integer $status ) : mixed Get modules by the given status.
getCached ( ) : array Get cached modules.
getOrdered ( ) : mixed Get all ordered modules.
getScanPaths ( ) : array Get scanned paths.
scan ( ) : array Scan & get all available modules.
toCollection ( ) : Collection Get modules as modules collection instance.

Method Details

all() public method

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

count() public method

Get count from all modules.
public count ( ) : integer
return integer

disabled() public method

Get list of disabled modules.
public disabled ( ) : mixed
return mixed

enabled() public method

Get list of enabled modules.
public enabled ( ) : mixed
return mixed

find() public method

Find a specific module.
public find ( $name ) : mixed
$name
return mixed

findOrFail() public method

Find a specific module. If there return that, otherwise throw exception.
public findOrFail ( $name ) : mixed
$name
return mixed

getByStatus() public method

Get modules by the given status.
public getByStatus ( integer $status ) : mixed
$status integer
return mixed

getCached() public method

Get cached modules.
public getCached ( ) : array
return array

getOrdered() public method

Get all ordered modules.
public getOrdered ( ) : mixed
return mixed

getScanPaths() public method

Get scanned paths.
public getScanPaths ( ) : array
return array

scan() public method

Scan & get all available modules.
public scan ( ) : array
return array

toCollection() public method

Get modules as modules collection instance.
public toCollection ( ) : Collection
return Nwidart\Modules\Collection