Entity.php

<?php

namespace UnicaenLdap\Entity;

use UnicaenLdap\Node;
use UnicaenLdap\Exception;
use UnicaenLdap\Service\AbstractService;
use Zend\Ldap\Dn;
use Zend\Ldap\Exception\LdapException;

/**
 * Classe mère des entrées de l'annuaire LDAP.
 *
 * @author Laurent Lécluse <laurent.lecluse at unicaen.fr>
 */
abstract class Entity
{
    /**
     * Type d'entité
     *
     * @var string
     */
    protected $type;

    /**
     * Service qui gère l'entité
     *
     * @var AbstractService
     */
    protected $service;

    /**
     * @var Node
     */
    protected $node;

    /**
     * Liste des classes d'objet nécessaires à la création de l'entité
     *
     * @var array
     */
    protected $objectClass = [];

    /**
     * Liste des labels utilisés dans les différents attributs
     *
     * @var array
     */
//    protected $labels = [
//        'AUTRE' => 'AUTRE', // Texte libre
//        'BAP' => 'BAP', // Branche d'Activité Professionnelle REFERENS
//        'CNRS' => 'CNRS', // LABINTEL (CNRS)
//        'CNU' => 'CNU', // Section CNU
//        'INRA' => 'INRA', // INRA
//        'INRIA' => 'INRIA', // INRIA
//        'INSERM' => 'INSERM', // INSERM
//        'NCORPS' => 'NCORPS', // BCN: code issu de la colonne “CORPS” de la table “N_CORPS” du domaine “Gestion du personnel”
//        'REFERENS' => 'REFERENS', // Emploi-type REFERENS
//        'SAML' => 'SAML', // Fédération d'identités
//        'SILLAND' => 'SILLAND', // Fonction SILLAND
//        'SIRET' =>  'SIRET', // SIRET (INSEE)
//        'SISE' => 'SISE', // BCN: valeur “DIPLOME SISE” de la table N_DIPLOME_SISE
//        'SUPANN' => 'SUPANN', // Label nomenclatures SupAnn
//        'TVA' => 'TVA', // Union Européenne
//        'UAI' => 'UAI', // Unité Administrative Immatriculée (UAI)
//        'UAI_ETABLISSEMENT' => 'UAI:%s',
//
//    ];

    /**
     * Liste des attributs contenant des dates
     *
     * @var array
     */
    protected $dateTimeAttributes = [];


    /**
     * @param string $type type d'entité
     * @return array
     * @throws Exception
     */
    public static function getNodeParams($type)
    {
        $params = [
            'Generic' => ['uid', 'UnicaenLdap\\Entity\\Generic'],
            'Group' => ['cn', 'UnicaenLdap\\Entity\\Group'],
            'People' => ['uid', 'UnicaenLdap\\Entity\\People'],
            'Structure' => ['supannCodeEntite', 'UnicaenLdap\\Entity\\Structure'],
            'System' => ['uid', 'UnicaenLdap\\Entity\\System'],
        ];
        if (!isset($params[$type])) throw new Exception('Paramètres de "' . $type . '" non trouvés');

        return $params[$type];
    }

    /**
     * Entity constructor.
     *
     * @param AbstractService $service Service qui gèrera la future entité
     * @param Node|Dn|array|string $data Noeud si Node, sinon DN
     * @throws LdapException
     */
    public function __construct(AbstractService $service, $data)
    {
        $this->service = $service;

        if ($data instanceof Node) {
            $this->setNode($data);
        } else {
            $this->setNode(Node::create($data, $this->objectClass));
        }
    }

    /**
     * Retourne le type du service
     *
     * @return string
     */
    public function getType()
    {
        return $this->type;
    }

    /**
     * Retourne le service qui gère l'entité
     *
     * @return AbstractService
     */
    public function getService()
    {
        return $this->service;
    }

    /**
     * Retourne le nœud Ldap de base
     *
     * @return Node
     */
    public function getNode()
    {
        return $this->node;
    }

    /**
     * Affecte un nœud de base
     *
     * @param Node $node
     */
    public function setNode(Node $node)
    {
        $this->node = $node;
    }

    /**
     * Retourne un label en fonction d'une clé
     *
     * @param $key
     * @return null|string
     */
//    public function getLabel($key)
//    {
//        return $this->labels[$key];
//    }

    /**
     * Retourne le Dn de l'entité sous forme de chaîne de caractères
     *
     * @return string
     */
    public function getDn()
    {
        return $this->getNode()->getDnString();
    }

    /**
     * Retourne la clé primaire correspondant à l'entité
     *
     * @return mixed
     * @throws Exception
     */
    public function getKey()
    {
        return reset(self::getNodeParams($this->type));
    }

    /**
     * Retourne la valeur de la clé primaire correspondant à l'entité
     *
     * @return string
     * @throws Exception
     * @throws LdapException
     */
    public function getId()
    {
        return $this->get($this->getKey());
    }

    /**
     * Retourne la liste des attributs de l'entité
     *
     * @return string[]
     */
    public function getAttributesList()
    {
        return array_keys($this->getNode()->getAttributes());
    }

    /**
     * Exporte sous forme de tableau le contenu de l'entité
     *
     * @return array
     * @throws LdapException
     */
    public function toArray()
    {
        $result = [];
        $attrsList = $this->getAttributesList();
        foreach ($attrsList as $attrName) {
            $result[$attrName] = $this->get($attrName);
        }

        return $result;
    }

    /**
     * Retourne un attribut
     *
     * @param string $attrName
     * @return array|int|mixed|null
     * @throws LdapException
     */
    public function get($attrName)
    {
        if (in_array($attrName, $this->dateTimeAttributes)) {
            $value = $this->getNode()->getDateTimeAttribute($attrName);
        } else {
            $value = $this->getNode()->getAttribute($attrName);
        }
        if (empty($value)) {
            $value = null;
        } elseif (1 == count($value)) {
            $value = $value[0];
        }

        return $value;
    }

    /**
     * Affecte une nouvelle valeur à un attribut
     *
     * @param string $attrName
     * @param mixed $value
     * @return self
     * @throws LdapException
     */
    public function set($attrName, $value)
    {
        if (in_array($attrName, $this->dateTimeAttributes)) {
            $this->getNode()->setDateTimeAttribute($attrName, $value, true);
        } else {
            $this->getNode()->setAttribute($attrName, $value);
        }

        return $this;
    }

    /**
     * Retourne <code>true</code> si l'attribut $param possède la valeur $value, <code>false</code> sinon.
     *
     * @param string $attrName
     * @param mixed $value
     * @return boolean
     */
    public function has($attrName, $value)
    {
        return $this->getNode()->attributeHasValue($attrName, $value);
    }

    /**
     * Ajoute une valeur à un attribut
     *
     * @param string $attrName
     * @param mixed $value
     * @return self
     * @throws LdapException
     */
    public function add($attrName, $value)
    {
        if (in_array($attrName, $this->dateTimeAttributes)) {
            $this->getNode()->appendToDateTimeAttribute($attrName, $value);
        } else {
            $this->getNode()->appendToAttribute($attrName, $value);
        }

        return $this;
    }

    /**
     * Retire une valeur à un attribut
     *
     * @param string $attrName
     * @param mixed|array $value
     * @return self
     */
    public function remove($attrName, $value)
    {
        $this->getNode()->removeFromAttribute($attrName, $value);

        return $this;
    }

    /**
     * Méthode magique...
     *
     * @param string $attrName
     * @return mixed
     * @throws LdapException
     */
    public function __get($attrName)
    {
        return $this->get($attrName);
    }

    /**
     * Méthode magique...
     *
     * @param string $attrName
     * @param mixed $value
     * @return self
     * @throws LdapException
     */
    public function __set($attrName, $value)
    {
        return $this->set($attrName, $value);
    }

    /**
     * Methode magique ...
     *
     * @param string $method Nom de la méthode à appeler
     * @param array $arguments Tableau de paramètres
     * @return mixed
     */
    public function __call($method, array $arguments)
    {
        $methods = ['get', 'set', 'has', 'add', 'remove'];
        foreach ($methods as $methodName) {
            if (0 === strpos($method, $methodName)) {
                $attrName = lcfirst(substr($method, strlen($methodName)));
                $arguments = array_merge((array)$attrName, $arguments);

                return call_user_func_array([$this, $methodName], $arguments);
            }
        }
    }

    /**
     * Mise à jour de l'entité
     *
     * @return self
     * @throws LdapException
     */
    public function update()
    {
        $this->getNode()->update();

        return $this;
    }

    /**
     * Suppression de l'entité
     *
     * @return self
     */
    public function delete()
    {
        $this->getNode()->delete();

        return $this;
    }

    /**
     * Attache une connexion
     *
     * @return self
     * @throws LdapException
     */
    public function attach()
    {
        $this->getNode()->attachLdap($this->service->getLdap());

        return $this;
    }

    /**
     * Retourne l'attribut "objectClass"
     *
     * @return array|int|mixed|null
     * @throws LdapException
     */
    public function getObjectClass()
    {
        return $this->get('objectClass');
    }
}