ReferenceTrait::resolveUnknown()

Completed

Push — master ( 7316d8...f9f65a )

by Hong

created 2016-06-24 04:18 UTC

↳ Parent: ReferenceTrait

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	1

Metric	Value
c	2
b	0
f	1
dl	0
loc	1
nc	1

<?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\Reference;

use Phossa2\Shared\Message\Message;
use Phossa2\Shared\Exception\RuntimeException;

/**
 * ReferenceTrait
 *
 * Provides reference & dereference methods
 *
 * @package Phossa2\Shared
 * @author  Hong Zhang <[email protected]>
 * @see     ReferenceInterface
 * @version 2.0.4
 * @since   2.0.4 added
 * @since   2.0.6 added reference cache support
 */
trait ReferenceTrait
{
    /**
     * refernece start chars
     *
     * @var    string
     * @access protected
     */
    protected $ref_start = '${';

    /**
     * reference ending chars
     *
     * @var    string
     * @access protected
     */
    protected $ref_end = '}';

    /**
     * cached pattern to match
     *
     * @var    string
     * @access protected
     */
    protected $ref_pattern = '~(\$\{((?:(?!\$\{|\}).)+?)\})~';

    /**
     * cached references
     *
     * @var    array
     * @access protected
     * @since  2.0.6
     */
    protected $ref_cache = [];

    /**
     * {@inheritDoc}
     */
    public function setReference(
        /*# string */ $start,
        /*# string */ $end
    ) {
        $this->ref_start = $start;
        $this->ref_end = $end;

        // build pattern
        $s = preg_quote($start);
        $e = preg_quote($end);
        $this->ref_pattern = sprintf(
            "~(%s((?:(?!%s|%s).)+?)%s)~", $s, $s, $e, $e
        );

        return $this;
    }

    /**
     * {@inheritDoc}
     */
    public function hasReference(
        /*# string */ $subject,
        array &$matched
    )/*# : bool */ {
        if (is_string($subject) &&
            false !== strpos($subject, $this->ref_start) &&
            preg_match($this->ref_pattern, $subject, $matched)
        ) {
            return true;
        }
        return false;
    }

    /**
     * {@inheritDoc}
     */
    public function deReference(/*# string */ $subject)
    {
        $loop = 0;
        $matched = [];

        while ($this->hasReference($subject, $matched)) {
            // check loop
            $this->checkReferenceLoop($loop++, $matched[2]);

            // resolve the reference
            $val = $this->resolveReference($matched[2]);

            // resolved to another string
            if (is_string($val)) {
                $subject = str_replace($matched[1], $val, $subject);

            // resolved to array, object, null etc.
            } else {
                return $this->checkValue($val, $subject, $matched[1]);
            }
        }
        return $subject;
    }

    /**
     * {@inheritDoc}
     */
    public function deReferenceArray(&$dataArray)
    {
        if (is_string($dataArray)) {
            $dataArray = $this->deReference($dataArray);
        }

        if (!is_array($dataArray)) {
            return;
        }

        foreach ($dataArray as &$data) {
            $this->dereferenceArray($data);
        }
    }

    /**
     * Check dereferenced value
     *
     * @param  mixed $value
     * @param  string $subject
     * @param  string $reference
     * @return mixed
     * @throws RuntimeException if $subject malformed, like mix string & array
     * @access protected
     */
    protected function checkValue(
        $value,
        /*# string */ $subject,
        /*# string */ $reference
    ) {
        // unknown reference found, leave it alone
        if (is_null($value)) {
            // exception thrown in resolveUnknown() already if wanted to
            return $subject;

        // malformed partial match
        } elseif ($subject != $reference) {
            throw new RuntimeException(
                Message::get(Message::MSG_REF_MALFORMED, $reference),
                Message::MSG_REF_MALFORMED
            );

        // full match, array or object
        } else {
            return $value;
        }
    }

    /**
     * Resolve the reference $name
     *
     * @param  string $name
     * @return mixed
     * @throws RuntimeException if reference unknown
     * @access protected
     * @since  2.0.6 added cache support
     */
    protected function resolveReference(/*# string */ $name)
    {
        try {
            // try reference cache first
            if (isset($this->ref_cache[$name])) {
                return $this->ref_cache[$name];
            }

            // get referenced value
            $val = $this->getReference($name);

            // unknown ref found
            if (is_null($val)) {
                $val = $this->resolveUnknown($name);
            }

            // cache deref result
            $this->ref_cache[$name] = $val;

            return $val;

        } catch (\Exception $e) {
            throw new RuntimeException($e->getMessage(), $e->getCode());
        }
    }

    /**
     * Throw exception if looped
     *
     * @param  int $loop loop counter
     * @param  string $name reference name
     * @throws RuntimeException if loop found
     * @access public
     */
    protected function checkReferenceLoop(
        /*# int */ $loop,
        /*# string */ $name
    ) {
        if ($loop > 20) {
            throw new RuntimeException(
                Message::get(Message::MSG_REF_LOOP, $name),
                Message::MSG_REF_LOOP
            );
        }
    }

    /**
     * Clear reference cache
     *
     * @return $this
     * @access protected
     * @since  2.0.6 added
     */
    protected function clearReferenceCache()
    {
        $this->ref_cache = [];
        return $this;
    }

    /**
     * For unknown reference $name, normally returns NULL
     *
     * @param  string $name
     * @return mixed
     * @throws \Exception if implementor WANTS TO !!
     * @access protected
     */
    abstract protected function resolveUnknown(/*# string */ $name);

    /**
     * The real resolving method. return NULL for unknown reference
     *
     * @param  string $name
     * @return mixed
     * @access protected
     */
    abstract protected function getReference(/*# string */ $name);
}


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\Reference;
16
17			use Phossa2\Shared\Message\Message;
18			use Phossa2\Shared\Exception\RuntimeException;
19
20			/**
21			* ReferenceTrait
22			*
23			* Provides reference & dereference methods
24			*
25			* @package Phossa2\Shared
26			* @author Hong Zhang <[email protected]>
27			* @see ReferenceInterface
28			* @version 2.0.4
29			* @since 2.0.4 added
30			* @since 2.0.6 added reference cache support
31			*/
32			trait ReferenceTrait
33			{
34			/**
35			* refernece start chars
36			*
37			* @var string
38			* @access protected
39			*/
40			protected $ref_start = '${';
41
42			/**
43			* reference ending chars
44			*
45			* @var string
46			* @access protected
47			*/
48			protected $ref_end = '}';
49
50			/**
51			* cached pattern to match
52			*
53			* @var string
54			* @access protected
55			*/
56			protected $ref_pattern = '~(\$\{((?:(?!\$\{\|\}).)+?)\})~';
57
58			/**
59			* cached references
60			*
61			* @var array
62			* @access protected
63			* @since 2.0.6
64			*/
65			protected $ref_cache = [];
66
67			/**
68			* {@inheritDoc}
69			*/
70			public function setReference(
71			/# string / $start,
72			/# string / $end
73			) {
74			$this->ref_start = $start;
75			$this->ref_end = $end;
76
77			// build pattern
78			$s = preg_quote($start);
79			$e = preg_quote($end);
80			$this->ref_pattern = sprintf(
81			"~(%s((?:(?!%s\|%s).)+?)%s)~", $s, $s, $e, $e
82			);
83
84			return $this;
85			}
86
87			/**
88			* {@inheritDoc}
89			*/
90			public function hasReference(
91			/# string / $subject,
92			array &$matched
93			)/# : bool / {
94			if (is_string($subject) &&
95			false !== strpos($subject, $this->ref_start) &&
96			preg_match($this->ref_pattern, $subject, $matched)
97			) {
98			return true;
99			}
100			return false;
101			}
102
103			/**
104			* {@inheritDoc}
105			*/
106			public function deReference(/# string / $subject)
107			{
108			$loop = 0;
109			$matched = [];
110
111			while ($this->hasReference($subject, $matched)) {
112			// check loop
113			$this->checkReferenceLoop($loop++, $matched[2]);
114
115			// resolve the reference
116			$val = $this->resolveReference($matched[2]);
117
118			// resolved to another string
119			if (is_string($val)) {
120			$subject = str_replace($matched[1], $val, $subject);
121
122			// resolved to array, object, null etc.
123			} else {
124			return $this->checkValue($val, $subject, $matched[1]);
125			}
126			}
127			return $subject;
128			}
129
130			/**
131			* {@inheritDoc}
132			*/
133			public function deReferenceArray(&$dataArray)
134			{
135			if (is_string($dataArray)) {
136			$dataArray = $this->deReference($dataArray);
137			}
138
139			if (!is_array($dataArray)) {
140			return;
141			}
142
143			foreach ($dataArray as &$data) {
144			$this->dereferenceArray($data);
145			}
146			}
147
148			/**
149			* Check dereferenced value
150			*
151			* @param mixed $value
152			* @param string $subject
153			* @param string $reference
154			* @return mixed
155			* @throws RuntimeException if $subject malformed, like mix string & array
156			* @access protected
157			*/
158			protected function checkValue(
159			$value,
160			/# string / $subject,
161			/# string / $reference
162			) {
163			// unknown reference found, leave it alone
164			if (is_null($value)) {
165			// exception thrown in resolveUnknown() already if wanted to
166			return $subject;
167
168			// malformed partial match
169			} elseif ($subject != $reference) {
170			throw new RuntimeException(
171			Message::get(Message::MSG_REF_MALFORMED, $reference),
172			Message::MSG_REF_MALFORMED
173			);
174
175			// full match, array or object
176			} else {
177			return $value;
178			}
179			}
180
181			/**
182			* Resolve the reference $name
183			*
184			* @param string $name
185			* @return mixed
186			* @throws RuntimeException if reference unknown
187			* @access protected
188			* @since 2.0.6 added cache support
189			*/
190			protected function resolveReference(/# string / $name)
191			{
192			try {
193			// try reference cache first
194			if (isset($this->ref_cache[$name])) {
195			return $this->ref_cache[$name];
196			}
197
198			// get referenced value
199			$val = $this->getReference($name);
200
201			// unknown ref found
202			if (is_null($val)) {
203			$val = $this->resolveUnknown($name);
204			}
205
206			// cache deref result
207			$this->ref_cache[$name] = $val;
208
209			return $val;
210
211			} catch (\Exception $e) {
212			throw new RuntimeException($e->getMessage(), $e->getCode());
213			}
214			}
215
216			/**
217			* Throw exception if looped
218			*
219			* @param int $loop loop counter
220			* @param string $name reference name
221			* @throws RuntimeException if loop found
222			* @access public
223			*/
224			protected function checkReferenceLoop(
225			/# int / $loop,
226			/# string / $name
227			) {
228			if ($loop > 20) {
229			throw new RuntimeException(
230			Message::get(Message::MSG_REF_LOOP, $name),
231			Message::MSG_REF_LOOP
232			);
233			}
234			}
235
236			/**
237			* Clear reference cache
238			*
239			* @return $this
240			* @access protected
241			* @since 2.0.6 added
242			*/
243			protected function clearReferenceCache()
244			{
245			$this->ref_cache = [];
246			return $this;
247			}
248
249			/**
250			* For unknown reference $name, normally returns NULL
251			*
252			* @param string $name
253			* @return mixed
254			* @throws \Exception if implementor WANTS TO !!
255			* @access protected
256			*/
257			abstract protected function resolveUnknown(/# string / $name);
258
259			/**
260			* The real resolving method. return NULL for unknown reference
261			*
262			* @param string $name
263			* @return mixed
264			* @access protected
265			*/
266			abstract protected function getReference(/# string / $name);
267			}
268

phossa2 / shared

Push — master ( 7316d8...f9f65a )

ReferenceTrait::resolveUnknown()

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like