Skip to content

Announcement

Type
Class
Namespace
craft\queue\jobs
Inherits
craft\queue\jobs\Announcement » craft\queue\BaseJob » yii\base\BaseObject
Implements
craft\queue\JobInterface, yii\base\Configurable
Since
3.7.0

Announcement job

View source

Public Properties

PropertyDescription
adminsOnlyboolean – Whether only admins should receive the announcement.
bodystring – The announcement body
descriptionstring, null – The configured job description.
headingstring – The announcement heading
pluginHandlestring, null – The plugin handle

adminsOnly

Type
boolean
Default value
false
Since
4.5.6

Whether only admins should receive the announcement.

View source

body

Type
string
Default value
null

The announcement body

View source

heading

Type
string
Default value
null

The announcement heading

View source

pluginHandle

Type
string, null
Default value
null

The plugin handle

View source

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__construct()Constructor.
__get()Returns the value of an object property.
__isset()Checks if a property is set, i.e. defined and not null.
__set()Sets value of an object property.
__unset()Sets an object property to null.
__wakeup()
canGetProperty()Returns a value indicating whether a property can be read.
canSetProperty()Returns a value indicating whether a property can be set.
className()Returns the fully qualified name of this class.
execute()
getDescription()Returns the description that should be used for the job.
hasMethod()Returns a value indicating whether a method is defined.
hasProperty()Returns a value indicating whether a property is defined.
init()Initializes the object.

execute()

View source

Arguments

Throws

Protected Methods

MethodDescription
defaultDescription()Returns a default description for getDescription().
setProgress()Sets the job progress on the queue.

defaultDescription()

Returns a default description for getDescription().

TIP

Run the description through craft\i18n\Translation::prep() rather than Craft::t() so it can be lazy-translated for users’ preferred languages rather that the current app language.

View source

Returns

string, null