PluginInterface
last analyzed

Size/Duplication

Total Lines 18
Duplicated Lines 0 %

Importance

Changes 0
Metric Value
dl 0
loc 18
c 0
b 0
f 0

2 Methods

Rating   Name   Duplication   Size   Complexity  
onAdd() 0 1 ?
onRender() 0 1 ?
1
<?php
2
3
namespace Jasny\View;
4
5
use Jasny\ViewInterface;
6
7
/**
8
 * A view plugin can be used to add functionality to a view.
9
 */
10
interface PluginInterface
11
{
12
    /**
13
     * Called when the plugin is added to the view.
14
     * 
15
     * @param ViewInterface $view
16
     */
17
    public function onAdd(ViewInterface $view);
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
     * Called when view renders a template.
21
     * 
22
     * @param ViewInterface $view
23
     * @param string        $template   Template filename
24
     * @param array         $context
25
     */
26
    public function onRender(ViewInterface $view, $template, array $context);
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...
27
}
28