ConnectionInterface.php

<?php

namespace Kitano\ConnectionBundle\Model;

interface ConnectionInterface
{
    const DIRECTION_ONE_WAY = 'one-way';
    const DIRECTION_TWO_WAYS = 'two-ways';

    /**
     * Returns the Node from where the Connection (edge) start
     *
     * @return \Kitano\ConnectionBundle\Model\NodeInterface
     */
    public function getSource();

    /**
     * Sets the Node from where the Connection start
     *
     * @param NodeInterface $node
     */
    public function setSource(NodeInterface $node);

    /**
     * Returns the Node to which the Connection is directed
     *
     * @return \Kitano\ConnectionBundle\Model\NodeInterface
     */
    public function getDestination();

    /**
     * Sets the Node to which the Connection is directed
     *
     * @param NodeInterface $node
     */
    public function setDestination(NodeInterface $node);

    /**
     * Returns the "type" of this connection (user defined)
     * This type is used to identify the kind of connection which is linking a Node
     * to another (i.e: "like", "follow", ...)
     *
     * @return mixed
     */
    public function getType();

    /**
     * Sets the connection type
     *
     * @param string $type
     */
    public function setType($type);

    /**
     * Returns the date the connection was initially created at
     *
     * @return \DateTime
     */
    public function getCreatedAt();

    /**
     * Set the date the connection was initially created at
     *
     * @param \DateTime $createdAt
     */
    public function setCreatedAt(\DateTime $createdAt);
}