PHP Class Nwidart\Modules\Publishing\Publisher

Inheritance: implements Nwidart\Modules\Contracts\PublisherInterface
Show file Open project: nwidart/laravel-modules

Protected Properties

Property Type Description
$console Illuminate\Console\Command The laravel console instance.
$error string The error message will displayed at console.
$module string The name of module will used.
$repository Nwidart\Modules\Repository The modules repository instance.
$showMessage boolean Determine whether the result message will shown in the console.
$success string The success message will displayed at console.

Public Methods

Method Description
__construct ( Module $module ) The constructor.
getConsole ( ) : Illuminate\Console\Command Get console instance.
getDestinationPath ( ) : string Get destination path.
getFilesystem ( ) : Illuminate\Filesystem\Filesystem Get laravel filesystem instance.
getModule ( ) : Module Get module instance.
getRepository ( ) : Repository Get modules repository instance.
getSourcePath ( ) : string Get source path.
hideMessage ( ) : self Hide the result message.
publish ( ) Publish something.
setConsole ( Illuminate\Console\Command $console ) Set console instance.
setRepository ( Repository $repository ) Set modules repository instance.
showMessage ( ) : self Show the result message.

Method Details

__construct() public method

The constructor.
public __construct ( Module $module )
$module Nwidart\Modules\Module

getConsole() public method

Get console instance.
public getConsole ( ) : Illuminate\Console\Command
return Illuminate\Console\Command

getDestinationPath() abstract public method

Get destination path.
abstract public getDestinationPath ( ) : string
return string

getFilesystem() public method

Get laravel filesystem instance.
public getFilesystem ( ) : Illuminate\Filesystem\Filesystem
return Illuminate\Filesystem\Filesystem

getModule() public method

Get module instance.
public getModule ( ) : Module
return Nwidart\Modules\Module

getRepository() public method

Get modules repository instance.
public getRepository ( ) : Repository
return Nwidart\Modules\Repository

getSourcePath() abstract public method

Get source path.
abstract public getSourcePath ( ) : string
return string

hideMessage() public method

Hide the result message.
public hideMessage ( ) : self
return self

publish() public method

Publish something.
public publish ( )

setConsole() public method

Set console instance.
public setConsole ( Illuminate\Console\Command $console )
$console Illuminate\Console\Command

setRepository() public method

Set modules repository instance.
public setRepository ( Repository $repository )
$repository Nwidart\Modules\Repository

showMessage() public method

Show the result message.
public showMessage ( ) : self
return self

Property Details

$console protected property

The laravel console instance.
protected Command,Illuminate\Console $console
return Illuminate\Console\Command

$error protected property

The error message will displayed at console.
protected string $error
return string

$module protected property

The name of module will used.
protected string $module
return string

$repository protected property

The modules repository instance.
protected Repository,Nwidart\Modules $repository
return Nwidart\Modules\Repository

$showMessage protected property

Determine whether the result message will shown in the console.
protected bool $showMessage
return boolean

$success protected property

The success message will displayed at console.
protected string $success
return string