CronjobReader
in package
implements
CronjobReaderInterface
Class CronjobReader
Interfaces, Classes and Traits
- CronjobReaderInterface
- Interface CronjobReaderInterface
Table of Contents
- $db : CI_DB_query_builder
- $meta : CronjobMetaInterface
- $settings : CronjobSettings
- $configStorage : ConfigurationStorageRepository
- __construct() : mixed
- CronjobRepository constructor.
- getAll() : array<string|int, mixed>
- Returns all cronjobs.
- getByName() : array<string|int, mixed>
- Returns a cronjob by the given identifier.
- _getConfigurationValue() : bool|mixed
- Returns the configuration value.
- _getDateTimeFromFlagFile() : DateTime
- Returns the DateTime that is contained in a given file.
- _isCronjobConfiguration() : bool
- Checks if given file info is a cronjob configuration file.
- _mapCronjob() : array<string|int, mixed>
- Maps cronjob data by the given config file.
- _mapCronjobConfiguration() : array<string|int, mixed>
- Maps cronjob configurations by their related data.
Properties
$db
protected
CI_DB_query_builder
$db
$meta
protected
CronjobMetaInterface
$meta
$settings
protected
CronjobSettings
$settings
$configStorage
private
ConfigurationStorageRepository
$configStorage
Methods
__construct()
CronjobRepository constructor.
public
__construct(CI_DB_query_builder $db, CronjobSettings $settings, ConfigurationStorageRepositoryBuilder $storageBuilder) : mixed
Parameters
- $db : CI_DB_query_builder
- $settings : CronjobSettings
- $storageBuilder : ConfigurationStorageRepositoryBuilder
Return values
mixed —getAll()
Returns all cronjobs.
public
getAll() : array<string|int, mixed>
Return values
array<string|int, mixed> —Collected cronjobs with meta data about execution.
getByName()
Returns a cronjob by the given identifier.
public
getByName(StringType $name) : array<string|int, mixed>
Parameters
- $name : StringType
-
Cronjob identifier.
Return values
array<string|int, mixed> —Cronjob of given identifier.
_getConfigurationValue()
Returns the configuration value.
protected
_getConfigurationValue(array<string|int, mixed> $configuration[, array<string|int, mixed>|null $result = null ]) : bool|mixed
If data was found in the $result, they get processed and returned. Otherwise, the default from $configuration is used.
Parameters
- $configuration : array<string|int, mixed>
- $result : array<string|int, mixed>|null = null
Return values
bool|mixed —_getDateTimeFromFlagFile()
Returns the DateTime that is contained in a given file.
protected
_getDateTimeFromFlagFile(StringType $flagPath) : DateTime
Parameters
- $flagPath : StringType
Return values
DateTime —_isCronjobConfiguration()
Checks if given file info is a cronjob configuration file.
protected
_isCronjobConfiguration(SplFileInfo $configFile) : bool
Parameters
- $configFile : SplFileInfo
Return values
bool —_mapCronjob()
Maps cronjob data by the given config file.
protected
_mapCronjob(SplFileInfo $configFile) : array<string|int, mixed>
Parameters
- $configFile : SplFileInfo
Return values
array<string|int, mixed> —_mapCronjobConfiguration()
Maps cronjob configurations by their related data.
protected
_mapCronjobConfiguration(string $cronjobName, string $key, array<string|int, mixed> $configuration) : array<string|int, mixed>
Parameters
- $cronjobName : string
- $key : string
- $configuration : array<string|int, mixed>