Message::withLocale() - Code Metrics - php-translation/common - Measure and Improve Code Quality continuously with Scrutinizer

Message::withLocale() A
last analyzed 2021-03-25 16:15 UTC

↳ Parent: Message

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	7
ccs	4
cts	4
cp	1
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1
crap	1

<?php

/*
 * This file is part of the PHP Translation package.
 *
 * (c) PHP Translation team <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Translation\Common\Model;

final class Message implements MessageInterface
{
    /**
     * @var string
     *
     * The domain the message belongs to
     */
    private $domain;

    /**
     * @var string
     *
     * The key/phrase you write in the source code
     */
    private $key;

    /**
     * @var string
     *
     * The locale the translations is on
     */
    private $locale;

    /**
     * @var string
     *
     * The translated string. This is the preview of the message. Ie no placeholders is visible.
     */
    private $translation;

    /**
     * Key value array with metadata.
     *
     * @var array
     */
    private $meta = [];

    public function __construct(string $key, string $domain = '', string $locale = '', string $translation = '', array $meta = [])
    {
        $this->key = $key;
        $this->domain = $domain;
        $this->locale = $locale;
        $this->translation = $translation;
        $this->meta = $meta;
    }

    /**
     * {@inheritdoc}
     */
    public function getDomain(): string
    {
        return $this->domain;
    }

    /**
     * {@inheritdoc}
     */
    public function withDomain(string $domain): MessageInterface
    {
        $new = clone $this;
        $new->domain = $domain;

        return $new;
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());
}
    }

    /**
     * {@inheritdoc}
     */
    public function getKey(): string
    {
        return $this->key;
    }

    /**
     * {@inheritdoc}
     */
    public function getLocale(): string
    {
        return $this->locale;
    }

    /**
     * {@inheritdoc}
     */
    public function withLocale(string $locale): MessageInterface
    {
        $new = clone $this;
        $new->locale = $locale;

        return $new;
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());
}
    }

    /**
     * {@inheritdoc}
     */
    public function getTranslation(): string
    {
        return $this->translation;
    }

    /**
     * {@inheritdoc}
     */
    public function withTranslation(string $translation): MessageInterface
    {
        $new = clone $this;
        $new->translation = $translation;

        return $new;
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());
}
    }

    /**
     * {@inheritdoc}
     */
    public function getAllMeta(): array
    {
        return $this->meta;
    }

    /**
     * {@inheritdoc}
     */
    public function withMeta(array $meta): MessageInterface
    {
        $new = clone $this;
        $new->meta = $meta;

        return $new;
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());
}
    }

    /**
     * {@inheritdoc}
     */
    public function withAddedMeta(string $key, string $value): MessageInterface
    {
        $new = clone $this;
        $new->meta[$key] = $value;

        return $new;
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());
}
    }

    /**
     * {@inheritdoc}
     */
    public function getMeta(string $key, $default = null)
    {
        if (\array_key_exists($key, $this->meta)) {
            return $this->meta[$key];
        }

        return $default;
    }
}


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 Bug Best Practice introduced 2019-12-06 10:18 UTC by Report Bug Copy Issue Report The return type of `return $new;` (`Translation\Common\Model\Message`) is incompatible with the return type declared by the interface `Translation\Common\Model...geInterface::withDomain` 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 `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
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 Bug Best Practice introduced 2019-12-06 10:18 UTC by Report Bug Copy Issue Report 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 `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. 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 Bug Best Practice introduced 2019-12-06 10:18 UTC by Report Bug Copy Issue Report 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 `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. 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 Bug Best Practice introduced 2019-12-06 10:18 UTC by Report Bug Copy Issue Report 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 `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. 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 Bug Best Practice introduced 2019-12-06 10:18 UTC by Report Bug Copy Issue Report 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 `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. 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

php-translation / common

Message::withLocale() A last analyzed 2021-03-25 16:15 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Message::withLocale() A
last analyzed 2021-03-25 16:15 UTC