class MailPartials extends AdminController

Traits

Has Authentication Trait Class

Widget Maker Trait Class

Verifies CSRF token Trait

Adds event related features to any class.

Extendable Trait Allows for "Private traits"

Properties

protected bool $requireAuthentication from  HasAuthentication
protected Users_model $currentUser from  HasAuthentication
protected $validateAfterCallback from  ValidatesForm
array $assetPath from  AssetMaker
string $configPath from  ConfigMaker
protected $configFileExtension from  ConfigMaker
$enableCsrfProtection from  VerifiesCsrfToken
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
protected array $emitterSingleEvents from  EventEmitter
protected array $emitterEvents from  EventEmitter
protected array $emitterEventSorted from  EventEmitter
protected array $extensionData from  ExtendableTrait
static protected array $extendableCallbacks from  ExtendableTrait
static protected array $extendableStaticMethods from  ExtendableTrait
static protected bool $extendableGuardProperties from  ExtendableTrait
static protected ClassLoader $extendableClassLoader from  ExtendableTrait
$implement
protected object $fatalError from  AdminController
BaseWidget[] $widgets from  AdminController
bool $suppressView from  AdminController
protected string $action from  AdminController
protected array $params from  AdminController
array $hiddenActions from  AdminController
protected array $publicActions from  AdminController
protected array $guarded from  AdminController
protected $requiredPermissions
string $pageTitle from  AdminController
string $bodyClass from  AdminController
$listConfig
$formConfig

Methods

checkUser()

No description

setUser($currentUser)

No description

getUser()

No description

array|bool
validatePasses($request, array $rules, array $messages = [], array $customAttributes = [])

Validate the given request with the given rules.

array
validate($request, array $rules, array $messages = [], array $customAttributes = [])

Validate the given request with the given rules.

makeValidator($request, array $rules, array $messages = [], array $customAttributes = [])

No description

parseRules(array $rules)

No description

parseAttributes(array $rules)

No description

array
extractInputFromRules(Request $request, array $rules)

Get the request input based on the given validation rules.

Factory
getValidationFactory()

Get a validation factory instance.

validateAfter(Closure $callback)

No description

flashValidationErrors($errors)

No description

validateFormWidget($form, $saveData)

No description

makeWidget(string $class, array $widgetConfig = [])

Makes a widget object with the supplied configuration ex. model config

makeFormWidget(string $class, mixed $fieldConfig = [], array $widgetConfig = [])

Makes a form widget object with the supplied form field and widget configuration.

flushAssets()

No description

string
getAssetPath(string $fileName, string $assetPath = null)

Locates a file based on it's definition. If the file starts with a forward slash, it will be returned in context of the application public path, otherwise it will be returned in context of the asset path.

addMeta($meta)

No description

addJs($href, $attributes = null)

No description

addCss($href, $attributes = null)

No description

array
loadConfig(array $configFile = [], array $requiredConfig = [], null $index = null)

Reads the contents of the supplied file and applies it to this object.

array
makeConfig(string|array $configFile, array $requiredConfig = [])

Reads the contents of the supplied file and applies it to this object.

array
mergeConfig($configLeft, $configRight)

Merges two configuration sources, either prepared or not, and returns them as a single configuration object.

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.

string
guessConfigPath(string $suffix = '')

Guess the package path for the called class.

string
guessConfigPathFrom(string $class, string $suffix = '')

Guess the package path from a specified class.

makeXsrfCookie()

No description

verifyCsrfToken()

No description

string
getCsrfTokenFromRequest()

Get the CSRF token from the request.

static bool
serialized()

Determine if the cookie contents should be serialized.

getViewPath($view, $viewPath = null)

No description

guessViewFileExtension($path)

No description

string
guessViewPath(string $suffix = '', bool $isPublic = FALSE)

Guess the package path from a specified class.

mixed
makeLayout(string $name = null, array $vars = [], bool $throwException = TRUE)

Render a layout.

string
makeView(string $view)

Loads a view with the name specified.

mixed
makePartial(string $partial, array $vars = [], bool $throwException = TRUE)

Render a partial file contents located in the views or partial folder.

string
makeFileContent(string $filePath, array $extraParams = [])

Includes a file path using output buffering.

compileFileContent($filePath)

No description

void
handleViewException(Exception $e, int $obLevel)

Handle a view exception.

array
gatherViewData($data)

Get the data bound to the view instance.

bindEvent(string $event, callable $callback, int $priority = 0)

Create a new event binding.

bindEventOnce(string $event, callable $callback)

Create a new event binding that fires once only

void
emitterEventSortEvents(string $eventName)

Sort the listeners for a given event by priority.

unbindEvent(string $event = null)

Destroys an event binding.

string|array
fireEvent(string $event, array $params = [], bool $halt = false)

Fire an event and call the listeners.

mixed
fireSystemEvent(string $event, array $params = [], bool $halt = true)

Fires a combination of local and global events. The first segment is removed from the event name locally and the local object is passed as the first argument to the event globally. Halting is also enabled by default.

extendableConstruct()

Constructor.

static void
extendableExtendCallback(callable $callback)

Helper method for ::extend() static method

static void
clearExtendedClasses()

Clear the list of extended classes so they will be re-extended.

string
extensionNormalizeClassName(string $name)

Normalizes the provided extension name allowing for the ClassLoader to inject aliased classes

extendClassWith(string $extensionName)

Dynamically extend a class with a specified behavior

void
extensionExtractMethods(string $extensionName, object $extensionObject)

Extracts the available methods from a behavior and adds it to the list of callable methods.

addDynamicMethod(string $dynamicName, callable $method, string $extension = null)

Programmatically adds a method to the extendable class

addDynamicProperty(string $dynamicName, string $value = null)

Programatically adds a property to the extendable class

bool
isClassExtendedWith(string $name)

Check if extendable class is extended with a behavior object

mixed
getClassExtension(string $name)

Returns a behavior object from an extendable class, example:

mixed
asExtension(string $shortName)

Short hand for getClassExtension() method, except takes the short extension name, example:

bool
methodExists(string $name)

Checks if a method exists, extension equivalent of method_exists()

array
getClassMethods()

Get a list of class methods, extension equivalent of get_class_methods()

array
getDynamicProperties()

Returns all dynamic properties and their values

bool
propertyExists(string $name)

Checks if a property exists, extension equivalent of property_exists()

bool
extendableIsAccessible(mixed $class, string $propertyName)

Checks if a property is accessible, property equivalent of is_callabe()

string
extendableGet(string $name)

Magic method for __get()

string
extendableSet(string $name, string $value)

Magic method for __set()

mixed
extendableCall(string $name, array $params = null)

Magic method for __call()

static mixed
extendableCallStatic(string $name, array $params = null)

Magic method for __callStatic()

ClassLoader|null
extensionGetClassLoader()

Gets the class loader

__construct()

Class constructor

definePaths()

No description

initialize()

No description

remap($action, $params)

No description

checkAction($action)

No description

pageAction()

No description

getClass()

No description

getAction()

No description

execPageAction($action, $params)

No description

makeMainMenuWidget()

No description

string
getHandler()

Returns the AJAX handler for the current request, if available.

processHandlers()

No description

validateHandler($handler)

No description

validateHandlerPartials()

No description

getUserLocation()

No description

getLocationId()

No description

pageUrl($path = null, $parameters = [], $secure = null)

No description

redirect($path, $status = 302, $headers = [], $secure = null)

No description

redirectGuest($path, $status = 302, $headers = [], $secure = null)

No description

redirectIntended($path, $status = 302, $headers = [], $secure = null)

No description

redirectBack($status = 302, $headers = [], $fallback = FALSE)

No description

refresh()

No description

runHandler($handler, $params)

No description

handleError(Exception $exception)

Sets standard page variables in the case of a controller error.

__get($name)

No description

__set($name, $value)

No description

__call($name, $params)

No description

static 
__callStatic($name, $params)

No description

static 
extend(callable $callback)

No description

formExtendFields($form)

No description

formBeforeSave($model)

No description

Details

in HasAuthentication at line 23
checkUser()

No description

in HasAuthentication at line 28
setUser($currentUser)

No description

Parameters

$currentUser

in HasAuthentication at line 33
getUser()

No description

in ValidatesForm at line 29
array|bool validatePasses($request, array $rules, array $messages = [], array $customAttributes = [])

Validate the given request with the given rules.

Parameters

$request
array $rules
array $messages
array $customAttributes

Return Value

array|bool

in ValidatesForm at line 52
array validate($request, array $rules, array $messages = [], array $customAttributes = [])

Validate the given request with the given rules.

Parameters

$request
array $rules
array $messages
array $customAttributes

Return Value

array

in ValidatesForm at line 64
makeValidator($request, array $rules, array $messages = [], array $customAttributes = [])

No description

Parameters

$request
array $rules
array $messages
array $customAttributes

in ValidatesForm at line 80
parseRules(array $rules)

No description

Parameters

array $rules

in ValidatesForm at line 93
parseAttributes(array $rules)

No description

Parameters

array $rules

in ValidatesForm at line 114
protected array extractInputFromRules(Request $request, array $rules)

Get the request input based on the given validation rules.

Parameters

Request $request
array $rules

Return Value

array

in ValidatesForm at line 127
protected Factory getValidationFactory()

Get a validation factory instance.

Return Value

Factory

in ValidatesForm at line 132
validateAfter(Closure $callback)

No description

Parameters

Closure $callback

in ValidatesForm at line 137
protected flashValidationErrors($errors)

No description

Parameters

$errors

in ValidatesForm at line 147
protected validateFormWidget($form, $saveData)

No description

Parameters

$form
$saveData

in WidgetMaker at line 24
BaseWidget makeWidget(string $class, array $widgetConfig = [])

Makes a widget object with the supplied configuration ex. model config

Parameters

string $class

Widget class name

array $widgetConfig

An array of config.

Return Value

BaseWidget

The widget object

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.

Parameters

string $class

Widget class name

mixed $fieldConfig

A field name, an array of config or a FormField object.

array $widgetConfig

An array of config.

Return Value

BaseFormWidget

The widget object

Exceptions

Exception

in AssetMaker at line 15
flushAssets()

No description

in AssetMaker at line 30
string getAssetPath(string $fileName, string $assetPath = null)

Locates a file based on it's definition. If the file starts with a forward slash, it will be returned in context of the application public path, otherwise it will be returned in context of the asset path.

Parameters

string $fileName

File to load.

string $assetPath

Explicitly define an asset path.

Return Value

string

Relative path to the asset file.

in AssetMaker at line 55
addMeta($meta)

No description

Parameters

$meta

in AssetMaker at line 60
addJs($href, $attributes = null)

No description

Parameters

$href
$attributes

in AssetMaker at line 65
addCss($href, $attributes = null)

No description

Parameters

$href
$attributes

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.

Parameters

array $configFile
array $requiredConfig
null $index

Return Value

array

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.

Parameters

string|array $configFile
array $requiredConfig

Return Value

array

Exceptions

SystemException

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.

Parameters

$configLeft
$configRight

Return Value

array

The config array

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.

Parameters

string $fileName

File to load.

mixed $configPath

Explicitly define a config path.

Return Value

string

Full path to the config file.

in ConfigMaker at line 154
string guessConfigPath(string $suffix = '')

Guess the package path for the called class.

Parameters

string $suffix

An extra path to attach to the end

Return Value

string

in ConfigMaker at line 169
string guessConfigPathFrom(string $class, string $suffix = '')

Guess the package path from a specified class.

Parameters

string $class

Class to guess path from.

string $suffix

An extra path to attach to the end

Return Value

string

in VerifiesCsrfToken at line 20
protected makeXsrfCookie()

No description

in VerifiesCsrfToken at line 37
protected verifyCsrfToken()

No description

in VerifiesCsrfToken at line 58
protected string getCsrfTokenFromRequest()

Get the CSRF token from the request.

Return Value

string

in VerifiesCsrfToken at line 79
static bool serialized()

Determine if the cookie contents should be serialized.

Return Value

bool

in ViewMaker at line 50
getViewPath($view, $viewPath = null)

No description

Parameters

$view
$viewPath

in ViewMaker at line 78
guessViewFileExtension($path)

No description

Parameters

$path

in ViewMaker at line 100
string guessViewPath(string $suffix = '', bool $isPublic = FALSE)

Guess the package path from a specified class.

Parameters

string $suffix

An extra path to attach to the end

bool $isPublic

Return Value

string

in ViewMaker at line 121
mixed makeLayout(string $name = null, array $vars = [], bool $throwException = TRUE)

Render a layout.

Parameters

string $name

Specifies the layout name. If this parameter is omitted, the $layout property will be used.

array $vars

Parameter variables to pass to the view.

bool $throwException

Throw an exception if the layout is not found

Return Value

mixed

The layout contents, or false.

Exceptions

SystemException

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".

Parameters

string $view

Specifies the view name, without extension. Eg: "index".

Return Value

string

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.

Parameters

string $partial

The view to load.

array $vars

Parameter variables to pass to the view.

bool $throwException

Throw an exception if the partial is not found.

Return Value

mixed

Partial contents or false if not throwing an exception.

Exceptions

SystemException

in ViewMaker at line 201
string makeFileContent(string $filePath, array $extraParams = [])

Includes a file path using output buffering.

Ensures that vars are available.

Parameters

string $filePath

Absolute path to the view file.

array $extraParams

Parameters that should be available to the view.

Return Value

string

in ViewMaker at line 239
compileFileContent($filePath)

No description

Parameters

$filePath

in ViewMaker at line 260
protected void handleViewException(Exception $e, int $obLevel)

Handle a view exception.

Parameters

Exception $e
int $obLevel

Return Value

void

in ViewMaker at line 275
protected array gatherViewData($data)

Get the data bound to the view instance.

Parameters

$data

Return Value

array

in EventEmitter at line 36
EventEmitter bindEvent(string $event, callable $callback, int $priority = 0)

Create a new event binding.

Parameters

string $event

The event name to listen for

callable $callback

The callback to call when emitted

int $priority

Return Value

EventEmitter

in EventEmitter at line 52
EventEmitter bindEventOnce(string $event, callable $callback)

Create a new event binding that fires once only

Parameters

string $event

The event name

callable $callback

Return Value

EventEmitter

in EventEmitter at line 66
protected void emitterEventSortEvents(string $eventName)

Sort the listeners for a given event by priority.

Parameters

string $eventName

Return Value

void

in EventEmitter at line 84
EventEmitter unbindEvent(string $event = null)

Destroys an event binding.

Parameters

string $event

Event to destroy

Return Value

EventEmitter

in EventEmitter at line 124
string|array fireEvent(string $event, array $params = [], bool $halt = false)

Fire an event and call the listeners.

Parameters

string $event

Event name

array $params

Event parameters

bool $halt

Halt after first non-null result

Return Value

string|array

Collection of event results / Or single result (if halted)

in EventEmitter at line 178
mixed fireSystemEvent(string $event, array $params = [], bool $halt = true)

Fires a combination of local and global events. The first segment is removed from the event name locally and the local object is passed as the first argument to the event globally. Halting is also enabled by default.

For example:

$this->fireSystemEvent('admin.form.myEvent', ['my value']);

Is equivalent to:

$this->fireEvent('form.myEvent', ['myvalue'], true);

Event::fire('admin.form.myEvent', [$this, 'myvalue'], true);

Parameters

string $event

Event name

array $params

Event parameters

bool $halt

Halt after first non-null result

Return Value

mixed

in ExtendableTrait at line 55
extendableConstruct()

Constructor.

in ExtendableTrait at line 103
static void extendableExtendCallback(callable $callback)

Helper method for ::extend() static method

Parameters

callable $callback

Return Value

void

in ExtendableTrait at line 120
static void clearExtendedClasses()

Clear the list of extended classes so they will be re-extended.

Return Value

void

in ExtendableTrait at line 131
protected string extensionNormalizeClassName(string $name)

Normalizes the provided extension name allowing for the ClassLoader to inject aliased classes

Parameters

string $name

Return Value

string

in ExtendableTrait at line 149
void|ExtendableTrait extendClassWith(string $extensionName)

Dynamically extend a class with a specified behavior

Parameters

string $extensionName

Return Value

void|ExtendableTrait

Exceptions

Exception

in ExtendableTrait at line 178
protected void extensionExtractMethods(string $extensionName, object $extensionObject)

Extracts the available methods from a behavior and adds it to the list of callable methods.

Parameters

string $extensionName
object $extensionObject

Return Value

void

in ExtendableTrait at line 206
addDynamicMethod(string $dynamicName, callable $method, string $extension = null)

Programmatically adds a method to the extendable class

Parameters

string $dynamicName
callable $method
string $extension

in ExtendableTrait at line 225
addDynamicProperty(string $dynamicName, string $value = null)

Programatically adds a property to the extendable class

Parameters

string $dynamicName
string $value

in ExtendableTrait at line 249
bool isClassExtendedWith(string $name)

Check if extendable class is extended with a behavior object

Parameters

string $name

Fully qualified behavior name

Return Value

bool

in ExtendableTrait at line 265
mixed getClassExtension(string $name)

Returns a behavior object from an extendable class, example:

$this->getClassExtension('Admin.Actions.FormController')

Parameters

string $name

Fully qualified behavior name

Return Value

mixed

in ExtendableTrait at line 280
mixed asExtension(string $shortName)

Short hand for getClassExtension() method, except takes the short extension name, example:

$this->asExtension('FormController')

Parameters

string $shortName

Return Value

mixed

in ExtendableTrait at line 301
bool methodExists(string $name)

Checks if a method exists, extension equivalent of method_exists()

Parameters

string $name

Return Value

bool

in ExtendableTrait at line 313
array getClassMethods()

Get a list of class methods, extension equivalent of get_class_methods()

Return Value

array

in ExtendableTrait at line 326
array getDynamicProperties()

Returns all dynamic properties and their values

Return Value

array

['property' => 'value']

in ExtendableTrait at line 344
bool propertyExists(string $name)

Checks if a property exists, extension equivalent of property_exists()

Parameters

string $name

Return Value

bool

in ExtendableTrait at line 370
protected bool extendableIsAccessible(mixed $class, string $propertyName)

Checks if a property is accessible, property equivalent of is_callabe()

Parameters

mixed $class
string $propertyName

Return Value

bool

in ExtendableTrait at line 385
string extendableGet(string $name)

Magic method for __get()

Parameters

string $name

Return Value

string

in ExtendableTrait at line 410
string extendableSet(string $name, string $value)

Magic method for __set()

Parameters

string $name
string $value

Return Value

string

in ExtendableTrait at line 444
mixed extendableCall(string $name, array $params = null)

Magic method for __call()

Parameters

string $name
array $params

Return Value

mixed

in ExtendableTrait at line 483
static mixed extendableCallStatic(string $name, array $params = null)

Magic method for __callStatic()

Parameters

string $name
array $params

Return Value

mixed

in ExtendableTrait at line 552
protected ClassLoader|null extensionGetClassLoader()

Gets the class loader

Return Value

ClassLoader|null

at line 52
__construct()

Class constructor

in AdminController at line 123
protected definePaths()

No description

in AdminController at line 158
initialize()

No description

in AdminController at line 182
remap($action, $params)

No description

Parameters

$action
$params

in AdminController at line 232
checkAction($action)

No description

Parameters

$action

in AdminController at line 249
pageAction()

No description

in AdminController at line 259
getClass()

No description

in AdminController at line 264
getAction()

No description

in AdminController at line 269
protected execPageAction($action, $params)

No description

Parameters

$action
$params

in AdminController at line 293
protected makeMainMenuWidget()

No description

in AdminController at line 314
string getHandler()

Returns the AJAX handler for the current request, if available.

Return Value

string

in AdminController at line 325
protected processHandlers()

No description

in AdminController at line 384
protected validateHandler($handler)

No description

Parameters

$handler

in AdminController at line 391
protected validateHandlerPartials()

No description

in AdminController at line 411
getUserLocation()

No description

in AdminController at line 416
getLocationId()

No description

in AdminController at line 425
pageUrl($path = null, $parameters = [], $secure = null)

No description

Parameters

$path
$parameters
$secure

in AdminController at line 430
redirect($path, $status = 302, $headers = [], $secure = null)

No description

Parameters

$path
$status
$headers
$secure

in AdminController at line 435
redirectGuest($path, $status = 302, $headers = [], $secure = null)

No description

Parameters

$path
$status
$headers
$secure

in AdminController at line 440
redirectIntended($path, $status = 302, $headers = [], $secure = null)

No description

Parameters

$path
$status
$headers
$secure

in AdminController at line 445
redirectBack($status = 302, $headers = [], $fallback = FALSE)

No description

Parameters

$status
$headers
$fallback

in AdminController at line 450
refresh()

No description

in AdminController at line 455
protected runHandler($handler, $params)

No description

Parameters

$handler
$params

in AdminController at line 514
handleError(Exception $exception)

Sets standard page variables in the case of a controller error.

Parameters

Exception $exception

Exceptions

Exception

in AdminController at line 527
__get($name)

No description

Parameters

$name

in AdminController at line 532
__set($name, $value)

No description

Parameters

$name
$value

in AdminController at line 537
__call($name, $params)

No description

Parameters

$name
$params

in AdminController at line 542
static __callStatic($name, $params)

No description

Parameters

$name
$params

in AdminController at line 547
static extend(callable $callback)

No description

Parameters

callable $callback

at line 59
formExtendFields($form)

No description

Parameters

$form

at line 67
formBeforeSave($model)

No description

Parameters

$model