Ayesh / PHPTemplate

src/PHPTemplate.php

Indentation +252 added lines, -252 removed lines

@@ -8,93 +8,93 @@ 
 
 final class PHPTemplate implements \ArrayAccess {
 
-	/**
-	 * @var array Raw user-provided variables.
-	 */
-	private $vars;
-
-	/**
-	 * @var string Template file path.
-	 */
-	private $template_file;
-
-	/**
-	 * @var array Allowed url protocols.
-	 */
-	private const ALLOWED_URL_PROTOCOLS = [
-		'http',
-		'https',
-		'ftp'
-	];
-
-	public function __construct(string $template_file = null, array $vars = []) {
-		$this->template_file = $template_file;
-		$this->set($vars);
-	}
-
-	/**
-	 * Set view data. This overwrites existing variables.
-	 *
-	 * @param array $vars The view data
-	 * @return void
-	 */
-	public function set(array $vars = []): void {
-		$this->vars = $vars;
-	}
-
-	/**
-	 * Render template.
-	 *
-	 * @param array|null $vars The view data. If not provided, variables set in a
+  /**
+   * @var array Raw user-provided variables.
+   */
+  private $vars;
+
+  /**
+   * @var string Template file path.
+   */
+  private $template_file;
+
+  /**
+   * @var array Allowed url protocols.
+   */
+  private const ALLOWED_URL_PROTOCOLS = [
+    'http',
+    'https',
+    'ftp'
+  ];
+
+  public function __construct(string $template_file = null, array $vars = []) {
+    $this->template_file = $template_file;
+    $this->set($vars);
+  }
+
+  /**
+   * Set view data. This overwrites existing variables.
+   *
+   * @param array $vars The view data
+   * @return void
+   */
+  public function set(array $vars = []): void {
+    $this->vars = $vars;
+  }
+
+  /**
+   * Render template.
+   *
+   * @param array|null $vars The view data. If not provided, variables set in a
    *  provious set() call or the constructor will be used.
-	 * @return string Rendered template.
-	 * @throws \Throwable
-	 */
-	public function render(array $vars = null): string {
-		if (empty($this->template_file)) {
-			throw new BadMethodCallException('Calls to render() method is illegal when a template path is not set.');
-		}
-		if (!file_exists($this->template_file)) {
-			throw new TemplateNotFound(sprintf('Template %s could not be loaded.', $this->template_file));
-		}
-
-		if (null !== $vars) {
-			$this->set($vars);
-		}
-
-		return trim(self::renderTemplate($this->template_file, $this));
-	}
-
-	/**
-	 * Render template.
-	 *
-	 * @param string $path The path to the template file.
-	 * @param PHPTemplate $v The PHPTemplate instance
-	 * @return string The rendered content
-	 * @throws \Throwable
-	 */
-	private static function renderTemplate(string $path, PHPTemplate $v): string {
-		ob_start();
-		try {
-			/** @noinspection PhpIncludeInspection */
-			include $path;
-		} catch (\Throwable $exception) {
-			ob_end_clean();
-			throw $exception;
-		}
-
-		return ob_get_clean();
-	}
-
-	/**
-	 * Get view data by key name WITHOUT applying any sanitization filters. Use
+   * @return string Rendered template.
+   * @throws \Throwable
+   */
+  public function render(array $vars = null): string {
+    if (empty($this->template_file)) {
+      throw new BadMethodCallException('Calls to render() method is illegal when a template path is not set.');
+    }
+    if (!file_exists($this->template_file)) {
+      throw new TemplateNotFound(sprintf('Template %s could not be loaded.', $this->template_file));
+    }
+
+    if (null !== $vars) {
+      $this->set($vars);
+    }
+
+    return trim(self::renderTemplate($this->template_file, $this));
+  }
+
+  /**
+   * Render template.
+   *
+   * @param string $path The path to the template file.
+   * @param PHPTemplate $v The PHPTemplate instance
+   * @return string The rendered content
+   * @throws \Throwable
+   */
+  private static function renderTemplate(string $path, PHPTemplate $v): string {
+    ob_start();
+    try {
+      /** @noinspection PhpIncludeInspection */
+      include $path;
+    } catch (\Throwable $exception) {
+      ob_end_clean();
+      throw $exception;
+    }
+
+    return ob_get_clean();
+  }
+
+  /**
+   * Get view data by key name WITHOUT applying any sanitization filters. Use
    *  array access pattern (e.g $v['var']) to benefit from automatic string
    *  sanitization functions.
-	 *
-	 * @param string $key The key of the user-provided to variable to fetch.
-	 * @return mixed|null The raw value, or null if not set.
-	 */
-	public function get(string $key) {
+   *
+   * @param string $key The key of the user-provided to variable to fetch.
+   * @return mixed|null The raw value, or null if not set.
+   */
+  public function get(string $key) {
     return $this->vars[$key] ?? NULL;
   }
 
@@ -104,12 +104,12 @@ 
    * @param string $offset An offset to check for
    * @return bool Returns true if the offset exists and is not null. False otherwise.
    */
-	public function offsetExists($offset): bool {
-		return isset($this->vars[$offset]);
-	}
+  public function offsetExists($offset): bool {
+    return isset($this->vars[$offset]);
+  }
 
-	/**
-	 * Retrieve an offset from the variables, with sanitization filters applied.
+  /**
+   * Retrieve an offset from the variables, with sanitization filters applied.
    *
    * When retrieving variables, the first character is matched against a list
    * of sanitization techniques provided by this library.
@@ -125,176 +125,176 @@ 
    *
    * If the variable has no special character prefix, it will be sanitized with
    *  HTML, as in no HTML will be intepreted by the browser.
-	 *
-	 * @param string $offset The offset to retrieve.
-	 * @return mixed Returns the value at specified offset, with the sanitization
+   *
+   * @param string $offset The offset to retrieve.
+   * @return mixed Returns the value at specified offset, with the sanitization
    *   filters applied based on the way their were asked.
-	 */
-	public function offsetGet($offset) {
-		$first_char = $offset{0};
-
-		switch ($first_char) {
-			case ':':
-				return $this->url($this->getVar(substr($offset, 1)));
-
-			case '!':
-				return $this->getVar(substr($offset, 1));
-			default:
-				return $this->escape($this->getVar($offset));
-		}
-	}
-
-	/**
-	 * Assign a value to the specified offset.
-	 *
-	 * @param string $offset The offset to assign the value to
-	 * @param mixed $value The value to set
-	 * @return void
-	 */
-	public function offsetSet($offset, $value): void {
-		$this->vars[$offset] = $value;
-	}
-
-	/**
-	 * Unset an offset.
-	 *
-	 * @param string $offset The offset to unset.
-	 * @return void
-	 */
-	public function offsetUnset($offset): void {
-		unset($this->vars[$offset]);
-	}
-
-	private function getVar(string $offset): string {
-		if (isset($this->vars[$offset]) && \is_scalar($this->vars[$offset]) && !\is_bool($this->vars[$offset])) {
-			return $this->vars[$offset];
-		}
-		return '';
-	}
-
-	/**
-	 * Html encoding.
-	 *
-	 * Escapes the provided literal string to make sure it does not contain
+   */
+  public function offsetGet($offset) {
+    $first_char = $offset{0};
+
+    switch ($first_char) {
+      case ':':
+        return $this->url($this->getVar(substr($offset, 1)));
+
+      case '!':
+        return $this->getVar(substr($offset, 1));
+      default:
+        return $this->escape($this->getVar($offset));
+    }
+  }
+
+  /**
+   * Assign a value to the specified offset.
+   *
+   * @param string $offset The offset to assign the value to
+   * @param mixed $value The value to set
+   * @return void
+   */
+  public function offsetSet($offset, $value): void {
+    $this->vars[$offset] = $value;
+  }
+
+  /**
+   * Unset an offset.
+   *
+   * @param string $offset The offset to unset.
+   * @return void
+   */
+  public function offsetUnset($offset): void {
+    unset($this->vars[$offset]);
+  }
+
+  private function getVar(string $offset): string {
+    if (isset($this->vars[$offset]) && \is_scalar($this->vars[$offset]) && !\is_bool($this->vars[$offset])) {
+      return $this->vars[$offset];
+    }
+    return '';
+  }
+
+  /**
+   * Html encoding.
+   *
+   * Escapes the provided literal string to make sure it does not contain
    * anything that would be interpreted as HTML. You can also use this escape
    * method inside HTML attributes as it would also convert single and double
-	 * quotes to HTML entities.
-	 *
-	 * @param string $input The value to encode
-	 * @return string The html encoded value
-	 */
-	public function escape(string $input): string {
-		return \htmlspecialchars($input, \ENT_QUOTES | \ENT_SUBSTITUTE, 'UTF-8');
-	}
-
-	/**
-	 * URL encoding.
-	 *
-	 * Sanitizes the provided URL making sure it only contains relative paths,
+   * quotes to HTML entities.
+   *
+   * @param string $input The value to encode
+   * @return string The html encoded value
+   */
+  public function escape(string $input): string {
+    return \htmlspecialchars($input, \ENT_QUOTES | \ENT_SUBSTITUTE, 'UTF-8');
+  }
+
+  /**
+   * URL encoding.
+   *
+   * Sanitizes the provided URL making sure it only contains relative paths,
    * or URIs whose protocol http://, https://, or ftp://. Any other protocols
    * such as javascript: will be removed.
-	 *
-	 * @param string $uri The url
-	 * @return string The url encoded string
-	 */
-	public function url(string $uri): string {
-		$allowed_protocols = array_flip(static::ALLOWED_URL_PROTOCOLS);
-
-		// Iteratively remove any invalid protocol found.
-		// Borrowed from Drupal.
-		do {
-			$before = $uri;
-			$colon_position = strpos($uri, ':');
-			if ($colon_position > 0) {
-
-				// We found a colon, possibly a protocol. Verify.
-				$protocol = substr($uri, 0, $colon_position);
-
-				// If a colon is preceded by a slash, question mark or hash, it cannot
-				// possibly be part of the URL scheme. This must be a relative URL, which
-				// inherits the (safe) protocol of the base document.
-				if (preg_match('![/?#]!', $protocol)) {
-					break;
-				}
-
-				// Check if this is a disallowed protocol. Per RFC2616, section 3.2.3
-				// (URI Comparison) scheme comparison must be case-insensitive.
-				if (!isset($allowed_protocols[strtolower($protocol)])) {
-					$uri = substr($uri, $colon_position + 1);
-				}
-			}
-		} while ($before !== $uri);
-		return $this->escape($uri);
-	}
-
-	/**
-	 * Expands the provided array into HTML attributes.
-	 *
-	 * @param array $attributes The attributes
-	 *
-	 * @return string
-	 */
-	public function attributes(array $attributes): string {
-		foreach ($attributes as $attribute => &$data) {
-			$data = implode(' ', (array) $data);
-			$data = $attribute . '="' . $this->escape($data) . '"';
-		}
-
-		return $attributes ? ' ' . implode(' ', $attributes) : '';
-	}
-
-	/**
-	 * This is a shortcut to throw an exception of type TemplateError that the
+   *
+   * @param string $uri The url
+   * @return string The url encoded string
+   */
+  public function url(string $uri): string {
+    $allowed_protocols = array_flip(static::ALLOWED_URL_PROTOCOLS);
+
+    // Iteratively remove any invalid protocol found.
+    // Borrowed from Drupal.
+    do {
+      $before = $uri;
+      $colon_position = strpos($uri, ':');
+      if ($colon_position > 0) {
+
+        // We found a colon, possibly a protocol. Verify.
+        $protocol = substr($uri, 0, $colon_position);
+
+        // If a colon is preceded by a slash, question mark or hash, it cannot
+        // possibly be part of the URL scheme. This must be a relative URL, which
+        // inherits the (safe) protocol of the base document.
+        if (preg_match('![/?#]!', $protocol)) {
+          break;
+        }
+
+        // Check if this is a disallowed protocol. Per RFC2616, section 3.2.3
+        // (URI Comparison) scheme comparison must be case-insensitive.
+        if (!isset($allowed_protocols[strtolower($protocol)])) {
+          $uri = substr($uri, $colon_position + 1);
+        }
+      }
+    } while ($before !== $uri);
+    return $this->escape($uri);
+  }
+
+  /**
+   * Expands the provided array into HTML attributes.
+   *
+   * @param array $attributes The attributes
+   *
+   * @return string
+   */
+  public function attributes(array $attributes): string {
+    foreach ($attributes as $attribute => &$data) {
+      $data = implode(' ', (array) $data);
+      $data = $attribute . '="' . $this->escape($data) . '"';
+    }
+
+    return $attributes ? ' ' . implode(' ', $attributes) : '';
+  }
+
+  /**
+   * This is a shortcut to throw an exception of type TemplateError that the
    * parent caller can catch. You will probably never need to use this method,
    * but this is an easy way to throw an error if your template cannot proceed
    * and you want to terminate and report it to the parent callers.
-	 *
-	 * @param string $error_message The error nessage
-	 * @param int $error_code The error code
-	 *
-	 * @throws TemplateError
-	 */
-	public function error(string $error_message, int $error_code = 0): void {
-		throw new TemplateError($error_message, $error_code);
-	}
-
-	/**
-	 * Cast to string. Always returns a blank string.
-	 *
-	 * @return string Blank string
-	 */
-	public function __toString(): string {
-		return '';
-	}
-
-	/**
-	 * Silently discard all attempts to set object properties.
-	 *
-	 * @param mixed $name The name
-	 * @param mixed $value The value
-	 * @return void
-	 */
-	public function __set($name, $value): void {
-	}
-
-	/**
-	 * Silently fail all attempts to inspect any object properties.
-	 *
-	 * @param mixed $name The name
-	 * @return bool Status
-	 */
-	public function __isset($name) {
-		return false;
-	}
-
-	/**
-	 * Return an empty string when attempted to fetch object properties. This is
+   *
+   * @param string $error_message The error nessage
+   * @param int $error_code The error code
+   *
+   * @throws TemplateError
+   */
+  public function error(string $error_message, int $error_code = 0): void {
+    throw new TemplateError($error_message, $error_code);
+  }
+
+  /**
+   * Cast to string. Always returns a blank string.
+   *
+   * @return string Blank string
+   */
+  public function __toString(): string {
+    return '';
+  }
+
+  /**
+   * Silently discard all attempts to set object properties.
+   *
+   * @param mixed $name The name
+   * @param mixed $value The value
+   * @return void
+   */
+  public function __set($name, $value): void {
+  }
+
+  /**
+   * Silently fail all attempts to inspect any object properties.
+   *
+   * @param mixed $name The name
+   * @return bool Status
+   */
+  public function __isset($name) {
+    return false;
+  }
+
+  /**
+   * Return an empty string when attempted to fetch object properties. This is
    * to discourage bypassing the ArrayAccess pattern.
-	 *
-	 * @param mixed $name The name
-	 * @return string Blank string
-	 */
-	public function __get($name) {
-		return '';
-	}
+   *
+   * @param mixed $name The name
+   * @return string Blank string
+   */
+  public function __get($name) {
+    return '';
+  }
 }