Documentation

CommandContentMd5Plugin
in package
implements EventSubscriberInterface

Listener used to add a ContentMD5 header to the body of a command and adds ContentMD5 validation if the ValidateMD5 option is not set to false on a command

Interfaces, Classes and Traits

EventSubscriberInterface
An EventSubscriber knows itself what events it is interested in.

Table of Contents

$contentMd5Param  : string
$validateMd5Param  : string
__construct()  : mixed
getSubscribedEvents()  : array<string|int, mixed>
Returns an array of event names this subscriber wants to listen to.
onCommandBeforeSend()  : mixed

Properties

$contentMd5Param

protected string $contentMd5Param

Parameter used to check if the ContentMD5 value is being added

$validateMd5Param

protected string $validateMd5Param

Parameter used to check if validation should occur on the response

Methods

__construct()

public __construct([string $contentMd5Param = 'ContentMD5' ][, string $validateMd5Param = 'ValidateMD5' ]) : mixed
Parameters
$contentMd5Param : string = 'ContentMD5'

Parameter used to check if the ContentMD5 value is being added

$validateMd5Param : string = 'ValidateMD5'

Parameter used to check if validation should occur on the response

Return values
mixed —

getSubscribedEvents()

Returns an array of event names this subscriber wants to listen to.

public static getSubscribedEvents() : array<string|int, mixed>

The array keys are event names and the value can be:

  • The method name to call (priority defaults to 0)
  • An array composed of the method name to call and the priority
  • An array of arrays composed of the method names to call and respective priorities, or 0 if unset

For instance:

  • ['eventName' => 'methodName']
  • ['eventName' => ['methodName', $priority]]
  • ['eventName' => [['methodName1', $priority], ['methodName2']]]

The code must not depend on runtime state as it will only be called at compile time. All logic depending on runtime state must be put into the individual methods handling the events.

Return values
array<string|int, mixed> —

The event names to listen to

Search results