class QueuedJobHandler extends AbstractProcessingHandler (View source)

Writes log output to a job descriptor

Traits

A class that can be instantiated or replaced via DI

Properties

protected QueuedJob $job
protected QueuedJobDescriptor $jobDescriptor

Methods

public static 
create(mixed ...$args)

An implementation of the factory method, allows you to create an instance of a class

public static 
singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

public
__construct(QueuedJob $job, QueuedJobDescriptor $jobDescriptor)

No description

public
getJob()

No description

public
getJobDescriptor()

No description

protected
void
write(LogRecord $record)

Writes the record down to the log of the implementing handler

public
void
handleBatch(array $records)

No description

protected
FormatterInterface
getDefaultFormatter()

Ensure that exception context is retained. Similar logic to SyslogHandler.

Details

static Injectable create(mixed ...$args)

An implementation of the factory method, allows you to create an instance of a class

This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.

This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create(SiteTree::class); $list = SiteTree::get();

Parameters

mixed ...$args

Return Value

Injectable

static Injectable singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).

Parameters

string $class

Optional classname to create, if the called class should not be used

Return Value

Injectable

The singleton instance

__construct(QueuedJob $job, QueuedJobDescriptor $jobDescriptor)

No description

Parameters

QueuedJob $job
QueuedJobDescriptor $jobDescriptor

QueuedJob getJob()

No description

Return Value

QueuedJob

QueuedJobDescriptor getJobDescriptor()

No description

Return Value

QueuedJobDescriptor

protected void write(LogRecord $record)

Writes the record down to the log of the implementing handler

Parameters

LogRecord $record

Return Value

void

void handleBatch(array $records)

No description

Parameters

array $records

Return Value

void

protected FormatterInterface getDefaultFormatter()

Ensure that exception context is retained. Similar logic to SyslogHandler.

Return Value

FormatterInterface