Voir le flux RSS

rawsrc

[Actualité] PDOPlusPlus (PPP) : une nouvelle façon d'utiliser PDO

Note : 3 votes pour une moyenne de 5,00.
par , 21/03/2020 à 14h01 (500 Affichages)
Salut les codeurs,

Ce billet me trottait dans la tête depuis un certain bout de temps. J'ai pu enfin trouver du temps pour le mettre noir sur blanc.
Dans cet épisode, on va s'intéresser à PHP et plus particulièrement à la manière et aux outils à disposition pour interagir avec une base de données.
Je vais principalement m'attarder au sous-ensemble limité à PDO : PHP Data Object qui est vaste et assez touffu quand un débarque pour la première fois dans le monde du PHP.
Si vous aimez la lecture, la documentation officielle est très bien faite et abondante.

1 - INTRODUCTION

L'objectif de cet billet est de vous expliquer et de mettre à disposition une classe et une seule qui va encapsuler de manière totalement autonome, la complexité de PDO.
Le but pour vous sera juste de produire du SQL de manière la plus naturelle qui soit c'est-à-dire, une simple chaîne SQL banale. Vous allez voir que c'est faisable et qu'il est possible de laisser les méandres de PDO de côté. L'outil va se charger des échappements, de l'injection des données, des tags de la remontée des résultats, bref, de tout ce qu'un développeur a besoin au quotidien.
Bref, le but ultime c'est que vous n'ayez plus besoin d'utiliser les prepare(), bindValue() ou autre bindParam() tout en continuant à utiliser PDO nativement.

Comme dans mes billets précédents, j'ai toujours privilégié une approche objet des mes outils et comme vous pouvez d'ores-et-déjà vous l'imaginer, je ne vais pas déroger à la règle. Comme PDO est déjà un ensemble de classes, il est tout naturel d'imaginer que l'outil qui va encapsuler cet ensemble de classes soit lui aussi une classe.

Je vais vous mettre à disposition ce que l'on appelle communément un : PDO Wrapper.
Si vous cherchez sur le net, vous allez en trouver des tas, mais pas comme celui-ci. Du moins je n'en ai pas trouvé d'équivalent. À priori c'est une création originale.
Si par hasard, vous tombez sur un exemplaire antérieur s'approchant, je vous invite à me faire passer l'info.
Dans le cadre de la mise à jour de mes outils de développement, j'en profite pour libérer certains

Ceux qui me suivent sur DVP depuis un certain temps doivent savoir maintenant que j'ai une tendance minimaliste assez forte. Je ne suis pas partisan d'outils qui nécessitent 80 classes voire plus pour fonctionner. J'aime la légèreté et privilégie l'utilisation poussée des fonctionnalités du langage à un empilement plus ou moins touffu de code.

Je vais vous démontrer qu'il est tout à fait possible d'avoir à disposition une seule et unique classe qui fera de PDO un jeu d'enfant et ne vous laissera sur les bras que l'écriture du SQL , comme d'antan.

Voici le projet sur mon espace GitHub.

2 - OBJECTIF

Produire une classe, qui encapsulera toute la machinerie de PDO et qui nous offrira la possibilité de faire simplement les 4 opérations élémentaires (CRUD) :
  • CREATE
  • READ ou SELECT
  • UPDATE
  • DELETE
  • CALL pour les procédures stockées

L'utilité majeur c'est de mettre à plat de manière unifiée les appels à PDO.

Pour les procédures stockées, cet outil offre une gestion complète de :
  • IN param
  • OUT param
  • INOUT param
  • renvoie de plusieurs jeux de données en une seule fois
  • toutes les options mélangées...


3 - RAPPELS SUR PDO

PDO est un ensemble de classes qui permet d'abstraire et d'unifier les appels à une base de données.
Par unification, il faut bien comprendre la puissance de l'approche objet : quelle que soient les moteurs de bases de données attaquées, le développeur PHP ne manipulera que l'objet PDO qui sera l'unique interface de communication entre son code et la base de données. L'énorme avantage pour le développeur c'est que les petites ou grosses différences entre chaque moteur de base de données lui sont totalement étrangères, lui il ne voit et ne manipule que PDO.

PDO vous permet d'attaquer une base de données de manière sécurisée. C'est-à-dire qu'il offre nativement un mécanisme d'échappement des caractères pouvant avoir un sens spécifique à chaque moteur de base de données. Pour que cela fonctionne de manière optimale, il faut qu'il soit connecté à la base afin d'adapter correctement les échappements.

PDO offre 2 mécanismes de sécurisation des données :

Nom : 2020-03-20_163331.png
Affichages : 1770
Taille : 51,2 Ko

Une fois la connexion établie, il est possible d'échapper directement les données avec PDO::quote(). Cette fonction échappe les caractères spécifiques à la base de données et renvoie la valeur entourée de guillemets.
Il faut bien noter que les seuls caractères pouvant être "dangereux" sont ceux des chaînes de caractères.
Pour ce qui est des valeurs numériques, une fois que le développeur s'est assuré de la conformité au type attendu, la valeur ne présente plus aucun danger et n'a pas besoin d'échappement, un casting explicite est suffisant. N'oubliez pas que tout échappement a un coût.

Le mécanisme de préparation est plus complexe mais il offre des avantages en contrepartie. Il fonctionne en deux étapes : la première consiste a présenter au serveur une chaîne SQL en bonne et due forme dans laquelle le développeur aura pris soin de remplacer toutes les valeurs dynamiques par des tags inoffensifs comme par exemple : :nom ou :prenom. Et dans un second temps à l'exécution de la requête soit il injecte les valeurs sous forme de tableau ([:tag => valeur]) et dans ce cas, toutes les valeurs sont considérées comme du texte, soit il les rattache une par une avec bindValue(:tag, valeur, type) ou bindParam(:tag, valeur, type). Dans les deux derniers cas, il est possible de définir le type de chaque variable selon la liste définie à cette page PDO::PARAM_xxx. Notez qu'il existe une légère différence entre bindValue() et bindParam() au niveau du passage des valeurs : bindValue() les passe par valeur alors que bindParam() par référence. bindParam() est indiquée dans les cas où la même requête doit être exécutée plusieurs fois d'affilée. Comme par exemple dans l'insertion de plusieurs jeux de données (nous reverrons ce point un peu plus loin).
Enfin, l'autre avantage du mécanisme de préparation, c'est la mise en cache par le serveur de la requête SQL pour la session en cours. Ainsi, si la même requête est représentée au cours de la même session, elle sera exécutée un poil plus vite.
Attention : bien que le mécanisme de préparation soit performant, il arrive dans certains cas de requête complexe où l'injection des valeurs rattachées aux tags pose problème, il faudra se rabattre sur un échappement SQL direct qui lui passe quelle que soit la chaîne SQL à traîter.

L'échappement des données est obligatoire et n'est pas une chose triviale. Vous allez trouver sur le net des fonctions d'échappement de données qui vous évitent d'avoir une connexion ouverte avec la base de données, manipulez les avec moult précautions. Comme les encodages maintenant sont quasiment tous en multioctets (utf8, utf8mb4...), si vous faites un loupé dans la gestion des encodages entre le PHP et votre SGBDR, vous vous exposez à des attaques basées sur les encodages. Donc, par précaution et pour la sécurité de vos développements, je vous invite à toujours privilégier et utiliser les outils natifs fournis par votre environnement.


4 - SUPPORT PRATIQUE

Tout au long de cet billet, je vais me servir d'un support pratique très simple afin de faciliter le passage des nouveaux concepts.
Je vais utiliser une base de données db_pdo_plus_plus contenant une seule et unique table t_video permettant le suivi d'une mini vidéothèque dont voici la DDL (Data Definition Language) :
Code sql : Sélectionner tout - Visualiser dans une fenêtre à part
1
2
3
4
5
6
7
8
9
10
11
CREATE OR REPLACE TABLE db_pdo_plus_plus.t_video
(
    video_id            int auto_increment primary key,
    video_title         varchar(255) not null,
    video_support       varchar(30) not null comment 'DVD DIVX BLU-RAY',
    video_multilangual  tinyint(1) default 0 not null,
    video_chapter       int null,
    video_year          int not null,
    video_summary       text null
    video_stock         int default 0
);


5 - CODE DE LA CLASSE : PDOPlusPlus alias PPP pour PHP 7+

Voici le code de la classe qui encapsule totalement PDO. Les explications et comment l'utiliser viennent juste après à travers quelques cas pratiques :

Code php : Sélectionner tout - Visualiser dans une fenêtre à part
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
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
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
<?php
 
declare(strict_types=1);
 
namespace rawsrc\PDOPlusPlus;
 
use BadMethodCallException;
use PDO;
use PDOException;
use PDOStatement;
use TypeError;
 
/**
 * PDOPlusPlus : A PHP Full Object PDO Wrapper with a new revolutionary fluid SQL syntax
 *
 * @link        https://www.developpez.net/forums/blogs/32058-rawsrc/b9083/pdoplusplus-nouvelle-facon-dutiliser-pdo/
 * @link        https://github.com/rawsrc/PDOPlusPlus
 * @author      rawsrc - https://www.developpez.net/forums/u32058/rawsrc/
 * @copyright   MIT License
 *
 *              Copyright (c) 2020 rawsrc
 *
 *              Permission is hereby granted, free of charge, to any person obtaining a copy
 *              of this software and associated documentation files (the "Software"), to deal
 *              in the Software without restriction, including without limitation the rights
 *              to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 *              copies of the Software, and to permit persons to whom the Software is
 *              furnished to do so, subject to the following conditions:
 *
 *              The above copyright notice and this permission notice shall be included in all
 *              copies or substantial portions of the Software.
 *
 *              THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *              IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 *              FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 *              AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 *              LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 *              OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 *              SOFTWARE.
 */
class PDOPlusPlus
{
    /**
     * @const string    Used by tag generator
     */
    protected const ALPHA = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ';
    /**
     * @const string
     */
    public const MODE_PREPARE_VALUES = 'prepare_values';
    /**
     * @const string
     */
    public const MODE_PREPARE_PARAMS = 'prepare_params';
    /**
     * @const string
     */
    public const MODE_SQL_DIRECT = 'sql_direct';
    /**
     * @var PDO
     */
    protected static $pdo = null;
    /**
     * @var array
     */
    protected static $tags = [];
    /**
     * @var array   [tag => value]
     */
    protected $values = [];
    /**
     * @var array   [tag => PDO::PARAM_xxx]
     */
    protected $types = [];
    /**
     * @var array
     */
    protected $in_params = [];
    /**
     * Used only for OUT Params in stored procedure
     * @var array  [param]
     */
    protected $out_params = [];
    /**
     * Used only for OUT and IN_OUT Params in stored procedure
     * @var array
     */
    protected $inout_params = [];
    /**
     * @var string
     */
    protected $mode;
    /**
     * @var bool
     */
    protected $debug;
    /**
     * @var PDOStatement
     */
    protected $stmt;
    /**
     * @var bool
     */
    protected $params_already_binded = false;
 
    /**
     * @return bool
     */
    protected function isModePrepareValues(): bool
    {
        return $this->mode === self::MODE_PREPARE_VALUES;
    }
 
    /**
     * @return bool
     */
    protected function isModePrepareParams(): bool
    {
        return $this->mode === self::MODE_PREPARE_PARAMS;
    }
 
    /**
     * @return bool
     */
    protected function isModeSQLDirect(): bool
    {
        return $this->mode === self::MODE_SQL_DIRECT;
    }
 
    /**
     * @return bool
     */
    protected function hasInParams(): bool
    {
        return ! (empty($this->in_params) && empty($this->inout_params));
    }
 
    /**
     * @return bool
     */
    protected function hasInOutParams(): bool
    {
        return ! empty($this->inout_params);
    }
 
    /**
     * @return bool
     */
    protected function hasOutParams(): bool
    {
        return ! (empty($this->out_params) && empty($this->inout_params));
    }
 
    /**
     * @return array
     */
    protected function outParams(): array
    {
        return array_merge($this->out_params, $this->inout_params);
    }
 
    /**
     * @return string
     */
    public function mode(): string
    {
        return $this->mode;
    }
 
    /**
     * @return PDO
     */
    public static function pdo(): PDO
    {
        if (self::$pdo === null) {
            self::connect();
        }
        return self::$pdo;
    }
 
    /**
     * 3 modes available :
     * - MODE_SQL_DIRECT     : omits the PDO prepare()
     * - MODE_PREPARE_VALUES : use PDO::prepare() with bindValue()
     * - MODE_PREPARE_PARAMS : use PDO::prepare() with bindParams()
     *
     * @param string $mode
     * @param bool   $debug
     */
    public function __construct(string $mode = self::MODE_SQL_DIRECT, bool $debug = false)
    {
        $modes       = [self::MODE_SQL_DIRECT, self::MODE_PREPARE_VALUES, self::MODE_PREPARE_PARAMS];
        $this->mode  = in_array($mode, $modes, true) ? $mode : self::MODE_SQL_DIRECT;
        $this->debug = $debug;
    }
 
    //region DATABASE CONNECTION
    /**
     * Default parameters for PDO are :
     *      \PDO::ATTR_ERRMODE            => \PDO::ERRMODE_EXCEPTION,
     *      \PDO::ATTR_DEFAULT_FETCH_MODE => \PDO::FETCH_ASSOC,
     *      \PDO::ATTR_EMULATE_PREPARES   => false
     *
     * @param string $scheme     Ex: mysql pgsql...
     * @param string $host       server host
     * @param string $database   database name
     * @param string $user       user name
     * @param string $pwd        password
     * @param string $port       port number
     * @param string $timeout
     * @param array  $pdo_params others parameters for PDO          [key => value]
     * @param array  $dsn_params other parameter for the dsn string [string]
     */
    protected static function connect(
        string $scheme = DB_SCHEME, string $host = DB_HOST, string $database = DB_NAME, string $user = DB_USER,
        string $pwd = DB_PWD, string $port = DB_PORT, string $timeout = DB_TIMEOUT, array $pdo_params = DB_PDO_PARAMS,
        array $dsn_params = DB_DSN_PARAMS
    ) {
        $dsn = "{$scheme}:host={$host};dbname={$database};";
 
        if ((int)($port)) {
            $dsn .= 'port='.(int)$port.';';
        }
 
        if ((int)$timeout) {
            $dsn .= 'connect_timeout='.(int)$timeout.';';
        }
 
        if ( ! empty($dsn_params)) {
            $dsn .= implode(';', $dsn_params).';';
        }
 
        $params = $pdo_params + [
            PDO::ATTR_ERRMODE            => PDO::ERRMODE_EXCEPTION,
            PDO::ATTR_DEFAULT_FETCH_MODE => PDO::FETCH_ASSOC,
            PDO::ATTR_EMULATE_PREPARES   => false
        ];
 
        try {
            self::$pdo = new PDO($dsn, $user, $pwd, $params);
        } catch (PDOException $e) {
            throw $e;
        }
    }
    //endregion
 
    /**
     * 3 parameters allowed :
     *    - the 1st is always reserved to the value
     *    - the 2 others are free, even in their placement
     *          - one boolean strict for the nullable attribute
     *          - one string for the type among: 'int', 'str', 'float', 'double', 'num', 'numeric', 'bool'
     *
     * By default all fields are strings and nullable
     *
     * @param array $args
     * @return mixed
     */
    public function __invoke(...$args)
    {
        return $this->injectorInByVal()(...$args);
    }
 
    //region INJECTORS
    /**
     * Return the corresponding params/value injector to the current mode
     *
     * @param string $type // among: in out inout
     * @return object
     */
    public function injector(string $type = 'in'): object
    {
        if ($type === 'out') {
            return $this->injectorOut();
        }
 
        if ($type === 'inout') {
            if ($this->isModePrepareParams()) {
                return $this->injectorInOutByRef();
            } else {
                return $this->injectorInOutByVal();
            }
        }
 
        if ($type === 'in') {
            if ($this->isModePrepareParams()) {
                return $this->injectorInByRef();
            }
        }
 
        // by default
        return $this->injectorInByVal();
    }
 
    /**
     * Default injector
     * @return object
     */
    protected function injectorInByVal(): object
    {
        return new class($this) extends PDOPlusPlus {
            /**
             * @var PDOPlusPlus
             */
            private $ppp;
 
            /**
             * @param PDOPlusPlus $p
             */
            public function __construct(PDOPlusPlus $p)
            {
                $this->ppp = $p;
            }
 
            public function __invoke(...$args)
            {
                if (empty($args)) {
                    throw new BadMethodCallException('Missing value');
                }
 
                $value = $args[0];
                $type  = $args[1] ?? 'str';
 
                /**
                 * @param $p
                 * @return bool
                 */
                $is_scalar = function($p): bool {
                    return ($p === null) || is_scalar($p) || (is_object($p) && method_exists($p, '__toString'));
                };
 
                if ( ! $is_scalar($value)) {
                    throw new TypeError('Null or scalar value expected or class with __toString() implemented');
                }
 
                if ($this->ppp->isModePrepareValues()) {
                    $tag = PDOPlusPlus::tag();
                    $this->ppp->values[$tag] = $value;
                    $this->ppp->types[$tag]  = $type;
                    $this->ppp->in_params[]  = $tag;
                    return $tag;
                } elseif ($this->ppp->isModeSQLDirect()) {
                    return PDOPlusPlus::sqlValue($value, $type, false);
                } else {
                    throw new BadMethodCallException(
                        'For prepared statement using reference, you must use a specific injector "by reference"'
                    );
                }
            }
        };
    }
 
    /**
     * Default injector for referenced params
     * @return object
     */
    protected function injectorInByRef(): object
    {
        return new class($this->values, $this->types, $this->in_params) {
            private $values;
            private $types;
            private $in_params;
 
            /**
             * @param $values
             * @param $types
             * @param $in_params
             */
            public function __construct(&$values, &$types, &$in_params)
            {
                $this->values    =& $values;
                $this->types     =& $types;
                $this->in_params =& $in_params;
            }
 
            /**
             * @param         $value
             * @param  string $type     among: int str float double num numeric bool
             * @return string
             */
            public function __invoke(&$value, string $type = 'str'): string
            {
                $tag = PDOPlusPlus::tag();
                $this->values[$tag] =& $value;
                $this->types[$tag]  =  $type;
                $this->in_params[]  =  $tag;
                return $tag;
            }
        };
    }
 
    /**
     * Injector for params having only OUT attribute
     * @return object
     */
    protected function injectorOut(): object
    {
        return new class($this->out_params) {
            private $out_params;
 
            /**
             * @param $out_params
             */
            public function __construct(&$out_params)
            {
                $this->out_params =& $out_params;
            }
 
            /**
             * @param  string $out_param // ex:'@id'
             * @return string
             */
            public function __invoke(string $out_param): string
            {
                $this->out_params[] = $out_param;
                return $out_param;
            }
        };
    }
 
    /**
     * Injector for by val params having IN OUT attribute
     * @return object
     */
    protected function injectorInOutByVal(): object
    {
        return new class($this->values, $this->types, $this->inout_params) {
            private $values;
            private $types;
            private $inout_params;
 
            /**
             * @param $values
             * @param $types
             * @param $inout_params
             */
            public function __construct(&$values, &$types, &$inout_params)
            {
                $this->values       =& $values;
                $this->types        =& $types;
                $this->inout_params =& $inout_params;
            }
 
            /**
             * @param         $value
             * @param string  $inout_param // ex: '@id'
             * @param string  $type        among: int str float double num numeric bool
             * @return string
             */
            public function __invoke($value, string $inout_param, string $type = 'str'): string
            {
                $this->values[$inout_param] = $value;
                $this->types[$inout_param]  = $type;
                $this->inout_params[]       = $inout_param;
                return $inout_param;
            }
        };
    }
 
    /**
     * Injector for by ref params having IN OUT attribute
     * @return object
     */
    protected function injectorInOutByRef(): object
    {
        return new class($this->values, $this->types, $this->inout_params) {
            private $values;
            private $types;
            private $inout_params;
 
            /**
             * @param $values
             * @param $types
             * @param $inout_params
             */
            public function __construct(&$values, &$types, &$inout_params)
            {
                $this->values       =& $values;
                $this->types        =& $types;
                $this->inout_params =& $inout_params;
            }
 
            /**
             * @param        $value
             * @param string $inout_param   // ex: '@id'
             * @param string $type          among: int str float double num numeric bool
             * @return string
             */
            public function __invoke(&$value, string $inout_param, string $type = 'str'): string
            {
                $this->values[$inout_param] =& $value;            // by ref
                $this->types[$inout_param]  =  $type;
                $this->inout_params[]       =  $inout_param;
                return $inout_param;
            }
        };
    }
    //endregion
 
    /**
     * @param  string $sql
     * @return int|null           lastInsertId() | null on error
     */
    public function insert(string $sql)
    {
        try {
            $pdo = self::pdo();
            if ($this->isModeSQLDirect()) {
                $pdo->exec($sql);
            } else {
                $this->prepareAndAttachValuesOrParams($sql);
                $this->stmt->execute();
            }
            return $pdo->lastInsertId();
        } catch (PDOException $e) {
            if ($this->debug) {
                var_dump($sql);
            }
            error_log('PPP::insert - '.$e->getMessage());
            return null;
        }
    }
 
    /**
     * @param  mixed $sql
     * @return array|null       null on error
     */
    public function select($sql): ?array
    {
        try {
            if ($this->isModeSQLDirect()) {
                $this->stmt = self::pdo()->query($sql);
            } else {
                $this->prepareAndAttachValuesOrParams($sql);
                $this->stmt->execute();
            }
            return $this->stmt->fetchAll();
        } catch (PDOException $e) {
            if ($this->debug) {
                var_dump($sql);
            }
            error_log('PPP::select - '.$e->getMessage());
            return null;
        }
    }
 
    /**
     * @param  string $sql
     * @return int|null         null on error | int -> nb of affected rows
     */
    public function update(string $sql)
    {
        return $this->execute($sql);
    }
 
    /**
     * @param  string $sql
     * @return int|null         null on error | int -> nb of affected rows
     */
    public function delete(string $sql)
    {
        return $this->execute($sql);
    }
 
    /**
     * @param  string $sql
     * @return int|null         null on error | int -> nb of affected rows
     */
    public function execute(string $sql)
    {
        try {
            if ($this->isModeSQLDirect()) {
                return self::pdo()->exec($sql);
            } else {
                $this->prepareAndAttachValuesOrParams($sql);
                $this->stmt->execute();
                return $this->stmt->rowCount();
            }
        } catch (PDOException $e) {
            if ($this->debug) {
                var_dump($sql);
            }
            error_log('PPP::execute - '.$e->getMessage());
            return null;
        }
    }
 
    /**
     * @param string $sql
     * @param bool   $is_query
     * @return mixed             null on error
     */
    public function call(string $sql, bool $is_query)
    {
        try {
            $pdo = self::pdo();
 
            $inject_io_values = function() use ($pdo) {
                if ($this->hasInOutParams()) {
                    $sql = [];
                    foreach ($this->inout_params as $io) {
                        // Injecting one by one io_params's value using SQL syntax : "SET @io_param = value"
                        $sql[] = "SET {$io} = ".self::sqlValue($this->values[$io], $this->types[$io], false);
                    }
                    $sql = implode(';', $sql);
                    $pdo->exec($sql);
                }
            };
 
            if ( ! $this->isModeSQLDirect()) {
                $this->prepareAndAttachValuesOrParams($sql);
            }
 
            $inject_io_values();
 
            if ($this->isModePrepareValues() || $this->isModePrepareParams()) {
                $this->stmt->execute();
            } elseif ($is_query) {
                // SQL Direct and Query
                $this->stmt = $pdo->query($sql);
            } else {
                // SQL Direct
                if ($this->hasOutParams()) {
                    $pdo->exec($sql);
                    return ['out' => $this->extractOutParams()];
                } else {
                    return $pdo->exec($sql);
                }
            }
 
            $data    = [];
            $nb_rows = 0;
            if ($is_query) {
                do {
                    $row = $this->stmt->fetchAll();
                    if ($row) {
                        $data[] = $row;
                        ++$nb_rows;
                    } else {
                        break;
                    }
                } while ($this->stmt->nextRowset());
            }
 
            // adding the OUT params values
            if ($this->hasOutParams()) {
                $data['out'] = $this->extractOutParams();
            }
            return $data;
        } catch (PDOException $e) {
            if ($this->debug) {
                var_dump($sql);
            }
            error_log('PPP::call - '.$e->getMessage());
            return null;
        }
    }
 
    /**
     * @return array|null       [out_param => value] | null on error
     */
    public function extractOutParams(): ?array
    {
        if ($this->hasOutParams()) {
            try {
                $sql  = 'SELECT '.implode(', ', $this->outParams());
                $stmt = self::pdo()->query($sql);
                return $stmt->fetchAll()[0];
            } catch (PDOException $e) {
                if ($this->debug) {
                    var_dump($sql);
                }
                error_log('PPP::extractOutParams - '.$e->getMessage());
                return null;
            }
        } else {
            return [];
        }
    }
 
    /**
     * @param string $sql
     */
    private function prepareAndAttachValuesOrParams(string $sql)
    {
        /**
         * @param  string $p    among: int str float double num numeric bool
         * @return int
         */
        $pdo_type = function(string $p): int {
            return [
                'null' => PDO::PARAM_NULL,
                'int'  => PDO::PARAM_INT,
                'bool' => PDO::PARAM_BOOL,
            ][$p] ?? PDO::PARAM_STR;
        };
 
        if ( ! ($this->stmt instanceof PDOStatement)) {
            $this->stmt = self::pdo()->prepare($sql);
        }
 
        if ($this->isModePrepareValues()) {
            if ($this->hasInParams()) {
                foreach ($this->values as $token => $v) {
                    $this->stmt->bindValue($token, $v, $pdo_type($this->types[$token]));
                }
            }
        } elseif ($this->isModePrepareParams() && $this->hasInParams() && ( ! $this->params_already_binded)) {
            foreach ($this->values as $token => &$v) {
                $this->stmt->bindParam($token, $v, $pdo_type($this->types[$token]));
            }
            $this->params_already_binded = true;
        }
    }
 
    public function closeCursor(): void
    {
        if (isset($this->stmt)) {
            $this->stmt->closeCursor();
        }
    }
 
    /**
     * Unique tag generator
     * The tag is always unique for the whole current session
     * @return string
     */
    public static function tag(): string
    {
        do {
            $tag = ':'.substr(str_shuffle(self::ALPHA), 0, 6).mt_rand(1000, 9999);
        } while (isset(self::$tags[$tag]));
        self::$tags[$tag] = true;
        return $tag;
    }
 
    /**
     * Unique tags generator
     * The tags are always unique for the whole current session
     * @param  array $keys
     * @return array        [key => tag]
     */
    public static function tags(array $keys): array
    {
        $tags = [];
        for ($i = 0, $nb = count($keys) ; $i < $nb ; ++$i) {
            $tags[] = self::tag();
        }
        return array_combine($keys, $tags);
    }
 
    /**
     * @param        $value
     * @param string $type      among: int str float double num numeric bool
     * @param bool   $for_pdo
     * @return mixed|array       if $for_pdo => [0 => value, 1 => pdo type] | plain escaped value
     */
    public static function sqlValue($value, string $type, bool $for_pdo)
    {
        if ($value === null) {
            return $for_pdo ? [null, PDO::PARAM_NULL] : 'NULL';
        } elseif ($type === 'int') {
            $v = (int)$value;
            return $for_pdo ? [$v, PDO::PARAM_INT] : $v;
        } elseif ($type === 'bool') {
            $v = (bool)$value;
            return $for_pdo ? [$v, PDO::PARAM_BOOL] : $v;
        } elseif (in_array($type, ['float', 'double', 'num', 'numeric'], true)) {
            $v = (string)(double)$value;
            return $for_pdo ? [$v, PDO::PARAM_STR] : $v;
        } else {
            $v = (string)$value;
            if ($for_pdo) {
                return [$v, PDO::PARAM_STR];
            } else {
                return self::pdo()->quote($v, PDO::PARAM_STR);
            }
        }
    }
}
 
// make the class available on the global namespace :
class_alias('rawsrc\PDOPlusPlus\PDOPlusPlus', 'PDOPlusPlus', false);
class_alias('rawsrc\PDOPlusPlus\PDOPlusPlus', 'PPP', false);            // PPP is an official alias for PDOPlusPlus
Si vous vous penchez sur le code de cette classe, vous verrez qu'il est pêchu et nécessite un niveau avancé en PHP. L'ingénierie qui est mise en oeuvre dans ce code fait appel aux concepts les plus avancés du langage PHP. Néanmoins et en vertu des principes de la Programmation Orientée Objet, la classe s'utilise très facilement sans être obligé d'aller mettre les mains dans le cambouis.

L'atout de cet classe réside dans la manière d'insérer les valeurs dans la chaîne SQL et en même temps paramétrer PDO. Les deux étapes sont faites en une fois.
Pour que cela fonctionne, en plus d'être une classe, PDOPlusPlus se comporte aussi comme une fonction grâce à la méthode magique public function __invoke(). Méthode magique déjà employée dans le code du petit moteur de rendu qui tient en une seule classe PHPEcho.

Principe de fonctionnement

Tout se passe au moment de l'injection des valeurs, comme schématisé ci-après :

Nom : dvp_concept.png
Affichages : 241
Taille : 56,9 Ko

ATTENTION : le mode MODE_PREPARE_PARAMS nécessite une petite adaptation dans l'écriture du SQL, veuillez vous reporter au paragraphe 8.3 - ÉCHAPPEMENT AVEC LE MÉCANISME DE PRÉPARATION ET PASSAGE DES VALEURS PAR RÉFÉRENCE.

Pour le passage des paramètres dans les procédure stockées, il existe deux injecteurs spécifiques :
- un pour les paramètres de type OUT,
- un pour les paramètres de type INOUT.

Nom : dvp_out_param.png
Affichages : 239
Taille : 11,2 Ko
Nom : dvp_inout_param.png
Affichages : 239
Taille : 22,1 Ko

Pour chaque cas traité, je vais vous présenter le code standard compatible avec PDO puis le code équivalent faisant appel à PDOPlusPlus.
Comme PDO offre 3 mécanismes d'échappement, il va de soi que PDOPlusPlus reprend les 3 mêmes mécanismes.

6 - CONNEXION À LA BASE DE DONNÉES

Pour éviter d'aller tripatouiller le code à chaque fois, il est très fortement conseillé de faire appel à des constantes qui représentent des données immuables (qui ne changent pas). Les paramètres de connexion à votre base de données ne changeant généralement pas, la classe attend par défaut que vous définissiez des constantes relatives à votre paramétrage comme ceci :
Code PHP : Sélectionner tout - Visualiser dans une fenêtre à part
1
2
3
4
5
6
7
8
9
10
11
// définition des paramètres de connexion à la base de données
// constantes attendues par la fonction "private static function connect()"
define('DB_SCHEME', 'mysql');
define('DB_HOST', 'localhost');
define('DB_NAME', 'db_pdo_plus_plus');
define('DB_USER', 'root');   // utilisateur
define('DB_PWD', '');        // mot de passe
define('DB_PORT', '3306');
define('DB_TIMEOUT', '5');
define('DB_PDO_PARAMS', []);
define('DB_DSN_PARAMS', []);

7 - JEU DE DONNÉES D'EXEMPLE
Code php : Sélectionner tout - Visualiser dans une fenêtre à part
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
$data = [[
    'title'        => "The Lord of the Rings - The Fellowship of the Ring",
    'support'      => 'BLU-RAY',
    'multilingual' => true,
    'chapter'      => 1,
    'year'         => 2001,
    'summary'      => null,
    'stock'        => 10
], [
    'title'        => "The Lord of the Rings - The two towers",
    'support'      => 'BLU-RAY',
    'multilingual' => true,
    'chapter'      => 2,
    'year'         => 2002,
    'summary'      => null,
    'stock'        => 0
], [
    'title'        => "The Lord of the Rings - The return of the King",
    'support'      => 'DVD',
    'multilingual' => true,
    'chapter'      => 3,
    'year'         => 2003,
    'summary'      => null,
    'stock'        => 1
]];

8 - INSERTION

La classe offre la possibilité d'accéder à la ressource PDO sous-jacente qui a été ouverte, donc on va s'en servir simplement pour tous nos exemples.

8.1 - ÉCHAPPEMENT SQL DIRECT

Ajoutons notre premier film dans la table avec PDO (ce qui correspond à $data[0] dans notre tableau d'exemple) :
Code php : Sélectionner tout - Visualiser dans une fenêtre à part
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
// à la toute fin du fichier, la classe a plusieurs alias dont PPP ;-)
$ppp  = new PPP(PPP::MODE_SQL_DIRECT);
$pdo  = $ppp->pdo();   // extraction de la ressource ouverte par PDOPlusPlus
$film = $data[0];
 
try {
    // préparation des données et échappement manuel des données numériques et gestion des NULL (je considère que les champs obligatoires sont définis (ceux notés NOT NULL dans la DDL)) :
    $values = [
        'title'        => $pdo->quote($film['title']),
        'support'      => $pdo->quote($film['support']),
        'multilingual' => (int)$film['multilingual'],
        'chapter'      => isset($film['chapter']) ? (int)$film['chapter'] : 'NULL',
        'year'         => (int)$film['year'],
        'summary'      => isset($film['summary']) ? $pdo->quote($film['summary']) : 'NULL',
        'stock'        => (int)$film['stock']
    ];
 
    // création de la chaîne SQL d'insertion 
    $sql = 'INSERT INTO t_video (video_title, video_support, video_multilingual, video_chapter, video_year, video_summary, video_stock) VALUE ('.implode(', ', $values).')';
 
    $pdo->exec($sql);
    $id = $pdo->lastInsertId();
} catch (PDOException $e) {
    throw $e;
}

Maintenant la même opération en utilisant PDOPlusPlus :
Code php : Sélectionner tout - Visualiser dans une fenêtre à part
1
2
3
4
5
6
7
8
9
10
11
<?php
 
$ppp  = new PPP(PPP::MODE_SQL_DIRECT);
$film = $data[0];
$sql  = <<<sql
INSERT INTO t_video (video_title, video_support, video_multilingual, video_chapter, video_year, video_summary, video_stock) VALUES (
    {$ppp($film['title'])}, {$ppp($film['support'])}, {$ppp($film['multilingual'], 'bool')}, 
    {$ppp($film['chapter'], 'int')}, {$ppp($film['year'], 'int')}, {$ppp($film['summary'])}, {$ppp($film['stock'], 'int')}
);
sql;
$id = $ppp->insert($sql);

8.2 - ÉCHAPPEMENT AVEC LE MÉCANISME DE PRÉPARATION ET PASSAGE DES VALEURS PAR VALEUR

Ajoutons notre deuxième film dans la table avec PDO : via ->bindValue() (ce qui correspond à $data[1] dans notre tableau d'exemple) :
Code php : Sélectionner tout - Visualiser dans une fenêtre à part
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
$ppp  = new PDOPlusPlus(PDOPlusPlus::MODE_PREPARE_VALUES);
$pdo  = $ppp->pdo();
$film = $data[1];
 
$sql = <<<sql
INSERT INTO t_video (video_title, video_support, video_multilingual, video_chapter, video_year, video_summary, video_stock) 
     VALUES (:title, :support, :multilingual, :chapter, :year, :summary, :stock)
sql;
try {
    $stmt = $pdo->prepare($sql);
    $stmt->bindValue(':title', $film['title'], PDO::PARAM_STR);
    $stmt->bindValue(':support', $film['support'], PDO::PARAM_STR);
    $stmt->bindValue(':multilingual', (bool)$film['multilingual'], PDO::PARAM_BOOL);
    if ($film['chapter'] === null) {
        $stmt->bindValue(':chapter', null, PDO::PARAM_NULL);
    } else {
        $stmt->bindValue(':chapter', (int)$film['chapter'], PDO::PARAM_INT);
    }
    $stmt->bindValue(':year', (int)$film['year'], PDO::PARAM_INT);
    if ($film['resume'] === null) {
        $stmt->bindValue(':summary', null, PDO::PARAM_NULL);
    } else {
        $stmt->bindValue(':summary', $film['summary'], PDO::PARAM_STR);
    }
    $stmt->bindValue(':stock', (int)$film['stock'], PDO::PARAM_INT);
    $stmt->execute();
    $id = $pdo->lastInsertId();
} catch (PDOException $e) {
    throw $e;
}
Maintenant la même opération en utilisant PDOPlusPlus :
Code php : Sélectionner tout - Visualiser dans une fenêtre à part
1
2
3
4
5
6
7
8
9
$ppp  = new PPP(PPP::MODE_PREPARE_VALUES);
$film = $data[1];
$sql  = <<<sql
INSERT INTO t_video (video_title, video_support, video_multilingual, video_chapter, video_year, video_summary, video_stock) VALUES (
    {$ppp($film['title'])}, {$ppp($film['support'])}, {$ppp($film['multilingual'], 'bool')}, 
    {$ppp($film['chapter'], 'int')}, {$ppp($film['year'], 'int')}, {$ppp($film['summary'])}, {$ppp($film['stock'], 'int')}
);
sql;
$id = $ppp->insert($sql);
Voici la chaîne intermédiaire qui a été générée par PDOPlusPlus pendant le traitement :
Code sql : Sélectionner tout - Visualiser dans une fenêtre à part
1
2
INSERT INTO t_video (video_title, video_support, video_multilingual, video_chapter, video_year, video_summary, video_stock) 
     VALUES (:XMEDem6153, :oASqvP7440, :mbfaTY4236, :FJzRWx7446, :FVHvqL4843, :tcCvZo8956, :JRtazM4176);
On remarque bien la présence de jetons d'identification pour l'injection des données (les ":tag").

J'attire votre attention sur l'unique changement de code pour basculer d'une méthode à l'autre :
Code php : Sélectionner tout - Visualiser dans une fenêtre à part
1
2
$ppp  = new PPP(PPP::MODE_SQL_DIRECT);      // échappement direct
$ppp  = new PPP(PPP::MODE_PREPARE_VALUES);  // préparation et passage par valeur
Tout le reste du code n'a pas bougé d'un iota. Alors que le traitement en arrière plan de la requête a été complètement différent ! C'est la magie de la POO.


8.3 - ÉCHAPPEMENT AVEC LE MÉCANISME DE PRÉPARATION ET PASSAGE DES VALEURS PAR RÉFÉRENCE

Après avoir purgé notre table, ajoutons la totalité de nos films avec PDO : via ->bindParam(). Je vous rappelle que le mécanisme de préparation couplé au passage des valeurs par référence est uniquement indiqué quand vous devez exécuter plusieurs fois d'affilée la même requête mais avec des données différentes. PDO offre dans ce cas de figure une optimisation de taille afin de ne pas alourdir le traitement : c'est le passage par référence des variables. Ainsi, on pourra faire changer très rapidement les valeurs de nos variables et ré-exécuter notre requête d'insertion sans avoir à la préparer à nouveau.
Code php : Sélectionner tout - Visualiser dans une fenêtre à part
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
$ppp = new PDOPlusPlus(PDOPlusPlus::MODE_PREPARE_PARAMS);
$pdo = $ppp->pdo();
$ids = [];
 
$sql = <<<sql
INSERT INTO t_video (video_title, video_support, video_multilingual, video_chapter, video_year, video_summary, video_stock) 
     VALUES (:title, :support, :multilingual, :chapter, :year, :summary, :stock)
sql;
try {
    $stmt = $pdo->prepare($sql);
    // à ce stade on défini des variables ($title, $support...) sans aucune valeur mais avec une existence en mémoire (une simple référence ou adresse mémoire)
    // par la suite notre code ira rattacher des valeurs à ces variables mais PDO ne lira que la valeur contenue à l'adresse mémoire qui a été définie
    $stmt->bindParam(':title', $title, PDO::PARAM_STR);
    $stmt->bindParam(':support', $support, PDO::PARAM_STR);
    $stmt->bindParam(':multilingual', $multilingual, PDO::PARAM_BOOL);
    $stmt->bindParam(':chapter', $chapter, PDO::PARAM_INT);
    $stmt->bindParam(':year', $year, PDO::PARAM_INT);
    $stmt->bindParam(':summary', $summary, PDO::PARAM_STR);
    $stmt->bindParam(':stock', $stock, PDO::PARAM_INT);
 
    foreach ($data as $film) {
        // on déstructure notre tableau pour coller aux variables attendues par bindParam() : $titre, $support...
        // avantageusement les nom des variables correspondent aux noms des clés du tableau $film
        // donc PHP offre un raccourci : extract()
        extract($film); // chaque clé du tableau devient une variable ayant pour valeur celle définie dans le tableau
        // on exécute la requête autant de fois que nécessaire sans l'étape de la préparation
        // à chaque tour de boucle, les valeurs des variables sont mises à jour grâce à extract()
        $stmt->execute();
        $ids[] = $pdo->lastInsertId(); // à la fin : [1, 2, 3] : nos 3 films ont bien été ajoutés
    }
} catch (PDOException $e) {
    throw $e;
}
Après avoir purgé notre table, maintenant la même opération en utilisant PDOPlusPlus :
Code php : Sélectionner tout - Visualiser dans une fenêtre à part
1
2
3
4
5
6
7
8
9
10
11
12
$ppp     = new PDOPlusPlus(PDOPlusPlus::MODE_PREPARE_PARAMS);
$in  = $ppp->injector(); // injecteur de référence
$ids = [];
$sql     = <<<sql
INSERT INTO t_video (video_title, video_support, video_multilingual, video_chapter, video_year, video_summary, video_stock) 
     VALUES ({$in($title)}, {$in($support)}, {$in($multilingual, 'bool')}, {$in($chapter, 'int')}, {$in($year, 'int')}, {$in($summary)}, {$ppp($stock, 'int')})
sql;
 
foreach ($data as $film) {
    extract($film);
    $ids[] = $ppp->insert($sql);    // à la fin : [1, 2, 3] : nos 3 films ont bien été ajoutés
}
ATTENTION : pour que le passage par référence fonctionne, il faut passer par un injecteur de référence : $in = $ppp->injector(); // injecteur de référence et c'est lui qui DOIT ÊTRE UTILISÉ dans la chaîne SQL pour l'injection des valeurs.



Je vais faire un aparté pour les développeurs experts en PHP, histoire de fournir une explication technique de la problématique.
Comme pour toute technologie et PHP en fait partie, il existe des règles et des limites. Là, on est au-delà des limites de PHP. Limites qu'il a fallu contourner afin de préserver le fonctionnement très simple de cet outil.
Depuis PHP 5.4, lors de l'appel d'une fonction il est impossible de forcer la passage des paramètres par référence sous peine de ramasser une erreur fatale :
PHP Fatal error: Call-time pass-by-reference has been removed
en conséquence, lors de l'appel de __invoke(), j'ai maintenu le passage des variables par valeur pour les appels en mode MODE_SQL_DIRECT et MODE_PREPARE_VALUES et j'ai dû redéfinir le comportement de __invoke() pour pouvoir récupérer les références des variables pour le mode MODE_PREPARE_PARAMS.
Une classe anonyme dérivant de la classe mère était tout indiquée pour ce travail. Conceptuellement, la nouvelle classe étant de même nature que la classe parente, la dérivation étant utile pour conserver un code minimaliste tout en préservant les accès nécessaires à la génération de code. Mais là vous devez faire face à une autre limite de PHP : la redéfinition des méthodes dans le cadre de l'héritage d'objet est permise mais très restrictive et contraignante sur les prototypes des méthodes. Comme la signature de la fonction __invoke() s'en est trouvée modifiée, vous ramassez là-aussi une belle erreur fatale :
PHP Fatal error: Declaration of ...::__invoke() must be compatible with PDOPlusPlus::__invoke()
Ce qui explique le code un tantinet exotique des fonctions public function injectorXXX(): object, code qui a permis de contourner assez élégamment les limitations de PHP 7+.

Bref, si vous ne comprenez pas trop ces explications, n'en faites quand même pas des cauchemars. D'ailleurs, tout reste utilisable sans pour autant avoir la nécessité de saisir toutes les subtilités du code source. Ça fonctionne, c'est le principal.



Maintenant que l'on a vu les 3 manières de fonctionnement de PDOPlusPlus, on va pouvoir tester les autres fonctionnalités en s'affranchissant totalement de PDO.
Je vais juste vous montrer de brefs exemples.

9 - SELECTION
Code php : Sélectionner tout - Visualiser dans une fenêtre à part
1
2
3
$ppp = new PPP(PPP::MODE_PREPARE_VALUES);
$sql = "SELECT video_id FROM t_video WHERE video_support = {$ppp('BLU-RAY')}";
$ids = $ppp->select($sql);
Pour utiliser un LIKE :
Code php : Sélectionner tout - Visualiser dans une fenêtre à part
1
2
3
$ppp = new PPP(PPP::MODE_PREPARE_VALUES);
$sql = "SELECT video_id FROM t_video WHERE video_support LIKE {$ppp('%RAY%')}";
$ids = $ppp->select($sql);

9 - MODIFICATION
Code php : Sélectionner tout - Visualiser dans une fenêtre à part
1
2
3
$ppp = new PPP(PPP::MODE_SQL_DIRECT);
$sql = "UPDATE t_video SET video_support = {$ppp('DVD')} WHERE video_id = {$ppp('1', 'int')}";
$ppp->update($sql);
Code php : Sélectionner tout - Visualiser dans une fenêtre à part
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
$ppp = new PPP(PPP::MODE_PREPARE_VALUES, true);
$summary = <<<'txt'
Sur la Terre du Milieu, dans la paisible région de la Comté, vit le Hobbit Frodon Sacquet. Comme tous les Hobbits, Frodon est un bon vivant, 
amoureux de la terre bien cultivée et de la bonne chère. Orphelin alors qu'il n'était qu'un enfant, il s'est installé à Cul-de-Sac chez son oncle Bilbon, 
connu de toute la Comté pour les aventures extraordinaires qu'il a vécues étant jeune et les trésors qu'il en a tirés. Le jour de ses 111 ans, Bilbon 
donne une fête grandiose à laquelle est convié le puissant magicien Gandalf le Gris. C'est en ce jour particulier que Bilbon décide de se retirer chez les Elfes 
pour y finir sa vie. Il laisse en héritage à Frodon son trou de Hobbit ainsi qu'un anneau, qu'il a autrefois trouvé dans la caverne d'une créature nommée Gollum 
dans les Monts Brumeux, et qui a le pouvoir de rendre invisible quiconque le porte à son doigt.
Gandalf est intrigué par l'anneau laissé à Frodon et surtout par les circonstances confuses dans lesquelles Bilbon l'a trouvé. Après s'être rendu à Minas Tirith, 
la capitale du Gondor, pour lire le récit de la vie d'Isildur, un ancien roi de l'Arnor et du Gondor, il découvre que cet objet n'est autre que l'Anneau unique 
forgé il y a bien longtemps par Sauron, le Seigneur des Ténèbres, et qui fut perdu 3 000 ans auparavant. Cet anneau maléfique est une arme redoutable qui 
permettrait au seigneur du Mordor de régner sur la Terre du Milieu et de réduire tous ses peuples en esclavage. Gandalf relate alors à Frodon la malédiction de 
l'Anneau et l'informe que les serviteurs de Sauron sont déjà en route pour retrouver le précieux objet. Il lui demande de l'emporter en secret à Fondcombe, 
demeure de l'Elfe Elrond, où l'on pourra prendre une décision à son sujet, pendant que Gandalf va sur les terres d'Isengard afin de consulter Saroumane, 
le supérieur de son ordre.
Un anneau en or...
txt;
$sql = "UPDATE t_video SET video_summary = {$ppp($summary)} WHERE video_id = {$ppp('1', 'int')}";
$ppp->update($sql);

10 - SUPPRESSION
Code php : Sélectionner tout - Visualiser dans une fenêtre à part
1
2
3
$ppp = new PPP(PPP::MODE_PREPARE_VALUES);
$sql = "DELETE FROM t_video WHERE video_id = {$ppp('1', 'int')}";
$ppp->delete($sql);
Quand vous n'avez pas besoin d'injecter des valeurs, utilisez toujours le mode MODE_SQL_DIRECT, comme ceci :
Code php : Sélectionner tout - Visualiser dans une fenêtre à part
1
2
$ppp = new PPP(PPP::MODE_SQL_DIRECT);
$ppp->execute("TRUNCATE TABLE t_video");


11 - PROCÉDURES STOCKÉES

Les procédures stockées sont une évolution majeure de cet outil à plusieurs titres d'ailleurs.
Compte tenu que PDO n'a pas une prise en charge totalement satisfaisante dans la gestion des procédures stockées paramétrées avec des OUT et/ou des INOUT, PDOPlusPlus utilise une méthode universelle en deux requêtes SQL qui permet de s'affranchir des problèmes posés par PDO.

Comme indiqué en introduction, nous verrons les différentes possibilités d'interaction avec les procédures stockées qu'elles soient très simples à très complexes.

11.1 - PROCÉDURE STOCKÉE QUI RENVOIE UN JEU DE DONNÉES
Code php : Sélectionner tout - Visualiser dans une fenêtre à part
1
2
3
4
5
6
7
8
9
10
11
12
13
// ONE ROWSET
$ppp  = new PPP(PPP::MODE_SQL_DIRECT);
$exec = $ppp->execute(<<<'sql'
CREATE OR REPLACE DEFINER = root@localhost PROCEDURE db_pdo_plus_plus.sp_list_films()
BEGIN
    SELECT * FROM t_video;
END;
sql
);
 
 
$ppp  = new PPP(PPP::MODE_SQL_DIRECT);
$rows = $ppp->call('CALL sp_list_films()', true); // n'oubliez pas le true qui indique que la procédure stockée renvoie des données

11.2 - PROCÉDURE STOCKÉE QUI RENVOIE DEUX JEUX DE DONNÉES SIMULTANÉMENT
Code php : Sélectionner tout - Visualiser dans une fenêtre à part
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
// MULTIPLE ROWSETS
$ppp  = new PPP(PPP::MODE_SQL_DIRECT);
$exec = $ppp->execute(<<<'sql'
CREATE OR REPLACE DEFINER = root@localhost PROCEDURE db_pdo_plus_plus.sp_list_films_group_by_support()
BEGIN
    SELECT * FROM t_video WHERE video_support = 'BLU-RAY';
    SELECT * FROM t_video WHERE video_support = 'DVD';
END;
sql
);
 
 
$ppp  = new PPP(PPP::MODE_SQL_DIRECT);
$rows = $ppp->call('CALL sp_list_films_group_by_support()', true);
// rows[0] est un tableau de films BLU-RAY : le 0 pointe sur le premier jeu de données
// rows[1] est un tableau de films DVD : le 1 pointe sur le second jeu de données

11.3 - PROCÉDURE STOCKÉE AVEC DES PARAMÈTRES IN
Code php : Sélectionner tout - Visualiser dans une fenêtre à part
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
// WITH TWO IN PARAM
$ppp  = new PPP(PPP::MODE_SQL_DIRECT);
$exec = $ppp->execute(<<<'sql'
CREATE OR REPLACE DEFINER = root@localhost PROCEDURE db_pdo_plus_plus.sp_list_films_two_in_param(
    p_support VARCHAR(30), 
    p_year INT
)
BEGIN
    SELECT * FROM t_video WHERE video_support = p_support AND video_year = p_year;
END;
sql
);
 
$ppp  = new PPP(PPP::MODE_SQL_DIRECT);
$rows = $ppp->call("CALL sp_list_films_two_in_param({$ppp('DVD')}, {$ppp('2001', 'int')})", true);
 
$ppp  = new PPP(PPP::MODE_PREPARE_VALUES);
$rows = $ppp->call("CALL sp_list_films_two_in_param({$ppp('DVD')}, {$ppp('2003', 'int')})", true);
 
$ppp  = new PPP(PPP::MODE_PREPARE_PARAMS);
$in   = $ppp->injector();
$sup  = 'BLU-RAY';
$year = '2002';
$rows = $ppp->call("CALL sp_list_films_two_in_param({$in($sup)}, {$in($year, 'int')})", true);
Comme vous pouvez le remarquer c'est toujours dans la continuité des utilisations précédentes

11.4 - PROCÉDURE STOCKÉE AVEC UN PARAMÈTRE OUT
Code php : Sélectionner tout - Visualiser dans une fenêtre à part
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
// WITH ONE OUT PARAM
$ppp  = new PPP(PPP::MODE_SQL_DIRECT);
$exec = $ppp->execute(<<<'sql'
CREATE OR REPLACE DEFINER = root@localhost PROCEDURE db_pdo_plus_plus.sp_nb_films_one_out_param(OUT p_nb INT)
BEGIN
    SELECT COUNT(video_id) INTO p_nb FROM t_video;
END;
sql
);
 
$ppp  = new PPP(PPP::MODE_SQL_DIRECT);
$out  = $ppp->injector('out');
$exec = $ppp->call("CALL sp_nb_films_one_out_param({$out('@nb')})", false);
$nb   = $exec['out']['@nb'];
 
$ppp  = new PPP(PPP::MODE_PREPARE_VALUES);
$out  = $ppp->injector('out');
$exec = $ppp->call("CALL sp_nb_films_one_out_param({$out('@nb')})", false);
$nb   = $exec['out']['@nb'];
Veuillez noter dans ce code l'utilisation d'un injecteur spécifique : $out = $ppp->injector('out');.

11.5 - PROCÉDURE STOCKÉE AVEC UN JEU DE DONNÉES ET 2 PARAMÈTRES OUT
Code php : Sélectionner tout - Visualiser dans une fenêtre à part
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
// WITH ROWSET AND TWO OUT PARAM
$ppp  = new PPP(PPP::MODE_SQL_DIRECT);
$exec = $ppp->execute(<<<'sql'
CREATE OR REPLACE DEFINER = root@localhost PROCEDURE db_pdo_plus_plus.sp_nb_films_rowset_two_out_param(
    OUT p_nb_blu_ray INT,
    OUT p_nb_dvd INT
)
BEGIN
    SELECT * FROM t_video ORDER BY video_year DESC;
    SELECT COUNT(video_id) INTO p_nb_blu_ray FROM t_video WHERE video_support = 'BLU-RAY';
    SELECT COUNT(video_id) INTO p_nb_dvd FROM t_video WHERE video_support = 'DVD';
END;
sql
);
 
$ppp   = new PPP(PPP::MODE_SQL_DIRECT);
$out   = $ppp->injector('out');
$exec  = $ppp->call("CALL sp_nb_films_rowset_two_out_param({$out('@nb_blu_ray')}, {$out('@nb_dvd')})", true);
$rows  = $exec[0];  // $exec[0] => pointe sur le le premier jeu de données qui est un tableau de tous les films trié par année décroissante
$nb_br = $exec['out']['@nb_blu_ray'];
$nb_dv = $exec['out']['@nb_dvd'];
 
$ppp   = new PPP(PPP::MODE_PREPARE_VALUES);
$out   = $ppp->injector('out');
$exec  = $ppp->call("CALL sp_nb_films_rowset_two_out_param({$out('@nb_blu_ray')}, {$out('@nb_dvd')})", true);
$rows  = $exec[0];  // $exec[0] => pointe sur le le premier jeu de données qui est un tableau de tous les films trié par année décroissante
$nb_br = $exec['out']['@nb_blu_ray'];
$nb_dv = $exec['out']['@nb_dvd'];

11.6 - PROCÉDURE STOCKÉE AVEC UN PARAMÈTRE INOUT ET 2 PARAMÈTRES OUT
Code php : Sélectionner tout - Visualiser dans une fenêtre à part
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
// WITH ONE INOUT PARAM AND TWO OUT PARAM
$ppp  = new PPP(PPP::MODE_SQL_DIRECT);
$exec = $ppp->execute(<<<'sql'
CREATE OR REPLACE DEFINER = root@localhost PROCEDURE db_pdo_plus_plus.sp_nb_films_one_inout_two_out_param(
    INOUT p_qty INT, 
    OUT p_nb_blu_ray INT, 
    OUT p_nb_dvd INT
)
BEGIN
    DECLARE v_nb INT;
    SELECT SUM(video_stock) INTO v_nb FROM t_video;
    SET p_qty = v_nb - p_qty;
    SELECT COUNT(video_id) INTO p_nb_blu_ray FROM t_video WHERE video_support = 'BLU-RAY';
    SELECT COUNT(video_id) INTO p_nb_dvd FROM t_video WHERE video_support = 'DVD';
END;
sql
);
 
$ppp   = new PPP(PPP::MODE_SQL_DIRECT);
$io    = $ppp->injector('inout');
$out   = $ppp->injector('out');
$exec  = $ppp->call("CALL sp_nb_films_one_inout_two_out_param({$io('25', '@stock', 'int')}, {$out('@nb_blu_ray')}, {$out('@nb_dvd')})", false);
$stock = $exec['out']['@stock'];
$nb_br = $exec['out']['@nb_blu_ray'];
$nb_dv = $exec['out']['@nb_dvd'];
Veuillez noter dans ce code l'utilisation de deux injecteurs spécifiques : $io = $ppp->injector('inout'); et $out = $ppp->injector('out');.

11.7 - PROCÉDURE STOCKÉE : RÈGLE GÉNÉRALE CONCERNANT LES PARAMÈTRES OUT

Les valeurs OUT renvoyées par une procédure stockée sont TOUJOURS dans le tableau résultat à la clé $result['out'], toutes les clés numériques correspondent aux jeux de données que la procédure stockée peut renvoyer.

12 - CONCLUSION

Chers collègues développeurs, nous voilà rendus à la fin de ce long billet entièrement consacré à PDO et au nouvel sur-ensemble de ma conception PDOPlusPlus.
Cet outil doit normalement vous révolutionner l'écriture sécurisée de vos requêtes SQL.
Plus besoin de s'occuper de aspects redondants de la couche PDO. Vous continuez à conserver un accès à toutes les fonctionnalités de PDO, tout en ayant un code souple, léger et entièrement sécurisé nativement. Bref, que des avantages
Ne vous en faites pas si la conception de cet outil vous échappe, l'ingénierie logicielle derrière le code est d'un niveau très avancé et nécessite une grande pratique de PHP doublée d'une connaissance théorique très complète du langage et de ses concepts objets.

J'espère en tout cas, que vous allez vous l'approprier, l'étudier et lui trouver une utilité de premier ordre. Et par la suite, l'améliorer encore. Dans ce cas, je me ferai un plaisir d'échanger avec vous.
Comme à l'accoutumé, j'ai disséminé des commentaires dans mon code pour expliquer certains points et faciliter ainsi la compréhension (une fois n'est pas coutume, je les ai laissés en français).
Enfin, vous allez trouver d'autres fonctions utiles dans cette classe, des fonctions qui ne nécessitent pas d'explications mais qui peuvent vous servir dans l'écosystème PDO.

Bon code à tous

rawsrc

Envoyer le billet « PDOPlusPlus (PPP) : une nouvelle façon d'utiliser PDO » dans le blog Viadeo Envoyer le billet « PDOPlusPlus (PPP) : une nouvelle façon d'utiliser PDO » dans le blog Twitter Envoyer le billet « PDOPlusPlus (PPP) : une nouvelle façon d'utiliser PDO » dans le blog Google Envoyer le billet « PDOPlusPlus (PPP) : une nouvelle façon d'utiliser PDO » dans le blog Facebook Envoyer le billet « PDOPlusPlus (PPP) : une nouvelle façon d'utiliser PDO » dans le blog Digg Envoyer le billet « PDOPlusPlus (PPP) : une nouvelle façon d'utiliser PDO » dans le blog Delicious Envoyer le billet « PDOPlusPlus (PPP) : une nouvelle façon d'utiliser PDO » dans le blog MySpace Envoyer le billet « PDOPlusPlus (PPP) : une nouvelle façon d'utiliser PDO » dans le blog Yahoo

Mis à jour 28/03/2020 à 09h28 par rawsrc

Catégories
PHP , Développement Web

Commentaires

  1. Avatar de laurentSc
    • |
    • permalink
    Super cette nouvelle classe, et preuve qu'un non-expert PHP peut l'utiliser : j'y suis arrivé

    Ayant démarré une application avec ta classe MyPDO (et ce que j'ai fait fonctionne), je ne pense pas essayer de la convertir (ne pas toucher ce qui marche !).
    J'ai néanmoins lu en entier ton billet (confirmation que je suis pas un expert, après avoir lu ton apparté) et faute de frappe dans ton code (vue en voulant tester) : l'insert avec valeurs préparées passées par valeur :
    Code php : Sélectionner tout - Visualiser dans une fenêtre à part
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
     
    $ppp  = new PPP(PPP::MODE_PREPARE_VALUES);
    $film = $data[1];
    $sql  = <<<sql
    INSERT INTO t_video (video_titre, video_support, video_multilingues, video_episode, video_annee, video_resume) VALUES (
        {$ppp($film['titre'], false)}, {$ppp($film['support'], false)}, {$ppp($film['multilngues'], 'bool', false)}, 
        {$ppp($film['episode'], 'int')}, {$ppp($film['annee'], 'int', false)}, {$ppp($film['resume'])}
    );
    sql;
    $new_id = $ppp->insert($sql);
    tu as écrit $film['multilngues']. Manque un i.

    Petite surprise : j'ai volontairement introduit une erreur dans la requête SQL, mais aucun message d'erreur affiché...Normal ou j'ai oublié de faire un truc ?
  2. Avatar de rawsrc
    • |
    • permalink
    Citation Envoyé par laurentSc
    $new_id = $ppp->insert($sql); tu as écrit $film['multilngues']. Manque un i.
    Merci c'est corrigé,

    Citation Envoyé par laurentSc
    Petite surprise : j'ai volontairement introduit une erreur dans la requête SQL, mais aucun message d'erreur affiché...Normal ou j'ai oublié de faire un truc ?
    Pour ce qui est des erreurs, quand cela échoue, la fonction renvoie null et l'erreur s'en va dans error_log(). Regarde le code source de la fonction insert() de la classe.
    Généralement, les erreurs de base de données sont les dernières qu'on remonte à la surface, il est préférable de les envoyer dans le fichier log.
    Mis à jour 21/03/2020 à 18h51 par rawsrc
  3. Avatar de CinePhil
    • |
    • permalink
    Bonjour,

    Pas essayé mais ça semble intéressant.

    As-tu essayé l'appel aux procédures stockées (CALL la_procédure (les, parametres, demandés, par, la, procedure) avec la subtilité des IN, OUT et INOUT) ?
  4. Avatar de rawsrc
    • |
    • permalink
    Salut CinePhil

    ouaip, j'ai ça dans les tuyaux, cela fera l'objet d'une mise à jour. Je dois encore mener quelques tests plus poussés avant de publier.
    Pour l'instant, cela supporte le CRUDE (Create (INSERT), Read (SELECT), UPDATE, DELETE, EXECUTE).
  5. Avatar de rawsrc
    • |
    • permalink
    euh je suis en train de mener des tests avec les procédure stockées et PDO, et ben c'est un beau bordel dès qu'il y a des paramètres OUT et INOUT. Les paramètres IN sont plutôt homogènes (ouf).
    Le fameux bitwise avec PDO::PARAM_INPUT_OUTPUT n'a pas l'air d'être pris en compte de la même manière selon les moteurs et même selon les versions quand il n'est carrément pas ignoré ou fasse tout planter.

    Euh, il le savent chez Zend que ça semble créer plus de problèmes que ça n'en résout ?
  6. Avatar de rawsrc
    • |
    • permalink
    Bon, après un paquet de tests dans tous les sens, il semblerait que la récupération d'un paramètre OUT en 2 étapes fonctionne impec et semble "assez universelle".
    Donc, c'est sur cette voie que je vais m'engager pour la gestion des paramètres OUT et INOUT dans les appels aux procédures stockées avec la deuxième étape automatique, il va de soi : le SELECT @PARAM_OUT.
    Bien que sur les autres fonctionnalités, PDO s'en sort très honorablement, sur l'aspect OUT et INOUT, c'est franchement moisi. Du coup je laisse PDO et sa cuisine de côté. Ça crée trop de problèmes.

    Si vous avez d'autres pistes, n'hésitez pas à me les soumettre.
    Par ailleurs si vous avez un SGBDR qui ne comprend pas cette syntaxe, ça serait aussi cool de participer à ce fil.

    Merci
  7. Avatar de grunk
    • |
    • permalink
    Perso j'utilise jamais bindValue ce qui enlève une bonne partie de la lourdeur de PDO :

    Code : Sélectionner tout - Visualiser dans une fenêtre à part
    1
    2
    $stmt = $pdo->prepare($sql);
    $stmt->execute([$param1,$param2]);
    Comme je considère que mes types doivent être bon avant d'arriver dans le SQL , le type du bind n'a pas d'importance.

    A défaut de dériver de PDO , il manque , je pense, à ta classe un moyen de récupérer l'instance de PDO en cours dans le cas ou quelqu’un voudrais faire quelque chose que ta classe ne permet pas ou qu'il ai besoin de la passer à un objet qui attend une instance de PDO.
  8. Avatar de rawsrc
    • |
    • permalink
    si si tu peux récupérer l'instance PDO courante, heureusement d'ailleurs :
    Code php : Sélectionner tout - Visualiser dans une fenêtre à part
    1
    2
    $ppp  = new PPP(PPP::MODE_SQL_DIRECT);
    $pdo  = $ppp->pdo();   // extraction de la ressource ouverte par PDOPlusPlus
    C'est dans le premier exemple de code
  9. Avatar de grunk
    • |
    • permalink
    AU temps pour moi j'ai regardé la source sur github en diagonale
  10. Avatar de rawsrc
    • |
    • permalink
    Bonjour à tous,

    j'ai procédé à une importante mise à jour du code source de PDOPlusPlus.
    J'y ai intégré notamment la gestion complète des procédures stockées paramétrées ou pas, renvoyant zéro ou plusieurs jeux de données simultanément.

    Attention : à la différence de la précédente mouture, cette version ne gère plus la validation des valeurs nullables. C'est le seul changement qui risque de vous créer une légère incompatibilité avec la version précédente.