This project does not seem to handle request data directly as such no vulnerable execution paths were found.
include
, or for example
via PHP's auto-loading mechanism.
These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more
1 | <?php |
||
2 | |||
3 | /* |
||
4 | * This file is part of the PHP Translation package. |
||
5 | * |
||
6 | * (c) PHP Translation team <[email protected]> |
||
7 | * |
||
8 | * For the full copyright and license information, please view the LICENSE |
||
9 | * file that was distributed with this source code. |
||
10 | */ |
||
11 | |||
12 | namespace Translation\Common\Model; |
||
13 | |||
14 | final class Message implements MessageInterface |
||
15 | { |
||
16 | /** |
||
17 | * @var string |
||
18 | * |
||
19 | * The domain the message belongs to |
||
20 | */ |
||
21 | private $domain; |
||
22 | |||
23 | /** |
||
24 | * @var string |
||
25 | * |
||
26 | * The key/phrase you write in the source code |
||
27 | */ |
||
28 | private $key; |
||
29 | |||
30 | /** |
||
31 | * @var string |
||
32 | * |
||
33 | * The locale the translations is on |
||
34 | */ |
||
35 | private $locale; |
||
36 | |||
37 | /** |
||
38 | * @var string |
||
39 | * |
||
40 | * The translated string. This is the preview of the message. Ie no placeholders is visible. |
||
41 | */ |
||
42 | private $translation; |
||
43 | |||
44 | /** |
||
45 | * Key value array with metadata. |
||
46 | * |
||
47 | * @var array |
||
48 | */ |
||
49 | private $meta = []; |
||
50 | |||
51 | 11 | public function __construct(string $key, string $domain = '', string $locale = '', string $translation = '', array $meta = []) |
|
52 | { |
||
53 | 11 | $this->key = $key; |
|
54 | 11 | $this->domain = $domain; |
|
55 | 11 | $this->locale = $locale; |
|
56 | 11 | $this->translation = $translation; |
|
57 | 11 | $this->meta = $meta; |
|
58 | 11 | } |
|
59 | |||
60 | /** |
||
61 | * {@inheritdoc} |
||
62 | */ |
||
63 | 5 | public function getDomain(): string |
|
64 | { |
||
65 | 5 | return $this->domain; |
|
66 | } |
||
67 | |||
68 | /** |
||
69 | * {@inheritdoc} |
||
70 | */ |
||
71 | 2 | public function withDomain(string $domain): MessageInterface |
|
72 | { |
||
73 | 2 | $new = clone $this; |
|
74 | 2 | $new->domain = $domain; |
|
75 | |||
76 | 2 | return $new; |
|
0 ignored issues
–
show
|
|||
77 | } |
||
78 | |||
79 | /** |
||
80 | * {@inheritdoc} |
||
81 | */ |
||
82 | 5 | public function getKey(): string |
|
83 | { |
||
84 | 5 | return $this->key; |
|
85 | } |
||
86 | |||
87 | /** |
||
88 | * {@inheritdoc} |
||
89 | */ |
||
90 | 5 | public function getLocale(): string |
|
91 | { |
||
92 | 5 | return $this->locale; |
|
93 | } |
||
94 | |||
95 | /** |
||
96 | * {@inheritdoc} |
||
97 | */ |
||
98 | 2 | public function withLocale(string $locale): MessageInterface |
|
99 | { |
||
100 | 2 | $new = clone $this; |
|
101 | 2 | $new->locale = $locale; |
|
102 | |||
103 | 2 | return $new; |
|
0 ignored issues
–
show
The return type of
return $new; (Translation\Common\Model\Message ) is incompatible with the return type declared by the interface Translation\Common\Model...geInterface::withLocale of type self .
If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author {
private $name;
public function __construct($name) {
$this->name = $name;
}
public function getName() {
return $this->name;
}
}
abstract class Post {
public function getAuthor() {
return 'Johannes';
}
}
class BlogPost extends Post {
public function getAuthor() {
return new Author('Johannes');
}
}
class ForumPost extends Post { /* ... */ }
function my_function(Post $post) {
echo strtoupper($post->getAuthor());
}
Our function
Loading history...
|
|||
104 | } |
||
105 | |||
106 | /** |
||
107 | * {@inheritdoc} |
||
108 | */ |
||
109 | 6 | public function getTranslation(): string |
|
110 | { |
||
111 | 6 | return $this->translation; |
|
112 | } |
||
113 | |||
114 | /** |
||
115 | * {@inheritdoc} |
||
116 | */ |
||
117 | 2 | public function withTranslation(string $translation): MessageInterface |
|
118 | { |
||
119 | 2 | $new = clone $this; |
|
120 | 2 | $new->translation = $translation; |
|
121 | |||
122 | 2 | return $new; |
|
0 ignored issues
–
show
The return type of
return $new; (Translation\Common\Model\Message ) is incompatible with the return type declared by the interface Translation\Common\Model...erface::withTranslation of type self .
If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author {
private $name;
public function __construct($name) {
$this->name = $name;
}
public function getName() {
return $this->name;
}
}
abstract class Post {
public function getAuthor() {
return 'Johannes';
}
}
class BlogPost extends Post {
public function getAuthor() {
return new Author('Johannes');
}
}
class ForumPost extends Post { /* ... */ }
function my_function(Post $post) {
echo strtoupper($post->getAuthor());
}
Our function
Loading history...
|
|||
123 | } |
||
124 | |||
125 | /** |
||
126 | * {@inheritdoc} |
||
127 | */ |
||
128 | 2 | public function getAllMeta(): array |
|
129 | { |
||
130 | 2 | return $this->meta; |
|
131 | } |
||
132 | |||
133 | /** |
||
134 | * {@inheritdoc} |
||
135 | */ |
||
136 | 2 | public function withMeta(array $meta): MessageInterface |
|
137 | { |
||
138 | 2 | $new = clone $this; |
|
139 | 2 | $new->meta = $meta; |
|
140 | |||
141 | 2 | return $new; |
|
0 ignored issues
–
show
The return type of
return $new; (Translation\Common\Model\Message ) is incompatible with the return type declared by the interface Translation\Common\Model...sageInterface::withMeta of type self .
If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author {
private $name;
public function __construct($name) {
$this->name = $name;
}
public function getName() {
return $this->name;
}
}
abstract class Post {
public function getAuthor() {
return 'Johannes';
}
}
class BlogPost extends Post {
public function getAuthor() {
return new Author('Johannes');
}
}
class ForumPost extends Post { /* ... */ }
function my_function(Post $post) {
echo strtoupper($post->getAuthor());
}
Our function
Loading history...
|
|||
142 | } |
||
143 | |||
144 | /** |
||
145 | * {@inheritdoc} |
||
146 | */ |
||
147 | 2 | public function withAddedMeta(string $key, string $value): MessageInterface |
|
148 | { |
||
149 | 2 | $new = clone $this; |
|
150 | 2 | $new->meta[$key] = $value; |
|
151 | |||
152 | 2 | return $new; |
|
0 ignored issues
–
show
The return type of
return $new; (Translation\Common\Model\Message ) is incompatible with the return type declared by the interface Translation\Common\Model...nterface::withAddedMeta of type self .
If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author {
private $name;
public function __construct($name) {
$this->name = $name;
}
public function getName() {
return $this->name;
}
}
abstract class Post {
public function getAuthor() {
return 'Johannes';
}
}
class BlogPost extends Post {
public function getAuthor() {
return new Author('Johannes');
}
}
class ForumPost extends Post { /* ... */ }
function my_function(Post $post) {
echo strtoupper($post->getAuthor());
}
Our function
Loading history...
|
|||
153 | } |
||
154 | |||
155 | /** |
||
156 | * {@inheritdoc} |
||
157 | */ |
||
158 | 1 | public function getMeta(string $key, $default = null) |
|
159 | { |
||
160 | 1 | if (\array_key_exists($key, $this->meta)) { |
|
161 | 1 | return $this->meta[$key]; |
|
162 | } |
||
163 | |||
164 | 1 | return $default; |
|
165 | } |
||
166 | } |
||
167 |
If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design.
Let’s take a look at an example:
Our function
my_function
expects aPost
object, and outputs the author of the post. The base classPost
returns a simple string and outputting a simple string will work just fine. However, the child classBlogPost
which is a sub-type ofPost
instead decided to return anobject
, and is therefore violating the SOLID principles. If aBlogPost
were passed tomy_function
, PHP would not complain, but ultimately fail when executing thestrtoupper
call in its body.