Emojify::setupEmojiMaps() - Code Metrics - Inspection of "Refactor Multibot Support." - irazasyed/telegram-bot-sdk - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( e02d88...60454e )

by Irfaq

created 2016-04-17 06:18 UTC

Emojify::setupEmojiMaps() A

↳ Parent: Emojify

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	5
ccs	0
cts	0
cp	0
rs	9.4285
cc	1
eloc	3
nc	1
nop	0
crap	2

<?php

namespace Telegram\Bot\Helpers;

use Telegram\Bot\Exceptions\TelegramEmojiMapFileNotFoundException;

class Emojify
{
    /**
     * @var Singleton The reference to *Singleton* instance of this class
     */
    private static $instance;

    /**
     * The path to the file containing the emoji map.
     *
     * @var string
     */
    const DEFAULT_EMOJI_MAP_FILE = '/../Storage/emoji.json';

    /**
     * The path to the file containing the emoji map.
     *
     * @var string
     */
    protected $emojiMapFile;

    /**
     * The array mapping words to emoji.
     *
     * @var array
     */
    protected $emojiMap;

    /**
     * The array mapping emoji back to words.
     *
     * @var array
     */
    protected $wordMap;

    /**
     * Protected Emojify constructor to prevent creating a new instance of the
     * *Singleton* via the `new` operator from outside of this class.
     *
     * @throws TelegramEmojiMapFileNotFoundException
     */
    protected function __construct()
    {
        $this->setupEmojiMaps();
    }

    /**
     * Returns the *Singleton* instance of this class.
     *
     * @return Singleton The *Singleton* instance.
     */
    public static function getInstance()
    {
        if (null === static::$instance) {
class YourClass
{
    private static $someVariable;

    public static function getSomeVariable()
    {
        return static::$someVariable;
    }
}
            static::$instance = new static();
class YourClass
{
    private static $someVariable;

    public static function getSomeVariable()
    {
        return static::$someVariable;
    }
}
        }

        return static::$instance;
class YourClass
{
    private static $someVariable;

    public static function getSomeVariable()
    {
        return static::$someVariable;
    }
}
    }

    /**
     * Set File Path to Emoji Map File.
     *
     * @param string $emojiMapFile
     *
     * @return Emojify
     */
    public function setEmojiMapFile($emojiMapFile)
    {
        $this->emojiMapFile = $emojiMapFile;
        $this->setupEmojiMaps();

        return $this;
    }

    /**
     * Translate Word to Emoji
     *
     * @param $text
     *
     * @return mixed
     */
    public function toEmoji($text)
    {
        return $this->replace($text, $this->emojiMap);
    }

    /**
     * Alias of toEmoji()
     *
     * @param $text
     *
     * @return mixed
     */
    public static function text($text)
    {
        return self::getInstance()->toEmoji($text);
    }

    /**
     * Translate Emoji to Word
     *
     * @param $text
     *
     * @return mixed
     */
    public function toWord($text)
    {
        return $this->replace($text, $this->wordMap, true);
    }

    /**
     * Alias of toWord()
     *
     * @param $text
     *
     * @return mixed
     */
    public static function translate($text)
    {
        return self::getInstance()->toWord($text);
    }

    /**
     * Replace
     *
     * @param        $line
     * @param        $replace
     * @param bool   $toWord
     * @param string $delimiter
     *
     * @return mixed
     */
    protected function replace($line, $replace, $toWord = false, $delimiter = ':')
    {
        uksort($replace, function ($a, $b) {
            return strlen($b) - strlen($a);
        });


        if ($toWord) {
            return $this->emojiToWordReplace($line, $replace, $delimiter);
        }

        return $this->wordToEmojiReplace($line, $replace, $delimiter);
    }

    /**
     * Finds words enclosed by the delimiter and converts them to the
     * appropriate emoji character.
     *
     * @param $line
     * @param $replace
     * @param $delimiter
     *
     * @return mixed
     */
    protected function wordToEmojiReplace($line, $replace, $delimiter)

    {
        foreach ($replace as $key => $value) {
            $line = str_replace($delimiter.$key.$delimiter, $value, $line);
        }

        return $line;
    }

    /**
     * Finds emojis and replaces them with text enclosed by the delimiter
     *
     * @param $line
     * @param $replace
     * @param $delimiter
     *
     * @return mixed
     */
    protected function emojiToWordReplace($line, $replace, $delimiter)

    {
        foreach ($replace as $key => $value) {
            $line = str_replace($key, $delimiter.$value.$delimiter, $line);
        }

        return $line;
    }

    /**
     * Get Emoji Map Array.
     *
     * @return array
     * @throws TelegramEmojiMapFileNotFoundException
     */
    protected function getEmojiMap()
    {
        if (!isset($this->emojiMapFile)) {
            $this->emojiMapFile = realpath(__DIR__.self::DEFAULT_EMOJI_MAP_FILE);
        }

        if (!file_exists($this->emojiMapFile)) {
            throw new TelegramEmojiMapFileNotFoundException();
        }

        return json_decode(file_get_contents($this->emojiMapFile), true);
    }

    /**
     * Setup Emoji Maps.
     *
     * @throws TelegramEmojiMapFileNotFoundException
     */
    protected function setupEmojiMaps()
    {
        $this->emojiMap = $this->getEmojiMap();
        $this->wordMap = array_flip($this->emojiMap);
    }

    /**
     * Private clone method to prevent cloning of the instance of the
     * *Singleton* instance.
     *
     * @return void
     */
    private function __clone()
    {
    }

    /**
     * Private unserialize method to prevent unserializing of the *Singleton*
     * instance.
     *
     * @return void
     */
    private function __wakeup()
    {
    }
}


1			<?php
2
3			namespace Telegram\Bot\Helpers;
4
5			use Telegram\Bot\Exceptions\TelegramEmojiMapFileNotFoundException;
6
7			class Emojify
8			{
9			/**
10			* @var Singleton The reference to Singleton instance of this class
11			*/
12			private static $instance;
13
14			/**
15			* The path to the file containing the emoji map.
16			*
17			* @var string
18			*/
19			const DEFAULT_EMOJI_MAP_FILE = '/../Storage/emoji.json';
20
21			/**
22			* The path to the file containing the emoji map.
23			*
24			* @var string
25			*/
26			protected $emojiMapFile;
27
28			/**
29			* The array mapping words to emoji.
30			*
31			* @var array
32			*/
33			protected $emojiMap;
34
35			/**
36			* The array mapping emoji back to words.
37	76		*
38			* @var array
39	76		*/
40	76		protected $wordMap;
41	76
42			/**
43	76		* Protected Emojify constructor to prevent creating a new instance of the
44	2		* Singleton via the `new` operator from outside of this class.
45			*
46			* @throws TelegramEmojiMapFileNotFoundException
47	76		*/
48	76		protected function __construct()
49	76		{
50	76		$this->setupEmojiMaps();
51			}
52
53			/**
54			* Returns the Singleton instance of this class.
55			*
56			* @return Singleton The Singleton instance.
57			*/
58			public static function getInstance()
59	6		{
60			if (null === static::$instance) {
			0 ignored issues – show Bug introduced 2016-04-17 06:20 UTC by Report Bug Copy Issue Report Since `$instance` is declared private, accessing it with `static` will lead to errors in possible sub-classes; consider using `self`, or increasing the visibility of `$instance` to at least protected. Let’s assume you have a class which uses late-static binding: class YourClass { private static $someVariable; public static function getSomeVariable() { return static::$someVariable; } } The code above will run fine in your PHP runtime. However, if you now create a sub-class and call the `getSomeVariable()` on that sub-class, you will receive a runtime error: class YourSubClass extends YourClass { } YourSubClass::getSomeVariable(); // Will cause an access error. In the case above, it makes sense to update `SomeClass` to use `self` instead: class SomeClass { private static $someVariable; public static function getSomeVariable() { return self::$someVariable; // self works fine with private. } } Loading history...
61	6		static::$instance = new static();
			0 ignored issues – show Bug introduced 2016-04-17 06:20 UTC by Report Bug Copy Issue Report Since `$instance` is declared private, accessing it with `static` will lead to errors in possible sub-classes; consider using `self`, or increasing the visibility of `$instance` to at least protected. Let’s assume you have a class which uses late-static binding: class YourClass { private static $someVariable; public static function getSomeVariable() { return static::$someVariable; } } The code above will run fine in your PHP runtime. However, if you now create a sub-class and call the `getSomeVariable()` on that sub-class, you will receive a runtime error: class YourSubClass extends YourClass { } YourSubClass::getSomeVariable(); // Will cause an access error. In the case above, it makes sense to update `SomeClass` to use `self` instead: class SomeClass { private static $someVariable; public static function getSomeVariable() { return self::$someVariable; // self works fine with private. } } Loading history... Documentation Bug introduced 2016-04-17 06:20 UTC by Report Bug Copy Issue Report It seems like `new static()` of type `this<Telegram\Bot\Helpers\Emojify>` is incompatible with the declared type `object<Telegram\Bot\Helpers\Singleton>` of property `$instance`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
62			}
63
64			return static::$instance;
			0 ignored issues – show Bug introduced 2016-04-17 06:20 UTC by Report Bug Copy Issue Report Since `$instance` is declared private, accessing it with `static` will lead to errors in possible sub-classes; consider using `self`, or increasing the visibility of `$instance` to at least protected. Let’s assume you have a class which uses late-static binding: class YourClass { private static $someVariable; public static function getSomeVariable() { return static::$someVariable; } } The code above will run fine in your PHP runtime. However, if you now create a sub-class and call the `getSomeVariable()` on that sub-class, you will receive a runtime error: class YourSubClass extends YourClass { } YourSubClass::getSomeVariable(); // Will cause an access error. In the case above, it makes sense to update `SomeClass` to use `self` instead: class SomeClass { private static $someVariable; public static function getSomeVariable() { return self::$someVariable; // self works fine with private. } } Loading history...
65			}
66
67			/**
68			* Set File Path to Emoji Map File.
69			*
70			* @param string $emojiMapFile
71			*
72			* @return Emojify
73			*/
74			public function setEmojiMapFile($emojiMapFile)
75			{
76			$this->emojiMapFile = $emojiMapFile;
77			$this->setupEmojiMaps();
78
79			return $this;
80			}
81
82			/**
83	10		* Translate Word to Emoji
84			*
85	10		* @param $text
86			*
87			* @return mixed
88			*/
89			public function toEmoji($text)
90			{
91			return $this->replace($text, $this->emojiMap);
92			}
93
94			/**
95	8		* Alias of toEmoji()
96			*
97	8		* @param $text
98			*
99			* @return mixed
100			*/
101			public static function text($text)
102			{
103			return self::getInstance()->toEmoji($text);
104			}
105
106			/**
107			* Translate Emoji to Word
108			*
109			* @param $text
110			*
111			* @return mixed
112	14		*/
113	14		public function toWord($text)
114	14		{
115			return $this->replace($text, $this->wordMap, true);
116			}
117	14
118	10		/**
119			* Alias of toWord()
120			*
121	6		* @param $text
122			*
123			* @return mixed
124			*/
125			public static function translate($text)
126			{
127			return self::getInstance()->toWord($text);
128			}
129
130			/**
131			* Replace
132			*
133			* @param $line
134	6		* @param $replace
135			* @param bool $toWord
136	6		* @param string $delimiter
137	6		*
138	6		* @return mixed
139			*/
140	6		protected function replace($line, $replace, $toWord = false, $delimiter = ':')
141			{
142			uksort($replace, function ($a, $b) {
143			return strlen($b) - strlen($a);
144			});
145
146
147			if ($toWord) {
148			return $this->emojiToWordReplace($line, $replace, $delimiter);
149			}
150
151			return $this->wordToEmojiReplace($line, $replace, $delimiter);
152	10		}
153
154	10		/**
155	10		* Finds words enclosed by the delimiter and converts them to the
156	10		* appropriate emoji character.
157			*
158	10		* @param $line
159			* @param $replace
160			* @param $delimiter
161			*
162			* @return mixed
163			*/
164		View Code Duplication	protected function wordToEmojiReplace($line, $replace, $delimiter)
			0 ignored issues – show Duplication introduced 2016-04-16 17:15 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
165			{
166			foreach ($replace as $key => $value) {
167			$line = str_replace($delimiter.$key.$delimiter, $value, $line);
168			}
169
170			return $line;
171			}
172
173			/**
174			* Finds emojis and replaces them with text enclosed by the delimiter
175			*
176			* @param $line
177			* @param $replace
178			* @param $delimiter
179			*
180			* @return mixed
181			*/
182		View Code Duplication	protected function emojiToWordReplace($line, $replace, $delimiter)
			0 ignored issues – show Duplication introduced 2016-04-16 17:15 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
183			{
184			foreach ($replace as $key => $value) {
185			$line = str_replace($key, $delimiter.$value.$delimiter, $line);
186			}
187
188			return $line;
189			}
190
191			/**
192			* Get Emoji Map Array.
193			*
194			* @return array
195			* @throws TelegramEmojiMapFileNotFoundException
196			*/
197			protected function getEmojiMap()
198			{
199			if (!isset($this->emojiMapFile)) {
200			$this->emojiMapFile = realpath(__DIR__.self::DEFAULT_EMOJI_MAP_FILE);
201			}
202
203			if (!file_exists($this->emojiMapFile)) {
204			throw new TelegramEmojiMapFileNotFoundException();
205			}
206
207			return json_decode(file_get_contents($this->emojiMapFile), true);
208			}
209
210			/**
211			* Setup Emoji Maps.
212			*
213			* @throws TelegramEmojiMapFileNotFoundException
214			*/
215			protected function setupEmojiMaps()
216			{
217			$this->emojiMap = $this->getEmojiMap();
218			$this->wordMap = array_flip($this->emojiMap);
219			}
220
221			/**
222			* Private clone method to prevent cloning of the instance of the
223			* Singleton instance.
224			*
225			* @return void
226			*/
227			private function __clone()
228			{
229			}
230
231			/**
232			* Private unserialize method to prevent unserializing of the Singleton
233			* instance.
234			*
235			* @return void
236			*/
237			private function __wakeup()
238			{
239			}
240			}
241

irazasyed / telegram-bot-sdk

Push — master ( e02d88...60454e )

Emojify::setupEmojiMaps() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like