Seufert\Hamle\Run

Complexity

Total Complexity

10

Size/Duplication

Total Lines	101
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	addInstance()	0	4	1
A	popInstance()	0	7	2
A	filter()	0	3	1
A	includeFile()	0	3	1
A	includeFragment()	0	3	1
A	modelTypeTags()	0	4	1
A	modelId()	0	5	2
A	modelTypeId()	0	3	1

<?php

/*

This project is Licenced under The MIT License (MIT)


Copyright (c) 2014 Christopher Seufert


Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal

in the Software without restriction, including without limitation the rights

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:


The above copyright notice and this permission notice shall be included in

all copies or substantial portions of the Software.


THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN

THE SOFTWARE.


 */

namespace Seufert\Hamle;


use Seufert\Hamle\Exception\RunTime;

use Seufert\Hamle\Model;


/**

 * HAMLE Runtime

 *

 * @author Chris Seufert <chris@seufert.id.au>

 */

class Run {

  /**

   * @var Hamle Current HAMLE instance

   */

  static protected $hamle;

  static protected $hamleList = array();


  /**

   * Add a hamle instance to the stack

   * @param Hamle $hamle Hamle Instance

   */

  static function addInstance(Hamle $hamle) {

It is generally recommended to explicitly declare the visibility for methods.

    self::$hamleList[] = $hamle;

    self::$hamle = $hamle;

  }


  /**

   * Remove hamle Instance from the stack

   */

  static function popInstance() {

It is generally recommended to explicitly declare the visibility for methods.

    array_pop(self::$hamleList);

    if (self::$hamleList)

The expression self::$hamleList of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

      self::$hamle = self::$hamleList[count(self::$hamleList) - 1];

    else

      self::$hamle = NULL;

  }


  /**

   * Execute a hamle String Filter

   * @param string $name Name of Filter

   * @param string $data Data to pass to filter

   * @return string Fitlered data

   */

  static function filter($name, $data) {

The parameter $name is not used and could be removed.

It is generally recommended to explicitly declare the visibility for methods.

    return strrev($data);

  }


  /**

   * Helper for hamle |include command

   * @param string $path Path to file to include

   * @return string HTML Code

   */

  static function includeFile($path) {

It is generally recommended to explicitly declare the visibility for methods.

    return self::$hamle->load($path)->output();

  }


  /**

   * @param $fragment Name of fragment

   * @internal Only for use in template system

   * @return string String to output where |include #fragment was called

   */

  static function includeFragment($fragment) {

It is generally recommended to explicitly declare the visibility for methods.

    return self::$hamle->setup->getFragment(self::$hamle, substr($fragment, 1));

  }


  /**

   * Called from template by $() to find a specific model

   * @param array[] $typeTags array of tags with types as key eg ['page'=>[]] or ['product'=>['featured]]

   * @param array $sort

   * @param int $limit Results Limit

   * @param int $offset Offset Results by

   * @internal param string $sortBy Field name to sort by

   * @return Model

   */

  static function modelTypeTags($typeTags, $sort = [], $limit = 0, $offset = 0) {

It is generally recommended to explicitly declare the visibility for methods.

    return self::$hamle->setup->getModelTypeTags($typeTags,

        $sort, $limit, $offset);

  }


  /**

   * Called from template by $() to find a specific model

   * @param string $id id to search for

   * @param array $sort

   * @param int $limit Limit of results

   * @param int $offset Results Offset

   * @throws RunTime

   * @return Model

   */

  static function modelId($id, $sort = [], $limit = 0, $offset = 0) {

It is generally recommended to explicitly declare the visibility for methods.

    $o = self::$hamle->setup->getModelDefault($id, $sort, $limit, $offset);

    if (!$o instanceOf Model) throw new RunTime("Application must return instance of hamleModel");

    return $o;

  }


  /**

   * Called from template by $() to find a specific model

   * @param array[] $typeId Array of types mapped to ids [type1=>[1],type2=>[2]]

   * @param int $sortDir Sort Direction defined by hamle::SORT_*

There is no parameter named $sortDir. Was it maybe removed?

   * @param string $sortField Field name to sort by

There is no parameter named $sortField. Was it maybe removed?

   * @param int $limit Results Limit

   * @param int $offset Results Offset

   * @internal param string $type type to filter by

   * @internal param string $id id to search for

   * @return Model

   */

  static function modelTypeId($typeId, $sort = [], $limit = 0, $offset = 0) {

It is generally recommended to explicitly declare the visibility for methods.

    return self::$hamle->setup->getModelTypeId($typeId, $sort, $limit, $offset);

  }



}