PHPCheckstyle Code

<?php
namespace PHPCheckstyle;

/**
 * Statement stack class.
 * This object is used to store the current stack of nested statements.
 * 
 * @package classes
 */
class StatementStack {

	/**
	 * Stack of items.
	 *
	 * @var Array[StatementItem]
	 */
	var $statements = array();

	/**
	 * Return the size of the stack.
	 *
	 * @return Integer
	 */
	function count() {
		return count($this->statements);
	}

	/**
	 * Add a statement to the stack.
	 *
	 * @param StatementItem $item        	
	 */
	function push($item) {
		array_push($this->statements, $item);
	}

	/**
	 * Get the top statement from the stack.
	 *
	 * @return StatementItem
	 */
	function pop() {
		return array_pop($this->statements);
	}

	/**
	 * Display the current branching stack.
	 *
	 * @return String
	 */
	function getStackDump() {
		$dump = "";
		foreach ($this->statements as $item) {
			$dump .= $item->type;
			if ($item->type == "FUNCTION" || $item->type == "INTERFACE" || $item->type == "CLASS") {
				$dump .= "(" . $item->name . ")";
			}
			$dump .= " -> ";
		}
		
		return $dump;
	}

	/**
	 * Return the top stack item.
	 *
	 * @return StatementItem
	 */
	function getCurrentStackItem() {
		$topItem = end($this->statements);
		if ($topItem != null) {
			return $topItem;
		} else {
			// In case of a empty stack, we are at the root of a PHP file (with no class or function).
			// We return the default values
			return new StatementItem();
		}
	}

	/**
	 * Return the parent stack item.
	 *
	 * @return StatementItem
	 */
	function getParentStackItem() {
		if ($this->count() > 1) {
			return $this->statements[$this->count() - 2];
		} else {
			// In case of a empty stack, we are at the root of a PHP file (with no class or function).
			// We return the default values
			return new StatementItem();
		}
	}
}