\FASS_Command

Базовый класс, отвечающий за выполнение команд.

Внимание! Все методы данного класса должны начинаться с нижнего подчеркивания (_) чтобы исключить возможность вызова их через http-запрос.

Summary

Methods
Properties
Constants
__construct()
_isInternal()
_isNeedLogin()
_execute()
_checkPermission()
_onBeforeAction()
_onAfterAction()
_onError()
_onSystemError()
No public properties found
No constants found
No protected methods found
$needLogin
$internal
N/A
No private methods found
$class
$method
$is_gen
N/A

Properties

$needLogin

$needLogin : integer

Нужна ли авторизация

Type

integer — (0/1, default: 1)

$internal

$internal : integer

Внутрення команда, вызов разрешен только из другой команды

Type

integer — (0/1, default: 0)

$class

$class : string

Имя класса команды

Type

string

$method

$method : string

Имя метода

Type

string

$is_gen

$is_gen : boolean

Признак, что команда сгенерированна AppXML

Type

boolean

Methods

__construct()

__construct(string  $class, string  $method, string  $is_gen = false) 

Конструктор

Parameters

string $class

Имя класса команды

string $method

Имя метода

string $is_gen

Признак что команда автоматически сгенерированна AppXML

_isInternal()

_isInternal() : boolean

Возвращает true если команда является внутренней

Returns

boolean

_isNeedLogin()

_isNeedLogin() : boolean

Возвращает true если команда требует авторизации

Returns

boolean

_execute()

_execute(boolean  $log = false, string  $name = null) : \any

Выполнение обычной команды или сгененрированной AppXML.

Метод вызывается из FASS_Base::_execute()

Parameters

boolean $log
  • протоколировать ли начало и конец команды в cmd.log (по умолчанию логируется только в fass/index.php)
string $name
  • имя команды для логирования

Returns

\any —

Результат работы метода класса команды

_checkPermission()

_checkPermission() 

Для переопределения в потомках. Возвращает булевый флаг, что команда имеет право быть допущенной к выполненнию.

_onBeforeAction()

_onBeforeAction() 

Для переопределения в потомках. Событийный метод, возникающий после _checkPermission(), но перед _execute(). В зависимости от возвращенного флага фреймворк либо продолжает выполнение, либо прекращает.

_onAfterAction()

_onAfterAction() 

Для переопределения в потомках. Событийный метод, возникающий после _execute().

_onError()

_onError() 

Для переопределения в потомках. Событийный метод, возникающий при получении прикладного exception (т.е. сгенерированного программистом явно или неявно) процессе выполнения _execute().

_onSystemError()

_onSystemError() 

Для переопределения в потомках. Событийный метод, возникающий при получении системного exception (например, ошибка в php-коде или sql-команде) в процессе выполнения _execute().