Xabbuh\XApi\Model\Actor

Complexity

Total Complexity

6

Size/Duplication

Total Lines	67
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	6
Bugs	0	Features	1

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	getInverseFunctionalIdentifier()	0	4	1
A	getName()	0	4	1
A	equals()	0	12	3

<?php

/*
 * This file is part of the xAPI package.
 *
 * (c) Christian Flothmann <christian.flothmann@xabbuh.de>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Xabbuh\XApi\Model;

/**
 * The Actor of a {@link Statement}.
 *
 * @author Christian Flothmann <christian.flothmann@xabbuh.de>
 */
abstract class Actor
{
    /**
     * The actor's {@link InverseFunctionalIdentifier inverse functional identifier}
     *
     * @var InverseFunctionalIdentifier
     */
    private $iri;

    /**
     * Name of the {@link Agent} or {@link Group}
     * @var string
     */
    private $name;

    /**
     * @param InverseFunctionalIdentifier $iri
     * @param string                      $name
     */
    public function __construct(InverseFunctionalIdentifier $iri, $name = null)
    {
        $this->iri = $iri;
        $this->name = $name;
    }

    /**
     * Returns the Actor's {@link InverseFunctionalIdentifier inverse functional identifier}.
     *
     * @return InverseFunctionalIdentifier The inverse functional identifier
     */
    public function getInverseFunctionalIdentifier()
    {
        return $this->iri;
    }

    /**
     * Returns the name of the {@link Agent} or {@link Group}.
     *
     * @return string The name
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * Checks if another actor is equal.
     *
     * Two actors are equal if and only if all of their properties are equal.
     *
     * @param Actor $actor The actor to compare with
     *
     * @return bool True if the actors are equal, false otherwise
     */
    public function equals(Actor $actor)
    {
        if ($this->name !== $actor->name) {
            return false;
        }

        if (!$this->iri->equals($actor->getInverseFunctionalIdentifier())) {
            return false;
        }

        return true;
    }
}