Entity.php 9.25 KB
Newer Older
1
<?php
Bertrand Gauthier's avatar
Bertrand Gauthier committed
2

3
4
5
6
namespace UnicaenLdap\Entity;

use UnicaenLdap\Node;
use UnicaenLdap\Exception;
Bertrand Gauthier's avatar
Bertrand Gauthier committed
7
use UnicaenLdap\Service\AbstractService;
8
9
use Zend\Ldap\Dn;
use Zend\Ldap\Exception\LdapException;
10
11
12
13
14
15
16
17
18
19

/**
 * 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é
Bertrand Gauthier's avatar
Bertrand Gauthier committed
20
     *
21
22
23
24
25
26
     * @var string
     */
    protected $type;

    /**
     * Service qui gère l'entité
Bertrand Gauthier's avatar
Bertrand Gauthier committed
27
28
     *
     * @var AbstractService
29
30
31
32
33
34
35
     */
    protected $service;

    /**
     * @var Node
     */
    protected $node;
Bertrand Gauthier's avatar
Bertrand Gauthier committed
36

37
38
    /**
     * Liste des classes d'objet nécessaires à la création de l'entité
Bertrand Gauthier's avatar
Bertrand Gauthier committed
39
     *
40
     * @var array
41
     */
42
    protected $objectClass = [];
43

44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
    /**
     * 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',
//
//    ];
69
70
71
72

    /**
     * Liste des attributs contenant des dates
     *
73
     * @var array
74
     */
75
    protected $dateTimeAttributes = [];
76
77


78
79
80
81
82
    /**
     * @param string $type type d'entité
     * @return array
     * @throws Exception
     */
83
84
    public static function getNodeParams($type)
    {
Bertrand Gauthier's avatar
Bertrand Gauthier committed
85
        $params = [
86
87
88
            'Generic' => ['uid', 'UnicaenLdap\\Entity\\Generic'],
            'Group' => ['cn', 'UnicaenLdap\\Entity\\Group'],
            'People' => ['uid', 'UnicaenLdap\\Entity\\People'],
Bertrand Gauthier's avatar
Bertrand Gauthier committed
89
            'Structure' => ['supannCodeEntite', 'UnicaenLdap\\Entity\\Structure'],
90
            'System' => ['uid', 'UnicaenLdap\\Entity\\System'],
Bertrand Gauthier's avatar
Bertrand Gauthier committed
91
92
93
        ];
        if (!isset($params[$type])) throw new Exception('Paramètres de "' . $type . '" non trouvés');

94
95
96
97
        return $params[$type];
    }

    /**
98
     * Entity constructor.
99
     *
100
101
102
     * @param AbstractService $service Service qui gèrera la future entité
     * @param Node|Dn|array|string $data Noeud si Node, sinon DN
     * @throws LdapException
103
     */
Bertrand Gauthier's avatar
Bertrand Gauthier committed
104
    public function __construct(AbstractService $service, $data)
105
106
107
    {
        $this->service = $service;

Bertrand Gauthier's avatar
Bertrand Gauthier committed
108
109
110
111
        if ($data instanceof Node) {
            $this->setNode($data);
        } else {
            $this->setNode(Node::create($data, $this->objectClass));
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
        }
    }

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

    /**
     * Retourne le service qui gère l'entité
Bertrand Gauthier's avatar
Bertrand Gauthier committed
127
128
     *
     * @return AbstractService
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
     */
    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
Bertrand Gauthier's avatar
Bertrand Gauthier committed
147
     *
148
149
     * @param Node $node
     */
Bertrand Gauthier's avatar
Bertrand Gauthier committed
150
    public function setNode(Node $node)
151
152
153
154
    {
        $this->node = $node;
    }

155
156
157
158
159
160
161
162
163
164
165
    /**
     * Retourne un label en fonction d'une clé
     *
     * @param $key
     * @return null|string
     */
//    public function getLabel($key)
//    {
//        return $this->labels[$key];
//    }

166
167
168
169
170
171
172
173
174
175
176
177
178
    /**
     * 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é
     *
179
180
     * @return mixed
     * @throws Exception
181
     */
182
    public function getKey()
183
    {
184
        return reset(self::getNodeParams($this->type));
185
186
187
    }

    /**
188
     * Retourne la valeur de la clé primaire correspondant à l'entité
189
190
     *
     * @return string
191
192
     * @throws Exception
     * @throws LdapException
193
     */
194
    public function getId()
195
    {
196
        return $this->get($this->getKey());
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
    }

    /**
     * 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
213
     * @throws LdapException
214
215
216
     */
    public function toArray()
    {
Bertrand Gauthier's avatar
Bertrand Gauthier committed
217
        $result = [];
218
        $attrsList = $this->getAttributesList();
Bertrand Gauthier's avatar
Bertrand Gauthier committed
219
        foreach ($attrsList as $attrName) {
220
221
            $result[$attrName] = $this->get($attrName);
        }
Bertrand Gauthier's avatar
Bertrand Gauthier committed
222

223
224
225
226
227
228
229
        return $result;
    }

    /**
     * Retourne un attribut
     *
     * @param string $attrName
230
231
     * @return array|int|mixed|null
     * @throws LdapException
232
233
234
     */
    public function get($attrName)
    {
Bertrand Gauthier's avatar
Bertrand Gauthier committed
235
        if (in_array($attrName, $this->dateTimeAttributes)) {
236
            $value = $this->getNode()->getDateTimeAttribute($attrName);
Bertrand Gauthier's avatar
Bertrand Gauthier committed
237
        } else {
238
239
            $value = $this->getNode()->getAttribute($attrName);
        }
Bertrand Gauthier's avatar
Bertrand Gauthier committed
240
        if (empty($value)) {
241
            $value = null;
Bertrand Gauthier's avatar
Bertrand Gauthier committed
242
        } elseif (1 == count($value)) {
243
244
            $value = $value[0];
        }
Bertrand Gauthier's avatar
Bertrand Gauthier committed
245

246
247
248
249
250
251
252
        return $value;
    }

    /**
     * Affecte une nouvelle valeur à un attribut
     *
     * @param string $attrName
253
     * @param mixed $value
254
     * @return self
255
     * @throws LdapException
256
257
258
     */
    public function set($attrName, $value)
    {
Bertrand Gauthier's avatar
Bertrand Gauthier committed
259
        if (in_array($attrName, $this->dateTimeAttributes)) {
260
            $this->getNode()->setDateTimeAttribute($attrName, $value, true);
Bertrand Gauthier's avatar
Bertrand Gauthier committed
261
        } else {
262
263
            $this->getNode()->setAttribute($attrName, $value);
        }
Bertrand Gauthier's avatar
Bertrand Gauthier committed
264

265
266
267
268
269
270
271
        return $this;
    }

    /**
     * Retourne <code>true</code> si l'attribut $param possède la valeur $value, <code>false</code> sinon.
     *
     * @param string $attrName
272
     * @param mixed $value
273
274
275
276
277
278
279
280
281
282
283
     * @return boolean
     */
    public function has($attrName, $value)
    {
        return $this->getNode()->attributeHasValue($attrName, $value);
    }

    /**
     * Ajoute une valeur à un attribut
     *
     * @param string $attrName
284
     * @param mixed $value
285
     * @return self
286
     * @throws LdapException
287
288
289
     */
    public function add($attrName, $value)
    {
Bertrand Gauthier's avatar
Bertrand Gauthier committed
290
        if (in_array($attrName, $this->dateTimeAttributes)) {
291
            $this->getNode()->appendToDateTimeAttribute($attrName, $value);
Bertrand Gauthier's avatar
Bertrand Gauthier committed
292
        } else {
293
294
            $this->getNode()->appendToAttribute($attrName, $value);
        }
Bertrand Gauthier's avatar
Bertrand Gauthier committed
295

296
297
298
299
300
301
        return $this;
    }

    /**
     * Retire une valeur à un attribut
     *
302
303
     * @param string $attrName
     * @param mixed|array $value
304
305
306
307
308
     * @return self
     */
    public function remove($attrName, $value)
    {
        $this->getNode()->removeFromAttribute($attrName, $value);
Bertrand Gauthier's avatar
Bertrand Gauthier committed
309

310
311
312
313
314
315
316
317
        return $this;
    }

    /**
     * Méthode magique...
     *
     * @param string $attrName
     * @return mixed
318
     * @throws LdapException
319
320
321
322
323
324
325
326
327
328
     */
    public function __get($attrName)
    {
        return $this->get($attrName);
    }

    /**
     * Méthode magique...
     *
     * @param string $attrName
329
     * @param mixed $value
330
     * @return self
331
     * @throws LdapException
332
333
334
335
336
337
338
339
340
     */
    public function __set($attrName, $value)
    {
        return $this->set($attrName, $value);
    }

    /**
     * Methode magique ...
     *
341
342
     * @param string $method Nom de la méthode à appeler
     * @param array $arguments Tableau de paramètres
343
344
345
346
     * @return mixed
     */
    public function __call($method, array $arguments)
    {
Bertrand Gauthier's avatar
Bertrand Gauthier committed
347
348
349
350
351
352
353
        $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);
354
355
356
            }
        }
    }
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405

    /**
     * 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');
    }
406
}