LegalThings\DataEnricher\Processor

Size/Duplication

Total Lines	23
Duplicated Lines	0 %

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
	getProperty()	0	1	?
	__construct()	0	1	?
	applyToNode()	0	1	?

<?php

namespace LegalThings\DataEnricher;

use LegalThings\DataEnricher\Node;

/**
 * A processor does a single type of data enrichment
 */
interface Processor
{
    /**
     * Class constructor
     * 
     * @param string $property  Property key with the processing instruction
     */
    public function __construct($property);

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

    /**
     * Get the property key that holds the processing instruction
     * 
     * @return string
     */
    public function getProperty();
    
    /**
     * Apply processing to a node
     * 
     * @param Node $node
     */
    public function applyToNode(Node $node);

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

}