Class AbstractTask

Base abstract class from which executable automation tasks may extend. Also provides for logging task output.

Blesta\Core\Automation\Tasks\Common\AbstractTask implements Blesta\Core\Automation\Tasks\Common\LoggableInterface, Blesta\Core\Automation\Tasks\Common\RunnableInterface

Direct known subclasses

Indirect known subclasses

Blesta\Core\Automation\Tasks\Task\CancelScheduledServices, Blesta\Core\Automation\Tasks\Task\ProcessRenewingServices, Blesta\Core\Automation\Tasks\Task\ProvisionPendingServices, Blesta\Core\Automation\Tasks\Task\SuspendServices, Blesta\Core\Automation\Tasks\Task\UnsuspendServices

Abstract
Namespace: Blesta\Core\Automation\Tasks\Common
Package: blesta\core\Automation\Tasks\Common
Copyright: Copyright (c) 2018, Phillips Data, Inc.
License: The Blesta License Agreement
Link: Blesta
Located at core/Automation/Tasks/Common/AbstractTask.php

Methods summary
`public`	# `__construct( Blesta\Core\Automation\Type\Common\AutomationTypeInterface $task, array $options = [] )` Initialize a new task Initialize a new task Parameters `$task` The raw automation task `$options` An additional options necessary for the task: print_log True to print logged content to stdout, or false otherwise (default false) cli True if this is being run via the Command-Line Interface, or false otherwise (default true)
`abstract protected boolean`	# `isTimeToRun( )` Determines whether this task can run at the given date Determines whether this task can run at the given date Returns boolean True if it is time for the task to run, or false otherwise
`protected boolean`	# `isCurrentDay( integer $day )` Determines whether today is the day of the month given Determines whether today is the day of the month given Parameters `$day` The day of the month to check (i.e. in range [1,31]) Returns boolean True if today is the current day given, false otherwise
`public`	# `setDate( Minphp\Date\Date $date )` Sets the date object for date calculations Sets the date object for date calculations Parameters `$date` An instance of Minphp\Date\Date
`public`	# `loadLanguage( string $directory = null, string $langCode = null, string $filename = null )` Attempts to load a language file for use Attempts to load a language file for use Parameters `$directory` The path to the directory containing the language file (optional, defaults to the default language directory) `$langCode` The ISO 639-1/2 language to load the $filename for (e.g. en_us) (optional, defaults to the current language) `$filename` The name of the file (without extension) containing the file (optional, attempts to load based on the current task name)
`public`	# `log( string $content )` Logs the given content for this task Logs the given content for this task Parameters `$content` The content to log to cron Implementation of `Blesta\Core\Automation\Tasks\Common\LoggableInterface::log()`
`public`	# `logComplete( )` Marks the log completed Marks the log completed Implementation of `Blesta\Core\Automation\Tasks\Common\LoggableInterface::logComplete()`
`protected`	# `resetErrors( object $object )` Reset Input errors on a given object Reset Input errors on a given object Parameters `$object` An instance of an object containing the Input component

Methods inherited from Blesta\Core\Automation\Tasks\Common\RunnableInterface
`run()`

Properties summary
`protected Minphp\Date\Date`	`$date` An instance of Minphp\Date\Date An instance of Minphp\Date\Date	#
`protected The`	`$logger` monolog logger monolog logger	#
`protected An`	`$options` array of options for this task: print_log True to print logged content to stdout, or false otherwise (default false) cli True if this is being run via the Command-Line Interface, or false otherwise (default true) array of options for this task: - print_log True to print logged content to stdout, or false otherwise (default false) - cli True if this is being run via the Command-Line Interface, or false otherwise (default true)	# `[]`
`protected An`	`$task` instance of the task instance of the task	#

Packages

Classes

Interfaces

Class AbstractTask

Direct known subclasses

Indirect known subclasses

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Parameters

Implementation of

Implementation of

Parameters