ControllerAction
class ControllerAction
Controller Action base Class
Traits
Properties
string | $configPath | from ConfigMaker | |
protected | $configFileExtension | from ConfigMaker | |
array | $vars | from ViewMaker | |
array | $viewPath | from ViewMaker | |
array | $layoutPath | from ViewMaker | |
array | $partialPath | from ViewMaker | |
string | $layout | from ViewMaker | |
bool | $suppressLayout | from ViewMaker | |
protected | $viewFileExtension | from ViewMaker | |
static protected array | $extensionCallbacks | from ExtensionTrait | |
static string | $extendableStaticCalledClass | from ExtensionTrait | |
protected | $extensionHidden | from ExtensionTrait | |
protected Controller | $controller | ||
protected array | $config | ||
protected array | $requiredProperties |
Methods
Reads the contents of the supplied file and applies it to this object.
Reads the contents of the supplied file and applies it to this object.
Merges two configuration sources, either prepared or not, and returns them as a single configuration object.
Locates a file based on it's definition. If the file starts with the ~ symbol it will be returned in context of the application base path, otherwise it will be returned in context of the config path.
Guess the package path for the called class.
Guess the package path from a specified class.
Guess the package path from a specified class.
Render a layout.
Render a partial file contents located in the views or partial folder.
Includes a file path using output buffering.
Makes a widget object with the supplied configuration ex. model config
Makes a form widget object with the supplied form field and widget configuration.
Helper method for ::extend()
static method
ControllerAction constructor.
Sets the widget configuration values
Get the widget configuration values.
Protects a public method from being available as an controller method.
Details
in
ConfigMaker at line 27
array
loadConfig(array $configFile = [], array $requiredConfig = [], null $index = null)
Reads the contents of the supplied file and applies it to this object.
in
ConfigMaker at line 46
array
makeConfig(string|array $configFile, array $requiredConfig = [])
Reads the contents of the supplied file and applies it to this object.
in
ConfigMaker at line 97
array
mergeConfig($configLeft, $configRight)
Merges two configuration sources, either prepared or not, and returns them as a single configuration object.
in
ConfigMaker at line 116
string
getConfigPath(string $fileName, mixed $configPath = null)
Locates a file based on it's definition. If the file starts with the ~ symbol it will be returned in context of the application base path, otherwise it will be returned in context of the config path.
in
ConfigMaker at line 154
string
guessConfigPath(string $suffix = '')
Guess the package path for the called class.
in
ConfigMaker at line 169
string
guessConfigPathFrom(string $class, string $suffix = '')
Guess the package path from a specified class.
in
ViewMaker at line 50
getViewPath($view, $viewPath = null)
No description
in
ViewMaker at line 78
guessViewFileExtension($path)
No description
in
ViewMaker at line 100
string
guessViewPath(string $suffix = '', bool $isPublic = FALSE)
Guess the package path from a specified class.
in
ViewMaker at line 121
mixed
makeLayout(string $name = null, array $vars = [], bool $throwException = TRUE)
Render a layout.
in
ViewMaker at line 149
string
makeView(string $view)
Loads a view with the name specified.
Applies layout if its name is provided by the parent object. The view file must be situated in the views directory, and has the extension "htm" or "php".
in
ViewMaker at line 173
mixed
makePartial(string $partial, array $vars = [], bool $throwException = TRUE)
Render a partial file contents located in the views or partial folder.
in
ViewMaker at line 201
string
makeFileContent(string $filePath, array $extraParams = [])
Includes a file path using output buffering.
Ensures that vars are available.
in
ViewMaker at line 239
compileFileContent($filePath)
No description
in
ViewMaker at line 260
protected void
handleViewException(Exception $e, int $obLevel)
Handle a view exception.
in
ViewMaker at line 275
protected array
gatherViewData($data)
Get the data bound to the view instance.
in
WidgetMaker at line 24
BaseWidget
makeWidget(string $class, array $widgetConfig = [])
Makes a widget object with the supplied configuration ex. model config
in
WidgetMaker at line 47
BaseFormWidget
makeFormWidget(string $class, mixed $fieldConfig = [], array $widgetConfig = [])
Makes a form widget object with the supplied form field and widget configuration.
in
ExtensionTrait at line 32
extensionApplyInitCallbacks()
No description
in
ExtensionTrait at line 51
static void
extensionExtendCallback(callable $callback)
Helper method for ::extend()
static method
in
ExtensionTrait at line 64
protected
extensionHideField($name)
No description
in
ExtensionTrait at line 69
protected
extensionHideMethod($name)
No description
in
ExtensionTrait at line 74
extensionIsHiddenField($name)
No description
in
ExtensionTrait at line 79
extensionIsHiddenMethod($name)
No description
in
ExtensionTrait at line 84
static
getCalledExtensionClass()
No description
at line 43
__construct(Controller $controller = null)
ControllerAction constructor.
at line 65
setConfig(string|array $config, array $required = [])
Sets the widget configuration values
at line 78
mixed
getConfig(string $name = null, mixed $default = null)
Get the widget configuration values.
at line 103
protected
hideAction($methodName)
Protects a public method from being available as an controller method.