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
Public Properties ​
| Property | Description |
|---|---|
| adminsOnly | boolean – Whether only admins should receive the announcement. |
| body | string – The announcement body |
| description | string, null – The configured job description. |
| heading | string – The announcement heading |
| pluginHandle | string, null – The plugin handle |
adminsOnly ​
- Type
- boolean
- Default value
false- Since
- 4.5.6
Whether only admins should receive the announcement.
body ​
- Type
- string
- Default value
null
The announcement body
heading ​
- Type
- string
- Default value
null
The announcement heading
pluginHandle ​
The plugin handle
Public Methods ​
| Method | Description |
|---|---|
| __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() ​
Arguments ​
$queue(yii\queue\Queue, craft\queue\QueueInterface) – The queue the job belongs to
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() so it can be lazy-translated for users’ preferred languages rather that the current app language.