Skip to content

code optimizations accepted? #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
TheDigitalOrchard wants to merge 2 commits into
base: master
Choose a base branch
from
Open

code optimizations accepted? #12

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eadc3a2
switch to [] array syntax; use single-quotes when parsing not needed;…
TheDigitalOrchard Jun 29, 2024
4144cf1
fix
TheDigitalOrchard Jun 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 36 additions & 36 deletions src/SkylarK/Spark/Spark.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php
/**
* Spark is a high-performance template parser designed to work inside
* Spark is a high-performance template parser designed to work inside
* a full templating engine or alongside an application.
*
* @author Skylar Kelty <skylarkelty@gmail.com>
Expand All @@ -13,33 +13,34 @@
*/
class Spark
{
const REGEX_TAG = '#</?(.*?)[ >/]+#is';
/** The namespace for Spark to use (prefixes all tags) */
private $_namespace;
/** The namespace callback for Spark to use (called for any tag within a namespace) */
private $_namespace_callback;
/** A list of all elements we parse */
private $_registered_elements = array();
private $_registered_elements = [];
/** A list of all current tokens */
private $_tokens = array();
private $_tokens = [];
/** A list of all linked tokens (e.g. embedded snippets) */
private $_embedded_tokens = array();
private $_embedded_tokens = [];
/** The last output we processed */
private $_output;
/** The last set of errors we encountered */
private $_errors;

/**
* Initialise Spark
*
*
* @param string $namespace The namespace for Spark to use (prefixes all tags)
* @param method $callback A method to be called for any tags within the namespace (optional, negates Spark::addTag())
*/
public function __construct($namespace = "Spark", $callback = null) {
public function __construct($namespace = 'Spark', $callback = null) {
$this->_namespace = $namespace;
$this->_namespace_callback = $callback;

// Add a version tag
$this->addTag("SparkVersion", function($html, $inner) {
$this->addTag('SparkVersion', function($html, $inner) {
return '<a href="https://github.com/SkylarKelty/Spark" target="_blank">Spark</a> v1.1';
});
}
Expand All @@ -61,7 +62,7 @@ public function getErrors() {
/**
* Register a callback related to a tag.
* Everytime spark encountrers the tag it will call the callback function with the element's markup
*
*
* @param string $tag The Tag to detect
* @param mixed $callback The Callback to call when the $tag is detected
*/
Expand All @@ -88,25 +89,24 @@ public function getResult() {
* @return <SparkTest> will return SparkTest
*/
public function getTagName($tag) {
$regex = '#</?(.*?)[ >/]+#is';
if (preg_match($regex, $tag, $matches)) {
if (preg_match(static::REGEX_TAG, $tag, $matches)) {
return $matches[1];
}
return $tag;
}

/**
* Run through a page and return the resulting markup
*
*
* @param string $html The HTML to render
* @return The resulting markup
*/
public function run($html) {
// Reset vars
$this->_output = "";
$this->_errors = array();
$this->_tokens = array();
$this->_embedded_tokens = array();
$this->_output = '';
$this->_errors = [];
$this->_tokens = [];
$this->_embedded_tokens = [];

// Run through the stages
$lines = $this->breakup($html);
Expand All @@ -119,57 +119,57 @@ public function run($html) {
/**
* Breakup a page, ensures all tags are on a separate line.
* Then return an array of lines
*
*
* @param string $html The HTML to break up
*/
private function breakup($html) {
$html = str_replace(array("<", ">"), array("\n<", ">\n"), $html);
$html = str_replace(['<', '>']', ["\n<", ">\n"], $html);
return explode("\n", $html);
}

/**
* Tokenise all namespaced tags
*
*
* @param string $lines The HTML lines to tokenise
*/
private function tokenise($lines) {
$html = "";
$html = '';
$token = 0;
$stack = array();
$stack = [];

foreach ($lines as $line) {
// Do we have a valid tag?
if (stripos($line, "<" . $this->_namespace) !== false) {
if (stripos($line, '<' . $this->_namespace) !== false) {
// Get the tagname
$tagname = $this->getTagName($line);

// Register the token
$this->_tokens[$token] = array($tagname, $line);
$this->_tokens[$token] = [$tagname, $line];

// Link the token to the previous item on the stack
if (count($stack) > 0) {
// List it as embedded, the parent is responsible for the output
$ptr = end($stack);
$ptr = $ptr[0];
$this->_tokens[$ptr][] = "";
$this->_embedded_tokens[$token] = array($ptr, count($this->_tokens[$ptr]) - 1);
$this->_tokens[$ptr][] = '';
$this->_embedded_tokens[$token] = [$ptr, count($this->_tokens[$ptr]) - 1];
} else {
// Tokenise it
$html .= "<SPARKTOKEN" . $token . ">\n";
$html .= "<SPARKTOKEN{$token}>\n";
}

// Are we empty?
$trimmed_line = trim($line);
if (strpos($trimmed_line, "/>") !== strlen($trimmed_line) - 2) {
if (strpos($trimmed_line, '/>') !== strlen($trimmed_line) - 2) {
// We are not an empty tag!
// Add it to the stack
$stack[] = array($token, $tagname);
$stack[] = [$token, $tagname];
}

$token++;
} else if (!empty($stack)) {
} elseif (!empty($stack)) {
// Do we have a closing tag?
if (stripos($line, "</" . $this->_namespace) !== false) {
if (stripos($line, '<//' . $this->_namespace) !== false) {
// Get the tagname
$tagname = $this->getTagName($line);

Expand All @@ -188,12 +188,12 @@ private function tokenise($lines) {
}
} else {
// Do we have a closing tag? If so, throw an error
if (stripos($line, "</" . $this->_namespace) !== false) {
if (stripos($line, '</' . $this->_namespace) !== false) {
$tagname = $this->getTagName($line);
$this->_errors[] = "Bad markup: Extra or misplaced closing tag found for element: " . $tagname;
}

$html .= $line . "\n";
$html .= "{$line}\n";
}
}

Expand All @@ -205,19 +205,19 @@ private function tokenise($lines) {
// Remove that tag and push all the HTML back in
array_shift($this->_tokens[$token]);

$html = str_replace("<SPARKTOKEN" . $token . ">", implode("", $this->_tokens[$token]), $html);
$html = str_replace("<SPARKTOKEN{$token}>", implode('', $this->_tokens[$token]), $html);
unset($this->_tokens[$token]);
}

// Return HTML to what it looked like before we broke it up
$html = str_replace(array("\n<", ">\n"), array("<", ">"), $html);
$html = str_replace(["\n<", ">\n"], ['<', '>'], $html);

return $html;
}

/**
* Replace all tokens with real data
*
*
* @param string $html The HTML to parse
*/
private function replace($html) {
Expand All @@ -237,7 +237,7 @@ private function replace($html) {
$inner_markup = trim(implode("\n", array_slice($data, 1, -1)));

$markup = $func($snippet_markup, $inner_markup);
$html = str_replace("<SPARKTOKEN" . $token . ">", $markup, $html);
$html = str_replace("<SPARKTOKEN{$token}>", $markup, $html);

// Also handle links
if (isset($this->_embedded_tokens[$token])) {
Expand All @@ -246,7 +246,7 @@ private function replace($html) {
}
} else {
$this->_errors[] = $tag . " is not a valid tag!";
$html = str_replace("<SPARKTOKEN" . $token . ">", "", $html);
$html = str_replace("<SPARKTOKEN{$token}>", '', $html);
}
}

Expand Down