diff --git a/appendices/migration74/other-changes.xml b/appendices/migration74/other-changes.xml deleted file mode 100644 index e9161e760..000000000 --- a/appendices/migration74/other-changes.xml +++ /dev/null @@ -1,561 +0,0 @@ - - - - - Other Changes - - - Performance Improvements - - - PHP Core - - A specialized VM opcode for the array_key_exists - function has been added, which improves performance of this function - if it can be statically resolved. In namespaced code, this may require - writing \array_key_exists() or explicitly importing - the function. - - - - - Regular Expressions (Perl-Compatible) - - When preg_match in UTF-8 mode ("u" modifier) - is repeatedly called on the same string (but possibly different offsets), - it will only be checked for UTF-8 validity once. - - - - - - Changes to INI File Handling - - zend.exception_ignore_args is a new INI directive - for including or excluding arguments from stack traces generated - from exceptions. - - - opcache.preload_user is a new INI directive - for specifying the user account under which preloading - code is execute if it would otherwise be run as root (which is not - allowed for security reasons). - - - - - Migration to pkg-config - - A number of extensions have been migrated to exclusively use pkg-config for the - detection of library dependencies. Generally, this means that instead of using - or similar only - is used. Custom library paths can be - specified either by adding additional directories to PKG_CONFIG_PATH - or by explicitly specifying compilation options through FOO_CFLAGS - and FOO_LIBS. - - - The following extensions and SAPIs are affected: - - - - - CURL: - - - - no longer accepts a directory. - - - - - - - Enchant: - - - - no longer accepts a directory. - - - - - - - FPM: - - - - now uses only pkg-config - for libsystem checks. The libsystemd minimum required version is 209. - - - - - - - GD: - - - - becomes - - (whether to enable the extension at all) and - - (to opt into using an external libgd, rather than the bundled one). - - - - - has been removed. libpng is required. - - - - - has been removed. zlib is required. - - - - - - becomes - - - - - becomes - - - - - - becomes - - - - - - becomes - - - - - - - - IMAP: - - - - no longer accepts a directory. - - - - - - - Intl: - - - - has been removed. - If is passed, - then libicu is always required. - - - - - - - LDAP: - - - - no longer accepts a directory. - - - - - - - Libxml: - - - - has been removed. - - - - - becomes - . - - - - - has been renamed to - and no longer accepts a directory. - - - - - - - Litespeed: - - - - becomes - . - - - - - - - Mbstring: - - - - has been removed. - Unless - has been passed, libonig is required. - - - - - - - ODBC: - - - - no longer accepts a directory. - - - - - without a directory now uses - pkg-config (preferred). Directory is still accepted for old versions without libodbc.pc. - - - - - - - OpenSSL: - - - - no longer accepts a directory. - - - - - - - PCRE: - - - - has been removed. - Instead - is provided to opt into using an external PCRE library, rather - than the bundled one. - - - - - - - PDO_SQLite: - - - - no longer accepts a directory. - - - - - - - Readline: - - - - no longer accepts a directory. - - - - - - - Sodium: - - - - no longer accepts a directory. - - - - - - - SQLite3: - - - - no longer accepts a directory. - - - - - - - XSL: - - - - no longer accepts a directory. - - - - - - - Zip: - - - - has been removed. - - - - - becomes - . - - - - - - - - - - CSV escaping - - fputcsv, - fgetcsv, - SplFileObject::fputcsv, - SplFileObject::fgetcsv, and - SplFileObject::setCsvControl - now accept an empty string as $escape argument, - which disables the proprietary PHP escaping mechanism. - - - The behavior of str_getcsv has been - adjusted accordingly (formerly, an empty string was identical - to using the default). - - - SplFileObject::getCsvControl now may also - return an empty string for the third array element, accordingly. - - - - - Data Filtering - - The filter extension no longer exposes - for Unix builds and can now reliably - be built as shared when using ./configure - - - - - GD - - The behavior of imagecropauto in the bundled - libgd has been synced with that of system libgd: - - - - - IMG_CROP_DEFAULT is no longer falling - back to IMG_CROP_SIDES - - - - - Threshold-cropping now uses the algorithm of system libgd - - - - - The default $mode parameter of - imagecropauto has been changed to - IMG_CROP_DEFAULT; passing -1 - is now deprecated. - - - imagescale now supports aspect ratio preserving - scaling to a fixed height by passing -1 - as $new_width. - - - - - HASH Message Digest Framework - - The hash extension cannot be disabled - anymore and is always an integral part of any PHP build, similar to - the date extension. - - - - - Intl - - The intl extension - now requires at least ICU 50.1. - - - ResourceBundle now implements - Countable. - - - - - Lightweight Directory Access Protocol - - Support for nsldap and umich_ldap has been removed. - - - - - Libxml - - All libxml-based extensions now require libxml 2.7.6 or newer. - - - - - Multibyte String - - The oniguruma library is no longer bundled with PHP, instead libonig needs - to be available on the system. Alternatively - can be used to disable - the mbregex component. - - - - - OPcache - - The and - configure options - have been removed in favor of the - opcache.file_cache INI directive. - - - - - Password Hashing - - The password_hash and functions - now accept nullable &string; and &integer; for $algo argument. - - - - - PEAR - - Installation of PEAR (including PECL) is no longer enabled by default. It - can be explicitly enabled using . - This option is deprecated and may be removed in the future. - - - - - Reflection - - The numeric values of the modifier constants - (IS_ABSTRACT, - IS_DEPRECATED, - IS_EXPLICIT_ABSTRACT, - IS_FINAL, - IS_IMPLICIT_ABSTRACT, - IS_PRIVATE, - IS_PROTECTED, - IS_PUBLIC, and - IS_STATIC) on the - ReflectionClass, - ReflectionFunction, - ReflectionMethod, - ReflectionObject, and - ReflectionProperty - classes have changed. - - - - - SimpleXML - - SimpleXMLElement now implements - Countable. - - - - - SQLite3 - - The bundled libsqlite has been removed. To build the - SQLite3 extension a - system libsqlite3 ≥ 3.7.4 is now required. To build the - PDO_SQLite extension - a system libsqlite3 ≥ 3.5.0 is now required. - - - Serialization and unserialization of SQLite3, - SQLite3Stmt and SQLite3Result - is now explicitly forbidden. Formerly, serialization of instances of - these classes was possible, but unserialization yielded unusable objects. - - - The @param notation can now also be used to - denote SQL query parameters. - - - - - Zip - - The bundled libzip library has been removed. - A system libzip >= 0.11 is now necessary to build the - zip extension. - - - - - - diff --git a/appendices/migration81/constants.xml b/appendices/migration81/constants.xml deleted file mode 100644 index ce5ced091..000000000 --- a/appendices/migration81/constants.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - New Global Constants - - - MySQLi - - - - MYSQLI_REFRESH_REPLICA - - This constant has been added as a replacement for - MYSQLI_REFRESH_SLAVE, - in line with an upstream change in MySQL. - The old constant is still available for backwards-compatibility reasons, - but may be deprecated/removed in the future. - - - - - - - Sockets - - - The following socket options are now defined if they are supported: - - - - SO_ACCEPTFILTER - - - SO_DONTTRUNC - - - SO_WANTMORE - - - SO_MARK - - - TCP_DEFER_ACCEPT - - - - - - diff --git a/appendices/migration81/deprecated.xml b/appendices/migration81/deprecated.xml deleted file mode 100644 index 077433906..000000000 --- a/appendices/migration81/deprecated.xml +++ /dev/null @@ -1,360 +0,0 @@ - - - Características obsoletas - - - Núcleo PHP - - - - Implementing <interfacename>Serializable</interfacename> without - <function>__serialize</function> and <function>__unserialize</function> - - - - Either only the new methods should be implemented, if no support for - PHP prior to version 7.4 is provided, or both should be implemented. - - - - - Passing &null; to non-nullable parameters of built-in functions - - - Scalar types for built-in functions are nullable by default, - this behaviour is deprecated to align with the behaviour of user-defined - functions, where scalar types need to be marked as nullable explicitly. - - - - -]]> - - - - - - - Implicit incompatible &float; to &integer; conversions - - - The implicit conversion of &float; to &integer; which - leads to a loss in precision is now deprecated. - This affects &array; keys, &integer; type declarations in coercive mode, - and operators working on &integer;s. - - - - -]]> - - - - - - - Calling a <modifier>static</modifier> element on a trait - - - Calling a static method, or accessing a - static property directly on a trait is deprecated. - Static methods and properties should only be accessed on a class using the trait. - - - - - Returning a non-&array; from <function>__sleep</function> - - - Returning a value which is not an &array; from - __sleep() now generates a diagnostic. - - - - - Returning by reference from a <type>void</type> function - - - - - -]]> - - - Such a function is contradictory, and already emits the following - E_NOTICE when called: - Only variable references should be returned by reference. - - - - - Autovivification from &false; - - Autovivification is the process of creating a new &array; when - appending to a value. - Autovivification is prohibited from scalar values, &false; however - was an exception. This is now deprecated. - - - - -]]> - - - - - - Autovivification from &null; and undefined values is still allowed: - - - -]]> - - - - - - - - - - ctype - - - Verifying non-string arguments - - - Passing a non-string argument is deprecated. - In the future, the argument will be interpreted as a string instead - of an ASCII codepoint. - Depending on the intended behavior, the argument should either be - casted to &string; or an explicit call to - chr should be made. - All ctype_*() functions are affected. - - - - - - Date - - - The date_sunrise and date_sunset - have been deprecated in favor of date_sun_info. - - - - The strptime has been deprecated. - Use date_parse_from_format instead (for locale-independent parsing), - or IntlDateFormatter::parse (for locale-dependent parsing). - - - - - Filter - - - The FILTER_SANITIZE_STRING and - FILTER_SANITIZE_STRIPPED filters are deprecated. - - - The filter.default - INI directive is deprecated. - - - - - - GD - - - The num_points of imageopenpolygon - and imagefilledpolygon has been deprecated. - - - - - Hash - - - The mhash, - mhash_keygen_s2k, - mhash_count, - mhash_get_block_size, - and mhash_get_hash_name have been deprecated. - Use the hash_*() functions instead. - - - - - IMAP - - - The NIL constant has been deprecated. - Use 0 instead. - - - - - Intl - - - Calling IntlCalendar::roll with a - &boolean; argument is deprecated. - Use 1 and -1 instead of - &true; and &false; respectively. - - - - - Multibyte String - - - Calling mb_check_encoding without any arguments - is deprecated. - - - - - MySQLi - - - The mysqli_driver::$driver_version property - has been deprecated. - It was meaningless and outdated, use PHP_VERSION_ID - instead. - - - - Calling mysqli::get_client_info or - mysqli_get_client_info with the - mysqli argument has been deprecated. - Call mysqli_get_client_info without any arguments - to obtain the version information of the client library. - - - - The mysqli::init method has been deprecated. - Replace calls to parent::init with - parent::__construct. - - - - - OCI8 - - - The oci8.old_oci_close_semantics - INI directive is deprecated. - - - - - ODBC - - - odbc_result_all has been deprecated. - - - - - PDO - - - The PDO::FETCH_SERIALIZE fetch mode has been deprecated. - - - - - PgSQL - - - Not passing the connection argument to all pgsql_*() - functions has been deprecated. - - - - - SOAP - - - The ssl_method option of - SoapClient::__construct has been deprecated - in favor of SSL stream context options. - - - - - - Standard - - - Calling key, current, - next, prev, - reset, or end - on &object;s is deprecated. - Either use get_mangled_object_vars on the - object first, or use ArrayIterator. - - - - The auto_detect_line_endings - INI directive is deprecated. - If necessary, handle "\r" line breaks manually instead. - - - - The FILE_BINARY and - FILE_TEXT constants have been deprecated. - They never had any effect. - - - - - diff --git a/appendices/migration81/new-classes.xml b/appendices/migration81/new-classes.xml deleted file mode 100644 index c5dc7c0ff..000000000 --- a/appendices/migration81/new-classes.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - New Classes and Interfaces - - - Intl - - - - - IntlDatePatternGenerator - - - - - - - diff --git a/appendices/migration81/new-features.xml b/appendices/migration81/new-features.xml deleted file mode 100644 index 0766243bf..000000000 --- a/appendices/migration81/new-features.xml +++ /dev/null @@ -1,485 +0,0 @@ - - - - - - - New Features - - - PHP Core - - - Integer Octal Literal Prefix - - - Octal integers can now use an explicit - 0o/0O - prefix in integer literals, - similarly to binary and hexadecimal integer literals. - - - -]]> - - - - - - - - Array Unpacking with String Keys - - - Added support for array unpacking with strings keys. - - - - - - - Named Argument After Argument Unpacking - - - It is now possible to specify named arguments after an argument unpack. - - e.g. - foo(...$args, named: $arg). - - - - - full-path Key for File Uploads - - - File uploads now provide an additional full_path key, - which contains the full path (rather than just the basename) of the uploaded file. - This is intended for use in conjunction with "upload webkitdirectory". - - - - - - Enumerations - - - Support for Enumerations has been added. - - - - - - Fibers - - - Support for Fibers has been added. - - - - - - First Class Callable Syntax - - - Closures for callables can now be created using the syntax myFunc(...), - which is identical to Closure::fromCallable('myFunc'). - - - - - The ... is part of the syntax, and not an omission. - - - - - - Intersection Types - - - Support for intersection types has been added. - - - - - - Intersection types cannot be used together with - - union types - - - - - - Never type - - - A new return only type &never; has been added. - This indicates that a function either exit, - throws an exception, or doesn't terminate. - - - - - - &new; in Initializers - - - It is now possible to use new ClassName() expressions as the - default value of a parameter, static variable, global constant initializers, - and as attribute arguments. - Objects can also be passed to define now. - - - - - - - Readonly properties - - - Support for readonly has been added. - - - - - - Final class constants - - - Added support for the final modifier for class constants. - - - - - - - - CURL - - - Added the CURLOPT_DOH_URL option. - - - - Added options for blob certificate when libcurl >= 7.71.0: - - - - CURLOPT_ISSUERCERT_BLOB - - - CURLOPT_PROXY_ISSUERCERT - - - CURLOPT_PROXY_ISSUERCERT_BLOB - - - CURLOPT_PROXY_SSLCERT_BLOB - - - CURLOPT_PROXY_SSLKEY_BLOB - - - CURLOPT_SSLCERT_BLOB - - - CURLOPT_SSLKEY_BLOB - - - - - Added CURLStringFile, which can be used to post - a file from a &string; rather than a file: - - - $file]); -?> -]]> - - - - - - - FPM - - - Added openmetrics status format. It can be used by Prometheus to fetch FPM - metrics. - - - Added new pool option for the dynamic process manager called - pm.max_spawn_rate. It allows to start a number of children - at a faster rate when dynamic pm is selected. - The default value is 32 which was the previous - hard coded value. - - - - - GD - - - Avix support is now available through - imagecreatefromavif and - imageavif, - if libgd has been built with Avix support. - - - - - Hash - - - The following functions hash, - hash_file, and hash_init - now support an additional optional options - argument, which can be used to pass algorithm specific data. - - - - MurmurHash3 - - - Added support for MurmurHash3 with streaming - support. The following variants are implemented: - - - - murmur3a, 32-bit hash - - - murmur3c, 128-bit hash for x86 - - - murmur3f, 128-bit hash for x64 - - - - - The initial hash state can be passed through the seed - key in the options array, for example: - - - - 42]); -echo $h, "\n"; -?> -]]> - - - - A valid seed value is within the range from 0 - to the platform defined UINT_MAX, usually - 4294967295. - - - - - xxHash - - - Added support for xxHash. - The following variants are implemented: - - - - xxh32, 32-bit hash - - - xxh64, 64-bit hash - - - xxh3, 64-bit hash - - - xxh128, 128-bit hash - - - - - The initial hash state can be passed through the seed - key in the options array, for example: - - - - 42]); -echo $h, "\n"; -?> -]]> - - - - Secret usage is supported through passing the secret - key in the options array, too: - - - - "at least 136 bytes long secret here"]); -echo $h, "\n"; -?> -]]> - - - - The quality of the custom secret is crucial for the quality of the resulting hash. - It is highly recommended for the secret to use the best possible entropy. - - - - - - MySQLi - - - New INI directive <literal>mysqli.local_infile_directory</literal> - - - The mysqli.local_infile_directory - INI directive has been added, which can be used to specify a directory from - which files are allowed to be loaded. It is only meaningful if - mysqli.allow_local_infile - is not enabled, as all directories are allowed in that case. - - - - - Binding parameters in execute - - - It is now possible to bind parameters by passing them as an array to - mysqli_stmt::execute. All values will be bound as - strings. Only list arrays are allowed. This new feature is not available - when MySQLi is compiled with libmysqlclient. - - - -prepare('INSERT INTO users(id, name) VALUES(?,?)'); -$stmt->execute([1, $username]); -?> -]]> - - - - - - - New method <methodname>mysqli_result::fetch_column</methodname> - - - mysqli_result::fetch_column - has been added to allow fetching a single scalar value from the result set. - The new method accepts an optional 0-based column - parameter of type &integer; specifying which column to fetch from. - - - -query('SELECT username FROM users WHERE id = 123'); -echo $result->fetch_column(); -?> -]]> - - - - - - - - - PDO - - - The PDO::MYSQL_ATTR_LOCAL_INFILE_DIRECTORY attribute - has been added, which can be used to specify a directory from which files - are allowed to be loaded. - It is only meaningful if PDO::MYSQL_ATTR_LOCAL_INFILE - is not enabled, as all directories are allowed in that case. - - - - - PDO_SQLite - - - SQLite's "file:" DSN syntax is now supported, - which allows specifying additional flags. - This feature is not available if open_basedir is set. - - - -]]> - - - - - - - POSIX - - - Added POSIX_RLIMIT_KQUEUES and POSIX_RLIMIT_NPTS. - These rlimits are only available on FreeBSD. - - - - - Standard - - - fputcsv now accepts a new - eol argument which allow to define a custom - End of Line sequence, the default remains the same and is "\n". - - - - - SPL - - - SplFileObject::fputcsv now accepts a new - eol argument which allow to define a custom - End of Line sequence, the default remains the same and is "\n". - - - - - diff --git a/appendices/migration81/new-functions.xml b/appendices/migration81/new-functions.xml deleted file mode 100644 index 4519a3c1a..000000000 --- a/appendices/migration81/new-functions.xml +++ /dev/null @@ -1,189 +0,0 @@ - - - New Functions - - - PHP Core - - - - - array_is_list - - - - - - - Process Control - - - - - pcntl_rfork - - - - - - - Reflection - - - - - ReflectionFunctionAbstract::getClosureUsedVariables - - - - - - - Standard - - - - - fsync - - - - - fdatasync - - - - - - - Sodium - - - XChaCha20 - - - - sodium_crypto_stream_xchacha20 - - - - - sodium_crypto_stream_xchacha20_keygen - - - - - sodium_crypto_stream_xchacha20_xor - - - - - - - Ristretto255 - - - Ristretto255 functions are available as of libsodium 1.0.18. - - - - - - sodium_crypto_core_ristretto255_add - - - - - sodium_crypto_core_ristretto255_from_hash - - - - - sodium_crypto_core_ristretto255_is_valid_point - - - - - sodium_crypto_core_ristretto255_random - - - - - sodium_crypto_core_ristretto255_scalar_add - - - - - sodium_crypto_core_ristretto255_scalar_complement - - - - - sodium_crypto_core_ristretto255_scalar_invert - - - - - sodium_crypto_core_ristretto255_scalar_mul - - - - - sodium_crypto_core_ristretto255_scalar_negate - - - - - sodium_crypto_core_ristretto255_scalar_random - - - - - sodium_crypto_core_ristretto255_scalar_reduce - - - - - sodium_crypto_core_ristretto255_scalar_sub - - - - - sodium_crypto_core_ristretto255_sub - - - - - sodium_crypto_scalarmult_ristretto255 - - - - - sodium_crypto_scalarmult_ristretto255_base - - - - - - - - diff --git a/appendices/migration81/other-changes.xml b/appendices/migration81/other-changes.xml deleted file mode 100644 index 1b9cbdf97..000000000 --- a/appendices/migration81/other-changes.xml +++ /dev/null @@ -1,239 +0,0 @@ - - - Other Changes - - - Changes in SAPI Modules - - - CLI - - - Using without the readline extension will now result in an error. - Previously, without readline had the same behavior as - calling php without any arguments, apart from printing an additional - "Interactive mode enabled" message. - This mode was not interactive. - - - - - PHPDBG - - - Remote functionality from phpdbg has been removed. - - - - - - Changed Functions - - - Core - - - The order of properties used in &foreach;, var_dump, - serialize, object comparison, etc. was changed. - Properties are now ordered naturally according to their declaration - and inheritance. Properties declared in a base class are going - to be before the child properties. - - - This order is consistent with internal layout of properties in - zend_object structure and repeats the order in - default_properties_table[] and properties_info_table[]. - The old order was not documented and was caused by class inheritance implementation details. - - - - - Filter - - - The FILTER_FLAG_ALLOW_OCTAL flag of the - FILTER_VALIDATE_INT filter - now accept octal string with the leading octal prefix - ("0o"/"0O"). - - - - - GMP - - - All GMP functions now accept octal string with the leading octal prefix - ("0o"/"0O"). - - - - - PDO ODBC - - - PDO::getAttribute with - PDO::ATTR_SERVER_INFO and - PDO::ATTR_SERVER_VERSION - now return values instead of throwing PDOException. - - - - - Reflection - - - ReflectionProperty::setAccessible and - ReflectionMethod::setAccessible - no longer have an effect. - Properties and methods are now always considered accessible via Reflection. - - - - - Standard - - - syslog is now binary safe. - - - - - - Other Changes to Extensions - - - GD - - - imagewebp can now do lossless WebP encoding - by passing IMG_WEBP_LOSSLESS as the quality. - - - This constant is only defined, if the used libgd supports - lossless WebP encoding. - - - - - MySQLi - - - mysqli_stmt::next_result and - mysqli::fetch_all - are now available when linking against libmysqlclient. - - - - - OpenSSL - - - - - The OpenSSL extension now requires at least OpenSSL version 1.0.2. - - - - - OpenSSL 3.0 is now supported. Be aware that many ciphers are no longer - enabled by default (part of the legacy provider), and that parameter - validation (e.g. minimum key sizes) is stricter now. - - - - - - - Phar - - - - - SHA256 is now used by default for signatures. - - - - - Added support for OpenSSL_SHA256 and OpenSSL_SHA512 signatures. - - - - - - - SNMP - - - - - Added support for SHA256 and SHA512 for the security protocol. - - - - - - - Standard - - - --with-password-argon2 now uses pkg-config to detect libargon2. - As such, an alternative libargon2 location should now be specified using - PKG_CONFIG_PATH. - - - - - - Changes to INI File Handling - - - - - The log_errors_max_len - INI directive has been removed. - It no longer had an effect since PHP 8.0.0. - - - - - A leading dollar in a quoted string can now be escaped: "\${" will now be - interpreted as a string with contents ${. - - - - - Backslashes in double quoted strings are now more consistently treated as - escape characters. Previously, "foo\\" followed by - something other than a newline was not considered as a terminated string. - It is now interpreted as a string with contents foo\. - However, as an exception, the string "foo\" - followed by a newline will continue to be treated as a valid string with - contents foo\ rather than an unterminated string. - This exception exists to support naive uses of Windows file paths such as - "C:\foo\". - - - - - - - diff --git a/appendices/migration82/incompatible.xml b/appendices/migration82/incompatible.xml deleted file mode 100644 index 01be060ab..000000000 --- a/appendices/migration82/incompatible.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - Backward Incompatible Changes - - - Date - - - DateTime::createFromImmutable now has a tentative - return type of static, previously it was DateTime. - - - - DateTimeImmutable::createFromMutable now has a tentative - return type of static, previously it was DateTimeImmutable. - - - - - ODBC - - - The ODBC extension now escapes the username and password for the case when - both a connection string and username/password are passed, and the string - must be appended to. Before, user values containing values needing escaping - could have created a malformed connection string, or injected values from - user-provided data. The escaping rules should be identical to the .NET BCL - DbConnectionOptions behaviour. - - - - - PDO_ODBC - - - The PDO_ODBC extension also escapes the username and password when a - connection string is passed. See the change to the ODBC extension for - further details. - - - - - Standard - - - glob now returns an empty &array; if all paths are - restricted by open_basedir. - Previously it returned &false;. - Moreover, a warning is now emitted even if only some paths are restricted by - open_basedir. - - - - strtolower, - strtoupper, - stristr, - stripos, - strripos, - lcfirst, - ucfirst, - ucwords, - and str_ireplace are no longer locale-sensitive. - They now perform ASCII case conversion, as if the locale were "C". - Localized versions of these functions are available in the MBString extension. - Moreover, array_change_key_case, and sorting with - SORT_FLAG_CASE now also use ASCII case conversion. - - - - str_split returns an empty &array; for an empty &string; now. - Previously it returned an array with a single empty string entry. - mb_str_split is not affected by this change as it was - already behaving like that. - - - - ksort and krsort now do numeric string - comparison under SORT_REGULAR using the standard PHP 8 rules now. - - - - - Standard PHP Library (SPL) - - - The following methods now enforce their signature: - - SplFileInfo::_bad_state_ex - SplFileObject::getCsvControl - SplFileObject::fflush - SplFileObject::ftell - SplFileObject::fgetc - SplFileObject::fpassthru - - - - - SplFileObject::hasChildren now has a tentative - return type of false, previously it was bool. - - - - SplFileObject::getChildren now has a tentative - return type of null, previously it was - RecursiveIteratornull. - - - - GlobIterator now returns an empty &array; if all - paths are restricted by open_basedir. - Previously it returned &false;. - Moreover, a warning is now emitted even if only some paths are restricted by - open_basedir. - - - - - diff --git a/appendices/migration82/new-features.xml b/appendices/migration82/new-features.xml deleted file mode 100644 index 77f315497..000000000 --- a/appendices/migration82/new-features.xml +++ /dev/null @@ -1,187 +0,0 @@ - - - New Features - - - PHP Core - - - SensitiveParameter Attribute - - - Added the #[\SensitiveParameter] attribute to redact - sensitive data in backtraces. - - - - - - error_log_mode INI directive - - - The error_log_mode INI directive has been added which allows setting - the permissions for the error log file. - - - - - Enumerations properties in constant expressions - - - It is now possible to fetch properties of - Enumerations - in constant expressions. - - - - - - Type System Improvements - - - It is now possible to use null and false - as stand-alone types. - - - - - The true type has been added. - - - - - It is now possible to combine intersection and union types. - The type needs to be written in DNF. - - - - - - Constants in Traits - - - It is now possible to define constants in traits. - - - - - - - Readonly Classes - - - Support for readonly - on classes has been added. - - - - - - - - cURL - - - Added the CURLINFO_EFFECTIVE_METHOD option, - which returns the effective HTTP method in the return value of - curl_getinfo. - - - - Exposed multiple new constants from libcurl 7.62 to 7.80. - - - - Added the curl_upkeep function to perform any connection upkeep checks. - - - - - DBA - - - The LMDB Driver now accepts the DBA_LMDB_USE_SUB_DIR or - DBA_LMDB_NO_SUB_DIR flags to determine if it should - create a subdirectory or not when creating a database file. - - - - - OCI8 - - - Added the oci8.prefetch_lob_size INI directive and - oci_set_prefetch_lob function to tune LOB query - performance by reducing the number of round-trips between PHP and - Oracle Databases when fetching LOBS. - This is usable with Oracle Database 12.2 or later. - - - - - OpenSSL - - - Added AEAD support for the chacha20-poly1305 algorithm. - - - - - ODBC - - - Added the odbc_connection_string_is_quoted, - odbc_connection_string_should_quote, and - odbc_connection_string_quote functions. - These are primarily used behind the scenes in the ODBC and PDO_ODBC extensions, - but are exposed to userland for easier unit testing, and for user - applications and libraries to perform quoting themselves. - - - - - PCRE - - - Added support for the n (NO_AUTO_CAPTURE) modifier, - which makes simple (xyz) groups non-capturing. - Only named groups like (?<name>xyz) are capturing. - This only affects which groups are capturing, it is still possible to use - numbered subpattern references, and the matches array will still contain - numbered results. - - - - - Random - - - This is a new extension which organises and consolidates existing - implementations related to random number generators. - New and better RNGs are available with scope issues eliminated. - - - - - - - diff --git a/appendices/migration82/new-functions.xml b/appendices/migration82/new-functions.xml deleted file mode 100644 index 2048733c5..000000000 --- a/appendices/migration82/new-functions.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - New Functions - - - cURL - - curl_upkeep - - - - - MySQLi - - mysqli_execute_query - - - - - OpenSSL - - openssl_cipher_key_length - - - - - Reflection - - - ReflectionFunction::isAnonymous - - ReflectionMethod::hasPrototype - - - - - Sodium - - - XChaCha20 - - sodium_crypto_stream_xchacha20_xor_ic - - - - - - Standard - - memory_reset_peak_usage - ini_parse_quantity - - - - - XML - - libxml_get_external_entity_loader - - - - - diff --git a/appendices/migration82/other-changes.xml b/appendices/migration82/other-changes.xml deleted file mode 100644 index 5adf841d8..000000000 --- a/appendices/migration82/other-changes.xml +++ /dev/null @@ -1,350 +0,0 @@ - - - Other Changes - - - Core changes - - - The iterable type is now a built-in compile time alias for - arrayTraversable. - Error messages relating to iterable will therefore - now use array|Traversable. - Type Reflection is preserved for single iterable - (and ?iterable) to produce a - ReflectionNamedType with name iterable, - however usage of iterable in union types will be - converted to array|Traversable. - - - - - Changes in SAPI Modules - - - CLI - - - The STDOUT, STDERR and STDIN streams are no longer closed on resource destruction - which is mostly when the CLI finishes. It is however still possible to - explicitly close those streams using fclose and similar. - - - - - - Changed Functions - - - Core - - - The strcmp, strcasecmp, - strncmp, strncasecmp, and - substr_compare functions, using binary safe string - comparison now return -1, 0 and 1. - - - - - DBA - - - dba_open and dba_popen - now have the following enforced signature: - - resourcefalsedba_open - stringpath - stringmode - stringnullhandler&null; - intpermission0644 - intmap_size0 - intnullflags&null; - - - - dba_fetch's optional skip argument is now at the end - in line with PHP userland semantics. Its signature is now: - - stringfalsedba_fetch - stringarraykey - resourcehandle - intskip - - - The overloaded signature: - - stringfalsedba_fetch - stringarraykey - intskip - resourcehandle - - is still accepted, but it is recommended to use the new standard variant. - - - - - Random - - - random_bytes and random_int - now throw a \Random\RandomException on CSPRNG failures. - Previously a plain \Exception was thrown instead. - - - - - SPL - - - The iterator parameter of - iterator_to_array and iterator_count - is widened to iterable from Iterator, - allowing arrays to be passed. - - - - - - - Other Changes to Extensions - - - Date - - - The properties of DatePeriod are now properly declared. - - - - - Intl - - - Instances of - IntlBreakIterator, - IntlRuleBasedBreakIterator, - IntlCodePointBreakIterator, - IntlPartsIterator, - IntlCalendar, - IntlCalendar, - Collator, - IntlIterator, - UConverter, - IntlDateFormatter, - IntlDatePatternGenerator, - MessageFormatter, - ResourceBundle, - Spoofchecker, - IntlTimeZone, - and Transliterator - are no longer serializable. Previously, they could be serialized, but - unserialization yielded unusable objects or failed. - - - - - MySQLi - - - The support for libmysql has been removed and it is no longer - possible to compile mysqli with libmysql. - From now on, the mysqli extension can be compiled only with mysqlnd. - All libmysql features unavailable in mysqlnd have been removed: - - The reconnect property of mysqli_driver - - The mysqli.reconnect INI directive - - The MYSQLI_IS_MARIADB constant has been deprecated - - - - - - OCI8 - - - The minimum Oracle Client library version required is now 11.2. - - - - - PCRE - - - NUL characters (\0) in pattern strings are now supported. - - - - - Session - - - Trying to change the - session.cookie_samesite - INI directive while the session is active or output has already been sent - will now fail and emit a warning. - This aligns the behaviour with all other session INI settings. - - - - - SQLite3 - - - sqlite3.defensive - is now PHP_INI_USER. - - - - - Standard - - - getimagesize now reports the actual image dimensions, - bits and channels of AVIF images. Previously, the dimensions have been reported as 0x0, - and bits and channels have not been reported at all. - - - - - Tidy - - - The properties of the tidy class are now properly declared. - And those of the tidyNode class are now properly declared as readonly. - - - - - Zip - - - The Zip extension has been updated to version 1.20.0, - which adds the following methods: - - ZipArchive::clearError - ZipArchive::getStreamName - ZipArchive::getStreamIndex - - - - - - - Changes to INI File Handling - - - Parsing of some ill-formatted values will now trigger a warning when this - was silently ignored before. - For backwards compatibility, interpretation of these values has not changed. - This affects the following settings: - - - - bcmath.scale - com.code_page - default_socket_timeout - fiber.stack_size - hard_timeout - intl.error_level - ldap.max_links - max_input_nesting_level - max_input_vars - mbstring.regex_retry_limit - mbstring.regex_stack_limit - mysqli.allow_local_infile - mysqli.allow_persistent - mysqli.default_port - mysqli.max_links - mysqli.max_persistent - mysqli.rollback_on_cached_plink - mysqlnd.log_mask - mysqlnd.mempool_default_size - mysqlnd.net_read_buffer_size - mysqlnd.net_read_timeout - oci8.default_prefetch - oci8.max_persistent - oci8.persistent_timeout - oci8.ping_interval - oci8.prefetch_lob_size - oci8.privileged_connect - oci8.statement_cache_size - odbc.allow_persistent - odbc.check_persistent - odbc.max_persistent - odbc.max_links - odbc.defaultbinmode - odbc.default_cursortype - odbc.defaultlrl - opcache.consistency_checks - opcache.file_update_protection - opcache.force_restart_timeout - opcache.interned_strings_buffer - opcache.jit_bisect_limit - opcache.jit_blacklist_root_trace - opcache.jit_blacklist_side_trace - opcache.jit_debug - opcache.jit_hot_func - opcache.jit_hot_loop - opcache.jit_hot_return - opcache.jit_hot_side_exit - opcache.jit_max_exit_counters - opcache.jit_max_loop_unrolls - opcache.jit_max_polymorphic_calls - opcache.jit_max_recursive_calls - opcache.jit_max_recursive_returns - opcache.jit_max_root_traces - opcache.jit_max_side_traces - opcache.log_verbosity_level - opcache.max_file_size - opcache.opt_debug_level - opcache.optimization_level - opcache.revalidate_freq - output_buffering - pcre.backtrack_limit - pcre.recursion_limit - pgsql.max_links - pgsql.max_persistent - post_max_size - realpath_cache_size - realpath_cache_ttl - session.cache_expire - session.cookie_lifetime - session.gc_divisor - session.gc_maxlifetime - session.gc_probability - soap.wsdl_cache_limit - soap.wsdl_cache_ttl - unserialize_max_depth - upload_max_filesize - user_ini.cache_ttl - xmlrpc_error_number - zend.assertions - zlib.output_compression_level - - - - - - diff --git a/appendices/migration82/windows-support.xml b/appendices/migration82/windows-support.xml deleted file mode 100644 index 50c16ed0d..000000000 --- a/appendices/migration82/windows-support.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - Windows Support - - - Core - - Windows specific error messages are no longer localized, but instead - always displayed in English to better match PHP error messages. - - - Preliminary and highly experimental support for building on ARM64 has been added. - - - - - OCI8 - - Because building against Oracle Client 10g is no longer supported anyway, - the configuration option --with-oci8 has been dropped. - The --with-oci8-11g, --with-oci8-12c and - --with-oci8-19 configuration options are still supported. - - - - - Zip - - The Zip extension is upgraded to version 1.21.0, - and is now built as shared library (DLL) by default. - - - - - diff --git a/reference/apache/versions.xml b/reference/apache/versions.xml deleted file mode 100644 index 9d549eacb..000000000 --- a/reference/apache/versions.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/array/versions.xml b/reference/array/versions.xml deleted file mode 100644 index 0734b7420..000000000 --- a/reference/array/versions.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/calendar/versions.xml b/reference/calendar/versions.xml deleted file mode 100644 index f9ae7de4d..000000000 --- a/reference/calendar/versions.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/classobj/functions/get-mangled-object-vars.xml b/reference/classobj/functions/get-mangled-object-vars.xml deleted file mode 100644 index 030a47ab6..000000000 --- a/reference/classobj/functions/get-mangled-object-vars.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - - - get_mangled_object_vars - Returns an array of mangled object properties - - - - &reftitle.description; - - arrayget_mangled_object_vars - objectobject - - - Returns an &array; whose elements are the object's - properties. The keys are the member variable names, with a few notable - exceptions: private variables have the class name prepended to the variable name, - and protected variables have a * prepended to the variable name. - These prepended values have NUL bytes on either side. - Uninitialized typed properties - are silently discarded. - - - - - &reftitle.parameters; - - - - object - - - An object instance. - - - - - - - - - &reftitle.returnvalues; - - Returns an &array; containing all properties, regardless of visibility, of object. - - - - - &reftitle.examples; - - - <function>get_mangled_object_vars</function> example - -dynamic = 5; -$object->{'6'} = 6; - -var_dump(get_mangled_object_vars($object)); - -class AO extends ArrayObject -{ - private $private = 1; -} - -$arrayObject = new AO(['x' => 'y']); -$arrayObject->dynamic = 2; - -var_dump(get_mangled_object_vars($arrayObject)); -]]> - - &example.outputs; - - - int(4) - ["public"]=> - int(1) - ["*protected"]=> - int(2) - ["Aprivate"]=> - int(3) - ["dynamic"]=> - int(5) - [6]=> - int(6) -} -array(2) { - ["AOprivate"]=> - int(1) - ["dynamic"]=> - int(2) -} - -]]> - - - - - - - &reftitle.seealso; - - - get_class_vars - get_object_vars - - - - - - diff --git a/reference/classobj/versions.xml b/reference/classobj/versions.xml deleted file mode 100644 index 312b6a901..000000000 --- a/reference/classobj/versions.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/cmark/commonmark.cql.xml b/reference/cmark/commonmark.cql.xml deleted file mode 100644 index 2ca50dbc3..000000000 --- a/reference/cmark/commonmark.cql.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - - The CommonMark\CQL class - CommonMark\CQL - - - - -
- &reftitle.intro; - - CommonMark Query Language is a DSL for describing how to travel through a CommonMark Node tree implemented as a parser and compiler for a small set of instructions, and a virtual machine for executing those instructions. - - - Paths: - - In it's most simplistic form, a CQL query combines the following paths and / to describe how to travel through a tree: - - firstChild - lastChild - previous - next - parent - - For example, /firstChild/lastChild would travel to the last child node of the first child node. - - - - Loops - - CQL can be instructed to loop, for example through the children of, or siblings to a particular node, by using the path children, or siblings. For example, /firstChild/children will travel to all the children of the first child node. - - - - Subqueries - - CQL can be instructed how to travel by using a subquery like [/firstChild]. For example, /firstChild/children[/firstChild] will travel to the first child node of all the children of the first child node. - - - - Loop Constraints - - While looping, CQL can be instructed to constrict the travelled path to nodes of particular type. For example /children(BlockQuote) will travel to the children of a node where the type is BlockQuote. The following types are recognized (case insensitively): - - BlockQuote - List - Item - CodeBlock - HtmlBlock - CustomBlock - Paragraph - Heading - ThematicBreak - Text - SoftBreak - LineBreak - Code - HtmlInline - CustomInline - Emphasis - Strong - Link - Image - - Types may be used as a union, for example /children(BlockQuote|List) will travel to the children of a node where the type is BlockQuote or List. Types, or unions of types, may be also negated. For example /children(~BlockQuote) will travel to the children of a node where the type is not BlockQuote, and /children(~BlockQuote|Paragraph) will travel to the children of a node where the type is not BlockQuote or Paragraph - - - - Path Constraints - - CQL can be instructed to create a loop to travel to a node of a particular type, at a particular path. For example, /firstChild(BlockQuote) will travel to the first child node where the type is BlockQuote. Note that like other loops for children and siblings, this kind of path can only be followed by a subquery. - - - - Implementation Notes - - While CQL has been implemented as part of the PHP CommonMark extension, it stands separately from PHP and does not use PHP's virtual machine or internal representation of values. - - -
- - -
- &reftitle.classsynopsis; - - - - CommonMark\CQL - - - - - CommonMark\CQL - - - - - Constructor - - - &Methods; - - - - -
- - - - &reference.cmark.commonmark.cql.construct; - &reference.cmark.commonmark.cql.invoke; - - - - diff --git a/reference/cmark/commonmark.interfaces.ivisitable.xml b/reference/cmark/commonmark.interfaces.ivisitable.xml deleted file mode 100644 index b58eda46a..000000000 --- a/reference/cmark/commonmark.interfaces.ivisitable.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - The CommonMark\Interfaces\IVisitable interface - CommonMark\Interfaces\IVisitable - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - CommonMark\Interfaces\IVisitable - - - - - final - CommonMark\Interfaces\IVisitable - - - - - - - - -
- - - - &reference.cmark.commonmark.interfaces.ivisitable.accept; - - - - diff --git a/reference/cmark/commonmark.interfaces.ivisitor.xml b/reference/cmark/commonmark.interfaces.ivisitor.xml deleted file mode 100644 index ee6c12c2e..000000000 --- a/reference/cmark/commonmark.interfaces.ivisitor.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - The CommonMark\Interfaces\IVisitor interface - CommonMark\Interfaces\IVisitor - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - CommonMark\Interfaces\IVisitor - - - - - final - CommonMark\Interfaces\IVisitor - - - - Constants - - const - int - CommonMark\Interfaces\IVisitor::Done - - - const - int - CommonMark\Interfaces\IVisitor::Enter - - - const - int - CommonMark\Interfaces\IVisitor::Leave - - - &Methods; - - - - -
- - - - &reference.cmark.commonmark.interfaces.ivisitor.enter; - &reference.cmark.commonmark.interfaces.ivisitor.leave; - - - - diff --git a/reference/cmark/commonmark.node.blockquote.xml b/reference/cmark/commonmark.node.blockquote.xml deleted file mode 100644 index 5fb458e94..000000000 --- a/reference/cmark/commonmark.node.blockquote.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - BlockQuote concrete CommonMark\Node - CommonMark\Node\BlockQuote - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\BlockQuote - - - - - final - CommonMark\Node\BlockQuote - - - - extends - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
- - - - - - diff --git a/reference/cmark/commonmark.node.bulletlist.xml b/reference/cmark/commonmark.node.bulletlist.xml deleted file mode 100644 index ff0fcaa3c..000000000 --- a/reference/cmark/commonmark.node.bulletlist.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - BulletList concrete CommonMark\Node - CommonMark\Node\BulletList - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\BulletList - - - - - final - CommonMark\Node\BulletList - - - - extends - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - - &InheritedProperties; - - - &Properties; - - public - bool - tight - - - public - int - delimiter - - -Constructor - - - &InheritedMethods; - - - - - -
- - - - &reference.cmark.commonmark.node.bulletlist.construct; - - - - diff --git a/reference/cmark/commonmark.node.code.xml b/reference/cmark/commonmark.node.code.xml deleted file mode 100644 index 51ea4fa46..000000000 --- a/reference/cmark/commonmark.node.code.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - Code concrete CommonMark\Node - CommonMark\Node\Code - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\Code - - - - - final - CommonMark\Node\Code - - - - extends - CommonMark\Node\Text - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - &InheritedProperties; - - - - Constructor - - - &InheritedMethods; - - - - - -
- - - - - - diff --git a/reference/cmark/commonmark.node.codeblock.xml b/reference/cmark/commonmark.node.codeblock.xml deleted file mode 100644 index 7b4fd625b..000000000 --- a/reference/cmark/commonmark.node.codeblock.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - CodeBlock concrete CommonMark\Node - CommonMark\Node\CodeBlock - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\CodeBlock - - - - - final - CommonMark\Node\CodeBlock - - - - extends - CommonMark\Node\Text - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - &InheritedProperties; - - - - &Properties; - - public - stringnull - fence - - - Constructor - - - - &InheritedMethods; - - - - - -
- - - - - &reference.cmark.commonmark.node.codeblock.construct; - - - - diff --git a/reference/cmark/commonmark.node.customblock.xml b/reference/cmark/commonmark.node.customblock.xml deleted file mode 100644 index 4b815b0e9..000000000 --- a/reference/cmark/commonmark.node.customblock.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - CustomBlock concrete CommonMark\Node - CommonMark\Node\CustomBlock - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\CustomBlock - - - - - final - CommonMark\Node\CustomBlock - - - - extends - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - - &InheritedProperties; - - - &Properties; - - public - stringnull - onEnter - - - public - stringnull - onLeave - - - &InheritedMethods; - - - - - -
- - - - - - diff --git a/reference/cmark/commonmark.node.custominline.xml b/reference/cmark/commonmark.node.custominline.xml deleted file mode 100644 index 06af8eef2..000000000 --- a/reference/cmark/commonmark.node.custominline.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - CustomInline concrete CommonMark\Node - CommonMark\Node\CustomInline - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\CustomInline - - - - - final - CommonMark\Node\CustomInline - - - - extends - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - &InheritedProperties; - - - &Properties; - - public - stringnull - onEnter - - - public - stringnull - onLeave - - - &InheritedMethods; - - - - - -
- - - - - - diff --git a/reference/cmark/commonmark.node.document.xml b/reference/cmark/commonmark.node.document.xml deleted file mode 100644 index c5e6f334f..000000000 --- a/reference/cmark/commonmark.node.document.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Document concrete CommonMark\Node - CommonMark\Node\Document - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\Document - - - - - final - CommonMark\Node\Document - - - - extends - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
- - - - - - diff --git a/reference/cmark/commonmark.node.heading.xml b/reference/cmark/commonmark.node.heading.xml deleted file mode 100644 index 579c1fb44..000000000 --- a/reference/cmark/commonmark.node.heading.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - Heading concrete CommonMark\Node - CommonMark\Node\Heading - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\Heading - - - - - final - CommonMark\Node\Heading - - - - extends - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - - &InheritedProperties; - - - &Properties; - - public - int - level - - - Constructor - - - &InheritedMethods; - - - - - -
- - - - &reference.cmark.commonmark.node.heading.construct; - - - diff --git a/reference/cmark/commonmark.node.htmlblock.xml b/reference/cmark/commonmark.node.htmlblock.xml deleted file mode 100644 index 62f121e47..000000000 --- a/reference/cmark/commonmark.node.htmlblock.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - HTMLBlock concrete CommonMark\Node - CommonMark\Node\HTMLBlock - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\HTMLBlock - - - - - final - CommonMark\Node\HTMLBlock - - - - extends - CommonMark\Node\Text - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - &InheritedProperties; - - - - Constructor - - - &InheritedMethods; - - - - - -
- - - - - - diff --git a/reference/cmark/commonmark.node.htmlinline.xml b/reference/cmark/commonmark.node.htmlinline.xml deleted file mode 100644 index c9fbc8464..000000000 --- a/reference/cmark/commonmark.node.htmlinline.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - HTMLInline concrete CommonMark\Node - CommonMark\Node\HTMLInline - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\HTMLInline - - - - - final - CommonMark\Node\HTMLInline - - - - extends - CommonMark\Node\Text - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - &InheritedProperties; - - - -Constructor - - - &InheritedMethods; - - - - - -
- - - - - - diff --git a/reference/cmark/commonmark.node.image.xml b/reference/cmark/commonmark.node.image.xml deleted file mode 100644 index 1fa5d4ffc..000000000 --- a/reference/cmark/commonmark.node.image.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Image concrete CommonMark\Node - CommonMark\Node\Image - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\Image - - - - - final - CommonMark\Node\Image - - - - extends - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - &InheritedProperties; - - - &Properties; - - public - stringnull - url - - - public - stringnull - title - - - Constructor - - - &InheritedMethods; - - - - - -
- - - &reference.cmark.commonmark.node.image.construct; - - - - diff --git a/reference/cmark/commonmark.node.item.xml b/reference/cmark/commonmark.node.item.xml deleted file mode 100644 index 6b02fb69e..000000000 --- a/reference/cmark/commonmark.node.item.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Item concrete CommonMark\Node - CommonMark\Node\Item - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\Item - - - - - final - CommonMark\Node\Item - - - - extends - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
- - - - - - diff --git a/reference/cmark/commonmark.node.linebreak.xml b/reference/cmark/commonmark.node.linebreak.xml deleted file mode 100644 index a24f917a8..000000000 --- a/reference/cmark/commonmark.node.linebreak.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - LineBreak concrete CommonMark\Node - CommonMark\Node\LineBreak - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\LineBreak - - - - - final - CommonMark\Node\LineBreak - - - - extends - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
- - - - - - diff --git a/reference/cmark/commonmark.node.link.xml b/reference/cmark/commonmark.node.link.xml deleted file mode 100644 index d5785639c..000000000 --- a/reference/cmark/commonmark.node.link.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - Link concrete CommonMark\Node - CommonMark\Node\Link - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\Link - - - - - final - CommonMark\Node\Link - - - - extends - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - - &InheritedProperties; - - - &Properties; - - public - stringnull - url - - - public - stringnull - title - - - Constructor - - - &InheritedMethods; - - - - - -
- - - - &reference.cmark.commonmark.node.link.construct; - - - - diff --git a/reference/cmark/commonmark.node.orderedlist.xml b/reference/cmark/commonmark.node.orderedlist.xml deleted file mode 100644 index 2789b9974..000000000 --- a/reference/cmark/commonmark.node.orderedlist.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - OrderedList concrete CommonMark\Node - CommonMark\Node\OrderedList - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\OrderedList - - - - - final - CommonMark\Node\OrderedList - - - - extends - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - &InheritedProperties; - - - &Properties; - - public - bool - tight - - - public - int - delimiter - - - public - int - start - - - Constructor - - - &InheritedMethods; - - - - - -
- - - - &reference.cmark.commonmark.node.orderedlist.construct; - - - - diff --git a/reference/cmark/commonmark.node.paragraph.xml b/reference/cmark/commonmark.node.paragraph.xml deleted file mode 100644 index 1182d12f0..000000000 --- a/reference/cmark/commonmark.node.paragraph.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Paragraph concrete CommonMark\Node - CommonMark\Node\Paragraph - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\Paragraph - - - - - final - CommonMark\Node\Paragraph - - - - extends - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
- - - - - - diff --git a/reference/cmark/commonmark.node.softbreak.xml b/reference/cmark/commonmark.node.softbreak.xml deleted file mode 100644 index f26719dbc..000000000 --- a/reference/cmark/commonmark.node.softbreak.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - SoftBreak concrete CommonMark\Node - CommonMark\Node\SoftBreak - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\SoftBreak - - - - - final - CommonMark\Node\SoftBreak - - - - extends - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
- - - - - - diff --git a/reference/cmark/commonmark.node.text.emphasis.xml b/reference/cmark/commonmark.node.text.emphasis.xml deleted file mode 100644 index e4cf7d7da..000000000 --- a/reference/cmark/commonmark.node.text.emphasis.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Emphasis concrete CommonMark\Node - CommonMark\Node\Text\Emphasis - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\Text\Emphasis - - - - - final - CommonMark\Node\Text\Emphasis - - - - extends - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
- - - - - - diff --git a/reference/cmark/commonmark.node.text.strong.xml b/reference/cmark/commonmark.node.text.strong.xml deleted file mode 100644 index 919639d23..000000000 --- a/reference/cmark/commonmark.node.text.strong.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Strong concrete CommonMark\Node - CommonMark\Node\Text\Strong - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\Text\Strong - - - - - final - CommonMark\Node\Text\Strong - - - - extends - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
- - - - - - diff --git a/reference/cmark/commonmark.node.text.xml b/reference/cmark/commonmark.node.text.xml deleted file mode 100644 index aaeb90f00..000000000 --- a/reference/cmark/commonmark.node.text.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - Text concrete CommonMark\Node - CommonMark\Node\Text - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\Text - - - - - final - CommonMark\Node\Text - - - - extends - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - &InheritedProperties; - - - &Properties; - - public - stringnull - literal - - - Constructor - - - &InheritedMethods; - - - - - -
- - - - &reference.cmark.commonmark.node.text.construct; - - - - diff --git a/reference/cmark/commonmark.node.thematicbreak.xml b/reference/cmark/commonmark.node.thematicbreak.xml deleted file mode 100644 index 20c1a7028..000000000 --- a/reference/cmark/commonmark.node.thematicbreak.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - ThematicBreak concrete CommonMark\Node - CommonMark\Node\ThematicBreak - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\ThematicBreak - - - - - final - CommonMark\Node\ThematicBreak - - - - extends - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
- - - - - - diff --git a/reference/cmark/commonmark.node.xml b/reference/cmark/commonmark.node.xml deleted file mode 100644 index 15c8ef84c..000000000 --- a/reference/cmark/commonmark.node.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - Abstract CommonMark\Node - CommonMark\Node - - - - -
- &reftitle.intro; - - Represents an Abstract Node, this final abstract is not for direct use by the programmer. - -
- - -
- &reftitle.classsynopsis; - - - - CommonMark\Node - - - - - final - abstract - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - - &Properties; - - public - readonly - Nodenull - parent - - - public - readonly - Nodenull - previous - - - public - readonly - Nodenull - next - - - public - readonly - Nodenull - lastChild - - - public - readonly - Nodenull - firstChild - - - public - readonly - int - startLine - - - public - readonly - int - endLine - - - public - readonly - int - startColumn - - - public - readonly - int - endColumn - - - &Methods; - - - - -
- - - - - &reference.cmark.commonmark.node.appendchild; - &reference.cmark.commonmark.node.prependchild; - &reference.cmark.commonmark.node.insertafter; - &reference.cmark.commonmark.node.insertbefore; - &reference.cmark.commonmark.node.replace; - &reference.cmark.commonmark.node.unlink; - &reference.cmark.commonmark.node.accept; - - - - diff --git a/reference/cmark/commonmark.parser.xml b/reference/cmark/commonmark.parser.xml deleted file mode 100644 index 16155fdea..000000000 --- a/reference/cmark/commonmark.parser.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - The CommonMark\Parser class - CommonMark\Parser - - - - -
- &reftitle.intro; - - Provides an incremental parser as an alternative to the simple Parsing API function - -
- - -
- &reftitle.classsynopsis; - - - - CommonMark\Parser - - - - - final - CommonMark\Parser - - - - - Constructor - - - &Methods; - - - - -
- - - - &reference.cmark.commonmark.parser.construct; - &reference.cmark.commonmark.parser.parse; - &reference.cmark.commonmark.parser.finish; - - - - diff --git a/reference/cmark/commonmark/cql/construct.xml b/reference/cmark/commonmark/cql/construct.xml deleted file mode 100644 index c4336a4e4..000000000 --- a/reference/cmark/commonmark/cql/construct.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - CommonMark\CQL::__construct - CQL Construction - - - - &reftitle.description; - - public CommonMark\CQL::__construct - stringquery - - - - - - - - - &reftitle.parameters; - - - query - - - a CQL string - - - - - - - - - diff --git a/reference/cmark/commonmark/cql/invoke.xml b/reference/cmark/commonmark/cql/invoke.xml deleted file mode 100644 index 21f622a68..000000000 --- a/reference/cmark/commonmark/cql/invoke.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - CommonMark\CQL::__invoke - CQL Execution - - - - &reftitle.description; - - public CommonMark\CQL::__invoke - CommonMark\Noderoot - callablehandler - - - Shall invoke the current CQL function on the given root, - executing the given handler on entry to a CommonMark\Node - - - - - - &reftitle.parameters; - - - root - - the root node of a tree - - - - handler - - - should have the prototype: - - boolnullhandler - CommonMark\Noderoot - CommonMark\Nodeentering - - - Should handler fail to return (void), or return null, CQL will continue executing - Should the handler return a truthy value, CQL will continue executing. - Should the handler return a falsy value, CQL will stop executing - - - - - - - - - - diff --git a/reference/cmark/commonmark/interfaces/entities.ivisitable.xml b/reference/cmark/commonmark/interfaces/entities.ivisitable.xml deleted file mode 100644 index e948a9450..000000000 --- a/reference/cmark/commonmark/interfaces/entities.ivisitable.xml +++ /dev/null @@ -1 +0,0 @@ -&reference.cmark.commonmark.interfaces.ivisitable.accept; diff --git a/reference/cmark/commonmark/interfaces/entities.ivisitor.xml b/reference/cmark/commonmark/interfaces/entities.ivisitor.xml deleted file mode 100644 index 9cc36fd71..000000000 --- a/reference/cmark/commonmark/interfaces/entities.ivisitor.xml +++ /dev/null @@ -1,2 +0,0 @@ -&reference.cmark.commonmark.interfaces.ivisitor.enter; -&reference.cmark.commonmark.interfaces.ivisitor.leave; diff --git a/reference/cmark/commonmark/interfaces/ivisitable/accept.xml b/reference/cmark/commonmark/interfaces/ivisitable/accept.xml deleted file mode 100644 index 1f725727e..000000000 --- a/reference/cmark/commonmark/interfaces/ivisitable/accept.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - CommonMark\Interfaces\IVisitable::accept - Visitation - - - - &reftitle.description; - - abstract public voidCommonMark\Interfaces\IVisitable::accept - CommonMark\Interfaces\IVisitorvisitor - - - - - - &reftitle.parameters; - - - visitor - - - An object implementing CommonMark\Interfaces\IVisitor - - - - - - - - &reftitle.seealso; - - - - - - - - - diff --git a/reference/cmark/commonmark/interfaces/ivisitor/enter.xml b/reference/cmark/commonmark/interfaces/ivisitor/enter.xml deleted file mode 100644 index a5be5c690..000000000 --- a/reference/cmark/commonmark/interfaces/ivisitor/enter.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - CommonMark\Interfaces\IVisitor::enter - Visitation - - - - &reftitle.description; - - abstract public intIVisitablenullCommonMark\Interfaces\IVisitor::enter - IVisitablevisitable - - - - - - &reftitle.parameters; - - - visitable - - - The current CommonMark\Interfaces\IVisitable being entered - - - - - - - - &reftitle.returnvalues; - - Returning CommonMark\Interfaces\IVisitor::Done will cause the backing iterator to exit. - - - Returning CommonMark\Interfaces\IVisitor::Enter will reset the backing iterator at entering the current IVisitable - - - Returning CommonMark\Interfaces\IVisitor::Leave will reset the backing iterator at exiting the current IVisitable - - - Returning an IVisitable will reset the backing iterator at entering the given IVisitable - - - Returning nothing will allow the backing iterator to continue - - - - - &reftitle.seealso; - - - - - - - - - diff --git a/reference/cmark/commonmark/interfaces/ivisitor/leave.xml b/reference/cmark/commonmark/interfaces/ivisitor/leave.xml deleted file mode 100644 index 7f90f0854..000000000 --- a/reference/cmark/commonmark/interfaces/ivisitor/leave.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - CommonMark\Interfaces\IVisitor::leave - Visitation - - - - &reftitle.description; - - abstract public intIVisitablenullCommonMark\Interfaces\IVisitor::leave - IVisitablevisitable - - - - - - &reftitle.parameters; - - - visitable - - - The current CommonMark\Interfaces\IVisitable being exited - - - - - - - - &reftitle.returnvalues; - - Returning CommonMark\Interfaces\IVisitor::Done will cause the backing iterator to exit. - - - Returning CommonMark\Interfaces\IVisitor::Enter will reset the backing iterator at entering the current IVisitable - - - Returning CommonMark\Interfaces\IVisitor::Leave will reset the backing iterator at exiting the current IVisitable - - - Returning an IVisitable will reset the backing iterator at exiting the given IVisitable - - - Returning nothing will allow the backing iterator to continue - - - - - &reftitle.seealso; - - - - - - - - - diff --git a/reference/cmark/commonmark/node/appendchild.xml b/reference/cmark/commonmark/node/appendchild.xml deleted file mode 100644 index d142c3598..000000000 --- a/reference/cmark/commonmark/node/appendchild.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - CommonMark\Node::appendChild - Manipulación AST - - - - &reftitle.description; - - public CommonMark\NodeCommonMark\Node::appendChild - CommonMark\Nodechild - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - child - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/cmark/commonmark/node/bulletlist/construct.xml b/reference/cmark/commonmark/node/bulletlist/construct.xml deleted file mode 100644 index a6c0c5529..000000000 --- a/reference/cmark/commonmark/node/bulletlist/construct.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - CommonMark\Node\BulletList::__construct - Construcción BulletList - - - - &reftitle.description; - - public CommonMark\Node\BulletList::__construct - - - - public CommonMark\Node\BulletList::__construct - inttight - - - public CommonMark\Node\BulletList::__construct - inttight - intdelimiter - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - - - - diff --git a/reference/cmark/commonmark/node/codeblock/construct.xml b/reference/cmark/commonmark/node/codeblock/construct.xml deleted file mode 100644 index b1b7ea085..000000000 --- a/reference/cmark/commonmark/node/codeblock/construct.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - - CommonMark\Node\CodeBlock::__construct - Constructor CodeBlock - - - - &reftitle.description; - - public CommonMark\Node\CodeBlock::__construct - stringfence - stringliteral - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - fence - - - - - - - - literal - - - - - - - - - - - - - - - - diff --git a/reference/cmark/commonmark/node/entities.bulletlist.xml b/reference/cmark/commonmark/node/entities.bulletlist.xml deleted file mode 100644 index c49b0f268..000000000 --- a/reference/cmark/commonmark/node/entities.bulletlist.xml +++ /dev/null @@ -1 +0,0 @@ -&reference.cmark.commonmark.node.bulletlist.construct; diff --git a/reference/cmark/commonmark/node/entities.codeblock.xml b/reference/cmark/commonmark/node/entities.codeblock.xml deleted file mode 100644 index 96b67c56b..000000000 --- a/reference/cmark/commonmark/node/entities.codeblock.xml +++ /dev/null @@ -1 +0,0 @@ -&reference.cmark.commonmark.node.codeblock.construct; diff --git a/reference/cmark/commonmark/node/entities.heading.xml b/reference/cmark/commonmark/node/entities.heading.xml deleted file mode 100644 index 32a18ad96..000000000 --- a/reference/cmark/commonmark/node/entities.heading.xml +++ /dev/null @@ -1 +0,0 @@ -&reference.cmark.commonmark.node.heading.construct; diff --git a/reference/cmark/commonmark/node/entities.image.xml b/reference/cmark/commonmark/node/entities.image.xml deleted file mode 100644 index 17cad94c5..000000000 --- a/reference/cmark/commonmark/node/entities.image.xml +++ /dev/null @@ -1 +0,0 @@ -&reference.cmark.commonmark.node.image.construct; diff --git a/reference/cmark/commonmark/node/entities.link.xml b/reference/cmark/commonmark/node/entities.link.xml deleted file mode 100644 index cc36d3890..000000000 --- a/reference/cmark/commonmark/node/entities.link.xml +++ /dev/null @@ -1 +0,0 @@ -&reference.cmark.commonmark.node.link.construct; diff --git a/reference/cmark/commonmark/node/entities.orderedlist.xml b/reference/cmark/commonmark/node/entities.orderedlist.xml deleted file mode 100644 index 2d4eeb819..000000000 --- a/reference/cmark/commonmark/node/entities.orderedlist.xml +++ /dev/null @@ -1 +0,0 @@ -&reference.cmark.commonmark.node.orderedlist.construct; diff --git a/reference/cmark/commonmark/node/entities.text.xml b/reference/cmark/commonmark/node/entities.text.xml deleted file mode 100644 index d512473c5..000000000 --- a/reference/cmark/commonmark/node/entities.text.xml +++ /dev/null @@ -1 +0,0 @@ -&reference.cmark.commonmark.node.text.construct; diff --git a/reference/cmark/commonmark/node/heading/construct.xml b/reference/cmark/commonmark/node/heading/construct.xml deleted file mode 100644 index 0c8a1dcf2..000000000 --- a/reference/cmark/commonmark/node/heading/construct.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - CommonMark\Node\Heading::__construct - Constructor Heading - - - - &reftitle.description; - - public CommonMark\Node\Heading::__construct - - - - public CommonMark\Node\Heading::__construct - intlevel - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - - - - diff --git a/reference/cmark/commonmark/node/image/construct.xml b/reference/cmark/commonmark/node/image/construct.xml deleted file mode 100644 index fa0984ec8..000000000 --- a/reference/cmark/commonmark/node/image/construct.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - CommonMark\Node\Image::__construct - Constructor Image - - - - &reftitle.description; - - public CommonMark\Node\Image::__construct - - - - public CommonMark\Node\Image::__construct - stringurl - - - public CommonMark\Node\Image::__construct - stringurl - stringtitle - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - url - - - - - - - - title - - - - - - - - - - - - - - - - diff --git a/reference/cmark/commonmark/node/insertafter.xml b/reference/cmark/commonmark/node/insertafter.xml deleted file mode 100644 index 51c35f658..000000000 --- a/reference/cmark/commonmark/node/insertafter.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - CommonMark\Node::insertAfter - Manipulación AST - - - - &reftitle.description; - - public CommonMark\NodeCommonMark\Node::insertAfter - CommonMark\Nodesibling - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - sibling - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/cmark/commonmark/node/insertbefore.xml b/reference/cmark/commonmark/node/insertbefore.xml deleted file mode 100644 index 84aa06bc5..000000000 --- a/reference/cmark/commonmark/node/insertbefore.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - CommonMark\Node::insertBefore - Manipulación AST - - - - &reftitle.description; - - public CommonMark\NodeCommonMark\Node::insertBefore - CommonMark\Nodesibling - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - sibling - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/cmark/commonmark/node/link/construct.xml b/reference/cmark/commonmark/node/link/construct.xml deleted file mode 100644 index dab0b8473..000000000 --- a/reference/cmark/commonmark/node/link/construct.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - CommonMark\Node\Link::__construct - Constructor Link - - - - &reftitle.description; - - public CommonMark\Node\Link::__construct - - - - public CommonMark\Node\Link::__construct - stringurl - - - public CommonMark\Node\Link::__construct - stringurl - stringtitle - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - url - - - - - - - - title - - - - - - - - - - - - - - - - diff --git a/reference/cmark/commonmark/node/prependchild.xml b/reference/cmark/commonmark/node/prependchild.xml deleted file mode 100644 index f4eda94ff..000000000 --- a/reference/cmark/commonmark/node/prependchild.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - CommonMark\Node::prependChild - Manipulación AST - - - - &reftitle.description; - - public CommonMark\NodeCommonMark\Node::prependChild - CommonMark\Nodechild - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - child - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/cmark/commonmark/node/replace.xml b/reference/cmark/commonmark/node/replace.xml deleted file mode 100644 index 8805664b5..000000000 --- a/reference/cmark/commonmark/node/replace.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - CommonMark\Node::replace - Manipulación AST - - - - &reftitle.description; - - public CommonMark\NodeCommonMark\Node::replace - CommonMark\Nodetarget - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - target - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/cmark/commonmark/node/text/construct.xml b/reference/cmark/commonmark/node/text/construct.xml deleted file mode 100644 index 8a2d12492..000000000 --- a/reference/cmark/commonmark/node/text/construct.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - - CommonMark\Node\Text::__construct - Constructor Text - - - - &reftitle.description; - - public CommonMark\Node\Text::__construct - - - - public CommonMark\Node\Text::__construct - stringliteral - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - literal - - - - - - - - - - - - - - - - diff --git a/reference/cmark/commonmark/node/unlink.xml b/reference/cmark/commonmark/node/unlink.xml deleted file mode 100644 index 91eb5525d..000000000 --- a/reference/cmark/commonmark/node/unlink.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - CommonMark\Node::unlink - Manipulación AST - - - - &reftitle.description; - - public voidCommonMark\Node::unlink - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/cmark/commonmark/parser/construct.xml b/reference/cmark/commonmark/parser/construct.xml deleted file mode 100644 index 07ab58bdb..000000000 --- a/reference/cmark/commonmark/parser/construct.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - - CommonMark\Parser::__construct - Constructor Parser - - - - &reftitle.description; - - public CommonMark\Parser::__construct - intoptions - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - options - - - Una máscara de: - - - - - CommonMark\Parser\Normal - (integer) - - - - - - - - - CommonMark\Parser\Normalize - (integer) - - - - - - - - - CommonMark\Parser\ValidateUTF8 - (integer) - - - - - - - - - CommonMark\Parser\Smart - (integer) - - - - - - - - - - - - - - - diff --git a/reference/cmark/commonmark/parser/finish.xml b/reference/cmark/commonmark/parser/finish.xml deleted file mode 100644 index 9ff6ada57..000000000 --- a/reference/cmark/commonmark/parser/finish.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - CommonMark\Parser::finish - Parsing - - - - &reftitle.description; - - public CommonMark\NodeCommonMark\Parser::finish - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/cmark/commonmark/parser/parse.xml b/reference/cmark/commonmark/parser/parse.xml deleted file mode 100644 index 6f73d6a99..000000000 --- a/reference/cmark/commonmark/parser/parse.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - CommonMark\Parser::parse - Parsing - - - - &reftitle.description; - - public voidCommonMark\Parser::parse - stringbuffer - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - buffer - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/cmark/configure.xml b/reference/cmark/configure.xml deleted file mode 100644 index 49f337f1c..000000000 --- a/reference/cmark/configure.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - -
- &reftitle.install; - - - Use when compiling PHP. - - - - Windows users should include php_cmark.dll into &php.ini; - - -
- - - diff --git a/reference/cmark/entities.commonmark.xml b/reference/cmark/entities.commonmark.xml deleted file mode 100644 index 95b1b0a2b..000000000 --- a/reference/cmark/entities.commonmark.xml +++ /dev/null @@ -1,4 +0,0 @@ -&reference.cmark.commonmark.entities.cql; -&reference.cmark.commonmark.entities.interfaces; -&reference.cmark.commonmark.entities.node; -&reference.cmark.commonmark.entities.parser; diff --git a/reference/cmark/entities.functions.xml b/reference/cmark/entities.functions.xml deleted file mode 100644 index 0306f1e9d..000000000 --- a/reference/cmark/entities.functions.xml +++ /dev/null @@ -1,6 +0,0 @@ -&reference.cmark.functions.commonmark.parse; -&reference.cmark.functions.commonmark.render.html; -&reference.cmark.functions.commonmark.render.latex; -&reference.cmark.functions.commonmark.render.man; -&reference.cmark.functions.commonmark.render.xml; -&reference.cmark.functions.commonmark.render; diff --git a/reference/cmark/functions/commonmark.render.html.xml b/reference/cmark/functions/commonmark.render.html.xml deleted file mode 100644 index 4ef7101a2..000000000 --- a/reference/cmark/functions/commonmark.render.html.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - - - CommonMark\Render\HTML - Rendering - - - - &reftitle.description; - - stringCommonMark\Render\HTML - CommonMark\Nodenode - intoptions - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - node - - - - - - - - options - - - Una máscara de: - - - - - CommonMark\Render\Normal - (integer) - - - - - - - - - CommonMark\Render\SourcePos - (integer) - - - - - - - - - CommonMark\Render\HardBreaks - (integer) - - - - - - - - - CommonMark\Render\Safe - (integer) - - - - - - - - - CommonMark\Render\NoBreaks - (integer) - - - - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/cmark/functions/commonmark.render.latex.xml b/reference/cmark/functions/commonmark.render.latex.xml deleted file mode 100644 index 580b66a83..000000000 --- a/reference/cmark/functions/commonmark.render.latex.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - - - CommonMark\Render\Latex - Rendering - - - - &reftitle.description; - - stringCommonMark\Render\Latex - CommonMark\Nodenode - intoptions - intwidth - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - node - - - - - - - - options - - - Una máscara de: - - - - - CommonMark\Render\Normal - (integer) - - - - - - - - - CommonMark\Render\SourcePos - (integer) - - - - - - - - - CommonMark\Render\HardBreaks - (integer) - - - - - - - - - CommonMark\Render\Safe - (integer) - - - - - - - - - CommonMark\Render\NoBreaks - (integer) - - - - - - - - - - - width - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/cmark/functions/commonmark.render.man.xml b/reference/cmark/functions/commonmark.render.man.xml deleted file mode 100644 index 4a40cb184..000000000 --- a/reference/cmark/functions/commonmark.render.man.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - - - CommonMark\Render\Man - Rendering - - - - &reftitle.description; - - stringCommonMark\Render\Man - CommonMark\Nodenode - intoptions - intwidth - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - node - - - - - - - - options - - - Una máscara de: - - - - - CommonMark\Render\Normal - (integer) - - - - - - - - - CommonMark\Render\SourcePos - (integer) - - - - - - - - - CommonMark\Render\HardBreaks - (integer) - - - - - - - - - CommonMark\Render\Safe - (integer) - - - - - - - - - CommonMark\Render\NoBreaks - (integer) - - - - - - - - - - - width - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/cmark/functions/commonmark.render.xml b/reference/cmark/functions/commonmark.render.xml deleted file mode 100644 index 1ac4b6ea7..000000000 --- a/reference/cmark/functions/commonmark.render.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - - - CommonMark\Render - Rendering - - - - &reftitle.description; - - stringCommonMark\Render - CommonMark\Nodenode - intoptions - intwidth - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - node - - - - - - - - options - - - Una máscara de: - - - - - CommonMark\Render\Normal - (integer) - - - - - - - - - CommonMark\Render\SourcePos - (integer) - - - - - - - - - CommonMark\Render\HardBreaks - (integer) - - - - - - - - - CommonMark\Render\Safe - (integer) - - - - - - - - - CommonMark\Render\NoBreaks - (integer) - - - - - - - - - - - width - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/cmark/functions/commonmark.render.xml.xml b/reference/cmark/functions/commonmark.render.xml.xml deleted file mode 100644 index 166a458c6..000000000 --- a/reference/cmark/functions/commonmark.render.xml.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - - - CommonMark\Render\XML - Rendering - - - - &reftitle.description; - - stringCommonMark\Render\XML - CommonMark\Nodenode - intoptions - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - node - - - - - - - - options - - - Una máscara de: - - - - - CommonMark\Render\Normal - (integer) - - - - - - - - - CommonMark\Render\SourcePos - (integer) - - - - - - - - - CommonMark\Render\HardBreaks - (integer) - - - - - - - - - CommonMark\Render\Safe - (integer) - - - - - - - - - CommonMark\Render\NoBreaks - (integer) - - - - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/cmark/reference.xml b/reference/cmark/reference.xml deleted file mode 100644 index d41416971..000000000 --- a/reference/cmark/reference.xml +++ /dev/null @@ -1,35 +0,0 @@ - - - - - CommonMark &Functions; - - &reference.cmark.functions.commonmark.parse; - &reference.cmark.functions.commonmark.render; - &reference.cmark.functions.commonmark.render.html; - &reference.cmark.functions.commonmark.render.latex; - &reference.cmark.functions.commonmark.render.man; - &reference.cmark.functions.commonmark.render.xml; - - - - diff --git a/reference/cmark/setup.xml b/reference/cmark/setup.xml deleted file mode 100644 index 75ab0c709..000000000 --- a/reference/cmark/setup.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - &reftitle.setup; - -
- &reftitle.required; - - The CommonMark extension requires the (C) reference implementation of cmark. - -
- -
- &reftitle.install; - - The CommonMark extension releases are hosted by PECL and source is hosted on - github, - the easiest route to installation is the normal PECL route: - &url.pecl.package;cmark. - - - Windows users can download prebuilt release binaries from the PECL website. - - - - Windows users need to take the additional step of adding cmark.dll (distributed with Windows releases) to their PATH. - - - -
- - - - diff --git a/reference/cmark/versions.xml b/reference/cmark/versions.xml deleted file mode 100644 index a6807e616..000000000 --- a/reference/cmark/versions.xml +++ /dev/null @@ -1,261 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/com/versions.xml b/reference/com/versions.xml deleted file mode 100644 index 914d0e1cb..000000000 --- a/reference/com/versions.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/componere/versions.xml b/reference/componere/versions.xml deleted file mode 100644 index e84d80577..000000000 --- a/reference/componere/versions.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/ctype/versions.xml b/reference/ctype/versions.xml deleted file mode 100644 index 6090f61e5..000000000 --- a/reference/ctype/versions.xml +++ /dev/null @@ -1,39 +0,0 @@ - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/cubrid/versions.xml b/reference/cubrid/versions.xml deleted file mode 100644 index bdcd695fd..000000000 --- a/reference/cubrid/versions.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/curl/versions.xml b/reference/curl/versions.xml deleted file mode 100644 index 9f570ec33..000000000 --- a/reference/curl/versions.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/datetime/versions.xml b/reference/datetime/versions.xml deleted file mode 100644 index 74a8b4bed..000000000 --- a/reference/datetime/versions.xml +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/dba/versions.xml b/reference/dba/versions.xml deleted file mode 100644 index bd5d85fb5..000000000 --- a/reference/dba/versions.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/dbase/versions.xml b/reference/dbase/versions.xml deleted file mode 100644 index eb0c1e0a3..000000000 --- a/reference/dbase/versions.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/dom/versions.xml b/reference/dom/versions.xml deleted file mode 100644 index 63d72c7ae..000000000 --- a/reference/dom/versions.xml +++ /dev/null @@ -1,175 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/enchant/versions.xml b/reference/enchant/versions.xml deleted file mode 100644 index 74a713b03..000000000 --- a/reference/enchant/versions.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/errorfunc/versions.xml b/reference/errorfunc/versions.xml deleted file mode 100644 index f5f79382c..000000000 --- a/reference/errorfunc/versions.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/exec/versions.xml b/reference/exec/versions.xml deleted file mode 100644 index bb14c284a..000000000 --- a/reference/exec/versions.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - - - - - - - - - - - - - - - - - diff --git a/reference/exif/versions.xml b/reference/exif/versions.xml deleted file mode 100644 index 847007472..000000000 --- a/reference/exif/versions.xml +++ /dev/null @@ -1,33 +0,0 @@ - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/fileinfo/versions.xml b/reference/fileinfo/versions.xml deleted file mode 100644 index ec661091c..000000000 --- a/reference/fileinfo/versions.xml +++ /dev/null @@ -1,35 +0,0 @@ - - - - - - - - - - - - - - diff --git a/reference/filesystem/versions.xml b/reference/filesystem/versions.xml deleted file mode 100644 index de51e5ee8..000000000 --- a/reference/filesystem/versions.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/filter/versions.xml b/reference/filter/versions.xml deleted file mode 100644 index 5dd320263..000000000 --- a/reference/filter/versions.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - - - - - - - - - - - - - diff --git a/reference/ftp/versions.xml b/reference/ftp/versions.xml deleted file mode 100644 index 455f4eb7b..000000000 --- a/reference/ftp/versions.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/funchand/versions.xml b/reference/funchand/versions.xml deleted file mode 100644 index 820cd3765..000000000 --- a/reference/funchand/versions.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/gearman/versions.xml b/reference/gearman/versions.xml deleted file mode 100644 index b1813b92f..000000000 --- a/reference/gearman/versions.xml +++ /dev/null @@ -1,232 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/gmagick/versions.xml b/reference/gmagick/versions.xml deleted file mode 100644 index 9e320ba20..000000000 --- a/reference/gmagick/versions.xml +++ /dev/null @@ -1,227 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/gnupg/versions.xml b/reference/gnupg/versions.xml deleted file mode 100644 index 04a3f2a15..000000000 --- a/reference/gnupg/versions.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/iconv/versions.xml b/reference/iconv/versions.xml deleted file mode 100644 index 7e94853a1..000000000 --- a/reference/iconv/versions.xml +++ /dev/null @@ -1,39 +0,0 @@ - - - - - - - - - - - - - - - - - - diff --git a/reference/igbinary/book.xml b/reference/igbinary/book.xml deleted file mode 100644 index 3e531f0b8..000000000 --- a/reference/igbinary/book.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - Igbinary - Igbinary - - - &reftitle.intro; - - Igbinary is a drop in replacement for the standard PHP serializer. - Instead of the time and space consuming textual representation used by PHP's serialize, - igbinary stores PHP data structures in a compact binary form. - Memory savings are significant when using memcached, APCu, - or similar memory based storages for serialized data. - The typical reduction in storage requirements are around 50%. - The exact percentage depends on the data. - - - - &reference.igbinary.setup; - &reference.igbinary.reference; - - - diff --git a/reference/igbinary/entities.functions.xml b/reference/igbinary/entities.functions.xml deleted file mode 100644 index 59413f1c7..000000000 --- a/reference/igbinary/entities.functions.xml +++ /dev/null @@ -1,2 +0,0 @@ -&reference.igbinary.functions.igbinary-serialize; -&reference.igbinary.functions.igbinary-unserialize; diff --git a/reference/igbinary/functions/igbinary-serialize.xml b/reference/igbinary/functions/igbinary-serialize.xml deleted file mode 100644 index a777a85e1..000000000 --- a/reference/igbinary/functions/igbinary-serialize.xml +++ /dev/null @@ -1,158 +0,0 @@ - - - - igbinary_serialize - Generates a compact, storable binary representation of a value - - - - &reftitle.description; - - stringfalseigbinary_serialize - mixedvalue - - - Generates a storable representation of a value. - - - This is useful for storing or passing PHP values around without - losing their type and structure. - - - To make the serialized string into a PHP value again, - igbinary_unserialize can be used. - - - - - &reftitle.parameters; - - - value - - - The value to be serialized. igbinary_serialize - handles all types, except the resource-type and some objects (see note below). - Even &array;s that contain references to itself can be igbinary_serialized. - Circular references inside the &array; or &object; that is being serializend will also be stored. - Any other reference will be lost. - - - When serializing objects, igbinary will attempt to call the member functions - __serialize() or - __sleep() prior to serialization. - This is to allow the object to do any last minute clean-up, etc. prior - to being serialized. Likewise, when the object is restored using - igbinary_unserialize the __unserialize() or - __wakeup() member function is called. - - - - Private members of &object;s have the class name prepended to the member - name; protected members have a '*' prepended to the member name. - These prepended values have null bytes on either side. - - - - - - - - - &reftitle.returnvalues; - - Returns a string containing a byte-stream representation of - value that can be stored anywhere. - - - Note that this is a binary string which can include any byte value, and needs - to be stored and handled as such. For example, - igbinary_serialize output should generally be stored in a BLOB - field in a database, rather than a CHAR or TEXT field. - - - - - &reftitle.examples; - - - <function>igbinary_serialize</function> example - - -]]> - - &example.outputs; - - 'test', - 1 => 'test', -) -]]> - - - - - - - &reftitle.notes; - - - Note that many built-in PHP objects cannot be serialized. However, those with - this ability either implement the Serializable interface or the - magic __serialize()/__unserialize() - or __sleep()/__wakeup() methods. If an - internal class does not fulfill any of those requirements, it cannot reliably be - serialized with any serializer. - - - There are some historical exceptions to the above rule, where some internal objects - could be serialized without implementing the interface or exposing the methods. - - - - - - &reftitle.seealso; - - - serialize - igbinary_unserialize - var_export - json_encode - Serializing Objects - __sleep() - __wakeup() - __serialize() - __unserialize() - - - - - - diff --git a/reference/igbinary/functions/igbinary-unserialize.xml b/reference/igbinary/functions/igbinary-unserialize.xml deleted file mode 100644 index 71a6f1b60..000000000 --- a/reference/igbinary/functions/igbinary-unserialize.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - igbinary_unserialize - - Creates a PHP value from a stored representation from igbinary_serialize - - - - - &reftitle.description; - - mixedigbinary_unserialize - stringstr - - - igbinary_unserialize takes a single serialized variable from - igbinary_serialize and converts it back into a PHP value. - - - - Untrusted user input must not be passed to igbinary_unserialize. - Unserialization can result in code being loaded and executed due to object - instantiation and autoloading, and a malicious user may be able to exploit - this. Instead a safe, standard data interchange format such as JSON (via - json_decode and json_encode) should be used, - if serialized data needs to be passed to a client. - - - If there is the need to unserialize externally-stored serialized data, - hash_hmac can be used for data validation. - It is important to ensure that nobody has tampered with the data. - - - - - The igbinary serialization format does not provide a way to distinguish between different reference - groups for the same value. All PHP references to a given value as treated as part - of the same reference group when unserialized, - even if they were parts of difference reference groups when serialized. - - - - - - &reftitle.parameters; - - - str - - - The serialized string generated by igbinary_serialize. - - - If the value being unserialized is an &object;, after successfully - reconstructing the object igbinary will automatically attempt to call the - __unserialize() or - __wakeup() methods (if one exists). - - - - unserialize_callback_func directive - - It is possible to set a callback function which will be called, - if an undefined class should be instantiated during unserializing. - (to prevent getting an incomplete object __PHP_Incomplete_Class.) - The &php.ini;, ini_set or &htaccess; can be used - to define unserialize_callback_func. - Everytime an undefined class should be instantiated, it will be called. - To disable this feature this setting should be emptied. - - - - - - - - - - &reftitle.returnvalues; - - The converted value is returned, and can be a bool, - int, float, string, - array, object, or null. - - - In case the passed string is not unserializeable, &false; is returned and - E_NOTICE or E_WARNING is issued. - - - - - &reftitle.errors; - - Objects may throw Throwables in their unserialization handlers. - - - - - &reftitle.notes; - - - &null; or &false; is returned both in the case of an error and if unserializing - the serialized &null; or &false; value. It is possible to catch this special case by - comparing str with - igbinary_serialize(null) or igbinary_serialize(false) - or by catching the issued E_NOTICE. - - - - - - &reftitle.seealso; - - - unserialize - json_encode - json_decode - hash_hmac - igbinary_serialize - Autoloading Classes - unserialize_callback_func - __wakeup() - __serialize() - __unserialize() - - - - - diff --git a/reference/igbinary/ini.xml b/reference/igbinary/ini.xml deleted file mode 100644 index 632c7ec11..000000000 --- a/reference/igbinary/ini.xml +++ /dev/null @@ -1,102 +0,0 @@ - -
- &reftitle.runtime; - &extension.runtime; - - - Igbinary &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - igbinary.compact_strings - 1 - PHP_INI_ALL - - - - -
- - Session Configuration Options Affecting Igbinary Behavior - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - session.save_handler - "files" - PHP_INI_ALL - - - - -
- &ini.php.constants; - - - &ini.descriptions.title; - - - - - - igbinary.compact_strings - bool - - - - Enable or disable compacting of duplicate strings. - The default is On. - - - - - - - session.save_handler - string - - - - Igbinary is used as session handler by setting this value to igbinary. - - - - - - -
- diff --git a/reference/igbinary/reference.xml b/reference/igbinary/reference.xml deleted file mode 100644 index 58ac4fc53..000000000 --- a/reference/igbinary/reference.xml +++ /dev/null @@ -1,27 +0,0 @@ - - - Igbinary &Functions; - - &reference.igbinary.entities.functions; - - - diff --git a/reference/igbinary/versions.xml b/reference/igbinary/versions.xml deleted file mode 100644 index 49a9cddc7..000000000 --- a/reference/igbinary/versions.xml +++ /dev/null @@ -1,27 +0,0 @@ - - - - - - - - diff --git a/reference/image/versions.xml b/reference/image/versions.xml deleted file mode 100644 index 1eba1d5b5..000000000 --- a/reference/image/versions.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/imagick/versions.xml b/reference/imagick/versions.xml deleted file mode 100644 index db4386c15..000000000 --- a/reference/imagick/versions.xml +++ /dev/null @@ -1,583 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/imap/versions.xml b/reference/imap/versions.xml deleted file mode 100644 index 9bad377a0..000000000 --- a/reference/imap/versions.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/inotify/versions.xml b/reference/inotify/versions.xml deleted file mode 100644 index 4510ced44..000000000 --- a/reference/inotify/versions.xml +++ /dev/null @@ -1,34 +0,0 @@ - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/json/versions.xml b/reference/json/versions.xml deleted file mode 100644 index 2fbbb86f5..000000000 --- a/reference/json/versions.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - - - - - - diff --git a/reference/lzf/versions.xml b/reference/lzf/versions.xml deleted file mode 100644 index 8787e6e4b..000000000 --- a/reference/lzf/versions.xml +++ /dev/null @@ -1,33 +0,0 @@ - - - - - - - - - - - - diff --git a/reference/mail/versions.xml b/reference/mail/versions.xml deleted file mode 100644 index 8b8a55139..000000000 --- a/reference/mail/versions.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - - - - - - diff --git a/reference/memcache/versions.xml b/reference/memcache/versions.xml deleted file mode 100644 index 0da3c3c7c..000000000 --- a/reference/memcache/versions.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/misc/versions.xml b/reference/misc/versions.xml deleted file mode 100644 index 35cbfbc62..000000000 --- a/reference/misc/versions.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/mongodb/bson/timestamp.xml b/reference/mongodb/bson/timestamp.xml deleted file mode 100644 index b81eccc4b..000000000 --- a/reference/mongodb/bson/timestamp.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - La clase MongoDB\BSON\Timestamp - MongoDB\BSON\Timestamp - - - - -
- &reftitle.intro; - - Represents a - BSON timestamp, - which is an internal MongoDB type not intended for general date storage. - -
- - -
- &reftitle.classsynopsis; - - - - MongoDB\BSON\Timestamp - - - - - MongoDB\BSON\Timestamp - - - - MongoDB\BSON\Type - - - - - &Methods; - - - - -
- - - - &reference.mongodb.bson.entities.timestamp; - - - - diff --git a/reference/mongodb/functions/bson/fromjson.xml b/reference/mongodb/functions/bson/fromjson.xml deleted file mode 100644 index 3c819a146..000000000 --- a/reference/mongodb/functions/bson/fromjson.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - MongoDB\BSON\fromJSON - Returns the BSON representation of a JSON value - - - - &reftitle.description; - - stringMongoDB\BSON\fromJSON - stringjson - - - Converts an - extended JSON - string to its BSON representation. - - - - - &reftitle.parameters; - - - json (string) - - - JSON value to be converted. - - - - - - - - &reftitle.returnvalues; - - The serialized BSON document as a binary string. - - - - - &reftitle.errors; - - - Throws - MongoDB\Driver\Exception\UnexpectedValueException if - the JSON value cannot be converted to BSON (e.g. due to a syntax error). - - - - - - &reftitle.examples; - - <function>MongoDB\BSON\fromJSON</function> example - - -]]> - - &example.outputs; - - - object(MongoDB\BSON\ObjectId)#1 (1) { - ["oid"]=> - string(24) "563143b280d2387c91807965" - } -} -]]> - - - - - - - &reftitle.seealso; - - MongoDB\BSON\toJSON - MongoDB Extended JSON - MongoDB BSON - - - - - - diff --git a/reference/mongodb/functions/bson/fromphp.xml b/reference/mongodb/functions/bson/fromphp.xml deleted file mode 100644 index e3605ffc2..000000000 --- a/reference/mongodb/functions/bson/fromphp.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - MongoDB\BSON\fromPHP - Returns the BSON representation of a PHP value - - - - &reftitle.description; - - stringMongoDB\BSON\fromPHP - arrayobjectvalue - - - Serializes a PHP array or object (e.g. document) to its - BSON representation. The - returned binary string will describe a BSON document. - - - - - &reftitle.parameters; - - - value (arrayobject) - - - PHP value to be serialized. - - - - - - - - &reftitle.returnvalues; - - The serialized BSON document as a binary string. - - - - - &reftitle.errors; - - - Throws - MongoDB\Driver\Exception\UnexpectedValueException if - the PHP value cannot be converted to BSON. Possible reasons include, but are - not limited to, encountering an unexpected - MongoDB\BSON\Type instance or - MongoDB\BSON\Serializable::bsonSerialize failing to - return an array or stdClass. - - - - - - &reftitle.examples; - - <function>MongoDB\BSON\fromPHP</function> example - - 1]); -echo bin2hex($bson), "\n"; - -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - MongoDB\BSON\toPHP - MongoDB BSON - - - - - - - diff --git a/reference/mongodb/functions/bson/tocanonicalextendedjson.xml b/reference/mongodb/functions/bson/tocanonicalextendedjson.xml deleted file mode 100644 index 81d6bf6ff..000000000 --- a/reference/mongodb/functions/bson/tocanonicalextendedjson.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - - MongoDB\BSON\toCanonicalExtendedJSON - Returns the Canonical Extended JSON representation of a BSON value - - - - &reftitle.description; - - stringMongoDB\BSON\toCanonicalExtendedJSON - stringbson - - - Converts a BSON string to its - Canonical Extended JSON - representation. The canonical format prefers type fidelity at the expense of - concise output and is most suited for producing output that can be converted - back to BSON without any loss of type information (e.g. numeric types will - remain differentiated). - - - - - &reftitle.parameters; - - - bson (string) - - - BSON value to be converted. - - - - - - - - &reftitle.returnvalues; - - The converted JSON value. - - - - - &reftitle.errors; - - &mongodb.throws.bson.unexpected; - - - - - &reftitle.examples; - - <function>MongoDB\BSON\toCanonicalExtendedJSON</function> example - - null ], - [ 'boolean' => true ], - [ 'string' => 'foo' ], - [ 'int32' => 123 ], - [ 'int64' => 4294967295 ], - [ 'double' => 1.0, ], - [ 'nan' => NAN ], - [ 'pos_inf' => INF ], - [ 'neg_inf' => -INF ], - [ 'array' => [ 'foo', 'bar' ]], - [ 'document' => [ 'foo' => 'bar' ]], - [ 'oid' => new MongoDB\BSON\ObjectId('56315a7c6118fd1b920270b1') ], - [ 'dec128' => new MongoDB\BSON\Decimal128('1234.5678') ], - [ 'binary' => new MongoDB\BSON\Binary('foo', MongoDB\BSON\Binary::TYPE_GENERIC) ], - [ 'date' => new MongoDB\BSON\UTCDateTime(1445990400000) ], - [ 'timestamp' => new MongoDB\BSON\Timestamp(1234, 5678) ], - [ 'regex' => new MongoDB\BSON\Regex('pattern', 'i') ], - [ 'code' => new MongoDB\BSON\Javascript('function() { return 1; }') ], - [ 'code_ws' => new MongoDB\BSON\Javascript('function() { return a; }', ['a' => 1]) ], - [ 'minkey' => new MongoDB\BSON\MinKey ], - [ 'maxkey' => new MongoDB\BSON\MaxKey ], -]; - -foreach ($documents as $document) { - $bson = MongoDB\BSON\fromPHP($document); - echo MongoDB\BSON\toCanonicalExtendedJSON($bson), "\n"; -} - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\BSON\fromJSON - MongoDB\BSON\toRelaxedExtendedJSON - Extended JSON Specification - MongoDB BSON - - - - - - diff --git a/reference/mongodb/functions/bson/tojson.xml b/reference/mongodb/functions/bson/tojson.xml deleted file mode 100644 index 4af3dd02e..000000000 --- a/reference/mongodb/functions/bson/tojson.xml +++ /dev/null @@ -1,180 +0,0 @@ - - - - - - MongoDB\BSON\toJSON - Returns the Legacy Extended JSON representation of a BSON value - - - - &reftitle.description; - - stringMongoDB\BSON\toJSON - stringbson - - - Converts a BSON string to its - Legacy Extended JSON - representation. - - - - There exist several JSON formats for representing BSON. This function - implements the "strict mode" defined in - MongoDB Extended JSON, - which has been superseded by the canonical and relaxed formats defined in - the - Extended JSON Specification - and implemented by MongoDB\BSON\toCanonicalExtendedJSON - and MongoDB\BSON\toRelaxedExtendedJSON, respectively. - - - - - JSON does not support - NAN and - INF and - MongoDB's Legacy Extended JSON format does not define an alternative - representation for these values - (libbson will output - nan and inf literals, which may not be - parsed as valid JSON). If you are working with BSON that may contain - non-finite numbers, please use - MongoDB\BSON\toCanonicalExtendedJSON or - MongoDB\BSON\toRelaxedExtendedJSON. - - - - - - &reftitle.parameters; - - - bson (string) - - - BSON value to be converted. - - - - - - - - &reftitle.returnvalues; - - The converted JSON value. - - - - - &reftitle.errors; - - &mongodb.throws.bson.unexpected; - - - - - &reftitle.examples; - - <function>MongoDB\BSON\toJSON</function> example - - null ], - [ 'boolean' => true ], - [ 'string' => 'foo' ], - [ 'int32' => 123 ], - [ 'int64' => 4294967295 ], - [ 'double' => 1.0, ], - [ 'nan' => NAN ], - [ 'pos_inf' => INF ], - [ 'neg_inf' => -INF ], - [ 'array' => [ 'foo', 'bar' ]], - [ 'document' => [ 'foo' => 'bar' ]], - [ 'oid' => new MongoDB\BSON\ObjectId('56315a7c6118fd1b920270b1') ], - [ 'dec128' => new MongoDB\BSON\Decimal128('1234.5678') ], - [ 'binary' => new MongoDB\BSON\Binary('foo', MongoDB\BSON\Binary::TYPE_GENERIC) ], - [ 'date' => new MongoDB\BSON\UTCDateTime(1445990400000) ], - [ 'timestamp' => new MongoDB\BSON\Timestamp(1234, 5678) ], - [ 'regex' => new MongoDB\BSON\Regex('pattern', 'i') ], - [ 'code' => new MongoDB\BSON\Javascript('function() { return 1; }') ], - [ 'code_ws' => new MongoDB\BSON\Javascript('function() { return a; }', ['a' => 1]) ], - [ 'minkey' => new MongoDB\BSON\MinKey ], - [ 'maxkey' => new MongoDB\BSON\MaxKey ], -]; - -foreach ($documents as $document) { - $bson = MongoDB\BSON\fromPHP($document); - echo MongoDB\BSON\toJSON($bson), "\n"; -} - -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - MongoDB\BSON\fromJSON - MongoDB\BSON\toCanonicalExtendedJSON - MongoDB\BSON\toRelaxedExtendedJSON - MongoDB Extended JSON - MongoDB BSON - - - - - - diff --git a/reference/mongodb/functions/bson/tophp.xml b/reference/mongodb/functions/bson/tophp.xml deleted file mode 100644 index b75d878d1..000000000 --- a/reference/mongodb/functions/bson/tophp.xml +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - MongoDB\BSON\toPHP - Returns the PHP representation of a BSON value - - - - &reftitle.description; - - arrayobjectMongoDB\BSON\toPHP - stringbson - arraytypeMaparray() - - - Unserializes a BSON document (i.e. binary string) to its PHP representation. - The typeMap paramater may be used to control the PHP - types used for converting BSON arrays and documents (both root and embedded). - - &mongodb.warning.duplicate-keys; - - - - &reftitle.parameters; - - - bson (string) - - - BSON value to be unserialized. - - - - &mongodb.parameter.typeMap; - - - - - &reftitle.returnvalues; - - The unserialized PHP value. - - - - - &reftitle.errors; - - - Throws - MongoDB\Driver\Exception\InvalidArgumentException if - a class in the type map cannot be instantiated or does not implement - MongoDB\BSON\Unserializable. - - &mongodb.throws.bson.unexpected; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 1.4.0 - - - If the input contains an unsupported, deprecated BSON type, the - driver will now no longer log a warning to the debug log, but instead - will create an object representing this type. - - - - - PECL mongodb 1.3.2 - - - MongoDB\Driver\Exception\UnexpectedValueException - is no longer thrown if the input contains an unsupported, deprecated - BSON type. Such types will be ignored (as they were in versions before - 1.3.0), although the driver will now log a warning to the debug log - (see: mongodb.debug). - - - - - PECL mongodb 1.3.0 - - - MongoDB\Driver\Exception\UnexpectedValueException - is thrown if the input contains an unsupported, deprecated BSON type. - Previously, such types were ignored. - - - - - - - - - - - &reftitle.examples; - - <function>MongoDB\BSON\toPHP</function> example - - -]]> - - &example.outputs; - - - int(1) -} -]]> - - - - - - - &reftitle.seealso; - - MongoDB\BSON\fromPHP - MongoDB BSON - - - - - - - diff --git a/reference/mongodb/functions/bson/torelaxedextendedjson.xml b/reference/mongodb/functions/bson/torelaxedextendedjson.xml deleted file mode 100644 index 13b7488b0..000000000 --- a/reference/mongodb/functions/bson/torelaxedextendedjson.xml +++ /dev/null @@ -1,153 +0,0 @@ - - - - - - MongoDB\BSON\toRelaxedExtendedJSON - Returns the Relaxed Extended JSON representation of a BSON value - - - - &reftitle.description; - - stringMongoDB\BSON\toRelaxedExtendedJSON - stringbson - - - Converts a BSON string to its - Relaxed Extended JSON - representation. The relaxed format prefers use of JSON type primitives at the - expense of type fidelity and is most suited for producing output that can be - easily consumed by web APIs and humans. - - - - - &reftitle.parameters; - - - bson (string) - - - BSON value to be converted. - - - - - - - - &reftitle.returnvalues; - - The converted JSON value. - - - - - &reftitle.errors; - - &mongodb.throws.bson.unexpected; - - - - - &reftitle.examples; - - <function>MongoDB\BSON\toRelaxedExtendedJSON</function> example - - null ], - [ 'boolean' => true ], - [ 'string' => 'foo' ], - [ 'int32' => 123 ], - [ 'int64' => 4294967295 ], - [ 'double' => 1.0, ], - [ 'nan' => NAN ], - [ 'pos_inf' => INF ], - [ 'neg_inf' => -INF ], - [ 'array' => [ 'foo', 'bar' ]], - [ 'document' => [ 'foo' => 'bar' ]], - [ 'oid' => new MongoDB\BSON\ObjectId('56315a7c6118fd1b920270b1') ], - [ 'dec128' => new MongoDB\BSON\Decimal128('1234.5678') ], - [ 'binary' => new MongoDB\BSON\Binary('foo', MongoDB\BSON\Binary::TYPE_GENERIC) ], - [ 'date' => new MongoDB\BSON\UTCDateTime(1445990400000) ], - [ 'timestamp' => new MongoDB\BSON\Timestamp(1234, 5678) ], - [ 'regex' => new MongoDB\BSON\Regex('pattern', 'i') ], - [ 'code' => new MongoDB\BSON\Javascript('function() { return 1; }') ], - [ 'code_ws' => new MongoDB\BSON\Javascript('function() { return a; }', ['a' => 1]) ], - [ 'minkey' => new MongoDB\BSON\MinKey ], - [ 'maxkey' => new MongoDB\BSON\MaxKey ], -]; - -foreach ($documents as $document) { - $bson = MongoDB\BSON\fromPHP($document); - echo MongoDB\BSON\toRelaxedExtendedJSON($bson), "\n"; -} - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\BSON\fromJSON - MongoDB\BSON\toCanonicalExtendedJSON - Extended JSON - MongoDB BSON - - - - - - diff --git a/reference/mongodb/functions/driver/entities.monitoring.xml b/reference/mongodb/functions/driver/entities.monitoring.xml deleted file mode 100644 index b43f115c6..000000000 --- a/reference/mongodb/functions/driver/entities.monitoring.xml +++ /dev/null @@ -1,2 +0,0 @@ -&reference.mongodb.functions.driver.monitoring.addsubscriber; -&reference.mongodb.functions.driver.monitoring.removesubscriber; diff --git a/reference/mongodb/functions/driver/monitoring/addsubscriber.xml b/reference/mongodb/functions/driver/monitoring/addsubscriber.xml deleted file mode 100644 index 242e3ca3a..000000000 --- a/reference/mongodb/functions/driver/monitoring/addsubscriber.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\addSubscriber - Registers a monitoring event subscriber globally - - - - &reftitle.description; - - voidMongoDB\Driver\Monitoring\addSubscriber - MongoDB\Driver\Monitoring\Subscribersubscriber - - - Registers a monitoring event subscriber globally. The subscriber will be - notified of all events in the driver for any Manager. - - - - If subscriber is already registered globally, this - function is a no-op. If subscriber is also registered - with one or more Managers, it will still only be notified once of each event - for each Manager. - - - - - - &reftitle.parameters; - - - subscriber (MongoDB\Driver\Monitoring\Subscriber) - - - A monitoring event subscriber to register globally. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\removeSubscriber - MongoDB\Driver\Monitoring\Subscriber - MongoDB\Driver\Monitoring\CommandSubscriber - MongoDB\Driver\Manager::addSubscriber - - - - - - - diff --git a/reference/mongodb/functions/driver/monitoring/removesubscriber.xml b/reference/mongodb/functions/driver/monitoring/removesubscriber.xml deleted file mode 100644 index a26c8b07e..000000000 --- a/reference/mongodb/functions/driver/monitoring/removesubscriber.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\removeSubscriber - Unregisters a monitoring event subscriber globally - - - - &reftitle.description; - - voidMongoDB\Driver\Monitoring\removeSubscriber - MongoDB\Driver\Monitoring\Subscribersubscriber - - - Unregisters a monitoring event subscriber globally. - - - - If subscriber is not already registered globally, - this function is a no-op. - - - - - - &reftitle.parameters; - - - subscriber (MongoDB\Driver\Monitoring\Subscriber) - - - A monitoring event subscriber to unregister globally. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\addSubscriber - MongoDB\Driver\Monitoring\Subscriber - MongoDB\Driver\Monitoring\CommandSubscriber - MongoDB\Driver\Manager::removeSubscriber - - - - - - - diff --git a/reference/mongodb/functions/entities.bson.xml b/reference/mongodb/functions/entities.bson.xml deleted file mode 100644 index 4ea8911b2..000000000 --- a/reference/mongodb/functions/entities.bson.xml +++ /dev/null @@ -1,6 +0,0 @@ -&reference.mongodb.functions.bson.fromjson; -&reference.mongodb.functions.bson.fromphp; -&reference.mongodb.functions.bson.tocanonicalextendedjson; -&reference.mongodb.functions.bson.tojson; -&reference.mongodb.functions.bson.tophp; -&reference.mongodb.functions.bson.torelaxedextendedjson; diff --git a/reference/mongodb/functions/entities.driver.xml b/reference/mongodb/functions/entities.driver.xml deleted file mode 100644 index 5f0e9b586..000000000 --- a/reference/mongodb/functions/entities.driver.xml +++ /dev/null @@ -1 +0,0 @@ -&reference.mongodb.functions.driver.entities.monitoring; diff --git a/reference/mongodb/images/driver_arch.png b/reference/mongodb/images/driver_arch.png deleted file mode 100644 index 74064bf78..000000000 Binary files a/reference/mongodb/images/driver_arch.png and /dev/null differ diff --git a/reference/mongodb/mongodb/driver/bulkwrite.xml b/reference/mongodb/mongodb/driver/bulkwrite.xml deleted file mode 100644 index 5d4ab3708..000000000 --- a/reference/mongodb/mongodb/driver/bulkwrite.xml +++ /dev/null @@ -1,225 +0,0 @@ - - - - - - The MongoDB\Driver\BulkWrite class - MongoDB\Driver\BulkWrite - - - - -
- &reftitle.intro; - - The MongoDB\Driver\BulkWrite collects one or more - write operations that should be sent to the server. After adding any - number of insert, update, and delete operations, the collection may be - executed via - MongoDB\Driver\Manager::executeBulkWrite. - - - Write operations may either be ordered (default) or unordered. Ordered write - operations are sent to the server, in the order provided, for serial - execution. If a write fails, any remaining operations will be aborted. - Unordered operations are sent to the server in an arbitrary order - where they may be executed in parallel. Any errors that occur are reported - after all operations have been attempted. - -
- - -
- &reftitle.classsynopsis; - - - - MongoDB\Driver\BulkWrite - - - - final - - MongoDB\Driver\BulkWrite - - - - Countable - - - - - &Methods; - - - - -
- -
- &reftitle.examples; - - - Mixed write operations are grouped by type - - Mixed write operations (i.e. inserts, updates, and deletes) will be - assembled into typed write commands to be sent sequentially to the server. - - - true]); -$bulk->insert(['_id' => 1, 'x' => 1]); -$bulk->insert(['_id' => 2, 'x' => 2]); -$bulk->update(['x' => 2], ['$set' => ['x' => 1]]); -$bulk->insert(['_id' => 3, 'x' => 3]); -$bulk->delete(['x' => 1]); - -?> -]]> - - - Will result in four write commands (i.e. roundtrips) being executed. Since - the operations are ordered, the third insertion cannot be sent until the - preceding update is executed. - - - - Ordered write operations causing an error - - true]); -$bulk->delete([]); -$bulk->insert(['_id' => 1]); -$bulk->insert(['_id' => 2]); -$bulk->insert(['_id' => 3, 'hello' => 'world']); -$bulk->update(['_id' => 3], ['$set' => ['hello' => 'earth']]); -$bulk->insert(['_id' => 4, 'hello' => 'pluto']); -$bulk->update(['_id' => 4], ['$set' => ['hello' => 'moon']]); -$bulk->insert(['_id' => 3]); -$bulk->insert(['_id' => 4]); -$bulk->insert(['_id' => 5]); - -$manager = new MongoDB\Driver\Manager('mongodb://localhost:27017'); -$writeConcern = new MongoDB\Driver\WriteConcern(MongoDB\Driver\WriteConcern::MAJORITY, 1000); - -try { - $result = $manager->executeBulkWrite('db.collection', $bulk, $writeConcern); -} catch (MongoDB\Driver\Exception\BulkWriteException $e) { - $result = $e->getWriteResult(); - - // Check if the write concern could not be fulfilled - if ($writeConcernError = $result->getWriteConcernError()) { - printf("%s (%d): %s\n", - $writeConcernError->getMessage(), - $writeConcernError->getCode(), - var_export($writeConcernError->getInfo(), true) - ); - } - - // Check if any write operations did not complete at all - foreach ($result->getWriteErrors() as $writeError) { - printf("Operation#%d: %s (%d)\n", - $writeError->getIndex(), - $writeError->getMessage(), - $writeError->getCode() - ); - } -} catch (MongoDB\Driver\Exception\Exception $e) { - printf("Other error: %s\n", $e->getMessage()); - exit; -} - -printf("Inserted %d document(s)\n", $result->getInsertedCount()); -printf("Updated %d document(s)\n", $result->getModifiedCount()); - -?> -]]> - - - &example.outputs; - - - - - If the write concern could not be fullfilled, the example above would output - something like: - - - true, -) -Operation#7: E11000 duplicate key error index: databaseName.collectionName.$_id_ dup key: { : 3 } (11000) -Inserted 4 document(s) -Updated 2 document(s) -]]> - - - If we execute the example above, but allow for unordered writes: - - - false]); -/* ... */ - -?> -]]> - - &example.outputs; - - - -
- -
- &reftitle.seealso; - - MongoDB\Driver\Manager::executeBulkWrite - MongoDB\Driver\WriteResult - MongoDB\Driver\WriteConcern - MongoDB\Driver\WriteConcernError - MongoDB\Driver\WriteError - -
- - - - &reference.mongodb.mongodb.driver.entities.bulkwrite; - - - - diff --git a/reference/mongodb/mongodb/driver/bulkwrite/construct.xml b/reference/mongodb/mongodb/driver/bulkwrite/construct.xml deleted file mode 100644 index a6b866382..000000000 --- a/reference/mongodb/mongodb/driver/bulkwrite/construct.xml +++ /dev/null @@ -1,212 +0,0 @@ - - - - - - MongoDB\Driver\BulkWrite::__construct - Create a new BulkWrite - - - - &reftitle.description; - - public MongoDB\Driver\BulkWrite::__construct - arrayoptions - - - Constructs a new MongoDB\Driver\BulkWrite, which is a - mutable object to which one or more write operations may be added. The - write(s) may then be executed with - MongoDB\Driver\Manager::executeBulkWrite. - - - - - &reftitle.parameters; - - - options (array) - - - - options - - - - Option - Type - Description - Default - - - - - bypassDocumentValidation - bool - - - If &true;, allows insert and update operations to circumvent - document level validation. - - - This option is available in MongoDB 3.2+ and is ignored for older - server versions, which do not support document level validation. - - - &false; - - - ordered - bool - - Ordered operations (&true;) are executed serially on the MongoDB - server, while unordered operations (&false;) are sent to the server - in an arbitrary order and may be executed in parallel. - - &true; - - - -
- - - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 1.1.0 - - Added the "bypassDocumentValidation" option. - - - - - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\BulkWrite::__construct</function> example - - true]); -$bulk->delete([]); -$bulk->insert(['_id' => 1, 'x' => 1]); -$bulk->insert(['_id' => 2, 'x' => 2]); -$bulk->update( - ['x' => 2], - ['$set' => ['x' => 1]], - ['limit' => 1, 'upsert' => false] -); -$bulk->delete(['x' => 1], ['limit' => 1]); -$bulk->update( - ['_id' => 3], - ['$set' => ['x' => 3]], - ['limit' => 1, 'upsert' => true] -); - -$manager = new MongoDB\Driver\Manager('mongodb://localhost:27017'); -$writeConcern = new MongoDB\Driver\WriteConcern(1); - -try { - $result = $manager->executeBulkWrite('db.collection', $bulk, $writeConcern); -} catch (MongoDB\Driver\Exception\BulkWriteException $e) { - $result = $e->getWriteResult(); - - // Check if the write concern could not be fulfilled - if ($writeConcernError = $result->getWriteConcernError()) { - printf("%s (%d): %s\n", - $writeConcernError->getMessage(), - $writeConcernError->getCode(), - var_export($writeConcernError->getInfo(), true) - ); - } - - // Check if any write operations did not complete at all - foreach ($result->getWriteErrors() as $writeError) { - printf("Operation#%d: %s (%d)\n", - $writeError->getIndex(), - $writeError->getMessage(), - $writeError->getCode() - ); - } -} catch (MongoDB\Driver\Exception\Exception $e) { - printf("Other error: %s\n", $e->getMessage()); - exit; -} - -printf("Inserted %d document(s)\n", $result->getInsertedCount()); -printf("Updated %d document(s)\n", $result->getModifiedCount()); -printf("Upserted %d document(s)\n", $result->getUpsertedCount()); -printf("Deleted %d document(s)\n", $result->getDeletedCount()); - -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::executeBulkWrite - MongoDB\Driver\WriteResult - - - - - - diff --git a/reference/mongodb/mongodb/driver/bulkwrite/count.xml b/reference/mongodb/mongodb/driver/bulkwrite/count.xml deleted file mode 100644 index 3da97a785..000000000 --- a/reference/mongodb/mongodb/driver/bulkwrite/count.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - MongoDB\Driver\BulkWrite::count - Count number of write operations in the bulk - - - - &reftitle.description; - - public intMongoDB\Driver\BulkWrite::count - - - - Returns the number of write operations added to the - MongoDB\Driver\BulkWrite object. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns number of write operations added to the - MongoDB\Driver\BulkWrite object. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 1.2.0 - - Returns the number of write operations added to the - MongoDB\Driver\BulkWrite object. Earlier versions - returned the expected number of client-to-server roundtrips required to - execute all write operations. - - - - - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\BulkWrite::count</function> example - -insert(['_id' => 1, 'x' => 1]); -$bulk->insert(['_id' => 2, 'x' => 2]); -$bulk->update(['x' => 2], ['$set' => ['x' => 1]]); -$bulk->delete(['x' => 1]); - -var_dump(count($bulk)); - -?> -]]> - - &example.outputs; - - - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/bulkwrite/delete.xml b/reference/mongodb/mongodb/driver/bulkwrite/delete.xml deleted file mode 100644 index 252d5b3e0..000000000 --- a/reference/mongodb/mongodb/driver/bulkwrite/delete.xml +++ /dev/null @@ -1,171 +0,0 @@ - - - - - - MongoDB\Driver\BulkWrite::delete - Add a delete operation to the bulk - - - - &reftitle.description; - - public voidMongoDB\Driver\BulkWrite::delete - arrayobjectfilter - arraydeleteOptions - - - Adds a delete operation to the - MongoDB\Driver\BulkWrite. - - - - - - &reftitle.parameters; - - &mongodb.parameter.filter; - - deleteOptions - - - - deleteOptions - - - - Option - Type - Description - Default - - - - &mongodb.option.collation; - - hint - stringarrayobject - - - Index specification. Specify either the index name as a string or - the index key pattern. If specified, then the query system will only - consider plans using the hinted index. - - - This option is available in MongoDB 4.4+ and will result in an - exception at execution time if specified for an older server - version. - - - - - limit - bool - Delete all matching documents (&false;), or only the first matching document (&true;) - &false; - - - -
- - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 1.8.0 - - Added the "hint" option. - - - - PECL mongodb 1.2.0 - - Added the "collation" option. - - - - - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\BulkWrite::delete</function> example - -delete(['x' => 1], ['limit' => 1]); -$bulk->delete(['x' => 2], ['limit' => 0]); - -$manager = new MongoDB\Driver\Manager('mongodb://localhost:27017'); -$result = $manager->executeBulkWrite('db.collection', $bulk); - -?> -]]> - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::executeBulkWrite - MongoDB\Driver\WriteResult - - - - - - diff --git a/reference/mongodb/mongodb/driver/bulkwrite/insert.xml b/reference/mongodb/mongodb/driver/bulkwrite/insert.xml deleted file mode 100644 index 64b8bba33..000000000 --- a/reference/mongodb/mongodb/driver/bulkwrite/insert.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - MongoDB\Driver\BulkWrite::insert - Add an insert operation to the bulk - - - - &reftitle.description; - - public mixedMongoDB\Driver\BulkWrite::insert - arrayobjectdocument - - - Adds an insert operation to the - MongoDB\Driver\BulkWrite. - - - - - - &reftitle.parameters; - - - document (arrayobject) - - - A document to insert. - - - - - - - - &reftitle.returnvalues; - - Returns the _id of the inserted document. If the - document did not have an _id, the - MongoDB\BSON\ObjectId generated for the insert will - be returned. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 1.3.0 - - The _id of the inserted document is always returned. - Previously, the method only returned a value if a - MongoDB\BSON\ObjectId was generated. - - - - - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\BulkWrite::insert</function> example - - 'one']; -$document2 = ['_id' => 'custom ID', 'title' => 'two']; -$document3 = ['_id' => new MongoDB\BSON\ObjectId, 'title' => 'three']; - -$_id1 = $bulk->insert($document1); -$_id2 = $bulk->insert($document2); -$_id3 = $bulk->insert($document3); - -var_dump($_id1, $_id2, $_id3); - -$manager = new MongoDB\Driver\Manager('mongodb://localhost:27017'); -$result = $manager->executeBulkWrite('db.collection', $bulk); - -?> -]]> - - &example.outputs.similar; - - - string(24) "54d51146bd21b91405401d92" -} -NULL -NULL -]]> - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::executeBulkWrite - MongoDB\Driver\WriteResult - MongoDB\BSON\ObjectId - MongoDB\BSON\Persistable - - - - - - diff --git a/reference/mongodb/mongodb/driver/bulkwrite/update.xml b/reference/mongodb/mongodb/driver/bulkwrite/update.xml deleted file mode 100644 index 3ad23cead..000000000 --- a/reference/mongodb/mongodb/driver/bulkwrite/update.xml +++ /dev/null @@ -1,242 +0,0 @@ - - - - - - MongoDB\Driver\BulkWrite::update - Add an update operation to the bulk - - - - &reftitle.description; - - public voidMongoDB\Driver\BulkWrite::update - arrayobjectfilter - arrayobjectnewObj - arrayupdateOptions - - - Adds an update operation to the - MongoDB\Driver\BulkWrite. - - - - - - &reftitle.parameters; - - &mongodb.parameter.filter; - - newObj (arrayobject) - - - A document containing either update operators (e.g. - $set), a replacement document (i.e. - only field:value expressions), or - an aggregation pipeline. - - - - - updateOptions - - - - updateOptions - - - - Option - Type - Description - Default - - - - - arrayFilters - array - - - An array of filter documents that determines which array elements to - modify for an update operation on an array field. See - Specify arrayFilters for Array Update Operations - in the MongoDB manual for more information. - - - This option is available in MongoDB 3.6+ and will result in an - exception at execution time if specified for an older server - version. - - - - &mongodb.option.collation; - - hint - stringarrayobject - - - Index specification. Specify either the index name as a string or - the index key pattern. If specified, then the query system will only - consider plans using the hinted index. - - - This option is available in MongoDB 4.2+ and will result in an - exception at execution time if specified for an older server - version. - - - - - multi - bool - - Update only the first matching document if &false;, or all - matching documents &true;. This option cannot be &true; if - newObj is a replacement document. - - &false; - - - upsert - bool - - If filter does not match an existing document, - insert a single document. The document will be - created from newObj if it is a replacement - document (i.e. no update operators); otherwise, the operators in - newObj will be applied to - filter to create the new document. - - &false; - - - -
- - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 1.7.0 - - Added the "hint" option. - - - - PECL mongodb 1.6.0 - - The newObj parameter now accepts an aggregation - pipeline. This feature requires MongoDB 4.2+ and will result in an - exception at execution time if specified for an older server version. - - - - PECL mongodb 1.5.0 - - Using the "arrayFilters" option will result in an - exception at execution time if unsupported by the server. Previously, - no exception would be thrown and the option may have been ignored. - - - - PECL mongodb 1.4.0 - - Added the "arrayFilters" option. - - - - PECL mongodb 1.2.0 - - Added the "collation" option. - - - - - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\BulkWrite::update</function> example - -update( - ['x' => 2], - ['$set' => ['y' => 3]], - ['multi' => false, 'upsert' => false] -); - -$manager = new MongoDB\Driver\Manager('mongodb://localhost:27017'); -$result = $manager->executeBulkWrite('db.collection', $bulk); - -?> -]]> - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::executeBulkWrite - MongoDB\Driver\WriteResult - - - - - - diff --git a/reference/mongodb/mongodb/driver/clientencryption.xml b/reference/mongodb/mongodb/driver/clientencryption.xml deleted file mode 100644 index 8039cb138..000000000 --- a/reference/mongodb/mongodb/driver/clientencryption.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - The MongoDB\Driver\ClientEncryption class - MongoDB\Driver\ClientEncryption - - - - -
- &reftitle.intro; - - The MongoDB\Driver\ClientEncryption class handles - creation of data keys for client-side encryption, as well as manually - encrypting and decrypting values. - -
- - -
- &reftitle.classsynopsis; - - - - MongoDB\Driver\ClientEncryption - - - - final - - MongoDB\Driver\ClientEncryption - - - - - - Constants - - const - string - MongoDB\Driver\ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_DETERMINISTIC - AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic - - - const - string - MongoDB\Driver\ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_RANDOM - AEAD_AES_256_CBC_HMAC_SHA_512-Random - - - &Methods; - - - - -
- - -
- &reftitle.constants; - - - - MongoDB\Driver\ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_DETERMINISTIC - - Uses randomized encryption. - - - - - MongoDB\Driver\ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_RANDOM - - Uses deterministic (queryable) encryption. - - - - -
- - -
- &reftitle.seealso; - - MongoDB\Driver\Manager::createClientEncryption - -
- - - - &reference.mongodb.mongodb.driver.entities.clientencryption; - - - - diff --git a/reference/mongodb/mongodb/driver/clientencryption/createdatakey.xml b/reference/mongodb/mongodb/driver/clientencryption/createdatakey.xml deleted file mode 100644 index f36af3d1c..000000000 --- a/reference/mongodb/mongodb/driver/clientencryption/createdatakey.xml +++ /dev/null @@ -1,260 +0,0 @@ - - - - - - MongoDB\Driver\ClientEncryption::createDataKey - Create a new encryption data key - - - - &reftitle.description; - - final public MongoDB\BSON\BinaryMongoDB\Driver\ClientEncryption::createDataKey - stringkmsProvider - arrayoptions - - - Creates a new key document and inserts it into the key vault collection. - - - - - &reftitle.parameters; - - - kmsProvider - - - The KMS provider (e.g. "local", - "aws", "azure", - "gcp") that will be used to encrypt the new encryption - key. - - - - - - options - - - - Data key options - - - - Option - Type - Description - - - - - masterKey - array - - - The masterKey identifies a KMS-specific key used to encrypt the new - data key. This option is required unless - kmsProvider is "local". - - - If kmsProvider is "aws", - this option is required and has the following fields: -
- AWS masterKey options - - - - Option - Type - Description - - - - - region - string - Required. - - - key - string - Required. The Amazon Resource Name (ARN) to the AWS customer master key (CMK). - - - endpoint - string - Optional. An alternate host identifier to send KMS requests to. May include port number. - - - -
- - - If kmsProvider is "azure", - this option is required and has the following fields: - - Azure masterKey options - - - - Option - Type - Description - - - - - keyVaultEndpoint - string - Required. Host with optional port (e.g. "example.vault.azure.net"). - - - keyName - string - Required. - - - keyVersion - string - Optional. A specific version of the named key. Defaults to using the key's primary version. - - - -
- - - If kmsProvider is "gcp", - this option is required and has the following fields: - - GCP masterKey options - - - - Option - Type - Description - - - - - projectId - string - Required. - - - location - string - Required. - - - keyRing - string - Required. - - - keyName - string - Required. - - - keyVersion - string - Optional. A specific version of the named key. Defaults to using the key's primary version. - - - endpoint - string - Optional. Host with optional port. Defaults to "cloudkms.googleapis.com". - - - -
- - - - - keyAltNames - array - - - An optional list of string alternate names used to reference a key. - If a key is created with alternate names, then encryption may refer - to the key by the unique alternate name instead of by - _id. - - - - - - - - - - - - - - &reftitle.returnvalues; - - Returns the identifier of the new key as a - MongoDB\BSON\Binary object with subtype 4 (UUID). - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\EncryptionException if an error occurs while creating the data key - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 1.10.0 - - Azure and GCP are now supported as KMS providers for client-side - encryption. - - - - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/clientencryption/decrypt.xml b/reference/mongodb/mongodb/driver/clientencryption/decrypt.xml deleted file mode 100644 index 26344ef0f..000000000 --- a/reference/mongodb/mongodb/driver/clientencryption/decrypt.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - MongoDB\Driver\ClientEncryption::decrypt - Decrypt a value - - - - &reftitle.description; - - final public mixedMongoDB\Driver\ClientEncryption::decrypt - MongoDB\BSON\Binaryvalue - - - Decrypts the value. - - - - - &reftitle.parameters; - - - value - - - A MongoDB\BSON\Binary instance with subtype 6 - containing the encrypted value. - - - - - - - - &reftitle.returnvalues; - - Returns the decrypted value as it was passed to - MongoDB\Driver\ClientEncryption::encrypt. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\EncryptionException if an error occurs while decrypting the value - - - - - &reftitle.seealso; - - MongoDB\Driver\ClientEncryption::encrypt - - - - - - diff --git a/reference/mongodb/mongodb/driver/clientencryption/encrypt.xml b/reference/mongodb/mongodb/driver/clientencryption/encrypt.xml deleted file mode 100644 index aec4ab43b..000000000 --- a/reference/mongodb/mongodb/driver/clientencryption/encrypt.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - MongoDB\Driver\ClientEncryption::encrypt - Encrypt a value - - - - &reftitle.description; - - final public MongoDB\BSON\BinaryMongoDB\Driver\ClientEncryption::encrypt - mixedvalue - arrayoptions - - - Encrypts the value. - - - - - &reftitle.parameters; - - - value - - - The value to be encrypted. Any value that can be inserted into MongoDB can - be encrypted using this method. - - - - - - options - - - - Encryption options - - - - Option - Type - Description - - - - - algorithm - string - - - The encryption algorithm to be used. Use the constants defined in - MongoDB\Driver\ClientEncryption. - - - - - keyAltName - string - - - Identifies a key vault collection document by - keyAltName. - - - - - keyId - MongoDB\BSON\Binary - - - Identifies a data key by _id. The value is a UUID - (binary subtype 4). - - - - - -
- - - - Exactly one of keyId and keyAltName - must be provided. The algorithm option is required. - - - - - - - - - &reftitle.returnvalues; - - Returns the encrypted value as - MongoDB\BSON\Binary object with subtype 6. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\EncryptionException if an error occurs while encrypting the value - - - - - &reftitle.seealso; - - MongoDB\Driver\ClientEncryption::decrypt - - - - - - diff --git a/reference/mongodb/mongodb/driver/command.xml b/reference/mongodb/mongodb/driver/command.xml deleted file mode 100644 index 723ca2778..000000000 --- a/reference/mongodb/mongodb/driver/command.xml +++ /dev/null @@ -1,196 +0,0 @@ - - - - - - The MongoDB\Driver\Command class - MongoDB\Driver\Command - - - - -
- &reftitle.intro; - - The MongoDB\Driver\Command class is a value object - that represents a database command. - - - To provide Command Helpers the MongoDB\Driver\Command object should be composed. - -
- - -
- &reftitle.classsynopsis; - - - - MongoDB\Driver\Command - - - - final - - MongoDB\Driver\Command - - - - - &Methods; - - - - -
- -
- &reftitle.examples; - - - Composing <classname>MongoDB\Driver\Command</classname> to provide a helper to create collections - -cmd["create"] = (string)$collectionName; - } - function setCappedCollection($maxBytes, $maxDocuments = false) { - $this->cmd["capped"] = true; - $this->cmd["size"] = (int)$maxBytes; - - if ($maxDocuments) { - $this->cmd["max"] = (int)$maxDocuments; - } - } - function usePowerOf2Sizes($bool) { - if ($bool) { - $this->cmd["flags"] = 1; - } else { - $this->cmd["flags"] = 0; - } - } - function setFlags($flags) { - $this->cmd["flags"] = (int)$flags; - } - function getCommand() { - return new MongoDB\Driver\Command($this->cmd); - } - function getCollectionName() { - return $this->cmd["create"]; - } -} - - -$manager = new MongoDB\Driver\Manager("mongodb://localhost:27017"); - -$createCollection = new CreateCollection("cappedCollection"); -$createCollection->setCappedCollection(64 * 1024); - -try { - $command = $createCollection->getCommand(); - $cursor = $manager->executeCommand("databaseName", $command); - $response = $cursor->toArray()[0]; - var_dump($response); - - $collstats = ["collstats" => $createCollection->getCollectionName()]; - $cursor = $manager->executeCommand("databaseName", new MongoDB\Driver\Command($collstats)); - $response = $cursor->toArray()[0]; - var_dump($response); -} catch(MongoDB\Driver\Exception $e) { - echo $e->getMessage(), "\n"; - exit; -} - -?> -]]> - - - &example.outputs; - - - array(3) { - ["create"]=> - string(16) "cappedCollection" - ["capped"]=> - bool(true) - ["size"]=> - int(65536) - } -} -array(1) { - ["ok"]=> - float(1) -} -array(16) { - ["ns"]=> - string(29) "databaseName.cappedCollection" - ["count"]=> - int(0) - ["size"]=> - int(0) - ["numExtents"]=> - int(1) - ["storageSize"]=> - int(65536) - ["nindexes"]=> - int(1) - ["lastExtentSize"]=> - float(65536) - ["paddingFactor"]=> - float(1) - ["paddingFactorNote"]=> - string(101) "paddingFactor is unused and unmaintained in 2.8. It remains hard coded to 1.0 for compatibility only." - ["userFlags"]=> - int(0) - ["capped"]=> - bool(true) - ["max"]=> - int(9223372036854775807) - ["maxSize"]=> - int(65536) - ["totalIndexSize"]=> - int(8176) - ["indexSizes"]=> - object(stdClass)#4 (1) { - ["_id_"]=> - int(8176) - } - ["ok"]=> - float(1) -} -]]> - -
- - - - &reference.mongodb.mongodb.driver.entities.command; - - - - diff --git a/reference/mongodb/mongodb/driver/command/construct.xml b/reference/mongodb/mongodb/driver/command/construct.xml deleted file mode 100644 index d2436ca13..000000000 --- a/reference/mongodb/mongodb/driver/command/construct.xml +++ /dev/null @@ -1,262 +0,0 @@ - - - - - - MongoDB\Driver\Command::__construct - Create a new Command - - - - &reftitle.description; - - final public MongoDB\Driver\Command::__construct - arrayobjectdocument - arraycommandOptions - - - Constructs a new MongoDB\Driver\Command, which is an - immutable value object that represents a database command. The command may - then be executed with - MongoDB\Driver\Manager::executeCommand. - - - The complete command document, which includes the command name and its - options, should be expressed in the document - parameter. The commandOptions parameter is only used - to specify options related to the execution of the command and the resulting - MongoDB\Driver\Cursor. - - - - - &reftitle.parameters; - - - document - - - The complete command document, which will be sent to the server. - - - - - - commandOptions - - - - Do not use this parameter to specify options described in the command's - reference in the MongoDB manual. This parameter should only be used for - the options explicitly listed below. - - - - - commandOptions - - - - Option - Type - Description - - - - - maxAwaitTimeMS - int - - - Positive integer denoting the time limit in milliseconds for the - server to block a getMore operation if no data is available. This - option should only be used in conjunction with commands that return - a tailable cursor (e.g. Change - Streams). - - - - - -
- - - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 1.4.0 - - - Added a second commandOptions argument, which supports - the "maxAwaitTimeMS" option. - - - - - - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\Command::__construct</function> example - - 1)); - -try { - $cursor = $manager->executeCommand("admin", $command); - $response = $cursor->toArray()[0]; -} catch(MongoDB\Driver\Exception $e) { - echo $e->getMessage(), "\n"; - exit; -} -var_dump($response); - -?> -]]> - - &example.outputs.similar; - - - string(14) "2.8.0-rc2-pre-" - ["gitVersion"]=> - string(62) "b743d7158f7642f4da6b7eac8320374b3b88dc2e modules: subscription" - ["OpenSSLVersion"]=> - string(25) "OpenSSL 1.0.1f 6 Jan 2014" - ["sysInfo"]=> - string(104) "Linux infant 3.16.0-24-generic #32-Ubuntu SMP Tue Oct 28 13:07:32 UTC 2014 x86_64 BOOST_LIB_VERSION=1_49" - ["loaderFlags"]=> - string(91) "-fPIC -pthread -Wl,-z,now -rdynamic -Wl,-Bsymbolic-functions -Wl,-z,relro -Wl,-z,now -Wl,-E" - ["compilerFlags"]=> - string(301) "-Wnon-virtual-dtor -Woverloaded-virtual -std=c++11 -fPIC -fno-strict-aliasing -ggdb -pthread -Wall -Wsign-compare -Wno-unknown-pragmas -Winvalid-pch -pipe -Werror -O3 -Wno-unused-local-typedefs -Wno-unused-function -Wno-deprecated-declarations -Wno-unused-but-set-variable -fno-builtin-memcmp -std=c99" - ["allocator"]=> - string(8) "tcmalloc" - ["versionArray"]=> - array(4) { - [0]=> - int(2) - [1]=> - int(8) - [2]=> - int(0) - [3]=> - int(-8) - } - ["javascriptEngine"]=> - string(2) "V8" - ["bits"]=> - int(64) - ["debug"]=> - bool(false) - ["maxBsonObjectSize"]=> - int(16777216) - ["ok"]=> - float(1) -} - -]]> - - - - - <function>MongoDB\Driver\Command::__construct</function> example - - Commands can accept options as well, as part of the normal structure that - you create to send to the server. For example, the - maxTimeMS option can be passed with most commands to - restrict the amount of time a specific command can run for on the server. - - - "beer", - "key" => "beer_name", - "maxTimeMS" => 10, - ) -); - -try { - $cursor = $manager->executeCommand("beerdb", $command); - $response = $cursor->toArray()[0]; -} catch(MongoDB\Driver\Exception\Exception $e) { - echo $e->getMessage(), "\n"; - exit; -} -var_dump($response); - -?> -]]> - - &example.outputs.similar; - - operation exceeded time limit - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::executeCommand - MongoDB\Driver\Cursor - - - - - - diff --git a/reference/mongodb/mongodb/driver/cursor.xml b/reference/mongodb/mongodb/driver/cursor.xml deleted file mode 100644 index 4b33bf55f..000000000 --- a/reference/mongodb/mongodb/driver/cursor.xml +++ /dev/null @@ -1,318 +0,0 @@ - - - - - - The MongoDB\Driver\Cursor class - MongoDB\Driver\Cursor - - - - -
- &reftitle.intro; - - The MongoDB\Driver\Cursor class encapsulates - the results of a MongoDB command or query and may be returned by - MongoDB\Driver\Manager::executeCommand or - MongoDB\Driver\Manager::executeQuery, respectively. - -
- - -
- &reftitle.classsynopsis; - - - - MongoDB\Driver\Cursor - - - - final - - MongoDB\Driver\Cursor - - - - MongoDB\Driver\CursorInterface - - - - Iterator - - - - - &Methods; - - - - -
- -
- &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 1.9.0 - - Implements Iterator. - - - - PECL mongodb 1.6.0 - - Implements MongoDB\Driver\CursorInterface, - which extends Traversable. - - - - - - -
- -
- &reftitle.examples; - - - Reading a result set - - MongoDB\Driver\Manager::executeCommand and - MongoDB\Driver\Manager::executeQuery both return - their result(s) as a MongoDB\Driver\Cursor object. - This object can be used to iterate over the result set of the command or - query. - - - Because MongoDB\Driver\Cursor implements the - Traversable interface, you can simply - iterate over the result set with - foreach. - - -insert(['name' => 'Ceres', 'size' => 946, 'distance' => 2.766]); -$bulkWrite->insert(['name' => 'Vesta', 'size' => 525, 'distance' => 2.362]); -$manager->executeBulkWrite("test.asteroids", $bulkWrite); - -/* Query for all the items in the collection */ -$query = new MongoDB\Driver\Query( [] ); - -/* Query the "asteroids" collection of the "test" database */ -$cursor = $manager->executeQuery("test.asteroids", $query); - -/* $cursor now contains an object that wraps around the result set. Use - * foreach() to iterate over all the result */ -foreach($cursor as $document) { - print_r($document); -} - -?> -]]> - - &example.outputs.similar; - - MongoDB\BSON\ObjectId Object - ( - [oid] => 5a4cff2f122d3321565d8cc2 - ) - - [name] => Ceres - [size] => 946 - [distance] => 2.766 -) -stdClass Object -( - [_id] => MongoDB\BSON\ObjectId Object - ( - [oid] => 5a4cff2f122d3321565d8cc3 - ) - - [name] => Vesta - [size] => 525 - [distance] => 2.362 -} -]]> - - - - - Reading a result set for a tailable cursor - - Tailable cursors - are a special type of MongoDB cursor that allows the client to read some - results and then wait until more documents become available. These cursors - are primarily used with - Capped Collections - and Change Streams. - - - While normal cursors can be iterated once with foreach, - that approach will not work with tailable cursors. When - foreach is used with a tailable cursor, the loop will - stop upon reaching the end of the initial result set. Attempting to - continue iteration on the cursor with a second - foreach would throw an exception, since PHP attempts to - rewind the cursor. Similar to result objects in other database drivers, - cursors in MongoDB only support forward iteration, which means they cannot - be rewound. - - - In order to continuously read from a tailable cursor, the Cursor object - must be wrapped with an IteratorIterator. This - allows the application to directly control the cursor's iteration, avoid - inadvertently rewinding the cursor, and decide when to wait for new results - or stop iteration entirely. - - - In order to demonstrate a tailable cursor in action, two scripts will be - used: a "producer" and a "consumer". The producer script will create a new - capped collection using the - create command - and proceed to insert a new document into that collection each second. - - -executeCommand('test', new MongoDB\Driver\Command([ - 'create' => 'asteroids', - 'capped' => true, - 'size' => 1048576, -])); - -while (true) { - $bulkWrite = new MongoDB\Driver\BulkWrite; - $bulkWrite->insert(['createdAt' => new MongoDB\BSON\UTCDateTime]); - $manager->executeBulkWrite('test.asteroids', $bulkWrite); - - sleep(1); -} - -?> -]]> - - - With the producer script still running, a second consumer script may be - executed to read the inserted documents using a tailable cursor, indicated - by the tailable and awaitData options - to MongoDB\Driver\Query::__construct. - - - true, - 'awaitData' => true, -]); - -$cursor = $manager->executeQuery('test.asteroids', $query); - -$iterator = new IteratorIterator($cursor); - -$iterator->rewind(); - -while (true) { - if ($iterator->valid()) { - $document = $iterator->current(); - printf("Consumed document created at: %s\n", $document->createdAt); - } - - $iterator->next(); -} - -?> -]]> - - - The consumer script will start by quickly printing all available documents - in the capped collection (as if foreach had been used); - however, it will not terminate upon reaching the end of the initial result - set. Since the cursor is tailable, calling - IteratorIterator::next will block and wait for - additional results. IteratorIterator::valid is also - used to check if there is actually data available to read at each step. - - - - This example uses the awaitData query option to - instruct the server to block for a short period (e.g. one second) at the - end of the result set before returning a response to the driver. This is - used to prevent the driver from aggressively polling the server when there - are no results available. The maxAwaitTimeMS option may - be used in conjunction with tailable and - awaitData to specify the amount of time that the server - should block when it reaches the end of the result set. - - - -
- -
- &reftitle.errors; - - When iterating over the cursor object, BSON data is converted into PHP - variables. This iteration can cause the following Exceptions: - - - - Throws - MongoDB\Driver\Exception\InvalidArgumentException if - a class in the type map cannot be instantiated or does not implement - MongoDB\BSON\Unserializable. - - &mongodb.throws.bson.unexpected; - -
- - - - &reference.mongodb.mongodb.driver.entities.cursor; - - - - diff --git a/reference/mongodb/mongodb/driver/cursor/construct.xml b/reference/mongodb/mongodb/driver/cursor/construct.xml deleted file mode 100644 index d44e436eb..000000000 --- a/reference/mongodb/mongodb/driver/cursor/construct.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - MongoDB\Driver\Cursor::__construct - Create a new Cursor (not used) - - - - &reftitle.description; - - final private MongoDB\Driver\Cursor::__construct - - - - MongoDB\Driver\Cursor objects are returned as the - result of an executed command or query and cannot be constructed directly. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::executeCommand - MongoDB\Driver\Manager::executeQuery - MongoDB\Driver\Server::executeCommand - MongoDB\Driver\Server::executeQuery - - - - - - diff --git a/reference/mongodb/mongodb/driver/cursor/current.xml b/reference/mongodb/mongodb/driver/cursor/current.xml deleted file mode 100644 index 1a4d04c3c..000000000 --- a/reference/mongodb/mongodb/driver/cursor/current.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - MongoDB\Driver\Cursor::current - Returns the current element - - - - &reftitle.description; - - public arrayobjectMongoDB\Driver\Cursor::current - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the current result document as an array or object, depending on the - cursor's type map. If iteration has not started or the current position - is not valid, &null; will be returned. - - - - - &reftitle.seealso; - - Iterator::current - - - - diff --git a/reference/mongodb/mongodb/driver/cursor/getid.xml b/reference/mongodb/mongodb/driver/cursor/getid.xml deleted file mode 100644 index 3a26a782d..000000000 --- a/reference/mongodb/mongodb/driver/cursor/getid.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - MongoDB\Driver\Cursor::getId - Returns the ID for this cursor - - - - &reftitle.description; - - final public MongoDB\Driver\CursorIdMongoDB\Driver\Cursor::getId - - - - Returns the MongoDB\Driver\CursorId associated with - this cursor. A cursor ID uniquely identifies the cursor on the server. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the MongoDB\Driver\CursorId for this cursor. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\Cursor::getId</function> example - - 2]); - -$bulk = new MongoDB\Driver\BulkWrite; -$bulk->insert(['x' => 1]); -$bulk->insert(['x' => 2]); -$bulk->insert(['x' => 3]); -$manager->executeBulkWrite('db.collection', $bulk); - -$cursor = $manager->executeQuery('db.collection', $query); -var_dump($cursor->getId()); - -?> -]]> - - &example.outputs.similar; - - - int(94810124093) -} -]]> - - - - - - - &reftitle.seealso; - - MongoDB\Driver\CursorId - MongoDB\Driver\CursorId::__toString - - - - - - diff --git a/reference/mongodb/mongodb/driver/cursor/getserver.xml b/reference/mongodb/mongodb/driver/cursor/getserver.xml deleted file mode 100644 index 7d417c6f0..000000000 --- a/reference/mongodb/mongodb/driver/cursor/getserver.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - MongoDB\Driver\Cursor::getServer - Returns the server associated with this cursor - - - - &reftitle.description; - - final public MongoDB\Driver\ServerMongoDB\Driver\Cursor::getServer - - - - Returns the MongoDB\Driver\Server associated with this - cursor. This is the server that executed the - MongoDB\Driver\Query or - MongoDB\Driver\Command. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the MongoDB\Driver\Server associated with this - cursor. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\Cursor::getServer</function> example - -insert(['x' => 1]); -$manager->executeBulkWrite('db.collection', $bulk); - -$cursor = $manager->executeQuery('db.collection', $query); -var_dump($cursor->getServer()); - -?> -]]> - - &example.outputs.similar; - - - string(9) "localhost" - ["port"]=> - int(27017) - ["type"]=> - int(1) - ["is_primary"]=> - bool(false) - ["is_secondary"]=> - bool(false) - ["is_arbiter"]=> - bool(false) - ["is_hidden"]=> - bool(false) - ["is_passive"]=> - bool(false) - ["last_hello_response"]=> - array(8) { - ["isWritablePrimary"]=> - bool(true) - ["maxBsonObjectSize"]=> - int(16777216) - ["maxMessageSizeBytes"]=> - int(48000000) - ["maxWriteBatchSize"]=> - int(1000) - ["localTime"]=> - object(MongoDB\BSON\UTCDateTime)#6 (1) { - ["milliseconds"]=> - int(1446505367907) - } - ["maxWireVersion"]=> - int(3) - ["minWireVersion"]=> - int(0) - ["ok"]=> - float(1) - } - ["round_trip_time"]=> - int(584) -} -]]> - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Server - - - - - - diff --git a/reference/mongodb/mongodb/driver/cursor/isdead.xml b/reference/mongodb/mongodb/driver/cursor/isdead.xml deleted file mode 100644 index c94f086be..000000000 --- a/reference/mongodb/mongodb/driver/cursor/isdead.xml +++ /dev/null @@ -1,156 +0,0 @@ - - - - - - MongoDB\Driver\Cursor::isDead - Checks if the cursor is exhausted or may have additional results - - - - &reftitle.description; - - final public boolMongoDB\Driver\Cursor::isDead - - - - Checks whether there are definitely no additional results available on the - cursor. This method is similar to the - cursor.isExhausted() - method in the MongoDB shell and is primarily useful when iterating - tailable cursors. - - - A cursor has no additional results and is considered "dead" when one of the - following is true: - - - The current batch has been fully iterated and the - cursor ID is zero (i.e. a - getMore - cannot be issued). - - An error was encountered while iterating the cursor. - The cursor reached its configured limit. - - - - By design, it is not possible to always determine whether a cursor has - additional results. The cases where a cursor may have - more data available is as follows: - - - There are additional documents in the current batch, which are buffered on - the client side. Iterating will fetch a document from the local buffer. - - - There are no additional documents in the current batch (i.e. local buffer), - but the cursor ID is non-zero. Iterating will request more documents from - the server via a - getMore - operation, which may or may not return additional results and/or indicate - that the cursor has been closed on the server by returning zero for its ID. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; if there are definitely no additional results available on the - cursor, and &false; otherwise. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\Cursor::isDead</function> example - -insert(['x' => 1]); -$bulk->insert(['x' => 2]); -$bulk->insert(['x' => 3]); -$manager->executeBulkWrite('db.collection', $bulk); - -$cursor = $manager->executeQuery('db.collection', $query); - -$iterator = new IteratorIterator($cursor); - -$iterator->rewind(); -var_dump($cursor->isDead()); - -$iterator->next(); -var_dump($cursor->isDead()); - -$iterator->next(); -var_dump($cursor->isDead()); - -$iterator->next(); -var_dump($cursor->isDead()); - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - Tailable Cursors in the MongoDB manual - cursor.isExhausted() in the MongoDB manual - - - - - - diff --git a/reference/mongodb/mongodb/driver/cursor/key.xml b/reference/mongodb/mongodb/driver/cursor/key.xml deleted file mode 100644 index 1d8b9bbd5..000000000 --- a/reference/mongodb/mongodb/driver/cursor/key.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - MongoDB\Driver\Cursor::key - Returns the current result's index within the cursor - - - - &reftitle.description; - - public intMongoDB\Driver\Cursor::key - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The current result's numeric index within the cursor. - - - - - &reftitle.seealso; - - Iterator::key - - - - diff --git a/reference/mongodb/mongodb/driver/cursor/next.xml b/reference/mongodb/mongodb/driver/cursor/next.xml deleted file mode 100644 index 34b82a1a1..000000000 --- a/reference/mongodb/mongodb/driver/cursor/next.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - MongoDB\Driver\Cursor::next - Advances the cursor to the next result - - - - &reftitle.description; - - public voidMongoDB\Driver\Cursor::next - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Moves the current position to the next element in the cursor. - - - - - &reftitle.errors; - - &mongodb.throws.std; - - - - - &reftitle.seealso; - - Iterator::next - - - - diff --git a/reference/mongodb/mongodb/driver/cursor/rewind.xml b/reference/mongodb/mongodb/driver/cursor/rewind.xml deleted file mode 100644 index d9066e652..000000000 --- a/reference/mongodb/mongodb/driver/cursor/rewind.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - MongoDB\Driver\Cursor::rewind - Rewind the cursor to the first result - - - - &reftitle.description; - - public voidMongoDB\Driver\Cursor::rewind - - - - If the cursor has advanced beyond its first position, it can no longer be - rewound. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &null;. - - - - - &reftitle.errors; - - &mongodb.throws.std; - Throws MongoDB\Driver\Exception\LogicException if this method is called after the cursor has advanced beyond its first position. - - - - - &reftitle.seealso; - - Iterator::rewind - - - - diff --git a/reference/mongodb/mongodb/driver/cursor/settypemap.xml b/reference/mongodb/mongodb/driver/cursor/settypemap.xml deleted file mode 100644 index 9949f30a1..000000000 --- a/reference/mongodb/mongodb/driver/cursor/settypemap.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - MongoDB\Driver\Cursor::setTypeMap - Sets a type map to use for BSON unserialization - - - - &reftitle.description; - - final public voidMongoDB\Driver\Cursor::setTypeMap - arraytypemap - - - Sets the type map - configuration to use when unserializing the BSON results into PHP - values. - - - - - &reftitle.parameters; - - &mongodb.parameter.typeMap; - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - When iterating over the cursor, the following exceptions can also be thrown - due to an incorrect type map configuration: - - - Throws - MongoDB\Driver\Exception\InvalidArgumentException if - a class in the type map cannot be instantiated or does not implement - MongoDB\BSON\Unserializable. - - - - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\Cursor::setTypeMap</function> example - -insert(['x' => 1]); -$manager->executeBulkWrite('db.collection', $bulk); - -$query = new MongoDB\Driver\Query(['_id' => $id]); -$cursor = $manager->executeQuery('db.collection', $query); -$cursor->setTypeMap(['root' => 'array']); - -foreach ($cursor as $document) { - var_dump($document); -} - -?> -]]> - - &example.outputs.similar; - - - object(MongoDB\BSON\ObjectId)#6 (1) { - ["oid"]=> - string(24) "56424fb76118fd3267180741" - } - ["x"]=> - int(1) -} -]]> - - - - - - - &reftitle.seealso; - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/cursor/toarray.xml b/reference/mongodb/mongodb/driver/cursor/toarray.xml deleted file mode 100644 index da53b10fd..000000000 --- a/reference/mongodb/mongodb/driver/cursor/toarray.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - - MongoDB\Driver\Cursor::toArray - Returns an array containing all results for this cursor - - - - &reftitle.description; - - final public arrayMongoDB\Driver\Cursor::toArray - - - - Iterates the cursor and returns its results in an array. - MongoDB\Driver\Cursor::setTypeMap may be used to control - how documents are unserialized into PHP values. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an array containing all results for this cursor. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\Cursor::toArray</function> example - -insert(['x' => 1]); -$bulk->insert(['x' => 2]); -$bulk->insert(['x' => 3]); -$manager->executeBulkWrite('db.collection', $bulk); - -$query = new MongoDB\Driver\Query([]); -$cursor = $manager->executeQuery('db.collection', $query); - -var_dump($cursor->toArray()); - -?> -]]> - - &example.outputs.similar; - - - object(stdClass)#6 (2) { - ["_id"]=> - object(MongoDB\BSON\ObjectId)#5 (1) { - ["oid"]=> - string(24) "564259a96118fd40b41bcf61" - } - ["x"]=> - int(1) - } - [1]=> - object(stdClass)#8 (2) { - ["_id"]=> - object(MongoDB\BSON\ObjectId)#7 (1) { - ["oid"]=> - string(24) "564259a96118fd40b41bcf62" - } - ["x"]=> - int(2) - } - [2]=> - object(stdClass)#10 (2) { - ["_id"]=> - object(MongoDB\BSON\ObjectId)#9 (1) { - ["oid"]=> - string(24) "564259a96118fd40b41bcf63" - } - ["x"]=> - int(3) - } -} -]]> - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Cursor::setTypeMap - - - - - - diff --git a/reference/mongodb/mongodb/driver/cursor/valid.xml b/reference/mongodb/mongodb/driver/cursor/valid.xml deleted file mode 100644 index 2336a90b1..000000000 --- a/reference/mongodb/mongodb/driver/cursor/valid.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - MongoDB\Driver\Cursor::valid - Checks if the current position in the cursor is valid - - - - &reftitle.description; - - public boolMongoDB\Driver\Cursor::valid - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; if the current cursor position is valid, &false; otherwise. - - - - - &reftitle.seealso; - - Iterator::valid - - - - diff --git a/reference/mongodb/mongodb/driver/cursorid.xml b/reference/mongodb/mongodb/driver/cursorid.xml deleted file mode 100644 index cbe61bcab..000000000 --- a/reference/mongodb/mongodb/driver/cursorid.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - The MongoDB\Driver\CursorId class - MongoDB\Driver\CursorId - - - - -
- &reftitle.intro; - - The MongoDB\Driver\CursorID class is a value object - that represents a cursor ID. Instances of this class are returned by - MongoDB\Driver\Cursor::getId. - -
- - -
- &reftitle.classsynopsis; - - - - MongoDB\Driver\CursorId - - - - final - - MongoDB\Driver\CursorId - - - - Serializable - - - - Stringable - - - - - &Methods; - - - - -
- -
- &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 1.12.0 - - Implements Stringable for PHP 8.0+. - - - - PECL mongodb 1.7.0 - - Implements Serializable. - - - - - - -
- - - - &reference.mongodb.mongodb.driver.entities.cursorid; - - - - diff --git a/reference/mongodb/mongodb/driver/cursorid/construct.xml b/reference/mongodb/mongodb/driver/cursorid/construct.xml deleted file mode 100644 index a3cb8e19b..000000000 --- a/reference/mongodb/mongodb/driver/cursorid/construct.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - MongoDB\Driver\CursorId::__construct - Create a new CursorId (not used) - - - - &reftitle.description; - - final private MongoDB\Driver\CursorId::__construct - - - - MongoDB\Driver\CursorId objects are returned from - MongoDB\Driver\Cursor::getId and cannot be constructed - directly. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - &reftitle.seealso; - - MongoDB\Driver\Cursor::getId - - - - - - diff --git a/reference/mongodb/mongodb/driver/cursorid/serialize.xml b/reference/mongodb/mongodb/driver/cursorid/serialize.xml deleted file mode 100644 index ba58bc1f7..000000000 --- a/reference/mongodb/mongodb/driver/cursorid/serialize.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - MongoDB\Driver\CursorId::serialize - Serialize a CursorId - - - - &reftitle.description; - - final public stringMongoDB\Driver\CursorId::serialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the serialized representation of the - MongoDB\Driver\CursorId. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\CursorId::unserialize - serialize - Serializing Objects - - - - - - diff --git a/reference/mongodb/mongodb/driver/cursorid/tostring.xml b/reference/mongodb/mongodb/driver/cursorid/tostring.xml deleted file mode 100644 index eebf94915..000000000 --- a/reference/mongodb/mongodb/driver/cursorid/tostring.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - MongoDB\Driver\CursorId::__toString - String representation of the cursor ID - - - - &reftitle.description; - - final public stringMongoDB\Driver\CursorId::__toString - - - - Returns the string representation of the cursor ID. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the string representation of the cursor ID. - - - - - &reftitle.examples; - - <function>MongoDB\Driver\CursorId::__toString</function> example - - 2]); - -$bulk = new MongoDB\Driver\BulkWrite; -$bulk->insert(['x' => 1]); -$bulk->insert(['x' => 2]); -$bulk->insert(['x' => 3]); -$manager->executeBulkWrite('db.collection', $bulk); - -$cursor = $manager->executeQuery('db.collection', $query); -var_dump((string) $cursor->getId()); - -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Cursor::getId - - - - - - diff --git a/reference/mongodb/mongodb/driver/cursorid/unserialize.xml b/reference/mongodb/mongodb/driver/cursorid/unserialize.xml deleted file mode 100644 index bd60098dc..000000000 --- a/reference/mongodb/mongodb/driver/cursorid/unserialize.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - MongoDB\Driver\CursorId::unserialize - Unserialize a CursorId - - - - &reftitle.description; - - final public voidMongoDB\Driver\CursorId::unserialize - stringserialized - - - - - &reftitle.parameters; - - - - serialized - - - The serialized MongoDB\Driver\CursorId. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\UnexpectedValueException if the properties cannot be unserialized (i.e. serialized was malformed). - Throws MongoDB\Driver\Exception\InvalidArgumentException if the properties are invalid (e.g. missing fields or invalid values). - - - - - &reftitle.seealso; - - MongoDB\Driver\CursorId::serialize - unserialize - Serializing Objects - - - - - - diff --git a/reference/mongodb/mongodb/driver/cursorinterface.xml b/reference/mongodb/mongodb/driver/cursorinterface.xml deleted file mode 100644 index 4284d3dd1..000000000 --- a/reference/mongodb/mongodb/driver/cursorinterface.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - The MongoDB\Driver\CursorInterface interface - MongoDB\Driver\CursorInterface - - - - -
- &reftitle.intro; - - This interface is implemented by - MongoDB\Driver\Cursor to be used as - a parameter, return, or property type in userland classes. - -
- - -
- &reftitle.classsynopsis; - - - - MongoDB\Driver\CursorInterface - - - - - MongoDB\Driver\CursorInterface - - - - Traversable - - - - - &Methods; - - - - -
- - - - &reference.mongodb.mongodb.driver.entities.cursorinterface; - - - - diff --git a/reference/mongodb/mongodb/driver/cursorinterface/getid.xml b/reference/mongodb/mongodb/driver/cursorinterface/getid.xml deleted file mode 100644 index b32320898..000000000 --- a/reference/mongodb/mongodb/driver/cursorinterface/getid.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - MongoDB\Driver\CursorInterface::getId - Returns the ID for this cursor - - - - &reftitle.description; - - abstract public MongoDB\Driver\CursorIdMongoDB\Driver\CursorInterface::getId - - - - Returns the MongoDB\Driver\CursorId associated with - this cursor. A cursor ID uniquely identifies the cursor on the server. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the MongoDB\Driver\CursorId for this cursor. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Cursor::getId - MongoDB\Driver\CursorId - MongoDB\Driver\CursorId::__toString - - - - - - diff --git a/reference/mongodb/mongodb/driver/cursorinterface/getserver.xml b/reference/mongodb/mongodb/driver/cursorinterface/getserver.xml deleted file mode 100644 index f64b038d2..000000000 --- a/reference/mongodb/mongodb/driver/cursorinterface/getserver.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - MongoDB\Driver\CursorInterface::getServer - Returns the server associated with this cursor - - - - &reftitle.description; - - abstract public MongoDB\Driver\ServerMongoDB\Driver\CursorInterface::getServer - - - - Returns the MongoDB\Driver\Server associated with this - cursor. This is the server that executed the - MongoDB\Driver\Query or - MongoDB\Driver\Command. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the MongoDB\Driver\Server associated with this - cursor. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Cursor::getServer - MongoDB\Driver\Server - - - - - - diff --git a/reference/mongodb/mongodb/driver/cursorinterface/isdead.xml b/reference/mongodb/mongodb/driver/cursorinterface/isdead.xml deleted file mode 100644 index 95b856e9d..000000000 --- a/reference/mongodb/mongodb/driver/cursorinterface/isdead.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - MongoDB\Driver\CursorInterface::isDead - Checks if the cursor may have additional results - - - - &reftitle.description; - - abstract public boolMongoDB\Driver\CursorInterface::isDead - - - - Checks whether the cursor may have additional results available to read. A - cursor is initially "alive" but may become "dead" for any of the following - reasons: - - Advancing a non-tailable cursor did not return a document - The cursor encountered an error - The cursor read its last batch to completion - The cursor reached its configured limit - - This is primarily useful with tailable cursors. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; if additional results are not available, and &false; - otherwise. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Cursor::isDead - - - - - - diff --git a/reference/mongodb/mongodb/driver/cursorinterface/settypemap.xml b/reference/mongodb/mongodb/driver/cursorinterface/settypemap.xml deleted file mode 100644 index 6d3f04165..000000000 --- a/reference/mongodb/mongodb/driver/cursorinterface/settypemap.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - MongoDB\Driver\CursorInterface::setTypeMap - Sets a type map to use for BSON unserialization - - - - &reftitle.description; - - abstract public voidMongoDB\Driver\CursorInterface::setTypeMap - arraytypemap - - - Sets the type map - configuration to use when unserializing the BSON results into PHP - values. - - - - - &reftitle.parameters; - - &mongodb.parameter.typeMap; - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Cursor::setTypeMap - - - - - - - diff --git a/reference/mongodb/mongodb/driver/cursorinterface/toarray.xml b/reference/mongodb/mongodb/driver/cursorinterface/toarray.xml deleted file mode 100644 index 466548205..000000000 --- a/reference/mongodb/mongodb/driver/cursorinterface/toarray.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - MongoDB\Driver\CursorInterface::toArray - Returns an array containing all results for this cursor - - - - &reftitle.description; - - abstract public arrayMongoDB\Driver\CursorInterface::toArray - - - - Iterates the cursor and returns its results in an array. - MongoDB\Driver\CursorInterface::setTypeMap may be used - to control how documents are unserialized into PHP values. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an array containing all results for this cursor. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Cursor::toArray - MongoDB\Driver\CursorInterface::setTypeMap - - - - - - diff --git a/reference/mongodb/mongodb/driver/entities.bulkwrite.xml b/reference/mongodb/mongodb/driver/entities.bulkwrite.xml deleted file mode 100644 index 37daf3ef1..000000000 --- a/reference/mongodb/mongodb/driver/entities.bulkwrite.xml +++ /dev/null @@ -1,5 +0,0 @@ -&reference.mongodb.mongodb.driver.bulkwrite.construct; -&reference.mongodb.mongodb.driver.bulkwrite.count; -&reference.mongodb.mongodb.driver.bulkwrite.delete; -&reference.mongodb.mongodb.driver.bulkwrite.insert; -&reference.mongodb.mongodb.driver.bulkwrite.update; diff --git a/reference/mongodb/mongodb/driver/entities.clientencryption.xml b/reference/mongodb/mongodb/driver/entities.clientencryption.xml deleted file mode 100644 index 5f1efac83..000000000 --- a/reference/mongodb/mongodb/driver/entities.clientencryption.xml +++ /dev/null @@ -1,3 +0,0 @@ -&reference.mongodb.mongodb.driver.clientencryption.createdatakey; -&reference.mongodb.mongodb.driver.clientencryption.decrypt; -&reference.mongodb.mongodb.driver.clientencryption.encrypt; diff --git a/reference/mongodb/mongodb/driver/entities.command.xml b/reference/mongodb/mongodb/driver/entities.command.xml deleted file mode 100644 index 13257468e..000000000 --- a/reference/mongodb/mongodb/driver/entities.command.xml +++ /dev/null @@ -1 +0,0 @@ -&reference.mongodb.mongodb.driver.command.construct; diff --git a/reference/mongodb/mongodb/driver/entities.cursor.xml b/reference/mongodb/mongodb/driver/entities.cursor.xml deleted file mode 100644 index fa2022faa..000000000 --- a/reference/mongodb/mongodb/driver/entities.cursor.xml +++ /dev/null @@ -1,11 +0,0 @@ -&reference.mongodb.mongodb.driver.cursor.construct; -&reference.mongodb.mongodb.driver.cursor.current; -&reference.mongodb.mongodb.driver.cursor.getid; -&reference.mongodb.mongodb.driver.cursor.getserver; -&reference.mongodb.mongodb.driver.cursor.isdead; -&reference.mongodb.mongodb.driver.cursor.key; -&reference.mongodb.mongodb.driver.cursor.next; -&reference.mongodb.mongodb.driver.cursor.rewind; -&reference.mongodb.mongodb.driver.cursor.settypemap; -&reference.mongodb.mongodb.driver.cursor.toarray; -&reference.mongodb.mongodb.driver.cursor.valid; diff --git a/reference/mongodb/mongodb/driver/entities.cursorid.xml b/reference/mongodb/mongodb/driver/entities.cursorid.xml deleted file mode 100644 index 3ade0b368..000000000 --- a/reference/mongodb/mongodb/driver/entities.cursorid.xml +++ /dev/null @@ -1,4 +0,0 @@ -&reference.mongodb.mongodb.driver.cursorid.construct; -&reference.mongodb.mongodb.driver.cursorid.serialize; -&reference.mongodb.mongodb.driver.cursorid.tostring; -&reference.mongodb.mongodb.driver.cursorid.unserialize; diff --git a/reference/mongodb/mongodb/driver/entities.cursorinterface.xml b/reference/mongodb/mongodb/driver/entities.cursorinterface.xml deleted file mode 100644 index 2140531ac..000000000 --- a/reference/mongodb/mongodb/driver/entities.cursorinterface.xml +++ /dev/null @@ -1,5 +0,0 @@ -&reference.mongodb.mongodb.driver.cursorinterface.getid; -&reference.mongodb.mongodb.driver.cursorinterface.getserver; -&reference.mongodb.mongodb.driver.cursorinterface.isdead; -&reference.mongodb.mongodb.driver.cursorinterface.settypemap; -&reference.mongodb.mongodb.driver.cursorinterface.toarray; diff --git a/reference/mongodb/mongodb/driver/entities.exception.xml b/reference/mongodb/mongodb/driver/entities.exception.xml deleted file mode 100644 index 9bfbb8159..000000000 --- a/reference/mongodb/mongodb/driver/entities.exception.xml +++ /dev/null @@ -1,18 +0,0 @@ -&reference.mongodb.mongodb.driver.exception.authenticationexception; -&reference.mongodb.mongodb.driver.exception.bulkwriteexception; -&reference.mongodb.mongodb.driver.exception.commandexception; -&reference.mongodb.mongodb.driver.exception.connectionexception; -&reference.mongodb.mongodb.driver.exception.connectiontimeoutexception; -&reference.mongodb.mongodb.driver.exception.encryptionexception; -&reference.mongodb.mongodb.driver.exception.entities.commandexception; -&reference.mongodb.mongodb.driver.exception.entities.runtimeexception; -&reference.mongodb.mongodb.driver.exception.entities.writeexception; -&reference.mongodb.mongodb.driver.exception.exception; -&reference.mongodb.mongodb.driver.exception.executiontimeoutexception; -&reference.mongodb.mongodb.driver.exception.invalidargumentexception; -&reference.mongodb.mongodb.driver.exception.logicexception; -&reference.mongodb.mongodb.driver.exception.runtimeexception; -&reference.mongodb.mongodb.driver.exception.serverexception; -&reference.mongodb.mongodb.driver.exception.sslconnectionexception; -&reference.mongodb.mongodb.driver.exception.unexpectedvalueexception; -&reference.mongodb.mongodb.driver.exception.writeexception; diff --git a/reference/mongodb/mongodb/driver/entities.manager.xml b/reference/mongodb/mongodb/driver/entities.manager.xml deleted file mode 100644 index d59e7bf79..000000000 --- a/reference/mongodb/mongodb/driver/entities.manager.xml +++ /dev/null @@ -1,16 +0,0 @@ -&reference.mongodb.mongodb.driver.manager.addsubscriber; -&reference.mongodb.mongodb.driver.manager.construct; -&reference.mongodb.mongodb.driver.manager.createclientencryption; -&reference.mongodb.mongodb.driver.manager.executebulkwrite; -&reference.mongodb.mongodb.driver.manager.executecommand; -&reference.mongodb.mongodb.driver.manager.executequery; -&reference.mongodb.mongodb.driver.manager.executereadcommand; -&reference.mongodb.mongodb.driver.manager.executereadwritecommand; -&reference.mongodb.mongodb.driver.manager.executewritecommand; -&reference.mongodb.mongodb.driver.manager.getreadconcern; -&reference.mongodb.mongodb.driver.manager.getreadpreference; -&reference.mongodb.mongodb.driver.manager.getservers; -&reference.mongodb.mongodb.driver.manager.getwriteconcern; -&reference.mongodb.mongodb.driver.manager.removesubscriber; -&reference.mongodb.mongodb.driver.manager.selectserver; -&reference.mongodb.mongodb.driver.manager.startsession; diff --git a/reference/mongodb/mongodb/driver/entities.monitoring.xml b/reference/mongodb/mongodb/driver/entities.monitoring.xml deleted file mode 100644 index 10b697bd4..000000000 --- a/reference/mongodb/mongodb/driver/entities.monitoring.xml +++ /dev/null @@ -1,19 +0,0 @@ -&reference.mongodb.mongodb.driver.monitoring.commandfailedevent; -&reference.mongodb.mongodb.driver.monitoring.commandstartedevent; -&reference.mongodb.mongodb.driver.monitoring.commandsubscriber; -&reference.mongodb.mongodb.driver.monitoring.commandsucceededevent; -&reference.mongodb.mongodb.driver.monitoring.entities.commandfailedevent; -&reference.mongodb.mongodb.driver.monitoring.entities.commandstartedevent; -&reference.mongodb.mongodb.driver.monitoring.entities.commandsubscriber; -&reference.mongodb.mongodb.driver.monitoring.entities.commandsucceededevent; -&reference.mongodb.mongodb.driver.monitoring.sdamsubscriber; -&reference.mongodb.mongodb.driver.monitoring.serverchangedevent; -&reference.mongodb.mongodb.driver.monitoring.serverclosedevent; -&reference.mongodb.mongodb.driver.monitoring.serverheartbeatfailedevent; -&reference.mongodb.mongodb.driver.monitoring.serverheartbeatstartedevent; -&reference.mongodb.mongodb.driver.monitoring.serverheartbeatsucceededevent; -&reference.mongodb.mongodb.driver.monitoring.serveropeningevent; -&reference.mongodb.mongodb.driver.monitoring.subscriber; -&reference.mongodb.mongodb.driver.monitoring.topologychangedevent; -&reference.mongodb.mongodb.driver.monitoring.topologyclosedevent; -&reference.mongodb.mongodb.driver.monitoring.topologyopeningevent; diff --git a/reference/mongodb/mongodb/driver/entities.query.xml b/reference/mongodb/mongodb/driver/entities.query.xml deleted file mode 100644 index 6f7100eca..000000000 --- a/reference/mongodb/mongodb/driver/entities.query.xml +++ /dev/null @@ -1 +0,0 @@ -&reference.mongodb.mongodb.driver.query.construct; diff --git a/reference/mongodb/mongodb/driver/entities.readconcern.xml b/reference/mongodb/mongodb/driver/entities.readconcern.xml deleted file mode 100644 index 709a2d3b2..000000000 --- a/reference/mongodb/mongodb/driver/entities.readconcern.xml +++ /dev/null @@ -1,6 +0,0 @@ -&reference.mongodb.mongodb.driver.readconcern.bsonserialize; -&reference.mongodb.mongodb.driver.readconcern.construct; -&reference.mongodb.mongodb.driver.readconcern.getlevel; -&reference.mongodb.mongodb.driver.readconcern.isdefault; -&reference.mongodb.mongodb.driver.readconcern.serialize; -&reference.mongodb.mongodb.driver.readconcern.unserialize; diff --git a/reference/mongodb/mongodb/driver/entities.readpreference.xml b/reference/mongodb/mongodb/driver/entities.readpreference.xml deleted file mode 100644 index 26c34bf41..000000000 --- a/reference/mongodb/mongodb/driver/entities.readpreference.xml +++ /dev/null @@ -1,9 +0,0 @@ -&reference.mongodb.mongodb.driver.readpreference.bsonserialize; -&reference.mongodb.mongodb.driver.readpreference.construct; -&reference.mongodb.mongodb.driver.readpreference.gethedge; -&reference.mongodb.mongodb.driver.readpreference.getmaxstalenessseconds; -&reference.mongodb.mongodb.driver.readpreference.getmode; -&reference.mongodb.mongodb.driver.readpreference.getmodestring; -&reference.mongodb.mongodb.driver.readpreference.gettagsets; -&reference.mongodb.mongodb.driver.readpreference.serialize; -&reference.mongodb.mongodb.driver.readpreference.unserialize; diff --git a/reference/mongodb/mongodb/driver/entities.server.xml b/reference/mongodb/mongodb/driver/entities.server.xml deleted file mode 100644 index c21483274..000000000 --- a/reference/mongodb/mongodb/driver/entities.server.xml +++ /dev/null @@ -1,19 +0,0 @@ -&reference.mongodb.mongodb.driver.server.construct; -&reference.mongodb.mongodb.driver.server.executebulkwrite; -&reference.mongodb.mongodb.driver.server.executecommand; -&reference.mongodb.mongodb.driver.server.executequery; -&reference.mongodb.mongodb.driver.server.executereadcommand; -&reference.mongodb.mongodb.driver.server.executereadwritecommand; -&reference.mongodb.mongodb.driver.server.executewritecommand; -&reference.mongodb.mongodb.driver.server.gethost; -&reference.mongodb.mongodb.driver.server.getinfo; -&reference.mongodb.mongodb.driver.server.getlatency; -&reference.mongodb.mongodb.driver.server.getport; -&reference.mongodb.mongodb.driver.server.getserverdescription; -&reference.mongodb.mongodb.driver.server.gettags; -&reference.mongodb.mongodb.driver.server.gettype; -&reference.mongodb.mongodb.driver.server.isarbiter; -&reference.mongodb.mongodb.driver.server.ishidden; -&reference.mongodb.mongodb.driver.server.ispassive; -&reference.mongodb.mongodb.driver.server.isprimary; -&reference.mongodb.mongodb.driver.server.issecondary; diff --git a/reference/mongodb/mongodb/driver/entities.serverapi.xml b/reference/mongodb/mongodb/driver/entities.serverapi.xml deleted file mode 100644 index ab1cc9f82..000000000 --- a/reference/mongodb/mongodb/driver/entities.serverapi.xml +++ /dev/null @@ -1,4 +0,0 @@ -&reference.mongodb.mongodb.driver.serverapi.bsonserialize; -&reference.mongodb.mongodb.driver.serverapi.construct; -&reference.mongodb.mongodb.driver.serverapi.serialize; -&reference.mongodb.mongodb.driver.serverapi.unserialize; diff --git a/reference/mongodb/mongodb/driver/entities.serverdescription.xml b/reference/mongodb/mongodb/driver/entities.serverdescription.xml deleted file mode 100644 index fcdebbf59..000000000 --- a/reference/mongodb/mongodb/driver/entities.serverdescription.xml +++ /dev/null @@ -1,6 +0,0 @@ -&reference.mongodb.mongodb.driver.serverdescription.gethelloresponse; -&reference.mongodb.mongodb.driver.serverdescription.gethost; -&reference.mongodb.mongodb.driver.serverdescription.getlastupdatetime; -&reference.mongodb.mongodb.driver.serverdescription.getport; -&reference.mongodb.mongodb.driver.serverdescription.getroundtriptime; -&reference.mongodb.mongodb.driver.serverdescription.gettype; diff --git a/reference/mongodb/mongodb/driver/entities.session.xml b/reference/mongodb/mongodb/driver/entities.session.xml deleted file mode 100644 index ee7203c72..000000000 --- a/reference/mongodb/mongodb/driver/entities.session.xml +++ /dev/null @@ -1,15 +0,0 @@ -&reference.mongodb.mongodb.driver.session.aborttransaction; -&reference.mongodb.mongodb.driver.session.advanceclustertime; -&reference.mongodb.mongodb.driver.session.advanceoperationtime; -&reference.mongodb.mongodb.driver.session.committransaction; -&reference.mongodb.mongodb.driver.session.construct; -&reference.mongodb.mongodb.driver.session.endsession; -&reference.mongodb.mongodb.driver.session.getclustertime; -&reference.mongodb.mongodb.driver.session.getlogicalsessionid; -&reference.mongodb.mongodb.driver.session.getoperationtime; -&reference.mongodb.mongodb.driver.session.getserver; -&reference.mongodb.mongodb.driver.session.gettransactionoptions; -&reference.mongodb.mongodb.driver.session.gettransactionstate; -&reference.mongodb.mongodb.driver.session.isdirty; -&reference.mongodb.mongodb.driver.session.isintransaction; -&reference.mongodb.mongodb.driver.session.starttransaction; diff --git a/reference/mongodb/mongodb/driver/entities.topologydescription.xml b/reference/mongodb/mongodb/driver/entities.topologydescription.xml deleted file mode 100644 index 3af929d93..000000000 --- a/reference/mongodb/mongodb/driver/entities.topologydescription.xml +++ /dev/null @@ -1,4 +0,0 @@ -&reference.mongodb.mongodb.driver.topologydescription.getservers; -&reference.mongodb.mongodb.driver.topologydescription.gettype; -&reference.mongodb.mongodb.driver.topologydescription.hasreadableserver; -&reference.mongodb.mongodb.driver.topologydescription.haswritableserver; diff --git a/reference/mongodb/mongodb/driver/entities.writeconcern.xml b/reference/mongodb/mongodb/driver/entities.writeconcern.xml deleted file mode 100644 index 628c72057..000000000 --- a/reference/mongodb/mongodb/driver/entities.writeconcern.xml +++ /dev/null @@ -1,8 +0,0 @@ -&reference.mongodb.mongodb.driver.writeconcern.bsonserialize; -&reference.mongodb.mongodb.driver.writeconcern.construct; -&reference.mongodb.mongodb.driver.writeconcern.getjournal; -&reference.mongodb.mongodb.driver.writeconcern.getw; -&reference.mongodb.mongodb.driver.writeconcern.getwtimeout; -&reference.mongodb.mongodb.driver.writeconcern.isdefault; -&reference.mongodb.mongodb.driver.writeconcern.serialize; -&reference.mongodb.mongodb.driver.writeconcern.unserialize; diff --git a/reference/mongodb/mongodb/driver/entities.writeconcernerror.xml b/reference/mongodb/mongodb/driver/entities.writeconcernerror.xml deleted file mode 100644 index 004198a84..000000000 --- a/reference/mongodb/mongodb/driver/entities.writeconcernerror.xml +++ /dev/null @@ -1,3 +0,0 @@ -&reference.mongodb.mongodb.driver.writeconcernerror.getcode; -&reference.mongodb.mongodb.driver.writeconcernerror.getinfo; -&reference.mongodb.mongodb.driver.writeconcernerror.getmessage; diff --git a/reference/mongodb/mongodb/driver/entities.writeerror.xml b/reference/mongodb/mongodb/driver/entities.writeerror.xml deleted file mode 100644 index 2ff5a70b2..000000000 --- a/reference/mongodb/mongodb/driver/entities.writeerror.xml +++ /dev/null @@ -1,4 +0,0 @@ -&reference.mongodb.mongodb.driver.writeerror.getcode; -&reference.mongodb.mongodb.driver.writeerror.getindex; -&reference.mongodb.mongodb.driver.writeerror.getinfo; -&reference.mongodb.mongodb.driver.writeerror.getmessage; diff --git a/reference/mongodb/mongodb/driver/entities.writeresult.xml b/reference/mongodb/mongodb/driver/entities.writeresult.xml deleted file mode 100644 index c19d55081..000000000 --- a/reference/mongodb/mongodb/driver/entities.writeresult.xml +++ /dev/null @@ -1,10 +0,0 @@ -&reference.mongodb.mongodb.driver.writeresult.getdeletedcount; -&reference.mongodb.mongodb.driver.writeresult.getinsertedcount; -&reference.mongodb.mongodb.driver.writeresult.getmatchedcount; -&reference.mongodb.mongodb.driver.writeresult.getmodifiedcount; -&reference.mongodb.mongodb.driver.writeresult.getserver; -&reference.mongodb.mongodb.driver.writeresult.getupsertedcount; -&reference.mongodb.mongodb.driver.writeresult.getupsertedids; -&reference.mongodb.mongodb.driver.writeresult.getwriteconcernerror; -&reference.mongodb.mongodb.driver.writeresult.getwriteerrors; -&reference.mongodb.mongodb.driver.writeresult.isacknowledged; diff --git a/reference/mongodb/mongodb/driver/exception/authenticationexception.xml b/reference/mongodb/mongodb/driver/exception/authenticationexception.xml deleted file mode 100644 index e3e3fb533..000000000 --- a/reference/mongodb/mongodb/driver/exception/authenticationexception.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - The MongoDB\Driver\Exception\AuthenticationException class - MongoDB\Driver\Exception\AuthenticationException - - - - -
- &reftitle.intro; - - Thrown when the driver fails to authenticate with the server. - -
- - -
- &reftitle.classsynopsis; - - - - MongoDB\Driver\Exception\AuthenticationException - - - - - MongoDB\Driver\Exception\AuthenticationException - - - - extends - MongoDB\Driver\Exception\ConnectionException - - - - MongoDB\Driver\Exception\Exception - - - - &InheritedProperties; - - - - - - &InheritedMethods; - - - - - - - - -
- - - - - - diff --git a/reference/mongodb/mongodb/driver/exception/bulkwriteexception.xml b/reference/mongodb/mongodb/driver/exception/bulkwriteexception.xml deleted file mode 100644 index 67c49507f..000000000 --- a/reference/mongodb/mongodb/driver/exception/bulkwriteexception.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - The MongoDB\Driver\Exception\BulkWriteException class - MongoDB\Driver\Exception\BulkWriteException - - - - -
- &reftitle.intro; - - Thrown when a bulk write operation fails. - -
- - -
- &reftitle.classsynopsis; - - - - MongoDB\Driver\Exception\BulkWriteException - - - - - MongoDB\Driver\Exception\BulkWriteException - - - - extends - MongoDB\Driver\Exception\WriteException - - - - MongoDB\Driver\Exception\Exception - - - - &InheritedProperties; - - - - - - - &InheritedMethods; - - - - - - - - - -
- - - - - - diff --git a/reference/mongodb/mongodb/driver/exception/commandexception.xml b/reference/mongodb/mongodb/driver/exception/commandexception.xml deleted file mode 100644 index ab44ffc22..000000000 --- a/reference/mongodb/mongodb/driver/exception/commandexception.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - The MongoDB\Driver\Exception\CommandException class - MongoDB\Driver\Exception\CommandException - - - - -
- &reftitle.intro; - - Thrown when a command fails. - -
- - -
- &reftitle.classsynopsis; - - - - MongoDB\Driver\Exception\CommandException - - - - - MongoDB\Driver\Exception\CommandException - - - - extends - MongoDB\Driver\Exception\ServerException - - - - MongoDB\Driver\Exception\Exception - - - - &Properties; - - protected - object - resultDocument - - - &InheritedProperties; - - - - - - &Methods; - - - &InheritedMethods; - - - - - - - - -
- - - -
- &reftitle.properties; - - - resultDocument - - - The result document associated with the failed command. - - - - -
- - - - - &reference.mongodb.mongodb.driver.exception.entities.commandexception; - - - - diff --git a/reference/mongodb/mongodb/driver/exception/commandexception/getresultdocument.xml b/reference/mongodb/mongodb/driver/exception/commandexception/getresultdocument.xml deleted file mode 100644 index 9835c795b..000000000 --- a/reference/mongodb/mongodb/driver/exception/commandexception/getresultdocument.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - MongoDB\Driver\Exception\CommandException::getResultDocument - Returns the result document for the failed command - - - - &reftitle.description; - - final public objectMongoDB\Driver\Exception\CommandException::getResultDocument - - - - Returns the result document for the failed command. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The result document for the failed command. - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::executeCommand - - - - - - diff --git a/reference/mongodb/mongodb/driver/exception/connectionexception.xml b/reference/mongodb/mongodb/driver/exception/connectionexception.xml deleted file mode 100644 index c85a1b97c..000000000 --- a/reference/mongodb/mongodb/driver/exception/connectionexception.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - The MongoDB\Driver\Exception\ConnectionException class - MongoDB\Driver\Exception\ConnectionException - - - - -
- &reftitle.intro; - - Base class for exceptions thrown when the driver fails to establish a - database connection. - -
- - -
- &reftitle.classsynopsis; - - - - MongoDB\Driver\Exception\ConnectionException - - - - - MongoDB\Driver\Exception\ConnectionException - - - - extends - MongoDB\Driver\Exception\RuntimeException - - - - MongoDB\Driver\Exception\Exception - - - - &InheritedProperties; - - - - - &InheritedMethods; - - - - - - - -
- - - - - - diff --git a/reference/mongodb/mongodb/driver/exception/connectiontimeoutexception.xml b/reference/mongodb/mongodb/driver/exception/connectiontimeoutexception.xml deleted file mode 100644 index 94a0f3606..000000000 --- a/reference/mongodb/mongodb/driver/exception/connectiontimeoutexception.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - The MongoDB\Driver\Exception\ConnectionTimeoutException class - MongoDB\Driver\Exception\ConnectionTimeoutException - - - - -
- &reftitle.intro; - - Thrown when the driver fails to establish a database connection within a - specified time limit - (connectTimeoutMS) - or server selection fails - (serverSelectionTimeoutMS). - -
- - -
- &reftitle.classsynopsis; - - - - MongoDB\Driver\Exception\ConnectionTimeoutException - - - - final - - MongoDB\Driver\Exception\ConnectionTimeoutException - - - - extends - MongoDB\Driver\Exception\ConnectionException - - - - MongoDB\Driver\Exception\Exception - - - - &InheritedProperties; - - - - - - &InheritedMethods; - - - - - - - - -
- - - - - - diff --git a/reference/mongodb/mongodb/driver/exception/encryptionexception.xml b/reference/mongodb/mongodb/driver/exception/encryptionexception.xml deleted file mode 100644 index dc13d4ee2..000000000 --- a/reference/mongodb/mongodb/driver/exception/encryptionexception.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - The MongoDB\Driver\Exception\EncryptionException class - MongoDB\Driver\Exception\EncryptionException - - - - -
- &reftitle.intro; - - Base class for exceptions thrown during client-side encryption. - -
- - -
- &reftitle.classsynopsis; - - - - MongoDB\Driver\Exception\EncryptionException - - - - - MongoDB\Driver\Exception\EncryptionException - - - - extends - MongoDB\Driver\Exception\RuntimeException - - - - MongoDB\Driver\Exception\Exception - - - - &InheritedProperties; - - - - - &InheritedMethods; - - - - - - - -
- - - - - - diff --git a/reference/mongodb/mongodb/driver/exception/entities.commandexception.xml b/reference/mongodb/mongodb/driver/exception/entities.commandexception.xml deleted file mode 100644 index dddc9a456..000000000 --- a/reference/mongodb/mongodb/driver/exception/entities.commandexception.xml +++ /dev/null @@ -1 +0,0 @@ -&reference.mongodb.mongodb.driver.exception.commandexception.getresultdocument; diff --git a/reference/mongodb/mongodb/driver/exception/entities.runtimeexception.xml b/reference/mongodb/mongodb/driver/exception/entities.runtimeexception.xml deleted file mode 100644 index 68ff2c58a..000000000 --- a/reference/mongodb/mongodb/driver/exception/entities.runtimeexception.xml +++ /dev/null @@ -1 +0,0 @@ -&reference.mongodb.mongodb.driver.exception.runtimeexception.haserrorlabel; diff --git a/reference/mongodb/mongodb/driver/exception/entities.writeexception.xml b/reference/mongodb/mongodb/driver/exception/entities.writeexception.xml deleted file mode 100644 index 526fd4ed2..000000000 --- a/reference/mongodb/mongodb/driver/exception/entities.writeexception.xml +++ /dev/null @@ -1 +0,0 @@ -&reference.mongodb.mongodb.driver.exception.writeexception.getwriteresult; diff --git a/reference/mongodb/mongodb/driver/exception/exception.xml b/reference/mongodb/mongodb/driver/exception/exception.xml deleted file mode 100644 index f266d6023..000000000 --- a/reference/mongodb/mongodb/driver/exception/exception.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - The MongoDB\Driver\Exception\Exception interface - MongoDB\Driver\Exception\Exception - - - - -
- &reftitle.intro; - - Common interface for all driver exceptions. This may be used to catch only - exceptions originating from the driver itself. - -
- - -
- &reftitle.classsynopsis; - - - - MongoDB\Driver\Exception\Exception - - - - - MongoDB\Driver\Exception\Exception - - - - - - - -
- - - - - - diff --git a/reference/mongodb/mongodb/driver/exception/executiontimeoutexception.xml b/reference/mongodb/mongodb/driver/exception/executiontimeoutexception.xml deleted file mode 100644 index a26d0b7f6..000000000 --- a/reference/mongodb/mongodb/driver/exception/executiontimeoutexception.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - The MongoDB\Driver\Exception\ExecutionTimeoutException class - MongoDB\Driver\Exception\ExecutionTimeoutException - - - - -
- &reftitle.intro; - - Thrown when a query or command fails to complete within a specified time - limit (e.g. - maxTimeMS). - -
- - -
- &reftitle.classsynopsis; - - - - MongoDB\Driver\Exception\ExecutionTimeoutException - - - - final - - MongoDB\Driver\Exception\ExecutionTimeoutException - - - - extends - MongoDB\Driver\Exception\ServerException - - - - MongoDB\Driver\Exception\Exception - - - - &InheritedProperties; - - - - - - &InheritedMethods; - - - - - - - - -
- -
- &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 1.5.0 - - - This class now extends - MongoDB\Driver\Exception\ServerException - instead of - MongoDB\Driver\Exception\RuntimeException. - - - - - - - -
- - - - - - diff --git a/reference/mongodb/mongodb/driver/exception/invalidargumentexception.xml b/reference/mongodb/mongodb/driver/exception/invalidargumentexception.xml deleted file mode 100644 index 691c0c8d5..000000000 --- a/reference/mongodb/mongodb/driver/exception/invalidargumentexception.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - The MongoDB\Driver\Exception\InvalidArgumentException class - MongoDB\Driver\Exception\InvalidArgumentException - - - - -
- &reftitle.intro; - - Thrown when a driver method is given invalid arguments (e.g. invalid option - types). - -
- - -
- &reftitle.classsynopsis; - - - - MongoDB\Driver\Exception\InvalidArgumentException - - - - - MongoDB\Driver\Exception\InvalidArgumentException - - - - extends - InvalidArgumentException - - - - MongoDB\Driver\Exception\Exception - - - - &InheritedProperties; - - - - &InheritedMethods; - - - - - - -
- - - - - - diff --git a/reference/mongodb/mongodb/driver/exception/logicexception.xml b/reference/mongodb/mongodb/driver/exception/logicexception.xml deleted file mode 100644 index abc0d2fb2..000000000 --- a/reference/mongodb/mongodb/driver/exception/logicexception.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - The MongoDB\Driver\Exception\LogicException class - MongoDB\Driver\Exception\LogicException - - - - -
- &reftitle.intro; - - Thrown when the driver is incorrectly used (e.g. rewinding a cursor). - -
- - -
- &reftitle.classsynopsis; - - - - MongoDB\Driver\Exception\LogicException - - - - - MongoDB\Driver\Exception\LogicException - - - - extends - LogicException - - - - MongoDB\Driver\Exception\Exception - - - - &InheritedProperties; - - - - &InheritedMethods; - - - - - - -
- - - - - - diff --git a/reference/mongodb/mongodb/driver/exception/runtimeexception.xml b/reference/mongodb/mongodb/driver/exception/runtimeexception.xml deleted file mode 100644 index 525da2155..000000000 --- a/reference/mongodb/mongodb/driver/exception/runtimeexception.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - The MongoDB\Driver\Exception\RuntimeException class - MongoDB\Driver\Exception\RuntimeException - - - - -
- &reftitle.intro; - - Thrown when the driver encounters a runtime error (e.g. internal error from - libmongoc). - -
- - -
- &reftitle.classsynopsis; - - - - MongoDB\Driver\Exception\RuntimeException - - - - - MongoDB\Driver\Exception\RuntimeException - - - - extends - RuntimeException - - - - MongoDB\Driver\Exception\Exception - - - - &Properties; - - protected - arraynull - errorLabels - - - &InheritedProperties; - - - - &Methods; - - - &InheritedMethods; - - - - - - -
- - -
- &reftitle.properties; - - - errorLabels - - - Contains an array of error labels to go with an exception. For example, - error labels can be used to detect whether a transaction can be retried - safely if the TransientTransactionError label is - present. The existence of a specific error label should be tested for - with the - MongoDB\Driver\Exception\RuntimeException::hasErrorLabel, - instead of interpreting this errorLabels property - manually. - - - - -
- - -
- &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 1.6.0 - - - The - MongoDB\Driver\Exception\RuntimeException::hasErrorLabel - method and - MongoDB\Driver\Exception\RuntimeException::errorLabels - property have been added. - - - - - - - -
- - - - &reference.mongodb.mongodb.driver.exception.entities.runtimeexception; - - - - diff --git a/reference/mongodb/mongodb/driver/exception/runtimeexception/haserrorlabel.xml b/reference/mongodb/mongodb/driver/exception/runtimeexception/haserrorlabel.xml deleted file mode 100644 index 3e0f4097b..000000000 --- a/reference/mongodb/mongodb/driver/exception/runtimeexception/haserrorlabel.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - MongoDB\Driver\Exception\RuntimeException::hasErrorLabel - Returns whether an error label is associated with an exception - - - - &reftitle.description; - - final public boolMongoDB\Driver\Exception\RuntimeException::hasErrorLabel - stringerrorLabel - - - Returns whether the errorLabel has been set for this - exception. Error labels are set by either the server or the driver to - indicated specific situations on which you might want to decide on how you - want to handle a specific exception. A common situation might be to find - out whether you can safely retry a transaction that failed due to a - transient error (like a networking issue, or a transaction conflict). - Examples of error labels are TransientTransactionError - and UnknownTransactionCommitResult. - - - - - - &reftitle.parameters; - - - errorLabel - - The name of the errorLabel to test for. - - - - - - - &reftitle.returnvalues; - - Whether the given errorLabel is associated with this - exception. - - - - - &reftitle.seealso; - - MongoDB\Driver\Session::commitTransaction - MongoDB documentation on transactions - - - - - - diff --git a/reference/mongodb/mongodb/driver/exception/serverexception.xml b/reference/mongodb/mongodb/driver/exception/serverexception.xml deleted file mode 100644 index c679a85fd..000000000 --- a/reference/mongodb/mongodb/driver/exception/serverexception.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - The MongoDB\Driver\Exception\ServerException class - MongoDB\Driver\Exception\ServerException - - - - -
- &reftitle.intro; - - Base class for exceptions thrown by the server. The code of this exception and its subclasses will correspond to the original error code from the server. - -
- - -
- &reftitle.classsynopsis; - - - - MongoDB\Driver\Exception\ServerException - - - - - MongoDB\Driver\Exception\ServerException - - - - extends - MongoDB\Driver\Exception\RuntimeException - - - - MongoDB\Driver\Exception\Exception - - - - &InheritedProperties; - - - - - &InheritedMethods; - - - - - - - -
- - - - - - diff --git a/reference/mongodb/mongodb/driver/exception/sslconnectionexception.xml b/reference/mongodb/mongodb/driver/exception/sslconnectionexception.xml deleted file mode 100644 index ef0821078..000000000 --- a/reference/mongodb/mongodb/driver/exception/sslconnectionexception.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - The MongoDB\Driver\Exception\SSLConnectionException class (deprecated) - MongoDB\Driver\Exception\SSLConnectionException - - - - - - This exception class is deprecated and may be removed in a future major version. The driver has never thrown this exception. - - - - -
- &reftitle.intro; - - Thrown when the driver fails to establish an SSL connection with the server. - -
- - -
- &reftitle.classsynopsis; - - - - MongoDB\Driver\Exception\SSLConnectionException - - - - final - - MongoDB\Driver\Exception\SSLConnectionException - - - - extends - MongoDB\Driver\Exception\ConnectionException - - - - MongoDB\Driver\Exception\Exception - - - - &InheritedProperties; - - - - - - &InheritedMethods; - - - - - - - - -
- - - - - - diff --git a/reference/mongodb/mongodb/driver/exception/unexpectedvalueexception.xml b/reference/mongodb/mongodb/driver/exception/unexpectedvalueexception.xml deleted file mode 100644 index 8a99d0c3e..000000000 --- a/reference/mongodb/mongodb/driver/exception/unexpectedvalueexception.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - The MongoDB\Driver\Exception\UnexpectedValueException class - MongoDB\Driver\Exception\UnexpectedValueException - - - - -
- &reftitle.intro; - - Thrown when the driver encounters an unexpected value (e.g. during BSON - serialization or deserialization). - -
- - -
- &reftitle.classsynopsis; - - - - MongoDB\Driver\Exception\UnexpectedValueException - - - - - MongoDB\Driver\Exception\UnexpectedValueException - - - - extends - UnexpectedValueException - - - - MongoDB\Driver\Exception\Exception - - - - &InheritedProperties; - - - - &InheritedMethods; - - - - - - -
- - - - - - diff --git a/reference/mongodb/mongodb/driver/exception/writeexception.xml b/reference/mongodb/mongodb/driver/exception/writeexception.xml deleted file mode 100644 index 35fc63ff9..000000000 --- a/reference/mongodb/mongodb/driver/exception/writeexception.xml +++ /dev/null @@ -1,144 +0,0 @@ - - - - - - The MongoDB\Driver\Exception\WriteException class - MongoDB\Driver\Exception\WriteException - - - - -
- &reftitle.intro; - - Base class for exceptions thrown by a failed write operation. The exception - encapsulates a MongoDB\Driver\WriteResult object. - -
- - -
- &reftitle.classsynopsis; - - - - MongoDB\Driver\Exception\WriteException - - - - - abstract - MongoDB\Driver\Exception\WriteException - - - - extends - MongoDB\Driver\Exception\ServerException - - - - MongoDB\Driver\Exception\Exception - - - - &Properties; - - protected - MongoDB\Driver\WriteResult - writeResult - - - &InheritedProperties; - - - - - - &Methods; - - - &InheritedMethods; - - - - - - - - -
- - - -
- &reftitle.properties; - - - writeResult - - - The MongoDB\Driver\WriteResult associated with - the failed write operation. - - - - -
- - -
- &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 1.5.0 - - - This class now extends - MongoDB\Driver\Exception\ServerException - instead of - MongoDB\Driver\Exception\RuntimeException. - - - - - - - -
- - - - &reference.mongodb.mongodb.driver.exception.entities.writeexception; - - - - diff --git a/reference/mongodb/mongodb/driver/exception/writeexception/getwriteresult.xml b/reference/mongodb/mongodb/driver/exception/writeexception/getwriteresult.xml deleted file mode 100644 index 70db2383b..000000000 --- a/reference/mongodb/mongodb/driver/exception/writeexception/getwriteresult.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - MongoDB\Driver\Exception\WriteException::getWriteResult - Returns the WriteResult for the failed write operation - - - - &reftitle.description; - - final public MongoDB\Driver\WriteResultMongoDB\Driver\Exception\WriteException::getWriteResult - - - - Returns the MongoDB\Driver\WriteResult for the failed - write operation. The - MongoDB\Driver\WriteResult::getWriteErrors and - MongoDB\Driver\WriteResult::getWriteConcernError methods - may be used to get more details about the failure. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The MongoDB\Driver\WriteResult for the failed write - operation. - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\Exception\WriteException::getWriteResult</function> example - -insert(['_id' => 1]); -$bulk->insert(['_id' => 1]); - -try { - $manager->executeBulkWrite('db.collection', $bulk); -} catch (MongoDB\Driver\Exception\WriteException $e) { - $writeResult = $e->getWriteResult(); - - if ($writeConcernError = $writeResult->getWriteConcernError()) { - var_dump($writeConcernError); - } - - if ($writeErrors = $writeResult->getWriteErrors()) { - var_dump($writeErrors); - } -} - -?> -]]> - - &example.outputs.similar; - - - object(MongoDB\Driver\WriteError)#5 (4) { - ["message"]=> - string(70) "E11000 duplicate key error index: db.collection.$_id_ dup key: { : 1 }" - ["code"]=> - int(11000) - ["index"]=> - int(1) - ["info"]=> - NULL - } -} -]]> - - - - - - - &reftitle.seealso; - - MongoDB\Driver\WriteResult - MongoDB\Driver\Manager::executeBulkWrite - - - - - - diff --git a/reference/mongodb/mongodb/driver/manager.xml b/reference/mongodb/mongodb/driver/manager.xml deleted file mode 100644 index 4c3ffb372..000000000 --- a/reference/mongodb/mongodb/driver/manager.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - The MongoDB\Driver\Manager class - MongoDB\Driver\Manager - - - - -
- &reftitle.intro; - - The MongoDB\Driver\Manager is the main entry point - to the extension. It is responsible for maintaining connections to MongoDB - (be it standalone server, replica set, or sharded cluster). - - - No connection to MongoDB is made upon instantiating the Manager. - This means the MongoDB\Driver\Manager can always be - constructed, even though one or more MongoDB servers are down. - - - Any write or query can throw connection exceptions as connections are created lazily. - A MongoDB server may also become unavailable during the life time of the script. - It is therefore important that all actions on the Manager to be wrapped in try/catch statements. - -
- - -
- &reftitle.classsynopsis; - - - - MongoDB\Driver\Manager - - - - final - - MongoDB\Driver\Manager - - - - - &Methods; - - - - -
- -
- &reftitle.examples; - - - <function>MongoDB\Driver\Manager::__construct</function> basic example - - var_dumping a - MongoDB\Driver\Manager will print out various - details about the manager that are otherwise not normally exposed. - This can be useful to debug how the driver views your MongoDB setup, and - which options are used. - - - -]]> - - &example.outputs.similar; - - - string(26) "mongodb://127.0.0.1:27017/" - ["cluster"]=> - array(0) { - } -} -]]> - - -
- - - &reference.mongodb.mongodb.driver.entities.manager; - - - - diff --git a/reference/mongodb/mongodb/driver/manager/addsubscriber.xml b/reference/mongodb/mongodb/driver/manager/addsubscriber.xml deleted file mode 100644 index b05b5fda5..000000000 --- a/reference/mongodb/mongodb/driver/manager/addsubscriber.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - MongoDB\Driver\Manager::addSubscriber - Registers a monitoring event subscriber with this Manager - - - - &reftitle.description; - - final public voidMongoDB\Driver\Manager::addSubscriber - MongoDB\Driver\Monitoring\Subscribersubscriber - - - Registers a monitoring event subscriber with this Manager. The subscriber - will be notified of all events for this Manager. - - - - If subscriber is already registered with this - Manager, this function is a no-op. If subscriber is - also registered globally, it will still only be notified once of each event - for this Manager. - - - - - - &reftitle.parameters; - - - subscriber (MongoDB\Driver\Monitoring\Subscriber) - - - A monitoring event subscriber to register with this Manager. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::removeSubscriber - MongoDB\Driver\Monitoring\Subscriber - MongoDB\Driver\Monitoring\CommandSubscriber - MongoDB\Driver\Monitoring\addSubscriber - - - - - - - diff --git a/reference/mongodb/mongodb/driver/manager/construct.xml b/reference/mongodb/mongodb/driver/manager/construct.xml deleted file mode 100644 index 9e615817d..000000000 --- a/reference/mongodb/mongodb/driver/manager/construct.xml +++ /dev/null @@ -1,1311 +0,0 @@ - - - - - - MongoDB\Driver\Manager::__construct - Create new MongoDB Manager - - - - &reftitle.description; - - final public MongoDB\Driver\Manager::__construct - stringuri"mongodb://127.0.0.1/" - arrayuriOptionsarray() - arraydriverOptionsarray() - - - Constructs a new MongoDB\Driver\Manager object with the specified options. - - - - Per the Server Discovery and Monitoring Specification, - this constructor performs no I/O. Connections will be initialized on demand, - when the first operation is executed. - - - - - When specifying any SSL or TLS URI options via the connection string or - uriOptions parameter, the driver will implicitly - enable TLS for its connections. To avoid this, either explicitly disable the - tls option or don't specify any TLS options. - - - &mongodb.note.forking; - - - - &reftitle.parameters; - - - uri - - - A mongodb:// connection URI: - - - - - - For details on supported URI options, see - Connection String Options - in the MongoDB manual. - Connection pool options - are not supported, as the PHP driver does not implement connection pools. - - - The uri is a URL, hence any special characters in - its components need to be URL encoded according to - RFC 3986. This is particularly - relevant to the username and password, which can often include special - characters such as @, :, or - %. When connecting via a Unix domain socket, the socket - path may contain special characters such as slashes and must be encoded. - The rawurlencode function may be used to encode - constituent parts of the URI. - - - The defaultAuthDb component may be used to specify the - database name associated with the user's credentials; however the - authSource URI option will take priority if specified. - If neither defaultAuthDb nor - authSource are specified, the admin - database will be used by default. The defaultAuthDb - component has no effect in the absence of user credentials. - - - - - uriOptions - - - Additional - connection string options, - which will overwrite any options with the same name in the - uri parameter. - - - - uriOptions - - - - Option - Type - Description - - - - - appname - string - - - MongoDB 3.4+ has the ability to annotate connections with metadata - provided by the connecting client. This metadata is included in the - server's logs upon establishing a connection and also recorded in - slow query logs when database profiling is enabled. - - - This option may be used to specify an application name, which will - be included in the metadata. The value cannot exceed 128 characters - in length. - - - - - authMechanism - string - - - The authentication mechanism that MongoDB will use to authenticate - the connection. For additional details and a list of supported - values, see - Authentication Options - in the MongoDB manual. - - - - - authMechanismProperties - array - - - Properties for the selected authentication mechanism. For additional - details and a list of supported properties, see the - Driver Authentication Specification. - - - - When not specified in the URI string, this option is expressed as - an array of key/value pairs. The keys and values in this array - should be strings. - - - - - - authSource - string - - - The database name associated with the user's credentials. Defaults - to the database component of the connection URI, or the - admin database if both are unspecified. - - - For authentication mechanisms that delegate credential storage to - other services (e.g. GSSAPI), this should be - "$external". - - - - - canonicalizeHostname - bool - - - If &true;, the driver will resolve the real hostname for the server - IP address before authenticating via SASL. Some underlying GSSAPI - layers already do this, but the functionality may be disabled in - their config (e.g. krb.conf). Defaults to - &false;. - - - This option is a deprecated alias for the - "CANONICALIZE_HOST_NAME" property of the - "authMechanismProperties" URI option. - - - - - compressors - string - - - A prioritized, comma-delimited list of compressors that the client - wants to use. Messages are only compressed if the client and server - share any compressors in common, and the compressor used in each - direction will depend on the individual configuration of the server - or driver. See the - Driver Compression Specification - for more information. - - - - - connectTimeoutMS - int - - - The time in milliseconds to attempt a connection before timing out. - Defaults to 10,000 milliseconds. - - - - - directConnection - bool - - - This option can be used to control replica set discovery behavior - when only a single host is provided in the connection string. By - default, providing a single member in the connection string will - establish a direct connection or discover additional members - depending on whether the "replicaSet" URI option - is omitted or present, respectively. Specify &false; to force - discovery to occur (if "replicaSet" is omitted) - or specify &true; to force a direct connection (if - "replicaSet" is present). - - - - - gssapiServiceName - string - - - Set the Kerberos service name when connecting to Kerberized MongoDB - instances. This value must match the service name set on MongoDB - instances (i.e. - saslServiceName - server parameter). Defaults to "mongodb". - - - This option is a deprecated alias for the - "SERVICE_NAME" property of the - "authMechanismProperties" URI option. - - - - - heartbeatFrequencyMS - int - - - Specifies the interval in milliseconds between the driver's checks - of the MongoDB topology, counted from the end of the previous check - until the beginning of the next one. Defaults to 60,000 - milliseconds. - - - Per the - Server Discovery and Monitoring Specification, - this value cannot be less than 500 milliseconds. - - - - - journal - bool - - - Corresponds to the default write concern's - journal parameter. If &true;, writes will - require acknowledgement from MongoDB that the operation has been - written to the journal. For details, see - MongoDB\Driver\WriteConcern. - - - - - loadBalanced - bool - - - Specifies whether the driver is connecting to a MongoDB cluster - through a load balancer. If &true;, the driver may only connect to a - single host (specified by either the connection string or SRV - lookup), the "directConnection" URI option - cannot be &true;, and the "replicaSet" URI option - must be omitted. Defaults to &false;. - - - - - localThresholdMS - int - - - The size in milliseconds of the latency window for selecting among - multiple suitable MongoDB instances while resolving a read - preference. Defaults to 15 milliseconds. - - - - - maxStalenessSeconds - int - - - Corresponds to the read preference's - "maxStalenessSeconds". Specifies, in seconds, how - stale a secondary can be before the client stops using it for read - operations. By default, there is no maximum staleness and clients - will not consider a secondary’s lag when choosing where to direct a - read operation. For details, see - MongoDB\Driver\ReadPreference. - - - If specified, the max staleness must be a signed 32-bit integer - greater than or equal to - MongoDB\Driver\ReadPreference::SMALLEST_MAX_STALENESS_SECONDS - (i.e. 90 seconds). - - - - - password - string - - The password for the user being authenticated. This option is useful - if the password contains special characters, which would otherwise - need to be URL encoded for the connection URI. - - - - readConcernLevel - string - - Corresponds to the read concern's level - parameter. Specifies the level of read isolation. For details, see - MongoDB\Driver\ReadConcern. - - - - readPreference - string - - - Corresponds to the read preference's mode - parameter. Defaults to "primary". For details, - see MongoDB\Driver\ReadPreference. - - - - - readPreferenceTags - array - - - Corresponds to the read preference's tagSets - parameter. Tag sets allow you to target read operations to specific - members of a replica set. For details, see - MongoDB\Driver\ReadPreference. - - - - When not specified in the URI string, this option is expressed as - an array consistent with the format expected by - MongoDB\Driver\ReadPreference::__construct. - - - - - - replicaSet - string - - - Specifies the name of the replica set. - - - - - retryReads - bool - - - Specifies whether or not the driver should automatically retry - certain read operations that fail due to transient network errors - or replica set elections. This functionality requires MongoDB 3.6+. - Defaults to &true;. - - - See the - Retryable Reads Specification - for more information. - - - - - retryWrites - bool - - - Specifies whether or not the driver should automatically retry - certain write operations that fail due to transient network errors - or replica set elections. This functionality requires MongoDB 3.6+. - Defaults to &true;. - - - See - Retryable Writes - in the MongoDB manual for more information. - - - - - safe - bool - - - If &true;, specifies 1 for the default write - concern's w parameter. If &false;, - 0 is specified. For details, see - MongoDB\Driver\WriteConcern. - - - This option is deprecated and should not be used. - - - - - serverSelectionTimeoutMS - int - - - Specifies how long in milliseconds to block for server selection - before throwing an exception. Defaults to 30,000 milliseconds. - - - - - serverSelectionTryOnce - bool - - - When &true;, instructs the driver to scan the MongoDB deployment - exactly once after server selection fails and then either select a - server or raise an error. When &false;, the driver blocks and - searches for a server up to the - "serverSelectionTimeoutMS" value. Defaults to - &true;. - - - - - socketCheckIntervalMS - int - - - If a socket has not been used recently, the driver must check it via - a hello command before using it for any - operation. Defaults to 5,000 milliseconds. - - - - - socketTimeoutMS - int - - - The time in milliseconds to attempt a send or receive on a socket - before timing out. Defaults to 300,000 milliseconds (i.e. five - minutes). - - - - - srvMaxHosts - int - - - The maximum number of SRV results to randomly select when initially - populating the seedlist or, during SRV polling, adding new hosts to - the topology. Defaults to 0 (i.e. no maximum). - - - - - srvServiceName - string - - - The service name to use for SRV lookup in initial DNS seedlist - discovery and SRV polling. Defaults to "mongodb". - - - - - ssl - bool - - - Initiates the connection with TLS/SSL if &true;. Defaults to - &false;. - - - This option is a deprecated alias for the "tls" - URI option. - - - - - tls - bool - - - Initiates the connection with TLS/SSL if &true;. Defaults to - &false;. - - - - - tlsAllowInvalidCertificates - bool - - - Specifies whether or not the driver should error when the server's - TLS certificate is invalid. Defaults to &false;. - - - - Disabling certificate validation creates a vulnerability. - - - - - - tlsAllowInvalidHostnames - bool - - - Specifies whether or not the driver should error when there is a - mismatch between the server's hostname and the hostname specified by - the TLS certificate. Defaults to &false;. - - - - Disabling certificate validation creates a vulnerability. Allowing - invalid hostnames may expose the driver to a - man-in-the-middle attack. - - - - - - tlsCAFile - string - - - Path to file with either a single or bundle of certificate - authorities to be considered trusted when making a TLS connection. - The system certificate store will be used by default. - - - - - tlsCertificateKeyFile - string - - - Path to the client certificate file or the client private key file; - in the case that they both are needed, the files should be - concatenated. - - - - - tlsCertificateKeyFilePassword - string - - - Password to decrypt the client private key (i.e. - "tlsCertificateKeyFile" URI option) to be used - for TLS connections. - - - - - tlsDisableCertificateRevocationCheck - bool - - - If &true;, the driver will not attempt to check certificate - revocation status (e.g. OCSP, CRL). Defaults to &false;. - - - - - tlsDisableOCSPEndpointCheck - bool - - - If &true;, the driver will not attempt to contact an OCSP responder - endpoint if needed (i.e. an OCSP response is not stapled). Defaults - to &false;. - - - - - tlsInsecure - bool - - - Relax TLS constraints as much as possible. Specifying &true; for - this option has the same effect as specifying &true; for both the - "tlsAllowInvalidCertificates" and - "tlsAllowInvalidHostnames" URI options. Defaults - to &false;. - - - - Disabling certificate validation creates a vulnerability. Allowing - invalid hostnames may expose the driver to a - man-in-the-middle attack. - - - - - - username - string - - The username for the user being authenticated. This option is useful - if the username contains special characters, which would otherwise - need to be URL encoded for the connection URI. - - - - w - intstring - - - Corresponds to the default write concern's w - parameter. For details, see - MongoDB\Driver\WriteConcern. - - - - - wTimeoutMS - intstring - - - Corresponds to the default write concern's - wtimeout parameter. Specifies a time limit, - in milliseconds, for the write concern. For details, see - MongoDB\Driver\WriteConcern. - - - If specified, wTimeoutMS must be a signed 32-bit - integer greater than or equal to zero. - - - - - zlibCompressionLevel - int - - - Specifies the compression level to use for the zlib compressor. This - option has no effect if zlib is not included in - the "compressors" URI option. See the - Driver Compression Specification - for more information. - - - - - -
- - - - - driverOptions - - - - driverOptions - - - - Option - Type - Description - - - - - allow_invalid_hostname - bool - - - Disables hostname validation if &true;. Defaults to &false;. - - - Allowing invalid hostnames may expose the driver to a - man-in-the-middle attack. - - - This option is a deprecated alias for the - "tlsAllowInvalidHostnames" URI option. - - - - - autoEncryption - array - - - Provides options to enable automatic client-side field level encryption. - The following options are supported: - -
- Options for automatic encryption - - - - Option - Type - Description - - - - &mongodb.option.encryption.keyVaultClient; - &mongodb.option.encryption.keyVaultNamespace; - &mongodb.option.encryption.kmsProviders; - &mongodb.option.encryption.tlsOptions; - - schemaMap - array - - - Allows specifying a local JSON schema that is used to configure encryption. - - - - Supplying a schemaMap provides more - security than relying on JSON schemas obtained from the - server. It protects against a malicious server advertising a - false JSON schema, which could trick the client into sending - unencrypted data that should be encrypted. - - - - - Schemas supplied in the schemaMap only - apply to configuring automatic encryption for client side - encryption. Other validation rules in the JSON schema will - not be enforced by the driver and will result in an error. - - - - - - bypassAutoEncryption - bool - - With this option set to &true;, mongocryptd - will not be spawned automatically. This is used to disable - automatic encryption. - - - - extraOptions - array - - - The extraOptions relate to the - mongocryptd process. The following options - are supported: - - -: { - mongocryptdURI: , // Defaults to "mongodb://localhost:27027" - mongocryptdBypassSpawn: , // Defaults to false - mongocryptdSpawnPath: , // Defaults to empty string and uses default system paths - mongocryptdSpawnArgs: // Defaults to [ "--idleShutdownTimeoutSecs=60" ] -} -]]> - - - See the Client-Side Encryption Specification for more information. - - - - - -
- - - - - Automatic encryption is an enterprise only feature that only - applies to operations on a collection. Automatic encryption is not - supported for operations on a database or view, and operations that - are not bypassed will result in error. To bypass automatic - encryption for all operations, set bypassAutoEncryption=true - in autoEncryption. For more information on - allowed operations, see the - Client-Side Encryption Specification. - - - - - - ca_dir - string - - - Path to a correctly hashed certificate directory. The system - certificate store will be used by default. - - - - - ca_file - string - - - Path to file with either a single or bundle of certificate - authorities to be considered trusted when making a TLS connection. - The system certificate store will be used by default. - - - This option is a deprecated alias for the - "tlsCAFile" URI option. - - - - - context - resource - - - SSL context options to be used as - fallbacks if a driver option or its equivalent URI option, if any, - is not specified. Note that the driver does not consult the default - stream context (i.e. - stream_context_get_default). The following - context options are supported: - - - - SSL context option fallbacks - - - - Driver option - Context option (fallback) - - - - - ca_dir - capath - - - ca_file - cafile - - - pem_file - local_cert - - - pem_pwd - passphrase - - - weak_cert_validation - allow_self_signed - - - -
- - This option is supported for backwards compatibility, but should be - considered deprecated. - - - - - crl_file - string - Path to a certificate revocation list file. - - - disableClientPersistence - bool - - - If &true;, this Manager will use a new libmongoc client, which will - not be persisted or shared with other Manager objects. When this - Manager object is freed, its client will be destroyed and any - connections will be closed. Defaults to &false;. - - - - Disabling client persistence is not generally recommended. - - - - - - driver - array - - - Allows custom drivers to append their own metadata to the server - handshake. By default, the driver submits its own name, version, and - platform (i.e. PHP version) in the handshake. Custom drivers can - specify strings for the "name", - "version", and - "platform" keys of this array, which will be - appended to the respective field(s) in the handshake document. - - - - Handshake information is limited to 512 bytes. The driver will - truncate handshake data to fit within this 512-byte string. Drivers - and ODMs are encouraged to keep their own metadata concise. - - - - - - pem_file - string - - - Path to a PEM encoded certificate to use for client authentication. - - - This option is a deprecated alias for the - "tlsCertificateKeyFile" URI option. - - - - - pem_pwd - string - - - Passphrase for the PEM encoded certificate (if applicable). - - - This option is a deprecated alias for the - "tlsCertificateKeyFilePassword" URI option. - - - - - serverApi - MongoDB\Driver\ServerApi - - - This option is used to declare a server API version for the manager. - If omitted, no API version is declared. - - - - - weak_cert_validation - bool - - - Disables certificate validation if &true;. Defaults to &false; - - - This option is a deprecated alias for the - "tlsAllowInvalidCertificates" URI option. - - - - - - - - - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\RuntimeException if the uri format is invalid - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 1.13.0 - - - Added the "srvMaxHosts" and - "srvServiceName" URI options. - - - - - PECL mongodb 1.12.0 - - - KMIP is now supported as a KMS provider for client-side encryption and - may be configured in the "kmsProviders" field of the - "autoEncryption" driver option. Additionally, TLS - options for KMS providers may now be configured in the - "tlsOptions" field of the - "autoEncryption" driver option. - - - - - PECL mongodb 1.11.0 - - - Added the "loadBalanced" URI option. - - - - - PECL mongodb 1.10.0 - - - Added the "disableClientPersistence" driver option. - - - Azure and GCP are now supported as KMS providers for client-side - encryption and may be configured in the - "kmsProviders" field of the - "autoEncryption" driver option. Base64-encoded - strings are now accepted as an alternative to - MongoDB\BSON\Binary for options within - "kmsProviders". - - - - - PECL mongodb 1.8.0 - - - Added the "directConnection", - "tlsDisableCertificateRevocationCheck", and - "tlsDisableOCSPEndpointCheck" URI options. - - - Added the "driver" driver option. - - - - - PECL mongodb 1.7.0 - - - Added the "autoEncryption" driver option. - - - Specifying any SSL or TLS option via the driverOptions - parameter will now implicitly enable TLS, as is done for the - corresponding URI options. - - - - - PECL mongodb 1.6.0 - - - Added the "retryReads", "tls", - "tlsAllowInvalidCertificates", - "tlsAllowInvalidHostnames", - "tlsCAFile", - "tlsCertificateKeyFile", - "tlsCertificateKeyFilePassword", and - "tlsInsecure" URI options. - - - The "retryWrites" URI option defaults to &true;. - - - Specifying any SSL or TLS URI option via the connection string or - uriOptions parameter will now implicitly enable - TLS unless ssl or tls is &false;. - TLS is not implicitly enabled for any options in - the driverOptions parameter, which is unchanged - from previous versions. - - - - - PECL mongodb 1.5.0 - - - "wtimeoutMS" is now always validated and applied to - the write concern. Previously, the option was ignored if - "w" was <= 1, since the timeout only applies to - replication. - - - - - PECL mongodb 1.4.0 - - - Added the "compressors", - "retryWrites", and - "zlibCompressionLevel" URI options. - - - - - PECL mongodb 1.3.0 - - - The uriOptions argument now accepts - "authMechanism" and - "authMechanismProperties" options. Previously, these - options were only supported in the uri argument. - - - - - PECL mongodb 1.2.0 - - - The uri argument defaults to - "mongodb://127.0.0.1/". The default port remains - 27017. - - - Added the "appname" URI option. - - - Added the "allow_invalid_hostname", - "ca_file", "ca_dir", - "clr_file", "pem_file", - "pem_pwd", and - "weak_cert_validation" driver options. - - - The PHP Streams API is no longer used for socket communication. The - "connectTimeoutMS" URI option now defaults to 10 - seconds instead of - default_socket_timeout - in previous versions. Additionally, the driver no longer supports all - SSL context options via the - "context" driver option. - - - - - PECL mongodb 1.1.0 - - - The uri argument is optional and defaults to - "mongodb://localhost:27017/". - - - - - - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\Manager::__construct</function> basic examples - Connecting to standalone MongoDB node: - - -]]> - - - Connecting to standalone MongoDB node via a Unix domain socket. The socket - path may include special characters such as slashes and should be encoded - with rawurlencode. - - - -]]> - - Connecting to a replica set: - - -]]> - - Connecting to a sharded cluster (i.e. one or more mongos instances): - - -]]> - - Connecting to MongoDB with authentication credentials for a particular user and database: - - -]]> - - - - Connecting to MongoDB with authentication credentials for a particular - user and database, where the username or password includes special - characters (e.g. @, :, - %). In the following example, the password string - myp@ss:w%rd has been manually escaped; however, - rawurlencode may also be used to escape URI components - that may contain special characters. - - - -]]> - - - Connecting to MongoDB with X509 authentication: - - "/path/to/client.pem", - ] -); -?> -]]> - - - - - - &reftitle.seealso; - - Connection handling and persistence - MongoDB Connection String Format - - - - - - diff --git a/reference/mongodb/mongodb/driver/manager/createclientencryption.xml b/reference/mongodb/mongodb/driver/manager/createclientencryption.xml deleted file mode 100644 index ea8bf85ff..000000000 --- a/reference/mongodb/mongodb/driver/manager/createclientencryption.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - - MongoDB\Driver\Manager::createClientEncryption - Create a new ClientEncryption object - - - - &reftitle.description; - - final public MongoDB\Driver\ClientEncryptionMongoDB\Driver\Manager::createClientEncryption - arrayoptions - - - Constructs a new MongoDB\Driver\ClientEncryption object with the specified options. - - - - - &reftitle.parameters; - - - options - - - - options - - - - Option - Type - Description - - - - &mongodb.option.encryption.keyVaultClient; - &mongodb.option.encryption.keyVaultNamespace; - &mongodb.option.encryption.kmsProviders; - &mongodb.option.encryption.tlsOptions; - - -
- - - - - - - - &reftitle.returnvalues; - - Returns a new MongoDB\Driver\ClientEncryption instance. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\RuntimeException if the extension was compiled without libmongocrypt support - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 1.12.0 - - - KMIP is now supported as a KMS provider for client-side encryption and - may be configured in the "kmsProviders" option. - - - Added the "tlsOptions" option. - - - - - PECL mongodb 1.10.0 - - Azure and GCP are now supported as KMS providers for client-side - encryption and may be configured in the - "kmsProviders" option. Base64-encoded strings are now - accepted as an alternative to MongoDB\BSON\Binary - for options within "kmsProviders". - - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\ClientEncryption - Explicit (Manual) Client-Side Field Level Encryption in the MongoDB manual - - - - - - diff --git a/reference/mongodb/mongodb/driver/manager/executebulkwrite.xml b/reference/mongodb/mongodb/driver/manager/executebulkwrite.xml deleted file mode 100644 index 2fd29be86..000000000 --- a/reference/mongodb/mongodb/driver/manager/executebulkwrite.xml +++ /dev/null @@ -1,218 +0,0 @@ - - - - - - MongoDB\Driver\Manager::executeBulkWrite - Execute one or more write operations - - - - &reftitle.description; - - final public MongoDB\Driver\WriteResultMongoDB\Driver\Manager::executeBulkWrite - stringnamespace - MongoDB\Driver\BulkWritebulk - arrayoptionsarray() - - - Executes one or more write operations on the primary server. - - - A MongoDB\Driver\BulkWrite can be constructed with - one or more write operations of varying types (e.g. updates, deletes, and - inserts). The driver will attempt to send operations of the same type to the - server in as few requests as possible to optimize round trips. - - - - - &reftitle.parameters; - - &mongodb.parameter.namespace; - &mongodb.parameter.bulkwrite; - - options - - - - options - - - - Option - Type - Description - - - - &mongodb.option.session; - &mongodb.option.writeConcern; - - -
- - - - - - - - &reftitle.returnvalues; - &mongodb.returns.writeresult; - - - - &reftitle.errors; - - Throws MongoDB\Driver\Exception\InvalidArgumentException if bulk does not contain any write operations. - Throws MongoDB\Driver\Exception\InvalidArgumentException if bulk has already been executed. MongoDB\Driver\BulkWrite objects may not be executed multiple times. - &mongodb.throws.session-unacknowledged; - &mongodb.throws.std; - &mongodb.throws.bulkwriteexception; - Throws MongoDB\Driver\Exception\RuntimeException on other errors. - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 1.4.4 - - MongoDB\Driver\Exception\InvalidArgumentException - will be thrown if the "session" option is used in - combination with an unacknowledged write concern. - - - - PECL mongodb 1.4.0 - - The third parameter is now an options array. - For backwards compatibility, this paramater will still accept a - MongoDB\Driver\WriteConcern object. - - - - PECL mongodb 1.3.0 - - MongoDB\Driver\Exception\InvalidArgumentException - is now thrown if bulk does not contain any write - operations. Previously, a - MongoDB\Driver\Exception\BulkWriteException was - thrown. - - - - - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\Manager::executeBulkWrite</function> example - -insert(['_id' => 1, 'x' => 1]); -$bulk->insert(['_id' => 2, 'x' => 2]); - -$bulk->update(['x' => 2], ['$set' => ['x' => 1]], ['multi' => false, 'upsert' => false]); -$bulk->update(['x' => 3], ['$set' => ['x' => 3]], ['multi' => false, 'upsert' => true]); -$bulk->update(['_id' => 3], ['$set' => ['x' => 3]], ['multi' => false, 'upsert' => true]); - -$bulk->insert(['_id' => 4, 'x' => 2]); - -$bulk->delete(['x' => 1], ['limit' => 1]); - -$manager = new MongoDB\Driver\Manager('mongodb://localhost:27017'); -$writeConcern = new MongoDB\Driver\WriteConcern(MongoDB\Driver\WriteConcern::MAJORITY, 100); -$result = $manager->executeBulkWrite('db.collection', $bulk, $writeConcern); - -printf("Inserted %d document(s)\n", $result->getInsertedCount()); -printf("Matched %d document(s)\n", $result->getMatchedCount()); -printf("Updated %d document(s)\n", $result->getModifiedCount()); -printf("Upserted %d document(s)\n", $result->getUpsertedCount()); -printf("Deleted %d document(s)\n", $result->getDeletedCount()); - -foreach ($result->getUpsertedIds() as $index => $id) { - printf('upsertedId[%d]: ', $index); - var_dump($id); -} - -/* If the WriteConcern could not be fulfilled */ -if ($writeConcernError = $result->getWriteConcernError()) { - printf("%s (%d): %s\n", $writeConcernError->getMessage(), $writeConcernError->getCode(), var_export($writeConcernError->getInfo(), true)); -} - -/* If a write could not happen at all */ -foreach ($result->getWriteErrors() as $writeError) { - printf("Operation#%d: %s (%d)\n", $writeError->getIndex(), $writeError->getMessage(), $writeError->getCode()); -} -?> -]]> - - &example.outputs.similar; - - - string(24) "54d3adc3ce7a792f4d703756" -} -upsertedId[4]: int(3) -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWrite - MongoDB\Driver\WriteResult - MongoDB\Driver\WriteConcern - MongoDB\Driver\Server::executeBulkWrite - - - - - - diff --git a/reference/mongodb/mongodb/driver/manager/executecommand.xml b/reference/mongodb/mongodb/driver/manager/executecommand.xml deleted file mode 100644 index 1bd917115..000000000 --- a/reference/mongodb/mongodb/driver/manager/executecommand.xml +++ /dev/null @@ -1,292 +0,0 @@ - - - - - - MongoDB\Driver\Manager::executeCommand - Execute a database command - - - - &reftitle.description; - - final public MongoDB\Driver\CursorMongoDB\Driver\Manager::executeCommand - stringdb - MongoDB\Driver\Commandcommand - arrayoptionsarray() - - - Selects a server according to the "readPreference" option - and executes the command on that server. By default, the read preference from - the MongoDB Connection - URI will be used. - - - This method applies no special logic to the command. Although this method - accepts "readConcern" and - "writeConcern" options, which will be incorporated into - the command document, those options will not default to corresponding values - from the MongoDB - Connection URI nor will the MongoDB server version be taken into - account. Users are therefore encouraged to use specific read and/or write - command methods if possible. - - - - - &reftitle.parameters; - - &mongodb.parameter.db; - &mongodb.parameter.command; - - options - - - - options - - - - Option - Type - Description - - - - &mongodb.option.readConcern; - &mongodb.option.readPreference; - &mongodb.option.session; - &mongodb.option.writeConcern; - - -
- - &mongodb.option.transactionReadWriteConcern; - - - - - - - &reftitle.returnvalues; - &mongodb.returns.cursor; - - - - &reftitle.errors; - - &mongodb.throws.session-readwriteconcern; - &mongodb.throws.session-unacknowledged; - &mongodb.throws.std; - Throws MongoDB\Driver\Exception\RuntimeException on other errors (e.g. invalid command, issuing a write command to a secondary). - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 1.4.4 - - MongoDB\Driver\Exception\InvalidArgumentException - will be thrown if the "session" option is used in - combination with an unacknowledged write concern. - - - - PECL mongodb 1.4.0 - - The third parameter is now an options array. - For backwards compatibility, this paramater will still accept a - MongoDB\Driver\ReadPreference object. - - - - - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\Manager::executeCommand</function> with a command returning a single result document - - 1]); - -try { - $cursor = $manager->executeCommand('admin', $command); -} catch(MongoDB\Driver\Exception $e) { - echo $e->getMessage(), "\n"; - exit; -} - -/* The ping command returns a single result document, so we need to access the - * first result in the cursor. */ -$response = $cursor->toArray()[0]; - -var_dump($response); - -?> -]]> - - &example.outputs; - - - float(1) -} -]]> - - - - <function>MongoDB\Driver\Manager::executeCommand</function> with a command returning a cursor - -insert(['x' => 1, 'y' => 'foo']); -$bulk->insert(['x' => 2, 'y' => 'bar']); -$bulk->insert(['x' => 3, 'y' => 'bar']); -$manager->executeBulkWrite('db.collection', $bulk); - -$command = new MongoDB\Driver\Command([ - 'aggregate' => 'collection', - 'pipeline' => [ - ['$group' => ['_id' => '$y', 'sum' => ['$sum' => '$x']]], - ], - 'cursor' => new stdClass, -]); -$cursor = $manager->executeCommand('db', $command); - -/* The aggregate command can optionally return its results in a cursor instead - * of a single result document. In this case, we can iterate on the cursor - * directly to access those results. */ -foreach ($cursor as $document) { - var_dump($document); -} - -?> -]]> - - &example.outputs; - - - string(3) "bar" - ["sum"]=> - int(10) -} -object(stdClass)#7 (2) { - ["_id"]=> - string(3) "foo" - ["sum"]=> - int(2) -} -]]> - - - - - Limiting execution time for a command - - The execution time of a command may be limited by specifying a value for - "maxTimeMS" in the - MongoDB\Driver\Command document. Note that this time - limit is enforced on the server side and does not take network latency into - account. See - Terminate Running Operations - in the MongoDB manual for more information. - - - 'collection', - 'query' => ['x' => ['$gt' => 1]], - 'maxTimeMS' => 1000, -]); - -$cursor = $manager->executeCommand('db', $command); - -var_dump($cursor->toArray()[0]); - -?> -]]> - - - If the command fails to complete after one second of execution time on the - server, a - MongoDB\Driver\Exception\ExecutionTimeoutException - will be thrown. - - - - - - &reftitle.notes; - - - If a secondary readPreference is used, it is the - caller's responsibility to ensure that the - command can be executed on a secondary. No validation - is done by the driver. - - - - - - &reftitle.seealso; - - MongoDB\Driver\Command - MongoDB\Driver\Cursor - MongoDB\Driver\Manager::executeReadCommand - MongoDB\Driver\Manager::executeReadWriteCommand - MongoDB\Driver\Manager::executeWriteCommand - MongoDB\Driver\Server::executeCommand - - - - - - diff --git a/reference/mongodb/mongodb/driver/manager/executequery.xml b/reference/mongodb/mongodb/driver/manager/executequery.xml deleted file mode 100644 index eba4f66b4..000000000 --- a/reference/mongodb/mongodb/driver/manager/executequery.xml +++ /dev/null @@ -1,214 +0,0 @@ - - - - - - MongoDB\Driver\Manager::executeQuery - Execute a database query - - - - &reftitle.description; - - final public MongoDB\Driver\CursorMongoDB\Driver\Manager::executeQuery - stringnamespace - MongoDB\Driver\Queryquery - arrayoptionsarray() - - - Selects a server according to the "readPreference" option - and executes the query on that server. By default, the read preference from - the MongoDB Connection - URI will be used. - - - - - &reftitle.parameters; - - &mongodb.parameter.namespace; - &mongodb.parameter.query; - - options - - - - options - - - - Option - Type - Description - - - - &mongodb.option.readPreference; - &mongodb.option.session; - - -
- - - - - - - - &reftitle.returnvalues; - &mongodb.returns.cursor; - - - - &reftitle.errors; - - &mongodb.throws.std; - Throws MongoDB\Driver\Exception\RuntimeException on other errors (e.g. invalid query operators). - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 1.4.0 - - The third parameter is now an options array. - For backwards compatibility, this paramater will still accept a - MongoDB\Driver\ReadPreference object. - - - - - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\Manager::executeQuery</function> example - -insert(['x' => 1]); -$bulk->insert(['x' => 2]); -$bulk->insert(['x' => 3]); -$manager->executeBulkWrite('db.collection', $bulk); - -$filter = ['x' => ['$gt' => 1]]; -$options = [ - 'projection' => ['_id' => 0], - 'sort' => ['x' => -1], -]; - -$query = new MongoDB\Driver\Query($filter, $options); -$cursor = $manager->executeQuery('db.collection', $query); - -foreach ($cursor as $document) { - var_dump($document); -} - -?> -]]> - - &example.outputs; - - - int(3) -} -object(stdClass)#7 (1) { - ["x"]=> - int(2) -} -]]> - - - - - Limiting execution time for a query - - The "maxTimeMS" - MongoDB\Driver\Query option may be used to limit the - execution time of a query. Note that this time limit is enforced on the - server side and does not take network latency into account. See - Terminate Running Operations - in the MongoDB manual for more information. - - - ['$gt' => 1]]; -$options = [ - 'maxTimeMS' => 1000, -]; - -$query = new MongoDB\Driver\Query($filter, $options); -$cursor = $manager->executeQuery('db.collection', $query); - -foreach ($cursor as $document) { - var_dump($document); -} - -?> -]]> - - - If the query fails to complete after one second of execution time on the - server, a - MongoDB\Driver\Exception\ExecutionTimeoutException - will be thrown. - - - - - - &reftitle.seealso; - - MongoDB\Driver\Cursor - MongoDB\Driver\Query - MongoDB\Driver\ReadPreference - MongoDB\Driver\Server::executeQuery - - - - - - diff --git a/reference/mongodb/mongodb/driver/manager/executereadcommand.xml b/reference/mongodb/mongodb/driver/manager/executereadcommand.xml deleted file mode 100644 index a64fe07cc..000000000 --- a/reference/mongodb/mongodb/driver/manager/executereadcommand.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - MongoDB\Driver\Manager::executeReadCommand - Execute a database command that reads - - - - &reftitle.description; - - final public MongoDB\Driver\CursorMongoDB\Driver\Manager::executeReadCommand - stringdb - MongoDB\Driver\Commandcommand - arrayoptionsarray() - - - Selects a server according to the "readPreference" option - and executes the command on that server. By default, the read preference from - the MongoDB Connection - URI will be used. - - - This method will apply logic that is specific to commands that read (e.g. - count) - and take the MongoDB server version into account. The - "readConcern" option will default to the corresponding - value from the MongoDB - Connection URI. - - - - - &reftitle.parameters; - - &mongodb.parameter.db; - &mongodb.parameter.command; - - options - - - - options - - - - Option - Type - Description - - - - &mongodb.option.readConcern; - &mongodb.option.readPreference; - &mongodb.option.session; - - -
- - &mongodb.option.transactionReadWriteConcern; - - - - - - - &reftitle.returnvalues; - &mongodb.returns.cursor; - - - - &reftitle.errors; - - &mongodb.throws.session-readwriteconcern; - &mongodb.throws.std; - Throws MongoDB\Driver\Exception\RuntimeException on other errors (e.g. invalid command). - - - - - &reftitle.seealso; - - MongoDB\Driver\Command - MongoDB\Driver\Cursor - MongoDB\Driver\Manager::executeCommand - MongoDB\Driver\Manager::executeReadWriteCommand - MongoDB\Driver\Manager::executeWriteCommand - MongoDB\Driver\Server::executeReadCommand - - - - - - diff --git a/reference/mongodb/mongodb/driver/manager/executereadwritecommand.xml b/reference/mongodb/mongodb/driver/manager/executereadwritecommand.xml deleted file mode 100644 index 91e0f399b..000000000 --- a/reference/mongodb/mongodb/driver/manager/executereadwritecommand.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - MongoDB\Driver\Manager::executeReadWriteCommand - Execute a database command that reads and writes - - - - &reftitle.description; - - final public MongoDB\Driver\CursorMongoDB\Driver\Manager::executeReadWriteCommand - stringdb - MongoDB\Driver\Commandcommand - arrayoptionsarray() - - - Executes the command on the primary server. - - - This method will apply logic that is specific to commands that read and write - (e.g. - aggregate) - and take the MongoDB server version into account. The - "readConcern" and "writeConcern" - options will default to the corresponding values from the - MongoDB Connection - URI. - - - - - &reftitle.parameters; - - &mongodb.parameter.db; - &mongodb.parameter.command; - - options - - - - options - - - - Option - Type - Description - - - - &mongodb.option.readConcern; - &mongodb.option.session; - &mongodb.option.writeConcern; - - -
- - &mongodb.option.transactionReadWriteConcern; - - - - - - - &reftitle.returnvalues; - &mongodb.returns.cursor; - - - - &reftitle.errors; - - &mongodb.throws.session-readwriteconcern; - &mongodb.throws.session-unacknowledged; - &mongodb.throws.std; - Throws MongoDB\Driver\Exception\RuntimeException on other errors (e.g. invalid command). - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 1.4.4 - - MongoDB\Driver\Exception\InvalidArgumentException - will be thrown if the "session" option is used in - combination with an unacknowledged write concern. - - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Command - MongoDB\Driver\Cursor - MongoDB\Driver\Manager::executeCommand - MongoDB\Driver\Manager::executeReadCommand - MongoDB\Driver\Manager::executeWriteCommand - MongoDB\Driver\Server::executeReadWriteCommand - - - - - - diff --git a/reference/mongodb/mongodb/driver/manager/executewritecommand.xml b/reference/mongodb/mongodb/driver/manager/executewritecommand.xml deleted file mode 100644 index 7ddeb0bc4..000000000 --- a/reference/mongodb/mongodb/driver/manager/executewritecommand.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - MongoDB\Driver\Manager::executeWriteCommand - Execute a database command that writes - - - - &reftitle.description; - - final public MongoDB\Driver\CursorMongoDB\Driver\Manager::executeWriteCommand - stringdb - MongoDB\Driver\Commandcommand - arrayoptionsarray() - - - Executes the command on the primary server. - - - This method will apply logic that is specific to commands that write (e.g. - drop) and - take the MongoDB server version into account. The - "writeConcern" option will default to the corresponding - value from the MongoDB - Connection URI. - - - - This method is not intended to be used to execute - insert, - update, - or delete - commands. Users are encouraged to use - MongoDB\Driver\Manager::executeBulkWrite for those - commands. - - - - - - &reftitle.parameters; - - &mongodb.parameter.db; - &mongodb.parameter.command; - - options - - - - options - - - - Option - Type - Description - - - - &mongodb.option.session; - &mongodb.option.writeConcern; - - -
- - &mongodb.option.transactionReadWriteConcern; - - - - - - - &reftitle.returnvalues; - &mongodb.returns.cursor; - - - - &reftitle.errors; - - &mongodb.throws.session-readwriteconcern; - &mongodb.throws.session-unacknowledged; - &mongodb.throws.std; - Throws MongoDB\Driver\Exception\RuntimeException on other errors (e.g. invalid command). - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 1.4.4 - - MongoDB\Driver\Exception\InvalidArgumentException - will be thrown if the "session" option is used in - combination with an unacknowledged write concern. - - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Command - MongoDB\Driver\Cursor - MongoDB\Driver\Manager::executeCommand - MongoDB\Driver\Manager::executeReadCommand - MongoDB\Driver\Manager::executeReadWriteCommand - MongoDB\Driver\Server::executeWriteCommand - - - - - - diff --git a/reference/mongodb/mongodb/driver/manager/getreadconcern.xml b/reference/mongodb/mongodb/driver/manager/getreadconcern.xml deleted file mode 100644 index 84bdbbd59..000000000 --- a/reference/mongodb/mongodb/driver/manager/getreadconcern.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - MongoDB\Driver\Manager::getReadConcern - Return the ReadConcern for the Manager - - - - &reftitle.description; - - final public MongoDB\Driver\ReadConcernMongoDB\Driver\Manager::getReadConcern - - - - Returns the MongoDB\Driver\ReadConcern for the - Manager, which is derived from its URI options. This is the default read - concern for queries and commands executed on the Manager. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The MongoDB\Driver\ReadConcern for the Manager. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - <function>MongoDB\Driver\Manager::getReadConcern</function> example - -getReadConcern()); - -$manager = new MongoDB\Driver\Manager('mongodb://localhost:27017/?readConcernLevel=local'); -var_dump($manager->getReadConcern()); - -?> -]]> - - &example.outputs.similar; - - - string(5) "local" -} -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\ReadConcern - MongoDB\Driver\Manager::__construct - - - - - - diff --git a/reference/mongodb/mongodb/driver/manager/getreadpreference.xml b/reference/mongodb/mongodb/driver/manager/getreadpreference.xml deleted file mode 100644 index 2294ee0a7..000000000 --- a/reference/mongodb/mongodb/driver/manager/getreadpreference.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - MongoDB\Driver\Manager::getReadPreference - Return the ReadPreference for the Manager - - - - &reftitle.description; - - final public MongoDB\Driver\ReadPreferenceMongoDB\Driver\Manager::getReadPreference - - - - Returns the MongoDB\Driver\ReadPreference for the - Manager, which is derived from its URI options. This is the default read - preference for queries and commands executed on the Manager. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The MongoDB\Driver\ReadPreference for the Manager. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - <function>MongoDB\Driver\Manager::getReadPreference</function> example - -getReadPreference()); - -$manager = new MongoDB\Driver\Manager('mongodb://localhost:27017/?readPreference=secondaryPreferred&readPreferenceTags=dc:ny,rack:1&readPreferenceTags=dc:ny&readPreferenceTags='); -var_dump($manager->getReadPreference()); - -?> -]]> - - &example.outputs.similar; - - - string(7) "primary" -} -object(MongoDB\Driver\ReadPreference)#1 (2) { - ["mode"]=> - string(18) "secondaryPreferred" - ["tags"]=> - array(3) { - [0]=> - object(stdClass)#3 (2) { - ["dc"]=> - string(2) "ny" - ["rack"]=> - string(1) "1" - } - [1]=> - object(stdClass)#4 (1) { - ["dc"]=> - string(2) "ny" - } - [2]=> - object(stdClass)#5 (0) { - } - } -} -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\ReadPreference - MongoDB\Driver\Manager::__construct - - - - - - diff --git a/reference/mongodb/mongodb/driver/manager/getservers.xml b/reference/mongodb/mongodb/driver/manager/getservers.xml deleted file mode 100644 index 9259dc9cb..000000000 --- a/reference/mongodb/mongodb/driver/manager/getservers.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - - MongoDB\Driver\Manager::getServers - Return the servers to which this manager is connected - - - - &reftitle.description; - - final public arrayMongoDB\Driver\Manager::getServers - - - - Returns an array of MongoDB\Driver\Server - instances to which this manager is connected. - - - - Since the driver connects to the database lazily, this method may return an - empty array if called before executing an operation on the - MongoDB\Driver\Manager. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an array of MongoDB\Driver\Server - instances to which this manager is connected. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\Manager::getServers</function> example - -getServers()); - -$command = new MongoDB\Driver\Command(['ping' => 1]); -$manager->executeCommand('db', $command); - -var_dump($manager->getServers()); - -?> -]]> - - &example.outputs.similar; - - - object(MongoDB\Driver\Server)#3 (10) { - ["host"]=> - string(9) "localhost" - ["port"]=> - int(27017) - ["type"]=> - int(1) - ["is_primary"]=> - bool(false) - ["is_secondary"]=> - bool(false) - ["is_arbiter"]=> - bool(false) - ["is_hidden"]=> - bool(false) - ["is_passive"]=> - bool(false) - ["last_hello_response"]=> - array(8) { - ["isWritablePrimary"]=> - bool(true) - ["maxBsonObjectSize"]=> - int(16777216) - ["maxMessageSizeBytes"]=> - int(48000000) - ["maxWriteBatchSize"]=> - int(1000) - ["localTime"]=> - object(MongoDB\BSON\UTCDateTime)#4 (1) { - ["milliseconds"]=> - int(1447267964517) - } - ["maxWireVersion"]=> - int(3) - ["minWireVersion"]=> - int(0) - ["ok"]=> - float(1) - } - ["round_trip_time"]=> - int(554) - } -} -]]> - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Server - MongoDB\Driver\Manager::selectServer - - - - - - diff --git a/reference/mongodb/mongodb/driver/manager/getwriteconcern.xml b/reference/mongodb/mongodb/driver/manager/getwriteconcern.xml deleted file mode 100644 index ac494d9e5..000000000 --- a/reference/mongodb/mongodb/driver/manager/getwriteconcern.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - MongoDB\Driver\Manager::getWriteConcern - Return the WriteConcern for the Manager - - - - &reftitle.description; - - final public MongoDB\Driver\WriteConcernMongoDB\Driver\Manager::getWriteConcern - - - - Returns the MongoDB\Driver\WriteConcern for the - Manager, which is derived from its URI options. This is the default write - concern for writes and commands executed on the Manager. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The MongoDB\Driver\WriteConcern for the Manager. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - <function>MongoDB\Driver\Manager::getWriteConcern</function> example - -getWriteConcern()); - -$manager = new MongoDB\Driver\Manager('mongodb://localhost:27017/?w=majority&wtimeoutMS=2000'); -var_dump($manager->getWriteConcern()); - -?> -]]> - - &example.outputs.similar; - - - string(8) "majority" - ["wtimeout"]=> - int(2000) -} -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\WriteConcern - MongoDB\Driver\Manager::__construct - - - - - - diff --git a/reference/mongodb/mongodb/driver/manager/removesubscriber.xml b/reference/mongodb/mongodb/driver/manager/removesubscriber.xml deleted file mode 100644 index c3bd4ef24..000000000 --- a/reference/mongodb/mongodb/driver/manager/removesubscriber.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - MongoDB\Driver\Manager::removeSubscriber - Unregisters a monitoring event subscriber with this Manager - - - - &reftitle.description; - - final public voidMongoDB\Driver\Manager::removeSubscriber - MongoDB\Driver\Monitoring\Subscribersubscriber - - - Unregisters a monitoring event subscriber with this Manager. - - - - If subscriber is not already registered with this - Manager, this function is a no-op. - - - - - - &reftitle.parameters; - - - subscriber (MongoDB\Driver\Monitoring\Subscriber) - - - A monitoring event subscriber to unregister with this Manager. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::addSubscriber - MongoDB\Driver\Monitoring\Subscriber - MongoDB\Driver\Monitoring\CommandSubscriber - MongoDB\Driver\Monitoring\removeSubscriber - - - - - - - diff --git a/reference/mongodb/mongodb/driver/manager/selectserver.xml b/reference/mongodb/mongodb/driver/manager/selectserver.xml deleted file mode 100644 index ff1f6258c..000000000 --- a/reference/mongodb/mongodb/driver/manager/selectserver.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - MongoDB\Driver\Manager::selectServer - Select a server matching a read preference - - - - &reftitle.description; - - final public MongoDB\Driver\ServerMongoDB\Driver\Manager::selectServer - MongoDB\Driver\ReadPreferencenullreadPreference&null; - - - Selects a MongoDB\Driver\Server matching - readPreference. If - readPreference is &null; or omitted, the primary - server will be selected by default. This may be used to preselect a server in - order to perform version checking before executing an operation. - - - - Unlike MongoDB\Driver\Manager::getServers, this method - will initialize database connections and perform server discovery if - necessary. See the - Server Selection Specification - for additional information. - - - - - - &reftitle.parameters; - - - readPreference (MongoDB\Driver\ReadPreference) - - - The read preference to use for selecting a server. If &null; or omitted, - the primary server will be selected by default. - - - - - - - - &reftitle.returnvalues; - - Returns a MongoDB\Driver\Server matching the read - preference. - - - - - &reftitle.errors; - - &mongodb.throws.std; - Throws MongoDB\Driver\Exception\RuntimeException if a server matching the read preference could not be found. - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 1.11.0 - - The readPreference is now optional. If &null; or - omitted, the primary server will be selected by default. - - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Server - MongoDB\Driver\Manager::getServers - Server Selection Specification - - - - - - diff --git a/reference/mongodb/mongodb/driver/manager/startsession.xml b/reference/mongodb/mongodb/driver/manager/startsession.xml deleted file mode 100644 index 54ffd324c..000000000 --- a/reference/mongodb/mongodb/driver/manager/startsession.xml +++ /dev/null @@ -1,224 +0,0 @@ - - - - - - MongoDB\Driver\Manager::startSession - Start a new client session for use with this client - - - - &reftitle.description; - - final public MongoDB\Driver\SessionMongoDB\Driver\Manager::startSession - arrayoptions - - - Creates a MongoDB\Driver\Session for the given - options. The session may then be specified when executing commands, queries, - and write operations. - - - - A MongoDB\Driver\Session can only be used with the - MongoDB\Driver\Manager from which it was created. - - - - - - &reftitle.parameters; - - - options - - - - options - - - - Option - Type - Description - Default - - - - - causalConsistency - bool - - - Configure causal consistency in a session. If &true;, each operation - in the session will be causally ordered after the previous read or - write operation. Set to &false; to disable causal consistency. - - - See - Casual Consistency - in the MongoDB manual for more information. - - - &true; - - - defaultTransactionOptions - array - - - Default options to apply to newly created transactions. These - options are used unless they are overridden when a transaction is - started with different value for each option. - - -
- options - - - - Option - Type - Description - - - - &mongodb.option.maxCommitTimeMS; - &mongodb.option.readConcern; - &mongodb.option.readPreference; - &mongodb.option.writeConcern; - - -
- - - This option is available in MongoDB 4.0+. - - - [] - - - snapshot - bool - - - Configure snapshot reads in a session. If &true;, a timestamp will - be obtained from the first supported read operation in the session - (i.e. find, aggregate, or - unsharded distinct). Subsequent read operations - within the session will then utilize a "snapshot" - read concern level to read majority-committed data from that - timestamp. Set to &false; to disable snapshot reads. - - - Snapshot reads require MongoDB 5.0+ and cannot be used with causal - consistency, transactions, or write operations. If - "snapshot" is &true;, - "causalConsistency" will default to &false;. - - - See - Read Concern "snapshot" - in the MongoDB manual for more information. - - - &false; - - - - - - - - - - - - &reftitle.returnvalues; - - Returns a MongoDB\Driver\Session. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\InvalidArgumentException if the "causalConsistency" and "snapshot" options are both &true;. - Throws MongoDB\Driver\Exception\RuntimeException if the session could not be created (e.g. libmongoc does not support crypto). - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 1.11.0 - - - The "snapshot" option was added. - - - - - PECL mongodb 1.6.0 - - - The "maxCommitTimeMS" option was added to - "defaultTransactionOptions". - - - - - PECL mongodb 1.5.0 - - - The "defaultTransactionOptions" option was added. - - - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Session - Casual Consistency in the MongoDB manual - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent.xml b/reference/mongodb/mongodb/driver/monitoring/commandfailedevent.xml deleted file mode 100644 index 529e61e1b..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - The MongoDB\Driver\Monitoring\CommandFailedEvent class - MongoDB\Driver\Monitoring\CommandFailedEvent - - - - -
- &reftitle.intro; - - The MongoDB\Driver\Monitoring\CommandFailedEvent - class encapsulates information about a failed command. - -
- - -
- &reftitle.classsynopsis; - - - - MongoDB\Driver\Monitoring\CommandFailedEvent - - - - final - - MongoDB\Driver\Monitoring\CommandFailedEvent - - - - - &Methods; - - - - -
- - - - &reference.mongodb.mongodb.driver.monitoring.entities.commandfailedevent; - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getcommandname.xml b/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getcommandname.xml deleted file mode 100644 index 46ae7fff2..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getcommandname.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandFailedEvent::getCommandName - Returns the command name - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\CommandFailedEvent::getCommandName - - - - Returns the command name (e.g. "find", - "aggregate"). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the command name. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getdurationmicros.xml b/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getdurationmicros.xml deleted file mode 100644 index 37925ac23..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getdurationmicros.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandFailedEvent::getDurationMicros - Returns the command's duration in microseconds - - - - &reftitle.description; - - final public intMongoDB\Driver\Monitoring\CommandFailedEvent::getDurationMicros - - - - The command's duration is a calculated value that includes the time to send - the message and receive the reply from the server. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the command's duration in microseconds. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/geterror.xml b/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/geterror.xml deleted file mode 100644 index 139ff1d3d..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/geterror.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandFailedEvent::getError - Returns the Exception associated with the failed command - - - - &reftitle.description; - - final public ExceptionMongoDB\Driver\Monitoring\CommandFailedEvent::getError - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the Exception associated with the failed command. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getoperationid.xml b/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getoperationid.xml deleted file mode 100644 index a3288152c..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getoperationid.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandFailedEvent::getOperationId - Returns the command's operation ID - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\CommandFailedEvent::getOperationId - - - - The operation ID is generated by the driver and may be used to link events - together such as bulk write operations, which may have been split across - several commands at the protocol level. - - - - Since multiple commands may share the same operation ID, it is not reliable - to use this value to associate event objects with each other. The request ID - returned by - MongoDB\Driver\Monitoring\CommandFailedEvent::getRequestId - should be used instead. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the command's operation ID. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\CommandStartedEvent::getOperationId - MongoDB\Driver\Monitoring\CommandFailedEvent::getRequestId - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getreply.xml b/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getreply.xml deleted file mode 100644 index 25f535a4a..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getreply.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandFailedEvent::getReply - Returns the command reply document - - - - &reftitle.description; - - final public objectMongoDB\Driver\Monitoring\CommandFailedEvent::getReply - - - - The reply document will be converted from BSON to PHP using the default - deserialization - rules (e.g. BSON documents will be converted to stdClass). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the command reply document as a stdClass - object. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getrequestid.xml b/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getrequestid.xml deleted file mode 100644 index 07ee98f00..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getrequestid.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandFailedEvent::getRequestId - Returns the command's request ID - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\CommandFailedEvent::getRequestId - - - - The request ID is generated by the driver and may be used to associate this - MongoDB\Driver\Monitoring\CommandFailedEvent with a - previous - MongoDB\Driver\Monitoring\CommandStartedEvent. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the command's request ID. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\CommandStartedEvent::getRequestId - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getserver.xml b/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getserver.xml deleted file mode 100644 index b7fdf5dc6..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getserver.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandFailedEvent::getServer - Returns the Server on which the command was executed - - - - &reftitle.description; - - final public MongoDB\Driver\ServerMongoDB\Driver\Monitoring\CommandFailedEvent::getServer - - - - Returns the MongoDB\Driver\Server on which the command - was executed. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the MongoDB\Driver\Server on which the command - was executed. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\CommandStartedEvent::getServer - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getserviceid.xml b/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getserviceid.xml deleted file mode 100644 index f6a76b2f8..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getserviceid.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandFailedEvent::getServiceId - Returns the load balancer service ID for the command - - - - &reftitle.description; - - final public MongoDB\BSON\ObjectIdnullMongoDB\Driver\Monitoring\CommandFailedEvent::getServiceId - - - - When the driver is connected to a MongoDB cluster through a load balancer, - the service ID corresponds to the serviceId field in the - hello command response. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the load balancer service ID, or &null; if the driver is not - connected to a load balancer. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent.xml b/reference/mongodb/mongodb/driver/monitoring/commandstartedevent.xml deleted file mode 100644 index e2b7974bf..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - The MongoDB\Driver\Monitoring\CommandStartedEvent class - MongoDB\Driver\Monitoring\CommandStartedEvent - - - - -
- &reftitle.intro; - - The MongoDB\Driver\Monitoring\CommandStartedEvent - class encapsulates information about a started command. - -
- - -
- &reftitle.classsynopsis; - - - - MongoDB\Driver\Monitoring\CommandStartedEvent - - - - final - - MongoDB\Driver\Monitoring\CommandStartedEvent - - - - - &Methods; - - - - -
- - - - &reference.mongodb.mongodb.driver.monitoring.entities.commandstartedevent; - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getcommand.xml b/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getcommand.xml deleted file mode 100644 index 4399603fc..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getcommand.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandStartedEvent::getCommand - Returns the command document - - - - &reftitle.description; - - final public objectMongoDB\Driver\Monitoring\CommandStartedEvent::getCommand - - - - The reply document will be converted from BSON to PHP using the default - deserialization - rules (e.g. BSON documents will be converted to stdClass). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the command document as a stdClass object. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getcommandname.xml b/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getcommandname.xml deleted file mode 100644 index d414faa4b..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getcommandname.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandStartedEvent::getCommandName - Returns the command name - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\CommandStartedEvent::getCommandName - - - - Returns the command name (e.g. "find", - "aggregate"). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the command name. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getdatabasename.xml b/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getdatabasename.xml deleted file mode 100644 index f9acee2d1..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getdatabasename.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandStartedEvent::getDatabaseName - Returns the database on which the command was executed - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\CommandStartedEvent::getDatabaseName - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the database on which the command was executed. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getoperationid.xml b/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getoperationid.xml deleted file mode 100644 index e02e35786..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getoperationid.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandStartedEvent::getOperationId - Returns the command's operation ID - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\CommandStartedEvent::getOperationId - - - - The operation ID is generated by the driver and may be used to link events - together such as bulk write operations, which may have been split across - several commands at the protocol level. - - - - Since multiple commands may share the same operation ID, it is not reliable - to use this value to associate event objects with each other. The request ID - returned by - MongoDB\Driver\Monitoring\CommandStartedEvent::getRequestId - should be used instead. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the command's operation ID. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\CommandFailedEvent::getOperationId - MongoDB\Driver\Monitoring\CommandSucceededEvent::getOperationId - MongoDB\Driver\Monitoring\CommandStartedEvent::getRequestId - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getrequestid.xml b/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getrequestid.xml deleted file mode 100644 index 10257bd17..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getrequestid.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandStartedEvent::getRequestId - Returns the command's request ID - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\CommandStartedEvent::getRequestId - - - - The request ID is generated by the driver and may be used to associate this - MongoDB\Driver\Monitoring\CommandStartedEvent with a - later - MongoDB\Driver\Monitoring\CommandFailedEvent or - MongoDB\Driver\Monitoring\CommandSucceededEvent. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the command's request ID. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\CommandFailedEvent::getRequestId - MongoDB\Driver\Monitoring\CommandSucceededEvent::getRequestId - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getserver.xml b/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getserver.xml deleted file mode 100644 index 5149c6f4d..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getserver.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandStartedEvent::getServer - Returns the Server on which the command was executed - - - - &reftitle.description; - - final public MongoDB\Driver\ServerMongoDB\Driver\Monitoring\CommandStartedEvent::getServer - - - - Returns the MongoDB\Driver\Server on which the command - was executed. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the MongoDB\Driver\Server on which the command - was executed. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\CommandFailedEvent::getServer - MongoDB\Driver\Monitoring\CommandSucceededEvent::getServer - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getserviceid.xml b/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getserviceid.xml deleted file mode 100644 index 9e672ed2e..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getserviceid.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandStartedEvent::getServiceId - Returns the load balancer service ID for the command - - - - &reftitle.description; - - final public MongoDB\BSON\ObjectIdnullMongoDB\Driver\Monitoring\CommandStartedEvent::getServiceId - - - - When the driver is connected to a MongoDB cluster through a load balancer, - the service ID corresponds to the serviceId field in the - hello command response. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the load balancer service ID, or &null; if the driver is not - connected to a load balancer. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandsubscriber.xml b/reference/mongodb/mongodb/driver/monitoring/commandsubscriber.xml deleted file mode 100644 index 7a32a6fa2..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandsubscriber.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - The MongoDB\Driver\Monitoring\CommandSubscriber interface - MongoDB\Driver\Monitoring\CommandSubscriber - - - - -
- &reftitle.intro; - - Classes may implement this interface to register an event subscriber that is - notified for each started, successful, and failed command event. See - for additional information. - -
- - -
- &reftitle.interfacesynopsis; - - - - MongoDB\Driver\Monitoring\CommandSubscriber - - - - - MongoDB\Driver\Monitoring\CommandSubscriber - - - - MongoDB\Driver\Monitoring\Subscriber - - - - - &Methods; - - - - -
- - - - &reference.mongodb.mongodb.driver.monitoring.entities.commandsubscriber; - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandsubscriber/commandfailed.xml b/reference/mongodb/mongodb/driver/monitoring/commandsubscriber/commandfailed.xml deleted file mode 100644 index e1f0b96a4..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandsubscriber/commandfailed.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandSubscriber::commandFailed - Notification method for a failed command - - - - &reftitle.description; - - abstract public voidMongoDB\Driver\Monitoring\CommandSubscriber::commandFailed - MongoDB\Driver\Monitoring\CommandFailedEventevent - - - If the subscriber has been registered, the driver will call this method when - a command has failed. - - - - - &reftitle.parameters; - - - event (MongoDB\Driver\Monitoring\CommandFailedEvent) - - - An event object encapsulating information about the failed command. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\CommandFailedEvent - MongoDB\Driver\Monitoring\addSubscriber - MongoDB\Driver\Manager::addSubscriber - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandsubscriber/commandstarted.xml b/reference/mongodb/mongodb/driver/monitoring/commandsubscriber/commandstarted.xml deleted file mode 100644 index 54b02e544..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandsubscriber/commandstarted.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandSubscriber::commandStarted - Notification method for a started command - - - - &reftitle.description; - - abstract public voidMongoDB\Driver\Monitoring\CommandSubscriber::commandStarted - MongoDB\Driver\Monitoring\CommandStartedEventevent - - - If the subscriber has been registered, the driver will call this method when - a command has started. - - - - - &reftitle.parameters; - - - event (MongoDB\Driver\Monitoring\CommandStartedEvent) - - - An event object encapsulating information about the started command. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\CommandStartedEvent - MongoDB\Driver\Monitoring\addSubscriber - MongoDB\Driver\Manager::addSubscriber - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandsubscriber/commandsucceeded.xml b/reference/mongodb/mongodb/driver/monitoring/commandsubscriber/commandsucceeded.xml deleted file mode 100644 index 399e5324b..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandsubscriber/commandsucceeded.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandSubscriber::commandSucceeded - Notification method for a successful command - - - - &reftitle.description; - - abstract public voidMongoDB\Driver\Monitoring\CommandSubscriber::commandSucceeded - MongoDB\Driver\Monitoring\CommandSucceededEventevent - - - If the subscriber has been registered, the driver will call this method when - a command has succeeded. - - - - - &reftitle.parameters; - - - event (MongoDB\Driver\Monitoring\CommandSucceededEvent) - - - An event object encapsulating information about the successful command. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\CommandSucceededEvent - MongoDB\Driver\Monitoring\addSubscriber - MongoDB\Driver\Manager::addSubscriber - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent.xml b/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent.xml deleted file mode 100644 index 671ac028f..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - The MongoDB\Driver\Monitoring\CommandSucceededEvent class - MongoDB\Driver\Monitoring\CommandSucceededEvent - - - - -
- &reftitle.intro; - - The MongoDB\Driver\Monitoring\CommandSucceededEvent - class encapsulates information about a successful command. - -
- - -
- &reftitle.classsynopsis; - - - - MongoDB\Driver\Monitoring\CommandSucceededEvent - - - - final - - MongoDB\Driver\Monitoring\CommandSucceededEvent - - - - - &Methods; - - - - -
- - - - &reference.mongodb.mongodb.driver.monitoring.entities.commandsucceededevent; - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getcommandname.xml b/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getcommandname.xml deleted file mode 100644 index 1162657d9..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getcommandname.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandSucceededEvent::getCommandName - Returns the command name - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\CommandSucceededEvent::getCommandName - - - - Returns the command name (e.g. "find", - "aggregate"). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the command name. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getdurationmicros.xml b/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getdurationmicros.xml deleted file mode 100644 index fc7643019..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getdurationmicros.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandSucceededEvent::getDurationMicros - Returns the command's duration in microseconds - - - - &reftitle.description; - - final public intMongoDB\Driver\Monitoring\CommandSucceededEvent::getDurationMicros - - - - The command's duration is a calculated value that includes the time to send - the message and receive the reply from the server. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the command's duration in microseconds. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getoperationid.xml b/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getoperationid.xml deleted file mode 100644 index 359050a94..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getoperationid.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandSucceededEvent::getOperationId - Returns the command's operation ID - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\CommandSucceededEvent::getOperationId - - - - The operation ID is generated by the driver and may be used to link events - together such as bulk write operations, which may have been split across - several commands at the protocol level. - - - - Since multiple commands may share the same operation ID, it is not reliable - to use this value to associate event objects with each other. The request ID - returned by - MongoDB\Driver\Monitoring\CommandSucceededEvent::getRequestId - should be used instead. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the command's operation ID. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\CommandStartedEvent::getOperationId - MongoDB\Driver\Monitoring\CommandSucceededEvent::getRequestId - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getreply.xml b/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getreply.xml deleted file mode 100644 index 5f35079aa..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getreply.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandSucceededEvent::getReply - Returns the command reply document - - - - &reftitle.description; - - final public objectMongoDB\Driver\Monitoring\CommandSucceededEvent::getReply - - - - The reply document will be converted from BSON to PHP using the default - deserialization - rules (e.g. BSON documents will be converted to stdClass). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the command reply document as a stdClass - object. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getrequestid.xml b/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getrequestid.xml deleted file mode 100644 index e85a7a83e..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getrequestid.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandSucceededEvent::getRequestId - Returns the command's request ID - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\CommandSucceededEvent::getRequestId - - - - The request ID is generated by the driver and may be used to associate this - MongoDB\Driver\Monitoring\CommandSucceededEvent with a - previous - MongoDB\Driver\Monitoring\CommandStartedEvent. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the command's request ID. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\CommandStartedEvent::getRequestId - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getserver.xml b/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getserver.xml deleted file mode 100644 index 99ceca55f..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getserver.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandSucceededEvent::getServer - Returns the Server on which the command was executed - - - - &reftitle.description; - - final public MongoDB\Driver\ServerMongoDB\Driver\Monitoring\CommandSucceededEvent::getServer - - - - Returns the MongoDB\Driver\Server on which the command - was executed. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the MongoDB\Driver\Server on which the command - was executed. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\CommandStartedEvent::getServer - MongoDB\Driver\Cursor::getServer - MongoDB\Driver\WriteResult::getServer - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getserviceid.xml b/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getserviceid.xml deleted file mode 100644 index 2ddf11e58..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getserviceid.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandSucceededEvent::getServiceId - Returns the load balancer service ID for the command - - - - &reftitle.description; - - final public MongoDB\BSON\ObjectIdnullMongoDB\Driver\Monitoring\CommandSucceededEvent::getServiceId - - - - When the driver is connected to a MongoDB cluster through a load balancer, - the service ID corresponds to the serviceId field in the - hello command response. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the load balancer service ID, or &null; if the driver is not - connected to a load balancer. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/entities.commandfailedevent.xml b/reference/mongodb/mongodb/driver/monitoring/entities.commandfailedevent.xml deleted file mode 100644 index 3700133a2..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/entities.commandfailedevent.xml +++ /dev/null @@ -1,8 +0,0 @@ -&reference.mongodb.mongodb.driver.monitoring.commandfailedevent.getcommandname; -&reference.mongodb.mongodb.driver.monitoring.commandfailedevent.getdurationmicros; -&reference.mongodb.mongodb.driver.monitoring.commandfailedevent.geterror; -&reference.mongodb.mongodb.driver.monitoring.commandfailedevent.getoperationid; -&reference.mongodb.mongodb.driver.monitoring.commandfailedevent.getreply; -&reference.mongodb.mongodb.driver.monitoring.commandfailedevent.getrequestid; -&reference.mongodb.mongodb.driver.monitoring.commandfailedevent.getserver; -&reference.mongodb.mongodb.driver.monitoring.commandfailedevent.getserviceid; diff --git a/reference/mongodb/mongodb/driver/monitoring/entities.commandstartedevent.xml b/reference/mongodb/mongodb/driver/monitoring/entities.commandstartedevent.xml deleted file mode 100644 index 71dda3e37..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/entities.commandstartedevent.xml +++ /dev/null @@ -1,7 +0,0 @@ -&reference.mongodb.mongodb.driver.monitoring.commandstartedevent.getcommand; -&reference.mongodb.mongodb.driver.monitoring.commandstartedevent.getcommandname; -&reference.mongodb.mongodb.driver.monitoring.commandstartedevent.getdatabasename; -&reference.mongodb.mongodb.driver.monitoring.commandstartedevent.getoperationid; -&reference.mongodb.mongodb.driver.monitoring.commandstartedevent.getrequestid; -&reference.mongodb.mongodb.driver.monitoring.commandstartedevent.getserver; -&reference.mongodb.mongodb.driver.monitoring.commandstartedevent.getserviceid; diff --git a/reference/mongodb/mongodb/driver/monitoring/entities.commandsubscriber.xml b/reference/mongodb/mongodb/driver/monitoring/entities.commandsubscriber.xml deleted file mode 100644 index 1887daebb..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/entities.commandsubscriber.xml +++ /dev/null @@ -1,3 +0,0 @@ -&reference.mongodb.mongodb.driver.monitoring.commandsubscriber.commandfailed; -&reference.mongodb.mongodb.driver.monitoring.commandsubscriber.commandstarted; -&reference.mongodb.mongodb.driver.monitoring.commandsubscriber.commandsucceeded; diff --git a/reference/mongodb/mongodb/driver/monitoring/entities.commandsucceededevent.xml b/reference/mongodb/mongodb/driver/monitoring/entities.commandsucceededevent.xml deleted file mode 100644 index df32e0300..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/entities.commandsucceededevent.xml +++ /dev/null @@ -1,7 +0,0 @@ -&reference.mongodb.mongodb.driver.monitoring.commandsucceededevent.getcommandname; -&reference.mongodb.mongodb.driver.monitoring.commandsucceededevent.getdurationmicros; -&reference.mongodb.mongodb.driver.monitoring.commandsucceededevent.getoperationid; -&reference.mongodb.mongodb.driver.monitoring.commandsucceededevent.getreply; -&reference.mongodb.mongodb.driver.monitoring.commandsucceededevent.getrequestid; -&reference.mongodb.mongodb.driver.monitoring.commandsucceededevent.getserver; -&reference.mongodb.mongodb.driver.monitoring.commandsucceededevent.getserviceid; diff --git a/reference/mongodb/mongodb/driver/monitoring/entities.sdamsubscriber.xml b/reference/mongodb/mongodb/driver/monitoring/entities.sdamsubscriber.xml deleted file mode 100644 index 674bcf6f1..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/entities.sdamsubscriber.xml +++ /dev/null @@ -1,9 +0,0 @@ -&reference.mongodb.mongodb.driver.monitoring.sdamsubscriber.serverchanged; -&reference.mongodb.mongodb.driver.monitoring.sdamsubscriber.serverclosed; -&reference.mongodb.mongodb.driver.monitoring.sdamsubscriber.serverheartbeatfailed; -&reference.mongodb.mongodb.driver.monitoring.sdamsubscriber.serverheartbeatstarted; -&reference.mongodb.mongodb.driver.monitoring.sdamsubscriber.serverheartbeatsucceeded; -&reference.mongodb.mongodb.driver.monitoring.sdamsubscriber.serveropening; -&reference.mongodb.mongodb.driver.monitoring.sdamsubscriber.topologychanged; -&reference.mongodb.mongodb.driver.monitoring.sdamsubscriber.topologyclosed; -&reference.mongodb.mongodb.driver.monitoring.sdamsubscriber.topologyopening; diff --git a/reference/mongodb/mongodb/driver/monitoring/entities.serverchangedevent.xml b/reference/mongodb/mongodb/driver/monitoring/entities.serverchangedevent.xml deleted file mode 100644 index b20e36333..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/entities.serverchangedevent.xml +++ /dev/null @@ -1,5 +0,0 @@ -&reference.mongodb.mongodb.driver.monitoring.serverchangedevent.gethost; -&reference.mongodb.mongodb.driver.monitoring.serverchangedevent.getnewdescription; -&reference.mongodb.mongodb.driver.monitoring.serverchangedevent.getport; -&reference.mongodb.mongodb.driver.monitoring.serverchangedevent.getpreviousdescription; -&reference.mongodb.mongodb.driver.monitoring.serverchangedevent.gettopologyid; diff --git a/reference/mongodb/mongodb/driver/monitoring/entities.serverclosedevent.xml b/reference/mongodb/mongodb/driver/monitoring/entities.serverclosedevent.xml deleted file mode 100644 index eae9bfe8e..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/entities.serverclosedevent.xml +++ /dev/null @@ -1,3 +0,0 @@ -&reference.mongodb.mongodb.driver.monitoring.serverclosedevent.gethost; -&reference.mongodb.mongodb.driver.monitoring.serverclosedevent.getport; -&reference.mongodb.mongodb.driver.monitoring.serverclosedevent.gettopologyid; diff --git a/reference/mongodb/mongodb/driver/monitoring/entities.serverheartbeatfailedevent.xml b/reference/mongodb/mongodb/driver/monitoring/entities.serverheartbeatfailedevent.xml deleted file mode 100644 index 8d6b9e9b8..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/entities.serverheartbeatfailedevent.xml +++ /dev/null @@ -1,5 +0,0 @@ -&reference.mongodb.mongodb.driver.monitoring.serverheartbeatfailedevent.getdurationmicros; -&reference.mongodb.mongodb.driver.monitoring.serverheartbeatfailedevent.geterror; -&reference.mongodb.mongodb.driver.monitoring.serverheartbeatfailedevent.gethost; -&reference.mongodb.mongodb.driver.monitoring.serverheartbeatfailedevent.getport; -&reference.mongodb.mongodb.driver.monitoring.serverheartbeatfailedevent.isawaited; diff --git a/reference/mongodb/mongodb/driver/monitoring/entities.serverheartbeatstartedevent.xml b/reference/mongodb/mongodb/driver/monitoring/entities.serverheartbeatstartedevent.xml deleted file mode 100644 index e685ff3b9..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/entities.serverheartbeatstartedevent.xml +++ /dev/null @@ -1,3 +0,0 @@ -&reference.mongodb.mongodb.driver.monitoring.serverheartbeatstartedevent.gethost; -&reference.mongodb.mongodb.driver.monitoring.serverheartbeatstartedevent.getport; -&reference.mongodb.mongodb.driver.monitoring.serverheartbeatstartedevent.isawaited; diff --git a/reference/mongodb/mongodb/driver/monitoring/entities.serverheartbeatsucceededevent.xml b/reference/mongodb/mongodb/driver/monitoring/entities.serverheartbeatsucceededevent.xml deleted file mode 100644 index cd1c6890e..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/entities.serverheartbeatsucceededevent.xml +++ /dev/null @@ -1,5 +0,0 @@ -&reference.mongodb.mongodb.driver.monitoring.serverheartbeatsucceededevent.getdurationmicros; -&reference.mongodb.mongodb.driver.monitoring.serverheartbeatsucceededevent.gethost; -&reference.mongodb.mongodb.driver.monitoring.serverheartbeatsucceededevent.getport; -&reference.mongodb.mongodb.driver.monitoring.serverheartbeatsucceededevent.getreply; -&reference.mongodb.mongodb.driver.monitoring.serverheartbeatsucceededevent.isawaited; diff --git a/reference/mongodb/mongodb/driver/monitoring/entities.serveropeningevent.xml b/reference/mongodb/mongodb/driver/monitoring/entities.serveropeningevent.xml deleted file mode 100644 index 8d9b1d408..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/entities.serveropeningevent.xml +++ /dev/null @@ -1,3 +0,0 @@ -&reference.mongodb.mongodb.driver.monitoring.serveropeningevent.gethost; -&reference.mongodb.mongodb.driver.monitoring.serveropeningevent.getport; -&reference.mongodb.mongodb.driver.monitoring.serveropeningevent.gettopologyid; diff --git a/reference/mongodb/mongodb/driver/monitoring/entities.topologychangedevent.xml b/reference/mongodb/mongodb/driver/monitoring/entities.topologychangedevent.xml deleted file mode 100644 index 2b64534f6..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/entities.topologychangedevent.xml +++ /dev/null @@ -1,3 +0,0 @@ -&reference.mongodb.mongodb.driver.monitoring.topologychangedevent.getnewdescription; -&reference.mongodb.mongodb.driver.monitoring.topologychangedevent.getpreviousdescription; -&reference.mongodb.mongodb.driver.monitoring.topologychangedevent.gettopologyid; diff --git a/reference/mongodb/mongodb/driver/monitoring/entities.topologyclosedevent.xml b/reference/mongodb/mongodb/driver/monitoring/entities.topologyclosedevent.xml deleted file mode 100644 index 40f85722a..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/entities.topologyclosedevent.xml +++ /dev/null @@ -1 +0,0 @@ -&reference.mongodb.mongodb.driver.monitoring.topologyclosedevent.gettopologyid; diff --git a/reference/mongodb/mongodb/driver/monitoring/entities.topologyopeningevent.xml b/reference/mongodb/mongodb/driver/monitoring/entities.topologyopeningevent.xml deleted file mode 100644 index af8737222..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/entities.topologyopeningevent.xml +++ /dev/null @@ -1 +0,0 @@ -&reference.mongodb.mongodb.driver.monitoring.topologyopeningevent.gettopologyid; diff --git a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber.xml b/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber.xml deleted file mode 100644 index 978013805..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - The MongoDB\Driver\Monitoring\SDAMSubscriber interface - MongoDB\Driver\Monitoring\SDAMSubscriber - - - - -
- &reftitle.intro; - - Classes may implement this interface to register an event subscriber that is - notified for various SDAM events. See the - Server Discovery and Monitoring - and SDAM Monitoring - specifications for additional information. - -
- - -
- &reftitle.interfacesynopsis; - - - - MongoDB\Driver\Monitoring\SDAMSubscriber - - - - - MongoDB\Driver\Monitoring\SDAMSubscriber - - - - MongoDB\Driver\Monitoring\Subscriber - - - - - &Methods; - - - - -
- - - - &reference.mongodb.mongodb.driver.monitoring.entities.sdamsubscriber; - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serverchanged.xml b/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serverchanged.xml deleted file mode 100644 index fbcb51614..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serverchanged.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\SDAMSubscriber::serverChanged - Notification method for a server description change - - - - &reftitle.description; - - abstract public voidMongoDB\Driver\Monitoring\SDAMSubscriber::serverChanged - MongoDB\Driver\Monitoring\ServerChangedEventevent - - - If the subscriber has been registered, the driver will call this method when - a server's description has changed. - - - - - &reftitle.parameters; - - - event (MongoDB\Driver\Monitoring\ServerChangedEvent) - - - An event object encapsulating information about the changed server - description. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\ServerChangedEvent - MongoDB\Driver\Monitoring\addSubscriber - MongoDB\Driver\Manager::addSubscriber - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serverclosed.xml b/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serverclosed.xml deleted file mode 100644 index 4a2e44d58..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serverclosed.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\SDAMSubscriber::serverClosed - Notification method for closing a server - - - - &reftitle.description; - - abstract public voidMongoDB\Driver\Monitoring\SDAMSubscriber::serverClosed - MongoDB\Driver\Monitoring\ServerClosedEventevent - - - If the subscriber has been registered, the driver will call this method when - a server is closed. - - - - - &reftitle.parameters; - - - event (MongoDB\Driver\Monitoring\ServerClosedEvent) - - - An event object encapsulating information about the closed server. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\ServerClosedEvent - MongoDB\Driver\Monitoring\addSubscriber - MongoDB\Driver\Manager::addSubscriber - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serverheartbeatfailed.xml b/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serverheartbeatfailed.xml deleted file mode 100644 index 47da8a3a3..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serverheartbeatfailed.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\SDAMSubscriber::serverHeartbeatFailed - Notification method for a failed server heartbeat - - - - &reftitle.description; - - abstract public voidMongoDB\Driver\Monitoring\SDAMSubscriber::serverHeartbeatFailed - MongoDB\Driver\Monitoring\ServerHeartbeatFailedEventevent - - - If the subscriber has been registered, the driver will call this method when - a server heartbeat (i.e. - hello - command issued through - server monitoring) has failed. - - - - - &reftitle.parameters; - - - event (MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent) - - - An event object encapsulating information about the failed server - heartbeat. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent - MongoDB\Driver\Monitoring\addSubscriber - MongoDB\Driver\Manager::addSubscriber - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serverheartbeatstarted.xml b/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serverheartbeatstarted.xml deleted file mode 100644 index ff574ff33..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serverheartbeatstarted.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\SDAMSubscriber::serverHeartbeatStarted - Notification method for a started server heartbeat - - - - &reftitle.description; - - abstract public voidMongoDB\Driver\Monitoring\SDAMSubscriber::serverHeartbeatStarted - MongoDB\Driver\Monitoring\ServerHeartbeatStartedEventevent - - - If the subscriber has been registered, the driver will call this method when - a server heartbeat (i.e. - hello - command issued through - server monitoring) has started. - - - - - &reftitle.parameters; - - - event (MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent) - - - An event object encapsulating information about the started server - heartbeat. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent - MongoDB\Driver\Monitoring\addSubscriber - MongoDB\Driver\Manager::addSubscriber - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serverheartbeatsucceeded.xml b/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serverheartbeatsucceeded.xml deleted file mode 100644 index 6fb3a0d86..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serverheartbeatsucceeded.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\SDAMSubscriber::serverHeartbeatSucceeded - Notification method for a successful server heartbeat - - - - &reftitle.description; - - abstract public voidMongoDB\Driver\Monitoring\SDAMSubscriber::serverHeartbeatSucceeded - MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEventevent - - - If the subscriber has been registered, the driver will call this method when - a server heartbeat (i.e. - hello - command issued through - server monitoring) has - succeeded. - - - - - &reftitle.parameters; - - - event (MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent) - - - An event object encapsulating information about the successful server - heartbeat. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent - MongoDB\Driver\Monitoring\addSubscriber - MongoDB\Driver\Manager::addSubscriber - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serveropening.xml b/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serveropening.xml deleted file mode 100644 index 5f97d8b85..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serveropening.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\SDAMSubscriber::serverOpening - Notification method for opening a server - - - - &reftitle.description; - - abstract public voidMongoDB\Driver\Monitoring\SDAMSubscriber::serverOpening - MongoDB\Driver\Monitoring\ServerOpeningEventevent - - - If the subscriber has been registered, the driver will call this method when - a server is opened. - - - - - &reftitle.parameters; - - - event (MongoDB\Driver\Monitoring\ServerOpeningEvent) - - - An event object encapsulating information about the opened server. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\ServerOpeningEvent - MongoDB\Driver\Monitoring\addSubscriber - MongoDB\Driver\Manager::addSubscriber - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/topologychanged.xml b/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/topologychanged.xml deleted file mode 100644 index 5309a87fe..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/topologychanged.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\SDAMSubscriber::topologyChanged - Notification method for a topology description change - - - - &reftitle.description; - - abstract public voidMongoDB\Driver\Monitoring\SDAMSubscriber::topologyChanged - MongoDB\Driver\Monitoring\TopologyChangedEventevent - - - If the subscriber has been registered, the driver will call this method when - the topology's description has changed. - - - - - &reftitle.parameters; - - - event (MongoDB\Driver\Monitoring\TopologyChangedEvent) - - - An event object encapsulating information about the changed topology - description. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\TopologyChangedEvent - MongoDB\Driver\Monitoring\addSubscriber - MongoDB\Driver\Manager::addSubscriber - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/topologyclosed.xml b/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/topologyclosed.xml deleted file mode 100644 index bf030d2a6..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/topologyclosed.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\SDAMSubscriber::topologyClosed - Notification method for closing the topology - - - - &reftitle.description; - - abstract public voidMongoDB\Driver\Monitoring\SDAMSubscriber::topologyClosed - MongoDB\Driver\Monitoring\TopologyClosedEventevent - - - If the subscriber has been registered, the driver will call this method when - the topology is closed. - - - - - &reftitle.parameters; - - - event (MongoDB\Driver\Monitoring\TopologyClosedEvent) - - - An event object encapsulating information about the closed topology. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\TopologyClosedEvent - MongoDB\Driver\Monitoring\addSubscriber - MongoDB\Driver\Manager::addSubscriber - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/topologyopening.xml b/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/topologyopening.xml deleted file mode 100644 index 17a952875..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/topologyopening.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\SDAMSubscriber::topologyOpening - Notification method for opening the topology - - - - &reftitle.description; - - abstract public voidMongoDB\Driver\Monitoring\SDAMSubscriber::topologyOpening - MongoDB\Driver\Monitoring\TopologyOpeningEventevent - - - If the subscriber has been registered, the driver will call this method when - the topology is opened. - - - - - &reftitle.parameters; - - - event (MongoDB\Driver\Monitoring\TopologyOpeningEvent) - - - An event object encapsulating information about the opened topology. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\TopologyOpeningEvent - MongoDB\Driver\Monitoring\addSubscriber - MongoDB\Driver\Manager::addSubscriber - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverchangedevent.xml b/reference/mongodb/mongodb/driver/monitoring/serverchangedevent.xml deleted file mode 100644 index 7c7997163..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverchangedevent.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - The MongoDB\Driver\Monitoring\ServerChangedEvent class - MongoDB\Driver\Monitoring\ServerChangedEvent - - - - -
- &reftitle.intro; - - The MongoDB\Driver\Monitoring\ServerChangedEvent - class encapsulates information about a changed server description. - -
- - -
- &reftitle.classsynopsis; - - - - MongoDB\Driver\Monitoring\ServerChangedEvent - - - - final - - MongoDB\Driver\Monitoring\ServerChangedEvent - - - - - &Methods; - - - - -
- - - - &reference.mongodb.mongodb.driver.monitoring.entities.serverchangedevent; - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverchangedevent/gethost.xml b/reference/mongodb/mongodb/driver/monitoring/serverchangedevent/gethost.xml deleted file mode 100644 index 08b25905d..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverchangedevent/gethost.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerChangedEvent::getHost - Returns the hostname of the server - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\ServerChangedEvent::getHost - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the hostname of the server. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverchangedevent/getnewdescription.xml b/reference/mongodb/mongodb/driver/monitoring/serverchangedevent/getnewdescription.xml deleted file mode 100644 index 306d60192..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverchangedevent/getnewdescription.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerChangedEvent::getNewDescription - Returns the new description for the server - - - - &reftitle.description; - - final public MongoDB\Driver\ServerDescriptionMongoDB\Driver\Monitoring\ServerChangedEvent::getNewDescription - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the new MongoDB\Driver\ServerDescription - for the server. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverchangedevent/getport.xml b/reference/mongodb/mongodb/driver/monitoring/serverchangedevent/getport.xml deleted file mode 100644 index 4a917f049..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverchangedevent/getport.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerChangedEvent::getPort - Returns the port on which this server is listening - - - - &reftitle.description; - - final public intMongoDB\Driver\Monitoring\ServerChangedEvent::getPort - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the port on which this server is listening. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverchangedevent/getpreviousdescription.xml b/reference/mongodb/mongodb/driver/monitoring/serverchangedevent/getpreviousdescription.xml deleted file mode 100644 index ef5e7530f..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverchangedevent/getpreviousdescription.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerChangedEvent::getPreviousDescription - Returns the previous description for the server - - - - &reftitle.description; - - final public MongoDB\Driver\ServerDescriptionMongoDB\Driver\Monitoring\ServerChangedEvent::getPreviousDescription - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the previous MongoDB\Driver\ServerDescription - for the server. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverchangedevent/gettopologyid.xml b/reference/mongodb/mongodb/driver/monitoring/serverchangedevent/gettopologyid.xml deleted file mode 100644 index f31462b1b..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverchangedevent/gettopologyid.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerChangedEvent::getTopologyId - Returns the topology ID associated with this server - - - - &reftitle.description; - - final public MongoDB\BSON\ObjectIdMongoDB\Driver\Monitoring\ServerChangedEvent::getTopologyId - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the topology ID. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverclosedevent.xml b/reference/mongodb/mongodb/driver/monitoring/serverclosedevent.xml deleted file mode 100644 index af824fa7b..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverclosedevent.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - The MongoDB\Driver\Monitoring\ServerClosedEvent class - MongoDB\Driver\Monitoring\ServerClosedEvent - - - - -
- &reftitle.intro; - - The MongoDB\Driver\Monitoring\ServerClosedEvent - class encapsulates information about a closed server. - -
- - -
- &reftitle.classsynopsis; - - - - MongoDB\Driver\Monitoring\ServerClosedEvent - - - - final - - MongoDB\Driver\Monitoring\ServerClosedEvent - - - - - &Methods; - - - - -
- - - - &reference.mongodb.mongodb.driver.monitoring.entities.serverclosedevent; - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverclosedevent/gethost.xml b/reference/mongodb/mongodb/driver/monitoring/serverclosedevent/gethost.xml deleted file mode 100644 index 08fe70618..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverclosedevent/gethost.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerClosedEvent::getHost - Returns the hostname of the server - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\ServerClosedEvent::getHost - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the hostname of the server. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverclosedevent/getport.xml b/reference/mongodb/mongodb/driver/monitoring/serverclosedevent/getport.xml deleted file mode 100644 index 7275c4d44..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverclosedevent/getport.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerClosedEvent::getPort - Returns the port on which this server is listening - - - - &reftitle.description; - - final public intMongoDB\Driver\Monitoring\ServerClosedEvent::getPort - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the port on which this server is listening. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverclosedevent/gettopologyid.xml b/reference/mongodb/mongodb/driver/monitoring/serverclosedevent/gettopologyid.xml deleted file mode 100644 index 92e039315..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverclosedevent/gettopologyid.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerClosedEvent::getTopologyId - Returns the topology ID associated with this server - - - - &reftitle.description; - - final public MongoDB\BSON\ObjectIdMongoDB\Driver\Monitoring\ServerClosedEvent::getTopologyId - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the topology ID. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent.xml b/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent.xml deleted file mode 100644 index 3f5bd09ef..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - The MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent class - MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent - - - - -
- &reftitle.intro; - - The MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent - class encapsulates information about a failed server heartbeat. - -
- - -
- &reftitle.classsynopsis; - - - - MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent - - - - final - - MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent - - - - - &Methods; - - - - -
- - - - &reference.mongodb.mongodb.driver.monitoring.entities.serverheartbeatfailedevent; - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent/getdurationmicros.xml b/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent/getdurationmicros.xml deleted file mode 100644 index 48574d049..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent/getdurationmicros.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent::getDurationMicros - Returns the heartbeat's duration in microseconds - - - - &reftitle.description; - - final public intMongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent::getDurationMicros - - - - The heartbeat's duration is a calculated value that includes the time to send - the message and receive the reply from the server. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the heartbeat's duration in microseconds. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent/geterror.xml b/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent/geterror.xml deleted file mode 100644 index f0fd25fc8..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent/geterror.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent::getError - Returns the Exception associated with the failed heartbeat - - - - &reftitle.description; - - final public ExceptionMongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent::getError - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the Exception associated with the failed - heartbeat. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent/gethost.xml b/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent/gethost.xml deleted file mode 100644 index fd5c39282..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent/gethost.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent::getHost - Returns the hostname of the server - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent::getHost - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the hostname of the server. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent/getport.xml b/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent/getport.xml deleted file mode 100644 index a2b759a93..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent/getport.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent::getPort - Returns the port on which this server is listening - - - - &reftitle.description; - - final public intMongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent::getPort - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the port on which this server is listening. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent/isawaited.xml b/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent/isawaited.xml deleted file mode 100644 index 702da6acf..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent/isawaited.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent::isAwaited - Returns whether the heartbeat used a streaming protocol - - - - &reftitle.description; - - final public boolMongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent::isAwaited - - - - Returns whether the heartbeat used a streaming protocol. The PHP driver does - not use the streaming protocol for monitoring, so this method will always - return &false;. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &false;. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatstartedevent.xml b/reference/mongodb/mongodb/driver/monitoring/serverheartbeatstartedevent.xml deleted file mode 100644 index 5608a5c94..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatstartedevent.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - The MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent class - MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent - - - - -
- &reftitle.intro; - - The MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent - class encapsulates information about a started server heartbeat. - -
- - -
- &reftitle.classsynopsis; - - - - MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent - - - - final - - MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent - - - - - &Methods; - - - - -
- - - - &reference.mongodb.mongodb.driver.monitoring.entities.serverheartbeatstartedevent; - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatstartedevent/gethost.xml b/reference/mongodb/mongodb/driver/monitoring/serverheartbeatstartedevent/gethost.xml deleted file mode 100644 index 5df965655..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatstartedevent/gethost.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent::getHost - Returns the hostname of the server - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent::getHost - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the hostname of the server. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatstartedevent/getport.xml b/reference/mongodb/mongodb/driver/monitoring/serverheartbeatstartedevent/getport.xml deleted file mode 100644 index 793844360..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatstartedevent/getport.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent::getPort - Returns the port on which this server is listening - - - - &reftitle.description; - - final public intMongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent::getPort - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the port on which this server is listening. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatstartedevent/isawaited.xml b/reference/mongodb/mongodb/driver/monitoring/serverheartbeatstartedevent/isawaited.xml deleted file mode 100644 index 69191b295..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatstartedevent/isawaited.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent::isAwaited - Returns whether the heartbeat used a streaming protocol - - - - &reftitle.description; - - final public boolMongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent::isAwaited - - - - Returns whether the heartbeat used a streaming protocol. The PHP driver does - not use the streaming protocol for monitoring, so this method will always - return &false;. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &false;. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent.xml b/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent.xml deleted file mode 100644 index 6e8c833e0..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - The MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent class - MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent - - - - -
- &reftitle.intro; - - The MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent - class encapsulates information about a successful server heartbeat. - -
- - -
- &reftitle.classsynopsis; - - - - MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent - - - - final - - MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent - - - - - &Methods; - - - - -
- - - - &reference.mongodb.mongodb.driver.monitoring.entities.serverheartbeatsucceededevent; - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent/getdurationmicros.xml b/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent/getdurationmicros.xml deleted file mode 100644 index e419b86e2..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent/getdurationmicros.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent::getDurationMicros - Returns the heartbeat's duration in microseconds - - - - &reftitle.description; - - final public intMongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent::getDurationMicros - - - - The heartbeat's duration is a calculated value that includes the time to send - the message and receive the reply from the server. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the heartbeat's duration in microseconds. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent/gethost.xml b/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent/gethost.xml deleted file mode 100644 index e100ceab7..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent/gethost.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent::getHost - Returns the hostname of the server - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent::getHost - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the hostname of the server. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent/getport.xml b/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent/getport.xml deleted file mode 100644 index 2c4094905..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent/getport.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent::getPort - Returns the port on which this server is listening - - - - &reftitle.description; - - final public intMongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent::getPort - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the port on which this server is listening. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent/getreply.xml b/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent/getreply.xml deleted file mode 100644 index c071b6e47..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent/getreply.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent::getReply - Returns the heartbeat reply document - - - - &reftitle.description; - - final public objectMongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent::getReply - - - - The reply document will be converted from BSON to PHP using the default - deserialization - rules (e.g. BSON documents will be converted to stdClass). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the heartbeat reply document as a stdClass - object. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent/isawaited.xml b/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent/isawaited.xml deleted file mode 100644 index 7886debc4..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent/isawaited.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent::isAwaited - Returns whether the heartbeat used a streaming protocol - - - - &reftitle.description; - - final public boolMongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent::isAwaited - - - - Returns whether the heartbeat used a streaming protocol. The PHP driver does - not use the streaming protocol for monitoring, so this method will always - return &false;. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &false;. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serveropeningevent.xml b/reference/mongodb/mongodb/driver/monitoring/serveropeningevent.xml deleted file mode 100644 index 9a1070859..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serveropeningevent.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - The MongoDB\Driver\Monitoring\ServerOpeningEvent class - MongoDB\Driver\Monitoring\ServerOpeningEvent - - - - -
- &reftitle.intro; - - The MongoDB\Driver\Monitoring\ServerOpeningEvent - class encapsulates information about an opened server. - -
- - -
- &reftitle.classsynopsis; - - - - MongoDB\Driver\Monitoring\ServerOpeningEvent - - - - final - - MongoDB\Driver\Monitoring\ServerOpeningEvent - - - - - &Methods; - - - - -
- - - - &reference.mongodb.mongodb.driver.monitoring.entities.serveropeningevent; - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serveropeningevent/gethost.xml b/reference/mongodb/mongodb/driver/monitoring/serveropeningevent/gethost.xml deleted file mode 100644 index 002345275..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serveropeningevent/gethost.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerOpeningEvent::getHost - Returns the hostname of the server - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\ServerOpeningEvent::getHost - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the hostname of the server. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serveropeningevent/getport.xml b/reference/mongodb/mongodb/driver/monitoring/serveropeningevent/getport.xml deleted file mode 100644 index b8fcd2420..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serveropeningevent/getport.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerOpeningEvent::getPort - Returns the port on which this server is listening - - - - &reftitle.description; - - final public intMongoDB\Driver\Monitoring\ServerOpeningEvent::getPort - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the port on which this server is listening. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serveropeningevent/gettopologyid.xml b/reference/mongodb/mongodb/driver/monitoring/serveropeningevent/gettopologyid.xml deleted file mode 100644 index 71b1fbd6c..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serveropeningevent/gettopologyid.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerOpeningEvent::getTopologyId - Returns the topology ID associated with this server - - - - &reftitle.description; - - final public MongoDB\BSON\ObjectIdMongoDB\Driver\Monitoring\ServerOpeningEvent::getTopologyId - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the topology ID. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/subscriber.xml b/reference/mongodb/mongodb/driver/monitoring/subscriber.xml deleted file mode 100644 index 0d46cd29a..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/subscriber.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - The MongoDB\Driver\Monitoring\Subscriber interface - MongoDB\Driver\Monitoring\Subscriber - - - - -
- &reftitle.intro; - - Base interface for event subscribers. This is used as a parameter type in the functions - MongoDB\Driver\Monitoring\addSubscriber and - MongoDB\Driver\Monitoring\removeSubscriber and should - not be implemented directly. - -
- - -
- &reftitle.interfacesynopsis; - - - - MongoDB\Driver\Monitoring\Subscriber - - - - - MongoDB\Driver\Monitoring\Subscriber - - - - - - - - - This interface has no methods. Its only purpose is to be the base interface - for all event subscribers. - - -
- - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/topologychangedevent.xml b/reference/mongodb/mongodb/driver/monitoring/topologychangedevent.xml deleted file mode 100644 index 46a93f2f5..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/topologychangedevent.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - The MongoDB\Driver\Monitoring\TopologyChangedEvent class - MongoDB\Driver\Monitoring\TopologyChangedEvent - - - - -
- &reftitle.intro; - - The MongoDB\Driver\Monitoring\TopologyChangedEvent - class encapsulates information about a changed topology description. - -
- - -
- &reftitle.classsynopsis; - - - - MongoDB\Driver\Monitoring\TopologyChangedEvent - - - - final - - MongoDB\Driver\Monitoring\TopologyChangedEvent - - - - - &Methods; - - - - -
- - - - &reference.mongodb.mongodb.driver.monitoring.entities.topologychangedevent; - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/topologychangedevent/getnewdescription.xml b/reference/mongodb/mongodb/driver/monitoring/topologychangedevent/getnewdescription.xml deleted file mode 100644 index bf2eff554..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/topologychangedevent/getnewdescription.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\TopologyChangedEvent::getNewDescription - Returns the new description for the topology - - - - &reftitle.description; - - final public MongoDB\Driver\TopologyDescriptionMongoDB\Driver\Monitoring\TopologyChangedEvent::getNewDescription - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the new MongoDB\Driver\TopologyDescription - for the topology. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/topologychangedevent/getpreviousdescription.xml b/reference/mongodb/mongodb/driver/monitoring/topologychangedevent/getpreviousdescription.xml deleted file mode 100644 index 36af2580a..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/topologychangedevent/getpreviousdescription.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\TopologyChangedEvent::getPreviousDescription - Returns the previous description for the topology - - - - &reftitle.description; - - final public MongoDB\Driver\TopologyDescriptionMongoDB\Driver\Monitoring\TopologyChangedEvent::getPreviousDescription - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the previous MongoDB\Driver\TopologyDescription - for the topology. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/topologychangedevent/gettopologyid.xml b/reference/mongodb/mongodb/driver/monitoring/topologychangedevent/gettopologyid.xml deleted file mode 100644 index 59d3f708c..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/topologychangedevent/gettopologyid.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\TopologyChangedEvent::getTopologyId - Returns the topology ID - - - - &reftitle.description; - - final public MongoDB\BSON\ObjectIdMongoDB\Driver\Monitoring\TopologyChangedEvent::getTopologyId - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the topology ID. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/topologyclosedevent.xml b/reference/mongodb/mongodb/driver/monitoring/topologyclosedevent.xml deleted file mode 100644 index fca90cdc3..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/topologyclosedevent.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - The MongoDB\Driver\Monitoring\TopologyClosedEvent class - MongoDB\Driver\Monitoring\TopologyClosedEvent - - - - -
- &reftitle.intro; - - The MongoDB\Driver\Monitoring\TopologyClosedEvent - class encapsulates information about a closed topology. - -
- - -
- &reftitle.classsynopsis; - - - - MongoDB\Driver\Monitoring\TopologyClosedEvent - - - - final - - MongoDB\Driver\Monitoring\TopologyClosedEvent - - - - - &Methods; - - - - -
- - - - &reference.mongodb.mongodb.driver.monitoring.entities.topologyclosedevent; - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/topologyclosedevent/gettopologyid.xml b/reference/mongodb/mongodb/driver/monitoring/topologyclosedevent/gettopologyid.xml deleted file mode 100644 index f4cdc97c3..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/topologyclosedevent/gettopologyid.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\TopologyClosedEvent::getTopologyId - Returns the topology ID - - - - &reftitle.description; - - final public MongoDB\BSON\ObjectIdMongoDB\Driver\Monitoring\TopologyClosedEvent::getTopologyId - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the topology ID. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/topologyopeningevent.xml b/reference/mongodb/mongodb/driver/monitoring/topologyopeningevent.xml deleted file mode 100644 index 255abe01c..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/topologyopeningevent.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - The MongoDB\Driver\Monitoring\TopologyOpeningEvent class - MongoDB\Driver\Monitoring\TopologyOpeningEvent - - - - -
- &reftitle.intro; - - The MongoDB\Driver\Monitoring\TopologyOpeningEvent - class encapsulates information about an opened topology. - -
- - -
- &reftitle.classsynopsis; - - - - MongoDB\Driver\Monitoring\TopologyOpeningEvent - - - - final - - MongoDB\Driver\Monitoring\TopologyOpeningEvent - - - - - &Methods; - - - - -
- - - - &reference.mongodb.mongodb.driver.monitoring.entities.topologyopeningevent; - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/topologyopeningevent/gettopologyid.xml b/reference/mongodb/mongodb/driver/monitoring/topologyopeningevent/gettopologyid.xml deleted file mode 100644 index 678540919..000000000 --- a/reference/mongodb/mongodb/driver/monitoring/topologyopeningevent/gettopologyid.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\TopologyOpeningEvent::getTopologyId - Returns the topology ID - - - - &reftitle.description; - - final public MongoDB\BSON\ObjectIdMongoDB\Driver\Monitoring\TopologyOpeningEvent::getTopologyId - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the topology ID. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/query.xml b/reference/mongodb/mongodb/driver/query.xml deleted file mode 100644 index db12fa40b..000000000 --- a/reference/mongodb/mongodb/driver/query.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - The MongoDB\Driver\Query class - MongoDB\Driver\Query - - - - -
- &reftitle.intro; - - The MongoDB\Driver\Query class is a value object that - represents a database query. - -
- - -
- &reftitle.classsynopsis; - - - - MongoDB\Driver\Query - - - - final - - MongoDB\Driver\Query - - - - - &Methods; - - - - -
- - - - - &reference.mongodb.mongodb.driver.entities.query; - - - - diff --git a/reference/mongodb/mongodb/driver/query/construct.xml b/reference/mongodb/mongodb/driver/query/construct.xml deleted file mode 100644 index 8b289c3d5..000000000 --- a/reference/mongodb/mongodb/driver/query/construct.xml +++ /dev/null @@ -1,571 +0,0 @@ - - - - - - MongoDB\Driver\Query::__construct - Create a new Query - - - - &reftitle.description; - - final public MongoDB\Driver\Query::__construct - arrayobjectfilter - arrayqueryOptions - - - Constructs a new MongoDB\Driver\Query, which is an - immutable value object that represents a database query. The query may then - be executed with - MongoDB\Driver\Manager::executeQuery. - - - - - &reftitle.parameters; - - &mongodb.parameter.filter; - - queryOptions - - - - queryOptions - - - - Option - Type - Description - - - - - allowDiskUse - bool - - - Allows MongoDB to use temporary disk files to store data exceeding - the 100 megabyte system memory limit while processing a blocking - sort operation. - - - - - allowPartialResults - bool - - - For queries against a sharded collection, returns partial results - from the mongos if some shards are unavailable instead of throwing - an error. - - - Falls back to the deprecated "partial" option if - not specified. - - - - - awaitData - bool - - Use in conjunction with the "tailable" option to - block a getMore operation on the cursor temporarily if at the end of - data rather than returning no data. After a timeout period, the query - returns as normal. - - - - batchSize - int - - - The number of documents to return in the first batch. Defaults to - 101. A batch size of 0 means that the cursor will be established, - but no documents will be returned in the first batch. - - - In versions of MongoDB before 3.2, where queries use the legacy wire - protocol OP_QUERY, a batch size of 1 will close the cursor - irrespective of the number of matched documents. - - - - &mongodb.option.collation; - - comment - string - - - A comment to attach to the query to help interpret and trace query - profile data. - - - Falls back to the deprecated "$comment" modifier - if not specified. - - - - - exhaust - bool - - - Stream the data down full blast in multiple "more" packages, on the - assumption that the client will fully read all data queried. Faster - when you are pulling a lot of data and know you want to pull it all - down. Note: the client is not allowed to not read all the data - unless it closes the connection. - - - This option is not supported by the find command in MongoDB 3.2+ and - will force the driver to use the legacy wire protocol version (i.e. - OP_QUERY). - - - - - explain - bool - - - If &true;, the returned MongoDB\Driver\Cursor - will contain a single document that describes the process and - indexes used to return the query. - - - Falls back to the deprecated "$explain" modifier - if not specified. - - - This option is not supported by the find command in MongoDB 3.2+ and - will only be respected when using the legacy wire protocol version - (i.e. OP_QUERY). The - explain - command should be used on MongoDB 3.0+. - - - - - hint - stringarrayobject - - - Index specification. Specify either the index name as a string or - the index key pattern. If specified, then the query system will only - consider plans using the hinted index. - - - Falls back to the deprecated "hint" option if not - specified. - - - - - limit - int - - - The maximum number of documents to return. If unspecified, then - defaults to no limit. A limit of 0 is equivalent to setting no - limit. - - - A negative limit is will be interpreted as a positive limit with the - "singleBatch" option set to &true;. This behavior - is supported for backwards compatibility, but should be considered - deprecated. - - - - - max - arrayobject - - - The exclusive upper bound for a specific index. - - - Falls back to the deprecated "$max" modifier if - not specified. - - - - - maxAwaitTimeMS - int - - - Positive integer denoting the time limit in milliseconds for the - server to block a getMore operation if no data is available. This - option should only be used in conjunction with the - "tailable" and "awaitData" - options. - - - - - maxScan - int - - - - This option is deprecated and should not be used. - - - - Positive integer denoting the maximum number of documents or index - keys to scan when executing the query. - - - Falls back to the deprecated "$maxScan" modifier - if not specified. - - - - - maxTimeMS - int - - - The cumulative time limit in milliseconds for processing operations - on the cursor. MongoDB aborts the operation at the earliest - following interrupt point. - - - Falls back to the deprecated "$maxTimeMS" - modifier if not specified. - - - - - min - arrayobject - - - The inclusive lower bound for a specific index. - - - Falls back to the deprecated "$min" modifier if - not specified. - - - - - modifiers - array - - Meta operators - modifying the output or behavior of a query. Use of these operators - is deprecated in favor of named options. - - - - noCursorTimeout - bool - - Prevents the server from timing out idle cursors after an inactivity - period (10 minutes). - - - - oplogReplay - bool - - - Internal use for replica sets. To use oplogReplay, you must include - the following condition in the filter: - - - - [ '$gte' => ] ] -]]> - - - This option is deprecated as of the 1.8.0 release. - - - - projection - arrayobject - - - The projection specification - to determine which fields to include in the returned documents. - - - If you are using the ODM - functionality to deserialise documents as their original - PHP class, make sure that you include the - __pclass field in the projection. This is - required for the deserialization to work and without it, the - driver will return (by default) a stdClass - object instead. - - - - - readConcern - MongoDB\Driver\ReadConcern - - - A read concern to apply to the operation. By default, the read - concern from the - MongoDB - Connection URI will be used. - - - This option is available in MongoDB 3.2+ and will result in an - exception at execution time if specified for an older server - version. - - - - - returnKey - bool - - - If &true;, returns only the index keys in the resulting documents. - Default value is &false;. If &true; and the find command does not - use an index, the returned documents will be empty. - - - Falls back to the deprecated "$returnKey" - modifier if not specified. - - - - - showRecordId - bool - - - Determines whether to return the record identifier for each - document. If &true;, adds a top-level "$recordId" - field to the returned documents. - - - Falls back to the deprecated "$showDiskLoc" - modifier if not specified. - - - - - singleBatch - bool - - Determines whether to close the cursor after the first batch. - Defaults to &false;. - - - - skip - int - Number of documents to skip. Defaults to 0. - - - snapshot - bool - - - - This option is deprecated and should not be used. - - - - Prevents the cursor from returning a document more than once because - of an intervening write operation. - - - Falls back to the deprecated "$snapshot" modifier - if not specified. - - - - - sort - arrayobject - - The sort specification for the ordering of the results. - - Falls back to the deprecated "$orderby" modifier - if not specified. - - - - - tailable - bool - Returns a tailable cursor for a capped collection. - - - -
- - - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 1.8.0 - - - Added the "allowDiskUse" option. - - - The "oplogReplay" option is deprecated. - - - - - PECL mongodb 1.5.0 - - - The "maxScan" and "snapshot" - options are deprecated. - - - - - PECL mongodb 1.3.0 - - - Added the "maxAwaitTimeMS" option. - - - - - PECL mongodb 1.2.0 - - - Added the "allowPartialResults", - "collation", "comment", - "hint", "max", - "maxScan", "maxTimeMS", - "min", "returnKey", - "showRecordId", and "snapshot" - options. - - - Renamed the "partial" option to - "allowPartialResults". For backwards compatibility, - "partial" will still be read if - "allowPartialResults" is not specified. - - - Removed the legacy "secondaryOk" option, which is - obsolete. For queries using the legacy wire protocol OP_QUERY, the - driver will set the secondaryOk bit as needed in - accordance with the - Server Selection Specification. - - - - - PECL mongodb 1.1.0 - Added the "readConcern" option. - - - - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\Query::__construct</function> example - - 'bjori', - 'views' => [ - '$gte' => 100, - ], -]; - -$options = [ - /* Only return the following fields in the matching documents */ - 'projection' => [ - 'title' => 1, - 'article' => 1, - ], - /* Return the documents in descending order of views */ - 'sort' => [ - 'views' => -1 - ], -]; - -$query = new MongoDB\Driver\Query($filter, $options); - -$manager = new MongoDB\Driver\Manager('mongodb://localhost:27017'); -$readPreference = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::RP_PRIMARY); -$cursor = $manager->executeQuery('databaseName.collectionName', $query, $readPreference); - -foreach($cursor as $document) { - var_dump($document); -} - -?> -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::executeQuery - MongoDB\Driver\Cursor - - - - - - diff --git a/reference/mongodb/mongodb/driver/readconcern.xml b/reference/mongodb/mongodb/driver/readconcern.xml deleted file mode 100644 index 4dc714c94..000000000 --- a/reference/mongodb/mongodb/driver/readconcern.xml +++ /dev/null @@ -1,315 +0,0 @@ - - - - - - The MongoDB\Driver\ReadConcern class - MongoDB\Driver\ReadConcern - - - - -
- &reftitle.intro; - - MongoDB\Driver\ReadConcern controls the level of - isolation for read operations for replica sets and replica set shards. This - option requires MongoDB 3.2 or later. - -
- - -
- &reftitle.classsynopsis; - - - - MongoDB\Driver\ReadConcern - - - - final - - MongoDB\Driver\ReadConcern - - - - MongoDB\BSON\Serializable - - - - Serializable - - - - Constants - - const - string - MongoDB\Driver\ReadConcern::AVAILABLE - "available" - - - const - string - MongoDB\Driver\ReadConcern::LINEARIZABLE - "linearizable" - - - const - string - MongoDB\Driver\ReadConcern::LOCAL - "local" - - - const - string - MongoDB\Driver\ReadConcern::MAJORITY - "majority" - - - const - string - MongoDB\Driver\ReadConcern::SNAPSHOT - "snapshot" - - - &Methods; - - - - -
- - -
- &reftitle.constants; - - - - MongoDB\Driver\ReadConcern::AVAILABLE - - - Default for reads against secondaries when - afterClusterTimeand level are - unspecified. - - - The query returns the instance's most recent data. Provides no - guarantee that the data has been written to a majority of the replica set - members (i.e. may be rolled back). - - - For unsharded collections (including collections in a standalone - deployment or a replica set deployment), "local" and - "available" read concerns behave identically. - - - For a sharded cluster, "available" read concern - provides greater tolerance for partitions since it does not wait to - ensure consistency guarantees. However, a query with - "available" read concern may return orphan documents - if the shard is undergoing chunk migrations since the - "available" read concern, unlike - "local" read concern, does not contact the - shard's primary nor the config servers for updated metadata. - - - - - - MongoDB\Driver\ReadConcern::LINEARIZABLE - - - The query returns data that reflects all successful writes issued with a - write concern of "majority" and - acknowledged prior to the start of the read operation. For replica sets - that run with writeConcernMajorityJournalDefault set - to &true;, linearizable read concern returns data that will never be - rolled back. - - - With writeConcernMajorityJournalDefault set to - &false;, MongoDB will not wait for w: "majority" - writes to be durable before acknowledging the writes. As such, - "majority" write operations could possibly roll back - in the event of a loss of a replica set member. - - - You can specify linearizable read concern for read operations on the - primary only. - - - Linearizable read concern guarantees only apply if read - operations specify a query filter that uniquely identifies a single - document. - - - - Always use maxTimeMS with linearizable read concern - in case a majority of data bearing members are unavailable. - maxTimeMS ensures that the operation does not block - indefinitely and instead ensures that the operation returns an error if - the read concern cannot be fulfilled. - - - - Linearizable read concern requires MongoDB 3.4. - - - - - - MongoDB\Driver\ReadConcern::LOCAL - - - Default for reads against primary if level is - unspecified and for reads against secondaries if level - is unspecified but afterClusterTime is specified. - - - The query returns the instance's most recent data. Provides no - guarantee that the data has been written to a majority of the replica set - members (i.e. may be rolled back). - - - - - - MongoDB\Driver\ReadConcern::MAJORITY - - - The query returns the instance's most recent data acknowledged as - having been written to a majority of members in the replica set. - - - To use read concern level of "majority", replica sets - must use WiredTiger storage engine and election protocol version 1. - - - - - - MongoDB\Driver\ReadConcern::SNAPSHOT - - - Read concern "snapshot" is available for - multi-document transactions, and starting in MongoDB 5.0, certain read - operations outside of multi-document transactions. - - - If the transaction is not part of a causally consistent session, upon - transaction commit with write concern "majority", the - transaction operations are guaranteed to have read from a snapshot of - majority-committed data. - - - If the transaction is part of a causally consistent session, upon - transaction commit with write concern "majority", the - transaction operations are guaranteed to have read from a snapshot of - majority-committed data that provides causal consistency with the - operation immediately preceding the transaction start. - - - Outside of multi-document transactions, read concern - "snapshot" is available on primaries and secondaries - for the following read operations: find, - aggregate, and distinct (on - unsharded collections). All other read commands prohibit - "snapshot". - - - - - -
- - -
- &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 1.11.0 - - - Added the MongoDB\Driver\ReadConcern::SNAPSHOT - constant. - - - - - PECL mongodb 1.7.0 - - Implements Serializable. - - - - PECL mongodb 1.4.0 - - - Added the MongoDB\Driver\ReadConcern::AVAILABLE - constant. - - - - - PECL mongodb 1.2.0 - - - Added the - MongoDB\Driver\ReadConcern::LINEARIZABLE - constant. - - - Implements MongoDB\BSON\Serializable. - - - - - - - -
- -
- &reftitle.seealso; - - Read Concern reference - -
- - - - &reference.mongodb.mongodb.driver.entities.readconcern; - - - - diff --git a/reference/mongodb/mongodb/driver/readconcern/bsonserialize.xml b/reference/mongodb/mongodb/driver/readconcern/bsonserialize.xml deleted file mode 100644 index 91597a416..000000000 --- a/reference/mongodb/mongodb/driver/readconcern/bsonserialize.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - MongoDB\Driver\ReadConcern::bsonSerialize - Returns an object for BSON serialization - - - - &reftitle.description; - - final public objectMongoDB\Driver\ReadConcern::bsonSerialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an object for serializing the ReadConcern as BSON. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\ReadConcern::bsonSerialize</function> with empty read concern - -bsonSerialize()); - -echo "\n", MongoDB\BSON\toJSON(MongoDB\BSON\fromPHP($rc)); - -?> -]]> - - &example.outputs.similar; - - - - - <function>MongoDB\Driver\ReadConcern::bsonSerialize</function> with local read concern - -bsonSerialize()); - -echo "\n", MongoDB\BSON\toJSON(MongoDB\BSON\fromPHP($rc)); - -?> -]]> - - &example.outputs.similar; - - - string(5) "local" -} - -{ "level" : "local" } -]]> - - - - - - - &reftitle.seealso; - - MongoDB\BSON\Serializable::bsonSerialize - Read Concern reference - - - - - - diff --git a/reference/mongodb/mongodb/driver/readconcern/construct.xml b/reference/mongodb/mongodb/driver/readconcern/construct.xml deleted file mode 100644 index 0e133ab53..000000000 --- a/reference/mongodb/mongodb/driver/readconcern/construct.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - MongoDB\Driver\ReadConcern::__construct - Create a new ReadConcern - - - - &reftitle.description; - - final public MongoDB\Driver\ReadConcern::__construct - stringlevel - - - Constructs a new MongoDB\Driver\ReadConcern, which is - an immutable value object. - - - - - &reftitle.parameters; - - - level - - - The read concern level. - You may use, but are not limited to, one of the - class constants. - - - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\ReadConcern::__construct</function> example - - -]]> - - - - - - - &reftitle.seealso; - - Read Concern reference - - - - - - diff --git a/reference/mongodb/mongodb/driver/readconcern/getlevel.xml b/reference/mongodb/mongodb/driver/readconcern/getlevel.xml deleted file mode 100644 index 86fb459a4..000000000 --- a/reference/mongodb/mongodb/driver/readconcern/getlevel.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - MongoDB\Driver\ReadConcern::getLevel - Returns the ReadConcern's "level" option - - - - &reftitle.description; - - final public stringnullMongoDB\Driver\ReadConcern::getLevel - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the ReadConcern's "level" option. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\ReadConcern::getLevel</function> example - -getLevel()); - -$rc = new MongoDB\Driver\ReadConcern(MongoDB\Driver\ReadConcern::LOCAL); -var_dump($rc->getLevel()); - -$rc = new MongoDB\Driver\ReadConcern(MongoDB\Driver\ReadConcern::MAJORITY); -var_dump($rc->getLevel()); - -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - Read Concern reference - - - - - - diff --git a/reference/mongodb/mongodb/driver/readconcern/isdefault.xml b/reference/mongodb/mongodb/driver/readconcern/isdefault.xml deleted file mode 100644 index 3f342aee5..000000000 --- a/reference/mongodb/mongodb/driver/readconcern/isdefault.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - MongoDB\Driver\ReadConcern::isDefault - Checks if this is the default read concern - - - - &reftitle.description; - - final public boolMongoDB\Driver\ReadConcern::isDefault - - - - Returns whether this is the default read concern (i.e. no options are - specified). This method is primarily intended to be used in conjunction with - MongoDB\Driver\Manager::getReadConcern to determine - whether the Manager has been constructed without any read concern options. - - - The driver will not include a default read concern in its read operations - (e.g. MongoDB\Driver\Manager::executeQuery) in order - order to allow the server to apply its own default. Libraries that access the - Manager's read concern to include it in their own read commands should use - this method to ensure that default read concerns are left unset. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; if this is the default read concern and &false; otherwise. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - <function>MongoDB\Driver\ReadConcern::isDefault</function> example - -isDefault()); - -$rc = new MongoDB\Driver\ReadConcern(MongoDB\Driver\ReadConcern::MAJORITY); -var_dump($rc->isDefault()); - -$manager = new MongoDB\Driver\Manager('mongodb://127.0.0.1/?readConcernLevel=majority'); -$rc = $manager->getReadConcern(); -var_dump($rc->isDefault()); - -$manager = new MongoDB\Driver\Manager('mongodb://127.0.0.1/'); -$rc = $manager->getReadConcern(); -var_dump($rc->isDefault()); - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::getReadConcern - Read Concern reference - - - - - - diff --git a/reference/mongodb/mongodb/driver/readconcern/serialize.xml b/reference/mongodb/mongodb/driver/readconcern/serialize.xml deleted file mode 100644 index 1fe9467ba..000000000 --- a/reference/mongodb/mongodb/driver/readconcern/serialize.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - MongoDB\Driver\ReadConcern::serialize - Serialize a ReadConcern - - - - &reftitle.description; - - final public stringMongoDB\Driver\ReadConcern::serialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the serialized representation of the - MongoDB\Driver\ReadConcern. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\ReadConcern::unserialize - serialize - Serializing Objects - - - - - - diff --git a/reference/mongodb/mongodb/driver/readconcern/unserialize.xml b/reference/mongodb/mongodb/driver/readconcern/unserialize.xml deleted file mode 100644 index 7954ab985..000000000 --- a/reference/mongodb/mongodb/driver/readconcern/unserialize.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - MongoDB\Driver\ReadConcern::unserialize - Unserialize a ReadConcern - - - - &reftitle.description; - - final public voidMongoDB\Driver\ReadConcern::unserialize - stringserialized - - - - - &reftitle.parameters; - - - - serialized - - - The serialized MongoDB\Driver\ReadConcern. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\UnexpectedValueException if the properties cannot be unserialized (i.e. serialized was malformed). - Throws MongoDB\Driver\Exception\InvalidArgumentException if the properties are invalid (e.g. missing fields or invalid values). - - - - - &reftitle.seealso; - - MongoDB\Driver\ReadConcern::serialize - unserialize - Serializing Objects - - - - - - diff --git a/reference/mongodb/mongodb/driver/readpreference.xml b/reference/mongodb/mongodb/driver/readpreference.xml deleted file mode 100644 index 8fa6adebf..000000000 --- a/reference/mongodb/mongodb/driver/readpreference.xml +++ /dev/null @@ -1,331 +0,0 @@ - - - - - - The MongoDB\Driver\ReadPreference class - MongoDB\Driver\ReadPreference - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - MongoDB\Driver\ReadPreference - - - - final - - MongoDB\Driver\ReadPreference - - - - MongoDB\BSON\Serializable - - - - Serializable - - - - Constants - - const - int - MongoDB\Driver\ReadPreference::RP_PRIMARY - 1 - - - const - int - MongoDB\Driver\ReadPreference::RP_PRIMARY_PREFERRED - 5 - - - const - int - MongoDB\Driver\ReadPreference::RP_SECONDARY - 2 - - - const - int - MongoDB\Driver\ReadPreference::RP_SECONDARY_PREFERRED - 6 - - - const - int - MongoDB\Driver\ReadPreference::RP_NEAREST - 10 - - - const - string - MongoDB\Driver\ReadPreference::PRIMARY - primary - - - const - string - MongoDB\Driver\ReadPreference::PRIMARY_PREFERRED - primaryPreferred - - - const - string - MongoDB\Driver\ReadPreference::SECONDARY - secondary - - - const - string - MongoDB\Driver\ReadPreference::SECONDARY_PREFERRED - secondaryPreferred - - - const - string - MongoDB\Driver\ReadPreference::NEAREST - nearest - - - const - int - MongoDB\Driver\ReadPreference::NO_MAX_STALENESS - -1 - - - const - int - MongoDB\Driver\ReadPreference::SMALLEST_MAX_STALENESS_SECONDS - 90 - - - &Methods; - - - - -
- - -
- &reftitle.constants; - - - - MongoDB\Driver\ReadPreference::RP_PRIMARY - - - All operations read from the current replica set primary. This is the - default read preference for MongoDB. - - - - - - MongoDB\Driver\ReadPreference::RP_PRIMARY_PREFERRED - - - In most situations, operations read from the primary but if it is - unavailable, operations read from secondary members. - - - - - - MongoDB\Driver\ReadPreference::RP_SECONDARY - - - All operations read from the secondary members of the replica set. - - - - - - MongoDB\Driver\ReadPreference::RP_SECONDARY_PREFERRED - - - In most situations, operations read from secondary members but if no - secondary members are available, operations read from the primary. - - - - - - MongoDB\Driver\ReadPreference::RP_NEAREST - - - Operations read from member of the replica set with the least network - latency, irrespective of the member's type. - - - - - - MongoDB\Driver\ReadPreference::PRIMARY - - - All operations read from the current replica set primary. This is the - default read preference for MongoDB. - - - - - - MongoDB\Driver\ReadPreference::PRIMARY_PREFERRED - - - In most situations, operations read from the primary but if it is - unavailable, operations read from secondary members. - - - - - - MongoDB\Driver\ReadPreference::SECONDARY - - - All operations read from the secondary members of the replica set. - - - - - - MongoDB\Driver\ReadPreference::SECONDARY_PREFERRED - - - In most situations, operations read from secondary members but if no - secondary members are available, operations read from the primary. - - - - - - MongoDB\Driver\ReadPreference::NEAREST - - - Operations read from member of the replica set with the least network - latency, irrespective of the member's type. - - - - - - MongoDB\Driver\ReadPreference::NO_MAX_STALENESS - - - The default value for the "maxStalenessSeconds" - option is to specify no limit on maximum staleness, which means that the - driver will not consider a secondary's lag when choosing where to - direct a read operation. - - - - - - MongoDB\Driver\ReadPreference::SMALLEST_MAX_STALENESS_SECONDS - - - The minimum value for the "maxStalenessSeconds" option - is 90 seconds. The driver estimates secondaries' staleness by - periodically checking the latest write date of each replica set member. - Since these checks are infrequent, the staleness estimate is coarse. - Thus, the driver cannot enforce a max staleness value of less than 90 - seconds. - - - - - -
- - -
- &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 1.7.0 - - - Added the - MongoDB\Driver\ReadPreference::PRIMARY, - MongoDB\Driver\ReadPreference::PRIMARY_PREFERRED, - MongoDB\Driver\ReadPreference::SECONDARY, - MongoDB\Driver\ReadPreference::SECONDARY_PREFERRED, - MongoDB\Driver\ReadPreference::NEAREST constants. - - - Implements Serializable. - - - - - PECL mongodb 1.2.0 - - - Added the - MongoDB\Driver\ReadPreference::NO_MAX_STALENESS - and - MongoDB\Driver\ReadPreference::SMALLEST_MAX_STALENESS_SECONDS - constants. - - - Implements MongoDB\BSON\Serializable. - - - - - - - -
- - - - &reference.mongodb.mongodb.driver.entities.readpreference; - - - - diff --git a/reference/mongodb/mongodb/driver/readpreference/bsonserialize.xml b/reference/mongodb/mongodb/driver/readpreference/bsonserialize.xml deleted file mode 100644 index f445edc0f..000000000 --- a/reference/mongodb/mongodb/driver/readpreference/bsonserialize.xml +++ /dev/null @@ -1,181 +0,0 @@ - - - - - - MongoDB\Driver\ReadPreference::bsonSerialize - Returns an object for BSON serialization - - - - &reftitle.description; - - final public objectMongoDB\Driver\ReadPreference::bsonSerialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an object for serializing the ReadPreference as BSON. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\ReadPreference::bsonSerialize</function> with primary read preference - -bsonSerialize()); - -echo "\n", MongoDB\BSON\toJSON(MongoDB\BSON\fromPHP($rp)); - -?> -]]> - - &example.outputs.similar; - - - string(7) "primary" -} - -{ "mode" : "primary" } -]]> - - - - <function>MongoDB\Driver\ReadPreference::bsonSerialize</function> with secondary read preference and tag sets - - 'ny'], - ['dc' => 'sf', 'use' => 'reporting'], - [] - ] -); -var_dump($rp->bsonSerialize()); - -echo "\n", MongoDB\BSON\toJSON(MongoDB\BSON\fromPHP($rp)); - -?> -]]> - - &example.outputs.similar; - - - string(9) "secondary" - ["tags"]=> - array(3) { - [0]=> - object(stdClass)#1 (1) { - ["dc"]=> - string(2) "ny" - } - [1]=> - object(stdClass)#5 (2) { - ["dc"]=> - string(2) "sf" - ["use"]=> - string(9) "reporting" - } - [2]=> - object(stdClass)#4 (0) { - } - } -} - -{ "mode" : "secondary", "tags" : [ { "dc" : "ny" }, { "dc" : "sf", "use" : "reporting" }, { } ] } -]]> - - - - <function>MongoDB\Driver\ReadPreference::bsonSerialize</function> with secondary read preference and max staleness - - 120] -); -var_dump($rp->bsonSerialize()); - -echo "\n", MongoDB\BSON\toJSON(MongoDB\BSON\fromPHP($rp)); - -?> -]]> - - &example.outputs.similar; - - - string(9) "secondary" - ["maxStalenessSeconds"]=> - int(120) -} - -{ "mode" : "secondary", "maxStalenessSeconds" : 120 } -]]> - - - - - - - &reftitle.seealso; - - MongoDB\BSON\Serializable::bsonSerialize - Read Preference reference - - - - - - diff --git a/reference/mongodb/mongodb/driver/readpreference/construct.xml b/reference/mongodb/mongodb/driver/readpreference/construct.xml deleted file mode 100644 index a156036ea..000000000 --- a/reference/mongodb/mongodb/driver/readpreference/construct.xml +++ /dev/null @@ -1,329 +0,0 @@ - - - - - - MongoDB\Driver\ReadPreference::__construct - Create a new ReadPreference - - - - &reftitle.description; - - final public MongoDB\Driver\ReadPreference::__construct - stringintmode - arraytagSets&null; - arrayoptionsarray() - - - Constructs a new MongoDB\Driver\ReadPreference, which - is an immutable value object. - - - - - &reftitle.parameters; - - - mode - - - - Read preference mode - - - - Value - Description - - - - - MongoDB\Driver\ReadPreference::RP_PRIMARY or "primary" - - - All operations read from the current replica set primary. This is - the default read preference for MongoDB. - - - - - MongoDB\Driver\ReadPreference::RP_PRIMARY_PREFERRED or "primaryPreferred" - - - In most situations, operations read from the primary but if it is - unavailable, operations read from secondary members. - - - - - MongoDB\Driver\ReadPreference::RP_SECONDARY or "secondary" - - - All operations read from the secondary members of the replica set. - - - - - MongoDB\Driver\ReadPreference::RP_SECONDARY_PREFERRED or "secondaryPreferred" - - - In most situations, operations read from secondary members but if no - secondary members are available, operations read from the primary. - - - - - MongoDB\Driver\ReadPreference::RP_NEAREST or "nearest" - - - Operations read from member of the replica set with the least - network latency, irrespective of the member's type. - - - - - -
- - - - - tagSets - - - Tag sets allow you to target read operations to specific members of a - replica set. This parameter should be an array of associative arrays, each - of which contain zero or more key/value pairs. When selecting a server for - a read operation, the driver attempt to select a node having all tags in a - set (i.e. the associative array of key/value pairs). If selection fails, - the driver will attempt subsequent sets. An empty tag set - (array()) will match any node and may be used as a - fallback. - - - Tags are not compatible with the - MongoDB\Driver\ReadPreference::RP_PRIMARY mode and, - in general, only apply when selecting a secondary member of a set for a - read operation. However, the - MongoDB\Driver\ReadPreference::RP_NEAREST mode, when - combined with a tag set, selects the matching member with the lowest - network latency. This member may be a primary or secondary. - - - - - options - - - - options - - - - Option - Type - Description - - - - - hedge - objectarray - - Specifies whether to use hedged reads, which are supported by MongoDB 4.4+ for sharded queries. - - Server hedged reads are available for all non-primary read preferences - and are enabled by default when using the "nearest" - mode. This option allows explicitly enabling server hedged reads for - non-primary read preferences by specifying - ['enabled' => true], or explicitly disabling - server hedged reads for the "nearest" read - preference by specifying ['enabled' => false]. - - - - - maxStalenessSeconds - int - - - Specifies a maximum replication lag, or "staleness", for reads from - secondaries. When a secondary's estimated staleness exceeds - this value, the driver stops using it for read operations. - - - If specified, the max staleness must be a signed 32-bit integer - greater than or equal to - MongoDB\Driver\ReadPreference::SMALLEST_MAX_STALENESS_SECONDS. - - - Defaults to - MongoDB\Driver\ReadPreference::NO_MAX_STALENESS, - which means that the driver will not consider a secondary's lag - when choosing where to direct a read operation. - - - This option is not compatible with the - MongoDB\Driver\ReadPreference::RP_PRIMARY mode. - Specifying a max staleness also requires all MongoDB instances in - the deployment to be using MongoDB 3.4+. An exception will be thrown - at execution time if any MongoDB instances in the deployment are of - an older server version. - - - - - -
- - - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\InvalidArgumentException if mode is invalid. - Throws MongoDB\Driver\Exception\InvalidArgumentException if tagSets is provided for a primary read preference or is malformed (i.e. not an array of zero or more documents). - Throws MongoDB\Driver\Exception\InvalidArgumentException if the "maxStalenessSeconds" option is provided for a primary read preference or is out of range. - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 1.8.0 - - Added the "hedge" option. - - - - PECL mongodb 1.3.0 - - - The mode argument now accepts a string value, - which is consistent with the "readPreference" URI - option for MongoDB\Driver\Manager::__construct. - - - - - PECL mongodb 1.2.0 - - - Added a third options argument, which supports - the "maxStalenessSeconds" option. - - - - - - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\ReadPreference::__construct</function> example - - 'ny']])); - -/* Require a secondary node whose replication lag is within two minutes of the primary */ -var_dump(new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::RP_SECONDARY, null, ['maxStalenessSeconds' => 120])); - -/* Explicitly enable server hedged reads */ -var_dump(new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::RP_SECONDARY, null, ['hedge' => ['enabled' => true]])); - -?> -]]> - - &example.outputs; - - - string(18) "secondaryPreferred" -} -object(MongoDB\Driver\ReadPreference)#1 (2) { - ["mode"]=> - string(7) "nearest" - ["tags"]=> - array(1) { - [0]=> - object(stdClass)#2 (1) { - ["dc"]=> - string(2) "ny" - } - } -} -object(MongoDB\Driver\ReadPreference)#1 (2) { - ["mode"]=> - string(9) "secondary" - ["maxStalenessSeconds"]=> - int(120) -} -object(MongoDB\Driver\ReadPreference)#1 (2) { - ["mode"]=> - string(9) "secondary" - ["hedge"]=> - object(stdClass)#1 (1) { - ["enabled"]=> - bool(true) - } -} -]]> - - - - - - - &reftitle.seealso; - - Read Preference reference - - - - - - diff --git a/reference/mongodb/mongodb/driver/readpreference/gethedge.xml b/reference/mongodb/mongodb/driver/readpreference/gethedge.xml deleted file mode 100644 index 60ae07207..000000000 --- a/reference/mongodb/mongodb/driver/readpreference/gethedge.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - MongoDB\Driver\ReadPreference::getHedge - Returns the ReadPreference's "hedge" option - - - - &reftitle.description; - - final public objectnullMongoDB\Driver\ReadPreference::getHedge - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the ReadPreference's "hedge" option. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.seealso; - - Read Preference reference - - - - - - diff --git a/reference/mongodb/mongodb/driver/readpreference/getmaxstalenessseconds.xml b/reference/mongodb/mongodb/driver/readpreference/getmaxstalenessseconds.xml deleted file mode 100644 index a03e35547..000000000 --- a/reference/mongodb/mongodb/driver/readpreference/getmaxstalenessseconds.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - MongoDB\Driver\ReadPreference::getMaxStalenessSeconds - Returns the ReadPreference's "maxStalenessSeconds" option - - - - &reftitle.description; - - final public intMongoDB\Driver\ReadPreference::getMaxStalenessSeconds - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the ReadPreference's "maxStalenessSeconds" option. If no max - staleness has been specified, - MongoDB\Driver\ReadPreference::NO_MAX_STALENESS will be - returned. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\ReadPreference::getMaxStalenessSeconds</function> example - -getMaxStalenessSeconds()); - -$rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::RP_SECONDARY, null, [ - 'maxStalenessSeconds' => MongoDB\Driver\ReadPreference::NO_MAX_STALENESS, -]); -var_dump($rp->getMaxStalenessSeconds()); - -$rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::RP_SECONDARY, null, [ - 'maxStalenessSeconds' => MongoDB\Driver\ReadPreference::SMALLEST_MAX_STALENESS_SECONDS, -]); -var_dump($rp->getMaxStalenessSeconds()); - -$rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::RP_SECONDARY, null, [ - 'maxStalenessSeconds' => 1000, -]); -var_dump($rp->getMaxStalenessSeconds()); - -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - Read Preference reference - - - - - - diff --git a/reference/mongodb/mongodb/driver/readpreference/getmode.xml b/reference/mongodb/mongodb/driver/readpreference/getmode.xml deleted file mode 100644 index fd3aefdcb..000000000 --- a/reference/mongodb/mongodb/driver/readpreference/getmode.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - MongoDB\Driver\ReadPreference::getMode - Returns the ReadPreference's "mode" option - - - - &reftitle.description; - - final public intMongoDB\Driver\ReadPreference::getMode - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the ReadPreference's "mode" option. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\ReadPreference::getMode</function> example - -getMode()); - -$rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::RP_PRIMARY_PREFERRED); -var_dump($rp->getMode()); - -$rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::RP_SECONDARY); -var_dump($rp->getMode()); - -$rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::RP_SECONDARY_PREFERRED); -var_dump($rp->getMode()); - -$rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::RP_NEAREST); -var_dump($rp->getMode()); - -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\ReadPreference::getModeString - Read Preference reference - - - - - - diff --git a/reference/mongodb/mongodb/driver/readpreference/getmodestring.xml b/reference/mongodb/mongodb/driver/readpreference/getmodestring.xml deleted file mode 100644 index 5da58e612..000000000 --- a/reference/mongodb/mongodb/driver/readpreference/getmodestring.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - MongoDB\Driver\ReadPreference::getModeString - Returns the ReadPreference's "mode" option as a string - - - - &reftitle.description; - - final public stringMongoDB\Driver\ReadPreference::getModeString - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the ReadPreference's "mode" option as a string. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\ReadPreference::getModeString</function> example - -getModeString()); - -$rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::PRIMARY_PREFERRED); -var_dump($rp->getModeString()); - -$rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::SECONDARY); -var_dump($rp->getModeString()); - -$rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::SECONDARY_PREFERRED); -var_dump($rp->getModeString()); - -$rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::NEAREST); -var_dump($rp->getModeString()); - -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\ReadPreference::getMode - Read Preference reference - - - - - - diff --git a/reference/mongodb/mongodb/driver/readpreference/gettagsets.xml b/reference/mongodb/mongodb/driver/readpreference/gettagsets.xml deleted file mode 100644 index b4b866445..000000000 --- a/reference/mongodb/mongodb/driver/readpreference/gettagsets.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - MongoDB\Driver\ReadPreference::getTagSets - Returns the ReadPreference's "tagSets" option - - - - &reftitle.description; - - final public arrayMongoDB\Driver\ReadPreference::getTagSets - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the ReadPreference's "tagSets" option. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\ReadPreference::getTagSets</function> example - -getTagSets()); - -$rp = new MongoDB\Driver\ReadPreference($mode, []); -var_dump($rp->getTagSets()); - -/* Prefer a node in New York, but fall back to any available node. */ -$rp = new MongoDB\Driver\ReadPreference($mode, [['dc' => 'ny']]); -var_dump($rp->getTagSets()); - -/* Prefer a node in the New York, followed by a node in San Francisco that is - labeled for reporting usage, and finally fall back to any available node. */ -$rp = new MongoDB\Driver\ReadPreference($mode, [ - ['dc' => 'ny'], - ['dc' => 'sf', 'use' => 'reporting'], - [], -]); -var_dump($rp->getTagSets()); - -?> -]]> - - &example.outputs; - - - array(1) { - ["dc"]=> - string(2) "ny" - } - [1]=> - array(0) { - } -} -array(3) { - [0]=> - array(1) { - ["dc"]=> - string(2) "ny" - } - [1]=> - array(2) { - ["dc"]=> - string(2) "sf" - ["use"]=> - string(9) "reporting" - } - [2]=> - array(0) { - } -} -]]> - - - - - - - &reftitle.seealso; - - Read Preference reference - - - - - - diff --git a/reference/mongodb/mongodb/driver/readpreference/serialize.xml b/reference/mongodb/mongodb/driver/readpreference/serialize.xml deleted file mode 100644 index 5e0746084..000000000 --- a/reference/mongodb/mongodb/driver/readpreference/serialize.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - MongoDB\Driver\ReadPreference::serialize - Serialize a ReadPreference - - - - &reftitle.description; - - final public stringMongoDB\Driver\ReadPreference::serialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the serialized representation of the - MongoDB\Driver\ReadPreference. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\ReadPreference::unserialize - serialize - Serializing Objects - - - - - - diff --git a/reference/mongodb/mongodb/driver/readpreference/unserialize.xml b/reference/mongodb/mongodb/driver/readpreference/unserialize.xml deleted file mode 100644 index acfa81b60..000000000 --- a/reference/mongodb/mongodb/driver/readpreference/unserialize.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - MongoDB\Driver\ReadPreference::unserialize - Unserialize a ReadPreference - - - - &reftitle.description; - - final public voidMongoDB\Driver\ReadPreference::unserialize - stringserialized - - - - - &reftitle.parameters; - - - - serialized - - - The serialized MongoDB\Driver\ReadPreference. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\UnexpectedValueException if the properties cannot be unserialized (i.e. serialized was malformed). - Throws MongoDB\Driver\Exception\InvalidArgumentException if the properties are invalid (e.g. missing fields or invalid values). - - - - - &reftitle.seealso; - - MongoDB\Driver\ReadPreference::serialize - unserialize - Serializing Objects - - - - - - diff --git a/reference/mongodb/mongodb/driver/server.xml b/reference/mongodb/mongodb/driver/server.xml deleted file mode 100644 index 0d68c2f29..000000000 --- a/reference/mongodb/mongodb/driver/server.xml +++ /dev/null @@ -1,239 +0,0 @@ - - - - - - The MongoDB\Driver\Server class - MongoDB\Driver\Server - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - MongoDB\Driver\Server - - - - final - - MongoDB\Driver\Server - - - - Constants - - const - int - MongoDB\Driver\Server::TYPE_UNKNOWN - 0 - - - const - int - MongoDB\Driver\Server::TYPE_STANDALONE - 1 - - - const - int - MongoDB\Driver\Server::TYPE_MONGOS - 2 - - - const - int - MongoDB\Driver\Server::TYPE_POSSIBLE_PRIMARY - 3 - - - const - int - MongoDB\Driver\Server::TYPE_RS_PRIMARY - 4 - - - const - int - MongoDB\Driver\Server::TYPE_RS_SECONDARY - 5 - - - const - int - MongoDB\Driver\Server::TYPE_RS_ARBITER - 6 - - - const - int - MongoDB\Driver\Server::TYPE_RS_OTHER - 7 - - - const - int - MongoDB\Driver\Server::TYPE_RS_GHOST - 8 - - - const - int - MongoDB\Driver\Server::TYPE_LOAD_BALANCER - 9 - - - &Methods; - - - - -
- - -
- &reftitle.constants; - - - - MongoDB\Driver\Server::TYPE_UNKNOWN - - Unknown server type, returned by MongoDB\Driver\Server::getType. - - - - - MongoDB\Driver\Server::TYPE_STANDALONE - - Standalone server type, returned by MongoDB\Driver\Server::getType. - - - - - MongoDB\Driver\Server::TYPE_MONGOS - - Mongos server type, returned by MongoDB\Driver\Server::getType. - - - - - MongoDB\Driver\Server::TYPE_POSSIBLE_PRIMARY - - Replica set possible primary server type, returned by MongoDB\Driver\Server::getType. - A server may be identified as a possible primary if it has not yet been checked but another memory of the replica set thinks it is the primary. - - - - - MongoDB\Driver\Server::TYPE_RS_PRIMARY - - Replica set primary server type, returned by MongoDB\Driver\Server::getType. - - - - - MongoDB\Driver\Server::TYPE_RS_SECONDARY - - Replica set secondary server type, returned by MongoDB\Driver\Server::getType. - - - - - MongoDB\Driver\Server::TYPE_RS_ARBITER - - Replica set arbiter server type, returned by MongoDB\Driver\Server::getType. - - - - - MongoDB\Driver\Server::TYPE_RS_OTHER - - Replica set other server type, returned by MongoDB\Driver\Server::getType. - Such servers may be hidden, starting up, or recovering. They cannot be queried, but their hosts lists are useful for discovering the current replica set configuration. - - - - - MongoDB\Driver\Server::TYPE_RS_GHOST - - Replica set ghost server type, returned by MongoDB\Driver\Server::getType. - Servers may be identified as such in at least three situations: briefly during server startup; in an uninitialized replica set; or when the server is shunned (i.e. removed from the replica set config). They cannot be queried, nor can their host list be used to discover the current replica set configuration; however, the client may monitor this server in hope that it transitions to a more useful state. - - - - - MongoDB\Driver\Server::TYPE_LOAD_BALANCER - - Load balancer server type, returned by MongoDB\Driver\Server::getType. - - - - -
- - -
- &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 1.11.0 - - - Added the - MongoDB\Driver\Server::TYPE_LOAD_BALANCER - constant. - - - - - - - -
- - - - &reference.mongodb.mongodb.driver.entities.server; - - - - diff --git a/reference/mongodb/mongodb/driver/server/construct.xml b/reference/mongodb/mongodb/driver/server/construct.xml deleted file mode 100644 index 37308e095..000000000 --- a/reference/mongodb/mongodb/driver/server/construct.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - MongoDB\Driver\Server::__construct - Create a new Server (not used) - - - - &reftitle.description; - - final private MongoDB\Driver\Server::__construct - - - - MongoDB\Driver\Server objects are created internally - by MongoDB\Driver\Manager when a database connection - is established and may be returned by - MongoDB\Driver\Manager::getServers and - MongoDB\Driver\Manager::selectServer. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::getServers - MongoDB\Driver\Manager::selectServer - - - - - - diff --git a/reference/mongodb/mongodb/driver/server/executebulkwrite.xml b/reference/mongodb/mongodb/driver/server/executebulkwrite.xml deleted file mode 100644 index 4cba2fe5d..000000000 --- a/reference/mongodb/mongodb/driver/server/executebulkwrite.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - - MongoDB\Driver\Server::executeBulkWrite - Execute one or more write operations on this server - - - - &reftitle.description; - - final public MongoDB\Driver\WriteResultMongoDB\Driver\Server::executeBulkWrite - stringnamespace - MongoDB\Driver\BulkWritebulk - arrayoptionsarray() - - - Executes one or more write operations on this server. - - - A MongoDB\Driver\BulkWrite can be constructed with - one or more write operations of varying types (e.g. updates, deletes, and - inserts). The driver will attempt to send operations of the same type to the - server in as few requests as possible to optimize round trips. - - - - - &reftitle.parameters; - - &mongodb.parameter.namespace; - &mongodb.parameter.bulkwrite; - - options - - - - options - - - - Option - Type - Description - - - - &mongodb.option.session; - &mongodb.option.writeConcern; - - -
- - - - - - - - &reftitle.returnvalues; - &mongodb.returns.writeresult; - - - - &reftitle.errors; - - Throws MongoDB\Driver\Exception\InvalidArgumentException if bulk does not contain any write operations. - Throws MongoDB\Driver\Exception\InvalidArgumentException if bulk has already been executed. MongoDB\Driver\BulkWrite objects may not be executed multiple times. - &mongodb.throws.session-unacknowledged; - &mongodb.throws.std; - &mongodb.throws.bulkwriteexception; - Throws MongoDB\Driver\Exception\RuntimeException on other errors. - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 1.4.4 - - MongoDB\Driver\Exception\InvalidArgumentException - will be thrown if the "session" option is used in - combination with an unacknowledged write concern. - - - - PECL mongodb 1.4.0 - - The third parameter is now an options array. - For backwards compatibility, this paramater will still accept a - MongoDB\Driver\WriteConcern object. - - - - PECL mongodb 1.3.0 - - MongoDB\Driver\Exception\InvalidArgumentException - is now thrown if bulk does not contain any write - operations. Previously, a - MongoDB\Driver\Exception\BulkWriteException was - thrown. - - - - - - - - - - &reftitle.notes; - &mongodb.note.server.write; - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWrite - MongoDB\Driver\WriteResult - MongoDB\Driver\WriteConcern - MongoDB\Driver\Manager::executeBulkWrite - - - - - - diff --git a/reference/mongodb/mongodb/driver/server/executecommand.xml b/reference/mongodb/mongodb/driver/server/executecommand.xml deleted file mode 100644 index 8e703553c..000000000 --- a/reference/mongodb/mongodb/driver/server/executecommand.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - - - MongoDB\Driver\Server::executeCommand - Execute a database command on this server - - - - &reftitle.description; - - final public MongoDB\Driver\CursorMongoDB\Driver\Server::executeCommand - stringdb - MongoDB\Driver\Commandcommand - arrayoptionsarray() - - - Executes the command on this server. - - - This method applies no special logic to the command. Although this method - accepts "readConcern" and - "writeConcern" options, which will be incorporated into - the command document, those options will not default to corresponding values - from the MongoDB - Connection URI nor will the MongoDB server version be taken into - account. Users are therefore encouraged to use specific read and/or write - command methods if possible. - - &mongodb.note.server.readpreference; - - - - &reftitle.parameters; - - &mongodb.parameter.db; - &mongodb.parameter.command; - - options - - - - options - - - - Option - Type - Description - - - - &mongodb.option.readConcern; - &mongodb.option.readPreference; - &mongodb.option.session; - &mongodb.option.writeConcern; - - -
- - &mongodb.option.transactionReadWriteConcern; - - - - - - - &reftitle.returnvalues; - &mongodb.returns.cursor; - - - - &reftitle.errors; - - &mongodb.throws.session-readwriteconcern; - &mongodb.throws.session-unacknowledged; - &mongodb.throws.std; - Throws MongoDB\Driver\Exception\RuntimeException on other errors (e.g. invalid command, issuing a write command to a secondary). - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 1.4.4 - - MongoDB\Driver\Exception\InvalidArgumentException - will be thrown if the "session" option is used in - combination with an unacknowledged write concern. - - - - PECL mongodb 1.4.0 - - The third parameter is now an options array. - For backwards compatibility, this paramater will still accept a - MongoDB\Driver\ReadPreference object. - - - - - - - - - - &reftitle.notes; - &mongodb.note.server.write; - - - - &reftitle.seealso; - - MongoDB\Driver\Command - MongoDB\Driver\Cursor - MongoDB\Driver\Server::executeReadCommand - MongoDB\Driver\Server::executeReadWriteCommand - MongoDB\Driver\Server::executeWriteCommand - MongoDB\Driver\Manager::executeCommand - - - - - - diff --git a/reference/mongodb/mongodb/driver/server/executequery.xml b/reference/mongodb/mongodb/driver/server/executequery.xml deleted file mode 100644 index 2b5b6c51e..000000000 --- a/reference/mongodb/mongodb/driver/server/executequery.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - MongoDB\Driver\Server::executeQuery - Execute a database query on this server - - - - &reftitle.description; - - final public MongoDB\Driver\CursorMongoDB\Driver\Server::executeQuery - stringnamespace - MongoDB\Driver\Queryquery - arrayoptionsarray() - - - Executes the query on this server. - - - - The "readPreference" option does not control the server - to which the driver issues the operation; it will always be executed on - this server object. Instead, it may be used when issuing the operation to a - secondary (from a replica set connection, not standalone) or mongos node to - ensure that the driver sets the wire protocol accordingly or adds the read - preference to the operation, respectively. - - - - - - &reftitle.parameters; - - &mongodb.parameter.namespace; - &mongodb.parameter.query; - - options - - - - options - - - - Option - Type - Description - - - - &mongodb.option.readPreference; - &mongodb.option.session; - - -
- - - - - - - - &reftitle.returnvalues; - &mongodb.returns.cursor; - - - - &reftitle.errors; - - &mongodb.throws.std; - Throws MongoDB\Driver\Exception\RuntimeException on other errors (e.g. invalid query operators). - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 1.4.0 - - The third parameter is now an options array. - For backwards compatibility, this paramater will still accept a - MongoDB\Driver\ReadPreference object. - - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Cursor - MongoDB\Driver\Query - MongoDB\Driver\ReadPreference - MongoDB\Driver\Manager::executeQuery - - - - - - diff --git a/reference/mongodb/mongodb/driver/server/executereadcommand.xml b/reference/mongodb/mongodb/driver/server/executereadcommand.xml deleted file mode 100644 index feeaf237f..000000000 --- a/reference/mongodb/mongodb/driver/server/executereadcommand.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - MongoDB\Driver\Server::executeReadCommand - Execute a database command that reads on this server - - - - &reftitle.description; - - final public MongoDB\Driver\CursorMongoDB\Driver\Server::executeReadCommand - stringdb - MongoDB\Driver\Commandcommand - arrayoptionsarray() - - - Executes the command on this server. - - - This method will apply logic that is specific to commands that read (e.g. - count) - and take the MongoDB server version into account. The - "readConcern" option will default to the corresponding - value from the MongoDB - Connection URI. - - &mongodb.note.server.readpreference; - - - - &reftitle.parameters; - - &mongodb.parameter.db; - &mongodb.parameter.command; - - options - - - - options - - - - Option - Type - Description - - - - &mongodb.option.readConcern; - &mongodb.option.readPreference; - &mongodb.option.session; - - -
- - &mongodb.option.transactionReadWriteConcern; - - - - - - - &reftitle.returnvalues; - &mongodb.returns.cursor; - - - - &reftitle.errors; - - &mongodb.throws.session-readwriteconcern; - &mongodb.throws.std; - Throws MongoDB\Driver\Exception\RuntimeException on other errors (e.g. invalid command). - - - - - &reftitle.seealso; - - MongoDB\Driver\Command - MongoDB\Driver\Cursor - MongoDB\Driver\Server::executeCommand - MongoDB\Driver\Server::executeReadWriteCommand - MongoDB\Driver\Server::executeWriteCommand - MongoDB\Driver\Manager::executeReadCommand - - - - - - diff --git a/reference/mongodb/mongodb/driver/server/executereadwritecommand.xml b/reference/mongodb/mongodb/driver/server/executereadwritecommand.xml deleted file mode 100644 index 192e95ac3..000000000 --- a/reference/mongodb/mongodb/driver/server/executereadwritecommand.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - MongoDB\Driver\Server::executeReadWriteCommand - Execute a database command that reads and writes on this server - - - - &reftitle.description; - - final public MongoDB\Driver\CursorMongoDB\Driver\Server::executeReadWriteCommand - stringdb - MongoDB\Driver\Commandcommand - arrayoptionsarray() - - - Executes the command on this server. - - - This method will apply logic that is specific to commands that read and write - (e.g. - aggregate) - and take the MongoDB server version into account. The - "readConcern" and "writeConcern" - options will default to the corresponding values from the - MongoDB Connection - URI. - - - - - &reftitle.parameters; - - &mongodb.parameter.db; - &mongodb.parameter.command; - - options - - - - options - - - - Option - Type - Description - - - - &mongodb.option.readConcern; - &mongodb.option.session; - &mongodb.option.writeConcern; - - -
- - &mongodb.option.transactionReadWriteConcern; - - - - - - - &reftitle.returnvalues; - &mongodb.returns.cursor; - - - - &reftitle.errors; - - &mongodb.throws.session-readwriteconcern; - &mongodb.throws.session-unacknowledged; - &mongodb.throws.std; - Throws MongoDB\Driver\Exception\RuntimeException on other errors (e.g. invalid command). - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 1.4.4 - - MongoDB\Driver\Exception\InvalidArgumentException - will be thrown if the "session" option is used in - combination with an unacknowledged write concern. - - - - - - - - - - &reftitle.notes; - &mongodb.note.server.write; - - - - &reftitle.seealso; - - MongoDB\Driver\Command - MongoDB\Driver\Cursor - MongoDB\Driver\Server::executeCommand - MongoDB\Driver\Server::executeReadCommand - MongoDB\Driver\Server::executeWriteCommand - MongoDB\Driver\Manager::executeReadWriteCommand - - - - - - diff --git a/reference/mongodb/mongodb/driver/server/executewritecommand.xml b/reference/mongodb/mongodb/driver/server/executewritecommand.xml deleted file mode 100644 index 38f655b8d..000000000 --- a/reference/mongodb/mongodb/driver/server/executewritecommand.xml +++ /dev/null @@ -1,153 +0,0 @@ - - - - - - MongoDB\Driver\Server::executeWriteCommand - Execute a database command that writes on this server - - - - &reftitle.description; - - final public MongoDB\Driver\CursorMongoDB\Driver\Server::executeWriteCommand - stringdb - MongoDB\Driver\Commandcommand - arrayoptionsarray() - - - Executes the command on this server. - - - This method will apply logic that is specific to commands that write (e.g. - drop) and - take the MongoDB server version into account. The - "writeConcern" option will default to the corresponding - value from the MongoDB - Connection URI. - - - - This method is not intended to be used to execute - insert, - update, - or delete - commands. Users are encouraged to use - MongoDB\Driver\Server::executeBulkWrite for those - commands. - - - - - - &reftitle.parameters; - - &mongodb.parameter.db; - &mongodb.parameter.command; - - options - - - - options - - - - Option - Type - Description - - - - &mongodb.option.session; - &mongodb.option.writeConcern; - - -
- - &mongodb.option.transactionReadWriteConcern; - - - - - - - &reftitle.returnvalues; - &mongodb.returns.cursor; - - - - &reftitle.errors; - - &mongodb.throws.session-readwriteconcern; - &mongodb.throws.session-unacknowledged; - &mongodb.throws.std; - Throws MongoDB\Driver\Exception\RuntimeException on other errors (e.g. invalid command). - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 1.4.4 - - MongoDB\Driver\Exception\InvalidArgumentException - will be thrown if the "session" option is used in - combination with an unacknowledged write concern. - - - - - - - - - - &reftitle.notes; - &mongodb.note.server.write; - - - - &reftitle.seealso; - - MongoDB\Driver\Command - MongoDB\Driver\Cursor - MongoDB\Driver\Server::executeCommand - MongoDB\Driver\Server::executeReadCommand - MongoDB\Driver\Server::executeReadWriteCommand - MongoDB\Driver\Manager::executeWriteCommand - - - - - - diff --git a/reference/mongodb/mongodb/driver/server/gethost.xml b/reference/mongodb/mongodb/driver/server/gethost.xml deleted file mode 100644 index 20e86df1e..000000000 --- a/reference/mongodb/mongodb/driver/server/gethost.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - MongoDB\Driver\Server::getHost - Returns the hostname of this server - - - - &reftitle.description; - - final public stringMongoDB\Driver\Server::getHost - - - - Returns the hostname of this server. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the hostname of this server. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\Server::getHost</function> example - -selectServer($rp); - -var_dump($server->getHost()); - -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Server::getInfo - MongoDB\Driver\ServerDescription::getHost - - - - - - diff --git a/reference/mongodb/mongodb/driver/server/getinfo.xml b/reference/mongodb/mongodb/driver/server/getinfo.xml deleted file mode 100644 index a5fa549b0..000000000 --- a/reference/mongodb/mongodb/driver/server/getinfo.xml +++ /dev/null @@ -1,262 +0,0 @@ - - - - - - MongoDB\Driver\Server::getInfo - Returns an array of information describing this server - - - - &reftitle.description; - - final public arrayMongoDB\Driver\Server::getInfo - - - - Returns an array of information describing the server. This array is derived - from the most recent - hello - command response obtained through - server monitoring. - - - - When the driver is connected to a load balancer, this method will return - the backing server's - hello - command response from the initial connection handshake. This is in contrast - to other methods (e.g. MongoDB\Driver\Server::getType), - which will return information about the load balancer itself. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an array of information describing this server. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\Server::getInfo</function> example - -selectServer($rp); - -var_dump($server->getInfo()); - -?> -]]> - - &example.outputs.similar; - - - bool(true) - ["topologyVersion"]=> - array(2) { - ["processId"]=> - object(MongoDB\BSON\ObjectId)#4 (1) { - ["oid"]=> - string(24) "617b6d696a3a89d2f77e6df0" - } - ["counter"]=> - int(6) - } - ["hosts"]=> - array(1) { - [0]=> - string(15) "localhost:27017" - } - ["setName"]=> - string(3) "rs0" - ["setVersion"]=> - int(1) - ["ismaster"]=> - bool(true) - ["secondary"]=> - bool(false) - ["primary"]=> - string(15) "localhost:27017" - ["me"]=> - string(15) "localhost:27017" - ["electionId"]=> - object(MongoDB\BSON\ObjectId)#5 (1) { - ["oid"]=> - string(24) "7fffffff0000000000000001" - } - ["lastWrite"]=> - array(4) { - ["opTime"]=> - array(2) { - ["ts"]=> - object(MongoDB\BSON\Timestamp)#6 (2) { - ["increment"]=> - string(1) "1" - ["timestamp"]=> - string(10) "1635478989" - } - ["t"]=> - int(1) - } - ["lastWriteDate"]=> - object(MongoDB\BSON\UTCDateTime)#7 (1) { - ["milliseconds"]=> - string(13) "1635478989000" - } - ["majorityOpTime"]=> - array(2) { - ["ts"]=> - object(MongoDB\BSON\Timestamp)#8 (2) { - ["increment"]=> - string(1) "1" - ["timestamp"]=> - string(10) "1635478989" - } - ["t"]=> - int(1) - } - ["majorityWriteDate"]=> - object(MongoDB\BSON\UTCDateTime)#9 (1) { - ["milliseconds"]=> - string(13) "1635478989000" - } - } - ["maxBsonObjectSize"]=> - int(16777216) - ["maxMessageSizeBytes"]=> - int(48000000) - ["maxWriteBatchSize"]=> - int(100000) - ["localTime"]=> - object(MongoDB\BSON\UTCDateTime)#10 (1) { - ["milliseconds"]=> - string(13) "1635478992136" - } - ["logicalSessionTimeoutMinutes"]=> - int(30) - ["connectionId"]=> - int(3) - ["minWireVersion"]=> - int(0) - ["maxWireVersion"]=> - int(13) - ["readOnly"]=> - bool(false) - ["ok"]=> - float(1) - ["$clusterTime"]=> - array(2) { - ["clusterTime"]=> - object(MongoDB\BSON\Timestamp)#11 (2) { - ["increment"]=> - string(1) "1" - ["timestamp"]=> - string(10) "1635478989" - } - ["signature"]=> - array(2) { - ["hash"]=> - object(MongoDB\BSON\Binary)#12 (2) { - ["data"]=> - string(20) "" - ["type"]=> - int(0) - } - ["keyId"]=> - int(0) - } - } - ["operationTime"]=> - object(MongoDB\BSON\Timestamp)#13 (2) { - ["increment"]=> - string(1) "1" - ["timestamp"]=> - string(10) "1635478989" - } -} -]]> - - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 1.11.0 - - When the driver is connected to a load balancer, this method returns - the backing server's hello command response from the - initial connection handshake. - - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\ServerDescription::getHelloResponse - hello command in the MongoDB manual - Server Discovery and Monitoring Specification - - - - - - diff --git a/reference/mongodb/mongodb/driver/server/getlatency.xml b/reference/mongodb/mongodb/driver/server/getlatency.xml deleted file mode 100644 index 8e13d734a..000000000 --- a/reference/mongodb/mongodb/driver/server/getlatency.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - MongoDB\Driver\Server::getLatency - Returns the latency of this server in milliseconds - - - - &reftitle.description; - - final public integernullMongoDB\Driver\Server::getLatency - - - - Returns the latency of this server in milliseconds. This is the client's - measured - round trip time - of a hello command. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the latency of this server in milliseconds, or &null; if no latency - has been measured (e.g. client is connected to a load balancer). - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 1.11.0 - - This method will return &null; if no latency has been measured. In - earlier versions, an integer was always returned and an unset value - might be reported as -1. - - - - - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\Server::getLatency</function> example - -selectServer($rp); - -var_dump($server->getLatency()); - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Server::getInfo - MongoDB\Driver\ServerDescription::getRoundTripTime - Server Discovery and Monitoring Specification - - - - - - diff --git a/reference/mongodb/mongodb/driver/server/getport.xml b/reference/mongodb/mongodb/driver/server/getport.xml deleted file mode 100644 index 15e1fe1bb..000000000 --- a/reference/mongodb/mongodb/driver/server/getport.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - MongoDB\Driver\Server::getPort - Returns the port on which this server is listening - - - - &reftitle.description; - - final public intMongoDB\Driver\Server::getPort - - - - Returns the port on which this server is listening. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the port on which this server is listening. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\Server::getPort</function> example - -selectServer($rp); - -var_dump($server->getPort()); - -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Server::getInfo - MongoDB\Driver\ServerDescription::getPort - - - - - - diff --git a/reference/mongodb/mongodb/driver/server/getserverdescription.xml b/reference/mongodb/mongodb/driver/server/getserverdescription.xml deleted file mode 100644 index 614548fd5..000000000 --- a/reference/mongodb/mongodb/driver/server/getserverdescription.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - MongoDB\Driver\Server::getServerDescription - Returns a ServerDescription for this server - - - - &reftitle.description; - - final public MongoDB\Driver\ServerDescriptionMongoDB\Driver\Server::getServerDescription - - - - Returns a MongoDB\Driver\ServerDescription for this - server. This is an immutable value object that will describe the server at - the time this method is called. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a MongoDB\Driver\ServerDescription for this - server. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/server/gettags.xml b/reference/mongodb/mongodb/driver/server/gettags.xml deleted file mode 100644 index 838d5667f..000000000 --- a/reference/mongodb/mongodb/driver/server/gettags.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - MongoDB\Driver\Server::getTags - Returns an array of tags describing this server in a replica set - - - - &reftitle.description; - - final public arrayMongoDB\Driver\Server::getTags - - - - Returns an array of - tags used to - describe this server in a replica set. The array will contain zero or more - string key and value pairs. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an array of tags used to describe this server in a - replica set. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.seealso; - - MongoDB\Driver\Server::getInfo - - - - - - diff --git a/reference/mongodb/mongodb/driver/server/gettype.xml b/reference/mongodb/mongodb/driver/server/gettype.xml deleted file mode 100644 index f45d9cbe1..000000000 --- a/reference/mongodb/mongodb/driver/server/gettype.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - MongoDB\Driver\Server::getType - Returns an integer denoting the type of this server - - - - &reftitle.description; - - final public intMongoDB\Driver\Server::getType - - - - Returns an int denoting the type of this server. The value - will correlate with a MongoDB\Driver\Server constant. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an int denoting the type of this server. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.seealso; - - MongoDB\Driver\Server::getInfo - MongoDB\Driver\ServerDescription::getType - - - - - - diff --git a/reference/mongodb/mongodb/driver/server/isarbiter.xml b/reference/mongodb/mongodb/driver/server/isarbiter.xml deleted file mode 100644 index b4f2253d4..000000000 --- a/reference/mongodb/mongodb/driver/server/isarbiter.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - MongoDB\Driver\Server::isArbiter - Checks if this server is an arbiter member of a replica set - - - - &reftitle.description; - - final public boolMongoDB\Driver\Server::isArbiter - - - - Returns whether this server is an - arbiter member - of a replica set. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; if this server is an arbiter member of a replica set, and - &false; otherwise. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.seealso; - - MongoDB\Driver\Server::getInfo - - - - - - diff --git a/reference/mongodb/mongodb/driver/server/ishidden.xml b/reference/mongodb/mongodb/driver/server/ishidden.xml deleted file mode 100644 index 7b9024be3..000000000 --- a/reference/mongodb/mongodb/driver/server/ishidden.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - MongoDB\Driver\Server::isHidden - Checks if this server is a hidden member of a replica set - - - - &reftitle.description; - - final public boolMongoDB\Driver\Server::isHidden - - - - Returns whether this server is a - hidden member - of a replica set. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; if this server is a hidden member of a replica set, and - &false; otherwise. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.seealso; - - MongoDB\Driver\Server::getInfo - - - - - - diff --git a/reference/mongodb/mongodb/driver/server/ispassive.xml b/reference/mongodb/mongodb/driver/server/ispassive.xml deleted file mode 100644 index d77ecb3d4..000000000 --- a/reference/mongodb/mongodb/driver/server/ispassive.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - MongoDB\Driver\Server::isPassive - Checks if this server is a passive member of a replica set - - - - &reftitle.description; - - final public boolMongoDB\Driver\Server::isPassive - - - - Returns whether this server is a - passive member - of a replica set (i.e. its priority is 0). - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; if this server is a passive member of a replica set, and - &false; otherwise. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.seealso; - - MongoDB\Driver\Server::getInfo - - - - - - diff --git a/reference/mongodb/mongodb/driver/server/isprimary.xml b/reference/mongodb/mongodb/driver/server/isprimary.xml deleted file mode 100644 index 2cfa9ffe7..000000000 --- a/reference/mongodb/mongodb/driver/server/isprimary.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - MongoDB\Driver\Server::isPrimary - Checks if this server is a primary member of a replica set - - - - &reftitle.description; - - final public boolMongoDB\Driver\Server::isPrimary - - - - Returns whether this server is a - primary member - of a replica set. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; if this server is a primary member of a replica set, and - &false; otherwise. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.seealso; - - MongoDB\Driver\Server::getInfo - - - - - - diff --git a/reference/mongodb/mongodb/driver/server/issecondary.xml b/reference/mongodb/mongodb/driver/server/issecondary.xml deleted file mode 100644 index 2e987ebd6..000000000 --- a/reference/mongodb/mongodb/driver/server/issecondary.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - MongoDB\Driver\Server::isSecondary - Checks if this server is a secondary member of a replica set - - - - &reftitle.description; - - final public boolMongoDB\Driver\Server::isSecondary - - - - Returns whether this server is a - secondary member - of a replica set. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; if this server is a secondary member of a replica set, and - &false; otherwise. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.seealso; - - MongoDB\Driver\Server::getInfo - - - - - - diff --git a/reference/mongodb/mongodb/driver/serverapi.xml b/reference/mongodb/mongodb/driver/serverapi.xml deleted file mode 100644 index 2888e796a..000000000 --- a/reference/mongodb/mongodb/driver/serverapi.xml +++ /dev/null @@ -1,185 +0,0 @@ - - - - - - The MongoDB\Driver\ServerApi class - MongoDB\Driver\ServerApi - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - MongoDB\Driver\ServerApi - - - - final - - MongoDB\Driver\ServerApi - - - MongoDB\BSON\Serializable - - - - Serializable - - - - Constants - - const - string - MongoDB\Driver\ServerAPI::V1 - "1" - - - &Methods; - - - - -
- - -
- &reftitle.constants; - - - - MongoDB\Driver\ServerApi::V1 - - Server API version 1. - - - - -
- - -
- &reftitle.examples; - - - Declare an API version on a manager - - $v1]); - -$command = new MongoDB\Driver\Command(['buildInfo' => 1]); - -try { - $cursor = $manager->executeCommand('admin', $command); -} catch(MongoDB\Driver\Exception $e) { - echo $e->getMessage(), "\n"; - exit; -} - -/* The buildInfo command returns a single result document, so we need to access - * the first result in the cursor. */ -$buildInfo = $cursor->toArray()[0]; - -echo $buildInfo->version, "\n"; - -?> -]]> - - - &example.outputs; - - - - - - - Declare a strict API version on a manager - - The following example sets the strict flag, which - tells the server to reject any command that is not part of the declared API - version. This results in an error when running the buildInfo command. - - - $v1]); - -$command = new MongoDB\Driver\Command(['buildInfo' => 1]); - -try { - $cursor = $manager->executeCommand('admin', $command); -} catch(MongoDB\Driver\Exception $e) { - echo $e->getMessage(), "\n"; - exit; -} - -/* The buildInfo command returns a single result document, so we need to access - * the first result in the cursor. */ -$buildInfo = $cursor->toArray()[0]; - -echo $buildInfo->version, "\n"; - -?> -]]> - - - &example.outputs; - - - - -
- - - - &reference.mongodb.mongodb.driver.entities.serverapi; - - - - diff --git a/reference/mongodb/mongodb/driver/serverapi/bsonserialize.xml b/reference/mongodb/mongodb/driver/serverapi/bsonserialize.xml deleted file mode 100644 index c200ba257..000000000 --- a/reference/mongodb/mongodb/driver/serverapi/bsonserialize.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - MongoDB\Driver\ServerApi::bsonSerialize - Returns an object for BSON serialization - - - - &reftitle.description; - - final public objectMongoDB\Driver\ServerApi::bsonSerialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an object for serializing the ServerApi as BSON. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.seealso; - - MongoDB\BSON\Serializable::bsonSerialize - - - - - - diff --git a/reference/mongodb/mongodb/driver/serverapi/construct.xml b/reference/mongodb/mongodb/driver/serverapi/construct.xml deleted file mode 100644 index 63e7f81d0..000000000 --- a/reference/mongodb/mongodb/driver/serverapi/construct.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - MongoDB\Driver\ServerApi::__construct - Create a new ServerApi instance - - - - &reftitle.description; - - final public MongoDB\Driver\ServerApi::__construct - stringversion - boolstrict&null; - booldeprecationErrors&null; - - - - Creates a new MongoDB\Driver\ServerApi instance used to - declare an API version when creating a - MongoDB\Driver\Manager. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - diff --git a/reference/mongodb/mongodb/driver/serverapi/serialize.xml b/reference/mongodb/mongodb/driver/serverapi/serialize.xml deleted file mode 100644 index 1882c23bd..000000000 --- a/reference/mongodb/mongodb/driver/serverapi/serialize.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - MongoDB\Driver\ServerApi::serialize - Serialize a ServerApi - - - - &reftitle.description; - - final public stringMongoDB\Driver\ServerApi::serialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the serialized representation of the - MongoDB\Driver\ServerApi. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\ServerApi::unserialize - serialize - Serializing Objects - - - - - - diff --git a/reference/mongodb/mongodb/driver/serverapi/unserialize.xml b/reference/mongodb/mongodb/driver/serverapi/unserialize.xml deleted file mode 100644 index 544e3df3f..000000000 --- a/reference/mongodb/mongodb/driver/serverapi/unserialize.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - MongoDB\Driver\ServerApi::unserialize - Unserialize a ServerApi - - - - &reftitle.description; - - final public voidMongoDB\Driver\ServerApi::unserialize - stringserialized - - - - - &reftitle.parameters; - - - - serialized - - - The serialized MongoDB\Driver\ServerApi. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\UnexpectedValueException if the properties cannot be unserialized (i.e. serialized was malformed). - Throws MongoDB\Driver\Exception\InvalidArgumentException if the properties are invalid (e.g. missing fields or invalid values). - - - - - &reftitle.seealso; - - MongoDB\Driver\ServerApi::serialize - unserialize - Serializing Objects - - - - - - diff --git a/reference/mongodb/mongodb/driver/serverdescription.xml b/reference/mongodb/mongodb/driver/serverdescription.xml deleted file mode 100644 index 858b391cb..000000000 --- a/reference/mongodb/mongodb/driver/serverdescription.xml +++ /dev/null @@ -1,215 +0,0 @@ - - - - - - The MongoDB\Driver\ServerDescription class - MongoDB\Driver\ServerDescription - - - - -
- &reftitle.intro; - - The MongoDB\Driver\ServerDescription class is a value - object that represents a server to which the driver is connected. Instances - of this class are returned by - MongoDB\Driver\Server::getServerDescription and - MongoDB\Driver\Monitoring\ServerChangedEvent methods. - -
- - -
- &reftitle.classsynopsis; - - - - MongoDB\Driver\ServerDescription - - - - final - - MongoDB\Driver\ServerDescription - - - - Constants - - const - string - MongoDB\Driver\ServerDescription::TYPE_UNKNOWN - "Unknown" - - - const - string - MongoDB\Driver\ServerDescription::TYPE_STANDALONE - "Standalone" - - - const - string - MongoDB\Driver\ServerDescription::TYPE_MONGOS - "Mongos" - - - const - string - MongoDB\Driver\ServerDescription::TYPE_POSSIBLE_PRIMARY - "PossiblePrimary" - - - const - string - MongoDB\Driver\ServerDescription::TYPE_RS_PRIMARY - "RSPrimary" - - - const - string - MongoDB\Driver\ServerDescription::TYPE_RS_SECONDARY - "RSSecondary" - - - const - string - MongoDB\Driver\ServerDescription::TYPE_RS_ARBITER - "RSArbiter" - - - const - string - MongoDB\Driver\ServerDescription::TYPE_RS_OTHER - "RSOther" - - - const - string - MongoDB\Driver\ServerDescription::TYPE_RS_GHOST - "RSGhost" - - - const - string - MongoDB\Driver\ServerDescription::TYPE_LOAD_BALANCER - "LoadBalancer" - - - &Methods; - - - - -
- - -
- &reftitle.constants; - - - - MongoDB\Driver\ServerDescription::TYPE_UNKNOWN - - Unknown server type, returned by MongoDB\Driver\ServerDescription::getType. - - - - - MongoDB\Driver\ServerDescription::TYPE_STANDALONE - - Standalone server type, returned by MongoDB\Driver\ServerDescription::getType. - - - - - MongoDB\Driver\ServerDescription::TYPE_MONGOS - - Mongos server type, returned by MongoDB\Driver\ServerDescription::getType. - - - - - MongoDB\Driver\ServerDescription::TYPE_POSSIBLE_PRIMARY - - Replica set possible primary server type, returned by MongoDB\Driver\ServerDescription::getType. - A server may be identified as a possible primary if it has not yet been checked but another memory of the replica set thinks it is the primary. - - - - - MongoDB\Driver\ServerDescription::TYPE_RS_PRIMARY - - Replica set primary server type, returned by MongoDB\Driver\ServerDescription::getType. - - - - - MongoDB\Driver\ServerDescription::TYPE_RS_SECONDARY - - Replica set secondary server type, returned by MongoDB\Driver\ServerDescription::getType. - - - - - MongoDB\Driver\ServerDescription::TYPE_RS_ARBITER - - Replica set arbiter server type, returned by MongoDB\Driver\ServerDescription::getType. - - - - - MongoDB\Driver\ServerDescription::TYPE_RS_OTHER - - Replica set other server type, returned by MongoDB\Driver\ServerDescription::getType. - Such servers may be hidden, starting up, or recovering. They cannot be queried, but their hosts lists are useful for discovering the current replica set configuration. - - - - - MongoDB\Driver\ServerDescription::TYPE_RS_GHOST - - Replica set ghost server type, returned by MongoDB\Driver\ServerDescription::getType. - Servers may be identified as such in at least three situations: briefly during server startup; in an uninitialized replica set; or when the server is shunned (i.e. removed from the replica set config). They cannot be queried, nor can their host list be used to discover the current replica set configuration; however, the client may monitor this server in hope that it transitions to a more useful state. - - - - - MongoDB\Driver\ServerDescription::TYPE_LOAD_BALANCER - - Load balancer server type, returned by MongoDB\Driver\ServerDescription::getType. - - - - -
- - - - - &reference.mongodb.mongodb.driver.entities.serverdescription; - - - - diff --git a/reference/mongodb/mongodb/driver/serverdescription/gethelloresponse.xml b/reference/mongodb/mongodb/driver/serverdescription/gethelloresponse.xml deleted file mode 100644 index d019db75b..000000000 --- a/reference/mongodb/mongodb/driver/serverdescription/gethelloresponse.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - MongoDB\Driver\ServerDescription::getHelloResponse - Returns the server's most recent "hello" response - - - - &reftitle.description; - - final public arrayMongoDB\Driver\ServerDescription::getHelloResponse - - - - Returns an array of information describing the server. This array is derived - from the most recent (at the time the - MongoDB\Driver\ServerDescription was constructed) - hello - command response obtained through - server monitoring. - - - - When the driver is connected to a load balancer, this method will return an - empty array since load balancers are not monitored. This is in contrast to - MongoDB\Driver\Server::getInfo, which would return the - backing server's - hello - command response from the initial connection handshake. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an array of information describing this server. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Server::getInfo - hello command in the MongoDB manual - Server Discovery and Monitoring Specification - - - - - - diff --git a/reference/mongodb/mongodb/driver/serverdescription/gethost.xml b/reference/mongodb/mongodb/driver/serverdescription/gethost.xml deleted file mode 100644 index 499d413b0..000000000 --- a/reference/mongodb/mongodb/driver/serverdescription/gethost.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - MongoDB\Driver\ServerDescription::getHost - Returns the hostname of this server - - - - &reftitle.description; - - final public stringMongoDB\Driver\ServerDescription::getHost - - - - Returns the hostname of this server. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the hostname of this server. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Server::getHost - - - - - - diff --git a/reference/mongodb/mongodb/driver/serverdescription/getlastupdatetime.xml b/reference/mongodb/mongodb/driver/serverdescription/getlastupdatetime.xml deleted file mode 100644 index b68bbd370..000000000 --- a/reference/mongodb/mongodb/driver/serverdescription/getlastupdatetime.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - MongoDB\Driver\ServerDescription::getLastUpdateTime - Returns the server's last update time in microseconds - - - - &reftitle.description; - - final public intMongoDB\Driver\ServerDescription::getLastUpdateTime - - - - Returns the server's last update time in microseconds. - - - - The returned value is a monotonic timestamp, which starts at an arbitrary - point. As such, it is only suitable to compare with other return values from - MongoDB\Driver\ServerDescription::getLastUpdateTime. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the server's last update time in microseconds. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/serverdescription/getport.xml b/reference/mongodb/mongodb/driver/serverdescription/getport.xml deleted file mode 100644 index 3014e18cc..000000000 --- a/reference/mongodb/mongodb/driver/serverdescription/getport.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - MongoDB\Driver\ServerDescription::getPort - Returns the port on which this server is listening - - - - &reftitle.description; - - final public intMongoDB\Driver\ServerDescription::getPort - - - - Returns the port on which this server is listening. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the port on which this server is listening. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Server::getPort - - - - - - diff --git a/reference/mongodb/mongodb/driver/serverdescription/getroundtriptime.xml b/reference/mongodb/mongodb/driver/serverdescription/getroundtriptime.xml deleted file mode 100644 index ca11fd1d5..000000000 --- a/reference/mongodb/mongodb/driver/serverdescription/getroundtriptime.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - MongoDB\Driver\ServerDescription::getRoundTripTime - Returns the server's round trip time in milliseconds - - - - &reftitle.description; - - final public intMongoDB\Driver\ServerDescription::getRoundTripTime - - - - Returns the server's round trip time in milliseconds. This is the client's - measurement of the duration of a - hello - command. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the server's round trip time in milliseconds. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Server::getLatency - - - - - - diff --git a/reference/mongodb/mongodb/driver/serverdescription/gettype.xml b/reference/mongodb/mongodb/driver/serverdescription/gettype.xml deleted file mode 100644 index 6ff42f78d..000000000 --- a/reference/mongodb/mongodb/driver/serverdescription/gettype.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - MongoDB\Driver\ServerDescription::getType - Returns a string denoting the type of this server - - - - &reftitle.description; - - final public stringMongoDB\Driver\ServerDescription::getType - - - - Returns a string denoting the type of this server. The value - will correlate with a MongoDB\Driver\ServerDescription - constant. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a string denoting the type of this server. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Server::getType - - - - - - diff --git a/reference/mongodb/mongodb/driver/session.xml b/reference/mongodb/mongodb/driver/session.xml deleted file mode 100644 index 6005ca9c6..000000000 --- a/reference/mongodb/mongodb/driver/session.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - - The MongoDB\Driver\Session class - MongoDB\Driver\Session - - - - -
- &reftitle.intro; - - The MongoDB\Driver\Session class represents a - client session and is returned by - MongoDB\Driver\Manager::startSession. Commands, - queries, and write operations may then be associated the session. - -
- - -
- &reftitle.classsynopsis; - - - - MongoDB\Driver\Session - - - - final - - MongoDB\Driver\Session - - - - - Constants - - const - string - MongoDB\Driver\Session::TRANSACTION_NONE - none - - - const - string - MongoDB\Driver\Session::TRANSACTION_STARTING - starting - - - const - string - MongoDB\Driver\Session::TRANSACTION_IN_PROGRESS - in_progress - - - const - string - MongoDB\Driver\Session::TRANSACTION_COMMITTED - committed - - - const - string - MongoDB\Driver\Session::TRANSACTION_ABORTED - aborted - - - &Methods; - - - - -
- - -
- &reftitle.constants; - - - - MongoDB\Driver\Session::TRANSACTION_NONE - - - There is no transaction in progress. - - - - - - MongoDB\Driver\Session::TRANSACTION_STARTING - - - A transaction has been started, but no operation has been sent to the server. - - - - - - MongoDB\Driver\Session::TRANSACTION_IN_PROGRESS - - - A transaction is in progress. - - - - - - MongoDB\Driver\Session::TRANSACTION_COMMITTED - - - The transaction was committed. - - - - - - MongoDB\Driver\Session::TRANSACTION_ABORTED - - - The transaction was aborted. - - - - - -
- - - - - &reference.mongodb.mongodb.driver.entities.session; - - - - diff --git a/reference/mongodb/mongodb/driver/session/aborttransaction.xml b/reference/mongodb/mongodb/driver/session/aborttransaction.xml deleted file mode 100644 index 5ee7ffa06..000000000 --- a/reference/mongodb/mongodb/driver/session/aborttransaction.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - MongoDB\Driver\Session::abortTransaction - Aborts a transaction - - - - &reftitle.description; - - final public voidMongoDB\Driver\Session::abortTransaction - - - - Terminates the multi-document transaction and rolls back any data changes - made by the operations within the transaction. That is, the transaction ends - without saving any of the changes made by the operations in the transaction. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\RuntimeException if the transaction could not be aborted (e.g. a transaction was not started). - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::startSession - MongoDB\Driver\Session::commitTransaction - MongoDB\Driver\Session::startTransaction - - - - - - diff --git a/reference/mongodb/mongodb/driver/session/advanceclustertime.xml b/reference/mongodb/mongodb/driver/session/advanceclustertime.xml deleted file mode 100644 index 69362b554..000000000 --- a/reference/mongodb/mongodb/driver/session/advanceclustertime.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - MongoDB\Driver\Session::advanceClusterTime - Advances the cluster time for this session - - - - &reftitle.description; - - final public voidMongoDB\Driver\Session::advanceClusterTime - arrayobjectclusterTime - - - Advances the cluster time for this session. If the cluster time is less than - or equal to the session's current cluster time, this function is a no-op. - - - By using this method in conjunction with - MongoDB\Driver\Session::advanceOperationTime to copy - the cluster and operation times from another session, you can ensure that - operations in this session are causally consistent with the last operation in - the other session. - - - - - &reftitle.parameters; - - - clusterTime - - - The cluster time is a document containing a logical timestamp and server - signature. Typically, this value will be obtained by calling - MongoDB\Driver\Session::getClusterTime on another - session object. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Session::advanceOperationTime - MongoDB\Driver\Session::getClusterTime - - - - - - diff --git a/reference/mongodb/mongodb/driver/session/advanceoperationtime.xml b/reference/mongodb/mongodb/driver/session/advanceoperationtime.xml deleted file mode 100644 index e7c0fcb48..000000000 --- a/reference/mongodb/mongodb/driver/session/advanceoperationtime.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - MongoDB\Driver\Session::advanceOperationTime - Advances the operation time for this session - - - - &reftitle.description; - - final public voidMongoDB\Driver\Session::advanceOperationTime - MongoDB\BSON\TimestampInterfaceoperationTime - - - Advances the operation time for this session. If the operation time is less - than or equal to the session's current operation time, this function is a - no-op. - - - By using this method in conjunction with - MongoDB\Driver\Session::advanceClusterTime to copy - the operation and cluster times from another session, you can ensure that - operations in this session are causally consistent with the last operation in - the other session. - - - - - &reftitle.parameters; - - - operationTime - - - The operation time is a logical timestamp. Typically, this value will be - obtained by calling - MongoDB\Driver\Session::getOperationTime on - another session object. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Session::advanceClusterTime - MongoDB\Driver\Session::getClusterTime - - - - - - diff --git a/reference/mongodb/mongodb/driver/session/committransaction.xml b/reference/mongodb/mongodb/driver/session/committransaction.xml deleted file mode 100644 index 7bfc4e2e7..000000000 --- a/reference/mongodb/mongodb/driver/session/committransaction.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - MongoDB\Driver\Session::commitTransaction - Commits a transaction - - - - &reftitle.description; - - final public voidMongoDB\Driver\Session::commitTransaction - - - - Saves the changes made by the operations in the multi-document transaction - and ends the transaction. Until the commit, none of the data changes made - from within the transaction are visible outside the transaction. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Throws - MongoDB\Driver\Exception\CommandException if the - server could not commit the transaction (e.g. due to conflicts, network - issues). In case the exception's - MongoDB\Driver\Exception\CommandException::getResultDocument - has a "errorLabels" element, and this array contains a - "TransientTransactionError" or - "UnUnknownTransactionCommitResult" value, it is safe to re-try - the whole transaction. In newer versions of the - driver, - MongoDB\Driver\Exception\RuntimeException::hasErrorLabel - should be used to test for this situation instead. - Throws - MongoDB\Driver\Exception\RuntimeException if the - transaction could not be commited (e.g. a transaction was not - started). - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::startSession - MongoDB\Driver\Session::abortTransaction - MongoDB\Driver\Session::startTransaction - MongoDB\Driver\Exception\RuntimeException::hasErrorLabel - - - - - - diff --git a/reference/mongodb/mongodb/driver/session/construct.xml b/reference/mongodb/mongodb/driver/session/construct.xml deleted file mode 100644 index 5091e5e01..000000000 --- a/reference/mongodb/mongodb/driver/session/construct.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - MongoDB\Driver\Session::__construct - Create a new Session (not used) - - - - &reftitle.description; - - final private MongoDB\Driver\Session::__construct - - - - MongoDB\Driver\Session objects are returned by - MongoDB\Driver\Manager::startSession and cannot be - constructed directly. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::startSession - - - - - - diff --git a/reference/mongodb/mongodb/driver/session/endsession.xml b/reference/mongodb/mongodb/driver/session/endsession.xml deleted file mode 100644 index 6027039b2..000000000 --- a/reference/mongodb/mongodb/driver/session/endsession.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - MongoDB\Driver\Session::endSession - Terminates a session - - - - &reftitle.description; - - final public voidMongoDB\Driver\Session::endSession - - - - This method closes an existing session. If a transaction was associated - with this session, the transaction will be aborted. After calling this - method, applications should not invoke other methods on the session. - - - - Sessions are also closed during garbage collection. It should not be - necessary to call this method under normal circumstances. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::startSession - MongoDB\Driver\Session::abortTransaction - MongoDB\Driver\Session::commitTransaction - MongoDB\Driver\Session::startTransaction - - - - - - diff --git a/reference/mongodb/mongodb/driver/session/getclustertime.xml b/reference/mongodb/mongodb/driver/session/getclustertime.xml deleted file mode 100644 index 4e304cab2..000000000 --- a/reference/mongodb/mongodb/driver/session/getclustertime.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - MongoDB\Driver\Session::getClusterTime - Returns the cluster time for this session - - - - &reftitle.description; - - final public objectnullMongoDB\Driver\Session::getClusterTime - - - - Returns the cluster time for this session. If the session has not been used - for any operation and - MongoDB\Driver\Session::advanceClusterTime has not - been called, the cluster time will be &null;. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the cluster time for this session, or &null; if the session has no - cluster time. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Session::advanceClusterTime - - - - - - diff --git a/reference/mongodb/mongodb/driver/session/getlogicalsessionid.xml b/reference/mongodb/mongodb/driver/session/getlogicalsessionid.xml deleted file mode 100644 index 96c2eba0a..000000000 --- a/reference/mongodb/mongodb/driver/session/getlogicalsessionid.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - MongoDB\Driver\Session::getLogicalSessionId - Returns the logical session ID for this session - - - - &reftitle.description; - - final public objectMongoDB\Driver\Session::getLogicalSessionId - - - - Returns the logical session ID for this session, which may be used to - identify this session's operations on the server. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the logical session ID for this session. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/session/getoperationtime.xml b/reference/mongodb/mongodb/driver/session/getoperationtime.xml deleted file mode 100644 index 91b59c531..000000000 --- a/reference/mongodb/mongodb/driver/session/getoperationtime.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - MongoDB\Driver\Session::getOperationTime - Returns the operation time for this session - - - - &reftitle.description; - - final public MongoDB\BSON\TimestampnullMongoDB\Driver\Session::getOperationTime - - - - Returns the operation time for this session. If the session has not been used - for any operation and - MongoDB\Driver\Session::advanceOperationTime has not - been called, the operation time will be &null; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the operation time for this session, or &null; if the session has no - operation time. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Session::advanceOperationTime - - - - - - diff --git a/reference/mongodb/mongodb/driver/session/getserver.xml b/reference/mongodb/mongodb/driver/session/getserver.xml deleted file mode 100644 index 68147c02c..000000000 --- a/reference/mongodb/mongodb/driver/session/getserver.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - MongoDB\Driver\Session::getServer - Returns the server to which this session is pinned - - - - &reftitle.description; - - final public MongoDB\Driver\ServernullMongoDB\Driver\Session::getServer - - - - Returns the MongoDB\Driver\Server to which this - session is pinned. If the session is not pinned to a server, &null; will be - returned. - - - Session pinning is primarily used for sharded transactions, as all commands - within a sharded transaction must be sent to the same mongos instance. This - method is intended to be used by libraries built atop the extension to allow - use of a pinned server instead of invoking server selection. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the MongoDB\Driver\Server to which this - session is pinned, or &null; if the session is not pinned to any server. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/session/gettransactionoptions.xml b/reference/mongodb/mongodb/driver/session/gettransactionoptions.xml deleted file mode 100644 index e9be45346..000000000 --- a/reference/mongodb/mongodb/driver/session/gettransactionoptions.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - MongoDB\Driver\Session::getTransactionOptions - Returns options for the currently running transaction - - - - &reftitle.description; - - final public arraynullMongoDB\Driver\Session::getTransactionOptions - - - - Returns options for the currently running transaction. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a array containing current transaction options, or - &null; if no transaction is running. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Session::getTransactionState - - - - - - diff --git a/reference/mongodb/mongodb/driver/session/gettransactionstate.xml b/reference/mongodb/mongodb/driver/session/gettransactionstate.xml deleted file mode 100644 index aa08a8541..000000000 --- a/reference/mongodb/mongodb/driver/session/gettransactionstate.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - MongoDB\Driver\Session::getTransactionState - Returns the current transaction state for this session - - - - &reftitle.description; - - final public stringMongoDB\Driver\Session::getTransactionState - - - - Returns the transaction state for this session. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the current transaction state for this session. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Session::isInTransaction - MongoDB\Driver\Session::getTransactionOptions - - - - - - diff --git a/reference/mongodb/mongodb/driver/session/isdirty.xml b/reference/mongodb/mongodb/driver/session/isdirty.xml deleted file mode 100644 index be191640b..000000000 --- a/reference/mongodb/mongodb/driver/session/isdirty.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - MongoDB\Driver\Session::isDirty - Returns whether the session has been marked as dirty - - - - &reftitle.description; - - final public boolMongoDB\Driver\Session::isDirty - - - - Returns whether the session has been marked as dirty (i.e. it has been used - with a command that encountered a network error). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns whether the session has been marked as dirty. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/session/isintransaction.xml b/reference/mongodb/mongodb/driver/session/isintransaction.xml deleted file mode 100644 index cf6f95651..000000000 --- a/reference/mongodb/mongodb/driver/session/isintransaction.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - MongoDB\Driver\Session::isInTransaction - Returns whether a multi-document transaction is in progress - - - - &reftitle.description; - - final public boolMongoDB\Driver\Session::isInTransaction - - - - Returns whether a multi-document transaction is currently in progress for - this session. A transaction is considered "in progress" if it has been - started but has not been committed or aborted. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; if a transaction is currently in progress for this session, - and &false; otherwise. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Session::getTransactionState - - - - - - diff --git a/reference/mongodb/mongodb/driver/session/starttransaction.xml b/reference/mongodb/mongodb/driver/session/starttransaction.xml deleted file mode 100644 index 80ea7f14e..000000000 --- a/reference/mongodb/mongodb/driver/session/starttransaction.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - MongoDB\Driver\Session::startTransaction - Starts a transaction - - - - &reftitle.description; - - final public voidMongoDB\Driver\Session::startTransaction - arrayoptions - - - Starts a multi-document transaction associated with the session. At any given - time, you can have at most one open transaction for a session. After starting - a transaction, the session object must be passed to each operation via - the "session" option (e.g. - MongoDB\Driver\Manager::executeBulkWrite) in order - to associate that operation with the transaction. - - - Transactions can be committed through - MongoDB\Driver\Session::commitTransaction, and - aborted with - MongoDB\Driver\Session::abortTransaction. - Transactions are also automatically aborted when the session is closed from - garbage collection or by explicitly calling - MongoDB\Driver\Session::endSession. - - - - - &reftitle.parameters; - - - options - - - Options can be passed as argument to this method. Each element in this - options array overrides the corresponding option from the - "defaultTransactionOptions" option, if set when - starting the session with - MongoDB\Driver\Manager::startSession. - - - - options - - - - Option - Type - Description - - - - &mongodb.option.maxCommitTimeMS; - &mongodb.option.readConcern; - &mongodb.option.readPreference; - &mongodb.option.writeConcern; - - -
- - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\CommandException if the transaction could not be started because of a server-side problem (e.g. a lock could not be obtained). - Throws MongoDB\Driver\Exception\RuntimeException if the transaction could not be started (e.g. a transaction was already started). - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 1.6.0 - - - The "maxCommitTimeMS" option was added. - - - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::startSession - MongoDB\Driver\Session::commitTransaction - MongoDB\Driver\Session::abortTransaction - - - - - - diff --git a/reference/mongodb/mongodb/driver/topologydescription.xml b/reference/mongodb/mongodb/driver/topologydescription.xml deleted file mode 100644 index 9107d56a1..000000000 --- a/reference/mongodb/mongodb/driver/topologydescription.xml +++ /dev/null @@ -1,160 +0,0 @@ - - - - - - The MongoDB\Driver\TopologyDescription class - MongoDB\Driver\TopologyDescription - - - - -
- &reftitle.intro; - - The MongoDB\Driver\TopologyDescription class is a - value object that represents a topology to which the driver is connected. - Instances of this class are returned by - MongoDB\Driver\Monitoring\TopologyChangedEvent - methods. - -
- - -
- &reftitle.classsynopsis; - - - - MongoDB\Driver\TopologyDescription - - - - final - - MongoDB\Driver\TopologyDescription - - - - Constants - - const - string - MongoDB\Driver\TopologyDescription::TYPE_UNKNOWN - "Unknown" - - - const - string - MongoDB\Driver\TopologyDescription::TYPE_SINGLE - "Single" - - - const - string - MongoDB\Driver\TopologyDescription::TYPE_SHARDED - "Sharded" - - - const - string - MongoDB\Driver\TopologyDescription::TYPE_REPLICA_SET_NO_PRIMARY - "ReplicaSetNoPrimary" - - - const - string - MongoDB\Driver\TopologyDescription::TYPE_REPLICA_SET_WITH_PRIMARY - "ReplicaSetWithPrimary" - - - const - string - MongoDB\Driver\TopologyDescription::TYPE_LOAD_BALANCED - "LoadBalanced" - - - &Methods; - - - - -
- - -
- &reftitle.constants; - - - - MongoDB\Driver\TopologyDescription::TYPE_UNKNOWN - - Unknown topology type, returned by MongoDB\Driver\TopologyDescription::getType. - - - - - MongoDB\Driver\TopologyDescription::TYPE_SINGLE - - Single server (i.e. direct connection), returned by MongoDB\Driver\TopologyDescription::getType. - - - - - MongoDB\Driver\TopologyDescription::TYPE_SHARDED - - Sharded cluster, returned by MongoDB\Driver\TopologyDescription::getType. - - - - - MongoDB\Driver\TopologyDescription::TYPE_REPLICA_SET_NO_PRIMARY - - Replica set with no primary server, returned by MongoDB\Driver\TopologyDescription::getType. - - - - - MongoDB\Driver\TopologyDescription::TYPE_REPLICA_SET_WITH_PRIMARY - - Replica set with a primary server, returned by MongoDB\Driver\TopologyDescription::getType. - - - - - MongoDB\Driver\TopologyDescription::TYPE_LOAD_BALANCED - - Load balanced topology, returned by MongoDB\Driver\TopologyDescription::getType. - - - - -
- - - - - &reference.mongodb.mongodb.driver.entities.topologydescription; - - - - diff --git a/reference/mongodb/mongodb/driver/topologydescription/getservers.xml b/reference/mongodb/mongodb/driver/topologydescription/getservers.xml deleted file mode 100644 index c039cc54d..000000000 --- a/reference/mongodb/mongodb/driver/topologydescription/getservers.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - MongoDB\Driver\TopologyDescription::getServers - Returns the servers in the topology - - - - &reftitle.description; - - final public arrayMongoDB\Driver\TopologyDescription::getServers - - - - Returns an array of MongoDB\Driver\ServerDescription - objects corresponding to the known servers in the topology. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an array of MongoDB\Driver\ServerDescription - objects corresponding to the known servers in the topology. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/topologydescription/gettype.xml b/reference/mongodb/mongodb/driver/topologydescription/gettype.xml deleted file mode 100644 index 6b405dc70..000000000 --- a/reference/mongodb/mongodb/driver/topologydescription/gettype.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - MongoDB\Driver\TopologyDescription::getType - Returns a string denoting the type of this topology - - - - &reftitle.description; - - final public stringMongoDB\Driver\TopologyDescription::getType - - - - Returns a string denoting the type of this topology. The value - will correlate with a - MongoDB\Driver\TopologyDescription constant. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a string denoting the type of this topology. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/topologydescription/hasreadableserver.xml b/reference/mongodb/mongodb/driver/topologydescription/hasreadableserver.xml deleted file mode 100644 index c59075b79..000000000 --- a/reference/mongodb/mongodb/driver/topologydescription/hasreadableserver.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - MongoDB\Driver\TopologyDescription::hasReadableServer - Returns whether the topology has a readable server - - - - &reftitle.description; - - final public boolMongoDB\Driver\TopologyDescription::hasReadableServer - MongoDB\Driver\ReadPreferencenullreadPreference&null; - - - Returns whether the topology has a readable server or, if - readPreference is specified, a server matching the - specified read preference. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns whether the topology has a readable server or, if - readPreference is specified, a server matching the - specified read preference. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/topologydescription/haswritableserver.xml b/reference/mongodb/mongodb/driver/topologydescription/haswritableserver.xml deleted file mode 100644 index 43576e804..000000000 --- a/reference/mongodb/mongodb/driver/topologydescription/haswritableserver.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - MongoDB\Driver\TopologyDescription::hasWritableServer - Returns whether the topology has a writable server - - - - &reftitle.description; - - final public boolMongoDB\Driver\TopologyDescription::hasWritableServer - - - - Returns whether the topology has a writable server. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns whether the topology has a writable server. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeconcern.xml b/reference/mongodb/mongodb/driver/writeconcern.xml deleted file mode 100644 index a3169eb47..000000000 --- a/reference/mongodb/mongodb/driver/writeconcern.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - - The MongoDB\Driver\WriteConcern class - MongoDB\Driver\WriteConcern - - - - -
- &reftitle.intro; - - MongoDB\Driver\WriteConcern describes the level of - acknowledgement requested from MongoDB for write operations to a standalone - mongod or to replica sets or to sharded clusters. In - sharded clusters, mongos instances will pass the write - concern on to the shards. - -
- - -
- &reftitle.classsynopsis; - - - - MongoDB\Driver\WriteConcern - - - - final - - MongoDB\Driver\WriteConcern - - - - MongoDB\BSON\Serializable - - - - Serializable - - - - Constants - - const - string - MongoDB\Driver\WriteConcern::MAJORITY - "majority" - - - &Methods; - - - - -
- - -
- &reftitle.constants; - - - - MongoDB\Driver\WriteConcern::MAJORITY - - - Majority of all the members in the set; arbiters, non-voting members, - passive members, hidden members and delayed members are all included in - the definition of majority write concern. - - - - - -
- - -
- &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 1.7.0 - - Implements Serializable. - - - - PECL mongodb 1.2.0 - - Implements MongoDB\BSON\Serializable. - - - - - - -
- - - - &reference.mongodb.mongodb.driver.entities.writeconcern; - - - - diff --git a/reference/mongodb/mongodb/driver/writeconcern/bsonserialize.xml b/reference/mongodb/mongodb/driver/writeconcern/bsonserialize.xml deleted file mode 100644 index a7f90bff6..000000000 --- a/reference/mongodb/mongodb/driver/writeconcern/bsonserialize.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - MongoDB\Driver\WriteConcern::bsonSerialize - Returns an object for BSON serialization - - - - &reftitle.description; - - final public objectMongoDB\Driver\WriteConcern::bsonSerialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an object for serializing the WriteConcern as BSON. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\WriteConcern::bsonSerialize</function> with majority write concern - -bsonSerialize()); - -echo "\n", MongoDB\BSON\toJSON(MongoDB\BSON\fromPHP($wc)); - -?> -]]> - - &example.outputs.similar; - - - string(8) "majority" -} - -{ "w" : "majority" } -]]> - - - <function>MongoDB\Driver\WriteConcern::bsonSerialize</function> with wtimeout and journal - -bsonSerialize()); - -echo "\n", MongoDB\BSON\toJSON(MongoDB\BSON\fromPHP($wc)); - -?> -]]> - - &example.outputs.similar; - - - int(2) - ["j"]=> - bool(true) - ["wtimeout"]=> - int(1000) -} - -{ "w" : 2, "j" : true, "wtimeout" : 1000 } -]]> - - - - - - - &reftitle.seealso; - - MongoDB\BSON\Serializable::bsonSerialize - Write Concern reference - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeconcern/construct.xml b/reference/mongodb/mongodb/driver/writeconcern/construct.xml deleted file mode 100644 index bb2d4b4ae..000000000 --- a/reference/mongodb/mongodb/driver/writeconcern/construct.xml +++ /dev/null @@ -1,231 +0,0 @@ - - - - - - MongoDB\Driver\WriteConcern::__construct - Create a new WriteConcern - - - - &reftitle.description; - - final public MongoDB\Driver\WriteConcern::__construct - stringintw - intwtimeout - booljournal - - - Constructs a new MongoDB\Driver\WriteConcern, which is - an immutable value object. - - - - - &reftitle.parameters; - - - w - - - - Write concern - - - - Value - Description - - - - - 1 - - Requests acknowledgement that the write operation has propagated to - the standalone mongod or the primary in a replica - set. This is the default write concern for MongoDB. - - - - 0 - - Requests no acknowledgment of the write operation. However, this may - return information about socket exceptions and networking errors to - the application. - - - - <integer greater than 1> - - Numbers greater than 1 are valid only for replica sets to request - acknowledgement from specified number of members, including the - primary. - - - - MongoDB\Driver\WriteConcern::MAJORITY - - - Requests acknowledgment that write operations have propagated to the - majority of voting nodes, including the primary, and have been - written to the on-disk journal for these nodes. - - - Prior to MongoDB 3.0, this refers to the majority of replica set - members (not just voting nodes). - - - - - string - - A string value is interpereted as a tag set. Requests acknowledgement - that the write operations have propagated to a replica set member - with the specified tag. - - - - -
- - - - - wtimeout - - - How long to wait (in milliseconds) for secondaries before failing. - - - wtimeout causes write operations to return with an - error (WriteConcernError) after the specified - limit, even if the required write concern will eventually succeed. When - these write operations return, MongoDB does not undo successful data - modifications performed before the write concern exceeded the - wtimeout time limit. - - - If specified, wtimeout must be a signed 64-bit integer - greater than or equal to zero. - - - - Write concern timeout - - - - Value - Description - - - - - 0 - Block indefinitely. This is the default. - - - <integer greater than 0> - - Milliseconds to wait until returning. - - - - -
- - - - - journal - - - Wait until mongod has applied the write to the journal. - - - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\InvalidArgumentException if w is invalid or wtimeout is either negative or greater than the bounds of a signed 32-bit integer. - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 1.7.0 - - The wTimeout parameter now accepts 64-bit values. - - - - - - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\WriteConcern::__construct</function> example - - -]]> - - - - - - - &reftitle.seealso; - - Write Concern reference - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeconcern/getjournal.xml b/reference/mongodb/mongodb/driver/writeconcern/getjournal.xml deleted file mode 100644 index 96d7b9b2a..000000000 --- a/reference/mongodb/mongodb/driver/writeconcern/getjournal.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - MongoDB\Driver\WriteConcern::getJournal - Returns the WriteConcern's "journal" option - - - - &reftitle.description; - - final public boolnullMongoDB\Driver\WriteConcern::getJournal - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the WriteConcern's "journal" option. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\WriteConcern::getJournal</function> example - -getJournal()); - -$wc = new MongoDB\Driver\WriteConcern(1, 0, true); -var_dump($wc->getJournal()); - -$wc = new MongoDB\Driver\WriteConcern(1, 0, false); -var_dump($wc->getJournal()); - -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - Write Concern reference - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeconcern/getw.xml b/reference/mongodb/mongodb/driver/writeconcern/getw.xml deleted file mode 100644 index 6ccd3d7fd..000000000 --- a/reference/mongodb/mongodb/driver/writeconcern/getw.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - MongoDB\Driver\WriteConcern::getW - Returns the WriteConcern's "w" option - - - - &reftitle.description; - - final public stringintnullMongoDB\Driver\WriteConcern::getW - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the WriteConcern's "w" option. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\WriteConcern::getW</function> example - -getW()); - -$wc = new MongoDB\Driver\WriteConcern(MongoDB\Driver\WriteConcern::MAJORITY); -var_dump($wc->getW()); - -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - Write Concern reference - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeconcern/getwtimeout.xml b/reference/mongodb/mongodb/driver/writeconcern/getwtimeout.xml deleted file mode 100644 index 835a3f398..000000000 --- a/reference/mongodb/mongodb/driver/writeconcern/getwtimeout.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - MongoDB\Driver\WriteConcern::getWtimeout - Returns the WriteConcern's "wtimeout" option - - - - &reftitle.description; - - final public intMongoDB\BSON\Int64MongoDB\Driver\WriteConcern::getWtimeout - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the WriteConcern's "wtimeout" option. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 1.7.0 - - On 32-bit systems, this method will return a MongoDB\BSON\Int64 - instance if the WriteConcern object was created with a wTimeout - that exceeds the 32-bit range. On 64-bit systems, this method will - always return an integer value. - - - - - - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\WriteConcern::getWtimeout</function> example - -getWtimeout()); - -$wc = new MongoDB\Driver\WriteConcern(MongoDB\Driver\WriteConcern::MAJORITY, 3000); -var_dump($wc->getWtimeout()); - -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - Write Concern reference - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeconcern/isdefault.xml b/reference/mongodb/mongodb/driver/writeconcern/isdefault.xml deleted file mode 100644 index 22a108b24..000000000 --- a/reference/mongodb/mongodb/driver/writeconcern/isdefault.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - MongoDB\Driver\WriteConcern::isDefault - Checks if this is the default write concern - - - - &reftitle.description; - - final public boolMongoDB\Driver\WriteConcern::isDefault - - - - Returns whether this is the default write concern (i.e. no options are - specified). This method is primarily intended to be used in conjunction with - MongoDB\Driver\Manager::getWriteConcern to determine - whether the Manager has been constructed without any write concern options. - - - The driver will not include a default write concern in its write operations - (e.g. MongoDB\Driver\Manager::executeBulkWrite) in - order to allow the server to apply its own default, which may have been - modified. - Libraries that access the Manager's write concern to include it in their own - write commands should use this method to ensure that default write concerns - are left unset. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; if this is the default write concern and &false; otherwise. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - <function>MongoDB\Driver\WriteConcern::isDefault</function> example - -isDefault()); - -$manager = new MongoDB\Driver\Manager('mongodb://127.0.0.1/?w=majority'); -$wc = $manager->getWriteConcern(); -var_dump($wc->isDefault()); - -$manager = new MongoDB\Driver\Manager('mongodb://127.0.0.1/'); -$wc = $manager->getWriteConcern(); -var_dump($wc->isDefault()); - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::getWriteConcern - Modify Default Write Concern in the MongoDB manual - Write Concern reference - - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeconcern/serialize.xml b/reference/mongodb/mongodb/driver/writeconcern/serialize.xml deleted file mode 100644 index 01739f932..000000000 --- a/reference/mongodb/mongodb/driver/writeconcern/serialize.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - MongoDB\Driver\WriteConcern::serialize - Serialize a WriteConcern - - - - &reftitle.description; - - final public stringMongoDB\Driver\WriteConcern::serialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the serialized representation of the - MongoDB\Driver\WriteConcern. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\WriteConcern::unserialize - serialize - Serializing Objects - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeconcern/unserialize.xml b/reference/mongodb/mongodb/driver/writeconcern/unserialize.xml deleted file mode 100644 index f3412bba9..000000000 --- a/reference/mongodb/mongodb/driver/writeconcern/unserialize.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - MongoDB\Driver\WriteConcern::unserialize - Unserialize a WriteConcern - - - - &reftitle.description; - - final public voidMongoDB\Driver\WriteConcern::unserialize - stringserialized - - - - - &reftitle.parameters; - - - - serialized - - - The serialized MongoDB\Driver\WriteConcern. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\UnexpectedValueException if the properties cannot be unserialized (i.e. serialized was malformed). - Throws MongoDB\Driver\Exception\InvalidArgumentException if the properties are invalid (e.g. missing fields or invalid values). - - - - - &reftitle.seealso; - - MongoDB\Driver\WriteConcern::serialize - unserialize - Serializing Objects - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeconcernerror.xml b/reference/mongodb/mongodb/driver/writeconcernerror.xml deleted file mode 100644 index c287a51f5..000000000 --- a/reference/mongodb/mongodb/driver/writeconcernerror.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - The MongoDB\Driver\WriteConcernError class - MongoDB\Driver\WriteConcernError - - - - -
- &reftitle.intro; - - The MongoDB\Driver\WriteConcernError class - encapsulates information about a write concern error and may be returned by - MongoDB\Driver\WriteResult::getWriteConcernError. - -
- - -
- &reftitle.classsynopsis; - - - - MongoDB\Driver\WriteConcernError - - - - final - - MongoDB\Driver\WriteConcernError - - - - - &Methods; - - - - -
- - - - &reference.mongodb.mongodb.driver.entities.writeconcernerror; - - - - diff --git a/reference/mongodb/mongodb/driver/writeconcernerror/getcode.xml b/reference/mongodb/mongodb/driver/writeconcernerror/getcode.xml deleted file mode 100644 index 35616d971..000000000 --- a/reference/mongodb/mongodb/driver/writeconcernerror/getcode.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - MongoDB\Driver\WriteConcernError::getCode - Returns the WriteConcernError's error code - - - - &reftitle.description; - - final public intMongoDB\Driver\WriteConcernError::getCode - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the WriteConcernError's error code. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\WriteConcernError::getCode</function> example - -insert(['x' => 1]); - -$writeConcern = new MongoDB\Driver\WriteConcern(2, 1); - -try { - $manager->executeBulkWrite('db.collection', $bulk, $writeConcern); -} catch(MongoDB\Driver\Exception\BulkWriteException $e) { - var_dump($e->getWriteResult()->getWriteConcernError()->getCode()); -} - -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - Write Concern reference - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeconcernerror/getinfo.xml b/reference/mongodb/mongodb/driver/writeconcernerror/getinfo.xml deleted file mode 100644 index 51a77b2f5..000000000 --- a/reference/mongodb/mongodb/driver/writeconcernerror/getinfo.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - MongoDB\Driver\WriteConcernError::getInfo - Returns metadata document for the WriteConcernError - - - - &reftitle.description; - - final public objectnullMongoDB\Driver\WriteConcernError::getInfo - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the metadata document for the WriteConcernError, or &null; if - no metadata is available. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\WriteConcernError::getInfo</function> example - -insert(['x' => 1]); - -$writeConcern = new MongoDB\Driver\WriteConcern(2, 1); - -try { - $manager->executeBulkWrite('db.collection', $bulk, $writeConcern); -} catch(MongoDB\Driver\Exception\BulkWriteException $e) { - var_dump($e->getWriteResult()->getWriteConcernError()->getInfo()); -} - -?> -]]> - - &example.outputs.similar; - - - bool(true) -} -]]> - - - - - - - &reftitle.seealso; - - Write Concern reference - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeconcernerror/getmessage.xml b/reference/mongodb/mongodb/driver/writeconcernerror/getmessage.xml deleted file mode 100644 index 7157ccbba..000000000 --- a/reference/mongodb/mongodb/driver/writeconcernerror/getmessage.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - MongoDB\Driver\WriteConcernError::getMessage - Returns the WriteConcernError's error message - - - - &reftitle.description; - - final public stringMongoDB\Driver\WriteConcernError::getMessage - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the WriteConcernError's error message. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\WriteConcernError::getMessage</function> example - -insert(['x' => 1]); - -$writeConcern = new MongoDB\Driver\WriteConcern(2, 1); - -try { - $manager->executeBulkWrite('db.collection', $bulk, $writeConcern); -} catch(MongoDB\Driver\Exception\BulkWriteException $e) { - var_dump($e->getWriteResult()->getWriteConcernError()->getMessage()); -} - -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - Write Concern reference - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeerror.xml b/reference/mongodb/mongodb/driver/writeerror.xml deleted file mode 100644 index a4435a92b..000000000 --- a/reference/mongodb/mongodb/driver/writeerror.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - The MongoDB\Driver\WriteError class - MongoDB\Driver\WriteError - - - - -
- &reftitle.intro; - - The MongoDB\Driver\WriteError class encapsulates - information about a write error and may be returned as an array element from - MongoDB\Driver\WriteResult::getWriteErrors. - -
- - -
- &reftitle.classsynopsis; - - - - MongoDB\Driver\WriteError - - - - final - - MongoDB\Driver\WriteError - - - - - &Methods; - - - - -
- - - - &reference.mongodb.mongodb.driver.entities.writeerror; - - - - diff --git a/reference/mongodb/mongodb/driver/writeerror/getcode.xml b/reference/mongodb/mongodb/driver/writeerror/getcode.xml deleted file mode 100644 index c25f8bcfa..000000000 --- a/reference/mongodb/mongodb/driver/writeerror/getcode.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - MongoDB\Driver\WriteError::getCode - Returns the WriteError's error code - - - - &reftitle.description; - - final public intMongoDB\Driver\WriteError::getCode - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the WriteError's error code. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\WriteError::getCode</function> example - -insert(['_id' => 1]); -$bulk->insert(['_id' => 1]); - -try { - $manager->executeBulkWrite('db.collection', $bulk); -} catch(MongoDB\Driver\Exception\BulkWriteException $e) { - var_dump($e->getWriteResult()->getWriteErrors()[0]->getCode()); -} - -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeerror/getindex.xml b/reference/mongodb/mongodb/driver/writeerror/getindex.xml deleted file mode 100644 index 047475f77..000000000 --- a/reference/mongodb/mongodb/driver/writeerror/getindex.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - MongoDB\Driver\WriteError::getIndex - Returns the index of the write operation corresponding to this WriteError - - - - &reftitle.description; - - final public intMongoDB\Driver\WriteError::getIndex - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the index of the write operation (from - MongoDB\Driver\BulkWrite) corresponding to this - WriteError. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\WriteError::getIndex</function> example - -insert(['_id' => 1]); -$bulk->insert(['_id' => 1]); - -try { - $manager->executeBulkWrite('db.collection', $bulk); -} catch(MongoDB\Driver\Exception\BulkWriteException $e) { - var_dump($e->getWriteResult()->getWriteErrors()[0]->getIndex()); -} - -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWrite - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeerror/getinfo.xml b/reference/mongodb/mongodb/driver/writeerror/getinfo.xml deleted file mode 100644 index 45ebadd8e..000000000 --- a/reference/mongodb/mongodb/driver/writeerror/getinfo.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - MongoDB\Driver\WriteError::getInfo - Returns metadata document for the WriteError - - - - &reftitle.description; - - final public objectnullMongoDB\Driver\WriteError::getInfo - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the metadata document for the WriteError, or &null; if no metadata is - available. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeerror/getmessage.xml b/reference/mongodb/mongodb/driver/writeerror/getmessage.xml deleted file mode 100644 index 77883c7f1..000000000 --- a/reference/mongodb/mongodb/driver/writeerror/getmessage.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - MongoDB\Driver\WriteError::getMessage - Returns the WriteError's error message - - - - &reftitle.description; - - final public stringMongoDB\Driver\WriteError::getMessage - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the WriteError's error message. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\WriteError::getMessage</function> example - -insert(['_id' => 1]); -$bulk->insert(['_id' => 1]); - -try { - $manager->executeBulkWrite('db.collection', $bulk); -} catch(MongoDB\Driver\Exception\BulkWriteException $e) { - var_dump($e->getWriteResult()->getWriteErrors()[0]->getMessage()); -} - -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeresult.xml b/reference/mongodb/mongodb/driver/writeresult.xml deleted file mode 100644 index 44078f2cb..000000000 --- a/reference/mongodb/mongodb/driver/writeresult.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - The MongoDB\Driver\WriteResult class - MongoDB\Driver\WriteResult - - - - -
- &reftitle.intro; - - The MongoDB\Driver\WriteResult class encapsulates - information about an executed - MongoDB\Driver\BulkWrite and may be returned by - MongoDB\Driver\Manager::executeBulkWrite. - - -
- - -
- &reftitle.classsynopsis; - - - - MongoDB\Driver\WriteResult - - - - final - - MongoDB\Driver\WriteResult - - - - - &Methods; - - - - -
- - - - &reference.mongodb.mongodb.driver.entities.writeresult; - - - - diff --git a/reference/mongodb/mongodb/driver/writeresult/getdeletedcount.xml b/reference/mongodb/mongodb/driver/writeresult/getdeletedcount.xml deleted file mode 100644 index ee7823918..000000000 --- a/reference/mongodb/mongodb/driver/writeresult/getdeletedcount.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - MongoDB\Driver\WriteResult::getDeletedCount - Returns the number of documents deleted - - - - &reftitle.description; - - final public intnullMongoDB\Driver\WriteResult::getDeletedCount - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the number of documents deleted, or &null; if the write was not - acknowledged. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\WriteResult::getDeletedCount</function> example - -insert(['x' => 1]); -$bulk->update(['x' => 1], ['$set' => ['y' => 3]]); -$bulk->update(['x' => 2], ['$set' => ['y' => 1]], ['upsert' => true]); -$bulk->update(['x' => 3], ['$set' => ['y' => 2]], ['upsert' => true]); -$bulk->delete(['x' => 1]); - -$result = $manager->executeBulkWrite('db.collection', $bulk); - -var_dump($result->getDeletedCount()); - -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\WriteResult::isAcknowledged - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeresult/getinsertedcount.xml b/reference/mongodb/mongodb/driver/writeresult/getinsertedcount.xml deleted file mode 100644 index b4eb359e9..000000000 --- a/reference/mongodb/mongodb/driver/writeresult/getinsertedcount.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - MongoDB\Driver\WriteResult::getInsertedCount - Returns the number of documents inserted (excluding upserts) - - - - &reftitle.description; - - final public intnullMongoDB\Driver\WriteResult::getInsertedCount - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the number of documents inserted (excluding upserts), or &null; if - the write was not acknowledged. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\WriteResult::getInsertedCount</function> example - -insert(['x' => 1]); -$bulk->update(['x' => 1], ['$set' => ['y' => 3]]); -$bulk->update(['x' => 2], ['$set' => ['y' => 1]], ['upsert' => true]); -$bulk->update(['x' => 3], ['$set' => ['y' => 2]], ['upsert' => true]); -$bulk->delete(['x' => 1]); - -$result = $manager->executeBulkWrite('db.collection', $bulk); - -var_dump($result->getInsertedCount()); - -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\WriteResult::isAcknowledged - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeresult/getmatchedcount.xml b/reference/mongodb/mongodb/driver/writeresult/getmatchedcount.xml deleted file mode 100644 index 1f02b458a..000000000 --- a/reference/mongodb/mongodb/driver/writeresult/getmatchedcount.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - MongoDB\Driver\WriteResult::getMatchedCount - Returns the number of documents selected for update - - - - &reftitle.description; - - final public intnullMongoDB\Driver\WriteResult::getMatchedCount - - - - If the update operation results in no change to the document (e.g. setting - the value of a field to its current value), the matched count may be greater - than the value returned by - MongoDB\Driver\WriteResult::getModifiedCount. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the number of documents selected for update, or &null; if the write - was not acknowledged. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\WriteResult::getMatchedCount</function> example - -insert(['x' => 1]); -$bulk->update(['x' => 1], ['$set' => ['y' => 3]]); -$bulk->update(['x' => 2], ['$set' => ['y' => 1]], ['upsert' => true]); -$bulk->update(['x' => 3], ['$set' => ['y' => 2]], ['upsert' => true]); -$bulk->delete(['x' => 1]); - -$result = $manager->executeBulkWrite('db.collection', $bulk); - -var_dump($result->getMatchedCount()); - -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\WriteResult::getModifiedCount - MongoDB\Driver\WriteResult::isAcknowledged - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeresult/getmodifiedcount.xml b/reference/mongodb/mongodb/driver/writeresult/getmodifiedcount.xml deleted file mode 100644 index 6c919bf16..000000000 --- a/reference/mongodb/mongodb/driver/writeresult/getmodifiedcount.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - MongoDB\Driver\WriteResult::getModifiedCount - Returns the number of existing documents updated - - - - &reftitle.description; - - final public intnullMongoDB\Driver\WriteResult::getModifiedCount - - - - If the update operation results in no change to the document (e.g. setting - the value of a field to its current value), the modified count may be less - than the value returned by - MongoDB\Driver\WriteResult::getMatchedCount. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the number of existing documents updated, or &null; if the write was - not acknowledged. - - - The modified count is not available on versions of MongoDB before 2.6, which - used the legacy wire protocol version (i.e. OP_UPDATE). If this is the case, - the modified count will also be &null;. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\WriteResult::getModifiedCount</function> example - -insert(['x' => 1]); -$bulk->update(['x' => 1], ['$set' => ['y' => 3]]); -$bulk->update(['x' => 2], ['$set' => ['y' => 1]], ['upsert' => true]); -$bulk->update(['x' => 3], ['$set' => ['y' => 2]], ['upsert' => true]); -$bulk->delete(['x' => 1]); - -$result = $manager->executeBulkWrite('db.collection', $bulk); - -var_dump($result->getModifiedCount()); - -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\WriteResult::getMatchedCount - MongoDB\Driver\WriteResult::isAcknowledged - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeresult/getserver.xml b/reference/mongodb/mongodb/driver/writeresult/getserver.xml deleted file mode 100644 index 76b66a298..000000000 --- a/reference/mongodb/mongodb/driver/writeresult/getserver.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - MongoDB\Driver\WriteResult::getServer - Returns the server associated with this write result - - - - &reftitle.description; - - final public MongoDB\Driver\ServerMongoDB\Driver\WriteResult::getServer - - - - Returns the MongoDB\Driver\Server associated with this - write result. This is the server that executed the - MongoDB\Driver\BulkWrite. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the MongoDB\Driver\Server associated with this - write result. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\WriteResult::getServer</function> example - -selectServer(new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::RP_PRIMARY)); - -$bulk = new MongoDB\Driver\BulkWrite; -$bulk->insert(['x' => 1]); - -$result = $server->executeBulkWrite('db.collection', $bulk); - -var_dump($result->getServer() == $server); - -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Server - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeresult/getupsertedcount.xml b/reference/mongodb/mongodb/driver/writeresult/getupsertedcount.xml deleted file mode 100644 index c0a3c495d..000000000 --- a/reference/mongodb/mongodb/driver/writeresult/getupsertedcount.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - MongoDB\Driver\WriteResult::getUpsertedCount - Returns the number of documents inserted by an upsert - - - - &reftitle.description; - - final public intnullMongoDB\Driver\WriteResult::getUpsertedCount - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the number of documents inserted by an upsert. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\WriteResult::getUpsertedCount</function> example - -insert(['x' => 1]); -$bulk->update(['x' => 1], ['$set' => ['y' => 3]]); -$bulk->update(['x' => 2], ['$set' => ['y' => 1]], ['upsert' => true]); -$bulk->update(['x' => 3], ['$set' => ['y' => 2]], ['upsert' => true]); -$bulk->delete(['x' => 1]); - -$result = $manager->executeBulkWrite('db.collection', $bulk); - -var_dump($result->getUpsertedCount()); - -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\WriteResult::getUpsertedIds - MongoDB\Driver\WriteResult::isAcknowledged - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeresult/getupsertedids.xml b/reference/mongodb/mongodb/driver/writeresult/getupsertedids.xml deleted file mode 100644 index 3cb9152a4..000000000 --- a/reference/mongodb/mongodb/driver/writeresult/getupsertedids.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - MongoDB\Driver\WriteResult::getUpsertedIds - Returns an array of identifiers for upserted documents - - - - &reftitle.description; - - final public arrayMongoDB\Driver\WriteResult::getUpsertedIds - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an array of identifiers (i.e. "_id" field values) - for upserted documents. The array keys will correspond to the index of the - write operation (from MongoDB\Driver\BulkWrite) - responsible for the upsert. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\WriteResult::getUpsertedIds</function> example - -insert(['x' => 1]); -$bulk->update(['x' => 1], ['$set' => ['y' => 3]]); -$bulk->update(['x' => 2], ['$set' => ['y' => 1]], ['upsert' => true]); -$bulk->update(['x' => 3], ['$set' => ['y' => 2]], ['upsert' => true]); -$bulk->delete(['x' => 1]); - -$result = $manager->executeBulkWrite('db.collection', $bulk); - -var_dump($result->getUpsertedIds()); - -?> -]]> - - &example.outputs.similar; - - - object(MongoDB\BSON\ObjectId)#4 (1) { - ["oid"]=> - string(24) "580e62a224f2302f191b880b" - } - [3]=> - object(MongoDB\BSON\ObjectId)#5 (1) { - ["oid"]=> - string(24) "580e62a224f2302f191b880c" - } -} -]]> - - - - - - - &reftitle.seealso; - - MongoDB\Driver\WriteResult::getUpsertedCount - MongoDB\Driver\WriteResult::isAcknowledged - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeresult/getwriteconcernerror.xml b/reference/mongodb/mongodb/driver/writeresult/getwriteconcernerror.xml deleted file mode 100644 index 39f345c81..000000000 --- a/reference/mongodb/mongodb/driver/writeresult/getwriteconcernerror.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - MongoDB\Driver\WriteResult::getWriteConcernError - Returns any write concern error that occurred - - - - &reftitle.description; - - final public MongoDB\Driver\WriteConcernErrornullMongoDB\Driver\WriteResult::getWriteConcernError - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a MongoDB\Driver\WriteConcernError if a write - concern error was encountered during the write operation, and &null; - otherwise. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\WriteResult::getWriteConcernError</function> example - -insert(['x' => 1]); - -$writeConcern = new MongoDB\Driver\WriteConcern(2, 1); - -try { - $manager->executeBulkWrite('db.collection', $bulk, $writeConcern); -} catch(MongoDB\Driver\Exception\BulkWriteException $e) { - var_dump($e->getWriteResult()->getWriteConcernError()); -} - -?> -]]> - - &example.outputs.similar; - - - string(33) "waiting for replication timed out" - ["code"]=> - int(64) - ["info"]=> - object(stdClass)#7 (1) { - ["wtimeout"]=> - bool(true) - } -} -]]> - - - - - - - &reftitle.seealso; - - MongoDB\Driver\WriteConcern - Write Concern reference - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeresult/getwriteerrors.xml b/reference/mongodb/mongodb/driver/writeresult/getwriteerrors.xml deleted file mode 100644 index 5107ed30c..000000000 --- a/reference/mongodb/mongodb/driver/writeresult/getwriteerrors.xml +++ /dev/null @@ -1,182 +0,0 @@ - - - - - - MongoDB\Driver\WriteResult::getWriteErrors - Returns any write errors that occurred - - - - &reftitle.description; - - final public arrayMongoDB\Driver\WriteResult::getWriteErrors - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an array of MongoDB\Driver\WriteError objects - for any write errors encountered during the write operation. The array will - be empty if no write errors occurred. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\WriteResult::getWriteErrors</function> with a single error - -insert(['_id' => 1]); -$bulk->insert(['_id' => 2]); -$bulk->insert(['_id' => 2]); -$bulk->insert(['_id' => 3]); -$bulk->insert(['_id' => 4]); -$bulk->insert(['_id' => 4]); - -try { - $result = $manager->executeBulkWrite('db.collection', $bulk); -} catch (MongoDB\Driver\Exception\BulkWriteException $e) { - var_dump($e->getWriteResult()->getWriteErrors()); -} - -?> -]]> - - &example.outputs.similar; - - - object(MongoDB\Driver\WriteError)#5 (4) { - ["message"]=> - string(81) "E11000 duplicate key error collection: db.collection index: _id_ dup key: { : 2 }" - ["code"]=> - int(11000) - ["index"]=> - int(2) - ["info"]=> - NULL - } -} -]]> - - - - <function>MongoDB\Driver\WriteResult::getWriteErrors</function> with multiple errors - - false]); -$bulk->insert(['_id' => 1]); -$bulk->insert(['_id' => 2]); -$bulk->insert(['_id' => 2]); -$bulk->insert(['_id' => 3]); -$bulk->insert(['_id' => 4]); -$bulk->insert(['_id' => 4]); - -try { - $result = $manager->executeBulkWrite('db.collection', $bulk); -} catch (MongoDB\Driver\Exception\BulkWriteException $e) { - var_dump($e->getWriteResult()->getWriteErrors()); -} - -?> -]]> - - &example.outputs.similar; - - - object(MongoDB\Driver\WriteError)#5 (4) { - ["message"]=> - string(81) "E11000 duplicate key error collection: db.collection index: _id_ dup key: { : 2 }" - ["code"]=> - int(11000) - ["index"]=> - int(2) - ["info"]=> - NULL - } - [1]=> - object(MongoDB\Driver\WriteError)#6 (4) { - ["message"]=> - string(81) "E11000 duplicate key error collection: db.collection index: _id_ dup key: { : 4 }" - ["code"]=> - int(11000) - ["index"]=> - int(5) - ["info"]=> - NULL - } -} -]]> - - - - - - - &reftitle.seealso; - - MongoDB\Driver\WriteError - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeresult/isacknowledged.xml b/reference/mongodb/mongodb/driver/writeresult/isacknowledged.xml deleted file mode 100644 index c669257b8..000000000 --- a/reference/mongodb/mongodb/driver/writeresult/isacknowledged.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - MongoDB\Driver\WriteResult::isAcknowledged - Returns whether the write was acknowledged - - - - &reftitle.description; - - final public boolMongoDB\Driver\WriteResult::isAcknowledged - - - - If the write is acknowledged, other count fields will be available on the - MongoDB\Driver\WriteResult object. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; if the write was acknowledged, and &false; otherwise. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\WriteResult::isAcknowledged</function> with acknowledged write concern - -insert(['x' => 1]); - -$result = $manager->executeBulkWrite('db.collection', $bulk); - -var_dump($result->isAcknowledged()); - -?> -]]> - - &example.outputs; - - - - - - <function>MongoDB\Driver\WriteResult::isAcknowledged</function> with unacknowledged write concern - -insert(['x' => 1]); - -$result = $manager->executeBulkWrite('db.collection', $bulk, new MongoDB\Driver\WriteConcern(0)); - -var_dump($result->isAcknowledged()); - -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\WriteConcern - Write Concern reference - - - - - - diff --git a/reference/mongodb/mongodb/entities.driver.xml b/reference/mongodb/mongodb/entities.driver.xml deleted file mode 100644 index f07800864..000000000 --- a/reference/mongodb/mongodb/entities.driver.xml +++ /dev/null @@ -1,38 +0,0 @@ -&reference.mongodb.mongodb.driver.bulkwrite; -&reference.mongodb.mongodb.driver.clientencryption; -&reference.mongodb.mongodb.driver.command; -&reference.mongodb.mongodb.driver.cursor; -&reference.mongodb.mongodb.driver.cursorid; -&reference.mongodb.mongodb.driver.cursorinterface; -&reference.mongodb.mongodb.driver.entities.bulkwrite; -&reference.mongodb.mongodb.driver.entities.clientencryption; -&reference.mongodb.mongodb.driver.entities.command; -&reference.mongodb.mongodb.driver.entities.cursor; -&reference.mongodb.mongodb.driver.entities.cursorid; -&reference.mongodb.mongodb.driver.entities.cursorinterface; -&reference.mongodb.mongodb.driver.entities.exception; -&reference.mongodb.mongodb.driver.entities.manager; -&reference.mongodb.mongodb.driver.entities.monitoring; -&reference.mongodb.mongodb.driver.entities.query; -&reference.mongodb.mongodb.driver.entities.readconcern; -&reference.mongodb.mongodb.driver.entities.readpreference; -&reference.mongodb.mongodb.driver.entities.server; -&reference.mongodb.mongodb.driver.entities.serverapi; -&reference.mongodb.mongodb.driver.entities.session; -&reference.mongodb.mongodb.driver.entities.writeconcern; -&reference.mongodb.mongodb.driver.entities.writeconcernerror; -&reference.mongodb.mongodb.driver.entities.writeerror; -&reference.mongodb.mongodb.driver.entities.writeresult; -&reference.mongodb.mongodb.driver.manager; -&reference.mongodb.mongodb.driver.query; -&reference.mongodb.mongodb.driver.readconcern; -&reference.mongodb.mongodb.driver.readpreference; -&reference.mongodb.mongodb.driver.server; -&reference.mongodb.mongodb.driver.serverapi; -&reference.mongodb.mongodb.driver.serverdescription; -&reference.mongodb.mongodb.driver.session; -&reference.mongodb.mongodb.driver.topologydescription; -&reference.mongodb.mongodb.driver.writeconcern; -&reference.mongodb.mongodb.driver.writeconcernerror; -&reference.mongodb.mongodb.driver.writeerror; -&reference.mongodb.mongodb.driver.writeresult; diff --git a/reference/mongodb/setup.xml b/reference/mongodb/setup.xml deleted file mode 100644 index 8000267b7..000000000 --- a/reference/mongodb/setup.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - - &reftitle.setup; - -
- &reftitle.required; - - La variante de PHP del controlador requiere PHP 5.4 o superior. - - - La variante de HHVM del controlador requiere HHVM 3.9 o superior. - -
- - &reference.mongodb.configure; - &reference.mongodb.ini; - - &reference.mongodb.constants; - - - - diff --git a/reference/mysqli/versions.xml b/reference/mysqli/versions.xml deleted file mode 100644 index c9030861d..000000000 --- a/reference/mysqli/versions.xml +++ /dev/null @@ -1,178 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/opcache/entities.functions.xml b/reference/opcache/entities.functions.xml deleted file mode 100644 index a239af28f..000000000 --- a/reference/opcache/entities.functions.xml +++ /dev/null @@ -1,6 +0,0 @@ -&reference.opcache.functions.opcache-compile-file; -&reference.opcache.functions.opcache-get-configuration; -&reference.opcache.functions.opcache-get-status; -&reference.opcache.functions.opcache-invalidate; -&reference.opcache.functions.opcache-is-script-cached; -&reference.opcache.functions.opcache-reset; diff --git a/reference/opcache/functions/opcache-compile-file.xml b/reference/opcache/functions/opcache-compile-file.xml deleted file mode 100644 index db3e98fe8..000000000 --- a/reference/opcache/functions/opcache-compile-file.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - opcache_compile_file - Compiles and caches a PHP script without executing it - - - - &reftitle.description; - - boolopcache_compile_file - stringfilename - - - This function compiles a PHP script and adds it to the opcode cache without - executing it. This can be used to prime the cache after a Web server - restart by pre-caching files that will be included in later requests. - - - - - &reftitle.parameters; - - - filename - - - The path to the PHP script to be compiled. - - - - - - - - &reftitle.returnvalues; - - Returns &true; if filename was compiled successfully - &return.falseforfailure;. - - - - - &reftitle.errors; - - If filename cannot be loaded or compiled, an error of - level E_WARNING is generated. You may use - @ to suppress this - warning. - - - - - &reftitle.seealso; - - - opcache_invalidate - - - - - diff --git a/reference/opcache/functions/opcache-get-configuration.xml b/reference/opcache/functions/opcache-get-configuration.xml deleted file mode 100644 index 6556dc9c5..000000000 --- a/reference/opcache/functions/opcache-get-configuration.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - opcache_get_configuration - Get configuration information about the cache - - - - &reftitle.description; - - arrayfalseopcache_get_configuration - - - - This function returns configuration information about the cache instance - - - - - &reftitle.returnvalues; - - Returns an array of information, including ini, blacklist and version - - - - - &reftitle.errors; - - If opcache.restrict_api is in use and the current path - is in violation of the rule, an E_WARNING will be raised; no status information will - be returned. - - - - - &reftitle.seealso; - - - opcache_get_status - - - - - - diff --git a/reference/opcache/functions/opcache-get-status.xml b/reference/opcache/functions/opcache-get-status.xml deleted file mode 100644 index 8ca42f336..000000000 --- a/reference/opcache/functions/opcache-get-status.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - opcache_get_status - Get status information about the cache - - - - &reftitle.description; - - arrayfalseopcache_get_status - boolinclude_scripts&true; - - - This function returns state information about the cache instance - - - - - &reftitle.parameters; - - - include_scripts - - - Include script specific state information - - - - - - - - &reftitle.returnvalues; - - Returns an array of information, optionally containing script specific state information, - &return.falseforfailure;. - - - - - &reftitle.errors; - - If opcache.restrict_api is in use and the current path - is in violation of the rule, an E_WARNING will be raised; no status information will - be returned. - - - - - &reftitle.seealso; - - - opcache_get_configuration - - - - - - diff --git a/reference/opcache/functions/opcache-invalidate.xml b/reference/opcache/functions/opcache-invalidate.xml deleted file mode 100644 index 985078868..000000000 --- a/reference/opcache/functions/opcache-invalidate.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - opcache_invalidate - Invalidates a cached script - - - - &reftitle.description; - - boolopcache_invalidate - stringfilename - boolforce&false; - - - This function invalidates a particular script from the opcode cache. If - force is unset or &false;, the script will only be - invalidated if the modification time of the script is newer than the cached - opcodes. - - - - - &reftitle.parameters; - - - filename - - - The path to the script being invalidated. - - - - - force - - - If set to &true;, the script will be invalidated regardless of whether - invalidation is necessary. - - - - - - - - &reftitle.returnvalues; - - Returns &true; if the opcode cache for filename was - invalidated or if there was nothing to invalidate, or &false; if the opcode - cache is disabled. - - - - - &reftitle.seealso; - - - opcache_compile_file - opcache_reset - - - - - diff --git a/reference/opcache/functions/opcache-is-script-cached.xml b/reference/opcache/functions/opcache-is-script-cached.xml deleted file mode 100644 index f71417da7..000000000 --- a/reference/opcache/functions/opcache-is-script-cached.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - opcache_is_script_cached - Tells whether a script is cached in OPCache - - - - &reftitle.description; - - boolopcache_is_script_cached - stringfilename - - - This function checks if a PHP script has been cached in OPCache. This can be - used to more easily detect the "warming" of the cache for a particular script. - - - - - &reftitle.parameters; - - - filename - - - The path to the PHP script to be checked. - - - - - - - - &reftitle.returnvalues; - - Returns &true; if filename is cached in OPCache, - &false; otherwise. - - - - - &reftitle.seealso; - - - opcache_compile_file - - - - - diff --git a/reference/opcache/functions/opcache-reset.xml b/reference/opcache/functions/opcache-reset.xml deleted file mode 100644 index 21469c398..000000000 --- a/reference/opcache/functions/opcache-reset.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - opcache_reset - Resets the contents of the opcode cache - - - - &reftitle.description; - - boolopcache_reset - - - - This function resets the entire opcode cache. After calling - opcache_reset, all scripts will be reloaded and - reparsed the next time they are hit. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; if the opcode cache was reset, or &false; if the opcode - cache is disabled. - - - - - &reftitle.seealso; - - - opcache_invalidate - - - - - - diff --git a/reference/opcache/preload.xml b/reference/opcache/preload.xml deleted file mode 100644 index c8e14b5c5..000000000 --- a/reference/opcache/preload.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - Preloading - - - As of PHP 7.4.0, PHP can be configured to preload scripts into the opcache when the engine - starts. Any symbols (functions, classes, etc.) in those files will then become - globally available for all requests without needing to be explicitly included. That trades - convenience and performance (because the code is always available) for baseline memory usage. It also - requires restarting the PHP process to clear pre-loaded scripts, meaning this feature is - only practical to use in production, not in a development environment. - - - - Note that the optimal tradeoff between performance and memory may vary with the application. - "Preload everything" may be the easiest strategy, but not necessarily the best strategy. Additionally, - preloading is only useful when there is a persistent process from one request to another. That means - while it can work in a CLI script if the opcache is enabled, it's generally pointless. The exception - is when using preloading on FFI libraries. - - - - - Preloading is not supported on Windows. - - - - - Configuring preloading involves two steps, and requires that the opcache be enabled. - First, set the opcache.preload - value in &php.ini;: - - - - - - - - - - preload.php is an arbitrary file that will run once at server startup - (PHP-FPM, mod_php, etc.) and load code into persistent memory. If PHP will be run as - root (not recommended), the opcache.preload_user - value can specify an alternate system user to run the preloading. Running preloading as - root is not allowed. - - - - In the preload.php script, any file referenced by include, - include_once, require, require_once, or - opcache_compile_file will be parsed into persistent memory. In the following example, - all .php files in the src directory will be preloaded, unless they - are a Test file. - - - - - $file) { - require_once($file[0]); -} -?> -]]> - - - - - Both include and opcache_compile_file will work, but have different - implications for how code gets handled. - - - include will execute code in the file, - while opcache_compile_file will not. That means only the former supports - conditional declaration (functions declared inside an if-block). - Because include will execute code, nested included - files will also be parsed and their declarations preloaded. - opcache_compile_file can load files in any order. That is, if - a.php defines class A and b.php defines class - B that extends A, then opcache_compile_file can - load those two files in any order. When using include, however, a.php - must be included first. - In either case, if a later script includes a file that has already been preloaded then - its contents will still execute, but any symbols it defines will not be re-defined. Using - include_once will not prevent the file from being included a second time. - - - Which approach is better therefore depends on the desired behavior. With code that would otherwise use an - autoloader, opcache_compile_file allows for greater flexibility. With code that would - otherwise be loaded manually, include will be more robust. - - - - - diff --git a/reference/openssl/versions.xml b/reference/openssl/versions.xml deleted file mode 100644 index 8af51887a..000000000 --- a/reference/openssl/versions.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/parallel/book.developer.xml b/reference/parallel/book.developer.xml deleted file mode 100644 index 429dabe5a..000000000 --- a/reference/parallel/book.developer.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - -%xhtml-lat1; -%xhtml-symbol; -%xhtml-special; -%isopub; - - - - - - -%language-defs.default; -%extensions.default; -%language-snippets.default; - - - - - - - - - -%global.entities; -%file.entities; -%frontpage.entities; -]> - - - Parallel - Parallel - - - &reftitle.intro; - - - - - - &reference.parallel.setup; - &reference.parallel.constants; - &reference.parallel.examples; - &reference.parallel.reference; - - - - - diff --git a/reference/parallel/book.xml b/reference/parallel/book.xml deleted file mode 100644 index 7fddce853..000000000 --- a/reference/parallel/book.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - parallel - parallel - - - &reftitle.intro; - - parallel is a parallel concurrency extension for PHP 7.2+. - - - A brief description of the concepts core to parallel follows, more detailed information may be found within this section of the manual. - - - Runtime - - A parallel\Runtime represents a PHP interpreter thread. A parallel\Runtime is configured with an optional bootstrap file passed to parallel\Runtime::__construct, this is typically an autoloader, - or some other preloading routine: The bootstrap file will be included before any task is executed. - - - After construction the parallel\Runtime remains available until it is closed, killed, or destroyed by the normal scoping rules of PHP objects. - parallel\Runtime::run allows the programmer to schedule tasks for execution in parallel. - A parallel\Runtime has a FIFO schedule, tasks will be executed in the order that they are scheduled. - - - - Functional API - - parallel implements a functional, higher level API on top of parallel\Runtime that provides a single function entry point to executing parallel code - with automatic scheduling: parallel\run. - - - - Task - - A task is simply a Closure intended for parallel execution. The Closure may contain almost any instruction, including nested closures. - However, there are some instructions that are prohibited in tasks: - - - yield - - - use by-reference - - - declare class - - - declare named function - - - - - - Nested closures may yield or use by-reference, but must not contain class or named function declarations. - - - - - No instructions are prohibited in the files which the task may include. - - - - - Future - - The parallel\Future is used to access the return value from the task, and exposes an API for cancellation of the task. - - - - Channel - - A task may be scheduled with arguments, use lexical scope variables (by-value), and return a value (via a parallel\Future), but these only allow uni-directional communication: - They allow the programmer to send data into and retrieve data from a task, but do not allow bi-directional communication between tasks. - The parallel\Channel API allows bi-directional communication between tasks, a parallel\Channel is a socket-like link between tasks that the programmer can use to send and receive data. - - - - Events - - The parallel\Events API implements a native feel (Traversable) event loop, and parallel\Events::poll method. - It allows the programmer to work with sets of channels and or futures. - The programmer simply adds channels and futures to the event loop, optionally setting the input for writes with parallel\Events::setInput, - and enters into a foreach: parallel will read from and write to objects as they become available yielding parallel\Events\Event objects - describing the operations that have occurred. - - - - &reftitle.seealso; - - - - - - - &reference.parallel.setup; - &reference.parallel.philosophy; - &reference.parallel.functional; - &reference.parallel.parallel.runtime; - &reference.parallel.parallel.future; - &reference.parallel.parallel.channel; - &reference.parallel.parallel.events; - &reference.parallel.parallel.events.input; - &reference.parallel.parallel.events.event; - &reference.parallel.parallel.events.event.type; - - &reference.parallel.parallel.sync; - - - - - diff --git a/reference/parallel/configure.xml b/reference/parallel/configure.xml deleted file mode 100644 index 02c1a4aba..000000000 --- a/reference/parallel/configure.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - -
- &reftitle.install; - - - Use when compiling PHP. - - - - Windows users should include php_parallel.dll into &php.ini; - - -
- - - diff --git a/reference/parallel/functional.xml b/reference/parallel/functional.xml deleted file mode 100644 index 4bc76702e..000000000 --- a/reference/parallel/functional.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - Functional API - - - The parallel\Runtime API provides a great degree of control to the power PHP programmer, and those intimately familiar with writing applications that use - parallel concurrency. - - - The functional API provides less control in exchange for the ability to make decisions for the programmer: - - - all executing runtimes are bootstrapped identically - - - scheduling is determined by the API, not the programmer - - - parallel\run provides the guarantee that the task will begin to execute in parallel as soon as allowed by hardware and operating system constraints, without - needlessly creating runtimes. For most applications the functional API should be preferred. - - - - &reference.parallel.functions.parallel.bootstrap; - &reference.parallel.functions.parallel.run; - - - diff --git a/reference/parallel/functions/parallel.bootstrap.xml b/reference/parallel/functions/parallel.bootstrap.xml deleted file mode 100644 index 8542f99eb..000000000 --- a/reference/parallel/functions/parallel.bootstrap.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - parallel\bootstrap - Bootstrapping - - - - &reftitle.description; - - voidparallel\bootstrap - stringfile - - - Shall use the provided file to bootstrap all runtimes created for automatic scheduling via parallel\run. - - - - - &reftitle.parameters; - - - - file - - - Path to the file to bootstrap all runtimes. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - - Shall throw parallel\Runtime\Error\Bootstrap if previously called for this process. - - - - - Shall throw parallel\Runtime\Error\Bootstrap if called after parallel\run. - - - - - - &reftitle.seealso; - - - - - - - diff --git a/reference/parallel/functions/parallel.run.xml b/reference/parallel/functions/parallel.run.xml deleted file mode 100644 index 433ecbeb2..000000000 --- a/reference/parallel/functions/parallel.run.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - parallel\run - Execution - - - - &reftitle.description; - - Futurenullparallel\run - Closuretask - - - Shall schedule task for execution in parallel. - - - Futurenullparallel\run - Closuretask - arrayargv - - - Shall schedule task for execution in parallel, passing argv at execution time. - - - - - Automatic Scheduling - - If a \parallel\Runtime internally created and cached by a previous call to parallel\run is idle, - it will be used to execute the task. If no \parallel\Runtime is idle parallel will create and cache a - \parallel\Runtime. - - - - \parallel\Runtime objects created by the programmer are not used for automatic scheduling. - - - - - - - - - - - - - &reftitle.seealso; - - - - - - - diff --git a/reference/parallel/parallel.channel.xml b/reference/parallel/parallel.channel.xml deleted file mode 100644 index cf518a855..000000000 --- a/reference/parallel/parallel.channel.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - The parallel\Channel class - parallel\Channel - - -
- Unbuffered Channels - - An unbuffered channel will block on calls to parallel\Channel::send until there is a receiver, and block on calls to - parallel\Channel::recv until there is a sender. This means an unbuffered channel is not only a way to share data among tasks - but also a simple method of synchronization. - - - An unbuffered channel is the fastest way to share data among tasks, requiring the least copying. - -
- -
- Buffered Channels - - A buffered channel will not block on calls to parallel\Channel::send until capacity is reached, calls to - parallel\Channel::recv will block until there is data in the buffer. - -
- -
- Closures over Channels - - A powerful feature of parallel channels is that they allow the exchange of closures between tasks (and runtimes). - - - When a closure is sent over a channel the closure is buffered, it doesn't change the buffering of the channel transmitting the closure, - but it does effect the static scope inside the closure: The same closure sent to different runtimes, or the same runtime, - will not share their static scope. - - - This means that whenever a closure is executed that was transmitted by a channel, static state will be as it was when the closure was buffered. - -
- -
- Anonymous Channels - - The anonymous channel constructor allows the programmer to avoid assigning names to every channel: parallel will generate a unique name for anonymous - channels. - -
- -
- &reftitle.classsynopsis; - - - - parallel\Channel - - - - - final - parallel\Channel - - - - - Anonymous Constructor - - - - - Access - - - - - Sharing - - - - - Closing - - - - - Constant for Infinitely Buffered - - const - Infinite - - - - - -
- - - - &reference.parallel.parallel.channel.construct; - &reference.parallel.parallel.channel.make; - &reference.parallel.parallel.channel.open; - &reference.parallel.parallel.channel.recv; - &reference.parallel.parallel.channel.send; - &reference.parallel.parallel.channel.close; - - - - diff --git a/reference/parallel/parallel.events.event.type.xml b/reference/parallel/parallel.events.event.type.xml deleted file mode 100644 index 5fddce4ba..000000000 --- a/reference/parallel/parallel.events.event.type.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - The parallel\Events\Event\Type class - parallel\Events\Event\Type - - - -
- &reftitle.classsynopsis; - - - - parallel\Events\Event\Type - - - - - final - parallel\Events\Event\Type - - - - - Event::$object was read into Event::$value - - const - Read - - - Input for Event::$source written to Event::$object - - const - Write - - - Event::$object (Channel) was closed - - const - Close - - - Event::$object (Future) was cancelled - - const - Cancel - - - Runtime executing Event::$object (Future) was killed - - const - Kill - - - Event::$object (Future) raised error - - const - Error - - - - - -
- - - - - - diff --git a/reference/parallel/parallel.events.event.xml b/reference/parallel/parallel.events.event.xml deleted file mode 100644 index 08055995f..000000000 --- a/reference/parallel/parallel.events.event.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - The parallel\Events\Event class - parallel\Events\Event - - - -
- Event Objects - - When an Event is returned, Event::$object shall be removed from the loop that returned it, should the event be a write event - the Input for Event::$source shall also be removed. - -
-
- &reftitle.classsynopsis; - - - - parallel\Events\Event - - - - - final - parallel\Events\Event - - - - - Shall be one of Event\Type constants - - public - int - type - - - Shall be the source of the event (target name) - - public - string - source - - - Shall be either Future or Channel - - public - object - object - - - Shall be set for Read/Error events - - public - value - - - - - -
- - - - - - diff --git a/reference/parallel/parallel.events.input.xml b/reference/parallel/parallel.events.input.xml deleted file mode 100644 index fe76afb8f..000000000 --- a/reference/parallel/parallel.events.input.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - The parallel\Events\Input class - parallel\Events\Input - - - -
- Events Input - - An Input object is a container for data that the parallel\Events object will write to - parallel\Channel objects as they become available. Multiple event loops may share an Input container - parallel does not - verify the contents of the container when it is set as the input for a parallel\Events object. - - - - When a parallel\Events object performs a write, the target is removed from the input object as if - parallel\Events\Input::remove were called. - - -
- -
- &reftitle.classsynopsis; - - - - parallel\Events\Input - - - - - final - parallel\Events\Input - - - - - - - - - - - - - - - - - -
- - - -&reference.parallel.parallel.entities.input; - - - - diff --git a/reference/parallel/parallel.events.xml b/reference/parallel/parallel.events.xml deleted file mode 100644 index 4a16b1686..000000000 --- a/reference/parallel/parallel.events.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - The parallel\Events class - parallel\Events - - -
- The Event Loop - - The Event loop monitors the state of sets of futures and or channels (targets) in order to perform read (parallel\Future::value, parallel\Channel::recv) and write (parallel\Channel::send) operations as the targets become available and the operations may be performed without blocking the event loop. - -
-
- &reftitle.classsynopsis; - - - - parallel\Events - - - - - final - parallel\Events - - - Countable - - - Traversable - - - - - Input - - - - - Targets - - - - - Behaviour - - - - - Polling - - - - - - -
- - - - &reference.parallel.parallel.events.setblocking; - &reference.parallel.parallel.events.settimeout; - &reference.parallel.parallel.events.setinput; - &reference.parallel.parallel.events.addchannel; - &reference.parallel.parallel.events.addfuture; - &reference.parallel.parallel.events.remove; - &reference.parallel.parallel.events.poll; - - - - diff --git a/reference/parallel/parallel.future.xml b/reference/parallel/parallel.future.xml deleted file mode 100644 index 4275c4e1e..000000000 --- a/reference/parallel/parallel.future.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - The parallel\Future class - parallel\Future - - - -
- Futures - - A Future represents the return value or uncaught exception from a task, and exposes an API for cancellation. - - - Example showing Future as return value - -run(function(){ - return "World"; -}); -printf("Hello %s\n", $future->value()); -?> -]]> - - &example.outputs.similar; - - - - - - The behaviour of a future also allows it to be used as a simple synchronization point even where the task does not return a value explicitly. - - - Example showing Future as synchronization point - -run(function(){ - echo "in child "; - for ($i = 0; $i < 500; $i++) { - if ($i % 10 == 0) { - echo "."; - } - } - echo " leaving child"; -}); - -$future->value(); -echo "\nparent continues\n"; -?> -]]> - - &example.outputs.similar; - - - - -
- -
- &reftitle.classsynopsis; - - - - parallel\Future - - - - - final - parallel\Future - - - - - Resolution - - - - - State - - - - - Cancellation - - - - - - - -
- - - - &reference.parallel.parallel.entities.future; - - - - diff --git a/reference/parallel/parallel.runtime.xml b/reference/parallel/parallel.runtime.xml deleted file mode 100644 index 462bcf53d..000000000 --- a/reference/parallel/parallel.runtime.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - The parallel\Runtime class - parallel\Runtime - - - -
- Runtime Objects - - Each runtime represents a single PHP thread, the thread is created (and bootstrapped) upon construction. - The thread then waits for tasks to be scheduled: Scheduled tasks will be executed FIFO and then the thread will resume waiting until - more tasks are scheduled, or it's closed, killed, or destroyed by the normal scoping rules of PHP objects. - - - - When a runtime is destroyed by the normal scoping rules of PHP objects, it will first execute all of the tasks that were scheduled, - and block while doing so. - - -
- -
- Runtime Bootstrapping - - When a new runtime is created, it does not share code with the thread (or process) that created it. This means it doesn't have the same - classes and functions loaded, nor the same autoloader set. In some cases, a very lightweight runtime is desirable because the tasks that - will be scheduled do not need access to the code in the parent thread. In those cases where the tasks do need to access the same code, it - is enough to set an autoloader as the bootstrap. - - - - preloading may be used in conjunction with parallel, in this case preloaded code is available without bootstrapping - - -
- -
- &reftitle.classsynopsis; - - - - parallel\Runtime - - - - - final - parallel\Runtime - - - - - Create - - - - - Execute - - - - - Join - - - - - - -
- - - - &reference.parallel.parallel.runtime.construct; - &reference.parallel.parallel.runtime.run; - &reference.parallel.parallel.runtime.close; - &reference.parallel.parallel.runtime.kill; - - - - diff --git a/reference/parallel/parallel.sync.xml b/reference/parallel/parallel.sync.xml deleted file mode 100644 index 1c4e0ef40..000000000 --- a/reference/parallel/parallel.sync.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - The parallel\Sync class - parallel\Sync - - -
- Low Level Synchronization - - The parallel\Sync class provides access to low level synchronization primitives, mutex, condition variables, and allows the implementation of semaphores. - - - - Synchronization for most applications is much better implemented using channels, however, in some cases authors of low level code may find it useful to be able to access - these lower level mechanisms. - - -
- -
- &reftitle.classsynopsis; - - - - parallel\Sync - - - - - final - parallel\Sync - - - - - Constructor - - - - - Access - - - - - Synchronization - - - - - - - -
- - - - &reference.parallel.parallel.sync.construct; - &reference.parallel.parallel.sync.get; - &reference.parallel.parallel.sync.set; - &reference.parallel.parallel.sync.wait; - &reference.parallel.parallel.sync.notify; - &reference.parallel.parallel.sync.invoke; - - - - diff --git a/reference/parallel/parallel/channel/close.xml b/reference/parallel/parallel/channel/close.xml deleted file mode 100644 index 591110324..000000000 --- a/reference/parallel/parallel/channel/close.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - parallel\Channel::close - Closing - - - - &reftitle.description; - - public voidparallel\Channel::close - - - - Shall close this channel - - - - - - Exceptions - - - Shall throw parallel\Channel\Error\Closed if channel is closed. - - - - - - - diff --git a/reference/parallel/parallel/channel/construct.xml b/reference/parallel/parallel/channel/construct.xml deleted file mode 100644 index a50376d22..000000000 --- a/reference/parallel/parallel/channel/construct.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - parallel\Channel::__construct - Channel Construction - - - - &reftitle.description; - - public parallel\Channel::__construct - - - - Shall make an anonymous unbuffered channel - - - public parallel\Channel::__construct - intcapacity - - - Shall make an anonymous buffered channel with the given capacity - - - - - - &reftitle.parameters; - - - capacity - - - May be Channel::Infinite or a positive integer - - - - - - - - - diff --git a/reference/parallel/parallel/channel/make.xml b/reference/parallel/parallel/channel/make.xml deleted file mode 100644 index af7883785..000000000 --- a/reference/parallel/parallel/channel/make.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - parallel\Channel::make - Access - - - - &reftitle.description; - - public Channelparallel\Channel::make - stringname - - - Shall make an unbuffered channel with the given name - - - public Channelparallel\Channel::make - stringname - intcapacity - - - Shall make a buffered channel with the given name and capacity - - - - - - &reftitle.parameters; - - - name - - - The name of the channel. - - - - - capacity - - - May be Channel::Infinite or a positive integer - - - - - - - - Exceptions - - - Shall throw parallel\Channel\Error\Existence if channel already exists. - - - - - - - diff --git a/reference/parallel/parallel/channel/open.xml b/reference/parallel/parallel/channel/open.xml deleted file mode 100644 index bc78a71f0..000000000 --- a/reference/parallel/parallel/channel/open.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - parallel\Channel::open - Access - - - - &reftitle.description; - - public Channelparallel\Channel::open - stringname - - - Shall open the channel with the given name - - - - - - Exceptions - - - Shall throw parallel\Channel\Error\Existence if channel does not exist. - - - - - - - diff --git a/reference/parallel/parallel/channel/recv.xml b/reference/parallel/parallel/channel/recv.xml deleted file mode 100644 index f89e15220..000000000 --- a/reference/parallel/parallel/channel/recv.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - parallel\Channel::recv - Sharing - - - - &reftitle.description; - - public mixedparallel\Channel::recv - - - - Shall recv a value from this channel - - - - - - Exceptions - - - Shall throw parallel\Channel\Error\Closed if channel is closed. - - - - - - - diff --git a/reference/parallel/parallel/channel/send.xml b/reference/parallel/parallel/channel/send.xml deleted file mode 100644 index 3d8d0c703..000000000 --- a/reference/parallel/parallel/channel/send.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - parallel\Channel::send - Sharing - - - - &reftitle.description; - - public voidparallel\Channel::send - mixedvalue - - - Shall send the given value on this channel - - - - - - Exceptions - - - Shall throw parallel\Channel\Error\Closed if channel is closed. - - - - - Shall throw parallel\Channel\Error\IllegalValue if value is illegal. - - - - - - - diff --git a/reference/parallel/parallel/events/addchannel.xml b/reference/parallel/parallel/events/addchannel.xml deleted file mode 100644 index cfffdaa62..000000000 --- a/reference/parallel/parallel/events/addchannel.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - parallel\Events::addChannel - Targets - - - - &reftitle.description; - - public voidparallel\Events::addChannel - parallel\Channelchannel - - - Shall watch for events on the given channel - - - - - Exceptions - - - Shall throw parallel\Events\Error\Existence if channel was already added. - - - - - - - diff --git a/reference/parallel/parallel/events/addfuture.xml b/reference/parallel/parallel/events/addfuture.xml deleted file mode 100644 index a736fa49d..000000000 --- a/reference/parallel/parallel/events/addfuture.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - parallel\Events::addFuture - Targets - - - - &reftitle.description; - - public voidparallel\Events::addFuture - stringname - parallel\Futurefuture - - - Shall watch for events on the given future - - - - - Exceptions - - - Shall throw parallel\Events\Error\Existence if target with the given name was already added. - - - - - - - diff --git a/reference/parallel/parallel/events/poll.xml b/reference/parallel/parallel/events/poll.xml deleted file mode 100644 index 601ce5eb5..000000000 --- a/reference/parallel/parallel/events/poll.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - parallel\Events::poll - Polling - - - - &reftitle.description; - - public parallel\Events\Eventnullparallel\Events::poll - - - - Shall poll for the next event - - - - - &reftitle.returnvalues; - - Should there be no targets remaining, &null; shall be returned - - - Should this be a non-blocking loop, and blocking would occur, &null; shall be returned - - - Otherwise, the parallel\Events\Event returned describes the event. - - - - - Exceptions - - - Shall throw parallel\Events\Error\Timeout if timeout is used and reached. - - - - - - - diff --git a/reference/parallel/parallel/events/remove.xml b/reference/parallel/parallel/events/remove.xml deleted file mode 100644 index b3520c094..000000000 --- a/reference/parallel/parallel/events/remove.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - parallel\Events::remove - Targets - - - - &reftitle.description; - - public voidparallel\Events::remove - stringtarget - - - Shall remove the given target - - - - - Exceptions - - - Shall throw parallel\Events\Error\Existence if target with the given name was not found. - - - - - - - diff --git a/reference/parallel/parallel/events/setblocking.xml b/reference/parallel/parallel/events/setblocking.xml deleted file mode 100644 index 1eb3889c7..000000000 --- a/reference/parallel/parallel/events/setblocking.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - parallel\Events::setBlocking - Behaviour - - - - &reftitle.description; - - By default when events are polled for, blocking will occur (at the PHP level) until the first event can be returned: Setting blocking mode to &false; will cause - poll to return control if the first target polled is not ready. - - - This differs from setting a timeout of 0 with parallel\Events::setTimeout, since a timeout of 0, while allowed, will cause an exception - to be raised, which may be extremely slow or wasteful if what is really desired is non-blocking behaviour. - - - A non-blocking loop effects the return value of parallel\Events::poll, such that it may be &null; before all events have been processed. - - - public voidparallel\Events::setBlocking - boolblocking - - - Shall set blocking mode - - - - - Exceptions - - - Shall throw parallel\Events\Error if loop has timeout set. - - - - - - - diff --git a/reference/parallel/parallel/events/setinput.xml b/reference/parallel/parallel/events/setinput.xml deleted file mode 100644 index c3a575f7e..000000000 --- a/reference/parallel/parallel/events/setinput.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - - parallel\Events::setInput - Input - - - - &reftitle.description; - - public voidparallel\Events::setInput - Inputinput - - - Shall set input for this event loop - - - - - - diff --git a/reference/parallel/parallel/events/settimeout.xml b/reference/parallel/parallel/events/settimeout.xml deleted file mode 100644 index 64518bcdc..000000000 --- a/reference/parallel/parallel/events/settimeout.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - parallel\Events::setTimeout - Behaviour - - - - &reftitle.description; - - By default when events are polled for, blocking will occur (at the PHP level) until the first event can be returned: Setting the timeout causes an exception to be - thrown when the timeout is reached. - - - This differs from setting blocking mode to &false; with parallel\Events::setBlocking, which will not cause an exception to be thrown. - - - public voidparallel\Events::setTimeout - inttimeout - - - Shall set the timeout in microseconds - - - - - Exceptions - - - Shall throw parallel\Events\Error if loop is non-blocking. - - - - - - - diff --git a/reference/parallel/parallel/future/cancel.xml b/reference/parallel/parallel/future/cancel.xml deleted file mode 100644 index 118930134..000000000 --- a/reference/parallel/parallel/future/cancel.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - parallel\Future::cancel - Cancellation - - - - &reftitle.description; - - public boolparallel\Future::cancel - - - - Shall try to cancel the task - - - - If task is running, it will be interrupted. - - - - - Internal function calls in progress cannot be interrupted. - - - - - - Exceptions - - - Shall throw parallel\Future\Error\Killed if parallel\Runtime executing task was killed. - - - - - Shall throw parallel\Future\Error\Cancelled if task was already cancelled. - - - - - - - diff --git a/reference/parallel/parallel/future/cancelled.xml b/reference/parallel/parallel/future/cancelled.xml deleted file mode 100644 index b17b9ad23..000000000 --- a/reference/parallel/parallel/future/cancelled.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - - parallel\Future::cancelled - State Detection - - - - &reftitle.description; - - public boolparallel\Future::cancelled - - - - Shall indicate if the task was cancelled - - - - - - - diff --git a/reference/parallel/parallel/future/done.xml b/reference/parallel/parallel/future/done.xml deleted file mode 100644 index b4e4ad0cc..000000000 --- a/reference/parallel/parallel/future/done.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - - parallel\Future::done - State Detection - - - - &reftitle.description; - - public boolparallel\Future::done - - - - Shall indicate if the task is completed - - - - - - - diff --git a/reference/parallel/parallel/future/value.xml b/reference/parallel/parallel/future/value.xml deleted file mode 100644 index 16bd571db..000000000 --- a/reference/parallel/parallel/future/value.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - parallel\Future::value - Resolution - - - - &reftitle.description; - - public mixedparallel\Future::value - - - - Shall return (and if necessary wait for) return from task - - - - - Exceptions - - - Shall throw parallel\Future\Error if waiting failed (internal error). - - - - - Shall throw parallel\Future\Error\Killed if parallel\Runtime executing task was killed. - - - - - Shall throw parallel\Future\Error\Cancelled if task was cancelled. - - - - - Shall throw parallel\Future\Error\Foreign if task raised an unrecognized uncaught exception. - - - - - Shall rethrow Throwable uncaught in task - - - - - - - - diff --git a/reference/parallel/parallel/input/add.xml b/reference/parallel/parallel/input/add.xml deleted file mode 100644 index 36a663848..000000000 --- a/reference/parallel/parallel/input/add.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - parallel\Events\Input::add - Inputs - - - - &reftitle.description; - - public voidparallel\Events\Input::add - stringtarget - mixedvalue - - - Shall set input for the given target - - - - - Exceptions - - - Shall throw parallel\Events\Input\Error\Existence if input for target already exists. - - - - - Shall throw parallel\Events\Input\Error\IllegalValue if value is illegal (&object;, &null;). - - - - - - - diff --git a/reference/parallel/parallel/input/clear.xml b/reference/parallel/parallel/input/clear.xml deleted file mode 100644 index 6cd562bd5..000000000 --- a/reference/parallel/parallel/input/clear.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - - parallel\Events\Input::clear - Inputs - - - - &reftitle.description; - - public voidparallel\Events\Input::clear - - - - Shall remove input for all targets - - - - - - diff --git a/reference/parallel/parallel/input/remove.xml b/reference/parallel/parallel/input/remove.xml deleted file mode 100644 index adf313a6f..000000000 --- a/reference/parallel/parallel/input/remove.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - parallel\Events\Input::remove - Inputs - - - - &reftitle.description; - - public voidparallel\Events\Input::remove - stringtarget - - - Shall remove input for the given target - - - - - Exceptions - - - Shall throw parallel\Events\Input\Error\Existence if input for target does not exist. - - - - - - - diff --git a/reference/parallel/parallel/runtime/close.xml b/reference/parallel/parallel/runtime/close.xml deleted file mode 100644 index 34c564005..000000000 --- a/reference/parallel/parallel/runtime/close.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - parallel\Runtime::close - Runtime Graceful Join - - - - &reftitle.description; - - public voidparallel\Runtime::close - - - - Shall request that the runtime shutsdown. - - - - Tasks scheduled for execution will be executed before the shutdown occurs. - - - - - - Exceptions - - - Shall throw parallel\Runtime\Error\Closed if Runtime was already closed. - - - - - - - - diff --git a/reference/parallel/parallel/runtime/construct.xml b/reference/parallel/parallel/runtime/construct.xml deleted file mode 100644 index 3cd842082..000000000 --- a/reference/parallel/parallel/runtime/construct.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - parallel\Runtime::__construct - Runtime Construction - - - - &reftitle.description; - - public parallel\Runtime::__construct - - - - Shall construct a new runtime without bootstrapping. - - - public parallel\Runtime::__construct - stringbootstrap - - - Shall construct a bootstrapped runtime. - - - - - - &reftitle.parameters; - - - bootstrap - - - The location of a bootstrap file, generally an autoloader. - - - - - - - - Exceptions - - - Shall throw parallel\Runtime\Error if thread could not be created - - - - - Shall throw parallel\Runtime\Bootstrap if bootstrapping failed - - - - - - - diff --git a/reference/parallel/parallel/runtime/kill.xml b/reference/parallel/parallel/runtime/kill.xml deleted file mode 100644 index d124f0880..000000000 --- a/reference/parallel/parallel/runtime/kill.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - parallel\Runtime::kill - Runtime Join - - - - &reftitle.description; - - public voidparallel\Runtime::kill - - - - Shall attempt to force the runtime to shutdown. - - - - Tasks scheduled for execution will not be executed, the currently running task shall be interrupted. - - - - - Internal function calls in progress cannot be interrupted. - - - - - - Exceptions - - - Shall throw parallel\Runtime\Error\Closed if Runtime was closed. - - - - - - - - diff --git a/reference/parallel/parallel/runtime/run.xml b/reference/parallel/parallel/runtime/run.xml deleted file mode 100644 index c2d874f12..000000000 --- a/reference/parallel/parallel/runtime/run.xml +++ /dev/null @@ -1,182 +0,0 @@ - - - - - - parallel\Runtime::run - Execution - - - - &reftitle.description; - - public Futurenullparallel\Runtime::run - Closuretask - - - Shall schedule task for execution in parallel. - - - public Futurenullparallel\Runtime::run - Closuretask - arrayargv - - - Shall schedule task for execution in parallel, passing argv at execution time. - - - - - - &reftitle.parameters; - - - task - - - A Closure with specific characteristics. - - - - - argv - - - An array of arguments with specific characteristics to be passed to task at execution time. - - - - - - - - Task Characteristics - - Closures scheduled for parallel execution must not: - - accept or return by reference - accept or return internal objects (see notes) - execute a limited set of instructions - - - - Instructions prohibited in Closures intended for parallel execution are: - - yield - use by-reference - declare class - declare named function - - - - - Nested closures may yield or use by-reference, but must not contain class or named function declarations. - - - - - No instructions are prohibited in the files which the task may include. - - - - - - Arguments Characteristics - - Arguments must not: - - contain references - contain resources - contain internal objects (see notes) - - - - In the case of file stream resources, the resource will be cast to the file descriptor and passed as int where possible, this is unsupported on Windows. - - - - - - - Internal Objects Notes - - Internal objects generally use a custom structure which cannot be copied by value safely, PHP currently lacks the mechanics to do this (without serialization) - and so only objects that do not use a custom structure may be shared. - - - Some internal objects do not use a custom structure, for example parallel\Events\Event and so may be shared. - - - Closures are a special kind of internal object and support being copied by value, and so may be shared. - - - Channels are central to writing parallel code and support concurrent access and execution by necessity, and so may be shared. - - - - A user class that extends an internal class may use a custom structure as defined by the internal class, in which case they cannot be copied by value safely, - and so may not be shared. - - - - - - &reftitle.returnvalues; - - - The return parallel\Future must not be ignored when the task contains a return or throw statement. - - - - - - Exceptions - - - Shall throw parallel\Runtime\Error\Closed if parallel\Runtime was closed. - - - - - Shall throw parallel\Runtime\Error\IllegalFunction if task is a closure created from an internal function. - - - - - Shall throw parallel\Runtime\Error\IllegalInstruction if task contains illegal instructions. - - - - - Shall throw parallel\Runtime\Error\IllegalParameter if task accepts or argv contains illegal variables. - - - - - Shall throw parallel\Runtime\Error\IllegalReturn if task returns illegally. - - - - - - - diff --git a/reference/parallel/parallel/sync/construct.xml b/reference/parallel/parallel/sync/construct.xml deleted file mode 100644 index 91ae9db29..000000000 --- a/reference/parallel/parallel/sync/construct.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - parallel\Sync::__construct - Construction - - - - &reftitle.description; - - public parallel\Sync::__construct - - - - Shall construct a new synchronization object with no value - - - - public parallel\Sync::__construct - scalarvalue - - - Shall construct a new synchronization object containing the given scalar value - - - - - - Exceptions - - - Shall throw parallel\Sync\Error\IllegalValue if value is non-scalar. - - - - - - - diff --git a/reference/parallel/parallel/sync/get.xml b/reference/parallel/parallel/sync/get.xml deleted file mode 100644 index 0d3dd33a9..000000000 --- a/reference/parallel/parallel/sync/get.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - - parallel\Sync::get - Access - - - - &reftitle.description; - - public scalarparallel\Sync::get - - - - Shall atomically return the syncrhonization objects value - - - - - - - diff --git a/reference/parallel/parallel/sync/invoke.xml b/reference/parallel/parallel/sync/invoke.xml deleted file mode 100644 index 0413f333b..000000000 --- a/reference/parallel/parallel/sync/invoke.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - - parallel\Sync::__invoke - Synchronization - - - - &reftitle.description; - - public parallel\Sync::__invoke - callablecritical - - - Shall exclusively enter into the critical code - - - - - - - diff --git a/reference/parallel/parallel/sync/notify.xml b/reference/parallel/parallel/sync/notify.xml deleted file mode 100644 index 32b94eaf6..000000000 --- a/reference/parallel/parallel/sync/notify.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - - parallel\Sync::notify - Synchronization - - - - &reftitle.description; - - public parallel\Sync::notify - boolall - - - Shall notify one (by default) or all threads waiting on the synchronization object - - - - - - - diff --git a/reference/parallel/parallel/sync/set.xml b/reference/parallel/parallel/sync/set.xml deleted file mode 100644 index 284df393b..000000000 --- a/reference/parallel/parallel/sync/set.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - parallel\Sync::set - Access - - - - &reftitle.description; - - public parallel\Sync::set - scalarvalue - - - Shall atomically set the value of the synchronization object - - - - - - Exceptions - - - Shall throw parallel\Sync\Error\IllegalValue if value is non-scalar. - - - - - - - diff --git a/reference/parallel/parallel/sync/wait.xml b/reference/parallel/parallel/sync/wait.xml deleted file mode 100644 index b893da2f2..000000000 --- a/reference/parallel/parallel/sync/wait.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - - parallel\Sync::wait - Synchronization - - - - &reftitle.description; - - public parallel\Sync::wait - - - - Shall wait for notification on this synchronization object - - - - - - - diff --git a/reference/parallel/philosophy.xml b/reference/parallel/philosophy.xml deleted file mode 100644 index a2d08dea6..000000000 --- a/reference/parallel/philosophy.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - Philosophy - - This section contains philosophies important to writing parallel code and some details about the internal implementation of parallel. - - - Do not communicate by sharing memory; instead, share memory by communicating. - - This philosophy which is embraced by parallel has its origins in Go, one of the most widely admired if not used platforms for writing parallel code at the moment. - Go programmers have to work hard to live up to this ideal: PHP and parallel do all the hard work for the programmer, and by default. - - - In conventional threading models found in other languages, generally threads are communicating with one another through nothing more than by virtue of the fact that - they operate in the same address space. - The programmer must deploy mutual exclusion, condition variables, and other low level threading or synchronization primitives in order to ensure proper communication - of state and consistency. - - - When the conventional model is inversed, it means that threads only share memory as a result of communication (a variable is passed over a Channel for example). - - - When parallel passes a variable from one thread to another by any means - Task arguments, return via Future, and Channels - it is passed by value. - In all but the case of unbuffered channels, the variable is also buffered so that it may not change (or be destroyed) before it is used in whichever thread the variable - is being passed to. An unbuffered read over a channel is the only instance in which a thread directly reads memory allocated by another thread, it can do so safely because - the thread that owns the memory is waiting for the read to complete before it can continue to manipulate it, and the thread that does not own the memory reads by value. When - both threads continue, they are no longer sharing memory. - - - This makes writing and reasoning about parallel code much easier than the conventional model of threading. It means the programmer does not need to consider that threads - may be manipulating data concurrently, because that is not possible. - - - This also makes PHP the perfect platform for implementing a parallel concurrency API based on CSP (message passing over channels), because PHP itself is shared nothing - - PHP threads operate in their own virtual address space by default, and so may only share memory by communicating. - - - - Data should have a definitive single owner - - When approaching the CSP model for the first time, a programmer versed in the traditional model of threading may find themselves looking for concurrent data structures, - because that is what they are used too: they pass around shared objects for manipulation. - - - When it comes to the CSP model, there is no need for data structures to be shared by many tasks, and indeed, it is simpler if they are not. The data should be owned - by a single task, changes to (or operations on) that data structure should be communicated over channels and performed by the owner of the data, the success, failure, - or result (state) of the change (or operation) being communicated back. - - - Once again the share nothing nature of PHP and copy by value nature of parallel helps the programmer to achieve this goal, no data will be shared by accident, - only ever as a result of communication. - - - - - diff --git a/reference/parallel/setup.xml b/reference/parallel/setup.xml deleted file mode 100644 index cf0f96009..000000000 --- a/reference/parallel/setup.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - Installation - - - &reftitle.required; - - parallel requires a build of PHP with ZTS (Zend Thread Safety) enabled - (, or on non-Windows systems prior to PHP 8.0.0, - ) - - - - Zend Thread Safety cannot be enabled post build; it is a build time configuration option. - - - - parallel should build anywhere there is a working Posix Threads header (pthread.h) and ZTS build of PHP, including Windows (using the pthread-w32 project from redhat). - - - - - &reftitle.install; - - parallel releases are hosted by PECL and the source code by - github, - the easiest route to installation is the normal PECL route: - &url.pecl.package;parallel. - - - Windows users can download prebuilt release binaries from the PECL website. - - - - Windows users need to take the additional step of adding pthreadVC2.dll (distributed with Windows releases) to their PATH. - - - - - - - diff --git a/reference/parallel/versions.xml b/reference/parallel/versions.xml deleted file mode 100644 index 2f1d0c9a0..000000000 --- a/reference/parallel/versions.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/pcre/versions.xml b/reference/pcre/versions.xml deleted file mode 100644 index fb4a16c68..000000000 --- a/reference/pcre/versions.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/posix/versions.xml b/reference/posix/versions.xml deleted file mode 100644 index 180272faf..000000000 --- a/reference/posix/versions.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/pspell/versions.xml b/reference/pspell/versions.xml deleted file mode 100644 index 390e9884a..000000000 --- a/reference/pspell/versions.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/reflection/reflectionclass/getreflectionconstant.xml b/reference/reflection/reflectionclass/getreflectionconstant.xml deleted file mode 100644 index b81054c49..000000000 --- a/reference/reflection/reflectionclass/getreflectionconstant.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - ReflectionClass::getReflectionConstant - Gets a ReflectionClassConstant for a class's constant - - - - &reftitle.description; - - public ReflectionClassConstantfalseReflectionClass::getReflectionConstant - stringname - - - Gets a ReflectionClassConstant for a class's property. - - - - - - &reftitle.parameters; - - - - name - - - The class constant name. - - - - - - - - - &reftitle.returnvalues; - - A ReflectionClassConstant, &return.falseforfailure;. - - - - - &reftitle.seealso; - - - ReflectionClass::getReflectionConstants - ReflectionClassConstant - - - - - - - diff --git a/reference/reflection/reflectionclass/getreflectionconstants.xml b/reference/reflection/reflectionclass/getreflectionconstants.xml deleted file mode 100644 index b46f9f924..000000000 --- a/reference/reflection/reflectionclass/getreflectionconstants.xml +++ /dev/null @@ -1,156 +0,0 @@ - - - - - ReflectionClass::getReflectionConstants - Gets class constants - - - - &reftitle.description; - - public arrayReflectionClass::getReflectionConstants - intnullfilter&null; - - - Retrieves reflected constants. - - - - - &reftitle.parameters; - - - filter - - - The optional filter, for filtering desired constant visibilities. It's configured using - the ReflectionClassConstant constants, - and defaults to all constant visibilities. - - - - - - - - &reftitle.returnvalues; - - An array of ReflectionClassConstant objects. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - 8.0.0 - - filter has been added. - - - - - - - - - &reftitle.examples; - - Basic <function>ReflectionClass::getReflectionConstants</function> example - -getReflectionConstants(); - -foreach ($consts as $const) { - print $const->getName() . "\n"; -} - -var_dump($consts); - -?> -]]> - - &example.outputs.similar; - - - object(ReflectionClassConstant)#3 (2) { - ["name"]=> - string(3) "FOO" - ["class"]=> - string(3) "Foo" - } - [1]=> - object(ReflectionClassConstant)#4 (2) { - ["name"]=> - string(3) "BAR" - ["class"]=> - string(3) "Foo" - } - [2]=> - object(ReflectionClassConstant)#5 (2) { - ["name"]=> - string(3) "BAZ" - ["class"]=> - string(3) "Foo" - } -} -]]> - - - - - - &reftitle.seealso; - - - ReflectionClass::getReflectionConstant - ReflectionClassConstant - - - - - - diff --git a/reference/reflection/reflectionclassconstant.xml b/reference/reflection/reflectionclassconstant.xml deleted file mode 100644 index ab979c009..000000000 --- a/reference/reflection/reflectionclassconstant.xml +++ /dev/null @@ -1,171 +0,0 @@ - - - - - - The ReflectionClassConstant class - ReflectionClassConstant - - - - -
- &reftitle.intro; - - The ReflectionClassConstant class reports - information about a class constant. - -
- - -
- &reftitle.classsynopsis; - - - - ReflectionClassConstant - - - - - ReflectionClassConstant - - - - Reflector - - - - &Constants; - - const - int - ReflectionClassConstant::IS_PUBLIC - - - const - int - ReflectionClassConstant::IS_PROTECTED - - - const - int - ReflectionClassConstant::IS_PRIVATE - - - &Properties; - - public - name - - - public - class - - - - &Methods; - - - - - - - -
- - - -
- &reftitle.properties; - - - name - - - Name of the class constant. Read-only, throws - ReflectionException in attempt to write. - - - - - class - - - Name of the class where the class constant is defined. Read-only, throws - ReflectionException in attempt to write. - - - - -
- - - -
- &reftitle.constants; -
- ReflectionClassConstant Modifiers - - - - ReflectionClassConstant::IS_PUBLIC - - - Indicates public - constants. - - - - - - ReflectionClassConstant::IS_PROTECTED - - - Indicates protected - constants. - - - - - - ReflectionClassConstant::IS_PRIVATE - - - Indicates private - constants. - - - - - -
-
- - - - - &reference.reflection.entities.reflectionclassconstant; - - - - diff --git a/reference/reflection/reflectionclassconstant/construct.xml b/reference/reflection/reflectionclassconstant/construct.xml deleted file mode 100644 index 36d14cdd0..000000000 --- a/reference/reflection/reflectionclassconstant/construct.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - ReflectionClassConstant::__construct - Constructs a ReflectionClassConstant - - - - &reftitle.description; - - public ReflectionClassConstant::__construct - objectstringclass - stringconstant - - - Constructs a new ReflectionClassConstant object. - - - - - &reftitle.parameters; - - - - class - - - Either a string containing the name of the class to - reflect, or an object. - - - - - constant - - - The name of the class constant. - - - - - - - - - &reftitle.returnvalues; - - Returns constructed ReflectionClassConstant instance. - - - - - &reftitle.errors; - - Throws an Exception in case the given class constant does not exist. - - - - - &reftitle.seealso; - - - Constructors - - - - - - diff --git a/reference/reflection/reflectionclassconstant/export.xml b/reference/reflection/reflectionclassconstant/export.xml deleted file mode 100644 index 920f910a6..000000000 --- a/reference/reflection/reflectionclassconstant/export.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - ReflectionClassConstant::export - Export - - - - &warn.deprecated.function-7-4-0; - - - - &reftitle.description; - - public static stringReflectionClassConstant::export - mixedclass - stringname - boolreturn - - - Exports a reflection. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - class - - - &reflection.export.param.name; - - - - - name - - - The class constant name. - - - - - return - - - &reflection.export.param.return; - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - - ReflectionClassConstant::__toString - - - - - - - diff --git a/reference/reflection/reflectionclassconstant/getdeclaringclass.xml b/reference/reflection/reflectionclassconstant/getdeclaringclass.xml deleted file mode 100644 index 5db2fb8c4..000000000 --- a/reference/reflection/reflectionclassconstant/getdeclaringclass.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - ReflectionClassConstant::getDeclaringClass - Gets declaring class - - - - &reftitle.description; - - public ReflectionClassReflectionClassConstant::getDeclaringClass - - - - Gets the declaring class. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A ReflectionClass object. - - - - - - diff --git a/reference/reflection/reflectionclassconstant/getdoccomment.xml b/reference/reflection/reflectionclassconstant/getdoccomment.xml deleted file mode 100644 index b2f22560a..000000000 --- a/reference/reflection/reflectionclassconstant/getdoccomment.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - ReflectionClassConstant::getDocComment - Gets doc comments - - - - &reftitle.description; - - public stringfalseReflectionClassConstant::getDocComment - - - - Gets doc comments from a class constant. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The doc comment if it exists, otherwise &false; - - - - - diff --git a/reference/reflection/reflectionclassconstant/getmodifiers.xml b/reference/reflection/reflectionclassconstant/getmodifiers.xml deleted file mode 100644 index 910c460cc..000000000 --- a/reference/reflection/reflectionclassconstant/getmodifiers.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - ReflectionClassConstant::getModifiers - Gets the class constant modifiers - - - - &reftitle.description; - - public intReflectionClassConstant::getModifiers - - - - Returns a bitfield of the access modifiers for this class constant. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A numeric representation of the modifiers. - The actual meanings of these modifiers are described in the - predefined constants. - - - - - &reftitle.seealso; - - - Reflection::getModifierNames - - - - - - - diff --git a/reference/reflection/reflectionclassconstant/getname.xml b/reference/reflection/reflectionclassconstant/getname.xml deleted file mode 100644 index 32c37813c..000000000 --- a/reference/reflection/reflectionclassconstant/getname.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - ReflectionClassConstant::getName - Get name of the constant - - - - &reftitle.description; - - public stringfalseReflectionClassConstant::getName - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the constant's name, &return.falseforfailure;. - - - - - - diff --git a/reference/reflection/reflectionclassconstant/getvalue.xml b/reference/reflection/reflectionclassconstant/getvalue.xml deleted file mode 100644 index 1c98566a4..000000000 --- a/reference/reflection/reflectionclassconstant/getvalue.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - ReflectionClassConstant::getValue - Gets value - - - - &reftitle.description; - - public mixedReflectionClassConstant::getValue - - - - Gets the class constant's value. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The value of the class constant. - - - - - - diff --git a/reference/reflection/reflectionclassconstant/isprivate.xml b/reference/reflection/reflectionclassconstant/isprivate.xml deleted file mode 100644 index fbd330012..000000000 --- a/reference/reflection/reflectionclassconstant/isprivate.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - ReflectionClassConstant::isPrivate - Checks if class constant is private - - - - &reftitle.description; - - public boolReflectionClassConstant::isPrivate - - - - Checks if the class constant is private. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; if the class constant is private, otherwise &false; - - - - - &reftitle.seealso; - - - ReflectionClassConstant::isPublic - ReflectionClassConstant::isProtected - - - - - - - diff --git a/reference/reflection/reflectionclassconstant/isprotected.xml b/reference/reflection/reflectionclassconstant/isprotected.xml deleted file mode 100644 index e87ee2297..000000000 --- a/reference/reflection/reflectionclassconstant/isprotected.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - ReflectionClassConstant::isProtected - Checks if class constant is protected - - - - &reftitle.description; - - public boolReflectionClassConstant::isProtected - - - - Checks if the class constant is protected. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; if the class constant is protected, otherwise &false; - - - - - &reftitle.seealso; - - - ReflectionClassConstant::isPublic - ReflectionClassConstant::isPrivate - - - - - - - diff --git a/reference/reflection/reflectionclassconstant/ispublic.xml b/reference/reflection/reflectionclassconstant/ispublic.xml deleted file mode 100644 index 37d7ee068..000000000 --- a/reference/reflection/reflectionclassconstant/ispublic.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - ReflectionClassConstant::isPublic - Checks if class constant is public - - - - &reftitle.description; - - public boolReflectionClassConstant::isPublic - - - - Checks if the class constant is public. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; if the class constant is public, otherwise &false; - - - - - &reftitle.seealso; - - - ReflectionClassConstant::isPrivate - ReflectionClassConstant::isProtected - - - - - - - diff --git a/reference/reflection/reflectionclassconstant/tostring.xml b/reference/reflection/reflectionclassconstant/tostring.xml deleted file mode 100644 index eece1499a..000000000 --- a/reference/reflection/reflectionclassconstant/tostring.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - ReflectionClassConstant::__toString - Returns the string representation of the ReflectionClassConstant object - - - - &reftitle.description; - - public stringReflectionClassConstant::__toString - - - - Returns the string representation of the ReflectionClassConstant object. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A string representation of this ReflectionClassConstant instance. - - - - - &reftitle.seealso; - - - ReflectionClassConstant::export - __toString() - - - - - - - diff --git a/reference/reflection/reflectionfunctionabstract/gettentativereturntype.xml b/reference/reflection/reflectionfunctionabstract/gettentativereturntype.xml deleted file mode 100644 index 22b4ff11b..000000000 --- a/reference/reflection/reflectionfunctionabstract/gettentativereturntype.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - ReflectionFunctionAbstract::getTentativeReturnType - Returns the tentative return type associated with the function - - - - &reftitle.description; - - public ReflectionTypenullReflectionFunctionAbstract::getTentativeReturnType - - - - Returns the tentative return type associated with the function. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a ReflectionType object if a tentative return type is - specified, &null; otherwise. - - - - - &reftitle.examples; - - - <methodname>ReflectionFunctionAbstract::getTentativeReturnType</methodname> example - -getTentativeReturnType()); -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - ReflectionFunctionAbstract::getReturnType - ReflectionFunctionAbstract::hasTentativeReturnType - Return Type Compatibility with Internal Classes - - - - - - diff --git a/reference/reflection/reflectionfunctionabstract/hasreturntype.xml b/reference/reflection/reflectionfunctionabstract/hasreturntype.xml deleted file mode 100644 index 71791ce74..000000000 --- a/reference/reflection/reflectionfunctionabstract/hasreturntype.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - ReflectionFunctionAbstract::hasReturnType - Checks if the function has a specified return type - - - - &reftitle.description; - - public boolReflectionFunctionAbstract::hasReturnType - - - - Checks whether the reflected function has a return type specified. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; if the function is a specified return type, otherwise &false;. - - - - - &reftitle.examples; - - - <methodname>ReflectionFunctionAbstract::hasReturnType</methodname> example - -hasReturnType()); -]]> - - &example.outputs; - - - - - - - Usage on built-in functions - -hasReturnType()); -]]> - - &example.outputs; - - - - - - - This is because many internal functions do not have types specified for their - parameters or return values. It is therefore best to avoid using this - method on built-in functions. - - - - - &reftitle.seealso; - - - ReflectionFunctionAbstract::getReturnType - - - - - - - diff --git a/reference/reflection/reflectiongenerator.xml b/reference/reflection/reflectiongenerator.xml deleted file mode 100644 index 863763efc..000000000 --- a/reference/reflection/reflectiongenerator.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - The ReflectionGenerator class - ReflectionGenerator - - - - -
- &reftitle.intro; - - The ReflectionGenerator class reports - information about a generator. - -
- - -
- &reftitle.classsynopsis; - - - - ReflectionGenerator - - - - - ReflectionGenerator - - - - &Methods; - - - - - - - -
- - - - &reference.reflection.entities.reflectiongenerator; - - - - diff --git a/reference/reflection/reflectiongenerator/construct.xml b/reference/reflection/reflectiongenerator/construct.xml deleted file mode 100644 index 38369a41e..000000000 --- a/reference/reflection/reflectiongenerator/construct.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - ReflectionGenerator::__construct - Constructs a ReflectionGenerator object - - - - &reftitle.description; - - public ReflectionGenerator::__construct - Generatorgenerator - - - Constructs a ReflectionGenerator object. - - - - - &reftitle.parameters; - - - - generator - - - A generator object. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - <methodname>ReflectionGenerator::__construct</methodname> example - -getFunction()->name} -Line: {$reflectionGen->getExecutingLine()} -File: {$reflectionGen->getExecutingFile()} -output; -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - ReflectionGenerator::getFunction - ReflectionGenerator::getExecutingLine - ReflectionGenerator::getExecutingFile - - - - - - diff --git a/reference/reflection/reflectiongenerator/getexecutingfile.xml b/reference/reflection/reflectiongenerator/getexecutingfile.xml deleted file mode 100644 index 71ed4ebd6..000000000 --- a/reference/reflection/reflectiongenerator/getexecutingfile.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - ReflectionGenerator::getExecutingFile - Gets the file name of the currently executing generator - - - - &reftitle.description; - - public stringReflectionGenerator::getExecutingFile - - - - Get the full path and file name of the currently executing generator. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the full path and file name of the currently executing generator. - - - - - &reftitle.examples; - - - <methodname>ReflectionGenerator::getExecutingFile</methodname> example - -gen(); - -$reflectionGen = new ReflectionGenerator($gen); - -echo "File: {$reflectionGen->getExecutingFile()}"; -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - ReflectionGenerator::getExecutingLine - ReflectionGenerator::getExecutingGenerator - - - - - - - diff --git a/reference/reflection/reflectiongenerator/getexecutinggenerator.xml b/reference/reflection/reflectiongenerator/getexecutinggenerator.xml deleted file mode 100644 index 1df890238..000000000 --- a/reference/reflection/reflectiongenerator/getexecutinggenerator.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - ReflectionGenerator::getExecutingGenerator - Gets the executing Generator object - - - - &reftitle.description; - - public GeneratorReflectionGenerator::getExecutingGenerator - - - - Get the executing Generator object - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the currently executing Generator object. - - - - - &reftitle.examples; - - - <methodname>ReflectionGenerator::getExecutingGenerator</methodname> example - -gen(); - -$reflectionGen = new ReflectionGenerator($gen); - -$gen2 = $reflectionGen->getExecutingGenerator(); - -var_dump($gen2 === $gen); -var_dump($gen2->current()); -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - ReflectionGenerator::getExecutingLine - ReflectionGenerator::getExecutingFile - - - - - - - diff --git a/reference/reflection/reflectiongenerator/getexecutingline.xml b/reference/reflection/reflectiongenerator/getexecutingline.xml deleted file mode 100644 index 6e007c02f..000000000 --- a/reference/reflection/reflectiongenerator/getexecutingline.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - ReflectionGenerator::getExecutingLine - Gets the currently executing line of the generator - - - - &reftitle.description; - - public intReflectionGenerator::getExecutingLine - - - - Get the currently executing line number of the generator. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the line number of the currently executing statement in the generator. - - - - - &reftitle.examples; - - - <methodname>ReflectionGenerator::getExecutingLine</methodname> example - -gen(); - -$reflectionGen = new ReflectionGenerator($gen); - -echo "Line: {$reflectionGen->getExecutingLine()}"; -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - ReflectionGenerator::getExecutingGenerator - ReflectionGenerator::getExecutingFile - - - - - - - diff --git a/reference/reflection/reflectiongenerator/getfunction.xml b/reference/reflection/reflectiongenerator/getfunction.xml deleted file mode 100644 index d57ddd2e1..000000000 --- a/reference/reflection/reflectiongenerator/getfunction.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - ReflectionGenerator::getFunction - Gets the function name of the generator - - - - &reftitle.description; - - public ReflectionFunctionAbstractReflectionGenerator::getFunction - - - - Enables the function name of the generator to be obtained by returning a - class derived from ReflectionFunctionAbstract. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a ReflectionFunctionAbstract class. This will - be ReflectionFunction for functions, or - ReflectionMethod for methods. - - - - - &reftitle.examples; - - - <methodname>ReflectionGenerator::getFunction</methodname> example - -getFunction()); -]]> - - &example.outputs.similar; - - - string(3) "gen" -} -]]> - - - - - - - &reftitle.seealso; - - - ReflectionGenerator::getThis - ReflectionGenerator::getTrace - - - - - - - diff --git a/reference/reflection/reflectiongenerator/getthis.xml b/reference/reflection/reflectiongenerator/getthis.xml deleted file mode 100644 index 2416eee3a..000000000 --- a/reference/reflection/reflectiongenerator/getthis.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - ReflectionGenerator::getThis - Gets the $this value of the generator - - - - &reftitle.description; - - public objectnullReflectionGenerator::getThis - - - - Get the $this value that the generator has access to. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the $this value, or &null; if the generator was - not created in a class context. - - - - - &reftitle.examples; - - - <methodname>ReflectionGenerator::getThis</methodname> example - -gen(); - -$reflectionGen = new ReflectionGenerator($gen); - -var_dump($reflectionGen->getThis()); -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - ReflectionGenerator::getFunction - ReflectionGenerator::getTrace - - - - - - diff --git a/reference/reflection/reflectiongenerator/gettrace.xml b/reference/reflection/reflectiongenerator/gettrace.xml deleted file mode 100644 index 65b8f4816..000000000 --- a/reference/reflection/reflectiongenerator/gettrace.xml +++ /dev/null @@ -1,169 +0,0 @@ - - - - - ReflectionGenerator::getTrace - Gets the trace of the executing generator - - - - &reftitle.description; - - public arrayReflectionGenerator::getTrace - intoptionsDEBUG_BACKTRACE_PROVIDE_OBJECT - - - Get the trace of the currently executing generator. - - - - - &reftitle.parameters; - - - - options - - - The value of options can be any of - the following flags. - - - - Available options - - - - Option - Description - - - - - - DEBUG_BACKTRACE_PROVIDE_OBJECT - - - Default. - - - - - DEBUG_BACKTRACE_IGNORE_ARGS - - - Don't include the argument information for functions in the stack - trace. - - - - -
- - - - - - - - - &reftitle.returnvalues; - - Returns the trace of the currently executing generator. - - - - - &reftitle.examples; - - - <methodname>ReflectionGenerator::getTrace</methodname> example - -valid(); // start the generator - -var_dump((new ReflectionGenerator($gen))->getTrace()); -]]> - - &example.outputs.similar; - - - array(4) { - ["file"]=> - string(18) "example.php" - ["line"]=> - int(8) - ["function"]=> - string(3) "foo" - ["args"]=> - array(0) { - } - } - [1]=> - array(4) { - ["file"]=> - string(18) "example.php" - ["line"]=> - int(12) - ["function"]=> - string(3) "bar" - ["args"]=> - array(0) { - } - } -} -]]> - - - - - - - &reftitle.seealso; - - - ReflectionGenerator::getFunction - ReflectionGenerator::getThis - - - - - - diff --git a/reference/reflection/reflectionnamedtype.xml b/reference/reflection/reflectionnamedtype.xml deleted file mode 100644 index 347efde6a..000000000 --- a/reference/reflection/reflectionnamedtype.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - The ReflectionNamedType class - ReflectionNamedType - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - ReflectionNamedType - - - - - ReflectionNamedType - - - - extends - ReflectionType - - - - - &Methods; - - - &InheritedMethods; - - - - - -
- - - - &reference.reflection.entities.reflectionnamedtype; - - - - diff --git a/reference/reflection/reflectionnamedtype/getname.xml b/reference/reflection/reflectionnamedtype/getname.xml deleted file mode 100644 index 8d2bcbf4f..000000000 --- a/reference/reflection/reflectionnamedtype/getname.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - ReflectionNamedType::getName - Get the text of the type hint - - - - &reftitle.description; - - public stringReflectionNamedType::getName - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the text of the type hint. - - - - - &reftitle.seealso; - - - ReflectionType::__toString - - - - - - - diff --git a/reference/reflection/reflectionnamedtype/isbuiltin.xml b/reference/reflection/reflectionnamedtype/isbuiltin.xml deleted file mode 100644 index 1e18bb8c1..000000000 --- a/reference/reflection/reflectionnamedtype/isbuiltin.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - ReflectionNamedType::isBuiltin - Checks if it is a built-in type - - - - &reftitle.description; - - public boolReflectionNamedType::isBuiltin - - - - Checks if the type is a built-in type in PHP. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; if it's a built-in type, otherwise &false; - - - - - &reftitle.examples; - - - <methodname>ReflectionNamedType::isBuiltin</methodname> example - -getParameters(); - -var_dump($reflectionParams[0]->getType()->isBuiltin()); -var_dump($reflectionParams[1]->getType()->isBuiltin()); -var_dump($reflectionParams[2]->getType()->isBuiltin()); -]]> - - &example.outputs; - - - - - - - Note that the ReflectionNamedType::isBuiltin method - does not distinguish between internal and custom classes. To make this - distinction, the ReflectionClass::isInternal method - should be used on the returned class name. - - - - - &reftitle.seealso; - - - ReflectionType::allowsNull - ReflectionType::__toString - ReflectionClass::isInternal - ReflectionParameter::getType - - - - - - - diff --git a/reference/reflection/reflectionreference/fromarrayelement.xml b/reference/reflection/reflectionreference/fromarrayelement.xml deleted file mode 100644 index 93da7f703..000000000 --- a/reference/reflection/reflectionreference/fromarrayelement.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - ReflectionReference::fromArrayElement - Create a ReflectionReference from an array element - - - - &reftitle.description; - - public static ReflectionReferencenullReflectionReference::fromArrayElement - arrayarray - intstringkey - - - Creates a ReflectionReference from an array element. - - - - - &reftitle.parameters; - - - array - - - The &array; which contains the potential reference. - - - - - key - - - The key; either an &integer; or a &string;. - - - - - - - - &reftitle.returnvalues; - - Returns a ReflectionReference instance if - $array[$key] is a reference, or &null; otherwise. - - - - - &reftitle.errors; - - If array is not an &array;, or key - is not an &integer; or &string;, a TypeError is thrown. - If $array[$key] does not exist, - a ReflectionException is thrown. - - - - - diff --git a/reference/reflection/reflectionreference/getid.xml b/reference/reflection/reflectionreference/getid.xml deleted file mode 100644 index 1cefb6640..000000000 --- a/reference/reflection/reflectionreference/getid.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - ReflectionReference::getId - Get unique ID of a reference - - - - &reftitle.description; - - public stringReflectionReference::getId - - - - Returns an ID which is unique for the reference for the lifetime of that reference. - This ID can be used to compare references for equality, or to maintain a map of - known references. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a &string; of unspecified format. - - - - - &reftitle.examples; - - Basic <methodname>ReflectionReference::getId</methodname> usage - -getId() === $rr2->getId()); -var_dump($rr1->getId() === $rr3->getId()); -?> -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/reflection/reflectiontype.xml b/reference/reflection/reflectiontype.xml deleted file mode 100644 index 2469e6e0a..000000000 --- a/reference/reflection/reflectiontype.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - The ReflectionType class - ReflectionType - - - - -
- &reftitle.intro; - - The ReflectionType class reports - information about a function's return type. - -
- - -
- &reftitle.classsynopsis; - - - - ReflectionType - - - - - abstract - ReflectionType - - - - &Methods; - - - - - - - -
- -
- &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 8.0.0 - - ReflectionType has become abstract and ReflectionType::isBuiltin - has been moved to ReflectionNamedType::isBuiltin. - - - - - - -
- - - - &reference.reflection.entities.reflectiontype; - - - - diff --git a/reference/reflection/reflectiontype/allowsnull.xml b/reference/reflection/reflectiontype/allowsnull.xml deleted file mode 100644 index c0993cfd1..000000000 --- a/reference/reflection/reflectiontype/allowsnull.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - ReflectionType::allowsNull - Checks if null is allowed - - - - &reftitle.description; - - public boolReflectionType::allowsNull - - - - Checks whether the parameter allows &null;. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; if &null; is allowed, otherwise &false; - - - - - &reftitle.examples; - - - <methodname>ReflectionType::allowsNull</methodname> example - -getParameters(); - -var_dump($reflectionParams[0]->getType()->allowsNull()); -var_dump($reflectionParams[1]->getType()->allowsNull()); -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - - ReflectionNamedType::isBuiltin - ReflectionType::__toString - ReflectionParameter::getType - - - - - - - diff --git a/reference/reflection/reflectiontype/tostring.xml b/reference/reflection/reflectiontype/tostring.xml deleted file mode 100644 index 36718fe50..000000000 --- a/reference/reflection/reflectiontype/tostring.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - ReflectionType::__toString - To string - - - - &warn.deprecated.function-7-1-0; - - - - &reftitle.description; - - public stringReflectionType::__toString - - - - Gets the parameter type name. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the type of the parameter. - - - - - &reftitle.examples; - - - <methodname>ReflectionType::__toString</methodname> example - -getParameters()[0]; - -echo $reflectionParam->getType(); -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - 7.1.0 - - ReflectionType::__toString has been deprecated. - - - - - - - - - &reftitle.seealso; - - - ReflectionNamedType::getName - ReflectionNamedType::isBuiltin - ReflectionType::allowsNull - ReflectionUnionType::getTypes - ReflectionParameter::getType - - - - - - - diff --git a/reference/reflection/reflectionuniontype.xml b/reference/reflection/reflectionuniontype.xml deleted file mode 100644 index ec8af841b..000000000 --- a/reference/reflection/reflectionuniontype.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - The ReflectionUnionType class - ReflectionUnionType - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - ReflectionUnionType - - - - - ReflectionUnionType - - - - extends - ReflectionType - - - - - &Methods; - - - - &InheritedMethods; - - - - - - - -
- - - - &reference.reflection.entities.reflectionuniontype; - - - - diff --git a/reference/reflection/reflectionuniontype/gettypes.xml b/reference/reflection/reflectionuniontype/gettypes.xml deleted file mode 100644 index 68986ffcd..000000000 --- a/reference/reflection/reflectionuniontype/gettypes.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - ReflectionUnionType::getTypes - Returns the types included in the union type - - - - &reftitle.description; - - public arrayReflectionUnionType::getTypes - - - - Returns the reflections of types included in the union type. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - An array of ReflectionType objects. - - - - - &reftitle.examples; - - - <methodname>ReflectionUnionType::getTypes</methodname> example - -getParameters()[0]; - -var_dump($reflectionParam->getType()->getTypes()); -]]> - - &example.outputs.similar; - - - class ReflectionNamedType#4(0) { - } - [1] => - class ReflectionNamedType#5(0) { - } -} -]]> - - - - - - - &reftitle.seealso; - - - ReflectionType::allowsNull - ReflectionParameter::getType - - - - - - - diff --git a/reference/runkit7/versions.xml b/reference/runkit7/versions.xml deleted file mode 100644 index cae3ca7a4..000000000 --- a/reference/runkit7/versions.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/sem/versions.xml b/reference/sem/versions.xml deleted file mode 100644 index ead52ae3b..000000000 --- a/reference/sem/versions.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/session/versions.xml b/reference/session/versions.xml deleted file mode 100644 index 66f1002b3..000000000 --- a/reference/session/versions.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/simplexml/versions.xml b/reference/simplexml/versions.xml deleted file mode 100644 index 3fa75285f..000000000 --- a/reference/simplexml/versions.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/sockets/versions.xml b/reference/sockets/versions.xml deleted file mode 100644 index b3d83ebb4..000000000 --- a/reference/sockets/versions.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/solr/versions.xml b/reference/solr/versions.xml deleted file mode 100644 index a457d295b..000000000 --- a/reference/solr/versions.xml +++ /dev/null @@ -1,416 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/stream/versions.xml b/reference/stream/versions.xml deleted file mode 100644 index f51a5f87e..000000000 --- a/reference/stream/versions.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/strings/versions.xml b/reference/strings/versions.xml deleted file mode 100644 index 2cc742d3f..000000000 --- a/reference/strings/versions.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/uodbc/versions.xml b/reference/uodbc/versions.xml deleted file mode 100644 index 7ee1cf7a8..000000000 --- a/reference/uodbc/versions.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/url/versions.xml b/reference/url/versions.xml deleted file mode 100644 index 643cd2c45..000000000 --- a/reference/url/versions.xml +++ /dev/null @@ -1,39 +0,0 @@ - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/var/versions.xml b/reference/var/versions.xml deleted file mode 100644 index b1805f6f0..000000000 --- a/reference/var/versions.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/win32service/versions.xml b/reference/win32service/versions.xml deleted file mode 100644 index 6738b07f5..000000000 --- a/reference/win32service/versions.xml +++ /dev/null @@ -1,36 +0,0 @@ - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/yaml/versions.xml b/reference/yaml/versions.xml deleted file mode 100644 index f3298d954..000000000 --- a/reference/yaml/versions.xml +++ /dev/null @@ -1,35 +0,0 @@ - - - - - - - - - - - - - - diff --git a/reference/zlib/functions/deflate_add.xml b/reference/zlib/functions/deflate_add.xml deleted file mode 100644 index 6af623540..000000000 --- a/reference/zlib/functions/deflate_add.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - deflate_add - Incrementally deflate data - - - - &reftitle.description; - - stringfalsedeflate_add - DeflateContextcontext - stringdata - intflush_modeZLIB_SYNC_FLUSH - - - Incrementally deflates data in the specified context. - - - - - &reftitle.parameters; - - - context - - - A context created with deflate_init. - - - - - data - - - A chunk of data to compress. - - - - - flush_mode - - - One of ZLIB_BLOCK, - ZLIB_NO_FLUSH, - ZLIB_PARTIAL_FLUSH, - ZLIB_SYNC_FLUSH (default), - ZLIB_FULL_FLUSH, ZLIB_FINISH. - Normally you will want to set ZLIB_NO_FLUSH to - maximize compression, and ZLIB_FINISH to terminate - with the last chunk of data. See the zlib manual for a - detailed description of these constants. - - - - - - - - &reftitle.returnvalues; - - Returns a chunk of compressed data, &return.falseforfailure;. - - - - - &reftitle.errors; - - If invalid arguments are given, an error of level - E_WARNING is generated. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - 8.0.0 - - context expects a DeflateContext - instance now; previously, a resource was expected. - - - - - - - - - &reftitle.seealso; - - deflate_init - - - - - diff --git a/reference/zlib/functions/deflate_init.xml b/reference/zlib/functions/deflate_init.xml deleted file mode 100644 index c0d1b642b..000000000 --- a/reference/zlib/functions/deflate_init.xml +++ /dev/null @@ -1,175 +0,0 @@ - - - - - deflate_init - Initialize an incremental deflate context - - - - &reftitle.description; - - DeflateContextfalsedeflate_init - intencoding - arrayoptions[] - - - Initializes an incremental deflate context using the specified - encoding. - - - Note that the window option here only sets the window size - of the algorithm, differently from the zlib filters where the same parameter - also sets the encoding to use; the encoding must be set with the - encoding parameter. - - - Limitation: there is currently no way to set the header information on a GZIP - compressed stream, which are set as follows: GZIP signature - (\x1f\x8B); compression method (\x08 - == DEFLATE); 6 zero bytes; the operating system set to the current system - (\x00 = Windows, \x03 = Unix, etc.) - - - - - &reftitle.parameters; - - - encoding - - - One of the ZLIB_ENCODING_* constants. - - - - - options - - - An associative array which may contain the following elements: - - - level - - - The compression level in range -1..9; defaults to -1. - - - - - memory - - - The compression memory level in range 1..9; defaults to 8. - - - - - window - - - The zlib window size (logarithmic) in range 8..15; - defaults to 15. - zlib changes a window size of 8 to 9, - and as of zlib 1.2.8 fails with a warning, if a window size of 8 - is requested for ZLIB_ENCODING_RAW or ZLIB_ENCODING_GZIP. - - - - - strategy - - - One of ZLIB_FILTERED, - ZLIB_HUFFMAN_ONLY, ZLIB_RLE, - ZLIB_FIXED or - ZLIB_DEFAULT_STRATEGY (the default). - - - - - dictionary - - - A string or an array of strings - of the preset dictionary (default: no preset dictionary). - - - - - - - - - - - - &reftitle.returnvalues; - - Returns a deflate context resource (zlib.deflate) on - success, &return.falseforfailure;. - - - - - &reftitle.errors; - - If an invalid option is passed to options or the - context couldn't be created, an error of level E_WARNING - is generated. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - 8.0.0 - - On success, this function returns a DeflateContext instance now; - previously, a resource was returned. - - - - - - - - - &reftitle.seealso; - - deflate_add - inflate_init - - - - - diff --git a/reference/zlib/functions/inflate-get-read-len.xml b/reference/zlib/functions/inflate-get-read-len.xml deleted file mode 100644 index 599508c10..000000000 --- a/reference/zlib/functions/inflate-get-read-len.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - inflate_get_read_len - Get number of bytes read so far - - - - &reftitle.description; - - intinflate_get_read_len - InflateContextcontext - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - context - - - - - - - - - - - &reftitle.returnvalues; - - Returns number of bytes read so far&return.falseforfailure;. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - 8.0.0 - - context expects an InflateContext - instance now; previously, a resource was expected. - - - - - - - - - diff --git a/reference/zlib/functions/inflate-get-status.xml b/reference/zlib/functions/inflate-get-status.xml deleted file mode 100644 index b913c5da9..000000000 --- a/reference/zlib/functions/inflate-get-status.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - inflate_get_status - Get decompression status - - - - &reftitle.description; - - intinflate_get_status - InflateContextcontext - - - Usually returns either ZLIB_OK or ZLIB_STREAM_END. - - - - - - &reftitle.parameters; - - - context - - - - - - - - - - - &reftitle.returnvalues; - - Returns decompression status&return.falseforfailure;. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - 8.0.0 - - context expects an InflateContext - instance now; previously, a resource was expected. - - - - - - - - - diff --git a/reference/zlib/functions/inflate_add.xml b/reference/zlib/functions/inflate_add.xml deleted file mode 100644 index 6e62ec88c..000000000 --- a/reference/zlib/functions/inflate_add.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - inflate_add - Incrementally inflate encoded data - - - - &reftitle.description; - - stringfalseinflate_add - InflateContextcontext - stringdata - intflush_modeZLIB_SYNC_FLUSH - - - Incrementally inflates encoded data in the specified context. - - - Limitation: header information from GZIP compressed data are not made - available. - - - - - &reftitle.parameters; - - - context - - - A context created with inflate_init. - - - - - data - - - A chunk of compressed data. - - - - - flush_mode - - - One of ZLIB_BLOCK, - ZLIB_NO_FLUSH, - ZLIB_PARTIAL_FLUSH, - ZLIB_SYNC_FLUSH (default), - ZLIB_FULL_FLUSH, ZLIB_FINISH. - Normally you will want to set ZLIB_NO_FLUSH to - maximize compression, and ZLIB_FINISH to terminate - with the last chunk of data. See the zlib manual for a - detailed description of these constants. - - - - - - - - &reftitle.returnvalues; - - Returns a chunk of uncompressed data, &return.falseforfailure;. - - - - - &reftitle.errors; - - If invalid parameters are given, inflating the data requires a preset - dictionary, but none is specified, the compressed stream is corrupt or has an - invalid checksum, an error of level E_WARNING is - generated. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - 8.0.0 - - context expects an InflateContext - instance now; previously, a resource was expected. - - - - - - - - - &reftitle.seealso; - - inflate_init - - - - - diff --git a/reference/zlib/functions/inflate_init.xml b/reference/zlib/functions/inflate_init.xml deleted file mode 100644 index d8174442b..000000000 --- a/reference/zlib/functions/inflate_init.xml +++ /dev/null @@ -1,158 +0,0 @@ - - - - - inflate_init - Initialize an incremental inflate context - - - - &reftitle.description; - - InflateContextfalseinflate_init - intencoding - arrayoptions[] - - - Initialize an incremental inflate context with the specified - encoding. - - - - - &reftitle.parameters; - - - encoding - - - One of the ZLIB_ENCODING_* constants. - - - - - options - - - An associative array which may contain the following elements: - - - level - - - The compression level in range -1..9; defaults to -1. - - - - - memory - - - The compression memory level in range 1..9; defaults to 8. - - - - - window - - - The zlib window size (logarithmic) in range 8..15; defaults to 15. - - - - - strategy - - - One of ZLIB_FILTERED, - ZLIB_HUFFMAN_ONLY, ZLIB_RLE, - ZLIB_FIXED or - ZLIB_DEFAULT_STRATEGY (the default). - - - - - dictionary - - - A string or an array of strings - of the preset dictionary (default: no preset dictionary). - - - - - - - - - - - - &reftitle.returnvalues; - - Returns an inflate context resource (zlib.inflate) on - success, &return.falseforfailure;. - - - - - &reftitle.errors; - - If an invalid encoding or option is passed to options, - or the context couldn't be created, an error of level - E_WARNING is generated. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - 8.0.0 - - On success, this function returns an InflateContext instance now; - previously, a resource was returned. - - - - - - - - - &reftitle.seealso; - - inflate_add - deflate_init - - - - - diff --git a/reference/zlib/versions.xml b/reference/zlib/versions.xml deleted file mode 100644 index 6e2092c53..000000000 --- a/reference/zlib/versions.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file