PHP Class Nwidart\Modules\Module

Inheritance: extends Illuminate\Support\ServiceProvider
Afficher le fichier Open project: nwidart/laravel-modules Class Usage Examples

Protected Properties

Свойство Type Description
$app Illuminate\Foundation\Application The laravel application instance.
$name The module name.
$path string The module path,.

Méthodes publiques

Méthode Description
__construct ( Illuminate\Foundation\Application $app, $name, $path ) The constructor.
__get ( $key ) : mixed Handle call to __get method.
__toString ( ) : string Handle call __toString.
active ( ) : boolean Alternate for "enabled" method.
boot ( ) Bootstrap the application events.
delete ( ) : boolean Delete the current module.
disable ( ) : boolean Disable the current module.
disabled ( ) : boolean Alias for "notActive" method.
enable ( ) Enable the current module.
enabled ( ) : boolean Determine whether the current module activated.
get ( $key, null $default = null ) : mixed Get a specific data from json file by given the key.
getAlias ( ) : string Get alias.
getComposerAttr ( $key, null $default = null ) : mixed Get a specific data from composer.json file by given the key.
getDescription ( ) : string Get description.
getExtraPath ( $path ) : string Get extra path.
getLaravel ( ) : Illuminate\Foundation\Application Get laravel instance.
getLowerName ( ) : string Get name in lower case.
getName ( ) : string Get name.
getPath ( ) : string Get path.
getPriority ( ) : string Get priority.
getStudlyName ( ) : string Get name in studly case.
isStatus ( $status ) : boolean Determine whether the given status same with the current module status.
json ( $file = null ) : Json Get json contents.
notActive ( ) : boolean Determine whether the current module not activated.
register ( ) Register the module.
setActive ( $active ) : boolean Set active state for current module.
setPath ( string $path ) Set path.

Méthodes protégées

Méthode Description
fireEvent ( string $event ) Register the module event.
registerAliases ( ) Register the aliases from this module.
registerFiles ( ) Register the files from this module.
registerProviders ( ) Register the service providers from this module.
registerTranslation ( ) : void Register module's translation.

Method Details

__construct() public méthode

The constructor.
public __construct ( Illuminate\Foundation\Application $app, $name, $path )
$app Illuminate\Foundation\Application
$name
$path

__get() public méthode

Handle call to __get method.
public __get ( $key ) : mixed
$key
Résultat mixed

__toString() public méthode

Handle call __toString.
public __toString ( ) : string
Résultat string

active() public méthode

Alternate for "enabled" method.
public active ( ) : boolean
Résultat boolean

boot() public méthode

Bootstrap the application events.
public boot ( )

delete() public méthode

Delete the current module.
public delete ( ) : boolean
Résultat boolean

disable() public méthode

Disable the current module.
public disable ( ) : boolean
Résultat boolean

disabled() public méthode

Alias for "notActive" method.
public disabled ( ) : boolean
Résultat boolean

enable() public méthode

Enable the current module.
public enable ( )

enabled() public méthode

Determine whether the current module activated.
public enabled ( ) : boolean
Résultat boolean

fireEvent() protected méthode

Register the module event.
protected fireEvent ( string $event )
$event string

get() public méthode

Get a specific data from json file by given the key.
public get ( $key, null $default = null ) : mixed
$key
$default null
Résultat mixed

getAlias() public méthode

Get alias.
public getAlias ( ) : string
Résultat string

getComposerAttr() public méthode

Get a specific data from composer.json file by given the key.
public getComposerAttr ( $key, null $default = null ) : mixed
$key
$default null
Résultat mixed

getDescription() public méthode

Get description.
public getDescription ( ) : string
Résultat string

getExtraPath() public méthode

Get extra path.
public getExtraPath ( $path ) : string
$path
Résultat string

getLaravel() public méthode

Get laravel instance.
public getLaravel ( ) : Illuminate\Foundation\Application
Résultat Illuminate\Foundation\Application

getLowerName() public méthode

Get name in lower case.
public getLowerName ( ) : string
Résultat string

getName() public méthode

Get name.
public getName ( ) : string
Résultat string

getPath() public méthode

Get path.
public getPath ( ) : string
Résultat string

getPriority() public méthode

Get priority.
public getPriority ( ) : string
Résultat string

getStudlyName() public méthode

Get name in studly case.
public getStudlyName ( ) : string
Résultat string

isStatus() public méthode

Determine whether the given status same with the current module status.
public isStatus ( $status ) : boolean
$status
Résultat boolean

json() public méthode

Get json contents.
public json ( $file = null ) : Json
Résultat Json

notActive() public méthode

Determine whether the current module not activated.
public notActive ( ) : boolean
Résultat boolean

register() public méthode

Register the module.
public register ( )

registerAliases() protected méthode

Register the aliases from this module.
protected registerAliases ( )

registerFiles() protected méthode

Register the files from this module.
protected registerFiles ( )

registerProviders() protected méthode

Register the service providers from this module.
protected registerProviders ( )

registerTranslation() protected méthode

Register module's translation.
protected registerTranslation ( ) : void
Résultat void

setActive() public méthode

Set active state for current module.
public setActive ( $active ) : boolean
$active
Résultat boolean

setPath() public méthode

Set path.
public setPath ( string $path )
$path string

Property Details

$app protected_oe property

The laravel application instance.
protected Application,Illuminate\Foundation $app
Résultat Illuminate\Foundation\Application

$name protected_oe property

The module name.
protected $name

$path protected_oe property

The module path,.
protected string $path
Résultat string