primo commit

libraries/allediaframework/Framework/Content/Tag.php

@@ -0,0 +1,195 @@
+<?php
+/**
+ * @package   AllediaFramework
+ * @contact   www.joomlashack.com, help@joomlashack.com
+ * @copyright 2016-2023 Joomlashack.com. All rights reserved
+ * @license   https://www.gnu.org/licenses/gpl.html GNU/GPL
+ *
+ * This file is part of AllediaFramework.
+ *
+ * AllediaFramework is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * AllediaFramework is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with AllediaFramework.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+namespace Alledia\Framework\Content;
+
+use Alledia\Framework\Base;
+use Joomla\Registry\Registry;
+
+defined('_JEXEC') or die();
+
+class Tag extends Base
+{
+    /**
+     * The unparsed tag string
+     *
+     * @var string
+     */
+    protected $unparsedString = null;
+
+    /**
+     * The tag name
+     *
+     * @var string
+     */
+    protected $name = null;
+
+    /**
+     * The tag content
+     *
+     * @var string
+     */
+    protected $content = '';
+
+    /**
+     * The regex used to find the tag
+     *
+     * @var string
+     */
+    protected $regex = null;
+
+    /**
+     * The tag params
+     *
+     * @var Registry
+     */
+    public $params = null;
+
+    /**
+     * Constructor method, that defines the internal content
+     *
+     * @param string $name
+     * @param string $unparsedString
+     *
+     * @return void
+     */
+    public function __construct($name, $unparsedString)
+    {
+        $this->name           = $name;
+        $this->unparsedString = $unparsedString;
+        $this->regex          = static::getRegex($this->name);
+
+        $this->parse();
+    }
+
+    /**
+     * Return the regex used to find tags inside a text.
+     *
+     * @param string $tagName
+     *
+     * @return string
+     */
+    public static function getRegex($tagName)
+    {
+        return '/\{' . $tagName . '(?:(?!\{\/' . $tagName
+            . '\}).)*\}[\s]*([^{]*)[\s]*\{\/' . $tagName . '\}/i';
+    }
+
+    /**
+     * Parse this tag storing the content and params.
+     *
+     * @return void
+     */
+    protected function parse()
+    {
+        $this->content = $this->parseContent();
+
+        $this->params = $this->parseParams();
+    }
+
+    /**
+     * Parse the {tagName}{/tagName} returning the content
+     *
+     * @return string
+     */
+    protected function parseContent()
+    {
+        $content = '';
+
+        if (!empty($this->unparsedString)) {
+            if (strpos($this->unparsedString, '{' . $this->name) !== false) {
+                // Check if the source has the tag name
+                if (preg_match($this->regex, $this->unparsedString, $match)) {
+                    $content = trim($match[1]);
+                }
+            }
+        }
+
+        return trim($content);
+    }
+
+    /**
+     * Parse inline parameters from the tag
+     *
+     * @return Registry
+     */
+    protected function parseParams()
+    {
+        // Remove the tag name, extracting only the tag attributes
+        $inlineParams = preg_replace('/^{' . $this->name . '/', '', $this->unparsedString);
+        $inlineParams = trim(preg_replace('/}[a-z0-9\s]*{\/' . $this->name . '}/', '', $inlineParams));
+
+        // Parse the inline params
+        $regex  = '/([a-z0-9_]*)(?:="([^"]*)")?\s?/i';
+        $parsed = new Registry();
+        if (preg_match_all($regex, $inlineParams, $vars)) {
+            $fullParams  = $vars[0];
+            $paramNames  = $vars[1];
+            $paramValues = $vars[2];
+
+            foreach ($fullParams as $i => $param) {
+                if (!empty($paramNames[$i])) {
+                    $parsed->set(trim($paramNames[$i]), trim($paramValues[$i]));
+                }
+            }
+        }
+
+        return $parsed;
+    }
+
+    /**
+     * Return the unparsed string
+     *
+     * @return string
+     */
+    public function toString()
+    {
+        return $this->unparsedString;
+    }
+
+    /**
+     * Returns the tag content
+     *
+     * @return string
+     */
+    public function getContent()
+    {
+        return $this->content;
+    }
+
+    /**
+     * @return string
+     */
+    public function getName()
+    {
+        return $this->name;
+    }
+
+    /**
+     * @return Registry
+     */
+    public function getParams()
+    {
+        return $this->params;
+    }
+}

libraries/allediaframework/Framework/Content/Text.php

@@ -0,0 +1,94 @@
+<?php
+/**
+ * @package   AllediaFramework
+ * @contact   www.joomlashack.com, help@joomlashack.com
+ * @copyright 2016-2023 Joomlashack.com. All rights reserved
+ * @license   https://www.gnu.org/licenses/gpl.html GNU/GPL
+ *
+ * This file is part of AllediaFramework.
+ *
+ * AllediaFramework is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * AllediaFramework is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with AllediaFramework.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+namespace Alledia\Framework\Content;
+
+use Alledia\Framework\Base;
+
+defined('_JEXEC') or die();
+
+class Text extends Base
+{
+    public $content = '';
+
+    /**
+     * Constructor method, that defines the internal content
+     *
+     * @param string $content
+     */
+    public function __construct($content)
+    {
+        $this->content = $content;
+    }
+
+    /**
+     * Extract multiple {mytag} tags from the content
+     *
+     * @todo Recognize unclose tags like {dumbtag param1="12"}
+     *
+     * @param  string $tagName
+     *
+     * @return array  An array with all tags {tagName} found on the text
+     */
+    protected function extractPluginTags($tagName)
+    {
+        preg_match_all(Tag::getRegex($tagName), $this->content, $matches);
+
+        return $matches[0];
+    }
+
+    /**
+     * Extract multiple {mytag} tags from the content, returning
+     * as Tag instances
+     *
+     * @param  string $tagName
+     *
+     * @return Tag[]  An array with all tags {tagName} found on the text
+     */
+    public function getPluginTags($tagName)
+    {
+        $unparsedTags = $this->extractPluginTags($tagName);
+
+        $tags = [];
+        foreach ($unparsedTags as $unparsedTag) {
+            $tags[] = new Tag($tagName, $unparsedTag);
+        }
+
+        return $tags;
+    }
+
+    /**
+     * Extract multiple {mytag} tags from the content, returning
+     * as Tag instances
+     *
+     * @param  string $tagName
+     *
+     * @return array  An array with all tags {tagName} found on the text
+     * @deprecated 1.3.1 Use getPluginsTags instead
+     */
+    public function getTags($tagName)
+    {
+        // Deprecated. Use getPluginTags instead
+        return $this->getPluginTags($tagName);
+    }
+}