zemowsplat\Splat Class Reference

Simple template engine. More...

Public Member Functions
	__construct ()
	Setup default scopes and paths, but leave base dirs empty. More...
	splat ( $name, $scope=array())
	Main function: execute template $name with given $scope More...
	addPaths (array $paths)
	Add a resolution of $name to $relativePath More...
	addBases ( $bases)
	Add a base directory to resolve $relativePath to $absolutePath More...

Protected Member Functions
	push (array $scope)
	push a scope onto the stack More...
	peek ()
	peek at current scope More...
	pop ()
	pop a scope off the stack More...
	nameToPaths ($name)
	Resolve a template $name to an array of absolute $paths. More...

Private Attributes
	$paths
	$bases
	$stack

Detailed Description

Simple template engine.

Definition at line 12 of file grima-splats.php.

Constructor & Destructor Documentation

__construct()

zemowsplat\Splat::__construct

(

)

Setup default scopes and paths, but leave base dirs empty.

Definition at line 45 of file grima-splats.php.

                                  {
        $this->stack = [ [
            'e' =>  'htmlspecialchars',
            't' =>  [ $this, 'splat' ],
        ] ];
        $this->paths = [];
        $this->bases = [];
    }

Member Function Documentation

addBases()

zemowsplat\Splat::addBases

(

$bases

)

Add a base directory to resolve $relativePath to $absolutePath

Parameters

string | array

$bases

- beginnings of absolute paths to search for relative paths

Definition at line 111 of file grima-splats.php.

                                       {
        foreach( (array) $bases as $base ) {
            $this->bases[] = $base;
        }
    }

addPaths()

zemowsplat\Splat::addPaths

(

array

$paths

)

Add a resolution of $name to $relativePath

Parameters

array

$paths

- associative array of $name => $path pairs to setup path resolution

Definition at line 101 of file grima-splats.php.

                                             {
        foreach( $paths as $name => $path ) {
            $this->paths[$name][] = $path;
        }
    }

nameToPaths()

zemowsplat\Splat::nameToPaths (   $name )

protected

Resolve a template $name to an array of absolute $paths.

In case of additions, the array may be long, but is usually a single path to be included in order to print the template.

Parameters

string

$name

- name of the template to lookup

Returns

array $paths - absolute paths that should be included in order to print the template

Definition at line 125 of file grima-splats.php.

                                          {
        $ret = array();
        @$onlyOne = array_merge( (array) $this->paths[$name], [ "$name.php", ]);
        foreach( $onlyOne as $file ) {
            foreach( $this->bases as $base ) {
                $path = $base . DIRECTORY_SEPARATOR . $file;
                if( is_readable( $path ) ) {
                    $ret[] = $path;
                    break 2;
                }
            }
        }
        @$adds = array_merge( (array) $this->paths[$name.'[]'], [ "$name-add.php", ]);
        foreach( $adds as $file ) {
            foreach( $this->bases as $base ) {
                $path = $base . DIRECTORY_SEPARATOR . $file;
                if( is_readable( $path ) ) {
                    $ret[] = $path;
                }
            }
        }
        return $ret;
    }

peek()

zemowsplat\Splat::peek ( )

protected

peek at current scope

Returns

array $scope - the current scope

Definition at line 29 of file grima-splats.php.

                              {
        $length = sizeof( $this->stack );
        return $length ? $this->stack[ $length - 1 ] : array();
    }

pop()

zemowsplat\Splat::pop ( )

protected

pop a scope off the stack

Returns

array $scope - the former scope

Definition at line 38 of file grima-splats.php.

                             {
        return array_pop( $this->stack );
    }

push()

zemowsplat\Splat::push ( array  $scope )

protected

push a scope onto the stack

Parameters

array

$scope

- the new scope to be merged with old scope

Definition at line 21 of file grima-splats.php.

                                            { 
        $this->stack[] = array_merge( (array) $this->peek(), (array) $scope );
    }

splat()

zemowsplat\Splat::splat	(		$name,
			$scope = array()
	)

Main function: execute template $name with given $scope

Default variables

There are two convenience variables:

• $e = htmlspecialchars - suitable for

  <div class="<?=$e($className)?>"><?=$e($textContent)?></div>

• $t = $this->splat - suitable for calling more templates.

Suggested template contents

Technically any PHP code is valid in the template, but it is intended to be used on text/html heavy templates with some:

<?=$e($var)?>

and some

<?php if(isset($var)): ?> ... <?php else: ?> ... <?php endif ?>

and some

<?php foreach($var as $key=>$val): ?> ... <?php endforeach ?>

with some

<?=$t('subtemplate',['var'=>$val])?>

and that's basically it.

Parameters

string	$name	- name of the template to execute
array	$scope	- additional variables in scope of the template

Definition at line 87 of file grima-splats.php.

                                                     {
        $this->push( $scope );
        $scope = $this->peek();
        foreach( $this->nameToPaths( $name ) as $file ) {
            $exe = new SplatExecutionContext( $file, $scope );
            $exe->splat();
        }
        $this->pop();
    }

Member Data Documentation

$bases

zemowsplat\Splat::$bases

private

Definition at line 14 of file grima-splats.php.

$paths

zemowsplat\Splat::$paths

private

Definition at line 13 of file grima-splats.php.

$stack

zemowsplat\Splat::$stack

private

Definition at line 16 of file grima-splats.php.

---

The documentation for this class was generated from the following file:

• grimas/grima-splats.php