coffee-table/src/Coffee/Tile.php

<?php

namespace Coffee;

/**
 * Class Tile Represents the Position on the Map with more properties
 *
 * @package Coffee
 */
/**
 * Class Tile
 *
 * @package Coffee
 */
class Tile extends Position {

    /**
     * Representation on the map, that element exists on the given tile
     */
    const REPRESENTS_SPOT = 1;
    /**
     * Representation on the map, that element does not exist on the given tile
     */
    const REPRESENTS_VOID = 0;
    /**
     * @var integer
     */
    private $representation;

    /**
     * Tiles are inherently unvisited
     *
     * @var bool
     */
    private $visited = false;

    /**
     * Tile constructor.
     *
     * @param $row
     * @param $column
     * @param $tileRepresentation
     * @throws \Exception
     */
    public function __construct($row, $column, $tileRepresentation) {
        if (!$this->isRepresentingSpot() && !$this->isRepresentingVoid()) {
            throw new \Exception('The map contains invalid representations');
        }

        parent::__construct($row, $column);

        $this->representation = $tileRepresentation;
    }

    /**
     * @return boolean
     */
    public function isVisited() {
        return $this->visited;
    }

    /**
     * Flags this Tile as "visited"
     *
     * @return bool
     */
    public function visit() {
        if ($this->isVisited()) {
            return false;
        }

        $this->visited = true;
        return true;
    }

    /**
     * @return boolean
     */
    public function isRepresentingSpot() {
        return $this->representation == self::REPRESENTS_SPOT;
    }

    /**
     * @return bool
     */
    public function isRepresentingVoid() {
        return $this->representation == self::REPRESENTS_VOID;
    }

    /**
     * @return Position
     */
    public function getPosition() {
        return new Position($this->getRow(), $this->getColumn());
    }

}