PHP: полный мануал с примерами, функциями и ООП

<?php
declare(strict_types=1);
use MongoDB\Driver\{Manager, Command};
use MongoDB\BSON\{Document,ObjectId};
use MongoDB\Driver\Exception\{
    Exception as DriverFailure, RuntimeException as DriverRuntime, InvalidArgumentException as DriverInvalid,
    LogicException as DriverLogic, UnexpectedValueException as DriverUnexpected, CommandException
};

require __DIR__.'/er134-helper.php';
[$rows,$checks,$runtime,$counts] = er134Lab(static function(Manager $manager,string $db,string $ns): array {
    $inserted = er134Put($manager,$ns,[['_id'=>'S-10','state'=>'готов']]);
    $caught = false;
    try {
        $waiting = er134Cursor($manager,$ns,['state'=>'ожидает'],['_id'=>1])->toArray();
        $ready = er134Cursor($manager,$ns,['state'=>'готов'],['_id'=>1])->toArray();
    } catch (DriverFailure $error) {
        $caught = true;
        throw $error;
    }
    $screen = $waiting === [] ? 'Очередь пуста' : 'Есть заказы';
    $checks = ['one_fixture'=>$inserted === 1,'no_throw'=>$caught === false,'empty_list'=>$waiting === [],
        'found_ready'=>count($ready) === 1,'known_order'=>$ready[0]['_id'] === 'S-10','correct_screen'=>$screen === 'Очередь пуста'];
    $rows = [['Ожидают',count($waiting)],['Готовы',count($ready)],['Открываем заказ',$ready[0]['_id']],['Сообщение',$screen]];
    return [$rows,$checks];
});
er134Report('mongodb134-contract-empty-is-result', ['Что проверили', 'Результат'], $rows,$checks,$runtime,$counts);
echo 'mongodb134-contract-empty-is-result: OK', PHP_EOL;

mongodb134-contract-empty-is-result: OK

Самостоятельный CLI-запуск на реальной MongoDB. Проверяется результат сценария и очистка собственной коллекции.

<?php
declare(strict_types=1);
use MongoDB\Driver\{Manager, Command};
use MongoDB\BSON\{Document,ObjectId};
use MongoDB\Driver\Exception\{
    Exception as DriverFailure, RuntimeException as DriverRuntime, InvalidArgumentException as DriverInvalid,
    LogicException as DriverLogic, UnexpectedValueException as DriverUnexpected, CommandException
};

require __DIR__.'/er134-helper.php';
[$rows,$checks,$runtime,$counts] = er134Lab(static function(Manager $manager,string $db,string $ns): array {
    $known = '664000000000000000000001';
    $unknown = '664000000000000000000002';
    er134Put($manager,$ns,[['_id'=>new ObjectId($known),'receipt'=>'R-1']]);
    $states = [];
    $queries = 0;
    foreach ([$known,$unknown,'not-an-id'] as $input) {
        try {
            $id = new ObjectId($input);
        } catch (DriverInvalid $error) {
            $states[] = 'Неверный формат';
            continue;
        }
        $queries++;
        $items = er134Cursor($manager,$ns,['_id'=>$id],['_id'=>0,'receipt'=>1])->toArray();
        $states[] = $items ? $items[0]['receipt'] : 'Не найден';
    }
    $checks = ['known_loaded'=>$states[0] === 'R-1','missing_normal'=>$states[1] === 'Не найден','invalid_rejected'=>$states[2] === 'Неверный формат',
        'only_two_queries'=>$queries === 2,'three_answers'=>count($states) === 3,'fixed_id_is_hex'=>strlen($known) === 24 && ctype_xdigit($known)];
    $rows = [['Существующий ID',$states[0]],['Верный, но неизвестный ID',$states[1]],['Строка not-an-id',$states[2]],['Отправлено поисков',$queries]];
    return [$rows,$checks];
});
er134Report('mongodb134-contract-invalid-id', ['Что проверили', 'Результат'], $rows,$checks,$runtime,$counts);
echo 'mongodb134-contract-invalid-id: OK', PHP_EOL;

mongodb134-contract-invalid-id: OK

Самостоятельный CLI-запуск на реальной MongoDB. Проверяется результат сценария и очистка собственной коллекции.

<?php
declare(strict_types=1);
use MongoDB\Driver\{Manager, Command};
use MongoDB\BSON\{Document,ObjectId};
use MongoDB\Driver\Exception\{
    Exception as DriverFailure, RuntimeException as DriverRuntime, InvalidArgumentException as DriverInvalid,
    LogicException as DriverLogic, UnexpectedValueException as DriverUnexpected, CommandException
};

require __DIR__.'/er134-helper.php';
[$rows,$checks,$runtime,$counts] = er134Lab(static function(Manager $manager,string $db,string $ns): array {
    $known = '664000000000000000000003';
    er134Put($manager,$ns,[['_id'=>new ObjectId($known),'label'=>'талон C']]);
    $entered = 0;
    $lookup = static function(string $text) use($manager,$ns,&$entered): array {
        $entered++;
        $id = new ObjectId($text);
        return er134Cursor($manager,$ns,['_id'=>$id],['_id'=>0,'label'=>1])->toArray();
    };
    $typeIsDriver = null;
    $invalidIsDriver = null;
    try {
        $lookup(['id'=>$known]);
    } catch (TypeError $error) {
        $typeIsDriver = $error instanceof DriverFailure;
    }
    $beforeString = $entered;
    try {
        $lookup('xyz');
    } catch (DriverInvalid $error) {
        $invalidIsDriver = $error instanceof DriverFailure;
    }
    $result = $lookup($known);
    $checks = ['php_type_outside_driver'=>$typeIsDriver === false,'first_call_not_entered'=>$beforeString === 0,
        'invalid_string_driver'=>$invalidIsDriver === true,'two_string_calls'=>$entered === 2,'one_valid_doc'=>count($result) === 1,
        'expected_label'=>$result[0]['label'] === 'талон C'];
    $rows = [['Вход в функцию при массиве',$beforeString],['TypeError реализует интерфейс драйвера',$typeIsDriver],
        ['Ошибка xyz реализует интерфейс драйвера',$invalidIsDriver],['Корректная строка',$result[0]['label']]];
    return [$rows,$checks];
});
er134Report('mongodb134-contract-php-type', ['Что проверили', 'Результат'], $rows,$checks,$runtime,$counts);
echo 'mongodb134-contract-php-type: OK', PHP_EOL;

mongodb134-contract-php-type: OK

Самостоятельный CLI-запуск на реальной MongoDB. Проверяется результат сценария и очистка собственной коллекции.

<?php
declare(strict_types=1);
use MongoDB\Driver\{Manager, Command};
use MongoDB\BSON\{Document,ObjectId};
use MongoDB\Driver\Exception\{
    Exception as DriverFailure, RuntimeException as DriverRuntime, InvalidArgumentException as DriverInvalid,
    LogicException as DriverLogic, UnexpectedValueException as DriverUnexpected, CommandException
};

require __DIR__.'/er134-helper.php';
[$rows,$checks,$runtime,$counts] = er134Lab(static function(Manager $manager,string $db,string $ns): array {
    er134Put($manager,$ns,[['_id'=>'1','qty'=>2],['_id'=>'2','qty'=>3],['_id'=>'3','qty'=>1]]);
    $projection = ['_id'=>1,'qty'=>1];
    $cursor = er134Cursor($manager,$ns,[],$projection);
    $cursor->rewind();
    $first = $cursor->current()['_id'];
    $cursor->next();
    $second = $cursor->current()['_id'];
    $rejected = false;
    try {
        $cursor->rewind();
    } catch (DriverLogic $error) {
        $rejected = $error instanceof DriverFailure && $error instanceof \LogicException;
    }
    $ids = [];
    $total = 0;
    foreach (er134Cursor($manager,$ns,[],$projection) as $row) {
        $ids[] = $row['_id'];
        $total += $row['qty'];
    }
    $checks = ['first'=>$first === '1','second'=>$second === '2','rewind_blocked'=>$rejected,
        'three_lines'=>count($ids) === 3,'ordered_lines'=>$ids === ['1','2','3'],'one_pass_total'=>$total === 6];
    $rows = [['До next',$first],['После next',$second],['Перемотка отклонена',$rejected],['Строк в накладной',count($ids)],['Единиц всего',$total]];
    return [$rows,$checks];
});
er134Report('mongodb134-contract-cursor-state', ['Что проверили', 'Результат'], $rows,$checks,$runtime,$counts);
echo 'mongodb134-contract-cursor-state: OK', PHP_EOL;

mongodb134-contract-cursor-state: OK

Самостоятельный CLI-запуск на реальной MongoDB. Проверяется результат сценария и очистка собственной коллекции.

<?php
declare(strict_types=1);
use MongoDB\Driver\{Manager, Command};
use MongoDB\BSON\{Document,ObjectId};
use MongoDB\Driver\Exception\{
    Exception as DriverFailure, RuntimeException as DriverRuntime, InvalidArgumentException as DriverInvalid,
    LogicException as DriverLogic, UnexpectedValueException as DriverUnexpected, CommandException
};

require __DIR__.'/er134-helper.php';
[$rows,$checks,$runtime,$counts] = er134Lab(static function(Manager $manager,string $db,string $ns): array {
    $goodBytes = (string)Document::fromPHP(['_id'=>'batch-17','state'=>'получен']);
    $damaged = "\x05\x00\x00\x00\x01";
    $inserted = 0;
    $rejected = 0;
    $parentMatches = false;
    foreach ([$goodBytes,$damaged] as $bytes) {
        try {
            $parsed = Document::fromBSON($bytes);
        } catch (DriverUnexpected $error) {
            $rejected++;
            $parentMatches = get_parent_class($error) === \UnexpectedValueException::class;
            continue;
        }
        $inserted += er134Put($manager,$ns,[$parsed->toPHP(['root'=>'array','document'=>'array'])]);
    }
    $saved = er134Cursor($manager,$ns,[],['_id'=>1,'state'=>1])->toArray();
    $checks = ['bad_five_bytes'=>strlen($damaged) === 5,'only_valid_insert'=>$inserted === 1,'one_rejected'=>$rejected === 1,
        'spl_parent'=>$parentMatches,'one_record'=>count($saved) === 1,'good_content'=>$saved[0] === ['_id'=>'batch-17','state'=>'получен']];
    $rows = [['Байт в повреждённом пакете',strlen($damaged)],['Отклонено',$rejected],['Сохранено',$inserted],['ID сохранённой записи',$saved[0]['_id']]];
    return [$rows,$checks];
});
er134Report('mongodb134-contract-damaged-bson', ['Что проверили', 'Результат'], $rows,$checks,$runtime,$counts);
echo 'mongodb134-contract-damaged-bson: OK', PHP_EOL;

mongodb134-contract-damaged-bson: OK

Самостоятельный CLI-запуск на реальной MongoDB. Проверяется результат сценария и очистка собственной коллекции.

<?php
declare(strict_types=1);
use MongoDB\Driver\{Manager, Command};
use MongoDB\BSON\{Document,ObjectId};
use MongoDB\Driver\Exception\{
    Exception as DriverFailure, RuntimeException as DriverRuntime, InvalidArgumentException as DriverInvalid,
    LogicException as DriverLogic, UnexpectedValueException as DriverUnexpected, CommandException
};

require __DIR__.'/er134-helper.php';
[$rows,$checks,$runtime,$counts] = er134Lab(static function(Manager $manager,string $db,string $ns): array {
    $accepted = [];
    $reasons = [];
    foreach (['664000000000000000000004','bad','664000000000000000000005'] as $i=>$value) {
        try {
            $id = new ObjectId($value);
            $wire = $i === 2 ? "\x05\x00\x00\x00\x01" : (string)Document::fromPHP(['ref'=>'Q-18']);
            $data = Document::fromBSON($wire)->toPHP(['root'=>'array']);
        } catch (DriverFailure $error) {
            if ($error instanceof DriverInvalid) {$reasons[] = 'неверный ID';}
            elseif ($error instanceof DriverUnexpected) {$reasons[] = 'испорчен BSON';}
            else {throw $error;}
            continue;
        }
        er134Put($manager,$ns,[['_id'=>$id,'ref'=>$data['ref']]]);
        $accepted[] = $data['ref'];
    }
    $stored = er134Cursor($manager,$ns,[],['_id'=>0,'ref'=>1])->toArray();
    $checks = ['one_accepted'=>$accepted === ['Q-18'],'two_rejections'=>count($reasons) === 2,
        'bad_id'=>$reasons[0] === 'неверный ID','bad_wire'=>$reasons[1] === 'испорчен BSON',
        'stored_accepted'=>$stored === [['ref'=>'Q-18']],'three_outcomes'=>count($accepted)+count($reasons) === 3];
    $rows = [['Принят документ',$accepted[0]],['Вторая строка',$reasons[0]],['Третья строка',$reasons[1]],['Записей в коллекции',count($stored)]];
    return [$rows,$checks];
});
er134Report('mongodb134-contract-driver-boundary', ['Что проверили', 'Результат'], $rows,$checks,$runtime,$counts);
echo 'mongodb134-contract-driver-boundary: OK', PHP_EOL;

mongodb134-contract-driver-boundary: OK

Самостоятельный CLI-запуск на реальной MongoDB. Проверяется результат сценария и очистка собственной коллекции.

<?php
declare(strict_types=1);
use MongoDB\Driver\{Manager, Command};
use MongoDB\BSON\{Document,ObjectId};
use MongoDB\Driver\Exception\{
    Exception as DriverFailure, RuntimeException as DriverRuntime, InvalidArgumentException as DriverInvalid,
    LogicException as DriverLogic, UnexpectedValueException as DriverUnexpected, CommandException
};

require __DIR__.'/er134-helper.php';
[$rows,$checks,$runtime,$counts] = er134Lab(static function(Manager $manager,string $db,string $ns): array {
    er134Put($manager,$ns,[['_id'=>'version-test','state'=>'сохранён']]);
    $event = null;
    try {
        er134Command($manager,$db,['phpmanUnknownContractCommand134'=>1]);
    } catch (DriverRuntime $error) {
        $event = $error;
    }
    if (!$event instanceof CommandException) {throw new RuntimeException('Expected a real command failure');}
    $invalidParent = get_parent_class(DriverInvalid::class);
    $runtimeParent = get_parent_class(DriverRuntime::class);
    $driverInterface = (new ReflectionClass(DriverFailure::class))->isInterface();
    $legacyWrite = class_exists('MongoDB\\Driver\\Exception\\WriteException');
    $oldTls = class_exists('MongoDB\\Driver\\Exception\\SSLConnectionException');
    $record = er134Cursor($manager,$ns,['_id'=>'version-test'],['_id'=>0,'state'=>1])->toArray()[0];
    $checks = ['is_interface'=>$driverInterface,'runtime_parent'=>$runtimeParent === \RuntimeException::class,
        'invalid_parent'=>$invalidParent === \InvalidArgumentException::class,'invalid_separate'=>!is_subclass_of(DriverInvalid::class,DriverRuntime::class),
        'real_code'=>$event->getCode() === 59,'marker'=>$event instanceof DriverFailure,'historical_types_absent'=>!$legacyWrite && !$oldTls,
        'record_intact'=>$record['state'] === 'сохранён'];
    $rows = [['Версия расширения',phpversion('mongodb')],['Драйверный Exception — интерфейс',$driverInterface],
        ['Код неизвестной команды',$event->getCode()],['Родитель DriverRuntime',$runtimeParent],
        ['Родитель DriverInvalid',$invalidParent],['Есть исторический WriteException',$legacyWrite],['Есть исторический SSLConnectionException',$oldTls]];
    return [$rows,$checks];
});
er134Report('mongodb134-contract-class-tree', ['Что проверили', 'Результат'], $rows,$checks,$runtime,$counts);
echo 'mongodb134-contract-class-tree: OK', PHP_EOL;

mongodb134-contract-class-tree: OK

Самостоятельный CLI-запуск на реальной MongoDB. Проверяется результат сценария и очистка собственной коллекции.

<?php
declare(strict_types=1);
use MongoDB\Driver\{Manager, Command};
use MongoDB\BSON\{Document,ObjectId};
use MongoDB\Driver\Exception\{
    Exception as DriverFailure, RuntimeException as DriverRuntime, InvalidArgumentException as DriverInvalid,
    LogicException as DriverLogic, UnexpectedValueException as DriverUnexpected, CommandException
};

require __DIR__.'/er134-helper.php';
[$rows,$checks,$runtime,$counts] = er134Lab(static function(Manager $manager,string $db,string $ns): array {
    $quantity = 4;
    er134Put($manager,$ns,[['_id'=>'op-19','reserved'=>$quantity]]);
    $respond = static function(string $case) use($manager,$db,$ns): array {
        try {
            if ($case === 'duplicate') {
                er134Put($manager,$ns,[['_id'=>'op-19','reserved'=>99]]);
            } elseif ($case === 'server-contract') {
                er134Command($manager,$db,['phpmanUnknownResponse134'=>1]);
            }
            $doc = er134Cursor($manager,$ns,['_id'=>'op-19'],['_id'=>0,'reserved'=>1])->toArray()[0];
            return ['status'=>200,'outcome'=>'Резерв: '.$doc['reserved']];
        } catch (MongoDB\Driver\Exception\BulkWriteException $error) {
            $errors = $error->getWriteResult()->getWriteErrors();
            if (count($errors) !== 1 || $errors[0]->getCode() !== 11000) {throw $error;}
            return ['status'=>409,'outcome'=>'Номер операции уже занят'];
        } catch (DriverRuntime $error) {
            if (!$error instanceof CommandException || $error->getCode() !== 59) {throw $error;}
            return ['status'=>500,'outcome'=>'Не удалось обработать запрос'];
        }
    };
    $ok = $respond('read');
    $duplicate = $respond('duplicate');
    $badCommand = $respond('server-contract');
    $actual = er134Cursor($manager,$ns,[],['_id'=>1,'reserved'=>1])->toArray();
    $checks = ['success_code'=>$ok['status'] === 200,'conflict_handled_first'=>$duplicate['status'] === 409,
        'bug_maps_500'=>$badCommand['status'] === 500,'one_original'=>count($actual) === 1,
        'quantity_unchanged'=>$actual[0]['reserved'] === 4,'read_agrees'=>$ok['outcome'] === 'Резерв: 4',
        'public_contract'=>array_keys($badCommand) === ['status','outcome']];
    $rows = [['Обычное чтение',$ok['status'].' — '.$ok['outcome']],['Повторный номер',$duplicate['status'].' — '.$duplicate['outcome']],
        ['Неподдержанная серверная команда',$badCommand['status'].' — '.$badCommand['outcome']],['В резерве после отказов',$actual[0]['reserved']]];
    return [$rows,$checks];
});
er134Report('mongodb134-contract-api-response', ['Что проверили', 'Результат'], $rows,$checks,$runtime,$counts);
echo 'mongodb134-contract-api-response: OK', PHP_EOL;

mongodb134-contract-api-response: OK

Самостоятельный CLI-запуск на реальной MongoDB. Проверяется результат сценария и очистка собственной коллекции.