API Documentation
\
Phug
Ast
Compiler
Element
Event
Locator
NodeCompiler
Util
DependencyInjection
Event
Formatter
Element
Event
Format
Partial
Util
Lexer
Analyzer
Event
Partial
Scanner
Partial
Token
Parser
Event
Node
TokenHandler
Partial
Renderer
Adapter
Stream
Event
Partial
Debug
Profiler
Task
Test
Util
Exception
Partial

\PhugCli

Summary

Methods
Properties
Constants
__construct()
getCustomMethods()
run()
getAvailableMethods()
listAvailableMethods()
No public properties found
No constants found
convertToKebabCase()
convertToCamelCase()
execute()
getNamedArgumentBySpaceDelimiter()
getNamedArgumentByEqualOperator()
getNamedArgument()
$facade
$methods
N/A
No private methods found
No private properties found
N/A

Properties

$facade

$facade : string

The facade class name that the cli application will call the methods on.

Type

string

$methods

$methods : array

List of available methods/actions in the cli application.

Type

array

Methods

__construct()

__construct(string  $facade, array  $methods)

Cli application constructor. Needs a facade name and a methods list.

Parameters

string $facade
array $methods

getCustomMethods()

getCustomMethods() : array

Get list of user-defined commands.

Returns

array

run()

run(  $arguments) : boolean

Run the CLI applications with arguments list, return true for a success status, false for an error status.

Parameters

$arguments

Returns

boolean

getAvailableMethods()

getAvailableMethods(array|null  $customMethods = null) : \Phug\iterable

Yield all available methods.

Parameters

array|null $customMethods

pass custom methods list (calculated from the facade if missing)

Returns

\Phug\iterable

listAvailableMethods()

listAvailableMethods(array|null  $customMethods = null)

Dump the list of available methods as textual output.

Parameters

array|null $customMethods

pass custom methods list (calculated from the facade if missing)

convertToKebabCase()

convertToKebabCase(  $string)

Parameters

$string

convertToCamelCase()

convertToCamelCase(  $string)

Parameters

$string

execute()

execute(  $facade,   $method,   $arguments,   $outputFile)

Parameters

$facade
$method
$arguments
$outputFile

getNamedArgumentBySpaceDelimiter()

getNamedArgumentBySpaceDelimiter(array  $arguments,   $index,   $name)

Parameters

array $arguments
$index
$name

getNamedArgumentByEqualOperator()

getNamedArgumentByEqualOperator(array  $arguments,   $index,   $name)

Parameters

array $arguments
$index
$name

getNamedArgument()

getNamedArgument(array  $arguments, array  $names)

Parameters

array $arguments
array $names