Notif::addFart() - Code Metrics - Inspection of "Refactored the tagging and hook system to use indi..." - mjmunger/farret - Measure and Improve Code Quality continuously with Scrutinizer

Test Setup Failed

Push — master ( 1685c5...687b3c )

by Michael

created 2018-07-28 05:24 UTC

Notif::addFart() A

↳ Parent: Notif

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	2
dl	0
loc	3
rs	10
c	0
b	0
f	0

<?php
/**
 * {CLASS SUMMARY}
 *
 * Date: 7/26/18
 * Time: 6:54 PM
 * @author Michael Munger <[email protected]>
 */

namespace HPHIO\Farret;

use \Exception;

class Notif
{
    private $tagPattern       = '/\{{2} {0,2}([A-Z]+) {0,2}\}{2}/';
    private $hookPattern      = '/(?:{\%\s{0,})([A-Z]+)\s{0,}((\|(?:{{){0,1}[A-Za-z0-9-]+(?:}}){0,1}\s{0,}){0,})(?:\%})/';

    public $templateDirectory = null;
    public $template          = null;
    public $fromName          = null;
    public $fromAddress       = null;
    public $subjectTemplate   = null;
    public $body              = null;

    public $to                = [];
    public $cc                = [];
    public $bcc               = [];
    public $fartDictionary    = [];

    public $hooks             = [];

    public function __construct()
    {
        $this->addHook('DATE', 'getDate');
    }

    public function setTemplateDirectory($directory)
    {
        if (file_exists($directory) === false) {
            return false;
        }

        $this->templateDirectory = $directory;
        return file_exists($this->templateDirectory);
    }

    /**
     * Loads a template from the template directory.
     * @param $template
     * @throws Exception
     */

    public function loadTemplate($template)
    {
        $targetTemplate = $this->templateDirectory . "$template.html";

        if (file_exists($this->templateDirectory) === false) {
            throw new Exception("Template directory not set!");
        }
        if (file_exists($targetTemplate)          === false) {
            throw new Exception("Requested template does not exist in $targetTemplate");
        }
        if (is_readable($targetTemplate)          === false) {
            throw new Exception("Requested template is not readable ($targetTemplate)");
        }

        $this->template = file_get_contents($targetTemplate);

        return strlen($this->template) > 0;
    }

    public function setFromName($name)
    {
        $this->fromName = $name;
    }

    /**
     * Validates an email passed to it, and if valid, sets the from address for the email notification.
     * @param $email
     * @return bool
     * @throws Exception
     */

    public function setFromAddress($email)
    {
        $email = filter_var($email, FILTER_VALIDATE_EMAIL);

        if ($email === false) {
            throw new Exception("$email is not a valid email address!");
        }

        $this->fromAddress = $email;

        return true;
    }

    public function setSubjectTemplate($subject)
    {
        $this->subjectTemplate = $subject;
    }

    /**
     * Adds a Find And Replace Template pair. These will be used to find {{ TEMPLATETAGS }} and perform a substitution.
     * @param $find
     * @param $replace
     */

    public function addFart($find, $replace)
    {
        $this->fartDictionary[$find] = $replace;
    }

    /**
     * Returns unmatched, unreplaced tags from the template.
     * @return mixed
     * @throws Exception
     */

    public function getTemplateTags()
    {
        if (strlen($this->template) == 0) {
            throw new Exception("Template not set!");
        }
        return $this->getTags($this->template);
    }

    public function getBodyTags()
    {
        return $this->getTags($this->body);
    }

    public function getTags($body)
    {
        $matches = [];
        preg_match_all($this->tagPattern, $body, $matches, PREG_PATTERN_ORDER);
        return $matches[0];
    }

    public function getHooks($body)
    {
        $matches = [];
        preg_match_all($this->hookPattern, $body, $matches, PREG_PATTERN_ORDER);
        return $matches[0];
    }

    public function makeTag($find)
    {
        return sprintf("{{%s}}", strtoupper($find));
    }

    public function matchFind($tag, $find)
    {
        //Remove spaces
        $tag = str_replace(" ", '', $tag);
        //Decorate the find
        $find = $this->makeTag($find);
        return (strcmp($tag, $find) === 0);
    }

    /**
     * @param $body
     * @throws Exception
     */

    private function doFart($body)
    {
        $tags = $this->getTemplateTags();
        foreach ($tags as $tag) {
            foreach ($this->fartDictionary as $find => $replace) {
                if ($this->matchFind($tag, $find)) {
                    $body = str_replace($tag, $replace, $body);
                }
            }
        }
        $tags = $this->getBodyTags();

        if (count($tags) > 0) {
            $this->doFart($this->body);
        }

        return $body;
    }

    public function render()
    {
        $this->body = $this->doFart($this->template);
    }

    public function addHook($hook, $callback)
    {
        $this->hooks[$hook] = $callback;
    }

    public function getLabel($subject)
    {
        $matches = [];

        switch ($this->getTagType($subject)) {
            case 'tag':
                preg_match($this->tagPattern, $subject, $matches);
                break;
            case 'hook':
                preg_match($this->hookPattern, $subject, $matches);
                break;
            default:
                return false;
        }

        return $matches[1];
    }

    public function getTagType($tag)
    {
        if (preg_match($this->tagPattern, $tag) > 0) {
            return 'tag';
        }
        if (preg_match($this->hookPattern, $tag) > 0) {
            return 'hook';
        }
        return false;
    }

    /**
     * @param $hook
     * @return mixed
     * @throws Exception
     */

    public function renderHook($hook)
    {

        $TagFactory = new TagFactory();
        $Tag = $TagFactory->getTag($hook);
        $action = $Tag->getLabel();

        //1. Replace template tags here.
        if(count($Tag->getArgs()) > 0) {
            $args = array_map([$this,'doFart'], $Tag->getArgs());
        }

        //2. Lookup the callback in the hooks dictionary.
        $callback = $this->hooks[$action];

        if (method_exists($this, $callback) === false) {
            throw new Exception("Hook method does not exist! Cannot execute $callback in " . __FILE__ . ":" .  __LINE__);
        }

        return (count($Tag->getArgs()) == 0 ? $this->$callback() : $this->$callback($args));

    }

    public function getDate($formatArray)
    {
        $now = new \DateTime();
        return $now->format($formatArray[0]);
    }

    public function getCurrentMonth()
    {
        return $this->getDate(["m"]);
    }

    public function getCurrentDay()
    {
        return $this->getDate(["d"]);
    }

    public function getCurrentYear()
    {
        return $this->getDate(["Y"]);
    }

    public function getArgs($hook) {
        $Factory = new TagFactory();
        $Tag = $Factory->getTag($hook);
        return $Tag->getArgs();
    }

}


1			<?php
2			/**
3			* {CLASS SUMMARY}
4			*
5			* Date: 7/26/18
6			* Time: 6:54 PM
7			* @author Michael Munger <[email protected]>
8			*/
9
10			namespace HPHIO\Farret;
11
12			use \Exception;
13
14			class Notif
15			{
16			private $tagPattern = '/\{{2} {0,2}([A-Z]+) {0,2}\}{2}/';
17			private $hookPattern = '/(?:{\%\s{0,})([A-Z]+)\s{0,}((\\|(?:{{){0,1}[A-Za-z0-9-]+(?:}}){0,1}\s{0,}){0,})(?:\%})/';
18
19			public $templateDirectory = null;
20			public $template = null;
21			public $fromName = null;
22			public $fromAddress = null;
23			public $subjectTemplate = null;
24			public $body = null;
25
26			public $to = [];
27			public $cc = [];
28			public $bcc = [];
29			public $fartDictionary = [];
30
31			public $hooks = [];
32
33			public function __construct()
34			{
35			$this->addHook('DATE', 'getDate');
36			}
37
38			public function setTemplateDirectory($directory)
39			{
40			if (file_exists($directory) === false) {
41			return false;
42			}
43
44			$this->templateDirectory = $directory;
45			return file_exists($this->templateDirectory);
46			}
47
48			/**
49			* Loads a template from the template directory.
50			* @param $template
51			* @throws Exception
52			*/
53
54			public function loadTemplate($template)
55			{
56			$targetTemplate = $this->templateDirectory . "$template.html";
57
58			if (file_exists($this->templateDirectory) === false) {
59			throw new Exception("Template directory not set!");
60			}
61			if (file_exists($targetTemplate) === false) {
62			throw new Exception("Requested template does not exist in $targetTemplate");
63			}
64			if (is_readable($targetTemplate) === false) {
65			throw new Exception("Requested template is not readable ($targetTemplate)");
66			}
67
68			$this->template = file_get_contents($targetTemplate);
69
70			return strlen($this->template) > 0;
71			}
72
73			public function setFromName($name)
74			{
75			$this->fromName = $name;
76			}
77
78			/**
79			* Validates an email passed to it, and if valid, sets the from address for the email notification.
80			* @param $email
81			* @return bool
82			* @throws Exception
83			*/
84
85			public function setFromAddress($email)
86			{
87			$email = filter_var($email, FILTER_VALIDATE_EMAIL);
88
89			if ($email === false) {
90			throw new Exception("$email is not a valid email address!");
91			}
92
93			$this->fromAddress = $email;
94
95			return true;
96			}
97
98			public function setSubjectTemplate($subject)
99			{
100			$this->subjectTemplate = $subject;
101			}
102
103			/**
104			* Adds a Find And Replace Template pair. These will be used to find {{ TEMPLATETAGS }} and perform a substitution.
105			* @param $find
106			* @param $replace
107			*/
108
109			public function addFart($find, $replace)
110			{
111			$this->fartDictionary[$find] = $replace;
112			}
113
114			/**
115			* Returns unmatched, unreplaced tags from the template.
116			* @return mixed
117			* @throws Exception
118			*/
119
120			public function getTemplateTags()
121			{
122			if (strlen($this->template) == 0) {
123			throw new Exception("Template not set!");
124			}
125			return $this->getTags($this->template);
126			}
127
128			public function getBodyTags()
129			{
130			return $this->getTags($this->body);
131			}
132
133			public function getTags($body)
134			{
135			$matches = [];
136			preg_match_all($this->tagPattern, $body, $matches, PREG_PATTERN_ORDER);
137			return $matches[0];
138			}
139
140			public function getHooks($body)
141			{
142			$matches = [];
143			preg_match_all($this->hookPattern, $body, $matches, PREG_PATTERN_ORDER);
144			return $matches[0];
145			}
146
147			public function makeTag($find)
148			{
149			return sprintf("{{%s}}", strtoupper($find));
150			}
151
152			public function matchFind($tag, $find)
153			{
154			//Remove spaces
155			$tag = str_replace(" ", '', $tag);
156			//Decorate the find
157			$find = $this->makeTag($find);
158			return (strcmp($tag, $find) === 0);
159			}
160
161			/**
162			* @param $body
163			* @throws Exception
164			*/
165
166			private function doFart($body)
167			{
168			$tags = $this->getTemplateTags();
169			foreach ($tags as $tag) {
170			foreach ($this->fartDictionary as $find => $replace) {
171			if ($this->matchFind($tag, $find)) {
172			$body = str_replace($tag, $replace, $body);
173			}
174			}
175			}
176			$tags = $this->getBodyTags();
177
178			if (count($tags) > 0) {
179			$this->doFart($this->body);
180			}
181
182			return $body;
183			}
184
185			public function render()
186			{
187			$this->body = $this->doFart($this->template);
188			}
189
190			public function addHook($hook, $callback)
191			{
192			$this->hooks[$hook] = $callback;
193			}
194
195			public function getLabel($subject)
196			{
197			$matches = [];
198
199			switch ($this->getTagType($subject)) {
200			case 'tag':
201			preg_match($this->tagPattern, $subject, $matches);
202			break;
203			case 'hook':
204			preg_match($this->hookPattern, $subject, $matches);
205			break;
206			default:
207			return false;
208			}
209
210			return $matches[1];
211			}
212
213			public function getTagType($tag)
214			{
215			if (preg_match($this->tagPattern, $tag) > 0) {
216			return 'tag';
217			}
218			if (preg_match($this->hookPattern, $tag) > 0) {
219			return 'hook';
220			}
221			return false;
222			}
223
224			/**
225			* @param $hook
226			* @return mixed
227			* @throws Exception
228			*/
229
230			public function renderHook($hook)
231			{
232
233			$TagFactory = new TagFactory();
234			$Tag = $TagFactory->getTag($hook);
235			$action = $Tag->getLabel();
236
237			//1. Replace template tags here.
238			if(count($Tag->getArgs()) > 0) {
239			$args = array_map([$this,'doFart'], $Tag->getArgs());
240			}
241
242			//2. Lookup the callback in the hooks dictionary.
243			$callback = $this->hooks[$action];
244
245			if (method_exists($this, $callback) === false) {
246			throw new Exception("Hook method does not exist! Cannot execute $callback in " . __FILE__ . ":" . __LINE__);
247			}
248
249			return (count($Tag->getArgs()) == 0 ? $this->$callback() : $this->$callback($args));
			0 ignored issues – show Comprehensibility Best Practice introduced 2018-07-28 05:26 UTC by Report Bug Copy Issue Report The variable `$args` does not seem to be defined for all execution paths leading up to this point. Loading history...
250			}
251
252			public function getDate($formatArray)
253			{
254			$now = new \DateTime();
255			return $now->format($formatArray[0]);
256			}
257
258			public function getCurrentMonth()
259			{
260			return $this->getDate(["m"]);
261			}
262
263			public function getCurrentDay()
264			{
265			return $this->getDate(["d"]);
266			}
267
268			public function getCurrentYear()
269			{
270			return $this->getDate(["Y"]);
271			}
272
273			public function getArgs($hook) {
274			$Factory = new TagFactory();
275			$Tag = $Factory->getTag($hook);
276			return $Tag->getArgs();
277			}
278
279			}
280

mjmunger / farret

Push — master ( 1685c5...687b3c )

Notif::addFart() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like