Documentation

pkg extends cli
in package

FanPress CM cli help module

Tags
author

Stefan Seehafer sea75300@yahoo.de

copyright

(c) 2011-2022, Stefan Seehafer

license

http://www.gnu.org/licenses/gpl.txt GPLv3

since
3.5.1

Table of Contents

PARAM_CHGROLL  = '--chgroll'
CLI param: --chgroll
PARAM_CLEAN  = '--clean'
CLI param: --clean
PARAM_CLEAR  = '--clear'
CLI param: --clear
PARAM_DISABLE  = '--disable'
CLI param: --disable
PARAM_ENABLE  = '--enable'
CLI param: --enable
PARAM_EXEC  = '--exec'
CLI param: --exec
PARAM_INFO  = '--info'
CLI param: --info
PARAM_INSTALL  = '--install'
CLI param: --install
PARAM_LIST  = '--list'
CLI param: --list
PARAM_LISTROLLS  = '--listrolls'
CLI param: --chgroll
PARAM_PASSWD  = '--passwd'
CLI param: --passwd
PARAM_REMOVE  = '--remove'
CLI param: --remove
PARAM_SIZE  = '--size'
CLI param: --size
PARAM_TYPE_MODULE  = 'module'
CLI param: package manager type: module
PARAM_TYPE_MODULES  = 'modules'
CLI param: package manager type: modules (All modules)
PARAM_TYPE_SYSTEM  = 'system'
CLI param: package manager type: system
PARAM_UPDATE  = '--update'
CLI param: --update
PARAM_UPGRADE  = '--upgrade'
CLI param: --upgrade
PARAM_UPGRADE_DB  = '--upgrade-db'
CLI param: --upgrade-db
$cache  : cache
Cache object
$cacheModule  : string
Cache Modul
$cacheName  : string
Cache name
$config  : config
Config object
$data  : array<string|int, mixed>
Data array
$events  : events
Event list
$funcParams  : array<string|int, mixed>
Funktionsparameter
$language  : language
Sprachobjekt
$notifications  : notifications
Notifications
$permissions  : permissions
Permissions
$session  : session
Session objekt
$exSystem  : bool
Internal execution via system
$modulekey  : string
Moduel key string
$noMaintenanceMode  : array<string|int, mixed>
List of actions without maintenace mode enabled
$updaterMod  : modules
Module updater object
$updaterSys  : system
System updater object
__construct()  : void
Konstruktor
getCacheName()  : string
Cache-Name zurückgeben
help()  : array<string|int, mixed>
Hilfe-Text zurückgeben ausführen
process()  : void
Modul ausführen
boolText()  : string
Returns text by bool value
debug()  : mixed
CLI debug output
input()  : mixed
CLI input
output()  : mixed
CLI output
getModuleKey()  : bool
Returns module key by cli params and run check for existance
initObjects()  : bool
Initialize objects
processDeleteModule()  : bool
Process complete modul deletion
processInfoModule()  : bool
Displays information for given module key
processInstallModule()  : bool
Process module installation
processListLocal()  : bool
Process local module list output
processListRemote()  : bool
Process remote module list output
processListUpdatefs()  : bool
Process local file system for new modules
processModulePackage()  : bool
Process module package actions
processRemoveModule()  : bool
Process complete modul removal
processUpdate()  : bool
Process update check
processUpgradedbModule()  : bool
Run update finalizer
processUpgradedbSystem()  : bool
Run system database update
processUpgradeModule()  : bool
Process module update
processUpgradeModules()  : bool
Process module update
processUpgradeSystem()  : bool
Process full system update

Constants

PARAM_CHGROLL

CLI param: --chgroll

public mixed PARAM_CHGROLL = '--chgroll'

PARAM_CLEAN

CLI param: --clean

public mixed PARAM_CLEAN = '--clean'

PARAM_CLEAR

CLI param: --clear

public mixed PARAM_CLEAR = '--clear'

PARAM_DISABLE

CLI param: --disable

public mixed PARAM_DISABLE = '--disable'

PARAM_ENABLE

CLI param: --enable

public mixed PARAM_ENABLE = '--enable'

PARAM_EXEC

CLI param: --exec

public mixed PARAM_EXEC = '--exec'

PARAM_INFO

CLI param: --info

public mixed PARAM_INFO = '--info'

PARAM_INSTALL

CLI param: --install

public mixed PARAM_INSTALL = '--install'

PARAM_LIST

CLI param: --list

public mixed PARAM_LIST = '--list'

PARAM_LISTROLLS

CLI param: --chgroll

public mixed PARAM_LISTROLLS = '--listrolls'

PARAM_PASSWD

CLI param: --passwd

public mixed PARAM_PASSWD = '--passwd'

PARAM_REMOVE

CLI param: --remove

public mixed PARAM_REMOVE = '--remove'

PARAM_SIZE

CLI param: --size

public mixed PARAM_SIZE = '--size'

PARAM_TYPE_MODULE

CLI param: package manager type: module

public mixed PARAM_TYPE_MODULE = 'module'

PARAM_TYPE_MODULES

CLI param: package manager type: modules (All modules)

public mixed PARAM_TYPE_MODULES = 'modules'

PARAM_TYPE_SYSTEM

CLI param: package manager type: system

public mixed PARAM_TYPE_SYSTEM = 'system'

PARAM_UPDATE

CLI param: --update

public mixed PARAM_UPDATE = '--update'

PARAM_UPGRADE

CLI param: --upgrade

public mixed PARAM_UPGRADE = '--upgrade'

PARAM_UPGRADE_DB

CLI param: --upgrade-db

public mixed PARAM_UPGRADE_DB = '--upgrade-db'

Properties

$cacheModule

Cache Modul

protected string $cacheModule = ''
Tags
since
3.4

$cacheName

Cache name

protected string $cacheName = false

$data

Data array

protected array<string|int, mixed> $data

$funcParams

Funktionsparameter

protected array<string|int, mixed> $funcParams = []

$exSystem

Internal execution via system

private bool $exSystem

$modulekey

Moduel key string

private string $modulekey

$noMaintenanceMode

List of actions without maintenace mode enabled

private array<string|int, mixed> $noMaintenanceMode = [self::PARAM_UPDATE, self::PARAM_LIST, self::PARAM_INFO]

$updaterMod

Module updater object

private modules $updaterMod

$updaterSys

System updater object

private system $updaterSys

Methods

__construct()

Konstruktor

public __construct() : void
Return values
void

getCacheName()

Cache-Name zurückgeben

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

help()

Hilfe-Text zurückgeben ausführen

public help() : array<string|int, mixed>
Return values
array<string|int, mixed>

process()

Modul ausführen

public process() : void
Return values
void

boolText()

Returns text by bool value

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

debug()

CLI debug output

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

input()

CLI input

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

output()

CLI output

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

getModuleKey()

Returns module key by cli params and run check for existance

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

initObjects()

Initialize objects

private initObjects() : bool
Return values
bool

processDeleteModule()

Process complete modul deletion

private processDeleteModule() : bool
Return values
bool

processInfoModule()

Displays information for given module key

private processInfoModule() : bool
Return values
bool

processInstallModule()

Process module installation

private processInstallModule() : 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

processListUpdatefs()

Process local file system for new modules

private processListUpdatefs() : bool
Return values
bool

processModulePackage()

Process module package actions

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

processRemoveModule()

Process complete modul removal

private processRemoveModule() : bool
Return values
bool

processUpdate()

Process update check

private processUpdate() : bool
Return values
bool

processUpgradedbModule()

Run update finalizer

private processUpgradedbModule() : bool
Return values
bool

processUpgradedbSystem()

Run system database update

private processUpgradedbSystem() : bool
Return values
bool

processUpgradeModule()

Process module update

private processUpgradeModule() : bool
Return values
bool

processUpgradeModules()

Process module update

private processUpgradeModules() : bool
Tags
since
4.5-b8
Return values
bool

processUpgradeSystem()

Process full system update

private processUpgradeSystem() : bool
Return values
bool

Search results