API Documentation
\
Vegas
Application
Assets
Cli
EventsListener
Exception
Task
Exception
Db
Adapter
Mongo
Decorator
Helper
Exception
Mapping
DI
Scaffolding
Adapter
Exception
Service
Component
Exception
Http
Response
Mvc
Controller
Crud
Exception
Exception
Dispatcher
Events
Exception
Module
Router
Adapter
Exception
Route
View
Engine
Volt
Exception
Filter
Helper
Paginator
Adapter
Exception
Tag
Task
Util

\Vegas\Cli\TaskAction

Class Action

Summary

Methods
Properties
Constants
__construct()
getName()
getDescription()
addOption()
getOptions()
validate()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

__construct()

__construct( $name,  $description)

Constructor

Parameters

$name
$description

getName()

getName() : string

Returns name of action

Returns

string

getDescription()

getDescription() : string

Returns description of action

Returns

string

addOption()

addOption(\Vegas\Cli\Task\Option $option) : $this

Adds option for action

Parameters

\Vegas\Cli\Task\Option $option

Returns

$this

getOptions()

getOptions() : array

Returns available options for action

Returns

array

validate()

validate(array $args) : boolean

Validates current action options

Parameters

array $args

Throws

\Vegas\Cli\Task\Exception\MissingRequiredArgumentException
\Vegas\Cli\Task\Exception\InvalidArgumentException
\Vegas\Cli\Task\Exception\InvalidOptionException

Returns

boolean