Documentation

help extends cli
in

FanPress CM cli help module

Table of Contents

$exclude Exclude cli classes from help array
$funcParams Funktionsparameter array
$data Data array array
$cache Cache object cache
$events Event list events
$config Config object config
$language Sprachobjekt language
$session Session objekt session
$notifications Notifications notifications
$permissions Permissions permissions
$cacheName Cache name string
$cacheModule Cache Modul string
process() Modul ausführen void
help() Hilfe-Text zurückgeben ausführen array
__construct() Konstruktor void
process() Modul ausführen void
help() Hilfe-Text zurückgeben ausführen array
output() CLI output mixed
debug() CLI debug output mixed
input() CLI input mixed
boolText() Returns text by bool value string
getCacheName() Cache-Name zurückgeben string

Properties

$exclude

Exclude cli classes from help

private array $exclude = ['help', 'io', 'progress']

$funcParams

Funktionsparameter

protected array $funcParams = []

$cacheName

Cache name

protected string $cacheName = false

$cacheModule

Cache Modul

protected string $cacheModule = ''

Methods

process()

Modul ausführen

public process( ) : void

help()

Hilfe-Text zurückgeben ausführen

public help( ) : array
Return values
array

__construct()

Konstruktor

public __construct( ) : void

process()

Modul ausführen

public abstract process( ) : void

help()

Hilfe-Text zurückgeben ausführen

public abstract help( ) : array
Return values
array

output()

CLI output

protected output( $str : string [, $exit : bool = false ] ) : mixed
Parameters
$str : string
$exit : bool = false
Return values
mixed

debug()

CLI debug output

protected debug( $str : string [, $exit : bool = false ] ) : mixed
Parameters
$str : string
$exit : bool = false
Return values
mixed

input()

CLI input

protected input( $str : string ) : mixed
Parameters
$str : string
Return values
mixed

boolText()

Returns text by bool value

protected boolText( $value : bool ) : string
Parameters
$value : bool
Return values
string

getCacheName()

Cache-Name zurückgeben

public getCacheName( [ $addName : string = '' ] ) : string
Parameters
$addName : string = ''
Return values
string

Search results