Overview

Namespaces

  • Net
    • Bazzline
      • Component
        • Template

Classes

  • Net\Bazzline\Component\Template\AbstractFileBasedTemplate
  • Net\Bazzline\Component\Template\AbstractTemplate
  • Net\Bazzline\Component\Template\CallableComplexFileBasedTemplateManager
  • Net\Bazzline\Component\Template\ComplexFileBasedTemplate
  • Net\Bazzline\Component\Template\ExpressiveTemplateAdapter
  • Net\Bazzline\Component\Template\FileBasedTemplate
  • Net\Bazzline\Component\Template\RuntimeContentBasedTemplate
  • Net\Bazzline\Component\Template\TemplateDumper

Interfaces

  • Net\Bazzline\Component\Template\DelimiterInterface
  • Net\Bazzline\Component\Template\TemplateInterface
  • Overview
  • Namespace
  • Class
  1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 
<?php
/**
 * @author stev leibelt <artodeto@bazzline.net>
 * @since 2015-10-07
 */
namespace Net\Bazzline\Component\Template;

use InvalidArgumentException;
use RuntimeException;

abstract class AbstractFileBasedTemplate extends AbstractTemplate
{
    /** @var null|string */
    private $filePath;

    /**
     * @param array $variables
     * @param null|string $filePath
     * @throws InvalidArgumentException
     * @throws RuntimeException
     */
    public function __construct($variables = array(), $filePath = null)
    {
        parent::__construct($variables);

        $this->setFilePathIfProvided($filePath);
    }

    /**
     * @param array $variables
     * @param null $filePath
     * @return string
     * @throws InvalidArgumentException
     * @throws RuntimeException
     */
    public function __invoke($variables = array(), $filePath = null)
    {
        $this->setFilePathIfProvided($filePath);

        return parent::__invoke($variables);
    }

    /**
     * @param string $filePath
     * @throws InvalidArgumentException
     * @throws RuntimeException
     */
    public function setFilePath($filePath)
    {
        $this->throwRuntimeExceptionIfFilePathIsInvalid($filePath);

        if (!is_readable($filePath)) {
            throw new InvalidArgumentException(
                'file path: "' . $filePath . '" is not readable'
            );
        }

        $this->filePath = $filePath;
    }

    /**
     * @return string
     * @throws RuntimeException
     */
    protected function getContent()
    {
        $filePath = $this->getFilePath();

        $this->throwRuntimeExceptionIfFilePathIsInvalid($filePath);

        $content = file_get_contents($filePath);

        if ($content === false) {
            throw new RuntimeException(
                'could not read content from "' . $filePath . '"'
            );
        }

        return $content;
    }

    /**
     * @return null|string
     */
    protected function getFilePath()
    {
        return $this->filePath;
    }

    /**
     * @param string $filePath
     * @throws RuntimeException
     */
    protected function throwRuntimeExceptionIfFilePathIsInvalid($filePath)
    {
        if (is_null($filePath)) {
            throw new RuntimeException(
                'file path must be a valid string'
            );
        }

        if (!file_exists($filePath)) {
            throw new InvalidArgumentException(
                'file path: "' . $filePath . '" does not exist'
            );
        }

        if (!is_readable($filePath)) {
            throw new RuntimeException(
                'file path: "' . $filePath . '" is not readable'
            );
        }
    }

    /**
     * @param null|string $filePath
     * @throws RuntimeException
     */
    protected function setFilePathIfProvided($filePath = null)
    {
        if (!is_null($filePath)) {
            $this->setFilePath($filePath);
        }
    }
}
PHP Template Component by bazzline.net API documentation generated by ApiGen