izzum\statemachine\Identifier

Complexity

Total Complexity

8

Size/Duplication

Total Lines	105
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes	6
Bugs	2	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	getMachine()	0	4	1
A	setEntityId()	0	4	1
A	getEntityId()	0	4	1
A	getId()	0	9	2
A	toString()	0	4	1
A	__toString()	0	4	1

<?php
namespace izzum\statemachine;

/**
 * an instance of Identifier uniquely identifies the statemachine to be used.
 *
 * A statemachine is always uniquely identified by the combination of an entity
 * id and a machine name (that provides the relation to the statemachine the
 * entity is governed by).
 * 
 * the machine name should be a 'machine readable' string, since it will be stored in different
 * backends and might be used as a key there (eg: in redis).
 * 
 * The entity id is something that uniquely identifies a domain model. Probably 
 * something that is stored in your application, like a primary key in a table, a GUID or a hash.
 *
 * This object thus stores the minimum data needed from other processes in your
 * application domain to succesfully work with the statemachine.
 *
 * @author Rolf Vreijdenberger
 *        
 */
class Identifier {
    const NULL_ENTITY_ID = "-1";
    const NULL_STATEMACHINE = 'null-machine';
    
    /**
     * an entity id that represents the unique identifier for an application
     * domain specific object (entity) like 'Order', 'Customer' etc.
     *
     * @var string
     */
    protected $entity_id;
    
    /**
     * the statemachine that governs the state behaviour for this entity (eg
     * 'order').
     * this is the name of the statemachine itself and is used in conjunction
     * with the entity_id to define what a statemachine is about.
     *
     * @var string
     */
    protected $machine_name;

    /**
     * Constructor
     *
     * @param mixed $entity_id
     *            the id of the domain specific entity (it will internally be
     *            converted to a string)
     * @param string $machine_name
     *            the name of the statemachine (eg: 'order')
     */
    public function __construct($entity_id, $machine_name)
    {
        // convert $entity_id to string (it will likely be an int but a string
        // gives more flexibility)
        $this->setEntityId($entity_id);
        $this->machine_name = $machine_name;
    }

    /**
     * gets the statemachine name that handles the entity
     *
     * @return string
     */
    public function getMachine()
    {
        return $this->machine_name;
    }

    /**
     * set the id of the domain specific entity (it will internally be converted to a string)
     * @param mixed $entity_id
     */
    public function setEntityId($entity_id)
    {
        $this->entity_id = trim("$entity_id");
    }

    /**
     * gets the entity id that represents the unique identifier for the
     * application domain specific model.
     *
     * @return string
     */
    public function getEntityId()
    {
        return $this->entity_id;
    }

    /**
     * get the unique identifier representation for an Identifier, which
     * consists of the machine name and the entity_id in parseable form.
     *
     * @param boolean $readable
     *            human readable or not. defaults to false
     * @return string
     */
    public function getId($readable = false)
    {
        if ($readable) {
            $output = "machine: '" . $this->getMachine() . "', id: '" . $this->getEntityId() . "'";
        } else {
            $output = $this->getMachine() . "_" . $this->getEntityId();
        }
        return $output;
    }

    /**
     *
     * @return string
     */
    public function toString()
    {
        return get_class($this) . ' ' . $this->getId(true);
    }

    /**
     *
     * @return string
     */
    public function __toString()
    {
        return $this->toString();
    }
}