Documentation

pkg extends cli
in

FanPress CM cli help module

Table of Contents

$updaterSys System updater object system
$updaterMod Module updater object modules
$modulekey Moduel key string string
$exSystem Internal execution via system bool
$noMaintenanceMode List of actions without maintenace mode enabled 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
initObjects() Initialize objects bool
process() Modul ausführen void
processUpdate() Process update check bool
processUpgradeSystem() Process full system update bool
processUpgradedbSystem() Run system database update bool
processUpgradedbModule() Run update finalizer bool
processListUpdatefs() Process local file system for new modules bool
processListLocal() Process local module list output bool
processListRemote() Process remote module list output bool
processInfoModule() Displays information for given module key bool
moduleslIstDetails() Displays information for given module mixed
processInstallModule() Process module installation bool
processUpgradeModule() Process module update bool
processModulePackage() Process module package actions bool
getModuleKey() Returns module key by cli params and run check for existance bool
processRemoveModule() Process complete modul removal bool
processDeleteModule() Process complete modul deletion bool
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

$updaterSys

System updater object

private system $updaterSys

$updaterMod

Module updater object

private modules $updaterMod

$modulekey

Moduel key string

private string $modulekey

$exSystem

Internal execution via system

private bool $exSystem

$noMaintenanceMode

List of actions without maintenace mode enabled

private array $noMaintenanceMode = [self::PARAM_UPDATE, self::PARAM_LIST, self::PARAM_INFO]

$funcParams

Funktionsparameter

protected array $funcParams = []

$cacheName

Cache name

protected string $cacheName = false

$cacheModule

Cache Modul

protected string $cacheModule = ''

Methods

initObjects()

Initialize objects

private initObjects( ) : bool
Return values
bool

process()

Modul ausführen

public process( ) : void

processUpdate()

Process update check

private processUpdate( ) : bool
Return values
bool

processUpgradeSystem()

Process full system update

private processUpgradeSystem( ) : bool
Return values
bool

processUpgradedbSystem()

Run system database update

private processUpgradedbSystem( ) : bool
Return values
bool

processUpgradedbModule()

Run update finalizer

private processUpgradedbModule( ) : bool
Return values
bool

processListUpdatefs()

Process local file system for new modules

private processListUpdatefs( ) : bool
Return values
bool

processListLocal()

Process local module list output

private processListLocal( ) : bool
Return values
bool

processListRemote()

Process remote module list output

private processListRemote( ) : bool
Return values
bool

processInfoModule()

Displays information for given module key

private processInfoModule( ) : bool
Return values
bool

moduleslIstDetails()

Displays information for given module

private moduleslIstDetails( $module : module [, $remote : bool = false ] [, $descr : bool = false ] ) : mixed
Parameters
$module : module
$remote : bool = false
$descr : bool = false
Return values
mixed

processInstallModule()

Process module installation

private processInstallModule( ) : bool
Return values
bool

processUpgradeModule()

Process module update

private processUpgradeModule( ) : bool
Return values
bool

processModulePackage()

Process module package actions

private processModulePackage( $mode : string [, $checkFiles : bool = false ] ) : bool
Parameters
$mode : string
$checkFiles : bool = false
Return values
bool

getModuleKey()

Returns module key by cli params and run check for existance

private getModuleKey( [ $pos : int = 2 ] ) : bool
Parameters
$pos : int = 2
Return values
bool

processRemoveModule()

Process complete modul removal

private processRemoveModule( ) : bool
Return values
bool

processDeleteModule()

Process complete modul deletion

private processDeleteModule( ) : bool
Return values
bool

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