\Charcoal\Admin\Action\ObjectRevertRevisionAction

setObjType()

setObjType(string  $objType) : \Charcoal\Admin\Ui\ObjectContainerInterface

Set the object type.

Parameters

Throws

\InvalidArgumentException

If provided argument is not of type 'string'.

Returns

Chainable

objType()

objType() : string|null

Retrieve the object type.

Returns

setObjId()

setObjId(string|\Charcoal\Admin\Ui\numeric  $objId) : \Charcoal\Admin\Ui\ObjectContainerInterface

Set the object ID.

Parameters

Throws

\InvalidArgumentException

If provided argument is not of type 'scalar'.

Returns

Chainable

objId()

objId() : string|\Charcoal\Admin\Ui\numeric|null

Retrieve the object ID.

Returns

objIdWithSlashes()

objIdWithSlashes() : string

Retrieve the object ID and addslashes.

Used in template/charcoal/admin/template/form/js.mustache to prevent problems with ID with single or double quotes.

Returns

Escaped ID.

setObjBaseClass()

setObjBaseClass(string  $objBaseClass) : \Charcoal\Admin\Ui\ObjectContainerInterface

Parameters

Throws

\InvalidArgumentException

If provided argument is not of type 'string'.

Returns

Chainable

objBaseClass()

objBaseClass() : string|null

Returns

proto()

proto() : \Charcoal\Model\ModelInterface

Retrieve a singleton of the {self::$objType} for prototyping.

Throws

\RuntimeException

If the class has no object type.

Returns

hasObj()

hasObj() : boolean

Determine if the class has a concrete object.

Returns

obj()

obj() : \Charcoal\Model\ModelInterface

Retrieve the object.

Returns

__construct()

__construct(array  $data = null) 

Parameters

setDependencies()

setDependencies(\Pimple\Container  $container) : void

Dependencies

Parameters

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

Returns

siteName()

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

Retrieve the name of the project.

Returns

authRequired()

authRequired() : boolean

Authentication is required by default.

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

Returns

isAuthenticated()

isAuthenticated() : boolean

Determine if the current user is authenticated.

Returns

getAuthenticatedUser()

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

Retrieve the currently authenticated user.

Returns

results()

results() : array

Default response stub.

Returns

adminUrl()

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

Retrieve the base URI of the administration area.

Returns

setBaseUrl()

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

Set the base URI of the application.

Parameters

Returns

baseUrl()

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

Retrieve the base URI of the application.

Returns

hasFeedbacks()

hasFeedbacks() : boolean

Determine if there's feedback.

Returns

numFeedbacks()

numFeedbacks() : integer

Count feedback.

Returns

feedbacks()

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

Retrieve the feedback collection.

Optionally retrieve only the feedback for the given level.

Parameters

Throws

\InvalidArgumentException

If the feedback level is invalid.

Returns

addFeedback()

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

Add feedback.

Parameters

Returns

Chainable

clearFeedback()

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

Remove all feedback from collection.

Returns

Chainable

revNum()

revNum() : integer|null

Retrieve the revision number to restore.

Returns

run()

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

Parameters

Returns

setModelFactory()

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

Parameters

Returns

Chainable

modelFactory()

modelFactory() : \Charcoal\Factory\FactoryInterface

Returns

The model factory.

createOrLoadObj()

createOrLoadObj() : \Charcoal\Model\ModelInterface

Create or load the object.

Returns

cloneObj()

cloneObj() : \Charcoal\Model\ModelInterface

Throws

\Exception

If the object is not valid.

Returns

createObjFromBluePrint()

createObjFromBluePrint() : \Charcoal\Model\ModelInterface

Throws

\Exception

If the object is not valid.

Returns

createObj()

createObj() : \Charcoal\Model\ModelInterface

Throws

\Exception

If the object is not valid.

Returns

loadObj()

loadObj() : \Charcoal\Model\ModelInterface

Returns

The loaded object

validateObjType()

validateObjType() : boolean

Throws

\RuntimeException

If the object is invalid.

Returns

validateObjBaseClass()

validateObjBaseClass(mixed  $obj) : boolean

Parameters

Returns

setSiteName()

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

Set the name of the project.

Parameters

Returns

Chainable

validateCaptcha()

validateCaptcha(string  $response) : boolean

Parameters

Throws

\RuntimeException

If Google reCAPTCHA is not configured.

Returns

resolveFeedbackLevel()

resolveFeedbackLevel(string  $level) : string

Resolve the given feedback level.

Parameters

Returns

The level.

setRevNum()

setRevNum(integer  $revNum) : \Charcoal\Admin\Ui\ObjectContainerInterface

Set the revision number to restore.

Parameters

Throws

\InvalidArgumentException

If the given revision is invalid.

Returns

Chainable