API Documentation
\
Charcoal
Admin
Action
Account
Object
System
Widget
Table
Object
Property
Display
Input
Selectize
Script
Notification
Object
Table
Translation
User
AclRole
Service
ServiceProvider
Template
Account
Object
System
Ui
Sidemenu
User
Widget
Dialog
FormGroup
Graph

\Charcoal\Admin\Script\NotificationAbstractNotificationScript

Base class for all the notification script

Summary

Methods
Properties
Constants
setDependencies()
defaultArguments()
run()
No public properties found
No constants found
setModelFactory()
modelFactory()
propertyToInput()
frequency()
startDate()
endDate()
emailData()
No protected properties found
N/A
booleanInput()
passwordInput()
loadNotifications()
handleNotification()
sendEmail()
updatedObjects()
setNotificationFactory()
notificationFactory()
setRevisionFactory()
revisionFactory()
$modelFactory
$notificationFactory
$emailFactory
$userFactory
$objectFactory
N/A

Properties

$modelFactory

$modelFactory : \Charcoal\Factory\FactoryInterface

Type

\Charcoal\Factory\FactoryInterface

$notificationFactory

$notificationFactory : \Charcoal\Factory\FactoryInterface

Type

\Charcoal\Factory\FactoryInterface

$emailFactory

$emailFactory : \Charcoal\Factory\FactoryInterface

Type

\Charcoal\Factory\FactoryInterface

$userFactory

$userFactory : \Charcoal\Factory\FactoryInterface

Type

\Charcoal\Factory\FactoryInterface

$objectFactory

$objectFactory : \Charcoal\Factory\FactoryInterface

Type

\Charcoal\Factory\FactoryInterface

Methods

setDependencies()

setDependencies(\Pimple\Container  $container) : void

Parameters

\Pimple\Container $container

Pimple DI container.

defaultArguments()

defaultArguments() : array

Returns

array

run()

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

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

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.

propertyToInput()

propertyToInput(\Charcoal\Property\PropertyInterface  $prop) : mixed

Parameters

\Charcoal\Property\PropertyInterface $prop

The property to retrieve input from.

Returns

mixed

frequency()

frequency() : string

Get the frequency type of this script.

Returns

string

startDate()

startDate() : \Charcoal\Admin\Script\Notification\DateTime

Retrieve the "minimal" date that the revisions should have been made for this script.

Returns

\Charcoal\Admin\Script\Notification\DateTime

endDate()

endDate() : \Charcoal\Admin\Script\Notification\DateTime

Retrieve the "maximal" date that the revisions should have been made for this script.

Returns

\Charcoal\Admin\Script\Notification\DateTime

emailData()

emailData(\Charcoal\Admin\Object\Notification  $notification, \Charcoal\Model\CollectionInterface  $objects) : array

Parameters

\Charcoal\Admin\Object\Notification $notification

The notification object.
\Charcoal\Model\CollectionInterface $objects

The objects that were modified.

Returns

array

booleanInput()

booleanInput(\Charcoal\Property\PropertyInterface  $prop) : \League\CLImate\TerminalObject\Dynamic\Input

Get a CLI input from a boolean property.

Parameters

\Charcoal\Property\PropertyInterface $prop

The property to retrieve input from.

Returns

\League\CLImate\TerminalObject\Dynamic\Input

passwordInput()

passwordInput(\Charcoal\Property\PropertyInterface  $prop) : \League\CLImate\TerminalObject\Dynamic\Input

Get a CLI password input (hidden) from a password property.

Parameters

\Charcoal\Property\PropertyInterface $prop

The property to retrieve input from.

Returns

\League\CLImate\TerminalObject\Dynamic\Input

loadNotifications()

loadNotifications(string  $frequency) : \Charcoal\Admin\Script\Notification\Charcoal\Model\CollectionInterface

Parameters

string $frequency

The frequency type to load.

Returns

\Charcoal\Admin\Script\Notification\Charcoal\Model\CollectionInterface

handleNotification()

handleNotification(\Charcoal\Admin\Object\Notification  $notification) : void

Handle a notification request

Parameters

\Charcoal\Admin\Object\Notification $notification

The notification object to handle.

sendEmail()

sendEmail(\Charcoal\Admin\Object\Notification  $notification, \Charcoal\Model\CollectionInterface  $objects) : void

Parameters

\Charcoal\Admin\Object\Notification $notification

The notification object.
\Charcoal\Model\CollectionInterface $objects

The objects that were modified.

updatedObjects()

updatedObjects(string  $objType) : \Charcoal\Model\CollectionInterface

Parameters

string $objType

The object (target) type to process.

Returns

\Charcoal\Model\CollectionInterface

setNotificationFactory()

setNotificationFactory(\Charcoal\Factory\FactoryInterface  $factory) : void

Parameters

\Charcoal\Factory\FactoryInterface $factory

The factory used to create queue items.

notificationFactory()

notificationFactory() : \Charcoal\Factory\FactoryInterface

Returns

\Charcoal\Factory\FactoryInterface

setRevisionFactory()

setRevisionFactory(\Charcoal\Factory\FactoryInterface  $factory) : void

Parameters

\Charcoal\Factory\FactoryInterface $factory

The factory used to create queue items.

revisionFactory()

revisionFactory() : \Charcoal\Factory\FactoryInterface

Returns

\Charcoal\Factory\FactoryInterface