Ubiquity 2.5.2
php rapid development framework
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Static Protected Member Functions | Protected Attributes | Static Protected Attributes
Command Class Reference

Define a command complete desciption. More...

Public Member Functions

 __construct (string $name='', string $value='', string $description='', array $aliases=[], array $parameters=[], array $examples=[], string $category='custom')
 
 simpleString ()
 
 longString ()
 
 getName ()
 
 getDescription ()
 
 getValue ()
 
 hasRequiredValue ()
 
 getAliases ()
 
 getParameters ()
 
 getExamples ()
 
 getCategory ()
 
 setCategory ($category)
 
 hasParameters ()
 
 hasValue ()
 
 isImmediate ()
 
 __toString ()
 

Static Public Member Functions

static getInfo ($cmd)
 
static project ()
 
static controller ()
 
static genModel ()
 
static model ()
 
static routes ()
 
static version ()
 
static allModels ()
 
static clearCache ()
 
static initCache ()
 
static serve ()
 
static liveReload ()
 
static selfUpdate ()
 
static admin ()
 
static help ()
 
static crudController ()
 
static indexCrudController ()
 
static restController ()
 
static restApiController ()
 
static dao ()
 
static authController ()
 
static newAction ()
 
static newDomain ()
 
static infoModel ()
 
static infoModels ()
 
static infoValidation ()
 
static configInfo ()
 
static configSet ()
 
static newTheme ()
 
static installTheme ()
 
static bootstrap ()
 
static composer ()
 
static mailer ()
 
static sendMails ()
 
static newMail ()
 
static newClass ()
 
static createCommand ()
 
static initAcls ()
 
static displayAcls ()
 
static newEncryptionKey ()
 
static infoMigrations ()
 
static migrations ()
 
static templateParser ()
 
static getCustomCommands ()
 
static reloadCustomCommands (array $config=[])
 
static getCustomAliases ()
 
static preloadCustomCommands (array $config=[])
 
static getCommandNames (array $excludedCategories=['installation'=> false, 'servers'=> false], $excludedCommands=[])
 
static getCommands ()
 

Static Protected Member Functions

static getCustomCommandInfos ()
 

Protected Attributes

 $name
 
 $description
 
 $value
 
 $aliases
 
 $parameters
 
 $examples
 
 $category
 

Static Protected Attributes

static $customCommands
 
static $customAliases
 

Detailed Description

Define a command complete desciption.

Ubiquity\devtools\cmd$Command This class is part of Ubiquity

Author
jc
Version
1.0.3

Definition at line 16 of file Command.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( string  $name = '',
string  $value = '',
string  $description = '',
array  $aliases = [],
array  $parameters = [],
array  $examples = [],
string  $category = 'custom' 
)

Definition at line 36 of file Command.php.

Member Function Documentation

◆ __toString()

__toString ( )

Definition at line 1008 of file Command.php.

◆ admin()

static admin ( )
static

Definition at line 337 of file Command.php.

◆ allModels()

static allModels ( )
static

Definition at line 244 of file Command.php.

◆ authController()

static authController ( )
static

Definition at line 463 of file Command.php.

◆ bootstrap()

static bootstrap ( )
static

Definition at line 640 of file Command.php.

◆ clearCache()

static clearCache ( )
static

Definition at line 261 of file Command.php.

◆ composer()

static composer ( )
static

Definition at line 649 of file Command.php.

◆ configInfo()

static configInfo ( )
static

Definition at line 582 of file Command.php.

◆ configSet()

static configSet ( )
static

Definition at line 596 of file Command.php.

◆ controller()

static controller ( )
static

Definition at line 154 of file Command.php.

◆ createCommand()

static createCommand ( )
static

Definition at line 707 of file Command.php.

◆ crudController()

static crudController ( )
static

Definition at line 347 of file Command.php.

◆ dao()

static dao ( )
static

Definition at line 445 of file Command.php.

◆ displayAcls()

static displayAcls ( )
static

Definition at line 738 of file Command.php.

◆ genModel()

static genModel ( )
static

Definition at line 173 of file Command.php.

◆ getAliases()

getAliases ( )
Returns
mixed

Definition at line 960 of file Command.php.

◆ getCategory()

getCategory ( )
Returns
mixed

Definition at line 984 of file Command.php.

◆ getCommandNames()

static getCommandNames ( array  $excludedCategories = [ 'installation' => false, 'servers' => false ],
  $excludedCommands = [] 
)
static

Definition at line 860 of file Command.php.

◆ getCommands()

static getCommands ( )
static

Definition at line 876 of file Command.php.

◆ getCustomAliases()

static getCustomAliases ( )
static

Definition at line 846 of file Command.php.

◆ getCustomCommandInfos()

static getCustomCommandInfos ( )
staticprotected

Definition at line 806 of file Command.php.

◆ getCustomCommands()

static getCustomCommands ( )
static

Definition at line 817 of file Command.php.

◆ getDescription()

getDescription ( )
Returns
mixed

Definition at line 937 of file Command.php.

◆ getExamples()

getExamples ( )
Returns
mixed

Definition at line 976 of file Command.php.

◆ getInfo()

static getInfo (   $cmd)
static

Definition at line 81 of file Command.php.

◆ getName()

getName ( )
Returns
mixed

Definition at line 929 of file Command.php.

◆ getParameters()

getParameters ( )
Returns
mixed

Definition at line 968 of file Command.php.

◆ getValue()

getValue ( )
Returns
mixed

Definition at line 945 of file Command.php.

◆ hasParameters()

hasParameters ( )

Definition at line 996 of file Command.php.

◆ hasRequiredValue()

hasRequiredValue ( )

Definition at line 952 of file Command.php.

◆ hasValue()

hasValue ( )

Definition at line 1000 of file Command.php.

◆ help()

static help ( )
static

Definition at line 341 of file Command.php.

◆ indexCrudController()

static indexCrudController ( )
static

Definition at line 382 of file Command.php.

◆ infoMigrations()

static infoMigrations ( )
static

Definition at line 767 of file Command.php.

◆ infoModel()

static infoModel ( )
static

Definition at line 524 of file Command.php.

◆ infoModels()

static infoModels ( )
static

Definition at line 542 of file Command.php.

◆ infoValidation()

static infoValidation ( )
static

Definition at line 560 of file Command.php.

◆ initAcls()

static initAcls ( )
static

Definition at line 722 of file Command.php.

◆ initCache()

static initCache ( )
static

Definition at line 282 of file Command.php.

◆ installTheme()

static installTheme ( )
static

Definition at line 626 of file Command.php.

◆ isImmediate()

isImmediate ( )

Definition at line 1004 of file Command.php.

◆ liveReload()

static liveReload ( )
static

Definition at line 319 of file Command.php.

◆ longString()

longString ( )

Definition at line 50 of file Command.php.

◆ mailer()

static mailer ( )
static

Definition at line 659 of file Command.php.

◆ migrations()

static migrations ( )
static

Definition at line 780 of file Command.php.

◆ model()

static model ( )
static

Definition at line 190 of file Command.php.

◆ newAction()

static newAction ( )
static

Definition at line 488 of file Command.php.

◆ newClass()

static newClass ( )
static

Definition at line 694 of file Command.php.

◆ newDomain()

static newDomain ( )
static

Definition at line 511 of file Command.php.

◆ newEncryptionKey()

static newEncryptionKey ( )
static

Definition at line 757 of file Command.php.

◆ newMail()

static newMail ( )
static

Definition at line 681 of file Command.php.

◆ newTheme()

static newTheme ( )
static

Definition at line 608 of file Command.php.

◆ preloadCustomCommands()

static preloadCustomCommands ( array  $config = [])
static

Definition at line 850 of file Command.php.

◆ project()

static project ( )
static

Definition at line 125 of file Command.php.

◆ reloadCustomCommands()

static reloadCustomCommands ( array  $config = [])
static

Definition at line 837 of file Command.php.

◆ restApiController()

static restApiController ( )
static

Definition at line 431 of file Command.php.

◆ restController()

static restController ( )
static

Definition at line 416 of file Command.php.

◆ routes()

static routes ( )
static

Definition at line 211 of file Command.php.

◆ selfUpdate()

static selfUpdate ( )
static

Definition at line 333 of file Command.php.

◆ sendMails()

static sendMails ( )
static

Definition at line 667 of file Command.php.

◆ serve()

static serve ( )
static

Definition at line 301 of file Command.php.

◆ setCategory()

setCategory (   $category)
Parameters
mixed$category

Definition at line 992 of file Command.php.

◆ simpleString()

simpleString ( )

Definition at line 46 of file Command.php.

◆ templateParser()

static templateParser ( )
static

Definition at line 792 of file Command.php.

◆ version()

static version ( )
static

Definition at line 240 of file Command.php.

Field Documentation

◆ $aliases

$aliases
protected

Definition at line 24 of file Command.php.

◆ $category

$category
protected

Definition at line 30 of file Command.php.

◆ $customAliases

$customAliases
staticprotected

Definition at line 34 of file Command.php.

◆ $customCommands

$customCommands
staticprotected

Definition at line 32 of file Command.php.

◆ $description

$description
protected

Definition at line 20 of file Command.php.

◆ $examples

$examples
protected

Definition at line 28 of file Command.php.

◆ $name

$name
protected

Definition at line 18 of file Command.php.

◆ $parameters

$parameters
protected

Definition at line 26 of file Command.php.

◆ $value

$value
protected

Definition at line 22 of file Command.php.

The documentation for this class was generated from the following file: