MailPartials

Mail partials controller

 class System\Controllers\MailPartials
extends Backend\Classes\Controller

Traits

Trait Description
AssetMaker

Asset Maker Trait Adds asset based methods to a class

ConfigMaker

Config Maker Trait Adds configuration based methods to a class

ErrorMaker

Error Maker Trait Adds exception based methods to a class, goes well with System\Traits\ViewMaker.

EventEmitter

Adds system event related features to any class.

ExtendableTrait

This extension trait is used when access to the underlying base class is not available, such as classes that belong to the foundation framework (Laravel). It is currently used by the Controller and Model classes.

ResponseMaker

Response Maker Trait Stores attributes the can be used to prepare a response from the server.

SecurityController

Security Controller Trait Adds cross-site scripting protection methods to a controller based class

ViewMaker

View Maker Trait Adds view based methods to a class

WidgetMaker

Widget Maker Trait

Properties

public $implement : array

Extensions implemented by this controller.

public $requiredPermissions : array

Permissions required to view this page.

public $assetPath : string

Inherited from AssetMaker

Specifies a path to the asset directory.

public $bodyClass : string

Inherited from Controller

Body class property used for customising the layout on a controller basis.

public $hiddenActions : array

Inherited from Controller

Default methods which cannot be called as actions.

public $layout : string

Inherited from ViewMaker

Layout to use for the view.

public $pageTitle : string

Inherited from Controller

Page title

public $pageTitleTemplate : string

Inherited from Controller

Page title template

public $suppressLayout : bool

Inherited from ViewMaker

Prevents the use of a layout.

public $suppressView : bool

Inherited from Controller

Prevents the automatic view display.

public $vars : array

Inherited from ViewMaker

A list of variables to pass to the page.

public $widget : array

Inherited from Controller

Collection of WidgetBase objects used on this page.

protected $action : string

Inherited from Controller

Page action being called.

protected $assets : array

Inherited from AssetMaker

Collection of assets to display in the layout.

protected $configPath : string

Inherited from ConfigMaker

Specifies a path to the config directory.

protected static $extendableCallbacks : array

Inherited from ExtendableTrait

Used to extend the constructor of an extendable class. Eg:

Class::extend(function($obj) { })

protected static $extendableClassLoader : ClassLoader | null

Inherited from ExtendableTrait

Class loader instance.

protected static $extendableGuardProperties : bool

Inherited from ExtendableTrait

Indicates if dynamic properties can be created.

protected static $extendableStaticMethods : array

Inherited from ExtendableTrait

Collection of static methods used by behaviors.

protected $extensionData : array

Inherited from ExtendableTrait

Class reflection information, including behaviors.

protected $fatalError : string

Inherited from ErrorMaker

Object used for storing a fatal error.

protected $guarded : array

Inherited from Controller

Controller specified methods which cannot be called as actions.

protected $layoutPath : string

Inherited from ViewMaker

Specifies a path to the layout directory.

protected $params : array

Inherited from Controller

Routed parameters.

protected $publicActions : array

Inherited from Controller

Defines a collection of actions available without authentication.

protected $responseHeaderBag : Symfony\Component\HttpFoundation\ResponseHeaderBag

Inherited from ResponseMaker

protected $responseOverride : mixed

Inherited from ResponseMaker

Override the standard controller response.

protected $statusCode : int

Inherited from ResponseMaker

Response status code

protected $user : object

Inherited from Controller

Reference the logged in admin user.

protected $viewPath : string | array

Inherited from ViewMaker

Specifies a path to the views directory.

Methods

public __construct ()

Constructor.

Returns
mixed

public formBeforeSave ($model)

Parameters
Property Description
$model
mixed
Returns
mixed

public __call ($name, $params)

Inherited from Controller
Parameters
Property Description
$name
mixed
$params
mixed
Returns
mixed

public static __callStatic ($name, $params)

Inherited from Controller
Parameters
Property Description
$name
mixed
$params
mixed
Returns
mixed

public __get ($name)

Inherited from Controller
Parameters
Property Description
$name
mixed
Returns
mixed

public __set ($name, $value)

Inherited from Controller
Parameters
Property Description
$name
mixed
$value
mixed
Returns
mixed

public actionExists (string $name, boolean $internal = false) : bool

Inherited from Controller

This method is used internally.

Determines whether an action with the specified name exists. Action must be a class public method. Action name can not be prefixed with the underscore character.

Parameters
Property Description
$name
string

Specifies the action name.

$internal
boolean

Allow protected actions.

Returns
bool

public actionUrl ($action = null, $path = null)

Inherited from Controller

Returns a URL for this controller and supplied action.

Parameters
Property Description
$action
mixed
$path
mixed
Returns
mixed

public addCss (array | string $name, array $attributes = []) : void

Inherited from AssetMaker

Adds StyleSheet asset to the asset list. Call $this->makeAssets() in a view to output corresponding markup.

Parameters
Property Description
$name
array | string

Specifies a path (URL) or an array of paths to the stylesheet(s).

$attributes
array

Adds extra HTML attributes to the asset link.

Returns
void

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

Inherited from ExtendableTrait

Programmatically adds a method to the extendable class

Parameters
Property Description
$dynamicName
string
$method
callable
$extension
string
Returns
mixed

public addDynamicProperty (string $dynamicName, mixed $value = null) : void

Inherited from ExtendableTrait

Programmatically adds a property to the extendable class

Parameters
Property Description
$dynamicName
string

The name of the property to add

$value
mixed

The value of the property

Returns
void

public addJs (array | string $name, array $attributes = []) : void

Inherited from AssetMaker

Adds JavaScript asset to the asset list. Call $this->makeAssets() in a view to output corresponding markup.

Parameters
Property Description
$name
array | string

Specifies a path (URL) or an array of paths to the script(s).

$attributes
array

Adds extra HTML attributes to the asset link.

Returns
void

public addRss (string $name, array $attributes = []) : void

Inherited from AssetMaker

Adds an RSS link asset to the asset list. Call $this->makeAssets() in a view to output corresponding markup.

Parameters
Property Description
$name
string

Specifies a path (URL) to the RSS channel

$attributes
array

Adds extra HTML attributes to the asset link.

Returns
void

public addViewPath (string | array $path) : void

Inherited from ViewMaker

Prepends a path on the available view path locations.

Parameters
Property Description
$path
string | array
Returns
void

public asExtension (string $shortName) : mixed

Inherited from ExtendableTrait

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

$this->asExtension('FormController')

Parameters
Property Description
$shortName
string
Returns
mixed

public static clearExtendedClasses () : void

Inherited from ExtendableTrait

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

Returns
void

public combineAssets (array $assets, string $localPath = "") : string

Inherited from AssetMaker

Run the provided assets through the Asset Combiner

Parameters
Property Description
$assets
array

Collection of assets

$localPath
string

Prefix all assets with this path (optional)

Returns
string

public extendClassWith (string $extensionName) : void

Inherited from ExtendableTrait

Dynamically extend a class with a specified behavior

Parameters
Property Description
$extensionName
string
Returns
void

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

Inherited from ExtendableTrait

Magic method for __call().

Callback priority is as follows:

  • "Dynamic Methods" added locally to the object via addDynamicMethod($name, $callable)
  • Methods available on Behaviors that have been implemented by the object
  • Pass it to the parent's __call() method if it defines one
Parameters
Property Description
$name
string
$params
array
Returns
mixed

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

Inherited from ExtendableTrait

Magic method for __callStatic()

Parameters
Property Description
$name
string
$params
array
Returns
mixed

public extendableConstruct ()

Inherited from ExtendableTrait

This method should be called as part of the constructor.

Returns
mixed

public static extendableExtendCallback (callable $callback, boolean $scoped = false, $outerScope = null) : void

Inherited from ExtendableTrait

Helper method for ::extend() static method.

Parameters
Property Description
$callback
callable
$scoped
boolean
$outerScope
mixed
Returns
void

public extendableGet (string $name) : mixed | null

Inherited from ExtendableTrait

Magic method for __get()

Parameters
Property Description
$name
string
Returns
mixed | null

public extendableSet (string $name, mixed $value) : void

Inherited from ExtendableTrait

Magic method for __set()

Parameters
Property Description
$name
string
$value
mixed
Returns
void

public fireSystemEvent (string $event, array $params = [], boolean $halt = true) : mixed

Inherited from EventEmitter

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('backend.list.myEvent', ['my value']);

Is equivalent to:

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

Event::fire('backend.list.myEvent', [$this, 'myvalue'], true);
Parameters
Property Description
$event
string

Event name

$params
array

Event parameters

$halt
boolean

Halt after first non-null result

Returns
mixed

public fireViewEvent (string $event, array $params = []) : string

Inherited from EventEmitter

Special event function used for extending within view files, allowing HTML to be injected multiple times.

For example:

= $this->fireViewEvent('backend.auth.extendSigninView') ?>
Parameters
Property Description
$event
string

Event name

$params
array

Event parameters

Returns
string

public flushAssets () : void

Inherited from AssetMaker

Disables the use, and subequent broadcast, of assets. This is useful to call during an AJAX request to speed things up. This method works by specifically targeting the hasAssetsDefined method.

Returns
void

public getAjaxHandler () : string

Inherited from Controller

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

Returns
string

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

Inherited from AssetMaker

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
Property Description
$fileName
string

File to load.

$assetPath
string

Explicitly define an asset path.

Returns
string

Relative path to the asset file.

public getAssetPaths () : array

Inherited from AssetMaker

Returns an array of all registered asset paths.

Returns
array

public getClassExtension (string $name) : mixed

Inherited from ExtendableTrait

Returns a behavior object from an extendable class, example:

$this->getClassExtension('Backend.Behaviors.FormController')

Parameters
Property Description
$name
string

Fully qualified behavior name

Returns
mixed

public getClassMethods () : array

Inherited from ExtendableTrait

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

Returns
array

public getConfigPath (string $fileName, mixed $configPath = null) : string

Inherited from ConfigMaker

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
Property Description
$fileName
string

File to load.

$configPath
mixed

Explicitly define a config path.

Returns
string

Full path to the config file.

public getDynamicProperties () : array

Inherited from ExtendableTrait

Returns all dynamic properties and their values

Returns
array

['property' => 'value']

public getFatalError () : string

Inherited from ErrorMaker
Returns
string

The fatal error message

public getId ($suffix = null)

Inherited from Controller

Returns a unique ID for the controller and route. Useful in creating HTML markup.

Parameters
Property Description
$suffix
mixed
Returns
mixed

public getPublicActions ()

Inherited from Controller

Returns the controllers public actions.

Returns
mixed

public getResponseHeaders () : Symfony\Component\HttpFoundation\ResponseHeaderBag | null

Inherited from ResponseMaker

Get the header response bag

Returns
Symfony\Component\HttpFoundation\ResponseHeaderBag | null

public getStatusCode () : int

Inherited from ResponseMaker

Returns the status code for the current web response.

Returns
int

Status code

public getViewPath (string $fileName, $viewPaths = null) : string

Inherited from ViewMaker

Locates a file based on its definition. The file name can be prefixed with a symbol (~|$) to return in context of the application or plugin base path, otherwise it will be returned in context of this object view path.

If the fileName cannot be found it will be returned unmodified.

Parameters
Property Description
$fileName
string
$viewPaths
mixed
Returns
string

public getViewPaths () : array

Inherited from ViewMaker

Returns the active view path locations.

Returns
array

public guessConfigPath (string $suffix = "") : string

Inherited from ConfigMaker

Guess the package path for the called class.

Parameters
Property Description
$suffix
string

An extra path to attach to the end

Returns
string

public guessConfigPathFrom (string $class, string $suffix = "") : string

Inherited from ConfigMaker

Guess the package path from a specified class.

Parameters
Property Description
$class
string

Class to guess path from.

$suffix
string

An extra path to attach to the end

Returns
string

public guessViewPath (string $suffix = "", boolean $isPublic = false) : string | null

Inherited from ViewMaker

Guess the package path for the called class.

Parameters
Property Description
$suffix
string

An extra path to attach to the end

$isPublic
boolean

Returns public path instead of an absolute one

Returns
string | null

public guessViewPathFrom (string $class, string $suffix = "", boolean $isPublic = false) : string | null

Inherited from ViewMaker

Guess the package path from a specified class.

Parameters
Property Description
$class
string

Class to guess path from.

$suffix
string

An extra path to attach to the end

$isPublic
boolean

Returns public path instead of an absolute one

Returns
string | null

public handleError ($exception)

Inherited from ErrorMaker

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

Parameters
Property Description
$exception
mixed
Returns
mixed

public hasAssetsDefined () : bool

Inherited from AssetMaker

Returns true if assets any have been added.

Returns
bool

public hasFatalError () : bool

Inherited from ErrorMaker
Returns
bool

Whether a fatal error has been set or not.

public isBackendHintHidden (string $name) : bool

Inherited from Controller

Checks if a hint has been hidden by the user.

Parameters
Property Description
$name
string

Unique key name

Returns
bool

public isClassExtendedWith (string $name) : bool

Inherited from ExtendableTrait

Check if extendable class is extended with a behavior object

Parameters
Property Description
$name
string

Fully qualified behavior name

Returns
bool

public makeAssets ($type = null) : string | null

Inherited from AssetMaker

Outputs <link> and <script> tags to load assets previously added with addJs, addCss, & addRss method calls depending on the provided $type

Parameters
Property Description
$type
mixed
Returns
string | null

public makeConfig (array $configFile = [], array $requiredConfig = []) : array | stdClass

Inherited from ConfigMaker

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

Parameters
Property Description
$configFile
array
$requiredConfig
array
Returns
array | stdClass

public makeConfigFromArray (array $configArray = []) : stdClass

Inherited from ConfigMaker

Makes a config object from an array, making the first level keys properties of a new object.

Parameters
Property Description
$configArray
array

Config array.

Returns
stdClass

The config object

public makeFileContents (string $filePath, array $extraParams = []) : string

Inherited from ViewMaker

Includes a file path using output buffering, making the provided vars available.

Parameters
Property Description
$filePath
string
$extraParams
array
Returns
string

public makeFormWidget (string $class, array $fieldConfig = [], array $widgetConfig = []) : Backend\Classes\FormWidgetBase

Inherited from WidgetMaker

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

Parameters
Property Description
$class
string

Widget class name

$fieldConfig
array

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

$widgetConfig
array

An array of config.

Returns

The widget object

public makeHintPartial (string $name, string $partial = null, array $params = []) : string

Inherited from Controller

Renders a hint partial, used for displaying informative information that can be hidden by the user. If you don't want to render a partial, you can supply content via the 'content' key of $params.

Parameters
Property Description
$name
string

Unique key name

$partial
string

Reference to content (partial name)

$params
array

Extra parameters

Returns
string

public makeLayout ($name = null, array $params = [], boolean $throwException = true) : string | bool

Inherited from ViewMaker

Render a layout, defaulting to the layout propery specified on the class

Parameters
Property Description
$name
mixed
$params
array
$throwException
boolean
Returns
string | bool

The layout contents, or false.

public makeLayoutPartial (string $partial, array $params = []) : string

Inherited from ViewMaker

Renders a layout partial

Parameters
Property Description
$partial
string
$params
array
Returns
string

public makePartial (string $partial, array $params = [], boolean $throwException = true) : mixed

Inherited from ViewMaker

Render a partial file contents located in the views folder.

Parameters
Property Description
$partial
string
$params
array
$throwException
boolean
Returns
mixed

Partial contents or false if not throwing an exception.

public makeResponse (mixed $contents) : mixed

Inherited from ResponseMaker

Prepares a response that considers overrides and custom responses.

Parameters
Property Description
$contents
mixed
Returns
mixed

public makeView (string $view) : string

Inherited from ViewMaker

Loads the specified view. Applies the layout if one is set.

The view file must have the .php extension (or ".htm" for historical reasons) and be located in the views directory

Parameters
Property Description
$view
string
Returns
string

public makeViewContent (string $contents, $layout = null) : string

Inherited from ViewMaker

Renders supplied contents inside a layout.

Parameters
Property Description
$contents
string
$layout
mixed
Returns
string

public makeWidget (string $class, array $widgetConfig = []) : mixed | Backend\Classes\WidgetBase

Inherited from WidgetMaker

Makes a widget object with the supplied configuration file.

Parameters
Property Description
$class
string

Widget class name

$widgetConfig
array

An array of config.

Returns

The widget object

public mergeConfig (mixed $configA, mixed $configB) : stdClass

Inherited from ConfigMaker

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

Parameters
Property Description
$configA
mixed
$configB
mixed
Returns
stdClass

The config object

public methodExists (string $name) : bool

Inherited from ExtendableTrait

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

Parameters
Property Description
$name
string
Returns
bool

public onHideBackendHint () : void

Inherited from Controller

Ajax handler to hide a backend hint, once hidden the partial will no longer display for the user.

Returns
void

public pageAction ()

Inherited from Controller

Invokes the current controller action without rendering a view, used by AJAX handler that may rely on the logic inside the action.

Returns
mixed

public propertyExists (string $name) : bool

Inherited from ExtendableTrait

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

Parameters
Property Description
$name
string
Returns
bool

public run (string $action = null, array $params = []) : mixed

Inherited from Controller

Execute the controller action.

Parameters
Property Description
$action
string

The action name.

$params
array

Routing parameters to pass to the action.

Returns
mixed

The action result.

public setResponse (mixed $response) : $this

Inherited from ResponseMaker

Sets the response for the current page request cycle, this value takes priority over the standard response prepared by the controller.

Parameters
Property Description
$response
mixed

Response object or string

Returns
$this

public setResponseCookie (Symfony\Component\HttpFoundation\Cookie | mixed $cookie) : $this

Inherited from ResponseMaker

Add a cookie to the response.

Parameters
Property Description
$cookie
Symfony\Component\HttpFoundation\Cookie | mixed
Returns
$this

public setResponseHeader (string $key, array | string $values, boolean $replace = true) : $this

Inherited from ResponseMaker

Set a header on the Response.

Parameters
Property Description
$key
string
$values
array | string
$replace
boolean
Returns
$this

public setStatusCode (int $code) : $this

Inherited from ResponseMaker

Sets the status code for the current web response.

Parameters
Property Description
$code
int

Status code

Returns
$this

protected addAsset (string $type, string $path, array $attributes)

Inherited from AssetMaker

Adds the provided asset to the internal asset collections

Parameters
Property Description
$type
string

The type of the asset: 'js' || 'css' || 'rss'

$path
string

The path to the asset

$attributes
array

The attributes for the asset

Returns
mixed

protected execAjaxHandlers ()

Inherited from Controller

This method is used internally.

Invokes a controller event handler and loads the supplied partials.

Returns
mixed

protected execPageAction (string $actionName, array $parameters)

Inherited from Controller

This method is used internally.

Invokes the controller action and loads the corresponding view.

Parameters
Property Description
$actionName
string

Specifies a action name to execute.

$parameters
array

A list of the action parameters.

Returns
mixed

protected extendableIsAccessible (mixed $class, string $propertyName) : bool

Inherited from ExtendableTrait

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

Parameters
Property Description
$class
mixed
$propertyName
string
Returns
bool

protected extensionExtractMethods (string $extensionName, object $extensionObject) : void

Inherited from ExtendableTrait

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

Parameters
Property Description
$extensionName
string
$extensionObject
object
Returns
void

protected extensionGetClassLoader () : Winter\Storm\Support\ClassLoader | null

Inherited from ExtendableTrait

Gets the class loader

Returns
Winter\Storm\Support\ClassLoader | null

protected extensionNormalizeClassName (string $name) : string

Inherited from ExtendableTrait

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

Parameters
Property Description
$name
string
Returns
string

protected getAssetEntryBuildPath (array $asset) : string

Inherited from AssetMaker

Internal helper, attaches a build code to an asset path

Parameters
Property Description
$asset
array

Stored asset array

Returns
string

protected getAssetScheme (string $asset) : string

Inherited from AssetMaker

Internal helper, get asset scheme

Parameters
Property Description
$asset
string

Specifies a path (URL) to the asset.

Returns
string

protected getLocalPath (string | null $relativePath)

Inherited from AssetMaker
Parameters
Property Description
$relativePath
string | null
Returns
mixed

protected handleViewException (Throwable $e, integer $obLevel) : void

Inherited from ViewMaker

Handle a view exception.

Parameters
Property Description
$e
Throwable
$obLevel
integer
Returns
void

protected makeXsrfCookie () : Symfony\Component\HttpFoundation\Cookie

Inherited from SecurityController

Adds anti-CSRF cookie.

Adds a cookie with a token for CSRF checks to the response.

Returns
Symfony\Component\HttpFoundation\Cookie

protected removeDuplicates () : void

Inherited from AssetMaker

Removes duplicate assets from the entire collection.

Returns
void

protected runAjaxHandler ($handler) : bool

Inherited from Controller

Tries to find and run an AJAX handler in the page action.

The method stops as soon as the handler is found.

Parameters
Property Description
$handler
mixed
Returns
bool

Returns true if the handler was found. Returns false otherwise.

protected runAjaxHandlerForWidget ($widget, $handler) : mixed

Inherited from Controller

Specific code for executing an AJAX handler for a widget.

This will append the widget view paths to the controller and merge the vars.

Parameters
Property Description
$widget
mixed
$handler
mixed
Returns
mixed

protected verifyCsrfToken () : bool

Inherited from SecurityController

Checks the request data / headers for a valid CSRF token.

Returns
bool

Returns false if a valid token is not found or cms.enableCsrfProtection is set to false

protected verifyForceSecure () : bool

Inherited from SecurityController

Checks if the back-end should force a secure protocol (HTTPS) enabled by config.

Returns
bool
Copyright © 2023 Winter CMS