@@ -22,27 +22,27 @@ |
||
| 22 | 22 | class HTMLMail extends AbstractMail |
| 23 | 23 | { |
| 24 | 24 | |
| 25 | - /** |
|
| 26 | - * Set the format of the mail. |
|
| 27 | - * |
|
| 28 | - * @since 1.0.0 |
|
| 29 | - */ |
|
| 30 | - protected function setFormat() |
|
| 31 | - { |
|
| 32 | - $this->format = 'html'; |
|
| 33 | - } |
|
| 25 | + /** |
|
| 26 | + * Set the format of the mail. |
|
| 27 | + * |
|
| 28 | + * @since 1.0.0 |
|
| 29 | + */ |
|
| 30 | + protected function setFormat() |
|
| 31 | + { |
|
| 32 | + $this->format = 'html'; |
|
| 33 | + } |
|
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * Set the context of the renderer. |
|
| 37 | - * |
|
| 38 | - * @since 1.0.0 |
|
| 39 | - * |
|
| 40 | - * @param array $context Context to set/modify. |
|
| 41 | - * |
|
| 42 | - * @return array Updated context. |
|
| 43 | - */ |
|
| 44 | - protected function setContext(array $context) |
|
| 45 | - { |
|
| 46 | - return $context; |
|
| 47 | - } |
|
| 35 | + /** |
|
| 36 | + * Set the context of the renderer. |
|
| 37 | + * |
|
| 38 | + * @since 1.0.0 |
|
| 39 | + * |
|
| 40 | + * @param array $context Context to set/modify. |
|
| 41 | + * |
|
| 42 | + * @return array Updated context. |
|
| 43 | + */ |
|
| 44 | + protected function setContext(array $context) |
|
| 45 | + { |
|
| 46 | + return $context; |
|
| 47 | + } |
|
| 48 | 48 | } |
@@ -22,27 +22,27 @@ |
||
| 22 | 22 | class TextMail extends AbstractMail |
| 23 | 23 | { |
| 24 | 24 | |
| 25 | - /** |
|
| 26 | - * Set the format of the mail. |
|
| 27 | - * |
|
| 28 | - * @since 1.0.0 |
|
| 29 | - */ |
|
| 30 | - protected function setFormat() |
|
| 31 | - { |
|
| 32 | - $this->format = 'text'; |
|
| 33 | - } |
|
| 25 | + /** |
|
| 26 | + * Set the format of the mail. |
|
| 27 | + * |
|
| 28 | + * @since 1.0.0 |
|
| 29 | + */ |
|
| 30 | + protected function setFormat() |
|
| 31 | + { |
|
| 32 | + $this->format = 'text'; |
|
| 33 | + } |
|
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * Set the context of the renderer. |
|
| 37 | - * |
|
| 38 | - * @since 1.0.0 |
|
| 39 | - * |
|
| 40 | - * @param array $context Context to set/modify. |
|
| 41 | - * |
|
| 42 | - * @return array Updated context. |
|
| 43 | - */ |
|
| 44 | - protected function setContext(array $context) |
|
| 45 | - { |
|
| 46 | - return $context; |
|
| 47 | - } |
|
| 35 | + /** |
|
| 36 | + * Set the context of the renderer. |
|
| 37 | + * |
|
| 38 | + * @since 1.0.0 |
|
| 39 | + * |
|
| 40 | + * @param array $context Context to set/modify. |
|
| 41 | + * |
|
| 42 | + * @return array Updated context. |
|
| 43 | + */ |
|
| 44 | + protected function setContext(array $context) |
|
| 45 | + { |
|
| 46 | + return $context; |
|
| 47 | + } |
|
| 48 | 48 | } |
@@ -24,36 +24,36 @@ |
||
| 24 | 24 | interface MailInterface extends Renderable |
| 25 | 25 | { |
| 26 | 26 | |
| 27 | - /** |
|
| 28 | - * Set the template that the email will use. |
|
| 29 | - * |
|
| 30 | - * @since 1.0.0 |
|
| 31 | - * |
|
| 32 | - * @param string|TemplateInterface $template Template to use. |
|
| 33 | - * |
|
| 34 | - * @return void |
|
| 35 | - */ |
|
| 36 | - public function setTemplate($template); |
|
| 27 | + /** |
|
| 28 | + * Set the template that the email will use. |
|
| 29 | + * |
|
| 30 | + * @since 1.0.0 |
|
| 31 | + * |
|
| 32 | + * @param string|TemplateInterface $template Template to use. |
|
| 33 | + * |
|
| 34 | + * @return void |
|
| 35 | + */ |
|
| 36 | + public function setTemplate($template); |
|
| 37 | 37 | |
| 38 | - /** |
|
| 39 | - * Get the instance of the template. |
|
| 40 | - * |
|
| 41 | - * @since 1.0.0 |
|
| 42 | - * |
|
| 43 | - * @return TemplateInterface |
|
| 44 | - */ |
|
| 45 | - public function getTemplate(); |
|
| 38 | + /** |
|
| 39 | + * Get the instance of the template. |
|
| 40 | + * |
|
| 41 | + * @since 1.0.0 |
|
| 42 | + * |
|
| 43 | + * @return TemplateInterface |
|
| 44 | + */ |
|
| 45 | + public function getTemplate(); |
|
| 46 | 46 | |
| 47 | - /** |
|
| 48 | - * Add a section to the Mail. |
|
| 49 | - * |
|
| 50 | - * @since 1.0.0 |
|
| 51 | - * |
|
| 52 | - * @param string $type Type of section to add. |
|
| 53 | - * @param string $content Content of the section. |
|
| 54 | - * |
|
| 55 | - * @return void |
|
| 56 | - * @throws RuntimeException |
|
| 57 | - */ |
|
| 58 | - public function addSection($type, $content); |
|
| 47 | + /** |
|
| 48 | + * Add a section to the Mail. |
|
| 49 | + * |
|
| 50 | + * @since 1.0.0 |
|
| 51 | + * |
|
| 52 | + * @param string $type Type of section to add. |
|
| 53 | + * @param string $content Content of the section. |
|
| 54 | + * |
|
| 55 | + * @return void |
|
| 56 | + * @throws RuntimeException |
|
| 57 | + */ |
|
| 58 | + public function addSection($type, $content); |
|
| 59 | 59 | } |
@@ -22,15 +22,15 @@ |
||
| 22 | 22 | interface ValidatorInterface |
| 23 | 23 | { |
| 24 | 24 | |
| 25 | - /** |
|
| 26 | - * Validate the content for a given context. |
|
| 27 | - * |
|
| 28 | - * @since 1.0.0 |
|
| 29 | - * |
|
| 30 | - * @param string $content Content to validate. |
|
| 31 | - * @param array $context Context in which to validate. |
|
| 32 | - * |
|
| 33 | - * @return string Validated content. |
|
| 34 | - */ |
|
| 35 | - public function validate($content, array $context); |
|
| 25 | + /** |
|
| 26 | + * Validate the content for a given context. |
|
| 27 | + * |
|
| 28 | + * @since 1.0.0 |
|
| 29 | + * |
|
| 30 | + * @param string $content Content to validate. |
|
| 31 | + * @param array $context Context in which to validate. |
|
| 32 | + * |
|
| 33 | + * @return string Validated content. |
|
| 34 | + */ |
|
| 35 | + public function validate($content, array $context); |
|
| 36 | 36 | } |
@@ -22,18 +22,18 @@ |
||
| 22 | 22 | class HTMLSanitizer extends AbstractSanitizer |
| 23 | 23 | { |
| 24 | 24 | |
| 25 | - /** |
|
| 26 | - * Sanitize the content for a given context. |
|
| 27 | - * |
|
| 28 | - * @since 1.0.0 |
|
| 29 | - * |
|
| 30 | - * @param string $content Content to sanitize. |
|
| 31 | - * @param array $context Context in which to sanitize. |
|
| 32 | - * |
|
| 33 | - * @return string Sanitized content. |
|
| 34 | - */ |
|
| 35 | - public function sanitize($content, array $context) |
|
| 36 | - { |
|
| 37 | - return $content; |
|
| 38 | - } |
|
| 25 | + /** |
|
| 26 | + * Sanitize the content for a given context. |
|
| 27 | + * |
|
| 28 | + * @since 1.0.0 |
|
| 29 | + * |
|
| 30 | + * @param string $content Content to sanitize. |
|
| 31 | + * @param array $context Context in which to sanitize. |
|
| 32 | + * |
|
| 33 | + * @return string Sanitized content. |
|
| 34 | + */ |
|
| 35 | + public function sanitize($content, array $context) |
|
| 36 | + { |
|
| 37 | + return $content; |
|
| 38 | + } |
|
| 39 | 39 | } |
@@ -26,75 +26,75 @@ |
||
| 26 | 26 | class Factory |
| 27 | 27 | { |
| 28 | 28 | |
| 29 | - /** |
|
| 30 | - * Configuration Settings. |
|
| 31 | - * |
|
| 32 | - * @since 1.0.0 |
|
| 33 | - * |
|
| 34 | - * @var ConfigInterface |
|
| 35 | - */ |
|
| 36 | - protected $config; |
|
| 29 | + /** |
|
| 30 | + * Configuration Settings. |
|
| 31 | + * |
|
| 32 | + * @since 1.0.0 |
|
| 33 | + * |
|
| 34 | + * @var ConfigInterface |
|
| 35 | + */ |
|
| 36 | + protected $config; |
|
| 37 | 37 | |
| 38 | - /** |
|
| 39 | - * Type of element the factory wants to create. |
|
| 40 | - * |
|
| 41 | - * @since 1.0.0 |
|
| 42 | - * |
|
| 43 | - * @var string |
|
| 44 | - */ |
|
| 45 | - protected $element; |
|
| 38 | + /** |
|
| 39 | + * Type of element the factory wants to create. |
|
| 40 | + * |
|
| 41 | + * @since 1.0.0 |
|
| 42 | + * |
|
| 43 | + * @var string |
|
| 44 | + */ |
|
| 45 | + protected $element; |
|
| 46 | 46 | |
| 47 | - /** |
|
| 48 | - * Instantiate a Factory object. |
|
| 49 | - * |
|
| 50 | - * @since 1.0.0 |
|
| 51 | - * |
|
| 52 | - * @param ConfigInterface $config Configuration settings. |
|
| 53 | - * @param string $element The type of element to instantiate a factory for. |
|
| 54 | - * |
|
| 55 | - * @throws FailedToInstantiateFactoryException When an unknown element type is requested. |
|
| 56 | - */ |
|
| 57 | - public function __construct(ConfigInterface $config, $element) |
|
| 58 | - { |
|
| 47 | + /** |
|
| 48 | + * Instantiate a Factory object. |
|
| 49 | + * |
|
| 50 | + * @since 1.0.0 |
|
| 51 | + * |
|
| 52 | + * @param ConfigInterface $config Configuration settings. |
|
| 53 | + * @param string $element The type of element to instantiate a factory for. |
|
| 54 | + * |
|
| 55 | + * @throws FailedToInstantiateFactoryException When an unknown element type is requested. |
|
| 56 | + */ |
|
| 57 | + public function __construct(ConfigInterface $config, $element) |
|
| 58 | + { |
|
| 59 | 59 | |
| 60 | - $this->config = $config; |
|
| 60 | + $this->config = $config; |
|
| 61 | 61 | |
| 62 | - if (! $this->config->hasKey($element)) { |
|
| 63 | - throw new FailedToInstantiateFactoryException(sprintf( |
|
| 64 | - 'Could not instantiate Factory for unknown Element Type "%1$s".', |
|
| 65 | - $element |
|
| 66 | - )); |
|
| 67 | - } |
|
| 62 | + if (! $this->config->hasKey($element)) { |
|
| 63 | + throw new FailedToInstantiateFactoryException(sprintf( |
|
| 64 | + 'Could not instantiate Factory for unknown Element Type "%1$s".', |
|
| 65 | + $element |
|
| 66 | + )); |
|
| 67 | + } |
|
| 68 | 68 | |
| 69 | - $this->element = $element; |
|
| 70 | - } |
|
| 69 | + $this->element = $element; |
|
| 70 | + } |
|
| 71 | 71 | |
| 72 | - /** |
|
| 73 | - * Create and return a new instance of an element. |
|
| 74 | - * |
|
| 75 | - * @since 1.0.0 |
|
| 76 | - * |
|
| 77 | - * @param string $type Type of element to create. |
|
| 78 | - * @param mixed $arguments Optional. Arguments to pass to the object. |
|
| 79 | - * |
|
| 80 | - * @return object New instance of the requested class. |
|
| 81 | - * @throws FailedToInstantiateClassException If an unknown element type is requested. |
|
| 82 | - */ |
|
| 83 | - public function create($type, $arguments = null) |
|
| 84 | - { |
|
| 72 | + /** |
|
| 73 | + * Create and return a new instance of an element. |
|
| 74 | + * |
|
| 75 | + * @since 1.0.0 |
|
| 76 | + * |
|
| 77 | + * @param string $type Type of element to create. |
|
| 78 | + * @param mixed $arguments Optional. Arguments to pass to the object. |
|
| 79 | + * |
|
| 80 | + * @return object New instance of the requested class. |
|
| 81 | + * @throws FailedToInstantiateClassException If an unknown element type is requested. |
|
| 82 | + */ |
|
| 83 | + public function create($type, $arguments = null) |
|
| 84 | + { |
|
| 85 | 85 | |
| 86 | - $classMap = $this->config[$this->element]; |
|
| 86 | + $classMap = $this->config[$this->element]; |
|
| 87 | 87 | |
| 88 | - if (! array_key_exists($type, $classMap)) { |
|
| 89 | - throw new FailedToInstantiateClassException(sprintf( |
|
| 90 | - 'Could not create object, unknown Type "%1$s" for "%2$s" elements.', |
|
| 91 | - $type, |
|
| 92 | - $this->element |
|
| 93 | - )); |
|
| 94 | - } |
|
| 88 | + if (! array_key_exists($type, $classMap)) { |
|
| 89 | + throw new FailedToInstantiateClassException(sprintf( |
|
| 90 | + 'Could not create object, unknown Type "%1$s" for "%2$s" elements.', |
|
| 91 | + $type, |
|
| 92 | + $this->element |
|
| 93 | + )); |
|
| 94 | + } |
|
| 95 | 95 | |
| 96 | - $className = $classMap[$type]['class_name']; |
|
| 96 | + $className = $classMap[$type]['class_name']; |
|
| 97 | 97 | |
| 98 | - return new $className($this->config, $arguments); |
|
| 99 | - } |
|
| 98 | + return new $className($this->config, $arguments); |
|
| 99 | + } |
|
| 100 | 100 | } |
@@ -22,21 +22,21 @@ |
||
| 22 | 22 | interface TemplateInterface extends Renderable |
| 23 | 23 | { |
| 24 | 24 | |
| 25 | - /** |
|
| 26 | - * Get an array of Sections that are used by this template. |
|
| 27 | - * |
|
| 28 | - * @since 1.0.0 |
|
| 29 | - * |
|
| 30 | - * @return array Sections that are used by this template. |
|
| 31 | - */ |
|
| 32 | - public function getUsedSections(); |
|
| 25 | + /** |
|
| 26 | + * Get an array of Sections that are used by this template. |
|
| 27 | + * |
|
| 28 | + * @since 1.0.0 |
|
| 29 | + * |
|
| 30 | + * @return array Sections that are used by this template. |
|
| 31 | + */ |
|
| 32 | + public function getUsedSections(); |
|
| 33 | 33 | |
| 34 | - /** |
|
| 35 | - * Get the name of the Template. |
|
| 36 | - * |
|
| 37 | - * @since 1.0.0 |
|
| 38 | - * |
|
| 39 | - * @return string Name of the template. |
|
| 40 | - */ |
|
| 41 | - public function getTemplateName(); |
|
| 34 | + /** |
|
| 35 | + * Get the name of the Template. |
|
| 36 | + * |
|
| 37 | + * @since 1.0.0 |
|
| 38 | + * |
|
| 39 | + * @return string Name of the template. |
|
| 40 | + */ |
|
| 41 | + public function getTemplateName(); |
|
| 42 | 42 | } |
@@ -22,14 +22,14 @@ |
||
| 22 | 22 | interface Renderable |
| 23 | 23 | { |
| 24 | 24 | |
| 25 | - /** |
|
| 26 | - * Render the current Renderable for a given context. |
|
| 27 | - * |
|
| 28 | - * @since 1.0.0 |
|
| 29 | - * |
|
| 30 | - * @param array $context The context in which to render the Renderable. |
|
| 31 | - * |
|
| 32 | - * @return string Rendered output of the Renderable. |
|
| 33 | - */ |
|
| 34 | - public function render(array $context); |
|
| 25 | + /** |
|
| 26 | + * Render the current Renderable for a given context. |
|
| 27 | + * |
|
| 28 | + * @since 1.0.0 |
|
| 29 | + * |
|
| 30 | + * @param array $context The context in which to render the Renderable. |
|
| 31 | + * |
|
| 32 | + * @return string Rendered output of the Renderable. |
|
| 33 | + */ |
|
| 34 | + public function render(array $context); |
|
| 35 | 35 | } |
@@ -22,18 +22,18 @@ |
||
| 22 | 22 | class TextValidator extends AbstractValidator |
| 23 | 23 | { |
| 24 | 24 | |
| 25 | - /** |
|
| 26 | - * Validate the content for a given context. |
|
| 27 | - * |
|
| 28 | - * @since 1.0.0 |
|
| 29 | - * |
|
| 30 | - * @param string $content Content to validate. |
|
| 31 | - * @param array $context Context in which to validate. |
|
| 32 | - * |
|
| 33 | - * @return string Validated content. |
|
| 34 | - */ |
|
| 35 | - public function validate($content, array $context) |
|
| 36 | - { |
|
| 37 | - return $content; |
|
| 38 | - } |
|
| 25 | + /** |
|
| 26 | + * Validate the content for a given context. |
|
| 27 | + * |
|
| 28 | + * @since 1.0.0 |
|
| 29 | + * |
|
| 30 | + * @param string $content Content to validate. |
|
| 31 | + * @param array $context Context in which to validate. |
|
| 32 | + * |
|
| 33 | + * @return string Validated content. |
|
| 34 | + */ |
|
| 35 | + public function validate($content, array $context) |
|
| 36 | + { |
|
| 37 | + return $content; |
|
| 38 | + } |
|
| 39 | 39 | } |