ValueObject::__toString()
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 BestServedCold\PhalueObjects\Contract;
4
5
/**
6
 * Interface ValueObjectInterface
7
 *
8
 * @package  BestServedCold\PhalueObjects\Contract
9
 */
10
interface ValueObject
0 ignored issues
show
Coding Style introduced by
ValueObject does not seem to conform to the naming convention (^[A-Z][a-zA-Z0-9]*Interface$).

This check examines a number of code elements and verifies that they conform to the given naming conventions.

You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods.

Loading history...
11
{
12
    /**
13
     * @return string
14
     */
15
    public function __toString();
16
17
    /**
18
     * @param  $field
19
     * @param  $value
20
     * @throws \RuntimeException
21
     */
22
    public function __set($field, $value);
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...
23
24
    /**
25
     * @return mixed
26
     */
27
    public function getValue();
28
29
    /**
30
     * @param  ValueObject $object
31
     * @return bool
32
     */
33
    public function equals(ValueObject $object);
0 ignored issues
show
Coding Style introduced by
function equals() does not seem to conform to the naming convention (^(?:is|has|should|may|supports)).

This check examines a number of code elements and verifies that they conform to the given naming conventions.

You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods.

Loading history...
34
35
    /**
36
     * @return string
37
     */
38
    public function getType();
39
40
    /**
41
     * @return string
42
     */
43
    public function hash();
44
45
    /**
46
     * @inheritdoc
47
     */
48
    public function __destruct();
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...
49
}
50