Announcement

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

Announcement job

View source (opens new window)

# Public Properties

Property Description
body string (opens new window) – The announcement body
description string (opens new window), null (opens new window) – The configured job description.
heading string (opens new window) – The announcement heading
pluginHandle string (opens new window), null (opens new window) – The plugin handle

# body

Type
string (opens new window)
Default value
null

The announcement body

View source (opens new window)

# heading

Type
string (opens new window)
Default value
null

The announcement heading

View source (opens new window)

# pluginHandle

Type
string (opens new window), null (opens new window)
Default value
null

The plugin handle

View source (opens new window)

# Public Methods

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

# execute()

View source (opens new window)

Arguments

Throws

# Protected Methods

Method Description
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() (opens new window) so it can be lazy-translated for users’ preferred languages rather that the current app language.

View source (opens new window)

Returns

string (opens new window), null (opens new window)