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

mysql_xdevapi8.0.11+; учебный runtime8.0.30 · mysql_xdevapi

class mysql_xdevapi\Session

Один установленный сеанс связывает операции с сервером и границами транзакции. Его получают через getSession, а не new Session. Две Session — два отдельных сеанса.

Класс расширения mysql_xdevapi доступен с8.0.11. Его конструктор закрытый (private), поэтому объект возвращает соответствующий API. Ниже справочная схема, а не класс, который нужно объявить в своём файле.

class mysql_xdevapi\Session {
    public function close(): bool;
    public function commit(): Object;
    private function __construct();
    public function createSchema(string $schema_name): Schema;
    public function dropSchema(string $schema_name): bool;
    public function generateUUID(): string;
    public function getDefaultSchema(): ?Schema;
    public function getSchema(string $schema_name): Schema;
    public function getSchemas(): array;
    public function getServerVersion(): int;
    public function listClients(): array;
    public function quoteName(string $name): string;
    public function releaseSavepoint(string $name): void;
    public function rollback(): void;
    public function rollbackTo(string $name): void;
    public function setSavepoint(string $name = ?): string;
    public function sql(string $query): SqlStatement;
    public function startTransaction(): void;
}

Два применения

Диагностика получает версию именно установленного сеанса; URI берётся из проверенного окружения.

$session = mysql_xdevapi\getSession($uri);
$version = $session->getServerVersion();

Исходные данные, полный файл и ожидаемый результат.

После проверки существующей учебной схемы тот же сеанс создаёт свою коллекцию.

$schema = $session->getSchema($schemaName);
$collection = $schema->createCollection($ownName);

Исходные данные, полный файл и ожидаемый результат.

Короткие записи здесь — контекстные фрагменты и варианты применения. Самостоятельные программы с окружением, отчётом и очисткой находятся по ссылкам; фрагменты не считаются дополнительными выполненными программами.

Методы с переходом в PHP Manual перечислены для полного обзора класса; такой внешний переход не выдаётся за уже написанный отдельный урок по каждому методу. При сетевом отказе, отсутствии прав или неподходящем аргументе последующее действие может не состояться: сообщение о сохранении выводите только после полученного результата и нужной прикладной проверки.

• PHP Manual — Session
• PHP Manual — Session::__construct

mysql_xdevapi8.0.11+; учебный runtime8.0.30 · mysql_xdevapi

class mysql_xdevapi\Schema implements DatabaseObject

Schema представляет базу MySQL и даёт доступ к коллекциям и реляционным таблицам. Сам getSchema не создаёт базу. Публичное name описывает имя объекта; изменение PHP-свойства не является командой переименования базы.

Класс расширения mysql_xdevapi доступен с8.0.11. Его конструктор закрытый (private), поэтому объект возвращает соответствующий API. Ниже справочная схема, а не класс, который нужно объявить в своём файле.

class mysql_xdevapi\Schema implements DatabaseObject {
    public $name;
    private function __construct();
    public function createCollection(string $name, string $validate = ?): Collection;
    public function dropCollection(string $collection_name): bool;
    public function existsInDatabase(): bool;
    public function getCollection(string $name): Collection;
    public function getCollectionAsTable(string $name): Table;
    public function getCollections(): array;
    public function getName(): string;
    public function getSession(): Session;
    public function getTable(string $name): Table;
    public function getTables(): array;
}

implements перечисляет реализованные контракты: DatabaseObject. Это описание возможностей объектов, а не новые данные каталога. Как интерфейс задаёт договор поведения.

Два применения

Перед работой подтвердите существование заранее подготовленной учебной базы.

$schema = $session->getSchema($schemaName);
$present = $schema->existsInDatabase();

Исходные данные, полный файл и ожидаемый результат.

Создание и получение второго объекта доступа решают разные задачи.

$collection = $schema->createCollection($ownName);
$another = $schema->getCollection($ownName);

Исходные данные, полный файл и ожидаемый результат.

Короткие записи здесь — контекстные фрагменты и варианты применения. Самостоятельные программы с окружением, отчётом и очисткой находятся по ссылкам; фрагменты не считаются дополнительными выполненными программами.

Методы с переходом в PHP Manual перечислены для полного обзора класса; такой внешний переход не выдаётся за уже написанный отдельный урок по каждому методу. При сетевом отказе, отсутствии прав или неподходящем аргументе последующее действие может не состояться: сообщение о сохранении выводите только после полученного результата и нужной прикладной проверки.

• PHP Manual — Schema
• PHP Manual — Schema::__construct

mysql_xdevapi8.0.11+; учебный runtime8.0.30 · mysql_xdevapi

class mysql_xdevapi\Collection implements SchemaObject

Collection — объект доступа к набору JSON-документов. Он хранит связь с именем и схемой, а не весь каталог в памяти PHP. Получается через Schema. Поле name описывает имя; данные меняют методами CRUD.

Класс расширения mysql_xdevapi доступен с8.0.11. Его конструктор закрытый (private), поэтому объект возвращает соответствующий API. Ниже справочная схема, а не класс, который нужно объявить в своём файле.

class mysql_xdevapi\Collection implements SchemaObject {
    public $name;
    public function add(mixed $document): CollectionAdd;
    public function addOrReplaceOne(string $id, string $doc): Result;
    private function __construct();
    public function count(): int;
    public function createIndex(string $index_name, string $index_desc_json): void;
    public function dropIndex(string $index_name): bool;
    public function existsInDatabase(): bool;
    public function find(string $search_condition = ?): CollectionFind;
    public function getName(): string;
    public function getOne(string $id): Document;
    public function getSchema(): Schema;
    public function getSession(): Session;
    public function modify(string $search_condition): CollectionModify;
    public function remove(string $search_condition): CollectionRemove;
    public function removeOne(string $id): Result;
    public function replaceOne(string $id, string $doc): Result;
}

implements перечисляет реализованные контракты: SchemaObject. Это описание возможностей объектов, а не новые данные каталога. Как интерфейс задаёт договор поведения.

Document в сокращённой схеме getOne — обозначение данных документа, не встроенный PHP-класс для new. В этом API прочитанные поля используются как массив, а отсутствие обозначается null; различие разобрано в Collection::getOne.

Два применения

Записать одну карточку и затем отдельно проверить сохранённую цену.

$receipt = $collection->add(['_id'=>'LAMP-1','price'=>1200])->execute();
$lamp = $collection->getOne('LAMP-1');

Исходные данные, полный файл и ожидаемый результат.

Выдать подходящие карточки при изменившемся бюджете.

$items = $collection->find('price <= :ceiling')
    ->bind(['ceiling'=>1000])->execute()->fetchAll();

Исходные данные, полный файл и ожидаемый результат.

Короткие записи здесь — контекстные фрагменты и варианты применения. Самостоятельные программы с окружением, отчётом и очисткой находятся по ссылкам; фрагменты не считаются дополнительными выполненными программами.

Методы с переходом в PHP Manual перечислены для полного обзора класса; такой внешний переход не выдаётся за уже написанный отдельный урок по каждому методу. При сетевом отказе, отсутствии прав или неподходящем аргументе последующее действие может не состояться: сообщение о сохранении выводите только после полученного результата и нужной прикладной проверки.

• PHP Manual — Collection
• PHP Manual — Collection::__construct

mysql_xdevapi8.0.11+; учебный runtime8.0.30 · mysql_xdevapi

class mysql_xdevapi\CollectionAdd implements Executable

CollectionAdd описывает ещё не отправленное добавление. Collection::add возвращает этот объект; execute отправляет действие и возвращает квитанцию Result. Повторный execute не следует использовать как безопасный повтор бизнес-операции.

Класс расширения mysql_xdevapi доступен с8.0.11. Его конструктор закрытый (private), поэтому объект возвращает соответствующий API. Ниже справочная схема, а не класс, который нужно объявить в своём файле.

class mysql_xdevapi\CollectionAdd implements Executable {
    private function __construct();
    public function execute(): Result;
}

implements перечисляет реализованные контракты: Executable. Это описание возможностей объектов, а не новые данные каталога. Как интерфейс задаёт договор поведения.

Два применения

Можно отдельно увидеть пустую коллекцию до исполнения подготовленной операции.

$operation = $collection->add(['_id'=>'LAMP-1','price'=>1200]);
$before = $collection->count();
$receipt = $operation->execute();

Исходные данные, полный файл и ожидаемый результат.

Одна операция принимает несколько документов и даёт общую квитанцию.

$receipt = $collection->add(['sku'=>'LED'], '{"sku":"CABLE"}')->execute();
$ids = $receipt->getGeneratedIds();

Исходные данные, полный файл и ожидаемый результат.

Короткие записи здесь — контекстные фрагменты и варианты применения. Самостоятельные программы с окружением, отчётом и очисткой находятся по ссылкам; фрагменты не считаются дополнительными выполненными программами.

Методы с переходом в PHP Manual перечислены для полного обзора класса; такой внешний переход не выдаётся за уже написанный отдельный урок по каждому методу. При сетевом отказе, отсутствии прав или неподходящем аргументе последующее действие может не состояться: сообщение о сохранении выводите только после полученного результата и нужной прикладной проверки.

• PHP Manual — CollectionAdd
• PHP Manual — CollectionAdd::__construct

mysql_xdevapi8.0.11+; учебный runtime8.0.30 · mysql_xdevapi

class mysql_xdevapi\CollectionFind implements Executable, CrudOperationBindable, CrudOperationLimitable, CrudOperationSortable

CollectionFind хранит условие и настройки запроса. Каждый метод настройки возвращает CollectionFind для дальнейшей цепочки; execute возвращает уже DocResult. Найденные документы не хранятся в самой строке условия.

Класс расширения mysql_xdevapi доступен с8.0.11. Его конструктор закрытый (private), поэтому объект возвращает соответствующий API. Ниже справочная схема, а не класс, который нужно объявить в своём файле.

class mysql_xdevapi\CollectionFind implements Executable, CrudOperationBindable, CrudOperationLimitable, CrudOperationSortable {
    public function bind(array $placeholder_values): CollectionFind;
    private function __construct();
    public function execute(): DocResult;
    public function fields(string $projection): CollectionFind;
    public function groupBy(string $sort_expr): CollectionFind;
    public function having(string $sort_expr): CollectionFind;
    public function limit(int $rows): CollectionFind;
    public function lockExclusive(int $lock_waiting_option = ?): CollectionFind;
    public function lockShared(int $lock_waiting_option = ?): CollectionFind;
    public function offset(int $position): CollectionFind;
    public function sort(string $sort_expr): CollectionFind;
}

implements перечисляет реализованные контракты: Executable, CrudOperationBindable, CrudOperationLimitable, CrudOperationSortable. Это описание возможностей объектов, а не новые данные каталога. Как интерфейс задаёт договор поведения.

Схема воспроизводит краткие формы Manual. Полный текст CollectionFind::fields допускает массив полей, а пример CollectionFind::sort — несколько строк сортировки. Знак ? у необязательного аргумента в справочной схеме означает, что значение по умолчанию здесь не конкретизировано; не вставляйте такой знак в вызов.

Два применения

Сначала выбрать товары, затем ограничить данные карточки.

$request = $collection->find('category = :category');
$request->bind(['category'=>$category])->fields(['sku','name']);
$result = $request->execute();

Исходные данные, полный файл и ожидаемый результат.

Настройки одной выдачи задают вторую страницу неизменяемого каталога.

$result = $collection->find()->sort('price ASC','sku ASC')
    ->limit(2)->offset(2)->execute();

Исходные данные, полный файл и ожидаемый результат.

Короткие записи здесь — контекстные фрагменты и варианты применения. Самостоятельные программы с окружением, отчётом и очисткой находятся по ссылкам; фрагменты не считаются дополнительными выполненными программами.

Методы с переходом в PHP Manual перечислены для полного обзора класса; такой внешний переход не выдаётся за уже написанный отдельный урок по каждому методу. При сетевом отказе, отсутствии прав или неподходящем аргументе последующее действие может не состояться: сообщение о сохранении выводите только после полученного результата и нужной прикладной проверки.

• PHP Manual — CollectionFind
• PHP Manual — CollectionFind::__construct

mysql_xdevapi8.0.11+; учебный runtime8.0.30 · mysql_xdevapi

class mysql_xdevapi\DocResult implements BaseResult, Traversable

DocResult содержит результат поиска документов и сведения о предупреждениях. Создаётся исполнением CollectionFind; документы получают методами чтения или foreach. Это иной объект, чем Result квитанции записи.

Класс расширения mysql_xdevapi доступен с8.0.11. Его конструктор закрытый (private), поэтому объект возвращает соответствующий API. Ниже справочная схема, а не класс, который нужно объявить в своём файле.

class mysql_xdevapi\DocResult implements BaseResult, Traversable {
    private function __construct();
    public function fetchAll(): array;
    public function fetchOne(): array;
    public function getWarnings(): array;
    public function getWarningsCount(): int;
}

implements перечисляет реализованные контракты: BaseResult, Traversable. Это описание возможностей объектов, а не новые данные каталога. Как интерфейс задаёт договор поведения.

У fetchOne краткая сигнатура array неполна: описание возврата включает null в конце результата. Для цикла используйте именно эту границу. Traversable позволяет foreach, но не является обещанием перематывать уже прочитанный результат.

Два применения

Небольшая ограниченная выборка превращается в готовый список карточек.

$documents = $request->execute()->fetchAll();

Исходные данные, полный файл и ожидаемый результат.

Последовательное чтение прекращается на null; альтернативный foreach показан на свежем результате.

while (($document = $result->fetchOne()) !== null) {
    echo $document['sku'], PHP_EOL;
}

Исходные данные, полный файл и ожидаемый результат.

Короткие записи здесь — контекстные фрагменты и варианты применения. Самостоятельные программы с окружением, отчётом и очисткой находятся по ссылкам; фрагменты не считаются дополнительными выполненными программами.

Методы с переходом в PHP Manual перечислены для полного обзора класса; такой внешний переход не выдаётся за уже написанный отдельный урок по каждому методу. При сетевом отказе, отсутствии прав или неподходящем аргументе последующее действие может не состояться: сообщение о сохранении выводите только после полученного результата и нужной прикладной проверки.

• PHP Manual — DocResult
• PHP Manual — DocResult::__construct

mysql_xdevapi8.0.11+; учебный runtime8.0.30 · mysql_xdevapi

class mysql_xdevapi\Result implements BaseResult, Traversable

Result — квитанция завершённой операции записи: затронутое количество, серверные идентификаторы и предупреждения. Она не заменяет чтение сохранённых полей и не означает число товаров во всей коллекции.

Класс расширения mysql_xdevapi доступен с8.0.11. Его конструктор закрытый (private), поэтому объект возвращает соответствующий API. Ниже справочная схема, а не класс, который нужно объявить в своём файле.

class mysql_xdevapi\Result implements BaseResult, Traversable {
    private function __construct();
    public function getAffectedItemsCount(): int;
    public function getAutoIncrementValue(): int;
    public function getGeneratedIds(): array;
    public function getWarnings(): array;
    public function getWarningsCount(): int;
}

implements перечисляет реализованные контракты: BaseResult, Traversable. Это описание возможностей объектов, а не новые данные каталога. Как интерфейс задаёт договор поведения.

Наличие Traversable в схеме не превращает квитанцию в коллекцию сохранённых карточек. Для нашего добавления полезны счётчик и generated IDs; поля товаров возвращает отдельный запрос. getWarnings/getWarningsCount описывают предупреждения операции, а не исключение, прервавшее её.

Два применения

Одна явная карточка даёт счётчик1; её цену всё равно читают отдельно.

$receipt = $collection->add(['_id'=>'LAMP-1','price'=>1200])->execute();
$added = $receipt->getAffectedItemsCount();

Исходные данные, полный файл и ожидаемый результат.

Квитанция нескольких добавлений даёт адреса для проверенного повторного чтения.

$ids = $receipt->getGeneratedIds();
foreach ($ids as $id) {$saved[] = $collection->getOne($id);}

Исходные данные, полный файл и ожидаемый результат.

Короткие записи здесь — контекстные фрагменты и варианты применения. Самостоятельные программы с окружением, отчётом и очисткой находятся по ссылкам; фрагменты не считаются дополнительными выполненными программами.

Методы с переходом в PHP Manual перечислены для полного обзора класса; такой внешний переход не выдаётся за уже написанный отдельный урок по каждому методу. При сетевом отказе, отсутствии прав или неподходящем аргументе последующее действие может не состояться: сообщение о сохранении выводите только после полученного результата и нужной прикладной проверки.

• PHP Manual — Result
• PHP Manual — Result::__construct

Точная первая версия метода не всегда указана Manual; стенд mysql_xdevapi8.0.30 · mysql_xdevapi

function mysql_xdevapi\getSession(string $uri): mysql_xdevapi\Session

Открыть X-сеанс по URI и получить объект для дальнейшей работы.

Результат и отказ

Session при успехе; ошибка соединения выбрасывает Exception, а не возвращает пустую коллекцию.

Страница PHP Manual не всегда указывает точную версию появления отдельного метода и не задаёт исчерпывающую таблицу исключений. Здесь используется mysql_xdevapi8.0.30; ошибка аргумента, сервера или транспорта не подменяется значением успешной пустой выдачи. Версионные изменения, прямо указанные документацией, отмечены выше.

Два применения

Установленный сеанс даёт реальный первый ответ сервера.

$session = mysql_xdevapi\getSession($config['uri']);
$version = $session->getServerVersion();

Исходные данные, полный файл и ожидаемый результат.

Тот же вход открывает путь к заранее подготовленной схеме; в finally Session закрывается.

$session = mysql_xdevapi\getSession($config['uri']);
$schema = $session->getSchema($config['schema']);

Исходные данные, полный файл и ожидаемый результат.

Короткие записи здесь — контекстные фрагменты и варианты применения. Самостоятельные программы с окружением, отчётом и очисткой находятся по ссылкам; фрагменты не считаются дополнительными выполненными программами.

Граница применения

Не путайте X-порт с classic3306 и не переносите единицы таймаута из другого Connector. Фрагменты URI в справочнике не являются готовыми учётными данными. Символы @/: в компонентах имени/пароля кодируйте; полный URI не включайте в логи. Само наличие DLL не доказывает ответ X Plugin.

• PHP Manual — getSession

Точная первая версия метода не всегда указана Manual; стенд mysql_xdevapi8.0.30 · mysql_xdevapi

public function mysql_xdevapi\Session::getServerVersion(): int

Отличить версию сервера от версии PHP-модуля.

Параметров нет: пустые скобки вызывают действие у уже полученного объекта.

Результат и отказ

Целое число версии сервера данного сеанса; например80012 обозначает8.0.12.

Страница PHP Manual не всегда указывает точную версию появления отдельного метода и не задаёт исчерпывающую таблицу исключений. Здесь используется mysql_xdevapi8.0.30; ошибка аргумента, сервера или транспорта не подменяется значением успешной пустой выдачи. Версионные изменения, прямо указанные документацией, отмечены выше.

Два применения

Первый запуск проверяет требуемую ветку MySQL.

$version = $session->getServerVersion();
$modern = $version >= 80000;

Исходные данные, полный файл и ожидаемый результат.

Квитанция сохраняет обе версии, чтобы повторное исследование использовало тот же контекст.

$runtime = ['server'=>$session->getServerVersion(),
    'extension'=>phpversion('mysql_xdevapi')];

Исходные данные, полный файл и ожидаемый результат.

Короткие записи здесь — контекстные фрагменты и варианты применения. Самостоятельные программы с окружением, отчётом и очисткой находятся по ссылкам; фрагменты не считаются дополнительными выполненными программами.

Граница применения

Метод без параметров не устанавливает и не обновляет сервер. Проверка >=80000 подтверждает основную ветку, но отдельные функции всё равно имеют свои требования к серверу/расширению.

• PHP Manual — Session::getServerVersion

Точная первая версия метода не всегда указана Manual; стенд mysql_xdevapi8.0.30 · mysql_xdevapi

public function mysql_xdevapi\Schema::createCollection(string $name, string $validate = ?): mysql_xdevapi\Collection

Создать место для документов и при необходимости задать проверку формы.

Результат и отказ

Collection созданной коллекции. В отличие от getCollection это серверное действие.

Страница PHP Manual не всегда указывает точную версию появления отдельного метода и не задаёт исчерпывающую таблицу исключений. Здесь используется mysql_xdevapi8.0.30; ошибка аргумента, сервера или транспорта не подменяется значением успешной пустой выдачи. Версионные изменения, прямо указанные документацией, отмечены выше.

Два применения

Создание пустого каталога возвращает объект, через который ожидаем count0.

$collection = $schema->createCollection($ownName);
$count = $collection->count();

Исходные данные, полный файл и ожидаемый результат.

Следующий шаг использует созданную коллекцию для первой карточки; JSON validation позволяет впоследствии ограничить форму принимаемых данных.

$collection = $schema->createCollection($ownName);
$receipt = $collection->add($document)->execute();

Исходные данные, полный файл и ожидаемый результат.

Короткие записи здесь — контекстные фрагменты и варианты применения. Самостоятельные программы с окружением, отчётом и очисткой находятся по ссылкам; фрагменты не считаются дополнительными выполненными программами.

Граница применения

Нельзя считать любой объект Collection доказательством успешного создания. Имя, которое уже занято, не следует освобождать удалением чужих данных. В лаборатории создаются только новые случайные имена, успешно созданные имена регистрируются для cleanup.

• PHP Manual — Schema::createCollection

Точная первая версия метода не всегда указана Manual; стенд mysql_xdevapi8.0.30 · mysql_xdevapi

public function mysql_xdevapi\Schema::getCollection(string $name): mysql_xdevapi\Collection

Получить адресный объект доступа без создания коллекции.

Результат и отказ

Collection для выбранного имени.

Страница PHP Manual не всегда указывает точную версию появления отдельного метода и не задаёт исчерпывающую таблицу исключений. Здесь используется mysql_xdevapi8.0.30; ошибка аргумента, сервера или транспорта не подменяется значением успешной пустой выдачи. Версионные изменения, прямо указанные документацией, отмечены выше.

Два применения

Можно получить адрес ещё не созданной коллекции и отдельно увидеть false.

$handle = $schema->getCollection($ownName);
$before = $handle->existsInDatabase();

Исходные данные, полный файл и ожидаемый результат.

У уже существующего каталога handle используется для открытия конкретной карточки.

$catalog = $schema->getCollection($ownName);
$lamp = $catalog->getOne('LAMP-1');

Исходные данные, полный файл и ожидаемый результат.

Короткие записи здесь — контекстные фрагменты и варианты применения. Самостоятельные программы с окружением, отчётом и очисткой находятся по ссылкам; фрагменты не считаются дополнительными выполненными программами.

Граница применения

getCollection не является ни выборкой документов, ни проверкой прав на все последующие действия. Существование могло измениться между отдельными командами.

• PHP Manual — Schema::getCollection

Точная первая версия метода не всегда указана Manual; стенд mysql_xdevapi8.0.30 · mysql_xdevapi

public function mysql_xdevapi\Collection::existsInDatabase(): bool

Отличить существующую коллекцию от одного лишь PHP-объекта.

Параметров нет: пустые скобки вызывают действие у уже полученного объекта.

Результат и отказ

true, если объект указывает на коллекцию в базе, иначе false.

Страница PHP Manual не всегда указывает точную версию появления отдельного метода и не задаёт исчерпывающую таблицу исключений. Здесь используется mysql_xdevapi8.0.30; ошибка аргумента, сервера или транспорта не подменяется значением успешной пустой выдачи. Версионные изменения, прямо указанные документацией, отмечены выше.

Два применения

Тот же handle показывает переход false -> true.

$before = $handle->existsInDatabase();
$created = $schema->createCollection($ownName);
$after = $handle->existsInDatabase();

Исходные данные, полный файл и ожидаемый результат.

В cleanup проверяется обратный переход после удаления только собственной коллекции.

$schema->dropCollection($ownName);
$gone = !$collection->existsInDatabase();

Исходные данные, полный файл и ожидаемый результат.

Короткие записи здесь — контекстные фрагменты и варианты применения. Самостоятельные программы с окружением, отчётом и очисткой находятся по ссылкам; фрагменты не считаются дополнительными выполненными программами.

Граница применения

Проверка существования не сообщает число документов и не превращается в блокировку от удаления. Пустая коллекция существует; это проверяется отдельно от count.

• PHP Manual — Collection::existsInDatabase

Точная первая версия метода не всегда указана Manual; стенд mysql_xdevapi8.0.30 · mysql_xdevapi

public function mysql_xdevapi\Collection::add(mixed $document): mysql_xdevapi\CollectionAdd

Подготовить вставку массива или JSON-документа, сохранив границу отправки.

Результат и отказ

CollectionAdd; его execute возвращает Result с количеством, предупреждениями и generated IDs.

Страница PHP Manual не всегда указывает точную версию появления отдельного метода и не задаёт исчерпывающую таблицу исключений. Здесь используется mysql_xdevapi8.0.30; ошибка аргумента, сервера или транспорта не подменяется значением успешной пустой выдачи. Версионные изменения, прямо указанные документацией, отмечены выше.

Два применения

Одна адресуемая карточка с числом без кавычек.

$operation = $collection->add(['_id'=>'LAMP-1','price'=>1200]);
$receipt = $operation->execute();

Исходные данные, полный файл и ожидаемый результат.

Две допустимые формы данных в одной операции без заранее назначенных _id.

$receipt = $collection->add(['sku'=>'LED'], '{"sku":"CABLE"}')->execute();

Исходные данные, полный файл и ожидаемый результат.

Короткие записи здесь — контекстные фрагменты и варианты применения. Самостоятельные программы с окружением, отчётом и очисткой находятся по ссылкам; фрагменты не считаются дополнительными выполненными программами.

Граница применения

Короткая сигнатура с одним mixed не исчерпывает несколько документированных вариантов вызова. add не означает update и не доказывает запись до execute. Не кодируйте готовую JSON-строку повторно и не считайте PHP-объект Collection самим документом.

• PHP Manual — Collection::add

Точная первая версия метода не всегда указана Manual; стенд mysql_xdevapi8.0.30 · mysql_xdevapi

public function mysql_xdevapi\Collection::count(): int

Узнать количество документов в коллекции целиком.

Параметров нет: пустые скобки вызывают действие у уже полученного объекта.

Результат и отказ

Число документов коллекции как int.

Страница PHP Manual не всегда указывает точную версию появления отдельного метода и не задаёт исчерпывающую таблицу исключений. Здесь используется mysql_xdevapi8.0.30; ошибка аргумента, сервера или транспорта не подменяется значением успешной пустой выдачи. Версионные изменения, прямо указанные документацией, отмечены выше.

Два применения

Новая существующая коллекция даёт0 документов.

$empty = $collection->count();

Исходные данные, полный файл и ожидаемый результат.

Всего5 товаров и не более2 документов страницы — разные числа.

$total = $collection->count();
$page = $collection->find()->limit(2)->execute()->fetchAll();

Исходные данные, полный файл и ожидаемый результат.

Короткие записи здесь — контекстные фрагменты и варианты применения. Самостоятельные программы с окружением, отчётом и очисткой находятся по ссылкам; фрагменты не считаются дополнительными выполненными программами.

Граница применения

Не подменяйте этим счётчиком количество совпадений произвольного фильтра. Между отдельными чтениями другой клиент может изменить коллекцию; fixture программы исключает такое вмешательство, но реальное приложение — нет.

• PHP Manual — Collection::count

Точная первая версия метода не всегда указана Manual; стенд mysql_xdevapi8.0.30 · mysql_xdevapi

public function mysql_xdevapi\Collection::getOne(string $id): Document

Открыть конкретный документ по _id либо получить отсутствие.

Результат и отказ

Данные документа как ассоциативный массив; официальный контракт для отсутствующего _id — null. В PECL mysql_xdevapi8.0.30 обнаружено отклонение, описанное ниже.

Страница PHP Manual не всегда указывает точную версию появления отдельного метода и не задаёт исчерпывающую таблицу исключений. Здесь используется mysql_xdevapi8.0.30; ошибка аргумента, сервера или транспорта не подменяется значением успешной пустой выдачи. Версионные изменения, прямо указанные документацией, отмечены выше.

Два применения

Карточка и отсутствие различаются явно; ?? null учитывает проверенное отклонение PECL8.0.30.

$lamp = $collection->getOne('LAMP-1');
$missing = $collection->getOne('NO-SUCH') ?? null;

Исходные данные, полный файл и ожидаемый результат.

Реальный ID квитанции связывается с повторно прочитанным документом.

$doc = $collection->getOne($generatedId);
$matches = $doc !== null && $doc['_id'] === $generatedId;

Исходные данные, полный файл и ожидаемый результат.

Короткие записи здесь — контекстные фрагменты и варианты применения. Самостоятельные программы с окружением, отчётом и очисткой находятся по ссылкам; фрагменты не считаются дополнительными выполненными программами.

Граница применения

Проверяйте null до $doc['name']. Совпадение по обычному полю sku — другая задача для find; getOne адресует именно _id.

• PHP Manual — Collection::getOne

Точная первая версия метода не всегда указана Manual; стенд mysql_xdevapi8.0.30 · mysql_xdevapi

public function mysql_xdevapi\Collection::find(string $search_condition = ?): mysql_xdevapi\CollectionFind

Задать условие выбора и получить настраиваемый запрос.

Результат и отказ

CollectionFind для настройки и дальнейшего execute; это ещё не массив найденных документов.

Страница PHP Manual не всегда указывает точную версию появления отдельного метода и не задаёт исчерпывающую таблицу исключений. Здесь используется mysql_xdevapi8.0.30; ошибка аргумента, сервера или транспорта не подменяется значением успешной пустой выдачи. Версионные изменения, прямо указанные документацией, отмечены выше.

Два применения

Автор задаёт форму двух условий, значения придут отдельно.

$request = $collection->find('category = :category and price <= :ceiling');

Исходные данные, полный файл и ожидаемый результат.

Полный каталог сознательно ограничен страницей, затем выполняется.

$request = $collection->find()->sort('sku ASC')->limit(2);

Исходные данные, полный файл и ожидаемый результат.

Короткие записи здесь — контекстные фрагменты и варианты применения. Самостоятельные программы с окружением, отчётом и очисткой находятся по ссылкам; фрагменты не считаются дополнительными выполненными программами.

Граница применения

find без условия выбирает все документы: перед fetchAll большого каталога добавьте осмысленную границу. Пустая выдача после успешного execute отличается от исключения при неправильном запросе.

• PHP Manual — Collection::find

Точная первая версия метода не всегда указана Manual; стенд mysql_xdevapi8.0.30 · mysql_xdevapi

public function mysql_xdevapi\CollectionAdd::execute(): mysql_xdevapi\Result

Отправить подготовленное добавление на сервер.

Параметров нет: пустые скобки вызывают действие у уже полученного объекта.

Результат и отказ

Result, по которому проверяют состояние операции, в том числе количество затронутых документов.

Страница PHP Manual не всегда указывает точную версию появления отдельного метода и не задаёт исчерпывающую таблицу исключений. Здесь используется mysql_xdevapi8.0.30; ошибка аргумента, сервера или транспорта не подменяется значением успешной пустой выдачи. Версионные изменения, прямо указанные документацией, отмечены выше.

Два применения

Программа отдельно наблюдает состояние до отправки и после неё.

$operation = $collection->add($document);
$before = $collection->count();
$receipt = $operation->execute();

Исходные данные, полный файл и ожидаемый результат.

Исполнение нескольких документов возвращает общую квитанцию и реальные ключи.

$receipt = $collection->add($first, $second)->execute();
$ids = $receipt->getGeneratedIds();

Исходные данные, полный файл и ожидаемый результат.

Короткие записи здесь — контекстные фрагменты и варианты применения. Самостоятельные программы с окружением, отчётом и очисткой находятся по ссылкам; фрагменты не считаются дополнительными выполненными программами.

Граница применения

Серверный отказ, например конфликт _id, нельзя объявлять успешным нулём. Повтор добавления после неопределённого сетевого исхода требует политики повторов; этот урок не обещает exactly-once.

• PHP Manual — CollectionAdd::execute

Точная первая версия метода не всегда указана Manual; стенд mysql_xdevapi8.0.30 · mysql_xdevapi

public function mysql_xdevapi\CollectionFind::bind(array $placeholder_values): mysql_xdevapi\CollectionFind

Передать пользовательские значения отдельно от выражения поиска.

Результат и отказ

CollectionFind; последующий execute этой операции поиска возвращает DocResult.

Страница PHP Manual не всегда указывает точную версию появления отдельного метода и не задаёт исчерпывающую таблицу исключений. Здесь используется mysql_xdevapi8.0.30; ошибка аргумента, сервера или транспорта не подменяется значением успешной пустой выдачи. Версионные изменения, прямо указанные документацией, отмечены выше.

Два применения

Апостроф остаётся частью категории, число сохраняет числовой смысл.

$request->bind(['category'=>"Мастерская O'Neal", 'ceiling'=>1000]);

Исходные данные, полный файл и ожидаемый результат.

Тот же механизм может адресовать серверный ID; getOne представляет короткую форму этой задачи.

$doc = $collection->find('_id = :id')->bind(['id'=>$generatedId])->execute()->fetchOne();

Исходные данные, полный файл и ожидаемый результат.

Короткие записи здесь — контекстные фрагменты и варианты применения. Самостоятельные программы с окружением, отчётом и очисткой находятся по ссылкам; фрагменты не считаются дополнительными выполненными программами.

Граница применения

Нельзя связать имя поля либо ASC/DESC как обычное значение. На странице bind возврат от execute обобщён до Result; точный контракт CollectionFind::execute — DocResult.

• PHP Manual — CollectionFind::bind

Точная первая версия метода не всегда указана Manual; стенд mysql_xdevapi8.0.30 · mysql_xdevapi

public function mysql_xdevapi\CollectionFind::fields(string $projection): mysql_xdevapi\CollectionFind

Оставить в ответе поля, нужные экрану.

Результат и отказ

CollectionFind для дальнейших настроек/исполнения.

Страница PHP Manual не всегда указывает точную версию появления отдельного метода и не задаёт исчерпывающую таблицу исключений. Здесь используется mysql_xdevapi8.0.30; ошибка аргумента, сервера или транспорта не подменяется значением успешной пустой выдачи. Версионные изменения, прямо указанные документацией, отмечены выше.

Два применения

Карточка не получает внутреннее поле internal.

$request->fields(['sku','name','price']);

Исходные данные, полный файл и ожидаемый результат.

Контекстное развитие страницы: вместо полных карточек только список артикулов; исходный runnable-урок и данные указаны по ссылке.

$skus = $collection->find()->fields('sku')->sort('sku ASC')->limit(2)->execute()->fetchAll();

Исходные данные, полный файл и ожидаемый результат.

Короткие записи здесь — контекстные фрагменты и варианты применения. Самостоятельные программы с окружением, отчётом и очисткой находятся по ссылкам; фрагменты не считаются дополнительными выполненными программами.

Граница применения

Проекция не удаляет поля из сохранённого документа и не является изменением его схемы. Не передавайте произвольную строку посетителя как описание полей; сформируйте разрешённую проекцию сами.

• PHP Manual — CollectionFind::fields

Точная первая версия метода не всегда указана Manual; стенд mysql_xdevapi8.0.30 · mysql_xdevapi

public function mysql_xdevapi\CollectionFind::sort(string $sort_expr): mysql_xdevapi\CollectionFind

Дать выдаче определённый порядок.

Результат и отказ

CollectionFind, к которому добавляют настройки либо вызывают execute.

Страница PHP Manual не всегда указывает точную версию появления отдельного метода и не задаёт исчерпывающую таблицу исключений. Здесь используется mysql_xdevapi8.0.30; ошибка аргумента, сервера или транспорта не подменяется значением успешной пустой выдачи. Версионные изменения, прямо указанные документацией, отмечены выше.

Два применения

Каталог сначала показывает доступные по цене товары; sku разрешает равные цены.

$request->sort('price ASC','sku ASC');

Исходные данные, полный файл и ожидаемый результат.

Тот же порядок требуется на каждой странице, иначе offset нельзя осмысленно сравнивать.

$first = $collection->find()->sort('price ASC','sku ASC')->limit(2)->execute();

Исходные данные, полный файл и ожидаемый результат.

Короткие записи здесь — контекстные фрагменты и варианты применения. Самостоятельные программы с окружением, отчётом и очисткой находятся по ссылкам; фрагменты не считаются дополнительными выполненными программами.

Граница применения

При равенстве основного поля нужен дополнительный устойчивый критерий. Порядок полей JSON и порядок документов выдачи — разные вещи. Пользователь выбирает известный вариант сортировки, а не передаёт произвольное выражение.

• PHP Manual — CollectionFind::sort

Точная первая версия метода не всегда указана Manual; стенд mysql_xdevapi8.0.30 · mysql_xdevapi

public function mysql_xdevapi\CollectionFind::limit(int $rows): mysql_xdevapi\CollectionFind

Ограничить размер выдачи для страницы каталога.

Результат и отказ

CollectionFind; после execute — DocResult.

Страница PHP Manual не всегда указывает точную версию появления отдельного метода и не задаёт исчерпывающую таблицу исключений. Здесь используется mysql_xdevapi8.0.30; ошибка аргумента, сервера или транспорта не подменяется значением успешной пустой выдачи. Версионные изменения, прямо указанные документацией, отмечены выше.

Два применения

Первая страница берёт максимум два товара.

$result = $collection->find()->sort('sku ASC')->limit(2)->execute();

Исходные данные, полный файл и ожидаемый результат.

Если подходящий товар один, limit2 не создаст второй документ.

$short = $collection->find('price <= :ceiling')->bind(['ceiling'=>500])->limit(2)->execute();

Исходные данные, полный файл и ожидаемый результат.

Короткие записи здесь — контекстные фрагменты и варианты применения. Самостоятельные программы с окружением, отчётом и очисткой находятся по ссылкам; фрагменты не считаются дополнительными выполненными программами.

Граница применения

Проверяйте размер страницы до вызова: отрицательный/чрезмерный пользовательский ввод не является полезной настройкой. Для страницы нужен также определённый sort; для последующей страницы — offset.

• PHP Manual — CollectionFind::limit

Точная первая версия метода не всегда указана Manual; стенд mysql_xdevapi8.0.30 · mysql_xdevapi

public function mysql_xdevapi\CollectionFind::offset(int $position): mysql_xdevapi\CollectionFind

Пропустить уже показанную часть стабильной выдачи.

Результат и отказ

CollectionFind; смещение больше размера результата даёт пустую выдачу.

Страница PHP Manual не всегда указывает точную версию появления отдельного метода и не задаёт исчерпывающую таблицу исключений. Здесь используется mysql_xdevapi8.0.30; ошибка аргумента, сервера или транспорта не подменяется значением успешной пустой выдачи. Версионные изменения, прямо указанные документацией, отмечены выше.

Два применения

Пропуск A,B позволяет получить C,D.

$second = $collection->find()->sort('sku ASC')->limit(2)->offset(2)->execute()->fetchAll();

Исходные данные, полный файл и ожидаемый результат.

За концом каталога ожидается [], а не ошибка из-за отсутствия документов.

$empty = $collection->find()->sort('sku ASC')->limit(2)->offset(99)->execute()->fetchAll();

Исходные данные, полный файл и ожидаемый результат.

Короткие записи здесь — контекстные фрагменты и варианты применения. Самостоятельные программы с окружением, отчётом и очисткой находятся по ссылкам; фрагменты не считаются дополнительными выполненными программами.

Граница применения

Две независимые выдачи с offset не гарантируют отсутствие повторов при конкурентных вставках/удалениях. Большое смещение не обещает дешёвую операцию; урок использует неизменяемые пять документов.

• PHP Manual — CollectionFind::offset

Точная первая версия метода не всегда указана Manual; стенд mysql_xdevapi8.0.30 · mysql_xdevapi

public function mysql_xdevapi\CollectionFind::execute(): mysql_xdevapi\DocResult

Исполнить настроенный поиск и получить объект чтения.

Параметров нет: пустые скобки вызывают действие у уже полученного объекта.

Результат и отказ

DocResult для извлечения документов и сведений о состоянии/предупреждениях операции.

Страница PHP Manual не всегда указывает точную версию появления отдельного метода и не задаёт исчерпывающую таблицу исключений. Здесь используется mysql_xdevapi8.0.30; ошибка аргумента, сервера или транспорта не подменяется значением успешной пустой выдачи. Версионные изменения, прямо указанные документацией, отмечены выше.

Два применения

Экран получает набор карточек после всех настроек запроса.

$result = $request->execute();
$documents = $result->fetchAll();

Исходные данные, полный файл и ожидаемый результат.

Тот же объект результата можно читать по одному документу.

$result = $collection->find()->sort('sku ASC')->limit(2)->execute();
$first = $result->fetchOne();

Исходные данные, полный файл и ожидаемый результат.

Короткие записи здесь — контекстные фрагменты и варианты применения. Самостоятельные программы с окружением, отчётом и очисткой находятся по ссылкам; фрагменты не считаются дополнительными выполненными программами.

Граница применения

CollectionFind не является массивом результата. Успешное исполнение с нулём совпадений тоже даёт DocResult, из которого fetchAll возвращает [] либо fetchOne — null.

• PHP Manual — CollectionFind::execute

Точная первая версия метода не всегда указана Manual; стенд mysql_xdevapi8.0.30 · mysql_xdevapi

public function mysql_xdevapi\DocResult::fetchOne(): array

Получить очередной документ и явно распознать конец.

Параметров нет: пустые скобки вызывают действие у уже полученного объекта.

Результат и отказ

Ассоциативный массив документа либо null, когда результатов больше нет.

Страница PHP Manual не всегда указывает точную версию появления отдельного метода и не задаёт исчерпывающую таблицу исключений. Здесь используется mysql_xdevapi8.0.30; ошибка аргумента, сервера или транспорта не подменяется значением успешной пустой выдачи. Версионные изменения, прямо указанные документацией, отмечены выше.

Два применения

Цикл читает A и B, затем завершает страницу.

while (($doc = $result->fetchOne()) !== null) {
    $page[] = $doc;
}

Исходные данные, полный файл и ожидаемый результат.

При отсутствующем ключе первый fetchOne уже вернёт null; getOne — короткая форма этой задачи.

$doc = $collection->find('_id = :id')->bind(['id'=>'NO-SUCH'])->execute()->fetchOne();

Исходные данные, полный файл и ожидаемый результат.

Короткие записи здесь — контекстные фрагменты и варианты применения. Самостоятельные программы с окружением, отчётом и очисткой находятся по ссылкам; фрагменты не считаются дополнительными выполненными программами.

Граница применения

Каждое чтение продвигает результат; повторный вызов не является повтором того же документа. Не путайте отсутствие результата с пустым массивом полей и не предполагайте перемотку уже прочитанного DocResult.

• PHP Manual — DocResult::fetchOne

Точная первая версия метода не всегда указана Manual; стенд mysql_xdevapi8.0.30 · mysql_xdevapi

public function mysql_xdevapi\DocResult::fetchAll(): array

Получить выбранные документы в виде списка для экрана.

Параметров нет: пустые скобки вызывают действие у уже полученного объекта.

Результат и отказ

Числовой массив документов, каждый документ — ассоциативный массив; если строк нет — пустой массив.

Страница PHP Manual не всегда указывает точную версию появления отдельного метода и не задаёт исчерпывающую таблицу исключений. Здесь используется mysql_xdevapi8.0.30; ошибка аргумента, сервера или транспорта не подменяется значением успешной пустой выдачи. Версионные изменения, прямо указанные документацией, отмечены выше.

Два применения

Из небольшого каталога получается список артикулов.

$documents = $request->execute()->fetchAll();
$skus = array_column($documents, 'sku');

Исходные данные, полный файл и ожидаемый результат.

Пустой список — обычный результат страницы за концом каталога.

$empty = $collection->find()->limit(2)->offset(99)->execute()->fetchAll();

Исходные данные, полный файл и ожидаемый результат.

Короткие записи здесь — контекстные фрагменты и варианты применения. Самостоятельные программы с окружением, отчётом и очисткой находятся по ссылкам; фрагменты не считаются дополнительными выполненными программами.

Граница применения

Полный список занимает память PHP; разумно ограничить выборку до чтения. Для альтернативного способа обхода создавайте свежий DocResult; урок не предполагает повторное чтение уже потреблённого результата.

• PHP Manual — DocResult::fetchAll

Точная первая версия метода не всегда указана Manual; стенд mysql_xdevapi8.0.30 · mysql_xdevapi

public function mysql_xdevapi\Result::getGeneratedIds(): array

Получить настоящие серверные ключи только этой операции.

Параметров нет: пустые скобки вызывают действие у уже полученного объекта.

Результат и отказ

Массив созданных сервером _id последней операции, связанной с этим Result; при их отсутствии пустой массив.

Страница PHP Manual не всегда указывает точную версию появления отдельного метода и не задаёт исчерпывающую таблицу исключений. Здесь используется mysql_xdevapi8.0.30; ошибка аргумента, сервера или транспорта не подменяется значением успешной пустой выдачи. Версионные изменения, прямо указанные документацией, отмечены выше.

Два применения

Каждый возвращённый ключ связан с фактически сохранённой карточкой.

$ids = $receipt->getGeneratedIds();
foreach ($ids as $id) {$readBack[] = $collection->getOne($id);}

Исходные данные, полный файл и ожидаемый результат.

Вторая ситуация: явный ключ, успешная запись, но generatedIds пуст.

$receipt = $collection->add(['_id'=>'MANUAL-1','sku'=>'STAND'])->execute();
$ids = $receipt->getGeneratedIds();

Исходные данные, полный файл и ожидаемый результат.

Короткие записи здесь — контекстные фрагменты и варианты применения. Самостоятельные программы с окружением, отчётом и очисткой находятся по ссылкам; фрагменты не считаются дополнительными выполненными программами.

Граница применения

Пустой массив не означает отказ записи: документ с явным _id может успешно добавиться без server-generated IDs. Сохраняйте фактические значения, не используйте ожидаемый пример ID как найденный результат.

• PHP Manual — Result::getGeneratedIds

Точная первая версия метода не всегда указана Manual; стенд mysql_xdevapi8.0.30 · mysql_xdevapi

public function mysql_xdevapi\Result::getAffectedItemsCount(): int

Прочитать количество затронутых элементов операции.

Параметров нет: пустые скобки вызывают действие у уже полученного объекта.

Результат и отказ

Целое число затронутых строк/элементов предыдущей операции, которую представляет Result.

Страница PHP Manual не всегда указывает точную версию появления отдельного метода и не задаёт исчерпывающую таблицу исключений. Здесь используется mysql_xdevapi8.0.30; ошибка аргумента, сервера или транспорта не подменяется значением успешной пустой выдачи. Версионные изменения, прямо указанные документацией, отмечены выше.

Два применения

Реальный Result первой лампы сообщает1.

$added = $receipt->getAffectedItemsCount();

Исходные данные, полный файл и ожидаемый результат.

Первая операция вставила2; после отдельного третьего товара общий count равен3.

$added = $receipt->getAffectedItemsCount();
$total = $collection->count();

Исходные данные, полный файл и ожидаемый результат.

Короткие записи здесь — контекстные фрагменты и варианты применения. Самостоятельные программы с окружением, отчётом и очисткой находятся по ссылкам; фрагменты не считаются дополнительными выполненными программами.

Граница применения

Счётчик не содержит сами документы и не означает текущее количество всей коллекции. Не печатайте количество входных массивов как будто это серверная квитанция; вызывайте метод Result.

• PHP Manual — Result::getAffectedItemsCount