MappingTrait::getTemplateByCode() - Code Metrics - phossa2/shared - Measure and Improve Code Quality continuously with Scrutinizer

MappingTrait::getTemplateByCode() A
last analyzed 2017-01-16 10:10 UTC

↳ Parent: MappingTrait

Complexity

Conditions	3
Paths	3

Size

Total Lines	21
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	21
c	0
b	0
f	0
rs	9.3142
cc	3
eloc	9
nc	3
nop	2

<?php
/**
 * Phossa Project
 *
 * PHP version 5.4
 *
 * @category  Library
 * @package   Phossa2\Shared
 * @copyright Copyright (c) 2016 phossa.com
 * @license   http://mit-license.org/ MIT License
 * @link      http://www.phossa.com/
 */
/*# declare(strict_types=1); */

namespace Phossa2\Shared\Message\Mapping;

use Phossa2\Shared\Message\Loader\LoaderAwareTrait;

/**
 * MappingTrait
 *
 * One implementation of `MappingInterface`
 *
 * @package Phossa2\Shared
 * @author  Hong Zhang <[email protected]>
 * @see     MappingInterface
 * @version 2.0.0
 * @since   2.0.0 added
 */
trait MappingTrait
{
    use LoaderAwareTrait;

    /**
     * Ddefault messages for current message class
     *
     * This property HAS TO BE redefined for each descendant message class !
     *
     * @var    string[]
     * @access protected
     */
    protected static $messages = [];

    /**
     * Message mapping cache
     *
     * @var    array
     * @access private
     */
    private static $mappings = [];

    /**
     * Reset current message class' code to message mappings cache
     *
     * ```php
     *     MyMessage::setMappings([
     *         MyMessage::MSG_HELLO => 'Hello %s'
     *     ]);
     * ```
     *
     * @param  array $messages messages mapping array
     * @param  bool $manual manually, not auto load from $loader
     * @access public
     * @api
     */
    public static function setMappings(
        array $messages,
        /*# bool */ $manual = true
    ) {
        $class = get_called_class();

        if ($manual) {
            // set default
            static::$messages = $messages;

            // status changed
            self::setStatus();
        } else {
            // set cache
            self::$mappings[$class] = array_replace(
                $class::getMappings(),
                $messages
            );
        }
    }

    /**
     * Check current class' message mapping cache
     *
     * @return bool
     * @access protected
     */
    protected static function hasMappings()/*# : bool */
    {
        return isset(self::$mappings[get_called_class()]);
    }

    /**
     * Get current class' message mapping, default or cached
     *
     * @return array
     * @access protected
     */
    protected static function getMappings()/*# : array */
    {
        // use cached first if any
        if (static::hasMappings()) {
            return self::$mappings[get_called_class()];
        }

        // return the default
        return static::$messages;
    }

    /**
     * Clear the mapping cache
     *
     * @access protected
     */
    protected static function resetMappings()
    {
        self::$mappings = [];
    }

    /**
     * Check message template in default mapping
     *
     * @param  int $code the message code
     * @return bool
     * @access protected
     */
    protected static function messageDefined(/*# int */ $code)/*# : bool */
    {
        return isset(static::$messages[$code]);
    }

    /**
     * Resolving code for current message class, from cache or default
     *
     * If nothing found, return the code anyway
     *
     * @param  int $code the message code
     * @return string
     * @access protected
     */
    protected static function getMessage(/*# int */ $code)/*# : string */
    {
        $mapping = static::getMappings();
        if (isset($mapping[$code])) {
            return $mapping[$code];
        }
        return (string) $code;
    }

    /**
     * Resolving $code to message template, start from $class
     *
     * @param  int $code message code
     * @param  string $class class name
     * @return string
     * @access protected
     */
    protected static function getTemplateByCode(
        /*# int */ $code,
        /*# string */ $class
    )/*# : string */ {
        // default template, last resort
        if (__CLASS__ === $class) {
            return "unknown message code: $code, %s";
        }

        // check $class
        if ($class::messageDefined($code)) {
            // load message mapping for $class
            $class::loadMappings();

            // get the message template
            return $class::getMessage($code);
        }

        // search upwards
        return self::getTemplateByCode($code, get_parent_class($class));
    }

    /**
     * Load message mappings into cache for $class
     *
     * @access protected
     */
    protected static function loadMappings()
    {
        // check status
        self::checkStatus();

        // mapping cache loaded already for $class
        if (static::hasMappings()) {
            return;
        }

        // load $class mapping
        $loadedClass = static::hasLoader(true);
        static::setMappings(
            $loadedClass ?
                $loadedClass::getLoader()->loadMessages(get_called_class()) : [],
            false
        );
    }

    /**
     * Update mapping cache if status changed
     *
     * @access protected
     */
    protected static function checkStatus()
    {
        if (self::isStatusUpdated()) {
            self::resetMappings();
            self::setStatus(false);
        }
    }
}


1			<?php
2			/**
3			* Phossa Project
4			*
5			* PHP version 5.4
6			*
7			* @category Library
8			* @package Phossa2\Shared
9			* @copyright Copyright (c) 2016 phossa.com
10			* @license http://mit-license.org/ MIT License
11			* @link http://www.phossa.com/
12			*/
13			/# declare(strict_types=1); /
14
15			namespace Phossa2\Shared\Message\Mapping;
16
17			use Phossa2\Shared\Message\Loader\LoaderAwareTrait;
18
19			/**
20			* MappingTrait
21			*
22			* One implementation of `MappingInterface`
23			*
24			* @package Phossa2\Shared
25			* @author Hong Zhang <[email protected]>
26			* @see MappingInterface
27			* @version 2.0.0
28			* @since 2.0.0 added
29			*/
30			trait MappingTrait
31			{
32			use LoaderAwareTrait;
33
34			/**
35			* Ddefault messages for current message class
36			*
37			* This property HAS TO BE redefined for each descendant message class !
38			*
39			* @var string[]
40			* @access protected
41			*/
42			protected static $messages = [];
43
44			/**
45			* Message mapping cache
46			*
47			* @var array
48			* @access private
49			*/
50			private static $mappings = [];
51
52			/**
53			* Reset current message class' code to message mappings cache
54			*
55			* ```php
56			* MyMessage::setMappings([
57			* MyMessage::MSG_HELLO => 'Hello %s'
58			* ]);
59			* ```
60			*
61			* @param array $messages messages mapping array
62			* @param bool $manual manually, not auto load from $loader
63			* @access public
64			* @api
65			*/
66			public static function setMappings(
67			array $messages,
68			/# bool / $manual = true
69			) {
70			$class = get_called_class();
71
72			if ($manual) {
73			// set default
74			static::$messages = $messages;
75
76			// status changed
77			self::setStatus();
78			} else {
79			// set cache
80			self::$mappings[$class] = array_replace(
81			$class::getMappings(),
82			$messages
83			);
84			}
85			}
86
87			/**
88			* Check current class' message mapping cache
89			*
90			* @return bool
91			* @access protected
92			*/
93			protected static function hasMappings()/# : bool /
94			{
95			return isset(self::$mappings[get_called_class()]);
96			}
97
98			/**
99			* Get current class' message mapping, default or cached
100			*
101			* @return array
102			* @access protected
103			*/
104			protected static function getMappings()/# : array /
105			{
106			// use cached first if any
107			if (static::hasMappings()) {
108			return self::$mappings[get_called_class()];
109			}
110
111			// return the default
112			return static::$messages;
113			}
114
115			/**
116			* Clear the mapping cache
117			*
118			* @access protected
119			*/
120			protected static function resetMappings()
121			{
122			self::$mappings = [];
123			}
124
125			/**
126			* Check message template in default mapping
127			*
128			* @param int $code the message code
129			* @return bool
130			* @access protected
131			*/
132			protected static function messageDefined(/# int / $code)/# : bool /
133			{
134			return isset(static::$messages[$code]);
135			}
136
137			/**
138			* Resolving code for current message class, from cache or default
139			*
140			* If nothing found, return the code anyway
141			*
142			* @param int $code the message code
143			* @return string
144			* @access protected
145			*/
146			protected static function getMessage(/# int / $code)/# : string /
147			{
148			$mapping = static::getMappings();
149			if (isset($mapping[$code])) {
150			return $mapping[$code];
151			}
152			return (string) $code;
153			}
154
155			/**
156			* Resolving $code to message template, start from $class
157			*
158			* @param int $code message code
159			* @param string $class class name
160			* @return string
161			* @access protected
162			*/
163			protected static function getTemplateByCode(
164			/# int / $code,
165			/# string / $class
166			)/# : string / {
167			// default template, last resort
168			if (__CLASS__ === $class) {
169			return "unknown message code: $code, %s";
170			}
171
172			// check $class
173			if ($class::messageDefined($code)) {
174			// load message mapping for $class
175			$class::loadMappings();
176
177			// get the message template
178			return $class::getMessage($code);
179			}
180
181			// search upwards
182			return self::getTemplateByCode($code, get_parent_class($class));
183			}
184
185			/**
186			* Load message mappings into cache for $class
187			*
188			* @access protected
189			*/
190			protected static function loadMappings()
191			{
192			// check status
193			self::checkStatus();
194
195			// mapping cache loaded already for $class
196			if (static::hasMappings()) {
197			return;
198			}
199
200			// load $class mapping
201			$loadedClass = static::hasLoader(true);
202			static::setMappings(
203			$loadedClass ?
204			$loadedClass::getLoader()->loadMessages(get_called_class()) : [],
205			false
206			);
207			}
208
209			/**
210			* Update mapping cache if status changed
211			*
212			* @access protected
213			*/
214			protected static function checkStatus()
215			{
216			if (self::isStatusUpdated()) {
217			self::resetMappings();
218			self::setStatus(false);
219			}
220			}
221			}
222

phossa2 / shared

MappingTrait::getTemplateByCode() A last analyzed 2017-01-16 10:10 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

MappingTrait::getTemplateByCode() A
last analyzed 2017-01-16 10:10 UTC