Processor::__construct()
last analyzed

Size

Total Lines 1

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 1
c 0
b 0
f 0
1
<?php
2
3
namespace LegalThings\DataEnricher;
4
5
use LegalThings\DataEnricher\Node;
6
7
/**
8
 * A processor does a single type of data enrichment
9
 */
10
interface Processor
11
{
12
    /**
13
     * Class constructor
14
     * 
15
     * @param string $property  Property key with the processing instruction
16
     */
17
    public function __construct($property);
0 ignored issues
show
Documentation introduced by
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.

For interface and abstract methods, it is impossible to infer the return type from the immediate code. In these cases, it is generally advisible to explicitly annotate these methods with a @return doc comment to communicate to implementors of these methods what they are expected to return.

Loading history...
18
19
    /**
20
     * Get the property key that holds the processing instruction
21
     * 
22
     * @return string
23
     */
24
    public function getProperty();
25
    
26
    /**
27
     * Apply processing to a node
28
     * 
29
     * @param Node $node
30
     */
31
    public function applyToNode(Node $node);
0 ignored issues
show
Documentation introduced by
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.

For interface and abstract methods, it is impossible to infer the return type from the immediate code. In these cases, it is generally advisible to explicitly annotate these methods with a @return doc comment to communicate to implementors of these methods what they are expected to return.

Loading history...
32
}
33