\Charcoal\Admin\Action\WidgetLoadAction

Action: Build a widget.

Required Parameters

widget_type (string) — The widget type, as an identifier for a \Charcoal\App\Template\WidgetInterface.

Optional Parameters

widget_options (array) — Data to set on the built widget.

Response

success (boolean) — TRUE if the widget was built, FALSE in case of any error.
widget_html (string) — The widget's rendered view.
widget_id (string) — The widget's ID.

HTTP Status Codes

200 — Successful; Widget built
400 — Client error; Invalid request data
500 — Server error; Widget could not be built

Summary

Methods

Properties

Constants

__construct()
setDependencies()
init()
siteName()
authRequired()
isAuthenticated()
getAuthenticatedUser()
results()
adminUrl()
setBaseUrl()
baseUrl()
hasFeedbacks()
numFeedbacks()
feedbacks()
addFeedback()
clearFeedback()
run()
setWidgetId()
widgetId()
setWidgetType()
widgetType()
setWidgetHtml()
widgetHtml()

No public properties found

No constants found

setModelFactory()
modelFactory()
setSiteName()
validateCaptcha()
resolveFeedbackLevel()
setWidgetView()
widgetView()
setWidgetFactory()
widgetFactory()

$adminConfig
$appConfig
$feedbacks
$widgetId
$widgetType
$widgetHtml
$widgetView
$widgetFactory

N/A

No private methods found

$siteName
$modelFactory

N/A

File: Action/Widget/LoadAction.php
Package: Default
Class hierarchy: \Charcoal\App\Action\AbstractAction

\Charcoal\Admin\AdminAction

\Charcoal\Admin\Action\Widget\LoadAction

Properties

$adminConfig

$adminConfig : \Charcoal\Admin\Config

Store a reference to the admin configuration.

Type

\Charcoal\Admin\Config

$appConfig

$appConfig : \Charcoal\App\Config

Store a reference to the application configuration.

Type

\Charcoal\App\Config

$feedbacks

$feedbacks : array

Collection of feedback.

Type

array

$widgetId

$widgetId : string

The widget's current ID.

Type

string

$widgetType

$widgetType : string

The widget's current type.

Type

string

$widgetHtml

$widgetHtml : string

The widget's renderered view.

Type

string

$widgetView

$widgetView : \Charcoal\View\ViewInterface

Store the view renderer.

Type

\Charcoal\View\ViewInterface

$widgetFactory

$widgetFactory : \Charcoal\Factory\FactoryInterface

Store the widget factory.

Type

\Charcoal\Factory\FactoryInterface

$siteName

$siteName : \Charcoal\Translator\Translation|string|null

The name of the project.

Type

\Charcoal\Translator\Translation|string|null

$modelFactory

$modelFactory : \Charcoal\Factory\FactoryInterface

Store the model factory.

Type

\Charcoal\Factory\FactoryInterface

Methods

__construct()

__construct(array  $data = null)

Parameters

array

$data

Optional.

setDependencies()

setDependencies(\Pimple\Container  $container) : void

Dependencies

Parameters

\Pimple\Container

$container

A dependencies container instance.

init()

init(\Psr\Http\Message\RequestInterface  $request) : boolean

Template's init method is called automatically from `charcoal-app`'s Template Route.

For admin templates, initializations is:

to start a session, if necessary
to authenticate
to initialize the template data with $_GET

Parameters

\Psr\Http\Message\RequestInterface

$request

The request to initialize.

Returns

boolean

siteName()

siteName() : \Charcoal\Translator\Translation|string|null

Retrieve the name of the project.

Returns

\Charcoal\Translator\Translation|string|null

authRequired()

authRequired() : boolean

Authentication is required by default.

Reimplement and change to false in templates that do not require authentication.

Returns

boolean

isAuthenticated()

isAuthenticated() : boolean

Determine if the current user is authenticated.

Returns

boolean

getAuthenticatedUser()

getAuthenticatedUser() : \Charcoal\User\UserInterface|null

Retrieve the currently authenticated user.

Returns

\Charcoal\User\UserInterface|null

results()

results() : string

Default response stub.

Returns

string

adminUrl()

adminUrl() : \Charcoal\Admin\UriInterface|string

Retrieve the base URI of the administration area.

Returns

\Charcoal\Admin\UriInterface|string

setBaseUrl()

setBaseUrl(\Charcoal\Admin\UriInterface|string  $uri) : self

Set the base URI of the application.

Parameters

\Charcoal\Admin\UriInterface|string

$uri

The base URI.

Returns

self

baseUrl()

baseUrl() : \Charcoal\Admin\UriInterface|string

Retrieve the base URI of the application.

Returns

\Charcoal\Admin\UriInterface|string

hasFeedbacks()

hasFeedbacks() : boolean

Determine if there's feedback.

Returns

boolean

numFeedbacks()

numFeedbacks() : integer

Count feedback.

Returns

integer

feedbacks()

feedbacks(string|null  $level = null) : array

Retrieve the feedback collection.

Optionally retrieve only the feedback for the given level.

Parameters

string|null

$level

Optional level to filter collection.

Throws

\InvalidArgumentException: If the feedback level is invalid.

Returns

array

addFeedback()

addFeedback(string  $level, mixed  $message) : \Charcoal\Admin\Ui\FeedbackContainerTrait

Add feedback.

Parameters

string	$level	The feedback level.
mixed	$message	The feedback message.

Returns

\Charcoal\Admin\Ui\FeedbackContainerTrait —

Chainable

clearFeedback()

clearFeedback() : \Charcoal\Admin\Ui\FeedbackContainerTrait

Remove all feedback from collection.

Returns

\Charcoal\Admin\Ui\FeedbackContainerTrait —

Chainable

run()

run(\Psr\Http\Message\RequestInterface  $request, \Psr\Http\Message\ResponseInterface  $response) : \Psr\Http\Message\ResponseInterface

Execute the endpoint.

Parameters

\Psr\Http\Message\RequestInterface	$request	A PSR-7 compatible Request instance.
\Psr\Http\Message\ResponseInterface	$response	A PSR-7 compatible Response instance.

Returns

\Psr\Http\Message\ResponseInterface

setWidgetId()

setWidgetId(string  $id) : \Charcoal\Admin\Action\Widget\LoadAction

Set the widget's ID.

Parameters

string

$id

The widget ID.

Throws

\InvalidArgumentException: If the widget ID argument is not a string.

Returns

\Charcoal\Admin\Action\Widget\LoadAction —

Chainable

widgetId()

widgetId() : string

Retrieve the widget's ID.

Returns

string

setWidgetType()

setWidgetType(string  $type) : \Charcoal\Admin\Action\Widget\LoadAction

Set the widget's type.

Parameters

string

$type

The widget type.

Throws

\InvalidArgumentException: If the widget type argument is not a string.

Returns

\Charcoal\Admin\Action\Widget\LoadAction —

Chainable

widgetType()

widgetType() : string

Retrieve the widget's type.

Returns

string

setWidgetHtml()

setWidgetHtml(string  $html) : \Charcoal\Admin\Action\Widget\LoadAction

Set the widget's rendered view.

Parameters

string

$html

The widget HTML.

Throws

\InvalidArgumentException: If the widget HTML is not a string.

Returns

\Charcoal\Admin\Action\Widget\LoadAction —

Chainable

widgetHtml()

widgetHtml() : string

Retrieve the widget's rendered view.

Returns

string

setModelFactory()

setModelFactory(\Charcoal\Factory\FactoryInterface  $factory) : \Charcoal\Admin\AdminScript

Parameters

\Charcoal\Factory\FactoryInterface

$factory

The factory used to create models.

Returns

\Charcoal\Admin\AdminScript —

Chainable

modelFactory()

modelFactory() : \Charcoal\Factory\FactoryInterface

Returns

\Charcoal\Factory\FactoryInterface —

The model factory.

setSiteName()

setSiteName(string  $name) : \Charcoal\Admin\AdminAction

Set the name of the project.

Parameters

string

$name

Name of the project.

Returns

\Charcoal\Admin\AdminAction —

Chainable

validateCaptcha()

validateCaptcha(string  $response) : boolean

Parameters

string

$response

The captcha value (response) to validate.

Throws

\RuntimeException: If Google reCAPTCHA is not configured.

Returns

boolean

Inherited from: \Charcoal\Admin\AdminAction