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\ObjectNotification

Summary

Methods
Properties
Constants
setUsers()
users()
setTargetTypes()
targetTypes()
setExtraEmails()
extraEmails()
setFrequency()
frequency()
setActive()
active()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$users
$targetTypes
$extraEmails
$frequency
$active
N/A

Properties

$users

$users : array<mixed,string>

The user ids (usernames).

Type

array<mixed,string>

$targetTypes

$targetTypes : array<mixed,string>

The types of object to watch, for notifications.

Type

array<mixed,string>

$extraEmails

$extraEmails : array<mixed,string>

Extra emails the report shoul be sent to.

Type

array<mixed,string>

$frequency

$frequency : string

Can be "minute", "hourly", "daily", "weekly" or "monthly".

Type

string

$active

$active : boolean

Type

boolean

Methods

setUsers()

setUsers(array|string|null  $users) : \Charcoal\Admin\Object\Notification

Parameters

array|string|null $users

The users (username) of this notifications.

Throws

\InvalidArgumentException

If the users are not an array or a comma-separated string.

Returns

\Charcoal\Admin\Object\Notification —

Chainable

users()

users() : array

Returns

array

setTargetTypes()

setTargetTypes(array|string|null  $targetTypes) : \Charcoal\Admin\Object\Notification

Parameters

array|string|null $targetTypes

The targetTypes of this notifications.

Throws

\InvalidArgumentException

If the types are not an array or a comma-separated string.

Returns

\Charcoal\Admin\Object\Notification —

Chainable

targetTypes()

targetTypes() : array|null

Returns

array|null

setExtraEmails()

setExtraEmails(array|string|null  $extraEmails) : \Charcoal\Admin\Object\Notification

Parameters

array|string|null $extraEmails

The targetTypes of this notifications.

Throws

\InvalidArgumentException

If the emails are not an array or a comma-separated string.

Returns

\Charcoal\Admin\Object\Notification —

Chainable

extraEmails()

extraEmails() : array|null

Returns

array|null

setFrequency()

setFrequency(string  $frequency) : \Charcoal\Admin\Object\Notification

Parameters

string $frequency

The frequency mode of this notification.

Throws

\InvalidArgumentException

If the frequency is not a valid mode.

Returns

\Charcoal\Admin\Object\Notification —

Chainable

frequency()

frequency() : boolean

Returns

boolean

setActive()

setActive(boolean  $active) : \Charcoal\Admin\Object\Notification

Parameters

boolean $active

The active flag.

Returns

\Charcoal\Admin\Object\Notification —

Chainable

active()

active() : boolean

Returns

boolean