diff --git a/appendices/aliases.xml b/appendices/aliases.xml index e08ecb5cff6e..f0d81fd51e28 100644 --- a/appendices/aliases.xml +++ b/appendices/aliases.xml @@ -1,6 +1,6 @@ - + List of Function Aliases There are quite a few functions in PHP which you can call with more @@ -234,92 +234,92 @@ mysql mysql_db_query - MySQL + MySQL mysql_createdb mysql_create_db - MySQL + MySQL mysql_db_name mysql_result - MySQL + MySQL mysql_dbname mysql_result - MySQL + MySQL mysql_dropdb mysql_drop_db - MySQL + MySQL mysql_fieldflags mysql_field_flags - MySQL + MySQL mysql_fieldlen mysql_field_len - MySQL + MySQL mysql_fieldname mysql_field_name - MySQL + MySQL mysql_fieldtable mysql_field_table - MySQL + MySQL mysql_fieldtype mysql_field_type - MySQL + MySQL mysql_freeresult mysql_free_result - MySQL + MySQL mysql_listdbs mysql_list_dbs - MySQL + MySQL mysql_listfields mysql_list_fields - MySQL + MySQL mysql_listtables mysql_list_tables - MySQL + MySQL mysql_numfields mysql_num_fields - MySQL + MySQL mysql_numrows mysql_num_rows - MySQL + MySQL mysql_selectdb mysql_select_db - MySQL + MySQL mysql_tablename mysql_result - MySQL + MySQL ociassignelem @@ -594,7 +594,7 @@ recode recode_string - Recode + Recode show_source diff --git a/appendices/extensions.xml b/appendices/extensions.xml index 302fd4ce2920..88e91452a0de 100644 --- a/appendices/extensions.xml +++ b/appendices/extensions.xml @@ -8,35 +8,22 @@ - - - - - - - - - - - - - @@ -44,154 +31,73 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -310,104 +216,10 @@ &extcat.membership.pecl; - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -420,27 +232,6 @@ - - - - - - - - -
- &extcat.state.experimental; - - - - - - - - - - -
diff --git a/appendices/filters.xml b/appendices/filters.xml index 5eb5a72f9ebb..5e496a8dd701 100644 --- a/appendices/filters.xml +++ b/appendices/filters.xml @@ -581,7 +581,7 @@ The compressed file is 1488 bytes long. mcrypt.* and mdecrypt.* provide symmetric encryption and decryption using libmcrypt. Both sets of filters support the same algorithms available to - mcrypt extension in the form of + mcrypt extension in the form of mcrypt.ciphername where ciphername is the name of the cipher as it would be passed to mcrypt_module_open. diff --git a/appendices/ini.list.xml b/appendices/ini.list.xml index 99a9146072e6..6f4919e7a242 100644 --- a/appendices/ini.list.xml +++ b/appendices/ini.list.xml @@ -302,7 +302,6 @@ INI_ALL
- expose_php "1" @@ -347,7 +346,6 @@ - hard_timeout "2" @@ -390,8 +388,6 @@ INI_ALL - - ignore_repeated_errors @@ -486,15 +482,12 @@ - - memory_limit "128M" INI_ALL - @@ -571,7 +564,6 @@ INI_PERDIR
- sendmail_from &null; @@ -715,7 +707,6 @@ INI_SYSTEM - variables_order "EGPCS" diff --git a/appendices/migration56/changed-functions.xml b/appendices/migration56/changed-functions.xml index 646b322b33ef..ceb8a3ae8e7e 100644 --- a/appendices/migration56/changed-functions.xml +++ b/appendices/migration56/changed-functions.xml @@ -1,7 +1,7 @@ - + Changed functions @@ -46,7 +46,7 @@ - <link linkend="book.mcrypt">Mcrypt</link> + <link xlink:href="../extensions/book.mcrypt.php">Mcrypt</link> diff --git a/appendices/migration56/incompatible.xml b/appendices/migration56/incompatible.xml index 5ca3e4402b48..fce677341ee3 100644 --- a/appendices/migration56/incompatible.xml +++ b/appendices/migration56/incompatible.xml @@ -1,7 +1,7 @@ - + Backward incompatible changes Although most existing PHP 5 code should work without changes, please take @@ -99,7 +99,7 @@ array(3) { - <link linkend="book.mcrypt">Mcrypt</link> functions now require valid keys and IVs + <link xlink:href="../extensions/book.mcrypt.php">Mcrypt</link> functions now require valid keys and IVs mcrypt_encrypt, mcrypt_decrypt, diff --git a/appendices/migration70/incompatible/removed-functions.xml b/appendices/migration70/incompatible/removed-functions.xml index 19945fb7ae2b..0bdb9ac50f50 100644 --- a/appendices/migration70/incompatible/removed-functions.xml +++ b/appendices/migration70/incompatible/removed-functions.xml @@ -1,7 +1,7 @@ - + Removed functions @@ -33,7 +33,7 @@ - <link linkend="book.mcrypt">mcrypt</link> aliases + <link xlink:href="../extensions/book.mcrypt.php">mcrypt</link> aliases The deprecated mcrypt_generic_end function has been @@ -53,11 +53,11 @@ All ext/mysql functions - - All ext/mysql functions were removed. For + + All ext/mysql functions were removed. For details about choosing a different MySQL API, see Choosing a MySQL API. - + @@ -67,9 +67,9 @@ All ext/mssql functions were removed. - PDO_SQLSRV + PDO_SQLSRV PDO_ODBC - SQLSRV + SQLSRV Unified ODBC API diff --git a/appendices/migration72/other-changes.xml b/appendices/migration72/other-changes.xml index 3314557d8bf8..4b6868dffe8e 100644 --- a/appendices/migration72/other-changes.xml +++ b/appendices/migration72/other-changes.xml @@ -83,15 +83,15 @@ - Moving <link linkend="book.mcrypt">MCrypt</link> to PECL + Moving <link xlink:href="../extensions/book.mcrypt.php">MCrypt</link> to PECL - - The MCrypt extension has now been moved + + The MCrypt extension has now been moved out of the core to PECL. Given the mcrypt library has not seen any updates since 2007, its usage is highly discouraged. Instead, either the OpenSSL or Sodium extension should be used. - + diff --git a/appendices/migration74/removed-extensions.xml b/appendices/migration74/removed-extensions.xml index be09c5fcd9b4..33bb9180347a 100644 --- a/appendices/migration74/removed-extensions.xml +++ b/appendices/migration74/removed-extensions.xml @@ -13,19 +13,19 @@ - Firebird/Interbase + Firebird/Interbase - access to an InterBase and/or Firebird based database is still available with the PDO Firebird driver. - Recode + Recode - WDDX + WDDX diff --git a/faq/databases.xml b/faq/databases.xml index b8574f19bf7b..9e579a4756a0 100644 --- a/faq/databases.xml +++ b/faq/databases.xml @@ -22,10 +22,10 @@ On Unix machines you can use PDO_ODBC or the Unified ODBC API. - - On Windows machines you can also use PDO_SQLSRV - or SQLSRV. - + + On Windows machines you can also use PDO_SQLSRV + or SQLSRV. + Also see the answer to the next question. diff --git a/install/pie.xml b/install/pie.xml index d730e02bd1c8..c59a49730035 100644 --- a/install/pie.xml +++ b/install/pie.xml @@ -17,7 +17,7 @@ After installing the requirements and PIE itself, you can then install the - MongoDB extension by running the + MongoDB extension by running the following on the command line. diff --git a/install/unix/alpine.xml b/install/unix/alpine.xml index af35e4ce7ef2..c6f3414aebf9 100644 --- a/install/unix/alpine.xml +++ b/install/unix/alpine.xml @@ -54,7 +54,7 @@ Only the core extensions are installed with the base package. Additional extensions such as - MySQL + MySQL cURL GD etc. diff --git a/install/unix/debian.xml b/install/unix/debian.xml index 587e46297940..5b3c53592ee0 100644 --- a/install/unix/debian.xml +++ b/install/unix/debian.xml @@ -53,7 +53,7 @@ dependencies, and then activate it. Apache httpd should be restarted in order f In the last section, PHP was installed with only core modules. It's very likely that additional modules will be desired, such as - MySQL, + MySQL, cURL, GD, etc. These may also be installed via the apt command. diff --git a/install/unix/dnf.xml b/install/unix/dnf.xml index db21bc8bd0d0..df89b699be81 100644 --- a/install/unix/dnf.xml +++ b/install/unix/dnf.xml @@ -52,7 +52,7 @@ In the last section, PHP was installed with only core modules. It's very likely that additional modules will be desired, such as - MySQL + MySQL cURL GD etc. diff --git a/install/unix/pacman.xml b/install/unix/pacman.xml index ba6113ba1f2e..e14e913c78d0 100644 --- a/install/unix/pacman.xml +++ b/install/unix/pacman.xml @@ -50,7 +50,7 @@ In the last section, PHP was installed with only core modules. It is very likely that additional modules will be desired, such as - MySQL + MySQL cURL GD etc. diff --git a/install/windows/recommended.xml b/install/windows/recommended.xml index 6c4c242ad707..129360c6c427 100644 --- a/install/windows/recommended.xml +++ b/install/windows/recommended.xml @@ -57,7 +57,7 @@ wincache.ocenabled=1 ; removed as of wincache 2.0.0.0 For more info, see: - WinCache Configuration + WinCache Configuration
diff --git a/language-snippets.ent b/language-snippets.ent index a721f1edb553..b9680a366f90 100644 --- a/language-snippets.ent +++ b/language-snippets.ent @@ -367,8 +367,8 @@ This function should be used at your own risk. '> The IMAP, recode and -YAZ +linkend="book.imap">IMAP, recode and +YAZ extensions cannot be used in conjunction, because they share the same internal symbols. Note: Yaz 2.0 and above does not suffer from this problem.'> @@ -1340,7 +1340,7 @@ encoding value will be used.'> A function or method to call. - It should return a valid Gearman return value. + It should return a valid Gearman return value. If no return statement is present, it defaults to GEARMAN_SUCCESS. @@ -2259,19 +2259,19 @@ See also MySQL: choosing an API gu Alternatives to this function include:'> This function was deprecated in PHP 4.3.0, and it -and the entire original MySQL extension was removed in PHP 7.0.0. +and the entire original MySQL extension was removed in PHP 7.0.0. Instead, use either the actively developed MySQLi or PDO_MySQL extensions. See also the MySQL: choosing an API guide. Alternatives to this function include:'> This function was deprecated in PHP 5.3.0, and it -and the entire original MySQL extension was removed in PHP 7.0.0. +and the entire original MySQL extension was removed in PHP 7.0.0. Instead, use either the actively developed MySQLi or PDO_MySQL extensions. See also the MySQL: choosing an API guide. Alternatives to this function include:'> This function was deprecated in PHP 5.4.0, and it -and the entire original MySQL extension was removed in PHP 7.0.0. +and the entire original MySQL extension was removed in PHP 7.0.0. Instead, use either the actively developed MySQLi or PDO_MySQL extensions. See also the MySQL: choosing an API guide. Alternatives to this function include:'> @@ -3417,7 +3417,7 @@ local: { - When evaluating query criteria, MongoDB compares types and values according to its own comparison rules for BSON types, which differs from PHP's comparison and type juggling rules. When matching a special BSON type the query criteria should use the respective BSON class (e.g. use MongoDB\BSON\ObjectId to match an ObjectId). + When evaluating query criteria, MongoDB compares types and values according to its own comparison rules for BSON types, which differs from PHP's comparison and type juggling rules. When matching a special BSON type the query criteria should use the respective BSON class (e.g. use MongoDB\BSON\ObjectId to match an ObjectId). diff --git a/language/operators.xml b/language/operators.xml index 68b5fcfd53d6..d0433795a349 100644 --- a/language/operators.xml +++ b/language/operators.xml @@ -1,6 +1,6 @@ - + Operators An operator is something that takes one or more values (or @@ -31,7 +31,7 @@ There is a PECL extension that allows for overloading of some operators for - objects. For more information, see the Operator + objects. For more information, see the Operator Overloading for Objects section. diff --git a/manual.xml b/manual.xml index d9302073d28d..bd6773834908 100644 --- a/manual.xml +++ b/manual.xml @@ -110,30 +110,12 @@ &AffectingPHPsBehaviour; - &reference.apcu.book; - &reference.componere.book; &reference.errorfunc.book; &reference.ffi.book; &reference.opcache.book; - &reference.operator.book; &reference.outcontrol.book; &reference.info.book; &reference.phpdbg.book; - &reference.runkit7.book; - &reference.uopz.book; - &reference.wincache.book; - &reference.xhprof.book; - &reference.yac.book; - - - - &AudioFormatsManipulation; - &reference.openal.book; - - - - &AuthenticationServices; - &reference.radius.book; @@ -144,9 +126,7 @@ &CompressionExtensions; &reference.bzip2.book; - &reference.lzf.book; &reference.phar.book; - &reference.rar.book; &reference.zip.book; &reference.zlib.book; @@ -154,13 +134,10 @@ &CryptographyExtensions; &reference.hash.book; - &reference.mcrypt.book; &reference.mhash.book; &reference.openssl.book; &reference.password.book; - &reference.rnp.book; &reference.sodium.book; - &reference.xpass.book; @@ -175,16 +152,10 @@ &VendorSpecificDatabaseExtensions; - &reference.cubrid.book; - &reference.dbase.book; - &reference.ibase.book; - &reference.ibm-db2.book; - &reference.mongodb.book; &reference.mysqlinfo.set; &reference.oci8.book; &reference.pgsql.book; &reference.sqlite3.book; - &reference.sqlsrv.book; @@ -192,45 +163,35 @@ &CalendarandEventRelatedExtensions; &reference.calendar.book; &reference.datetime.book; - &reference.hrtime.book; &FileSystemRelatedExtensions; - &reference.dio.book; &reference.dir.book; &reference.fileinfo.book; &reference.filesystem.book; - &reference.inotify.book; - &reference.xattr.book; - &reference.xdiff.book; &HumanLanguageandCharacterEncodingSupport; &reference.enchant.book; - &reference.gender.book; &reference.gettext.book; &reference.iconv.book; &reference.intl.book; &reference.mbstring.book; &reference.pspell.book; - &reference.recode.book; &ImageProcessingandGeneration; &reference.exif.book; &reference.image.book; - &reference.gmagick.book; - &reference.imagick.book; &MailRelatedExtensions; &reference.imap.book; &reference.mail.book; - &reference.mailparse.book; @@ -238,92 +199,38 @@ &reference.bc.book; &reference.gmp.book; &reference.math.book; - &reference.stats.book; - &reference.trader.book; - - - - &NonTextMIMEOutput; - &reference.fdf.book; - &reference.gnupg.book; - &reference.wkhtmltox.book; - &reference.ps.book; - &reference.rpminfo.book; - &reference.xlswriter.book; &ProcessControlExtensions; - &reference.eio.book; - &reference.ev.book; - &reference.expect.book; &reference.pcntl.book; &reference.posix.book; &reference.exec.book; - &reference.parallel.book; - &reference.pthreads.book; &reference.sem.book; &reference.shmop.book; - &reference.sync.book; &OtherBasicExtensions; - &reference.geoip.book; - &reference.fann.book; - &reference.igbinary.book; &reference.json.book; - &reference.simdjson.book; - &reference.lua.book; - &reference.luasandbox.book; &reference.misc.book; &reference.random.book; - &reference.seaslog.book; &reference.spl.book; &reference.stream.book; - &reference.swoole.book; &reference.tidy.book; &reference.tokenizer.book; &reference.uri.book; &reference.url.book; - &reference.v8js.book; - &reference.yaml.book; - &reference.yaf.book; - &reference.yaconf.book; - &reference.taint.book; - &reference.ds.book; - &reference.var-representation.book; &OtherServices; &reference.curl.book; - &reference.event.book; &reference.ftp.book; - &reference.gearman.book; &reference.ldap.book; - &reference.memcache.book; - &reference.memcached.book; - &reference.mqseries.book; &reference.network.book; - &reference.rrd.book; - &reference.scoutapm.book; &reference.snmp.book; &reference.sockets.book; - &reference.ssh2.book; - &reference.stomp.book; - &reference.svm.book; - &reference.svn.book; - &reference.tcpwrap.book; - &reference.varnish.book; - &reference.yaz.book; - &reference.zmq.book; - &reference.zookeeper.book; - - - - &SearchEngineExtensions; - &reference.solr.book; @@ -340,10 +247,7 @@ &TextProcessing; - &reference.cmark.book; - &reference.parle.book; &reference.pcre.book; - &reference.ssdeep.book; &reference.strings.book; @@ -354,23 +258,18 @@ &reference.ctype.book; &reference.filter.book; &reference.funchand.book; - &reference.quickhash.book; &reference.reflection.book; &reference.var.book; &WebServices; - &reference.oauth.book; &reference.soap.book; - &reference.yar.book; - &reference.xmlrpc.book; &WindowsOnlyExtensions; &reference.com.book; - &reference.win32service.book; @@ -378,18 +277,11 @@ &reference.dom.book; &reference.libxml.book; &reference.simplexml.book; - &reference.wddx.book; - &reference.xmldiff.book; &reference.xml.book; &reference.xmlreader.book; &reference.xmlwriter.book; &reference.xsl.book; - - - &UIExtensions; - &reference.ui.book; - diff --git a/reference/apcu/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/apcu/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/apcu/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/apcu/apcuiterator.xml b/reference/apcu/apcuiterator.xml deleted file mode 100644 index 924907b12cdf..000000000000 --- a/reference/apcu/apcuiterator.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - The APCUIterator class - APCUIterator - - - - -
- &reftitle.intro; - - The APCUIterator class makes it easier to iterate - over large APCu caches. This is helpful as it allows iterating over large - caches in steps, while grabbing a defined number of entries per lock instance, - so it frees the cache locks for other activities rather than hold up the - entire cache to grab 100 (the default) entries. Also, using regular expression - matching is more efficient as it's been moved to the C level. - -
- - -
- &reftitle.classsynopsis; - - - - APCUIterator - - - - - APCUIterator - - - - Iterator - - - - - - &Methods; - - - - - - -
- -
- - &reference.apcu.entities.apcuiterator; - -
- diff --git a/reference/apcu/apcuiterator/construct.xml b/reference/apcu/apcuiterator/construct.xml deleted file mode 100644 index 3bec4bcefade..000000000000 --- a/reference/apcu/apcuiterator/construct.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - APCUIterator::__construct - Constructs an APCUIterator iterator object - - - - &reftitle.description; - - public APCUIterator::__construct - arraystringnullsearch&null; - intformatAPC_ITER_ALL - intchunk_size100 - intlistAPC_LIST_ACTIVE - - - Constructs an APCUIterator object. - - - - - &reftitle.parameters; - - - search - - - Either a PCRE regular expression that - matches against APCu key names, given as a &string;. - Or an &array; of &string;s with APCu key names. - Or, optionally &null; to skip the search. - - - - - format - - - The desired format, as configured with one or more of the - APC_ITER_* constants. - - - - - chunk_size - - - The chunk size. Must be a value greater than 0. The default - value is 100. - - - - - list - - - The type to list. Either pass in APC_LIST_ACTIVE - or APC_LIST_DELETED. - - - - - - - - &reftitle.examples; - - A <function>APCUIterator::__construct</function> example - - -]]> - - - - - - &reftitle.seealso; - - apcu_exists - apcu_cache_info - - - - - diff --git a/reference/apcu/apcuiterator/current.xml b/reference/apcu/apcuiterator/current.xml deleted file mode 100644 index 5cce4dd5f085..000000000000 --- a/reference/apcu/apcuiterator/current.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - APCUIterator::current - Get current item - - - - &reftitle.description; - - public mixedAPCUIterator::current - - - - Gets the current item from the APCUIterator stack. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the current item on success, or &false; if no - more items exist, or on failure. - - - - - &reftitle.seealso; - - APCUIterator::next - Iterator::current - - - - - diff --git a/reference/apcu/apcuiterator/gettotalcount.xml b/reference/apcu/apcuiterator/gettotalcount.xml deleted file mode 100644 index 719580b177c3..000000000000 --- a/reference/apcu/apcuiterator/gettotalcount.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - APCUIterator::getTotalCount - Get total count - - - - &reftitle.description; - - public intAPCUIterator::getTotalCount - - - - Get the total count. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The total count. - - - - - &reftitle.seealso; - - APCUIterator::getTotalHits - APCUIterator::getTotalSize - apcu_cache_info - - - - - diff --git a/reference/apcu/apcuiterator/gettotalhits.xml b/reference/apcu/apcuiterator/gettotalhits.xml deleted file mode 100644 index 34554fc8cb54..000000000000 --- a/reference/apcu/apcuiterator/gettotalhits.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - APCUIterator::getTotalHits - Get total cache hits - - - - &reftitle.description; - - public intAPCUIterator::getTotalHits - - - - Gets the total number of cache hits. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The number of hits on success, or &false; on failure. - - - - - &reftitle.seealso; - - APCUIterator::getTotalCount - APCUIterator::getTotalSize - apcu_cache_info - - - - - diff --git a/reference/apcu/apcuiterator/gettotalsize.xml b/reference/apcu/apcuiterator/gettotalsize.xml deleted file mode 100644 index 7e45a4553c47..000000000000 --- a/reference/apcu/apcuiterator/gettotalsize.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - APCUIterator::getTotalSize - Get total cache size - - - - &reftitle.description; - - public intAPCUIterator::getTotalSize - - - - Gets the total cache size. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The total cache size. - - - - - &reftitle.seealso; - - APCUIterator::getTotalCount - APCUIterator::getTotalHits - apc_cache_info - - - - - diff --git a/reference/apcu/apcuiterator/key.xml b/reference/apcu/apcuiterator/key.xml deleted file mode 100644 index d48684001129..000000000000 --- a/reference/apcu/apcuiterator/key.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - APCUIterator::key - Get iterator key - - - - &reftitle.description; - - public stringAPCUIterator::key - - - - Gets the current iterator key. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the key on success, or &false; upon failure. - - - - - &reftitle.seealso; - - APCUIterator::current - Iterator::key - - - - - diff --git a/reference/apcu/apcuiterator/next.xml b/reference/apcu/apcuiterator/next.xml deleted file mode 100644 index f24b7fd7ca4c..000000000000 --- a/reference/apcu/apcuiterator/next.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - APCUIterator::next - Move pointer to next item - - - - &reftitle.description; - - public boolAPCUIterator::next - - - - Moves the iterator pointer to the next element. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - APCUIterator::current - APCUIterator::rewind - Iterator::next - - - - - diff --git a/reference/apcu/apcuiterator/rewind.xml b/reference/apcu/apcuiterator/rewind.xml deleted file mode 100644 index 1204b4a97101..000000000000 --- a/reference/apcu/apcuiterator/rewind.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - APCUIterator::rewind - Rewinds iterator - - - - &reftitle.description; - - public voidAPCUIterator::rewind - - - - Rewinds back the iterator to the first element. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - APCUIterator::next - Iterator::next - - - - - diff --git a/reference/apcu/apcuiterator/valid.xml b/reference/apcu/apcuiterator/valid.xml deleted file mode 100644 index 9a5c27755657..000000000000 --- a/reference/apcu/apcuiterator/valid.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - APCUIterator::valid - Checks if current position is valid - - - - &reftitle.description; - - public boolAPCUIterator::valid - - - - Checks if the current iterator position is valid. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; if the current iterator position is valid, otherwise &false;. - - - - - &reftitle.seealso; - - APCUIterator::current - Iterator::valid - - - - - diff --git a/reference/apcu/book.xml b/reference/apcu/book.xml deleted file mode 100644 index 9d72f0feede6..000000000000 --- a/reference/apcu/book.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - APC User Cache - APCu - - - &reftitle.intro; - - APCu is an in-memory key-value store for PHP. - Keys are of type &string; and values can be any PHP variables. - APCu only supports userland caching of variables. - - - The APCu cache is per-process on Windows, so when using a process-based - (rather than thread-based) SAPI, it will not be shared between different processes. - - - APCu is APC stripped of opcode caching. - - - The first APCu codebase was versioned 4.0.0, it was forked from the head of the APC master branch at the time. - PHP 7 support is available as of APCu 5.0.0. PHP 8 support is available as of APCu 5.1.19. - - - - &reference.apcu.setup; - &reference.apcu.constants; - &reference.apcu.reference; - &reference.apcu.apcuiterator; - - - diff --git a/reference/apcu/constants.xml b/reference/apcu/constants.xml deleted file mode 100644 index 6f53dbd84588..000000000000 --- a/reference/apcu/constants.xml +++ /dev/null @@ -1,236 +0,0 @@ - - - &reftitle.constants; - &extension.constants; - - - - - APC_ITER_ALL - (int) - - - - - - - - - - APC_ITER_ATIME - (int) - - - - - - - - - - APC_ITER_CTIME - (int) - - - - - - - - - - APC_ITER_DEVICE - (int) - - - - - - - - - - APC_ITER_DTIME - (int) - - - - - - - - - - APC_ITER_FILENAME - (int) - - - - - - - - - - APC_ITER_INODE - (int) - - - - - - - - - - APC_ITER_KEY - (int) - - - - - - - - - - APC_ITER_MD5 - (int) - - - - - - - - - - APC_ITER_MEM_SIZE - (int) - - - - - - - - - - APC_ITER_MTIME - (int) - - - - - - - - - - APC_ITER_NONE - (int) - - - - - - - - - - APC_ITER_NUM_HITS - (int) - - - - - - - - - - APC_ITER_REFCOUNT - (int) - - - - - - - - - - APC_ITER_TTL - (int) - - - - - - - - - - APC_ITER_TYPE - (int) - - - - - - - - - - APC_ITER_VALUE - (int) - - - - - - - - - - APC_LIST_ACTIVE - (int) - - - - - - - - - - APC_LIST_DELETED - (int) - - - - - - - - - diff --git a/reference/apcu/functions/apcu-add.xml b/reference/apcu/functions/apcu-add.xml deleted file mode 100644 index 5ec172f31048..000000000000 --- a/reference/apcu/functions/apcu-add.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - apcu_add - - Cache a new variable in the data store - - - - &reftitle.description; - - boolapcu_add - stringkey - mixedvar - intttl0 - - - arrayapcu_add - arrayvalues - mixedunusedNULL - intttl0 - - - Caches a variable in the data store, only if it's not already stored. - - - - Unlike many other mechanisms in PHP, variables stored using - apcu_add will persist between requests (until the - value is removed from the cache). - - - - - &reftitle.parameters; - - - key - - - Store the variable using this name. keys are - cache-unique, so attempting to use apcu_add to - store data with a key that already exists will not overwrite the - existing data, and will instead return &false;. (This is the only - difference between apcu_add and - apcu_store.) - - - - - var - - - The variable to store - - - - - ttl - - - Time To Live; store var in the cache for - ttl seconds. After the - ttl has passed, the stored variable will be - expunged from the cache (on the next request). If no ttl - is supplied (or if the ttl is - 0), the value will persist until it is removed from - the cache manually, or otherwise fails to exist in the cache (clear, - restart, etc.). - - - - - values - - - Names in key, variables in value. - - - - - - - &reftitle.returnvalues; - - Returns TRUE if something has effectively been added into the cache, FALSE otherwise. - Second syntax returns array with error keys. - - - - - &reftitle.examples; - - A <function>apcu_add</function> example - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - apcu_store - apcu_fetch - apcu_delete - - - - - diff --git a/reference/apcu/functions/apcu-cache-info.xml b/reference/apcu/functions/apcu-cache-info.xml deleted file mode 100644 index 3ac7c291ccf4..000000000000 --- a/reference/apcu/functions/apcu-cache-info.xml +++ /dev/null @@ -1,153 +0,0 @@ - - - - - apcu_cache_info - - Retrieves cached information from APCu's data store - - - - &reftitle.description; - - arrayfalseapcu_cache_info - boollimited&false; - - - Retrieves cached information and meta-data from APCu's data store. - - - - - &reftitle.parameters; - - - limited - - - If limited is &true;, the - return value will exclude the individual list of cache entries. This - is useful when trying to optimize calls for statistics gathering. - - - - - - - - &reftitle.returnvalues; - - Array of cached data (and meta-data)&return.falseforfailure; - - - - apcu_cache_info will raise a warning if it is unable to - retrieve APCu cache data. This typically occurs when APCu is not enabled. - - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL apcu 3.0.11 - - The limited parameter was introduced. - - - - PECL apcu 3.0.16 - - The "filehits" option for the - cache_type parameter was introduced. - - - - - - - - - &reftitle.examples; - - A <function>apcu_cache_info</function> example - - -]]> - - &example.outputs.similar; - - 2000 - [ttl] => 0 - [num_hits] => 9 - [num_misses] => 3 - [start_time] => 1123958803 - [cache_list] => Array - ( - [0] => Array - ( - [filename] => /path/to/apcu_test.php - [device] => 29954 - [inode] => 1130511 - [type] => file - [num_hits] => 1 - [mtime] => 1123960686 - [creation_time] => 1123960696 - [deletion_time] => 0 - [access_time] => 1123962864 - [ref_count] => 1 - [mem_size] => 677 - ) - [1] => Array (...iterates for each cached file) -) -]]> - - - - - - &reftitle.seealso; - - APCu configuration directives - APCUIterator::getTotalSize - APCUIterator::getTotalHits - APCUIterator::getTotalCount - - - - - diff --git a/reference/apcu/functions/apcu-cas.xml b/reference/apcu/functions/apcu-cas.xml deleted file mode 100644 index c7ed9635aceb..000000000000 --- a/reference/apcu/functions/apcu-cas.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - apcu_cas - Updates an old value with a new value - - - - &reftitle.description; - - boolapcu_cas - stringkey - intold - intnew - - - apcu_cas updates an already existing integer value if the - old parameter matches the currently stored value - with the value of the new parameter. - - - - - &reftitle.parameters; - - - key - - - The key of the value being updated. - - - - - old - - - The old value (the value currently stored). - - - - - new - - - The new value to update to. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>apcu_cas</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - apcu_dec - apcu_store - - - - - diff --git a/reference/apcu/functions/apcu-clear-cache.xml b/reference/apcu/functions/apcu-clear-cache.xml deleted file mode 100644 index afdb45ef8b02..000000000000 --- a/reference/apcu/functions/apcu-clear-cache.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - apcu_clear_cache - - Clears the APCu cache - - - - &reftitle.description; - - boolapcu_clear_cache - - - - Clears the cache. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; always - - - - - &reftitle.seealso; - - apcu_cache_info - - - - - diff --git a/reference/apcu/functions/apcu-dec.xml b/reference/apcu/functions/apcu-dec.xml deleted file mode 100644 index 02fa81a20ce9..000000000000 --- a/reference/apcu/functions/apcu-dec.xml +++ /dev/null @@ -1,146 +0,0 @@ - - - - - apcu_dec - Decrease a stored number - - - - &reftitle.description; - - intfalseapcu_dec - stringkey - intstep1 - boolsuccess - intttl0 - - - Decreases a stored integer value. - - - - - &reftitle.parameters; - - - key - - - The key of the value being decreased. - - - - - step - - - The step, or value to decrease. - - - - - success - - - Optionally pass the success or fail boolean value to - this referenced variable. - - - - - ttl - - - TTL to use if the operation inserts a new value (rather than decrementing an existing one). - - - - - - - - &reftitle.returnvalues; - - Returns the current value of key's value on success, - &return.falseforfailure; - - - - - &reftitle.examples; - - <function>apcu_dec</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - apcu_inc - - - - - diff --git a/reference/apcu/functions/apcu-delete.xml b/reference/apcu/functions/apcu-delete.xml deleted file mode 100644 index edf55339ec95..000000000000 --- a/reference/apcu/functions/apcu-delete.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - apcu_delete - - Removes a stored variable from the cache - - - - &reftitle.description; - - mixedapcu_delete - mixedkey - - - Removes a stored variable from the cache. - - - - &reftitle.parameters; - - - key - - - A key used to store the value as a - string for a single key, - or as an array of strings for several keys, - or as an APCUIterator object. - - - - - - - &reftitle.returnvalues; - - If key is an &array;, an indexed &array; of the keys is returned. - Otherwise &true; is returned on success, or &false; on failure. - - - - - &reftitle.examples; - - A <function>apcu_delete</function> example - - -]]> - - - - - - &reftitle.seealso; - - apcu_store - apcu_fetch - apcu_clear_cache - APCUIterator - - - - - diff --git a/reference/apcu/functions/apcu-enabled.xml b/reference/apcu/functions/apcu-enabled.xml deleted file mode 100644 index 444becf25c91..000000000000 --- a/reference/apcu/functions/apcu-enabled.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - apcu_enabled - Whether APCu is usable in the current environment - - - - &reftitle.description; - - boolapcu_enabled - - - - Returns whether APCu is usable in the current environment. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; when APCu is usable in the current environment, &false; otherwise. - - - - - diff --git a/reference/apcu/functions/apcu-entry.xml b/reference/apcu/functions/apcu-entry.xml deleted file mode 100644 index 7abe698949b9..000000000000 --- a/reference/apcu/functions/apcu-entry.xml +++ /dev/null @@ -1,163 +0,0 @@ - - - - - apcu_entry - - Atomically fetch or generate a cache entry - - - - &reftitle.description; - - mixedapcu_entry - stringkey - callablecallback - intttl0 - - - Atomically attempts to find key in the cache, if it cannot be found callback - is called, passing key as the only argument. The return value of the call is then cached with the optionally specified - ttl, and returned. - - - - When control enters apcu_entry the lock for the cache is acquired exclusively, it is released when control leaves apcu_entry: - In effect, this turns the body of callback into a critical section, disallowing two processes from executing the same code paths concurrently. - In addition, it prohibits the concurrent execution of any other APCu functions, since they will acquire the same lock. - - - - - The only APCu function that can be called safely by callback is apcu_entry. - - - - - &reftitle.parameters; - - - key - - - Identity of cache entry - - - - - callback - - - A callable that accepts key as the only argument and returns the value to cache. - - - - - ttl - - - Time To Live; store the callback's return value in the cache for - ttl seconds. After the - ttl has passed, the stored entry will be - expunged from the cache (on the next request). If no ttl - is supplied (or if the ttl is - 0), the value will persist until it is removed from - the cache manually, or otherwise fails to exist in the cache (clear, - restart, etc.). - - - - - - - &reftitle.returnvalues; - - Returns the cached value - - - - - &reftitle.examples; - - An <function>apcu_entry</function> example - - apcu_entry("config.fruit", function($key){ - return [ - "apples", - "pears" - ]; - }), - "people" => apcu_entry("config.people", function($key){ - return [ - "bob", - "joe", - "niki" - ]; - }) - ]; -}); - -var_dump($config); -?> -]]> - - &example.outputs; - - - array(2) { - [0]=> - string(6) "apples" - [1]=> - string(5) "pears" - } - ["people"]=> - array(3) { - [0]=> - string(3) "bob" - [1]=> - string(3) "joe" - [2]=> - string(4) "niki" - } -} -]]> - - - - - - &reftitle.seealso; - - apcu_store - apcu_fetch - apcu_delete - - - - - diff --git a/reference/apcu/functions/apcu-exists.xml b/reference/apcu/functions/apcu-exists.xml deleted file mode 100644 index 61a81f2b7842..000000000000 --- a/reference/apcu/functions/apcu-exists.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - apcu_exists - Checks if entry exists - - - - &reftitle.description; - - boolarrayapcu_exists - stringarraykeys - - - Checks if one or more APCu entries exist. - - - - - &reftitle.parameters; - - - keys - - - A string, or an array of strings, that - contain keys. - - - - - - - - &reftitle.returnvalues; - - Returns &true; if the key exists, otherwise &false; Or if an - array was passed to keys, then - an array is returned that contains all existing keys, or an empty - array if none exist. - - - - - &reftitle.examples; - - <function>apcu_exists</function> example - - -]]> - - &example.outputs.similar; - - - bool(true) - ["bar"]=> - bool(true) -} -]]> - - - - - - &reftitle.seealso; - - apcu_cache_info - apcu_fetch - - - - diff --git a/reference/apcu/functions/apcu-fetch.xml b/reference/apcu/functions/apcu-fetch.xml deleted file mode 100644 index 1555e9862eb0..000000000000 --- a/reference/apcu/functions/apcu-fetch.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - apcu_fetch - - Fetch a stored variable from the cache - - - - &reftitle.description; - - mixedapcu_fetch - mixedkey - boolsuccess - - - Fetches an entry from the cache. - - - - &reftitle.parameters; - - - key - - - The key used to store the value (with - apcu_store). If an array is passed then each - element is fetched and returned. - - - - - success - - - Set to &true; in success and &false; in failure. - - - - - - - &reftitle.returnvalues; - - The stored variable or array of variables on success; &false; on failure - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL apcu 3.0.17 - - The success parameter was added. - - - - - - - - - &reftitle.examples; - - A <function>apcu_fetch</function> example - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - apcu_store - apcu_delete - APCUIterator - - - - - diff --git a/reference/apcu/functions/apcu-inc.xml b/reference/apcu/functions/apcu-inc.xml deleted file mode 100644 index af7b0465b259..000000000000 --- a/reference/apcu/functions/apcu-inc.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - apcu_inc - Increase a stored number - - - - &reftitle.description; - - intfalseapcu_inc - stringkey - intstep1 - boolsuccess - intttl0 - - - Increases a stored number. - - - - - &reftitle.parameters; - - - key - - - The key of the value being increased. - - - - - step - - - The step, or value to increase. - - - - - success - - - Optionally pass the success or fail boolean value to - this referenced variable. - - - - - ttl - - - TTL to use if the operation inserts a new value (rather than incrementing an existing one). - - - - - - - - &reftitle.returnvalues; - - Returns the current value of key's value on success, - &return.falseforfailure; - - - - - &reftitle.examples; - - <function>apcu_inc</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - apcu_dec - - - - - diff --git a/reference/apcu/functions/apcu-key-info.xml b/reference/apcu/functions/apcu-key-info.xml deleted file mode 100644 index cfaf160e5034..000000000000 --- a/reference/apcu/functions/apcu-key-info.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - apcu_key_info - - Get detailed information about the cache key - - - - - &reftitle.description; - - arraynullapcu_key_info - stringkey - - - Get detailed information about the cache key - - - - - &reftitle.parameters; - - - key - - - The key to retrieve information for. - - - - - - - - &reftitle.returnvalues; - - An array containing the detailed information about the cache key, or &null; if the key does not exist. - - - - - &reftitle.examples; - - A <function>apcu_key_info</function> example - - -]]> - - &example.outputs; - - - int(0) - ["access_time"]=> - int(1606701783) - ["mtime"]=> - int(1606701783) - ["creation_time"]=> - int(1606701783) - ["deletion_time"]=> - int(0) - ["ttl"]=> - int(0) - ["refs"]=> - int(0) -} -]]> - - - - - - &reftitle.seealso; - - apcu_store - apcu_fetch - apcu_delete - - - - - diff --git a/reference/apcu/functions/apcu-sma-info.xml b/reference/apcu/functions/apcu-sma-info.xml deleted file mode 100644 index 135779b929e3..000000000000 --- a/reference/apcu/functions/apcu-sma-info.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - apcu_sma_info - - Retrieves APCu Shared Memory Allocation information - - - - &reftitle.description; - - arrayfalseapcu_sma_info - boollimited&false; - - - Retrieves APCu Shared Memory Allocation information. - - - - - &reftitle.parameters; - - - limited - - - When set to &false; (default) apcu_sma_info will - return a detailed information about each segment. - - - - - - - - &reftitle.returnvalues; - - Array of Shared Memory Allocation data; &false; on failure. - - - - - &reftitle.examples; - - A <function>apcu_sma_info</function> example - - -]]> - - &example.outputs.similar; - - 1 - [seg_size] => 31457280 - [avail_mem] => 31448408 - [block_lists] => Array - ( - [0] => Array - ( - [0] => Array - ( - [size] => 31448408 - [offset] => 8864 - ) - - ) - - ) - -) -]]> - - - - - - &reftitle.seealso; - - - APCu configuration directives - - - - - - diff --git a/reference/apcu/functions/apcu-store.xml b/reference/apcu/functions/apcu-store.xml deleted file mode 100644 index 0bd00e37a76c..000000000000 --- a/reference/apcu/functions/apcu-store.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - apcu_store - - Cache a variable in the data store - - - - &reftitle.description; - - boolapcu_store - stringkey - mixedvar - intttl0 - - - arrayapcu_store - arrayvalues - mixedunusedNULL - intttl0 - - - Cache a variable in the data store. - - - - Unlike many other mechanisms in PHP, variables stored using - apcu_store will persist between requests (until the - value is removed from the cache). - - - - - &reftitle.parameters; - - - key - - - Store the variable using this name. keys are - cache-unique, so storing a second value with the same - key will overwrite the original value. - - - - - var - - - The variable to store - - - - - ttl - - - Time To Live; store var in the cache for - ttl seconds. After the - ttl has passed, the stored variable will be - expunged from the cache (on the next request). If no ttl - is supplied (or if the ttl is - 0), the value will persist until it is removed from - the cache manually, or otherwise fails to exist in the cache (clear, - restart, etc.). - - - - - values - - - Names in key, variables in value. - - - - - - - &reftitle.returnvalues; - - &return.success; - Second syntax returns array with error keys. - - - - - &reftitle.examples; - - A <function>apcu_store</function> example - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - apcu_add - apcu_fetch - apcu_delete - - - - - diff --git a/reference/apcu/ini.xml b/reference/apcu/ini.xml deleted file mode 100644 index 06a0f5eccfee..000000000000 --- a/reference/apcu/ini.xml +++ /dev/null @@ -1,384 +0,0 @@ - - -
- &reftitle.runtime; - &extension.runtime; - - Although the default APCu settings are fine for many installations, serious - users should consider tuning the following parameters. - - - There is one decision to be made configuring APCu. - How much memory is going to be allocated to APCu. - The ini directive that controls this is apc.shm_size - Read the sections on this carefully below. - - - Once the server is running, the apc.php script that - is bundled with the extension should be copied somewhere into the docroot and - viewed with a browser as it provides a detailed analysis of the internal - workings of APCu. If GD is enabled in PHP, it will even display some - interesting graphs. - - If APCu is working, the Cache full count - number (on the left) will display the number of times the cache - has reached maximum capacity and has had to evict entries to free up memory. - During eviction, if apc.ttl was specified, APCu will first - attempt to remove expired entries, i.e. entries whose TTL has either expired, - or entries that have no TTL set and haven't been accessed in the last - apc.ttl seconds. If apc.ttl was not set, - or removing expired entries did not free up enough space, APCu will clear the - entire cache. - - - The number of evictions should be minimal in a well-configured cache. If the - cache is constantly being filled, and thusly forcefully freed, the resulting - churning will have disparaging effects on script performance. The easiest way - to minimize this number is to allocate more memory for APCu. - - - When APCu is compiled with mmap support (Memory Mapping), it will use only one - memory segment, unlike when APCu is built with SHM (SysV Shared Memory) support - that uses multiple memory segments. MMAP does not have a maximum limit like SHM - does in /proc/sys/kernel/shmmax. In general MMAP support is - recommended because it will reclaim the memory faster when the webserver is - restarted and all in all reduces memory allocation impact at startup. - - - - APCu configuration options - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - apc.enabled - 1 - INI_SYSTEM - - - - apc.shm_segments - 1 - INI_SYSTEM - - - - apc.shm_size - "32M" - INI_SYSTEM - - - - apc.entries_hint - 512 * apc.shm_size - INI_SYSTEM - Prior to APCu 5.1.25, the default was 4096 - - - apc.ttl - 0 - INI_SYSTEM - - - - apc.gc_ttl - 3600 - INI_SYSTEM - - - - apc.mmap_file_mask - NULL - INI_SYSTEM - - - - apc.slam_defense - 0 - INI_SYSTEM - - - - apc.enable_cli - 0 - INI_SYSTEM - - - - apc.use_request_time - 0 - INI_ALL - Prior to APCu 5.1.19, the default was 1. - - - apc.serializer - "php" - INI_SYSTEM - Prior to APCu 5.1.15, the default was "default". - - - apc.coredump_unmap - 0 - INI_SYSTEM - - - - apc.preload_path - NULL - INI_SYSTEM - - - - -
- &ini.php.constants; -
- - &ini.descriptions.title; - - - - - apc.enabled - bool - - - - apc.enabled can be set to 0 to disable APC. This is - primarily useful when APC is statically compiled - into PHP, since there is no other way to disable - it (when compiled as a DSO, the extension - line in php.ini can just be commented-out). - - - - - - apc.shm_segments - int - - - - The number of shared memory segments to allocate - for the compiler cache. If APC is running out of - shared memory but apc.shm_size - is set as high as the system allows, raising - this value might prevent APC from exhausting its memory. - - - - - - apc.shm_size - string - - - - The size of each shared memory segment given by a shorthand notation as - described in this FAQ. - By default, some systems (including most BSD - variants) have very low limits on the size of a - shared memory segment. - - - - - - apc.entries_hint - int - - - - A "hint" about the number of distinct variables that might be stored. - Set to zero or omit if not sure. - - - - - - apc.ttl - int - - - - Consider cache entries without an explicit TTL to be - expired if they have not been accessed in this many - seconds. Effectively, this allows such entries to be - removed opportunistically during a cache insert, or - prior to a full expunge. Note that because removal is - opportunistic, entries can still be readable even if - they are older than apc.ttl seconds. - This setting has no effect on cache entries that have - an explicit TTL specified. - - - - - - apc.gc_ttl - int - - - - The number of seconds that a cache entry may - remain on the garbage-collection list after being removed or invalidated. - Entries are eligible for removal if their reference count is zero, - or they exceed this time limit. - If set to 0, time-based cleanup is disabled, - and entries are only removed when their reference count drops to zero. - - - - - - apc.mmap_file_mask - string - - - - If compiled with MMAP support by using --enable-mmap - this is the mktemp-style file_mask to pass to the - mmap module for determining whether your mmap'ed memory - region is going to be file-backed or shared memory - backed. For straight file-backed mmap, set it to - something like /tmp/apc.XXXXXX - (exactly 6 Xs). - To use POSIX-style shm_open/mmap put a .shm - somewhere in your mask. e.g. /apc.shm.XXXXXX - You can also set it to /dev/zero to use your - kernel's /dev/zero interface to anonymous mmap'ed - memory. Leaving it undefined will force an anonymous mmap. - - - - - - apc.slam_defense - bool - - - - On very busy servers whenever you start the server or - modify files you can create a race of many processes - all trying to cache the same file at the same time. - Setting apc.slam_defense to 1 - can help prevent multiple processes from caching the - same file simultaneously by introducing a probability - mechanism. If the same key is attempted to be cached - within a short period by different processes, it skips - the caching for the current process to mitigate potential - cache slams. - - - - - - apc.enable_cli - int - - - - Mostly for testing and debugging. Setting this enables APC - for the CLI version of PHP. Under normal circumstances, it is - not ideal to create, populate and destroy the APC cache on every - CLI request, but for various test scenarios it is useful to be - able to enable APC for the CLI version of PHP easily. - - - - - - apc.serializer - string - - - - Used to configure APC to use a third party serializer. - - - - - - apc.coredump_unmap - bool - - - - Enables APC handling of signals, such as SIGSEGV, that write - core files when signaled. When these signals are received, - APC will attempt to unmap the shared memory segment in order - to exclude it from the core file. This setting may improve - system stability when fatal signals are received and a large - APC shared memory segment is configured. - - - - This feature is potentially dangerous. Unmapping the shared - memory segment in a fatal signal handler may cause undefined - behaviour if a fatal error occurs. - - - - - Although some kernels may provide a facility to ignore various - types of shared memory when generating a core dump file, these - implementations may also ignore important shared memory segments - such as the Apache scoreboard. - - - - - - - apc.preload_path - string - - - - Optionally, set a path to the directory that APC will load - cache data at startup. - - - - - - - apc.use_request_time - bool - - - - Use the SAPI request start time for - TTL. - - - - -
- diff --git a/reference/apcu/reference.xml b/reference/apcu/reference.xml deleted file mode 100644 index dd8251c90c35..000000000000 --- a/reference/apcu/reference.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - APCu &Functions; - - &reference.apcu.entities.functions; - - - - - diff --git a/reference/apcu/setup.xml b/reference/apcu/setup.xml deleted file mode 100644 index e6263aa74b89..000000000000 --- a/reference/apcu/setup.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - &reftitle.setup; - -
- &reftitle.install; - - &pecl.info; - &url.pecl.package;apcu. - - - - PHP 7 has a separate module (apcu-bc) for backwards compatibility with APC. - - - In backward compatibility mode, APCu registers the applicable APC functions - with backward compatible prototypes. - - - Where an APC function accepted cache_type, it is simply - ignored by the backward compatible version, and omitted from the prototype for - the APCu version. - - - - - As of PHP 8.0.0, apcu-bc is no longer supported. - - - - - On Windows, APCu needs a temp path to exist, and be - writable by the web server. It checks the TMP, TEMP - and USERPROFILE environment variables in that order - and finally tries the WINDOWS directory if none of - those are set. - - - - - For more in-depth, highly technical implementation details, see the - - developer-supplied TECHNOTES file - . - - - - APCu sources can be found here. - -
- - &reference.apcu.ini; - -
- diff --git a/reference/apcu/versions.xml b/reference/apcu/versions.xml deleted file mode 100644 index b9d0992d6890..000000000000 --- a/reference/apcu/versions.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/cmark/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/cmark/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/cmark/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/cmark/book.xml b/reference/cmark/book.xml deleted file mode 100644 index 2b81863aeaf6..000000000000 --- a/reference/cmark/book.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - CommonMark - CommonMark - - - &reftitle.intro; - - This extension provides access to the reference implementation of CommonMark, a rationalized version of Markdown syntax with a specification. - - - Parsing: - - The CommonMark extension provides a simple parsing API: - - - - - Rendering: - - The CommonMark extension provides simple rendering API that supports multiple formats: - - - - - - - - - AST: - - The CommonMark extension implements visitation for CommonMark\Node objects: - - - - - CQL: - - The CommonMark extension provides an interface to CQL, CommonMark Query Language: - - - - - - &reference.cmark.setup; - &reference.cmark.constants; - &reference.cmark.commonmark.node.document; - &reference.cmark.commonmark.node.heading; - &reference.cmark.commonmark.node.paragraph; - &reference.cmark.commonmark.node.blockquote; - &reference.cmark.commonmark.node.bulletlist; - &reference.cmark.commonmark.node.orderedlist; - &reference.cmark.commonmark.node.item; - &reference.cmark.commonmark.node.text; - &reference.cmark.commonmark.node.text.strong; - &reference.cmark.commonmark.node.text.emphasis; - &reference.cmark.commonmark.node.thematicbreak; - &reference.cmark.commonmark.node.softbreak; - &reference.cmark.commonmark.node.linebreak; - &reference.cmark.commonmark.node.code; - &reference.cmark.commonmark.node.codeblock; - &reference.cmark.commonmark.node.htmlblock; - &reference.cmark.commonmark.node.htmlinline; - &reference.cmark.commonmark.node.image; - &reference.cmark.commonmark.node.link; - &reference.cmark.commonmark.node.customblock; - &reference.cmark.commonmark.node.custominline; - &reference.cmark.commonmark.node; - &reference.cmark.commonmark.interfaces.ivisitor; - &reference.cmark.commonmark.interfaces.ivisitable; - &reference.cmark.commonmark.parser; - &reference.cmark.commonmark.cql; - &reference.cmark.reference; - - - diff --git a/reference/cmark/commonmark.cql.xml b/reference/cmark/commonmark.cql.xml deleted file mode 100644 index c839f164bda7..000000000000 --- a/reference/cmark/commonmark.cql.xml +++ /dev/null @@ -1,135 +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 its 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 1cc72f649069..000000000000 --- a/reference/cmark/commonmark.interfaces.ivisitable.xml +++ /dev/null @@ -1,65 +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 67b524ba79cd..000000000000 --- a/reference/cmark/commonmark.interfaces.ivisitor.xml +++ /dev/null @@ -1,83 +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 cdc4f3492473..000000000000 --- 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 cc64e15a8a7f..000000000000 --- 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 d484612f4827..000000000000 --- 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 19b66f9cdaad..000000000000 --- 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 660080400713..000000000000 --- 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 c84074bd74c7..000000000000 --- 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 8ec1ce8e3789..000000000000 --- 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 9d9bcc0cdeba..000000000000 --- 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 a12622f73857..000000000000 --- 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 cdca6b31fc59..000000000000 --- 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 60369de685eb..000000000000 --- 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 0cb79c3e2410..000000000000 --- 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 f8a2942c6de8..000000000000 --- 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 f7071a33cdd6..000000000000 --- 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 3121b8510a36..000000000000 --- 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 337a6b517728..000000000000 --- 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 579d42576548..000000000000 --- 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 40bbbb3904db..000000000000 --- 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 787b2d67cff0..000000000000 --- 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 7343edcae75e..000000000000 --- 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 61643cd00ca4..000000000000 --- 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 e57acf2123bf..000000000000 --- a/reference/cmark/commonmark.node.xml +++ /dev/null @@ -1,138 +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 9ea64aa69064..000000000000 --- a/reference/cmark/commonmark.parser.xml +++ /dev/null @@ -1,71 +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 08aff3732155..000000000000 --- a/reference/cmark/commonmark/cql/construct.xml +++ /dev/null @@ -1,55 +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 534758d3a309..000000000000 --- a/reference/cmark/commonmark/cql/invoke.xml +++ /dev/null @@ -1,73 +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/ivisitable/accept.xml b/reference/cmark/commonmark/interfaces/ivisitable/accept.xml deleted file mode 100644 index 791b8cff8450..000000000000 --- a/reference/cmark/commonmark/interfaces/ivisitable/accept.xml +++ /dev/null @@ -1,60 +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 2d23d8c24155..000000000000 --- a/reference/cmark/commonmark/interfaces/ivisitor/enter.xml +++ /dev/null @@ -1,79 +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 d603b92cf95a..000000000000 --- a/reference/cmark/commonmark/interfaces/ivisitor/leave.xml +++ /dev/null @@ -1,79 +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/accept.xml b/reference/cmark/commonmark/node/accept.xml deleted file mode 100644 index 473619597f3f..000000000000 --- a/reference/cmark/commonmark/node/accept.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - CommonMark\Node::accept - Visitation - - - - &reftitle.description; - - public voidCommonMark\Node::accept - CommonMark\Interfaces\IVisitorvisitor - - - - - - &reftitle.parameters; - - - visitor - - - An object implementing CommonMark\Interfaces\IVisitor - - - - - - - - &reftitle.seealso; - - - - - - - - - diff --git a/reference/cmark/commonmark/node/appendchild.xml b/reference/cmark/commonmark/node/appendchild.xml deleted file mode 100644 index ba6328f08e33..000000000000 --- a/reference/cmark/commonmark/node/appendchild.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - CommonMark\Node::appendChild - AST Manipulation - - - - &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 cbf2ee8a063b..000000000000 --- a/reference/cmark/commonmark/node/bulletlist/construct.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - CommonMark\Node\BulletList::__construct - BulletList Construction - - - - &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 0c4f468ad969..000000000000 --- a/reference/cmark/commonmark/node/codeblock/construct.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - CommonMark\Node\CodeBlock::__construct - CodeBlock Construction - - - - &reftitle.description; - - public CommonMark\Node\CodeBlock::__construct - stringfence - stringliteral - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - fence - - - - - - - - literal - - - - - - - - - - - - - - - diff --git a/reference/cmark/commonmark/node/heading/construct.xml b/reference/cmark/commonmark/node/heading/construct.xml deleted file mode 100644 index 6ba1bad660d2..000000000000 --- a/reference/cmark/commonmark/node/heading/construct.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - CommonMark\Node\Heading::__construct - Heading Construction - - - - &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 15a950104ec2..000000000000 --- a/reference/cmark/commonmark/node/image/construct.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - CommonMark\Node\Image::__construct - Image Construction - - - - &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 5df5829eeefe..000000000000 --- a/reference/cmark/commonmark/node/insertafter.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - CommonMark\Node::insertAfter - AST Manipulation - - - - &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 efcfb595d86f..000000000000 --- a/reference/cmark/commonmark/node/insertbefore.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - CommonMark\Node::insertBefore - AST Manipulation - - - - &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 277c2e100d00..000000000000 --- a/reference/cmark/commonmark/node/link/construct.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - CommonMark\Node\Link::__construct - Link Construction - - - - &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/orderedlist/construct.xml b/reference/cmark/commonmark/node/orderedlist/construct.xml deleted file mode 100644 index 3e7f12d0fb22..000000000000 --- a/reference/cmark/commonmark/node/orderedlist/construct.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - CommonMark\Node\OrderedList::__construct - OrderedList Construction - - - - &reftitle.description; - - public CommonMark\Node\OrderedList::__construct - - - - public CommonMark\Node\OrderedList::__construct - inttight - - - public CommonMark\Node\OrderedList::__construct - inttight - intdelimiter - - - public CommonMark\Node\OrderedList::__construct - inttight - intdelimiter - intstart - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - tight - - - - - - - - delimiter - - - - - - - - start - - - - - - - - - - - - - - - diff --git a/reference/cmark/commonmark/node/prependchild.xml b/reference/cmark/commonmark/node/prependchild.xml deleted file mode 100644 index 40533d1df48e..000000000000 --- a/reference/cmark/commonmark/node/prependchild.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - CommonMark\Node::prependChild - AST Manipulation - - - - &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 e9dd7e643cb8..000000000000 --- a/reference/cmark/commonmark/node/replace.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - CommonMark\Node::replace - AST Manipulation - - - - &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 fd224d92883a..000000000000 --- a/reference/cmark/commonmark/node/text/construct.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - CommonMark\Node\Text::__construct - Text Construction - - - - &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 e6259d869a05..000000000000 --- a/reference/cmark/commonmark/node/unlink.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - CommonMark\Node::unlink - AST Manipulation - - - - &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 d6d2254656fd..000000000000 --- a/reference/cmark/commonmark/parser/construct.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - CommonMark\Parser::__construct - Parsing - - - - &reftitle.description; - - public CommonMark\Parser::__construct - intoptions - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - options - - - A mask of: - - - - - CommonMark\Parser\Normal - (int) - - - - - - - - - CommonMark\Parser\Normalize - (int) - - - - - - - - - CommonMark\Parser\ValidateUTF8 - (int) - - - - - - - - - CommonMark\Parser\Smart - (int) - - - - - - - - - - - - - - diff --git a/reference/cmark/commonmark/parser/finish.xml b/reference/cmark/commonmark/parser/finish.xml deleted file mode 100644 index be0085cc6c9c..000000000000 --- a/reference/cmark/commonmark/parser/finish.xml +++ /dev/null @@ -1,56 +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 4812cf407c0c..000000000000 --- a/reference/cmark/commonmark/parser/parse.xml +++ /dev/null @@ -1,65 +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 6b66114e805a..000000000000 --- a/reference/cmark/configure.xml +++ /dev/null @@ -1,34 +0,0 @@ - - -
- &reftitle.install; - - - Use when compiling PHP. - - - - Windows users should include php_cmark.dll into &php.ini; - - -
- diff --git a/reference/cmark/constants.xml b/reference/cmark/constants.xml deleted file mode 100644 index 50f69e8a0781..000000000000 --- a/reference/cmark/constants.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - &reftitle.constants; - - - - CommonMark\Parser\Normal - (int) - - - - - - - - - CommonMark\Parser\Normalize - (int) - - - - - - - - - CommonMark\Parser\Smart - (int) - - - - - - - - - CommonMark\Parser\ValidateUTF8 - (int) - - - - - - - - - CommonMark\Render\HardBreaks - (int) - - - - - - - - - CommonMark\Render\NoBreaks - (int) - - - - - - - - - CommonMark\Render\Normal - (int) - - - - - - - - - CommonMark\Render\Safe - (int) - - - - - - - - - CommonMark\Render\SourcePos - (int) - - - - - - - - - diff --git a/reference/cmark/functions/commonmark.parse.xml b/reference/cmark/functions/commonmark.parse.xml deleted file mode 100644 index 21477c4328fe..000000000000 --- a/reference/cmark/functions/commonmark.parse.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - CommonMark\Parse - Parsing - - - - &reftitle.description; - - CommonMark\NodeCommonMark\Parse - stringcontent - intoptions - - - Shall parse content - - - - - - &reftitle.parameters; - - - content - - - markdown string - - - - - options - - - A mask of: - - - - - CommonMark\Parser\Normal - (int) - - - - - - - - - CommonMark\Parser\Normalize - (int) - - - - - - - - - CommonMark\Parser\ValidateUTF8 - (int) - - - - - - - - - CommonMark\Parser\Smart - (int) - - - - - - - - - - - - - - &reftitle.returnvalues; - - Shall return root CommonMark\Node - - - - - - diff --git a/reference/cmark/functions/commonmark.render.html.xml b/reference/cmark/functions/commonmark.render.html.xml deleted file mode 100644 index 2bb03904dfa9..000000000000 --- a/reference/cmark/functions/commonmark.render.html.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - CommonMark\Render\HTML - Rendering - - - - &reftitle.description; - - stringCommonMark\Render\HTML - CommonMark\Nodenode - intoptions - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - node - - - - - - - - options - - - A mask of: - - - - - CommonMark\Render\Normal - (int) - - - - - - - - - CommonMark\Render\SourcePos - (int) - - - - - - - - - CommonMark\Render\HardBreaks - (int) - - - - - - - - - CommonMark\Render\Safe - (int) - - - - - - - - - CommonMark\Render\NoBreaks - (int) - - - - - - - - - - - - - - &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 328bfa05c077..000000000000 --- a/reference/cmark/functions/commonmark.render.latex.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - CommonMark\Render\Latex - Rendering - - - - &reftitle.description; - - stringCommonMark\Render\Latex - CommonMark\Nodenode - intoptions - intwidth - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - node - - - - - - - - options - - - A mask of: - - - - - CommonMark\Render\Normal - (int) - - - - - - - - - CommonMark\Render\SourcePos - (int) - - - - - - - - - CommonMark\Render\HardBreaks - (int) - - - - - - - - - CommonMark\Render\Safe - (int) - - - - - - - - - CommonMark\Render\NoBreaks - (int) - - - - - - - - - - - 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 240df7b85d05..000000000000 --- a/reference/cmark/functions/commonmark.render.man.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - CommonMark\Render\Man - Rendering - - - - &reftitle.description; - - stringCommonMark\Render\Man - CommonMark\Nodenode - intoptions - intwidth - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - node - - - - - - - - options - - - A mask of: - - - - - CommonMark\Render\Normal - (int) - - - - - - - - - CommonMark\Render\SourcePos - (int) - - - - - - - - - CommonMark\Render\HardBreaks - (int) - - - - - - - - - CommonMark\Render\Safe - (int) - - - - - - - - - CommonMark\Render\NoBreaks - (int) - - - - - - - - - - - width - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/cmark/functions/commonmark.render.xml b/reference/cmark/functions/commonmark.render.xml deleted file mode 100644 index 488719b1f6d4..000000000000 --- a/reference/cmark/functions/commonmark.render.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - CommonMark\Render - Rendering - - - - &reftitle.description; - - stringCommonMark\Render - CommonMark\Nodenode - intoptions - intwidth - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - node - - - - - - - - options - - - A mask of: - - - - - CommonMark\Render\Normal - (int) - - - - - - - - - CommonMark\Render\SourcePos - (int) - - - - - - - - - CommonMark\Render\HardBreaks - (int) - - - - - - - - - CommonMark\Render\Safe - (int) - - - - - - - - - CommonMark\Render\NoBreaks - (int) - - - - - - - - - - - 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 5b68b282f6b8..000000000000 --- a/reference/cmark/functions/commonmark.render.xml.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - CommonMark\Render\XML - Rendering - - - - &reftitle.description; - - stringCommonMark\Render\XML - CommonMark\Nodenode - intoptions - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - node - - - - - - - - options - - - A mask of: - - - - - CommonMark\Render\Normal - (int) - - - - - - - - - CommonMark\Render\SourcePos - (int) - - - - - - - - - CommonMark\Render\HardBreaks - (int) - - - - - - - - - CommonMark\Render\Safe - (int) - - - - - - - - - CommonMark\Render\NoBreaks - (int) - - - - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/cmark/reference.xml b/reference/cmark/reference.xml deleted file mode 100644 index d4141697190b..000000000000 --- 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 0ec50755c003..000000000000 --- a/reference/cmark/setup.xml +++ /dev/null @@ -1,52 +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 8c41ecfb9fbe..000000000000 --- a/reference/cmark/versions.xml +++ /dev/null @@ -1,258 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/componere/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/componere/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/componere/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/componere/book.xml b/reference/componere/book.xml deleted file mode 100644 index 07e62a234353..000000000000 --- a/reference/componere/book.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - Componere - Componere - - - &reftitle.intro; - - Componere (latin, English: compose) targets production environments and provides an API for - composition of classes, monkey patching, and casting. - - - Composition: - - Componere\Definition is used to define (or redefine) a class at runtime; - The class can then be registered, and in the case of redefinition it replaces the original class - for as long as the Componere\Definition exists. - - - - - - Patching: - - Componere\Patch is used to change the class of a specific instance of an object at runtime; - Upon application the patch will remain applied for as long as the Componere\Patch exists, and can be reverted explicitly. - - - - - - Casting: - - Componere\ casting functions can cast among user defined compatible types; - Where compatible means Type is sub or super to the type of object. - - - - - - - - &reference.componere.setup; - &reference.componere.componere.abstract.definition; - &reference.componere.componere.definition; - &reference.componere.componere.patch; - &reference.componere.componere.method; - &reference.componere.componere.value; - &reference.componere.reference; - - diff --git a/reference/componere/componere.abstract.definition.xml b/reference/componere/componere.abstract.definition.xml deleted file mode 100644 index 06e0d3e9571e..000000000000 --- a/reference/componere/componere.abstract.definition.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - The Componere\Abstract\Definition class - Componere\Abstract\Definition - - - - -
- &reftitle.intro; - - This final abstract represents a class entry, and should not be used by the programmer. - -
- - -
- &reftitle.classsynopsis; - - - - Componere\Abstract\Definition - - - - - final - abstract - Componere\Abstract\Definition - - - - - &Methods; - - - - -
- -
- - &reference.componere.componere.abstract.entities.definition; - -
- diff --git a/reference/componere/componere.definition.xml b/reference/componere/componere.definition.xml deleted file mode 100644 index e6030ed3501a..000000000000 --- a/reference/componere/componere.definition.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - The Componere\Definition class - Componere\Definition - - - - -
- &reftitle.intro; - - The Definition class allows the programmer to build and register a type at runtime. - - - Should a Definition replace an existing class, the existing class will be restored when the Definition is destroyed. - -
- - -
- &reftitle.classsynopsis; - - - - - Componere\Definition - - - - - - final - Componere\Definition - - - - extends - Componere\Abstract\Definition - - - - - Constructors - - - &Methods; - - - &InheritedMethods; - - - - - -
- -
- - &reference.componere.componere.definition.construct; - &reference.componere.componere.definition.addconstant; - &reference.componere.componere.definition.addproperty; - &reference.componere.componere.definition.register; - &reference.componere.componere.definition.isregistered; - &reference.componere.componere.definition.getclosure; - &reference.componere.componere.definition.getclosures; -
- diff --git a/reference/componere/componere.method.xml b/reference/componere/componere.method.xml deleted file mode 100644 index 2a15ae14ba4e..000000000000 --- a/reference/componere/componere.method.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - The Componere\Method class - Componere\Method - - - - -
- &reftitle.intro; - - A Method represents a function with modifiable accessibility flags - -
- - -
- &reftitle.classsynopsis; - - - - Componere\Method - - - - - final - Componere\Method - - - - - Constructor - - - &Methods; - - - - -
- -
- - &reference.componere.componere.method.construct; - &reference.componere.componere.method.setprivate; - &reference.componere.componere.method.setprotected; - &reference.componere.componere.method.setstatic; - &reference.componere.componere.method.getreflector; - -
- diff --git a/reference/componere/componere.patch.xml b/reference/componere/componere.patch.xml deleted file mode 100644 index 0ebe39a2b112..000000000000 --- a/reference/componere/componere.patch.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - The Componere\Patch class - Componere\Patch - - - - -
- &reftitle.intro; - - The Patch class allows the programmer to change the type of an instance at runtime without registering a new Definition - - - When a Patch is destroyed it is reverted, so that instances that were patched during the lifetime of the Patch are restored to their formal type. - -
- - -
- &reftitle.classsynopsis; - - - - Componere\Patch - - - - - final - Componere\Patch - - - - extends - Componere\Abstract\Definition - - - - - Constructors - - - &Methods; - - - &InheritedMethods; - - - - - -
- -
- - &reference.componere.componere.patch.construct; - &reference.componere.componere.patch.apply; - &reference.componere.componere.patch.revert; - &reference.componere.componere.patch.isapplied; - &reference.componere.componere.patch.derive; - &reference.componere.componere.patch.getclosure; - &reference.componere.componere.patch.getclosures; - -
- diff --git a/reference/componere/componere.value.xml b/reference/componere/componere.value.xml deleted file mode 100644 index 0f7918f957bc..000000000000 --- a/reference/componere/componere.value.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - The Componere\Value class - Componere\Value - - - - -
- &reftitle.intro; - - A Value represents a PHP variable of all types, including undefined - -
- - -
- &reftitle.classsynopsis; - - - - Componere\Value - - - - - final - Componere\Value - - - - - Constructor - - - &Methods; - - - - -
- -
- - &reference.componere.componere.value.construct; - &reference.componere.componere.value.setprivate; - &reference.componere.componere.value.setprotected; - &reference.componere.componere.value.setstatic; - &reference.componere.componere.value.isprivate; - &reference.componere.componere.value.isprotected; - &reference.componere.componere.value.isstatic; - &reference.componere.componere.value.hasdefault; - -
- diff --git a/reference/componere/componere/abstract/definition/addinterface.xml b/reference/componere/componere/abstract/definition/addinterface.xml deleted file mode 100644 index 04df5e92421c..000000000000 --- a/reference/componere/componere/abstract/definition/addinterface.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - Componere\Abstract\Definition::addInterface - Add Interface - - - - &reftitle.description; - - public DefinitionComponere\Abstract\Definition::addInterface - stringinterface - - - Shall implement the given interface on the current definition - - - - - - &reftitle.parameters; - - - interface - - - The case insensitive name of an interface - - - - - - - - &reftitle.returnvalues; - - The current Definition - - - - - Exceptions - - - Shall throw RuntimeException if Definition was registered - - - - - - diff --git a/reference/componere/componere/abstract/definition/addmethod.xml b/reference/componere/componere/abstract/definition/addmethod.xml deleted file mode 100644 index dac3f10d7c6f..000000000000 --- a/reference/componere/componere/abstract/definition/addmethod.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - Componere\Abstract\Definition::addMethod - Add Method - - - - &reftitle.description; - - public DefinitionComponere\Abstract\Definition::addMethod - stringname - Componere\Methodmethod - - - Shall create or override a method on the current definition. - - - - - - &reftitle.parameters; - - - name - - - The case insensitive name for method - - - - - method - - - Componere\Method not previously added to another Definition - - - - - - - - &reftitle.returnvalues; - - The current Definition - - - - - Exceptions - - - Shall throw RuntimeException if Definition was registered - - - - - Shall throw RuntimeException if Method was added to another Definition - - - - - - - diff --git a/reference/componere/componere/abstract/definition/addtrait.xml b/reference/componere/componere/abstract/definition/addtrait.xml deleted file mode 100644 index f720ee8a36ca..000000000000 --- a/reference/componere/componere/abstract/definition/addtrait.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - Componere\Abstract\Definition::addTrait - Add Trait - - - - &reftitle.description; - - public DefinitionComponere\Abstract\Definition::addTrait - stringtrait - - - Shall use the given trait for the current definition - - - - - - &reftitle.parameters; - - - trait - - - The case insensitive name of a trait - - - - - - - - &reftitle.returnvalues; - - The current Definition - - - - - Exceptions - - - Shall throw RuntimeException if Definition was registered - - - - - - - diff --git a/reference/componere/componere/abstract/definition/getreflector.xml b/reference/componere/componere/abstract/definition/getreflector.xml deleted file mode 100644 index 11a93d485d04..000000000000 --- a/reference/componere/componere/abstract/definition/getreflector.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - Componere\Abstract\Definition::getReflector - Reflection - - - - &reftitle.description; - - public ReflectionClassComponere\Abstract\Definition::getReflector - - - - Shall create or return a ReflectionClass - - - - - - &reftitle.returnvalues; - - A ReflectionClass for the current definition (cached) - - - - - - diff --git a/reference/componere/componere/definition/addconstant.xml b/reference/componere/componere/definition/addconstant.xml deleted file mode 100644 index 351f347cc51a..000000000000 --- a/reference/componere/componere/definition/addconstant.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - Componere\Definition::addConstant - Add Constant - - - - &reftitle.description; - - public DefinitionComponere\Definition::addConstant - stringname - Componere\Valuevalue - - - Shall declare a class constant on the current Definition - - - - - &reftitle.parameters; - - - name - - - The case sensitive name for the constant - - - - - value - - - The Value for the constant, must not be undefined or static - - - - - - - - &reftitle.returnvalues; - - The current Definition - - - - - Exceptions - - - Shall throw RuntimeException if Definition was registered - - - - - Shall throw RuntimeException if name is already declared as a constant - - - - - Shall throw RuntimeException if value is static - - - - - Shall throw RuntimeException if value is undefined - - - - - - diff --git a/reference/componere/componere/definition/addproperty.xml b/reference/componere/componere/definition/addproperty.xml deleted file mode 100644 index 74a702d41cc4..000000000000 --- a/reference/componere/componere/definition/addproperty.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - Componere\Definition::addProperty - Add Property - - - - &reftitle.description; - - public DefinitionComponere\Definition::addProperty - stringname - Componere\Valuevalue - - - Shall declare a class property on the current Definition - - - - - - &reftitle.parameters; - - - name - - - The case sensitive name for the property - - - - - value - - - The default Value for the property - - - - - - - - &reftitle.returnvalues; - - The current Definition - - - - - Exceptions - - - Shall throw RuntimeException if Definition was registered - - - - - Shall throw RuntimeException if name is already declared as a property - - - - - - diff --git a/reference/componere/componere/definition/construct.xml b/reference/componere/componere/definition/construct.xml deleted file mode 100644 index 96c3f5ab9156..000000000000 --- a/reference/componere/componere/definition/construct.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - Componere\Definition::__construct - Definition Construction - - - - &reftitle.description; - - public Componere\Definition::__construct - stringname - - - - public Componere\Definition::__construct - stringname - stringparent - - - - public Componere\Definition::__construct - stringname - arrayinterfaces - - - - public Componere\Definition::__construct - stringname - stringparent - arrayinterfaces - - - - - - &reftitle.parameters; - - - name - - - A case insensitive class name - - - - - parent - - - A case insensitive class name - - - - - interfaces - - - An array of case insensitive class names - - - - - - - - Exceptions - - - Shall throw InvalidArgumentException if an attempt is made to replace an internal class - - - - - Shall throw InvalidArgumentException if an attempt is made to replace an interface - - - - - Shall throw InvalidArgumentException if an attempt is made to replace a trait - - - - - Shall throw RuntimeException if a class in interfaces cannot be found - - - - - Shall throw RuntimeException if a class in interfaces is not an interface - - - - - - diff --git a/reference/componere/componere/definition/getclosure.xml b/reference/componere/componere/definition/getclosure.xml deleted file mode 100644 index 3c741c10ed46..000000000000 --- a/reference/componere/componere/definition/getclosure.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - Componere\Definition::getClosure - Get Closure - - - - &reftitle.description; - - public ClosureComponere\Definition::getClosure - stringname - - - Shall return a Closure for the method specified by name - - - - - - &reftitle.parameters; - - - name - - - The case insensitive name of the method - - - - - - - - &reftitle.returnvalues; - - A Closure bound to the correct scope - - - - - Exceptions - - - Shall throw RuntimeException if Definition was registered - - - - - Shall throw RuntimeException if name could not be found - - - - - - diff --git a/reference/componere/componere/definition/getclosures.xml b/reference/componere/componere/definition/getclosures.xml deleted file mode 100644 index 808e71d37adb..000000000000 --- a/reference/componere/componere/definition/getclosures.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - Componere\Definition::getClosures - Get Closures - - - - &reftitle.description; - - public arrayComponere\Definition::getClosures - - - - Shall return an array of Closures - - - - - - &reftitle.returnvalues; - - Shall return all methods as an array of Closure objects bound to the correct scope - - - - - Exceptions - - - Shall throw RuntimeException if Definition was registered - - - - - - diff --git a/reference/componere/componere/definition/isregistered.xml b/reference/componere/componere/definition/isregistered.xml deleted file mode 100644 index 401906108e05..000000000000 --- a/reference/componere/componere/definition/isregistered.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - Componere\Definition::isRegistered - State Detection - - - - &reftitle.description; - - public boolComponere\Definition::isRegistered - - - - Shall detect the registration state of this Definition - - - - - &reftitle.returnvalues; - - Shall return true if this Definition is registered - - - - - - diff --git a/reference/componere/componere/definition/register.xml b/reference/componere/componere/definition/register.xml deleted file mode 100644 index f5f96e8204f5..000000000000 --- a/reference/componere/componere/definition/register.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - Componere\Definition::register - Registration - - - - &reftitle.description; - - public voidComponere\Definition::register - - - - Shall register the current Definition - - - - - - Exceptions - - - Shall throw RuntimeException if Definition was registered - - - - - - diff --git a/reference/componere/componere/method/construct.xml b/reference/componere/componere/method/construct.xml deleted file mode 100644 index 1ae6a0ce0a95..000000000000 --- a/reference/componere/componere/method/construct.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - Componere\Method::__construct - Method Construction - - - - &reftitle.description; - - public Componere\Method::__construct - Closureclosure - - - - - - &reftitle.parameters; - - - closure - - - - - - - - - - - - - diff --git a/reference/componere/componere/method/getreflector.xml b/reference/componere/componere/method/getreflector.xml deleted file mode 100644 index 0d9b8b798462..000000000000 --- a/reference/componere/componere/method/getreflector.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - Componere\Method::getReflector - Reflection - - - - &reftitle.description; - - public ReflectionMethodComponere\Method::getReflector - - - - Shall create or return a ReflectionMethod - - - - - &reftitle.returnvalues; - - A ReflectionMethod for the current method (cached) - - - - - - diff --git a/reference/componere/componere/method/setprivate.xml b/reference/componere/componere/method/setprivate.xml deleted file mode 100644 index d3865ea8200a..000000000000 --- a/reference/componere/componere/method/setprivate.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - Componere\Method::setPrivate - Accessibility Modification - - - - &reftitle.description; - - public MethodComponere\Method::setPrivate - - - - - - &reftitle.returnvalues; - - The current Method - - - - - Exceptions - - - Shall throw RuntimeException if access level was previously set - - - - - - diff --git a/reference/componere/componere/method/setprotected.xml b/reference/componere/componere/method/setprotected.xml deleted file mode 100644 index e13da56616a8..000000000000 --- a/reference/componere/componere/method/setprotected.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - Componere\Method::setProtected - Accessibility Modification - - - - &reftitle.description; - - public MethodComponere\Method::setProtected - - - - - - &reftitle.returnvalues; - - The current Method - - - - - Exceptions - - - Shall throw RuntimeException if access level was previously set - - - - - - - diff --git a/reference/componere/componere/method/setstatic.xml b/reference/componere/componere/method/setstatic.xml deleted file mode 100644 index 62b63361c0b7..000000000000 --- a/reference/componere/componere/method/setstatic.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - - - Componere\Method::setStatic - Accessibility Modification - - - - &reftitle.description; - - public MethodComponere\Method::setStatic - - - - - - &reftitle.returnvalues; - - The current Method - - - - - - diff --git a/reference/componere/componere/patch/apply.xml b/reference/componere/componere/patch/apply.xml deleted file mode 100644 index a2339e5775e2..000000000000 --- a/reference/componere/componere/patch/apply.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - Componere\Patch::apply - Application - - - - &reftitle.description; - - public voidComponere\Patch::apply - - - - Shall apply the current patch - - - - - - - diff --git a/reference/componere/componere/patch/construct.xml b/reference/componere/componere/patch/construct.xml deleted file mode 100644 index 954cdd48a61e..000000000000 --- a/reference/componere/componere/patch/construct.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - Componere\Patch::__construct - Patch Construction - - - - &reftitle.description; - - public Componere\Patch::__construct - objectinstance - - - public Componere\Patch::__construct - objectinstance - arrayinterfaces - - - - - - &reftitle.parameters; - - - instance - - - The target for this Patch - - - - - interfaces - - - A case insensitive array of class names - - - - - - - - Exceptions - - - Shall throw RuntimeException if a class in interfaces cannot be found - - - - - Shall throw RuntimeException if a class in interfaces is not an interface - - - - - - diff --git a/reference/componere/componere/patch/derive.xml b/reference/componere/componere/patch/derive.xml deleted file mode 100644 index 7f93bb98efa7..000000000000 --- a/reference/componere/componere/patch/derive.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - Componere\Patch::derive - Patch Derivation - - - - &reftitle.description; - - public PatchComponere\Patch::derive - objectinstance - - - Shall derive a Patch for the given instance - - - - - - &reftitle.parameters; - - - instance - - - The target for the derived Patch - - - - - - - - &reftitle.returnvalues; - - Patch for instance derived from the current Patch - - - - - Exceptions - - - Shall throw InvalidArgumentException if instance is not compatible - - - - - - diff --git a/reference/componere/componere/patch/getclosure.xml b/reference/componere/componere/patch/getclosure.xml deleted file mode 100644 index 1da32bb40510..000000000000 --- a/reference/componere/componere/patch/getclosure.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - Componere\Patch::getClosure - Get Closure - - - - &reftitle.description; - - public ClosureComponere\Patch::getClosure - stringname - - - Shall return a Closure for the method specified by name - - - - - - &reftitle.parameters; - - - name - - - The case insensitive name of the method - - - - - - - - &reftitle.returnvalues; - - A Closure bound to the correct scope and object - - - - - Exceptions - - - Shall throw RuntimeException if name could not be found - - - - - - diff --git a/reference/componere/componere/patch/getclosures.xml b/reference/componere/componere/patch/getclosures.xml deleted file mode 100644 index 9752284dfc74..000000000000 --- a/reference/componere/componere/patch/getclosures.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - Componere\Patch::getClosures - Get Closures - - - - &reftitle.description; - - public arrayComponere\Patch::getClosures - - - - Shall return an array of Closures - - - - - - &reftitle.returnvalues; - - Shall return all methods as an array of Closure objects bound to the correct scope and object - - - - - - diff --git a/reference/componere/componere/patch/isapplied.xml b/reference/componere/componere/patch/isapplied.xml deleted file mode 100644 index b69a4251d7f6..000000000000 --- a/reference/componere/componere/patch/isapplied.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - - - - Componere\Patch::isApplied - State Detection - - - - &reftitle.description; - - public boolComponere\Patch::isApplied - - - - - - - - diff --git a/reference/componere/componere/patch/revert.xml b/reference/componere/componere/patch/revert.xml deleted file mode 100644 index adb6623911c4..000000000000 --- a/reference/componere/componere/patch/revert.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - Componere\Patch::revert - Reversal - - - - &reftitle.description; - - public voidComponere\Patch::revert - - - - Shall revert the current patch - - - - - - diff --git a/reference/componere/componere/value/construct.xml b/reference/componere/componere/value/construct.xml deleted file mode 100644 index 83ab23eace65..000000000000 --- a/reference/componere/componere/value/construct.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - Componere\Value::__construct - Value Construction - - - - &reftitle.description; - - public Componere\Value::__construct - mixeddefault - - - - - - - - - &reftitle.parameters; - - - default - - - - - - - - - - - Exceptions - - - Shall throw InvalidArgumentException if default does not have a suitable value - - - - - - - - diff --git a/reference/componere/componere/value/hasdefault.xml b/reference/componere/componere/value/hasdefault.xml deleted file mode 100644 index 1f996146225e..000000000000 --- a/reference/componere/componere/value/hasdefault.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - Componere\Value::hasDefault - Value Interaction - - - - &reftitle.description; - - public boolComponere\Value::hasDefault - - - - - - - - - - - diff --git a/reference/componere/componere/value/isprivate.xml b/reference/componere/componere/value/isprivate.xml deleted file mode 100644 index dc9a57aaf55b..000000000000 --- a/reference/componere/componere/value/isprivate.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - Componere\Value::isPrivate - Accessibility Detection - - - - &reftitle.description; - - public boolComponere\Value::isPrivate - - - - - - - - - - - diff --git a/reference/componere/componere/value/isprotected.xml b/reference/componere/componere/value/isprotected.xml deleted file mode 100644 index 80415bb68a2a..000000000000 --- a/reference/componere/componere/value/isprotected.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - Componere\Value::isProtected - Accessibility Detection - - - - &reftitle.description; - - public boolComponere\Value::isProtected - - - - - - - - - - - diff --git a/reference/componere/componere/value/isstatic.xml b/reference/componere/componere/value/isstatic.xml deleted file mode 100644 index 49a1eb667da5..000000000000 --- a/reference/componere/componere/value/isstatic.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - Componere\Value::isStatic - Accessibility Detection - - - - &reftitle.description; - - public boolComponere\Value::isStatic - - - - - - - - - - - diff --git a/reference/componere/componere/value/setprivate.xml b/reference/componere/componere/value/setprivate.xml deleted file mode 100644 index 8db7513303f8..000000000000 --- a/reference/componere/componere/value/setprivate.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - Componere\Value::setPrivate - Accessibility Modification - - - - &reftitle.description; - - public ValueComponere\Value::setPrivate - - - - - - - - - - &reftitle.returnvalues; - - The current Value - - - - - Exceptions - - - Shall throw RuntimeException if access level was previously set - - - - - - - diff --git a/reference/componere/componere/value/setprotected.xml b/reference/componere/componere/value/setprotected.xml deleted file mode 100644 index 99be9efe848e..000000000000 --- a/reference/componere/componere/value/setprotected.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - Componere\Value::setProtected - Accessibility Modification - - - - &reftitle.description; - - public ValueComponere\Value::setProtected - - - - - - - - - - &reftitle.returnvalues; - - The current Value - - - - - Exceptions - - - Shall throw RuntimeException if access level was previously set - - - - - - - diff --git a/reference/componere/componere/value/setstatic.xml b/reference/componere/componere/value/setstatic.xml deleted file mode 100644 index 271a90347084..000000000000 --- a/reference/componere/componere/value/setstatic.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - Componere\Value::setStatic - Accessibility Modification - - - - &reftitle.description; - - public ValueComponere\Value::setStatic - - - - - - - - - - &reftitle.returnvalues; - - The current Value - - - - - - diff --git a/reference/componere/configure.xml b/reference/componere/configure.xml deleted file mode 100644 index 08d790f5aa29..000000000000 --- a/reference/componere/configure.xml +++ /dev/null @@ -1,34 +0,0 @@ - - -
- &reftitle.install; - - - Use when compiling PHP. - - - - Windows users should include php_componere.dll into &php.ini; - - -
- diff --git a/reference/componere/functions/componere.cast.xml b/reference/componere/functions/componere.cast.xml deleted file mode 100644 index f9b7b48e953a..000000000000 --- a/reference/componere/functions/componere.cast.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - Componere\cast - Casting - - - - &reftitle.description; - - objectComponere\cast - stringtype - objectobject - - - - - &reftitle.parameters; - - - type - - - A user defined type - - - - - object - - - An object with a user defined type compatible with Type - - - - - - - - &reftitle.returnvalues; - - An object of type Type, cast from object - - - - - &reftitle.errors; - - - Shall throw InvalidArgumentException if the type of object is or is derived from an internal class - - - - - Shall throw InvalidArgumentException if Type is an interface - - - - - Shall throw InvalidArgumentException if Type is a trait - - - - - Shall throw InvalidArgumentException if Type is an abstract - - - - - Shall throw InvalidArgumentException if Type is not compatible with the type of object - - - - - - &reftitle.seealso; - - - - - - - diff --git a/reference/componere/functions/componere.cast_by_ref.xml b/reference/componere/functions/componere.cast_by_ref.xml deleted file mode 100644 index 6d7d387fa8ea..000000000000 --- a/reference/componere/functions/componere.cast_by_ref.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - Componere\cast_by_ref - Casting - - - - &reftitle.description; - - objectComponere\cast_by_ref - stringtype - objectobject - - - - - &reftitle.parameters; - - - type - - - A user defined type - - - - - object - - - An object with a user defined type compatible with Type - - - - - - - - &reftitle.returnvalues; - - An object of type Type, cast from object, where members are references to object members - - - - - &reftitle.errors; - - - Shall throw InvalidArgumentException if the type of object is or is derived from an internal class - - - - - Shall throw InvalidArgumentException if Type is an interface - - - - - Shall throw InvalidArgumentException if Type is a trait - - - - - Shall throw InvalidArgumentException if Type is an abstract - - - - - Shall throw InvalidArgumentException if Type is not compatible with the type of object - - - - - - &reftitle.seealso; - - - - - - - diff --git a/reference/componere/reference.xml b/reference/componere/reference.xml deleted file mode 100644 index 69e298cd891c..000000000000 --- a/reference/componere/reference.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - Componere &Functions; - - &reference.componere.functions.componere.cast; - &reference.componere.functions.componere.cast-by-ref; - - - - diff --git a/reference/componere/setup.xml b/reference/componere/setup.xml deleted file mode 100644 index c4ffd18407b6..000000000000 --- a/reference/componere/setup.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - &reftitle.setup; - -
- &reftitle.required; - - Reflection is required - -
- -
- &reftitle.install; - - Componere source and releases are available on - github - -
- -
- diff --git a/reference/componere/versions.xml b/reference/componere/versions.xml deleted file mode 100644 index 88636c107484..000000000000 --- a/reference/componere/versions.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/cubrid/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/cubrid/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/cubrid/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/cubrid/aliases.xml b/reference/cubrid/aliases.xml deleted file mode 100644 index dda3ccce688c..000000000000 --- a/reference/cubrid/aliases.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - CUBRID Obsolete Aliases and Functions - - &reference.cubrid.entities.oldaliases; - - - - - diff --git a/reference/cubrid/book.xml b/reference/cubrid/book.xml deleted file mode 100644 index e01ff29a97e6..000000000000 --- a/reference/cubrid/book.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - CUBRID - CUBRID - - - &reftitle.intro; - - These functions allow you to access CUBRID database servers. More information about CUBRID can be found at CUBRID. - - - Documentation for CUBRID can be found at CUBRID Documentation. - - - - - &reference.cubrid.setup; - &reference.cubrid.constants; - &reference.cubrid.examples; - &reference.cubrid.reference; - &reference.cubrid.cubridmysql; - &reference.cubrid.aliases; - - - diff --git a/reference/cubrid/configure.xml b/reference/cubrid/configure.xml deleted file mode 100644 index 3a88ab53011c..000000000000 --- a/reference/cubrid/configure.xml +++ /dev/null @@ -1,38 +0,0 @@ - - -
- &reftitle.install; - - - &pecl.info; - &url.pecl.package;cubrid. - - - &pecl.windows.download; - - - For information about manual installation on Linux and Windows systems, please - read the file build-guide.html included in the package. - - -
- diff --git a/reference/cubrid/constants.xml b/reference/cubrid/constants.xml deleted file mode 100644 index ab004bb06c56..000000000000 --- a/reference/cubrid/constants.xml +++ /dev/null @@ -1,391 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - The following constants can be used when executing SQL statement. They can - be passed to cubrid_prepare and - cubrid_execute. - - CUBRID SQL execution flags - - - - Constant - Description - - - - - CUBRID_INCLUDE_OID - Determine whether to get OID during query execution. - - - CUBRID_ASYNC - Execute the query in asynchronous mode. - - - CUBRID_EXEC_QUERY_ALL - Execute the query in synchronous mode. This flag must be set - when executing multiple SQL statements. - - - -
-
- - - The following constants can be used when fetching the results to specify - fetch behaviour. They can be passed to cubrid_fetch and - cubrid_fetch_array. - - CUBRID fetch flags - - - - Constant - Description - - - - - CUBRID_NUM - Get query result as a numeric array (0-default). - - - CUBRID_ASSOC - Get query result as an associative array. - - - CUBRID_BOTH - Get query result as both numeric and associative arrays (default value). - - - CUBRID_OBJECT - Get query result as an object. - - - CUBRID_LOB - The constant CUBRID_LOB can be used when you want to operate the - lob object. It can be passed to cubrid_fetch, - cubrid_fetch_row, - cubrid_fetch_array, - cubrid_fetch_assoc and - cubrid_fetch_object. - - - -
-
- - - The following constants can be used when positioning the cursor in query - results. They can be passed to or returned by - cubrid_move_cursor. - - CUBRID cursor position flags - - - - Constant - Description - - - - - CUBRID_CURSOR_FIRST - Move current cursor to the first position in the result. - - - CUBRID_CURSOR_CURRENT - Move current cursor as a default value if the origin is not specified. - - - CUBRID_CURSOR_LAST - Move current cursor to the last position in the result. - - - CUBRID_CURSOR_SUCCESS - Returned value of cubrid_move_cursor - function in case of success. This flag has been removed from 8.4.1. - - - CUBRID_NO_MORE_DATA - Returned value of cubrid_move_cursor - function in case of failure. This flag has been removed from 8.4.1. - - - CUBRID_CURSOR_ERROR - Returned value of cubrid_move_cursor - function in case of failure. This flag has been removed from 8.4.1. - - - -
-
- - - The following constants can be used when setting the auto-commit mode for - the database connection. They can be passed to - cubrid_set_autocommit or returned by - cubrid_get_autocommit. - - CUBRID auto-commit mode flags - - - - Constant - Description - - - - - CUBRID_AUTOCOMMIT_TRUE - Enable the auto-commit mode. - - - CUBRID_AUTOCOMMIT_FALSE - Disable the auto-commit mode. - - - -
-
- - - The following constants can be used when setting the database parameter. - They can be passed to cubrid_set_db_parameter. - - CUBRID parameter flags - - - - Constant - Description - - - - - CUBRID_PARAM_ISOLATION_LEVEL - Transaction isolation level for the database connection. - - - CUBRID_PARAM_LOCK_TIMEOUT - Transaction timeout in seconds. - - - -
-
- - - The following constants can be used when setting the transaction isolation - level. They can be passed to cubrid_set_db_parameter - or returned by cubrid_get_db_parameter. - - CUBRID isolation level flags - - - - Constant - Description - - - - - TRAN_COMMIT_CLASS_UNCOMMIT_INSTANCE - The lowest isolation level (1). A dirty, non-repeatable or - phantom read may occur for the tuple and a non-repeatable read may - occur for the table as well. - - - TRAN_COMMIT_CLASS_COMMIT_INSTANCE - A relatively low isolation level (2). A dirty read does not - occur, but non-repeatable or phantom read may occur. - - - TRAN_REP_CLASS_UNCOMMIT_INSTANCE - The default isolation of CUBRID (3). A dirty, non-repeatable or - phantom read may occur for the tuple, but repeatable read is ensured - for the table. - - - TRAN_REP_CLASS_COMMIT_INSTANCE - A relatively low isolation level (4). A dirty read does not - occur, but non-repeatable or phantom read may. - - - TRAN_REP_CLASS_REP_INSTANCE - A relatively high isolation level (5). A dirty or non-repeatable - read does not occur, but a phantom read may. - - - TRAN_SERIALIZABLE - The highest isolation level (6). Problems concerning concurrency - (e.g. dirty read, non-repeatable read, phantom read, etc.) do not - occur. - - - -
-
- - - The following constants can be used when getting schema information. They - can be passed to cubrid_schema. - - CUBRID schema flags - - - - Constant - Description - - - - - CUBRID_SCH_CLASS - Get name and type of table in CUBRID. - - - CUBRID_SCH_VCLASS - Get name and type of view in CUBRID. - - - CUBRID_SCH_QUERY_SPEC - Get the query definition of view. - - - CUBRID_SCH_ATTRIBUTE - Get the attributes of table column. - - - CUBRID_SCH_CLASS_ATTRIBUTE - Get the attributes of table. - - - CUBRID_SCH_METHOD - Get the instance method. The instance method is a method called - by a class instance. It is used more often than the class method - because most operations are executed in the instance. - - - CUBRID_SCH_CLASS_METHOD - Get the class method. The class method is a method called by a - class object. It is usually used to create a new class instance or to - initialize it. It is also used to access or update class - attributes. - - - CUBRID_SCH_METHOD_FILE - Get the information of the file where the method of the table is - defined. - - - CUBRID_SCH_SUPERCLASS - Get the name and type of table which table inherites attributes - from. - - - CUBRID_SCH_SUBCLASS - Get the name and type of table which inherites attributes from - this table. - - - CUBRID_SCH_CONSTRAINT - Get the table constraints. - - - CUBRID_SCH_TRIGGER - Get the table triggers. - - - CUBRID_SCH_CLASS_PRIVILEGE - Get the privilege information of table. - - - CUBRID_SCH_ATTR_PRIVILEGE - Get the privilege information of column. - - - CUBRID_SCH_DIRECT_SUPER_CLASS - Get the direct super table of table. - - - CUBRID_SCH_PRIMARY_KEY - Get the table primary key. - - - CUBRID_SCH_IMPORTED_KEYS - Get imported keys of table. - - - CUBRID_SCH_EXPORTED_KEYS - Get exported keys of table. - - - CUBRID_SCH_CROSS_REFERENCE - Get reference relationship of two tables. - - - -
-
- - - The following constants can be used when reporting errors. They can be - returned from cubrid_error_code_facility. - - CUBRID error facility code - - - - Constant - Description - - - - - CUBRID_FACILITY_DBMS - The error occurred in CUBRID dbms. - - - CUBRID_FACILITY_CAS - The error occurred in CUBRID broker cas. - - - CUBRID_FACILITY_CCI - The error occurred in CUBRID cci. - - - CUBRID_FACILITY_CLIENT - The error occurred in CUBRID PHP client. - - - -
-
-
- - diff --git a/reference/cubrid/cubridmysql.xml b/reference/cubrid/cubridmysql.xml deleted file mode 100644 index fc44b1e6eef0..000000000000 --- a/reference/cubrid/cubridmysql.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - CUBRID MySQL Compatibility Functions - - &reference.cubrid.entities.cubridmysql; - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-affected-rows.xml b/reference/cubrid/cubridmysql/cubrid-affected-rows.xml deleted file mode 100644 index 354fde4e007a..000000000000 --- a/reference/cubrid/cubridmysql/cubrid-affected-rows.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - cubrid_affected_rows - Return the number of rows affected by the last SQL statement - - - - &reftitle.description; - - intcubrid_affected_rows - resourceconn_identifier - - - intcubrid_affected_rows - resourcereq_identifier - - - The cubrid_affected_rows function is used to get the - number of rows affected by the SQL statement (INSERT, DELETE, UPDATE). - - - - - &reftitle.parameters; - - - conn_identifier - The CUBRID connection. If the connection identifier is not - specified, the last link opened by cubrid_connect is - assumed. - - - req_identifier - - - Request Identifier, could be returned from either cubrid_prepare or cubrid_execute. - If the request identifier is not specified, the last identifier requested by - cubrid_prepare or cubrid_execute is assumed. - - - - - - - - &reftitle.returnvalues; - - Number of rows affected by the SQL statement, when process is successful. - - - -1, when SQL statement is not INSERT, DELETE or UPDATE. - - - &false;, when the request identifier is not specified, and there is no last - request. - - - - - &reftitle.examples; - - <function>cubrid_affected_rows</function> example - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_execute - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-client-encoding.xml b/reference/cubrid/cubridmysql/cubrid-client-encoding.xml deleted file mode 100644 index f3a0c3698769..000000000000 --- a/reference/cubrid/cubridmysql/cubrid-client-encoding.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - cubrid_client_encoding - Return the current CUBRID connection charset - - - - &reftitle.description; - - stringcubrid_client_encoding - resourceconn_identifier - - - This function returns the current CUBRID connection charset and is similar - to the CUBRID function cubrid_get_charset. - - - - - &reftitle.parameters; - - - conn_identifier - The CUBRID connection. If the connection identifier is not specified, the last link opened by cubrid_connect is assumed. - - - - - - &reftitle.returnvalues; - - A string that represents the CUBRID connection charset; on success. - - - &false; on failure. - - - - - &reftitle.examples; - - <function>cubrid_client_encoding</function> example - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_get_charset - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-close.xml b/reference/cubrid/cubridmysql/cubrid-close.xml deleted file mode 100644 index e262868436b8..000000000000 --- a/reference/cubrid/cubridmysql/cubrid-close.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - cubrid_close - Close CUBRID connection - - - - &reftitle.description; - - boolcubrid_close - resourceconn_identifier - - - The cubrid_close function ends the transaction - currently in process, closes the connection handle and disconnects from - server. If there is any request handles not closed yet at this point, - they will be closed. It is similar to the CUBRID function - cubrid_disconnect. - - - - - &reftitle.parameters; - - - conn_identifier - The CUBRID connection identifier. If the connection identifier is not specified, the last connection opened by cubrid_connect is assumed. - - - - - - &reftitle.returnvalues; - - &true;, when process is successful. - - - &false;, when process is unsuccessful. - - - - - &reftitle.examples; - - <function>cubrid_close</function> example - - -]]> - - - - - - &reftitle.seealso; - - cubrid_disconnect - cubrid_connect - cubrid_connect_with_url - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-data-seek.xml b/reference/cubrid/cubridmysql/cubrid-data-seek.xml deleted file mode 100644 index 1751a9432256..000000000000 --- a/reference/cubrid/cubridmysql/cubrid-data-seek.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - cubrid_data_seek - Move the internal row pointer of the CUBRID result - - - - &reftitle.description; - - boolcubrid_data_seek - resourceresult - introw_number - - - This function performs the moving of the internal row pointer of the - CUBRID result (associated with the specified result identifier) to point - to a specific row number. There are functions, such as - cubrid_fetch_assoc, which use the currently stored - value of row number. - - - - - &reftitle.parameters; - - - result - The result. - - - row_number - This is the desired row number of the new result pointer. - - - - - - &reftitle.returnvalues; - - Returns &true; on success or &false; on failure. - - - - - &reftitle.examples; - - <function>cubrid_data_seek</function> example - - -]]> - - &example.outputs; - - - string(1) "X" - [1]=> - string(5) "Mixed" -} -array(2) { - [0]=> - string(1) "M" - [1]=> - string(3) "Man" -} -array(2) { - [0]=> - string(1) "S" - [1]=> - string(6) "Silver" -} -]]> - - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-db-name.xml b/reference/cubrid/cubridmysql/cubrid-db-name.xml deleted file mode 100644 index 5988306f6ff1..000000000000 --- a/reference/cubrid/cubridmysql/cubrid-db-name.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - cubrid_db_name - Get db name from results of cubrid_list_dbs - - - - &reftitle.description; - - stringcubrid_db_name - arrayresult - intindex - - - Retrieve the database name from a call to cubrid_list_dbs. - - - - - &reftitle.parameters; - - - result - - - The result pointer from a call to cubrid_list_dbs. - - - - - index - - - The index into the result set. - - - - - - - - &reftitle.returnvalues; - - Returns the database name on success, and &false; on failure. If &false; - is returned, use cubrid_error to determine the nature - of the error. - - - - - &reftitle.examples; - - <function>cubrid_db_name</function> example - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_list_dbs - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-errno.xml b/reference/cubrid/cubridmysql/cubrid-errno.xml deleted file mode 100644 index b76abb008a7c..000000000000 --- a/reference/cubrid/cubridmysql/cubrid-errno.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - cubrid_errno - Return the numerical value of the error message from previous CUBRID operation - - - - &reftitle.description; - - intcubrid_errno - resourceconn_identifier - - - Returns the error number from the last CUBRID function. - - - The cubrid_errno function is used to get the - error code of the error that occurred during the API execution. Usually, - it gets the error code when API returns false as its return value. - - - - - &reftitle.parameters; - - - conn_identifier - - - The CUBRID connection identifier. If the connection identifier is not - specified, the last connection opened by - cubrid_connect is assumed. - - - - - - - - &reftitle.returnvalues; - - Returns the error number from the last CUBRID function, or 0 (zero) if no error occurred. - - - - - &reftitle.examples; - - <function>cubrid_errno</function> example - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_error - cubrid_error_code - cubrid_error_msg - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-error.xml b/reference/cubrid/cubridmysql/cubrid-error.xml deleted file mode 100644 index eed8e743ac82..000000000000 --- a/reference/cubrid/cubridmysql/cubrid-error.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - cubrid_error - Get the error message - - - - &reftitle.description; - - stringcubrid_error - resourceconnection - - - The cubrid_error function is used to get the error - message that occurred during the use of CUBRID API. Usually, it gets error - message when API returns false as its return value. - - - - - &reftitle.parameters; - - - connection - The CUBRID connection. - - - - - - &reftitle.returnvalues; - - Error message that occurred. - - - - - - &reftitle.examples; - - <function>cubrid_error</function> example - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_errno - cubrid_error_code - cubrid_error_msg - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-fetch-array.xml b/reference/cubrid/cubridmysql/cubrid-fetch-array.xml deleted file mode 100644 index 7136019f98ce..000000000000 --- a/reference/cubrid/cubridmysql/cubrid-fetch-array.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - cubrid_fetch_array - Fetch a result row as an associative array, a numeric array, or both - - - - &reftitle.description; - - arraycubrid_fetch_array - resourceresult - inttypeCUBRID_BOTH - - - The cubrid_fetch_array function is used to get a - single row from the query result and returns an array. The cursor - automatically moves to the next row after getting the result. - - - - - &reftitle.parameters; - - - result - Result comes from a call to cubrid_execute - - - type - Array type of the fetched result CUBRID_NUM, CUBRID_ASSOC, - CUBRID_BOTH. If you need to operate the lob object, you can use CUBRID_LOB. - - - - - - &reftitle.returnvalues; - Returns an array of strings that corresponds to the fetched row, when process is successful. - &false;, when there are no more rows; NULL, when process is unsuccessful. - The type of returned array depends on how type is defined. By using CUBRID_BOTH (default), you'll get an array with both associative and number indices, and you can decide which data type to use by setting the type argument. The type variable can be set to one of the following values: - - CUBRID_NUM : Numerical array (0-based) - CUBRID_ASSOC : Associative array - CUBRID_BOTH : Numerical & Associative array (default) - - - - - &reftitle.examples; - - <function>cubrid_fetch_array</function> example - - 10000"); - -printf("%-40s %-10s %-6s %-20s\n", "name", "area", "seats", "address"); -while ($row = cubrid_fetch_array($req, CUBRID_NUM)) { - printf("%-40s %-10s %-6s %-20s\n", $row[0], $row[1], $row[2], $row[3]); -} - -// if you want to operate LOB object, you can use cubrid_fetch_array($req, CUBRID_NUM | CUBRID_LOB) - -cubrid_close_request($req); - -cubrid_disconnect($conn); -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - cubrid_execute - cubrid_fetch - cubrid_fetch_row - cubrid_fetch_assoc - cubrid_fetch_object - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-fetch-assoc.xml b/reference/cubrid/cubridmysql/cubrid-fetch-assoc.xml deleted file mode 100644 index 72f4df77ec3b..000000000000 --- a/reference/cubrid/cubridmysql/cubrid-fetch-assoc.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - cubrid_fetch_assoc - Return the associative array that corresponds to the fetched row - - - - &reftitle.description; - - arraycubrid_fetch_assoc - resourceresult - inttype - - - This function returns the associative array, that corresponds to the - fetched row, and then moves the internal data pointer ahead, or returns - FALSE when the end is reached. - - - - - &reftitle.parameters; - - - result - result comes from a call to cubrid_execute - - - type - Type can only be CUBRID_LOB, this parameter will be used - only when you need to operate the lob object. - - - - - - &reftitle.returnvalues; - - Associative array, when process is successful. - - - &false;, when there are no more rows; NULL, when process is unsuccessful. - - - - - &reftitle.examples; - - <function>cubrid_fetch_assoc</function> example - - 10000"); - -printf("%-40s %-10s %-6s %-20s\n", "name", "area", "seats", "address"); -while ($row = cubrid_fetch_assoc($req)) { - printf("%-40s %-10s %-6s %-20s\n", - $row["name"], $row["area"], $row["seats"], $row["address"]); -} - -// if you want to operate LOB object, you can use cubrid_fetch_assoc($req, CUBRID_LOB) - -cubrid_close_request($req); - -cubrid_disconnect($conn); -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_execute - cubrid_fetch - cubrid_fetch_row - cubrid_fetch_array - cubrid_fetch_object - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-fetch-field.xml b/reference/cubrid/cubridmysql/cubrid-fetch-field.xml deleted file mode 100644 index a4e105fdfe91..000000000000 --- a/reference/cubrid/cubridmysql/cubrid-fetch-field.xml +++ /dev/null @@ -1,193 +0,0 @@ - - - - - cubrid_fetch_field - Get column information from a result and return as an object - - - - &reftitle.description; - - objectcubrid_fetch_field - resourceresult - intfield_offset0 - - - This function returns an object with certain properties of the specific - column. The properties of the object are: - - - - name - column name - - - table - name of the table that the column belongs to - - - def - default value of the column - - - max_length - maximum length of the column - - - not_null - 1 if the column cannot be NULL - - - primary_key - 1 if the column is a primary key - - - unique_key - 1 if the column is a unique key - - - multiple_key - 1 if the column is a non-unique key - - - numeric - 1 if the column is numeric - - - blob - 1 if the column is a BLOB - - - type - the type of the column - - - unsigned - 1 if the column is unsigned - - - zerofill - 1 if the column is zero-filled - - - - - - &reftitle.parameters; - - - result - result comes from a call to cubrid_execute - - - field_offset - - The numerical field offset. If the field offset is not specified, the - next field (that was not yet retrieved by this function) is retrieved. - The field_offset starts at 0. - - - - - - - &reftitle.returnvalues; - - Object with certain properties of the specific column, when process is successful. - - - &false; on failure. - - - - - &reftitle.examples; - - <function>cubrid_fetch_field</function> example - -name); -printf("%-30s %s\n", "table:", $field->table); -printf("%-30s \"%s\"\n", "default value:", $field->def); -printf("%-30s %d\n", "max length:", $field->max_length); -printf("%-30s %d\n", "not null:", $field->not_null); -printf("%-30s %d\n", "primary key:", $field->primary_key); -printf("%-30s %d\n", "unique key:", $field->unique_key); -printf("%-30s %d\n", "multiple key:", $field->multiple_key); -printf("%-30s %d\n", "numeric:", $field->numeric); -printf("%-30s %d\n", "blob:", $field->blob); -printf("%-30s %s\n", "type:", $field->type); -printf("%-30s %d\n", "unsigned:", $field->unsigned); -printf("%-30s %d\n", "zerofill:", $field->zerofill); - -cubrid_close_request($req); - -cubrid_disconnect($conn); -?> -]]> - - &example.outputs; - - - string(5) "20001" - [1]=> - string(5) "16681" - [2]=> - string(3) "KOR" - [3]=> - string(9) "1988-9-30" -} - ---- Field Properties --- -name: athlete_code -table: game -default value: "" -max length: 0 -not null: 1 -primary key: 1 -unique key: 1 -multiple key: 0 -numeric: 1 -blob: 0 -type: integer -unsigned: 0 -zerofill: 0 -]]> - - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-fetch-lengths.xml b/reference/cubrid/cubridmysql/cubrid-fetch-lengths.xml deleted file mode 100644 index b974c6713d82..000000000000 --- a/reference/cubrid/cubridmysql/cubrid-fetch-lengths.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - cubrid_fetch_lengths - Return an array with the lengths of the values of each field from the current row - - - - &reftitle.description; - - arraycubrid_fetch_lengths - resourceresult - - - This function returns a numeric array with the lengths of the values of - each field from the current row of the result set or it returns FALSE on - failure. - - - - If field data type is BLOB/CLOB, you should get its length by using - cubrid_lob_size. - - - - - - - &reftitle.parameters; - - - result - result comes from a call to cubrid_execute - - - - - - &reftitle.returnvalues; - - A numeric array, when process is successful. - - - &false; on failure. - - - - - &reftitle.examples; - - <function>cubrid_fetch_lengths</function> example - - -]]> - - &example.outputs; - - 2004 - [1] => 20085 - [2] => 15118 - [3] => 30134 - [4] => AUS - [5] => G - [6] => 2004-8-20 -) -Array -( - [0] => 4 - [1] => 5 - [2] => 5 - [3] => 5 - [4] => 3 - [5] => 1 - [6] => 10 -) -]]> - - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-fetch-object.xml b/reference/cubrid/cubridmysql/cubrid-fetch-object.xml deleted file mode 100644 index 012f242cb15c..000000000000 --- a/reference/cubrid/cubridmysql/cubrid-fetch-object.xml +++ /dev/null @@ -1,182 +0,0 @@ - - - - - cubrid_fetch_object - Fetch the next row and return it as an object - - - - &reftitle.description; - - objectcubrid_fetch_object - resourceresult - stringclass_name - arrayparams - inttype - - - This function returns an object with the column names of the result set as - properties. The values of these properties are extracted from the current - row of the result. - - - - - &reftitle.parameters; - - - result - result comes from a call to cubrid_execute - - - class_name - - - The name of the class to instantiate. If not specified, a - stdClass (stdClass is PHP's generic empty class - that's used when casting other types to objects) object is returned. - - - - - params - - - An optional array of parameters to pass to the constructor - for class_name objects. - - - - - type - - - Type can only be CUBRID_LOB, this parameter will be used only when you - need to operate the lob object. - - - - - - - - &reftitle.returnvalues; - - An object, when process is successful. - - - &false;, when there are no more rows; NULL, when process is unsuccessful. - - - - - &reftitle.examples; - - <function>cubrid_fetch_object</function> example - -s_name = $s; - $this->f_name = $f; - } -} - -var_dump(cubrid_fetch_object($res, 'demodb_code_construct', array('s_name', 'f_name'))); - -// if you want to operate LOB object, you can use cubrid_fetch_object($res, 'demodb_code_construct', array('s_name', 'f_name'), CUBRID_LOB) - - -var_dump(cubrid_fetch_object($res)); - -cubrid_close_request($res); -cubrid_disconnect($conn); -?> -]]> - - &example.outputs; - - - string(1) "X" - ["f_name"]=> - string(5) "Mixed" -} -object(demodb_code)#1 (2) { - ["s_name"]=> - string(1) "W" - ["f_name"]=> - string(5) "Woman" -} -object(demodb_code_construct)#1 (2) { - ["s_name"]=> - string(6) "s_name" - ["f_name"]=> - string(6) "f_name" -} -object(stdClass)#1 (2) { - ["s_name"]=> - string(1) "B" - ["f_name"]=> - string(6) "Bronze" -} -]]> - - - - - - &reftitle.seealso; - - cubrid_execute - cubrid_fetch - cubrid_fetch_array - cubrid_fetch_assoc - cubrid_fetch_row - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-fetch-row.xml b/reference/cubrid/cubridmysql/cubrid-fetch-row.xml deleted file mode 100644 index 885ab68209b3..000000000000 --- a/reference/cubrid/cubridmysql/cubrid-fetch-row.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - cubrid_fetch_row - Return a numerical array with the values of the current row - - - - &reftitle.description; - - arraycubrid_fetch_row - resourceresult - inttype - - - This function returns a numerical array with the values of the current row - from the result set, starting from 0, and moves the internal data pointer - ahead. - - - - - &reftitle.parameters; - - - result - result comes from a call to cubrid_execute - - - type - Type can only be CUBRID_LOB, this parameter will be used - only when you need to operate the lob object. - - - - - - &reftitle.returnvalues; - - A numerical array, when process is successful. - - - &false;, when there are no more rows; NULL, when process is unsuccessful. - - - - - &reftitle.examples; - - <function>cubrid_fetch_row</function> example - - 10000"); - -printf("%-40s %-10s %-6s %-20s\n", "name", "area", "seats", "address"); -while ($row = cubrid_fetch_row($req)) { - printf("%-40s %-10s %-6s %-20s\n", $row[0], $row[1], $row[2], $row[3]); -} - -// if you want to operate LOB object, you can use cubrid_fetch_row($req, CUBRID_LOB) - -cubrid_close_request($req); - -cubrid_disconnect($conn); -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_execute - cubrid_fetch - cubrid_fetch_array - cubrid_fetch_assoc - cubrid_fetch_object - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-field-flags.xml b/reference/cubrid/cubridmysql/cubrid-field-flags.xml deleted file mode 100644 index 7299de51f253..000000000000 --- a/reference/cubrid/cubridmysql/cubrid-field-flags.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - cubrid_field_flags - Return a string with the flags of the given field offset - - - - &reftitle.description; - - stringcubrid_field_flags - resourceresult - intfield_offset - - - This function returns a string with the flags of the given field offset - separated by space. You can split the returned value using explode. The - possible flags could be: not_null, - primary_key, unique_key, - foreign_key, auto_increment, - shared, reverse_index, - reverse_unique and timestamp. - - - - - &reftitle.parameters; - - - result - result comes from a call to cubrid_execute - - - field_offset - - The numerical field offset. The field_offset - starts at 0. If field_offset does not exist, an - error of level E_WARNING is also issued. - - - - - - - &reftitle.returnvalues; - - A string with flags, when process is successful. - - - &false; when invalid field_offset value. - - - -1 if SQL sentence is not SELECT. - - - - - &reftitle.examples; - - <function>cubrid_field_flags</function> example - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-field-len.xml b/reference/cubrid/cubridmysql/cubrid-field-len.xml deleted file mode 100644 index b6f9705e2e1a..000000000000 --- a/reference/cubrid/cubridmysql/cubrid-field-len.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - cubrid_field_len - Get the maximum length of the specified field - - - - &reftitle.description; - - intcubrid_field_len - resourceresult - intfield_offset - - - This function returns the maximum length of the specified field on success, or it returns FALSE on failure. - - - - - &reftitle.parameters; - - - result - result comes from a call to cubrid_execute - - - field_offset - The numerical field offset. The field_offset starts at 0. If field_offset does not exist, an error of level E_WARNING is also issued. - - - - - - &reftitle.returnvalues; - - Maximum length, when process is successful. - - - &false; on failure. - - - - - &reftitle.examples; - - <function>cubrid_field_len</function> example - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-field-name.xml b/reference/cubrid/cubridmysql/cubrid-field-name.xml deleted file mode 100644 index ed9241d3cef9..000000000000 --- a/reference/cubrid/cubridmysql/cubrid-field-name.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - cubrid_field_name - Return the name of the specified field index - - - - &reftitle.description; - - stringcubrid_field_name - resourceresult - intfield_offset - - - This function returns the name of the specified field index on success or - it returns FALSE on failure. - - - - - &reftitle.parameters; - - - result - result comes from a call to cubrid_execute - - - field_offset - - The numerical field offset. The field_offset - starts at 0. If field_offset does not exist, an - error of level E_WARNING is also issued. - - - - - - - &reftitle.returnvalues; - - Name of specified field index, on success. - - - &false; on failure. - - - - - &reftitle.examples; - - <function>cubrid_field_name</function> example - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-field-seek.xml b/reference/cubrid/cubridmysql/cubrid-field-seek.xml deleted file mode 100644 index d88a2560da1b..000000000000 --- a/reference/cubrid/cubridmysql/cubrid-field-seek.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - cubrid_field_seek - Move the result set cursor to the specified field offset - - - - &reftitle.description; - - boolcubrid_field_seek - resourceresult - intfield_offset0 - - - This function moves the result set cursor to the specified field offset. - This offset is used by cubrid_fetch_field if it - doesn't include a field offset. It returns TRUE on success or FALSE on - failure. - - - - - &reftitle.parameters; - - - result - result comes from a call to cubrid_execute - - - field_offset - - The numerical field offset. The field_offset - starts at 0. If field_offset does not exist, an - error of level E_WARNING is also issued. - - - - - - - &reftitle.returnvalues; - - &true; on success. - - - &false; on failure. - - - - - &reftitle.examples; - - <function>cubrid_field_seek</function> example - -name); -printf("%-30s %s\n", "table:", $field->table); -printf("%-30s \"%s\"\n", "default value:", $field->def); -printf("%-30s %d\n", "max length:", $field->max_length); -printf("%-30s %d\n", "not null:", $field->not_null); -printf("%-30s %d\n", "unique key:", $field->unique_key); -printf("%-30s %d\n", "multiple key:", $field->multiple_key); -printf("%-30s %d\n", "numeric:", $field->numeric); -printf("%-30s %s\n", "type:", $field->type); - -cubrid_close_request($req); - -cubrid_disconnect($conn); -?> -]]> - - &example.outputs; - - - string(5) "20001" - [1]=> - string(5) "16132" - [2]=> - string(3) "KOR" - [3]=> - string(9) "1988-09-30" -} - ---- Field Properties --- -name: athlete_code -table: game -default value: "" -max length: 0 -not null: 1 -unique key: 1 -multiple key: 0 -numeric: 1 -type: integer -]]> - - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-field-table.xml b/reference/cubrid/cubridmysql/cubrid-field-table.xml deleted file mode 100644 index fd6a53ed60a6..000000000000 --- a/reference/cubrid/cubridmysql/cubrid-field-table.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - cubrid_field_table - Return the name of the table of the specified field - - - - &reftitle.description; - - stringcubrid_field_table - resourceresult - intfield_offset - - - This function returns the name of the table of the specified field. This is useful when using large select queries with JOINS. - - - - - &reftitle.parameters; - - - result - - result comes from a call to - cubrid_execute - - - - field_offset - - The numerical field offset. The field_offset - starts at 0. If field_offset does not exist, an - error of level E_WARNING is also issued. - - - - - - - &reftitle.returnvalues; - - Name of the table of the specified field, on success. - - - &false; when invalid field_offset value. - - - -1 if SQL sentence is not SELECT. - - - - - &reftitle.examples; - - <function>cubrid_field_table</function> example - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-field-type.xml b/reference/cubrid/cubridmysql/cubrid-field-type.xml deleted file mode 100644 index 45efda969746..000000000000 --- a/reference/cubrid/cubridmysql/cubrid-field-type.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - cubrid_field_type - Return the type of the column corresponding to the given field offset - - - - &reftitle.description; - - stringcubrid_field_type - resourceresult - intfield_offset - - - This function returns the type of the column corresponding to the given - field offset. The returned field type could be one of the following: - "int", "real", "string", etc. - - - - - &reftitle.parameters; - - - result - - result comes from a call to - cubrid_execute - - - - field_offset - - The numerical field offset. The field_offset - starts at 0. If field_offset does not exist, an - error of level E_WARNING is also issued. - - - - - - - &reftitle.returnvalues; - - Type of the column, on success. - - - &false; when invalid field_offset value. - - - -1 if SQL sentence is not SELECT. - - - - - &reftitle.examples; - - <function>cubrid_field_type</function> example - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-list-dbs.xml b/reference/cubrid/cubridmysql/cubrid-list-dbs.xml deleted file mode 100644 index 2e33932e4f61..000000000000 --- a/reference/cubrid/cubridmysql/cubrid-list-dbs.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - cubrid_list_dbs - Return an array with the list of all existing CUBRID databases - - - - &reftitle.description; - - arraycubrid_list_dbs - resourceconn_identifier - - - This function returns an array with the list of all existing Cubrid - databases. - - - - - &reftitle.parameters; - - - conn_identifier - The CUBRID connection. - - - - - - &reftitle.returnvalues; - - An numeric array with all existing Cubrid databases; on success. - - - &false; on failure. - - - - - &reftitle.examples; - - <function>cubrid_list_dbs</function> example - - -]]> - - &example.outputs; - - - string(6) "demodb" -} -]]> - - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-num-fields.xml b/reference/cubrid/cubridmysql/cubrid-num-fields.xml deleted file mode 100644 index b12852c7b5ed..000000000000 --- a/reference/cubrid/cubridmysql/cubrid-num-fields.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - cubrid_num_fields - Return the number of columns in the result set - - - - &reftitle.description; - - intcubrid_num_fields - resourceresult - - - This function returns the number of columns in the result set, on success, - or it returns FALSE on failure. - - - - - &reftitle.parameters; - - - result - result comes from a call to - cubrid_execute, cubrid_query - and cubrid_prepare - - - - - - &reftitle.returnvalues; - - Number of columns, on success. - - - -1 if SQL sentence is not SELECT. - - - &false; when process is unsuccessful. - - - - - &reftitle.examples; - - <function>cubrid_num_fields</function> example - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-ping.xml b/reference/cubrid/cubridmysql/cubrid-ping.xml deleted file mode 100644 index 9d0c20540ef0..000000000000 --- a/reference/cubrid/cubridmysql/cubrid-ping.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - cubrid_ping - Ping a server connection or reconnect if there is no connection - - - - &reftitle.description; - - boolcubrid_ping - resourceconn_identifier - - - Checks whether or not the connection to the server is working. - - - - - &reftitle.parameters; - - - conn_identifier - - - The CUBRID connection identifier. If the connection identifier is not - specified, the last connection opened by - cubrid_connect is assumed. - - - - - - - - &reftitle.returnvalues; - - Returns &true; if the connection to the CUBRID server is working, otherwise &false;. - - - - - &reftitle.examples; - - <function>cubrid_ping</function> example - - -]]> - - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-query.xml b/reference/cubrid/cubridmysql/cubrid-query.xml deleted file mode 100644 index 0a6261eca836..000000000000 --- a/reference/cubrid/cubridmysql/cubrid-query.xml +++ /dev/null @@ -1,182 +0,0 @@ - - - - - cubrid_query - Send a CUBRID query - - - - &reftitle.description; - - resourcecubrid_query - stringquery - resourceconn_identifier - - - cubrid_query sends a unique query (multiple queries are not supported) to the - currently active database on the server that's associated with the specified conn_identifier. - - - - - &reftitle.parameters; - - - query - - - An SQL query - - - Data inside the query should be properly escaped. - - - - - conn_identifier - - - The CUBRID connection. If the connection identifier is not specified, - the last connection opened by cubrid_connect is - assumed. - - - - - - - - &reftitle.returnvalues; - - For SELECT, SHOW, DESCRIBE, EXPLAIN and other statements returning resultset, - cubrid_query returns a resource on success, or &false; on error. - - - For other type of SQL statements, INSERT, UPDATE, DELETE, DROP, etc, - cubrid_query returns &true; on success or &false; on error. - - - The returned result resource should be passed to cubrid_fetch_array, and other - functions for dealing with result tables, to access the returned data. - - - Use cubrid_num_rows to find out how many rows were returned for a SELECT statement or - cubrid_affected_rows to find out how many rows were affected by a DELETE, INSERT, REPLACE, or UPDATE statement. - - - cubrid_query will also fail and return &false; - if the user does not have permission to access the table(s) referenced by the query. - - - - - &reftitle.examples; - - Invalid Query - - The following query is syntactically invalid, so cubrid_query fails and returns &false;. - - - -]]> - - - - Valid Query - - The following query is valid, so cubrid_query returns a resource. - - - -]]> - - - - - - &reftitle.seealso; - - cubrid_connect - cubrid_error - cubrid_real_escape_string - cubrid_result - cubrid_fetch_assoc - cubrid_unbuffered_query - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-real-escape-string.xml b/reference/cubrid/cubridmysql/cubrid-real-escape-string.xml deleted file mode 100644 index 4b3cfe1f8dba..000000000000 --- a/reference/cubrid/cubridmysql/cubrid-real-escape-string.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - cubrid_real_escape_string - Escape special characters in a string for use in an SQL statement - - - - &reftitle.description; - - stringcubrid_real_escape_string - stringunescaped_string - resourceconn_identifier - - - This function returns the escaped string version of the given string. It - will escape the following characters: '. - - In general, single quotations are used to enclose character string. Double - quotations may be used as well depending on the value of ansi_quotes, - which is a parameter related to SQL statement. If the ansi_quotes value is - set to no, character string enclosed by double quotations is handled as - character string, not as an identifier. The default value is yes. - - If you want to include a single quote as part of a character string, enter - two single quotes in a row. - - - - - &reftitle.parameters; - - - unescaped_string - The string that is to be escaped. - - - conn_identifier - - The CUBRID connection. If the connection identifier is not specified, the - last connection opened by cubrid_connect is assumed. - - - - - - - &reftitle.returnvalues; - - Escaped string version of the given string, on success. - - - &false; on failure. - - - - - &reftitle.examples; - - <function>cubrid_real_escape_string</function> example - -?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~'; -$escaped_str = cubrid_real_escape_string($unescaped_str); - -$len = strlen($unescaped_str); - -@cubrid_execute($conn, "DROP TABLE cubrid_test"); -cubrid_execute($conn, "CREATE TABLE cubrid_test (t char($len))"); -cubrid_execute($conn, "INSERT INTO cubrid_test (t) VALUES('$escaped_str')"); - -$req = cubrid_execute($conn, "SELECT * FROM cubrid_test"); -$row = cubrid_fetch_assoc($req); - -var_dump($row); - -cubrid_close_request($req); -cubrid_disconnect($conn); -?> -]]> - - &example.outputs; - - - string(95) " !"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~" -} -]]> - - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-result.xml b/reference/cubrid/cubridmysql/cubrid-result.xml deleted file mode 100644 index b772ea58b10e..000000000000 --- a/reference/cubrid/cubridmysql/cubrid-result.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - cubrid_result - Return the value of a specific field in a specific row - - - - &reftitle.description; - - stringcubrid_result - resourceresult - introw - mixedfield0 - - - This function returns the value of a specific field in a specific row from - a result set. - - - - - &reftitle.parameters; - - - result - result comes from a call to cubrid_execute - - - row - The row number from the result that is being retrieved. Row numbers start at 0. - - - field - - The name or offset of the field being retrieved. It - can be the field's offset, the field's name, or the field's table dot - field name (tablename.fieldname). If the column name has been aliased - ('select foo as bar from...'), use the alias instead of the column name. - If undefined, the first field is retrieved. - - - - - - - &reftitle.returnvalues; - - Value of a specific field, on success (NULL if value if null). - - - &false; on failure. - - - - - &reftitle.examples; - - <function>cubrid_result</function> example - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-unbuffered-query.xml b/reference/cubrid/cubridmysql/cubrid-unbuffered-query.xml deleted file mode 100644 index c45b4b9d49a9..000000000000 --- a/reference/cubrid/cubridmysql/cubrid-unbuffered-query.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - cubrid_unbuffered_query - Perform a query without fetching the results into memory - - - - &reftitle.description; - - resourcecubrid_unbuffered_query - stringquery - resourceconn_identifier - - - This function performs a query without waiting for that all query results have been complete. It will return - when the results are being generated. - - - - - &reftitle.parameters; - - - query - A SQL query. - - - conn_identifier - The CUBRID connection. If the connection identifier is not specified, the last connection opened by cubrid_connect is assumed. - - - - - - &reftitle.returnvalues; - - For SELECT, SHOW, DESCRIBE or EXPLAIN statements returns a request identifier resource on success. - - - For other type of SQL statements, UPDATE, DELETE, DROP, etc, returns &true; on success. - - - &false; on failure. - - - - - &reftitle.examples; - - <function>cubrid_unbuffered_query</function> example - - -]]> - - - - - - &reftitle.notes; - - - The benefits of cubrid_unbuffered_query come - at a cost: you cannot use cubrid_num_rows and - cubrid_data_seek on a result set returned from - cubrid_unbuffered_query. - - - - - - diff --git a/reference/cubrid/examples.xml b/reference/cubrid/examples.xml deleted file mode 100644 index 96769e13c43c..000000000000 --- a/reference/cubrid/examples.xml +++ /dev/null @@ -1,175 +0,0 @@ - - - - &reftitle.examples; - The following is a simple example that establishes a connection between PHP and CUBRID. This section will cover the most basic and notable features. The following code required to connect to CUBRID database, which means CUBRID Server and CUBRID Broker have to be running. - The example below uses the demodb database as an examples. By default it is created during the installation. Make sure it has been created. - - - Example of Data Retrieval - - - - - - -
- - - "; - - while (list($key, $colname) = each($columns)) { - echo ""; - } - - echo ""; - - /** - * Get the results from the result set. - */ - while ($row = cubrid_fetch($result)) { - echo ""; - - for ($i = 0; $i < $num_fields; $i++) { - echo ""; - } - - echo ""; - } - } - /** - * The PHP module in the CUBRID runs in a 3-tier architecture. Even when - * calling SELECT for transaction processing, it is processed as a part - * of the transaction. Therefore, the transaction needs to be rolled back - * by calling commit or rollback even though SELECT was called for smooth - * performance. - */ - cubrid_commit($cubrid_con); - cubrid_disconnect($cubrid_con); - ?> - - - ]]> - - - - Example of Data Insertion - - - - - - -
-
$colname
"; - echo $row[$i]; - echo "
- - - - - ]]> - - - - - - diff --git a/reference/cubrid/functions/cubrid-bind.xml b/reference/cubrid/functions/cubrid-bind.xml deleted file mode 100644 index c4c47f2578ea..000000000000 --- a/reference/cubrid/functions/cubrid-bind.xml +++ /dev/null @@ -1,325 +0,0 @@ - - - - - cubrid_bind - Bind variables to a prepared statement as parameters - - - - &reftitle.description; - - boolcubrid_bind - resourcereq_identifier - intbind_index - mixedbind_value - stringbind_value_type - - - The cubrid_bind function is used to bind values to a - corresponding named or question mark placeholder in the SQL statement that - was passed to cubrid_prepare. If - bind_value_type is not given, string will be the - default. - - - - If the type of data to be bound is BLOB/CLOB, CUBRID will try to map the - data as a PHP stream. If the actually bind value type is not stream, - CUBRID will convert it to string, and use it as the full path and file - name of a file on the client filesystem. - - - If the type of data to be bound explicitly is ENUM, the bind_value - argument should be the enum element which is in string format. - - - In CUBRID shard environment, the bind_value_type must be included in - the cubrid_bind function. - - - - The following table shows the types of substitute values. - -
- CUBRID Bind Data Types - - - - Support - Bind Type - Corresponding SQL Type - - - - - Supported - STRING - CHAR, VARCHAR - - - - NCHAR - NCHAR, NVARCHAR - - - - BIT - BIT, VARBIT - - - - NUMERIC or NUMBER - SHORT, INT, NUMERIC - - - - FLOAT - FLOAT - - - - DOUBLE - DOUBLE - - - - TIME - TIME - - - - DATE - DATE - - - - TIMESTAMP - TIMESTAMP - - - - OBJECT - OBJECT - - - - ENUM - ENUM - - - - BLOB - BLOB - - - - CLOB - CLOB - - - - NULL - NULL - - - Not supported - SET - SET - - - - MULTISET - MULTISET - - - - SEQUENCE - SEQUENCE - - - -
- - - - &reftitle.parameters; - - - req_identifier - Request identifier as a result of - cubrid_prepare. - - - bind_index - Location of binding parameters. It starts with 1. - - - bind_value - Actual value for binding. - - - bind_value_type - A type of the value to bind. (It is omitted by default. - Thus, the system internally uses string by default. However, you need to - specify the exact type of the value as an argument when they are NCHAR, - BIT, or BLOB/CLOB). - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - 8.3.1 - - Added BLOB/CLOB data types support. - - - - - - - - - &reftitle.examples; - - <function>cubrid_bind</function> example - - -]]> - -&example.outputs; - - - - - - - <function>cubrid_bind</function> BLOB/CLOB example - - -]]> - - - - - <function>cubrid_bind</function> BLOB/CLOB example - - -]]> - - - - - - &reftitle.seealso; - - cubrid_execute - cubrid_prepare - - - - diff --git a/reference/cubrid/functions/cubrid-close-prepare.xml b/reference/cubrid/functions/cubrid-close-prepare.xml deleted file mode 100644 index 7f02a650246e..000000000000 --- a/reference/cubrid/functions/cubrid-close-prepare.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - cubrid_close_prepare - Close the request handle - - - - &reftitle.description; - - boolcubrid_close_prepare - resourcereq_identifier - - - The cubrid_close_prepare function closes the request - handle given by the req_identifier argument, and - releases the memory region related to the handle. It is an alias of - cubrid_close_request. - - - - - &reftitle.parameters; - - - req_identifier - Request identifier. - - - - - - &reftitle.returnvalues; - - Return &true; on success. - - - - - &reftitle.examples; - - <function>cubrid_close_prepare</function> example - - -]]> - - - - - - &reftitle.seealso; - - cubrid_close_request - - - - diff --git a/reference/cubrid/functions/cubrid-close-request.xml b/reference/cubrid/functions/cubrid-close-request.xml deleted file mode 100644 index 9ab9f38d89d2..000000000000 --- a/reference/cubrid/functions/cubrid-close-request.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - cubrid_close_request - Close the request handle - - - - &reftitle.description; - - boolcubrid_close_request - resourcereq_identifier - - - The cubrid_close_request function closes the request - handle given by the req_identifier argument, and - releases the memory region related to the handle. It is an alias of - cubrid_close_prepare. - - - - - &reftitle.parameters; - - - req_identifier - Request identifier. - - - - - - &reftitle.returnvalues; - - Return &true; on success. - - - - - &reftitle.examples; - - <function>cubrid_close_request</function> example - - -]]> - - - - - - &reftitle.seealso; - - cubrid_close_prepare - - - - - diff --git a/reference/cubrid/functions/cubrid-col-get.xml b/reference/cubrid/functions/cubrid-col-get.xml deleted file mode 100644 index 38c79b6190fb..000000000000 --- a/reference/cubrid/functions/cubrid-col-get.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - cubrid_col_get - Get contents of collection type column using OID - - - - &reftitle.description; - - arraycubrid_col_get - resourceconn_identifier - stringoid - stringattr_name - - - The cubrid_col_get function is used to get contents - of the elements of the collection type (set, multiset, sequence) attribute - you requested as an array. - - - - - &reftitle.parameters; - - - conn_identifier - Connection identifier. - - - oid - OID of the instance that you want to read. - - - attr_name - Attribute name that you want to read from the instance. - - - - - - &reftitle.returnvalues; - - Array (0-based numerical array) containing the elements you requested, - when process is successful; - - - &false; (to distinguish the error from the situation of attribute having - empty collection or NULL, in case of error, a warning message is shown; in - such case you can check the error by using - cubrid_error_code), when process is unsuccessful. - - - - - &reftitle.examples; - - <function>cubrid_col_get</function> example - - -]]> - - &example.outputs; - - - string(1) "1" - [1]=> - string(1) "2" - [2]=> - string(1) "3" -} -int(3) -]]> - - - - - diff --git a/reference/cubrid/functions/cubrid-col-size.xml b/reference/cubrid/functions/cubrid-col-size.xml deleted file mode 100644 index 63b49ada757a..000000000000 --- a/reference/cubrid/functions/cubrid-col-size.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - cubrid_col_size - Get the number of elements in collection type column using OID - - - - &reftitle.description; - - intcubrid_col_size - resourceconn_identifier - stringoid - stringattr_name - - - The cubrid_col_size function is used to get the - number of elements in a collection type (set, multiset, sequence) - attribute. - - - - - &reftitle.parameters; - - - conn_identifier - Connection identifier. - - - oid - OID the instance that you want to work with. - - - attr_name - Name of the attribute that you want to work with. - - - - - - &reftitle.returnvalues; - - Number of elements, when process is successful,&return.falseforfailure;. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - 8.3.1 - - Change return value: when process is unsuccessful, return false, not -1. - - - - - - - - - &reftitle.examples; - - <function>cubrid_col_size</function> example - - -]]> - - &example.outputs; - - - string(1) "1" - [1]=> - string(1) "2" - [2]=> - string(1) "3" -} -int(3) -]]> - - - - - diff --git a/reference/cubrid/functions/cubrid-column-names.xml b/reference/cubrid/functions/cubrid-column-names.xml deleted file mode 100644 index 0fb8a37de1ab..000000000000 --- a/reference/cubrid/functions/cubrid-column-names.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - cubrid_column_names - Get the column names in result - - - - &reftitle.description; - - arraycubrid_column_names - resourcereq_identifier - - - The cubrid_column_names function is used to get the - column names of the query result by using req_identifier. - - - - - &reftitle.parameters; - - - req_identifier - Request identifier. - - - - - - &reftitle.returnvalues; - - Array of string values containing the column names, when process is successful,&return.falseforfailure;. - - - - - &reftitle.examples; - - <function>cubrid_column_names</function> example - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_prepare - cubrid_execute - cubrid_column_types - - - - - diff --git a/reference/cubrid/functions/cubrid-column-types.xml b/reference/cubrid/functions/cubrid-column-types.xml deleted file mode 100644 index 7431f6ffda8a..000000000000 --- a/reference/cubrid/functions/cubrid-column-types.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - cubrid_column_types - Get column types in result - - - - &reftitle.description; - - arraycubrid_column_types - resourcereq_identifier - - - The cubrid_column_types function gets column types of - query results by using req_identifier. - - - - - &reftitle.parameters; - - - req_identifier - Request identifier. - - - - - - &reftitle.returnvalues; - - Array of string values containing the column types, when process is successful,&return.falseforfailure;. - - - - - &reftitle.examples; - - <function>cubrid_column_types</function> example - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_column_names - cubrid_prepare - cubrid_execute - - - - - diff --git a/reference/cubrid/functions/cubrid-commit.xml b/reference/cubrid/functions/cubrid-commit.xml deleted file mode 100644 index 90055a29fe08..000000000000 --- a/reference/cubrid/functions/cubrid-commit.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - cubrid_commit - Commit a transaction - - - - &reftitle.description; - - boolcubrid_commit - resourceconn_identifier - - The cubrid_commit function is used to execute commit - on the transaction pointed by conn_identifier, - currently in progress. Connection to the server is closed after the - cubrid_commit function is called; However, - the connection handle is still valid. - - - In CUBRID PHP, auto-commit mode is disabled by default for transaction management. - You can set it by using cubrid_set_autocommit. - You can get its status by using cubrid_get_autocommit. Before you start a transaction, - remember to disable the auto-commit mode. - - - - - &reftitle.parameters; - - - conn_identifier - Connection identifier. - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>cubrid_commit</function> example - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_rollback - cubrid_get_autocommit - cubrid_set_autocommit - - - - diff --git a/reference/cubrid/functions/cubrid-connect-with-url.xml b/reference/cubrid/functions/cubrid-connect-with-url.xml deleted file mode 100644 index 89583b17915a..000000000000 --- a/reference/cubrid/functions/cubrid-connect-with-url.xml +++ /dev/null @@ -1,240 +0,0 @@ - - - - - cubrid_connect_with_url - Establish the environment for connecting to CUBRID server - - - - &reftitle.description; - - resourcecubrid_connect_with_url - stringconn_url - stringuserid - stringpasswd - boolnew_link&false; - - - The cubrid_connect_with_url function is used to - establish the environment for connecting to your server by using connection - information passed with an url string argument. If the HA feature is - enabled in CUBRID, you must specify the connection information of the - standby server, which is used for failover when failure occurs, in the url - string argument of this function. If the user name and password is not - given, then the "PUBLIC" connection will be made by default. - - - <url> ::= CUBRID:<host>:<db_name>:<db_user>:<db_password>:[?<properties>] - - - <properties> ::= <property> [&<property>] - - - <properties> ::= alhosts=<alternative_hosts>[ &rctime=<time>] - - - <properties> ::= login_timeout=<milli_sec> - - - <properties> ::= query_timeout=<milli_sec> - - - <properties> ::= disconnect_on_query_timeout=true|false - - - <alternative_hosts> ::= <standby_broker1_host>:<port> [,<standby_broker2_host>:<port>] - - - <host> := HOSTNAME | IP_ADDR - - - <time> := SECOND - - - <milli_sec> := MILLI SECOND - - - host : A host name or IP address of the master database - db_name : A name of the database - db_user : A name of the database user - db_password : A database user password - - alhosts : Specifies the broker information of the standby server, which is - used for failover when it is impossible to connect to the active server. - You can specify multiple brokers for failover, and the connection to the brokers - is attempted in the order listed in alhosts - - rctime : An interval between the attempts to connect to the active broker in - which failure occurred. After a failure occurs, the system connects to the - broker specified by althosts (failover), terminates the transaction, and then - attempts to connect to the active broker of the master database at every rctime. - The default value is 600 seconds. - - login_timeout : Timeout value (unit: msec.) for database login. The default - value is 0, which means infinite postponement. - - - query_timeout : Timeout value (unit: msec.) for query request. Upon timeout, - a message to cancel the requested query is sent to the server. The return - value can depend on the disconnect_on_query_timeout configuration; even though the - message to cancel a request is sent to server, that request may succeed. - - - disconnect_on_query_timeout : Configures a value whether to immediately return - an error of function being executed upon timeout. The default value is false. - - - - - ? and : that are used as identifiers - in PHP connection URL can't be included in the password. The following is - an example of a password that is invalid to use as connection URL because it contains - "?:". - - - $url = "CUBRID:localhost:33000:tdb:dba:12?:?login_timeout=100"; - - - Passwords that contain ? or : - may be passed as a separate parameter. - - - $url = "CUBRID:localhost:33000:tbd:::?login_timeout=100"; - - - $conn = cubrid_connect_with_url($url, "dba", "12?"); - - - If user or password is empty,you can't delete ":",the following is - an example. - - - $url = "CUBRID:localhost:33000:demodb:::"; - - - - - - &reftitle.parameters; - - - conn_url - A character string that contains server connection information. - - - userid - User name for the database. - - - passwd - User password. - - - new_link - If a second call is made to - cubrid_connect_with_url with the same arguments, - no new connection will be established, but instead, the connection - identifier of the already opened connection will be returned. The - new_link parameter modifies this behavior and - makes cubrid_connect_with_url always open a new - connection, even if cubrid_connect_with_url was - called before with the same parameters. - - - - - - &reftitle.returnvalues; - - Connection identifier, when process is successful,&return.falseforfailure;. - - - - - &reftitle.examples; - - <function>cubrid_connect_with_url</function> url without properties example - - -]]> - - - - - <function>cubrid_connect_with_url</function> url with properties example - - -]]> - - - - - - &reftitle.seealso; - - cubrid_connect - cubrid_pconnect - cubrid_pconnect_with_url - cubrid_disconnect - cubrid_close - - - - - diff --git a/reference/cubrid/functions/cubrid-connect.xml b/reference/cubrid/functions/cubrid-connect.xml deleted file mode 100644 index 4e7107b1b7f4..000000000000 --- a/reference/cubrid/functions/cubrid-connect.xml +++ /dev/null @@ -1,165 +0,0 @@ - - - - - cubrid_connect - Open a connection to a CUBRID Server - - - - &reftitle.description; - - resourcecubrid_connect - stringhost - intport - stringdbname - stringuserid - stringpasswd - boolnew_link&false; - - - The cubrid_connect function is used to establish the - environment for connecting to your server by using your server address, - port number, database name, user name, and password. If the user name and - password is not given, then the "PUBLIC" connection will be made by - default. - - - - - &reftitle.parameters; - - - host - Host name or IP address of CUBRID CAS server. - - - port - Port number of CUBRID CAS server (BROKER_PORT configured in $CUBRID/conf/cubrid_broker.conf). - - - dbname - Name of database. - - - userid - User name for the database. If not given, the default - value is "public". - - - passwd - User password. If not given, the default value is "". - - - new_link - If a second call is made to - cubrid_connect with the same arguments, no new - connection will be established, but instead, the connection identifier - of the already opened connection will be returned. The - new_link parameter modifies this behavior and - makes cubrid_connect always open a new connection, - even if cubrid_connect was called before with the - same parameters. - - - - - - &reftitle.returnvalues; - - Connection identifier, when process is successful,&return.falseforfailure;. - - - - - &reftitle.examples; - - <function>cubrid_connect</function> example - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_pconnect - cubrid_connect_with_url - cubrid_pconnect_with_url - cubrid_disconnect - cubrid_close - - - - - diff --git a/reference/cubrid/functions/cubrid-current-oid.xml b/reference/cubrid/functions/cubrid-current-oid.xml deleted file mode 100644 index c4de97d3576d..000000000000 --- a/reference/cubrid/functions/cubrid-current-oid.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - cubrid_current_oid - Get OID of the current cursor location - - - - &reftitle.description; - - stringcubrid_current_oid - resourcereq_identifier - - - The cubrid_current_oid function is used to get the - oid of the current cursor location from the query result. To use - cubrid_current_oid, the query executed must be a - updatable query, and the CUBRID_INCLUDE_OID option must be included during - the query execution. - - - - - &reftitle.parameters; - - - req_identifier - Request identifier. - - - - - - &reftitle.returnvalues; - - Oid of current cursor location, when process is successful,&return.falseforfailure;. - - - - - &reftitle.examples; - - <function>cubrid_current_oid</function> example - - -]]> - - &example.outputs; - - X - [f_name] => Mixed -) -]]> - - - - - - - &reftitle.seealso; - - cubrid_execute - - - - - diff --git a/reference/cubrid/functions/cubrid-disconnect.xml b/reference/cubrid/functions/cubrid-disconnect.xml deleted file mode 100644 index 730a5874f58b..000000000000 --- a/reference/cubrid/functions/cubrid-disconnect.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - cubrid_disconnect - Close a database connection - - - - &reftitle.description; - - boolcubrid_disconnect - resourceconn_identifier - - - The cubrid_disconnect function closes the connection - handle and disconnects from server. If any request handle is not closed at this point, - it will be closed. It is similar to the CUBRID MySQL compatible function cubrid_close. - - - - - &reftitle.parameters; - - - conn_identifier - Connection identifier. - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>cubrid_disconnect</function> example - - -]]> - - - - - - &reftitle.seealso; - - cubrid_close - cubrid_connect - cubrid_connect_with_url - - - - - diff --git a/reference/cubrid/functions/cubrid-drop.xml b/reference/cubrid/functions/cubrid-drop.xml deleted file mode 100644 index 53b5564915a1..000000000000 --- a/reference/cubrid/functions/cubrid-drop.xml +++ /dev/null @@ -1,178 +0,0 @@ - - - - - cubrid_drop - Delete an instance using OID - - - - &reftitle.description; - - boolcubrid_drop - resourceconn_identifier - stringoid - - - The cubrid_drop function is used to delete an - instance from database by using the oid of the instance. - - - - - &reftitle.parameters; - - - conn_identifier - Connection identifier. - - - oid - Oid of the instance that you want to delete. - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>cubrid_drop</function> example - - -]]> - - &example.outputs; - - - string(1) "1" - ["b"]=> - array(3) { - [0]=> - string(1) "1" - [1]=> - string(1) "2" - [2]=> - string(1) "3" - } - ["c"]=> - array(4) { - [0]=> - string(2) "11" - [1]=> - string(2) "22" - [2]=> - string(2) "33" - [3]=> - string(3) "333" - } - ["d"]=> - string(10) "a " -} - ---- After Drop: --- -array(4) { - ["a"]=> - string(1) "2" - ["b"]=> - array(3) { - [0]=> - string(1) "4" - [1]=> - string(1) "5" - [2]=> - string(1) "7" - } - ["c"]=> - array(4) { - [0]=> - string(2) "44" - [1]=> - string(2) "55" - [2]=> - string(2) "66" - [3]=> - string(3) "666" - } - ["d"]=> - string(10) "b " -} -]]> - - - - - - &reftitle.seealso; - - cubrid_is_instance - - - - - diff --git a/reference/cubrid/functions/cubrid-error-code-facility.xml b/reference/cubrid/functions/cubrid-error-code-facility.xml deleted file mode 100644 index 0c5682431b69..000000000000 --- a/reference/cubrid/functions/cubrid-error-code-facility.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - cubrid_error_code_facility - Get the facility code of error - - - - &reftitle.description; - - intcubrid_error_code_facility - - - - The cubrid_error_code_facility function is used to - get the facility code (level in which the error occurred) from the error - code of the error that occurred during the API execution. Usually, you can - get the error code when API returns false as its return value. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Facility code of the error code that occurred: - CUBRID_FACILITY_DBMS, CUBRID_FACILITY_CAS, - CUBRID_FACILITY_CCI, CUBRID_FACILITY_CLIENT. - - - - - &reftitle.examples; - - <function>cubrid_error_code_facility</function> example - - -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - cubrid_error_code - cubrid_error_msg - - - - - diff --git a/reference/cubrid/functions/cubrid-error-code.xml b/reference/cubrid/functions/cubrid-error-code.xml deleted file mode 100644 index 7989641374dc..000000000000 --- a/reference/cubrid/functions/cubrid-error-code.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - cubrid_error_code - Get error code for the most recent function call - - - - &reftitle.description; - - intcubrid_error_code - - - - The cubrid_error_code function is used to get the - error code of the error that occurred during the API execution. Usually, - it gets the error code when API returns false as its return value. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Error code of the error that occurred, or 0 (zero) if no - error occurred. - - - - - - &reftitle.examples; - - <function>cubrid_error_code</function> example - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_error_code_facility - cubrid_error_msg - - - - - diff --git a/reference/cubrid/functions/cubrid-error-msg.xml b/reference/cubrid/functions/cubrid-error-msg.xml deleted file mode 100644 index c2b5498ec984..000000000000 --- a/reference/cubrid/functions/cubrid-error-msg.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - cubrid_error_msg - Get last error message for the most recent function call - - - - &reftitle.description; - - stringcubrid_error_msg - - - - The cubrid_error_msg function is used to get the - error message that occurred during the use of CUBRID API. Usually, it gets - error message when API returns false as its return value. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Error message that occurred. - - - - - - &reftitle.examples; - - <function>cubrid_error_msg</function> example - - -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - cubrid_error_code - cubrid_error_code_facility - - - - - diff --git a/reference/cubrid/functions/cubrid-execute.xml b/reference/cubrid/functions/cubrid-execute.xml deleted file mode 100644 index 3148a966a056..000000000000 --- a/reference/cubrid/functions/cubrid-execute.xml +++ /dev/null @@ -1,194 +0,0 @@ - - - - - cubrid_execute - Execute a prepared SQL statement - - - - &reftitle.description; - - resourcecubrid_execute - resourceconn_identifier - stringsql - intoption0 - - - boolcubrid_execute - resourcerequest_identifier - intoption0 - - - The cubrid_execute function is used to execute the - given SQL statement. It executes the query by using - conn_identifier and SQL, and then returns the - request identifier created. It is used for simple execution of query, - where the parameter binding is not needed. In addition, the - cubrid_execute function is used to execute the - prepared statement by means of cubrid_prepare and - cubrid_bind. At this time, you need to specify - arguments of request_identifier and - option. - - - The option is used to determine whether to get OID - after query execution and whether to execute the query in synchronous or - asynchronous mode. CUBRID_INCLUDE_OID and CUBRID_ASYNC (or - CUBRID_EXEC_QUERY_ALL if you want to execute multiple SQL statements) can - be specified by using a bitwise OR operator. If not specified, neither of - them is selected. If the flag CUBRID_EXEC_QUERY_ALL is set, a synchronous - mode (sync_mode) is used to retrieve query results, and in such cases the - following rules are applied: - - - The return value is the result of the first query. - - If an error occurs in any query, the execution is processed as a - failure. - - - In a query composed of q1 q2 q3, if an error - occurs in q2 after q1 succeeds the execution, the result of q1 remains - valid. That is, the previous successful query executions are not rolled - back when an error occurs. - - - If a query is executed successfully, the result of the second query can - be obtained using cubrid_next_result. - - - - If the first argument is request_identifier to - execute the cubrid_prepare function, you can specify - an option, CUBRID_ASYNC only. - - - - - &reftitle.parameters; - - - conn_identifier - Connection identifier. - - - sql - SQL to be executed. - - - option - Query execution option CUBRID_INCLUDE_OID, CUBRID_ASYNC, CUBRID_EXEC_QUERY_ALL. - - - request_identifier - cubrid_prepare identifier. - - - - - - &reftitle.returnvalues; - - Request identifier, when process is successful and first param is - conn_identifier; &true;, when process is successful and first argument is - request_identifier,&return.falseforfailure;. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - 8.4.0 - - Add new option CUBRID_EXEC_QUERY_ALL. - - - - - - - - - &reftitle.examples; - - <function>cubrid_execute</function> example - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_prepare - cubrid_bind - cubrid_next_result - cubrid_close_request - cubrid_commit - cubrid_rollback - - - - - diff --git a/reference/cubrid/functions/cubrid-fetch.xml b/reference/cubrid/functions/cubrid-fetch.xml deleted file mode 100644 index 4ae412bf7374..000000000000 --- a/reference/cubrid/functions/cubrid-fetch.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - cubrid_fetch - Fetch the next row from a result set - - - - &reftitle.description; - - mixedcubrid_fetch - resourceresult - inttypeCUBRID_BOTH - - - The cubrid_fetch function is used to get a single row from the query result. The cursor automatically moves to the next row after getting the result. - - - - - &reftitle.parameters; - - - result - result comes from a call to cubrid_execute - - - type - Array type of the fetched result CUBRID_NUM, CUBRID_ASSOC, - CUBRID_BOTH, CUBRID_OBJECT. If you want to operate the lob object, you can - use CUBRID_LOB. - - - - - - &reftitle.returnvalues; - Result array or object, when process is successful. - &false;, when there are no more rows; NULL, when process is unsuccessful. - The result can be received either as an array or as an object, and you can decide which data type to use by setting the type argument. The type variable can be set to one of the following values: - - CUBRID_NUM : Numerical array (0-based) - CUBRID_ASSOC : Associative array - CUBRID_BOTH : Numerical & Associative array (default) - CUBRID_OBJECT : object that has the attribute name as the column name of query result - - When type argument is omitted, the result will be received using CUBRID_BOTH option as default. When you want to receive query result in object data type, the column name of the result must obey the naming rules for identifiers in PHP. For example, column name such as "count(*)" cannot be received in object type. - - - - &reftitle.examples; - - <function>cubrid_fetch</function> example - - 10000"); - -printf("%-40s %-10s %-6s %-20s\n", "name", "area", "seats", "address"); -while ($row = cubrid_fetch($req)) { - printf("%-40s %-10s %-6s %-20s\n", - $row["name"], $row["area"], $row["seats"], $row["address"]); -} - -// if you want to operate lob object, you can use cubrid_fetch($req, CUBRID_LOB) - -cubrid_close_request($req); - -cubrid_disconnect($conn); -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_execute - cubrid_fetch_array - cubrid_fetch_row - cubrid_fetch_assoc - cubrid_fetch_object - - - - - diff --git a/reference/cubrid/functions/cubrid-free-result.xml b/reference/cubrid/functions/cubrid-free-result.xml deleted file mode 100644 index 83ec6e82b291..000000000000 --- a/reference/cubrid/functions/cubrid-free-result.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - cubrid_free_result - Free the memory occupied by the result data - - - - &reftitle.description; - - boolcubrid_free_result - resourcereq_identifier - - - This function frees the memory occupied by the result data. It returns - &true; on success or &false; on failure. Note that it can only frees the - client fetch buffer now, and if you want free all memory, use function - cubrid_close_request. - - - - - &reftitle.parameters; - - - req_identifier - This is the request identifier. - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>cubrid_free_result</function> example - - -]]> - - &example.outputs; - - - string(5) "20005" - ["athlete"]=> - string(12) "Hayes Joanna" - ["host_year"]=> - string(4) "2004" - ["score"]=> - string(5) "12.37" - ["unit"]=> - string(4) "time" -} -]]> - - - - - - diff --git a/reference/cubrid/functions/cubrid-get-autocommit.xml b/reference/cubrid/functions/cubrid-get-autocommit.xml deleted file mode 100644 index 3ab793ca62ad..000000000000 --- a/reference/cubrid/functions/cubrid-get-autocommit.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - cubrid_get_autocommit - Get auto-commit mode of the connection - - - - &reftitle.description; - - boolcubrid_get_autocommit - resourceconn_identifier - - - The cubrid_get_autocommit function is used to get the status of CUBRID - database connection auto-commit mode. - - - For CUBRID 8.4.0, auto-commit mode is disabled by default for transaction - management. - - - For CUBRID 8.4.1, auto-commit mode is enabled by default for transaction - management. - - - - - &reftitle.parameters; - - - conn_identifier - Connection identifier. - - - - - - &reftitle.returnvalues; - - &true;, when auto-commit is on. - - - &false;, when auto-commit is off. - - - &null; on error. - - - - - &reftitle.seealso; - - cubrid_set_autocommit - cubrid_commit - - - - diff --git a/reference/cubrid/functions/cubrid-get-charset.xml b/reference/cubrid/functions/cubrid-get-charset.xml deleted file mode 100644 index 2aad500fd6a8..000000000000 --- a/reference/cubrid/functions/cubrid-get-charset.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - cubrid_get_charset - Return the current CUBRID connection charset - - - - &reftitle.description; - - stringcubrid_get_charset - resourceconn_identifier - - - This function returns the current CUBRID connection charset and is similar - to the CUBRID MySQL compatible function - cubrid_client_encoding. - - - - - &reftitle.parameters; - - - conn_identifier - The CUBRID connection. - - - - - - &reftitle.returnvalues; - - A string that represents the CUBRID connection charset on success,&return.falseforfailure;. - - - - - &reftitle.examples; - - <function>cubrid_get_charset</function> example - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_client_encoding - - - - - diff --git a/reference/cubrid/functions/cubrid-get-class-name.xml b/reference/cubrid/functions/cubrid-get-class-name.xml deleted file mode 100644 index e9b09a5fc137..000000000000 --- a/reference/cubrid/functions/cubrid-get-class-name.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - cubrid_get_class_name - Get the class name using OID - - - - &reftitle.description; - - stringcubrid_get_class_name - resourceconn_identifier - stringoid - - - The cubrid_get_class_name function is used to get the - class name from oid. It doesn't work when selecting data from the system tables, - for example db_class. - - - - - &reftitle.parameters; - - - conn_identifier - Connection identifier. - - - oid - OID of the instance that you want to check the existence. - - - - - - &reftitle.returnvalues; - - Class name when process is successful,&return.falseforfailure;. - - - - - &reftitle.examples; - - <function>cubrid_get_class_name</function> example - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_is_instance - cubrid_drop - - - - diff --git a/reference/cubrid/functions/cubrid-get-client-info.xml b/reference/cubrid/functions/cubrid-get-client-info.xml deleted file mode 100644 index 5dff1dea5e40..000000000000 --- a/reference/cubrid/functions/cubrid-get-client-info.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - cubrid_get_client_info - Return the client library version - - - - &reftitle.description; - - stringcubrid_get_client_info - - - - This function returns a string that represents the client library version. - - - - - &reftitle.parameters; - - - - - - - &reftitle.returnvalues; - - A string that represents the client library version on success,&return.falseforfailure;. - - - - - &reftitle.examples; - - <function>cubrid_get_client_info</function> example - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/cubrid/functions/cubrid-get-db-parameter.xml b/reference/cubrid/functions/cubrid-get-db-parameter.xml deleted file mode 100644 index 5337b2af6e34..000000000000 --- a/reference/cubrid/functions/cubrid-get-db-parameter.xml +++ /dev/null @@ -1,255 +0,0 @@ - - - - - cubrid_get_db_parameter - Returns the CUBRID database parameters - - - - &reftitle.description; - - arraycubrid_get_db_parameter - resourceconn_identifier - - - This function returns the CUBRID database parameters,&return.falseforfailure;. - It returns an associative array with the values for the following parameters: - - - PARAM_ISOLATION_LEVEL - PARAM_LOCK_TIMEOUT - PARAM_MAX_STRING_LENGTH - PARAM_AUTO_COMMIT - - - Database parameters - - - - Parameter - Description - - - - - PARAM_ISOLATION_LEVEL - The transaction isolation level. - - - LOCK_TIMEOUT - CUBRID provides the lock timeout feature, which sets the waiting - time (in seconds) for the lock until the transaction lock setting is - allowed. The default value of the lock_timeout_in_secs parameter is - -1, which means the application client will wait indefinitely until - the transaction lock is allowed. - - - - PARAM_AUTO_COMMIT - In CUBRID PHP, auto-commit mode is disabled by default for - transaction management. It can be set by using - cubrid_set_autocommit. - - - - -
- - - The following table shows the isolation levels from 1 to 6. It consists of - table schema (row) and isolation level: - - Levels of Isolation Supported by CUBRID - - - - Name - Description - - - - - SERIALIZABLE (6) - In this isolation level, problems concerning concurrency (e.g. - dirty read, non-repeatable read, phantom read, etc.) do not - occur. - - - REPEATABLE READ CLASS with REPEATABLE READ INSTANCES (5) - Another transaction T2 cannot update the schema of table A while - transaction T1 is viewing table A. - Transaction T1 may experience phantom read for the record R that was - inserted by another transaction T2 when it is repeatedly retrieving a - specific record. - - - REPEATABLE READ CLASS with READ COMMITTED INSTANCES (or CURSOR STABILITY) (4) - Another transaction T2 cannot update the schema of table A while - transaction T1 is viewing table A. - Transaction T1 may experience R read (non-repeatable read) that was - updated and committed by another transaction T2 when it is repeatedly - retrieving the record R. - - - REPEATABLE READ CLASS with READ UNCOMMITTED INSTANCES (3) - Default isolation level. Another transaction T2 cannot update - the schema of table A while transaction T1 is viewing table A. - Transaction T1 may experience R' read (dirty read) for the record that - was updated but not committed by another transaction T2. - - - READ COMMITTED CLASS with READ COMMITTED INSTANCES (2) - Transaction T1 may experience A' read (non-repeatable read) for - the table that was updated and committed by another transaction T2 - while it is viewing table A repeatedly. Transaction T1 may experience - R' read (non-repeatable read) for the record that was updated and - committed by another transaction T2 while it is retrieving the record - R repeatedly. - - - READ COMMITTED CLASS with READ UNCOMMITTED INSTANCES (1) - Transaction T1 may experience A' read (non-repeatable read) for - the table that was updated and committed by another transaction T2 - while it is repeatedly viewing table A. Transaction T1 may experience - R' read (dirty read) for the record that was updated but not committed - by another transaction T2. - - - -
-
-
- - - &reftitle.parameters; - - - conn_identifier - - The CUBRID connection. If the connection identifier is not specified, - the last link opened by cubrid_connect is assumed. - - - - - - - &reftitle.returnvalues; - - An associative array with CUBRID database parameters; on success,&return.falseforfailure;. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - 8.4.0 - - Change LOCK_TIMEOUT to PARAM_LOCK_TIMEOUT, and MAX_STRING_LENGTH to - PARAM_MAX_STRING_LENGTH in result. - - - - - - - - - &reftitle.examples; - - <function>cubrid_get_db_parameter</function> example - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_set_db_parameter - cubrid_get_autocommit - - -
- diff --git a/reference/cubrid/functions/cubrid-get-query-timeout.xml b/reference/cubrid/functions/cubrid-get-query-timeout.xml deleted file mode 100644 index dbe24d024d46..000000000000 --- a/reference/cubrid/functions/cubrid-get-query-timeout.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - cubrid_get_query_timeout - Get the query timeout value of the request - - - - &reftitle.description; - - intcubrid_get_query_timeout - resourcereq_identifier - - - The cubrid_get_query_timeout function is used to get - the query timeout of the request. - - - - - &reftitle.parameters; - - - req_identifier - Request identifier. - - - - - - &reftitle.returnvalues; - - Returns the query timeout value in milliseconds of the current request on success,&return.falseforfailure;. - - - - - &reftitle.examples; - - <function>cubrid_get_query_timeout</function> example - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_set_query_timeout - - - - diff --git a/reference/cubrid/functions/cubrid-get-server-info.xml b/reference/cubrid/functions/cubrid-get-server-info.xml deleted file mode 100644 index 81741e70c97e..000000000000 --- a/reference/cubrid/functions/cubrid-get-server-info.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - cubrid_get_server_info - Return the CUBRID server version - - - - &reftitle.description; - - stringcubrid_get_server_info - resourceconn_identifier - - - This function returns a string that represents the CUBRID server version. - - - - - &reftitle.parameters; - - - conn_identifier - The CUBRID connection. - - - - - - &reftitle.returnvalues; - - A string that represents the CUBRID server version on success,&return.falseforfailure;. - - - - - &reftitle.examples; - - <function>cubrid_get_server_info</function> example - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/cubrid/functions/cubrid-get.xml b/reference/cubrid/functions/cubrid-get.xml deleted file mode 100644 index d91f6f203d28..000000000000 --- a/reference/cubrid/functions/cubrid-get.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - cubrid_get - Get a column using OID - - - - &reftitle.description; - - mixedcubrid_get - resourceconn_identifier - stringoid - mixedattr - - - The cubrid_get function is used to get the attribute - of the instance of the given oid. You can get - single attribute by using string data type for the - attr argument, or many attributes by using array - data type for the attr argument. - - - - - &reftitle.parameters; - - - conn_identifier - Connection identifier. - - - oid - OID of the instance that you want to read. - - - attr - Name of the attribute that you want to read. - - - - - - - &reftitle.returnvalues; - - Content of the requested attribute, when process is successful; When - attr is set with string data type, the result is - returned as a string; when attr is set with array - data type (0-based numerical array), then the result is returned in - associative array. When attr is omitted, then all - attributes are received in array form. - - - &false; when process is unsuccessful or result is NULL (If error occurs to - distinguish empty string from NULL, then it prints the warning message. - You can check the error by using cubrid_error_code) - - - - - &reftitle.examples; - - <function>cubrid_get</function> example - - -]]> - - &example.outputs; - - - string(1) "1" - ["b"]=> - array(3) { - [0]=> - string(1) "1" - [1]=> - string(1) "2" - [2]=> - string(1) "3" - } - ["c"]=> - array(4) { - [0]=> - string(2) "11" - [1]=> - string(2) "22" - [2]=> - string(2) "33" - [3]=> - string(3) "333" - } - ["d"]=> - string(10) "a " -} -]]> - - - - - - &reftitle.seealso; - - cubrid_put - - - - - diff --git a/reference/cubrid/functions/cubrid-insert-id.xml b/reference/cubrid/functions/cubrid-insert-id.xml deleted file mode 100644 index c1e992ee89cc..000000000000 --- a/reference/cubrid/functions/cubrid-insert-id.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - cubrid_insert_id - Return the ID generated for the last updated AUTO_INCREMENT column - - - - &reftitle.description; - - stringcubrid_insert_id - resourceconn_identifier - - - The cubrid_insert_id function retrieves the ID - generated for the AUTO_INCREMENT column which is updated by the previous - INSERT query. It returns 0 if the previous query does not generate new - rows, or FALSE on failure. - - - - - CUBRID supports AUTO_INCREMENT for more than one columns in a table. In - most cases, there will be a single AUTO_INCREMENT column in a table. If - there are multiple AUTO_INCREMENT columns, this function should not be - used even if it will return a value. - - - - - - &reftitle.parameters; - - - conn_identifier - - The connection identifier previously obtained by a call to - cubrid_connect. - - - - - - - &reftitle.returnvalues; - - A string representing the ID generated for an AUTO_INCREMENT column by the - previous query, on success. - - - 0, if the previous query does not generate new rows. - - - &false; on failure. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - 8.4.0 - - Change the return value from an array to string; Remove the first - parameter class_name. - - - - - - - - - &reftitle.examples; - - <function>cubrid_insert_id</function> example - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/cubrid/functions/cubrid-is-instance.xml b/reference/cubrid/functions/cubrid-is-instance.xml deleted file mode 100644 index c9e68d0af4a7..000000000000 --- a/reference/cubrid/functions/cubrid-is-instance.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - cubrid_is_instance - Check whether the instance pointed by OID exists - - - - &reftitle.description; - - intcubrid_is_instance - resourceconn_identifier - stringoid - - - The cubrid_is_instance function is used to check - whether the instance pointed by the given oid - exists or not. - - - - - &reftitle.parameters; - - - conn_identifier - Connection identifier. - - - oid - OID of the instance that you want to check the existence. - - - - - - &reftitle.returnvalues; - - 1, if such instance exists; - - - 0, if such instance does not exist; - - - -1, in case of error - - - - - &reftitle.examples; - - <function>cubrid_is_instance</function> example - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_drop - cubrid_get_class_name - - - - - diff --git a/reference/cubrid/functions/cubrid-lob-close.xml b/reference/cubrid/functions/cubrid-lob-close.xml deleted file mode 100644 index 0648917e1f77..000000000000 --- a/reference/cubrid/functions/cubrid-lob-close.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - cubrid_lob_close - Close BLOB/CLOB data - - - - &reftitle.description; - - boolcubrid_lob_close - arraylob_identifier_array - - - cubrid_lob_close is used to close all BLOB/CLOB - returned from cubrid_lob_get. - - - - - &reftitle.parameters; - - - lob_identifier_array - LOB identifier array returned from cubrid_lob_get. - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>cubrid_lob_close</function> example - - -]]> - - - - - - &reftitle.seealso; - - cubrid_lob_get - cubrid_lob_size - cubrid_lob_export - cubrid_lob_send - - - - - diff --git a/reference/cubrid/functions/cubrid-lob-export.xml b/reference/cubrid/functions/cubrid-lob-export.xml deleted file mode 100644 index 5d8406d43c41..000000000000 --- a/reference/cubrid/functions/cubrid-lob-export.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - cubrid_lob_export - Export BLOB/CLOB data to file - - - - &reftitle.description; - - boolcubrid_lob_export - resourceconn_identifier - resourcelob_identifier - stringpath_name - - - cubrid_lob_export is used to get BLOB/CLOB data from CUBRID database, and saves its contents to a file. - To use this function, you must use cubrid_lob_get first to get BLOB/CLOB info from CUBRID. - - - - - &reftitle.parameters; - - - conn_identifier - Connection identifier. - - - lob_identifier - LOB identifier. - - - path_name - Path name of the file. - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>cubrid_lob_export</function> example - - -]]> - - - - - - &reftitle.seealso; - - cubrid_lob_get - cubrid_lob_close - cubrid_lob_size - cubrid_lob_send - - - - - diff --git a/reference/cubrid/functions/cubrid-lob-get.xml b/reference/cubrid/functions/cubrid-lob-get.xml deleted file mode 100644 index 6faf6d2bdcf7..000000000000 --- a/reference/cubrid/functions/cubrid-lob-get.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - cubrid_lob_get - Get BLOB/CLOB data - - - - &reftitle.description; - - arraycubrid_lob_get - resourceconn_identifier - stringsql - - - cubrid_lob_get is used to get BLOB/CLOB meta info from CUBRID database, - CUBRID gets BLOB/CLOB by executing the SQL statement, and returns all LOBs as a resource array. - Be sure that the SQL retrieves only one column and its data type is BLOB or CLOB. - - - Remember to use cubrid_lob_close to release the LOBs if you don't need it any more. - - - - - &reftitle.parameters; - - - conn_identifier - Connection identifier. - - - sql - SQL statement to be executed. - - - - - - &reftitle.returnvalues; - - Return an array of LOB resources, when process is successful,&return.falseforfailure;. - - - - - &reftitle.examples; - - <function>cubrid_lob_get</function> example - - -]]> - - - - - - &reftitle.seealso; - - cubrid_lob_close - cubrid_lob_size - cubrid_lob_export - cubrid_lob_send - - - - - diff --git a/reference/cubrid/functions/cubrid-lob-send.xml b/reference/cubrid/functions/cubrid-lob-send.xml deleted file mode 100644 index 0220f7ec6a82..000000000000 --- a/reference/cubrid/functions/cubrid-lob-send.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - cubrid_lob_send - Read BLOB/CLOB data and send straight to browser - - - - &reftitle.description; - - boolcubrid_lob_send - resourceconn_identifier - resourcelob_identifier - - - cubrid_lob_send reads BLOB/CLOB data and passes it straight through to the browser. - To use this function, you must use cubrid_lob_get first to get BLOB/CLOB info from CUBRID. - - - - - &reftitle.parameters; - - - conn_identifier - Connection identifier. - - - lob_identifier - LOB identifier. - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>cubrid_lob_send</function> example - - -]]> - - - - - - &reftitle.seealso; - - cubrid_lob_get - cubrid_lob_close - cubrid_lob_size - cubrid_lob_export - - - - - diff --git a/reference/cubrid/functions/cubrid-lob-size.xml b/reference/cubrid/functions/cubrid-lob-size.xml deleted file mode 100644 index ab7261770ad7..000000000000 --- a/reference/cubrid/functions/cubrid-lob-size.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - cubrid_lob_size - Get BLOB/CLOB data size - - - - &reftitle.description; - - stringcubrid_lob_size - resourcelob_identifier - - - cubrid_lob_size is used to get BLOB/CLOB data size. - - - - - &reftitle.parameters; - - - lob_identifier - LOB identifier. - - - - - - &reftitle.returnvalues; - - A string representing LOB data size, when process is successful,&return.falseforfailure;. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - 8.4.0 - - Change return value type from int to string. - - - - - - - - - - &reftitle.examples; - - <function>cubrid_lob_size</function> example - - -]]> - - - - - - &reftitle.seealso; - - cubrid_lob_get - cubrid_lob_close - cubrid_lob_export - cubrid_lob_send - - - - - diff --git a/reference/cubrid/functions/cubrid-lob2-bind.xml b/reference/cubrid/functions/cubrid-lob2-bind.xml deleted file mode 100644 index d79c6015724e..000000000000 --- a/reference/cubrid/functions/cubrid-lob2-bind.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - cubrid_lob2_bind - Bind a lob object or a string as a lob object to a prepared statement as parameters - - - - &reftitle.description; - - boolcubrid_lob2_bind - resourcereq_identifier - intbind_index - mixedbind_value - stringbind_value_type - - - The cubrid_lob2_bind function is used to bind BLOB/CLOB datas - to a corresponding question mark placeholder in the SQL statement that was passed - to cubrid_prepare. If bind_value_type - is not given, string will be "BLOB" as the default. But if you use - cubrid_lob2_new before, bind_value_type - will be consistent with type in cubrid_lob2_new as the default. - - - - - &reftitle.parameters; - - - req_identifier - - Request identifier as a result of cubrid_prepare. - - - - bind_index - - Location of binding parameters. It starts with 1. - - - - bind_value - - Actual value for binding. - - - - bind_value_type - - It must be "BLOB" or "CLOB" and it won't be case-sensitive. If it not be given, the default value is "BLOB". - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>cubrid_lob2_bind</function> example - - -]]> - - - - - - &reftitle.seealso; - - cubrid_lob2_new - cubrid_lob2_close - - - - - diff --git a/reference/cubrid/functions/cubrid-lob2-close.xml b/reference/cubrid/functions/cubrid-lob2-close.xml deleted file mode 100644 index 85bd9b233cb1..000000000000 --- a/reference/cubrid/functions/cubrid-lob2-close.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - cubrid_lob2_close - Close LOB object - - - - &reftitle.description; - - boolcubrid_lob2_close - resourcelob_identifier - - - The cubrid_lob2_close function is used to close LOB object - returned from cubrid_lob2_new or got from the result set. - - - - - &reftitle.parameters; - - - lob_identifier - - Lob identifier as a result of cubrid_lob2_new or get from the result set. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - cubrid_lob2_new - - - - diff --git a/reference/cubrid/functions/cubrid-lob2-export.xml b/reference/cubrid/functions/cubrid-lob2-export.xml deleted file mode 100644 index 278c0491d1d9..000000000000 --- a/reference/cubrid/functions/cubrid-lob2-export.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - cubrid_lob2_export - Export the lob object to a file - - - - &reftitle.description; - - boolcubrid_lob2_export - resourcelob_identifier - stringfile_name - - - The cubrid_lob2_export function is used to save the - contents of BLOB/CLOB data to a file. To use this function, you must use - cubrid_lob2_new or fetch a lob object from CUBRID - database first. If the file already exists, the operation will fail. - This function will not influence the cursor position of the lob object. - It operates the entire lob object. - - - - - &reftitle.parameters; - - - lob_identifier - - Lob identifier as a result of cubrid_lob2_new or get from the result set. - - - - filename - - File name you want to store BLOB/CLOB data. It also supports the path of the file. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>cubrid_lob2_export</function> example - - -]]> - - - - - - &reftitle.seealso; - - cubrid_lob2_new - cubrid_lob2_close - cubrid_lob2_import - cubrid_lob2_bind - - - - - diff --git a/reference/cubrid/functions/cubrid-lob2-import.xml b/reference/cubrid/functions/cubrid-lob2-import.xml deleted file mode 100644 index 0e837f17085a..000000000000 --- a/reference/cubrid/functions/cubrid-lob2-import.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - cubrid_lob2_import - Import BLOB/CLOB data from a file - - - - &reftitle.description; - - boolcubrid_lob2_import - resourcelob_identifier - stringfile_name - - - The cubrid_lob2_import function is used to save the - contents of BLOB/CLOB data from a file. To use this function, you must use - cubrid_lob2_new or fetch a lob object from CUBRID database - first. If the file does not exist, the operation will fail. - This function will not influence the cursor position of the lob object. - It operates the entire lob object. - - - - - &reftitle.parameters; - - - lob_identifier - - Lob identifier as a result of cubrid_lob2_new or get from the result set. - - - - filename - - File name you want to import BLOB/CLOB data. It also supports the path of the file. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>cubrid_lob2_export</function> example - - -]]> - - - - - - &reftitle.seealso; - - cubrid_lob2_new - cubrid_lob2_close - cubrid_lob2_export - cubrid_lob2_bind - - - - - diff --git a/reference/cubrid/functions/cubrid-lob2-new.xml b/reference/cubrid/functions/cubrid-lob2-new.xml deleted file mode 100644 index 12f6a7b53637..000000000000 --- a/reference/cubrid/functions/cubrid-lob2-new.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - cubrid_lob2_new - Create a lob object - - - - &reftitle.description; - - resourcecubrid_lob2_new - resourceconn_identifier - stringtype"BLOB" - - - The cubrid_lob2_new function is used to create a lob object (both BLOB and CLOB). - This function should be used before you bind a lob object. - - - - - &reftitle.parameters; - - - conn_identifier - - Connection identifier. If the connection identifier is not specified, - the last connection opened by cubrid_connect or - cubrid_connect_with_url is assumed. - - - - type - - It may be "BLOB" or "CLOB", it won't be case-sensitive. The default value is "BLOB". - - - - - - - &reftitle.returnvalues; - - Lob identifier when it is successful,&return.falseforfailure;. - - - - - &reftitle.seealso; - - cubrid_lob2_close - - - - diff --git a/reference/cubrid/functions/cubrid-lob2-read.xml b/reference/cubrid/functions/cubrid-lob2-read.xml deleted file mode 100644 index 1c2c05fda076..000000000000 --- a/reference/cubrid/functions/cubrid-lob2-read.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - cubrid_lob2_read - Read from BLOB/CLOB data - - - - &reftitle.description; - - stringcubrid_lob2_read - resourcelob_identifier - intlen - - - The cubrid_lob2_read function reads len bytes from the - LOB data and returns the bytes read. - - - - - &reftitle.parameters; - - - lob_identifier - - Lob identifier as a result of cubrid_lob2_new or get from the result set. - - - - len - - Length from buffer you want to read from the lob data. - - - - - - - &reftitle.returnvalues; - - Returns the contents as a string, &false; when there is no more data, or &null; on failure. - - - - - &reftitle.examples; - - <function>cubrid_lob2_read</function> example 1 - - -]]> - - - - - <function>cubrid_lob2_read</function> example 2 - - -]]> - - - - - - &reftitle.seealso; - - cubrid_lob2_write - cubrid_lob2_seek - cubrid_lob2_seek64 - cubrid_lob2_tell - cubrid_lob2_tell64 - cubrid_lob2_size - cubrid_lob2_size64 - - - - - diff --git a/reference/cubrid/functions/cubrid-lob2-seek.xml b/reference/cubrid/functions/cubrid-lob2-seek.xml deleted file mode 100644 index 3af4192ea5a3..000000000000 --- a/reference/cubrid/functions/cubrid-lob2-seek.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - cubrid_lob2_seek - Move the cursor of a lob object - - - - &reftitle.description; - - boolcubrid_lob2_seek - resourcelob_identifier - intoffset - intoriginCUBRID_CURSOR_CURRENT - - - The cubrid_lob2_seek function is used to move the cursor - position of a lob object by the value set in the offset - argument, to the direction set in the origin argument. - - - To set the origin argument, you can use CUBRID_CURSOR_FIRST - to set the cursor position moving forward offset units from - the first beginning. In this case, offset must be a positive value. - - - If you use CUBRID_CURSOR_CURRENT for origin, you can move - forward or backward. and offset can be positive or negative. - - - If you use CUBRID_CURSOR_LAST for origin, you can move - backward offset units from the end of LOB object and - offset only can be positive. - - - - - &reftitle.parameters; - - - lob_identifier - - Lob identifier as a result of cubrid_lob2_new or get from the result set. - - - - offset - - Number of units you want to move the cursor. - - - - origin - - This parameter can be the following values: - CUBRID_CURSOR_FIRST: move forward from the first beginning. - CUBRID_CURSOR_CURRENT: move forward or backward from the current position. - CUBRID_CURSOR_LAST: move backward at the end of LOB object. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>cubrid_lob2_seek</function> example - - -]]> - - - - - - &reftitle.seealso; - - cubrid_lob2_read - cubrid_lob2_write - cubrid_lob2_seek64 - cubrid_lob2_tell - cubrid_lob2_tell64 - cubrid_lob2_size - cubrid_lob2_size64 - - - - - diff --git a/reference/cubrid/functions/cubrid-lob2-seek64.xml b/reference/cubrid/functions/cubrid-lob2-seek64.xml deleted file mode 100644 index 9561317d7ea1..000000000000 --- a/reference/cubrid/functions/cubrid-lob2-seek64.xml +++ /dev/null @@ -1,151 +0,0 @@ - - - - - cubrid_lob2_seek64 - Move the cursor of a lob object - - - - &reftitle.description; - - boolcubrid_lob2_seek64 - resourcelob_identifier - stringoffset - intoriginCUBRID_CURSOR_CURRENT - - - The cubrid_lob2_seek64 function is used to move the cursor - position of a lob object by the value set in the offset - argument, to the direction set in the origin argument. - If the offset you want to move is larger than an integer - data can be stored, you can use this function. - - - To set the origin argument, you can use CUBRID_CURSOR_FIRST - to set the cursor position moving forward offset units from - the first beginning. In this case, offset must be a positive value. - - - If you use CUBRID_CURSOR_CURRENT for origin, you can move - forward or backward. and offset can be positive or negative. - - - If you use CUBRID_CURSOR_LAST for origin, you can move backward - offset units from the end of LOB object and offset only can be positive. - - - - If you use this function to move the cursor position of the lob object, you should pass offset as a string. - - - - - - &reftitle.parameters; - - - lob_identifier - - Lob identifier as a result of cubrid_lob2_new or get from the result set. - - - - offset - - Number of units you want to move the cursor. - - - - origin - - This parameter can be the following values: - CUBRID_CURSOR_FIRST: move forward from the first beginning. - CUBRID_CURSOR_CURRENT: move forward or backward from the current position. - CUBRID_CURSOR_LAST: move backward at the end of LOB object. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>cubrid_lob2_seek64</function> example - - -]]> - - - - - - &reftitle.seealso; - - cubrid_lob2_read - cubrid_lob2_write - cubrid_lob2_seek - cubrid_lob2_tell - cubrid_lob2_tell64 - cubrid_lob2_size - cubrid_lob2_size64 - - - - - diff --git a/reference/cubrid/functions/cubrid-lob2-size.xml b/reference/cubrid/functions/cubrid-lob2-size.xml deleted file mode 100644 index 183d27f72fda..000000000000 --- a/reference/cubrid/functions/cubrid-lob2-size.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - cubrid_lob2_size - Get a lob object's size - - - - &reftitle.description; - - intcubrid_lob2_size - resourcelob_identifier - - - The cubrid_lob2_size function is used to get the size of a lob object. - - - - - &reftitle.parameters; - - - lob_identifier - - Lob identifier as a result of cubrid_lob2_new or get from the result set. - - - - - - - &reftitle.returnvalues; - - It will return the size of the LOB object when it processes successfully,&return.falseforfailure;. - - - - - &reftitle.seealso; - - cubrid_lob2_read - cubrid_lob2_write - cubrid_lob2_seek - cubrid_lob2_seek64 - cubrid_lob2_tell - cubrid_lob2_tell64 - cubrid_lob2_size64 - - - - - diff --git a/reference/cubrid/functions/cubrid-lob2-size64.xml b/reference/cubrid/functions/cubrid-lob2-size64.xml deleted file mode 100644 index 7f0b966ab2ae..000000000000 --- a/reference/cubrid/functions/cubrid-lob2-size64.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - cubrid_lob2_size64 - Get a lob object's size - - - - &reftitle.description; - - stringcubrid_lob2_size64 - resourcelob_identifier - - - The cubrid_lob2_size64 function is used to get the - size of a lob object. If the size of a lob object is larger than an - integer data can be stored, you can use this function and it will return - the size as a string. - - - - - &reftitle.parameters; - - - lob_identifier - - Lob identifier as a result of cubrid_lob2_new or get from the result set. - - - - - - - &reftitle.returnvalues; - - It will return the size of the LOB object as a string when it processes successfully,&return.falseforfailure;. - - - - - &reftitle.seealso; - - cubrid_lob2_read - cubrid_lob2_write - cubrid_lob2_seek - cubrid_lob2_seek64 - cubrid_lob2_tell - cubrid_lob2_tell64 - cubrid_lob2_size - - - - - diff --git a/reference/cubrid/functions/cubrid-lob2-tell.xml b/reference/cubrid/functions/cubrid-lob2-tell.xml deleted file mode 100644 index ddf413fb2403..000000000000 --- a/reference/cubrid/functions/cubrid-lob2-tell.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - cubrid_lob2_tell - Tell the cursor position of the LOB object - - - - &reftitle.description; - - intcubrid_lob2_tell - resourcelob_identifier - - - The cubrid_lob2_tell function is used to tell the cursor position of the LOB object. - - - - - &reftitle.parameters; - - - lob_identifier - - Lob identifier as a result of cubrid_lob2_new or get from the result set. - - - - - - - &reftitle.returnvalues; - - It will return the cursor position on the LOB object when it processes successfully,&return.falseforfailure;. - - - - - &reftitle.seealso; - - cubrid_lob2_read - cubrid_lob2_write - cubrid_lob2_seek - cubrid_lob2_seek64 - cubrid_lob2_tell64 - cubrid_lob2_size - cubrid_lob2_size64 - - - - - diff --git a/reference/cubrid/functions/cubrid-lob2-tell64.xml b/reference/cubrid/functions/cubrid-lob2-tell64.xml deleted file mode 100644 index 224a46ae55de..000000000000 --- a/reference/cubrid/functions/cubrid-lob2-tell64.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - cubrid_lob2_tell64 - Tell the cursor position of the LOB object - - - - &reftitle.description; - - stringcubrid_lob2_tell64 - resourcelob_identifier - - - The cubrid_lob2_tell64 function is used to tell the - cursor position of the LOB object. If the size of a lob object is larger - than an integer data can be stored, you can use this function and it will - return the position information as a string. - - - - - &reftitle.parameters; - - - lob_identifier - - Lob identifier as a result of cubrid_lob2_new or get from the result set. - - - - - - - &reftitle.returnvalues; - - It will return the cursor position on the LOB object as a string when it processes successfully,&return.falseforfailure;. - - - - - &reftitle.seealso; - - cubrid_lob2_read - cubrid_lob2_write - cubrid_lob2_seek - cubrid_lob2_seek64 - cubrid_lob2_tell - cubrid_lob2_size - cubrid_lob2_size64 - - - - - diff --git a/reference/cubrid/functions/cubrid-lob2-write.xml b/reference/cubrid/functions/cubrid-lob2-write.xml deleted file mode 100644 index 2383fd6946ed..000000000000 --- a/reference/cubrid/functions/cubrid-lob2-write.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - cubrid_lob2_write - Write to a lob object - - - - &reftitle.description; - - boolcubrid_lob2_write - resourcelob_identifier - stringbuf - - - The cubrid_lob2_write function reads as much as data - from buf and stores it to the LOB object. Note that - this function can only append characters now. - - - - - &reftitle.parameters; - - - lob_identifier - - Lob identifier as a result of cubrid_lob2_new or get from the result set. - - - - buf - - Data that need to be written to the lob object. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>cubrid_lob2_write</function> example 1 - - -]]> - - - - - <function>cubrid_lob2_write</function> example 2 - - -]]> - - - - - - &reftitle.seealso; - - cubrid_lob2_read - cubrid_lob2_seek - cubrid_lob2_seek64 - cubrid_lob2_tell - cubrid_lob2_tell64 - cubrid_lob2_size - cubrid_lob2_size64 - - - - - diff --git a/reference/cubrid/functions/cubrid-lock-read.xml b/reference/cubrid/functions/cubrid-lock-read.xml deleted file mode 100644 index 5c820a05d0b0..000000000000 --- a/reference/cubrid/functions/cubrid-lock-read.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - cubrid_lock_read - Set a read lock on the given OID - - - - &reftitle.description; - - boolcubrid_lock_read - resourceconn_identifier - stringoid - - - The cubrid_lock_read function is used to put read - lock on the instance pointed by given oid. - - - - - &reftitle.parameters; - - - conn_identifier - Connection identifier. - - - oid - OID of the instance that you want to put read lock on. - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>cubrid_lock_read</function> example - - -]]> - -&example.outputs; - - - string(1) "1" - ["b"]=> - array(3) { - [0]=> - string(1) "1" - [1]=> - string(1) "2" - [2]=> - string(1) "3" - } - ["c"]=> - array(4) { - [0]=> - string(2) "11" - [1]=> - string(2) "22" - [2]=> - string(2) "33" - [3]=> - string(3) "333" - } - ["d"]=> - string(10) "a " -} -]]> - - - - - - &reftitle.seealso; - - cubrid_lock_write - - - - - diff --git a/reference/cubrid/functions/cubrid-lock-write.xml b/reference/cubrid/functions/cubrid-lock-write.xml deleted file mode 100644 index a141af74c23e..000000000000 --- a/reference/cubrid/functions/cubrid-lock-write.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - cubrid_lock_write - Set a write lock on the given OID - - - - &reftitle.description; - - boolcubrid_lock_write - resourceconn_identifier - stringoid - - - The cubrid_lock_write function is used to put write - lock on the instance pointed by the given oid. - - - - - &reftitle.parameters; - - - conn_identifier - Connection identifier. - - - oid - OID of the instance that you want to put write lock on. - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>cubrid_lock_write</function> example - - -]]> - - &example.outputs; - - - string(1) "1" - [1]=> - string(1) "2" - [2]=> - string(1) "3" -} -array(3) { - [0]=> - string(1) "2" - [1]=> - string(1) "4" - [2]=> - string(1) "8" -} -]]> - - - - - - &reftitle.seealso; - - cubrid_lock_read - - - - - diff --git a/reference/cubrid/functions/cubrid-move-cursor.xml b/reference/cubrid/functions/cubrid-move-cursor.xml deleted file mode 100644 index 217faa8be594..000000000000 --- a/reference/cubrid/functions/cubrid-move-cursor.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - cubrid_move_cursor - Move the cursor in the result - - - - &reftitle.description; - - boolcubrid_move_cursor - resourcereq_identifier - intoffset - intoriginCUBRID_CURSOR_CURRENT - - - The cubrid_move_cursor function is used to move the - current cursor location of req_identifier by the - value set in the offset argument, to the direction - set in the origin argument. To set the - origin argument, you can use CUBRID_CURSOR_FIRST - for the first part of the result, CUBRID_CURSOR_CURRENT for the current - location of the result, or CUBRID_CURSOR_LAST for the last part of the - result. If origin argument is not explicitly - designated, then the function uses CUBRID_CURSOR_CURRENT as its default - value. - - - If the value of cursor movement range goes over the valid limit, then the - cursor moves to the next location after the valid range for the cursor. - For example, if you move 20 units in the result with the size of 10, then - the cursor will move to 11th place and return CUBRID_NO_MORE_DATA. - - - - - &reftitle.parameters; - - - req_identifier - Request identifier. - - - offset - Number of units you want to move the cursor. - - - origin - Location where you want to move the cursor from CUBRID_CURSOR_FIRST, CUBRID_CURSOR_CURRENT, CUBRID_CURSOR_LAST. - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>cubrid_move_cursor</function> example - - -]]> - -&example.outputs; - - - string(1) "G" - [1]=> - string(4) "Gold" -} -array(2) { - [0]=> - string(1) "X" - [1]=> - string(5) "Mixed" -} -array(2) { - [0]=> - string(1) "M" - [1]=> - string(3) "Man" -} -]]> - - - - - - &reftitle.seealso; - - cubrid_execute - - - - - diff --git a/reference/cubrid/functions/cubrid-next-result.xml b/reference/cubrid/functions/cubrid-next-result.xml deleted file mode 100644 index e66ce0f5e54e..000000000000 --- a/reference/cubrid/functions/cubrid-next-result.xml +++ /dev/null @@ -1,170 +0,0 @@ - - - - - cubrid_next_result - Get result of next query when executing multiple SQL statements - - - - &reftitle.description; - - boolcubrid_next_result - resourceresult - - - The cubrid_next_result function is used to get - results of next query if multiple SQL statements are executed and - CUBRID_EXEC_QUERY_ALL flag is set upon - cubrid_execute. - - - - - &reftitle.parameters; - - - result - result comes from a call to cubrid_execute - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>cubrid_next_result</function> example - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_execute - - - - - diff --git a/reference/cubrid/functions/cubrid-num-cols.xml b/reference/cubrid/functions/cubrid-num-cols.xml deleted file mode 100644 index abd1ec83c1bc..000000000000 --- a/reference/cubrid/functions/cubrid-num-cols.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - cubrid_num_cols - Return the number of columns in the result set - - - - &reftitle.description; - - intcubrid_num_cols - resourceresult - - - The cubrid_num_cols function is used to get the - number of columns from the query result. It can only be used when the - query executed is a SELECT statement. - - - - - &reftitle.parameters; - - - result - Result. - - - - - - &reftitle.returnvalues; - - Number of columns, when process is successful. - - - &false;, if SQL statement is not SELECT. - - - - - &reftitle.examples; - - <function>cubrid_num_cols</function> example - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_execute - cubrid_num_rows - - - - - diff --git a/reference/cubrid/functions/cubrid-num-rows.xml b/reference/cubrid/functions/cubrid-num-rows.xml deleted file mode 100644 index 632c3cf2de7a..000000000000 --- a/reference/cubrid/functions/cubrid-num-rows.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - cubrid_num_rows - Get the number of rows in the result set - - - - &reftitle.description; - - intcubrid_num_rows - resourceresult - - - The cubrid_num_rows function is used to get the - number of rows from the query result. - It can be used for SELECT statements. - For INSERT, UPDATE, or DELETE queries, - use the cubrid_affected_rows function. - - - Note: The cubrid_num_rows function can only be used - for synchronous query; it returns 0 when it is used for asynchronous query. - - - - - &reftitle.parameters; - - - result - result comes from a call to - cubrid_execute, cubrid_query and - cubrid_prepare - - - - - - &reftitle.returnvalues; - - Number of rows, when process is successful. - - - 0 when the query was done in async mode. - - - -1, if SQL statement is not SELECT. - - - &false; when process is unsuccessful. - - - - - &reftitle.examples; - - <function>cubrid_num_rows</function> example - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_execute - cubrid_num_cols - cubrid_affected_rows - - - - - diff --git a/reference/cubrid/functions/cubrid-pconnect-with-url.xml b/reference/cubrid/functions/cubrid-pconnect-with-url.xml deleted file mode 100644 index 1dc7e387386e..000000000000 --- a/reference/cubrid/functions/cubrid-pconnect-with-url.xml +++ /dev/null @@ -1,241 +0,0 @@ - - - - - cubrid_pconnect_with_url - Open a persistent connection to CUBRID server - - - - &reftitle.description; - - resourcecubrid_pconnect_with_url - stringconn_url - stringuserid - stringpasswd - - - Establishes a persistent connection to a CUBRID server. - - - cubrid_pconnect_with_url acts very much like - cubrid_connect_with_url with two major differences. - - - First, when connecting, the function would first try to find a (persistent) - link that's already open with the same host, port, dbname and userid. If - one is found, an identifier for it will be returned instead of opening a - new connection. - - - Second, the connection to the SQL server will not be closed when the - execution of the script ends. Instead, the link will remain open for - future use (cubrid_close or - cubrid_disconnect will not close links established by - cubrid_pconnect_with_url). - - - This type of link is therefore called 'persistent'. - - - <url> ::= CUBRID:<host>:<db_name>:<db_user>:<db_password>:[?<properties>] - - - <properties> ::= <property> [&<property>] - - - <properties> ::= alhosts=<alternative_hosts>[ &rctime=<time>] - - - <properties> ::= login_timeout=<milli_sec> - - - <properties> ::= query_timeout=<milli_sec> - - - <properties> ::= disconnect_on_query_timeout=true|false - - - <alternative_hosts> ::= <standby_broker1_host>:<port> [,<standby_broker2_host>:<port>] - - - <host> := HOSTNAME | IP_ADDR - - - <time> := SECOND - - - <milli_sec> := MILLI SECOND - - - host : A host name or IP address of the master database - db_name : A name of the database - db_user : A name of the database user - db_password : A database user password - - alhosts : Specifies the broker information of the standby server, which is - used for failover when it is impossible to connect to the active server. - You can specify multiple brokers for failover, and the connection to the brokers - is attempted in the order listed in alhosts - - rctime : An interval between the attempts to connect to the active broker in - which failure occurred. After a failure occurs, the system connects to the - broker specified by althosts (failover), terminates the transaction, and then - attempts to connect to the active broker of the master database at every rctime. - The default value is 600 seconds. - - login_timeout : Timeout value (unit: msec.) for database login. The default - value is 0, which means infinite postponement. - - - query_timeout : Timeout value (unit: msec.) for query request. Upon timeout, - a message to cancel requesting a query transferred to server is sent. The return - value can depend on the disconnect_on_query_timeout configuration; even though the - message to cancel a request is sent to server, that request may succeed. - - - disconnect_on_query_timeout : Configures a value whether to immediately return - an error of function being executed upon timeout. The default value is false. - - - - - ? and : that are used as identifiers - in PHP connection URL can't be included in the password. The following is - an example of a password that is invalid to use as connection URL because it contains - "?:". - - - $url = "CUBRID:localhost:33000:tdb:dba:12?:?login_timeout=100"; - - - Passwords that contain ? or : may be - passed as a separate parameter. - - - $url = "CUBRID:localhost:33000:tbd:::?login_timeout=100"; - - - $conn = cubrid_pconnect_with_url ($url, "dba", "12?"); - - - If user or password is empty,you can't delete ":",the following is - an example. - - - $url = "CUBRID:localhost:33000:demodb:::"; - - - - - - &reftitle.parameters; - - - conn_url - A character string that contains server connection information. - - - userid - User name for the database. - - - passwd - User password. - - - - - - &reftitle.returnvalues; - - Connection identifier, when process is successful,&return.falseforfailure;. - - - - - &reftitle.examples; - - <function>cubrid_pconnect_with_url</function> url without properties example - - -]]> - - - - - <function>cubrid_pconnect_with_url</function> url with properties example - - -]]> - - - - - - &reftitle.seealso; - - cubrid_connect - cubrid_connect_with_url - cubrid_pconnect - cubrid_disconnect - cubrid_close - - - - - diff --git a/reference/cubrid/functions/cubrid-pconnect.xml b/reference/cubrid/functions/cubrid-pconnect.xml deleted file mode 100644 index 84b9bf239f8e..000000000000 --- a/reference/cubrid/functions/cubrid-pconnect.xml +++ /dev/null @@ -1,168 +0,0 @@ - - - - - cubrid_pconnect - Open a persistent connection to a CUBRID server - - - - &reftitle.description; - - resourcecubrid_pconnect - stringhost - intport - stringdbname - stringuserid - stringpasswd - - - Establishes a persistent connection to a CUBRID server. - - - cubrid_pconnect acts very much like - cubrid_connect with two major differences. - - - First, when connecting, the function would first try to find a (persistent) - link that's already open with the same host, port, dbname and userid. If - one is found, an identifier for it will be returned instead of opening a - new connection. - - - Second, the connection to the SQL server will not be closed when the - execution of the script ends. Instead, the link will remain open for - future use (cubrid_close or - cubrid_disconnect will not close links established by - cubrid_pconnect). - - - This type of link is therefore called 'persistent'. - - - - - &reftitle.parameters; - - - host - Host name or IP address of CUBRID CAS server. - - - port - Port number of CUBRID CAS server (BROKER_PORT configured in $CUBRID/conf/cubrid_broker.conf). - - - dbname - Name of database. - - - userid - User name for the database. - - - passwd - User password. - - - - - - &reftitle.returnvalues; - - Connection identifier, when process is successful,&return.falseforfailure;. - - - - - &reftitle.examples; - - <function>cubrid_pconnect</function> example - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_connect - cubrid_connect_with_url - cubrid_pconnect_with_url - cubrid_disconnect - cubrid_close - - - - - diff --git a/reference/cubrid/functions/cubrid-prepare.xml b/reference/cubrid/functions/cubrid-prepare.xml deleted file mode 100644 index ed9878f97cf8..000000000000 --- a/reference/cubrid/functions/cubrid-prepare.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - cubrid_prepare - Prepare a SQL statement for execution - - - - &reftitle.description; - - resourcecubrid_prepare - resourceconn_identifier - stringprepare_stmt - intoption0 - - - The cubrid_prepare function compiles a SQL statement for a given - connection handle and returns a handle that represents the pre-compiled statement. - - - A prepared statement can be executed several times, which is efficient for repeated - execution or for processing long data. Only a single statement can be used, and a - parameter can be marked with a question mark (?) at the appropriate - place in the SQL statement. Add a parameter when binding a value in the - VALUES clause of an INSERT statement or in the - WHERE clause. Note that a value can be bound to a parameter only by - using the cubrid_bind function. - - - - - &reftitle.parameters; - - - conn_identifier - Connection identifier. - - - prepare_stmt - Prepare query. - - - option - OID return option CUBRID_INCLUDE_OID. - - - - - - &reftitle.returnvalues; - - Request identifier, if process is successful,&return.falseforfailure;. - - - - - &reftitle.examples; - - <function>cubrid_prepare</function> example - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_execute - cubrid_bind - - - - - diff --git a/reference/cubrid/functions/cubrid-put.xml b/reference/cubrid/functions/cubrid-put.xml deleted file mode 100644 index a8bb2a9a706c..000000000000 --- a/reference/cubrid/functions/cubrid-put.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - cubrid_put - Update a column using OID - - - - &reftitle.description; - - boolcubrid_put - resourceconn_identifier - stringoid - stringattr - mixedvalue - - - The cubrid_put function is used to update an - attribute of the instance of the given oid. - - - You can update single attribute by using string data type to set - attr. In such case, you can use integer, - floating point or string type data for the value - argument. To update multiple number of attributes, you can disregard the - attr argument, and set - value argument with associative array data type. - - - - - &reftitle.parameters; - - - conn_identifier - Connection identifier. - - - oid - OID of the instance that you want to update. - - - attr - Name of the attribute that you want to update. - - - value - New value that you want to assign to the attribute. - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>cubrid_put</function> example - - -]]> - - &example.outputs; - - - string(1) "1" - [1]=> - string(1) "2" - [2]=> - string(1) "3" -} -array(3) { - [0]=> - string(1) "2" - [1]=> - string(1) "4" - [2]=> - string(1) "8" -} -]]> - - - - - - &reftitle.seealso; - - cubrid_get - cubrid_set_add - cubrid_set_drop - cubrid_seq_insert - cubrid_seq_drop - cubrid_seq_put - - - - - diff --git a/reference/cubrid/functions/cubrid-rollback.xml b/reference/cubrid/functions/cubrid-rollback.xml deleted file mode 100644 index ba2d08998dab..000000000000 --- a/reference/cubrid/functions/cubrid-rollback.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - cubrid_rollback - Roll back a transaction - - - - &reftitle.description; - - boolcubrid_rollback - resourceconn_identifier - - - The cubrid_rollback function executes rollback on the - transaction pointed by conn_identifier, currently in - progress. - - - Connection to server is closed after calling - cubrid_rollback. Connection handle, however, is - still valid. - - - - - &reftitle.parameters; - - - conn_identifier - Connection identifier. - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>cubrid_rollback</function> example - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_commit - cubrid_disconnect - - - - - diff --git a/reference/cubrid/functions/cubrid-schema.xml b/reference/cubrid/functions/cubrid-schema.xml deleted file mode 100644 index 036862df0256..000000000000 --- a/reference/cubrid/functions/cubrid-schema.xml +++ /dev/null @@ -1,624 +0,0 @@ - - - - - cubrid_schema - Get the requested schema information - - - - &reftitle.description; - - arraycubrid_schema - resourceconn_identifier - intschema_type - stringclass_name - stringattr_name - - - The cubrid_schema function is used to get the - requested schema information from database. To get information about specific class, - set the class_name, to get information about specific attribute - (can be used only with CUBRID_SCH_ATTR_PRIVILEGE), - set the attr_name. - - - - The result of the cubrid_schema function is returned as a two-dimensional - array (column (associative array) * row (numeric array)). The following - tables shows types of schema and the column structure of the result array to - be returned based on the schema type. - - - - Result Composition of Each Type - - - - Schema - Column Number - Column Name - Value - - - - - CUBRID_SCH_CLASS - 1 - NAME - - - - - 2 - TYPE - 0:system class 1:vclass 2:class - - - - CUBRID_SCH_VCLASS - 1 - NAME - - - - - 2 - TYPE - 1:vclass - - - - CUBRID_SCH_QUERY_SPEC - 1 - QUERY_SPEC - - - - - CUBRID_SCH_ATTRIBUTE / CUBRID_SCH_CLASS_ATTRIBUTE - 1 - ATTR_NAME - - - - - 2 - DOMAIN - - - - - 3 - SCALE - - - - - 4 - PRECISION - - - - - 5 - INDEXED - 1:indexed - - - - 6 - NOT NULL - 1:not null - - - - 7 - SHARED - 1:shared - - - - 8 - UNIQUE - 1:unique - - - - 9 - DEFAULT - - - - - 10 - ATTR_ORDER - base:1 - - - - 11 - CLASS_NAME - - - - - 12 - SOURCE_CLASS - - - - - 13 - IS_KEY - 1:key - - - - CUBRID_SCH_METHOD / CUBRID_SCH_CLASS_METHOD - 1 - NAME - - - - - 2 - RET_DOMAIN - - - - - 3 - ARG_DOMAIN - - - - - CUBRID_SCH_METHOD_FILE - 1 - METHOD_FILE - - - - - CUBRID_SCH_SUPERCLASS / CUBRID_SCH_DIRECT_SUPER_CLASS / CUBRID_SCH_SUBCLASS - 1 - CLASS_NAME - - - - - 2 - TYPE - 0:system class 1:vclass 2:class - - - - CUBRID_SCH_CONSTRAINT - 1 - TYPE - 0:unique 1:index 2:reverse unique 3:reverse index - - - - 2 - NAME - - - - - 3 - ATTR_NAME - - - - - 4 - NUM_PAGES - - - - - 5 - NUM_KEYS - - - - - 6 - PRIMARY_KEY - 1:primary key - - - - 7 - KEY_ORDER - base:1 - - - - CUBRID_SCH_TRIGGER - 1 - NAME - - - - - 2 - STATUS - - - - - 3 - EVENT - - - - - 4 - TARGET_CLASS - - - - - 5 - TARGET_ATTR - - - - - 6 - ACTION_TIME - - - - - 7 - ACTION - - - - - 8 - PRIORITY - - - - - 9 - CONDITION_TIME - - - - - 10 - CONDITION - - - - - CUBRID_SCH_CLASS_PRIVILEGE / CUBRID_SCH_ATTR_PRIVILEGE - 1 - CLASS_NAME / ATTR_NAME - - - - - 2 - PRIVILEGE - - - - - 3 - GRANTABLE - - - - - CUBRID_SCH_PRIMARY_KEY - 1 - CLASS_NAME - - - - - 2 - ATTR_NAME - - - - - 3 - KEY_SEQ - base:1 - - - - 4 - KEY_NAME - - - - - CUBRID_SCH_IMPORTED_KEYS / CUBRID_SCH_EXPORTED_KEYS / CUBRID_SCH_CROSS_REFERENCE - 1 - PKTABLE_NAME - - - - - 2 - PKCOLUMN_NAME - - - - - 3 - FKTABLE_NAME - base:1 - - - - 4 - FKCOLUMN_NAME - - - - - 5 - KEY_SEQ - base:1 - - - - 6 - UPDATE_ACTION - 0:cascade 1:restrict 2:no action 3:set null - - - - 7 - DELETE_ACTION - 0:cascade 1:restrict 2:no action 3:set null - - - - 8 - FK_NAME - - - - - 9 - PK_NAME - - - - -
- -
- - - &reftitle.parameters; - - - conn_identifier - Connection identifier. - - - schema_type - Schema data that you want to know. - - - class_name - Class you want to know the schema of. - - - attr_name - Attribute you want to know the schema of. - - - - - - &reftitle.returnvalues; - - Array containing the schema information, when process is successful,&return.falseforfailure;. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - 8.3.1 - - Change return value: when process is unsuccessful, return false, not -1. - - - - - - - - - &reftitle.examples; - - <function>cubrid_schema</function> example - - -]]> - - &example.outputs; - - - array(4) { - ["CLASS_NAME"]=> - string(4) "game" - ["ATTR_NAME"]=> - string(12) "athlete_code" - ["KEY_SEQ"]=> - string(1) "3" - ["KEY_NAME"]=> - string(41) "pk_game_host_year_event_code_athlete_code" - } - [1]=> - array(4) { - ["CLASS_NAME"]=> - string(4) "game" - ["ATTR_NAME"]=> - string(10) "event_code" - ["KEY_SEQ"]=> - string(1) "2" - ["KEY_NAME"]=> - string(41) "pk_game_host_year_event_code_athlete_code" - } - [2]=> - array(4) { - ["CLASS_NAME"]=> - string(4) "game" - ["ATTR_NAME"]=> - string(9) "host_year" - ["KEY_SEQ"]=> - string(1) "1" - ["KEY_NAME"]=> - string(41) "pk_game_host_year_event_code_athlete_code" - } -} - ---- Foreign Keys --- -array(2) { - [0]=> - array(9) { - ["PKTABLE_NAME"]=> - string(7) "athlete" - ["PKCOLUMN_NAME"]=> - string(4) "code" - ["FKTABLE_NAME"]=> - string(4) "game" - ["FKCOLUMN_NAME"]=> - string(12) "athlete_code" - ["KEY_SEQ"]=> - string(1) "1" - ["UPDATE_RULE"]=> - string(1) "1" - ["DELETE_RULE"]=> - string(1) "1" - ["FK_NAME"]=> - string(20) "fk_game_athlete_code" - ["PK_NAME"]=> - string(15) "pk_athlete_code" - } - [1]=> - array(9) { - ["PKTABLE_NAME"]=> - string(5) "event" - ["PKCOLUMN_NAME"]=> - string(4) "code" - ["FKTABLE_NAME"]=> - string(4) "game" - ["FKCOLUMN_NAME"]=> - string(10) "event_code" - ["KEY_SEQ"]=> - string(1) "1" - ["UPDATE_RULE"]=> - string(1) "1" - ["DELETE_RULE"]=> - string(1) "1" - ["FK_NAME"]=> - string(18) "fk_game_event_code" - ["PK_NAME"]=> - string(13) "pk_event_code" - } -} - ---- Column Attribute --- -array(1) { - [0]=> - array(13) { - ["ATTR_NAME"]=> - string(4) "area" - ["DOMAIN"]=> - string(1) "7" - ["SCALE"]=> - string(1) "2" - ["PRECISION"]=> - string(2) "10" - ["INDEXED"]=> - string(1) "0" - ["NON_NULL"]=> - string(1) "0" - ["SHARED"]=> - string(1) "0" - ["UNIQUE"]=> - string(1) "0" - ["DEFAULT"]=> - NULL - ["ATTR_ORDER"]=> - string(1) "4" - ["CLASS_NAME"]=> - string(7) "stadium" - ["SOURCE_CLASS"]=> - string(7) "stadium" - ["IS_KEY"]=> - string(1) "0" - } -} -]]> - - - - -
- diff --git a/reference/cubrid/functions/cubrid-seq-drop.xml b/reference/cubrid/functions/cubrid-seq-drop.xml deleted file mode 100644 index b281c0a0f2b8..000000000000 --- a/reference/cubrid/functions/cubrid-seq-drop.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - cubrid_seq_drop - Delete an element from sequence type column using OID - - - - &reftitle.description; - - boolcubrid_seq_drop - resourceconn_identifier - stringoid - stringattr_name - intindex - - - The cubrid_seq_drop function is used to delete an - element you request from the given sequence type attribute in the - database. - - - - - &reftitle.parameters; - - - conn_identifier - Connection identifier. - - - oid - OID of the instance you want to work with. - - - attr_name - Name of the attribute that you want to delete an element from. - - - index - Index of the element that you want to delete (1-based). - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>cubrid_seq_drop</function> example - - -]]> - -&example.outputs; - - - string(2) "11" - [1]=> - string(2) "22" - [2]=> - string(2) "33" - [3]=> - string(3) "333" -} -array(3) { - [0]=> - string(2) "11" - [1]=> - string(2) "22" - [2]=> - string(2) "33" -} -]]> - - - - - - &reftitle.seealso; - - cubrid_seq_insert - cubrid_seq_put - - - - - diff --git a/reference/cubrid/functions/cubrid-seq-insert.xml b/reference/cubrid/functions/cubrid-seq-insert.xml deleted file mode 100644 index 62e0ab25aa21..000000000000 --- a/reference/cubrid/functions/cubrid-seq-insert.xml +++ /dev/null @@ -1,147 +0,0 @@ - - - - - cubrid_seq_insert - Insert an element to a sequence type column using OID - - - - &reftitle.description; - - boolcubrid_seq_insert - resourceconn_identifier - stringoid - stringattr_name - intindex - stringseq_element - - - The cubrid_seq_insert function is used to insert an - element to a sequence type attribute in a requested location. - - - - - &reftitle.parameters; - - - conn_identifier - Connection identifier. - - - oid - OID of the instance you want to work with. - - - attr_name - Name of the attribute you want to insert an instance to. - - - index - Location of the element, you want to insert the element to (1-based). - - - seq_element - Content of the element that you want to insert. - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>cubrid_seq_insert</function> example - - -]]> - -&example.outputs; - - - string(2) "11" - [1]=> - string(2) "22" - [2]=> - string(2) "33" - [3]=> - string(3) "333" -} -array(5) { - [0]=> - string(2) "11" - [1]=> - string(2) "22" - [2]=> - string(2) "33" - [3]=> - string(3) "333" - [4]=> - string(2) "44" -} -]]> - - - - - - &reftitle.seealso; - - cubrid_seq_drop - cubrid_seq_put - - - - - diff --git a/reference/cubrid/functions/cubrid-seq-put.xml b/reference/cubrid/functions/cubrid-seq-put.xml deleted file mode 100644 index 7349e0b3fd0d..000000000000 --- a/reference/cubrid/functions/cubrid-seq-put.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - cubrid_seq_put - Update the element value of sequence type column using OID - - - - &reftitle.description; - - boolcubrid_seq_put - resourceconn_identifier - stringoid - stringattr_name - intindex - stringseq_element - - - The cubrid_seq_put function is used to update the - content of the requested element in a sequent type attribute using OID. - - - - - &reftitle.parameters; - - - conn_identifier - Connection identifier. - - - oid - OID of the instance you want to work with. - - - attr_name - Name of the attribute that you want to update an element. - - - index - Index (1-based) of the element that you want to update. - - - seq_element - New content that you want to use for the update. - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>cubrid_seq_put</function> example - - -]]> - -&example.outputs; - - - string(2) "11" - [1]=> - string(2) "22" - [2]=> - string(2) "33" - [3]=> - string(3) "333" -} -array(4) { - [0]=> - string(3) "111" - [1]=> - string(2) "22" - [2]=> - string(2) "33" - [3]=> - string(3) "333" -} -]]> - - - - - - &reftitle.seealso; - - cubrid_seq_drop - cubrid_seq_insert - - - - - diff --git a/reference/cubrid/functions/cubrid-set-add.xml b/reference/cubrid/functions/cubrid-set-add.xml deleted file mode 100644 index df5333fb3781..000000000000 --- a/reference/cubrid/functions/cubrid-set-add.xml +++ /dev/null @@ -1,138 +0,0 @@ - - - - - cubrid_set_add - Insert a single element to set type column using OID - - - - &reftitle.description; - - boolcubrid_set_add - resourceconn_identifier - stringoid - stringattr_name - stringset_element - - - The cubrid_set_add function is used to insert a - single element to a set type attribute (set, multiset, sequence) you - requested. - - - - - &reftitle.parameters; - - - conn_identifier - Connection identifier. - - - oid - OID of the instance you want to work with. - - - attr_name - Name of the attribute you want to insert an element. - - - set_element - Content of the element you want to insert. - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>cubrid_set_add</function> example - - -]]> - -&example.outputs; - - - string(1) "1" - [1]=> - string(1) "2" - [2]=> - string(1) "3" -} -array(4) { - [0]=> - string(1) "1" - [1]=> - string(1) "2" - [2]=> - string(1) "3" - [3]=> - string(1) "4" -} -]]> - - - - - - &reftitle.seealso; - - cubrid_seq_drop - - - - - diff --git a/reference/cubrid/functions/cubrid-set-autocommit.xml b/reference/cubrid/functions/cubrid-set-autocommit.xml deleted file mode 100644 index 0a13502f8717..000000000000 --- a/reference/cubrid/functions/cubrid-set-autocommit.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - cubrid_set_autocommit - Set autocommit mode of the connection - - - - &reftitle.description; - - boolcubrid_set_autocommit - resourceconn_identifier - boolmode - - - The cubrid_set_autocommit function is used to set the - CUBRID database auto-commit mode of the current database connection. - - - In CUBRID PHP, auto-commit mode is disabled by default for transaction - management. When auto-commit mode is turned from off to on, any pending work is - automatically committed. - - - - - &reftitle.parameters; - - - conn_identifier - Connection identifier. - - - mode - - Auto-commit mode. The following constants can be used: - - CUBRID_AUTOCOMMIT_FALSE - CUBRID_AUTOCOMMIT_TRUE - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - cubrid_get_autocommit - cubrid_commit - - - - diff --git a/reference/cubrid/functions/cubrid-set-db-parameter.xml b/reference/cubrid/functions/cubrid-set-db-parameter.xml deleted file mode 100644 index 79bc0e07d6c9..000000000000 --- a/reference/cubrid/functions/cubrid-set-db-parameter.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - cubrid_set_db_parameter - Sets the CUBRID database parameters - - - - &reftitle.description; - - boolcubrid_set_db_parameter - resourceconn_identifier - intparam_type - intparam_value - - - The cubrid_set_db_parameter function is used to set - the CUBRID database parameters. It can set the following CUBRID database - parameters: - - - PARAM_ISOLATION_LEVEL - PARAM_LOCK_TIMEOUT - - - - - The auto-commit mode can be set by using - cubrid_set_autocommit. - - - - - - &reftitle.parameters; - - - conn_identifier - - The CUBRID connection. If the connection identifier is not specified, - the last link opened by cubrid_connect is assumed. - - - - param_type - Database parameter type. - - - param_value - Isolation level value (1-6) or lock timeout (in seconds) value. - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>cubrid_get_db_parameter</function> example - - -]]> - - &example.outputs; - - - int(3) - ["PARAM_LOCK_TIMEOUT"]=> - int(-1) - ["PARAM_MAX_STRING_LENGTH"]=> - int(1073741823) - ["PARAM_AUTO_COMMIT"]=> - int(0) -} -array(4) { - ["PARAM_ISOLATION_LEVEL"]=> - int(2) - ["PARAM_LOCK_TIMEOUT"]=> - int(-1) - ["PARAM_MAX_STRING_LENGTH"]=> - int(1073741823) - ["PARAM_AUTO_COMMIT"]=> - int(1) -} -]]> - - - - - - &reftitle.seealso; - - cubrid_get_db_parameter - cubrid_set_autocommit - - - - diff --git a/reference/cubrid/functions/cubrid-set-drop.xml b/reference/cubrid/functions/cubrid-set-drop.xml deleted file mode 100644 index 64c3449fc12d..000000000000 --- a/reference/cubrid/functions/cubrid-set-drop.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - cubrid_set_drop - Delete an element from set type column using OID - - - - &reftitle.description; - - boolcubrid_set_drop - resourceconn_identifier - stringoid - stringattr_name - stringset_element - - - The cubrid_set_drop function is used to delete an - element that you request from the given set type (set, multiset) attribute - of the database. - - - - - &reftitle.parameters; - - - conn_identifier - Connection identifier. - - - oid - OID of the instance you want to work with. - - - attr_name - Name of the attribute you want to delete an element from. - - - set_element - Content of the element you want to delete. - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>cubrid_set_drop</function> example - - -]]> - -&example.outputs; - - - string(1) "1" - [1]=> - string(1) "2" - [2]=> - string(1) "3" -} -array(2) { - [0]=> - string(1) "2" - [1]=> - string(1) "3" -} -]]> - - - - - - &reftitle.seealso; - - cubrid_set_add - - - - - diff --git a/reference/cubrid/functions/cubrid-set-query-timeout.xml b/reference/cubrid/functions/cubrid-set-query-timeout.xml deleted file mode 100644 index 5c53b6971076..000000000000 --- a/reference/cubrid/functions/cubrid-set-query-timeout.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - cubrid_set_query_timeout - Set the timeout time of query execution - - - - &reftitle.description; - - boolcubrid_set_query_timeout - resourcereq_identifier - inttimeout - - - The cubrid_set_query_timeout function is used to set - the timeout time of query execution. - - - - - &reftitle.parameters; - - - req_identifier - Request identifier. - - - timeout - - Timeout time in milliseconds. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - cubrid_get_query_timeout - - - - diff --git a/reference/cubrid/functions/cubrid-version.xml b/reference/cubrid/functions/cubrid-version.xml deleted file mode 100644 index b0ddb26615a3..000000000000 --- a/reference/cubrid/functions/cubrid-version.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - cubrid_version - Get the CUBRID PHP module's version - - - - &reftitle.description; - - stringcubrid_version - - - - The cubrid_version function is used to get the CUBRID - PHP module's version. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Version information (eg. "8.3.1.0001"). - - - - - &reftitle.examples; - - <function>cubrid_version</function> example - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_error_code - cubrid_error_code_facility - - - - - - diff --git a/reference/cubrid/oldaliases/cubrid-load-from-glo.xml b/reference/cubrid/oldaliases/cubrid-load-from-glo.xml deleted file mode 100644 index 19f93760840a..000000000000 --- a/reference/cubrid/oldaliases/cubrid-load-from-glo.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - cubrid_load_from_glo - Read data from a GLO instance and save it in a file - - - - &reftitle.description; - - intcubrid_load_from_glo - resourceconn_identifier - stringoid - stringfile_name - - - The cubrid_load_from_glo function is used to read a - data from a glo instance, and saves it in a designated file. - - - - - &reftitle.parameters; - - - conn_identifier - Connection identifier. - - - oid - Oid of the glo instance that you want to read the data from. - - - file_name - Name of the file where you want to save the data in. - - - - - - &reftitle.returnvalues; - - &true;, when process is successful. - - - &false;, when process is unsuccessful. - - - - - &reftitle.examples; - - <function>cubrid_load_from_glo</function> example - - -]]> - - - - - - &reftitle.notes; - - - &info.deprecated.alias; - cubrid_load_from_glo - - - - - This function is removed from CUBRID 3.1. - - - - - - &reftitle.seealso; - - cubrid_new_glo - cubrid_save_to_glo - cubrid_send_glo - - - - - diff --git a/reference/cubrid/oldaliases/cubrid-new-glo.xml b/reference/cubrid/oldaliases/cubrid-new-glo.xml deleted file mode 100644 index 176a5d1befb8..000000000000 --- a/reference/cubrid/oldaliases/cubrid-new-glo.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - cubrid_new_glo - Create a glo instance - - - - &reftitle.description; - - stringcubrid_new_glo - resourceconn_identifier - stringclass_name - stringfile_name - - - The cubrid_new_glo function is used to create a glo instance in the requested class (glo class). The glo created is a LO type, and is stored in the file_name file. - - - - - &reftitle.parameters; - - - conn_identifier - Connection identifier. - - - class_name - Name of the class that you want to create a glo in. - - - file_name - The file name that you want to save in the newly created glo. - - - - - - &reftitle.returnvalues; - - Oid of the instance created, when process is successful. - - - &false;, when process is unsuccessful. - - - - - &reftitle.examples; - - <function>cubrid_new_glo</function> example - - -]]> - - - - - - &reftitle.notes; - - - &info.deprecated.alias; - cubrid_new_glo - - - - - This function is removed from CUBRID 3.1. - - - - - - &reftitle.seealso; - - cubrid_save_to_glo - cubrid_load_from_glo - cubrid_send_glo - - - - - diff --git a/reference/cubrid/oldaliases/cubrid-save-to-glo.xml b/reference/cubrid/oldaliases/cubrid-save-to-glo.xml deleted file mode 100644 index d9ccfff66a61..000000000000 --- a/reference/cubrid/oldaliases/cubrid-save-to-glo.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - cubrid_save_to_glo - Save requested file in a GLO instance - - - - &reftitle.description; - - intcubrid_save_to_glo - resourceconn_identifier - stringoid - stringfile_name - - - The cubrid_save_to_glo function is used to save requested file in a glo instance. - - - - - &reftitle.parameters; - - - conn_identifier - Connection identifier. - - - oid - Oid of the glo instance that you want to save a file in. - - - file_name - The name of the file that you want to save. - - - - - - &reftitle.returnvalues; - - &true;, when process is successful. - - - &false;, when process is unsuccessful. - - - - - &reftitle.examples; - - <function>cubrid_save_to_glo</function> example - - -]]> - - - - - - &reftitle.notes; - - - &info.deprecated.alias; - cubrid_save_to_glo - - - - - This function is removed from CUBRID 3.1. - - - - - - &reftitle.seealso; - - cubrid_new_glo - cubrid_load_from_glo - cubrid_send_glo - - - - - diff --git a/reference/cubrid/oldaliases/cubrid-send-glo.xml b/reference/cubrid/oldaliases/cubrid-send-glo.xml deleted file mode 100644 index 9ecce71bf440..000000000000 --- a/reference/cubrid/oldaliases/cubrid-send-glo.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - cubrid_send_glo - Read data from glo and send it to std output - - - - &reftitle.description; - - intcubrid_send_glo - resourceconn_identifier - stringoid - - - The cubrid_send_glo function is used to read data from glo instance and sends it to the PHP standard output. - - - - - &reftitle.parameters; - - - conn_identifier - Connection identifier. - - - oid - Oid of the glo instance that you want to read data from. - - - - - - &reftitle.returnvalues; - - &true;, when process is successful. - - - &false;, when process is unsuccessful. - - - - - &reftitle.examples; - - <function>cubrid_send_glo</function> example - - -]]> - - - - - - &reftitle.notes; - - - &info.deprecated.alias; - cubrid_send_glo - - - - - This function is removed from CUBRID 3.1. - - - - - - &reftitle.seealso; - - cubrid_new_glo - cubrid_save_to_glo - cubrid_load_from_glo - - - - - diff --git a/reference/cubrid/reference.xml b/reference/cubrid/reference.xml deleted file mode 100644 index 33fee516325d..000000000000 --- a/reference/cubrid/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - CUBRID &Functions; - - &reference.cubrid.entities.functions; - - - - diff --git a/reference/cubrid/setup.xml b/reference/cubrid/setup.xml deleted file mode 100644 index bce5962b35de..000000000000 --- a/reference/cubrid/setup.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - &reftitle.setup; - -
- &reftitle.required; - - In order to have these functions available, you must install CUBRID, and compile CUBRID PHP Library with CUBRID support. - -
- - &reference.cubrid.configure; - -
- &reftitle.runtime; - - There is no runtime configuration now. - -
- -
- &reftitle.resources; - - There are four resource types used in CUBRID. The first one is the link - identifier for a database connection, the second is the resource which - holds the result of a query, and the last two a resource which holds the - query results of BLOB/CLOB data types. - -
- connection identifier - - A connection identifier returned by cubrid_connect, - cubrid_connect_with_url, - cubrid_pconnect and - cubrid_pconnect_with_url. - -
-
- request identifier - - A request identifier returned by cubrid_prepare and cubrid_execute. - -
-
- LOB identifier - - A LOB identifier returned by cubrid_lob_get. - -
-
- LOB2 identifier - - A LOB identifier returned by cubrid_lob2_new or get - from the result set. - -
- -
- -
- diff --git a/reference/cubrid/versions.xml b/reference/cubrid/versions.xml deleted file mode 100644 index 5f36e4e9505a..000000000000 --- a/reference/cubrid/versions.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/dbase/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/dbase/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/dbase/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/dbase/book.xml b/reference/dbase/book.xml deleted file mode 100644 index 4ec110cf4032..000000000000 --- a/reference/dbase/book.xml +++ /dev/null @@ -1,162 +0,0 @@ - - - - - - dBase - - - - &reftitle.intro; - - - &pecl.moved-ver;5.3.0. - - - - These functions allow you to access records stored in dBase-format - (dbf) databases. - - - - We recommend against using dBase files as your production - database. Use SQLite or choose any real SQL server instead; MySQL or Postgres - are common choices with PHP. dBase support is here to allow you to - import and export data to and from your web database, because the - file format is commonly understood by Windows spreadsheets and - organizers. - - - - - As of dbase 7.0.0 the databases are automatically locked via - flock. There has been no support for locking earlier, - so two concurrent web server processes modifying the same dBase file would - have very likely ruined your database. This can happen even with dbase - 7.0.0+ on systems which implement the locks at the process level with - multithreaded SAPIs. - - - - dBase files are simple sequential files of fixed length records. - Records are appended to the end of the file and deleted records are - kept until you call dbase_pack. - - - Only dbf file levels 3 (dBASE III+) - 5 (dBASE V) are supported. - The types of dBase fields available are: - - Available types of fields - - - - Field - dBase Type - Format - Additional information - - - - - M - Memo - n/a - This type is not supported by PHP, such field will be ignored - - - D - Date - YYYYMMDD - The field length is limited to 8 - - - T - DateTime - YYYYMMDDhhmmss.uuu - (FoxPro) No validity checks are done. Available as of dbase 7.0.0. - - - N - Number - A number - - You must declare a length and a precision (the number of digits - after the decimal point). - - - - F - Float - A float number - Same as N. - - - C - String - A string - You must declare a length. When retrieving data, the string - will be right-padded with spaces to fit the declared length. Overlong - strings will be silently truncated when storing data. - - - L - Boolean - - T or Y for &true;, - F or N for &false;, - ? for uninitialized. - - - As of dbase 7.0.0, returned as a bool (&true; or &false;), - or &null; for uninitialized fields. - Formerly, returned as an int (1 or 0). - - - - -
-
- - - As of dbase 7.0.0 nullable fields are supported for - DBASE_TYPE_FOXPRO databases. If a field is nullable, - passing &null; will set the respective flag, and on later retrieval the field - value will be &null;. - - - - - There is no support for indexes or memo fields. - - -
- - - &reference.dbase.setup; - &reference.dbase.constants; - &reference.dbase.reference; - -
- - - diff --git a/reference/dbase/configure.xml b/reference/dbase/configure.xml deleted file mode 100644 index 50dd3a3bd1c0..000000000000 --- a/reference/dbase/configure.xml +++ /dev/null @@ -1,30 +0,0 @@ - - -
- &reftitle.install; - - &pecl.info; - &url.pecl.package;dbase. - -
- - diff --git a/reference/dbase/constants.xml b/reference/dbase/constants.xml deleted file mode 100644 index e8d2275ef393..000000000000 --- a/reference/dbase/constants.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - - - DBASE_VERSION - (string) - - - - The extension version. - (Available as of dbase 7.0.0) - - - - - - DBASE_RDONLY - (int) - - - - Open database for reading only. Used with dbase_open. - (Available as of dbase 7.0.0) - - - - - - DBASE_RDWR - (int) - - - - Open database for reading and writing. Used with dbase_open. - (Available as of dbase 7.0.0) - - - - - - DBASE_TYPE_DBASE - (int) - - - - Create dBASE style database. Used with dbase_create. - (Available as of dbase 7.0.0) - - - - - - DBASE_TYPE_FOXPRO - (int) - - - - Create FoxPro style database. Used with dbase_create. - (Available as of dbase 7.0.0) - - - - - - - - diff --git a/reference/dbase/functions/dbase-add-record.xml b/reference/dbase/functions/dbase-add-record.xml deleted file mode 100644 index 2e3727b6afc4..000000000000 --- a/reference/dbase/functions/dbase-add-record.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - dbase_add_record - Adds a record to a database - - - &reftitle.description; - - booldbase_add_record - resourcedatabase - arraydata - - - Adds the given data to the database. - - - - &reftitle.parameters; - - - - database - - - The database resource, returned by dbase_open - or dbase_create. - - - - - data - - - An indexed array of data. The number of items must be equal to the number of - fields in the database, otherwise dbase_add_record - will fail. - - - - If you're using dbase_get_record return value for this - parameter, remember to reset the key named deleted. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL dbase 7.0.0 - - database is now a resource - instead of an int. - - - - - - - - - &reftitle.examples; - - - Inserting a record in a dBase database - - -]]> - - - - - - &reftitle.seealso; - - - dbase_delete_record - dbase_replace_record - - - - - - diff --git a/reference/dbase/functions/dbase-close.xml b/reference/dbase/functions/dbase-close.xml deleted file mode 100644 index d34a26ede123..000000000000 --- a/reference/dbase/functions/dbase-close.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - dbase_close - Closes a database - - - &reftitle.description; - - booldbase_close - resourcedatabase - - - Closes the given database resource. - - - - &reftitle.parameters; - - - - database - - - The database resource, returned by dbase_open - or dbase_create. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL dbase 7.0.0 - - database is now a resource - instead of an int. - - - - - - - - - &reftitle.examples; - - - Closing a dBase database file - - -]]> - - - - - - &reftitle.seealso; - - - dbase_open - dbase_create - - - - - - diff --git a/reference/dbase/functions/dbase-create.xml b/reference/dbase/functions/dbase-create.xml deleted file mode 100644 index c2a0b102d1d7..000000000000 --- a/reference/dbase/functions/dbase-create.xml +++ /dev/null @@ -1,163 +0,0 @@ - - - - - dbase_create - Creates a database - - - &reftitle.description; - - resourcedbase_create - stringpath - arrayfields - inttypeDBASE_TYPE_DBASE - - - dbase_create creates a dBase database with the given - definition. - If the file already exists, it is not truncated. - dbase_pack can be called to force truncation. - - ¬e.open-basedir.func; - - - &reftitle.parameters; - - - - path - - - The path of the database. It can be a relative or absolute path to - the file where dBase will store your data. - - - - - fields - - - An array of arrays, each array describing the format of one field of the - database. Each field consists of a name, a character indicating the field - type, and optionally, a length, a precision and a nullable flag. - The supported field types are listed in the introduction section. - - - - The fieldnames are limited in length and must not exceed 10 chars. - - - - - - type - - - The type of database to be created. Either - DBASE_TYPE_DBASE or - DBASE_TYPE_FOXPRO. - - - - - - - - &reftitle.returnvalues; - - Returns a database resource if the database is successfully created, - or &false; if an error occurred. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL dbase 7.0.0 - - The type parameter has been added. - - - - PECL dbase 7.0.0 - - The return value is now a resource instead of an - int. - - - - - - - - - &reftitle.examples; - - - Creating a dBase database file - - -]]> - - - - - - &reftitle.seealso; - - - dbase_open - dbase_close - - - - - - diff --git a/reference/dbase/functions/dbase-delete-record.xml b/reference/dbase/functions/dbase-delete-record.xml deleted file mode 100644 index f182afc525f4..000000000000 --- a/reference/dbase/functions/dbase-delete-record.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - dbase_delete_record - Deletes a record from a database - - - &reftitle.description; - - booldbase_delete_record - resourcedatabase - intnumber - - - Marks the given record to be deleted from the database. - - - - To actually remove the record from the database, you must also call - dbase_pack. - - - - - &reftitle.parameters; - - - - database - - - The database resource, returned by dbase_open - or dbase_create. - - - - - number - - - An integer which spans from 1 to the number of records in the database - (as returned by dbase_numrecords). - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL dbase 7.0.0 - - database is now a resource - instead of an int. - - - - - - - - - &reftitle.seealso; - - - dbase_add_record - dbase_replace_record - - - - - - diff --git a/reference/dbase/functions/dbase-get-header-info.xml b/reference/dbase/functions/dbase-get-header-info.xml deleted file mode 100644 index 727276fa955c..000000000000 --- a/reference/dbase/functions/dbase-get-header-info.xml +++ /dev/null @@ -1,172 +0,0 @@ - - - - - dbase_get_header_info - Gets the header info of a database - - - &reftitle.description; - - arraydbase_get_header_info - resourcedatabase - - - Returns information on the column structure of the given database resource. - - - - &reftitle.parameters; - - - - database - - - The database resource, returned by dbase_open - or dbase_create. - - - - - - - - &reftitle.returnvalues; - - An indexed array with an entry for each column in the database. The array index - starts at 0. - - - Each array element contains an associative array of column information, as - described here: - - - name - - - The name of the column - - - - - type - - - The human-readable name for the dbase type of the column (i.e. date, - boolean, etc.) - The supported field types are listed in the introduction section. - - - - - length - - - The number of bytes this column can hold - - - - - precision - - - The number of digits of decimal precision for the column - - - - - format - - - A suggested printf format specifier for the column - - - - - offset - - - The byte offset of the column from the start of the row - - - - - - - If the database header information cannot be read, &false; is returned. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL dbase 7.0.0 - - database is now a resource - instead of an int. - - - - - - - - - &reftitle.examples; - - - Showing header information for a dBase database file - - -]]> - - - - - - - diff --git a/reference/dbase/functions/dbase-get-record-with-names.xml b/reference/dbase/functions/dbase-get-record-with-names.xml deleted file mode 100644 index 4a09d0a58a9a..000000000000 --- a/reference/dbase/functions/dbase-get-record-with-names.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - dbase_get_record_with_names - - Gets a record from a database as an associative array - - - - &reftitle.description; - - arraydbase_get_record_with_names - resourcedatabase - intnumber - - - Gets a record from a dBase database as an associative array. - - - - &reftitle.parameters; - - - - database - - - The database resource, returned by dbase_open - or dbase_create. - - - - - number - - - The index of the record between 1 and - dbase_numrecords($dbase_identifier). - - - - - - - - &reftitle.returnvalues; - - An associative array with the record. This will also include a key named - deleted which is set to 1 if the record has been marked - for deletion (see dbase_delete_record). - Therefore it is not possible to retrieve the value of a field named - deleted with this function. - - &dbase.type-conversion; - - On error, dbase_get_record_with_names will return &false;. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL dbase 7.0.0 - - database is now a resource - instead of an int. - - - - - - - - - &reftitle.examples; - - - Listing all the registered members in the database - - -]]> - - - - - - &reftitle.seealso; - - - dbase_get_record - - - - - - diff --git a/reference/dbase/functions/dbase-get-record.xml b/reference/dbase/functions/dbase-get-record.xml deleted file mode 100644 index 8eeb77f96a6e..000000000000 --- a/reference/dbase/functions/dbase-get-record.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - dbase_get_record - - Gets a record from a database as an indexed array - - - - &reftitle.description; - - arraydbase_get_record - resourcedatabase - intnumber - - - Gets a record from a database as an indexed array. - - - - &reftitle.parameters; - - - - database - - - The database resource, returned by dbase_open - or dbase_create. - - - - - number - - - The index of the record between 1 and - dbase_numrecords($dbase_identifier). - - - - - - - - &reftitle.returnvalues; - - An indexed array with the record. This array will also include an associative - key named deleted which is set to 1 if the record has been - marked for deletion (see dbase_delete_record). - - &dbase.type-conversion; - - On error, dbase_get_record will return &false;. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL dbase 7.0.0 - - database is now a resource - instead of an int. - - - - - - - - - &reftitle.seealso; - - - dbase_get_record_with_names - - - - - - diff --git a/reference/dbase/functions/dbase-numfields.xml b/reference/dbase/functions/dbase-numfields.xml deleted file mode 100644 index dea9110acfd8..000000000000 --- a/reference/dbase/functions/dbase-numfields.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - dbase_numfields - Gets the number of fields of a database - - - &reftitle.description; - - intdbase_numfields - resourcedatabase - - - Gets the number of fields (columns) in the specified database. - - - - Field numbers are between 0 and dbase_numfields($db)-1, - while record numbers are between 1 and dbase_numrecords($db). - - - - - &reftitle.parameters; - - - - database - - - The database resource, returned by dbase_open - or dbase_create. - - - - - - - - &reftitle.returnvalues; - - The number of fields in the database, or &false; if an error occurs. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL dbase 7.0.0 - - database is now a resource - instead of an int. - - - - - - - - - &reftitle.examples; - - - <function>dbase_numfields</function> Example - - -]]> - - - - - - &reftitle.seealso; - - - dbase_numrecords - - - - - - diff --git a/reference/dbase/functions/dbase-numrecords.xml b/reference/dbase/functions/dbase-numrecords.xml deleted file mode 100644 index dd06db7be052..000000000000 --- a/reference/dbase/functions/dbase-numrecords.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - dbase_numrecords - Gets the number of records in a database - - - &reftitle.description; - - intdbase_numrecords - resourcedatabase - - - Gets the number of records (rows) in the specified database. - - - - Records which are marked as deleted are counted as well. - - - - - Record numbers are between 1 and dbase_numrecords($db), - while field numbers are between 0 and dbase_numfields($db)-1. - - - - - &reftitle.parameters; - - - - database - - - The database resource, returned by dbase_open - or dbase_create. - - - - - - - - &reftitle.returnvalues; - - The number of records in the database, or &false; if an error occurs. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL dbase 7.0.0 - - database is now a resource - instead of an int. - - - - - - - - - &reftitle.examples; - - - Looping over all the records of the database - - -]]> - - - - - - &reftitle.seealso; - - - dbase_numfields - - - - - - diff --git a/reference/dbase/functions/dbase-open.xml b/reference/dbase/functions/dbase-open.xml deleted file mode 100644 index d1a2277b009e..000000000000 --- a/reference/dbase/functions/dbase-open.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - dbase_open - Opens a database - - - &reftitle.description; - - resourcefalsedbase_open - stringpath - intmode - - - dbase_open opens a dBase database with the given - access mode. - - ¬e.open-basedir.func; - - - &reftitle.parameters; - - - - path - - - The path of the database. It can be a relative or absolute path to - the file where dBase will store your data. - - - - - mode - - - An integer which correspond to those for the open() - system call (Typically 0 means read-only, 1 means write-only, and 2 - means read and write). - - - - You can't open a dBase file in write-only mode as the function will - fail to read the headers information and thus you can't use 1 as - mode. - - - - As of dbase 7.0.0 you can use DBASE_RDONLY - and DBASE_RDWR, respectively, to specify the - mode. - - - - - - - - - &reftitle.returnvalues; - - Returns a database resource on success, &return.falseforfailure;. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL dbase 7.0.0 - - The return value is now a resource instead of an - int. - - - - - - - - - &reftitle.examples; - - - Opening a dBase database file - - -]]> - - - - - - - &reftitle.seealso; - - - dbase_create - dbase_close - - - - - - diff --git a/reference/dbase/functions/dbase-pack.xml b/reference/dbase/functions/dbase-pack.xml deleted file mode 100644 index 7b0ef21cb209..000000000000 --- a/reference/dbase/functions/dbase-pack.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - dbase_pack - Packs a database - - - &reftitle.description; - - booldbase_pack - resourcedatabase - - - Packs the specified database by permanently deleting all records marked - for deletion using dbase_delete_record. - Note that the file will be truncated after successful packing (contrary to - dBASE III's PACK command). - - - - &reftitle.parameters; - - - - database - - - The database resource, returned by dbase_open - or dbase_create. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL dbase 7.0.0 - - database is now a resource - instead of an int. - - - - - - - - - &reftitle.examples; - - - Emptying a dBase database - - -]]> - - - - - - &reftitle.seealso; - - - dbase_delete_record - - - - - - diff --git a/reference/dbase/functions/dbase-replace-record.xml b/reference/dbase/functions/dbase-replace-record.xml deleted file mode 100644 index 6fd18f56891d..000000000000 --- a/reference/dbase/functions/dbase-replace-record.xml +++ /dev/null @@ -1,172 +0,0 @@ - - - - - dbase_replace_record - Replaces a record in a database - - - &reftitle.description; - - booldbase_replace_record - resourcedatabase - arraydata - intnumber - - - Replaces the given record in the database with the given data. - - - - &reftitle.parameters; - - - - database - - - The database resource, returned by dbase_open - or dbase_create. - - - - - data - - - An indexed array of data. The number of items must be equal to the - number of fields in the database, otherwise - dbase_replace_record will fail. - - - - If you're using dbase_get_record return value for this - parameter, remember to reset the key named deleted. - - - - - - number - - - An integer which spans from 1 to the number of records in the database - (as returned by dbase_numrecords). - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL dbase 7.0.0 - - database is now a resource - instead of an int. - - - - - - - - - &reftitle.examples; - - - Updating a record in the database - - -]]> - - - - - - - &reftitle.notes; - - - Boolean fields result in an int element value - (0 or 1) when retrieved via - dbase_get_record or - dbase_get_record_with_names. If they are written back, - this results in the value becoming 0, so care has to be - taken to properly adjust the values. - - - - - - &reftitle.seealso; - - - dbase_add_record - dbase_delete_record - - - - - - diff --git a/reference/dbase/reference.xml b/reference/dbase/reference.xml deleted file mode 100644 index c65b48a54c92..000000000000 --- a/reference/dbase/reference.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - dBase &Functions; - - -
- &reftitle.examples; - - Many examples in this reference require a dBase database. We will use - /tmp/test.dbf that will be created in the example of - dbase_create. - -
- -
- -&reference.dbase.entities.functions; - -
- - diff --git a/reference/dbase/setup.xml b/reference/dbase/setup.xml deleted file mode 100644 index 47b5c33b6168..000000000000 --- a/reference/dbase/setup.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - &reftitle.setup; - - - &reference.dbase.configure; - - - -
- &reftitle.resources; - - As of dbase 7.0.0, the resource type dbase is defined, - which is returned by dbase_open and - dbase_create. - -
- - -
- - - diff --git a/reference/dbase/versions.xml b/reference/dbase/versions.xml deleted file mode 100644 index 5e70c5301ab9..000000000000 --- a/reference/dbase/versions.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - - - - - - - - - - - - - - - diff --git a/reference/dio/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/dio/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/dio/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/dio/book.xml b/reference/dio/book.xml deleted file mode 100644 index 07c04ac32305..000000000000 --- a/reference/dio/book.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - Direct IO - - - - &reftitle.intro; - - PHP supports the direct io functions as described in the Posix - Standard (Section 6) for performing I/O functions at a lower - level than the C-Language stream I/O functions - (fopen, fread,..). The use - of the DIO functions should be considered only when direct - control of a device is needed. In all other cases, the standard - filesystem functions are more - than adequate. - - - - - &reference.dio.setup; - &reference.dio.constants; - &reference.dio.reference; - - - - - diff --git a/reference/dio/configure.xml b/reference/dio/configure.xml deleted file mode 100644 index 80064e8d1d81..000000000000 --- a/reference/dio/configure.xml +++ /dev/null @@ -1,33 +0,0 @@ - - -
- &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;dio. - -
- - diff --git a/reference/dio/constants.xml b/reference/dio/constants.xml deleted file mode 100644 index 0626639d50d1..000000000000 --- a/reference/dio/constants.xml +++ /dev/null @@ -1,353 +0,0 @@ - - - - &reftitle.constants; - &extension.constants; - - - - F_DUPFD - (int) - - - - - - - - F_GETFD - (int) - - - - - - - - F_GETFL - (int) - - - - - - - - F_GETLK - (int) - - - - - - - - F_GETOWN - (int) - - - - - - - - F_RDLCK - (int) - - - - - - - - F_SETFL - (int) - - - - - - - - F_SETLK - (int) - - - - - - - - F_SETLKW - (int) - - - - - - - - F_SETOWN - (int) - - - - - - - - F_UNLCK - (int) - - - - - - - - F_WRLCK - (int) - - - - - - - - O_APPEND - (int) - - - - - - - - O_ASYNC - (int) - - - - - - - - O_CREAT - (int) - - - - - - - - O_EXCL - (int) - - - - - - - - O_NDELAY - (int) - - - - - - - - O_NOCTTY - (int) - - - - - - - - O_NONBLOCK - (int) - - - - - - - - O_RDONLY - (int) - - - - - - - - O_RDWR - (int) - - - - - - - - O_SYNC - (int) - - - - - - - - O_TRUNC - (int) - - - - - - - - O_WRONLY - (int) - - - - - - - - S_IRGRP - (int) - - - - - - - - S_IROTH - (int) - - - - - - - - S_IRUSR - (int) - - - - - - - - S_IRWXG - (int) - - - - - - - - S_IRWXO - (int) - - - - - - - - S_IRWXU - (int) - - - - - - - - S_IWGRP - (int) - - - - - - - - S_IWOTH - (int) - - - - - - - - S_IWUSR - (int) - - - - - - - - S_IXGRP - (int) - - - - - - - - S_IXOTH - (int) - - - - - - - - S_IXUSR - (int) - - - - - - - - - diff --git a/reference/dio/functions/dio-close.xml b/reference/dio/functions/dio-close.xml deleted file mode 100644 index de19f640f815..000000000000 --- a/reference/dio/functions/dio-close.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - dio_close - Closes the file descriptor given by fd - - - &reftitle.description; - - voiddio_close - resourcefd - - - The function dio_close closes the file descriptor - fd. - - - - &reftitle.parameters; - - - - fd - - - The file descriptor returned by dio_open. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.examples; - - - Closing an open file descriptor - - -]]> - - - - - - &reftitle.seealso; - - - dio_open - - - - - - diff --git a/reference/dio/functions/dio-fcntl.xml b/reference/dio/functions/dio-fcntl.xml deleted file mode 100644 index 74c60f5520a5..000000000000 --- a/reference/dio/functions/dio-fcntl.xml +++ /dev/null @@ -1,182 +0,0 @@ - - - - - dio_fcntl - Performs a c library fcntl on fd - - - &reftitle.description; - - mixeddio_fcntl - resourcefd - intcmd - mixedargs - - - The dio_fcntl function performs the - operation specified by cmd on the file - descriptor fd. Some commands require - additional arguments args to be supplied. - - - - &reftitle.parameters; - - - - fd - - - The file descriptor returned by dio_open. - - - - - cmd - - - Can be one of the following operations: - - - - F_SETLK - Lock is set or cleared. If the lock - is held by someone else dio_fcntl returns - -1. - - - - - F_SETLKW - like F_SETLK, - but in case the lock is held by someone else, - dio_fcntl waits until the lock is released. - - - - - F_GETLK - dio_fcntl - returns an associative array (as described below) if someone else - prevents lock. If there is no obstruction key "type" will set - to F_UNLCK. - - - - - F_DUPFD - finds the lowest numbered available - file descriptor greater than or equal to args - and returns them. - - - - - F_SETFL - Sets the file descriptors flags to - the value specified by args, which can be - O_APPEND, O_NONBLOCK or - O_ASYNC. To use O_ASYNC - you will need to use the PCNTL - extension. - - - - - - - - args - - - args is an associative array, when - cmd is F_SETLK or - F_SETLKW, with the following keys: - - - - start - offset where lock begins - - - - - length - size of locked area. zero means to end - of file - - - - - whence - Where l_start is relative to: can be - SEEK_SET, - SEEK_END and SEEK_CUR - - - - - type - type of lock: can be - F_RDLCK (read lock), - F_WRLCK (write lock) or - F_UNLCK (unlock) - - - - - - - - - - - &reftitle.returnvalues; - - Returns the result of the C call. - - - - &reftitle.examples; - - - Setting and clearing a lock - -F_WRLCK)) == -1) { - // the file descriptor appears locked - echo "The lock can not be cleared. It is held by someone else."; -} else { - echo "Lock successfully set/cleared"; -} - -dio_close($fd); -?> -]]> - - - - - - - &reftitle.notes; - ¬e.no-windows; - - - - diff --git a/reference/dio/functions/dio-open.xml b/reference/dio/functions/dio-open.xml deleted file mode 100644 index 5738b9bd974c..000000000000 --- a/reference/dio/functions/dio-open.xml +++ /dev/null @@ -1,177 +0,0 @@ - - - - - dio_open - - Opens a file (creating it if necessary) at a lower level than the - C library input/output stream functions allow - - - - &reftitle.description; - - resourcedio_open - stringfilename - intflags - intmode0 - - - dio_open opens a file and returns a new file - descriptor for it. - - - - &reftitle.parameters; - - - - filename - - - The pathname of the file to open. - - - - - flags - - - The flags parameter is a bitwise-ORed - value comprising flags from the following list. This value - must include one of - O_RDONLY, O_WRONLY, - or O_RDWR. Additionally, it may include - any combination of the other flags from this list. - - - - O_RDONLY - opens the file for read access. - - - - - O_WRONLY - opens the file for write access. - - - - - O_RDWR - opens the file for both reading and - writing. - - - - - O_CREAT - creates the file, if it doesn't - already exist. - - - - - O_EXCL - if both O_CREAT - and O_EXCL are set and the file already - exists, dio_open will fail. - - - - - O_TRUNC - if the file exists and is opened - for write access, the file will be truncated to zero length. - - - - - O_APPEND - write operations write data at the - end of the file. - - - - - O_NONBLOCK - sets non blocking mode. - - - - - O_NOCTTY - prevent the OS from - assigning the opened file as the process's controlling - terminal when opening a TTY device file. - - - - - - - - mode - - - If flags contains - O_CREAT, mode will - set the permissions of the file (creation - permissions). mode is required for - correct operation when O_CREAT is - specified in flags and is ignored - otherwise. - - - The actual permissions assigned to the created file will be - affected by the process's umask setting as - per usual. - - - - - - - - &reftitle.returnvalues; - - A file descriptor or &false; on error. - - - - &reftitle.examples; - - Opening a file descriptor - - -]]> - - - - - &reftitle.seealso; - - - dio_close - - - - - - diff --git a/reference/dio/functions/dio-read.xml b/reference/dio/functions/dio-read.xml deleted file mode 100644 index 7b5da60a7c0c..000000000000 --- a/reference/dio/functions/dio-read.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - dio_read - Reads bytes from a file descriptor - - - &reftitle.description; - - stringdio_read - resourcefd - intlen1024 - - - The function dio_read reads and returns - len bytes from file with descriptor - fd. - - - - &reftitle.parameters; - - - - fd - - - The file descriptor returned by dio_open. - - - - - len - - - The number of bytes to read. If not specified, - dio_read reads 1K sized block. - - - - - - - - &reftitle.returnvalues; - - The bytes read from fd. - - - - &reftitle.seealso; - - - dio_write - - - - - - diff --git a/reference/dio/functions/dio-seek.xml b/reference/dio/functions/dio-seek.xml deleted file mode 100644 index b7401722eeee..000000000000 --- a/reference/dio/functions/dio-seek.xml +++ /dev/null @@ -1,138 +0,0 @@ - - - - - dio_seek - Seeks to pos on fd from whence - - - &reftitle.description; - - intdio_seek - resourcefd - intpos - intwhenceSEEK_SET - - - The function dio_seek is used to change the - file position of the given file descriptor. - - - - &reftitle.parameters; - - - - fd - - - The file descriptor returned by dio_open. - - - - - pos - - - The new position. - - - - - whence - - - Specifies how the position pos should be - interpreted: - - - - SEEK_SET (default) - specifies that - pos is specified from the beginning of the - file. - - - - - SEEK_CUR - Specifies that - pos is a count of characters from the current - file position. This count may be positive or negative. - - - - - SEEK_END - Specifies that - pos is a count of characters from the end of - the file. A negative count specifies a position within the current - extent of the file; a positive count specifies a position past the - current end. If you set the position past the current end, and - actually write data, you will extend the file with zeros up to that - position. - - - - - - - - - - - &reftitle.returnvalues; - - - - - &reftitle.examples; - - - Positioning in a file - - -]]> - - - - - - - diff --git a/reference/dio/functions/dio-stat.xml b/reference/dio/functions/dio-stat.xml deleted file mode 100644 index ec71b73727e0..000000000000 --- a/reference/dio/functions/dio-stat.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - dio_stat - - Gets stat information about the file descriptor fd - - - - &reftitle.description; - - arraydio_stat - resourcefd - - - dio_stat returns information about the given file - descriptor. - - - - &reftitle.parameters; - - - - fd - - - The file descriptor returned by dio_open. - - - - - - - - &reftitle.returnvalues; - - Returns an associative array with the following keys: - - - - "device" - device - - - - - "inode" - inode - - - - - "mode" - mode - - - - - "nlink" - number of hard links - - - - - "uid" - user id - - - - - "gid" - group id - - - - - "device_type" - device type (if inode device) - - - - - "size" - total size in bytes - - - - - "blocksize" - blocksize - - - - - "blocks" - number of blocks allocated - - - - - "atime" - time of last access - - - - - "mtime" - time of last modification - - - - - "ctime" - time of last change - - - - On error dio_stat returns &null;. - - - - - diff --git a/reference/dio/functions/dio-tcsetattr.xml b/reference/dio/functions/dio-tcsetattr.xml deleted file mode 100644 index f89a453d2f93..000000000000 --- a/reference/dio/functions/dio-tcsetattr.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - dio_tcsetattr - - Sets terminal attributes and baud rate for a serial port - - - - &reftitle.description; - - booldio_tcsetattr - resourcefd - arrayoptions - - - dio_tcsetattr sets the terminal attributes and baud - rate of the open fd. - - - - &reftitle.parameters; - - - - fd - - - The file descriptor returned by dio_open. - - - - - options - - - The currently available options are: - - - - 'baud' - baud rate of the port - can be 38400,19200,9600,4800,2400,1800, - 1200,600,300,200,150,134,110,75 or 50, default value is 9600. - - - - - 'bits' - data bits - can be 8,7,6 or 5. Default value is 8. - - - - - 'stop' - stop bits - can be 1 or 2. Default value is 1. - - - - - 'parity' - can be 0,1 or 2. Default value is 0. - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.examples; - - Setting the baud rate on a serial port - - 9600, - 'bits' => 8, - 'stop' => 1, - 'parity' => 0 -)); - -while (true) { - $data = dio_read($fd, 256); - if ($data !== null && $data !== '') { - echo $data; - } -} - -?> -]]> - - - - - - &reftitle.notes; - ¬e.no-windows; - - - diff --git a/reference/dio/functions/dio-truncate.xml b/reference/dio/functions/dio-truncate.xml deleted file mode 100644 index 092263246c18..000000000000 --- a/reference/dio/functions/dio-truncate.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - dio_truncate - - Truncates file descriptor fd to offset bytes - - - - &reftitle.description; - - booldio_truncate - resourcefd - intoffset - - - dio_truncate truncates a file to at most - offset bytes in size. - - - If the file previously was larger than this size, the extra data is - lost. If the file previously was shorter, it is unspecified whether the - file is left unchanged or is extended. In the latter case the extended - part reads as zero bytes. - - - - &reftitle.parameters; - - - - fd - - - The file descriptor returned by dio_open. - - - - - offset - - - The offset in bytes. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.notes; - ¬e.no-windows; - - - - diff --git a/reference/dio/functions/dio-write.xml b/reference/dio/functions/dio-write.xml deleted file mode 100644 index 5d579e3fb837..000000000000 --- a/reference/dio/functions/dio-write.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - dio_write - - Writes data to fd with optional truncation at length - - - - &reftitle.description; - - intdio_write - resourcefd - stringdata - intlen0 - - - dio_write writes up to len - bytes from data to file fd. - - - - &reftitle.parameters; - - - - fd - - - The file descriptor returned by dio_open. - - - - - data - - - The written data. - - - - - len - - - The length of data to write in bytes. If not specified, the - function writes all the data to the specified file. - - - - - - - - &reftitle.returnvalues; - - Returns the number of bytes written to fd. - - - - &reftitle.seealso; - - - dio_read - - - - - - diff --git a/reference/dio/reference.xml b/reference/dio/reference.xml deleted file mode 100644 index f61fe3fcd136..000000000000 --- a/reference/dio/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - Direct IO &Functions; - - &reference.dio.entities.functions; - - - - diff --git a/reference/dio/setup.xml b/reference/dio/setup.xml deleted file mode 100644 index 5f843158f4b8..000000000000 --- a/reference/dio/setup.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - &reftitle.setup; - - - &reference.dio.configure; - - - -
- &reftitle.resources; - - One resource type is defined by this extension: - a file descriptor returned by dio_open. - -
- - -
- - - diff --git a/reference/dio/versions.xml b/reference/dio/versions.xml deleted file mode 100644 index 7216f1279548..000000000000 --- a/reference/dio/versions.xml +++ /dev/null @@ -1,35 +0,0 @@ - - - - - - - - - - - - - - - - diff --git a/reference/ds/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/ds/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/ds/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/ds/book.xml b/reference/ds/book.xml deleted file mode 100644 index 4a6d5f5db18e..000000000000 --- a/reference/ds/book.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Data Structures - - - - &reftitle.intro; - - Efficient data structures for PHP 7, provided as an alternative to the &array;. - - - See this blog post - for benchmarks, discussion and frequently asked questions. - - - - &reference.ds.setup; - &reference.ds.examples; - - &reference.ds.ds.collection; - &reference.ds.ds.hashable; - - &reference.ds.ds.sequence; - &reference.ds.ds.vector; - &reference.ds.ds.deque; - - &reference.ds.ds.map; - &reference.ds.ds.pair; - &reference.ds.ds.set; - &reference.ds.ds.stack; - &reference.ds.ds.queue; - &reference.ds.ds.priorityqueue; - - - - diff --git a/reference/ds/ds.collection.xml b/reference/ds/ds.collection.xml deleted file mode 100644 index 734f2d939222..000000000000 --- a/reference/ds/ds.collection.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - The Collection interface - Ds\Collection - - - -
- &reftitle.intro; - - Collection is the base interface which covers functionality - common to all the data structures in this library. It guarantees that all structures - are traversable, countable, and can be converted to json using json_encode. - -
- -
- &reftitle.interfacesynopsis; - - - Ds\Collection - - - extends - Countable - - - IteratorAggregate - - - JsonSerializable - - - &Methods; - - - &InheritedMethods; - - - - - - -
- -
- &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL ds 1.4.0 - - Collection implements - IteratorAggregate now instead of just Traversable. (This change came to the polyfill in 1.4.1.) - - - - - -
- -
- - &reference.ds.ds.entities.collection; - -
- - diff --git a/reference/ds/ds.deque.xml b/reference/ds/ds.deque.xml deleted file mode 100644 index badebc0db79f..000000000000 --- a/reference/ds/ds.deque.xml +++ /dev/null @@ -1,159 +0,0 @@ - - - - - - The Deque class - Ds\Deque - - - -
- &reftitle.intro; - - A Deque (pronounced “deck”) is a sequence of values - in a contiguous buffer that grows and shrinks automatically. - The name is a common abbreviation of “double-ended queue” and is used - internally by Ds\Queue. - - - Two pointers are used to keep track of a head and a tail. The pointers can - “wrap around” the end of the buffer, which avoids the need to move other - values around to make room. This makes shift and unshift very fast —  - something a Ds\Vector can’t compete with. - - - Accessing a value by index requires a translation between the index and its - corresponding position in the buffer: ((head + position) % capacity). - -
- -
- Strengths - - - Supports array syntax (square brackets). - Uses less overall memory than an &array; for the same number of values. - Automatically frees allocated memory when its size drops low enough. - - get, - set, - push, - pop, - shift, and - unshift are all O(1). - - - -
- -
- Weaknesses - - - Capacity must be a power of 2. - - insert and - remove are O(n). - - - -
- -
- &reftitle.classsynopsis; - - - Ds\Deque - - - - Ds\Deque - - - - Ds\Sequence - - - ArrayAccess - - - - &Constants; - - const - int - Ds\Deque::MIN_CAPACITY - 8 - - - &Methods; - - - -
- -
- &reftitle.constants; - - - - Ds\Deque::MIN_CAPACITY - - - - - - -
- -
- &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL ds 1.3.0 - - The class now implements ArrayAccess. - - - - - - -
- -
- - &reference.ds.ds.entities.deque; - -
- - diff --git a/reference/ds/ds.hashable.xml b/reference/ds/ds.hashable.xml deleted file mode 100644 index 18beecd152ef..000000000000 --- a/reference/ds/ds.hashable.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - The Hashable interface - Ds\Hashable - - - -
- &reftitle.intro; - - Hashable is an interface which allows objects to be used as keys. - It’s an alternative to spl_object_hash, - which determines an object’s hash based on its handle: - this means that two objects that are considered equal by an implicit - definition would not be treated as equal because they are not the same instance. - - - hash is used to return a scalar value to be used as - the object's hash value, which determines where it goes in the hash table. - While this value does not have to be unique, objects which are equal must - have the same hash value. - - - equals is used to determine if two objects are equal. - It's guaranteed that the comparing object will be an instance of the same class - as the subject. - - -
- -
- &reftitle.interfacesynopsis; - - - Ds\Hashable - - &Methods; - - - -
- -
- - &reference.ds.ds.entities.hashable; - -
- - diff --git a/reference/ds/ds.map.xml b/reference/ds/ds.map.xml deleted file mode 100644 index d98861711672..000000000000 --- a/reference/ds/ds.map.xml +++ /dev/null @@ -1,147 +0,0 @@ - - - - - - The Map class - Ds\Map - - - -
- &reftitle.intro; - - A Map is a sequential collection of key-value pairs, almost identical to an - &array; used in a similar context. Keys can be any type, but must be unique. - Values are replaced if added to the map using the same key. - -
- - - -
- Strengths - - - Keys and values can be any type, including objects. - Supports array syntax (square brackets). - Insertion order is preserved. - Performance and memory efficiency is very similar to an &array;. - Automatically frees allocated memory when its size drops low enough. - - -
- -
- Weaknesses - - - Can’t be converted to an array when objects are used as keys. - - -
- - -
- &reftitle.classsynopsis; - - - Ds\Map - - - - Ds\Map - - - - Ds\Collection - - - ArrayAccess - - - - &Constants; - - const - int - Ds\Map::MIN_CAPACITY - 8 - - - &Methods; - - - -
- -
- &reftitle.constants; - - - - Ds\Map::MIN_CAPACITY - - - - - - -
- -
- &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL ds 1.3.0 - - The class now implements ArrayAccess. - - - - PECL ds 1.2.0 - - Ds\Map::MIN_CAPACITY changed from 16 to 8. - - - - - - -
- -
- - &reference.ds.ds.entities.map; - -
- - diff --git a/reference/ds/ds.pair.xml b/reference/ds/ds.pair.xml deleted file mode 100644 index a70f9d8e7b88..000000000000 --- a/reference/ds/ds.pair.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - The Pair class - Ds\Pair - - - -
- &reftitle.intro; - - A pair is used by Ds\Map to pair keys with values. - -
- -
- &reftitle.classsynopsis; - - - Ds\Pair - - - - Ds\Pair - - - - JsonSerializable - - - - &Methods; - - - - -
- -
- - &reference.ds.ds.entities.pair; - -
- - diff --git a/reference/ds/ds.priorityqueue.xml b/reference/ds/ds.priorityqueue.xml deleted file mode 100644 index bc41929b8abd..000000000000 --- a/reference/ds/ds.priorityqueue.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - The PriorityQueue class - Ds\PriorityQueue - - - -
- &reftitle.intro; - - A PriorityQueue is very similar to a Queue. Values are pushed into the queue - with an assigned priority, and the value with the highest priority will - always be at the front of the queue. - - - Implemented using a max heap. - - - - "First in, first out" ordering is preserved for values with the same priority. - - - - - Iterating over a PriorityQueue is destructive, equivalent to successive pop operations until the queue is empty. - - -
- -
- &reftitle.classsynopsis; - - - Ds\PriorityQueue - - - - Ds\PriorityQueue - - - - Ds\Collection - - - - &Constants; - - const - int - Ds\PriorityQueue::MIN_CAPACITY - 8 - - - &Methods; - - - -
- -
- &reftitle.constants; - - - - Ds\PriorityQueue::MIN_CAPACITY - - - - - - -
- -
- - &reference.ds.ds.entities.priorityqueue; - -
- - diff --git a/reference/ds/ds.queue.xml b/reference/ds/ds.queue.xml deleted file mode 100644 index eba8c6f4e5ad..000000000000 --- a/reference/ds/ds.queue.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - The Queue class - Ds\Queue - - - -
- &reftitle.intro; - - A Queue is a “first in, first out” or “FIFO” collection that only allows - access to the value at the front of the queue and iterates in that order, - destructively. - -
- -
- &reftitle.classsynopsis; - - - Ds\Queue - - - - Ds\Queue - - - - Ds\Collection - - - ArrayAccess - - - - &Constants; - - const - int - Ds\Queue::MIN_CAPACITY - 8 - - - &Methods; - - - -
- -
- &reftitle.constants; - - - - Ds\Queue::MIN_CAPACITY - - - - - - -
- -
- &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL ds 1.3.0 - - The class now implements ArrayAccess. - - - - - - -
- -
- - &reference.ds.ds.entities.queue; - -
- - diff --git a/reference/ds/ds.sequence.xml b/reference/ds/ds.sequence.xml deleted file mode 100644 index 098b3289cde1..000000000000 --- a/reference/ds/ds.sequence.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - The Sequence interface - Ds\Sequence - - - -
- &reftitle.intro; - - A Sequence describes the behaviour of values arranged in a single, linear dimension. - Some languages refer to this as a "List". It’s similar to an array that uses - incremental integer keys, with the exception of a few characteristics: - - Values will always be indexed as [0, 1, 2, …, size - 1]. - Only allowed to access values by index in the range [0, size - 1]. - - - - Use cases: - - Wherever you would use an array as a list (not concerned with keys). - A more efficient alternative to - SplDoublyLinkedList and - SplFixedArray. - - - -
- -
- &reftitle.interfacesynopsis; - - - Ds\Sequence - - - extends - Ds\Collection - - - ArrayAccess - - - &Methods; - - - &InheritedMethods; - - - - - - - - -
- -
- &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL ds 1.3.0 - - The interface now extends ArrayAccess. - - - - - - -
- -
- - &reference.ds.ds.entities.sequence; - -
- - diff --git a/reference/ds/ds.set.xml b/reference/ds/ds.set.xml deleted file mode 100644 index b85ef9161ea0..000000000000 --- a/reference/ds/ds.set.xml +++ /dev/null @@ -1,164 +0,0 @@ - - - - - - The Set class - Ds\Set - - - -
- &reftitle.intro; - - A Set is a sequence of unique values. This implementation uses the same hash - table as Ds\Map, where values are used as keys and the - mapped value is ignored. - -
- -
- Strengths - - - Values can be any type, including objects. - Supports array syntax (square brackets). - Insertion order is preserved. - Automatically frees allocated memory when its size drops low enough. - - add, - remove and - contains are all O(1). - - - -
- -
- Weaknesses - - - Doesn’t support - push, - pop, - insert, - shift, or - unshift. - - - get is O(n) if there are deleted values - in the buffer before the accessed index, O(1) otherwise. - - - -
- -
- &reftitle.classsynopsis; - - - Ds\Set - - - - Ds\Set - - - - Ds\Collection - - - ArrayAccess - - - - &Constants; - - const - int - Ds\Set::MIN_CAPACITY - 8 - - - &Methods; - - - -
- -
- &reftitle.constants; - - - - Ds\Set::MIN_CAPACITY - - - - - - -
- -
- &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL ds 1.3.0 - - The class now implements ArrayAccess. - - - - PECL ds 1.2.7 - - Added the Ds\Set::map method. - - - - PECL ds 1.2.0 - - Ds\Set::MIN_CAPACITY changed from 16 to 8. - - - - - - -
- -
- - &reference.ds.ds.entities.set; - -
- - diff --git a/reference/ds/ds.stack.xml b/reference/ds/ds.stack.xml deleted file mode 100644 index 8d2a21f4bda5..000000000000 --- a/reference/ds/ds.stack.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - The Stack class - Ds\Stack - - - -
- &reftitle.intro; - - A Stack is a “last in, first out” or “LIFO” collection that only allows - access to the value at the top of the structure and iterates in that order, - destructively. - - - Uses a Ds\Vector internally. - -
- -
- &reftitle.classsynopsis; - - - Ds\Stack - - - - Ds\Stack - - - - Ds\Collection - - - ArrayAccess - - - - &Methods; - - - -
- -
- &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL ds 1.3.0 - - The class now implements ArrayAccess. - - - - - - -
- -
- - &reference.ds.ds.entities.stack; - -
- - diff --git a/reference/ds/ds.vector.xml b/reference/ds/ds.vector.xml deleted file mode 100644 index 9594effcd6b7..000000000000 --- a/reference/ds/ds.vector.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - The Vector class - Ds\Vector - - - -
- &reftitle.intro; - - A Vector is a sequence of values in a contiguous buffer that grows and - shrinks automatically. It’s the most efficient sequential structure because - a value’s index is a direct mapping to its index in the buffer, and the - growth factor isn't bound to a specific multiple or exponent. - -
- -
- Strengths - - - Supports array syntax (square brackets). - Uses less overall memory than an &array; for the same number of values. - Automatically frees allocated memory when its size drops low enough. - Capacity does not have to be a power of 2. - - get, - set, - push, - pop are all O(1). - - - -
- -
- Weaknesses - - - - shift, - unshift, - insert and - remove are all O(n). - - - -
- -
- &reftitle.classsynopsis; - - - - Ds\Vector - - - - - Ds\Vector - Ds\Sequence - ArrayAccess - - - - &Constants; - - const - int - Ds\Vector::MIN_CAPACITY - 8 - - - &Methods; - - - -
- -
- &reftitle.constants; - - - - Ds\Vector::MIN_CAPACITY - - - - - - -
- -
- &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL ds 1.3.0 - - The class now implements ArrayAccess. - - - - PECL ds 1.2.0 - - Ds\Vector::MIN_CAPACITY changed from 10 to 8. - - - - - - -
- -
- - &reference.ds.ds.entities.vector; - -
- - diff --git a/reference/ds/ds/collection/clear.xml b/reference/ds/ds/collection/clear.xml deleted file mode 100644 index 4c07cf06ec9b..000000000000 --- a/reference/ds/ds/collection/clear.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - Ds\Collection::clear - Removes all values - - - - &reftitle.description; - - public voidDs\Collection::clear - - - - Removes all values from the collection. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <function>Ds\Collection::clear</function> example - -clear(); -print_r($collection); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 -) -Ds\Vector Object -( -) -]]> - - - - - - - - diff --git a/reference/ds/ds/collection/copy.xml b/reference/ds/ds/collection/copy.xml deleted file mode 100644 index ea4af34fb08d..000000000000 --- a/reference/ds/ds/collection/copy.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - Ds\Collection::copy - Returns a shallow copy of the collection - - - - &reftitle.description; - - public Ds\CollectionDs\Collection::copy - - - - Returns a shallow copy of the collection. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a shallow copy of the collection. - - - - - &reftitle.examples; - - <function>Ds\Collection::copy</function> example - -copy(); - -$b->push(4); - -print_r($a); -print_r($b); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 -) -Ds\Vector Object -( - [0] => 1 - [1] => 2 - [2] => 3 - [3] => 4 -) -]]> - - - - - - - - diff --git a/reference/ds/ds/collection/isempty.xml b/reference/ds/ds/collection/isempty.xml deleted file mode 100644 index 418d0e292afd..000000000000 --- a/reference/ds/ds/collection/isempty.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - Ds\Collection::isEmpty - Returns whether the collection is empty - - - - &reftitle.description; - - public boolDs\Collection::isEmpty - - - - Returns whether the collection is empty. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; if the collection is empty, &false; otherwise. - - - - - &reftitle.examples; - - <function>Ds\Collection::isEmpty</function> example - -isEmpty()); -var_dump($b->isEmpty()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/collection/toarray.xml b/reference/ds/ds/collection/toarray.xml deleted file mode 100644 index 44b782af7bc3..000000000000 --- a/reference/ds/ds/collection/toarray.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - Ds\Collection::toArray - - Converts the collection to an &array; - - - - - &reftitle.description; - - public arrayDs\Collection::toArray - - - - Converts the collection to an &array;. - - - - Casting to an &array; is not supported yet. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - An &array; containing all the values in the same order as the collection. - - - - - &reftitle.examples; - - <function>Ds\Collection::toArray</function> example - -toArray()); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) - [2]=> - int(3) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/deque/allocate.xml b/reference/ds/ds/deque/allocate.xml deleted file mode 100644 index be614818cede..000000000000 --- a/reference/ds/ds/deque/allocate.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - Ds\Deque::allocate - Allocates enough memory for a required capacity - - - - &reftitle.description; - - public voidDs\Deque::allocate - intcapacity - - - Ensures that enough memory is allocated for a required capacity. - This removes the need to reallocate the internal buffer as values are added. - - - - - &reftitle.parameters; - - - capacity - - - The number of values for which capacity should be allocated. - - - - Capacity will stay the same if this value is less than or equal to the - current capacity. - - - - - Capacity will always be rounded up to the nearest power of 2. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <function>Ds\Deque::allocate</function> example - -capacity()); - -$deque->allocate(100); -var_dump($deque->capacity()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/deque/apply.xml b/reference/ds/ds/deque/apply.xml deleted file mode 100644 index 8d39690988e1..000000000000 --- a/reference/ds/ds/deque/apply.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - Ds\Deque::apply - Updates all values by applying a callback function to each value - - - - &reftitle.description; - - public voidDs\Deque::apply - callablecallback - - - Updates all values by applying a callback function to - each value in the deque. - - - - - &reftitle.parameters; - - - callback - - - - - mixed - callback - mixedvalue - - - - A callable to apply to each value in the deque. - - - - The callback should return what the value should be replaced by. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <function>Ds\Deque::apply</function> example - -apply(function($value) { return $value * 2; }); - -print_r($deque); -?> -]]> - - &example.outputs.similar; - - 2 - [1] => 4 - [2] => 6 -) -]]> - - - - - - - - diff --git a/reference/ds/ds/deque/capacity.xml b/reference/ds/ds/deque/capacity.xml deleted file mode 100644 index 3672eda1af38..000000000000 --- a/reference/ds/ds/deque/capacity.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - Ds\Deque::capacity - Returns the current capacity - - - - &reftitle.description; - - public intDs\Deque::capacity - - - - Returns the current capacity. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The current capacity. - - - - - &reftitle.examples; - - <function>Ds\Deque::capacity</function> example - -capacity()); - -$deque->push(...range(1, 50)); -var_dump($deque->capacity()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/deque/clear.xml b/reference/ds/ds/deque/clear.xml deleted file mode 100644 index 742018dbc911..000000000000 --- a/reference/ds/ds/deque/clear.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - Ds\Deque::clear - Removes all values from the deque - - - - &reftitle.description; - - public voidDs\Deque::clear - - - - Removes all values from the deque. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <function>Ds\Deque::clear</function> example - -clear(); -print_r($deque); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 -) -Ds\Deque Object -( -) -]]> - - - - - - - - diff --git a/reference/ds/ds/deque/construct.xml b/reference/ds/ds/deque/construct.xml deleted file mode 100644 index 9579cc6b1c5d..000000000000 --- a/reference/ds/ds/deque/construct.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - Ds\Deque::__construct - Creates a new instance - - - - &reftitle.description; - - public Ds\Deque::__construct - mixedvalues - - - Creates a new instance, using either a traversable - object or an &array; for the initial values. - - - - - &reftitle.parameters; - - - values - - - A traversable object or an &array; to use for the initial values. - - - - - - - - - - - &reftitle.examples; - - <function>Ds\Deque::__construct</function> example - - -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) - [2]=> - int(3) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/deque/contains.xml b/reference/ds/ds/deque/contains.xml deleted file mode 100644 index 878ec0320e25..000000000000 --- a/reference/ds/ds/deque/contains.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - Ds\Deque::contains - Determines if the deque contains given values - - - - &reftitle.description; - - public boolDs\Deque::contains - mixedvalues - - - Determines if the deque contains all values. - - - - - &reftitle.parameters; - - - values - - - Values to check. - - - - - - - - &reftitle.returnvalues; - - &false; if any of the provided values are not in the - deque, &true; otherwise. - - - - - &reftitle.examples; - - <function>Ds\Deque::contains</function> example - -contains('a')); // true -var_dump($deque->contains('a', 'b')); // true -var_dump($deque->contains('c', 'd')); // false - -var_dump($deque->contains(...['c', 'b', 'a'])); // true - -// Always strict -var_dump($deque->contains(1)); // true -var_dump($deque->contains('1')); // false - -var_dump($deque->contains(...[])); // true -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/deque/copy.xml b/reference/ds/ds/deque/copy.xml deleted file mode 100644 index 49cfb60adba7..000000000000 --- a/reference/ds/ds/deque/copy.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - Ds\Deque::copy - Returns a shallow copy of the deque - - - - &reftitle.description; - - public Ds\DequeDs\Deque::copy - - - - Returns a shallow copy of the deque. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A shallow copy of the deque. - - - - - &reftitle.examples; - - <function>Ds\Deque::copy</function> example - -copy(); - -$b->push(4); - -print_r($a); -print_r($b); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 -) -Ds\Deque Object -( - [0] => 1 - [1] => 2 - [2] => 3 - [3] => 4 -) -]]> - - - - - - - - diff --git a/reference/ds/ds/deque/count.xml b/reference/ds/ds/deque/count.xml deleted file mode 100644 index a374bdfc4a00..000000000000 --- a/reference/ds/ds/deque/count.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - - Ds\Deque::count - Returns the number of values in the collection - - - - &reftitle.description; - - See Countable::count - - - - - - diff --git a/reference/ds/ds/deque/filter.xml b/reference/ds/ds/deque/filter.xml deleted file mode 100644 index b61b5934f738..000000000000 --- a/reference/ds/ds/deque/filter.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - Ds\Deque::filter - - Creates a new deque using a callable to - determine which values to include - - - - - &reftitle.description; - - public Ds\DequeDs\Deque::filter - callablecallback - - - Creates a new deque using a callable to - determine which values to include. - - - - - &reftitle.parameters; - - - - callback - - - - - bool - callback - mixedvalue - - - - Optional callable which returns &true; if the value should be included, &false; otherwise. - - - If a callback is not provided, only values which are &true; - (see converting to boolean) - will be included. - - - - - - - - - &reftitle.returnvalues; - - A new deque containing all the values for which - either the callback returned &true;, or all values that - convert to &true; if a callback was not provided. - - - - - &reftitle.examples; - - <function>Ds\Deque::filter</function> example using callback function - -filter(function($value) { - return $value % 2 == 0; -})); -?> -]]> - - &example.outputs.similar; - - - int(2) - [1]=> - int(4) -} -]]> - - - - <function>Ds\Deque::filter</function> example without a callback function - -filter()); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - string(1) "a" - [2]=> - bool(true) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/deque/find.xml b/reference/ds/ds/deque/find.xml deleted file mode 100644 index dfab9c66c009..000000000000 --- a/reference/ds/ds/deque/find.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Ds\Deque::find - - Attempts to find a value's index - - - - - &reftitle.description; - - public mixedDs\Deque::find - mixedvalue - - - Returns the index of the value, or &false; if not found. - - - - - - &reftitle.parameters; - - - value - - - The value to find. - - - - - - - - &reftitle.returnvalues; - - The index of the value, or &false; if not found. - - - - Values will be compared by value and by type. - - - - - - &reftitle.examples; - - <function>Ds\Deque::find</function> example - -find("a")); // 0 -var_dump($deque->find("b")); // false -var_dump($deque->find("1")); // false -var_dump($deque->find(1)); // 1 -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/deque/first.xml b/reference/ds/ds/deque/first.xml deleted file mode 100644 index f3837b3ccaba..000000000000 --- a/reference/ds/ds/deque/first.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - Ds\Deque::first - Returns the first value in the deque - - - - &reftitle.description; - - public mixedDs\Deque::first - - - - Returns the first value in the deque. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The first value in the deque. - - - - - &reftitle.errors; - - UnderflowException if empty. - - - - - &reftitle.examples; - - <function>Ds\Deque::first</function> example - -first()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/deque/get.xml b/reference/ds/ds/deque/get.xml deleted file mode 100644 index 374a3738380e..000000000000 --- a/reference/ds/ds/deque/get.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - Ds\Deque::get - Returns the value at a given index - - - - &reftitle.description; - - public mixedDs\Deque::get - intindex - - - Returns the value at a given index. - - - - - - &reftitle.parameters; - - - index - - - The index to access, starting at 0. - - - - - - - - &reftitle.returnvalues; - - The value at the requested index. - - - - - &reftitle.errors; - - OutOfRangeException if the index is not valid. - - - - - &reftitle.examples; - - <function>Ds\Deque::get</function> example - -get(0)); -var_dump($deque->get(1)); -var_dump($deque->get(2)); -?> -]]> - - &example.outputs.similar; - - - - - - <function>Ds\Deque::get</function> example using array syntax - - -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/deque/insert.xml b/reference/ds/ds/deque/insert.xml deleted file mode 100644 index 136ec85ce9cb..000000000000 --- a/reference/ds/ds/deque/insert.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - Ds\Deque::insert - Inserts values at a given index - - - - &reftitle.description; - - public voidDs\Deque::insert - intindex - mixedvalues - - - Inserts values into the deque at a given index. - - - - - - &reftitle.parameters; - - - index - - - The index at which to insert. 0 <= index <= count - - - - You can insert at the index equal to the number of values. - - - - - - values - - - The value or values to insert. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - OutOfRangeException if the index is not valid. - - - - - &reftitle.examples; - - <function>Ds\Deque::insert</function> example - -insert(0, "e"); // [e] -$deque->insert(1, "f"); // [e, f] -$deque->insert(2, "g"); // [e, f, g] -$deque->insert(0, "a", "b"); // [a, b, e, f, g] -$deque->insert(2, ...["c", "d"]); // [a, b, c, d, e, f, g] - -var_dump($deque); -?> -]]> - - &example.outputs.similar; - - - string(1) "a" - [1]=> - string(1) "b" - [2]=> - string(1) "c" - [3]=> - string(1) "d" - [4]=> - string(1) "e" - [5]=> - string(1) "f" - [6]=> - string(1) "g" -} -]]> - - - - - - - - diff --git a/reference/ds/ds/deque/isempty.xml b/reference/ds/ds/deque/isempty.xml deleted file mode 100644 index 8fcf23f7eeea..000000000000 --- a/reference/ds/ds/deque/isempty.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - Ds\Deque::isEmpty - Returns whether the deque is empty - - - - &reftitle.description; - - public boolDs\Deque::isEmpty - - - - Returns whether the deque is empty. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; if the deque is empty, &false; otherwise. - - - - - &reftitle.examples; - - <function>Ds\Deque::isEmpty</function> example - -isEmpty()); -var_dump($b->isEmpty()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/deque/join.xml b/reference/ds/ds/deque/join.xml deleted file mode 100644 index 6eef2d348814..000000000000 --- a/reference/ds/ds/deque/join.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Ds\Deque::join - Joins all values together as a string - - - - &reftitle.description; - - public stringDs\Deque::join - stringglue - - - Joins all values together as a string using an optional separator between each value. - - - - - &reftitle.parameters; - - - glue - - - An optional string to separate each value. - - - - - - - - &reftitle.returnvalues; - - All values of the deque joined together as a string. - - - - - &reftitle.examples; - - <function>Ds\Deque::join</function> example using a separator string - -join("|")); -?> -]]> - - &example.outputs.similar; - - - - - - <function>Ds\Deque::join</function> example without a separator string - -join()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/deque/jsonserialize.xml b/reference/ds/ds/deque/jsonserialize.xml deleted file mode 100644 index d3be59b2044f..000000000000 --- a/reference/ds/ds/deque/jsonserialize.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - - Ds\Deque::jsonSerialize - Returns a representation that can be converted to JSON - - - - &reftitle.description; - - See JsonSerializable::jsonSerialize - - - - You should never need to call this directly. - - - - - - - diff --git a/reference/ds/ds/deque/last.xml b/reference/ds/ds/deque/last.xml deleted file mode 100644 index 8718c8041505..000000000000 --- a/reference/ds/ds/deque/last.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - Ds\Deque::last - Returns the last value - - - - &reftitle.description; - - public mixedDs\Deque::last - - - - Returns the last value in the deque. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The last value in the deque. - - - - - &reftitle.errors; - - UnderflowException if empty. - - - - - &reftitle.examples; - - <function>Ds\Deque::last</function> example - -last()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/deque/map.xml b/reference/ds/ds/deque/map.xml deleted file mode 100644 index def1d450e67e..000000000000 --- a/reference/ds/ds/deque/map.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - Ds\Deque::map - Returns the result of applying a callback to each value - - - - &reftitle.description; - - public Ds\DequeDs\Deque::map - callablecallback - - - Returns the result of applying a callback function to - each value in the deque. - - - - - &reftitle.parameters; - - - callback - - - - - mixed - callback - mixedvalue - - - - A callable to apply to each value in the deque. - - - - The callable should return what the new value will be in the new deque. - - - - - - - - - &reftitle.returnvalues; - - The result of applying a callback to each value in - the deque. - - - - The values of the current instance won't be affected. - - - - - - &reftitle.examples; - - <function>Ds\Deque::map</function> example - -map(function($value) { return $value * 2; })); -print_r($deque); -?> -]]> - - &example.outputs.similar; - - 2 - [1] => 4 - [2] => 6 -) -Ds\Deque Object -( - [0] => 1 - [1] => 2 - [2] => 3 -) -]]> - - - - - - - - diff --git a/reference/ds/ds/deque/merge.xml b/reference/ds/ds/deque/merge.xml deleted file mode 100644 index 02412b276f02..000000000000 --- a/reference/ds/ds/deque/merge.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - Ds\Deque::merge - Returns the result of adding all given values to the deque - - - - &reftitle.description; - - public Ds\DequeDs\Deque::merge - mixedvalues - - - Returns the result of adding all given values to the deque. - - - - - - &reftitle.parameters; - - - values - - - A traversable object or an &array;. - - - - - - - - &reftitle.returnvalues; - - The result of adding all given values to the deque, - effectively the same as adding the values to a copy, then returning that copy. - - - - The current instance won't be affected. - - - - - - &reftitle.examples; - - <function>Ds\Deque::merge</function> example - -merge([4, 5, 6])); -var_dump($deque); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) - [2]=> - int(3) - [3]=> - int(4) - [4]=> - int(5) - [5]=> - int(6) -} -object(Ds\Deque)#1 (3) { - [0]=> - int(1) - [1]=> - int(2) - [2]=> - int(3) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/deque/pop.xml b/reference/ds/ds/deque/pop.xml deleted file mode 100644 index 44960b60dac0..000000000000 --- a/reference/ds/ds/deque/pop.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Ds\Deque::pop - Removes and returns the last value - - - - &reftitle.description; - - public mixedDs\Deque::pop - - - - Removes and returns the last value. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The removed last value. - - - - - &reftitle.errors; - - UnderflowException if empty. - - - - - &reftitle.examples; - - <function>Ds\Deque::pop</function> example - -pop()); -var_dump($deque->pop()); -var_dump($deque->pop()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/deque/push.xml b/reference/ds/ds/deque/push.xml deleted file mode 100644 index f42c6bccb36b..000000000000 --- a/reference/ds/ds/deque/push.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Ds\Deque::push - Adds values to the end of the deque - - - - &reftitle.description; - - public voidDs\Deque::push - mixedvalues - - - Adds values to the end of the deque. - - - - - - &reftitle.parameters; - - - values - - - The values to add. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <function>Ds\Deque::push</function> example - -push("a"); -$deque->push("b"); -$deque->push("c", "d"); -$deque->push(...["e", "f"]); - -print_r($deque); -?> -]]> - - &example.outputs.similar; - - a - [1] => b - [2] => c - [3] => d - [4] => e - [5] => f -) -]]> - - - - - - - - diff --git a/reference/ds/ds/deque/reduce.xml b/reference/ds/ds/deque/reduce.xml deleted file mode 100644 index 745bcf683fb4..000000000000 --- a/reference/ds/ds/deque/reduce.xml +++ /dev/null @@ -1,159 +0,0 @@ - - - - - - Ds\Deque::reduce - Reduces the deque to a single value using a callback function - - - - &reftitle.description; - - public mixedDs\Deque::reduce - callablecallback - mixedinitial - - - Reduces the deque to a single value using a callback function. - - - - - - &reftitle.parameters; - - - callback - - - - mixedcallback - mixedcarry - mixedvalue - - - - carry - - - The return value of the previous callback, or initial if - it's the first iteration. - - - - - value - - - The value of the current iteration. - - - - - - - - - initial - - - The initial value of the carry value. Can be &null;. - - - - - - - - &reftitle.returnvalues; - - The return value of the final callback. - - - - - &reftitle.examples; - - <function>Ds\Deque::reduce</function> with initial value example - -reduce($callback, 5)); - -// Iterations: -// -// $carry = $initial = 5 -// -// $carry = $carry * 1 = 5 -// $carry = $carry * 2 = 10 -// $carry = $carry * 3 = 30 -?> -]]> - - &example.outputs.similar; - - - - - - <function>Ds\Deque::reduce</function> without an initial value example - -reduce(function($carry, $value) { - return $carry + $value + 5; -})); - -// Iterations: -// -// $carry = $initial = null -// -// $carry = $carry + 1 + 5 = 6 -// $carry = $carry + 2 + 5 = 13 -// $carry = $carry + 3 + 5 = 21 -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/deque/remove.xml b/reference/ds/ds/deque/remove.xml deleted file mode 100644 index 100470a89dff..000000000000 --- a/reference/ds/ds/deque/remove.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - Ds\Deque::remove - Removes and returns a value by index - - - - &reftitle.description; - - public mixedDs\Deque::remove - intindex - - - Removes and returns a value by index. - - - - - - &reftitle.parameters; - - - index - - - The index of the value to remove. - - - - - - - - &reftitle.returnvalues; - - The value that was removed. - - - - - &reftitle.errors; - - OutOfRangeException if the index is not valid. - - - - - &reftitle.examples; - - <function>Ds\Deque::remove</function> example - -remove(1)); -var_dump($deque->remove(0)); -var_dump($deque->remove(0)); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/deque/reverse.xml b/reference/ds/ds/deque/reverse.xml deleted file mode 100644 index c530d5176a23..000000000000 --- a/reference/ds/ds/deque/reverse.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - Ds\Deque::reverse - - Reverses the deque in-place - - - - - &reftitle.description; - - public voidDs\Deque::reverse - - - - Reverses the deque in-place. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <function>Ds\Deque::reverse</function> example - -reverse(); - -print_r($deque); -?> -]]> - - &example.outputs.similar; - - c - [1] => b - [2] => a -) -]]> - - - - - - - - diff --git a/reference/ds/ds/deque/reversed.xml b/reference/ds/ds/deque/reversed.xml deleted file mode 100644 index f08000242a3e..000000000000 --- a/reference/ds/ds/deque/reversed.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - Ds\Deque::reversed - Returns a reversed copy - - - - &reftitle.description; - - public Ds\DequeDs\Deque::reversed - - - - Returns a reversed copy of the deque. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A reversed copy of the deque. - - - - The current instance is not affected. - - - - - - - &reftitle.examples; - - <function>Ds\Deque::reversed</function> example - -reversed()); -print_r($deque); -?> -]]> - - &example.outputs.similar; - - c - [1] => b - [2] => a -) -Ds\Deque Object -( - [0] => a - [1] => b - [2] => c -) -]]> - - - - - - - - diff --git a/reference/ds/ds/deque/rotate.xml b/reference/ds/ds/deque/rotate.xml deleted file mode 100644 index dce00cbcea33..000000000000 --- a/reference/ds/ds/deque/rotate.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - Ds\Deque::rotate - Rotates the deque by a given number of rotations - - - - &reftitle.description; - - public voidDs\Deque::rotate - introtations - - - Rotates the deque by a given number of rotations, which is equivalent - to successively calling $deque->push($deque->shift()) if the number - of rotations is positive, or $deque->unshift($deque->pop()) if negative. - - - - - - &reftitle.parameters; - - - rotations - - - The number of times the deque should be rotated. - - - - - - - - &reftitle.returnvalues; - - &return.void;. The deque of the current instance will be rotated. - - - - - &reftitle.examples; - - <function>Ds\Deque::rotate</function> example - -rotate(1); // "a" is shifted, then pushed. -print_r($deque); - -$deque->rotate(2); // "b" and "c" are both shifted, then pushed. -print_r($deque); -?> -]]> - - &example.outputs.similar; - - b - [1] => c - [2] => d - [3] => a -) -Ds\Deque Object -( - [0] => d - [1] => a - [2] => b - [3] => c -) -]]> - - - - - - - - diff --git a/reference/ds/ds/deque/set.xml b/reference/ds/ds/deque/set.xml deleted file mode 100644 index 1555e6951a8f..000000000000 --- a/reference/ds/ds/deque/set.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - Ds\Deque::set - Updates a value at a given index - - - - &reftitle.description; - - public voidDs\Deque::set - intindex - mixedvalue - - - Updates a value at a given index. - - - - - - &reftitle.parameters; - - - index - - - The index of the value to update. - - - - - value - - - The new value. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - OutOfRangeException if the index is not valid. - - - - - &reftitle.examples; - - <function>Ds\Deque::set</function> example - -set(1, "_"); -print_r($deque); -?> -]]> - - &example.outputs.similar; - - a - [1] => _ - [2] => c -) -]]> - - - - <function>Ds\Deque::set</function> example using array syntax - - -]]> - - &example.outputs.similar; - - a - [1] => _ - [2] => c -) -]]> - - - - - - - - diff --git a/reference/ds/ds/deque/shift.xml b/reference/ds/ds/deque/shift.xml deleted file mode 100644 index ad76fb929a03..000000000000 --- a/reference/ds/ds/deque/shift.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Ds\Deque::shift - Removes and returns the first value - - - - &reftitle.description; - - public mixedDs\Deque::shift - - - - Removes and returns the first value. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The first value, which was removed. - - - - - &reftitle.errors; - - UnderflowException if empty. - - - - - &reftitle.examples; - - <function>Ds\Deque::shift</function> example - -shift()); -var_dump($deque->shift()); -var_dump($deque->shift()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/deque/slice.xml b/reference/ds/ds/deque/slice.xml deleted file mode 100644 index f8191128f8fd..000000000000 --- a/reference/ds/ds/deque/slice.xml +++ /dev/null @@ -1,156 +0,0 @@ - - - - - - Ds\Deque::slice - - Returns a sub-deque of a given range - - - - - &reftitle.description; - - public Ds\DequeDs\Deque::slice - intindex - intlength - - - Creates a sub-deque of a given range. - - - - - - &reftitle.parameters; - - - index - - - The index at which the sub-deque starts. - - - If positive, the deque will start at that index in the deque. - If negative, the deque will start that far from the end. - - - - - length - - - If a length is given and is positive, the resulting - deque will have up to that many values in it. - - If the length results in an overflow, only - values up to the end of the deque will be included. - - If a length is given and is negative, the deque - will stop that many values from the end. - - If a length is not provided, the resulting deque - will contain all values between the index and the - end of the deque. - - - - - - - - &reftitle.returnvalues; - - A sub-deque of the given range. - - - - - &reftitle.examples; - - <function>Ds\Deque::slice</function> example - -slice(2)); - -// Slice from 1, for a length of 3 -print_r($deque->slice(1, 3)); - -// Slice from 1 onwards -print_r($deque->slice(1)); - -// Slice from 2 from the end onwards -print_r($deque->slice(-2)); - -// Slice from 1 to 1 from the end -print_r($deque->slice(1, -1)); -?> -]]> - - &example.outputs.similar; - - c - [1] => d - [2] => e -) -Ds\Deque Object -( - [0] => b - [1] => c - [2] => d -) -Ds\Deque Object -( - [0] => b - [1] => c - [2] => d - [3] => e -) -Ds\Deque Object -( - [0] => d - [1] => e -) -Ds\Deque Object -( - [0] => b - [1] => c - [2] => d -) - -]]> - - - - - - - - diff --git a/reference/ds/ds/deque/sort.xml b/reference/ds/ds/deque/sort.xml deleted file mode 100644 index b50d2c2fdab6..000000000000 --- a/reference/ds/ds/deque/sort.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - Ds\Deque::sort - - Sorts the deque in-place - - - - - &reftitle.description; - - public voidDs\Deque::sort - callablecomparator - - - Sorts the deque in-place, using an optional comparator function. - - - - - - &reftitle.parameters; - - - comparator - - &sort.callback.description; - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <function>Ds\Deque::sort</function> example - -sort(); - -print_r($deque); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 - [3] => 4 - [4] => 5 -) -]]> - - - - <function>Ds\Deque::sort</function> example using a comparator - -sort(function($a, $b) { - return $b <=> $a; -}); - -print_r($deque); -?> -]]> - - &example.outputs.similar; - - 5 - [1] => 4 - [2] => 3 - [3] => 2 - [4] => 1 -) -]]> - - - - - - - - - diff --git a/reference/ds/ds/deque/sorted.xml b/reference/ds/ds/deque/sorted.xml deleted file mode 100644 index 93241d67bcba..000000000000 --- a/reference/ds/ds/deque/sorted.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - Ds\Deque::sorted - Returns a sorted copy - - - - &reftitle.description; - - public Ds\DequeDs\Deque::sorted - callablecomparator - - - Returns a sorted copy, using an optional comparator function. - - - - - - &reftitle.parameters; - - - comparator - - &sort.callback.description; - - - - - - - &reftitle.returnvalues; - - Returns a sorted copy of the deque. - - - - - &reftitle.examples; - - <function>Ds\Deque::sorted</function> example - -sorted()); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 - [3] => 4 - [4] => 5 -) -]]> - - - - <function>Ds\Deque::sorted</function> example using a comparator - -sorted(function($a, $b) { - return $b <=> $a; -}); - -print_r($sorted); -?> -]]> - - &example.outputs.similar; - - 5 - [1] => 4 - [2] => 3 - [3] => 2 - [4] => 1 -) -]]> - - - - - - - - - diff --git a/reference/ds/ds/deque/sum.xml b/reference/ds/ds/deque/sum.xml deleted file mode 100644 index 5ae0a7135f6a..000000000000 --- a/reference/ds/ds/deque/sum.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Ds\Deque::sum - Returns the sum of all values in the deque - - - - &reftitle.description; - - public intfloatDs\Deque::sum - - - - Returns the sum of all values in the deque. - - - - Arrays and objects are considered equal to zero when calculating the sum. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The sum of all the values in the deque as either a float or int - depending on the values in the deque. - - - - - &reftitle.examples; - - <function>Ds\Deque::sum</function> integer example - -sum()); -?> -]]> - - &example.outputs.similar; - - - - - - <function>Ds\Deque::sum</function> float example - -sum()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/deque/toarray.xml b/reference/ds/ds/deque/toarray.xml deleted file mode 100644 index 6fba07034307..000000000000 --- a/reference/ds/ds/deque/toarray.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - Ds\Deque::toArray - - Converts the deque to an &array; - - - - - &reftitle.description; - - public arrayDs\Deque::toArray - - - - Converts the deque to an &array;. - - - - Casting to an &array; is not supported yet. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - An &array; containing all the values in the same order as the deque. - - - - - &reftitle.examples; - - <function>Ds\Deque::toArray</function> example - -toArray()); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) - [2]=> - int(3) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/deque/unshift.xml b/reference/ds/ds/deque/unshift.xml deleted file mode 100644 index 7618263ce2d2..000000000000 --- a/reference/ds/ds/deque/unshift.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Ds\Deque::unshift - Adds values to the front of the deque - - - - &reftitle.description; - - public voidDs\Deque::unshift - mixedvalues - - - Adds values to the front of the deque, moving all the current - values forward to make room for the new values. - - - - - - &reftitle.parameters; - - - values - - - The values to add to the front of the deque. - - - Multiple values will be added in the same order that they are - passed. - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <function>Ds\Deque::unshift</function> example - -unshift("a"); -$deque->unshift("b", "c"); - -print_r($deque); -?> -]]> - - &example.outputs.similar; - - b - [1] => c - [2] => a - [3] => 1 - [4] => 2 - [5] => 3 -) -]]> - - - - - - - diff --git a/reference/ds/ds/hashable/equals.xml b/reference/ds/ds/hashable/equals.xml deleted file mode 100644 index e2c56f21724f..000000000000 --- a/reference/ds/ds/hashable/equals.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - Ds\Hashable::equals - Determines whether an object is equal to the current instance - - - - &reftitle.description; - - abstract public boolDs\Hashable::equals - objectobj - - - Determines whether another object is equal to the current instance. - - - - This method allows objects to be used as keys in structures such as - Ds\Map and Ds\Set, or any - other lookup structure that honors this interface. - - - - - It's guaranteed that obj is an instance of the same class. - - - - - - It's important that objects which are equal also have the same hash value. - See Ds\Hashable::hash. - - - - - - - &reftitle.parameters; - - - obj - - - The object to compare the current instance to, which is always an instance of - the same class. - - - - - - - - &reftitle.returnvalues; - - &true; if equal, &false; otherwise. - - - - - - - diff --git a/reference/ds/ds/hashable/hash.xml b/reference/ds/ds/hashable/hash.xml deleted file mode 100644 index 386c85e05816..000000000000 --- a/reference/ds/ds/hashable/hash.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - Ds\Hashable::hash - Returns a scalar value to be used as a hash value - - - - &reftitle.description; - - abstract public mixedDs\Hashable::hash - - - - Returns a scalar value to be used as the hash value of the objects. - - - While the hash value does not define equality, all objects that are equal according to Ds\Hashable::equals - must have the same hash value. Hash values of equal objects don't have to be unique, for example - you could just return &true; for all objects and nothing would break - the only - implication would be that hash tables then turn into linked lists because all - your objects will be hashed to the same bucket. It's therefore very important - that you pick a good hash value, such as an ID or email address. - - - - This method allows objects to be used as keys in structures such as - Ds\Map and Ds\Set, or any - other lookup structure that honors this interface. - - - - - Do not pick a value that might change within the object, such as a public - property. Hash table lookups would fail because the hash has changed. - - - - - - All objects that are equal must have the same hash value. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A scalar value to be used as this object's hash value. - - - - - &reftitle.examples; - - <function>Ds\Hashable::hash</function> example - -name = $name; - $this->email = $email; - } - - /** - * Should return the same value for all equal objects, but doesn't have to - * be unique. This value will not be used to determine equality. - */ - public function hash() - { - return $this->email; - } - - /** - * This determines equality, usually during a hash table lookup to determine - * if the bucket's key matches the lookup key. The hash has to be equal if - * the objects are equal, otherwise this determination wouldn't be reached. - */ - public function equals($obj): bool - { - return $this->name === $obj->name - && $this->email === $obj->email; - } -} -?> -]]> - - - - - - - - diff --git a/reference/ds/ds/map/allocate.xml b/reference/ds/ds/map/allocate.xml deleted file mode 100644 index ad645579f163..000000000000 --- a/reference/ds/ds/map/allocate.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - Ds\Map::allocate - Allocates enough memory for a required capacity - - - - &reftitle.description; - - public voidDs\Map::allocate - intcapacity - - - Allocates enough memory for a required capacity. - - - - - - &reftitle.parameters; - - - capacity - - - The number of values for which capacity should be allocated. - - - - Capacity will stay the same if this value is less than or equal to the - current capacity. - - - - - Capacity will always be rounded up to the nearest power of 2. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <function>Ds\Map::allocate</function> example - -capacity()); - -$map->allocate(100); -var_dump($map->capacity()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/map/apply.xml b/reference/ds/ds/map/apply.xml deleted file mode 100644 index 03dbb4ca967a..000000000000 --- a/reference/ds/ds/map/apply.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - Ds\Map::apply - Updates all values by applying a callback function to each value - - - - &reftitle.description; - - public voidDs\Map::apply - callablecallback - - - Updates all values by applying a callback function to - each value in the map. - - - - - &reftitle.parameters; - - - callback - - - - - mixed - callback - mixedkey - mixedvalue - - - - A callable to apply to each value in the map. - - - - The callback should return what the value should be replaced by. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <function>Ds\Map::apply</function> example - - 1, "b" => 2, "c" => 3]); -$map->apply(function($key, $value) { return $value * 2; }); - -print_r($map); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => a - [value] => 2 - ) - - [1] => Ds\Pair Object - ( - [key] => b - [value] => 4 - ) - - [2] => Ds\Pair Object - ( - [key] => c - [value] => 6 - ) - -) -]]> - - - - - - - - diff --git a/reference/ds/ds/map/capacity.xml b/reference/ds/ds/map/capacity.xml deleted file mode 100644 index 4f65668a1e49..000000000000 --- a/reference/ds/ds/map/capacity.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - Ds\Map::capacity - Returns the current capacity - - - - &reftitle.description; - - public intDs\Map::capacity - - - - Returns the current capacity. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The current capacity. - - - - - &reftitle.examples; - - <function>Ds\Map::capacity</function> example - -capacity()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/map/clear.xml b/reference/ds/ds/map/clear.xml deleted file mode 100644 index 0e2cb991fa50..000000000000 --- a/reference/ds/ds/map/clear.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - Ds\Map::clear - Removes all values - - - - &reftitle.description; - - public voidDs\Map::clear - - - - Removes all values from the map. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <function>Ds\Map::clear</function> example - - 1, - "b" => 2, - "c" => 3, -]); -print_r($map); - -$map->clear(); -print_r($map); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => a - [value] => 1 - ) - - [1] => Ds\Pair Object - ( - [key] => b - [value] => 2 - ) - - [2] => Ds\Pair Object - ( - [key] => c - [value] => 3 - ) - -) -Ds\Map Object -( -) -]]> - - - - - - - - diff --git a/reference/ds/ds/map/construct.xml b/reference/ds/ds/map/construct.xml deleted file mode 100644 index ecd58f298c80..000000000000 --- a/reference/ds/ds/map/construct.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - Ds\Map::__construct - Creates a new instance - - - - &reftitle.description; - - public Ds\Map::__construct - mixedvalues - - - Creates a new instance, using either a traversable - object or an &array; for the initial values. - - - - - - &reftitle.parameters; - - - values - - - A traversable object or an &array; to use for the initial values. - - - - - - - - - - &reftitle.examples; - - <function>Ds\Map::__construct</function> example - - 1, "b" => 2, "c" => 3]); -var_dump($map); -?> -]]> - - &example.outputs.similar; - - - object(Ds\Pair)#1 (2) { - ["key"]=> - string(1) "a" - ["value"]=> - int(1) - } - [1]=> - object(Ds\Pair)#3 (2) { - ["key"]=> - string(1) "b" - ["value"]=> - int(2) - } - [2]=> - object(Ds\Pair)#4 (2) { - ["key"]=> - string(1) "c" - ["value"]=> - int(3) - } -} -]]> - - - - - - - - diff --git a/reference/ds/ds/map/copy.xml b/reference/ds/ds/map/copy.xml deleted file mode 100644 index 2fbc8c4b3fc1..000000000000 --- a/reference/ds/ds/map/copy.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - Ds\Map::copy - Returns a shallow copy of the map - - - - &reftitle.description; - - public Ds\MapDs\Map::copy - - - - Returns a shallow copy of the map. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a shallow copy of the map. - - - - - &reftitle.examples; - - <function>Ds\Map::copy</function> example - - 1, - "b" => 2, - "c" => 3, -]); - -print_r($map->copy()); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => a - [value] => 1 - ) - - [1] => Ds\Pair Object - ( - [key] => b - [value] => 2 - ) - - [2] => Ds\Pair Object - ( - [key] => c - [value] => 3 - ) - -) -]]> - - - - - - - - diff --git a/reference/ds/ds/map/count.xml b/reference/ds/ds/map/count.xml deleted file mode 100644 index b04276e12f43..000000000000 --- a/reference/ds/ds/map/count.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - - Ds\Map::count - Returns the number of values in the map - - - - &reftitle.description; - - See Countable::count - - - - - - diff --git a/reference/ds/ds/map/diff.xml b/reference/ds/ds/map/diff.xml deleted file mode 100644 index 92c11bdbff46..000000000000 --- a/reference/ds/ds/map/diff.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - Ds\Map::diff - Creates a new map using keys that aren't in another map - - - - &reftitle.description; - - public Ds\MapDs\Map::diff - Ds\Mapmap - - - Returns the result of removing all keys from the current instance that are - present in a given map. - - - A \ B = {x ∈ A | x ∉ B} - - - - - &reftitle.parameters; - - - map - - - The map containing the keys to exclude in the resulting map. - - - - - - - - &reftitle.returnvalues; - - The result of removing all keys from the current instance that are - present in a given map. - - - - - &reftitle.seealso; - - - Complement on Wikipedia - - - - - - &reftitle.examples; - - <function>Ds\Map::diff</function> example - - 1, "b" => 2, "c" => 3]); -$b = new \Ds\Map(["b" => 4, "c" => 5, "d" => 6]); - -var_dump($a->diff($b)); -?> -]]> - - &example.outputs.similar; - - - object(Ds\Pair)#4 (2) { - ["key"]=> - string(1) "a" - ["value"]=> - int(1) - } -} -]]> - - - - - - - - diff --git a/reference/ds/ds/map/filter.xml b/reference/ds/ds/map/filter.xml deleted file mode 100644 index da1bbd53848b..000000000000 --- a/reference/ds/ds/map/filter.xml +++ /dev/null @@ -1,153 +0,0 @@ - - - - - - Ds\Map::filter - - Creates a new map using a callable to determine which pairs to include - - - - - &reftitle.description; - - public Ds\MapDs\Map::filter - callablecallback - - - Creates a new map using a callable to determine which pairs to include. - - - - - - &reftitle.parameters; - - - callback - - - - bool - callback - mixedkey - mixedvalue - - - - Optional callable which returns &true; if the pair should be included, &false; otherwise. - - - If a callback is not provided, only values which are &true; - (see converting to boolean) - will be included. - - - - - - - - &reftitle.returnvalues; - - A new map containing all the pairs for which - either the callback returned &true;, or all values that - convert to &true; if a callback was not provided. - - - - - &reftitle.examples; - - <function>Ds\Map::filter</function> example using callback function - -filter(function($key, $value) { - return $key % 2 == 0; -})); -?> -]]> - - &example.outputs.similar; - - - object(Ds\Pair)#2 (2) { - ["key"]=> - int(0) - ["value"]=> - string(1) "a" - } - [1]=> - object(Ds\Pair)#4 (2) { - ["key"]=> - int(2) - ["value"]=> - string(1) "c" - } - [2]=> - object(Ds\Pair)#5 (2) { - ["key"]=> - int(4) - ["value"]=> - string(1) "e" - } -} -]]> - - - - <function>Ds\Map::filter</function> example without a callback function - - 0, "b" => 1, "c" => true, "d" => false]); - -var_dump($map->filter()); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - string(1) "a" - [2]=> - bool(true) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/map/first.xml b/reference/ds/ds/map/first.xml deleted file mode 100644 index 4434e5348605..000000000000 --- a/reference/ds/ds/map/first.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Ds\Map::first - Returns the first pair in the map - - - - &reftitle.description; - - public Ds\PairDs\Map::first - - - - Returns the first pair in the map. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The first pair in the map. - - - - - &reftitle.errors; - - UnderflowException if empty. - - - - - &reftitle.examples; - - <function>Ds\Map::first</function> example - - 1, "b" => 2, "c" => 3]); -var_dump($map->first()); -?> -]]> - - &example.outputs.similar; - - - string(1) "a" - ["value"]=> - int(1) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/map/get.xml b/reference/ds/ds/map/get.xml deleted file mode 100644 index 835e43f8e34a..000000000000 --- a/reference/ds/ds/map/get.xml +++ /dev/null @@ -1,156 +0,0 @@ - - - - - - Ds\Map::get - Returns the value for a given key - - - - &reftitle.description; - - public mixedDs\Map::get - mixedkey - mixeddefault - - - Returns the value for a given key, or an optional default value if the key - could not be found. - - - - - Keys of type object are supported. - - If an object implements Ds\Hashable, - equality will be determined by the object's equals function. - - If an object does not implement Ds\Hashable, - objects must be references to the same instance to be considered equal. - - - - - - You can also use array syntax to access values by key, eg. $map["key"]. - - - - - - Be careful when using array syntax. Scalar keys will be coerced to - integers by the engine. For example, $map["1"] will attempt - to access int(1), while $map->get("1") will - correctly look up the string key. - - - See Arrays. - - - - - - - &reftitle.parameters; - - - key - - - The key to look up. - - - - - default - - - The optional default value, returned if the key could not be found. - - - - - - - - &reftitle.returnvalues; - - The value mapped to the given key, or the default - value if provided and the key could not be found in the map. - - - - - &reftitle.errors; - - OutOfBoundsException if the key could not be found - and a default value was not provided. - - - - - &reftitle.examples; - - <function>Ds\Map::get</function> example - - 1, "b" => 2, "c" => 3]); - -var_dump($map->get("a")); // 1 -var_dump($map->get("d", 10)); // 10 (default used) -?> -]]> - - &example.outputs.similar; - - - - - - <function>Ds\Map::get</function> example using array syntax - - 1, "b" => 2, "c" => 3]); - -var_dump($map["a"]); // 1 -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/map/haskey.xml b/reference/ds/ds/map/haskey.xml deleted file mode 100644 index 30982c250315..000000000000 --- a/reference/ds/ds/map/haskey.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Ds\Map::hasKey - Determines whether the map contains a given key - - - - &reftitle.description; - - public boolDs\Map::hasKey - mixedkey - - - Determines whether the map contains a given key. - - - - - - &reftitle.parameters; - - - key - - - The key to look for. - - - - - - - - &reftitle.returnvalues; - - Returns &true; if the key could be found, &false; otherwise. - - - - - &reftitle.examples; - - <function>Ds\Map::hasKey</function> example - - 1, "b" => 2, "c" => 3]); - -var_dump($map->hasKey("a")); // true -var_dump($map->hasKey("e")); // false -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/map/hasvalue.xml b/reference/ds/ds/map/hasvalue.xml deleted file mode 100644 index 9c8e301c1d2b..000000000000 --- a/reference/ds/ds/map/hasvalue.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Ds\Map::hasValue - Determines whether the map contains a given value - - - - &reftitle.description; - - public boolDs\Map::hasValue - mixedvalue - - - Determines whether the map contains a given value. - - - - - - &reftitle.parameters; - - - value - - - The value to look for. - - - - - - - - &reftitle.returnvalues; - - Returns &true; if the value could be found, &false; otherwise. - - - - - &reftitle.examples; - - <function>Ds\Map::hasValue</function> example - - 1, "b" => 2, "c" => 3]); - -var_dump($map->hasValue(1)); // true -var_dump($map->hasValue(4)); // false -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/map/intersect.xml b/reference/ds/ds/map/intersect.xml deleted file mode 100644 index 96170889cc0c..000000000000 --- a/reference/ds/ds/map/intersect.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - Ds\Map::intersect - Creates a new map by intersecting keys with another map - - - - &reftitle.description; - - public Ds\MapDs\Map::intersect - Ds\Mapmap - - - Creates a new map containing the pairs of the current instance whose keys - are also present in the given map. - - In other words, returns a copy of the current instance with all keys removed that - are not also in the other map. - - - A ∩ B = {x : x ∈ A ∧ x ∈ B} - - - - - Values from the current instance will be kept. - - - - - - &reftitle.parameters; - - - map - - - The other map, containing the keys to intersect with. - - - - - - - - &reftitle.returnvalues; - - The key intersection of the current instance and another map. - - - - - &reftitle.seealso; - - - Intersection on Wikipedia - - - - - - &reftitle.examples; - - <function>Ds\Map::intersect</function> example - - 1, "b" => 2, "c" => 3]); -$b = new \Ds\Map(["b" => 4, "c" => 5, "d" => 6]); - -var_dump($a->intersect($b)); -?> -]]> - - &example.outputs.similar; - - - object(Ds\Pair)#4 (2) { - ["key"]=> - string(1) "b" - ["value"]=> - int(2) - } - [1]=> - object(Ds\Pair)#5 (2) { - ["key"]=> - string(1) "c" - ["value"]=> - int(3) - } -} -]]> - - - - - - - - diff --git a/reference/ds/ds/map/isempty.xml b/reference/ds/ds/map/isempty.xml deleted file mode 100644 index 71b3bf0557df..000000000000 --- a/reference/ds/ds/map/isempty.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - Ds\Map::isEmpty - Returns whether the map is empty - - - - &reftitle.description; - - public boolDs\Map::isEmpty - - - - Returns whether the map is empty. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; if the map is empty, &false; otherwise. - - - - - &reftitle.examples; - - <function>Ds\Map::isEmpty</function> example - - 1, "b" => 2, "c" => 3]); -$b = new \Ds\Map(); - -var_dump($a->isEmpty()); -var_dump($b->isEmpty()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/map/jsonserialize.xml b/reference/ds/ds/map/jsonserialize.xml deleted file mode 100644 index 0da6deb87e96..000000000000 --- a/reference/ds/ds/map/jsonserialize.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - - Ds\Map::jsonSerialize - Returns a representation that can be converted to JSON - - - - &reftitle.description; - - See JsonSerializable::jsonSerialize - - - - You should never need to call this directly. - - - - - - - diff --git a/reference/ds/ds/map/keys.xml b/reference/ds/ds/map/keys.xml deleted file mode 100644 index 9878196d74ec..000000000000 --- a/reference/ds/ds/map/keys.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - Ds\Map::keys - Returns a set of the map's keys - - - - &reftitle.description; - - public Ds\SetDs\Map::keys - - - - Returns a set containing all the keys of the map, in the same order. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A Ds\Set containing all the keys of the map. - - - - - &reftitle.examples; - - <function>Ds\Map::keys</function> example - - 1, "b" => 2, "c" => 3]); -var_dump($map->keys()); -?> -]]> - - &example.outputs.similar; - - - string(1) "a" - [1]=> - string(1) "b" - [2]=> - string(1) "c" -} -]]> - - - - - - - - diff --git a/reference/ds/ds/map/ksort.xml b/reference/ds/ds/map/ksort.xml deleted file mode 100644 index c5614fce1460..000000000000 --- a/reference/ds/ds/map/ksort.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - Ds\Map::ksort - - Sorts the map in-place by key - - - - - &reftitle.description; - - public voidDs\Map::ksort - callablecomparator - - - Sorts the map in-place by key, using an optional comparator function. - - - - - - &reftitle.parameters; - - - comparator - - &sort.callback.description; - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <function>Ds\Map::ksort</function> example - - 2, "c" => 3, "a" => 1]); -$map->ksort(); - -print_r($map); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => a - [value] => 1 - ) - - [1] => Ds\Pair Object - ( - [key] => b - [value] => 2 - ) - - [2] => Ds\Pair Object - ( - [key] => c - [value] => 3 - ) - -) -]]> - - - - <function>Ds\Map::ksort</function> example using a comparator - - "x", 2 => "y", 0 => "z"]); - -// Reverse -$map->ksort(function($a, $b) { - return $b <=> $a; -}); - -print_r($map); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => 2 - [value] => y - ) - - [1] => Ds\Pair Object - ( - [key] => 1 - [value] => x - ) - - [2] => Ds\Pair Object - ( - [key] => 0 - [value] => z - ) - -) -]]> - - - - - - - - - diff --git a/reference/ds/ds/map/ksorted.xml b/reference/ds/ds/map/ksorted.xml deleted file mode 100644 index dc12b7be4b6c..000000000000 --- a/reference/ds/ds/map/ksorted.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - Ds\Map::ksorted - Returns a copy, sorted by key - - - - &reftitle.description; - - public Ds\MapDs\Map::ksorted - callablecomparator - - - Returns a copy sorted by key, using an optional comparator function. - - - - - - &reftitle.parameters; - - - comparator - - &sort.callback.description; - - - - - - - &reftitle.returnvalues; - - Returns a copy of the map, sorted by key. - - - - - &reftitle.examples; - - <function>Ds\Map::ksorted</function> example - - 2, "c" => 3, "a" => 1]); - -print_r($map->ksorted()); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => a - [value] => 1 - ) - - [1] => Ds\Pair Object - ( - [key] => b - [value] => 2 - ) - - [2] => Ds\Pair Object - ( - [key] => c - [value] => 3 - ) - -) -]]> - - - - <function>Ds\Map::ksorted</function> example using a comparator - - "x", 2 => "y", 0 => "z"]); - -// Reverse -$sorted = $map->ksorted(function($a, $b) { - return $b <=> $a; -}); - -print_r($sorted); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => 2 - [value] => y - ) - - [1] => Ds\Pair Object - ( - [key] => 1 - [value] => x - ) - - [2] => Ds\Pair Object - ( - [key] => 0 - [value] => z - ) - -) -]]> - - - - - - - - - diff --git a/reference/ds/ds/map/last.xml b/reference/ds/ds/map/last.xml deleted file mode 100644 index 2b53f5bc7c54..000000000000 --- a/reference/ds/ds/map/last.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Ds\Map::last - Returns the last pair of the map - - - - &reftitle.description; - - public Ds\PairDs\Map::last - - - - Returns the last pair of the map. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The last pair of the map. - - - - - &reftitle.errors; - - UnderflowException if empty. - - - - - &reftitle.examples; - - <function>Ds\Map::last</function> example - - 1, "b" => 2, "c" => 3]); -var_dump($map->last()); -?> -]]> - - &example.outputs.similar; - - - string(1) "c" - ["value"]=> - int(3) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/map/map.xml b/reference/ds/ds/map/map.xml deleted file mode 100644 index 91c02ff65c97..000000000000 --- a/reference/ds/ds/map/map.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - Ds\Map::map - Returns the result of applying a callback to each value - - - - &reftitle.description; - - public Ds\MapDs\Map::map - callablecallback - - - Returns the result of applying a callback function to - each value of the map. - - - - - &reftitle.parameters; - - - callback - - - - mixed - callback - mixedkey - mixedvalue - - - - A callable to apply to each value in the map. - - - - The callable should return what the key will be mapped to in the - resulting map. - - - - - - - - - &reftitle.returnvalues; - - The result of applying a callback to each value in - the map. - - - - The keys and values of the current instance won't be affected. - - - - - - &reftitle.examples; - - <function>Ds\Map::map</function> example - - 1, "b" => 2, "c" => 3]); - -print_r($map->map(function($key, $value) { return $value * 2; })); -print_r($map); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => a - [value] => 2 - ) - - [1] => Ds\Pair Object - ( - [key] => b - [value] => 4 - ) - - [2] => Ds\Pair Object - ( - [key] => c - [value] => 6 - ) - -) -Ds\Map Object -( - [0] => Ds\Pair Object - ( - [key] => a - [value] => 1 - ) - - [1] => Ds\Pair Object - ( - [key] => b - [value] => 2 - ) - - [2] => Ds\Pair Object - ( - [key] => c - [value] => 3 - ) - -) -]]> - - - - - - - - diff --git a/reference/ds/ds/map/merge.xml b/reference/ds/ds/map/merge.xml deleted file mode 100644 index a21cc75bffd7..000000000000 --- a/reference/ds/ds/map/merge.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - Ds\Map::merge - Returns the result of adding all given associations - - - - &reftitle.description; - - public Ds\MapDs\Map::merge - mixedvalues - - - Returns the result of associating all keys of a given traversable - object or &array; with their corresponding values, combined with the current instance. - - - - - Values of the current instance will be overwritten by those provided where keys are equal. - - - - - - - &reftitle.parameters; - - - values - - - A traversable object or an &array;. - - - - - - - - &reftitle.returnvalues; - - The result of associating all keys of a given traversable - object or &array; with their corresponding values, combined with the current instance. - - - - The current instance won't be affected. - - - - - - &reftitle.examples; - - <function>Ds\Map::merge</function> example - - 1, "b" => 2, "c" => 3]); - -print_r($map->merge(["a" => 10, "e" => 50])); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => a - [value] => 10 - ) - - [1] => Ds\Pair Object - ( - [key] => b - [value] => 2 - ) - - [2] => Ds\Pair Object - ( - [key] => c - [value] => 3 - ) - - [3] => Ds\Pair Object - ( - [key] => e - [value] => 50 - ) - -) -]]> - - - - - - - - diff --git a/reference/ds/ds/map/pairs.xml b/reference/ds/ds/map/pairs.xml deleted file mode 100644 index c34a0749af8d..000000000000 --- a/reference/ds/ds/map/pairs.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Ds\Map::pairs - Returns a sequence containing all the pairs of the map - - - - &reftitle.description; - - public Ds\SequenceDs\Map::pairs - - - - Returns a Ds\Sequence containing all the pairs of the map. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Ds\Sequence containing all the pairs of the map. - - - - - &reftitle.examples; - - <function>Ds\Map::pairs</function> example - - 1, "b" => 2, "c" => 3]); - -var_dump($map->pairs()); -?> -]]> - - &example.outputs.similar; - - - object(Ds\Pair)#5 (2) { - ["key"]=> - string(1) "a" - ["value"]=> - int(1) - } - [1]=> - object(Ds\Pair)#6 (2) { - ["key"]=> - string(1) "b" - ["value"]=> - int(2) - } - [2]=> - object(Ds\Pair)#7 (2) { - ["key"]=> - string(1) "c" - ["value"]=> - int(3) - } -} -]]> - - - - - - - - diff --git a/reference/ds/ds/map/put.xml b/reference/ds/ds/map/put.xml deleted file mode 100644 index 78504d2711f9..000000000000 --- a/reference/ds/ds/map/put.xml +++ /dev/null @@ -1,256 +0,0 @@ - - - - - - Ds\Map::put - Associates a key with a value - - - - &reftitle.description; - - public voidDs\Map::put - mixedkey - mixedvalue - - - Associates a key with a value, - overwriting a previous association if one exists. - - - - - Keys of type object are supported. - - If an object implements Ds\Hashable, - equality will be determined by the object's equals function. - - If an object does not implement Ds\Hashable, - objects must be references to the same instance to be considered equal. - - - - - - You can also use array syntax to associate values by key, eg. $map["key"] = $value. - - - - - - Be careful when using array syntax. Scalar keys will be coerced to - integers by the engine. For example, $map["1"] will attempt - to access int(1), while $map->get("1") will - correctly look up the string key. - - - See Arrays. - - - - - - - &reftitle.parameters; - - - key - - - The key to associate the value with. - - - - - value - - - The value to be associated with the key. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <function>Ds\Map::put</function> example - -put("a", 1); -$map->put("b", 2); -$map->put("c", 3); - -print_r($map); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => a - [value] => 1 - ) - - [1] => Ds\Pair Object - ( - [key] => b - [value] => 2 - ) - - [2] => Ds\Pair Object - ( - [key] => c - [value] => 3 - ) - -) -]]> - - - - <function>Ds\Map::put</function> example using objects as keys - -value = $value; - } - - public function hash() - { - return $this->value; - } - - public function equals($obj): bool - { - return $this->value === $obj->value; - } -} - -$map = new \Ds\Map(); - -$obj = new \ArrayIterator([]); - -// Using the same instance multiple times will overwrite the previous value. -$map->put($obj, 1); -$map->put($obj, 2); - -// Using multiple instances of the same object will create new associations. -$map->put(new \stdClass(), 3); -$map->put(new \stdClass(), 4); - -// Using multiple instances of equal hashable objects will overwrite previous values. -$map->put(new \HashableObject(1), 5); -$map->put(new \HashableObject(1), 6); -$map->put(new \HashableObject(2), 7); -$map->put(new \HashableObject(2), 8); - -var_dump($map); -?> -]]> - - &example.outputs.similar; - - - object(Ds\Pair)#7 (2) { - ["key"]=> - object(ArrayIterator)#2 (1) { - ["storage":"ArrayIterator":private]=> - array(0) { - } - } - ["value"]=> - int(2) - } - [1]=> - object(Ds\Pair)#8 (2) { - ["key"]=> - object(stdClass)#3 (0) { - } - ["value"]=> - int(3) - } - [2]=> - object(Ds\Pair)#9 (2) { - ["key"]=> - object(stdClass)#4 (0) { - } - ["value"]=> - int(4) - } - [3]=> - object(Ds\Pair)#10 (2) { - ["key"]=> - object(HashableObject)#5 (1) { - ["value":"HashableObject":private]=> - int(1) - } - ["value"]=> - int(6) - } - [4]=> - object(Ds\Pair)#11 (2) { - ["key"]=> - object(HashableObject)#6 (1) { - ["value":"HashableObject":private]=> - int(2) - } - ["value"]=> - int(8) - } -} -]]> - - - - - - - - diff --git a/reference/ds/ds/map/putAll.xml b/reference/ds/ds/map/putAll.xml deleted file mode 100644 index 1f4a613db37c..000000000000 --- a/reference/ds/ds/map/putAll.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - Ds\Map::putAll - Associates all key-value pairs of a traversable object or array - - - - &reftitle.description; - - public voidDs\Map::putAll - mixedpairs - - - Associates all key-value pairs of a traversable object or &array;. - - - - - Keys of type object are supported. - - If an object implements Ds\Hashable, - equality will be determined by the object's equals function. - - If an object does not implement Ds\Hashable, - objects must be references to the same instance to be considered equal. - - - - - - - &reftitle.parameters; - - - pairs - - - traversable object or &array;. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <function>Ds\Map::putAll</function> example - -putAll([ - "a" => 1, - "b" => 2, - "c" => 3, -]); - -print_r($map); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => a - [value] => 1 - ) - - [1] => Ds\Pair Object - ( - [key] => b - [value] => 2 - ) - - [2] => Ds\Pair Object - ( - [key] => c - [value] => 3 - ) - -) -]]> - - - - - - - - - diff --git a/reference/ds/ds/map/reduce.xml b/reference/ds/ds/map/reduce.xml deleted file mode 100644 index a8f4d466be2b..000000000000 --- a/reference/ds/ds/map/reduce.xml +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - Ds\Map::reduce - Reduces the map to a single value using a callback function - - - - &reftitle.description; - - public mixedDs\Map::reduce - callablecallback - mixedinitial - - - Reduces the map to a single value using a callback function. - - - - - - &reftitle.parameters; - - - callback - - - - mixedcallback - mixedcarry - mixedkey - mixedvalue - - - - carry - - - The return value of the previous callback, or initial if - it's the first iteration. - - - - - key - - - The key of the current iteration. - - - - - value - - - The value of the current iteration. - - - - - - - - - initial - - - The initial value of the carry value. Can be &null;. - - - - - - - - &reftitle.returnvalues; - - The return value of the final callback. - - - - - &reftitle.examples; - - <function>Ds\Map::reduce</function> with initial value example - - 1, "b" => 2, "c" => 3]); - -$callback = function($carry, $key, $value) { - return $carry * $value; -}; - -var_dump($map->reduce($callback, 5)); - -// Iterations: -// -// $carry = $initial = 5 -// -// $carry = $carry * 1 = 5 -// $carry = $carry * 2 = 10 -// $carry = $carry * 3 = 30 -?> -]]> - - &example.outputs.similar; - - - - - - <function>Ds\Map::reduce</function> without an initial value example - - 1, "b" => 2, "c" => 3]); - -var_dump($map->reduce(function($carry, $key, $value) { - return $carry + $value + 5; -})); - -// Iterations: -// -// $carry = $initial = null -// -// $carry = $carry + 1 + 5 = 6 -// $carry = $carry + 2 + 5 = 13 -// $carry = $carry + 3 + 5 = 21 -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/map/remove.xml b/reference/ds/ds/map/remove.xml deleted file mode 100644 index 71d8cd3bc171..000000000000 --- a/reference/ds/ds/map/remove.xml +++ /dev/null @@ -1,138 +0,0 @@ - - - - - - Ds\Map::remove - Removes and returns a value by key - - - - &reftitle.description; - - public mixedDs\Map::remove - mixedkey - mixeddefault - - - Removes and returns a value by key, or return an optional default value if the key - could not be found. - - - - - Keys of type object are supported. - - If an object implements Ds\Hashable, - equality will be determined by the object's equals function. - - If an object does not implement Ds\Hashable, - objects must be references to the same instance to be considered equal. - - - - - - You can also use array syntax to access values by key, eg. $map["key"]. - - - - - - Be careful when using array syntax. Scalar keys will be coerced to - integers by the engine. For example, $map["1"] will attempt - to access int(1), while $map->get("1") will - correctly look up the string key. - - - See Arrays. - - - - - - - &reftitle.parameters; - - - key - - - The key to remove. - - - - - default - - - The optional default value, returned if the key could not be found. - - - - - - - - &reftitle.returnvalues; - - The value that was removed, or the default - value if provided and the key could not be found in the map. - - - - - &reftitle.errors; - - OutOfBoundsException if the key could not be found - and a default value was not provided. - - - - - &reftitle.examples; - - <function>Ds\Map::remove</function> example - - 1, "b" => 2, "c" => 3]); - -var_dump($map->remove("a")); // 1 -var_dump($map->remove("e", 10)); // 10 (default used) -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/map/reverse.xml b/reference/ds/ds/map/reverse.xml deleted file mode 100644 index ca144d868c4d..000000000000 --- a/reference/ds/ds/map/reverse.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - Ds\Map::reverse - - Reverses the map in-place - - - - - &reftitle.description; - - public voidDs\Map::reverse - - - - Reverses the map in-place. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <function>Ds\Map::reverse</function> example - - 1, "b" => 2, "c" => 3]); -$map->reverse(); - -print_r($map); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => c - [value] => 3 - ) - - [1] => Ds\Pair Object - ( - [key] => b - [value] => 2 - ) - - [2] => Ds\Pair Object - ( - [key] => a - [value] => 1 - ) - -) -]]> - - - - - - - - diff --git a/reference/ds/ds/map/reversed.xml b/reference/ds/ds/map/reversed.xml deleted file mode 100644 index 097c3e8d3429..000000000000 --- a/reference/ds/ds/map/reversed.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Ds\Map::reversed - Returns a reversed copy - - - - &reftitle.description; - - public Ds\MapDs\Map::reversed - - - - Returns a reversed copy of the map. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A reversed copy of the map. - - - - The current instance is not affected. - - - - - - - &reftitle.examples; - - <function>Ds\Map::reversed</function> example - - 1, "b" => 2, "c" => 3]); - -print_r($map->reversed()); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => c - [value] => 3 - ) - - [1] => Ds\Pair Object - ( - [key] => b - [value] => 2 - ) - - [2] => Ds\Pair Object - ( - [key] => a - [value] => 1 - ) - -) -]]> - - - - - - - - diff --git a/reference/ds/ds/map/skip.xml b/reference/ds/ds/map/skip.xml deleted file mode 100644 index 1cddb5db5029..000000000000 --- a/reference/ds/ds/map/skip.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - Ds\Map::skip - Returns the pair at a given positional index - - - - &reftitle.description; - - public Ds\PairDs\Map::skip - intposition - - - Returns the pair at a given zero-based position. - - - - - - &reftitle.parameters; - - - position - - - The zero-based positional index to return. - - - - - - - - &reftitle.returnvalues; - - Returns the Ds\Pair at the given position. - - - - - &reftitle.errors; - - OutOfRangeException if the position is not valid. - - - - - &reftitle.examples; - - <function>Ds\Map::skip</function> example - - 1, "b" => 2, "c" => 3]); - -var_dump($map->skip(1)); -?> -]]> - - &example.outputs.similar; - - - string(1) "b" - ["value"]=> - int(2) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/map/slice.xml b/reference/ds/ds/map/slice.xml deleted file mode 100644 index 901059a9eef7..000000000000 --- a/reference/ds/ds/map/slice.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - - - Ds\Map::slice - - Returns a subset of the map defined by a starting index and length - - - - - &reftitle.description; - - public Ds\MapDs\Map::slice - intindex - intlength - - - Returns a subset of the map defined by a starting index and length. - - - - - - &reftitle.parameters; - - - index - - - The index at which the range starts. - - - If positive, the range will start at that index in the map. - If negative, the range will start that far from the end. - - - - - length - - - If a length is given and is positive, the resulting - map will have up to that many pairs in it. - - If a length is given and is negative, the range - will stop that many pairs from the end. - - If the length results in an overflow, only - pairs up to the end of the map will be included. - - If a length is not provided, the resulting map - will contain all pairs between the index and the - end of the map. - - - - - - - - &reftitle.returnvalues; - - A subset of the map defined by a starting index and length. - - - - - &reftitle.examples; - - <function>Ds\Map::slice</function> example - - 1, "b" => 2, "c" => 3, "d" => 4, "e" => 5]); - -// Slice from 2 onwards -print_r($map->slice(2)->toArray()); - -// Slice from 1, for a length of 3 -print_r($map->slice(1, 3)->toArray()); - -// Slice from 1 onwards -print_r($map->slice(1)->toArray()); - -// Slice from 2 from the end onwards -print_r($map->slice(-2)->toArray()); - -// Slice from 1 to 1 from the end -print_r($map->slice(1, -1)->toArray()); -?> -]]> - - &example.outputs.similar; - - 3 - [d] => 4 - [e] => 5 -) -Array -( - [b] => 2 - [c] => 3 - [d] => 4 -) -Array -( - [b] => 2 - [c] => 3 - [d] => 4 - [e] => 5 -) -Array -( - [d] => 4 - [e] => 5 -) -Array -( - [b] => 2 - [c] => 3 - [d] => 4 -) -]]> - - - - - - - - diff --git a/reference/ds/ds/map/sort.xml b/reference/ds/ds/map/sort.xml deleted file mode 100644 index 723f6274d7fb..000000000000 --- a/reference/ds/ds/map/sort.xml +++ /dev/null @@ -1,151 +0,0 @@ - - - - - - Ds\Map::sort - - Sorts the map in-place by value - - - - - &reftitle.description; - - public voidDs\Map::sort - callablecomparator - - - Sorts the map in-place by value, using an optional comparator function. - - - - - - &reftitle.parameters; - - - comparator - - &sort.callback.description; - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <function>Ds\Map::sort</function> example - - 2, "b" => 3, "c" => 1]); -$map->sort(); - -print_r($map); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => c - [value] => 1 - ) - - [1] => Ds\Pair Object - ( - [key] => a - [value] => 2 - ) - - [2] => Ds\Pair Object - ( - [key] => b - [value] => 3 - ) - -) -]]> - - - - <function>Ds\Map::sort</function> example using a comparator - - 2, "b" => 3, "c" => 1]); - -$map->sort(function($a, $b) { - return $b <=> $a; -}); - -print_r($map); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => b - [value] => 3 - ) - - [1] => Ds\Pair Object - ( - [key] => a - [value] => 2 - ) - - [2] => Ds\Pair Object - ( - [key] => c - [value] => 1 - ) - -) -]]> - - - - - - - - - diff --git a/reference/ds/ds/map/sorted.xml b/reference/ds/ds/map/sorted.xml deleted file mode 100644 index f02d6cedeb78..000000000000 --- a/reference/ds/ds/map/sorted.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - Ds\Map::sorted - Returns a copy, sorted by value - - - - &reftitle.description; - - public Ds\MapDs\Map::sorted - callablecomparator - - - Returns a copy, sorted by value using an optional comparator function. - - - - - - &reftitle.parameters; - - - comparator - - &sort.callback.description; - - - - - - - &reftitle.returnvalues; - - Returns a copy of the map, sorted by value. - - - - - &reftitle.examples; - - <function>Ds\Map::sort</function> example - - 2, "b" => 3, "c" => 1]); - -print_r($map->sorted()); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => c - [value] => 1 - ) - - [1] => Ds\Pair Object - ( - [key] => a - [value] => 2 - ) - - [2] => Ds\Pair Object - ( - [key] => b - [value] => 3 - ) - -) -]]> - - - - <function>Ds\Map::sort</function> example using a comparator - - 2, "b" => 3, "c" => 1]); - -// Reverse -$sorted = $map->sorted(function($a, $b) { - return $b <=> $a; -}); - -print_r($sorted); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => b - [value] => 3 - ) - - [1] => Ds\Pair Object - ( - [key] => a - [value] => 2 - ) - - [2] => Ds\Pair Object - ( - [key] => c - [value] => 1 - ) - -) -]]> - - - - - - - - diff --git a/reference/ds/ds/map/sum.xml b/reference/ds/ds/map/sum.xml deleted file mode 100644 index 9bf04d890e5d..000000000000 --- a/reference/ds/ds/map/sum.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Ds\Map::sum - Returns the sum of all values in the map - - - - &reftitle.description; - - public intfloatDs\Map::sum - - - - Returns the sum of all values in the map. - - - - Arrays and objects are considered equal to zero when calculating the sum. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The sum of all the values in the map as either a float or int - depending on the values in the map. - - - - - &reftitle.examples; - - <function>Ds\Map::sum</function> integer example - - 1, "b" => 2, "c" => 3]); -var_dump($map->sum()); -?> -]]> - - &example.outputs.similar; - - - - - - <function>Ds\Map::sum</function> float example - - 1, "b" => 2.5, "c" => 3]); -var_dump($map->sum()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/map/toarray.xml b/reference/ds/ds/map/toarray.xml deleted file mode 100644 index 4b30278d641a..000000000000 --- a/reference/ds/ds/map/toarray.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - Ds\Map::toArray - - Converts the map to an &array; - - - - - &reftitle.description; - - public arrayDs\Map::toArray - - - - Converts the map to an &array;. - - - - Maps with non-scalar keys can't be converted to an &array;. - - - - - An &array; will treat all numeric keys as integers, - eg. "1" and 1 as keys in the map - will only result in 1 being included in the array. - - - - - Casting to an &array; is not supported yet. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - An &array; containing all the values in the same order as the map. - - - - - &reftitle.examples; - - <function>Ds\Map::toArray</function> example - - 1, - "b" => 2, - "c" => 3, -]); - -var_dump($map->toArray()); -?> -]]> - - &example.outputs.similar; - - - int(1) - ["b"]=> - int(2) - ["c"]=> - int(3) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/map/union.xml b/reference/ds/ds/map/union.xml deleted file mode 100644 index f5064677a288..000000000000 --- a/reference/ds/ds/map/union.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - Ds\Map::union - Creates a new map using values from the current instance and another map - - - - &reftitle.description; - - public Ds\MapDs\Map::union - Ds\Mapmap - - - Creates a new map that contains the pairs of the current instance as well as the - pairs of another map. - - - A ∪ B = {x: x ∈ A ∨ x ∈ B} - - - - - Values of the current instance will be overwritten by those provided where keys are equal. - - - - - - - &reftitle.parameters; - - - map - - - The other map, to combine with the current instance. - - - - - - - - &reftitle.returnvalues; - - A new map containing all the pairs of the current instance as well as another map. - - - - - &reftitle.seealso; - - - Union on Wikipedia - - - - - - &reftitle.examples; - - <function>Ds\Map::union</function> example - - 1, "b" => 2, "c" => 3]); -$b = new \Ds\Map(["b" => 3, "c" => 4, "d" => 5]); - -print_r($a->union($b)); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => a - [value] => 1 - ) - - [1] => Ds\Pair Object - ( - [key] => b - [value] => 3 - ) - - [2] => Ds\Pair Object - ( - [key] => c - [value] => 4 - ) - - [3] => Ds\Pair Object - ( - [key] => d - [value] => 5 - ) - -) -]]> - - - - - - - - diff --git a/reference/ds/ds/map/values.xml b/reference/ds/ds/map/values.xml deleted file mode 100644 index bf14f0206a5f..000000000000 --- a/reference/ds/ds/map/values.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - Ds\Map::values - Returns a sequence of the map's values - - - - &reftitle.description; - - public Ds\SequenceDs\Map::values - - - - Returns a sequence containing all the values of the map, in the same order. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A Ds\Sequence containing all the values of the map. - - - - - &reftitle.examples; - - <function>Ds\Map::values</function> example - - 1, "b" => 2, "c" => 3]); -var_dump($map->values()); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) - [2]=> - int(3) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/map/xor.xml b/reference/ds/ds/map/xor.xml deleted file mode 100644 index 53c60982cb79..000000000000 --- a/reference/ds/ds/map/xor.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - Ds\Map::xor - Creates a new map using keys of either the current instance or of another map, but not of both - - - - &reftitle.description; - - public Ds\MapDs\Map::xor - Ds\Mapmap - - - Creates a new map containing keys of the current instance as well as another map, - but not of both. - - - A ⊖ B = {x : x ∈ (A \ B) ∪ (B \ A)} - - - - - &reftitle.parameters; - - - map - - - The other map. - - - - - - - - &reftitle.returnvalues; - - A new map containing keys in the current instance as well as another map, - but not in both. - - - - - &reftitle.seealso; - - - Symmetric Difference on Wikipedia - - - - - - &reftitle.examples; - - <function>Ds\Map::xor</function> example - - 1, "b" => 2, "c" => 3]); -$b = new \Ds\Map(["b" => 4, "c" => 5, "d" => 6]); - -print_r($a->xor($b)); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => a - [value] => 1 - ) - - [1] => Ds\Pair Object - ( - [key] => d - [value] => 6 - ) - -) -]]> - - - - - - - - diff --git a/reference/ds/ds/pair/clear.xml b/reference/ds/ds/pair/clear.xml deleted file mode 100644 index 37651d88c694..000000000000 --- a/reference/ds/ds/pair/clear.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - Ds\Pair::clear - Removes all values - - - - &reftitle.description; - - public voidDs\Pair::clear - - - - Removes all values from the pair. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <function>Ds\Pair::clear</function> example - -clear(); -print_r($pair); -?> -]]> - - &example.outputs.similar; - - a - [value] => 1 -) -Ds\Pair Object -( -) -]]> - - - - - - - - diff --git a/reference/ds/ds/pair/construct.xml b/reference/ds/ds/pair/construct.xml deleted file mode 100644 index 723822a21484..000000000000 --- a/reference/ds/ds/pair/construct.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - Ds\Pair::__construct - Creates a new instance - - - - &reftitle.description; - - public Ds\Pair::__construct - mixedkey - mixedvalue - - - Creates a new instance using a given key and value. - - - - - - &reftitle.parameters; - - - key - - - The key. - - - - - value - - - The value. - - - - - - - - - - - - diff --git a/reference/ds/ds/pair/copy.xml b/reference/ds/ds/pair/copy.xml deleted file mode 100644 index f2b8481072be..000000000000 --- a/reference/ds/ds/pair/copy.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - Ds\Pair::copy - Returns a shallow copy of the pair - - - - &reftitle.description; - - public Ds\PairDs\Pair::copy - - - - Returns a shallow copy of the pair. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a shallow copy of the pair. - - - - - &reftitle.examples; - - <function>Ds\Pair::copy</function> example - -copy(); - -$a->key = "x"; - -print_r($a); -print_r($b); -?> -]]> - - &example.outputs.similar; - - x - [value] => 1 -) -Ds\Pair Object -( - [key] => a - [value] => 1 -) -]]> - - - - - - - - diff --git a/reference/ds/ds/pair/isempty.xml b/reference/ds/ds/pair/isempty.xml deleted file mode 100644 index 240f54c7b928..000000000000 --- a/reference/ds/ds/pair/isempty.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - Ds\Pair::isEmpty - Returns whether the pair is empty - - - - &reftitle.description; - - public boolDs\Pair::isEmpty - - - - Returns whether the pair is empty. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; if the pair is empty, &false; otherwise. - - - - - &reftitle.examples; - - <function>Ds\Pair::isEmpty</function> example - -isEmpty()); -var_dump($b->isEmpty()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/pair/jsonserialize.xml b/reference/ds/ds/pair/jsonserialize.xml deleted file mode 100644 index 1f778e0d0905..000000000000 --- a/reference/ds/ds/pair/jsonserialize.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - - Ds\Pair::jsonSerialize - Returns a representation that can be converted to JSON - - - - &reftitle.description; - - See JsonSerializable::jsonSerialize - - - - You should never need to call this directly. - - - - - - - diff --git a/reference/ds/ds/pair/toarray.xml b/reference/ds/ds/pair/toarray.xml deleted file mode 100644 index d7ef6383996e..000000000000 --- a/reference/ds/ds/pair/toarray.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - Ds\Pair::toArray - - Converts the pair to an &array; - - - - - &reftitle.description; - - public arrayDs\Pair::toArray - - - - Converts the pair to an &array;. - - - - Casting to an &array; is not supported yet. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - An &array; containing all the values in the same order as the pair. - - - - - &reftitle.examples; - - <function>Ds\Pair::toArray</function> example - -toArray()); -?> -]]> - - &example.outputs.similar; - - - string(1) "a" - ["value"]=> - int(1) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/priorityqueue/allocate.xml b/reference/ds/ds/priorityqueue/allocate.xml deleted file mode 100644 index 30e71e0623ed..000000000000 --- a/reference/ds/ds/priorityqueue/allocate.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - Ds\PriorityQueue::allocate - Allocates enough memory for a required capacity - - - - &reftitle.description; - - public voidDs\PriorityQueue::allocate - intcapacity - - - Ensures that enough memory is allocated for a required capacity. - This removes the need to reallocate the internal buffer as values are added. - - - - - &reftitle.parameters; - - - capacity - - - The number of values for which capacity should be allocated. - - - - Capacity will stay the same if this value is less than or equal to the - current capacity. - - - - - Capacity will always be rounded up to the nearest power of 2. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - &reftitle.examples; - - <function>Ds\PriorityQueue::allocate</function> example - -capacity()); - -$queue->allocate(100); -var_dump($queue->capacity()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/priorityqueue/capacity.xml b/reference/ds/ds/priorityqueue/capacity.xml deleted file mode 100644 index 65e343f3542b..000000000000 --- a/reference/ds/ds/priorityqueue/capacity.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - Ds\PriorityQueue::capacity - Returns the current capacity - - - - &reftitle.description; - - public intDs\PriorityQueue::capacity - - - - Returns the current capacity. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The current capacity. - - - - - &reftitle.examples; - - <function>Ds\PriorityQueue::capacity</function> example - -capacity()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/priorityqueue/clear.xml b/reference/ds/ds/priorityqueue/clear.xml deleted file mode 100644 index 326a08f377aa..000000000000 --- a/reference/ds/ds/priorityqueue/clear.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - Ds\PriorityQueue::clear - Removes all values - - - - &reftitle.description; - - public voidDs\PriorityQueue::clear - - - - Removes all values from the queue. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <function>Ds\PriorityQueue::clear</function> example - -push("a", 5); -$queue->push("b", 15); -$queue->push("c", 10); - -$queue->clear(); -print_r($queue); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/priorityqueue/construct.xml b/reference/ds/ds/priorityqueue/construct.xml deleted file mode 100644 index bdd9a49b6a2d..000000000000 --- a/reference/ds/ds/priorityqueue/construct.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - Ds\PriorityQueue::__construct - Creates a new instance - - - - &reftitle.description; - - public Ds\PriorityQueue::__construct - - - - Creates a new instance. - - - - - - - - &reftitle.examples; - - <function>Ds\PriorityQueue::__construct</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/priorityqueue/copy.xml b/reference/ds/ds/priorityqueue/copy.xml deleted file mode 100644 index 559bacdb299f..000000000000 --- a/reference/ds/ds/priorityqueue/copy.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - Ds\PriorityQueue::copy - Returns a shallow copy of the queue - - - - &reftitle.description; - - public Ds\PriorityQueueDs\PriorityQueue::copy - - - - Returns a shallow copy of the queue. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a shallow copy of the queue. - - - - - &reftitle.examples; - - <function>Ds\PriorityQueue::copy</function> example - -push("a", 5); -$queue->push("b", 15); -$queue->push("c", 10); - -print_r($queue->copy()); -?> -]]> - - &example.outputs.similar; - - b - [1] => c - [2] => a -) -]]> - - - - - - - - diff --git a/reference/ds/ds/priorityqueue/count.xml b/reference/ds/ds/priorityqueue/count.xml deleted file mode 100644 index 0899f775af23..000000000000 --- a/reference/ds/ds/priorityqueue/count.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - - - - Ds\PriorityQueue::count - Returns the number of values in the queue - - - - &reftitle.description; - - See Countable::count - - - - - diff --git a/reference/ds/ds/priorityqueue/isempty.xml b/reference/ds/ds/priorityqueue/isempty.xml deleted file mode 100644 index b8f39f9f8794..000000000000 --- a/reference/ds/ds/priorityqueue/isempty.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - Ds\PriorityQueue::isEmpty - Returns whether the queue is empty - - - - &reftitle.description; - - public boolDs\PriorityQueue::isEmpty - - - - Returns whether the queue is empty. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; if the queue is empty, &false; otherwise. - - - - - &reftitle.examples; - - <function>Ds\PriorityQueue::isEmpty</function> example - -push("a", 5); -$a->push("b", 15); -$a->push("c", 10); - -var_dump($a->isEmpty()); -var_dump($b->isEmpty()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/priorityqueue/jsonserialize.xml b/reference/ds/ds/priorityqueue/jsonserialize.xml deleted file mode 100644 index f2bbd4d2c58f..000000000000 --- a/reference/ds/ds/priorityqueue/jsonserialize.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - - Ds\PriorityQueue::jsonSerialize - Returns a representation that can be converted to JSON - - - - &reftitle.description; - - See JsonSerializable::jsonSerialize - - - - You should never need to call this directly. - - - - - - diff --git a/reference/ds/ds/priorityqueue/peek.xml b/reference/ds/ds/priorityqueue/peek.xml deleted file mode 100644 index aaad62faf226..000000000000 --- a/reference/ds/ds/priorityqueue/peek.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Ds\PriorityQueue::peek - Returns the value at the front of the queue - - - - &reftitle.description; - - public mixedDs\PriorityQueue::peek - - - - Returns the value at the front of the queue, but does not remove it. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The value at the front of the queue. - - - - - &reftitle.errors; - - UnderflowException if empty. - - - - - &reftitle.examples; - - <function>Ds\PriorityQueue::peek</function> example - -push("a", 5); -$queue->push("b", 15); -$queue->push("c", 10); - -var_dump($queue->peek()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/priorityqueue/pop.xml b/reference/ds/ds/priorityqueue/pop.xml deleted file mode 100644 index b7050f106080..000000000000 --- a/reference/ds/ds/priorityqueue/pop.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - Ds\PriorityQueue::pop - Removes and returns the value with the highest priority - - - - &reftitle.description; - - public mixedDs\PriorityQueue::pop - - - - Removes and returns the value at the front of the queue, ie. the value - with the highest priority. - - - - Values with equal priority fall back to FIFO (first in first out). - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The removed value which was at the front of the queue. - - - - - &reftitle.errors; - - UnderflowException if empty. - - - - - &reftitle.examples; - - <function>Ds\PriorityQueue::pop</function> example - -push("a", 5); -$queue->push("b", 15); -$queue->push("c", 10); - -print_r($queue->pop()); -print_r($queue->pop()); -print_r($queue->pop()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/priorityqueue/push.xml b/reference/ds/ds/priorityqueue/push.xml deleted file mode 100644 index f16171d87c26..000000000000 --- a/reference/ds/ds/priorityqueue/push.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Ds\PriorityQueue::push - Pushes values into the queue - - - - &reftitle.description; - - public voidDs\PriorityQueue::push - mixedvalue - intpriority - - - Pushes a value with a given priority into the queue. - - - - - - &reftitle.parameters; - - - value - - - The value to push into the queue. - - - - - priority - - - The priority associated with the value. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <function>Ds\PriorityQueue::push</function> example - -push("a", 5); -$queue->push("b", 15); -$queue->push("c", 10); - -print_r($queue->pop()); -print_r($queue->pop()); -print_r($queue->pop()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/priorityqueue/toarray.xml b/reference/ds/ds/priorityqueue/toarray.xml deleted file mode 100644 index f38b60466c94..000000000000 --- a/reference/ds/ds/priorityqueue/toarray.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - Ds\PriorityQueue::toArray - - Converts the queue to an &array; - - - - - &reftitle.description; - - public arrayDs\PriorityQueue::toArray - - - - Converts the queue to an &array;. - - - - This method is not destructive. - - - - - Casting to an &array; is not supported yet. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - An &array; containing all the values in the same order as the queue. - - - - - &reftitle.examples; - - <function>Ds\PriorityQueue::toArray</function> example - -push("a", 5); -$queue->push("b", 15); -$queue->push("c", 10); - -var_dump($queue->toArray()); -?> -]]> - - &example.outputs.similar; - - - string(1) "b" - [1]=> - string(1) "c" - [2]=> - string(1) "a" -} -]]> - - - - - - - - diff --git a/reference/ds/ds/queue/allocate.xml b/reference/ds/ds/queue/allocate.xml deleted file mode 100644 index 976a84600aa4..000000000000 --- a/reference/ds/ds/queue/allocate.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - Ds\Queue::allocate - Allocates enough memory for a required capacity - - - - &reftitle.description; - - public voidDs\Queue::allocate - intcapacity - - - Ensures that enough memory is allocated for a required capacity. - This removes the need to reallocate the internal buffer as values are added. - - - - Capacity will always be rounded up to the nearest power of 2. - - - - - - &reftitle.parameters; - - - capacity - - - The number of values for which capacity should be allocated. - - - - Capacity will stay the same if this value is less than or equal to the - current capacity. - - - - - Capacity will always be rounded up to the nearest power of 2. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <function>Ds\Queue::allocate</function> example - -capacity()); - -$queue->allocate(100); -var_dump($queue->capacity()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/queue/capacity.xml b/reference/ds/ds/queue/capacity.xml deleted file mode 100644 index d1ab1de10fc4..000000000000 --- a/reference/ds/ds/queue/capacity.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - Ds\Queue::capacity - Returns the current capacity - - - - &reftitle.description; - - public intDs\Queue::capacity - - - - Returns the current capacity. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The current capacity. - - - - - &reftitle.examples; - - <function>Ds\Queue::capacity</function> example - -capacity()); - -$queue->push(...range(1, 50)); -var_dump($queue->capacity()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/queue/clear.xml b/reference/ds/ds/queue/clear.xml deleted file mode 100644 index 9dfcda362e6d..000000000000 --- a/reference/ds/ds/queue/clear.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - Ds\Queue::clear - Removes all values - - - - &reftitle.description; - - public voidDs\Queue::clear - - - - Removes all values from the queue. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <function>Ds\Queue::clear</function> example - -clear(); -print_r($queue); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 -) -Ds\Queue Object -( -) -]]> - - - - - - - - diff --git a/reference/ds/ds/queue/construct.xml b/reference/ds/ds/queue/construct.xml deleted file mode 100644 index 51d59eef4a43..000000000000 --- a/reference/ds/ds/queue/construct.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Ds\Queue::__construct - Creates a new instance - - - - &reftitle.description; - - public Ds\Queue::__construct - mixedvalues - - - Creates a new instance, using either a traversable - object or an &array; for the initial values. - - - - - &reftitle.parameters; - - - values - - - A traversable object or an &array; to use for the initial values. - - - - - - - - - - - &reftitle.examples; - - <function>Ds\Queue::__construct</function> example - - -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) - [2]=> - int(3) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/queue/copy.xml b/reference/ds/ds/queue/copy.xml deleted file mode 100644 index 11489c17344d..000000000000 --- a/reference/ds/ds/queue/copy.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - Ds\Queue::copy - Returns a shallow copy of the queue - - - - &reftitle.description; - - public Ds\QueueDs\Queue::copy - - - - Returns a shallow copy of the queue. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a shallow copy of the queue. - - - - - &reftitle.examples; - - <function>Ds\Queue::copy</function> example - -copy(); - -// Updating the copy doesn't affect the original -$b->push(4); - -print_r($a); -print_r($b); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 -) -Ds\Queue Object -( - [0] => 1 - [1] => 2 - [2] => 3 - [3] => 4 -) -]]> - - - - - - - - diff --git a/reference/ds/ds/queue/count.xml b/reference/ds/ds/queue/count.xml deleted file mode 100644 index 1ec916c88320..000000000000 --- a/reference/ds/ds/queue/count.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - - Ds\Queue::count - Returns the number of values in the queue - - - - &reftitle.description; - - See Countable::count - - - - - - diff --git a/reference/ds/ds/queue/isempty.xml b/reference/ds/ds/queue/isempty.xml deleted file mode 100644 index a8a1d0ce798a..000000000000 --- a/reference/ds/ds/queue/isempty.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - Ds\Queue::isEmpty - Returns whether the queue is empty - - - - &reftitle.description; - - public boolDs\Queue::isEmpty - - - - Returns whether the queue is empty. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; if the queue is empty, &false; otherwise. - - - - - &reftitle.examples; - - <function>Ds\Queue::isEmpty</function> example - -isEmpty()); -var_dump($b->isEmpty()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/queue/jsonserialize.xml b/reference/ds/ds/queue/jsonserialize.xml deleted file mode 100644 index 26513d0511a7..000000000000 --- a/reference/ds/ds/queue/jsonserialize.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - - Ds\Queue::jsonSerialize - Returns a representation that can be converted to JSON - - - - &reftitle.description; - - See JsonSerializable::jsonSerialize - - - - You should never need to call this directly. - - - - - - - diff --git a/reference/ds/ds/queue/peek.xml b/reference/ds/ds/queue/peek.xml deleted file mode 100644 index 57371f8febce..000000000000 --- a/reference/ds/ds/queue/peek.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Ds\Queue::peek - Returns the value at the front of the queue - - - - &reftitle.description; - - public mixedDs\Queue::peek - - - - Returns the value at the front of the queue, but does not remove it. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The value at the front of the queue. - - - - - &reftitle.errors; - - UnderflowException if empty. - - - - - &reftitle.examples; - - <function>Ds\Queue::peek</function> example - -push("a"); -$queue->push("b"); -$queue->push("c"); - -var_dump($queue->peek()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/queue/pop.xml b/reference/ds/ds/queue/pop.xml deleted file mode 100644 index 3d098b733605..000000000000 --- a/reference/ds/ds/queue/pop.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - Ds\Queue::pop - Removes and returns the value at the front of the queue - - - - &reftitle.description; - - public mixedDs\Queue::pop - - - - Removes and returns the value at the front of the queue. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The removed value which was at the front of the queue. - - - - - &reftitle.errors; - - UnderflowException if empty. - - - - - &reftitle.examples; - - <function>Ds\Queue::pop</function> example - -push("a"); -$queue->push("b"); -$queue->push("c"); - -var_dump($queue->pop()); -var_dump($queue->pop()); -var_dump($queue->pop()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/queue/push.xml b/reference/ds/ds/queue/push.xml deleted file mode 100644 index 759df53ec3b1..000000000000 --- a/reference/ds/ds/queue/push.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Ds\Queue::push - Pushes values into the queue - - - - &reftitle.description; - - public voidDs\Queue::push - mixedvalues - - - Pushes values into the queue. - - - - - - &reftitle.parameters; - - - values - - - The values to push into the queue. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <function>Ds\Queue::push</function> example - -push("a"); -$queue->push("b"); -$queue->push("c", "d"); -$queue->push(...["e", "f"]); - -print_r($queue); -?> -]]> - - &example.outputs.similar; - - a - [1] => b - [2] => c - [3] => d - [4] => e - [5] => f -) -]]> - - - - - - - - diff --git a/reference/ds/ds/queue/toarray.xml b/reference/ds/ds/queue/toarray.xml deleted file mode 100644 index 2da9aa766bc9..000000000000 --- a/reference/ds/ds/queue/toarray.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - Ds\Queue::toArray - - Converts the queue to an &array; - - - - - &reftitle.description; - - public arrayDs\Queue::toArray - - - - Converts the queue to an &array;. - - - - Casting to an &array; is not supported yet. - - - - - This method is not destructive. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - An &array; containing all the values in the same order as the queue. - - - - - &reftitle.examples; - - <function>Ds\Queue::toArray</function> example - -toArray()); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) - [2]=> - int(3) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/sequence/allocate.xml b/reference/ds/ds/sequence/allocate.xml deleted file mode 100644 index 98b6aff42bdf..000000000000 --- a/reference/ds/ds/sequence/allocate.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - Ds\Sequence::allocate - Allocates enough memory for a required capacity - - - - &reftitle.description; - - abstract public voidDs\Sequence::allocate - intcapacity - - - Ensures that enough memory is allocated for a required capacity. - This removes the need to reallocate the internal buffer as values are added. - - - - - &reftitle.parameters; - - - capacity - - - The number of values for which capacity should be allocated. - - - - Capacity will stay the same if this value is less than or equal to the - current capacity. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <function>Ds\Sequence::allocate</function> example - -capacity()); - -$vector->allocate(100); -var_dump($sequence->capacity()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/sequence/apply.xml b/reference/ds/ds/sequence/apply.xml deleted file mode 100644 index 4d67a5f45fda..000000000000 --- a/reference/ds/ds/sequence/apply.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - Ds\Sequence::apply - Updates all values by applying a callback function to each value - - - - &reftitle.description; - - abstract public voidDs\Sequence::apply - callablecallback - - - Updates all values by applying a callback function to - each value in the sequence. - - - - - &reftitle.parameters; - - - callback - - - - - mixed - callback - mixedvalue - - - - A callable to apply to each value in the sequence. - - - - The callback should return what the value should be replaced by. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <function>Ds\Sequence::apply</function> example - -apply(function($value) { return $value * 2; }); - -print_r($sequence); -?> -]]> - - &example.outputs.similar; - - 2 - [1] => 4 - [2] => 6 -) -]]> - - - - - - - - diff --git a/reference/ds/ds/sequence/capacity.xml b/reference/ds/ds/sequence/capacity.xml deleted file mode 100644 index 521d832f5a5c..000000000000 --- a/reference/ds/ds/sequence/capacity.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - Ds\Sequence::capacity - Returns the current capacity - - - - &reftitle.description; - - abstract public intDs\Sequence::capacity - - - - Returns the current capacity. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The current capacity. - - - - - &reftitle.examples; - - <function>Ds\Sequence::capacity</function> example - -capacity()); - -$sequence->push(...range(1, 50)); -var_dump($sequence->capacity()); - -$sequence[] = "a"; -var_dump($sequence->capacity()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/sequence/contains.xml b/reference/ds/ds/sequence/contains.xml deleted file mode 100644 index 56ec838c1ea7..000000000000 --- a/reference/ds/ds/sequence/contains.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - Ds\Sequence::contains - Determines if the sequence contains given values - - - - &reftitle.description; - - abstract public boolDs\Sequence::contains - mixedvalues - - - Determines if the sequence contains all values. - - - - - &reftitle.parameters; - - - values - - - Values to check. - - - - - - - - &reftitle.returnvalues; - - &false; if any of the provided values are not in the - sequence, &true; otherwise. - - - - - &reftitle.examples; - - <function>Ds\Sequence::contains</function> example - -contains('a')); // true -var_dump($sequence->contains('a', 'b')); // true -var_dump($sequence->contains('c', 'd')); // false - -var_dump($sequence->contains(...['c', 'b', 'a'])); // true - -// Always strict -var_dump($sequence->contains(1)); // true -var_dump($sequence->contains('1')); // false - -var_dump($sequence->contains(...[])); // true -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/sequence/filter.xml b/reference/ds/ds/sequence/filter.xml deleted file mode 100644 index 502854b595c4..000000000000 --- a/reference/ds/ds/sequence/filter.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - Ds\Sequence::filter - - Creates a new sequence using a callable to - determine which values to include - - - - - &reftitle.description; - - abstract public Ds\SequenceDs\Sequence::filter - callablecallback - - - Creates a new sequence using a callable to - determine which values to include. - - - - - &reftitle.parameters; - - - - callback - - - - - bool - callback - mixedvalue - - - - Optional callable which returns &true; if the value should be included, &false; otherwise. - - - If a callback is not provided, only values which are &true; - (see converting to boolean) - will be included. - - - - - - - - - &reftitle.returnvalues; - - A new sequence containing all the values for which - either the callback returned &true;, or all values that - convert to &true; if a callback was not provided. - - - - - &reftitle.examples; - - <function>Ds\Sequence::filter</function> example using callback function - -filter(function($value) { - return $value % 2 == 0; -})); -?> -]]> - - &example.outputs.similar; - - - int(2) - [1]=> - int(4) -} -]]> - - - - <function>Ds\Sequence::filter</function> example without a callback function - -filter()); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - string(1) "a" - [2]=> - bool(true) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/sequence/find.xml b/reference/ds/ds/sequence/find.xml deleted file mode 100644 index 7991f9d01a27..000000000000 --- a/reference/ds/ds/sequence/find.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Ds\Sequence::find - - Attempts to find a value's index - - - - - &reftitle.description; - - abstract public mixedDs\Sequence::find - mixedvalue - - - Returns the index of the value, or &false; if not found. - - - - - - &reftitle.parameters; - - - value - - - The value to find. - - - - - - - - &reftitle.returnvalues; - - The index of the value, or &false; if not found. - - - - Values will be compared by value and by type. - - - - - - &reftitle.examples; - - <function>Ds\Sequence::find</function> example - -find("a")); // 0 -var_dump($sequence->find("b")); // false -var_dump($sequence->find("1")); // false -var_dump($sequence->find(1)); // 1 -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/sequence/first.xml b/reference/ds/ds/sequence/first.xml deleted file mode 100644 index e7322c7e02a9..000000000000 --- a/reference/ds/ds/sequence/first.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - Ds\Sequence::first - Returns the first value in the sequence - - - - &reftitle.description; - - abstract public mixedDs\Sequence::first - - - - Returns the first value in the sequence. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The first value in the sequence. - - - - - &reftitle.errors; - - UnderflowException if empty. - - - - - &reftitle.examples; - - <function>Ds\Sequence::first</function> example - -first()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/sequence/get.xml b/reference/ds/ds/sequence/get.xml deleted file mode 100644 index 51e8df0cb380..000000000000 --- a/reference/ds/ds/sequence/get.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - Ds\Sequence::get - Returns the value at a given index - - - - &reftitle.description; - - abstract public mixedDs\Sequence::get - intindex - - - Returns the value at a given index. - - - - - - &reftitle.parameters; - - - index - - - The index to access, starting at 0. - - - - - - - - &reftitle.returnvalues; - - The value at the requested index. - - - - - &reftitle.errors; - - OutOfRangeException if the index is not valid. - - - - - &reftitle.examples; - - <function>Ds\Sequence::get</function> example - -get(0)); -var_dump($sequence->get(1)); -var_dump($sequence->get(2)); -?> -]]> - - &example.outputs.similar; - - - - - - <function>Ds\Sequence::get</function> example using array syntax - - -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/sequence/insert.xml b/reference/ds/ds/sequence/insert.xml deleted file mode 100644 index 32cc7d0ed41a..000000000000 --- a/reference/ds/ds/sequence/insert.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - Ds\Sequence::insert - Inserts values at a given index - - - - &reftitle.description; - - abstract public voidDs\Sequence::insert - intindex - mixedvalues - - - Inserts values into the sequence at a given index. - - - - - - &reftitle.parameters; - - - index - - - The index at which to insert. 0 <= index <= count - - - - You can insert at the index equal to the number of values. - - - - - - values - - - The value or values to insert. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - OutOfRangeException if the index is not valid. - - - - - &reftitle.examples; - - <function>Ds\Sequence::insert</function> example - -insert(0, "e"); // [e] -$sequence->insert(1, "f"); // [e, f] -$sequence->insert(2, "g"); // [e, f, g] -$sequence->insert(0, "a", "b"); // [a, b, e, f, g] -$sequence->insert(2, ...["c", "d"]); // [a, b, c, d, e, f, g] - -var_dump($sequence); -?> -]]> - - &example.outputs.similar; - - - string(1) "a" - [1]=> - string(1) "b" - [2]=> - string(1) "c" - [3]=> - string(1) "d" - [4]=> - string(1) "e" - [5]=> - string(1) "f" - [6]=> - string(1) "g" -} -]]> - - - - - - - - diff --git a/reference/ds/ds/sequence/join.xml b/reference/ds/ds/sequence/join.xml deleted file mode 100644 index 57b63cda3076..000000000000 --- a/reference/ds/ds/sequence/join.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Ds\Sequence::join - Joins all values together as a string - - - - &reftitle.description; - - abstract public stringDs\Sequence::join - stringglue - - - Joins all values together as a string using an optional separator between each value. - - - - - &reftitle.parameters; - - - glue - - - An optional string to separate each value. - - - - - - - - &reftitle.returnvalues; - - All values of the sequence joined together as a string. - - - - - &reftitle.examples; - - <function>Ds\Sequence::join</function> example using a separator string - -join("|")); -?> -]]> - - &example.outputs.similar; - - - - - - <function>Ds\Sequence::join</function> example without a separator string - -join()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/sequence/last.xml b/reference/ds/ds/sequence/last.xml deleted file mode 100644 index 90a7431115b6..000000000000 --- a/reference/ds/ds/sequence/last.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - Ds\Sequence::last - Returns the last value - - - - &reftitle.description; - - abstract public mixedDs\Sequence::last - - - - Returns the last value in the sequence. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The last value in the sequence. - - - - - &reftitle.errors; - - UnderflowException if empty. - - - - - &reftitle.examples; - - <function>Ds\Sequence::last</function> example - -last()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/sequence/map.xml b/reference/ds/ds/sequence/map.xml deleted file mode 100644 index 644c973b2699..000000000000 --- a/reference/ds/ds/sequence/map.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - Ds\Sequence::map - Returns the result of applying a callback to each value - - - - &reftitle.description; - - abstract public Ds\SequenceDs\Sequence::map - callablecallback - - - Returns the result of applying a callback function to - each value in the sequence. - - - - - &reftitle.parameters; - - - callback - - - - - mixed - callback - mixedvalue - - - - A callable to apply to each value in the sequence. - - - - The callable should return what the new value will be in the new sequence. - - - - - - - - - &reftitle.returnvalues; - - The result of applying a callback to each value in - the sequence. - - - - The values of the current instance won't be affected. - - - - - - &reftitle.examples; - - <function>Ds\Sequence::map</function> example - -map(function($value) { return $value * 2; })); -print_r($sequence); -?> -]]> - - &example.outputs.similar; - - 2 - [1] => 4 - [2] => 6 -) -Ds\Vector Object -( - [0] => 1 - [1] => 2 - [2] => 3 -) -]]> - - - - - - - - diff --git a/reference/ds/ds/sequence/merge.xml b/reference/ds/ds/sequence/merge.xml deleted file mode 100644 index 689af930591a..000000000000 --- a/reference/ds/ds/sequence/merge.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - Ds\Sequence::merge - Returns the result of adding all given values to the sequence - - - - &reftitle.description; - - abstract public Ds\SequenceDs\Sequence::merge - mixedvalues - - - Returns the result of adding all given values to the sequence. - - - - - - &reftitle.parameters; - - - values - - - A traversable object or an &array;. - - - - - - - - &reftitle.returnvalues; - - The result of adding all given values to the sequence, - effectively the same as adding the values to a copy, then returning that copy. - - - - The current instance won't be affected. - - - - - - &reftitle.examples; - - <function>Ds\Sequence::merge</function> example - -merge([4, 5, 6])); -var_dump($sequence); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) - [2]=> - int(3) - [3]=> - int(4) - [4]=> - int(5) - [5]=> - int(6) -} -object(Ds\Vector)#1 (3) { - [0]=> - int(1) - [1]=> - int(2) - [2]=> - int(3) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/sequence/pop.xml b/reference/ds/ds/sequence/pop.xml deleted file mode 100644 index 86fe364a3b11..000000000000 --- a/reference/ds/ds/sequence/pop.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Ds\Sequence::pop - Removes and returns the last value - - - - &reftitle.description; - - abstract public mixedDs\Sequence::pop - - - - Removes and returns the last value. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The removed last value. - - - - - &reftitle.errors; - - UnderflowException if empty. - - - - - &reftitle.examples; - - <function>Ds\Sequence::pop</function> example - -pop()); -var_dump($sequence->pop()); -var_dump($sequence->pop()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/sequence/push.xml b/reference/ds/ds/sequence/push.xml deleted file mode 100644 index a0b9232a7a52..000000000000 --- a/reference/ds/ds/sequence/push.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Ds\Sequence::push - Adds values to the end of the sequence - - - - &reftitle.description; - - abstract public voidDs\Sequence::push - mixedvalues - - - Adds values to the end of the sequence. - - - - - - &reftitle.parameters; - - - values - - - The values to add. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <function>Ds\Sequence::push</function> example - -push("a"); -$sequence->push("b"); -$sequence->push("c", "d"); -$sequence->push(...["e", "f"]); - -print_r($sequence); -?> -]]> - - &example.outputs.similar; - - a - [1] => b - [2] => c - [3] => d - [4] => e - [5] => f -) -]]> - - - - - - - - diff --git a/reference/ds/ds/sequence/reduce.xml b/reference/ds/ds/sequence/reduce.xml deleted file mode 100644 index 6ae1fbb02e2c..000000000000 --- a/reference/ds/ds/sequence/reduce.xml +++ /dev/null @@ -1,159 +0,0 @@ - - - - - - Ds\Sequence::reduce - Reduces the sequence to a single value using a callback function - - - - &reftitle.description; - - abstract public mixedDs\Sequence::reduce - callablecallback - mixedinitial - - - Reduces the sequence to a single value using a callback function. - - - - - - &reftitle.parameters; - - - callback - - - - mixedcallback - mixedcarry - mixedvalue - - - - carry - - - The return value of the previous callback, or initial if - it's the first iteration. - - - - - value - - - The value of the current iteration. - - - - - - - - - initial - - - The initial value of the carry value. Can be &null;. - - - - - - - - &reftitle.returnvalues; - - The return value of the final callback. - - - - - &reftitle.examples; - - <function>Ds\Sequence::reduce</function> with initial value example - -reduce($callback, 5)); - -// Iterations: -// -// $carry = $initial = 5 -// -// $carry = $carry * 1 = 5 -// $carry = $carry * 2 = 10 -// $carry = $carry * 3 = 30 -?> -]]> - - &example.outputs.similar; - - - - - - <function>Ds\Sequence::reduce</function> without an initial value example - -reduce(function($carry, $value) { - return $carry + $value + 5; -})); - -// Iterations: -// -// $carry = $initial = null -// -// $carry = $carry + 1 + 5 = 6 -// $carry = $carry + 2 + 5 = 13 -// $carry = $carry + 3 + 5 = 21 -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/sequence/remove.xml b/reference/ds/ds/sequence/remove.xml deleted file mode 100644 index 5406876fb7fb..000000000000 --- a/reference/ds/ds/sequence/remove.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - Ds\Sequence::remove - Removes and returns a value by index - - - - &reftitle.description; - - abstract public mixedDs\Sequence::remove - intindex - - - Removes and returns a value by index. - - - - - - &reftitle.parameters; - - - index - - - The index of the value to remove. - - - - - - - - &reftitle.returnvalues; - - The value that was removed. - - - - - &reftitle.errors; - - OutOfRangeException if the index is not valid. - - - - - &reftitle.examples; - - <function>Ds\Sequence::remove</function> example - -remove(1)); -var_dump($sequence->remove(0)); -var_dump($sequence->remove(0)); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/sequence/reverse.xml b/reference/ds/ds/sequence/reverse.xml deleted file mode 100644 index d72348279510..000000000000 --- a/reference/ds/ds/sequence/reverse.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - Ds\Sequence::reverse - - Reverses the sequence in-place - - - - - &reftitle.description; - - abstract public voidDs\Sequence::reverse - - - - Reverses the sequence in-place. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <function>Ds\Sequence::reverse</function> example - -reverse(); - -print_r($sequence); -?> -]]> - - &example.outputs.similar; - - c - [1] => b - [2] => a -) -]]> - - - - - - - - diff --git a/reference/ds/ds/sequence/reversed.xml b/reference/ds/ds/sequence/reversed.xml deleted file mode 100644 index e5a88b8aa1cd..000000000000 --- a/reference/ds/ds/sequence/reversed.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - Ds\Sequence::reversed - Returns a reversed copy - - - - &reftitle.description; - - abstract public Ds\SequenceDs\Sequence::reversed - - - - Returns a reversed copy of the sequence. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A reversed copy of the sequence. - - - - The current instance is not affected. - - - - - - - &reftitle.examples; - - <function>Ds\Sequence::reversed</function> example - -reversed()); -print_r($sequence); -?> -]]> - - &example.outputs.similar; - - c - [1] => b - [2] => a -) -Ds\Vector Object -( - [0] => a - [1] => b - [2] => c -) -]]> - - - - - - - - diff --git a/reference/ds/ds/sequence/rotate.xml b/reference/ds/ds/sequence/rotate.xml deleted file mode 100644 index aec884376937..000000000000 --- a/reference/ds/ds/sequence/rotate.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - Ds\Sequence::rotate - Rotates the sequence by a given number of rotations - - - - &reftitle.description; - - abstract public voidDs\Sequence::rotate - introtations - - - Rotates the sequence by a given number of rotations, which is equivalent - to successively calling $sequence->push($sequence->shift()) if the number - of rotations is positive, or $sequence->unshift($sequence->pop()) if negative. - - - - - - &reftitle.parameters; - - - rotations - - - The number of times the sequence should be rotated. - - - - - - - - &reftitle.returnvalues; - - &return.void;. The sequence of the current instance will be rotated. - - - - - &reftitle.examples; - - <function>Ds\Sequence::rotate</function> example - -rotate(1); // "a" is shifted, then pushed. -print_r($sequence); - -$sequence->rotate(2); // "b" and "c" are both shifted, then pushed. -print_r($sequence); -?> -]]> - - &example.outputs.similar; - - b - [1] => c - [2] => d - [3] => a -) -Ds\Vector Object -( - [0] => d - [1] => a - [2] => b - [3] => c -) -]]> - - - - - - - - diff --git a/reference/ds/ds/sequence/set.xml b/reference/ds/ds/sequence/set.xml deleted file mode 100644 index c3528241869d..000000000000 --- a/reference/ds/ds/sequence/set.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - Ds\Sequence::set - Updates a value at a given index - - - - &reftitle.description; - - abstract public voidDs\Sequence::set - intindex - mixedvalue - - - Updates a value at a given index. - - - - - - &reftitle.parameters; - - - index - - - The index of the value to update. - - - - - value - - - The new value. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - OutOfRangeException if the index is not valid. - - - - - &reftitle.examples; - - <function>Ds\Sequence::set</function> example - -set(1, "_"); -print_r($sequence); -?> -]]> - - &example.outputs.similar; - - a - [1] => _ - [2] => c -) -]]> - - - - <function>Ds\Sequence::set</function> example using array syntax - - -]]> - - &example.outputs.similar; - - a - [1] => _ - [2] => c -) -]]> - - - - - - - - diff --git a/reference/ds/ds/sequence/shift.xml b/reference/ds/ds/sequence/shift.xml deleted file mode 100644 index 0ab932ee4555..000000000000 --- a/reference/ds/ds/sequence/shift.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Ds\Sequence::shift - Removes and returns the first value - - - - &reftitle.description; - - abstract public mixedDs\Sequence::shift - - - - Removes and returns the first value. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The first value, which was removed. - - - - - &reftitle.errors; - - UnderflowException if empty. - - - - - &reftitle.examples; - - <function>Ds\Sequence::shift</function> example - -shift()); -var_dump($sequence->shift()); -var_dump($sequence->shift()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/sequence/slice.xml b/reference/ds/ds/sequence/slice.xml deleted file mode 100644 index 5a577eea0607..000000000000 --- a/reference/ds/ds/sequence/slice.xml +++ /dev/null @@ -1,156 +0,0 @@ - - - - - - Ds\Sequence::slice - - Returns a sub-sequence of a given range - - - - - &reftitle.description; - - abstract public Ds\SequenceDs\Sequence::slice - intindex - intlength - - - Creates a sub-sequence of a given range. - - - - - - &reftitle.parameters; - - - index - - - The index at which the sub-sequence starts. - - - If positive, the sequence will start at that index in the sequence. - If negative, the sequence will start that far from the end. - - - - - length - - - If a length is given and is positive, the resulting - sequence will have up to that many values in it. - - If the length results in an overflow, only - values up to the end of the sequence will be included. - - If a length is given and is negative, the sequence - will stop that many values from the end. - - If a length is not provided, the resulting sequence - will contain all values between the index and the - end of the sequence. - - - - - - - - &reftitle.returnvalues; - - A sub-sequence of the given range. - - - - - &reftitle.examples; - - <function>Ds\Sequence::slice</function> example - -slice(2)); - -// Slice from 1, for a length of 3 -print_r($sequence->slice(1, 3)); - -// Slice from 1 onwards -print_r($sequence->slice(1)); - -// Slice from 2 from the end onwards -print_r($sequence->slice(-2)); - -// Slice from 1 to 1 from the end -print_r($sequence->slice(1, -1)); -?> -]]> - - &example.outputs.similar; - - c - [1] => d - [2] => e -) -Ds\Vector Object -( - [0] => b - [1] => c - [2] => d -) -Ds\Vector Object -( - [0] => b - [1] => c - [2] => d - [3] => e -) -Ds\Vector Object -( - [0] => d - [1] => e -) -Ds\Vector Object -( - [0] => b - [1] => c - [2] => d -) - -]]> - - - - - - - - diff --git a/reference/ds/ds/sequence/sort.xml b/reference/ds/ds/sequence/sort.xml deleted file mode 100644 index 984d7a2e49fc..000000000000 --- a/reference/ds/ds/sequence/sort.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - Ds\Sequence::sort - - Sorts the sequence in-place - - - - - &reftitle.description; - - abstract public voidDs\Sequence::sort - callablecomparator - - - Sorts the sequence in-place, using an optional comparator function. - - - - - - &reftitle.parameters; - - - comparator - - &sort.callback.description; - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <function>Ds\Sequence::sort</function> example - -sort(); - -print_r($sequence); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 - [3] => 4 - [4] => 5 -) -]]> - - - - <function>Ds\Sequence::sort</function> example using a comparator - -sort(function($a, $b) { - return $b <=> $a; -}); - -print_r($sequence); -?> -]]> - - &example.outputs.similar; - - 5 - [1] => 4 - [2] => 3 - [3] => 2 - [4] => 1 -) -]]> - - - - - - - - - diff --git a/reference/ds/ds/sequence/sorted.xml b/reference/ds/ds/sequence/sorted.xml deleted file mode 100644 index 87cc1edb0565..000000000000 --- a/reference/ds/ds/sequence/sorted.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - Ds\Sequence::sorted - Returns a sorted copy - - - - &reftitle.description; - - abstract public Ds\SequenceDs\Sequence::sorted - callablecomparator - - - Returns a sorted copy, using an optional comparator function. - - - - - - &reftitle.parameters; - - - comparator - - &sort.callback.description; - - - - - - - &reftitle.returnvalues; - - Returns a sorted copy of the sequence. - - - - - &reftitle.examples; - - <function>Ds\Sequence::sorted</function> example - -sorted()); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 - [3] => 4 - [4] => 5 -) -]]> - - - - <function>Ds\Sequence::sorted</function> example using a comparator - -sorted(function($a, $b) { - return $b <=> $a; -}); - -print_r($sorted); -?> -]]> - - &example.outputs.similar; - - 5 - [1] => 4 - [2] => 3 - [3] => 2 - [4] => 1 -) -]]> - - - - - - - - - diff --git a/reference/ds/ds/sequence/sum.xml b/reference/ds/ds/sequence/sum.xml deleted file mode 100644 index d780a4d320a5..000000000000 --- a/reference/ds/ds/sequence/sum.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Ds\Sequence::sum - Returns the sum of all values in the sequence - - - - &reftitle.description; - - abstract public intfloatDs\Sequence::sum - - - - Returns the sum of all values in the sequence. - - - - Arrays and objects are considered equal to zero when calculating the sum. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The sum of all the values in the sequence as either a float or int - depending on the values in the sequence. - - - - - &reftitle.examples; - - <function>Ds\Sequence::sum</function> integer example - -sum()); -?> -]]> - - &example.outputs.similar; - - - - - - <function>Ds\Sequence::sum</function> float example - -sum()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/sequence/unshift.xml b/reference/ds/ds/sequence/unshift.xml deleted file mode 100644 index 58e1f7a9ce5c..000000000000 --- a/reference/ds/ds/sequence/unshift.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Ds\Sequence::unshift - Adds values to the front of the sequence - - - - &reftitle.description; - - abstract public voidDs\Sequence::unshift - mixedvalues - - - Adds values to the front of the sequence, moving all the current - values forward to make room for the new values. - - - - - - &reftitle.parameters; - - - values - - - The values to add to the front of the sequence. - - - Multiple values will be added in the same order that they are - passed. - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <function>Ds\Sequence::unshift</function> example - -unshift("a"); -$sequence->unshift("b", "c"); - -print_r($sequence); -?> -]]> - - &example.outputs.similar; - - b - [1] => c - [2] => a - [3] => 1 - [4] => 2 - [5] => 3 -) -]]> - - - - - - - diff --git a/reference/ds/ds/set/add.xml b/reference/ds/ds/set/add.xml deleted file mode 100644 index fb373ffd13dd..000000000000 --- a/reference/ds/ds/set/add.xml +++ /dev/null @@ -1,202 +0,0 @@ - - - - - - Ds\Set::add - Adds values to the set - - - - &reftitle.description; - - public voidDs\Set::add - mixedvalues - - - Adds all given values to the set that haven't already been added. - - - - Values of type object are supported. - - If an object implements Ds\Hashable, - equality will be determined by the object's equals function. - - If an object does not implement Ds\Hashable, - objects must be references to the same instance to be considered equal. - - - - - All comparisons are strict (type and value). - - - - - - &reftitle.parameters; - - - values - - - Values to add to the set. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <function>Ds\Set::add</function> example using integers - -add(1); -$set->add(1); -$set->add(2); -$set->add(3); - -// Strict comparison would not treat these the same as int(1) -$set->add("1"); -$set->add(true); - -var_dump($set); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) - [2]=> - int(3) - [3]=> - string(1) "1" - [4]=> - bool(true) -} -]]> - - - - <function>Ds\Set::add</function> example using objects - -value = $value; - } - - public function hash() - { - return $this->value; - } - - public function equals($obj): bool - { - return $this->value === $obj->value; - } -} - -$set = new \Ds\Set(); - -$obj = new \ArrayIterator([]); - -// Adding the same instance multiple times will only add the first. -$set->add($obj); -$set->add($obj); - -// Adding multiple instances of the same object will add them all. -$set->add(new \stdClass()); -$set->add(new \stdClass()); - -// Adding multiple instances of equal hashable objects will only add the first. -$set->add(new \HashableObject(1)); -$set->add(new \HashableObject(1)); -$set->add(new \HashableObject(2)); -$set->add(new \HashableObject(2)); - -var_dump($set); -?> -]]> - - &example.outputs.similar; - - - object(ArrayIterator)#2 (1) { - ["storage":"ArrayIterator":private]=> - array(0) { - } - } - [1]=> - object(stdClass)#3 (0) { - } - [2]=> - object(stdClass)#4 (0) { - } - [3]=> - object(HashableObject)#5 (1) { - ["value":"HashableObject":private]=> - int(1) - } - [4]=> - object(HashableObject)#6 (1) { - ["value":"HashableObject":private]=> - int(2) - } -} -]]> - - - - - - - - diff --git a/reference/ds/ds/set/allocate.xml b/reference/ds/ds/set/allocate.xml deleted file mode 100644 index c74c70d6c56a..000000000000 --- a/reference/ds/ds/set/allocate.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - Ds\Set::allocate - Allocates enough memory for a required capacity - - - - &reftitle.description; - - public voidDs\Set::allocate - intcapacity - - - Allocates enough memory for a required capacity. - - - - - - &reftitle.parameters; - - - capacity - - - The number of values for which capacity should be allocated. - - - - Capacity will stay the same if this value is less than or equal to the - current capacity. - - - - - Capacity will always be rounded up to the nearest power of 2. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <function>Ds\Set::allocate</function> example - -capacity()); - -$set->allocate(100); -var_dump($set->capacity()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/set/capacity.xml b/reference/ds/ds/set/capacity.xml deleted file mode 100644 index 84be7eb3122c..000000000000 --- a/reference/ds/ds/set/capacity.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - Ds\Set::capacity - Returns the current capacity - - - - &reftitle.description; - - public intDs\Set::capacity - - - - Returns the current capacity. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The current capacity. - - - - - &reftitle.examples; - - <function>Ds\Set::capacity</function> example - -capacity()); - -$set->add(...range(1, 50)); -var_dump($set->capacity()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/set/clear.xml b/reference/ds/ds/set/clear.xml deleted file mode 100644 index 051e84e4fce1..000000000000 --- a/reference/ds/ds/set/clear.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - Ds\Set::clear - Removes all values - - - - &reftitle.description; - - public voidDs\Set::clear - - - - Removes all values from the set. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <function>Ds\Set::clear</function> example - -clear(); -print_r($set); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 -) -Ds\Set Object -( -) -]]> - - - - - - - - diff --git a/reference/ds/ds/set/construct.xml b/reference/ds/ds/set/construct.xml deleted file mode 100644 index a8701a7968b5..000000000000 --- a/reference/ds/ds/set/construct.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Ds\Set::__construct - Creates a new instance - - - - &reftitle.description; - - public Ds\Set::__construct - mixedvalues[] - - - Creates a new instance, using either a traversable - object or an &array; for the initial values. - - - - - - &reftitle.parameters; - - - values - - - A traversable object or an &array; to use for the initial values. - - - - - - - - - - - &reftitle.examples; - - <function>Ds\Set::__construct</function> example - - -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) - [2]=> - int(3) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/set/contains.xml b/reference/ds/ds/set/contains.xml deleted file mode 100644 index 96d21898500f..000000000000 --- a/reference/ds/ds/set/contains.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - Ds\Set::contains - Determines if the set contains all values - - - - &reftitle.description; - - public boolDs\Set::contains - mixedvalues - - - Determines if the set contains all values. - - - - - Values of type object are supported. - - If an object implements Ds\Hashable, - equality will be determined by the object's equals function. - - If an object does not implement Ds\Hashable, - objects must be references to the same instance to be considered equal. - - - - - All comparisons are strict (type and value). - - - - - - - &reftitle.parameters; - - - values - - - Values to check. - - - - - - - - &reftitle.returnvalues; - - &false; if any of the provided values are not in the - set, &true; otherwise. - - - - - &reftitle.examples; - - <function>Ds\Set::contains</function> example - -contains(1)); // true -var_dump($set->contains(1, 2)); // true -var_dump($set->contains(...[1, 2])); // true - -var_dump($set->contains("1")); // false -var_dump($set->contains(...[1, 2, 3, 4])); // false - -var_dump($set->contains(...[])); // true -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/set/copy.xml b/reference/ds/ds/set/copy.xml deleted file mode 100644 index f6e2730a1f8e..000000000000 --- a/reference/ds/ds/set/copy.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - Ds\Set::copy - Returns a shallow copy of the set - - - - &reftitle.description; - - public Ds\SetDs\Set::copy - - - - Returns a shallow copy of the set. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a shallow copy of the set. - - - - - &reftitle.examples; - - <function>Ds\Set::copy</function> example - -copy(); - -// Updating the copy doesn't affect the original -$b->add(4); - -print_r($a); -print_r($b); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 -) -Ds\Set Object -( - [0] => 1 - [1] => 2 - [2] => 3 - [3] => 4 -) -]]> - - - - - - - - diff --git a/reference/ds/ds/set/count.xml b/reference/ds/ds/set/count.xml deleted file mode 100644 index 4d97b717cc75..000000000000 --- a/reference/ds/ds/set/count.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - - Ds\Set::count - Returns the number of values in the set - - - - &reftitle.description; - - See Countable::count - - - - - - diff --git a/reference/ds/ds/set/diff.xml b/reference/ds/ds/set/diff.xml deleted file mode 100644 index ddc1635d1209..000000000000 --- a/reference/ds/ds/set/diff.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Ds\Set::diff - Creates a new set using values that aren't in another set - - - - &reftitle.description; - - public Ds\SetDs\Set::diff - Ds\Setset - - - Creates a new set using values that aren't in another set. - - - A \ B = {x ∈ A | x ∉ B} - - - - - &reftitle.parameters; - - - set - - - Set containing the values to exclude. - - - - - - - - &reftitle.returnvalues; - - A new set containing all values that were not in the other set. - - - - - &reftitle.seealso; - - - Complement on Wikipedia - - - - - - &reftitle.examples; - - <function>Ds\Set::diff</function> example - -diff($b)); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/set/filter.xml b/reference/ds/ds/set/filter.xml deleted file mode 100644 index 953edd7acd41..000000000000 --- a/reference/ds/ds/set/filter.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - - Ds\Set::filter - - Creates a new set using a callable to - determine which values to include - - - - - &reftitle.description; - - public Ds\SetDs\Set::filter - callablecallback - - - Creates a new set using a callable to - determine which values to include. - - - - - - &reftitle.parameters; - - - callback - - - - bool - callback - mixedvalue - - - - Optional callable which returns &true; if the value should be included, &false; otherwise. - - - If a callback is not provided, only values which are &true; - (see converting to boolean) - will be included. - - - - - - - - &reftitle.returnvalues; - - A new set containing all the values for which - either the callback returned &true;, or all values that - convert to &true; if a callback was not provided. - - - - - &reftitle.examples; - - <function>Ds\Set::filter</function> example using callback function - -filter(function($value) { - return $value % 2 == 0; -})); -?> -]]> - - &example.outputs.similar; - - - int(2) - [1]=> - int(4) -} -]]> - - - - <function>Ds\Set::filter</function> example without a callback function - -filter()); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - string(1) "a" - [2]=> - bool(true) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/set/first.xml b/reference/ds/ds/set/first.xml deleted file mode 100644 index da39b797938a..000000000000 --- a/reference/ds/ds/set/first.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - Ds\Set::first - Returns the first value in the set - - - - &reftitle.description; - - public mixedDs\Set::first - - - - Returns the first value in the set. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The first value in the set. - - - - - &reftitle.errors; - - UnderflowException if empty. - - - - - &reftitle.examples; - - <function>Ds\Set::first</function> example - -first()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/set/get.xml b/reference/ds/ds/set/get.xml deleted file mode 100644 index b52a5b6237ca..000000000000 --- a/reference/ds/ds/set/get.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - Ds\Set::get - Returns the value at a given index - - - - &reftitle.description; - - public mixedDs\Set::get - intindex - - - Returns the value at a given index. - - - - - - &reftitle.parameters; - - - index - - - The index to access, starting at 0. - - - - - - - - &reftitle.returnvalues; - - The value at the requested index. - - - - - &reftitle.errors; - - OutOfRangeException if the index is not valid. - - - - - &reftitle.examples; - - <function>Ds\Set::get</function> example - -get(0)); -var_dump($set->get(1)); -var_dump($set->get(2)); -?> -]]> - - &example.outputs.similar; - - - - - - <function>Ds\Set::get</function> example using array syntax - - -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/set/intersect.xml b/reference/ds/ds/set/intersect.xml deleted file mode 100644 index 9ea56e010349..000000000000 --- a/reference/ds/ds/set/intersect.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - Ds\Set::intersect - Creates a new set by intersecting values with another set - - - - &reftitle.description; - - public Ds\SetDs\Set::intersect - Ds\Setset - - - Creates a new set using values common to both the current instance and another set. - - In other words, returns a copy of the current instance with all values removed that - are not in the other set. - - - A ∩ B = {x : x ∈ A ∧ x ∈ B} - - - - - &reftitle.parameters; - - - set - - - The other set. - - - - - - - - &reftitle.returnvalues; - - The intersection of the current instance and another set. - - - - - &reftitle.seealso; - - - Intersection on Wikipedia - - - - - - &reftitle.examples; - - <function>Ds\Set::intersect</function> example - -intersect($b)); -?> -]]> - - &example.outputs.similar; - - - int(3) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/set/isempty.xml b/reference/ds/ds/set/isempty.xml deleted file mode 100644 index 652e453bb7d3..000000000000 --- a/reference/ds/ds/set/isempty.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - Ds\Set::isEmpty - Returns whether the set is empty - - - - &reftitle.description; - - public boolDs\Set::isEmpty - - - - Returns whether the set is empty. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; if the set is empty, &false; otherwise. - - - - - &reftitle.examples; - - <function>Ds\Set::isEmpty</function> example - -isEmpty()); -var_dump($b->isEmpty()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/set/join.xml b/reference/ds/ds/set/join.xml deleted file mode 100644 index 1966f32c3a52..000000000000 --- a/reference/ds/ds/set/join.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Ds\Set::join - Joins all values together as a string - - - - &reftitle.description; - - public stringDs\Set::join - stringglue - - - Joins all values together as a string using an optional separator between each value. - - - - - &reftitle.parameters; - - - glue - - - An optional string to separate each value. - - - - - - - - &reftitle.returnvalues; - - All values of the set joined together as a string. - - - - - &reftitle.examples; - - <function>Ds\Set::join</function> example using a separator string - -join("|")); -?> -]]> - - &example.outputs.similar; - - - - - - <function>Ds\Set::join</function> example without a separator string - -join()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/set/jsonserialize.xml b/reference/ds/ds/set/jsonserialize.xml deleted file mode 100644 index b3cb4f267cd3..000000000000 --- a/reference/ds/ds/set/jsonserialize.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - - Ds\Set::jsonSerialize - Returns a representation that can be converted to JSON - - - - &reftitle.description; - - See JsonSerializable::jsonSerialize - - - - You should never need to call this directly. - - - - - - - diff --git a/reference/ds/ds/set/last.xml b/reference/ds/ds/set/last.xml deleted file mode 100644 index de41141ec40a..000000000000 --- a/reference/ds/ds/set/last.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - Ds\Set::last - Returns the last value in the set - - - - &reftitle.description; - - public mixedDs\Set::last - - - - Returns the last value in the set. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The last value in the set. - - - - - &reftitle.errors; - - UnderflowException if empty. - - - - - &reftitle.examples; - - <function>Ds\Set::last</function> example - -last()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/set/map.xml b/reference/ds/ds/set/map.xml deleted file mode 100644 index ae1a1e821ad9..000000000000 --- a/reference/ds/ds/set/map.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - Ds\Set::map - Returns the result of applying a callback to each value - - - - &reftitle.description; - - public Ds\SetDs\Set::map - callablecallback - - - Returns the result of applying a callback function to - each value in the set. - - - - - &reftitle.parameters; - - - callback - - - The callback to apply to each value in the set must have the following signature: - - mixed - callback - mixedvalue - - - - - - - - - &reftitle.returnvalues; - - Returns a new Ds\Set instance where each value - is the result of applying the callback to each value - of the set. - - - - - &reftitle.examples; - - <methodname>Ds\Set::map</methodname> example - -map(function($value) { return $value * 2; })); -var_dump($set); -?> -]]> - - &example.outputs.similar; - - - int(2) - [1]=> - int(4) - [2]=> - int(6) -} -object(Ds\Set)#1 (3) { - [0]=> - int(1) - [1]=> - int(2) - [2]=> - int(3) -} -]]> - - - - - - diff --git a/reference/ds/ds/set/merge.xml b/reference/ds/ds/set/merge.xml deleted file mode 100644 index 277b085207b6..000000000000 --- a/reference/ds/ds/set/merge.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - Ds\Set::merge - Returns the result of adding all given values to the set - - - - &reftitle.description; - - public Ds\SetDs\Set::merge - mixedvalues - - - Returns the result of adding all given values to the set. - - - - - - &reftitle.parameters; - - - values - - - A traversable object or an &array;. - - - - - - - - &reftitle.returnvalues; - - The result of adding all given values to the set, - effectively the same as adding the values to a copy, then returning that copy. - - - - The current instance won't be affected. - - - - - - &reftitle.examples; - - <function>Ds\Set::merge</function> example - -merge([3, 4, 5])); -var_dump($set); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) - [2]=> - int(3) - [3]=> - int(4) - [4]=> - int(5) -} -object(Ds\Set)#1 (3) { - [0]=> - int(1) - [1]=> - int(2) - [2]=> - int(3) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/set/reduce.xml b/reference/ds/ds/set/reduce.xml deleted file mode 100644 index 31b19b238f0c..000000000000 --- a/reference/ds/ds/set/reduce.xml +++ /dev/null @@ -1,159 +0,0 @@ - - - - - - Ds\Set::reduce - Reduces the set to a single value using a callback function - - - - &reftitle.description; - - public mixedDs\Set::reduce - callablecallback - mixedinitial - - - Reduces the set to a single value using a callback function. - - - - - - &reftitle.parameters; - - - callback - - - - mixedcallback - mixedcarry - mixedvalue - - - - carry - - - The return value of the previous callback, or initial if - it's the first iteration. - - - - - value - - - The value of the current iteration. - - - - - - - - - initial - - - The initial value of the carry value. Can be &null;. - - - - - - - - &reftitle.returnvalues; - - The return value of the final callback. - - - - - &reftitle.examples; - - <function>Ds\Set::reduce</function> with initial value example - -reduce($callback, 5)); - -// Iterations: -// -// $carry = $initial = 5 -// -// $carry = $carry * 1 = 5 -// $carry = $carry * 2 = 10 -// $carry = $carry * 3 = 30 -?> -]]> - - &example.outputs.similar; - - - - - - <function>Ds\Set::reduce</function> without an initial value example - -reduce(function($carry, $value) { - return $carry + $value + 5; -})); - -// Iterations: -// -// $carry = $initial = null -// -// $carry = $carry + 1 + 5 = 6 -// $carry = $carry + 2 + 5 = 13 -// $carry = $carry + 3 + 5 = 21 -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/set/remove.xml b/reference/ds/ds/set/remove.xml deleted file mode 100644 index 274f2880c0ba..000000000000 --- a/reference/ds/ds/set/remove.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - Ds\Set::remove - Removes all given values from the set - - - - &reftitle.description; - - public voidDs\Set::remove - mixedvalues - - - Removes all given values from the set, ignoring any that are not in the set. - - - - - - &reftitle.parameters; - - - values - - - The values to remove. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <function>Ds\Set::remove</function> example - -remove(1); // Remove 1 -$set->remove(1, 2); // Can't find 1, but remove 2 -$set->remove(...[3, 4]); // Remove 3 and 4 - -var_dump($set); -?> -]]> - - &example.outputs.similar; - - - int(5) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/set/reverse.xml b/reference/ds/ds/set/reverse.xml deleted file mode 100644 index 979dea166105..000000000000 --- a/reference/ds/ds/set/reverse.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - Ds\Set::reverse - - Reverses the set in-place - - - - - &reftitle.description; - - public voidDs\Set::reverse - - - - Reverses the set in-place. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <function>Ds\Set::reverse</function> example - -reverse(); - -print_r($set); -?> -]]> - - &example.outputs.similar; - - c - [1] => b - [2] => a -) -]]> - - - - - - - - diff --git a/reference/ds/ds/set/reversed.xml b/reference/ds/ds/set/reversed.xml deleted file mode 100644 index 5bbd84f1814a..000000000000 --- a/reference/ds/ds/set/reversed.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - Ds\Set::reversed - Returns a reversed copy - - - - &reftitle.description; - - public Ds\SetDs\Set::reversed - - - - Returns a reversed copy of the set. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A reversed copy of the set. - - - - The current instance is not affected. - - - - - - - &reftitle.examples; - - <function>Ds\Set::reversed</function> example - -reversed()); -print_r($set); -?> -]]> - - &example.outputs.similar; - - c - [1] => b - [2] => a -) -Ds\Set Object -( - [0] => a - [1] => b - [2] => c -) -]]> - - - - - - - - diff --git a/reference/ds/ds/set/slice.xml b/reference/ds/ds/set/slice.xml deleted file mode 100644 index 9e48c8003beb..000000000000 --- a/reference/ds/ds/set/slice.xml +++ /dev/null @@ -1,156 +0,0 @@ - - - - - - Ds\Set::slice - - Returns a sub-set of a given range - - - - - &reftitle.description; - - public Ds\SetDs\Set::slice - intindex - intlength - - - Creates a sub-set of a given range. - - - - - - &reftitle.parameters; - - - index - - - The index at which the sub-set starts. - - - If positive, the set will start at that index in the set. - If negative, the set will start that far from the end. - - - - - length - - - If a length is given and is positive, the resulting - set will have up to that many values in it. - - If the length results in an overflow, only - values up to the end of the set will be included. - - If a length is given and is negative, the set - will stop that many values from the end. - - If a length is not provided, the resulting set - will contain all values between the index and the - end of the set. - - - - - - - - &reftitle.returnvalues; - - A sub-set of the given range. - - - - - &reftitle.examples; - - <function>Ds\Set::slice</function> example - -slice(2)); - -// Slice from 1, for a length of 3 -print_r($set->slice(1, 3)); - -// Slice from 1 onwards -print_r($set->slice(1)); - -// Slice from 2 from the end onwards -print_r($set->slice(-2)); - -// Slice from 1 to 1 from the end -print_r($set->slice(1, -1)); -?> -]]> - - &example.outputs.similar; - - c - [1] => d - [2] => e -) -Ds\Set Object -( - [0] => b - [1] => c - [2] => d -) -Ds\Set Object -( - [0] => b - [1] => c - [2] => d - [3] => e -) -Ds\Set Object -( - [0] => d - [1] => e -) -Ds\Set Object -( - [0] => b - [1] => c - [2] => d -) - -]]> - - - - - - - - diff --git a/reference/ds/ds/set/sort.xml b/reference/ds/ds/set/sort.xml deleted file mode 100644 index 8c4ce725cb9f..000000000000 --- a/reference/ds/ds/set/sort.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - Ds\Set::sort - - Sorts the set in-place - - - - - &reftitle.description; - - public voidDs\Set::sort - callablecomparator - - - Sorts the set in-place, using an optional comparator function. - - - - - - &reftitle.parameters; - - - comparator - - &sort.callback.description; - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <function>Ds\Set::sort</function> example - -sort(); - -print_r($set); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 - [3] => 4 - [4] => 5 -) -]]> - - - - <function>Ds\Set::sort</function> example using a comparator - -sort(function($a, $b) { - return $b <=> $a; -}); - -print_r($set); -?> -]]> - - &example.outputs.similar; - - 5 - [1] => 4 - [2] => 3 - [3] => 2 - [4] => 1 -) -]]> - - - - - - - - - diff --git a/reference/ds/ds/set/sorted.xml b/reference/ds/ds/set/sorted.xml deleted file mode 100644 index 1540319889fa..000000000000 --- a/reference/ds/ds/set/sorted.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - Ds\Set::sorted - Returns a sorted copy - - - - &reftitle.description; - - public Ds\SetDs\Set::sorted - callablecomparator - - - Returns a sorted copy, using an optional comparator function. - - - - - - &reftitle.parameters; - - - comparator - - &sort.callback.description; - - - - - - - &reftitle.returnvalues; - - Returns a sorted copy of the set. - - - - - &reftitle.examples; - - <function>Ds\Set::sorted</function> example - -sorted()); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 - [3] => 4 - [4] => 5 -) -]]> - - - - <function>Ds\Set::sorted</function> example using a comparator - -sorted(function($a, $b) { - return $b <=> $a; -}); - -print_r($sorted); -?> -]]> - - &example.outputs.similar; - - 5 - [1] => 4 - [2] => 3 - [3] => 2 - [4] => 1 -) -]]> - - - - - - - - - diff --git a/reference/ds/ds/set/sum.xml b/reference/ds/ds/set/sum.xml deleted file mode 100644 index d58d2e756309..000000000000 --- a/reference/ds/ds/set/sum.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Ds\Set::sum - Returns the sum of all values in the set - - - - &reftitle.description; - - public intfloatDs\Set::sum - - - - Returns the sum of all values in the set. - - - - Arrays and objects are considered equal to zero when calculating the sum. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The sum of all the values in the set as either a float or int - depending on the values in the set. - - - - - &reftitle.examples; - - <function>Ds\Set::sum</function> integer example - -sum()); -?> -]]> - - &example.outputs.similar; - - - - - - <function>Ds\Set::sum</function> float example - -sum()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/set/toarray.xml b/reference/ds/ds/set/toarray.xml deleted file mode 100644 index f87ec4a2876a..000000000000 --- a/reference/ds/ds/set/toarray.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - Ds\Set::toArray - - Converts the set to an &array; - - - - - &reftitle.description; - - public arrayDs\Set::toArray - - - - Converts the set to an &array;. - - - - Casting to an &array; is not supported yet. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - An &array; containing all the values in the same order as the set. - - - - - &reftitle.examples; - - <function>Ds\Set::toArray</function> example - -toArray()); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) - [2]=> - int(3) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/set/union.xml b/reference/ds/ds/set/union.xml deleted file mode 100644 index 1094db761e97..000000000000 --- a/reference/ds/ds/set/union.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - Ds\Set::union - Creates a new set using values from the current instance and another set - - - - &reftitle.description; - - public Ds\SetDs\Set::union - Ds\Setset - - - Creates a new set that contains the values of the current instance as well as the - values of another set. - - - A ∪ B = {x: x ∈ A ∨ x ∈ B} - - - - - &reftitle.parameters; - - - set - - - The other set, to combine with the current instance. - - - - - - - - &reftitle.returnvalues; - - A new set containing all the values of the current instance as well as another set. - - - - - &reftitle.seealso; - - - Union on Wikipedia - - - - - - &reftitle.examples; - - <function>Ds\Set::union</function> example - -union($b)); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) - [2]=> - int(3) - [3]=> - int(4) - [4]=> - int(5) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/set/xor.xml b/reference/ds/ds/set/xor.xml deleted file mode 100644 index 1b64dbbae8ff..000000000000 --- a/reference/ds/ds/set/xor.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - Ds\Set::xor - Creates a new set using values in either the current instance or in another set, but not in both - - - - &reftitle.description; - - public Ds\SetDs\Set::xor - Ds\Setset - - - Creates a new set containing values in the current instance as well as another set, - but not in both. - - - A ⊖ B = {x : x ∈ (A \ B) ∪ (B \ A)} - - - - - &reftitle.parameters; - - - set - - - The other set. - - - - - - - - &reftitle.returnvalues; - - A new set containing values in the current instance as well as another set, - but not in both. - - - - - &reftitle.seealso; - - - Symmetric Difference on Wikipedia - - - - - - &reftitle.examples; - - <function>Ds\Set::xor</function> example - -xor($b)); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) - [2]=> - int(4) - [3]=> - int(5) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/stack/allocate.xml b/reference/ds/ds/stack/allocate.xml deleted file mode 100644 index 646a7faac9e8..000000000000 --- a/reference/ds/ds/stack/allocate.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - Ds\Stack::allocate - Allocates enough memory for a required capacity - - - - &reftitle.description; - - public voidDs\Stack::allocate - intcapacity - - - Ensures that enough memory is allocated for a required capacity. - This removes the need to reallocate the internal buffer as values are added. - - - - - &reftitle.parameters; - - - capacity - - - The number of values for which capacity should be allocated. - - - - Capacity will stay the same if this value is less than or equal to the - current capacity. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/ds/ds/stack/capacity.xml b/reference/ds/ds/stack/capacity.xml deleted file mode 100644 index a793e68167fb..000000000000 --- a/reference/ds/ds/stack/capacity.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - Ds\Stack::capacity - Returns the current capacity - - - - &reftitle.description; - - public intDs\Stack::capacity - - - - Returns the current capacity. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The current capacity. - - - - - - - diff --git a/reference/ds/ds/stack/clear.xml b/reference/ds/ds/stack/clear.xml deleted file mode 100644 index d02e578f3e02..000000000000 --- a/reference/ds/ds/stack/clear.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - Ds\Stack::clear - Removes all values - - - - &reftitle.description; - - public voidDs\Stack::clear - - - - Removes all values from the stack. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <function>Ds\Stack::clear</function> example - -clear(); -print_r($stack); -?> -]]> - - &example.outputs.similar; - - 3 - [1] => 2 - [2] => 1 -) -Ds\Stack Object -( -) -]]> - - - - - - - - diff --git a/reference/ds/ds/stack/construct.xml b/reference/ds/ds/stack/construct.xml deleted file mode 100644 index 7554d18b4f44..000000000000 --- a/reference/ds/ds/stack/construct.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - Ds\Stack::__construct - Creates a new instance - - - - &reftitle.description; - - public Ds\Stack::__construct - mixedvalues - - - Creates a new instance, using either a traversable - object or an &array; for the initial values. - - - - - &reftitle.parameters; - - - values - - - A traversable object or an &array; to use for the initial values. - - - - - - - - - - - &reftitle.examples; - - <function>Ds\Stack::__construct</function> example - - -]]> - - &example.outputs.similar; - - 3 - [1] => 2 - [2] => 1 -) -]]> - - - - - - - - diff --git a/reference/ds/ds/stack/copy.xml b/reference/ds/ds/stack/copy.xml deleted file mode 100644 index 10ac257b0f01..000000000000 --- a/reference/ds/ds/stack/copy.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - Ds\Stack::copy - Returns a shallow copy of the stack - - - - &reftitle.description; - - public Ds\StackDs\Stack::copy - - - - Returns a shallow copy of the stack. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a shallow copy of the stack. - - - - - &reftitle.examples; - - <function>Ds\Stack::copy</function> example - -copy(); - -// Updating the copy doesn't affect the original -$b->push(4); - -print_r($a); -print_r($b); -?> -]]> - - &example.outputs.similar; - - 3 - [1] => 2 - [2] => 1 -) -Ds\Stack Object -( - [0] => 4 - [1] => 3 - [2] => 2 - [3] => 1 -) -]]> - - - - - - - - diff --git a/reference/ds/ds/stack/count.xml b/reference/ds/ds/stack/count.xml deleted file mode 100644 index 4ff7fd78de16..000000000000 --- a/reference/ds/ds/stack/count.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - - Ds\Stack::count - Returns the number of values in the stack - - - - &reftitle.description; - - See Countable::count - - - - - - diff --git a/reference/ds/ds/stack/isempty.xml b/reference/ds/ds/stack/isempty.xml deleted file mode 100644 index 09287137b26c..000000000000 --- a/reference/ds/ds/stack/isempty.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - Ds\Stack::isEmpty - Returns whether the stack is empty - - - - &reftitle.description; - - public boolDs\Stack::isEmpty - - - - Returns whether the stack is empty. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; if the stack is empty, &false; otherwise. - - - - - &reftitle.examples; - - <function>Ds\Stack::isEmpty</function> example - -isEmpty()); -var_dump($b->isEmpty()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/stack/jsonserialize.xml b/reference/ds/ds/stack/jsonserialize.xml deleted file mode 100644 index 6c8d8a17f8b5..000000000000 --- a/reference/ds/ds/stack/jsonserialize.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - - Ds\Stack::jsonSerialize - Returns a representation that can be converted to JSON - - - - &reftitle.description; - - See JsonSerializable::jsonSerialize - - - - You should never need to call this directly. - - - - - - diff --git a/reference/ds/ds/stack/peek.xml b/reference/ds/ds/stack/peek.xml deleted file mode 100644 index 183e5dccf3a3..000000000000 --- a/reference/ds/ds/stack/peek.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Ds\Stack::peek - Returns the value at the top of the stack - - - - &reftitle.description; - - public mixedDs\Stack::peek - - - - Returns the value at the top of the stack, but does not remove it. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The value at the top of the stack. - - - - - &reftitle.errors; - - UnderflowException if empty. - - - - - &reftitle.examples; - - <function>Ds\Stack::peek</function> example - -push("a"); -$stack->push("b"); -$stack->push("c"); - -var_dump($stack->peek()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/stack/pop.xml b/reference/ds/ds/stack/pop.xml deleted file mode 100644 index df040a7881cd..000000000000 --- a/reference/ds/ds/stack/pop.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - Ds\Stack::pop - Removes and returns the value at the top of the stack - - - - &reftitle.description; - - public mixedDs\Stack::pop - - - - Removes and returns the value at the top of the stack. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The removed value which was at the top of the stack. - - - - - &reftitle.errors; - - UnderflowException if empty. - - - - - &reftitle.examples; - - <function>Ds\Stack::pop</function> example - -push("a"); -$stack->push("b"); -$stack->push("c"); - -var_dump($stack->pop()); -var_dump($stack->pop()); -var_dump($stack->pop()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/stack/push.xml b/reference/ds/ds/stack/push.xml deleted file mode 100644 index e00ba4c5d58b..000000000000 --- a/reference/ds/ds/stack/push.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Ds\Stack::push - Pushes values onto the stack - - - - &reftitle.description; - - public voidDs\Stack::push - mixedvalues - - - Pushes values onto the stack. - - - - - - &reftitle.parameters; - - - values - - - The values to push onto the stack. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <function>Ds\Stack::push</function> example - -push("a"); -$stack->push("b"); -$stack->push("c", "d"); -$stack->push(...["e", "f"]); - -print_r($stack); -?> -]]> - - &example.outputs.similar; - - a - [1] => b - [2] => c - [3] => d - [4] => e - [5] => f -) -]]> - - - - - - - - diff --git a/reference/ds/ds/stack/toarray.xml b/reference/ds/ds/stack/toarray.xml deleted file mode 100644 index 7c408173769b..000000000000 --- a/reference/ds/ds/stack/toarray.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - Ds\Stack::toArray - - Converts the stack to an &array; - - - - - &reftitle.description; - - public arrayDs\Stack::toArray - - - - Converts the stack to an &array;. - - - - Casting to an &array; is not supported yet. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - An &array; containing all the values in the same order as the stack. - - - - - &reftitle.examples; - - <function>Ds\Stack::toArray</function> example - -toArray()); -?> -]]> - - &example.outputs.similar; - - - int(3) - [1]=> - int(2) - [2]=> - int(1) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/vector/allocate.xml b/reference/ds/ds/vector/allocate.xml deleted file mode 100644 index 9b6e1772ec63..000000000000 --- a/reference/ds/ds/vector/allocate.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - Ds\Vector::allocate - Allocates enough memory for a required capacity - - - - &reftitle.description; - - public voidDs\Vector::allocate - intcapacity - - - Ensures that enough memory is allocated for a required capacity. - This removes the need to reallocate the internal buffer as values are added. - - - - - &reftitle.parameters; - - - capacity - - - The number of values for which capacity should be allocated. - - - - Capacity will stay the same if this value is less than or equal to the - current capacity. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <function>Ds\Vector::allocate</function> example - -capacity()); - -$vector->allocate(100); -var_dump($vector->capacity()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/vector/apply.xml b/reference/ds/ds/vector/apply.xml deleted file mode 100644 index 64c8b61fd73e..000000000000 --- a/reference/ds/ds/vector/apply.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - Ds\Vector::apply - Updates all values by applying a callback function to each value - - - - &reftitle.description; - - public voidDs\Vector::apply - callablecallback - - - Updates all values by applying a callback function to - each value in the vector. - - - - - &reftitle.parameters; - - - callback - - - - - mixed - callback - mixedvalue - - - - A callable to apply to each value in the vector. - - - - The callback should return what the value should be replaced by. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <function>Ds\Vector::apply</function> example - -apply(function($value) { return $value * 2; }); - -print_r($vector); -?> -]]> - - &example.outputs.similar; - - 2 - [1] => 4 - [2] => 6 -) -]]> - - - - - - - - diff --git a/reference/ds/ds/vector/capacity.xml b/reference/ds/ds/vector/capacity.xml deleted file mode 100644 index 4a43128dfe18..000000000000 --- a/reference/ds/ds/vector/capacity.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - Ds\Vector::capacity - Returns the current capacity - - - - &reftitle.description; - - public intDs\Vector::capacity - - - - Returns the current capacity. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The current capacity. - - - - - &reftitle.examples; - - <function>Ds\Vector::capacity</function> example - -capacity()); - -$vector->push(...range(1, 50)); -var_dump($vector->capacity()); - -$vector[] = "a"; -var_dump($vector->capacity()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/vector/clear.xml b/reference/ds/ds/vector/clear.xml deleted file mode 100644 index 0960f80a2c24..000000000000 --- a/reference/ds/ds/vector/clear.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - Ds\Vector::clear - Removes all values - - - - &reftitle.description; - - public voidDs\Vector::clear - - - - Removes all values from the vector. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <function>Ds\Vector::clear</function> example - -clear(); -print_r($vector); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 -) -Ds\Vector Object -( -) -]]> - - - - - - - - diff --git a/reference/ds/ds/vector/construct.xml b/reference/ds/ds/vector/construct.xml deleted file mode 100644 index fb9e4d703baf..000000000000 --- a/reference/ds/ds/vector/construct.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Ds\Vector::__construct - Creates a new instance - - - - &reftitle.description; - - public Ds\Vector::__construct - mixedvalues - - - Creates a new instance, using either a traversable - object or an &array; for the initial values. - - - - - &reftitle.parameters; - - - values - - - A traversable object or an &array; to use for the initial values. - - - - - - - - - - - &reftitle.examples; - - <function>Ds\Vector::__construct</function> example - - -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) - [2]=> - int(3) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/vector/contains.xml b/reference/ds/ds/vector/contains.xml deleted file mode 100644 index 061669bf8b54..000000000000 --- a/reference/ds/ds/vector/contains.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - Ds\Vector::contains - Determines if the vector contains given values - - - - &reftitle.description; - - public boolDs\Vector::contains - mixedvalues - - - Determines if the vector contains all values. - - - - - &reftitle.parameters; - - - values - - - Values to check. - - - - - - - - &reftitle.returnvalues; - - &false; if any of the provided values are not in the - vector, &true; otherwise. - - - - - &reftitle.examples; - - <function>Ds\Vector::contains</function> example - -contains('a')); // true -var_dump($vector->contains('a', 'b')); // true -var_dump($vector->contains('c', 'd')); // false - -var_dump($vector->contains(...['c', 'b', 'a'])); // true - -// Always strict -var_dump($vector->contains(1)); // true -var_dump($vector->contains('1')); // false - -var_dump($vector->contains(...[])); // true -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/vector/copy.xml b/reference/ds/ds/vector/copy.xml deleted file mode 100644 index e002980c5d2b..000000000000 --- a/reference/ds/ds/vector/copy.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - Ds\Vector::copy - Returns a shallow copy of the vector - - - - &reftitle.description; - - public Ds\VectorDs\Vector::copy - - - - Returns a shallow copy of the vector. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a shallow copy of the vector. - - - - - &reftitle.examples; - - <function>Ds\Vector::copy</function> example - -copy(); - -// Updating the copy doesn't affect the original -$b->push(4); - -print_r($a); -print_r($b); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 -) -Ds\Vector Object -( - [0] => 1 - [1] => 2 - [2] => 3 - [3] => 4 -) -]]> - - - - - - - - diff --git a/reference/ds/ds/vector/count.xml b/reference/ds/ds/vector/count.xml deleted file mode 100644 index e2eced61ad30..000000000000 --- a/reference/ds/ds/vector/count.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - - Ds\Vector::count - Returns the number of values in the collection - - - - &reftitle.description; - - See Countable::count - - - - - - diff --git a/reference/ds/ds/vector/filter.xml b/reference/ds/ds/vector/filter.xml deleted file mode 100644 index 4e26f00bd1fc..000000000000 --- a/reference/ds/ds/vector/filter.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - Ds\Vector::filter - - Creates a new vector using a callable to - determine which values to include - - - - - &reftitle.description; - - public Ds\VectorDs\Vector::filter - callablecallback - - - Creates a new vector using a callable to - determine which values to include. - - - - - &reftitle.parameters; - - - - callback - - - - - bool - callback - mixedvalue - - - - Optional callable which returns &true; if the value should be included, &false; otherwise. - - - If a callback is not provided, only values which are &true; - (see converting to boolean) - will be included. - - - - - - - - - &reftitle.returnvalues; - - A new vector containing all the values for which - either the callback returned &true;, or all values that - convert to &true; if a callback was not provided. - - - - - &reftitle.examples; - - <function>Ds\Vector::filter</function> example using callback function - -filter(function($value) { - return $value % 2 == 0; -})); -?> -]]> - - &example.outputs.similar; - - - int(2) - [1]=> - int(4) -} -]]> - - - - <function>Ds\Vector::filter</function> example without a callback function - -filter()); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - string(1) "a" - [2]=> - bool(true) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/vector/find.xml b/reference/ds/ds/vector/find.xml deleted file mode 100644 index 3678176bf9fb..000000000000 --- a/reference/ds/ds/vector/find.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Ds\Vector::find - - Attempts to find a value's index - - - - - &reftitle.description; - - public mixedDs\Vector::find - mixedvalue - - - Returns the index of the value, or &false; if not found. - - - - - - &reftitle.parameters; - - - value - - - The value to find. - - - - - - - - &reftitle.returnvalues; - - The index of the value, or &false; if not found. - - - - Values will be compared by value and by type. - - - - - - &reftitle.examples; - - <function>Ds\Vector::find</function> example - -find("a")); // 0 -var_dump($vector->find("b")); // false -var_dump($vector->find("1")); // false -var_dump($vector->find(1)); // 1 -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/vector/first.xml b/reference/ds/ds/vector/first.xml deleted file mode 100644 index 799f99847fd7..000000000000 --- a/reference/ds/ds/vector/first.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - Ds\Vector::first - Returns the first value in the vector - - - - &reftitle.description; - - public mixedDs\Vector::first - - - - Returns the first value in the vector. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The first value in the vector. - - - - - &reftitle.errors; - - UnderflowException if empty. - - - - - &reftitle.examples; - - <function>Ds\Vector::first</function> example - -first()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/vector/get.xml b/reference/ds/ds/vector/get.xml deleted file mode 100644 index 178423cf4d3d..000000000000 --- a/reference/ds/ds/vector/get.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - Ds\Vector::get - Returns the value at a given index - - - - &reftitle.description; - - public mixedDs\Vector::get - intindex - - - Returns the value at a given index. - - - - - - &reftitle.parameters; - - - index - - - The index to access, starting at 0. - - - - - - - - &reftitle.returnvalues; - - The value at the requested index. - - - - - &reftitle.errors; - - OutOfRangeException if the index is not valid. - - - - - &reftitle.examples; - - <function>Ds\Vector::get</function> example - -get(0)); -var_dump($vector->get(1)); -var_dump($vector->get(2)); -?> -]]> - - &example.outputs.similar; - - - - - - <function>Ds\Vector::get</function> example using array syntax - - -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/vector/insert.xml b/reference/ds/ds/vector/insert.xml deleted file mode 100644 index 2f1c67a7fd26..000000000000 --- a/reference/ds/ds/vector/insert.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - Ds\Vector::insert - Inserts values at a given index - - - - &reftitle.description; - - public voidDs\Vector::insert - intindex - mixedvalues - - - Inserts values into the vector at a given index. - - - - - - &reftitle.parameters; - - - index - - - The index at which to insert. 0 <= index <= count - - - - You can insert at the index equal to the number of values. - - - - - - values - - - The value or values to insert. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - OutOfRangeException if the index is not valid. - - - - - &reftitle.examples; - - <function>Ds\Vector::insert</function> example - -insert(0, "e"); // [e] -$vector->insert(1, "f"); // [e, f] -$vector->insert(2, "g"); // [e, f, g] -$vector->insert(0, "a", "b"); // [a, b, e, f, g] -$vector->insert(2, ...["c", "d"]); // [a, b, c, d, e, f, g] - -var_dump($vector); -?> -]]> - - &example.outputs.similar; - - - string(1) "a" - [1]=> - string(1) "b" - [2]=> - string(1) "c" - [3]=> - string(1) "d" - [4]=> - string(1) "e" - [5]=> - string(1) "f" - [6]=> - string(1) "g" -} -]]> - - - - - - - - diff --git a/reference/ds/ds/vector/isempty.xml b/reference/ds/ds/vector/isempty.xml deleted file mode 100644 index 22e301628b52..000000000000 --- a/reference/ds/ds/vector/isempty.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - Ds\Vector::isEmpty - Returns whether the vector is empty - - - - &reftitle.description; - - public boolDs\Vector::isEmpty - - - - Returns whether the vector is empty. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; if the vector is empty, &false; otherwise. - - - - - &reftitle.examples; - - <function>Ds\Vector::isEmpty</function> example - -isEmpty()); -var_dump($b->isEmpty()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/vector/join.xml b/reference/ds/ds/vector/join.xml deleted file mode 100644 index 2d07479405d0..000000000000 --- a/reference/ds/ds/vector/join.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Ds\Vector::join - Joins all values together as a string - - - - &reftitle.description; - - public stringDs\Vector::join - stringglue - - - Joins all values together as a string using an optional separator between each value. - - - - - &reftitle.parameters; - - - glue - - - An optional string to separate each value. - - - - - - - - &reftitle.returnvalues; - - All values of the vector joined together as a string. - - - - - &reftitle.examples; - - <function>Ds\Vector::join</function> example using a separator string - -join("|")); -?> -]]> - - &example.outputs.similar; - - - - - - <function>Ds\Vector::join</function> example without a separator string - -join()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/vector/jsonserialize.xml b/reference/ds/ds/vector/jsonserialize.xml deleted file mode 100644 index f28047ed39be..000000000000 --- a/reference/ds/ds/vector/jsonserialize.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - - Ds\Vector::jsonSerialize - Returns a representation that can be converted to JSON - - - - &reftitle.description; - - See JsonSerializable::jsonSerialize - - - - You should never need to call this directly. - - - - - - - diff --git a/reference/ds/ds/vector/last.xml b/reference/ds/ds/vector/last.xml deleted file mode 100644 index b8d6b68465cf..000000000000 --- a/reference/ds/ds/vector/last.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - Ds\Vector::last - Returns the last value - - - - &reftitle.description; - - public mixedDs\Vector::last - - - - Returns the last value in the vector. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The last value in the vector. - - - - - &reftitle.errors; - - UnderflowException if empty. - - - - - &reftitle.examples; - - <function>Ds\Vector::last</function> example - -last()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/vector/map.xml b/reference/ds/ds/vector/map.xml deleted file mode 100644 index 9664ccd64a38..000000000000 --- a/reference/ds/ds/vector/map.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - Ds\Vector::map - Returns the result of applying a callback to each value - - - - &reftitle.description; - - public Ds\VectorDs\Vector::map - callablecallback - - - Returns the result of applying a callback function to - each value in the vector. - - - - - &reftitle.parameters; - - - callback - - - - - mixed - callback - mixedvalue - - - - A callable to apply to each value in the vector. - - - - The callable should return what the new value will be in the new vector. - - - - - - - - - &reftitle.returnvalues; - - The result of applying a callback to each value in - the vector. - - - - The values of the current instance won't be affected. - - - - - - &reftitle.examples; - - <function>Ds\Vector::map</function> example - -map(function($value) { return $value * 2; })); -print_r($vector); -?> -]]> - - &example.outputs.similar; - - 2 - [1] => 4 - [2] => 6 -) -Ds\Vector Object -( - [0] => 1 - [1] => 2 - [2] => 3 -) -]]> - - - - - - - - diff --git a/reference/ds/ds/vector/merge.xml b/reference/ds/ds/vector/merge.xml deleted file mode 100644 index 955ad6bdde0e..000000000000 --- a/reference/ds/ds/vector/merge.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - Ds\Vector::merge - Returns the result of adding all given values to the vector - - - - &reftitle.description; - - public Ds\VectorDs\Vector::merge - mixedvalues - - - Returns the result of adding all given values to the vector. - - - - - - &reftitle.parameters; - - - values - - - A traversable object or an &array;. - - - - - - - - &reftitle.returnvalues; - - The result of adding all given values to the vector, - effectively the same as adding the values to a copy, then returning that copy. - - - - The current instance won't be affected. - - - - - - &reftitle.examples; - - <function>Ds\Vector::merge</function> example - -merge([4, 5, 6])); -var_dump($vector); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) - [2]=> - int(3) - [3]=> - int(4) - [4]=> - int(5) - [5]=> - int(6) -} -object(Ds\Vector)#1 (3) { - [0]=> - int(1) - [1]=> - int(2) - [2]=> - int(3) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/vector/pop.xml b/reference/ds/ds/vector/pop.xml deleted file mode 100644 index 545d16b0630d..000000000000 --- a/reference/ds/ds/vector/pop.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Ds\Vector::pop - Removes and returns the last value - - - - &reftitle.description; - - public mixedDs\Vector::pop - - - - Removes and returns the last value. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The removed last value. - - - - - &reftitle.errors; - - UnderflowException if empty. - - - - - &reftitle.examples; - - <function>Ds\Vector::pop</function> example - -pop()); -var_dump($vector->pop()); -var_dump($vector->pop()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/vector/push.xml b/reference/ds/ds/vector/push.xml deleted file mode 100644 index 248b9ebca859..000000000000 --- a/reference/ds/ds/vector/push.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Ds\Vector::push - Adds values to the end of the vector - - - - &reftitle.description; - - public voidDs\Vector::push - mixedvalues - - - Adds values to the end of the vector. - - - - - - &reftitle.parameters; - - - values - - - The values to add. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <function>Ds\Vector::push</function> example - -push("a"); -$vector->push("b"); -$vector->push("c", "d"); -$vector->push(...["e", "f"]); - -print_r($vector); -?> -]]> - - &example.outputs.similar; - - a - [1] => b - [2] => c - [3] => d - [4] => e - [5] => f -) -]]> - - - - - - - - diff --git a/reference/ds/ds/vector/reduce.xml b/reference/ds/ds/vector/reduce.xml deleted file mode 100644 index a5a400ed826c..000000000000 --- a/reference/ds/ds/vector/reduce.xml +++ /dev/null @@ -1,159 +0,0 @@ - - - - - - Ds\Vector::reduce - Reduces the vector to a single value using a callback function - - - - &reftitle.description; - - public mixedDs\Vector::reduce - callablecallback - mixedinitial - - - Reduces the vector to a single value using a callback function. - - - - - - &reftitle.parameters; - - - callback - - - - mixedcallback - mixedcarry - mixedvalue - - - - carry - - - The return value of the previous callback, or initial if - it's the first iteration. - - - - - value - - - The value of the current iteration. - - - - - - - - - initial - - - The initial value of the carry value. Can be &null;. - - - - - - - - &reftitle.returnvalues; - - The return value of the final callback. - - - - - &reftitle.examples; - - <function>Ds\Vector::reduce</function> with initial value example - -reduce($callback, 5)); - -// Iterations: -// -// $carry = $initial = 5 -// -// $carry = $carry * 1 = 5 -// $carry = $carry * 2 = 10 -// $carry = $carry * 3 = 30 -?> -]]> - - &example.outputs.similar; - - - - - - <function>Ds\Vector::reduce</function> without an initial value example - -reduce(function($carry, $value) { - return $carry + $value + 5; -})); - -// Iterations: -// -// $carry = $initial = null -// -// $carry = $carry + 1 + 5 = 6 -// $carry = $carry + 2 + 5 = 13 -// $carry = $carry + 3 + 5 = 21 -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/vector/remove.xml b/reference/ds/ds/vector/remove.xml deleted file mode 100644 index b15f809cfe1d..000000000000 --- a/reference/ds/ds/vector/remove.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - Ds\Vector::remove - Removes and returns a value by index - - - - &reftitle.description; - - public mixedDs\Vector::remove - intindex - - - Removes and returns a value by index. - - - - - - &reftitle.parameters; - - - index - - - The index of the value to remove. - - - - - - - - &reftitle.returnvalues; - - The value that was removed. - - - - - &reftitle.errors; - - OutOfRangeException if the index is not valid. - - - - - &reftitle.examples; - - <function>Ds\Vector::remove</function> example - -remove(1)); -var_dump($vector->remove(0)); -var_dump($vector->remove(0)); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/vector/reverse.xml b/reference/ds/ds/vector/reverse.xml deleted file mode 100644 index 2162bfc99355..000000000000 --- a/reference/ds/ds/vector/reverse.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - Ds\Vector::reverse - - Reverses the vector in-place - - - - - &reftitle.description; - - public voidDs\Vector::reverse - - - - Reverses the vector in-place. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <function>Ds\Vector::reverse</function> example - -reverse(); - -print_r($vector); -?> -]]> - - &example.outputs.similar; - - c - [1] => b - [2] => a -) -]]> - - - - - - - - diff --git a/reference/ds/ds/vector/reversed.xml b/reference/ds/ds/vector/reversed.xml deleted file mode 100644 index cca3679a82fc..000000000000 --- a/reference/ds/ds/vector/reversed.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - Ds\Vector::reversed - Returns a reversed copy - - - - &reftitle.description; - - public Ds\VectorDs\Vector::reversed - - - - Returns a reversed copy of the vector. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A reversed copy of the vector. - - - - The current instance is not affected. - - - - - - - &reftitle.examples; - - <function>Ds\Vector::reversed</function> example - -reversed()); -print_r($vector); -?> -]]> - - &example.outputs.similar; - - c - [1] => b - [2] => a -) -Ds\Vector Object -( - [0] => a - [1] => b - [2] => c -) -]]> - - - - - - - - diff --git a/reference/ds/ds/vector/rotate.xml b/reference/ds/ds/vector/rotate.xml deleted file mode 100644 index c3282e59ea92..000000000000 --- a/reference/ds/ds/vector/rotate.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - Ds\Vector::rotate - Rotates the vector by a given number of rotations - - - - &reftitle.description; - - public voidDs\Vector::rotate - introtations - - - Rotates the vector by a given number of rotations, which is equivalent - to successively calling $vector->push($vector->shift()) if the number - of rotations is positive, or $vector->unshift($vector->pop()) if negative. - - - - - - &reftitle.parameters; - - - rotations - - - The number of times the vector should be rotated. - - - - - - - - &reftitle.returnvalues; - - &return.void;. The vector of the current instance will be rotated. - - - - - &reftitle.examples; - - <function>Ds\Vector::rotate</function> example - -rotate(1); // "a" is shifted, then pushed. -print_r($vector); - -$vector->rotate(2); // "b" and "c" are both shifted, then pushed. -print_r($vector); -?> -]]> - - &example.outputs.similar; - - b - [1] => c - [2] => d - [3] => a -) -Ds\Vector Object -( - [0] => d - [1] => a - [2] => b - [3] => c -) -]]> - - - - - - - - diff --git a/reference/ds/ds/vector/set.xml b/reference/ds/ds/vector/set.xml deleted file mode 100644 index 848b73a87d7b..000000000000 --- a/reference/ds/ds/vector/set.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - Ds\Vector::set - Updates a value at a given index - - - - &reftitle.description; - - public voidDs\Vector::set - intindex - mixedvalue - - - Updates a value at a given index. - - - - - - &reftitle.parameters; - - - index - - - The index of the value to update. - - - - - value - - - The new value. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - OutOfRangeException if the index is not valid. - - - - - &reftitle.examples; - - <function>Ds\Vector::set</function> example - -set(1, "_"); -print_r($vector); -?> -]]> - - &example.outputs.similar; - - a - [1] => _ - [2] => c -) -]]> - - - - <function>Ds\Vector::set</function> example using array syntax - - -]]> - - &example.outputs.similar; - - a - [1] => _ - [2] => c -) -]]> - - - - - - - - diff --git a/reference/ds/ds/vector/shift.xml b/reference/ds/ds/vector/shift.xml deleted file mode 100644 index f4facb9657c0..000000000000 --- a/reference/ds/ds/vector/shift.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Ds\Vector::shift - Removes and returns the first value - - - - &reftitle.description; - - public mixedDs\Vector::shift - - - - Removes and returns the first value. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The first value, which was removed. - - - - - &reftitle.errors; - - UnderflowException if empty. - - - - - &reftitle.examples; - - <function>Ds\Vector::shift</function> example - -shift()); -var_dump($vector->shift()); -var_dump($vector->shift()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/vector/slice.xml b/reference/ds/ds/vector/slice.xml deleted file mode 100644 index 15c94e0d6b39..000000000000 --- a/reference/ds/ds/vector/slice.xml +++ /dev/null @@ -1,156 +0,0 @@ - - - - - - Ds\Vector::slice - - Returns a sub-vector of a given range - - - - - &reftitle.description; - - public Ds\VectorDs\Vector::slice - intindex - intlength - - - Creates a sub-vector of a given range. - - - - - - &reftitle.parameters; - - - index - - - The index at which the sub-vector starts. - - - If positive, the vector will start at that index in the vector. - If negative, the vector will start that far from the end. - - - - - length - - - If a length is given and is positive, the resulting - vector will have up to that many values in it. - - If the length results in an overflow, only - values up to the end of the vector will be included. - - If a length is given and is negative, the vector - will stop that many values from the end. - - If a length is not provided, the resulting vector - will contain all values between the index and the - end of the vector. - - - - - - - - &reftitle.returnvalues; - - A sub-vector of the given range. - - - - - &reftitle.examples; - - <function>Ds\Vector::slice</function> example - -slice(2)); - -// Slice from 1, for a length of 3 -print_r($vector->slice(1, 3)); - -// Slice from 1 onwards -print_r($vector->slice(1)); - -// Slice from 2 from the end onwards -print_r($vector->slice(-2)); - -// Slice from 1 to 1 from the end -print_r($vector->slice(1, -1)); -?> -]]> - - &example.outputs.similar; - - c - [1] => d - [2] => e -) -Ds\Vector Object -( - [0] => b - [1] => c - [2] => d -) -Ds\Vector Object -( - [0] => b - [1] => c - [2] => d - [3] => e -) -Ds\Vector Object -( - [0] => d - [1] => e -) -Ds\Vector Object -( - [0] => b - [1] => c - [2] => d -) - -]]> - - - - - - - - diff --git a/reference/ds/ds/vector/sort.xml b/reference/ds/ds/vector/sort.xml deleted file mode 100644 index cb0c0949b100..000000000000 --- a/reference/ds/ds/vector/sort.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - Ds\Vector::sort - - Sorts the vector in-place - - - - - &reftitle.description; - - public voidDs\Vector::sort - callablecomparator - - - Sorts the vector in-place, using an optional comparator function. - - - - - - &reftitle.parameters; - - - comparator - - &sort.callback.description; - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <function>Ds\Vector::sort</function> example - -sort(); - -print_r($vector); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 - [3] => 4 - [4] => 5 -) -]]> - - - - <function>Ds\Vector::sort</function> example using a comparator - -sort(function($a, $b) { - return $b <=> $a; -}); - -print_r($vector); -?> -]]> - - &example.outputs.similar; - - 5 - [1] => 4 - [2] => 3 - [3] => 2 - [4] => 1 -) -]]> - - - - - - - - - diff --git a/reference/ds/ds/vector/sorted.xml b/reference/ds/ds/vector/sorted.xml deleted file mode 100644 index 8f99f36d022d..000000000000 --- a/reference/ds/ds/vector/sorted.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - Ds\Vector::sorted - Returns a sorted copy - - - - &reftitle.description; - - public Ds\VectorDs\Vector::sorted - callablecomparator - - - Returns a sorted copy, using an optional comparator function. - - - - - - &reftitle.parameters; - - - comparator - - &sort.callback.description; - - - - - - - &reftitle.returnvalues; - - Returns a sorted copy of the vector. - - - - - &reftitle.examples; - - <function>Ds\Vector::sorted</function> example - -sorted()); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 - [3] => 4 - [4] => 5 -) -]]> - - - - <function>Ds\Vector::sorted</function> example using a comparator - -sorted(function($a, $b) { - return $b <=> $a; -}); - -print_r($sorted); -?> -]]> - - &example.outputs.similar; - - 5 - [1] => 4 - [2] => 3 - [3] => 2 - [4] => 1 -) -]]> - - - - - - - - - diff --git a/reference/ds/ds/vector/sum.xml b/reference/ds/ds/vector/sum.xml deleted file mode 100644 index 8480fa1469d9..000000000000 --- a/reference/ds/ds/vector/sum.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Ds\Vector::sum - Returns the sum of all values in the vector - - - - &reftitle.description; - - public intfloatDs\Vector::sum - - - - Returns the sum of all values in the vector. - - - - Arrays and objects are considered equal to zero when calculating the sum. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The sum of all the values in the vector as either a float or int - depending on the values in the vector. - - - - - &reftitle.examples; - - <function>Ds\Vector::sum</function> integer example - -sum()); -?> -]]> - - &example.outputs.similar; - - - - - - <function>Ds\Vector::sum</function> float example - -sum()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/ds/ds/vector/toarray.xml b/reference/ds/ds/vector/toarray.xml deleted file mode 100644 index e2126f8dc30c..000000000000 --- a/reference/ds/ds/vector/toarray.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - Ds\Vector::toArray - - Converts the vector to an &array; - - - - - &reftitle.description; - - public arrayDs\Vector::toArray - - - - Converts the vector to an &array;. - - - - Casting to an &array; is not supported yet. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - An &array; containing all the values in the same order as the vector. - - - - - &reftitle.examples; - - <function>Ds\Vector::toArray</function> example - -toArray()); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) - [2]=> - int(3) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/vector/unshift.xml b/reference/ds/ds/vector/unshift.xml deleted file mode 100644 index 20a3e8ab2afa..000000000000 --- a/reference/ds/ds/vector/unshift.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Ds\Vector::unshift - Adds values to the front of the vector - - - - &reftitle.description; - - public voidDs\Vector::unshift - mixedvalues - - - Adds values to the front of the vector, moving all the current - values forward to make room for the new values. - - - - - - &reftitle.parameters; - - - values - - - The values to add to the front of the vector. - - - Multiple values will be added in the same order that they are - passed. - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <function>Ds\Vector::unshift</function> example - -unshift("a"); -$vector->unshift("b", "c"); - -print_r($vector); -?> -]]> - - &example.outputs.similar; - - b - [1] => c - [2] => a - [3] => 1 - [4] => 2 - [5] => 3 -) -]]> - - - - - - - diff --git a/reference/ds/examples.xml b/reference/ds/examples.xml deleted file mode 100644 index 6b593e38f6fd..000000000000 --- a/reference/ds/examples.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - &reftitle.examples; - - Vector - -push('a'); -$vector->push('b', 'c'); - -$vector[] = 'd'; - -print_r($vector); - -?> -]]> - - &example.outputs.similar; - - a - [1] => b - [2] => c - [3] => d -) -]]> - - - - Map - -put('a', 1); -$map->put('b', 2); - -$map['c'] = 3; - -print_r($map); - -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => a - [value] => 1 - ) - - [1] => Ds\Pair Object - ( - [key] => b - [value] => 2 - ) - - [2] => Ds\Pair Object - ( - [key] => c - [value] => 3 - ) - -) -]]> - - - - - diff --git a/reference/ds/setup.xml b/reference/ds/setup.xml deleted file mode 100644 index 66f0fb9923bf..000000000000 --- a/reference/ds/setup.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - &reftitle.setup; - -
- &reftitle.required; - - PHP 7 is required by both the extension and the compatibility polyfill. - -
- -
- &reftitle.install; - - The easiest way to install the extension is via PECL - - - - - - - You can also build directly from source: - - - - - - - - - - If you're using Composer, it's highly recommended that you include - php-ds/php-ds - in your project so that your code is still functional in an environment where the - extension is not installed. The extension will take priority if installed. - - -
- - -
- - diff --git a/reference/ds/versions.xml b/reference/ds/versions.xml deleted file mode 100644 index 654ca032c278..000000000000 --- a/reference/ds/versions.xml +++ /dev/null @@ -1,264 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/eio/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/eio/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/eio/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/eio/book.xml b/reference/eio/book.xml deleted file mode 100644 index 2cb3732439a1..000000000000 --- a/reference/eio/book.xml +++ /dev/null @@ -1,184 +0,0 @@ - - - - - Eio - Eio - - - &reftitle.intro; - - This extension provides asynchronous POSIX I/O by means of libeio C - library written by Marc Lehmann. - - - ¬e.no-windows.extension; - - - - - - It is important to be aware that each request is executed in a thread, and the - order of execution of continuously queued requests basically is - unpredictable. For instance, the following piece of code is incorrect. - - - - - Incorrect requests - -]]> - - - - In the example above eio_rename request may finish - before eio_symlink. To fix it you might call eio_rename - in the callback of eio_symlink: - - Calling request from a request callback - - ]]> - - - - Alternatively, you might want to create a request group: - - - Calling request from a request callback - -]]> - - - Group is a special kind of request that could accumulate a set of regular - eio requests. This could be used to create a complex - request that opens, reads and closes a file. - - - Since version 0.3.0 alpha, a variable used in communications with libeio - internally, could be retrieved with - eio_get_event_stream. The variable could be used - to bind to an event loop supported by some other extension. You might - organize a simple event loop where eio and libevent work together: - - Using eio with libevent - -]]> - - - - - - &reference.eio.setup; - &reference.eio.constants; - &reference.eio.examples; - &reference.eio.reference; - - - diff --git a/reference/eio/configure.xml b/reference/eio/configure.xml deleted file mode 100644 index 4f9fdc444b43..000000000000 --- a/reference/eio/configure.xml +++ /dev/null @@ -1,35 +0,0 @@ - - -
- &reftitle.install; - - - &pecl.info; - &url.pecl.package;eio. - - - For information about manual installation, please - read the file INSTALL included in the package. - - -
- diff --git a/reference/eio/constants.xml b/reference/eio/constants.xml deleted file mode 100644 index 04009193a62c..000000000000 --- a/reference/eio/constants.xml +++ /dev/null @@ -1,663 +0,0 @@ - - - - &reftitle.constants; - &extension.constants; - - Request priority constants: - - - - EIO_PRI_MIN - (int) - - - - Request minimal priority. - - - - - - EIO_PRI_DEFAULT - (int) - - - - Request default priority. - - - - - - EIO_PRI_MAX - (int) - - - - Request maximal priority. - - - - - - - eio_seek whence argument: - - - - EIO_SEEK_SET - (int) - - - - The offset is set to specified number of bytes (offset). - - - - - - EIO_SEEK_CUR - (int) - - - - The offset is set to its current location plus offset bytes. - - - - - - EIO_SEEK_END - (int) - - - - The offset is set to the size of the file plus offset bytes. - - - - - - - - Flags used with eio_readdir: - - - - - EIO_READDIR_DENTS - (int) - - - - eio_readdir flag. If specified, the result argument of the callback - becomes an array with the following keys: - 'names' - array of directory names - 'dents' - array of struct eio_dirent-like - arrays having the following keys each: - 'name' - the directory name; - 'type' - one of EIO_DT_* - constants; - 'inode' - the inode number, if available, otherwise - unspecified. - - - - - - EIO_READDIR_DIRS_FIRST - (int) - - - - When this flag is specified, the names will be returned in an order - where likely directories come first, in optimal stat order. - - - - - - EIO_READDIR_STAT_ORDER - (int) - - - - When this flag is specified, then the names will be returned in an order - suitable for stat'ing each one. When planning to - stat all files in the given directory, the - returned order will likely be - fastest. - - - - - - EIO_READDIR_FOUND_UNKNOWN - (int) - - - - - - - - - - EIO_DT_UNKNOWN - (int) - - - - Unknown node type (very common). Further stat needed. - - - - - - EIO_DT_FIFO - (int) - - - - FIFO node type. - - - - - - EIO_DT_CHR - (int) - - - - Node type. - - - - - - EIO_DT_MPC - (int) - - - - Multiplexed char device (v7+coherent) node type. - - - - - - EIO_DT_DIR - (int) - - - - Directory node type. - - - - - - EIO_DT_NAM - (int) - - - - Xenix special named file node type. - - - - - - EIO_DT_BLK - (int) - - - - Node type. - - - - - - EIO_DT_MPB - (int) - - - - Multiplexed block device (v7+coherent). - - - - - - EIO_DT_REG - (int) - - - - Node type. - - - - - - EIO_DT_NWK - (int) - - - - - - - - - EIO_DT_CMP - (int) - - - - HP-UX network special node type. - - - - - - EIO_DT_LNK - (int) - - - - Link node type. - - - - - - EIO_DT_SOCK - (int) - - - - Socket node type. - - - - - - EIO_DT_DOOR - (int) - - - - Solaris door node type. - - - - - - EIO_DT_WHT - (int) - - - - Node type. - - - - - - EIO_DT_MAX - (int) - - - - Highest node type value. - - - - - - - - Access modes for eio_open flags - argument: - - - - - EIO_O_RDONLY - (int) - - - - - - - - - EIO_O_WRONLY - (int) - - - - - - - - - EIO_O_RDWR - (int) - - - - - - - - - EIO_O_NONBLOCK - (int) - - - - - - - - - EIO_O_APPEND - (int) - - - - - - - - - EIO_O_CREAT - (int) - - - - - - - - - EIO_O_TRUNC - (int) - - - - - - - - - EIO_O_EXCL - (int) - - - - - - - - - EIO_O_FSYNC - (int) - - - - - - - - - - - mode argument flags for eio_open: - - - - - EIO_S_IRUSR - (int) - - - - - - - - - EIO_S_IWUSR - (int) - - - - - - - - - EIO_S_IXUSR - (int) - - - - - - - - - EIO_S_IRGRP - (int) - - - - - - - - - EIO_S_IWGRP - (int) - - - - - - - - - EIO_S_IXGRP - (int) - - - - - - - - - EIO_S_IROTH - (int) - - - - - - - - - EIO_S_IWOTH - (int) - - - - - - - - - EIO_S_IXOTH - (int) - - - - - - - - - EIO_S_IFREG - (int) - - - - - - - - - EIO_S_IFCHR - (int) - - - - - - - - - EIO_S_IFBLK - (int) - - - - - - - - - EIO_S_IFIFO - (int) - - - - - - - - - EIO_S_IFSOCK - (int) - - - - - - - - - - - eio_sync_file_range flags: - - - - - EIO_SYNC_FILE_RANGE_WAIT_BEFORE - (int) - - - - - - - - - EIO_SYNC_FILE_RANGE_WRITE - (int) - - - - - - - - - EIO_SYNC_FILE_RANGE_WAIT_AFTER - (int) - - - - - - - - - - - eio_fallocate flags: - - - - - EIO_FALLOC_FL_KEEP_SIZE - (int) - - - - - - - - - - - - - EIO_S_I* constants have the same meaning as their - S_I* POSIX counterparts. - - - - - - EIO_SYNC_FILE_* constants have the same meaning as their - SYNC_FILE_** counterparts. - - - - - - EIO_O_* constants have the same meaning as their - O_* POSIX counterparts. - - - - diff --git a/reference/eio/examples.xml b/reference/eio/examples.xml deleted file mode 100644 index 8560167c2187..000000000000 --- a/reference/eio/examples.xml +++ /dev/null @@ -1,302 +0,0 @@ - - - - &reftitle.examples; - -Cancelling a request - - -]]> - -&example.outputs.similar; - - - - - - -Calling <function>eio_chmod</function> - - -]]> - -&example.outputs.similar; - - - - - - -Making a custom request - - 1001, - 'data_modified' => "my custom data", - ); - - return $result; -} - -$data = "my_custom_data"; -$req = eio_custom("my_custom", EIO_PRI_DEFAULT, "my_custom_callback", $data); -var_dump($req); -eio_event_loop(); -?> -]]> - -&example.outputs.similar; - - - - - - - - Grouping requests - - 0); - - // Create eio_read() request and add it to the group - $req = eio_read($my_file_fd, 4, 0, EIO_PRI_DEFAULT, "my_grp_file_read_callback"); - eio_grp_add($grp, $req); -} - -/* Is called when eio_read() done */ -function my_grp_file_read_callback($data, $result) { - global $my_file_fd, $grp; - - var_dump($result); - - // Create eio_close() request and add it to the group - $req = eio_close($my_file_fd); - eio_grp_add($grp, $req); -} - -$grp = eio_grp("my_grp_done", "my_grp_data"); - -// Create eio_open() request and add it to the group -$req = eio_open($temp_filename, EIO_O_RDWR | EIO_O_APPEND , NULL, - EIO_PRI_DEFAULT, "my_grp_file_opened_callback", NULL); -eio_grp_add($grp, $req); -var_dump($grp); - -eio_event_loop(); -?> -]]> - -&example.outputs.similar; - - - - - - - - Using eio with libevent extension - -]]> - -&example.outputs.similar; - - - - - - - Using eio with event extension - add(); - -// Add eio jobs -eio_nop(EIO_PRI_DEFAULT, function () { - echo "eio_nop\n"; -}); - -// Add events -$timer = Event::timer($base, function () { - echo "2 seconds elapsed\n"; -}); -$timer->add(2); - -// Dispatch events. -$base->dispatch(); -?> -]]> - -&example.outputs.similar; - - - - - - - diff --git a/reference/eio/functions/eio-busy.xml b/reference/eio/functions/eio-busy.xml deleted file mode 100644 index e0af433ed4bb..000000000000 --- a/reference/eio/functions/eio-busy.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - eio_busy - Artificially increase load. Could be useful in tests, - benchmarking - - - - &reftitle.description; - - resourceeio_busy - intdelay - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_busy artificially increases load taking - delay seconds to execute. May be used for debugging, - or benchmarking. - - - - - &reftitle.parameters; - - - delay - - - Delay in seconds - - - - - pri - - &eio.request.pri.values; - - - - callback - - - This callback is called when all the group requests are done. - - - - - data - - - Arbitrary variable passed to callback. - - - - - - - - &reftitle.returnvalues; - - eio_busy returns request resource on success,&return.falseforfailure;. - - - - &reftitle.seealso; - - eio_nop - - - - - diff --git a/reference/eio/functions/eio-cancel.xml b/reference/eio/functions/eio-cancel.xml deleted file mode 100644 index 20a593731dba..000000000000 --- a/reference/eio/functions/eio-cancel.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - eio_cancel - Cancels a request - - - - &reftitle.description; - - voideio_cancel - resourcereq - - - eio_cancel cancels a request specified by - req - - - - - &reftitle.parameters; - - - req - - - The request resource - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Arbitrary variable passed to callback. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <function>eio_cancel</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - eio_grp_cancel - - - - - diff --git a/reference/eio/functions/eio-chmod.xml b/reference/eio/functions/eio-chmod.xml deleted file mode 100644 index 7dc60befc842..000000000000 --- a/reference/eio/functions/eio-chmod.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - eio_chmod - Change file/directory permissions - - - - &reftitle.description; - - resourceeio_chmod - stringpath - intmode - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_chmod changes file, or directory permissions. The - new permissions are specified by mode. - - - - - - &reftitle.parameters; - - - path - - - Path to the target file or directory - - &eio.warn.relpath; - - - - mode - - - The new permissions. E.g. 0644. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Arbitrary variable passed to callback. - - - - - - - - &reftitle.returnvalues; - - eio_chmod returns request resource on success,&return.falseforfailure;. - - - - - &reftitle.seealso; - - eio_chown - - - - - diff --git a/reference/eio/functions/eio-chown.xml b/reference/eio/functions/eio-chown.xml deleted file mode 100644 index 324ee6c962f0..000000000000 --- a/reference/eio/functions/eio-chown.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - eio_chown - Change file/directory ownership - - - - &reftitle.description; - - resourceeio_chown - stringpath - intuid - intgid-1 - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_chown changes ownership of a file, or directory. The - new owner is specified by uid, and the group by - gid. - - - - - &reftitle.parameters; - - - path - - - Path to file or directory. - - &eio.warn.relpath; - - - - uid - - - User ID. Is ignored when equal to -1. - - - - - gid - - - Group ID. Is ignored when equal to -1. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Arbitrary variable passed to callback. - - - - - - - - &reftitle.returnvalues; - - eio_chown returns request resource on success,&return.falseforfailure;. - - - - - - &reftitle.seealso; - - eio_chmod - - - - - diff --git a/reference/eio/functions/eio-close.xml b/reference/eio/functions/eio-close.xml deleted file mode 100644 index e2487180e040..000000000000 --- a/reference/eio/functions/eio-close.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - eio_close - Close file - - - - &reftitle.description; - - resourceeio_close - mixedfd - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_close closes file specified by - fd. - - - - - - &reftitle.parameters; - - - fd - - - Stream, Socket resource, or numeric file descriptor - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Arbitrary variable passed to callback. - - - - - - - - &reftitle.returnvalues; - - eio_close returns request resource on success,&return.falseforfailure;. - - - - - &reftitle.seealso; - - eio_open - - - - - diff --git a/reference/eio/functions/eio-custom.xml b/reference/eio/functions/eio-custom.xml deleted file mode 100644 index 4c077a1ff0a5..000000000000 --- a/reference/eio/functions/eio-custom.xml +++ /dev/null @@ -1,151 +0,0 @@ - - - - - eio_custom - Execute custom request like any other eio_* call - - - - &reftitle.description; - - resourceeio_custom - callableexecute - intpri - callablecallback - mixeddataNULL - - - eio_custom executes custom function specified by - execute processing it just like any other eio_* call. - - - - - - - &reftitle.parameters; - - - execute - - - Specifies the request function that should match the following prototype: - - - callback is event completion callback that should match the following - prototype: - - - data is the data passed to - execute via data argument - without modifications - result value returned by execute - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Arbitrary variable passed to callback. - - - - - - - - &reftitle.returnvalues; - - eio_custom returns request resource on success,&return.falseforfailure;. - - - - - - - &reftitle.examples; - - <function>eio_custom</function> example - - 1001, - 'data_modified' => "my custom data", - ); - - return $result; -} - -$data = "my_custom_data"; -$req = eio_custom("my_custom", EIO_PRI_DEFAULT, "my_custom_callback", $data); -var_dump($req); -eio_event_loop(); -?> -]]> - -&example.outputs.similar; - - - - - - - - diff --git a/reference/eio/functions/eio-dup2.xml b/reference/eio/functions/eio-dup2.xml deleted file mode 100644 index 3c7ede8f9d5e..000000000000 --- a/reference/eio/functions/eio-dup2.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - eio_dup2 - Duplicate a file descriptor - - - - &reftitle.description; - - resourceeio_dup2 - mixedfd - mixedfd2 - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - - eio_dup2 duplicates file descriptor. - - - - - - &reftitle.parameters; - - - fd - - - Source stream, Socket resource, or numeric file descriptor - - - - - fd2 - - - Target stream, Socket resource, or numeric file descriptor - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Arbitrary variable passed to callback. - - - - - - - - &reftitle.returnvalues; - - eio_dup2 returns request resource on success,&return.falseforfailure;. - - - - - diff --git a/reference/eio/functions/eio-event-loop.xml b/reference/eio/functions/eio-event-loop.xml deleted file mode 100644 index fd273c22237c..000000000000 --- a/reference/eio/functions/eio-event-loop.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - eio_event_loop - Polls libeio until all requests proceeded - - - - &reftitle.description; - - booleio_event_loop - - - - eio_event_loop polls libeio until all requests proceeded. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - eio_event_loop returns &true; on success,&return.falseforfailure;. - - - - - &reftitle.examples; - - <function>eio_event_loop</function> example - - -]]> - -&example.outputs.similar; - - - - - - - - - - &reftitle.seealso; - - eio_poll - - - - - diff --git a/reference/eio/functions/eio-fallocate.xml b/reference/eio/functions/eio-fallocate.xml deleted file mode 100644 index eac03109017c..000000000000 --- a/reference/eio/functions/eio-fallocate.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - eio_fallocate - Allows the caller to directly manipulate the allocated disk - space for a file - - - - &reftitle.description; - - resourceeio_fallocate - mixedfd - intmode - intoffset - intlength - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - - - eio_fallocate allows the caller to directly manipulate the allocated disk space for the - file specified by fd file descriptor for the byte - range starting at offset and continuing for - length bytes. - - - - File should be opened for writing - EIO_O_CREAT should be logically - OR'd with EIO_O_WRONLY, or - EIO_O_RDWR - - - - - - - &reftitle.parameters; - - - fd - - - Stream, Socket resource, or numeric file descriptor, e.g. returned by eio_open. - - - - - mode - - Currently only one flag is supported for mode: - EIO_FALLOC_FL_KEEP_SIZE (the same as POSIX constant - FALLOC_FL_KEEP_SIZE). - - - - - offset - - - Specifies start of the byte range. - - - - - length - - - Specifies length of the byte range. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Arbitrary variable passed to callback. - - - - - - - - &reftitle.returnvalues; - - eio_fallocate returns request resource on success,&return.falseforfailure;. - - - - - diff --git a/reference/eio/functions/eio-fchmod.xml b/reference/eio/functions/eio-fchmod.xml deleted file mode 100644 index 245e81312af7..000000000000 --- a/reference/eio/functions/eio-fchmod.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - eio_fchmod - Change file permissions - - - - &reftitle.description; - - resourceeio_fchmod - mixedfd - intmode - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_fchmod changes permissions for the file specified - by fd file descriptor. - - - - - - &reftitle.parameters; - - - fd - - - Stream, Socket resource, or numeric file descriptor, e.g. returned by eio_open. - - - - - mode - - - The new permissions. E.g. 0644. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Arbitrary variable passed to callback. - - - - - - - - &reftitle.returnvalues; - - eio_fchmod returns request resource on success,&return.falseforfailure;. - - - - - &reftitle.seealso; - - eio_fchown - - - - - diff --git a/reference/eio/functions/eio-fchown.xml b/reference/eio/functions/eio-fchown.xml deleted file mode 100644 index 9b10af704d1d..000000000000 --- a/reference/eio/functions/eio-fchown.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - eio_fchown - Change file ownership - - - - &reftitle.description; - - resourceeio_fchown - mixedfd - intuid - intgid-1 - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_fchown changes ownership of the file specified by - fd file descriptor. - - - - - - &reftitle.parameters; - - - fd - - - Stream, Socket resource, or numeric file descriptor. - - - - - uid - - - User ID. Is ignored when equal to -1. - - - - - gid - - - Group ID. Is ignored when equal to -1. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Arbitrary variable passed to callback. - - - - - - - - &reftitle.returnvalues; - - eio_fchown returns request resource on success,&return.falseforfailure;. - - - - - &reftitle.seealso; - - eio_fchmod - - - - - diff --git a/reference/eio/functions/eio-fdatasync.xml b/reference/eio/functions/eio-fdatasync.xml deleted file mode 100644 index 750773a7c7f5..000000000000 --- a/reference/eio/functions/eio-fdatasync.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - eio_fdatasync - Synchronize a file's in-core state with storage device - - - - &reftitle.description; - - resourceeio_fdatasync - mixedfd - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_fdatasync synchronizes a file's in-core state with storage device. - - - - - - &reftitle.parameters; - - - fd - - - Stream, Socket resource, or numeric file descriptor, e.g. returned by eio_open. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Arbitrary variable passed to callback. - - - - - - - - &reftitle.returnvalues; - - eio_fdatasync returns request resource on success,&return.falseforfailure;. - - - - - diff --git a/reference/eio/functions/eio-fstat.xml b/reference/eio/functions/eio-fstat.xml deleted file mode 100644 index eeb7d9933861..000000000000 --- a/reference/eio/functions/eio-fstat.xml +++ /dev/null @@ -1,174 +0,0 @@ - - - - - eio_fstat - Get file status - - - - &reftitle.description; - - resourceeio_fstat - mixedfd - intpri - callablecallback - mixeddata - - - eio_fstat returns file status information in - result argument of callback - - - - - - &reftitle.parameters; - - - fd - - - Stream, Socket resource, or numeric file descriptor. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Arbitrary variable passed to callback. - - - - - - - - &reftitle.returnvalues; - - eio_fstat returns request resource on success,&return.falseforfailure;. - - - - - &reftitle.examples; - - <function>eio_fstat</function> example - - $result, - 'file'=> $data - ); - // Request stat info - eio_fstat($result, EIO_PRI_DEFAULT, "my_res_cb", $d); - // Process request(s) - eio_event_loop(); -} - -// Open temporary file -eio_open($tmp_filename, EIO_O_RDONLY, NULL, EIO_PRI_DEFAULT, - "my_open_cb", $tmp_filename); -eio_event_loop(); -?> -]]> - - &example.outputs.similar; - - - int(2050) - ["st_ino"]=> - int(2489159) - ["st_mode"]=> - int(33188) - ["st_nlink"]=> - int(1) - ["st_uid"]=> - int(1000) - ["st_gid"]=> - int(100) - ["st_rdev"]=> - int(0) - ["st_blksize"]=> - int(4096) - ["st_blocks"]=> - int(0) - ["st_atime"]=> - int(1318239506) - ["st_mtime"]=> - int(1318239506) - ["st_ctime"]=> - int(1318239506) -} -]]> - - - - - - - &reftitle.seealso; - - eio_lstat - eio_stat - - - - - diff --git a/reference/eio/functions/eio-fstatvfs.xml b/reference/eio/functions/eio-fstatvfs.xml deleted file mode 100644 index 3ac7291cda9f..000000000000 --- a/reference/eio/functions/eio-fstatvfs.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - eio_fstatvfs - Get file system statistics - - - - &reftitle.description; - - resourceeio_fstatvfs - mixedfd - intpri - callablecallback - mixeddata - - - eio_fstatvfs returns file system statistics in - result of callback. - - - - - - &reftitle.parameters; - - - fd - - - A file descriptor of a file within the mounted file system. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Arbitrary variable passed to callback. - - - - - - - - &reftitle.returnvalues; - - eio_fstatvfs returns request resource on success,&return.falseforfailure;. - - - - - &reftitle.seealso; - - eio_statvfs - - - - - diff --git a/reference/eio/functions/eio-fsync.xml b/reference/eio/functions/eio-fsync.xml deleted file mode 100644 index 814b356f1947..000000000000 --- a/reference/eio/functions/eio-fsync.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - eio_fsync - Synchronize a file's in-core state with storage device - - - - &reftitle.description; - - resourceeio_fsync - mixedfd - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - Synchronize a file's in-core state with storage device - - - - - - &reftitle.parameters; - - - fd - - - Stream, Socket resource, or numeric file descriptor. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Arbitrary variable passed to callback. - - - - - - - - &reftitle.returnvalues; - - eio_fsync returns request resource on success,&return.falseforfailure;. - - - - - - &reftitle.seealso; - - eio_sync - - - - - diff --git a/reference/eio/functions/eio-ftruncate.xml b/reference/eio/functions/eio-ftruncate.xml deleted file mode 100644 index d09569560e51..000000000000 --- a/reference/eio/functions/eio-ftruncate.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - eio_ftruncate - Truncate a file - - - - &reftitle.description; - - resourceeio_ftruncate - mixedfd - intoffset0 - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_ftruncate causes a regular file referenced by - fd file descriptor to be truncated to precisely - length bytes. - - - - - - &reftitle.parameters; - - - fd - - - Stream, Socket resource, or numeric file descriptor. - - - - - offset - - - Offset from beginning of the file - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Arbitrary variable passed to callback. - - - - - - - - &reftitle.returnvalues; - - eio_ftruncate returns request resource on success,&return.falseforfailure;. - - - - - - &reftitle.seealso; - - eio_truncate - - - - - diff --git a/reference/eio/functions/eio-futime.xml b/reference/eio/functions/eio-futime.xml deleted file mode 100644 index ace349fa0649..000000000000 --- a/reference/eio/functions/eio-futime.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - eio_futime - Change file last access and modification times - - - - &reftitle.description; - - resourceeio_futime - mixedfd - floatatime - floatmtime - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - - eio_futime changes file last access and modification - times. - - - - - - &reftitle.parameters; - - - fd - - - Stream, Socket resource, or numeric file descriptor, e.g. returned by eio_open - - - - - atime - - - Access time - - - - - mtime - - - Modification time - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Arbitrary variable passed to callback. - - - - - - - - &reftitle.returnvalues; - - eio_futime returns request resource on success,&return.falseforfailure;. - - - - - &reftitle.seealso; - - eio_utime - - - - - diff --git a/reference/eio/functions/eio-get-event-stream.xml b/reference/eio/functions/eio-get-event-stream.xml deleted file mode 100644 index 6ad5aa773343..000000000000 --- a/reference/eio/functions/eio-get-event-stream.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - eio_get_event_stream - Get stream representing a variable used in internal communications with libeio - - - - &reftitle.description; - - mixedeio_get_event_stream - - - - eio_get_event_stream acquires stream representing a - variable used in internal communications with libeio. Could be used to bind - with some event loop provided by other PECL extension, for example - libevent. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - eio_get_event_stream returns stream on success; - otherwise, &null; - - - - - &reftitle.examples; - - Using eio with libevent - - -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/eio/functions/eio-get-last-error.xml b/reference/eio/functions/eio-get-last-error.xml deleted file mode 100644 index 2ee1de8b2ec6..000000000000 --- a/reference/eio/functions/eio-get-last-error.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - eio_get_last_error - Returns string describing the last error associated with a request resource - - - - &reftitle.description; - - stringeio_get_last_error - resourcereq - - - eio_get_last_error returns string describing the last error associated with req. - - - - - &reftitle.parameters; - - - req - - - The request resource. - - - - - - - - &reftitle.returnvalues; - - eio_get_last_error returns string describing the last error associated with the request resource specified by req. - - &warn.experimental.func; - - - diff --git a/reference/eio/functions/eio-grp-add.xml b/reference/eio/functions/eio-grp-add.xml deleted file mode 100644 index e7453b58a84a..000000000000 --- a/reference/eio/functions/eio-grp-add.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - eio_grp_add - Adds a request to the request group - - - - &reftitle.description; - - voideio_grp_add - resourcegrp - resourcereq - - - eio_grp_add adds a request to the request group. - - - - - - &reftitle.parameters; - - - grp - - - The request group resource returned by eio_grp - - - - - req - - - The request resource - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Grouping requests - 0); - - // Create eio_read() request and add it to the group - // Pass file descriptor to the callback - $req = eio_read($result, 4, 0, - EIO_PRI_DEFAULT, "my_grp_file_read_callback", $result); - eio_grp_add($grp, $req); -} - -/* Is called when eio_read() done */ -function my_grp_file_read_callback($data, $result) { - global $grp; - - // Read bytes - var_dump($result); - - // Create eio_close() request and add it to the group - // $data should contain the file descriptor - $req = eio_close($data); - eio_grp_add($grp, $req); -} - -// Create request group -$grp = eio_grp("my_grp_done", $temp_filename); -var_dump($grp); - -// Create eio_open() request and add it to the group -$req = eio_open($temp_filename, EIO_O_RDWR | EIO_O_APPEND , NULL, - EIO_PRI_DEFAULT, "my_grp_file_opened_callback", NULL); -eio_grp_add($grp, $req); - -// Process requests -eio_event_loop(); -?> -]]> - &example.outputs.similar; - - - - - - &reftitle.seealso; - - eio_grp - eio_grp_cancel - eio_grp_limit - - - - - diff --git a/reference/eio/functions/eio-grp-cancel.xml b/reference/eio/functions/eio-grp-cancel.xml deleted file mode 100644 index d1258a2e5759..000000000000 --- a/reference/eio/functions/eio-grp-cancel.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - eio_grp_cancel - Cancels a request group - - - - &reftitle.description; - - voideio_grp_cancel - resourcegrp - - - eio_grp_cancel cancels a group request specified by - grp request group resource. - - - - - - &reftitle.parameters; - - - grp - - - The request group resource returned by eio_grp. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - eio_grp - eio_grp_add - - - - - diff --git a/reference/eio/functions/eio-grp-limit.xml b/reference/eio/functions/eio-grp-limit.xml deleted file mode 100644 index 5b8712aaf2b9..000000000000 --- a/reference/eio/functions/eio-grp-limit.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - eio_grp_limit - Set group limit - - - - &reftitle.description; - - voideio_grp_limit - resourcegrp - intlimit - - - Limit number of requests in the request group. - - - - - - &reftitle.parameters; - - - grp - - - The request group resource. - - - - - limit - - - Number of requests in the group. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - eio_grp_add - - - - - diff --git a/reference/eio/functions/eio-grp.xml b/reference/eio/functions/eio-grp.xml deleted file mode 100644 index 943f28caddc1..000000000000 --- a/reference/eio/functions/eio-grp.xml +++ /dev/null @@ -1,144 +0,0 @@ - - - - - eio_grp - Creates a request group - - - - &reftitle.description; - - resourceeio_grp - callablecallback - stringdataNULL - - - eio_grp creates a request group. - - - - - - &reftitle.parameters; - - - callback - - &eio.callback.proto; - - - - data - - - Arbitrary variable passed to callback. - - - - - - - - &reftitle.returnvalues; - - eio_grp returns request group resource on success,&return.falseforfailure;. - - - - - &reftitle.examples; - - <function>eio_grp</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - eio_grp_cancel - eio_grp_add - - - - - diff --git a/reference/eio/functions/eio-init.xml b/reference/eio/functions/eio-init.xml deleted file mode 100644 index ad1398bb236e..000000000000 --- a/reference/eio/functions/eio-init.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - eio_init - (Re-)initialize Eio - - - - &reftitle.description; - - voideio_init - - - - eio_init (re-)initializes Eio. It allocates memory for internal structures of libeio and Eio itself. You may call eio_init before using Eio functions. Otherwise it will be called internally first time you invoke an Eio function in a process. - - - - This function was removed in version 3.0.0RC1 of the eio extension for PHP version 8 and higher. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/eio/functions/eio-link.xml b/reference/eio/functions/eio-link.xml deleted file mode 100644 index cf46db78ee50..000000000000 --- a/reference/eio/functions/eio-link.xml +++ /dev/null @@ -1,158 +0,0 @@ - - - - - eio_link - Create a hardlink for file - - - - &reftitle.description; - - resourceeio_link - stringpath - stringnew_path - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_link creates a hardlink - new_path for a file specified by - path. - - - - - - &reftitle.parameters; - - - path - - - Source file path. - - - - - new_path - - - Target file path. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Arbitrary variable passed to callback. - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - <function>eio_link</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - eio_symlink - - - - - diff --git a/reference/eio/functions/eio-lstat.xml b/reference/eio/functions/eio-lstat.xml deleted file mode 100644 index 85525cf16a5a..000000000000 --- a/reference/eio/functions/eio-lstat.xml +++ /dev/null @@ -1,159 +0,0 @@ - - - - - eio_lstat - Get file status - - - - &reftitle.description; - - resourceeio_lstat - stringpath - intpri - callablecallback - mixeddataNULL - - - eio_lstat returns file status information in - result argument of callback - - - - - - &reftitle.parameters; - - - path - - - The file path - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Arbitrary variable passed to callback. - - - - - - - - &reftitle.returnvalues; - - eio_lstat returns request resource on success or &false; on error. - - - - - &reftitle.examples; - - <function>eio_lstat</function> example - - -]]> - - &example.outputs.similar; - - - int(2050) - ["st_ino"]=> - int(2099197) - ["st_mode"]=> - int(33188) - ["st_nlink"]=> - int(1) - ["st_uid"]=> - int(1000) - ["st_gid"]=> - int(100) - ["st_rdev"]=> - int(0) - ["st_blksize"]=> - int(4096) - ["st_blocks"]=> - int(0) - ["st_atime"]=> - int(1318235777) - ["st_mtime"]=> - int(1318235777) - ["st_ctime"]=> - int(1318235777) -} -]]> - - - - - - - &reftitle.seealso; - - eio_stat - eio_fstat - - - - - diff --git a/reference/eio/functions/eio-mkdir.xml b/reference/eio/functions/eio-mkdir.xml deleted file mode 100644 index 18eaeb33c309..000000000000 --- a/reference/eio/functions/eio-mkdir.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - eio_mkdir - Create directory - - - - &reftitle.description; - - resourceeio_mkdir - stringpath - intmode - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_mkdir creates directory with specified access - mode. - - - - - - &reftitle.parameters; - - - path - - - Path for the new directory. - - - - - mode - - - Access mode, e.g. 0755 - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Arbitrary variable passed to callback. - - - - - - - - &reftitle.returnvalues; - - eio_mkdir returns request resource on success,&return.falseforfailure;. - - - - - &reftitle.examples; - - <function>eio_mkdir</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - eio_rmdir - - - - - diff --git a/reference/eio/functions/eio-mknod.xml b/reference/eio/functions/eio-mknod.xml deleted file mode 100644 index e9716ae927f7..000000000000 --- a/reference/eio/functions/eio-mknod.xml +++ /dev/null @@ -1,220 +0,0 @@ - - - - - eio_mknod - Create a special or ordinary file - - - - &reftitle.description; - - resourceeio_mknod - stringpath - intmode - intdev - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - - eio_mknod creates ordinary or special(often) file. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - path - - - Path for the new node(file). - - - - - mode - - - Specifies both the permissions to use and the type of node to be - created. It should be a combination (using bitwise OR) of one of the - file types listed below and the permissions for the new node(e.g. 0640). - - Possible file types are: EIO_S_IFREG(regular file), - EIO_S_IFCHR(character file), - EIO_S_IFBLK(block special file), - EIO_S_IFIFO(FIFO - named pipe) and - EIO_S_IFSOCK(UNIX domain socket). - - To specify permissions EIO_S_I* constants could be - used. - - - - - dev - - - If the file type is EIO_S_IFCHR or - EIO_S_IFBLK then dev specifies the major and minor - numbers of the newly created device special file. Otherwise - dev ignored. See mknod(2) man page for - details. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Arbitrary variable passed to callback. - - - - - - - - &reftitle.returnvalues; - - eio_mknod returns request resource on success,&return.falseforfailure;. - - - - - &reftitle.examples; - - <function>eio_mknod</function> example - - -]]> - - &example.outputs.similar; - - - int(17) - [1]=> - int(2337608) - [2]=> - int(4096) - [3]=> - int(1) - [4]=> - int(1000) - [5]=> - int(100) - [6]=> - int(0) - [7]=> - int(0) - [8]=> - int(1318241261) - [9]=> - int(1318241261) - [10]=> - int(1318241261) - [11]=> - int(4096) - [12]=> - int(0) - ["dev"]=> - int(17) - ["ino"]=> - int(2337608) - ["mode"]=> - int(4096) - ["nlink"]=> - int(1) - ["uid"]=> - int(1000) - ["gid"]=> - int(100) - ["rdev"]=> - int(0) - ["size"]=> - int(0) - ["atime"]=> - int(1318241261) - ["mtime"]=> - int(1318241261) - ["ctime"]=> - int(1318241261) - ["blksize"]=> - int(4096) - ["blocks"]=> - int(0) -} -eio_mknod_ok -]]> - - - - - - &reftitle.seealso; - - eio_open - - - - - diff --git a/reference/eio/functions/eio-nop.xml b/reference/eio/functions/eio-nop.xml deleted file mode 100644 index 1dc6499f68b1..000000000000 --- a/reference/eio/functions/eio-nop.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - eio_nop - Does nothing, except go through the whole request cycle - - - - &reftitle.description; - - resourceeio_nop - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_nop does nothing, except go through the whole - request cycle. Could be useful in debugging. - - - - - - &reftitle.parameters; - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Arbitrary variable passed to callback. - - - - - - - - &reftitle.returnvalues; - - eio_nop returns request resource on success,&return.falseforfailure;. - - - - - - &reftitle.seealso; - - eio_busy - - - - - diff --git a/reference/eio/functions/eio-npending.xml b/reference/eio/functions/eio-npending.xml deleted file mode 100644 index 8494dbced4ad..000000000000 --- a/reference/eio/functions/eio-npending.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - eio_npending - Returns number of finished, but unhandled requests - - - - &reftitle.description; - - inteio_npending - - - - eio_npending returns number of finished, but unhandled requests - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - eio_npending returns number of finished, but unhandled - requests. - - - - - - &reftitle.seealso; - - eio_nreqs - eio_nready - eio_nthreads - - - - - diff --git a/reference/eio/functions/eio-nready.xml b/reference/eio/functions/eio-nready.xml deleted file mode 100644 index 7758d28304c9..000000000000 --- a/reference/eio/functions/eio-nready.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - eio_nready - Returns number of not-yet handled requests - - - - &reftitle.description; - - inteio_nready - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - eio_nready returns number of not-yet handled requests - - - - - - &reftitle.seealso; - - eio_nreqs - eio_nthreads - - - - - diff --git a/reference/eio/functions/eio-nreqs.xml b/reference/eio/functions/eio-nreqs.xml deleted file mode 100644 index a3749848c328..000000000000 --- a/reference/eio/functions/eio-nreqs.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - eio_nreqs - Returns number of requests to be processed - - - - &reftitle.description; - - inteio_nreqs - - - - eio_nreqs could be called in a custom loop calling - eio_poll. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - eio_nreqs returns number of requests to be processed. - - - - - &reftitle.examples; - - <function>eio_nreqs</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - eio_poll - eio_nready - - - - - diff --git a/reference/eio/functions/eio-nthreads.xml b/reference/eio/functions/eio-nthreads.xml deleted file mode 100644 index 8d9af66b394b..000000000000 --- a/reference/eio/functions/eio-nthreads.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - eio_nthreads - Returns number of threads currently in use - - - - &reftitle.description; - - inteio_nthreads - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - eio_nthreads returns number of threads currently in - use. - - - - - - &reftitle.seealso; - - eio_npending - eio_nready - eio_nreqs - eio_set_max_idle - eio_set_max_parallel - eio_set_min_parallel - - - - - diff --git a/reference/eio/functions/eio-open.xml b/reference/eio/functions/eio-open.xml deleted file mode 100644 index 9c13904ee7f3..000000000000 --- a/reference/eio/functions/eio-open.xml +++ /dev/null @@ -1,171 +0,0 @@ - - - - - eio_open - Opens a file - - - - &reftitle.description; - - resourceeio_open - stringpath - intflags - intmode - intpri - callablecallback - mixeddataNULL - - - eio_open opens file specified by - path in access mode mode with the - given flags. - - - - - - - &reftitle.parameters; - - - path - - - Path of the file to be opened. - - In some SAPIs(e.g. PHP-FPM) it could fail, if you - don't specify full path. - - - - - - flags - - One of EIO_O_* constants, or their - combinations. EIO_O_* constants have the same - meaning, as their corresponding O_* counterparts - defined in fnctl.h C header file. Default is - EIO_O_RDWR. - - - - - mode - - One of EIO_S_I* constants, or their combination - (via bitwise OR operator). The constants have the same meaning as their - S_I* counterparts defined in sys/stat.h - C header file. Required, if a file is created. Otherwise ignored. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Arbitrary variable passed to callback. - - - - - - - - &reftitle.returnvalues; - - eio_open returns file descriptor in - result argument of callback - on success; otherwise, result is equal to -1. - - - - - &reftitle.examples; - - <function>eio_open</function> example - - 0); - - if ($result > 0) { - // Close the file - eio_close($result, EIO_PRI_DEFAULT, "my_close_cb", $data); - eio_event_loop(); - } -} - -// Create new file for reading and writing -// Deny group and others to do anything with that file -eio_open($temp_filename, EIO_O_CREAT | EIO_O_RDWR, EIO_S_IRUSR | EIO_S_IWUSR, - EIO_PRI_DEFAULT, "my_file_opened_callback", $temp_filename); -eio_event_loop(); -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - eio_mknod - - - - - diff --git a/reference/eio/functions/eio-poll.xml b/reference/eio/functions/eio-poll.xml deleted file mode 100644 index abfd44abe4a9..000000000000 --- a/reference/eio/functions/eio-poll.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - eio_poll - Can be called whenever there are pending requests that need finishing - - - - &reftitle.description; - - inteio_poll - - - - eio_poll can be used to implement special event loop. - For this eio_nreqs could be used to test if there are - unprocessed requests. - - - Applicable only when implementing userspace event loop. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - If any request invocation returns a non-zero value, returns that value. - Otherwise, it returns 0. - - - - - &reftitle.examples; - - <function>eio_poll</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - eio_nreqs - - - - - diff --git a/reference/eio/functions/eio-read.xml b/reference/eio/functions/eio-read.xml deleted file mode 100644 index b183e18ddae8..000000000000 --- a/reference/eio/functions/eio-read.xml +++ /dev/null @@ -1,176 +0,0 @@ - - - - - eio_read - Read from a file descriptor at given offset - - - - &reftitle.description; - - resourceeio_read - mixedfd - intlength - intoffset - intpri - callablecallback - mixeddataNULL - - - eio_read reads up to length - bytes from fd file descriptor at - offset. The read bytes are stored in - result argument of callback. - - - - - - &reftitle.parameters; - - - fd - - - Stream, Socket resource, or numeric file descriptor - - - - - length - - - Maximum number of bytes to read. - - - - - offset - - - Offset within the file. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Arbitrary variable passed to callback. - - - - - - - - &reftitle.returnvalues; - - eio_read stores read bytes in - result argument of callback - function. - - - - - &reftitle.examples; - - <function>eio_read</function> example - - 0) { - // Read 5 bytes starting from third - eio_read($result, 5, 2, EIO_PRI_DEFAULT, "my_read_cb", $result); - eio_event_loop(); - } else { - // eio_open() failed - unlink($data); - } -} - -// Open the file for reading and writing -eio_open($temp_filename, EIO_O_RDWR, NULL, - EIO_PRI_DEFAULT, "my_file_opened_callback", $temp_filename); -eio_event_loop(); -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - eio_open - eio_write - eio_close - eio_event_loop - - - - - diff --git a/reference/eio/functions/eio-readahead.xml b/reference/eio/functions/eio-readahead.xml deleted file mode 100644 index 7bc10d0e896c..000000000000 --- a/reference/eio/functions/eio-readahead.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - eio_readahead - Perform file readahead into page cache - - - - &reftitle.description; - - resourceeio_readahead - mixedfd - intoffset - intlength - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_readahead populates the page cache with data from a file so that subsequent reads from - that file will not block on disk I/O. See READAHEAD(2) man page for details. - - - - - - &reftitle.parameters; - - - fd - - - Stream, Socket resource, or numeric file descriptor - - - - - offset - - - Starting point from which data is to be read. - - - - - length - - - Number of bytes to be read. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Arbitrary variable passed to callback. - - - - - - - - &reftitle.returnvalues; - - eio_readahead returns request resource on success,&return.falseforfailure;. - - - - - diff --git a/reference/eio/functions/eio-readdir.xml b/reference/eio/functions/eio-readdir.xml deleted file mode 100644 index bfd34a63f781..000000000000 --- a/reference/eio/functions/eio-readdir.xml +++ /dev/null @@ -1,476 +0,0 @@ - - - - - eio_readdir - Reads through a whole directory - - - - &reftitle.description; - - resourceeio_readdir - stringpath - intflags - intpri - callablecallback - stringdataNULL - - - Reads through a whole directory(via the opendir, readdir and - closedir system calls) and returns either the names or an array in - result argument of callback - function, depending on the flags argument. - - - - - - &reftitle.parameters; - - - path - - - Directory path. - - - - - flags - - - Combination of EIO_READDIR_* constants. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Arbitrary variable passed to callback. - - - - - - - - &reftitle.returnvalues; - - eio_readdir returns request resource on success,&return.falseforfailure;. - Sets result argument of - callback function according to - flags: - - - - - - - EIO_READDIR_DENTS - (int) - - - - eio_readdir flag. If specified, the result argument of the callback - becomes an array with the following keys: - 'names' - array of directory names - 'dents' - array of struct - eio_dirent-like arrays having the following keys each: - 'name' - the directory name; - 'type' - one of EIO_DT_* - constants; - 'inode' - the inode number, if available, otherwise - unspecified; - - - - - - EIO_READDIR_DIRS_FIRST - (int) - - - - When this flag is specified, the names will be returned in an order - where likely directories come first, in optimal stat order. - - - - - - EIO_READDIR_STAT_ORDER - (int) - - - - When this flag is specified, then the names will be returned in an order - suitable for stat'ing each one. When planning to - stat all files in the given directory, the - returned order will likely be - fastest. - - - - - - EIO_READDIR_FOUND_UNKNOWN - (int) - - - - - - - - - - - Node types: - - - - - EIO_DT_UNKNOWN - (int) - - - - Unknown node type(very common). Further stat needed. - - - - - - EIO_DT_FIFO - (int) - - - - FIFO node type - - - - - - EIO_DT_CHR - (int) - - - - Node type - - - - - - EIO_DT_MPC - (int) - - - - Multiplexed char device (v7+coherent) node type - - - - - - EIO_DT_DIR - (int) - - - - Directory node type - - - - - - EIO_DT_NAM - (int) - - - - Xenix special named file node type - - - - - - EIO_DT_BLK - (int) - - - - Node type - - - - - - EIO_DT_MPB - (int) - - - - Multiplexed block device (v7+coherent) - - - - - - EIO_DT_REG - (int) - - - - Node type - - - - - - EIO_DT_NWK - (int) - - - - - - - - - EIO_DT_CMP - (int) - - - - HP-UX network special node type - - - - - - EIO_DT_LNK - (int) - - - - Link node type - - - - - - EIO_DT_SOCK - (int) - - - - Socket node type - - - - - - EIO_DT_DOOR - (int) - - - - Solaris door node type - - - - - - EIO_DT_WHT - (int) - - - - Node type - - - - - - EIO_DT_MAX - (int) - - - - Highest node type value - - - - - - - - - - &reftitle.examples; - - <function>eio_readdir</function> example - - -]]> - - &example.outputs.similar; - - - array(7) { - [0]=> - string(7) "archive" - [1]=> - string(8) "articles" - [2]=> - string(8) "incoming" - [3]=> - string(7) "innfeed" - [4]=> - string(8) "outgoing" - [5]=> - string(8) "overview" - [6]=> - string(3) "tmp" - } - ["dents"]=> - array(7) { - [0]=> - array(3) - { - ["name"]=> - string(7) - "archive" - ["type"]=> - int(4) - ["inode"]=> - int(393265) - } - [1]=> - array(3) - { - ["name"]=> - string(8) - "articles" - ["type"]=> - int(4) - ["inode"]=> - int(393266) - } - [2]=> - array(3) - { - ["name"]=> - string(8) - "incoming" - ["type"]=> - int(4) - ["inode"]=> - int(393267) - } - [3]=> - array(3) - { - ["name"]=> - string(7) - "innfeed" - ["type"]=> - int(4) - ["inode"]=> - int(393269) - } - [4]=> - array(3) - { - ["name"]=> - string(8) - "outgoing" - ["type"]=> - int(4) - ["inode"]=> - int(393270) - } - [5]=> - array(3) - { - ["name"]=> - string(8) - "overview" - ["type"]=> - int(4) - ["inode"]=> - int(393271) - } - [6]=> - array(3) - { - ["name"]=> - string(3) - "tmp" - ["type"]=> - int(4) - ["inode"]=> - int(393272) - } - } -} -]]> - - - - - - - diff --git a/reference/eio/functions/eio-readlink.xml b/reference/eio/functions/eio-readlink.xml deleted file mode 100644 index b4b750ed8f8d..000000000000 --- a/reference/eio/functions/eio-readlink.xml +++ /dev/null @@ -1,147 +0,0 @@ - - - - - eio_readlink - Read value of a symbolic link - - - - &reftitle.description; - - resourceeio_readlink - stringpath - intpri - callablecallback - mixeddataNULL - - - - - - - - - &reftitle.parameters; - - - path - - - Source symbolic link path - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Arbitrary variable passed to callback. - - - - - - - - &reftitle.returnvalues; - - eio_readlink returns request resource on success,&return.falseforfailure;. - - - - - &reftitle.examples; - - <function>eio_readlink</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - eio_symlink - - - - - diff --git a/reference/eio/functions/eio-realpath.xml b/reference/eio/functions/eio-realpath.xml deleted file mode 100644 index f886fdad672c..000000000000 --- a/reference/eio/functions/eio-realpath.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - eio_realpath - Get the canonicalized absolute pathname - - - - &reftitle.description; - - resourceeio_realpath - stringpath - intpri - callablecallback - stringdataNULL - - - eio_realpath returns the canonicalized absolute - pathname in result argument of - callback function. - - - - - - &reftitle.parameters; - - - path - - - Short pathname - - - - - - pri - - - - - - - - callback - - - - - - - - data - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - <function>eio_realpath</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/eio/functions/eio-rename.xml b/reference/eio/functions/eio-rename.xml deleted file mode 100644 index ac997884b790..000000000000 --- a/reference/eio/functions/eio-rename.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - eio_rename - Change the name or location of a file - - - - &reftitle.description; - - resourceeio_rename - stringpath - stringnew_path - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_rename renames or moves a file to new location. - - - - - - &reftitle.parameters; - - - path - - - Source path - - - - - new_path - - - Target path - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Arbitrary variable passed to callback. - - - - - - - - &reftitle.returnvalues; - - eio_rename returns request resource on success,&return.falseforfailure;. - - - - - &reftitle.examples; - - <function>eio_rename</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/eio/functions/eio-rmdir.xml b/reference/eio/functions/eio-rmdir.xml deleted file mode 100644 index 83c5e613efa7..000000000000 --- a/reference/eio/functions/eio-rmdir.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - eio_rmdir - Remove a directory - - - - &reftitle.description; - - resourceeio_rmdir - stringpath - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_rmdir removes a directory. - - - - - - &reftitle.parameters; - - - path - - - Directory path - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Arbitrary variable passed to callback. - - - - - - - - &reftitle.returnvalues; - - eio_rmdir returns request resource on success,&return.falseforfailure;. - - - - - &reftitle.examples; - - <function>eio_rmdir</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - eio_mkdir - - - - - diff --git a/reference/eio/functions/eio-seek.xml b/reference/eio/functions/eio-seek.xml deleted file mode 100644 index c1c670a57e81..000000000000 --- a/reference/eio/functions/eio-seek.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - eio_seek - Seek to a position - - - - &reftitle.description; - - resourceeio_seek - mixedfd - intoffset - intwhence - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_seek repositions the offset of the open file associated with - stream, Socket instance, or file descriptor specified by fd to - the argument offset according to - the directive whence. - - - - - &reftitle.parameters; - - - fd - - - Stream, Socket instance, or numeric file descriptor. - - - - - offset - - - Starting point from which data is to be read. - - - - - whence - - - whence values are: - - EIO_SEEK_SET - Set position equal to offset bytes. - EIO_SEEK_CUR - Set position to current location plus offset. - EIO_SEEK_END - Set position to end-of-file plus offset. - - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Arbitrary variable passed to callback. - - - - - - - - &reftitle.returnvalues; - - eio_seek returns request resource on success,&return.falseforfailure;. - - - - - diff --git a/reference/eio/functions/eio-sendfile.xml b/reference/eio/functions/eio-sendfile.xml deleted file mode 100644 index 2679b1d7e9a6..000000000000 --- a/reference/eio/functions/eio-sendfile.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - eio_sendfile - Transfer data between file descriptors - - - - &reftitle.description; - - resourceeio_sendfile - mixedout_fd - mixedin_fd - intoffset - intlength - intpri - callablecallback - stringdata - - - eio_sendfile copies data between one file descriptor - and another. See SENDFILE(2) man page for details. - - - - - - &reftitle.parameters; - - - out_fd - - - Output stream, Socket resource, or file descriptor. Should be opened for writing. - - - - - in_fd - - - Input stream, Socket resource, or file descriptor. Should be opened for reading. - - - - - offset - - - Offset within the source file. - - - - - length - - - Number of bytes to copy. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Arbitrary variable passed to callback. - - - - - - - - &reftitle.returnvalues; - - eio_sendfile returns request resource on success,&return.falseforfailure;. - - - - - diff --git a/reference/eio/functions/eio-set-max-idle.xml b/reference/eio/functions/eio-set-max-idle.xml deleted file mode 100644 index 8c99ed90419a..000000000000 --- a/reference/eio/functions/eio-set-max-idle.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - eio_set_max_idle - Set maximum number of idle threads - - - - &reftitle.description; - - voideio_set_max_idle - intnthreads - - - - - - - - - &reftitle.parameters; - - - nthreads - - - Number of idle threads. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - eio_nthreads - eio_set_min_parallel - eio_set_max_parallel - - - - - diff --git a/reference/eio/functions/eio-set-max-parallel.xml b/reference/eio/functions/eio-set-max-parallel.xml deleted file mode 100644 index 45aae2e122fd..000000000000 --- a/reference/eio/functions/eio-set-max-parallel.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - eio_set_max_parallel - Set maximum parallel threads - - - - &reftitle.description; - - voideio_set_max_parallel - intnthreads - - - - - - - - - &reftitle.parameters; - - - nthreads - - - Number of parallel threads - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - eio_nthreads - eio_set_max_idle - eio_set_min_parallel - - - - - diff --git a/reference/eio/functions/eio-set-max-poll-reqs.xml b/reference/eio/functions/eio-set-max-poll-reqs.xml deleted file mode 100644 index d6fa6bb3caf1..000000000000 --- a/reference/eio/functions/eio-set-max-poll-reqs.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - eio_set_max_poll_reqs - Set maximum number of requests processed in a poll - - - - &reftitle.description; - - voideio_set_max_poll_reqs - intnreqs - - - - - - - - - &reftitle.parameters; - - - nreqs - - - Number of requests - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/eio/functions/eio-set-max-poll-time.xml b/reference/eio/functions/eio-set-max-poll-time.xml deleted file mode 100644 index f68dcfb80ebf..000000000000 --- a/reference/eio/functions/eio-set-max-poll-time.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - eio_set_max_poll_time - Set maximum poll time - - - - &reftitle.description; - - voideio_set_max_poll_time - floatnseconds - - - Polling stops, if poll took longer than nseconds - seconds. - - - - - - &reftitle.parameters; - - - nseconds - - - Number of seconds - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/eio/functions/eio-set-min-parallel.xml b/reference/eio/functions/eio-set-min-parallel.xml deleted file mode 100644 index 72a51ef951bf..000000000000 --- a/reference/eio/functions/eio-set-min-parallel.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - eio_set_min_parallel - Set minimum parallel thread number - - - - &reftitle.description; - - voideio_set_min_parallel - stringnthreads - - - - - - - - - &reftitle.parameters; - - - nthreads - - - Number of parallel threads. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - &reftitle.seealso; - - eio_nthreads - eio_set_max_idle - eio_set_max_parallel - - - - - diff --git a/reference/eio/functions/eio-stat.xml b/reference/eio/functions/eio-stat.xml deleted file mode 100644 index abedfc5ef004..000000000000 --- a/reference/eio/functions/eio-stat.xml +++ /dev/null @@ -1,161 +0,0 @@ - - - - - eio_stat - Get file status - - - - &reftitle.description; - - resourceeio_stat - stringpath - intpri - callablecallback - mixeddataNULL - - - eio_stat returns file status information in - result argument of callback - - - - - - &reftitle.parameters; - - - path - - - The file path - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Arbitrary variable passed to callback. - - - - - - - - &reftitle.returnvalues; - - eio_stat returns request resource on success or - &false; on error. On success assigns result argument of - callback to an array. - - - - - &reftitle.examples; - - <function>eio_stat</function> example - - -]]> - - &example.outputs.similar; - - - int(2050) - ["st_ino"]=> - int(2489173) - ["st_mode"]=> - int(33188) - ["st_nlink"]=> - int(1) - ["st_uid"]=> - int(1000) - ["st_gid"]=> - int(100) - ["st_rdev"]=> - int(0) - ["st_blksize"]=> - int(4096) - ["st_blocks"]=> - int(0) - ["st_atime"]=> - int(1318250380) - ["st_mtime"]=> - int(1318250380) - ["st_ctime"]=> - int(1318250380) -} -]]> - - - - - - - &reftitle.seealso; - - eio_lstat - eio_fstat - - - - - diff --git a/reference/eio/functions/eio-statvfs.xml b/reference/eio/functions/eio-statvfs.xml deleted file mode 100644 index dfd0b43f8984..000000000000 --- a/reference/eio/functions/eio-statvfs.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - eio_statvfs - Get file system statistics - - - - &reftitle.description; - - resourceeio_statvfs - stringpath - intpri - callablecallback - mixeddata - - - eio_statvfs returns file system statistics information in - result argument of callback - - - - - &reftitle.parameters; - - - path - - - Pathname of any file within the mounted file system - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Arbitrary variable passed to callback. - - - - - - - - &reftitle.returnvalues; - - eio_statvfs returns request resource on success,&return.falseforfailure;. - On success assigns result argument of - callback to an array. - - - - - &reftitle.examples; - - <function>eio_statvfs</function> example - - -]]> - - &example.outputs.similar; - - - int(4096) - ["f_frsize"]=> - int(4096) - ["f_blocks"]=> - int(262144) - ["f_bfree"]=> - int(262111) - ["f_bavail"]=> - int(262111) - ["f_files"]=> - int(1540815) - ["f_ffree"]=> - int(1540743) - ["f_favail"]=> - int(1540743) - ["f_fsid"]=> - int(0) - ["f_flag"]=> - int(4102) - ["f_namemax"]=> - int(255) -} -]]> - - - - - - - diff --git a/reference/eio/functions/eio-symlink.xml b/reference/eio/functions/eio-symlink.xml deleted file mode 100644 index ba147b08ed76..000000000000 --- a/reference/eio/functions/eio-symlink.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - eio_symlink - Create a symbolic link - - - - &reftitle.description; - - resourceeio_symlink - stringpath - stringnew_path - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - - eio_symlink creates a symbolic link - new_path to path. - - - - - - &reftitle.parameters; - - - path - - - Source path - - - - - new_path - - - Target path - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Arbitrary variable passed to callback. - - - - - - - - &reftitle.returnvalues; - - eio_symlink returns request resource on success,&return.falseforfailure;. - - - - - &reftitle.examples; - - <function>eio_symlink</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - eio_link - - - - - diff --git a/reference/eio/functions/eio-sync-file-range.xml b/reference/eio/functions/eio-sync-file-range.xml deleted file mode 100644 index a987a15793a1..000000000000 --- a/reference/eio/functions/eio-sync-file-range.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - eio_sync_file_range - Sync a file segment with disk - - - - &reftitle.description; - - resourceeio_sync_file_range - mixedfd - intoffset - intnbytes - intflags - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_sync_file_range permits fine control when synchronizing the open file referred to by the file - descriptor fd with disk. - - - - - - &reftitle.parameters; - - - fd - - - File descriptor - - - - - offset - - - The starting byte of the file range to be synchronized - - - - - nbytes - - - Specifies the length of the range to be synchronized, in bytes. If - nbytes is zero, then all bytes from offset through - to the end of file are synchronized. - - - - - flags - - - A bit-mask. Can include any of the following values: - EIO_SYNC_FILE_RANGE_WAIT_BEFORE, - EIO_SYNC_FILE_RANGE_WRITE, - EIO_SYNC_FILE_RANGE_WAIT_AFTER. These flags have - the same meaning as their SYNC_FILE_RANGE_* - counterparts(see SYNC_FILE_RANGE(2) man page). - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Arbitrary variable passed to callback. - - - - - - - - &reftitle.returnvalues; - - eio_sync_file_range returns request resource on success,&return.falseforfailure;. - - - - - diff --git a/reference/eio/functions/eio-sync.xml b/reference/eio/functions/eio-sync.xml deleted file mode 100644 index 873ebf616656..000000000000 --- a/reference/eio/functions/eio-sync.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - eio_sync - Commit buffer cache to disk - - - - &reftitle.description; - - resourceeio_sync - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - eio_sync returns request resource on success,&return.falseforfailure;. - - - - - diff --git a/reference/eio/functions/eio-syncfs.xml b/reference/eio/functions/eio-syncfs.xml deleted file mode 100644 index 82c76fe0baa3..000000000000 --- a/reference/eio/functions/eio-syncfs.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - eio_syncfs - Calls Linux' syncfs syscall, if available - - - - &reftitle.description; - - resourceeio_syncfs - mixedfd - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - - - - - - - &reftitle.parameters; - - - fd - - - File descriptor - - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Arbitrary variable passed to callback. - - - - - - - - &reftitle.returnvalues; - - eio_syncfs returns request resource on success,&return.falseforfailure;. - - - - - - diff --git a/reference/eio/functions/eio-truncate.xml b/reference/eio/functions/eio-truncate.xml deleted file mode 100644 index b7819a4fa9dc..000000000000 --- a/reference/eio/functions/eio-truncate.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - eio_truncate - Truncate a file - - - - &reftitle.description; - - resourceeio_truncate - stringpath - intoffset0 - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_truncate causes the regular file named by path to be truncated to - a size of precisely length bytes - - - - - - &reftitle.parameters; - - - path - - - File path - - - - - offset - - - Offset from beginning of the file. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Arbitrary variable passed to callback. - - - - - - - - &reftitle.returnvalues; - - eio_truncate returns request resource on success,&return.falseforfailure;. - - - - - &reftitle.seealso; - - eio_ftruncate - - - - - diff --git a/reference/eio/functions/eio-unlink.xml b/reference/eio/functions/eio-unlink.xml deleted file mode 100644 index 78b300a3c90a..000000000000 --- a/reference/eio/functions/eio-unlink.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - eio_unlink - Delete a name and possibly the file it refers to - - - - &reftitle.description; - - resourceeio_unlink - stringpath - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_unlink deletes a name from the file system. - - - - - - &reftitle.parameters; - - - path - - - Path to file - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Arbitrary variable passed to callback. - - - - - - - - &reftitle.returnvalues; - - eio_unlink returns request resource on success,&return.falseforfailure;. - - - - - diff --git a/reference/eio/functions/eio-utime.xml b/reference/eio/functions/eio-utime.xml deleted file mode 100644 index 9c4cb17e8478..000000000000 --- a/reference/eio/functions/eio-utime.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - eio_utime - Change file last access and modification times - - - - &reftitle.description; - - resourceeio_utime - stringpath - floatatime - floatmtime - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - - - - - - - &reftitle.parameters; - - - path - - - Path to the file. - - - - - atime - - - Access time - - - - - mtime - - - Modification time - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Arbitrary variable passed to callback. - - - - - - - - &reftitle.returnvalues; - - eio_utime returns request resource on success,&return.falseforfailure;. - - - - - &reftitle.seealso; - - eio_futime - - - - - diff --git a/reference/eio/functions/eio-write.xml b/reference/eio/functions/eio-write.xml deleted file mode 100644 index 8c5b5050652b..000000000000 --- a/reference/eio/functions/eio-write.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - eio_write - Write to file - - - - &reftitle.description; - - resourceeio_write - mixedfd - stringstr - intlength0 - intoffset0 - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_write writes up to length - bytes from str at offset - offset from the beginning of the file. - - - - - - &reftitle.parameters; - - - fd - - - Stream, Socket resource, or numeric file descriptor, e.g. returned by eio_open - - - - - str - - - Source string - - - - - length - - - Maximum number of bytes to write. - - - - - offset - - - Offset from the beginning of file. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Arbitrary variable passed to callback. - - - - - - - - &reftitle.returnvalues; - - eio_write returns request resource on success,&return.falseforfailure;. - - - - - &reftitle.seealso; - - eio_open - - - - - diff --git a/reference/eio/reference.xml b/reference/eio/reference.xml deleted file mode 100644 index 5d0865305fe9..000000000000 --- a/reference/eio/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - Eio &Functions; - - &reference.eio.entities.functions; - - - - diff --git a/reference/eio/setup.xml b/reference/eio/setup.xml deleted file mode 100644 index 3668e9dfbf48..000000000000 --- a/reference/eio/setup.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - &reftitle.setup; - -
- &reftitle.required; - - This extension has libeio - library embedded. So you do NOT need to install libeio separately. - -
- - - &reference.eio.configure; - -
- &reftitle.resources; - - There are two resource types in this extension: request and request group. - -
- -
- diff --git a/reference/eio/versions.xml b/reference/eio/versions.xml deleted file mode 100644 index f132ce1ae95f..000000000000 --- a/reference/eio/versions.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/ev/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/ev/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/ev/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/ev/book.xml b/reference/ev/book.xml deleted file mode 100644 index 6ffe59ebbb85..000000000000 --- a/reference/ev/book.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - Ev - Ev - - &reftitle.intro; - - This extension provides interface to - libev - library - a high performance full-featured event loop written in C. - - - ¬e.no-windows.extension; - - - Libev - is an event loop: one registers interest in certain events (such as a file - descriptor being readable or a timeout occurring), and it will manage these - event sources and provide the program with events. - - - To do this, it must take more or less complete control over the process (or - thread) by executing the event loop handler, and will then communicate - events via a callback mechanism. - - - You register interest in certain events by registering so-called event - watchers, and then hand it over to libev by starting the watcher. - - - For details refer to the - documentation of libev. - - - - &reference.ev.setup; - &reference.ev.examples; - &reference.ev.watchers; - &reference.ev.watcher-callbacks; - &reference.ev.periodic-modes; - &reference.ev.ev; - &reference.ev.evcheck; - &reference.ev.evchild; - &reference.ev.evembed; - &reference.ev.evfork; - &reference.ev.evidle; - &reference.ev.evio; - &reference.ev.evloop; - &reference.ev.evperiodic; - &reference.ev.evprepare; - &reference.ev.evsignal; - &reference.ev.evstat; - &reference.ev.evtimer; - &reference.ev.evwatcher; - - - diff --git a/reference/ev/configure.xml b/reference/ev/configure.xml deleted file mode 100644 index 7bf61d39e70d..000000000000 --- a/reference/ev/configure.xml +++ /dev/null @@ -1,35 +0,0 @@ - - -
- &reftitle.install; - - - &pecl.info; - &url.pecl.package;ev - - - For information about manual installation, please read the file - INSTALL.md - included in the package source. - -
- diff --git a/reference/ev/ev.xml b/reference/ev/ev.xml deleted file mode 100644 index aed606241278..000000000000 --- a/reference/ev/ev.xml +++ /dev/null @@ -1,821 +0,0 @@ - - - - The Ev class - Ev - -
- &reftitle.intro; - - Ev is a static class providing access to the default loop and to some common - operations. - -
- -
- &reftitle.classsynopsis; - - - - Ev - - - - final - Ev - - - - &Constants; - - - const - int - Ev::FLAG_AUTO - 0 - - - const - int - Ev::FLAG_NOENV - 16777216 - - - const - int - Ev::FLAG_FORKCHECK - 33554432 - - - const - int - Ev::FLAG_NOINOTIFY - 1048576 - - - const - int - Ev::FLAG_SIGNALFD - 2097152 - - - const - int - Ev::FLAG_NOSIGMASK - 4194304 - - - const - int - Ev::RUN_NOWAIT - 1 - - - const - int - Ev::RUN_ONCE - 2 - - - const - int - Ev::BREAK_CANCEL - 0 - - - const - int - Ev::BREAK_ONE - 1 - - - const - int - Ev::BREAK_ALL - 2 - - - const - int - Ev::MINPRI - -2 - - - const - int - Ev::MAXPRI - 2 - - - const - int - Ev::READ - 1 - - - const - int - Ev::WRITE - 2 - - - const - int - Ev::TIMER - 256 - - - const - int - Ev::PERIODIC - 512 - - - const - int - Ev::SIGNAL - 1024 - - - const - int - Ev::CHILD - 2048 - - - const - int - Ev::STAT - 4096 - - - const - int - Ev::IDLE - 8192 - - - const - int - Ev::PREPARE - 16384 - - - const - int - Ev::CHECK - 32768 - - - const - int - Ev::EMBED - 65536 - - - const - int - Ev::CUSTOM - 16777216 - - - const - int - Ev::ERROR - 2147483648 - - - const - int - Ev::BACKEND_SELECT - 1 - - - const - int - Ev::BACKEND_POLL - 2 - - - const - int - Ev::BACKEND_EPOLL - 4 - - - const - int - Ev::BACKEND_KQUEUE - 8 - - - const - int - Ev::BACKEND_DEVPOLL - 16 - - - const - int - Ev::BACKEND_PORT - 32 - - - const - int - Ev::BACKEND_ALL - 63 - - - const - int - Ev::BACKEND_MASK - 65535 - - - &Methods; - - - -
- -
- &reftitle.constants; - - - Flags passed to create a loop: - - - - - Ev::FLAG_AUTO - - - - The default flags value - - - - - - Ev::FLAG_NOENV - - - - If this flag used(or the program runs setuid or setgid), - libev - won't look at the environment variable - LIBEV_FLAGS. - Otherwise(by default), - LIBEV_FLAGS - will override the flags completely if it is found. Useful for - performance tests and searching for bugs. - - - - - - Ev::FLAG_FORKCHECK - - - - Makes libev check for a fork in each iteration, instead of calling - EvLoop::fork - manually. This works by calling - getpid() - on every iteration of the loop, and thus this might slow down the - event loop with lots of loop iterations, but usually is not - noticeable. This flag setting cannot be overridden or specified in the - LIBEV_FLAGS - environment variable. - - - - - - Ev::FLAG_NOINOTIFY - - - - When this flag is specified, - libev - won't attempt to use the - inotify - API for its - ev_stat - watchers. The flag can be useful to conserve inotify file descriptors, - as otherwise each loop using - ev_stat - watchers consumes one - inotify - handle. - - - - - - Ev::FLAG_SIGNALFD - - - - When this flag is specified, - libev - will attempt to use the - signalfd - API for its - ev_signal - (and - ev_child) - watchers. This API delivers signals synchronously, which makes it - both faster and might make it possible to get the queued signal data. - It can also simplify signal handling with threads, as long as signals - are properly blocked in threads. - Signalfd - will not be used by default. - - - - - - Ev::FLAG_NOSIGMASK - - - - When this flag is specified, - libev - will avoid to modify the signal mask. Specifically, this means having - to make sure signals are unblocked before receiving them. - - - This behaviour is useful for custom signal handling, or handling - signals only in specific threads. - - - - - - - - Flags passed to - Ev::run, - or - EvLoop::run - - - - - Ev::RUN_NOWAIT - - - - Means that event loop will look for new events, will handle those - events and any already outstanding ones, but will not wait and block - the process in case there are no events and will return after one - iteration of the loop. This is sometimes useful to poll and handle new - events while doing lengthy calculations, to keep the program - responsive. - - - - - - Ev::RUN_ONCE - - - - Means that event loop will look for new events (waiting if necessary) - and will handle those and any already outstanding ones. It will block - the process until at least one new event arrives (which could be an - event internal to libev itself, so there is no guarantee that a - user-registered callback will be called), and will return after one - iteration of the loop. - - - - - - - - Flags passed to - Ev::stop, - or - EvLoop::stop - - - - - Ev::BREAK_CANCEL - - - - Cancel the break operation. - - - - - - Ev::BREAK_ONE - - - - Makes the innermost - Ev::run - (or - EvLoop::run) - call return. - - - - - - Ev::BREAK_ALL - - - - Makes all nested - Ev::run - (or - EvLoop::run) - calls return. - - - - - - - - Watcher priorities: - - - - Ev::MINPRI - - - - Minimum allowed watcher priority. - - - - - - Ev::MAXPRI - - - - Maximum allowed watcher priority. - - - - - - - - Bit masks of (received) events: - - - - Ev::READ - - - - The file descriptor in the - EvIo - watcher has become readable. - - - - - - Ev::WRITE - - - - The file descriptor in the - EvIo - watcher has become writable. - - - - - - Ev::TIMER - - - - EvTimer - watcher has been timed out. - - - - - - Ev::PERIODIC - - - - EvPeriodic - watcher has been timed out. - - - - - - Ev::SIGNAL - - - - A signal specified in - EvSignal::__construct - has been received. - - - - - - Ev::CHILD - - - - The - pid - specified in - EvChild::__construct - has received a status change. - - - - - - Ev::STAT - - - - The path specified in - EvStat - watcher changed its attributes. - - - - - - Ev::IDLE - - - - EvIdle - watcher works when there is nothing to do with other watchers. - - - - - - Ev::PREPARE - - - - All - EvPrepare - watchers are invoked just before - Ev::run - starts. Thus, - EvPrepare - watchers are the last watchers invoked before the event loop sleeps or - polls for new events. - - - - - - Ev::CHECK - - - - All - EvCheck - watchers are queued just after - Ev::run - has gathered the new events, but before it queues any callbacks for - any received events. Thus, - EvCheck - watchers will be invoked before any other watchers of the same or - lower priority within an event loop iteration. - - - - - - Ev::EMBED - - - - The embedded event loop specified in the - EvEmbed - watcher needs attention. - - - - - - Ev::CUSTOM - - - - Not ever sent(or otherwise used) by - libev - itself, but can be freely used by - libev - users to signal watchers (e.g. via - EvWatcher::feed - ). - - - - - - Ev::ERROR - - - - An unspecified error has occurred, the watcher has been stopped. This - might happen because the watcher could not be properly started because - libev - ran out of memory, a file descriptor was found to be closed or any - other problem. - Libev - considers these application bugs. See also - ANATOMY - OF A WATCHER - - - - - - - - Backend flags: - - - - Ev::BACKEND_SELECT - - - - select(2) backend - - - - - - Ev::BACKEND_POLL - - - - poll(2) backend - - - - - - Ev::BACKEND_EPOLL - - - - Linux-specific - epoll(7) - backend for both pre- and post-2.6.9 kernels - - - - - - Ev::BACKEND_KQUEUE - - - - kqueue - backend used on most BSD systems. - EvEmbed - watcher could be used to embed one loop(with kqueue backend) into - another. For instance, one can try to create an event loop with - kqueue - backend and use it for sockets only. - - - - - - Ev::BACKEND_DEVPOLL - - - - Solaris 8 backend. This is not implemented yet. - - - - - - Ev::BACKEND_PORT - - - - Solaris 10 event port mechanism with a good scaling. - - - - - - Ev::BACKEND_ALL - - - - Try all backends(even corrupted ones). It's not recommended to use it - explicitly. Bitwise operators should be applied here(e.g. - Ev::BACKEND_ALL - & ~ - Ev::BACKEND_KQUEUE) - Use - Ev::recommendedBackends, - or don't specify any backends at all. - - - - - - Ev::BACKEND_MASK - - - - Not a backend, but a mask to select all backend bits from - flags - value to mask out any backends(e.g. when modifying the - LIBEV_FLAGS - environment variable). - - - - - - - - - For the default loop during module initialization phase - Ev - registers - ev_loop_fork - call by means of - pthread_atfork - (if available). - - - - - There are methods providing access to the - default event - loop - in - Ev - class(e.g. - Ev::iteration, - Ev::depth - etc.) For - custom loops - (created with - EvLoop::__construct) - these values may be accessed via corresponding properties and methods - of the - EvLoop - class. - - - The instance of the default event loop itself can be fetched by means of - EvLoop::defaultLoop - method. - - -
- -
- - &reference.ev.entities.ev; - -
- diff --git a/reference/ev/ev/backend.xml b/reference/ev/ev/backend.xml deleted file mode 100644 index 202675315864..000000000000 --- a/reference/ev/ev/backend.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - Ev::backend - Returns an integer describing the backend used by libev - - - &reftitle.description; - - final - public - static - int - Ev::backend - - - - Returns an integer describing the backend used by - libev. - See - Backend flags - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Returns an integer(bit mask) describing the backend used by - libev. - - - - &reftitle.seealso; - - - EvEmbed - - - Ev::embeddableBackends - - - Ev::recommendedBackends - - - Ev::supportedBackends - - - Backend flags - - - - - diff --git a/reference/ev/ev/depth.xml b/reference/ev/ev/depth.xml deleted file mode 100644 index 0c8842237685..000000000000 --- a/reference/ev/ev/depth.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - Ev::depth - Returns recursion depth - - - &reftitle.description; - - final - public - static - int - Ev::depth - - - - The number of times - Ev::run - was entered minus the number of times - Ev::run - was exited normally, in other words, the recursion depth. Outside - Ev::run, - this number is - 0. - In a callback, this number is - 1, - unless - Ev::run - was invoked recursively (or from another thread), in which case it is - higher. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - ev_depth - returns recursion depth of the default loop. - - - - &reftitle.seealso; - - - Ev::iteration - - - - - diff --git a/reference/ev/ev/embeddablebackends.xml b/reference/ev/ev/embeddablebackends.xml deleted file mode 100644 index 2049eb00c35b..000000000000 --- a/reference/ev/ev/embeddablebackends.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - Ev::embeddableBackends - Returns the set of backends that are embeddable in other event loops - - - &reftitle.description; - - final - public - static - int - Ev::embeddableBackends - - - - Returns the set of backends that are embeddable in other event loops. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Returns a bit mask which can containing - backend flags - combined using bitwise - OR - operator. - - - - &reftitle.examples; - - Embedding loop created with kqueue backend into the default loop - - -]]> - - - - - &reftitle.seealso; - - - EvEmbed - - - Ev::recommendedBackends - - - Ev::supportedBackends - - - Backend flags - - - Examples - - - - - diff --git a/reference/ev/ev/feedsignal.xml b/reference/ev/ev/feedsignal.xml deleted file mode 100644 index 36dfbe862dd6..000000000000 --- a/reference/ev/ev/feedsignal.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - Ev::feedSignal - Feed a signal event into Ev - - - &reftitle.description; - - final - public - static - void - Ev::feedSignal - - int - signum - - - - Simulates a signal receive. It is safe to call this function at any time, - from any context, including signal handlers or random threads. Its main use - is to customise signal handling in the process. - - - Unlike - Ev::feedSignalEvent, - this works regardless of which loop has registered the signal. - - - - &reftitle.parameters; - - - - signum - - - - Signal number. See - signal(7) - man page for details. You can use constants exported by - pcntl - extension. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - Ev::feedSignalEvent - - - - - diff --git a/reference/ev/ev/feedsignalevent.xml b/reference/ev/ev/feedsignalevent.xml deleted file mode 100644 index b1c0f604ee37..000000000000 --- a/reference/ev/ev/feedsignalevent.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - Ev::feedSignalEvent - Feed signal event into the default loop - - - &reftitle.description; - - final - public - static - void - Ev::feedSignalEvent - - int - signum - - - - Feed signal event into the default loop. Ev will react to this call as if - the signal specified by - signal - had occurred. - - - - &reftitle.parameters; - - - - signum - - - - Signal number. See - signal(7) - man page for details. See also constants exported by - pcntl - extension. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - Ev::feedSignal - - - - - diff --git a/reference/ev/ev/iteration.xml b/reference/ev/ev/iteration.xml deleted file mode 100644 index 59eb9bc597ca..000000000000 --- a/reference/ev/ev/iteration.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - Ev::iteration - Return the number of times the default event loop has polled for new - events - - - &reftitle.description; - - final - public - static - int - Ev::iteration - - - - Return the number of times the event loop has polled for new events. - Sometimes useful as a generation counter. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Returns number of polls of the default event loop. - - - - &reftitle.seealso; - - - Ev::depth - - - - - diff --git a/reference/ev/ev/now.xml b/reference/ev/ev/now.xml deleted file mode 100644 index 13bdac16c255..000000000000 --- a/reference/ev/ev/now.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - Ev::now - Returns the time when the last iteration of the default event - loop has started - - - &reftitle.description; - - final - public - static - float - Ev::now - - - - Returns the time when the last iteration of the default event loop has - started. This is the time that timers( - EvTimer - and - EvPeriodic) - are based on, and referring to it is usually faster than calling - Ev::time. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Returns number of seconds(fractional) representing the time when the last - iteration of the default event loop has started. - - - - &reftitle.seealso; - - - Ev::nowUpdate - - - - - diff --git a/reference/ev/ev/nowupdate.xml b/reference/ev/ev/nowupdate.xml deleted file mode 100644 index 05695ec9cf22..000000000000 --- a/reference/ev/ev/nowupdate.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - Ev::nowUpdate - Establishes the current time by querying the kernel, updating the time - returned by Ev::now in the progress - - - &reftitle.description; - - final - public - static - void - Ev::nowUpdate - - - - Establishes the current time by querying the kernel, updating the time - returned by - Ev::now - in the progress. This is a costly operation and is usually done - automatically within - Ev::run. - - - This method is rarely useful, but when some event callback runs for a very - long time without entering the event loop, updating - libev - 's consideration of the current time is a good idea. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - Ev::now - - - - - diff --git a/reference/ev/ev/recommendedbackends.xml b/reference/ev/ev/recommendedbackends.xml deleted file mode 100644 index daabb3af9ddd..000000000000 --- a/reference/ev/ev/recommendedbackends.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - Ev::recommendedBackends - Returns a bit mask of recommended backends for current - platform - - - &reftitle.description; - - final - public - static - int - Ev::recommendedBackends - - - - Returns the set of all backends compiled into this binary of - libev - and also recommended for this platform, meaning it will work for most file - descriptor types. This set is often smaller than the one returned by - ev_supported_backends, - as for example - kqueue - is broken on most - BSD - systems and will not be auto-detected unless it is requested explicitly. - This is the set of backends that - libev - will probe when no backends are specified explicitly. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Returns a bit mask which can containing - backend flags - combined using bitwise - OR - operator. - - - - &reftitle.examples; - - Embedding one loop into another - - -]]> - - - - - &reftitle.seealso; - - - EvEmbed - - - Ev::embeddableBackends - - - Ev::supportedBackends - - - Backend flags - - - Examples - - - - - diff --git a/reference/ev/ev/resume.xml b/reference/ev/ev/resume.xml deleted file mode 100644 index dfeb9f355912..000000000000 --- a/reference/ev/ev/resume.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - Ev::resume - Resume previously suspended default event loop - - - &reftitle.description; - - final - public - static - void - Ev::resume - - - - Ev::suspend - and - Ev::resume - methods suspend and resume a loop correspondingly. - - - All timer watchers will be delayed by the time spent between - suspend - and - resume, - and all - periodic - watchers will be rescheduled(that is, they will lose any events that would - have occurred while suspended). - - - After calling - Ev::suspend - it is not allowed to call any function on the given loop other than - Ev::resume. - Also it is not allowed to call - Ev::resume - without a previous call to - Ev::suspend. - - - Calling - suspend - / - resume - has the side effect of updating the event loop time(see - Ev::nowUpdate - ). - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - Ev::suspend - - - - - diff --git a/reference/ev/ev/run.xml b/reference/ev/ev/run.xml deleted file mode 100644 index 599aa46bf7a9..000000000000 --- a/reference/ev/ev/run.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - Ev::run - Begin checking for events and calling callbacks for the default - loop - - - &reftitle.description; - - final - public - static - void - Ev::run - - int - flags - - - - Begin checking for events and calling callbacks - for the default loop. - Returns when a callback calls - Ev::stop - method, or the flags are nonzero(in which case the return value is true) or - when there are no active watchers which reference the loop( - EvWatcher::keepalive - is &true;), in which case the return value will be &false;. The return - value can generally be interpreted as - if &true;, there is more work left to - do. - - - - &reftitle.parameters; - - - - flags - - - - Optional parameter - flags - can be one of the following: - - - List for possible values of <parameter>flags</parameter> - - - - - - flags - - Description - - - - - - 0 - - The default behavior described above - - - - Ev::RUN_ONCE - - Block at most one(wait, but don't loop) - - - - Ev::RUN_NOWAIT - - Don't block at all(fetch/handle events, but don't wait) - - - -
-
- - See - the run flag - constants. - -
-
-
-
- - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - Ev::stop - - - EvLoop::run - - - -
- diff --git a/reference/ev/ev/sleep.xml b/reference/ev/ev/sleep.xml deleted file mode 100644 index 8f5cd2b87838..000000000000 --- a/reference/ev/ev/sleep.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - Ev::sleep - Block the process for the given number of seconds - - - &reftitle.description; - - final - public - static - void - Ev::sleep - - float - seconds - - - - Block the process for the given number of seconds. - - - - &reftitle.parameters; - - - - seconds - - - - Fractional number of seconds - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/ev/ev/stop.xml b/reference/ev/ev/stop.xml deleted file mode 100644 index a5d27f4bf849..000000000000 --- a/reference/ev/ev/stop.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - Ev::stop - Stops the default event loop - - - &reftitle.description; - - final - public - static - void - Ev::stop - - int - how - - - - Stops the default event loop - - - - &reftitle.parameters; - - - - how - - - - One of - Ev::BREAK_* - constants. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - Ev::run - - - - - diff --git a/reference/ev/ev/supportedbackends.xml b/reference/ev/ev/supportedbackends.xml deleted file mode 100644 index 696141ab3e68..000000000000 --- a/reference/ev/ev/supportedbackends.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - Ev::supportedBackends - Returns the set of backends supported by current libev - configuration - - - &reftitle.description; - - final - public - static - int - Ev::supportedBackends - - - - Returns the set of backends supported by current libev configuration. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Returns a bit mask which can containing - backend flags - combined using bitwise - OR - operator. - - - - &reftitle.examples; - - Embedding loop created with kqueue backend into the default loop - - -]]> - - - - - &reftitle.seealso; - - - EvEmbed - - - Ev::recommendedBackends - - - Ev::embeddableBackends - - - Backend flags - - - Examples - - - - - diff --git a/reference/ev/ev/suspend.xml b/reference/ev/ev/suspend.xml deleted file mode 100644 index 71a1e8e441d6..000000000000 --- a/reference/ev/ev/suspend.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - Ev::suspend - Suspend the default event loop - - - &reftitle.description; - - final - public - static - void - Ev::suspend - - - - Ev::suspend - and - Ev::resume - methods suspend and resume the default loop correspondingly. - - - All timer watchers will be delayed by the time spent between - suspend - and - resume, - and all - periodic - watchers will be rescheduled(that is, they will lose any events that would - have occurred while suspended). - - - After calling - Ev::suspend - it is not allowed to call any function on the given loop other than - Ev::resume. - Also it is not allowed to call - Ev::resume - without a previous call to - Ev::suspend. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - Ev::resume - - - - - diff --git a/reference/ev/ev/time.xml b/reference/ev/ev/time.xml deleted file mode 100644 index 31dffd083f32..000000000000 --- a/reference/ev/ev/time.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - Ev::time - Returns the current time in fractional seconds since the epoch - - - &reftitle.description; - - final - public - static - float - Ev::time - - - - Returns the current time in fractional seconds since the epoch. Consider - using - Ev::now - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Returns the current time in fractional seconds since the epoch. - - - - &reftitle.seealso; - - - Ev::now - - - - - diff --git a/reference/ev/ev/verify.xml b/reference/ev/ev/verify.xml deleted file mode 100644 index b4ef7411cabd..000000000000 --- a/reference/ev/ev/verify.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - Ev::verify - Performs internal consistency checks(for debugging) - - - &reftitle.description; - - final - public - static - void - Ev::verify - - - - Performs internal consistency checks(for debugging - libev) - and abort the program if any data structures were found to be corrupted. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/ev/evcheck.xml b/reference/ev/evcheck.xml deleted file mode 100644 index 83af918a27f9..000000000000 --- a/reference/ev/evcheck.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - The EvCheck class - EvCheck - - -
- &reftitle.intro; - - EvPrepare - and - EvCheck - watchers are usually used in pairs. - EvPrepare - watchers get invoked before the process blocks, - EvCheck - afterwards. - - - It is not allowed to call - EvLoop::run - or similar methods or functions that enter the current event loop from - either - EvPrepare - or - EvCheck - watchers. Other loops than the current one are fine, however. The - rationale behind this is that one don't need to check for recursion - in those watchers, i.e. the sequence will always be: - EvPrepare - -> blocking -> - EvCheck, - so having a watcher of each kind they will always be called in pairs - bracketing the blocking call. - - - The main purpose is to integrate other event mechanisms into - libev - and their use is somewhat advanced. They could be used, for example, to - track variable changes, implement custom watchers, integrate net-snmp or a - coroutine library and lots more. They are also occasionally useful to - cache some data and want to flush it before blocking. - - - It is recommended to give - EvCheck - watchers highest( - Ev::MAXPRI) - priority, to ensure that they are being run before any other watchers - after the poll (this doesn’t matter for - EvPrepare - watchers). - - - Also, - EvCheck - watchers should not activate/feed events. While - libev - fully supports this, they might get executed before other - EvCheck - watchers did their job. - -
- -
- &reftitle.classsynopsis; - - - - - EvCheck - - - - - EvCheck - - - extends - EvWatcher - - - - - &InheritedProperties; - - &Methods; - - - &InheritedMethods; - - - -
-
- - &reference.ev.entities.evcheck; - -
- diff --git a/reference/ev/evcheck/construct.xml b/reference/ev/evcheck/construct.xml deleted file mode 100644 index 9b070b0aebdb..000000000000 --- a/reference/ev/evcheck/construct.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - EvCheck::__construct - Constructs the EvCheck watcher object - - - &reftitle.description; - - public - EvCheck::__construct - - callable - callback - - - mixed - data - - - int - priority - - - - Constructs the - EvCheck - watcher object. - - - - &reftitle.parameters; - - - - callback - - - - See - Watcher callbacks. - - - - - - data - - - - Custom data associated with the watcher. - - - - - - priority - - - - Watcher priority - - - - - - - - &reftitle.seealso; - - - EvPrepare - - - EvLoop::check - - - - - diff --git a/reference/ev/evcheck/createstopped.xml b/reference/ev/evcheck/createstopped.xml deleted file mode 100644 index eb622b67c0e1..000000000000 --- a/reference/ev/evcheck/createstopped.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - EvCheck::createStopped - Create instance of a stopped EvCheck watcher - - - &reftitle.description; - - final - public - static - object - EvCheck::createStopped - - string - callback - - - string - data - - - string - priority - - - - Create instance of a stopped EvCheck watcher - - - - &reftitle.parameters; - - - - callback - - - - See - Watcher callbacks. - - - - - - data - - - - Custom data associated with the watcher. - - - - - - priority - - - - Watcher priority - - - - - - - &reftitle.returnvalues; - - Returns EvCheck object on success. - - - - &reftitle.seealso; - - - EvPrepare - - - - - diff --git a/reference/ev/evchild.xml b/reference/ev/evchild.xml deleted file mode 100644 index 6de0cfa6230c..000000000000 --- a/reference/ev/evchild.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - The EvChild class - EvChild - - -
- &reftitle.intro; - - EvChild - watchers trigger when the process receives a - SIGCHLD - in response to some child status changes (most typically when a child dies - or exits). It is permissible to install an - EvChild - watcher after the child has been forked(which implies it might have - already exited), as long as the event loop isn't entered(or is continued - from a watcher), i.e. forking and then immediately registering a watcher - for the child is fine, but forking and registering a watcher a few event - loop iterations later or in the next callback invocation is not. - - - It is allowed to register - EvChild - watchers in the - default loop - only. - -
- -
- &reftitle.classsynopsis; - - - - - EvChild - - - - - EvChild - - - extends - EvWatcher - - - - &Properties; - - public - pid - - - public - rpid - - - public - rstatus - - &InheritedProperties; - - &Methods; - - - &InheritedMethods; - - - -
- -
- &reftitle.properties; - - - - pid - - - - Readonly. - The process ID this watcher watches out for, or - 0, - meaning any process ID. - - - - - - rpid - - - - Readonly - .The process ID that detected a status change. - - - - - - rstatus - - - - Readonly. - The process exit status caused by - rpid. - - - - -
- -
- - &reference.ev.entities.evchild; - -
- diff --git a/reference/ev/evchild/construct.xml b/reference/ev/evchild/construct.xml deleted file mode 100644 index 897061b45628..000000000000 --- a/reference/ev/evchild/construct.xml +++ /dev/null @@ -1,183 +0,0 @@ - - - - - EvChild::__construct - Constructs the EvChild watcher object - - - &reftitle.description; - - public - EvChild::__construct - - int - pid - - - bool - trace - - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Constructs the - EvChild - watcher object. - - - Call the callback when a status change for process ID - pid - (or any - PID - if - pid - is - 0) - has been received(a status change happens when the process terminates or - is killed, or, when - trace - is &true;, additionally when it is stopped or continued). In other words, - when the process receives a - SIGCHLD, - Ev - will fetch the outstanding exit/wait status for all changed/zombie children - and call the callback. - - - It is valid to install a child watcher after an - EvChild - has exited but before the event loop has started its next iteration. For - example, first one calls - fork, - then the new child process might exit, and only then an - EvChild - watcher is installed in the parent for the new - PID. - - - You can access both exit/tracing status and - pid - by using the - rstatus - and - rpid - properties of the watcher object. - - - The number of - PID - watchers per - PID - is unlimited. All of them will be called. - - - The - EvChild::createStopped - method doesn't start(activate) the newly created watcher. - - - - &reftitle.parameters; - - - - pid - - - - Wait for status changes of process PID(or any process if PID is - specified as - 0 - ). - - - - - - trace - - - - If &false;, only activate the watcher when the process terminates. - Otherwise(&true;) additionally activate the watcher when the process is - stopped or continued. - - - - - - callback - - - - See - Watcher callbacks. - - - - - - data - - - - Custom data associated with the watcher. - - - - - - priority - - - - Watcher priority - - - - - - - - &reftitle.seealso; - - - EvLoop::child - - - - - diff --git a/reference/ev/evchild/createstopped.xml b/reference/ev/evchild/createstopped.xml deleted file mode 100644 index fe3cf440311d..000000000000 --- a/reference/ev/evchild/createstopped.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - EvChild::createStopped - Create instance of a stopped EvChild watcher - - - &reftitle.description; - - final - public - static - object - EvChild::createStopped - - int - pid - - - bool - trace - - - callable - callback - - - mixed - data - - - int - priority - - - - The same as - EvChild::__construct, - but doesn't start the watcher automatically. - - - - &reftitle.parameters; - - - - pid - - - - The same as for - EvChild::__construct - - - - - - trace - - - - The same as for - EvChild::__construct - - - - - - callback - - - - See - Watcher callbacks. - - - - - - data - - - - Custom data associated with the watcher. - - - - - - priority - - - - Watcher priority - - - - - - - &reftitle.returnvalues; - - - - &reftitle.seealso; - - - EvChild::__construct - - - EvLoop::child - - - - - diff --git a/reference/ev/evchild/set.xml b/reference/ev/evchild/set.xml deleted file mode 100644 index 70e4af1d376e..000000000000 --- a/reference/ev/evchild/set.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - EvChild::set - Configures the watcher - - - &reftitle.description; - - public - void - EvChild::set - - int - pid - - - bool - trace - - - - - - &reftitle.parameters; - - - - pid - - - - The same as for - EvChild::__construct - - - - - - trace - - - - The same as for - EvChild::__construct - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EvChild::__construct - - - - - diff --git a/reference/ev/evembed.xml b/reference/ev/evembed.xml deleted file mode 100644 index e3457554866d..000000000000 --- a/reference/ev/evembed.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - The EvEmbed class - EvEmbed - - -
- &reftitle.intro; - - Used to embed one event loop into another. - -
- -
- &reftitle.classsynopsis; - - - - - EvEmbed - - - - - EvEmbed - - - extends - EvWatcher - - - - &Properties; - - public - embed - - &Methods; - - - &InheritedMethods; - - - -
- -
- &reftitle.properties; - - - - is_active - - - - - - - - data - - - - - - - - is_pending - - - - - - - - priority - - - - - - - - embed - - - - - - -
- -
- - &reference.ev.entities.evembed; - -
- diff --git a/reference/ev/evembed/construct.xml b/reference/ev/evembed/construct.xml deleted file mode 100644 index 7522a988f78c..000000000000 --- a/reference/ev/evembed/construct.xml +++ /dev/null @@ -1,165 +0,0 @@ - - - - - EvEmbed::__construct - Constructs the EvEmbed object - - - &reftitle.description; - - public - EvEmbed::__construct - - object - other - - - callable - callback - - - mixed - data - - - int - priority - - - - This is a rather advanced watcher type that lets to embed one event loop - into another(currently only IO events are supported in the embedded loop, - other types of watchers might be handled in a delayed or incorrect fashion - and must not be used). - - - See - the - libev documentation - for details. - - - This watcher is most useful on - BSD - systems without working - kqueue - to still be able to handle a large number of sockets. See example below. - - - - &reftitle.parameters; - - - - other - - - - Instance of - EvLoop. - The loop to embed, this loop must be embeddable(see - Ev::embeddableBackends - ). - - - - - - callback - - - - See - Watcher callbacks. - - - - - - data - - - - Custom data associated with the watcher. - - - - - - priority - - - - Watcher priority - - - - - - - - &reftitle.examples; - - Embedding loop created with kqueue backend into the default loop - - -]]> - - - - - &reftitle.seealso; - - - Ev::embeddableBackends - - - - - diff --git a/reference/ev/evembed/createstopped.xml b/reference/ev/evembed/createstopped.xml deleted file mode 100644 index 7c52ec8155fe..000000000000 --- a/reference/ev/evembed/createstopped.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - EvEmbed::createStopped - Create stopped EvEmbed watcher object - - - &reftitle.description; - - final - public - static - void - EvEmbed::createStopped - - object - other - - - callable - callback - - - mixed - data - - - int - priority - - - - The same as - EvEmbed::__construct, - but doesn't start the watcher automatically. - - - - &reftitle.parameters; - - - - other - - - - The same as for - EvEmbed::__construct - - - - - - callback - - - - See - Watcher callbacks. - - - - - - data - - - - Custom data associated with the watcher. - - - - - - priority - - - - Watcher priority - - - - - - - &reftitle.returnvalues; - - Returns stopped EvEmbed object on success. - - - - &reftitle.seealso; - - - EvEmbed::__construct - - - Ev::embeddableBackends - - - - - diff --git a/reference/ev/evembed/set.xml b/reference/ev/evembed/set.xml deleted file mode 100644 index c4ff6b72d8d4..000000000000 --- a/reference/ev/evembed/set.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - EvEmbed::set - Configures the watcher - - - &reftitle.description; - - public - void - EvEmbed::set - - object - other - - - - Configures the watcher to use - other - event loop object. - - - - &reftitle.parameters; - - - - other - - - - The same as for - EvEmbed::__construct - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/ev/evembed/sweep.xml b/reference/ev/evembed/sweep.xml deleted file mode 100644 index b5902670c92e..000000000000 --- a/reference/ev/evembed/sweep.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - EvEmbed::sweep - Make a single, non-blocking sweep over the embedded loop - - - &reftitle.description; - - public - void - EvEmbed::sweep - - - - Make a single, non-blocking sweep over the embedded loop. Works similarly - to the following, but in the most appropriate way for embedded loops: - -start(Ev::RUN_NOWAIT); -?> -]]> - - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EvWatcher::start - - - - - diff --git a/reference/ev/evfork.xml b/reference/ev/evfork.xml deleted file mode 100644 index 5539e3be1396..000000000000 --- a/reference/ev/evfork.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - The EvFork class - EvFork - - -
- &reftitle.intro; - - Fork watchers are called when a - fork() - was detected (usually because whoever signalled - libev - about it by calling - EvLoop::fork - ). The invocation is done before the event loop blocks next and before - EvCheck - watchers are being called, and only in the child after the fork. Note, - that if whoever calling - EvLoop::fork - calls it in the wrong process, the fork handlers will be invoked, too. - -
- -
- &reftitle.classsynopsis; - - - - - EvFork - - - - - EvFork - - - extends - EvWatcher - - - - - &InheritedProperties; - - &Methods; - - - &InheritedMethods; - - - -
-
- - &reference.ev.entities.evfork; - -
- diff --git a/reference/ev/evfork/construct.xml b/reference/ev/evfork/construct.xml deleted file mode 100644 index 8f2b845facf2..000000000000 --- a/reference/ev/evfork/construct.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - EvFork::__construct - Constructs the EvFork watcher object - - - &reftitle.description; - - public - EvFork::__construct - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Constructs the EvFork watcher object and starts the watcher automatically. - - - - &reftitle.parameters; - - - - callback - - - - See - Watcher callbacks. - - - - - - data - - - - Custom data associated with the watcher. - - - - - - priority - - - - Watcher priority - - - - - - - - &reftitle.seealso; - - - EvLoop::fork - - - EvCheck - - - - - diff --git a/reference/ev/evfork/createstopped.xml b/reference/ev/evfork/createstopped.xml deleted file mode 100644 index bdb0bdfa835e..000000000000 --- a/reference/ev/evfork/createstopped.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - EvFork::createStopped - Creates a stopped instance of EvFork watcher class - - - &reftitle.description; - - final - public - static - object - EvFork::createStopped - - string - callback - - - string - data - - - string - priority - - - - The same as - EvFork::__construct, - but doesn't start the watcher automatically. - - - - &reftitle.parameters; - - - - callback - - - - See - Watcher callbacks. - - - - - - data - - - - Custom data associated with the watcher. - - - - - - priority - - - - Watcher priority - - - - - - - &reftitle.returnvalues; - - Returns EvFork(stopped) object on success. - - - - &reftitle.seealso; - - - EvFork::__construct - - - - - diff --git a/reference/ev/evidle.xml b/reference/ev/evidle.xml deleted file mode 100644 index 9461ad985d34..000000000000 --- a/reference/ev/evidle.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - The EvIdle class - EvIdle - - -
- &reftitle.intro; - - EvIdle - watchers trigger events when no other events of the same or higher - priority are pending ( - EvPrepare, - EvCheck - and other - EvIdle - watchers do not count as receiving - events - ). - - - Thus, as long as the process is busy handling sockets or timeouts(or even - signals) of the same or higher priority it will not be triggered. But when - the process is in idle(or only lower-priority watchers are pending), the - EvIdle - watchers are being called once per event loop iteration - until stopped, - that is, or the process receives more events and becomes busy again with - higher priority stuff. - - - Apart from keeping the process non-blocking(which is a useful on its own - sometimes), - EvIdle - watchers are a good place to do - "pseudo-background processing", - or delay processing stuff to after the event loop has handled all - outstanding events. - - - The most noticeable effect is that as long as any - idle - watchers are active, the process will - not - block when waiting for new events. - -
- -
- &reftitle.classsynopsis; - - - - - EvIdle - - - - - EvIdle - - - extends - EvWatcher - - - - - &InheritedProperties; - - &Methods; - - - &InheritedMethods; - - - -
- -
- - &reference.ev.entities.evidle; - -
- diff --git a/reference/ev/evidle/construct.xml b/reference/ev/evidle/construct.xml deleted file mode 100644 index 487c5a2af6f6..000000000000 --- a/reference/ev/evidle/construct.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - EvIdle::__construct - Constructs the EvIdle watcher object - - - &reftitle.description; - - public - EvIdle::__construct - - callable - callback - - - mixed - data - - - int - priority - - - - Constructs the EvIdle watcher object and starts the watcher automatically. - - - - &reftitle.parameters; - - - - callback - - - - See - Watcher callbacks. - - - - - - data - - - - Custom data associated with the watcher. - - - - - - priority - - - - Watcher priority - - - - - - - - &reftitle.seealso; - - - EvIdle::createStopped - - - EvLoop::idle - - - - - diff --git a/reference/ev/evidle/createstopped.xml b/reference/ev/evidle/createstopped.xml deleted file mode 100644 index 9ddb7683209b..000000000000 --- a/reference/ev/evidle/createstopped.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - EvIdle::createStopped - Creates instance of a stopped EvIdle watcher object - - - &reftitle.description; - - final - public - static - object - EvIdle::createStopped - - string - callback - - - mixed - data - - - int - priority - - - - The same as - EvIdle::__construct, - but doesn't start the watcher automatically. - - - - &reftitle.parameters; - - - - callback - - - - See - Watcher callbacks. - - - - - - data - - - - Custom data associated with the watcher. - - - - - - priority - - - - Watcher priority - - - - - - - &reftitle.returnvalues; - - Returns EvIdle object on success. - - - - &reftitle.seealso; - - - EvIdle::__construct - - - EvLoop::idle - - - - - diff --git a/reference/ev/evio.xml b/reference/ev/evio.xml deleted file mode 100644 index 3357cb6622db..000000000000 --- a/reference/ev/evio.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - The EvIo class - EvIo - -
- &reftitle.intro; - - EvIo - watchers check whether a file descriptor(or socket, or a stream castable - to numeric file descriptor) is readable or writable in each iteration of - the event loop, or, more precisely, when reading would not block the - process and writing would at least be able to write some data. This - behaviour is called - level-triggering - because events are kept receiving as long as the condition persists. To - stop receiving events just stop the watcher. - - - The number of read and/or write event watchers per - fd - is unlimited. Setting all file descriptors to non-blocking mode is also - usually a good idea(but not required). - - - Another thing to watch out for is that it is quite easy to receive false - readiness notifications, i.e. the callback might be called with - Ev::READ - but a subsequent - read() - will actually block because there is no data. It is very easy to get into - this situation. Thus it is best to always use non-blocking I/O: An extra - read() - returning - EAGAIN - (or similar) is far preferable to a program hanging until some data - arrives. - - - If for some reason it is impossible to run the - fd - in non-blocking mode, then separately re-test whether a file descriptor is - really ready. Some people additionally use - SIGALRM - and an interval timer, just to be sure they won't block infinitely. - - - Always consider using non-blocking mode. - -
- -
- &reftitle.classsynopsis; - - - - EvIo - - - - EvIo - - - extends - EvWatcher - - - - &Properties; - - public - fd - - - public - events - - &InheritedProperties; - - &Methods; - - - &InheritedMethods; - - - -
-
- &reftitle.properties; - - - - fd - - - - - - - - events - - - - - - -
- -
- - &reference.ev.entities.evio; - -
- diff --git a/reference/ev/evio/construct.xml b/reference/ev/evio/construct.xml deleted file mode 100644 index 3e8c480335c3..000000000000 --- a/reference/ev/evio/construct.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - EvIo::__construct - Constructs EvIo watcher object - - - &reftitle.description; - - public - EvIo::__construct - - mixed - fd - - - int - events - - - callable - callback - - - mixed - data - - - int - priority - - - - Constructs EvIo watcher object and starts the watcher automatically. - - - - &reftitle.parameters; - - - - fd - - - - Can be a stream opened with - fopen - or similar functions, numeric file descriptor, or socket. - - - - - - events - - - - Ev::READ - and/or - Ev::WRITE. - See - the bit masks. - - - - - - callback - - - - See - Watcher callbacks. - - - - - - data - - - - Custom data associated with the watcher. - - - - - - priority - - - - Watcher priority - - - - - - - - &reftitle.seealso; - - - EvIo::createStopped - - - EvLoop::io - - - - - diff --git a/reference/ev/evio/createstopped.xml b/reference/ev/evio/createstopped.xml deleted file mode 100644 index fc8de557c439..000000000000 --- a/reference/ev/evio/createstopped.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - EvIo::createStopped - Create stopped EvIo watcher object - - - &reftitle.description; - - final - public - static - EvIo - EvIo::createStopped - - mixed - fd - - - int - events - - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - The same as - EvIo::__construct, - but doesn't start the watcher automatically. - - - - &reftitle.parameters; - - - - fd - - - - The same as for - EvIo::__construct - - - - - - events - - - - The same as for - EvIo::__construct - - - - - - callback - - - - See - Watcher callbacks. - - - - - - data - - - - Custom data associated with the watcher. - - - - - - priority - - - - Watcher priority - - - - - - - &reftitle.returnvalues; - - Returns EvIo object on success. - - - - &reftitle.seealso; - - - EvIo::__construct - - - EvLoop::io - - - - - diff --git a/reference/ev/evio/set.xml b/reference/ev/evio/set.xml deleted file mode 100644 index 42d150e46a5a..000000000000 --- a/reference/ev/evio/set.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - EvIo::set - Configures the watcher - - - &reftitle.description; - - public - void - EvIo::set - - mixed - fd - - - int - events - - - - Configures the EvIo watcher - - - - &reftitle.parameters; - - - - fd - - - - The same as for - EvIo::__construct - - - - - - events - - - - The same as for - EvIo::__construct - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/ev/evloop.xml b/reference/ev/evloop.xml deleted file mode 100644 index 16d6f8b8e278..000000000000 --- a/reference/ev/evloop.xml +++ /dev/null @@ -1,255 +0,0 @@ - - - - The EvLoop class - EvLoop - - -
- &reftitle.intro; - - Represents an event loop that is always distinct from the - default - loop. - Unlike the - default loop, - it cannot handle - EvChild - watchers. - - - Having threads we have to create a loop per thread, and use the - default loop - in the parent thread. - - - The - default event loop - is initialized automatically by - Ev. - It is accessible via methods of the - Ev - class, or via - EvLoop::defaultLoop - method. - -
- -
- &reftitle.classsynopsis; - - - - - EvLoop - - - - - final - EvLoop - - - - &Properties; - - public - data - - - public - backend - - - public - is_default_loop - - - public - iteration - - - public - pending - - - public - io_interval - - - public - timeout_interval - - - public - depth - - &Methods; - - - - -
- -
- &reftitle.properties; - - - - data - - - - Custom data attached to loop - - - - - - backend - - - - Readonly. - The - backend flags - indicating the event backend in use. - - - - - - is_default_loop - - - - Readonly. - &true; if it is the default event loop. - - - - - - iteration - - - - The current iteration count of the loop. See - Ev::iteration - - - - - - pending - - - - The number of pending watchers. - 0 - indicates that there are no watchers pending. - - - - - - io_interval - - - - Higher - io_interval - allows - libev - to spend more time collecting - EvIo - events, so more events can be handled per iteration, at the cost of - increasing latency. Timeouts (both - EvPeriodic - and - EvTimer) - will not be affected. Setting this to a non-zero value will introduce - an additional - sleep() - call into most loop iterations. The sleep time ensures that - libev - will not poll for - EvIo - events more often than once per this interval, on average. Many - programs can usually benefit by setting the - io_interval - to a value near - 0.1, - which is often enough for interactive servers(not for games). It - usually doesn't make much sense to set it to a lower value than - 0.01, - as this approaches the timing granularity of most systems. - - - See also - FUNCTIONS - CONTROLLING EVENT LOOPS. - - - - - - timeout_interval - - - - Higher - timeout_interval - allows - libev - to spend more time collecting timeouts, at the expense of increased - latency/jitter/inexactness(the watcher callback will be called later). - EvIo - watchers will not be affected. Setting this to a non-null value will - not introduce any overhead in - libev. - See also - FUNCTIONS - CONTROLLING EVENT LOOPS. - - - - - - depth - - - - The recursion depth. See - Ev::depth. - - - - -
- -
- - &reference.ev.entities.evloop; - -
- diff --git a/reference/ev/evloop/backend.xml b/reference/ev/evloop/backend.xml deleted file mode 100644 index b33378d9b074..000000000000 --- a/reference/ev/evloop/backend.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - EvLoop::backend - Returns an integer describing the backend used by libev - - - &reftitle.description; - - public - int - EvLoop::backend - - - - The same as - Ev::backend, - but for the loop instance. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Returns an integer describing the backend used by libev. See - Ev::backend. - - - - &reftitle.seealso; - - - Ev::backend - - - - - diff --git a/reference/ev/evloop/check.xml b/reference/ev/evloop/check.xml deleted file mode 100644 index 974b4a66f4f4..000000000000 --- a/reference/ev/evloop/check.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - EvLoop::check - Creates EvCheck object associated with the current event loop - instance - - - &reftitle.description; - - final - public - EvCheck - EvLoop::check - - string - callback - - - string - data - - - string - priority - - - - Creates EvCheck object associated with the current event loop instance. - - - - &reftitle.parameters; - - All parameters have the same meaning as for - EvCheck::__construct - - - - &reftitle.returnvalues; - - Returns EvCheck object on success. - - - - &reftitle.seealso; - - - EvCheck::__construct - - - - - diff --git a/reference/ev/evloop/child.xml b/reference/ev/evloop/child.xml deleted file mode 100644 index c0fce351476e..000000000000 --- a/reference/ev/evloop/child.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - EvLoop::child - Creates EvChild object associated with the current event loop - - - &reftitle.description; - - final - public - EvChild - EvLoop::child - - string - pid - - - string - trace - - - string - callback - - - string - data - - - string - priority - - - - Creates EvChild object associated with the current event loop. - - - - &reftitle.parameters; - - All parameters have the same meaning as for - EvChild::__construct - - - - &reftitle.returnvalues; - - Returns EvChild object on success. - - - - &reftitle.seealso; - - - EvChild::__construct - - - - - diff --git a/reference/ev/evloop/construct.xml b/reference/ev/evloop/construct.xml deleted file mode 100644 index aefec801fafa..000000000000 --- a/reference/ev/evloop/construct.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - EvLoop::__construct - Constructs the event loop object - - - &reftitle.description; - - public - EvLoop::__construct - - int - flags - - - mixed - data - NULL - - - float - io_interval - 0.0 - - - float - timeout_interval - 0.0 - - - - Constructs the event loop object. - - - - &reftitle.parameters; - - - - flags - - - - One of the - event loop flags - - - - - - data - - - - Custom data associated with the loop. - - - - - - io_interval - - - - See - io_interval - - - - - - timeout_interval - - - - See - timeout_interval - - - - - - - - &reftitle.seealso; - - - EvLoop::defaultLoop - - - - - diff --git a/reference/ev/evloop/defaultloop.xml b/reference/ev/evloop/defaultloop.xml deleted file mode 100644 index b8b33a0bfcf5..000000000000 --- a/reference/ev/evloop/defaultloop.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - EvLoop::defaultLoop - Returns or creates the default event loop - - - &reftitle.description; - - public - static - EvLoop - EvLoop::defaultLoop - - int - flags - Ev::FLAG_AUTO - - - mixed - data - NULL - - - float - io_interval - 0. - - - float - timeout_interval - 0. - - - - If the default event loop is not created, - EvLoop::defaultLoop - creates it with the specified parameters. Otherwise, it just returns the - object representing previously created instance ignoring all the - parameters. - - - - &reftitle.parameters; - - - - flags - - - - One of the - event loop flags - - - - - - data - - - - Custom data to associate with the loop. - - - - - - io_collect_interval - - - - See - io_interval - - - - - - timeout_collect_interval - - - - See - timeout_interval - - - - - - - &reftitle.returnvalues; - - Returns EvLoop object on success. - - - - &reftitle.seealso; - - - EvLoop::__construct - - - - - diff --git a/reference/ev/evloop/embed.xml b/reference/ev/evloop/embed.xml deleted file mode 100644 index 2381fde9cafc..000000000000 --- a/reference/ev/evloop/embed.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - EvLoop::embed - Creates an instance of EvEmbed watcher associated - with the current EvLoop object - - - &reftitle.description; - - final - public - EvEmbed - EvLoop::embed - - string - other - - - string - callback - - - string - data - - - string - priority - - - - Creates an instance of - EvEmbed - watcher associated with the current - EvLoop - object. - - - - &reftitle.parameters; - - All parameters have the same meaning as for - EvEmbed::__construct. - - - - &reftitle.returnvalues; - - Returns EvEmbed object on success. - - - - &reftitle.seealso; - - - EvEmbed::__construct - - - - - diff --git a/reference/ev/evloop/fork.xml b/reference/ev/evloop/fork.xml deleted file mode 100644 index 469fe23889b2..000000000000 --- a/reference/ev/evloop/fork.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - EvLoop::fork - Creates EvFork watcher object associated with the current event - loop instance - - - &reftitle.description; - - final - public - EvFork - EvLoop::fork - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Creates EvFork watcher object associated with the current event loop - instance - - - - &reftitle.parameters; - - All parameters have the same meaning as for - EvFork::__construct - - - - &reftitle.returnvalues; - - Returns EvFork object on success. - - - - &reftitle.seealso; - - - EvFork::__construct - - - - - diff --git a/reference/ev/evloop/idle.xml b/reference/ev/evloop/idle.xml deleted file mode 100644 index b24a239681ad..000000000000 --- a/reference/ev/evloop/idle.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - EvLoop::idle - Creates EvIdle watcher object associated with the current event - loop instance - - - &reftitle.description; - - final - public - EvIdle - EvLoop::idle - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Creates EvIdle watcher object associated with the current event loop - instance - - - - &reftitle.parameters; - - All the parameters have the same meaning as for - EvIdle::__construct - - - - &reftitle.returnvalues; - - Returns EvIdle object on success. - - - - &reftitle.seealso; - - - EvIdle::__construct - - - - - diff --git a/reference/ev/evloop/invokepending.xml b/reference/ev/evloop/invokepending.xml deleted file mode 100644 index 3958e7e49bb6..000000000000 --- a/reference/ev/evloop/invokepending.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - EvLoop::invokePending - Invoke all pending watchers while resetting their pending state - - - &reftitle.description; - - public - void - EvLoop::invokePending - - - - Invoke all pending watchers while resetting their pending state. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/ev/evloop/io.xml b/reference/ev/evloop/io.xml deleted file mode 100644 index 7d00537600b4..000000000000 --- a/reference/ev/evloop/io.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - EvLoop::io - Create EvIo watcher object associated with the current event - loop instance - - - &reftitle.description; - - final - public - EvIo - EvLoop::io - - mixed - fd - - - int - events - - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Create EvIo watcher object associated with the current event loop instance. - - - - &reftitle.parameters; - - All parameters have the same meaning as for - EvIo::__construct - - - - &reftitle.returnvalues; - - Returns EvIo object on success. - - - - &reftitle.seealso; - - - EvIo::__construct - - - - - diff --git a/reference/ev/evloop/loopfork.xml b/reference/ev/evloop/loopfork.xml deleted file mode 100644 index 9606fb19c392..000000000000 --- a/reference/ev/evloop/loopfork.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - EvLoop::loopFork - Must be called after a fork - - - &reftitle.description; - - public - void - EvLoop::loopFork - - - - Must be called after a - fork - in the child, before entering or continuing the event loop. An alternative - is to use - Ev::FLAG_FORKCHECK - which calls this function automatically, at some performance loss (refer to - the - libev - documentation - ). - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/ev/evloop/now.xml b/reference/ev/evloop/now.xml deleted file mode 100644 index f56958642b6d..000000000000 --- a/reference/ev/evloop/now.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - EvLoop::now - Returns the current "event loop time" - - - &reftitle.description; - - public - float - EvLoop::now - - - - Returns the current "event loop time", which is the time the event loop - received events and started processing them. This timestamp does not change - as long as callbacks are being processed, and this is also the base time - used for relative timers. You can treat it as the timestamp of the event - occurring(or more correctly, libev finding out about it). - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Returns time of the event loop in (fractional) seconds. - - - - &reftitle.seealso; - - - Ev::now - - - - - diff --git a/reference/ev/evloop/nowupdate.xml b/reference/ev/evloop/nowupdate.xml deleted file mode 100644 index c74694feaddc..000000000000 --- a/reference/ev/evloop/nowupdate.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - EvLoop::nowUpdate - Establishes the current time by querying the kernel, updating the time - returned by EvLoop::now in the progress - - - &reftitle.description; - - public - void - EvLoop::nowUpdate - - - - Establishes the current time by querying the kernel, updating the time - returned by - EvLoop::now - in the progress. This is a costly operation and is usually done - automatically within - EvLoop::run. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EvLoop::now - - - Ev::nowUpdate - - - - - diff --git a/reference/ev/evloop/periodic.xml b/reference/ev/evloop/periodic.xml deleted file mode 100644 index 0b043ccfbbed..000000000000 --- a/reference/ev/evloop/periodic.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - EvLoop::periodic - Creates EvPeriodic watcher object associated with the current - event loop instance - - - &reftitle.description; - - final - public - EvPeriodic - EvLoop::periodic - - float - offset - - - float - interval - - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Creates EvPeriodic watcher object associated with the current event loop - instance - - - - &reftitle.parameters; - - All parameters have the same meaning as for - EvPeriodic::__construct - - - - &reftitle.returnvalues; - - Returns EvPeriodic object on success. - - - - &reftitle.seealso; - - - EvPeriodic::__construct - - - - - diff --git a/reference/ev/evloop/prepare.xml b/reference/ev/evloop/prepare.xml deleted file mode 100644 index cae9278deff9..000000000000 --- a/reference/ev/evloop/prepare.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - EvLoop::prepare - Creates EvPrepare watcher object associated with the current - event loop instance - - - &reftitle.description; - - final - public - EvPrepare - EvLoop::prepare - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Creates EvPrepare watcher object associated with the current event loop - instance - - - - &reftitle.parameters; - - All parameters have the same meaning as for - EvPrepare - - - - &reftitle.returnvalues; - - Returns EvPrepare object on success - - - - &reftitle.seealso; - - - EvPrepare::__construct - - - - - diff --git a/reference/ev/evloop/resume.xml b/reference/ev/evloop/resume.xml deleted file mode 100644 index d1e6f65cbdce..000000000000 --- a/reference/ev/evloop/resume.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - EvLoop::resume - Resume previously suspended default event loop - - - &reftitle.description; - - public - void - EvLoop::resume - - - - EvLoop::suspend - and - EvLoop::resume - methods suspend and resume a loop correspondingly. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EvLoop::suspend - - - Ev::resume - - - - - diff --git a/reference/ev/evloop/run.xml b/reference/ev/evloop/run.xml deleted file mode 100644 index ddf0a96649f6..000000000000 --- a/reference/ev/evloop/run.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - EvLoop::run - Begin checking for events and calling callbacks for the loop - - - &reftitle.description; - - public - void - EvLoop::run - - int - flags - 0 - - - - Begin checking for events and calling callbacks for the current event loop. - Returns when a callback calls - Ev::stop - method, or the flags are nonzero(in which case the return value is true) or - when there are no active watchers which reference the loop( - EvWatcher::keepalive - is &true;), in which case the return value will be &false;. The return - value can generally be interpreted as - if &true;, there is more work left - to do. - - - - &reftitle.parameters; - - - - flags - - - - Optional parameter - flags - can be one of the following: - - - List for possible values of <parameter>flags</parameter> - - - - - - flags - - Description - - - - - - 0 - - The default behavior described above - - - - Ev::RUN_ONCE - - Block at most one(wait, but don't loop) - - - - Ev::RUN_NOWAIT - - Don't block at all(fetch/handle events, but don't wait) - - - -
-
- - See - the run flag - constants. - -
-
-
-
- - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EvLoop::stop - - - Ev::run - - - -
- diff --git a/reference/ev/evloop/signal.xml b/reference/ev/evloop/signal.xml deleted file mode 100644 index 7fc7bef27892..000000000000 --- a/reference/ev/evloop/signal.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - EvLoop::signal - Creates EvSignal watcher object associated with the current - event loop instance - - - &reftitle.description; - - final - public - EvSignal - EvLoop::signal - - int - signum - - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Creates EvSignal watcher object associated with the current event loop - instance - - - - &reftitle.parameters; - - All parameters have the same meaning as for - EvSignal::__construct - - - - &reftitle.returnvalues; - - Returns EvSignal object on success - - - - &reftitle.seealso; - - - EvSignal::__construct - - - - - diff --git a/reference/ev/evloop/stat.xml b/reference/ev/evloop/stat.xml deleted file mode 100644 index fec53ab33af8..000000000000 --- a/reference/ev/evloop/stat.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - EvLoop::stat - Creates EvStat watcher object associated with the current event - loop instance - - - &reftitle.description; - - final - public - EvStat - EvLoop::stat - - string - path - - - float - interval - - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Creates EvStat watcher object associated with the current event loop - instance - - - - &reftitle.parameters; - - All parameters have the same meaning as for - EvSignal::__construct - - - - &reftitle.returnvalues; - - Returns EvStat object on success - - - - &reftitle.seealso; - - - EvSignal::__construct - - - - - diff --git a/reference/ev/evloop/stop.xml b/reference/ev/evloop/stop.xml deleted file mode 100644 index ccda96df3296..000000000000 --- a/reference/ev/evloop/stop.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - EvLoop::stop - Stops the event loop - - - &reftitle.description; - - public - void - EvLoop::stop - - int - how - - - - Stops the event loop - - - - &reftitle.parameters; - - - - how - - - - One of - Ev::BREAK_* - constants. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EvLoop::run - - - Ev::stop - - - - - diff --git a/reference/ev/evloop/suspend.xml b/reference/ev/evloop/suspend.xml deleted file mode 100644 index 729e2da69064..000000000000 --- a/reference/ev/evloop/suspend.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - EvLoop::suspend - Suspend the loop - - - &reftitle.description; - - public - void - EvLoop::suspend - - - - EvLoop::suspend - and - EvLoop::resume - methods suspend and resume a loop correspondingly. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EvLoop::resume - - - Ev::suspend - - - - - diff --git a/reference/ev/evloop/timer.xml b/reference/ev/evloop/timer.xml deleted file mode 100644 index d52d2c7b4024..000000000000 --- a/reference/ev/evloop/timer.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - EvLoop::timer - Creates EvTimer watcher object associated with the current event - loop instance - - - &reftitle.description; - - final - public - EvTimer - EvLoop::timer - - float - after - - - float - repeat - - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Creates EvTimer watcher object associated with the current event loop - instance - - - - &reftitle.parameters; - - All parameters have the same meaning as for - EvTimer::__construct - - - - &reftitle.returnvalues; - - Returns EvTimer object on success - - - - &reftitle.seealso; - - - EvTimer::__construct - - - - - diff --git a/reference/ev/evloop/verify.xml b/reference/ev/evloop/verify.xml deleted file mode 100644 index 1d353260b36b..000000000000 --- a/reference/ev/evloop/verify.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - EvLoop::verify - Performs internal consistency checks(for debugging) - - - &reftitle.description; - - public - void - EvLoop::verify - - - - Performs internal consistency checks(for debugging - libev) - and abort the program if any data structures were found to be corrupted. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - Ev::verify - - - - - diff --git a/reference/ev/evperiodic.xml b/reference/ev/evperiodic.xml deleted file mode 100644 index a254c4547f0d..000000000000 --- a/reference/ev/evperiodic.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - The EvPeriodic class - EvPeriodic - - -
- &reftitle.intro; - - Periodic watchers are also timers of a kind, but they are very versatile. - - - Unlike - EvTimer, - EvPeriodic - watchers are not based on real time(or relative time, the physical time - that passes) but on wall clock time(absolute time, calendar or clock). The - difference is that wall clock time can run faster or slower than real - time, and time jumps are not uncommon(e.g. when adjusting it). - - - EvPeriodic - watcher can be configured to trigger after some specific point in time. - For example, if an - EvPeriodic - watcher is configured to trigger - "in 10 seconds" - (e.g. - EvLoop::now - + - 10.0, - i.e. an absolute time, not a delay), and the system clock is reset to - January of the previous year, - then it will take a year or more to trigger the event (unlike an - EvTimer, - which would still trigger roughly - 10 - seconds after starting it as it uses a relative timeout). - - - As with timers, the callback is guaranteed to be invoked only when the - point in time where it is supposed to trigger has passed. If multiple - timers become ready during the same loop iteration then the ones with - earlier time-out values are invoked before ones with later time-out values - (but this is no longer true when a callback calls - EvLoop::run - recursively). - -
- -
- &reftitle.classsynopsis; - - - - - EvPeriodic - - - - - EvPeriodic - - - extends - EvWatcher - - - - &Properties; - - public - offset - - - public - interval - - &InheritedProperties; - - &Methods; - - - &InheritedMethods; - - - -
- -
- &reftitle.properties; - - - - offset - - - - When repeating, this contains the offset value, otherwise this is the - absolute point in time(the offset value passed to - EvPeriodic::set, - although - libev - might modify this value for better numerical stability). - - - - - - interval - - - - The current interval value. Can be modified any time, but changes only - take effect when the periodic timer fires or - EvPeriodic::again - is being called. - - - - -
- -
- - &reference.ev.entities.evperiodic; - -
- diff --git a/reference/ev/evperiodic/again.xml b/reference/ev/evperiodic/again.xml deleted file mode 100644 index 1722165b3be7..000000000000 --- a/reference/ev/evperiodic/again.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - EvPeriodic::again - Simply stops and restarts the periodic watcher again - - - &reftitle.description; - - public - void - EvPeriodic::again - - - - Simply stops and restarts the periodic watcher again. This is only useful - when attributes are changed. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EvTimer::again - - - - - diff --git a/reference/ev/evperiodic/at.xml b/reference/ev/evperiodic/at.xml deleted file mode 100644 index bd7432c2a27a..000000000000 --- a/reference/ev/evperiodic/at.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - EvPeriodic::at - Returns the absolute time that this - watcher is supposed to trigger next - - - &reftitle.description; - - public - float - EvPeriodic::at - - - - When the watcher is active, returns the absolute time that this watcher is - supposed to trigger next. This is not the same as the offset argument to - EvPeriodic::set - or - EvPeriodic::__construct, - but indeed works even in interval mode. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Returns the absolute time this watcher is supposed to trigger next in - seconds. - - - - diff --git a/reference/ev/evperiodic/construct.xml b/reference/ev/evperiodic/construct.xml deleted file mode 100644 index 81cfc7f86166..000000000000 --- a/reference/ev/evperiodic/construct.xml +++ /dev/null @@ -1,201 +0,0 @@ - - - - - EvPeriodic::__construct - Constructs EvPeriodic watcher object - - - &reftitle.description; - - public - EvPeriodic::__construct - - float - offset - - - string - interval - - - callable - reschedule_cb - - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Constructs EvPeriodic watcher object and starts it automatically. - EvPeriodic::createStopped - method creates stopped periodic watcher. - - - - &reftitle.parameters; - - - - offset - - - - See - Periodic watcher operation modes - - - - - - interval - - - - See - Periodic watcher operation modes - - - - - - reschedule_cb - - - - Reschedule callback. You can pass &null;. See - Periodic watcher operation - modes - - - - - - callback - - - - See - Watcher callbacks. - - - - - - data - - - - Custom data associated with the watcher. - - - - - - priority - - - - Watcher priority - - - - - - - - &reftitle.examples; - - - Periodic timer. Use reschedule callback - - - -]]> - - - - Periodic timer. Tick every 10.5 seconds starting at now - - -]]> - - - - Hourly watcher - - -]]> - - - - - &reftitle.seealso; - - - Periodic watcher operation modes - - - EvTimer - - - EvPeriodic::createStopped - - - - - diff --git a/reference/ev/evperiodic/createstopped.xml b/reference/ev/evperiodic/createstopped.xml deleted file mode 100644 index ffe4491d6021..000000000000 --- a/reference/ev/evperiodic/createstopped.xml +++ /dev/null @@ -1,156 +0,0 @@ - - - - - EvPeriodic::createStopped - Create a stopped EvPeriodic watcher - - - &reftitle.description; - - final - public - static - EvPeriodic - EvPeriodic::createStopped - - float - offset - - - float - interval - - - callable - reschedule_cb - - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Create EvPeriodic object. Unlike - EvPeriodic::__construct - this method doesn't start the watcher automatically. - - - - &reftitle.parameters; - - - - offset - - - - See - Periodic watcher operation modes - - - - - - interval - - - - See - Periodic watcher operation modes - - - - - - reschedule_cb - - - - Reschedule callback. You can pass &null;. See - Periodic watcher operation - modes - - - - - - callback - - - - See - Watcher callbacks. - - - - - - data - - - - Custom data associated with the watcher. - - - - - - priority - - - - Watcher priority - - - - - - - &reftitle.returnvalues; - - Returns EvPeriodic watcher object on success. - - - - &reftitle.seealso; - - - EvPeriodic::__construct - - - EvTimer::createStopped - - - - - diff --git a/reference/ev/evperiodic/set.xml b/reference/ev/evperiodic/set.xml deleted file mode 100644 index 152b2c2148e8..000000000000 --- a/reference/ev/evperiodic/set.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - EvPeriodic::set - Configures the watcher - - - &reftitle.description; - - public - void - EvPeriodic::set - - float - offset - - - float - interval - - - - (Re-)Configures EvPeriodic watcher - - - - &reftitle.parameters; - - - - offset - - - - The same meaning as for - EvPeriodic::__construct. - See - Periodic watcher operation modes - - - - - - interval - - - - The same meaning as for - EvPeriodic::__construct. - See - Periodic watcher operation modes - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/ev/evprepare.xml b/reference/ev/evprepare.xml deleted file mode 100644 index dbfc7b3fe12f..000000000000 --- a/reference/ev/evprepare.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - The EvPrepare class - EvPrepare - - -
- -
- -
- &reftitle.classsynopsis; - - - - - EvPrepare - - - - - EvPrepare - - - extends - EvWatcher - - - - - &InheritedProperties; - - &Methods; - - - &InheritedMethods; - - - -
-
- - &reference.ev.entities.evprepare; - -
- diff --git a/reference/ev/evprepare/construct.xml b/reference/ev/evprepare/construct.xml deleted file mode 100644 index c7f6f35a5d23..000000000000 --- a/reference/ev/evprepare/construct.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - EvPrepare::__construct - Constructs EvPrepare watcher object - - - &reftitle.description; - - public - EvPrepare::__construct - - string - callback - - - string - data - - - string - priority - - - - Constructs EvPrepare watcher object. And starts the watcher automatically. - If a stopped watcher is needed, consider using - EvPrepare::createStopped - - - - &reftitle.parameters; - - - - callback - - - - See - Watcher callbacks. - - - - - - data - - - - Custom data associated with the watcher. - - - - - - priority - - - - Watcher priority - - - - - - - - &reftitle.seealso; - - - EvCheck - - - - - diff --git a/reference/ev/evprepare/createstopped.xml b/reference/ev/evprepare/createstopped.xml deleted file mode 100644 index 833f8235da70..000000000000 --- a/reference/ev/evprepare/createstopped.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - EvPrepare::createStopped - Creates a stopped instance of EvPrepare watcher - - - &reftitle.description; - - final - public - static - EvPrepare - EvPrepare::createStopped - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Creates a stopped instance of EvPrepare watcher. Unlike - EvPrepare::__construct, - this method doesn't start the watcher automatically. - - - - &reftitle.parameters; - - - - callback - - - - See - Watcher callbacks. - - - - - - data - - - - Custom data associated with the watcher. - - - - - - priority - - - - Watcher priority - - - - - - - &reftitle.returnvalues; - - Returns EvPrepare object on success. - - - - &reftitle.seealso; - - - EvPrepare::__construct - - - EvWatcher::start - - - - - diff --git a/reference/ev/evsignal.xml b/reference/ev/evsignal.xml deleted file mode 100644 index e7782ad09db3..000000000000 --- a/reference/ev/evsignal.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - The EvSignal class - EvSignal - - -
- &reftitle.intro; - - EvSignal - watchers will trigger an event when the process receives a specific signal - one or more times. Even though signals are very asynchronous, - libev - will try its best to deliver signals synchronously, i.e. as part of the - normal event processing, like any other event. - - - There is no limit for the number of watchers for the same signal, but only - within the same loop, i.e. one can watch for - SIGINT - in the default loop and for - SIGIO - in another loop, but it is not allowed to watch for - SIGINT - in both the default loop and another loop at the same time. At the moment, - SIGCHLD - is permanently tied to the default loop. - - - If possible and supported, - libev - will install its handlers with - SA_RESTART - (or equivalent) behaviour enabled, so system calls should not be unduly - interrupted. In case of a problem with system calls getting interrupted by - signals, all the signals can be blocked in an - EvCheck - watcher and unblocked in a - EvPrepare - watcher. - -
- -
- &reftitle.classsynopsis; - - - - - EvSignal - - - - - EvSignal - - - extends - EvWatcher - - - - &Properties; - - public - signum - - &InheritedProperties; - - &Methods; - - - &InheritedMethods; - - - -
- -
- &reftitle.properties; - - - - signum - - - - Signal number. See the constants exported by - pcntl - extension. See also - signal(7) - man page. - - - - -
- -
- - &reference.ev.entities.evsignal; - -
- diff --git a/reference/ev/evsignal/construct.xml b/reference/ev/evsignal/construct.xml deleted file mode 100644 index ec996fb33cc0..000000000000 --- a/reference/ev/evsignal/construct.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - EvSignal::__construct - Constructs EvSignal watcher object - - - &reftitle.description; - - public - EvSignal::__construct - - int - signum - - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Constructs EvSignal watcher object and starts it automatically. For a - stopped signal watcher consider using - EvSignal::createStopped - method. - - - - &reftitle.parameters; - - - - signum - - - - Signal number. See constants exported by - pcntl - extension. See also - signal(7) - man page. - - - - - - callback - - - - See - Watcher callbacks. - - - - - - data - - - - Custom data associated with the watcher. - - - - - - priority - - - - Watcher priority - - - - - - - - &reftitle.examples; - - Handle SIGTERM signal - -stop(); -}); - -Ev::run(); -?> -]]> - - - - - &reftitle.seealso; - - - EvSignal::createStopped - - - - - diff --git a/reference/ev/evsignal/createstopped.xml b/reference/ev/evsignal/createstopped.xml deleted file mode 100644 index 8d3ea025f401..000000000000 --- a/reference/ev/evsignal/createstopped.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - EvSignal::createStopped - Create stopped EvSignal watcher object - - - &reftitle.description; - - final - public - static - EvSignal - EvSignal::createStopped - - int - signum - - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Create stopped EvSignal watcher object. Unlike - EvSignal::__construct, - this method doesn't start the watcher automatically. - - - - &reftitle.parameters; - - - - signum - - - - Signal number. See constants exported by - pcntl - extension. See also - signal(7) - man page. - - - - - - callback - - - - See - Watcher callbacks. - - - - - - data - - - - Custom data associated with the watcher. - - - - - - priority - - - - Watcher priority - - - - - - - &reftitle.returnvalues; - - Returns EvSignal object on success. - - - - &reftitle.seealso; - - - EvWatcher::start - - - EvSignal::__construct - - - - - diff --git a/reference/ev/evsignal/set.xml b/reference/ev/evsignal/set.xml deleted file mode 100644 index 5875cbf0d2f8..000000000000 --- a/reference/ev/evsignal/set.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - EvSignal::set - Configures the watcher - - - &reftitle.description; - - public - void - EvSignal::set - - int - signum - - - - Configures the watcher. - - - - &reftitle.parameters; - - - - signum - - - - Signal number. The same as for - EvSignal::__construct - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/ev/evstat.xml b/reference/ev/evstat.xml deleted file mode 100644 index 673aafe68da1..000000000000 --- a/reference/ev/evstat.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - The EvStat class - EvStat - - -
- &reftitle.intro; - - EvStat - monitors a file system path for attribute changes. It calls - stat() - on that path in regular intervals (or when the OS signals it changed) and - sees if it changed compared to the last time, invoking the callback if it - did. - - - The path does not need to exist: changing from "path exists" to "path does - not exist" is a status change like any other. The condition "path does not - exist" is signified by the - 'nlink' - item being 0(returned by - EvStat::attr - method). - - - The path must not end in a slash or contain special components such as - '.' - or - ... - The path should be absolute: if it is relative and the working directory - changes, then the behaviour is undefined. - - - Since there is no portable change notification interface available, the - portable implementation simply calls - stat() - regularly on the path to see if it changed somehow. For this case a - recommended polling interval can be specified. If one specifies a polling - interval of - 0.0 - (highly recommended) then a suitable, unspecified default value will be - used(which could be expected to be around 5 seconds, although this might - change dynamically). - libev - will also impose a minimum interval which is currently around - 0.1, - but that’s usually overkill. - - - This watcher type is not meant for massive numbers of - EvStat - watchers, as even with OS-supported change notifications, this can be - resource-intensive. - -
- -
- &reftitle.classsynopsis; - - - - - EvStat - - - - - EvStat - - - extends - EvWatcher - - - - &Properties; - - public - path - - - public - interval - - &InheritedProperties; - - &Methods; - - - &InheritedMethods; - - - -
- -
- &reftitle.properties; - - - - interval - - - - Readonly. - Hint on how quickly a change is expected to be detected and should - normally be specified as - 0.0 - to let - libev - choose a suitable value. - - - - - - path - - - - Readonly. - The path to wait for status changes on. - - - - -
- -
- - &reference.ev.entities.evstat; - -
- diff --git a/reference/ev/evstat/attr.xml b/reference/ev/evstat/attr.xml deleted file mode 100644 index 2ef7d0272523..000000000000 --- a/reference/ev/evstat/attr.xml +++ /dev/null @@ -1,190 +0,0 @@ - - - - - EvStat::attr - Returns the values most recently detected by Ev - - - &reftitle.description; - - public - array - EvStat::attr - - - - Returns array of the values most recently detected by Ev - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Returns array with the values most recently detect by Ev(without actual - stat - 'ing): - - - List for item keys of the array returned by <methodname>EvStat::attr</methodname> - - - - - Key - Description - - - - - - 'dev' - - ID of device containing file - - - - 'ino' - - inode number - - - - 'mode' - - protection - - - - 'nlink' - - number of hard links - - - - 'uid' - - user ID of owner - - - - 'size' - - total size, in bytes - - - - 'gid' - - group ID of owner - - - - 'rdev' - - device ID (if special file) - - - - 'blksize' - - blocksize for file system I/O - - - - 'blocks' - - number of 512B blocks allocated - - - - 'atime' - - time of last access - - - - 'ctime' - - time of last status change - - - - 'mtime' - - time of last modification - - - -
-
- - See - stat(2) - man page for details. - -
- - &reftitle.examples; - - Monitor changes of /var/log/messages - -attr(); - - if ($attr['nlink']) { - printf("Current size: %ld\n", $attr['size']); - printf("Current atime: %ld\n", $attr['atime']); - printf("Current mtime: %ld\n", $attr['mtime']); - } else { - fprintf(STDERR, "`messages` file is not there!"); - $w->stop(); - } -}); - -Ev::run(); -?> -]]> - - - - - &reftitle.seealso; - - - EvStat::prev - - - EvStat::stat - - - -
- diff --git a/reference/ev/evstat/construct.xml b/reference/ev/evstat/construct.xml deleted file mode 100644 index cea9473da98d..000000000000 --- a/reference/ev/evstat/construct.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - EvStat::__construct - Constructs EvStat watcher object - - - &reftitle.description; - - public - EvStat::__construct - - string - path - - - float - interval - - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Constructs EvStat watcher object and starts the watcher automatically. - - - - &reftitle.parameters; - - - - path - - - - The path to wait for status changes on. - - - - - - interval - - - - Hint on how quickly a change is expected to be detected and should - normally be specified as - 0.0 - to let - libev - choose a suitable value. - - - - - - callback - - - - See - Watcher callbacks. - - - - - - data - - - - Custom data associated with the watcher. - - - - - - priority - - - - Watcher priority - - - - - - - - &reftitle.examples; - - - Monitor changes of /var/log/messages - -attr(); - - if ($attr['nlink']) { - printf("Current size: %ld\n", $attr['size']); - printf("Current atime: %ld\n", $attr['atime']); - printf("Current mtime: %ld\n", $attr['mtime']); - } else { - fprintf(STDERR, "`messages` file is not there!"); - $w->stop(); - } -}); - -?> -]]> - - - - - diff --git a/reference/ev/evstat/createstopped.xml b/reference/ev/evstat/createstopped.xml deleted file mode 100644 index b995d568e664..000000000000 --- a/reference/ev/evstat/createstopped.xml +++ /dev/null @@ -1,144 +0,0 @@ - - - - - EvStat::createStopped - Create a stopped EvStat watcher object - - - &reftitle.description; - - final - public - static - void - EvStat::createStopped - - string - path - - - float - interval - - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Creates EvStat watcher object, but doesn't start it - automatically(unlike - EvStat::__construct - ). - - - - &reftitle.parameters; - - - - path - - - - The path to wait for status changes on. - - - - - - interval - - - - Hint on how quickly a change is expected to be detected and should - normally be specified as - 0.0 - to let - libev - choose a suitable value. - - - - - - callback - - - - See - Watcher callbacks. - - - - - - data - - - - Custom data associated with the watcher. - - - - - - priority - - - - Watcher priority - - - - - - - &reftitle.returnvalues; - - Returns a stopped EvStat watcher object on success. - - - - &reftitle.seealso; - - - EvStat::__construct - - - EvWatcher::start - - - - - diff --git a/reference/ev/evstat/prev.xml b/reference/ev/evstat/prev.xml deleted file mode 100644 index cca8ba36cd45..000000000000 --- a/reference/ev/evstat/prev.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - EvStat::prev - Returns the previous set of values returned by EvStat::attr - - - &reftitle.description; - - public - void - EvStat::prev - - - - Just like - EvStat::attr, - but returns the previous set of values. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Returns an array with the same structure as the array returned by - EvStat::attr. - The array contains previously detected values. - - - - &reftitle.seealso; - - - EvStat::attr - - - EvStat::stat - - - - - diff --git a/reference/ev/evstat/set.xml b/reference/ev/evstat/set.xml deleted file mode 100644 index 5ccf10b13222..000000000000 --- a/reference/ev/evstat/set.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - EvStat::set - Configures the watcher - - - &reftitle.description; - - public - void - EvStat::set - - string - path - - - float - interval - - - - Configures the watcher. - - - - &reftitle.parameters; - - - - path - - - - The path to wait for status changes on. - - - - - - interval - - - - Hint on how quickly a change is expected to be detected and should - normally be specified as - 0.0 - to let - libev - choose a suitable value. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/ev/evstat/stat.xml b/reference/ev/evstat/stat.xml deleted file mode 100644 index 80e7cec6b703..000000000000 --- a/reference/ev/evstat/stat.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - EvStat::stat - Initiates the stat call - - - &reftitle.description; - - public - bool - EvStat::stat - - - - Initiates the stat call(updates internal cache). It stats(using - lstat) - the - path - specified in the watcher and sets to the values found. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Returns &true; if - path - exists. Otherwise &false;. - - - - &reftitle.seealso; - - - EvStat::attr - - - EvStat::prev - - - - - diff --git a/reference/ev/evtimer.xml b/reference/ev/evtimer.xml deleted file mode 100644 index 35bef355a551..000000000000 --- a/reference/ev/evtimer.xml +++ /dev/null @@ -1,164 +0,0 @@ - - - - The EvTimer class - EvTimer - - -
- &reftitle.intro; - - EvTimer - watchers are simple relative timers that generate an event after a given - time, and optionally repeating in regular intervals after that. - - - The timers are based on real time, that is, if one registers an event that - times out after an hour and resets the system clock to - January last year, - it will still time out after(roughly) one hour. "Roughly" because - detecting time jumps is hard, and some inaccuracies are unavoidable. - - - The callback is guaranteed to be invoked only after its timeout has passed - (not at, so on systems with very low-resolution clocks this might - introduce a small delay). If multiple timers become ready during the same - loop iteration then the ones with earlier time-out values are invoked - before ones of the same priority with later time-out values (but this is - no longer true when a callback calls - EvLoop::run - recursively). - - - The timer itself will do a best-effort at avoiding drift, that is, if a - timer is configured to trigger every - 10 - seconds, then it will normally trigger at exactly - 10 - second intervals. If, however, the script cannot keep up with the timer - because it takes longer than those - 10 - seconds to do) the timer will not fire more than once per event loop - iteration. - -
- -
- &reftitle.classsynopsis; - - - - - EvTimer - - - - - EvTimer - - - extends - EvWatcher - - - - &Properties; - - public - repeat - - - public - remaining - - &InheritedProperties; - - &Methods; - - - &InheritedMethods; - - - -
- -
- &reftitle.properties; - - - - repeat - - - - If repeat is - 0.0, - then it will automatically be stopped once the timeout is reached. If - it is positive, then the timer will automatically be configured to - trigger again every repeat seconds later, until stopped manually. - - - - - - remaining - - - - Returns the remaining time until a timer fires. If the timer is active, - then this time is relative to the current event loop time, otherwise - it's the timeout value currently configured. - - - That is, after instantiating an - EvTimer - with an - after - value of - 5.0 - and - repeat - value of - 7.0, - remaining - returns - 5.0. - When the timer is started and one second passes, - remaining - will return - 4.0. - When the timer expires and is restarted, it will return roughly - 7.0 - (likely slightly less as callback invocation takes some time too), and - so on. - - - - -
- -
- - &reference.ev.entities.evtimer; - -
- diff --git a/reference/ev/evtimer/again.xml b/reference/ev/evtimer/again.xml deleted file mode 100644 index 44760fc25b75..000000000000 --- a/reference/ev/evtimer/again.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - EvTimer::again - Restarts the timer watcher - - - &reftitle.description; - - public - void - EvTimer::again - - - - This will act as if the timer timed out and restart it again if it is - repeating. The exact semantics are: - - - - - if the timer is pending, its pending status is cleared. - - - - - if the timer is started but non-repeating, stop it (as if it timed out). - - - - - if the timer is repeating, either start it if necessary (with the - repeat - value), or reset the running timer to the - repeat - value. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EvWatcher::stop - - - - - diff --git a/reference/ev/evtimer/construct.xml b/reference/ev/evtimer/construct.xml deleted file mode 100644 index d788c1c50af3..000000000000 --- a/reference/ev/evtimer/construct.xml +++ /dev/null @@ -1,220 +0,0 @@ - - - - - EvTimer::__construct - Constructs an EvTimer watcher object - - - &reftitle.description; - - public - EvTimer::__construct - - float - after - - - float - repeat - - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Constructs an EvTimer watcher object. - - - - &reftitle.parameters; - - - - after - - - - Configures the timer to trigger after - after - seconds. - - - - - - repeat - - - - If repeat is - 0.0, - then it will automatically be stopped once the timeout is reached. If - it is positive, then the timer will automatically be configured to - trigger again every repeat seconds later, until stopped manually. - - - - - - callback - - - - See - Watcher callbacks. - - - - - - data - - - - Custom data associated with the watcher. - - - - - - priority - - - - Watcher priority - - - - - - - - &reftitle.examples; - - Simple timers - -stop(); - // Stop the watcher if further calls cause more than 10 iterations - Ev::iteration() >= 10 and $w->stop(); -}); - -// Create stopped timer. It will be inactive until we start it ourselves -$w_stopped = EvTimer::createStopped(10, 5, function($w) { - echo "Callback of a timer created as stopped\n"; - - // Stop the watcher after 2 iterations - Ev::iteration() >= 2 and $w->stop(); -}); - -// Loop until Ev::stop() is called or all of watchers stop -Ev::run(); - -// Start and look if it works -$w_stopped->start(); -echo "Run single iteration\n"; -Ev::run(Ev::RUN_ONCE); - -echo "Restart the second watcher and try to handle the same events, but don't block\n"; -$w2->again(); -Ev::run(Ev::RUN_NOWAIT); - -$w = new EvTimer(10, 0, function() {}); -echo "Running a blocking loop\n"; -Ev::run(); -echo "END\n"; -?> -]]> - - &example.outputs.similar; - - - - - - - &reftitle.seealso; - - - EvTimer::createStopped - - - EvPeriodic - - - ev_timer - relative and optionally repeating timeouts - - - Be smart about timeouts - - - - - diff --git a/reference/ev/evtimer/createstopped.xml b/reference/ev/evtimer/createstopped.xml deleted file mode 100644 index 691ddabda645..000000000000 --- a/reference/ev/evtimer/createstopped.xml +++ /dev/null @@ -1,173 +0,0 @@ - - - - - EvTimer::createStopped - Creates EvTimer stopped watcher object - - - &reftitle.description; - - final - public - static - EvTimer - EvTimer::createStopped - - float - after - - - float - repeat - - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Creates EvTimer stopped watcher object. Unlike - EvTimer::__construct, - this method doesn't start the watcher automatically. - - - - &reftitle.parameters; - - - - after - - - - Configures the timer to trigger after - after - seconds. - - - - - - repeat - - - - If repeat is - 0.0, - then it will automatically be stopped once the timeout is reached. If - it is positive, then the timer will automatically be configured to - trigger again every repeat seconds later, until stopped manually. - - - - - - callback - - - - See - Watcher callbacks. - - - - - - data - - - - Custom data associated with the watcher. - - - - - - priority - - - - Watcher priority - - - - - - - &reftitle.returnvalues; - - Returns EvTimer watcher object on success. - - - - &reftitle.examples; - - Monitor changes of /var/log/messages. Avoid missing updates by means of one second delay - -stop(); - - $stat = $w->data; - - // 1 second after the most recent change of the file - printf("Current size: %ld\n", $stat->attr()['size']); -}); - -$stat = new EvStat("/var/log/messages", 0., function () use ($timer) { - // Reset timer watcher - $timer->again(); -}); - -$timer->data = $stat; - -Ev::run(); -?> -]]> - - - - - &reftitle.seealso; - - - EvTimer::__construct - - - EvPeriodic - - - - - diff --git a/reference/ev/evtimer/set.xml b/reference/ev/evtimer/set.xml deleted file mode 100644 index a32690104826..000000000000 --- a/reference/ev/evtimer/set.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - EvTimer::set - Configures the watcher - - - &reftitle.description; - - public - void - EvTimer::set - - float - after - - - float - repeat - - - - Configures the watcher - - - - &reftitle.parameters; - - - - after - - - - Configures the timer to trigger after - after - seconds. - - - - - - repeat - - - - If repeat is - 0.0, - then it will automatically be stopped once the timeout is reached. If - it is positive, then the timer will automatically be configured to - trigger again every repeat seconds later, until stopped manually. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/ev/evwatcher.xml b/reference/ev/evwatcher.xml deleted file mode 100644 index 785b45687d84..000000000000 --- a/reference/ev/evwatcher.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - The EvWatcher class - EvWatcher - - -
- &reftitle.intro; - - EvWatcher - is a base class for all watchers( - EvCheck, - EvChild - etc.). Since - EvWatcher - 's constructor is - abstract, - one can't(and don't need to) create EvWatcher objects - directly. - -
- -
- &reftitle.classsynopsis; - - - - - EvWatcher - - - - - abstract - EvWatcher - - - - &Properties; - - public - is_active - - - public - data - - - public - is_pending - - - public - priority - - &Methods; - - - - -
- -
- &reftitle.properties; - - - - is_active - - - - Readonly. - &true; if the watcher is active. &false; otherwise. - - - - - - data - - - - User custom data associated with the watcher - - - - - - is_pending - - - - Readonly - .&true; if the watcher is pending, i.e. it has outstanding events, but - its callback has not yet been invoked. &false; otherwise. As long, as a - watcher is pending(but not active), one must - not - change its priority. - - - - - - priority - - - - int - between - Ev::MINPRI - and - Ev::MAXPRI. - Pending watchers with higher priority will be invoked before watchers - with lower priority, but priority will not keep watchers from being - executed(except for - EvIdle - watchers). - EvIdle - watchers provide functionality to suppress invocation when higher - priority events are pending. - - - - -
- -
- - &reference.ev.entities.evwatcher; - -
- diff --git a/reference/ev/evwatcher/clear.xml b/reference/ev/evwatcher/clear.xml deleted file mode 100644 index 51cb3d6c4025..000000000000 --- a/reference/ev/evwatcher/clear.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - EvWatcher::clear - Clear watcher pending status - - - &reftitle.description; - - public - int - EvWatcher::clear - - - - If the watcher is pending, this method clears its - pending - status and returns its - revents - bitset(as if its callback was invoked). If the watcher isn't pending - it does nothing and returns - 0. - - - Sometimes it can be useful to "poll" a watcher instead of waiting for its - callback to be invoked, which can be accomplished with this function. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - In case if the watcher is pending, returns - revents - bitset as if the - watcher callback - had been invoked. Otherwise returns - 0. - - - - diff --git a/reference/ev/evwatcher/construct.xml b/reference/ev/evwatcher/construct.xml deleted file mode 100644 index b01c7dfc981f..000000000000 --- a/reference/ev/evwatcher/construct.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - EvWatcher::__construct - Abstract constructor of a watcher object - - - &reftitle.description; - - abstract - public - EvWatcher::__construct - - - - EvWatcher::__construct - is an abstract constructor of a watcher object implemented in the derived - classes. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - diff --git a/reference/ev/evwatcher/feed.xml b/reference/ev/evwatcher/feed.xml deleted file mode 100644 index a4a65ccf6d6c..000000000000 --- a/reference/ev/evwatcher/feed.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - EvWatcher::feed - Feeds the given revents set into the event loop - - - &reftitle.description; - - public - void - EvWatcher::feed - - int - revents - - - - Feeds the given revents set into the event loop, as if the specified event - had happened for the watcher. - - - - &reftitle.parameters; - - - - revents - - - - Bit mask of watcher - received events. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/ev/evwatcher/getloop.xml b/reference/ev/evwatcher/getloop.xml deleted file mode 100644 index 395dbe332971..000000000000 --- a/reference/ev/evwatcher/getloop.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - EvWatcher::getLoop - Returns the loop responsible for the watcher - - - &reftitle.description; - - public - EvLoop - EvWatcher::getLoop - - - - Returns the loop responsible for the watcher - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Returns - EvLoop - event loop object responsible for the watcher. - - - - diff --git a/reference/ev/evwatcher/invoke.xml b/reference/ev/evwatcher/invoke.xml deleted file mode 100644 index f680ab891c0b..000000000000 --- a/reference/ev/evwatcher/invoke.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - EvWatcher::invoke - Invokes the watcher callback with the given received events bit - mask - - - &reftitle.description; - - public - void - EvWatcher::invoke - - int - revents - - - - Invokes the watcher callback with the given received events bit mask. - - - - &reftitle.parameters; - - - - revents - - - - Bit mask of watcher - received events. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/ev/evwatcher/keepalive.xml b/reference/ev/evwatcher/keepalive.xml deleted file mode 100644 index 2fe7e384d27f..000000000000 --- a/reference/ev/evwatcher/keepalive.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - EvWatcher::keepalive - Configures whether to keep the loop from returning - - - &reftitle.description; - - public - bool - EvWatcher::keepalive - - bool - value - - - - Configures whether to keep the loop from returning. With keepalive - value - set to &false; the watcher won't keep - Ev::run - / - EvLoop::run - from returning even though the watcher is active. - - - Watchers have keepalive - value - &true; by default. - - - Clearing keepalive status is useful when returning from - Ev::run - / - EvLoop::run - just because of the watcher is undesirable. It could be a long running UDP - socket watcher or so. - - - - &reftitle.parameters; - - - - value - - - - With keepalive - value - set to &false; the watcher won't keep - Ev::run - / - EvLoop::run - from returning even though the watcher is active. - - - - - - - &reftitle.returnvalues; - - Returns the previous state. - - - - &reftitle.examples; - - Register an I/O watcher for some UDP socket but do not keep the - event loop from running just because of that watcher. - -keepalive(FALSE); -?> -]]> - - - - - diff --git a/reference/ev/evwatcher/setcallback.xml b/reference/ev/evwatcher/setcallback.xml deleted file mode 100644 index d0725fe984f5..000000000000 --- a/reference/ev/evwatcher/setcallback.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - EvWatcher::setCallback - Sets new callback for the watcher - - - &reftitle.description; - - public - void - EvWatcher::setCallback - - callable - callback - - - - Sets new callback for the watcher - - - - &reftitle.parameters; - - - - callback - - - - See - Watcher callbacks. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/ev/evwatcher/start.xml b/reference/ev/evwatcher/start.xml deleted file mode 100644 index ea965ee9297f..000000000000 --- a/reference/ev/evwatcher/start.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - EvWatcher::start - Starts the watcher - - - &reftitle.description; - - public - void - EvWatcher::start - - - - Marks the watcher as active. Note that only active watchers will receive - events. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EvWatcher::stop - - - - - diff --git a/reference/ev/evwatcher/stop.xml b/reference/ev/evwatcher/stop.xml deleted file mode 100644 index a4bfe950e8d4..000000000000 --- a/reference/ev/evwatcher/stop.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - EvWatcher::stop - Stops the watcher - - - &reftitle.description; - - public - void - EvWatcher::stop - - - - Marks the watcher as inactive. Note that only active watchers will receive - events. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EvWatcher::start - - - - - diff --git a/reference/ev/examples.xml b/reference/ev/examples.xml deleted file mode 100644 index c318a11dc528..000000000000 --- a/reference/ev/examples.xml +++ /dev/null @@ -1,435 +0,0 @@ - - - - &reftitle.examples; - - Simple timers - -stop(); - // Stop the watcher if further calls cause more than 10 iterations - Ev::iteration() >= 10 and $w->stop(); -}); - -// Create stopped timer. It will be inactive until we start it ourselves -$w_stopped = EvTimer::createStopped(10, 5, function($w) { - echo "Callback of a timer created as stopped\n"; - - // Stop the watcher after 2 iterations - Ev::iteration() >= 2 and $w->stop(); -}); - -// Loop until Ev::stop() is called or all of watchers stop -Ev::run(); - -// Start and look if it works -$w_stopped->start(); -echo "Run single iteration\n"; -Ev::run(Ev::RUN_ONCE); - -echo "Restart the second watcher and try to handle the same events, but don't block\n"; -$w2->again(); -Ev::run(Ev::RUN_NOWAIT); - -$w = new EvTimer(10, 0, function() {}); -echo "Running a blocking loop\n"; -Ev::run(); -echo "END\n"; -?> -]]> - - &example.outputs.similar; - - - - - - Periodic timer. Tick each 10.5 seconds - - -]]> - - - - Periodic timer. Use reschedule callback - - - -]]> - - - - Periodic timer. Tick every 10.5 seconds starting at now - - -]]> - - - - Wait until STDIN is readable - - -]]> - - - - Use some async I/O to access a socket - -stop(); - // Stop write watcher - $w->stop(); - - $in = "HEAD / HTTP/1.1\r\n"; - $in .= "Host: google.co.uk\r\n"; - $in .= "Connection: Close\r\n\r\n"; - - if (!socket_write($socket, $in, strlen($in))) { - trigger_error("Failed writing $in to socket", E_USER_ERROR); - } - - $read_watcher = new EvIo($socket, Ev::READ, function ($w, $re) - use ($socket, $e_nonblocking) - { - // Socket is readable. recv() 20 bytes using non-blocking mode - $ret = socket_recv($socket, $out, 20, MSG_DONTWAIT); - - if ($ret) { - echo $out; - } elseif ($ret === 0) { - // All read - $w->stop(); - socket_close($socket); - return; - } - - // Caught EINPROGRESS, EAGAIN, or EWOULDBLOCK - if (in_array(socket_last_error(), $e_nonblocking)) { - return; - } - - $w->stop(); - socket_close($socket); - }); - - Ev::run(); -}); - -$result = socket_connect($socket, $address, $service_port); - -Ev::run(); -?> -]]> - - &example.outputs.similar; - - - - - - Embedding one loop into another - - -]]> - - - - Embedding loop created with kqueue backend into the default loop - - -]]> - - - - Handle SIGTERM signal - -stop(); -}); - -Ev::run(); -?> -]]> - - - - Monitor changes of /var/log/messages - -attr(); - - if ($attr['nlink']) { - printf("Current size: %ld\n", $attr['size']); - printf("Current atime: %ld\n", $attr['atime']); - printf("Current mtime: %ld\n", $attr['mtime']); - } else { - fprintf(STDERR, "`messages` file is not there!"); - $w->stop(); - } -}); - -Ev::run(); -?> -]]> - - - - Monitor changes of /var/log/messages. Avoid missing updates by means of one second delay - -stop(); - - $stat = $w->data; - - // 1 second after the most recent change of the file - printf("Current size: %ld\n", $stat->attr()['size']); -}); - -$stat = new EvStat("/var/log/messages", 0., function () use ($timer) { - // Reset timer watcher - $timer->again(); -}); - -$timer->data = $stat; - -Ev::run(); -?> -]]> - - - - Process status changes - -stop(); - - printf("Process %d exited with status %d\n", $w->rpid, $w->rstatus); - }); - - Ev::run(); - - // Protect against Zombies - pcntl_wait($status); -} else { - //Forked child - exit(2); -} -?> -]]> - - - - diff --git a/reference/ev/periodic-modes.xml b/reference/ev/periodic-modes.xml deleted file mode 100644 index 0388fbc04288..000000000000 --- a/reference/ev/periodic-modes.xml +++ /dev/null @@ -1,158 +0,0 @@ - - - - Periodic watcher operation modes - - EvPeriodic - watcher works in different modes depending on the - offset, - interval - and - reschedule_cb - parameters. - - - - - Absolute timer. - In this mode - interval - = - 0, - reschedule_cb - = &null;. This time simply fires at the wallclock time - offset - and doesn't repeat. It will not adjust when a time jump occurs, that is, - if it is to be run at - January - 1st 2014 - then it will run when the system time reaches or surpasses this time. - - - - - Repeating interval timer. - In this mode - interval - > - 0, - reschedule_cb - = &null;; the watcher will always be scheduled to timeout at the next - offset - + - N - * - interval - time(for some integer - N) - and then repeat, regardless of any time jumps. - - - This can be used to create timers that do not drift with respect to system - time: - - -]]> - - That doesn't mean there will always be - 3600 - seconds in between triggers, but only that the callback will be called - when the system time shows a full hour( - UTC - ). - - - EvPeriodic - will try to run the callback in this mode at the next possible time where - time - = - offset - ( - mod - interval - ), regardless of any time jumps. - - - - - Manual reschedule mode. - In this mode - reschedule_cb - is a - callable. - - - interval - and - offset - are both being ignored. Instead, each time the periodic watcher gets - scheduled, the reschedule callback ( - reschedule_cb) - will be called with the watcher as first, and the current time as second - argument. - - - This callback - must not - stop or destroy this or any other periodic watchers, ever, and - must not - call any event loop functions or methods. To stop it return - 1e30 - and stop it afterwards. An - EvPrepare - watcher may be used for this task. - - - It must return the next time to trigger, based on the passed time value - (that is, the lowest time value larger than or equal to the second - argument). It will usually be called just before the callback will be - triggered, but might be called at other times, too. - - - Using reschedule callback - - -]]> - - - - - - diff --git a/reference/ev/setup.xml b/reference/ev/setup.xml deleted file mode 100644 index e8f43d896e80..000000000000 --- a/reference/ev/setup.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - &reftitle.setup; - -
- &reftitle.required; - - libev - library is embedded into this extension. You don't need to install it - separately. - -
-
- &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;ev. - -
-
- diff --git a/reference/ev/versions.xml b/reference/ev/versions.xml deleted file mode 100644 index 492e471d0de6..000000000000 --- a/reference/ev/versions.xml +++ /dev/null @@ -1,228 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/ev/watcher-callbacks.xml b/reference/ev/watcher-callbacks.xml deleted file mode 100644 index a533551b5b79..000000000000 --- a/reference/ev/watcher-callbacks.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - Watcher callbacks - - All watchers can be active(waiting for events) or inactive(paused). Only - active watchers will have their callbacks invoked. All callbacks will be - called with at least two arguments: - watcher - - the watcher, and - revents - a bitmask of received events. - - - Watcher callbacks are passed to the watcher constructors (the classes derived - from - EvWatcher - - - EvCheck::__construct, - EvChild::__construct - etc.). A watcher callback should match the following prototype: - - - void - callback - - object - watcher - NULL - - - int - revents - NULL - - - - - - watcher - - - - The watcher instance(of a class extending - EvWatcher - ). - - - - - - revents - - - - Watcher received events. - - - - - - Each watcher type has its associated bit in - revents, - so one can use the same callback for multiple watchers. The event mask is - named after the type, i.e. - EvChild - (or - EvLoop::child) - sets - Ev::CHILD, - EvPrepare - (or - EvLoop::prepare) - sets - Ev::PREPARE, - EvPeriodic - (or - EvLoop::periodic) - sets - Ev::PERIODIC - and so on, with the exception of I/O events (which can set both - Ev::READ - and - Ev::WRITE - bits). - - - diff --git a/reference/ev/watchers.xml b/reference/ev/watchers.xml deleted file mode 100644 index c74e262566e5..000000000000 --- a/reference/ev/watchers.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - Watchers - - A watcher is an object that gets created to record interest in some event. - For instance, the following code waits for - STDIN - to become readable: - - -]]> - - - - All the watcher constructors automatically start the watchers. - createStopped - methods create stopped watchers(e.g. - EvIo::createStopped) - - - Note that a watcher will automatically be stopped when the watcher object is - destroyed. Therefore, the watcher objects returned by the constructors or - factory methods should be kept. - - - Note also that all methods changing some watcher property( - set, - priority - etc.) automatically stop and start it again if it is active, which means - pending events get lost. - - - See also: - Watcher callbacks. - - - diff --git a/reference/event/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/event/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/event/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/event/book.xml b/reference/event/book.xml deleted file mode 100644 index d6bd18e14f62..000000000000 --- a/reference/event/book.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - Event - Event - - &reftitle.intro; - - This is an extension to efficiently schedule I/O, time and signal based - events using the best I/O notification mechanism available for specific - platform. This is a port of libevent to the PHP infrastructure. - - - - Note, Windows support introduced in - event-1.9.0. - - - - Version - 1.0.0 - introduces new object-oriented API (breaking backwards compatibility), and - support of libevent 2+ including HTTP, DNS, OpenSSL and the event listener. - - - - Note, - event-1.0.0 - and greater is not compatible with previous versions. - - - - &reference.event.setup; - &reference.event.examples; - &reference.event.event.flags; - &reference.event.event.persistence; - &reference.event.event.callbacks; - &reference.event.event.constructing.signal.events; - &reference.event.event; - &reference.event.eventbase; - &reference.event.eventbuffer; - &reference.event.eventbufferevent; - &reference.event.eventbufferevent.about.callbacks; - &reference.event.eventconfig; - &reference.event.eventdnsbase; - &reference.event.eventhttp; - &reference.event.eventhttpconnection; - &reference.event.eventhttprequest; - &reference.event.eventlistener; - &reference.event.eventsslcontext; - &reference.event.eventutil; - &reference.event.eventexception; - - - diff --git a/reference/event/configure.xml b/reference/event/configure.xml deleted file mode 100644 index 989ca6e81044..000000000000 --- a/reference/event/configure.xml +++ /dev/null @@ -1,30 +0,0 @@ - - -
- &reftitle.install; - - - &pecl.info; - &url.pecl.package;event - -
- diff --git a/reference/event/event.callbacks.xml b/reference/event/event.callbacks.xml deleted file mode 100644 index c5017d8aeb4d..000000000000 --- a/reference/event/event.callbacks.xml +++ /dev/null @@ -1,160 +0,0 @@ - - - - Event callbacks - - If a callback is registered for an event, it will be called when the event - becomes active. To associate a callback with event one can pass a - callable - to either - Event::__construct, - or - Event::set, - or one of the factory methods like - Event::timer. - - - An event callback should match the following prototype: - - - void - callback - - mixed - fd - &null; - - - int - what - - - mixed - arg - &null; - - - - - - fd - - - - The file descriptor, stream resource or socket associated with the - event. For signal event - fd - is equal to the signal number. - - - - - - what - - - - Bit mask of - all - events triggered. - - - - - - arg - - - - User custom data. - - - - - - Event::timer - expects the callback to match the following prototype: - - - void - callback - - mixed - arg - &null; - - - - - - arg - - - - User custom data. - - - - - - Event::signal - expects the callback to match the following prototype: - - - void - callback - - int - signum - - - mixed - arg - &null; - - - - - - signum - - - - The number of the triggered signal(e.g. - SIGTERM - ). - - - - - - arg - - - - User custom data. - - - - - - diff --git a/reference/event/event.constructing.signal.events.xml b/reference/event/event.constructing.signal.events.xml deleted file mode 100644 index 1e7b9e472ef8..000000000000 --- a/reference/event/event.constructing.signal.events.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - Constructing signal events - - Event can also watch for POSIX-style signals. To construct a handler for a - signal, use - Event::__construct - constructor with - Event::SIGNAL - flag, or - Event::signal - factory method. - - - Handling <literal>SIGTERM</literal> signal - -base = $base; - $this->ev = Event::signal($base, SIGTERM, array($this, 'eventSighandler')); - $this->ev->add(); - } - - public function eventSighandler($no, $c) { - echo "Caught signal $no\n"; - $this->base->exit(); - } -} - -$base = new EventBase(); -$c = new MyEventSignal($base); - -$base->loop(); -?> -]]> - - - - Note that signal callbacks are run in the event loop after the signal - occurs, so it is safe for them to call functions that you are not supposed - to call from a regular POSIX signal handler. - - - - See also - Fast - portable non-blocking network programming with Libevent, Constructing Signal - Events. - - - diff --git a/reference/event/event.flags.xml b/reference/event/event.flags.xml deleted file mode 100644 index 739220413c19..000000000000 --- a/reference/event/event.flags.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - Event flags - - Event::READ - This flag indicates an event that becomes active when the provided file - descriptor (usually a stream resource, or socket) is ready for reading. - - - Event::WRITE - flag indicates an event that becomes active when the provided file - descriptor (usually a stream resource, or socket) is ready for writing. - - - Event::SIGNAL - used to implement signal detection. See "Constructing signal events" below. - - - Event::TIMEOUT - indicates an event that becomes active after a timeout elapses. The - Event::TIMEOUT - flag is ignored when constructing an event: one can either set a timeout - when event is - added, - or not. It is set in the - $what - argument to the callback function when a timeout has occurred. - - - See also - Fast - portable non-blocking network programming with Libevent, Working with events, - Event flags - - - diff --git a/reference/event/event.persistence.xml b/reference/event/event.persistence.xml deleted file mode 100644 index 648ef79c3640..000000000000 --- a/reference/event/event.persistence.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - About event persistence - - By default, whenever a pending event becomes active (because its file - descriptor is ready to read or write, or because its timeout expires), it - becomes non-pending right before its callback is executed. Thus, to make the - event pending again one may call - Event::add - on it again from inside the callback function. - - - If the - Event::PERSIST - flag is set on an event, however, the event is - persistent. - This means that event remains pending even when its callback is activated. - Event::del - method can be called to make it non-pending. - - - The timeout on a persistent event resets whenever the event's callback runs. - Thus, if one has an event with flags - Event::READ - | - Event::PERSIST - and a timeout of five seconds, the event will become active: - - - - - Whenever the socket or file descriptor is ready for reading. - - - - - Whenever five seconds have passed since the event last became active. - - - - - See also - Fast - portable non-blocking network programming with Libevent, About Event - Persistence - - - diff --git a/reference/event/event.xml b/reference/event/event.xml deleted file mode 100644 index 66ac882a1486..000000000000 --- a/reference/event/event.xml +++ /dev/null @@ -1,236 +0,0 @@ - - - - The Event class - Event - - -
- &reftitle.intro; - - Event - class represents and event firing on a file descriptor being ready to read - from or write to; a file descriptor becoming ready to read from or write - to(edge-triggered I/O only); a timeout expiring; a signal occurring; a - user-triggered event. - - - Every event is associated with - EventBase. - However, event will never fire until it is - added - (via - Event::add - ). An added event remains in - pending - state until the registered event occurs, thus turning it to - active - state. To handle events user may register a callback which is called when - event becomes active. If event is configured - persistent, - it remains pending. If it is not persistent, it stops being pending when - it's callback runs. - Event::del - method - deletes - event, thus making it non-pending. By means of - Event::add - method it could be added again. - -
- -
- &reftitle.classsynopsis; - - - - - Event - - - - - final - Event - - - - &Constants; - - const - int - Event::ET - 32 - - - const - int - Event::PERSIST - 16 - - - const - int - Event::READ - 2 - - - const - int - Event::WRITE - 4 - - - const - int - Event::SIGNAL - 8 - - - const - int - Event::TIMEOUT - 1 - - &Properties; - - public - readonly - bool - pending - - &Methods; - - - -
- -
- &reftitle.properties; - - - - pending - - - - Whether event is pending. See - About event persistence. - - - - -
- - -
- &reftitle.constants; - - - - Event::ET - - - - Indicates that the event should be edge-triggered, if the underlying - event base backend supports edge-triggered events. This affects the - semantics of - Event::READ - and - Event::WRITE. - - - - - - Event::PERSIST - - - - Indicates that the event is persistent. See - About event persistence. - - - - - - Event::READ - - - - This flag indicates an event that becomes active when the provided file - descriptor(usually a stream resource, or socket) is ready for reading. - - - - - - Event::WRITE - - - - This flag indicates an event that becomes active when the provided file - descriptor(usually a stream resource, or socket) is ready for writing. - - - - - - Event::SIGNAL - - - - Used to implement signal detection. See "Constructing signal events" - below. - - - - - - Event::TIMEOUT - - - - This flag indicates an event that becomes active after a timeout - elapses. - - - The - Event::TIMEOUT - flag is ignored when constructing an event: one can either set a - timeout when event is - added, - or not. It is set in the - $what - argument to the callback function when a timeout has occurred. - - - - -
- -
- - &reference.event.entities.event; - -
- diff --git a/reference/event/event/add.xml b/reference/event/event/add.xml deleted file mode 100644 index 2ae88e158a3d..000000000000 --- a/reference/event/event/add.xml +++ /dev/null @@ -1,166 +0,0 @@ - - - - - Event::add - Makes event pending - - - &reftitle.description; - - public - bool - Event::add - - float - timeout - - - - Marks event pending. Non-pending event will never occur, and the event - callback will never be called. In conjunction with - Event::del - an event could be re-scheduled by user at any time. - - - If - Event::add - is called on an already pending event, libevent will leave it pending and - re-schedule it with the given timeout(if specified). If in this case - timeout is not specified, - Event::add - has no effect. - - - - - &reftitle.parameters; - - - - timeout - - - - Timeout in seconds. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Adding a custom signal - - base = $base; - $this->ev = Event::signal($base, SIGTERM, array($this, 'eventSighandler')); - $this->ev->add(); - } - - public function eventSighandler($no, $c) { - echo "Caught signal $no\n"; - $this->base->exit(); - } -} - -$base = new EventBase(); -$c = new MyEventSignal($base); - -$base->loop(); -?> -]]> - - &example.outputs.similar; - - - - - - - Adding a timer - - delTimer(); -}, $n); -$e->add($n); -$base->loop(); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Event::add - Event::del - Event::signal - Event::timer - - - - diff --git a/reference/event/event/addsignal.xml b/reference/event/event/addsignal.xml deleted file mode 100644 index 0a6c27ec69a1..000000000000 --- a/reference/event/event/addsignal.xml +++ /dev/null @@ -1,35 +0,0 @@ - - - - - Event::addSignal - &Alias; Event::add - - - - &reftitle.description; - - &info.method.alias; Event::add - - - - diff --git a/reference/event/event/addtimer.xml b/reference/event/event/addtimer.xml deleted file mode 100644 index 4da1df7fc033..000000000000 --- a/reference/event/event/addtimer.xml +++ /dev/null @@ -1,35 +0,0 @@ - - - - - Event::addTimer - &Alias; Event::add - - - - &reftitle.description; - - &info.method.alias; Event::add - - - - diff --git a/reference/event/event/construct.xml b/reference/event/event/construct.xml deleted file mode 100644 index 0b3494f67a7a..000000000000 --- a/reference/event/event/construct.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - Event::__construct - Constructs Event object - - - &reftitle.description; - - public - Event::__construct - - EventBase - base - - - mixed - fd - - - int - what - - - callable - cb - - - mixed - arg - NULL - - - - Constructs Event object. - - - - &reftitle.parameters; - - - - base - - - - The event base to associate with. - - - - - - fd - - - - stream resource, socket resource, or numeric file descriptor. For timer - events pass - -1. - For signal events pass the signal number, e.g. - SIGHUP. - - - - - - what - - - - Event flags. See - Event flags. - - - - - - cb - - - - The event callback. See - Event callbacks. - - - - - - arg - - - - Custom data. If specified, it will be passed to the callback when event - triggers. - - - - - - - &reftitle.seealso; - - - Event::signal - - - Event::timer - - - - - diff --git a/reference/event/event/del.xml b/reference/event/event/del.xml deleted file mode 100644 index 575446872fb4..000000000000 --- a/reference/event/event/del.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - Event::del - Makes event non-pending - - - &reftitle.description; - - public - bool - Event::del - - - - Removes an event from the set of monitored events, i.e. makes it - non-pending. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - Event::add - - - - - diff --git a/reference/event/event/delsignal.xml b/reference/event/event/delsignal.xml deleted file mode 100644 index 0a4eca0a1ad6..000000000000 --- a/reference/event/event/delsignal.xml +++ /dev/null @@ -1,35 +0,0 @@ - - - - - Event::delSignal - &Alias; Event::del - - - - &reftitle.description; - - &info.method.alias; Event::del - - - - diff --git a/reference/event/event/deltimer.xml b/reference/event/event/deltimer.xml deleted file mode 100644 index d4729f545b7c..000000000000 --- a/reference/event/event/deltimer.xml +++ /dev/null @@ -1,35 +0,0 @@ - - - - - Event::delTimer - &Alias; Event::del - - - - &reftitle.description; - - &info.method.alias; Event::del - - - - diff --git a/reference/event/event/free.xml b/reference/event/event/free.xml deleted file mode 100644 index f365fb31d7fe..000000000000 --- a/reference/event/event/free.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - Event::free - Make event non-pending and free resources allocated for this - event - - - &reftitle.description; - - public - void - Event::free - - - - Removes event from the list of events monitored by libevent, and free - resources allocated for the event. - - - - The - Event::free - method currently doesn't destruct the object itself. To destruct the - object completely call - unset, - or assign &null;. - - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - Event::__construct - - - - - diff --git a/reference/event/event/getsupportedmethods.xml b/reference/event/event/getsupportedmethods.xml deleted file mode 100644 index a417247bd4a3..000000000000 --- a/reference/event/event/getsupportedmethods.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - Event::getSupportedMethods - Returns array of the names of the methods supported in this version of Libevent - - - &reftitle.description; - - public - static - array - Event::getSupportedMethods - - - - Returns array of the names of the methods(backends) supported in this - version of Libevent. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Returns array. - - - - &reftitle.seealso; - - - EventConfig - - - - - diff --git a/reference/event/event/pending.xml b/reference/event/event/pending.xml deleted file mode 100644 index a3e811a4f93d..000000000000 --- a/reference/event/event/pending.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - Event::pending - Detects whether event is pending or scheduled - - - &reftitle.description; - - public - bool - Event::pending - - int - flags - - - - Detects whether event is pending or scheduled - - - - &reftitle.parameters; - - - - flags - - - - One of, or a composition of the following constants: - Event::READ, - Event::WRITE, - Event::TIMEOUT, - Event::SIGNAL. - - - - - - - &reftitle.returnvalues; - - Returns &true; if event is pending or scheduled. Otherwise &false;. - - - - diff --git a/reference/event/event/set.xml b/reference/event/event/set.xml deleted file mode 100644 index b52ffb25b29d..000000000000 --- a/reference/event/event/set.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - Event::set - Re-configures event - - - &reftitle.description; - - public - bool - Event::set - - EventBase - base - - - mixed - fd - - - int - what - - - callable - cb - - - mixed - arg - - - - Re-configures event. Note, this function doesn't invoke obsolete libevent's - event_set. It calls event_assign instead. - - - - &reftitle.parameters; - - - - base - - - - The event base to associate the event with. - - - - - - fd - - - - Stream resource, socket resource, or numeric file descriptor. For timer - events pass - -1. - For signal events pass the signal number, e.g. - SIGHUP. - - - - - - what - - - - See - Event flags. - - - - - - cb - - - - The event callback. See - Event callbacks. - - - - - - arg - - - - Custom data associated with the event. It will be passed to the callback - when the event becomes active. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/event/event/setpriority.xml b/reference/event/event/setpriority.xml deleted file mode 100644 index 8de04b48c628..000000000000 --- a/reference/event/event/setpriority.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - Event::setPriority - Set event priority - - - &reftitle.description; - - public - bool - Event::setPriority - - int - priority - - - - Set event priority. - - - - &reftitle.parameters; - - - - priority - - - - The event priority. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/event/event/settimer.xml b/reference/event/event/settimer.xml deleted file mode 100644 index 3083fef92e1f..000000000000 --- a/reference/event/event/settimer.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - Event::setTimer - Re-configures timer event - - - &reftitle.description; - - public - bool - Event::setTimer - - EventBase - base - - - callable - cb - - - mixed - arg - - - - Re-configures timer event. Note, this function doesn't invoke obsolete - libevent's - event_set. - It calls - event_assign - instead. - - - - &reftitle.parameters; - - - - base - - - - The event base to associate with. - - - - - - cb - - - - The timer event callback. See - Event callbacks. - - - - - - arg - - - - Custom data. If specified, it will be passed to the callback when event - triggers. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - Event::__construct - - - Event::timer - - - - - diff --git a/reference/event/event/signal.xml b/reference/event/event/signal.xml deleted file mode 100644 index 62b101a780a1..000000000000 --- a/reference/event/event/signal.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - Event::signal - Constructs signal event object - - - &reftitle.description; - - public - static - Event - Event::signal - - EventBase - base - - - int - signum - - - callable - cb - - - mixed - arg - - - - Constructs signal event object. This is a straightforward method to create - a signal event. Note, the generic - Event::__construct - method can contruct signal event objects too. - - - - &reftitle.parameters; - - - - base - - - - The associated event base object. - - - - - - signum - - - - The signal number. - - - - - - cb - - - - The signal event callback. See - Event callbacks. - - - - - - arg - - - - Custom data. If specified, it will be passed to the callback when event - triggers. - - - - - - - &reftitle.returnvalues; - - Returns Event object on success. Otherwise &false;. - - - - &reftitle.seealso; - - - Constructing signal events - - - - - diff --git a/reference/event/event/timer.xml b/reference/event/event/timer.xml deleted file mode 100644 index d9e64bd10d30..000000000000 --- a/reference/event/event/timer.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - Event::timer - Constructs timer event object - - - &reftitle.description; - - public - static - Event - Event::timer - - EventBase - base - - - callable - cb - - - mixed - arg - - - - Constructs timer event object. This is a straightforward method to create a - timer event. Note, the generic - Event::__construct - method can contruct signal event objects too. - - - - &reftitle.parameters; - - - - base - - - - The associated event base object. - - - - - - cb - - - - The signal event callback. See - Event callbacks. - - - - - - arg - - - - Custom data. If specified, it will be passed to the callback when event - triggers. - - - - - - - &reftitle.returnvalues; - - Returns Event object on success. Otherwise &false;. - - - - diff --git a/reference/event/eventbase.xml b/reference/event/eventbase.xml deleted file mode 100644 index 22c979b7aa26..000000000000 --- a/reference/event/eventbase.xml +++ /dev/null @@ -1,228 +0,0 @@ - - - - The EventBase class - EventBase - - -
- &reftitle.intro; - - EventBase - class represents libevent's event base structure. It holds a set of events - and can poll to determine which events are active. - - - Each event base has a - method, - or a - backend - that it uses to determine which events are ready. The recognized methods - are: - select, - poll, - epoll, - kqueue, - devpoll, - evport - and - win32. - - - To configure event base to use, or avoid specific backend - EventConfig - class can be used. - - - - Do - NOT - destroy the - EventBase - object as long as resources of the associated - Event - objects are not released. Otherwise, it will lead to unpredictable - results! - - -
- -
- &reftitle.classsynopsis; - - - - - EventBase - - - - - final - EventBase - - - - &Constants; - - const - int - EventBase::LOOP_ONCE - 1 - - - const - int - EventBase::LOOP_NONBLOCK - 2 - - - const - int - EventBase::NOLOCK - 1 - - - const - int - EventBase::STARTUP_IOCP - 4 - - - const - int - EventBase::NO_CACHE_TIME - 8 - - - const - int - EventBase::EPOLL_USE_CHANGELIST - 16 - - &Methods; - - - -
- -
- &reftitle.constants; - - - - EventBase::LOOP_ONCE - - - - Flag used with - EventBase::loop - method which means: "block until libevent has an active event, then - exit once all active events have had their callbacks run". - - - - - - EventBase::LOOP_NONBLOCK - - - - Flag used with - EventBase::loop - method which means: "do not block: see which events are ready now, run - the callbacks of the highest-priority ones, then exit". - - - - - - EventBase::NOLOCK - - - - Configuration flag. Do not allocate a lock for the event base, even if - we have locking set up". - - - - - - EventBase::STARTUP_IOCP - - - - Windows-only configuration flag. Enables the IOCP dispatcher at - startup. - - - - - - EventBase::NO_CACHE_TIME - - - - Configuration flag. Instead of checking the current time every time the - event loop is ready to run timeout callbacks, check after each timeout - callback. - - - - - - EventBase::EPOLL_USE_CHANGELIST - - - - If we are using the - epoll - backend, this flag says that it is safe to use Libevent's internal - change-list code to batch up adds and deletes in order to try to do as - few syscalls as possible. - - - Setting this flag can make code run faster, but it may trigger a Linux - bug: it is not safe to use this flag if one has any fds cloned by - dup(), or its variants. Doing so will produce strange and - hard-to-diagnose bugs. - - - This flag can also be activated by setting the - EVENT_EPOLL_USE_CHANGELIST - environment variable. - - - This flag has no effect if one winds up using a backend other than - epoll. - - - - -
- -
- - &reference.event.entities.eventbase; - -
- diff --git a/reference/event/eventbase/construct.xml b/reference/event/eventbase/construct.xml deleted file mode 100644 index 6cdb680e2ba7..000000000000 --- a/reference/event/eventbase/construct.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - EventBase::__construct - Constructs EventBase object - - - &reftitle.description; - - public - EventBase::__construct - - EventConfig - cfg - - - - Constructs EventBase object - - - - &reftitle.parameters; - - - - cfg - - - - Optional - EventConfig - object. - - - - - - - &reftitle.errors; - - If EventBase cannot be constructed with the provided configuration, - a EventException will be thrown. - - - - &reftitle.seealso; - - - EventConfig - - - - - diff --git a/reference/event/eventbase/dispatch.xml b/reference/event/eventbase/dispatch.xml deleted file mode 100644 index bce4be7b960f..000000000000 --- a/reference/event/eventbase/dispatch.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - EventBase::dispatch - Dispatch pending events - - - &reftitle.description; - - public - void - EventBase::dispatch - - - - Wait for events to become active, and run their callbacks. The same as - EventBase::loop - with no flags set. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBase::loop - - - - - diff --git a/reference/event/eventbase/exit.xml b/reference/event/eventbase/exit.xml deleted file mode 100644 index ef05e72fe052..000000000000 --- a/reference/event/eventbase/exit.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - EventBase::exit - Stop dispatching events - - - &reftitle.description; - - public - bool - EventBase::exit - - float - timeout - - - - Tells event base to stop optionally after given number of seconds. - - - - &reftitle.parameters; - - - - timeout - - - - Optional number of seconds after which the event base should stop - dispatching events. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBase::stop - - - - - diff --git a/reference/event/eventbase/free.xml b/reference/event/eventbase/free.xml deleted file mode 100644 index 21b8284e0694..000000000000 --- a/reference/event/eventbase/free.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - EventBase::free - Free resources allocated for this event base - - - &reftitle.description; - - public - void - EventBase::free - - - - Deallocates resources allocated by libevent for the EventBase object. - - - - The - EventBase::free - method doesn't destruct the object itself. To destruct the - object completely call - unset, - or assign &null;. - - - This method does not deallocate or detach any of the events that are - currently associated with the EventBase object, or - close any of their sockets - beware. - - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EventBase::__construct - - - - - diff --git a/reference/event/eventbase/getfeatures.xml b/reference/event/eventbase/getfeatures.xml deleted file mode 100644 index 9824e6fddc08..000000000000 --- a/reference/event/eventbase/getfeatures.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - EventBase::getFeatures - Returns bitmask of features supported - - - &reftitle.description; - - public - int - EventBase::getFeatures - - - - Returns bitmask of features supported. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Returns integer representing a bitmask of supported features. See - EventConfig::FEATURE_* constants. - - - - &reftitle.examples; - - - <function>EventBase::getFeatures</function> example - -avoidMethod("select")) { - echo "'select' method avoided\n"; -} - -$base = new EventBase($cfg); - -echo "Features:\n"; -$features = $base->getFeatures(); -($features & EventConfig::FEATURE_ET) and print "ET - edge-triggered IO\n"; -($features & EventConfig::FEATURE_O1) and print "O1 - O(1) operation for adding/deleting events\n"; -($features & EventConfig::FEATURE_FDS) and print "FDS - arbitrary file descriptor types, and not just sockets\n"; -?> -]]> - - - - - &reftitle.seealso; - - - EventBase::getMethod - - - EventConfig - - - - - diff --git a/reference/event/eventbase/getmethod.xml b/reference/event/eventbase/getmethod.xml deleted file mode 100644 index 85ba6882751d..000000000000 --- a/reference/event/eventbase/getmethod.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - EventBase::getMethod - Returns event method in use - - - &reftitle.description; - - public - string - EventBase::getMethod - - - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - String representing used event method(backend). - - - - &reftitle.examples; - - - <function>EventBase::getMethod</function> example - -avoidMethod("select")) { - echo "'select' method avoided\n"; -} - -// Create event_base associated with the config -$base = new EventBase($cfg); -echo "Event method used: ", $base->getMethod(), PHP_EOL; - -?> -]]> - - &example.outputs.similar; - - - - - - - &reftitle.seealso; - - - EventBase::getFeatures - - - - - diff --git a/reference/event/eventbase/gettimeofdaycached.xml b/reference/event/eventbase/gettimeofdaycached.xml deleted file mode 100644 index 30e0638f7a32..000000000000 --- a/reference/event/eventbase/gettimeofdaycached.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - EventBase::getTimeOfDayCached - Returns the current event base time - - - &reftitle.description; - - public - float - EventBase::getTimeOfDayCached - - - - On success returns the current time(as returned by - gettimeofday() - ), looking at the cached value in - base - if possible, and calling - gettimeofday() - or - clock_gettime() - as appropriate if there is no cached time. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Returns the current - event base - time. On failure returns &null;. - - - - diff --git a/reference/event/eventbase/gotexit.xml b/reference/event/eventbase/gotexit.xml deleted file mode 100644 index b5caa3053e16..000000000000 --- a/reference/event/eventbase/gotexit.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - EventBase::gotExit - Checks if the event loop was told to exit - - - &reftitle.description; - - public - bool - EventBase::gotExit - - - - Checks if the event loop was told to exit by - EventBase::exit. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Returns &true;, event loop was told to exit by - EventBase::exit. - Otherwise &false;. - - - - &reftitle.seealso; - - - EventBase::exit - - - EventBase::stop - - - EventBase::gotStop - - - - - diff --git a/reference/event/eventbase/gotstop.xml b/reference/event/eventbase/gotstop.xml deleted file mode 100644 index 3a58c448558c..000000000000 --- a/reference/event/eventbase/gotstop.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - EventBase::gotStop - Checks if the event loop was told to exit - - - &reftitle.description; - - public - bool - EventBase::gotStop - - - - Checks if the event loop was told to exit by - EventBase::stop. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Returns &true;, event loop was told to stop by - EventBase::stop. - Otherwise &false;. - - - - &reftitle.seealso; - - - EventBase::exit - - - EventBase::stop - - - EventBase::gotExit - - - - - diff --git a/reference/event/eventbase/loop.xml b/reference/event/eventbase/loop.xml deleted file mode 100644 index 99c97aac5958..000000000000 --- a/reference/event/eventbase/loop.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - EventBase::loop - Dispatch pending events - - - &reftitle.description; - - public - bool - EventBase::loop - - int - flags - - - - Wait for events to become active, and run their callbacks. - - - - - - - &reftitle.parameters; - - - - flags - - - - Optional flags. One of - EventBase::LOOP_* - constants. See - EventBase constants. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBase::dispatch - - - - - diff --git a/reference/event/eventbase/priorityinit.xml b/reference/event/eventbase/priorityinit.xml deleted file mode 100644 index 466f0e408a6e..000000000000 --- a/reference/event/eventbase/priorityinit.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - EventBase::priorityInit - Sets number of priorities per event base - - - &reftitle.description; - - public - bool - EventBase::priorityInit - - int - n_priorities - - - - Sets number of priorities per event base. - - - - &reftitle.parameters; - - - - n_priorities - - - - The number of priorities per event base. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - Event::setPriority - - - - - diff --git a/reference/event/eventbase/reinit.xml b/reference/event/eventbase/reinit.xml deleted file mode 100644 index ddbb9f80830f..000000000000 --- a/reference/event/eventbase/reinit.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - EventBase::reInit - Re-initialize event base(after a fork) - - - &reftitle.description; - - public - bool - EventBase::reInit - - - - Re-initialize event base. Should be called after a fork. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/event/eventbase/stop.xml b/reference/event/eventbase/stop.xml deleted file mode 100644 index b466e9e4928f..000000000000 --- a/reference/event/eventbase/stop.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - EventBase::stop - Tells event_base to stop dispatching events - - - &reftitle.description; - - public - bool - EventBase::stop - - - - Tells event_base to stop dispatching events - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBase::exit - - - EventBase::gotStop - - - - - diff --git a/reference/event/eventbuffer.xml b/reference/event/eventbuffer.xml deleted file mode 100644 index 1b4c35c41880..000000000000 --- a/reference/event/eventbuffer.xml +++ /dev/null @@ -1,242 +0,0 @@ - - - - The EventBuffer class - EventBuffer - - -
- &reftitle.intro; - - EventBuffer - represents Libevent's "evbuffer", an utility functionality for buffered - I/O. - - - Event buffers are meant to be generally useful for doing the "buffer" part - of buffered network I/O. - -
- -
- &reftitle.classsynopsis; - - - - - EventBuffer - - - - - EventBuffer - - - - &Constants; - - const - int - EventBuffer::EOL_ANY - 0 - - - const - int - EventBuffer::EOL_CRLF - 1 - - - const - int - EventBuffer::EOL_CRLF_STRICT - 2 - - - const - int - EventBuffer::EOL_LF - 3 - - - const - int - EventBuffer::PTR_SET - 0 - - - const - int - EventBuffer::PTR_ADD - 1 - - &Properties; - - public - readonly - int - length - - - public - readonly - int - contiguous_space - - &Methods; - - - -
- -
- &reftitle.properties; - - - - length - - - - The number of bytes stored in an event buffer. - - - - - - contiguous_space - - - - The number of bytes stored contiguously at the front of the buffer. The - bytes in a buffer may be stored in multiple separate chunks of memory; - the property returns the number of bytes currently stored in the first - chunk. - - - - -
- - -
- &reftitle.constants; - - - - EventBuffer::EOL_ANY - - - - The end of line is any sequence of any number of carriage return and - linefeed characters. This format is not very useful; it exists mainly - for backward compatibility. - - - - - - EventBuffer::EOL_CRLF - - - - The end of the line is an optional carriage return, followed by a - linefeed. (In other words, it is either a - "\r\n" - or a - "\n" - .) This format is useful in parsing text-based Internet protocols, - since the standards generally prescribe a - "\r\n" - line-terminator, but nonconformant clients sometimes say just - "\n". - - - - - - EventBuffer::EOL_CRLF_STRICT - - - - The end of a line is a single carriage return, followed by a single - linefeed. (This is also known as - "\r\n". - The ASCII values are - 0x0D - 0x0A - ). - - - - - - EventBuffer::EOL_LF - - - - The end of a line is a single linefeed character. (This is also known - as - "\n". - It is ASCII value is - 0x0A - .) - - - - - - EventBuffer::PTR_SET - - - - Flag used as argument of - EventBuffer::setPosition - method. If this flag specified, the position pointer is moved to an - absolute position within the buffer. - - - - - - EventBuffer::PTR_ADD - - - - The same as - EventBuffer::PTR_SET, - except this flag causes - EventBuffer::setPosition - method to move position forward up to the specified number of - bytes(instead of setting absolute position). - - - - -
- -
- - &reference.event.entities.eventbuffer; - -
- diff --git a/reference/event/eventbuffer/add.xml b/reference/event/eventbuffer/add.xml deleted file mode 100644 index ac232c362dce..000000000000 --- a/reference/event/eventbuffer/add.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - EventBuffer::add - Append data to the end of an event buffer - - - &reftitle.description; - - public - bool - EventBuffer::add - - string - data - - - - Append data to the end of an event buffer. - - - - &reftitle.parameters; - - - - data - - - - String to be appended to the end of the buffer. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBuffer::addBuffer - - - - - diff --git a/reference/event/eventbuffer/addbuffer.xml b/reference/event/eventbuffer/addbuffer.xml deleted file mode 100644 index bb0b8caf4cd5..000000000000 --- a/reference/event/eventbuffer/addbuffer.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - EventBuffer::addBuffer - Move all data from a buffer provided to the current instance of EventBuffer - - - &reftitle.description; - - public - bool - EventBuffer::addBuffer - - EventBuffer - buf - - - - Move all data from the buffer provided in - buf - parameter to the end of current - EventBuffer. - This is a destructive add. The data from one buffer moves into the other - buffer. However, no unnecessary memory copies occur. - - - - &reftitle.parameters; - - - - buf - - - - The source EventBuffer object. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBuffer::add - - - - - diff --git a/reference/event/eventbuffer/appendfrom.xml b/reference/event/eventbuffer/appendfrom.xml deleted file mode 100644 index f3792ee9cc66..000000000000 --- a/reference/event/eventbuffer/appendfrom.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - EventBuffer::appendFrom - Moves the specified number of bytes from a source buffer to the - end of the current buffer - - - &reftitle.description; - - public - int - EventBuffer::appendFrom - - EventBuffer - buf - - - int - len - - - - Moves the specified number of bytes from a source buffer to the end of the - current buffer. If there are fewer number of bytes, it moves all the bytes - available from the source buffer. - - - - &reftitle.parameters; - - - - buf - - - - Source buffer. - - - - - - len - - - - - - - - - &reftitle.returnvalues; - - Returns the number of bytes read. - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL event 1.6.0 - - Renamed EventBuffer::appendFrom(the old - method name) to EventBuffer::appendFrom. - - - - - - - - &reftitle.seealso; - - - EventBuffer::copyout - - - EventBuffer::drain - - - EventBuffer::pullup - - - EventBuffer::readLine - - - EventBuffer::read - - - - - diff --git a/reference/event/eventbuffer/construct.xml b/reference/event/eventbuffer/construct.xml deleted file mode 100644 index d8d5c6318bc0..000000000000 --- a/reference/event/eventbuffer/construct.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - EventBuffer::__construct - Constructs EventBuffer object - - - &reftitle.description; - - public - EventBuffer::__construct - - - - Constructs EventBuffer object - - - - &reftitle.parameters; - &no.function.parameters; - - - diff --git a/reference/event/eventbuffer/copyout.xml b/reference/event/eventbuffer/copyout.xml deleted file mode 100644 index 5b440c52d192..000000000000 --- a/reference/event/eventbuffer/copyout.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - EventBuffer::copyout - Copies out specified number of bytes from the front of the buffer - - - &reftitle.description; - - public - int - EventBuffer::copyout - - string - data - - - int - max_bytes - - - - Behaves just like - EventBuffer::read, - but does not drain any data from the buffer. I.e. it copies the first - max_bytes - bytes from the front of the buffer into - data. - If there are fewer than - max_bytes - bytes available, the function copies all the bytes there are. - - - - &reftitle.parameters; - - - - data - - - - Output string. - - - - - - max_bytes - - - - The number of bytes to copy. - - - - - - - &reftitle.returnvalues; - - Returns the number of bytes copied, or - -1 - on failure. - - - - &reftitle.seealso; - - - EventBuffer::read - - - EventBuffer::appendFrom - - - - - diff --git a/reference/event/eventbuffer/drain.xml b/reference/event/eventbuffer/drain.xml deleted file mode 100644 index beb303590a91..000000000000 --- a/reference/event/eventbuffer/drain.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - EventBuffer::drain - Removes specified number of bytes from the front of the buffer - without copying it anywhere - - - &reftitle.description; - - public - bool - EventBuffer::drain - - int - len - - - - Behaves as - EventBuffer::read, - except that it does not copy the data: it just removes it from the front - of the buffer. - - - - &reftitle.parameters; - - - - len - - - - The number of bytes to remove from the buffer. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBuffer::read - - - EventBuffer::appendFrom - - - - - diff --git a/reference/event/eventbuffer/enablelocking.xml b/reference/event/eventbuffer/enablelocking.xml deleted file mode 100644 index 3aa585455612..000000000000 --- a/reference/event/eventbuffer/enablelocking.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - EventBuffer::enableLocking - - - - &reftitle.description; - - public - void - EventBuffer::enableLocking - - - - Enable locking on an - EventBuffer - so that it can safely be used by multiple threads at the same time. When - locking is enabled, the lock will be held when callbacks are invoked. This - could result in deadlock if you aren't careful. Plan accordingly! - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - Evbuffers and Thread-safety - - - - - diff --git a/reference/event/eventbuffer/expand.xml b/reference/event/eventbuffer/expand.xml deleted file mode 100644 index e0fcec65e836..000000000000 --- a/reference/event/eventbuffer/expand.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - EventBuffer::expand - Reserves space in buffer - - - &reftitle.description; - - public - bool - EventBuffer::expand - - int - len - - - - Alters the last chunk of memory in the buffer, or adds a new chunk, such - that the buffer is now large enough to contain - len - bytes without any further allocations. - - - - &reftitle.parameters; - - - - len - - - - The number of bytes to reserve for the buffer - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/event/eventbuffer/freeze.xml b/reference/event/eventbuffer/freeze.xml deleted file mode 100644 index d93a0470515f..000000000000 --- a/reference/event/eventbuffer/freeze.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - EventBuffer::freeze - Prevent calls that modify an event buffer from succeeding - - - &reftitle.description; - - public - bool - EventBuffer::freeze - - bool - at_front - - - - Prevent calls that modify an event buffer from succeeding - - - - &reftitle.parameters; - - - - at_front - - - - Whether to disable changes to the front or end of the buffer. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBuffer::unfreeze - - - - - diff --git a/reference/event/eventbuffer/lock.xml b/reference/event/eventbuffer/lock.xml deleted file mode 100644 index ecb65671f986..000000000000 --- a/reference/event/eventbuffer/lock.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - EventBuffer::lock - Acquires a lock on buffer - - - &reftitle.description; - - public - void - EventBuffer::lock - - - - Acquires a lock on buffer. Can be used in pair with - EventBuffer::unlock - to make a set of operations atomic, i.e. thread-safe. Note, it is not - needed to lock buffers for - individual - operations. When locking is enabled(see - EventBuffer::enableLocking - ), individual operations on event buffers are already atomic. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EventBuffer::unlock - - - - - diff --git a/reference/event/eventbuffer/prepend.xml b/reference/event/eventbuffer/prepend.xml deleted file mode 100644 index 5984c6d07352..000000000000 --- a/reference/event/eventbuffer/prepend.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - EventBuffer::prepend - Prepend data to the front of the buffer - - - &reftitle.description; - - public - bool - EventBuffer::prepend - - string - data - - - - Prepend data to the front of the buffer. - - - - &reftitle.parameters; - - - - data - - - - String to be prepended to the front of the buffer. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBuffer::prependBuffer - - - EventBuffer::add - - - EventBuffer::addBuffer - - - - - diff --git a/reference/event/eventbuffer/prependbuffer.xml b/reference/event/eventbuffer/prependbuffer.xml deleted file mode 100644 index 17729d86341a..000000000000 --- a/reference/event/eventbuffer/prependbuffer.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - EventBuffer::prependBuffer - Moves all data from source buffer to the front of current buffer - - - &reftitle.description; - - public - bool - EventBuffer::prependBuffer - - EventBuffer - buf - - - - Behaves as - EventBuffer::addBuffer, - except that it moves data to the front of the buffer. - - - - &reftitle.parameters; - - - - buf - - - - Source buffer. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBuffer::add - - - EventBuffer::addBuffer - - - EventBuffer::prepend - - - - - diff --git a/reference/event/eventbuffer/pullup.xml b/reference/event/eventbuffer/pullup.xml deleted file mode 100644 index b6053e5acc50..000000000000 --- a/reference/event/eventbuffer/pullup.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - EventBuffer::pullup - Linearizes data within buffer - and returns its contents as a string - - - &reftitle.description; - - public - string - EventBuffer::pullup - - int - size - - - - "Linearizes" the first - size - bytes of the buffer, copying or moving them as needed to ensure that they - are all contiguous and occupying the same chunk of memory. If size is - negative, the function linearizes the entire buffer. - - - - Calling - EventBuffer::pullup - with a large size can be quite slow, since it potentially needs to copy - the entire buffer's contents. - - - - - &reftitle.parameters; - - - - size - - - - The number of bytes required to be contiguous within the buffer. - - - - - - - &reftitle.returnvalues; - - If - size - is greater than the number of bytes in the buffer, the function returns - &null;. Otherwise, - EventBuffer::pullup - returns string. - - - - &reftitle.seealso; - - - EventBuffer::copyout - - - EventBuffer::drain - - - EventBuffer::read - - - EventBuffer::readLine - - - EventBuffer::appendFrom - - - - - diff --git a/reference/event/eventbuffer/read.xml b/reference/event/eventbuffer/read.xml deleted file mode 100644 index c1ea5482ead4..000000000000 --- a/reference/event/eventbuffer/read.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - EventBuffer::read - Read data from an evbuffer and drain the bytes read - - - &reftitle.description; - - public - string - EventBuffer::read - - int - max_bytes - - - - Read the first - max_bytes - from the buffer and drain the bytes read. If more - max_bytes - are requested than are available in the buffer, it only extracts as many - bytes as available. - - - - &reftitle.parameters; - - - - max_bytes - - - - Maximum number of bytes to read from the buffer. - - - - - - - &reftitle.returnvalues; - - Returns string read, or &false; on failure. - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL event 1.6.0 - - Renamed EventBuffer::read(the old method - name) to EventBuffer::read. - EventBuffer::read now takes only - max_bytes argument; returns string instead of - integer. - - - - - - - - &reftitle.seealso; - - - EventBuffer::copyout - - - EventBuffer::drain - - - EventBuffer::pullup - - - EventBuffer::readLine - - - EventBuffer::appendFrom - - - - - diff --git a/reference/event/eventbuffer/readfrom.xml b/reference/event/eventbuffer/readfrom.xml deleted file mode 100644 index 5c07316f2ded..000000000000 --- a/reference/event/eventbuffer/readfrom.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - EventBuffer::readFrom - Read data from a file onto the end of the buffer - - - &reftitle.description; - - public - int - EventBuffer::read - - mixed - fd - - - int - howmuch - - - - Read data from the file specified by - fd - onto the end of the buffer. - - - - &reftitle.parameters; - - - - fd - - - - Socket resource, stream, or numeric file descriptor. - - - - - - howmuch - - - - Maximum number of bytes to read. - - - - - - - &reftitle.returnvalues; - - Returns the number of bytes read, or &false; on failure. - - - - &reftitle.seealso; - - - EventBuffer::copyout - - - EventBuffer::drain - - - EventBuffer::pullup - - - EventBuffer::readLine - - - EventBuffer::appendFrom - - - - - diff --git a/reference/event/eventbuffer/readline.xml b/reference/event/eventbuffer/readline.xml deleted file mode 100644 index c953eaf20052..000000000000 --- a/reference/event/eventbuffer/readline.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - EventBuffer::readLine - Extracts a line from the front of the buffer - - - &reftitle.description; - - public - string - EventBuffer::readLine - - int - eol_style - - - - Extracts a line from the front of the buffer and returns it in a newly - allocated string. If there is not a whole line to read, the function - returns &null;. The line terminator is not included in the copied string. - - - - &reftitle.parameters; - - - - eol_style - - - - One of - EventBuffer:EOL_* constants. - - - - - - - &reftitle.returnvalues; - - On success returns the line read from the buffer, otherwise &null;. - - - - &reftitle.seealso; - - - EventBuffer::copyout - - - EventBuffer::drain - - - EventBuffer::pullup - - - EventBuffer::read - - - EventBuffer::appendFrom - - - - - diff --git a/reference/event/eventbuffer/search.xml b/reference/event/eventbuffer/search.xml deleted file mode 100644 index 844e3f8b3757..000000000000 --- a/reference/event/eventbuffer/search.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - EventBuffer::search - Scans the buffer for an occurrence of a string - - - &reftitle.description; - - public - mixed - EventBuffer::search - - string - what - - - int - start - -1 - - - int - end - -1 - - - - Scans the buffer for an occurrence of the string - what. - It returns numeric position of the string, or &false; if the string was - not found. - - - If the - start - argument is provided, it points to the position at which the search should - begin; otherwise, the search is performed from the start of the string. If - end - argument provided, the search is performed between start and end buffer - positions. - - - - &reftitle.parameters; - - - - what - - - - String to search. - - - - - - start - - - - Start search position. - - - - - - end - - - - End search position. - - - - - - - &reftitle.returnvalues; - - Returns numeric position of the first occurrence of the string in the - buffer, or &false; if string is not found. - - &return.falseproblem; - - - &reftitle.examples; - - - <function>EventBuffer::search</function> example - -search($str, $p); - if ($p === FALSE) { - break; - } - ++$total; - ++$p; - } - - return $total; -} - -$buf = new EventBuffer(); -$buf->add("Some string within a string inside another string"); -var_dump(count_instances($buf, "str")); -?> -]]> - - &example.outputs.similar; - - - - - - - &reftitle.seealso; - - - EventBuffer::searchEol - - - - - diff --git a/reference/event/eventbuffer/searcheol.xml b/reference/event/eventbuffer/searcheol.xml deleted file mode 100644 index 9493f4fd0eaa..000000000000 --- a/reference/event/eventbuffer/searcheol.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - EventBuffer::searchEol - Scans the buffer for an occurrence of an end of line - - - &reftitle.description; - - public - mixed - EventBuffer::searchEol - - int - start - -1 - - - int - eol_style - - EventBuffer::EOL_ANY - - - - - Scans the buffer for an occurrence of an end of line specified by - eol_style - parameter . It returns numeric position of the string, or &false; if the - string was not found. - - - If the - start - argument is provided, it represents the position at which the search should - begin; otherwise, the search is performed from the start of the string. If - end - argument provided, the search is performed between start and end buffer - positions. - - - - &reftitle.parameters; - - - - start - - - - Start search position. - - - - - - eol_style - - - - One of - EventBuffer:EOL_* constants. - - - - - - - &reftitle.returnvalues; - - Returns numeric position of the first occurrence of end-of-line symbol in - the buffer, or &false; if not found. - - &return.falseproblem; - - - &reftitle.seealso; - - - EventBuffer::search - - - - - diff --git a/reference/event/eventbuffer/substr.xml b/reference/event/eventbuffer/substr.xml deleted file mode 100644 index 0516b8f89a85..000000000000 --- a/reference/event/eventbuffer/substr.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - EventBuffer::substr - Subtracts a portion of the buffer data - - - &reftitle.description; - - public - string - EventBuffer::substr - - int - start - - - int - length - - - - Subtracts up to - length - bytes of the buffer data beginning at - start - position. - - - - &reftitle.parameters; - - - - start - - - - The start position of data to be subtracted. - - - - - - length - - - - Maximum number of bytes to subtract. - - - - - - - &reftitle.returnvalues; - - Returns the data subtracted as a - string - on success, or &false; on failure. - - - - &reftitle.seealso; - - - EventBuffer::read - - - - - diff --git a/reference/event/eventbuffer/unfreeze.xml b/reference/event/eventbuffer/unfreeze.xml deleted file mode 100644 index 4e09c071e39f..000000000000 --- a/reference/event/eventbuffer/unfreeze.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - EventBuffer::unfreeze - Re-enable calls that modify an event buffer - - - &reftitle.description; - - public - bool - EventBuffer::unfreeze - - bool - at_front - - - - Re-enable calls that modify an event buffer. - - - - &reftitle.parameters; - - - - at_front - - - - Whether to enable events at the front or at the end of the buffer. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBuffer::freeze - - - - - diff --git a/reference/event/eventbuffer/unlock.xml b/reference/event/eventbuffer/unlock.xml deleted file mode 100644 index fdbc74a61f2c..000000000000 --- a/reference/event/eventbuffer/unlock.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - EventBuffer::unlock - Releases lock acquired by EventBuffer::lock - - - &reftitle.description; - - public - bool - EventBuffer::unlock - - - - Releases lock acquired by - EventBuffer::lock. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBuffer::lock - - - - - diff --git a/reference/event/eventbuffer/write.xml b/reference/event/eventbuffer/write.xml deleted file mode 100644 index f003ca65cc2f..000000000000 --- a/reference/event/eventbuffer/write.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - EventBuffer::write - Write contents of the buffer to a file or socket - - - &reftitle.description; - - public - int - EventBuffer::write - - mixed - fd - - - int - howmuch - - - - Write contents of the buffer to a file descriptor. The buffer will be - drained after the bytes have been successfully written. - - - - &reftitle.parameters; - - - - fd - - - - Socket resource, stream or numeric file descriptor normally - associated with a socket. - - - - - - howmuch - - - - The maximum number of bytes to write. - - - - - - - &reftitle.returnvalues; - - Returns the number of bytes written, or &false; on error. - - - - &reftitle.seealso; - - - EventBuffer::read - - - - - diff --git a/reference/event/eventbufferevent.about.callbacks.xml b/reference/event/eventbufferevent.about.callbacks.xml deleted file mode 100644 index 5ef366d328e0..000000000000 --- a/reference/event/eventbufferevent.about.callbacks.xml +++ /dev/null @@ -1,147 +0,0 @@ - - - - About buffer event callbacks - - An object of - EventBufferEvent - class represents a - buffer event. - The asynchronous nature of I/O performed by Libevent implies that a - socket(or other kind of file descriptor) is not always available. Event - invokes corresponding callbacks when the resource becomes available for - reading or writing, or when some event occurs(e.g. error, "end of line" - etc.). - - - Read and write callbacks should match the following prototype: - - - void - callback - - EventBufferEvent - bev - &null; - - - mixed - arg - &null; - - - - - - bev - - - - Associated - EventBufferEvent - object. - - - - - - arg - - - - Custom variable attached to all callbacks via - EventBufferEvent::__construct, - or - EventBufferEvent::setCallbacks. - - - - - - Event callback should match the following prototype: - - - void - callback - - EventBufferEvent - bev - &null; - - - int - events - 0 - - - mixed - arg - &null; - - - - - - bev - - - - Associated - EventBufferEvent - object. - - - - - - events - - - - Bit mask of events: - EventBufferEvent::READING, - EventBufferEvent::WRITING, - EventBufferEvent::EOL, - EventBufferEvent::ERROR - and - EventBufferEvent::TIMEOUT. - See - EventBufferEvent constants - - - - - - arg - - - - Custom variable attached to all callbacks via - EventBufferEvent::__construct, - or - EventBufferEvent::setCallbacks. - - - - - - diff --git a/reference/event/eventbufferevent.xml b/reference/event/eventbufferevent.xml deleted file mode 100644 index 02696f7f462c..000000000000 --- a/reference/event/eventbufferevent.xml +++ /dev/null @@ -1,399 +0,0 @@ - - - - The EventBufferEvent class - EventBufferEvent - - -
- &reftitle.intro; - - Represents Libevent's buffer event. - - - Usually an application wants to perform some amount of data buffering in - addition to just responding to events. When we want to write data, for - example, the usual pattern looks like: - - - - - Decide that we want to write some data to a connection; put that data in - a buffer. - - - - - Wait for the connection to become writable - - - - - Write as much of the data as we can - - - - - Remember how much we wrote, and if we still have more data to write, - wait for the connection to become writable again. - - - - - This buffered I/O pattern is common enough that Libevent provides a - generic mechanism for it. A "buffer event" consists of an underlying - transport (like a socket), a read buffer, and a write buffer. Instead of - regular events, which give callbacks when the underlying transport is - ready to be read or written, a buffer event invokes its user-supplied - callbacks when it has read or written enough data. - -
- -
- &reftitle.classsynopsis; - - - - - EventBufferEvent - - - - - final - EventBufferEvent - - - - &Constants; - - const - int - EventBufferEvent::READING - 1 - - - const - int - EventBufferEvent::WRITING - 2 - - - const - int - EventBufferEvent::EOF - 16 - - - const - int - EventBufferEvent::ERROR - 32 - - - const - int - EventBufferEvent::TIMEOUT - 64 - - - const - int - EventBufferEvent::CONNECTED - 128 - - - const - int - EventBufferEvent::OPT_CLOSE_ON_FREE - 1 - - - const - int - EventBufferEvent::OPT_THREADSAFE - 2 - - - const - int - EventBufferEvent::OPT_DEFER_CALLBACKS - 4 - - - const - int - EventBufferEvent::OPT_UNLOCK_CALLBACKS - 8 - - - const - int - EventBufferEvent::SSL_OPEN - 0 - - - const - int - EventBufferEvent::SSL_CONNECTING - 1 - - - const - int - EventBufferEvent::SSL_ACCEPTING - 2 - - &Properties; - - public - int - fd - - - public - int - priority - - - public - readonly - EventBuffer - input - - - public - readonly - EventBuffer - output - - &Methods; - - - -
- -
- &reftitle.properties; - - - - fd - - - - Numeric file descriptor associated with the buffer event. Normally - represents a bound socket. Equals to &null;, if there is no file - descriptor(socket) associated with the buffer event. - - - - - - priority - - - - The priority of the events used to implement the buffer event. - - - - - - input - - - - Underlying input buffer object( - EventBuffer) - - - - - - output - - - - Underlying output buffer object( - EventBuffer) - - - - -
- - -
- &reftitle.constants; - - - - EventBufferEvent::READING - - - - An event occurred during a read operation on the bufferevent. See the - other flags for which event it was. - - - - - - EventBufferEvent::WRITING - - - - An event occurred during a write operation on the bufferevent. See the - other flags for which event it was. - - - - - - EventBufferEvent::EOF - - - - Got an end-of-file indication on the buffer event. - - - - - - EventBufferEvent::ERROR - - - - An error occurred during a bufferevent operation. For more information - on what the error was, call - EventUtil::getLastSocketErrno - and/or - EventUtil::getLastSocketError. - - - - - - EventBufferEvent::TIMEOUT - - - - - - - - EventBufferEvent::CONNECTED - - - - Finished a requested connection on the bufferevent. - - - - - - EventBufferEvent::OPT_CLOSE_ON_FREE - - - - When the buffer event is freed, close the underlying transport. This - will close an underlying socket, free an underlying buffer event, etc. - - - - - - EventBufferEvent::OPT_THREADSAFE - - - - Automatically allocate locks for the bufferevent, so that it’s safe - to use from multiple threads. - - - - - - EventBufferEvent::OPT_DEFER_CALLBACKS - - - - When this flag is set, the bufferevent defers all of its callbacks. See - Fast - portable non-blocking network programming with Libevent, Deferred callbacks. - - - - - - EventBufferEvent::OPT_UNLOCK_CALLBACKS - - - - By default, when the bufferevent is set up to be threadsafe, the buffer - event’s locks are held whenever the any user-provided callback is - invoked. Setting this option makes Libevent release the buffer - event’s lock when it’s invoking the callbacks. - - - - - - EventBufferEvent::SSL_OPEN - - - - The SSL handshake is done - - - - - - EventBufferEvent::SSL_CONNECTING - - - - SSL is currently performing negotiation as a client - - - - - - EventBufferEvent::SSL_ACCEPTING - - - - SSL is currently performing negotiation as a server - - - - -
- -
- - &reference.event.entities.eventbufferevent; - -
- diff --git a/reference/event/eventbufferevent/close.xml b/reference/event/eventbufferevent/close.xml deleted file mode 100644 index 914426a1c6b0..000000000000 --- a/reference/event/eventbufferevent/close.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - EventBufferEvent::close - Closes file descriptor associated with the current buffer event - - - &reftitle.description; - - public - void - EventBufferEvent::close - - - - Closes file descriptor associated with the current buffer event. - - - This method may be used in cases when the - EventBufferEvent::OPT_CLOSE_ON_FREE option is not appropriate. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/event/eventbufferevent/connect.xml b/reference/event/eventbufferevent/connect.xml deleted file mode 100644 index 5aa541314c0f..000000000000 --- a/reference/event/eventbufferevent/connect.xml +++ /dev/null @@ -1,272 +0,0 @@ - - - - - EventBufferEvent::connect - Connect buffer event's file descriptor to given address or - UNIX socket - - - &reftitle.description; - - public - bool - EventBufferEvent::connect - - string - addr - - - - Connect buffer event's file descriptor to given address(optionally - with port), or a UNIX domain socket. - - - If socket is not assigned to the buffer event, this function allocates a - new socket and makes it non-blocking internally. - - - To resolve DNS names(asynchronously), use - EventBufferEvent::connectHost - method. - - - - &reftitle.parameters; - - - - addr - - - - Should contain an IP address with optional port number, or a path to - UNIX domain socket. Recognized formats are: - - - - Note, - 'unix:' - prefix is currently not case sensitive. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - - <function>EventBufferEvent::connect</function> example - -getInput(); - - while (($n = $input->remove($buf, 1024)) > 0) { - echo $buf; - } -} - -/* Event callback */ -function eventcb($bev, $events, $base) { - if ($events & EventBufferEvent::CONNECTED) { - echo "Connected.\n"; - } elseif ($events & (EventBufferEvent::ERROR | EventBufferEvent::EOF)) { - if ($events & EventBufferEvent::ERROR) { - echo "DNS error: ", $bev->getDnsErrorString(), PHP_EOL; - } - - echo "Closing\n"; - $base->exit(); - exit("Done\n"); - } -} - -$base = new EventBase(); - -echo "step 1\n"; -$bev = new EventBufferEvent($base, /* use internal socket */ NULL, - EventBufferEvent::OPT_CLOSE_ON_FREE | EventBufferEvent::OPT_DEFER_CALLBACKS); -if (!$bev) { - exit("Failed creating bufferevent socket\n"); -} - -echo "step 2\n"; -$bev->setCallbacks("readcb", /* writecb */ NULL, "eventcb", $base); -$bev->enable(Event::READ | Event::WRITE); - -echo "step 3\n"; -/* Send request */ -$output = $bev->getOutput(); -if (!$output->add( - "GET /index.cphp HTTP/1.0\r\n". - "Connection: Close\r\n\r\n" -)) { - exit("Failed adding request to output buffer\n"); -} - -/* Connect to the host synchronously. - * We know the IP, and don't need to resolve DNS. */ -if (!$bev->connect("127.0.0.1:80")) { - exit("Can't connect to host\n"); -} - -/* Dispatch pending events */ -$base->dispatch(); -]]> - - &example.outputs.similar; - - - - - - Connect to UNIX domain socket which presumably is served by a server, read response from - the server and output it to the console - -base = $base; - $this->bev = new EventBufferEvent($base, NULL, EventBufferEvent::OPT_CLOSE_ON_FREE, - array ($this, "read_cb"), NULL, array ($this, "event_cb")); - - if (!$this->bev->connect("unix:$sock_path")) { - trigger_error("Failed to connect to socket `$sock_path'", E_USER_ERROR); - } - - $this->bev->enable(Event::READ); - } - - function __destruct() { - if ($this->bev) { - $this->bev->free(); - $this->bev = NULL; - } - } - - function dispatch() { - $this->base->dispatch(); - } - - function read_cb($bev, $unused) { - $in = $bev->input; - - printf("Received %ld bytes\n", $in->length); - printf("----- data ----\n"); - printf("%ld:\t%s\n", (int) $in->length, $in->pullup(-1)); - - $this->bev->free(); - $this->bev = NULL; - $this->base->exit(NULL); - } - - function event_cb($bev, $events, $unused) { - if ($events & EventBufferEvent::ERROR) { - echo "Error from bufferevent\n"; - } - - if ($events & (EventBufferEvent::EOF | EventBufferEvent::ERROR)) { - $bev->free(); - $bev = NULL; - } elseif ($events & EventBufferEvent::CONNECTED) { - $bev->output->add("test\n"); - } - } -} - -if ($argc <= 1) { - exit("Socket path is not provided\n"); -} -$sock_path = $argv[1]; - -$base = new EventBase(); -$cl = new MyUnixSocketClient($base, $sock_path); -$cl->dispatch(); -?> - -]]> - - &example.outputs.similar; - - - - - - - &reftitle.seealso; - - - EventBufferEvent::connectHost - - - - - diff --git a/reference/event/eventbufferevent/connecthost.xml b/reference/event/eventbufferevent/connecthost.xml deleted file mode 100644 index d177d6dba9cf..000000000000 --- a/reference/event/eventbufferevent/connecthost.xml +++ /dev/null @@ -1,266 +0,0 @@ - - - - - EventBufferEvent::connectHost - Connects to a hostname with optionally asynchronous DNS resolving - - - &reftitle.description; - - public - bool - EventBufferEvent::connectHost - - EventDnsBase - dns_base - - - string - hostname - - - int - port - - - int - family - EventUtil::AF_UNSPEC - - - - Resolves the DNS name hostname, looking for addresses of type - family - ( - EventUtil::AF_* - constants). If the name resolution fails, it invokes the event callback - with an error event. If it succeeds, it launches a connection attempt just - as - EventBufferEvent::connect - would. - - - dns_base - is optional. May be &null;, or an object created with - EventDnsBase::__construct. - For asynchronous hostname resolving pass a valid event dns base resource. - Otherwise the hostname resolving will block. - - - - EventDnsBase - is available only if - Event - configured - - ( - event_extra - library, - libevent protocol-specific functionality support including HTTP, DNS, and RPC - ). - - - - - EventBufferEvent::connectHost - requires - libevent-2.0.3-alpha - or greater. - - - - - &reftitle.parameters; - - - - dns_base - - - - Object of - EventDnsBase - in case if DNS is to be resolved asynchronously. Otherwise &null;. - - - - - - hostname - - - - Hostname to connect to. Recognized formats are: - - - - - - - - - port - - - - Port number - - - - - - family - - - - Address family. - EventUtil::AF_UNSPEC, - EventUtil::AF_INET, - or - EventUtil::AF_INET6. - See - EventUtil constants. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - - <function>EventBufferEvent::connectHost</function> example - -input; //$bev->getInput(); - - //$pos = $input->search("TTP"); - $pos = $bev->input->search("TTP"); - - while (($n = $bev->input->remove($buf, 1024)) > 0) { - echo $buf; - } -} - -/* Event callback */ -function eventcb($bev, $events, $base) { - if ($events & EventBufferEvent::CONNECTED) { - echo "Connected.\n"; - } elseif ($events & (EventBufferEvent::ERROR | EventBufferEvent::EOF)) { - if ($events & EventBufferEvent::ERROR) { - echo "DNS error: ", $bev->getDnsErrorString(), PHP_EOL; - } - - echo "Closing\n"; - $base->exit(); - exit("Done\n"); - } -} - -$base = new EventBase(); - -$dns_base = new EventDnsBase($base, TRUE); // We'll use async DNS resolving -if (!$dns_base) { - exit("Failed to init DNS Base\n"); -} - -$bev = new EventBufferEvent($base, /* use internal socket */ NULL, - EventBufferEvent::OPT_CLOSE_ON_FREE | EventBufferEvent::OPT_DEFER_CALLBACKS, - "readcb", /* writecb */ NULL, "eventcb", $base -); -if (!$bev) { - exit("Failed creating bufferevent socket\n"); -} - -//$bev->setCallbacks("readcb", /* writecb */ NULL, "eventcb", $base); -$bev->enable(Event::READ | Event::WRITE); - -$output = $bev->output; //$bev->getOutput(); -if (!$output->add( - "GET {$argv[2]} HTTP/1.0\r\n". - "Host: {$argv[1]}\r\n". - "Connection: Close\r\n\r\n" -)) { - exit("Failed adding request to output buffer\n"); -} - -if (!$bev->connectHost($dns_base, $argv[1], 80, EventUtil::AF_UNSPEC)) { - exit("Can't connect to host {$argv[1]}\n"); -} - -$base->dispatch(); -?> -]]> - - &example.outputs.similar; - - -301 Moved -

301 Moved

-The document has moved -here. - -Closing -Done -]]> -
-
-
- - &reftitle.seealso; - - - EventBufferEvent::connect - - - -
- diff --git a/reference/event/eventbufferevent/construct.xml b/reference/event/eventbufferevent/construct.xml deleted file mode 100644 index ee70597f2857..000000000000 --- a/reference/event/eventbufferevent/construct.xml +++ /dev/null @@ -1,180 +0,0 @@ - - - - - EventBufferEvent::__construct - Constructs EventBufferEvent object - - - &reftitle.description; - - public - EventBufferEvent::__construct - - EventBase - base - - - mixed - socket - &null; - - - int - options - 0 - - - callable - readcb - &null; - - - callable - writecb - &null; - - - callable - eventcb - &null; - - - mixed - arg - &null; - - - - Create a buffer event on a socket, stream or a file descriptor. Passing - &null; to - socket - means that the socket should be created later, e.g. by means of - EventBufferEvent::connect. - - - - &reftitle.parameters; - - - - base - - - - Event base that should be associated with the new buffer event. - - - - - - socket - - - - May be created as a stream(not necessarily by means of - sockets - extension) - - - - - - options - - - - One of - EventBufferEvent::OPT_* - constants, - or - 0. - - - - - - readcb - - - - Read event callback. See - About buffer event - callbacks. - - - - - - writecb - - - - Write event callback. See - About buffer event - callbacks. - - - - - - eventcb - - - - Status-change event callback. See - About buffer event - callbacks. - - - - - - arg - - - - A variable that will be passed to all the callbacks. - - - - - - - &reftitle.seealso; - - - EventBufferEvent::sslFilter - - - EventBufferEvent::sslSocket - - - - - diff --git a/reference/event/eventbufferevent/createpair.xml b/reference/event/eventbufferevent/createpair.xml deleted file mode 100644 index ad625897402f..000000000000 --- a/reference/event/eventbufferevent/createpair.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - EventBufferEvent::createPair - Creates two buffer events connected to each other - - - &reftitle.description; - - public - static - array - EventBufferEvent::createPair - - EventBase - base - - - int - options - 0 - - - - Returns array of two - EventBufferEvent - objects connected to each other. All the usual options are supported, - except for - EventBufferEvent::OPT_CLOSE_ON_FREE, - which has no effect, and - EventBufferEvent::OPT_DEFER_CALLBACKS, - which is always on. - - - - &reftitle.parameters; - - - - base - - - - Associated event base - - - - - - options - - - - EventBufferEvent::OPT_* constants - combined with bitwise - OR - operator. - - - - - - - &reftitle.returnvalues; - - Returns array of two - EventBufferEvent - objects connected to each other. - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL event 1.9.0 - - Method made static. - - - - - - - - diff --git a/reference/event/eventbufferevent/disable.xml b/reference/event/eventbufferevent/disable.xml deleted file mode 100644 index b7b50dbc842d..000000000000 --- a/reference/event/eventbufferevent/disable.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - EventBufferEvent::disable - Disable events read, write, or both on a buffer event - - - &reftitle.description; - - public - bool - EventBufferEvent::disable - - int - events - - - - Disable events - Event::READ, - Event::WRITE, - or - Event::READ - | - Event::WRITE - on a buffer event. - - - - &reftitle.parameters; - - - - events - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBufferEvent::enable - - - - - diff --git a/reference/event/eventbufferevent/enable.xml b/reference/event/eventbufferevent/enable.xml deleted file mode 100644 index 26bc794ce813..000000000000 --- a/reference/event/eventbufferevent/enable.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - EventBufferEvent::enable - Enable events read, write, or both on a buffer event - - - &reftitle.description; - - public - bool - EventBufferEvent::enable - - int - events - - - - Enable events - Event::READ, - Event::WRITE, - or - Event::READ - | - Event::WRITE - on a buffer event. - - - - &reftitle.parameters; - - - - events - - - - Event::READ, - Event::WRITE, - or - Event::READ - | - Event::WRITE - on a buffer event. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBufferEvent::disable - - - - - diff --git a/reference/event/eventbufferevent/free.xml b/reference/event/eventbufferevent/free.xml deleted file mode 100644 index 8462ca361c68..000000000000 --- a/reference/event/eventbufferevent/free.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - EventBufferEvent::free - Free a buffer event - - - &reftitle.description; - - public - void - EventBufferEvent::free - - - - Free resources allocated by buffer event. - - - Usually there is no need to call this method, since normally it is done - within internal object destructors. However, sometimes we have a long-time - script allocating lots of instances, or a script with a heavy memory usage, - where we need to free resources as soon as possible. In such cases - EventBufferEvent::free - may be used to protect the script against running up to the - memory_limit. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/event/eventbufferevent/getdnserrorstring.xml b/reference/event/eventbufferevent/getdnserrorstring.xml deleted file mode 100644 index 31737418fc51..000000000000 --- a/reference/event/eventbufferevent/getdnserrorstring.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - EventBufferEvent::getDnsErrorString - Returns string describing the last failed DNS lookup attempt - - - &reftitle.description; - - public - string - EventBufferEvent::getDnsErrorString - - - - Returns string describing the last failed DNS lookup attempt made by - EventBufferEvent::connectHost, - or an empty string, if there is no DNS error detected. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Returns a string describing DNS lookup error, or an empty string for no - error. - - - - &reftitle.seealso; - - - EventBufferEvent::connectHost - - - - - diff --git a/reference/event/eventbufferevent/getenabled.xml b/reference/event/eventbufferevent/getenabled.xml deleted file mode 100644 index 2adfd24b3889..000000000000 --- a/reference/event/eventbufferevent/getenabled.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - EventBufferEvent::getEnabled - Returns bitmask of events currently enabled on the buffer event - - - &reftitle.description; - - public - int - EventBufferEvent::getEnabled - - - - Returns bitmask of events currently enabled on the buffer event - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Returns integer representing a bitmask of events currently enabled on the - buffer event - - - - &reftitle.seealso; - - - EventBufferEvent::enable - - - EventBufferEvent::disable - - - - - diff --git a/reference/event/eventbufferevent/getinput.xml b/reference/event/eventbufferevent/getinput.xml deleted file mode 100644 index 00f05a36a64d..000000000000 --- a/reference/event/eventbufferevent/getinput.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - EventBufferEvent::getInput - Returns underlying input buffer associated with current buffer - event - - - &reftitle.description; - - public - EventBuffer - EventBufferEvent::getInput - - - - Returns underlying input buffer associated with current buffer event. An - input buffer is a storage for data to read. - - - Note, there is also - - input - - property of - EventBufferEvent - class. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Returns instance of - EventBuffer - input buffer associated with current buffer event. - - - - &reftitle.examples; - - Buffer event's read callback - -input; //$bev->getInput(); - - while (($n = $input->remove($buf, 1024)) > 0) { - echo $buf; - } -} -?> -]]> - - - - - &reftitle.seealso; - - - EventBufferEvent::getOutput - - - - - diff --git a/reference/event/eventbufferevent/getoutput.xml b/reference/event/eventbufferevent/getoutput.xml deleted file mode 100644 index 1fe54065ea3b..000000000000 --- a/reference/event/eventbufferevent/getoutput.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - EventBufferEvent::getOutput - Returns underlying output buffer associated with current buffer - event - - - &reftitle.description; - - public - EventBuffer - EventBufferEvent::getOutput - - - - Returns underlying output buffer associated with current buffer event. An - output buffer is a storage for data to be written. - - - Note, there is also - - output - - property of - EventBufferEvent - class. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Returns instance of - EventBuffer - output buffer associated with current buffer event. - - - - &reftitle.examples; - - - <function>EventBufferEvent::getOutput</function> example - -enable(Event::READ | Event::WRITE); - -$output = $bev->getOutput(); -if (!$output->add( - "GET {$argv[2]} HTTP/1.0\r\n". - "Host: {$argv[1]}\r\n". - "Connection: Close\r\n\r\n" -)) { - exit("Failed adding request to output buffer\n"); -} - -/* ... */ -?> -]]> - - - - - &reftitle.seealso; - - - EventBufferEvent::getInput - - - - - diff --git a/reference/event/eventbufferevent/read.xml b/reference/event/eventbufferevent/read.xml deleted file mode 100644 index 6d4d8baa8ab2..000000000000 --- a/reference/event/eventbufferevent/read.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - EventBufferEvent::read - Read buffer's data - - - &reftitle.description; - - public - string - EventBufferEvent::read - - int - size - - - - Removes up to - size - bytes from the input buffer. Returns a string of data read from the input - buffer. - - - - &reftitle.parameters; - - - - size - - - - Maximum number of bytes to read - - - - - - - &reftitle.returnvalues; - - Returns string of data read from the input buffer. - - - - &reftitle.seealso; - - - EventBufferEvent::readBuffer - - - - - diff --git a/reference/event/eventbufferevent/readbuffer.xml b/reference/event/eventbufferevent/readbuffer.xml deleted file mode 100644 index c93ed8d1d96f..000000000000 --- a/reference/event/eventbufferevent/readbuffer.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - EventBufferEvent::readBuffer - Drains the entire contents of the input buffer and places them into buf - - - &reftitle.description; - - public - bool - EventBufferEvent::readBuffer - - EventBuffer - buf - - - - Drains the entire contents of the input buffer and places them into - buf. - - - - &reftitle.parameters; - - - - buf - - - - Target buffer - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBufferEvent::read - - - - - diff --git a/reference/event/eventbufferevent/setcallbacks.xml b/reference/event/eventbufferevent/setcallbacks.xml deleted file mode 100644 index 18ab8b5428d5..000000000000 --- a/reference/event/eventbufferevent/setcallbacks.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - EventBufferEvent::setCallbacks - Assigns read, write and event(status) callbacks - - - &reftitle.description; - - public - void - EventBufferEvent::setCallbacks - - callable - readcb - - - callable - writecb - - - callable - eventcb - - - mixed - arg - - - - Assigns read, write and event(status) callbacks. - - - - &reftitle.parameters; - - - - readcb - - - - Read event callback. See - About buffer event - callbacks. - - - - - - writecb - - - - Write event callback. See - About buffer event - callbacks. - - - - - - eventcb - - - - Status-change event callback. See - About buffer event - callbacks. - - - - - - arg - - - - A variable that will be passed to all the callbacks. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EventBufferEvent::__construct - - - - - diff --git a/reference/event/eventbufferevent/setpriority.xml b/reference/event/eventbufferevent/setpriority.xml deleted file mode 100644 index 55b7549bad79..000000000000 --- a/reference/event/eventbufferevent/setpriority.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - EventBufferEvent::setPriority - Assign a priority to a bufferevent - - - &reftitle.description; - - public - bool - EventBufferEvent::setPriority - - int - priority - - - - Assign a priority to a bufferevent - - - - Only supported for socket buffer events - - - - - &reftitle.parameters; - - - - priority - - - - Priority value. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/event/eventbufferevent/settimeouts.xml b/reference/event/eventbufferevent/settimeouts.xml deleted file mode 100644 index 1436c22e393a..000000000000 --- a/reference/event/eventbufferevent/settimeouts.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - EventBufferEvent::setTimeouts - Set the read and write timeout for a buffer event - - - &reftitle.description; - - public - bool - EventBufferEvent::setTimeouts - - float - timeout_read - - - float - timeout_write - - - - Set the read and write timeout for a buffer event - - - - &reftitle.parameters; - - - - timeout_read - - - - Read timeout - - - - - - timeout_write - - - - Write timeout - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/event/eventbufferevent/setwatermark.xml b/reference/event/eventbufferevent/setwatermark.xml deleted file mode 100644 index 1b746ed412fd..000000000000 --- a/reference/event/eventbufferevent/setwatermark.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - EventBufferEvent::setWatermark - Adjusts read and/or write watermarks - - - &reftitle.description; - - public - void - EventBufferEvent::setWatermark - - int - events - - - int - lowmark - - - int - highmark - - - - Adjusts the read watermarks, the write - watermarks, - or both, of a single buffer event. - - - A buffer event watermark is an edge, a value specifying number of bytes to - be read or written before callback is invoked. By default every read/write - event triggers a callback invocation. See - Fast - portable non-blocking network programming with Libevent: Callbacks and watermarks - - - - &reftitle.parameters; - - - - events - - - - Bitmask of - Event::READ, - Event::WRITE, - or both. - - - - - - lowmark - - - - Minimum watermark value. - - - - - - highmark - - - - Maximum watermark value. - 0 - means "unlimited". - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/event/eventbufferevent/sslerror.xml b/reference/event/eventbufferevent/sslerror.xml deleted file mode 100644 index 24fcd1f253f6..000000000000 --- a/reference/event/eventbufferevent/sslerror.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - EventBufferEvent::sslError - Returns most recent OpenSSL error reported on the buffer event - - - &reftitle.description; - - public - string - EventBufferEvent::sslError - - - - Returns most recent OpenSSL error reported on the buffer event. - - - - This function is available only if - Event - is compiled with OpenSSL support. - - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Returns OpenSSL error string reported on the buffer event, or &false;, if - there is no more error to return. - - - - &reftitle.examples; - - - <function>EventBufferEvent::sslError</function> example - -sslError()) { - fprintf(STDERR, "Bufferevent error %s.\n", $err); - } - } - - if ($events & (EventBufferEvent::EOF | EventBufferEvent::ERROR)) { - $bev->free(); - } -} -?> -]]> - - - - - &reftitle.seealso; - - - EventBufferEvent::sslRenegotiate - - - - - diff --git a/reference/event/eventbufferevent/sslfilter.xml b/reference/event/eventbufferevent/sslfilter.xml deleted file mode 100644 index c3843ecf416a..000000000000 --- a/reference/event/eventbufferevent/sslfilter.xml +++ /dev/null @@ -1,151 +0,0 @@ - - - - - EventBufferEvent::sslFilter - Create a new SSL buffer event to send its data over another buffer event - - - &reftitle.description; - - public - static - EventBufferEvent - EventBufferEvent::sslFilter - - EventBase - base - - - EventBufferEvent - underlying - - - EventSslContext - ctx - - - int - state - - - int - options - 0 - - - - Create a new SSL buffer event to send its data over another buffer event - - - - This function is available only if - Event - is compiled with OpenSSL support. - - - - - &reftitle.parameters; - - - - base - - - - Associated event base. - - - - - - underlying - - - - A socket buffer event to use for this SSL. - - - - - - ctx - - - - Object of - EventSslContext - class. - - - - - - state - - - - The current state of SSL connection: - EventBufferEvent::SSL_OPEN, - EventBufferEvent::SSL_ACCEPTING - or - EventBufferEvent::SSL_CONNECTING. - - - - - - options - - - - One or more buffer event options. - - - - - - - &reftitle.returnvalues; - - Returns a new SSL - EventBufferEvent - object. - - - - &reftitle.examples; - - - - - - &reftitle.seealso; - - - EventBufferEvent::sslSocket - - - - - diff --git a/reference/event/eventbufferevent/sslgetcipherinfo.xml b/reference/event/eventbufferevent/sslgetcipherinfo.xml deleted file mode 100644 index 89ee4d12be9f..000000000000 --- a/reference/event/eventbufferevent/sslgetcipherinfo.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - EventBufferEvent::sslGetCipherInfo - Returns a textual description of the cipher - - - &reftitle.description; - - public - string - EventBufferEvent::sslGetCipherInfo - - - - Retrieves description of the current cipher by means of the - SSL_CIPHER_description SSL API function (see - SSL_CIPHER_get_name(3) man page). - - - - This function is available only if - Event - is compiled with OpenSSL support. - - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Returns a textual description of the cipher on success, or &false; on error. - - - - diff --git a/reference/event/eventbufferevent/sslgetciphername.xml b/reference/event/eventbufferevent/sslgetciphername.xml deleted file mode 100644 index 878c629b68c9..000000000000 --- a/reference/event/eventbufferevent/sslgetciphername.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - EventBufferEvent::sslGetCipherName - Returns the current cipher name of the SSL connection - - - &reftitle.description; - - public - string - EventBufferEvent::sslGetCipherName - - - - Retrieves name of cipher used by current SSL connection. - - - - This function is available only if - Event - is compiled with OpenSSL support. - - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Returns the current cipher name of the SSL connection, or &false; on error. - - - - diff --git a/reference/event/eventbufferevent/sslgetcipherversion.xml b/reference/event/eventbufferevent/sslgetcipherversion.xml deleted file mode 100644 index 1d25717b3b56..000000000000 --- a/reference/event/eventbufferevent/sslgetcipherversion.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - EventBufferEvent::sslGetCipherVersion - Returns version of cipher used by current SSL connection - - - &reftitle.description; - - public - string - EventBufferEvent::sslGetCipherVersion - - - - Retrieves version of cipher used by current SSL connection. - - - - This function is available only if - Event - is compiled with OpenSSL support. - - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Returns the current cipher version of the SSL connection, or &false; on error. - - - - diff --git a/reference/event/eventbufferevent/sslgetprotocol.xml b/reference/event/eventbufferevent/sslgetprotocol.xml deleted file mode 100644 index a791185b2204..000000000000 --- a/reference/event/eventbufferevent/sslgetprotocol.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - EventBufferEvent::sslGetProtocol - Returns the name of the protocol used for current SSL connection - - - &reftitle.description; - - public - string - EventBufferEvent::sslGetProtocol - - - - Returns the name of the protocol used for current SSL connection. - - - - This function is available only if - Event - is compiled with OpenSSL support. - - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Returns the name of the protocol used for current SSL connection. - - - - diff --git a/reference/event/eventbufferevent/sslrenegotiate.xml b/reference/event/eventbufferevent/sslrenegotiate.xml deleted file mode 100644 index 113bb3742146..000000000000 --- a/reference/event/eventbufferevent/sslrenegotiate.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - EventBufferEvent::sslRenegotiate - Tells a bufferevent to begin SSL renegotiation - - - &reftitle.description; - - public - void - EventBufferEvent::sslRenegotiate - - - - Tells a bufferevent to begin SSL renegotiation. - - - - Calling this function tells the SSL to renegotiate, and the buffer event - to invoke appropriate callbacks. This is an advanced topic; this should be - generally avoided unless one really knows what he/she does, especially - since many SSL versions have had known security issues related to - renegotiation. - - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/event/eventbufferevent/sslsocket.xml b/reference/event/eventbufferevent/sslsocket.xml deleted file mode 100644 index 6e54086a6d97..000000000000 --- a/reference/event/eventbufferevent/sslsocket.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - EventBufferEvent::sslSocket - Creates a new SSL buffer event to send its data over an SSL on a socket - - - &reftitle.description; - - public - static - EventBufferEvent - EventBufferEvent::sslSocket - - EventBase - base - - - mixed - socket - - - EventSslContext - ctx - - - int - state - - - int - options - - - - Creates a new SSL buffer event to send its data over an SSL on a socket. - - - - &reftitle.parameters; - - - - base - - - - Associated event base. - - - - - - socket - - - - Socket to use for this SSL. Can be stream or socket resource, numeric - file descriptor, or &null;. If - socket - is &null;, it is assumed that the file descriptor for the socket will be - assigned later, for instance, by means of - EventBufferEvent::connectHost - method. - - - - - - ctx - - - - Object of - EventSslContext - class. - - - - - - state - - - - The current state of SSL connection: - EventBufferEvent::SSL_OPEN, - EventBufferEvent::SSL_ACCEPTING - or - EventBufferEvent::SSL_CONNECTING. - - - - - - options - - - - The buffer event options. - - - - - - - &reftitle.returnvalues; - - Returns - EventBufferEvent - object. - - - - &reftitle.seealso; - - - EventBufferEvent::sslFilter - - - - - diff --git a/reference/event/eventbufferevent/write.xml b/reference/event/eventbufferevent/write.xml deleted file mode 100644 index c900eac2798f..000000000000 --- a/reference/event/eventbufferevent/write.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - EventBufferEvent::write - Adds data to a buffer event's output buffer - - - &reftitle.description; - - public - bool - EventBufferEvent::write - - string - data - - - - Adds - data - to a buffer event's output buffer - - - - &reftitle.parameters; - - - - data - - - - Data to be added to the underlying buffer. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBufferEvent::writeBuffer - - - - - diff --git a/reference/event/eventbufferevent/writebuffer.xml b/reference/event/eventbufferevent/writebuffer.xml deleted file mode 100644 index 59e364feb5c1..000000000000 --- a/reference/event/eventbufferevent/writebuffer.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - EventBufferEvent::writeBuffer - Adds contents of the entire buffer to a buffer event's output - buffer - - - &reftitle.description; - - public - bool - EventBufferEvent::writeBuffer - - EventBuffer - buf - - - - Adds contents of the entire buffer to a buffer event's output buffer - - - - &reftitle.parameters; - - - - buf - - - - Source - EventBuffer - object. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBufferEvent::write - - - - - diff --git a/reference/event/eventconfig.xml b/reference/event/eventconfig.xml deleted file mode 100644 index 12f4f566ac9f..000000000000 --- a/reference/event/eventconfig.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - The EventConfig class - EventConfig - - -
- &reftitle.intro; - - Represents configuration structure which could be used in construction of - the - EventBase. - -
- -
- &reftitle.classsynopsis; - - - - - EventConfig - - - - - final - EventConfig - - - - &Constants; - - const - int - EventConfig::FEATURE_ET - 1 - - - const - int - EventConfig::FEATURE_O1 - 2 - - - const - int - EventConfig::FEATURE_FDS - 4 - - &Methods; - - - -
- -
- &reftitle.constants; - - - - EventConfig::FEATURE_ET - - - - Requires a backend method that supports edge-triggered I/O. - - - - - - EventConfig::FEATURE_O1 - - - - Requires a backend method where adding or deleting a single event, or - having a single event become active, is an O(1) operation. - - - - - - EventConfig::FEATURE_FDS - - - - Requires a backend method that can support arbitrary file descriptor - types, and not just sockets. - - - - -
- -
- - &reference.event.entities.eventconfig; - -
- diff --git a/reference/event/eventconfig/avoidmethod.xml b/reference/event/eventconfig/avoidmethod.xml deleted file mode 100644 index 94ae9e10952a..000000000000 --- a/reference/event/eventconfig/avoidmethod.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - EventConfig::avoidMethod - Tells libevent to avoid specific event method - - - &reftitle.description; - - public - bool - EventConfig::avoidMethod - - string - method - - - - Tells libevent to avoid specific event method(backend). See - Creating - an event base. - - - - &reftitle.parameters; - - - - method - - - - The backend method to avoid. See - EventConfig constants. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - - <function>EventConfig::avoidMethod</function> example - -avoidMethod("select")) { - echo "'select' method avoided\n"; -} -?> -]]> - - - - - &reftitle.seealso; - - - EventBase::__construct - - - - - diff --git a/reference/event/eventconfig/construct.xml b/reference/event/eventconfig/construct.xml deleted file mode 100644 index b15d65d9a560..000000000000 --- a/reference/event/eventconfig/construct.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - EventConfig::__construct - Constructs EventConfig object - - - &reftitle.description; - - public - EventConfig::__construct - - - - Constructs EventConfig object which could be passed to - EventBase::__construct - constructor. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.examples; - - - <function>EventConfig::__construct</function> example - -avoidMethod("select")) { - echo "'select' method avoided\n"; -} - -// Create event_base associated with the config -$base = new EventBase($cfg); - -/* Now $base is configured to avoid select backend(method) */ -?> -]]> - - - - - &reftitle.seealso; - - - EventBase::__construct - - - - - diff --git a/reference/event/eventconfig/requirefeatures.xml b/reference/event/eventconfig/requirefeatures.xml deleted file mode 100644 index 57c61db4f3ff..000000000000 --- a/reference/event/eventconfig/requirefeatures.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - EventConfig::requireFeatures - Enters a required event method feature that the application demands - - - &reftitle.description; - - public - bool - EventConfig::requireFeatures - - int - feature - - - - Enters a required event method feature that the application demands - - - - &reftitle.parameters; - - - - feature - - - - Bitmask of required features. See - - EventConfig::FEATURE_* constants - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - - <function>EventConfig::requireFeatures</function> example - -requireFeatures(EventConfig::FEATURE_FDS)) { - echo "FDS feature is now required\n"; - - $base = new EventBase($cfg); - ($base->getFeatures() & EventConfig::FEATURE_FDS) - and print "FDS - arbitrary file descriptor types, and not just sockets\n"; -} -?> -]]> - - &example.outputs.similar; - - - - - - - &reftitle.seealso; - - - EventBase::getFeatures - - - - - diff --git a/reference/event/eventconfig/setflags.xml b/reference/event/eventconfig/setflags.xml deleted file mode 100644 index a499499403ef..000000000000 --- a/reference/event/eventconfig/setflags.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - EventConfig::setFlags - Sets one or more flags that configure how the eventual EventBase will be initialized - - - &reftitle.description; - - public - bool - EventConfig::setFlags - - int - flags - - - - Sets one or more flags to configure what parts of - the eventual EventBase will be initialized, and how they'll work. - - - - &reftitle.parameters; - - - - flags - - - - One of EventBase::LOOP_* constants. - See EventBase constants. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBase::getFeatures - - - - - diff --git a/reference/event/eventconfig/setmaxdispatchinterval.xml b/reference/event/eventconfig/setmaxdispatchinterval.xml deleted file mode 100644 index 34826bb1b65d..000000000000 --- a/reference/event/eventconfig/setmaxdispatchinterval.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - EventConfig::setMaxDispatchInterval - Prevents priority inversion - - - &reftitle.description; - - public - void - EventConfig::setMaxDispatchInterval - - int - max_interval - - - int - max_callbacks - - - int - min_priority - - - - Prevents priority inversion by limiting how many low-priority event - callbacks can be invoked before checking for more high-priority events. - - - - Available since - libevent 2.1.0-alpha. - - - - - &reftitle.parameters; - - - - max_interval - - - - An interval after which Libevent should stop running callbacks and check - for more events, or - 0, - if there should be no such interval. - - - - - - max_callbacks - - - - A number of callbacks after which Libevent should stop running callbacks - and check for more events, or - -1, - if there should be no such limit. - - - - - - min_priority - - - - A priority below which - max_interval - and - max_callbacks - should not be enforced. If this is set to - 0, - they are enforced for events of every priority; if it's set to - 1, - they're enforced for events of priority - 1 - and above, and so on. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/event/eventdnsbase.xml b/reference/event/eventdnsbase.xml deleted file mode 100644 index 7b91a22ec560..000000000000 --- a/reference/event/eventdnsbase.xml +++ /dev/null @@ -1,209 +0,0 @@ - - - - The EventDnsBase class - EventDnsBase - - -
- &reftitle.intro; - - Represents Libevent's DNS base structure. Used to resolve DNS - asynchronously, parse configuration files like resolv.conf etc. - -
- -
- &reftitle.classsynopsis; - - - - - EventDnsBase - - - - - final - EventDnsBase - - - - &Constants; - - const - int - EventDnsBase::OPTION_SEARCH - 1 - - - const - int - EventDnsBase::OPTION_NAMESERVERS - 2 - - - const - int - EventDnsBase::OPTION_MISC - 4 - - - const - int - EventDnsBase::OPTION_HOSTSFILE - 8 - - - const - int - EventDnsBase::OPTIONS_ALL - 15 - - - const - int - EventDnsBase::DISABLE_WHEN_INACTIVE - 32768 - - - const - int - EventDnsBase::INITIALIZE_NAMESERVERS - 1 - - - const - int - EventDnsBase::NAMESERVERS_NO_DEFAULT - 65536 - - &Methods; - - - - -
- -
- &reftitle.constants; - - - - EventDnsBase::OPTION_SEARCH - - - - Tells to read the domain and search fields from the - resolv.conf - file and the - ndots - option, and use them to decide which domains(if any) to search for - hostnames that aren’t fully-qualified. - - - - - - EventDnsBase::OPTION_NAMESERVERS - - - - Tells to learn the nameservers from the - resolv.conf - file. - - - - - - EventDnsBase::OPTION_MISC - - - - - - - - EventDnsBase::OPTION_HOSTSFILE - - - - Tells to read a list of hosts from - /etc/hosts - as part of loading the - resolv.conf - file. - - - - - - EventDnsBase::OPTIONS_ALL - - - - Tells to learn as much as it can from the - resolv.conf - file. - - - - - - EventDnsBase::DISABLE_WHEN_INACTIVE - - - - Do not prevent the libevent event loop from exiting when we have no active DNS requests. - - - - - - EventDnsBase::INITIALIZE_NAMESERVERS - - - - Process the resolv.conf. - - - - - - EventDnsBase::NAMESERVERS_NO_DEFAULT - - - - Do not add default nameserver if there are no nameservers in the resolv.conf. - - - - -
- -
- - &reference.event.entities.eventdnsbase; - -
- diff --git a/reference/event/eventdnsbase/addnameserverip.xml b/reference/event/eventdnsbase/addnameserverip.xml deleted file mode 100644 index 845068efc327..000000000000 --- a/reference/event/eventdnsbase/addnameserverip.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - EventDnsBase::addNameserverIp - Adds a nameserver to the DNS base - - - &reftitle.description; - - public - bool - EventDnsBase::addNameserverIp - - string - ip - - - - Adds a nameserver to the evdns_base. - - - - &reftitle.parameters; - - - - ip - - - - The nameserver string, either as an IPv4 address, an IPv6 address, an - IPv4 address with a port ( - IPv4:Port - ), or an IPv6 address with a port ( - [IPv6]:Port - ). - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/event/eventdnsbase/addsearch.xml b/reference/event/eventdnsbase/addsearch.xml deleted file mode 100644 index bc16dc412933..000000000000 --- a/reference/event/eventdnsbase/addsearch.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - EventDnsBase::addSearch - Adds a domain to the list of search domains - - - &reftitle.description; - - public - void - EventDnsBase::addSearch - - string - domain - - - - Adds a domain to the list of search domains - - - - &reftitle.parameters; - - - - domain - - - - Search domain. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/event/eventdnsbase/clearsearch.xml b/reference/event/eventdnsbase/clearsearch.xml deleted file mode 100644 index 1102322b5a73..000000000000 --- a/reference/event/eventdnsbase/clearsearch.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - EventDnsBase::clearSearch - Removes all current search suffixes - - - &reftitle.description; - - public - void - EventDnsBase::clearSearch - - - - Removes all current search suffixes from the DNS base; the - EventDnsBase::addSearch - function adds a suffix. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EventDnsBase::addSearch - - - - - diff --git a/reference/event/eventdnsbase/construct.xml b/reference/event/eventdnsbase/construct.xml deleted file mode 100644 index 04cf7a40d352..000000000000 --- a/reference/event/eventdnsbase/construct.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - - EventDnsBase::__construct - Constructs EventDnsBase object - - - &reftitle.description; - - public - EventDnsBase::__construct - - EventBase - base - - - intbool - initialize - - - - Constructs EventDnsBase object. - - - - &reftitle.parameters; - - - - base - - - - Event base. - - - - - - initialize - - - - If initialize is &true;, - it attempts to use the underlying operating system defaults to configure - the DNS base sensibly. - If it is &false;, the DNS base is left unconfigured, with no nameservers or options set. - In the latter case the DNS base should be configured manually, e.g. with - EventDnsBase::parseResolvConf. - - - If initialize is an integer, it must be one of the following flags: - - - - - Flag - &Description; - - - - - EventDnsBase::DISABLE_WHEN_INACTIVE - - Do not prevent the libevent event loop from exiting when we have no active DNS requests. - - - - EventDnsBase::INITIALIZE_NAMESERVERS - - Process the resolv.conf. - - - - EventDnsBase::NAMESERVERS_NO_DEFAULT - - Do not add default nameserver if there are no nameservers in the resolv.conf. - - - - - - - - - - - - &reftitle.errors; - - If initialize has a type other than - intbool, - a TypeError is thrown. - - - If the value of initialize is invalid, - a EventException is thrown. - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL event 3.1.3 - - If initialize has a type other than - intbool, - a TypeError is thrown. - - - - PECL event 3.1.0RC1 - - The type of the initialize parameter has been changed from bool - to mixed. The value can be either bool (preserving the previous meaning) - or one of the following constants: - EventDnsBase::DISABLE_WHEN_INACTIVE, - EventDnsBase::INITIALIZE_NAMESERVERS, - or EventDnsBase::NAMESERVERS_NO_DEFAULT. - - - - - - - - diff --git a/reference/event/eventdnsbase/countnameservers.xml b/reference/event/eventdnsbase/countnameservers.xml deleted file mode 100644 index 360e5b7987c2..000000000000 --- a/reference/event/eventdnsbase/countnameservers.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - EventDnsBase::countNameservers - Gets the number of configured nameservers - - - &reftitle.description; - - public - int - EventDnsBase::countNameservers - - - - Gets the number of configured nameservers - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Returns the number of configured nameservers(not necessarily the number of - running nameservers). This is useful for double-checking whether our calls - to the various nameserver configuration functions have been successful. - - - - diff --git a/reference/event/eventdnsbase/loadhosts.xml b/reference/event/eventdnsbase/loadhosts.xml deleted file mode 100644 index 50d906612505..000000000000 --- a/reference/event/eventdnsbase/loadhosts.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - EventDnsBase::loadHosts - Loads a hosts file (in the same format as /etc/hosts) from hosts file - - - &reftitle.description; - - public - bool - EventDnsBase::loadHosts - - string - hosts - - - - Loads a hosts file (in the same format as - /etc/hosts) - from hosts file. - - - - &reftitle.parameters; - - - - hosts - - - - Path to the hosts' file. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/event/eventdnsbase/parseresolvconf.xml b/reference/event/eventdnsbase/parseresolvconf.xml deleted file mode 100644 index 6deeb787b7bc..000000000000 --- a/reference/event/eventdnsbase/parseresolvconf.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - EventDnsBase::parseResolvConf - Scans the resolv.conf-formatted file - - - &reftitle.description; - - public - bool - EventDnsBase::parseResolvConf - - int - flags - - - string - filename - - - - Scans the resolv.conf-formatted file stored in filename, and read in all - the options from it that are listed in flags - - - - &reftitle.parameters; - - - - flags - - - - Determines what information is parsed from the - resolv.conf - file. See the man page for - resolv.conf - for the format of this file. - - - The following directives are not parsed from the file: - sortlist, rotate, no-check-names, inet6, debug. - - - If this function encounters an error, the possible return values are: - - - 1 = failed to open file - - 2 = failed to stat file - - 3 = file too large - - 4 = out of memory - - 5 = short read from file - - 6 = no nameservers listed in the file - - - - - - - filename - - - - Path to - resolv.conf - file. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/event/eventdnsbase/setoption.xml b/reference/event/eventdnsbase/setoption.xml deleted file mode 100644 index b49d8611626d..000000000000 --- a/reference/event/eventdnsbase/setoption.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - EventDnsBase::setOption - Set the value of a configuration option - - - &reftitle.description; - - public - bool - EventDnsBase::setOption - - string - option - - - string - value - - - - Set the value of a configuration option. - - - - &reftitle.parameters; - - - - option - - - - The currently available configuration options are: - "ndots", - "timeout", - "max-timeouts", - "max-inflight", - and - "attempts". - - - - - - value - - - - Option value. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/event/eventdnsbase/setsearchndots.xml b/reference/event/eventdnsbase/setsearchndots.xml deleted file mode 100644 index f71438df953f..000000000000 --- a/reference/event/eventdnsbase/setsearchndots.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - EventDnsBase::setSearchNdots - Set the 'ndots' parameter for searches - - - &reftitle.description; - - public - bool - EventDnsBase::setSearchNdots - - int - ndots - - - - Set the - 'ndots' - parameter for searches. Sets the number of dots which, when found in a - name, causes the first query to be without any search domain. - - - - &reftitle.parameters; - - - - ndots - - - - The number of dots. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/event/eventexception.xml b/reference/event/eventexception.xml deleted file mode 100644 index b956d4d3bc3d..000000000000 --- a/reference/event/eventexception.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - The EventException class - EventException - - -
- &reftitle.intro; - - A EventException is thrown when the Event extension methods - encounter invalid user input or identify an unrecoverable error. This exception - serves as a signal for developers to handle exceptional situations gracefully. - -
- -
- &reftitle.classsynopsis; - - - - - EventException - - - - extends - RuntimeException - - - &InheritedProperties; - - - &InheritedMethods; - - - - -
-
- -
- diff --git a/reference/event/eventhttp.xml b/reference/event/eventhttp.xml deleted file mode 100644 index 259fadeda98c..000000000000 --- a/reference/event/eventhttp.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - The EventHttp class - EventHttp - - -
- &reftitle.intro; - - Represents HTTP server. - -
- -
- &reftitle.classsynopsis; - - - - - EventHttp - - - - - final - EventHttp - - - - &Methods; - - - -
-
- - &reference.event.entities.eventhttp; - -
- diff --git a/reference/event/eventhttp/accept.xml b/reference/event/eventhttp/accept.xml deleted file mode 100644 index 2662c5bbb11e..000000000000 --- a/reference/event/eventhttp/accept.xml +++ /dev/null @@ -1,176 +0,0 @@ - - - - - EventHttp::accept - Makes an HTTP server accept connections on the specified socket stream or resource - - - &reftitle.description; - - public - bool - EventHttp::accept - - mixed - socket - - - - Makes an HTTP server accept connections on the specified socket stream or - resource. The socket should be ready to accept connections. - - - Can be called multiple times to accept connections on different sockets. - - - - To bind a socket, - listen, - and - accept - connections on the socket in a single call use - EventHttp::bind. - EventHttp::accept - is needed only if one already has a socket ready to accept connections. - - - - - &reftitle.parameters; - - - - socket - - - - Socket resource, stream or numeric file descriptor representing a socket - ready to accept connections. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - - <function>EventHttp::accept</function> example - - "127.0.0.1", - 8092 => "127.0.0.2", -]; -$i = 0; - -$socket = array(); - -foreach ($addresses as $port => $ip) { - echo $ip, " ", $port, PHP_EOL; - $socket[$i] = socket_create(AF_INET, SOCK_STREAM, SOL_TCP); - - if (!socket_bind($socket[$i], $ip, $port)) { - exit("socket_bind failed\n"); - } - - socket_listen($socket[$i], 0); - socket_set_nonblock($socket[$i]); - - if (!$http->accept($socket[$i])) { - echo "Accept failed\n"; - exit(1); - } - - ++$i; -} - -$http->setCallback("/some-page", function () { - echo "(some-page)\n"; - echo "URI: ", $req->getUri(), PHP_EOL; - $req->sendReply(200, "OK"); - echo "OK\n"; -}); - -$http->setDefaultCallback(function ($req) { - echo "URI: ", $req->getUri(), PHP_EOL; - $req->sendReply(200, "OK"); - echo "OK\n"; -}); - -$signal = Event::signal($base, SIGINT, function () use ($base) { - echo "Caught SIGINT. Stopping...\n"; - $base->stop(); -}); -$signal->add(); - -$base->dispatch(); -echo "END\n"; -// We didn't close sockets, since Libevent already sets -// CLOSE_ON_FREE and CLOSE_ON_EXEC flags on the file -// descriptor associated with the sockets. -?> -]]> - - &example.outputs.similar; - - - - - - - &reftitle.seealso; - - - EventHttp::bind - - - - - diff --git a/reference/event/eventhttp/addserveralias.xml b/reference/event/eventhttp/addserveralias.xml deleted file mode 100644 index 46cbeeedd0ed..000000000000 --- a/reference/event/eventhttp/addserveralias.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - EventHttp::addServerAlias - Adds a server alias to the HTTP server object - - - &reftitle.description; - - public - bool - EventHttp::addServerAlias - - string - alias - - - - Adds a server alias to the HTTP server object. - - - - &reftitle.parameters; - - - - alias - - - - The alias to add. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - - <function>EventHttp::addServerAlias</function> example - -bind("127.0.0.1", 8088)) { - exit("bind(1) failed\n"); -}; - -if (!$http->addServerAlias("local.net")) { - exit("Failed to add server alias\n"); -} - -$http->setCallback("/about", function($req) { - echo "URI: ", $req->getUri(), PHP_EOL; - $req->sendReply(200, "OK"); -}); -$base->dispatch(); -?> -]]> - - - - - &reftitle.seealso; - - - EventHttp::removeServerAlias - - - - - diff --git a/reference/event/eventhttp/bind.xml b/reference/event/eventhttp/bind.xml deleted file mode 100644 index 741958ee3c1d..000000000000 --- a/reference/event/eventhttp/bind.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - EventHttp::bind - Binds an HTTP server on the specified address and port - - - &reftitle.description; - - public - void - EventHttp::bind - - string - address - - - int - port - - - - Binds an HTTP server on the specified address and port. - - - Can be called multiple times to bind the same HTTP server to multiple - different ports. - - - - &reftitle.parameters; - - - - address - - - - A string containing the IP address to - listen(2) - on. - - - - - - port - - - - The port number to listen on. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - - <function>EventHttp::bind</function> example - -bind("127.0.0.1", 8088)) { - exit("bind(1) failed\n"); -}; -if (!$http->bind("127.0.0.1", 8089)) { - exit("bind(2) failed\n"); -}; - -$http->setCallback("/about", function($req) { - echo "URI: ", $req->getUri(), PHP_EOL; - $req->sendReply(200, "OK"); - echo "OK\n"; -}); - -$base->dispatch(); -?> -]]> - - &example.outputs.similar; - -404 Not Found

Not Found

The requested URL /unknown was not found on this server.

- -Server: -URI: /about -OK -]]> -
-
-
- - &reftitle.seealso; - - - EventHttp::accept - - - -
- diff --git a/reference/event/eventhttp/construct.xml b/reference/event/eventhttp/construct.xml deleted file mode 100644 index fb6c8d92a065..000000000000 --- a/reference/event/eventhttp/construct.xml +++ /dev/null @@ -1,249 +0,0 @@ - - - - - EventHttp::__construct - Constructs EventHttp object (the HTTP server) - - - &reftitle.description; - - public - EventHttp::__construct - - EventBase - base - - - EventSslContext - ctx - &null; - - - - Constructs the HTTP server object. - - - - &reftitle.parameters; - - - - base - - - - Associated event base. - - - - - - ctx - - - - EventSslContext - class object. Turns plain HTTP server into HTTPS server. It means that - if - ctx - is configured correctly, then the underlying buffer events will be based - on OpenSSL sockets. Thus, all traffic will pass through the SSL or TLS. - - - - This parameter is available only if - Event - is compiled with OpenSSL support and only with - Libevent - 2.1.0-alpha - and higher. - - - - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL event 1.9.0 - - OpenSSL support (ctx) added. - - - - - - - - &reftitle.examples; - - Simple HTTP server - -= $max_requests) { - echo "Counter reached max requests $max_requests. Exiting\n"; - exit(); - } - - echo __METHOD__, " called\n"; - echo "request:"; var_dump($req); - echo "data:"; var_dump($data); - - echo "\n===== DUMP =====\n"; - echo "Command:", $req->getCommand(), PHP_EOL; - echo "URI:", $req->getUri(), PHP_EOL; - echo "Input headers:"; var_dump($req->getInputHeaders()); - echo "Output headers:"; var_dump($req->getOutputHeaders()); - - echo "\n >> Sending reply ..."; - $req->sendReply(200, "OK"); - echo "OK\n"; - - echo "\n >> Reading input buffer ...\n"; - $buf = $req->getInputBuffer(); - while ($s = $buf->readLine(EventBuffer::EOL_ANY)) { - echo $s, PHP_EOL; - } - echo "No more data in the buffer\n"; -} - -function _http_about($req) { - echo __METHOD__, PHP_EOL; - echo "URI: ", $req->getUri(), PHP_EOL; - echo "\n >> Sending reply ..."; - $req->sendReply(200, "OK"); - echo "OK\n"; -} - -function _http_default($req, $data) { - echo __METHOD__, PHP_EOL; - echo "URI: ", $req->getUri(), PHP_EOL; - echo "\n >> Sending reply ..."; - $req->sendReply(200, "OK"); - echo "OK\n"; -} - -$port = 8010; -if ($argc > 1) { - $port = (int) $argv[1]; -} -if ($port <= 0 || $port > 65535) { - exit("Invalid port"); -} - -$base = new EventBase(); -$http = new EventHttp($base); -$http->setAllowedMethods(EventHttpRequest::CMD_GET | EventHttpRequest::CMD_POST); - -$http->setCallback("/dump", "_http_dump", array(4, 8)); -$http->setCallback("/about", "_http_about"); -$http->setDefaultCallback("_http_default", "custom data value"); - -$http->bind("0.0.0.0", 8010); -$base->loop(); -?> -]]> - - &example.outputs.similar; - - - - - - - diff --git a/reference/event/eventhttp/removeserveralias.xml b/reference/event/eventhttp/removeserveralias.xml deleted file mode 100644 index efe300a196ae..000000000000 --- a/reference/event/eventhttp/removeserveralias.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - EventHttp::removeServerAlias - Removes server alias - - - &reftitle.description; - - public - bool - EventHttp::removeServerAlias - - string - alias - - - - Removes server alias added with - EventHttp::addServerAlias - - - - &reftitle.parameters; - - - - alias - - - - The alias to remove. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventHttp::addServerAlias - - - - - diff --git a/reference/event/eventhttp/setallowedmethods.xml b/reference/event/eventhttp/setallowedmethods.xml deleted file mode 100644 index 780bf1ed3f61..000000000000 --- a/reference/event/eventhttp/setallowedmethods.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - EventHttp::setAllowedMethods - Sets which HTTP methods are supported in requests accepted by this server, and passed to user callbacks - - - &reftitle.description; - - public - void - EventHttp::setAllowedMethods - - int - methods - - - - Sets which HTTP methods are supported in requests accepted by this - server, and passed to user callbacks - - - If not supported they will generate a - "405 Method not - allowed" - response. - - - By default this includes the following methods: - GET, - POST, - HEAD, - PUT, - DELETE. - See - EventHttpRequest::CMD_* - constants. - - - - &reftitle.parameters; - - - - methods - - - - A bit mask of - - EventHttpRequest::CMD_* - constants. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/event/eventhttp/setcallback.xml b/reference/event/eventhttp/setcallback.xml deleted file mode 100644 index 71626535760c..000000000000 --- a/reference/event/eventhttp/setcallback.xml +++ /dev/null @@ -1,252 +0,0 @@ - - - - - EventHttp::setCallback - Sets a callback for specified URI - - - &reftitle.description; - - public - void - EventHttp::setCallback - - string - path - - - string - cb - - - string - arg - - - - Sets a callback for specified URI. - - - - &reftitle.parameters; - - - - path - - - - The path for which to invoke the callback. - - - - - - cb - - - - The callback - callable - that gets invoked on requested - path. - It should match the following prototype: - - - void - callback - - EventHttpRequest - req - NULL - - - mixed - arg - NULL - - - - - - req - - - - EventHttpRequest - object. - - - - - - arg - - - - Custom data. - - - - - - - - - arg - - - - Custom data. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - - <function>EventHttp::setCallback</function> example - -= $max_requests) { - echo "Counter reached max requests $max_requests. Exiting\n"; - exit(); - } - - echo __METHOD__, " called\n"; - echo "request:"; var_dump($req); - echo "data:"; var_dump($data); - - echo "\n===== DUMP =====\n"; - echo "Command:", $req->getCommand(), PHP_EOL; - echo "URI:", $req->getUri(), PHP_EOL; - echo "Input headers:"; var_dump($req->getInputHeaders()); - echo "Output headers:"; var_dump($req->getOutputHeaders()); - - echo "\n >> Sending reply ..."; - $req->sendReply(200, "OK"); - echo "OK\n"; - - echo "\n >> Reading input buffer ...\n"; - $buf = $req->getInputBuffer(); - while ($s = $buf->readLine(EventBuffer::EOL_ANY)) { - echo $s, PHP_EOL; - } - echo "No more data in the buffer\n"; -} - -function _http_about($req) { - echo __METHOD__, PHP_EOL; - echo "URI: ", $req->getUri(), PHP_EOL; - echo "\n >> Sending reply ..."; - $req->sendReply(200, "OK"); - echo "OK\n"; -} - -function _http_default($req, $data) { - echo __METHOD__, PHP_EOL; - echo "URI: ", $req->getUri(), PHP_EOL; - echo "\n >> Sending reply ..."; - $req->sendReply(200, "OK"); - echo "OK\n"; -} - -$port = 8010; -if ($argc > 1) { - $port = (int) $argv[1]; -} -if ($port <= 0 || $port > 65535) { - exit("Invalid port"); -} - -$base = new EventBase(); -$http = new EventHttp($base); -$http->setAllowedMethods(EventHttpRequest::CMD_GET | EventHttpRequest::CMD_POST); - -$http->setCallback("/dump", "_http_dump", array(4, 8)); -$http->setCallback("/about", "_http_about"); -$http->setDefaultCallback("_http_default", "custom data value"); - -$http->bind("0.0.0.0", 8010); -$base->loop(); -?> -]]> - - &example.outputs.similar; - - - - - - - &reftitle.seealso; - - - EventHttp::setDefaultCallback - - - - - diff --git a/reference/event/eventhttp/setdefaultcallback.xml b/reference/event/eventhttp/setdefaultcallback.xml deleted file mode 100644 index f6214c3c6e7c..000000000000 --- a/reference/event/eventhttp/setdefaultcallback.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - EventHttp::setDefaultCallback - Sets default callback to handle requests that are not caught by specific callbacks - - - &reftitle.description; - - public - void - EventHttp::setDefaultCallback - - string - cb - - - string - arg - - - - Sets default callback to handle requests that are not caught by specific - callbacks - - - - &reftitle.parameters; - - - - cb - - - - The callback - callable. - It should match the following prototype: - - - void - callback - - EventHttpRequest - req - NULL - - - mixed - arg - NULL - - - - - - req - - - - EventHttpRequest - object. - - - - - - arg - - - - Custom data. - - - - - - - - - arg - - - - User custom data passed to the callback. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - - <function>EventHttp::setDefaultCallback</function> example - -bind("127.0.0.1", 8088)) { - exit("bind(1) failed\n"); -}; - -$http->setDefaultCallback(function($req) { - echo "URI: ", $req->getUri(), PHP_EOL; - $req->sendReply(200, "OK"); -}); - -$base->dispatch(); -?> -]]> - - - - - &reftitle.seealso; - - - EventHttp::setCallback - - - - - diff --git a/reference/event/eventhttp/setmaxbodysize.xml b/reference/event/eventhttp/setmaxbodysize.xml deleted file mode 100644 index a6dc4a0b69d0..000000000000 --- a/reference/event/eventhttp/setmaxbodysize.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - EventHttp::setMaxBodySize - Sets maximum request body size - - - &reftitle.description; - - public - void - EventHttp::setMaxBodySize - - int - value - - - - Sets maximum request body size. - - - - &reftitle.parameters; - - - - value - - - - The body size in bytes. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EventHttp::setMaxHeadersSize - - - - - diff --git a/reference/event/eventhttp/setmaxheaderssize.xml b/reference/event/eventhttp/setmaxheaderssize.xml deleted file mode 100644 index 5a495361a625..000000000000 --- a/reference/event/eventhttp/setmaxheaderssize.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - EventHttp::setMaxHeadersSize - Sets maximum HTTP header size - - - &reftitle.description; - - public - void - EventHttp::setMaxHeadersSize - - int - value - - - - Sets maximum HTTP header size. - - - - &reftitle.parameters; - - - - value - - - - The header size in bytes. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EventHttp::setMaxHeadersSize - - - - - diff --git a/reference/event/eventhttp/settimeout.xml b/reference/event/eventhttp/settimeout.xml deleted file mode 100644 index 57bf0ba1b2e2..000000000000 --- a/reference/event/eventhttp/settimeout.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - EventHttp::setTimeout - Sets the timeout for an HTTP request - - - &reftitle.description; - - public - void - EventHttp::setTimeout - - int - value - - - - Sets the timeout for an HTTP request. - - - - &reftitle.parameters; - - - - value - - - - The timeout in seconds. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/event/eventhttpconnection.xml b/reference/event/eventhttpconnection.xml deleted file mode 100644 index 0bb34c4510be..000000000000 --- a/reference/event/eventhttpconnection.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - The EventHttpConnection class - EventHttpConnection - - -
- &reftitle.intro; - - Represents an HTTP connection. - -
- -
- &reftitle.classsynopsis; - - - - - EventHttpConnection - - - - - EventHttpConnection - - - - &Methods; - - - -
-
- - &reference.event.entities.eventhttpconnection; - -
- diff --git a/reference/event/eventhttpconnection/construct.xml b/reference/event/eventhttpconnection/construct.xml deleted file mode 100644 index c4daf0498dce..000000000000 --- a/reference/event/eventhttpconnection/construct.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - EventHttpConnection::__construct - Constructs EventHttpConnection object - - - &reftitle.description; - - public - EventHttpConnection::__construct - - EventBase - base - - - EventDnsBase - dns_base - - - string - address - - - int - port - - - EventSslContext - ctx - &null; - - - - Constructs EventHttpConnection object. - - - - &reftitle.parameters; - - - - base - - - - Associated event base. - - - - - - dns_base - - - - If - dns_base - is &null;, hostname resolution will block. - - - - - - address - - - - The address to connect to. - - - - - - port - - - - The port to connect to. - - - - - - ctx - - - - EventSslContext - class object. Enables OpenSSL. - - - - This parameter is available only if - Event - is compiled with OpenSSL support and only with - Libevent - 2.1.0-alpha - and higher. - - - - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL event 1.9.0 - - OpenSSL support (ctx) added. - - - - - - - - diff --git a/reference/event/eventhttpconnection/getbase.xml b/reference/event/eventhttpconnection/getbase.xml deleted file mode 100644 index af5b9a71e3ae..000000000000 --- a/reference/event/eventhttpconnection/getbase.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - EventHttpConnection::getBase - Returns event base associated with the connection - - - &reftitle.description; - - public - EventBase - EventHttpConnection::getBase - - - - Returns event base associated with the connection. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - On success returns - EventBase - object associated with the connection. Otherwise &false;. - - - - diff --git a/reference/event/eventhttpconnection/getpeer.xml b/reference/event/eventhttpconnection/getpeer.xml deleted file mode 100644 index a5169975692c..000000000000 --- a/reference/event/eventhttpconnection/getpeer.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - EventHttpConnection::getPeer - Gets the remote address and port associated with the connection - - - &reftitle.description; - - public - void - EventHttpConnection::getPeer - - string - address - - - int - port - - - - Gets the remote address and port associated with the connection - - - - &reftitle.parameters; - - - - address - - - - Address of the peer. - - - - - - port - - - - Port of the peer. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/event/eventhttpconnection/makerequest.xml b/reference/event/eventhttpconnection/makerequest.xml deleted file mode 100644 index 31748c8a2889..000000000000 --- a/reference/event/eventhttpconnection/makerequest.xml +++ /dev/null @@ -1,167 +0,0 @@ - - - - - EventHttpConnection::makeRequest - Makes an HTTP request over the specified connection - - - &reftitle.description; - - public - bool - EventHttpConnection::makeRequest - - EventHttpRequest - req - - - int - type - - - string - uri - - - - Makes an HTTP request over the specified connection. - type - is one of - EventHttpRequest::CMD_* - constants. - - - - &reftitle.parameters; - - - - req - - - - The connection object over which to send the request. - - - - - - type - - - - One of - - EventHttpRequest::CMD_* constants. - - - - - - uri - - - - The URI associated with the request. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - - <function>EventHttpConnection::makeRequest</function> example - -getResponseCode(); - - if ($response_code == 0) { - echo "Connection refused\n"; - } elseif ($response_code != 200) { - echo "Unexpected response: $response_code\n"; - } else { - echo "Success: $response_code\n"; - $buf = $req->getInputBuffer(); - echo "Body:\n"; - while ($s = $buf->readLine(EventBuffer::EOL_ANY)) { - echo $s, PHP_EOL; - } - } - } - - $base->exit(NULL); -} - -$address = "127.0.0.1"; -$port = 80; - -$base = new EventBase(); -$conn = new EventHttpConnection($base, NULL, $address, $port); -$conn->setTimeout(5); -$req = new EventHttpRequest("_request_handler", $base); - -$req->addHeader("Host", $address, EventHttpRequest::OUTPUT_HEADER); -$req->addHeader("Content-Length", "0", EventHttpRequest::OUTPUT_HEADER); -$conn->makeRequest($req, EventHttpRequest::CMD_GET, "/index.cphp"); - -$base->loop(); -?> -]]> - - &example.outputs.similar; - - - - - - - &reftitle.seealso; - - - EventHttpRequest::addHeader - - - - - diff --git a/reference/event/eventhttpconnection/setclosecallback.xml b/reference/event/eventhttpconnection/setclosecallback.xml deleted file mode 100644 index 8f7ce8990c06..000000000000 --- a/reference/event/eventhttpconnection/setclosecallback.xml +++ /dev/null @@ -1,194 +0,0 @@ - - - - - EventHttpConnection::setCloseCallback - Set callback for connection close - - - &reftitle.description; - - public - void - EventHttpConnection::setCloseCallback - - callable - callback - - - mixed - data - - - - Sets callback for connection close. - - - - &reftitle.parameters; - - - - callback - - - - Callback which is called when connection is closed. Should match the - following prototype: - - - void - callback - - EventHttpConnection - conn - &null; - - - mixed - arg - &null; - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.examples; - - - <methodname>EventHttpConnection::setCloseCallback</methodname> example - - - * - * 3) Terminate the client connection abruptly, - * i.e. kill the process, or just press Ctrl-C. - * - * 4) Check if the server called _close_callback. - * The script should output "_close_callback" string to standard output. - * - * 5) Check if the server's process has no orphaned connections, - * e.g. with `lsof` utility. - */ - -function _close_callback($conn) -{ - echo __FUNCTION__, PHP_EOL; -} - -function _http_default($req, $dummy) -{ - $conn = $req->getConnection(); - $conn->setCloseCallback('_close_callback', NULL); - - /* - By enabling Event::READ we protect the server against unclosed conections. - This is a peculiarity of Libevent. The library disables Event::READ events - on this connection, and the server is not notified about terminated - connections. - - So each time client terminates connection abruptly, we get an orphaned - connection. For instance, the following is a part of `lsof -p $PID | grep TCP` - command after client has terminated connection: - - 57-php 15057 ruslan 6u unix 0xffff8802fb59c780 0t0 125187 socket - 58:php 15057 ruslan 7u IPv4 125189 0t0 TCP *:4242 (LISTEN) - 59:php 15057 ruslan 8u IPv4 124342 0t0 TCP localhost:4242->localhost:37375 (CLOSE_WAIT) - - where $PID is our process ID. - - The following block of code fixes such kind of orphaned connections. - */ - $bev = $req->getBufferEvent(); - $bev->enable(Event::READ); - - // We have to free it explicitly. See EventHttpRequest::getConnection - $bev->free(); // we have to free it explicitly - - $req->addHeader( - 'Content-Type', - 'multipart/x-mixed-replace;boundary=boundarydonotcross', - EventHttpRequest::OUTPUT_HEADER - ); - - $buf = new EventBuffer(); - $buf->add(''); - - $req->sendReply(200, "OK"); - $req->sendReplyChunk($buf); -} - -$port = 4242; -if ($argc > 1) { - $port = (int) $argv[1]; -} -if ($port <= 0 || $port > 65535) { - exit("Invalid port"); -} - -$base = new EventBase(); -$http = new EventHttp($base); - -$http->setDefaultCallback("_http_default", NULL); -$http->bind("0.0.0.0", $port); -$base->loop(); - -?> -]]> - - - - - diff --git a/reference/event/eventhttpconnection/setlocaladdress.xml b/reference/event/eventhttpconnection/setlocaladdress.xml deleted file mode 100644 index 572c9dc7ea74..000000000000 --- a/reference/event/eventhttpconnection/setlocaladdress.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - EventHttpConnection::setLocalAddress - Sets the IP address from which HTTP connections are made - - - &reftitle.description; - - public - void - EventHttpConnection::setLocalAddress - - string - address - - - - Sets the IP address from which http connections are made. - - - - &reftitle.parameters; - - - - address - - - - The IP address from which HTTP connections are made. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EventHttpConnection::setLocalPort - - - - - diff --git a/reference/event/eventhttpconnection/setlocalport.xml b/reference/event/eventhttpconnection/setlocalport.xml deleted file mode 100644 index fbbbe9a0d060..000000000000 --- a/reference/event/eventhttpconnection/setlocalport.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - EventHttpConnection::setLocalPort - Sets the local port from which connections are made - - - &reftitle.description; - - public - void - EventHttpConnection::setLocalPort - - int - port - - - - Sets the local port from which connections are made. - - - - &reftitle.parameters; - - - - port - - - - The port number. - - - - - - - &reftitle.returnvalues; - - - - &reftitle.seealso; - - - EventHttpConnection::setLocalAddress - - - - - diff --git a/reference/event/eventhttpconnection/setmaxbodysize.xml b/reference/event/eventhttpconnection/setmaxbodysize.xml deleted file mode 100644 index 2e29355cfcaf..000000000000 --- a/reference/event/eventhttpconnection/setmaxbodysize.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - EventHttpConnection::setMaxBodySize - Sets maximum body size for the connection - - - &reftitle.description; - - public - void - EventHttpConnection::setMaxBodySize - - string - max_size - - - - Sets maximum body size for the connection. - - - - &reftitle.parameters; - - - - max_size - - - - The maximum body size in bytes. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EventHttpConnection::setMaxHeadersSize - - - - - diff --git a/reference/event/eventhttpconnection/setmaxheaderssize.xml b/reference/event/eventhttpconnection/setmaxheaderssize.xml deleted file mode 100644 index d3d0ebe7eaff..000000000000 --- a/reference/event/eventhttpconnection/setmaxheaderssize.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - EventHttpConnection::setMaxHeadersSize - Sets maximum header size - - - &reftitle.description; - - public - void - EventHttpConnection::setMaxHeadersSize - - string - max_size - - - - Sets maximum header size for the connection. - - - - &reftitle.parameters; - - - - max_size - - - - The maximum header size in bytes. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EventHttpConnection::setMaxBodySize - - - - - diff --git a/reference/event/eventhttpconnection/setretries.xml b/reference/event/eventhttpconnection/setretries.xml deleted file mode 100644 index ecc7658f4bdf..000000000000 --- a/reference/event/eventhttpconnection/setretries.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - EventHttpConnection::setRetries - Sets the retry limit for the connection - - - &reftitle.description; - - public - void - EventHttpConnection::setRetries - - int - retries - - - - Sets the retry limit for the connection - - - - &reftitle.parameters; - - - - retries - - - - The retry limit. - -1 - means infinity. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/event/eventhttpconnection/settimeout.xml b/reference/event/eventhttpconnection/settimeout.xml deleted file mode 100644 index d35e955a49fa..000000000000 --- a/reference/event/eventhttpconnection/settimeout.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - EventHttpConnection::setTimeout - Sets the timeout for the connection - - - &reftitle.description; - - public - void - EventHttpConnection::setTimeout - - int - timeout - - - - Sets the timeout for the connection - - - - &reftitle.parameters; - - - - timeout - - - - Timeout in seconds. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/event/eventhttprequest.xml b/reference/event/eventhttprequest.xml deleted file mode 100644 index dde0335758ca..000000000000 --- a/reference/event/eventhttprequest.xml +++ /dev/null @@ -1,243 +0,0 @@ - - - - The EventHttpRequest class - EventHttpRequest - - -
- &reftitle.intro; - - Represents an HTTP request. - -
- -
- &reftitle.classsynopsis; - - - - - EventHttpRequest - - - - - EventHttpRequest - - - - &Constants; - - const - int - EventHttpRequest::CMD_GET - 1 - - - const - int - EventHttpRequest::CMD_POST - 2 - - - const - int - EventHttpRequest::CMD_HEAD - 4 - - - const - int - EventHttpRequest::CMD_PUT - 8 - - - const - int - EventHttpRequest::CMD_DELETE - 16 - - - const - int - EventHttpRequest::CMD_OPTIONS - 32 - - - const - int - EventHttpRequest::CMD_TRACE - 64 - - - const - int - EventHttpRequest::CMD_CONNECT - 128 - - - const - int - EventHttpRequest::CMD_PATCH - 256 - - - const - int - EventHttpRequest::INPUT_HEADER - 1 - - - const - int - EventHttpRequest::OUTPUT_HEADER - 2 - - &Methods; - - - -
- -
- &reftitle.constants; - - - - EventHttpRequest::CMD_GET - - - - GET method(command) - - - - - - EventHttpRequest::CMD_POST - - - - POST method(command) - - - - - - EventHttpRequest::CMD_HEAD - - - - HEAD method(command) - - - - - - EventHttpRequest::CMD_PUT - - - - PUT method(command) - - - - - - EventHttpRequest::CMD_DELETE - - - - DELETE command(method) - - - - - - EventHttpRequest::CMD_OPTIONS - - - - OPTIONS method(command) - - - - - - EventHttpRequest::CMD_TRACE - - - - TRACE method(command) - - - - - - EventHttpRequest::CMD_CONNECT - - - - CONNECT method(command) - - - - - - EventHttpRequest::CMD_PATCH - - - - PATCH method(command) - - - - - - EventHttpRequest::INPUT_HEADER - - - - Request input header type. - - - - - - EventHttpRequest::OUTPUT_HEADER - - - - Request output header type. - - - - -
- -
- - &reference.event.entities.eventhttprequest; - -
- diff --git a/reference/event/eventhttprequest/addheader.xml b/reference/event/eventhttprequest/addheader.xml deleted file mode 100644 index 87ab25beb537..000000000000 --- a/reference/event/eventhttprequest/addheader.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - EventHttpRequest::addHeader - Adds an HTTP header to the headers of the request - - - &reftitle.description; - - public - bool - EventHttpRequest::addHeader - - string - key - - - string - value - - - int - type - - - - Adds an HTTP header to the headers of the request. - - - - &reftitle.parameters; - - - - key - - - - Header name. - - - - - - value - - - - Header value. - - - - - - type - - - - One of - - EventHttpRequest::*_HEADER constants. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventHttpRequest::removeHeader - - - - - diff --git a/reference/event/eventhttprequest/cancel.xml b/reference/event/eventhttprequest/cancel.xml deleted file mode 100644 index 0c9caf495132..000000000000 --- a/reference/event/eventhttprequest/cancel.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - EventHttpRequest::cancel - Cancels a pending HTTP request - - - &reftitle.description; - - public - void - EventHttpRequest::cancel - - - - Cancels a pending HTTP request. - - - Cancels an ongoing HTTP request. The callback associated with this request - is not executed and the request object is freed. If the request is - currently being processed, e.g. it is ongoing, the corresponding - EventHttpConnection - object is going to get reset. - - - A request cannot be canceled if its callback has executed already. A - request may be canceled reentrantly from its chunked callback. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/event/eventhttprequest/clearheaders.xml b/reference/event/eventhttprequest/clearheaders.xml deleted file mode 100644 index 66cf80d5bb49..000000000000 --- a/reference/event/eventhttprequest/clearheaders.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - EventHttpRequest::clearHeaders - Removes all output headers from the header list of the request - - - &reftitle.description; - - public - void - EventHttpRequest::clearHeaders - - - - Removes all output headers from the header list of the request. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EventHttpRequest::addHeader - - - - - diff --git a/reference/event/eventhttprequest/closeconnection.xml b/reference/event/eventhttprequest/closeconnection.xml deleted file mode 100644 index 9680738722c4..000000000000 --- a/reference/event/eventhttprequest/closeconnection.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - EventHttpRequest::closeConnection - Closes associated HTTP connection - - - &reftitle.description; - - public - void - EventHttpRequest::closeConnection - - - - Closes HTTP connection associated with the request. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/event/eventhttprequest/construct.xml b/reference/event/eventhttprequest/construct.xml deleted file mode 100644 index 83197135ac45..000000000000 --- a/reference/event/eventhttprequest/construct.xml +++ /dev/null @@ -1,153 +0,0 @@ - - - - - EventHttpRequest::__construct - Constructs EventHttpRequest object - - - &reftitle.description; - - public - EventHttpRequest::__construct - - callable - callback - - - mixed - data - &null; - - - - Constructs EventHttpRequest object. - - - - &reftitle.parameters; - - - - callback - - - - Gets invoked on requesting path. Should match the following prototype: - - - void - callback - - EventHttpRequest - req - &null; - - - mixed - arg - &null; - - - - - - - data - - - - User custom data passed to the callback. - - - - - - - &reftitle.examples; - - - <function>EventHttpRequest::__construct</function> example - -getResponseCode(); - - if ($response_code == 0) { - echo "Connection refused\n"; - } elseif ($response_code != 200) { - echo "Unexpected response: $response_code\n"; - } else { - echo "Success: $response_code\n"; - $buf = $req->getInputBuffer(); - echo "Body:\n"; - while ($s = $buf->readLine(EventBuffer::EOL_ANY)) { - echo $s, PHP_EOL; - } - } - } - - $base->exit(NULL); -} - - -$address = "127.0.0.1"; -$port = 80; - -$base = new EventBase(); -$conn = new EventHttpConnection($base, NULL, $address, $port); -$conn->setTimeout(5); -$req = new EventHttpRequest("_request_handler", $base); - -$req->addHeader("Host", $address, EventHttpRequest::OUTPUT_HEADER); -$req->addHeader("Content-Length", "0", EventHttpRequest::OUTPUT_HEADER); -$conn->makeRequest($req, EventHttpRequest::CMD_GET, "/index.cphp"); - -$base->loop(); -?> -]]> - - - - - &reftitle.seealso; - - - EventHttpRequest::cancel - - - EventHttpRequest::addHeader - - - - - diff --git a/reference/event/eventhttprequest/findheader.xml b/reference/event/eventhttprequest/findheader.xml deleted file mode 100644 index 2afca304bb78..000000000000 --- a/reference/event/eventhttprequest/findheader.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - EventHttpRequest::findHeader - Finds the value belonging to a header - - - &reftitle.description; - - public - void - EventHttpRequest::findHeader - - string - key - - - string - type - - - - Finds the value belonging to a header. - - - - &reftitle.parameters; - - - - key - - - - The header name. - - - - - - type - - - - One of - - EventHttpRequest::*_HEADER constants. - - - - - - - &reftitle.returnvalues; - - Returns &null; if header not found. - - - - &reftitle.seealso; - - - EventHttpRequest::addHeader - - - - - diff --git a/reference/event/eventhttprequest/free.xml b/reference/event/eventhttprequest/free.xml deleted file mode 100644 index 195c02eb6ea7..000000000000 --- a/reference/event/eventhttprequest/free.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - EventHttpRequest::free - Frees the object and removes associated events - - - &reftitle.description; - - public - void - EventHttpRequest::free - - - - Frees the object and removes associated events. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/event/eventhttprequest/getbufferevent.xml b/reference/event/eventhttprequest/getbufferevent.xml deleted file mode 100644 index d2adb9b35276..000000000000 --- a/reference/event/eventhttprequest/getbufferevent.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - EventHttpRequest::getBufferEvent - Returns EventBufferEvent object - - - &reftitle.description; - - public - EventBufferEvent - EventHttpRequest::getBufferEvent - - - - Returns - EventBufferEvent - object which represents buffer event that the connection is using. - - - - The reference counter of the returned object will be incremented by one to - protect internal structures against premature destruction when the method - is called from a user callback. So the - EventBufferEvent object should be freed explicitly - with EventBufferEvent::free method. - Otherwise memory will leak. - - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Returns - EventBufferEvent - object. - - - - &reftitle.seealso; - - - EventHttpRequest::getConnection - - - - - diff --git a/reference/event/eventhttprequest/getcommand.xml b/reference/event/eventhttprequest/getcommand.xml deleted file mode 100644 index 751a66560c9e..000000000000 --- a/reference/event/eventhttprequest/getcommand.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - EventHttpRequest::getCommand - Returns the request command(method) - - - &reftitle.description; - - public - void - EventHttpRequest::getCommand - - - - Returns the request command, one of - - EventHttpRequest::CMD_* - - constants. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Returns the request command, one of - - EventHttpRequest::CMD_* - - constants. - - - - diff --git a/reference/event/eventhttprequest/getconnection.xml b/reference/event/eventhttprequest/getconnection.xml deleted file mode 100644 index 550a54c55990..000000000000 --- a/reference/event/eventhttprequest/getconnection.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - EventHttpRequest::getConnection - Returns EventHttpConnection object - - - &reftitle.description; - - public - EventHttpConnection - EventHttpRequest::closeConnection - - - - Returns - EventHttpConnection - object which represents HTTP connection associated with the request. - - - - Libevent API allows HTTP request objects to be not bound to any HTTP - connection. Therefore we can't unambiguously associate - EventHttpRequest - with - EventHttpConnection. - Thus, we construct - EventHttpConnection - object on-the-fly. Having no information about the event base, DNS base - and connection-close callback, we just leave these fields unset. - - - - EventHttpRequest::getConnection - method is usually useful when we need to set up a callback on connection - close. See - EventHttpConnection::setCloseCallback. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Returns - EventHttpConnection - object. - - - - &reftitle.seealso; - - - EventHttpConnection::setCloseCallback - - - EventHttpRequest::getBufferEvent - - - - - diff --git a/reference/event/eventhttprequest/gethost.xml b/reference/event/eventhttprequest/gethost.xml deleted file mode 100644 index 5a0145d6fa3e..000000000000 --- a/reference/event/eventhttprequest/gethost.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - EventHttpRequest::getHost - Returns the request host - - - &reftitle.description; - - public - string - EventHttpRequest::getHost - - - - Returns the request host. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Returns the request host. - - - - &reftitle.seealso; - - - EventHttpRequest::getUri - - - EventHttpRequest::getCommand - - - - - diff --git a/reference/event/eventhttprequest/getinputbuffer.xml b/reference/event/eventhttprequest/getinputbuffer.xml deleted file mode 100644 index 7e74a94c47b4..000000000000 --- a/reference/event/eventhttprequest/getinputbuffer.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - EventHttpRequest::getInputBuffer - Returns the input buffer - - - &reftitle.description; - - public - EventBuffer - EventHttpRequest::getInputBuffer - - - - Returns the input buffer. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Returns the input buffer. - - - - &reftitle.seealso; - - - EventHttpRequest::getOutputBuffer - - - - - diff --git a/reference/event/eventhttprequest/getinputheaders.xml b/reference/event/eventhttprequest/getinputheaders.xml deleted file mode 100644 index 3a649bb2afa0..000000000000 --- a/reference/event/eventhttprequest/getinputheaders.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - EventHttpRequest::getInputHeaders - Returns associative array of the input headers - - - &reftitle.description; - - public - array - EventHttpRequest::getInputHeaders - - - - Returns associative array of the input headers. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Returns associative array of the input headers. - - - - &reftitle.seealso; - - - EventHttpRequest::getOutputHeaders - - - - - diff --git a/reference/event/eventhttprequest/getoutputbuffer.xml b/reference/event/eventhttprequest/getoutputbuffer.xml deleted file mode 100644 index 6917d66af816..000000000000 --- a/reference/event/eventhttprequest/getoutputbuffer.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - EventHttpRequest::getOutputBuffer - Returns the output buffer of the request - - - &reftitle.description; - - public - EventBuffer - EventHttpRequest::getOutputBuffer - - - - Returns the output buffer of the request. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Returns the output buffer of the request. - - - - &reftitle.seealso; - - - EventHttpRequest::getInputBuffer - - - - - diff --git a/reference/event/eventhttprequest/getoutputheaders.xml b/reference/event/eventhttprequest/getoutputheaders.xml deleted file mode 100644 index df32a306616c..000000000000 --- a/reference/event/eventhttprequest/getoutputheaders.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - EventHttpRequest::getOutputHeaders - Returns associative array of the output headers - - - &reftitle.description; - - public - void - EventHttpRequest::getOutputHeaders - - - - Returns associative array of the output headers. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - - - &reftitle.seealso; - - - EventHttpRequest::getInputHeaders - - - - - diff --git a/reference/event/eventhttprequest/getresponsecode.xml b/reference/event/eventhttprequest/getresponsecode.xml deleted file mode 100644 index c566243f46fc..000000000000 --- a/reference/event/eventhttprequest/getresponsecode.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - EventHttpRequest::getResponseCode - Returns the response code - - - &reftitle.description; - - public - int - EventHttpRequest::getResponseCode - - - - Returns the response code. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Returns the response code of the request. - - - - &reftitle.seealso; - - - EventHttpRequest::getCommand - - - EventHttpRequest::getHost - - - EventHttpRequest::getUri - - - - - diff --git a/reference/event/eventhttprequest/geturi.xml b/reference/event/eventhttprequest/geturi.xml deleted file mode 100644 index 8945815f47e6..000000000000 --- a/reference/event/eventhttprequest/geturi.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - EventHttpRequest::getUri - Returns the request URI - - - &reftitle.description; - - public - string - EventHttpRequest::getUri - - - - Returns the request URI - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Returns the request URI - - - - &reftitle.seealso; - - - EventHttpRequest::getCommand - - - EventHttpRequest::getHost - - - EventHttpRequest::getResponseCode - - - - - diff --git a/reference/event/eventhttprequest/removeheader.xml b/reference/event/eventhttprequest/removeheader.xml deleted file mode 100644 index 8deb1275ddcd..000000000000 --- a/reference/event/eventhttprequest/removeheader.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - EventHttpRequest::removeHeader - Removes an HTTP header from the headers of the request - - - &reftitle.description; - - public - void - EventHttpRequest::removeHeader - - string - key - - - string - type - - - - Removes an HTTP header from the headers of the request. - - - - &reftitle.parameters; - - - - key - - - - The header name. - - - - - - type - - - - type - is one of - EventHttpRequest::*_HEADER - constants. - - - - - - - &reftitle.returnvalues; - - Removes an HTTP header from the headers of the request. - - - - &reftitle.seealso; - - - EventHttpRequest::addHeader - - - - - diff --git a/reference/event/eventhttprequest/senderror.xml b/reference/event/eventhttprequest/senderror.xml deleted file mode 100644 index 44056d03a00b..000000000000 --- a/reference/event/eventhttprequest/senderror.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - EventHttpRequest::sendError - Send an HTML error message to the client - - - &reftitle.description; - - public - void - EventHttpRequest::sendError - - int - error - - - string - reason - &null; - - - - Send an HTML error message to the client. - - - - &reftitle.parameters; - - - - error - - - - The HTTP error code. - - - - - - reason - - - - A brief explanation of the error. If &null;, the standard meaning of the - error code will be used. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.examples; - - - <function>EventHttpRequest::sendError</function> example - -sendError(400); -} - -$base = new EventBase(); -$http = new EventHttp($base); - -$http->setCallback("/err400", "_http_400"); - -$http->bind("0.0.0.0", 8010); -$base->loop(); -?> -]]> - - - - - &reftitle.seealso; - - - EventHttpRequest::sendReply - - - - - diff --git a/reference/event/eventhttprequest/sendreply.xml b/reference/event/eventhttprequest/sendreply.xml deleted file mode 100644 index 9054c9d83e20..000000000000 --- a/reference/event/eventhttprequest/sendreply.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - EventHttpRequest::sendReply - Send an HTML reply to the client - - - &reftitle.description; - - public - void - EventHttpRequest::sendReply - - int - code - - - string - reason - - - EventBuffer - buf - - - - Send an HTML reply to the client. The body of the reply consists of data in - optional - buf - parameter. - - - - &reftitle.parameters; - - - - code - - - - The HTTP response code to send. - - - - - - reason - - - - A brief message to send with the response code. - - - - - - buf - - - - The body of the response. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EventHttpRequest::sendError - - - EventHttpRequest::sendReplyChunk - - - - - diff --git a/reference/event/eventhttprequest/sendreplychunk.xml b/reference/event/eventhttprequest/sendreplychunk.xml deleted file mode 100644 index a326a8d96462..000000000000 --- a/reference/event/eventhttprequest/sendreplychunk.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - EventHttpRequest::sendReplyChunk - Send another data chunk as part of an ongoing chunked reply - - - &reftitle.description; - - public - void - EventHttpRequest::sendReplyChunk - - EventBuffer - buf - - - - Send another data chunk as part of an ongoing chunked reply. After calling - this method - buf - will be empty. - - - - &reftitle.parameters; - - - - buf - - - - The data chunk to send as part of the reply. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EventHttpRequest::sendReplyStart - - - EventHttpRequest::sendReplyEnd - - - - - diff --git a/reference/event/eventhttprequest/sendreplyend.xml b/reference/event/eventhttprequest/sendreplyend.xml deleted file mode 100644 index 232b3629710e..000000000000 --- a/reference/event/eventhttprequest/sendreplyend.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - EventHttpRequest::sendReplyEnd - Complete a chunked reply, freeing the request as appropriate - - - &reftitle.description; - - public - void - EventHttpRequest::sendReplyEnd - - - - Complete a chunked reply, freeing the request as appropriate. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EventHttpRequest::sendReplyStart - - - EventHttpRequest::sendReplyChunk - - - - - diff --git a/reference/event/eventhttprequest/sendreplystart.xml b/reference/event/eventhttprequest/sendreplystart.xml deleted file mode 100644 index 76bd61796a5f..000000000000 --- a/reference/event/eventhttprequest/sendreplystart.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - EventHttpRequest::sendReplyStart - Initiate a chunked reply - - - &reftitle.description; - - public - void - EventHttpRequest::sendReplyStart - - int - code - - - string - reason - - - - Initiate a reply that uses - Transfer-Encoding - chunked. - - - This allows the caller to stream the reply back to the client and is useful - when either not all of the reply data is immediately available or when - sending very large replies. - - - The caller needs to supply data chunks with - EventHttpRequest::sendReplyChunk - and complete the reply by calling - EventHttpRequest::sendReplyEnd. - - - - &reftitle.parameters; - - - - code - - - - The HTTP response code to send. - - - - - - reason - - - - A brief message to send with the response code. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EventHttpRequest::sendReplyChunk - - - EventHttpRequest::sendReplyEnd - - - - - diff --git a/reference/event/eventlistener.xml b/reference/event/eventlistener.xml deleted file mode 100644 index 273ebd25dadc..000000000000 --- a/reference/event/eventlistener.xml +++ /dev/null @@ -1,187 +0,0 @@ - - - - The EventListener class - EventListener - - -
- &reftitle.intro; - - Represents a connection listener. - -
- -
- &reftitle.classsynopsis; - - - - - EventListener - - - - - final - EventListener - - - - &Constants; - - const - int - EventListener::OPT_LEAVE_SOCKETS_BLOCKING - 1 - - - const - int - EventListener::OPT_CLOSE_ON_FREE - 2 - - - const - int - EventListener::OPT_CLOSE_ON_EXEC - 4 - - - const - int - EventListener::OPT_REUSEABLE - 8 - - - const - int - EventListener::OPT_THREADSAFE - 16 - - &Properties; - - public - readonly - int - fd - - &Methods; - - - -
-
- &reftitle.properties; - - - - fd - - - - Numeric file descriptor of the underlying socket. (Added in - event-1.6.0 - .) - - - - -
- -
- &reftitle.constants; - - - - EventListener::OPT_LEAVE_SOCKETS_BLOCKING - - - - By default Libevent turns underlying file descriptors, or sockets, to - non-blocking mode. This flag tells Libevent to leave them in blocking - mode. - - - - - - EventListener::OPT_CLOSE_ON_FREE - - - - If this option is set, the connection listener closes its underlying - socket when the - EventListener - object is freed. - - - - - - EventListener::OPT_CLOSE_ON_EXEC - - - - If this option is set, the connection listener sets the close-on-exec - flag on the underlying listener socket. See platform documentation for - fcntl - and - FD_CLOEXEC - for more information. - - - - - - EventListener::OPT_REUSEABLE - - - - By default on some platforms, once a listener socket is closed, no - other socket can bind to the same port until a while has passed. - Setting this option makes Libevent mark the socket as reusable, so that - once it is closed, another socket can be opened to listen on the same - port. - - - - - - EventListener::OPT_THREADSAFE - - - - Allocate locks for the listener, so that it’s safe to use it from - multiple threads. - - - - -
- -
- - &reference.event.entities.eventlistener; - -
- diff --git a/reference/event/eventlistener/construct.xml b/reference/event/eventlistener/construct.xml deleted file mode 100644 index af918584b540..000000000000 --- a/reference/event/eventlistener/construct.xml +++ /dev/null @@ -1,324 +0,0 @@ - - - - - EventListener::__construct - Creates new connection listener associated with an event base - - - &reftitle.description; - - public - EventListener::__construct - - EventBase - base - - - callable - cb - - - mixed - data - - - int - flags - - - int - backlog - - - mixed - target - - - - Creates new connection listener associated with an event base. - - - - &reftitle.parameters; - - - - base - - - - Associated event base. - - - - - - cb - - - - A - callable - that will be invoked when new connection received. - - - - - - data - - - - Custom user data attached to - cb. - - - - - - flags - - - - Bit mask of - EventListener::OPT_* - constants. See - EventListener constants. - - - - - - backlog - - - - Controls the maximum number of pending connections that the network - stack should allow to wait in a not-yet-accepted state at any time; see - documentation for your system’s - listen - function for more details. If - backlog - is negative, Libevent tries to pick a good value for the - backlog - ; if it is zero, Event assumes that - listen - is already called on the socket (target). - - - - - - target - - - - May be string, socket resource, or a stream associated with a socket. In - case if - target - is a string, the string will be parsed as network address. It will be - interpreted as a UNIX domain socket path, if prefixed with - 'unix:', - e.g. - 'unix:/tmp/my.sock'. - - - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL event 1.5.0 - - UNIX domain sockets' support added. - - - - - - - - &reftitle.examples; - - - <function>EventListener::__construct</function> example - -bev->free(); - } - - public function __construct($base, $fd) { - $this->base = $base; - - $this->bev = new EventBufferEvent($base, $fd, EventBufferEvent::OPT_CLOSE_ON_FREE); - - $this->bev->setCallbacks(array($this, "echoReadCallback"), NULL, - array($this, "echoEventCallback"), NULL); - - if (!$this->bev->enable(Event::READ)) { - echo "Failed to enable READ\n"; - return; - } - } - - public function echoReadCallback($bev, $ctx) { - // Copy all the data from the input buffer to the output buffer - - // Variant #1 - $bev->output->addBuffer($bev->input); - - /* Variant #2 */ - /* - $input = $bev->getInput(); - $output = $bev->getOutput(); - $output->addBuffer($input); - */ - } - - public function echoEventCallback($bev, $events, $ctx) { - if ($events & EventBufferEvent::ERROR) { - echo "Error from bufferevent\n"; - } - - if ($events & (EventBufferEvent::EOF | EventBufferEvent::ERROR)) { - //$bev->free(); - $this->__destruct(); - } - } -} - -class MyListener { - public $base, - $listener, - $socket; - private $conn = array(); - - public function __destruct() { - foreach ($this->conn as &$c) $c = NULL; - } - - public function __construct($port) { - $this->base = new EventBase(); - if (!$this->base) { - echo "Couldn't open event base"; - exit(1); - } - - // Variant #1 - /* - $this->socket = socket_create(AF_INET, SOCK_STREAM, SOL_TCP); - if (!socket_bind($this->socket, '0.0.0.0', $port)) { - echo "Unable to bind socket\n"; - exit(1); - } - $this->listener = new EventListener($this->base, - array($this, "acceptConnCallback"), $this->base, - EventListener::OPT_CLOSE_ON_FREE | EventListener::OPT_REUSEABLE, - -1, $this->socket); - */ - - // Variant #2 - $this->listener = new EventListener($this->base, - array($this, "acceptConnCallback"), $this->base, - EventListener::OPT_CLOSE_ON_FREE | EventListener::OPT_REUSEABLE, -1, - "0.0.0.0:$port"); - - if (!$this->listener) { - echo "Couldn't create listener"; - exit(1); - } - - $this->listener->setErrorCallback(array($this, "accept_error_cb")); - } - - public function dispatch() { - $this->base->dispatch(); - } - - // This callback is invoked when there is data to read on $bev - public function acceptConnCallback($listener, $fd, $address, $ctx) { - // We got a new connection! Set up a bufferevent for it. */ - $base = $this->base; - $this->conn[] = new MyListenerConnection($base, $fd); - } - - public function accept_error_cb($listener, $ctx) { - $base = $this->base; - - fprintf(STDERR, "Got an error %d (%s) on the listener. " - ."Shutting down.\n", - EventUtil::getLastSocketErrno(), - EventUtil::getLastSocketError()); - - $base->exit(NULL); - } -} - -$port = 9808; - -if ($argc > 1) { - $port = (int) $argv[1]; -} -if ($port <= 0 || $port > 65535) { - exit("Invalid port"); -} - -$l = new MyListener($port); -$l->dispatch(); -?> -]]> - - - - - diff --git a/reference/event/eventlistener/disable.xml b/reference/event/eventlistener/disable.xml deleted file mode 100644 index e39fe8efb43c..000000000000 --- a/reference/event/eventlistener/disable.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - EventListener::disable - Disables an event connect listener object - - - &reftitle.description; - - public - bool - EventListener::disable - - - - Disables an event connect listener object - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventListener::enable - - - - - diff --git a/reference/event/eventlistener/enable.xml b/reference/event/eventlistener/enable.xml deleted file mode 100644 index 7ccfad89f10f..000000000000 --- a/reference/event/eventlistener/enable.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - EventListener::enable - Enables an event connect listener object - - - &reftitle.description; - - public - bool - EventListener::enable - - - - Enables an event connect listener object - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventListener::disable - - - - - diff --git a/reference/event/eventlistener/getbase.xml b/reference/event/eventlistener/getbase.xml deleted file mode 100644 index a59202d8b5f5..000000000000 --- a/reference/event/eventlistener/getbase.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - EventListener::getBase - Returns event base associated with the event listener - - - &reftitle.description; - - public - void - EventListener::getBase - - - - Returns event base associated with the event listener. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Returns event base associated with the event listener. - - - - diff --git a/reference/event/eventlistener/getsocketname.xml b/reference/event/eventlistener/getsocketname.xml deleted file mode 100644 index fdeec7973603..000000000000 --- a/reference/event/eventlistener/getsocketname.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - EventListener::getSocketName - Retrieves the current address to which the - listener's socket is bound - - - &reftitle.description; - - public - static - bool - EventListener::getSocketName - - string - address - - - mixed - port - - - - Retrieves the current address to which the listener's socket is bound. - - - - &reftitle.parameters; - - - - address - - - - Output parameter. IP-address depending on the socket address family. - - - - - - port - - - - Output parameter. The port the socket is bound to. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/event/eventlistener/setcallback.xml b/reference/event/eventlistener/setcallback.xml deleted file mode 100644 index f941b9e43a54..000000000000 --- a/reference/event/eventlistener/setcallback.xml +++ /dev/null @@ -1,153 +0,0 @@ - - - - - EventListener::setCallback - The setCallback purpose - - - &reftitle.description; - - public - void - EventListener::setCallback - - callable - cb - - - mixed - arg - &null; - - - - Adjust event connect listener's callback and optionally the callback - argument. - - - - &reftitle.parameters; - - - - cb - - - - The new callback for new connections. Ignored if &null;. - - - Should match the following prototype: - - - void - callback - - EventListener - listener - &null; - - - mixed - fd - &null; - - - array - address - &null; - - - mixed - arg - &null; - - - - - - listener - - - - The - EventListener - object. - - - - - - fd - - - - The file descriptor or a resource associated with the listener. - - - - - - address - - - - Array of two elements: IP address and the - server - port. - - - - - - arg - - - - User custom data attached to the callback. - - - - - - - - - arg - - - - Custom user data attached to the callback. Ignored if &null;. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/event/eventlistener/seterrorcallback.xml b/reference/event/eventlistener/seterrorcallback.xml deleted file mode 100644 index 49e728e58708..000000000000 --- a/reference/event/eventlistener/seterrorcallback.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - EventListener::setErrorCallback - Set event listener's error callback - - - &reftitle.description; - - public - void - EventListener::setErrorCallback - - string - cb - - - - Set event listener's error callback - - - - &reftitle.parameters; - - - - cb - - - - The error callback. Should match the following prototype: - - - void - callback - - EventListener - listener - &null; - - - mixed - data - &null; - - - - - - listener - - - - The - EventListener - object. - - - - - - data - - - - User custom data attached to the callback. - - - - - - - - - - &reftitle.returnvalues; - - - - &reftitle.seealso; - - - EventListener::setCallback - - - - - diff --git a/reference/event/eventsslcontext.xml b/reference/event/eventsslcontext.xml deleted file mode 100644 index 846b048bb0b0..000000000000 --- a/reference/event/eventsslcontext.xml +++ /dev/null @@ -1,418 +0,0 @@ - - - - The EventSslContext class - EventSslContext - - -
- &reftitle.intro; - - Represents - SSL_CTX - structure. Provides methods and properties to configure the SSL context. - -
- -
- &reftitle.classsynopsis; - - - - - EventSslContext - - - - - final - EventSslContext - - - - &Constants; - - const - int - EventSslContext::SSLv2_CLIENT_METHOD - 1 - - - const - int - EventSslContext::SSLv3_CLIENT_METHOD - 2 - - - const - int - EventSslContext::SSLv23_CLIENT_METHOD - 3 - - - const - int - EventSslContext::TLS_CLIENT_METHOD - 4 - - - const - int - EventSslContext::SSLv2_SERVER_METHOD - 5 - - - const - int - EventSslContext::SSLv3_SERVER_METHOD - 6 - - - const - int - EventSslContext::SSLv23_SERVER_METHOD - 7 - - - const - int - EventSslContext::TLS_SERVER_METHOD - 8 - - - const - int - EventSslContext::OPT_LOCAL_CERT - 1 - - - const - int - EventSslContext::OPT_LOCAL_PK - 2 - - - const - int - EventSslContext::OPT_PASSPHRASE - 3 - - - const - int - EventSslContext::OPT_CA_FILE - 4 - - - const - int - EventSslContext::OPT_CA_PATH - 5 - - - const - int - EventSslContext::OPT_ALLOW_SELF_SIGNED - 6 - - - const - int - EventSslContext::OPT_VERIFY_PEER - 7 - - - const - int - EventSslContext::OPT_VERIFY_DEPTH - 8 - - - const - int - EventSslContext::OPT_CIPHERS - 9 - - &Properties; - - public - string - local_cert - - - public - string - local_pk - - &Methods; - - - -
- -
- &reftitle.properties; - - - - local_cert - - - - Path to local certificate file on filesystem. It must be a PEM-encoded - file which contains certificate. It can optionally contain the - certificate chain of issuers. - - - - - - local_pk - - - - Path to local private key file - - - - -
- - -
- &reftitle.constants; - - - - EventSslContext::SSLv2_CLIENT_METHOD - - - - SSLv2 client method. See - SSL_CTX_new(3) - man page. - - - - - - EventSslContext::SSLv3_CLIENT_METHOD - - - - SSLv3 client method. See - SSL_CTX_new(3) - man page. - - - - - - EventSslContext::SSLv23_CLIENT_METHOD - - - - SSLv23 client method. See - SSL_CTX_new(3) - man page. - - - - - - EventSslContext::TLS_CLIENT_METHOD - - - - TLS client method. See - SSL_CTX_new(3) - man page. - - - - - - EventSslContext::SSLv2_SERVER_METHOD - - - - SSLv2 server method. See - SSL_CTX_new(3) - man page. - - - - - - EventSslContext::SSLv3_SERVER_METHOD - - - - SSLv3 server method. See - SSL_CTX_new(3) - man page. - - - - - - EventSslContext::SSLv23_SERVER_METHOD - - - - SSLv23 server method. See - SSL_CTX_new(3) - man page. - - - - - - EventSslContext::TLS_SERVER_METHOD - - - - TLS server method. See - SSL_CTX_new(3) - man page. - - - - - - EventSslContext::OPT_LOCAL_CERT - - - - Key for an item of the options' array used in - EventSslContext::__construct. - The option points to path of local certificate. - - - - - - EventSslContext::OPT_LOCAL_PK - - - - Key for an item of the options' array used in - EventSslContext::__construct. - The option points to path of the private key. - - - - - - EventSslContext::OPT_PASSPHRASE - - - - Key for an item of the options' array used in - EventSslContext::__construct. - Represents passphrase of the certificate. - - - - - - EventSslContext::OPT_CA_FILE - - - - Key for an item of the options' array used in - EventSslContext::__construct. - Represents path of the certificate authority file. - - - - - - EventSslContext::OPT_CA_PATH - - - - Key for an item of the options' array used in - EventSslContext::__construct. - Represents path where the certificate authority file should be - searched for. - - - - - - EventSslContext::OPT_ALLOW_SELF_SIGNED - - - - Key for an item of the options' array used in - EventSslContext::__construct. - Represents option that allows self-signed certificates. - - - - - - EventSslContext::OPT_VERIFY_PEER - - - - Key for an item of the options' array used in - EventSslContext::__construct. - Represents option that tells Event to verify peer. - - - - - - EventSslContext::OPT_VERIFY_DEPTH - - - - Key for an item of the options' array used in - EventSslContext::__construct. - Represents maximum depth for the certificate chain verification that - shall be allowed for the SSL context. - - - - - - EventSslContext::OPT_CIPHERS - - - - Key for an item of the options' array used in - EventSslContext::__construct. - Represents the cipher list for the SSL context. - - - - -
- -
- - &reference.event.entities.eventsslcontext; - -
- diff --git a/reference/event/eventsslcontext/construct.xml b/reference/event/eventsslcontext/construct.xml deleted file mode 100644 index 673c625256a5..000000000000 --- a/reference/event/eventsslcontext/construct.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - EventSslContext::__construct - Constructs an OpenSSL context for use with Event classes - - - &reftitle.description; - - public - EventSslContext::__construct - - string - method - - - string - options - - - - Creates SSL context holding pointer to - SSL_CTX - (see the system manual). - - - - &reftitle.parameters; - - - - method - - - - One of - - EventSslContext::*_METHOD constants. - - - - - - options - - - - Associative array of SSL context options One of - - EventSslContext::OPT_* constants. - - - - - - - &reftitle.examples; - - - <function>EventSslContext::__construct</function> example - - $local_cert, - EventSslContext::OPT_LOCAL_PK => $local_pk, - EventSslContext::OPT_PASSPHRASE => "echo server", - EventSslContext::OPT_VERIFY_PEER => true, - EventSslContext::OPT_ALLOW_SELF_SIGNED => false, -)); -?> -]]> - - - - - diff --git a/reference/event/eventutil.xml b/reference/event/eventutil.xml deleted file mode 100644 index a1ebca7255d5..000000000000 --- a/reference/event/eventutil.xml +++ /dev/null @@ -1,509 +0,0 @@ - - - - The EventUtil class - EventUtil - - -
- &reftitle.intro; - - EventUtil - is a singleton with supplementary methods and constants. - -
- -
- &reftitle.classsynopsis; - - - - - EventUtil - - - - - final - EventUtil - - - - &Constants; - - const - int - EventUtil::AF_INET - 2 - - - const - int - EventUtil::AF_INET6 - 10 - - - const - int - EventUtil::AF_UNSPEC - 0 - - - const - int - EventUtil::LIBEVENT_VERSION_NUMBER - 33559808 - - - const - int - EventUtil::SO_DEBUG - 1 - - - const - int - EventUtil::SO_REUSEADDR - 2 - - - const - int - EventUtil::SO_KEEPALIVE - 9 - - - const - int - EventUtil::SO_DONTROUTE - 5 - - - const - int - EventUtil::SO_LINGER - 13 - - - const - int - EventUtil::SO_BROADCAST - 6 - - - const - int - EventUtil::SO_OOBINLINE - 10 - - - const - int - EventUtil::SO_SNDBUF - 7 - - - const - int - EventUtil::SO_RCVBUF - 8 - - - const - int - EventUtil::SO_SNDLOWAT - 19 - - - const - int - EventUtil::SO_RCVLOWAT - 18 - - - const - int - EventUtil::SO_SNDTIMEO - 21 - - - const - int - EventUtil::SO_RCVTIMEO - 20 - - - const - int - EventUtil::SO_TYPE - 3 - - - const - int - EventUtil::SO_ERROR - 4 - - - const - int - EventUtil::SOL_SOCKET - 1 - - - const - int - EventUtil::SOL_TCP - 6 - - - const - int - EventUtil::SOL_UDP - 17 - - - const - int - EventUtil::IPPROTO_IP - 0 - - - const - int - EventUtil::IPPROTO_IPV6 - 41 - - &Methods; - - - -
- -
- &reftitle.constants; - - - - EventUtil::AF_INET - - - - IPv4 address family - - - - - - EventUtil::AF_INET6 - - - - IPv6 address family - - - - - - EventUtil::AF_UNSPEC - - - - Unspecified IP address family - - - - - - EventUtil::SO_DEBUG - - - - Socket option. Enable socket debugging. Only allowed for processes with - the - CAP_NET_ADMIN - capability or an effective user ID of - 0. - (Added in event-1.6.0.) - - - - - - EventUtil::SO_REUSEADDR - - - - Socket option. Indicates that the rules used in validating addresses - supplied in a - bind(2) - call should allow reuse of local addresses. See the - socket(7) - manual page. (Added in event-1.6.0.) - - - - - - EventUtil::SO_KEEPALIVE - - - - Socket option. Enable sending of keep-alive messages on - connection-oriented sockets. Expects an integer boolean flag. See the - socket(7) - manual page. (Added in event-1.6.0.) - - - - - - EventUtil::SO_DONTROUTE - - - - Socket option. See the - socket(7) - manual page. (Added in event-1.6.0.) - - - - - - EventUtil::SO_LINGER - - - - Socket option. When enabled, a - close(2) - or - shutdown(2) - will not return until all queued messages for the socket have been - successfully sent or the linger timeout has been reached. Otherwise, - the call returns immediately and the closing is done in the background. - See the - socket(7) - manual page. (Added in event-1.6.0.) - - - - - - EventUtil::SO_BROADCAST - - - - Socket option. Reports whether transmission of broadcast messages is - supported. See the - socket(7) - manual page. (Added in event-1.6.0.) - - - - - - EventUtil::SO_OOBINLINE - - - - Socket option. See the - socket(7) - manual page. (Added in event-1.6.0.) - - - - - - EventUtil::SO_SNDBUF - - - - Socket option. See the - socket(7) - manual page. (Added in event-1.6.0.) - - - - - - EventUtil::SO_RCVBUF - - - - Socket option. See the - socket(7) - manual page. (Added in event-1.6.0.) - - - - - - EventUtil::SO_SNDLOWAT - - - - Socket option. See the - socket(7) - manual page. (Added in event-1.6.0.) - - - - - - EventUtil::SO_RCVLOWAT - - - - Socket option. See the - socket(7) - manual page. (Added in event-1.6.0.) - - - - - - EventUtil::SO_SNDTIMEO - - - - Socket option. See the - socket(7) - manual page. (Added in event-1.6.0.) - - - - - - EventUtil::SO_RCVTIMEO - - - - Socket option. See the - socket(7) - manual page. (Added in event-1.6.0.) - - - - - - EventUtil::SO_TYPE - - - - Socket option. See the - socket(7) - manual page. (Added in event-1.6.0.) - - - - - - EventUtil::SO_ERROR - - - - Socket option. See the - socket(7) - manual page. (Added in event-1.6.0.) - - - - - - EventUtil::SOL_SOCKET - - - - Socket option level. See the - socket(7) - manual page. (Added in event-1.6.0.) - - - - - - EventUtil::SOL_TCP - - - - Socket option level. See the - socket(7) - manual page. (Added in event-1.6.0.) - - - - - - EventUtil::SOL_UDP - - - - Socket option level. See the - socket(7) - manual page. (Added in event-1.6.0.) - - - - - - EventUtil::IPPROTO_IP - - - - See the - socket(7) - manual page. (Added in event-1.6.0.) - - - - - - EventUtil::IPPROTO_IPV6 - - - - See the - socket(7) - manual page. (Added in event-1.6.0.) - - - - - - EventUtil::LIBEVENT_VERSION_NUMBER - - - - Libevent' version number at the time when Event extension had been - compiled with the library. - - - - -
- -
- - &reference.event.entities.eventutil; - -
- diff --git a/reference/event/eventutil/construct.xml b/reference/event/eventutil/construct.xml deleted file mode 100644 index b3a0d36e0e33..000000000000 --- a/reference/event/eventutil/construct.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - EventUtil::__construct - The abstract constructor - - - &reftitle.description; - - abstract - public - EventUtil::__construct - - - - EventUtil - is a singleton. Therefore the constructor is abstract, and it is impossible - to create objects based on this class. - - - - &reftitle.parameters; - &no.function.parameters; - - - diff --git a/reference/event/eventutil/getlastsocketerrno.xml b/reference/event/eventutil/getlastsocketerrno.xml deleted file mode 100644 index 5c6685bb9630..000000000000 --- a/reference/event/eventutil/getlastsocketerrno.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - EventUtil::getLastSocketErrno - Returns the most recent socket error number - - - &reftitle.description; - - public - static - int - EventUtil::getLastSocketErrno - - mixed - socket - &null; - - - - Returns the most recent socket error number( - errno - ). - - - - &reftitle.parameters; - - - - socket - - - - Socket resource, stream or a file descriptor of a socket. - - - - - - - &reftitle.returnvalues; - - Returns the most recent socket error number( - errno - ). - - - - &reftitle.seealso; - - - EventUtil::getLastSocketError - - - - - diff --git a/reference/event/eventutil/getlastsocketerror.xml b/reference/event/eventutil/getlastsocketerror.xml deleted file mode 100644 index 87e033b1cc20..000000000000 --- a/reference/event/eventutil/getlastsocketerror.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - EventUtil::getLastSocketError - Returns the most recent socket error - - - &reftitle.description; - - public - static - string - EventUtil::getLastSocketError - - mixed - socket - - - - Returns the most recent socket error. - - - - &reftitle.parameters; - - - - socket - - - - Socket resource, stream or a file descriptor of a socket. - - - - - - - &reftitle.returnvalues; - - Returns the most recent socket error. - - - - &reftitle.seealso; - - - EventUtil::getLastSocketErrno - - - - - diff --git a/reference/event/eventutil/getsocketfd.xml b/reference/event/eventutil/getsocketfd.xml deleted file mode 100644 index 917f9c4c9cbc..000000000000 --- a/reference/event/eventutil/getsocketfd.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - EventUtil::getSocketFd - Returns numeric file descriptor of a socket, or stream - - - &reftitle.description; - - public - static - int - EventUtil::getSocketFd - - mixed - socket - - - - Returns numeric file descriptor of a socket or stream specified by - socket - argument just like the - Event - extension does it internally for all methods accepting socket resource or - stream. - - - - &reftitle.parameters; - - - - socket - - - - Socket resource or stream. - - - - - - - &reftitle.returnvalues; - - Returns numeric file descriptor of a socket, or stream. - EventUtil::getSocketFd - returns &false; in case if it is whether failed to recognize the type of - the underlying file, or detected that the file descriptor associated with - socket - is not valid. - - - - diff --git a/reference/event/eventutil/getsocketname.xml b/reference/event/eventutil/getsocketname.xml deleted file mode 100644 index 7d633b8561aa..000000000000 --- a/reference/event/eventutil/getsocketname.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - EventUtil::getSocketName - Retrieves the current address to which the - socket is bound - - - &reftitle.description; - - public - static - bool - EventUtil::getSocketName - - mixed - socket - - - string - address - - - mixed - port - - - - Retrieves the current address to which the - socket - is bound. - - - - &reftitle.parameters; - - - - socket - - - - Socket resource, stream or a file descriptor of a socket. - - - - - - address - - - - Output parameter. IP-address, or the UNIX domain socket path depending - on the socket address family. - - - - - - port - - - - Output parameter. The port the socket is bound to. Has no meaning for - UNIX domain sockets. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/event/eventutil/setsocketoption.xml b/reference/event/eventutil/setsocketoption.xml deleted file mode 100644 index 795aee7f42b7..000000000000 --- a/reference/event/eventutil/setsocketoption.xml +++ /dev/null @@ -1,138 +0,0 @@ - - - - - EventUtil::setSocketOption - Sets socket options - - - &reftitle.description; - - public - static - bool - EventUtil::setSocketOption - - mixed - socket - - - int - level - - - int - optname - - - mixed - optval - - - - Sets socket options. - - - - &reftitle.parameters; - - - - socket - - - - Socket resource, stream, or numeric file descriptor associated with the - socket. - - - - - - level - - - - One of - EventUtil::SOL_* - constants. Specifies the protocol level at which the option resides. For - example, to retrieve options at the socket level, a - level - parameter of - EventUtil::SOL_SOCKET - would be used. Other levels, such as TCP, can be used by specifying the - protocol number of that level. Protocol numbers can be found by using - the - getprotobyname - function. See - EventUtil constants. - - - - - - optname - - - - Option name(type). Has the same meaning as corresponding parameter of - socket_get_option - function. See - EventUtil constants. - - - - - - optval - - - - Accepts the same values as - optval - parameter of the - socket_get_option - function. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - socket_get_option - - - socket_set_option - - - - - diff --git a/reference/event/eventutil/sslrandpoll.xml b/reference/event/eventutil/sslrandpoll.xml deleted file mode 100644 index 0841216285b0..000000000000 --- a/reference/event/eventutil/sslrandpoll.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - EventUtil::sslRandPoll - Generates entropy by means of OpenSSL's RAND_poll() - - - &reftitle.description; - - public - static - void - EventUtil::sslRandPoll - - - - Generates entropy by means of OpenSSL's - RAND_poll() - (see the system manual). - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/event/examples.xml b/reference/event/examples.xml deleted file mode 100644 index da10d4952446..000000000000 --- a/reference/event/examples.xml +++ /dev/null @@ -1,1317 +0,0 @@ - - - - &reftitle.examples; - - Simple HTTP client - -input; //$bev->getInput(); - - //$pos = $input->search("TTP"); - $pos = $bev->input->search("TTP"); - - while (($n = $bev->input->remove($buf, 1024)) > 0) { - echo $buf; - } -} - -// Event callback -function eventcb($bev, $events, $base) { - if ($events & EventBufferEvent::CONNECTED) { - echo "Connected.\n"; - } elseif ($events & (EventBufferEvent::ERROR | EventBufferEvent::EOF)) { - if ($events & EventBufferEvent::ERROR) { - echo "DNS error: ", $bev->getDnsErrorString(), PHP_EOL; - } - - echo "Closing\n"; - $base->exit(); - exit("Done\n"); - } -} - -if ($argc != 3) { - echo <<setCallbacks("readcb", /* writecb */ NULL, "eventcb", $base); -$bev->enable(Event::READ | Event::WRITE); - -$output = $bev->output; //$bev->getOutput(); -if (!$output->add( - "GET {$argv[2]} HTTP/1.0\r\n". - "Host: {$argv[1]}\r\n". - "Connection: Close\r\n\r\n" -)) { - exit("Failed adding request to output buffer\n"); -} - -if (!$bev->connectHost($dns_base, $argv[1], 80, EventUtil::AF_UNSPEC)) { - exit("Can't connect to host {$argv[1]}\n"); -} - -$base->dispatch(); -?> -]]> - - &example.outputs.similar; - - -301 Moved -

301 Moved

-The document has moved -here. - -Closing -Done -]]> -
-
- - HTTP client using asynchronous DNS resolver - -getInput(); - - while (($n = $input->remove($buf, 1024)) > 0) { - echo $buf; - } -} - -// Event callback -function eventcb($bev, $events, $base) { - if ($events & EventBufferEvent::CONNECTED) { - echo "Connected.\n"; - } elseif ($events & (EventBufferEvent::ERROR | EventBufferEvent::EOF)) { - if ($events & EventBufferEvent::ERROR) { - echo "DNS error: ", $bev->getDnsErrorString(), PHP_EOL; - } - - echo "Closing\n"; - $base->exit(); - exit("Done\n"); - } -} - -$base = new EventBase(); - -echo "step 1\n"; -$bev = new EventBufferEvent($base, /* use internal socket */ NULL, - EventBufferEvent::OPT_CLOSE_ON_FREE | EventBufferEvent::OPT_DEFER_CALLBACKS); -if (!$bev) { - exit("Failed creating bufferevent socket\n"); -} - -echo "step 2\n"; -$bev->setCallbacks("readcb", /* writecb */ NULL, "eventcb", $base); -$bev->enable(Event::READ | Event::WRITE); - -echo "step 3\n"; -// Send request -$output = $bev->getOutput(); -if (!$output->add( - "GET /index.cphp HTTP/1.0\r\n". - "Connection: Close\r\n\r\n" -)) { - exit("Failed adding request to output buffer\n"); -} - -/* Connect to the host synchronously. -We know the IP, and don't need to resolve DNS. */ -if (!$bev->connect("127.0.0.1:80")) { - exit("Can't connect to host\n"); -} - -// Dispatch pending events -$base->dispatch(); -?> -]]> - - - - Echo server - -bev->free(); - } - - public function __construct($base, $fd) { - $this->base = $base; - - $this->bev = new EventBufferEvent($base, $fd, EventBufferEvent::OPT_CLOSE_ON_FREE); - - $this->bev->setCallbacks(array($this, "echoReadCallback"), NULL, - array($this, "echoEventCallback"), NULL); - - if (!$this->bev->enable(Event::READ)) { - echo "Failed to enable READ\n"; - return; - } - } - - public function echoReadCallback($bev, $ctx) { - // Copy all the data from the input buffer to the output buffer - - // Variant #1 - $bev->output->addBuffer($bev->input); - - /* Variant #2 */ - /* - $input = $bev->getInput(); - $output = $bev->getOutput(); - $output->addBuffer($input); - */ - } - - public function echoEventCallback($bev, $events, $ctx) { - if ($events & EventBufferEvent::ERROR) { - echo "Error from bufferevent\n"; - } - - if ($events & (EventBufferEvent::EOF | EventBufferEvent::ERROR)) { - //$bev->free(); - $this->__destruct(); - } - } -} - -class MyListener { - public $base, - $listener, - $socket; - private $conn = array(); - - public function __destruct() { - foreach ($this->conn as &$c) $c = NULL; - } - - public function __construct($port) { - $this->base = new EventBase(); - if (!$this->base) { - echo "Couldn't open event base"; - exit(1); - } - - // Variant #1 - /* - $this->socket = socket_create(AF_INET, SOCK_STREAM, SOL_TCP); - if (!socket_bind($this->socket, '0.0.0.0', $port)) { - echo "Unable to bind socket\n"; - exit(1); - } - $this->listener = new EventListener($this->base, - array($this, "acceptConnCallback"), $this->base, - EventListener::OPT_CLOSE_ON_FREE | EventListener::OPT_REUSEABLE, - -1, $this->socket); - */ - - // Variant #2 - $this->listener = new EventListener($this->base, - array($this, "acceptConnCallback"), $this->base, - EventListener::OPT_CLOSE_ON_FREE | EventListener::OPT_REUSEABLE, -1, - "0.0.0.0:$port"); - - if (!$this->listener) { - echo "Couldn't create listener"; - exit(1); - } - - $this->listener->setErrorCallback(array($this, "accept_error_cb")); - } - - public function dispatch() { - $this->base->dispatch(); - } - - // This callback is invoked when there is data to read on $bev - public function acceptConnCallback($listener, $fd, $address, $ctx) { - // We got a new connection! Set up a bufferevent for it. */ - $base = $this->base; - $this->conn[] = new MyListenerConnection($base, $fd); - } - - public function accept_error_cb($listener, $ctx) { - $base = $this->base; - - fprintf(STDERR, "Got an error %d (%s) on the listener. " - ."Shutting down.\n", - EventUtil::getLastSocketErrno(), - EventUtil::getLastSocketError()); - - $base->exit(NULL); - } -} - -$port = 9808; - -if ($argc > 1) { - $port = (int) $argv[1]; -} -if ($port <= 0 || $port > 65535) { - exit("Invalid port"); -} - -$l = new MyListener($port); -$l->dispatch(); -?> -]]> - - - - SSL echo server - -port = $port; - $this->ctx = $this->init_ssl(); - if (!$this->ctx) { - exit("Failed creating SSL context\n"); - } - - $this->base = new EventBase(); - if (!$this->base) { - exit("Couldn't open event base\n"); - } - - $this->listener = new EventListener($this->base, - array($this, "ssl_accept_cb"), $this->ctx, - EventListener::OPT_CLOSE_ON_FREE | EventListener::OPT_REUSEABLE, - -1, "$host:$port"); - if (!$this->listener) { - exit("Couldn't create listener\n"); - } - - $this->listener->setErrorCallback(array($this, "accept_error_cb")); - } - function dispatch() { - $this->base->dispatch(); - } - - // This callback is invoked when there is data to read on $bev. - function ssl_read_cb($bev, $ctx) { - $in = $bev->input; //$bev->getInput(); - - printf("Received %zu bytes\n", $in->length); - printf("----- data ----\n"); - printf("%ld:\t%s\n", (int) $in->length, $in->pullup(-1)); - - $bev->writeBuffer($in); - } - - // This callback is invoked when some event occurs on the event listener, - // e.g. connection closed, or an error occurred - function ssl_event_cb($bev, $events, $ctx) { - if ($events & EventBufferEvent::ERROR) { - // Fetch errors from the SSL error stack - while ($err = $bev->sslError()) { - fprintf(STDERR, "Bufferevent error %s.\n", $err); - } - } - - if ($events & (EventBufferEvent::EOF | EventBufferEvent::ERROR)) { - $bev->free(); - } - } - - // This callback is invoked when a client accepts new connection - function ssl_accept_cb($listener, $fd, $address, $ctx) { - // We got a new connection! Set up a bufferevent for it. - $this->bev = EventBufferEvent::sslSocket($this->base, $fd, $this->ctx, - EventBufferEvent::SSL_ACCEPTING, EventBufferEvent::OPT_CLOSE_ON_FREE); - - if (!$this->bev) { - echo "Failed creating ssl buffer\n"; - $this->base->exit(NULL); - exit(1); - } - - $this->bev->enable(Event::READ); - $this->bev->setCallbacks(array($this, "ssl_read_cb"), NULL, - array($this, "ssl_event_cb"), NULL); - } - - // This callback is invoked when we failed to setup new connection for a client - function accept_error_cb($listener, $ctx) { - fprintf(STDERR, "Got an error %d (%s) on the listener. " - ."Shutting down.\n", - EventUtil::getLastSocketErrno(), - EventUtil::getLastSocketError()); - - $this->base->exit(NULL); - } - - // Initialize SSL structures, create an EventSslContext - // Optionally create self-signed certificates - function init_ssl() { - // We *must* have entropy. Otherwise there's no point to crypto. - if (!EventUtil::sslRandPoll()) { - exit("EventUtil::sslRandPoll failed\n"); - } - - $local_cert = __DIR__."/cert.pem"; - $local_pk = __DIR__."/privkey.pem"; - - if (!file_exists($local_cert) || !file_exists($local_pk)) { - echo "Couldn't read $local_cert or $local_pk file. To generate a key\n", - "and self-signed certificate, run:\n", - " openssl genrsa -out $local_pk 2048\n", - " openssl req -new -key $local_pk -out cert.req\n", - " openssl x509 -req -days 365 -in cert.req -signkey $local_pk -out $local_cert\n"; - - return FALSE; - } - - $ctx = new EventSslContext(EventSslContext::SSLv3_SERVER_METHOD, array ( - EventSslContext::OPT_LOCAL_CERT => $local_cert, - EventSslContext::OPT_LOCAL_PK => $local_pk, - //EventSslContext::OPT_PASSPHRASE => "echo server", - EventSslContext::OPT_VERIFY_PEER => true, - EventSslContext::OPT_ALLOW_SELF_SIGNED => false, - )); - - return $ctx; - } -} - -// Allow to override the port -$port = 9999; -if ($argc > 1) { - $port = (int) $argv[1]; -} -if ($port <= 0 || $port > 65535) { - exit("Invalid port\n"); -} - - -$l = new MySslEchoServer($port); -$l->dispatch(); -?> -]]> - - - - Signal handler - -base = $base; - } - - function eventSighandler($no, $c) { - echo "Caught signal $no\n"; - event_base_loopexit($c->base); - } -} - -$base = event_base_new(); -$c = new MyEventSignal($base); -$no = SIGTERM; -$ev = evsignal_new($base, $no, array($c,'eventSighandler'), $c); - -evsignal_add($ev); - -event_base_loop($base); -?> -]]> - - - - Use libevent's loop to process requests of `eio' extension - -stop(); -}, $base); - -echo "step 3\n"; - -$event->add(); - -echo "step 4\n"; - -$base->dispatch(); - -echo "Done\n"; -?> -]]> - - - - Miscellaneous - -avoidMethod("select")) { - echo "'select' method avoided\n"; -} - -// Create event_base associated with the config -$base = new EventBase($cfg); -echo "Event method used: ", $base->getMethod(), PHP_EOL; - -echo "Features:\n"; -$features = $base->getFeatures(); -($features & EventConfig::FEATURE_ET) and print "ET - edge-triggered IO\n"; -($features & EventConfig::FEATURE_O1) and print "O1 - O(1) operation for adding/deleting events\n"; -($features & EventConfig::FEATURE_FDS) and print "FDS - arbitrary file descriptor types, and not just sockets\n"; - -// Require FDS feature -if ($cfg->requireFeatures(EventConfig::FEATURE_FDS)) { - echo "FDS feature is now required\n"; - - $base = new EventBase($cfg); - ($base->getFeatures() & EventConfig::FEATURE_FDS) - and print "FDS - arbitrary file descriptor types, and not just sockets\n"; -} -/* }}} */ - -/* {{{ Base */ -$base = new EventBase(); -$event = new Event($base, STDIN, Event::READ | Event::PERSIST, function ($fd, $events, $arg) { - static $max_iterations = 0; - - if (++$max_iterations >= 5) { - /* exit after 5 iterations with timeout of 2.33 seconds */ - echo "Stopping...\n"; - $arg[0]->exit(2.33); - } - - echo fgets($fd); -}, array (&$base)); - -$event->add(); -$base->loop(); -/* Base }}} */ -?> -]]> - - - - Simple HTTP server - -= $max_requests) { - echo "Counter reached max requests $max_requests. Exiting\n"; - exit(); - } - - echo __METHOD__, " called\n"; - echo "request:"; var_dump($req); - echo "data:"; var_dump($data); - - echo "\n===== DUMP =====\n"; - echo "Command:", $req->getCommand(), PHP_EOL; - echo "URI:", $req->getUri(), PHP_EOL; - echo "Input headers:"; var_dump($req->getInputHeaders()); - echo "Output headers:"; var_dump($req->getOutputHeaders()); - - echo "\n >> Sending reply ..."; - $req->sendReply(200, "OK"); - echo "OK\n"; - - echo "\n >> Reading input buffer ...\n"; - $buf = $req->getInputBuffer(); - while ($s = $buf->readLine(EventBuffer::EOL_ANY)) { - echo $s, PHP_EOL; - } - echo "No more data in the buffer\n"; -} - -function _http_about($req) { - echo __METHOD__, PHP_EOL; - echo "URI: ", $req->getUri(), PHP_EOL; - echo "\n >> Sending reply ..."; - $req->sendReply(200, "OK"); - echo "OK\n"; -} - -function _http_default($req, $data) { - echo __METHOD__, PHP_EOL; - echo "URI: ", $req->getUri(), PHP_EOL; - echo "\n >> Sending reply ..."; - $req->sendReply(200, "OK"); - echo "OK\n"; -} - -$port = 8010; -if ($argc > 1) { - $port = (int) $argv[1]; -} -if ($port <= 0 || $port > 65535) { - exit("Invalid port"); -} - -$base = new EventBase(); -$http = new EventHttp($base); -$http->setAllowedMethods(EventHttpRequest::CMD_GET | EventHttpRequest::CMD_POST); - -$http->setCallback("/dump", "_http_dump", array(4, 8)); -$http->setCallback("/about", "_http_about"); -$http->setDefaultCallback("_http_default", "custom data value"); - -$http->bind("0.0.0.0", 8010); -$base->loop(); -?> -]]> - - &example.outputs.similar; - - - - - - Simple HTTPS server - -= $max_requests) { - echo "Counter reached max requests $max_requests. Exiting\n"; - exit(); - } - - echo __METHOD__, " called\n"; - echo "request:"; var_dump($req); - echo "data:"; var_dump($data); - - echo "\n===== DUMP =====\n"; - echo "Command:", $req->getCommand(), PHP_EOL; - echo "URI:", $req->getUri(), PHP_EOL; - echo "Input headers:"; var_dump($req->getInputHeaders()); - echo "Output headers:"; var_dump($req->getOutputHeaders()); - - echo "\n >> Sending reply ..."; - $req->sendReply(200, "OK"); - echo "OK\n"; - - $buf = $req->getInputBuffer(); - echo "\n >> Reading input buffer (", $buf->length, ") ...\n"; - while ($s = $buf->read(1024)) { - echo $s; - } - echo "\nNo more data in the buffer\n"; -} - -function _http_about($req) { - echo __METHOD__, PHP_EOL; - echo "URI: ", $req->getUri(), PHP_EOL; - echo "\n >> Sending reply ..."; - $req->sendReply(200, "OK"); - echo "OK\n"; -} - -function _http_default($req, $data) { - echo __METHOD__, PHP_EOL; - echo "URI: ", $req->getUri(), PHP_EOL; - echo "\n >> Sending reply ..."; - $req->sendReply(200, "OK"); - echo "OK\n"; -} - -function _http_400($req) { - $req->sendError(400); -} - -function _init_ssl() { - $local_cert = __DIR__."/ssl-echo-server/cert.pem"; - $local_pk = __DIR__."/ssl-echo-server/privkey.pem"; - - $ctx = new EventSslContext(EventSslContext::SSLv3_SERVER_METHOD, array ( - EventSslContext::OPT_LOCAL_CERT => $local_cert, - EventSslContext::OPT_LOCAL_PK => $local_pk, - //EventSslContext::OPT_PASSPHRASE => "test", - EventSslContext::OPT_ALLOW_SELF_SIGNED => true, - )); - - return $ctx; -} - -$port = 9999; -if ($argc > 1) { - $port = (int) $argv[1]; -} -if ($port <= 0 || $port > 65535) { - exit("Invalid port"); -} -$ip = '0.0.0.0'; - -$base = new EventBase(); -$ctx = _init_ssl(); -$http = new EventHttp($base, $ctx); -$http->setAllowedMethods(EventHttpRequest::CMD_GET | EventHttpRequest::CMD_POST); - -$http->setCallback("/dump", "_http_dump", array(4, 8)); -$http->setCallback("/about", "_http_about"); -$http->setCallback("/err400", "_http_400"); -$http->setDefaultCallback("_http_default", "custom data value"); - -$http->bind($ip, $port); -$base->dispatch(); -]]> - - - - OpenSSL connection - -getResponseCode(); - - if ($response_code == 0) { - echo "Connection refused\n"; - } elseif ($response_code != 200) { - echo "Unexpected response: $response_code\n"; - } else { - echo "Success: $response_code\n"; - $buf = $req->getInputBuffer(); - echo "Body:\n"; - while ($s = $buf->readLine(EventBuffer::EOL_ANY)) { - echo $s, PHP_EOL; - } - } - } - - $base->exit(NULL); -} - -function _init_ssl() { - $ctx = new EventSslContext(EventSslContext::SSLv3_CLIENT_METHOD, array ()); - - return $ctx; -} - - -// Allow to override the port -$port = 9999; -if ($argc > 1) { - $port = (int) $argv[1]; -} -if ($port <= 0 || $port > 65535) { - exit("Invalid port\n"); -} -$host = '127.0.0.1'; - -$ctx = _init_ssl(); -if (!$ctx) { - trigger_error("Failed creating SSL context", E_USER_ERROR); -} - -$base = new EventBase(); -if (!$base) { - trigger_error("Failed to initialize event base", E_USER_ERROR); -} - -$conn = new EventHttpConnection($base, NULL, $host, $port, $ctx); -$conn->setTimeout(50); - -$req = new EventHttpRequest("_request_handler", $base); -$req->addHeader("Host", $host, EventHttpRequest::OUTPUT_HEADER); -$buf = $req->getOutputBuffer(); -$buf->add("HTML TEST"); -//$req->addHeader("Content-Length", $buf->length, EventHttpRequest::OUTPUT_HEADER); -//$req->addHeader("Connection", "close", EventHttpRequest::OUTPUT_HEADER); -$conn->makeRequest($req, EventHttpRequest::CMD_POST, "/dump"); - -$base->dispatch(); -echo "END\n"; -?> -]]> - - - - - <function>EventHttpConnection::makeRequest</function> example - -getResponseCode(); - - if ($response_code == 0) { - echo "Connection refused\n"; - } elseif ($response_code != 200) { - echo "Unexpected response: $response_code\n"; - } else { - echo "Success: $response_code\n"; - $buf = $req->getInputBuffer(); - echo "Body:\n"; - while ($s = $buf->readLine(EventBuffer::EOL_ANY)) { - echo $s, PHP_EOL; - } - } - } - - $base->exit(NULL); -} - -$address = "127.0.0.1"; -$port = 80; - -$base = new EventBase(); -$conn = new EventHttpConnection($base, NULL, $address, $port); -$conn->setTimeout(5); -$req = new EventHttpRequest("_request_handler", $base); - -$req->addHeader("Host", $address, EventHttpRequest::OUTPUT_HEADER); -$req->addHeader("Content-Length", "0", EventHttpRequest::OUTPUT_HEADER); -$conn->makeRequest($req, EventHttpRequest::CMD_GET, "/index.cphp"); - -$base->loop(); -?> -]]> - - &example.outputs.similar; - - - - - - - Connection listener based on a UNIX domain socket - -bev) { - $this->bev->free(); - } - } - - public function __construct($base, $fd) { - $this->base = $base; - - $this->bev = new EventBufferEvent($base, $fd, EventBufferEvent::OPT_CLOSE_ON_FREE); - - $this->bev->setCallbacks(array($this, "echoReadCallback"), NULL, - array($this, "echoEventCallback"), NULL); - - if (!$this->bev->enable(Event::READ)) { - echo "Failed to enable READ\n"; - return; - } - } - - public function echoReadCallback($bev, $ctx) { - // Copy all the data from the input buffer to the output buffer - $bev->output->addBuffer($bev->input); - } - - public function echoEventCallback($bev, $events, $ctx) { - if ($events & EventBufferEvent::ERROR) { - echo "Error from bufferevent\n"; - } - - if ($events & (EventBufferEvent::EOF | EventBufferEvent::ERROR)) { - $bev->free(); - $bev = NULL; - } - } -} - -class MyListener { - public $base, - $listener, - $socket; - private $conn = array(); - - public function __destruct() { - foreach ($this->conn as &$c) $c = NULL; - } - - public function __construct($sock_path) { - $this->base = new EventBase(); - if (!$this->base) { - echo "Couldn't open event base"; - exit(1); - } - - if (file_exists($sock_path)) { - unlink($sock_path); - } - - $this->listener = new EventListener($this->base, - array($this, "acceptConnCallback"), $this->base, - EventListener::OPT_CLOSE_ON_FREE | EventListener::OPT_REUSEABLE, -1, - "unix:$sock_path"); - - if (!$this->listener) { - trigger_error("Couldn't create listener", E_USER_ERROR); - } - - $this->listener->setErrorCallback(array($this, "accept_error_cb")); - } - - public function dispatch() { - $this->base->dispatch(); - } - - // This callback is invoked when there is data to read on $bev - public function acceptConnCallback($listener, $fd, $address, $ctx) { - // We got a new connection! Set up a bufferevent for it. */ - $base = $this->base; - $this->conn[] = new MyListenerConnection($base, $fd); - } - - public function accept_error_cb($listener, $ctx) { - $base = $this->base; - - fprintf(STDERR, "Got an error %d (%s) on the listener. " - ."Shutting down.\n", - EventUtil::getLastSocketErrno(), - EventUtil::getLastSocketError()); - - $base->exit(NULL); - } -} - -if ($argc <= 1) { - exit("Socket path is not provided\n"); -} -$sock_path = $argv[1]; - -$l = new MyListener($sock_path); -$l->dispatch(); -?> -]]> - - - - Simple SMTP server - - - * - * Usage: - * 1) Prepare cert.pem certificate and privkey.pem private key files. - * 2) Launch the server script - * 3) Open TLS connection, e.g.: - * $ openssl s_client -connect localhost:25 -starttls smtp -crlf - * 4) Start testing the commands listed in `cmd` method below. - */ - -class Handler { - public $domainName = FALSE; - public $connections = []; - public $buffers = []; - public $maxRead = 256000; - - public function __construct() { - $this->ctx = new EventSslContext(EventSslContext::SSLv3_SERVER_METHOD, [ - EventSslContext::OPT_LOCAL_CERT => 'cert.pem', - EventSslContext::OPT_LOCAL_PK => 'privkey.pem', - //EventSslContext::OPT_PASSPHRASE => '', - EventSslContext::OPT_VERIFY_PEER => false, // change to true with authentic cert - EventSslContext::OPT_ALLOW_SELF_SIGNED => true // change to false with authentic cert - ]); - - $this->base = new EventBase(); - if (!$this->base) { - exit("Couldn't open event base\n"); - } - - if (!$this->listener = new EventListener($this->base, - [$this, 'ev_accept'], - $this->ctx, - EventListener::OPT_CLOSE_ON_FREE | EventListener::OPT_REUSEABLE, - -1, - '0.0.0.0:25')) - { - exit("Couldn't create listener\n"); - } - - $this->listener->setErrorCallback([$this, 'ev_error']); - $this->base->dispatch(); - } - - public function ev_accept($listener, $fd, $address, $ctx) { - static $id = 0; - $id += 1; - - $this->connections[$id]['clientData'] = ''; - $this->connections[$id]['cnx'] = new EventBufferEvent($this->base, $fd, - EventBufferEvent::OPT_CLOSE_ON_FREE); - - if (!$this->connections[$id]['cnx']) { - echo "Failed creating buffer\n"; - $this->base->exit(NULL); - exit(1); - } - - $this->connections[$id]['cnx']->setCallbacks([$this, "ev_read"], NULL, - [$this, 'ev_error'], $id); - $this->connections[$id]['cnx']->enable(Event::READ | Event::WRITE); - - $this->ev_write($id, '220 '.$this->domainName." wazzzap?\r\n"); - } - - function ev_error($listener, $ctx) { - $errno = EventUtil::getLastSocketErrno(); - - fprintf(STDERR, "Got an error %d (%s) on the listener. Shutting down.\n", - $errno, EventUtil::getLastSocketError()); - - if ($errno != 0) { - $this->base->exit(NULL); - exit(); - } - } - - public function ev_close($id) { - $this->connections[$id]['cnx']->disable(Event::READ | Event::WRITE); - unset($this->connections[$id]); - } - - protected function ev_write($id, $string) { - echo 'S('.$id.'): '.$string; - $this->connections[$id]['cnx']->write($string); - } - - public function ev_read($buffer, $id) { - while($buffer->input->length > 0) { - $this->connections[$id]['clientData'] .= $buffer->input->read($this->maxRead); - $clientDataLen = strlen($this->connections[$id]['clientData']); - - if($this->connections[$id]['clientData'][$clientDataLen-1] == "\n" - && $this->connections[$id]['clientData'][$clientDataLen-2] == "\r") - { - // remove the trailing \r\n - $line = substr($this->connections[$id]['clientData'], 0, - strlen($this->connections[$id]['clientData']) - 2); - - $this->connections[$id]['clientData'] = ''; - $this->cmd($buffer, $id, $line); - } - } - } - - protected function cmd($buffer, $id, $line) { - switch ($line) { - case strncmp('EHLO ', $line, 4): - $this->ev_write($id, "250-STARTTLS\r\n"); - $this->ev_write($id, "250 OK ehlo\r\n"); - break; - - case strncmp('HELO ', $line, 4): - $this->ev_write($id, "250-STARTTLS\r\n"); - $this->ev_write($id, "250 OK helo\r\n"); - break; - - case strncmp('QUIT', $line, 3): - $this->ev_write($id, "250 OK quit\r\n"); - $this->ev_close($id); - break; - - case strncmp('STARTTLS', $line, 3): - $this->ev_write($id, "220 Ready to start TLS\r\n"); - $this->connections[$id]['cnx'] = EventBufferEvent::sslFilter($this->base, - $this->connections[$id]['cnx'], $this->ctx, - EventBufferEvent::SSL_ACCEPTING, - EventBufferEvent::OPT_CLOSE_ON_FREE); - $this->connections[$id]['cnx']->setCallbacks([$this, "ev_read"], NULL, [$this, 'ev_error'], $id); - $this->connections[$id]['cnx']->enable(Event::READ | Event::WRITE); - break; - - default: - echo 'unknown command: '.$line."\n"; - break; - } - } -} - -new Handler(); -]]> - - -
- diff --git a/reference/event/setup.xml b/reference/event/setup.xml deleted file mode 100644 index edeea97f7821..000000000000 --- a/reference/event/setup.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - &reftitle.setup; - -
- &reftitle.required; - - This extension requires - libevent - library. Most modern distributions provide packages for libevent. - - - OpenSSL features require - OpenSSL - library. - -
-
- &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;event. - -
-
- diff --git a/reference/event/versions.xml b/reference/event/versions.xml deleted file mode 100644 index b20a410fd632..000000000000 --- a/reference/event/versions.xml +++ /dev/null @@ -1,193 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/expect/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/expect/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/expect/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/expect/book.xml b/reference/expect/book.xml deleted file mode 100644 index 967ec0540e03..000000000000 --- a/reference/expect/book.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - Expect - - - - &reftitle.intro; - - This extension allows to interact with processes through PTY. You may - consider using the expect:// - wrapper with the filesystem - functions which provide a simpler and more intuitive interface. - - - - - &reference.expect.setup; - &reference.expect.constants; - &reference.expect.examples; - &reference.expect.reference; - - - diff --git a/reference/expect/configure.xml b/reference/expect/configure.xml deleted file mode 100644 index 013a9b2b8564..000000000000 --- a/reference/expect/configure.xml +++ /dev/null @@ -1,40 +0,0 @@ - - -
- &reftitle.install; - - &pecl.moved; - &pecl.info; - &url.pecl.package;expect. - - - In order to use these functions you must compile PHP with expect support - by using the - configure option. - - - Windows users will enable php_expect.dll inside - of &php.ini; in order to use these functions. - &pecl.windows.download; - -
- diff --git a/reference/expect/constants.xml b/reference/expect/constants.xml deleted file mode 100644 index 5bc5e38b6f78..000000000000 --- a/reference/expect/constants.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - &reftitle.constants; - &extension.constants; - - - - EXP_GLOB - (int) - - - - Indicates that the pattern is a glob-style string pattern. - - - - - - EXP_EXACT - (int) - - - - Indicates that the pattern is an exact string. - - - - - - EXP_REGEXP - (int) - - - - Indicates that the pattern is a regexp-style string pattern. - - - - - - EXP_EOF - (int) - - - - Value, returned by expect_expectl, when EOF is - reached. - - - - - - EXP_TIMEOUT - (int) - - - - Value, returned by expect_expectl upon timeout of - seconds, specified in value of expect.timeout - - - - - - EXP_FULLBUFFER - (int) - - - - Value, returned by expect_expectl if no pattern have - been matched. - - - - - - - diff --git a/reference/expect/examples.xml b/reference/expect/examples.xml deleted file mode 100644 index 816647900eb8..000000000000 --- a/reference/expect/examples.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - &reftitle.examples; -
- Expect Usage Examples - - Expect Usage Example - - This example connects to the remote host via SSH, and prints the remote - uptime. - - - "password:", 1 => PASSWORD) -); - -switch (expect_expectl ($stream, $cases)) { - case PASSWORD: - fwrite ($stream, "password\n"); - break; - - default: - die ("Error was occurred while connecting to the remote host!\n"); -} - -while ($line = fgets($stream)) { - print $line; -} -fclose ($stream); -?> -]]> - - - - - The following example connects to the remote host, determines whether - installed OS is for 32 or 64 bit, then runs update for specific package. - - - Another Expect Usage Example - - -]]> - - -
-
- diff --git a/reference/expect/functions/expect-expectl.xml b/reference/expect/functions/expect-expectl.xml deleted file mode 100644 index 62107912a9ce..000000000000 --- a/reference/expect/functions/expect-expectl.xml +++ /dev/null @@ -1,197 +0,0 @@ - - - - - expect_expectl - Waits until the output from a process matches one - of the patterns, a specified time period has passed, or an EOF is seen - - - - &reftitle.description; - - intexpect_expectl - resourceexpect - arraycases - arraymatch - - - Waits until the output from a process matches one of the patterns, - a specified time period has passed, or an EOF is seen. - - - If match is provided, then it is filled with the result of search. - The matched string can be found in match[0]. - The match substrings (according to the parentheses) in the original pattern can be found - in match[1], match[2], and so - on, up to match[9] (the limitation of libexpect). - - - - &reftitle.parameters; - - - expect - - - An Expect stream, previously opened with - expect_popen. - - - - - cases - - - An array of expect cases. Each expect case is an indexed array, - as described in the following table: - - Expect Case Array - - - - Index Key - Value Type - Description - Is Mandatory - Default Value - - - - - 0 - string - pattern, that will be matched against the output from the stream - yes - - - - 1 - mixed - value, that will be returned by this function, if the pattern matches - yes - - - - 2 - integer - - pattern type, one of: - EXP_GLOB, - EXP_EXACT - or - EXP_REGEXP - - no - EXP_GLOB - - - -
-
-
-
-
-
- - &reftitle.returnvalues; - - Returns value associated with the pattern that was matched. - - - On failure this function returns: - EXP_EOF, - EXP_TIMEOUT - or - EXP_FULLBUFFER - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL expect 0.2.1 - - Prior to version 0.2.1, in match parameter a match string was returned, - not an array of match substrings. - - - - - - - - &reftitle.examples; - - <function>expect_expectl</function> example - - -]]> - - - - - &reftitle.seealso; - - expect_popen - - -
- diff --git a/reference/expect/functions/expect-popen.xml b/reference/expect/functions/expect-popen.xml deleted file mode 100644 index ae96a02286f6..000000000000 --- a/reference/expect/functions/expect-popen.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - expect_popen - Execute command via Bourne shell, and open the PTY stream to - the process - - - &reftitle.description; - - resourceexpect_popen - stringcommand - - - Execute command via Bourne shell, and open the PTY stream to the process. - - - - &reftitle.parameters; - - - command - - - Command to execute. - - - - - - - &reftitle.returnvalues; - - Returns an open PTY stream to the processes stdio, - stdout, and stderr. - - - On failure this function returns &false;. - - - - &reftitle.examples; - - <function>expect_popen</function> example - - -]]> - - - - - &reftitle.seealso; - - popen - - - - diff --git a/reference/expect/ini.xml b/reference/expect/ini.xml deleted file mode 100644 index 0a39e9df559e..000000000000 --- a/reference/expect/ini.xml +++ /dev/null @@ -1,143 +0,0 @@ - - -
- &reftitle.runtime; - &extension.runtime; - - In order to configure expect extension, there are configuration options - in the configuration file &php.ini;. - - Expect &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - expect.timeout - "10" - INI_ALL - - - - expect.loguser - "1" - INI_ALL - - - - expect.logfile - "" - INI_ALL - - - - expect.match_max - "" - INI_ALL - - - - -
- &ini.php.constants; -
- - &ini.descriptions.title; - - - - - expect.timeout - int - - - - The timeout period for waiting for the data, when using the - expect_expectl function. - - - A value of "-1" disables a timeout from occurring. - - - - A value of "0" causes the expect_expectl - function to return immediately. - - - - - - - - expect.loguser - bool - - - - Whether expect should send any output from the spawned process to stdout. - Since interactive programs typically echo their input, this usually suffices - to show both sides of the conversation. - - - - - - - expect.logfile - string - - - - Name of the file, where the output from the spawned process will be - written. If this file doesn't exist, it will be created. - - - - If this configuration is not empty, the output is written regardless of - the value of expect.loguser. - - - - - - - - expect.match_max - int - - - - Changes default size (2000 bytes) of the buffer used to match asterisks - in patterns. - - - - - -
- diff --git a/reference/expect/reference.xml b/reference/expect/reference.xml deleted file mode 100644 index 6baf6c8f8e8c..000000000000 --- a/reference/expect/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - Expect &Functions; -&reference.expect.entities.functions; - - - - - diff --git a/reference/expect/setup.xml b/reference/expect/setup.xml deleted file mode 100644 index dc7b5b1de595..000000000000 --- a/reference/expect/setup.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - &reftitle.setup; - - -
- &reftitle.required; - - This module uses the functions of the expect library. - You need libexpect version >= 5.43.0. - -
- - - - &reference.expect.configure; - - - - &reference.expect.ini; - - - -
- &reftitle.resources; - - expect_popen returns an open PTY stream used by - expect_expectl. - -
- - -
- diff --git a/reference/expect/versions.xml b/reference/expect/versions.xml deleted file mode 100644 index 2343489ba8ca..000000000000 --- a/reference/expect/versions.xml +++ /dev/null @@ -1,28 +0,0 @@ - - - - - - - - - diff --git a/reference/fann/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/fann/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/fann/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/fann/book.xml b/reference/fann/book.xml deleted file mode 100644 index 2f0a021684dc..000000000000 --- a/reference/fann/book.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - - FANN (Fast Artificial Neural Network) - FANN - - - &reftitle.intro; - - PHP binding for FANN (Fast Artificial Neural Network) Library which implements multilayer - artificial neural networks with support for both fully connected and sparsely connected networks. - It includes a framework for easy handling of training data sets. It is easy to use, versatile, - well documented, and fast. - - - - &reference.fann.setup; - &reference.fann.constants; - &reference.fann.examples; - &reference.fann.reference; - &reference.fann.fannconnection; - - - - diff --git a/reference/fann/configure.xml b/reference/fann/configure.xml deleted file mode 100644 index 60beca5d9ead..000000000000 --- a/reference/fann/configure.xml +++ /dev/null @@ -1,35 +0,0 @@ - - - -
- &reftitle.install; - - - &pecl.info; - &url.pecl.package;fann - - - -
- - - diff --git a/reference/fann/constants.xml b/reference/fann/constants.xml deleted file mode 100644 index 91ad9ed6e064..000000000000 --- a/reference/fann/constants.xml +++ /dev/null @@ -1,617 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - - Training algorithms - - - FANN_TRAIN_INCREMENTAL - (int) - - - - Standard backpropagation algorithm, where the weights are updated after each training pattern. - This means that the weights are updated many times during a single epoch. For this reason some problems, - will train very fast with this algorithm, while other more advanced problems will not train very well. - - - - - - FANN_TRAIN_BATCH - (int) - - - - Standard backpropagation algorithm, where the weights are updated after calculating the mean square error - for the whole training set. This means that the weights are only updated once during an epoch. - For this reason, some problems will train slower with this algorithm. But since the mean square - error is calculated more correctly than in incremental training, some problems will reach better - solutions with this algorithm. - - - - - - FANN_TRAIN_RPROP - (int) - - - - A more advanced batch training algorithm which achieves good results for many problems. The RPROP - training algorithm is adaptive, and therefore does not use the learning_rate. Some other parameters - can however be set to change the way the RPROP algorithm works, but it is only recommended - for users with insight in how the RPROP training algorithm works. The RPROP training algorithm - is described by [Riedmiller and Braun, 1993], but the actual learning algorithm used here is - the iRPROP- training algorithm which is described by [Igel and Husken, 2000] which is a variety - of the standard RPROP training algorithm. - - - - - - FANN_TRAIN_QUICKPROP - (int) - - - - A more advanced batch training algorithm which achieves good results for many problems. - The quickprop training algorithm uses the learning_rate parameter along with other more advanced parameters, - but it is only recommended to change these advanced parameters for users with insight into how the quickprop - training algorithm works. The quickprop training algorithm is described by [Fahlman, 1988]. - - - - - - FANN_TRAIN_SARPROP - (int) - - - - Even more advance training algorithm. Only for version 2.2 - - - - - - Activation functions - - - FANN_LINEAR - (int) - - - - Linear activation function. - - - - - - FANN_THRESHOLD - (int) - - - - Threshold activation function. - - - - - - FANN_THRESHOLD_SYMMETRIC - (int) - - - - Threshold activation function. - - - - - - FANN_SIGMOID - (int) - - - - Sigmoid activation function. - - - - - - FANN_SIGMOID_STEPWISE - (int) - - - - Stepwise linear approximation to sigmoid. - - - - - - FANN_SIGMOID_SYMMETRIC - (int) - - - - Symmetric sigmoid activation function, aka. tanh. - - - - - - FANN_SIGMOID_SYMMETRIC_STEPWISE - (int) - - - - Stepwise linear approximation to symmetric sigmoid - - - - - - FANN_GAUSSIAN - (int) - - - - Gaussian activation function. - - - - - - FANN_GAUSSIAN_SYMMETRIC - (int) - - - - Symmetric Gaussian activation function. - - - - - - FANN_GAUSSIAN_STEPWISE - (int) - - - - Stepwise Gaussian activation function. - - - - - - FANN_ELLIOT - (int) - - - - Fast (sigmoid-like) activation function defined by David Elliott. - - - - - - FANN_ELLIOT_SYMMETRIC - (int) - - - - Fast (symmetric sigmoid-like) activation function defined by David Elliott. - - - - - - FANN_LINEAR_PIECE - (int) - - - - Bounded linear activation function. - - - - - - FANN_LINEAR_PIECE_SYMMETRIC - (int) - - - - Bounded linear activation function. - - - - - - FANN_SIN_SYMMETRIC - (int) - - - - Periodical sinus activation function. - - - - - - FANN_COS_SYMMETRIC - (int) - - - - Periodical cosinus activation function. - - - - - - FANN_SIN - (int) - - - - Periodical sinus activation function. - - - - - - FANN_COS - (int) - - - - Periodical cosinus activation function. - - - - - - Error function used during training - - - FANN_ERRORFUNC_LINEAR - (int) - - - - Standard linear error function. - - - - - - FANN_ERRORFUNC_TANH - (int) - - - - Tanh error function; usually better but may require a lower learning rate. This error function aggressively - targets outputs that differ much from the desired output, while not targeting outputs that differ only slightly. - Not recommended for cascade or incremental training. - - - - - - Stop criteria used during training - - - FANN_STOPFUNC_MSE - (int) - - - - Stop criteria is Mean Square Error (MSE) value. - - - - - - FANN_STOPFUNC_BIT - (int) - - - - Stop criterion is number of bits that fail. The number of bits means the number of output neurons - which differ more than the bit fail limit (see fann_get_bit_fail_limit, fann_set_bit_fail_limit). The bits are counted - in all of the training data, so this number can be higher than the number of training data. - - - - - - Definition of network types used by <function>fann_get_network_type</function> - - - FANN_NETTYPE_LAYER - (int) - - - - Each layer only has connections to the next layer. - - - - - - FANN_NETTYPE_SHORTCUT - (int) - - - - Each layer has connections to all following layers - - - - - - Errors - - - FANN_E_NO_ERROR - (int) - - - - No error. - - - - - - FANN_E_CANT_OPEN_CONFIG_R - (int) - - - - Unable to open configuration file for reading. - - - - - - FANN_E_CANT_OPEN_CONFIG_W - (int) - - - - Unable to open configuration file for writing. - - - - - - FANN_E_WRONG_CONFIG_VERSION - (int) - - - - Wrong version of configuration file. - - - - - - FANN_E_CANT_READ_CONFIG - (int) - - - - Error reading info from configuration file. - - - - - - FANN_E_CANT_READ_NEURON - (int) - - - - Error reading neuron info from configuration file. - - - - - - FANN_E_CANT_READ_CONNECTIONS - (int) - - - - Error reading connections from configuration file. - - - - - - FANN_E_WRONG_NUM_CONNECTIONS - (int) - - - - Number of connections not equal to the number expected. - - - - - - FANN_E_CANT_OPEN_TD_W - (int) - - - - Unable to open train data file for writing. - - - - - - FANN_E_CANT_OPEN_TD_R - (int) - - - - Unable to open train data file for reading. - - - - - - FANN_E_CANT_READ_TD - (int) - - - - Error reading training data from file. - - - - - - FANN_E_CANT_ALLOCATE_MEM - (int) - - - - Unable to allocate memory. - - - - - - FANN_E_CANT_TRAIN_ACTIVATION - (int) - - - - Unable to train with the selected activation function. - - - - - - FANN_E_CANT_USE_ACTIVATION - (int) - - - - Unable to use the selected activation function. - - - - - - FANN_E_TRAIN_DATA_MISMATCH - (int) - - - - Irreconcilable differences between two struct fann_train_data structures. - - - - - - FANN_E_CANT_USE_TRAIN_ALG - (int) - - - - Unable to use the selected training algorithm. - - - - - - FANN_E_TRAIN_DATA_SUBSET - (int) - - - - Trying to take subset which is not within the training set. - - - - - - FANN_E_INDEX_OUT_OF_BOUND - (int) - - - - Index is out of bound. - - - - - - FANN_E_SCALE_NOT_PRESENT - (int) - - - - Scaling parameters not present. - - - - - - FANN_E_INPUT_NO_MATCH - (int) - - - - The number of input neurons in the ann and data do not match - - - - - - FANN_E_OUTPUT_NO_MATCH - (int) - - - - The number of output neurons in the ann and data do not match. - - - - - - - - diff --git a/reference/fann/examples.xml b/reference/fann/examples.xml deleted file mode 100644 index b75afdf1182c..000000000000 --- a/reference/fann/examples.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - &reftitle.examples; -
- XOR training - - This example shows how to train data for XOR function - - xor.data file - - - - - - Simple train - - -]]> - - - - - This example shows how to read and run data for XOR function - - Simple test - - %f\n", $input[0], $input[1], $calc_out[0]); -fann_destroy($ann); -?> -]]> - - - -
-
- - diff --git a/reference/fann/fannconnection.xml b/reference/fann/fannconnection.xml deleted file mode 100644 index 38e495f14df8..000000000000 --- a/reference/fann/fannconnection.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - The FANNConnection class - FANNConnection - - - - -
- &reftitle.intro; - - FANNConnection is used for the neural network connection. - The objects of this class are used in fann_get_connection_array and fann_set_weight_array. - -
- - -
- &reftitle.classsynopsis; - - - - FANNConnection - - - - - FANNConnection - - - - &Properties; - - public - from_neuron - - - public - to_neuron - - - public - weight - - - - &Methods; - - - - - -
- - - -
- &reftitle.properties; - - - from_neuron - - The neuron where the connection starts. - - - - to_neuron - - The neuron where the connection ends. - - - - weight - - The weight of the connection. - - - -
- - - -
- - &reference.fann.entities.fannconnection; - -
- - diff --git a/reference/fann/fannconnection/construct.xml b/reference/fann/fannconnection/construct.xml deleted file mode 100644 index aac25fa61729..000000000000 --- a/reference/fann/fannconnection/construct.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - FANNConnection::__construct - The connection constructor - - - - &reftitle.description; - - public FANNConnection::__construct - intfrom_neuron - intto_neuron - floatweight - - - Create new connection and initialize its params. After creating the connection, only weight can be changed. - - - - - &reftitle.parameters; - - - from_neuron - - - The position number of starting neuron. - - - - - to_neuron - - - The position number of terminating neuron. - - - - - weight - - - The connection weight value. - - - - - - - - - diff --git a/reference/fann/fannconnection/getfromneuron.xml b/reference/fann/fannconnection/getfromneuron.xml deleted file mode 100644 index 27174aba97f5..000000000000 --- a/reference/fann/fannconnection/getfromneuron.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - FANNConnection::getFromNeuron - Returns the positions of starting neuron - - - - &reftitle.description; - - public intFANNConnection::getFromNeuron - - - - Returns the positions of starting neuron. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The positions of starting neuron. - - - - - - - diff --git a/reference/fann/fannconnection/gettoneuron.xml b/reference/fann/fannconnection/gettoneuron.xml deleted file mode 100644 index ab2aaa6d8f9b..000000000000 --- a/reference/fann/fannconnection/gettoneuron.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - FANNConnection::getToNeuron - Returns the positions of terminating neuron - - - - &reftitle.description; - - public intFANNConnection::getToNeuron - - - - Returns the positions of terminating neuron. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The positions of terminating neuron. - - - - - - - diff --git a/reference/fann/fannconnection/getweight.xml b/reference/fann/fannconnection/getweight.xml deleted file mode 100644 index 7eb99699b462..000000000000 --- a/reference/fann/fannconnection/getweight.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - FANNConnection::getWeight - Returns the connection weight - - - - &reftitle.description; - - public voidFANNConnection::getWeight - - - - Returns the connection weight. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The connection weight. - - - - - - - diff --git a/reference/fann/fannconnection/setweight.xml b/reference/fann/fannconnection/setweight.xml deleted file mode 100644 index c8a54431e9a0..000000000000 --- a/reference/fann/fannconnection/setweight.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - FANNConnection::setWeight - Sets the connections weight - - - - &reftitle.description; - - public voidFANNConnection::setWeight - floatweight - - - Sets the connection weight. - - - This method is different than fann_set_weight. It does not - update the weight value in the network. The network value is updated only after calling - fann_set_weight_array. - - - - - &reftitle.parameters; - - - - weight - - - The connection weight. - - - - - - - - - &reftitle.returnvalues; - &fann.return.void; - - - - - - diff --git a/reference/fann/functions/fann-cascadetrain-on-data.xml b/reference/fann/functions/fann-cascadetrain-on-data.xml deleted file mode 100644 index c9c359d7fb3c..000000000000 --- a/reference/fann/functions/fann-cascadetrain-on-data.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - fann_cascadetrain_on_data - Trains on an entire dataset, for a period of time using the Cascade2 training algorithm - - - - &reftitle.description; - - boolfann_cascadetrain_on_data - resourceann - resourcedata - intmax_neurons - intneurons_between_reports - floatdesired_error - - - The cascade output change fraction is a number between 0 and 1 determining how large a fraction - the fann_get_MSE value should change within fann_get_cascade_output_stagnation_epochs - during training of the output connections, in order for the training not to stagnate. If the training stagnates, - the training of the output connections will be ended and new candidates will be prepared. - - - This training uses the parameters set using the fann_set_cascade_..., but it also uses another training algorithm - as it’s internal training algorithm. This algorithm can be set to either FANN_TRAIN_RPROP or - FANN_TRAIN_QUICKPROP by fann_set_training_algorithm, and the parameters - set for these training algorithms will also affect the cascade training. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - data - - &fann.train.description; - - - - max_neurons - - - The maximum number of neurons to be added to neural network. - - - - - neurons_between_reports - - - The number of neurons between printing a status report. A value of zero means no reports should be printed. - - - - - desired_error - - - The desired fann_get_MSE or fann_get_bit_fail, - depending on which stop function is chosen by fann_set_train_stop_function - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_train_on_data - fann_cascadetrain_on_file - - - - - - - - diff --git a/reference/fann/functions/fann-cascadetrain-on-file.xml b/reference/fann/functions/fann-cascadetrain-on-file.xml deleted file mode 100644 index 9c1b9783311e..000000000000 --- a/reference/fann/functions/fann-cascadetrain-on-file.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - fann_cascadetrain_on_file - Trains on an entire dataset read from file, for a period of time using the Cascade2 training algorithm - - - - &reftitle.description; - - boolfann_cascadetrain_on_file - resourceann - stringfilename - intmax_neurons - intneurons_between_reports - floatdesired_error - - - Does the same as fann_cascadetrain_on_data, but reads the training data directly from a file. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - filename - - - A file containing the data for training. - - - - - max_neurons - - - The maximum number of neurons to be added to neural network - - - - - neurons_between_reports - - - The number of neurons between printing a status report. A value of zero means no reports should be printed. - - - - - desired_error - - - The desired fann_get_MSE or fann_get_bit_fail, - depending on which stop function is chosen by fann_set_train_stop_function. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_train_on_data - fann_cascadetrain_on_data - - - - - - - - diff --git a/reference/fann/functions/fann-clear-scaling-params.xml b/reference/fann/functions/fann-clear-scaling-params.xml deleted file mode 100644 index 8ee61b474d7c..000000000000 --- a/reference/fann/functions/fann-clear-scaling-params.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - fann_clear_scaling_params - Clears scaling parameters - - - - &reftitle.description; - - boolfann_clear_scaling_params - resourceann - - - Clears scaling parameters. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - - diff --git a/reference/fann/functions/fann-copy.xml b/reference/fann/functions/fann-copy.xml deleted file mode 100644 index 2a518ac14143..000000000000 --- a/reference/fann/functions/fann-copy.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - fann_copy - Creates a copy of a fann structure - - - - &reftitle.description; - - resourcefann_copy - resourceann - - - Creates a copy of a fann structure. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - Returns a copy of neural network resource on success, or &false; on error - - - - - &reftitle.notes; - &fann.note.function.fann-2.2; - - - - &reftitle.seealso; - - - fann_test - - - - - - - diff --git a/reference/fann/functions/fann-create-from-file.xml b/reference/fann/functions/fann-create-from-file.xml deleted file mode 100644 index f35844997512..000000000000 --- a/reference/fann/functions/fann-create-from-file.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - fann_create_from_file - Constructs a backpropagation neural network from a configuration file - - - - &reftitle.description; - - resourcefann_create_from_file - stringconfiguration_file - - - Constructs a backpropagation neural network from a configuration file, which have been saved by fann_save. - - - - - &reftitle.parameters; - - - configuration_file - - - The configuration file path. - - - - - - - - &reftitle.returnvalues; - &fann.return.ann; - - - - &reftitle.seealso; - - - fann_save - - - - - - - - diff --git a/reference/fann/functions/fann-create-shortcut-array.xml b/reference/fann/functions/fann-create-shortcut-array.xml deleted file mode 100644 index 2943e98c679d..000000000000 --- a/reference/fann/functions/fann-create-shortcut-array.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - fann_create_shortcut_array - Creates a standard backpropagation neural network which is not fully connected and has shortcut connections - - - - &reftitle.description; - - resourcefann_create_shortcut_array - intnum_layers - arraylayers - - - Creates a standard backpropagation neural network which is not fully connected and has shortcut connections using an array of layers sizes. - - - - - &reftitle.parameters; - - - num_layers - - - The total number of layers including the input and the output layer. - - - - - layers - - - An array of layers sizes. - - - - - - - - &reftitle.returnvalues; - - Returns a neural network resource on success, or &false; on error. - - - - - &reftitle.seealso; - - - fann_create_shortcut - fann_create_sparse - fann_create_standard - - - - - - - diff --git a/reference/fann/functions/fann-create-shortcut.xml b/reference/fann/functions/fann-create-shortcut.xml deleted file mode 100644 index 734727e43720..000000000000 --- a/reference/fann/functions/fann-create-shortcut.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - fann_create_shortcut - Creates a standard backpropagation neural network which is not fully connected and has shortcut connections - - - - &reftitle.description; - - resourcefann_create_shortcut - intnum_layers - intnum_neurons1 - intnum_neurons2 - intnum_neuronsN - - - Creates a standard backpropagation neural network, which is not fully connected and which also has shortcut connections. - - - Shortcut connections are connections that skip layers. A fully connected network with shortcut connections, is a network - where all neurons are connected to all neurons in later layers. Including direct connections from the input layer to the output layer. - - - - - &reftitle.parameters; - - - num_layers - - - The total number of layers including the input and the output layer. - - - - - num_neurons1 - - - Number of neurons in the first layer. - - - - - num_neurons2 - - - Number of neurons in the second layer. - - - - - num_neuronsN - - - Number of neurons in other layers. - - - - - - - - &reftitle.returnvalues; - - Returns a neural network resource on success, or &false; on error. - - - - - &reftitle.seealso; - - - fann_create_shortcut_array - fann_create_sparse - fann_create_standard - - - - - - - diff --git a/reference/fann/functions/fann-create-sparse-array.xml b/reference/fann/functions/fann-create-sparse-array.xml deleted file mode 100644 index 575b67f5a91e..000000000000 --- a/reference/fann/functions/fann-create-sparse-array.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - fann_create_sparse_array - Creates a standard backpropagation neural network, which is not fully connected using an array of layer sizes - - - - &reftitle.description; - - resourcefann_create_sparse_array - floatconnection_rate - intnum_layers - arraylayers - - - Creates a standard backpropagation neural network, which is not fully connected using an array of layer sizes. - - - - - &reftitle.parameters; - - - connection_rate - - - The connection rate controls how many connections there will be in the network. If the connection rate - is set to 1, the network will be fully connected, but if it is set to 0.5 only half of the connections - will be set. A connection rate of 1 will yield the same result as fann_create_standard. - - - - - num_layers - - - The total number of layers including the input and the output layer. - - - - - layers - - - An array of layer sizes. - - - - - - - - &reftitle.returnvalues; - - Returns a neural network resource on success, or &false; on error. - - - - - &reftitle.seealso; - - - fann_create_sparse - fann_create_standard - fann_create_shortcut - - - - - - - diff --git a/reference/fann/functions/fann-create-sparse.xml b/reference/fann/functions/fann-create-sparse.xml deleted file mode 100644 index 89e8019a69da..000000000000 --- a/reference/fann/functions/fann-create-sparse.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - fann_create_sparse - Creates a standard backpropagation neural network, which is not fully connected - - - - &reftitle.description; - - resourcefann_create_sparse - floatconnection_rate - intnum_layers - intnum_neurons1 - intnum_neurons2 - intnum_neuronsN - - - Creates a standard backpropagation neural network, which is not fully connected. - - - - - &reftitle.parameters; - - - connection_rate - - - The connection rate controls how many connections there will be in the network. If the connection rate - is set to 1, the network will be fully connected, but if it is set to 0.5 only half of the connections - will be set. A connection rate of 1 will yield the same result as fann_create_standard. - - - - - num_layers - - - The total number of layers including the input and the output layer. - - - - - num_neurons1 - - - Number of neurons in the first layer. - - - - - num_neurons2 - - - Number of neurons in the second layer. - - - - - num_neuronsN - - - Number of neurons in other layers. - - - - - - - - &reftitle.returnvalues; - - Returns a neural network resource on success, or &false; on error. - - - - - - &reftitle.seealso; - - - fann_create_sparse_array - fann_create_standard - fann_create_shortcut - - - - - - - diff --git a/reference/fann/functions/fann-create-standard-array.xml b/reference/fann/functions/fann-create-standard-array.xml deleted file mode 100644 index adc34ed03eb8..000000000000 --- a/reference/fann/functions/fann-create-standard-array.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - fann_create_standard_array - Creates a standard fully connected backpropagation neural network using an array of layer sizes - - - - &reftitle.description; - - resourcefann_create_standard_array - intnum_layers - arraylayers - - - Creates a standard fully connected backpropagation neural network. - - - There will be a bias neuron in each layer (except the output layer), - and this bias neuron will be connected to all neurons in the next layer. - When running the network, the bias nodes always emits 1. - - - To destroy a neural network use the fann_destroy function. - - - - - &reftitle.parameters; - - - num_layers - - - The total number of layers including the input and the output layer. - - - - - layers - - - An array of layer sizes. - - - - - - - - &reftitle.returnvalues; - - Returns a neural network resource on success, or &false; on error. - - - - - &reftitle.seealso; - - - fann_create_standard - fann_create_sparse - fann_create_shortcut - - - - - - - diff --git a/reference/fann/functions/fann-create-standard.xml b/reference/fann/functions/fann-create-standard.xml deleted file mode 100644 index 1f10a8c07f5b..000000000000 --- a/reference/fann/functions/fann-create-standard.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - fann_create_standard - Creates a standard fully connected backpropagation neural network - - - - &reftitle.description; - - resourcefann_create_standard - intnum_layers - intnum_neurons1 - intnum_neurons2 - intnum_neuronsN - - - Creates a standard fully connected backpropagation neural network. - - - There will be a bias neuron in each layer (except the output layer), - and this bias neuron will be connected to all neurons in the next layer. - When running the network, the bias nodes always emits 1. - - - To destroy a neural network use the fann_destroy function. - - - - - &reftitle.parameters; - - - num_layers - - - The total number of layers including the input and the output layer. - - - - - num_neurons1 - - - Number of neurons in the first layer. - - - - - num_neurons2 - - - Number of neurons in the second layer. - - - - - num_neuronsN - - - Number of neurons in other layers. - - - - - - - - &reftitle.returnvalues; - - Returns a neural network resource on success, or &false; on error. - - - - - &reftitle.seealso; - - - fann_create_standard_array - fann_create_sparse - fann_create_shortcut - - - - - - - diff --git a/reference/fann/functions/fann-create-train-from-callback.xml b/reference/fann/functions/fann-create-train-from-callback.xml deleted file mode 100644 index 49d1860cbe34..000000000000 --- a/reference/fann/functions/fann-create-train-from-callback.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - fann_create_train_from_callback - Creates the training data struct from a user supplied function - - - - &reftitle.description; - - resourcefann_create_train_from_callback - intnum_data - intnum_input - intnum_output - callableuser_function - - - Creates the training data struct from a user supplied function. As the training data are numerable (data 1, data 2...), - the user must write a function that receives the number of the training data set (input, output) and returns the set. - - - - - &reftitle.parameters; - - - num_data - - - The number of training data - - - - - num_input - - - The number of inputs per training data - - - - - num_output - - - The number of outputs per training data - - - - - user_function - - - The user supplied function with following parameters: - - num - The number of the training data set - num_input - The number of inputs per training data - num_output - The number of outputs per training data - - - - The function should return an associative array with keys input and output and - two array values of input and output. - - - - - - - - &reftitle.returnvalues; - &fann.return.train; - - - - &reftitle.examples; - - - <methodname>fann_create_train_from_callback</methodname> example - - array_fill(0, $num_input, 1), - "output" => array_fill(0, $num_output, 1), - ); -} - -$num_data = 3; -$num_input = 2; -$num_output = 1; -$train_data = fann_create_train_from_callback($num_data, $num_input, $num_output, "create_train_callback"); -if ($train_data) { - // Do something with $train_data -} -?> -]]> - - - - - - - &reftitle.notes; - &fann.note.function.fann-2.2; - - - - &reftitle.seealso; - - - fann_read_train_from_file - fann_train_on_data - fann_destroy_train - fann_save_train - - - - - - - - diff --git a/reference/fann/functions/fann-create-train.xml b/reference/fann/functions/fann-create-train.xml deleted file mode 100644 index 3ff6c5bef425..000000000000 --- a/reference/fann/functions/fann-create-train.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - fann_create_train - Creates an empty training data struct - - - - &reftitle.description; - - resourcefann_create_train - intnum_data - intnum_input - intnum_output - - - Creates an empty training data struct. - - - - - &reftitle.parameters; - - - num_data - - - The number of training data - - - - - num_input - - - The number of inputs per training data - - - - - num_output - - - The number of outputs per training data - - - - - - - - &reftitle.returnvalues; - &fann.return.train; - - - - &reftitle.notes; - &fann.note.function.fann-2.2; - - - - &reftitle.seealso; - - - fann_read_train_from_file - fann_train_on_data - fann_destroy_train - fann_save_train - - - - - - - - diff --git a/reference/fann/functions/fann-descale-input.xml b/reference/fann/functions/fann-descale-input.xml deleted file mode 100644 index 78c37cabb35c..000000000000 --- a/reference/fann/functions/fann-descale-input.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - fann_descale_input - Scale data in input vector after get it from ann based on previously calculated parameters - - - - &reftitle.description; - - boolfann_descale_input - resourceann - arrayinput_vector - - - Scale data in input vector after get it from ann based on previously calculated parameters. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - input_vector - - - Input vector that will be descaled - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_scale_input - fann_descale_output - - - - - - - - diff --git a/reference/fann/functions/fann-descale-output.xml b/reference/fann/functions/fann-descale-output.xml deleted file mode 100644 index 6be8037907c0..000000000000 --- a/reference/fann/functions/fann-descale-output.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - fann_descale_output - Scale data in output vector after get it from ann based on previously calculated parameters - - - - &reftitle.description; - - boolfann_descale_output - resourceann - arrayoutput_vector - - - Scale data in output vector after get it from ann based on previously calculated parameters. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - output_vector - - - Output vector that will be descaled - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_scale_output - fann_descale_input - - - - - - - - diff --git a/reference/fann/functions/fann-descale-train.xml b/reference/fann/functions/fann-descale-train.xml deleted file mode 100644 index 492208a8528b..000000000000 --- a/reference/fann/functions/fann-descale-train.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - fann_descale_train - Descale input and output data based on previously calculated parameters - - - - &reftitle.description; - - boolfann_descale_train - resourceann - resourcetrain_data - - - Descale input and output data based on previously calculated parameters. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - train_data - - &fann.train.description; - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_scale_train - fann_set_scaling_params - - - - - - - - diff --git a/reference/fann/functions/fann-destroy-train.xml b/reference/fann/functions/fann-destroy-train.xml deleted file mode 100644 index 8096939960d4..000000000000 --- a/reference/fann/functions/fann-destroy-train.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - fann_destroy_train - Destructs the training data - - - - &reftitle.description; - - boolfann_destroy_train - resourcetrain_data - - - Destructs the training data - - - - - &reftitle.parameters; - - - train_data - - &fann.train.description; - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - - diff --git a/reference/fann/functions/fann-destroy.xml b/reference/fann/functions/fann-destroy.xml deleted file mode 100644 index 781fc2a8e53b..000000000000 --- a/reference/fann/functions/fann-destroy.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - fann_destroy - Destroys the entire network and properly freeing all the associated memory - - - - &reftitle.description; - - boolfann_destroy - resourceann - - - Destroys the entire network and properly freeing all the associated memory. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - - - diff --git a/reference/fann/functions/fann-duplicate-train-data.xml b/reference/fann/functions/fann-duplicate-train-data.xml deleted file mode 100644 index cfc7c3135328..000000000000 --- a/reference/fann/functions/fann-duplicate-train-data.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - fann_duplicate_train_data - Returns an exact copy of a fann train data - - - - &reftitle.description; - - resourcefann_duplicate_train_data - resourcedata - - - Returns an exact copy of a fann train data resource. - - - - - &reftitle.parameters; - - - data - - &fann.train.description; - - - - - - - &reftitle.returnvalues; - &fann.return.train; - - - - - diff --git a/reference/fann/functions/fann-get-activation-function.xml b/reference/fann/functions/fann-get-activation-function.xml deleted file mode 100644 index 2cc6a3e733d9..000000000000 --- a/reference/fann/functions/fann-get-activation-function.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - fann_get_activation_function - Returns the activation function - - - - &reftitle.description; - - intfann_get_activation_function - resourceann - intlayer - intneuron - - - Get the activation function for neuron number neuron in layer number - layer, counting the input layer as layer 0. - - - It is not possible to get activation functions for the neurons in the input layer. - - - The return value is one of the activation functions constants. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - layer - - - Layer number. - - - - - neuron - - - Neuron number. - - - - - - - - &reftitle.returnvalues; - - Activation functions constant or -1 - if the neuron is not defined in the neural network, or &false; on error. - - - - - &reftitle.seealso; - - - fann_set_activation_function_layer - fann_set_activation_function_hidden - fann_set_activation_function_output - fann_set_activation_steepness - fann_set_activation_function - - - - - - - - diff --git a/reference/fann/functions/fann-get-activation-steepness.xml b/reference/fann/functions/fann-get-activation-steepness.xml deleted file mode 100644 index 144202bc5f42..000000000000 --- a/reference/fann/functions/fann-get-activation-steepness.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - fann_get_activation_steepness - Returns the activation steepness for supplied neuron and layer number - - - - &reftitle.description; - - floatfann_get_activation_steepness - resourceann - intlayer - intneuron - - - Get the activation steepness for neuron number neuron in layer number - layer, counting the input layer as layer 0. - - - It is not possible to get activation steepness for the neurons in the input layer. - - - The steepness of an activation function says something about how fast the activation function goes - from the minimum to the maximum. A high value for the activation function will also give a more aggressive training. - - - When training neural networks where the output values should be at the extremes - (usually 0 and 1, depending on the activation function), a steep activation function can be used (e.g. 1.0). - - - The default activation steepness is 0.5. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - layer - - - Layer number - - - - - neuron - - - Neuron number - - - - - - - - &reftitle.returnvalues; - - The activation steepness for the neuron or -1 if the neuron is not defined in the neural network, or &false; on error. - - - - - &reftitle.seealso; - - - fann_set_activation_function - fann_set_activation_steepness_layer - fann_set_activation_steepness_hidden - fann_set_activation_steepness_output - fann_set_activation_steepness - - - - - - - - diff --git a/reference/fann/functions/fann-get-bias-array.xml b/reference/fann/functions/fann-get-bias-array.xml deleted file mode 100644 index 3cf70f0b5e08..000000000000 --- a/reference/fann/functions/fann-get-bias-array.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - fann_get_bias_array - Get the number of bias in each layer in the network - - - - &reftitle.description; - - arrayfann_get_bias_array - resourceann - - - Get the number of bias in each layer in the network. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - An array of numbers of bias in each layer - - - - - - - diff --git a/reference/fann/functions/fann-get-bit-fail-limit.xml b/reference/fann/functions/fann-get-bit-fail-limit.xml deleted file mode 100644 index c1bc09a4cfb3..000000000000 --- a/reference/fann/functions/fann-get-bit-fail-limit.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - fann_get_bit_fail_limit - Returns the bit fail limit used during training - - - - &reftitle.description; - - floatfann_get_bit_fail_limit - resourceann - - - Returns the bit fail limit used during training. - - - The bit fail limit is used during training where the stop function - is set to FANN_STOPFUNC_BIT. - - - The limit is the maximum accepted difference between the desired output and the actual output during training. - Each output that diverges more than this limit is counted as an error bit. This difference is divided by two - when dealing with symmetric activation functions, so that symmetric and not symmetric activation functions - can use the same limit. - - - The default bit fail limit is 0.35. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - The bit fail limit, or &false; on error. - - - - - &reftitle.seealso; - - - fann_set_bit_fail_limit - - - - - - - - diff --git a/reference/fann/functions/fann-get-bit-fail.xml b/reference/fann/functions/fann-get-bit-fail.xml deleted file mode 100644 index 54a211084269..000000000000 --- a/reference/fann/functions/fann-get-bit-fail.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - fann_get_bit_fail - The number of fail bits - - - - &reftitle.description; - - intfann_get_bit_fail - resourceann - - - The number of fail bits; means the number of output neurons which differ more than the bit fail limit - (see fann_get_bit_fail_limit, fann_set_bit_fail_limit). - The bits are counted in all of the training data, so this number can be higher than the number of training data. - - - This value is reset by fann_reset_MSE and updated by all the same functions - which also updates the MSE value (e.g. fann_test_data, fann_train_epoch) - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - The number of bits fail, or &false; on error. - - - - - &reftitle.seealso; - - - fann_get_MSE - fann_reset_MSE - fann_test_data - fann_train_epoch - fann_get_bit_fail_limit - fann_set_bit_fail_limit - - - - - - - diff --git a/reference/fann/functions/fann-get-cascade-activation-functions-count.xml b/reference/fann/functions/fann-get-cascade-activation-functions-count.xml deleted file mode 100644 index c40e4778cd90..000000000000 --- a/reference/fann/functions/fann-get-cascade-activation-functions-count.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - fann_get_cascade_activation_functions_count - Returns the number of cascade activation functions - - - - &reftitle.description; - - intfann_get_cascade_activation_functions_count - resourceann - - - The number of activation functions in the fann_get_cascade_activation_functions array. - - - The default number of activation functions is 6. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - The number of cascade activation functions, or &false; on error. - - - - - &reftitle.seealso; - - - fann_get_cascade_activation_functions - fann_set_cascade_activation_functions - - - - - - - - diff --git a/reference/fann/functions/fann-get-cascade-activation-functions.xml b/reference/fann/functions/fann-get-cascade-activation-functions.xml deleted file mode 100644 index 31a07e1832e7..000000000000 --- a/reference/fann/functions/fann-get-cascade-activation-functions.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - fann_get_cascade_activation_functions - Returns the cascade activation functions - - - - &reftitle.description; - - arrayfann_get_cascade_activation_functions - resourceann - - - The cascade activation functions array is an array of the different activation functions used by the candidates - - - See fann_get_cascade_num_candidates for a description of which candidate neurons will be generated by this array. - - - The default activation functions are FANN_SIGMOID, FANN_SIGMOID_SYMMETRIC, - FANN_GAUSSIAN, FANN_GAUSSIAN_SYMMETRIC, FANN_ELLIOT, - FANN_ELLIOT_SYMMETRIC. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - The cascade activation functions, or &false; on error. - - - - - &reftitle.seealso; - - - fann_get_cascade_activation_functions_count - fann_set_cascade_activation_functions - - - - - - - - diff --git a/reference/fann/functions/fann-get-cascade-activation-steepnesses-count.xml b/reference/fann/functions/fann-get-cascade-activation-steepnesses-count.xml deleted file mode 100644 index 396aca1c85be..000000000000 --- a/reference/fann/functions/fann-get-cascade-activation-steepnesses-count.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - fann_get_cascade_activation_steepnesses_count - The number of activation steepnesses - - - - &reftitle.description; - - intfann_get_cascade_activation_steepnesses_count - resourceann - - - The number of activation steepnesses in the fann_get_cascade_activation_functions array. - - - The default number of activation steepnesses is 4. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - The number of activation steepnesses, or &false; on error. - - - - - &reftitle.seealso; - - - fann_get_cascade_activation_steepnesses - fann_set_cascade_activation_functions - - - - - - - - diff --git a/reference/fann/functions/fann-get-cascade-activation-steepnesses.xml b/reference/fann/functions/fann-get-cascade-activation-steepnesses.xml deleted file mode 100644 index ad42c7a831c5..000000000000 --- a/reference/fann/functions/fann-get-cascade-activation-steepnesses.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - fann_get_cascade_activation_steepnesses - Returns the cascade activation steepnesses - - - - &reftitle.description; - - arrayfann_get_cascade_activation_steepnesses - resourceann - - - The cascade activation steepnesses array is an array of the different activation functions used by the candidates. - - - See fann_get_cascade_num_candidates for a description of which candidate neurons will be generated by this array. - - - The default activation steepnesses are {0.25, 0.50, 0.75, 1.00}. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - The cascade activation steepnesses, or &false; on error. - - - - - &reftitle.seealso; - - - fann_get_cascade_activation_steepnesses_count - fann_set_cascade_activation_steepnesses - - - - - - - - diff --git a/reference/fann/functions/fann-get-cascade-candidate-change-fraction.xml b/reference/fann/functions/fann-get-cascade-candidate-change-fraction.xml deleted file mode 100644 index aa28b5cfe9bf..000000000000 --- a/reference/fann/functions/fann-get-cascade-candidate-change-fraction.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - fann_get_cascade_candidate_change_fraction - Returns the cascade candidate change fraction - - - - &reftitle.description; - - floatfann_get_cascade_candidate_change_fraction - resourceann - - - The cascade candidate change fraction is a number between 0 and 1 determining how large a fraction the fann_get_MSE - value should change within fann_get_cascade_candidate_stagnation_epochs during training of the candidate neurons, - in order for the training not to stagnate. If the training stagnates, the training of the candidate neurons will be ended - and the best candidate will be selected. - - - It means that if the MSE does not change by a fraction of fann_get_cascade_candidate_change_fraction during - a period of fann_get_cascade_candidate_stagnation_epochs, the training of the candidate neurons is stopped - because the training has stagnated. - - - If the cascade candidate change fraction is low, the candidate neurons will be trained more and if the fraction is high they will be trained less. - - - The default cascade candidate change fraction is 0.01, which is equivalent to a 1% change in MSE. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - The cascade candidate change fraction, or &false; on error. - - - - - &reftitle.seealso; - - - fann_set_cascade_candidate_change_fraction - fann_get_MSE - fann_get_cascade_candidate_stagnation_epochs - - - - - - - - diff --git a/reference/fann/functions/fann-get-cascade-candidate-limit.xml b/reference/fann/functions/fann-get-cascade-candidate-limit.xml deleted file mode 100644 index 06829b921f8b..000000000000 --- a/reference/fann/functions/fann-get-cascade-candidate-limit.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - fann_get_cascade_candidate_limit - Return the candidate limit - - - - &reftitle.description; - - floatfann_get_cascade_candidate_limit - resourceann - - - The candidate limit is a limit for how much the candidate neuron may be trained. The limit is a limit - on the proportion between the MSE and candidate score. - - - Set this to a lower value to avoid overfitting and to a higher if overfitting is not a problem. - - - The default candidate limit is 1000.0. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - The candidate limit, or &false; on error. - - - - - &reftitle.seealso; - - - fann_set_cascade_candidate_limit - - - - - - - - diff --git a/reference/fann/functions/fann-get-cascade-candidate-stagnation-epochs.xml b/reference/fann/functions/fann-get-cascade-candidate-stagnation-epochs.xml deleted file mode 100644 index ae98c4b6a25a..000000000000 --- a/reference/fann/functions/fann-get-cascade-candidate-stagnation-epochs.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - fann_get_cascade_candidate_stagnation_epochs - Returns the number of cascade candidate stagnation epochs - - - - &reftitle.description; - - intfann_get_cascade_candidate_stagnation_epochs - resourceann - - - The number of cascade candidate stagnation epochs determines the number of epochs training is allowed to continue - without changing the MSE by a fraction of fann_get_cascade_candidate_change_fraction. - - - See more info about this parameter in fann_get_cascade_candidate_change_fraction. - - - The default number of cascade candidate stagnation epochs is 12. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - The number of cascade candidate stagnation epochs, or &false; on error. - - - - - &reftitle.seealso; - - - fann_set_cascade_candidate_stagnation_epochs - fann_get_cascade_candidate_change_fraction - - - - - - - - diff --git a/reference/fann/functions/fann-get-cascade-max-cand-epochs.xml b/reference/fann/functions/fann-get-cascade-max-cand-epochs.xml deleted file mode 100644 index 748774231780..000000000000 --- a/reference/fann/functions/fann-get-cascade-max-cand-epochs.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - fann_get_cascade_max_cand_epochs - Returns the maximum candidate epochs - - - - &reftitle.description; - - intfann_get_cascade_max_cand_epochs - resourceann - - - The maximum candidate epochs determines the maximum number of epochs the input connections - to the candidates may be trained before adding a new candidate neuron. - - - The default max candidate epochs is 150. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - The maximum candidate epochs, or &false; on error. - - - - - &reftitle.seealso; - - - fann_set_cascade_max_cand_epochs - - - - - - - - diff --git a/reference/fann/functions/fann-get-cascade-max-out-epochs.xml b/reference/fann/functions/fann-get-cascade-max-out-epochs.xml deleted file mode 100644 index 13bf56d74bc5..000000000000 --- a/reference/fann/functions/fann-get-cascade-max-out-epochs.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - fann_get_cascade_max_out_epochs - Returns the maximum out epochs - - - - &reftitle.description; - - intfann_get_cascade_max_out_epochs - resourceann - - - The maximum out epochs determines the maximum number of epochs the output connections may be - trained after adding a new candidate neuron. - - - The default max out epochs is 150. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - The maximum out epochs, or &false; on error. - - - - - &reftitle.seealso; - - - fann_set_cascade_max_out_epochs - - - - - - - - diff --git a/reference/fann/functions/fann-get-cascade-min-cand-epochs.xml b/reference/fann/functions/fann-get-cascade-min-cand-epochs.xml deleted file mode 100644 index 2460f5cba005..000000000000 --- a/reference/fann/functions/fann-get-cascade-min-cand-epochs.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - fann_get_cascade_min_cand_epochs - Returns the minimum candidate epochs - - - - &reftitle.description; - - intfann_get_cascade_min_cand_epochs - resourceann - - - The minimum candidate epochs determines the minimum number of epochs the input connections - to the candidates may be trained before adding a new candidate neuron. - - - The default min candidate epochs is 50. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - The minimum candidate epochs, or &false; on error. - - - - - &reftitle.notes; - &fann.note.function.fann-2.2; - - - - &reftitle.seealso; - - - fann_set_cascade_min_cand_epochs - - - - - - - - diff --git a/reference/fann/functions/fann-get-cascade-min-out-epochs.xml b/reference/fann/functions/fann-get-cascade-min-out-epochs.xml deleted file mode 100644 index c95413674676..000000000000 --- a/reference/fann/functions/fann-get-cascade-min-out-epochs.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - fann_get_cascade_min_out_epochs - Returns the minimum out epochs - - - - &reftitle.description; - - intfann_get_cascade_min_out_epochs - resourceann - - - The minimum out epochs determines the minimum number of epochs the output connections must be trained - after adding a new candidate neuron. - - - The default min out epochs is 50. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - The minimum out epochs, or &false; on error. - - - - - &reftitle.notes; - &fann.note.function.fann-2.2; - - - - &reftitle.seealso; - - - fann_set_cascade_min_out_epochs - - - - - - - - diff --git a/reference/fann/functions/fann-get-cascade-num-candidate-groups.xml b/reference/fann/functions/fann-get-cascade-num-candidate-groups.xml deleted file mode 100644 index fe08e6970462..000000000000 --- a/reference/fann/functions/fann-get-cascade-num-candidate-groups.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - fann_get_cascade_num_candidate_groups - Returns the number of candidate groups - - - - &reftitle.description; - - intfann_get_cascade_num_candidate_groups - resourceann - - - The number of candidate groups is the number of groups of identical candidates which will be used during training. - - - This number can be used to have more candidates without having to define new parameters for the candidates. - - - See fann_get_cascade_num_candidates for a description of - which candidate neurons will be generated by this parameter. - - - The default number of candidate groups is 2. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - The number of candidate groups, or &false; on error. - - - - - &reftitle.seealso; - - - fann_set_cascade_num_candidate_groups - - - - - - - - diff --git a/reference/fann/functions/fann-get-cascade-num-candidates.xml b/reference/fann/functions/fann-get-cascade-num-candidates.xml deleted file mode 100644 index a462f53ab276..000000000000 --- a/reference/fann/functions/fann-get-cascade-num-candidates.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - fann_get_cascade_num_candidates - Returns the number of candidates used during training - - - - &reftitle.description; - - intfann_get_cascade_num_candidates - resourceann - - - The number of candidates used during training (calculated by multiplying - fann_get_cascade_activation_functions_count, - fann_get_cascade_activation_steepnesses_count and - fann_get_cascade_num_candidate_groups). - - - The actual candidates is defined by the fann_get_cascade_activation_functions and - fann_get_cascade_activation_steepnesses arrays. These arrays define the activation functions and - activation steepnesses used for the candidate neurons. If there are 2 activation functions in the activation function array and - 3 steepnesses in the steepness array, then there will be 2x3=6 different candidates which will be trained. These 6 different - candidates can be copied into several candidate groups, where the only difference between these groups is the initial weights. - If the number of groups is set to 2, then the number of candidate neurons will be 2x3x2=12. - The number of candidate groups is defined by fann_set_cascade_num_candidate_groups. - - - The default number of candidates is 6x4x2 = 48 - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - The number of candidates used during training, or &false; on error. - - - - - &reftitle.seealso; - - - fann_get_cascade_activation_functions - fann_get_cascade_activation_functions_count - fann_get_cascade_activation_steepnesses - fann_get_cascade_activation_steepnesses_count - fann_get_cascade_num_candidate_groups - - - - - - - - diff --git a/reference/fann/functions/fann-get-cascade-output-change-fraction.xml b/reference/fann/functions/fann-get-cascade-output-change-fraction.xml deleted file mode 100644 index 27f5cc48a863..000000000000 --- a/reference/fann/functions/fann-get-cascade-output-change-fraction.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - fann_get_cascade_output_change_fraction - Returns the cascade output change fraction - - - - &reftitle.description; - - floatfann_get_cascade_output_change_fraction - resourceann - - - The cascade output change fraction is a number between 0 and 1 determining how large a fraction of the fann_get_MSE - value should change within fann_get_cascade_output_stagnation_epochs during training of the output connections, - in order for the training not to stagnate. If the training stagnates, the training of the output connections - will be ended and new candidates will be prepared. - - - It means that if the MSE does not change by a fraction of fann_get_cascade_output_change_fraction during - a period of fann_get_cascade_output_stagnation_epochs, the training of the output connections is - stopped because the training has stagnated. - - - If the cascade output change fraction is low, the output connections will be trained more and if the fraction is high, - they will be trained less. - - - The default cascade output change fraction is 0.01, which is equivalent to a 1% change in MSE. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - The cascade output change fraction, or &false; on error. - - - - - &reftitle.seealso; - - - fann_set_cascade_output_change_fraction - fann_get_MSE - fann_get_cascade_output_stagnation_epochs - - - - - - - - diff --git a/reference/fann/functions/fann-get-cascade-output-stagnation-epochs.xml b/reference/fann/functions/fann-get-cascade-output-stagnation-epochs.xml deleted file mode 100644 index 2456714c780f..000000000000 --- a/reference/fann/functions/fann-get-cascade-output-stagnation-epochs.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - fann_get_cascade_output_stagnation_epochs - Returns the number of cascade output stagnation epochs - - - - &reftitle.description; - - intfann_get_cascade_output_stagnation_epochs - resourceann - - - The number of cascade output stagnation epochs determines the number of epochs training is allowed to continue - without changing the MSE by a fraction of fann_get_cascade_output_change_fraction. - - - See more info about this parameter in fann_get_cascade_output_change_fraction. - - - The default number of cascade output stagnation epochs is 12. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - The number of cascade output stagnation epochs, or &false; on error. - - - - - &reftitle.seealso; - - - fann_set_cascade_output_stagnation_epochs - fann_get_cascade_output_change_fraction - - - - - - - - diff --git a/reference/fann/functions/fann-get-cascade-weight-multiplier.xml b/reference/fann/functions/fann-get-cascade-weight-multiplier.xml deleted file mode 100644 index 05832c9c6812..000000000000 --- a/reference/fann/functions/fann-get-cascade-weight-multiplier.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - fann_get_cascade_weight_multiplier - Returns the weight multiplier - - - - &reftitle.description; - - floatfann_get_cascade_weight_multiplier - resourceann - - - The weight multiplier is a parameter which is used to multiply the weights from the candidate neuron before adding - the neuron to the neural network. This parameter is usually between 0 and 1, and is used to make the training a bit less aggressive. - - - The default weight multiplier is 0.4. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - The weight multiplier, or &false; on error. - - - - - &reftitle.seealso; - - - fann_set_cascade_weight_multiplier - - - - - - - - diff --git a/reference/fann/functions/fann-get-connection-array.xml b/reference/fann/functions/fann-get-connection-array.xml deleted file mode 100644 index d883dcc5aa6a..000000000000 --- a/reference/fann/functions/fann-get-connection-array.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - fann_get_connection_array - Get connections in the network - - - - &reftitle.description; - - arrayfann_get_connection_array - resourceann - - - Get connections in the network. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - An array of connections in the network - - - - - - - diff --git a/reference/fann/functions/fann-get-connection-rate.xml b/reference/fann/functions/fann-get-connection-rate.xml deleted file mode 100644 index 8564cde9094b..000000000000 --- a/reference/fann/functions/fann-get-connection-rate.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - fann_get_connection_rate - Get the connection rate used when the network was created - - - - &reftitle.description; - - floatfann_get_connection_rate - resourceann - - - Get the connection rate used when the network was created. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - The connection rate used when the network was created, or &false; on error. - - - - - - - diff --git a/reference/fann/functions/fann-get-errno.xml b/reference/fann/functions/fann-get-errno.xml deleted file mode 100644 index 7412ba6e254b..000000000000 --- a/reference/fann/functions/fann-get-errno.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - fann_get_errno - Returns the last error number - - - - &reftitle.description; - - intfann_get_errno - resourceerrdat - - - Returns the last error number. - - - - - &reftitle.parameters; - - - errdat - - &fann.errdat.description; - - - - - - - &reftitle.returnvalues; - - The error number, or &false; on error. - - - - - &reftitle.seealso; - - - fann_reset_errno - fann_get_errstr - - - - - - - - diff --git a/reference/fann/functions/fann-get-errstr.xml b/reference/fann/functions/fann-get-errstr.xml deleted file mode 100644 index e353761d94b6..000000000000 --- a/reference/fann/functions/fann-get-errstr.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - fann_get_errstr - Returns the last errstr - - - - &reftitle.description; - - stringfann_get_errstr - resourceerrdat - - - Returns the last errstr. - - - - - &reftitle.parameters; - - - errdat - - &fann.errdat.description; - - - - - - - &reftitle.returnvalues; - - The last error string, or &false; on error. - - - - - &reftitle.seealso; - - - fann_reset_errstr - fann_get_errno - - - - - - - - diff --git a/reference/fann/functions/fann-get-layer-array.xml b/reference/fann/functions/fann-get-layer-array.xml deleted file mode 100644 index f56aa7377a0b..000000000000 --- a/reference/fann/functions/fann-get-layer-array.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - fann_get_layer_array - Get the number of neurons in each layer in the network - - - - &reftitle.description; - - arrayfann_get_layer_array - resourceann - - - Get the number of neurons in each layer in the neural network. - - - Bias is not included so the layers match the fann_create functions. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - An array of numbers of neurons in each layer - - - - - - diff --git a/reference/fann/functions/fann-get-learning-momentum.xml b/reference/fann/functions/fann-get-learning-momentum.xml deleted file mode 100644 index 107acdda1338..000000000000 --- a/reference/fann/functions/fann-get-learning-momentum.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - fann_get_learning_momentum - Returns the learning momentum - - - - &reftitle.description; - - floatfann_get_learning_momentum - resourceann - - - The learning momentum can be used to speed up FANN_TRAIN_INCREMENTAL training. - A too high momentum will however not benefit training. Setting momentum to 0 will be the same as - not using the momentum parameter. The recommended value of this parameter is between 0.0 and 1.0. - - - The default momentum is 0. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - The learning momentum, or &false; on error. - - - - - &reftitle.seealso; - - - fann_set_learning_momentum - fann_set_training_algorithm - - - - - - - - diff --git a/reference/fann/functions/fann-get-learning-rate.xml b/reference/fann/functions/fann-get-learning-rate.xml deleted file mode 100644 index 436c28c8ccc1..000000000000 --- a/reference/fann/functions/fann-get-learning-rate.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - fann_get_learning_rate - Returns the learning rate - - - - &reftitle.description; - - floatfann_get_learning_rate - resourceann - - - The learning rate is used to determine how aggressive training should be for some of the training algorithms - (FANN_TRAIN_INCREMENTAL, FANN_TRAIN_BATCH, FANN_TRAIN_QUICKPROP). - Do however note that it is not used in FANN_TRAIN_RPROP. - - - The default learning rate is 0.7. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - The learning rate, or &false; on error. - - - - - &reftitle.seealso; - - - fann_set_learning_rate - fann_set_training_algorithm - - - - - - - - diff --git a/reference/fann/functions/fann-get-mse.xml b/reference/fann/functions/fann-get-mse.xml deleted file mode 100644 index f426cf7ae5ea..000000000000 --- a/reference/fann/functions/fann-get-mse.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - fann_get_MSE - Reads the mean square error from the network - - - - &reftitle.description; - - floatfann_get_MSE - resourceann - - - Reads the mean square error from the network. - - - Reads the mean square error from the network. This value is calculated during training or testing and can therefore - sometimes be a bit off if the weights have been changed since the last calculation of the value. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - The mean square error, or &false; on error. - - - - - &reftitle.seealso; - - - fann_test_data - - - - - - - diff --git a/reference/fann/functions/fann-get-network-type.xml b/reference/fann/functions/fann-get-network-type.xml deleted file mode 100644 index acc17c4610cc..000000000000 --- a/reference/fann/functions/fann-get-network-type.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - fann_get_network_type - Get the type of neural network it was created as - - - - &reftitle.description; - - intfann_get_network_type - resourceann - - - Get the type of neural network it was created as. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - Network type constant, or &false; on error. - - - - - - - diff --git a/reference/fann/functions/fann-get-num-input.xml b/reference/fann/functions/fann-get-num-input.xml deleted file mode 100644 index a6ddb561cddd..000000000000 --- a/reference/fann/functions/fann-get-num-input.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - fann_get_num_input - Get the number of input neurons - - - - &reftitle.description; - - intfann_get_num_input - resourceann - - - Get the number of input neurons. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - Number of input neurons, or &false; on error - - - - - - - diff --git a/reference/fann/functions/fann-get-num-layers.xml b/reference/fann/functions/fann-get-num-layers.xml deleted file mode 100644 index 3ad2c4f7faeb..000000000000 --- a/reference/fann/functions/fann-get-num-layers.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - fann_get_num_layers - Get the number of layers in the neural network - - - - &reftitle.description; - - intfann_get_num_layers - resourceann - - - Get the number of layers in the neural network. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - The number of layers in the neural network, or &false; on error. - - - - - - - diff --git a/reference/fann/functions/fann-get-num-output.xml b/reference/fann/functions/fann-get-num-output.xml deleted file mode 100644 index 7430ddb64236..000000000000 --- a/reference/fann/functions/fann-get-num-output.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - fann_get_num_output - Get the number of output neurons - - - - &reftitle.description; - - intfann_get_num_output - resourceann - - - Get the number of output neurons. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - Number of output neurons, or &false; on error - - - - - - - diff --git a/reference/fann/functions/fann-get-quickprop-decay.xml b/reference/fann/functions/fann-get-quickprop-decay.xml deleted file mode 100644 index dfb72706a8ff..000000000000 --- a/reference/fann/functions/fann-get-quickprop-decay.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - fann_get_quickprop_decay - Returns the decay which is a factor that weights should decrease in each iteration during quickprop training - - - - &reftitle.description; - - floatfann_get_quickprop_decay - resourceann - - - The decay is a small negative valued number which is a factor that the weights should decrease in each iteration - during quickprop training. This is used to make sure that the weights do not become too high during training. - - - The default decay is -0.0001. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - The decay, or &false; on error. - - - - - &reftitle.seealso; - - - fann_set_quickprop_decay - - - - - - - - diff --git a/reference/fann/functions/fann-get-quickprop-mu.xml b/reference/fann/functions/fann-get-quickprop-mu.xml deleted file mode 100644 index a64d7f7407b6..000000000000 --- a/reference/fann/functions/fann-get-quickprop-mu.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - fann_get_quickprop_mu - Returns the mu factor - - - - &reftitle.description; - - floatfann_get_quickprop_mu - resourceann - - - The mu factor is used to increase and decrease the step-size during quickprop training. The mu factor should always be above 1, - since it would otherwise decrease the step-size when it was suppose to increase it. - - - The default mu factor is 1.75. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - The mu factor, or &false; on error. - - - - - &reftitle.seealso; - - - fann_set_quickprop_mu - - - - - - - - diff --git a/reference/fann/functions/fann-get-rprop-decrease-factor.xml b/reference/fann/functions/fann-get-rprop-decrease-factor.xml deleted file mode 100644 index 78cdf3fe9635..000000000000 --- a/reference/fann/functions/fann-get-rprop-decrease-factor.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - fann_get_rprop_decrease_factor - Returns the decrease factor used during RPROP training - - - - &reftitle.description; - - floatfann_get_rprop_decrease_factor - resourceann - - - The decrease factor is a value smaller than 1, which is used to decrease the step-size during RPROP training. - - - The default decrease factor is 0.5. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - The decrease factor, or &false; on error. - - - - - &reftitle.seealso; - - - fann_set_rprop_decrease_factor - - - - - - - - diff --git a/reference/fann/functions/fann-get-rprop-delta-max.xml b/reference/fann/functions/fann-get-rprop-delta-max.xml deleted file mode 100644 index 54dca2db9e34..000000000000 --- a/reference/fann/functions/fann-get-rprop-delta-max.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - fann_get_rprop_delta_max - Returns the maximum step-size - - - - &reftitle.description; - - floatfann_get_rprop_delta_max - resourceann - - - The maximum step-size is a positive number determining how large the maximum step-size may be. - - - The default delta max is 50.0. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - The maximum step-size, or &false; on error. - - - - - &reftitle.seealso; - - - fann_set_rprop_delta_max - fann_get_rprop_delta_min - - - - - - - - diff --git a/reference/fann/functions/fann-get-rprop-delta-min.xml b/reference/fann/functions/fann-get-rprop-delta-min.xml deleted file mode 100644 index 560d295292c8..000000000000 --- a/reference/fann/functions/fann-get-rprop-delta-min.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - fann_get_rprop_delta_min - Returns the minimum step-size - - - - &reftitle.description; - - floatfann_get_rprop_delta_min - resourceann - - - The minimum step-size is a small positive number determining how small the minimum step-size may be. - - - The default value delta min is 0.0. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - The minimum step-size, or &false; on error. - - - - - &reftitle.seealso; - - - fann_set_rprop_delta_min - - - - - - - - diff --git a/reference/fann/functions/fann-get-rprop-delta-zero.xml b/reference/fann/functions/fann-get-rprop-delta-zero.xml deleted file mode 100644 index 182ef0a44890..000000000000 --- a/reference/fann/functions/fann-get-rprop-delta-zero.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - fann_get_rprop_delta_zero - Returns the initial step-size - - - - &reftitle.description; - - intfann_get_rprop_delta_zero - resourceann - - - The initial step-size is a positive number determining the initial step size. - - - The default delta zero is 0.1. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - The initial step-size, or &false; on error. - - - - - &reftitle.seealso; - - - fann_set_rprop_delta_zero - fann_get_rprop_delta_min - fann_get_rprop_delta_max - - - - - - - - diff --git a/reference/fann/functions/fann-get-rprop-increase-factor.xml b/reference/fann/functions/fann-get-rprop-increase-factor.xml deleted file mode 100644 index 7a433b02c76e..000000000000 --- a/reference/fann/functions/fann-get-rprop-increase-factor.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - fann_get_rprop_increase_factor - Returns the increase factor used during RPROP training - - - - &reftitle.description; - - floatfann_get_rprop_increase_factor - resourceann - - - The increase factor is a value larger than 1, which is used to increase the step-size during RPROP training. - - - The default increase factor is 1.2. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - The increase factor, or &false; on error. - - - - - &reftitle.seealso; - - - fann_set_rprop_increase_factor - - - - - - - - diff --git a/reference/fann/functions/fann-get-sarprop-step-error-shift.xml b/reference/fann/functions/fann-get-sarprop-step-error-shift.xml deleted file mode 100644 index aade12f78d2d..000000000000 --- a/reference/fann/functions/fann-get-sarprop-step-error-shift.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - fann_get_sarprop_step_error_shift - Returns the sarprop step error shift - - - - &reftitle.description; - - floatfann_get_sarprop_step_error_shift - resourceann - - - Returns the sarprop step error shift. - - - The default step error shift is 1.385. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - The sarprop step error shift , or &false; on error. - - - - - &reftitle.notes; - &fann.note.function.fann-2.2; - - - - &reftitle.seealso; - - - fann_set_sarprop_step_error_shift - - - - - - - - diff --git a/reference/fann/functions/fann-get-sarprop-step-error-threshold-factor.xml b/reference/fann/functions/fann-get-sarprop-step-error-threshold-factor.xml deleted file mode 100644 index 62ba4170c1a0..000000000000 --- a/reference/fann/functions/fann-get-sarprop-step-error-threshold-factor.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - fann_get_sarprop_step_error_threshold_factor - Returns the sarprop step error threshold factor - - - - &reftitle.description; - - floatfann_get_sarprop_step_error_threshold_factor - resourceann - - - The sarprop step error threshold factor. - - - The default factor is 0.1. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - The sarprop step error threshold factor, or &false; on error. - - - - - &reftitle.notes; - &fann.note.function.fann-2.2; - - - - &reftitle.seealso; - - - fann_set_sarprop_step_error_threshold_factor - - - - - - - - diff --git a/reference/fann/functions/fann-get-sarprop-temperature.xml b/reference/fann/functions/fann-get-sarprop-temperature.xml deleted file mode 100644 index f4371a722dc4..000000000000 --- a/reference/fann/functions/fann-get-sarprop-temperature.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - fann_get_sarprop_temperature - Returns the sarprop temperature - - - - &reftitle.description; - - floatfann_get_sarprop_temperature - resourceann - - - Returns the sarprop temperature. - - - The default temperature is 0.015. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - The sarprop temperature, or &false; on error. - - - - - &reftitle.notes; - &fann.note.function.fann-2.2; - - - - &reftitle.seealso; - - - fann_set_sarprop_temperature - - - - - - - - diff --git a/reference/fann/functions/fann-get-sarprop-weight-decay-shift.xml b/reference/fann/functions/fann-get-sarprop-weight-decay-shift.xml deleted file mode 100644 index 226ac5ec5c63..000000000000 --- a/reference/fann/functions/fann-get-sarprop-weight-decay-shift.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - fann_get_sarprop_weight_decay_shift - Returns the sarprop weight decay shift - - - - &reftitle.description; - - floatfann_get_sarprop_weight_decay_shift - resourceann - - - The sarprop weight decay shift. - - - The default delta max is -6.644. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - The sarprop weight decay shift, or &false; on error. - - - - - &reftitle.notes; - &fann.note.function.fann-2.2; - - - - &reftitle.seealso; - - - fann_set_sarprop_weight_decay_shift - - - - - - - - diff --git a/reference/fann/functions/fann-get-total-connections.xml b/reference/fann/functions/fann-get-total-connections.xml deleted file mode 100644 index a3e38b3531bb..000000000000 --- a/reference/fann/functions/fann-get-total-connections.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - fann_get_total_connections - Get the total number of connections in the entire network - - - - &reftitle.description; - - intfann_get_total_connections - resourceann - - - Get the total number of connections in the entire network. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - Total number of connections in the entire network, or &false; on error - - - - - - - diff --git a/reference/fann/functions/fann-get-total-neurons.xml b/reference/fann/functions/fann-get-total-neurons.xml deleted file mode 100644 index 45739d2f127e..000000000000 --- a/reference/fann/functions/fann-get-total-neurons.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - fann_get_total_neurons - Get the total number of neurons in the entire network - - - - &reftitle.description; - - intfann_get_total_neurons - resourceann - - - Get the total number of neurons in the entire network. This number does also include the bias neurons, - so a 2-4-2 network has 2+4+2 +2(bias) = 10 neurons. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - Total number of neurons in the entire network, or &false; on error. - - - - - - diff --git a/reference/fann/functions/fann-get-train-error-function.xml b/reference/fann/functions/fann-get-train-error-function.xml deleted file mode 100644 index 1bc0cc8b410e..000000000000 --- a/reference/fann/functions/fann-get-train-error-function.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - fann_get_train_error_function - Returns the error function used during training - - - - &reftitle.description; - - intfann_get_train_error_function - resourceann - - - Returns the error function used during training. - - - The error functions are described further in error functions constants. - - - The default error function is FANN_ERRORFUNC_TANH. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - The error function constant, or &false; on error. - - - - - &reftitle.seealso; - - - fann_set_train_error_function - - - - - - - - diff --git a/reference/fann/functions/fann-get-train-stop-function.xml b/reference/fann/functions/fann-get-train-stop-function.xml deleted file mode 100644 index 348aebdd89ca..000000000000 --- a/reference/fann/functions/fann-get-train-stop-function.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - fann_get_train_stop_function - Returns the stop function used during training - - - - &reftitle.description; - - intfann_get_train_stop_function - resourceann - - - Returns the stop function used during training. - - - The stop functions are described further in stop functions constants. - - - The default stop function is FANN_STOPFUNC_MSE. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - The stop function constant, or &false; on error. - - - - - &reftitle.seealso; - - - fann_set_train_stop_function - - - - - - - - diff --git a/reference/fann/functions/fann-get-training-algorithm.xml b/reference/fann/functions/fann-get-training-algorithm.xml deleted file mode 100644 index 19f6f923cee6..000000000000 --- a/reference/fann/functions/fann-get-training-algorithm.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - fann_get_training_algorithm - Returns the training algorithm - - - - &reftitle.description; - - intfann_get_training_algorithm - resourceann - - - Returns the training algorithm. This training algorithm is used by fann_train_on_data and associated functions. - - - Note that this algorithm is also used during fann_cascadetrain_on_data, although only - FANN_TRAIN_RPROP and FANN_TRAIN_QUICKPROP is allowed during cascade training. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - Training algorithm constant, or &false; on error. - - - - - &reftitle.seealso; - - - fann_set_training_algorithm - - - - - - - - diff --git a/reference/fann/functions/fann-init-weights.xml b/reference/fann/functions/fann-init-weights.xml deleted file mode 100644 index fa90b10d4d6d..000000000000 --- a/reference/fann/functions/fann-init-weights.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - fann_init_weights - Initialize the weights using Widrow + Nguyen’s algorithm - - - - &reftitle.description; - - boolfann_init_weights - resourceann - resourcetrain_data - - - Initialize the weights using Widrow + Nguyen’s algorithm. - - - This function behaves similarly to fann_randomize_weights. It will use the algorithm developed by - Derrick Nguyen and Bernard Widrow to set the weights in such a way as to speed up training. This technique is not always - successful, and in some cases can be less efficient than a purely random initialization. - - - The algorithm requires access to the range of the input data (for example largest and smallest input), and therefore - accepts a second argument, data, which is the training data that will be used to train the network. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - train_data - - &fann.train.description; - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_randomize_weights - fann_read_train_from_file - - - - - - - - diff --git a/reference/fann/functions/fann-length-train-data.xml b/reference/fann/functions/fann-length-train-data.xml deleted file mode 100644 index 3076f0f12ce6..000000000000 --- a/reference/fann/functions/fann-length-train-data.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - fann_length_train_data - Returns the number of training patterns in the train data - - - - &reftitle.description; - - intfann_length_train_data - resourcedata - - - Returns the number of training patterns in the train data resource. - - - - - &reftitle.parameters; - - - data - - &fann.train.description; - - - - - - - &reftitle.returnvalues; - - Number of elements in the train data resource, or &false; on error. - - - - - - diff --git a/reference/fann/functions/fann-merge-train-data.xml b/reference/fann/functions/fann-merge-train-data.xml deleted file mode 100644 index ec2d3dda99b4..000000000000 --- a/reference/fann/functions/fann-merge-train-data.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - fann_merge_train_data - Merges the train data - - - - &reftitle.description; - - resourcefann_merge_train_data - resourcedata1 - resourcedata2 - - - Merges the data from data1 and data2 into a new train data resource. - - - - - &reftitle.parameters; - - - data1 - - &fann.train.description; - - - - data2 - - &fann.train.description; - - - - - - - &reftitle.returnvalues; - - New merged train data resource, or &false; on error. - - - - - - diff --git a/reference/fann/functions/fann-num-input-train-data.xml b/reference/fann/functions/fann-num-input-train-data.xml deleted file mode 100644 index 9120aee908aa..000000000000 --- a/reference/fann/functions/fann-num-input-train-data.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - fann_num_input_train_data - Returns the number of inputs in each of the training patterns in the train data - - - - &reftitle.description; - - intfann_num_input_train_data - resourcedata - - - Returns the number of inputs in each of the training patterns in the train data resource. - - - - - &reftitle.parameters; - - - data - - &fann.train.description; - - - - - - - &reftitle.returnvalues; - - The number of inputs, or &false; on error. - - - - - &reftitle.seealso; - - - fann_length_train_data - fann_num_output_train_data - - - - - - - - diff --git a/reference/fann/functions/fann-num-output-train-data.xml b/reference/fann/functions/fann-num-output-train-data.xml deleted file mode 100644 index 7c784faf07ca..000000000000 --- a/reference/fann/functions/fann-num-output-train-data.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - fann_num_output_train_data - Returns the number of outputs in each of the training patterns in the train data - - - - &reftitle.description; - - intfann_num_output_train_data - resourcedata - - - Returns the number of outputs in each of the training patterns in the train data resource. - - - - - &reftitle.parameters; - - - data - - &fann.train.description; - - - - - - - &reftitle.returnvalues; - - The number of outputs, or &false; on error. - - - - - &reftitle.seealso; - - - fann_length_train_data - fann_num_input_train_data - - - - - - - - diff --git a/reference/fann/functions/fann-print-error.xml b/reference/fann/functions/fann-print-error.xml deleted file mode 100644 index 8762bd01982b..000000000000 --- a/reference/fann/functions/fann-print-error.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - fann_print_error - Prints the error string - - - - &reftitle.description; - - voidfann_print_error - resourceerrdat - - - Prints the error string. - - - - - &reftitle.parameters; - - - errdat - - &fann.errdat.description; - - - - - - - &reftitle.returnvalues; - &fann.return.void; - - - - &reftitle.seealso; - - - fann_get_errstr - - - - - - - - diff --git a/reference/fann/functions/fann-randomize-weights.xml b/reference/fann/functions/fann-randomize-weights.xml deleted file mode 100644 index 52cbea8cd97d..000000000000 --- a/reference/fann/functions/fann-randomize-weights.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - fann_randomize_weights - Give each connection a random weight between min_weight and max_weight - - - - &reftitle.description; - - boolfann_randomize_weights - resourceann - floatmin_weight - floatmax_weight - - - Give each connection a random weight between min_weight and max_weight - - - From the beginning the weights are random between -0.1 and 0.1. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - min_weight - - - Minimum weight value - - - - - max_weight - - - Maximum weight value - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_init_weights - - - - - - - - diff --git a/reference/fann/functions/fann-read-train-from-file.xml b/reference/fann/functions/fann-read-train-from-file.xml deleted file mode 100644 index 4780e144ed88..000000000000 --- a/reference/fann/functions/fann-read-train-from-file.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - fann_read_train_from_file - Reads a file that stores training data - - - - &reftitle.description; - - resourcefann_read_train_from_file - stringfilename - - - Reads a file that stores training data. - - - - - &reftitle.parameters; - - - filename - - - The input file in the following format: - - - - - - - - - - - &reftitle.returnvalues; - &fann.return.train; - - - - &reftitle.examples; - - - <methodname>fann_read_train_from_file</methodname> example - - -]]> - - Contents of xor.data - - - - - - - - - &reftitle.seealso; - - - fann_train_on_data - fann_destroy_train - fann_save_train - - - - - - - diff --git a/reference/fann/functions/fann-reset-errno.xml b/reference/fann/functions/fann-reset-errno.xml deleted file mode 100644 index 0a977d74e23c..000000000000 --- a/reference/fann/functions/fann-reset-errno.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - fann_reset_errno - Resets the last error number - - - - &reftitle.description; - - voidfann_reset_errno - resourceerrdat - - - Resets the last error number. - - - - - &reftitle.parameters; - - - errdat - - &fann.errdat.description; - - - - - - - &reftitle.returnvalues; - &fann.return.void; - - - - &reftitle.seealso; - - - fann_get_errno - fann_reset_errstr - - - - - - - - diff --git a/reference/fann/functions/fann-reset-errstr.xml b/reference/fann/functions/fann-reset-errstr.xml deleted file mode 100644 index a3b05bf34c18..000000000000 --- a/reference/fann/functions/fann-reset-errstr.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - fann_reset_errstr - Resets the last error string - - - - &reftitle.description; - - voidfann_reset_errstr - resourceerrdat - - - Resets the last error string. - - - - - &reftitle.parameters; - - - errdat - - &fann.errdat.description; - - - - - - - &reftitle.returnvalues; - &fann.return.void; - - - - &reftitle.seealso; - - - fann_get_errstr - fann_reset_errno - - - - - - - - diff --git a/reference/fann/functions/fann-reset-mse.xml b/reference/fann/functions/fann-reset-mse.xml deleted file mode 100644 index 79bc135dd1a3..000000000000 --- a/reference/fann/functions/fann-reset-mse.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - fann_reset_MSE - Resets the mean square error from the network - - - - &reftitle.description; - - boolfann_reset_MSE - stringann - - - Resets the mean square error from the network. - - - This function also resets the number of bits that fail. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_MSE - fann_get_bit_fail - fann_get_bit_fail_limit - - - - - - - diff --git a/reference/fann/functions/fann-run.xml b/reference/fann/functions/fann-run.xml deleted file mode 100644 index d1ad08ec4413..000000000000 --- a/reference/fann/functions/fann-run.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - fann_run - Will run input through the neural network - - - - &reftitle.description; - - arrayfann_run - resourceann - arrayinput - - - Will run input through the neural network, returning an array of outputs, the number of which being equal - to the number of neurons in the output layer. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - input - - - Array of input values - - - - - - - - &reftitle.returnvalues; - - Array of output values, or &false; on error - - - - - - diff --git a/reference/fann/functions/fann-save-train.xml b/reference/fann/functions/fann-save-train.xml deleted file mode 100644 index e3974a968b0a..000000000000 --- a/reference/fann/functions/fann-save-train.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - fann_save_train - Save the training structure to a file - - - - &reftitle.description; - - boolfann_save_train - resourcedata - stringfile_name - - - Save the training data to a file, with the format as specified in fann_read_train_from_file. - - - - - &reftitle.parameters; - - - data - - &fann.train.description; - - - - file_name - - - The file name of the file where training data is saved to. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_read_train_from_file - - - - - - - - diff --git a/reference/fann/functions/fann-save.xml b/reference/fann/functions/fann-save.xml deleted file mode 100644 index 3bccb6a2bd3d..000000000000 --- a/reference/fann/functions/fann-save.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - fann_save - Saves the entire network to a configuration file - - - - &reftitle.description; - - boolfann_save - resourceann - stringconfiguration_file - - - Saves the entire network to a configuration file. - - - The configuration file contains all information about the neural network and enables - fann_create_from_file to create an exact copy of the neural network - and all of the parameters associated with the neural network. - - - These three parameters (fann_set_callback, fann_set_error_log, - fann_set_user_data) are NOT saved to the file because they cannot safely be ported - to a different location. Also temporary parameters generated during training like fann_get_MSE - is not saved. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - configuration_file - - - The configuration file path. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_create_from_file - - - - - - - - diff --git a/reference/fann/functions/fann-scale-input-train-data.xml b/reference/fann/functions/fann-scale-input-train-data.xml deleted file mode 100644 index 7a1445eb9aa8..000000000000 --- a/reference/fann/functions/fann-scale-input-train-data.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - fann_scale_input_train_data - Scales the inputs in the training data to the specified range - - - - &reftitle.description; - - boolfann_scale_input_train_data - resourcetrain_data - floatnew_min - floatnew_max - - - Scales the inputs in the training data to the specified range. - - - - - &reftitle.parameters; - - - train_data - - &fann.train.description; - - - - new_min - - - New minimum after scaling inputs in training data. - - - - - new_max - - - New maximum after scaling inputs in training data. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_scale_output_train_data - fann_scale_train_data - - - - - - - - diff --git a/reference/fann/functions/fann-scale-input.xml b/reference/fann/functions/fann-scale-input.xml deleted file mode 100644 index c1f97c26056d..000000000000 --- a/reference/fann/functions/fann-scale-input.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - fann_scale_input - Scale data in input vector before feed it to ann based on previously calculated parameters - - - - &reftitle.description; - - boolfann_scale_input - resourceann - arrayinput_vector - - - Scale data in input vector before feed it to ann based on previously calculated parameters. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - input_vector - - - Input vector that will be scaled - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_descale_input - fann_scale_output - - - - - - - - diff --git a/reference/fann/functions/fann-scale-output-train-data.xml b/reference/fann/functions/fann-scale-output-train-data.xml deleted file mode 100644 index 2445dad3d606..000000000000 --- a/reference/fann/functions/fann-scale-output-train-data.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - fann_scale_output_train_data - Scales the outputs in the training data to the specified range - - - - &reftitle.description; - - boolfann_scale_output_train_data - resourcetrain_data - floatnew_min - floatnew_max - - - Scales the outputs in the training data to the specified range. - - - - - &reftitle.parameters; - - - train_data - - &fann.train.description; - - - - new_min - - - New minimum after scaling outputs in training data. - - - - - new_max - - - New maximum after scaling outputs in training data. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_scale_input_train_data - fann_scale_train_data - - - - - - - - diff --git a/reference/fann/functions/fann-scale-output.xml b/reference/fann/functions/fann-scale-output.xml deleted file mode 100644 index cc3723b520c3..000000000000 --- a/reference/fann/functions/fann-scale-output.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - fann_scale_output - Scale data in output vector before feed it to ann based on previously calculated parameters - - - - &reftitle.description; - - boolfann_scale_output - resourceann - arrayoutput_vector - - - Scale data in output vector before feed it to ann based on previously calculated parameters. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - output_vector - - - Output vector that will be scaled - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_descale_output - fann_scale_input - - - - - - - - diff --git a/reference/fann/functions/fann-scale-train-data.xml b/reference/fann/functions/fann-scale-train-data.xml deleted file mode 100644 index ee1196c02841..000000000000 --- a/reference/fann/functions/fann-scale-train-data.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - fann_scale_train_data - Scales the inputs and outputs in the training data to the specified range - - - - &reftitle.description; - - boolfann_scale_train_data - resourcetrain_data - floatnew_min - floatnew_max - - - Scales the inputs and outputs in the training data to the specified range. - - - - - &reftitle.parameters; - - - train_data - - &fann.train.description; - - - - new_min - - - New minimum after scaling inputs and outputs in training data. - - - - - new_max - - - New maximum after scaling inputs and outputs in training data. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_scale_output_train_data - fann_scale_input_train_data - - - - - - - - diff --git a/reference/fann/functions/fann-scale-train.xml b/reference/fann/functions/fann-scale-train.xml deleted file mode 100644 index db220b473598..000000000000 --- a/reference/fann/functions/fann-scale-train.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - fann_scale_train - Scale input and output data based on previously calculated parameters - - - - &reftitle.description; - - boolfann_scale_train - resourceann - resourcetrain_data - - - Scale input and output data based on previously calculated parameters. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - train_data - - &fann.train.description; - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_descale_train - fann_set_scaling_params - - - - - - - - diff --git a/reference/fann/functions/fann-set-activation-function-hidden.xml b/reference/fann/functions/fann-set-activation-function-hidden.xml deleted file mode 100644 index c7441abe0c87..000000000000 --- a/reference/fann/functions/fann-set-activation-function-hidden.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - fann_set_activation_function_hidden - Sets the activation function for all of the hidden layers - - - - &reftitle.description; - - boolfann_set_activation_function_hidden - resourceann - intactivation_function - - - Sets the activation function for all of the hidden layers. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - activation_function - - - The activation functions constant. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_set_activation_function - fann_set_activation_function_layer - fann_set_activation_function_output - fann_set_activation_steepness - - - - - - - - diff --git a/reference/fann/functions/fann-set-activation-function-layer.xml b/reference/fann/functions/fann-set-activation-function-layer.xml deleted file mode 100644 index 1fc85e87e8b0..000000000000 --- a/reference/fann/functions/fann-set-activation-function-layer.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - fann_set_activation_function_layer - Sets the activation function for all the neurons in the supplied layer - - - - &reftitle.description; - - boolfann_set_activation_function_layer - resourceann - intactivation_function - intlayer - - - Set the activation function for all the neurons in the layer number layer, counting the input layer as layer 0. - - - It is not possible to set activation functions for the neurons in the input layer. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - activation_function - - - The activation functions constant. - - - - - layer - - - Layer number. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_set_activation_function - fann_set_activation_function_hidden - fann_set_activation_function_output - fann_set_activation_steepness - - - - - - - - diff --git a/reference/fann/functions/fann-set-activation-function-output.xml b/reference/fann/functions/fann-set-activation-function-output.xml deleted file mode 100644 index d884d4df61fe..000000000000 --- a/reference/fann/functions/fann-set-activation-function-output.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - fann_set_activation_function_output - Sets the activation function for the output layer - - - - &reftitle.description; - - boolfann_set_activation_function_output - resourceann - intactivation_function - - - Sets the activation function for the output layer. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - activation_function - - - The activation functions constant. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_set_activation_function - fann_set_activation_function_layer - fann_set_activation_function_hidden - fann_set_activation_steepness - - - - - - - - diff --git a/reference/fann/functions/fann-set-activation-function.xml b/reference/fann/functions/fann-set-activation-function.xml deleted file mode 100644 index e2bad143de7e..000000000000 --- a/reference/fann/functions/fann-set-activation-function.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - fann_set_activation_function - Sets the activation function for supplied neuron and layer - - - - &reftitle.description; - - boolfann_set_activation_function - resourceann - intactivation_function - intlayer - intneuron - - - Set the activation function for neuron number neuron in layer number - layer, counting the input layer as layer 0. - - - It is not possible to set activation functions for the neurons in the input layer. - - - When choosing an activation function it is important to note that the activation functions have different range. - FANN_SIGMOID is e.g. in the 0 - 1 range while FANN_SIGMOID_SYMMETRIC is - in the -1 - 1 range and FANN_LINEAR is unbound. - - - The supplied activation_function value must be - one of the activation functions constants. - - - The return value is one of the activation functions constants. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - activation_function - - - The activation functions constant. - - - - - layer - - - Layer number. - - - - - neuron - - - Neuron number. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_set_activation_function_layer - fann_set_activation_function_hidden - fann_set_activation_function_output - fann_set_activation_steepness - fann_get_activation_function - - - - - - - - diff --git a/reference/fann/functions/fann-set-activation-steepness-hidden.xml b/reference/fann/functions/fann-set-activation-steepness-hidden.xml deleted file mode 100644 index d8295308e99a..000000000000 --- a/reference/fann/functions/fann-set-activation-steepness-hidden.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - fann_set_activation_steepness_hidden - Sets the steepness of the activation steepness for all neurons in the all hidden layers - - - - &reftitle.description; - - boolfann_set_activation_steepness_hidden - resourceann - floatactivation_steepness - - - Sets the steepness of the activation steepness for all neurons in the all hidden layers. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - activation_steepness - - - The activation steepness. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_set_activation_steepness - fann_set_activation_steepness_layer - fann_set_activation_steepness_output - fann_get_activation_steepness - fann_set_activation_function - - - - - - - - diff --git a/reference/fann/functions/fann-set-activation-steepness-layer.xml b/reference/fann/functions/fann-set-activation-steepness-layer.xml deleted file mode 100644 index 535171cbceb1..000000000000 --- a/reference/fann/functions/fann-set-activation-steepness-layer.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - fann_set_activation_steepness_layer - Sets the activation steepness for all of the neurons in the supplied layer number - - - - &reftitle.description; - - boolfann_set_activation_steepness_layer - resourceann - floatactivation_steepness - intlayer - - - Set the activation steepness for all of the neurons in layer number layer, - counting the input layer as layer 0. - - - It is not possible to set activation steepness for the neurons in the input layer. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - activation_steepness - - - The activation steepness. - - - - - layer - - - Layer number. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_set_activation_steepness - fann_set_activation_steepness_hidden - fann_set_activation_steepness_output - fann_get_activation_steepness - fann_set_activation_function - - - - - - - - diff --git a/reference/fann/functions/fann-set-activation-steepness-output.xml b/reference/fann/functions/fann-set-activation-steepness-output.xml deleted file mode 100644 index 82b33fc476fa..000000000000 --- a/reference/fann/functions/fann-set-activation-steepness-output.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - fann_set_activation_steepness_output - Sets the steepness of the activation steepness in the output layer - - - - &reftitle.description; - - boolfann_set_activation_steepness_output - resourceann - floatactivation_steepness - - - Sets the steepness of the activation steepness in the output layer. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - activation_steepness - - - The activation steepness. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_set_activation_steepness - fann_set_activation_steepness_layer - fann_set_activation_steepness_hidden - fann_get_activation_steepness - fann_set_activation_function - - - - - - - - diff --git a/reference/fann/functions/fann-set-activation-steepness.xml b/reference/fann/functions/fann-set-activation-steepness.xml deleted file mode 100644 index 098dc48dcb6b..000000000000 --- a/reference/fann/functions/fann-set-activation-steepness.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - fann_set_activation_steepness - Sets the activation steepness for supplied neuron and layer number - - - - &reftitle.description; - - boolfann_set_activation_steepness - resourceann - floatactivation_steepness - intlayer - intneuron - - - Set the activation steepness for neuron number neuron in layer number layer, - counting the input layer as layer 0. - - - It is not possible to set activation steepness for the neurons in the input layer. - - - The steepness of an activation function says something about how fast the activation function goes from - the minimum to the maximum. A high value for the activation function will also give a more aggressive training. - - - When training neural networks where the output values should be at the extremes - (usually 0 and 1, depending on the activation function), a steep activation function can be used (e.g. 1.0). - - - The default activation steepness is 0.5. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - activation_steepness - - - The activation steepness. - - - - - layer - - - Layer number. - - - - - neuron - - - Neuron number. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_set_activation_steepness_layer - fann_set_activation_steepness_hidden - fann_set_activation_steepness_output - fann_get_activation_steepness - fann_set_activation_function - - - - - - - - diff --git a/reference/fann/functions/fann-set-bit-fail-limit.xml b/reference/fann/functions/fann-set-bit-fail-limit.xml deleted file mode 100644 index eba0f2904ead..000000000000 --- a/reference/fann/functions/fann-set-bit-fail-limit.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - fann_set_bit_fail_limit - Set the bit fail limit used during training - - - - &reftitle.description; - - boolfann_set_bit_fail_limit - resourceann - floatbit_fail_limit - - - Set the bit fail limit used during training. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - bit_fail_limit - - - The bit fail limit. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_bit_fail_limit - - - - - - - diff --git a/reference/fann/functions/fann-set-callback.xml b/reference/fann/functions/fann-set-callback.xml deleted file mode 100644 index e73eb3963f75..000000000000 --- a/reference/fann/functions/fann-set-callback.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - fann_set_callback - Sets the callback function for use during training - - - - &reftitle.description; - - boolfann_set_callback - resourceann - callablecallback - - - Sets the callback function for use during training. It means that it is called from - fann_train_on_data or fann_train_on_file. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - callback - - - The supplied callback function takes following parameters: - - ann - The neural network resource - train - The train data resource - or &null; if called from fann_train_on_file - max_epochs - The maximum number of epochs the training should continue - epochs_between_reports - The number of epochs between calling this function - desired_error - The desired fann_get_MSE or - fann_get_bit_fail, depending on the stop function chosen by - fann_set_train_stop_function - epochs - The current epoch - - - - The callback should return &true;. If it returns &false;, the training will terminate. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_train_on_data - fann_train_on_file - - - - - - - - diff --git a/reference/fann/functions/fann-set-cascade-activation-functions.xml b/reference/fann/functions/fann-set-cascade-activation-functions.xml deleted file mode 100644 index 95a62a147a54..000000000000 --- a/reference/fann/functions/fann-set-cascade-activation-functions.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - fann_set_cascade_activation_functions - Sets the array of cascade candidate activation functions - - - - &reftitle.description; - - boolfann_set_cascade_activation_functions - resourceann - arraycascade_activation_functions - - - Sets the array of cascade candidate activation functions. - - - See fann_get_cascade_num_candidates for a description of which candidate neurons will be generated by this array. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - cascade_activation_functions - - - The array of cascade candidate activation functions. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_cascade_activation_functions_count - fann_set_cascade_activation_functions - - - - - - - - diff --git a/reference/fann/functions/fann-set-cascade-activation-steepnesses.xml b/reference/fann/functions/fann-set-cascade-activation-steepnesses.xml deleted file mode 100644 index 3e9dbddb324e..000000000000 --- a/reference/fann/functions/fann-set-cascade-activation-steepnesses.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - fann_set_cascade_activation_steepnesses - Sets the array of cascade candidate activation steepnesses - - - - &reftitle.description; - - boolfann_set_cascade_activation_steepnesses - resourceann - arraycascade_activation_steepnesses_count - - - Sets the array of cascade candidate activation steepnesses. - - - See fann_get_cascade_num_candidates for a description of which candidate neurons will be generated by this array. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - cascade_activation_steepnesses_count - - - The array of cascade candidate activation steepnesses. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_cascade_activation_steepnesses - fann_get_cascade_activation_steepnesses_count - - - - - - - - diff --git a/reference/fann/functions/fann-set-cascade-candidate-change-fraction.xml b/reference/fann/functions/fann-set-cascade-candidate-change-fraction.xml deleted file mode 100644 index 34584f0dfd6e..000000000000 --- a/reference/fann/functions/fann-set-cascade-candidate-change-fraction.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - fann_set_cascade_candidate_change_fraction - Sets the cascade candidate change fraction - - - - &reftitle.description; - - boolfann_set_cascade_candidate_change_fraction - resourceann - floatcascade_candidate_change_fraction - - - Sets the cascade candidate change fraction. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - cascade_candidate_change_fraction - - - The cascade candidate change fraction. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_cascade_candidate_change_fraction - - - - - - - - diff --git a/reference/fann/functions/fann-set-cascade-candidate-limit.xml b/reference/fann/functions/fann-set-cascade-candidate-limit.xml deleted file mode 100644 index ab404a1cd454..000000000000 --- a/reference/fann/functions/fann-set-cascade-candidate-limit.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - fann_set_cascade_candidate_limit - Sets the candidate limit - - - - &reftitle.description; - - boolfann_set_cascade_candidate_limit - resourceann - floatcascade_candidate_limit - - - Sets the candidate limit. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - cascade_candidate_limit - - - The candidate limit. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_cascade_candidate_limit - - - - - - - - diff --git a/reference/fann/functions/fann-set-cascade-candidate-stagnation-epochs.xml b/reference/fann/functions/fann-set-cascade-candidate-stagnation-epochs.xml deleted file mode 100644 index 0493f3a41241..000000000000 --- a/reference/fann/functions/fann-set-cascade-candidate-stagnation-epochs.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - fann_set_cascade_candidate_stagnation_epochs - Sets the number of cascade candidate stagnation epochs - - - - &reftitle.description; - - boolfann_set_cascade_candidate_stagnation_epochs - resourceann - intcascade_candidate_stagnation_epochs - - - Sets the number of cascade candidate stagnation epochs. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - cascade_candidate_stagnation_epochs - - - The number of cascade candidate stagnation epochs. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_cascade_candidate_stagnation_epochs - - - - - - - - diff --git a/reference/fann/functions/fann-set-cascade-max-cand-epochs.xml b/reference/fann/functions/fann-set-cascade-max-cand-epochs.xml deleted file mode 100644 index 8f0806a692f3..000000000000 --- a/reference/fann/functions/fann-set-cascade-max-cand-epochs.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - fann_set_cascade_max_cand_epochs - Sets the max candidate epochs - - - - &reftitle.description; - - boolfann_set_cascade_max_cand_epochs - resourceann - intcascade_max_cand_epochs - - - Sets the max candidate epochs. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - cascade_max_cand_epochs - - - The max candidate epochs. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_cascade_max_cand_epochs - - - - - - - - diff --git a/reference/fann/functions/fann-set-cascade-max-out-epochs.xml b/reference/fann/functions/fann-set-cascade-max-out-epochs.xml deleted file mode 100644 index b563be842895..000000000000 --- a/reference/fann/functions/fann-set-cascade-max-out-epochs.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - fann_set_cascade_max_out_epochs - Sets the maximum out epochs - - - - &reftitle.description; - - boolfann_set_cascade_max_out_epochs - resourceann - intcascade_max_out_epochs - - - Sets the maximum out epochs. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - cascade_max_out_epochs - - - The maximum out epochs. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_cascade_max_out_epochs - - - - - - - - diff --git a/reference/fann/functions/fann-set-cascade-min-cand-epochs.xml b/reference/fann/functions/fann-set-cascade-min-cand-epochs.xml deleted file mode 100644 index d7efc010ec91..000000000000 --- a/reference/fann/functions/fann-set-cascade-min-cand-epochs.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - fann_set_cascade_min_cand_epochs - Sets the min candidate epochs - - - - &reftitle.description; - - boolfann_set_cascade_min_cand_epochs - resourceann - intcascade_min_cand_epochs - - - Sets the min candidate epochs. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - cascade_min_cand_epochs - - - The minimum candidate epochs. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.notes; - &fann.note.function.fann-2.2; - - - - &reftitle.seealso; - - - fann_get_cascade_min_cand_epochs - - - - - - - - diff --git a/reference/fann/functions/fann-set-cascade-min-out-epochs.xml b/reference/fann/functions/fann-set-cascade-min-out-epochs.xml deleted file mode 100644 index fe44d428ce47..000000000000 --- a/reference/fann/functions/fann-set-cascade-min-out-epochs.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - fann_set_cascade_min_out_epochs - Sets the minimum out epochs - - - - &reftitle.description; - - boolfann_set_cascade_min_out_epochs - resourceann - intcascade_min_out_epochs - - - Sets the minimum out epochs. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - cascade_min_out_epochs - - - The minimum out epochs. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.notes; - &fann.note.function.fann-2.2; - - - - &reftitle.seealso; - - - fann_get_cascade_min_out_epochs - - - - - - - - diff --git a/reference/fann/functions/fann-set-cascade-num-candidate-groups.xml b/reference/fann/functions/fann-set-cascade-num-candidate-groups.xml deleted file mode 100644 index 53d24b8619b1..000000000000 --- a/reference/fann/functions/fann-set-cascade-num-candidate-groups.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - fann_set_cascade_num_candidate_groups - Sets the number of candidate groups - - - - &reftitle.description; - - boolfann_set_cascade_num_candidate_groups - resourceann - intcascade_num_candidate_groups - - - Sets the number of candidate groups. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - cascade_num_candidate_groups - - - The number of candidate groups. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_cascade_num_candidate_groups - - - - - - - - diff --git a/reference/fann/functions/fann-set-cascade-output-change-fraction.xml b/reference/fann/functions/fann-set-cascade-output-change-fraction.xml deleted file mode 100644 index c9f7a106e937..000000000000 --- a/reference/fann/functions/fann-set-cascade-output-change-fraction.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - fann_set_cascade_output_change_fraction - Sets the cascade output change fraction - - - - &reftitle.description; - - boolfann_set_cascade_output_change_fraction - resourceann - floatcascade_output_change_fraction - - - Sets the cascade output change fraction. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - cascade_output_change_fraction - - - The cascade output change fraction. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_cascade_output_change_fraction - - - - - - - - diff --git a/reference/fann/functions/fann-set-cascade-output-stagnation-epochs.xml b/reference/fann/functions/fann-set-cascade-output-stagnation-epochs.xml deleted file mode 100644 index 30d9863b3ddb..000000000000 --- a/reference/fann/functions/fann-set-cascade-output-stagnation-epochs.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - fann_set_cascade_output_stagnation_epochs - Sets the number of cascade output stagnation epochs - - - - &reftitle.description; - - boolfann_set_cascade_output_stagnation_epochs - resourceann - intcascade_output_stagnation_epochs - - - Sets the number of cascade output stagnation epochs. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - cascade_output_stagnation_epochs - - - The number of cascade output stagnation epochs. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_cascade_output_stagnation_epochs - - - - - - - - diff --git a/reference/fann/functions/fann-set-cascade-weight-multiplier.xml b/reference/fann/functions/fann-set-cascade-weight-multiplier.xml deleted file mode 100644 index f05d39979072..000000000000 --- a/reference/fann/functions/fann-set-cascade-weight-multiplier.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - fann_set_cascade_weight_multiplier - Sets the weight multiplier - - - - &reftitle.description; - - boolfann_set_cascade_weight_multiplier - resourceann - floatcascade_weight_multiplier - - - Sets the weight multiplier. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - cascade_weight_multiplier - - - The weight multiplier. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_cascade_weight_multiplier - - - - - - - - diff --git a/reference/fann/functions/fann-set-error-log.xml b/reference/fann/functions/fann-set-error-log.xml deleted file mode 100644 index 76673d94e59b..000000000000 --- a/reference/fann/functions/fann-set-error-log.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - fann_set_error_log - Sets where the errors are logged to - - - - &reftitle.description; - - voidfann_set_error_log - resourceerrdat - stringlog_file - - - Sets where the errors are logged to. - - - - - &reftitle.parameters; - - - errdat - - &fann.errdat.description; - - - - log_file - - - The log file path. - - - - - - - - &reftitle.returnvalues; - &fann.return.void; - - - - - diff --git a/reference/fann/functions/fann-set-input-scaling-params.xml b/reference/fann/functions/fann-set-input-scaling-params.xml deleted file mode 100644 index e7d7e0705c28..000000000000 --- a/reference/fann/functions/fann-set-input-scaling-params.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - fann_set_input_scaling_params - Calculate input scaling parameters for future use based on training data - - - - &reftitle.description; - - boolfann_set_input_scaling_params - resourceann - resourcetrain_data - floatnew_input_min - floatnew_input_max - - - Calculate input scaling parameters for future use based on training data. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - train_data - - &fann.train.description; - - - - new_input_min - - - The desired lower bound in input data after scaling (not strictly followed) - - - - - new_input_max - - - The desired upper bound in input data after scaling (not strictly followed) - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_set_output_scaling_params - - - - - - - - diff --git a/reference/fann/functions/fann-set-learning-momentum.xml b/reference/fann/functions/fann-set-learning-momentum.xml deleted file mode 100644 index 785aa72ad9ae..000000000000 --- a/reference/fann/functions/fann-set-learning-momentum.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - fann_set_learning_momentum - Sets the learning momentum - - - - &reftitle.description; - - boolfann_set_learning_momentum - resourceann - floatlearning_momentum - - - Sets the learning momentum. - - - More info available in fann_get_learning_momentum. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - learning_momentum - - - The learning momentum. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_learning_momentum - fann_set_training_algorithm - - - - - - - - diff --git a/reference/fann/functions/fann-set-learning-rate.xml b/reference/fann/functions/fann-set-learning-rate.xml deleted file mode 100644 index bc5b803e11a7..000000000000 --- a/reference/fann/functions/fann-set-learning-rate.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - fann_set_learning_rate - Sets the learning rate - - - - &reftitle.description; - - boolfann_set_learning_rate - resourceann - floatlearning_rate - - - Sets the learning rate. - - - More info available in fann_get_learning_rate. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - learning_rate - - - The learning rate. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_learning_rate - fann_set_training_algorithm - - - - - - - - diff --git a/reference/fann/functions/fann-set-output-scaling-params.xml b/reference/fann/functions/fann-set-output-scaling-params.xml deleted file mode 100644 index f5f3bb05c94a..000000000000 --- a/reference/fann/functions/fann-set-output-scaling-params.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - fann_set_output_scaling_params - Calculate output scaling parameters for future use based on training data - - - - &reftitle.description; - - boolfann_set_output_scaling_params - resourceann - resourcetrain_data - floatnew_output_min - floatnew_output_max - - - Calculate output scaling parameters for future use based on training data. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - train_data - - &fann.train.description; - - - - new_output_min - - - The desired lower bound in output data after scaling (not strictly followed) - - - - - new_output_max - - - The desired upper bound in output data after scaling (not strictly followed) - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_set_input_scaling_params - - - - - - - - diff --git a/reference/fann/functions/fann-set-quickprop-decay.xml b/reference/fann/functions/fann-set-quickprop-decay.xml deleted file mode 100644 index 49b2f76b24fd..000000000000 --- a/reference/fann/functions/fann-set-quickprop-decay.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - fann_set_quickprop_decay - Sets the quickprop decay factor - - - - &reftitle.description; - - boolfann_set_quickprop_decay - resourceann - floatquickprop_decay - - - Sets the quickprop decay factor. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - quickprop_decay - - - The quickprop decay factor. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_quickprop_decay - - - - - - - - diff --git a/reference/fann/functions/fann-set-quickprop-mu.xml b/reference/fann/functions/fann-set-quickprop-mu.xml deleted file mode 100644 index 6060276fa45c..000000000000 --- a/reference/fann/functions/fann-set-quickprop-mu.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - fann_set_quickprop_mu - Sets the quickprop mu factor - - - - &reftitle.description; - - boolfann_set_quickprop_mu - resourceann - floatquickprop_mu - - - Sets the quickprop mu factor. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - quickprop_mu - - - The mu factor. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_quickprop_mu - - - - - - - - diff --git a/reference/fann/functions/fann-set-rprop-decrease-factor.xml b/reference/fann/functions/fann-set-rprop-decrease-factor.xml deleted file mode 100644 index 173e49ae11a8..000000000000 --- a/reference/fann/functions/fann-set-rprop-decrease-factor.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - fann_set_rprop_decrease_factor - Sets the decrease factor used during RPROP training - - - - &reftitle.description; - - boolfann_set_rprop_decrease_factor - resourceann - floatrprop_decrease_factor - - - Sets the decrease factor used during RPROP training. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - rprop_decrease_factor - - - The decrease factor. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_rprop_decrease_factor - - - - - - - - diff --git a/reference/fann/functions/fann-set-rprop-delta-max.xml b/reference/fann/functions/fann-set-rprop-delta-max.xml deleted file mode 100644 index dc4b443900e5..000000000000 --- a/reference/fann/functions/fann-set-rprop-delta-max.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - fann_set_rprop_delta_max - Sets the maximum step-size - - - - &reftitle.description; - - boolfann_set_rprop_delta_max - resourceann - floatrprop_delta_max - - - The maximum step-size is a positive number determining how large the maximum step-size may be. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - rprop_delta_max - - - The maximum step-size. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_rprop_delta_max - fann_get_rprop_delta_min - - - - - - - - diff --git a/reference/fann/functions/fann-set-rprop-delta-min.xml b/reference/fann/functions/fann-set-rprop-delta-min.xml deleted file mode 100644 index 79702e47ba45..000000000000 --- a/reference/fann/functions/fann-set-rprop-delta-min.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - fann_set_rprop_delta_min - Sets the minimum step-size - - - - &reftitle.description; - - boolfann_set_rprop_delta_min - resourceann - floatrprop_delta_min - - - The minimum step-size is a small positive number determining how small the minimum step-size may be. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - rprop_delta_min - - - The minimum step-size. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_rprop_delta_min - - - - - - - - diff --git a/reference/fann/functions/fann-set-rprop-delta-zero.xml b/reference/fann/functions/fann-set-rprop-delta-zero.xml deleted file mode 100644 index f47e0f149a75..000000000000 --- a/reference/fann/functions/fann-set-rprop-delta-zero.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - fann_set_rprop_delta_zero - Sets the initial step-size - - - - &reftitle.description; - - boolfann_set_rprop_delta_zero - resourceann - floatrprop_delta_zero - - - The initial step-size is a positive number determining the initial step size. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - rprop_delta_zero - - - The initial step-size. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_rprop_delta_zero - fann_get_rprop_delta_min - fann_get_rprop_delta_max - - - - - - - - diff --git a/reference/fann/functions/fann-set-rprop-increase-factor.xml b/reference/fann/functions/fann-set-rprop-increase-factor.xml deleted file mode 100644 index 07b1869862dc..000000000000 --- a/reference/fann/functions/fann-set-rprop-increase-factor.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - fann_set_rprop_increase_factor - Sets the increase factor used during RPROP training - - - - &reftitle.description; - - boolfann_set_rprop_increase_factor - resourceann - floatrprop_increase_factor - - - Sets the increase factor used during RPROP training. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - rprop_increase_factor - - - The increase factor. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_rprop_increase_factor - - - - - - - - diff --git a/reference/fann/functions/fann-set-sarprop-step-error-shift.xml b/reference/fann/functions/fann-set-sarprop-step-error-shift.xml deleted file mode 100644 index 7fc21fc90bc0..000000000000 --- a/reference/fann/functions/fann-set-sarprop-step-error-shift.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - fann_set_sarprop_step_error_shift - Sets the sarprop step error shift - - - - &reftitle.description; - - boolfann_set_sarprop_step_error_shift - resourceann - floatsarprop_step_error_shift - - - Sets the sarprop step error shift. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - sarprop_step_error_shift - - - The sarprop step error shift. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.notes; - &fann.note.function.fann-2.2; - - - - &reftitle.seealso; - - - fann_get_sarprop_step_error_shift - - - - - - - - diff --git a/reference/fann/functions/fann-set-sarprop-step-error-threshold-factor.xml b/reference/fann/functions/fann-set-sarprop-step-error-threshold-factor.xml deleted file mode 100644 index f4b2a5512354..000000000000 --- a/reference/fann/functions/fann-set-sarprop-step-error-threshold-factor.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - fann_set_sarprop_step_error_threshold_factor - Sets the sarprop step error threshold factor - - - - &reftitle.description; - - boolfann_set_sarprop_step_error_threshold_factor - resourceann - floatsarprop_step_error_threshold_factor - - - Sets the sarprop step error threshold factor. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - sarprop_step_error_threshold_factor - - - The sarprop step error threshold factor. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.notes; - &fann.note.function.fann-2.2; - - - - &reftitle.seealso; - - - fann_get_sarprop_step_error_threshold_factor - - - - - - - - diff --git a/reference/fann/functions/fann-set-sarprop-temperature.xml b/reference/fann/functions/fann-set-sarprop-temperature.xml deleted file mode 100644 index 7756ab3f7e7c..000000000000 --- a/reference/fann/functions/fann-set-sarprop-temperature.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - fann_set_sarprop_temperature - Sets the sarprop temperature - - - - &reftitle.description; - - boolfann_set_sarprop_temperature - resourceann - floatsarprop_temperature - - - Sets the sarprop temperature. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - sarprop_temperature - - - The sarprop temperature. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.notes; - &fann.note.function.fann-2.2; - - - - &reftitle.seealso; - - - fann_get_sarprop_temperature - - - - - - - - diff --git a/reference/fann/functions/fann-set-sarprop-weight-decay-shift.xml b/reference/fann/functions/fann-set-sarprop-weight-decay-shift.xml deleted file mode 100644 index f21916f3d1f9..000000000000 --- a/reference/fann/functions/fann-set-sarprop-weight-decay-shift.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - fann_set_sarprop_weight_decay_shift - Sets the sarprop weight decay shift - - - - &reftitle.description; - - boolfann_set_sarprop_weight_decay_shift - resourceann - floatsarprop_weight_decay_shift - - - Sets the sarprop weight decay shift. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - sarprop_weight_decay_shift - - - The sarprop weight decay shift. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.notes; - &fann.note.function.fann-2.2; - - - - &reftitle.seealso; - - - fann_get_sarprop_weight_decay_shift - - - - - - - - diff --git a/reference/fann/functions/fann-set-scaling-params.xml b/reference/fann/functions/fann-set-scaling-params.xml deleted file mode 100644 index c6b7db44c09e..000000000000 --- a/reference/fann/functions/fann-set-scaling-params.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - fann_set_scaling_params - Calculate input and output scaling parameters for future use based on training data - - - - &reftitle.description; - - boolfann_set_scaling_params - resourceann - resourcetrain_data - floatnew_input_min - floatnew_input_max - floatnew_output_min - floatnew_output_max - - - Calculate input and output scaling parameters for future use based on training data. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - train_data - - &fann.train.description; - - - - new_input_min - - - The desired lower bound in input data after scaling (not strictly followed) - - - - - new_input_max - - - The desired upper bound in input data after scaling (not strictly followed) - - - - - new_output_min - - - The desired lower bound in output data after scaling (not strictly followed) - - - - - new_output_max - - - The desired upper bound in output data after scaling (not strictly followed) - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_set_input_scaling_params - fann_set_output_scaling_params - - - - - - - - diff --git a/reference/fann/functions/fann-set-train-error-function.xml b/reference/fann/functions/fann-set-train-error-function.xml deleted file mode 100644 index a275e1a63d2f..000000000000 --- a/reference/fann/functions/fann-set-train-error-function.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - fann_set_train_error_function - Sets the error function used during training - - - - &reftitle.description; - - boolfann_set_train_error_function - resourceann - interror_function - - - Sets the error function used during training. - - - The error functions are described further in error functions constants. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - error_function - - - The error function constant - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_train_error_function - - - - - - - - diff --git a/reference/fann/functions/fann-set-train-stop-function.xml b/reference/fann/functions/fann-set-train-stop-function.xml deleted file mode 100644 index abed909f87c5..000000000000 --- a/reference/fann/functions/fann-set-train-stop-function.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - fann_set_train_stop_function - Sets the stop function used during training - - - - &reftitle.description; - - boolfann_set_train_stop_function - resourceann - intstop_function - - - Sets the stop function used during training. - - - The stop functions are described further in stop functions constants. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - stop_function - - - The stop function constant. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_train_stop_function - - - - - - - - diff --git a/reference/fann/functions/fann-set-training-algorithm.xml b/reference/fann/functions/fann-set-training-algorithm.xml deleted file mode 100644 index 8cde682ceeef..000000000000 --- a/reference/fann/functions/fann-set-training-algorithm.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - fann_set_training_algorithm - Sets the training algorithm - - - - &reftitle.description; - - boolfann_set_training_algorithm - resourceann - inttraining_algorithm - - - Sets the training algorithm. - - - More info available in fann_get_training_algorithm. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - training_algorithm - - - Training algorithm constant - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_training_algorithm - - - - - - - - diff --git a/reference/fann/functions/fann-set-weight-array.xml b/reference/fann/functions/fann-set-weight-array.xml deleted file mode 100644 index 8d84b377face..000000000000 --- a/reference/fann/functions/fann-set-weight-array.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - fann_set_weight_array - Set connections in the network - - - - &reftitle.description; - - boolfann_set_weight_array - resourceann - arrayconnections - - - Set connections in the network. - - - Only the weights can be changed, connections and weights are ignored if they do not already exist in the network. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - connections - - - An array of FANNConnection objects - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - - - diff --git a/reference/fann/functions/fann-set-weight.xml b/reference/fann/functions/fann-set-weight.xml deleted file mode 100644 index f63b86945f12..000000000000 --- a/reference/fann/functions/fann-set-weight.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - fann_set_weight - Set a connection in the network - - - - &reftitle.description; - - boolfann_set_weight - resourceann - intfrom_neuron - intto_neuron - floatweight - - - Set a connections in the network. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - from_neuron - - - The neuron where the connection starts - - - - - to_neuron - - - The neuron where the connection ends - - - - - weight - - - Connection weight - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - - - diff --git a/reference/fann/functions/fann-shuffle-train-data.xml b/reference/fann/functions/fann-shuffle-train-data.xml deleted file mode 100644 index 67d5afd5cdac..000000000000 --- a/reference/fann/functions/fann-shuffle-train-data.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - fann_shuffle_train_data - Shuffles training data, randomizing the order - - - - &reftitle.description; - - boolfann_shuffle_train_data - resourcetrain_data - - - Shuffles training data, randomizing the order. This is recommended for incremental training, - while it have no influence during batch training. - - - - - &reftitle.parameters; - - - train_data - - &fann.train.description; - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - - diff --git a/reference/fann/functions/fann-subset-train-data.xml b/reference/fann/functions/fann-subset-train-data.xml deleted file mode 100644 index 37b719797fb8..000000000000 --- a/reference/fann/functions/fann-subset-train-data.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - fann_subset_train_data - Returns an copy of a subset of the train data - - - - &reftitle.description; - - resourcefann_subset_train_data - resourcedata - intpos - intlength - - - Returns an copy of a subset of the train data resource, starting at position - pos and length elements forward. - - - The fann_subset_train_data(train_data, 0, fann_length_train_data(train_data)) do the same as - fann_duplicate_train_data - - - - - &reftitle.parameters; - - - data - - &fann.train.description; - - - - pos - - - Starting position. - - - - - length - - - The number of copied elements. - - - - - - - - &reftitle.returnvalues; - &fann.return.train; - - - - &reftitle.seealso; - - - fann_duplicate_train_data - - - - - - - - diff --git a/reference/fann/functions/fann-test-data.xml b/reference/fann/functions/fann-test-data.xml deleted file mode 100644 index 313e847d452e..000000000000 --- a/reference/fann/functions/fann-test-data.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - fann_test_data - Test a set of training data and calculates the MSE for the training data - - - - &reftitle.description; - - floatfann_test_data - resourceann - resourcedata - - - Test a set of training data and calculates the MSE for the training data. - - - This function updates the MSE and the bit fail values. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - data - - &fann.train.description; - - - - - - - &reftitle.returnvalues; - - The updated MSE, or &false; on error. - - - - - &reftitle.seealso; - - - fann_train_on_data - fann_train_epoch - fann_get_bit_fail - fann_get_MSE - fann_set_training_algorithm - - - - - - - - diff --git a/reference/fann/functions/fann-test.xml b/reference/fann/functions/fann-test.xml deleted file mode 100644 index 8d2f261b11c7..000000000000 --- a/reference/fann/functions/fann-test.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - fann_test - Test with a set of inputs, and a set of desired outputs - - - - &reftitle.description; - - arrayfann_test - resourceann - arrayinput - arraydesired_output - - - Test with a set of inputs, and a set of desired outputs. This operation updates the mean square error, - but does not change the network in any way. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - input - - - An array of inputs. This array must be exactly fann_get_num_input long. - - - - - desired_output - - - An array of desired outputs. This array must be exactly fann_get_num_output long. - - - - - - - - &reftitle.returnvalues; - Returns test outputs on success, or &false; on error. - - - - &reftitle.seealso; - - - fann_test_data - fann_train - fann_get_num_input - fann_get_num_output - - - - - - - - diff --git a/reference/fann/functions/fann-train-epoch.xml b/reference/fann/functions/fann-train-epoch.xml deleted file mode 100644 index 06e3917324ac..000000000000 --- a/reference/fann/functions/fann-train-epoch.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - fann_train_epoch - Train one epoch with a set of training data - - - - &reftitle.description; - - floatfann_train_epoch - resourceann - resourcedata - - - Train one epoch with the training data stored in data. One epoch is - where all of the training data is considered exactly once. - - - This function returns the MSE error as it is calculated either before or during the actual training. - This is not the actual MSE after the training epoch, but since calculating this would require going - through the entire training set once more, it is more than adequate to use this value during training. - - - The training algorithm used by this function is chosen by fann_set_training_algorithm - function. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - data - - &fann.train.description; - - - - - - - &reftitle.returnvalues; - - The MSE, or &false; on error. - - - - - &reftitle.seealso; - - - fann_train_on_data - fann_test_data - fann_get_MSE - fann_set_training_algorithm - - - - - - - - diff --git a/reference/fann/functions/fann-train-on-data.xml b/reference/fann/functions/fann-train-on-data.xml deleted file mode 100644 index ea4ccb5c1fac..000000000000 --- a/reference/fann/functions/fann-train-on-data.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - fann_train_on_data - Trains on an entire dataset for a period of time - - - - &reftitle.description; - - boolfann_train_on_data - resourceann - resourcedata - intmax_epochs - intepochs_between_reports - floatdesired_error - - - Trains on an entire dataset for a period of time. - - - This training uses the training algorithm chosen by fann_set_training_algorithm and - the parameters set for these training algorithms. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - data - - &fann.train.description; - - - - max_epochs - - - The maximum number of epochs the training should continue - - - - - epochs_between_reports - - - The number of epochs between calling a callback function. A value of zero means that user function is not called. - - - - - desired_error - - - The desired fann_get_MSE or fann_get_bit_fail, depending on the stop function - chosen by fann_set_train_stop_function - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_train_on_file - fann_train_epoch - fann_get_bit_fail - fann_get_MSE - fann_set_train_stop_function - fann_set_training_algorithm - fann_set_callback - - - - - - - - diff --git a/reference/fann/functions/fann-train-on-file.xml b/reference/fann/functions/fann-train-on-file.xml deleted file mode 100644 index e0f6ec6b10fe..000000000000 --- a/reference/fann/functions/fann-train-on-file.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - fann_train_on_file - Trains on an entire dataset, which is read from file, for a period of time - - - - &reftitle.description; - - boolfann_train_on_file - resourceann - stringfilename - intmax_epochs - intepochs_between_reports - floatdesired_error - - - Trains on an entire dataset, which is read from file, for a period of time. - - - This training uses the training algorithm chosen by fann_set_training_algorithm and - the parameters set for these training algorithms. - - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - filename - - - The file containing train data - - - - - max_epochs - - - The maximum number of epochs the training should continue - - - - - epochs_between_reports - - - The number of epochs between calling a user function. A value of zero means that user function is not called. - - - - - desired_error - - - The desired fann_get_MSE or fann_get_bit_fail, depending on the stop function - chosen by fann_set_train_stop_function - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_train_on_data - fann_train_epoch - fann_get_bit_fail - fann_get_MSE - fann_set_train_stop_function - fann_set_training_algorithm - fann_set_callback - - - - - - - - diff --git a/reference/fann/functions/fann-train.xml b/reference/fann/functions/fann-train.xml deleted file mode 100644 index a30ebadb88a6..000000000000 --- a/reference/fann/functions/fann-train.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - fann_train - Train one iteration with a set of inputs, and a set of desired outputs - - - - &reftitle.description; - - boolfann_train - resourceann - arrayinput - arraydesired_output - - - Train one iteration with a set of inputs, and a set of desired outputs. This training is always incremental training, - since only one pattern is presented. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - input - - - An array of inputs. This array must be exactly fann_get_num_input long. - - - - - desired_output - - - An array of desired outputs. This array must be exactly fann_get_num_output long. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_train_on_data - fann_train_epoch - fann_get_num_input - fann_get_num_output - - - - - - - - diff --git a/reference/fann/reference.xml b/reference/fann/reference.xml deleted file mode 100644 index 069fb8ae3044..000000000000 --- a/reference/fann/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - Fann &Functions; - - &reference.fann.entities.functions; - - - - diff --git a/reference/fann/setup.xml b/reference/fann/setup.xml deleted file mode 100644 index fad1af04a6cb..000000000000 --- a/reference/fann/setup.xml +++ /dev/null @@ -1,187 +0,0 @@ - - - - - &reftitle.setup; - -
- &reftitle.required; - - PHP >= 5.2.0 and libfann >= 2.1.0 - -
- -
- &reftitle.install; - - The FANN PHP extension should work on all Linux systems. - - - - - - - - - - - - - - -
- - FANN Library Installation - - - Before you start installation make sure that libfann is installed - on your system. It's part of the main repository in the most Linux distributions - (search for fann). You need a development version. - - - If it is not installed, you need to install it first. Either download it from the - official site or get it from your distro - repository. For example on Fedora: - - - - or Ubuntu: - - - - - - If the library is re-installed manually, then all old library file should be removed - before re-installing otherwise the old library version could be linked. - -
- -
- - PECL Installation - - - This extension is available on PECL. The installation is very simple. Just run: - - - - -
- -
- - Manual Installation - - - For developers and people interested in the latest changes, you - can compile the driver from the latest source code on - Github. - Go to Github and click the "Download ZIP" button. Then run: - - - - - - - - Make the following changes to php.ini: - - - - - Make sure the extension_dir variable is pointing to - the directory containing fann.so. The build will display where - it is installing the PHP driver with output that looks something like: - - - - - Make sure that it is the same as the PHP extension directory by running: - - - /usr/lib/php/extensions/no-debug-non-zts-20060613 => - /usr/lib/php/extensions/no-debug-non-zts-20060613 - -]]> - - - If it's not, change the extension_dir in php.ini or - move fann.so. - - - - - To load the extension on PHP startup, add a line: - - - - - - - - - -
-
- -
- &reftitle.resources; - - - -
- -
- - diff --git a/reference/fann/versions.xml b/reference/fann/versions.xml deleted file mode 100644 index 459e74b3af47..000000000000 --- a/reference/fann/versions.xml +++ /dev/null @@ -1,174 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/fdf/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/fdf/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/fdf/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/fdf/book.xml b/reference/fdf/book.xml deleted file mode 100644 index 3aac7c4c162d..000000000000 --- a/reference/fdf/book.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - Forms Data Format - FDF - - - - &reftitle.intro; - - Forms Data Format (FDF) is a format for handling - forms within PDF documents. You should read the documentation at - &spec.pdf.fdf; - for more information on what FDF is and how it is used in general. - - - The general idea of FDF is similar to HTML forms. The difference is - basically the format how data is transmitted to the server when the submit - button is pressed (this is actually the Form Data Format) and the format - of the form itself (which is the Portable Document Format, PDF). - Processing the FDF data is one of the features provided by the fdf - functions. But there is more. One may as well take an existing PDF form - and populated the input fields with data without modifying the form - itself. In such a case one would create a FDF document - (fdf_create) set the values of each input field - (fdf_set_value) and associate it with a PDF form - (fdf_set_file). Finally it has to be sent to the - browser with MimeType application/vnd.fdf. The Acrobat - reader plugin of your browser recognizes the MimeType, reads the - associated PDF form and fills in the data from the FDF document. - - - - If you look at an FDF-document with a text editor you will find a - catalogue object with the name FDF. Such an object may - contain a number of entries like Fields, - F, Status etc.. - The most commonly used entries are Fields which points - to a list of input fields, and F which contains the - filename of the PDF-document this data belongs to. Those entries are - referred to in the FDF documentation as /F-Key or /Status-Key. - Modifying this entries - is done by functions like fdf_set_file and - fdf_set_status. Fields are modified with - fdf_set_value, fdf_set_opt etc.. - - - - - &reference.fdf.setup; - &reference.fdf.constants; - &reference.fdf.examples; - &reference.fdf.reference; - - - - - diff --git a/reference/fdf/configure.xml b/reference/fdf/configure.xml deleted file mode 100644 index 308336a88091..000000000000 --- a/reference/fdf/configure.xml +++ /dev/null @@ -1,54 +0,0 @@ - - -
- &reftitle.install; - - &pecl.info.dead; - &url.pecl.vcs;fdf. - - - This extension is no longer bundled with PHP. - - - - If you run into problems configuring PHP with fdftk support, check - whether the header file fdftk.h and the library - libfdftk.so are at the right place. - The configure script supports both the directory structure of the - FDF SDK distribution and the usual DIR/include / - DIR/lib layout, so you can point it either - directly to the unpacked distribution directory or put the header - file and the appropriate library for your platform into e.g. - /usr/local/include and - /usr/local/lib and configure with - . - - - - Note to Win32 Users - - &ext.windows.path.dll; - fdftk.dll - - -
- diff --git a/reference/fdf/constants.xml b/reference/fdf/constants.xml deleted file mode 100644 index 0168e2cb35f0..000000000000 --- a/reference/fdf/constants.xml +++ /dev/null @@ -1,326 +0,0 @@ - - - - &reftitle.constants; - &extension.constants; - - - - FDFValue - (int) - - - - - - - - - - FDFStatus - (int) - - - - - - - - - - FDFFile - (int) - - - - - - - - - - FDFID - (int) - - - - - - - - - - FDFFf - (int) - - - - - - - - - - FDFSetFf - (int) - - - - - - - - - - FDFClearFf - (int) - - - - - - - - - - FDFFlags - (int) - - - - - - - - - - FDFSetF - (int) - - - - - - - - - - FDFClrF - (int) - - - - - - - - - - FDFAP - (int) - - - - - - - - - - FDFAS - (int) - - - - - - - - - - FDFAction - (int) - - - - - - - - - - FDFAA - (int) - - - - - - - - - - FDFAPRef - (int) - - - - - - - - - - FDFIF - (int) - - - - - - - - - - FDFEnter - (int) - - - - - - - - - - FDFExit - (int) - - - - - - - - - - FDFDown - (int) - - - - - - - - - - FDFUp - (int) - - - - - - - - - - FDFFormat - (int) - - - - - - - - - - FDFValidate - (int) - - - - - - - - - - FDFKeystroke - (int) - - - - - - - - - - FDFCalculate - (int) - - - - - - - - - - FDFNormalAP - (int) - - - - - - - - - - FDFRolloverAP - (int) - - - - - - - - - - FDFDownAP - (int) - - - - - - - - - - - diff --git a/reference/fdf/examples.xml b/reference/fdf/examples.xml deleted file mode 100644 index e16ac4d1ff38..000000000000 --- a/reference/fdf/examples.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - &reftitle.examples; - - The following examples shows just the evaluation of form data. - - Evaluating a FDF document - -$volume'
"; - -$date = fdf_get_value($fdf, "date"); -echo "The date field has the value '$date'
"; - -$comment = fdf_get_value($fdf, "comment"); -echo "The comment field has the value '$comment'
"; - -if (fdf_get_value($fdf, "show_publisher") == "On") { - $publisher = fdf_get_value($fdf, "publisher"); - echo "The publisher field has the value '$publisher'
"; -} else - echo "Publisher shall not be shown.
"; - -if (fdf_get_value($fdf, "show_preparer") == "On") { - $preparer = fdf_get_value($fdf, "preparer"); - echo "The preparer field has the value '$preparer'
"; -} else - echo "Preparer shall not be shown.
"; -fdf_close($fdf); -?> -]]> -
-
-
-
- - - diff --git a/reference/fdf/functions/fdf-add-doc-javascript.xml b/reference/fdf/functions/fdf-add-doc-javascript.xml deleted file mode 100644 index 823a5f1f735a..000000000000 --- a/reference/fdf/functions/fdf-add-doc-javascript.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - fdf_add_doc_javascript - Adds javascript code to the FDF document - - - - &reftitle.description; - - boolfdf_add_doc_javascript - resourcefdf_document - stringscript_name - stringscript_code - - - Adds a script to the FDF, which Acrobat then adds to the doc-level scripts - of a document, once the FDF is imported into it. - - - - - &reftitle.parameters; - - - fdf_document - - - The FDF document handle, returned by fdf_create, - fdf_open or fdf_open_string. - - - - - script_name - - - The script name. - - - - - script_code - - - The script code. It is strongly suggested to use \r - for linebreaks within the script code. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Adding JavaScript code to a FDF - - -]]> - - - will create a FDF like this: - - -> >> ->> -endobj -trailer -<< -/Root 1 0 R - ->> -%%EOF -]]> - - - - - - diff --git a/reference/fdf/functions/fdf-add-template.xml b/reference/fdf/functions/fdf-add-template.xml deleted file mode 100644 index 9143bb53b749..000000000000 --- a/reference/fdf/functions/fdf-add-template.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - fdf_add_template - Adds a template into the FDF document - - - - &reftitle.description; - - boolfdf_add_template - resourcefdf_document - intnewpage - stringfilename - stringtemplate - intrename - - &warn.undocumented.func; - - - - - diff --git a/reference/fdf/functions/fdf-close.xml b/reference/fdf/functions/fdf-close.xml deleted file mode 100644 index e96e6ad88822..000000000000 --- a/reference/fdf/functions/fdf-close.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - fdf_close - Close an FDF document - - - - &reftitle.description; - - voidfdf_close - resourcefdf_document - - - Closes the FDF document. - - - - - &reftitle.parameters; - - - fdf_document - - - The FDF document handle, returned by fdf_create, - fdf_open or fdf_open_string. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - fdf_open - - - - diff --git a/reference/fdf/functions/fdf-create.xml b/reference/fdf/functions/fdf-create.xml deleted file mode 100644 index c0d9347cee7d..000000000000 --- a/reference/fdf/functions/fdf-create.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - fdf_create - Create a new FDF document - - - - &reftitle.description; - - resourcefdf_create - - - - Creates a new FDF document. - - - This function is needed if one would like to populate input fields in a - PDF document with data. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a FDF document handle, or &false; on error. - - - - - &reftitle.examples; - - Populating a PDF document - - -]]> - - - - - - &reftitle.seealso; - - fdf_close - fdf_save - fdf_open - - - - - diff --git a/reference/fdf/functions/fdf-enum-values.xml b/reference/fdf/functions/fdf-enum-values.xml deleted file mode 100644 index 36f9706ff3fb..000000000000 --- a/reference/fdf/functions/fdf-enum-values.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - fdf_enum_values - Call a user defined function for each document value - - - - &reftitle.description; - - boolfdf_enum_values - resourcefdf_document - callablefunction - mixeduserdata - - &warn.undocumented.func; - - - - - diff --git a/reference/fdf/functions/fdf-errno.xml b/reference/fdf/functions/fdf-errno.xml deleted file mode 100644 index 5a03d2474228..000000000000 --- a/reference/fdf/functions/fdf-errno.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - fdf_errno - Return error code for last fdf operation - - - - &reftitle.description; - - intfdf_errno - - - - Gets the error code set by the last FDF function call. - - - A textual description of the error may be obtained using - fdf_error. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the error code as an integer, or zero if there was no errors. - - - - - &reftitle.seealso; - - fdf_error - - - - diff --git a/reference/fdf/functions/fdf-error.xml b/reference/fdf/functions/fdf-error.xml deleted file mode 100644 index fd94f600fe6a..000000000000 --- a/reference/fdf/functions/fdf-error.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - fdf_error - Return error description for FDF error code - - - - &reftitle.description; - - stringfdf_error - interror_code-1 - - - Gets a textual description for the FDF error code given in - error_code. - - - - - &reftitle.parameters; - - - error_code - - - An error code obtained with fdf_errno. - If not provided, this function uses the internal error code set by the - last operation. - - - - - - - - &reftitle.returnvalues; - - Returns the error message as a string, or the string - no error if nothing went wrong. - - - - - &reftitle.seealso; - - fdf_errno - - - - - diff --git a/reference/fdf/functions/fdf-get-ap.xml b/reference/fdf/functions/fdf-get-ap.xml deleted file mode 100644 index e8f2b8679141..000000000000 --- a/reference/fdf/functions/fdf-get-ap.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - fdf_get_ap - Get the appearance of a field - - - - &reftitle.description; - - boolfdf_get_ap - resourcefdf_document - stringfield - intface - stringfilename - - - Gets the appearance of a field (i.e. the value of - the /AP key) and stores it in a file. - - - - - &reftitle.parameters; - - - fdf_document - - - The FDF document handle, returned by fdf_create, - fdf_open or fdf_open_string. - - - - - field - - - - - - - face - - - The possible values are FDFNormalAP, - FDFRolloverAP and FDFDownAP. - - - - - filename - - - The appearance will be stored in this parameter. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/fdf/functions/fdf-get-attachment.xml b/reference/fdf/functions/fdf-get-attachment.xml deleted file mode 100644 index 5a5399997427..000000000000 --- a/reference/fdf/functions/fdf-get-attachment.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - fdf_get_attachment - Extracts uploaded file embedded in the FDF - - - - &reftitle.description; - - arrayfdf_get_attachment - resourcefdf_document - stringfieldname - stringsavepath - - - Extracts a file uploaded by means of the "file selection" field - fieldname and stores it under - savepath. - - - - - &reftitle.parameters; - - - fdf_document - - - The FDF document handle, returned by fdf_create, - fdf_open or fdf_open_string. - - - - - fieldname - - - - - - - savepath - - - May be the name of a plain file or an existing directory in which the - file is to be created under its original name. Any existing file under - the same name will be overwritten. - - - - There seems to be no other way to find out the original filename but - to store the file using a directory as - savepath and check for the basename it was - stored under. - - - - - - - - - &reftitle.returnvalues; - - The returned array contains the following fields: - - - path - path where the file got stored - - - size - size of the stored file in bytes - - - type - mimetype if given in the FDF - - - - - - - &reftitle.examples; - - Storing an uploaded file - - -]]> - - - - - - diff --git a/reference/fdf/functions/fdf-get-encoding.xml b/reference/fdf/functions/fdf-get-encoding.xml deleted file mode 100644 index fe44fe24a9ba..000000000000 --- a/reference/fdf/functions/fdf-get-encoding.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - fdf_get_encoding - Get the value of the /Encoding key - - - - &reftitle.description; - - stringfdf_get_encoding - resourcefdf_document - - - Gets the value of the /Encoding key. - - - - - &reftitle.parameters; - - - fdf_document - - - The FDF document handle, returned by fdf_create, - fdf_open or fdf_open_string. - - - - - - - - &reftitle.returnvalues; - - Returns the encoding as a string. An empty string is returned if the - default PDFDocEncoding/Unicode scheme is used. - - - - - &reftitle.seealso; - - fdf_set_encoding - - - - - diff --git a/reference/fdf/functions/fdf-get-file.xml b/reference/fdf/functions/fdf-get-file.xml deleted file mode 100644 index 0b1e83ce1390..000000000000 --- a/reference/fdf/functions/fdf-get-file.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - fdf_get_file - Get the value of the /F key - - - - &reftitle.description; - - stringfdf_get_file - resourcefdf_document - - - Gets the value of the /F key. - - - - - &reftitle.parameters; - - - fdf_document - - - The FDF document handle, returned by fdf_create, - fdf_open or fdf_open_string. - - - - - - - - &reftitle.returnvalues; - - Returns the key value, as a string. - - - - - &reftitle.seealso; - - fdf_set_file - - - - - diff --git a/reference/fdf/functions/fdf-get-flags.xml b/reference/fdf/functions/fdf-get-flags.xml deleted file mode 100644 index 1f3a6edfe4ca..000000000000 --- a/reference/fdf/functions/fdf-get-flags.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - fdf_get_flags - Gets the flags of a field - - - - &reftitle.description; - - intfdf_get_flags - resourcefdf_document - stringfieldname - intwhichflags - - &warn.undocumented.func; - - - - - diff --git a/reference/fdf/functions/fdf-get-opt.xml b/reference/fdf/functions/fdf-get-opt.xml deleted file mode 100644 index a9b24dfaba86..000000000000 --- a/reference/fdf/functions/fdf-get-opt.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - fdf_get_opt - Gets a value from the opt array of a field - - - - &reftitle.description; - - mixedfdf_get_opt - resourcefdf_document - stringfieldname - intelement-1 - - &warn.undocumented.func; - - - - - diff --git a/reference/fdf/functions/fdf-get-status.xml b/reference/fdf/functions/fdf-get-status.xml deleted file mode 100644 index bb3664b5466e..000000000000 --- a/reference/fdf/functions/fdf-get-status.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - fdf_get_status - Get the value of the /STATUS key - - - - &reftitle.description; - - stringfdf_get_status - resourcefdf_document - - - Gets the value of the /STATUS key. - - - - - &reftitle.parameters; - - - fdf_document - - - The FDF document handle, returned by fdf_create, - fdf_open or fdf_open_string. - - - - - - - - &reftitle.returnvalues; - - Returns the key value, as a string. - - - - - &reftitle.seealso; - - fdf_set_status - - - - - diff --git a/reference/fdf/functions/fdf-get-value.xml b/reference/fdf/functions/fdf-get-value.xml deleted file mode 100644 index 8d9854d8b7c7..000000000000 --- a/reference/fdf/functions/fdf-get-value.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - fdf_get_value - Get the value of a field - - - - &reftitle.description; - - mixedfdf_get_value - resourcefdf_document - stringfieldname - intwhich-1 - - - Gets the value for the requested field. - - - - - &reftitle.parameters; - - - fdf_document - - - The FDF document handle, returned by fdf_create, - fdf_open or fdf_open_string. - - - - - fieldname - - - Name of the FDF field, as a string. - - - - - which - - - Elements of an array field can be retrieved by passing this optional - parameter, starting at zero. For non-array fields, this parameter will - be ignored. - - - - - - - - &reftitle.returnvalues; - - Returns the field value. - - - - - &reftitle.seealso; - - fdf_set_value - - - - - diff --git a/reference/fdf/functions/fdf-get-version.xml b/reference/fdf/functions/fdf-get-version.xml deleted file mode 100644 index 411fb2601c56..000000000000 --- a/reference/fdf/functions/fdf-get-version.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - fdf_get_version - Gets version number for FDF API or file - - - - &reftitle.description; - - stringfdf_get_version - resourcefdf_document - - - Return the FDF version for the given document, or the toolkit API version - number if no parameter is given. - - - - - &reftitle.parameters; - - - fdf_document - - - The FDF document handle, returned by fdf_create, - fdf_open or fdf_open_string. - - - - - - - - &reftitle.returnvalues; - - Returns the version as a string. For the current FDF toolkit 5.0 the API - version number is 5.0 and the document version number - is either 1.2, 1.3 or - 1.4. - - - - - &reftitle.seealso; - - fdf_set_version - - - - - diff --git a/reference/fdf/functions/fdf-header.xml b/reference/fdf/functions/fdf-header.xml deleted file mode 100644 index 5b0908c49c35..000000000000 --- a/reference/fdf/functions/fdf-header.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - fdf_header - Sets FDF-specific output headers - - - - &reftitle.description; - - voidfdf_header - - - - This is a convenience function to set appropriate HTTP headers for FDF - output. It sets the Content-type: to - application/vnd.fdf. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/fdf/functions/fdf-next-field-name.xml b/reference/fdf/functions/fdf-next-field-name.xml deleted file mode 100644 index 8fc131fbe3de..000000000000 --- a/reference/fdf/functions/fdf-next-field-name.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - fdf_next_field_name - Get the next field name - - - - &reftitle.description; - - stringfdf_next_field_name - resourcefdf_document - stringfieldname - - - Gets the name of the field after the given field. This name can be used - with several functions. - - - - - &reftitle.parameters; - - - fdf_document - - - The FDF document handle, returned by fdf_create, - fdf_open or fdf_open_string. - - - - - fieldname - - - Name of the FDF field, as a string. If not given, the first field will - be assumed. - - - - - - - - &reftitle.returnvalues; - - Returns the field name as a string. - - - - - &reftitle.examples; - - Detecting all fieldnames in a FDF - - -]]> - - - - - - &reftitle.seealso; - - fdf_get_value - - - - - diff --git a/reference/fdf/functions/fdf-open-string.xml b/reference/fdf/functions/fdf-open-string.xml deleted file mode 100644 index fabfa0a3681d..000000000000 --- a/reference/fdf/functions/fdf-open-string.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - fdf_open_string - Read a FDF document from a string - - - - &reftitle.description; - - resourcefdf_open_string - stringfdf_data - - - Reads form data from a string. - - - You can use fdf_open_string together with - $HTTP_FDF_DATA to process FDF form input from a remote - client. - - - - - &reftitle.parameters; - - - fdf_data - - - The data as returned from a PDF form or created using - fdf_create and - fdf_save_string. - - - - - - - - &reftitle.returnvalues; - - Returns a FDF document handle, or &false; on error. - - - - - &reftitle.examples; - - Accessing the form data - - -]]> - - - - - - &reftitle.seealso; - - fdf_open - fdf_close - fdf_create - fdf_save_string - - - - - diff --git a/reference/fdf/functions/fdf-open.xml b/reference/fdf/functions/fdf-open.xml deleted file mode 100644 index 53b2571ca46d..000000000000 --- a/reference/fdf/functions/fdf-open.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - fdf_open - Open a FDF document - - - - &reftitle.description; - - resourcefdf_open - stringfilename - - - Opens a file with form data. - - - You can also use fdf_open_string to process the - results of a PDF form POST request. - - - - - &reftitle.parameters; - - - filename - - - Path to the FDF file. This file must contain the data as returned from - a PDF form or created using fdf_create and - fdf_save. - - - - - - - - &reftitle.returnvalues; - - Returns a FDF document handle, or &false; on error. - - - - - &reftitle.examples; - - Accessing the form data - - -]]> - - - - - - &reftitle.seealso; - - fdf_open_string - fdf_close - fdf_create - fdf_save - - - - - diff --git a/reference/fdf/functions/fdf-remove-item.xml b/reference/fdf/functions/fdf-remove-item.xml deleted file mode 100644 index f4398abcb7a7..000000000000 --- a/reference/fdf/functions/fdf-remove-item.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - fdf_remove_item - Sets target frame for form - - - - &reftitle.description; - - boolfdf_remove_item - resourcefdf_document - stringfieldname - intitem - - &warn.undocumented.func; - - - - - diff --git a/reference/fdf/functions/fdf-save-string.xml b/reference/fdf/functions/fdf-save-string.xml deleted file mode 100644 index f5cdeb19db86..000000000000 --- a/reference/fdf/functions/fdf-save-string.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - fdf_save_string - Returns the FDF document as a string - - - - &reftitle.description; - - stringfdf_save_string - resourcefdf_document - - - Returns the FDF document as a string. - - - - - &reftitle.parameters; - - - fdf_document - - - The FDF document handle, returned by fdf_create, - fdf_open or fdf_open_string. - - - - - - - - &reftitle.returnvalues; - - Returns the document as a string, or &false; on error. - - - - - &reftitle.examples; - - Retrieving FDF as a string - - -]]> - - &example.outputs; - -> ->> -endobj -2 0 obj -[ -<< /T (foo)/V (bar)>> -] -endobj -trailer -<< -/Root 1 0 R - ->> -%%EOF -]]> - - - - - - &reftitle.seealso; - - fdf_open_string - fdf_close - fdf_create - fdf_save - - - - - diff --git a/reference/fdf/functions/fdf-save.xml b/reference/fdf/functions/fdf-save.xml deleted file mode 100644 index a8f298ea5068..000000000000 --- a/reference/fdf/functions/fdf-save.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - fdf_save - Save a FDF document - - - - &reftitle.description; - - boolfdf_save - resourcefdf_document - stringfilename - - - Saves a FDF document. - - - - - &reftitle.parameters; - - - fdf_document - - - The FDF document handle, returned by fdf_create, - fdf_open or fdf_open_string. - - - - - filename - - - If provided, the resulting FDF will be written in this parameter. - Otherwise, this function will write the FDF to the default PHP output - stream. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - fdf_close - fdf_create - fdf_save_string - - - - - diff --git a/reference/fdf/functions/fdf-set-ap.xml b/reference/fdf/functions/fdf-set-ap.xml deleted file mode 100644 index d481b0c5518d..000000000000 --- a/reference/fdf/functions/fdf-set-ap.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - fdf_set_ap - Set the appearance of a field - - - - &reftitle.description; - - boolfdf_set_ap - resourcefdf_document - stringfield_name - intface - stringfilename - intpage_number - - - Sets the appearance of a field (i.e. the value of the - /AP key). - - - - - &reftitle.parameters; - - - fdf_document - - - The FDF document handle, returned by fdf_create, - fdf_open or fdf_open_string. - - - - - field_name - - - - - - - face - - - The possible values are FDFNormalAP, - FDFRolloverAP and - FDFDownAP. - - - - - filename - - - - - - - page_number - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/fdf/functions/fdf-set-encoding.xml b/reference/fdf/functions/fdf-set-encoding.xml deleted file mode 100644 index 02b23a6c629f..000000000000 --- a/reference/fdf/functions/fdf-set-encoding.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - fdf_set_encoding - Sets FDF character encoding - - - - &reftitle.description; - - boolfdf_set_encoding - resourcefdf_document - stringencoding - - - Sets the character encoding for the FDF document. - - - - - &reftitle.parameters; - - - fdf_document - - - The FDF document handle, returned by fdf_create, - fdf_open or fdf_open_string. - - - - - encoding - - - The encoding name. The following values are supported: - "Shift-JIS", "UHC", - "GBK" and "BigFive". - - - An empty string resets the encoding to the default - PDFDocEncoding/Unicode scheme. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/fdf/functions/fdf-set-file.xml b/reference/fdf/functions/fdf-set-file.xml deleted file mode 100644 index 0ac7ef084076..000000000000 --- a/reference/fdf/functions/fdf-set-file.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - fdf_set_file - Set PDF document to display FDF data in - - - - &reftitle.description; - - boolfdf_set_file - resourcefdf_document - stringurl - stringtarget_frame - - - Selects a different PDF document to display the form results in than the - form it originated from. - - - - - &reftitle.parameters; - - - fdf_document - - - The FDF document handle, returned by fdf_create, - fdf_open or fdf_open_string. - - - - - url - - - Should be given as an absolute URL. - - - - - target_frame - - - Use this parameter to specify the frame in which the document will be - displayed. You can also set the default value for this parameter using - fdf_set_target_frame. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Passing FDF data to a second form - - -]]> - - - - - - &reftitle.seealso; - - fdf_get_file - fdf_set_target_frame - - - - - diff --git a/reference/fdf/functions/fdf-set-flags.xml b/reference/fdf/functions/fdf-set-flags.xml deleted file mode 100644 index 5f3dff99690e..000000000000 --- a/reference/fdf/functions/fdf-set-flags.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - fdf_set_flags - Sets a flag of a field - - - - &reftitle.description; - - boolfdf_set_flags - resourcefdf_document - stringfieldname - intwhichFlags - intnewFlags - - - Sets certain flags of the given field. - - - - - &reftitle.parameters; - - - fdf_document - - - The FDF document handle, returned by fdf_create, - fdf_open or fdf_open_string. - - - - - fieldname - - - Name of the FDF field, as a string. - - - - - whichFlags - - - - - - - newFlags - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - fdf_set_opt - - - - - diff --git a/reference/fdf/functions/fdf-set-javascript-action.xml b/reference/fdf/functions/fdf-set-javascript-action.xml deleted file mode 100644 index 5835231d2285..000000000000 --- a/reference/fdf/functions/fdf-set-javascript-action.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - fdf_set_javascript_action - Sets an javascript action of a field - - - - &reftitle.description; - - boolfdf_set_javascript_action - resourcefdf_document - stringfieldname - inttrigger - stringscript - - - Sets a javascript action for the given field. - - - - - &reftitle.parameters; - - - fdf_document - - - The FDF document handle, returned by fdf_create, - fdf_open or fdf_open_string. - - - - - fieldname - - - Name of the FDF field, as a string. - - - - - trigger - - - - - - - script - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - fdf_set_submit_form_action - - - - - diff --git a/reference/fdf/functions/fdf-set-on-import-javascript.xml b/reference/fdf/functions/fdf-set-on-import-javascript.xml deleted file mode 100644 index f74439ddc8c0..000000000000 --- a/reference/fdf/functions/fdf-set-on-import-javascript.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - fdf_set_on_import_javascript - Adds javascript code to be executed when Acrobat opens the FDF - - - - &reftitle.description; - - boolfdf_set_on_import_javascript - resourcefdf_document - stringscript - boolbefore_data_import - - &warn.undocumented.func; - - - - &reftitle.seealso; - - fdf_add_doc_javascript - fdf_set_javascript_action - - - - - diff --git a/reference/fdf/functions/fdf-set-opt.xml b/reference/fdf/functions/fdf-set-opt.xml deleted file mode 100644 index 2cbeb1e6c127..000000000000 --- a/reference/fdf/functions/fdf-set-opt.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - fdf_set_opt - Sets an option of a field - - - - &reftitle.description; - - boolfdf_set_opt - resourcefdf_document - stringfieldname - intelement - stringstr1 - stringstr2 - - - Sets options of the given field. - - - - - &reftitle.parameters; - - - fdf_document - - - The FDF document handle, returned by fdf_create, - fdf_open or fdf_open_string. - - - - - fieldname - - - Name of the FDF field, as a string. - - - - - element - - - - - - - str1 - - - - - - - str2 - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - fdf_set_flags - - - - - diff --git a/reference/fdf/functions/fdf-set-status.xml b/reference/fdf/functions/fdf-set-status.xml deleted file mode 100644 index aff9ae49346e..000000000000 --- a/reference/fdf/functions/fdf-set-status.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - fdf_set_status - Set the value of the /STATUS key - - - - &reftitle.description; - - boolfdf_set_status - resourcefdf_document - stringstatus - - - Sets the value of the /STATUS key. When a client - receives a FDF with a status set it will present the value in an alert - box. - - - - - &reftitle.parameters; - - - fdf_document - - - The FDF document handle, returned by fdf_create, - fdf_open or fdf_open_string. - - - - - status - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - fdf_get_status - - - - - diff --git a/reference/fdf/functions/fdf-set-submit-form-action.xml b/reference/fdf/functions/fdf-set-submit-form-action.xml deleted file mode 100644 index 2d23c88c329b..000000000000 --- a/reference/fdf/functions/fdf-set-submit-form-action.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - fdf_set_submit_form_action - Sets a submit form action of a field - - - - &reftitle.description; - - boolfdf_set_submit_form_action - resourcefdf_document - stringfieldname - inttrigger - stringscript - intflags - - - Sets a submit form action for the given field. - - - - - &reftitle.parameters; - - - fdf_document - - - The FDF document handle, returned by fdf_create, - fdf_open or fdf_open_string. - - - - - fieldname - - - Name of the FDF field, as a string. - - - - - trigger - - - - - - - script - - - - - - - flags - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - fdf_set_javascript_action - - - - - diff --git a/reference/fdf/functions/fdf-set-target-frame.xml b/reference/fdf/functions/fdf-set-target-frame.xml deleted file mode 100644 index b7d5380bb8f5..000000000000 --- a/reference/fdf/functions/fdf-set-target-frame.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - fdf_set_target_frame - Set target frame for form display - - - - &reftitle.description; - - boolfdf_set_target_frame - resourcefdf_document - stringframe_name - - - Sets the target frame to display a result PDF defined with - fdf_save_file in. - - - - - &reftitle.parameters; - - - fdf_document - - - The FDF document handle, returned by fdf_create, - fdf_open or fdf_open_string. - - - - - frame_name - - - The frame name, as a string. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - fdf_save_file - - - - - diff --git a/reference/fdf/functions/fdf-set-value.xml b/reference/fdf/functions/fdf-set-value.xml deleted file mode 100644 index cafea957282e..000000000000 --- a/reference/fdf/functions/fdf-set-value.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - fdf_set_value - Set the value of a field - - - - &reftitle.description; - - boolfdf_set_value - resourcefdf_document - stringfieldname - mixedvalue - intisName - - - Sets the value for the given field. - - - - - &reftitle.parameters; - - - fdf_document - - - The FDF document handle, returned by fdf_create, - fdf_open or fdf_open_string. - - - - - fieldname - - - Name of the FDF field, as a string. - - - - - value - - - This parameter will be stored as a string unless it is an array. In - this case all array elements will be stored as a value array. - - - - - isName - - - - In older versions of the FDF toolkit last parameter determined if the - field value was to be converted to a PDF Name (= 1) or set to a PDF - String (= 0). - - - The value is no longer used in the current toolkit version 5.0. For - compatibility reasons it is still supported as an optional parameter, - but ignored internally. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - fdf_get_value - fdf_remove_item - - - - - diff --git a/reference/fdf/functions/fdf-set-version.xml b/reference/fdf/functions/fdf-set-version.xml deleted file mode 100644 index 2dc2cb04a95f..000000000000 --- a/reference/fdf/functions/fdf-set-version.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - fdf_set_version - Sets version number for a FDF file - - - - &reftitle.description; - - boolfdf_set_version - resourcefdf_document - stringversion - - - Sets the FDF version for the given document. - - - Some features supported by this extension are only available in newer FDF - versions. - - - - - &reftitle.parameters; - - - fdf_document - - - The FDF document handle, returned by fdf_create, - fdf_open or fdf_open_string. - - - - - version - - - The version number. For the current FDF toolkit 5.0, this may be - either 1.2, 1.3 or - 1.4. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - fdf_get_version - - - - - diff --git a/reference/fdf/reference.xml b/reference/fdf/reference.xml deleted file mode 100644 index 8cc2329419e3..000000000000 --- a/reference/fdf/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - FDF &Functions; - - &reference.fdf.entities.functions; - - - - - diff --git a/reference/fdf/setup.xml b/reference/fdf/setup.xml deleted file mode 100644 index 59b85146a57e..000000000000 --- a/reference/fdf/setup.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - &reftitle.setup; - - -
- &reftitle.required; - - You need the FDF toolkit SDK available from - &spec.pdf.fdf;. - As of PHP 4.3.0 you need at least SDK version 5.0. - The FDF toolkit library is available in binary form only, - platforms supported by Adobe are Win32, Linux, Solaris and AIX. - -
- - - - &reference.fdf.configure; - - - -
- &reftitle.resources; - - Most fdf functions require a fdf resource - as their first parameter. A fdf resource - is a handle to an opened fdf file. fdf - resources may be obtained using fdf_create, - fdf_open and fdf_open_string. - -
- - -
- diff --git a/reference/fdf/versions.xml b/reference/fdf/versions.xml deleted file mode 100644 index 8ad04a69106b..000000000000 --- a/reference/fdf/versions.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/gearman/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/gearman/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/gearman/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/gearman/book.xml b/reference/gearman/book.xml deleted file mode 100644 index fabf4015ee55..000000000000 --- a/reference/gearman/book.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - Gearman - Gearman - - - &reftitle.intro; - - Gearman is a generic application framework for farming - out work to multiple machines or processes. It allows applications to complete tasks in parallel, - to load balance processing, and to call functions between languages. The framework can be - used in a variety of applications, from high-availability web sites to the transport of database - replication events. - - - This extension provides classes for writing Gearman clients and workers. - - - - &reference.gearman.setup; - &reference.gearman.constants; - &reference.gearman.examples; - &reference.gearman.gearmanclient; - &reference.gearman.gearmanjob; - &reference.gearman.gearmantask; - &reference.gearman.gearmanworker; - &reference.gearman.gearmanexception; - - - diff --git a/reference/gearman/configure.xml b/reference/gearman/configure.xml deleted file mode 100644 index 6ad8137ad89c..000000000000 --- a/reference/gearman/configure.xml +++ /dev/null @@ -1,31 +0,0 @@ - - -
- &reftitle.install; - - - &pecl.info; - &url.pecl.package;gearman - - -
- diff --git a/reference/gearman/constants.xml b/reference/gearman/constants.xml deleted file mode 100644 index 0d72d7e4a133..000000000000 --- a/reference/gearman/constants.xml +++ /dev/null @@ -1,580 +0,0 @@ - - - - &reftitle.constants; - &extension.constants; - - Return values. Always check GearmanClient::error or - GearmanWorker for a string error, as it may contain - more details: - - - - - GEARMAN_SUCCESS - (int) - - - - Whatever action was taken was successful. - - - - - - GEARMAN_IO_WAIT - (int) - - - - When in non-blocking mode, an event is hit that would have blocked. - - - - - - GEARMAN_ERRNO - (int) - - - - A system error. Check GearmanClient::errno or - GearmanWorker::errno for the system error code that - was returned. - - - - - - GEARMAN_NO_ACTIVE_FDS - (int) - - - - GearmanClient::wait or GearmanWorker was - called with no connections. - - - - - - GEARMAN_UNEXPECTED_PACKET - (int) - - - - Indicates something going very wrong in gearmand. Applies only to - GearmanWorker. - - - - - - GEARMAN_GETADDRINFO - (int) - - - - DNS resolution failed (invalid host, port, etc). - - - - - - GEARMAN_NO_SERVERS - (int) - - - - Did not call GearmanClient::addServer before submitting jobs - or tasks. - - - - - - GEARMAN_LOST_CONNECTION - (int) - - - - Lost a connection during a request. - - - - - - GEARMAN_MEMORY_ALLOCATION_FAILURE - (int) - - - - Memory allocation failed (ran out of memory). - - - - - - GEARMAN_SERVER_ERROR - (int) - - - - Something went wrong in the Gearman server and it could not handle the - request gracefully. - - - - - - GEARMAN_WORK_DATA - (int) - - - - Notice return code obtained with GearmanClient::returnCode - when using GearmanClient::do. Sent to update the client - with data from a running job. A worker uses this when it needs to send updates, - send partial results, or flush data during long running jobs. - - - - - - GEARMAN_WORK_WARNING - (int) - - - - Notice return code obtained with GearmanClient::returnCode - when using GearmanClient::do. Updates the client with - a warning. The behavior is just like GEARMAN_WORK_DATA, but - should be treated as a warning instead of normal response data. - - - - - - GEARMAN_WORK_STATUS - (int) - - - - Notice return code obtained with GearmanClient::returnCode - when using GearmanClient::do. Sent to update the status - of a long running job. Use GearmanClient::doStatus to obtain - the percentage complete of the task. - - - - - - GEARMAN_WORK_EXCEPTION - (int) - - - - Notice return code obtained with GearmanClient::returnCode - when using GearmanClient::do. Indicates that a job failed - with a given exception. - - - - - - GEARMAN_WORK_FAIL - (int) - - - - Notice return code obtained with GearmanClient::returnCode - when using GearmanClient::do. Indicates that the job failed. - - - - - - GEARMAN_COULD_NOT_CONNECT - (int) - - - - Failed to connect to servers. - - - - - - GEARMAN_INVALID_FUNCTION_NAME - (int) - - - - Trying to register a function name of NULL or using the callback interface - without specifying callbacks. - - - - - - GEARMAN_INVALID_WORKER_FUNCTION - (int) - - - - Trying to register a function with a NULL callback function. - - - - - - GEARMAN_NO_REGISTERED_FUNCTIONS - (int) - - - - When a worker gets a job for a function it did not register. - - - - - - GEARMAN_NO_JOBS - (int) - - - - For a non-blocking worker, when GearmanWorker::work does not have - any active jobs. - - - - - - GEARMAN_ECHO_DATA_CORRUPTION - (int) - - - - After GearmanClient::echo or GearmanWorker::echo - the data returned doesn't match the data sent. - - - - - - GEARMAN_NEED_WORKLOAD_FN - (int) - - - - When the client opted to stream the workload of a task, but did not - specify a workload callback function. - - - - - - GEARMAN_PAUSE - (int) - - - - For the non-blocking client task interface, can be returned from the task callback - to "pause" the call and return from GearmanClient::runTasks. - Call GearmanClient::runTasks again to continue. - - - - - - GEARMAN_UNKNOWN_STATE - (int) - - - - Internal client/worker state error. - - - - - - GEARMAN_SEND_BUFFER_TOO_SMALL - (int) - - - - Internal error: trying to flush more data in one atomic chunk than is possible - due to hard-coded buffer sizes. - - - - - - GEARMAN_TIMEOUT - (int) - - - - Hit the timeout limit set by the client/worker. - - - - - - - GearmanClient options: - - - - - GEARMAN_CLIENT_GENERATE_UNIQUE - (int) - - - - Generate a unique id (UUID) for each task. - - - - - - GEARMAN_CLIENT_NON_BLOCKING - (int) - - - - Run the cient in a non-blocking mode. - - - - - - GEARMAN_CLIENT_UNBUFFERED_RESULT - (int) - - - - Allow the client to read data in chunks rather than have the library - buffer the entire data result and pass that back. - - - - - - GEARMAN_CLIENT_FREE_TASKS - (int) - - - - Automatically free task objects once they are complete. This is the default - setting in this extension to prevent memory leaks. - - - - - - - GearmanWorker options: - - - - - GEARMAN_WORKER_NON_BLOCKING - (int) - - - - Run the worker in non-blocking mode. - - - - - - GEARMAN_WORKER_GRAB_UNIQ - (int) - - - - Return the client assigned unique ID in addition to the job handle. - - - - - - - Base Gearman configuration: - - - - - GEARMAN_DEFAULT_TCP_HOST - (string) - - - - - - - - - GEARMAN_DEFAULT_TCP_PORT - (int) - - - - - - - - - GEARMAN_DEFAULT_SOCKET_TIMEOUT - (int) - - - - - - - - - GEARMAN_DEFAULT_SOCKET_SEND_SIZE - (int) - - - - - - - - - GEARMAN_DEFAULT_SOCKET_RECV_SIZE - (int) - - - - - - - - - GEARMAN_MAX_ERROR_SIZE - (int) - - - - - - - - - GEARMAN_PACKET_HEADER_SIZE - (int) - - - - - - - - - GEARMAN_JOB_HANDLE_SIZE - (int) - - - - - - - - - GEARMAN_OPTION_SIZE - (int) - - - - - - - - - GEARMAN_UNIQUE_SIZE - (int) - - - - - - - - - GEARMAN_MAX_COMMAND_ARGS - (int) - - - - - - - - - GEARMAN_ARGS_BUFFER_SIZE - (int) - - - - - - - - - GEARMAN_SEND_BUFFER_SIZE - (int) - - - - - - - - - GEARMAN_RECV_BUFFER_SIZE - (int) - - - - - - - - - GEARMAN_WORKER_WAIT_TIMEOUT - (int) - - - - - - - - - diff --git a/reference/gearman/examples.xml b/reference/gearman/examples.xml deleted file mode 100644 index 0d0e7a157d13..000000000000 --- a/reference/gearman/examples.xml +++ /dev/null @@ -1,469 +0,0 @@ - - - - &reftitle.examples; -
- Basic usage - - Basic Gearman client and worker - - This example shows a very simple client and worker. The client sends a string - to the job server, and the worker reverses the string and sends it back. - The job is performed synchronously. - - -addServer(); - -echo "Sending job\n"; - -# Send reverse job -do -{ - $result = $gmclient->doNormal("reverse", "Hello!"); - - # Check for various return packets and errors. - switch($gmclient->returnCode()) - { - case GEARMAN_WORK_DATA: - echo "Data: $result\n"; - break; - case GEARMAN_WORK_STATUS: - list($numerator, $denominator)= $gmclient->doStatus(); - echo "Status: $numerator/$denominator complete\n"; - break; - case GEARMAN_WORK_FAIL: - echo "Failed\n"; - exit; - case GEARMAN_SUCCESS: - echo "Success: $result\n"; - break; - default: - echo "RET: " . $gmclient->returnCode() . "\n"; - exit; - } -} -while($gmclient->returnCode() != GEARMAN_SUCCESS); - -?> -]]> - - -addServer(); - -# Register function "reverse" with the server. Change the worker function to -# "reverse_fn_fast" for a faster worker with no output. -$gmworker->addFunction("reverse", "reverse_fn"); - -print "Waiting for job...\n"; -while($gmworker->work()) -{ - if ($gmworker->returnCode() != GEARMAN_SUCCESS) - { - echo "return_code: " . $gmworker->returnCode() . "\n"; - break; - } -} - -function reverse_fn($job) -{ - echo "Received job: " . $job->handle() . "\n"; - - $workload = $job->workload(); - $workload_size = $job->workloadSize(); - - echo "Workload: $workload ($workload_size)\n"; - - # This status loop is not needed, just showing how it works - for ($x= 0; $x < $workload_size; $x++) - { - echo "Sending status: " . ($x + 1) . "/$workload_size complete\n"; - $job->sendStatus($x, $workload_size); - sleep(1); - } - - $result= strrev($workload); - echo "Result: $result\n"; - - # Return what we want to send back to the client. - return $result; -} - -# A much simpler and less verbose version of the above function would be: -function reverse_fn_fast($job) -{ - return strrev($job->workload()); -} - -?> -]]> - - &example.outputs.similar; - - - - - - - -
-
- Basic Gearman client and worker, background - - Basic Gearman client and worker, background - - This example shows a very simple client and worker. The client sends a string - to the job server as a background job, and the worker reverses the string. - Note that since the work is performed asynchronously, the client does not - wait for the job to complete and exits (and hence the client never receives the results). - - -addServer(); - -# run reverse client in the background -$job_handle = $gmclient->doBackground("reverse", "this is a test"); - -if ($gmclient->returnCode() != GEARMAN_SUCCESS) -{ - echo "bad return code\n"; - exit; -} - -echo "done!\n"; - -?> -]]> - - -addServer(); - -# Register function "reverse" with the server. Change the worker function to -# "reverse_fn_fast" for a faster worker with no output. -$gmworker->addFunction("reverse", "reverse_fn"); - -print "Waiting for job...\n"; -while($gmworker->work()) -{ - if ($gmworker->returnCode() != GEARMAN_SUCCESS) - { - echo "return_code: " . $gmworker->returnCode() . "\n"; - break; - } -} - -function reverse_fn($job) -{ - echo "Received job: " . $job->handle() . "\n"; - - $workload = $job->workload(); - $workload_size = $job->workloadSize(); - - echo "Workload: $workload ($workload_size)\n"; - - # This status loop is not needed, just showing how it works - for ($x= 0; $x < $workload_size; $x++) - { - echo "Sending status: " . ($x + 1) . "/$workload_size complete\n"; - $job->sendStatus($x, $workload_size); - sleep(1); - } - - $result= strrev($workload); - echo "Result: $result\n"; - - # Return what we want to send back to the client. - return $result; -} - -# A much simpler and less verbose version of the above function would be: -function reverse_fn_fast($job) -{ - return strrev($job->workload()); -} - -?> -]]> - - &example.outputs.similar; - - - - - - - -
-
- Basic Gearman client and worker, submitting tasks - - Basic Gearman client and worker, submitting tasks - - In this example, the basic reverse client extended to run two tasks in parallel. - The reverse worker is unchanged except to add sending of data back during processing. - - -addServer(); - -# register some callbacks -$gmc->setCreatedCallback("reverse_created"); -$gmc->setDataCallback("reverse_data"); -$gmc->setStatusCallback("reverse_status"); -$gmc->setCompleteCallback("reverse_complete"); -$gmc->setFailCallback("reverse_fail"); - -# set some arbitrary application data -$data['foo'] = 'bar'; - -# add two tasks -$task= $gmc->addTask("reverse", "foo", $data); -$task2= $gmc->addTaskLow("reverse", "bar", NULL); - -# run the tasks in parallel (assuming multiple workers) -if (! $gmc->runTasks()) -{ - echo "ERROR " . $gmc->error() . "\n"; - exit; -} - -echo "DONE\n"; - -function reverse_created($task) -{ - echo "CREATED: " . $task->jobHandle() . "\n"; -} - -function reverse_status($task) -{ - echo "STATUS: " . $task->jobHandle() . " - " . $task->taskNumerator() . - "/" . $task->taskDenominator() . "\n"; -} - -function reverse_complete($task) -{ - echo "COMPLETE: " . $task->jobHandle() . ", " . $task->data() . "\n"; -} - -function reverse_fail($task) -{ - echo "FAILED: " . $task->jobHandle() . "\n"; -} - -function reverse_data($task) -{ - echo "DATA: " . $task->data() . "\n"; -} - -?> -]]> - - -addServer(); - -# Register function "reverse" with the server. Change the worker function to -# "reverse_fn_fast" for a faster worker with no output. -$gmworker->addFunction("reverse", "reverse_fn"); - -print "Waiting for job...\n"; -while($gmworker->work()) -{ - if ($gmworker->returnCode() != GEARMAN_SUCCESS) - { - echo "return_code: " . $gmworker->returnCode() . "\n"; - break; - } -} - -function reverse_fn($job) -{ - echo "Received job: " . $job->handle() . "\n"; - - $workload = $job->workload(); - $workload_size = $job->workloadSize(); - - echo "Workload: $workload ($workload_size)\n"; - - # This status loop is not needed, just showing how it works - for ($x= 0; $x < $workload_size; $x++) - { - echo "Sending status: " . ($x + 1) . "/$workload_size complete\n"; - $job->sendStatus($x+1, $workload_size); - $job->sendData(substr($workload, $x, 1)); - sleep(1); - } - - $result= strrev($workload); - echo "Result: $result\n"; - - # Return what we want to send back to the client. - return $result; -} - -# A much simpler and less verbose version of the above function would be: -function reverse_fn_fast($job) -{ - return strrev($job->workload()); -} - -?> -]]> - - &example.outputs.similar; - - - - - - - -
-
- diff --git a/reference/gearman/gearmanclient.xml b/reference/gearman/gearmanclient.xml deleted file mode 100644 index 778ca848feef..000000000000 --- a/reference/gearman/gearmanclient.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - The GearmanClient class - GearmanClient - - - - -
- &reftitle.intro; - - Represents a class for connecting to a Gearman job server and making requests to perform - some function on provided data. The function performed must be one registered by a Gearman - worker and the data passed is opaque to the job server. - -
- - -
- &reftitle.classsynopsis; - - - - - GearmanClient - - - &Methods; - - - - - -
- -
- - &reference.gearman.entities.gearmanclient; - -
- diff --git a/reference/gearman/gearmanclient/addoptions.xml b/reference/gearman/gearmanclient/addoptions.xml deleted file mode 100644 index 8039ef67c2f6..000000000000 --- a/reference/gearman/gearmanclient/addoptions.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - GearmanClient::addOptions - Add client options - - - - &reftitle.description; - - public boolGearmanClient::addOptions - intoption - - - Adds one or more options to those already set. - - - - - &reftitle.parameters; - - - option - - - The options to add. - One of the following constants, or a combination of - them using the bitwise OR operator (|): - GEARMAN_CLIENT_GENERATE_UNIQUE, - GEARMAN_CLIENT_NON_BLOCKING, - GEARMAN_CLIENT_UNBUFFERED_RESULT or - GEARMAN_CLIENT_FREE_TASKS. - - - - - - - - &reftitle.returnvalues; - - Always returns &true;. - - - - - diff --git a/reference/gearman/gearmanclient/addserver.xml b/reference/gearman/gearmanclient/addserver.xml deleted file mode 100644 index 9a3ada52174e..000000000000 --- a/reference/gearman/gearmanclient/addserver.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - GearmanClient::addServer - Add a job server to the client - - - - &reftitle.description; - - public boolGearmanClient::addServer - stringhost&null; - intport0 - boolsetupExceptionHandler&true; - - - Adds a job server to a list of servers that can be used to run a task. No socket - I/O happens here; the server is simply added to the list. - - - - - - &reftitle.parameters; - - - host - - - &gearman.parameter.host; - - - - - port - - - &gearman.parameter.port; - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Adding two job servers - -addServer("10.0.0.1"); -$gmclient->addServer("10.0.0.2", 7003); - -?> -]]> - - - - - - &reftitle.seealso; - - GearmanClient::addServers - - - - - diff --git a/reference/gearman/gearmanclient/addservers.xml b/reference/gearman/gearmanclient/addservers.xml deleted file mode 100644 index e2b173c4555c..000000000000 --- a/reference/gearman/gearmanclient/addservers.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - GearmanClient::addServers - Add a list of job servers to the client - - - - &reftitle.description; - - public boolGearmanClient::addServers - stringservers&null; - boolsetupExceptionHandler&true; - - - Adds a list of job servers that can be used to run a task. No socket I/O happens here; - the servers are simply added to the full list of servers. - - - - - - &reftitle.parameters; - - - servers - - - A comma-separated list of servers, each server specified in the format 'host:port'. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Add two job servers - -addServers("10.0.0.1,10.0.0.2:7003"); - -?> -]]> - - - - - - &reftitle.seealso; - - GearmanClient::addServer - - - - - diff --git a/reference/gearman/gearmanclient/addtask.xml b/reference/gearman/gearmanclient/addtask.xml deleted file mode 100644 index 13320269a24d..000000000000 --- a/reference/gearman/gearmanclient/addtask.xml +++ /dev/null @@ -1,189 +0,0 @@ - - - - - GearmanClient::addTask - Add a task to be run in parallel - - - - &reftitle.description; - - public GearmanTaskfalseGearmanClient::addTask - stringfunction_name - stringintfloatworkload - mixedcontext&null; - stringnullunique_key&null; - - - Adds a task to be run in parallel with other tasks. Call this method for all the tasks - to be run in parallel, then call GearmanClient::runTasks to - perform the work. Note that enough workers need to be available for the tasks to all - run in parallel. - - - - - &reftitle.parameters; - - - function_name - - - &gearman.parameter.functionname; - - - - - workload - - - &gearman.parameter.workload; - - - - - context - - - &gearman.parameter.context; - - - - - unique_key - - - &gearman.parameter.unique; - - - - - - - - &reftitle.returnvalues; - - A GearmanTask object or &false; if the task could not be added. - - - - - &reftitle.examples; - - - Basic submission of two tasks - -addServer(); - -# set a function to be called when the work is complete -$gmclient->setCompleteCallback("complete"); - -# add a task to perform the "reverse" function on the string "Hello World!" -$gmclient->addTask("reverse", "Hello World!", null, "1"); - -# add another task to perform the "reverse" function on the string "!dlroW olleH" -$gmclient->addTask("reverse", "!dlroW olleH", null, "2"); - -# run the tasks -$gmclient->runTasks(); - -function complete($task) -{ - print "COMPLETE: " . $task->unique() . ", " . $task->data() . "\n"; -} - -?> -]]> - - &example.outputs.similar; - - - - - - Basic submission of two tasks with passing application context - -addServer(); - -# set a function to be called when the work is complete -$client->setCompleteCallback("reverse_complete"); - -# Add some tasks for a placeholder of where to put the results -$results = array(); -$client->addTask("reverse", "Hello World!", $results, "t1"); -$client->addTask("reverse", "!dlroW olleH", $results, "t2"); - -$client->runTasks(); - -# The results should now be filled in from the callbacks -foreach ($results as $id => $result) - echo $id . ": " . $result['handle'] . ", " . $result['data'] . "\n"; - - -function reverse_complete($task, $results) -{ - $results[$task->unique()] = array("handle"=>$task->jobHandle(), "data"=>$task->data()); -} - -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - GearmanClient::addTaskHigh - GearmanClient::addTaskLow - GearmanClient::addTaskBackground - GearmanClient::addTaskHighBackground - GearmanClient::addTaskLowBackground - GearmanClient::runTasks - - - - - diff --git a/reference/gearman/gearmanclient/addtaskbackground.xml b/reference/gearman/gearmanclient/addtaskbackground.xml deleted file mode 100644 index 63549ceb7ed4..000000000000 --- a/reference/gearman/gearmanclient/addtaskbackground.xml +++ /dev/null @@ -1,275 +0,0 @@ - - - - - GearmanClient::addTaskBackground - Add a background task to be run in parallel - - - - &reftitle.description; - - public GearmanTaskfalseGearmanClient::addTaskBackground - stringfunction_name - stringintfloatworkload - mixedcontext&null; - stringnullunique_key&null; - - - Adds a background task to be run in parallel with other tasks. Call this method for all the tasks - to be run in parallel, then call GearmanClient::runTasks to - perform the work. - - - - - &reftitle.parameters; - - - function_name - - - &gearman.parameter.functionname; - - - - - workload - - - &gearman.parameter.workload; - - - - - context - - - &gearman.parameter.context; - - - - - unique_key - - - &gearman.parameter.unique; - - - - - - - - &reftitle.returnvalues; - - A GearmanTask object or &false; if the task could not be added. - - - - - &reftitle.examples; - - Two tasks, one background and one not - - This example illustrates the difference between running a background task - and a normal task. The client adds two tasks to execute the same function, - but one is added with addTaskBackground. A callback is - set so that progress of the job can be tracked. A simple worker with an - artificial delay reports on the job progress and the client picks this up - through the callback. Two workers are run for this example. Note that the - background task does not show in the client output. - - -addServer(); - -# set a couple of callbacks so we can track progress -$gmc->setCompleteCallback("reverse_complete"); -$gmc->setStatusCallback("reverse_status"); - -# add a task for the "reverse" function -$task= $gmc->addTask("reverse", "Hello World!", null, "1"); - -# add another task, but this one to run in the background -$task= $gmc->addTaskBackground("reverse", "!dlroW olleH", null, "2"); - -if (! $gmc->runTasks()) -{ - echo "ERROR " . $gmc->error() . "\n"; - exit; -} - -echo "DONE\n"; - -function reverse_status($task) -{ - echo "STATUS: " . $task->unique() . ", " . $task->jobHandle() . " - " . $task->taskNumerator() . - "/" . $task->taskDenominator() . "\n"; -} - -function reverse_complete($task) -{ - echo "COMPLETE: " . $task->unique() . ", " . $task->data() . "\n"; -} - -?> -]]> - - -addServer(); - -# Register function "reverse" with the server. -$gmworker->addFunction("reverse", "reverse_fn"); - -print "Waiting for job...\n"; -while($gmworker->work()) -{ - if ($gmworker->returnCode() != GEARMAN_SUCCESS) - { - echo "return_code: " . $gmworker->returnCode() . "\n"; - break; - } -} - -function reverse_fn($job) -{ - echo "Received job: " . $job->handle() . "\n"; - - $workload = $job->workload(); - $workload_size = $job->workloadSize(); - - echo "Workload: $workload ($workload_size)\n"; - - # This status loop is not needed, just showing how it works - for ($x= 0; $x < $workload_size; $x++) - { - echo "Sending status: " . ($x + 1) . "/$workload_size complete\n"; - $job->sendStatus($x+1, $workload_size); - $job->sendData(substr($workload, $x, 1)); - sleep(1); - } - - $result= strrev($workload); - echo "Result: $result\n"; - - # Return what we want to send back to the client. - return $result; -} - -?> -]]> - - - Worker output for two workers running: - - - - - - Client output: - - - - - - - - - &reftitle.seealso; - - GearmanClient::addTask - GearmanClient::addTaskHigh - GearmanClient::addTaskLow - GearmanClient::addTaskHighBackground - GearmanClient::addTaskLowBackground - GearmanClient::runTasks - - - - - diff --git a/reference/gearman/gearmanclient/addtaskhigh.xml b/reference/gearman/gearmanclient/addtaskhigh.xml deleted file mode 100644 index db6b7527685e..000000000000 --- a/reference/gearman/gearmanclient/addtaskhigh.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - GearmanClient::addTaskHigh - Add a high priority task to run in parallel - - - - &reftitle.description; - - public GearmanTaskfalseGearmanClient::addTaskHigh - stringfunction_name - stringintfloatworkload - mixedcontext&null; - stringnullunique_key&null; - - - Adds a high priority task to be run in parallel with other tasks. Call this method for all - the high priority tasks to be run in parallel, then call - GearmanClient::runTasks to perform the work. Tasks with a high - priority will be selected from the queue before those of normal or low priority. - - - - - &reftitle.parameters; - - - function_name - - - &gearman.parameter.functionname; - - - - - workload - - - &gearman.parameter.workload; - - - - - context - - - &gearman.parameter.context; - - - - - unique_key - - - &gearman.parameter.unique; - - - - - - - - &reftitle.returnvalues; - - A GearmanTask object or &false; if the task could not be added. - - - - - &reftitle.examples; - - A high priority task along with two normal tasks - - A high priority task is included among two other tasks. A single worker - is available, so that tasks are run one at a time, with the high priority - task run first. - - -addServer(); - -# set the callback for when the job is complete -$gmc->setCompleteCallback("reverse_complete"); - -# add tasks, one of which is high priority -$task= $gmc->addTask("reverse", "Hello World!", null, "1"); -$task= $gmc->addTaskHigh("reverse", "!dlroW olleH", null, "2"); -$task= $gmc->addTask("reverse", "Hello World!", null, "3"); - -if (! $gmc->runTasks()) -{ - echo "ERROR " . $gmc->error() . "\n"; - exit; -} -echo "DONE\n"; - -function reverse_complete($task) -{ - echo "COMPLETE: " . $task->unique() . ", " . $task->data() . "\n"; -} - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - GearmanClient::addTask - GearmanClient::addTaskLow - GearmanClient::addTaskBackground - GearmanClient::addTaskHighBackground - GearmanClient::addTaskLowBackground - GearmanClient::runTasks - - - - - diff --git a/reference/gearman/gearmanclient/addtaskhighbackground.xml b/reference/gearman/gearmanclient/addtaskhighbackground.xml deleted file mode 100644 index fe7c877cddf9..000000000000 --- a/reference/gearman/gearmanclient/addtaskhighbackground.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - GearmanClient::addTaskHighBackground - Add a high priority background task to be run in parallel - - - - &reftitle.description; - - public GearmanTaskfalseGearmanClient::addTaskHighBackground - stringfunction_name - stringintfloatworkload - mixedcontext&null; - stringnullunique_key&null; - - - Adds a high priority background task to be run in parallel with other tasks. - Call this method for all the tasks to be run in parallel, then call - GearmanClient::runTasks to perform the work. Tasks with a high - priority will be selected from the queue before those of normal or low priority. - - - - - &reftitle.parameters; - - - function_name - - - &gearman.parameter.functionname; - - - - - workload - - - &gearman.parameter.workload; - - - - - context - - - &gearman.parameter.context; - - - - - unique_key - - - &gearman.parameter.unique; - - - - - - - - &reftitle.returnvalues; - - A GearmanTask object or &false; if the task could not be added. - - - - - &reftitle.seealso; - - GearmanClient::addTask - GearmanClient::addTaskHigh - GearmanClient::addTaskLow - GearmanClient::addTaskBackground - GearmanClient::addTaskLowBackground - GearmanClient::runTasks - - - - - diff --git a/reference/gearman/gearmanclient/addtasklow.xml b/reference/gearman/gearmanclient/addtasklow.xml deleted file mode 100644 index 90d168b96742..000000000000 --- a/reference/gearman/gearmanclient/addtasklow.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - GearmanClient::addTaskLow - Add a low priority task to run in parallel - - - - &reftitle.description; - - public GearmanTaskfalseGearmanClient::addTaskLow - stringfunction_name - stringintfloatworkload - mixedcontext&null; - stringnullunique_key&null; - - - Adds a low priority background task to be run in parallel with other tasks. - Call this method for all the tasks to be run in parallel, then call - GearmanClient::runTasks to perform the work. Tasks with a low - priority will be selected from the queue after those of normal or low priority. - - - - - &reftitle.parameters; - - - function_name - - - &gearman.parameter.functionname; - - - - - workload - - - &gearman.parameter.workload; - - - - - context - - - &gearman.parameter.context; - - - - - unique_key - - - &gearman.parameter.unique; - - - - - - - - &reftitle.returnvalues; - - A GearmanTask object or &false; if the task could not be added. - - - - - &reftitle.examples; - - A low priority task along with two normal tasks - - A low priority task is included among two other tasks. A single worker - is available, so that tasks are run one at a time, with the low priority - task run last. - - -addServer(); - -# set the callback for when the job is complete -$gmc->setCompleteCallback("reverse_complete"); - -# add tasks, one of which is low priority -$task= $gmc->addTask("reverse", "Hello World!", null, "1"); -$task= $gmc->addTaskLow("reverse", "!dlroW olleH", null, "2"); -$task= $gmc->addTask("reverse", "Hello World!", null, "3"); - -if (! $gmc->runTasks()) -{ - echo "ERROR " . $gmc->error() . "\n"; - exit; -} -echo "DONE\n"; - -function reverse_complete($task) -{ - echo "COMPLETE: " . $task->unique() . ", " . $task->data() . "\n"; -} - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - GearmanClient::addTask - GearmanClient::addTaskHigh - GearmanClient::addTaskBackground - GearmanClient::addTaskHighBackground - GearmanClient::addTaskLowBackground - GearmanClient::runTasks - - - - - diff --git a/reference/gearman/gearmanclient/addtasklowbackground.xml b/reference/gearman/gearmanclient/addtasklowbackground.xml deleted file mode 100644 index 808735094098..000000000000 --- a/reference/gearman/gearmanclient/addtasklowbackground.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - GearmanClient::addTaskLowBackground - Add a low priority background task to be run in parallel - - - - &reftitle.description; - - public GearmanTaskfalseGearmanClient::addTaskLowBackground - stringfunction_name - stringintfloatworkload - mixedcontext&null; - stringnullunique_key&null; - - - Adds a low priority background task to be run in parallel with other tasks. - Call this method for all the tasks to be run in parallel, then call - GearmanClient::runTasks to perform the work. Tasks with a low - priority will be selected from the queue after those of normal or high priority. - - - - - &reftitle.parameters; - - - function_name - - - &gearman.parameter.functionname; - - - - - workload - - - &gearman.parameter.workload; - - - - - context - - - &gearman.parameter.context; - - - - - unique_key - - - &gearman.parameter.unique; - - - - - - - - &reftitle.returnvalues; - - A GearmanTask object or &false; if the task could not be added. - - - - - &reftitle.seealso; - - GearmanClient::addTask - GearmanClient::addTaskHigh - GearmanClient::addTaskLow - GearmanClient::addTaskBackground - GearmanClient::addTaskHighBackground - GearmanClient::runTasks - - - - - diff --git a/reference/gearman/gearmanclient/addtaskstatus.xml b/reference/gearman/gearmanclient/addtaskstatus.xml deleted file mode 100644 index effcff32352b..000000000000 --- a/reference/gearman/gearmanclient/addtaskstatus.xml +++ /dev/null @@ -1,159 +0,0 @@ - - - - - GearmanClient::addTaskStatus - Add a task to get status - - - - &reftitle.description; - - public GearmanTaskfalseGearmanClient::addTaskStatus - stringjob_handle - mixedcontext&null; - - - Used to request status information from the Gearman server, which will call the specified - status callback (set using GearmanClient::setStatusCallback). - - - - - &reftitle.parameters; - - - job_handle - - - The job handle for the task to get status for - - - - - context - - - Data to be passed to the status callback, generally a reference to an array or object - - - - - - - - &reftitle.returnvalues; - - A GearmanTask object or &false; on failure. - - - - - &reftitle.examples; - - Monitor completion of multiple background tasks - - An artificial delay is introduced in the worker in this example to simulate - a long running process. There is only one worker running for this example. - - -addServer(); - -/* start some background jobs and save the handles */ -$handles = array(); -$handles[0] = $gmclient->doBackground("reverse", "Hello World!"); -$handles[1] = $gmclient->doBackground("reverse", "!dlroW olleH"); - -$gmclient->setStatusCallback("reverse_status"); - -/* Poll the server to see when those background jobs finish; */ -/* a better method would be to use event callbacks */ -do -{ - /* Use the context variable to track how many tasks have completed */ - $done = 0; - $gmclient->addTaskStatus($handles[0], $done); - $gmclient->addTaskStatus($handles[1], $done); - $gmclient->runTasks(); - echo "Done: $done\n"; - sleep(1); -} -while ($done != 2); - -function reverse_status($task, $done) -{ - if (!$task->isKnown()) - $done++; -} - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - GearmanClient::setStatusCallback - - - - - diff --git a/reference/gearman/gearmanclient/clearcallbacks.xml b/reference/gearman/gearmanclient/clearcallbacks.xml deleted file mode 100644 index 114927ab1f37..000000000000 --- a/reference/gearman/gearmanclient/clearcallbacks.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - GearmanClient::clearCallbacks - Clear all task callback functions - - - - &reftitle.description; - - public boolGearmanClient::clearCallbacks - - - - Clears all the task callback functions that have previously been set. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Always returns &true;. - - - - - &reftitle.seealso; - - GearmanClient::setDataCallback - GearmanClient::setCompleteCallback - GearmanClient::setCreatedCallback - GearmanClient::setExceptionCallback - GearmanClient::setFailCallback - GearmanClient::setStatusCallback - GearmanClient::setWarningCallback - GearmanClient::setWorkloadCallback - - - - - diff --git a/reference/gearman/gearmanclient/clone.xml b/reference/gearman/gearmanclient/clone.xml deleted file mode 100644 index 7f592589516c..000000000000 --- a/reference/gearman/gearmanclient/clone.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - GearmanClient::clone - Create a copy of a GearmanClient object - - - - &reftitle.description; - - public GearmanClientGearmanClient::clone - - - - Creates a copy of a GearmanClient object. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A GearmanClient on success, &false; on failure. - - - - - diff --git a/reference/gearman/gearmanclient/construct.xml b/reference/gearman/gearmanclient/construct.xml deleted file mode 100644 index 8c7f01bc4688..000000000000 --- a/reference/gearman/gearmanclient/construct.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - GearmanClient::__construct - Create a GearmanClient instance - - - - &reftitle.description; - - public GearmanClient::__construct - - - - Creates a GearmanClient instance representing a client that connects to the - job server and submits tasks to complete. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A GearmanClient object. - - - - - &reftitle.seealso; - - GearmanClient::clone - - - - - diff --git a/reference/gearman/gearmanclient/context.xml b/reference/gearman/gearmanclient/context.xml deleted file mode 100644 index b9b1e5a6538f..000000000000 --- a/reference/gearman/gearmanclient/context.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - GearmanClient::context - Get the application context - - - - &reftitle.description; - - public stringGearmanClient::context - - - - Get the application context previously set with GearmanClient::setContext. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The same context data structure set with GearmanClient::setContext - - - - - &reftitle.seealso; - - GearmanClient::setContext - - - - - diff --git a/reference/gearman/gearmanclient/data.xml b/reference/gearman/gearmanclient/data.xml deleted file mode 100644 index 1cad9960ba55..000000000000 --- a/reference/gearman/gearmanclient/data.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - GearmanClient::data - Get the application data (deprecated) - - - - &reftitle.description; - - public stringGearmanClient::data - - - - Get the application data previously set with GearmanClient::setData. - - - - This method was replaced by GearmanClient::setContext in the - 0.6.0 release of the Gearman extension. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The same string data set with GearmanClient::setData - - - - - &reftitle.seealso; - - GearmanClient::setData - - - - - diff --git a/reference/gearman/gearmanclient/do.xml b/reference/gearman/gearmanclient/do.xml deleted file mode 100644 index dcc415469a03..000000000000 --- a/reference/gearman/gearmanclient/do.xml +++ /dev/null @@ -1,319 +0,0 @@ - - - - - GearmanClient::do - Run a single task and return a result [deprecated] - - - - &reftitle.description; - - public stringGearmanClient::do - stringfunction_name - stringworkload - stringunique - - - The GearmanClient::do method is deprecated as of - pecl/gearman 1.0.0. Use GearmanClient::doNormal. - - - - - &reftitle.parameters; - - - function_name - - - &gearman.parameter.functionname; - - - - - workload - - - &gearman.parameter.workload; - - - - - unique - - - &gearman.parameter.unique; - - - - - - - - &reftitle.returnvalues; - - A string representing the results of running a task. - - - - - &reftitle.examples; - - - Simple job submission with immediate return - -addServer(); - -echo "Sending job\n"; - -$result = $gmclient->doNormal("reverse", "Hello!"); - -echo "Success: $result\n"; - -?> -]]> - - -addServer(); - -# Register function "reverse" with the server. Change the worker function to -# "reverse_fn_fast" for a faster worker with no output. -$gmworker->addFunction("reverse", "reverse_fn"); - -print "Waiting for job...\n"; -while($gmworker->work()) -{ - if ($gmworker->returnCode() != GEARMAN_SUCCESS) - { - echo "return_code: " . $gmworker->returnCode() . "\n"; - break; - } -} - -function reverse_fn($job) -{ - return strrev($job->workload()); -} - -?> -]]> - - &example.outputs.similar; - - - - - - Submitting a job and retrieving incremental status - - A job is submitted and the script loops to retrieve status information. - The worker has an artificial delay which results in a long running job - and sends status and data as processing occurs. - Each subsequent call to GearmanClient::do - produces status information on the running job. - - -addServer(); - -echo "Sending job\n"; - -# Send reverse job -do -{ - $result = $gmclient->doNormal("reverse", "Hello!"); - # Check for various return packets and errors. - - switch($gmclient->returnCode()) - { - case GEARMAN_WORK_DATA: - echo "Data: $result\n"; - break; - case GEARMAN_WORK_STATUS: - list($numerator, $denominator)= $gmclient->doStatus(); - echo "Status: $numerator/$denominator complete\n"; - break; - case GEARMAN_WORK_FAIL: - echo "Failed\n"; - exit; - case GEARMAN_SUCCESS: - break; - default: - echo "RET: " . $gmclient->returnCode() . "\n"; - echo "Error: " . $gmclient->error() . "\n"; - echo "Errno: " . $gmclient->getErrno() . "\n"; - exit; - } -} -while($gmclient->returnCode() != GEARMAN_SUCCESS); - -echo "Success: $result\n"; - -?> -]]> - - -addServer(); - -# Register function "reverse" with the server. -$gmworker->addFunction("reverse", "reverse_fn"); - -print "Waiting for job...\n"; -while($gmworker->work()) -{ - if ($gmworker->returnCode() != GEARMAN_SUCCESS) - { - echo "return_code: " . $gmworker->returnCode() . "\n"; - break; - } -} - -function reverse_fn($job) -{ - echo "Received job: " . $job->handle() . "\n"; - - $workload = $job->workload(); - $workload_size = $job->workloadSize(); - - echo "Workload: $workload ($workload_size)\n"; - - # This status loop is not needed, just showing how it works - for ($x= 0; $x < $workload_size; $x++) - { - echo "Sending status: " + $x + 1 . "/$workload_size complete\n"; - $job->sendStatus($x+1, $workload_size); - $job->sendData(substr($workload, $x, 1)); - sleep(1); - } - - $result= strrev($workload); - echo "Result: $result\n"; - - # Return what we want to send back to the client. - return $result; -} - -?> -]]> - - &example.outputs.similar; - - Worker output: - - - - - - Client output: - - - - - - - - - - &reftitle.seealso; - - GearmanClient::doHigh - GearmanClient::doLow - GearmanClient::doBackground - GearmanClient::doHighBackground - GearmanClient::doLowBackground - - - - - diff --git a/reference/gearman/gearmanclient/dobackground.xml b/reference/gearman/gearmanclient/dobackground.xml deleted file mode 100644 index f2aae86ee357..000000000000 --- a/reference/gearman/gearmanclient/dobackground.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - GearmanClient::doBackground - Run a task in the background - - - - &reftitle.description; - - public stringGearmanClient::doBackground - stringfunction - stringworkload - stringnullunique&null; - - - Runs a task in the background, returning a job handle which can be used - to get the status of the running task. - - - - - &reftitle.parameters; - - - function - - - &gearman.parameter.functionname; - - - - - workload - - - &gearman.parameter.workload; - - - - - unique - - - &gearman.parameter.unique; - - - - - - - - &reftitle.returnvalues; - - The job handle for the submitted task. - - - - - &reftitle.examples; - - Submit and monitor a background job - - The worker in this example has an artificial delay introduced to mimic - a long running job. The client script periodically checks the status - of the running job. - - -addServer(); - -/* run reverse client */ -$job_handle = $gmclient->doBackground("reverse", "this is a test"); - -if ($gmclient->returnCode() != GEARMAN_SUCCESS) -{ - echo "bad return code\n"; - exit; -} - -$done = false; -do -{ - sleep(3); - $stat = $gmclient->jobStatus($job_handle); - if (!$stat[0]) // the job is known so it is not done - $done = true; - echo "Running: " . ($stat[1] ? "true" : "false") . ", numerator: " . $stat[2] . ", denominator: " . $stat[3] . "\n"; -} -while(!$done); - -echo "done!\n"; - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - GearmanClient::doNormal - GearmanClient::doHigh - GearmanClient::doLow - GearmanClient::doHighBackground - GearmanClient::doLowBackground - - - - - diff --git a/reference/gearman/gearmanclient/dohigh.xml b/reference/gearman/gearmanclient/dohigh.xml deleted file mode 100644 index 2952d132b2d3..000000000000 --- a/reference/gearman/gearmanclient/dohigh.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - GearmanClient::doHigh - Run a single high priority task - - - - &reftitle.description; - - public stringGearmanClient::doHigh - stringfunction - stringworkload - stringnullunique&null; - - - Runs a single high priority task and returns a string representation of the result. It is up to - the GearmanClient and GearmanWorker to - agree on the format of the result. High priority tasks will get precedence over normal - and low priority tasks in the job queue. - - - - - &reftitle.parameters; - - - function - - - &gearman.parameter.functionname; - - - - - workload - - - &gearman.parameter.workload; - - - - - unique - - - &gearman.parameter.unique; - - - - - - - - &reftitle.returnvalues; - - A string representing the results of running a task. - - - - - &reftitle.seealso; - - GearmanClient::doNormal - GearmanClient::doLow - GearmanClient::doBackground - GearmanClient::doHighBackground - GearmanClient::doLowBackground - - - - - diff --git a/reference/gearman/gearmanclient/dohighbackground.xml b/reference/gearman/gearmanclient/dohighbackground.xml deleted file mode 100644 index 57cb25dec4c0..000000000000 --- a/reference/gearman/gearmanclient/dohighbackground.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - GearmanClient::doHighBackground - Run a high priority task in the background - - - - &reftitle.description; - - public stringGearmanClient::doHighBackground - stringfunction - stringworkload - stringnullunique&null; - - - Runs a high priority task in the background, returning a job handle which can be used - to get the status of the running task. High priority tasks take precedence over normal - and low priority tasks in the job queue. - - - - - &reftitle.parameters; - - - function - - - &gearman.parameter.functionname; - - - - - workload - - - &gearman.parameter.workload; - - - - - unique - - - &gearman.parameter.unique; - - - - - - - - &reftitle.returnvalues; - - The job handle for the submitted task. - - - - - &reftitle.seealso; - - GearmanClient::doNormal - GearmanClient::doHigh - GearmanClient::doLow - GearmanClient::doBackground - GearmanClient::doLowBackground - - - - - diff --git a/reference/gearman/gearmanclient/dojobhandle.xml b/reference/gearman/gearmanclient/dojobhandle.xml deleted file mode 100644 index d0b5e063a02e..000000000000 --- a/reference/gearman/gearmanclient/dojobhandle.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - GearmanClient::doJobHandle - Get the job handle for the running task - - - - &reftitle.description; - - public stringGearmanClient::doJobHandle - - - - Gets that job handle for a running task. This should be used between repeated - GearmanClient::doNormal calls. The job handle can then be used - to get information on the task. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The job handle for the running task. - - - - - &reftitle.seealso; - - GearmanClient::jobStatus - - - - - diff --git a/reference/gearman/gearmanclient/dolow.xml b/reference/gearman/gearmanclient/dolow.xml deleted file mode 100644 index e2c7f8f1669e..000000000000 --- a/reference/gearman/gearmanclient/dolow.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - GearmanClient::doLow - Run a single low priority task - - - - &reftitle.description; - - public stringGearmanClient::doLow - stringfunction - stringworkload - stringnullunique&null; - - - Runs a single low priority task and returns a string representation of the result. It is up to - the GearmanClient and GearmanWorker to - agree on the format of the result. Normal and high priority tasks will get precedence over - low priority tasks in the job queue. - - - - - &reftitle.parameters; - - - function - - - &gearman.parameter.functionname; - - - - - workload - - - &gearman.parameter.workload; - - - - - unique - - - &gearman.parameter.unique; - - - - - - - - &reftitle.returnvalues; - - A string representing the results of running a task. - - - - - &reftitle.seealso; - - GearmanClient::doNormal - GearmanClient::doHigh - GearmanClient::doBackground - GearmanClient::doHighBackground - GearmanClient::doLowBackground - - - - - diff --git a/reference/gearman/gearmanclient/dolowbackground.xml b/reference/gearman/gearmanclient/dolowbackground.xml deleted file mode 100644 index a449213456d7..000000000000 --- a/reference/gearman/gearmanclient/dolowbackground.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - GearmanClient::doLowBackground - Run a low priority task in the background - - - - &reftitle.description; - - public stringGearmanClient::doLowBackground - stringfunction - stringworkload - stringnullunique&null; - - - Runs a low priority task in the background, returning a job handle which can be used - to get the status of the running task. Normal and high priority tasks take precedence over - low priority tasks in the job queue. - - - - - &reftitle.parameters; - - - function - - - &gearman.parameter.functionname; - - - - - workload - - - &gearman.parameter.workload; - - - - - unique - - - &gearman.parameter.unique; - - - - - - - - &reftitle.returnvalues; - - The job handle for the submitted task. - - - - - &reftitle.seealso; - - GearmanClient::doNormal - GearmanClient::doHigh - GearmanClient::doLow - GearmanClient::doBackground - GearmanClient::doHighBackground - - - - - diff --git a/reference/gearman/gearmanclient/donormal.xml b/reference/gearman/gearmanclient/donormal.xml deleted file mode 100644 index 7927f0be1793..000000000000 --- a/reference/gearman/gearmanclient/donormal.xml +++ /dev/null @@ -1,327 +0,0 @@ - - - - - GearmanClient::doNormal - Run a single task and return a result - - - - &reftitle.description; - - public stringGearmanClient::doNormal - stringfunction - stringworkload - stringnullunique&null; - - - Runs a single task and returns a string representation of the result. It is up to - the GearmanClient and GearmanWorker to - agree on the format of the result. - - - - - &reftitle.parameters; - - - function - - - &gearman.parameter.functionname; - - - - - workload - - - &gearman.parameter.workload; - - - - - unique - - - &gearman.parameter.unique; - - - - - - - - &reftitle.returnvalues; - - A string representing the results of running a task. - - - - - &reftitle.examples; - - - Simple job submission with immediate return - - -]]> - - -addServer(); - -echo "Sending job\n"; - -$result = $gmclient->doNormal("reverse", "Hello!"); - -echo "Success: $result\n"; - -?> -]]> - - -addServer(); - -# Register function "reverse" with the server. Change the worker function to -# "reverse_fn_fast" for a faster worker with no output. -$gmworker->addFunction("reverse", "reverse_fn"); - -print "Waiting for job...\n"; -while($gmworker->work()) -{ - if ($gmworker->returnCode() != GEARMAN_SUCCESS) - { - echo "return_code: " . $gmworker->returnCode() . "\n"; - break; - } -} - -function reverse_fn($job) -{ - return strrev($job->workload()); -} - -?> -]]> - - &example.outputs.similar; - - - - - - Submitting a job and retrieving incremental status - - A job is submitted and the script loops to retrieve status information. - The worker has an artificial delay which results in a long running job - and sends status and data as processing occurs. - Each subsequent call to GearmanClient::doNormal - produces status information on the running job. - - -addServer(); - -echo "Sending job\n"; - -# Send reverse job -do -{ - $result = $gmclient->doNormal("reverse", "Hello!"); - # Check for various return packets and errors. - - switch($gmclient->returnCode()) - { - case GEARMAN_WORK_DATA: - echo "Data: $result\n"; - break; - case GEARMAN_WORK_STATUS: - list($numerator, $denominator)= $gmclient->doStatus(); - echo "Status: $numerator/$denominator complete\n"; - break; - case GEARMAN_WORK_FAIL: - echo "Failed\n"; - exit; - case GEARMAN_SUCCESS: - break; - default: - echo "RET: " . $gmclient->returnCode() . "\n"; - echo "Error: " . $gmclient->error() . "\n"; - echo "Errno: " . $gmclient->getErrno() . "\n"; - exit; - } -} -while($gmclient->returnCode() != GEARMAN_SUCCESS); - -echo "Success: $result\n"; - -?> -]]> - - -addServer(); - -# Register function "reverse" with the server. -$gmworker->addFunction("reverse", "reverse_fn"); - -print "Waiting for job...\n"; -while($gmworker->work()) -{ - if ($gmworker->returnCode() != GEARMAN_SUCCESS) - { - echo "return_code: " . $gmworker->returnCode() . "\n"; - break; - } -} - -function reverse_fn($job) -{ - echo "Received job: " . $job->handle() . "\n"; - - $workload = $job->workload(); - $workload_size = $job->workloadSize(); - - echo "Workload: $workload ($workload_size)\n"; - - # This status loop is not needed, just showing how it works - for ($x= 0; $x < $workload_size; $x++) - { - echo "Sending status: " + $x + 1 . "/$workload_size complete\n"; - $job->sendStatus($x+1, $workload_size); - $job->sendData(substr($workload, $x, 1)); - sleep(1); - } - - $result= strrev($workload); - echo "Result: $result\n"; - - # Return what we want to send back to the client. - return $result; -} - -?> -]]> - - &example.outputs.similar; - - Worker output: - - - - - - Client output: - - - - - - - - - - &reftitle.seealso; - - GearmanClient::doHigh - GearmanClient::doLow - GearmanClient::doBackground - GearmanClient::doHighBackground - GearmanClient::doLowBackground - - - - - diff --git a/reference/gearman/gearmanclient/dostatus.xml b/reference/gearman/gearmanclient/dostatus.xml deleted file mode 100644 index 7cea79105271..000000000000 --- a/reference/gearman/gearmanclient/dostatus.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - GearmanClient::doStatus - Get the status for the running task - - - - &reftitle.description; - - public arrayGearmanClient::doStatus - - - - Returns the status for the running task. This should be used between repeated - GearmanClient::doNormal calls. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - An array representing the percentage completion given as a fraction, with the - first element the numerator and the second element the denomintor. - - - - - &reftitle.examples; - - Get the status of a long running job - - The worker in this example has an artificial delay added during processing of the - string to be reversed. After each delay it calls GearmanJob::status - which the client then picks up. - - -addServer(); - -echo "Sending job\n"; - -# Send reverse job -do -{ - $result = $gmclient->doNormal("reverse", "Hello!"); - - # Check for various return packets and errors. - switch($gmclient->returnCode()) - { - case GEARMAN_WORK_DATA: - break; - case GEARMAN_WORK_STATUS: - # get the current job status - list($numerator, $denominator)= $gmclient->doStatus(); - echo "Status: $numerator/$denominator complete\n"; - break; - case GEARMAN_WORK_FAIL: - echo "Failed\n"; - exit; - case GEARMAN_SUCCESS: - break; - default: - echo "RET: " . $gmclient->returnCode() . "\n"; - exit; - } -} -while($gmclient->returnCode() != GEARMAN_SUCCESS); - -echo "Success: $result\n"; - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - GearmanClient::doNormal - GearmanJob::status - - - - - diff --git a/reference/gearman/gearmanclient/echo.xml b/reference/gearman/gearmanclient/echo.xml deleted file mode 100644 index 8a0725deba57..000000000000 --- a/reference/gearman/gearmanclient/echo.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - GearmanClient::echo - Send data to all job servers to see if they echo it back [deprecated] - - - - &reftitle.description; - - public boolGearmanClient::echo - stringworkload - - - The GearmanClient::echo method is deprecated as of - pecl/gearman 1.0.0. Use GearmanClient::ping. - - - - - &reftitle.parameters; - - - workload - - - Some arbitrary serialized data to be echo back - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/gearman/gearmanclient/error.xml b/reference/gearman/gearmanclient/error.xml deleted file mode 100644 index 9b5fc5b1a82d..000000000000 --- a/reference/gearman/gearmanclient/error.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - GearmanClient::error - Returns an error string for the last error encountered - - - - &reftitle.description; - - public stringfalseGearmanClient::error - - - - Returns an error string for the last error encountered. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A human readable error string, or &false; if there is no error message available. - - - - - &reftitle.seealso; - - GearmanClient::getErrno - - - - - diff --git a/reference/gearman/gearmanclient/geterrno.xml b/reference/gearman/gearmanclient/geterrno.xml deleted file mode 100644 index ed05d4ae1a6f..000000000000 --- a/reference/gearman/gearmanclient/geterrno.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - GearmanClient::getErrno - Get an errno value - - - - &reftitle.description; - - public intGearmanClient::getErrno - - - - Value of errno in the case of a GEARMAN_ERRNO return value. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A valid Gearman errno. - - - - - &reftitle.seealso; - - GearmanClient::error - - - - - diff --git a/reference/gearman/gearmanclient/jobstatus.xml b/reference/gearman/gearmanclient/jobstatus.xml deleted file mode 100644 index 66361d1977a8..000000000000 --- a/reference/gearman/gearmanclient/jobstatus.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - GearmanClient::jobStatus - gearman_job_status - Get the status of a background job - - - - &reftitle.description; - &style.oop; (method): - - public arrayGearmanClient::jobStatus - stringjob_handle - - - Gets the status for a background job given a job handle. The status information will - specify whether the job is known, whether the job is currently running, and - the percentage completion. - - - - - &reftitle.parameters; - - - job_handle - - - &gearman.parameter.jobhandle; - - - - - - - - &reftitle.returnvalues; - - An array containing status information for the job corresponding to the supplied - job handle. The first array element is a boolean indicating whether the job is - even known, the second is a boolean indicating whether the job is still running, - and the third and fourth elements correspond to the numerator and denominator - of the fractional completion percentage, respectively. - - - - - &reftitle.examples; - - Monitor the status of a long running background job - -addServer(); - -/* run reverse client */ -$job_handle = $gmclient->doBackground("reverse", "this is a test"); - -if ($gmclient->returnCode() != GEARMAN_SUCCESS) -{ - echo "bad return code\n"; - exit; -} - -$done = false; -do -{ - sleep(3); - $stat = $gmclient->jobStatus($job_handle); - if (!$stat[0]) // the job is known so it is not done - $done = true; - echo "Running: " . ($stat[1] ? "true" : "false") . ", numerator: " . $stat[2] . ", denominator: " . $stat[3] . "\n"; -} -while(!$done); - -echo "done!\n"; - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - GearmanClient::doStatus - - - - - diff --git a/reference/gearman/gearmanclient/ping.xml b/reference/gearman/gearmanclient/ping.xml deleted file mode 100644 index 2e9c6e0396aa..000000000000 --- a/reference/gearman/gearmanclient/ping.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - GearmanClient::ping - Send data to all job servers to see if they echo it back - - - - &reftitle.description; - - public boolGearmanClient::ping - stringworkload - - - Sends some arbitrary data to all job servers to see if they echo it back. The data sent - is not used or processed in any other way. Primarily used for testing and debugging. - - - - - &reftitle.parameters; - - - workload - - - Some arbitrary serialized data to be echo back - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/gearman/gearmanclient/removeoptions.xml b/reference/gearman/gearmanclient/removeoptions.xml deleted file mode 100644 index 563cc33f7c3d..000000000000 --- a/reference/gearman/gearmanclient/removeoptions.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - GearmanClient::removeOptions - Remove client options - - - - &reftitle.description; - - public boolGearmanClient::removeOptions - intoption - - - Removes (unsets) one or more options. - - - - - &reftitle.parameters; - - - option - - - The options to be removed (unset) - - - - - - - - &reftitle.returnvalues; - - Always returns &true;. - - - - - diff --git a/reference/gearman/gearmanclient/returncode.xml b/reference/gearman/gearmanclient/returncode.xml deleted file mode 100644 index f2338fe14d74..000000000000 --- a/reference/gearman/gearmanclient/returncode.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - GearmanClient::returnCode - Get the last Gearman return code - - - - &reftitle.description; - - public intGearmanClient::returnCode - - - - Returns the last Gearman return code. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A valid Gearman return code. - - - - - diff --git a/reference/gearman/gearmanclient/runtasks.xml b/reference/gearman/gearmanclient/runtasks.xml deleted file mode 100644 index e402e0e1c585..000000000000 --- a/reference/gearman/gearmanclient/runtasks.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - GearmanClient::runTasks - Run a list of tasks in parallel - - - - &reftitle.description; - - public boolGearmanClient::runTasks - - - - For a set of tasks previously added with GearmanClient::addTask, - GearmanClient::addTaskHigh, GearmanClient::addTaskLow, - GearmanClient::addTaskBackground, GearmanClient::addTaskHighBackground, or - GearmanClient::addTaskLowBackground, this call starts running the tasks - in parallel. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanClient::addTask - - - - - diff --git a/reference/gearman/gearmanclient/setclientcallback.xml b/reference/gearman/gearmanclient/setclientcallback.xml deleted file mode 100644 index be7c5e0093ad..000000000000 --- a/reference/gearman/gearmanclient/setclientcallback.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - GearmanClient::setClientCallback - Callback function when there is a data packet for a task (deprecated) - - - - &reftitle.description; - - public voidGearmanClient::setClientCallback - callablecallback - - - Sets the callback function for accepting data packets for a task. - - - - This method has been replaced by GearmanClient::setDataCallback in - the 0.6.0 release of the Gearman extension. - - - &gearman.note.callback; - - - - &reftitle.parameters; - - &gearman.parameter.callback; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanClient::setCompleteCallback - GearmanClient::setCreatedCallback - GearmanClient::setDataCallback - GearmanClient::setExceptionCallback - GearmanClient::setFailCallback - GearmanClient::setStatusCallback - GearmanClient::setWarningCallback - GearmanClient::setWorkloadCallback - - - - - diff --git a/reference/gearman/gearmanclient/setcompletecallback.xml b/reference/gearman/gearmanclient/setcompletecallback.xml deleted file mode 100644 index 35526ecbf026..000000000000 --- a/reference/gearman/gearmanclient/setcompletecallback.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - GearmanClient::setCompleteCallback - Set a function to be called on task completion - - - - &reftitle.description; - - public boolGearmanClient::setCompleteCallback - callablecallback - - - Use to set a callback function to be called when a GearmanTask is completed, or - when GearmanJob::sendComplete is invoked by a worker (whichever happens - first). - - - This callback executes only when executing a GearmanTask using - GearmanClient::runTasks. It is not used for individual jobs. - - &gearman.note.callback; - - - - &reftitle.parameters; - - &gearman.parameter.callback; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanClient::setDataCallback - GearmanClient::setCreatedCallback - GearmanClient::setExceptionCallback - GearmanClient::setFailCallback - GearmanClient::setStatusCallback - GearmanClient::setWarningCallback - GearmanClient::setWorkloadCallback - - - - - diff --git a/reference/gearman/gearmanclient/setcontext.xml b/reference/gearman/gearmanclient/setcontext.xml deleted file mode 100644 index 80d9948083ad..000000000000 --- a/reference/gearman/gearmanclient/setcontext.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - GearmanClient::setContext - Set application context - - - - &reftitle.description; - - public boolGearmanClient::setContext - stringdata - - - Sets an arbitrary string to provide application context that can - later be retrieved by GearmanClient::context. - - - - - &reftitle.parameters; - - - data - - - Arbitrary context data - - - - - - - - &reftitle.returnvalues; - - Always returns &true;. - - - - - &reftitle.seealso; - - GearmanClient::context - - - - - diff --git a/reference/gearman/gearmanclient/setcreatedcallback.xml b/reference/gearman/gearmanclient/setcreatedcallback.xml deleted file mode 100644 index 2ee9194e1b9f..000000000000 --- a/reference/gearman/gearmanclient/setcreatedcallback.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - GearmanClient::setCreatedCallback - Set a callback for when a task is queued - - - - &reftitle.description; - - public boolGearmanClient::setCreatedCallback - callablecallback - - - Sets a callback function to be called when a task is received and queued by the Gearman job server. - - &gearman.note.callback; - - - - &reftitle.parameters; - - &gearman.parameter.callback; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanClient::setDataCallback - GearmanClient::setCompleteCallback - GearmanClient::setExceptionCallback - GearmanClient::setFailCallback - GearmanClient::setStatusCallback - GearmanClient::setWarningCallback - GearmanClient::setWorkloadCallback - - - - - diff --git a/reference/gearman/gearmanclient/setdata.xml b/reference/gearman/gearmanclient/setdata.xml deleted file mode 100644 index 8f003262c561..000000000000 --- a/reference/gearman/gearmanclient/setdata.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - GearmanClient::setData - Set application data (deprecated) - - - - &reftitle.description; - - public boolGearmanClient::setData - stringdata - - - Sets some arbitrary application data that can later be retrieved by - GearmanClient::data. - - - - This method has been replaced by GearmanClient::setContext in the - 0.6.0 release of the Gearman extension. - - - - - - &reftitle.parameters; - - - data - - - - - - - - - - &reftitle.returnvalues; - - Always returns &true;. - - - - - &reftitle.seealso; - - GearmanClient::data - - - - - diff --git a/reference/gearman/gearmanclient/setdatacallback.xml b/reference/gearman/gearmanclient/setdatacallback.xml deleted file mode 100644 index 2e8279365519..000000000000 --- a/reference/gearman/gearmanclient/setdatacallback.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - GearmanClient::setDataCallback - Callback function when there is a data packet for a task - - - - &reftitle.description; - - public boolGearmanClient::setDataCallback - callablecallback - - - Sets the callback function for accepting data packets for a task. - - &gearman.note.callback; - - - - &reftitle.parameters; - - &gearman.parameter.callback; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanClient::setCompleteCallback - GearmanClient::setCreatedCallback - GearmanClient::setExceptionCallback - GearmanClient::setFailCallback - GearmanClient::setStatusCallback - GearmanClient::setWarningCallback - GearmanClient::setWorkloadCallback - - - - - diff --git a/reference/gearman/gearmanclient/setexceptioncallback.xml b/reference/gearman/gearmanclient/setexceptioncallback.xml deleted file mode 100644 index 3bca216cd52b..000000000000 --- a/reference/gearman/gearmanclient/setexceptioncallback.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - GearmanClient::setExceptionCallback - Set a callback for worker exceptions - - - - &reftitle.description; - - public boolGearmanClient::setExceptionCallback - callablecallback - - - Specifies a callback function to call when a worker for a task sends an exception. - - &gearman.note.callback; - - - - &reftitle.parameters; - - &gearman.parameter.callback; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanClient::setDataCallback - GearmanClient::setCompleteCallback - GearmanClient::setCreatedCallback - GearmanClient::setFailCallback - GearmanClient::setStatusCallback - GearmanClient::setWarningCallback - GearmanClient::setWorkloadCallback - - - - - diff --git a/reference/gearman/gearmanclient/setfailcallback.xml b/reference/gearman/gearmanclient/setfailcallback.xml deleted file mode 100644 index 099c594cf1a5..000000000000 --- a/reference/gearman/gearmanclient/setfailcallback.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - GearmanClient::setFailCallback - Set callback for job failure - - - - &reftitle.description; - - public boolGearmanClient::setFailCallback - callablecallback - - - Sets the callback function to be used when a task does not complete successfully. - - &gearman.note.callback; - - - - &reftitle.parameters; - - &gearman.parameter.callback; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanClient::setDataCallback - GearmanClient::setCompleteCallback - GearmanClient::setCreatedCallback - GearmanClient::setExceptionCallback - GearmanClient::setStatusCallback - GearmanClient::setWarningCallback - GearmanClient::setWorkloadCallback - - - - - diff --git a/reference/gearman/gearmanclient/setoptions.xml b/reference/gearman/gearmanclient/setoptions.xml deleted file mode 100644 index fa9d8ef0599a..000000000000 --- a/reference/gearman/gearmanclient/setoptions.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - GearmanClient::setOptions - Set client options - - - - &reftitle.description; - - public boolGearmanClient::setOptions - intoption - - - Sets one or more client options. - - - - - &reftitle.parameters; - - - option - - - The options to be set - - - - - - - - &reftitle.returnvalues; - - Always returns &true;. - - - - - diff --git a/reference/gearman/gearmanclient/setstatuscallback.xml b/reference/gearman/gearmanclient/setstatuscallback.xml deleted file mode 100644 index 342802a92dff..000000000000 --- a/reference/gearman/gearmanclient/setstatuscallback.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - GearmanClient::setStatusCallback - Set a callback for collecting task status - - - - &reftitle.description; - - public boolGearmanClient::setStatusCallback - callablecallback - - - Sets a callback function used for getting updated status information from a worker. - - &gearman.note.callback; - - - - &reftitle.parameters; - - &gearman.parameter.callback; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanClient::setDataCallback - GearmanClient::setCompleteCallback - GearmanClient::setCreatedCallback - GearmanClient::setExceptionCallback - GearmanClient::setFailCallback - GearmanClient::setWarningCallback - GearmanClient::setWorkloadCallback - - - - - diff --git a/reference/gearman/gearmanclient/settimeout.xml b/reference/gearman/gearmanclient/settimeout.xml deleted file mode 100644 index 5cc7acb1f555..000000000000 --- a/reference/gearman/gearmanclient/settimeout.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - GearmanClient::setTimeout - Set socket I/O activity timeout - - - - &reftitle.description; - - public boolGearmanClient::setTimeout - inttimeout - - - Sets the timeout for socket I/O activity. - - - - - &reftitle.parameters; - - - timeout - - - An interval of time in milliseconds - - - - - - - - &reftitle.returnvalues; - - Always returns &true;. - - - - - diff --git a/reference/gearman/gearmanclient/setwarningcallback.xml b/reference/gearman/gearmanclient/setwarningcallback.xml deleted file mode 100644 index 68b9f3ec32a2..000000000000 --- a/reference/gearman/gearmanclient/setwarningcallback.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - GearmanClient::setWarningCallback - Set a callback for worker warnings - - - - &reftitle.description; - - public boolGearmanClient::setWarningCallback - callablecallback - - - Sets a callback function to be called when a worker sends a warning. - - &gearman.note.callback; - - - - &reftitle.parameters; - - &gearman.parameter.callback; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanClient::setDataCallback - GearmanClient::setCompleteCallback - GearmanClient::setCreatedCallback - GearmanClient::setExceptionCallback - GearmanClient::setFailCallback - GearmanClient::setStatusCallback - GearmanClient::setWorkloadCallback - - - - - diff --git a/reference/gearman/gearmanclient/setworkloadcallback.xml b/reference/gearman/gearmanclient/setworkloadcallback.xml deleted file mode 100644 index 41cf4aedb105..000000000000 --- a/reference/gearman/gearmanclient/setworkloadcallback.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - GearmanClient::setWorkloadCallback - Set a callback for accepting incremental data updates - - - - &reftitle.description; - - public boolGearmanClient::setWorkloadCallback - callablecallback - - - Sets a callback function to be called when a worker needs to send back data prior to job completion. - A worker can do this when it needs to send updates, send partial results, or flush data - during long running jobs. - - &gearman.note.callback; - - - - &reftitle.parameters; - - &gearman.parameter.callback; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanClient::setDataCallback - GearmanClient::setCompleteCallback - GearmanClient::setCreatedCallback - GearmanClient::setExceptionCallback - GearmanClient::setFailCallback - GearmanClient::setStatusCallback - GearmanClient::setWarningCallback - - - - - diff --git a/reference/gearman/gearmanclient/timeout.xml b/reference/gearman/gearmanclient/timeout.xml deleted file mode 100644 index 0ea97ef9d6e2..000000000000 --- a/reference/gearman/gearmanclient/timeout.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - GearmanClient::timeout - Get current socket I/O activity timeout value - - - - &reftitle.description; - - public intGearmanClient::timeout - - - - Returns the timeout in milliseconds to wait for I/O activity. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Timeout in milliseconds to wait for I/O activity. A negative value means an infinite timeout. - - - - - &reftitle.seealso; - - GearmanClient::setTimeout - - - - - diff --git a/reference/gearman/gearmanclient/wait.xml b/reference/gearman/gearmanclient/wait.xml deleted file mode 100644 index 79ff587ccc91..000000000000 --- a/reference/gearman/gearmanclient/wait.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - GearmanClient::wait - Wait for I/O activity on all connections in a client - - - - &reftitle.description; - - public boolGearmanClient::wait - - - - This waits for activity from any one of the connected servers. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; on success &false; on an error. - - - - - &reftitle.seealso; - - GearmanWorker::wait - - - - - diff --git a/reference/gearman/gearmanexception.xml b/reference/gearman/gearmanexception.xml deleted file mode 100644 index 937711b1e8fd..000000000000 --- a/reference/gearman/gearmanexception.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - The GearmanException class - GearmanException - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - - GearmanException - - - &InheritedProperties; - - - &Methods; - - - &InheritedMethods; - - - - - -
- - -
- -
- diff --git a/reference/gearman/gearmanjob.xml b/reference/gearman/gearmanjob.xml deleted file mode 100644 index e6809a1e11a1..000000000000 --- a/reference/gearman/gearmanjob.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - The GearmanJob class - GearmanJob - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - - GearmanJob - - - &Methods; - - - - -
- -
- - &reference.gearman.entities.gearmanjob; - -
- diff --git a/reference/gearman/gearmanjob/complete.xml b/reference/gearman/gearmanjob/complete.xml deleted file mode 100644 index 503f1492439f..000000000000 --- a/reference/gearman/gearmanjob/complete.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - GearmanJob::complete - Send the result and complete status (deprecated) - - - - &reftitle.description; - - public boolGearmanJob::complete - stringresult - - - Sends result data and the complete status update for this job. - - - - This method has been replaced by GearmanJob::sendComplete in the - 0.6.0 release of the Gearman extension. - - - - - - &reftitle.parameters; - - - result - - - Serialized result data. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanJob::sendFail - GearmanJob::setReturn - - - - - diff --git a/reference/gearman/gearmanjob/construct.xml b/reference/gearman/gearmanjob/construct.xml deleted file mode 100644 index 1576347c0f89..000000000000 --- a/reference/gearman/gearmanjob/construct.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - GearmanJob::__construct - Create a GearmanJob instance - - - - &reftitle.description; - - public GearmanJob::__construct - - - - Creates a GearmanJob instance representing a job the worker is to complete. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A GearmanJob object. - - - - - diff --git a/reference/gearman/gearmanjob/data.xml b/reference/gearman/gearmanjob/data.xml deleted file mode 100644 index a684e6f1173a..000000000000 --- a/reference/gearman/gearmanjob/data.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - GearmanJob::data - Send data for a running job (deprecated) - - - - &reftitle.description; - - public boolGearmanJob::data - stringdata - - - Sends data to the job server (and any listening clients) for this job. - - - - This method has been replaced by GearmanJob::sendData in the - 0.6.0 release of the Gearman extension. - - - - - - &reftitle.parameters; - - - data - - - Arbitrary serialized data. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanJob::workload - GearmanTask::data - - - - - diff --git a/reference/gearman/gearmanjob/exception.xml b/reference/gearman/gearmanjob/exception.xml deleted file mode 100644 index d0da0d6626ae..000000000000 --- a/reference/gearman/gearmanjob/exception.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - GearmanJob::exception - Send exception for running job (deprecated) - - - - &reftitle.description; - - public boolGearmanJob::exception - stringexception - - - Sends the supplied exception when this job is running. - - - - This method has been replaced by GearmanJob::sendException in the - 0.6.0 release of the Gearman extension. - - - - - - &reftitle.parameters; - - - exception - - - An exception description. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanJob::setReturn - GearmanJob::sendStatus - GearmanJob::sendWarning - - - - - diff --git a/reference/gearman/gearmanjob/fail.xml b/reference/gearman/gearmanjob/fail.xml deleted file mode 100644 index c6348610b4c0..000000000000 --- a/reference/gearman/gearmanjob/fail.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - GearmanJob::fail - Send fail status (deprecated) - - - - &reftitle.description; - - public boolGearmanJob::fail - - - - Sends failure status for this job, indicating that the job failed in a known way (as - opposed to failing due to a thrown exception). - - - - This method has been replaced by GearmanJob::sendFail in the - 0.6.0 release of the Gearman extension. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanJob::sendException - GearmanJob::setReturn - GearmanJob::sendStatus - GearmanJob::sendWarning - - - - - diff --git a/reference/gearman/gearmanjob/functionname.xml b/reference/gearman/gearmanjob/functionname.xml deleted file mode 100644 index 55120761fd4f..000000000000 --- a/reference/gearman/gearmanjob/functionname.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - GearmanJob::functionName - Get function name - - - - &reftitle.description; - - public falsestringGearmanJob::functionName - - - - Returns the function name for this job. This is the function the work will execute to - perform the job. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The name of a function, or &false; if the job has not yet been initialized. - - - - - &reftitle.seealso; - - GearmanTask::function - - - - - diff --git a/reference/gearman/gearmanjob/handle.xml b/reference/gearman/gearmanjob/handle.xml deleted file mode 100644 index 6c566f84409b..000000000000 --- a/reference/gearman/gearmanjob/handle.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - GearmanJob::handle - Get the job handle - - - - &reftitle.description; - - public falsestringGearmanJob::handle - - - - Returns the opaque job handle assigned by the job server. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - An opaque job handle, or &false; if the job has not yet been initialized. - - - - - &reftitle.seealso; - - GearmanTask::jobHandle - - - - - diff --git a/reference/gearman/gearmanjob/returncode.xml b/reference/gearman/gearmanjob/returncode.xml deleted file mode 100644 index e41c88c487bc..000000000000 --- a/reference/gearman/gearmanjob/returncode.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - GearmanJob::returnCode - Get last return code - - - - &reftitle.description; - - public intGearmanJob::returnCode - - - - Returns the last return code issued by the job server. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A valid Gearman return code. - - - - - &reftitle.seealso; - - GearmanTask::returnCode - - - - - diff --git a/reference/gearman/gearmanjob/sendcomplete.xml b/reference/gearman/gearmanjob/sendcomplete.xml deleted file mode 100644 index 4518c3593f01..000000000000 --- a/reference/gearman/gearmanjob/sendcomplete.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - GearmanJob::sendComplete - Send the result and complete status - - - - &reftitle.description; - - public boolGearmanJob::sendComplete - stringresult - - - Sends result data and the complete status update for this job. - - - - - &reftitle.parameters; - - - result - - - Serialized result data. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanJob::sendFail - GearmanJob::setReturn - - - - - diff --git a/reference/gearman/gearmanjob/senddata.xml b/reference/gearman/gearmanjob/senddata.xml deleted file mode 100644 index 5d5ce173af0b..000000000000 --- a/reference/gearman/gearmanjob/senddata.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - GearmanJob::sendData - Send data for a running job - - - - &reftitle.description; - - public boolGearmanJob::sendData - stringdata - - - Sends data to the job server (and any listening clients) for this job. - - - - - &reftitle.parameters; - - - data - - - Arbitrary serialized data. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanJob::workload - GearmanTask::data - - - - - diff --git a/reference/gearman/gearmanjob/sendexception.xml b/reference/gearman/gearmanjob/sendexception.xml deleted file mode 100644 index 19ed9485891f..000000000000 --- a/reference/gearman/gearmanjob/sendexception.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - GearmanJob::sendException - Send exception for running job (exception) - - - - &reftitle.description; - - public boolGearmanJob::sendException - stringexception - - - Sends the supplied exception when this job is running. - - - - - &reftitle.parameters; - - - exception - - - An exception description. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanJob::setReturn - GearmanJob::sendStatus - GearmanJob::sendWarning - - - - - diff --git a/reference/gearman/gearmanjob/sendfail.xml b/reference/gearman/gearmanjob/sendfail.xml deleted file mode 100644 index fbe029ad08d9..000000000000 --- a/reference/gearman/gearmanjob/sendfail.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - GearmanJob::sendFail - Send fail status - - - - &reftitle.description; - - public boolGearmanJob::sendFail - - - - Sends failure status for this job, indicating that the job failed in a known way (as - opposed to failing due to a thrown exception). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanJob::sendException - GearmanJob::setReturn - GearmanJob::sendStatus - GearmanJob::sendWarning - - - - - diff --git a/reference/gearman/gearmanjob/sendstatus.xml b/reference/gearman/gearmanjob/sendstatus.xml deleted file mode 100644 index df4638770c6f..000000000000 --- a/reference/gearman/gearmanjob/sendstatus.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - GearmanJob::sendStatus - Send status - - - - &reftitle.description; - - public boolGearmanJob::sendStatus - intnumerator - intdenominator - - - Sends status information to the job server and any listening clients. Use this - to specify what percentage of the job has been completed. - - - - - &reftitle.parameters; - - - numerator - - - The numerator of the percentage completed expressed as a fraction. - - - - - denominator - - - The denominator of the percentage completed expressed as a fraction. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanClient::jobStatus - GearmanTask::taskDenominator - GearmanTask::taskNumerator - - - - - diff --git a/reference/gearman/gearmanjob/sendwarning.xml b/reference/gearman/gearmanjob/sendwarning.xml deleted file mode 100644 index a5833986936c..000000000000 --- a/reference/gearman/gearmanjob/sendwarning.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - GearmanJob::sendWarning - Send a warning - - - - &reftitle.description; - - public boolGearmanJob::sendWarning - stringwarning - - - Sends a warning for this job while it is running. - - - - - &reftitle.parameters; - - - warning - - - A warning message. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanJob::sendComplete - GearmanJob::sendException - GearmanJob::sendFail - - - - - diff --git a/reference/gearman/gearmanjob/setreturn.xml b/reference/gearman/gearmanjob/setreturn.xml deleted file mode 100644 index 1c8d19052da7..000000000000 --- a/reference/gearman/gearmanjob/setreturn.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - GearmanJob::setReturn - Set a return value - - - - &reftitle.description; - - public boolGearmanJob::setReturn - intgearman_return_t - - - Sets the return value for this job, indicates how the job completed. - - - - - &reftitle.parameters; - - - gearman_return_t - - - A valid Gearman return value. - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - diff --git a/reference/gearman/gearmanjob/status.xml b/reference/gearman/gearmanjob/status.xml deleted file mode 100644 index fc3d2523e3c0..000000000000 --- a/reference/gearman/gearmanjob/status.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - GearmanJob::status - Send status (deprecated) - - - - &reftitle.description; - - public boolGearmanJob::status - intnumerator - intdenominator - - - Sends status information to the job server and any listening clients. Use this - to specify what percentage of the job has been completed. - - - - This method has been replaced by GearmanJob::sendStatus in the - 0.6.0 release of the Gearman extension. - - - - - - &reftitle.parameters; - - - numerator - - - The numerator of the percentage completed expressed as a fraction. - - - - - denominator - - - The denominator of the percentage completed expressed as a fraction. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanClient::jobStatus - GearmanTask::taskDenominator - GearmanTask::taskNumerator - - - - - diff --git a/reference/gearman/gearmanjob/unique.xml b/reference/gearman/gearmanjob/unique.xml deleted file mode 100644 index f8502413a952..000000000000 --- a/reference/gearman/gearmanjob/unique.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - GearmanJob::unique - Get the unique identifier - - - - &reftitle.description; - - public falsestringGearmanJob::unique - - - - Returns the unique identifier for this job. The identifier is assigned by the client. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - An opaque unique identifier, or &false; if the job has not yet been initialized. - - - - - &reftitle.seealso; - - GearmanClient::do - GearmanTask::uuid - - - - - diff --git a/reference/gearman/gearmanjob/warning.xml b/reference/gearman/gearmanjob/warning.xml deleted file mode 100644 index 0507b052398a..000000000000 --- a/reference/gearman/gearmanjob/warning.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - GearmanJob::warning - Send a warning (deprecated) - - - - &reftitle.description; - - public boolGearmanJob::warning - stringwarning - - - Sends a warning for this job while it is running. - - - - This method has been replaced by GearmanJob::sendWarning in the - 0.6.0 release of the Gearman extension. - - - - - - &reftitle.parameters; - - - warning - - - A warning messages. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanJob::sendComplete - GearmanJob::sendException - GearmanJob::sendFail - - - - - diff --git a/reference/gearman/gearmanjob/workload.xml b/reference/gearman/gearmanjob/workload.xml deleted file mode 100644 index b6d3dd620984..000000000000 --- a/reference/gearman/gearmanjob/workload.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - GearmanJob::workload - Get workload - - - - &reftitle.description; - - public stringGearmanJob::workload - - - - Returns the workload for the job. This is serialized data that is to be processed by the worker. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Serialized data. - - - - - &reftitle.seealso; - - GearmanClient::do - GearmanJob::workloadSize - - - - - diff --git a/reference/gearman/gearmanjob/workloadsize.xml b/reference/gearman/gearmanjob/workloadsize.xml deleted file mode 100644 index ddca7a5ea1a8..000000000000 --- a/reference/gearman/gearmanjob/workloadsize.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - GearmanJob::workloadSize - Get size of work load - - - - &reftitle.description; - - public intGearmanJob::workloadSize - - - - Returns the size of the job's work load (the data the worker is to process) in bytes. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The size in bytes. - - - - - &reftitle.seealso; - - GearmanJob::workload - - - - - diff --git a/reference/gearman/gearmantask.xml b/reference/gearman/gearmantask.xml deleted file mode 100644 index 90bb62a17d0b..000000000000 --- a/reference/gearman/gearmantask.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - The GearmanTask class - GearmanTask - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - - GearmanTask - - - &Methods; - - - - - -
- -
- - &reference.gearman.entities.gearmantask; - -
- diff --git a/reference/gearman/gearmantask/construct.xml b/reference/gearman/gearmantask/construct.xml deleted file mode 100644 index 4801bc0d39c2..000000000000 --- a/reference/gearman/gearmantask/construct.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - GearmanTask::__construct - Create a GearmanTask instance - - - - &reftitle.description; - - public GearmanTask::__construct - - - - Creates a GearmanTask instance representing a task to be submitted to a job server. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A GearmanTask object. - - - - - diff --git a/reference/gearman/gearmantask/create.xml b/reference/gearman/gearmantask/create.xml deleted file mode 100644 index baa4dee8a847..000000000000 --- a/reference/gearman/gearmantask/create.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - GearmanTask::create - Create a task (deprecated) - - - - &reftitle.description; - - public GearmanTaskfalseGearmanTask::create - - - - Returns a new GearmanTask object. - - - - This method was removed in the 0.6.0 version of the Gearman extension. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A GearmanTask object&return.falseforfailure;. - - - - - diff --git a/reference/gearman/gearmantask/data.xml b/reference/gearman/gearmantask/data.xml deleted file mode 100644 index 95060de34a13..000000000000 --- a/reference/gearman/gearmantask/data.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - GearmanTask::data - Get data returned for a task - - - - &reftitle.description; - - public falsestringGearmanTask::data - - - - Returns data being returned for a task by a worker. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The serialized data, or &false; if no data is present. - - - - - &reftitle.seealso; - - GearmanTask::dataSize - - - - - diff --git a/reference/gearman/gearmantask/datasize.xml b/reference/gearman/gearmantask/datasize.xml deleted file mode 100644 index 5479b7238365..000000000000 --- a/reference/gearman/gearmantask/datasize.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - GearmanTask::dataSize - Get the size of returned data - - - - &reftitle.description; - - public intfalseGearmanTask::dataSize - - - - Returns the size of the data being returned for a task. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The data size, or &false; if there is no data. - - - - - &reftitle.seealso; - - GearmanTask::data - - - - - diff --git a/reference/gearman/gearmantask/function.xml b/reference/gearman/gearmantask/function.xml deleted file mode 100644 index 0ee371eeed8e..000000000000 --- a/reference/gearman/gearmantask/function.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - GearmanTask::function - Get associated function name (deprecated) - - - - &reftitle.description; - - public stringGearmanTask::function - - - - Returns the name of the function this task is associated with, i.e., the function - the Gearman worker calls. - - - - This method has been replaced by GearmanTask::functionName in the - 0.6.0 release of the Gearman extension. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A function name. - - - - - diff --git a/reference/gearman/gearmantask/functionname.xml b/reference/gearman/gearmantask/functionname.xml deleted file mode 100644 index 3231f1359513..000000000000 --- a/reference/gearman/gearmantask/functionname.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - GearmanTask::functionName - Get associated function name - - - - &reftitle.description; - - public falsestringGearmanTask::functionName - - - - Returns the name of the function this task is associated with, i.e., the function - the Gearman worker calls. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A function name, or &false; if the task has not yet been created. - - - - - diff --git a/reference/gearman/gearmantask/isknown.xml b/reference/gearman/gearmantask/isknown.xml deleted file mode 100644 index 541adee28aab..000000000000 --- a/reference/gearman/gearmantask/isknown.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - GearmanTask::isKnown - Determine if task is known - - - - &reftitle.description; - - public boolGearmanTask::isKnown - - - - Gets the status information for whether or not this task is known to the job server. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; if the task is known, &false; otherwise. - - - - - diff --git a/reference/gearman/gearmantask/isrunning.xml b/reference/gearman/gearmantask/isrunning.xml deleted file mode 100644 index c1e76632da46..000000000000 --- a/reference/gearman/gearmantask/isrunning.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - GearmanTask::isRunning - Test whether the task is currently running - - - - &reftitle.description; - - public boolGearmanTask::isRunning - - - - Indicates whether or not this task is currently running. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; if the task is running, &false; otherwise. - - - - - diff --git a/reference/gearman/gearmantask/jobhandle.xml b/reference/gearman/gearmantask/jobhandle.xml deleted file mode 100644 index 502f7aa7d51c..000000000000 --- a/reference/gearman/gearmantask/jobhandle.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - GearmanTask::jobHandle - gearman_job_handle - Get the job handle - - - - &reftitle.description; - - public falsestringGearmanTask::jobHandle - - - - Returns the job handle for this task. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The opaque job handle, or &false; if the task has not yet been created. - - - - - &reftitle.seealso; - - GearmanClient::doJobHandle - - - - - diff --git a/reference/gearman/gearmantask/recvdata.xml b/reference/gearman/gearmantask/recvdata.xml deleted file mode 100644 index cdbd943dc7ef..000000000000 --- a/reference/gearman/gearmantask/recvdata.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - GearmanTask::recvData - Read work or result data into a buffer for a task - - - - &reftitle.description; - - public falsearrayGearmanTask::recvData - intdata_len - - - - &warn.experimental.func; - - - - &reftitle.parameters; - - - data_len - - - Length of data to be read. - - - - - - - - &reftitle.returnvalues; - - An array whose first element is the length of data read and the second is the data buffer. - Returns &false; if the read failed. - - - - - &reftitle.seealso; - - GearmanTask::sendData - - - - - diff --git a/reference/gearman/gearmantask/returncode.xml b/reference/gearman/gearmantask/returncode.xml deleted file mode 100644 index 8d1dfe8d228b..000000000000 --- a/reference/gearman/gearmantask/returncode.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - GearmanTask::returnCode - Get the last return code - - - - &reftitle.description; - - public intGearmanTask::returnCode - - - - Returns the last Gearman return code for this task. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A valid Gearman return code. - - - - - &reftitle.seealso; - - GearmanClient::returnCode - - - - - diff --git a/reference/gearman/gearmantask/senddata.xml b/reference/gearman/gearmantask/senddata.xml deleted file mode 100644 index 4aaf05d67cba..000000000000 --- a/reference/gearman/gearmantask/senddata.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - GearmanTask::sendData - Send data for a task (deprecated) - - - - &reftitle.description; - - public intGearmanTask::sendData - stringdata - - - - &warn.experimental.func; - - - - - &reftitle.parameters; - - - data - - - Data to send to the worker. - - - - - - - - &reftitle.returnvalues; - - The length of data sent, or &false; if the send failed. - - - - - &reftitle.seealso; - - GearmanTask::recvData - - - - - diff --git a/reference/gearman/gearmantask/sendworkload.xml b/reference/gearman/gearmantask/sendworkload.xml deleted file mode 100644 index 6e47847ecdc4..000000000000 --- a/reference/gearman/gearmantask/sendworkload.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - GearmanTask::sendWorkload - Send data for a task - - - - &reftitle.description; - - public intfalseGearmanTask::sendWorkload - stringdata - - - - &warn.experimental.func; - - - - - &reftitle.parameters; - - - data - - - Data to send to the worker. - - - - - - - - &reftitle.returnvalues; - - The length of data sent, or &false; if the send failed. - - - - - &reftitle.seealso; - - GearmanTask::recvData - - - - - diff --git a/reference/gearman/gearmantask/taskdenominator.xml b/reference/gearman/gearmantask/taskdenominator.xml deleted file mode 100644 index 7b0ec3778967..000000000000 --- a/reference/gearman/gearmantask/taskdenominator.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - GearmanTask::taskDenominator - Get completion percentage denominator - - - - &reftitle.description; - - public falseintGearmanTask::taskDenominator - - - - Returns the denominator of the percentage of the task that is complete expressed as a fraction. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A number between 0 and 100, or &false; if cannot be determined. - - - - - &reftitle.seealso; - - GearmanTask::taskNumerator - - - - - diff --git a/reference/gearman/gearmantask/tasknumerator.xml b/reference/gearman/gearmantask/tasknumerator.xml deleted file mode 100644 index 6343e6d3c24d..000000000000 --- a/reference/gearman/gearmantask/tasknumerator.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - GearmanTask::taskNumerator - Get completion percentage numerator - - - - &reftitle.description; - - public falseintGearmanTask::taskNumerator - - - - Returns the numerator of the percentage of the task that is complete expressed as a fraction. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A number between 0 and 100, or &false; if cannot be determined. - - - - - &reftitle.seealso; - - GearmanTask::taskDenominator - - - - - diff --git a/reference/gearman/gearmantask/unique.xml b/reference/gearman/gearmantask/unique.xml deleted file mode 100644 index af6742b03fd4..000000000000 --- a/reference/gearman/gearmantask/unique.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - GearmanTask::unique - Get the unique identifier for a task - - - - &reftitle.description; - - public falsestringGearmanTask::unique - - - - Returns the unique identifier for this task. This is assigned by the GearmanClient, - as opposed to the job handle which is set by the Gearman job server. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The unique identifier, or &false; if no identifier is assigned. - - - - - &reftitle.seealso; - - GearmanClient::do - GearmanClient::addTask - - - - - diff --git a/reference/gearman/gearmantask/uuid.xml b/reference/gearman/gearmantask/uuid.xml deleted file mode 100644 index f9fdfabec931..000000000000 --- a/reference/gearman/gearmantask/uuid.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - GearmanTask::uuid - Get the unique identifier for a task (deprecated) - - - - &reftitle.description; - - public stringGearmanTask::uuid - - - - Returns the unique identifier for this task. This is assigned by the GearmanClient, - as opposed to the job handle which is set by the Gearman job server. - - - - This method has been replaced by GearmanTask::unique in the - 0.6.0 release of the Gearman extension. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The unique identifier, or &false; if no identifier is assigned. - - - - - &reftitle.seealso; - - GearmanClient::do - GearmanClient::addTask - - - - - diff --git a/reference/gearman/gearmanworker.xml b/reference/gearman/gearmanworker.xml deleted file mode 100644 index bc152dc2afdc..000000000000 --- a/reference/gearman/gearmanworker.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - The GearmanWorker class - GearmanWorker - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - - GearmanWorker - - - &Methods; - - - - - -
- -
- - &reference.gearman.entities.gearmanworker; - -
- diff --git a/reference/gearman/gearmanworker/addfunction.xml b/reference/gearman/gearmanworker/addfunction.xml deleted file mode 100644 index 0e922fc8745b..000000000000 --- a/reference/gearman/gearmanworker/addfunction.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - GearmanWorker::addFunction - Register and add callback function - - - - &reftitle.description; - - public boolGearmanWorker::addFunction - stringfunction_name - callablefunction - mixedcontext&null; - inttimeout0 - - - Registers a function name with the job server and specifies a callback corresponding to that - function. Optionally specify extra application context data to be used when the callback is - called and a timeout. - - - - - &reftitle.parameters; - - - function_name - - - The name of a function to register with the job server - - - - - function - - - A callback that gets called when a job for the registered function name is submitted - - - - - context - - - A reference to arbitrary application context data that can be modified by the worker function - - - - - timeout - - - An interval of time in seconds - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Simple worker making use of extra application context data - -addServer(); - -# define a variable to hold application data -$count= 0; - -# add the "reverse" function -$worker->addFunction("reverse", "reverse_cb", $count); - -# start the worker -while ($worker->work()); - -function reverse_cb($job, &$count) -{ - $count++; - return "$count: " . strrev($job->workload()); -} - -?> -]]> - - - Running a client that submits two jobs for the reverse function would have - output similar to the following: - - - - - - - - - &reftitle.seealso; - - GearmanClient::do - - - - - diff --git a/reference/gearman/gearmanworker/addoptions.xml b/reference/gearman/gearmanworker/addoptions.xml deleted file mode 100644 index 7de428bdbc24..000000000000 --- a/reference/gearman/gearmanworker/addoptions.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - GearmanWorker::addOptions - Add worker options - - - - &reftitle.description; - - public trueGearmanWorker::addOptions - intoption - - - Adds one or more options to the options previously set. - - - - - &reftitle.parameters; - - - option - - - The options to be added - - - - - - - - &reftitle.returnvalues; - - &return.true.always; - - - - - &reftitle.seealso; - - GearmanWorker::options - GearmanClient::setOptions - GearmanClient::removeOptions - - - - - diff --git a/reference/gearman/gearmanworker/addserver.xml b/reference/gearman/gearmanworker/addserver.xml deleted file mode 100644 index f6e966d550f1..000000000000 --- a/reference/gearman/gearmanworker/addserver.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - GearmanWorker::addServer - Add a job server - - - - &reftitle.description; - - public boolGearmanWorker::addServer - stringhost&null; - intport0 - boolsetupExceptionHandler&true; - - - Adds a job server to this worker. This goes into a list of servers than can be used to run jobs. - No socket I/O happens here. - - - - - &reftitle.parameters; - - - host - - - &gearman.parameter.host; - - - - - port - - - &gearman.parameter.port; - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Add alternate Gearman servers - -addServer("10.0.0.1"); -$worker->addServer("10.0.0.2", 7003); -?> -]]> - - - - - - &reftitle.seealso; - - GearmanWorker::addServers - - - - - diff --git a/reference/gearman/gearmanworker/addservers.xml b/reference/gearman/gearmanworker/addservers.xml deleted file mode 100644 index ddf5611e080f..000000000000 --- a/reference/gearman/gearmanworker/addservers.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - GearmanWorker::addServers - Add job servers - - - - &reftitle.description; - - public boolGearmanWorker::addServers - stringservers&null; - boolsetupExceptionHandler&true; - - - Adds one or more job servers to this worker. These go into a list of servers that can be used - to run jobs. No socket I/O happens here. - - - - - &reftitle.parameters; - - - servers - - - A comma separated list of job servers in the format host:port. If no port is - specified, it defaults to 4730. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Add two job servers - -addServers("10.0.0.1,10.0.0.2:7003"); - -?> -]]> - - - - - - &reftitle.seealso; - - GearmanWorker::addServer - - - - - diff --git a/reference/gearman/gearmanworker/clone.xml b/reference/gearman/gearmanworker/clone.xml deleted file mode 100644 index 8ff0bfe3cf0a..000000000000 --- a/reference/gearman/gearmanworker/clone.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - GearmanWorker::clone - Create a copy of the worker - - - - &reftitle.description; - - public voidGearmanWorker::clone - - - - Creates a copy of the worker. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A GearmanWorker object - - - - - diff --git a/reference/gearman/gearmanworker/construct.xml b/reference/gearman/gearmanworker/construct.xml deleted file mode 100644 index f267e4ae859d..000000000000 --- a/reference/gearman/gearmanworker/construct.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - GearmanWorker::__construct - Create a GearmanWorker instance - - - - &reftitle.description; - - public GearmanWorker::__construct - - - - Creates a GearmanWorker instance representing a worker that connects to the job server and accepts tasks to run. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A GearmanWorker object - - - - - &reftitle.seealso; - - GearmanWorker::clone - - - - - diff --git a/reference/gearman/gearmanworker/echo.xml b/reference/gearman/gearmanworker/echo.xml deleted file mode 100644 index ee368bd6ceb7..000000000000 --- a/reference/gearman/gearmanworker/echo.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - GearmanWorker::echo - Test job server response - - - - &reftitle.description; - - public boolGearmanWorker::echo - stringworkload - - - Sends data to all job servers to see if they echo it back. This is a test function - to see if job servers are responding properly. - - - - - &reftitle.parameters; - - - workload - - - Arbitrary serialized data - - - - - - - - &reftitle.returnvalues; - - Standard Gearman return value. - - - - - &reftitle.seealso; - - GearmanClient::echo - - - - - diff --git a/reference/gearman/gearmanworker/error.xml b/reference/gearman/gearmanworker/error.xml deleted file mode 100644 index a039ae7c3438..000000000000 --- a/reference/gearman/gearmanworker/error.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - GearmanWorker::error - Get the last error encountered - - - - &reftitle.description; - - public stringfalseGearmanWorker::error - - - - Returns an error string for the last error encountered. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A human readable error string, or &false; if there is no error message available. - - - - - &reftitle.seealso; - - GearmanWorker::getErrno - - - - - diff --git a/reference/gearman/gearmanworker/geterrno.xml b/reference/gearman/gearmanworker/geterrno.xml deleted file mode 100644 index 7896902b29e9..000000000000 --- a/reference/gearman/gearmanworker/geterrno.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - GearmanWorker::getErrno - Get errno - - - - &reftitle.description; - - public intGearmanWorker::getErrno - - - - Returns the value of errno in the case of a GEARMAN_ERRNO return value. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A valid errno. - - - - - &reftitle.seealso; - - GearmanWorker::error - - - - - diff --git a/reference/gearman/gearmanworker/options.xml b/reference/gearman/gearmanworker/options.xml deleted file mode 100644 index 65aee103e9d2..000000000000 --- a/reference/gearman/gearmanworker/options.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - GearmanWorker::options - Get worker options - - - - &reftitle.description; - - public intGearmanWorker::options - - - - Gets the options previously set for the worker. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The options currently set for the worker. - - - - - &reftitle.seealso; - - GearmanWorker::setOptions - - - - - diff --git a/reference/gearman/gearmanworker/register.xml b/reference/gearman/gearmanworker/register.xml deleted file mode 100644 index 216490adda22..000000000000 --- a/reference/gearman/gearmanworker/register.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - GearmanWorker::register - Register a function with the job server - - - - &reftitle.description; - - public boolGearmanWorker::register - stringfunction_name - inttimeout0 - - - Registers a function name with the job server with an optional timeout. The timeout - specifies how many seconds the server will wait before marking a job as failed. - If the timeout is set to zero, there is no timeout. - - - - - &reftitle.parameters; - - - function_name - - - The name of a function to register with the job server - - - - - timeout - - - An interval of time in seconds - - - - - - - - &reftitle.returnvalues; - - A standard Gearman return value. - - - - - &reftitle.seealso; - - GearmanWorker::unregister - GearmanWorker::unregisterAll - - - - - diff --git a/reference/gearman/gearmanworker/removeoptions.xml b/reference/gearman/gearmanworker/removeoptions.xml deleted file mode 100644 index 6eadbc8dee17..000000000000 --- a/reference/gearman/gearmanworker/removeoptions.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - GearmanWorker::removeOptions - Remove worker options - - - - &reftitle.description; - - public trueGearmanWorker::removeOptions - intoption - - - Removes (unsets) one or more worker options. - - - - - &reftitle.parameters; - - - option - - - The options to be removed (unset) - - - - - - - - &reftitle.returnvalues; - - &return.true.always; - - - - - &reftitle.seealso; - - GearmanWorker::options - GearmanWorker::setOptions - GearmanWorker::addOptions - - - - - diff --git a/reference/gearman/gearmanworker/returncode.xml b/reference/gearman/gearmanworker/returncode.xml deleted file mode 100644 index 98c66af8746c..000000000000 --- a/reference/gearman/gearmanworker/returncode.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - GearmanWorker::returnCode - Get last Gearman return code - - - - &reftitle.description; - - public intGearmanWorker::returnCode - - - - Returns the last Gearman return code. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A valid Gearman return code. - - - - - &reftitle.seealso; - - GearmanWorker::error - GearmanWorker::getErrno - - - - - diff --git a/reference/gearman/gearmanworker/setid.xml b/reference/gearman/gearmanworker/setid.xml deleted file mode 100644 index efedbcbee864..000000000000 --- a/reference/gearman/gearmanworker/setid.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - GearmanWorker::setId - Give the worker an identifier so it can be tracked when asking gearmand for the list of available workers - - - - &reftitle.description; - - public boolGearmanWorker::setId - stringid - - - Assigns the worker an identifier. - - - - - &reftitle.parameters; - - - id - - - A string identifier. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>GearmanWorker::setId</function> example - - Set an identifier for a simple worker. - - -setId('test'); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/gearman/gearmanworker/setoptions.xml b/reference/gearman/gearmanworker/setoptions.xml deleted file mode 100644 index cbe29fa94e22..000000000000 --- a/reference/gearman/gearmanworker/setoptions.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - GearmanWorker::setOptions - Set worker options - - - - &reftitle.description; - - public trueGearmanWorker::setOptions - intoption - - - Sets one or more options to the supplied value. - - - - - &reftitle.parameters; - - - option - - - The options to be set - - - - - - - - &reftitle.returnvalues; - - &return.true.always; - - - - - &reftitle.seealso; - - GearmanWorker::options - GearmanWorker::addOptions - GearmanWorker::removeOptions - GearmanClient::setOptions - - - - - diff --git a/reference/gearman/gearmanworker/settimeout.xml b/reference/gearman/gearmanworker/settimeout.xml deleted file mode 100644 index a60c36491e2d..000000000000 --- a/reference/gearman/gearmanworker/settimeout.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - GearmanWorker::setTimeout - Set socket I/O activity timeout - - - - &reftitle.description; - - public trueGearmanWorker::setTimeout - inttimeout - - - Sets the interval of time to wait for socket I/O activity. - - - - - &reftitle.parameters; - - - timeout - - - An interval of time in milliseconds. A negative value indicates an infinite timeout. - - - - - - - - &reftitle.returnvalues; - - &return.true.always; - - - - - &reftitle.examples; - - A simple worker with a 5 second timeout - -addServer(); - -# Register function "reverse" with the server. -$gmworker->addFunction("reverse", "reverse_fn"); - -# Set the timeout to 5 seconds -$gmworker->setTimeout(5000); - -echo "Waiting for job...\n"; -while(@$gmworker->work() || $gmworker->returnCode() == GEARMAN_TIMEOUT) -{ - if ($gmworker->returnCode() == GEARMAN_TIMEOUT) - { - # Normally one would want to do something useful here ... - echo "Timeout. Waiting for next job...\n"; - continue; - } - - if ($gmworker->returnCode() != GEARMAN_SUCCESS) - { - echo "return_code: " . $gmworker->returnCode() . "\n"; - break; - } -} - -echo "Done\n"; - -function reverse_fn($job) -{ - return strrev($job->workload()); -} - -?> -]]> - - - Running the worker with no submitted jobs will generate output that looks like the following: - - - - - - - - - &reftitle.seealso; - - GearmanWorker::timeout - - - - - diff --git a/reference/gearman/gearmanworker/timeout.xml b/reference/gearman/gearmanworker/timeout.xml deleted file mode 100644 index 139ff9b082a6..000000000000 --- a/reference/gearman/gearmanworker/timeout.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - GearmanWorker::timeout - Get socket I/O activity timeout - - - - &reftitle.description; - - public intGearmanWorker::timeout - - - - Returns the current time to wait, in milliseconds, for socket I/O activity. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A time period in milliseconds. A negative value indicates an infinite timeout. - - - - - &reftitle.seealso; - - GearmanWorker::setTimeout - - - - - diff --git a/reference/gearman/gearmanworker/unregister.xml b/reference/gearman/gearmanworker/unregister.xml deleted file mode 100644 index bcb3e9a69bfc..000000000000 --- a/reference/gearman/gearmanworker/unregister.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - GearmanWorker::unregister - Unregister a function name with the job servers - - - - &reftitle.description; - - public boolGearmanWorker::unregister - stringfunction_name - - - Unregisters a function name with the job servers ensuring that no more jobs (for that - function) are sent to this worker. - - - - - &reftitle.parameters; - - - function_name - - - The name of a function to register with the job server - - - - - - - - &reftitle.returnvalues; - - A standard Gearman return value. - - - - - &reftitle.seealso; - - GearmanWorker::register - GearmanWorker::unregisterAll - - - - - diff --git a/reference/gearman/gearmanworker/unregisterall.xml b/reference/gearman/gearmanworker/unregisterall.xml deleted file mode 100644 index a7f279a8ddaf..000000000000 --- a/reference/gearman/gearmanworker/unregisterall.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - GearmanWorker::unregisterAll - Unregister all function names with the job servers - - - - &reftitle.description; - - public boolGearmanWorker::unregisterAll - - - - Unregisters all previously registered functions, ensuring that no more jobs are - sent to this worker. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A standard Gearman return value. - - - - - &reftitle.seealso; - - GearmanWorker::register - GearmanWorker::unregister - - - - - diff --git a/reference/gearman/gearmanworker/wait.xml b/reference/gearman/gearmanworker/wait.xml deleted file mode 100644 index 5fa726287426..000000000000 --- a/reference/gearman/gearmanworker/wait.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - GearmanWorker::wait - Wait for activity from one of the job servers - - - - &reftitle.description; - - public boolGearmanWorker::wait - - - - Causes the worker to wait for activity from one of the Gearman job servers when operating - in non-blocking I/O mode. On failure, issues a E_WARNING with the last Gearman error - encountered. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Running worker in non-blocking mode - -addOptions(GEARMAN_WORKER_NON_BLOCKING); - -# Add the default server (localhost, port 4730) -$worker->addServer(); - -# Add our reverse function -$worker->addFunction('reverse', 'reverse_fn'); - -# Try to grab a job -while (@$worker->work() || - $worker->returnCode() == GEARMAN_IO_WAIT || - $worker->returnCode() == GEARMAN_NO_JOBS) -{ - if ($worker->returnCode() == GEARMAN_SUCCESS) - continue; - - echo "Waiting for next job...\n"; - if (!@$worker->wait()) - { - if ($worker->returnCode() == GEARMAN_NO_ACTIVE_FDS) - { - # We are not connected to any servers, so wait a bit before - # trying to reconnect. - sleep(5); - continue; - } - break; - } -} - -echo "Worker Error: " . $worker->error() . "\n"; - -function reverse_fn($job) -{ - return strrev($job->workload()); -} - - -?> -]]> - - - - - - &reftitle.seealso; - - GearmanWorker::work - - - - - diff --git a/reference/gearman/gearmanworker/work.xml b/reference/gearman/gearmanworker/work.xml deleted file mode 100644 index 99b502e6376a..000000000000 --- a/reference/gearman/gearmanworker/work.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - GearmanWorker::work - Wait for and perform jobs - - - - &reftitle.description; - - public boolGearmanWorker::work - - - - Waits for a job to be assigned and then calls the appropriate callback function. - Issues an E_WARNING with the last Gearman error if the return - code is not one of GEARMAN_SUCCESS, GEARMAN_IO_WAIT, - or GEARMAN_WORK_FAIL. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <methodname>GearmanWorker::work</methodname> example - -addServer(); - -# add the reverse function -$worker->addFunction("reverse", "my_reverse_function"); - -# start te worker listening for job submissions -while ($worker->work()); - -function my_reverse_function($job) -{ - return strrev($job->workload()); -} - -?> -]]> - - - - - - &reftitle.seealso; - - GearmanWorker::addFunction - - - - - diff --git a/reference/gearman/setup.xml b/reference/gearman/setup.xml deleted file mode 100644 index 766e836bb870..000000000000 --- a/reference/gearman/setup.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - &reftitle.setup; - -
- &reftitle.required; - - - This extension requires the - libgearman, - libevent and - uuid - libraries, - and a running Gearman server. - -
- - - &reference.gearman.configure; - - -
- diff --git a/reference/gearman/versions.xml b/reference/gearman/versions.xml deleted file mode 100644 index b8433453d2e9..000000000000 --- a/reference/gearman/versions.xml +++ /dev/null @@ -1,235 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/gender/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/gender/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/gender/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/gender/book.xml b/reference/gender/book.xml deleted file mode 100644 index e2a3a66949a6..000000000000 --- a/reference/gender/book.xml +++ /dev/null @@ -1,39 +0,0 @@ - - - - - Determine gender of firstnames - Gender - - - &reftitle.intro; - - Gender PHP extension is a port of the gender.c program originally written by Joerg Michael. The main purpose is to find out the gender of firstnames. The current database contains >40000 firstnames from 54 countries. - - - - &reference.gender.setup; - &reference.gender.examples; - &reference.gender.gender; - - - diff --git a/reference/gender/configure.xml b/reference/gender/configure.xml deleted file mode 100644 index 4c6aef9b1187..000000000000 --- a/reference/gender/configure.xml +++ /dev/null @@ -1,32 +0,0 @@ - - -
- &reftitle.install; - - - &pecl.info; - &url.pecl.package;gender - - - -
- diff --git a/reference/gender/examples.xml b/reference/gender/examples.xml deleted file mode 100644 index 59af8803c650..000000000000 --- a/reference/gender/examples.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - &reftitle.examples; -
- Usage example. - - Gender class usage example. - - - Usage example. - -get($name, $country); - -$data = $gender->country($country); - -switch($result) { - case Gender::IS_FEMALE: - printf("The name %s is female in %s\n", $name, $data['country']); - break; - - - case Gender::IS_MOSTLY_FEMALE: - printf("The name %s is mostly female in %s\n", $name, $data['country']); - break; - - - case Gender::IS_MALE: - printf("The name %s is male in %s\n", $name, $data['country']); - break; - - - case Gender::IS_MOSTLY_MALE: - printf("The name %s is mostly male in %s\n", $name, $data['country']); - break; - - - case Gender::IS_UNISEX_NAME: - printf("The name %s is unisex in %s\n", $name, $data['country']); - break; - - - case Gender::IS_A_COUPLE: - printf("The name %s is both male and female in %s\n", $name, $data['country']); - break; - - - case Gender::NAME_NOT_FOUND: - printf("The name %s was not found for %s\n", $name, $data['country']); - break; - - - case Gender::ERROR_IN_NAME: - echo "There is an error in the given name!\n"; - break; - - default: - echo "An error occurred!\n"; - break; - -} -]]> - - -
-
- diff --git a/reference/gender/gender.xml b/reference/gender/gender.xml deleted file mode 100644 index 7754aaaac5a1..000000000000 --- a/reference/gender/gender.xml +++ /dev/null @@ -1,883 +0,0 @@ - - - - - The Gender\Gender class - Gender\Gender - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - Gender\Gender - - - - - Gender\Gender - - - - &Constants; - - const - int - Gender\Gender::IS_FEMALE - 70 - - - const - int - Gender\Gender::IS_MOSTLY_FEMALE - 102 - - - const - int - Gender\Gender::IS_MALE - 77 - - - const - int - Gender\Gender::IS_MOSTLY_MALE - 109 - - - const - int - Gender\Gender::IS_UNISEX_NAME - 63 - - - const - int - Gender\Gender::IS_A_COUPLE - 67 - - - const - int - Gender\Gender::NAME_NOT_FOUND - 32 - - - const - int - Gender\Gender::ERROR_IN_NAME - 69 - - - const - int - Gender\Gender::ANY_COUNTRY - 0 - - - const - int - Gender\Gender::BRITAIN - 1 - - - const - int - Gender\Gender::IRELAND - 2 - - - const - int - Gender\Gender::USA - 3 - - - const - int - Gender\Gender::SPAIN - 4 - - - const - int - Gender\Gender::PORTUGAL - 5 - - - const - int - Gender\Gender::ITALY - 6 - - - const - int - Gender\Gender::MALTA - 7 - - - const - int - Gender\Gender::FRANCE - 8 - - - const - int - Gender\Gender::BELGIUM - 9 - - - const - int - Gender\Gender::LUXEMBOURG - 10 - - - const - int - Gender\Gender::NETHERLANDS - 11 - - - const - int - Gender\Gender::GERMANY - 12 - - - const - int - Gender\Gender::EAST_FRISIA - 13 - - - const - int - Gender\Gender::AUSTRIA - 14 - - - const - int - Gender\Gender::SWISS - 15 - - - const - int - Gender\Gender::ICELAND - 16 - - - const - int - Gender\Gender::DENMARK - 17 - - - const - int - Gender\Gender::NORWAY - 18 - - - const - int - Gender\Gender::SWEDEN - 19 - - - const - int - Gender\Gender::FINLAND - 20 - - - const - int - Gender\Gender::ESTONIA - 21 - - - const - int - Gender\Gender::LATVIA - 22 - - - const - int - Gender\Gender::LITHUANIA - 23 - - - const - int - Gender\Gender::POLAND - 24 - - - const - int - Gender\Gender::CZECH_REP - 25 - - - const - int - Gender\Gender::SLOVAKIA - 26 - - - const - int - Gender\Gender::HUNGARY - 27 - - - const - int - Gender\Gender::ROMANIA - 28 - - - const - int - Gender\Gender::BULGARIA - 29 - - - const - int - Gender\Gender::BOSNIA - 30 - - - const - int - Gender\Gender::CROATIA - 31 - - - const - int - Gender\Gender::KOSOVO - 32 - - - const - int - Gender\Gender::MACEDONIA - 33 - - - const - int - Gender\Gender::MONTENEGRO - 34 - - - const - int - Gender\Gender::SERBIA - 35 - - - const - int - Gender\Gender::SLOVENIA - 36 - - - const - int - Gender\Gender::ALBANIA - 37 - - - const - int - Gender\Gender::GREECE - 38 - - - const - int - Gender\Gender::RUSSIA - 39 - - - const - int - Gender\Gender::BELARUS - 40 - - - const - int - Gender\Gender::MOLDOVA - 41 - - - const - int - Gender\Gender::UKRAINE - 42 - - - const - int - Gender\Gender::ARMENIA - 43 - - - const - int - Gender\Gender::AZERBAIJAN - 44 - - - const - int - Gender\Gender::GEORGIA - 45 - - - const - int - Gender\Gender::KAZAKH_UZBEK - 46 - - - const - int - Gender\Gender::TURKEY - 47 - - - const - int - Gender\Gender::ARABIA - 48 - - - const - int - Gender\Gender::ISRAEL - 49 - - - const - int - Gender\Gender::CHINA - 50 - - - const - int - Gender\Gender::INDIA - 51 - - - const - int - Gender\Gender::JAPAN - 52 - - - const - int - Gender\Gender::KOREA - 53 - - - &Methods; - - - - - -
- - -
- &reftitle.constants; - - - - Gender\Gender::IS_FEMALE - - - - - - - Gender\Gender::IS_MOSTLY_FEMALE - - - - - - - Gender\Gender::IS_MALE - - - - - - - Gender\Gender::IS_MOSTLY_MALE - - - - - - - Gender\Gender::IS_UNISEX_NAME - - - - - - - Gender\Gender::IS_A_COUPLE - - - - - - - Gender\Gender::NAME_NOT_FOUND - - - - - - - Gender\Gender::ERROR_IN_NAME - - - - - - - Gender\Gender::ANY_COUNTRY - - - - - - - Gender\Gender::BRITAIN - - - - - - - Gender\Gender::IRELAND - - - - - - - Gender\Gender::USA - - - - - - - Gender\Gender::SPAIN - - - - - - - Gender\Gender::PORTUGAL - - - - - - - Gender\Gender::ITALY - - - - - - - Gender\Gender::MALTA - - - - - - - Gender\Gender::FRANCE - - - - - - - Gender\Gender::BELGIUM - - - - - - - Gender\Gender::LUXEMBOURG - - - - - - - Gender\Gender::NETHERLANDS - - - - - - - Gender\Gender::GERMANY - - - - - - - Gender\Gender::EAST_FRISIA - - - - - - - Gender\Gender::AUSTRIA - - - - - - - Gender\Gender::SWISS - - - - - - - Gender\Gender::ICELAND - - - - - - - Gender\Gender::DENMARK - - - - - - - Gender\Gender::NORWAY - - - - - - - Gender\Gender::SWEDEN - - - - - - - Gender\Gender::FINLAND - - - - - - - Gender\Gender::ESTONIA - - - - - - - Gender\Gender::LATVIA - - - - - - - Gender\Gender::LITHUANIA - - - - - - - Gender\Gender::POLAND - - - - - - - Gender\Gender::CZECH_REP - - - - - - - Gender\Gender::SLOVAKIA - - - - - - - Gender\Gender::HUNGARY - - - - - - - Gender\Gender::ROMANIA - - - - - - - Gender\Gender::BULGARIA - - - - - - - Gender\Gender::BOSNIA - - - - - - - Gender\Gender::CROATIA - - - - - - - Gender\Gender::KOSOVO - - - - - - - Gender\Gender::MACEDONIA - - - - - - - Gender\Gender::MONTENEGRO - - - - - - - Gender\Gender::SERBIA - - - - - - - Gender\Gender::SLOVENIA - - - - - - - Gender\Gender::ALBANIA - - - - - - - Gender\Gender::GREECE - - - - - - - Gender\Gender::RUSSIA - - - - - - - Gender\Gender::BELARUS - - - - - - - Gender\Gender::MOLDOVA - - - - - - - Gender\Gender::UKRAINE - - - - - - - Gender\Gender::ARMENIA - - - - - - - Gender\Gender::AZERBAIJAN - - - - - - - Gender\Gender::GEORGIA - - - - - - - Gender\Gender::KAZAKH_UZBEK - - - - - - - Gender\Gender::TURKEY - - - - - - - Gender\Gender::ARABIA - - - - - - - Gender\Gender::ISRAEL - - - - - - - Gender\Gender::CHINA - - - - - - - Gender\Gender::INDIA - - - - - - - Gender\Gender::JAPAN - - - - - - - Gender\Gender::KOREA - - - - - - -
- - - -
- - &reference.gender.entities.gender; - -
- diff --git a/reference/gender/gender/connect.xml b/reference/gender/gender/connect.xml deleted file mode 100644 index 5aac0da6c9c9..000000000000 --- a/reference/gender/gender/connect.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - Gender\Gender::connect - Connect to an external name dictionary - - - - &reftitle.description; - - public boolGender\Gender::connect - stringdsn - - - Connect to an external name dictionary. Currently only streams are - supported. - - - - - &reftitle.parameters; - - - dsn - - - DSN to open. - - - - - - - - &reftitle.returnvalues; - - Boolean as success of failure. - - - - diff --git a/reference/gender/gender/construct.xml b/reference/gender/gender/construct.xml deleted file mode 100644 index bcb6b4d4d561..000000000000 --- a/reference/gender/gender/construct.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - Gender\Gender::__construct - Construct the Gender object - - - - &reftitle.description; - - public Gender\Gender::__construct - stringdsn - - - Create a Gender object optionally connecting to an external name - dictionary. When no external database was given, compiled in data will be - used. - - - - - &reftitle.parameters; - - - dsn - - - DSN to open. - - - - - - - - diff --git a/reference/gender/gender/country.xml b/reference/gender/gender/country.xml deleted file mode 100644 index 9a5c9b2c27e5..000000000000 --- a/reference/gender/gender/country.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - Gender\Gender::country - Get textual country representation - - - - &reftitle.description; - - public arrayfalseGender\Gender::country - intcountry - - - Returns the textual representation of a country from a Gender class - constant. - - - - - &reftitle.parameters; - - - country - - - A country ID specified by a Gender\Gender class - constant. - - - - - - - - &reftitle.returnvalues; - - Returns an array with the short and full names of the country on success - &return.falseforfailure;. - - - - - &reftitle.examples; - - Using <methodname>Gender\Gender::country</methodname> - -country(Gender\Gender::BRITAIN)); -]]> - - &example.outputs; - - - string(2) "UK" - 'country' => - string(13) "Great Britain" -} -]]> - - - - - diff --git a/reference/gender/gender/get.xml b/reference/gender/gender/get.xml deleted file mode 100644 index 226dbe85bb67..000000000000 --- a/reference/gender/gender/get.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - Gender\Gender::get - Get gender of a name - - - - &reftitle.description; - - public intGender\Gender::get - stringname - intcountry - - - Get the gender of the name in a particular country. - - - - - &reftitle.parameters; - - - name - - - Name to check. - - - - - country - - - Country id identified by Gender class constant. - - - - - - - - &reftitle.returnvalues; - - Returns gender of the name. - - - - - - diff --git a/reference/gender/gender/isnick.xml b/reference/gender/gender/isnick.xml deleted file mode 100644 index c37bcf7bdf5d..000000000000 --- a/reference/gender/gender/isnick.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - Gender\Gender::isNick - Check if the name0 is an alias of the name1 - - - - &reftitle.description; - - public arrayGender\Gender::isNick - stringname0 - stringname1 - intcountry - - - Check whether the name0 is a nick of the name1. - - - - - &reftitle.parameters; - - - name0 - - - Name to check. - - - - - name1 - - - Name to check. - - - - - country - - - Country id identified by Gender class constant. If ommited ANY_COUNTRY is used. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/gender/gender/similarnames.xml b/reference/gender/gender/similarnames.xml deleted file mode 100644 index 038345019606..000000000000 --- a/reference/gender/gender/similarnames.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - Gender\Gender::similarNames - Get similar names - - - - &reftitle.description; - - public arrayGender\Gender::similarNames - stringname - intcountry - - - Get similar names for the given name and country. - - - - - &reftitle.parameters; - - - name - - - Name to check. - - - - - country - - - Country id identified by Gender class constant. If ommited ANY_COUNTRY is used. - - - - - - - - &reftitle.returnvalues; - - Returns an array with the similar names found. - - - - - - diff --git a/reference/gender/setup.xml b/reference/gender/setup.xml deleted file mode 100644 index 49791664401a..000000000000 --- a/reference/gender/setup.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - &reftitle.setup; - - - -
- &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;gender. - -
- - - -
- diff --git a/reference/gender/versions.xml b/reference/gender/versions.xml deleted file mode 100644 index 607986900e8a..000000000000 --- a/reference/gender/versions.xml +++ /dev/null @@ -1,35 +0,0 @@ - - - - - - - - - - - - - - - - diff --git a/reference/geoip/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/geoip/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/geoip/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/geoip/book.xml b/reference/geoip/book.xml deleted file mode 100644 index b0d335e192b0..000000000000 --- a/reference/geoip/book.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - Geo IP Location - GeoIP - - - &reftitle.intro; - - The GeoIP extension allows you to find the location of an IP address. City, - State, Country, Longitude, Latitude, and other information as all, such as - ISP and connection type can be obtained with the help of GeoIP. - - - - This extension does not support MaxMind's current "GeoIP2" databases, - only the "GeoIP legacy" database files. - - - - - &reference.geoip.setup; - &reference.geoip.constants; - &reference.geoip.reference; - - - diff --git a/reference/geoip/constants.xml b/reference/geoip/constants.xml deleted file mode 100644 index b653bba40b6b..000000000000 --- a/reference/geoip/constants.xml +++ /dev/null @@ -1,190 +0,0 @@ - - - - &reftitle.constants; - &extension.constants; - - - - GEOIP_COUNTRY_EDITION - (int) - - - - - - - - - - GEOIP_REGION_EDITION_REV0 - (int) - - - - - - - - - - GEOIP_CITY_EDITION_REV0 - (int) - - - - - - - - - - GEOIP_ORG_EDITION - (int) - - - - - - - - - - GEOIP_ISP_EDITION - (int) - - - - - - - - - - GEOIP_CITY_EDITION_REV1 - (int) - - - - - - - - - - GEOIP_REGION_EDITION_REV1 - (int) - - - - - - - - - - GEOIP_PROXY_EDITION - (int) - - - - - - - - - - GEOIP_ASNUM_EDITION - (int) - - - - - - - - - - GEOIP_NETSPEED_EDITION - (int) - - - - - - - - - - GEOIP_DOMAIN_EDITION - (int) - - - - - - - - - - The following constants are for net speed: - - - - - GEOIP_UNKNOWN_SPEED - (int) - - - - - - - - GEOIP_DIALUP_SPEED - (int) - - - - - - - - GEOIP_CABLEDSL_SPEED - (int) - - - - - - - - GEOIP_CORPORATE_SPEED - (int) - - - - - - - - diff --git a/reference/geoip/functions/geoip-asnum-by-name.xml b/reference/geoip/functions/geoip-asnum-by-name.xml deleted file mode 100644 index 675773a23d0d..000000000000 --- a/reference/geoip/functions/geoip-asnum-by-name.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - geoip_asnum_by_name - Get the Autonomous System Numbers (ASN) - - - &reftitle.description; - - stringgeoip_asnum_by_name - stringhostname - - - - The geoip_asnum_by_name function will return the Autonomous - System Numbers (ASN) associated with an IP address. - - - - - &reftitle.parameters; - - - hostname - - - The hostname or IP address. - - - - - - - &reftitle.returnvalues; - - Returns the ASN on success, or &false; if the address - cannot be found in the database. - - - - - &reftitle.examples; - - A <function>geoip_asnum_by_name</function> example - - This will output the ASN of the host www.example.com. - - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/geoip/functions/geoip-continent-code-by-name.xml b/reference/geoip/functions/geoip-continent-code-by-name.xml deleted file mode 100644 index 613b3395e732..000000000000 --- a/reference/geoip/functions/geoip-continent-code-by-name.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - geoip_continent_code_by_name - Get the two letter continent code - - - &reftitle.description; - - stringgeoip_continent_code_by_name - stringhostname - - - - The geoip_continent_code_by_name function will return - the two letter continent code corresponding to a hostname or an IP address. - - - - - &reftitle.parameters; - - - hostname - - - The hostname or IP address whose location is to be looked-up. - - - - - - - &reftitle.returnvalues; - - Returns the two letter continent code on success, or &false; if the - address cannot be found in the database. - - - Continent codes - - - - Code - Continent name - - - - - AF - Africa - - - AN - Antarctica - - - AS - Asia - - - EU - Europe - - - NA - North america - - - OC - Oceania - - - SA - South america - - - -
-
- - - &reftitle.examples; - - A <function>geoip_continent_code_by_name</function> example - - This will print where the host example.com is located. - - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - geoip_country_code_by_name - - - -
- diff --git a/reference/geoip/functions/geoip-country-code-by-name.xml b/reference/geoip/functions/geoip-country-code-by-name.xml deleted file mode 100644 index 1407a18fec1c..000000000000 --- a/reference/geoip/functions/geoip-country-code-by-name.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - geoip_country_code_by_name - Get the two letter country code - - - &reftitle.description; - - stringgeoip_country_code_by_name - stringhostname - - - - The geoip_country_code_by_name function will return - the two letter country code corresponding to a hostname or an IP address. - - - - - &reftitle.parameters; - - - hostname - - - The hostname or IP address whose location is to be looked-up. - - - - - - - &reftitle.returnvalues; - - Returns the two letter ISO country code on success, or &false; - if the address cannot be found in the database. - - - - - &reftitle.examples; - - A <function>geoip_country_code_by_name</function> example - - This will print where the host example.com is located. - - - -]]> - - &example.outputs; - - - - - - - - &reftitle.notes; - - - Please see - &url.maxmind.iso3166; for - a complete list of possible return values, including special codes. - - - - - - &reftitle.seealso; - - geoip_country_code3_by_name - geoip_country_name_by_name - - - - - diff --git a/reference/geoip/functions/geoip-country-code3-by-name.xml b/reference/geoip/functions/geoip-country-code3-by-name.xml deleted file mode 100644 index 7fc04338120e..000000000000 --- a/reference/geoip/functions/geoip-country-code3-by-name.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - geoip_country_code3_by_name - Get the three letter country code - - - &reftitle.description; - - stringgeoip_country_code3_by_name - stringhostname - - - - The geoip_country_code3_by_name function will return the - three letter country code corresponding to a hostname or an IP address. - - - - - &reftitle.parameters; - - - hostname - - - The hostname or IP address whose location is to be looked-up. - - - - - - - &reftitle.returnvalues; - - Returns the three letter country code on success, or &false; - if the address cannot be found in the database. - - - - - &reftitle.examples; - - A <function>geoip_country_code3_by_name</function> example - - This will print where the host example.com is located. - - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - geoip_country_code_by_name - geoip_country_name_by_name - - - - - diff --git a/reference/geoip/functions/geoip-country-name-by-name.xml b/reference/geoip/functions/geoip-country-name-by-name.xml deleted file mode 100644 index e10ae385e523..000000000000 --- a/reference/geoip/functions/geoip-country-name-by-name.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - geoip_country_name_by_name - Get the full country name - - - &reftitle.description; - - stringgeoip_country_name_by_name - stringhostname - - - - The geoip_country_name_by_name function will return the - full country name corresponding to a hostname or an IP address. - - - - - &reftitle.parameters; - - - hostname - - - The hostname or IP address whose location is to be looked-up. - - - - - - - &reftitle.returnvalues; - - Returns the country name on success, or &false; if the address cannot - be found in the database. - - - - - &reftitle.examples; - - A <function>geoip_country_name_by_name</function> example - - This will print where the host example.com is located. - - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - geoip_country_code_by_name - geoip_country_code3_by_name - - - - - diff --git a/reference/geoip/functions/geoip-database-info.xml b/reference/geoip/functions/geoip-database-info.xml deleted file mode 100644 index 120d0557ae42..000000000000 --- a/reference/geoip/functions/geoip-database-info.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - geoip_database_info - Get GeoIP Database information - - - &reftitle.description; - - stringgeoip_database_info - intdatabaseGEOIP_COUNTRY_EDITION - - - - The geoip_database_info function returns the corresponding - GeoIP Database version as it is defined inside the binary file. - - - - If this function is called without arguments, it returns the version - of the GeoIP Free Country Edition. - - - - - &reftitle.parameters; - - - database - - - The database type as an integer. You can use the - various constants defined with - this extension (ie: GEOIP_*_EDITION). - - - - - - - - &reftitle.returnvalues; - - Returns the corresponding database version, or &null; on error. - - - - - &reftitle.examples; - - A <function>geoip_database_info</function> example - - This will output information regarding the database. - - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/geoip/functions/geoip-db-avail.xml b/reference/geoip/functions/geoip-db-avail.xml deleted file mode 100644 index 583b6d665bb1..000000000000 --- a/reference/geoip/functions/geoip-db-avail.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - geoip_db_avail - Determine if GeoIP Database is available - - - &reftitle.description; - - boolgeoip_db_avail - intdatabase - - - - The geoip_db_avail function returns if the corresponding - GeoIP Database is available and can be opened on disk. - - - - It does not indicate if the file is a proper database, only if it is readable. - - - - - &reftitle.parameters; - - - database - - - The database type as an integer. You can use the - various constants defined with - this extension (ie: GEOIP_*_EDITION). - - - - - - - - &reftitle.returnvalues; - - Returns &true; is database exists, &false; if not found, or &null; on error. - - - - - &reftitle.examples; - - A <function>geoip_db_avail</function> example - - This will output the current database version string. - - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/geoip/functions/geoip-db-filename.xml b/reference/geoip/functions/geoip-db-filename.xml deleted file mode 100644 index 39eaae631272..000000000000 --- a/reference/geoip/functions/geoip-db-filename.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - geoip_db_filename - Returns the filename of the corresponding GeoIP Database - - - &reftitle.description; - - stringgeoip_db_filename - intdatabase - - - - The geoip_db_filename function returns the filename of - the corresponding GeoIP Database. - - - - It does not indicate if the file exists or not on disk, only where the library - is looking for the database. - - - - - &reftitle.parameters; - - - database - - - The database type as an integer. You can use the - various constants defined with - this extension (ie: GEOIP_*_EDITION). - - - - - - - - &reftitle.returnvalues; - - Returns the filename of the corresponding database, or &null; on error. - - - - - &reftitle.examples; - - A <function>geoip_db_filename</function> example - - This will output the filename of the corresponding database. - - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/geoip/functions/geoip-db-get-all-info.xml b/reference/geoip/functions/geoip-db-get-all-info.xml deleted file mode 100644 index bbdab2b2c86d..000000000000 --- a/reference/geoip/functions/geoip-db-get-all-info.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - geoip_db_get_all_info - Returns detailed information about all GeoIP database types - - - &reftitle.description; - - arraygeoip_db_get_all_info - - - - - The geoip_db_get_all_info function will return - detailed information as a multi-dimensional array about all the - GeoIP database types. - - - This function is available even if no databases are installed. It - will simply list them as non-available. - - - The names of the different keys of the returning associative array are as follows: - - - - - "available" -- Boolean, indicate if DB is available (see - geoip_db_avail) - - - - - "description" -- The database description - - - - - "filename" -- The database filename on disk (see - geoip_db_filename) - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the associative array. - - - - - &reftitle.examples; - - A <function>geoip_db_get_all_info</function> example - - This will print the array containing all the information. - - - -]]> - - &example.outputs; - - - array(3) { - ["available"]=> - bool(true) - ["description"]=> - string(21) "GeoIP Country Edition" - ["filename"]=> - string(32) "/usr/share/GeoIP/GeoIP.dat" - } - -[ ... ] - - [11]=> - array(3) { - ["available"]=> - bool(false) - ["description"]=> - string(25) "GeoIP Domain Name Edition" - ["filename"]=> - string(38) "/usr/share/GeoIP/GeoIPDomain.dat" - } -} -]]> - - - - - A <function>geoip_db_get_all_info</function> example - - You can use the various constants as keys to get only parts of the information. - - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/geoip/functions/geoip-domain-by-name.xml b/reference/geoip/functions/geoip-domain-by-name.xml deleted file mode 100644 index 5884d9e0526d..000000000000 --- a/reference/geoip/functions/geoip-domain-by-name.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - geoip_domain_by_name - Get the second level domain name - - - &reftitle.description; - - stringgeoip_domain_by_name - stringhostname - - - - The geoip_domain_by_name function will return the second level - domain names associated with a hostname or an IP address. - - - This function is currently only available to users who have bought a commercial - GeoIP Domain Edition. A warning will be issued if the proper database cannot be - located. - - - - - &reftitle.parameters; - - - hostname - - - The hostname or IP address. - - - - - - - &reftitle.returnvalues; - - Returns the domain name on success, or &false; if the address - cannot be found in the database. - - - - - &reftitle.examples; - - A <function>geoip_domain_by_name</function> example - - This will output the domain associated with IP 61.106.139.1. - - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/geoip/functions/geoip-id-by-name.xml b/reference/geoip/functions/geoip-id-by-name.xml deleted file mode 100644 index 363601c710cb..000000000000 --- a/reference/geoip/functions/geoip-id-by-name.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - geoip_id_by_name - Get the Internet connection type - - - &reftitle.description; - - intgeoip_id_by_name - stringhostname - - - - The geoip_id_by_name function will return the Internet - connection type corresponding to a hostname or an IP address. - - - The return value is numeric and can be compared to the following constants: - - - - - GEOIP_UNKNOWN_SPEED - - - - - GEOIP_DIALUP_SPEED - - - - - GEOIP_CABLEDSL_SPEED - - - - - GEOIP_CORPORATE_SPEED - - - - - - - &reftitle.parameters; - - - hostname - - - The hostname or IP address whose connection type is to be looked-up. - - - - - - - &reftitle.returnvalues; - - Returns the connection type. - - - - - &reftitle.examples; - - A <function>geoip_id_by_name</function> example - - This will output the connection type of the host example.com. - - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/geoip/functions/geoip-isp-by-name.xml b/reference/geoip/functions/geoip-isp-by-name.xml deleted file mode 100644 index 8106353071a5..000000000000 --- a/reference/geoip/functions/geoip-isp-by-name.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - geoip_isp_by_name - Get the Internet Service Provider (ISP) name - - - &reftitle.description; - - stringgeoip_isp_by_name - stringhostname - - - - The geoip_isp_by_name function will return the name of - the Internet Service Provider (ISP) that an IP is assigned to. - - - This function is currently only available to users who have bought a commercial - GeoIP ISP Edition. A warning will be issued if the proper database cannot be - located. - - - - - &reftitle.parameters; - - - hostname - - - The hostname or IP address. - - - - - - - &reftitle.returnvalues; - - Returns the ISP name on success, or &false; if the address - cannot be found in the database. - - - - - &reftitle.examples; - - A <function>geoip_isp_by_name</function> example - - This will print the ISP name of host example.com. - - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/geoip/functions/geoip-netspeedcell-by-name.xml b/reference/geoip/functions/geoip-netspeedcell-by-name.xml deleted file mode 100644 index f71ac261f8d0..000000000000 --- a/reference/geoip/functions/geoip-netspeedcell-by-name.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - geoip_netspeedcell_by_name - Get the Internet connection speed - - - &reftitle.description; - - stringgeoip_netspeedcell_by_name - stringhostname - - - - The geoip_netspeedcell_by_name function will return the Internet - connection type and speed corresponding to a hostname or an IP address. - - - This function is only available if using GeoIP Library version 1.4.8 or newer. - - - This function is currently only available to users who have bought a commercial - GeoIP NetSpeedCell Edition. A warning will be issued if the proper database cannot be - located. - - - The return value is a string, common values are: - - - - - Cable/DSL - - - - - Dialup - - - - - Cellular - - - - - Corporate - - - - - - - &reftitle.parameters; - - - hostname - - - The hostname or IP address. - - - - - - - &reftitle.returnvalues; - - Returns the connection speed on success, or &false; if the address - cannot be found in the database. - - - - - &reftitle.examples; - - A <function>geoip_netspeedcell_by_name</function> example - - This will output the connection speed of the host example.com. - - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/geoip/functions/geoip-org-by-name.xml b/reference/geoip/functions/geoip-org-by-name.xml deleted file mode 100644 index db7be7ae375a..000000000000 --- a/reference/geoip/functions/geoip-org-by-name.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - geoip_org_by_name - Get the organization name - - - &reftitle.description; - - stringgeoip_org_by_name - stringhostname - - - - The geoip_org_by_name function will return the name of - the organization that an IP is assigned to. - - - This function is currently only available to users who have bought a commercial - GeoIP Organization, ISP or AS Edition. A warning will be issued if the proper - database cannot be located. - - - - - &reftitle.parameters; - - - hostname - - - The hostname or IP address. - - - - - - - &reftitle.returnvalues; - - Returns the organization name on success, or &false; if the address - cannot be found in the database. - - - - - &reftitle.examples; - - A <function>geoip_org_by_name</function> example - - This will print to whom the host example.com IP is allocated. - - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/geoip/functions/geoip-record-by-name.xml b/reference/geoip/functions/geoip-record-by-name.xml deleted file mode 100644 index 73fbef3dd345..000000000000 --- a/reference/geoip/functions/geoip-record-by-name.xml +++ /dev/null @@ -1,198 +0,0 @@ - - - - - geoip_record_by_name - Returns the detailed City information found in the GeoIP Database - - - &reftitle.description; - - arraygeoip_record_by_name - stringhostname - - - - The geoip_record_by_name function will return the - record information corresponding to a hostname or an IP address. - - - This function is available for both GeoLite City Edition and commercial GeoIP - City Edition. A warning will be issued if the proper database cannot be - located. - - - The names of the different keys of the returning associative array are as follows: - - - - - "continent_code" -- Two letter continent code (as of version 1.0.4 with - libgeoip 1.4.3 or newer) - - - - - "country_code" -- Two letter country code (see - geoip_country_code_by_name) - - - - - "country_code3" -- Three letter country code (see - geoip_country_code3_by_name) - - - - - "country_name" -- The country name (see - geoip_country_name_by_name) - - - - - "region" -- The region code (ex: CA for California) - - - - - "city" -- The city. - - - - - "postal_code" -- The Postal Code, FSA or Zip Code. - - - - - "latitude" -- The Latitude as signed float. - - - - - "longitude" -- The Longitude as signed float. - - - - - "dma_code" -- Designated Market Area code (USA and Canada only) - - - - - "area_code" -- The PSTN area code (ex: 212) - - - - - - - &reftitle.parameters; - - - hostname - - - The hostname or IP address whose record is to be looked-up. - - - - - - - &reftitle.returnvalues; - - Returns the associative array on success, or &false; if the address - cannot be found in the database. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL geoip 1.0.4 - - Adding the continent_code with GeoIP Library 1.4.3 or newer only - - - - PECL geoip 1.0.3 - - Adding country_code3 and country_name - - - - - - - - - &reftitle.examples; - - A <function>geoip_record_by_name</function> example - - This will print the array containing the record of host example.com. - - - -]]> - - &example.outputs; - - NA - [country_code] => US - [country_code3] => USA - [country_name] => United States - [region] => CA - [city] => Marina Del Rey - [postal_code] => - [latitude] => 33.9776992798 - [longitude] => -118.435096741 - [dma_code] => 803 - [area_code] => 310 -) -]]> - - - - - - diff --git a/reference/geoip/functions/geoip-region-by-name.xml b/reference/geoip/functions/geoip-region-by-name.xml deleted file mode 100644 index af298dae66d4..000000000000 --- a/reference/geoip/functions/geoip-region-by-name.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - geoip_region_by_name - Get the country code and region - - - &reftitle.description; - - arraygeoip_region_by_name - stringhostname - - - - The geoip_region_by_name function will return the country - and region corresponding to a hostname or an IP address. - - - This function is currently only available to users who have bought a commercial - GeoIP Region Edition. A warning will be issued if the proper database cannot be - located. - - - The names of the different keys of the returning associative array are as follows: - - - - - "country_code" -- Two letter country code (see - geoip_country_code_by_name) - - - - - "region" -- The region code (ex: CA for California) - - - - - - &reftitle.parameters; - - - hostname - - - The hostname or IP address whose region is to be looked-up. - - - - - - - &reftitle.returnvalues; - - Returns the associative array on success, or &false; if the address - cannot be found in the database. - - - - - &reftitle.examples; - - A <function>geoip_region_by_name</function> example - - This will print the array containing the country code and region - of the host example.com. - - - -]]> - - &example.outputs; - - US - [region] => CA -) -]]> - - - - - - diff --git a/reference/geoip/functions/geoip-region-name-by-code.xml b/reference/geoip/functions/geoip-region-name-by-code.xml deleted file mode 100644 index 73b203bc60a2..000000000000 --- a/reference/geoip/functions/geoip-region-name-by-code.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - geoip_region_name_by_code - Returns the region name for some country and region code combo - - - &reftitle.description; - - stringgeoip_region_name_by_code - stringcountry_code - stringregion_code - - - - The geoip_region_name_by_code function will return the region - name corresponding to a country and region code combo. - - - In the United States, the region code corresponds to the two-letter abbreviation - of each state. In Canada, the region code corresponds to the two-letter province or - territory code as attributed by Canada Post. - - - For the rest of the world, GeoIP uses FIPS 10-4 codes to represent regions. - You can check &url.maxmind.fips; - for a detailed list of FIPS 10-4 codes. - - - This function is always available if using GeoIP Library version 1.4.1 or newer. The - data is taken directly from the GeoIP Library and not from any database. - - - - &reftitle.parameters; - - - country_code - - - The two-letter country code (see - geoip_country_code_by_name) - - - - - region_code - - - The two-letter (or digit) region code (see - geoip_region_by_name) - - - - - - - &reftitle.returnvalues; - - Returns the region name on success, or &false; if the country and region code - combo cannot be found. - - - - - &reftitle.examples; - - - A <function>geoip_region_name_by_code</function> example using region code for US/Canada - - This will print the region name for country CA (Canada), region QC (Quebec). - - - -]]> - - &example.outputs; - - - - - - A <function>geoip_region_name_by_code</function> example using FIPS codes - - This will print the region name for country JP (Japan), region 01. - - - -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/geoip/functions/geoip-setup-custom-directory.xml b/reference/geoip/functions/geoip-setup-custom-directory.xml deleted file mode 100644 index 734c05adfee5..000000000000 --- a/reference/geoip/functions/geoip-setup-custom-directory.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - geoip_setup_custom_directory - Set a custom directory for the GeoIP database - - - &reftitle.description; - - voidgeoip_setup_custom_directory - stringpath - - - - The geoip_setup_custom_directory function will change the - default directory of the GeoIP database. This is equivalent to changing - geoip.custom_directory. - - - - - &reftitle.parameters; - - - path - - - The full path of where the GeoIP database is on disk. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - A <function>geoip_setup_custom_directory</function> example - - This will change the GeoIP default database path. - - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/geoip/functions/geoip-time-zone-by-country-and-region.xml b/reference/geoip/functions/geoip-time-zone-by-country-and-region.xml deleted file mode 100644 index 9aa2eedd4572..000000000000 --- a/reference/geoip/functions/geoip-time-zone-by-country-and-region.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - geoip_time_zone_by_country_and_region - Returns the time zone for some country and region code combo - - - &reftitle.description; - - stringgeoip_time_zone_by_country_and_region - stringcountry_code - stringregion_code - - - - The geoip_time_zone_by_country_and_region function will return the - time zone corresponding to a country and region code combo. - - - In the United States, the region code corresponds to the two-letter abbreviation - of each state. In Canada, the region code corresponds to the two-letter province or - territory code as attributed by Canada Post. - - - For the rest of the world, GeoIP uses FIPS 10-4 codes to represent regions. - You can check &url.maxmind.fips; - for a detailed list of FIPS 10-4 codes. - - - This function is always available if using GeoIP Library version 1.4.1 or newer. The - data is taken directly from the GeoIP Library and not from any database. - - - - &reftitle.parameters; - - - country_code - - - The two-letter country code (see - geoip_country_code_by_name) - - - - - region_code - - - The two-letter (or digit) region code (see - geoip_region_by_name) - - - - - - - &reftitle.returnvalues; - - Returns the time zone on success, or &false; if the country and region code - combo cannot be found. - - - - - &reftitle.examples; - - - A <function>geoip_time_zone_by_country_and_region</function> example using region code for US/Canada - - This will print the time zone for country CA (Canada), region QC (Quebec). - - - -]]> - - &example.outputs; - - - - - - A <function>geoip_time_zone_by_country_and_region</function> example using FIPS codes - - This will print the time zone for country JP (Japan), region 01 (Aichi). - - - -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/geoip/ini.xml b/reference/geoip/ini.xml deleted file mode 100644 index 55b05fb15fb8..000000000000 --- a/reference/geoip/ini.xml +++ /dev/null @@ -1,43 +0,0 @@ - - -
- &reftitle.runtime; - &extension.runtime; - - GeoIP &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - geoip.custom_directory - "" - INI_ALL - - - - -
- - &ini.descriptions.title; - - - - - geoip.custom_directory - string - - - - Empty by default, but can be set to force a different database path than the one compiled in the library. - - - - -
diff --git a/reference/geoip/reference.xml b/reference/geoip/reference.xml deleted file mode 100644 index 2440b29cba35..000000000000 --- a/reference/geoip/reference.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - GeoIP &Functions; - &reference.geoip.entities.functions; - - - - diff --git a/reference/geoip/setup.xml b/reference/geoip/setup.xml deleted file mode 100644 index 9b3f8dc77f69..000000000000 --- a/reference/geoip/setup.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - &reftitle.setup; - -
- &reftitle.required; - - This extension requires the GeoIP C library version 1.4.0 or higher to be - installed. You can grab the latest version from - &url.maxmind.geoip; - and compile it yourself. - - - By default, you will only have access to the Free GeoIP Country or GeoLite - City databases. While this module can work with other types of database, - you must buy a commercial license from - Maxmind. - -
- -
- &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;geoip. - -
- - &reference.geoip.ini; - -
- diff --git a/reference/geoip/versions.xml b/reference/geoip/versions.xml deleted file mode 100644 index 2fd8c5033545..000000000000 --- a/reference/geoip/versions.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/gmagick/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/gmagick/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/gmagick/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/gmagick/book.xml b/reference/gmagick/book.xml deleted file mode 100644 index 74578b226a01..000000000000 --- a/reference/gmagick/book.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - Gmagick - Gmagick - - - &reftitle.intro; - &warn.experimental; - - Gmagick is a php extension to create, modify and obtain meta information of images using the GraphicsMagick API. - - - GraphicsMagick prides itself as the swiss army knife of image processing. It works with over 88 major formats - including important formats like DPX, GIF, JPEG, JPEG-2000, PNG, PDF, PNM, and TIFF. - - - Gmagick consists of a main Gmagick class, a GmagickDraw class which is in effect a drawing wand and a - GmagickPixel class of which instances represent a single pixel of an image (color, opacity). - - - - &reference.gmagick.setup; - &reference.gmagick.constants; - &reference.gmagick.examples; - &reference.gmagick.gmagick; - &reference.gmagick.gmagickdraw; - &reference.gmagick.gmagickpixel; - &reference.gmagick.gmagickexception; - &reference.gmagick.gmagickpixelexception; - - diff --git a/reference/gmagick/constants.xml b/reference/gmagick/constants.xml deleted file mode 100644 index 047d80486ad1..000000000000 --- a/reference/gmagick/constants.xml +++ /dev/null @@ -1,3127 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - Colortype constants - - - Gmagick::COLOR_BLACK - (int) - - - - Black - - - - - - Gmagick::COLOR_BLUE - (int) - - - - Blue - - - - - - Gmagick::COLOR_CYAN - (int) - - - - Cyan - - - - - - Gmagick::COLOR_GREEN - (int) - - - - Green - - - - - - Gmagick::COLOR_RED - (int) - - - - Red - - - - - - Gmagick::COLOR_YELLOW - (int) - - - - Yellow - - - - - - Gmagick::COLOR_MAGENTA - (int) - - - - Magenta - - - - - - Gmagick::COLOR_OPACITY - (int) - - - - Opacity - - - - - - Gmagick::COLOR_ALPHA - (int) - - - - Alpha - - - - - - Gmagick::COLOR_FUZZ - (int) - - - - Fuzz - - - - - - Composite Operator Constants - - - Gmagick::COMPOSITE_DEFAULT - (int) - - - - The default composite operator - - - - - - Gmagick::COMPOSITE_UNDEFINED - (int) - - - - Undefined composite operator - - - - - - Gmagick::COMPOSITE_NO - (int) - - - - No composite operator defined - - - - - - Gmagick::COMPOSITE_ADD - (int) - - - - The result of image + image - - - - - - Gmagick::COMPOSITE_ATOP - (int) - - - - The result is the same shape as image, with composite image obscuring image where the image shapes overlap - - - - - - Gmagick::COMPOSITE_BLEND - (int) - - - - Blends the image - - - - - - Gmagick::COMPOSITE_BUMPMAP - (int) - - - - The same as COMPOSITE_MULTIPLY, except the source is converted to grayscale first. - - - - - - Gmagick::COMPOSITE_CLEAR - (int) - - - - Makes the target image transparent - - - - - - Gmagick::COMPOSITE_COLORBURN - (int) - - - - Darkens the destination image to reflect the source image - - - - - - Gmagick::COMPOSITE_COLORDODGE - (int) - - - - Brightens the destination image to reflect the source image - - - - - - Gmagick::COMPOSITE_COLORIZE - (int) - - - - Colorizes the target image using the composite image - - - - - - Gmagick::COMPOSITE_COPYBLACK - (int) - - - - Copies black from the source to target - - - - - - Gmagick::COMPOSITE_COPYBLUE - (int) - - - - Copies blue from the source to target - - - - - - Gmagick::COMPOSITE_COPY - (int) - - - - Copies the source image on the target image - - - - - - Gmagick::COMPOSITE_COPYCYAN - (int) - - - - Copies cyan from the source to target - - - - - - Gmagick::COMPOSITE_COPYGREEN - (int) - - - - Copies green from the source to target - - - - - - Gmagick::COMPOSITE_COPYMAGENTA - (int) - - - - Copies magenta from the source to target - - - - - - Gmagick::COMPOSITE_COPYOPACITY - (int) - - - - Copies opacity from the source to target - - - - - - Gmagick::COMPOSITE_COPYRED - (int) - - - - Copies red from the source to target - - - - - - Gmagick::COMPOSITE_COPYYELLOW - (int) - - - - Copies yellow from the source to target - - - - - - Gmagick::COMPOSITE_DARKEN - (int) - - - - Darkens the target image - - - - - - Gmagick::COMPOSITE_DSTATOP - (int) - - - - The part of the destination lying inside of the source is composited over the source and replaces the destination - - - - - - Gmagick::COMPOSITE_DST - (int) - - - - The target is left untouched - - - - - - Gmagick::COMPOSITE_DSTIN - (int) - - - - The parts inside the source replace the target - - - - - - Gmagick::COMPOSITE_DSTOUT - (int) - - - - The parts outside the source replace the target - - - - - - Gmagick::COMPOSITE_DSTOVER - (int) - - - - Target replaces the source - - - - - - Gmagick::COMPOSITE_DIFFERENCE - (int) - - - - Subtracts the darker of the two constituent colors from the lighter - - - - - - Gmagick::COMPOSITE_DISPLACE - (int) - - - - Shifts target image pixels as defined by the source - - - - - - Gmagick::COMPOSITE_DISSOLVE - (int) - - - - Dissolves the source in to the target - - - - - - Gmagick::COMPOSITE_EXCLUSION - (int) - - - - Produces an effect similar to that of Gmagick::COMPOSITE_DIFFERENCE, but appears as lower contrast - - - - - - Gmagick::COMPOSITE_HARDLIGHT - (int) - - - - Multiplies or screens the colors, dependent on the source color value - - - - - - Gmagick::COMPOSITE_HUE - (int) - - - - Modifies the hue of the target as defined by source - - - - - - Gmagick::COMPOSITE_IN - (int) - - - - Composites source into the target - - - - - - Gmagick::COMPOSITE_LIGHTEN - (int) - - - - Lightens the target as defined by source - - - - - - Gmagick::COMPOSITE_LUMINIZE - (int) - - - - Luminizes the target as defined by source - - - - - - Gmagick::COMPOSITE_MINUS - (int) - - - - Subtracts the source from the target - - - - - - Gmagick::COMPOSITE_MODULATE - (int) - - - - Modulates the target brightness, saturation and hue as defined by source - - - - - - Gmagick::COMPOSITE_MULTIPLY - (int) - - - - Multiplies the target to the source - - - - - - Gmagick::COMPOSITE_OUT - (int) - - - - Composites outer parts of the source on the target - - - - - - Gmagick::COMPOSITE_OVER - (int) - - - - Composites source over the target - - - - - - Gmagick::COMPOSITE_OVERLAY - (int) - - - - Overlays the source on the target - - - - - - Gmagick::COMPOSITE_PLUS - (int) - - - - Adds the source to the target - - - - - - Gmagick::COMPOSITE_REPLACE - (int) - - - - Replaces the target with the source - - - - - - Gmagick::COMPOSITE_SATURATE - (int) - - - - Saturates the target as defined by the source - - - - - - Gmagick::COMPOSITE_SCREEN - (int) - - - - The source and destination are complemented and then multiplied and then replace the destination - - - - - - Gmagick::COMPOSITE_SOFTLIGHT - (int) - - - - Darkens or lightens the colors, dependent on the source - - - - - - Gmagick::COMPOSITE_SRCATOP - (int) - - - - The part of the source lying inside of the destination is composited onto the destination - - - - - - Gmagick::COMPOSITE_SRC - (int) - - - - The source is copied to the destination - - - - - - Gmagick::COMPOSITE_SRCIN - (int) - - - - The part of the source lying inside of the destination replaces the destination - - - - - - Gmagick::COMPOSITE_SRCOUT - (int) - - - - The part of the source lying outside of the destination replaces the destination - - - - - - Gmagick::COMPOSITE_SRCOVER - (int) - - - - The source replaces the destination - - - - - - Gmagick::COMPOSITE_SUBTRACT - (int) - - - - Subtract the colors in the source image from the destination image - - - - - - Gmagick::COMPOSITE_THRESHOLD - (int) - - - - The source is composited on the target as defined by source threshold - - - - - - Gmagick::COMPOSITE_XOR - (int) - - - - The part of the source that lies outside of the destination is combined with the part of the destination that lies outside of the source - - - - - - Montage Mode constants - - - Gmagick::MONTAGEMODE_FRAME - (int) - - - - - - - - - - Gmagick::MONTAGEMODE_UNFRAME - (int) - - - - - - - - - - Gmagick::MONTAGEMODE_CONCATENATE - (int) - - - - - - - - - - Style constants - - - Gmagick::STYLE_NORMAL - (int) - - - - - - - - - - Gmagick::STYLE_ITALIC - (int) - - - - - - - - - - Gmagick::STYLE_OBLIQUE - (int) - - - - - - - - - - Gmagick::STYLE_ANY - (int) - - - - - - - - - - Filter constants - - - Gmagick::FILTER_UNDEFINED - (int) - - - - - - - - - - Gmagick::FILTER_POINT - (int) - - - - - - - - - - Gmagick::FILTER_BOX - (int) - - - - - - - - - - Gmagick::FILTER_TRIANGLE - (int) - - - - - - - - - - Gmagick::FILTER_HERMITE - (int) - - - - - - - - - - Gmagick::FILTER_HANNING - (int) - - - - - - - - - - Gmagick::FILTER_HAMMING - (int) - - - - - - - - - - Gmagick::FILTER_BLACKMAN - (int) - - - - - - - - - - Gmagick::FILTER_GAUSSIAN - (int) - - - - - - - - - - Gmagick::FILTER_QUADRATIC - (int) - - - - - - - - - - Gmagick::FILTER_CUBIC - (int) - - - - - - - - - - Gmagick::FILTER_CATROM - (int) - - - - - - - - - - Gmagick::FILTER_MITCHELL - (int) - - - - - - - - - - Gmagick::FILTER_LANCZOS - (int) - - - - - - - - - - Gmagick::FILTER_BESSEL - (int) - - - - - - - - - - Gmagick::FILTER_SINC - (int) - - - - - - - - - - Image type constants - - - Gmagick::IMGTYPE_UNDEFINED - (int) - - - - - - - - - - Gmagick::IMGTYPE_BILEVEL - (int) - - - - - - - - - - Gmagick::IMGTYPE_GRAYSCALE - (int) - - - - - - - - - - Gmagick::IMGTYPE_GRAYSCALEMATTE - (int) - - - - - - - - - - Gmagick::IMGTYPE_PALETTE - (int) - - - - - - - - - - Gmagick::IMGTYPE_PALETTEMATTE - (int) - - - - - - - - - - Gmagick::IMGTYPE_TRUECOLOR - (int) - - - - - - - - - - Gmagick::IMGTYPE_TRUECOLORMATTE - (int) - - - - - - - - - - Gmagick::IMGTYPE_COLORSEPARATION - (int) - - - - - - - - - - Gmagick::IMGTYPE_COLORSEPARATIONMATTE - (int) - - - - - - - - - - Gmagick::IMGTYPE_OPTIMIZE - (int) - - - - - - - - - - Resolution constants - - - Gmagick::RESOLUTION_UNDEFINED - (int) - - - - - - - - - - Gmagick::RESOLUTION_PIXELSPERINCH - (int) - - - - - - - - - - Gmagick::RESOLUTION_PIXELSPERCENTIMETER - (int) - - - - - - - - - - Compression constants - - - Gmagick::COMPRESSION_UNDEFINED - (int) - - - - - - - - - - Gmagick::COMPRESSION_NO - (int) - - - - - - - - - - Gmagick::COMPRESSION_BZIP - (int) - - - - - - - - - - Gmagick::COMPRESSION_FAX - (int) - - - - - - - - - - Gmagick::COMPRESSION_GROUP4 - (int) - - - - - - - - - - Gmagick::COMPRESSION_JPEG - (int) - - - - - - - - - - Gmagick::COMPRESSION_JPEG2000 - (int) - - - - - - - - - - Gmagick::COMPRESSION_LOSSLESSJPEG - (int) - - - - - - - - - - Gmagick::COMPRESSION_LZW - (int) - - - - - - - - - - Gmagick::COMPRESSION_RLE - (int) - - - - - - - - - - Gmagick::COMPRESSION_ZIP - (int) - - - - - - - - - - Paint constants - - - Gmagick::PAINT_POINT - (int) - - - - - - - - - - Gmagick::PAINT_REPLACE - (int) - - - - - - - - - - Gmagick::PAINT_FLOODFILL - (int) - - - - - - - - - - Gmagick::PAINT_FILLTOBORDER - (int) - - - - - - - - - - Gmagick::PAINT_RESET - (int) - - - - - - - - - - Gravity constants - - - Gmagick::GRAVITY_NORTHWEST - (int) - - - - - - - - - - Gmagick::GRAVITY_NORTH - (int) - - - - - - - - - - Gmagick::GRAVITY_NORTHEAST - (int) - - - - - - - - - - Gmagick::GRAVITY_WEST - (int) - - - - - - - - - - Gmagick::GRAVITY_CENTER - (int) - - - - - - - - - - Gmagick::GRAVITY_EAST - (int) - - - - - - - - - - Gmagick::GRAVITY_SOUTHWEST - (int) - - - - - - - - - - Gmagick::GRAVITY_SOUTH - (int) - - - - - - - - - - Gmagick::GRAVITY_SOUTHEAST - (int) - - - - - - - - - - Stretch constants - - - Gmagick::STRETCH_NORMAL - (int) - - - - - - - - - - Gmagick::STRETCH_ULTRACONDENSED - (int) - - - - - - - - - - Gmagick::STRETCH_CONDENSED - (int) - - - - - - - - - - Gmagick::STRETCH_SEMICONDENSED - (int) - - - - - - - - - - Gmagick::STRETCH_SEMIEXPANDED - (int) - - - - - - - - - - Gmagick::STRETCH_EXPANDED - (int) - - - - - - - - - - Gmagick::STRETCH_EXTRAEXPANDED - (int) - - - - - - - - - - Gmagick::STRETCH_ULTRAEXPANDED - (int) - - - - - - - - - - Gmagick::STRETCH_ANY - (int) - - - - - - - - - - Align constants - - - Gmagick::ALIGN_UNDEFINED - (int) - - - - - - - - - - Gmagick::ALIGN_LEFT - (int) - - - - - - - - - - Gmagick::ALIGN_CENTER - (int) - - - - - - - - - - Gmagick::ALIGN_RIGHT - (int) - - - - - - - - - - Decoration constants - - - Gmagick::DECORATION_NO - (int) - - - - - - - - - - Gmagick::DECORATION_UNDERLINE - (int) - - - - - - - - - - Gmagick::DECORATION_OVERLINE - (int) - - - - - - - - - - Gmagick::DECORATION_LINETROUGH - (int) - - - - - - - - - - Noise constants - - - Gmagick::NOISE_UNIFORM - (int) - - - - - - - - - - Gmagick::NOISE_GAUSSIAN - (int) - - - - - - - - - - Gmagick::NOISE_MULTIPLICATIVEGAUSSIAN - (int) - - - - - - - - - - Gmagick::NOISE_IMPULSE - (int) - - - - - - - - - - Gmagick::NOISE_LAPLACIAN - (int) - - - - - - - - - - Gmagick::NOISE_POISSON - (int) - - - - - - - - - - Channel constants - - - Gmagick::CHANNEL_UNDEFINED - (int) - - - - - - - - - - Gmagick::CHANNEL_RED - (int) - - - - - - - - - - Gmagick::CHANNEL_GRAY - (int) - - - - - - - - - - Gmagick::CHANNEL_CYAN - (int) - - - - - - - - - - Gmagick::CHANNEL_GREEN - (int) - - - - - - - - - - Gmagick::CHANNEL_MAGENTA - (int) - - - - - - - - - - Gmagick::CHANNEL_BLUE - (int) - - - - - - - - - - Gmagick::CHANNEL_YELLOW - (int) - - - - - - - - - - Gmagick::CHANNEL_ALPHA - (int) - - - - - - - - - - Gmagick::CHANNEL_OPACITY - (int) - - - - - - - - - - Gmagick::CHANNEL_MATTE - (int) - - - - - - - - - - Gmagick::CHANNEL_BLACK - (int) - - - - - - - - - - Gmagick::CHANNEL_INDEX - (int) - - - - - - - - - - Gmagick::CHANNEL_ALL - (int) - - - - - - - - - - Metric constants - - - Gmagick::METRIC_UNDEFINED - (int) - - - - - - - - - - Gmagick::METRIC_MEANABSOLUTEERROR - (int) - - - - - - - - - - Gmagick::METRIC_MEANSQUAREERROR - (int) - - - - - - - - - - Gmagick::METRIC_PEAKABSOLUTEERROR - (int) - - - - - - - - - - Gmagick::METRIC_PEAKSIGNALTONOISERATIO - (int) - - - - - - - - - - Gmagick::METRIC_ROOTMEANSQUAREDERROR - (int) - - - - - - - - - - Pixel constants - - - Gmagick::PIXEL_CHAR - (int) - - - - - - - - - - Gmagick::PIXEL_DOUBLE - (int) - - - - - - - - - - Gmagick::PIXEL_FLOAT - (int) - - - - - - - - - - Gmagick::PIXEL_INTEGER - (int) - - - - - - - - - - Gmagick::PIXEL_LONG - (int) - - - - - - - - - - Gmagick::PIXEL_QUANTUM - (int) - - - - - - - - - - Gmagick::PIXEL_SHORT - (int) - - - - - - - - - - Colorspace constants - - - Gmagick::COLORSPACE_UNDEFINED - (int) - - - - - - - - - - Gmagick::COLORSPACE_RGB - (int) - - - - - - - - - - Gmagick::COLORSPACE_GRAY - (int) - - - - - - - - - - Gmagick::COLORSPACE_TRANSPARENT - (int) - - - - - - - - - - Gmagick::COLORSPACE_OHTA - (int) - - - - - - - - - - Gmagick::COLORSPACE_LAB - (int) - - - - - - - - - - Gmagick::COLORSPACE_XYZ - (int) - - - - - - - - - - Gmagick::COLORSPACE_YCBCR - (int) - - - - - - - - - - Gmagick::COLORSPACE_YCC - (int) - - - - - - - - - - Gmagick::COLORSPACE_YIQ - (int) - - - - - - - - - - Gmagick::COLORSPACE_YPBPR - (int) - - - - - - - - - - Gmagick::COLORSPACE_YUV - (int) - - - - - - - - - - Gmagick::COLORSPACE_CMYK - (int) - - - - - - - - - - Gmagick::COLORSPACE_SRGB - (int) - - - - - - - - - - Gmagick::COLORSPACE_HSB - (int) - - - - - - - - - - Gmagick::COLORSPACE_HSL - (int) - - - - - - - - - - Gmagick::COLORSPACE_HWB - (int) - - - - - - - - - - Gmagick::COLORSPACE_REC601LUMA - (int) - - - - - - - - - - Gmagick::COLORSPACE_REC709LUMA - (int) - - - - - - - - - - Gmagick::COLORSPACE_LOG - (int) - - - - - - - - - - Virtual Pixel Method constants - - - Gmagick::VIRTUALPIXELMETHOD_UNDEFINED - (int) - - - - - - - - - - Gmagick::VIRTUALPIXELMETHOD_BACKGROUND - (int) - - - - - - - - - - Gmagick::VIRTUALPIXELMETHOD_CONSTANT - (int) - - - - - - - - - - Gmagick::VIRTUALPIXELMETHOD_EDGE - (int) - - - - - - - - - - Gmagick::VIRTUALPIXELMETHOD_MIRROR - (int) - - - - - - - - - - Gmagick::VIRTUALPIXELMETHOD_TILE - (int) - - - - - - - - - - Gmagick::VIRTUALPIXELMETHOD_TRANSPARENT - (int) - - - - - - - - - - Preview constants - - - Gmagick::PREVIEW_UNDEFINED - (int) - - - - - - - - - - Gmagick::PREVIEW_ROTATE - (int) - - - - - - - - - - Gmagick::PREVIEW_SHEAR - (int) - - - - - - - - - - Gmagick::PREVIEW_ROLL - (int) - - - - - - - - - - Gmagick::PREVIEW_HUE - (int) - - - - - - - - - - Gmagick::PREVIEW_SATURATION - (int) - - - - - - - - - - Gmagick::PREVIEW_BRIGHTNESS - (int) - - - - - - - - - - Gmagick::PREVIEW_GAMMA - (int) - - - - - - - - - - Gmagick::PREVIEW_SPIFF - (int) - - - - - - - - - - Gmagick::PREVIEW_DULL - (int) - - - - - - - - - - Gmagick::PREVIEW_GRAYSCALE - (int) - - - - - - - - - - Gmagick::PREVIEW_QUANTIZE - (int) - - - - - - - - - - Gmagick::PREVIEW_DESPECKLE - (int) - - - - - - - - - - Gmagick::PREVIEW_REDUCENOISE - (int) - - - - - - - - - - Gmagick::PREVIEW_ADDNOISE - (int) - - - - - - - - - - Gmagick::PREVIEW_SHARPEN - (int) - - - - - - - - - - Gmagick::PREVIEW_BLUR - (int) - - - - - - - - - - Gmagick::PREVIEW_THRESHOLD - (int) - - - - - - - - - - Gmagick::PREVIEW_EDGEDETECT - (int) - - - - - - - - - - Gmagick::PREVIEW_SPREAD - (int) - - - - - - - - - - Gmagick::PREVIEW_SOLARIZE - (int) - - - - - - - - - - Gmagick::PREVIEW_SHADE - (int) - - - - - - - - - - Gmagick::PREVIEW_RAISE - (int) - - - - - - - - - - Gmagick::PREVIEW_SEGMENT - (int) - - - - - - - - - - Gmagick::PREVIEW_SWIRL - (int) - - - - - - - - - - Gmagick::PREVIEW_IMPLODE - (int) - - - - - - - - - - Gmagick::PREVIEW_WAVE - (int) - - - - - - - - - - Gmagick::PREVIEW_OILPAINT - (int) - - - - - - - - - - Gmagick::PREVIEW_CHARCOALDRAWING - (int) - - - - - - - - - - Gmagick::PREVIEW_JPEG - (int) - - - - - - - - - - Rendering Intent constants - - - Gmagick::RENDERINGINTENT_UNDEFINED - (int) - - - - - - - - - - Gmagick::RENDERINGINTENT_SATURATION - (int) - - - - - - - - - - Gmagick::RENDERINGINTENT_PERCEPTUAL - (int) - - - - - - - - - - Gmagick::RENDERINGINTENT_ABSOLUTE - (int) - - - - - - - - - - Gmagick::RENDERINGINTENT_RELATIVE - (int) - - - - - - - - - - Fillrule constants - - - Gmagick::FILLRULE_UNDEFINED - (int) - - - - - - - - - - Gmagick::FILLRULE_EVENODD - (int) - - - - - - - - - - Gmagick::FILLRULE_NONZERO - (int) - - - - - - - - - - Pathunit constants - - - Gmagick::PATHUNITS_UNDEFINED - (int) - - - - - - - - - - Gmagick::PATHUNITS_USERSPACE - (int) - - - - - - - - - - Gmagick::PATHUNITS_USERSPACEONUSE - (int) - - - - - - - - - - Gmagick::PATHUNITS_OBJECTBOUNDINGBOX - (int) - - - - - - - - - - Linecap constants - - - Gmagick::LINECAP_UNDEFINED - (int) - - - - - - - - - - Gmagick::LINECAP_BUTT - (int) - - - - - - - - - - Gmagick::LINECAP_ROUND - (int) - - - - - - - - - - Gmagick::LINECAP_SQUARE - (int) - - - - - - - - - - Line Join constants - - - Gmagick::LINEJOIN_UNDEFINED - (int) - - - - - - - - - - Gmagick::LINEJOIN_MITER - (int) - - - - - - - - - - Gmagick::LINEJOIN_ROUND - (int) - - - - - - - - - - Gmagick::LINEJOIN_BEVEL - (int) - - - - - - - - - - Resourcetype constants - - - Gmagick::RESOURCETYPE_UNDEFINED - (int) - - - - - - - - - - Gmagick::RESOURCETYPE_AREA - (int) - - - - - - - - - - Gmagick::RESOURCETYPE_DISK - (int) - - - - - - - - - - Gmagick::RESOURCETYPE_FILE - (int) - - - - - - - - - - Gmagick::RESOURCETYPE_MAP - (int) - - - - - - - - - - Gmagick::RESOURCETYPE_MEMORY - (int) - - - - - - - - - - Orientation constants - - - Gmagick::ORIENTATION_UNDEFINED - (int) - - - - - - - - - - Gmagick::ORIENTATION_TOPLEFT - (int) - - - - - - - - - - Gmagick::ORIENTATION_TOPRIGHT - (int) - - - - - - - - - - Gmagick::ORIENTATION_BOTTOMRIGHT - (int) - - - - - - - - - - Gmagick::ORIENTATION_BOTTOMLEFT - (int) - - - - - - - - - - Gmagick::ORIENTATION_LEFTTOP - (int) - - - - - - - - - - Gmagick::ORIENTATION_RIGHTTOP - (int) - - - - - - - - - - Gmagick::ORIENTATION_RIGHTBOTTOM - (int) - - - - - - - - - - Gmagick::ORIENTATION_LEFTBOTTOM - (int) - - - - - - - - - - Interlace constants - - - Gmagick::INTERLACE_UNDEFINED - (int) - - - - - - - - - - Gmagick::INTERLACE_NO - (int) - - - - - - - - - - Gmagick::INTERLACE_NONE - (int) - - - - - - - - - - Gmagick::INTERLACE_LINE - (int) - - - - - - - - - - Gmagick::INTERLACE_PLANE - (int) - - - - - - - - - - Gmagick::INTERLACE_PARTITION - (int) - - - - - - - - - - - - diff --git a/reference/gmagick/examples.xml b/reference/gmagick/examples.xml deleted file mode 100644 index 7c0b8097d5b3..000000000000 --- a/reference/gmagick/examples.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - &reftitle.examples; - - The following shows some common Gmagick image operations. - - - Gmagick Example - -thumbnailimage(100, 0); - -//Create a border around the image, then simulate how the image will look like as an oil painting -//Notice the chaining of mutator methods which is supported in gmagick -$image->borderimage("yellow", 8, 8)->oilpaintimage(0.3); - -//Write the current image at the current state to a file -$image->write('example_thumbnail.jpg'); -?> -]]> - - - - diff --git a/reference/gmagick/gmagick.xml b/reference/gmagick/gmagick.xml deleted file mode 100644 index 41a532f90df9..000000000000 --- a/reference/gmagick/gmagick.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - The Gmagick class - Gmagick - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - Gmagick - - - - - Gmagick - - - - &Methods; - - - - - -
-
- - &reference.gmagick.entities.gmagick; - -
- diff --git a/reference/gmagick/gmagick/addimage.xml b/reference/gmagick/gmagick/addimage.xml deleted file mode 100644 index e6f2d842c0e5..000000000000 --- a/reference/gmagick/gmagick/addimage.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - Gmagick::addimage - Adds new image to Gmagick object image list - - - - &reftitle.description; - - public GmagickGmagick::addimage - Gmagicksource - - - Adds new image to Gmagick object from the current position of the source object. After the operation iterator position is moved at the end of the list. - - - - - &reftitle.parameters; - - - source - - - The source Gmagick object - - - - - - - - &reftitle.returnvalues; - - The Gmagick object with image added - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/addnoiseimage.xml b/reference/gmagick/gmagick/addnoiseimage.xml deleted file mode 100644 index 615cb6f26955..000000000000 --- a/reference/gmagick/gmagick/addnoiseimage.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - Gmagick::addnoiseimage - Adds random noise to the image - - - - &reftitle.description; - - public GmagickGmagick::addnoiseimage - intnoise_type - - - Adds random noise to the image. - - - - - &reftitle.parameters; - - - noise_type - - - The type of the noise. Refer to this list of noise constants. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object with noise added. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/annotateimage.xml b/reference/gmagick/gmagick/annotateimage.xml deleted file mode 100644 index 8abdd094edde..000000000000 --- a/reference/gmagick/gmagick/annotateimage.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - Gmagick::annotateimage - Annotates an image with text - - - - &reftitle.description; - - public GmagickGmagick::annotateimage - GmagickDrawGmagickDraw - floatx - floaty - floatangle - stringtext - - - Annotates an image with text. - - - - - &reftitle.parameters; - - - GmagickDraw - - - The GmagickDraw object that contains settings for drawing the text. - - - - - x - - - Horizontal offset in pixels to the left of text. - - - - - y - - - Vertical offset in pixels to the baseline of text. - - - - - angle - - - The angle at which to write the text. - - - - - text - - - The string to draw. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object with annotation made. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/blurimage.xml b/reference/gmagick/gmagick/blurimage.xml deleted file mode 100644 index 8ba2b1a46889..000000000000 --- a/reference/gmagick/gmagick/blurimage.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - Gmagick::blurimage - Adds blur filter to image - - - - &reftitle.description; - - public GmagickGmagick::blurimage - floatradius - floatsigma - intchannel - - - Adds blur filter to image. - - - - - &reftitle.parameters; - - - radius - - - Blur radius - - - - - sigma - - - Standard deviation - - - - - - - - &reftitle.returnvalues; - - The blurred Gmagick object - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/borderimage.xml b/reference/gmagick/gmagick/borderimage.xml deleted file mode 100644 index bee568a878a7..000000000000 --- a/reference/gmagick/gmagick/borderimage.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - Gmagick::borderimage - Surrounds the image with a border - - - - &reftitle.description; - - public GmagickGmagick::borderimage - GmagickPixelcolor - intwidth - intheight - - - Surrounds the image with a border of the color defined by the bordercolor GmagickPixel object or a color string. - - - - - &reftitle.parameters; - - - color - - - GmagickPixel object or a string containing the border color. - - - - - width - - - Border width. - - - - - height - - - Border height. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object with border defined. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/charcoalimage.xml b/reference/gmagick/gmagick/charcoalimage.xml deleted file mode 100644 index 0294377f4c49..000000000000 --- a/reference/gmagick/gmagick/charcoalimage.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - Gmagick::charcoalimage - Simulates a charcoal drawing - - - - &reftitle.description; - - public GmagickGmagick::charcoalimage - floatradius - floatsigma - - - Simulates a charcoal drawing. - - - - - &reftitle.parameters; - - - radius - - - The radius of the Gaussian, in pixels, not counting the center pixel. - - - - - sigma - - - The standard deviation of the Gaussian, in pixels. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object with charcoal simulation. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/chopimage.xml b/reference/gmagick/gmagick/chopimage.xml deleted file mode 100644 index 7718cd01bdb8..000000000000 --- a/reference/gmagick/gmagick/chopimage.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - Gmagick::chopimage - Removes a region of an image and trims - - - - &reftitle.description; - - public GmagickGmagick::chopimage - intwidth - intheight - intx - inty - - - Removes a region of an image and collapses the image to occupy the removed portion. - - - - - &reftitle.parameters; - - - width - - - Width of the chopped area. - - - - - height - - - Height of the chopped area. - - - - - x - - - X origo of the chopped area. - - - - - y - - - Y origo of the chopped area. - - - - - - - - &reftitle.returnvalues; - - The chopped Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/clear.xml b/reference/gmagick/gmagick/clear.xml deleted file mode 100644 index 2e10eadeec7f..000000000000 --- a/reference/gmagick/gmagick/clear.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - Gmagick::clear - Clears all resources associated to Gmagick object - - - - &reftitle.description; - - public GmagickGmagick::clear - - - - Clears all resources associated to Gmagick object. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The cleared Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/commentimage.xml b/reference/gmagick/gmagick/commentimage.xml deleted file mode 100644 index 7dc1298be968..000000000000 --- a/reference/gmagick/gmagick/commentimage.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - Gmagick::commentimage - Adds a comment to your image - - - - &reftitle.description; - - public GmagickGmagick::commentimage - stringcomment - - - Adds a comment to your image. - - - - - &reftitle.parameters; - - - comment - - - The comment to add. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object with comment added. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/compositeimage.xml b/reference/gmagick/gmagick/compositeimage.xml deleted file mode 100644 index 523dfea96bc6..000000000000 --- a/reference/gmagick/gmagick/compositeimage.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - Gmagick::compositeimage - Composite one image onto another - - - - &reftitle.description; - - public GmagickGmagick::compositeimage - Gmagicksource - intCOMPOSE - intx - inty - - - Composite one image onto another at the specified offset. - - - - - - &reftitle.parameters; - - - source - - - Gmagick object which holds the composite image. - - - - - COMPOSE - - - Composite operator. - - - - - x - - - The column offset of the composited image. - - - - - y - - - The row offset of the composited image. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object with compositions. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/construct.xml b/reference/gmagick/gmagick/construct.xml deleted file mode 100644 index 75b11ac25356..000000000000 --- a/reference/gmagick/gmagick/construct.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - Gmagick::__construct - The Gmagick constructor - - - - &reftitle.description; - - public Gmagick::__construct - stringfilename - - - The Gmagick constructor. - - - - - - &reftitle.parameters; - - - filename - - - The path to an image to load or array of paths. - - - - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/cropimage.xml b/reference/gmagick/gmagick/cropimage.xml deleted file mode 100644 index cdf809fdaec5..000000000000 --- a/reference/gmagick/gmagick/cropimage.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - Gmagick::cropimage - Extracts a region of the image - - - - &reftitle.description; - - public GmagickGmagick::cropimage - - int - width - - - int - height - - intx - inty - - - Extracts a region of the image. - - - - - - - &reftitle.parameters; - - - - - width - - - - The width of the crop. - - - - - - height - - - - The height of the crop. - - - - - x - - - The X coordinate of the cropped region's top left corner. - - - - - y - - - The Y coordinate of the cropped region's top left corner. - - - - - - - - &reftitle.returnvalues; - - The cropped Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/cropthumbnailimage.xml b/reference/gmagick/gmagick/cropthumbnailimage.xml deleted file mode 100644 index 55b7dce87aa3..000000000000 --- a/reference/gmagick/gmagick/cropthumbnailimage.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - Gmagick::cropthumbnailimage - Creates a crop thumbnail - - - - &reftitle.description; - - public GmagickGmagick::cropthumbnailimage - intwidth - intheight - - - Creates a fixed size thumbnail by first scaling the image down and cropping a specified area from the center. - - - - - &reftitle.parameters; - - - width - - - The width of the thumbnail. - - - - - height - - - The Height of the thumbnail. - - - - - - - - &reftitle.returnvalues; - - The cropped Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/current.xml b/reference/gmagick/gmagick/current.xml deleted file mode 100644 index 83b285c65215..000000000000 --- a/reference/gmagick/gmagick/current.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - Gmagick::current - The current purpose - - - - &reftitle.description; - - public GmagickGmagick::current - - - - Returns reference to the current gmagick object with image pointer at the correct sequence. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns self on success. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/cyclecolormapimage.xml b/reference/gmagick/gmagick/cyclecolormapimage.xml deleted file mode 100644 index a14faa406671..000000000000 --- a/reference/gmagick/gmagick/cyclecolormapimage.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - Gmagick::cyclecolormapimage - Displaces an image's colormap - - - - &reftitle.description; - - public GmagickGmagick::cyclecolormapimage - intdisplace - - - Displaces an image's colormap by a given number of positions. If you cycle the colormap a number of times you can -produce a psychedelic effect. - - - - - - &reftitle.parameters; - - - displace - - - The amount to displace the colormap. - - - - - - - - &reftitle.returnvalues; - - Returns self on success. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/deconstructimages.xml b/reference/gmagick/gmagick/deconstructimages.xml deleted file mode 100644 index f7b949fb7696..000000000000 --- a/reference/gmagick/gmagick/deconstructimages.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - Gmagick::deconstructimages - Returns certain pixel differences between images - - - - &reftitle.description; - - public GmagickGmagick::deconstructimages - - - -Compares each image with the next in a sequence and returns the maximum bounding region of any pixel differences it discovers. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a new Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/despeckleimage.xml b/reference/gmagick/gmagick/despeckleimage.xml deleted file mode 100644 index c63456b66841..000000000000 --- a/reference/gmagick/gmagick/despeckleimage.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - Gmagick::despeckleimage - The despeckleimage purpose - - - - &reftitle.description; - - public GmagickGmagick::despeckleimage - - - - Reduces the speckle noise in an image while preserving the edges of the original image. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The despeckled Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - &reftitle.examples; - - <methodname>Gmagick::despeckleimage</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/gmagick/gmagick/destroy.xml b/reference/gmagick/gmagick/destroy.xml deleted file mode 100644 index dc55b2e66e0d..000000000000 --- a/reference/gmagick/gmagick/destroy.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - Gmagick::destroy - The destroy purpose - - - - &reftitle.description; - - public boolGmagick::destroy - - - - Destroys the Gmagick object and frees all resources associated with it - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/drawimage.xml b/reference/gmagick/gmagick/drawimage.xml deleted file mode 100644 index 17a55d33284b..000000000000 --- a/reference/gmagick/gmagick/drawimage.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - Gmagick::drawimage - Renders the GmagickDraw object on the current image - - - - &reftitle.description; - - public GmagickGmagick::drawimage - GmagickDrawGmagickDraw - - - Renders the GmagickDraw object on the current image. - - - - - - - &reftitle.parameters; - - - GmagickDraw - - - The drawing operations to render on the image. - - - - - - - - &reftitle.returnvalues; - - The drawn Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/edgeimage.xml b/reference/gmagick/gmagick/edgeimage.xml deleted file mode 100644 index e72657c8e1b4..000000000000 --- a/reference/gmagick/gmagick/edgeimage.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - Gmagick::edgeimage - Enhance edges within the image - - - - &reftitle.description; - - public GmagickGmagick::edgeimage - floatradius - - - Enhance edges within the image with a convolution filter of the given radius. Use radius 0 and it will be auto-selected. - - - - - - - &reftitle.parameters; - - - radius - - - The radius of the operation. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object with edges enhanced. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/embossimage.xml b/reference/gmagick/gmagick/embossimage.xml deleted file mode 100644 index 082bd55f2eba..000000000000 --- a/reference/gmagick/gmagick/embossimage.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - Gmagick::embossimage - Returns a grayscale image with a three-dimensional effect - - - - &reftitle.description; - - public GmagickGmagick::embossimage - floatradius - floatsigma - - - Returns a grayscale image with a three-dimensional effect. We convolve the image with a Gaussian operator of the given radius and standard deviation (sigma). For reasonable results, radius should be larger than sigma. Use a radius of 0 and it will choose a suitable radius for you. - - - - - - - &reftitle.parameters; - - - radius - - - The radius of the effect. - - - - - sigma - - - The sigma of the effect. - - - - - - - - &reftitle.returnvalues; - - The embossed Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/enhanceimage.xml b/reference/gmagick/gmagick/enhanceimage.xml deleted file mode 100644 index 59cb23349d2f..000000000000 --- a/reference/gmagick/gmagick/enhanceimage.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - Gmagick::enhanceimage - Improves the quality of a noisy image - - - - &reftitle.description; - - public GmagickGmagick::enhanceimage - - - - Applies a digital filter that improves the quality of a noisy image. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The enhanced Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - - diff --git a/reference/gmagick/gmagick/equalizeimage.xml b/reference/gmagick/gmagick/equalizeimage.xml deleted file mode 100644 index 6bdb4616878f..000000000000 --- a/reference/gmagick/gmagick/equalizeimage.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - Gmagick::equalizeimage - Equalizes the image histogram - - - - &reftitle.description; - - public GmagickGmagick::equalizeimage - - - - Equalizes the image histogram. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The equalized Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/flipimage.xml b/reference/gmagick/gmagick/flipimage.xml deleted file mode 100644 index c50b23ec4ba0..000000000000 --- a/reference/gmagick/gmagick/flipimage.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - Gmagick::flipimage - Creates a vertical mirror image - - - - &reftitle.description; - - public GmagickGmagick::flipimage - - - - Creates a vertical mirror image by reflecting the pixels around the central x-axis. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The flipped Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - &reftitle.seealso; - - Gmagick::flopimage - - - - - diff --git a/reference/gmagick/gmagick/flopimage.xml b/reference/gmagick/gmagick/flopimage.xml deleted file mode 100644 index 2e0137fc46b0..000000000000 --- a/reference/gmagick/gmagick/flopimage.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - Gmagick::flopimage - Creates a horizontal mirror image - - - - &reftitle.description; - - public GmagickGmagick::flopimage - - - - Creates a horizontal mirror image by reflecting the pixels around the central y-axis. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The flopped Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - &reftitle.seealso; - - Gmagick::flipimage - - - - - diff --git a/reference/gmagick/gmagick/frameimage.xml b/reference/gmagick/gmagick/frameimage.xml deleted file mode 100644 index 4ade4b77bd0e..000000000000 --- a/reference/gmagick/gmagick/frameimage.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - Gmagick::frameimage - Adds a simulated three-dimensional border - - - - &reftitle.description; - - public GmagickGmagick::frameimage - GmagickPixelcolor - intwidth - intheight - intinner_bevel - intouter_bevel - - -Adds a simulated three-dimensional border around the image. The width and height specify the border width of the vertical and horizontal sides of the frame. The inner and outer bevels indicate the width of the inner and outer shadows of the frame. - - - - - - &reftitle.parameters; - - - color - - - GmagickPixel object or a float representing the matte color. - - - - - width - - - The width of the border. - - - - - height - - - The height of the border. - - - - - inner_bevel - - - The inner bevel width. - - - - - outer_bevel - - - The outer bevel width. - - - - - - - - &reftitle.returnvalues; - - The framed Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/gammaimage.xml b/reference/gmagick/gmagick/gammaimage.xml deleted file mode 100644 index 64ee77a6a827..000000000000 --- a/reference/gmagick/gmagick/gammaimage.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - Gmagick::gammaimage - Gamma-corrects an image - - - - &reftitle.description; - - public GmagickGmagick::gammaimage - floatgamma - - - Gamma-corrects an image. The same image viewed on different devices will have perceptual differences in the way the image's intensities are represented on the screen. Specify individual gamma levels for the red, green, and blue channels, or adjust all three with the gamma parameter. Values typically range from 0.8 to 2.3. - - - - - - &reftitle.parameters; - - - gamma - - - The amount of gamma-correction. - - - - - - - - &reftitle.returnvalues; - - The gamma corrected Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getcopyright.xml b/reference/gmagick/gmagick/getcopyright.xml deleted file mode 100644 index 930bfa014b60..000000000000 --- a/reference/gmagick/gmagick/getcopyright.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - Gmagick::getcopyright - Returns the GraphicsMagick API copyright as a string - - - - &reftitle.description; - - public stringGmagick::getcopyright - - - - Returns the GraphicsMagick API copyright as a string. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a string containing the copyright notice of GraphicsMagick and - Magickwand C API. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getfilename.xml b/reference/gmagick/gmagick/getfilename.xml deleted file mode 100644 index 66156ba35cb2..000000000000 --- a/reference/gmagick/gmagick/getfilename.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - Gmagick::getfilename - The filename associated with an image sequence - - - - &reftitle.description; - - public stringGmagick::getfilename - - - - Returns the filename associated with an image sequence. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a string on success. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagebackgroundcolor.xml b/reference/gmagick/gmagick/getimagebackgroundcolor.xml deleted file mode 100644 index 4f15964fee7a..000000000000 --- a/reference/gmagick/gmagick/getimagebackgroundcolor.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - Gmagick::getimagebackgroundcolor - Returns the image background color - - - - &reftitle.description; - - public GmagickPixelGmagick::getimagebackgroundcolor - - - - Returns the image background color. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an GmagickPixel set to the background color of the image. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimageblueprimary.xml b/reference/gmagick/gmagick/getimageblueprimary.xml deleted file mode 100644 index b2df22ced0c6..000000000000 --- a/reference/gmagick/gmagick/getimageblueprimary.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - Gmagick::getimageblueprimary - Returns the chromaticy blue primary point - - - - &reftitle.description; - - public arrayGmagick::getimageblueprimary - - - - Returns the chromaticity blue primary point for the image. - - - - - - - &reftitle.parameters; - - - x - - - The chromaticity blue primary x-point. - - - - - y - - - The chromaticity blue primary y-point. - - - - - - - - &reftitle.returnvalues; - - Array consisting of "x" and "y" coordinates of point. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagebordercolor.xml b/reference/gmagick/gmagick/getimagebordercolor.xml deleted file mode 100644 index 9ebbb81e1fdc..000000000000 --- a/reference/gmagick/gmagick/getimagebordercolor.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - Gmagick::getimagebordercolor - Returns the image border color - - - - &reftitle.description; - - public GmagickPixelGmagick::getimagebordercolor - - - - Returns the image border color. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - GmagickPixel object representing the color of the border. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagechanneldepth.xml b/reference/gmagick/gmagick/getimagechanneldepth.xml deleted file mode 100644 index 56ee6693d6ed..000000000000 --- a/reference/gmagick/gmagick/getimagechanneldepth.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - Gmagick::getimagechanneldepth - Gets the depth for a particular image channel - - - - &reftitle.description; - - public intGmagick::getimagechanneldepth - intchannel_type - - - Gets the depth for a particular image channel. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Depth of image channel - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagecolors.xml b/reference/gmagick/gmagick/getimagecolors.xml deleted file mode 100644 index b34963933f4c..000000000000 --- a/reference/gmagick/gmagick/getimagecolors.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - Gmagick::getimagecolors - Returns the color of the specified colormap index - - - - &reftitle.description; - - public intGmagick::getimagecolors - - - - Returns the color of the specified colormap index. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The number of colors in image. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagecolorspace.xml b/reference/gmagick/gmagick/getimagecolorspace.xml deleted file mode 100644 index e08f605799ef..000000000000 --- a/reference/gmagick/gmagick/getimagecolorspace.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - Gmagick::getimagecolorspace - Gets the image colorspace - - - - &reftitle.description; - - public intGmagick::getimagecolorspace - - - - Gets the image colorspace. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Colorspace - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagecompose.xml b/reference/gmagick/gmagick/getimagecompose.xml deleted file mode 100644 index e000f213b33e..000000000000 --- a/reference/gmagick/gmagick/getimagecompose.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - Gmagick::getimagecompose - Returns the composite operator associated with the image - - - - &reftitle.description; - - public intGmagick::getimagecompose - - - - Returns the composite operator associated with the image. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the composite operator associated with the image. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagedelay.xml b/reference/gmagick/gmagick/getimagedelay.xml deleted file mode 100644 index 208ee41ca0dd..000000000000 --- a/reference/gmagick/gmagick/getimagedelay.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - Gmagick::getimagedelay - Gets the image delay - - - - &reftitle.description; - - public intGmagick::getimagedelay - - - - Gets the image delay - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the composite operator associated with the image. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagedepth.xml b/reference/gmagick/gmagick/getimagedepth.xml deleted file mode 100644 index 1ccff6b1d3ff..000000000000 --- a/reference/gmagick/gmagick/getimagedepth.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - Gmagick::getimagedepth - Gets the depth of the image - - - - &reftitle.description; - - public intGmagick::getimagedepth - - - - Gets the depth of the image. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Image depth - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagedispose.xml b/reference/gmagick/gmagick/getimagedispose.xml deleted file mode 100644 index 7a8febf8dc3e..000000000000 --- a/reference/gmagick/gmagick/getimagedispose.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - Gmagick::getimagedispose - Gets the image disposal method - - - - &reftitle.description; - - public intGmagick::getimagedispose - - - - Gets the image disposal method - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the dispose method on success. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimageextrema.xml b/reference/gmagick/gmagick/getimageextrema.xml deleted file mode 100644 index 0e9fedd05f28..000000000000 --- a/reference/gmagick/gmagick/getimageextrema.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - Gmagick::getimageextrema - Gets the extrema for the image - - - - &reftitle.description; - - public arrayGmagick::getimageextrema - - - - Returns an associative array with the keys "min" and "max". &gmagick.gmagickexception.throw; - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an associative array with the keys "min" and "max". - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagefilename.xml b/reference/gmagick/gmagick/getimagefilename.xml deleted file mode 100644 index 9cd87a07f267..000000000000 --- a/reference/gmagick/gmagick/getimagefilename.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - Gmagick::getimagefilename - Returns the filename of a particular image in a sequence - - - - &reftitle.description; - - public stringGmagick::getimagefilename - - - - Returns the filename of a particular image in a sequence - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a string with the filename of the image - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimageformat.xml b/reference/gmagick/gmagick/getimageformat.xml deleted file mode 100644 index e42f51295d66..000000000000 --- a/reference/gmagick/gmagick/getimageformat.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - Gmagick::getimageformat - Returns the format of a particular image in a sequence - - - - &reftitle.description; - - public stringGmagick::getimageformat - - - - Returns the format of a particular image in a sequence. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a string containing the image format on success. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagegamma.xml b/reference/gmagick/gmagick/getimagegamma.xml deleted file mode 100644 index 58e4f7e5f0bb..000000000000 --- a/reference/gmagick/gmagick/getimagegamma.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - Gmagick::getimagegamma - Gets the image gamma - - - - &reftitle.description; - - public floatGmagick::getimagegamma - - - - Gets the image gamma - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the image gamma on success - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/getimagegreenprimary.xml b/reference/gmagick/gmagick/getimagegreenprimary.xml deleted file mode 100644 index 1f34afa96ed7..000000000000 --- a/reference/gmagick/gmagick/getimagegreenprimary.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - Gmagick::getimagegreenprimary - Returns the chromaticy green primary point - - - - &reftitle.description; - - public arrayGmagick::getimagegreenprimary - - - - Returns the chromaticity green primary point. Returns an array with the keys "x" and "y". - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an array with the keys "x" and "y" on success. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/getimageheight.xml b/reference/gmagick/gmagick/getimageheight.xml deleted file mode 100644 index ba129e0a71ab..000000000000 --- a/reference/gmagick/gmagick/getimageheight.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - Gmagick::getimageheight - Returns the image height - - - - &reftitle.description; - - public intGmagick::getimageheight - - - - Returns the image height - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the image height in pixels. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagehistogram.xml b/reference/gmagick/gmagick/getimagehistogram.xml deleted file mode 100644 index 0aaa7090567e..000000000000 --- a/reference/gmagick/gmagick/getimagehistogram.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - Gmagick::getimagehistogram - Gets the image histogram - - - - &reftitle.description; - - public arrayGmagick::getimagehistogram - - - - Returns the image histogram as an array of GmagickPixel objects. - Throw an GmagickException on error. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the image histogram as an array of GmagickPixel objects. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimageindex.xml b/reference/gmagick/gmagick/getimageindex.xml deleted file mode 100644 index cc72bd332362..000000000000 --- a/reference/gmagick/gmagick/getimageindex.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - Gmagick::getimageindex - Gets the index of the current active image - - - - &reftitle.description; - - public intGmagick::getimageindex - - - - Returns the index of the current active image within the Gmagick object. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Index of current active image. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimageinterlacescheme.xml b/reference/gmagick/gmagick/getimageinterlacescheme.xml deleted file mode 100644 index 25424f801ae4..000000000000 --- a/reference/gmagick/gmagick/getimageinterlacescheme.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - Gmagick::getimageinterlacescheme - Gets the image interlace scheme - - - - &reftitle.description; - - public intGmagick::getimageinterlacescheme - - - - Gets the image interlace scheme. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the interlace scheme as an integer on success - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimageiterations.xml b/reference/gmagick/gmagick/getimageiterations.xml deleted file mode 100644 index 46394a962716..000000000000 --- a/reference/gmagick/gmagick/getimageiterations.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - Gmagick::getimageiterations - Gets the image iterations - - - - &reftitle.description; - - public intGmagick::getimageiterations - - - - Gets the image iterations. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the image iterations as an integer. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagematte.xml b/reference/gmagick/gmagick/getimagematte.xml deleted file mode 100644 index 335ec24a19a5..000000000000 --- a/reference/gmagick/gmagick/getimagematte.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - Gmagick::getimagematte - Check if the image has a matte channel - - - - &reftitle.description; - - public intGmagick::getimagematte - - - - Returns &true; if the image has a matte channel, otherwise &false;. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; if the image has a matte channel, otherwise &false;. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagemattecolor.xml b/reference/gmagick/gmagick/getimagemattecolor.xml deleted file mode 100644 index fce7d049afbd..000000000000 --- a/reference/gmagick/gmagick/getimagemattecolor.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - Gmagick::getimagemattecolor - Returns the image matte color - - - - &reftitle.description; - - public GmagickPixelGmagick::getimagemattecolor - - - - Returns GmagickPixel object on success. Throw an GmagickException on error. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns GmagickPixel object on success. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimageprofile.xml b/reference/gmagick/gmagick/getimageprofile.xml deleted file mode 100644 index 63460a885e83..000000000000 --- a/reference/gmagick/gmagick/getimageprofile.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - Gmagick::getimageprofile - Returns the named image profile - - - - &reftitle.description; - - public stringGmagick::getimageprofile - stringname - - - Returns the named image profile. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a string containing the image profile. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimageredprimary.xml b/reference/gmagick/gmagick/getimageredprimary.xml deleted file mode 100644 index c9c71bd75e90..000000000000 --- a/reference/gmagick/gmagick/getimageredprimary.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - Gmagick::getimageredprimary - Returns the chromaticity red primary point - - - - &reftitle.description; - - public arrayGmagick::getimageredprimary - - - - Returns the chromaticity red primary point as an array with the keys "x" and "y". - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the chromaticity red primary point as an array with the keys "x" and "y". - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagerenderingintent.xml b/reference/gmagick/gmagick/getimagerenderingintent.xml deleted file mode 100644 index 7640f6a63479..000000000000 --- a/reference/gmagick/gmagick/getimagerenderingintent.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - Gmagick::getimagerenderingintent - Gets the image rendering intent - - - - &reftitle.description; - - public intGmagick::getimagerenderingintent - - - - Gets the image rendering intent - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Extracts a region of the image and returns it as a new wand - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimageresolution.xml b/reference/gmagick/gmagick/getimageresolution.xml deleted file mode 100644 index 55b9477d419e..000000000000 --- a/reference/gmagick/gmagick/getimageresolution.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - Gmagick::getimageresolution - Gets the image X and Y resolution - - - - &reftitle.description; - - public arrayGmagick::getimageresolution - - - - Returns the resolution as an array. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the resolution as an array. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagescene.xml b/reference/gmagick/gmagick/getimagescene.xml deleted file mode 100644 index bbc5a7bd32f5..000000000000 --- a/reference/gmagick/gmagick/getimagescene.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - Gmagick::getimagescene - Gets the image scene - - - - &reftitle.description; - - public intGmagick::getimagescene - - - - Gets the image scene. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the image scene. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagesignature.xml b/reference/gmagick/gmagick/getimagesignature.xml deleted file mode 100644 index 8a4f0b6f0632..000000000000 --- a/reference/gmagick/gmagick/getimagesignature.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - Gmagick::getimagesignature - Generates an SHA-256 message digest - - - - &reftitle.description; - - public stringGmagick::getimagesignature - - - - Generates an SHA-256 message digest for the image pixel stream. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a string containing the SHA-256 hash of the file. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagetype.xml b/reference/gmagick/gmagick/getimagetype.xml deleted file mode 100644 index 42423a9a6f48..000000000000 --- a/reference/gmagick/gmagick/getimagetype.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - Gmagick::getimagetype - Gets the potential image type - - - - &reftitle.description; - - public intGmagick::getimagetype - - - - Gets the potential image type. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the potential image type. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimageunits.xml b/reference/gmagick/gmagick/getimageunits.xml deleted file mode 100644 index 5161a3ead6b4..000000000000 --- a/reference/gmagick/gmagick/getimageunits.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - Gmagick::getimageunits - Gets the image units of resolution - - - - &reftitle.description; - - public intGmagick::getimageunits - - - - Gets the image units of resolution. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the image units of resolution. - - - - - - diff --git a/reference/gmagick/gmagick/getimagewhitepoint.xml b/reference/gmagick/gmagick/getimagewhitepoint.xml deleted file mode 100644 index a8b4b15b3136..000000000000 --- a/reference/gmagick/gmagick/getimagewhitepoint.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - Gmagick::getimagewhitepoint - Returns the chromaticity white point - - - - &reftitle.description; - - public arrayGmagick::getimagewhitepoint - - - - Returns the chromaticity white point as an associative array with the keys "x" and "y". - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the chromaticity white point as an associative array with the keys "x" and "y". - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/getimagewidth.xml b/reference/gmagick/gmagick/getimagewidth.xml deleted file mode 100644 index 56974c76f230..000000000000 --- a/reference/gmagick/gmagick/getimagewidth.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - Gmagick::getimagewidth - Returns the width of the image - - - - &reftitle.description; - - public intGmagick::getimagewidth - - - - Returns the width of the image. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the image width. - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getpackagename.xml b/reference/gmagick/gmagick/getpackagename.xml deleted file mode 100644 index 926894cc2a58..000000000000 --- a/reference/gmagick/gmagick/getpackagename.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - Gmagick::getpackagename - Returns the GraphicsMagick package name - - - - &reftitle.description; - - public stringGmagick::getpackagename - - - - Returns the GraphicsMagick package name. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the GraphicsMagick package name as a string. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getquantumdepth.xml b/reference/gmagick/gmagick/getquantumdepth.xml deleted file mode 100644 index 843a6f2dcf7e..000000000000 --- a/reference/gmagick/gmagick/getquantumdepth.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - Gmagick::getquantumdepth - Returns the Gmagick quantum depth as a string - - - - &reftitle.description; - - public arrayGmagick::getquantumdepth - - - - Returns the Gmagick quantum depth as a string. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the Gmagick quantum depth as a string. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getreleasedate.xml b/reference/gmagick/gmagick/getreleasedate.xml deleted file mode 100644 index f4c9771cbd0d..000000000000 --- a/reference/gmagick/gmagick/getreleasedate.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - Gmagick::getreleasedate - Returns the GraphicsMagick release date as a string - - - - &reftitle.description; - - public stringGmagick::getreleasedate - - - - Returns the GraphicsMagick release date as a string. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the GraphicsMagick release date as a string. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/getsamplingfactors.xml b/reference/gmagick/gmagick/getsamplingfactors.xml deleted file mode 100644 index 74f8decef2cc..000000000000 --- a/reference/gmagick/gmagick/getsamplingfactors.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - Gmagick::getsamplingfactors - Gets the horizontal and vertical sampling factor - - - - &reftitle.description; - - public arrayGmagick::getsamplingfactors - - - - Gets the horizontal and vertical sampling factor. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an associative array with the horizontal and vertical sampling factors of the image. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getsize.xml b/reference/gmagick/gmagick/getsize.xml deleted file mode 100644 index 74d027816b83..000000000000 --- a/reference/gmagick/gmagick/getsize.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - Gmagick::getsize - Returns the size associated with the Gmagick object - - - - &reftitle.description; - - public arrayGmagick::getsize - - - - Returns the size associated with the Gmagick object as an array with the keys "columns" and "rows". - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the size associated with the Gmagick object as an array with the keys "columns" and "rows". - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getversion.xml b/reference/gmagick/gmagick/getversion.xml deleted file mode 100644 index 1ef8372b1ea3..000000000000 --- a/reference/gmagick/gmagick/getversion.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - Gmagick::getversion - Returns the GraphicsMagick API version - - - - &reftitle.description; - - public arrayGmagick::getversion - - - - Returns the GraphicsMagick API version as a string and as a number. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the GraphicsMagick API version as a string and as a number. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/hasnextimage.xml b/reference/gmagick/gmagick/hasnextimage.xml deleted file mode 100644 index d3f2739eafae..000000000000 --- a/reference/gmagick/gmagick/hasnextimage.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - Gmagick::hasnextimage - Checks if the object has more images - - - - &reftitle.description; - - public mixedGmagick::hasnextimage - - - - Returns &true; if the object has more images when traversing the list in the forward direction. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; if the object has more images when traversing the list in the forward direction, returns &false; if there are none. - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/haspreviousimage.xml b/reference/gmagick/gmagick/haspreviousimage.xml deleted file mode 100644 index e352777393e9..000000000000 --- a/reference/gmagick/gmagick/haspreviousimage.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - Gmagick::haspreviousimage - Checks if the object has a previous image - - - - &reftitle.description; - - public mixedGmagick::haspreviousimage - - - - Returns &true; if the object has more images when traversing the list in the reverse direction. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; if the object has more images when traversing the list in the reverse direction, returns &false; if there are none. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/implodeimage.xml b/reference/gmagick/gmagick/implodeimage.xml deleted file mode 100644 index b11012c5116c..000000000000 --- a/reference/gmagick/gmagick/implodeimage.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - Gmagick::implodeimage - Creates a new image as a copy - - - - &reftitle.description; - - public mixedGmagick::implodeimage - floatradius - - - Creates a new image that is a copy of an existing one with the image pixels "imploded" by the specified percentage. - - - - - &reftitle.parameters; - - - radius - - - The radius of the implode. - - - - - - - - &reftitle.returnvalues; - - Returns imploded Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/labelimage.xml b/reference/gmagick/gmagick/labelimage.xml deleted file mode 100644 index 5a9e918de18c..000000000000 --- a/reference/gmagick/gmagick/labelimage.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - Gmagick::labelimage - Adds a label to an image - - - - &reftitle.description; - - public mixedGmagick::labelimage - stringlabel - - - Adds a label to an image. - - - - - - - - &reftitle.parameters; - - - label - - - The label to add - - - - - - - - &reftitle.returnvalues; - - Gmagick with label. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/levelimage.xml b/reference/gmagick/gmagick/levelimage.xml deleted file mode 100644 index a4135f762908..000000000000 --- a/reference/gmagick/gmagick/levelimage.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - Gmagick::levelimage - Adjusts the levels of an image - - - - &reftitle.description; - - public mixedGmagick::levelimage - floatblackPoint - floatgamma - floatwhitePoint - intchannelGmagick::CHANNEL_DEFAULT - - - Adjusts the levels of an image by scaling the colors falling between specified white and black - points to the full available quantum range. The parameters provided represent the black, mid, and - white points. The black point specifies the darkest color in the image. Colors darker than the black - point are set to zero. Mid point specifies a gamma correction to apply to the image. White point - specifies the lightest color in the image. Colors brighter than the white point are set to the - maximum quantum value. - - - - - &reftitle.parameters; - - - blackPoint - - - The image black point. - - - - - gamma - - - The gamma value. - - - - - whitePoint - - - The image white point. - - - - - channel - - - Provide any channel constant that is valid for your channel mode. -To apply to more than one channel, combine channeltype constants using bitwise -operators. Refer to this list of channel constants. - - - - - - - - &reftitle.returnvalues; - - Gmagick object with image leveled. - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/magnifyimage.xml b/reference/gmagick/gmagick/magnifyimage.xml deleted file mode 100644 index d69d2cfcceb6..000000000000 --- a/reference/gmagick/gmagick/magnifyimage.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - Gmagick::magnifyimage - Scales an image proportionally 2x - - - - &reftitle.description; - - public mixedGmagick::magnifyimage - - - - Conveniently scales an image proportionally to twice its original size. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Magnified Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/mapimage.xml b/reference/gmagick/gmagick/mapimage.xml deleted file mode 100644 index bc3b67676ed2..000000000000 --- a/reference/gmagick/gmagick/mapimage.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - Gmagick::mapimage - Replaces the colors of an image with the closest color from a reference image - - - - &reftitle.description; - - public GmagickGmagick::mapimage - gmagickgmagick - booldither - - - Replaces the colors of an image with the closest color from a reference image. - - - - - &reftitle.parameters; - - - gmagick - - - The reference image. - - - - - dither - - - Set this integer value to something other than zero to dither the mapped image. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object. - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/medianfilterimage.xml b/reference/gmagick/gmagick/medianfilterimage.xml deleted file mode 100644 index 26489ed07e16..000000000000 --- a/reference/gmagick/gmagick/medianfilterimage.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - Gmagick::medianfilterimage - Applies a digital filter - - - - &reftitle.description; - - public voidGmagick::medianfilterimage - floatradius - - - Applies a digital filter that improves the quality of a noisy image. Each pixel is replaced by the median in a set of neighboring pixels as defined by radius. - - - - - &reftitle.parameters; - - - radius - - - The radius of the pixel neighborhood. - - - - - - - - &reftitle.returnvalues; - - Gmagick object with median filter applied. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/minifyimage.xml b/reference/gmagick/gmagick/minifyimage.xml deleted file mode 100644 index d23381eac543..000000000000 --- a/reference/gmagick/gmagick/minifyimage.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - Gmagick::minifyimage - Scales an image proportionally to half its size - - - - &reftitle.description; - - public GmagickGmagick::minifyimage - - - - A convenient method that scales an image proportionally to one-half its original size. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/modulateimage.xml b/reference/gmagick/gmagick/modulateimage.xml deleted file mode 100644 index daf7d28db6a1..000000000000 --- a/reference/gmagick/gmagick/modulateimage.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - Gmagick::modulateimage - Control the brightness, saturation, and hue - - - - &reftitle.description; - - public GmagickGmagick::modulateimage - floatbrightness - floatsaturation - floathue - - - Lets you control the brightness, saturation, and hue of an image. Hue is the - percentage of absolute rotation from the current position. For example 50 results - in a counter-clockwise rotation of 90 degrees, 150 results in a clockwise rotation - of 90 degrees, with 0 and 200 both resulting in a rotation of 180 degrees. - - - - - - - - &reftitle.parameters; - - - brightness - - - The percent change in brighness (-100 thru +100). - - - - - saturation - - - The percent change in saturation (-100 thru +100) - - - - - hue - - - The percent change in hue (-100 thru +100) - - - - - - - - &reftitle.returnvalues; - - The Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/motionblurimage.xml b/reference/gmagick/gmagick/motionblurimage.xml deleted file mode 100644 index 19d0e5e99ea3..000000000000 --- a/reference/gmagick/gmagick/motionblurimage.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - Gmagick::motionblurimage - Simulates motion blur - - - - &reftitle.description; - - public GmagickGmagick::motionblurimage - floatradius - floatsigma - floatangle - - - Simulates motion blur. We convolve the image with a Gaussian operator of the - given radius and standard deviation (sigma). For reasonable results, radius should be - larger than sigma. Use a radius of 0 and Gmagick::motionblurimage selects a suitable radius - for you. Angle gives the angle of the blurring motion. - - - - - - &reftitle.parameters; - - - radius - - - The radius of the Gaussian, in pixels, not counting the center pixel. - - - - - sigma - - - The standard deviation of the Gaussian, in pixels. - - - - - angle - - - Apply the effect along this angle. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object. - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/newimage.xml b/reference/gmagick/gmagick/newimage.xml deleted file mode 100644 index 393c0490c872..000000000000 --- a/reference/gmagick/gmagick/newimage.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - Gmagick::newimage - Creates a new image - - - - &reftitle.description; - - public GmagickGmagick::newimage - intwidth - intheight - stringbackground - stringformat - - - Creates a new image with the specified background color. - - - - - &reftitle.parameters; - - - width - - - Width of the new image. - - - - - height - - - Height of the new image. - - - - - background - - - The background color used for this image (as float). - - - - - format - - - Image format. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/nextimage.xml b/reference/gmagick/gmagick/nextimage.xml deleted file mode 100644 index d01a476d1134..000000000000 --- a/reference/gmagick/gmagick/nextimage.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - Gmagick::nextimage - Moves to the next image - - - - &reftitle.description; - - public boolGmagick::nextimage - - - - Associates the next image in the image list with an Gmagick object. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/normalizeimage.xml b/reference/gmagick/gmagick/normalizeimage.xml deleted file mode 100644 index cf583c57ce08..000000000000 --- a/reference/gmagick/gmagick/normalizeimage.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - Gmagick::normalizeimage - Enhances the contrast of a color image - - - - &reftitle.description; - - public GmagickGmagick::normalizeimage - intchannel - - - Enhances the contrast of a color image by adjusting the pixels color to span the entire range of colors available. - - - - - - &reftitle.parameters; - - - channel - - - Identify which channel to normalize. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/oilpaintimage.xml b/reference/gmagick/gmagick/oilpaintimage.xml deleted file mode 100644 index 632e15c3e330..000000000000 --- a/reference/gmagick/gmagick/oilpaintimage.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - Gmagick::oilpaintimage - Simulates an oil painting - - - - &reftitle.description; - - public GmagickGmagick::oilpaintimage - - float - radius - - - - Applies a special effect filter that simulates an oil painting. Each pixel is replaced by the most frequent color occurring in a circular region defined by radius. - - - - - - - - &reftitle.parameters; - - - - radius - - - - The radius of the circular neighborhood. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object on success - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/previousimage.xml b/reference/gmagick/gmagick/previousimage.xml deleted file mode 100644 index 161f43fcb67f..000000000000 --- a/reference/gmagick/gmagick/previousimage.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - Gmagick::previousimage - Move to the previous image in the object - - - - &reftitle.description; - - public boolGmagick::previousimage - - - - Associates the previous image in an image list with the Gmagick object. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/profileimage.xml b/reference/gmagick/gmagick/profileimage.xml deleted file mode 100644 index 095106839ee6..000000000000 --- a/reference/gmagick/gmagick/profileimage.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - Gmagick::profileimage - Adds or removes a profile from an image - - - - &reftitle.description; - - public GmagickGmagick::profileimage - stringname - stringprofile - - - Adds or removes a ICC, IPTC, or generic profile from an image. If the profile is &null;, it is removed from the image otherwise added. - Use a name of * and a profile of &null; to remove all profiles from the image. - - - - - - &reftitle.parameters; - - - name - - - Name of profile to add or remove: ICC, IPTC, or generic profile. - - - - - profile - - - The profile. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/quantizeimage.xml b/reference/gmagick/gmagick/quantizeimage.xml deleted file mode 100644 index aa7e867ac57a..000000000000 --- a/reference/gmagick/gmagick/quantizeimage.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - Gmagick::quantizeimage - Analyzes the colors within a reference image - - - - &reftitle.description; - - public GmagickGmagick::quantizeimage - intnumColors - intcolorspace - inttreeDepth - booldither - boolmeasureError - - - Analyzes the colors within a reference image and chooses a fixed number of - colors to represent the image. The goal of the algorithm is to minimize the - color difference between the input and output image while minimizing the processing time. - - - - - - - - &reftitle.parameters; - - - numColors - - - The number of colors. - - - - - colorspace - - - Perform color reduction in this colorspace, typically RGBColorspace. - - - - - treeDepth - - - Normally, this integer value is zero or one. A zero or one tells Quantize -to choose a optimal tree depth of Log4(number_colors).% A tree of this depth generally -allows the best representation of the reference image with the least amount of memory -and the fastest computational speed. In some cases, such as an image with low color -dispersion (a few number of colors), a value other than Log4(number_colors) is required. -To expand the color tree completely, use a value of 8. - - - - - dither - - - A value other than zero distributes the difference between an original image and the corresponding color reduced algorithm to neighboring pixels along a Hilbert curve. - - - - - measureError - - - A value other than zero measures the difference between the original and quantized images. This difference is the total quantization error. The error is computed by summing over all pixels in an image the distance squared in RGB space between each reference pixel value and its quantized value. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object on success - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/quantizeimages.xml b/reference/gmagick/gmagick/quantizeimages.xml deleted file mode 100644 index 3f5acff042b1..000000000000 --- a/reference/gmagick/gmagick/quantizeimages.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - Gmagick::quantizeimages - The quantizeimages purpose - - - - &reftitle.description; - - public GmagickGmagick::quantizeimages - intnumColors - intcolorspace - inttreeDepth - booldither - boolmeasureError - - - Analyzes the colors within a sequence of images and chooses a fixed number of - colors to represent the image. The goal of the algorithm is to minimize the - color difference between the input and output image while minimizing the processing time. - - - - - - - - &reftitle.parameters; - - - numColors - - - The number of colors. - - - - - colorspace - - - Perform color reduction in this colorspace, typically RGBColorspace. - - - - - treeDepth - - - Normally, this integer value is zero or one. A zero or one tells Quantize -to choose a optimal tree depth of Log4(number_colors).% A tree of this depth generally -allows the best representation of the reference image with the least amount of memory -and the fastest computational speed. In some cases, such as an image with low color -dispersion (a few number of colors), a value other than Log4(number_colors) is required. -To expand the color tree completely, use a value of 8. - - - - - dither - - - A value other than zero distributes the difference between an original image and the corresponding color reduced algorithm to neighboring pixels along a Hilbert curve. - - - - - measureError - - - A value other than zero measures the difference between the original and quantized images. This difference is the total quantization error. The error is computed by summing over all pixels in an image the distance squared in RGB space between each reference pixel value and its quantized value. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object on success - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/queryfontmetrics.xml b/reference/gmagick/gmagick/queryfontmetrics.xml deleted file mode 100644 index ad2a8cdfa354..000000000000 --- a/reference/gmagick/gmagick/queryfontmetrics.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - Gmagick::queryfontmetrics - Returns an array representing the font metrics - - - - &reftitle.description; - - public arrayGmagick::queryfontmetrics - GmagickDrawdraw - stringtext - - - MagickQueryFontMetrics() returns an array representing the font metrics. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The Gmagick object on success - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/queryfonts.xml b/reference/gmagick/gmagick/queryfonts.xml deleted file mode 100644 index 4a6b2ddd3e5a..000000000000 --- a/reference/gmagick/gmagick/queryfonts.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - Gmagick::queryfonts - Returns the configured fonts - - - - &reftitle.description; - - public arrayGmagick::queryfonts - stringpattern"*" - - - Returns fonts supported by Gmagick. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The Gmagick object on success - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/queryformats.xml b/reference/gmagick/gmagick/queryformats.xml deleted file mode 100644 index 033ca6d40dab..000000000000 --- a/reference/gmagick/gmagick/queryformats.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - Gmagick::queryformats - Returns formats supported by Gmagick - - - - &reftitle.description; - - public arrayGmagick::queryformats - stringpattern"*" - - - Returns formats supported by Gmagick. - - - - - &reftitle.parameters; - - - pattern - - - Specifies a string containing a pattern. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/radialblurimage.xml b/reference/gmagick/gmagick/radialblurimage.xml deleted file mode 100644 index 705a597df74b..000000000000 --- a/reference/gmagick/gmagick/radialblurimage.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - Gmagick::radialblurimage - Radial blurs an image - - - - &reftitle.description; - - public GmagickGmagick::radialblurimage - floatangle - intchannelGmagick::CHANNEL_DEFAULT - - - Radial blurs an image. - - - - - &reftitle.parameters; - - - angle - - - The angle of the blur in degrees. - - - - - channel - - - Related channel. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object. - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/raiseimage.xml b/reference/gmagick/gmagick/raiseimage.xml deleted file mode 100644 index 3b38d7ed44e8..000000000000 --- a/reference/gmagick/gmagick/raiseimage.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - Gmagick::raiseimage - Creates a simulated 3d button-like effect - - - - &reftitle.description; - - public GmagickGmagick::raiseimage - intwidth - intheight - intx - inty - boolraise - - - Creates a simulated three-dimensional button-like effect by lightening and darkening the edges of the image. Members width and height of raise_info define the width of the vertical and horizontal edge of the effect. - - - - - - &reftitle.parameters; - - - width - - - Width of the area to raise. - - - - - height - - - Height of the area to raise. - - - - - x - - - X coordinate. - - - - - y - - - Y coordinate. - - - - - raise - - - A value other than zero creates a 3-D raise effect, otherwise it has a lowered effect. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/read.xml b/reference/gmagick/gmagick/read.xml deleted file mode 100644 index 9d51ed47239c..000000000000 --- a/reference/gmagick/gmagick/read.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - Gmagick::read - Reads image from filename - - - - &reftitle.description; - - public GmagickGmagick::read - stringfilename - - - Reads image from filename. - - - - - - &reftitle.parameters; - - - filename - - - The image filename. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/readimage.xml b/reference/gmagick/gmagick/readimage.xml deleted file mode 100644 index 0d260de403d6..000000000000 --- a/reference/gmagick/gmagick/readimage.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - Gmagick::readimage - Reads image from filename - - - - &reftitle.description; - - public GmagickGmagick::readimage - stringfilename - - - Reads image from filename. - - - - - &reftitle.parameters; - - - filename - - - The image filename. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/readimageblob.xml b/reference/gmagick/gmagick/readimageblob.xml deleted file mode 100644 index dc36d0aa4ca9..000000000000 --- a/reference/gmagick/gmagick/readimageblob.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - Gmagick::readimageblob - Reads image from a binary string - - - - &reftitle.description; - - public GmagickGmagick::readimageblob - stringimageContents - stringfilename - - - Reads image from a binary string. - - - - - &reftitle.parameters; - - - imageContents - - - Content of image. - - - - - filename - - - The image filename. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/readimagefile.xml b/reference/gmagick/gmagick/readimagefile.xml deleted file mode 100644 index 27e8d5c10264..000000000000 --- a/reference/gmagick/gmagick/readimagefile.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - Gmagick::readimagefile - The readimagefile purpose - - - - &reftitle.description; - - public GmagickGmagick::readimagefile - resourcefp - stringfilename - - - Reads an image or image sequence from an open file descriptor. - - - - - &reftitle.parameters; - - - fp - - - The file descriptor. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/reducenoiseimage.xml b/reference/gmagick/gmagick/reducenoiseimage.xml deleted file mode 100644 index 50a5c732253c..000000000000 --- a/reference/gmagick/gmagick/reducenoiseimage.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - Gmagick::reducenoiseimage - Smooths the contours of an image - - - - &reftitle.description; - - public GmagickGmagick::reducenoiseimage - floatradius - - - Smooths the contours of an image while still preserving edge information. The algorithm works by replacing each pixel with its neighbor closest in value. A neighbor is defined by radius. - Use a radius of 0 and Gmagick::reducenoiseimage selects a suitable radius for you. - - - - - - &reftitle.parameters; - - - radius - - - The radius of the pixel neighborhood. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/removeimage.xml b/reference/gmagick/gmagick/removeimage.xml deleted file mode 100644 index e78b256a2a5b..000000000000 --- a/reference/gmagick/gmagick/removeimage.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - Gmagick::removeimage - Removes an image from the image list - - - - &reftitle.description; - - public GmagickGmagick::removeimage - - - - Removes an image from the image list. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/removeimageprofile.xml b/reference/gmagick/gmagick/removeimageprofile.xml deleted file mode 100644 index 7b2fd97ffd44..000000000000 --- a/reference/gmagick/gmagick/removeimageprofile.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - Gmagick::removeimageprofile - Removes the named image profile and returns it - - - - &reftitle.description; - - public stringGmagick::removeimageprofile - stringname - - - Removes the named image profile and returns it. - - - - - - - - &reftitle.parameters; - - - name - - - Name of profile to return: ICC, IPTC, or generic profile. - - - - - - - - &reftitle.returnvalues; - - The named profile. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/resampleimage.xml b/reference/gmagick/gmagick/resampleimage.xml deleted file mode 100644 index 0535b0f9a8f2..000000000000 --- a/reference/gmagick/gmagick/resampleimage.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - Gmagick::resampleimage - Resample image to desired resolution - - - - &reftitle.description; - - public GmagickGmagick::resampleimage - floatxResolution - floatyResolution - intfilter - floatblur - - - Resample image to desired resolution. - - - - - - - - &reftitle.parameters; - - - xResolution - - - The new image x resolution. - - - - - yResolution - - - The new image y resolution. - - - - - filter - - - Image filter to use. - - - - - blur - - - The blur factor where larger than 1 is blurry, smaller than 1 is sharp. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object on success - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/resizeimage.xml b/reference/gmagick/gmagick/resizeimage.xml deleted file mode 100644 index 4b784252a00d..000000000000 --- a/reference/gmagick/gmagick/resizeimage.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - Gmagick::resizeimage - Scales an image - - - - &reftitle.description; - - public GmagickGmagick::resizeimage - intwidth - intheight - intfilter - floatblur - boolfit&false; - - - Scales an image to the desired dimensions with a filter. - - - - - - &reftitle.parameters; - - - width - - - The number of columns in the scaled image. - - - - - height - - - The number of rows in the scaled image. - - - - - filter - - - Image filter to use. - - - - - blur - - - The blur factor where larger than 1 is blurry, lesser than 1 is sharp. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/rollimage.xml b/reference/gmagick/gmagick/rollimage.xml deleted file mode 100644 index c51173461e56..000000000000 --- a/reference/gmagick/gmagick/rollimage.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - Gmagick::rollimage - Offsets an image - - - - &reftitle.description; - - public GmagickGmagick::rollimage - intx - inty - - - Offsets an image as defined by x and y. - - - - - - - - &reftitle.parameters; - - - x - - - The x offset. - - - - - y - - - The y offset. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object on success - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/rotateimage.xml b/reference/gmagick/gmagick/rotateimage.xml deleted file mode 100644 index 110e791837fb..000000000000 --- a/reference/gmagick/gmagick/rotateimage.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - Gmagick::rotateimage - Rotates an image - - - - &reftitle.description; - - public GmagickGmagick::rotateimage - mixedcolor - floatdegrees - - - Rotates an image the specified number of degrees. Empty triangles left over from rotating the image are filled with the background color. - - - - - - - - &reftitle.parameters; - - - color - - - The background pixel. - - - - - degrees - - - The number of degrees to rotate the image. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object on success - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/scaleimage.xml b/reference/gmagick/gmagick/scaleimage.xml deleted file mode 100644 index 67a5b31dbd4a..000000000000 --- a/reference/gmagick/gmagick/scaleimage.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - Gmagick::scaleimage - Scales the size of an image - - - - &reftitle.description; - - public GmagickGmagick::scaleimage - intwidth - intheight - boolfit&false; - - - Scales the size of an image to the given dimensions. The other parameter will be calculated if 0 is passed as either param. - - - - - &reftitle.parameters; - - - width - - - The number of columns in the scaled image. - - - - - height - - - The number of rows in the scaled image. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object. - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/separateimagechannel.xml b/reference/gmagick/gmagick/separateimagechannel.xml deleted file mode 100644 index ae88ee460f9c..000000000000 --- a/reference/gmagick/gmagick/separateimagechannel.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - Gmagick::separateimagechannel - Separates a channel from the image - - - - &reftitle.description; - - public GmagickGmagick::separateimagechannel - intchannel - - - Separates a channel from the image and returns a grayscale image. A channel is a particular color component of each pixel in the image. - - - - - &reftitle.parameters; - - - channel - - - One of the Channel constant - (Gmagick::CHANNEL_*). - - - - - - - - &reftitle.returnvalues; - - The Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/setcompressionquality.xml b/reference/gmagick/gmagick/setcompressionquality.xml deleted file mode 100644 index 17ef1cf5f2e8..000000000000 --- a/reference/gmagick/gmagick/setcompressionquality.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - Gmagick::setCompressionQuality - Sets the object's default compression quality - - - - &reftitle.description; - - GmagickGmagick::setCompressionQuality - - intquality - - - - Sets the object's default compression quality. - - - - - &reftitle.parameters; - - - quality - - - The GraphicsMagick default value is 75. - - - - - - - - - &reftitle.returnvalues; - - The Gmagick object. - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - - - - - &reftitle.examples; - - <function>Gmagick::setCompressionQuality</function> - - read("magick:rose"); -$gm->setCompressionQuality(2); -?> -]]> - - - - - - diff --git a/reference/gmagick/gmagick/setfilename.xml b/reference/gmagick/gmagick/setfilename.xml deleted file mode 100644 index 96104e32dcb6..000000000000 --- a/reference/gmagick/gmagick/setfilename.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - Gmagick::setfilename - Sets the filename before you read or write the image - - - - &reftitle.description; - - public GmagickGmagick::setfilename - stringfilename - - - Sets the filename before you read or write an image file. - - - - - - &reftitle.parameters; - - - filename - - - The image filename. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object. - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/setimagebackgroundcolor.xml b/reference/gmagick/gmagick/setimagebackgroundcolor.xml deleted file mode 100644 index 59acce13ab46..000000000000 --- a/reference/gmagick/gmagick/setimagebackgroundcolor.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - Gmagick::setimagebackgroundcolor - Sets the image background color - - - - &reftitle.description; - - public GmagickGmagick::setimagebackgroundcolor - GmagickPixelcolor - - - Sets the image background color. - - - - - - &reftitle.parameters; - - - color - - - The background pixel wand. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object. - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimageblueprimary.xml b/reference/gmagick/gmagick/setimageblueprimary.xml deleted file mode 100644 index 0c18590edd37..000000000000 --- a/reference/gmagick/gmagick/setimageblueprimary.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - Gmagick::setimageblueprimary - Sets the image chromaticity blue primary point - - - - &reftitle.description; - - public GmagickGmagick::setimageblueprimary - floatx - floaty - - - Sets the image chromaticity blue primary point. - - - - - - &reftitle.parameters; - - - x - - - The blue primary x-point. - - - - - y - - - The blue primary y-point. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimagebordercolor.xml b/reference/gmagick/gmagick/setimagebordercolor.xml deleted file mode 100644 index 1d20f4c0c8a3..000000000000 --- a/reference/gmagick/gmagick/setimagebordercolor.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - Gmagick::setimagebordercolor - Sets the image border color - - - - &reftitle.description; - - public GmagickGmagick::setimagebordercolor - GmagickPixelcolor - - - Sets the image border color. - - - - - - &reftitle.parameters; - - - color - - - The border pixel wand. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimagechanneldepth.xml b/reference/gmagick/gmagick/setimagechanneldepth.xml deleted file mode 100644 index fa772c90ee85..000000000000 --- a/reference/gmagick/gmagick/setimagechanneldepth.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - Gmagick::setimagechanneldepth - Sets the depth of a particular image channel - - - - &reftitle.description; - - public GmagickGmagick::setimagechanneldepth - intchannel - intdepth - - - Sets the depth of a particular image channel. - - - - - - &reftitle.parameters; - - - channel - - - One of the Channel constant - (Gmagick::CHANNEL_*). - - - - - depth - - - The image depth in bits. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimagecolorspace.xml b/reference/gmagick/gmagick/setimagecolorspace.xml deleted file mode 100644 index b6ce9dc4688a..000000000000 --- a/reference/gmagick/gmagick/setimagecolorspace.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - Gmagick::setimagecolorspace - Sets the image colorspace - - - - &reftitle.description; - - public GmagickGmagick::setimagecolorspace - intcolorspace - - - Sets the image colorspace. - - - - - - &reftitle.parameters; - - - colorspace - - - One of the Colorspace constant - (Gmagick::COLORSPACE_*). - - - - - - - - &reftitle.returnvalues; - - The Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimagecompose.xml b/reference/gmagick/gmagick/setimagecompose.xml deleted file mode 100644 index edfb42c73c2c..000000000000 --- a/reference/gmagick/gmagick/setimagecompose.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - Gmagick::setimagecompose - Sets the image composite operator - - - - &reftitle.description; - - public GmagickGmagick::setimagecompose - intcomposite - - - Sets the image composite operator. - - - - - - - - &reftitle.parameters; - - - composite - - - The image composite operator. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object on success - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimagedelay.xml b/reference/gmagick/gmagick/setimagedelay.xml deleted file mode 100644 index 21fb68e9542f..000000000000 --- a/reference/gmagick/gmagick/setimagedelay.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - Gmagick::setimagedelay - Sets the image delay - - - - &reftitle.description; - - public GmagickGmagick::setimagedelay - intdelay - - - Sets the image delay. - - - - - &reftitle.parameters; - - - delay - - - The image delay in 1/100th of a second. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimagedepth.xml b/reference/gmagick/gmagick/setimagedepth.xml deleted file mode 100644 index 6def56d64290..000000000000 --- a/reference/gmagick/gmagick/setimagedepth.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - Gmagick::setimagedepth - Sets the image depth - - - - &reftitle.description; - - public GmagickGmagick::setimagedepth - intdepth - - - Sets the image depth. - - - - - &reftitle.parameters; - - - depth - - - The image depth in bits: 8, 16, or 32. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimagedispose.xml b/reference/gmagick/gmagick/setimagedispose.xml deleted file mode 100644 index d9027d148263..000000000000 --- a/reference/gmagick/gmagick/setimagedispose.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - Gmagick::setimagedispose - Sets the image disposal method - - - - &reftitle.description; - - public GmagickGmagick::setimagedispose - intdisposeType - - - Sets the image disposal method. - - - - - - &reftitle.parameters; - - - disposeType - - - The image disposal type. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/setimagefilename.xml b/reference/gmagick/gmagick/setimagefilename.xml deleted file mode 100644 index 20d7147b358f..000000000000 --- a/reference/gmagick/gmagick/setimagefilename.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - Gmagick::setimagefilename - Sets the filename of a particular image in a sequence - - - - &reftitle.description; - - public GmagickGmagick::setimagefilename - stringfilename - - - Sets the filename of a particular image in a sequence. - - - - - - &reftitle.parameters; - - - filename - - - The image filename. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/setimageformat.xml b/reference/gmagick/gmagick/setimageformat.xml deleted file mode 100644 index 095897c44864..000000000000 --- a/reference/gmagick/gmagick/setimageformat.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - Gmagick::setimageformat - Sets the format of a particular image - - - - &reftitle.description; - - public GmagickGmagick::setimageformat - stringimageFormat - - - Sets the format of a particular image in a sequence. - - - - - &reftitle.parameters; - - - imageFormat - - - The image format. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/setimagegamma.xml b/reference/gmagick/gmagick/setimagegamma.xml deleted file mode 100644 index a4ec5254e246..000000000000 --- a/reference/gmagick/gmagick/setimagegamma.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - Gmagick::setimagegamma - Sets the image gamma - - - - &reftitle.description; - - public GmagickGmagick::setimagegamma - floatgamma - - - Sets the image gamma. - - - - - - &reftitle.parameters; - - - gamma - - - The image gamma. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimagegreenprimary.xml b/reference/gmagick/gmagick/setimagegreenprimary.xml deleted file mode 100644 index 8198eb5c0830..000000000000 --- a/reference/gmagick/gmagick/setimagegreenprimary.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - Gmagick::setimagegreenprimary - Sets the image chromaticity green primary point - - - - &reftitle.description; - - public GmagickGmagick::setimagegreenprimary - floatx - floaty - - - Sets the image chromaticity green primary point. - - - - - - &reftitle.parameters; - - - x - - - The chromaticity green primary x-point. - - - - - y - - - The chromaticity green primary y-point. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimageindex.xml b/reference/gmagick/gmagick/setimageindex.xml deleted file mode 100644 index ed52ee85d496..000000000000 --- a/reference/gmagick/gmagick/setimageindex.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - Gmagick::setimageindex - Set the iterator to the position in the image list specified with the index parameter - - - - &reftitle.description; - - public GmagickGmagick::setimageindex - intindex - - - Set the iterator to the position in the image list specified with the index parameter. - - - - - - &reftitle.parameters; - - - index - - - The scene number. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimageinterlacescheme.xml b/reference/gmagick/gmagick/setimageinterlacescheme.xml deleted file mode 100644 index 42eb1eb5ce7f..000000000000 --- a/reference/gmagick/gmagick/setimageinterlacescheme.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - Gmagick::setimageinterlacescheme - Sets the interlace scheme of the image - - - - &reftitle.description; - - public GmagickGmagick::setimageinterlacescheme - intinterlace - - - Sets the interlace scheme of the image. - - - - - - &reftitle.parameters; - - - interlace - - - One of the Interlace constant - (Gmagick::INTERLACE_*). - - - - - - - - &reftitle.returnvalues; - - The Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/setimageiterations.xml b/reference/gmagick/gmagick/setimageiterations.xml deleted file mode 100644 index b2fec74daf04..000000000000 --- a/reference/gmagick/gmagick/setimageiterations.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - Gmagick::setimageiterations - Sets the image iterations - - - - &reftitle.description; - - public GmagickGmagick::setimageiterations - intiterations - - - Sets the image iterations. - - - - - &reftitle.parameters; - - - iterations - - - The image delay in 1/100th of a second. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimageprofile.xml b/reference/gmagick/gmagick/setimageprofile.xml deleted file mode 100644 index 417d09ffe881..000000000000 --- a/reference/gmagick/gmagick/setimageprofile.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - Gmagick::setimageprofile - Adds a named profile to the Gmagick object - - - - &reftitle.description; - - public GmagickGmagick::setimageprofile - stringname - stringprofile - - - Adds a named profile to the Gmagick object. If a profile with the same name already exists, it is replaced. - This method differs from the Gmagick::profileimage() method in that it does not apply any CMS color profiles. - - - - - - - - &reftitle.parameters; - - - name - - - Name of profile to add or remove: ICC, IPTC, or generic profile. - - - - - profile - - - The profile. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object on success. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimageredprimary.xml b/reference/gmagick/gmagick/setimageredprimary.xml deleted file mode 100644 index e482101237f2..000000000000 --- a/reference/gmagick/gmagick/setimageredprimary.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - Gmagick::setimageredprimary - Sets the image chromaticity red primary point - - - - &reftitle.description; - - public GmagickGmagick::setimageredprimary - floatx - floaty - - - Sets the image chromaticity red primary point. - - - - - - - - &reftitle.parameters; - - - x - - - The red primary x-point. - - - - - y - - - The red primary y-point. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object on success. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimagerenderingintent.xml b/reference/gmagick/gmagick/setimagerenderingintent.xml deleted file mode 100644 index e5ed8fdf565d..000000000000 --- a/reference/gmagick/gmagick/setimagerenderingintent.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - Gmagick::setimagerenderingintent - Sets the image rendering intent - - - - &reftitle.description; - - public GmagickGmagick::setimagerenderingintent - intrendering_intent - - - Sets the image rendering intent. - - - - - - &reftitle.parameters; - - - rendering_intent - - - One of the Rendering Intent constant - (Gmagick::RENDERINGINTENT_*). - - - - - - - - &reftitle.returnvalues; - - The Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimageresolution.xml b/reference/gmagick/gmagick/setimageresolution.xml deleted file mode 100644 index e55cd95cc0e5..000000000000 --- a/reference/gmagick/gmagick/setimageresolution.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - Gmagick::setimageresolution - Sets the image resolution - - - - &reftitle.description; - - public GmagickGmagick::setimageresolution - floatxResolution - floatyResolution - - - Sets the image resolution. - - - - - - - - &reftitle.parameters; - - - xResolution - - - The image x resolution. - - - - - yResolution - - - The image y resolution. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object on success. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimagescene.xml b/reference/gmagick/gmagick/setimagescene.xml deleted file mode 100644 index 3a09b16d1acd..000000000000 --- a/reference/gmagick/gmagick/setimagescene.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - Gmagick::setimagescene - Sets the image scene - - - - &reftitle.description; - - public GmagickGmagick::setimagescene - intscene - - - Sets the image scene. - - - - - &reftitle.parameters; - - - scene - - - The image scene number. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimagetype.xml b/reference/gmagick/gmagick/setimagetype.xml deleted file mode 100644 index 011080abf07d..000000000000 --- a/reference/gmagick/gmagick/setimagetype.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - Gmagick::setimagetype - Sets the image type - - - - &reftitle.description; - - public GmagickGmagick::setimagetype - intimgType - - - Sets the image type. - - - - - &reftitle.parameters; - - - imgType - - - One of the Image type constant - (Gmagick::IMGTYPE_*). - - - - - - - - &reftitle.returnvalues; - - The Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimageunits.xml b/reference/gmagick/gmagick/setimageunits.xml deleted file mode 100644 index 18c0abb4a810..000000000000 --- a/reference/gmagick/gmagick/setimageunits.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - Gmagick::setimageunits - Sets the image units of resolution - - - - &reftitle.description; - - public GmagickGmagick::setimageunits - intresolution - - - Sets the image units of resolution. - - - - - &reftitle.parameters; - - - resolution - - - One of the Resolution constant - (Gmagick::RESOLUTION_*). - - - - - - - - &reftitle.returnvalues; - - The Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimagewhitepoint.xml b/reference/gmagick/gmagick/setimagewhitepoint.xml deleted file mode 100644 index 3c22c070ad07..000000000000 --- a/reference/gmagick/gmagick/setimagewhitepoint.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - Gmagick::setimagewhitepoint - Sets the image chromaticity white point - - - - &reftitle.description; - - public GmagickGmagick::setimagewhitepoint - floatx - floaty - - - Sets the image chromaticity white point. - - - - - &reftitle.parameters; - - - x - - - The white x-point. - - - - - y - - - The white y-point. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setsamplingfactors.xml b/reference/gmagick/gmagick/setsamplingfactors.xml deleted file mode 100644 index fb5b2fe0ddac..000000000000 --- a/reference/gmagick/gmagick/setsamplingfactors.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - Gmagick::setsamplingfactors - Sets the image sampling factors - - - - &reftitle.description; - - public GmagickGmagick::setsamplingfactors - arrayfactors - - - Sets the image sampling factors. - - - - - &reftitle.parameters; - - - factors - - - An array of floats representing the sampling factor for each color component (in RGB order). - - - - - - - - &reftitle.returnvalues; - - The Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setsize.xml b/reference/gmagick/gmagick/setsize.xml deleted file mode 100644 index 2ecab65648ab..000000000000 --- a/reference/gmagick/gmagick/setsize.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - Gmagick::setsize - Sets the size of the Gmagick object - - - - &reftitle.description; - - public GmagickGmagick::setsize - intcolumns - introws - - - Sets the size of the Gmagick object. Set it before you read a raw image format such as Gmagick::COLORSPACE_RGB, - Gmagick::COLORSPACE_GRAY, or Gmagick::COLORSPACE_CMYK. - - - - - &reftitle.parameters; - - - columns - - - The width in pixels. - - - - - rows - - - The height in pixels. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/shearimage.xml b/reference/gmagick/gmagick/shearimage.xml deleted file mode 100644 index e823bd5beb23..000000000000 --- a/reference/gmagick/gmagick/shearimage.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - Gmagick::shearimage - Creating a parallelogram - - - - &reftitle.description; - - public GmagickGmagick::shearimage - mixedcolor - floatxShear - floatyShear - - -Slides one edge of an image along the X or Y axis, creating a parallelogram. - An X direction shear slides an edge along the X axis, while a Y direction shear slides an edge along the Y axis. -The amount of the shear is controlled by a shear angle. For X direction shears, x_shear is measured relative to the - Y axis, and similarly, for Y direction shears y_shear is measured relative to the X axis. Empty triangles left over - from shearing the image are filled with the background color. - - - - - - &reftitle.parameters; - - - color - - - The background pixel wand. - - - - - xShear - - - The number of degrees to shear the image. - - - - - yShear - - - The number of degrees to shear the image. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/solarizeimage.xml b/reference/gmagick/gmagick/solarizeimage.xml deleted file mode 100644 index 162c866ea412..000000000000 --- a/reference/gmagick/gmagick/solarizeimage.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - Gmagick::solarizeimage - Applies a solarizing effect to the image - - - - &reftitle.description; - - public GmagickGmagick::solarizeimage - intthreshold - - - Applies a special effect to the image, similar to the effect achieved in a - photo darkroom by selectively exposing areas of photo sensitive paper to light. - Threshold ranges from 0 to QuantumRange and is a measure of the extent of the solarization. - - - - - - &reftitle.parameters; - - - threshold - - - Define the extent of the solarization. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/spreadimage.xml b/reference/gmagick/gmagick/spreadimage.xml deleted file mode 100644 index f4b12fe26632..000000000000 --- a/reference/gmagick/gmagick/spreadimage.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - Gmagick::spreadimage - Randomly displaces each pixel in a block - - - - &reftitle.description; - - public GmagickGmagick::spreadimage - floatradius - - - Special effects method that randomly displaces each pixel in a block defined by the radius parameter. - - - - - - &reftitle.parameters; - - - radius - - - Choose a random pixel in a neighborhood of this extent. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/stripimage.xml b/reference/gmagick/gmagick/stripimage.xml deleted file mode 100644 index 9706275306f4..000000000000 --- a/reference/gmagick/gmagick/stripimage.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - Gmagick::stripimage - Strips an image of all profiles and comments - - - - &reftitle.description; - - public GmagickGmagick::stripimage - - - - Strips an image of all profiles and comments. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/swirlimage.xml b/reference/gmagick/gmagick/swirlimage.xml deleted file mode 100644 index c68ccd0f014b..000000000000 --- a/reference/gmagick/gmagick/swirlimage.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - Gmagick::swirlimage - Swirls the pixels about the center of the image - - - - &reftitle.description; - - public GmagickGmagick::swirlimage - floatdegrees - - - Swirls the pixels about the center of the image, where degrees indicates the sweep of the arc through which each pixel is moved. You get a more dramatic effect as the degrees move from 1 to 360. - - - - - - &reftitle.parameters; - - - degrees - - - Define the tightness of the swirling effect. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/thumbnailimage.xml b/reference/gmagick/gmagick/thumbnailimage.xml deleted file mode 100644 index 5d14c12a5e19..000000000000 --- a/reference/gmagick/gmagick/thumbnailimage.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - Gmagick::thumbnailimage - Changes the size of an image - - - - &reftitle.description; - - public GmagickGmagick::thumbnailimage - intwidth - intheight - boolfit&false; - - - Changes the size of an image to the given dimensions and removes any associated profiles. -The goal is to produce small low cost thumbnail images suited for display on the Web. -If &true; is given as a third parameter then columns and rows parameters are used as maximums - for each side. Both sides will be scaled down until the match or are smaller than the parameter given for the side. - - - - - &reftitle.parameters; - - - width - - - Image width. - - - - - height - - - Image height. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/trimimage.xml b/reference/gmagick/gmagick/trimimage.xml deleted file mode 100644 index b741d5312936..000000000000 --- a/reference/gmagick/gmagick/trimimage.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - Gmagick::trimimage - Remove edges from the image - - - - &reftitle.description; - - public GmagickGmagick::trimimage - floatfuzz - - - Remove edges that are the background color from the image. - - - - - - &reftitle.parameters; - - - fuzz - - - By default target must match a particular pixel color exactly. However, in many cases two colors may differ by a small amount. The fuzz member of image defines how much tolerance is acceptable to consider two colors as the same. This parameter represents the variation on the quantum range. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/write.xml b/reference/gmagick/gmagick/write.xml deleted file mode 100644 index 668dc120456c..000000000000 --- a/reference/gmagick/gmagick/write.xml +++ /dev/null @@ -1,39 +0,0 @@ - - - - - - - Gmagick::write - &Alias; Gmagick::writeimage - - - - &reftitle.description; - - &info.method.alias; Gmagick::writeimage. - - - - - - diff --git a/reference/gmagick/gmagick/writeimage.xml b/reference/gmagick/gmagick/writeimage.xml deleted file mode 100644 index 460a3dace35e..000000000000 --- a/reference/gmagick/gmagick/writeimage.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - Gmagick::writeimage - Writes an image to the specified filename - - - - &reftitle.description; - - public GmagickGmagick::writeimage - stringfilename - boolall_frames&false; - - - Writes an image to the specified filename. If the filename parameter is &null;, - the image is written to the filename set by Gmagick::readimage or Gmagick::setimagefilename. - - - - - &reftitle.parameters; - - - filename - - - The image filename. - - - - - - - - &reftitle.returnvalues; - - The Gmagick object. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagickdraw.xml b/reference/gmagick/gmagickdraw.xml deleted file mode 100644 index 94d3ca46e87d..000000000000 --- a/reference/gmagick/gmagickdraw.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - The GmagickDraw class - GmagickDraw - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - GmagickDraw - - - - - GmagickDraw - - - - - &Methods; - - - - -
- -
- - &reference.gmagick.entities.gmagickdraw; - -
- diff --git a/reference/gmagick/gmagickdraw/annotate.xml b/reference/gmagick/gmagickdraw/annotate.xml deleted file mode 100644 index 784d95b2cea1..000000000000 --- a/reference/gmagick/gmagickdraw/annotate.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - GmagickDraw::annotate - Draws text on the image - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::annotate - floatx - floaty - stringtext - - - Draws text on the image. - - - - - - - - &reftitle.parameters; - - - x - - - x ordinate to left of text - - - - - y - - - y ordinate to text baseline - - - - - text - - - text to draw - - - - - - - - &reftitle.returnvalues; - - The GmagickDraw object. - - - - - diff --git a/reference/gmagick/gmagickdraw/arc.xml b/reference/gmagick/gmagickdraw/arc.xml deleted file mode 100644 index 35a86a8c83b5..000000000000 --- a/reference/gmagick/gmagickdraw/arc.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - GmagickDraw::arc - Draws an arc - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::arc - floatsx - floatsy - floatex - floatey - floatsd - floated - - - Draws an arc falling within a specified bounding rectangle on the image. - - - - - - - - &reftitle.parameters; - - - sx - - - starting x ordinate of bounding rectangle - - - - - sy - - - starting y ordinate of bounding rectangle - - - - - ex - - - ending x ordinate of bounding rectangle - - - - - ey - - - ending y ordinate of bounding rectangle - - - - - sd - - - starting degrees of rotation - - - - - ed - - - ending degrees of rotation - - - - - - - - &reftitle.returnvalues; - - The GmagickDraw object. - - - - - - diff --git a/reference/gmagick/gmagickdraw/bezier.xml b/reference/gmagick/gmagickdraw/bezier.xml deleted file mode 100644 index 6244d207936b..000000000000 --- a/reference/gmagick/gmagickdraw/bezier.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - GmagickDraw::bezier - Draws a bezier curve - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::bezier - arraycoordinate_array - - - Draws a bezier curve through a set of points on the image. - - - - - - - - &reftitle.parameters; - - - coordinate_array - - - Coordinates array - - - - - - - - &reftitle.returnvalues; - - The GmagickDraw object. - - - - - diff --git a/reference/gmagick/gmagickdraw/ellipse.xml b/reference/gmagick/gmagickdraw/ellipse.xml deleted file mode 100644 index 7244280b74a0..000000000000 --- a/reference/gmagick/gmagickdraw/ellipse.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - GmagickDraw::ellipse - Draws an ellipse on the image - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::ellipse - floatox - floatoy - floatrx - floatry - floatstart - floatend - - - Draws an ellipse on the image. - - - - - &reftitle.parameters; - - - ox - - - origin x ordinate - - - - - oy - - - origin y ordinate - - - - - rx - - - radius in x - - - - - ry - - - radius in y - - - - - start - - - starting rotation in degrees - - - - - end - - - ending rotation in degrees - - - - - - - - &reftitle.returnvalues; - - The GmagickDraw object. - - - - - - diff --git a/reference/gmagick/gmagickdraw/getfillcolor.xml b/reference/gmagick/gmagickdraw/getfillcolor.xml deleted file mode 100644 index 46e7b58b900f..000000000000 --- a/reference/gmagick/gmagickdraw/getfillcolor.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - GmagickDraw::getfillcolor - Returns the fill color - - - - &reftitle.description; - - public GmagickPixelGmagickDraw::getfillcolor - - - - Returns the fill color used for drawing filled objects. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The GmagickPixel fill color used for drawing filled objects. - - - - - diff --git a/reference/gmagick/gmagickdraw/getfillopacity.xml b/reference/gmagick/gmagickdraw/getfillopacity.xml deleted file mode 100644 index 9cc182f19b30..000000000000 --- a/reference/gmagick/gmagickdraw/getfillopacity.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - GmagickDraw::getfillopacity - Returns the opacity used when drawing - - - - &reftitle.description; - - public floatGmagickDraw::getfillopacity - - - - Returns the opacity used when drawing - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the opacity used when drawing using the fill color or fill texture. Fully opaque is 1.0. - - - - - diff --git a/reference/gmagick/gmagickdraw/getfont.xml b/reference/gmagick/gmagickdraw/getfont.xml deleted file mode 100644 index 345c9c5b4c22..000000000000 --- a/reference/gmagick/gmagickdraw/getfont.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - GmagickDraw::getfont - Returns the font - - - - &reftitle.description; - - public mixedGmagickDraw::getfont - - - - Returns a string specifying the font used when annotating with text. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a string on success and &false; if no font is set. - - - - - diff --git a/reference/gmagick/gmagickdraw/getfontsize.xml b/reference/gmagick/gmagickdraw/getfontsize.xml deleted file mode 100644 index 2481e8a899c5..000000000000 --- a/reference/gmagick/gmagickdraw/getfontsize.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - GmagickDraw::getfontsize - Returns the font pointsize - - - - &reftitle.description; - - public floatGmagickDraw::getfontsize - - - - Returns the font pointsize used when annotating with text. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the font size associated with the current - GmagickDraw object. - - - - - diff --git a/reference/gmagick/gmagickdraw/getfontstyle.xml b/reference/gmagick/gmagickdraw/getfontstyle.xml deleted file mode 100644 index 7418430b7aa2..000000000000 --- a/reference/gmagick/gmagickdraw/getfontstyle.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - GmagickDraw::getfontstyle - Returns the font style - - - - &reftitle.description; - - public intGmagickDraw::getfontstyle - - - - Returns the font style used when annotating with text. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the font style constant (STYLE_) associated with the - GmagickDraw object or 0 if no style - is set. - - - - - diff --git a/reference/gmagick/gmagickdraw/getfontweight.xml b/reference/gmagick/gmagickdraw/getfontweight.xml deleted file mode 100644 index ff0095ac97e5..000000000000 --- a/reference/gmagick/gmagickdraw/getfontweight.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - GmagickDraw::getfontweight - Returns the font weight - - - - &reftitle.description; - - public intGmagickDraw::getfontweight - - - - Returns the font weight used when annotating with text. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an int on success and 0 if no weight is set. - - - - - diff --git a/reference/gmagick/gmagickdraw/getstrokecolor.xml b/reference/gmagick/gmagickdraw/getstrokecolor.xml deleted file mode 100644 index 490d85c2c42d..000000000000 --- a/reference/gmagick/gmagickdraw/getstrokecolor.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - GmagickDraw::getstrokecolor - Returns the color used for stroking object outlines - - - - &reftitle.description; - - public GmagickPixelGmagickDraw::getstrokecolor - - - - Returns the color used for stroking object outlines. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an GmagickPixel object which describes the color. - - - - - diff --git a/reference/gmagick/gmagickdraw/getstrokeopacity.xml b/reference/gmagick/gmagickdraw/getstrokeopacity.xml deleted file mode 100644 index ffc414637e4d..000000000000 --- a/reference/gmagick/gmagickdraw/getstrokeopacity.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - GmagickDraw::getstrokeopacity - Returns the opacity of stroked object outlines - - - - &reftitle.description; - - public floatGmagickDraw::getstrokeopacity - - - - Returns the opacity of stroked object outlines. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a float describing the opacity. - - - - - diff --git a/reference/gmagick/gmagickdraw/getstrokewidth.xml b/reference/gmagick/gmagickdraw/getstrokewidth.xml deleted file mode 100644 index 931108e586bb..000000000000 --- a/reference/gmagick/gmagickdraw/getstrokewidth.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - GmagickDraw::getstrokewidth - Returns the width of the stroke used to draw object outlines - - - - &reftitle.description; - - public floatGmagickDraw::getstrokewidth - - - - Returns the width of the stroke used to draw object outlines. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a float describing the stroke width. - - - - - diff --git a/reference/gmagick/gmagickdraw/gettextdecoration.xml b/reference/gmagick/gmagickdraw/gettextdecoration.xml deleted file mode 100644 index f53643ee6d22..000000000000 --- a/reference/gmagick/gmagickdraw/gettextdecoration.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - GmagickDraw::gettextdecoration - Returns the text decoration - - - - &reftitle.description; - - public intGmagickDraw::gettextdecoration - - - - Returns the decoration applied when annotating with text. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns one of the DECORATION_ constants and 0 if no decoration is set. - - - - - diff --git a/reference/gmagick/gmagickdraw/gettextencoding.xml b/reference/gmagick/gmagickdraw/gettextencoding.xml deleted file mode 100644 index ce6ae0933729..000000000000 --- a/reference/gmagick/gmagickdraw/gettextencoding.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - GmagickDraw::gettextencoding - Returns the code set used for text annotations - - - - &reftitle.description; - - public mixedGmagickDraw::gettextencoding - - - - Returns a string which specifies the code set used for text annotations. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a string specifying the code set or &false; if text encoding is not set. - - - - - diff --git a/reference/gmagick/gmagickdraw/line.xml b/reference/gmagick/gmagickdraw/line.xml deleted file mode 100644 index 1edbafdd0efc..000000000000 --- a/reference/gmagick/gmagickdraw/line.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - GmagickDraw::line - Draws a line - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::line - floatsx - floatsy - floatex - floatey - - - Draws a line on the image using the current stroke color, stroke opacity, and stroke width. - - - - - - - - &reftitle.parameters; - - - sx - - - starting x ordinate - - - - - sy - - - starting y ordinate - - - - - ex - - - ending x ordinate - - - - - ey - - - ending y ordinate - - - - - - - - &reftitle.returnvalues; - - The GmagickDraw object. - - - - - diff --git a/reference/gmagick/gmagickdraw/point.xml b/reference/gmagick/gmagickdraw/point.xml deleted file mode 100644 index b3c237ee22c2..000000000000 --- a/reference/gmagick/gmagickdraw/point.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - GmagickDraw::point - Draws a point - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::point - floatx - floaty - - - Draws a point using the current stroke color and stroke thickness at the specified coordinates. - - - - - - - - &reftitle.parameters; - - - x - - - target x coordinate - - - - - y - - - target y coordinate - - - - - - - - &reftitle.returnvalues; - - The GmagickDraw object. - - - - - - diff --git a/reference/gmagick/gmagickdraw/polygon.xml b/reference/gmagick/gmagickdraw/polygon.xml deleted file mode 100644 index 0360d59b480e..000000000000 --- a/reference/gmagick/gmagickdraw/polygon.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - GmagickDraw::polygon - Draws a polygon - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::polygon - arraycoordinates - - - Draws a polygon using the current stroke, stroke width, and fill color or texture, using the specified array of coordinates. - - - - - - - - &reftitle.parameters; - - - coordinates - - - coordinate array - - - - - - - - &reftitle.returnvalues; - - The GmagickDraw object. - - - - - - diff --git a/reference/gmagick/gmagickdraw/polyline.xml b/reference/gmagick/gmagickdraw/polyline.xml deleted file mode 100644 index 9f50826b8d07..000000000000 --- a/reference/gmagick/gmagickdraw/polyline.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - GmagickDraw::polyline - Draws a polyline - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::polyline - arraycoordinate_array - - - Draws a polyline using the current stroke, stroke width, and fill color or texture, using the specified array of coordinates. - - - - - - - - &reftitle.parameters; - - - coordinate_array - - - The array of coordinates - - - - - - - - &reftitle.returnvalues; - - The GmagickDraw object. - - - - - diff --git a/reference/gmagick/gmagickdraw/rectangle.xml b/reference/gmagick/gmagickdraw/rectangle.xml deleted file mode 100644 index a18c8d179aa5..000000000000 --- a/reference/gmagick/gmagickdraw/rectangle.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - GmagickDraw::rectangle - Draws a rectangle - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::rectangle - floatx1 - floaty1 - floatx2 - floaty2 - - - Draws a rectangle given two coordinates and using the current stroke, stroke width, and fill settings. - - - - - - - - &reftitle.parameters; - - - x1 - - - x ordinate of first coordinate - - - - - y1 - - - y ordinate of first coordinate - - - - - x2 - - - x ordinate of second coordinate - - - - - y2 - - - y ordinate of second coordinate - - - - - - - - &reftitle.returnvalues; - - The GmagickDraw object. - - - - - diff --git a/reference/gmagick/gmagickdraw/rotate.xml b/reference/gmagick/gmagickdraw/rotate.xml deleted file mode 100644 index 5ccbfb4b931b..000000000000 --- a/reference/gmagick/gmagickdraw/rotate.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - GmagickDraw::rotate - Applies the specified rotation to the current coordinate space - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::rotate - floatdegrees - - - Applies the specified rotation to the current coordinate space. - - - - - - - - &reftitle.parameters; - - - degrees - - - degrees of rotation - - - - - - - - &reftitle.returnvalues; - - The GmagickDraw object. - - - - - diff --git a/reference/gmagick/gmagickdraw/roundrectangle.xml b/reference/gmagick/gmagickdraw/roundrectangle.xml deleted file mode 100644 index cc3da39b946b..000000000000 --- a/reference/gmagick/gmagickdraw/roundrectangle.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - GmagickDraw::roundrectangle - Draws a rounded rectangle - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::roundrectangle - floatx1 - floaty1 - floatx2 - floaty2 - floatrx - floatry - - - Draws a rounded rectangle given two coordinates, x and y corner radiuses and using the current stroke, stroke width, and fill settings. - - - - - - - - &reftitle.parameters; - - - x1 - - - x ordinate of first coordinate - - - - - y1 - - - y ordinate of first coordinate - - - - - x2 - - - x ordinate of second coordinate - - - - - y2 - - - y ordinate of second coordinate - - - - - rx - - - radius of corner in horizontal direction - - - - - ry - - - radius of corner in vertical direction - - - - - - - - &reftitle.returnvalues; - - The GmagickDraw object. - - - - - diff --git a/reference/gmagick/gmagickdraw/scale.xml b/reference/gmagick/gmagickdraw/scale.xml deleted file mode 100644 index 15a05e6bb0ac..000000000000 --- a/reference/gmagick/gmagickdraw/scale.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - GmagickDraw::scale - Adjusts the scaling factor - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::scale - floatx - floaty - - - Adjusts the scaling factor to apply in the horizontal and vertical directions to the current coordinate space. - - - - - - - - &reftitle.parameters; - - - x - - - horizontal scale factor - - - - - y - - - vertical scale factor - - - - - - - - &reftitle.returnvalues; - - The GmagickDraw object. - - - - - diff --git a/reference/gmagick/gmagickdraw/setfillcolor.xml b/reference/gmagick/gmagickdraw/setfillcolor.xml deleted file mode 100644 index b393ff5a69e5..000000000000 --- a/reference/gmagick/gmagickdraw/setfillcolor.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - GmagickDraw::setfillcolor - Sets the fill color to be used for drawing filled objects - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::setfillcolor - mixedcolor - - - Sets the fill color to be used for drawing filled objects. - - - - - - - - &reftitle.parameters; - - - color - - - GmagickPixel or string indicating color to use for filling. - - - - - - - - &reftitle.returnvalues; - - The GmagickDraw object on success. - - - - - diff --git a/reference/gmagick/gmagickdraw/setfillopacity.xml b/reference/gmagick/gmagickdraw/setfillopacity.xml deleted file mode 100644 index 29dfd3c5535d..000000000000 --- a/reference/gmagick/gmagickdraw/setfillopacity.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - GmagickDraw::setfillopacity - The setfillopacity purpose - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::setfillopacity - floatfill_opacity - - - Sets the opacity to use when drawing using the fill color or fill texture. Setting it to 1.0 will make - fill full opaque. - - - - - - - - &reftitle.parameters; - - - fill_opacity - - - Fill opacity - - - - - - - - &reftitle.returnvalues; - - The GmagickDraw object. - - - - - diff --git a/reference/gmagick/gmagickdraw/setfont.xml b/reference/gmagick/gmagickdraw/setfont.xml deleted file mode 100644 index 46518e15ea50..000000000000 --- a/reference/gmagick/gmagickdraw/setfont.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - GmagickDraw::setfont - Sets the fully-specified font to use when annotating with text - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::setfont - stringfont - - - Sets the fully-specified font to use when annotating with text - - - - - - - - &reftitle.parameters; - - - font - - - font name - - - - - - - - &reftitle.returnvalues; - - The GmagickDraw object. - - - - - diff --git a/reference/gmagick/gmagickdraw/setfontsize.xml b/reference/gmagick/gmagickdraw/setfontsize.xml deleted file mode 100644 index e9b5c3936000..000000000000 --- a/reference/gmagick/gmagickdraw/setfontsize.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - GmagickDraw::setfontsize - Sets the font pointsize to use when annotating with text - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::setfontsize - floatpointsize - - - Sets the font pointsize to use when annotating with text. - - - - - - - - &reftitle.parameters; - - - pointsize - - - Text pointsize - - - - - - - - &reftitle.returnvalues; - - The GmagickDraw object. - - - - - diff --git a/reference/gmagick/gmagickdraw/setfontstyle.xml b/reference/gmagick/gmagickdraw/setfontstyle.xml deleted file mode 100644 index fd6ecddf9968..000000000000 --- a/reference/gmagick/gmagickdraw/setfontstyle.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - GmagickDraw::setfontstyle - Sets the font style to use when annotating with text - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::setfontstyle - intstyle - - - Sets the font style to use when annotating with text. The AnyStyle enumeration acts as a wild-card "don't care" option. - - - - - - - - &reftitle.parameters; - - - style - - - Font style (NormalStyle, ItalicStyle, ObliqueStyle, AnyStyle) - - - - - - - - &reftitle.returnvalues; - - The GmagickDraw object. - - - - - - diff --git a/reference/gmagick/gmagickdraw/setfontweight.xml b/reference/gmagick/gmagickdraw/setfontweight.xml deleted file mode 100644 index 5dac2cb8d88b..000000000000 --- a/reference/gmagick/gmagickdraw/setfontweight.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - GmagickDraw::setfontweight - Sets the font weight - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::setfontweight - intweight - - - Sets the font weight to use when annotating with text. - - - - - - &reftitle.parameters; - - - weight - - - Font weight (valid range 100-900) - - - - - - - - &reftitle.returnvalues; - - The GmagickDraw object. - - - - - diff --git a/reference/gmagick/gmagickdraw/setstrokecolor.xml b/reference/gmagick/gmagickdraw/setstrokecolor.xml deleted file mode 100644 index 1dab04663b4d..000000000000 --- a/reference/gmagick/gmagickdraw/setstrokecolor.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - GmagickDraw::setstrokecolor - Sets the color used for stroking object outlines - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::setstrokecolor - mixedcolor - - - Sets the color used for stroking object outlines. - - - - - - - - &reftitle.parameters; - - - color - - - GmagickPixel or string representing the color for the stroke. - - - - - - - - &reftitle.returnvalues; - - The GmagickDraw object on success. - - - - - diff --git a/reference/gmagick/gmagickdraw/setstrokeopacity.xml b/reference/gmagick/gmagickdraw/setstrokeopacity.xml deleted file mode 100644 index ee96b9e57f61..000000000000 --- a/reference/gmagick/gmagickdraw/setstrokeopacity.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - GmagickDraw::setstrokeopacity - Specifies the opacity of stroked object outlines - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::setstrokeopacity - floatstroke_opacity - - - Specifies the opacity of stroked object outlines. - - - - - - - - &reftitle.parameters; - - - stroke_opacity - - - Stroke opacity. The value 1.0 is opaque. - - - - - - - - &reftitle.returnvalues; - - The GmagickDraw object. - - - - - diff --git a/reference/gmagick/gmagickdraw/setstrokewidth.xml b/reference/gmagick/gmagickdraw/setstrokewidth.xml deleted file mode 100644 index cd1a8f9c71f2..000000000000 --- a/reference/gmagick/gmagickdraw/setstrokewidth.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - GmagickDraw::setstrokewidth - Sets the width of the stroke used to draw object outlines - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::setstrokewidth - floatwidth - - - Sets the width of the stroke used to draw object outlines - - - - - - - - &reftitle.parameters; - - - width - - - Stroke width - - - - - - - - &reftitle.returnvalues; - - The GmagickDraw object. - - - - - diff --git a/reference/gmagick/gmagickdraw/settextdecoration.xml b/reference/gmagick/gmagickdraw/settextdecoration.xml deleted file mode 100644 index 86407e9084f3..000000000000 --- a/reference/gmagick/gmagickdraw/settextdecoration.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - GmagickDraw::settextdecoration - Specifies a decoration - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::settextdecoration - intdecoration - - - Specifies a decoration to be applied when annotating with text. - - - - - - - - &reftitle.parameters; - - - int - - - Text decoration. One of NoDecoration, UnderlineDecoration, OverlineDecoration, or LineThroughDecoration - - - - - - - - &reftitle.returnvalues; - - The GmagickDraw object. - - - - - diff --git a/reference/gmagick/gmagickdraw/settextencoding.xml b/reference/gmagick/gmagickdraw/settextencoding.xml deleted file mode 100644 index 082b662db5d1..000000000000 --- a/reference/gmagick/gmagickdraw/settextencoding.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - GmagickDraw::settextencoding - Specifies the text code set - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::settextencoding - stringencoding - - - Specifies the code set to use for text annotations. The only character - encoding which may be specified at this time is "UTF-8" for representing Unicode as - a sequence of bytes. Specify an empty string to set text encoding to the system's default. - Successful text annotation using Unicode may require fonts designed to support Unicode. - - - - - - - - &reftitle.parameters; - - - encoding - - - Character string specifying text encoding - - - - - - - - &reftitle.returnvalues; - - The GmagickDraw object. - - - - diff --git a/reference/gmagick/gmagickexception.xml b/reference/gmagick/gmagickexception.xml deleted file mode 100644 index d8c92f502b7c..000000000000 --- a/reference/gmagick/gmagickexception.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - The GmagickException class - GmagickException - - - - -
- &reftitle.intro; - - GmagickException class - -
- - -
- &reftitle.classsynopsis; - - - - GmagickException - - - - - GmagickException - - - - extends - Exception - - - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
- - -
- -
- diff --git a/reference/gmagick/gmagickpixel.xml b/reference/gmagick/gmagickpixel.xml deleted file mode 100644 index d9dc28a1bf54..000000000000 --- a/reference/gmagick/gmagickpixel.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - The GmagickPixel class - GmagickPixel - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - GmagickPixel - - - - - GmagickPixel - - - - - &Methods; - - - - - -
- -
- - &reference.gmagick.entities.gmagickpixel; - -
- diff --git a/reference/gmagick/gmagickpixel/construct.xml b/reference/gmagick/gmagickpixel/construct.xml deleted file mode 100644 index 2a83a6490a0a..000000000000 --- a/reference/gmagick/gmagickpixel/construct.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - GmagickPixel::__construct - The GmagickPixel constructor - - - - &reftitle.description; - - public GmagickPixel::__construct - stringcolor - - - Constructs an GmagickPixel object. If a color is specified, the object is constructed and then initialised with that color before being returned. - - - - - - &reftitle.parameters; - - - color - - - The optional color string to use as the initial value of this object. - - - - - - - - diff --git a/reference/gmagick/gmagickpixel/getcolor.xml b/reference/gmagick/gmagickpixel/getcolor.xml deleted file mode 100644 index f8dd10dd90e8..000000000000 --- a/reference/gmagick/gmagickpixel/getcolor.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - GmagickPixel::getcolor - Returns the color - - - - &reftitle.description; - - public mixedGmagickPixel::getcolor - boolas_array&false; - boolnormalize_array&false; - - - Returns the color described by the GmagickPixel object, as a string or an array. If the color has an opacity channel set, this is provided as a fourth value in the list. - - - - - &reftitle.parameters; - - - as_array - - - &true; to indicate return of array instead of string. - - - - - normalize_array - - - &true; to normalize the color values. - - - - - - - - &reftitle.returnvalues; - - A string or an array of channel values, each normalized if &true; is given as normalize_array. Throws GmagickPixelException on error. - - - - - - diff --git a/reference/gmagick/gmagickpixel/getcolorcount.xml b/reference/gmagick/gmagickpixel/getcolorcount.xml deleted file mode 100644 index 8b91218075b8..000000000000 --- a/reference/gmagick/gmagickpixel/getcolorcount.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - GmagickPixel::getcolorcount - Returns the color count associated with this color - - - - &reftitle.description; - - public intGmagickPixel::getcolorcount - - - - Returns the color count associated with this color. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the color count as an integer on success, throws GmagickPixelException on failure. - - - - - - diff --git a/reference/gmagick/gmagickpixel/getcolorvalue.xml b/reference/gmagick/gmagickpixel/getcolorvalue.xml deleted file mode 100644 index 152398985ce6..000000000000 --- a/reference/gmagick/gmagickpixel/getcolorvalue.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - GmagickPixel::getcolorvalue - Gets the normalized value of the provided color channel - - - - &reftitle.description; - - public floatGmagickPixel::getcolorvalue - intcolor - - - Retrieves the value of the color channel specified, as a floating-point number between 0 and 1. - - - - - - &reftitle.parameters; - - - color - - - The channel to check, specified as one of the Gmagick channel constants. - - - - - - - - &reftitle.returnvalues; - - The value of the channel, as a normalized floating-point number, throwing GmagickPixelException on error. - - - - - - diff --git a/reference/gmagick/gmagickpixel/setcolor.xml b/reference/gmagick/gmagickpixel/setcolor.xml deleted file mode 100644 index ca9430aa2591..000000000000 --- a/reference/gmagick/gmagickpixel/setcolor.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - GmagickPixel::setcolor - Sets the color - - - - &reftitle.description; - - public GmagickPixelGmagickPixel::setcolor - stringcolor - - - Sets the color described by the GmagickPixel object, with a string (e.g. "blue", "#0000ff", "rgb(0,0,255)", "cmyk(100,100,100,10)", etc.). - - - - - - &reftitle.parameters; - - - color - - - The color definition to use in order to initialise the GmagickPixel object. - - - - - - - - &reftitle.returnvalues; - - The GmagickPixel object. - - - - - diff --git a/reference/gmagick/gmagickpixel/setcolorvalue.xml b/reference/gmagick/gmagickpixel/setcolorvalue.xml deleted file mode 100644 index 0b7d3c4997f2..000000000000 --- a/reference/gmagick/gmagickpixel/setcolorvalue.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - GmagickPixel::setcolorvalue - Sets the normalized value of one of the channels - - - - &reftitle.description; - - public GmagickPixelGmagickPixel::setcolorvalue - intcolor - floatvalue - - - Sets the value of the specified channel of this object to the provided value, which should be between 0 and 1. - This function can be used to provide an opacity channel to a GmagickPixel object. - - - - - &reftitle.parameters; - - - color - - - One of the Gmagick channel color constants. - - - - - value - - - The value to set this channel to, ranging from 0 to 1. - - - - - - - - &reftitle.returnvalues; - - The GmagickPixel object. - - - - - - diff --git a/reference/gmagick/gmagickpixelexception.xml b/reference/gmagick/gmagickpixelexception.xml deleted file mode 100644 index ef6d9e0196ac..000000000000 --- a/reference/gmagick/gmagickpixelexception.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - The GmagickPixelException class - GmagickPixelException - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - GmagickPixelException - - - - - GmagickPixelException - - - - extends - Exception - - - - - &InheritedMethods; - - - - - -
- - -
- -
- diff --git a/reference/gmagick/setup.xml b/reference/gmagick/setup.xml deleted file mode 100644 index 8ac88075f3c6..000000000000 --- a/reference/gmagick/setup.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - &reftitle.setup; - -
- &reftitle.required; - - This extension works best with GraphicsMagick version 1.4+. - Gmagick should work with earlier versions up to GraphicsMagick 1.2.6 but - some features and formats are not supported for these versions. - Windows version of GraphicsMagick is available from the GraphicsMagick - website. To read about the difference between ImageMagick and GraphicsMagick, - check the FAQ. - -
- - -
- &reftitle.install; - - &pecl.info; - &url.pecl.package;gmagick. - - - The official name of this extension is gmagick. - -
- - -
- diff --git a/reference/gmagick/versions.xml b/reference/gmagick/versions.xml deleted file mode 100644 index a817beda1b9a..000000000000 --- a/reference/gmagick/versions.xml +++ /dev/null @@ -1,235 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/gnupg/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/gnupg/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/gnupg/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/gnupg/book.xml b/reference/gnupg/book.xml deleted file mode 100644 index 86530def27d7..000000000000 --- a/reference/gnupg/book.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - GNU Privacy Guard - GnuPG - - - - &reftitle.intro; - - This module allows you to interact with gnupg. - - - - - &reference.gnupg.setup; - &reference.gnupg.constants; - &reference.gnupg.examples; - - &reference.gnupg.reference; - - - diff --git a/reference/gnupg/configure.xml b/reference/gnupg/configure.xml deleted file mode 100644 index da5a8727e194..000000000000 --- a/reference/gnupg/configure.xml +++ /dev/null @@ -1,29 +0,0 @@ - - -
- &reftitle.install; - - &pecl.info; - . - -
- diff --git a/reference/gnupg/constants.xml b/reference/gnupg/constants.xml deleted file mode 100644 index ab33d1c86a2b..000000000000 --- a/reference/gnupg/constants.xml +++ /dev/null @@ -1,303 +0,0 @@ - - - - &reftitle.constants; - - - - GNUPG_SIG_MODE_NORMAL - (int) - - - - - - - - - - GNUPG_SIG_MODE_DETACH - (int) - - - - - - - - - - GNUPG_SIG_MODE_CLEAR - (int) - - - - - - - - - - GNUPG_VALIDITY_UNKNOWN - (int) - - - - - - - - - - GNUPG_VALIDITY_UNDEFINED - (int) - - - - - - - - - - GNUPG_VALIDITY_NEVER - (int) - - - - - - - - - - GNUPG_VALIDITY_MARGINAL - (int) - - - - - - - - - - GNUPG_VALIDITY_FULL - (int) - - - - - - - - - - GNUPG_VALIDITY_ULTIMATE - (int) - - - - - - - - - - GNUPG_PROTOCOL_OpenPGP - (int) - - - - - - - - - - GNUPG_PROTOCOL_CMS - (int) - - - - - - - - - - GNUPG_SIGSUM_VALID - (int) - - - - - - - - - - GNUPG_SIGSUM_GREEN - (int) - - - - - - - - - - GNUPG_SIGSUM_RED - (int) - - - - - - - - - - GNUPG_SIGSUM_KEY_REVOKED - (int) - - - - - - - - - - GNUPG_SIGSUM_KEY_EXPIRED - (int) - - - - - - - - - - GNUPG_SIGSUM_KEY_MISSING - (int) - - - - - - - - - - GNUPG_SIGSUM_SIG_EXPIRED - (int) - - - - - - - - - - GNUPG_SIGSUM_CRL_MISSING - (int) - - - - - - - - - - GNUPG_SIGSUM_CRL_TOO_OLD - (int) - - - - - - - - - - GNUPG_SIGSUM_BAD_POLICY - (int) - - - - - - - - - - GNUPG_SIGSUM_SYS_ERROR - (int) - - - - - - - - - - GNUPG_ERROR_WARNING - (int) - - - - - - - - - - GNUPG_ERROR_EXCEPTION - (int) - - - - - - - - - - GNUPG_ERROR_SILENT - (int) - - - - - - - - - - - diff --git a/reference/gnupg/examples.xml b/reference/gnupg/examples.xml deleted file mode 100644 index f4bb8009b36c..000000000000 --- a/reference/gnupg/examples.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - &reftitle.examples; -
- Clearsign text - - This example will clearsign a given text. - - - gnupg clearsign example (procedural) - - -]]> - - - - gnupg clearsign example (OO) - -setsignmode(gnupg::SIG_MODE_CLEAR); -// add key with passphrase 'test' for signing -$gnupg->addsignkey("8660281B6051D071D94B5B230549F9DC851566DC","test"); -// sign -$signed = $gnupg->sign("just a test"); -echo $signed; -?> -]]> - - - - keylistiterator - - This extension also comes with an Iterator for your keyring. - - - $userid){ - echo $fingerprint." -> ".$userid."\n"; -} -?> -]]> - - -
-
- diff --git a/reference/gnupg/functions/gnupg-adddecryptkey.xml b/reference/gnupg/functions/gnupg-adddecryptkey.xml deleted file mode 100644 index b2d47e115b40..000000000000 --- a/reference/gnupg/functions/gnupg-adddecryptkey.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - gnupg_adddecryptkey - Add a key for decryption - - - - &reftitle.description; - - boolgnupg_adddecryptkey - resourceidentifier - stringfingerprint - stringpassphrase - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - fingerprint - - &gnupg.fingerprint; - - - - passphrase - - - The pass phrase. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Procedural <function>gnupg_adddecryptkey</function> example - - -]]> - - - - OO <function>gnupg_adddecryptkey</function> example - -adddecryptkey("8660281B6051D071D94B5B230549F9DC851566DC","test"); -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-addencryptkey.xml b/reference/gnupg/functions/gnupg-addencryptkey.xml deleted file mode 100644 index 1ac416a7bc1d..000000000000 --- a/reference/gnupg/functions/gnupg-addencryptkey.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - gnupg_addencryptkey - Add a key for encryption - - - - &reftitle.description; - - boolgnupg_addencryptkey - resourceidentifier - stringfingerprint - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - fingerprint - - &gnupg.fingerprint; - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Procedural <function>gnupg_addencryptkey</function> example - - -]]> - - - - OO <function>gnupg_addencryptkey</function> example - -addencryptkey("8660281B6051D071D94B5B230549F9DC851566DC"); -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-addsignkey.xml b/reference/gnupg/functions/gnupg-addsignkey.xml deleted file mode 100644 index 4f0c88bb3698..000000000000 --- a/reference/gnupg/functions/gnupg-addsignkey.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - gnupg_addsignkey - Add a key for signing - - - - &reftitle.description; - - boolgnupg_addsignkey - resourceidentifier - stringfingerprint - stringpassphrase - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - fingerprint - - &gnupg.fingerprint; - - - - passphrase - - - The pass phrase. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Procedural <function>gnupg_addsignkey</function> example - - -]]> - - - - OO <function>gnupg_addsignkey</function> example - -addsignkey("8660281B6051D071D94B5B230549F9DC851566DC","test"); -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-cleardecryptkeys.xml b/reference/gnupg/functions/gnupg-cleardecryptkeys.xml deleted file mode 100644 index 8f2ef52c5687..000000000000 --- a/reference/gnupg/functions/gnupg-cleardecryptkeys.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - gnupg_cleardecryptkeys - Removes all keys which were set for decryption before - - - - &reftitle.description; - - boolgnupg_cleardecryptkeys - resourceidentifier - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Procedural <function>gnupg_cleardecryptkeys</function> example - - -]]> - - - - OO <function>gnupg_cleardecryptkeys</function> example - -cleardecryptkeys(); -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-clearencryptkeys.xml b/reference/gnupg/functions/gnupg-clearencryptkeys.xml deleted file mode 100644 index 75535be8025f..000000000000 --- a/reference/gnupg/functions/gnupg-clearencryptkeys.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - gnupg_clearencryptkeys - Removes all keys which were set for encryption before - - - - &reftitle.description; - - boolgnupg_clearencryptkeys - resourceidentifier - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Procedural <function>gnupg_clearencryptkeys</function> example - - -]]> - - - - OO <function>gnupg_clearencryptkeys</function> example - -clearencryptkeys(); -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-clearsignkeys.xml b/reference/gnupg/functions/gnupg-clearsignkeys.xml deleted file mode 100644 index 74bfbd2721fe..000000000000 --- a/reference/gnupg/functions/gnupg-clearsignkeys.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - gnupg_clearsignkeys - Removes all keys which were set for signing before - - - - &reftitle.description; - - boolgnupg_clearsignkeys - resourceidentifier - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Procedural <function>gnupg_clearsignkeys</function> example - - -]]> - - - - OO <function>gnupg_clearsignkeys</function> example - -clearsignkeys(); -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-decrypt.xml b/reference/gnupg/functions/gnupg-decrypt.xml deleted file mode 100644 index 9bb803c9de05..000000000000 --- a/reference/gnupg/functions/gnupg-decrypt.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - gnupg_decrypt - Decrypts a given text - - - - &reftitle.description; - - stringfalsegnupg_decrypt - resourceidentifier - stringtext - - - Decrypts the given text with the keys, which were set with gnupg_adddecryptkey before. - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - text - - - The text being decrypted. - - - - - - - - &reftitle.returnvalues; - - On success, this function returns the decrypted text. - On failure, this function returns &false;. - - - - - &reftitle.examples; - - - Procedural <function>gnupg_decrypt</function> example - - -]]> - - - - OO <function>gnupg_decrypt</function> example - -adddecryptkey("8660281B6051D071D94B5B230549F9DC851566DC","test"); -$plain = $gpg->decrypt($encrypted_text); -echo $plain; -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-decryptverify.xml b/reference/gnupg/functions/gnupg-decryptverify.xml deleted file mode 100644 index 70f7bfe9f361..000000000000 --- a/reference/gnupg/functions/gnupg-decryptverify.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - gnupg_decryptverify - Decrypts and verifies a given text - - - - &reftitle.description; - - arrayfalsegnupg_decryptverify - resourceidentifier - stringtext - stringplaintext - - - Decrypts and verifies a given text and returns information about the - signature. - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - text - - - The text being decrypted. - - - - - plaintext - - - The parameter plaintext gets filled with the decrypted - text. - - - - - - - - &reftitle.returnvalues; - - On success, this function returns information about the signature and - fills the plaintext parameter with the decrypted text. - On failure, this function returns &false;. - - - - - &reftitle.examples; - - - Procedural <function>gnupg_decryptverify</function> example - - -]]> - - - - OO <function>gnupg_decryptverify</function> example - -adddecryptkey("8660281B6051D071D94B5B230549F9DC851566DC","test"); -$info = $gpg->decryptverify($text,$plaintext); -print_r($info); -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-deletekey.xml b/reference/gnupg/functions/gnupg-deletekey.xml deleted file mode 100644 index 646a565cd994..000000000000 --- a/reference/gnupg/functions/gnupg-deletekey.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - gnupg_deletekey - Delete a key from the keyring - - - - &reftitle.description; - - boolgnupg_deletekey - resourceidentifier - stringkey - boolallow_secret - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - key - - - The key to delete. - - - - - allow_secret - - - It specifies whether to delete secret keys as well. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Procedural <function>gnupg_deletekey</function> example - - -]]> - - - - OO <function>gnupg_deletekey</function> example - -deletekey("8660281B6051D071D94B5B230549F9DC851566DC"); -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-encrypt.xml b/reference/gnupg/functions/gnupg-encrypt.xml deleted file mode 100644 index 9f58145b5b9d..000000000000 --- a/reference/gnupg/functions/gnupg-encrypt.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - gnupg_encrypt - Encrypts a given text - - - - &reftitle.description; - - stringfalsegnupg_encrypt - resourceidentifier - stringplaintext - - - Encrypts the given plaintext with the keys, which - were set with gnupg_addencryptkey before and - returns the encrypted text. - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - plaintext - - - The text being encrypted. - - - - - - - - &reftitle.returnvalues; - - On success, this function returns the encrypted text. - On failure, this function returns &false;. - - - - - &reftitle.examples; - - - Procedural <function>gnupg_encrypt</function> example - - -]]> - - - - OO <function>gnupg_encrypt</function> example - -addencryptkey("8660281B6051D071D94B5B230549F9DC851566DC"); -$enc = $gpg->encrypt("just a test"); -echo $enc; -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-encryptsign.xml b/reference/gnupg/functions/gnupg-encryptsign.xml deleted file mode 100644 index 5b5c5a3e18bc..000000000000 --- a/reference/gnupg/functions/gnupg-encryptsign.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - gnupg_encryptsign - Encrypts and signs a given text - - - - &reftitle.description; - - stringfalsegnupg_encryptsign - resourceidentifier - stringplaintext - - - Encrypts and signs the given plaintext with the - keys, which were set with - gnupg_addsignkey and gnupg_addencryptkey before and - returns the encrypted and signed text. - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - plaintext - - - The text being encrypted. - - - - - - - - &reftitle.returnvalues; - - On success, this function returns the encrypted and signed text. - On failure, this function returns &false;. - - - - - &reftitle.examples; - - - Procedural <function>gnupg_encryptsign</function> example - - -]]> - - - - OO <function>gnupg_encryptsign</function> example - -addencryptkey("8660281B6051D071D94B5B230549F9DC851566DC"); -$gpg->addsignkey("8660281B6051D071D94B5B230549F9DC851566DC","test"); -$enc = $gpg->encryptsign("just a test"); -echo $enc; -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-export.xml b/reference/gnupg/functions/gnupg-export.xml deleted file mode 100644 index eafa00809120..000000000000 --- a/reference/gnupg/functions/gnupg-export.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - gnupg_export - Exports a key - - - - &reftitle.description; - - stringfalsegnupg_export - resourceidentifier - stringfingerprint - - - Exports the key fingerprint. - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - fingerprint - - &gnupg.fingerprint; - - - - - - - &reftitle.returnvalues; - - On success, this function returns the keydata. - On failure, this function returns &false;. - - - - - &reftitle.examples; - - - Procedural <function>gnupg_export</function> example - - -]]> - - - - OO <function>gnupg_export</function> example - -export("8660281B6051D071D94B5B230549F9DC851566DC"); -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-getengineinfo.xml b/reference/gnupg/functions/gnupg-getengineinfo.xml deleted file mode 100644 index c7803bd6362c..000000000000 --- a/reference/gnupg/functions/gnupg-getengineinfo.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - gnupg_getengineinfo - Returns the engine info - - - - &reftitle.description; - - arraygnupg_getengineinfo - resourceidentifier - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - - - - &reftitle.returnvalues; - - Returns an array with engine info consisting of protocol, - file_name and home_dir. - - - - - &reftitle.examples; - - - Procedural <function>gnupg_getengineinfo</function> example - - -]]> - - &example.outputs; - - - int(0) - ["file_name"]=> - string(12) "/usr/bin/gpg" - ["home_dir"]=> - string(0) "" -} -]]> - - - - OO <function>gnupg_getengineinfo</function> example - - "/usr/bin/gpg2", "home_dir" => "/var/www/.gnupg"]); -print_r($gpg->getengineinfo()); -?> -]]> - - &example.outputs; - - - int(0) - ["file_name"]=> - string(13) "/usr/bin/gpg2" - ["home_dir"]=> - string(15) "/var/www/.gnupg" -} -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-geterror.xml b/reference/gnupg/functions/gnupg-geterror.xml deleted file mode 100644 index e0601eca2763..000000000000 --- a/reference/gnupg/functions/gnupg-geterror.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - gnupg_geterror - Returns the errortext, if a function fails - - - - &reftitle.description; - - stringfalsegnupg_geterror - resourceidentifier - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - - - - &reftitle.returnvalues; - - Returns an errortext, if an error has occurred, otherwise &false;. - - - - - &reftitle.examples; - - - Procedural <function>gnupg_geterror</function> example - - -]]> - - - - OO <function>gnupg_geterror</function> example - -geterror(); -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-geterrorinfo.xml b/reference/gnupg/functions/gnupg-geterrorinfo.xml deleted file mode 100644 index 2c81250b1e96..000000000000 --- a/reference/gnupg/functions/gnupg-geterrorinfo.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - gnupg_geterrorinfo - Returns the error info - - - - &reftitle.description; - - arraygnupg_geterrorinfo - resourceidentifier - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - - - - &reftitle.returnvalues; - - Returns an array with error info. - - - - - &reftitle.examples; - - - Procedural <function>gnupg_geterrorinfo</function> example - - -]]> - - &example.outputs; - - - bool(false) - ["gpgme_code"]=> - int(0) - ["gpgme_source"]=> - string(18) "Unspecified source" - ["gpgme_message"]=> - string(7) "Success" -} -]]> - - - - OO <function>gnupg_geterrorinfo</function> example - -decrypt('abc'); -// error info should be displayed -print_r($gpg->geterrorinfo()); -?> -]]> - - &example.outputs; - - - string(14) "decrypt failed" - ["gpgme_code"]=> - int(117440570) - ["gpgme_source"]=> - string(5) "GPGME" - ["gpgme_message"]=> - string(7) "No data" -} -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-getprotocol.xml b/reference/gnupg/functions/gnupg-getprotocol.xml deleted file mode 100644 index 3c2bbaa3ebc7..000000000000 --- a/reference/gnupg/functions/gnupg-getprotocol.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - gnupg_getprotocol - Returns the currently active protocol for all operations - - - - &reftitle.description; - - intgnupg_getprotocol - resourceidentifier - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - - - - &reftitle.returnvalues; - - Returns the currently active protocol, which can be one of - GNUPG_PROTOCOL_OpenPGP or - GNUPG_PROTOCOL_CMS. - - - - - &reftitle.examples; - - - Procedural <function>gnupg_getprotocol</function> example - - -]]> - - - - OO <function>gnupg_getprotocol</function> example - -getprotocol(); -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-gettrustlist.xml b/reference/gnupg/functions/gnupg-gettrustlist.xml deleted file mode 100644 index d1b6d4c0aac2..000000000000 --- a/reference/gnupg/functions/gnupg-gettrustlist.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - gnupg_gettrustlist - Search the trust items - - - - &reftitle.description; - - arraynullgnupg_gettrustlist - resourceidentifier - stringpattern - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - pattern - - - Expression to limit the list of trust items to only the ones matching the pattern. - - - - - - - - &reftitle.returnvalues; - - On success, this function returns an array of trust items. - On failure, this function returns &null;. - - - - - &reftitle.examples; - - - Procedural <function>gnupg_gettrustlist</function> example - - -]]> - - - - OO <function>gnupg_gettrustlist</function> example - -gettrustlist(); -print_r($items); -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-import.xml b/reference/gnupg/functions/gnupg-import.xml deleted file mode 100644 index 89b8eadea278..000000000000 --- a/reference/gnupg/functions/gnupg-import.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - gnupg_import - Imports a key - - - - &reftitle.description; - - arrayfalsegnupg_import - resourceidentifier - stringkeydata - - - Imports the key keydata and returns an array with - information about the importprocess. - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - keydata - - - The data key that is being imported. - - - - - - - - &reftitle.returnvalues; - - On success, this function returns and info-array about the importprocess. - On failure, this function returns &false;. - - - - - &reftitle.examples; - - - Procedural <function>gnupg_import</function> example - - -]]> - - - - OO <function>gnupg_import</function> example - -import($keydata); -print_r($info); -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-init.xml b/reference/gnupg/functions/gnupg-init.xml deleted file mode 100644 index 89f1b4743e7f..000000000000 --- a/reference/gnupg/functions/gnupg-init.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - - gnupg_init - Initialize a connection - - - - &reftitle.description; - - resourcegnupg_init - arraynulloptions&null; - - - - - &reftitle.parameters; - - - options - - - Must be an associative array. It is used to change the default configuration - of the crypto engine. - - Configuration overrides - - - - key - type - description - - - - - file_name - string - - It is the file name of the executable program implementing this protocol - which is usually path of the gpg executable. - - - - home_dir - string - - It is the directory name of the configuration directory. It also overrides - GNUPGHOME environment variable that is used for the same - purpose. - - - - -
-
-
-
-
-
- - - &reftitle.returnvalues; - - A GnuPG resource connection used by other GnuPG functions. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL gnupg 1.5.0 - The options parameter was added. - - - - - - - - &reftitle.examples; - - - Procedural <function>gnupg_init</function> example with default setting - - -]]> - - - - Procedural <function>gnupg_init</function> example with overridden file name and home dir - - "/usr/bin/gpg2", "home_dir" => "/var/www/.gnupg"]); -?> -]]> - - - - OO gnupg initializer example with default setting - - -]]> - - - - OO gnupg initializer example with overridden file name and home dir - - "/usr/bin/gpg2", "home_dir" => "/var/www/.gnupg"]); -?> -]]> - - - - -
- diff --git a/reference/gnupg/functions/gnupg-keyinfo.xml b/reference/gnupg/functions/gnupg-keyinfo.xml deleted file mode 100644 index c88ad09856f5..000000000000 --- a/reference/gnupg/functions/gnupg-keyinfo.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - gnupg_keyinfo - Returns an array with information about all keys that matches the given pattern - - - - &reftitle.description; - - arrayfalsegnupg_keyinfo - resourceidentifier - stringpattern - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - pattern - - - The pattern being checked against the keys. - - - - - - - - &reftitle.returnvalues; - - Returns an array with information about all keys that matches the given - pattern or &false;, if an error has occurred. - - - - - &reftitle.examples; - - - Procedural <function>gnupg_keyinfo</function> example - - -]]> - - - - OO <function>gnupg_keyinfo</function> example - -keyinfo("test"); -print_r($info); -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-listsignatures.xml b/reference/gnupg/functions/gnupg-listsignatures.xml deleted file mode 100644 index 841a091d8132..000000000000 --- a/reference/gnupg/functions/gnupg-listsignatures.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - gnupg_listsignatures - List key signatures - - - - &reftitle.description; - - arraynullgnupg_listsignatures - resourceidentifier - stringkeyid - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - keyid - - - The key ID to list signatures for. - - - - - - - - &reftitle.returnvalues; - - On success, this function returns an array of key signatures. - On failure, this function returns &null;. - - - - - &reftitle.examples; - - - Procedural <function>gnupg_listsignatures</function> example - - -]]> - - - - OO <function>gnupg_listsignatures</function> example - -listsignatures("8660281B6051D071D94B5B230549F9DC851566DC"); -print_r($signatures); -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-setarmor.xml b/reference/gnupg/functions/gnupg-setarmor.xml deleted file mode 100644 index 9a40675d5db8..000000000000 --- a/reference/gnupg/functions/gnupg-setarmor.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - gnupg_setarmor - Toggle armored output - - - - &reftitle.description; - - boolgnupg_setarmor - resourceidentifier - intarmor - - - Toggle the armored output. - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - armor - - - Pass a non-zero integer-value to this function to enable armored-output - (default). - Pass 0 to disable armored output. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Procedural <function>gnupg_setarmor</function> example - - -]]> - - - - OO <function>gnupg_setarmor</function> example - -setarmor(1); // enable armored output; -$gpg->setarmor(0); // disable armored output; -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-seterrormode.xml b/reference/gnupg/functions/gnupg-seterrormode.xml deleted file mode 100644 index 161b6c9abb25..000000000000 --- a/reference/gnupg/functions/gnupg-seterrormode.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - gnupg_seterrormode - Sets the mode for error_reporting - - - - &reftitle.description; - - voidgnupg_seterrormode - resourceidentifier - interrormode - - - Sets the mode for error_reporting. - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - errormode - - - The error mode. - - - errormode takes a constant indicating what type of - error_reporting should be used. The possible values are - GNUPG_ERROR_WARNING, - GNUPG_ERROR_EXCEPTION and - GNUPG_ERROR_SILENT. - By default GNUPG_ERROR_SILENT is used. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Procedural <function>gnupg_seterrormode</function> example - - -]]> - - - - OO <function>gnupg_seterrormode</function> example - -seterrormode(gnupg::ERROR_EXCEPTION); // throw an exception in case of an error -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-setsignmode.xml b/reference/gnupg/functions/gnupg-setsignmode.xml deleted file mode 100644 index 4adb594e6f34..000000000000 --- a/reference/gnupg/functions/gnupg-setsignmode.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - gnupg_setsignmode - Sets the mode for signing - - - - &reftitle.description; - - boolgnupg_setsignmode - resourceidentifier - intsignmode - - - Sets the mode for signing. - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - sigmode - - - The mode for signing. - - - signmode takes a constant indicating what type of - signature should be produced. The possible values are - GNUPG_SIG_MODE_NORMAL, - GNUPG_SIG_MODE_DETACH and - GNUPG_SIG_MODE_CLEAR. - By default GNUPG_SIG_MODE_CLEAR is used. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - - Procedural <function>gnupg_setsignmode</function> example - - -]]> - - - - OO <function>gnupg_setsignmode</function> example - -setsignmode(gnupg::SIG_MODE_DETACH); // produce a detached signature -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-sign.xml b/reference/gnupg/functions/gnupg-sign.xml deleted file mode 100644 index d0e637ce1066..000000000000 --- a/reference/gnupg/functions/gnupg-sign.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - gnupg_sign - Signs a given text - - - - &reftitle.description; - - stringfalsegnupg_sign - resourceidentifier - stringplaintext - - - Signs the given plaintext with the keys, which were - set with gnupg_addsignkey before and - returns the signed text or the signature, depending on what was set with - gnupg_setsignmode. - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - plaintext - - - The plain text being signed. - - - - - - - - &reftitle.returnvalues; - - On success, this function returns the signed text or the signature. - On failure, this function returns &false;. - - - - - &reftitle.examples; - - - Procedural <function>gnupg_sign</function> example - - -]]> - - - - OO <function>gnupg_sign</function> example - -addsignkey("8660281B6051D071D94B5B230549F9DC851566DC","test"); -$signed = $gpg->sign("just a test"); -echo $signed; -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-verify.xml b/reference/gnupg/functions/gnupg-verify.xml deleted file mode 100644 index 649bae3f959f..000000000000 --- a/reference/gnupg/functions/gnupg-verify.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - gnupg_verify - Verifies a signed text - - - - &reftitle.description; - - arrayfalsegnupg_verify - resourceidentifier - stringsigned_text - stringsignature - stringplaintext - - - Verifies the given signed_text and returns information about the - signature. - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - signed_text - - - The signed text. - - - - - signature - - - The signature. - To verify a clearsigned text, set signature to &false;. - - - - - plaintext - - - The plain text. - If this optional parameter is passed, it is - filled with the plain text. - - - - - - - - &reftitle.returnvalues; - - On success, this function returns information about the signature. - On failure, this function returns &false;. - - - - - &reftitle.examples; - - - Procedural <function>gnupg_verify</function> example - - -]]> - - - - OO <function>gnupg_verify</function> example - -verify($signed_text,false,$plaintext); -print_r($info); -// detached signature -$info = $gpg->verify($signed_text,$signature); -print_r($info); -?> -]]> - - - - - - diff --git a/reference/gnupg/reference.xml b/reference/gnupg/reference.xml deleted file mode 100644 index 5d2f98800f23..000000000000 --- a/reference/gnupg/reference.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - GnuPG &Functions; - - - &reftitle.notes; - - This extension makes use of the keyring of the current user. This keyring - is normally located in ~/.gnupg/. - To specify a custom location, store the path to the keyring in the - environment variable GNUPGHOME. See putenv for more information how to do - this. - - - Some functions require the specification of a key. This specification can - be anything that refers to a unique key (userid, key-id, fingerprint, - ...). - This documentation uses the fingerprint in all examples. - - - - As alternative to the explicitly documented functions using - resources, you can also use an object-oriented style using - gnupg objects. - - - - - &reference.gnupg.entities.functions; - - - diff --git a/reference/gnupg/setup.xml b/reference/gnupg/setup.xml deleted file mode 100644 index 9fd7bbbe41ed..000000000000 --- a/reference/gnupg/setup.xml +++ /dev/null @@ -1,39 +0,0 @@ - - - - &reftitle.setup; - - -
- &reftitle.required; - - This extension requires the gpgme library - -
- - - - &reference.gnupg.configure; - - -
- diff --git a/reference/gnupg/versions.xml b/reference/gnupg/versions.xml deleted file mode 100644 index 5ff143d464b2..000000000000 --- a/reference/gnupg/versions.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/hrtime/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/hrtime/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/hrtime/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/hrtime/book.xml b/reference/hrtime/book.xml deleted file mode 100644 index 3c319c60980d..000000000000 --- a/reference/hrtime/book.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - High resolution timing - HRTime - - - &reftitle.intro; - -The HRTime extension implements a high resolution StopWatch class. It uses the -best possible APIs on different platforms which brings resolution up to nanoseconds. It also makes possible to implement -a custom stopwatch using low level ticks delivered by the underlying APIs. - - - - As of PHP 7.3.0 the related function hrtime is part of - the core. - - - - - &reference.hrtime.setup; - &reference.hrtime.examples; - &reference.hrtime.hrtime.performancecounter; - &reference.hrtime.hrtime.stopwatch; - &reference.hrtime.hrtime.unit; - - - diff --git a/reference/hrtime/configure.xml b/reference/hrtime/configure.xml deleted file mode 100644 index 19498e05ce62..000000000000 --- a/reference/hrtime/configure.xml +++ /dev/null @@ -1,34 +0,0 @@ - - -
- &reftitle.install; - - - Use when compiling PHP. - - - - Windows users should include php_hrtime.dll into &php.ini; - - -
- diff --git a/reference/hrtime/examples.xml b/reference/hrtime/examples.xml deleted file mode 100644 index a2e5e49a3834..000000000000 --- a/reference/hrtime/examples.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - &reftitle.examples; -
- Basic usage - - The example illustrates the basic StopWatch class usage - - - Measure several code blocks execution and get the total - -start(); -/* measure this code block execution */ -for ($i = 0; $i < 1024*1024; $i++); -$c->stop(); -$elapsed0 = $c->getLastElapsedTime(HRTime\Unit::NANOSECOND); - -/* measurement is not running here*/ -for ($i = 0; $i < 1024*1024; $i++); - -$c->start(); -/* measure this code block execution */ -for ($i = 0; $i < 1024*1024; $i++); -$c->stop(); -$elapsed1 = $c->getLastElapsedTime(HRTime\Unit::NANOSECOND); - -$elapsed_total = $c->getElapsedTime(HRTime\Unit::NANOSECOND); - -?> -]]> - - -
-
- diff --git a/reference/hrtime/hrtime-performancecounter/getfrequency.xml b/reference/hrtime/hrtime-performancecounter/getfrequency.xml deleted file mode 100644 index 4af08af21ba1..000000000000 --- a/reference/hrtime/hrtime-performancecounter/getfrequency.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - HRTime\PerformanceCounter::getFrequency - Timer frequency in ticks per second - - - - &reftitle.description; - - public static intHRTime\PerformanceCounter::getFrequency - - - -Returns the timer frequency in ticks per second. This value is constant after -the system start on almost any operating system. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &integer; indicating the timer frequency. - - - - - - diff --git a/reference/hrtime/hrtime-performancecounter/getticks.xml b/reference/hrtime/hrtime-performancecounter/getticks.xml deleted file mode 100644 index 97cc4167b1b9..000000000000 --- a/reference/hrtime/hrtime-performancecounter/getticks.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - HRTime\PerformanceCounter::getTicks - Current ticks from the system - - - - &reftitle.description; - - public static intHRTime\PerformanceCounter::getTicks - - - - Returns the ticks count. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &integer; indicating the ticks count. - - - - - diff --git a/reference/hrtime/hrtime-performancecounter/gettickssince.xml b/reference/hrtime/hrtime-performancecounter/gettickssince.xml deleted file mode 100644 index 98bf7b04eee8..000000000000 --- a/reference/hrtime/hrtime-performancecounter/gettickssince.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - HRTime\PerformanceCounter::getTicksSince - Ticks elapsed since the given value - - - - &reftitle.description; - - public static intHRTime\PerformanceCounter::getTicksSince - intstart - - -Returns the ticks count elapsed since the given start value. - - - - - - &reftitle.parameters; - - - start - - - Starting ticks value. - - - - - - - - &reftitle.returnvalues; - - Returns &integer; indicating the ticks count. - - - - - - diff --git a/reference/hrtime/hrtime-stopwatch/getelapsedticks.xml b/reference/hrtime/hrtime-stopwatch/getelapsedticks.xml deleted file mode 100644 index 44b2fb23c0d5..000000000000 --- a/reference/hrtime/hrtime-stopwatch/getelapsedticks.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - HRTime\StopWatch::getElapsedTicks - Get elapsed ticks for all intervals - - - - &reftitle.description; - - public intHRTime\StopWatch::getElapsedTicks - - - -Get elapsed ticks for all the previously closed intervals. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &integer; indicating elapsed ticks. - - - - - - diff --git a/reference/hrtime/hrtime-stopwatch/getelapsedtime.xml b/reference/hrtime/hrtime-stopwatch/getelapsedtime.xml deleted file mode 100644 index 4677d55b3b69..000000000000 --- a/reference/hrtime/hrtime-stopwatch/getelapsedtime.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - HRTime\StopWatch::getElapsedTime - Get elapsed time for all intervals - - - - &reftitle.description; - - public floatHRTime\StopWatch::getElapsedTime - intunit - - - -Get elapsed time for all the previously closed intervals. - - - - - - &reftitle.parameters; - - - unit - - - Time unit represented by a HRTime\Unit constant. Default is - HRTime\Unit::SECOND. - - - - - - - - &reftitle.returnvalues; - - Returns &float; indicating elapsed time. - - - - - - - diff --git a/reference/hrtime/hrtime-stopwatch/getlastelapsedticks.xml b/reference/hrtime/hrtime-stopwatch/getlastelapsedticks.xml deleted file mode 100644 index f3e22f1923b4..000000000000 --- a/reference/hrtime/hrtime-stopwatch/getlastelapsedticks.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - HRTime\StopWatch::getLastElapsedTicks - Get elapsed ticks for the last interval - - - - &reftitle.description; - - public intHRTime\StopWatch::getLastElapsedTicks - - - -Get elapsed ticks for the previously closed interval. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &integer; indicating elapsed ticks. - - - - - - diff --git a/reference/hrtime/hrtime-stopwatch/getlastelapsedtime.xml b/reference/hrtime/hrtime-stopwatch/getlastelapsedtime.xml deleted file mode 100644 index 18ea62044934..000000000000 --- a/reference/hrtime/hrtime-stopwatch/getlastelapsedtime.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - HRTime\StopWatch::getLastElapsedTime - Get elapsed time for the last interval - - - - &reftitle.description; - - public floatHRTime\StopWatch::getLastElapsedTime - intunit - - - -Get elapsed time for the previously closed interval. - - - - - - &reftitle.parameters; - - - unit - - - Time unit represented by a HRTime\Unit constant. Default is - HRTime\Unit::SECOND. - - - - - - - - &reftitle.returnvalues; - - Returns &float; indicating elapsed time. - - - - - - diff --git a/reference/hrtime/hrtime-stopwatch/isrunning.xml b/reference/hrtime/hrtime-stopwatch/isrunning.xml deleted file mode 100644 index 1e3a3f7514af..000000000000 --- a/reference/hrtime/hrtime-stopwatch/isrunning.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - HRTime\StopWatch::isRunning - Whether the measurement is running - - - - &reftitle.description; - - public boolHRTime\StopWatch::isRunning - - - -Reveals whether the measurement was started. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &boolean; indicating whether the measurement is running. - - - - - - diff --git a/reference/hrtime/hrtime-stopwatch/start.xml b/reference/hrtime/hrtime-stopwatch/start.xml deleted file mode 100644 index dfaec926b059..000000000000 --- a/reference/hrtime/hrtime-stopwatch/start.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - HRTime\StopWatch::start - Start time measurement - - - - &reftitle.description; - - public voidHRTime\StopWatch::start - - - -Starts the time measurement. It has no effect if the measurement was already -started. The measurement will be continued if it was previously stopped. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns void. - - - - - - diff --git a/reference/hrtime/hrtime-stopwatch/stop.xml b/reference/hrtime/hrtime-stopwatch/stop.xml deleted file mode 100644 index a22266433161..000000000000 --- a/reference/hrtime/hrtime-stopwatch/stop.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - HRTime\StopWatch::stop - Stop time measurement - - - - &reftitle.description; - - public voidHRTime\StopWatch::stop - - - - -Stop the time measurement for the previously started interval. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns void. - - - - - - diff --git a/reference/hrtime/hrtime.performancecounter.xml b/reference/hrtime/hrtime.performancecounter.xml deleted file mode 100644 index 6dd349d79e65..000000000000 --- a/reference/hrtime/hrtime.performancecounter.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - The HRTime\PerformanceCounter class - HRTime\PerformanceCounter - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - HRTime\PerformanceCounter - - - - - HRTime\PerformanceCounter - - - - - &Methods; - - - - -
- -
- - &reference.hrtime.entities.hrtime-performancecounter; - -
- diff --git a/reference/hrtime/hrtime.stopwatch.xml b/reference/hrtime/hrtime.stopwatch.xml deleted file mode 100644 index fa7cd3019ba9..000000000000 --- a/reference/hrtime/hrtime.stopwatch.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - The HRTime\StopWatch class - HRTime\StopWatch - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - HRTime\StopWatch - - - - - HRTime\StopWatch - - - - extends - HRTime\PerformanceCounter - - - - - &Methods; - - - &InheritedMethods; - - - - - -
- -
- - &reference.hrtime.entities.hrtime-stopwatch; - -
- diff --git a/reference/hrtime/hrtime.unit.xml b/reference/hrtime/hrtime.unit.xml deleted file mode 100644 index 76126e5d0c8c..000000000000 --- a/reference/hrtime/hrtime.unit.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - The HRTime\Unit class - HRTime\Unit - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - HRTime\Unit - - - - - HRTime\Unit - - - - &Constants; - - const - int - HRTime\Unit::SECOND - 0 - - - const - int - HRTime\Unit::MILLISECOND - 1 - - - const - int - HRTime\Unit::MICROSECOND - 2 - - - const - int - HRTime\Unit::NANOSECOND - 3 - - - &Methods; - - - - -
- - -
- &reftitle.constants; - - - - HRTime\Unit::SECOND - - - - - - - HRTime\Unit::MILLISECOND - - - - - - - HRTime\Unit::MICROSECOND - - - - - - - HRTime\Unit::NANOSECOND - - - - - - -
- - - -
- - - -
- diff --git a/reference/hrtime/setup.xml b/reference/hrtime/setup.xml deleted file mode 100644 index 96fa74d04f95..000000000000 --- a/reference/hrtime/setup.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - &reftitle.setup; - - - -
- &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;hrtime. - -
- - - -
- diff --git a/reference/hrtime/versions.xml b/reference/hrtime/versions.xml deleted file mode 100644 index 3fdfe808cb2d..000000000000 --- a/reference/hrtime/versions.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/ibase/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/ibase/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/ibase/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/ibase/book.xml b/reference/ibase/book.xml deleted file mode 100644 index e592cdfce6f4..000000000000 --- a/reference/ibase/book.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - Firebird/InterBase - - - - &reftitle.intro; - - - &pecl.info.dead.git; - &url.php.git.mirror;pecl-database-interbase. - - - - Firebird is a relational database offering many ISO SQL-2003 features - that runs on Linux, Windows, and a variety of Unix platforms. Firebird - offers excellent concurrency, high performance, and powerful language - support for stored procedures and triggers. It has been used in production - systems, under a variety of names since 1981. - - - InterBase is the name of the closed-source variant of this RDBMS that - was developed by Embarcadero/Inprise. More information about InterBase is - available at &url.ibase;. - - - Firebird is a commercially independent project (fundation) of C++ programmers, - technical advisors and supporters developing and enhancing a multi-platform - relational database management system based on the source code released by - Inprise Corp (now known as Embarcadero) under the InterBase - Public License v.1.0 on 25 July, 2000. More information about Firebird is - available at &url.firebird;. - - - - &pecl.moved-ver;7.4.0 - - - This extension supports InterBase versions 6 and up and Firebird version 2.0 and up. - - - - - - &reference.ibase.setup; - &reference.ibase.constants; - &reference.ibase.reference; - - - diff --git a/reference/ibase/configure.xml b/reference/ibase/configure.xml deleted file mode 100644 index 19fcd7813285..000000000000 --- a/reference/ibase/configure.xml +++ /dev/null @@ -1,51 +0,0 @@ - - -
- &reftitle.install; - - &pecl.moved-ver;7.4.0 - - - &pecl.info; - &url.git.hub;FirebirdSQL/php-firebird. - - - To enable Firebird/InterBase support configure PHP - , where DIR is the - Firebird/InterBase base install directory, which defaults to - /usr. - - - Note to Win32/Win64 Users - - &ext.windows.path.dll; - fbclient.dll,gds32.dll - - - If you installed the Firebird/InterBase database server on the - same machine PHP is running on, you will have this DLL already and - fbclient.dll,gds32.dll (gds32.dll is generated from the installer for legacy applications) will already be in - the PATH. - - -
- diff --git a/reference/ibase/constants.xml b/reference/ibase/constants.xml deleted file mode 100644 index 48e78a6bfce2..000000000000 --- a/reference/ibase/constants.xml +++ /dev/null @@ -1,624 +0,0 @@ - - - - &reftitle.constants; - &extension.constants; - - The following constants can be passed to ibase_trans - to specify transaction behaviour. - - Firebird/InterBase transaction flags - - - - Constant - Description - - - - - IBASE_DEFAULT - - The default transaction settings are to be used. This default is - determined by the client library, which defines it as - IBASE_WRITE|IBASE_CONCURRENCY|IBASE_WAIT in most cases. - - - IBASE_READ - Starts a read-only transaction. - - - IBASE_WRITE - Starts a read-write transaction. - - - IBASE_CONSISTENCY - Starts a transaction with the isolation level set to - 'consistency', which means the transaction cannot read from tables - that are being modified by other concurrent transactions. - - - IBASE_CONCURRENCY - Starts a transaction with the isolation level set to - 'concurrency' (or 'snapshot'), which means the transaction - has access to all tables, but cannot see changes that were committed - by other transactions after the transaction was started. - - - IBASE_COMMITTED - Starts a transaction with the isolation level set to - 'read committed'. This flag should be combined with either - IBASE_REC_VERSION or - IBASE_REC_NO_VERSION. This isolation level - allows access to changes that were committed after the transaction - was started. If IBASE_REC_NO_VERSION was - specified, only the latest version of a row can be read. If - IBASE_REC_VERSION was specified, a row can - even be read when a modification to it is pending in a concurrent - transaction. - - - - IBASE_WAIT - Indicated that a transaction should wait and retry when a - conflict occurs. - - - IBASE_NOWAIT - Indicated that a transaction should fail immediately when a - conflict occurs. - - - -
-
- - - The following constants can be passed to ibase_fetch_row, - ibase_fetch_assoc or ibase_fetch_object - to specify fetch behaviour. - - Firebird/InterBase fetch flags - - - - Constant - Description - - - - - IBASE_FETCH_BLOBS - Also available as IBASE_TEXTfor backward - compatibility. Causes BLOB contents to be fetched inline, instead of - being fetched as BLOB identifiers. - - - IBASE_FETCH_ARRAYS - Causes arrays to be fetched inline. Otherwise, array - identifiers are returned. Array identifiers can only be used as - arguments to INSERT operations, as no functions to handle array - identifiers are currently available. - - - - IBASE_UNIXTIME - Causes date and time fields not to be returned as strings, - but as UNIX timestamps (the number of seconds since the epoch, which - is 1-Jan-1970 0:00 UTC). Might be problematic if used with dates - before 1970 on some systems. - - - - -
-
- - The following constants are used to pass requests and options to the service - API functions (ibase_server_info, ibase_db_info, - ibase_backup, ibase_restore - and ibase_maintain_db). Please refer to - the Firebird/InterBase manuals for the meaning of these options. - - - - IBASE_BKP_IGNORE_CHECKSUMS - - - - Options to ibase_backup - - - - - - IBASE_BKP_IGNORE_LIMBO - - - - Options to ibase_backup - - - - - - IBASE_BKP_METADATA_ONLY - - - - Options to ibase_backup - - - - - - IBASE_BKP_NO_GARBAGE_COLLECT - - - - Options to ibase_backup - - - - - - IBASE_BKP_OLD_DESCRIPTIONS - - - - Options to ibase_backup - - - - - - IBASE_BKP_NON_TRANSPORTABLE - - - - Options to ibase_backup - - - - - - IBASE_BKP_CONVERT - - - - Options to ibase_backup - - - - - - IBASE_RES_DEACTIVATE_IDX - - - - Options to ibase_restore - - - - - - IBASE_RES_NO_SHADOW - - - - Options to ibase_restore - - - - - - IBASE_RES_NO_VALIDITY - - - - Options to ibase_restore - - - - - - IBASE_RES_ONE_AT_A_TIME - - - - Options to ibase_restore - - - - - - IBASE_RES_REPLACE - - - - - - - - - IBASE_RES_CREATE - - - - Options to ibase_restore - - - - - - IBASE_RES_USE_ALL_SPACE - - - - Options to ibase_restore - - - - - - IBASE_PRP_PAGE_BUFFERS - - - - - - - - - IBASE_PRP_SWEEP_INTERVAL - - - - - - - - - IBASE_PRP_SHUTDOWN_DB - - - - - - - - - IBASE_PRP_DENY_NEW_TRANSACTIONS - - - - - - - - - IBASE_PRP_DENY_NEW_ATTACHMENTS - - - - - - - - - IBASE_PRP_RESERVE_SPACE - - - - - - - - - IBASE_PRP_RES_USE_FULL - - - - - - - - - IBASE_PRP_RES - - - - - - - - - IBASE_PRP_WRITE_MODE - - - - - - - - - IBASE_PRP_WM_ASYNC - - - - - - - - - IBASE_PRP_WM_SYNC - - - - - - - - - IBASE_PRP_ACCESS_MODE - - - - - - - - - IBASE_PRP_AM_READONLY - - - - - - - - - IBASE_PRP_AM_READWRITE - - - - - - - - - IBASE_PRP_SET_SQL_DIALECT - - - - - - - - - IBASE_PRP_ACTIVATE - - - - - - - - - IBASE_PRP_DB_ONLINE - - - - - - - - - IBASE_RPR_CHECK_DB - - - - - - - - - IBASE_RPR_IGNORE_CHECKSUM - - - - - - - - - IBASE_RPR_KILL_SHADOWS - - - - - - - - - IBASE_RPR_MEND_DB - - - - - - - - - IBASE_RPR_VALIDATE_DB - - - - - - - - - IBASE_RPR_FULL - - - - - - - - - IBASE_RPR_SWEEP_DB - - - - Options to ibase_maintain_db - - - - - - IBASE_STS_DATA_PAGES - - - - - - - - - IBASE_STS_DB_LOG - - - - - - - - - IBASE_STS_HDR_PAGES - - - - - - - - - IBASE_STS_IDX_PAGES - - - - - - - - - IBASE_STS_SYS_RELATIONS - - - - Options to ibase_db_info - - - - - - IBASE_SVC_SERVER_VERSION - - - - Options to ibase_server_info - - - - - - IBASE_SVC_IMPLEMENTATION - - - - Options to ibase_server_info - - - - - - IBASE_SVC_GET_ENV - - - - Options to ibase_server_info - - - - - - IBASE_SVC_GET_ENV_LOCK - - - - - - - - - IBASE_SVC_GET_ENV_MSG - - - - - - - - - IBASE_SVC_USER_DBPATH - - - - - - - - - IBASE_SVC_SVR_DB_INFO - - - - - - - - - IBASE_SVC_GET_USERS - - - - Options to ibase_server_info - - - - - -
- - diff --git a/reference/ibase/functions/fbird-add-user.xml b/reference/ibase/functions/fbird-add-user.xml deleted file mode 100644 index e557d491e5b3..000000000000 --- a/reference/ibase/functions/fbird-add-user.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - - - fbird_add_user - &Alias; ibase_add_user - - - - &reftitle.description; - - &info.function.alias; - ibase_add_user. - - - - - &reftitle.seealso; - - fbird_modify_user - fbird_delete_user - - - - - diff --git a/reference/ibase/functions/fbird-affected-rows.xml b/reference/ibase/functions/fbird-affected-rows.xml deleted file mode 100644 index 2a1c12b41bff..000000000000 --- a/reference/ibase/functions/fbird-affected-rows.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - - - fbird_affected_rows - &Alias; ibase_affected_rows - - - - &reftitle.description; - - &info.function.alias; - ibase_affected_rows. - - - - - &reftitle.seealso; - - fbird_query - fbird_execute - - - - - diff --git a/reference/ibase/functions/fbird-backup.xml b/reference/ibase/functions/fbird-backup.xml deleted file mode 100644 index 2f19b6abff9a..000000000000 --- a/reference/ibase/functions/fbird-backup.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - - - fbird_backup - &Alias; ibase_backup - - - - &reftitle.description; - - &info.function.alias; - ibase_backup. - - - - - diff --git a/reference/ibase/functions/fbird-blob-add.xml b/reference/ibase/functions/fbird-blob-add.xml deleted file mode 100644 index cd1bd624e946..000000000000 --- a/reference/ibase/functions/fbird-blob-add.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - fbird_blob_add - &Alias; ibase_blob_add - - - - &reftitle.description; - - &info.function.alias; - ibase_blob_add. - - - - - &reftitle.seealso; - - fbird_blob_cancel - fbird_blob_close - fbird_blob_create - fbird_blob_import - - - - - diff --git a/reference/ibase/functions/fbird-blob-cancel.xml b/reference/ibase/functions/fbird-blob-cancel.xml deleted file mode 100644 index 0fec00886695..000000000000 --- a/reference/ibase/functions/fbird-blob-cancel.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - fbird_blob_cancel - Cancel creating blob - - - - &reftitle.description; - - boolfbird_blob_cancel - resourceblob_handle - - - This function will discard a BLOB if it has not yet been closed by - fbird_blob_close. - - - - - &reftitle.parameters; - - - blob_handle - - - A BLOB handle opened with fbird_blob_create. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - fbird_blob_close - fbird_blob_create - fbird_blob_import - - - - - diff --git a/reference/ibase/functions/fbird-blob-close.xml b/reference/ibase/functions/fbird-blob-close.xml deleted file mode 100644 index b7be15a06966..000000000000 --- a/reference/ibase/functions/fbird-blob-close.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - fbird_blob_close - &Alias; ibase_blob_close - - - - &reftitle.description; - - &info.function.alias; - ibase_blob_close. - - - - - &reftitle.seealso; - - fbird_blob_create - fbird_blob_cancel - fbird_blob_open - fbird_blob_import - - - - - diff --git a/reference/ibase/functions/fbird-blob-create.xml b/reference/ibase/functions/fbird-blob-create.xml deleted file mode 100644 index ad4d6eeb401e..000000000000 --- a/reference/ibase/functions/fbird-blob-create.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - fbird_blob_create - &Alias; ibase_blob_create - - - - &reftitle.description; - - &info.function.alias; - ibase_blob_create. - - - - - &reftitle.seealso; - - fbird_blob_add - fbird_blob_cancel - fbird_blob_close - fbird_blob_import - - - - - diff --git a/reference/ibase/functions/fbird-blob-echo.xml b/reference/ibase/functions/fbird-blob-echo.xml deleted file mode 100644 index 2d5f28a9ddc0..000000000000 --- a/reference/ibase/functions/fbird-blob-echo.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - fbird_blob_echo - &Alias; ibase_blob_echo - - - - &reftitle.description; - - &info.function.alias; - ibase_blob_echo. - - - - - &reftitle.seealso; - - fbird_blob_open - fbird_blob_close - fbird_blob_get - - - - - diff --git a/reference/ibase/functions/fbird-blob-get.xml b/reference/ibase/functions/fbird-blob-get.xml deleted file mode 100644 index bd266e5399c1..000000000000 --- a/reference/ibase/functions/fbird-blob-get.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - fbird_blob_get - &Alias; ibase_blob_get - - - - &reftitle.description; - - &info.function.alias; - ibase_blob_get. - - - - - &reftitle.seealso; - - fbird_blob_open - fbird_blob_close - fbird_blob_echo - - - - - diff --git a/reference/ibase/functions/fbird-blob-import.xml b/reference/ibase/functions/fbird-blob-import.xml deleted file mode 100644 index 0bd8feedcbfd..000000000000 --- a/reference/ibase/functions/fbird-blob-import.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - fbird_blob_import - &Alias; ibase_blob_import - - - - &reftitle.description; - - &info.function.alias; - ibase_blob_import. - - - - - &reftitle.seealso; - - fbird_blob_add - fbird_blob_cancel - fbird_blob_close - fbird_blob_create - - - - - diff --git a/reference/ibase/functions/fbird-blob-info.xml b/reference/ibase/functions/fbird-blob-info.xml deleted file mode 100644 index b97b635e4995..000000000000 --- a/reference/ibase/functions/fbird-blob-info.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - fbird_blob_info - &Alias; ibase_blob_info - - - - &reftitle.description; - - &info.function.alias; - ibase_blob_info. - - - - - - diff --git a/reference/ibase/functions/fbird-blob-open.xml b/reference/ibase/functions/fbird-blob-open.xml deleted file mode 100644 index 088abe3a2a6c..000000000000 --- a/reference/ibase/functions/fbird-blob-open.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - fbird_blob_open - &Alias; ibase_blob_open - - - - &reftitle.description; - - &info.function.alias; - ibase_blob_open. - - - - - &reftitle.seealso; - - fbird_blob_close - fbird_blob_echo - fbird_blob_get - - - - - diff --git a/reference/ibase/functions/fbird-close.xml b/reference/ibase/functions/fbird-close.xml deleted file mode 100644 index 40d77f6fe1c3..000000000000 --- a/reference/ibase/functions/fbird-close.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - - - fbird_close - &Alias; ibase_close - - - - &reftitle.description; - - &info.function.alias; - ibase_close. - - - - - &reftitle.seealso; - - fbird_connect - fbird_pconnect - - - - - diff --git a/reference/ibase/functions/fbird-commit-ret.xml b/reference/ibase/functions/fbird-commit-ret.xml deleted file mode 100644 index fc1582e0e2b2..000000000000 --- a/reference/ibase/functions/fbird-commit-ret.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - fbird_commit_ret - &Alias; ibase_commit_ret - - - - &reftitle.description; - - &info.function.alias; - ibase_commit_ret. - - - - - - diff --git a/reference/ibase/functions/fbird-commit.xml b/reference/ibase/functions/fbird-commit.xml deleted file mode 100644 index 538fe6f74e30..000000000000 --- a/reference/ibase/functions/fbird-commit.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - fbird_commit - &Alias; ibase_commit - - - - &reftitle.description; - - &info.function.alias; - ibase_commit. - - - - - - diff --git a/reference/ibase/functions/fbird-connect.xml b/reference/ibase/functions/fbird-connect.xml deleted file mode 100644 index 2c9322a52907..000000000000 --- a/reference/ibase/functions/fbird-connect.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - - - fbird_connect - &Alias; ibase_connect - - - - &reftitle.description; - - &info.function.alias; - ibase_connect. - - - - - &reftitle.seealso; - - fbird_pconnect - fbird_close - - - - - diff --git a/reference/ibase/functions/fbird-db-info.xml b/reference/ibase/functions/fbird-db-info.xml deleted file mode 100644 index 7182d98904c7..000000000000 --- a/reference/ibase/functions/fbird-db-info.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - fbird_db_info - &Alias; ibase_db_info - - - - &reftitle.description; - - &info.function.alias; - ibase_db_info. - - - - - - diff --git a/reference/ibase/functions/fbird-delete-user.xml b/reference/ibase/functions/fbird-delete-user.xml deleted file mode 100644 index 5581627a0dff..000000000000 --- a/reference/ibase/functions/fbird-delete-user.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - - - fbird_delete_user - &Alias; ibase_delete_user - - - - &reftitle.description; - - &info.function.alias; - ibase_delete_user. - - - - - &reftitle.seealso; - - fbird_add_user - fbird_modify_user - - - - - diff --git a/reference/ibase/functions/fbird-drop-db.xml b/reference/ibase/functions/fbird-drop-db.xml deleted file mode 100644 index 203ac7306a75..000000000000 --- a/reference/ibase/functions/fbird-drop-db.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - - - fbird_drop_db - &Alias; ibase_drop_db - - - - &reftitle.description; - - &info.function.alias; - ibase_drop_db. - - - - - &reftitle.seealso; - - fbird_connect - fbird_pconnect - - - - - diff --git a/reference/ibase/functions/fbird-errcode.xml b/reference/ibase/functions/fbird-errcode.xml deleted file mode 100644 index 3f75922a910f..000000000000 --- a/reference/ibase/functions/fbird-errcode.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - fbird_errcode - &Alias; ibase_errcode - - - - &reftitle.description; - - &info.function.alias; - ibase_errcode. - - - - - &reftitle.seealso; - - fbird_errmsg - - - - - diff --git a/reference/ibase/functions/fbird-errmsg.xml b/reference/ibase/functions/fbird-errmsg.xml deleted file mode 100644 index ef7b1837e76f..000000000000 --- a/reference/ibase/functions/fbird-errmsg.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - fbird_errmsg - &Alias; ibase_errmsg - - - - &reftitle.description; - - &info.function.alias; - ibase_errmsg. - - - - - &reftitle.seealso; - - fbird_errcode - - - - - diff --git a/reference/ibase/functions/fbird-execute.xml b/reference/ibase/functions/fbird-execute.xml deleted file mode 100644 index a8bc7da9ef58..000000000000 --- a/reference/ibase/functions/fbird-execute.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - fbird_execute - &Alias; ibase_execute - - - - &reftitle.description; - - &info.function.alias; - ibase_execute. - - - - - &reftitle.seealso; - - fbird_query - - - - - diff --git a/reference/ibase/functions/fbird-fetch-assoc.xml b/reference/ibase/functions/fbird-fetch-assoc.xml deleted file mode 100644 index 3b5fa2c85b7c..000000000000 --- a/reference/ibase/functions/fbird-fetch-assoc.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - - - fbird_fetch_assoc - &Alias; ibase_fetch_assoc - - - - &reftitle.description; - - &info.function.alias; - ibase_fetch_assoc. - - - - - &reftitle.seealso; - - fbird_fetch_row - fbird_fetch_object - - - - - diff --git a/reference/ibase/functions/fbird-fetch-object.xml b/reference/ibase/functions/fbird-fetch-object.xml deleted file mode 100644 index 853db71677f6..000000000000 --- a/reference/ibase/functions/fbird-fetch-object.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - - - fbird_fetch_object - &Alias; ibase_fetch_object - - - - &reftitle.description; - - &info.function.alias; - ibase_fetch_object. - - - - - &reftitle.seealso; - - fbird_fetch_row - fbird_fetch_assoc - - - - - diff --git a/reference/ibase/functions/fbird-fetch-row.xml b/reference/ibase/functions/fbird-fetch-row.xml deleted file mode 100644 index e07fee1cb915..000000000000 --- a/reference/ibase/functions/fbird-fetch-row.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - - - fbird_fetch_row - &Alias; ibase_fetch_row - - - - &reftitle.description; - - &info.function.alias; - ibase_fetch_row. - - - - - &reftitle.seealso; - - fbird_fetch_assoc - fbird_fetch_object - - - - - diff --git a/reference/ibase/functions/fbird-field-info.xml b/reference/ibase/functions/fbird-field-info.xml deleted file mode 100644 index 4eacec7afdfe..000000000000 --- a/reference/ibase/functions/fbird-field-info.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - fbird_field_info - &Alias; ibase_field_info - - - - &reftitle.description; - - &info.function.alias; - ibase_field_info. - - - - - &reftitle.seealso; - - fbird_num_fields - - - - - diff --git a/reference/ibase/functions/fbird-free-event-handler.xml b/reference/ibase/functions/fbird-free-event-handler.xml deleted file mode 100644 index 52d3448f23d4..000000000000 --- a/reference/ibase/functions/fbird-free-event-handler.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - fbird_free_event_handler - &Alias; ibase_free_event_handler - - - - &reftitle.description; - - &info.function.alias; - ibase_free_event_handler. - - - - - &reftitle.seealso; - - fbird_set_event_handler - - - - - diff --git a/reference/ibase/functions/fbird-free-query.xml b/reference/ibase/functions/fbird-free-query.xml deleted file mode 100644 index ec8795da2818..000000000000 --- a/reference/ibase/functions/fbird-free-query.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - fbird_free_query - &Alias; ibase_free_query - - - - &reftitle.description; - - &info.function.alias; - ibase_free_query. - - - - - - diff --git a/reference/ibase/functions/fbird-free-result.xml b/reference/ibase/functions/fbird-free-result.xml deleted file mode 100644 index 12000886d66d..000000000000 --- a/reference/ibase/functions/fbird-free-result.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - fbird_free_result - &Alias; ibase_free_result - - - - &reftitle.description; - - &info.function.alias; - ibase_free_result. - - - - - - diff --git a/reference/ibase/functions/fbird-gen-id.xml b/reference/ibase/functions/fbird-gen-id.xml deleted file mode 100644 index 618a9f1bcdfc..000000000000 --- a/reference/ibase/functions/fbird-gen-id.xml +++ /dev/null @@ -1,39 +0,0 @@ - - - - - - fbird_gen_id - &Alias; ibase_gen_id - - - - &reftitle.description; - - &info.function.alias; - ibase_gen_id. - - - - - - diff --git a/reference/ibase/functions/fbird-maintain-db.xml b/reference/ibase/functions/fbird-maintain-db.xml deleted file mode 100644 index c8c95c99598d..000000000000 --- a/reference/ibase/functions/fbird-maintain-db.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - fbird_maintain_db - &Alias; ibase_maintain_db - - - - &reftitle.description; - - &info.function.alias; - ibase_maintain_db. - - - - - - diff --git a/reference/ibase/functions/fbird-modify-user.xml b/reference/ibase/functions/fbird-modify-user.xml deleted file mode 100644 index 9581be249c5c..000000000000 --- a/reference/ibase/functions/fbird-modify-user.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - - - fbird_modify_user - &Alias; ibase_modify_user - - - - &reftitle.description; - - &info.function.alias; - ibase_modify_user. - - - - - &reftitle.seealso; - - fbird_add_user - fbird_delete_user - - - - - diff --git a/reference/ibase/functions/fbird-name-result.xml b/reference/ibase/functions/fbird-name-result.xml deleted file mode 100644 index fe3d251225d7..000000000000 --- a/reference/ibase/functions/fbird-name-result.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - - - fbird_name_result - &Alias; ibase_name_result - - - - &reftitle.description; - - &info.function.alias; - ibase_name_result. - - - - - &reftitle.seealso; - - fbird_prepare - fbird_execute - - - - - diff --git a/reference/ibase/functions/fbird-num-fields.xml b/reference/ibase/functions/fbird-num-fields.xml deleted file mode 100644 index 097b503fee9d..000000000000 --- a/reference/ibase/functions/fbird-num-fields.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - fbird_num_fields - &Alias; ibase_num_fields - - - - &reftitle.description; - - &info.function.alias; - ibase_num_fields. - - - - - &reftitle.seealso; - - fbird_field_info - - - - - diff --git a/reference/ibase/functions/fbird-num-params.xml b/reference/ibase/functions/fbird-num-params.xml deleted file mode 100644 index 2cff671ab3f3..000000000000 --- a/reference/ibase/functions/fbird-num-params.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - - - fbird_num_params - &Alias; ibase_num_params - - - - &reftitle.description; - - &info.function.alias; - ibase_num_params. - - - - - &reftitle.seealso; - - fbird_prepare - fbird_param_info - - - - - diff --git a/reference/ibase/functions/fbird-param-info.xml b/reference/ibase/functions/fbird-param-info.xml deleted file mode 100644 index 98d9a47b9f15..000000000000 --- a/reference/ibase/functions/fbird-param-info.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - - - fbird_param_info - &Alias; ibase_param_info - - - - &reftitle.description; - - &info.function.alias; - ibase_param_info. - - - - - &reftitle.seealso; - - fbird_field_info - fbird_num_params - - - - - diff --git a/reference/ibase/functions/fbird-pconnect.xml b/reference/ibase/functions/fbird-pconnect.xml deleted file mode 100644 index ef1313627439..000000000000 --- a/reference/ibase/functions/fbird-pconnect.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - - - fbird_pconnect - &Alias; ibase_pconnect - - - - &reftitle.description; - - &info.function.alias; - ibase_pconnect. - - - - - &reftitle.seealso; - - fbird_close - fbird_connect - - - - - diff --git a/reference/ibase/functions/fbird-prepare.xml b/reference/ibase/functions/fbird-prepare.xml deleted file mode 100644 index a112b24ab232..000000000000 --- a/reference/ibase/functions/fbird-prepare.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - fbird_prepare - &Alias; ibase_prepare - - - - &reftitle.description; - - &info.function.alias; - ibase_prepare. - - - - - - diff --git a/reference/ibase/functions/fbird-query.xml b/reference/ibase/functions/fbird-query.xml deleted file mode 100644 index 0d1becea59be..000000000000 --- a/reference/ibase/functions/fbird-query.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - fbird_query - &Alias; ibase_query - - - - &reftitle.description; - - &info.function.alias; - ibase_query. - - - - - &reftitle.seealso; - - fbird_errmsg - fbird_fetch_row - fbird_fetch_object - fbird_free_result - - - - - diff --git a/reference/ibase/functions/fbird-restore.xml b/reference/ibase/functions/fbird-restore.xml deleted file mode 100644 index 52c7d71ae153..000000000000 --- a/reference/ibase/functions/fbird-restore.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - fbird_restore - &Alias; ibase_restore - - - - &reftitle.description; - - &info.function.alias; - ibase_restore. - - - - - - diff --git a/reference/ibase/functions/fbird-rollback-ret.xml b/reference/ibase/functions/fbird-rollback-ret.xml deleted file mode 100644 index a135dbc66cda..000000000000 --- a/reference/ibase/functions/fbird-rollback-ret.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - fbird_rollback_ret - &Alias; ibase_rollback_ret - - - - &reftitle.description; - - &info.function.alias; - ibase_rollback_ret. - - - - - - diff --git a/reference/ibase/functions/fbird-rollback.xml b/reference/ibase/functions/fbird-rollback.xml deleted file mode 100644 index 539091703efd..000000000000 --- a/reference/ibase/functions/fbird-rollback.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - fbird_rollback - &Alias; ibase_rollback - - - - &reftitle.description; - - &info.function.alias; - ibase_rollback. - - - - - - diff --git a/reference/ibase/functions/fbird-server-info.xml b/reference/ibase/functions/fbird-server-info.xml deleted file mode 100644 index 8580bc372102..000000000000 --- a/reference/ibase/functions/fbird-server-info.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - fbird_server_info - &Alias; ibase_server_info - - - - &reftitle.description; - - &info.function.alias; - ibase_server_info. - - - - - - diff --git a/reference/ibase/functions/fbird-service-attach.xml b/reference/ibase/functions/fbird-service-attach.xml deleted file mode 100644 index 49a9f8f57457..000000000000 --- a/reference/ibase/functions/fbird-service-attach.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - fbird_service_attach - &Alias; ibase_service_attach - - - - &reftitle.description; - - &info.function.alias; - ibase_service_attach. - - - - - - diff --git a/reference/ibase/functions/fbird-service-detach.xml b/reference/ibase/functions/fbird-service-detach.xml deleted file mode 100644 index 8996f1351de0..000000000000 --- a/reference/ibase/functions/fbird-service-detach.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - fbird_service_detach - &Alias; ibase_service_detach - - - - &reftitle.description; - - &info.function.alias; - ibase_service_detach. - - - - - - diff --git a/reference/ibase/functions/fbird-set-event-handler.xml b/reference/ibase/functions/fbird-set-event-handler.xml deleted file mode 100644 index 4c3cb000d185..000000000000 --- a/reference/ibase/functions/fbird-set-event-handler.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - - - fbird_set_event_handler - &Alias; ibase_set_event_handler - - - - &reftitle.description; - - &info.function.alias; - ibase_set_event_handler. - - - - - &reftitle.seealso; - - fbird_free_event_handler - fbird_wait_event - - - - - diff --git a/reference/ibase/functions/fbird-trans.xml b/reference/ibase/functions/fbird-trans.xml deleted file mode 100644 index 6993408337da..000000000000 --- a/reference/ibase/functions/fbird-trans.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - fbird_trans - &Alias; ibase_trans - - - - &reftitle.description; - - &info.function.alias; - ibase_trans. - - - - - - diff --git a/reference/ibase/functions/fbird-wait-event.xml b/reference/ibase/functions/fbird-wait-event.xml deleted file mode 100644 index c79246743b8d..000000000000 --- a/reference/ibase/functions/fbird-wait-event.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - - - fbird_wait_event - &Alias; ibase_wait_event - - - - &reftitle.description; - - &info.function.alias; - ibase_wait_event. - - - - - &reftitle.seealso; - - fbird_set_event_handler - fbird_free_event_handler - - - - - diff --git a/reference/ibase/functions/ibase-add-user.xml b/reference/ibase/functions/ibase-add-user.xml deleted file mode 100644 index 324dee01bf3f..000000000000 --- a/reference/ibase/functions/ibase-add-user.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - ibase_add_user - Add a user to a security database - - - - &reftitle.description; - - boolibase_add_user - resourceservice_handle - stringuser_name - stringpassword - stringfirst_name - stringmiddle_name - stringlast_name - - - - - &reftitle.parameters; - - - service_handle - - - The handle on the database server service. - - - - - user_name - - - The login name of the new database user. - - - - - password - - - The password of the new user. - - - - - first_name - - - The first name of the new database user. - - - - - middle_name - - - The middle name of the new database user. - - - - - last_name - - - The last name of the new database user. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - ibase_modify_user - ibase_delete_user - - - - - diff --git a/reference/ibase/functions/ibase-affected-rows.xml b/reference/ibase/functions/ibase-affected-rows.xml deleted file mode 100644 index f2ee2b3cea8b..000000000000 --- a/reference/ibase/functions/ibase-affected-rows.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - ibase_affected_rows - Return the number of rows that were affected by the previous query - - - - &reftitle.description; - - intibase_affected_rows - resourcelink_identifier - - - This function returns the number of rows that were affected by the - previous query (INSERT, UPDATE or DELETE) that was executed from within - the specified transaction context. - - - - - &reftitle.parameters; - - - link_identifier - - - A transaction context. If link_identifier is a - connection resource, its default transaction is used. - - - - - - - - &reftitle.returnvalues; - - Returns the number of rows as an integer. - - - - - &reftitle.seealso; - - ibase_query - ibase_execute - - - - - diff --git a/reference/ibase/functions/ibase-backup.xml b/reference/ibase/functions/ibase-backup.xml deleted file mode 100644 index a12ccbe1c63d..000000000000 --- a/reference/ibase/functions/ibase-backup.xml +++ /dev/null @@ -1,165 +0,0 @@ - - - - - ibase_backup - Initiates a backup task in the service manager and returns immediately - - - - &reftitle.description; - - mixedibase_backup - resourceservice_handle - stringsource_db - stringdest_file - intoptions0 - boolverbose&false; - - - This function passes the arguments to the (remote) database server. There it starts a new backup process. Therefore you - won't get any responses. - - - - - &reftitle.parameters; - - - service_handle - - - A previously opened connection to the database server. - - - - - source_db - - - The absolute file path to the database on the database server. You can also use a database alias. - - - - - dest_file - - - The path to the backup file on the database server. - - - - - options - - - Additional options to pass to the database server for backup. - The options parameter can be a combination - of the following constants: - IBASE_BKP_IGNORE_CHECKSUMS, - IBASE_BKP_IGNORE_LIMBO, - IBASE_BKP_METADATA_ONLY, - IBASE_BKP_NO_GARBAGE_COLLECT, - IBASE_BKP_OLD_DESCRIPTIONS, - IBASE_BKP_NON_TRANSPORTABLE or - IBASE_BKP_CONVERT. - Read the section about for further information. - - - - - verbose - - - Since the backup process is done on the database server, you don't have any chance - to get its output. This argument is useless. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - Since the backup process is done on the (remote) server, this function just passes the arguments to it. - While the arguments are legal, you won't get &false;. - - - - - &reftitle.examples; - - <function>ibase_backup</function> example - - -]]> - - - - - <function>ibase_backup</function> example with arguments - - -]]> - - - - - - &reftitle.seealso; - - ibase_restore - - - - - diff --git a/reference/ibase/functions/ibase-blob-add.xml b/reference/ibase/functions/ibase-blob-add.xml deleted file mode 100644 index 135e22ffd60d..000000000000 --- a/reference/ibase/functions/ibase-blob-add.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - ibase_blob_add - Add data into a newly created blob - - - - &reftitle.description; - - voidibase_blob_add - resourceblob_handle - stringdata - - - ibase_blob_add adds data into a blob created with - ibase_blob_create. - - - - - &reftitle.parameters; - - - blob_handle - - - A blob handle opened with ibase_blob_create. - - - - - data - - - The data to be added. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - ibase_blob_cancel - ibase_blob_close - ibase_blob_create - ibase_blob_import - - - - - diff --git a/reference/ibase/functions/ibase-blob-cancel.xml b/reference/ibase/functions/ibase-blob-cancel.xml deleted file mode 100644 index 258a69be4702..000000000000 --- a/reference/ibase/functions/ibase-blob-cancel.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - ibase_blob_cancel - Cancel creating blob - - - - &reftitle.description; - - boolibase_blob_cancel - resourceblob_handle - - - This function will discard a BLOB if it has not yet been closed by - ibase_blob_close. - - - - - &reftitle.parameters; - - - blob_handle - - - A BLOB handle opened with ibase_blob_create. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - ibase_blob_close - ibase_blob_create - ibase_blob_import - - - - - diff --git a/reference/ibase/functions/ibase-blob-close.xml b/reference/ibase/functions/ibase-blob-close.xml deleted file mode 100644 index 352d4ebc3769..000000000000 --- a/reference/ibase/functions/ibase-blob-close.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - ibase_blob_close - Close blob - - - - &reftitle.description; - - mixedibase_blob_close - resourceblob_handle - - - This function closes a BLOB that has either been opened for reading by - ibase_blob_open or has been opened for writing by - ibase_blob_create. - - - - - &reftitle.parameters; - - - blob_handle - - - A BLOB handle opened with ibase_blob_create or - ibase_blob_open. - - - - - - - - &reftitle.returnvalues; - - If the BLOB was being read, this function returns &true; on success, if - the BLOB was being written to, this function returns a string containing - the BLOB id that has been assigned to it by the database. On failure, this - function returns &false;. - - - - - &reftitle.seealso; - - ibase_blob_cancel - ibase_blob_open - - - - - diff --git a/reference/ibase/functions/ibase-blob-create.xml b/reference/ibase/functions/ibase-blob-create.xml deleted file mode 100644 index 83cf34a7de3b..000000000000 --- a/reference/ibase/functions/ibase-blob-create.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - ibase_blob_create - Create a new blob for adding data - - - - &reftitle.description; - - resourcefalseibase_blob_create - resourcelink_identifier&null; - - - ibase_blob_create creates a new BLOB for filling with - data. - - - - - &reftitle.parameters; - - - link_identifier - - - An InterBase link identifier. If omitted, the last opened link is - assumed. - - - - - - - - &reftitle.returnvalues; - - Returns a BLOB handle for later use with - ibase_blob_add&return.falseforfailure;. - - - - - &reftitle.seealso; - - ibase_blob_add - ibase_blob_cancel - ibase_blob_close - ibase_blob_import - - - - - diff --git a/reference/ibase/functions/ibase-blob-echo.xml b/reference/ibase/functions/ibase-blob-echo.xml deleted file mode 100644 index 6d9debcdd351..000000000000 --- a/reference/ibase/functions/ibase-blob-echo.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - ibase_blob_echo - Output blob contents to browser - - - - &reftitle.description; - - boolibase_blob_echo - stringblob_id - - - boolibase_blob_echo - resourcelink_identifier - stringblob_id - - - This function opens a BLOB for reading and sends its contents directly to - standard output (the browser, in most cases). - - - - - &reftitle.parameters; - - - link_identifier - - - An InterBase link identifier. If omitted, the last opened link is - assumed. - - - - - blob_id - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - ibase_blob_open - ibase_blob_close - ibase_blob_get - - - - - diff --git a/reference/ibase/functions/ibase-blob-get.xml b/reference/ibase/functions/ibase-blob-get.xml deleted file mode 100644 index f1c892859f21..000000000000 --- a/reference/ibase/functions/ibase-blob-get.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - ibase_blob_get - Get len bytes data from open blob - - - - &reftitle.description; - - stringibase_blob_get - resourceblob_handle - intlen - - - This function returns at most len bytes from a BLOB - that has been opened for reading by ibase_blob_open. - - - - It is not possible to read from a BLOB that has been opened for writing - by ibase_blob_create. - - - - - - &reftitle.parameters; - - - blob_handle - - - A BLOB handle opened with ibase_blob_open. - - - - - len - - - Size of returned data. - - - - - - - - &reftitle.returnvalues; - - Returns at most len bytes from the BLOB, or &false; - on failure. - - - - - &reftitle.examples; - - - <function>ibase_blob_get</function> example - -BLOB_VALUE); -$blob_hndl = ibase_blob_open($data->BLOB_VALUE); -echo ibase_blob_get($blob_hndl, $blob_data[0]); -?> -]]> - - - Whilst this example doesn't do much more than a - 'ibase_blob_echo($data->BLOB_VALUE)' would do, it does show you how to get - information into a $variable to manipulate as you please. - - - - - &reftitle.seealso; - - ibase_blob_open - ibase_blob_close - ibase_blob_echo - - - - - diff --git a/reference/ibase/functions/ibase-blob-import.xml b/reference/ibase/functions/ibase-blob-import.xml deleted file mode 100644 index 03bbfc85a9ce..000000000000 --- a/reference/ibase/functions/ibase-blob-import.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - ibase_blob_import - Create blob, copy file in it, and close it - - - - &reftitle.description; - - stringibase_blob_import - resourcelink_identifier - resourcefile_handle - - - stringibase_blob_import - resourcefile_handle - - - This function creates a BLOB, reads an entire file into it, closes it and - returns the assigned BLOB id. - - - - - &reftitle.parameters; - - - link_identifier - - - An InterBase link identifier. If omitted, the last opened link is - assumed. - - - - - file_handle - - - The file handle is a handle returned by fopen. - - - - - - - - &reftitle.returnvalues; - - Returns the BLOB id on success, or &false; on error. - - - - - &reftitle.examples; - - <function>ibase_blob_import</function> example - - -]]> - - - - - - &reftitle.seealso; - - ibase_blob_add - ibase_blob_cancel - ibase_blob_close - ibase_blob_create - - - - - diff --git a/reference/ibase/functions/ibase-blob-info.xml b/reference/ibase/functions/ibase-blob-info.xml deleted file mode 100644 index 84ce2fd3f070..000000000000 --- a/reference/ibase/functions/ibase-blob-info.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - ibase_blob_info - Return blob length and other useful info - - - - &reftitle.description; - - arrayibase_blob_info - resourcelink_identifier - stringblob_id - - - arrayibase_blob_info - stringblob_id - - - Returns the BLOB length and other useful information. - - - - - &reftitle.parameters; - - - link_identifier - - - An InterBase link identifier. If omitted, the last opened link is - assumed. - - - - - blob_id - - - A BLOB id. - - - - - - - - &reftitle.returnvalues; - - Returns an array containing information about a BLOB. The information returned - consists of the length of the BLOB, the number of segments it contains, the size - of the largest segment, and whether it is a stream BLOB or a segmented BLOB. - - - - - diff --git a/reference/ibase/functions/ibase-blob-open.xml b/reference/ibase/functions/ibase-blob-open.xml deleted file mode 100644 index 222856b15392..000000000000 --- a/reference/ibase/functions/ibase-blob-open.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - ibase_blob_open - Open blob for retrieving data parts - - - - &reftitle.description; - - resourcefalseibase_blob_open - resourcelink_identifier - stringblob_id - - - resourcefalseibase_blob_open - stringblob_id - - - Opens an existing BLOB for reading. - - - - - &reftitle.parameters; - - - link_identifier - - - An InterBase link identifier. If omitted, the last opened link is - assumed. - - - - - blob_id - - - A BLOB id. - - - - - - - - &reftitle.returnvalues; - - Returns a BLOB handle for later use with - ibase_blob_get&return.falseforfailure;. - - - - - &reftitle.seealso; - - ibase_blob_close - ibase_blob_echo - ibase_blob_get - - - - - diff --git a/reference/ibase/functions/ibase-close.xml b/reference/ibase/functions/ibase-close.xml deleted file mode 100644 index 05e90918a5cb..000000000000 --- a/reference/ibase/functions/ibase-close.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - ibase_close - Close a connection to an InterBase database - - - - &reftitle.description; - - boolibase_close - resourceconnection_id&null; - - - Closes the link to an InterBase database that's associated with - a connection id returned from ibase_connect. - Default transaction on link is committed, other transactions are - rolled back. - - - - - &reftitle.parameters; - - - connection_id - - - An InterBase link identifier returned from - ibase_connect. If omitted, the last opened link - is assumed. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - ibase_connect - ibase_pconnect - - - - - diff --git a/reference/ibase/functions/ibase-commit-ret.xml b/reference/ibase/functions/ibase-commit-ret.xml deleted file mode 100644 index b50f1b0bc4b3..000000000000 --- a/reference/ibase/functions/ibase-commit-ret.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - ibase_commit_ret - Commit a transaction without closing it - - - - &reftitle.description; - - boolibase_commit_ret - resourcelink_or_trans_identifier&null; - - - Commits a transaction without closing it. - - - - - &reftitle.parameters; - - - link_or_trans_identifier - - - If called without an argument, this function commits the default - transaction of the default link. If the argument is a connection - identifier, the default transaction of the corresponding connection - will be committed. If the argument is a transaction identifier, the - corresponding transaction will be committed. The transaction context - will be retained, so statements executed from within this transaction - will not be invalidated. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/ibase/functions/ibase-commit.xml b/reference/ibase/functions/ibase-commit.xml deleted file mode 100644 index ea44c0c6f887..000000000000 --- a/reference/ibase/functions/ibase-commit.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - ibase_commit - Commit a transaction - - - - &reftitle.description; - - boolibase_commit - resourcelink_or_trans_identifier&null; - - - Commits a transaction. - - - - - &reftitle.parameters; - - - link_or_trans_identifier - - - If called without an argument, this function commits the default - transaction of the default link. If the argument is a connection - identifier, the default transaction of the corresponding connection - will be committed. If the argument is a transaction identifier, the - corresponding transaction will be committed. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/ibase/functions/ibase-connect.xml b/reference/ibase/functions/ibase-connect.xml deleted file mode 100644 index ffe791fcbdd5..000000000000 --- a/reference/ibase/functions/ibase-connect.xml +++ /dev/null @@ -1,184 +0,0 @@ - - - - - ibase_connect - Open a connection to a database - - - - &reftitle.description; - - resourceibase_connect - stringdatabase - stringusername - stringpassword - stringcharset - intbuffers - intdialect - stringrole - intsync - - - Establishes a connection to an Firebird/InterBase server. - - - In case a second call is made to ibase_connect with - the same arguments, no new link will be established, but instead, the link - identifier of the already opened link will be returned. The link to the - server will be closed as soon as the execution of the script ends, unless - it's closed earlier by explicitly calling ibase_close. - - - - - &reftitle.parameters; - - - database - - - The database argument has to be a valid path to - database file on the server it resides on. If the server is not local, - it must be prefixed with either 'hostname:' (TCP/IP), 'hostname/port:' - (TCP/IP with interbase server on custom TCP port), '//hostname/' - (NetBEUI), depending on the connection - protocol used. - - - - - username - - - The user name. Can be set with the - ibase.default_user &php.ini; directive. - - - - - password - - - The password for username. Can be set with the - ibase.default_password &php.ini; directive. - - - - - charset - - - charset is the default character set for a - database. - - - - - buffers - - - buffers is the number of database buffers to - allocate for the server-side cache. If 0 or omitted, server chooses - its own default. - - - - - dialect - - - dialect selects the default SQL dialect for any - statement executed within a connection, and it defaults to the highest - one supported by client libraries. - - - - - role - - - Functional only with InterBase 5 and up. - - - - - sync - - - - - - - - - - &reftitle.returnvalues; - - Returns an Firebird/InterBase link identifier on success, or &false; on error. - - - - - &reftitle.errors; - - If you get some error like "arithmetic exception, numeric overflow, or - string truncation. Cannot transliterate character between character sets" - (this occurs when you try use some character with accents) when using this - and after ibase_query you must set the character set - (i.e. ISO8859_1 or your current character set). - - - - - &reftitle.examples; - - <function>ibase_connect</function> example - -email, "\n"; -} -ibase_free_result($sth); -ibase_close($dbh); -?> -]]> - - - - - - &reftitle.seealso; - - ibase_pconnect - ibase_close - - - - - diff --git a/reference/ibase/functions/ibase-db-info.xml b/reference/ibase/functions/ibase-db-info.xml deleted file mode 100644 index b829a580da08..000000000000 --- a/reference/ibase/functions/ibase-db-info.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - ibase_db_info - Request statistics about a database - - - - &reftitle.description; - - stringibase_db_info - resourceservice_handle - stringdb - intaction - intargument0 - - - &warn.undocumented.func; - - - - - - diff --git a/reference/ibase/functions/ibase-delete-user.xml b/reference/ibase/functions/ibase-delete-user.xml deleted file mode 100644 index e730903c3e3f..000000000000 --- a/reference/ibase/functions/ibase-delete-user.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - ibase_delete_user - Delete a user from a security database - - - - &reftitle.description; - - boolibase_delete_user - resourceservice_handle - stringuser_name - - - - - - &reftitle.parameters; - - - service_handle - - - The handle on the database server service. - - - - - user_name - - - The login name of the user you want to delete from the database. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - ibase_add_user - ibase_modify_user - - - - - diff --git a/reference/ibase/functions/ibase-drop-db.xml b/reference/ibase/functions/ibase-drop-db.xml deleted file mode 100644 index 5e57fe9c2ac8..000000000000 --- a/reference/ibase/functions/ibase-drop-db.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - ibase_drop_db - Drops a database - - - - &reftitle.description; - - boolibase_drop_db - resourceconnection&null; - - - This functions drops a database that was opened by either ibase_connect - or ibase_pconnect. The database is closed and deleted from the server. - - - - - &reftitle.parameters; - - - connection - - - An InterBase link identifier. If omitted, the last opened link is - assumed. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - ibase_connect - ibase_pconnect - - - - - diff --git a/reference/ibase/functions/ibase-errcode.xml b/reference/ibase/functions/ibase-errcode.xml deleted file mode 100644 index d37dc70dbeed..000000000000 --- a/reference/ibase/functions/ibase-errcode.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - ibase_errcode - Return an error code - - - - &reftitle.description; - - intibase_errcode - - - - Returns the error code that resulted from the most recent InterBase function - call. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the error code as an integer, or &false; if no error occurred. - - - - - &reftitle.seealso; - - ibase_errmsg - - - - - diff --git a/reference/ibase/functions/ibase-errmsg.xml b/reference/ibase/functions/ibase-errmsg.xml deleted file mode 100644 index 7403b7b9bef3..000000000000 --- a/reference/ibase/functions/ibase-errmsg.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - ibase_errmsg - Return error messages - - - - &reftitle.description; - - stringibase_errmsg - - - - Returns the error message that resulted from the most recent InterBase function - call. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the error message as a string, or &false; if no error occurred. - - - - - &reftitle.seealso; - - ibase_errcode - - - - - diff --git a/reference/ibase/functions/ibase-execute.xml b/reference/ibase/functions/ibase-execute.xml deleted file mode 100644 index 673b7a3cd50f..000000000000 --- a/reference/ibase/functions/ibase-execute.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - ibase_execute - Execute a previously prepared query - - - - &reftitle.description; - - resourceibase_execute - resourcequery - mixedvalues - - - Execute a query prepared by ibase_prepare. - - - This is a lot more effective than using ibase_query - if you are repeating a same kind of query several times with only - some parameters changing. - - - - - &reftitle.parameters; - - - query - - - An InterBase query prepared by ibase_prepare. - - - - - values - - - - - - - - - - &reftitle.returnvalues; - - If the query raises an error, returns &false;. If it is successful and - there is a (possibly empty) result set (such as with a SELECT query), - returns a result identifier. If the query was successful and there were - no results, returns &true;. - - - - This function returns the number of rows affected by - the query (if > 0 and applicable to the statement type). A query that - succeeded, but did not affect any rows (e.g. an UPDATE of a non-existent - record) will return &true;. - - - - - - &reftitle.examples; - - <function>ibase_execute</function> example - - 'Eric', - 5 => 'Filip', - 7 => 'Larry' -); - -$query = ibase_prepare($dbh, "UPDATE FOO SET BAR = ? WHERE BAZ = ?"); - -foreach ($updates as $baz => $bar) { - ibase_execute($query, $bar, $baz); -} - -?> -]]> - - - - - - &reftitle.seealso; - - ibase_query - - - - - diff --git a/reference/ibase/functions/ibase-fetch-assoc.xml b/reference/ibase/functions/ibase-fetch-assoc.xml deleted file mode 100644 index c872ff604a4d..000000000000 --- a/reference/ibase/functions/ibase-fetch-assoc.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - ibase_fetch_assoc - Fetch a result row from a query as an associative array - - - - &reftitle.description; - - arrayibase_fetch_assoc - resourceresult - intfetch_flag0 - - - Fetch a result row from a query as an associative array. - - - ibase_fetch_assoc fetches one row of data from the - result. If two or more columns of the result - have the same field names, the last column will take precedence. To - access the other column(s) of the same name, you either need to access - the result with numeric indices by using - ibase_fetch_row or use alias names in your query. - - - - - &reftitle.parameters; - - - result - - - The result handle. - - - - - fetch_flag - - - fetch_flag is a combination of the constants - IBASE_TEXT and IBASE_UNIXTIME - ORed together. Passing IBASE_TEXT will cause this - function to return BLOB contents instead of BLOB ids. Passing - IBASE_UNIXTIME will cause this function to return - date/time values as Unix timestamps instead of as formatted strings. - - - - - - - - &reftitle.returnvalues; - - Returns an associative array that corresponds to the fetched row. - Subsequent calls will return the next row in the result set, or &false; if - there are no more rows. - - - - - &reftitle.seealso; - - ibase_fetch_row - ibase_fetch_object - - - - - diff --git a/reference/ibase/functions/ibase-fetch-object.xml b/reference/ibase/functions/ibase-fetch-object.xml deleted file mode 100644 index 0e0265f78746..000000000000 --- a/reference/ibase/functions/ibase-fetch-object.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - ibase_fetch_object - Get an object from a InterBase database - - - - &reftitle.description; - - objectibase_fetch_object - resourceresult_id - intfetch_flag0 - - - Fetches a row as a pseudo-object from a given result identifier. - - - Subsequent calls to ibase_fetch_object - return the next row in the result set. - - - - - &reftitle.parameters; - - - result_id - - - An InterBase result identifier obtained either by - ibase_query or ibase_execute. - - - - - fetch_flag - - - fetch_flag is a combination of the constants - IBASE_TEXT and IBASE_UNIXTIME - ORed together. Passing IBASE_TEXT will cause this - function to return BLOB contents instead of BLOB ids. Passing - IBASE_UNIXTIME will cause this function to return - date/time values as Unix timestamps instead of as formatted strings. - - - - - - - - &reftitle.returnvalues; - - Returns an object with the next row information, or &false; if there are - no more rows. - - - - - &reftitle.examples; - - <function>ibase_fetch_object</function> example - -email . "\n"; -} -ibase_close($dbh); -?> -]]> - - - - - - &reftitle.seealso; - - ibase_fetch_row - ibase_fetch_assoc - - - - - diff --git a/reference/ibase/functions/ibase-fetch-row.xml b/reference/ibase/functions/ibase-fetch-row.xml deleted file mode 100644 index 67cc839997f0..000000000000 --- a/reference/ibase/functions/ibase-fetch-row.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - ibase_fetch_row - Fetch a row from an InterBase database - - - - &reftitle.description; - - arrayibase_fetch_row - resourceresult_identifier - intfetch_flag0 - - - ibase_fetch_row fetches one row of data from the - given result set. - - - Subsequent calls to ibase_fetch_row - return the next row in the result set, or &false; if there are no - more rows. - - - - - &reftitle.parameters; - - - result_identifier - - - An InterBase result identifier. - - - - - fetch_flag - - - fetch_flag is a combination of the constants - IBASE_TEXT and IBASE_UNIXTIME - ORed together. Passing IBASE_TEXT will cause this - function to return BLOB contents instead of BLOB ids. Passing - IBASE_UNIXTIME will cause this function to return - date/time values as Unix timestamps instead of as formatted strings. - - - - - - - - &reftitle.returnvalues; - - Returns an array that corresponds to the fetched row, or &false; if there - are no more rows. Each result column is stored in an array offset, - starting at offset 0. - - - - - &reftitle.seealso; - - ibase_fetch_assoc - ibase_fetch_object - - - - - diff --git a/reference/ibase/functions/ibase-field-info.xml b/reference/ibase/functions/ibase-field-info.xml deleted file mode 100644 index 05e3ce094eb6..000000000000 --- a/reference/ibase/functions/ibase-field-info.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - ibase_field_info - Get information about a field - - - - &reftitle.description; - - arrayibase_field_info - resourceresult - intfield_number - - - Returns an array with information about a field after a select - query has been run. - - - - - &reftitle.parameters; - - - result - - - An InterBase result identifier. - - - - - field_number - - - Field offset. - - - - - - - - &reftitle.returnvalues; - - Returns an array with the following keys: name, - alias, relation, - length and type. - - - - - &reftitle.examples; - - <function>ibase_field_info</function> example - - -]]> - - - - - - &reftitle.seealso; - - ibase_num_fields - - - - - diff --git a/reference/ibase/functions/ibase-free-event-handler.xml b/reference/ibase/functions/ibase-free-event-handler.xml deleted file mode 100644 index 3ce3bdd5c3f4..000000000000 --- a/reference/ibase/functions/ibase-free-event-handler.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - ibase_free_event_handler - Cancels a registered event handler - - - - &reftitle.description; - - boolibase_free_event_handler - resourceevent - - - This function causes the registered event handler specified by - event to be cancelled. The callback function will - no longer be called for the events it was registered to handle. - - - - - &reftitle.parameters; - - - event - - - An event resource, created by - ibase_set_event_handler. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - ibase_set_event_handler - - - - - diff --git a/reference/ibase/functions/ibase-free-query.xml b/reference/ibase/functions/ibase-free-query.xml deleted file mode 100644 index fa36734c5d61..000000000000 --- a/reference/ibase/functions/ibase-free-query.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - ibase_free_query - Free memory allocated by a prepared query - - - - &reftitle.description; - - boolibase_free_query - resourcequery - - - Frees a prepared query. - - - - - &reftitle.parameters; - - - query - - - A query prepared with ibase_prepare. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/ibase/functions/ibase-free-result.xml b/reference/ibase/functions/ibase-free-result.xml deleted file mode 100644 index 356a79bcc5c8..000000000000 --- a/reference/ibase/functions/ibase-free-result.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - ibase_free_result - Free a result set - - - - &reftitle.description; - - boolibase_free_result - resourceresult_identifier - - - Frees a result set. - - - - - &reftitle.parameters; - - - result_identifier - - - A result set created by ibase_query or - ibase_execute. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/ibase/functions/ibase-gen-id.xml b/reference/ibase/functions/ibase-gen-id.xml deleted file mode 100644 index aba1b59bd82e..000000000000 --- a/reference/ibase/functions/ibase-gen-id.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - ibase_gen_id - Increments the named generator and returns its new value - - - - &reftitle.description; - - mixedibase_gen_id - stringgenerator - intincrement1 - resourcelink_identifier&null; - - - &warn.undocumented.func; - - - - - &reftitle.returnvalues; - - Returns new generator value as integer, or as string if the value is too big. - - - - - diff --git a/reference/ibase/functions/ibase-maintain-db.xml b/reference/ibase/functions/ibase-maintain-db.xml deleted file mode 100644 index 3a062cce0816..000000000000 --- a/reference/ibase/functions/ibase-maintain-db.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - ibase_maintain_db - Execute a maintenance command on the database server - - - - &reftitle.description; - - boolibase_maintain_db - resourceservice_handle - stringdb - intaction - intargument0 - - - &warn.undocumented.func; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/ibase/functions/ibase-modify-user.xml b/reference/ibase/functions/ibase-modify-user.xml deleted file mode 100644 index 5c465803cf92..000000000000 --- a/reference/ibase/functions/ibase-modify-user.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - ibase_modify_user - Modify a user to a security database - - - - &reftitle.description; - - boolibase_modify_user - resourceservice_handle - stringuser_name - stringpassword - stringfirst_name - stringmiddle_name - stringlast_name - - - - - &reftitle.parameters; - - - service_handle - - - The handle on the database server service. - - - - - user_name - - - The login name of the database user to modify. - - - - - password - - - The user's new password. - - - - - first_name - - - The user's new first name. - - - - - middle_name - - - The user's new middle name. - - - - - last_name - - - The user's new last name. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - ibase_add_user - ibase_delete_user - - - - - diff --git a/reference/ibase/functions/ibase-name-result.xml b/reference/ibase/functions/ibase-name-result.xml deleted file mode 100644 index adfb8f78afe7..000000000000 --- a/reference/ibase/functions/ibase-name-result.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - ibase_name_result - Assigns a name to a result set - - - - &reftitle.description; - - boolibase_name_result - resourceresult - stringname - - - This function assigns a name to a result set. This name can be used later in - UPDATE|DELETE ... WHERE CURRENT OF name statements. - - - - - &reftitle.parameters; - - - result - - - An InterBase result set. - - - - - name - - - The name to be assigned. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>ibase_name_result</function> example - - -]]> - - - - - - &reftitle.seealso; - - ibase_prepare - ibase_execute - - - - - diff --git a/reference/ibase/functions/ibase-num-fields.xml b/reference/ibase/functions/ibase-num-fields.xml deleted file mode 100644 index d464ff8866f5..000000000000 --- a/reference/ibase/functions/ibase-num-fields.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - ibase_num_fields - Get the number of fields in a result set - - - - &reftitle.description; - - intibase_num_fields - resourceresult_id - - - Get the number of fields in a result set. - - - - - &reftitle.parameters; - - - result_id - - - An InterBase result identifier. - - - - - - - - &reftitle.returnvalues; - - Returns the number of fields as an integer. - - - - - &reftitle.examples; - - <function>ibase_num_fields</function> example - - -]]> - - - - - - &reftitle.seealso; - - ibase_field_info - - - - - diff --git a/reference/ibase/functions/ibase-num-params.xml b/reference/ibase/functions/ibase-num-params.xml deleted file mode 100644 index 0f8b8cd9112f..000000000000 --- a/reference/ibase/functions/ibase-num-params.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - ibase_num_params - Return the number of parameters in a prepared query - - - - &reftitle.description; - - intibase_num_params - resourcequery - - - This function returns the number of parameters in the prepared query specified - by query. This is the number of binding arguments that - must be present when calling ibase_execute. - - - - - &reftitle.parameters; - - - query - - - The prepared query handle. - - - - - - - - &reftitle.returnvalues; - - Returns the number of parameters as an integer. - - - - - &reftitle.seealso; - - ibase_prepare - ibase_param_info - - - - - diff --git a/reference/ibase/functions/ibase-param-info.xml b/reference/ibase/functions/ibase-param-info.xml deleted file mode 100644 index 9a2faa414bd8..000000000000 --- a/reference/ibase/functions/ibase-param-info.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - ibase_param_info - Return information about a parameter in a prepared query - - - - &reftitle.description; - - arrayibase_param_info - resourcequery - intparam_number - - - Returns an array with information about a parameter after a - query has been prepared. - - - - - &reftitle.parameters; - - - query - - - An InterBase prepared query handle. - - - - - param_number - - - Parameter offset. - - - - - - - - &reftitle.returnvalues; - - Returns an array with the following keys: name, - alias, relation, - length and type. - - - - - &reftitle.seealso; - - ibase_field_info - ibase_num_params - - - - - diff --git a/reference/ibase/functions/ibase-pconnect.xml b/reference/ibase/functions/ibase-pconnect.xml deleted file mode 100644 index 6a5e266d198d..000000000000 --- a/reference/ibase/functions/ibase-pconnect.xml +++ /dev/null @@ -1,159 +0,0 @@ - - - - - ibase_pconnect - Open a persistent connection to an InterBase database - - - - &reftitle.description; - - resourceibase_pconnect - stringdatabase - stringusername - stringpassword - stringcharset - intbuffers - intdialect - stringrole - intsync - - - Opens a persistent connection to an InterBase database. - - - ibase_pconnect acts very much like - ibase_connect with two major differences. - - - First, when connecting, the function will first try to find a (persistent) - link that's already opened with the same parameters. If one is found, an - identifier for it will be returned instead of opening a new connection. - - - Second, the connection to the InterBase server will not be closed when the - execution of the script ends. Instead, the link will remain open for - future use (ibase_close will not close links - established by ibase_pconnect). This type of link is - therefore called 'persistent'. - - - - - &reftitle.parameters; - - - database - - - The database argument has to be a valid path to - database file on the server it resides on. If the server is not local, - it must be prefixed with either 'hostname:' (TCP/IP), '//hostname/' - (NetBEUI) or 'hostname@' (IPX/SPX), depending on the connection - protocol used. - - - - - username - - - The user name. Can be set with the - ibase.default_user &php.ini; directive. - - - - - password - - - The password for username. Can be set with the - ibase.default_password &php.ini; directive. - - - - - charset - - - charset is the default character set for a - database. - - - - - buffers - - - buffers is the number of database buffers to - allocate for the server-side cache. If 0 or omitted, server chooses - its own default. - - - - - dialect - - - dialect selects the default SQL dialect for any - statement executed within a connection, and it defaults to the highest - one supported by client libraries. Functional only with InterBase 6 - and up. - - - - - role - - - Functional only with InterBase 5 and up. - - - - - sync - - - - - - - - - - &reftitle.returnvalues; - - Returns an InterBase link identifier on success, or &false; on error. - - - - - &reftitle.seealso; - - ibase_close - ibase_connect - - - - - diff --git a/reference/ibase/functions/ibase-prepare.xml b/reference/ibase/functions/ibase-prepare.xml deleted file mode 100644 index dce12f8874b1..000000000000 --- a/reference/ibase/functions/ibase-prepare.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - ibase_prepare - Prepare a query for later binding of parameter placeholders and execution - - - - &reftitle.description; - - resourceibase_prepare - stringquery - - - resourceibase_prepare - resourcelink_identifier - stringquery - - - resourceibase_prepare - resourcelink_identifier - stringtrans - stringquery - - - Prepare a query for later binding of parameter placeholders and execution - (via ibase_execute). - - - - - &reftitle.parameters; - - - query - - - An InterBase query. - - - - - link_identifier - - - An InterBase link identifier returned from - ibase_connect. If omitted, the last opened link - is assumed. - - - - - trans - - - An InterBase transaction handle the query should be associated with. - If omitted, the default transaction of the connection is assumed. - - - - - - - - &reftitle.returnvalues; - - Returns a prepared query handle, or &false; on error. - - - - - diff --git a/reference/ibase/functions/ibase-query.xml b/reference/ibase/functions/ibase-query.xml deleted file mode 100644 index b9874a7db4f0..000000000000 --- a/reference/ibase/functions/ibase-query.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - ibase_query - Execute a query on an InterBase database - - - - &reftitle.description; - - resourceibase_query - resourcelink_identifier - stringquery - intbind_args - - - Performs a query on an InterBase database. - - - - - &reftitle.parameters; - - - link_identifier - - - An InterBase link identifier. If omitted, the last opened link is - assumed. - - - - - query - - - An InterBase query. - - - - - bind_args - - - - - - - - - - &reftitle.returnvalues; - - If the query raises an error, returns &false;. If it is successful and - there is a (possibly empty) result set (such as with a SELECT query), - returns a result identifier. If the query was successful and there were - no results, returns &true;. - - - - In PHP 5.0.0 and up, this function will return the number of rows - affected by the query for INSERT, UPDATE and DELETE statements. In order - to retain backward compatibility, it will return &true; for these - statements if the query succeeded without affecting any rows. - - - - - - &reftitle.errors; - - If you get some error like "arithmetic exception, numeric overflow, or - string truncation. Cannot transliterate character between character sets" - (this occurs when you try use some character with accents) when using this - and after ibase_query you must set the character set - (i.e. ISO8859_1 or your current character set). - - - - - &reftitle.examples; - - <function>ibase_query</function> example - - -]]> - - - - - - &reftitle.seealso; - - ibase_errmsg - ibase_fetch_row - ibase_fetch_object - ibase_free_result - - - - - diff --git a/reference/ibase/functions/ibase-restore.xml b/reference/ibase/functions/ibase-restore.xml deleted file mode 100644 index 3f62a87b4c80..000000000000 --- a/reference/ibase/functions/ibase-restore.xml +++ /dev/null @@ -1,170 +0,0 @@ - - - - - ibase_restore - Initiates a restore task in the service manager and returns immediately - - - - &reftitle.description; - - mixedibase_restore - resourceservice_handle - stringsource_file - stringdest_db - intoptions0 - boolverbose&false; - - - - This function passes the arguments to the (remote) database server. There it starts a new restore process. Therefore you - won't get any responses. - - - - - &reftitle.parameters; - - - service_handle - - - A previously opened connection to the database server. - - - - - source_file - - - The absolute path on the server where the backup file is located. - - - - - dest_db - - - The path to create the new database on the server. You can also use database alias. - - - - - options - - - Additional options to pass to the database server for restore. - The options parameter can be a combination - of the following constants: - IBASE_RES_DEACTIVATE_IDX, - IBASE_RES_NO_SHADOW, - IBASE_RES_NO_VALIDITY, - IBASE_RES_ONE_AT_A_TIME, - IBASE_RES_REPLACE, - IBASE_RES_CREATE, - IBASE_RES_USE_ALL_SPACE, - IBASE_PRP_PAGE_BUFFERS, - IBASE_PRP_SWEEP_INTERVAL, - IBASE_RES_CREATE. - Read the section about for further information. - - - - - verbose - - - Since the restore process is done on the database server, you don't have any chance - to get its output. This argument is useless. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - Since the restore process is done on the (remote) server, this function just passes the arguments to it. - While the arguments are legal, you won't get &false;. - - - - - &reftitle.examples; - - <function>ibase_restore</function> example - - -]]> - - - - - <function>ibase_restore</function> example with arguments - - -]]> - - - - - - - &reftitle.seealso; - - ibase_backup - - - - - diff --git a/reference/ibase/functions/ibase-rollback-ret.xml b/reference/ibase/functions/ibase-rollback-ret.xml deleted file mode 100644 index b9597ea227b2..000000000000 --- a/reference/ibase/functions/ibase-rollback-ret.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - ibase_rollback_ret - Roll back a transaction without closing it - - - - &reftitle.description; - - boolibase_rollback_ret - resourcelink_or_trans_identifier&null; - - - Rolls back a transaction without closing it. - - - - - &reftitle.parameters; - - - link_or_trans_identifier - - - If called without an argument, this function rolls back the default - transaction of the default link. If the argument is a connection - identifier, the default transaction of the corresponding connection - will be rolled back. If the argument is a transaction identifier, the - corresponding transaction will be rolled back. The transaction context - will be retained, so statements executed from within this transaction - will not be invalidated. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/ibase/functions/ibase-rollback.xml b/reference/ibase/functions/ibase-rollback.xml deleted file mode 100644 index 221917c9f3db..000000000000 --- a/reference/ibase/functions/ibase-rollback.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - ibase_rollback - Roll back a transaction - - - - &reftitle.description; - - boolibase_rollback - resourcelink_or_trans_identifier&null; - - - Rolls back a transaction. - - - - - &reftitle.parameters; - - - link_or_trans_identifier - - - If called without an argument, this function rolls back the default - transaction of the default link. If the argument is a connection - identifier, the default transaction of the corresponding connection - will be rolled back. If the argument is a transaction identifier, the - corresponding transaction will be rolled back. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/ibase/functions/ibase-server-info.xml b/reference/ibase/functions/ibase-server-info.xml deleted file mode 100644 index 2dca4976739a..000000000000 --- a/reference/ibase/functions/ibase-server-info.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - ibase_server_info - Request information about a database server - - - - &reftitle.description; - - stringibase_server_info - resourceservice_handle - intaction - - - - - &reftitle.parameters; - - - service_handle - - - A previously created connection to the database server. - - - - - action - - - A valid constant. - - - - - - - - &reftitle.returnvalues; - - Returns mixed types depending on context. - - - - - &reftitle.examples; - - <function>ibase_service_attach</function> example - - -]]> - - &example.outputs; - - Array - ( - [user_name] => SYSDBA - [first_name] => Sql - [middle_name] => Server - [last_name] => Administrator - [user_id] => 0 - [group_id] => 0 - ) - -) - -Server directory: /etc/firebird/ -Server lock path: /tmp/firebird/ -Server lib path: /usr/lib64/firebird/lib/ -Path of user db: /var/lib/firebird/secdb/security3.fdb -Established connections: Array -( - [attachments] => 3 - [databases] => 2 - [0] => /srv/firebird/poss.fdb - [1] => /srv/firebird/employees.fdb -) -]]> - - - - - - - diff --git a/reference/ibase/functions/ibase-service-attach.xml b/reference/ibase/functions/ibase-service-attach.xml deleted file mode 100644 index 2716af6a4d63..000000000000 --- a/reference/ibase/functions/ibase-service-attach.xml +++ /dev/null @@ -1,153 +0,0 @@ - - - - - ibase_service_attach - Connect to the service manager - - - - &reftitle.description; - - resourcefalseibase_service_attach - stringhost - stringdba_username - stringdba_password - - - - - &reftitle.parameters; - - - host - - - The name or ip address of the database host. You can define the port by adding - '/' and port number. If no port is specified, port 3050 will be used. - - - - - dba_username - - - The name of any valid user. - - - - - dba_password - - - The user's password. - - - - - - - - &reftitle.returnvalues; - - Returns a Interbase / Firebird link identifier on success&return.falseforfailure;. - - - - - &reftitle.examples; - - <function>ibase_service_attach</function> example - -"; - echo "Server implementation: " . $server_implementation; - } - else { - // Output message on error - $conn_error = ibase_errmsg(); - die($conn_error); - } - -?> -]]> - - - - - <function>ibase_service_attach</function> example using <literal>hostname/port</literal> syntax - -"; - echo "Server implementation: " . $server_implementation; - } - else { - // Output message on error - $conn_error = ibase_errmsg(); - die($conn_error); - } - -?> -]]> - - - - - - &reftitle.seealso; - - ibase_service_detach - - - - - diff --git a/reference/ibase/functions/ibase-service-detach.xml b/reference/ibase/functions/ibase-service-detach.xml deleted file mode 100644 index 0a1488126ec1..000000000000 --- a/reference/ibase/functions/ibase-service-detach.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - ibase_service_detach - Disconnect from the service manager - - - - &reftitle.description; - - boolibase_service_detach - resourceservice_handle - - - - - &reftitle.parameters; - - - service_handle - - - A previously created connection to the database server. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>ibase_service_detach</function> example - - -]]> - - - - - diff --git a/reference/ibase/functions/ibase-set-event-handler.xml b/reference/ibase/functions/ibase-set-event-handler.xml deleted file mode 100644 index dddb55557b34..000000000000 --- a/reference/ibase/functions/ibase-set-event-handler.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - ibase_set_event_handler - Register a callback function to be called when events are posted - - - - &reftitle.description; - - resourceibase_set_event_handler - callableevent_handler - stringevent_name - stringeven_names - - - resourceibase_set_event_handler - resourceconnection - callableevent_handler - stringevent_name - stringevent_names - - - This function registers a PHP user function as event handler for the - specified events. - - - - - &reftitle.parameters; - - - event_handler - - - The callback is called with the event name and the link resource as - arguments whenever one of the specified events is posted by the - database. - - - The callback must return &false; if the event handler should be - canceled. Any other return value is ignored. This function accepts up - to 15 event arguments. - - - - - event_name - - - An event name. - - - - - event_names - - - At most 15 events allowed. - - - - - - - - &reftitle.returnvalues; - - The return value is an event resource. This resource can be used to free - the event handler using ibase_free_event_handler. - - - - - &reftitle.examples; - - <function>ibase_set_event_handler</function> example - - -]]> - - - - - - &reftitle.seealso; - - ibase_free_event_handler - ibase_wait_event - - - - - diff --git a/reference/ibase/functions/ibase-trans.xml b/reference/ibase/functions/ibase-trans.xml deleted file mode 100644 index 74d676afbb35..000000000000 --- a/reference/ibase/functions/ibase-trans.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - ibase_trans - Begin a transaction - - - - &reftitle.description; - - resourceibase_trans - inttrans_args - resourcelink_identifier - - - resourceibase_trans - resourcelink_identifier - - - Begins a transaction. - - - - The first call to ibase_trans will not return the default transaction - of a connection. All transactions started by ibase_trans - will be rolled back at the end of the script if they were not committed or - rolled back by either ibase_commit or - ibase_rollback. - - - - - This function will accept multiple trans_args - and link_identifier arguments. This allows transactions - over multiple database connections, which are committed using a 2-phase commit - algorithm. This means you can rely on the updates to either succeed in every - database, or fail in every database. It does NOT mean you can use tables from - different databases in the same query! - - - If you use transactions over multiple databases, you will have to specify both - the link_id and transaction_id - in calls to ibase_query and ibase_prepare. - - - - - - &reftitle.parameters; - - - trans_args - - - trans_args can be a combination of - IBASE_READ, - IBASE_WRITE, - IBASE_COMMITTED, - IBASE_CONSISTENCY, - IBASE_CONCURRENCY, - IBASE_REC_VERSION, - IBASE_REC_NO_VERSION, - IBASE_WAIT and - IBASE_NOWAIT. - - - - - link_identifier - - - An InterBase link identifier. If omitted, the last opened link is - assumed. - - - - - - - - &reftitle.returnvalues; - - Returns a transaction handle, or &false; on error. - - - - - diff --git a/reference/ibase/functions/ibase-wait-event.xml b/reference/ibase/functions/ibase-wait-event.xml deleted file mode 100644 index a39d82b8d712..000000000000 --- a/reference/ibase/functions/ibase-wait-event.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - ibase_wait_event - Wait for an event to be posted by the database - - - - &reftitle.description; - - stringibase_wait_event - stringevent_name - stringevent_names - - - stringibase_wait_event - resourceconnection - stringevent_name - stringevent_names - - - This function suspends execution of the script until one of the specified events - is posted by the database. The name of the event that was posted is returned. This - function accepts up to 15 event arguments. - - - - - &reftitle.parameters; - - - event_name - - - The event name. - - - - - event_names - - - - - - - - - - &reftitle.returnvalues; - - Returns the name of the event that was posted. - - - - - &reftitle.seealso; - - ibase_set_event_handler - ibase_free_event_handler - - - - - diff --git a/reference/ibase/ini.xml b/reference/ibase/ini.xml deleted file mode 100644 index c43d2219f04a..000000000000 --- a/reference/ibase/ini.xml +++ /dev/null @@ -1,236 +0,0 @@ - - -
- &reftitle.runtime; - &extension.runtime; - - - InterBase configuration options - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - ibase.allow_persistent - "1" - INI_SYSTEM - - - - ibase.max_persistent - "-1" - INI_SYSTEM - - - - ibase.max_links - "-1" - INI_SYSTEM - - - - ibase.default_db - NULL - INI_SYSTEM - - - - ibase.default_user - NULL - INI_ALL - - - - ibase.default_password - NULL - INI_ALL - - - - ibase.default_charset - NULL - INI_ALL - - - - ibase.timestampformat - "%Y-%m-%d %H:%M:%S" - INI_ALL - - - - ibase.dateformat - "%Y-%m-%d" - INI_ALL - - - - ibase.timeformat - "%H:%M:%S" - INI_ALL - - - - -
- &ini.php.constants; -
- - &ini.descriptions.title; - - - - - ibase.allow_persistent - bool - - - - Whether to allow - persistent connections - to Firebird/InterBase. - - - - - - - ibase.max_persistent - int - - - - The maximum number of persistent Firebird/InterBase connections per - process. New connections created with ibase_pconnect() will be non-persistent - if this number would be exceeded. - - - - - - - ibase.max_links - int - - - - The maximum number of Firebird/InterBase connections per process, including - persistent connections. - - - - - - ibase.default_db - string - - - - The default database to connect to when ibase_[p]connect() is called - without specifying a database name. If this value is set and SQL safe - mode is enabled, no other connections than to this database will be allowed. - - - - - - ibase.default_user - string - - - - The user name to use when connecting to a database - if no user name is specified. - - - - - - - ibase.default_password - string - - - - The password to use when connecting to a database - if no password is specified. - - - - - - ibase.default_charset - string - - - - The character set to use when connecting to a database - if no character set is specified. - - - - - - - - - ibase.timestampformat - string - - - - - - - - - ibase.dateformat - string - - - - - - - - - ibase.timeformat - string - - - - These directives are used to set the date and time formats - that are used when returning dates and times from a result set, - or when binding arguments to date and time parameters. - - - - - -
- diff --git a/reference/ibase/reference.xml b/reference/ibase/reference.xml deleted file mode 100644 index 6df96bb60eb0..000000000000 --- a/reference/ibase/reference.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - Firebird/InterBase &Functions; - - &reference.ibase.entities.functions; - - - - - diff --git a/reference/ibase/setup.xml b/reference/ibase/setup.xml deleted file mode 100644 index 7d28d3885250..000000000000 --- a/reference/ibase/setup.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - - - &reftitle.setup; - - - &reference.ibase.configure; - - - - &reference.ibase.ini; - - - - - - diff --git a/reference/ibase/versions.xml b/reference/ibase/versions.xml deleted file mode 100644 index a5f838430d0e..000000000000 --- a/reference/ibase/versions.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/ibm_db2/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/ibm_db2/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/ibm_db2/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/ibm_db2/book.xml b/reference/ibm_db2/book.xml deleted file mode 100644 index cc530f2fae3a..000000000000 --- a/reference/ibm_db2/book.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - IBM DB2, Cloudscape and Apache Derby - IBM DB2 - - - - &reftitle.intro; - - These functions enable you to access IBM DB2 Universal Database, IBM - Cloudscape, and Apache Derby databases using the DB2 Call Level Interface - (DB2 CLI). - - - - - &reference.ibm-db2.setup; - &reference.ibm-db2.constants; - &reference.ibm-db2.reference; - - - diff --git a/reference/ibm_db2/configure.xml b/reference/ibm_db2/configure.xml deleted file mode 100644 index 0535af0587c5..000000000000 --- a/reference/ibm_db2/configure.xml +++ /dev/null @@ -1,74 +0,0 @@ - - -
- &reftitle.install; - - To build the ibm_db2 extension, the DB2 application development header files - and libraries must be installed on the system. - DB2 does not install these by default, so it may be necessary to return to the - DB2 installer and add this option. - The DB2 Application Development Client includes the header files and is freely - available for download from the IBM DB2 Universal Database - support site. - - - If the DB2 application development header files and libraries are added to a - Linux or Unix operating system on which DB2 was already installed, the command - db2iupdt -e must be issued to update the symbolic links to - the header files and libraries in the DB2 instances. - - - ibm_db2 is a &link.pecl; extension, so follow the instructions in - to install the ibm_db2 extension for PHP. - Issue the configure command to point to the location of - the DB2 header files and libraries as follows: - - - - The configure command defaults to - /opt/IBM/db2/V8.1. - - - Note for IIS users - - If the ibm_db2 driver is being used with Microsoft Internet Information - Server (IIS), it may be necessary to do the following: - - - - Install DB2 with extended operating system security. - - - Add the PHP binary path to the PATH system environment variable (default C:\php\). - - - Create another system environment variable equal to the path where the PHP.INI file is located (eg: PHPRC = C:\php\). - - - Add the IUSR_COMPUTERNAME to the DB2USERS group. - - - -
- diff --git a/reference/ibm_db2/constants.xml b/reference/ibm_db2/constants.xml deleted file mode 100644 index 0b07fec93246..000000000000 --- a/reference/ibm_db2/constants.xml +++ /dev/null @@ -1,249 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - - - DB2_BINARY - (int) - - - - Specifies that binary data shall be returned as is. This is the default - mode. - - - - - - DB2_CONVERT - (int) - - - - Specifies that binary data shall be converted to a hexadecimal encoding - and returned as an ASCII string. - - - - - - DB2_PASSTHRU - (int) - - - - Specifies that binary data shall be converted to a &null; value. - - - - - - DB2_SCROLLABLE - (int) - - - - Specifies a scrollable cursor for a statement resource. This mode enables - random access to rows in a result set, but currently is supported only by - IBM DB2 Universal Database. - - - - - - DB2_FORWARD_ONLY - (int) - - - - Specifies a forward-only cursor for a statement resource. This is the - default cursor type and is supported on all database servers. - - - - - - DB2_PARAM_IN - (int) - - - - Specifies the PHP variable should be bound as an IN parameter for a - stored procedure. - - - - - - DB2_PARAM_OUT - (int) - - - - Specifies the PHP variable should be bound as an OUT parameter for a - stored procedure. - - - - - - DB2_PARAM_INOUT - (int) - - - - Specifies the PHP variable should be bound as an INOUT parameter for a - stored procedure. - - - - - - DB2_PARAM_FILE - (int) - - - - Specifies that the column should be bound directly to a file for input. - - - - - - DB2_AUTOCOMMIT_ON - (int) - - - - Specifies that autocommit should be turned on. - - - - - - DB2_AUTOCOMMIT_OFF - (int) - - - - Specifies that autocommit should be turned off. - - - - - - DB2_DOUBLE - (int) - - - - Specifies that the variable should be bound as a DOUBLE, FLOAT, or REAL - data type. - - - - - - DB2_LONG - (int) - - - - Specifies that the variable should be bound as a SMALLINT, INTEGER, or - BIGINT data type. - - - - - - DB2_CHAR - (int) - - - - Specifies that the variable should be bound as a CHAR or VARCHAR data type. - - - - - - DB2_CASE_NATURAL - (int) - - - - Specifies that column names will be returned in their natural case. - - - - - - DB2_CASE_LOWER - (int) - - - - Specifies that column names will be returned in lower case. - - - - - - DB2_CASE_UPPER - (int) - - - - Specifies that column names will be returned in upper case. - - - - - - DB2_DEFERRED_PREPARE_ON - (int) - - - - Specifies that deferred prepare should be turned on for the specified statement resource. - - - - - - DB2_DEFERRED_PREPARE_OFF - (int) - - - - Specifies that deferred prepare should be turned off for the specified statement resource. - - - - - - - diff --git a/reference/ibm_db2/functions/db2-autocommit.xml b/reference/ibm_db2/functions/db2-autocommit.xml deleted file mode 100644 index 526f3fe1f9cc..000000000000 --- a/reference/ibm_db2/functions/db2-autocommit.xml +++ /dev/null @@ -1,181 +0,0 @@ - - - - - db2_autocommit - - Returns or sets the AUTOCOMMIT state for a database connection - - - - &reftitle.description; - - intbooldb2_autocommit - resourceconnection - intvalue - - - - Sets or gets the AUTOCOMMIT behavior of the specified connection resource. - - - - - &reftitle.parameters; - - - connection - - - A valid database connection resource variable as returned from - db2_connect or db2_pconnect. - - - - - value - - - One of the following constants: - - - DB2_AUTOCOMMIT_OFF - - - Turns AUTOCOMMIT off. - - - - - DB2_AUTOCOMMIT_ON - - - Turns AUTOCOMMIT on. - - - - - - - - - - - &reftitle.returnvalues; - - When db2_autocommit receives only the - connection parameter, it returns the current state - of AUTOCOMMIT for the requested connection as an integer value. A value of - DB2_AUTOCOMMIT_OFF indicates that AUTOCOMMIT is off, - while a value of DB2_AUTOCOMMIT_ON indicates that - AUTOCOMMIT is on. - - - When db2_autocommit receives both the - connection parameter and - autocommit parameter, it attempts to set the - AUTOCOMMIT state of the requested connection to the corresponding state. - &return.success; - - - - - &reftitle.examples; - - - Retrieving the AUTOCOMMIT value for a connection - - In the following example, a connection which has been created with - AUTOCOMMIT turned off is tested with the - db2_autocommit function. - - - DB2_AUTOCOMMIT_OFF); -$conn = db2_connect($database, $user, $password, $options); -$ac = db2_autocommit($conn); -if ($ac == DB2_AUTOCOMMIT_OFF) { - print "$ac -- AUTOCOMMIT is off."; -} else { - print "$ac -- AUTOCOMMIT is on."; -} -?> -]]> - - &example.outputs; - - - - - - Setting the AUTOCOMMIT value for a connection - - In the following example, a connection which was initially created with - AUTOCOMMIT turned off has its behavior changed to turn AUTOCOMMIT on. - - - DB2_AUTOCOMMIT_OFF); -$conn = db2_connect($database, $user, $password, $options); - -// Turn AUTOCOMMIT on -$rc = db2_autocommit($conn, DB2_AUTOCOMMIT_ON); -if ($rc) { - print "Turning AUTOCOMMIT on succeeded.\n"; -} - -// Check AUTOCOMMIT state -$ac = db2_autocommit($conn); -if ($ac == DB2_AUTOCOMMIT_OFF) { - print "$ac -- AUTOCOMMIT is off."; -} else { - print "$ac -- AUTOCOMMIT is on."; -} -?> -]]> - - &example.outputs; - - - - - - - - - - &reftitle.seealso; - - db2_connect - db2_pconnect - - - - - diff --git a/reference/ibm_db2/functions/db2-bind-param.xml b/reference/ibm_db2/functions/db2-bind-param.xml deleted file mode 100644 index 58c2906f8e64..000000000000 --- a/reference/ibm_db2/functions/db2-bind-param.xml +++ /dev/null @@ -1,303 +0,0 @@ - - - - - db2_bind_param - - Binds a PHP variable to an SQL statement parameter - - - - &reftitle.description; - - booldb2_bind_param - resourcestmt - intparameter_number - stringvariable_name - intparameter_typeDB2_PARAM_IN - intdata_type0 - intprecision-1 - intscale0 - - - - Binds a PHP variable to an SQL statement parameter in a statement resource - returned by db2_prepare. This function gives you more - control over the parameter type, data type, precision, and scale for the - parameter than simply passing the variable as part of the optional input - array to db2_execute. - - - - - &reftitle.parameters; - - - stmt - - - A prepared statement returned from db2_prepare. - - - - - parameter_number - - - Specifies the 1-indexed position of the parameter in the prepared - statement. - - - - - variable_name - - - A string specifying the name of the PHP variable to bind to the - parameter specified by parameter_number. - - - - - parameter_type - - - A constant specifying whether the PHP variable should be bound to the - SQL parameter as an input parameter (DB2_PARAM_IN), - an output parameter (DB2_PARAM_OUT), or as a - parameter that accepts input and returns output - (DB2_PARAM_INOUT). To avoid memory overhead, you can - also specify DB2_PARAM_FILE to bind the PHP variable - to the name of a file that contains large object (BLOB, CLOB, or DBCLOB) - data. - - - - - data_type - - - A constant specifying the SQL data type that the PHP variable should be - bound as: one of DB2_BINARY, - DB2_CHAR, DB2_DOUBLE, or - DB2_LONG . - - - - - precision - - - Specifies the precision with which the variable should be bound to the - database. This parameter can also be used for retrieving XML output values - from stored procedures. A non-negative value specifies the maximum size of - the XML data that will be retrieved from the database. If this parameter - is not used, a default of 1MB will be assumed for retrieving the XML - output value from the stored procedure. - - - - - scale - - - Specifies the scale with which the variable should be bound to the - database. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Binding PHP variables to a prepared statement - - The SQL statement in the following example uses two input parameters in - the WHERE clause. We call db2_bind_param to bind two - PHP variables to the corresponding SQL parameters. Notice that the PHP - variables do not have to be declared or assigned before the call to - db2_bind_param; in the example, - $lower_limit is assigned a value before the call to - db2_bind_param, but $upper_limit - is assigned a value after the call to - db2_bind_param. The variables must be bound and, for - parameters that accept input, must have any value assigned, before calling - db2_execute. - - - ? AND weight < ?'; -$conn = db2_connect($database, $user, $password); -$stmt = db2_prepare($conn, $sql); - -// We can declare the variable before calling db2_bind_param() -$lower_limit = 1; - -db2_bind_param($stmt, 1, "lower_limit", DB2_PARAM_IN); -db2_bind_param($stmt, 2, "upper_limit", DB2_PARAM_IN); - -// We can also declare the variable after calling db2_bind_param() -$upper_limit = 15.0; - -if (db2_execute($stmt)) { - while ($row = db2_fetch_array($stmt)) { - print "{$row[0]}, {$row[1]}, {$row[2]}\n"; - } -} -?> -]]> - - &example.outputs; - - - - - - Calling stored procedures with IN and OUT parameters - - The stored procedure match_animal in the following example accepts - three different parameters: - - - - an input (IN) parameter that accepts the name of the first animal as - input - - - - - an input-output (INOUT) parameter that accepts the name of the second - animal as input and returns the string TRUE if an - animal in the database matches that name - - - - - an output (OUT) parameter that returns the sum of the weight of the - two identified animals - - - - In addition, the stored procedure returns a result set consisting of the - animals listed in alphabetic order starting at the animal corresponding - to the input value of the first parameter and ending at the animal - corresponding to the input value of the second parameter. - - - -]]> - - &example.outputs; - - - - - - Inserting a binary large object (BLOB) directly from a file - - The data for large objects are typically stored in files, such as XML - documents or audio files. Rather than reading an entire file into a PHP - variable, and then binding that PHP variable into an SQL statement, you - can avoid some memory overhead by binding the file directly to the input - parameter of your SQL statement. The following example demonstrates how - to bind a file directly into a BLOB column. - - - -]]> - - - - - - - - &reftitle.seealso; - - db2_execute - db2_prepare - - - - - diff --git a/reference/ibm_db2/functions/db2-client-info.xml b/reference/ibm_db2/functions/db2-client-info.xml deleted file mode 100644 index 3528d77bd23e..000000000000 --- a/reference/ibm_db2/functions/db2-client-info.xml +++ /dev/null @@ -1,216 +0,0 @@ - - - - - db2_client_info - Returns an object with properties that describe the DB2 database client - - - &reftitle.description; - - stdClassfalsedb2_client_info - resourceconnection - - - - This function returns an object with read-only properties that return - information about the DB2 database client. The following table lists - the DB2 client properties: - - DB2 client properties - - - - Property name - Return type - Description - - - - - APPL_CODEPAGE - int - The application code page. - - - CONN_CODEPAGE - int - The code page for the current connection. - - - DATA_SOURCE_NAME - string - The data source name (DSN) used to create the current connection - to the database. - - - DRIVER_NAME - string - The name of the library that implements the DB2 Call - Level Interface (CLI) specification. - - - DRIVER_ODBC_VER - string - The version of ODBC that the DB2 client supports. This returns a - string "MM.mm" where MM is the major version and - mm is the minor version. The DB2 client always - returns "03.51". - - - - DRIVER_VER - string - The version of the client, in the form of a string "MM.mm.uuuu" where - MM is the major version, - mm is the minor version, - and uuuu is the update. For example, "08.02.0001" - represents major version 8, minor version 2, update 1. - - - - ODBC_SQL_CONFORMANCE - string - - The level of ODBC SQL grammar supported by the client: - - - MINIMUM - - - Supports the minimum ODBC SQL grammar. - - - - - CORE - - - Supports the core ODBC SQL grammar. - - - - - EXTENDED - - - Supports extended ODBC SQL grammar. - - - - - - - - - ODBC_VER - string - The version of ODBC that the ODBC driver manager supports. This - returns a string "MM.mm.rrrr" where MM is the major - version, mm is the minor version, and - rrrr is the release. The DB2 client always returns - "03.01.0000". - - - - -
-
- -
- - &reftitle.parameters; - - - connection - - - Specifies an active DB2 client connection. - - - - - - - &reftitle.returnvalues; - - Returns an object on a successful call,&return.falseforfailure; - - - - - &reftitle.examples; - - A <function>db2_client_info</function> example - - To retrieve information about the client, you must pass a valid - database connection resource to db2_client_info. - - -DRIVER_NAME ); - echo "DRIVER_VER: "; var_dump( $client->DRIVER_VER ); - echo "DATA_SOURCE_NAME: "; var_dump( $client->DATA_SOURCE_NAME ); - echo "DRIVER_ODBC_VER: "; var_dump( $client->DRIVER_ODBC_VER ); - echo "ODBC_VER: "; var_dump( $client->ODBC_VER ); - echo "ODBC_SQL_CONFORMANCE: "; var_dump( $client->ODBC_SQL_CONFORMANCE ); - echo "APPL_CODEPAGE: "; var_dump( $client->APPL_CODEPAGE ); - echo "CONN_CODEPAGE: "; var_dump( $client->CONN_CODEPAGE ); -} -else { - echo "Error retrieving client information. - Perhaps your database connection was invalid."; -} -db2_close($conn); - -?>]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - db2_server_info - - - - -
- diff --git a/reference/ibm_db2/functions/db2-close.xml b/reference/ibm_db2/functions/db2-close.xml deleted file mode 100644 index b8a3d7925e82..000000000000 --- a/reference/ibm_db2/functions/db2-close.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - db2_close - - Closes a database connection - - - - &reftitle.description; - - booldb2_close - resourceconnection - - - - This function closes a DB2 client connection created with - db2_connect and returns the corresponding - resources to the database server. - - - If you attempt to close a persistent DB2 client connection created with - db2_pconnect, the close request is ignored and the - persistent DB2 client connection remains available for the next caller. - - - - - &reftitle.parameters; - - - connection - - - Specifies an active DB2 client connection. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Closing a connection - - The following example demonstrates a successful attempt to close a - connection to an IBM DB2, Cloudscape, or Apache Derby database. - - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - db2_connect - db2_pclose - db2_pconnect - - - - - diff --git a/reference/ibm_db2/functions/db2-column-privileges.xml b/reference/ibm_db2/functions/db2-column-privileges.xml deleted file mode 100644 index c73f35844846..000000000000 --- a/reference/ibm_db2/functions/db2-column-privileges.xml +++ /dev/null @@ -1,169 +0,0 @@ - - - - - - db2_column_privileges - - Returns a result set listing the columns and associated privileges for a table - - - - &reftitle.description; - - resourcedb2_column_privileges - resourceconnection - stringnullqualifier&null; - stringnullschema&null; - stringnulltable_name&null; - stringnullcolumn_name&null; - - - - - Returns a result set listing the columns and associated privileges for a - table. - - - - - &reftitle.parameters; - - - connection - - - A valid connection to an IBM DB2, Cloudscape, or Apache Derby database. - - - - - qualifier - - - A qualifier for DB2 databases running on OS/390 or z/OS servers. For - other databases, pass &null; or an empty string. - - - - - schema - - - The schema which contains the tables. To match all schemas, pass &null; - or an empty string. - - - - - table_name - - - The name of the table or view. To match all tables in the database, - pass &null; or an empty string. - - - - - column_name - - - The name of the column. To match all columns in the table, pass &null; - or an empty string. - - - - - - - &reftitle.returnvalues; - - Returns a statement resource with a result set containing rows describing - the column privileges for columns matching the specified parameters. The - rows are composed of the following columns: - - - - - Column name - Description - - - - - TABLE_CAT - Name of the catalog. The value is NULL if this table does not - have catalogs. - - - TABLE_SCHEM - Name of the schema. - - - TABLE_NAME - Name of the table or view. - - - COLUMN_NAME - Name of the column. - - - GRANTOR - Authorization ID of the user who granted the privilege. - - - GRANTEE - Authorization ID of the user to whom the privilege was - granted. - - - PRIVILEGE - The privilege for the column. - - - IS_GRANTABLE - Whether the GRANTEE is permitted to grant this privilege to - other users. - - - - - - - - - &reftitle.seealso; - - db2_columns - db2_foreign_keys - db2_primary_keys - db2_procedure_columns - db2_procedures - db2_special_columns - db2_statistics - db2_table_privileges - db2_tables - - - - - diff --git a/reference/ibm_db2/functions/db2-columns.xml b/reference/ibm_db2/functions/db2-columns.xml deleted file mode 100644 index 2bd0482787a9..000000000000 --- a/reference/ibm_db2/functions/db2-columns.xml +++ /dev/null @@ -1,227 +0,0 @@ - - - - - - db2_columns - - Returns a result set listing the columns and associated metadata for a table - - - - &reftitle.description; - - resourcedb2_columns - resourceconnection - stringnullqualifier&null; - stringnullschema&null; - stringnulltable_name&null; - stringnullcolumn_name&null; - - - - Returns a result set listing the columns and associated metadata for a - table. - - - - - &reftitle.parameters; - - - connection - - - A valid connection to an IBM DB2, Cloudscape, or Apache Derby database. - - - - - qualifier - - - A qualifier for DB2 databases running on OS/390 or z/OS servers. For - other databases, pass &null; or an empty string. - - - - - schema - - - The schema which contains the tables. To match all schemas, pass - '%'. - - - - - table_name - - - The name of the table or view. To match all tables in the database, - pass &null; or an empty string. - - - - - column_name - - - The name of the column. To match all columns in the table, pass &null; - or an empty string. - - - - - - - &reftitle.returnvalues; - - Returns a statement resource with a result set containing rows describing - the columns matching the specified parameters. The rows are composed of - the following columns: - - - - - Column name - Description - - - - - TABLE_CAT - Name of the catalog. The value is NULL if this table does not - have catalogs. - - - TABLE_SCHEM - Name of the schema. - - - TABLE_NAME - Name of the table or view. - - - COLUMN_NAME - Name of the column. - - - DATA_TYPE - The SQL data type for the column represented as an integer value. - - - TYPE_NAME - A string representing the data type for the column. - - - COLUMN_SIZE - An integer value representing the size of the column. - - - BUFFER_LENGTH - - Maximum number of bytes necessary to store data from this column. - - - - DECIMAL_DIGITS - - The scale of the column, or &null; where scale is not applicable. - - - - NUM_PREC_RADIX - - An integer value of either 10 (representing - an exact numeric data type), 2 (representing an - approximate numeric data type), or &null; (representing a data type for - which radix is not applicable). - - - - NULLABLE - An integer value representing whether the column is nullable or - not. - - - REMARKS - Description of the column. - - - COLUMN_DEF - Default value for the column. - - - SQL_DATA_TYPE - An integer value representing the size of the column. - - - SQL_DATETIME_SUB - - Returns an integer value representing a datetime subtype code, - or &null; for SQL data types to which this does not apply. - - - - CHAR_OCTET_LENGTH - - Maximum length in octets for a character data type column, which - matches COLUMN_SIZE for single-byte character set data, or &null; for - non-character data types. - - - - ORDINAL_POSITION - The 1-indexed position of the column in the table. - - - IS_NULLABLE - - A string value where 'YES' means that the column is nullable and - 'NO' means that the column is not nullable. - - - - - - - - - - - &reftitle.seealso; - - db2_column_privileges - db2_foreign_keys - db2_primary_keys - db2_procedure_columns - db2_procedures - db2_special_columns - db2_statistics - db2_table_privileges - db2_tables - - - - - diff --git a/reference/ibm_db2/functions/db2-commit.xml b/reference/ibm_db2/functions/db2-commit.xml deleted file mode 100644 index a1907bc65b12..000000000000 --- a/reference/ibm_db2/functions/db2-commit.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - db2_commit - - Commits a transaction - - - - &reftitle.description; - - booldb2_commit - resourceconnection - - - - - Commits an in-progress transaction on the specified connection resource and - begins a new transaction. PHP applications normally default to AUTOCOMMIT - mode, so db2_commit is not necessary unless AUTOCOMMIT - has been turned off for the connection resource. - - - - - &reftitle.parameters; - - - connection - - - A valid database connection resource variable as returned from - db2_connect or db2_pconnect. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - db2_autocommit - db2_rollback - - - - - diff --git a/reference/ibm_db2/functions/db2-conn-error.xml b/reference/ibm_db2/functions/db2-conn-error.xml deleted file mode 100644 index 467a06a13acb..000000000000 --- a/reference/ibm_db2/functions/db2-conn-error.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - db2_conn_error - - Returns a string containing the SQLSTATE returned by the last connection attempt - - - - &reftitle.description; - - stringdb2_conn_error - resourcenullconnection&null; - - - - - db2_conn_error returns an SQLSTATE value representing - the reason the last attempt to connect to a database failed. As - db2_connect returns &false; in the event of a failed - connection attempt, you do not pass any parameters to - db2_conn_error to retrieve the SQLSTATE value. - - - If, however, the connection was successful but becomes invalid over time, - you can pass the connection parameter to retrieve - the SQLSTATE value for a specific connection. - - - To learn what the SQLSTATE value means, you can issue the following command - at a DB2 Command Line Processor prompt: - db2 '? sqlstate-value'. You - can also call db2_conn_errormsg to retrieve an - explicit error message and the associated SQLCODE value. - - - - &reftitle.parameters; - - - connection - - - A connection resource associated with a connection that initially - succeeded, but which over time became invalid. - - - - - - - &reftitle.returnvalues; - - Returns the SQLSTATE value resulting from a failed connection attempt. - Returns an empty string if there is no error associated with the last - connection attempt. - - - - - &reftitle.examples; - - Retrieving an SQLSTATE value for a failed connection attempt - - The following example demonstrates how to return an SQLSTATE value - after deliberately passing invalid parameters to - db2_connect. - - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - db2_conn_errormsg - db2_connect - db2_stmt_error - db2_stmt_errormsg - - - - - - diff --git a/reference/ibm_db2/functions/db2-conn-errormsg.xml b/reference/ibm_db2/functions/db2-conn-errormsg.xml deleted file mode 100644 index 898e98534080..000000000000 --- a/reference/ibm_db2/functions/db2-conn-errormsg.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - db2_conn_errormsg - - Returns the last connection error message and SQLCODE value - - - - &reftitle.description; - - stringdb2_conn_errormsg - resourcenullconnection&null; - - - - db2_conn_errormsg returns an error message and SQLCODE - value representing the reason the last database connection attempt failed. - As db2_connect returns &false; in the event of a failed - connection attempt, do not pass any parameters to - db2_conn_errormsg to retrieve the associated error - message and SQLCODE value. - - - If, however, the connection was successful but becomes invalid over time, - you can pass the connection parameter to retrieve - the associated error message and SQLCODE value for a specific connection. - - - - &reftitle.parameters; - - - connection - - - A connection resource associated with a connection that initially - succeeded, but which over time became invalid. - - - - - - - &reftitle.returnvalues; - - Returns a string containing the error message and SQLCODE value resulting - from a failed connection attempt. If there is no error associated with the last - connection attempt, db2_conn_errormsg returns an empty - string. - - - - - &reftitle.examples; - - Retrieving the error message returned by a failed connection attempt - - The following example demonstrates how to return an error message and - SQLCODE value after deliberately passing invalid parameters to - db2_connect. - - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - db2_conn_error - db2_connect - db2_stmt_error - db2_stmt_errormsg - - - - - diff --git a/reference/ibm_db2/functions/db2-connect.xml b/reference/ibm_db2/functions/db2-connect.xml deleted file mode 100644 index 45b2878e829c..000000000000 --- a/reference/ibm_db2/functions/db2-connect.xml +++ /dev/null @@ -1,706 +0,0 @@ - - - - - - db2_connect - - Returns a connection to a database - - - - &reftitle.description; - - resourcefalsedb2_connect - stringdatabase - stringnullusername - stringnullpassword - arrayoptions[] - - - - Creates a new connection to an IBM DB2 Universal Database, IBM Cloudscape, - or Apache Derby database. - - - - - &reftitle.parameters; - - - database - - - For a cataloged connection to a database, database - represents the database alias in the DB2 client catalog. - - - For an uncataloged connection to a database, - database represents a complete connection - string in the following format: - DATABASE=database;HOSTNAME=hostname;PORT=port;PROTOCOL=TCPIP;UID=username;PWD=password; - - - When connecting to Db2 on IBM i, the underlying system calls - SQLDriverConnect, - which only accepts DSN, UID, and PWD for the - connection string. - Like so: - DSN=database;UID=username;PWD=password; - - - where the parameters represent the following values: - - - database - - - The name of the database. - - - - - hostname - - - The hostname or IP address of the database server. - - - - - port - - - The TCP/IP port on which the database is listening for - requests. - - - - - username - - - The username with which you are connecting to the - database. - - - - - password - - - The password with which you are connecting to the database. - - - - - - - - - username - - - The username with which you are connecting to the database. - - - For uncataloged connections, you must pass a &null; value or empty - string. - - - - - password - - - The password with which you are connecting to the database. - - - For uncataloged connections, you must pass a &null; value or empty - string. - - - - - options - - - An associative array of connection options that affect the behavior - of the connection, where valid array keys include: - - - autocommit - - - Passing the DB2_AUTOCOMMIT_ON value turns - autocommit on for this connection handle. - - - Passing the DB2_AUTOCOMMIT_OFF value turns - autocommit off for this connection handle. - - - - - DB2_ATTR_CASE - - - Passing the DB2_CASE_NATURAL value specifies - that column names are returned in natural case. - - - Passing the DB2_CASE_LOWER value specifies - that column names are returned in lower case. - - - Passing the DB2_CASE_UPPER value specifies - that column names are returned in upper case. - - - - - CURSOR - - - Passing the DB2_FORWARD_ONLY value specifies a - forward-only cursor for a statement resource. This is the default - cursor type and is supported on all database servers. - - - Passing the DB2_SCROLLABLE value specifies a - scrollable cursor for a statement resource. This mode enables - random access to rows in a result set, but currently is supported - only by IBM DB2 Universal Database. - - - - - - - The following new option is available in ibm_db2 version 1.7.0 and later. - - - trustedcontext - - - Passing the DB2_TRUSTED_CONTEXT_ENABLE value turns trusted context - on for this connection handle. This parameter cannot be set using - db2_set_option. - - - This key works only if the database is cataloged (even if the - database is local), or if you specify the full DSN when you create - the connection. - - - To catalog the database, use following commands: - - db2 catalog tcpip node loopback remote <SERVERNAME> server <SERVICENAME> -db2 catalog database <LOCALDBNAME> as <REMOTEDBNAME> at node loopback -db2 "update dbm cfg using svcename <SERVICENAME>" -db2set DB2COMM=TCPIP - - - - - - The following new i5/OS options are available in ibm_db2 version 1.5.1 - and later. - - - i5_lib - - - A character value that indicates the default library that will be - used for resolving unqualified file references. This is not valid - if the connection is using system naming mode. - - - - - i5_naming - - - DB2_I5_NAMING_ON value turns on DB2 UDB CLI iSeries - system naming mode. Files are qualified using the slash (/) delimiter. - Unqualified files are resolved using the library list for the job. - - - DB2_I5_NAMING_OFF value turns off DB2 UDB CLI default - naming mode, which is SQL naming. Files are qualified using the period (.) - delimiter. Unqualified files are resolved using either the default library - or the current user ID. - - - - - i5_commit - - - The i5_commit attribute should be set before the - db2_connect. If the value is changed after the - connection has been established, and the connection is to a remote data - source, the change does not take effect until the next successful - db2_connect for the connection handle. - - - The php.ini setting ibm_db2.i5_allow_commit==0 - or DB2_I5_TXN_NO_COMMIT is the default, but may be - overridden with the i5_commit option. - - - - - DB2_I5_TXN_NO_COMMIT - Commitment control is not used. - - - DB2_I5_TXN_READ_UNCOMMITTED - Dirty reads, nonrepeatable - reads, and phantoms are possible. - - - DB2_I5_TXN_READ_COMMITTED - Dirty reads are not possible. - Nonrepeatable reads, and phantoms are possible. - - - DB2_I5_TXN_REPEATABLE_READ - Dirty reads and nonrepeatable - reads are not possible. Phantoms are possible. - - - DB2_I5_TXN_SERIALIZABLE - Transactions are serializable. - Dirty reads, non-repeatable reads, and phantoms are not possible - - - - - i5_query_optimize - - - DB2_FIRST_IO All queries are optimized with the goal of - returning the first page of output as fast as possible. This goal works well - when the output is controlled by a user who is most likely to cancel the query - after viewing the first page of output data. Queries coded with an - OPTIMIZE FOR nnn ROWS clause honor the goal specified by the clause. - - - DB2_ALL_IO All queries are optimized with the goal of running - the entire query to completion in the shortest amount of elapsed time. This is a - good option when the output of a query is being written to a file or report, or - the interface is queuing the output data. Queries coded with an OPTIMIZE FOR nnn - ROWS clause honor the goal specified by the clause. This is the default. - - - - - i5_dbcs_alloc - - - DB2_I5_DBCS_ALLOC_ON value turns on DB2 6X allocation scheme - for DBCS translation column size growth. - - - DB2_I5_DBCS_ALLOC_OFF value turns off DB2 6X allocation scheme - for DBCS translation column size growth. - - - Note: php.ini setting ibm_db2.i5_dbcs_alloc==0 or - DB2_I5_DBCS_ALLOC_OFF is the default, but may be overridden - with the i5_dbcs_alloc option. - - - - - i5_date_fmt - - - DB2_I5_FMT_ISO - The International Organization for Standardization - (ISO) date format yyyy-mm-dd is used. This is the default. - - - DB2_I5_FMT_USA - The United States date format mm/dd/yyyy is used. - - - DB2_I5_FMT_EUR - The European date format dd.mm.yyyy is used. - - - DB2_I5_FMT_JIS - The Japanese Industrial Standard date format - yyyy-mm-dd is used. - - - DB2_I5_FMT_MDY - The date format mm/dd/yyyy is used. - - - DB2_I5_FMT_DMY - The date format dd/mm/yyyy is used. - - - DB2_I5_FMT_YMD - The date format yy/mm/dd is used. - - - DB2_I5_FMT_JUL - The Julian date format yy/ddd is used. - - - DB2_I5_FMT_JOB - The job default is used. - - - - - i5_date_sep - - - DB2_I5_SEP_SLASH - A slash ( / ) is used as the date separator. - This is the default. - - - DB2_I5_SEP_DASH - A dash ( - ) is used as the date separator. - - - DB2_I5_SEP_PERIOD - A period ( . ) is used as the date - separator. - - - DB2_I5_SEP_COMMA - A comma ( , ) is used as the date separator. - - - DB2_I5_SEP_BLANK - A blank is used as the date separator. - - - DB2_I5_SEP_JOB - The job default is used - - - - - i5_time_fmt - - - DB2_I5_FMT_ISO - The International Organization for - Standardization (ISO) time format hh.mm.ss is used. This is the default. - - - DB2_I5_FMT_USA - The United States time format - hh:mmxx is used, where xx is AM or PM. - - - DB2_I5_FMT_EUR - The European time format hh.mm.ss - is used. - - - DB2_I5_FMT_JIS - The Japanese Industrial Standard - time format hh:mm:ss is used. - - - DB2_I5_FMT_HMS - The hh:mm:ss format is used. - - - - - i5_time_sep - - - DB2_I5_SEP_COLON - A colon ( : ) is used as the time - separator. This is the default. - - - DB2_I5_SEP_PERIOD - A period ( . ) is used as the time - separator. - - - DB2_I5_SEP_COMMA - A comma ( , ) is used as the time - separator. - - - DB2_I5_SEP_BLANK - A blank is used as the time separator. - - - DB2_I5_SEP_JOB - The job default is used. - - - - - i5_decimal_sep - - - DB2_I5_SEP_PERIOD - A period ( . ) is used as - the decimal separator. This is the default. - - - DB2_I5_SEP_COMMA - A comma ( , ) is used as the - decimal separator. - - - DB2_I5_SEP_JOB - The job default is used. - - - - - - - The following new i5/OS option is available in ibm_db2 version 1.8.0 - and later. - - - i5_libl - - - A character value that indicates the library list that will be used for - resolving unqualified file references. Specify the library list - elements separated by blanks 'i5_libl'=>"MYLIB YOURLIB ANYLIB". - - - - i5_libl calls qsys2/qcmdexc('cmd',cmdlen), which is only - available in i5/OS V5R4 and later. - - - - - - - - - - - - &reftitle.returnvalues; - - Returns a connection handle resource if the connection attempt is - successful. If the connection attempt fails, db2_connect - returns &false;. - - - - - &reftitle.examples; - - - Creating a cataloged connection - - Cataloged connections require you to have previously cataloged the target - database through the DB2 Command Line Processor (CLP) or DB2 - Configuration Assistant. - - - -]]> - - &example.outputs; - - - - - - Creating an uncataloged connection - - An uncataloged connection enables you to dynamically connect to a - database. - - - -]]> - - &example.outputs; - - - - - - Creating a connection with autocommit off by default - - Passing an array of options to db2_connect enables - you to modify the default behavior of the connection handle. - - - DB2_AUTOCOMMIT_OFF); - -$conn = db2_connect($database, $user, $password, $options); - -if ($conn) { - echo "Connection succeeded.\n"; - if (db2_autocommit($conn)) { - echo "Autocommit is on.\n"; - } - else { - echo "Autocommit is off.\n"; - } - db2_close($conn); -} -else { - echo "Connection failed."; -} -?> -]]> - - &example.outputs; - - - - - - i5/OS best performance - - To achieve best performance for your i5/OS ibm_db2 1.5.1 PHP application - use the default host, userid, and password for your - db2_connect. - - -"qsys2")); - $result = db2_exec($i5, - "select * from systables where table_schema = '$library'"); - while ($row = db2_fetch_both($result)) { - echo $row['TABLE_NAME']."
"; - } - db2_close($i5); -?> -]]> -
- &example.outputs; - - - -
- - Using trusted context - - The following example shows how to enable trusted context, switch - users, and get the current user ID. - - - DB2_TRUSTED_CONTEXT_ENABLE); - -$tc_conn = db2_connect($dsn, "", "", $options); -if($tc_conn) { - echo "Explicit trusted connection succeeded.\n"; - - if(db2_get_option($tc_conn, "trustedcontext")) { - $userBefore = db2_get_option($tc_conn, "trusted_user"); - - //Do some work as user 1. - - //Switching to trusted user. - $parameters = array("trusted_user" => $tc_user, - "trusted_password" => $tcuser_pass); - $res = db2_set_option ($tc_conn, $parameters, 1); - - $userAfter = db2_get_option($tc_conn, "trusted_user"); - //Do more work as trusted user. - - if($userBefore != $userAfter) { - echo "User has been switched." . "\n"; - } - } - - db2_close($tc_conn); -} -else { - echo "Explicit trusted connection failed.\n"; -} -?> - -]]> - - &example.outputs; - - - - -
-
- - - &reftitle.seealso; - - db2_close - db2_pconnect - - - - -
- diff --git a/reference/ibm_db2/functions/db2-cursor-type.xml b/reference/ibm_db2/functions/db2-cursor-type.xml deleted file mode 100644 index 2872d2d9fc6e..000000000000 --- a/reference/ibm_db2/functions/db2-cursor-type.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - db2_cursor_type - - Returns the cursor type used by a statement resource - - - - &reftitle.description; - - intdb2_cursor_type - resourcestmt - - - - Returns the cursor type used by a statement resource. Use this to determine - if you are working with a forward-only cursor or scrollable cursor. - - - - - &reftitle.parameters; - - - stmt - - - A valid statement resource. - - - - - - - &reftitle.returnvalues; - - Returns either DB2_FORWARD_ONLY if the statement - resource uses a forward-only cursor or DB2_SCROLLABLE if - the statement resource uses a scrollable cursor. - - - - - &reftitle.seealso; - - db2_prepare - - - - - diff --git a/reference/ibm_db2/functions/db2-escape-string.xml b/reference/ibm_db2/functions/db2-escape-string.xml deleted file mode 100644 index ed64760d92c4..000000000000 --- a/reference/ibm_db2/functions/db2-escape-string.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - db2_escape_string - - Used to escape certain characters - - - - - &reftitle.description; - - stringdb2_escape_string - stringstring_literal - - - Prepends backslashes to special characters in the string argument. - - - - - &reftitle.parameters; - - - string_literal - - - The string that contains special characters that need to be modified. - Characters that are prepended with a backslash are \x00, - \n, \r, \, - ', " and \x1a. - - - - - - - - &reftitle.returnvalues; - - Returns string_literal with the special characters - noted above prepended with backslashes. - - - - - &reftitle.examples; - - A <function>db2_escape_string</function> example - - Result of using the db2_escape_string function - - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - db2_prepare - - - - - diff --git a/reference/ibm_db2/functions/db2-exec.xml b/reference/ibm_db2/functions/db2-exec.xml deleted file mode 100644 index c0c95ed6caf9..000000000000 --- a/reference/ibm_db2/functions/db2-exec.xml +++ /dev/null @@ -1,374 +0,0 @@ - - - - - - db2_exec - - Executes an SQL statement directly - - - - &reftitle.description; - - resourcefalsedb2_exec - resourceconnection - stringstatement - arrayoptions[] - - - - - Executes an SQL statement directly. - - - If you plan to interpolate PHP variables into the SQL statement, understand - that this is one of the more common security exposures. Consider calling - db2_prepare to prepare an SQL statement with parameter - markers for input values. Then you can call db2_execute - to pass in the input values and avoid SQL injection attacks. - - - If you plan to repeatedly issue the same SQL statement with different - parameters, consider calling db2_prepare and - db2_execute to enable the database server to reuse its - access plan and increase the efficiency of your database access. - - - - - &reftitle.parameters; - - - connection - - - A valid database connection resource variable as returned from - db2_connect or db2_pconnect. - - - - - statement - - - An SQL statement. The statement cannot contain any parameter markers. - - - - - options - - - An associative array containing statement options. You can use this - parameter to request a scrollable cursor on database servers that - support this functionality. - - - For a description of valid statement options, see - db2_set_option. - - - - - - - &reftitle.returnvalues; - - Returns a statement resource if the SQL statement was issued successfully, - or &false; if the database failed to execute the SQL statement. - - - - - &reftitle.examples; - - - Creating a table with <function>db2_exec</function> - - The following example uses db2_exec to issue a set - of DDL statements in the process of creating a table. - - - -]]> - - &example.outputs; - - - - - - - Executing a SELECT statement with a scrollable cursor - - The following example demonstrates how to request a scrollable cursor for - an SQL statement issued by db2_exec. - - - DB2_SCROLLABLE)); - while ($row = db2_fetch_array($stmt)) { - print "$row[0]\n"; - } -} -?> -]]> - - &example.outputs; - - - - - - Returning XML data as an SQL ResultSet - - The following example demonstrates how to work with documents stored - in a XML column using the SAMPLE database. Using some pretty simple - SQL/XML, this example returns some of the nodes in a XML document in - an SQL ResultSet format that most users are familiar with. - - -CID $row->NAME $row->PHONE\n"); -} -db2_close($conn); - -?> -]]> - - &example.outputs; - - - - - - Performing a "JOIN" with XML data - - The following example works with documents stored in 2 different - XML columns in the SAMPLE database. It creates 2 temporary - tables from the XML documents from 2 different columns and - returns an SQL ResultSet with information regarding shipping - status for the customer. - - -CID $row->NAME $row->PHONE $row->PONUM $row->STATUS\n"); -} - -db2_close($conn); - -?> -]]> - - &example.outputs; - - - - - - Returning SQL data as part of a larger XML document - - The following example works with a portion of the PRODUCT.DESCRIPTION - documents in the SAMPLE database. It creates a XML document containing - product description (XML data) and pricing info (SQL data). - - - { - for $prod in $doc/product - where $prod/description/price < 10.00 - order by $prod/description/price ascending - return( - { - $prod, - {$start} , - {$end} , - {$promo} - } - ) - } -\' passing by ref DESCRIPTION AS "doc", -PROMOSTART as "start", -PROMOEND as "end", -PROMOPRICE as "promo" -RETURNING SEQUENCE) -AS CLOB (32000)) -AS NEW_PRODUCT_INFO -FROM PRODUCT -WHERE PID = \'100-100-01\' -'; - -$stmt = db2_exec($conn, $query); - -while($row = db2_fetch_array($stmt)){ - printf("$row[0]\n"); -} -db2_close($conn); - -?> -]]> - - &example.outputs; - - - - - - Snow Shovel, Basic 22 inch -
Basic Snow Shovel, 22 inches wide, straight handle with D-Grip
- 9.99 - 1 kg -
-
- 2004-11-19 - 2004-12-19 - 7.25 -
- -]]> -
-
-
-
- - - - &reftitle.seealso; - - db2_execute - db2_prepare - - - - -
- diff --git a/reference/ibm_db2/functions/db2-execute.xml b/reference/ibm_db2/functions/db2-execute.xml deleted file mode 100644 index d145dd6cd3ab..000000000000 --- a/reference/ibm_db2/functions/db2-execute.xml +++ /dev/null @@ -1,369 +0,0 @@ - - - - - - db2_execute - - Executes a prepared SQL statement - - - - &reftitle.description; - - booldb2_execute - resourcestmt - arrayparameters[] - - - - - db2_execute executes an SQL statement that was - prepared by db2_prepare. - - - If the SQL statement returns a result set, for example, a SELECT statement - or a CALL to a stored procedure that returns one or more result sets, you - can retrieve a row as an array from the stmt resource - using db2_fetch_assoc, - db2_fetch_both, or - db2_fetch_array. Alternatively, you can use - db2_fetch_row to move the result set pointer to the - next row and fetch a column at a time from that row with - db2_result. - - - Refer to db2_prepare for a brief discussion of the - advantages of using db2_prepare and - db2_execute rather than db2_exec. - - - - - &reftitle.parameters; - - - stmt - - - A prepared statement returned from db2_prepare. - - - - - parameters - - - An array of input parameters matching any parameter markers contained - in the prepared statement. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Preparing and executing an SQL statement with parameter markers - - The following example prepares an INSERT statement that accepts four - parameter markers, then iterates over an array of arrays containing the - input values to be passed to db2_execute. - - - -]]> - - &example.outputs; - - - - - - Calling a stored procedure with an OUT parameter - - The following example prepares a CALL statement that accepts one - parameter marker representing an OUT parameter, binds the PHP variable - $my_pets to the parameter using - db2_bind_param, then issues - db2_execute to execute the CALL statement. After the - CALL to the stored procedure has been made, the value of - $num_pets changes to reflect the value returned by the - stored procedure for that OUT parameter. - - - -]]> - - &example.outputs; - - - - - - Returning XML data as an SQL ResultSet - - The following example demonstrates how to work with documents stored - in a XML column using the SAMPLE database. Using some pretty simple - SQL/XML, this example returns some of the nodes in a XML document in - an SQL ResultSet format that most users are familiar with. - - -CID $row->NAME $row->PHONE\n"); - } -} -db2_close($conn); - -?> -]]> - - &example.outputs; - - - - - - Performing a "JOIN" with XML data - - The following example works with documents stored in 2 different - XML columns in the SAMPLE database. It creates 2 temporary - tables from the XML documents from 2 different columns and - returns an SQL ResultSet with information regarding shipping - status for the customer. - - -CID $row->NAME $row->PHONE $row->PONUM $row->STATUS\n"); - } -} - -db2_close($conn); - -?> -]]> - - &example.outputs; - - - - - - Returning SQL data as part of a larger XML document - - The following example works with a portion of the PRODUCT.DESCRIPTION - documents in the SAMPLE database. It creates a XML document containing - product description (XML data) and pricing info (SQL data). - - - { - for $prod in $doc/product - where $prod/description/price < 10.00 - order by $prod/description/price ascending - return( - { - $prod, - {$start} , - {$end} , - {$promo} - } - ) - } -\' passing by ref DESCRIPTION AS "doc", -PROMOSTART as "start", -PROMOEND as "end", -PROMOPRICE as "promo" -RETURNING SEQUENCE) -AS CLOB (32000)) -AS NEW_PRODUCT_INFO -FROM PRODUCT -WHERE PID = ? -'; - -$stmt = db2_prepare($conn, $query); - -$pid = "100-100-01"; - -if ($stmt) { - db2_bind_param($stmt, 1, "pid", DB2_PARAM_IN); - db2_execute($stmt); - - while($row = db2_fetch_array($stmt)){ - printf("$row[0]\n"); - } -} - -db2_close($conn); - -?> -]]> - - &example.outputs; - - - - - - Snow Shovel, Basic 22 inch -
Basic Snow Shovel, 22 inches wide, straight handle with D-Grip
- 9.99 - 1 kg -
-
- 2004-11-19 - 2004-12-19 - 7.25 -
- -]]> -
-
-
-
- - - &reftitle.seealso; - - db2_exec - db2_fetch_array - db2_fetch_assoc - db2_fetch_both - db2_fetch_row - db2_prepare - db2_result - - - - -
- diff --git a/reference/ibm_db2/functions/db2-fetch-array.xml b/reference/ibm_db2/functions/db2-fetch-array.xml deleted file mode 100644 index b720cf733c27..000000000000 --- a/reference/ibm_db2/functions/db2-fetch-array.xml +++ /dev/null @@ -1,161 +0,0 @@ - - - - - - db2_fetch_array - - Returns an array, indexed by column position, representing a row in a result set - - - - &reftitle.description; - - arrayfalsedb2_fetch_array - resourcestmt - introw_number-1 - - - - - Returns an array, indexed by column position, representing a row in a result - set. The columns are 0-indexed. - - - - - &reftitle.parameters; - - - stmt - - - A valid stmt resource containing a result set. - - - - - row_number - - - Requests a specific 1-indexed row from the result set. Passing this - parameter results in a PHP warning if the result set uses a - forward-only cursor. - - - - - - - &reftitle.returnvalues; - - Returns a 0-indexed array with column values indexed by the column position - representing the next or requested row in the result set. Returns &false; if - there are no rows left in the result set, or if the row requested by - row_number does not exist in the result set. - - - - - &reftitle.examples; - - - Iterating through a forward-only cursor - - If you call db2_fetch_array without a specific row - number, it automatically retrieves the next row in the result set. - - - -]]> - - &example.outputs; - - - - - - - Retrieving specific rows with <function>db2_fetch_array</function> - from a scrollable cursor - - If your result set uses a scrollable cursor, you can call - db2_fetch_array with a specific row number. The - following example retrieves every other row in the result set, starting - with the second row. - - - DB2_SCROLLABLE)); - -$i=2; -while ($row = db2_fetch_array($result, $i)) { - printf ("%-5d %-16s %-32s %10s\n", - $row[0], $row[1], $row[2], $row[3]); - $i = $i + 2; -} -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - db2_fetch_assoc - db2_fetch_both - db2_fetch_object - db2_fetch_row - db2_result - - - - - diff --git a/reference/ibm_db2/functions/db2-fetch-assoc.xml b/reference/ibm_db2/functions/db2-fetch-assoc.xml deleted file mode 100644 index d7e5ccc45e20..000000000000 --- a/reference/ibm_db2/functions/db2-fetch-assoc.xml +++ /dev/null @@ -1,161 +0,0 @@ - - - - - - db2_fetch_assoc - - Returns an array, indexed by column name, representing a row in a result set - - - - &reftitle.description; - - arrayfalsedb2_fetch_assoc - resourcestmt - introw_number-1 - - - - - Returns an array, indexed by column name, representing a row in a result - set. - - - - - &reftitle.parameters; - - - stmt - - - A valid stmt resource containing a result set. - - - - - row_number - - - Requests a specific 1-indexed row from the result set. Passing this - parameter results in a PHP warning if the result set uses a - forward-only cursor. - - - - - - - &reftitle.returnvalues; - - Returns an associative array with column values indexed by the column name - representing the next or requested row in the result set. Returns &false; if - there are no rows left in the result set, or if the row requested by - row_number does not exist in the result set. - - - - - &reftitle.examples; - - - Iterating through a forward-only cursor - - If you call db2_fetch_assoc without a specific row - number, it automatically retrieves the next row in the result set. - - - -]]> - - &example.outputs; - - - - - - - Retrieving specific rows with <function>db2_fetch_assoc</function> - from a scrollable cursor - - If your result set uses a scrollable cursor, you can call - db2_fetch_assoc with a specific row number. The - following example retrieves every other row in the result set, starting - with the second row. - - - DB2_SCROLLABLE)); - -$i=2; -while ($row = db2_fetch_assoc($result, $i)) { - printf ("%-5d %-16s %-32s %10s\n", - $row['ID'], $row['NAME'], $row['BREED'], $row['WEIGHT']); - $i = $i + 2; -} -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - db2_fetch_array - db2_fetch_both - db2_fetch_object - db2_fetch_row - db2_result - - - - - diff --git a/reference/ibm_db2/functions/db2-fetch-both.xml b/reference/ibm_db2/functions/db2-fetch-both.xml deleted file mode 100644 index cbc76b787c69..000000000000 --- a/reference/ibm_db2/functions/db2-fetch-both.xml +++ /dev/null @@ -1,169 +0,0 @@ - - - - - - db2_fetch_both - - Returns an array, indexed by both column name and position, representing a row in a result set - - - - &reftitle.description; - - arrayfalsedb2_fetch_both - resourcestmt - introw_number-1 - - - - - Returns an array, indexed by both column name and position, representing a - row in a result set. Note that the row returned by - db2_fetch_both requires more memory than the - single-indexed arrays returned by db2_fetch_assoc or - db2_fetch_array. - - - - - &reftitle.parameters; - - - stmt - - - A valid stmt resource containing a result set. - - - - - row_number - - - Requests a specific 1-indexed row from the result set. Passing this - parameter results in a PHP warning if the result set uses a - forward-only cursor. - - - - - - - &reftitle.returnvalues; - - Returns an associative array with column values indexed by both the column - name and 0-indexed column number. The array represents the next or - requested row in the result set. Returns &false; if there are no rows left - in the result set, or if the row requested by - row_number does not exist in the result set. - - - - - &reftitle.examples; - - - Iterating through a forward-only cursor - - If you call db2_fetch_both without a specific row - number, it automatically retrieves the next row in the result set. The - following example accesses columns in the returned array by both column - name and by numeric index. - - - -]]> - - &example.outputs; - - - - - - - Retrieving specific rows with <function>db2_fetch_both</function> - from a scrollable cursor - - If your result set uses a scrollable cursor, you can call - db2_fetch_both with a specific row number. The - following example retrieves every other row in the result set, starting - with the second row. - - - DB2_SCROLLABLE)); - -$i=2; -while ($row = db2_fetch_both($result, $i)) { - printf ("%-5d %-16s %-32s %10s\n", - $row[0], $row['NAME'], $row[2], $row['WEIGHT']); - $i = $i + 2; -} -?> -]]> - - &example.outputs; - - - - - - - - - - &reftitle.seealso; - - db2_fetch_array - db2_fetch_assoc - db2_fetch_object - db2_fetch_row - db2_result - - - - - - diff --git a/reference/ibm_db2/functions/db2-fetch-object.xml b/reference/ibm_db2/functions/db2-fetch-object.xml deleted file mode 100644 index 783e35ee781d..000000000000 --- a/reference/ibm_db2/functions/db2-fetch-object.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - db2_fetch_object - - Returns an object with properties representing columns in the fetched row - - - - &reftitle.description; - - stdClassfalsedb2_fetch_object - resourcestmt - introw_number-1 - - - - - Returns an object in which each property represents a column returned in - the row fetched from a result set. - - - - - &reftitle.parameters; - - - stmt - - - A valid stmt resource containing a result set. - - - - - row_number - - - Requests a specific 1-indexed row from the result set. Passing this - parameter results in a PHP warning if the result set uses a - forward-only cursor. - - - - - - - &reftitle.returnvalues; - - Returns an object representing a single row in the result set. The - properties of the object map to the names of the columns in the result set. - - - The IBM DB2, Cloudscape, and Apache Derby database servers typically fold - column names to upper-case, so the object properties will reflect that case. - - - If your SELECT statement calls a scalar function to modify the value - of a column, the database servers return the column number as the name of - the column in the result set. If you prefer a more descriptive column name - and object property, you can use the AS clause to assign a name to the - column in the result set. - - - Returns &false; if no row was retrieved. - - - - - &reftitle.examples; - - A <function>db2_fetch_object</function> example - - The following example issues a SELECT statement with a scalar function, - RTRIM, that removes whitespace from the end of the column. Rather than - creating an object with the properties "BREED" and "2", we use the AS - clause in the SELECT statement to assign the name "name" to the modified - column. The database server folds the column names to upper-case, - resulting in an object with the properties "BREED" and "NAME". - - -NAME}, my little {$pet->BREED}!"; - } - db2_close($conn); -} -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - db2_fetch_array - db2_fetch_assoc - db2_fetch_both - db2_fetch_row - db2_result - - - - - - diff --git a/reference/ibm_db2/functions/db2-fetch-row.xml b/reference/ibm_db2/functions/db2-fetch-row.xml deleted file mode 100644 index a29e69f8c3a8..000000000000 --- a/reference/ibm_db2/functions/db2-fetch-row.xml +++ /dev/null @@ -1,182 +0,0 @@ - - - - - - db2_fetch_row - - Sets the result set pointer to the next row or requested row - - - - &reftitle.description; - - booldb2_fetch_row - resourcestmt - introw_number-1 - - - - - Use db2_fetch_row to iterate through a result set, or - to point to a specific row in a result set if you requested a scrollable - cursor. - - - To retrieve individual fields from the result set, call the - db2_result function. - - - Rather than calling db2_fetch_row and - db2_result, most applications will call one of - db2_fetch_assoc, db2_fetch_both, - or db2_fetch_array to advance the result set pointer - and return a complete row as an array. - - - - - &reftitle.parameters; - - - stmt - - - A valid stmt resource. - - - - - row_number - - - With scrollable cursors, you can request a specific row number in the - result set. Row numbering is 1-indexed. - - - - - - - &reftitle.returnvalues; - - Returns &true; if the requested row exists in the result set. Returns - &false; if the requested row does not exist in the result set. - - - - - &reftitle.examples; - - - Iterating through a result set - - The following example demonstrates how to iterate through a result set - with db2_fetch_row and retrieve columns from the - result set with db2_result. - - - -]]> - - &example.outputs; - - - - - - i5/OS recommended alternatives to db2_fetch_row/db2_result - - On i5/OS it is recommended that you use db2_fetch_both, - db2_fetch_array, or db2_fetch_object - over db2_fetch_row/db2_result. In general - db2_fetch_row/db2_result have more issues - with various column types in EBCDIC to ASCII - translation, including possible truncation in DBCS applications. - You may also find the performance of db2_fetch_both, - db2_fetch_array, and db2_fetch_object to - be superior to db2_fetch_row/db2_result. - - - DB2_SCROLLABLE)); - while ($row = db2_fetch_both($stmt)){ - echo "
db2_fetch_both {$row['SPECIFIC_NAME']} {$row['ROUTINE_CREATED']} {$row[5]}"; - } - $stmt = db2_exec($conn, $sql, array('cursor' => DB2_SCROLLABLE)); - while ($row = db2_fetch_array($stmt)){ - echo "
db2_fetch_array {$row[1]} {$row[5]}"; - } - $stmt = db2_exec($conn, $sql, array('cursor' => DB2_SCROLLABLE)); - while ($row = db2_fetch_object($stmt)){ - echo "
db2_fetch_object {$row->SPECIFIC_NAME} {$row->ROUTINE_CREATED}"; - } - db2_close($conn); -?> -]]> -
- &example.outputs; - - - -
-
-
- - - &reftitle.seealso; - - db2_fetch_array - db2_fetch_assoc - db2_fetch_both - db2_fetch_object - db2_result - - - -
- diff --git a/reference/ibm_db2/functions/db2-field-display-size.xml b/reference/ibm_db2/functions/db2-field-display-size.xml deleted file mode 100644 index 37425165dc65..000000000000 --- a/reference/ibm_db2/functions/db2-field-display-size.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - db2_field_display_size - - Returns the maximum number of bytes required to display a column - - - - &reftitle.description; - - intfalsedb2_field_display_size - resourcestmt - intstringcolumn - - - - Returns the maximum number of bytes required to display a column in a - result set. - - - - - &reftitle.parameters; - - - stmt - - - Specifies a statement resource containing a result set. - - - - - column - - - Specifies the column in the result set. This can either be an integer - representing the 0-indexed position of the column, or a string - containing the name of the column. - - - - - - - &reftitle.returnvalues; - - Returns an integer value with the maximum number of bytes required to - display the specified column. If the column does not exist in the result - set, db2_field_display_size returns &false;. - - - - - &reftitle.seealso; - - db2_field_name - db2_field_num - db2_field_precision - db2_field_scale - db2_field_type - db2_field_width - - - - - - diff --git a/reference/ibm_db2/functions/db2-field-name.xml b/reference/ibm_db2/functions/db2-field-name.xml deleted file mode 100644 index d2454835de96..000000000000 --- a/reference/ibm_db2/functions/db2-field-name.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - db2_field_name - - Returns the name of the column in the result set - - - - &reftitle.description; - - stringfalsedb2_field_name - resourcestmt - intstringcolumn - - - - Returns the name of the specified column in the result set. - - - - - &reftitle.parameters; - - - stmt - - - Specifies a statement resource containing a result set. - - - - - column - - - Specifies the column in the result set. This can either be an integer - representing the 0-indexed position of the column, or a string - containing the name of the column. - - - - - - - &reftitle.returnvalues; - - Returns a string containing the name of the specified column. If the - specified column does not exist in the result - set, db2_field_name returns &false;. - - - - - &reftitle.seealso; - - db2_field_display_size - db2_field_num - db2_field_precision - db2_field_scale - db2_field_type - db2_field_width - - - - - - diff --git a/reference/ibm_db2/functions/db2-field-num.xml b/reference/ibm_db2/functions/db2-field-num.xml deleted file mode 100644 index 2f78d34c09b8..000000000000 --- a/reference/ibm_db2/functions/db2-field-num.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - db2_field_num - - Returns the position of the named column in a result set - - - - &reftitle.description; - - intfalsedb2_field_num - resourcestmt - intstringcolumn - - - - Returns the position of the named column in a result set. - - - - - &reftitle.parameters; - - - stmt - - - Specifies a statement resource containing a result set. - - - - - column - - - Specifies the column in the result set. This can either be an integer - representing the 0-indexed position of the column, or a string - containing the name of the column. - - - - - - - &reftitle.returnvalues; - - Returns an integer containing the 0-indexed position of the named column in - the result set. If the specified column does not exist in the result set, - db2_field_num returns &false;. - - - - - &reftitle.seealso; - - db2_field_display_size - db2_field_name - db2_field_precision - db2_field_scale - db2_field_type - db2_field_width - - - - - diff --git a/reference/ibm_db2/functions/db2-field-precision.xml b/reference/ibm_db2/functions/db2-field-precision.xml deleted file mode 100644 index a7ce2d299652..000000000000 --- a/reference/ibm_db2/functions/db2-field-precision.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - db2_field_precision - - Returns the precision of the indicated column in a result set - - - - &reftitle.description; - - intfalsedb2_field_precision - resourcestmt - intstringcolumn - - - - Returns the precision of the indicated column in a result set. - - - - - &reftitle.parameters; - - - stmt - - - Specifies a statement resource containing a result set. - - - - - column - - - Specifies the column in the result set. This can either be an integer - representing the 0-indexed position of the column, or a string - containing the name of the column. - - - - - - - &reftitle.returnvalues; - - Returns an integer containing the precision of the specified column. If the - specified column does not exist in the result set, - db2_field_precision returns &false;. - - - - - &reftitle.seealso; - - db2_field_display_size - db2_field_name - db2_field_num - db2_field_scale - db2_field_type - db2_field_width - - - - - diff --git a/reference/ibm_db2/functions/db2-field-scale.xml b/reference/ibm_db2/functions/db2-field-scale.xml deleted file mode 100644 index c2c83c01136c..000000000000 --- a/reference/ibm_db2/functions/db2-field-scale.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - db2_field_scale - - Returns the scale of the indicated column in a result set - - - - &reftitle.description; - - intfalsedb2_field_scale - resourcestmt - intstringcolumn - - - - Returns the scale of the indicated column in a result set. - - - - - &reftitle.parameters; - - - stmt - - - Specifies a statement resource containing a result set. - - - - - column - - - Specifies the column in the result set. This can either be an integer - representing the 0-indexed position of the column, or a string - containing the name of the column. - - - - - - - &reftitle.returnvalues; - - Returns an integer containing the scale of the specified column. If the - specified column does not exist in the result set, - db2_field_scale returns &false;. - - - - - &reftitle.seealso; - - db2_field_display_size - db2_field_name - db2_field_num - db2_field_precision - db2_field_type - db2_field_width - - - - - diff --git a/reference/ibm_db2/functions/db2-field-type.xml b/reference/ibm_db2/functions/db2-field-type.xml deleted file mode 100644 index 19ff45449119..000000000000 --- a/reference/ibm_db2/functions/db2-field-type.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - db2_field_type - - Returns the data type of the indicated column in a result set - - - - &reftitle.description; - - stringfalsedb2_field_type - resourcestmt - intstringcolumn - - - - Returns the data type of the indicated column in a result set. - - - - - &reftitle.parameters; - - - stmt - - - Specifies a statement resource containing a result set. - - - - - column - - - Specifies the column in the result set. This can either be an integer - representing the 0-indexed position of the column, or a string - containing the name of the column. - - - - - - - &reftitle.returnvalues; - - Returns a string containing the defined data type of the specified column. - If the specified column does not exist in the result set, - db2_field_type returns &false;. - - - - - &reftitle.seealso; - - db2_field_display_size - db2_field_name - db2_field_num - db2_field_precision - db2_field_scale - db2_field_width - - - - - diff --git a/reference/ibm_db2/functions/db2-field-width.xml b/reference/ibm_db2/functions/db2-field-width.xml deleted file mode 100644 index 0ca85466b0f9..000000000000 --- a/reference/ibm_db2/functions/db2-field-width.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - db2_field_width - - Returns the width of the current value of the indicated column in a result set - - - - &reftitle.description; - - intfalsedb2_field_width - resourcestmt - intstringcolumn - - - - Returns the width of the current value of the indicated column in a result - set. This is the maximum width of the column for a fixed-length data type, - or the actual width of the column for a variable-length data type. - - - - - &reftitle.parameters; - - - stmt - - - Specifies a statement resource containing a result set. - - - - - column - - - Specifies the column in the result set. This can either be an integer - representing the 0-indexed position of the column, or a string - containing the name of the column. - - - - - - - &reftitle.returnvalues; - - Returns an integer containing the width of the specified character or - binary data type column in a result set. If the specified column does not - exist in the result set, db2_field_width returns - &false;. - - - - - &reftitle.seealso; - - db2_field_display_size - db2_field_name - db2_field_num - db2_field_precision - db2_field_scale - db2_field_type - - - - - diff --git a/reference/ibm_db2/functions/db2-foreign-keys.xml b/reference/ibm_db2/functions/db2-foreign-keys.xml deleted file mode 100644 index 86dc07fcd323..000000000000 --- a/reference/ibm_db2/functions/db2-foreign-keys.xml +++ /dev/null @@ -1,200 +0,0 @@ - - - - - - db2_foreign_keys - - Returns a result set listing the foreign keys for a table - - - - &reftitle.description; - - resourcedb2_foreign_keys - resourceconnection - stringnullqualifier - stringnullschema - stringtable_name - - - - - Returns a result set listing the foreign keys for a table. - - - - - &reftitle.parameters; - - - connection - - - A valid connection to an IBM DB2, Cloudscape, or Apache Derby database. - - - - - qualifier - - - A qualifier for DB2 databases running on OS/390 or z/OS servers. For - other databases, pass &null; or an empty string. - - - - - schema - - - The schema which contains the tables. If schema - is &null;, db2_foreign_keys matches the schema for - the current connection. - - - - - table_name - - - The name of the table. - - - - - - - &reftitle.returnvalues; - - Returns a statement resource with a result set containing rows describing - the foreign keys for the specified table. The result set is composed of the - following columns: - - - - - Column name - Description - - - - - PKTABLE_CAT - - Name of the catalog for the table containing the primary key. The - value is NULL if this table does not have catalogs. - - - - PKTABLE_SCHEM - - Name of the schema for the table containing the primary key. - - - - PKTABLE_NAME - Name of the table containing the primary key. - - - PKCOLUMN_NAME - Name of the column containing the primary key. - - - FKTABLE_CAT - - Name of the catalog for the table containing the foreign key. The - value is NULL if this table does not have catalogs. - - - - FKTABLE_SCHEM - - Name of the schema for the table containing the foreign key. - - - - FKTABLE_NAME - Name of the table containing the foreign key. - - - FKCOLUMN_NAME - Name of the column containing the foreign key. - - - KEY_SEQ - 1-indexed position of the column in the key. - - - UPDATE_RULE - - Integer value representing the action applied to the foreign key - when the SQL operation is UPDATE. - - - - DELETE_RULE - - Integer value representing the action applied to the foreign key - when the SQL operation is DELETE. - - - - FK_NAME - The name of the foreign key. - - - PK_NAME - The name of the primary key. - - - DEFERRABILITY - - An integer value representing whether the foreign key deferrability is - SQL_INITIALLY_DEFERRED, SQL_INITIALLY_IMMEDIATE, or - SQL_NOT_DEFERRABLE. - - - - - - - - - - - &reftitle.seealso; - - db2_column_privileges - db2_columns - db2_primary_keys - db2_procedure_columns - db2_procedures - db2_special_columns - db2_statistics - db2_table_privileges - db2_tables - - - - - diff --git a/reference/ibm_db2/functions/db2-free-result.xml b/reference/ibm_db2/functions/db2-free-result.xml deleted file mode 100644 index 5793021d2e93..000000000000 --- a/reference/ibm_db2/functions/db2-free-result.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - db2_free_result - - Frees resources associated with a result set - - - - &reftitle.description; - - booldb2_free_result - resourcestmt - - - - Frees the system and database resources that are associated with a result - set. These resources are freed implicitly when a script finishes, but you - can call db2_free_result to explicitly free the result - set resources before the end of the script. - - - - - &reftitle.parameters; - - - stmt - - - A valid statement resource. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - db2_free_stmt - - - - - diff --git a/reference/ibm_db2/functions/db2-free-stmt.xml b/reference/ibm_db2/functions/db2-free-stmt.xml deleted file mode 100644 index 9e66645d95e5..000000000000 --- a/reference/ibm_db2/functions/db2-free-stmt.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - db2_free_stmt - - Frees resources associated with the indicated statement resource - - - - &reftitle.description; - - booldb2_free_stmt - resourcestmt - - - - - Frees the system and database resources that are associated with a statement - resource. These resources are freed implicitly when a script finishes, but - you can call db2_free_stmt to explicitly free the - statement resources before the end of the script. - - - - - &reftitle.parameters; - - - stmt - - - A valid statement resource. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - db2_free_result - - - - - diff --git a/reference/ibm_db2/functions/db2-get-option.xml b/reference/ibm_db2/functions/db2-get-option.xml deleted file mode 100644 index 84285976777b..000000000000 --- a/reference/ibm_db2/functions/db2-get-option.xml +++ /dev/null @@ -1,311 +0,0 @@ - - - - - db2_get_option - Retrieves an option value for a statement resource or a connection resource - - - - &reftitle.description; - - stringfalsedb2_get_option - resourceresource - stringoption - - - Retrieves the value of a specified option value for a statement resource - or a connection resource. - - - - - &reftitle.parameters; - - - resource - - - A valid statement resource as returned from - db2_prepare or a valid connection resource as - returned from db2_connect or - db2_pconnect. - - - - - option - - - A valid statement or connection options. The following new options are available - as of ibm_db2 version 1.6.0. They provide useful tracking information - that can be set during execution with db2_get_option. - - - Prior versions of ibm_db2 do not support these new options. - - - When the value in each option is being set, some servers might not handle - the entire length provided and might truncate the value. - - - To ensure that the data specified in each option is converted correctly - when transmitted to a host system, use only the characters A through Z, - 0 through 9, and the underscore (_) or period (.). - - - - - userid - - - SQL_ATTR_INFO_USERID - A pointer to a null-terminated - character string used to identify the client user ID sent to the host - database server when using DB2 Connect. - - - DB2 for z/OS and OS/390 servers support up to a length of 16 characters. - This user-id is not to be confused with the authentication user-id, it is for - identification purposes only and is not used for any authorization. - - - - - - - acctstr - - - SQL_ATTR_INFO_ACCTSTR - A pointer to a null-terminated - character string used to identify the client accounting string sent to the - host database server when using DB2 Connect. - - - DB2 for z/OS and OS/390 servers support up to a length of 200 characters. - - - - - - - applname - - - SQL_ATTR_INFO_APPLNAME - A pointer to a null-terminated - character string used to identify the client application name sent to the - host database server when using DB2 Connect. - - - DB2 for z/OS and OS/390 servers support up to a length of 32 characters. - - - - - - - wrkstnname - - - SQL_ATTR_INFO_WRKSTNNAME - A pointer to a null-terminated - character string used to identify the client workstation name sent to the - host database server when using DB2 Connect. - - - DB2 for z/OS and OS/390 servers support up to a length of 18 characters. - - - - - - - - - - - - The following table specifies which options are compatible with - the available resource types: - - Resource-Parameter Matrix - - - - - - - - - Key - Value - Resource Type - - - - - Connection - Statement - Result Set - - - userid - SQL_ATTR_INFO_USERID - X - X - - - - - acctstr - SQL_ATTR_INFO_ACCTSTR - X - X - - - - - applname - SQL_ATTR_INFO_APPLNAME - X - X - - - - - wrkstnname - SQL_ATTR_INFO_WRKSTNNAME - X - X - - - - - -
-
-
- - - &reftitle.returnvalues; - - Returns the current setting of the connection attribute provided on success - &return.falseforfailure;. - - - - - &reftitle.examples; - - Setting and retrieving parameters through a connection resource - - 'db2inst1'); -$conn1 = db2_connect($database, $user, $password, $options1); -$val = db2_get_option($conn1, 'userid'); -echo $val . "\n"; - -$options2 = array('acctstr' => 'account'); -$conn2 = db2_connect($database, $user, $password, $options2); -$val = db2_get_option($conn2, 'acctstr'); -echo $val . "\n"; - -$options3 = array('applname' => 'myapp'); -$conn3 = db2_connect($database, $user, $password, $options3); -$val = db2_get_option($conn3, 'applname'); -echo $val . "\n"; - -$options4 = array('wrkstnname' => 'workstation'); -$conn4 = db2_connect($database, $user, $password, $options4); -$val = db2_get_option($conn4, 'wrkstnname'); -echo $val . "\n"; - -echo "Client attributes passed post-connection:\n"; - -/* Create the associative options array with valid key-value pairs */ -/* Assign the attributes after a connection is made */ -/* Access the options specified */ -$options5 = array('userid' => 'db2inst1'); -$conn5 = db2_connect($database, $user, $password); -$rc = db2_set_option($conn5, $options5, 1); -$val = db2_get_option($conn5, 'userid'); -echo $val . "\n"; - -$options6 = array('acctstr' => 'account'); -$conn6 = db2_connect($database, $user, $password); -$rc = db2_set_option($conn6, $options6, 1); -$val = db2_get_option($conn6, 'acctstr'); -echo $val . "\n"; - -$options7 = array('applname' => 'myapp'); -$conn7 = db2_connect($database, $user, $password); -$rc = db2_set_option($conn7, $options7, 1); -$val = db2_get_option($conn7, 'applname'); -echo $val . "\n"; - -$options8 = array('wrkstnname' => 'workstation'); -$conn8 = db2_connect($database, $user, $password); -$rc = db2_set_option($conn8, $options8, 1); -$val = db2_get_option($conn8, 'wrkstnname'); -echo $val . "\n"; -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - db2_connect - db2_cursor_type - db2_exec - db2_set_option - db2_pconnect - db2_prepare - - - -
- diff --git a/reference/ibm_db2/functions/db2-last-insert-id.xml b/reference/ibm_db2/functions/db2-last-insert-id.xml deleted file mode 100644 index 011248f0100b..000000000000 --- a/reference/ibm_db2/functions/db2-last-insert-id.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - db2_last_insert_id - Returns the auto generated ID of the last insert query that successfully - executed on this connection - - - - &reftitle.description; - - stringnulldb2_last_insert_id - resourceresource - - - Returns the auto generated ID of the last insert query that successfully - executed on this connection. - - - The result of this function is not affected by any of the following: - - - - A single row INSERT statement with a VALUES clause for a table without an identity column. - - - - - A multiple row INSERT statement with a VALUES clause. - - - - - An INSERT statement with a fullselect. - - - - - A ROLLBACK TO SAVEPOINT statement. - - - - - - - - &reftitle.parameters; - - - resource - - - A valid connection resource as returned from db2_connect - or db2_pconnect. The value of this parameter cannot be a - statement resource or result set resource. - - - - - - - - &reftitle.returnvalues; - - Returns the auto generated ID of last insert query that successfully - executed on this connection. - - - - - &reftitle.examples; - - A <function>db2_last_insert_id</function> example - - The following example shows how to return the - auto generated ID of last insert query that successfully - executed on this connection. - - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/ibm_db2/functions/db2-lob-read.xml b/reference/ibm_db2/functions/db2-lob-read.xml deleted file mode 100644 index d5a6c173b72e..000000000000 --- a/reference/ibm_db2/functions/db2-lob-read.xml +++ /dev/null @@ -1,189 +0,0 @@ - - - - - - db2_lob_read - - Gets a user defined size of LOB files with each invocation - - - - - &reftitle.description; - - stringfalsedb2_lob_read - resourcestmt - intcolnum - intlength - - - Use db2_lob_read to iterate through a specified column of - a result set and retrieve a user defined size of LOB data. - - - - - &reftitle.parameters; - - - stmt - - - A valid stmt resource containing LOB data. - - - - - colnum - - - A valid column number in the result set of the stmt resource. - - - - - length - - - The size of the LOB data to be retrieved from the stmt resource. - - - - - - - - &reftitle.returnvalues; - - Returns the amount of data the user specifies. Returns - &false; if the data cannot be retrieved. - - - - - &reftitle.examples; - - Iterating through different types of data - - - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - db2_bind_param - db2_exec - db2_execute - db2_fetch_row - db2_prepare - db2_result - - - - - diff --git a/reference/ibm_db2/functions/db2-next-result.xml b/reference/ibm_db2/functions/db2-next-result.xml deleted file mode 100644 index 8a35b6d1bfd8..000000000000 --- a/reference/ibm_db2/functions/db2-next-result.xml +++ /dev/null @@ -1,171 +0,0 @@ - - - - - - db2_next_result - - Requests the next result set from a stored procedure - - - - &reftitle.description; - - resourcefalsedb2_next_result - resourcestmt - - - - - A stored procedure can return zero or more result sets. While you handle - the first result set in exactly the same way you would handle the results - returned by a simple SELECT statement, to fetch the second and subsequent - result sets from a stored procedure you must call the - db2_next_result function and return the result to a - uniquely named PHP variable. - - - - - &reftitle.parameters; - - - stmt - - - A prepared statement returned from db2_exec or - db2_execute. - - - - - - - &reftitle.returnvalues; - - Returns a new statement resource containing the next result set if the - stored procedure returned another result set. Returns &false; if the stored - procedure did not return another result set. - - - - - &reftitle.examples; - - Calling a stored procedure that returns multiple result sets - - In the following example, we call a stored procedure that returns three - result sets. The first result set is fetched directly from the same - statement resource on which we invoked the CALL statement, while the - second and third result sets are fetched from statement resources - returned from our calls to the db2_next_result - function. - - - -]]> - - &example.outputs; - - - string(16) "Bubbles " - [1]=> - int(3) -} -array(2) { - [0]=> - string(16) "Gizmo " - [1]=> - int(4) -} - -Fetching second result set -array(4) { - [0]=> - string(16) "Sweater " - [1]=> - int(6) - [2]=> - string(5) "llama" - [3]=> - string(6) "150.00" -} -array(4) { - [0]=> - string(16) "Smarty " - [1]=> - int(2) - [2]=> - string(5) "horse" - [3]=> - string(6) "350.00" -} - -Fetching third result set -array(1) { - [0]=> - string(16) "Bubbles " -} -array(1) { - [0]=> - string(16) "Gizmo " -} -]]> - - - - - - diff --git a/reference/ibm_db2/functions/db2-num-fields.xml b/reference/ibm_db2/functions/db2-num-fields.xml deleted file mode 100644 index 57f8d4633a23..000000000000 --- a/reference/ibm_db2/functions/db2-num-fields.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - db2_num_fields - - Returns the number of fields contained in a result set - - - - &reftitle.description; - - intfalsedb2_num_fields - resourcestmt - - - - - Returns the number of fields contained in a result set. This is most useful - for handling the result sets returned by dynamically generated queries, or - for result sets returned by stored procedures, where your application cannot - otherwise know how to retrieve and use the results. - - - - - &reftitle.parameters; - - - stmt - - - A valid statement resource containing a result set. - - - - - - - &reftitle.returnvalues; - - Returns an integer value representing the number of fields in the result - set associated with the specified statement resource. Returns &false; if - the statement resource is not a valid input value. - - - - - &reftitle.examples; - - Retrieving the number of fields in a result set - - The following example demonstrates how to retrieve the number of fields - returned in a result set. - - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - db2_execute - db2_field_display_size - db2_field_name - db2_field_num - db2_field_precision - db2_field_scale - db2_field_type - db2_field_width - - - - - diff --git a/reference/ibm_db2/functions/db2-num-rows.xml b/reference/ibm_db2/functions/db2-num-rows.xml deleted file mode 100644 index 7a42a5d9c1a0..000000000000 --- a/reference/ibm_db2/functions/db2-num-rows.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - db2_num_rows - - Returns the number of rows affected by an SQL statement - - - - &reftitle.description; - - intfalsedb2_num_rows - resourcestmt - - - - - Returns the number of rows deleted, inserted, or updated by an SQL - statement. - - - To determine the number of rows that will be returned by a SELECT - statement, issue SELECT COUNT(*) with the same predicates as your - intended SELECT statement and retrieve the value. - - - If your application logic checks the number of rows returned by a SELECT - statement and branches if the number of rows is 0, consider modifying your - application to attempt to return the first row with one of - db2_fetch_assoc, db2_fetch_both, - db2_fetch_array, or db2_fetch_row, - and branch if the fetch function returns &false;. - - - - - If you issue a SELECT statement using a scrollable cursor, - db2_num_rows returns the number of rows returned by - the SELECT statement. However, the overhead associated with scrollable - cursors significantly degrades the performance of your application, so if - this is the only reason you are considering using scrollable cursors, - you should use a forward-only cursor and either call SELECT COUNT(*) or - rely on the bool return value of the fetch functions to - achieve the equivalent functionality with much better performance. - - - - - - &reftitle.parameters; - - - stmt - - - A valid stmt resource containing a result set. - - - - - - - &reftitle.returnvalues; - - Returns the number of rows affected by the last SQL statement issued by - the specified statement handle,&return.falseforfailure; - - - - - diff --git a/reference/ibm_db2/functions/db2-pclose.xml b/reference/ibm_db2/functions/db2-pclose.xml deleted file mode 100644 index ddfe051cef3e..000000000000 --- a/reference/ibm_db2/functions/db2-pclose.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - db2_pclose - Closes a persistent database connection - - - - &reftitle.description; - - booldb2_pclose - resourceconnection - - - This function closes a DB2 client connection created with - db2_pconnect and returns the corresponding resources - to the database server. - - - This function is only available on i5/OS in response to i5/OS system - administration requests. - - - - - If you have a persistent DB2 client connection created with - db2_pconnect, you may use this function to close the - connection. To avoid substantial connection performance penalties, this - function should only be used in rare cases when the persistent connection - has become unresponsive or the persistent connection will not be needed for - a long period of time. - - - - - &reftitle.parameters; - - - connection - - - Specifies an active DB2 client connection. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Closing a persistent connection - - The following example demonstrates a successful attempt to close a - connection to an IBM DB2 i5/OS database. - - - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - db2_close - db2_pconnect - - - - - diff --git a/reference/ibm_db2/functions/db2-pconnect.xml b/reference/ibm_db2/functions/db2-pconnect.xml deleted file mode 100644 index 33d30e0f73be..000000000000 --- a/reference/ibm_db2/functions/db2-pconnect.xml +++ /dev/null @@ -1,686 +0,0 @@ - - - - - - db2_pconnect - - Returns a persistent connection to a database - - - - &reftitle.description; - - resourcefalsedb2_pconnect - stringdatabase - stringnullusername - stringnullpassword - arrayoptions[] - - - - - Returns a persistent connection to an IBM DB2 Universal Database, IBM - Cloudscape, or Apache Derby database. - - - - For more information on persistent - connections, refer to . - - - - Calling db2_close on a persistent connection always - returns &true;, but the underlying DB2 client connection remains open and - waiting to serve the next matching db2_pconnect - request. - - - - Users running version 1.9.0 or later of ibm_db2 should be aware that the - extension will perform a transaction rollback on persistent connections at - the end of a request, thus ending the transaction. This prevents the - transaction block from carrying over to the next request which uses that - connection if script execution ends before the transaction block does. - - - - - &reftitle.parameters; - - - database - - - For a cataloged connection to a database, database - represents the database alias in the DB2 client catalog. - - - For an uncataloged connection to a database, - database represents a complete connection - string in the following format: - DATABASE=database;HOSTNAME=hostname;PORT=port;PROTOCOL=TCPIP;UID=username;PWD=password; - - - When connecting to Db2 on IBM i, the underlying system calls - SQLDriverConnect, - which only accepts DSN, UID, and PWD for the - connection string. - Like so: - DSN=database;UID=username;PWD=password; - - - where the parameters represent the following values: - - - database - - - The name of the database. - - - - - hostname - - - The hostname or IP address of the database server. - - - - - port - - - The TCP/IP port on which the database is listening for - requests. - - - - - username - - - The username with which you are connecting to the - database. - - - - - password - - - The password with which you are connecting to the database. - - - - - - - - - username - - - The username with which you are connecting to the database. - - - - - password - - - The password with which you are connecting to the database. - - - - - options - - - An associative array of connection options that affect the behavior - of the connection, where valid array keys include: - - - autocommit - - - Passing the DB2_AUTOCOMMIT_ON value turns - autocommit on for this connection handle. - - - Passing the DB2_AUTOCOMMIT_OFF value turns - autocommit off for this connection handle. - - - - - DB2_ATTR_CASE - - - Passing the DB2_CASE_NATURAL value specifies - that column names are returned in natural case. - - - Passing the DB2_CASE_LOWER value specifies - that column names are returned in lower case. - - - Passing the DB2_CASE_UPPER value specifies - that column names are returned in upper case. - - - - - CURSOR - - - Passing the DB2_FORWARD_ONLY value specifies a - forward-only cursor for a statement resource. This is the default - cursor type and is supported on all database servers. - - - Passing the DB2_SCROLLABLE value specifies a - scrollable cursor for a statement resource. This mode enables - random access to rows in a result set, but currently is supported - only by IBM DB2 Universal Database. - - - - - - - The following new option is available in ibm_db2 version 1.7.0 - and later. - - - trustedcontext - - - Passing the DB2_TRUSTED_CONTEXT_ENABLE value turns trusted context - on for this connection handle. This parameter cannot be set using - db2_set_option. - - - This key works only if the database is cataloged (even if the - database is local), or if you specify the full DSN when you create - the connection. - - - To catalog the database, use following commands: - - db2 catalog tcpip node loopback remote <SERVERNAME> server <SERVICENAME> -db2 catalog database <LOCALDBNAME> as <REMOTEDBNAME> at node loopback -db2 "update dbm cfg using svcename <SERVICENAME>" -db2set DB2COMM=TCPIP - - - - - - - The following new i5/OS options are available in ibm_db2 version 1.5.1 - and later. - - Conflicting connection attributes used in conjunction with persistent - connections can produce indeterminate results on i5/OS. Site policies should - be establish for all applications using each persistent connection user - profile. The default DB2_AUTOCOMMIT_ON is suggested when using persistent connections. - - - - - i5_lib - - - A character value that indicates the default library that will be - used for resolving unqualified file references. This is not valid - if the connection is using system naming mode. - - - - - i5_naming - - - DB2_I5_NAMING_ON value turns on DB2 UDB CLI iSeries - system naming mode. Files are qualified using the slash (/) delimiter. - Unqualified files are resolved using the library list for the job. - - - DB2_I5_NAMING_OFF value turns off DB2 UDB CLI default - naming mode, which is SQL naming. Files are qualified using the period (.) - delimiter. Unqualified files are resolved using either the default library - or the current user ID. - - - - - i5_commit - - - The i5_commit attribute should be set before the - db2_pconnect. If the value is changed after the - connection has been established, and the connection is to a remote data - source, the change does not take effect until the next successful - db2_pconnect for the connection handle. - - - The php.ini setting ibm_db2.i5_allow_commit==0 - or DB2_I5_TXN_NO_COMMIT is the default, but may be - overridden with the i5_commit option. - - - - - DB2_I5_TXN_NO_COMMIT - Commitment control is not used. - - - DB2_I5_TXN_READ_UNCOMMITTED - Dirty reads, nonrepeatable - reads, and phantoms are possible. - - - DB2_I5_TXN_READ_COMMITTED - Dirty reads are not possible. - Nonrepeatable reads, and phantoms are possible. - - - DB2_I5_TXN_REPEATABLE_READ - Dirty reads and nonrepeatable - reads are not possible. Phantoms are possible. - - - DB2_I5_TXN_SERIALIZABLE - Transactions are serializable. - Dirty reads, non-repeatable reads, and phantoms are not possible - - - - - i5_query_optimize - - - DB2_FIRST_IO All queries are optimized with the goal of - returning the first page of output as fast as possible. This goal works well - when the output is controlled by a user who is most likely to cancel the query - after viewing the first page of output data. Queries coded with an - OPTIMIZE FOR nnn ROWS clause honor the goal specified by the clause. - - - DB2_ALL_IO All queries are optimized with the goal of running - the entire query to completion in the shortest amount of elapsed time. This is a - good option when the output of a query is being written to a file or report, or - the interface is queuing the output data. Queries coded with an OPTIMIZE FOR nnn - ROWS clause honor the goal specified by the clause. This is the default. - - - - - i5_dbcs_alloc - - - DB2_I5_DBCS_ALLOC_ON value turns on DB2 6X allocation scheme - for DBCS translation column size growth. - - - DB2_I5_DBCS_ALLOC_OFF value turns off DB2 6X allocation scheme - for DBCS translation column size growth. - - - The php.ini setting ibm_db2.i5_dbcs_alloc==0 or - DB2_I5_DBCS_ALLOC_OFF is the default, but may be overridden - with the i5_dbcs_alloc option. - - - - - - - i5_date_fmt - - - DB2_I5_FMT_ISO - The International Organization for Standardization - (ISO) date format yyyy-mm-dd is used. This is the default. - - - DB2_I5_FMT_USA - The United States date format mm/dd/yyyy is used. - - - DB2_I5_FMT_EUR - The European date format dd.mm.yyyy is used. - - - DB2_I5_FMT_JIS - The Japanese Industrial Standard date format - yyyy-mm-dd is used. - - - DB2_I5_FMT_MDY - The date format mm/dd/yyyy is used. - - - DB2_I5_FMT_DMY - The date format dd/mm/yyyy is used. - - - DB2_I5_FMT_YMD - The date format yy/mm/dd is used. - - - DB2_I5_FMT_JUL - The Julian date format yy/ddd is used. - - - DB2_I5_FMT_JOB - The job default is used. - - - - - i5_date_sep - - - DB2_I5_SEP_SLASH - A slash ( / ) is used as the date separator. - This is the default. - - - DB2_I5_SEP_DASH - A dash ( - ) is used as the date separator. - - - DB2_I5_SEP_PERIOD - A period ( . ) is used as the date - separator. - - - DB2_I5_SEP_COMMA - A comma ( , ) is used as the date separator. - - - DB2_I5_SEP_BLANK - A blank is used as the date separator. - - - DB2_I5_SEP_JOB - The job default is used - - - - - i5_time_fmt - - - DB2_I5_FMT_ISO - The International Organization for - Standardization (ISO) time format hh.mm.ss is used. This is the default. - - - DB2_I5_FMT_USA - The United States time format - hh:mmxx is used, where xx is AM or PM. - - - DB2_I5_FMT_EUR - The European time format hh.mm.ss - is used. - - - DB2_I5_FMT_JIS - The Japanese Industrial Standard - time format hh:mm:ss is used. - - - DB2_I5_FMT_HMS - The hh:mm:ss format is used. - - - - - i5_time_sep - - - DB2_I5_SEP_COLON - A colon ( : ) is used as the time - separator. This is the default. - - - DB2_I5_SEP_PERIOD - A period ( . ) is used as the time - separator. - - - DB2_I5_SEP_COMMA - A comma ( , ) is used as the time - separator. - - - DB2_I5_SEP_BLANK - A blank is used as the time separator. - - - DB2_I5_SEP_JOB - The job default is used. - - - - - i5_decimal_sep - - - DB2_I5_SEP_PERIOD - A period ( . ) is used as - the decimal separator. This is the default. - - - DB2_I5_SEP_COMMA - A comma ( , ) is used as the - decimal separator. - - - DB2_I5_SEP_JOB - The job default is used. - - - - - - - The following new i5/OS option is available in ibm_db2 version 1.8.0 - and later. - - - i5_libl - - - A character value that indicates the library list that will be used for - resolving unqualified file references. Specify the library list - elements separated by blanks 'i5_libl'=>"MYLIB YOURLIB ANYLIB". - - - i5_libl calls qsys2/qcmdexc('cmd',cmdlen), which is only available - in i5/OS V5R4 and later. - - - - - - - - - - - - - &reftitle.returnvalues; - - Returns a connection handle resource if the connection attempt is - successful. db2_pconnect tries to reuse an existing - connection resource that exactly matches the - database, username, and - password parameters. If the connection attempt fails, - db2_pconnect returns &false;. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL ibm_db2 1.9.0 - - Active transactions within a persistent connection will be rolled back - at the end of each request. - - - - PECL ibm_db2 1.8.0 - - The i5_libl option is available for i5/OS - users. - - - - PECL ibm_db2 1.7.0 - - The trustedcontext option is available. - - - - PECL ibm_db2 1.5.1 - - The i5_lib, i5_naming, - i5_commit, - i5_query_optimize, - i5_dbcs_alloc, - i5_date_fmt, - i5_date_sep, - i5_time_fmt, i5_time_sep - and i5_decimal_sep options are available for - i5/OS users. - - - - - - - - - &reftitle.examples; - - - A <function>db2_pconnect</function> example - - In the following example, the first call to - db2_pconnect returns a new persistent connection - resource. The second call to db2_pconnect returns - a persistent connection resource that simply reuses the first persistent - connection resource. - - - -]]> - - &example.outputs; - - - - - - Using trusted context - - The following example shows how to enable trusted context, switch - users, and get the current user ID. - - - DB2_TRUSTED_CONTEXT_ENABLE); - -$tc_conn = db2_pconnect($dsn, "", "", $options); -if($tc_conn) { - echo "Explicit trusted connection succeeded.\n"; - - if(db2_get_option($tc_conn, "trustedcontext")) { - $userBefore = db2_get_option($tc_conn, "trusted_user"); - - //Do some work as user 1. - - //Switching to trusted user. - $parameters = array("trusted_user" => $tc_user, - "trusted_password" => $tcuser_pass); - $res = db2_set_option ($tc_conn, $parameters, 1); - - $userAfter = db2_get_option($tc_conn, "trusted_user"); - //Do more work as trusted user. - - if($userBefore != $userAfter) { - echo "User has been switched." . "\n"; - } - } - - db2_close($tc_conn); -} -else { - echo "Explicit trusted connection failed.\n"; -} -?> - -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - db2_connect - - - - - - diff --git a/reference/ibm_db2/functions/db2-prepare.xml b/reference/ibm_db2/functions/db2-prepare.xml deleted file mode 100644 index edc653ad026c..000000000000 --- a/reference/ibm_db2/functions/db2-prepare.xml +++ /dev/null @@ -1,172 +0,0 @@ - - - - - - db2_prepare - - Prepares an SQL statement to be executed - - - - &reftitle.description; - - resourcefalsedb2_prepare - resourceconnection - stringstatement - arrayoptions[] - - - - - db2_prepare creates a prepared SQL statement which can - include 0 or more parameter markers (? characters) - representing parameters for input, output, or input/output. You can pass - parameters to the prepared statement using - db2_bind_param, or for input values only, as an array - passed to db2_execute. - - - There are three main advantages to using prepared statements in your - application: - - - - Performance: when you prepare a statement, the - database server creates an optimized access plan for retrieving data with - that statement. Subsequently issuing the prepared statement with - db2_execute enables the statements to reuse that - access plan and avoids the overhead of dynamically creating a new access - plan for every statement you issue. - - - - - Security: when you prepare a statement, you can - include parameter markers for input values. When you execute a prepared - statement with input values for placeholders, the database server checks - each input value to ensure that the type matches the column definition or - parameter definition. - - - - - Advanced functionality: Parameter markers not only - enable you to pass input values to prepared SQL statements, they also - enable you to retrieve OUT and INOUT parameters from stored procedures - using db2_bind_param. - - - - - - - - &reftitle.parameters; - - - connection - - - A valid database connection resource variable as returned from - db2_connect or db2_pconnect. - - - - - statement - - - An SQL statement, optionally containing one or more parameter markers.. - - - - - options - - - An associative array containing statement options. You can use this - parameter to request a scrollable cursor on database servers that - support this functionality. - - - For a description of valid statement options, see - db2_set_option. - - - - - - - &reftitle.returnvalues; - - Returns a statement resource if the SQL statement was successfully parsed and - prepared by the database server. Returns &false; if the database server - returned an error. You can determine which error was returned by calling - db2_stmt_error or db2_stmt_errormsg. - - - - - &reftitle.examples; - - Preparing and executing an SQL statement with parameter markers - - The following example prepares an INSERT statement that accepts four - parameter markers, then iterates over an array of arrays containing the - input values to be passed to db2_execute. - - - -]]> - - - - - - &reftitle.seealso; - - db2_bind_param - db2_execute - db2_stmt_error - db2_stmt_errormsg - - - - - diff --git a/reference/ibm_db2/functions/db2-primary-keys.xml b/reference/ibm_db2/functions/db2-primary-keys.xml deleted file mode 100644 index 6cd0e1863861..000000000000 --- a/reference/ibm_db2/functions/db2-primary-keys.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - db2_primary_keys - - Returns a result set listing primary keys for a table - - - - &reftitle.description; - - resourcedb2_primary_keys - resourceconnection - stringnullqualifier - stringnullschema - stringtable_name - - - - Returns a result set listing the primary keys for a table. - - - - - &reftitle.parameters; - - - connection - - - A valid connection to an IBM DB2, Cloudscape, or Apache Derby database. - - - - - qualifier - - - A qualifier for DB2 databases running on OS/390 or z/OS servers. For - other databases, pass &null; or an empty string. - - - - - schema - - - The schema which contains the tables. If schema - is &null;, db2_primary_keys matches the schema for - the current connection. - - - - - table_name - - - The name of the table. - - - - - - - &reftitle.returnvalues; - - Returns a statement resource with a result set containing rows describing - the primary keys for the specified table. The result set is composed of the - following columns: - - - - - Column name - Description - - - - - TABLE_CAT - - Name of the catalog for the table containing the primary key. The - value is NULL if this table does not have catalogs. - - - - TABLE_SCHEM - - Name of the schema for the table containing the primary key. - - - - TABLE_NAME - Name of the table containing the primary key. - - - COLUMN_NAME - Name of the column containing the primary key. - - - KEY_SEQ - 1-indexed position of the column in the key. - - - PK_NAME - The name of the primary key. - - - - - - - - - &reftitle.seealso; - - db2_column_privileges - db2_columns - db2_foreign_keys - db2_procedure_columns - db2_procedures - db2_special_columns - db2_statistics - db2_table_privileges - db2_tables - - - - - - diff --git a/reference/ibm_db2/functions/db2-procedure-columns.xml b/reference/ibm_db2/functions/db2-procedure-columns.xml deleted file mode 100644 index a4e6dc2356aa..000000000000 --- a/reference/ibm_db2/functions/db2-procedure-columns.xml +++ /dev/null @@ -1,267 +0,0 @@ - - - - - - db2_procedure_columns - - Returns a result set listing stored procedure parameters - - - - &reftitle.description; - - resourcedb2_procedure_columns - resourceconnection - stringnullqualifier - stringschema - stringprocedure - stringnullparameter - - - - Returns a result set listing the parameters for one or more stored - procedures. - - - - - &reftitle.parameters; - - - connection - - - A valid connection to an IBM DB2, Cloudscape, or Apache Derby database. - - - - - qualifier - - - A qualifier for DB2 databases running on OS/390 or z/OS servers. For - other databases, pass &null; or an empty string. - - - - - schema - - - The schema which contains the procedures. This parameter accepts a - search pattern containing _ and % - as wildcards. - - - - - procedure - - - The name of the procedure. This parameter accepts a - search pattern containing _ and % - as wildcards. - - - - - parameter - - - The name of the parameter. This parameter accepts a search pattern - containing _ and % as wildcards. - If this parameter is &null;, all parameters for the specified stored - procedures are returned. - - - - - - - &reftitle.returnvalues; - - Returns a statement resource with a result set containing rows describing - the parameters for the stored procedures matching the specified parameters. - The rows are composed of the following columns: - - - - - Column name - Description - - - - - PROCEDURE_CAT - The catalog that contains the procedure. The value is &null; if - this table does not have catalogs. - - - PROCEDURE_SCHEM - Name of the schema that contains the stored procedure. - - - PROCEDURE_NAME - Name of the procedure. - - - COLUMN_NAME - Name of the parameter. - - - COLUMN_TYPE - - - An integer value representing the type of the parameter: - - - - - Return value - Parameter type - - - - - 1 (SQL_PARAM_INPUT) - Input (IN) parameter. - - - 2 (SQL_PARAM_INPUT_OUTPUT) - Input/output (INOUT) parameter. - - - 3 (SQL_PARAM_OUTPUT) - Output (OUT) parameter. - - - - - - - - - DATA_TYPE - The SQL data type for the parameter represented as an integer - value. - - - TYPE_NAME - A string representing the data type for the parameter. - - - COLUMN_SIZE - An integer value representing the size of the parameter. - - - BUFFER_LENGTH - - Maximum number of bytes necessary to store data for this parameter. - - - - DECIMAL_DIGITS - - The scale of the parameter, or &null; where scale is not applicable. - - - - NUM_PREC_RADIX - - An integer value of either 10 (representing - an exact numeric data type), 2 (representing an - approximate numeric data type), or &null; (representing a data type for - which radix is not applicable). - - - - NULLABLE - An integer value representing whether the parameter is nullable - or not. - - - REMARKS - Description of the parameter. - - - COLUMN_DEF - Default value for the parameter. - - - SQL_DATA_TYPE - An integer value representing the size of the parameter. - - - SQL_DATETIME_SUB - - Returns an integer value representing a datetime subtype code, - or &null; for SQL data types to which this does not apply. - - - - CHAR_OCTET_LENGTH - - Maximum length in octets for a character data type parameter, which - matches COLUMN_SIZE for single-byte character set data, or &null; for - non-character data types. - - - - ORDINAL_POSITION - The 1-indexed position of the parameter in the CALL - statement. - - - IS_NULLABLE - - A string value where 'YES' means that the parameter accepts or - returns &null; values and 'NO' means that the parameter does not - accept or return &null; values. - - - - - - - - - - - &reftitle.seealso; - - db2_column_privileges - db2_columns - db2_foreign_keys - db2_primary_keys - db2_procedures - db2_special_columns - db2_statistics - db2_table_privileges - db2_tables - - - - - - diff --git a/reference/ibm_db2/functions/db2-procedures.xml b/reference/ibm_db2/functions/db2-procedures.xml deleted file mode 100644 index 56fa860f33d9..000000000000 --- a/reference/ibm_db2/functions/db2-procedures.xml +++ /dev/null @@ -1,162 +0,0 @@ - - - - - - db2_procedures - - Returns a result set listing the stored procedures registered in a database - - - - &reftitle.description; - - resourcedb2_procedures - resourceconnection - stringnullqualifier - stringschema - stringprocedure - - - - - Returns a result set listing the stored procedures registered in a - database. - - - - - &reftitle.parameters; - - - connection - - - A valid connection to an IBM DB2, Cloudscape, or Apache Derby database. - - - - - qualifier - - - A qualifier for DB2 databases running on OS/390 or z/OS servers. For - other databases, pass &null; or an empty string. - - - - - schema - - - The schema which contains the procedures. This parameter accepts a - search pattern containing _ and % - as wildcards. - - - - - procedure - - - The name of the procedure. This parameter accepts a - search pattern containing _ and % - as wildcards. - - - - - - - &reftitle.returnvalues; - - Returns a statement resource with a result set containing rows describing - the stored procedures matching the specified parameters. The rows are - composed of the following columns: - - - - - Column name - Description - - - - - PROCEDURE_CAT - The catalog that contains the procedure. The value is &null; if - this table does not have catalogs. - - - PROCEDURE_SCHEM - Name of the schema that contains the stored procedure. - - - PROCEDURE_NAME - Name of the procedure. - - - NUM_INPUT_PARAMS - Number of input (IN) parameters for the stored procedure. - - - NUM_OUTPUT_PARAMS - Number of output (OUT) parameters for the stored procedure. - - - NUM_RESULT_SETS - Number of result sets returned by the stored procedure. - - - REMARKS - Any comments about the stored procedure. - - - PROCEDURE_TYPE - Always returns 1, indicating that the stored - procedure does not return a return value. - - - - - - - - - - &reftitle.seealso; - - db2_column_privileges - db2_columns - db2_foreign_keys - db2_primary_keys - db2_procedure_columns - db2_special_columns - db2_statistics - db2_table_privileges - db2_tables - - - - - - diff --git a/reference/ibm_db2/functions/db2-result.xml b/reference/ibm_db2/functions/db2-result.xml deleted file mode 100644 index a0910111c3e3..000000000000 --- a/reference/ibm_db2/functions/db2-result.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - db2_result - - Returns a single column from a row in the result set - - - - &reftitle.description; - - mixednulldb2_result - resourcestmt - intstringcolumn - - - - - Use db2_result to return the value of a specified - column in the current row of a result set. You must call - db2_fetch_row before calling - db2_result to set the location of the result set - pointer. - - - - - &reftitle.parameters; - - - stmt - - - A valid stmt resource. - - - - - column - - - Either an integer mapping to the 0-indexed field in the result set, or - a string matching the name of the column. - - - - - - - &reftitle.returnvalues; - - Returns the value of the requested field if the field exists in the result - set. Returns &null; if the field does not exist, and issues a warning. - - - - - &reftitle.examples; - - A <function>db2_result</function> example - - The following example demonstrates how to iterate through a result set - with db2_fetch_row and retrieve columns from the - result set with db2_result. - - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - db2_fetch_array - db2_fetch_assoc - db2_fetch_both - db2_fetch_object - db2_fetch_row - - - - - diff --git a/reference/ibm_db2/functions/db2-rollback.xml b/reference/ibm_db2/functions/db2-rollback.xml deleted file mode 100644 index 0e43e25a674a..000000000000 --- a/reference/ibm_db2/functions/db2-rollback.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - db2_rollback - - Rolls back a transaction - - - - &reftitle.description; - - booldb2_rollback - resourceconnection - - - - Rolls back an in-progress transaction on the specified connection resource and - begins a new transaction. PHP applications normally default to AUTOCOMMIT - mode, so db2_rollback normally has no effect unless - AUTOCOMMIT has been turned off for the connection resource. - - - - - &reftitle.parameters; - - - connection - - - A valid database connection resource variable as returned from - db2_connect or db2_pconnect. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Rolling back a DELETE statement - - In the following example, we count the number of rows in a table, turn - off AUTOCOMMIT mode on a database connection, delete all of the rows in - the table and return the count of 0 to prove that the - rows have been removed. We then issue db2_rollback - and return the updated count of rows in the table to show that the number - is the same as before we issued the DELETE statement. The return to the - original state of the table demonstrates that the roll back of the - transaction succeeded. - - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - db2_autocommit - db2_commit - - - - - diff --git a/reference/ibm_db2/functions/db2-server-info.xml b/reference/ibm_db2/functions/db2-server-info.xml deleted file mode 100644 index d15e89245635..000000000000 --- a/reference/ibm_db2/functions/db2-server-info.xml +++ /dev/null @@ -1,386 +0,0 @@ - - - - - - db2_server_info - Returns an object with properties that describe the DB2 database server - - - &reftitle.description; - - stdClassfalsedb2_server_info - resourceconnection - - - - This function returns an object with read-only properties that return - information about the IBM DB2, Cloudscape, or Apache Derby database server. - The following table lists the database server properties: - - Database server properties - - - - Property name - Return type - Description - - - - - DBMS_NAME - string - The name of the database server to which you are - connected. For DB2 servers this is a combination of - DB2 followed by the operating system on which - the database server is running. - - - DBMS_VER - string - The version of the database server, in the form of a string - "MM.mm.uuuu" where MM is the major version, - mm is the minor version, - and uuuu is the update. For example, "08.02.0001" - represents major version 8, minor version 2, update 1. - - - - DB_CODEPAGE - int - The code page of the database to which you are connected. - - - DB_NAME - string - The name of the database to which you are connected. - - - DFT_ISOLATION - string - - The default transaction isolation level supported by the - server: - - - UR - - - Uncommitted read: changes are immediately visible by all - concurrent transactions. - - - - - CS - - - Cursor stability: a row read by one transaction can be altered and - committed by a second concurrent transaction. - - - - - RS - - - Read stability: a transaction can add or remove rows matching a - search condition or a pending transaction. - - - - - RR - - - Repeatable read: data affected by pending transaction is not - available to other transactions. - - - - - NC - - - No commit: any changes are visible at the end of a successful - operation. Explicit commits and rollbacks are not allowed. - - - - - - - - - IDENTIFIER_QUOTE_CHAR - string - The character used to delimit an identifier. - - - INST_NAME - string - The instance on the database server that contains the - database. - - - ISOLATION_OPTION - array - An array of the isolation options supported by the - database server. The isolation options are described in - the DFT_ISOLATION property. - - - KEYWORDS - array - An array of the keywords reserved by the database - server. - - - LIKE_ESCAPE_CLAUSE - bool - &true; if the database server supports the - use of % and _ wildcard - characters. &false; if the database server does not - support these wildcard characters. - - - MAX_COL_NAME_LEN - int - Maximum length of a column name supported by the database - server, expressed in bytes. - - - MAX_IDENTIFIER_LEN - int - Maximum length of an SQL identifier supported by the database - server, expressed in characters. - - - MAX_INDEX_SIZE - int - Maximum size of columns combined in an index supported by the - database server, expressed in bytes. - - - MAX_PROC_NAME_LEN - int - Maximum length of a procedure name supported by the database - server, expressed in bytes. - - - MAX_ROW_SIZE - int - Maximum length of a row in a base table supported by the - database server, expressed in bytes. - - - MAX_SCHEMA_NAME_LEN - int - Maximum length of a schema name supported by the database - server, expressed in bytes. - - - MAX_STATEMENT_LEN - int - Maximum length of an SQL statement supported by the database - server, expressed in bytes. - - - MAX_TABLE_NAME_LEN - int - Maximum length of a table name supported by the database - server, expressed in bytes. - - - NON_NULLABLE_COLUMNS - bool - &true; if the database server supports columns that can be - defined as NOT NULL, &false; if the database server does not support - columns defined as NOT NULL. - - - PROCEDURES - bool - &true; if the database server supports the use of the CALL - statement to call stored procedures, &false; if the database - server does not support the CALL statement. - - - SPECIAL_CHARS - string - A string containing all of the characters other than - a-Z, 0-9, and underscore that can be used in an identifier name. - - - SQL_CONFORMANCE - string - - The level of conformance to the ANSI/ISO SQL-92 specification - offered by the database server: - - - ENTRY - - - Entry-level SQL-92 compliance. - - - - - FIPS127 - - - FIPS-127-2 transitional compliance. - - - - - FULL - - - Full level SQL-92 compliance. - - - - - INTERMEDIATE - - - Intermediate level SQL-92 compliance. - - - - - - - - - -
-
- -
- - &reftitle.parameters; - - - connection - - - Specifies an active DB2 client connection. - - - - - - - &reftitle.returnvalues; - - Returns an object on a successful call,&return.falseforfailure; - - - - - &reftitle.examples; - - A <function>db2_server_info</function> example - - To retrieve information about the server, you must pass a valid - database connection resource to db2_server_info. - - DBMS_NAME ); - echo "DBMS_VER: "; var_dump( $server->DBMS_VER ); - echo "DB_CODEPAGE: "; var_dump( $server->DB_CODEPAGE ); - echo "DB_NAME: "; var_dump( $server->DB_NAME ); - echo "INST_NAME: "; var_dump( $server->INST_NAME ); - echo "SPECIAL_CHARS: "; var_dump( $server->SPECIAL_CHARS ); - echo "KEYWORDS: "; var_dump( sizeof($server->KEYWORDS) ); - echo "DFT_ISOLATION: "; var_dump( $server->DFT_ISOLATION ); - echo "ISOLATION_OPTION: "; - $il = ''; - foreach( $server->ISOLATION_OPTION as $opt ) - { - $il .= $opt." "; - } - var_dump( $il ); - echo "SQL_CONFORMANCE: "; var_dump( $server->SQL_CONFORMANCE ); - echo "PROCEDURES: "; var_dump( $server->PROCEDURES ); - echo "IDENTIFIER_QUOTE_CHAR: "; var_dump( $server->IDENTIFIER_QUOTE_CHAR ); - echo "LIKE_ESCAPE_CLAUSE: "; var_dump( $server->LIKE_ESCAPE_CLAUSE ); - echo "MAX_COL_NAME_LEN: "; var_dump( $server->MAX_COL_NAME_LEN ); - echo "MAX_ROW_SIZE: "; var_dump( $server->MAX_ROW_SIZE ); - echo "MAX_IDENTIFIER_LEN: "; var_dump( $server->MAX_IDENTIFIER_LEN ); - echo "MAX_INDEX_SIZE: "; var_dump( $server->MAX_INDEX_SIZE ); - echo "MAX_PROC_NAME_LEN: "; var_dump( $server->MAX_PROC_NAME_LEN ); - echo "MAX_SCHEMA_NAME_LEN: "; var_dump( $server->MAX_SCHEMA_NAME_LEN ); - echo "MAX_STATEMENT_LEN: "; var_dump( $server->MAX_STATEMENT_LEN ); - echo "MAX_TABLE_NAME_LEN: "; var_dump( $server->MAX_TABLE_NAME_LEN ); - echo "NON_NULLABLE_COLUMNS: "; var_dump( $server->NON_NULLABLE_COLUMNS ); - - db2_close($conn); -} -?>]]> - &example.outputs; - - - - - - - &reftitle.seealso; - - db2_client_info - - - - -
- diff --git a/reference/ibm_db2/functions/db2-set-option.xml b/reference/ibm_db2/functions/db2-set-option.xml deleted file mode 100644 index 0124d806632d..000000000000 --- a/reference/ibm_db2/functions/db2-set-option.xml +++ /dev/null @@ -1,912 +0,0 @@ - - - - - db2_set_option - Set options for connection or statement resources - - - &reftitle.description; - - booldb2_set_option - resourceresource - arrayoptions - inttype - - - Sets options for a statement resource or a connection resource. You - cannot set options for result set resources. - - - - &reftitle.parameters; - - - resource - - - A valid statement resource as returned from - db2_prepare or a valid connection resource as - returned from db2_connect or - db2_pconnect. - - - - - options - - - An associative array containing valid statement or connection - options. This parameter can be used to change autocommit values, - cursor types (scrollable or forward), and to specify the case of - the column names (lower, upper, or natural) that will appear in a - result set. - - - autocommit - - - Passing DB2_AUTOCOMMIT_ON turns - autocommit on for the specified connection resource. - - - Passing DB2_AUTOCOMMIT_OFF turns - autocommit off for the specified connection resource. - - - - - cursor - - - Passing DB2_FORWARD_ONLY specifies a - forward-only cursor for a statement resource. This is the - default cursor type, and is supported by all database - servers. - - - Passing DB2_SCROLLABLE specifies a - scrollable cursor for a statement resource. Scrollable - cursors enable result set rows to be accessed in - non-sequential order, but are only supported by - IBM DB2 Universal Database databases. - - - - - binmode - - - Passing DB2_BINARY specifies that - binary data will be returned as is. This is the default - mode. This is the equivalent of setting - ibm_db2.binmode=1 in &php.ini;. - - - Passing DB2_CONVERT specifies that - binary data will be converted to hexadecimal encoding, - and will be returned as such. This is the equivalent of - setting ibm_db2.binmode=2 in &php.ini;. - - - Passing DB2_PASSTHRU specifies that - binary data will be converted to &null;. This is the - equivalent of setting ibm_db2.binmode=3 - in &php.ini;. - - - - - db2_attr_case - - - Passing DB2_CASE_LOWER specifies that - column names of the result set are returned in lower case. - - - Passing DB2_CASE_UPPER specifies that - column names of the result set are returned in upper case. - - - Passing DB2_CASE_NATURAL specifies that - column names of the result set are returned in natural - case. - - - - - deferred_prepare - - - Passing DB2_DEFERRED_PREPARE_ON turns deferred - prepare on for the specified statement resource. - - - Passing DB2_DEFERRED_PREPARE_OFF turns deferred - prepare off for the specified statement resource. - - - - - - - The following new i5/OS options are available in ibm_db2 version 1.5.1 - and later. These options apply only when running PHP and ibm_db2 natively on i5 systems. - - - i5_fetch_only - - - DB2_I5_FETCH_ON - Cursors are read-only - and cannot be used for positioned updates or deletes. This - is the default unless SQL_ATTR_FOR_FETCH_ONLY - environment has been set to SQL_FALSE. - - - DB2_I5_FETCH_OFF - Cursors can be used - for positioned updates and deletes. - - - - - - - The following new option is available in ibm_db2 version 1.8.0 and later. - - - rowcount - - - DB2_ROWCOUNT_PREFETCH_ON - Client can request - the full row count prior to fetching, which means that - db2_num_rows returns the number of rows selected - even when a ROLLFORWARD_ONLY cursor is used. - - - DB2_ROWCOUNT_PREFETCH_OFF - Client cannot request - the full row count prior to fetching. - - - - - - - The following new options are available in ibm_db2 version 1.7.0 and later. - - - trusted_user - - - To switch the user to a trusted user, pass the User ID (String) - of the trusted user as the value of this key. This option can - be set on a connection resource only. To use this option, trusted - context must be enabled on the connection resource. - - - - - trusted_password - - - The password (String) that corresponds to the user specified - by the trusted_user key. - - - - - - - The following new options are available in ibm_db2 version 1.6.0 and later. - These options provide useful tracking information that can be accessed during - execution with db2_get_option. - - - When the value in each option is being set, some servers might not handle - the entire length provided and might truncate the value. - - - To ensure that the data specified in each option is converted correctly - when transmitted to a host system, use only the characters A through Z, - 0 through 9, and the underscore (_) or period (.). - - - - - userid - - - SQL_ATTR_INFO_USERID - A pointer to a null-terminated - character string used to identify the client user ID sent to the host - database server when using DB2 Connect. - - - DB2 for z/OS and OS/390 servers support up to a length of 16 characters. - This user-id is not to be confused with the authentication user-id, it is for - identification purposes only and is not used for any authorization. - - - - - - - acctstr - - - SQL_ATTR_INFO_ACCTSTR - A pointer to a null-terminated - character string used to identify the client accounting string sent to the - host database server when using DB2 Connect. - - - DB2 for z/OS and OS/390 servers support up to a length of 200 characters. - - - - - - - applname - - - SQL_ATTR_INFO_APPLNAME - A pointer to a null-terminated - character string used to identify the client application name sent to the - host database server when using DB2 Connect. - - - DB2 for z/OS and OS/390 servers support up to a length of 32 characters. - - - - - - - wrkstnname - - - SQL_ATTR_INFO_WRKSTNNAME - A pointer to a null-terminated - character string used to identify the client workstation name sent to the - host database server when using DB2 Connect. - - - DB2 for z/OS and OS/390 servers support up to a length of 18 characters. - - - - - - - - - - - type - - - An integer value that specifies the type of resource that was - passed into the function. The type of resource and this value - must correspond. - - - Passing 1 as the value specifies that - a connection resource has been passed into the function. - - - Passing any integer not equal to 1 as - the value specifies that a statement resource has been - passed into the function. - - - - - - - - The following table specifies which options are compatible with - the available resource types: - - Resource-Parameter Matrix - - - - - - - - - - Key - Value - Resource Type - - - - - - Connection - Statement - Result Set - - - autocommit - DB2_AUTOCOMMIT_ON - X - - - - - - - autocommit - DB2_AUTOCOMMIT_OFF - X - - - - - - - cursor - DB2_SCROLLABLE - - - X - - - - - cursor - DB2_FORWARD_ONLY - - - X - - - - - binmode - DB2_BINARY - X - X - - - - - binmode - DB2_CONVERT - X - X - - - - - binmode - DB2_PASSTHRU - X - X - - - - - db2_attr_case - DB2_CASE_LOWER - X - X - - - - - db2_attr_case - DB2_CASE_UPPER - X - X - - - - - db2_attr_case - DB2_CASE_NATURAL - X - X - - - - - deferred_prepare - DB2_DEFERRED_PREPARE_ON - - - X - - - - - deferred_prepare - DB2_DEFERRED_PREPARE_OFF - - - X - - - - - i5_fetch_only - DB2_I5_FETCH_ON - - - X - - - - - i5_fetch_only - DB2_I5_FETCH_OFF - - - X - - - - - rowcount - DB2_ROWCOUNT_PREFETCH_ON - - - X - - - - - rowcount - DB2_ROWCOUNT_PREFETCH_OFF - - - X - - - - - trusted_user - <USER NAME> (String) - X - - - - - - - trusted_password - <PASSWORD> (String) - X - - - - - - - userid - SQL_ATTR_INFO_USERID - X - X - - - - - acctstr - SQL_ATTR_INFO_ACCTSTR - X - X - - - - - applname - SQL_ATTR_INFO_APPLNAME - X - X - - - - - wrkstnname - SQL_ATTR_INFO_WRKSTNNAME - X - X - - - - - -
-
-
- - - &reftitle.returnvalues; - - &return.success; - - - - - - - &reftitle.examples; - - - - Setting one parameter with a connection resource - - DB2_AUTOCOMMIT_ON); - -/* Call the function using the correct resource, options array, and type values */ -$result = db2_set_option($conn, $options, 1); - -/* Check if all options could be set correctly */ -if($result) -{ - echo 'Options Set Successfully'; -} -else -{ - echo 'Could Not Set Options'; -} -?> -]]> - - &example.outputs; - - - - - Setting multiple parameters with a connection resource - - DB2_AUTOCOMMIT_OFF, - 'binmode' => DB2_PASSTHRU, - 'db2_attr_case' => DB2_CASE_UPPER, - 'cursor' => DB2_SCROLLABLE); - -/* Call the function using the correct resource, options array, and type values */ -$result = db2_set_option($conn, $options, 1); - -/* Check if all options could be set correctly */ -if($result) -{ - echo 'Options Set Successfully'; -} -else -{ - echo 'Could Not Set Options'; -} -?> -]]> - - &example.outputs; - - - - - - Setting multiple parameters with an invalid key - - DB2_AUTOCOMMIT_OFF, - 'MY_INVALID_KEY' => DB2_PASSTHRU, - 'db2_attr_case' => DB2_CASE_UPPER, - 'cursor' => DB2_SCROLLABLE); - -/* Call the function using the correct resource, options array, and type values */ -$result = db2_set_option($conn, $options, 1); - -/* Check if all options could be set correctly */ -if($result) -{ - echo 'Options Set Successfully'; -} -else -{ - echo 'Could Not Set Options'; -} -?> -]]> - - &example.outputs; - - - - - - Setting multiple parameters with an invalid value - - DB2_AUTOCOMMIT_OFF, - 'binmode' => 'INVALID_VALUE', - 'db2_attr_case' => DB2_CASE_UPPER, - 'cursor' => DB2_SCROLLABLE); - -/* Call the function using the correct resource, options array, and type values */ -$result = db2_set_option($conn, $options, 1); - -/* Check if all options could be set correctly */ -if($result) -{ - echo 'Options Set Successfully'; -} -else -{ - echo 'Could Not Set Options'; -} -?> -]]> - - &example.outputs; - - - - - Setting multiple parameters with a connection resource and the wrong type - - DB2_AUTOCOMMIT_OFF, - 'binmode' => DB2_PASSTHRU, - 'db2_attr_case' => DB2_CASE_UPPER, - 'cursor' => DB2_SCROLLABLE); - -/* Call the function using the correct resource, options array, and the wrong type value */ -$result = db2_set_option($conn, $options, 2); - -/* Check if all options could be set correctly */ -if($result) -{ - echo 'Options Set Successfully'; -} -else -{ - echo 'Could Not Set Options'; -} -?> -]]> - - &example.outputs; - - - - - Setting multiple parameters with the wrong resource - - DB2_AUTOCOMMIT_OFF, - 'binmode' => DB2_PASSTHRU, - 'db2_attr_case' => DB2_CASE_UPPER, - 'cursor' => DB2_SCROLLABLE); - -$stmt = db2_prepare($conn, 'SELECT * FROM EMPLOYEE'); - -/* Call the function using the wrong resource, and the correct options array, and type values */ -$result = db2_set_option($stmt, $options, 1); - -/* Check if all options could be set correctly */ -if($result) -{ - echo 'Options Set Successfully'; -} -else -{ - echo 'Could Not Set Options'; -} -?> -]]> - - &example.outputs; - - - - - Putting it all together - - DB2_CASE_LOWER, - 'cursor' => DB2_SCROLLABLE); - -$stmt = db2_prepare($conn, 'SELECT * FROM EMPLOYEE WHERE EMPNO = ? OR EMPNO = ?'); - -/* Call the function using the correct resource, options array, and type values */ -$option_result = db2_set_option($stmt, $options, 2); -$result = db2_execute($stmt, array('000130', '000140')); - -/* Get Row 2 before Row 1 since Scrollable Cursor */ -print_r(db2_fetch_assoc($stmt, 2)); -print '

'; -print_r(db2_fetch_assoc($stmt, 1)); - -?> -]]> -
- &example.outputs; - 000140 - [firstnme] => HEATHER - [midinit] => A - [lastname] => NICHOLLS - [workdept] => C01 - [phoneno] => 1793 - [hiredate] => 1976-12-15 - [job] => ANALYST - [edlevel] => 18 - [sex] => F - [birthdate] => 1946-01-19 - [salary] => 28420.00 - [bonus] => 600.00 - [comm] => 2274.00 -) - -Array -( - [empno] => 000130 - [firstnme] => DELORES - [midinit] => M - [lastname] => QUINTANA - [workdept] => C01 - [phoneno] => 4578 - [hiredate] => 1971-07-28 - [job] => ANALYST - [edlevel] => 16 - [sex] => F - [birthdate] => 1925-09-15 - [salary] => 23800.00 - [bonus] => 500.00 - [comm] => 1904.00 -)]]> -
- - i5/OS cursors are read-only - -"nobody")); - $stmt = db2_prepare($conn, 'select * from names where first = ?'); - $name = "first2"; - db2_bind_param($stmt, 1, "name", DB2_PARAM_IN); - $options = array("i5_fetch_only"=>DB2_I5_FETCH_ON); - db2_set_option($stmt,$options,0); - if (db2_execute($stmt)) { - while ($row = db2_fetch_array($stmt)) { - echo "{$row[0]} {$row[1]}"; - } - } -?> -]]> - - &example.outputs; - - - - -
-
- - &reftitle.seealso; - - db2_connect - db2_pconnect - db2_exec - db2_prepare - db2_cursor_type - - -
- diff --git a/reference/ibm_db2/functions/db2-special-columns.xml b/reference/ibm_db2/functions/db2-special-columns.xml deleted file mode 100644 index 5d22c62c6ebb..000000000000 --- a/reference/ibm_db2/functions/db2-special-columns.xml +++ /dev/null @@ -1,241 +0,0 @@ - - - - - - db2_special_columns - - Returns a result set listing the unique row identifier columns for a table - - - - &reftitle.description; - - resourcedb2_special_columns - resourceconnection - stringnullqualifier - stringschema - stringtable_name - intscope - - - - Returns a result set listing the unique row identifier columns for a table. - - - - - &reftitle.parameters; - - - connection - - - A valid connection to an IBM DB2, Cloudscape, or Apache Derby database. - - - - - qualifier - - - A qualifier for DB2 databases running on OS/390 or z/OS servers. For - other databases, pass &null; or an empty string. - - - - - schema - - - The schema which contains the tables. - - - - - table_name - - - The name of the table. - - - - - scope - - - Integer value representing the minimum duration for which the - unique row identifier is valid. This can be one of the following - values: - - - - - Integer value - SQL constant - Description - - - - - 0 - SQL_SCOPE_CURROW - Row identifier is valid only while the cursor is positioned - on the row. - - - 1 - SQL_SCOPE_TRANSACTION - Row identifier is valid for the duration of the - transaction. - - - 2 - SQL_SCOPE_SESSION - Row identifier is valid for the duration of the - connection. - - - - - - - - - - - &reftitle.returnvalues; - - Returns a statement resource with a result set containing rows with unique - row identifier information for a table. The rows are composed of the - following columns: - - - - - Column name - Description - - - - - SCOPE - - - - - - Integer value - SQL constant - Description - - - - - 0 - SQL_SCOPE_CURROW - Row identifier is valid only while the cursor is positioned - on the row. - - - 1 - SQL_SCOPE_TRANSACTION - Row identifier is valid for the duration of the - transaction. - - - 2 - SQL_SCOPE_SESSION - Row identifier is valid for the duration of the - connection. - - - - - - - - COLUMN_NAME - Name of the unique column. - - - DATA_TYPE - SQL data type for the column. - - - TYPE_NAME - Character string representation of the SQL data type for the - column. - - - COLUMN_SIZE - An integer value representing the size of the column. - - - BUFFER_LENGTH - - Maximum number of bytes necessary to store data from this column. - - - - DECIMAL_DIGITS - - The scale of the column, or &null; where scale is not applicable. - - - - NUM_PREC_RADIX - - An integer value of either 10 (representing - an exact numeric data type), 2 (representing an - approximate numeric data type), or &null; (representing a data type for - which radix is not applicable). - - - - PSEUDO_COLUMN - Always returns 1. - - - - - - - - - - &reftitle.seealso; - - db2_column_privileges - db2_columns - db2_foreign_keys - db2_primary_keys - db2_procedure_columns - db2_procedures - db2_statistics - db2_table_privileges - db2_tables - - - - - diff --git a/reference/ibm_db2/functions/db2-statistics.xml b/reference/ibm_db2/functions/db2-statistics.xml deleted file mode 100644 index 4c554831e37f..000000000000 --- a/reference/ibm_db2/functions/db2-statistics.xml +++ /dev/null @@ -1,280 +0,0 @@ - - - - - - db2_statistics - - Returns a result set listing the index and statistics for a table - - - - &reftitle.description; - - resourcedb2_statistics - resourceconnection - stringnullqualifier - stringnullschema - stringtable_name - boolunique - - - - Returns a result set listing the index and statistics for a table. - - - - - &reftitle.parameters; - - - connection - - - A valid connection to an IBM DB2, Cloudscape, or Apache Derby database. - - - - - qualifier - - - A qualifier for DB2 databases running on OS/390 or z/OS servers. For - other databases, pass &null; or an empty string. - - - - - schema - - - The schema that contains the targeted table. If this parameter is - &null;, the statistics and indexes are returned for the schema of the - current user. - - - - - table_name - - - The name of the table. - - - - - unique - - - When unique is &true;, the information for all - indexes in the table are returned. - Otherwise, only the information for unique indexes in the table are - returned. - - - - - - - &reftitle.returnvalues; - - Returns a statement resource with a result set containing rows describing - the statistics and indexes for the base tables matching the specified - parameters. The rows are composed of the following columns: - - - - - Column name - Description - - - - - TABLE_CAT - The catalog that contains the table. The value is &null; if - this table does not have catalogs. - - - TABLE_SCHEM - Name of the schema that contains the table. - - - TABLE_NAME - Name of the table. - - - NON_UNIQUE - - - An integer value representing whether the index prohibits unique - values, or whether the row represents statistics on the table itself: - - - - - Return value - Parameter type - - - - - 0 (SQL_FALSE) - The index allows duplicate values. - - - 1 (SQL_TRUE) - The index values must be unique. - - - &null; - This row is statistics information for the table itself. - - - - - - - - - INDEX_QUALIFIER - A string value representing the qualifier that would have to be - prepended to INDEX_NAME to fully qualify the index. - - - INDEX_NAME - A string representing the name of the index. - - - TYPE - - - An integer value representing the type of information contained in - this row of the result set: - - - - - Return value - Parameter type - - - - - 0 (SQL_TABLE_STAT) - The row contains statistics about the table itself. - - - 1 (SQL_INDEX_CLUSTERED) - The row contains information about a clustered index. - - - 2 (SQL_INDEX_HASH) - The row contains information about a hashed index. - - - 3 (SQL_INDEX_OTHER) - The row contains information about a type of index that - is neither clustered nor hashed. - - - - - - - - - ORDINAL_POSITION - The 1-indexed position of the column in the index. &null; if - the row contains statistics information about the table itself. - - - COLUMN_NAME - The name of the column in the index. &null; if the row - contains statistics information about the table itself. - - - ASC_OR_DESC - - A if the column is sorted in ascending order, - D if the column is sorted in descending order, - &null; if the row contains statistics information about the table - itself. - - - - CARDINALITY - - - If the row contains information about an index, this column contains - an integer value representing the number of unique values in the - index. - - - If the row contains information about the table itself, this column - contains an integer value representing the number of rows in the - table. - - - - - PAGES - - - If the row contains information about an index, this column contains - an integer value representing the number of pages used to store the - index. - - - If the row contains information about the table itself, this column - contains an integer value representing the number of pages used to - store the table. - - - - - FILTER_CONDITION - Always returns &null;. - - - - - - - - - &reftitle.seealso; - - db2_column_privileges - db2_columns - db2_foreign_keys - db2_primary_keys - db2_procedure_columns - db2_procedures - db2_special_columns - db2_table_privileges - db2_tables - - - - - diff --git a/reference/ibm_db2/functions/db2-stmt-error.xml b/reference/ibm_db2/functions/db2-stmt-error.xml deleted file mode 100644 index c4a2859f83e7..000000000000 --- a/reference/ibm_db2/functions/db2-stmt-error.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - db2_stmt_error - - Returns a string containing the SQLSTATE returned by an SQL statement - - - - &reftitle.description; - - stringdb2_stmt_error - resourcenullstmt&null; - - - - Returns a string containing the SQLSTATE value returned by an SQL statement. - - - If you do not pass a statement resource as an argument to - db2_stmt_error, the driver returns the SQLSTATE - value associated with the last attempt to return a statement resource, for - example, from db2_prepare or - db2_exec. - - - To learn what the SQLSTATE value means, you can issue the following command - at a DB2 Command Line Processor prompt: - db2 '? sqlstate-value'. You - can also call db2_stmt_errormsg to retrieve an - explicit error message and the associated SQLCODE value. - - - - - &reftitle.parameters; - - - stmt - - - A valid statement resource. - - - - - - - &reftitle.returnvalues; - - Returns a string containing an SQLSTATE value. - - - - - &reftitle.seealso; - - db2_conn_error - db2_conn_errormsg - db2_stmt_errormsg - - - - - diff --git a/reference/ibm_db2/functions/db2-stmt-errormsg.xml b/reference/ibm_db2/functions/db2-stmt-errormsg.xml deleted file mode 100644 index d20db97bdf97..000000000000 --- a/reference/ibm_db2/functions/db2-stmt-errormsg.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - db2_stmt_errormsg - - Returns a string containing the last SQL statement error message - - - - &reftitle.description; - - stringdb2_stmt_errormsg - resourcenullstmt&null; - - - - Returns a string containing the last SQL statement error message. - - - If you do not pass a statement resource as an argument to - db2_stmt_errormsg, the driver returns the error - message associated with the last attempt to return a statement resource, - for example, from db2_prepare or - db2_exec. - - - - - &reftitle.parameters; - - - stmt - - - A valid statement resource. - - - - - - - &reftitle.returnvalues; - - Returns a string containing the error message and SQLCODE value for the - last error that occurred issuing an SQL statement. - - - - - &reftitle.seealso; - - db2_conn_error - db2_conn_errormsg - db2_stmt_error - - - - - diff --git a/reference/ibm_db2/functions/db2-table-privileges.xml b/reference/ibm_db2/functions/db2-table-privileges.xml deleted file mode 100644 index 3fbb24994e50..000000000000 --- a/reference/ibm_db2/functions/db2-table-privileges.xml +++ /dev/null @@ -1,162 +0,0 @@ - - - - - - db2_table_privileges - - Returns a result set listing the tables and associated privileges in a database - - - - &reftitle.description; - - resourcedb2_table_privileges - resourceconnection - stringnullqualifier&null; - stringnullschema&null; - stringnulltable_name&null; - - - - Returns a result set listing the tables and associated privileges in a - database. - - - - - &reftitle.parameters; - - - connection - - - A valid connection to an IBM DB2, Cloudscape, or Apache Derby database. - - - - - qualifier - - - A qualifier for DB2 databases running on OS/390 or z/OS servers. For - other databases, pass &null; or an empty string. - - - - - schema - - - The schema which contains the tables. This parameter accepts a - search pattern containing _ and % - as wildcards. - - - - - table_name - - - The name of the table. This parameter accepts a search pattern - containing _ and % as wildcards. - - - - - - - &reftitle.returnvalues; - - Returns a statement resource with a result set containing rows describing - the privileges for the tables that match the specified parameters. The rows - are composed of the following columns: - - - - - Column name - Description - - - - - TABLE_CAT - The catalog that contains the table. The value is &null; if - this table does not have catalogs. - - - TABLE_SCHEM - Name of the schema that contains the table. - - - TABLE_NAME - Name of the table. - - - GRANTOR - Authorization ID of the user who granted the privilege. - - - GRANTEE - Authorization ID of the user to whom the privilege was - granted. - - - PRIVILEGE - - The privilege that has been granted. This can be one of ALTER, - CONTROL, DELETE, INDEX, INSERT, REFERENCES, SELECT, or UPDATE. - - - - IS_GRANTABLE - - A string value of "YES" or "NO" indicating whether the grantee - can grant the privilege to other users. - - - - - - - - - - - &reftitle.seealso; - - db2_column_privileges - db2_columns - db2_foreign_keys - db2_primary_keys - db2_procedure_columns - db2_procedures - db2_special_columns - db2_statistics - db2_tables - - - - - - diff --git a/reference/ibm_db2/functions/db2-tables.xml b/reference/ibm_db2/functions/db2-tables.xml deleted file mode 100644 index 9f5f9e5a3c7d..000000000000 --- a/reference/ibm_db2/functions/db2-tables.xml +++ /dev/null @@ -1,158 +0,0 @@ - - - - - - db2_tables - - Returns a result set listing the tables and associated metadata in a database - - - - &reftitle.description; - - resourcedb2_tables - resourceconnection - stringnullqualifier&null; - stringnullschema&null; - stringnulltable_name&null; - stringnulltable_type&null; - - - - Returns a result set listing the tables and associated metadata in a - database. - - - - - &reftitle.parameters; - - - connection - - - A valid connection to an IBM DB2, Cloudscape, or Apache Derby database. - - - - - qualifier - - - A qualifier for DB2 databases running on OS/390 or z/OS servers. For - other databases, pass &null; or an empty string. - - - - - schema - - - The schema which contains the tables. This parameter accepts a - search pattern containing _ and % - as wildcards. - - - - - table_name - - - The name of the table. This parameter accepts a search pattern - containing _ and % as wildcards. - - - - - table_type - - - A list of comma-delimited table type identifiers. To match all table - types, pass &null; or an empty string. Valid table type identifiers - include: ALIAS, HIERARCHY TABLE, INOPERATIVE VIEW, NICKNAME, - MATERIALIZED QUERY TABLE, SYSTEM TABLE, TABLE, TYPED TABLE, TYPED VIEW, - and VIEW. - - - - - - - &reftitle.returnvalues; - - Returns a statement resource with a result set containing rows describing - the tables that match the specified parameters. The rows are composed of - the following columns: - - - - - Column name - Description - - - - - TABLE_CAT - The catalog that contains the table. The value is &null; if - this table does not have catalogs. - - - TABLE_SCHEM - Name of the schema that contains the table. - - - TABLE_NAME - Name of the table. - - - TABLE_TYPE - Table type identifier for the table. - - - REMARKS - Description of the table. - - - - - - - - - &reftitle.seealso; - - db2_column_privileges - db2_columns - db2_foreign_keys - db2_primary_keys - db2_procedure_columns - db2_procedures - db2_special_columns - db2_statistics - db2_table_privileges - - - - - diff --git a/reference/ibm_db2/ini.xml b/reference/ibm_db2/ini.xml deleted file mode 100644 index ece4d2b24926..000000000000 --- a/reference/ibm_db2/ini.xml +++ /dev/null @@ -1,543 +0,0 @@ - - -
- &reftitle.runtime; - &extension.runtime; - - ibm_db2 &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - ibm_db2.binmode - "1" - INI_ALL - - - - ibm_db2.i5_all_pconnect - "0" - INI_SYSTEM - Available as of ibm_db2 1.6.5. - - - ibm_db2.i5_allow_commit - "0" - INI_SYSTEM - Available as of ibm_db2 1.4.9. - - - ibm_db2.i5_blank_userid - "0" - INI_SYSTEM - Available as of ibm_db2 1.9.7. - - - ibm_db2.i5_char_trim - "0" - INI_SYSTEM - Available as of ibm_db2 2.1.0. - - - ibm_db2.i5_dbcs_alloc - "0" - INI_SYSTEM - Available as of ibm_db2 1.5.0. - - - ibm_db2.i5_guard_profile - "0" - INI_SYSTEM - Available as of ibm_db2 1.9.7. - - - ibm_db2.i5_ignore_userid - "0" - INI_SYSTEM - Available as of ibm_db2 1.8.0. - - - ibm_db2.i5_job_sort - "0" - INI_SYSTEM - Available as of ibm_db2 1.8.4. - - - ibm_db2.i5_log_verbose - "0" - INI_SYSTEM - Available as of ibm_db2 1.9.7. - - - ibm_db2.i5_max_pconnect - "0" - INI_SYSTEM - Available as of ibm_db2 1.9.7. - - - ibm_db2.i5_override_ccsid - "0" - INI_SYSTEM - Available as of ibm_db2 1.9.7. - - - ibm_db2.i5_servermode_subsystem - NULL - INI_SYSTEM - Available as of ibm_db2 1.9.7. - - - ibm_db2.i5_sys_naming - "0" - INI_SYSTEM - Available as of ibm_db2 1.9.7. - - - ibm_db2.instance_name - NULL - INI_SYSTEM - Available as of ibm_db2 1.0.2. - - - -
- - &ini.descriptions.title; - - - - - ibm_db2.binmode - int - - - - This option controls the mode used for converting to and from binary - data in the PHP application. - - - - 1 (DB2_BINARY) - - - - - 2 (DB2_CONVERT) - - - - - 3 (DB2_PASSTHRU) - - - - - - - - - ibm_db2.i5_all_pconnect - int - - - - This option forces all connections to be persistent on IBM i. - Basically, all db2_connect calls transparently become - db2_pconnect calls. - By default, this option is 0. - This option is provided as a convenience for cases where persistent - connections are faster. - It should not be used in new applications. - - - - 0 - Persistent and non-persistent connections can be made. - - - - - 1 - All connections are persistent. - - - - - - - - - ibm_db2.i5_allow_commit - int - - - - This option controls the transaction isolation mode used. - By default, this option is 0, so commitment control isn't used. - This option can be overridden when connecting if the array key - i5_commit is set in the connection options array - passed to db2_connect or - db2_pconnect. - - - - 0 - commitment control is not used - - - - - 1 - read uncommitted, dirty reads possible. - - - - - 2 - read committed, dirty reads are not possible. - - - - - 3 - repeatable read, dirty reads and non-repeatable reads are not possible - - - - - 4 - serializeable, dirty reads, non-repeatable reads, and phantoms are not possible - - - - - - - - - ibm_db2.i5_blank_userid - int - - - - This controls if a blank user ID should be allowed on IBM i. - By default, this option is 0. - Unlike ibm_db2.i5_ignore_userid, this option - doesn't force all user IDs to be empty or change job behaviour, but - simply allows an empty user ID to be passed, for connecting to Db2 as the - current user. - - - - 0 - Don't allow a blank user ID to be passed. - - - - - 1 - Allow a blank user ID to be passed. - - - - - - - - - ibm_db2.i5_char_trim - int - - - - This option controls if the end of strings are trimmed on IBM i. - Since many tables use fixed column sizes padded with spaces, this is - provided as a convenience. - By default, this option is 0. - - - - 0 - Columns are not trimmed. - - - - - 1 - Spaces at the end of returned character columns are removed. - - - - - - - - - ibm_db2.i5_dbcs_alloc - int - - - - This options affects the internal buffer allocation strategy on IBM i. - By default, this option is 0. - When this option is set, buffers are allocated with a much larger size, - in case the database underestimates a string's size when converting - between encodings. - This option uses six times as much memory for buffers (to account for - the largest possible UTF-8 sequences), but may be needed if truncated - data is returned. - - - - 0 - Minimum size buffers are allocated. - - - - - 1 - Larger size buffers are allocated. - - - - - - - - - ibm_db2.i5_guard_profile - int - - - - This option checks if the database user profile was switched when - connecting to a persistent database connection on IBM i, and if so, - disconnects from the database. - By default, this option is set to 0. - - - - 0 - Don't check for profile swaps. - - - - - 1 - Check for profile swaps and disconnect if so. - - - - - - - - - ibm_db2.i5_log_verbose - int - - - - This option sets if SQL diagnostic messages like warnings and errors are - always sent to the PHP error log on IBM i. - Normally, only a brief message on failure is sent (such as "statement - execute failed") to the PHP error log, as this option is set to - 0 by default. - Note that you can still and should call i.e. - db2_stmt_errormsg manually as part of checking if - functions fail. - - - - 0 - Only logs brief messages. - - - - - 1 - Logs the SQL diagnostic message in addition to the brief message. - - - - - - - - - ibm_db2.i5_ignore_userid - int - - - - This option ignores the user ID when connecting to the database when - running on IBM i, and runs SQL/CLI functionality inside of the PHP job, - instead of a separate job. - By default, this option is 0. - When enabled, it no longer uses a separate database server job, and - always uses the current user profile for the database, ignoring the - username and password passed to db2_connect and - db2_pconnect. - - - - 0 - Uses the specified credentials, and use an SQL/CLI server job. - - - - - 1 - Always use blank credentials, and run SQL/CLI in the PHP job. - - - - - - - - - ibm_db2.i5_job_sort - int - - - - Controls the job sort option on IBM i. - By default, this option is 0. - This corresponds to the IBM i SQL/CLI - SQL_ATTR_CONN_SORT_SEQUENCE attribute. - - - - 0 - Uses the *HEX sort option, sorting by bytes. - - - - - 1 - Uses the job sort sequence set for the PHP job. - - - - - 2 - Uses the job sort sequence set for the database job. - - - - - - - - - ibm_db2.i5_max_pconnect - int - - - - This will affect how many times a persistent connection can be reused - when running on IBM i. - By default, this is set to 0, which means a persistent - connection can always be reused. - This option can help work around issues in a long-running database job - (i.e. if a procedure is leaking memory), but is obviously not a long-term - fix. - - - - - - ibm_db2.i5_override_ccsid - int - - - - The PASE CCSID to use for character conversions from EBCDIC on IBM i. - By default, this is 0, which will select the default - PASE job CCSID, which comes from the PASE locale settings. - For example, setting this to 1208 will use UTF-8. - This should only be modified if the PASE job CCSID isn't the expected - CCSID, and the locale cannot be modified. - - - To learn more about CCSIDs on IBM i, consult the - IBM documentation. - To learn how locales on IBM i PASE are mapped to CCSIDs, consult the - IBM documentation. - - - - - - ibm_db2.i5_sys_naming - int - - - - This option controls the naming mode when connecting to an IBM i system. - By default, this option is 0. - The naming mode affects how names are resolved and the allowed syntax for - names. - When set to 0, this uses periods to qualify names and - uses the default library or user ID to resolve names. - When set to 1, this uses slashes to qualify names and - uses the job library list to resolve names. - - - - 0 - Uses the SQL naming mode ("SCHEMA.TABLE"). - - - - - 1 - Uses the system naming mode ("LIBRARY/FILE"). - - - - - - To learn more about naming modes on IBM i, consult the - IBM documentation. - - - - - - ibm_db2.i5_servermode-subsystem - string - - - - This option changes which subsystem database server jobs run under on - IBM i. - By default, this option is &null;, so jobs will run under the default - subsystem for QSQSRVR jobs. - - - - - - ibm_db2.instance_name - string - - - - On Linux and UNIX operating systems, this option defines the name of the - instance to use for cataloged database connections. - By default, this option is &null;. - If this option is set, its value overrides the - DB2INSTANCE environment variable setting. - - - This option is ignored on Windows operating systems. - - - - -
- diff --git a/reference/ibm_db2/reference.xml b/reference/ibm_db2/reference.xml deleted file mode 100644 index 8d165803dad5..000000000000 --- a/reference/ibm_db2/reference.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - IBM DB2 &Functions; - - &reference.ibm-db2.entities.functions; - - - diff --git a/reference/ibm_db2/setup.xml b/reference/ibm_db2/setup.xml deleted file mode 100644 index bfd289a8d25f..000000000000 --- a/reference/ibm_db2/setup.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - &reftitle.setup; - - -
- &reftitle.required; - - To connect to IBM DB2 Universal Database for Linux, UNIX, and Windows, or - IBM Cloudscape, or Apache Derby, you must install an IBM DB2 Universal - Database client on the same computer on which you are running PHP. The - extension has been developed and tested with DB2 Version 8.2. - - - To connect to IBM DB2 Universal Database for z/OS or iSeries, you also - require IBM DB2 Connect or the equivalent DRDA gateway software. - -
- Requirements on Linux or Unix - - The user invoking the PHP executable or SAPI must specify the DB2 instance - before accessing these functions. You can set the name of the DB2 instance - in &php.ini; using the ibm_db2.instance_name - configuration option, or you can source the DB2 instance profile before - invoking the PHP executable. - - - If you created a DB2 instance named db2inst1 in - /home/db2inst1/, for example, you can add the - following line to &php.ini;: - - - - If you do not set this option in &php.ini;, you must issue the - following command to modify your environment variables to enable access to - DB2: - - - - To enable your PHP-enabled Web server to access these functions, you must - either set the ibm_db2.instance_name configuration - option in &php.ini;, or source the DB2 instance environment in your Web - server start script (typically /etc/init.d/httpd or - /etc/init.d/apache). - -
-
- - - - &reference.ibm-db2.configure; - - - - &reference.ibm-db2.ini; - - - -
- &reftitle.resources; - - The ibm_db2 extension returns connection resources, statement resources, - and result set resources. - -
- - -
- diff --git a/reference/ibm_db2/versions.xml b/reference/ibm_db2/versions.xml deleted file mode 100644 index d6ef671d50d5..000000000000 --- a/reference/ibm_db2/versions.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/iconv/reference.xml b/reference/iconv/reference.xml index 58aa6bbd9a76..ed23612de6e6 100644 --- a/reference/iconv/reference.xml +++ b/reference/iconv/reference.xml @@ -6,9 +6,9 @@ &reftitle.seealso; - - See also GNU Recode functions. - + + See also GNU Recode functions. + &reference.iconv.entities.functions; diff --git a/reference/igbinary/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/igbinary/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/igbinary/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/igbinary/book.xml b/reference/igbinary/book.xml deleted file mode 100644 index 4617832b94d9..000000000000 --- a/reference/igbinary/book.xml +++ /dev/null @@ -1,43 +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/functions/igbinary-serialize.xml b/reference/igbinary/functions/igbinary-serialize.xml deleted file mode 100644 index 20fe9350f746..000000000000 --- a/reference/igbinary/functions/igbinary-serialize.xml +++ /dev/null @@ -1,154 +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 processed by igbinary_serialize. - 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 943564467d08..000000000000 --- a/reference/igbinary/functions/igbinary-unserialize.xml +++ /dev/null @@ -1,146 +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). - - - - <link linkend="ini.unserialize-callback-func">unserialize_callback_func</link> - directive - - - The callback specified in the - unserialize_callback_func - directive is called when an undefined class is unserialized. - If no callback is specified, the object will be instantiated as - __PHP_Incomplete_Class. - - - - - - - - - &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 21b8e28e80b5..000000000000 --- a/reference/igbinary/ini.xml +++ /dev/null @@ -1,100 +0,0 @@ - -
- &reftitle.runtime; - &extension.runtime; - - - Igbinary &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - igbinary.compact_strings - 1 - INI_ALL - - - - -
- - Session Configuration Options Affecting Igbinary Behavior - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - session.save_handler - "files" - 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 58ac4fc53d11..000000000000 --- a/reference/igbinary/reference.xml +++ /dev/null @@ -1,27 +0,0 @@ - - - Igbinary &Functions; - - &reference.igbinary.entities.functions; - - - diff --git a/reference/igbinary/setup.xml b/reference/igbinary/setup.xml deleted file mode 100644 index 9f4cd1a6ca31..000000000000 --- a/reference/igbinary/setup.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - &reftitle.setup; - -
- &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;igbinary. - - - &pecl.windows.download.avail; - -
- - &reference.igbinary.ini; -
- diff --git a/reference/igbinary/versions.xml b/reference/igbinary/versions.xml deleted file mode 100644 index d38d6278f70d..000000000000 --- a/reference/igbinary/versions.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - - - - - - diff --git a/reference/imagick/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/imagick/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/imagick/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/imagick/book.xml b/reference/imagick/book.xml deleted file mode 100644 index 8d60f9c36823..000000000000 --- a/reference/imagick/book.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - Image Processing (ImageMagick) - ImageMagick - - - - &reftitle.intro; - - &warn.experimental; - Imagick is a native php extension to create and modify images using the - ImageMagick API. - - -
- About ImageMagick - - ImageMagick is a software suite to create, edit, and compose bitmap images. - It can read, convert and write images in a variety of formats (over 100) - including DPX, EXR, GIF, JPEG, JPEG-2000, PDF, PhotoCD, PNG, Postscript, SVG, and TIFF. - - - ImageMagick Studio LLC is a non-profit organization dedicated to making software imaging solutions freely available. - -
- - -
- - - &reference.imagick.setup; - &reference.imagick.constants; - &reference.imagick.examples; - - &reference.imagick.imagick; - &reference.imagick.imagickdraw; - &reference.imagick.imagickdrawexception; - &reference.imagick.imagickexception; - &reference.imagick.imagickkernel; - &reference.imagick.imagickkernelexception; - &reference.imagick.imagickpixel; - &reference.imagick.imagickpixelexception; - &reference.imagick.imagickpixeliterator; - &reference.imagick.imagickpixeliteratorexception; - -
- - - diff --git a/reference/imagick/constants.xml b/reference/imagick/constants.xml deleted file mode 100644 index 48182b05b714..000000000000 --- a/reference/imagick/constants.xml +++ /dev/null @@ -1,4376 +0,0 @@ - - - - &reftitle.constants; - &extension.constants; - - <constant>COLOR_<replaceable>*</replaceable></constant> constants - Colortype constants. These constants are mainly used with - ImagickPixel. - - - - imagick::COLOR_BLACK - (int) - - - - Black color - - - - - - imagick::COLOR_BLUE - (int) - - - - Blue color - - - - - - imagick::COLOR_CYAN - (int) - - - - Cyan color - - - - - - imagick::COLOR_GREEN - (int) - - - - Green color - - - - - - imagick::COLOR_RED - (int) - - - - Red color - - - - - - imagick::COLOR_YELLOW - (int) - - - - Yellow color - - - - - - imagick::COLOR_MAGENTA - (int) - - - - Magenta color - - - - - - imagick::COLOR_OPACITY - (int) - - - - Color's opacity - - - - - - imagick::COLOR_ALPHA - (int) - - - - Color's alpha - - - - - - imagick::COLOR_FUZZ - (int) - - - - Color's fuzz - - - - - - - <constant>DISPOSE_<replaceable>*</replaceable></constant> constants - Dispose type constants - - - imagick::DISPOSE_UNRECOGNIZED - (int) - - - - Unrecognized dispose type - - - - - - imagick::DISPOSE_UNDEFINED - (int) - - - - Undefined dispose type - - - - - - imagick::DISPOSE_NONE - (int) - - - - No dispose type defined - - - - - - imagick::DISPOSE_BACKGROUND - (int) - - - - Dispose background - - - - - - imagick::DISPOSE_PREVIOUS - (int) - - - - Dispose previous - - - - - - - <constant>COMPOSITE_<replaceable>*</replaceable></constant> constants - - - imagick::COMPOSITE_DEFAULT - (int) - - - - The default composite operator - - - - - - imagick::COMPOSITE_UNDEFINED - (int) - - - - Undefined composite operator - - - - - - imagick::COMPOSITE_NO - (int) - - - - No composite operator defined - - - - - - imagick::COMPOSITE_ADD - (int) - - - - The result of image + image - - - - - - imagick::COMPOSITE_ATOP - (int) - - - - The result is the same shape as image, with composite image obscuring image where the image shapes overlap - - - - - - imagick::COMPOSITE_BLEND - (int) - - - - Blends the image - - - - - - imagick::COMPOSITE_BUMPMAP - (int) - - - - The same as COMPOSITE_MULTIPLY, except the source is converted to grayscale first. - - - - - - imagick::COMPOSITE_CLEAR - (int) - - - - Makes the target image transparent - - - - - - imagick::COMPOSITE_COLORBURN - (int) - - - - Darkens the destination image to reflect the source image - - - - - - imagick::COMPOSITE_COLORDODGE - (int) - - - - Brightens the destination image to reflect the source image - - - - - - imagick::COMPOSITE_COLORIZE - (int) - - - - Colorizes the target image using the composite image - - - - - - imagick::COMPOSITE_COPYBLACK - (int) - - - - Copies black from the source to target - - - - - - imagick::COMPOSITE_COPYBLUE - (int) - - - - Copies blue from the source to target - - - - - - imagick::COMPOSITE_COPY - (int) - - - - Copies the source image on the target image - - - - - - imagick::COMPOSITE_COPYCYAN - (int) - - - - Copies cyan from the source to target - - - - - - imagick::COMPOSITE_COPYGREEN - (int) - - - - Copies green from the source to target - - - - - - imagick::COMPOSITE_COPYMAGENTA - (int) - - - - Copies magenta from the source to target - - - - - - imagick::COMPOSITE_COPYOPACITY - (int) - - - - Copies opacity from the source to target - - - - - - imagick::COMPOSITE_COPYRED - (int) - - - - Copies red from the source to target - - - - - - imagick::COMPOSITE_COPYYELLOW - (int) - - - - Copies yellow from the source to target - - - - - - imagick::COMPOSITE_DARKEN - (int) - - - - Darkens the target image - - - - - - imagick::COMPOSITE_DSTATOP - (int) - - - - The part of the destination lying inside of the source is composited over the source and replaces the destination - - - - - - imagick::COMPOSITE_DST - (int) - - - - The target is left untouched - - - - - - imagick::COMPOSITE_DSTIN - (int) - - - - The parts inside the source replace the target - - - - - - imagick::COMPOSITE_DSTOUT - (int) - - - - The parts outside the source replace the target - - - - - - imagick::COMPOSITE_DSTOVER - (int) - - - - Target replaces the source - - - - - - imagick::COMPOSITE_DIFFERENCE - (int) - - - - Subtracts the darker of the two constituent colors from the lighter - - - - - - imagick::COMPOSITE_DISPLACE - (int) - - - - Shifts target image pixels as defined by the source - - - - - - imagick::COMPOSITE_DISSOLVE - (int) - - - - Dissolves the source in to the target - - - - - - imagick::COMPOSITE_EXCLUSION - (int) - - - - Produces an effect similar to that of imagick::COMPOSITE_DIFFERENCE, but appears as lower contrast - - - - - - imagick::COMPOSITE_HARDLIGHT - (int) - - - - Multiplies or screens the colors, dependent on the source color value - - - - - - imagick::COMPOSITE_HUE - (int) - - - - Modifies the hue of the target as defined by source - - - - - - imagick::COMPOSITE_IN - (int) - - - - Composites source into the target - - - - - - imagick::COMPOSITE_LIGHTEN - (int) - - - - Lightens the target as defined by source - - - - - - imagick::COMPOSITE_LUMINIZE - (int) - - - - Luminizes the target as defined by source - - - - - - imagick::COMPOSITE_MINUS - (int) - - - - Subtracts the source from the target - - - - - - imagick::COMPOSITE_MODULATE - (int) - - - - Modulates the target brightness, saturation and hue as defined by source - - - - - - imagick::COMPOSITE_MULTIPLY - (int) - - - - Multiplies the target to the source - - - - - - imagick::COMPOSITE_OUT - (int) - - - - Composites outer parts of the source on the target - - - - - - imagick::COMPOSITE_OVER - (int) - - - - Composites source over the target - - - - - - imagick::COMPOSITE_OVERLAY - (int) - - - - Overlays the source on the target - - - - - - imagick::COMPOSITE_PLUS - (int) - - - - Adds the source to the target - - - - - - imagick::COMPOSITE_REPLACE - (int) - - - - Replaces the target with the source - - - - - - imagick::COMPOSITE_SATURATE - (int) - - - - Saturates the target as defined by the source - - - - - - imagick::COMPOSITE_SCREEN - (int) - - - - The source and destination are complemented and then multiplied and then replace the destination - - - - - - imagick::COMPOSITE_SOFTLIGHT - (int) - - - - Darkens or lightens the colors, dependent on the source - - - - - - imagick::COMPOSITE_SRCATOP - (int) - - - - The part of the source lying inside of the destination is composited onto the destination - - - - - - imagick::COMPOSITE_SRC - (int) - - - - The source is copied to the destination - - - - - - imagick::COMPOSITE_SRCIN - (int) - - - - The part of the source lying inside of the destination replaces the destination - - - - - - imagick::COMPOSITE_SRCOUT - (int) - - - - The part of the source lying outside of the destination replaces the destination - - - - - - imagick::COMPOSITE_SRCOVER - (int) - - - - The source replaces the destination - - - - - - imagick::COMPOSITE_SUBTRACT - (int) - - - - Subtract the colors in the source image from the destination image - - - - - - imagick::COMPOSITE_THRESHOLD - (int) - - - - The source is composited on the target as defined by source threshold - - - - - - imagick::COMPOSITE_XOR - (int) - - - - The part of the source that lies outside of the destination is combined with the part of the destination that lies outside of the source - - - - - - - <constant>MONTAGEMODE_<replaceable>*</replaceable></constant> constants - - - - imagick::MONTAGEMODE_FRAME - (int) - - - - - - - - - imagick::MONTAGEMODE_UNFRAME - (int) - - - - - - - - - imagick::MONTAGEMODE_CONCATENATE - (int) - - - - - - - - - - <constant>STYLE_<replaceable>*</replaceable></constant> constants - - - - imagick::STYLE_NORMAL - (int) - - - - - - - - - imagick::STYLE_ITALIC - (int) - - - - - - - - - imagick::STYLE_OBLIQUE - (int) - - - - - - - - - imagick::STYLE_ANY - (int) - - - - - - - - - - <constant>FILTER_<replaceable>*</replaceable></constant> constants - - - - imagick::FILTER_UNDEFINED - (int) - - - - - - - - - imagick::FILTER_POINT - (int) - - - - - - - - - imagick::FILTER_BOX - (int) - - - - - - - - - imagick::FILTER_TRIANGLE - (int) - - - - - - - - - imagick::FILTER_HERMITE - (int) - - - - - - - - - imagick::FILTER_HANNING - (int) - - - - - - - - - imagick::FILTER_HAMMING - (int) - - - - - - - - - imagick::FILTER_BLACKMAN - (int) - - - - - - - - - imagick::FILTER_GAUSSIAN - (int) - - - - - - - - - imagick::FILTER_QUADRATIC - (int) - - - - - - - - - imagick::FILTER_CUBIC - (int) - - - - - - - - - imagick::FILTER_CATROM - (int) - - - - - - - - - imagick::FILTER_MITCHELL - (int) - - - - - - - - - imagick::FILTER_LANCZOS - (int) - - - - - - - - - imagick::FILTER_BESSEL - (int) - - - - - - - - - imagick::FILTER_SINC - (int) - - - - - - - - - - <constant>IMGTYPE_<replaceable>*</replaceable></constant> constants - - An image type combines a color model with the presence or absence of an - alpha channel. - Passing one of these constants to - Imagick::setImageType converts the image to that - type. - Imagick::getImageType reports the type of an image, - but only ever returns a type that describes actual pixel data, never - imagick::IMGTYPE_UNDEFINED or - imagick::IMGTYPE_OPTIMIZE. - - - The constants whose name ends in MATTE are the variants - that carry an alpha channel; the others have none. - In ImageMagick 6 the alpha channel was known as the matte channel, and when - Imagick is built against ImageMagick 7 each of these constants also exists - under an IMGTYPE_*ALPHA name - with the same value. - - - - imagick::IMGTYPE_UNDEFINED - (int) - - - - The image type is not known. - Imagick::setImageType converts nothing for this - value, but still records it on the image. - - - - - - imagick::IMGTYPE_BILEVEL - (int) - - - - Two colors only. - The image is converted to grayscale, its contrast is stretched, and every - pixel becomes either black or white depending on whether it is lighter or - darker than mid-gray; any alpha channel is discarded. - - - - - - imagick::IMGTYPE_GRAYSCALE - (int) - - - - Shades of gray. - The image is converted to the grayscale colorspace, and any alpha channel - is discarded. - - - - - - imagick::IMGTYPE_GRAYSCALEMATTE - (int) - - - - Shades of gray with an alpha channel. - The same as imagick::IMGTYPE_GRAYSCALE, except that - the alpha channel is kept, and if the image has none, an opaque one is - added. - - - - - - imagick::IMGTYPE_PALETTE - (int) - - - - Indexed color. - The image is converted to sRGB and, if it is not already indexed or has - more than 256 colors, it is quantized to 256 colors; any alpha channel is - discarded. - - - - - - imagick::IMGTYPE_PALETTEMATTE - (int) - - - - Indexed color with an alpha channel. - The image is converted to sRGB, the alpha channel is kept, and if the - image has none, an opaque one is added. - Unlike imagick::IMGTYPE_PALETTE, the colors are - quantized even when the image is already indexed, and the alpha channel - is included in the quantization. - - - - - - imagick::IMGTYPE_TRUECOLOR - (int) - - - - Direct color: one red, green, and blue value per pixel, with no palette. - The image is converted to sRGB, and any alpha channel is discarded. - - - - - - imagick::IMGTYPE_TRUECOLORMATTE - (int) - - - - Direct color with an alpha channel. - The same as imagick::IMGTYPE_TRUECOLOR, except that - the alpha channel is kept, and if the image has none, an opaque one is - added. - - - - - - imagick::IMGTYPE_COLORSEPARATION - (int) - - - - One channel per printing ink, with no palette. - The image is converted to the CMYK colorspace, and any alpha channel is - discarded. - - - - - - imagick::IMGTYPE_COLORSEPARATIONMATTE - (int) - - - - One channel per printing ink, with no palette, plus an alpha channel. - The same as imagick::IMGTYPE_COLORSEPARATION, except - that the alpha channel is kept, and if the image has none, an opaque one - is added. - - - - - - imagick::IMGTYPE_PALETTEBILEVELMATTE - (int) - - - - Indexed color with a fully transparent or fully opaque alpha channel. - The image is converted to sRGB, an opaque alpha channel is added if it - has none, that channel alone is reduced to two values, and the colors - are then quantized. - This is the type of a PNG using binary transparency. - - - - - - imagick::IMGTYPE_OPTIMIZE - (int) - - - - Imagick::setImageType converts nothing for this - value, but still records it on the image. - - - - - - - <constant>RESOLUTION_<replaceable>*</replaceable></constant> constants - - - - imagick::RESOLUTION_UNDEFINED - (int) - - - - - - - - - imagick::RESOLUTION_PIXELSPERINCH - (int) - - - - - - - - - imagick::RESOLUTION_PIXELSPERCENTIMETER - (int) - - - - - - - - - - <constant>COMPRESSION_<replaceable>*</replaceable></constant> constants - - - - imagick::COMPRESSION_UNDEFINED - (int) - - - - - - - - - imagick::COMPRESSION_NO - (int) - - - - - - - - - imagick::COMPRESSION_BZIP - (int) - - - - - - - - - imagick::COMPRESSION_FAX - (int) - - - - - - - - - imagick::COMPRESSION_GROUP4 - (int) - - - - - - - - - imagick::COMPRESSION_JPEG - (int) - - - - - - - - - imagick::COMPRESSION_JPEG2000 - (int) - - - - - - - - - imagick::COMPRESSION_LOSSLESSJPEG - (int) - - - - - - - - - imagick::COMPRESSION_LZW - (int) - - - - - - - - - imagick::COMPRESSION_RLE - (int) - - - - - - - - - imagick::COMPRESSION_ZIP - (int) - - - - - - - - - imagick::COMPRESSION_DXT1 - (int) - - - - &imagick.constant.available; 6.4.0 or higher. - - - - - - imagick::COMPRESSION_DXT3 - (int) - - - - &imagick.constant.available; 6.4.0 or higher. - - - - - - imagick::COMPRESSION_DXT5 - (int) - - - - &imagick.constant.available; 6.4.0 or higher. - - - - - - - <constant>PAINT_<replaceable>*</replaceable></constant> constants - - - - imagick::PAINT_POINT - (int) - - - - - - - - - imagick::PAINT_REPLACE - (int) - - - - - - - - - imagick::PAINT_FLOODFILL - (int) - - - - - - - - - imagick::PAINT_FILLTOBORDER - (int) - - - - - - - - - imagick::PAINT_RESET - (int) - - - - - - - - - - <constant>GRAVITY_<replaceable>*</replaceable></constant> constants - - - - imagick::GRAVITY_NORTHWEST - (int) - - - - - - - - - imagick::GRAVITY_NORTH - (int) - - - - - - - - - imagick::GRAVITY_NORTHEAST - (int) - - - - - - - - - imagick::GRAVITY_WEST - (int) - - - - - - - - - imagick::GRAVITY_CENTER - (int) - - - - - - - - - imagick::GRAVITY_EAST - (int) - - - - - - - - - imagick::GRAVITY_SOUTHWEST - (int) - - - - - - - - - imagick::GRAVITY_SOUTH - (int) - - - - - - - - - imagick::GRAVITY_SOUTHEAST - (int) - - - - - - - - - - <constant>STRETCH_<replaceable>*</replaceable></constant> constants - - - - imagick::STRETCH_NORMAL - (int) - - - - - - - - - imagick::STRETCH_ULTRACONDENSED - (int) - - - - - - - - - imagick::STRETCH_CONDENSED - (int) - - - - - - - - - imagick::STRETCH_SEMICONDENSED - (int) - - - - - - - - - imagick::STRETCH_SEMIEXPANDED - (int) - - - - - - - - - imagick::STRETCH_EXPANDED - (int) - - - - - - - - - imagick::STRETCH_EXTRAEXPANDED - (int) - - - - - - - - - imagick::STRETCH_ULTRAEXPANDED - (int) - - - - - - - - - imagick::STRETCH_ANY - (int) - - - - - - - - - - <constant>ALIGN_<replaceable>*</replaceable></constant> constants - - - - imagick::ALIGN_UNDEFINED - (int) - - - - - - - - - imagick::ALIGN_LEFT - (int) - - - - - - - - - imagick::ALIGN_CENTER - (int) - - - - - - - - - imagick::ALIGN_RIGHT - (int) - - - - - - - - - - <constant>DECORATION_<replaceable>*</replaceable></constant> constants - - - - imagick::DECORATION_NO - (int) - - - - - - - - - imagick::DECORATION_UNDERLINE - (int) - - - - - - - - - imagick::DECORATION_OVERLINE - (int) - - - - - - - - - imagick::DECORATION_LINETROUGH - (int) - - - - - - - - - - <constant>NOISE_<replaceable>*</replaceable></constant> constants - - - - imagick::NOISE_UNIFORM - (int) - - - - - - - - - imagick::NOISE_GAUSSIAN - (int) - - - - - - - - - imagick::NOISE_MULTIPLICATIVEGAUSSIAN - (int) - - - - - - - - - imagick::NOISE_IMPULSE - (int) - - - - - - - - - imagick::NOISE_LAPLACIAN - (int) - - - - - - - - - imagick::NOISE_POISSON - (int) - - - - - - - - - imagick::NOISE_RANDOM - (int) - - - - &imagick.constant.available; 6.3.6 or higher. - - - - - - - <constant>CHANNEL_<replaceable>*</replaceable></constant> constants - - - - imagick::CHANNEL_UNDEFINED - (int) - - - - - - - - - imagick::CHANNEL_RED - (int) - - - - - - - - - imagick::CHANNEL_GRAY - (int) - - - - - - - - - imagick::CHANNEL_CYAN - (int) - - - - - - - - - imagick::CHANNEL_GREEN - (int) - - - - - - - - - imagick::CHANNEL_MAGENTA - (int) - - - - - - - - - imagick::CHANNEL_BLUE - (int) - - - - - - - - - imagick::CHANNEL_YELLOW - (int) - - - - - - - - - imagick::CHANNEL_ALPHA - (int) - - - - - - - - - imagick::CHANNEL_OPACITY - (int) - - - - - - - - - imagick::CHANNEL_MATTE - (int) - - - - - - - - - imagick::CHANNEL_BLACK - (int) - - - - - - - - - imagick::CHANNEL_INDEX - (int) - - - - - - - - - imagick::CHANNEL_ALL - (int) - - - - - - - - - imagick::CHANNEL_DEFAULT - (int) - - - - - - - - - - <constant>METRIC_<replaceable>*</replaceable></constant> constants - - - - imagick::METRIC_UNDEFINED - (int) - - - - - - - - - imagick::METRIC_MEANABSOLUTEERROR - (int) - - - - - - - - - imagick::METRIC_MEANSQUAREERROR - (int) - - - - - - - - - imagick::METRIC_PEAKABSOLUTEERROR - (int) - - - - - - - - - imagick::METRIC_PEAKSIGNALTONOISERATIO - (int) - - - - - - - - - imagick::METRIC_ROOTMEANSQUAREDERROR - (int) - - - - - - - - - - <constant>PIXEL_<replaceable>*</replaceable></constant> constants - - - - imagick::PIXEL_CHAR - (int) - - - - - - - - - imagick::PIXEL_DOUBLE - (int) - - - - - - - - - imagick::PIXEL_FLOAT - (int) - - - - - - - - - imagick::PIXEL_INTEGER - (int) - - - - Only available for ImageMagick < 7. - - - - - - imagick::PIXEL_LONG - (int) - - - - - - - - - imagick::PIXEL_QUANTUM - (int) - - - - - - - - - imagick::PIXEL_SHORT - (int) - - - - - - - - - - <constant>EVALUATE_<replaceable>*</replaceable></constant> constants - - - - imagick::EVALUATE_UNDEFINED - (int) - - - - - - - - - imagick::EVALUATE_ADD - (int) - - - - - - - - - imagick::EVALUATE_AND - (int) - - - - - - - - - imagick::EVALUATE_DIVIDE - (int) - - - - - - - - - imagick::EVALUATE_LEFTSHIFT - (int) - - - - - - - - - imagick::EVALUATE_MAX - (int) - - - - - - - - - imagick::EVALUATE_MIN - (int) - - - - - - - - - imagick::EVALUATE_MULTIPLY - (int) - - - - - - - - - imagick::EVALUATE_OR - (int) - - - - - - - - - imagick::EVALUATE_RIGHTSHIFT - (int) - - - - - - - - - imagick::EVALUATE_SET - (int) - - - - - - - - - imagick::EVALUATE_SUBTRACT - (int) - - - - - - - - - imagick::EVALUATE_XOR - (int) - - - - - - - - - imagick::EVALUATE_POW - (int) - - - - &imagick.constant.available; 6.4.4 or higher. - - - - - - imagick::EVALUATE_LOG - (int) - - - - &imagick.constant.available; 6.4.4 or higher. - - - - - - imagick::EVALUATE_THRESHOLD - (int) - - - - &imagick.constant.available; 6.4.4 or higher. - - - - - - imagick::EVALUATE_THRESHOLDBLACK - (int) - - - - &imagick.constant.available; 6.4.4 or higher. - - - - - - imagick::EVALUATE_THRESHOLDWHITE - (int) - - - - &imagick.constant.available; 6.4.4 or higher. - - - - - - imagick::EVALUATE_GAUSSIANNOISE - (int) - - - - &imagick.constant.available; 6.4.4 or higher. - - - - - - imagick::EVALUATE_IMPULSENOISE - (int) - - - - &imagick.constant.available; 6.4.4 or higher. - - - - - - imagick::EVALUATE_LAPLACIANNOISE - (int) - - - - &imagick.constant.available; 6.4.4 or higher. - - - - - - imagick::EVALUATE_MULTIPLICATIVENOISE - (int) - - - - &imagick.constant.available; 6.4.4 or higher. - - - - - - imagick::EVALUATE_POISSONNOISE - (int) - - - - &imagick.constant.available; 6.4.4 or higher. - - - - - - imagick::EVALUATE_UNIFORMNOISE - (int) - - - - &imagick.constant.available; 6.4.4 or higher. - - - - - - imagick::EVALUATE_COSINE - (int) - - - - &imagick.constant.available; 6.4.4 or higher. - - - - - - imagick::EVALUATE_SINE - (int) - - - - &imagick.constant.available; 6.4.4 or higher. - - - - - - imagick::EVALUATE_ADDMODULUS - (int) - - - - &imagick.constant.available; 6.4.4 or higher. - - - - - - - <constant>COLORSPACE_<replaceable>*</replaceable></constant> constants - - - - imagick::COLORSPACE_UNDEFINED - (int) - - - - - - - - - imagick::COLORSPACE_RGB - (int) - - - - - - - - - imagick::COLORSPACE_GRAY - (int) - - - - - - - - - imagick::COLORSPACE_TRANSPARENT - (int) - - - - - - - - - imagick::COLORSPACE_OHTA - (int) - - - - - - - - - imagick::COLORSPACE_LAB - (int) - - - - - - - - - imagick::COLORSPACE_XYZ - (int) - - - - - - - - - imagick::COLORSPACE_YCBCR - (int) - - - - - - - - - imagick::COLORSPACE_YCC - (int) - - - - - - - - - imagick::COLORSPACE_YIQ - (int) - - - - - - - - - imagick::COLORSPACE_YPBPR - (int) - - - - - - - - - imagick::COLORSPACE_YUV - (int) - - - - - - - - - imagick::COLORSPACE_CMYK - (int) - - - - - - - - - imagick::COLORSPACE_SRGB - (int) - - - - - - - - - imagick::COLORSPACE_HSB - (int) - - - - - - - - - imagick::COLORSPACE_HSL - (int) - - - - - - - - - imagick::COLORSPACE_HWB - (int) - - - - - - - - - imagick::COLORSPACE_REC601LUMA - (int) - - - - - - - - - imagick::COLORSPACE_REC709LUMA - (int) - - - - - - - - - imagick::COLORSPACE_LOG - (int) - - - - - - - - - imagick::COLORSPACE_CMY - (int) - - - - &imagick.constant.available; 6.4.2 or higher. - - - - - - - <constant>VIRTUALPIXELMETHOD_<replaceable>*</replaceable></constant> constants - - - - imagick::VIRTUALPIXELMETHOD_UNDEFINED - (int) - - - - - - - - - imagick::VIRTUALPIXELMETHOD_BACKGROUND - (int) - - - - - - - - - imagick::VIRTUALPIXELMETHOD_CONSTANT - (int) - - - - - - - - - imagick::VIRTUALPIXELMETHOD_EDGE - (int) - - - - - - - - - imagick::VIRTUALPIXELMETHOD_MIRROR - (int) - - - - - - - - - imagick::VIRTUALPIXELMETHOD_TILE - (int) - - - - - - - - - imagick::VIRTUALPIXELMETHOD_TRANSPARENT - (int) - - - - - - - - - imagick::VIRTUALPIXELMETHOD_MASK - (int) - - - - &imagick.constant.available; 6.4.2 or higher. - - - - - - imagick::VIRTUALPIXELMETHOD_BLACK - (int) - - - - &imagick.constant.available; 6.4.2 or higher. - - - - - - imagick::VIRTUALPIXELMETHOD_GRAY - (int) - - - - &imagick.constant.available; 6.4.2 or higher. - - - - - - imagick::VIRTUALPIXELMETHOD_WHITE - (int) - - - - &imagick.constant.available; 6.4.2 or higher. - - - - - - imagick::VIRTUALPIXELMETHOD_HORIZONTALTILE - (int) - - - - &imagick.constant.available; 6.4.3 or higher. - - - - - - imagick::VIRTUALPIXELMETHOD_VERTICALTILE - (int) - - - - &imagick.constant.available; 6.4.3 or higher. - - - - - - - <constant>PREVIEW_<replaceable>*</replaceable></constant> constants - - - - imagick::PREVIEW_UNDEFINED - (int) - - - - - - - - - imagick::PREVIEW_ROTATE - (int) - - - - - - - - - imagick::PREVIEW_SHEAR - (int) - - - - - - - - - imagick::PREVIEW_ROLL - (int) - - - - - - - - - imagick::PREVIEW_HUE - (int) - - - - - - - - - imagick::PREVIEW_SATURATION - (int) - - - - - - - - - imagick::PREVIEW_BRIGHTNESS - (int) - - - - - - - - - imagick::PREVIEW_GAMMA - (int) - - - - - - - - - imagick::PREVIEW_SPIFF - (int) - - - - - - - - - imagick::PREVIEW_DULL - (int) - - - - - - - - - imagick::PREVIEW_GRAYSCALE - (int) - - - - - - - - - imagick::PREVIEW_QUANTIZE - (int) - - - - - - - - - imagick::PREVIEW_DESPECKLE - (int) - - - - - - - - - imagick::PREVIEW_REDUCENOISE - (int) - - - - - - - - - imagick::PREVIEW_ADDNOISE - (int) - - - - - - - - - imagick::PREVIEW_SHARPEN - (int) - - - - - - - - - imagick::PREVIEW_BLUR - (int) - - - - - - - - - imagick::PREVIEW_THRESHOLD - (int) - - - - - - - - - imagick::PREVIEW_EDGEDETECT - (int) - - - - - - - - - imagick::PREVIEW_SPREAD - (int) - - - - - - - - - imagick::PREVIEW_SOLARIZE - (int) - - - - - - - - - imagick::PREVIEW_SHADE - (int) - - - - - - - - - imagick::PREVIEW_RAISE - (int) - - - - - - - - - imagick::PREVIEW_SEGMENT - (int) - - - - - - - - - imagick::PREVIEW_SWIRL - (int) - - - - - - - - - imagick::PREVIEW_IMPLODE - (int) - - - - - - - - - imagick::PREVIEW_WAVE - (int) - - - - - - - - - imagick::PREVIEW_OILPAINT - (int) - - - - - - - - - imagick::PREVIEW_CHARCOALDRAWING - (int) - - - - - - - - - imagick::PREVIEW_JPEG - (int) - - - - - - - - - - <constant>RENDERINGINTENT_<replaceable>*</replaceable></constant> constants - - - - imagick::RENDERINGINTENT_UNDEFINED - (int) - - - - - - - - - imagick::RENDERINGINTENT_SATURATION - (int) - - - - - - - - - imagick::RENDERINGINTENT_PERCEPTUAL - (int) - - - - - - - - - imagick::RENDERINGINTENT_ABSOLUTE - (int) - - - - - - - - - imagick::RENDERINGINTENT_RELATIVE - (int) - - - - - - - - - - <constant>INTERLACE_<replaceable>*</replaceable></constant> constants - - - - imagick::INTERLACE_UNDEFINED - (int) - - - - - - - - - imagick::INTERLACE_NO - (int) - - - - - - - - - imagick::INTERLACE_LINE - (int) - - - - - - - - - imagick::INTERLACE_PLANE - (int) - - - - - - - - - imagick::INTERLACE_PARTITION - (int) - - - - - - - - - imagick::INTERLACE_GIF - (int) - - - - &imagick.constant.available; 6.3.4 or higher. - - - - - - imagick::INTERLACE_JPEG - (int) - - - - - - - - - imagick::INTERLACE_PNG - (int) - - - - - - - - - - <constant>FILLRULE_<replaceable>*</replaceable></constant> constants - - - - imagick::FILLRULE_UNDEFINED - (int) - - - - - - - - - imagick::FILLRULE_EVENODD - (int) - - - - - - - - - imagick::FILLRULE_NONZERO - (int) - - - - - - - - - - <constant>PATHUNITS_<replaceable>*</replaceable></constant> constants - - - - imagick::PATHUNITS_UNDEFINED - (int) - - - - - - - - - imagick::PATHUNITS_USERSPACE - (int) - - - - - - - - - imagick::PATHUNITS_USERSPACEONUSE - (int) - - - - - - - - - imagick::PATHUNITS_OBJECTBOUNDINGBOX - (int) - - - - - - - - - - <constant>LINECAP_<replaceable>*</replaceable></constant> constants - - - - imagick::LINECAP_UNDEFINED - (int) - - - - - - - - - imagick::LINECAP_BUTT - (int) - - - - - - - - - imagick::LINECAP_ROUND - (int) - - - - - - - - - imagick::LINECAP_SQUARE - (int) - - - - - - - - - - <constant>LINEJOIN_<replaceable>*</replaceable></constant> constants - - - - imagick::LINEJOIN_UNDEFINED - (int) - - - - - - - - - imagick::LINEJOIN_MITER - (int) - - - - - - - - - imagick::LINEJOIN_ROUND - (int) - - - - - - - - - imagick::LINEJOIN_BEVEL - (int) - - - - - - - - - - <constant>RESOURCETYPE_<replaceable>*</replaceable></constant> constants - - - - imagick::RESOURCETYPE_UNDEFINED - (int) - - - - - - - - - imagick::RESOURCETYPE_AREA - (int) - - - - Set the maximum width * height of an image that can reside in the pixel cache memory. - - - - - - imagick::RESOURCETYPE_DISK - (int) - - - - Set maximum amount of disk space in bytes permitted for use by the pixel cache. - - - - - - imagick::RESOURCETYPE_FILE - (int) - - - - Set maximum number of open pixel cache files. - - - - - - imagick::RESOURCETYPE_MAP - (int) - - - - Set maximum amount of memory map in bytes to allocate for the pixel cache. - - - - - - imagick::RESOURCETYPE_MEMORY - (int) - - - - Set maximum amount of memory in bytes to allocate for the pixel cache from the heap. - - - - - - imagick::RESOURCETYPE_THREAD - (int) - - - - Set maximum parallel threads. - &imagick.constant.available; 6.7.8 or higher. - - - - - - - <constant>LAYERMETHOD_<replaceable>*</replaceable></constant> constants - - - - imagick::LAYERMETHOD_UNDEFINED - (int) - - - - &imagick.constant.available; 6.2.9 or higher. - - - - - - imagick::LAYERMETHOD_COALESCE - (int) - - - - &imagick.constant.available; 6.2.9 or higher. - - - - - - imagick::LAYERMETHOD_COMPAREANY - (int) - - - - &imagick.constant.available; 6.2.9 or higher. - - - - - - imagick::LAYERMETHOD_COMPARECLEAR - (int) - - - - &imagick.constant.available; 6.2.9 or higher. - - - - - - imagick::LAYERMETHOD_COMPAREOVERLAY - (int) - - - - &imagick.constant.available; 6.2.9 or higher. - - - - - - imagick::LAYERMETHOD_DISPOSE - (int) - - - - &imagick.constant.available; 6.2.9 or higher. - - - - - - imagick::LAYERMETHOD_OPTIMIZE - (int) - - - - &imagick.constant.available; 6.2.9 or higher. - - - - - - imagick::LAYERMETHOD_OPTIMIZEPLUS - (int) - - - - &imagick.constant.available; 6.2.9 or higher. - - - - - - imagick::LAYERMETHOD_OPTIMIZEIMAGE - (int) - - - - &imagick.constant.available; 6.3.0 or higher. - - - - - - imagick::LAYERMETHOD_OPTIMIZETRANS - (int) - - - - &imagick.constant.available; 6.3.0 or higher. - - - - - - imagick::LAYERMETHOD_REMOVEDUPS - (int) - - - - &imagick.constant.available; 6.3.0 or higher. - - - - - - imagick::LAYERMETHOD_REMOVEZERO - (int) - - - - &imagick.constant.available; 6.3.0 or higher. - - - - - - imagick::LAYERMETHOD_COMPOSITE - (int) - - - - &imagick.constant.available; 6.3.0 or higher. - - - - - - imagick::LAYERMETHOD_MERGE - (int) - - - - &imagick.constant.available; 6.3.7 or higher. - - - - - - imagick::LAYERMETHOD_FLATTEN - (int) - - - - &imagick.constant.available; 6.3.7 or higher. - - - - - - imagick::LAYERMETHOD_MOSAIC - (int) - - - - &imagick.constant.available; 6.3.7 or higher. - - - - - - - <constant>ORIENTATION_<replaceable>*</replaceable></constant> constants - - - - imagick::ORIENTATION_UNDEFINED - (int) - - - - &imagick.constant.available; 6.3.0 or higher. - - - - - - imagick::ORIENTATION_TOPLEFT - (int) - - - - &imagick.constant.available; 6.3.0 or higher. - - - - - - imagick::ORIENTATION_TOPRIGHT - (int) - - - - &imagick.constant.available; 6.3.0 or higher. - - - - - - imagick::ORIENTATION_BOTTOMRIGHT - (int) - - - - &imagick.constant.available; 6.3.0 or higher. - - - - - - imagick::ORIENTATION_BOTTOMLEFT - (int) - - - - &imagick.constant.available; 6.3.0 or higher. - - - - - - imagick::ORIENTATION_LEFTTOP - (int) - - - - &imagick.constant.available; 6.3.0 or higher. - - - - - - imagick::ORIENTATION_RIGHTTOP - (int) - - - - &imagick.constant.available; 6.3.0 or higher. - - - - - - imagick::ORIENTATION_RIGHTBOTTOM - (int) - - - - &imagick.constant.available; 6.3.0 or higher. - - - - - - imagick::ORIENTATION_LEFTBOTTOM - (int) - - - - &imagick.constant.available; 6.3.0 or higher. - - - - - - - <constant>DISTORTION_<replaceable>*</replaceable></constant> constants - - - - imagick::DISTORTION_UNDEFINED - (int) - - - - &imagick.constant.available; 6.3.6 or higher. - - - - - - imagick::DISTORTION_AFFINE - (int) - - - - &imagick.constant.available; 6.3.6 or higher. - - - - - - imagick::DISTORTION_AFFINEPROJECTION - (int) - - - - &imagick.constant.available; 6.3.6 or higher. - - - - - - imagick::DISTORTION_ARC - (int) - - - - &imagick.constant.available; 6.3.6 or higher. - - - - - - imagick::DISTORTION_BILINEAR - (int) - - - - &imagick.constant.available; 6.3.6 or higher. - - - - - - imagick::DISTORTION_PERSPECTIVE - (int) - - - - &imagick.constant.available; 6.3.6 or higher. - - - - - - imagick::DISTORTION_PERSPECTIVEPROJECTION - (int) - - - - &imagick.constant.available; 6.3.6 or higher. - - - - - - imagick::DISTORTION_SCALEROTATETRANSLATE - (int) - - - - &imagick.constant.available; 6.3.6 or higher. - - - - - - imagick::DISTORTION_POLYNOMIAL - (int) - - - - &imagick.constant.available; 6.4.6 or higher. - - - - - - imagick::DISTORTION_POLAR - (int) - - - - &imagick.constant.available; 6.4.6 or higher. - - - - - - imagick::DISTORTION_DEPOLAR - (int) - - - - &imagick.constant.available; 6.4.6 or higher. - - - - - - imagick::DISTORTION_BARREL - (int) - - - - &imagick.constant.available; 6.4.6 or higher. - - - - - - imagick::DISTORTION_BARRELINVERSE - (int) - - - - &imagick.constant.available; 6.4.6 or higher. - - - - - - imagick::DISTORTION_SHEPARDS - (int) - - - - &imagick.constant.available; 6.4.6 or higher. - - - - - - imagick::DISTORTION_SENTINEL - (int) - - - - &imagick.constant.available; 6.4.6 or higher. - - - - - - - <constant>ALPHACHANNEL_<replaceable>*</replaceable></constant> constants - - - - imagick::ALPHACHANNEL_ACTIVATE - (int) - - - - &imagick.constant.available; 6.3.8 or higher. - - - - - - imagick::ALPHACHANNEL_DEACTIVATE - (int) - - - - &imagick.constant.available; 6.3.8 or higher. - - - - - - imagick::ALPHACHANNEL_RESET - (int) - - - - &imagick.constant.available; 6.3.8 or higher. - - - - - - imagick::ALPHACHANNEL_SET - (int) - - - - &imagick.constant.available; 6.3.8 or higher. - - - - - - imagick::ALPHACHANNEL_UNDEFINED - (int) - - - - &imagick.constant.available; 6.4.6 or higher. - - - - - - imagick::ALPHACHANNEL_COPY - (int) - - - - &imagick.constant.available; 6.4.6 or higher. - - - - - - imagick::ALPHACHANNEL_EXTRACT - (int) - - - - &imagick.constant.available; 6.4.6 or higher. - - - - - - imagick::ALPHACHANNEL_OPAQUE - (int) - - - - &imagick.constant.available; 6.4.6 or higher. - - - - - - imagick::ALPHACHANNEL_SHAPE - (int) - - - - &imagick.constant.available; 6.4.6 or higher. - - - - - - imagick::ALPHACHANNEL_TRANSPARENT - (int) - - - - &imagick.constant.available; 6.4.6 or higher. - - - - - - imagick::ALPHACHANNEL_BACKGROUND - (int) - - - - &imagick.constant.available; 6.5.3 or higher. - - - - - - imagick::ALPHACHANNEL_REMOVE - (int) - - - - &imagick.constant.available; 6.7.8 or higher. - - - - - - imagick::ALPHACHANNEL_ASSOCIATE - (int) - - - - &imagick.constant.available; 6.9.0 or higher. - - - - - - imagick::ALPHACHANNEL_DISSOCIATE - (int) - - - - &imagick.constant.available; 6.9.0 or higher. - - - - - - imagick::ALPHACHANNEL_ON - (int) - - - - &imagick.constant.available; 7.0.0 or higher. - - - - - - imagick::ALPHACHANNEL_OFF - (int) - - - - &imagick.constant.available; 7.0.0 or higher. - - - - - - imagick::ALPHACHANNEL_DISCRETE - (int) - - - - &imagick.constant.available; 7.0.0 or higher. - - - - - - - <constant>SPARSECOLORMETHOD_<replaceable>*</replaceable></constant> constants - - - - imagick::SPARSECOLORMETHOD_UNDEFINED - (int) - - - - &imagick.constant.available; 6.4.6 or higher. - - - - - - imagick::SPARSECOLORMETHOD_BARYCENTRIC - (int) - - - - &imagick.constant.available; 6.4.6 or higher. - - - - - - imagick::SPARSECOLORMETHOD_BILINEAR - (int) - - - - &imagick.constant.available; 6.4.6 or higher. - - - - - - imagick::SPARSECOLORMETHOD_POLYNOMIAL - (int) - - - - &imagick.constant.available; 6.4.6 or higher. - - - - - - imagick::SPARSECOLORMETHOD_SPEPARDS - (int) - - - - &imagick.constant.available; 6.4.6 or higher. - - - - - - imagick::SPARSECOLORMETHOD_VORONOI - (int) - - - - &imagick.constant.available; 6.4.6 or higher. - - - - - - - <constant>FUNCTION_<replaceable>*</replaceable></constant> constants - - - - imagick::FUNCTION_UNDEFINED - (int) - - - - &imagick.constant.available; 6.4.9 or higher. - - - - - - imagick::FUNCTION_POLYNOMIAL - (int) - - - - &imagick.constant.available; 6.4.9 or higher. - - - - - - imagick::FUNCTION_SINUSOID - (int) - - - - &imagick.constant.available; 6.4.9 or higher. - - - - - - - <constant>INTERPOLATE_<replaceable>*</replaceable></constant> constants - - - - imagick::INTERPOLATE_UNDEFINED - (int) - - - - &imagick.constant.available; 6.3.2 or higher. - - - - - - imagick::INTERPOLATE_AVERAGE - (int) - - - - &imagick.constant.available; 6.3.2 or higher. - - - - - - imagick::INTERPOLATE_BICUBIC - (int) - - - - &imagick.constant.available; 6.3.2 or higher. - - - - - - imagick::INTERPOLATE_BILINEAR - (int) - - - - &imagick.constant.available; 6.3.2 or higher. - - - - - - imagick::INTERPOLATE_FILTER - (int) - - - - &imagick.constant.available; 6.3.2 or higher. - - - - - - imagick::INTERPOLATE_INTEGER - (int) - - - - &imagick.constant.available; 6.3.2 or higher. - - - - - - imagick::INTERPOLATE_MESH - (int) - - - - &imagick.constant.available; 6.3.2 or higher. - - - - - - imagick::INTERPOLATE_NEARESTNEIGHBOR - (int) - - - - &imagick.constant.available; 6.3.2 or higher. - - - - - - imagick::INTERPOLATE_SPLINE - (int) - - - - &imagick.constant.available; 6.3.4 or higher. - - - - - - - <constant>DITHERMETHOD_<replaceable>*</replaceable></constant> constants - - - - imagick::DITHERMETHOD_UNDEFINED - (int) - - - - &imagick.constant.available; 6.4.6 or higher. - - - - - - imagick::DITHERMETHOD_NO - (int) - - - - &imagick.constant.available; 6.4.6 or higher. - - - - - - imagick::DITHERMETHOD_RIEMERSMA - (int) - - - - &imagick.constant.available; 6.4.6 or higher. - - - - - - imagick::DITHERMETHOD_FLOYDSTEINBERG - (int) - - - - &imagick.constant.available; 6.4.6 or higher. - - - - - - - diff --git a/reference/imagick/examples.xml b/reference/imagick/examples.xml deleted file mode 100644 index 868f0596b54e..000000000000 --- a/reference/imagick/examples.xml +++ /dev/null @@ -1,273 +0,0 @@ - - - - - &reftitle.examples; -
- Basic usage - - Imagick makes image manipulation in PHP extremely easy through an OO - interface. Here is a quick example on how to make a thumbnail: - - Creating a thumbnail in Imagick - -thumbnailImage(100, 0); - -echo $image; - -?> -]]> - - - - - - Using SPL and other OO features supported in Imagick, it can be simple - to resize all files in a directory (useful for batch resizing large - digital camera images to be web viewable). Here we use resize, as we might - want to retain certain meta-data: - - Make a thumbnail of all JPG files in a directory - -thumbnailImage(1024,0); - -} - -$images->writeImages(); - -?> -]]> - - - - - This is an example of creating a reflection of an image. - The reflection is created by flipping the image and overlaying a gradient on it. - Then both, the original image and the reflection is overlaid on a canvas. - - Creating a reflection of an image - -thumbnailImage(200, null); - -/* Create a border for the image */ -$im->borderImage(new ImagickPixel("white"), 5, 5); - -/* Clone the image and flip it */ -$reflection = $im->clone(); -$reflection->flipImage(); - -/* Create gradient. It will be overlaid on the reflection */ -$gradient = new Imagick(); - -/* Gradient needs to be large enough for the image and the borders */ -$gradient->newPseudoImage($reflection->getImageWidth() + 10, $reflection->getImageHeight() + 10, "gradient:transparent-black"); - -/* Composite the gradient on the reflection */ -$reflection->compositeImage($gradient, imagick::COMPOSITE_OVER, 0, 0); - -/* Add some opacity. Requires ImageMagick 6.2.9 or later */ -$reflection->setImageOpacity( 0.3 ); - -/* Create an empty canvas */ -$canvas = new Imagick(); - -/* Canvas needs to be large enough to hold the both images */ -$width = $im->getImageWidth() + 40; -$height = ($im->getImageHeight() * 2) + 30; -$canvas->newImage($width, $height, new ImagickPixel("black")); -$canvas->setImageFormat("png"); - -/* Composite the original image and the reflection on the canvas */ -$canvas->compositeImage($im, imagick::COMPOSITE_OVER, 20, 10); -$canvas->compositeImage($reflection, imagick::COMPOSITE_OVER, 20, $im->getImageHeight() + 10); - -/* Output the image*/ -header("Content-Type: image/png"); -echo $canvas; -?> -]]> - - &example.outputs.similar; - - Output of example : Creating a reflection of an image - - - - - - - - This example illustrates how to use fill patterns during drawing. - - Filling text with gradient - -newPseudoImage(50, 50, "gradient:red-black"); - -/* Create imagickdraw object */ -$draw = new ImagickDraw(); - -/* Start a new pattern called "gradient" */ -$draw->pushPattern('gradient', 0, 0, 50, 50); - -/* Composite the gradient on the pattern */ -$draw->composite(Imagick::COMPOSITE_OVER, 0, 0, 50, 50, $im); - -/* Close the pattern */ -$draw->popPattern(); - -/* Use the pattern called "gradient" as the fill */ -$draw->setFillPatternURL('#gradient'); - -/* Set font size to 52 */ -$draw->setFontSize(52); - -/* Annotate some text */ -$draw->annotation(20, 50, "Hello World!"); - -/* Create a new canvas object and a white image */ -$canvas = new Imagick(); -$canvas->newImage(350, 70, "white"); - -/* Draw the ImagickDraw on to the canvas */ -$canvas->drawImage($draw); - -/* 1px black border around the image */ -$canvas->borderImage('black', 1, 1); - -/* Set the format to PNG */ -$canvas->setImageFormat('png'); - -/* Output the image */ -header("Content-Type: image/png"); -echo $canvas; -?> -]]> - - &example.outputs.similar; - - Output of example : Filling text with gradient - - - - - - - - Working with animated GIF images - - Read in GIF image and resize all frames - -thumbnailImage(50, 50); - - /* Set the virtual canvas to correct size */ - $frame->setImagePage(50, 50, 0, 0); -} - -/* Notice writeImages instead of writeImage */ -$im->writeImages("example_small.gif", true); -?> -]]> - - - - - Working with ellipse primitive and custom fonts - - Create a PHP logo - -newImage($width, $height, new ImagickPixel('transparent')); - -/* New ImagickDraw instance for ellipse draw */ -$draw = new ImagickDraw(); -/* Set purple fill color for ellipse */ -$draw->setFillColor('#777bb4'); -/* Set ellipse dimensions */ -$draw->ellipse($width / 2, $height / 2, $width / 2, $height / 2, 0, 360); -/* Draw ellipse onto the canvas */ -$img->drawImage($draw); - -/* Reset fill color from purple to black for text (note: we are reusing ImagickDraw object) */ -$draw->setFillColor('black'); -/* Set stroke border to white color */ -$draw->setStrokeColor('white'); -/* Set stroke border thickness */ -$draw->setStrokeWidth(2); -/* Set font kerning (negative value means that letters are closer to each other) */ -$draw->setTextKerning(-8); -/* Set font and font size used in PHP logo */ -$draw->setFont('Handel Gothic.ttf'); -$draw->setFontSize(150); -/* Center text horizontally and vertically */ -$draw->setGravity(Imagick::GRAVITY_CENTER); - -/* Add center "php" with Y offset of -10 to canvas (inside ellipse) */ -$img->annotateImage($draw, 0, -10, 0, 'php'); -$img->setImageFormat('png'); - -/* Set appropriate header for PNG and output the image */ -header('Content-Type: image/png'); -echo $img; -?> - -]]> - - &example.outputs.similar; - - Output of example : Creating PHP logo with Imagick - - - - - - -
-
- - diff --git a/reference/imagick/figures/adaptiveBlurImage.gif b/reference/imagick/figures/adaptiveBlurImage.gif deleted file mode 100644 index b4e9983809fc..000000000000 Binary files a/reference/imagick/figures/adaptiveBlurImage.gif and /dev/null differ diff --git a/reference/imagick/figures/distortImage.png b/reference/imagick/figures/distortImage.png deleted file mode 100644 index 27adef457070..000000000000 Binary files a/reference/imagick/figures/distortImage.png and /dev/null differ diff --git a/reference/imagick/figures/floodfillpaint_intermediate.png b/reference/imagick/figures/floodfillpaint_intermediate.png deleted file mode 100644 index 2e9cb81cd6db..000000000000 Binary files a/reference/imagick/figures/floodfillpaint_intermediate.png and /dev/null differ diff --git a/reference/imagick/figures/floodfillpaint_result.png b/reference/imagick/figures/floodfillpaint_result.png deleted file mode 100644 index 1962c91e8e28..000000000000 Binary files a/reference/imagick/figures/floodfillpaint_result.png and /dev/null differ diff --git a/reference/imagick/figures/functionImage_multiplied.png b/reference/imagick/figures/functionImage_multiplied.png deleted file mode 100644 index 5ab530924489..000000000000 Binary files a/reference/imagick/figures/functionImage_multiplied.png and /dev/null differ diff --git a/reference/imagick/figures/functionImage_polynomial.png b/reference/imagick/figures/functionImage_polynomial.png deleted file mode 100644 index 937e4b794ffd..000000000000 Binary files a/reference/imagick/figures/functionImage_polynomial.png and /dev/null differ diff --git a/reference/imagick/figures/functionImage_sinusoidal.png b/reference/imagick/figures/functionImage_sinusoidal.png deleted file mode 100644 index 46e68a02b763..000000000000 Binary files a/reference/imagick/figures/functionImage_sinusoidal.png and /dev/null differ diff --git a/reference/imagick/figures/hello_world.png b/reference/imagick/figures/hello_world.png deleted file mode 100644 index 3af4829e214a..000000000000 Binary files a/reference/imagick/figures/hello_world.png and /dev/null differ diff --git a/reference/imagick/figures/hello_world_reflection.png b/reference/imagick/figures/hello_world_reflection.png deleted file mode 100644 index b25f3211ebb0..000000000000 Binary files a/reference/imagick/figures/hello_world_reflection.png and /dev/null differ diff --git a/reference/imagick/figures/importimagepixels.jpg b/reference/imagick/figures/importimagepixels.jpg deleted file mode 100644 index c1580cc90fe7..000000000000 Binary files a/reference/imagick/figures/importimagepixels.jpg and /dev/null differ diff --git a/reference/imagick/figures/php_logo.png b/reference/imagick/figures/php_logo.png deleted file mode 100644 index d03c91fa1207..000000000000 Binary files a/reference/imagick/figures/php_logo.png and /dev/null differ diff --git a/reference/imagick/imagick.xml b/reference/imagick/imagick.xml deleted file mode 100644 index 2f24c5dd4511..000000000000 --- a/reference/imagick/imagick.xml +++ /dev/null @@ -1,770 +0,0 @@ - - - - The <classname>Imagick</classname> class - Imagick - -
- &reftitle.classsynopsis; - - Imagick - - Imagick - - Iterator - - - - - -
- -
- Image methods and global methods - - The Imagick class has the ability to hold and operate on multiple - images simultaneously. This is achieved through an internal stack. There - is always an internal pointer that points at the current image. Some - functions operate on all images in the Imagick class, but most operate - only on the current image in the internal stack. As a convention, method - names can contain the word Image to denote they affect only the current - image in the stack. - -
- -
- Class Methods - - Because there are so many methods, here is a handy list of methods, - somewhat reduced to their general purpose: - - - - Class methods by purpose - - - - Image effects - Get methods - Set methods - Read/write images - Other - - - - - - Imagick::adaptiveBlurImage - Imagick::getCompression - Imagick::setBackgroundColor - Imagick::__construct - Imagick::clear - - - Imagick::adaptiveResizeImage - Imagick::getFilename - Imagick::setCompressionQuality - Imagick::addImage - Imagick::clone - - - Imagick::adaptiveSharpenImage - Imagick::getFormat - Imagick::setCompression - Imagick::appendImages - Imagick::current - - - Imagick::adaptiveThresholdImage - Imagick::getImageBackgroundColor - Imagick::setFilename - Imagick::getFilename - Imagick::destroy - - - Imagick::addNoiseImage - Imagick::getImageBlob - Imagick::getImagesBlob - Imagick::setFormat - Imagick::getFormat - - - Imagick::affinetransformimage - Imagick::getImageBluePrimary - Imagick::setImageBackgroundColor - Imagick::getImageFilename - Imagick::getHomeURL - - - Imagick::annotateImage - Imagick::getImageBorderColor - Imagick::setFirstIterator - Imagick::getImageFormat - Imagick::commentImage - - - Imagick::averageImages - Imagick::getImageChannelDepth - Imagick::setImageBias - Imagick::getImage - Imagick::getNumberImages - - - Imagick::blackThresholdImage - Imagick::getImageChannelDistortion - Imagick::setImageBluePrimary - Imagick::setImageFilename - Imagick::getReleaseDate - - - Imagick::blurImage - Imagick::getImageChannelExtrema - Imagick::setImageBorderColor - Imagick::setImageFormat - Imagick::getVersion - - - Imagick::borderImage - Imagick::getImageChannelMean - Imagick::setImageChannelDepth - Imagick::readImageFile - Imagick::hasNextImage - - - Imagick::charcoalImage - Imagick::getImageChannelStatistics - Imagick::setImageColormapColor - Imagick::readImage - Imagick::hasPreviousImage - - - Imagick::chopImage - Imagick::getImageColormapColor - Imagick::setImageColorSpace - Imagick::writeImages - Imagick::labelImage - - - Imagick::clipImage - Imagick::getImageColorspace - Imagick::setImageCompose - Imagick::writeImage - Imagick::newImage - - - Imagick::clipPathImage - Imagick::getImageColors - Imagick::setImageCompression - - Imagick::newPseudoImage - - - Imagick::coalesceImages - Imagick::getImageCompose - Imagick::setImageDelay - - Imagick::nextImage - - - Imagick::colorFloodFillImage - Imagick::getImageDelay - Imagick::setImageDepth - - Imagick::pingImageBlob - - - Imagick::colorizeImage - Imagick::getImageDepth - Imagick::setImageDispose - - Imagick::pingImageFile - - - Imagick::combineImages - Imagick::getImageDispose - Imagick::setImageDispose - - Imagick::pingImage - - - Imagick::compareImageChannels - Imagick::getImageDistortion - Imagick::setImageExtent - - Imagick::previousImage - - - Imagick::compareImageLayers - Imagick::getImageExtrema - Imagick::setImageFilename - - Imagick::profileImage - - - Imagick::compositeImage - Imagick::getImageFilename - Imagick::setImageFormat - - Imagick::queryFormats - - - Imagick::contrastImage - Imagick::getImageFormat - Imagick::setImageGamma - - Imagick::removeImageProfile - - - Imagick::contrastStretchImage - Imagick::getImageGamma - Imagick::setImageGreenPrimary - - Imagick::removeImage - - - Imagick::convolveImage - Imagick::getImageGeometry - Imagick::setImageIndex - - Imagick::setFirstIterator - - - Imagick::cropImage - Imagick::getImageGreenPrimary - Imagick::setImageInterpolateMethod - - Imagick::setImageIndex - - - Imagick::cycleColormapImage - Imagick::getImageHeight - Imagick::setImageIterations - - Imagick::valid - - - Imagick::deconstructImages - Imagick::getImageHistogram - Imagick::setImageMatteColor - - Imagick::getCopyright - - - Imagick::drawImage - Imagick::getImageIndex - Imagick::setImageMatte - - - - - Imagick::edgeImage - Imagick::getImageInterlaceScheme - Imagick::setImagePage - - - - - Imagick::embossImage - Imagick::getImageInterpolateMethod - Imagick::setImageProfile - - - - - Imagick::enhanceImage - Imagick::getImageIterations - Imagick::setImageProperty - - - - - Imagick::equalizeImage - Imagick::getImageMatteColor - Imagick::setImageRedPrimary - - - - - Imagick::evaluateImage - Imagick::getImageMatte - Imagick::setImageRenderingIntent - - - - - Imagick::flattenImages - Imagick::getImagePage - Imagick::setImageResolution - - - - - Imagick::flipImage - Imagick::getImagePixelColor - Imagick::setImageScene - - - - - Imagick::flopImage - Imagick::getImageProfile - Imagick::setImageTicksPerSecond - - - - - - Imagick::getImageProperty - Imagick::setImageType - - - - - Imagick::fxImage - Imagick::getImageRedPrimary - Imagick::setImageUnits - - - - - Imagick::gammaImage - Imagick::getImageRegion - Imagick::setImageVirtualPixelMethod - - - - - Imagick::gaussianBlurImage - Imagick::getImageRenderingIntent - Imagick::setImageWhitepoint - - - - - Imagick::implodeImage - Imagick::getImageResolution - Imagick::setInterlaceScheme - - - - - Imagick::levelImage - Imagick::getImageScene - Imagick::setOption - - - - - Imagick::linearStretchImage - Imagick::getImageSignature - Imagick::setPage - - - - - Imagick::magnifyImage - Imagick::getImageTicksPerSecond - Imagick::setResolution - - - - - Imagick::matteFloodFillImage - Imagick::getImageTotalInkDensity - Imagick::setResourceLimit - - - - - Imagick::medianFilterImage - Imagick::getImageType - Imagick::setSamplingFactors - - - - - Imagick::minifyImage - Imagick::getImageUnits - Imagick::setSizeOffset - - - - - Imagick::modulateImage - Imagick::getImageVirtualPixelMethod - Imagick::setSize - - - - - Imagick::montageImage - Imagick::getImageWhitepoint - Imagick::setType - - - - - Imagick::morphImages - Imagick::getImageWidth - - - - - - Imagick::mosaicImages - Imagick::getImage - - - - - - Imagick::motionBlurImage - Imagick::getInterlaceScheme - - - - - - Imagick::negateImage - Imagick::getNumberImages - - - - - - Imagick::normalizeImage - Imagick::getOption - - - - - - Imagick::oilPaintImage - Imagick::getPackageName - - - - - - Imagick::optimizeImageLayers - Imagick::getPage - - - - - - Imagick::paintOpaqueImage - Imagick::getPixelIterator - - - - - - Imagick::paintTransparentImage - Imagick::getPixelRegionIterator - - - - - - Imagick::posterizeImage - - Imagick::getQuantumDepth - - - - - - Imagick::radialBlurImage - Imagick::getQuantumRange - - - - - - Imagick::raiseImage - Imagick::getResourceLimit - - - - - - Imagick::randomThresholdImage - Imagick::getResource - - - - - - Imagick::reduceNoiseImage - Imagick::getSamplingFactors - - - - - - Imagick::render - Imagick::getSizeOffset - - - - - - Imagick::resampleImage - Imagick::getSize - - - - - - Imagick::resizeImage - Imagick::identifyImage - - - - - - Imagick::rollImage - Imagick::getImageSize - - - - - - Imagick::rotateImage - - - - - - - Imagick::sampleImage - - - - - - - Imagick::scaleImage - - - - - - - Imagick::separateImageChannel - - - - - - - Imagick::sepiaToneImage - - - - - - - Imagick::shadeImage - - - - - - - Imagick::shadowImage - - - - - - - Imagick::sharpenImage - - - - - - - Imagick::shaveImage - - - - - - - Imagick::shearImage - - - - - - - Imagick::sigmoidalContrastImage - - - - - - - Imagick::sketchImage - - - - - - - Imagick::solarizeImage - - - - - - - Imagick::spliceImage - - - - - - - Imagick::spreadImage - - - - - - - Imagick::steganoImage - - - - - - - Imagick::stereoImage - - - - - - - Imagick::stripImage - - - - - - - Imagick::swirlImage - - - - - - - Imagick::textureImage - - - - - - - Imagick::thresholdImage - - - - - - - Imagick::thumbnailImage - - - - - - - Imagick::tintImage - - - - - - - Imagick::transverseImage - - - - - - - Imagick::trimImage - - - - - - - Imagick::uniqueImageColors - - - - - - - Imagick::unsharpMaskImage - - - - - - - Imagick::vignetteImage - - - - - - - Imagick::waveImage - - - - - - - Imagick::whiteThresholdImage - - - - - - - -
-
-
- &reference.imagick.entities.imagick; -
- - diff --git a/reference/imagick/imagick/adaptiveblurimage.xml b/reference/imagick/imagick/adaptiveblurimage.xml deleted file mode 100644 index b2742160c5a1..000000000000 --- a/reference/imagick/imagick/adaptiveblurimage.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - Imagick::adaptiveBlurImage - Adds adaptive blur filter to image - - - - &reftitle.description; - - public boolImagick::adaptiveBlurImage - floatradius - floatsigma - intchannelImagick::CHANNEL_DEFAULT - - - Adds an adaptive blur filter to image. The intensity of an adaptive blur - depends is dramatically decreased at edge of the image, whereas a standard - blur is uniform across the image. &imagick.method.available.0x629; - - - - - &reftitle.parameters; - - - - radius - - - The radius of the Gaussian, in pixels, not counting the center pixel. - Provide a value of 0 and the radius will be chosen automagically. - - - - - sigma - - - The standard deviation of the Gaussian, in pixels. - - - - - channel - - - &imagick.parameter.channel; - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Using <function>Imagick::adaptiveBlurImage</function>: - - Adaptively blur an image, then display to the browser. - - -adaptiveBlurImage(5,3); -echo $image; - -?> -]]> - - &example.outputs.similar; - - Output of example : Using Imagick::adaptiveBlurImage() - - - - - - - - - - &reftitle.seealso; - - - Imagick::blurImage - Imagick::motionBlurImage - Imagick::radialBlurImage - - - - - - - diff --git a/reference/imagick/imagick/adaptiveresizeimage.xml b/reference/imagick/imagick/adaptiveresizeimage.xml deleted file mode 100644 index df94cb160cfa..000000000000 --- a/reference/imagick/imagick/adaptiveresizeimage.xml +++ /dev/null @@ -1,183 +0,0 @@ - - - - - Imagick::adaptiveResizeImage - Adaptively resize image with data dependent triangulation - - - - &reftitle.description; - - public boolImagick::adaptiveResizeImage - intcolumns - introws - boolbestfit&false; - boollegacy&false; - - - Adaptively resize image with data-dependent triangulation. Avoids - blurring across sharp color changes. Most useful when used to shrink - images slightly to a slightly smaller "web size"; may not look good - when a full-sized image is adaptively resized to a thumbnail. - &imagick.method.available.0x629; - - &imagick.bestfit.note; - - - - &reftitle.parameters; - - - - columns - - - The number of columns in the scaled image. - - - - - rows - - - The number of rows in the scaled image. - - - - - bestfit - - - Whether to fit the image within the given dimensions while preserving - the aspect ratio. - - - - - legacy - - - Optional bool parameter. - If set to true, the calculations are done with the small rounding bug - that existed in Imagick before 3.4.0. If set to false, the calculations - should produce the same results as the ImageMagick command-line tools. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - Added optional fit parameter. - - - PECL imagick 2.1.0 - - This method now supports proportional scaling. - Pass zero as either parameter for proportional scaling. - - - - PECL imagick 3.4.0 - - Added the legacy parameter. - - - - - - - - - &reftitle.examples; - - - Using <function>Imagick::adaptiveResizeImage</function> - - Resize an image to a standard size for the web. This method works best - when resizing to a size only slightly smaller than the previous image - size. - - -adaptiveResizeImage(1024,768); - -echo $image; -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::chopImage - Imagick::cropImage - Imagick::magnifyImage - Imagick::minifyImage - Imagick::resizeImage - Imagick::scaleImage - Imagick::shaveImage - Imagick::thumbnailImage - Imagick::trimImage - - - - - - - diff --git a/reference/imagick/imagick/adaptivesharpenimage.xml b/reference/imagick/imagick/adaptivesharpenimage.xml deleted file mode 100644 index 682468b9c0d0..000000000000 --- a/reference/imagick/imagick/adaptivesharpenimage.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - Imagick::adaptiveSharpenImage - Adaptively sharpen the image - - - - &reftitle.description; - - public boolImagick::adaptiveSharpenImage - floatradius - floatsigma - intchannelImagick::CHANNEL_DEFAULT - - - - Adaptively sharpen the image by sharpening more intensely - near image edges and less intensely far from edges. &imagick.method.available.0x629; - - - - - &reftitle.parameters; - - - - radius - - - The radius of the Gaussian, in pixels, not counting the center pixel. Use 0 for auto-select. - - - - - sigma - - - The standard deviation of the Gaussian, in pixels. - - - - - channel - - - &imagick.parameter.channel; - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - A <function>Imagick::adaptiveSharpenImage</function> example - - Adaptively sharpen the image with radius 2 and sigma 1. - - -adaptiveSharpenImage(2,1); -} catch(ImagickException $e) { - echo 'Error: ' , $e->getMessage(); - die(); -} -header('Content-type: image/png'); -echo $image; -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::sharpenImage - - - - - - - diff --git a/reference/imagick/imagick/adaptivethresholdimage.xml b/reference/imagick/imagick/adaptivethresholdimage.xml deleted file mode 100644 index 074179226498..000000000000 --- a/reference/imagick/imagick/adaptivethresholdimage.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - Imagick::adaptiveThresholdImage - Selects a threshold for each pixel based on a range of intensity - - - - &reftitle.description; - - public boolImagick::adaptiveThresholdImage - intwidth - intheight - intoffset - - - Selects an individual threshold for each pixel based on the - range of intensity values in its local neighborhood. This - allows for thresholding of an image whose global intensity - histogram doesn't contain distinctive peaks. - - - - - &reftitle.parameters; - - - - width - - - Width of the local neighborhood. - - - - - height - - - Height of the local neighborhood. - - - - - offset - - - The mean offset - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>Imagick::adaptiveThresholdImage</function> - - adaptiveThresholdImage($width, $height, $adaptiveOffsetQuantum); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/addimage.xml b/reference/imagick/imagick/addimage.xml deleted file mode 100644 index b77c26ae2e3c..000000000000 --- a/reference/imagick/imagick/addimage.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - Imagick::addImage - Adds new image to Imagick object image list - - - - &reftitle.description; - - public boolImagick::addImage - Imagicksource - - - Adds new image to Imagick object from the current position of the source object. - After the operation iterator position is moved at the end of the list. - - - - - &reftitle.parameters; - - - - source - - - The source Imagick object - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/addnoiseimage.xml b/reference/imagick/imagick/addnoiseimage.xml deleted file mode 100644 index 407aaf65ed32..000000000000 --- a/reference/imagick/imagick/addnoiseimage.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - Imagick::addNoiseImage - Adds random noise to the image - - - - &reftitle.description; - - public boolImagick::addNoiseImage - intnoise_type - intchannelImagick::CHANNEL_DEFAULT - - - Adds random noise to the image. - - - - - &reftitle.parameters; - - - - noise_type - - - The type of the noise. Refer to this list of - noise constants. - - - - - channel - - - &imagick.parameter.channel; - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>Imagick::addNoiseImage</function> - - addNoiseImage($noiseType, $channel); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/affinetransformimage.xml b/reference/imagick/imagick/affinetransformimage.xml deleted file mode 100644 index e81007a54cba..000000000000 --- a/reference/imagick/imagick/affinetransformimage.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - Imagick::affineTransformImage - Transforms an image - - - - &reftitle.description; - - public boolImagick::affineTransformImage - ImagickDrawmatrix - - - Transforms an image as dictated by the affine matrix. - - - - - &reftitle.parameters; - - - - matrix - - - The affine matrix - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>Imagick::affineTransformImage</function> - - cos($angle), "sy" => cos($angle), - "rx" => sin($angle), "ry" => -sin($angle), - "tx" => 0, "ty" => 0, - ); - - $draw->affine($affineRotate); - - $imagick->affineTransformImage($draw); - - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/animateimages.xml b/reference/imagick/imagick/animateimages.xml deleted file mode 100644 index 24d2848aa685..000000000000 --- a/reference/imagick/imagick/animateimages.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - Imagick::animateImages - Animates an image or images - - - - &reftitle.description; - - public boolImagick::animateImages - stringx_server - - - - This method animates the image onto a local or remote X server. This method - is not available on Windows. - &imagick.method.available.0x636; - - - - - &reftitle.parameters; - - - - x_server - - - X server address - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.seealso; - - - Imagick::displayImage - - - - - - - diff --git a/reference/imagick/imagick/annotateimage.xml b/reference/imagick/imagick/annotateimage.xml deleted file mode 100644 index 6e0ed07b4123..000000000000 --- a/reference/imagick/imagick/annotateimage.xml +++ /dev/null @@ -1,153 +0,0 @@ - - - - - Imagick::annotateImage - Annotates an image with text - - - - &reftitle.description; - - public boolImagick::annotateImage - ImagickDrawdraw_settings - floatx - floaty - floatangle - stringtext - - - Annotates an image with text. - - - - - &reftitle.parameters; - - - - draw_settings - - - The ImagickDraw object that contains settings for drawing the text - - - - - x - - - Horizontal offset in pixels to the left of text - - - - - y - - - Vertical offset in pixels to the baseline of text - - - - - angle - - - The angle at which to write the text - - - - - text - - - The string to draw - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Using <function>Imagick::annotateImage</function>: - - Annotate text on an empty image - - -newImage(800, 75, $pixel); - -/* Black text */ -$draw->setFillColor('black'); - -/* Font properties */ -$draw->setFont('Bookman-DemiItalic'); -$draw->setFontSize( 30 ); - -/* Create text */ -$image->annotateImage($draw, 10, 45, 0, 'The quick brown fox jumps over the lazy dog'); - -/* Give image a format */ -$image->setImageFormat('png'); - -/* Output the image with headers */ -header('Content-type: image/png'); -echo $image; - -?> -]]> - - - - - - - &reftitle.seealso; - - - ImagickDraw::annotation - ImagickDraw::setFont - - - - - - - diff --git a/reference/imagick/imagick/appendimages.xml b/reference/imagick/imagick/appendimages.xml deleted file mode 100644 index 816f823d83fb..000000000000 --- a/reference/imagick/imagick/appendimages.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - Imagick::appendImages - Append a set of images - - - - &reftitle.description; - - public ImagickImagick::appendImages - boolstack - - - Append a set of images into one larger image. - - - - - &reftitle.parameters; - - - - stack - - - Whether to stack the images vertically. - By default (or if &false; is specified) images are stacked left-to-right. - If stack is &true;, images are stacked top-to-bottom. - - - - - - - - - &reftitle.returnvalues; - - Returns Imagick instance on success. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - <methodname>Imagick::appendImages</methodname> example - -newImage(100, 50, "red"); -$im->newImage(100, 50, "green"); -$im->newImage(100, 50, "blue"); - -/* Append the images into one */ -$im->resetIterator(); -$combined = $im->appendImages(true); - -/* Output the image */ -$combined->setImageFormat("png"); -header("Content-Type: image/png"); -echo $combined; -?> -]]> - - &example.outputs.similar; - - Output of example : Imagick::appendImages() - - - - - - - - - - - diff --git a/reference/imagick/imagick/autolevelimage.xml b/reference/imagick/imagick/autolevelimage.xml deleted file mode 100644 index 3faa13c15d45..000000000000 --- a/reference/imagick/imagick/autolevelimage.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - Imagick::autoLevelImage - Adjusts the levels of a particular image channel - - - - &reftitle.description; - - public boolImagick::autoLevelImage - intchannelImagick::CHANNEL_DEFAULT - - - Adjusts the levels of a particular image channel by scaling the minimum and maximum values to the full quantum range. - - - - - - &reftitle.parameters; - - - channel - - - Which channel should the auto-levelling should be done on. - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - <function>Imagick::autoLevelImage</function> - - autoLevelImage(); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/averageimages.xml b/reference/imagick/imagick/averageimages.xml deleted file mode 100644 index e08ec9b18fe7..000000000000 --- a/reference/imagick/imagick/averageimages.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - Imagick::averageImages - Average a set of images - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public ImagickImagick::averageImages - - - - Average a set of images. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a new Imagick object on success. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/blackthresholdimage.xml b/reference/imagick/imagick/blackthresholdimage.xml deleted file mode 100644 index 2e7c2d2a2e8e..000000000000 --- a/reference/imagick/imagick/blackthresholdimage.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - Imagick::blackThresholdImage - Forces all pixels below the threshold into black - - - - &reftitle.description; - - public boolImagick::blackThresholdImage - mixedthreshold - - - Is like Imagick::thresholdImage() but forces all pixels below the threshold - into black while leaving all pixels above the threshold unchanged. - - - - - &reftitle.parameters; - - - - threshold - - - The threshold below which everything turns black - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Now allows a string representing the color as a parameter. - Previous versions allow only an ImagickPixel object. - - - - - - - - - - - - &reftitle.examples; - - - <function>Imagick::blackThresholdImage</function> - - blackthresholdimage($thresholdColor); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/blueshiftimage.xml b/reference/imagick/imagick/blueshiftimage.xml deleted file mode 100644 index 119566897231..000000000000 --- a/reference/imagick/imagick/blueshiftimage.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - Imagick::blueShiftImage - Mutes the colors of the image - - - - &reftitle.description; - - public boolImagick::blueShiftImage - floatfactor1.5 - - - - Mutes the colors of the image to simulate a scene at nighttime in the moonlight. - - - - - - - - &reftitle.parameters; - - - factor - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - - &reftitle.examples; - - - <function>Imagick::blueShiftImage</function> - - blueShiftImage($blueShift); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/blurimage.xml b/reference/imagick/imagick/blurimage.xml deleted file mode 100644 index 107176f5db6a..000000000000 --- a/reference/imagick/imagick/blurimage.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - Imagick::blurImage - Adds blur filter to image - - - - &reftitle.description; - - public boolImagick::blurImage - floatradius - floatsigma - intchannel - - - Adds blur filter to image. Optional third parameter to blur a specific - channel. - - - - - &reftitle.parameters; - - - - radius - - - Blur radius - - - - - sigma - - - Standard deviation - - - - - channel - - - The Channeltype - constant. When not supplied, all channels are blurred. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Using <function>Imagick::blurImage</function>: - - Blur an image, then display to the browser. - - -blurImage(5,3); -echo $image; - -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::adaptiveBlurImage - Imagick::motionBlurImage - Imagick::radialBlurImage - - - - - - - diff --git a/reference/imagick/imagick/borderimage.xml b/reference/imagick/imagick/borderimage.xml deleted file mode 100644 index 053c656d818b..000000000000 --- a/reference/imagick/imagick/borderimage.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - Imagick::borderImage - Surrounds the image with a border - - - - &reftitle.description; - - public boolImagick::borderImage - mixedbordercolor - intwidth - intheight - - - Surrounds the image with a border of the color defined by the bordercolor ImagickPixel object. - - - - - &reftitle.parameters; - - - - bordercolor - - - ImagickPixel object or a string containing the border color - - - - - width - - - Border width - - - - - height - - - Border height - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Now allows a string representing the color as the first parameter. - Previous versions allow only an ImagickPixel object. - - - - - - - - - - - - &reftitle.examples; - - - <function>Imagick::borderImage</function> - - borderImage($color, $width, $height); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/brightnesscontrastimage.xml b/reference/imagick/imagick/brightnesscontrastimage.xml deleted file mode 100644 index 1e2ef25768c6..000000000000 --- a/reference/imagick/imagick/brightnesscontrastimage.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - Imagick::brightnessContrastImage - Change the brightness and/or contrast of an image - - - - &reftitle.description; - - public boolImagick::brightnessContrastImage - floatbrightness - floatcontrast - intchannelImagick::CHANNEL_DEFAULT - - - Change the brightness and/or contrast of an image. It converts the brightness and contrast parameters into slope and intercept and calls a polynomial function to apply to the image. - - - - - - &reftitle.parameters; - - - brightness - - - - - - - - contrast - - - - - - - - channel - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - - &reftitle.examples; - - - <function>Imagick::brightnessContrastImage</function> - - brightnessContrastImage($brightness, $contrast, $channel); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/charcoalimage.xml b/reference/imagick/imagick/charcoalimage.xml deleted file mode 100644 index 3f1323bcb5fa..000000000000 --- a/reference/imagick/imagick/charcoalimage.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - Imagick::charcoalImage - Simulates a charcoal drawing - - - - &reftitle.description; - - public boolImagick::charcoalImage - floatradius - floatsigma - - - Simulates a charcoal drawing. - - - - - &reftitle.parameters; - - - - radius - - - The radius of the Gaussian, in pixels, not counting the center pixel - - - - - sigma - - - The standard deviation of the Gaussian, in pixels - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>Imagick::charcoalImage</function> - - charcoalImage($radius, $sigma); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/chopimage.xml b/reference/imagick/imagick/chopimage.xml deleted file mode 100644 index 3b19a99d03e8..000000000000 --- a/reference/imagick/imagick/chopimage.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - Imagick::chopImage - Removes a region of an image and trims - - - - &reftitle.description; - - public boolImagick::chopImage - intwidth - intheight - intx - inty - - - Removes a region of an image and collapses the image to occupy the removed portion. - - - - - &reftitle.parameters; - - - - width - - - Width of the chopped area - - - - - height - - - Height of the chopped area - - - - - x - - - X origo of the chopped area - - - - - y - - - Y origo of the chopped area - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Using <function>Imagick::chopImage</function>: - - Example of using Imagick::chopImage - - -newImage(400, 200, $pixel); - -/* Chop image */ -$image->chopImage(200, 200, 0, 0); - -/* Give image a format */ -$image->setImageFormat('png'); - -/* Output the image with headers */ -header('Content-type: image/png'); -echo $image; - -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::cropImage - - - - - - - diff --git a/reference/imagick/imagick/clampimage.xml b/reference/imagick/imagick/clampimage.xml deleted file mode 100644 index 7c1c75e5af41..000000000000 --- a/reference/imagick/imagick/clampimage.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - Imagick::clampImage - Restricts the color range from 0 to the quantum depth. - - - - &reftitle.description; - - public boolImagick::clampImage - intchannelImagick::CHANNEL_DEFAULT - - - Restricts the color range from 0 to the quantum depth. - - - - - - - &reftitle.parameters; - - - channel - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - diff --git a/reference/imagick/imagick/clear.xml b/reference/imagick/imagick/clear.xml deleted file mode 100644 index 719bfb159fa7..000000000000 --- a/reference/imagick/imagick/clear.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - Imagick::clear - Clears all resources associated to Imagick object - - - - &reftitle.description; - - public boolImagick::clear - - - - Clears all resources associated to Imagick object - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/clipimage.xml b/reference/imagick/imagick/clipimage.xml deleted file mode 100644 index 49fcc0c64739..000000000000 --- a/reference/imagick/imagick/clipimage.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - Imagick::clipImage - Clips along the first path from the 8BIM profile - - - - &reftitle.description; - - public boolImagick::clipImage - - - - Clips along the first path from the 8BIM profile, if present. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/clipimagepath.xml b/reference/imagick/imagick/clipimagepath.xml deleted file mode 100644 index 0bb573ea9c7d..000000000000 --- a/reference/imagick/imagick/clipimagepath.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - Imagick::clipImagePath - Clips along the named paths from the 8BIM profile, if present - - - - &reftitle.description; - - public voidImagick::clipImagePath - stringpathname - stringinside - - - Clips along the named paths from the 8BIM profile, if present. Later operations take effect inside the path. Id may be a number if preceded with #, to work on a numbered path, e.g., "#1" to use the first path. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - pathname - - - - - - - - inside - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/imagick/imagick/clippathimage.xml b/reference/imagick/imagick/clippathimage.xml deleted file mode 100644 index a9ca1ebd3c26..000000000000 --- a/reference/imagick/imagick/clippathimage.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - Imagick::clipPathImage - Clips along the named paths from the 8BIM profile - - - - &reftitle.description; - - public boolImagick::clipPathImage - stringpathname - boolinside - - - Clips along the named paths from the 8BIM profile, if - present. Later operations take effect inside the path. - It may be a number if preceded with #, to work on a - numbered path, e.g., "#1" to use the first path. - - - - - &reftitle.parameters; - - - - pathname - - - The name of the path - - - - - inside - - - If &true; later operations take effect inside clipping path. - Otherwise later operations take effect outside clipping path. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/clone.xml b/reference/imagick/imagick/clone.xml deleted file mode 100644 index 5da16980ec9c..000000000000 --- a/reference/imagick/imagick/clone.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - Imagick::clone - Makes an exact copy of the Imagick object - - - - &reftitle.description; - - public ImagickImagick::clone - - - - Makes an exact copy of the Imagick object. - - - - This function has been DEPRECATED as of imagick 3.1.0 - in favour of using the clone - keyword. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A copy of the Imagick object is returned. - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 3.1.0 - - The method was deprecated in favour of the - clone keyword. - - - - - - - - - - &reftitle.examples; - - - Imagick object cloning in different versions of imagick - -clone(); - -// Cloning an Imagick object from 3.1.0 on: -$newImage = clone $image; -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/clutimage.xml b/reference/imagick/imagick/clutimage.xml deleted file mode 100644 index ebd1843b700c..000000000000 --- a/reference/imagick/imagick/clutimage.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - Imagick::clutImage - Replaces colors in the image - - - - &reftitle.description; - - public boolImagick::clutImage - Imagicklookup_table - intchannelImagick::CHANNEL_DEFAULT - - - - Replaces colors in the image from a color lookup table. Optional second - parameter to replace colors in a specific channel. &imagick.method.available.0x636; - - - - - &reftitle.parameters; - - - - lookup_table - - - Imagick object containing the color lookup table - - - - - channel - - - The Channeltype - constant. When not supplied, default channels are replaced. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Using <function>Imagick::clutImage</function>: - - Replace colors in the image from a color lookup table. - - -newImage(1, 1, new ImagickPixel('black')); -$image->clutImage($clut); -$image->writeImage('test_out.jpg'); -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::adaptiveBlurImage - Imagick::motionBlurImage - Imagick::radialBlurImage - - - - - - - diff --git a/reference/imagick/imagick/coalesceimages.xml b/reference/imagick/imagick/coalesceimages.xml deleted file mode 100644 index e3bb865b3eeb..000000000000 --- a/reference/imagick/imagick/coalesceimages.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - Imagick::coalesceImages - Composites a set of images - - - - &reftitle.description; - - public ImagickImagick::coalesceImages - - - - Composites a set of images while respecting any page offsets - and disposal methods. GIF, MIFF, and MNG animation sequences - typically start with an image background and each subsequent - image varies in size and offset. Returns a new Imagick object - where each image in the sequence is the same size as the first - and composited with the next image in the sequence. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a new Imagick object on success. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/colorfloodfillimage.xml b/reference/imagick/imagick/colorfloodfillimage.xml deleted file mode 100644 index 4f2d7c632a2d..000000000000 --- a/reference/imagick/imagick/colorfloodfillimage.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - Imagick::colorFloodfillImage - Changes the color value of any pixel that matches target - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::colorFloodfillImage - mixedfill - floatfuzz - mixedbordercolor - intx - inty - - - Changes the color value of any pixel that matches target and is an - immediate neighbor. - - - - - &reftitle.parameters; - - - - fill - - - ImagickPixel object containing the fill color - - - - - fuzz - - - The amount of fuzz. For example, set fuzz to 10 and the color red at - intensities of 100 and 102 respectively are now interpreted as the - same color for the purposes of the floodfill. - - - - - bordercolor - - - ImagickPixel object containing the border color - - - - - x - - - X start position of the floodfill - - - - - y - - - Y start position of the floodfill - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Now allows a string representing the color as first and third - parameter. Previous versions allow only an ImagickPixel object. - - - - - - - - - - - diff --git a/reference/imagick/imagick/colorizeimage.xml b/reference/imagick/imagick/colorizeimage.xml deleted file mode 100644 index cc13701573bd..000000000000 --- a/reference/imagick/imagick/colorizeimage.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - Imagick::colorizeImage - Blends the fill color with the image - - - - &reftitle.description; - - public boolImagick::colorizeImage - mixedcolorize - mixedopacity - boollegacy&false; - - - Blends the fill color with each pixel in the image. - - - - - &reftitle.parameters; - - - - colorize - - - ImagickPixel object or a string containing the colorize color - - - - - opacity - - - ImagickPixel object or an float containing the opacity value. - 1.0 is fully opaque and 0.0 is fully transparent. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Now allows a string representing the color as the first parameter and - a float representing the opacity value as the second parameter. - Previous versions allow only an ImagickPixel objects. - - - - - - - - - - - - &reftitle.examples; - - - <function>Imagick::colorizeImage</function> - - colorizeImage($color, $opacityColor); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/colormatriximage.xml b/reference/imagick/imagick/colormatriximage.xml deleted file mode 100644 index 53a406e0e23f..000000000000 --- a/reference/imagick/imagick/colormatriximage.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - Imagick::colorMatrixImage - Apply color transformation to an image - - - - &reftitle.description; - - public boolImagick::colorMatrixImage - arraycolor_matrix - - - Apply color transformation to an image. The method permits saturation changes, hue rotation, luminance to alpha, and various other effects. Although variable-sized transformation matrices can be used, typically one uses a 5x5 matrix for an RGBA image and a 6x6 for CMYKA (or RGBA with offsets). The matrix is similar to those used by Adobe Flash except offsets are in column 6 rather than 5 (in support of CMYKA images) and offsets are normalized (divide Flash offset by 255) - - - - - - - &reftitle.parameters; - - - color_matrix - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - - &reftitle.examples; - - - <function>Imagick::colorMatrixImage</function> - - setImageOpacity(1); - - //A color matrix should look like: - // $colorMatrix = [ - // 1.5, 0.0, 0.0, 0.0, 0.0, -0.157, - // 0.0, 1.0, 0.5, 0.0, 0.0, -0.157, - // 0.0, 0.0, 1.5, 0.0, 0.0, -0.157, - // 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, - // 0.0, 0.0, 0.0, 0.0, 1.0, 0.0, - // 0.0, 0.0, 0.0, 0.0, 0.0, 1.0 - // ]; - - $background = new \Imagick(); - $background->newPseudoImage($imagick->getImageWidth(), $imagick->getImageHeight(), "pattern:checkerboard"); - - $background->setImageFormat('png'); - - $imagick->setImageFormat('png'); - $imagick->colorMatrixImage($colorMatrix); - - $background->compositeImage($imagick, \Imagick::COMPOSITE_ATOP, 0, 0); - - header("Content-Type: image/png"); - echo $background->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/combineimages.xml b/reference/imagick/imagick/combineimages.xml deleted file mode 100644 index 2fc393654e5b..000000000000 --- a/reference/imagick/imagick/combineimages.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - Imagick::combineImages - Combines one or more images into a single image - - - - &reftitle.description; - - public ImagickImagick::combineImages - intchannelType - - - Combines one or more images into a single image. The grayscale - value of the pixels of each image in the sequence is assigned - in order to the specified channels of the combined image. The - typical ordering would be image 1 => Red, 2 => Green, - 3 => Blue, etc. - - - - - &reftitle.parameters; - - - - channelType - - - Provide any channel constant that is valid for your channel mode. To - apply to more than one channel, combine channeltype constants using - bitwise operators. Refer to this - list of channel constants. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/commentimage.xml b/reference/imagick/imagick/commentimage.xml deleted file mode 100644 index 5291e6160f0b..000000000000 --- a/reference/imagick/imagick/commentimage.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - Imagick::commentImage - Adds a comment to your image - - - - &reftitle.description; - - public boolImagick::commentImage - stringcomment - - - Adds a comment to your image. - - - - - &reftitle.parameters; - - - - comment - - - The comment to add - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Using <function>Imagick::commentImage</function>: - - Commenting an image and retrieving the comment: - - -newImage(100, 100, new ImagickPixel("red")); - -/* Add comment to the image */ -$im->commentImage("Hello World!"); - -/* Display the comment */ -echo $im->getImageProperty("comment"); - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/compareimagechannels.xml b/reference/imagick/imagick/compareimagechannels.xml deleted file mode 100644 index 5f9f7b442420..000000000000 --- a/reference/imagick/imagick/compareimagechannels.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - Imagick::compareImageChannels - Returns the difference in one or more images - - - - &reftitle.description; - - public arrayImagick::compareImageChannels - Imagickimage - intchannelType - intmetricType - - - Compares one or more images and returns the difference image. - - - - - &reftitle.parameters; - - - - image - - - Imagick object containing the image to compare. - - - - - channelType - - - Provide any channel constant that is valid for your channel mode. To - apply to more than one channel, combine channeltype constants using - bitwise operators. Refer to this - list of channel constants. - - - - - metricType - - - One of the metric type constants. - - - - - - - - - &reftitle.returnvalues; - - Array consisting of new_wand and - distortion. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/compareimagelayers.xml b/reference/imagick/imagick/compareimagelayers.xml deleted file mode 100644 index 248911f43009..000000000000 --- a/reference/imagick/imagick/compareimagelayers.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - Imagick::compareImageLayers - Returns the maximum bounding region between images - - - - &reftitle.description; - - public ImagickImagick::compareImageLayers - intmethod - - - - Compares each image with the next in a sequence and returns the - maximum bounding region of any pixel differences it discovers. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - - - - method - - - One of the layer method constants. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Using <function>Imagick::compareImageLayers</function> - - Comparing image layers - - -compareImageLayers(imagick::LAYERMETHOD_COALESCE); - -/* work on the $result */ -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::optimizeImageLayers - Imagick::writeImages - Imagick::writeImage - - - - - - - diff --git a/reference/imagick/imagick/compareimages.xml b/reference/imagick/imagick/compareimages.xml deleted file mode 100644 index 25a4f882072a..000000000000 --- a/reference/imagick/imagick/compareimages.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - Imagick::compareImages - Compares an image to a reconstructed image - - - - &reftitle.description; - - public arrayImagick::compareImages - Imagickcompare - intmetric - - - Returns an array containing a reconstructed image and the difference between images. - - - - - &reftitle.parameters; - - - - compare - - - An image to compare to. - - - - - metric - - - Provide a valid metric type constant. Refer to this - list of metric constants. - - - - - - - - - &reftitle.returnvalues; - - Returns an array containing a reconstructed image and the difference between images. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Using <function>Imagick::compareImages</function>: - - Compare images and display the reconstructed image - - -compareImages($image2, Imagick::METRIC_MEANSQUAREERROR); -$result[0]->setImageFormat("png"); - -header("Content-Type: image/png"); -echo $result[0]; - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/compositeimage.xml b/reference/imagick/imagick/compositeimage.xml deleted file mode 100644 index e191d330b0e9..000000000000 --- a/reference/imagick/imagick/compositeimage.xml +++ /dev/null @@ -1,144 +0,0 @@ - - - - - Imagick::compositeImage - Composite one image onto another - - - - &reftitle.description; - - public boolImagick::compositeImage - Imagickcomposite_object - intcomposite - intx - inty - intchannelImagick::CHANNEL_DEFAULT - - - Composite one image onto another at the specified offset. Any extra arguments needed for the compose algorithm should passed to setImageArtifact with 'compose:args' as the first parameter and the data as the second parameter. - - - - - &reftitle.parameters; - - - - composite_object - - - Imagick object which holds the composite image - - - - - compose - - - Composite operator. See Composite Operator - Constants - - - - - x - - - The column offset of the composited image - - - - - y - - - The row offset of the composited image - - - - - channel - - - Provide any channel constant that is valid for your channel mode. To - apply to more than one channel, combine channeltype constants using - bitwise operators. Refer to this list of channel constants. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Using <function>Imagick::compositeImage</function>: - - Composite two images with the 'mathematics' compose method - - -setImageVirtualPixelMethod(Imagick::VIRTUALPIXELMETHOD_TRANSPARENT); -$src1->setImageArtifact('compose:args', "1,0,-0.5,0.5"); -$src1->compositeImage($src2, Imagick::COMPOSITE_MATHEMATICS, 0, 0); -$src1->writeImage("./output.png"); - -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::setImageArtifact - - - - - - - diff --git a/reference/imagick/imagick/construct.xml b/reference/imagick/imagick/construct.xml deleted file mode 100644 index aad9f94a97af..000000000000 --- a/reference/imagick/imagick/construct.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - Imagick::__construct - The Imagick constructor - - - - &reftitle.description; - - public Imagick::__construct - mixedfiles - - - Creates an Imagick instance for a specified image or set of images. - - - - - &reftitle.parameters; - - - files - - - The path to an image to load or an array of paths. Paths can include - wildcards for file names, or can be URLs. - - - - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/contrastimage.xml b/reference/imagick/imagick/contrastimage.xml deleted file mode 100644 index 3deeec65087f..000000000000 --- a/reference/imagick/imagick/contrastimage.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - Imagick::contrastImage - Change the contrast of the image - - - - &reftitle.description; - - public boolImagick::contrastImage - boolsharpen - - - Enhances the intensity differences between the lighter and - darker elements of the image. Set sharpen to a value other - than 0 to increase the image contrast otherwise the contrast - is reduced. - - - - - &reftitle.parameters; - - - - sharpen - - - The sharpen value - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::contrastImage</function> - - contrastImage($contrastType); - } - - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/contraststretchimage.xml b/reference/imagick/imagick/contraststretchimage.xml deleted file mode 100644 index 9f2305d5f14d..000000000000 --- a/reference/imagick/imagick/contraststretchimage.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - Imagick::contrastStretchImage - Enhances the contrast of a color image - - - - &reftitle.description; - - public boolImagick::contrastStretchImage - floatblack_point - floatwhite_point - intchannelImagick::CHANNEL_DEFAULT - - - - Enhances the contrast of a color image by adjusting the pixels - color to span the entire range of colors available. &imagick.method.available.0x629; - - - - - &reftitle.parameters; - - - - black_point - - - The black point. - - - - - white_point - - - The white point. - - - - - channel - - - Provide any channel constant that is valid for your channel mode. To - apply to more than one channel, combine channeltype constants using - bitwise operators. Imagick::CHANNEL_ALL. Refer to this - list of channel constants. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/convolveimage.xml b/reference/imagick/imagick/convolveimage.xml deleted file mode 100644 index 639c55f43689..000000000000 --- a/reference/imagick/imagick/convolveimage.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - Imagick::convolveImage - Applies a custom convolution kernel to the image - - - - &reftitle.description; - - public boolImagick::convolveImage - arraykernel - intchannelImagick::CHANNEL_DEFAULT - - - Applies a custom convolution kernel to the image. - - - - - &reftitle.parameters; - - - - kernel - - - The convolution kernel - - - - - channel - - - Provide any channel constant that is valid for your channel mode. To - apply to more than one channel, combine channeltype constants using - bitwise operators. Refer to this - list of channel constants. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::convolveImage</function> - - setImageBias($bias * \Imagick::getQuantum()); - $imagick->convolveImage($kernelMatrix); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/count.xml b/reference/imagick/imagick/count.xml deleted file mode 100644 index 4cff71e37dc6..000000000000 --- a/reference/imagick/imagick/count.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Imagick::count - Get the number of images - - - - &reftitle.description; - - public intImagick::count - intmode0 - - - Returns the number of images. - - - - - - &reftitle.parameters; - - - mode - - - An unused argument. Currently there is a non-particularly well defined feature in PHP where calling count() on a countable object might (or might not) require this method to accept a parameter. This parameter is here to be conformant with the interface of countable, even though the param is not used. - - - - - - - - &reftitle.returnvalues; - - Returns the number of images. - - - - - - - diff --git a/reference/imagick/imagick/cropimage.xml b/reference/imagick/imagick/cropimage.xml deleted file mode 100644 index f70368ccb893..000000000000 --- a/reference/imagick/imagick/cropimage.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - Imagick::cropImage - Extracts a region of the image - - - - &reftitle.description; - - public boolImagick::cropImage - intwidth - intheight - intx - inty - - - Extracts a region of the image. - - - - - &reftitle.parameters; - - - - width - - - The width of the crop - - - - - height - - - The height of the crop - - - - - x - - - The X coordinate of the cropped region's top left corner - - - - - y - - - The Y coordinate of the cropped region's top left corner - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::cropImage</function> - - cropImage($width, $height, $startX, $startY); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/cropthumbnailimage.xml b/reference/imagick/imagick/cropthumbnailimage.xml deleted file mode 100644 index 94b66099b7fc..000000000000 --- a/reference/imagick/imagick/cropthumbnailimage.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - Imagick::cropThumbnailImage - Creates a crop thumbnail - - - - &reftitle.description; - - public boolImagick::cropThumbnailImage - intwidth - intheight - boollegacy&false; - - - Creates a fixed size thumbnail by first scaling the image up or down and cropping a specified - area from the center. - - - - - &reftitle.parameters; - - - - width - - - The width of the thumbnail - - - - - height - - - The Height of the thumbnail - - - - - legacy - - - Optional bool parameter. - If set to true, the calculations are done with the small rounding bug - that existed in Imagick before 3.4.0. If set to false, the calculations - should produce the same results as the ImageMagick command-line tools. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL imagick 3.4.0 - - Added the legacy parameter. - - - - - - - - - - diff --git a/reference/imagick/imagick/current.xml b/reference/imagick/imagick/current.xml deleted file mode 100644 index 05e24dafe8d9..000000000000 --- a/reference/imagick/imagick/current.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - Imagick::current - Returns a reference to the current Imagick object - - - - &reftitle.description; - - public ImagickImagick::current - - - - Returns reference to the current imagick object with image pointer at the correct sequence. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns self on success. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/cyclecolormapimage.xml b/reference/imagick/imagick/cyclecolormapimage.xml deleted file mode 100644 index cb5e99c029dc..000000000000 --- a/reference/imagick/imagick/cyclecolormapimage.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - Imagick::cycleColormapImage - Displaces an image's colormap - - - - &reftitle.description; - - public boolImagick::cycleColormapImage - intdisplace - - - Displaces an image's colormap by a given number of positions. If you - cycle the colormap a number of times you can produce a psychedelic - effect. - - - - - &reftitle.parameters; - - - - displace - - - The amount to displace the colormap. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/decipherimage.xml b/reference/imagick/imagick/decipherimage.xml deleted file mode 100644 index 20bfc4facbcb..000000000000 --- a/reference/imagick/imagick/decipherimage.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - Imagick::decipherImage - Deciphers an image - - - - &reftitle.description; - - public boolImagick::decipherImage - stringpassphrase - - - - Deciphers image that has been enciphered before. The image must be enciphered - using Imagick::encipherImage. - &imagick.method.available.0x639; - - - - - &reftitle.parameters; - - - - passphrase - - - The passphrase - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.seealso; - - - Imagick::encipherImage - - - - - - - diff --git a/reference/imagick/imagick/deconstructimages.xml b/reference/imagick/imagick/deconstructimages.xml deleted file mode 100644 index 5b0fd7a88b9f..000000000000 --- a/reference/imagick/imagick/deconstructimages.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - Imagick::deconstructImages - Returns certain pixel differences between images - - - - &reftitle.description; - - public ImagickImagick::deconstructImages - - - - Compares each image with the next in a sequence and returns the maximum - bounding region of any pixel differences it discovers. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a new Imagick object on success. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/deleteimageartifact.xml b/reference/imagick/imagick/deleteimageartifact.xml deleted file mode 100644 index 5d2f309d6052..000000000000 --- a/reference/imagick/imagick/deleteimageartifact.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - Imagick::deleteImageArtifact - Delete image artifact - - - - &reftitle.description; - - public boolImagick::deleteImageArtifact - stringartifact - - - Deletes an artifact associated with the image. The difference between image properties and - image artifacts is that properties are public and artifacts are private. - &imagick.method.available.0x657; - - - - - &reftitle.parameters; - - - - artifact - - - The name of the artifact to delete - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.seealso; - - - Imagick::setImageArtifact - Imagick::getImageArtifact - - - - - - - diff --git a/reference/imagick/imagick/deleteimageproperty.xml b/reference/imagick/imagick/deleteimageproperty.xml deleted file mode 100644 index 6710cf07f07a..000000000000 --- a/reference/imagick/imagick/deleteimageproperty.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Imagick::deleteImageProperty - Deletes an image property - - - - &reftitle.description; - - public boolImagick::deleteImageProperty - stringname - - - Deletes an image property. - - - - - - &reftitle.parameters; - - - name - - - The name of the property to delete. - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - diff --git a/reference/imagick/imagick/deskewimage.xml b/reference/imagick/imagick/deskewimage.xml deleted file mode 100644 index 9d0bc7866da9..000000000000 --- a/reference/imagick/imagick/deskewimage.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - Imagick::deskewImage - Removes skew from the image - - - - &reftitle.description; - - public boolImagick::deskewImage - floatthreshold - - - This method can be used to remove skew from for example scanned images where the paper - was not properly placed on the scanning surface. &imagick.method.available.0x645; - - - - - &reftitle.parameters; - - - - threshold - - - Deskew threshold - - - - - - - - - &reftitle.returnvalues; - - - - - - - - &reftitle.examples; - - - <function>Imagick::deskewImage</function> - - deskewImage($threshold); - - //The rest of this example is to make the result obvious - because - //otherwise the result is not obvious. - $trim = 9; - - $deskewImagick->cropImage($deskewImagick->getImageWidth() - $trim, $deskewImagick->getImageHeight(), $trim, 0); - $imagick->cropImage($imagick->getImageWidth() - $trim, $imagick->getImageHeight(), $trim, 0); - $deskewImagick->resizeimage($deskewImagick->getImageWidth() / 2, $deskewImagick->getImageHeight() / 2, \Imagick::FILTER_LANCZOS, 1); - $imagick->resizeimage($imagick->getImageWidth() / 2, $imagick->getImageHeight() / 2, \Imagick::FILTER_LANCZOS, 1); - $newCanvas = new \Imagick(); - $newCanvas->newimage($imagick->getImageWidth() + $deskewImagick->getImageWidth() + 20, $imagick->getImageHeight(), 'red', 'jpg'); - $newCanvas->compositeimage($imagick, \Imagick::COMPOSITE_COPY, 5, 0); - $newCanvas->compositeimage($deskewImagick, \Imagick::COMPOSITE_COPY, $imagick->getImageWidth() + 10, 0); - - header("Content-Type: image/jpg"); - echo $newCanvas->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/despeckleimage.xml b/reference/imagick/imagick/despeckleimage.xml deleted file mode 100644 index 7d16a26252e6..000000000000 --- a/reference/imagick/imagick/despeckleimage.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - Imagick::despeckleImage - Reduces the speckle noise in an image - - - - &reftitle.description; - - public boolImagick::despeckleImage - - - - Reduces the speckle noise in an image while preserving the edges of the original image. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::despeckleImage</function> - - despeckleImage(); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/destroy.xml b/reference/imagick/imagick/destroy.xml deleted file mode 100644 index 71ba57ad137c..000000000000 --- a/reference/imagick/imagick/destroy.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - Imagick::destroy - Destroys the Imagick object - - - - &reftitle.description; - - public boolImagick::destroy - - - - Destroys the Imagick object and frees all resources associated with it. - This method is deprecated in favour of Imagick::clear. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/displayimage.xml b/reference/imagick/imagick/displayimage.xml deleted file mode 100644 index d72fb78a92bc..000000000000 --- a/reference/imagick/imagick/displayimage.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - Imagick::displayImage - Displays an image - - - - &reftitle.description; - - public boolImagick::displayImage - stringservername - - - This method displays an image on a X server. - - - - - &reftitle.parameters; - - - - servername - - - The X server name - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/displayimages.xml b/reference/imagick/imagick/displayimages.xml deleted file mode 100644 index d4cc2cac82e6..000000000000 --- a/reference/imagick/imagick/displayimages.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - Imagick::displayImages - Displays an image or image sequence - - - - &reftitle.description; - - public boolImagick::displayImages - stringservername - - - Displays an image or image sequence on a X server. - - - - - &reftitle.parameters; - - - - servername - - - The X server name - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/distortimage.xml b/reference/imagick/imagick/distortimage.xml deleted file mode 100644 index f5095741bb79..000000000000 --- a/reference/imagick/imagick/distortimage.xml +++ /dev/null @@ -1,172 +0,0 @@ - - - - - Imagick::distortImage - Distorts an image using various distortion methods - - - - &reftitle.description; - - public boolImagick::distortImage - intmethod - arrayarguments - boolbestfit - - - Distorts an image using various distortion methods, by mapping color - lookups of the source image to a new destination image usually of the same - size as the source image, unless 'bestfit' is set to &true;. - - - If 'bestfit' is enabled, and distortion allows it, the destination image - is adjusted to ensure the whole source 'image' will just fit within the - final destination image, which will be sized and offset accordingly. Also - in many cases the virtual offset of the source image will be taken into - account in the mapping. - - - &imagick.method.available.0x636; - - - - - &reftitle.parameters; - - - - method - - - The method of image distortion. See distortion constants - - - - - arguments - - - The arguments for this distortion method - - - - - bestfit - - - Attempt to resize destination to fit distorted source - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Using <function>Imagick::distortImage</function>: - - Distort an image and display to the browser. - - -newPseudoImage(100, 100, "pattern:checkerboard"); - -/* Set the image format to png */ -$im->setImageFormat('png'); - -/* Fill new visible areas with transparent */ -$im->setImageVirtualPixelMethod(Imagick::VIRTUALPIXELMETHOD_TRANSPARENT); - -/* Activate matte */ -$im->setImageMatte(true); - -/* Control points for the distortion */ -$controlPoints = array( 10, 10, - 10, 5, - - 10, $im->getImageHeight() - 20, - 10, $im->getImageHeight() - 5, - - $im->getImageWidth() - 10, 10, - $im->getImageWidth() - 10, 20, - - $im->getImageWidth() - 10, $im->getImageHeight() - 10, - $im->getImageWidth() - 10, $im->getImageHeight() - 30); - -/* Perform the distortion */ -$im->distortImage(Imagick::DISTORTION_PERSPECTIVE, $controlPoints, true); - -/* Output the image */ -header("Content-Type: image/png"); -echo $im; -?> -]]> - - &example.outputs.similar; - - Output of example : Using Imagick::distortImage() - - - - - - - - - - &reftitle.seealso; - - - Imagick::blurImage - Imagick::motionBlurImage - Imagick::radialBlurImage - - - - - - - diff --git a/reference/imagick/imagick/drawimage.xml b/reference/imagick/imagick/drawimage.xml deleted file mode 100644 index 5e211b2b59e3..000000000000 --- a/reference/imagick/imagick/drawimage.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - Imagick::drawImage - Renders the ImagickDraw object on the current image - - - - &reftitle.description; - - public boolImagick::drawImage - ImagickDrawdraw - - - Renders the ImagickDraw object on the current image. - - - - - &reftitle.parameters; - - - - draw - - - The drawing operations to render on the image. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/edgeimage.xml b/reference/imagick/imagick/edgeimage.xml deleted file mode 100644 index d37ecdddc6e4..000000000000 --- a/reference/imagick/imagick/edgeimage.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - Imagick::edgeImage - Enhance edges within the image - - - - &reftitle.description; - - public boolImagick::edgeImage - floatradius - - - Enhance edges within the image with a convolution filter of the given - radius. Use radius 0 and it will be auto-selected. - - - - - &reftitle.parameters; - - - - radius - - - The radius of the operation. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::edgeImage</function> - - edgeImage($radius); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/embossimage.xml b/reference/imagick/imagick/embossimage.xml deleted file mode 100644 index 35fb70e9422f..000000000000 --- a/reference/imagick/imagick/embossimage.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - Imagick::embossImage - Returns a grayscale image with a three-dimensional effect - - - - &reftitle.description; - - public boolImagick::embossImage - floatradius - floatsigma - - - Returns a grayscale image with a three-dimensional effect. We convolve - the image with a Gaussian operator of the given radius and standard - deviation (sigma). For reasonable results, radius should be larger than - sigma. Use a radius of 0 and it will choose a suitable radius for you. - - - - - &reftitle.parameters; - - - - radius - - - The radius of the effect - - - - - sigma - - - The sigma of the effect - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::embossImage</function> - - embossImage($radius, $sigma); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/encipherimage.xml b/reference/imagick/imagick/encipherimage.xml deleted file mode 100644 index 55a854e20704..000000000000 --- a/reference/imagick/imagick/encipherimage.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - Imagick::encipherImage - Enciphers an image - - - - &reftitle.description; - - public boolImagick::encipherImage - stringpassphrase - - - - Converts plain pixels to enciphered pixels. The image is not readable - until it has been deciphered using Imagick::decipherImage - &imagick.method.available.0x639; - - - - - &reftitle.parameters; - - - - passphrase - - - The passphrase - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.seealso; - - - Imagick::decipherImage - - - - - - - diff --git a/reference/imagick/imagick/enhanceimage.xml b/reference/imagick/imagick/enhanceimage.xml deleted file mode 100644 index 56c061171a57..000000000000 --- a/reference/imagick/imagick/enhanceimage.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - Imagick::enhanceImage - Improves the quality of a noisy image - - - - &reftitle.description; - - public boolImagick::enhanceImage - - - - Applies a digital filter that improves the quality of a noisy image. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::enhanceImage</function> - - enhanceImage(); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/equalizeimage.xml b/reference/imagick/imagick/equalizeimage.xml deleted file mode 100644 index a4404706dd3c..000000000000 --- a/reference/imagick/imagick/equalizeimage.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - Imagick::equalizeImage - Equalizes the image histogram - - - - &reftitle.description; - - public boolImagick::equalizeImage - - - - Equalizes the image histogram. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::equalizeImage</function> - - equalizeImage(); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/evaluateimage.xml b/reference/imagick/imagick/evaluateimage.xml deleted file mode 100644 index 7a9b0ca277ed..000000000000 --- a/reference/imagick/imagick/evaluateimage.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - Imagick::evaluateImage - Applies an expression to an image - - - - &reftitle.description; - - public boolImagick::evaluateImage - intop - floatconstant - intchannelImagick::CHANNEL_DEFAULT - - - Applies an arithmetic, relational, or logical expression to an image. Use - these operators to lighten or darken an image, to increase or decrease - contrast in an image, or to produce the "negative" of an image. - - - - - &reftitle.parameters; - - - - op - - - The evaluation operator - - - - - constant - - - The value of the operator - - - - - channel - - - Provide any channel constant that is valid for your channel mode. To - apply to more than one channel, combine channeltype constants using - bitwise operators. Refer to this - list of channel constants. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Using <function>Imagick::evaluateImage</function> - - Using evaluateImage to reduce opacity in an image. - - -evaluateImage(Imagick::EVALUATE_DIVIDE, 2, Imagick::CHANNEL_ALPHA); - -// Output the image -header("Content-Type: image/png"); -echo $im; -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/exportimagepixels.xml b/reference/imagick/imagick/exportimagepixels.xml deleted file mode 100644 index 7f35f8ea226a..000000000000 --- a/reference/imagick/imagick/exportimagepixels.xml +++ /dev/null @@ -1,181 +0,0 @@ - - - - - - Imagick::exportImagePixels - Exports raw image pixels - - - - &reftitle.description; - - public arrayImagick::exportImagePixels - intx - inty - intwidth - intheight - stringmap - intSTORAGE - - - Exports image pixels into an array. The map defines the ordering of the exported - pixels. The size of the returned array is width * height * strlen(map). - &imagick.method.available.0x647; - - - - - &reftitle.parameters; - - - - x - - - X-coordinate of the exported area - - - - - y - - - Y-coordinate of the exported area - - - - - width - - - Width of the exported aread - - - - - height - - - Height of the exported area - - - - - map - - - Ordering of the exported pixels. For example "RGB". - Valid characters for the map are R, G, B, A, O, C, Y, M, K, I and P. - - - - - STORAGE - - - Refer to this list of pixel type constants - - - - - - - - - &reftitle.returnvalues; - - Returns an array containing the pixels values. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Using <function>Imagick::exportImagePixels</function> - - Export image pixels into an array - - -newPseudoImage(0, 0, "magick:rose"); - -/* Export the image pixels */ -$pixels = $im->exportImagePixels(10, 10, 2, 2, "RGB", Imagick::PIXEL_CHAR); - -/* Output */ -var_dump($pixels); -?> -]]> - - &example.outputs; - - - int(72) - [1]=> - int(64) - [2]=> - int(57) - [3]=> - int(69) - [4]=> - int(59) - [5]=> - int(43) - [6]=> - int(124) - [7]=> - int(120) - [8]=> - int(-96) - [9]=> - int(91) - [10]=> - int(84) - [11]=> - int(111) -} -]]> - - - - - - - - diff --git a/reference/imagick/imagick/extentimage.xml b/reference/imagick/imagick/extentimage.xml deleted file mode 100644 index df5a9486d19d..000000000000 --- a/reference/imagick/imagick/extentimage.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - Imagick::extentImage - Set image size - - - - &reftitle.description; - - public boolImagick::extentImage - intwidth - intheight - intx - inty - - - - Comfortability method for setting image size. The method sets the image size and allows - setting x,y coordinates where the new area begins. - &imagick.method.available.0x631; - - - - - Prior to ImageMagick 6.5.7-8 (1623), $x was positive when shifting to the left and negative when shifting to the right, and $y was positive when shifting an image up and negative when shifting an image down. - - Somewhere between ImageMagick 6.3.7 (1591) and ImageMagick 6.5.7-8 (1623), the axes of $x and $y were flipped, so that $x was negative when shifting to the left and positive when shifting to the right, and $y was negative when shifting an image up and positive when shifting an image down. - - Somewhere between ImageMagick 6.5.7-8 (1623) and ImageMagick 6.6.9-7 (1641), the axes of $x and $y were flipped back to pre-ImageMagick 6.5.7-8 (1623) functionality. - - - - - - - &reftitle.parameters; - - - - width - - - The new width - - - - - height - - - The new height - - - - - x - - - X position for the new size - - - - - y - - - Y position for the new size - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.seealso; - - - Imagick::resizeImage - Imagick::thumbnailImage - Imagick::cropImage - - - - - - - diff --git a/reference/imagick/imagick/filter.xml b/reference/imagick/imagick/filter.xml deleted file mode 100644 index 4ed48422f747..000000000000 --- a/reference/imagick/imagick/filter.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - Imagick::filter - Applies a custom convolution kernel to the image - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::filter - ImagickKernelImagickKernel - intchannelImagick::CHANNEL_UNDEFINED - - - Applies a custom convolution kernel to the image. - - - - - - - &reftitle.parameters; - - - ImagickKernel - - - An instance of ImagickKernel that represents either a single kernel or a linked series of kernels. - - - - - channel - - - &imagick.parameter.channel; - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - - &reftitle.examples; - - - <function>Imagick::filter</function> - - scale($strength, \Imagick::NORMALIZE_KERNEL_VALUE); - $kernel->addUnityKernel(1 - $strength); - - $imagick->filter($kernel); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/flattenimages.xml b/reference/imagick/imagick/flattenimages.xml deleted file mode 100644 index 9aa556a69c08..000000000000 --- a/reference/imagick/imagick/flattenimages.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - Imagick::flattenImages - Merges a sequence of images - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public ImagickImagick::flattenImages - - - - Merges a sequence of images. This is useful for combining Photoshop layers into a single image. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/flipimage.xml b/reference/imagick/imagick/flipimage.xml deleted file mode 100644 index eb264745970f..000000000000 --- a/reference/imagick/imagick/flipimage.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - Imagick::flipImage - Creates a vertical mirror image - - - - &reftitle.description; - - public boolImagick::flipImage - - - - Creates a vertical mirror image by reflecting the pixels around the central x-axis. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::flipImage</function> - - flipImage(); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - &reftitle.seealso; - - Imagick::flopimage - - - - - diff --git a/reference/imagick/imagick/floodfillpaintimage.xml b/reference/imagick/imagick/floodfillpaintimage.xml deleted file mode 100644 index 38be9a2fb508..000000000000 --- a/reference/imagick/imagick/floodfillpaintimage.xml +++ /dev/null @@ -1,176 +0,0 @@ - - - - - Imagick::floodFillPaintImage - Changes the color value of any pixel that matches target - - - - &reftitle.description; - - public boolImagick::floodFillPaintImage - mixedfill - floatfuzz - mixedtarget - intx - inty - boolinvert - intchannelImagick::CHANNEL_DEFAULT - - - - Changes the color value of any pixel that matches target and is an - immediate neighbor. This method is a replacement for deprecated - Imagick::paintFloodFillImage. - &imagick.method.available.0x638; - - - - - &reftitle.parameters; - - - - fill - - - ImagickPixel object or a string containing the fill color - - - - - fuzz - - - &imagick.parameter.fuzz; - - - - - target - - - ImagickPixel object or a string containing the target color to paint - - - - - x - - - X start position of the floodfill - - - - - y - - - Y start position of the floodfill - - - - - invert - - - If &true; paints any pixel that does not match the target color. - - - - - channel - - - &imagick.parameter.channel; - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - <methodname>Imagick::floodfillPaintImage</methodname> example - -newImage(100, 50, "red"); -$im->newImage(100, 50, "green"); -$im->newImage(100, 50, "blue"); - -/* Append the images into one */ -$im->resetIterator(); -$combined = $im->appendImages(true); - -/* Save the intermediate image for comparison */ -$combined->writeImage("floodfillpaint_intermediate.png"); - -/* The target pixel to paint */ -$x = 1; -$y = 1; - -/* Get the color we are painting */ -$target = $combined->getImagePixelColor($x, $y); - -/* Paints pixel in position 1,1 black and all neighboring - pixels that match the target color */ -$combined->floodfillPaintImage("black", 1, $target, $x, $y, false); - -/* Save the result */ -$combined->writeImage("floodfillpaint_result.png"); -?> -]]> - - &example.outputs.similar; - - Output of example : Imagick::floodfillPaintImage() - - - - - - - - - - - - - - diff --git a/reference/imagick/imagick/flopimage.xml b/reference/imagick/imagick/flopimage.xml deleted file mode 100644 index 708bdc923153..000000000000 --- a/reference/imagick/imagick/flopimage.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - Imagick::flopImage - Creates a horizontal mirror image - - - - &reftitle.description; - - public boolImagick::flopImage - - - - Creates a horizontal mirror image by reflecting the pixels around the central y-axis. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::flopImage</function> - - flopImage(); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - &reftitle.seealso; - - Imagick::flipimage - - - - - diff --git a/reference/imagick/imagick/forwardfouriertransformimage.xml b/reference/imagick/imagick/forwardfouriertransformimage.xml deleted file mode 100644 index 5523a36a5fd1..000000000000 --- a/reference/imagick/imagick/forwardfouriertransformimage.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - Imagick::forwardFourierTransformImage - Implements the discrete Fourier transform (DFT) - - - - &reftitle.description; - - public boolImagick::forwardFourierTransformimage - boolmagnitude - - - Implements the discrete Fourier transform (DFT) of the image either as a magnitude / phase or real / imaginary image pair. - - - - - - &reftitle.parameters; - - - magnitude - - - If true, return as magnitude / phase pair otherwise a real / imaginary image pair. - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - - &reftitle.examples; - - - <function>Imagick::forwardFourierTransformImage</function> - - setStrokeOpacity(0); - $draw->setStrokeColor('rgb(255, 255, 255)'); - $draw->setFillColor('rgb(255, 255, 255)'); - - //Draw a circle on the y-axis, with its centre - //at x, y that touches the origin - $draw->circle(250, 250, 220, 250); - - $imagick = new \Imagick(); - $imagick->newImage(512, 512, "black"); - $imagick->drawImage($draw); - $imagick->gaussianBlurImage(20, 20); - $imagick->autoLevelImage(); - - return $imagick; -} - - -function forwardFourierTransformImage($imagePath) { - $imagick = new \Imagick(realpath($imagePath)); - $imagick->resizeimage(512, 512, \Imagick::FILTER_LANCZOS, 1); - - $mask = createMask(); - $imagick->forwardFourierTransformImage(true); - - @$imagick->setimageindex(0); - $magnitude = $imagick->getimage(); - - @$imagick->setimageindex(1); - $imagickPhase = $imagick->getimage(); - - if (true) { - $imagickPhase->compositeImage($mask, \Imagick::COMPOSITE_MULTIPLY, 0, 0); - } - - if (false) { - $output = clone $imagickPhase; - $output->setimageformat('png'); - header("Content-Type: image/png"); - echo $output->getImageBlob(); - } - - $magnitude->inverseFourierTransformImage($imagickPhase, true); - - $magnitude->setimageformat('png'); - header("Content-Type: image/png"); - echo $magnitude->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/frameimage.xml b/reference/imagick/imagick/frameimage.xml deleted file mode 100644 index 72909d03aa8a..000000000000 --- a/reference/imagick/imagick/frameimage.xml +++ /dev/null @@ -1,170 +0,0 @@ - - - - - Imagick::frameImage - Adds a simulated three-dimensional border - - - - &reftitle.description; - - public boolImagick::frameImage - mixedmatte_color - intwidth - intheight - intinner_bevel - intouter_bevel - - - Adds a simulated three-dimensional border around the image. - The width and height specify the border width of the vertical - and horizontal sides of the frame. The inner and outer - bevels indicate the width of the inner and outer shadows of - the frame. - - - - - &reftitle.parameters; - - - - matte_color - - - ImagickPixel object or a string representing the matte color - - - - - width - - - The width of the border - - - - - height - - - The height of the border - - - - - inner_bevel - - - The inner bevel width - - - - - outer_bevel - - - The outer bevel width - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Now allows a string representing the color as the first parameter. - Previous versions allow only an ImagickPixel object. - - - - - - - - - - - - &reftitle.examples; - - - <function>Imagick::frameImage</function> - - frameimage( - $color, - $width, - $height, - $innerBevel, - $outerBevel - ); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/functionimage.xml b/reference/imagick/imagick/functionimage.xml deleted file mode 100644 index 6af43f6c47dc..000000000000 --- a/reference/imagick/imagick/functionimage.xml +++ /dev/null @@ -1,179 +0,0 @@ - - - - - - Imagick::functionImage - Applies a function on the image - - - - &reftitle.description; - - public boolImagick::functionImage - intfunction - arrayarguments - intchannelImagick::CHANNEL_DEFAULT - - - Applies an arithmetic, relational, or logical expression to a pseudo image. - - - See also ImageMagick - v6 Examples - Image Transformations — Function, Multi-Argument Evaluate - - - &imagick.method.available.0x649; - - - - - &reftitle.parameters; - - - - function - - - Refer to this list of function constants - - - - - arguments - - - Array of arguments to pass to this function. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Create a sinusoidal gradient - -newPseudoImage(200, 200, 'gradient:black-white'); -$arguments = array(3, -90); -$imagick->functionImage(Imagick::FUNCTION_SINUSOID, $arguments); - -header("Content-Type: image/png"); -$imagick->setImageFormat("png"); -echo $imagick->getImageBlob(); -?> -]]> - - &example.outputs.similar; - - Output of create a sinusoidal gradient - - - - - - - - Create a gradient from the polynomial (4x^2 - 4x + 1) - -newPseudoImage(200, 200, 'gradient:black-white'); -$arguments = array(4, -4, 1); -$imagick->functionImage(Imagick::FUNCTION_POLYNOMIAL, $arguments); - -header("Content-Type: image/png"); -$imagick->setimageformat("png"); -echo $imagick->getImageBlob(); -?> -]]> - - &example.outputs.similar; - - Output of create a polynomial gradient - - - - - - - - - Create a complex gradient from the - polynomial (4x^2 - 4x^2 + 1) modulated by a sinusoidal gradient - - -newPseudoImage(200, 200, 'gradient:black-white'); -$arguments = array(9, -90); -$imagick1->functionImage(Imagick::FUNCTION_SINUSOID, $arguments); - -$imagick2 = new Imagick(); -$imagick2->newPseudoImage(200, 200, 'gradient:black-white'); -$arguments = array(0.5, 0); -$imagick2->functionImage(Imagick::FUNCTION_SINUSOID, $arguments); -$imagick1->compositeimage($imagick2, Imagick::COMPOSITE_MULTIPLY, 0, 0); - -header("Content-Type: image/png"); -$imagick1->setImageFormat("png"); -echo $imagick1->getImageBlob(); -?> -]]> - - &example.outputs.similar; - - Output of create complex gradient - - - - - - - - - - - - diff --git a/reference/imagick/imagick/fximage.xml b/reference/imagick/imagick/fximage.xml deleted file mode 100644 index 82f863f705fa..000000000000 --- a/reference/imagick/imagick/fximage.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - Imagick::fxImage - Evaluate expression for each pixel in the image - - - - &reftitle.description; - - public ImagickImagick::fxImage - stringexpression - intchannelImagick::CHANNEL_DEFAULT - - - Evaluate expression for each pixel in the image. Consult The Fx Special Effects Image - Operator for more information. - - - - - &reftitle.parameters; - - - - expression - - - The expression. - - - - - channel - - - Provide any channel constant that is valid for your channel mode. To - apply to more than one channel, combine channeltype constants using - bitwise operators. Refer to this - list of channel constants. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::fxImage</function> - - newPseudoImage(200, 200, "xc:white"); - - $fx = 'xx=i-w/2; yy=j-h/2; rr=hypot(xx,yy); (.5-rr/140)*1.2+.5'; - $fxImage = $imagick->fxImage($fx); - - header("Content-Type: image/png"); - $fxImage->setimageformat('png'); - echo $fxImage->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/gammaimage.xml b/reference/imagick/imagick/gammaimage.xml deleted file mode 100644 index d23283635e9f..000000000000 --- a/reference/imagick/imagick/gammaimage.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - Imagick::gammaImage - Gamma-corrects an image - - - - &reftitle.description; - - public boolImagick::gammaImage - floatgamma - intchannelImagick::CHANNEL_DEFAULT - - - Gamma-corrects an image. The same image viewed on different devices will - have perceptual differences in the way the image's intensities are - represented on the screen. Specify individual gamma levels for the red, - green, and blue channels, or adjust all three with the gamma parameter. - Values typically range from 0.8 to 2.3. - - - - - &reftitle.parameters; - - - - gamma - - - The amount of gamma-correction. - - - - - channel - - - Provide any channel constant that is valid for your channel mode. To - apply to more than one channel, combine channeltype constants using - bitwise operators. Refer to this - list of channel constants. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::gammaImage</function> - - gammaImage($gamma, $channel); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/gaussianblurimage.xml b/reference/imagick/imagick/gaussianblurimage.xml deleted file mode 100644 index 419b5125e683..000000000000 --- a/reference/imagick/imagick/gaussianblurimage.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - Imagick::gaussianBlurImage - Blurs an image - - - - &reftitle.description; - - public boolImagick::gaussianBlurImage - floatradius - floatsigma - intchannelImagick::CHANNEL_DEFAULT - - - Blurs an image. We convolve the image with a Gaussian operator of the - given radius and standard deviation (sigma). For reasonable results, the - radius should be larger than sigma. Use a radius of 0 and selects a - suitable radius for you. - - - - - &reftitle.parameters; - - - - radius - - - The radius of the Gaussian, in pixels, not counting the center pixel. - - - - - sigma - - - The standard deviation of the Gaussian, in pixels. - - - - - channel - - - Provide any channel constant that is valid for your channel mode. To - apply to more than one channel, combine channeltype constants using - bitwise operators. Refer to this - list of channel constants. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::gaussianBlurImage</function> - - gaussianBlurImage($radius, $sigma, $channel); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/getcolorspace.xml b/reference/imagick/imagick/getcolorspace.xml deleted file mode 100644 index 6ae2e59631af..000000000000 --- a/reference/imagick/imagick/getcolorspace.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - Imagick::getColorspace - Gets the colorspace - - - - &reftitle.description; - - public intImagick::getColorspace - - - - Gets the global colorspace value. - &imagick.method.available.0x657; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an integer which can be compared against COLORSPACE constants. - - - - - - diff --git a/reference/imagick/imagick/getcompression.xml b/reference/imagick/imagick/getcompression.xml deleted file mode 100644 index a87396f334fa..000000000000 --- a/reference/imagick/imagick/getcompression.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - Imagick::getCompression - Gets the object compression type - - - - &reftitle.description; - - public intImagick::getCompression - - - - - Gets the object compression type. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the compression constant - - - - - - diff --git a/reference/imagick/imagick/getcompressionquality.xml b/reference/imagick/imagick/getcompressionquality.xml deleted file mode 100644 index 4d6fc24e6296..000000000000 --- a/reference/imagick/imagick/getcompressionquality.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - Imagick::getCompressionQuality - Gets the object compression quality - - - - &reftitle.description; - - public intImagick::getCompressionQuality - - - - - Gets the object compression quality. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns integer describing the compression quality - - - - - - diff --git a/reference/imagick/imagick/getcopyright.xml b/reference/imagick/imagick/getcopyright.xml deleted file mode 100644 index d7d00bf3dfc5..000000000000 --- a/reference/imagick/imagick/getcopyright.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - Imagick::getCopyright - Returns the ImageMagick API copyright as a string - - - - &reftitle.description; - - public static stringImagick::getCopyright - - - - Returns the ImageMagick API copyright as a string. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a string containing the copyright notice of Imagemagick and - Magickwand C API. - - - - - - diff --git a/reference/imagick/imagick/getfilename.xml b/reference/imagick/imagick/getfilename.xml deleted file mode 100644 index 9035ac88826b..000000000000 --- a/reference/imagick/imagick/getfilename.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - Imagick::getFilename - The filename associated with an image sequence - - - - &reftitle.description; - - public stringImagick::getFilename - - - - Returns the filename associated with an image sequence. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a string on success. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getfont.xml b/reference/imagick/imagick/getfont.xml deleted file mode 100644 index 407cccd8b9f6..000000000000 --- a/reference/imagick/imagick/getfont.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - Imagick::getFont - Gets font - - - - &reftitle.description; - - public stringImagick::getFont - - - - Returns the objects font property. - &imagick.method.available.0x637; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the string containing the font name or &false; if not font is set. - - - - - &reftitle.seealso; - - - Imagick::setFont - ImagickDraw::setFont - ImagickDraw::getFont - - - - - - - diff --git a/reference/imagick/imagick/getformat.xml b/reference/imagick/imagick/getformat.xml deleted file mode 100644 index 7dc877cf531d..000000000000 --- a/reference/imagick/imagick/getformat.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - Imagick::getFormat - Returns the format of the Imagick object - - - - &reftitle.description; - - public stringImagick::getFormat - - - - Returns the format of the Imagick object. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the format of the image. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getgravity.xml b/reference/imagick/imagick/getgravity.xml deleted file mode 100644 index a4d6709de06b..000000000000 --- a/reference/imagick/imagick/getgravity.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - Imagick::getGravity - Gets the gravity - - - - &reftitle.description; - - public intImagick::getGravity - - - - - Gets the global gravity property for the Imagick object. - &imagick.method.available.0x640; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the gravity property. Refer to the list of - gravity constants. - - - - - - diff --git a/reference/imagick/imagick/gethomeurl.xml b/reference/imagick/imagick/gethomeurl.xml deleted file mode 100644 index e73225df6716..000000000000 --- a/reference/imagick/imagick/gethomeurl.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - Imagick::getHomeURL - Returns the ImageMagick home URL - - - - &reftitle.description; - - public static stringImagick::getHomeURL - - - - Returns the ImageMagick home URL. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a link to the imagemagick homepage. - - - - - - diff --git a/reference/imagick/imagick/getimage.xml b/reference/imagick/imagick/getimage.xml deleted file mode 100644 index 5d56989dc19a..000000000000 --- a/reference/imagick/imagick/getimage.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - Imagick::getImage - Returns a new Imagick object - - - - &reftitle.description; - - public ImagickImagick::getImage - - - - Returns a new Imagick object with the current image sequence. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a new Imagick object with the current image sequence. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagealphachannel.xml b/reference/imagick/imagick/getimagealphachannel.xml deleted file mode 100644 index c61718eea1cf..000000000000 --- a/reference/imagick/imagick/getimagealphachannel.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - Imagick::getImageAlphaChannel - Checks if the image has an alpha channel - - - - &reftitle.description; - - public boolImagick::getImageAlphaChannel - - - - - Returns whether the image has an alpha channel. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; if the image has an alpha channel value and &false; if not, - i.e. the image is RGB rather than RGBA - or CMYK rather than CMYKA. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL imagick 3.6.0 - - Returns a &boolean; now; previously, an &integer; was returned. - - - - - - - - - - diff --git a/reference/imagick/imagick/getimageartifact.xml b/reference/imagick/imagick/getimageartifact.xml deleted file mode 100644 index 1aff02bb8c9d..000000000000 --- a/reference/imagick/imagick/getimageartifact.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - Imagick::getImageArtifact - Get image artifact - - - - &reftitle.description; - - public stringImagick::getImageArtifact - stringartifact - - - Gets an artifact associated with the image. The difference between image properties and - image artifacts is that properties are public and artifacts are private. - &imagick.method.available.0x657; - - - - - &reftitle.parameters; - - - - artifact - - - The name of the artifact - - - - - - - - - &reftitle.returnvalues; - - Returns the artifact value on success. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.seealso; - - - Imagick::setImageArtifact - Imagick::deleteImageArtifact - - - - - - - diff --git a/reference/imagick/imagick/getimageattribute.xml b/reference/imagick/imagick/getimageattribute.xml deleted file mode 100644 index 5095ea9db140..000000000000 --- a/reference/imagick/imagick/getimageattribute.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - Imagick::getImageAttribute - Returns a named attribute - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public stringImagick::getImageAttribute - stringkey - - - Returns a named attribute. - - - - - - - &reftitle.parameters; - - - key - - - The key of the attribute to get. - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/imagick/imagick/getimagebackgroundcolor.xml b/reference/imagick/imagick/getimagebackgroundcolor.xml deleted file mode 100644 index 2be924ff387f..000000000000 --- a/reference/imagick/imagick/getimagebackgroundcolor.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - Imagick::getImageBackgroundColor - Returns the image background color - - - - &reftitle.description; - - public ImagickPixelImagick::getImageBackgroundColor - - - - Returns the image background color. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an ImagickPixel set to the background color of the image. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimageblob.xml b/reference/imagick/imagick/getimageblob.xml deleted file mode 100644 index 9cdc770c3a88..000000000000 --- a/reference/imagick/imagick/getimageblob.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - Imagick::getImageBlob - Returns the image sequence as a blob - - - - &reftitle.description; - - public stringImagick::getImageBlob - - - - Implements direct to memory image formats. It returns the image - sequence as a string. The format of the image determines the - format of the returned blob (GIF, JPEG, PNG, etc.). To return a - different image format, use Imagick::setImageFormat(). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a string containing the image. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimageblueprimary.xml b/reference/imagick/imagick/getimageblueprimary.xml deleted file mode 100644 index 271f6d0efb04..000000000000 --- a/reference/imagick/imagick/getimageblueprimary.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - Imagick::getImageBluePrimary - Returns the chromaticy blue primary point - - - - &reftitle.description; - - public arrayImagick::getImageBluePrimary - - - - Returns the chromaticity blue primary point for the image. - - - - - &reftitle.parameters; - - - - x - - - The chromaticity blue primary x-point. - - - - - y - - - The chromaticity blue primary y-point. - - - - - - - - - &reftitle.returnvalues; - - Array consisting of "x" and "y" coordinates of point. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagebordercolor.xml b/reference/imagick/imagick/getimagebordercolor.xml deleted file mode 100644 index ad2150f4a6b2..000000000000 --- a/reference/imagick/imagick/getimagebordercolor.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - Imagick::getImageBorderColor - Returns the image border color - - - - &reftitle.description; - - public ImagickPixelImagick::getImageBorderColor - - - - Returns the image border color. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagechanneldepth.xml b/reference/imagick/imagick/getimagechanneldepth.xml deleted file mode 100644 index 282bbccdd783..000000000000 --- a/reference/imagick/imagick/getimagechanneldepth.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - Imagick::getImageChannelDepth - Gets the depth for a particular image channel - - - - &reftitle.description; - - public intImagick::getImageChannelDepth - intchannel - - - - Gets the depth for a particular image channel. - - - - - &reftitle.parameters; - - - - channel - - - &imagick.parameter.channel; - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/getimagechanneldistortion.xml b/reference/imagick/imagick/getimagechanneldistortion.xml deleted file mode 100644 index f531292e221f..000000000000 --- a/reference/imagick/imagick/getimagechanneldistortion.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - Imagick::getImageChannelDistortion - Compares image channels of an image to a reconstructed image - - - - &reftitle.description; - - public floatImagick::getImageChannelDistortion - Imagickreference - intchannel - intmetric - - - Compares one or more image channels of an image to a reconstructed image - and returns the specified distortion metric. - - - - - &reftitle.parameters; - - - - reference - - - Imagick object to compare to. - - - - - channel - - - Provide any channel constant that is valid for your channel mode. To - apply to more than one channel, combine channeltype constants using - bitwise operators. Refer to this - list of channel constants. - - - - - metric - - - One of the metric type constants. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagechanneldistortions.xml b/reference/imagick/imagick/getimagechanneldistortions.xml deleted file mode 100644 index f31b52125339..000000000000 --- a/reference/imagick/imagick/getimagechanneldistortions.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - Imagick::getImageChannelDistortions - Gets channel distortions - - - - &reftitle.description; - - public floatImagick::getImageChannelDistortions - Imagickreference - intmetric - intchannelImagick::CHANNEL_DEFAULT - - - - Compares one or more image channels of an image to a reconstructed image and returns the specified distortion metrics - &imagick.method.available.0x644; - - - - - &reftitle.parameters; - - - - reference - - - Imagick object containing the reference image - - - - - metric - - - Refer to this list of metric type constants. - - - - - channel - - - &imagick.parameter.channel; - - - - - - - - - &reftitle.returnvalues; - - Returns a float describing the channel distortion. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagechannelextrema.xml b/reference/imagick/imagick/getimagechannelextrema.xml deleted file mode 100644 index 6a7314520ccd..000000000000 --- a/reference/imagick/imagick/getimagechannelextrema.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - Imagick::getImageChannelExtrema - Gets the extrema for one or more image channels - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public arrayImagick::getImageChannelExtrema - intchannel - - - Gets the extrema for one or more image channels. Return value is an - associative array with the keys "minima" and "maxima". - - - - - &reftitle.parameters; - - - - channel - - - Provide any channel constant that is valid for your channel mode. To - apply to more than one channel, combine channeltype constants using - bitwise operators. Refer to this - list of channel constants. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagechannelkurtosis.xml b/reference/imagick/imagick/getimagechannelkurtosis.xml deleted file mode 100644 index dc440f31045b..000000000000 --- a/reference/imagick/imagick/getimagechannelkurtosis.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - Imagick::getImageChannelKurtosis - The getImageChannelKurtosis purpose - - - - &reftitle.description; - - public arrayImagick::getImageChannelKurtosis - intchannelImagick::CHANNEL_DEFAULT - - - Get the kurtosis and skewness of a specific channel. &imagick.method.available.0x649; - - - - - &reftitle.parameters; - - - - channel - - - &imagick.parameter.channel; - - - - - - - - - &reftitle.returnvalues; - - Returns an array with kurtosis and skewness - members. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - diff --git a/reference/imagick/imagick/getimagechannelmean.xml b/reference/imagick/imagick/getimagechannelmean.xml deleted file mode 100644 index 23d5e733330c..000000000000 --- a/reference/imagick/imagick/getimagechannelmean.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - Imagick::getImageChannelMean - Gets the mean and standard deviation - - - - &reftitle.description; - - public arrayImagick::getImageChannelMean - intchannel - - - Gets the mean and standard deviation of one or more image channels. - - - - - &reftitle.parameters; - - - - channel - - - Provide any channel constant that is valid for your channel mode. To - apply to more than one channel, combine channeltype constants using - bitwise operators. Refer to this - list of channel constants. - - - - - - - - - &reftitle.returnvalues; - - Returns an array with "mean" and "standardDeviation" - members. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagechannelrange.xml b/reference/imagick/imagick/getimagechannelrange.xml deleted file mode 100644 index 32622523aca0..000000000000 --- a/reference/imagick/imagick/getimagechannelrange.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - Imagick::getImageChannelRange - Gets channel range - - - - &reftitle.description; - - public arrayImagick::getImageChannelRange - intchannel - - - - Gets the range for one or more image channels. - &imagick.method.available.0x640; - - - - - &reftitle.parameters; - - - - channel - - - &imagick.parameter.channel; - - - - - - - - - &reftitle.returnvalues; - - Returns an array containing minima and maxima values of the channel(s). - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagechannelstatistics.xml b/reference/imagick/imagick/getimagechannelstatistics.xml deleted file mode 100644 index cf4dbdd7b87d..000000000000 --- a/reference/imagick/imagick/getimagechannelstatistics.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - Imagick::getImageChannelStatistics - Returns statistics for each channel in the image - - - - &reftitle.description; - - public arrayImagick::getImageChannelStatistics - - - - Returns statistics for each channel in the image. The statistics include - the channel depth, its minima and maxima, the mean, and the standard - deviation. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/getimageclipmask.xml b/reference/imagick/imagick/getimageclipmask.xml deleted file mode 100644 index 3b8119f78c64..000000000000 --- a/reference/imagick/imagick/getimageclipmask.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - Imagick::getImageClipMask - Gets image clip mask - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public ImagickImagick::getImageClipMask - - - - - Returns the image clip mask. The clip mask is an Imagick object containing the clip mask. - &imagick.method.available.0x636; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an Imagick object containing the clip mask. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagecolormapcolor.xml b/reference/imagick/imagick/getimagecolormapcolor.xml deleted file mode 100644 index be239b42ae31..000000000000 --- a/reference/imagick/imagick/getimagecolormapcolor.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - Imagick::getImageColormapColor - Returns the color of the specified colormap index - - - - &reftitle.description; - - public ImagickPixelImagick::getImageColormapColor - intindex - - - Returns the color of the specified colormap index. - - - - - &reftitle.parameters; - - - - index - - - The offset into the image colormap. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagecolors.xml b/reference/imagick/imagick/getimagecolors.xml deleted file mode 100644 index 9c428bc15579..000000000000 --- a/reference/imagick/imagick/getimagecolors.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - Imagick::getImageColors - Gets the number of unique colors in the image - - - - &reftitle.description; - - public intImagick::getImageColors - - - - Gets the number of unique colors in the image. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an int, the number of unique colors in the image. - - - - - - diff --git a/reference/imagick/imagick/getimagecolorspace.xml b/reference/imagick/imagick/getimagecolorspace.xml deleted file mode 100644 index 830906fea287..000000000000 --- a/reference/imagick/imagick/getimagecolorspace.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - Imagick::getImageColorspace - Gets the image colorspace - - - - &reftitle.description; - - public intImagick::getImageColorspace - - - - Gets the image colorspace. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an integer which can be compared against COLORSPACE constants. - - - - - - diff --git a/reference/imagick/imagick/getimagecompose.xml b/reference/imagick/imagick/getimagecompose.xml deleted file mode 100644 index 7de0538f0b11..000000000000 --- a/reference/imagick/imagick/getimagecompose.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - Imagick::getImageCompose - Returns the composite operator associated with the image - - - - &reftitle.description; - - public intImagick::getImageCompose - - - - Returns the composite operator associated with the image. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/getimagecompression.xml b/reference/imagick/imagick/getimagecompression.xml deleted file mode 100644 index 1bc6e5a65a6b..000000000000 --- a/reference/imagick/imagick/getimagecompression.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - Imagick::getImageCompression - Gets the current image's compression type - - - - &reftitle.description; - - public intImagick::getImageCompression - - - - - Gets the current image's compression type. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the compression constant - - - - - - diff --git a/reference/imagick/imagick/getimagecompressionquality.xml b/reference/imagick/imagick/getimagecompressionquality.xml deleted file mode 100644 index 6c887b843573..000000000000 --- a/reference/imagick/imagick/getimagecompressionquality.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - Imagick::getImageCompressionQuality - Gets the current image's compression quality - - - - &reftitle.description; - - public intImagick::getImageCompressionQuality - - - - - Gets the current image's compression quality - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns integer describing the images compression quality - - - - - - diff --git a/reference/imagick/imagick/getimagedelay.xml b/reference/imagick/imagick/getimagedelay.xml deleted file mode 100644 index c9644d94abb9..000000000000 --- a/reference/imagick/imagick/getimagedelay.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - Imagick::getImageDelay - Gets the image delay - - - - &reftitle.description; - - public intImagick::getImageDelay - - - - Gets the image delay. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the image delay. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagedepth.xml b/reference/imagick/imagick/getimagedepth.xml deleted file mode 100644 index d7cd2ed0e0b5..000000000000 --- a/reference/imagick/imagick/getimagedepth.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - Imagick::getImageDepth - Gets the image depth - - - - &reftitle.description; - - public intImagick::getImageDepth - - - - Gets the image depth. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The image depth. - - - - - - diff --git a/reference/imagick/imagick/getimagedispose.xml b/reference/imagick/imagick/getimagedispose.xml deleted file mode 100644 index 3da2a2d6aa68..000000000000 --- a/reference/imagick/imagick/getimagedispose.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - Imagick::getImageDispose - Gets the image disposal method - - - - &reftitle.description; - - public intImagick::getImageDispose - - - - Gets the image disposal method. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the dispose method on success. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagedistortion.xml b/reference/imagick/imagick/getimagedistortion.xml deleted file mode 100644 index eb3b207a7163..000000000000 --- a/reference/imagick/imagick/getimagedistortion.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - Imagick::getImageDistortion - Compares an image to a reconstructed image - - - - &reftitle.description; - - public floatImagick::getImageDistortion - MagickWandreference - intmetric - - - Compares an image to a reconstructed image and returns the specified distortion - metric. - - - - - &reftitle.parameters; - - - - reference - - - Imagick object to compare to. - - - - - metric - - - One of the metric type constants. - - - - - - - - - &reftitle.returnvalues; - - Returns the distortion metric used on the image (or the best guess - thereof). - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimageextrema.xml b/reference/imagick/imagick/getimageextrema.xml deleted file mode 100644 index 6f0457178a64..000000000000 --- a/reference/imagick/imagick/getimageextrema.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - Imagick::getImageExtrema - Gets the extrema for the image - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public arrayImagick::getImageExtrema - - - - Gets the extrema for the image. Returns an associative array with the keys "min" and "max". - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an associative array with the keys "min" and "max". - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagefilename.xml b/reference/imagick/imagick/getimagefilename.xml deleted file mode 100644 index 23c4461b7dd9..000000000000 --- a/reference/imagick/imagick/getimagefilename.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - Imagick::getImageFilename - Returns the filename of a particular image in a sequence - - - - &reftitle.description; - - public stringImagick::getImageFilename - - - - Returns the filename of a particular image in a sequence. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a string with the filename of the image. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimageformat.xml b/reference/imagick/imagick/getimageformat.xml deleted file mode 100644 index 6fb7bf1f57a2..000000000000 --- a/reference/imagick/imagick/getimageformat.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - Imagick::getImageFormat - Returns the format of a particular image in a sequence - - - - &reftitle.description; - - public stringImagick::getImageFormat - - - - Returns the format of a particular image in a sequence. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a string containing the image format on success. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagegamma.xml b/reference/imagick/imagick/getimagegamma.xml deleted file mode 100644 index 1e877c8ba218..000000000000 --- a/reference/imagick/imagick/getimagegamma.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - Imagick::getImageGamma - Gets the image gamma - - - - &reftitle.description; - - public floatImagick::getImageGamma - - - - Gets the image gamma. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the image gamma on success. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagegeometry.xml b/reference/imagick/imagick/getimagegeometry.xml deleted file mode 100644 index 0e65740b6369..000000000000 --- a/reference/imagick/imagick/getimagegeometry.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - Imagick::getImageGeometry - Gets the width and height as an associative array - - - - &reftitle.description; - - public arrayImagick::getImageGeometry - - - - Returns the width and height as an associative array. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an array with the width/height of the image. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - Using <function>Imagick::getImageGeometry</function> - - newImage(100, 200, "black"); -print_r($imagick->getImageGeometry()); -?> -]]> - - &example.outputs; - - 100 - [height] => 200 -) -]]> - - - - - - - - diff --git a/reference/imagick/imagick/getimagegravity.xml b/reference/imagick/imagick/getimagegravity.xml deleted file mode 100644 index f39636ebdc44..000000000000 --- a/reference/imagick/imagick/getimagegravity.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - Imagick::getImageGravity - Gets the image gravity - - - - &reftitle.description; - - public intImagick::getImageGravity - - - - - Gets the current gravity value of the - image. Unlike Imagick::getGravity, this method - returns the gravity defined for the current image sequence. - &imagick.method.available.0x644; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the images gravity property. Refer to the list of - gravity constants. - - - - - - diff --git a/reference/imagick/imagick/getimagegreenprimary.xml b/reference/imagick/imagick/getimagegreenprimary.xml deleted file mode 100644 index 5291478427fe..000000000000 --- a/reference/imagick/imagick/getimagegreenprimary.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - Imagick::getImageGreenPrimary - Returns the chromaticy green primary point - - - - &reftitle.description; - - public arrayImagick::getImageGreenPrimary - - - - Returns the chromaticity green primary point. Returns an array with the keys "x" and "y". - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an array with the keys "x" and "y" on success, throws an - ImagickException on failure. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimageheight.xml b/reference/imagick/imagick/getimageheight.xml deleted file mode 100644 index 592e7a020ee0..000000000000 --- a/reference/imagick/imagick/getimageheight.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - Imagick::getImageHeight - Returns the image height - - - - &reftitle.description; - - public intImagick::getImageHeight - - - - Returns the image height. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the image height in pixels. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagehistogram.xml b/reference/imagick/imagick/getimagehistogram.xml deleted file mode 100644 index 17e1e1757dec..000000000000 --- a/reference/imagick/imagick/getimagehistogram.xml +++ /dev/null @@ -1,162 +0,0 @@ - - - - - Imagick::getImageHistogram - Gets the image histogram - - - - &reftitle.description; - - public arrayImagick::getImageHistogram - - - - Returns the image histogram as an array of ImagickPixel objects. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the image histogram as an array of ImagickPixel objects. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - Generates <function>Imagick::getImageHistogram</function> - - getColorValue($colorChannel); - $color = intval($color * 255); - $count = $histogramElement->getColorCount(); - - if (array_key_exists($color, $colorStatistics)) { - $colorStatistics[$color] += $count; - } - else { - $colorStatistics[$color] = $count; - } - } - - ksort($colorStatistics); - - return $colorStatistics; -} - - - -function getImageHistogram($imagePath) { - - $backgroundColor = 'black'; - - $draw = new \ImagickDraw(); - $draw->setStrokeWidth(0); //make the lines be as thin as possible - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - $histogramWidth = 256; - $histogramHeight = 100; // the height for each RGB segment - - $imagick = new \Imagick(realpath($imagePath)); - //Resize the image to be small, otherwise PHP tends to run out of memory - //This might lead to bad results for images that are pathologically 'pixelly' - $imagick->adaptiveResizeImage(200, 200, true); - $histogramElements = $imagick->getImageHistogram(); - - $histogram = new \Imagick(); - $histogram->newpseudoimage($histogramWidth, $histogramHeight * 3, 'xc:black'); - $histogram->setImageFormat('png'); - - $getMax = function ($carry, $item) { - if ($item > $carry) { - return $item; - } - return $carry; - }; - - $colorValues = [ - 'red' => getColorStatistics($histogramElements, \Imagick::COLOR_RED), - 'lime' => getColorStatistics($histogramElements, \Imagick::COLOR_GREEN), - 'blue' => getColorStatistics($histogramElements, \Imagick::COLOR_BLUE), - ]; - - $max = array_reduce($colorValues['red'] , $getMax, 0); - $max = array_reduce($colorValues['lime'] , $getMax, $max); - $max = array_reduce($colorValues['blue'] , $getMax, $max); - - $scale = $histogramHeight / $max; - - $count = 0; - foreach ($colorValues as $color => $values) { - $draw->setstrokecolor($color); - - $offset = ($count + 1) * $histogramHeight; - - foreach ($values as $index => $value) { - $draw->line($index, $offset, $index, $offset - ($value * $scale)); - } - $count++; - } - - $histogram->drawImage($draw); - - header( "Content-Type: image/png" ); - echo $histogram; -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/getimageindex.xml b/reference/imagick/imagick/getimageindex.xml deleted file mode 100644 index a54450f67104..000000000000 --- a/reference/imagick/imagick/getimageindex.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - Imagick::getImageIndex - Gets the index of the current active image - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public intImagick::getImageIndex - - - - Returns the index of the current active image within the Imagick object. - This method has been deprecated. See - Imagick::getIteratorIndex. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an integer containing the index of the image in the stack. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimageinterlacescheme.xml b/reference/imagick/imagick/getimageinterlacescheme.xml deleted file mode 100644 index 608173aad11c..000000000000 --- a/reference/imagick/imagick/getimageinterlacescheme.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - Imagick::getImageInterlaceScheme - Gets the image interlace scheme - - - - &reftitle.description; - - public intImagick::getImageInterlaceScheme - - - - Gets the image interlace scheme. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the interlace scheme as an integer on success. - &imagick.imagickexception.throw; - - - - - - diff --git a/reference/imagick/imagick/getimageinterpolatemethod.xml b/reference/imagick/imagick/getimageinterpolatemethod.xml deleted file mode 100644 index 491f47a74292..000000000000 --- a/reference/imagick/imagick/getimageinterpolatemethod.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - Imagick::getImageInterpolateMethod - Returns the interpolation method - - - - &reftitle.description; - - public intImagick::getImageInterpolateMethod - - - - Returns the interpolation method for the specified image. The method is one of - the Imagick::INTERPOLATE_* constants. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the interpolate method on success. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimageiterations.xml b/reference/imagick/imagick/getimageiterations.xml deleted file mode 100644 index eb0265a456d1..000000000000 --- a/reference/imagick/imagick/getimageiterations.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - Imagick::getImageIterations - Gets the image iterations - - - - &reftitle.description; - - public intImagick::getImageIterations - - - - Gets the image iterations. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the image iterations as an integer. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagelength.xml b/reference/imagick/imagick/getimagelength.xml deleted file mode 100644 index 13474f100b54..000000000000 --- a/reference/imagick/imagick/getimagelength.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - Imagick::getImageLength - Returns the image length in bytes - - - - &reftitle.description; - - public intImagick::getImageLength - - - - Returns the image length in bytes - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an int containing the current image size. - - - - - &reftitle.examples; - - - Using <function>Imagick::getImageLength</function>: - - Getting image length in bytes - - -getImageLength() . ' bytes'; -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/getimagematte.xml b/reference/imagick/imagick/getimagematte.xml deleted file mode 100644 index 881b6146931e..000000000000 --- a/reference/imagick/imagick/getimagematte.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - Imagick::getImageMatte - Return if the image has a matte channel - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::getImageMatte - - - - - Returns &true; if the image has a matte channel otherwise false. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/getimagemattecolor.xml b/reference/imagick/imagick/getimagemattecolor.xml deleted file mode 100644 index 317790ab3ab2..000000000000 --- a/reference/imagick/imagick/getimagemattecolor.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - Imagick::getImageMatteColor - Returns the image matte color - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public ImagickPixelImagick::getImageMatteColor - - - - Returns the image matte color. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns ImagickPixel object on success. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagemimetype.xml b/reference/imagick/imagick/getimagemimetype.xml deleted file mode 100644 index a4b7e3c70b58..000000000000 --- a/reference/imagick/imagick/getimagemimetype.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Imagick::getImageMimeType - Returns the image mime-type - - - - &reftitle.description; - - public stringImagick::getImageMimeType - - - - Returns the image mime-type. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/imagick/imagick/getimageorientation.xml b/reference/imagick/imagick/getimageorientation.xml deleted file mode 100644 index d1beff313310..000000000000 --- a/reference/imagick/imagick/getimageorientation.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - Imagick::getImageOrientation - Gets the image orientation - - - - &reftitle.description; - - public intImagick::getImageOrientation - - - - - Gets the image orientation. The return value is one of the orientation constants. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an int on success. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagepage.xml b/reference/imagick/imagick/getimagepage.xml deleted file mode 100644 index 447e96699c5f..000000000000 --- a/reference/imagick/imagick/getimagepage.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - Imagick::getImagePage - Returns the page geometry - - - - &reftitle.description; - - public arrayImagick::getImagePage - - - - Returns the page geometry associated with the image in an array with the - keys "width", "height", "x", and "y". - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the page geometry associated with the image in an array with the - keys "width", "height", "x", and "y". - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagepixelcolor.xml b/reference/imagick/imagick/getimagepixelcolor.xml deleted file mode 100644 index c5768690c897..000000000000 --- a/reference/imagick/imagick/getimagepixelcolor.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - Imagick::getImagePixelColor - Returns the color of the specified pixel - - - - &reftitle.description; - - public ImagickPixelImagick::getImagePixelColor - intx - inty - - - Returns the color of the specified pixel. - - - - - &reftitle.parameters; - - - - x - - - The x-coordinate of the pixel - - - - - y - - - The y-coordinate of the pixel - - - - - - - - - &reftitle.returnvalues; - - Returns an ImagickPixel instance for the color at the coordinates given. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimageprofile.xml b/reference/imagick/imagick/getimageprofile.xml deleted file mode 100644 index 5189bbf5d155..000000000000 --- a/reference/imagick/imagick/getimageprofile.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - Imagick::getImageProfile - Returns the named image profile - - - - &reftitle.description; - - public stringImagick::getImageProfile - stringname - - - Returns the named image profile. - - - - - &reftitle.parameters; - - - - name - - - The name of the profile to return. - - - - - - - - - &reftitle.returnvalues; - - Returns a string containing the image profile. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimageprofiles.xml b/reference/imagick/imagick/getimageprofiles.xml deleted file mode 100644 index 7e5f7c1608c5..000000000000 --- a/reference/imagick/imagick/getimageprofiles.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - Imagick::getImageProfiles - Returns the image profiles - - - - &reftitle.description; - - public arrayImagick::getImageProfiles - stringpattern"*" - boolinclude_values&true; - - - - Returns all associated profiles that match the pattern. If &false; is passed as second parameter - only the profile names are returned. &imagick.method.available.0x636; - - - - - &reftitle.parameters; - - - - pattern - - - The pattern for profile names. - - - - - include_values - - - Whether to return only profile names. If &false; then only profile names will be returned. - - - - - - - - - &reftitle.returnvalues; - - Returns an array containing the image profiles or profile names. - - - - - - diff --git a/reference/imagick/imagick/getimageproperties.xml b/reference/imagick/imagick/getimageproperties.xml deleted file mode 100644 index d8e708de27bc..000000000000 --- a/reference/imagick/imagick/getimageproperties.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - Imagick::getImageProperties - Returns the image properties - - - - &reftitle.description; - - public arrayImagick::getImageProperties - stringpattern"*" - boolinclude_values&true; - - - - Returns all associated properties that match the pattern. If &false; is passed as second parameter - only the property names are returned. &imagick.method.available.0x636; - - - - - &reftitle.parameters; - - - - pattern - - - The pattern for property names. - - - - - include_values - - - Whether to return only property names. If &false; then only property names will be returned. - - - - - - - - - &reftitle.returnvalues; - - Returns an array containing the image properties or property names. - - - - - &reftitle.examples; - - - Using <function>Imagick::getImageProperties</function>: - - An example of extracting EXIF information. - - -getImageProperties("exif:*"); - -/* Loop through the EXIF properties */ -foreach ($exifArray as $name => $property) -{ - echo "{$name} => {$property}
\n"; -} - -?> -]]> -
-
-
-
- -
- - diff --git a/reference/imagick/imagick/getimageproperty.xml b/reference/imagick/imagick/getimageproperty.xml deleted file mode 100644 index 93b62655d9c4..000000000000 --- a/reference/imagick/imagick/getimageproperty.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - Imagick::getImageProperty - Returns the named image property - - - - &reftitle.description; - - public stringImagick::getImageProperty - stringname - - - - Returns the named image property. &imagick.method.available.0x632; - - - - - &reftitle.parameters; - - - - name - - - name of the property (for example Exif:DateTime) - - - - - - - - - &reftitle.returnvalues; - - Returns a string containing the image property, false if a - property with the given name does not exist. - - - - - &reftitle.examples; - - - Using <function>Imagick::getImageProperty</function>: - - Setting and getting image property - - -newImage(300, 200, "black"); - -$image->setImageProperty('Exif:Make', 'Imagick'); -echo $image->getImageProperty('Exif:Make'); -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::setImageProperty - - - - - - - diff --git a/reference/imagick/imagick/getimageredprimary.xml b/reference/imagick/imagick/getimageredprimary.xml deleted file mode 100644 index c63f6a7be307..000000000000 --- a/reference/imagick/imagick/getimageredprimary.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - Imagick::getImageRedPrimary - Returns the chromaticity red primary point - - - - &reftitle.description; - - public arrayImagick::getImageRedPrimary - - - - Returns the chromaticity red primary point as an array with the keys "x" and "y". - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the chromaticity red primary point as an array with the keys "x" - and "y". - &imagick.imagickexception.throw; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimageregion.xml b/reference/imagick/imagick/getimageregion.xml deleted file mode 100644 index f18015937d28..000000000000 --- a/reference/imagick/imagick/getimageregion.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - Imagick::getImageRegion - Extracts a region of the image - - - - &reftitle.description; - - public ImagickImagick::getImageRegion - intwidth - intheight - intx - inty - - - Extracts a region of the image and returns it as a new Imagick object. - - - - - &reftitle.parameters; - - - - width - - - The width of the extracted region. - - - - - height - - - The height of the extracted region. - - - - - x - - - X-coordinate of the top-left corner of the extracted region. - - - - - y - - - Y-coordinate of the top-left corner of the extracted region. - - - - - - - - - &reftitle.returnvalues; - - Extracts a region of the image and returns it as a new wand. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagerenderingintent.xml b/reference/imagick/imagick/getimagerenderingintent.xml deleted file mode 100644 index dd8fffad62ac..000000000000 --- a/reference/imagick/imagick/getimagerenderingintent.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - Imagick::getImageRenderingIntent - Gets the image rendering intent - - - - &reftitle.description; - - public intImagick::getImageRenderingIntent - - - - Gets the image rendering intent. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the image rendering intent. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimageresolution.xml b/reference/imagick/imagick/getimageresolution.xml deleted file mode 100644 index 7c4bff848d42..000000000000 --- a/reference/imagick/imagick/getimageresolution.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - Imagick::getImageResolution - Gets the image X and Y resolution - - - - &reftitle.description; - - public arrayImagick::getImageResolution - - - - Gets the image X and Y resolution. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the resolution as an array. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagesblob.xml b/reference/imagick/imagick/getimagesblob.xml deleted file mode 100644 index 79d635ce585a..000000000000 --- a/reference/imagick/imagick/getimagesblob.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - Imagick::getImagesBlob - Returns all image sequences as a blob - - - - &reftitle.description; - - public stringImagick::getImagesBlob - - - - Implements direct to memory image formats. It returns all image - sequences as a string. The format of the image determines the - format of the returned blob (GIF, JPEG, PNG, etc.). To return a - different image format, use Imagick::setImageFormat(). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a string containing the images. On failure, throws - ImagickException. - - - - - - diff --git a/reference/imagick/imagick/getimagescene.xml b/reference/imagick/imagick/getimagescene.xml deleted file mode 100644 index 66c71fdc225a..000000000000 --- a/reference/imagick/imagick/getimagescene.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - Imagick::getImageScene - Gets the image scene - - - - &reftitle.description; - - public intImagick::getImageScene - - - - Gets the image scene. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the image scene. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagesignature.xml b/reference/imagick/imagick/getimagesignature.xml deleted file mode 100644 index 910a9a72391c..000000000000 --- a/reference/imagick/imagick/getimagesignature.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - Imagick::getImageSignature - Generates an SHA-256 message digest - - - - &reftitle.description; - - public stringImagick::getImageSignature - - - - Generates an SHA-256 message digest for the image pixel stream. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a string containing the SHA-256 hash of the file. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagesize.xml b/reference/imagick/imagick/getimagesize.xml deleted file mode 100644 index ac610753558d..000000000000 --- a/reference/imagick/imagick/getimagesize.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - Imagick::getImageSize - Returns the image length in bytes - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public intImagick::getImageSize - - - - Returns the image length in bytes. - Deprecated in favour of Imagick::getImageLength() - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an int containing the current image size. - - - - - - diff --git a/reference/imagick/imagick/getimagetickspersecond.xml b/reference/imagick/imagick/getimagetickspersecond.xml deleted file mode 100644 index 838b3194b40e..000000000000 --- a/reference/imagick/imagick/getimagetickspersecond.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - Imagick::getImageTicksPerSecond - Gets the image ticks-per-second - - - - &reftitle.description; - - public intImagick::getImageTicksPerSecond - - - - Gets the image ticks-per-second. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the image ticks-per-second. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagetotalinkdensity.xml b/reference/imagick/imagick/getimagetotalinkdensity.xml deleted file mode 100644 index e3243950445b..000000000000 --- a/reference/imagick/imagick/getimagetotalinkdensity.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - Imagick::getImageTotalInkDensity - Gets the image total ink density - - - - &reftitle.description; - - public floatImagick::getImageTotalInkDensity - - - - Gets the image total ink density. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the image total ink density of the image. - &imagick.imagickexception.throw; - - - - - - diff --git a/reference/imagick/imagick/getimagetype.xml b/reference/imagick/imagick/getimagetype.xml deleted file mode 100644 index 43cc14a80ff8..000000000000 --- a/reference/imagick/imagick/getimagetype.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - Imagick::getImageType - Gets the image type - - - - &reftitle.description; - - public intImagick::getImageType - - - - Returns the type of the image, derived from its colorspace, its storage - class and whether it carries an alpha channel. The pixels themselves are - not examined, so the value reflects how the image is currently held rather - than the smallest type it could be reduced to. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns one of the following - imagick::IMGTYPE_* - constants. imagick::IMGTYPE_UNDEFINED and - imagick::IMGTYPE_OPTIMIZE are never returned. - - - - - imagick::IMGTYPE_BILEVEL - - - - - imagick::IMGTYPE_GRAYSCALE - - - - - imagick::IMGTYPE_GRAYSCALEMATTE - - - - - imagick::IMGTYPE_PALETTE - - - - - imagick::IMGTYPE_PALETTEMATTE - - - - - imagick::IMGTYPE_TRUECOLOR - - - - - imagick::IMGTYPE_TRUECOLORMATTE - - - - - imagick::IMGTYPE_COLORSEPARATION - - - - - imagick::IMGTYPE_COLORSEPARATIONMATTE - - - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimageunits.xml b/reference/imagick/imagick/getimageunits.xml deleted file mode 100644 index bdc55d69c6e3..000000000000 --- a/reference/imagick/imagick/getimageunits.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - Imagick::getImageUnits - Gets the image units of resolution - - - - &reftitle.description; - - public intImagick::getImageUnits - - - - Gets the image units of resolution. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the image units of resolution. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagevirtualpixelmethod.xml b/reference/imagick/imagick/getimagevirtualpixelmethod.xml deleted file mode 100644 index 453853b6265a..000000000000 --- a/reference/imagick/imagick/getimagevirtualpixelmethod.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - Imagick::getImageVirtualPixelMethod - Returns the virtual pixel method - - - - &reftitle.description; - - public intImagick::getImageVirtualPixelMethod - - - - Returns the virtual pixel method for the specified image. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the virtual pixel method on success. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagewhitepoint.xml b/reference/imagick/imagick/getimagewhitepoint.xml deleted file mode 100644 index e0c34cdc5791..000000000000 --- a/reference/imagick/imagick/getimagewhitepoint.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - Imagick::getImageWhitePoint - Returns the chromaticity white point - - - - &reftitle.description; - - public arrayImagick::getImageWhitePoint - - - - Returns the chromaticity white point as an associative array with the keys "x" and "y". - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the chromaticity white point as an associative array with the keys - "x" and "y". - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagewidth.xml b/reference/imagick/imagick/getimagewidth.xml deleted file mode 100644 index 67cd2fa5ebe9..000000000000 --- a/reference/imagick/imagick/getimagewidth.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - Imagick::getImageWidth - Returns the image width - - - - &reftitle.description; - - public intImagick::getImageWidth - - - - Returns the image width. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the image width. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getinterlacescheme.xml b/reference/imagick/imagick/getinterlacescheme.xml deleted file mode 100644 index 7c3de2c80114..000000000000 --- a/reference/imagick/imagick/getinterlacescheme.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - Imagick::getInterlaceScheme - Gets the object interlace scheme - - - - &reftitle.description; - - public intImagick::getInterlaceScheme - - - - Gets the object interlace scheme. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Gets the wand interlace - scheme. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getiteratorindex.xml b/reference/imagick/imagick/getiteratorindex.xml deleted file mode 100644 index 914877fa7839..000000000000 --- a/reference/imagick/imagick/getiteratorindex.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - Imagick::getIteratorIndex - Gets the index of the current active image - - - - &reftitle.description; - - public intImagick::getIteratorIndex - - - - - Returns the index of the current active image within the Imagick object. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an integer containing the index of the image in the stack. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Using <function>Imagick::getIteratorIndex</function>: - - Create images, set and get the iterator index - - -newImage(100, 100, new ImagickPixel("red")); -$im->newImage(100, 100, new ImagickPixel("green")); -$im->newImage(100, 100, new ImagickPixel("blue")); - -$im->setIteratorIndex(1); -echo $im->getIteratorIndex(); -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::setIteratorIndex - Imagick::getImageIndex - Imagick::setImageIndex - - - - - - - diff --git a/reference/imagick/imagick/getnumberimages.xml b/reference/imagick/imagick/getnumberimages.xml deleted file mode 100644 index ffc804fd4688..000000000000 --- a/reference/imagick/imagick/getnumberimages.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - Imagick::getNumberImages - Returns the number of images in the object - - - - &reftitle.description; - - public intImagick::getNumberImages - - - - Returns the number of images associated with Imagick object. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the number of images associated with Imagick object. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getoption.xml b/reference/imagick/imagick/getoption.xml deleted file mode 100644 index 81364077f881..000000000000 --- a/reference/imagick/imagick/getoption.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - Imagick::getOption - Returns a value associated with the specified key - - - - &reftitle.description; - - public stringImagick::getOption - stringkey - - - Returns a value associated within the object for the specified key. - - - - - &reftitle.parameters; - - - - key - - - The name of the option - - - - - - - - - &reftitle.returnvalues; - - Returns a value associated with a wand and the specified key. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getpackagename.xml b/reference/imagick/imagick/getpackagename.xml deleted file mode 100644 index 97687f87e48d..000000000000 --- a/reference/imagick/imagick/getpackagename.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - Imagick::getPackageName - Returns the ImageMagick package name - - - - &reftitle.description; - - public static stringImagick::getPackageName - - - - Returns the ImageMagick package name. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the ImageMagick package name as a string. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getpage.xml b/reference/imagick/imagick/getpage.xml deleted file mode 100644 index 2f9eaddfc780..000000000000 --- a/reference/imagick/imagick/getpage.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - Imagick::getPage - Returns the page geometry - - - - &reftitle.description; - - public arrayImagick::getPage - - - - Returns the page geometry associated with the Imagick object in - an associative array with the keys "width", "height", "x", and "y". - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the page geometry associated with the Imagick object in - an associative array with the keys "width", "height", "x", and "y", - throwing ImagickException on error. - - - - - - diff --git a/reference/imagick/imagick/getpixeliterator.xml b/reference/imagick/imagick/getpixeliterator.xml deleted file mode 100644 index b6bd21183103..000000000000 --- a/reference/imagick/imagick/getpixeliterator.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - Imagick::getPixelIterator - Returns a MagickPixelIterator - - - - &reftitle.description; - - public ImagickPixelIteratorImagick::getPixelIterator - - - - Returns a MagickPixelIterator. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an ImagickPixelIterator on success. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::getPixelIterator</function> - - getPixelIterator(); - - foreach ($imageIterator as $row => $pixels) { /* Loop through pixel rows */ - foreach ($pixels as $column => $pixel) { /* Loop through the pixels in the row (columns) */ - /** @var $pixel \ImagickPixel */ - if ($column % 2) { - $pixel->setColor("rgba(0, 0, 0, 0)"); /* Paint every second pixel black*/ - } - } - $imageIterator->syncIterator(); /* Sync the iterator, this is important to do on each iteration */ - } - - header("Content-Type: image/jpg"); - echo $imagick; -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/getpixelregioniterator.xml b/reference/imagick/imagick/getpixelregioniterator.xml deleted file mode 100644 index 94be187db99d..000000000000 --- a/reference/imagick/imagick/getpixelregioniterator.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - Imagick::getPixelRegionIterator - Get an ImagickPixelIterator for an image section - - - - &reftitle.description; - - public ImagickPixelIteratorImagick::getPixelRegionIterator - intx - inty - intcolumns - introws - - - Get an ImagickPixelIterator for an image section. - - - - - &reftitle.parameters; - - - - x - - - The x-coordinate of the region. - - - - - y - - - The y-coordinate of the region. - - - - - columns - - - The width of the region. - - - - - rows - - - The height of the region. - - - - - - - - - &reftitle.returnvalues; - - Returns an ImagickPixelIterator for an image section. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - <methodname>Imagick::getPixelRegionIterator</methodname> example - - Iterate over the pixels in the top left of the image, changing them to be black. - - - getPixelRegionIterator(0, 0, 10, 10); - -foreach ($areaIterator as $rowIterator) { - foreach ($rowIterator as $pixel) { - // Paint every pixel black - $pixel->setColor("rgba(0, 0, 0, 0)"); - } - $areaIterator->syncIterator(); -} -$im->writeImage("./output.png"); -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/getpointsize.xml b/reference/imagick/imagick/getpointsize.xml deleted file mode 100644 index 796ab1c7345c..000000000000 --- a/reference/imagick/imagick/getpointsize.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - Imagick::getPointSize - Gets point size - - - - &reftitle.description; - - public floatImagick::getPointSize - - - - Returns the objects point size property. - &imagick.method.available.0x637; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a &float; containing the point size. - - - - - &reftitle.seealso; - - - Imagick::setPointSize - - - - - - - diff --git a/reference/imagick/imagick/getquantum.xml b/reference/imagick/imagick/getquantum.xml deleted file mode 100644 index d58f5a24f404..000000000000 --- a/reference/imagick/imagick/getquantum.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Imagick::getQuantum - Returns the ImageMagick quantum range - - - - &reftitle.description; - - public static intImagick::getQuantum - - - - Returns the ImageMagick quantum range. If HDRI was enabled then the type is a float, if not it is an int. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/imagick/imagick/getquantumdepth.xml b/reference/imagick/imagick/getquantumdepth.xml deleted file mode 100644 index 2df8045d068c..000000000000 --- a/reference/imagick/imagick/getquantumdepth.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - Imagick::getQuantumDepth - Gets the quantum depth - - - - &reftitle.description; - - public static arrayImagick::getQuantumDepth - - - - Returns the Imagick quantum depth. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an array with "quantumDepthLong" and "quantumDepthString" - members. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getquantumrange.xml b/reference/imagick/imagick/getquantumrange.xml deleted file mode 100644 index 0a16cffb1e2c..000000000000 --- a/reference/imagick/imagick/getquantumrange.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - Imagick::getQuantumRange - Returns the Imagick quantum range - - - - &reftitle.description; - - public static arrayImagick::getQuantumRange - - - - Returns the quantum range for the Imagick instance. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an associative array containing the quantum range as an - int ("quantumRangeLong") and as a - string ("quantumRangeString"). - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getregistry.xml b/reference/imagick/imagick/getregistry.xml deleted file mode 100644 index 2d8d0ea6f54b..000000000000 --- a/reference/imagick/imagick/getregistry.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Imagick::getRegistry - Get a StringRegistry entry - - - - &reftitle.description; - - public static stringImagick::getRegistry - stringkey - - - Get the StringRegistry entry for the named key or false if not set. - - - - - - &reftitle.parameters; - - - key - - - The entry to get. - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/imagick/imagick/getreleasedate.xml b/reference/imagick/imagick/getreleasedate.xml deleted file mode 100644 index d1faed186dfd..000000000000 --- a/reference/imagick/imagick/getreleasedate.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - Imagick::getReleaseDate - Returns the ImageMagick release date - - - - &reftitle.description; - - public static stringImagick::getReleaseDate - - - - Returns the ImageMagick release date as a string. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the ImageMagick release date as a string. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getresource.xml b/reference/imagick/imagick/getresource.xml deleted file mode 100644 index 7947ef72773c..000000000000 --- a/reference/imagick/imagick/getresource.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - Imagick::getResource - Returns the specified resource's memory usage - - - - &reftitle.description; - - public static intImagick::getResource - inttype - - - Returns the specified resource's memory usage in megabytes. - - - - - &reftitle.parameters; - - - - type - - - Refer to the list of resourcetype constants. - - - - - - - - - &reftitle.returnvalues; - - Returns the specified resource's memory usage in megabytes. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getresourcelimit.xml b/reference/imagick/imagick/getresourcelimit.xml deleted file mode 100644 index 3e0c69e8516d..000000000000 --- a/reference/imagick/imagick/getresourcelimit.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - Imagick::getResourceLimit - Returns the specified resource limit - - - - &reftitle.description; - - public static intImagick::getResourceLimit - inttype - - - Returns the specified resource limit. - - - - - &reftitle.parameters; - - - - type - - - One of the resourcetype constants. - - - - - - - - - &reftitle.returnvalues; - - Returns the specified resource limit. - The unit depends on the type of the resource being limited. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.seealso; - - Imagick::setResourceLimit - - - - - - diff --git a/reference/imagick/imagick/getsamplingfactors.xml b/reference/imagick/imagick/getsamplingfactors.xml deleted file mode 100644 index bc563e59830b..000000000000 --- a/reference/imagick/imagick/getsamplingfactors.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - Imagick::getSamplingFactors - Gets the horizontal and vertical sampling factor - - - - &reftitle.description; - - public arrayImagick::getSamplingFactors - - - - Gets the horizontal and vertical sampling factor. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an associative array with the horizontal and vertical sampling - factors of the image. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getsize.xml b/reference/imagick/imagick/getsize.xml deleted file mode 100644 index a8c026e42a74..000000000000 --- a/reference/imagick/imagick/getsize.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - Imagick::getSize - Returns the size associated with the Imagick object - - - - &reftitle.description; - - public arrayImagick::getSize - - - - Get the size in pixels associated with the Imagick object, previously set by Imagick::setSize. - - - - This method just returns the size that was set using Imagick::setSize. If you want to get the actual width / height of the image, use Imagick::getImageWidth and Imagick::getImageHeight. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the size associated with the Imagick object as an array with the - keys "columns" and "rows". - - - - - &reftitle.examples; - - - Getting the size of a raw RGB image set at 200x400, after scaling to 400x800 (compared to width / height) - -setSize(200, 400); -$img->readImage("image.rgb"); - -$img->scaleImage(400, 800); - -$size = $img->getSize(); -print_r($size); - -echo $img->getImageWidth()."x".$img->getImageHeight(); -?> -]]> - - &example.outputs; - - 200 - [rows] => 400 -) -400x800 -]]> - - - - - - - - diff --git a/reference/imagick/imagick/getsizeoffset.xml b/reference/imagick/imagick/getsizeoffset.xml deleted file mode 100644 index 030a228c068f..000000000000 --- a/reference/imagick/imagick/getsizeoffset.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - Imagick::getSizeOffset - Returns the size offset - - - - &reftitle.description; - - public intImagick::getSizeOffset - - - - - Returns the size offset associated with the Imagick object. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the size offset associated with the Imagick object. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getversion.xml b/reference/imagick/imagick/getversion.xml deleted file mode 100644 index ade82032bb33..000000000000 --- a/reference/imagick/imagick/getversion.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - Imagick::getVersion - Returns the ImageMagick API version - - - - &reftitle.description; - - public static arrayImagick::getVersion - - - - Returns the ImageMagick API version as a string and as a number. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the ImageMagick API version as a string and as a number. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/haldclutimage.xml b/reference/imagick/imagick/haldclutimage.xml deleted file mode 100644 index e4050b768e5e..000000000000 --- a/reference/imagick/imagick/haldclutimage.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - Imagick::haldClutImage - Replaces colors in the image - - - - &reftitle.description; - - public boolImagick::haldClutImage - Imagickclut - intchannelImagick::CHANNEL_DEFAULT - - - Replaces colors in the image using a Hald lookup table. Hald images can be created using - HALD color coder. - - - - - &reftitle.parameters; - - - - clut - - - Imagick object containing the Hald lookup image. - - - - - channel - - - &imagick.parameter.channel; - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - &reftitle.examples; - - - <function>Imagick::haldClutImage</function> - - sepiatoneImage(55); - $imagick->haldClutImage($imagickPalette); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/hasnextimage.xml b/reference/imagick/imagick/hasnextimage.xml deleted file mode 100644 index 0e3ecf144eba..000000000000 --- a/reference/imagick/imagick/hasnextimage.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - Imagick::hasNextImage - Checks if the object has more images - - - - &reftitle.description; - - public boolImagick::hasNextImage - - - - Returns &true; if the object has more images when traversing the list in the forward direction. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; if the object has more images when traversing the list in the - forward direction, returns &false; if there are none. - - - - - - diff --git a/reference/imagick/imagick/haspreviousimage.xml b/reference/imagick/imagick/haspreviousimage.xml deleted file mode 100644 index c32d4da37d8d..000000000000 --- a/reference/imagick/imagick/haspreviousimage.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - Imagick::hasPreviousImage - Checks if the object has a previous image - - - - &reftitle.description; - - public boolImagick::hasPreviousImage - - - - Returns &true; if the object has more images when traversing the list in the reverse direction - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; if the object has more images when traversing the list in the - reverse direction, returns &false; if there are none. - - - - - - diff --git a/reference/imagick/imagick/identifyformat.xml b/reference/imagick/imagick/identifyformat.xml deleted file mode 100644 index c7f4e67a729a..000000000000 --- a/reference/imagick/imagick/identifyformat.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - Imagick::identifyFormat - Formats a string with image details - - - - &reftitle.description; - - public stringfalseImagick::identifyFormat - stringembedText - - - Replaces any embedded formatting characters with the appropriate image property and returns the interpreted text. See http://www.imagemagick.org/script/escape.php for escape sequences. - - - - - - - &reftitle.parameters; - - - embedText - - - A string containing formatting sequences e.g. "Trim box: %@ number of unique colors: %k". - - - - - - - - &reftitle.returnvalues; - - Returns format&return.falseforfailure;. - - - - - - - - &reftitle.examples; - - - <function>Imagick::identifyFormat</function> - - "; - $imagick = new \Imagick(realpath("./images/artifact/mask.png")); - $output .= $imagick->identifyFormat("Trim box: %@ number of unique colors: %k"); - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/identifyimage.xml b/reference/imagick/imagick/identifyimage.xml deleted file mode 100644 index 6540a424c631..000000000000 --- a/reference/imagick/imagick/identifyimage.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - Imagick::identifyImage - Identifies an image and fetches attributes - - - - &reftitle.description; - - public arrayImagick::identifyImage - boolappendRawOutput&false; - - - Identifies an image and returns the attributes. Attributes include - the image width, height, size, and others. - - - - - &reftitle.parameters; - - - - appendRawOutput - - - If &true; then the raw output is appended to the array. - - - - - - - - - &reftitle.returnvalues; - - Identifies an image and returns the attributes. Attributes include - the image width, height, size, and others. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Example Result Format - - /some/path/image.jpg - [format] => JPEG (Joint Photographic Experts Group JFIF format) - [geometry] => Array - ( - [width] => 90 - [height] => 90 - ) - - [type] => TrueColor - [colorSpace] => RGB - [resolution] => Array - ( - [x] => 300 - [y] => 300 - ) - - [units] => PixelsPerInch - [fileSize] => 1.88672kb - [compression] => JPEG - [signature] => 9a6dc8f604f97d0d691c0286176ddf992e188f0bebba98494b2146ee2d7118da -) -]]> - - - - - - - - diff --git a/reference/imagick/imagick/implodeimage.xml b/reference/imagick/imagick/implodeimage.xml deleted file mode 100644 index 3806daac5398..000000000000 --- a/reference/imagick/imagick/implodeimage.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - Imagick::implodeImage - Creates a new image as a copy - - - - &reftitle.description; - - public boolImagick::implodeImage - floatradius - - - Creates a new image that is a copy of an existing one with the image pixels - "imploded" by the specified percentage. - - - - - &reftitle.parameters; - - - - radius - - - The radius of the implode - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::implodeImage</function> - - implodeImage(0.0001); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); - -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/importimagepixels.xml b/reference/imagick/imagick/importimagepixels.xml deleted file mode 100644 index bdd91882988e..000000000000 --- a/reference/imagick/imagick/importimagepixels.xml +++ /dev/null @@ -1,193 +0,0 @@ - - - - - - Imagick::importImagePixels - Imports image pixels - - - - &reftitle.description; - - public boolImagick::importImagePixels - intx - inty - intwidth - intheight - stringmap - intstorage - arraypixels - - - Imports pixels from an array into an image. The map is usually - 'RGB'. This method imposes the following constraints for the parameters: amount of pixels - in the array must match width x height x length of the map. - &imagick.method.available.0x645; - - - - - - &reftitle.parameters; - - - - x - - - The image x position - - - - - y - - - The image y position - - - - - width - - - The image width - - - - - height - - - The image height - - - - - map - - - Map of pixel ordering as a string. This can be for example RGB. - The value can be any combination or order of R = red, G = green, B = blue, A = alpha (0 is transparent), - O = opacity (0 is opaque), C = cyan, Y = yellow, M = magenta, K = black, I = intensity (for grayscale), P = pad. - - - - - storage - - - The pixel storage method. - Refer to this list of pixel constants. - - - - - pixels - - - The array of pixels - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - <methodname>Imagick::importImagePixels</methodname> example - -newImage($width, $height, 'gray'); - -/* Import the pixels into image. - width * height * strlen("RGB") must match count($pixels) */ -$im->importImagePixels(0, 0, $width, $height, "RGB", Imagick::PIXEL_CHAR, $pixels); - -/* output as jpeg image */ -$im->setImageFormat('jpg'); -header("Content-Type: image/jpg"); -echo $im; - -?> -]]> - - &example.outputs.similar; - - Output of example : Imagick::importImagePixels() - - - - - - - - - - - - - diff --git a/reference/imagick/imagick/inversefouriertransformimage.xml b/reference/imagick/imagick/inversefouriertransformimage.xml deleted file mode 100644 index 50100a7612e1..000000000000 --- a/reference/imagick/imagick/inversefouriertransformimage.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - Imagick::inverseFourierTransformImage - Implements the inverse discrete Fourier transform (DFT) - - - - &reftitle.description; - - public boolImagick::inverseFourierTransformImage - Imagickcomplement - boolmagnitude - - - Implements the inverse discrete Fourier transform (DFT) of the image either as a magnitude / phase or real / imaginary image pair. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - complement - - - The second image to combine with this one to form either the magnitude / phase or real / imaginary image pair. - - - - - magnitude - - - If true, combine as magnitude / phase pair otherwise a real / imaginary image pair. - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - diff --git a/reference/imagick/imagick/labelimage.xml b/reference/imagick/imagick/labelimage.xml deleted file mode 100644 index d4316ce0cae5..000000000000 --- a/reference/imagick/imagick/labelimage.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - Imagick::labelImage - Adds a label to an image - - - - &reftitle.description; - - public boolImagick::labelImage - stringlabel - - - Adds a label to an image. - - - - - &reftitle.parameters; - - - - label - - - The label to add - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/levelimage.xml b/reference/imagick/imagick/levelimage.xml deleted file mode 100644 index 8995e9cd6970..000000000000 --- a/reference/imagick/imagick/levelimage.xml +++ /dev/null @@ -1,138 +0,0 @@ - - - - - Imagick::levelImage - Adjusts the levels of an image - - - - &reftitle.description; - - public boolImagick::levelImage - floatblackPoint - floatgamma - floatwhitePoint - intchannelImagick::CHANNEL_DEFAULT - - - Adjusts the levels of an image by scaling the colors falling - between specified white and black points to the full - available quantum range. The parameters provided represent - the black, mid, and white points. The black point specifies - the darkest color in the image. Colors darker than the black - point are set to zero. Mid point specifies a gamma - correction to apply to the image. White point specifies the - lightest color in the image. Colors brighter than the white - point are set to the maximum quantum value. - - - - - &reftitle.parameters; - - - - blackPoint - - - The image black point - - - - - gamma - - - The gamma value - - - - - whitePoint - - - The image white point - - - - - channel - - - Provide any channel constant that is valid for your channel mode. To - apply to more than one channel, combine channeltype constants using - bitwise operators. Refer to this - list of channel constants. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::levelImage</function> - - newPseudoimage(500, 500, 'gradient:black-white'); - - $imagick->setFormat('png'); - $quantum = $imagick->getQuantum(); - $imagick->levelImage($blackPoint / 100 , $gamma, $quantum * $whitePoint / 100); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/linearstretchimage.xml b/reference/imagick/imagick/linearstretchimage.xml deleted file mode 100644 index aa1ae18fa3e3..000000000000 --- a/reference/imagick/imagick/linearstretchimage.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - Imagick::linearStretchImage - Stretches with saturation the image intensity - - - - &reftitle.description; - - public boolImagick::linearStretchImage - floatblackPoint - floatwhitePoint - - - - Stretches with saturation the image intensity. - - - - - &reftitle.parameters; - - - - blackPoint - - - The image black point - - - - - whitePoint - - - The image white point - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>Imagick::linearStretchImage</function> - - getImageWidth() * $imagick->getImageHeight(); - $imagick->linearStretchImage($blackThreshold * $pixels, $whiteThreshold * $pixels); - - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/liquidrescaleimage.xml b/reference/imagick/imagick/liquidrescaleimage.xml deleted file mode 100644 index 063107fb9822..000000000000 --- a/reference/imagick/imagick/liquidrescaleimage.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - Imagick::liquidRescaleImage - Animates an image or images - - - - &reftitle.description; - - public boolImagick::liquidRescaleImage - intwidth - intheight - floatdelta_x - floatrigidity - - - - This method scales the images using liquid rescaling method. This method - is an implementation of a technique called seam carving. In order for this - method to work as expected ImageMagick must be compiled with liblqr support. - &imagick.method.available.0x639; - - - - - &reftitle.parameters; - - - - width - - - The width of the target size - - - - - height - - - The height of the target size - - - - - delta_x - - - How much the seam can traverse on x-axis. - Passing 0 causes the seams to be straight. - - - - - rigidity - - - Introduces a bias for non-straight seams. This parameter is - typically 0. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.seealso; - - - Imagick::resizeImage - - - - - - - diff --git a/reference/imagick/imagick/listregistry.xml b/reference/imagick/imagick/listregistry.xml deleted file mode 100644 index 209f7148c211..000000000000 --- a/reference/imagick/imagick/listregistry.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Imagick::listRegistry - List all the registry settings - - - - &reftitle.description; - - public static arrayImagick::listRegistry - - - - List all the registry settings. Returns an array of all the key/value pairs in the registry - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - An array containing the key/values from the registry. - - - - - - - diff --git a/reference/imagick/imagick/magnifyimage.xml b/reference/imagick/imagick/magnifyimage.xml deleted file mode 100644 index 45dab1cf15ae..000000000000 --- a/reference/imagick/imagick/magnifyimage.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - Imagick::magnifyImage - Scales an image proportionally 2x - - - - &reftitle.description; - - public boolImagick::magnifyImage - - - - Is a convenience method that scales an image proportionally to twice its original size. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::magnifyImage</function> - - magnifyImage(); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/mapimage.xml b/reference/imagick/imagick/mapimage.xml deleted file mode 100644 index 192f642d5d6e..000000000000 --- a/reference/imagick/imagick/mapimage.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - Imagick::mapImage - Replaces the colors of an image with the closest color from a reference image - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::mapImage - Imagickmap - booldither - - - - - &reftitle.parameters; - - - - map - - - - - - - dither - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/mattefloodfillimage.xml b/reference/imagick/imagick/mattefloodfillimage.xml deleted file mode 100644 index 0be21adbb6ba..000000000000 --- a/reference/imagick/imagick/mattefloodfillimage.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - Imagick::matteFloodfillImage - Changes the transparency value of a color - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::matteFloodfillImage - floatalpha - floatfuzz - mixedbordercolor - intx - inty - - - Changes the transparency value of any pixel that matches - target and is an immediate neighbor. If the method - FillToBorderMethod is specified, the transparency value - is changed for any neighbor pixel that does not match - the bordercolor member of image. - - - - - &reftitle.parameters; - - - - alpha - - - The level of transparency: 1.0 is fully opaque and 0.0 is fully - transparent. - - - - - fuzz - - - The fuzz member of image defines how much tolerance is acceptable to - consider two colors as the same. - - - - - bordercolor - - - An ImagickPixel object or string representing the border color. - - - - - x - - - The starting x coordinate of the operation. - - - - - y - - - The starting y coordinate of the operation. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Now allows a string representing the color as the third parameter. - Previous versions allow only an ImagickPixel object. - - - - - - - - - - - diff --git a/reference/imagick/imagick/medianfilterimage.xml b/reference/imagick/imagick/medianfilterimage.xml deleted file mode 100644 index f0f8c364d9af..000000000000 --- a/reference/imagick/imagick/medianfilterimage.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - Imagick::medianFilterImage - Applies a digital filter - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::medianFilterImage - floatradius - - - Applies a digital filter that improves the quality of a - noisy image. Each pixel is replaced by the median in a - set of neighboring pixels as defined by radius. - - - - - &reftitle.parameters; - - - - radius - - - The radius of the pixel neighborhood. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::medianFilterImage</function> - - medianFilterImage($radius); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/mergeimagelayers.xml b/reference/imagick/imagick/mergeimagelayers.xml deleted file mode 100644 index c0619798e6c1..000000000000 --- a/reference/imagick/imagick/mergeimagelayers.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - Imagick::mergeImageLayers - Merges image layers - - - - &reftitle.description; - - public ImagickImagick::mergeImageLayers - intlayer_method - - - Merges image layers into one. This method is useful when working with image - formats that use multiple layers such as PSD. The merging is controlled using - the layer_method which defines how the layers are merged. - &imagick.method.available.0x637; - - - - - &reftitle.parameters; - - - - layer_method - - - One of the Imagick::LAYERMETHOD_* constants - - - - - - - - - &reftitle.returnvalues; - - Returns an Imagick object containing the merged image. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - <function>Imagick::mergeImageLayers</function> - - addImage($imagick2); - $imagick->setImageFormat('png'); - - $result = $imagick->mergeImageLayers($layerMethodType); - header("Content-Type: image/png"); - echo $result->getImageBlob(); -} - -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::flattenImages - - - - - - - diff --git a/reference/imagick/imagick/minifyimage.xml b/reference/imagick/imagick/minifyimage.xml deleted file mode 100644 index e55cc5d6dc51..000000000000 --- a/reference/imagick/imagick/minifyimage.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - Imagick::minifyImage - Scales an image proportionally to half its size - - - - &reftitle.description; - - public boolImagick::minifyImage - - - - Is a convenience method that scales an image proportionally to one-half its original size - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/modulateimage.xml b/reference/imagick/imagick/modulateimage.xml deleted file mode 100644 index f4d2ea09b7aa..000000000000 --- a/reference/imagick/imagick/modulateimage.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - Imagick::modulateImage - Control the brightness, saturation, and hue - - - - &reftitle.description; - - public boolImagick::modulateImage - floatbrightness - floatsaturation - floathue - - - Lets you control the brightness, saturation, and hue of an image. Hue - is the percentage of absolute rotation from the current position. For - example 50 results in a counter-clockwise rotation of 90 degrees, 150 - results in a clockwise rotation of 90 degrees, with 0 and 200 both - resulting in a rotation of 180 degrees. - - - - - &reftitle.parameters; - - - - brightness - - - - - - - saturation - - - - - - - hue - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>Imagick::modulateImage</function> - - modulateImage($brightness, $saturation, $hue); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/montageimage.xml b/reference/imagick/imagick/montageimage.xml deleted file mode 100644 index dc5053d1769d..000000000000 --- a/reference/imagick/imagick/montageimage.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - Imagick::montageImage - Creates a composite image - - - - &reftitle.description; - - public ImagickImagick::montageImage - ImagickDrawdraw - stringtile_geometry - stringthumbnail_geometry - intmode - stringframe - - - Creates a composite image by combining several separate images. - The images are tiled on the composite image with the name of the - image optionally appearing just below the individual tile. - - - - - &reftitle.parameters; - - - - draw - - - The font name, size, and color are obtained from this object. - - - - - tile_geometry - - - The number of tiles per row and page (e.g. 6x4+0+0). - - - - - thumbnail_geometry - - - Preferred image size and border size of each thumbnail - (e.g. 120x120+4+3). - - - - - mode - - - Thumbnail framing mode, see Montage Mode constants. - - - - - frame - - - Surround the image with an ornamental border (e.g. 15x15+3+3). The - frame color is that of the thumbnail's matte color. - - - - - - - - - &reftitle.returnvalues; - - Creates a composite image and returns it as a new Imagick object. - - - - - - diff --git a/reference/imagick/imagick/morphimages.xml b/reference/imagick/imagick/morphimages.xml deleted file mode 100644 index 42e392c42745..000000000000 --- a/reference/imagick/imagick/morphimages.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - Imagick::morphImages - Method morphs a set of images - - - - &reftitle.description; - - public ImagickImagick::morphImages - intnumber_frames - - - Method morphs a set of images. Both the image pixels and size - are linearly interpolated to give the appearance of a - meta-morphosis from one image to the next. - - - - - &reftitle.parameters; - - - - number_frames - - - The number of in-between images to generate. - - - - - - - - - &reftitle.returnvalues; - - This method returns a new Imagick object on success. - &imagick.imagickexception.throw; - - - - - - diff --git a/reference/imagick/imagick/morphology.xml b/reference/imagick/imagick/morphology.xml deleted file mode 100644 index a198574c1e6e..000000000000 --- a/reference/imagick/imagick/morphology.xml +++ /dev/null @@ -1,575 +0,0 @@ - - - - - - Imagick::morphology - Applies a user supplied kernel to the image according to the given morphology method. - - - - &reftitle.description; - - public boolImagick::morphology - intmorphologyMethod - intiterations - ImagickKernelImagickKernel - intchannelImagick::CHANNEL_DEFAULT - - - Applies a user supplied kernel to the image according to the given morphology method. - - - - - - - - &reftitle.parameters; - - - morphologyMethod - - - Which morphology method to use one of the \Imagick::MORPHOLOGY_* constants. - - - - - iterations - - - The number of iteration to apply the morphology function. A value of -1 means loop until no change found. How this is applied may depend on the morphology method. Typically this is a value of 1. - - - - - ImagickKernel - - - - - - - - channel - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - - &reftitle.examples; - - - Convolve <function>Imagick::morphology</function> - - getCharacter(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_GAUSSIAN, "5,1"); - $imagick->morphology(\Imagick::MORPHOLOGY_CONVOLVE, 2, $kernel); - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); - -?> -]]> - - - - - Correlate <function>Imagick::morphology</function> - - getCharacterOutline(); - $kernel = \ImagickKernel::fromMatrix(self::$correlateMatrix, [2, 2]); - $imagick->morphology(\Imagick::MORPHOLOGY_CORRELATE, 1, $kernel); - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); - -?> -]]> - - - - - Erode <function>Imagick::morphology</function> - - getCharacterOutline(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_OCTAGON, "3"); - $canvas->morphology(\Imagick::MORPHOLOGY_ERODE, 2, $kernel); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); - -?> -]]> - - - - - Erode Intensity <function>Imagick::morphology</function> - - getCharacter(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_OCTAGON, "1"); - $canvas->morphology(\Imagick::MORPHOLOGY_ERODE_INTENSITY, 2, $kernel); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); - -?> -]]> - - - - - Dilate <function>Imagick::morphology</function> - - getCharacterOutline(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_OCTAGON, "3"); - $canvas->morphology(\Imagick::MORPHOLOGY_DILATE, 4, $kernel); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); - -?> -]]> - - - - - Dilate intensity <function>Imagick::morphology</function> - - getCharacter(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_OCTAGON, "1"); - $canvas->morphology(\Imagick::MORPHOLOGY_DILATE_INTENSITY, 4, $kernel); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); - -?> -]]> - - - - - Distance with Chebyshev kernel <function>Imagick::morphology</function> - - getCharacterOutline(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_CHEBYSHEV, "3"); - $canvas->morphology(\Imagick::MORPHOLOGY_DISTANCE, 3, $kernel); - $canvas->autoLevelImage(); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); - -?> -]]> - - - - - Distance with Manhattan kernel <function>Imagick::morphology</function> - - getCharacterOutline(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_MANHATTAN, "5"); - $canvas->morphology(\Imagick::MORPHOLOGY_DISTANCE, 3, $kernel); - $canvas->autoLevelImage(); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); - -?> -]]> - - - - - Distance with ocatagonal kernel <function>Imagick::morphology</function> - - getCharacterOutline(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_OCTAGONAL, "5"); - $canvas->morphology(\Imagick::MORPHOLOGY_DISTANCE, 3, $kernel); - $canvas->autoLevelImage(); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); - -?> -]]> - - - - - Distance with Euclidean kernel <function>Imagick::morphology</function> - - getCharacterOutline(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_EUCLIDEAN, "4"); - $canvas->morphology(\Imagick::MORPHOLOGY_DISTANCE, 3, $kernel); - $canvas->autoLevelImage(); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); - -?> -]]> - - - - - Edge <function>Imagick::morphology</function> - - getCharacterOutline(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_OCTAGON, "3"); - $canvas->morphology(\Imagick::MORPHOLOGY_EDGE, 1, $kernel); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); - -?> -]]> - - - - - Open <function>Imagick::morphology</function> - - getCharacterOutline(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_DISK, "6"); - $canvas->morphology(\Imagick::MORPHOLOGY_OPEN, 1, $kernel); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); - -?> -]]> - - - - - Open intensity <function>Imagick::morphology</function> - - getCharacter(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_DISK, "6"); - $canvas->morphology(\Imagick::MORPHOLOGY_OPEN_INTENSITY, 1, $kernel); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); - -?> -]]> - - - - - Close <function>Imagick::morphology</function> - - getCharacterOutline(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_DISK, "6"); - $canvas->morphology(\Imagick::MORPHOLOGY_CLOSE, 1, $kernel); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); - -?> -]]> - - - - - Close Intensity <function>Imagick::morphology</function> - - getCharacter(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_DISK, "6"); - $canvas->morphology(\Imagick::MORPHOLOGY_CLOSE_INTENSITY, 1, $kernel); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); - -?> -]]> - - - - - Smooth <function>Imagick::morphology</function> - - getCharacterOutline(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_OCTAGON, "3"); - $canvas->morphology(\Imagick::MORPHOLOGY_SMOOTH, 1, $kernel); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); - -?> -]]> - - - - - Edge in <function>Imagick::morphology</function> - - getCharacterOutline(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_OCTAGON, "3"); - $canvas->morphology(\Imagick::MORPHOLOGY_EDGE_IN, 1, $kernel); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); - -?> -]]> - - - - - Edge out <function>Imagick::morphology</function> - - getCharacterOutline(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_OCTAGON, "3"); - $canvas->morphology(\Imagick::MORPHOLOGY_EDGE_OUT, 1, $kernel); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); - -?> -]]> - - - - - The 'TopHat' method, or more specifically 'White Top Hat', returns the pixels that were removed by a Opening of the shape, that is the pixels that were removed to round off the points, and the connecting bridged between shapes. <function>Imagick::morphology</function> - - getCharacterOutline(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_DISK, "5"); - $canvas->morphology(\Imagick::MORPHOLOGY_TOP_HAT, 1, $kernel); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); - -?> -]]> - - - - - The 'BottomHat' method, also known as 'Black TopHat' is the pixels that a Closing of the shape adds to the image. That is the pixels that were used to fill in the 'holes', 'gaps', and 'bridges'. <function>Imagick::morphology</function> - - getCharacterOutline(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_DISK, "5"); - $canvas->morphology(\Imagick::MORPHOLOGY_BOTTOM_HAT, 1, $kernel); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); - -?> -]]> - - - - - Hit and Miss <function>Imagick::morphology</function> - - getCharacterOutline(); - //This finds all the pixels with 3 pixels of the right edge - $matrix = [[1, false, false, 0]]; - $kernel = \ImagickKernel::fromMatrix( - $matrix, - [0, 0] - ); - $canvas->morphology(\Imagick::MORPHOLOGY_HIT_AND_MISS, 1, $kernel); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); - -?> -]]> - - - - - Thinning <function>Imagick::morphology</function> - - getCharacterOutline(); - $leftEdgeKernel = \ImagickKernel::fromMatrix([[0, 1]], [1, 0]); - $rightEdgeKernel = \ImagickKernel::fromMatrix([[1, 0]], [0, 0]); - $leftEdgeKernel->addKernel($rightEdgeKernel); - - $canvas->morphology(\Imagick::MORPHOLOGY_THINNING, 3, $leftEdgeKernel); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); - -?> -]]> - - - - - Thicken <function>Imagick::morphology</function> - - getCharacterOutline(); - $leftEdgeKernel = \ImagickKernel::fromMatrix([[0, 1]], [1, 0]); - $rightEdgeKernel = \ImagickKernel::fromMatrix([[1, 0]], [0, 0]); - $leftEdgeKernel->addKernel($rightEdgeKernel); - - $canvas->morphology(\Imagick::MORPHOLOGY_THICKEN, 3, $leftEdgeKernel); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); - -?> -]]> - - - - - Thick to generate a convex hull <function>Imagick::morphology</function> - - getCharacterOutline(); - $diamondKernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_DIAMOND, "1"); - $convexKernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_CONVEX_HULL, ""); - - // The thicken morphology doesn't handle small gaps. We close them - // with the close morphology. - $canvas->morphology(\Imagick::MORPHOLOGY_CLOSE, 1, $diamondKernel); - $canvas->morphology(\Imagick::MORPHOLOGY_THICKEN, -1, $convexKernel); - $canvas->morphology(\Imagick::MORPHOLOGY_CLOSE, 1, $diamondKernel); - - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); - -?> -]]> - - - - - Iterative morphology <function>Imagick::morphology</function> - - getCharacterOutline(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_DISK, "2"); - $canvas->morphology(\Imagick::MORPHOLOGY_ITERATIVE, 3, $kernel); - $canvas->autoLevelImage(); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); - -?> -]]> - - - - - Helper function to get an image silhouette <function>Imagick::morphology</function> - -newPseudoImage( - $imagick->getImageWidth(), - $imagick->getImageHeight(), - "canvas:white" - ); - $canvas = new \Imagick(); - $canvas->newPseudoImage( - $imagick->getImageWidth(), - $imagick->getImageHeight(), - "canvas:black" - ); - - $character->compositeimage( - $imagick, - \Imagick::COMPOSITE_COPYOPACITY, - 0, 0 - ); - $canvas->compositeimage( - $character, - \Imagick::COMPOSITE_ATOP, - 0, 0 - ); - $canvas->setFormat('png'); - - return $canvas; -} -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/mosaicimages.xml b/reference/imagick/imagick/mosaicimages.xml deleted file mode 100644 index 07fdf02cf4e6..000000000000 --- a/reference/imagick/imagick/mosaicimages.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - Imagick::mosaicImages - Forms a mosaic from images - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public ImagickImagick::mosaicImages - - - - Inlays an image sequence to form a single coherent picture. It - returns a wand with each image in the sequence composited at - the location defined by the page offset of the image. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/motionblurimage.xml b/reference/imagick/imagick/motionblurimage.xml deleted file mode 100644 index b8fc82b69fb0..000000000000 --- a/reference/imagick/imagick/motionblurimage.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - Imagick::motionBlurImage - Simulates motion blur - - - - &reftitle.description; - - public boolImagick::motionBlurImage - floatradius - floatsigma - floatangle - intchannelImagick::CHANNEL_DEFAULT - - - Simulates motion blur. We convolve the image with a Gaussian - operator of the given radius and standard deviation (sigma). - For reasonable results, radius should be larger than sigma. - Use a radius of 0 and MotionBlurImage() selects a suitable - radius for you. Angle gives the angle of the blurring motion. - - - - - &reftitle.parameters; - - - - radius - - - The radius of the Gaussian, in pixels, not counting the center pixel. - - - - - sigma - - - The standard deviation of the Gaussian, in pixels. - - - - - angle - - - Apply the effect along this angle. - - - - - channel - - - Provide any channel constant that is valid for your channel mode. To - apply to more than one channel, combine channeltype constants using - bitwise operators. Refer to this - list of channel constants. - The channel argument affects only if Imagick is compiled against ImageMagick version - 6.4.4 or greater. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>Imagick::motionBlurImage</function> - - motionBlurImage($radius, $sigma, $angle, $channel); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/negateimage.xml b/reference/imagick/imagick/negateimage.xml deleted file mode 100644 index 64daefb084c7..000000000000 --- a/reference/imagick/imagick/negateimage.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - Imagick::negateImage - Negates the colors in the reference image - - - - &reftitle.description; - - public boolImagick::negateImage - boolgray - intchannelImagick::CHANNEL_DEFAULT - - - Negates the colors in the reference image. The Grayscale - option means that only grayscale values within the image - are negated. - - - - - &reftitle.parameters; - - - - gray - - - Whether to only negate grayscale pixels within the image. - - - - - channel - - - Provide any channel constant that is valid for your channel mode. To - apply to more than one channel, combine channeltype constants using - bitwise operators. Refer to this - list of channel constants. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::negateImage</function> - - negateImage($grayOnly, $channel); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/newimage.xml b/reference/imagick/imagick/newimage.xml deleted file mode 100644 index 3eca99a87325..000000000000 --- a/reference/imagick/imagick/newimage.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - Imagick::newImage - Creates a new image - - - - &reftitle.description; - - public boolImagick::newImage - intcols - introws - mixedbackground - stringformat - - - Creates a new image and associates ImagickPixel value as background color - - - - - &reftitle.parameters; - - - - cols - - - Columns in the new image - - - - - rows - - - Rows in the new image - - - - - background - - - The background color used for this image - - - - - format - - - Image format. This parameter was added in Imagick version 2.0.1. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Now allows a string representing the color as the third parameter. - Previous versions allow only an ImagickPixel object. - - - - - - - - - - &reftitle.examples; - - - Using <function>Imagick::newImage</function>: - - Create a new image and display it. - - -newImage(100, 100, new ImagickPixel('red')); -$image->setImageFormat('png'); - -header('Content-type: image/png'); -echo $image; - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/newpseudoimage.xml b/reference/imagick/imagick/newpseudoimage.xml deleted file mode 100644 index 1b83353632c8..000000000000 --- a/reference/imagick/imagick/newpseudoimage.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - Imagick::newPseudoImage - Creates a new image - - - - &reftitle.description; - - public boolImagick::newPseudoImage - intcolumns - introws - stringpseudoString - - - Creates a new image using ImageMagick pseudo-formats. - - - - - &reftitle.parameters; - - - - columns - - - columns in the new image - - - - - rows - - - rows in the new image - - - - - pseudoString - - - string containing pseudo image definition. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::newPseudoImage</function> - - newPseudoImage(300, 300, $canvasType); - $imagick->setImageFormat("png"); - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -//newPseudoImage('gradient:red-rgba(64, 255, 255, 0.5)'); -//newPseudoImage("radial-gradient:red-blue"); -newPseudoImage("plasma:fractal"); - -?> -]]> - - - - - - - - - diff --git a/reference/imagick/imagick/nextimage.xml b/reference/imagick/imagick/nextimage.xml deleted file mode 100644 index b46311aa8a36..000000000000 --- a/reference/imagick/imagick/nextimage.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - Imagick::nextImage - Moves to the next image - - - - &reftitle.description; - - public boolImagick::nextImage - - - - Associates the next image in the image list with an Imagick object. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/normalizeimage.xml b/reference/imagick/imagick/normalizeimage.xml deleted file mode 100644 index f79e5bc8054e..000000000000 --- a/reference/imagick/imagick/normalizeimage.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - Imagick::normalizeImage - Enhances the contrast of a color image - - - - &reftitle.description; - - public boolImagick::normalizeImage - intchannelImagick::CHANNEL_DEFAULT - - - Enhances the contrast of a color image by adjusting the pixels - color to span the entire range of colors available. - - - - - &reftitle.parameters; - - - - channel - - - Provide any channel constant that is valid for your channel mode. To - apply to more than one channel, combine channeltype constants using - bitwise operators. Refer to this - list of channel constants. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>Imagick::normalizeImage</function> - - cropimage($original->getImageWidth() / 2, $original->getImageHeight(), 0, 0); - $imagick->normalizeImage($channel); - $imagick->compositeimage($original, \Imagick::COMPOSITE_ATOP, 0, 0); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/oilpaintimage.xml b/reference/imagick/imagick/oilpaintimage.xml deleted file mode 100644 index 00eeada71b11..000000000000 --- a/reference/imagick/imagick/oilpaintimage.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - Imagick::oilPaintImage - Simulates an oil painting - - - - &reftitle.description; - - public boolImagick::oilPaintImage - floatradius - - - Applies a special effect filter that simulates an oil painting. - Each pixel is replaced by the most frequent color occurring in - a circular region defined by radius. - - - - - &reftitle.parameters; - - - - radius - - - The radius of the circular neighborhood. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>Imagick::oilPaintImage</function> - - oilPaintImage($radius); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/opaquepaintimage.xml b/reference/imagick/imagick/opaquepaintimage.xml deleted file mode 100644 index 1edffcfc2549..000000000000 --- a/reference/imagick/imagick/opaquepaintimage.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - Imagick::opaquePaintImage - Changes the color value of any pixel that matches target - - - - &reftitle.description; - - public boolImagick::opaquePaintImage - mixedtarget - mixedfill - floatfuzz - boolinvert - intchannelImagick::CHANNEL_DEFAULT - - - - Changes any pixel that matches color with the color defined by fill. - &imagick.method.available.0x638; - - - - - &reftitle.parameters; - - - - target - - - ImagickPixel object or a string containing the color to change - - - - - fill - - - The replacement color - - - - - fuzz - - - &imagick.parameter.fuzz; - - - - - invert - - - If &true; paints any pixel that does not match the target color. - - - - - channel - - - &imagick.parameter.channel; - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/optimizeimagelayers.xml b/reference/imagick/imagick/optimizeimagelayers.xml deleted file mode 100644 index 860ee74d06b7..000000000000 --- a/reference/imagick/imagick/optimizeimagelayers.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - Imagick::optimizeImageLayers - Removes repeated portions of images to optimize - - - - &reftitle.description; - - public boolImagick::optimizeImageLayers - - - - - Compares each image the GIF disposed forms of the previous image - in the sequence. From this it attempts to select the smallest - cropped image to replace each frame, while preserving the results - of the animation. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Using <function>Imagick::optimizeImageLayers</function> - - Reading, optimizing and writing a GIF image - - -optimizeImageLayers(); - -/* write the image back */ -$im->writeImages("test_optimized.gif", true); -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::compareImageLayers - Imagick::writeImages - Imagick::writeImage - - - - - - - diff --git a/reference/imagick/imagick/orderedposterizeimage.xml b/reference/imagick/imagick/orderedposterizeimage.xml deleted file mode 100644 index 1b68f546b626..000000000000 --- a/reference/imagick/imagick/orderedposterizeimage.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - Imagick::orderedPosterizeImage - Performs an ordered dither - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::orderedPosterizeImage - stringthreshold_map - intchannelImagick::CHANNEL_DEFAULT - - - - Performs an ordered dither based on a number of pre-defined dithering threshold maps, - but over multiple intensity levels, which can be different for different channels, - according to the input arguments. &imagick.method.available.0x631; - - - - - &reftitle.parameters; - - - - threshold_map - - - A string containing the name of the threshold dither map to use - - - - - channel - - - Provide any channel constant that is valid for your channel mode. To - apply to more than one channel, combine channeltype constants using - bitwise operators. Refer to this - list of channel constants. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::orderedPosterizeImage</function> - - orderedPosterizeImage($orderedPosterizeType); - $imagick->setImageFormat('png'); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -//orderedPosterizeImage($imagePath, 'o4x4,3,3'); -//orderedPosterizeImage($imagePath, 'o8x8,6,6'); -orderedPosterizeImage($imagePath, 'h8x8a'); - - - - - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/paintfloodfillimage.xml b/reference/imagick/imagick/paintfloodfillimage.xml deleted file mode 100644 index b0a5c503bdd4..000000000000 --- a/reference/imagick/imagick/paintfloodfillimage.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - Imagick::paintFloodfillImage - Changes the color value of any pixel that matches target - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::paintFloodfillImage - mixedfill - floatfuzz - mixedbordercolor - intx - inty - intchannelImagick::CHANNEL_DEFAULT - - - - Changes the color value of any pixel that matches target and is an - immediate neighbor. As of ImageMagick 6.3.8 this method has been deprecated - and Imagick::floodfillPaintImage should be used instead. - - - - - &reftitle.parameters; - - - - fill - - - ImagickPixel object or a string containing the fill color - - - - - fuzz - - - The amount of fuzz. For example, set fuzz to 10 and the color red at - intensities of 100 and 102 respectively are now interpreted as the - same color for the purposes of the floodfill. - - - - - bordercolor - - - ImagickPixel object or a string containing the border color - - - - - x - - - X start position of the floodfill - - - - - y - - - Y start position of the floodfill - - - - - channel - - - &imagick.parameter.channel; - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/paintopaqueimage.xml b/reference/imagick/imagick/paintopaqueimage.xml deleted file mode 100644 index 69ab54588655..000000000000 --- a/reference/imagick/imagick/paintopaqueimage.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - Imagick::paintOpaqueImage - Change any pixel that matches color - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::paintOpaqueImage - mixedtarget - mixedfill - floatfuzz - intchannelImagick::CHANNEL_DEFAULT - - - Changes any pixel that matches color with the color defined by fill. - - - - - &reftitle.parameters; - - - - target - - - Change this target color to the fill color within the image. An - ImagickPixel object or a string representing the target color. - - - - - fill - - - An ImagickPixel object or a string representing the fill color. - - - - - fuzz - - - The fuzz member of image defines how much tolerance is acceptable to - consider two colors as the same. - - - - - channel - - - Provide any channel constant that is valid for your channel mode. To - apply to more than one channel, combine channeltype constants using - bitwise operators. Refer to this - list of channel constants. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Now allows a string representing the color as first and second parameter. - Previous versions allow only an ImagickPixel object. - - - - - - - - - - - diff --git a/reference/imagick/imagick/painttransparentimage.xml b/reference/imagick/imagick/painttransparentimage.xml deleted file mode 100644 index a3d4c9a2a4d0..000000000000 --- a/reference/imagick/imagick/painttransparentimage.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - Imagick::paintTransparentImage - Changes any pixel that matches color with the color defined by fill - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::paintTransparentImage - mixedtarget - floatalpha - floatfuzz - - - Changes any pixel that matches color with the color defined by fill. - - - - - &reftitle.parameters; - - - - target - - - Change this target color to specified opacity value within the image. - - - - - alpha - - - The level of transparency: 1.0 is fully opaque and 0.0 is fully - transparent. - - - - - fuzz - - - The fuzz member of image defines how much tolerance is acceptable to - consider two colors as the same. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Now allows a string representing the color as the first parameter. - Previous versions allow only an ImagickPixel object. - - - - - - - - - - - diff --git a/reference/imagick/imagick/pingimage.xml b/reference/imagick/imagick/pingimage.xml deleted file mode 100644 index 317c11c38a58..000000000000 --- a/reference/imagick/imagick/pingimage.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - Imagick::pingImage - Fetch basic attributes about the image - - - - &reftitle.description; - - public boolImagick::pingImage - stringfilename - - - This method can be used to query image width, height, size, and - format without reading the whole image in to memory. - - - - - &reftitle.parameters; - - - - filename - - - The filename to read the information from. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/pingimageblob.xml b/reference/imagick/imagick/pingimageblob.xml deleted file mode 100644 index 3c8275140463..000000000000 --- a/reference/imagick/imagick/pingimageblob.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - Imagick::pingImageBlob - Quickly fetch attributes - - - - &reftitle.description; - - public boolImagick::pingImageBlob - stringimage - - - - This method can be used to query image width, height, size, and - format without reading the whole image to memory. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - - - - image - - - A string containing the image. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Using <function>Imagick::pingImageBlob</function> - - Pinging an image from a string - - -pingImageBlob($image); - -/* output image width and height */ -echo $im->getImageWidth() . 'x' . $im->getImageHeight(); -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::pingImage - Imagick::pingImageFile - Imagick::readImage - Imagick::readImageBlob - Imagick::readImageFile - - - - - - - diff --git a/reference/imagick/imagick/pingimagefile.xml b/reference/imagick/imagick/pingimagefile.xml deleted file mode 100644 index ab6681b27d30..000000000000 --- a/reference/imagick/imagick/pingimagefile.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - Imagick::pingImageFile - Get basic image attributes in a lightweight manner - - - - &reftitle.description; - - public boolImagick::pingImageFile - resourcefilehandle - stringfileName - - - - This method can be used to query image width, height, size, and - format without reading the whole image to memory. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - - - - filehandle - - - An open filehandle to the image. - - - - - fileName - - - Optional filename for this image. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Using <function>Imagick::pingImageFile</function> - - Opening a remote location - - -pingImageFile($fp); -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::pingImage - Imagick::pingImageBlob - Imagick::readImage - Imagick::readImageBlob - Imagick::readImageFile - - - - - - - diff --git a/reference/imagick/imagick/polaroidimage.xml b/reference/imagick/imagick/polaroidimage.xml deleted file mode 100644 index ed7a2298a5ee..000000000000 --- a/reference/imagick/imagick/polaroidimage.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - Imagick::polaroidImage - Simulates a Polaroid picture - - - - &reftitle.description; - - public boolImagick::polaroidImage - ImagickDrawproperties - floatangle - - - - Simulates a Polaroid picture. &imagick.method.available.0x632; - - - - - &reftitle.parameters; - - - - properties - - - The polaroid properties - - - - - angle - - - The polaroid angle - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - A <function>Imagick::polaroidImage</function> example - - An example of using Imagick::polaroidImage() - - -polaroidImage(new ImagickDraw(), 25); - -/* output the image */ -header('Content-type: image/png'); -echo $image; - -?> -]]> - - - - - - - - - diff --git a/reference/imagick/imagick/posterizeimage.xml b/reference/imagick/imagick/posterizeimage.xml deleted file mode 100644 index 1486275bfb66..000000000000 --- a/reference/imagick/imagick/posterizeimage.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - Imagick::posterizeImage - Reduces the image to a limited number of color level - - - - &reftitle.description; - - public boolImagick::posterizeImage - intlevels - booldither - - - Reduces the image to a limited number of color level. - - - - - &reftitle.parameters; - - - - levels - - - - - - - dither - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>Imagick::posterizeImage</function> - - posterizeImage($numberLevels, $posterizeType); - $imagick->setImageFormat('png'); - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -posterizeImage($imagePath, \Imagick::DITHERMETHOD_RIEMERSMA, 8); - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/previewimages.xml b/reference/imagick/imagick/previewimages.xml deleted file mode 100644 index e04425a2f3af..000000000000 --- a/reference/imagick/imagick/previewimages.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - Imagick::previewImages - Quickly pin-point appropriate parameters for image processing - - - - &reftitle.description; - - public boolImagick::previewImages - intpreview - - - Tiles 9 thumbnails of the specified image with an image processing - operation applied at varying strengths. This is helpful to quickly - pin-point an appropriate parameter for an image processing operation. - - - - - &reftitle.parameters; - - - - preview - - - Preview type. See Preview type constants - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/previousimage.xml b/reference/imagick/imagick/previousimage.xml deleted file mode 100644 index 88a79f871c38..000000000000 --- a/reference/imagick/imagick/previousimage.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - Imagick::previousImage - Move to the previous image in the object - - - - &reftitle.description; - - public boolImagick::previousImage - - - - Associates the previous image in an image list with the Imagick object. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/profileimage.xml b/reference/imagick/imagick/profileimage.xml deleted file mode 100644 index 92d5ede99145..000000000000 --- a/reference/imagick/imagick/profileimage.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - Imagick::profileImage - Adds or removes a profile from an image - - - - &reftitle.description; - - public boolImagick::profileImage - stringname - stringprofile - - - Adds or removes a ICC, IPTC, - or generic profile from an image. - If the profile is &null;, - it is removed from the image rather than added. - - - To remove every single profile from the image use '*' - as the name and &null; for the - profile. - - - - - &reftitle.parameters; - - - - name - - - The profile name. - - - - - profile - - - The profile data. - If &null;, the specified profile will be deleted. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - diff --git a/reference/imagick/imagick/quantizeimage.xml b/reference/imagick/imagick/quantizeimage.xml deleted file mode 100644 index 82cf4a5cc95a..000000000000 --- a/reference/imagick/imagick/quantizeimage.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - Imagick::quantizeImage - Analyzes the colors within a reference image - - - - &reftitle.description; - - public boolImagick::quantizeImage - intnumberColors - intcolorspace - inttreedepth - booldither - boolmeasureError - - - - - &reftitle.parameters; - - - - numberColors - - - - - - - colorspace - - - - - - - treedepth - - - - - - - dither - - - - - - - measureError - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::quantizeImage</function> - - quantizeImage($numberColors, $colorSpace, $treeDepth, $dither, false); - $imagick->setImageFormat('png'); - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/quantizeimages.xml b/reference/imagick/imagick/quantizeimages.xml deleted file mode 100644 index a328c2f167c8..000000000000 --- a/reference/imagick/imagick/quantizeimages.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - Imagick::quantizeImages - Analyzes the colors within a sequence of images - - - - &reftitle.description; - - public boolImagick::quantizeImages - intnumberColors - intcolorspace - inttreedepth - booldither - boolmeasureError - - - - - &reftitle.parameters; - - - - numberColors - - - - - - - colorspace - - - - - - - treedepth - - - - - - - dither - - - - - - - measureError - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/queryfontmetrics.xml b/reference/imagick/imagick/queryfontmetrics.xml deleted file mode 100644 index 99a8a31f98dc..000000000000 --- a/reference/imagick/imagick/queryfontmetrics.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - Imagick::queryFontMetrics - Returns an array representing the font metrics - - - - &reftitle.description; - - public arrayImagick::queryFontMetrics - ImagickDrawproperties - stringtext - boolmultiline - - - Returns a multi-dimensional array representing the font metrics. - - - - - &reftitle.parameters; - - - - properties - - - ImagickDraw object containing font properties - - - - - text - - - The text - - - - - multiline - - - Multiline parameter. If left empty it is autodetected - - - - - - - - - - &reftitle.returnvalues; - - Returns a multi-dimensional array representing the font metrics. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Using <function>Imagick::queryFontMetrics</function>: - - Query the metrics for the text and dump the results on the screen. - - -setFont('/path/to/font.ttf'); - -/* Dump the font metrics, autodetect multiline */ -var_dump($im->queryFontMetrics($draw, "Hello World!")); -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/queryfonts.xml b/reference/imagick/imagick/queryfonts.xml deleted file mode 100644 index f851a0ae2686..000000000000 --- a/reference/imagick/imagick/queryfonts.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - Imagick::queryFonts - Returns the configured fonts - - - - &reftitle.description; - - public static arrayImagick::queryFonts - stringpattern"*" - - - Returns the configured fonts. - - - - - &reftitle.parameters; - - - - pattern - - - The query pattern - - - - - - - - - &reftitle.returnvalues; - - Returns an array containing the configured fonts. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::queryFonts</function> - - "; - - $fontList = \Imagick::queryFonts("Helvetica*"); - - foreach ($fontList as $fontName) { - $output .= '
  • '. $fontName."
  • "; - } - - return $output; - -?> -]]> -
    -
    -
    -
    - -
    - - diff --git a/reference/imagick/imagick/queryformats.xml b/reference/imagick/imagick/queryformats.xml deleted file mode 100644 index dc9a035f34ac..000000000000 --- a/reference/imagick/imagick/queryformats.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - Imagick::queryFormats - Returns formats supported by Imagick - - - - &reftitle.description; - - public static arrayImagick::queryFormats - stringpattern"*" - - - Returns formats supported by Imagick. - - - - - &reftitle.parameters; - - - - pattern - - - - - - - - - - - &reftitle.returnvalues; - - Returns an array containing the formats supported by Imagick. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::queryFormats</function> - - "; - - for ($i=0; $i < count($input); $i += $columns) { - $output .= ""; - for ($c=0; $c<$columns; $c++) { - $output .= ""; - if (($i + $c) < count($input)) { - $output .= $input[$i + $c]; - } - $output .= ""; - } - $output .= ""; - } - - $output .= ""; - - return $output; - } - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/radialblurimage.xml b/reference/imagick/imagick/radialblurimage.xml deleted file mode 100644 index 748ff7ee964e..000000000000 --- a/reference/imagick/imagick/radialblurimage.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - Imagick::radialBlurImage - Radial blurs an image - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::radialBlurImage - floatangle - intchannelImagick::CHANNEL_DEFAULT - - - Radial blurs an image. - - - - - &reftitle.parameters; - - - - angle - - - - - - - channel - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>Imagick::radialBlurImage</function> - - radialBlurImage(3); - $imagick->radialBlurImage(5); - $imagick->radialBlurImage(7); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/raiseimage.xml b/reference/imagick/imagick/raiseimage.xml deleted file mode 100644 index 7a91037752e4..000000000000 --- a/reference/imagick/imagick/raiseimage.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - Imagick::raiseImage - Creates a simulated 3d button-like effect - - - - &reftitle.description; - - public boolImagick::raiseImage - intwidth - intheight - intx - inty - boolraise - - - Creates a simulated three-dimensional button-like effect - by lightening and darkening the edges of the image. - Members width and height of raise_info define the width - of the vertical and horizontal edge of the effect. - - - - - &reftitle.parameters; - - - - width - - - - - - - height - - - - - - - x - - - - - - - y - - - - - - - raise - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>Imagick::raiseImage</function> - - raiseImage($width, $height, $x, $y, $raise); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/randomthresholdimage.xml b/reference/imagick/imagick/randomthresholdimage.xml deleted file mode 100644 index 600e9b68204c..000000000000 --- a/reference/imagick/imagick/randomthresholdimage.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - Imagick::randomThresholdImage - Creates a high-contrast, two-color image - - - - &reftitle.description; - - public boolImagick::randomThresholdImage - floatlow - floathigh - intchannelImagick::CHANNEL_DEFAULT - - - - Changes the value of individual pixels based on the - intensity of each pixel compared to threshold. The - result is a high-contrast, two color image. &imagick.method.available.0x629; - - - - - &reftitle.parameters; - - - - low - - - The low point - - - - - high - - - The high point - - - - - channel - - - Provide any channel constant that is valid for your channel mode. To - apply to more than one channel, combine channeltype constants using - bitwise operators. Refer to this - list of channel constants. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>Imagick::randomThresholdImage</function> - - randomThresholdimage( - $lowThreshold * \Imagick::getQuantum(), - $highThreshold * \Imagick::getQuantum(), - $channel - ); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/readimage.xml b/reference/imagick/imagick/readimage.xml deleted file mode 100644 index 7a3cc0d29d45..000000000000 --- a/reference/imagick/imagick/readimage.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - Imagick::readImage - Reads image from filename - - - - &reftitle.description; - - public boolImagick::readImage - stringfilename - - - Reads image from filename - - - - - &reftitle.parameters; - - - - filename - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/readimageblob.xml b/reference/imagick/imagick/readimageblob.xml deleted file mode 100644 index bbbc8296e3e8..000000000000 --- a/reference/imagick/imagick/readimageblob.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - Imagick::readImageBlob - Reads image from a binary string - - - - &reftitle.description; - - public boolImagick::readImageBlob - stringimage - stringfilename - - - Reads image from a binary string - - - - - &reftitle.parameters; - - - - image - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::readImageBlob</function> - - readImageBlob($imageBlob); - - header("Content-Type: image/png"); - echo $imagick; -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/readimagefile.xml b/reference/imagick/imagick/readimagefile.xml deleted file mode 100644 index 0e1fd81f5c86..000000000000 --- a/reference/imagick/imagick/readimagefile.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - Imagick::readImageFile - Reads image from open filehandle - - - - &reftitle.description; - - public boolImagick::readImageFile - resourcefilehandle - stringfileName&null; - - - Reads image from open filehandle - - - - - &reftitle.parameters; - - - - filehandle - - - - - - - fileName - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - diff --git a/reference/imagick/imagick/readimages.xml b/reference/imagick/imagick/readimages.xml deleted file mode 100644 index 03c77443ac00..000000000000 --- a/reference/imagick/imagick/readimages.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - Imagick::readimages - Reads image from an array of filenames - - - - &reftitle.description; - - public boolImagick::readImages - arrayfilenames - - - Reads image from an array of filenames. All the images are held in a single Imagick object. - - - - - - - &reftitle.parameters; - - - filenames - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - diff --git a/reference/imagick/imagick/recolorimage.xml b/reference/imagick/imagick/recolorimage.xml deleted file mode 100644 index e5c939cac18d..000000000000 --- a/reference/imagick/imagick/recolorimage.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - Imagick::recolorImage - Recolors image - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::recolorImage - arraymatrix - - - - Translate, scale, shear, or rotate image colors. This method supports variable sized matrices but normally - 5x5 matrix is used for RGBA and 6x6 is used for CMYK. The last row should contain the normalized values. - &imagick.method.available.0x636; - - - - - &reftitle.parameters; - - - - matrix - - - The matrix containing the color values - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - <function>Imagick::recolorImage</function> - - recolorImage($remapColor); - - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::displayImage - - - - - - - diff --git a/reference/imagick/imagick/reducenoiseimage.xml b/reference/imagick/imagick/reducenoiseimage.xml deleted file mode 100644 index ba8ec0d5aaf7..000000000000 --- a/reference/imagick/imagick/reducenoiseimage.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - Imagick::reduceNoiseImage - Smooths the contours of an image - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::reduceNoiseImage - floatradius - - - Smooths the contours of an image while still preserving edge - information. The algorithm works by replacing each pixel with - its neighbor closest in value. A neighbor is defined by radius. - Use a radius of 0 and Imagick::reduceNoiseImage() selects a - suitable radius for you. - - - - - &reftitle.parameters; - - - - radius - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::reduceNoiseImage</function> - - reduceNoiseImage($reduceNoise); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/remapimage.xml b/reference/imagick/imagick/remapimage.xml deleted file mode 100644 index cf49236b5db4..000000000000 --- a/reference/imagick/imagick/remapimage.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - Imagick::remapImage - Remaps image colors - - - - &reftitle.description; - - public boolImagick::remapImage - Imagickreplacement - intDITHER - - - Replaces colors an image with those defined by replacement. The colors - are replaced with the closest possible color. &imagick.method.available.0x645; - - - - - &reftitle.parameters; - - - - replacement - - - An Imagick object containing the replacement colors - - - - - DITHER - - - Refer to this list of dither method constants - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - diff --git a/reference/imagick/imagick/removeimage.xml b/reference/imagick/imagick/removeimage.xml deleted file mode 100644 index 1c35b7fa5bdc..000000000000 --- a/reference/imagick/imagick/removeimage.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - Imagick::removeImage - Removes an image from the image list - - - - &reftitle.description; - - public boolImagick::removeImage - - - - Removes an image from the image list. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/removeimageprofile.xml b/reference/imagick/imagick/removeimageprofile.xml deleted file mode 100644 index 361b847370ef..000000000000 --- a/reference/imagick/imagick/removeimageprofile.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - Imagick::removeImageProfile - Removes the named image profile and returns it - - - - &reftitle.description; - - public stringImagick::removeImageProfile - stringname - - - Removes the named image profile and returns it. - - - - - &reftitle.parameters; - - - - name - - - - - - - - - - - &reftitle.returnvalues; - - Returns a string containing the profile of the image. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/render.xml b/reference/imagick/imagick/render.xml deleted file mode 100644 index b3ca8356c95c..000000000000 --- a/reference/imagick/imagick/render.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - Imagick::render - Renders all preceding drawing commands - - - - &reftitle.description; - - public boolImagick::render - - - - Renders all preceding drawing commands. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/resampleimage.xml b/reference/imagick/imagick/resampleimage.xml deleted file mode 100644 index c70e3795f913..000000000000 --- a/reference/imagick/imagick/resampleimage.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - Imagick::resampleImage - Resample image to desired resolution - - - - &reftitle.description; - - public boolImagick::resampleImage - floatx_resolution - floaty_resolution - intfilter - floatblur - - - Resample image to desired resolution. - - - - - &reftitle.parameters; - - - - x_resolution - - - - - - - y_resolution - - - - - - - filter - - - - - - - blur - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>Imagick::resampleImage</function> - - resampleImage(200, 200, \Imagick::FILTER_LANCZOS, 1); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/resetimagepage.xml b/reference/imagick/imagick/resetimagepage.xml deleted file mode 100644 index 8571a06e51e4..000000000000 --- a/reference/imagick/imagick/resetimagepage.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - Imagick::resetImagePage - Reset image page - - - - &reftitle.description; - - public boolImagick::resetImagePage - stringpage - - - - The page definition as a string. The string is in format WxH+x+y. - &imagick.method.available.0x636; - - - - - &reftitle.parameters; - - - - page - - - The page definition. For example 7168x5147+0+0 - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/resizeimage.xml b/reference/imagick/imagick/resizeimage.xml deleted file mode 100644 index 684a194da065..000000000000 --- a/reference/imagick/imagick/resizeimage.xml +++ /dev/null @@ -1,194 +0,0 @@ - - - - - Imagick::resizeImage - Scales an image - - - - &reftitle.description; - - public boolImagick::resizeImage - intcolumns - introws - intfilter - floatblur - boolbestfit&false; - boollegacy&false; - - - Scales an image to the desired dimensions with a - filter. - - &imagick.bestfit.note; - - - - &reftitle.parameters; - - - - columns - - - Width of the image - - - - - rows - - - Height of the image - - - - - filter - - - Refer to the list of filter constants. - - - - - blur - - - The blur factor where > 1 is blurry, < 1 is sharp. - - - - - bestfit - - - Optional bool parameter. - If set to true, the image is resized to fit within the given dimensions - while preserving the aspect ratio. - - - - - - legacy - - - Optional bool parameter. - If set to true, the calculations are done with the small rounding bug that existed in - Imagick before 3.4.0. If set to false, the calculations should produce the same results - as the ImageMagick command-line tools. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Added optional fit parameter. This method now supports proportional scaling. - Pass zero as either parameter for proportional scaling. - - - - PECL imagick 3.4.0 - - Added the legacy parameter. - - - - - - - - - - - &reftitle.examples; - - - <function>Imagick::resizeImage</function> - - 1 is blurry, < 1 is sharp. - $imagick = new \Imagick(realpath($imagePath)); - - $imagick->resizeImage($width, $height, $filterType, $blur, $bestFit); - - $cropWidth = $imagick->getImageWidth(); - $cropHeight = $imagick->getImageHeight(); - - if ($cropZoom) { - $newWidth = $cropWidth / 2; - $newHeight = $cropHeight / 2; - - $imagick->cropimage( - $newWidth, - $newHeight, - ($cropWidth - $newWidth) / 2, - ($cropHeight - $newHeight) / 2 - ); - - $imagick->scaleimage( - $imagick->getImageWidth() * 4, - $imagick->getImageHeight() * 4 - ); - } - - - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/rollimage.xml b/reference/imagick/imagick/rollimage.xml deleted file mode 100644 index 56cda4d772b4..000000000000 --- a/reference/imagick/imagick/rollimage.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - Imagick::rollImage - Offsets an image - - - - &reftitle.description; - - public boolImagick::rollImage - intx - inty - - - Offsets an image as defined by x and y. - - - - - &reftitle.parameters; - - - - x - - - The X offset. - - - - - y - - - The Y offset. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>Imagick::rollImage</function> - - rollimage($rollX, $rollY); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/rotateimage.xml b/reference/imagick/imagick/rotateimage.xml deleted file mode 100644 index 941d010384da..000000000000 --- a/reference/imagick/imagick/rotateimage.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - Imagick::rotateImage - Rotates an image - - - - &reftitle.description; - - public boolImagick::rotateImage - mixedbackground - floatdegrees - - - Rotates an image the specified number of degrees. Empty - triangles left over from rotating the image are filled - with the background color. - - - - - &reftitle.parameters; - - - - background - - - The background color - - - - - degrees - - - Rotation angle, in degrees. The rotation angle is interpreted as the - number of degrees to rotate the image clockwise. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Now allows a string representing the color as the first parameter. - Previous versions allow only an ImagickPixel object. - - - - - - - - - - - - &reftitle.examples; - - - <function>Imagick::rotateImage</function> - - rotateimage($color, $angle); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/rotationalblurimage.xml b/reference/imagick/imagick/rotationalblurimage.xml deleted file mode 100644 index 78b1903cbf6c..000000000000 --- a/reference/imagick/imagick/rotationalblurimage.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - Imagick::rotationalBlurImage - Rotational blurs an image - - - - &reftitle.description; - - public boolImagick::rotationalBlurImage - floatangle - intchannelImagick::CHANNEL_DEFAULT - - - Rotational blurs an image. - - - - - - - &reftitle.parameters; - - - angle - - - The angle to apply the blur over. - - - - - channel - - - &imagick.parameter.channel; - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - - &reftitle.examples; - - - <function>Imagick::rotationalBlurImage</function> - - rotationalBlurImage(3); - $imagick->rotationalBlurImage(5); - $imagick->rotationalBlurImage(7); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/roundcorners.xml b/reference/imagick/imagick/roundcorners.xml deleted file mode 100644 index a1feaee6a062..000000000000 --- a/reference/imagick/imagick/roundcorners.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - Imagick::roundCorners - Rounds image corners - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::roundCorners - floatx_rounding - floaty_rounding - floatstroke_width10 - floatdisplace5 - floatsize_correction-6 - - - Rounds image corners. The first two parameters control the amount - of rounding and the three last parameters can be used to fine-tune - the rounding process. &imagick.method.available.0x629; - &imagick.method.not.available.0x700; - - - - - &reftitle.parameters; - - - - x_rounding - - - x rounding - - - - - y_rounding - - - y rounding - - - - - stroke_width - - - stroke width - - - - - displace - - - image displace - - - - - size_correction - - - size correction - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Using <function>Imagick::roundCorners</function>: - - Rounds the image corners - - -newPseudoImage(100, 100, "magick:rose"); -$image->setImageFormat("png"); - -$image->roundCorners(5,3); -$image->writeImage("rounded.png"); -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/sampleimage.xml b/reference/imagick/imagick/sampleimage.xml deleted file mode 100644 index 42d458e13464..000000000000 --- a/reference/imagick/imagick/sampleimage.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - Imagick::sampleImage - Scales an image with pixel sampling - - - - &reftitle.description; - - public boolImagick::sampleImage - intcolumns - introws - - - Scales an image to the desired dimensions with pixel sampling. - Unlike other scaling methods, this method does not introduce - any additional color into the scaled image. - - - - - &reftitle.parameters; - - - - columns - - - - - - - rows - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/scaleimage.xml b/reference/imagick/imagick/scaleimage.xml deleted file mode 100644 index 3e1e3ef5943d..000000000000 --- a/reference/imagick/imagick/scaleimage.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - Imagick::scaleImage - Scales the size of an image - - - - &reftitle.description; - - public boolImagick::scaleImage - intcolumns - introws - boolbestfit&false; - boollegacy&false; - - - Scales the size of an image to the given dimensions. The other parameter - will be calculated if 0 is passed as either param. - - &imagick.bestfit.note; - - - - &reftitle.parameters; - - - - columns - - - The number of columns in the scaled image. - - - - - rows - - - The number of rows in the scaled image. - - - - - bestfit - - - Whether to fit the image within the given dimensions while preserving - the aspect ratio. - - - - - legacy - - - Optional bool parameter. - If set to true, the calculations are done with the small rounding bug - that existed in Imagick before 3.4.0. If set to false, the calculations - should produce the same results as the ImageMagick command-line tools. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Added optional fit parameter. This method now supports proportional scaling. - Pass zero as either parameter for proportional scaling. - - - - PECL imagick 3.4.0 - - Added the legacy parameter. - - - - - - - - - - - &reftitle.examples; - - - <function>Imagick::scaleImage</function> - - scaleImage(150, 150, true); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/segmentimage.xml b/reference/imagick/imagick/segmentimage.xml deleted file mode 100644 index fed4e23304e8..000000000000 --- a/reference/imagick/imagick/segmentimage.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - Imagick::segmentImage - Segments an image - - - - &reftitle.description; - - public boolImagick::segmentImage - intCOLORSPACE - floatcluster_threshold - floatsmooth_threshold - boolverbose&false; - - - Analyses the image and identifies units that are similar. &imagick.method.available.0x645; - - - - - &reftitle.parameters; - - - - COLORSPACE - - - One of the COLORSPACE constants. - - - - - cluster_threshold - - - A percentage describing minimum number of pixels - contained in hexedra before it is considered valid. - - - - - smooth_threshold - - - Eliminates noise from the histogram. - - - - - verbose - - - Whether to output detailed information about recognised classes. - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - &reftitle.examples; - - - <function>Imagick::segmentImage</function> - - segmentImage($colorSpace, $clusterThreshold, $smoothThreshold); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -segmentImage($imagePath, \Imagick::COLORSPACE_RGB, 5, 5); - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/selectiveblurimage.xml b/reference/imagick/imagick/selectiveblurimage.xml deleted file mode 100644 index 4c5332a3e9b6..000000000000 --- a/reference/imagick/imagick/selectiveblurimage.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - Imagick::selectiveBlurImage - Selectively blur an image within a contrast threshold - - - - &reftitle.description; - - public boolImagick::selectiveBlurImage - floatradius - floatsigma - floatthreshold - intchannelImagick::CHANNEL_DEFAULT - - - Selectively blur an image within a contrast threshold. It is similar to the unsharpen mask that sharpens everything with contrast above a certain threshold. - - - - - - - &reftitle.parameters; - - - radius - - - - - - - - sigma - - - - - - - - threshold - - - - - - - - channel - - - &imagick.parameter.channel; - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - - &reftitle.examples; - - - <function>Imagick::selectiveBlurImage</function> - - selectiveBlurImage($radius, $sigma, $threshold, $channel); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/separateimagechannel.xml b/reference/imagick/imagick/separateimagechannel.xml deleted file mode 100644 index ec9606d4a608..000000000000 --- a/reference/imagick/imagick/separateimagechannel.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - Imagick::separateImageChannel - Separates a channel from the image - - - - &reftitle.description; - - public boolImagick::separateImageChannel - intchannel - - - Separates a channel from the image and returns a grayscale image. A channel - is a particular color component of each pixel in the image. - - - - - &reftitle.parameters; - - - - channel - - - Which 'channel' to return. For colorspaces other than RGB, you can still use the CHANNEL_RED, CHANNEL_GREEN, CHANNEL_BLUE constants to indicate the 1st, 2nd and 3rd channels. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::separateImageChannel</function> - - separateimagechannel($channel); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -separateImageChannel($imagePath, \Imagick::CHANNEL_GREEN); - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/sepiatoneimage.xml b/reference/imagick/imagick/sepiatoneimage.xml deleted file mode 100644 index 882814be8e12..000000000000 --- a/reference/imagick/imagick/sepiatoneimage.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - Imagick::sepiaToneImage - Sepia tones an image - - - - &reftitle.description; - - public boolImagick::sepiaToneImage - floatthreshold - - - Applies a special effect to the image, similar to the effect achieved - in a photo darkroom by sepia toning. Threshold ranges from 0 to - QuantumRange and is a measure of the extent of the sepia toning. A - threshold of 80 is a good starting point for a reasonable tone. - - - - - &reftitle.parameters; - - - - threshold - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::sepiaToneImage</function> - - sepiaToneImage($sepia); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/setbackgroundcolor.xml b/reference/imagick/imagick/setbackgroundcolor.xml deleted file mode 100644 index 8a0a67634aa6..000000000000 --- a/reference/imagick/imagick/setbackgroundcolor.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - Imagick::setBackgroundColor - Sets the object's default background color - - - - &reftitle.description; - - public boolImagick::setBackgroundColor - mixedbackground - - - Sets the object's default background color. - - - - - &reftitle.parameters; - - - - background - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Now allows a string representing the color as a parameter. - Previous versions allow only an ImagickPixel object. - - - - - - - - - - - diff --git a/reference/imagick/imagick/setcolorspace.xml b/reference/imagick/imagick/setcolorspace.xml deleted file mode 100644 index 2e9860d320bf..000000000000 --- a/reference/imagick/imagick/setcolorspace.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - Imagick::setColorspace - Set colorspace - - - - &reftitle.description; - - public boolImagick::setColorspace - intCOLORSPACE - - - Sets the global colorspace value for the object. - &imagick.method.available.0x657; - - - - - &reftitle.parameters; - - - - COLORSPACE - - - One of the COLORSPACE constants - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setcompression.xml b/reference/imagick/imagick/setcompression.xml deleted file mode 100644 index 8291334e7091..000000000000 --- a/reference/imagick/imagick/setcompression.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - Imagick::setCompression - Sets the object's default compression type - - - - &reftitle.description; - - public boolImagick::setCompression - intcompression - - - Sets the object's default compression type - - - - - &reftitle.parameters; - - - - compression - - - The compression type. See the Imagick::COMPRESSION_* constants. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/setcompressionquality.xml b/reference/imagick/imagick/setcompressionquality.xml deleted file mode 100644 index 39bcd63b8082..000000000000 --- a/reference/imagick/imagick/setcompressionquality.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - Imagick::setCompressionQuality - Sets the object's default compression quality - - - - &reftitle.description; - - public boolImagick::setCompressionQuality - intquality - - - Sets the object's default compression quality. - - - - - This method only works for new images e.g. those created through Imagick::newPseudoImage. For existing images you should use Imagick::setImageCompressionQuality. - - - - - - - &reftitle.parameters; - - - - quality - - - An &integer; between 1 and 100, 1 = high compression, 100 low compression. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>Imagick::setCompressionQuality</function> - - setCompressionQuality($quality); - $imagick->newPseudoImage( - $backgroundImagick->getImageWidth(), - $backgroundImagick->getImageHeight(), - 'canvas:white' - ); - - $imagick->compositeImage( - $backgroundImagick, - \Imagick::COMPOSITE_ATOP, - 0, - 0 - ); - - $imagick->setFormat("jpg"); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/setfilename.xml b/reference/imagick/imagick/setfilename.xml deleted file mode 100644 index 8d573d56b6ea..000000000000 --- a/reference/imagick/imagick/setfilename.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - Imagick::setFilename - Sets the filename before you read or write the image - - - - &reftitle.description; - - public boolImagick::setFilename - stringfilename - - - Sets the filename before you read or write an image file. - - - - - &reftitle.parameters; - - - - filename - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/setfirstiterator.xml b/reference/imagick/imagick/setfirstiterator.xml deleted file mode 100644 index f3551a972675..000000000000 --- a/reference/imagick/imagick/setfirstiterator.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - Imagick::setFirstIterator - Sets the Imagick iterator to the first image - - - - &reftitle.description; - - public boolImagick::setFirstIterator - - - - Sets the Imagick iterator to the first image. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/setfont.xml b/reference/imagick/imagick/setfont.xml deleted file mode 100644 index e453e87e99b3..000000000000 --- a/reference/imagick/imagick/setfont.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - Imagick::setFont - Sets font - - - - &reftitle.description; - - public boolImagick::setFont - stringfont - - - Sets object's font property. This method can be used for example to set font for - caption: pseudo-format. The font needs to be configured in ImageMagick configuration - or a file by the name of font must exist. This method should - not be confused with ImagickDraw::setFont which sets the font - for a specific ImagickDraw object. - &imagick.method.available.0x637; - - - - - &reftitle.parameters; - - - - font - - - Font name or a filename - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - A <function>Imagick::setFont</function> example - - Example of using Imagick::setFont - - -setFont("example.ttf"); - -/* Create new caption */ -$im->newPseudoImage(100, 100, "caption:Hello"); - -/* Do something with the image */ -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::getFont - ImagickDraw::setFont - ImagickDraw::getFont - - - - - - - diff --git a/reference/imagick/imagick/setformat.xml b/reference/imagick/imagick/setformat.xml deleted file mode 100644 index 9542137b313b..000000000000 --- a/reference/imagick/imagick/setformat.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - Imagick::setFormat - Sets the format of the Imagick object - - - - &reftitle.description; - - public boolImagick::setFormat - stringformat - - - Sets the format of the Imagick object. - - - - - &reftitle.parameters; - - - - format - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/setgravity.xml b/reference/imagick/imagick/setgravity.xml deleted file mode 100644 index 7965b8171c82..000000000000 --- a/reference/imagick/imagick/setgravity.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - Imagick::setGravity - Sets the gravity - - - - &reftitle.description; - - public boolImagick::setGravity - intgravity - - - - Sets the global gravity property for the Imagick object. - &imagick.method.available.0x640; - - - - - &reftitle.parameters; - - - - gravity - - - The gravity property. Refer to the list of - gravity constants. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagick/setimage.xml b/reference/imagick/imagick/setimage.xml deleted file mode 100644 index 06564b40a104..000000000000 --- a/reference/imagick/imagick/setimage.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - Imagick::setImage - Replaces image in the object - - - - &reftitle.description; - - public boolImagick::setImage - Imagickreplace - - - Replaces the current image sequence with the image from replace object. - - - - - &reftitle.parameters; - - - - replace - - - The replace Imagick object - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - A <function>Imagick::setImage</function> example - - An example of using Imagick::setImage() - - -setImage($replace); - -/* output the image */ -header('Content-type: image/jpeg'); -echo $image; - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/setimagealphachannel.xml b/reference/imagick/imagick/setimagealphachannel.xml deleted file mode 100644 index 7bf6d8ab9d5a..000000000000 --- a/reference/imagick/imagick/setimagealphachannel.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - Imagick::setImageAlphaChannel - Sets image alpha channel - - - - &reftitle.description; - - public boolImagick::setImageAlphaChannel - intmode - - - Activate or deactivate image alpha channel. The mode - is one of the Imagick::ALPHACHANNEL_* constants. - &imagick.method.available.0x638; - - - - - &reftitle.parameters; - - - - mode - - - One of the Imagick::ALPHACHANNEL_* constants - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.seealso; - - - Imagick::setImageMatte - Imagick Alpha Channel Constants - - - - - - - diff --git a/reference/imagick/imagick/setimageartifact.xml b/reference/imagick/imagick/setimageartifact.xml deleted file mode 100644 index 30b54d061d4c..000000000000 --- a/reference/imagick/imagick/setimageartifact.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - Imagick::setImageArtifact - Set image artifact - - - - &reftitle.description; - - public boolImagick::setImageArtifact - stringartifact - stringvalue - - - Associates an artifact with the image. The difference between image properties and - image artifacts is that properties are public and artifacts are private. - &imagick.method.available.0x657; - - - - - &reftitle.parameters; - - - - artifact - - - The name of the artifact - - - - - value - - - The value of the artifact - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - <function>Imagick::setImageArtifact</function> - - setImageVirtualPixelMethod(\Imagick::VIRTUALPIXELMETHOD_TRANSPARENT); - $src2->setImageArtifact('compose:args', "1,0,-0.5,0.5"); - $src1->compositeImage($src2, Imagick::COMPOSITE_MATHEMATICS, 0, 0); - - $src1->setImageFormat('png'); - header("Content-Type: image/png"); - echo $src1->getImagesBlob(); -} - -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::getImageArtifact - Imagick::deleteImageArtifact - - - - - - - diff --git a/reference/imagick/imagick/setimageattribute.xml b/reference/imagick/imagick/setimageattribute.xml deleted file mode 100644 index 23fe7c0083d1..000000000000 --- a/reference/imagick/imagick/setimageattribute.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - Imagick::setImageAttribute - Sets an image attribute - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::setImageAttribute - stringkey - stringvalue - - - Sets an image attribute. - - - - - - &reftitle.parameters; - - - key - - - - - - - - value - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - diff --git a/reference/imagick/imagick/setimagebackgroundcolor.xml b/reference/imagick/imagick/setimagebackgroundcolor.xml deleted file mode 100644 index dac83aad59f9..000000000000 --- a/reference/imagick/imagick/setimagebackgroundcolor.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - Imagick::setImageBackgroundColor - Sets the image background color - - - - &reftitle.description; - - public boolImagick::setImageBackgroundColor - mixedbackground - - - Sets the image background color. - - - - - &reftitle.parameters; - - - - background - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Now allows a string representing the color as the parameter. - Previous versions allow only an ImagickPixel object. - - - - - - - - - - - diff --git a/reference/imagick/imagick/setimagebias.xml b/reference/imagick/imagick/setimagebias.xml deleted file mode 100644 index 8a0b9193c1c7..000000000000 --- a/reference/imagick/imagick/setimagebias.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - Imagick::setImageBias - Sets the image bias for any method that convolves an image - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::setImageBias - floatbias - - - Sets the image bias for any method that convolves an image (e.g. Imagick::ConvolveImage()). - - - - - &reftitle.parameters; - - - - bias - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::setImageBias</function> - - setImageBias($bias * \Imagick::getQuantum()); - $imagick->convolveImage($xKernel, \Imagick::CHANNEL_ALL); - - $imagick->setImageFormat('png'); - - header('Content-type: image/png'); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/setimagebiasquantum.xml b/reference/imagick/imagick/setimagebiasquantum.xml deleted file mode 100644 index 61931d477bf4..000000000000 --- a/reference/imagick/imagick/setimagebiasquantum.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - Imagick::setImageBiasQuantum - Sets the image bias - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public voidImagick::setImageBiasQuantum - floatbias - - - Sets the image bias. Bias should be scaled with 0 (no adjustment) to 1 (quantum value). - - - - - - &reftitle.parameters; - - - bias - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/imagick/imagick/setimageblueprimary.xml b/reference/imagick/imagick/setimageblueprimary.xml deleted file mode 100644 index 1813fc6030bd..000000000000 --- a/reference/imagick/imagick/setimageblueprimary.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - Imagick::setImageBluePrimary - Sets the image chromaticity blue primary point - - - - &reftitle.description; - - public boolImagick::setImageBluePrimary - floatx - floaty - - - Sets the image chromaticity blue primary point. - - - - - &reftitle.parameters; - - - - x - - - - - - - y - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimagebordercolor.xml b/reference/imagick/imagick/setimagebordercolor.xml deleted file mode 100644 index d9658b7274eb..000000000000 --- a/reference/imagick/imagick/setimagebordercolor.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - Imagick::setImageBorderColor - Sets the image border color - - - - &reftitle.description; - - public boolImagick::setImageBorderColor - mixedborder - - - Sets the image border color. - - - - - &reftitle.parameters; - - - - border - - - The border color - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Now allows a string representing the color as a parameter. - Previous versions allow only an ImagickPixel object. - - - - - - - - - - - diff --git a/reference/imagick/imagick/setimagechanneldepth.xml b/reference/imagick/imagick/setimagechanneldepth.xml deleted file mode 100644 index f12aba4f1606..000000000000 --- a/reference/imagick/imagick/setimagechanneldepth.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - Imagick::setImageChannelDepth - Sets the depth of a particular image channel - - - - &reftitle.description; - - public boolImagick::setImageChannelDepth - intchannel - intdepth - - - Sets the depth of a particular image channel. - - - - - &reftitle.parameters; - - - - channel - - - - - - - depth - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimageclipmask.xml b/reference/imagick/imagick/setimageclipmask.xml deleted file mode 100644 index bd6a53be4689..000000000000 --- a/reference/imagick/imagick/setimageclipmask.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - Imagick::setImageClipMask - Sets image clip mask - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::setImageClipMask - Imagickclip_mask - - - - Sets image clip mask from another Imagick object. - &imagick.method.available.0x636; - - - - - &reftitle.parameters; - - - - clip_mask - - - The Imagick object containing the clip mask - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::setImageClipMask</function> - - readImage(realpath($imagePath)); - - $width = $imagick->getImageWidth(); - $height = $imagick->getImageHeight(); - - $clipMask = new \Imagick(); - $clipMask->newPseudoImage( - $width, - $height, - "canvas:transparent" - ); - - $draw = new \ImagickDraw(); - $draw->setFillColor('white'); - $draw->circle( - $width / 2, - $height / 2, - ($width / 2) + ($width / 4), - $height / 2 - ); - $clipMask->drawImage($draw); - $imagick->setImageClipMask($clipMask); - - $imagick->negateImage(false); - $imagick->setFormat("png"); - - header("Content-Type: image/png"); - echo $imagick->getImagesBlob(); - -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/setimagecolormapcolor.xml b/reference/imagick/imagick/setimagecolormapcolor.xml deleted file mode 100644 index e76b39bf8060..000000000000 --- a/reference/imagick/imagick/setimagecolormapcolor.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - Imagick::setImageColormapColor - Sets the color of the specified colormap index - - - - &reftitle.description; - - public boolImagick::setImageColormapColor - intindex - ImagickPixelcolor - - - Sets the color of the specified colormap index. - - - - - &reftitle.parameters; - - - - index - - - - - - - color - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimagecolorspace.xml b/reference/imagick/imagick/setimagecolorspace.xml deleted file mode 100644 index ee5fc0cb5ff4..000000000000 --- a/reference/imagick/imagick/setimagecolorspace.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - Imagick::setImageColorspace - Sets the image colorspace - - - - &reftitle.description; - - public boolImagick::setImageColorspace - intcolorspace - - - Sets the image colorspace. This method should be used when creating new images. To change the colorspace of an existing image, you should use Imagick::transformImageColorspace. - - - - - &reftitle.parameters; - - - - colorspace - - - One of the COLORSPACE constants - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimagecompose.xml b/reference/imagick/imagick/setimagecompose.xml deleted file mode 100644 index 8cee11e6344d..000000000000 --- a/reference/imagick/imagick/setimagecompose.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - Imagick::setImageCompose - Sets the image composite operator - - - - &reftitle.description; - - public boolImagick::setImageCompose - intcompose - - - Sets the image composite operator, useful for specifying how - to composite the image thumbnail when using the - Imagick::montageImage() method. - - - - - &reftitle.parameters; - - - - compose - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimagecompression.xml b/reference/imagick/imagick/setimagecompression.xml deleted file mode 100644 index 1d68c6376b99..000000000000 --- a/reference/imagick/imagick/setimagecompression.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - Imagick::setImageCompression - Sets the image compression - - - - &reftitle.description; - - public boolImagick::setImageCompression - intcompression - - - - - - - &reftitle.parameters; - - - - compression - - - One of the COMPRESSION constants - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimagecompressionquality.xml b/reference/imagick/imagick/setimagecompressionquality.xml deleted file mode 100644 index 36dc7d7ec208..000000000000 --- a/reference/imagick/imagick/setimagecompressionquality.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - Imagick::setImageCompressionQuality - Sets the image compression quality - - - - &reftitle.description; - - public boolImagick::setImageCompressionQuality - intquality - - - Sets the image compression quality. - - - - - &reftitle.parameters; - - - - quality - - - The image compression quality as an integer - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::setImageCompressionQuality</function> - - setImageCompressionQuality($quality); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/setimagedelay.xml b/reference/imagick/imagick/setimagedelay.xml deleted file mode 100644 index 1e9bcbfc3521..000000000000 --- a/reference/imagick/imagick/setimagedelay.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - Imagick::setImageDelay - Sets the image delay - - - - &reftitle.description; - - public boolImagick::setImageDelay - intdelay - - - Sets the image delay. For an animated image this is the amount of time that - this frame of the image should be displayed for, before displaying the next - frame. - - - The delay can be set individually for each frame in an image. - - - - - &reftitle.parameters; - - - - delay - - - The amount of time expressed in 'ticks' that the image should be - displayed for. For animated GIFs there are 100 ticks per second, so a - value of 20 would be 20/100 of a second aka 1/5th of a second. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Modify animated Gif with <function>Imagick::setImageDelay</function> - -coalesceImages(); - -$frameCount = 0; - -foreach ($imagick as $frame) { - $imagick->setImageDelay((($frameCount % 11) * 5)); - $frameCount++; -} - -$imagick = $imagick->deconstructImages(); - -$imagick->writeImages("/path/to/save/output.gif", true); - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/setimagedepth.xml b/reference/imagick/imagick/setimagedepth.xml deleted file mode 100644 index 57ab22712f22..000000000000 --- a/reference/imagick/imagick/setimagedepth.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - Imagick::setImageDepth - Sets the image depth - - - - &reftitle.description; - - public boolImagick::setImageDepth - intdepth - - - Sets the image depth. - - - - - &reftitle.parameters; - - - - depth - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimagedispose.xml b/reference/imagick/imagick/setimagedispose.xml deleted file mode 100644 index 5c710f93cd7d..000000000000 --- a/reference/imagick/imagick/setimagedispose.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - Imagick::setImageDispose - Sets the image disposal method - - - - &reftitle.description; - - public boolImagick::setImageDispose - intdispose - - - Sets the image disposal method. - - - - - &reftitle.parameters; - - - - dispose - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimageextent.xml b/reference/imagick/imagick/setimageextent.xml deleted file mode 100644 index f43372754e1b..000000000000 --- a/reference/imagick/imagick/setimageextent.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - Imagick::setImageExtent - Sets the image size - - - - &reftitle.description; - - public boolImagick::setImageExtent - intcolumns - introws - - - Sets the image size (i.e. columns & rows). - - - - - &reftitle.parameters; - - - - columns - - - - - - - rows - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimagefilename.xml b/reference/imagick/imagick/setimagefilename.xml deleted file mode 100644 index 1d03f228efad..000000000000 --- a/reference/imagick/imagick/setimagefilename.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - Imagick::setImageFilename - Sets the filename of a particular image - - - - &reftitle.description; - - public boolImagick::setImageFilename - stringfilename - - - Sets the filename of a particular image in a sequence. - - - - - &reftitle.parameters; - - - - filename - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimageformat.xml b/reference/imagick/imagick/setimageformat.xml deleted file mode 100644 index f5665ecf46ae..000000000000 --- a/reference/imagick/imagick/setimageformat.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - Imagick::setImageFormat - Sets the format of a particular image - - - - &reftitle.description; - - public boolImagick::setImageFormat - stringformat - - - Sets the format of a particular image in a sequence. - - - - - &reftitle.parameters; - - - - format - - - String presentation of the image format. Format support - depends on the ImageMagick installation. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/setimagegamma.xml b/reference/imagick/imagick/setimagegamma.xml deleted file mode 100644 index 3a8f2596294d..000000000000 --- a/reference/imagick/imagick/setimagegamma.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - Imagick::setImageGamma - Sets the image gamma - - - - &reftitle.description; - - public boolImagick::setImageGamma - floatgamma - - - Sets the image gamma. - - - - - &reftitle.parameters; - - - - gamma - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimagegravity.xml b/reference/imagick/imagick/setimagegravity.xml deleted file mode 100644 index 321dca15ef35..000000000000 --- a/reference/imagick/imagick/setimagegravity.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - Imagick::setImageGravity - Sets the image gravity - - - - &reftitle.description; - - public boolImagick::setImageGravity - intgravity - - - - Sets the gravity property for the current image. This method can be used - to set the gravity property for a single image sequence. - &imagick.method.available.0x644; - - - - - &reftitle.parameters; - - - - gravity - - - The gravity property. Refer to the list of - gravity constants. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagick/setimagegreenprimary.xml b/reference/imagick/imagick/setimagegreenprimary.xml deleted file mode 100644 index e55eb2075b4e..000000000000 --- a/reference/imagick/imagick/setimagegreenprimary.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - Imagick::setImageGreenPrimary - Sets the image chromaticity green primary point - - - - &reftitle.description; - - public boolImagick::setImageGreenPrimary - floatx - floaty - - - Sets the image chromaticity green primary point. - - - - - &reftitle.parameters; - - - - x - - - - - - - y - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimageindex.xml b/reference/imagick/imagick/setimageindex.xml deleted file mode 100644 index 9e6e5e3cb3b6..000000000000 --- a/reference/imagick/imagick/setimageindex.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - Imagick::setImageIndex - Set the iterator position - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::setImageIndex - intindex - - - Set the iterator to the position in the image list specified with the index - parameter. - - - This method has been deprecated. See - Imagick::setIteratorIndex. - - - - - &reftitle.parameters; - - - - index - - - The position to set the iterator to - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimageinterlacescheme.xml b/reference/imagick/imagick/setimageinterlacescheme.xml deleted file mode 100644 index c419c6deb869..000000000000 --- a/reference/imagick/imagick/setimageinterlacescheme.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - Imagick::setImageInterlaceScheme - Sets the image compression - - - - &reftitle.description; - - public boolImagick::setImageInterlaceScheme - intinterlace_scheme - - - Sets the image compression. - - - - - &reftitle.parameters; - - - - interlace_scheme - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimageinterpolatemethod.xml b/reference/imagick/imagick/setimageinterpolatemethod.xml deleted file mode 100644 index babc90adb928..000000000000 --- a/reference/imagick/imagick/setimageinterpolatemethod.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - Imagick::setImageInterpolateMethod - Sets the image interpolate pixel method - - - - &reftitle.description; - - public boolImagick::setImageInterpolateMethod - intmethod - - - Sets the image interpolate pixel method. - - - - - &reftitle.parameters; - - - - method - - - The method is one of the Imagick::INTERPOLATE_* constants - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/setimageiterations.xml b/reference/imagick/imagick/setimageiterations.xml deleted file mode 100644 index ab5e621657b6..000000000000 --- a/reference/imagick/imagick/setimageiterations.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - Imagick::setImageIterations - Sets the image iterations - - - - &reftitle.description; - - public boolImagick::setImageIterations - intiterations - - - Sets the number of iterations an animated image is repeated. - - - - - &reftitle.parameters; - - - - iterations - - - The number of iterations the image should loop over. Set to '0' to loop - continuously. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Basic <function>Imagick::setImageIterations</function> usage - -coalesceImages(); -$imagick->setImageIterations(1); -$imagick = $imagick->deconstructImages(); - -$imagick->writeImages('/path/to/save/OnceOnly.gif', true); - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/setimagematte.xml b/reference/imagick/imagick/setimagematte.xml deleted file mode 100644 index 06e7fa9a80c3..000000000000 --- a/reference/imagick/imagick/setimagematte.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - Imagick::setImageMatte - Sets the image matte channel - - - - &reftitle.description; - - public boolImagick::setImageMatte - boolmatte - - - - Sets the image matte channel. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - - - - matte - - - True activates the matte channel and false disables it. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/setimagemattecolor.xml b/reference/imagick/imagick/setimagemattecolor.xml deleted file mode 100644 index e652b1a84d47..000000000000 --- a/reference/imagick/imagick/setimagemattecolor.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - Imagick::setImageMatteColor - Sets the image matte color - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::setImageMatteColor - mixedmatte - - - Sets the image matte color. - - - - - &reftitle.parameters; - - - - matte - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Now allows a string representing the color as the parameter. - Previous versions allow only an ImagickPixel object. - - - - - - - - - - - diff --git a/reference/imagick/imagick/setimageopacity.xml b/reference/imagick/imagick/setimageopacity.xml deleted file mode 100644 index 17c82dcc315f..000000000000 --- a/reference/imagick/imagick/setimageopacity.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - Imagick::setImageOpacity - Sets the image opacity level - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::setImageOpacity - floatopacity - - - - Sets the image to the specified opacity level. &imagick.method.available.0x631; - This method operates on all channels, which means that for example opacity value - of 0.5 will set all transparent areas to partially opaque. To add transparency to - areas that are not already transparent use Imagick::evaluateImage() - - - - - &reftitle.parameters; - - - - opacity - - - The level of transparency: 1.0 is fully opaque and 0.0 is fully - transparent. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - A <function>Imagick::setImageOpacity</function> example - - An example of using Imagick::setImageOpacity() - - -setImageOpacity(0.7); - -/* output the image */ -header('Content-type: image/png'); -echo $image; - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/setimageorientation.xml b/reference/imagick/imagick/setimageorientation.xml deleted file mode 100644 index 238adb1bb3f1..000000000000 --- a/reference/imagick/imagick/setimageorientation.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - Imagick::setImageOrientation - Sets the image orientation - - - - &reftitle.description; - - public boolImagick::setImageOrientation - intorientation - - - - Sets the image orientation. - - - - - &reftitle.parameters; - - - - orientation - - - One of the orientation constants - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>Imagick::setImageOrientation</function> - - setImageOrientation($orientationType); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/setimagepage.xml b/reference/imagick/imagick/setimagepage.xml deleted file mode 100644 index 6c7d26789bd0..000000000000 --- a/reference/imagick/imagick/setimagepage.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - Imagick::setImagePage - Sets the page geometry of the image - - - - &reftitle.description; - - public boolImagick::setImagePage - intwidth - intheight - intx - inty - - - Sets the page geometry of the image. - - - - - &reftitle.parameters; - - - - width - - - - - - - height - - - - - - - x - - - - - - - y - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimageprofile.xml b/reference/imagick/imagick/setimageprofile.xml deleted file mode 100644 index 45dd5b8b4623..000000000000 --- a/reference/imagick/imagick/setimageprofile.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - Imagick::setImageProfile - Adds a named profile to the Imagick object - - - - &reftitle.description; - - public boolImagick::setImageProfile - stringname - stringprofile - - - Adds a named profile to the Imagick object. If a profile - with the same name already exists, it is replaced. This - method differs from the Imagick::ProfileImage() method in - that it does not apply any CMS color profiles. - - - - - &reftitle.parameters; - - - - name - - - - - - - profile - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimageproperty.xml b/reference/imagick/imagick/setimageproperty.xml deleted file mode 100644 index 05f76539c57e..000000000000 --- a/reference/imagick/imagick/setimageproperty.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - Imagick::setImageProperty - Sets an image property - - - - &reftitle.description; - - public boolImagick::setImageProperty - stringname - stringvalue - - - - Sets a named property to the image. &imagick.method.available.0x632; - - - - - &reftitle.parameters; - - - - name - - - - - - - value - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Using <function>Imagick::setImageProperty</function>: - - Setting and getting image properties - - -newImage(300, 200, "black"); - -$image->setImageProperty('Exif:Make', 'Imagick'); -echo $image->getImageProperty('Exif:Make'); -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::getImageProperty - - - - - - - diff --git a/reference/imagick/imagick/setimageredprimary.xml b/reference/imagick/imagick/setimageredprimary.xml deleted file mode 100644 index f01fcbf1c447..000000000000 --- a/reference/imagick/imagick/setimageredprimary.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - Imagick::setImageRedPrimary - Sets the image chromaticity red primary point - - - - &reftitle.description; - - public boolImagick::setImageRedPrimary - floatx - floaty - - - Sets the image chromaticity red primary point. - - - - - &reftitle.parameters; - - - - x - - - - - - - y - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimagerenderingintent.xml b/reference/imagick/imagick/setimagerenderingintent.xml deleted file mode 100644 index c7bafb169bc5..000000000000 --- a/reference/imagick/imagick/setimagerenderingintent.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - Imagick::setImageRenderingIntent - Sets the image rendering intent - - - - &reftitle.description; - - public boolImagick::setImageRenderingIntent - intrendering_intent - - - Sets the image rendering intent. - - - - - &reftitle.parameters; - - - - rendering_intent - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimageresolution.xml b/reference/imagick/imagick/setimageresolution.xml deleted file mode 100644 index 5ff9c47ec5b4..000000000000 --- a/reference/imagick/imagick/setimageresolution.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - Imagick::setImageResolution - Sets the image resolution - - - - &reftitle.description; - - public boolImagick::setImageResolution - floatx_resolution - floaty_resolution - - - Sets the image resolution. - - - - - &reftitle.parameters; - - - - x_resolution - - - - - - - y_resolution - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::setImageResolution</function> - - setImageResolution(50, 50); - - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/setimagescene.xml b/reference/imagick/imagick/setimagescene.xml deleted file mode 100644 index 80f8af020f60..000000000000 --- a/reference/imagick/imagick/setimagescene.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - Imagick::setImageScene - Sets the image scene - - - - &reftitle.description; - - public boolImagick::setImageScene - intscene - - - Sets the image scene. - - - - - &reftitle.parameters; - - - - scene - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimagetickspersecond.xml b/reference/imagick/imagick/setimagetickspersecond.xml deleted file mode 100644 index bee029842754..000000000000 --- a/reference/imagick/imagick/setimagetickspersecond.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - Imagick::setImageTicksPerSecond - Sets the image ticks-per-second - - - - &reftitle.description; - - public boolImagick::setImageTicksPerSecond - intticks_per_second - - - Adjust the amount of time that a frame of an animated image is displayed for. - - - - For animated GIFs, this function does not change the number of 'image ticks' - per second, which is always defined as 100. Instead it adjusts the amount of - time that the frame is displayed for to simulate the change in 'ticks per - second'. - - - For example, for an animated GIF where each frame is displayed for 20 ticks - (1/5 of a second) when this method is called on each frame of that image - with an argument of 50 the frames are adjusted to be - displayed for 40 ticks (2/5 of a second) and the animation will play at half - the original speed. - - - - - - &reftitle.parameters; - - - - ticks_per_second - - - The duration for which an image should be displayed expressed in ticks - per second. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Modify animated Gif with <function>Imagick::setImageTicksPerSecond</function> - -coalesceImages(); - -$totalFrames = $imagick->getNumberImages(); - -$frameCount = 0; - -foreach ($imagick as $frame) { - $imagick->setImageTicksPerSecond(50); - - if ($frameCount < ($totalFrames / 2)) { - // Modify the frame to be displayed for twice as long as it currently is - $imagick->setImageTicksPerSecond(50); - } else { - // Modify the frame to be displayed for half as long as it currently is - $imagick->setImageTicksPerSecond(200); - } - - $frameCount++; -} - -$imagick = $imagick->deconstructImages(); - -$imagick->writeImages("/path/to/save/output.gif", true); - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/setimagetype.xml b/reference/imagick/imagick/setimagetype.xml deleted file mode 100644 index 5f6b586017c7..000000000000 --- a/reference/imagick/imagick/setimagetype.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - Imagick::setImageType - Sets the image type - - - - &reftitle.description; - - public boolImagick::setImageType - intimage_type - - - Converts the image to the given type, which combines a color model with the - presence or absence of an alpha channel. - Depending on the type, this may change the colorspace, quantize the colors, - or change whether the image has an alpha channel. - - - Imagick::setImageType modifies the image itself. - To set the type that subsequent images are written with instead, use - Imagick::setType. - - - - - &reftitle.parameters; - - - image_type - - - One of the - imagick::IMGTYPE_* - constants. imagick::IMGTYPE_UNDEFINED and - imagick::IMGTYPE_OPTIMIZE convert nothing, but are - still recorded on the image. - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/setimageunits.xml b/reference/imagick/imagick/setimageunits.xml deleted file mode 100644 index 2d2608dd2854..000000000000 --- a/reference/imagick/imagick/setimageunits.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - Imagick::setImageUnits - Sets the image units of resolution - - - - &reftitle.description; - - public boolImagick::setImageUnits - intunits - - - Sets the image units of resolution. - - - - - &reftitle.parameters; - - - - units - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/setimagevirtualpixelmethod.xml b/reference/imagick/imagick/setimagevirtualpixelmethod.xml deleted file mode 100644 index 8c2df9295580..000000000000 --- a/reference/imagick/imagick/setimagevirtualpixelmethod.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - Imagick::setImageVirtualPixelMethod - Sets the image virtual pixel method - - - - &reftitle.description; - - public boolImagick::setImageVirtualPixelMethod - intmethod - - - Sets the image virtual pixel method. - - - - - &reftitle.parameters; - - - - method - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/setimagewhitepoint.xml b/reference/imagick/imagick/setimagewhitepoint.xml deleted file mode 100644 index 51115d6109db..000000000000 --- a/reference/imagick/imagick/setimagewhitepoint.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - Imagick::setImageWhitePoint - Sets the image chromaticity white point - - - - &reftitle.description; - - public boolImagick::setImageWhitePoint - floatx - floaty - - - Sets the image chromaticity white point. - - - - - &reftitle.parameters; - - - - x - - - - - - - y - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setinterlacescheme.xml b/reference/imagick/imagick/setinterlacescheme.xml deleted file mode 100644 index 50a1149dd36d..000000000000 --- a/reference/imagick/imagick/setinterlacescheme.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - Imagick::setInterlaceScheme - Sets the image compression - - - - &reftitle.description; - - public boolImagick::setInterlaceScheme - intinterlace_scheme - - - Sets the image compression. - - - - - &reftitle.parameters; - - - - interlace_scheme - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/setiteratorindex.xml b/reference/imagick/imagick/setiteratorindex.xml deleted file mode 100644 index af214d61b15c..000000000000 --- a/reference/imagick/imagick/setiteratorindex.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - Imagick::setIteratorIndex - Set the iterator position - - - - &reftitle.description; - - public boolImagick::setIteratorIndex - intindex - - - - Set the iterator to the position in the image list specified with the index parameter. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - - - - index - - - The position to set the iterator to - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Using <function>Imagick::setIteratorIndex</function>: - - Create images, set and get the iterator index - - -newImage(100, 100, new ImagickPixel("red")); -$im->newImage(100, 100, new ImagickPixel("green")); -$im->newImage(100, 100, new ImagickPixel("blue")); - -$im->setIteratorIndex(1); -echo $im->getIteratorIndex(); -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::getIteratorIndex - Imagick::getImageIndex - Imagick::setImageIndex - - - - - - - diff --git a/reference/imagick/imagick/setlastiterator.xml b/reference/imagick/imagick/setlastiterator.xml deleted file mode 100644 index a465b5ea0a61..000000000000 --- a/reference/imagick/imagick/setlastiterator.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - Imagick::setLastIterator - Sets the Imagick iterator to the last image - - - - &reftitle.description; - - public boolImagick::setLastIterator - - - - Sets the Imagick iterator to the last image. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/setoption.xml b/reference/imagick/imagick/setoption.xml deleted file mode 100644 index 458d482a4639..000000000000 --- a/reference/imagick/imagick/setoption.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - Imagick::setOption - Set an option - - - - &reftitle.description; - - public boolImagick::setOption - stringkey - stringvalue - - - Associates one or more options with the wand. - - - - - &reftitle.parameters; - - - - key - - - - - - - value - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - Attempt to reach '$extent' size<function>Imagick::setOption</function> - - control->getImagePath(); - $imagick = new \Imagick(realpath($imagePath)); - $imagick->setImageFormat('jpg'); - $imagick->setOption('jpeg:extent', $extent); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); - } - -?> -]]> - - - - - <function>Imagick::setOption</function> - - setImageFormat('png'); - $imagick->setOption('png:format', $format); - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); - } - - //Save as 64bit PNG. - renderPNG($imagePath, 'png64'); - -?> -]]> - - - - - <function>Imagick::setOption</function> - - control->getImagePath(); - $imagick = new \Imagick(realpath($imagePath)); - $imagick->setImageFormat('png'); - - $imagick->setOption('png:bit-depth', '16'); - $imagick->setOption('png:color-type', 6); - header("Content-Type: image/png"); - $crash = true; - if ($crash) { - echo $imagick->getImageBlob(); - } - else { - $tempFilename = tempnam('./', 'imagick'); - $imagick->writeimage(realpath($tempFilename)); - echo file_get_contents($tempFilename); - } - } - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/setpage.xml b/reference/imagick/imagick/setpage.xml deleted file mode 100644 index 25f31d4f7d85..000000000000 --- a/reference/imagick/imagick/setpage.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - Imagick::setPage - Sets the page geometry of the Imagick object - - - - &reftitle.description; - - public boolImagick::setPage - intwidth - intheight - intx - inty - - - Sets the page geometry of the Imagick object. - - - - - &reftitle.parameters; - - - - width - - - - - - - height - - - - - - - x - - - - - - - y - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/setpointsize.xml b/reference/imagick/imagick/setpointsize.xml deleted file mode 100644 index 962699d3c22a..000000000000 --- a/reference/imagick/imagick/setpointsize.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - Imagick::setPointSize - Sets point size - - - - &reftitle.description; - - public boolImagick::setPointSize - floatpoint_size - - - Sets object's point size property. This method can be used for example to set font size for - caption: pseudo-format. - &imagick.method.available.0x637; - - - - - &reftitle.parameters; - - - - point_size - - - Point size - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - A <function>Imagick::setPointSize</function> example - - Example of using Imagick::setPointSize - - -setFont("example.ttf"); - -/* Set the point size */ -$im->setPointSize(12); - -/* Create new caption */ -$im->newPseudoImage(100, 100, "caption:Hello"); - -/* Do something with the image */ -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::getPointSize - - - - - - - diff --git a/reference/imagick/imagick/setprogressmonitor.xml b/reference/imagick/imagick/setprogressmonitor.xml deleted file mode 100644 index 071940cca2ac..000000000000 --- a/reference/imagick/imagick/setprogressmonitor.xml +++ /dev/null @@ -1,144 +0,0 @@ - - - - - - Imagick::setProgressMonitor - Set a callback to be called during processing - - - - &reftitle.description; - - public boolImagick::setProgressMonitor - callablecallback - - - Set a callback that will be called during the processing of the Imagick image. - - - - - - - - &reftitle.parameters; - - - callback - - - The progress function to call. It should return true if image processing should continue, or false if it should be cancelled. The offset parameter indicates the progress and the span parameter indicates the total amount of work needed to be done. - - - - bool - - callback - - - mixedoffset - - - mixed - span - - - - - - The values passed to the callback function are not consistent. In particular the span parameter can increase during image processing. Because of this calculating the percentage complete of an image operation is not trivial. - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - - &reftitle.examples; - - - <function>Imagick::setProgressMonitor</function> - - control->getImagePath())); - $startTime = time(); - - $callback = function ($offset, $span) use ($startTime, &$abortReason) { - if (((100 * $offset) / $span) > 20) { - $abortReason = "Processing reached 20%"; - return false; - } - - $nowTime = time(); - - if ($nowTime - $startTime > 5) { - $abortReason = "Image processing took more than 5 seconds"; - return false; - } - if (($offset % 5) == 0) { - echo "Progress: $offset / $span
    "; - } - return true; - }; - - $imagick->setProgressMonitor($callback); - - $imagick->waveImage(2, 15); - - echo "Data len is: ".strlen($imagick->getImageBlob()); - } - catch(\ImagickException $e) { - if ($abortReason != null) { - echo "Image processing was aborted: ".$abortReason."
    "; - } - else { - echo "ImagickException caught: ".$e->getMessage()." Exception type is ".get_class($e); - } - } - -?> -]]> -
    -
    -
    -
    - -
    - - diff --git a/reference/imagick/imagick/setregistry.xml b/reference/imagick/imagick/setregistry.xml deleted file mode 100644 index 9359bdd4876f..000000000000 --- a/reference/imagick/imagick/setregistry.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - Imagick::setRegistry - Sets the ImageMagick registry entry named key to value - - - - &reftitle.description; - - public static boolImagick::setRegistry - stringkey - stringvalue - - - Sets the ImageMagick registry entry named key to value. This is most - useful for setting "temporary-path" which controls where ImageMagick - creates temporary images e.g. while processing PDFs. - - - - - - &reftitle.parameters; - - - key - - - - - - - - value - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - diff --git a/reference/imagick/imagick/setresolution.xml b/reference/imagick/imagick/setresolution.xml deleted file mode 100644 index 1695a465af1c..000000000000 --- a/reference/imagick/imagick/setresolution.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - Imagick::setResolution - Sets the image resolution - - - - &reftitle.description; - - public boolImagick::setResolution - floatx_resolution - floaty_resolution - - - Sets the image resolution. - - - - - &reftitle.parameters; - - - - x_resolution - - - The horizontal resolution. - - - - - y_resolution - - - The vertical resolution. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.notes; - - Imagick::setResolution must be called before - loading or creating an image. - - - - - &reftitle.seealso; - - Imagick::setImageResolution - Imagick::getImageResolution - - - - - - - diff --git a/reference/imagick/imagick/setresourcelimit.xml b/reference/imagick/imagick/setresourcelimit.xml deleted file mode 100644 index 1732b3bbc300..000000000000 --- a/reference/imagick/imagick/setresourcelimit.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - Imagick::setResourceLimit - Sets the limit for a particular resource - - - - &reftitle.description; - - public static boolImagick::setResourceLimit - inttype - intlimit - - - This method is used to modify the resource limits of the underlying ImageMagick - library. - - - - - &reftitle.parameters; - - - - type - - - Refer to the list of resourcetype constants. - - - - - limit - - - One of the resourcetype constants. - The unit depends on the type of the resource being limited. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.seealso; - - Imagick::getResourceLimit - - - - - - diff --git a/reference/imagick/imagick/setsamplingfactors.xml b/reference/imagick/imagick/setsamplingfactors.xml deleted file mode 100644 index 2a3685e4cc69..000000000000 --- a/reference/imagick/imagick/setsamplingfactors.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - Imagick::setSamplingFactors - Sets the image sampling factors - - - - &reftitle.description; - - public boolImagick::setSamplingFactors - arrayfactors - - - Sets the image sampling factors. - - - - - &reftitle.parameters; - - - - factors - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>Imagick::setSamplingFactors</function> - - setImageFormat('jpg'); - $imagick->setSamplingFactors(array('2x2', '1x1', '1x1')); - - $compressed = $imagick->getImageBlob(); - - - $reopen = new \Imagick(); - $reopen->readImageBlob($compressed); - - $reopen->resizeImage( - $reopen->getImageWidth() * 4, - $reopen->getImageHeight() * 4, - \Imagick::FILTER_POINT, - 1 - ); - - header("Content-Type: image/jpg"); - echo $reopen->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/setsize.xml b/reference/imagick/imagick/setsize.xml deleted file mode 100644 index 1eda83637c16..000000000000 --- a/reference/imagick/imagick/setsize.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - Imagick::setSize - Sets the size of the Imagick object - - - - &reftitle.description; - - public boolImagick::setSize - intcolumns - introws - - - Sets the size of the Imagick object. Set it before you read a raw image - format such as RGB, GRAY, or CMYK. - - - - - &reftitle.parameters; - - - - columns - - - - - - - rows - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/setsizeoffset.xml b/reference/imagick/imagick/setsizeoffset.xml deleted file mode 100644 index e071abd1d522..000000000000 --- a/reference/imagick/imagick/setsizeoffset.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - Imagick::setSizeOffset - Sets the size and offset of the Imagick object - - - - &reftitle.description; - - public boolImagick::setSizeOffset - intcolumns - introws - intoffset - - - Sets the size and offset of the Imagick object. Set it before you read a - raw image format such as RGB, GRAY, or CMYK. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - - - - columns - - - The width in pixels. - - - - - rows - - - The height in pixels. - - - - - offset - - - The image offset. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/settype.xml b/reference/imagick/imagick/settype.xml deleted file mode 100644 index 9ae3e92d0870..000000000000 --- a/reference/imagick/imagick/settype.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - Imagick::setType - Sets the image type attribute - - - - &reftitle.description; - - public boolImagick::setType - intimage_type - - - Sets the image type applied to images written subsequently. - To convert the current image instead, use - Imagick::setImageType. - - - - - &reftitle.parameters; - - - image_type - - - One of the - imagick::IMGTYPE_* - constants. - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/shadeimage.xml b/reference/imagick/imagick/shadeimage.xml deleted file mode 100644 index 7e8edf7b66ca..000000000000 --- a/reference/imagick/imagick/shadeimage.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - Imagick::shadeImage - Creates a 3D effect - - - - &reftitle.description; - - public boolImagick::shadeImage - boolgray - floatazimuth - floatelevation - - - - Shines a distant light on an image to create a three-dimensional effect. - You control the positioning of the light with azimuth and elevation; - azimuth is measured in degrees off the x axis and elevation is measured - in pixels above the Z axis. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - - - - gray - - - A value other than zero shades the intensity of each pixel. - - - - - azimuth - - - Defines the light source direction. - - - - - elevation - - - Defines the light source direction. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - Throws ImagickException on failure. - - - - - - - &reftitle.examples; - - - <function>Imagick::shadeImage</function> - - shadeImage(true, 45, 20); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/shadowimage.xml b/reference/imagick/imagick/shadowimage.xml deleted file mode 100644 index db62847e0bf7..000000000000 --- a/reference/imagick/imagick/shadowimage.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - Imagick::shadowImage - Simulates an image shadow - - - - &reftitle.description; - - public boolImagick::shadowImage - floatopacity - floatsigma - intx - inty - - - Simulates an image shadow. - - - - - &reftitle.parameters; - - - - opacity - - - - - - - sigma - - - - - - - x - - - - - - - y - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>Imagick::shadowImage</function> - - shadowImage(0.4, 10, 50, 5); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/sharpenimage.xml b/reference/imagick/imagick/sharpenimage.xml deleted file mode 100644 index c7180f3a4165..000000000000 --- a/reference/imagick/imagick/sharpenimage.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - Imagick::sharpenImage - Sharpens an image - - - - &reftitle.description; - - public boolImagick::sharpenImage - floatradius - floatsigma - intchannelImagick::CHANNEL_DEFAULT - - - Sharpens an image. We convolve the image with a Gaussian operator - of the given radius and standard deviation (sigma). For reasonable - results, the radius should be larger than sigma. Use a radius of - 0 and Imagick::sharpenImage selects a suitable radius - for you. - - - - - &reftitle.parameters; - - - - radius - - - - - - - sigma - - - - - - - channel - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>Imagick::sharpenImage</function> - - sharpenimage($radius, $sigma, $channel); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/shaveimage.xml b/reference/imagick/imagick/shaveimage.xml deleted file mode 100644 index d73be12635b6..000000000000 --- a/reference/imagick/imagick/shaveimage.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - Imagick::shaveImage - Shaves pixels from the image edges - - - - &reftitle.description; - - public boolImagick::shaveImage - intcolumns - introws - - - Shaves pixels from the image edges. It allocates the memory necessary for - the new Image structure and returns a pointer to the new image. - - - - - &reftitle.parameters; - - - - columns - - - - - - - rows - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>Imagick::shaveImage</function> - - shaveImage(100, 50); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/shearimage.xml b/reference/imagick/imagick/shearimage.xml deleted file mode 100644 index 4a4a01136b8d..000000000000 --- a/reference/imagick/imagick/shearimage.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - Imagick::shearImage - Creating a parallelogram - - - - &reftitle.description; - - public boolImagick::shearImage - mixedbackground - floatx_shear - floaty_shear - - - Slides one edge of an image along the X or Y axis, creating a parallelogram. - An X direction shear slides an edge along the X axis, while a Y direction - shear slides an edge along the Y axis. The amount of the shear is controlled - by a shear angle. For X direction shears, x_shear is measured relative to - the Y axis, and similarly, for Y direction shears y_shear is measured - relative to the X axis. Empty triangles left over from shearing the image - are filled with the background color. - - - - - &reftitle.parameters; - - - - background - - - The background color - - - - - x_shear - - - The number of degrees to shear on the x axis - - - - - y_shear - - - The number of degrees to shear on the y axis - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Now allows a string representing the color as the first parameter. - Previous versions allow only an ImagickPixel object. - - - - - - - - - - - - &reftitle.examples; - - - <function>Imagick::shearImage</function> - - shearimage($color, $shearX, $shearY); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/sigmoidalcontrastimage.xml b/reference/imagick/imagick/sigmoidalcontrastimage.xml deleted file mode 100644 index 52c774b97817..000000000000 --- a/reference/imagick/imagick/sigmoidalcontrastimage.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - Imagick::sigmoidalContrastImage - Adjusts the contrast of an image - - - - &reftitle.description; - - public boolImagick::sigmoidalContrastImage - boolsharpen - floatalpha - floatbeta - intchannelImagick::CHANNEL_DEFAULT - - - Adjusts the contrast of an image with a non-linear sigmoidal contrast - algorithm. Increase the contrast of the image using a sigmoidal transfer - function without saturating highlights or shadows. alpha indicates - how much to increase the contrast: 0.00 is none; 3.00 is - typical; 20.00 is pushing it. - beta indicates where midtones fall in the resultant - image, as a fraction of the quantum range: 0.0 is white, - 0.5 is middle-gray, 1.0 is black - (multiply by getQuantumRange()['quantumRangeLong'] to get the value to - pass). - - - See also ImageMagick - Examples -- Color Modifications — Sigmoidal Non-linearity Contrast. - - - - - &reftitle.parameters; - - - - sharpen - - - If &true; increase the contrast, if &false; decrease the contrast. - - - - - alpha - - - The amount of contrast to apply. 1.00 is very little, 5.00 - is a significant amount, 20.00 is extreme. - - - - - beta - - - Where the midpoint of the gradient will be. This value should be in the range 0.00 - to 1.00 - multiplied by the quantum value for ImageMagick. - - - - - channel - - - Which color channels the contrast will be applied to. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Create a gradient image using <function>Imagick::sigmoidalContrastImage</function> - suitable for blending two images together smoothly, with the blending - defined by <parameter>alpha</parameter> and <parameter>beta</parameter> - - -newPseudoImage($width, $height, 'gradient:black-white'); - $quanta = $imagick->getQuantumRange(); - $imagick->sigmoidalContrastImage(true, $alpha, $beta * $quanta["quantumRangeLong"]); - - return $imagick; -} -]]> - - - - - - - diff --git a/reference/imagick/imagick/sketchimage.xml b/reference/imagick/imagick/sketchimage.xml deleted file mode 100644 index 5436470e9111..000000000000 --- a/reference/imagick/imagick/sketchimage.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - Imagick::sketchImage - Simulates a pencil sketch - - - - &reftitle.description; - - public boolImagick::sketchImage - floatradius - floatsigma - floatangle - - - - Simulates a pencil sketch. We convolve the image with a Gaussian operator - of the given radius and standard deviation (sigma). For reasonable - results, radius should be larger than sigma. Use a radius of 0 and - Imagick::sketchImage() selects a suitable radius for you. Angle gives the - angle of the blurring motion. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - - - - radius - - - The radius of the Gaussian, in pixels, not counting the center pixel - - - - - sigma - - - The standard deviation of the Gaussian, in pixels. - - - - - angle - - - Apply the effect along this angle. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>Imagick::sketchImage</function> - - sketchimage($radius, $sigma, $angle); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/smushimages.xml b/reference/imagick/imagick/smushimages.xml deleted file mode 100644 index d8cda5e41c25..000000000000 --- a/reference/imagick/imagick/smushimages.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Imagick::smushImages - Takes all images from the current image pointer to the end of the image list and smushs them - - - - &reftitle.description; - - public ImagickImagick::smushImages - boolstack - intoffset - - - Takes all images from the current image pointer to the end of the image list and smushs - them to each other top-to-bottom if the stack parameter is true, otherwise left-to-right. - - - - - - &reftitle.parameters; - - - stack - - - - - - - - offset - - - - - - - - - - - &reftitle.returnvalues; - - The new smushed image. - - - - - - - - &reftitle.examples; - - - <function>Imagick::smushImages</function> - - addimage($imagick2); - $smushed = $imagick->smushImages(false, 50); - $smushed->setImageFormat('jpg'); - header("Content-Type: image/jpg"); - echo $smushed->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/solarizeimage.xml b/reference/imagick/imagick/solarizeimage.xml deleted file mode 100644 index 127cae4ef0c0..000000000000 --- a/reference/imagick/imagick/solarizeimage.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - Imagick::solarizeImage - Applies a solarizing effect to the image - - - - &reftitle.description; - - public boolImagick::solarizeImage - intthreshold - - - Applies a special effect to the image, similar to the effect achieved in - a photo darkroom by selectively exposing areas of photo sensitive paper - to light. Threshold ranges from 0 to QuantumRange and is a measure of the - extent of the solarization. - - - - - &reftitle.parameters; - - - - threshold - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>Imagick::solarizeImage</function> - - solarizeImage($solarizeThreshold * \Imagick::getQuantum()); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/sparsecolorimage.xml b/reference/imagick/imagick/sparsecolorimage.xml deleted file mode 100644 index d25ed73f9c59..000000000000 --- a/reference/imagick/imagick/sparsecolorimage.xml +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - Imagick::sparseColorImage - Interpolates colors - - - - &reftitle.description; - - public boolImagick::sparseColorImage - intSPARSE_METHOD - arrayarguments - intchannelImagick::CHANNEL_DEFAULT - - - Given the arguments array containing numeric values this method interpolates - the colors found at those coordinates across the whole image using sparse_method. - &imagick.method.available.0x645; - - - - - &reftitle.parameters; - - - - SPARSE_METHOD - - - Refer to this list of sparse method constants - - - - - arguments - - - An array containing the coordinates. - The array is in format array(1,1, 2,45) - - - - - channel - - - &imagick.parameter.channel; - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - - &reftitle.examples; - - - SPARSECOLORMETHOD_BARYCENTRIC <function>Imagick::sparseColorImage</function> - - getImageBlob(); - } - -?> -]]> - - - - - SPARSECOLORMETHOD_BILINEAR <function>Imagick::sparseColorImage</function> - - getImageBlob(); - } - -?> -]]> - - - - - SPARSECOLORMETHOD_SPEPARDS <function>Imagick::sparseColorImage</function> - - getImageBlob(); - } - -?> -]]> - - - - - SPARSECOLORMETHOD_VORONOI <function>Imagick::sparseColorImage</function> - - getImageBlob(); - } - -?> -]]> - - - - - SPARSECOLORMETHOD_BARYCENTRIC <function>Imagick::sparseColorImage</function> - - getImageBlob(); - } - -?> -]]> - - - - - createGradientImage is used by other examples. <function>Imagick::sparseColorImage</function> - - newImage($width, $height, "white"); - $imagick->setImageFormat("png"); - - $barycentricPoints = array(); - - foreach ($colorPoints as $colorPoint) { - - if ($absolute == true) { - $barycentricPoints[] = $colorPoint[0]; - $barycentricPoints[] = $colorPoint[1]; - } - else { - $barycentricPoints[] = $colorPoint[0] * $width; - $barycentricPoints[] = $colorPoint[1] * $height; - } - - if (is_string($colorPoint[2])) { - $imagickPixel = new \ImagickPixel($colorPoint[2]); - } - else if ($colorPoint[2] instanceof \ImagickPixel) { - $imagickPixel = $colorPoint[2]; - } - else{ - $errorMessage = sprintf( - "Value %s is neither a string nor an ImagickPixel class. Cannot use as a color.", - $colorPoint[2] - ); - - throw new \InvalidArgumentException( - $errorMessage - ); - } - - $red = $imagickPixel->getColorValue(\Imagick::COLOR_RED); - $green = $imagickPixel->getColorValue(\Imagick::COLOR_GREEN); - $blue = $imagickPixel->getColorValue(\Imagick::COLOR_BLUE); - $alpha = $imagickPixel->getColorValue(\Imagick::COLOR_ALPHA); - - $barycentricPoints[] = $red; - $barycentricPoints[] = $green; - $barycentricPoints[] = $blue; - $barycentricPoints[] = $alpha; - } - - $imagick->sparseColorImage($sparseMethod, $barycentricPoints); - - return $imagick; -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/spliceimage.xml b/reference/imagick/imagick/spliceimage.xml deleted file mode 100644 index 565de3192c88..000000000000 --- a/reference/imagick/imagick/spliceimage.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - Imagick::spliceImage - Splices a solid color into the image - - - - &reftitle.description; - - public boolImagick::spliceImage - intwidth - intheight - intx - inty - - - Splices a solid color into the image. - - - - - &reftitle.parameters; - - - - width - - - - - - - height - - - - - - - x - - - - - - - y - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>Imagick::spliceImage</function> - - spliceImage($width, $height, $startX, $startY); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/spreadimage.xml b/reference/imagick/imagick/spreadimage.xml deleted file mode 100644 index f6733148185b..000000000000 --- a/reference/imagick/imagick/spreadimage.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - Imagick::spreadImage - Randomly displaces each pixel in a block - - - - &reftitle.description; - - public boolImagick::spreadImage - floatradius - - - Special effects method that randomly displaces each pixel in a block - defined by the radius parameter. - - - - - &reftitle.parameters; - - - - radius - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::spreadImage</function> - - spreadImage($radius); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/statisticimage.xml b/reference/imagick/imagick/statisticimage.xml deleted file mode 100644 index ac8312b53f9e..000000000000 --- a/reference/imagick/imagick/statisticimage.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - Imagick::statisticImage - Modifies image using a statistics function - - - - &reftitle.description; - - public boolImagick::statisticImage - inttype - intwidth - intheight - intchannelImagick::CHANNEL_DEFAULT - - - Replace each pixel with corresponding statistic from the neighborhood of the specified width and height. - - - - - - &reftitle.parameters; - - - type - - - - - - - - width - - - - - - - - height - - - - - - - - channel - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - - &reftitle.examples; - - - <function>Imagick::statisticImage</function> - - statisticImage( - $statisticType, - $width, - $height, - $channel - ); - - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -statisticImage($imagePath, \Imagick::STATISTIC_MEDIAN, 5, 5, \Imagick::CHANNEL_DEFAULT); - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/steganoimage.xml b/reference/imagick/imagick/steganoimage.xml deleted file mode 100644 index 35adaa9fcd31..000000000000 --- a/reference/imagick/imagick/steganoimage.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - Imagick::steganoImage - Hides a digital watermark within the image - - - - &reftitle.description; - - public ImagickImagick::steganoImage - Imagickwatermark_wand - intoffset - - - Hides a digital watermark within the image. Recover the hidden watermark - later to prove that the authenticity of an image. Offset defines the start - position within the image to hide the watermark. - - - - - &reftitle.parameters; - - - - watermark_wand - - - - - - - offset - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/stereoimage.xml b/reference/imagick/imagick/stereoimage.xml deleted file mode 100644 index 48817f7b0fd7..000000000000 --- a/reference/imagick/imagick/stereoimage.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - Imagick::stereoImage - Composites two images - - - - &reftitle.description; - - public boolImagick::stereoImage - Imagickoffset_wand - - - Composites two images and produces a single image that is the composite - of a left and right image of a stereo pair. - - - - - &reftitle.parameters; - - - - offset_wand - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/stripimage.xml b/reference/imagick/imagick/stripimage.xml deleted file mode 100644 index 4c2f34d9b648..000000000000 --- a/reference/imagick/imagick/stripimage.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - Imagick::stripImage - Strips an image of all profiles and comments - - - - &reftitle.description; - - public boolImagick::stripImage - - - - Strips an image of all profiles and comments. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/subimagematch.xml b/reference/imagick/imagick/subimagematch.xml deleted file mode 100644 index 460fb0c49e1a..000000000000 --- a/reference/imagick/imagick/subimagematch.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - Imagick::subImageMatch - Searches for a subimage in the current image and returns a similarity image - - - - &reftitle.description; - - public ImagickImagick::subImageMatch - ImagickImagick - arrayoffset - floatsimilarity - - - Searches for a subimage in the current image and returns a similarity image such that an exact match location is completely white and if none of the pixels match, black, otherwise some gray level in-between. - You can also pass in the optional parameters bestMatch and similarity. After calling the function similarity will be set to the 'score' of the similarity between the subimage and the matching position in the larger image, bestMatch will contain an associative array with elements x, y, width, height that describe the matching region. - - - - - - - &reftitle.parameters; - - - Imagick - - - - - - - - offset - - - - - - - - similarity - - - A new image that displays the amount of similarity at each pixel. - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - &reftitle.examples; - - - <function>Imagick::subImageMatch</function> - - cropimage(40, 40, 250, 110); - $imagick2->vignetteimage(0, 1, 3, 3); - - $similarity = null; - $bestMatch = null; - $comparison = $imagick->subImageMatch($imagick2, $bestMatch, $similarity); - - $comparison->setImageFormat('png'); - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/swirlimage.xml b/reference/imagick/imagick/swirlimage.xml deleted file mode 100644 index e91eaa8f83d3..000000000000 --- a/reference/imagick/imagick/swirlimage.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - Imagick::swirlImage - Swirls the pixels about the center of the image - - - - &reftitle.description; - - - boolImagick::swirlImage - floatdegrees - - - Swirls the pixels about the center of the image, where degrees indicates - the sweep of the arc through which each pixel is moved. You get a more - dramatic effect as the degrees move from 1 to 360. - - - - - &reftitle.parameters; - - - - degrees - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::swirlImage</function> - - swirlImage($swirl); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/textureimage.xml b/reference/imagick/imagick/textureimage.xml deleted file mode 100644 index a942e652b742..000000000000 --- a/reference/imagick/imagick/textureimage.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - Imagick::textureImage - Repeatedly tiles the texture image - - - - &reftitle.description; - - - ImagickImagick::textureImage - Imagicktexture_wand - - - Repeatedly tiles the texture image across and down the image canvas. - - - - - &reftitle.parameters; - - - - texture_wand - - - Imagick object to use as texture image - - - - - - - - - &reftitle.returnvalues; - - Returns a new Imagick object that has the repeated texture applied. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::textureImage</function> - - newImage(640, 480, new \ImagickPixel('pink')); - $image->setImageFormat("jpg"); - $texture = new \Imagick(realpath($imagePath)); - $texture->scaleimage($image->getimagewidth() / 4, $image->getimageheight() / 4); - $image = $image->textureImage($texture); - header("Content-Type: image/jpg"); - echo $image; -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/thresholdimage.xml b/reference/imagick/imagick/thresholdimage.xml deleted file mode 100644 index 1de2afd2aa90..000000000000 --- a/reference/imagick/imagick/thresholdimage.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - Imagick::thresholdImage - Changes the value of individual pixels based on a threshold - - - - &reftitle.description; - - public boolImagick::thresholdImage - floatthreshold - intchannelImagick::CHANNEL_DEFAULT - - - Changes the value of individual pixels based on the intensity of each pixel - compared to threshold. The result is a high-contrast, two color image. - - - - - &reftitle.parameters; - - - - threshold - - - - - - - channel - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>Imagick::thresholdImage</function> - - thresholdimage($threshold * \Imagick::getQuantum(), $channel); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/thumbnailimage.xml b/reference/imagick/imagick/thumbnailimage.xml deleted file mode 100644 index 9e800de383d7..000000000000 --- a/reference/imagick/imagick/thumbnailimage.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - Imagick::thumbnailImage - Changes the size of an image - - - - &reftitle.description; - - public boolImagick::thumbnailImage - intcolumns - introws - boolbestfit&false; - boolfill&false; - boollegacy&false; - - - Changes the size of an image to the given dimensions and removes any - associated profiles. The goal is to produce small, low cost thumbnail - images suited for display on the Web. - - If &true; is given as a third parameter then columns and rows parameters - are used as maximums for each side. Both sides will be scaled down until - they match or are smaller than the parameter given for the side. - - &imagick.bestfit.note; - - - - &reftitle.parameters; - - - - columns - - - Image width - - - - - rows - - - Image height - - - - - bestfit - - - Whether to force maximum values - - - - - fill - - - If the image does not fill the box completely then the box is filled with - image's background color. - - - - - legacy - - - Round the smaller dimension down instead to the closest integer. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::thumbnailImage</function> - - setbackgroundcolor('rgb(64, 64, 64)'); - $imagick->thumbnailImage(100, 100, true, true); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/tintimage.xml b/reference/imagick/imagick/tintimage.xml deleted file mode 100644 index 3a597b6ae944..000000000000 --- a/reference/imagick/imagick/tintimage.xml +++ /dev/null @@ -1,138 +0,0 @@ - - - - - Imagick::tintImage - Applies a color vector to each pixel in the image - - - - &reftitle.description; - - public boolImagick::tintImage - mixedtint - mixedopacity - boollegacy&false; - - - Applies a color vector to each pixel in the image. The length of the vector - is 0 for black and white and at its maximum for the midtones. The vector - weighing function is f(x)=(1-(4.0*((x-0.5)*(x-0.5)))). - - - - - &reftitle.parameters; - - - - tint - - - - - - - opacity - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Now allows a string representing the color as the first parameter and - a float representing the opacity value as the second parameter. - Previous versions allow only an ImagickPixel objects. - - - - - - - - - - - - &reftitle.examples; - - - <function>Imagick::tintImage</function> - - newPseudoImage(400, 400, 'gradient:black-white'); - - $tint = new \ImagickPixel("rgb($r, $g, $b)"); - $opacity = new \ImagickPixel("rgb(128, 128, 128, $a)"); - $imagick->tintImage($tint, $opacity); - $imagick->setImageFormat('png'); - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/toString.xml b/reference/imagick/imagick/toString.xml deleted file mode 100644 index 74f0b2e75257..000000000000 --- a/reference/imagick/imagick/toString.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - Imagick::__toString - Returns the image as a string - - - - &reftitle.description; - - public stringImagick::__toString - - - - Returns the current image as string. This will only return a single image; it should not be used for Imagick objects that contain multiple images e.g. an animated GIF or PDF with multiple pages. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the string content on success or an empty string on failure. - - - - - - &reftitle.seealso; - - Imagick::getImageBlob - Imagick::getImagesBlob - - - - - - diff --git a/reference/imagick/imagick/transformimage.xml b/reference/imagick/imagick/transformimage.xml deleted file mode 100644 index 00a4b8522d94..000000000000 --- a/reference/imagick/imagick/transformimage.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - Imagick::transformImage - Convenience method for setting crop size and the image geometry - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public ImagickImagick::transformImage - stringcrop - stringgeometry - - - - A convenience method for setting crop size and the image geometry from strings. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - - - - crop - - - A crop geometry string. This geometry defines a subregion of the image to crop. - - - - - geometry - - - An image geometry string. This geometry defines the final size of the image. - - - - - - - - - &reftitle.returnvalues; - - Returns an Imagick object containing the transformed image. - - - - - &reftitle.examples; - - - Using <function>Imagick::transformImage</function>: - - The example creates a 100x100 black image. - - -newImage(300, 200, "black"); -$new_image = $image->transformImage("100x100", "100x100"); -$new_image->writeImage('test_out.jpg'); -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::cropImage - Imagick::resizeImage - Imagick::thumbnailImage - - - - - - - diff --git a/reference/imagick/imagick/transformimagecolorspace.xml b/reference/imagick/imagick/transformimagecolorspace.xml deleted file mode 100644 index 299b951df06b..000000000000 --- a/reference/imagick/imagick/transformimagecolorspace.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - Imagick::transformImageColorspace - - Transforms an image to a new colorspace - - - - &reftitle.description; - - - public boolImagick::transformImageColorspace - intcolorspace - - - Transforms an image to a new colorspace. - - - - - &reftitle.parameters; - - - colorspace - - - The colorspace the image should be transformed to, one of the COLORSPACE constants e.g. Imagick::COLORSPACE_CMYK. - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - <methodname>Imagick::transformImageColorspace</methodname> example - - Transforms an image to a new colorspace, and then extracts a single channel so that the individual channel values can be viewed. - - - -transformimagecolorspace($colorSpace); - //channel should be one of the channel constants e.g. \Imagick::CHANNEL_BLUE - $imagick->separateImageChannel($channel); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} -?> -]]> - - - - - - - - &reftitle.seealso; - - Imagick::setColorSpace - - - - - - diff --git a/reference/imagick/imagick/transparentpaintimage.xml b/reference/imagick/imagick/transparentpaintimage.xml deleted file mode 100644 index 138f1dba032c..000000000000 --- a/reference/imagick/imagick/transparentpaintimage.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - Imagick::transparentPaintImage - Paints pixels transparent - - - - &reftitle.description; - - public boolImagick::transparentPaintImage - mixedtarget - floatalpha - floatfuzz - boolinvert - - - - Paints pixels matching the target color transparent. - &imagick.method.available.0x638; - - - - - &reftitle.parameters; - - - - target - - - The target color to paint - - - - - alpha - - - &imagick.parameter.alpha; - - - - - fuzz - - - &imagick.parameter.fuzz; - - - - - invert - - - If &true; paints any pixel that does not match the target color. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>Imagick::transparentPaintImage</function> - - setimageformat('png'); - - $imagick->transparentPaintImage( - $color, $alpha, $fuzz * \Imagick::getQuantum(), false - ); - - //Not required, but helps tidy up left over pixels - $imagick->despeckleimage(); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/transposeimage.xml b/reference/imagick/imagick/transposeimage.xml deleted file mode 100644 index 748a6d954e35..000000000000 --- a/reference/imagick/imagick/transposeimage.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - Imagick::transposeImage - Creates a vertical mirror image - - - - &reftitle.description; - - public boolImagick::transposeImage - - - - - Creates a vertical mirror image by reflecting the pixels - around the central x-axis while rotating them 90-degrees. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - <function>Imagick::transposeImage</function> - - transposeImage(); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::transverseImage - - - - - - - diff --git a/reference/imagick/imagick/transverseimage.xml b/reference/imagick/imagick/transverseimage.xml deleted file mode 100644 index bee828e0bd7a..000000000000 --- a/reference/imagick/imagick/transverseimage.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - Imagick::transverseImage - Creates a horizontal mirror image - - - - &reftitle.description; - - public boolImagick::transverseImage - - - - - Creates a horizontal mirror image by reflecting the pixels around the - central y-axis while rotating them 270-degrees. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - <function>Imagick::transverseImage</function> - - transverseImage(); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::transposeImage - - - - - - - diff --git a/reference/imagick/imagick/trimimage.xml b/reference/imagick/imagick/trimimage.xml deleted file mode 100644 index 94efd9752488..000000000000 --- a/reference/imagick/imagick/trimimage.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - Imagick::trimImage - Remove edges from the image - - - - &reftitle.description; - - public boolImagick::trimImage - floatfuzz - - - - Remove edges that are the background color from the image. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - - - - fuzz - - - By default target must match a particular pixel color exactly. - However, in many cases two colors may differ by a small amount. - The fuzz member of image defines how much tolerance is acceptable - to consider two colors as the same. This parameter represents the variation - on the quantum range. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Using <function>Imagick::trimImage</function>: - - Trim an image, then display to the browser. - - -trimImage(0); - -/* Output the image */ -header("Content-Type: image/" . $im->getImageFormat()); -echo $im; -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::getQuantumDepth - Imagick::getQuantumRange - imagecropauto - - - - - - - diff --git a/reference/imagick/imagick/uniqueimagecolors.xml b/reference/imagick/imagick/uniqueimagecolors.xml deleted file mode 100644 index 98faf6bd1e39..000000000000 --- a/reference/imagick/imagick/uniqueimagecolors.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - Imagick::uniqueImageColors - Discards all but one of any pixel color - - - - &reftitle.description; - - public boolImagick::uniqueImageColors - - - - - Discards all but one of any pixel color. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>Imagick::uniqueImageColors</function> - - quantizeImage(256, \Imagick::COLORSPACE_YIQ, 0, false, false); - $imagick->uniqueImageColors(); - $imagick->scaleimage($imagick->getImageWidth(), $imagick->getImageHeight() * 20); - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/unsharpmaskimage.xml b/reference/imagick/imagick/unsharpmaskimage.xml deleted file mode 100644 index 42ce66a4e83c..000000000000 --- a/reference/imagick/imagick/unsharpmaskimage.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - Imagick::unsharpMaskImage - Sharpens an image - - - - &reftitle.description; - - public boolImagick::unsharpMaskImage - floatradius - floatsigma - floatamount - floatthreshold - intchannelImagick::CHANNEL_DEFAULT - - - Sharpens an image. We convolve the image with a Gaussian operator of the given - radius and standard deviation (sigma). For reasonable results, radius should be - larger than sigma. Use a radius of 0 and Imagick::UnsharpMaskImage() selects a - suitable radius for you. - - - - - &reftitle.parameters; - - - - radius - - - - - - - sigma - - - - - - - amount - - - - - - - threshold - - - - - - - channel - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::unsharpMaskImage</function> - - unsharpMaskImage($radius, $sigma, $amount, $unsharpThreshold); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/valid.xml b/reference/imagick/imagick/valid.xml deleted file mode 100644 index 2a485d6328aa..000000000000 --- a/reference/imagick/imagick/valid.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - Imagick::valid - Checks if the current item is valid - - - - &reftitle.description; - - public boolImagick::valid - - - - Checks if the current item is valid. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/vignetteimage.xml b/reference/imagick/imagick/vignetteimage.xml deleted file mode 100644 index 2ed46a4003b2..000000000000 --- a/reference/imagick/imagick/vignetteimage.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - Imagick::vignetteImage - Adds vignette filter to the image - - - - &reftitle.description; - - public boolImagick::vignetteImage - floatblackPoint - floatwhitePoint - intx - inty - - - - Softens the edges of the image in vignette style. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - - - - blackPoint - - - The black point. - - - - - whitePoint - - - The white point - - - - - x - - - X offset of the ellipse - - - - - y - - - Y offset of the ellipse - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - <function>Imagick::vignetteImage</function> - - vignetteImage($blackPoint, $whitePoint, $x, $y); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::waveImage - Imagick::swirlImage - - - - - - - diff --git a/reference/imagick/imagick/waveimage.xml b/reference/imagick/imagick/waveimage.xml deleted file mode 100644 index 5543a44acc1c..000000000000 --- a/reference/imagick/imagick/waveimage.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - Imagick::waveImage - Applies wave filter to the image - - - - &reftitle.description; - - public boolImagick::waveImage - floatamplitude - floatlength - - - - Applies a wave filter to the image. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - - - - amplitude - - - The amplitude of the wave. - - - - - length - - - The length of the wave. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - WaveImage can be quite slow <function>Imagick::waveImage</function> - - waveImage($amplitude, $length); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::solarizeImage - Imagick::oilpaintImage - Imagick::embossImage - Imagick::addNoiseImage - Imagick::swirlImage - - - - - - - diff --git a/reference/imagick/imagick/whitethresholdimage.xml b/reference/imagick/imagick/whitethresholdimage.xml deleted file mode 100644 index 1e6f6c6f7141..000000000000 --- a/reference/imagick/imagick/whitethresholdimage.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - Imagick::whiteThresholdImage - Force all pixels above the threshold into white - - - - &reftitle.description; - - public boolImagick::whiteThresholdImage - mixedthreshold - - - Is like Imagick::ThresholdImage() but force all pixels above the threshold - into white while leaving all pixels below the threshold unchanged. - - - - - &reftitle.parameters; - - - - threshold - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Now allows a string representing the color as a parameter. - Previous versions allow only an ImagickPixel object. - - - - - - - - - - - - &reftitle.examples; - - - <function>Imagick::whiteThresholdImage</function> - - whiteThresholdImage($color); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/writeimage.xml b/reference/imagick/imagick/writeimage.xml deleted file mode 100644 index 8847e3f6cbd9..000000000000 --- a/reference/imagick/imagick/writeimage.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - Imagick::writeImage - Writes an image to the specified filename - - - - &reftitle.description; - - public boolImagick::writeImage - stringfilenameNULL - - - Writes an image to the specified filename. If the filename parameter is NULL, - the image is written to the filename set by Imagick::readImage() or - Imagick::setImageFilename(). - - - - - &reftitle.parameters; - - - - filename - - - Filename where to write the image. The extension of the filename - defines the type of the file. - Format can be forced regardless of file extension using format: prefix, - for example "jpg:test.png". - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/writeimagefile.xml b/reference/imagick/imagick/writeimagefile.xml deleted file mode 100644 index bd75da4f0b0a..000000000000 --- a/reference/imagick/imagick/writeimagefile.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - Imagick::writeImageFile - Writes an image to a filehandle - - - - &reftitle.description; - - public boolImagick::writeImageFile - resourcefilehandle - stringformat - - - - Writes the image sequence to an open filehandle. The handle must be opened with - for example fopen. &imagick.method.available.0x636; - - - - - &reftitle.parameters; - - - - filehandle - - - Filehandle where to write the image. - - - - - format - - - The image format. - The list of valid format specifiers depends on the compiled feature set of - ImageMagick, and can be queried at runtime via Imagick::queryFormats. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.seealso; - - Imagick::queryFormats - - - - - diff --git a/reference/imagick/imagick/writeimages.xml b/reference/imagick/imagick/writeimages.xml deleted file mode 100644 index ab931e3522a8..000000000000 --- a/reference/imagick/imagick/writeimages.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - Imagick::writeImages - Writes an image or image sequence - - - - &reftitle.description; - - public boolImagick::writeImages - stringfilename - booladjoin - - - Writes an image or image sequence. - - - - - &reftitle.parameters; - - - - filename - - - - - - - adjoin - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/writeimagesfile.xml b/reference/imagick/imagick/writeimagesfile.xml deleted file mode 100644 index 5145f37293d5..000000000000 --- a/reference/imagick/imagick/writeimagesfile.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - Imagick::writeImagesFile - Writes frames to a filehandle - - - - &reftitle.description; - - public boolImagick::writeImagesFile - resourcefilehandle - stringformat - - - - Writes all image frames into an open filehandle. This method can be used to write - animated gifs or other multiframe images into open filehandle. - &imagick.method.available.0x636; - - - - - &reftitle.parameters; - - - - filehandle - - - Filehandle where to write the images. - - - - - format - - - The image format. - The list of valid format specifiers depends on the compiled feature set of - ImageMagick, and can be queried at runtime via Imagick::queryFormats. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.seealso; - - Imagick::queryFormats - - - - - diff --git a/reference/imagick/imagickdraw.xml b/reference/imagick/imagickdraw.xml deleted file mode 100644 index 85350b98bf0f..000000000000 --- a/reference/imagick/imagickdraw.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - The <classname>ImagickDraw</classname> class - ImagickDraw - -
    - &reftitle.classsynopsis; - - ImagickDraw - - ImagickDraw - - - -
    -
    - - &reference.imagick.entities.imagickdraw; -
    - - diff --git a/reference/imagick/imagickdraw/affine.xml b/reference/imagick/imagickdraw/affine.xml deleted file mode 100644 index 459783554bb4..000000000000 --- a/reference/imagick/imagickdraw/affine.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - ImagickDraw::affine - Adjusts the current affine transformation matrix - - - - &reftitle.description; - - public boolImagickDraw::affine - arrayaffine - - &warn.undocumented.func; - - Adjusts the current affine transformation matrix with the specified affine - transformation matrix. - - - - - &reftitle.parameters; - - - - affine - - - Affine matrix parameters - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - &reftitle.examples; - - - <function>ImagickDraw::affine</function> example - - setStrokeWidth(1); - $draw->setStrokeOpacity(1); - $draw->setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - - $draw->setStrokeWidth(2); - - $PI = 3.141592653589794; - $angle = 60 * $PI / 360; - - //Scale the drawing co-ordinates. - $affineScale = array("sx" => 1.75, "sy" => 1.75, "rx" => 0, "ry" => 0, "tx" => 0, "ty" => 0); - - //Shear the drawing co-ordinates. - $affineShear = array("sx" => 1, "sy" => 1, "rx" => sin($angle), "ry" => -sin($angle), "tx" => 0, "ty" => 0); - - //Rotate the drawing co-ordinates. The shear affine matrix - //produces incorrectly scaled drawings. - $affineRotate = array("sx" => cos($angle), "sy" => cos($angle), "rx" => sin($angle), "ry" => -sin($angle), "tx" => 0, "ty" => 0,); - - //Translate (offset) the drawing - $affineTranslate = array("sx" => 1, "sy" => 1, "rx" => 0, "ry" => 0, "tx" => 30, "ty" => 30); - - //The identity affine matrix - $affineIdentity = array("sx" => 1, "sy" => 1, "rx" => 0, "ry" => 0, "tx" => 0, "ty" => 0); - - $examples = [$affineScale, $affineShear, $affineRotate, $affineTranslate, $affineIdentity,]; - - $count = 0; - - foreach ($examples as $example) { - $draw->push(); - $draw->translate(($count % 2) * 250, intval($count / 2) * 250); - $draw->translate(100, 100); - $draw->affine($example); - $draw->rectangle(-50, -50, 50, 50); - $draw->pop(); - $count++; - } - - //Create an image object which the draw commands can be rendered into - $image = new \Imagick(); - $image->newImage(500, 750, $backgroundColor); - $image->setImageFormat("png"); - - //Render the draw commands in the ImagickDraw object - //into the image. - $image->drawImage($draw); - - //Send the image to the browser - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/annotation.xml b/reference/imagick/imagickdraw/annotation.xml deleted file mode 100644 index fb7cceabbd16..000000000000 --- a/reference/imagick/imagickdraw/annotation.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - ImagickDraw::annotation - Draws text on the image - - - - &reftitle.description; - - public boolImagickDraw::annotation - floatx - floaty - stringtext - - &warn.undocumented.func; - - Draws text on the image. - - - - - &reftitle.parameters; - - - - x - - - The x coordinate where text is drawn - - - - - y - - - The y coordinate where text is drawn - - - - - text - - - The text to draw on the image - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/arc.xml b/reference/imagick/imagickdraw/arc.xml deleted file mode 100644 index 09a2c4b0ae5e..000000000000 --- a/reference/imagick/imagickdraw/arc.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - ImagickDraw::arc - Draws an arc - - - - &reftitle.description; - - public boolImagickDraw::arc - floatstart_x - floatstart_y - floatend_x - floatend_y - floatstart_angle - floatend_angle - - &warn.undocumented.func; - - Draws an arc falling within a specified bounding rectangle on the image. - - - - - &reftitle.parameters; - - - - start_x - - - Starting x ordinate of bounding rectangle - - - - - start_y - - - starting y ordinate of bounding rectangle - - - - - end_x - - - ending x ordinate of bounding rectangle - - - - - end_y - - - ending y ordinate of bounding rectangle - - - - - start_angle - - - starting degrees of rotation - - - - - end_angle - - - ending degrees of rotation - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - <function>ImagickDraw::arc</function> example - - setStrokeWidth(1); - $draw->setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(2); - - $draw->arc($startX, $startY, $endX, $endY, $startAngle, $endAngle); - - //Create an image object which the draw commands can be rendered into - $image = new \Imagick(); - $image->newImage(IMAGE_WIDTH, IMAGE_HEIGHT, $backgroundColor); - $image->setImageFormat("png"); - - //Render the draw commands in the ImagickDraw object - //into the image. - $image->drawImage($draw); - - //Send the image to the browser - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/bezier.xml b/reference/imagick/imagickdraw/bezier.xml deleted file mode 100644 index 85731ffabd6d..000000000000 --- a/reference/imagick/imagickdraw/bezier.xml +++ /dev/null @@ -1,147 +0,0 @@ - - - - - ImagickDraw::bezier - Draws a bezier curve - - - - &reftitle.description; - - public boolImagickDraw::bezier - arraycoordinates - - &warn.undocumented.func; - - Draws a bezier curve through a set of points on the image. - - - - - &reftitle.parameters; - - - - coordinates - - - Multidimensional array like array( array( 'x' => 1, 'y' => 2 ), - array( 'x' => 3, 'y' => 4 ) ) - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - <function>ImagickDraw::bezier</function> example - - setStrokeOpacity(1); - $draw->setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - - $draw->setStrokeWidth(2); - - $smoothPointsSet = [ - [ - ['x' => 10.0 * 5, 'y' => 10.0 * 5], - ['x' => 30.0 * 5, 'y' => 90.0 * 5], - ['x' => 25.0 * 5, 'y' => 10.0 * 5], - ['x' => 50.0 * 5, 'y' => 50.0 * 5], - ], - [ - ['x' => 50.0 * 5, 'y' => 50.0 * 5], - ['x' => 75.0 * 5, 'y' => 90.0 * 5], - ['x' => 70.0 * 5, 'y' => 10.0 * 5], - ['x' => 90.0 * 5, 'y' => 40.0 * 5], - ], - ]; - - foreach ($smoothPointsSet as $points) { - $draw->bezier($points); - } - - $disjointPoints = [ - [ - ['x' => 10 * 5, 'y' => 10 * 5], - ['x' => 30 * 5, 'y' => 90 * 5], - ['x' => 25 * 5, 'y' => 10 * 5], - ['x' => 50 * 5, 'y' => 50 * 5], - ], - [ - ['x' => 50 * 5, 'y' => 50 * 5], - ['x' => 80 * 5, 'y' => 50 * 5], - ['x' => 70 * 5, 'y' => 10 * 5], - ['x' => 90 * 5, 'y' => 40 * 5], - ] - ]; - $draw->translate(0, 200); - - foreach ($disjointPoints as $points) { - $draw->bezier($points); - } - - //Create an image object which the draw commands can be rendered into - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - - //Render the draw commands in the ImagickDraw object - //into the image. - $imagick->drawImage($draw); - - //Send the image to the browser - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/circle.xml b/reference/imagick/imagickdraw/circle.xml deleted file mode 100644 index 7a4f92fec77c..000000000000 --- a/reference/imagick/imagickdraw/circle.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - ImagickDraw::circle - Draws a circle - - - - &reftitle.description; - - public boolImagickDraw::circle - floatorigin_x - floatorigin_y - floatperimeter_x - floatperimeter_y - - &warn.undocumented.func; - - Draws a circle on the image. - - - - - &reftitle.parameters; - - - - origin_x - - - origin x coordinate - - - - - origin_y - - - origin y coordinate - - - - - perimeter_x - - - perimeter x coordinate - - - - - perimeter_y - - - perimeter y coordinate - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - <function>ImagickDraw::circle</function> example - - setStrokeOpacity(1); - $draw->setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - - $draw->setStrokeWidth(2); - $draw->setFontSize(72); - - $draw->circle($originX, $originY, $endX, $endY); - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/clear.xml b/reference/imagick/imagickdraw/clear.xml deleted file mode 100644 index d506ffcc0751..000000000000 --- a/reference/imagick/imagickdraw/clear.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - ImagickDraw::clear - Clears the ImagickDraw - - - - &reftitle.description; - - public boolImagickDraw::clear - - - &warn.undocumented.func; - - Clears the ImagickDraw object of any accumulated commands, and resets the - settings it contains to their defaults. - - - - - &reftitle.returnvalues; - - Returns an ImagickDraw object. - - - - - - diff --git a/reference/imagick/imagickdraw/clone.xml b/reference/imagick/imagickdraw/clone.xml deleted file mode 100644 index 3543304ef80a..000000000000 --- a/reference/imagick/imagickdraw/clone.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - ImagickDraw::clone - Makes an exact copy of the specified ImagickDraw object - - - - &reftitle.description; - - public ImagickDrawImagickDraw::clone - - - &warn.undocumented.func; - - Makes an exact copy of the specified ImagickDraw object. - - - - - &reftitle.returnvalues; - - returns an exact copy of the specified ImagickDraw object. - - - - - - diff --git a/reference/imagick/imagickdraw/color.xml b/reference/imagick/imagickdraw/color.xml deleted file mode 100644 index 72b78a734b43..000000000000 --- a/reference/imagick/imagickdraw/color.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - ImagickDraw::color - Draws color on image - - - - &reftitle.description; - - public boolImagickDraw::color - floatx - floaty - intpaint - - &warn.undocumented.func; - - Draws color on image using the current fill color, starting at specified - position, and using specified paint method. - - - - - &reftitle.parameters; - - - - x - - - x coordinate of the paint - - - - - y - - - y coordinate of the paint - - - - - paint - - - One of the PAINT constant - (imagick::PAINT_*). - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/comment.xml b/reference/imagick/imagickdraw/comment.xml deleted file mode 100644 index 258d79df2fce..000000000000 --- a/reference/imagick/imagickdraw/comment.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - ImagickDraw::comment - Adds a comment - - - - &reftitle.description; - - public boolImagickDraw::comment - stringcomment - - &warn.undocumented.func; - - Adds a comment to a vector output stream. - - - - - &reftitle.parameters; - - - - comment - - - The comment string to add to vector output stream - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/composite.xml b/reference/imagick/imagickdraw/composite.xml deleted file mode 100644 index 5257e1c2a8c3..000000000000 --- a/reference/imagick/imagickdraw/composite.xml +++ /dev/null @@ -1,161 +0,0 @@ - - - - - ImagickDraw::composite - Composites an image onto the current image - - - - &reftitle.description; - - public boolImagickDraw::composite - intcomposite - floatx - floaty - floatwidth - floatheight - Imagickimage - - &warn.undocumented.func; - - Composites an image onto the current image, using the specified - composition operator, specified position, and at the specified size. - - - - - &reftitle.parameters; - - - - composite - - - composition operator. - One of the Composite Operator constant - (imagick::COMPOSITE_*). - - - - - x - - - x coordinate of the top left corner. - - - - - y - - - y coordinate of the top left corner. - - - - - width - - - width of the composition image. - - - - - height - - - height of the composition image. - - - - - image - - - the Imagick object where composition image is taken from. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - <function>ImagickDraw::composite</function> example - - setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setFillOpacity(1); - $draw->setStrokeWidth(2); - $draw->setFontSize(72); - $draw->setStrokeOpacity(1); - $draw->setStrokeColor($strokeColor); - $draw->setStrokeWidth(2); - $draw->setFont("../fonts/CANDY.TTF"); - $draw->setFontSize(140); - $draw->rectangle(0, 0, 1000, 300); - $draw->setFillColor('white'); - $draw->setfillopacity(1); - $draw->annotation(50, 180, "Lorem Ipsum!"); - - //Create an image object which the draw commands can be rendered into - $imagick = new \Imagick(); - $imagick->newImage(1000, 302, $backgroundColor); - $imagick->setImageFormat("png"); - - //Render the draw commands in the ImagickDraw object - //into the image. - $imagick->drawImage($draw); - - //Send the image to the browser - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/construct.xml b/reference/imagick/imagickdraw/construct.xml deleted file mode 100644 index 25d8af7b297b..000000000000 --- a/reference/imagick/imagickdraw/construct.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - ImagickDraw::__construct - The ImagickDraw constructor - - - - &reftitle.description; - - public ImagickDraw::__construct - - - &warn.undocumented.func; - - The ImagickDraw constructor. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/destroy.xml b/reference/imagick/imagickdraw/destroy.xml deleted file mode 100644 index d0fb6d627989..000000000000 --- a/reference/imagick/imagickdraw/destroy.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - ImagickDraw::destroy - Frees all associated resources - - - - &reftitle.description; - - public boolImagickDraw::destroy - - - &warn.undocumented.func; - - Frees all resources associated with the ImagickDraw object. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/ellipse.xml b/reference/imagick/imagickdraw/ellipse.xml deleted file mode 100644 index 5f6dd30900c8..000000000000 --- a/reference/imagick/imagickdraw/ellipse.xml +++ /dev/null @@ -1,153 +0,0 @@ - - - - - ImagickDraw::ellipse - Draws an ellipse on the image - - - - &reftitle.description; - - public boolImagickDraw::ellipse - floatorigin_x - floatorigin_y - floatradius_x - floatradius_y - floatangle_start - floatangle_end - - &warn.undocumented.func; - - Draws an ellipse on the image. - - - - - &reftitle.parameters; - - - - origin_x - - - - - - - origin_y - - - - - - - radius_x - - - - - - - radius_y - - - - - - - angle_start - - - - - - - angle_end - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - <function>ImagickDraw::ellipse</function> example - - setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - - $draw->setStrokeWidth(2); - $draw->setFontSize(72); - - $draw->ellipse(125, 70, 100, 50, 0, 360); - $draw->ellipse(350, 70, 100, 50, 0, 315); - - $draw->push(); - $draw->translate(125, 250); - $draw->rotate(30); - $draw->ellipse(0, 0, 100, 50, 0, 360); - $draw->pop(); - - $draw->push(); - $draw->translate(350, 250); - $draw->rotate(30); - $draw->ellipse(0, 0, 100, 50, 0, 315); - $draw->pop(); - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/getclippath.xml b/reference/imagick/imagickdraw/getclippath.xml deleted file mode 100644 index 885fa4593d93..000000000000 --- a/reference/imagick/imagickdraw/getclippath.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - ImagickDraw::getClipPath - Obtains the current clipping path ID - - - - &reftitle.description; - - public falsestringImagickDraw::getClipPath - - - &warn.undocumented.func; - - Obtains the current clipping path ID. - - - - - &reftitle.returnvalues; - - Returns a string containing the clip path ID or false if no clip path exists. - - - - - - diff --git a/reference/imagick/imagickdraw/getcliprule.xml b/reference/imagick/imagickdraw/getcliprule.xml deleted file mode 100644 index 00fe8665e6a7..000000000000 --- a/reference/imagick/imagickdraw/getcliprule.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - ImagickDraw::getClipRule - Returns the current polygon fill rule - - - - &reftitle.description; - - public intImagickDraw::getClipRule - - - &warn.undocumented.func; - - Returns the current polygon fill rule to be used by the clipping path. - - - - - &reftitle.returnvalues; - - Returns a FILLRULE constant - (imagick::FILLRULE_*). - - - - - - diff --git a/reference/imagick/imagickdraw/getclipunits.xml b/reference/imagick/imagickdraw/getclipunits.xml deleted file mode 100644 index 8c1074c7fc03..000000000000 --- a/reference/imagick/imagickdraw/getclipunits.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - ImagickDraw::getClipUnits - Returns the interpretation of clip path units - - - - &reftitle.description; - - public intImagickDraw::getClipUnits - - - &warn.undocumented.func; - - Returns the interpretation of clip path units. - - - - - &reftitle.returnvalues; - - Returns an &integer; on success. - - - - - - diff --git a/reference/imagick/imagickdraw/getfillcolor.xml b/reference/imagick/imagickdraw/getfillcolor.xml deleted file mode 100644 index 7dea0ec16ded..000000000000 --- a/reference/imagick/imagickdraw/getfillcolor.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - ImagickDraw::getFillColor - Returns the fill color - - - - &reftitle.description; - - public ImagickPixelImagickDraw::getFillColor - - - &warn.undocumented.func; - - Returns the fill color used for drawing filled objects. - - - - - &reftitle.returnvalues; - - Returns an ImagickPixel object. - - - - - - diff --git a/reference/imagick/imagickdraw/getfillopacity.xml b/reference/imagick/imagickdraw/getfillopacity.xml deleted file mode 100644 index f8e0452b4bfe..000000000000 --- a/reference/imagick/imagickdraw/getfillopacity.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - ImagickDraw::getFillOpacity - Returns the opacity used when drawing - - - - &reftitle.description; - - public floatImagickDraw::getFillOpacity - - - &warn.undocumented.func; - - Returns the opacity used when drawing using the fill color or fill - texture. Fully opaque is 1.0. - - - - - &reftitle.returnvalues; - - The opacity. - - - - - - diff --git a/reference/imagick/imagickdraw/getfillrule.xml b/reference/imagick/imagickdraw/getfillrule.xml deleted file mode 100644 index 2bafde31d34c..000000000000 --- a/reference/imagick/imagickdraw/getfillrule.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - ImagickDraw::getFillRule - Returns the fill rule - - - - &reftitle.description; - - public intImagickDraw::getFillRule - - - &warn.undocumented.func; - - Returns the fill rule used while drawing polygons. - - - - - &reftitle.returnvalues; - - Returns a FILLRULE constant - (imagick::FILLRULE_*). - - - - - - diff --git a/reference/imagick/imagickdraw/getfont.xml b/reference/imagick/imagickdraw/getfont.xml deleted file mode 100644 index 6dd772c9cc4f..000000000000 --- a/reference/imagick/imagickdraw/getfont.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - ImagickDraw::getFont - Returns the font - - - - &reftitle.description; - - public stringImagickDraw::getFont - - - &warn.undocumented.func; - - Returns a string specifying the font used when annotating with text. - - - - - &reftitle.returnvalues; - - Returns a string on success and false if no font is set. - - - - - - diff --git a/reference/imagick/imagickdraw/getfontfamily.xml b/reference/imagick/imagickdraw/getfontfamily.xml deleted file mode 100644 index 4f7830729d0d..000000000000 --- a/reference/imagick/imagickdraw/getfontfamily.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - ImagickDraw::getFontFamily - Returns the font family - - - - &reftitle.description; - - public stringImagickDraw::getFontFamily - - - &warn.undocumented.func; - - Returns the font family to use when annotating with text. - - - - - &reftitle.returnvalues; - - Returns the font family currently selected or false if font family is not set. - - - - - - diff --git a/reference/imagick/imagickdraw/getfontsize.xml b/reference/imagick/imagickdraw/getfontsize.xml deleted file mode 100644 index a8a76e30625c..000000000000 --- a/reference/imagick/imagickdraw/getfontsize.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - ImagickDraw::getFontSize - Returns the font pointsize - - - - &reftitle.description; - - public floatImagickDraw::getFontSize - - - &warn.undocumented.func; - - Returns the font pointsize used when annotating with text. - - - - - &reftitle.returnvalues; - - Returns the font size associated with the current ImagickDraw object. - - - - - - diff --git a/reference/imagick/imagickdraw/getfontstretch.xml b/reference/imagick/imagickdraw/getfontstretch.xml deleted file mode 100644 index 856efd618fad..000000000000 --- a/reference/imagick/imagickdraw/getfontstretch.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - ImagickDraw::getFontStretch - Gets the font stretch to use when annotating with text - - - - &reftitle.description; - - public intImagickDraw::getFontStretch - - - - Gets the font stretch to use when annotating with text. Returns a StretchType. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/imagick/imagickdraw/getfontstyle.xml b/reference/imagick/imagickdraw/getfontstyle.xml deleted file mode 100644 index 456e47028b13..000000000000 --- a/reference/imagick/imagickdraw/getfontstyle.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - ImagickDraw::getFontStyle - Returns the font style - - - - &reftitle.description; - - public intImagickDraw::getFontStyle - - - &warn.undocumented.func; - - Returns the font style used when annotating with text. - - - - - &reftitle.returnvalues; - - Returns a STYLE constant - (imagick::STYLE_*) associated with the ImagickDraw object - or 0 if no style is set. - - - - - - diff --git a/reference/imagick/imagickdraw/getfontweight.xml b/reference/imagick/imagickdraw/getfontweight.xml deleted file mode 100644 index b4e1b6351194..000000000000 --- a/reference/imagick/imagickdraw/getfontweight.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - ImagickDraw::getFontWeight - Returns the font weight - - - - &reftitle.description; - - public intImagickDraw::getFontWeight - - - &warn.undocumented.func; - - Returns the font weight used when annotating with text. - - - - - &reftitle.returnvalues; - - Returns an &integer; on success and 0 if no weight is set. - - - - - - diff --git a/reference/imagick/imagickdraw/getgravity.xml b/reference/imagick/imagickdraw/getgravity.xml deleted file mode 100644 index 3ea5eeab3c04..000000000000 --- a/reference/imagick/imagickdraw/getgravity.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - ImagickDraw::getGravity - Returns the text placement gravity - - - - &reftitle.description; - - public intImagickDraw::getGravity - - - &warn.undocumented.func; - - Returns the text placement gravity used when annotating with text. - - - - - &reftitle.returnvalues; - - Returns a GRAVITY constant - (imagick::GRAVITY_*) on success and 0 if no gravity is set. - - - - - - diff --git a/reference/imagick/imagickdraw/getstrokeantialias.xml b/reference/imagick/imagickdraw/getstrokeantialias.xml deleted file mode 100644 index 1ebc04a0a259..000000000000 --- a/reference/imagick/imagickdraw/getstrokeantialias.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - ImagickDraw::getStrokeAntialias - Returns the current stroke antialias setting - - - - &reftitle.description; - - public boolImagickDraw::getStrokeAntialias - - - &warn.undocumented.func; - - Returns the current stroke antialias setting. Stroked outlines are - antialiased by default. When antialiasing is disabled stroked pixels are - thresholded to determine if the stroke color or underlying canvas color - should be used. - - - - - &reftitle.returnvalues; - - Returns &true; if antialiasing is on and &false; if it is off. - - - - - - diff --git a/reference/imagick/imagickdraw/getstrokecolor.xml b/reference/imagick/imagickdraw/getstrokecolor.xml deleted file mode 100644 index e850b4960a2c..000000000000 --- a/reference/imagick/imagickdraw/getstrokecolor.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - ImagickDraw::getStrokeColor - Returns the color used for stroking object outlines - - - - &reftitle.description; - - public ImagickPixelImagickDraw::getStrokeColor - - - &warn.undocumented.func; - - Returns the color used for stroking object outlines. - - - - - &reftitle.parameters; - - - - stroke_color - - - - - - - - - - - &reftitle.returnvalues; - - Returns an ImagickPixel object which describes the color. - - - - - - diff --git a/reference/imagick/imagickdraw/getstrokedasharray.xml b/reference/imagick/imagickdraw/getstrokedasharray.xml deleted file mode 100644 index 492155545195..000000000000 --- a/reference/imagick/imagickdraw/getstrokedasharray.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - ImagickDraw::getStrokeDashArray - Returns an array representing the pattern of dashes and gaps used to stroke paths - - - - &reftitle.description; - - public arrayImagickDraw::getStrokeDashArray - - - &warn.undocumented.func; - - Returns an array representing the pattern of dashes and gaps used to - stroke paths. - - - - - &reftitle.returnvalues; - - Returns an array on success and empty array if not set. - - - - - - diff --git a/reference/imagick/imagickdraw/getstrokedashoffset.xml b/reference/imagick/imagickdraw/getstrokedashoffset.xml deleted file mode 100644 index c325e2dc5b5b..000000000000 --- a/reference/imagick/imagickdraw/getstrokedashoffset.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - ImagickDraw::getStrokeDashOffset - Returns the offset into the dash pattern to start the dash - - - - &reftitle.description; - - public floatImagickDraw::getStrokeDashOffset - - - &warn.undocumented.func; - - Returns the offset into the dash pattern to start the dash. - - - - - &reftitle.returnvalues; - - Returns a float representing the offset and 0 if it's not set. - - - - - - diff --git a/reference/imagick/imagickdraw/getstrokelinecap.xml b/reference/imagick/imagickdraw/getstrokelinecap.xml deleted file mode 100644 index f02f3d963319..000000000000 --- a/reference/imagick/imagickdraw/getstrokelinecap.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - ImagickDraw::getStrokeLineCap - Returns the shape to be used at the end of open subpaths when they are stroked - - - - &reftitle.description; - - public intImagickDraw::getStrokeLineCap - - - &warn.undocumented.func; - - Returns the shape to be used at the end of open subpaths when they are - stroked. - - - - - &reftitle.returnvalues; - - Returns a LINECAP constant - (imagick::LINECAP_*), or 0 if stroke linecap is not set. - - - - - - diff --git a/reference/imagick/imagickdraw/getstrokelinejoin.xml b/reference/imagick/imagickdraw/getstrokelinejoin.xml deleted file mode 100644 index 6533b30bf696..000000000000 --- a/reference/imagick/imagickdraw/getstrokelinejoin.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - ImagickDraw::getStrokeLineJoin - Returns the shape to be used at the corners of paths when they are stroked - - - - &reftitle.description; - - public intImagickDraw::getStrokeLineJoin - - - &warn.undocumented.func; - - Returns the shape to be used at the corners of paths (or other vector - shapes) when they are stroked. - - - - - &reftitle.returnvalues; - - Returns a LINEJOIN constant - (imagick::LINEJOIN_*), or 0 if stroke line join is not set. - - - - - - diff --git a/reference/imagick/imagickdraw/getstrokemiterlimit.xml b/reference/imagick/imagickdraw/getstrokemiterlimit.xml deleted file mode 100644 index 981a87e203f8..000000000000 --- a/reference/imagick/imagickdraw/getstrokemiterlimit.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - ImagickDraw::getStrokeMiterLimit - Returns the stroke miter limit - - - - &reftitle.description; - - public intImagickDraw::getStrokeMiterLimit - - - &warn.undocumented.func; - - Returns the miter limit. When two line segments meet at a sharp angle and - miter joins have been specified for 'lineJoin', it is possible for the - miter to extend far beyond the thickness of the line stroking the path. - The 'miterLimit' imposes a limit on the ratio of the miter length to the - 'lineWidth'. - - - - - &reftitle.returnvalues; - - Returns an int describing the miter limit - and 0 if no miter limit is set. - - - - - - diff --git a/reference/imagick/imagickdraw/getstrokeopacity.xml b/reference/imagick/imagickdraw/getstrokeopacity.xml deleted file mode 100644 index 5a3be46fd24f..000000000000 --- a/reference/imagick/imagickdraw/getstrokeopacity.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - ImagickDraw::getStrokeOpacity - Returns the opacity of stroked object outlines - - - - &reftitle.description; - - public floatImagickDraw::getStrokeOpacity - - - &warn.undocumented.func; - - Returns the opacity of stroked object outlines. - - - - - &reftitle.returnvalues; - - Returns a float describing the opacity. - - - - - - diff --git a/reference/imagick/imagickdraw/getstrokewidth.xml b/reference/imagick/imagickdraw/getstrokewidth.xml deleted file mode 100644 index 0bd80c71be40..000000000000 --- a/reference/imagick/imagickdraw/getstrokewidth.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - ImagickDraw::getStrokeWidth - Returns the width of the stroke used to draw object outlines - - - - &reftitle.description; - - public floatImagickDraw::getStrokeWidth - - - &warn.undocumented.func; - - Returns the width of the stroke used to draw object outlines. - - - - - &reftitle.returnvalues; - - Returns a float describing the stroke width. - - - - - - diff --git a/reference/imagick/imagickdraw/gettextalignment.xml b/reference/imagick/imagickdraw/gettextalignment.xml deleted file mode 100644 index 8010beb4711b..000000000000 --- a/reference/imagick/imagickdraw/gettextalignment.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - ImagickDraw::getTextAlignment - Returns the text alignment - - - - &reftitle.description; - - public intImagickDraw::getTextAlignment - - - &warn.undocumented.func; - - Returns the alignment applied when annotating with text. - - - - - &reftitle.returnvalues; - - Returns a ALIGN constant - (imagick::ALIGN_*), and 0 if no align is set. - - - - - - diff --git a/reference/imagick/imagickdraw/gettextantialias.xml b/reference/imagick/imagickdraw/gettextantialias.xml deleted file mode 100644 index e20979e3408e..000000000000 --- a/reference/imagick/imagickdraw/gettextantialias.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - ImagickDraw::getTextAntialias - Returns the current text antialias setting - - - - &reftitle.description; - - public boolImagickDraw::getTextAntialias - - - &warn.undocumented.func; - - Returns the current text antialias setting, which determines whether text - is antialiased. Text is antialiased by default. - - - - - &reftitle.returnvalues; - - Returns &true; if text is antialiased and &false; if not. - - - - - - diff --git a/reference/imagick/imagickdraw/gettextdecoration.xml b/reference/imagick/imagickdraw/gettextdecoration.xml deleted file mode 100644 index a7fe9aea3a3a..000000000000 --- a/reference/imagick/imagickdraw/gettextdecoration.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - ImagickDraw::getTextDecoration - Returns the text decoration - - - - &reftitle.description; - - public intImagickDraw::getTextDecoration - - - &warn.undocumented.func; - - Returns the decoration applied when annotating with text. - - - - - &reftitle.returnvalues; - - Returns a DECORATION constant - (imagick::DECORATION_*), and 0 if no decoration is set. - - - - - - diff --git a/reference/imagick/imagickdraw/gettextencoding.xml b/reference/imagick/imagickdraw/gettextencoding.xml deleted file mode 100644 index 8e66dfadd380..000000000000 --- a/reference/imagick/imagickdraw/gettextencoding.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - ImagickDraw::getTextEncoding - Returns the code set used for text annotations - - - - &reftitle.description; - - public falsestringImagickDraw::getTextEncoding - - - &warn.undocumented.func; - - Returns a string which specifies the code set used for text annotations. - - - - - &reftitle.returnvalues; - - Returns a string specifying the code set - or false if text encoding is not set. - - - - - - diff --git a/reference/imagick/imagickdraw/gettextinterlinespacing.xml b/reference/imagick/imagickdraw/gettextinterlinespacing.xml deleted file mode 100644 index 6a54ce83cc12..000000000000 --- a/reference/imagick/imagickdraw/gettextinterlinespacing.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - ImagickDraw::getTextInterlineSpacing - Gets the text interline spacing - - - - &reftitle.description; - - public floatImagickDraw::getTextInterlineSpacing - - - - Gets the text interline spacing. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/imagick/imagickdraw/gettextinterwordspacing.xml b/reference/imagick/imagickdraw/gettextinterwordspacing.xml deleted file mode 100644 index af8b6c0f2d16..000000000000 --- a/reference/imagick/imagickdraw/gettextinterwordspacing.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - ImagickDraw::getTextInterwordSpacing - Gets the text interword spacing - - - - &reftitle.description; - - public floatImagickDraw::getTextInterwordSpacing - - - - Gets the text interword spacing. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/imagick/imagickdraw/gettextkerning.xml b/reference/imagick/imagickdraw/gettextkerning.xml deleted file mode 100644 index db5c2f92a91d..000000000000 --- a/reference/imagick/imagickdraw/gettextkerning.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - ImagickDraw::getTextKerning - Gets the text kerning - - - - &reftitle.description; - - public floatImagickDraw::getTextKerning - - - - Gets the text kerning. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/imagick/imagickdraw/gettextundercolor.xml b/reference/imagick/imagickdraw/gettextundercolor.xml deleted file mode 100644 index bb4950443ff8..000000000000 --- a/reference/imagick/imagickdraw/gettextundercolor.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - ImagickDraw::getTextUnderColor - Returns the text under color - - - - &reftitle.description; - - public ImagickPixelImagickDraw::getTextUnderColor - - - &warn.undocumented.func; - - Returns the color of a background rectangle to place under text annotations. - - - - - &reftitle.returnvalues; - - Returns an ImagickPixel object describing the color. - - - - - - diff --git a/reference/imagick/imagickdraw/getvectorgraphics.xml b/reference/imagick/imagickdraw/getvectorgraphics.xml deleted file mode 100644 index 86b06878caf0..000000000000 --- a/reference/imagick/imagickdraw/getvectorgraphics.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - ImagickDraw::getVectorGraphics - Returns a string containing vector graphics - - - - &reftitle.description; - - public stringImagickDraw::getVectorGraphics - - - &warn.undocumented.func; - - Returns a string which specifies the vector graphics generated by any - graphics calls made since the ImagickDraw object was instantiated. - - - - - &reftitle.returnvalues; - - Returns a string containing the vector graphics. - - - - - - diff --git a/reference/imagick/imagickdraw/line.xml b/reference/imagick/imagickdraw/line.xml deleted file mode 100644 index 5c7d669a6eb7..000000000000 --- a/reference/imagick/imagickdraw/line.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - ImagickDraw::line - Draws a line - - - - &reftitle.description; - - public boolImagickDraw::line - floatstart_x - floatstart_y - floatend_x - floatend_y - - &warn.undocumented.func; - - Draws a line on the image using the current stroke color, stroke opacity, and stroke width. - - - - - &reftitle.parameters; - - - - start_x - - - starting x coordinate - - - - - start_y - - - starting y coordinate - - - - - end_x - - - ending x coordinate - - - - - end_y - - - ending y coordinate - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - <function>ImagickDraw::line</function> example - - setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - - $draw->setStrokeWidth(2); - $draw->setFontSize(72); - - $draw->line(125, 70, 100, 50); - $draw->line(350, 170, 100, 150); - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/matte.xml b/reference/imagick/imagickdraw/matte.xml deleted file mode 100644 index 7b060a313d45..000000000000 --- a/reference/imagick/imagickdraw/matte.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - ImagickDraw::matte - Paints on the image's opacity channel - - - - &reftitle.description; - - public boolImagickDraw::matte - floatx - floaty - intpaint - - &warn.undocumented.func; - - Paints on the image's opacity channel in order to set effected pixels to - transparent, to influence the opacity of pixels. - - - - - &reftitle.parameters; - - - - x - - - x coordinate of the matte - - - - - y - - - y coordinate of the matte - - - - - paint - - - One of the PAINT constant - (imagick::PAINT_*). - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - <function>ImagickDraw::matte</function> example - - setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - - $draw->setStrokeWidth(2); - $draw->setFontSize(72); - - $draw->matte(120, 120, $paintType); - $draw->rectangle(100, 100, 300, 200); - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/pathclose.xml b/reference/imagick/imagickdraw/pathclose.xml deleted file mode 100644 index fa6de5c20bb7..000000000000 --- a/reference/imagick/imagickdraw/pathclose.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - ImagickDraw::pathClose - Adds a path element to the current path - - - - &reftitle.description; - - public boolImagickDraw::pathClose - - - &warn.undocumented.func; - - Adds a path element to the current path which closes the current subpath - by drawing a straight line from the current point to the current subpath's - most recent starting point (usually, the most recent moveto point). - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pathcurvetoabsolute.xml b/reference/imagick/imagickdraw/pathcurvetoabsolute.xml deleted file mode 100644 index a1ccfe5be594..000000000000 --- a/reference/imagick/imagickdraw/pathcurvetoabsolute.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - ImagickDraw::pathCurveToAbsolute - Draws a cubic Bezier curve - - - - &reftitle.description; - - public boolImagickDraw::pathCurveToAbsolute - floatx1 - floaty1 - floatx2 - floaty2 - floatx - floaty - - &warn.undocumented.func; - - Draws a cubic Bezier curve from the current point to (x,y) using (x1,y1) - as the control point at the beginning of the curve and (x2,y2) as the - control point at the end of the curve using absolute coordinates. At the - end of the command, the new current point becomes the final (x,y) - coordinate pair used in the polybezier. - - - - - &reftitle.parameters; - - - - x1 - - - x coordinate of the first control point - - - - - y1 - - - y coordinate of the first control point - - - - - x2 - - - x coordinate of the second control point - - - - - y2 - - - y coordinate of the first control point - - - - - x - - - x coordinate of the curve end - - - - - y - - - y coordinate of the curve end - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pathcurvetoquadraticbezierabsolute.xml b/reference/imagick/imagickdraw/pathcurvetoquadraticbezierabsolute.xml deleted file mode 100644 index 632fdac2d9e6..000000000000 --- a/reference/imagick/imagickdraw/pathcurvetoquadraticbezierabsolute.xml +++ /dev/null @@ -1,158 +0,0 @@ - - - - - ImagickDraw::pathCurveToQuadraticBezierAbsolute - Draws a quadratic Bezier curve - - - - &reftitle.description; - - public boolImagickDraw::pathCurveToQuadraticBezierAbsolute - floatx1 - floaty1 - floatx_end - floaty - - &warn.undocumented.func; - - Draws a quadratic Bezier curve from the current point to (x,y) using - (x1,y1) as the control point using absolute coordinates. At the end of the - command, the new current point becomes the final (x,y) coordinate pair - used in the polybezier. - - - - - &reftitle.parameters; - - - - x1 - - - x coordinate of the control point - - - - - y1 - - - y coordinate of the control point - - - - - x_end - - - x coordinate of the end point - - - - - y - - - y coordinate of the end point - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - <function>ImagickDraw::pathCurveToQuadraticBezierAbsolute</function> example - - setStrokeOpacity(1); - $draw->setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - - $draw->setStrokeWidth(2); - $draw->setFontSize(72); - - $draw->pathStart(); - $draw->pathMoveToAbsolute(50,250); - - // This specifies a quadratic bezier curve with the current position as the start - // point, the control point is the first two params, and the end point is the last two params. - $draw->pathCurveToQuadraticBezierAbsolute( - 150,50, - 250,250 - ); - - // This specifies a quadratic bezier curve with the current position as the start - // point, the control point is mirrored from the previous curves control point - // and the end point is defined by the x, y values. - $draw->pathCurveToQuadraticBezierSmoothAbsolute( - 450,250 - ); - - // This specifies a quadratic bezier curve with the current position as the start - // point, the control point is mirrored from the previous curves control point - // and the end point is defined relative from the current position by the x, y values. - $draw->pathCurveToQuadraticBezierSmoothRelative( - 200,-100 - ); - - $draw->pathFinish(); - - $imagick = new \Imagick(); - $imagick->newImage(700, 500, $backgroundColor); - $imagick->setImageFormat("png"); - - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); - -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/pathcurvetoquadraticbezierrelative.xml b/reference/imagick/imagickdraw/pathcurvetoquadraticbezierrelative.xml deleted file mode 100644 index 8373a2473f9f..000000000000 --- a/reference/imagick/imagickdraw/pathcurvetoquadraticbezierrelative.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - ImagickDraw::pathCurveToQuadraticBezierRelative - Draws a quadratic Bezier curve - - - - &reftitle.description; - - public boolImagickDraw::pathCurveToQuadraticBezierRelative - floatx1 - floaty1 - floatx_end - floaty - - &warn.undocumented.func; - - Draws a quadratic Bezier curve from the current point to (x,y) using - (x1,y1) as the control point using relative coordinates. At the end of the - command, the new current point becomes the final (x,y) coordinate pair - used in the polybezier. - - - - - &reftitle.parameters; - - - - x1 - - - starting x coordinate - - - - - y1 - - - starting y coordinate - - - - - x_end - - - ending x coordinate - - - - - y - - - ending y coordinate - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pathcurvetoquadraticbeziersmoothabsolute.xml b/reference/imagick/imagickdraw/pathcurvetoquadraticbeziersmoothabsolute.xml deleted file mode 100644 index da5f09f8104f..000000000000 --- a/reference/imagick/imagickdraw/pathcurvetoquadraticbeziersmoothabsolute.xml +++ /dev/null @@ -1,146 +0,0 @@ - - - - - ImagickDraw::pathCurveToQuadraticBezierSmoothAbsolute - Draws a quadratic Bezier curve - - - - &reftitle.description; - - public boolImagickDraw::pathCurveToQuadraticBezierSmoothAbsolute - floatx - floaty - - - - Draws a quadratic Bezier curve (using absolute coordinates) from the - current point to (x,y). The control point is assumed to be the reflection - of the control point on the previous command relative to the current point. - (If there is no previous command or if the previous command was not a - DrawPathCurveToQuadraticBezierAbsolute, - DrawPathCurveToQuadraticBezierRelative, - DrawPathCurveToQuadraticBezierSmoothAbsolut or - DrawPathCurveToQuadraticBezierSmoothRelative, assume the control point is - coincident with the current point.). At the end of the command, the new - current point becomes the final (x,y) coordinate pair used in the polybezier. - - - - This function cannot be used to continue a cubic Bezier curve smoothly. It can only continue from a quadratic curve smoothly. - - - - - &reftitle.parameters; - - - - x - - - ending x coordinate - - - - - y - - - ending y coordinate - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - - <methodname>ImagickDraw::pathCurveToQuadraticBezierSmoothAbsolute</methodname> example - - - setStrokeOpacity(1); -$draw->setStrokeColor("black"); -$draw->setFillColor("blue"); - -$draw->setStrokeWidth(2); -$draw->setFontSize(72); - -$draw->pathStart(); -$draw->pathMoveToAbsolute(50,250); - -// This specifies a quadratic bezier curve with the current position as the start -// point, the control point is the first two params, and the end point is the last two params. -$draw->pathCurveToQuadraticBezierAbsolute( - 150,50, - 250,250 -); - -// This specifies a quadratic bezier curve with the current position as the start -// point, the control point is mirrored from the previous curves control point -// and the end point is defined by the x, y values. -$draw->pathCurveToQuadraticBezierSmoothAbsolute( - 450,250 -); - -// This specifies a quadratic bezier curve with the current position as the start -// point, the control point is mirrored from the previous curves control point -// and the end point is defined relative from the current position by the x, y values. -$draw->pathCurveToQuadraticBezierSmoothRelative( - 200,-100 -); - -$draw->pathFinish(); - -$imagick = new \Imagick(); -$imagick->newImage(700, 500, $backgroundColor); -$imagick->setImageFormat("png"); - -$imagick->drawImage($draw); - -header("Content-Type: image/png"); -echo $imagick->getImageBlob(); -?> -]]> - - - - - - - diff --git a/reference/imagick/imagickdraw/pathcurvetoquadraticbeziersmoothrelative.xml b/reference/imagick/imagickdraw/pathcurvetoquadraticbeziersmoothrelative.xml deleted file mode 100644 index 7e09e96658d6..000000000000 --- a/reference/imagick/imagickdraw/pathcurvetoquadraticbeziersmoothrelative.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - ImagickDraw::pathCurveToQuadraticBezierSmoothRelative - Draws a quadratic Bezier curve - - - - &reftitle.description; - - public boolImagickDraw::pathCurveToQuadraticBezierSmoothRelative - floatx - floaty - - &warn.undocumented.func; - - Draws a quadratic Bezier curve (using relative coordinates) from the - current point to (x, y). The control point is assumed to be the reflection - of the control point on the previous command relative to the current point. - (If there is no previous command or if the previous command was not a - DrawPathCurveToQuadraticBezierAbsolute, - DrawPathCurveToQuadraticBezierRelative, - DrawPathCurveToQuadraticBezierSmoothAbsolut or - DrawPathCurveToQuadraticBezierSmoothRelative, assume the control point is - coincident with the current point). At the end of the command, the new - current point becomes the final (x, y) coordinate pair used in the - polybezier. - - - - This function cannot be used to continue a cubic Bezier curve smoothly. It can only continue from a quadratic curve smoothly. - - - - - &reftitle.parameters; - - - - x - - - ending x coordinate - - - - - y - - - ending y coordinate - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - - <methodname>ImagickDraw::pathCurveToQuadraticBezierSmoothRelative</methodname> example - - - setStrokeOpacity(1); -$draw->setStrokeColor("black"); -$draw->setFillColor("blue"); - -$draw->setStrokeWidth(2); -$draw->setFontSize(72); - -$draw->pathStart(); -$draw->pathMoveToAbsolute(50,250); - -// This specifies a quadratic bezier curve with the current position as the start -// point, the control point is the first two params, and the end point is the last two params. -$draw->pathCurveToQuadraticBezierAbsolute( - 150,50, - 250,250 -); - -// This specifies a quadratic bezier curve with the current position as the start -// point, the control point is mirrored from the previous curves control point -// and the end point is defined by the x, y values. -$draw->pathCurveToQuadraticBezierSmoothAbsolute( - 450,250 -); - -// This specifies a quadratic bezier curve with the current position as the start -// point, the control point is mirrored from the previous curves control point -// and the end point is defined relative from the current position by the x, y values. -$draw->pathCurveToQuadraticBezierSmoothRelative( - 200,-100 -); - -$draw->pathFinish(); - -$imagick = new \Imagick(); -$imagick->newImage(700, 500, $backgroundColor); -$imagick->setImageFormat("png"); - -$imagick->drawImage($draw); - -header("Content-Type: image/png"); -echo $imagick->getImageBlob(); -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/pathcurvetorelative.xml b/reference/imagick/imagickdraw/pathcurvetorelative.xml deleted file mode 100644 index d9690d4f4c78..000000000000 --- a/reference/imagick/imagickdraw/pathcurvetorelative.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - ImagickDraw::pathCurveToRelative - Draws a cubic Bezier curve - - - - &reftitle.description; - - public boolImagickDraw::pathCurveToRelative - floatx1 - floaty1 - floatx2 - floaty2 - floatx - floaty - - &warn.undocumented.func; - - Draws a cubic Bezier curve from the current point to (x,y) using (x1,y1) - as the control point at the beginning of the curve and (x2,y2) as the - control point at the end of the curve using relative coordinates. At the - end of the command, the new current point becomes the final (x,y) - coordinate pair used in the polybezier. - - - - - &reftitle.parameters; - - - - x1 - - - x coordinate of starting control point - - - - - y1 - - - y coordinate of starting control point - - - - - x2 - - - x coordinate of ending control point - - - - - y2 - - - y coordinate of ending control point - - - - - x - - - ending x coordinate - - - - - y - - - ending y coordinate - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pathcurvetosmoothabsolute.xml b/reference/imagick/imagickdraw/pathcurvetosmoothabsolute.xml deleted file mode 100644 index 4240bbf8ddf3..000000000000 --- a/reference/imagick/imagickdraw/pathcurvetosmoothabsolute.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - ImagickDraw::pathCurveToSmoothAbsolute - Draws a cubic Bezier curve - - - - &reftitle.description; - - public boolImagickDraw::pathCurveToSmoothAbsolute - floatx2 - floaty2 - floatx - floaty - - &warn.undocumented.func; - - Draws a cubic Bezier curve from the current point to (x,y) using absolute - coordinates. The first control point is assumed to be the reflection of the - second control point on the previous command relative to the current point. - (If there is no previous command or if the previous command was not an - DrawPathCurveToAbsolute, DrawPathCurveToRelative, - DrawPathCurveToSmoothAbsolute or DrawPathCurveToSmoothRelative, assume the - first control point is coincident with the current point.) (x2,y2) is the - second control point (i.e., the control point at the end of the curve). - At the end of the command, the new current point becomes the final (x,y) - coordinate pair used in the polybezier. - - - - - &reftitle.parameters; - - - - x2 - - - x coordinate of the second control point - - - - - y2 - - - y coordinate of the second control point - - - - - x - - - x coordinate of the ending point - - - - - y - - - y coordinate of the ending point - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pathcurvetosmoothrelative.xml b/reference/imagick/imagickdraw/pathcurvetosmoothrelative.xml deleted file mode 100644 index 40c75a0e2512..000000000000 --- a/reference/imagick/imagickdraw/pathcurvetosmoothrelative.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - ImagickDraw::pathCurveToSmoothRelative - Draws a cubic Bezier curve - - - - &reftitle.description; - - public boolImagickDraw::pathCurveToSmoothRelative - floatx2 - floaty2 - floatx - floaty - - &warn.undocumented.func; - - Draws a cubic Bezier curve from the current point to (x,y) using relative - coordinates. The first control point is assumed to be the reflection of - the second control point on the previous command relative to the current - point. (If there is no previous command or if the previous command was not - an DrawPathCurveToAbsolute, DrawPathCurveToRelative, - DrawPathCurveToSmoothAbsolute or DrawPathCurveToSmoothRelative, assume the - first control point is coincident with the current point.) (x2,y2) is the - second control point (i.e., the control point at the end of the curve). At - the end of the command, the new current point becomes the final (x,y) - coordinate pair used in the polybezier. - - - - - &reftitle.parameters; - - - - x2 - - - x coordinate of the second control point - - - - - y2 - - - y coordinate of the second control point - - - - - x - - - x coordinate of the ending point - - - - - y - - - y coordinate of the ending point - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pathellipticarcabsolute.xml b/reference/imagick/imagickdraw/pathellipticarcabsolute.xml deleted file mode 100644 index 86e2c24a1de5..000000000000 --- a/reference/imagick/imagickdraw/pathellipticarcabsolute.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - ImagickDraw::pathEllipticArcAbsolute - Draws an elliptical arc - - - - &reftitle.description; - - public boolImagickDraw::pathEllipticArcAbsolute - floatrx - floatry - floatx_axis_rotation - boollarge_arc - boolsweep - floatx - floaty - - &warn.undocumented.func; - - Draws an elliptical arc from the current point to (x, y) using absolute - coordinates. The size and orientation of the ellipse are defined by two - radii (rx, ry) and an xAxisRotation, which indicates how the ellipse as - a whole is rotated relative to the current coordinate system. The center - (cx, cy) of the ellipse is calculated automatically to satisfy the - constraints imposed by the other parameters. largeArcFlag and sweepFlag - contribute to the automatic calculations and help determine how the arc - is drawn. If large_arc is &true; then draw the larger of the available - arcs. If sweep is true, then draw the arc matching a clock-wise - rotation. - - - - - &reftitle.parameters; - - - - rx - - - x radius - - - - - ry - - - y radius - - - - - x_axis_rotation - - - x axis rotation - - - - - large_arc - - - large arc flag - - - - - sweep - - - sweep flag - - - - - x - - - x coordinate - - - - - y - - - y coordinate - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pathellipticarcrelative.xml b/reference/imagick/imagickdraw/pathellipticarcrelative.xml deleted file mode 100644 index 3a87698636a6..000000000000 --- a/reference/imagick/imagickdraw/pathellipticarcrelative.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - ImagickDraw::pathEllipticArcRelative - Draws an elliptical arc - - - - &reftitle.description; - - public boolImagickDraw::pathEllipticArcRelative - floatrx - floatry - floatx_axis_rotation - boollarge_arc - boolsweep - floatx - floaty - - &warn.undocumented.func; - - Draws an elliptical arc from the current point to (x, y) using relative - coordinates. The size and orientation of the ellipse are defined by two - radii (rx, ry) and an xAxisRotation, which indicates how the ellipse as - a whole is rotated relative to the current coordinate system. The center - (cx, cy) of the ellipse is calculated automatically to satisfy the - constraints imposed by the other parameters. largeArcFlag and sweepFlag - contribute to the automatic calculations and help determine how the arc - is drawn. If large_arc is &true; then draw the larger of the available - arcs. If sweep is true, then draw the arc matching a clock-wise - rotation. - - - - - &reftitle.parameters; - - - - rx - - - x radius - - - - - ry - - - y radius - - - - - x_axis_rotation - - - x axis rotation - - - - - large_arc - - - large arc flag - - - - - sweep - - - sweep flag - - - - - x - - - x coordinate - - - - - y - - - y coordinate - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pathfinish.xml b/reference/imagick/imagickdraw/pathfinish.xml deleted file mode 100644 index 39a873f45332..000000000000 --- a/reference/imagick/imagickdraw/pathfinish.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - ImagickDraw::pathFinish - Terminates the current path - - - - &reftitle.description; - - public boolImagickDraw::pathFinish - - - &warn.undocumented.func; - - Terminates the current path. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pathlinetoabsolute.xml b/reference/imagick/imagickdraw/pathlinetoabsolute.xml deleted file mode 100644 index 36365a0addce..000000000000 --- a/reference/imagick/imagickdraw/pathlinetoabsolute.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - ImagickDraw::pathLineToAbsolute - Draws a line path - - - - &reftitle.description; - - public boolImagickDraw::pathLineToAbsolute - floatx - floaty - - &warn.undocumented.func; - - Draws a line path from the current point to the given coordinate using - absolute coordinates. The coordinate then becomes the new current point. - - - - - &reftitle.parameters; - - - - x - - - starting x coordinate - - - - - y - - - ending x coordinate - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pathlinetohorizontalabsolute.xml b/reference/imagick/imagickdraw/pathlinetohorizontalabsolute.xml deleted file mode 100644 index 003f1012c50a..000000000000 --- a/reference/imagick/imagickdraw/pathlinetohorizontalabsolute.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - ImagickDraw::pathLineToHorizontalAbsolute - Draws a horizontal line path - - - - &reftitle.description; - - public boolImagickDraw::pathLineToHorizontalAbsolute - floatx - - &warn.undocumented.func; - - Draws a horizontal line path from the current point to the target point - using absolute coordinates. The target point then becomes the new - current point. - - - - - &reftitle.parameters; - - - - x - - - x coordinate - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pathlinetohorizontalrelative.xml b/reference/imagick/imagickdraw/pathlinetohorizontalrelative.xml deleted file mode 100644 index f23739af87e9..000000000000 --- a/reference/imagick/imagickdraw/pathlinetohorizontalrelative.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - ImagickDraw::pathLineToHorizontalRelative - Draws a horizontal line - - - - &reftitle.description; - - public boolImagickDraw::pathLineToHorizontalRelative - floatx - - &warn.undocumented.func; - - Draws a horizontal line path from the current point to the target point - using relative coordinates. The target point then becomes the new - current point. - - - - - &reftitle.parameters; - - - - x - - - x coordinate - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pathlinetorelative.xml b/reference/imagick/imagickdraw/pathlinetorelative.xml deleted file mode 100644 index 98cac1f63ccb..000000000000 --- a/reference/imagick/imagickdraw/pathlinetorelative.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - ImagickDraw::pathLineToRelative - Draws a line path - - - - &reftitle.description; - - public boolImagickDraw::pathLineToRelative - floatx - floaty - - &warn.undocumented.func; - - Draws a line path from the current point to the given coordinate using - relative coordinates. The coordinate then becomes the new current point. - - - - - &reftitle.parameters; - - - - x - - - starting x coordinate - - - - - y - - - starting y coordinate - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pathlinetoverticalabsolute.xml b/reference/imagick/imagickdraw/pathlinetoverticalabsolute.xml deleted file mode 100644 index 07cdfcea7ddc..000000000000 --- a/reference/imagick/imagickdraw/pathlinetoverticalabsolute.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - ImagickDraw::pathLineToVerticalAbsolute - Draws a vertical line - - - - &reftitle.description; - - public boolImagickDraw::pathLineToVerticalAbsolute - floaty - - &warn.undocumented.func; - - Draws a vertical line path from the current point to the target point using - absolute coordinates. The target point then becomes the new current point. - - - - - &reftitle.parameters; - - - - y - - - y coordinate - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pathlinetoverticalrelative.xml b/reference/imagick/imagickdraw/pathlinetoverticalrelative.xml deleted file mode 100644 index 8091d598dc7a..000000000000 --- a/reference/imagick/imagickdraw/pathlinetoverticalrelative.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - ImagickDraw::pathLineToVerticalRelative - Draws a vertical line path - - - - &reftitle.description; - - public boolImagickDraw::pathLineToVerticalRelative - floaty - - &warn.undocumented.func; - - Draws a vertical line path from the current point to the target point using - relative coordinates. The target point then becomes the new current point. - - - - - &reftitle.parameters; - - - - y - - - y coordinate - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pathmovetoabsolute.xml b/reference/imagick/imagickdraw/pathmovetoabsolute.xml deleted file mode 100644 index 4df099dcdb36..000000000000 --- a/reference/imagick/imagickdraw/pathmovetoabsolute.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - ImagickDraw::pathMoveToAbsolute - Starts a new sub-path - - - - &reftitle.description; - - public boolImagickDraw::pathMoveToAbsolute - floatx - floaty - - &warn.undocumented.func; - - Starts a new sub-path at the given coordinate using absolute coordinates. - The current point then becomes the specified coordinate. - - - - - &reftitle.parameters; - - - - x - - - x coordinate of the starting point - - - - - y - - - y coordinate of the starting point - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pathmovetorelative.xml b/reference/imagick/imagickdraw/pathmovetorelative.xml deleted file mode 100644 index cd012443054e..000000000000 --- a/reference/imagick/imagickdraw/pathmovetorelative.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - ImagickDraw::pathMoveToRelative - Starts a new sub-path - - - - &reftitle.description; - - public boolImagickDraw::pathMoveToRelative - floatx - floaty - - &warn.undocumented.func; - - Starts a new sub-path at the given coordinate using relative coordinates. - The current point then becomes the specified coordinate. - - - - - &reftitle.parameters; - - - - x - - - target x coordinate - - - - - y - - - target y coordinate - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pathstart.xml b/reference/imagick/imagickdraw/pathstart.xml deleted file mode 100644 index 515ef5319e38..000000000000 --- a/reference/imagick/imagickdraw/pathstart.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - ImagickDraw::pathStart - Declares the start of a path drawing list - - - - &reftitle.description; - - public boolImagickDraw::pathStart - - - &warn.undocumented.func; - - Declares the start of a path drawing list which is terminated by a matching - DrawPathFinish() command. All other DrawPath commands must be enclosed - between a and a DrawPathFinish() command. This is because path drawing - commands are subordinate commands and they do not function by themselves. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - <function>ImagickDraw::pathStart</function> example - - setStrokeOpacity(1); - $draw->setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - - $draw->setStrokeWidth(2); - $draw->setFontSize(72); - - $draw->pathStart(); - $draw->pathMoveToAbsolute(50, 50); - $draw->pathLineToAbsolute(100, 50); - $draw->pathLineToRelative(0, 50); - $draw->pathLineToHorizontalRelative(-50); - $draw->pathFinish(); - - $draw->pathStart(); - $draw->pathMoveToAbsolute(50, 50); - $draw->pathMoveToRelative(300, 0); - $draw->pathLineToRelative(50, 0); - $draw->pathLineToVerticalRelative(50); - $draw->pathLineToHorizontalAbsolute(350); - $draw->pathclose(); - $draw->pathFinish(); - - $draw->pathStart(); - $draw->pathMoveToAbsolute(50, 300); - $draw->pathCurveToAbsolute(50, 300, 100, 200, 300, 300); - $draw->pathLineToVerticalAbsolute(350); - $draw->pathFinish(); - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/point.xml b/reference/imagick/imagickdraw/point.xml deleted file mode 100644 index d5f1e040b4c4..000000000000 --- a/reference/imagick/imagickdraw/point.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - ImagickDraw::point - Draws a point - - - - &reftitle.description; - - public boolImagickDraw::point - floatx - floaty - - &warn.undocumented.func; - - Draws a point using the current stroke color and stroke thickness at the specified coordinates. - - - - - &reftitle.parameters; - - - - x - - - point's x coordinate - - - - - y - - - point's y coordinate - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - <function>ImagickDraw::point</function> example - - setFillColor($fillColor); - - for ($x = 0; $x < 10000; $x++) { - $draw->point(rand(0, 500), rand(0, 500)); - } - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/polygon.xml b/reference/imagick/imagickdraw/polygon.xml deleted file mode 100644 index bf8e6837d659..000000000000 --- a/reference/imagick/imagickdraw/polygon.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - ImagickDraw::polygon - Draws a polygon - - - - &reftitle.description; - - public boolImagickDraw::polygon - arraycoordinates - - &warn.undocumented.func; - - Draws a polygon using the current stroke, stroke width, and fill color or - texture, using the specified array of coordinates. - - - - - &reftitle.parameters; - - - - coordinates - - - multidimensional array like array( array( 'x' => 3, 'y' => 4 ), array( 'x' => 2, 'y' => 6 ) ); - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - <function>ImagickDraw::polygon</function> example - - setStrokeOpacity(1); - $draw->setStrokeColor($strokeColor); - $draw->setStrokeWidth(4); - - $draw->setFillColor($fillColor); - - $points = [ - ['x' => 40 * 5, 'y' => 10 * 5], - ['x' => 20 * 5, 'y' => 20 * 5], - ['x' => 70 * 5, 'y' => 50 * 5], - ['x' => 60 * 5, 'y' => 15 * 5], - ]; - - $draw->polygon($points); - - $image = new \Imagick(); - $image->newImage(500, 300, $backgroundColor); - $image->setImageFormat("png"); - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/polyline.xml b/reference/imagick/imagickdraw/polyline.xml deleted file mode 100644 index 453861019e38..000000000000 --- a/reference/imagick/imagickdraw/polyline.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - ImagickDraw::polyline - Draws a polyline - - - - &reftitle.description; - - public boolImagickDraw::polyline - arraycoordinates - - &warn.undocumented.func; - - Draws a polyline using the current stroke, stroke width, and fill color or - texture, using the specified array of coordinates. - - - - - &reftitle.parameters; - - - - coordinates - - - array of x and y coordinates: array( array( 'x' => 4, 'y' => 6 ), array( 'x' => 8, 'y' => 10 ) ) - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - <function>ImagickDraw::polyline</function> example - - setStrokeOpacity(1); - $draw->setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - - $draw->setStrokeWidth(5); - - $points = [ - ['x' => 40 * 5, 'y' => 10 * 5], - ['x' => 20 * 5, 'y' => 20 * 5], - ['x' => 70 * 5, 'y' => 50 * 5], - ['x' => 60 * 5, 'y' => 15 * 5] - ]; - - $draw->polyline($points); - - $image = new \Imagick(); - $image->newImage(500, 300, $backgroundColor); - $image->setImageFormat("png"); - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/pop.xml b/reference/imagick/imagickdraw/pop.xml deleted file mode 100644 index e9ac410855f9..000000000000 --- a/reference/imagick/imagickdraw/pop.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - ImagickDraw::pop - Destroys the current ImagickDraw in the stack, and returns to the previously pushed ImagickDraw - - - - &reftitle.description; - - public boolImagickDraw::pop - - - &warn.undocumented.func; - - Destroys the current ImagickDraw in the stack, and returns to the - previously pushed ImagickDraw. Multiple ImagickDraws may exist. It is an - error to attempt to pop more ImagickDraws than have been pushed, and it is - proper form to pop all ImagickDraws which have been pushed. - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/imagick/imagickdraw/popclippath.xml b/reference/imagick/imagickdraw/popclippath.xml deleted file mode 100644 index 592f56f5bb30..000000000000 --- a/reference/imagick/imagickdraw/popclippath.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - ImagickDraw::popClipPath - Terminates a clip path definition - - - - &reftitle.description; - - public boolImagickDraw::popClipPath - - - &warn.undocumented.func; - - Terminates a clip path definition. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/popdefs.xml b/reference/imagick/imagickdraw/popdefs.xml deleted file mode 100644 index cdaeae9c887a..000000000000 --- a/reference/imagick/imagickdraw/popdefs.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - ImagickDraw::popDefs - Terminates a definition list - - - - &reftitle.description; - - public boolImagickDraw::popDefs - - - &warn.undocumented.func; - - Terminates a definition list. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - <function>ImagickDraw::popDefs</function> example - - setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setstrokeOpacity(1); - $draw->setStrokeWidth(2); - $draw->setFontSize(72); - $draw->pushDefs(); - $draw->setStrokeColor('white'); - $draw->rectangle(50, 50, 200, 200); - $draw->popDefs(); - - $draw->rectangle(300, 50, 450, 200); - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/poppattern.xml b/reference/imagick/imagickdraw/poppattern.xml deleted file mode 100644 index 66a6808178a0..000000000000 --- a/reference/imagick/imagickdraw/poppattern.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - ImagickDraw::popPattern - Terminates a pattern definition - - - - &reftitle.description; - - public boolImagickDraw::popPattern - - - &warn.undocumented.func; - - Terminates a pattern definition. - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/imagick/imagickdraw/push.xml b/reference/imagick/imagickdraw/push.xml deleted file mode 100644 index 1786c6177324..000000000000 --- a/reference/imagick/imagickdraw/push.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - ImagickDraw::push - Clones the current ImagickDraw and pushes it to the stack - - - - &reftitle.description; - - public boolImagickDraw::push - - - &warn.undocumented.func; - - Clones the current ImagickDraw to create a new ImagickDraw, which is then - added to the ImagickDraw stack. The original drawing ImagickDraw(s) may be - returned to by invoking ImagickDraw::pop. The ImagickDraws are stored on a - ImagickDraw stack. For every Pop there must have already been an equivalent - Push. - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - <function>ImagickDraw::push</function> example - - setStrokeColor($strokeColor); - $draw->setFillColor($fillModifiedColor); - $draw->setStrokeWidth(2); - $draw->setFontSize(72); - $draw->push(); - $draw->translate(50, 50); - $draw->rectangle(200, 200, 300, 300); - $draw->pop(); - $draw->setFillColor($fillColor); - $draw->rectangle(200, 200, 300, 300); - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/pushclippath.xml b/reference/imagick/imagickdraw/pushclippath.xml deleted file mode 100644 index 5835f62269bd..000000000000 --- a/reference/imagick/imagickdraw/pushclippath.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - ImagickDraw::pushClipPath - Starts a clip path definition - - - - &reftitle.description; - - public boolImagickDraw::pushClipPath - stringclip_mask_id - - &warn.undocumented.func; - - Starts a clip path definition which is comprised of any number of drawing - commands and terminated by a ImagickDraw::popClipPath command. - - - - - &reftitle.parameters; - - - - clip_mask_id - - - Clip mask Id - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pushdefs.xml b/reference/imagick/imagickdraw/pushdefs.xml deleted file mode 100644 index 9313c8115c60..000000000000 --- a/reference/imagick/imagickdraw/pushdefs.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - ImagickDraw::pushDefs - Indicates that following commands create named elements for early processing - - - - &reftitle.description; - - public boolImagickDraw::pushDefs - - - &warn.undocumented.func; - - Indicates that commands up to a terminating ImagickDraw::popDefs - command create named elements (e.g. clip-paths, textures, etc.) which - may safely be processed earlier for the sake of efficiency. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pushpattern.xml b/reference/imagick/imagickdraw/pushpattern.xml deleted file mode 100644 index ab45479b5a7f..000000000000 --- a/reference/imagick/imagickdraw/pushpattern.xml +++ /dev/null @@ -1,163 +0,0 @@ - - - - - ImagickDraw::pushPattern - Indicates that subsequent commands up to a ImagickDraw::opPattern() command comprise the definition of a named pattern - - - - &reftitle.description; - - public boolImagickDraw::pushPattern - stringpattern_id - floatx - floaty - floatwidth - floatheight - - &warn.undocumented.func; - - Indicates that subsequent commands up to a DrawPopPattern() command - comprise the definition of a named pattern. The pattern space is assigned - top left corner coordinates, a width and height, and becomes its own - drawing space. Anything which can be drawn may be used in a pattern - definition. Named patterns may be used as stroke or brush definitions. - - - - - &reftitle.parameters; - - - - pattern_id - - - the pattern Id - - - - - x - - - x coordinate of the top-left corner - - - - - y - - - y coordinate of the top-left corner - - - - - width - - - width of the pattern - - - - - height - - - height of the pattern - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - <function>ImagickDraw::pushPattern</function> example - - setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(1); - $draw->setStrokeOpacity(1); - $draw->setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - - $draw->setStrokeWidth(1); - - $draw->pushPattern("MyFirstPattern", 0, 0, 50, 50); - for ($x = 0; $x < 50; $x += 10) { - for ($y = 0; $y < 50; $y += 5) { - $positionX = $x + (($y / 5) % 5); - $draw->rectangle($positionX, $y, $positionX + 5, $y + 5); - } - } - $draw->popPattern(); - - $draw->setFillOpacity(0); - $draw->rectangle(100, 100, 400, 400); - $draw->setFillOpacity(1); - - $draw->setFillOpacity(1); - - $draw->push(); - $draw->setFillPatternURL('#MyFirstPattern'); - $draw->setFillColor('yellow'); - $draw->rectangle(100, 100, 400, 400); - $draw->pop(); - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/rectangle.xml b/reference/imagick/imagickdraw/rectangle.xml deleted file mode 100644 index e63a8a47d3ad..000000000000 --- a/reference/imagick/imagickdraw/rectangle.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - ImagickDraw::rectangle - Draws a rectangle - - - - &reftitle.description; - - public boolImagickDraw::rectangle - floattop_left_x - floattop_left_y - floatbottom_right_x - floatbottom_right_y - - &warn.undocumented.func; - - Draws a rectangle given two coordinates and using the current stroke, - stroke width, and fill settings. - - - - - &reftitle.parameters; - - - - top_left_x - - - x coordinate of the top left corner - - - - - top_left_y - - - y coordinate of the top left corner - - - - - bottom_right_x - - - x coordinate of the bottom right corner - - - - - bottom_right_y - - - y coordinate of the bottom right corner - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - <function>ImagickDraw::rectangle</function> example - - setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeOpacity(1); - $draw->setStrokeWidth(2); - - $draw->rectangle(200, 200, 300, 300); - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/render.xml b/reference/imagick/imagickdraw/render.xml deleted file mode 100644 index dec3498f669e..000000000000 --- a/reference/imagick/imagickdraw/render.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - ImagickDraw::render - Renders all preceding drawing commands onto the image - - - - &reftitle.description; - - public boolImagickDraw::render - - - &warn.undocumented.func; - - Renders all preceding drawing commands onto the image. - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/imagick/imagickdraw/resetvectorgraphics.xml b/reference/imagick/imagickdraw/resetvectorgraphics.xml deleted file mode 100644 index 540f5aeedc31..000000000000 --- a/reference/imagick/imagickdraw/resetvectorgraphics.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - ImagickDraw::resetVectorGraphics - Resets the vector graphics - - - - &reftitle.description; - - public boolImagickDraw::resetVectorGraphics - - - - Resets the vector graphics. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - diff --git a/reference/imagick/imagickdraw/rotate.xml b/reference/imagick/imagickdraw/rotate.xml deleted file mode 100644 index 7ab60c73ec95..000000000000 --- a/reference/imagick/imagickdraw/rotate.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - ImagickDraw::rotate - Applies the specified rotation to the current coordinate space - - - - &reftitle.description; - - public boolImagickDraw::rotate - floatdegrees - - &warn.undocumented.func; - - Applies the specified rotation to the current coordinate space. - - - - - &reftitle.parameters; - - - - degrees - - - degrees to rotate. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - <function>ImagickDraw::rotate</function> example - - setStrokeColor($strokeColor); - $draw->setStrokeOpacity(1); - $draw->setFillColor($fillColor); - $draw->rectangle(200, 200, 300, 300); - $draw->setFillColor($fillModifiedColor); - $draw->rotate(15); - $draw->rectangle(200, 200, 300, 300); - - $image = new \Imagick(); - $image->newImage(500, 500, $backgroundColor); - $image->setImageFormat("png"); - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/roundrectangle.xml b/reference/imagick/imagickdraw/roundrectangle.xml deleted file mode 100644 index d113c20d1733..000000000000 --- a/reference/imagick/imagickdraw/roundrectangle.xml +++ /dev/null @@ -1,147 +0,0 @@ - - - - - ImagickDraw::roundRectangle - Draws a rounded rectangle - - - - &reftitle.description; - - public boolImagickDraw::roundRectangle - floattop_left_x - floattop_left_y - floatbottom_right_x - floatbottom_right_y - floatrounding_x - floatrounding_y - - &warn.undocumented.func; - - Draws a rounded rectangle given two coordinates, x & y corner radiuses - and using the current stroke, stroke width, and fill settings. - - - - - &reftitle.parameters; - - - - top_left_x - - - x coordinate of the top left corner - - - - - top_left_y - - - y coordinate of the top left corner - - - - - bottom_right_x - - - x coordinate of the bottom right - - - - - bottom_right_y - - - y coordinate of the bottom right - - - - - rounding_x - - - x rounding - - - - - rounding_y - - - y rounding - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - <function>ImagickDraw::roundRectangle</function> example - - setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeOpacity(1); - $draw->setStrokeWidth(2); - - $draw->roundRectangle($startX, $startY, $endX, $endY, $roundX, $roundY); - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/scale.xml b/reference/imagick/imagickdraw/scale.xml deleted file mode 100644 index a337dc9d8645..000000000000 --- a/reference/imagick/imagickdraw/scale.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - ImagickDraw::scale - Adjusts the scaling factor - - - - &reftitle.description; - - public boolImagickDraw::scale - floatx - floaty - - &warn.undocumented.func; - - Adjusts the scaling factor to apply in the horizontal and vertical - directions to the current coordinate space. - - - - - &reftitle.parameters; - - - - x - - - horizontal factor - - - - - y - - - vertical factor - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - <function>ImagickDraw::scale</function> example - - setStrokeColor($strokeColor); - $draw->setStrokeWidth(4); - $draw->setFillColor($fillColor); - $draw->rectangle(200, 200, 300, 300); - $draw->setFillColor($fillModifiedColor); - $draw->scale(1.4, 1.4); - $draw->rectangle(200, 200, 300, 300); - - $image = new \Imagick(); - $image->newImage(500, 500, $backgroundColor); - $image->setImageFormat("png"); - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setclippath.xml b/reference/imagick/imagickdraw/setclippath.xml deleted file mode 100644 index 0e441e71e1b2..000000000000 --- a/reference/imagick/imagickdraw/setclippath.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - ImagickDraw::setClipPath - Associates a named clipping path with the image - - - - &reftitle.description; - - public boolImagickDraw::setClipPath - stringclip_mask - - &warn.undocumented.func; - - Associates a named clipping path with the image. Only the areas drawn on - by the clipping path will be modified as long as it remains in effect. - - - - - &reftitle.parameters; - - - - clip_mask - - - the clipping path name - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - <function>ImagickDraw::setClipPath</function> example - - setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeOpacity(1); - $draw->setStrokeWidth(2); - - $clipPathName = 'testClipPath'; - - $draw->pushClipPath($clipPathName); - $draw->rectangle(0, 0, 250, 250); - $draw->popClipPath(); - $draw->setClipPath($clipPathName); - $draw->rectangle(100, 100, 400, 400); - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setcliprule.xml b/reference/imagick/imagickdraw/setcliprule.xml deleted file mode 100644 index edf001bfb384..000000000000 --- a/reference/imagick/imagickdraw/setcliprule.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - ImagickDraw::setClipRule - Set the polygon fill rule to be used by the clipping path - - - - &reftitle.description; - - public boolImagickDraw::setClipRule - intfillrule - - &warn.undocumented.func; - - Set the polygon fill rule to be used by the clipping path. - - - - - &reftitle.parameters; - - - - fillrule - - - One of the FILLRULE constant - (imagick::FILLRULE_*). - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - <function>ImagickDraw::setClipRule</function> example - - setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeOpacity(1); - $draw->setStrokeWidth(2); - //\Imagick::FILLRULE_EVENODD - //\Imagick::FILLRULE_NONZERO - - $clipPathName = 'testClipPath'; - $draw->pushClipPath($clipPathName); - $draw->setClipRule(\Imagick::FILLRULE_EVENODD); - $draw->rectangle(0, 0, 300, 500); - $draw->rectangle(200, 0, 500, 500); - $draw->popClipPath(); - $draw->setClipPath($clipPathName); - $draw->rectangle(200, 200, 300, 300); - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setclipunits.xml b/reference/imagick/imagickdraw/setclipunits.xml deleted file mode 100644 index 1de7ed425ada..000000000000 --- a/reference/imagick/imagickdraw/setclipunits.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - ImagickDraw::setClipUnits - Sets the interpretation of clip path units - - - - &reftitle.description; - - public boolImagickDraw::setClipUnits - intpathunits - - &warn.undocumented.func; - - Sets the interpretation of clip path units. - - - - - &reftitle.parameters; - - - - pathunits - - - the number of clip units - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - <function>ImagickDraw::setClipUnits</function> example - - setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeOpacity(1); - $draw->setStrokeWidth(2); - $clipPathName = 'testClipPath'; - $draw->setClipUnits(\Imagick::RESOLUTION_PIXELSPERINCH); - $draw->pushClipPath($clipPathName); - $draw->rectangle(0, 0, 250, 250); - $draw->popClipPath(); - $draw->setClipPath($clipPathName); - - //RESOLUTION_PIXELSPERINCH - //RESOLUTION_PIXELSPERCENTIMETER - - $draw->rectangle(200, 200, 300, 300); - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setfillalpha.xml b/reference/imagick/imagickdraw/setfillalpha.xml deleted file mode 100644 index 840a9b605fc9..000000000000 --- a/reference/imagick/imagickdraw/setfillalpha.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - ImagickDraw::setFillAlpha - Sets the opacity to use when drawing using the fill color or fill texture - - - - &reftitle.description; - - public boolImagickDraw::setFillAlpha - floatalpha - - &warn.undocumented.func; - - Sets the opacity to use when drawing using the fill color or fill texture. - Fully opaque is 1.0. - - - - - &reftitle.parameters; - - - - alpha - - - fill alpha - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - <function>ImagickDraw::setFillAlpha</function> example - - setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeOpacity(1); - $draw->setStrokeWidth(2); - $draw->rectangle(100, 200, 200, 300); - @$draw->setFillAlpha(0.4); - $draw->rectangle(300, 200, 400, 300); - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setfillcolor.xml b/reference/imagick/imagickdraw/setfillcolor.xml deleted file mode 100644 index a393ecee1b3e..000000000000 --- a/reference/imagick/imagickdraw/setfillcolor.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - ImagickDraw::setFillColor - Sets the fill color to be used for drawing filled objects - - - - &reftitle.description; - - public boolImagickDraw::setFillColor - ImagickPixelstringfill_color - - &warn.undocumented.func; - - Sets the fill color to be used for drawing filled objects. - - - - - &reftitle.parameters; - - - - fill_color - - - ImagickPixel to use to set the color - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - &reftitle.examples; - - - <function>ImagickDraw::setFillColor</function> - - setStrokeOpacity(1); - $draw->setStrokeWidth(1.5); - $draw->setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->rectangle(50, 50, 150, 150); - - $draw->setFillColor("rgb(200, 32, 32)"); - $draw->rectangle(200, 50, 300, 150); - - $image = new \Imagick(); - $image->newImage(500, 500, $backgroundColor); - $image->setImageFormat("png"); - - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setfillopacity.xml b/reference/imagick/imagickdraw/setfillopacity.xml deleted file mode 100644 index 7cd6dba584dc..000000000000 --- a/reference/imagick/imagickdraw/setfillopacity.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - ImagickDraw::setFillOpacity - Sets the opacity to use when drawing using the fill color or fill texture - - - - &reftitle.description; - - public boolImagickDraw::setFillOpacity - floatopacity - - &warn.undocumented.func; - - Sets the opacity to use when drawing using the fill color or fill texture. - Fully opaque is 1.0. - - - - - &reftitle.parameters; - - - - opacity - - - the fill opacity - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - &reftitle.examples; - - - <function>ImagickDraw::setFillOpacity</function> - - setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeOpacity(1); - $draw->setStrokeWidth(2); - - $draw->rectangle(100, 200, 200, 300); - - $draw->setFillOpacity(0.4); - $draw->rectangle(300, 200, 400, 300); - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setfillpatternurl.xml b/reference/imagick/imagickdraw/setfillpatternurl.xml deleted file mode 100644 index ec37adff5b3f..000000000000 --- a/reference/imagick/imagickdraw/setfillpatternurl.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - ImagickDraw::setFillPatternURL - Sets the URL to use as a fill pattern for filling objects - - - - &reftitle.description; - - public boolImagickDraw::setFillPatternURL - stringfill_url - - &warn.undocumented.func; - - Sets the URL to use as a fill pattern for filling objects. Only local URLs - ("#identifier") are supported at this time. These local URLs are normally - created by defining a named fill pattern with DrawPushPattern/DrawPopPattern. - - - - - &reftitle.parameters; - - - - fill_url - - - URL to use to obtain fill pattern. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/imagick/imagickdraw/setfillrule.xml b/reference/imagick/imagickdraw/setfillrule.xml deleted file mode 100644 index 68b03784bc6e..000000000000 --- a/reference/imagick/imagickdraw/setfillrule.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - ImagickDraw::setFillRule - Sets the fill rule to use while drawing polygons - - - - &reftitle.description; - - public boolImagickDraw::setFillRule - intfillrule - - &warn.undocumented.func; - - Sets the fill rule to use while drawing polygons. - - - - - &reftitle.parameters; - - - - fillrule - - - One of the FILLRULE constant - (imagick::FILLRULE_*). - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - <function>ImagickDraw::setFillRule</function> example - - setStrokeWidth(1); - $draw->setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - - $fillRules = [\Imagick::FILLRULE_NONZERO, \Imagick::FILLRULE_EVENODD]; - - $points = 11; - $size = 150; - - $draw->translate(175, 160); - - for ($x = 0; $x < 2; $x++) { - $draw->setFillRule($fillRules[$x]); - $draw->pathStart(); - for ($n = 0; $n < $points * 2; $n++) { - - if ($n >= $points) { - $angle = fmod($n * 360 * 4 / $points, 360) * pi() / 180; - } - else { - $angle = fmod($n * 360 * 3 / $points, 360) * pi() / 180; - } - - $positionX = $size * sin($angle); - $positionY = $size * cos($angle); - - if ($n == 0) { - $draw->pathMoveToAbsolute($positionX, $positionY); - } - else { - $draw->pathLineToAbsolute($positionX, $positionY); - } - } - - $draw->pathClose(); - $draw->pathFinish(); - - $draw->translate(325, 0); - } - - $image = new \Imagick(); - $image->newImage(700, 320, $backgroundColor); - $image->setImageFormat("png"); - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setfont.xml b/reference/imagick/imagickdraw/setfont.xml deleted file mode 100644 index a82646f7b4d8..000000000000 --- a/reference/imagick/imagickdraw/setfont.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - ImagickDraw::setFont - Sets the fully-specified font to use when annotating with text - - - - &reftitle.description; - - public boolImagickDraw::setFont - stringfont_name - - &warn.undocumented.func; - - Sets the fully-specified font to use when annotating with text. - - - - - &reftitle.parameters; - - - - font_name - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - <function>ImagickDraw::setFont</function> example - - setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - - $draw->setStrokeWidth(2); - $draw->setFontSize(36); - - $draw->setFont("../fonts/Arial.ttf"); - $draw->annotation(50, 50, "Lorem Ipsum!"); - - $draw->setFont("../fonts/Consolas.ttf"); - $draw->annotation(50, 100, "Lorem Ipsum!"); - - $draw->setFont("../fonts/CANDY.TTF"); - $draw->annotation(50, 150, "Lorem Ipsum!"); - - $draw->setFont("../fonts/Inconsolata-dz.otf"); - $draw->annotation(50, 200, "Lorem Ipsum!"); - - $imagick = new \Imagick(); - $imagick->newImage(500, 300, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setfontfamily.xml b/reference/imagick/imagickdraw/setfontfamily.xml deleted file mode 100644 index 91b25312c603..000000000000 --- a/reference/imagick/imagickdraw/setfontfamily.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - ImagickDraw::setFontFamily - Sets the font family to use when annotating with text - - - - &reftitle.description; - - public boolImagickDraw::setFontFamily - stringfont_family - - &warn.undocumented.func; - - Sets the font family to use when annotating with text. - - - - - &reftitle.parameters; - - - - font_family - - - the font family - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - <function>ImagickDraw::setFontFamily</function> example - - setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - - $draw->setStrokeWidth(2); - - $draw->setFontSize(48); - - $draw->setFontFamily("Times"); - $draw->annotation(50, 50, "Lorem Ipsum!"); - - $draw->setFontFamily("AvantGarde"); - $draw->annotation(50, 100, "Lorem Ipsum!"); - - $draw->setFontFamily("NewCenturySchlbk"); - $draw->annotation(50, 150, "Lorem Ipsum!"); - - $draw->setFontFamily("Palatino"); - $draw->annotation(50, 200, "Lorem Ipsum!"); - - $imagick = new \Imagick(); - $imagick->newImage(450, 250, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setfontsize.xml b/reference/imagick/imagickdraw/setfontsize.xml deleted file mode 100644 index dd9af3e6f9a5..000000000000 --- a/reference/imagick/imagickdraw/setfontsize.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - ImagickDraw::setFontSize - Sets the font pointsize to use when annotating with text - - - - &reftitle.description; - - public boolImagickDraw::setFontSize - floatpoint_size - - &warn.undocumented.func; - - Sets the font pointsize to use when annotating with text. - - - - - &reftitle.parameters; - - - - point_size - - - the point size - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - <function>ImagickDraw::setFontSize</function> example - - setStrokeOpacity(1); - $draw->setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(2); - $draw->setFont("../fonts/Arial.ttf"); - - $sizes = [24, 36, 48, 60, 72]; - - foreach ($sizes as $size) { - $draw->setFontSize($size); - $draw->annotation(50, ($size * $size / 16), "Lorem Ipsum!"); - } - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setfontstretch.xml b/reference/imagick/imagickdraw/setfontstretch.xml deleted file mode 100644 index cf330f7c6dc6..000000000000 --- a/reference/imagick/imagickdraw/setfontstretch.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - ImagickDraw::setFontStretch - Sets the font stretch to use when annotating with text - - - - &reftitle.description; - - public boolImagickDraw::setFontStretch - intstretch - - &warn.undocumented.func; - - Sets the font stretch to use when annotating with text. The AnyStretch - enumeration acts as a wild-card "don't care" option. - - - - - &reftitle.parameters; - - - - stretch - - - One of the STRETCH constant - (imagick::STRETCH_*). - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - <function>ImagickDraw::setFontStretch</function> example - - setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(2); - $draw->setFontSize(36); - - $fontStretchTypes = [ - \Imagick::STRETCH_ULTRACONDENSED, - \Imagick::STRETCH_CONDENSED, - \Imagick::STRETCH_SEMICONDENSED, - \Imagick::STRETCH_SEMIEXPANDED, - \Imagick::STRETCH_EXPANDED, - \Imagick::STRETCH_EXTRAEXPANDED, - \Imagick::STRETCH_ULTRAEXPANDED, - \Imagick::STRETCH_ANY - ]; - - $offset = 0; - foreach ($fontStretchTypes as $fontStretch) { - $draw->setFontStretch($fontStretch); - $draw->annotation(50, 75 + $offset, "Lorem Ipsum!"); - $offset += 50; - } - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setfontstyle.xml b/reference/imagick/imagickdraw/setfontstyle.xml deleted file mode 100644 index 99e01df9e335..000000000000 --- a/reference/imagick/imagickdraw/setfontstyle.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - ImagickDraw::setFontStyle - Sets the font style to use when annotating with text - - - - &reftitle.description; - - public boolImagickDraw::setFontStyle - intstyle - - &warn.undocumented.func; - - Sets the font style to use when annotating with text. The AnyStyle - enumeration acts as a wild-card "don't care" option. - - - - - &reftitle.parameters; - - - - style - - - One of the STYLE constant - (imagick::STYLE_*). - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - <function>ImagickDraw::setFontStyle</function> example - - setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(1); - $draw->setFontSize(36); - $draw->setFontStyle(\Imagick::STYLE_NORMAL); - $draw->annotation(50, 50, "Lorem Ipsum!"); - - $draw->setFontStyle(\Imagick::STYLE_ITALIC); - $draw->annotation(50, 100, "Lorem Ipsum!"); - - $draw->setFontStyle(\Imagick::STYLE_OBLIQUE); - $draw->annotation(50, 150, "Lorem Ipsum!"); - - $imagick = new \Imagick(); - $imagick->newImage(350, 300, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setfontweight.xml b/reference/imagick/imagickdraw/setfontweight.xml deleted file mode 100644 index 185a2f738825..000000000000 --- a/reference/imagick/imagickdraw/setfontweight.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - ImagickDraw::setFontWeight - Sets the font weight - - - - &reftitle.description; - - public boolImagickDraw::setFontWeight - intweight - - &warn.undocumented.func; - - Sets the font weight to use when annotating with text. - - - - - &reftitle.parameters; - - - - weight - - - - - - - - - - - &reftitle.returnvalues; - - - - - - &reftitle.examples; - - - <function>ImagickDraw::setFontWeight</function> example - - setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - - $draw->setStrokeWidth(1); - - $draw->setFontSize(36); - - $draw->setFontWeight(100); - $draw->annotation(50, 50, "Lorem Ipsum!"); - - $draw->setFontWeight(200); - $draw->annotation(50, 100, "Lorem Ipsum!"); - - $draw->setFontWeight(400); - $draw->annotation(50, 150, "Lorem Ipsum!"); - - $draw->setFontWeight(800); - $draw->annotation(50, 200, "Lorem Ipsum!"); - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setgravity.xml b/reference/imagick/imagickdraw/setgravity.xml deleted file mode 100644 index 1f0e62536e26..000000000000 --- a/reference/imagick/imagickdraw/setgravity.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - ImagickDraw::setGravity - Sets the text placement gravity - - - - &reftitle.description; - - public boolImagickDraw::setGravity - intgravity - - &warn.undocumented.func; - - Sets the text placement gravity to use when annotating with text. - - - - - &reftitle.parameters; - - - - gravity - - - One of the GRAVITY constant - (imagick::GRAVITY_*). - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - <function>ImagickDraw::setGravity</function> example - - setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(1); - $draw->setFontSize(24); - - $gravitySettings = array( - \Imagick::GRAVITY_NORTHWEST => 'NorthWest', - \Imagick::GRAVITY_NORTH => 'North', - \Imagick::GRAVITY_NORTHEAST => 'NorthEast', - \Imagick::GRAVITY_WEST => 'West', - \Imagick::GRAVITY_CENTER => 'Centre', - \Imagick::GRAVITY_SOUTHWEST => 'SouthWest', - \Imagick::GRAVITY_SOUTH => 'South', - \Imagick::GRAVITY_SOUTHEAST => 'SouthEast', - \Imagick::GRAVITY_EAST => 'East' - ); - - $draw->setFont("../fonts/Arial.ttf"); - - foreach ($gravitySettings as $type => $description) { - $draw->setGravity($type); - $draw->annotation(50, 50, '"' . $description . '"'); - } - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setresolution.xml b/reference/imagick/imagickdraw/setresolution.xml deleted file mode 100644 index 3c2cc731631c..000000000000 --- a/reference/imagick/imagickdraw/setresolution.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - ImagickDraw::setResolution - Sets the resolution - - - - &reftitle.description; - - public boolImagickDraw::setResolution - floatresolution_x - floatresolution_y - - - Sets the resolution. - - - - - - &reftitle.parameters; - - - resolution_x - - - - - - - - resolution_y - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - diff --git a/reference/imagick/imagickdraw/setstrokealpha.xml b/reference/imagick/imagickdraw/setstrokealpha.xml deleted file mode 100644 index d6b8c4922cfc..000000000000 --- a/reference/imagick/imagickdraw/setstrokealpha.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - ImagickDraw::setStrokeAlpha - Specifies the opacity of stroked object outlines - - - - &reftitle.description; - - public boolImagickDraw::setStrokeAlpha - floatalpha - - &warn.undocumented.func; - - Specifies the opacity of stroked object outlines. - - - - - &reftitle.parameters; - - - - alpha - - - opacity - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - <function>ImagickDraw::setStrokeAlpha</function> example - - setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(4); - $draw->line(100, 100, 400, 145); - $draw->rectangle(100, 200, 225, 350); - $draw->setStrokeOpacity(0.1); - $draw->line(100, 120, 400, 165); - $draw->rectangle(275, 200, 400, 350); - - $image = new \Imagick(); - $image->newImage(500, 400, $backgroundColor); - $image->setImageFormat("png"); - - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setstrokeantialias.xml b/reference/imagick/imagickdraw/setstrokeantialias.xml deleted file mode 100644 index d2828bb87ffa..000000000000 --- a/reference/imagick/imagickdraw/setstrokeantialias.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - ImagickDraw::setStrokeAntialias - Controls whether stroked outlines are antialiased - - - - &reftitle.description; - - public boolImagickDraw::setStrokeAntialias - boolenabled - - &warn.undocumented.func; - - Controls whether stroked outlines are antialiased. Stroked outlines are - antialiased by default. When antialiasing is disabled stroked pixels are - thresholded to determine if the stroke color or underlying canvas color - should be used. - - - - - &reftitle.parameters; - - - - enabled - - - the antialias setting - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - <function>ImagickDraw::setStrokeAntialias</function> example - - setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(1); - $draw->setStrokeAntialias(false); - $draw->line(100, 100, 400, 105); - - $draw->line(100, 140, 400, 185); - - $draw->setStrokeAntialias(true); - $draw->line(100, 110, 400, 115); - $draw->line(100, 150, 400, 195); - - $image = new \Imagick(); - $image->newImage(500, 250, $backgroundColor); - $image->setImageFormat("png"); - - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setstrokecolor.xml b/reference/imagick/imagickdraw/setstrokecolor.xml deleted file mode 100644 index 161149d4c804..000000000000 --- a/reference/imagick/imagickdraw/setstrokecolor.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - ImagickDraw::setStrokeColor - Sets the color used for stroking object outlines - - - - &reftitle.description; - - public boolImagickDraw::setStrokeColor - ImagickPixelstringcolor - - &warn.undocumented.func; - - Sets the color used for stroking object outlines. - - - - - &reftitle.parameters; - - - - color - - - the stroke color - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - <function>ImagickDraw::setStrokeColor</function> example - - setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - - $draw->setStrokeWidth(5); - - $draw->line(100, 100, 400, 145); - $draw->rectangle(100, 200, 225, 350); - - $draw->setStrokeOpacity(0.1); - $draw->line(100, 120, 400, 165); - $draw->rectangle(275, 200, 400, 350); - - $image = new \Imagick(); - $image->newImage(500, 400, $backgroundColor); - $image->setImageFormat("png"); - - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setstrokedasharray.xml b/reference/imagick/imagickdraw/setstrokedasharray.xml deleted file mode 100644 index e443b96dfa5d..000000000000 --- a/reference/imagick/imagickdraw/setstrokedasharray.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - ImagickDraw::setStrokeDashArray - Specifies the pattern of dashes and gaps used to stroke paths - - - - &reftitle.description; - - public boolImagickDraw::setStrokeDashArray - arraynulldashes - - &warn.undocumented.func; - - Specifies the pattern of dashes and gaps used to stroke paths. The - strokeDashArray represents an array of numbers that specify the lengths of - alternating dashes and gaps in pixels. If an odd number of values is - provided, then the list of values is repeated to yield an even number of - values. To remove an existing dash array, pass a zero number_elements - argument and null dash_array. A typical strokeDashArray_ array might - contain the members 5 3 2. - - - - - &reftitle.parameters; - - - - dashes - - - array of floats - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - <function>ImagickDraw::setStrokeDashArray</function> example - - setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(4); - - $draw->setStrokeDashArray([10, 10]); - $draw->rectangle(100, 50, 225, 175); - - $draw->setStrokeDashArray([20, 5, 20, 5, 5, 5,]); - $draw->rectangle(275, 50, 400, 175); - - $draw->setStrokeDashArray([20, 5, 20, 5, 5]); - $draw->rectangle(100, 200, 225, 350); - - $draw->setStrokeDashArray([1, 1, 1, 1, 2, 2, 3, 3, 5, 5, 8, 8, 13, 13, 21, 21, 34, 34, 55, 55, 89, 89, 144, 144, 233, 233, 377, 377, 610, 610, 987, 987, 1597, 1597, 2584, 2584, 4181, 4181,]); - - $draw->rectangle(275, 200, 400, 350); - - $image = new \Imagick(); - $image->newImage(500, 400, $backgroundColor); - $image->setImageFormat("png"); - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setstrokedashoffset.xml b/reference/imagick/imagickdraw/setstrokedashoffset.xml deleted file mode 100644 index ce76725c7a87..000000000000 --- a/reference/imagick/imagickdraw/setstrokedashoffset.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - ImagickDraw::setStrokeDashOffset - Specifies the offset into the dash pattern to start the dash - - - - &reftitle.description; - - public boolImagickDraw::setStrokeDashOffset - floatdash_offset - - &warn.undocumented.func; - - Specifies the offset into the dash pattern to start the dash. - - - - - &reftitle.parameters; - - - - dash_offset - - - dash offset - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - <function>ImagickDraw::setStrokeDashOffset</function> example - - setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(4); - $draw->setStrokeDashArray([20, 20]); - $draw->setStrokeDashOffset(0); - $draw->rectangle(100, 50, 225, 175); - - //Start the dash effect halfway through the solid portion - $draw->setStrokeDashOffset(10); - $draw->rectangle(275, 50, 400, 175); - - //Start the dash effect on the space portion - $draw->setStrokeDashOffset(20); - $draw->rectangle(100, 200, 225, 350); - $draw->setStrokeDashOffset(5); - $draw->rectangle(275, 200, 400, 350); - - $image = new \Imagick(); - $image->newImage(500, 400, $backgroundColor); - $image->setImageFormat("png"); - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setstrokelinecap.xml b/reference/imagick/imagickdraw/setstrokelinecap.xml deleted file mode 100644 index 88d9a4cabb47..000000000000 --- a/reference/imagick/imagickdraw/setstrokelinecap.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - ImagickDraw::setStrokeLineCap - Specifies the shape to be used at the end of open subpaths when they are stroked - - - - &reftitle.description; - - public boolImagickDraw::setStrokeLineCap - intlinecap - - &warn.undocumented.func; - - Specifies the shape to be used at the end of open subpaths when they - are stroked. - - - - - &reftitle.parameters; - - - - linecap - - - One of the LINECAP constant - (imagick::LINECAP_*). - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - <function>ImagickDraw::setStrokeLineCap</function> example - - setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(25); - - $lineTypes = [\Imagick::LINECAP_BUTT, \Imagick::LINECAP_ROUND, \Imagick::LINECAP_SQUARE,]; - - $offset = 0; - - foreach ($lineTypes as $lineType) { - $draw->setStrokeLineCap($lineType); - $draw->line(50 + $offset, 50, 50 + $offset, 250); - $offset += 50; - } - - $imagick = new \Imagick(); - $imagick->newImage(300, 300, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setstrokelinejoin.xml b/reference/imagick/imagickdraw/setstrokelinejoin.xml deleted file mode 100644 index edb5260c4a2c..000000000000 --- a/reference/imagick/imagickdraw/setstrokelinejoin.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - ImagickDraw::setStrokeLineJoin - Specifies the shape to be used at the corners of paths when they are stroked - - - - &reftitle.description; - - public boolImagickDraw::setStrokeLineJoin - intlinejoin - - &warn.undocumented.func; - - Specifies the shape to be used at the corners of paths (or other vector - shapes) when they are stroked. - - - - - &reftitle.parameters; - - - - linejoin - - - One of the LINEJOIN constant - (imagick::LINEJOIN_*). - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - <function>ImagickDraw::setStrokeLineJoin</function> example - - setStrokeWidth(1); - $draw->setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - - $draw->setStrokeWidth(20); - - $offset = 220; - - $lineJoinStyle = [ - \Imagick::LINEJOIN_MITER, - \Imagick::LINEJOIN_ROUND, - \Imagick::LINEJOIN_BEVEL, - ]; - - for ($x = 0; $x < count($lineJoinStyle); $x++) { - $draw->setStrokeLineJoin($lineJoinStyle[$x]); - $points = [ - ['x' => 40 * 5, 'y' => 10 * 5 + $x * $offset], - ['x' => 20 * 5, 'y' => 20 * 5 + $x * $offset], - ['x' => 70 * 5, 'y' => 50 * 5 + $x * $offset], - ['x' => 40 * 5, 'y' => 10 * 5 + $x * $offset], - ]; - - $draw->polyline($points); - } - - $image = new \Imagick(); - $image->newImage(500, 700, $backgroundColor); - $image->setImageFormat("png"); - - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setstrokemiterlimit.xml b/reference/imagick/imagickdraw/setstrokemiterlimit.xml deleted file mode 100644 index cf6f15d2b251..000000000000 --- a/reference/imagick/imagickdraw/setstrokemiterlimit.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - ImagickDraw::setStrokeMiterLimit - Specifies the miter limit - - - - &reftitle.description; - - public boolImagickDraw::setStrokeMiterLimit - intmiterlimit - - &warn.undocumented.func; - - Specifies the miter limit. When two line segments meet at a sharp angle - and miter joins have been specified for 'lineJoin', it is possible for - the miter to extend far beyond the thickness of the line stroking the - path. The miterLimit' imposes a limit on the ratio of the miter length to - the 'lineWidth'. - - - - - &reftitle.parameters; - - - - miterlimit - - - the miter limit - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - <function>ImagickDraw::setStrokeMiterLimit</function> example - - setStrokeColor($strokeColor); - $draw->setStrokeOpacity(0.6); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(10); - - $yOffset = 100; - - $draw->setStrokeLineJoin(\Imagick::LINEJOIN_MITER); - - for ($y = 0; $y < 3; $y++) { - - $draw->setStrokeMiterLimit(40 * $y); - - $points = [ - ['x' => 22 * 3, 'y' => 15 * 4 + $y * $yOffset], - ['x' => 20 * 3, 'y' => 20 * 4 + $y * $yOffset], - ['x' => 70 * 5, 'y' => 45 * 4 + $y * $yOffset], - ]; - - $draw->polygon($points); - } - - $image = new \Imagick(); - $image->newImage(500, 500, $backgroundColor); - $image->setImageFormat("png"); - $image->drawImage($draw); - - $image->setImageType(\Imagick::IMGTYPE_PALETTE); - $image->setImageCompressionQuality(100); - $image->stripImage(); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setstrokeopacity.xml b/reference/imagick/imagickdraw/setstrokeopacity.xml deleted file mode 100644 index e77a866e2b41..000000000000 --- a/reference/imagick/imagickdraw/setstrokeopacity.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - ImagickDraw::setStrokeOpacity - Specifies the opacity of stroked object outlines - - - - &reftitle.description; - - public boolImagickDraw::setStrokeOpacity - floatopacity - - &warn.undocumented.func; - - Specifies the opacity of stroked object outlines. - - - - - &reftitle.parameters; - - - - opacity - - - stroke opacity. 1.0 is fully opaque - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - <function>ImagickDraw::setStrokeOpacity</function> example - - setStrokeWidth(1); - $draw->setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(10); - $draw->setStrokeOpacity(1); - $draw->line(100, 80, 400, 125); - $draw->rectangle(25, 200, 150, 350); - $draw->setStrokeOpacity(0.5); - $draw->line(100, 100, 400, 145); - $draw->rectangle(200, 200, 325, 350); - $draw->setStrokeOpacity(0.2); - $draw->line(100, 120, 400, 165); - $draw->rectangle(375, 200, 500, 350); - - $image = new \Imagick(); - $image->newImage(550, 400, $backgroundColor); - $image->setImageFormat("png"); - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setstrokepatternurl.xml b/reference/imagick/imagickdraw/setstrokepatternurl.xml deleted file mode 100644 index e88602b8a720..000000000000 --- a/reference/imagick/imagickdraw/setstrokepatternurl.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - ImagickDraw::setStrokePatternURL - Sets the pattern used for stroking object outlines - - - - &reftitle.description; - - public boolImagickDraw::setStrokePatternURL - stringstroke_url - - &warn.undocumented.func; - - Sets the pattern used for stroking object outlines. - - - - - &reftitle.parameters; - - - - stroke_url - - - stroke URL - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagickdraw/setstrokewidth.xml b/reference/imagick/imagickdraw/setstrokewidth.xml deleted file mode 100644 index bb275a7e4477..000000000000 --- a/reference/imagick/imagickdraw/setstrokewidth.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - ImagickDraw::setStrokeWidth - Sets the width of the stroke used to draw object outlines - - - - &reftitle.description; - - public boolImagickDraw::setStrokeWidth - floatwidth - - &warn.undocumented.func; - - Sets the width of the stroke used to draw object outlines. - - - - - &reftitle.parameters; - - - - width - - - stroke width - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - <function>ImagickDraw::setStrokeWidth</function> example - - setStrokeWidth(1); - $draw->setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->line(100, 100, 400, 145); - $draw->rectangle(100, 200, 225, 350); - $draw->setStrokeWidth(5); - $draw->line(100, 120, 400, 165); - $draw->rectangle(275, 200, 400, 350); - - $image = new \Imagick(); - $image->newImage(500, 400, $backgroundColor); - $image->setImageFormat("png"); - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/settextalignment.xml b/reference/imagick/imagickdraw/settextalignment.xml deleted file mode 100644 index c738b13b9e9a..000000000000 --- a/reference/imagick/imagickdraw/settextalignment.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - ImagickDraw::setTextAlignment - Specifies a text alignment - - - - &reftitle.description; - - public boolImagickDraw::setTextAlignment - intalign - - &warn.undocumented.func; - - Specifies a text alignment to be applied when annotating with text. - - - - - &reftitle.parameters; - - - - align - - - One of the ALIGN constant - (imagick::ALIGN_*). - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - <function>ImagickDraw::setTextAlignment</function> example - - setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(1); - $draw->setFontSize(36); - - $draw->setTextAlignment(\Imagick::ALIGN_LEFT); - $draw->annotation(250, 75, "Lorem Ipsum!"); - $draw->setTextAlignment(\Imagick::ALIGN_CENTER); - $draw->annotation(250, 150, "Lorem Ipsum!"); - $draw->setTextAlignment(\Imagick::ALIGN_RIGHT); - $draw->annotation(250, 225, "Lorem Ipsum!"); - $draw->line(250, 0, 250, 500); - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/settextantialias.xml b/reference/imagick/imagickdraw/settextantialias.xml deleted file mode 100644 index 3ba3469a4b8d..000000000000 --- a/reference/imagick/imagickdraw/settextantialias.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - ImagickDraw::setTextAntialias - Controls whether text is antialiased - - - - &reftitle.description; - - public boolImagickDraw::setTextAntialias - boolantialias - - &warn.undocumented.func; - - Controls whether text is antialiased. Text is antialiased by default. - - - - - &reftitle.parameters; - - - - antialias - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - <function>ImagickDraw::setTextAntialias</function> example - - setStrokeColor('none'); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(1); - $draw->setFontSize(32); - $draw->setTextAntialias(false); - $draw->annotation(5, 30, "Lorem Ipsum!"); - $draw->setTextAntialias(true); - $draw->annotation(5, 65, "Lorem Ipsum!"); - - $imagick = new \Imagick(); - $imagick->newImage(220, 80, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - //Scale the image so that people can see the aliasing. - $imagick->scaleImage(220 * 6, 80 * 6); - $imagick->cropImage(640, 480, 0, 0); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/settextdecoration.xml b/reference/imagick/imagickdraw/settextdecoration.xml deleted file mode 100644 index 629bbe0138c3..000000000000 --- a/reference/imagick/imagickdraw/settextdecoration.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - ImagickDraw::setTextDecoration - Specifies a decoration - - - - &reftitle.description; - - public boolImagickDraw::setTextDecoration - intdecoration - - &warn.undocumented.func; - - Specifies a decoration to be applied when annotating with text. - - - - - &reftitle.parameters; - - - - decoration - - - One of the DECORATION constant - (imagick::DECORATION_*). - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - <function>ImagickDraw::setTextDecoration</function> example - - setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(2); - $draw->setFontSize(72); - $draw->setTextDecoration($textDecoration); - $draw->annotation(50, 75, "Lorem Ipsum!"); - - $imagick = new \Imagick(); - $imagick->newImage(500, 200, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/settextencoding.xml b/reference/imagick/imagickdraw/settextencoding.xml deleted file mode 100644 index 29e3666d4052..000000000000 --- a/reference/imagick/imagickdraw/settextencoding.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - ImagickDraw::setTextEncoding - Specifies the text code set - - - - &reftitle.description; - - public boolImagickDraw::setTextEncoding - stringencoding - - &warn.undocumented.func; - - Specifies the code set to use for text annotations. The only - character encoding which may be specified at this time is "UTF-8" for - representing Unicode as a sequence of bytes. Specify an empty string to - set text encoding to the system's default. Successful text annotation - using Unicode may require fonts designed to support Unicode. - - - - - &reftitle.parameters; - - - - encoding - - - the encoding name - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/settextinterlinespacing.xml b/reference/imagick/imagickdraw/settextinterlinespacing.xml deleted file mode 100644 index f3fdda22a476..000000000000 --- a/reference/imagick/imagickdraw/settextinterlinespacing.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - ImagickDraw::setTextInterlineSpacing - Sets the text interline spacing - - - - &reftitle.description; - - public boolImagickDraw::setTextInterlineSpacing - floatspacing - - - Sets the text interline spacing. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - spacing - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - diff --git a/reference/imagick/imagickdraw/settextinterwordspacing.xml b/reference/imagick/imagickdraw/settextinterwordspacing.xml deleted file mode 100644 index ebb1137f4d8b..000000000000 --- a/reference/imagick/imagickdraw/settextinterwordspacing.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - ImagickDraw::setTextInterwordSpacing - Sets the text interword spacing - - - - &reftitle.description; - - public boolImagickDraw::setTextInterwordSpacing - floatspacing - - - Sets the text interword spacing. - - - - - - &reftitle.parameters; - - - spacing - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - diff --git a/reference/imagick/imagickdraw/settextkerning.xml b/reference/imagick/imagickdraw/settextkerning.xml deleted file mode 100644 index 808e385f2ff8..000000000000 --- a/reference/imagick/imagickdraw/settextkerning.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - ImagickDraw::setTextKerning - Sets the text kerning - - - - &reftitle.description; - - public boolImagickDraw::setTextKerning - floatkerning - - - Sets the text kerning - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - kerning - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - diff --git a/reference/imagick/imagickdraw/settextundercolor.xml b/reference/imagick/imagickdraw/settextundercolor.xml deleted file mode 100644 index 9ffa21f85399..000000000000 --- a/reference/imagick/imagickdraw/settextundercolor.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - ImagickDraw::setTextUnderColor - Specifies the color of a background rectangle - - - - &reftitle.description; - - public boolImagickDraw::setTextUnderColor - ImagickPixelstringunder_color - - &warn.undocumented.func; - - Specifies the color of a background rectangle to place under text annotations. - - - - - &reftitle.parameters; - - - - under_color - - - the under color - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - <function>ImagickDraw::setTextUnderColor</function> example - - setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(2); - $draw->setFontSize(72); - $draw->annotation(50, 75, "Lorem Ipsum!"); - $draw->setTextUnderColor($textUnderColor); - $draw->annotation(50, 175, "Lorem Ipsum!"); - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setvectorgraphics.xml b/reference/imagick/imagickdraw/setvectorgraphics.xml deleted file mode 100644 index a322a17dee36..000000000000 --- a/reference/imagick/imagickdraw/setvectorgraphics.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - ImagickDraw::setVectorGraphics - Sets the vector graphics - - - - &reftitle.description; - - public boolImagickDraw::setVectorGraphics - stringxml - - &warn.undocumented.func; - - Sets the vector graphics associated with the specified ImagickDraw - object. Use this method with ImagickDraw::getVectorGraphics as a method - to persist the vector graphics state. - - - - - &reftitle.parameters; - - - - xml - - - xml containing the vector graphics - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - <function>ImagickDraw::setVectorGraphics</function> example - - setFillColor("red"); - $draw->circle(20, 20, 50, 50); - $draw->setFillColor("blue"); - $draw->circle(50, 70, 50, 50); - $draw->rectangle(50, 120, 80, 150); - - //Get the drawing as a string - $SVG = $draw->getVectorGraphics(); - - //$svg is a string, and could be saved anywhere a string can be saved - - //Use the saved drawing to generate a new draw object - $draw2 = new \ImagickDraw(); - //Apparently the SVG text is missing the root element. - $draw2->setVectorGraphics("".$SVG.""); - - $imagick = new \Imagick(); - $imagick->newImage(200, 200, 'white'); - $imagick->setImageFormat("png"); - - $imagick->drawImage($draw2); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setviewbox.xml b/reference/imagick/imagickdraw/setviewbox.xml deleted file mode 100644 index c4a7633a8c6a..000000000000 --- a/reference/imagick/imagickdraw/setviewbox.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - ImagickDraw::setViewbox - Sets the overall canvas size - - - - &reftitle.description; - - public boolImagickDraw::setViewbox - intleft_x - inttop_y - intright_x - intbottom_y - - &warn.undocumented.func; - - Sets the overall canvas size to be recorded with the drawing vector data. - Usually this will be specified using the same size as the canvas image. - When the vector data is saved to SVG or MVG formats, the viewbox is use to - specify the size of the canvas image that a viewer will render the vector - data on. - - - - - &reftitle.parameters; - - - - left_x - - - left x coordinate - - - - - top_y - - - left y coordinate - - - - - right_x - - - right x coordinate - - - - - bottom_y - - - right y coordinate - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - <function>ImagickDraw::setViewBox</function> example - - setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(2); - $draw->setFontSize(72); - - /* - - Sets the overall canvas size to be recorded with the drawing vector data. Usually this will be specified using the same size as the canvas image. When the vector data is saved to SVG or MVG formats, the viewbox is use to specify the size of the canvas image that a viewer will render the vector data on. - - */ - - $draw->circle(250, 250, 250, 0); - $draw->setviewbox(0, 0, 200, 200); - $draw->circle(125, 250, 250, 250); - $draw->translate(250, 125); - $draw->circle(0, 0, 125, 0); - - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/skewx.xml b/reference/imagick/imagickdraw/skewx.xml deleted file mode 100644 index 8aaf64231592..000000000000 --- a/reference/imagick/imagickdraw/skewx.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - ImagickDraw::skewX - Skews the current coordinate system in the horizontal direction - - - - &reftitle.description; - - public boolImagickDraw::skewX - floatdegrees - - &warn.undocumented.func; - - Skews the current coordinate system in the horizontal direction. - - - - - &reftitle.parameters; - - - - degrees - - - degrees to skew - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - <function>ImagickDraw::skewX</function> example - - setStrokeColor($strokeColor); - $draw->setStrokeWidth(2); - $draw->setFillColor($fillColor); - $draw->rectangle($startX, $startY, $endX, $endY); - $draw->setFillColor($fillModifiedColor); - $draw->skewX($skew); - $draw->rectangle($startX, $startY, $endX, $endY); - - $image = new \Imagick(); - $image->newImage(500, 500, $backgroundColor); - $image->setImageFormat("png"); - - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/skewy.xml b/reference/imagick/imagickdraw/skewy.xml deleted file mode 100644 index c4b2cd636457..000000000000 --- a/reference/imagick/imagickdraw/skewy.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - ImagickDraw::skewY - Skews the current coordinate system in the vertical direction - - - - &reftitle.description; - - public boolImagickDraw::skewY - floatdegrees - - &warn.undocumented.func; - - Skews the current coordinate system in the vertical direction. - - - - - &reftitle.parameters; - - - - degrees - - - degrees to skew - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - <function>ImagickDraw::skewY</function> example - - setStrokeColor($strokeColor); - $draw->setStrokeWidth(2); - $draw->setFillColor($fillColor); - $draw->rectangle($startX, $startY, $endX, $endY); - $draw->setFillColor($fillModifiedColor); - $draw->skewY($skew); - $draw->rectangle($startX, $startY, $endX, $endY); - - $image = new \Imagick(); - $image->newImage(500, 500, $backgroundColor); - $image->setImageFormat("png"); - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/translate.xml b/reference/imagick/imagickdraw/translate.xml deleted file mode 100644 index f0c371c19e34..000000000000 --- a/reference/imagick/imagickdraw/translate.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - ImagickDraw::translate - Applies a translation to the current coordinate system - - - - &reftitle.description; - - public boolImagickDraw::translate - floatx - floaty - - &warn.undocumented.func; - - Applies a translation to the current coordinate system which moves the - coordinate system origin to the specified coordinate. - - - - - &reftitle.parameters; - - - - x - - - horizontal translation - - - - - y - - - vertical translation - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - <function>ImagickDraw::translate</function> example - - setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->rectangle($startX, $startY, $endX, $endY); - - $draw->setFillColor($fillModifiedColor); - $draw->translate($translateX, $translateY); - $draw->rectangle($startX, $startY, $endX, $endY); - - $image = new \Imagick(); - $image->newImage(500, 500, $backgroundColor); - $image->setImageFormat("png"); - - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdrawexception.xml b/reference/imagick/imagickdrawexception.xml deleted file mode 100644 index a4a7465e17c2..000000000000 --- a/reference/imagick/imagickdrawexception.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - The ImagickDrawException class - ImagickDrawException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - - ImagickDrawException - - - - - ImagickDrawException - - - - extends - Exception - - - - Throwable - - - &InheritedProperties; - - - - &InheritedMethods; - - - - - - -
    - -
    - -
    - diff --git a/reference/imagick/imagickexception.xml b/reference/imagick/imagickexception.xml deleted file mode 100644 index 11b90c849859..000000000000 --- a/reference/imagick/imagickexception.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - The ImagickException class - ImagickException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - - ImagickException - - - - - ImagickException - - - - extends - Exception - - - - Throwable - - - &InheritedProperties; - - - - &InheritedMethods; - - - - - - -
    - -
    - -
    - diff --git a/reference/imagick/imagickkernel.xml b/reference/imagick/imagickkernel.xml deleted file mode 100644 index 4d355872a09b..000000000000 --- a/reference/imagick/imagickkernel.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - The ImagickKernel class - ImagickKernel - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - ImagickKernel - - - - - ImagickKernel - - - - - &Methods; - - - - -
    - -
    - - &reference.imagick.entities.imagickkernel; - -
    - - diff --git a/reference/imagick/imagickkernel/addkernel.xml b/reference/imagick/imagickkernel/addkernel.xml deleted file mode 100644 index edeeac5509be..000000000000 --- a/reference/imagick/imagickkernel/addkernel.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - ImagickKernel::addKernel - Attach another kernel to a kernel list - - - - &reftitle.description; - - public voidImagickKernel::addKernel - ImagickKernelImagickKernel - - - Attach another kernel to this kernel to allow them to both be applied in a single morphology or filter function. Returns the new combined kernel. - - - - - - &reftitle.parameters; - - - ImagickKernel - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - &reftitle.examples; - - - <function>ImagickKernel::addKernel</function> - - addKernel($kernel2); - - $imagick = new \Imagick(realpath($imagePath)); - $imagick->filter($kernel1); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); - -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickkernel/addunitykernel.xml b/reference/imagick/imagickkernel/addunitykernel.xml deleted file mode 100644 index 67ba07c8d079..000000000000 --- a/reference/imagick/imagickkernel/addunitykernel.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - - ImagickKernel::addUnityKernel - Adds a Unity Kernel to the kernel list - - - - &reftitle.description; - - public voidImagickKernel::addUnityKernel - floatscale - - - Adds a given amount of the 'Unity' Convolution Kernel to the given pre-scaled - and normalized Kernel. This in effect adds that amount of the original image - into the resulting convolution kernel. The resulting effect is to convert the - defined kernels into blended soft-blurs, unsharp kernels or into sharpening kernels. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - - &reftitle.examples; - - - <function>ImagickKernel::addUnityKernel</function> - - "; - - foreach ($matrix as $row) { - $output .= ""; - foreach ($row as $cell) { - $output .= ""; - if ($cell === false) { - $output .= "false"; - } - else { - $output .= round($cell, 3); - } - $output .= ""; - } - $output .= ""; - } - - $output .= ""; - - return $output; - } - - $matrix = [ - [-1, 0, -1], - [ 0, 4, 0], - [-1, 0, -1], - ]; - - $kernel = \ImagickKernel::fromMatrix($matrix); - $kernel->scale(1, \Imagick::NORMALIZE_KERNEL_VALUE); - $output = "Before adding unity kernel:
    "; - $output .= renderKernelTable($kernel->getMatrix()); - $kernel->addUnityKernel(0.5); - $output .= "After adding unity kernel:
    "; - $output .= renderKernelTable($kernel->getMatrix()); - - - $kernel->scale(1, \Imagick::NORMALIZE_KERNEL_VALUE); - $output .= "After renormalizing kernel:
    "; - $output .= renderKernelTable($kernel->getMatrix()); - - echo $output; - -?> -]]> -
    -
    - - - <function>ImagickKernel::addUnityKernel</function> - - scale(4, \Imagick::NORMALIZE_KERNEL_VALUE); - $kernel->addUnityKernel(0.5); - - - $imagick = new \Imagick(realpath($imagePath)); - $imagick->filter($kernel); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); - -} - -?> -]]> - - -
    -
    - -
    - - diff --git a/reference/imagick/imagickkernel/frombuiltin.xml b/reference/imagick/imagickkernel/frombuiltin.xml deleted file mode 100644 index f5eae3ec7b27..000000000000 --- a/reference/imagick/imagickkernel/frombuiltin.xml +++ /dev/null @@ -1,212 +0,0 @@ - - - - - - ImagickKernel::fromBuiltIn - Create a kernel from a builtin in kernel - - - - &reftitle.description; - - public static ImagickKernelImagickKernel::fromBuiltin - intkernelType - stringkernelString - - - Create a kernel from a builtin in kernel. See http://www.imagemagick.org/Usage/morphology/#kernel for examples. Currently the 'rotation' symbols are not supported. Example: - $diamondKernel = ImagickKernel::fromBuiltIn(\Imagick::KERNEL_DIAMOND, "2"); - - - - - - &reftitle.parameters; - - - kerneltype - - - The type of kernel to build e.g. \Imagick::KERNEL_DIAMOND - - - - - kernelString - - - A string that describes the parameters e.g. "4,2.5" - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - &reftitle.examples; - - - <function>ImagickKernel::fromBuiltin</function> - - getMatrix(); - - $imageMargin = 20; - - $tileSize = 20; - $tileSpace = 4; - $shadowSigma = 4; - $shadowDropX = 20; - $shadowDropY = 0; - - $radius = ($tileSize / 2) * 0.9; - - $rows = count($matrix); - $columns = count($matrix[0]); - - $imagickDraw = new \ImagickDraw(); - - $imagickDraw->setFillColor('#afafaf'); - $imagickDraw->setStrokeColor('none'); - - $imagickDraw->translate($imageMargin, $imageMargin); - $imagickDraw->push(); - - ksort($matrix); - - foreach ($matrix as $row) { - ksort($row); - $imagickDraw->push(); - foreach ($row as $cell) { - if ($cell !== false) { - $color = intval(255 * $cell); - $colorString = sprintf("rgb(%f, %f, %f)", $color, $color, $color); - $imagickDraw->setFillColor($colorString); - $imagickDraw->rectangle(0, 0, $tileSize, $tileSize); - } - $imagickDraw->translate(($tileSize + $tileSpace), 0); - } - $imagickDraw->pop(); - $imagickDraw->translate(0, ($tileSize + $tileSpace)); - } - - $imagickDraw->pop(); - - $width = ($columns * $tileSize) + (($columns - 1) * $tileSpace); - $height = ($rows * $tileSize) + (($rows - 1) * $tileSpace); - - $imagickDraw->push(); - $imagickDraw->translate($width/2 , $height/2); - $imagickDraw->setFillColor('rgba(0, 0, 0, 0)'); - $imagickDraw->setStrokeColor('white'); - $imagickDraw->circle(0, 0, $radius - 1, 0); - $imagickDraw->setStrokeColor('black'); - $imagickDraw->circle(0, 0, $radius, 0); - $imagickDraw->pop(); - - $canvasWidth = $width + (2 * $imageMargin); - $canvasHeight = $height + (2 * $imageMargin); - - $kernel = new \Imagick(); - $kernel->newPseudoImage( - $canvasWidth, - $canvasHeight, - 'canvas:none' - ); - - $kernel->setImageFormat('png'); - $kernel->drawImage($imagickDraw); - - /* create drop shadow on it's own layer */ - $canvas = $kernel->clone(); - $canvas->setImageBackgroundColor(new \ImagickPixel('rgb(0, 0, 0)')); - $canvas->shadowImage(100, $shadowSigma, $shadowDropX, $shadowDropY); - - $canvas->setImagePage($canvasWidth, $canvasHeight, -5, -5); - $canvas->cropImage($canvasWidth, $canvasHeight, 0, 0); - - /* composite original text_layer onto shadow_layer */ - $canvas->compositeImage($kernel, \Imagick::COMPOSITE_OVER, 0, 0); - $canvas->setImageFormat('png'); - - return $canvas; -} - - -function createFromBuiltin($kernelType, $kernelFirstTerm, $kernelSecondTerm, $kernelThirdTerm) { - $string = ''; - - if ($kernelFirstTerm != false && strlen(trim($kernelFirstTerm)) != 0) { - $string .= $kernelFirstTerm; - - if ($kernelSecondTerm != false && strlen(trim($kernelSecondTerm)) != 0) { - $string .= ','.$kernelSecondTerm; - if ($kernelThirdTerm != false && strlen(trim($kernelThirdTerm)) != 0) { - $string .= ','.$kernelThirdTerm; - } - } - } - - $kernel = ImagickKernel::fromBuiltIn( - $kernelType, - $string - ); - - return $kernel; -} - -function fromBuiltin($kernelType, $kernelFirstTerm, $kernelSecondTerm, $kernelThirdTerm) { - $diamondKernel = createFromBuiltin($kernelType, $kernelFirstTerm, $kernelSecondTerm, $kernelThirdTerm); - $imagick = renderKernel($diamondKernel); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -fromBuiltin(\Imagick::KERNEL_DIAMOND, 2, false, false); - - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickkernel/frommatrix.xml b/reference/imagick/imagickkernel/frommatrix.xml deleted file mode 100644 index b9b1af695444..000000000000 --- a/reference/imagick/imagickkernel/frommatrix.xml +++ /dev/null @@ -1,199 +0,0 @@ - - - - - - ImagickKernel::fromMatrix - Create a kernel from a 2d matrix of values - - - - &reftitle.description; - - public static ImagickKernelImagickKernel::fromMatrix - arraymatrix - arrayorigin - - - Create a kernel from an 2d matrix of values. Each value should either be a float - (if the element should be used) or 'false' if the element should be skipped. For - matrices that are odd sizes in both dimensions the origin pixel will default - to the centre of the kernel. For all other kernel sizes the origin pixel must be specified. - - - - - - &reftitle.parameters; - - - array - - - A matrix (i.e. 2d array) of values that define the kernel. Each element should be either a float value, or FALSE if that element shouldn't be used by the kernel. - - - - - array - - - Which element of the kernel should be used as the origin pixel. e.g. For a 3x3 matrix specifying the origin as [2, 2] would specify that the bottom right element should be the origin pixel. - - - - - - - - &reftitle.returnvalues; - - The generated ImagickKernel. - - - - - - - - &reftitle.examples; - - - <function>ImagickKernel::fromMatrix</function> - - getMatrix(); - - $imageMargin = 20; - - $tileSize = 20; - $tileSpace = 4; - $shadowSigma = 4; - $shadowDropX = 20; - $shadowDropY = 0; - - $radius = ($tileSize / 2) * 0.9; - - $rows = count($matrix); - $columns = count($matrix[0]); - - $imagickDraw = new \ImagickDraw(); - - $imagickDraw->setFillColor('#afafaf'); - $imagickDraw->setStrokeColor('none'); - - $imagickDraw->translate($imageMargin, $imageMargin); - $imagickDraw->push(); - - ksort($matrix); - - foreach ($matrix as $row) { - ksort($row); - $imagickDraw->push(); - foreach ($row as $cell) { - if ($cell !== false) { - $color = intval(255 * $cell); - $colorString = sprintf("rgb(%f, %f, %f)", $color, $color, $color); - $imagickDraw->setFillColor($colorString); - $imagickDraw->rectangle(0, 0, $tileSize, $tileSize); - } - $imagickDraw->translate(($tileSize + $tileSpace), 0); - } - $imagickDraw->pop(); - $imagickDraw->translate(0, ($tileSize + $tileSpace)); - } - - $imagickDraw->pop(); - - $width = ($columns * $tileSize) + (($columns - 1) * $tileSpace); - $height = ($rows * $tileSize) + (($rows - 1) * $tileSpace); - - $imagickDraw->push(); - $imagickDraw->translate($width/2 , $height/2); - $imagickDraw->setFillColor('rgba(0, 0, 0, 0)'); - $imagickDraw->setStrokeColor('white'); - $imagickDraw->circle(0, 0, $radius - 1, 0); - $imagickDraw->setStrokeColor('black'); - $imagickDraw->circle(0, 0, $radius, 0); - $imagickDraw->pop(); - - $canvasWidth = $width + (2 * $imageMargin); - $canvasHeight = $height + (2 * $imageMargin); - - $kernel = new \Imagick(); - $kernel->newPseudoImage( - $canvasWidth, - $canvasHeight, - 'canvas:none' - ); - - $kernel->setImageFormat('png'); - $kernel->drawImage($imagickDraw); - - /* create drop shadow on it's own layer */ - $canvas = $kernel->clone(); - $canvas->setImageBackgroundColor(new \ImagickPixel('rgb(0, 0, 0)')); - $canvas->shadowImage(100, $shadowSigma, $shadowDropX, $shadowDropY); - - $canvas->setImagePage($canvasWidth, $canvasHeight, -5, -5); - $canvas->cropImage($canvasWidth, $canvasHeight, 0, 0); - - /* composite original text_layer onto shadow_layer */ - $canvas->compositeImage($kernel, \Imagick::COMPOSITE_OVER, 0, 0); - $canvas->setImageFormat('png'); - - return $canvas; -} - -function createFromMatrix() { - $matrix = [ - [0.5, 0, 0.2], - [0, 1, 0], - [0.9, 0, false], - ]; - - $kernel = \ImagickKernel::fromMatrix($matrix); - - return $kernel; -} - -function fromMatrix() { - $kernel = createFromMatrix(); - $imagick = renderKernel($kernel); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickkernel/getmatrix.xml b/reference/imagick/imagickkernel/getmatrix.xml deleted file mode 100644 index 574c498d3cde..000000000000 --- a/reference/imagick/imagickkernel/getmatrix.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - ImagickKernel::getMatrix - Get the 2d matrix of values used in this kernel - - - - &reftitle.description; - - public arrayImagickKernel::getMatrix - - - - Get the 2d matrix of values used in this kernel. The elements are either - float for elements that are used or 'false' if the element should be skipped. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A matrix (2d array) of the values that represent the kernel. - - - - - - - - &reftitle.examples; - - - <function>ImagickKernel::getMatrix</function> - - "; - - foreach ($matrix as $row) { - $output .= ""; - foreach ($row as $cell) { - $output .= ""; - if ($cell === false) { - $output .= "false"; - } - else { - $output .= round($cell, 3); - } - $output .= ""; - } - $output .= ""; - } - - $output .= ""; - - return $output; -} - - $output = "The built-in kernel name 'ring' with parameters of '2,3.5':
    "; - $kernel = \ImagickKernel::fromBuiltIn( - \Imagick::KERNEL_RING, - "2,3.5" - ); - $matrix = $kernel->getMatrix(); - $output .= renderKernelTable($matrix); - - echo $output; - -?> -]]> -
    -
    -
    -
    - -
    - - diff --git a/reference/imagick/imagickkernel/scale.xml b/reference/imagick/imagickkernel/scale.xml deleted file mode 100644 index 41ab37f0c700..000000000000 --- a/reference/imagick/imagickkernel/scale.xml +++ /dev/null @@ -1,166 +0,0 @@ - - - - - - ImagickKernel::scale - Scales a kernel list by the given amount - - - - &reftitle.description; - - public voidImagickKernel::scale - floatscale - intnormalizeFlag - - - Scales the given kernel list by the given amount, with or without - normalization of the sum of the kernel values (as per given flags). - - The exact behaviour of this function depends on the normalization type being used - please see http://www.imagemagick.org/api/morphology.php#ScaleKernelInfo for details. - - - - - - - &reftitle.parameters; - - - - scale - - - - - - - - normalizeFlag - - - - Imagick::NORMALIZE_KERNEL_NONE - Imagick::NORMALIZE_KERNEL_VALUE - Imagick::NORMALIZE_KERNEL_CORRELATE - Imagick::NORMALIZE_KERNEL_PERCENT - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - &reftitle.examples; - - - <function>ImagickKernel::scale</function> - - "; - - foreach ($matrix as $row) { - $output .= ""; - foreach ($row as $cell) { - $output .= ""; - if ($cell === false) { - $output .= "false"; - } - else { - $output .= round($cell, 3); - } - $output .= ""; - } - $output .= ""; - } - - $output .= ""; - - return $output; - } - - - $output = ""; - - $matrix = [ - [-1, 0, -1], - [ 0, 4, 0], - [-1, 0, -1], - ]; - - $kernel = \ImagickKernel::fromMatrix($matrix); - $kernelClone = clone $kernel; - - $output .= "Start kernel
    "; - $output .= renderKernelTable($kernel->getMatrix()); - - - $output .= "Scaling with NORMALIZE_KERNEL_VALUE. The
    "; - $kernel->scale(2, \Imagick::NORMALIZE_KERNEL_VALUE); - $output .= renderKernelTable($kernel->getMatrix()); - - - $kernel = clone $kernelClone; - $output .= "Scaling by percent
    "; - $kernel->scale(2, \Imagick::NORMALIZE_KERNEL_PERCENT); - $output .= renderKernelTable($kernel->getMatrix()); - - $matrix2 = [ - [-1, -1, 1], - [ -1, false, 1], - [1, 1, 1], - ]; - - $kernel = \ImagickKernel::fromMatrix($matrix2); - $output .= "Scaling by correlate
    "; - $kernel->scale(1, \Imagick::NORMALIZE_KERNEL_CORRELATE); - $output .= renderKernelTable($kernel->getMatrix()); - - return $output; -?> -]]> -
    -
    -
    -
    - -
    - - diff --git a/reference/imagick/imagickkernel/separate.xml b/reference/imagick/imagickkernel/separate.xml deleted file mode 100644 index 40fe0beb0e31..000000000000 --- a/reference/imagick/imagickkernel/separate.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - ImagickKernel::separate - Separates a linked set of kernels and returns an array of ImagickKernels - - - - &reftitle.description; - - public arrayImagickKernel::separate - - - - Separates a linked set of kernels and returns an array of ImagickKernels. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - - &reftitle.examples; - - - <function>ImagickKernel::separate</function> - - "; - foreach ($matrix as $row) { - $output .= ""; - foreach ($row as $cell) { - $output .= ""; - if ($cell === false) { - $output .= "false"; - } - else { - $output .= round($cell, 3); - } - $output .= ""; - } - $output .= ""; - } - - $output .= ""; - - return $output; - } - - - $matrix = [ - [-1, 0, -1], - [ 0, 4, 0], - [-1, 0, -1], - ]; - - $kernel = \ImagickKernel::fromMatrix($matrix); - $kernel->scale(4, \Imagick::NORMALIZE_KERNEL_VALUE); - $diamondKernel = \ImagickKernel::fromBuiltIn( - \Imagick::KERNEL_DIAMOND, - "2" - ); - - $kernel->addKernel($diamondKernel); - - $kernelList = $kernel->separate(); - - $output = ''; - $count = 0; - foreach ($kernelList as $kernel) { - $output .= "
    Kernel $count
    "; - $output .= renderKernelTable($kernel->getMatrix()); - $count++; - } - - return $output; - -?> -]]> -
    -
    -
    -
    - -
    - - diff --git a/reference/imagick/imagickkernelexception.xml b/reference/imagick/imagickkernelexception.xml deleted file mode 100644 index 712bf1e9e17b..000000000000 --- a/reference/imagick/imagickkernelexception.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - The ImagickKernelException class - ImagickKernelException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - ImagickKernelException - - - - - ImagickKernelException - - - - extends - Exception - - - - &InheritedProperties; - - - - &InheritedMethods; - - - - - - -
    - -
    - -
    - - diff --git a/reference/imagick/imagickpixel.xml b/reference/imagick/imagickpixel.xml deleted file mode 100644 index 699686f4bae6..000000000000 --- a/reference/imagick/imagickpixel.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - - The <classname>ImagickPixel</classname> class - ImagickPixel - -
    - &reftitle.classsynopsis; - - ImagickPixel - - ImagickPixel - - - -
    -
    - &reference.imagick.entities.imagickpixel; -
    - - diff --git a/reference/imagick/imagickpixel/clear.xml b/reference/imagick/imagickpixel/clear.xml deleted file mode 100644 index 6257adef10d9..000000000000 --- a/reference/imagick/imagickpixel/clear.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - ImagickPixel::clear - Clears resources associated with this object - - - - &reftitle.description; - - public boolImagickPixel::clear - - - &warn.undocumented.func; - - Clears the ImagickPixel object, leaving it in a fresh state. This also - unsets any color associated with the object. - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagickpixel/construct.xml b/reference/imagick/imagickpixel/construct.xml deleted file mode 100644 index 59e249d52fdd..000000000000 --- a/reference/imagick/imagickpixel/construct.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - ImagickPixel::__construct - The ImagickPixel constructor - - - - &reftitle.description; - - public ImagickPixel::__construct - stringcolor - - &warn.undocumented.func; - - Constructs an ImagickPixel object. If a color is specified, the object is - constructed and then initialised with that color before being returned. - - - - - &reftitle.parameters; - - - - color - - - The optional color string to use as the initial value of this object. - - - - - - - - - &reftitle.returnvalues; - - Returns an ImagickPixel object on success, throwing ImagickPixelException on - failure. - - - - - - - &reftitle.examples; - - - <function>ImagickPixel::construct</function> - - setstrokewidth(1.0); - $draw->setStrokeColor($black); - $draw->setFillColor($color); - $offsetX = ($count % $columns) * 50 + 5; - $offsetY = intval($count / $columns) * 50 + 5; - $draw->rectangle(0 + $offsetX, 0 + $offsetY, 40 + $offsetX, 40 + $offsetY); - $count++; - } - - $image = new \Imagick(); - $image->newImage(350, 350, "blue"); - $image->setImageFormat("png"); - $image->drawImage($draw); - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickpixel/destroy.xml b/reference/imagick/imagickpixel/destroy.xml deleted file mode 100644 index 1a45dae91947..000000000000 --- a/reference/imagick/imagickpixel/destroy.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - ImagickPixel::destroy - Deallocates resources associated with this object - - - - &reftitle.description; - - public boolImagickPixel::destroy - - - &warn.undocumented.func; - - Deallocates any resources used by the ImagickPixel object, and unsets any - associated color. The object should not be used after the destroy function - has been called. - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagickpixel/getcolor.xml b/reference/imagick/imagickpixel/getcolor.xml deleted file mode 100644 index 7bd38098f945..000000000000 --- a/reference/imagick/imagickpixel/getcolor.xml +++ /dev/null @@ -1,165 +0,0 @@ - - - - - ImagickPixel::getColor - Returns the color - - - - &reftitle.description; - - public arrayImagickPixel::getColor - intnormalized0 - - - Returns the color described by the ImagickPixel object, as an array. If the color has an - opacity channel set, this is provided as a fourth value in the list. - - - - - &reftitle.parameters; - - - - normalized - - - Normalize the color values. Possible values are 0, - 1 or 2. - - - - - List of possible values for <parameter>normalized</parameter> - - - - - normalized - Description - - - - - - 0 - - - The RGB values are returned as ints in the range 0 - to 255 (inclusive.) - The alpha value is returned as int and is either 0 - or 1. - - - - - 1 - - - The RGBA values are returned as floats in the range 0 - to 1 (inclusive.) - - - - - 2 - - - The RGBA values are returned as ints in the range 0 - to 255 (inclusive.) - - - - -
    -
    -
    -
    -
    -
    - - - &reftitle.returnvalues; - - An array of channel values. Throws ImagickPixelException on error. - - - - - &reftitle.examples; - - - Basic <function>Imagick::getColor</function> usage - -setColorValue(Imagick::COLOR_ALPHA, 64 / 256.0); - -$colorInfo = $color->getColor(); - -echo "Standard values".PHP_EOL; -print_r($colorInfo); - -$colorInfo = $color->getColor(1); - -echo "Normalized values:".PHP_EOL; -print_r($colorInfo); - -?> -]]> - - &example.outputs; - - 165 - [g] => 42 - [b] => 42 - [a] => 0 -) -Normalized values: -Array -( - [r] => 0.64705882352941 - [g] => 0.16470588235294 - [b] => 0.16470588235294 - [a] => 0.25000381475547 -) - ]]> - - - - - -
    - - - diff --git a/reference/imagick/imagickpixel/getcolorasstring.xml b/reference/imagick/imagickpixel/getcolorasstring.xml deleted file mode 100644 index d8ebf44c11fc..000000000000 --- a/reference/imagick/imagickpixel/getcolorasstring.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - ImagickPixel::getColorAsString - Returns the color as a string - - - - &reftitle.description; - - public stringImagickPixel::getColorAsString - - - - Returns the color of the ImagickPixel object as a string. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the color of the ImagickPixel object as a string. - - - - - &reftitle.examples; - - - Basic <function>Imagick::getColorAsString</function> usage - -setColorValue(Imagick::COLOR_ALPHA, 64 / 256.0); - -$colorInfo = $color->getColorAsString(); - -print_r($colorInfo); -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.notes; - - Alpha not returned - - This function does not return the alpha value of the color in the string. - - - - - - - - diff --git a/reference/imagick/imagickpixel/getcolorcount.xml b/reference/imagick/imagickpixel/getcolorcount.xml deleted file mode 100644 index 8c091ec431bb..000000000000 --- a/reference/imagick/imagickpixel/getcolorcount.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - ImagickPixel::getColorCount - Returns the color count associated with this color - - - - &reftitle.description; - - public intImagickPixel::getColorCount - - - - Returns the color count associated with this color. - - The color count is the number of pixels in the image that have the same color as this ImagickPixel. - - - ImagickPixel::getColorCount appears to only work for ImagickPixel objects created through Imagick::getImageHistogram() - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the color count as an integer on success, throws - ImagickPixelException on failure. - - - - &reftitle.examples; - - - ImagickPixel <function>getColorCount</function> - - newPseudoImage(640, 480, "magick:logo"); - $histogramElements = $imagick->getImageHistogram(); - $lastColor = array_pop($histogramElements); - echo "Last pixel color count is: ".$lastColor->getColorCount(); -?> -]]> - - -The output for this will be similar to: - - - - - - - - - - - diff --git a/reference/imagick/imagickpixel/getcolorquantum.xml b/reference/imagick/imagickpixel/getcolorquantum.xml deleted file mode 100644 index c2d479e8cc4c..000000000000 --- a/reference/imagick/imagickpixel/getcolorquantum.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - ImagickPixel::getColorQuantum - Returns the color of the pixel in an array as Quantum values - - - - &reftitle.description; - - public arrayImagickPixel::getColorQuantum - - - - Returns the color of the pixel in an array as Quantum values. If ImageMagick was compiled - as HDRI these will be floats, otherwise they will be integers. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an array with keys "r", "g", - "b", "a". - - - - - - - diff --git a/reference/imagick/imagickpixel/getcolorvalue.xml b/reference/imagick/imagickpixel/getcolorvalue.xml deleted file mode 100644 index e47179bda350..000000000000 --- a/reference/imagick/imagickpixel/getcolorvalue.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - ImagickPixel::getColorValue - Gets the normalized value of the provided color channel - - - - &reftitle.description; - - public floatImagickPixel::getColorValue - intcolor - - - Retrieves the value of the color channel specified, as a floating-point - number between 0 and 1. - - - - - &reftitle.parameters; - - - - color - - - The color to get the value of, specified as one of the Imagick color - constants. This can be one of the RGB colors, CMYK colors, alpha and - opacity e.g (Imagick::COLOR_BLUE, Imagick::COLOR_MAGENTA). - - - - - - - - - &reftitle.returnvalues; - - The value of the channel, as a normalized floating-point number, throwing - ImagickPixelException on error. - - - - - &reftitle.examples; - - - Basic <function>Imagick::getColorValue</function> usage - -getColorValue(Imagick::COLOR_ALPHA).PHP_EOL; -echo "".PHP_EOL; -echo "Red value is ".$color->getColorValue(Imagick::COLOR_RED).PHP_EOL; -echo "Green value is ".$color->getColorValue(Imagick::COLOR_GREEN).PHP_EOL; -echo "Blue value is ".$color->getColorValue(Imagick::COLOR_BLUE).PHP_EOL; -echo "".PHP_EOL; -echo "Cyan value is ".$color->getColorValue(Imagick::COLOR_CYAN).PHP_EOL; -echo "Magenta value is ".$color->getColorValue(Imagick::COLOR_MAGENTA).PHP_EOL; -echo "Yellow value is ".$color->getColorValue(Imagick::COLOR_YELLOW).PHP_EOL; -echo "Black value is ".$color->getColorValue(Imagick::COLOR_BLACK).PHP_EOL; - -?> -]]> - - &example.outputs; - - - - - - - - - - diff --git a/reference/imagick/imagickpixel/getcolorvaluequantum.xml b/reference/imagick/imagickpixel/getcolorvaluequantum.xml deleted file mode 100644 index bee7eb3cb506..000000000000 --- a/reference/imagick/imagickpixel/getcolorvaluequantum.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - ImagickPixel::getColorValueQuantum - Gets the quantum value of a color in the ImagickPixel - - - - &reftitle.description; - - public intfloatImagickPixel::getColorValueQuantum - intcolor - - - Gets the quantum value of a color in the ImagickPixel. Return value is a float if ImageMagick was compiled with HDRI, otherwise an integer. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The quantum value of the color element. Float if ImageMagick was compiled with HDRI, otherwise an int. - - - - - - - - &reftitle.examples; - - - <function>ImagickPixel::getColorValueQuantum</function> - - getColorValueQuantum(\Imagick::COLOR_RED); - $colorGreen = $color->getColorValueQuantum(\Imagick::COLOR_GREEN); - $colorBlue = $color->getColorValueQuantum(\Imagick::COLOR_BLUE); - $colorAlpha = $color->getColorValueQuantum(\Imagick::COLOR_ALPHA); - - printf( - "Red: %s Green: %s Blue %s Alpha: %s", - $colorRed, - $colorGreen, - $colorBlue, - $colorAlpha - ); - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickpixel/gethsl.xml b/reference/imagick/imagickpixel/gethsl.xml deleted file mode 100644 index 48fff13df9eb..000000000000 --- a/reference/imagick/imagickpixel/gethsl.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - ImagickPixel::getHSL - Returns the normalized HSL color of the ImagickPixel object - - - - &reftitle.description; - - public arrayImagickPixel::getHSL - - - - Returns the normalized HSL color described by the ImagickPixel object, - with each of the three values as floating point numbers between 0.0 - and 1.0. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the HSL value in an array with the keys "hue", - "saturation", and "luminosity". Throws ImagickPixelException on failure. - - - - - &reftitle.examples; - - - Basic <function>Imagick::getHSL</function> example - -getHSL(); - -print_r($colorInfo); - -?> -]]> - - &example.outputs; - - 0 - [saturation] => 0.80001220740379 - [luminosity] => 0.50000762951095 -) -]]> - - - - - - - &reftitle.notes; - - - Available with ImageMagick library version 6.2.9 and higher. - - - - - - - diff --git a/reference/imagick/imagickpixel/getindex.xml b/reference/imagick/imagickpixel/getindex.xml deleted file mode 100644 index 73eeacb2530e..000000000000 --- a/reference/imagick/imagickpixel/getindex.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - ImagickPixel::getIndex - Gets the colormap index of the pixel wand - - - - &reftitle.description; - - public intImagickPixel::getIndex - - - - Gets the colormap index of the pixel wand. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/imagick/imagickpixel/ispixelsimilar.xml b/reference/imagick/imagickpixel/ispixelsimilar.xml deleted file mode 100644 index bffea0051043..000000000000 --- a/reference/imagick/imagickpixel/ispixelsimilar.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - ImagickPixel::isPixelSimilar - Check the distance between this color and another - - - - &reftitle.description; - - public boolImagickPixel::isPixelSimilar - ImagickPixelcolor - floatfuzz - - - Checks the distance between the color described by this ImagickPixel - object and that of the provided object, by plotting their RGB values - on the color cube. If the distance between the two points is less than - the fuzz value given, the colors are similar. - This method replaces ImagickPixel::isSimilar() - and correctly normalises the fuzz value to ImageMagick QuantumRange. - - - - - &reftitle.parameters; - - - - color - - - The ImagickPixel object to compare this object against. - - - - - fuzz - - - The maximum distance within which to consider these colors as similar. - The theoretical maximum for this value is the square root of three - (1.732). - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagickpixel/ispixelsimilarquantum.xml b/reference/imagick/imagickpixel/ispixelsimilarquantum.xml deleted file mode 100644 index a7938489cf6e..000000000000 --- a/reference/imagick/imagickpixel/ispixelsimilarquantum.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - ImagickPixel::isPixelSimilarQuantum - Returns whether two colors differ by less than the specified distance - - - - &reftitle.description; - - public boolImagickPixel::isPixelSimilarQuantum - stringcolor - stringfuzz - - - Returns true if the distance between two colors is less than the specified distance. - The fuzz value should be in the range 0-QuantumRange. - The maximum value represents the longest possible distance in the colorspace. - e.g. from RGB(0, 0, 0) to RGB(255, 255, 255) for the RGB colorspace - - - - - - &reftitle.parameters; - - - color - - - - - - - - fuzz - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/imagick/imagickpixel/issimilar.xml b/reference/imagick/imagickpixel/issimilar.xml deleted file mode 100644 index 9d553ccf0d8e..000000000000 --- a/reference/imagick/imagickpixel/issimilar.xml +++ /dev/null @@ -1,175 +0,0 @@ - - - - - ImagickPixel::isSimilar - Check the distance between this color and another - - - - &reftitle.description; - - public boolImagickPixel::isSimilar - ImagickPixelcolor - floatfuzz - - &warn.undocumented.func; - - Checks the distance between the color described by this ImagickPixel - object and that of the provided object, by plotting their RGB values - on the color cube. If the distance between the two points is less than - the fuzz value given, the colors are similar. - Deprecated in favour of ImagickPixel::isPixelSimilar(). - - - - - &reftitle.parameters; - - - - color - - - The ImagickPixel object to compare this object against. - - - - - fuzz - - - The maximum distance within which to consider these colors as similar. - The theoretical maximum for this value is the square root of three - (1.732). - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>ImagickPixel::isSimilar</function> - - - - - Color 1 - - - Color 2 - - - Test distance * 255 - - - Is within distance - - - "; - - $output .= ""; - - foreach ($tests as $testInfo) { - $color1 = $testInfo[0]; - $color2 = $testInfo[1]; - $distance = $testInfo[2]; - $expectation = $testInfo[3]; - $testDistance = ($distance / 255.0); - - $color1Pixel = new \ImagickPixel($color1); - $color2Pixel = new \ImagickPixel($color2); - - $isSimilar = $color1Pixel->isPixelSimilar($color2Pixel, $testDistance); - - - if ($isSimilar !== $expectation) { - echo "Test distance failed. Color [$color1] compared to color [$color2] is not within distance $testDistance FAILED.".NL; - } - - $layout = " - %s - %s - %s - %s - "; - - $output .= sprintf( - $layout, - $color1, - $color2, - $distance, - $isSimilar ? 'yes' : 'no' - ); - } - - $output .= ""; - - return $output; - -?> -]]> - - - - - - - - - diff --git a/reference/imagick/imagickpixel/setcolor.xml b/reference/imagick/imagickpixel/setcolor.xml deleted file mode 100644 index 2bc18b3e4401..000000000000 --- a/reference/imagick/imagickpixel/setcolor.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - ImagickPixel::setColor - Sets the color - - - - &reftitle.description; - - public boolImagickPixel::setColor - stringcolor - - &warn.undocumented.func; - - Sets the color described by the ImagickPixel object, with a string - (e.g. "blue", "#0000ff", "rgb(0,0,255)", "cmyk(100,100,100,10)", etc.). - - - - - &reftitle.parameters; - - - - color - - - The color definition to use in order to initialise the - ImagickPixel object. - - - - - - - - - &reftitle.returnvalues; - - Returns &true; if the specified color was set, &false; otherwise. - - - - - - - &reftitle.examples; - - - <function>ImagickPixel::setColor</function> - - setColor('rgba(100%, 75%, 0%, 1.0)'); - - $draw->setstrokewidth(3.0); - $draw->setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->rectangle(200, 200, 300, 300); - - $image = new \Imagick(); - $image->newImage(500, 500, "SteelBlue2"); - $image->setImageFormat("png"); - - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickpixel/setcolorcount.xml b/reference/imagick/imagickpixel/setcolorcount.xml deleted file mode 100644 index 6c32bfac6ef8..000000000000 --- a/reference/imagick/imagickpixel/setcolorcount.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - ImagickPixel::setColorCount - Sets the color count associated with this color - - - - &reftitle.description; - - public boolImagickPixel::setcolorcount - intcolorCount - - - Sets the color count associated with this color. - - - - - - &reftitle.parameters; - - - colorCount - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - diff --git a/reference/imagick/imagickpixel/setcolorvalue.xml b/reference/imagick/imagickpixel/setcolorvalue.xml deleted file mode 100644 index d28d35cf3924..000000000000 --- a/reference/imagick/imagickpixel/setcolorvalue.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - ImagickPixel::setColorValue - Sets the normalized value of one of the channels - - - - &reftitle.description; - - public boolImagickPixel::setColorValue - intcolor - floatvalue - - - Sets the value of the specified channel of this object to the provided - value, which should be between 0 and 1. This function can be used to - provide an opacity channel to an ImagickPixel object. - - - - - &reftitle.parameters; - - - - color - - - One of the Imagick color constants e.g. \Imagick::COLOR_GREEN or \Imagick::COLOR_ALPHA. - - - - - value - - - The value to set this channel to, ranging from 0 to 1. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Basic <function>Imagick::setColorValue</function> usage - -setColorValue(Imagick::COLOR_ALPHA, 0.5); - -print_r($color->getcolor(true)); -?> -]]> - - &example.outputs; - - 0.69803921568627 - [g] => 0.13333333333333 - [b] => 0.13333333333333 - [a] => 0.50000762951095 -) -]]> - - - - - - - - diff --git a/reference/imagick/imagickpixel/setcolorvaluequantum.xml b/reference/imagick/imagickpixel/setcolorvaluequantum.xml deleted file mode 100644 index c70c3adeec0a..000000000000 --- a/reference/imagick/imagickpixel/setcolorvaluequantum.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - ImagickPixel::setColorValueQuantum - Sets the quantum value of a color element of the ImagickPixel - - - - &reftitle.description; - - public boolImagickPixel::setColorValueQuantum - intcolor - intfloatvalue - - - Sets the quantum value of a color element of the ImagickPixel. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - color - - - Which color element to set e.g. \Imagick::COLOR_GREEN. - - - - - - - value - - - The quantum value to set the color element to. This should be a float if ImageMagick was compiled with HDRI otherwise an int in the range 0 to Imagick::getQuantum(). - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - - &reftitle.examples; - - - <function>ImagickPixel::setColorValueQuantum</function> - - getQuantumRange(); - - $draw = new \ImagickDraw(); - $color = new \ImagickPixel('blue'); - $color->setcolorValueQuantum(\Imagick::COLOR_RED, 128 * $quantumRange['quantumRangeLong'] / 256); - - $draw->setstrokewidth(1.0); - $draw->setStrokeColor($color); - $draw->setFillColor($color); - $draw->rectangle(200, 200, 300, 300); - - $image->newImage(500, 500, "SteelBlue2"); - $image->setImageFormat("png"); - - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickpixel/sethsl.xml b/reference/imagick/imagickpixel/sethsl.xml deleted file mode 100644 index 492b10cd0efc..000000000000 --- a/reference/imagick/imagickpixel/sethsl.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - ImagickPixel::setHSL - Sets the normalized HSL color - - - - &reftitle.description; - - public boolImagickPixel::setHSL - floathue - floatsaturation - floatluminosity - - - Sets the color described by the ImagickPixel object using normalized - values for hue, saturation and luminosity. - - - - - &reftitle.parameters; - - - - hue - - - The normalized value for hue, described as a fractional arc - (between 0 and 1) of the hue circle, where the zero value is - red. - - - - - saturation - - - The normalized value for saturation, with 1 as full saturation. - - - - - luminosity - - - The normalized value for luminosity, on a scale from black at - 0 to white at 1, with the full HS value at 0.5 luminosity. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Use <function>ImagickPixel::setHSL</function> to modify a color - - getHSL(); - -//Rotate the hue by 180 degrees -$newHue = $colorInfo['hue'] + 0.5; -if ($newHue > 1) { - $newHue = $newHue - 1; -} - -//Set the ImagickPixel to the new color -$colorInfo = $color->setHSL($newHue, $colorInfo['saturation'], $colorInfo['luminosity']); - -//Check that the new color is blue/green -$colorInfo = $color->getcolor(); -print_r($colorInfo); - -?> - ]]> - - &example.outputs; - - 26 - [g] => 230 - [b] => 230 - [a] => 255 -) -]]> - - - - - - - &reftitle.notes; - - - Available with ImageMagick library version 6.2.9 and higher. - - - - - - - diff --git a/reference/imagick/imagickpixel/setindex.xml b/reference/imagick/imagickpixel/setindex.xml deleted file mode 100644 index 0a2dec909c20..000000000000 --- a/reference/imagick/imagickpixel/setindex.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - ImagickPixel::setIndex - Sets the colormap index of the pixel wand - - - - &reftitle.description; - - public boolImagickPixel::setIndex - intindex - - - Sets the colormap index of the pixel wand. - - - - - - &reftitle.parameters; - - - index - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - diff --git a/reference/imagick/imagickpixelexception.xml b/reference/imagick/imagickpixelexception.xml deleted file mode 100644 index f2cb22a4359c..000000000000 --- a/reference/imagick/imagickpixelexception.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - The ImagickPixelException class - ImagickPixelException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - - ImagickPixelException - - - - - ImagickPixelException - - - - extends - Exception - - - - Throwable - - - &InheritedProperties; - - - - &InheritedMethods; - - - - - - -
    - -
    - -
    - diff --git a/reference/imagick/imagickpixeliterator.xml b/reference/imagick/imagickpixeliterator.xml deleted file mode 100644 index ee49a611484e..000000000000 --- a/reference/imagick/imagickpixeliterator.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - The <classname>ImagickPixelIterator</classname> class - ImagickPixelIterator - -
    - &reftitle.classsynopsis; - - ImagickPixelIterator - - ImagickPixelIterator - - - -
    -
    - &reference.imagick.entities.imagickpixeliterator; -
    - - - diff --git a/reference/imagick/imagickpixeliterator/clear.xml b/reference/imagick/imagickpixeliterator/clear.xml deleted file mode 100644 index 49a29b06dfa4..000000000000 --- a/reference/imagick/imagickpixeliterator/clear.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - ImagickPixelIterator::clear - Clear resources associated with a PixelIterator - - - - &reftitle.description; - - public boolImagickPixelIterator::clear - - - &warn.undocumented.func; - - Clear resources associated with a PixelIterator. - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>ImagickPixelIterator::clear</function> - - getPixelRegionIterator(100, 100, 250, 200); - - /* Loop through pixel rows */ - foreach ($imageIterator as $pixels) { - /** @var $pixel \ImagickPixel */ - /* Loop through the pixels in the row (columns) */ - foreach ($pixels as $column => $pixel) { - if ($column % 2) { - /* Paint every second pixel black*/ - $pixel->setColor("rgba(0, 0, 0, 0)"); - } - } - /* Sync the iterator, this is important to do on each iteration */ - $imageIterator->syncIterator(); - } - - $imageIterator->clear(); - - header("Content-Type: image/jpg"); - echo $imagick; -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickpixeliterator/construct.xml b/reference/imagick/imagickpixeliterator/construct.xml deleted file mode 100644 index 5044d7fee92c..000000000000 --- a/reference/imagick/imagickpixeliterator/construct.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - ImagickPixelIterator::__construct - The ImagickPixelIterator constructor - - - - &reftitle.description; - - public ImagickPixelIterator::__construct - Imagickwand - - &warn.undocumented.func; - - The ImagickPixelIterator constructor - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>ImagickPixelIterator::construct</function> - - $pixel) { - /** @var $pixel \ImagickPixel */ - if ($column % 2) { - /* Paint every second pixel black*/ - $pixel->setColor("rgba(0, 0, 0, 0)"); - } - } - /* Sync the iterator, this is important to do on each iteration */ - $imageIterator->syncIterator(); - } - - header("Content-Type: image/jpg"); - echo $imagick; -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickpixeliterator/destroy.xml b/reference/imagick/imagickpixeliterator/destroy.xml deleted file mode 100644 index c8ca29ce0f26..000000000000 --- a/reference/imagick/imagickpixeliterator/destroy.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - ImagickPixelIterator::destroy - Deallocates resources associated with a PixelIterator - - - - &reftitle.description; - - public boolImagickPixelIterator::destroy - - - &warn.undocumented.func; - - Deallocates resources associated with a PixelIterator. - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagickpixeliterator/getcurrentiteratorrow.xml b/reference/imagick/imagickpixeliterator/getcurrentiteratorrow.xml deleted file mode 100644 index dab069089080..000000000000 --- a/reference/imagick/imagickpixeliterator/getcurrentiteratorrow.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - ImagickPixelIterator::getCurrentIteratorRow - Returns the current row of ImagickPixel objects - - - - &reftitle.description; - - public arrayImagickPixelIterator::getCurrentIteratorRow - - - &warn.undocumented.func; - - Returns the current row as an array of ImagickPixel objects from the pixel iterator. - - - - - &reftitle.returnvalues; - - Returns a row as an array of ImagickPixel objects that can themselves be iterated. - - - - - - diff --git a/reference/imagick/imagickpixeliterator/getiteratorrow.xml b/reference/imagick/imagickpixeliterator/getiteratorrow.xml deleted file mode 100644 index 0c69227ca481..000000000000 --- a/reference/imagick/imagickpixeliterator/getiteratorrow.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - ImagickPixelIterator::getIteratorRow - Returns the current pixel iterator row - - - - &reftitle.description; - - public intImagickPixelIterator::getIteratorRow - - - &warn.undocumented.func; - - Returns the current pixel iterator row. - - - - - &reftitle.returnvalues; - - Returns the integer offset of the row, throwing - ImagickPixelIteratorException on error. - - - - - - diff --git a/reference/imagick/imagickpixeliterator/getnextiteratorrow.xml b/reference/imagick/imagickpixeliterator/getnextiteratorrow.xml deleted file mode 100644 index a5bfbdb72321..000000000000 --- a/reference/imagick/imagickpixeliterator/getnextiteratorrow.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - ImagickPixelIterator::getNextIteratorRow - Returns the next row of the pixel iterator - - - - &reftitle.description; - - public arrayImagickPixelIterator::getNextIteratorRow - - - &warn.undocumented.func; - - Returns the next row as an array of pixel wands from the pixel iterator. - - - - - &reftitle.returnvalues; - - Returns the next row as an array of ImagickPixel objects, throwing - ImagickPixelIteratorException on error. - - - - - - - &reftitle.examples; - - - <function>ImagickPixelIterator::getNextIteratorRow</function> - - getPixelIterator(); - - $count = 0; - while ($pixels = $imageIterator->getNextIteratorRow()) { - if (($count % 3) == 0) { - /* Loop through the pixels in the row (columns) */ - foreach ($pixels as $column => $pixel) { - /** @var $pixel \ImagickPixel */ - if ($column % 2) { - /* Paint every second pixel black*/ - $pixel->setColor("rgba(0, 0, 0, 0)"); - } - } - /* Sync the iterator, this is important to do on each iteration */ - $imageIterator->syncIterator(); - } - - $count += 1; - } - - header("Content-Type: image/jpg"); - echo $imagick; -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickpixeliterator/getpreviousiteratorrow.xml b/reference/imagick/imagickpixeliterator/getpreviousiteratorrow.xml deleted file mode 100644 index a976c6f14518..000000000000 --- a/reference/imagick/imagickpixeliterator/getpreviousiteratorrow.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - ImagickPixelIterator::getPreviousIteratorRow - Returns the previous row - - - - &reftitle.description; - - public arrayImagickPixelIterator::getPreviousIteratorRow - - - &warn.undocumented.func; - - Returns the previous row as an array of pixel wands from the pixel iterator. - - - - - &reftitle.returnvalues; - - Returns the previous row as an array of ImagickPixelWand objects from the - ImagickPixelIterator, throwing ImagickPixelIteratorException on error. - - - - - - diff --git a/reference/imagick/imagickpixeliterator/newpixeliterator.xml b/reference/imagick/imagickpixeliterator/newpixeliterator.xml deleted file mode 100644 index d32e9b165208..000000000000 --- a/reference/imagick/imagickpixeliterator/newpixeliterator.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - ImagickPixelIterator::newPixelIterator - Returns a new pixel iterator - - - - &reftitle.description; - - public boolImagickPixelIterator::newPixelIterator - Imagickwand - - &warn.undocumented.func; - - Returns a new pixel iterator. - - - - - &reftitle.returnvalues; - - &imagick.return.success; Throwing ImagickPixelIteratorException. - - - - - - diff --git a/reference/imagick/imagickpixeliterator/newpixelregioniterator.xml b/reference/imagick/imagickpixeliterator/newpixelregioniterator.xml deleted file mode 100644 index b7ed0771f054..000000000000 --- a/reference/imagick/imagickpixeliterator/newpixelregioniterator.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - ImagickPixelIterator::newPixelRegionIterator - Returns a new pixel iterator - - - - &reftitle.description; - - public boolImagickPixelIterator::newPixelRegionIterator - Imagickwand - intx - inty - intcolumns - introws - - &warn.undocumented.func; - - Returns a new pixel iterator. - - - - - &reftitle.parameters; - - - - wand - - - - - - - x - - - - - - - y - - - - - - - columns - - - - - - - rows - - - - - - - - - - - &reftitle.returnvalues; - - Returns a new ImagickPixelIterator on success; on failure, throws - ImagickPixelIteratorException. - - - - - - diff --git a/reference/imagick/imagickpixeliterator/resetiterator.xml b/reference/imagick/imagickpixeliterator/resetiterator.xml deleted file mode 100644 index 2ac2f65e3fe9..000000000000 --- a/reference/imagick/imagickpixeliterator/resetiterator.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - ImagickPixelIterator::resetIterator - Resets the pixel iterator - - - - &reftitle.description; - - public boolImagickPixelIterator::resetIterator - - - &warn.undocumented.func; - - Resets the pixel iterator. Use it in conjunction with - ImagickPixelIterator::getNextIteratorRow() to iterate over all the pixels - in a pixel container. - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>ImagickPixelIterator::resetIterator</function> - - getPixelIterator(); - - /* Loop through pixel rows */ - foreach ($imageIterator as $pixels) { - /* Loop through the pixels in the row (columns) */ - foreach ($pixels as $column => $pixel) { - /** @var $pixel \ImagickPixel */ - if ($column % 2) { - - /* Make every second pixel 25% red*/ - $pixel->setColorValue(\Imagick::COLOR_RED, 64); - } - } - /* Sync the iterator, this is important to do on each iteration */ - $imageIterator->syncIterator(); - } - - $imageIterator->resetiterator(); - - /* Loop through pixel rows */ - foreach ($imageIterator as $pixels) { - /* Loop through the pixels in the row (columns) */ - foreach ($pixels as $column => $pixel) { - /** @var $pixel \ImagickPixel */ - if ($column % 3) { - $pixel->setColorValue(\Imagick::COLOR_BLUE, 64); /* Make every second pixel a little blue*/ - //$pixel->setColor("rgba(0, 0, 128, 0)"); /* Paint every second pixel black*/ - } - } - $imageIterator->syncIterator(); /* Sync the iterator, this is important to do on each iteration */ - } - - $imageIterator->clear(); - - header("Content-Type: image/jpg"); - echo $imagick; -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickpixeliterator/setiteratorfirstrow.xml b/reference/imagick/imagickpixeliterator/setiteratorfirstrow.xml deleted file mode 100644 index 0a445142663b..000000000000 --- a/reference/imagick/imagickpixeliterator/setiteratorfirstrow.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - ImagickPixelIterator::setIteratorFirstRow - Sets the pixel iterator to the first pixel row - - - - &reftitle.description; - - public boolImagickPixelIterator::setIteratorFirstRow - - - &warn.undocumented.func; - - Sets the pixel iterator to the first pixel row. - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagickpixeliterator/setiteratorlastrow.xml b/reference/imagick/imagickpixeliterator/setiteratorlastrow.xml deleted file mode 100644 index bfe368a4df7b..000000000000 --- a/reference/imagick/imagickpixeliterator/setiteratorlastrow.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - ImagickPixelIterator::setIteratorLastRow - Sets the pixel iterator to the last pixel row - - - - &reftitle.description; - - public boolImagickPixelIterator::setIteratorLastRow - - - &warn.undocumented.func; - - Sets the pixel iterator to the last pixel row. - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagickpixeliterator/setiteratorrow.xml b/reference/imagick/imagickpixeliterator/setiteratorrow.xml deleted file mode 100644 index 5198a8483db9..000000000000 --- a/reference/imagick/imagickpixeliterator/setiteratorrow.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - ImagickPixelIterator::setIteratorRow - Set the pixel iterator row - - - - &reftitle.description; - - public boolImagickPixelIterator::setIteratorRow - introw - - &warn.undocumented.func; - - Set the pixel iterator row. - - - - - &reftitle.parameters; - - - - row - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>ImagickPixelIterator::setIteratorRow</function> - - getPixelRegionIterator(200, 100, 200, 200); - - for ($x = 0; $x < 20; $x++) { - $imageIterator->setIteratorRow($x * 5); - $pixels = $imageIterator->getCurrentIteratorRow(); - /* Loop through the pixels in the row (columns) */ - foreach ($pixels as $pixel) { - /** @var $pixel \ImagickPixel */ - /* Paint every second pixel black*/ - $pixel->setColor("rgba(0, 0, 0, 0)"); - } - - /* Sync the iterator, this is important to do on each iteration */ - $imageIterator->syncIterator(); - } - - header("Content-Type: image/jpg"); - echo $imagick; -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickpixeliterator/synciterator.xml b/reference/imagick/imagickpixeliterator/synciterator.xml deleted file mode 100644 index 780bc01cafdc..000000000000 --- a/reference/imagick/imagickpixeliterator/synciterator.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - ImagickPixelIterator::syncIterator - Syncs the pixel iterator - - - - &reftitle.description; - - public boolImagickPixelIterator::syncIterator - - - &warn.undocumented.func; - - Syncs the pixel iterator. - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagickpixeliteratorexception.xml b/reference/imagick/imagickpixeliteratorexception.xml deleted file mode 100644 index 8ce45c77ccfa..000000000000 --- a/reference/imagick/imagickpixeliteratorexception.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - The ImagickPixelIteratorException class - ImagickPixelIteratorException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - - ImagickPixelIteratorException - - - - - ImagickPixelIteratorException - - - - extends - Exception - - - - Throwable - - - &InheritedProperties; - - - - &InheritedMethods; - - - - - - -
    - -
    - -
    - diff --git a/reference/imagick/ini.xml b/reference/imagick/ini.xml deleted file mode 100644 index 1bdabf490ede..000000000000 --- a/reference/imagick/ini.xml +++ /dev/null @@ -1,110 +0,0 @@ - - -
    - &reftitle.runtime; - &extension.runtime; - - - Imagick configuration options - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - imagick.locale_fix - &false; - INI_ALL - Available since Imagick 2.1.0 - - - imagick.progress_monitor - &false; - INI_SYSTEM - Available since Imagick 2.2.2 - - - imagick.skip_version_check - &false; - INI_SYSTEM - Available since Imagick 3.3.0 - - - -
    - &ini.php.constants; -
    - - &ini.descriptions.title; - - - - - - imagick.locale_fix - bool - - - - Fixes a drawing bug with locales that use ',' as - float separators. - - - - - - - imagick.progress_monitor - bool - - - - Used to enable the image progress monitor. - - - - - - - - imagick.skip_version_check - bool - - - - When Imagick is loaded, it checks the version number of ImageMagick that it was compiled against, with the version number that is currently being used and will give a warning if they don't match. This warning can be suppressed by enabling this ini setting. - - Using a version of Imagick that was compiled against a different version of ImageMagick than the one being used is not recommended. Although it may appear to work, it can lead to random crashes or other undefined behaviour. - - - - - - -
    - - diff --git a/reference/imagick/setup.xml b/reference/imagick/setup.xml deleted file mode 100644 index 718c0873dd88..000000000000 --- a/reference/imagick/setup.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - &reftitle.setup; - - -
    - &reftitle.required; -
    - Installation requirements on non-Windows platforms - - ImageMagick >= 6.2.4 is required. The amount of - file formats supported by Imagick depends entirely upon the amount - of formats supported by your ImageMagick installation. For example, - Imagemagick requires ghostscript to conduct PDF operations. - -
    -
    - - - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;imagick. - - - The official name of this extension is imagick. - - - Windows users can download prebuilt DLL from the PECL website. - These packages already contain the extension DLL (php_imagick.dll) - which needs to be put into the extension_dir. - They also contain the ImageMagick DLLs, which need to be put somewhere in the PATH. - As of Imagick 3.6.0, they also contain XML configuration files in config; - to use these instead of the built-in defaults, they need to put into %USERPROFILE%/.config/ImageMagick, - or alternatively in the path given by the environment variable MAGICK_CONFIGURE_PATH. - Refer to the ImageMagick configuration files documentation - for further details. - -
    - - - &reference.imagick.ini; - -
    - - - diff --git a/reference/imagick/versions.xml b/reference/imagick/versions.xml deleted file mode 100644 index 35d82cc37bc9..000000000000 --- a/reference/imagick/versions.xml +++ /dev/null @@ -1,561 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/inotify/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/inotify/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/inotify/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/inotify/book.xml b/reference/inotify/book.xml deleted file mode 100644 index 61d71ba98b8c..000000000000 --- a/reference/inotify/book.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - Inotify - - - - &reftitle.intro; - - The inotify extension exposes the inotify functions inotify_init, - inotify_add_watch and inotify_rm_watch. - - - As the C inotify_init function returns a file descriptor, PHP's - inotify_init returns a stream resource, usable with standard - stream functions, like stream_select, stream_set_blocking - and fclose. inotify_read replaces the C way of reading inotify - events. - - - - - &reference.inotify.setup; - &reference.inotify.constants; - &reference.inotify.reference; - - - diff --git a/reference/inotify/constants.xml b/reference/inotify/constants.xml deleted file mode 100644 index bdfade340bbd..000000000000 --- a/reference/inotify/constants.xml +++ /dev/null @@ -1,291 +0,0 @@ - - - - &reftitle.constants; - &extension.constants; - - Inotify constants usable with <function>inotify_add_watch</function> and/or returned by <function>inotify_read</function> - - - IN_ACCESS - (int) - - - - File was accessed (read) (*) - - - - - - IN_MODIFY - (int) - - - - File was modified (*) - - - - - - IN_ATTRIB - (int) - - - - Metadata changed (e.g. permissions, mtime, etc.) (*) - - - - - - IN_CLOSE_WRITE - (int) - - - - File opened for writing was closed (*) - - - - - - IN_CLOSE_NOWRITE - (int) - - - - File not opened for writing was closed (*) - - - - - - IN_OPEN - (int) - - - - File was opened (*) - - - - - - IN_MOVED_TO - (int) - - - - File moved into watched directory (*) - - - - - - IN_MOVED_FROM - (int) - - - - File moved out of watched directory (*) - - - - - - IN_CREATE - (int) - - - - File or directory created in watched directory (*) - - - - - - IN_DELETE - (int) - - - - File or directory deleted in watched directory (*) - - - - - - IN_DELETE_SELF - (int) - - - - Watched file or directory was deleted - - - - - - IN_MOVE_SELF - (int) - - - - Watch file or directory was moved - - - - - - IN_CLOSE - (int) - - - - Equals to IN_CLOSE_WRITE | IN_CLOSE_NOWRITE - - - - - - IN_MOVE - (int) - - - - Equals to IN_MOVED_FROM | IN_MOVED_TO - - - - - - IN_ALL_EVENTS - (int) - - - - Bitmask of all the above constants - - - - - - IN_UNMOUNT - (int) - - - - File system containing watched object was unmounted - - - - - - IN_Q_OVERFLOW - (int) - - - - Event queue overflowed (wd is -1 for this event) - - - - - - IN_IGNORED - (int) - - - - Watch was removed (explicitly by inotify_rm_watch - or because file was removed or filesystem unmounted - - - - - - IN_ISDIR - (int) - - - - Subject of this event is a directory - - - - - - IN_ONLYDIR - (int) - - - - Only watch pathname if it is a directory (Since Linux 2.6.15) - - - - - - IN_DONT_FOLLOW - (int) - - - - Do not dereference pathname if it is a symlink (Since Linux 2.6.15) - - - - - - IN_MASK_ADD - (int) - - - - Add events to watch mask for this pathname if it already exists - (instead of replacing mask). - - - - - - IN_ONESHOT - (int) - - - - Monitor pathname for one event, then remove from watch list. - - - - - - - The events marked with an asterisk (*) above can occur for files in watched - directories. - - - - - diff --git a/reference/inotify/functions/inotify-add-watch.xml b/reference/inotify/functions/inotify-add-watch.xml deleted file mode 100644 index 2516456c8b69..000000000000 --- a/reference/inotify/functions/inotify-add-watch.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - inotify_add_watch - Add a watch to an initialized inotify instance - - - - &reftitle.description; - - intfalseinotify_add_watch - resourceinotify_instance - stringpathname - intmask - - - inotify_add_watch adds a new watch or modify an - existing watch for the file or directory specified in - pathname. - - - Using inotify_add_watch on a watched object replaces - the existing watch. Using the IN_MASK_ADD constant - adds (OR) events to the existing watch. - - - - - &reftitle.parameters; - - - inotify_instance - - - &inotify.instance.description; - - - - - pathname - - - File or directory to watch - - - - - mask - - - Events to watch for. See &ReservedConstants;. - - - - - - - - &reftitle.returnvalues; - - The return value is a unique (inotify instance wide) watch descriptor, - &return.falseforfailure;. - - - - - &reftitle.seealso; - - inotify_init - - - - - diff --git a/reference/inotify/functions/inotify-init.xml b/reference/inotify/functions/inotify-init.xml deleted file mode 100644 index bd1043e5c504..000000000000 --- a/reference/inotify/functions/inotify-init.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - inotify_init - Initialize an inotify instance - - - - &reftitle.description; - - resourcefalseinotify_init - - - - Initialize an inotify instance for use with - inotify_add_watch - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A stream resource or &false; on error. - - - - - &reftitle.examples; - - - Example usage of inotify - - 0, inotify_read() will not block - -// Stop watching __FILE__ for metadata changes -inotify_rm_watch($fd, $watch_descriptor); - -// Close the inotify instance -// This may have closed all watches if this was not already done -fclose($fd); - -?> -]]> - - &example.outputs.similar; - - 1, // Equals $watch_descriptor - 'mask' => 4, // IN_ATTRIB bit is set - 'cookie' => 0, // unique id to connect related events (e.g. - // IN_MOVE_FROM and IN_MOVE_TO events) - 'name' => '', // the name of a file (e.g. if we monitored changes - // in a directory) - ), -); -]]> - - - - - - - &reftitle.seealso; - - inotify_add_watch - inotify_rm_watch - inotify_queue_len - inotify_read - fclose - - - - - diff --git a/reference/inotify/functions/inotify-queue-len.xml b/reference/inotify/functions/inotify-queue-len.xml deleted file mode 100644 index 713b4c49f158..000000000000 --- a/reference/inotify/functions/inotify-queue-len.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - inotify_queue_len - Return a number upper than zero if there are pending events - - - - &reftitle.description; - - intinotify_queue_len - resourceinotify_instance - - - This function allows to know if inotify_read will block or not. - If a number upper than zero is returned, there are pending events and - inotify_read will not block. - - - - - &reftitle.parameters; - - - inotify_instance - - - &inotify.instance.description; - - - - - - - - &reftitle.returnvalues; - - Returns a number upper than zero if there are pending events. - - - - - &reftitle.seealso; - - inotify_init - stream_select - stream_set_blocking - - - - - diff --git a/reference/inotify/functions/inotify-read.xml b/reference/inotify/functions/inotify-read.xml deleted file mode 100644 index ad3515f46a9b..000000000000 --- a/reference/inotify/functions/inotify-read.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - inotify_read - Read events from an inotify instance - - - - &reftitle.description; - - arrayinotify_read - resourceinotify_instance - - - Read inotify events from an inotify instance. - - - - - &reftitle.parameters; - - - inotify_instance - - - &inotify.instance.description; - - - - - - - - &reftitle.returnvalues; - - An array of inotify events or &false; if no events was pending and - inotify_instance is non-blocking. Each event is an array with the following keys: - - wd is a watch descriptor returned by - inotify_add_watch - mask is a bit mask of events - cookie is a unique id to connect related events (e.g. IN_MOVE_FROM - and IN_MOVE_TO) - name is the name of a file (e.g. if a file was modified in a - watched directory) - - - - - - &reftitle.seealso; - - inotify_init - stream_select - stream_set_blocking - inotify_queue_len - - - - - diff --git a/reference/inotify/functions/inotify-rm-watch.xml b/reference/inotify/functions/inotify-rm-watch.xml deleted file mode 100644 index 04dd2590562a..000000000000 --- a/reference/inotify/functions/inotify-rm-watch.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - inotify_rm_watch - Remove an existing watch from an inotify instance - - - - &reftitle.description; - - boolinotify_rm_watch - resourceinotify_instance - intwatch_descriptor - - - inotify_rm_watch removes the watch - watch_descriptor from the inotify instance - inotify_instance. - - - - - &reftitle.parameters; - - - inotify_instance - - - &inotify.instance.description; - - - - - watch_descriptor - - - Watch to remove from the instance - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - inotify_init - - - - - diff --git a/reference/inotify/reference.xml b/reference/inotify/reference.xml deleted file mode 100644 index 880f1ca04f62..000000000000 --- a/reference/inotify/reference.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - Inotify &Functions; - - &reference.inotify.entities.functions; - - - - - diff --git a/reference/inotify/setup.xml b/reference/inotify/setup.xml deleted file mode 100644 index 747befe7483b..000000000000 --- a/reference/inotify/setup.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - &reftitle.setup; - - -
    - &reftitle.setup; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;inotify. - -
    - - - -
    - &reftitle.resources; - - This extension defines a stream resource returned by - inotify_init. - -
    - - -
    - diff --git a/reference/inotify/versions.xml b/reference/inotify/versions.xml deleted file mode 100644 index ad592f56f4d6..000000000000 --- a/reference/inotify/versions.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - - - - - - - - diff --git a/reference/libxml/book.xml b/reference/libxml/book.xml index cca0ad9440be..beda26e9ae28 100644 --- a/reference/libxml/book.xml +++ b/reference/libxml/book.xml @@ -8,20 +8,20 @@ &reftitle.intro; - + These functions/constants are available as of PHP 5.1.0, and the following core extensions rely on this libxml extension: DOM, libxml, SimpleXML, SOAP, - WDDX, + WDDX, XSL, XML, XMLReader, - XMLRPC&listendand; + XMLRPC&listendand; XMLWriter. - + diff --git a/reference/lua/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/lua/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/lua/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/lua/book.xml b/reference/lua/book.xml deleted file mode 100644 index 6c4a36c15409..000000000000 --- a/reference/lua/book.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - Lua - Lua - - - &reftitle.intro; - - "Lua is a powerful, fast, light-weight, embeddable scripting language." - This extension embeds the lua interpreter and offers an OO-API to lua - variables and functions. - - - - &reference.lua.setup; - - &reference.lua.lua; - &reference.lua.luaclosure; - &reference.lua.luaexception; - - diff --git a/reference/lua/configure.xml b/reference/lua/configure.xml deleted file mode 100644 index 65fd36c3c987..000000000000 --- a/reference/lua/configure.xml +++ /dev/null @@ -1,32 +0,0 @@ - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;lua - - - -
    - diff --git a/reference/lua/lua.xml b/reference/lua/lua.xml deleted file mode 100644 index 73cdbb42f89e..000000000000 --- a/reference/lua/lua.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - The Lua class - Lua - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Lua - - - - - Lua - - - - &Constants; - - const - string - Lua::LUA_VERSION - Lua 5.1.4 - - - &Methods; - - - - -
    - - - -
    - &reftitle.constants; - - - - Lua::LUA_VERSION - - - - - - -
    - - - -
    - - &reference.lua.entities.lua; - -
    - diff --git a/reference/lua/lua/assign.xml b/reference/lua/lua/assign.xml deleted file mode 100644 index 4b474fc50d30..000000000000 --- a/reference/lua/lua/assign.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - Lua::assign - Assign a PHP variable to Lua - - - - &reftitle.description; - - public mixedLua::assign - stringname - stringvalue - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - name - - - - - - - - value - - - - - - - - - - - &reftitle.returnvalues; - - Returns $this or &null; on failure. - - - - - &reftitle.examples; - - <function>Lua::assign</function>example - -assign("php_var", array(1=>1, 2, 3)); //lua table index begin with 1 -$lua->eval(<< -]]> - - &example.outputs; - - 1 - [2] => 2 - [3] => 3 - ) -]]> - - - - - - diff --git a/reference/lua/lua/call.xml b/reference/lua/lua/call.xml deleted file mode 100644 index 2e07d4683226..000000000000 --- a/reference/lua/lua/call.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - Lua::call - Lua::__call - Call Lua functions - - - - &reftitle.description; - - public mixedLua::call - callablelua_func - arrayargs - intuse_self0 - - - public mixedLua::__call - callablelua_func - arrayargs - intuse_self0 - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - lua_func - - - Function name in lua - - - - - args - - - Arguments passed to the Lua function - - - - - use_self - - - Whether to use self - - - - - - - - &reftitle.returnvalues; - - Returns result of the called function, &null; for wrong arguments or - &false; on other failure. - - - - - &reftitle.examples; - - <function>Lua::call</function>example - -eval(<<call("dummy", array("Lua", "geiliable\n")); -$lua->dummy("Lua", "geiliable"); // __call() -var_dump($lua->call(array("table", "concat"), array(array(1=>1, 2=>2, 3=>3), "-"))); -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - __call() - - - - - diff --git a/reference/lua/lua/construct.xml b/reference/lua/lua/construct.xml deleted file mode 100644 index 5e43fd610bcc..000000000000 --- a/reference/lua/lua/construct.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - Lua::__construct - Lua constructor - - - - &reftitle.description; - - public Lua::__construct - stringlua_script_fileNULL - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - lua_script_file - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/lua/lua/eval.xml b/reference/lua/lua/eval.xml deleted file mode 100644 index 2e8c7581fc9a..000000000000 --- a/reference/lua/lua/eval.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - Lua::eval - Evaluate a string as Lua code - - - - &reftitle.description; - - public mixedLua::eval - stringstatements - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - statements - - - - - - - - - - - &reftitle.returnvalues; - - Returns result of evaled code, &null; for wrong arguments or &false; on - other failure. - - - - - &reftitle.examples; - - <function>Lua::eval</function>example - -eval(<< -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/lua/lua/getversion.xml b/reference/lua/lua/getversion.xml deleted file mode 100644 index 2b376965e5c8..000000000000 --- a/reference/lua/lua/getversion.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - Lua::getVersion - The getversion purpose - - - - &reftitle.description; - - public stringLua::getVersion - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns Lua::LUA_VERSION. - - - - - - diff --git a/reference/lua/lua/include.xml b/reference/lua/lua/include.xml deleted file mode 100644 index 8444b0b1333c..000000000000 --- a/reference/lua/lua/include.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - Lua::include - Parse a Lua script file - - - - &reftitle.description; - - public mixedLua::include - stringfile - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - file - - - - - - - - - - - &reftitle.returnvalues; - - Returns result of included code, &null; for wrong arguments or &false; on - other failure. - - - - - - diff --git a/reference/lua/lua/registercallback.xml b/reference/lua/lua/registercallback.xml deleted file mode 100644 index 29a527bf7154..000000000000 --- a/reference/lua/lua/registercallback.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - Lua::registerCallback - Register a PHP function to Lua - - - - &reftitle.description; - - public mixedLua::registerCallback - stringname - callablefunction - - - Register a PHP function to Lua as a function named "$name" - - - - - - &reftitle.parameters; - - - name - - - - - - - - function - - - A valid PHP function callback - - - - - - - - &reftitle.returnvalues; - - Returns $this, &null; for wrong arguments or &false; on - other failure. - - - - - &reftitle.examples; - - <function>Lua::registerCallback</function>example - -registerCallback("echo", "var_dump"); -$lua->eval(<< -]]> - - &example.outputs; - - - float(1) - [2]=> - float(2) - [3]=> - float(3) -} -]]> - - - - - - diff --git a/reference/lua/luaclosure.xml b/reference/lua/luaclosure.xml deleted file mode 100644 index 6b6e14f7a779..000000000000 --- a/reference/lua/luaclosure.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - The LuaClosure class - LuaClosure - - - - -
    - &reftitle.intro; - - LuaClosure is a wrapper class for LUA_TFUNCTION which could be return from - calling to Lua function. - -
    - - -
    - &reftitle.classsynopsis; - - - - LuaClosure - - - - - LuaClosure - - - - - &Methods; - - - - -
    - -
    - - &reference.lua.entities.luaclosure; - -
    - diff --git a/reference/lua/luaclosure/invoke.xml b/reference/lua/luaclosure/invoke.xml deleted file mode 100644 index 7251581e3cf7..000000000000 --- a/reference/lua/luaclosure/invoke.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - LuaClosure::__invoke - Invoke luaclosure - - - - &reftitle.description; - - public voidLuaClosure::__invoke - mixedargs - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - args - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - <function>LuaClosure::__invoke</function>example - -eval(<<call($closure); -$closure(); -?> -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/lua/luaexception.xml b/reference/lua/luaexception.xml deleted file mode 100644 index 9547be2269c3..000000000000 --- a/reference/lua/luaexception.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - The LuaException class - LuaException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - LuaException - - - - - LuaException - - - - extends - Exception - - - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
    - - -
    - -
    - diff --git a/reference/lua/setup.xml b/reference/lua/setup.xml deleted file mode 100644 index 6b80c9a83125..000000000000 --- a/reference/lua/setup.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - &reftitle.setup; - -
    - &reftitle.required; - - To use this extension, you will need Lua installed, available on the Lua homepage - -
    - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;lua. - -
    - -
    - diff --git a/reference/lua/versions.xml b/reference/lua/versions.xml deleted file mode 100644 index d1093ca738a1..000000000000 --- a/reference/lua/versions.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/luasandbox/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/luasandbox/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/luasandbox/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/luasandbox/book.xml b/reference/luasandbox/book.xml deleted file mode 100644 index 80a38d33d0c2..000000000000 --- a/reference/luasandbox/book.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - LuaSandbox - LuaSandbox - - - &reftitle.intro; - - LuaSandbox is an extension for PHP 7 and PHP 8 to allow safely - running untrusted Lua 5.1 code from within PHP. - - - Differences compared to the Lua extension: - - - - LuaSandbox has support for time and memory limits. - - - - - LuaSandbox provides a default-safe environment for running untrusted code. - Stock Lua functions were reviewed for security, and several were patched - accordingly. - - - - - LuaSandbox has a PHP interface which is more complex, precise and powerful, - but it is less convenient for developers. - - - - - LuaSandbox supports only Lua 5.1. It is difficult to change this, because - LuaSandbox uses heavily modified Lua standard libraries, and - due to the lack of backwards compatibility between major Lua versions. - LuaSandbox aims to maximise backwards compatibility with user-supplied - scripts. - - - - - - - &reference.luasandbox.setup; - &reference.luasandbox.differences; - &reference.luasandbox.examples; - - - &reference.luasandbox.luasandbox; - &reference.luasandbox.luasandboxfunction; - &reference.luasandbox.luasandboxerror; - &reference.luasandbox.luasandboxerrorerror; - &reference.luasandbox.luasandboxfatalerror; - &reference.luasandbox.luasandboxmemoryerror; - &reference.luasandbox.luasandboxruntimeerror; - &reference.luasandbox.luasandboxsyntaxerror; - &reference.luasandbox.luasandboxtimeouterror; - - - diff --git a/reference/luasandbox/configure.xml b/reference/luasandbox/configure.xml deleted file mode 100644 index eb561590f7ff..000000000000 --- a/reference/luasandbox/configure.xml +++ /dev/null @@ -1,31 +0,0 @@ - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;luasandbox - - -
    - diff --git a/reference/luasandbox/differences.xml b/reference/luasandbox/differences.xml deleted file mode 100644 index be344b1a8a83..000000000000 --- a/reference/luasandbox/differences.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - Differences from Standard Lua - - - LuaSandbox provides a sandboxed environment which differs in some ways from standard Lua 5.1. - - - - Features that are not available - - - - dofile(), loadfile(), and the io package, as they allow direct filesystem access. If needed, filesystem access should be done via PHP callbacks. - - - - - The package package, including require() and module(), as it depends heavily on direct filesystem access. A pure-Lua rewrite such as that used in the MediaWiki Scribunto extension may be used instead. - - - - - load() and loadstring(), to allow for static analysis of Lua code. - - - - - print(), since it outputs to standard output. If needed, output should be done via PHP callbacks. - - - - - Most of the os package, as it allows manipulation of the process and executing of other processes. - - - - - os.clock(), os.date(), os.difftime(), and os.time() remain available. - - - - - - - Most of the debug package, as it allows manipulation of Lua state and metadata in ways that can break sandboxing. - - - - - debug.traceback() remains available. - - - - - - - string.dump(), as it may expose internal data. - - - - - collectgarbage(), gcinfo(), and the coroutine package have not been reviewed for security. - - - - - - - Features that have been modified - - - - pcall() and xpcall() cannot catch certain errors, particularly timeout errors. - - - - - tostring() does not include pointer addresses. - - - - - string.match() has been patched to limit the recursion depth and to periodically check for a timeout. - - - - - math.random() and math.randomseed() are replaced with versions that don't share state with PHP's rand(). - - - - - The Lua 5.2 __pairs and __ipairs metamethods are supported by pairs() and ipairs(). - - - - - - - diff --git a/reference/luasandbox/examples.xml b/reference/luasandbox/examples.xml deleted file mode 100644 index 6dbe9380e56b..000000000000 --- a/reference/luasandbox/examples.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - &reftitle.examples; - - - -
    - Basic usage for LuaSandbox - - Once you've compiled PHP with LuaSandbox support, you can begin using LuaSandbox to safely run user-provided Lua code. - - - Execute some Lua code - -setMemoryLimit( 50 * 1024 * 1024 ); -$sandbox->setCPULimit( 10 ); - -// Register some functions in the Lua environment - -function frobnosticate( $v ) { - return [ $v + 42 ]; -} - -$sandbox->registerLibrary( 'php', [ - 'frobnosticate' => 'frobnosticate', - 'output' => function ( $string ) { - echo "$string\n"; - }, - 'error' => function () { - throw new LuaSandboxRuntimeError( "Something is wrong" ); - } -] ); - -// Execute some Lua code, including callbacks into PHP and into Lua - -$luaCode = <<loadString( $luaCode )->call(); -assert( $frob->call( 4000 ) === [ 4242 ] ); - -// PHP-thrown LuaSandboxRuntimeError exceptions can be caught inside Lua - -list( $ok, $message ) = $sandbox->loadString( 'return pcall( php.error )' )->call(); -assert( !$ok ); -assert( $message === 'Something is wrong' ); - -?> -]]> - - -
    - -
    - diff --git a/reference/luasandbox/luasandbox.xml b/reference/luasandbox/luasandbox.xml deleted file mode 100644 index a9abd647d5d4..000000000000 --- a/reference/luasandbox/luasandbox.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - The LuaSandbox class - LuaSandbox - - - - -
    - &reftitle.intro; - - The LuaSandbox class creates a Lua environment and allows for execution of - Lua code. - -
    - - -
    - &reftitle.classsynopsis; - - - - LuaSandbox - - - - - LuaSandbox - - - - &Constants; - - const - int - LuaSandbox::SAMPLES - 0 - - - const - int - LuaSandbox::SECONDS - 1 - - - const - int - LuaSandbox::PERCENT - 2 - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - LuaSandbox::SAMPLES - - - Used with LuaSandbox::getProfilerFunctionReport to return timings in samples. - - - - - - LuaSandbox::SECONDS - - - Used with LuaSandbox::getProfilerFunctionReport to return timings in seconds. - - - - - - LuaSandbox::PERCENT - - - Used with LuaSandbox::getProfilerFunctionReport to return timings in percentages of the total. - - - - - -
    - - - -
    - - &reference.luasandbox.entities.luasandbox; - -
    - diff --git a/reference/luasandbox/luasandbox/callfunction.xml b/reference/luasandbox/luasandbox/callfunction.xml deleted file mode 100644 index 1e96f4863b84..000000000000 --- a/reference/luasandbox/luasandbox/callfunction.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - LuaSandbox::callFunction - Call a function in a Lua global variable - - - - &reftitle.description; - - public arrayboolLuaSandbox::callFunction - stringname - mixedargs - - - Calls a function in a Lua global variable. - - - If the name contains "." characters, the function is located via - recursive table accesses, as if the name were a Lua expression. - - - If the variable does not exist, or is not a function, false will be - returned and a warning issued. - - - For more information about calling Lua functions and the return values, - see LuaSandboxFunction::call. - - - - - &reftitle.parameters; - - - name - - - Lua variable name. - - - - - args - - - Arguments to the function. - - - - - - - - &reftitle.returnvalues; - - Returns an array of values returned by the Lua function, which may be empty, &return.falseforfailure;. - - - - - &reftitle.examples; - - Calling a Lua function - -callFunction( 'string.match', $string, $pattern ); - -?> -]]> - - - - - - diff --git a/reference/luasandbox/luasandbox/disableprofiler.xml b/reference/luasandbox/luasandbox/disableprofiler.xml deleted file mode 100644 index 7df8d3af8e42..000000000000 --- a/reference/luasandbox/luasandbox/disableprofiler.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - LuaSandbox::disableProfiler - Disable the profiler - - - - &reftitle.description; - - public voidLuaSandbox::disableProfiler - - - - Disables the profiler. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - LuaSandbox::enableProfiler - LuaSandbox::getProfilerFunctionReport - - - - - diff --git a/reference/luasandbox/luasandbox/enableprofiler.xml b/reference/luasandbox/luasandbox/enableprofiler.xml deleted file mode 100644 index cc920f65b2ee..000000000000 --- a/reference/luasandbox/luasandbox/enableprofiler.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - LuaSandbox::enableProfiler - Enable the profiler. - - - - &reftitle.description; - - public boolLuaSandbox::enableProfiler - floatperiod0.02 - - - Enables the profiler. Profiling will begin when Lua code is entered. - - - The profiler periodically samples the Lua environment to record the - running function. Testing indicates that at least on Linux, setting a - period less than 1ms will lead to a high overrun count but no - performance problems. - - - - - - &reftitle.parameters; - - - period - - - Sampling period in seconds. - - - - - - - - &reftitle.returnvalues; - - Returns a boolean indicating whether the profiler is enabled. - - - - - &reftitle.seealso; - - LuaSandbox::disableProfiler - LuaSandbox::getProfilerFunctionReport - - - - - diff --git a/reference/luasandbox/luasandbox/getcpuusage.xml b/reference/luasandbox/luasandbox/getcpuusage.xml deleted file mode 100644 index 39282100a4ff..000000000000 --- a/reference/luasandbox/luasandbox/getcpuusage.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - LuaSandbox::getCPUUsage - Fetch the current CPU time usage of the Lua environment - - - - &reftitle.description; - - public floatLuaSandbox::getCPUUsage - - - - Fetches the current CPU time usage of the Lua environment. - - - This includes time spent in PHP callbacks. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the current CPU time usage in seconds. - - - - On Windows, this function always returns zero. On operating systems that do - not support CLOCK_THREAD_CPUTIME_ID, such as FreeBSD - and Mac OS X, this function will return the elapsed wall-clock time, not - CPU time. - - - - - - &reftitle.seealso; - - LuaSandbox::getMemoryUsage - LuaSandbox::getPeakMemoryUsage - LuaSandbox::setCPULimit - - - - - diff --git a/reference/luasandbox/luasandbox/getmemoryusage.xml b/reference/luasandbox/luasandbox/getmemoryusage.xml deleted file mode 100644 index 1a59767ba5e0..000000000000 --- a/reference/luasandbox/luasandbox/getmemoryusage.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - LuaSandbox::getMemoryUsage - Fetch the current memory usage of the Lua environment - - - - &reftitle.description; - - public intLuaSandbox::getMemoryUsage - - - - Fetches the current memory usage of the Lua environment. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the current memory usage in bytes. - - - - - &reftitle.seealso; - - LuaSandbox::getPeakMemoryUsage - LuaSandbox::getCPUUsage - LuaSandbox::setMemoryLimit - - - - - diff --git a/reference/luasandbox/luasandbox/getpeakmemoryusage.xml b/reference/luasandbox/luasandbox/getpeakmemoryusage.xml deleted file mode 100644 index f152100c800d..000000000000 --- a/reference/luasandbox/luasandbox/getpeakmemoryusage.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - LuaSandbox::getPeakMemoryUsage - Fetch the peak memory usage of the Lua environment - - - - &reftitle.description; - - public intLuaSandbox::getPeakMemoryUsage - - - - Fetches the peak memory usage of the Lua environment. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the peak memory usage in bytes. - - - - - &reftitle.seealso; - - LuaSandbox::getMemoryUsage - LuaSandbox::getCPUUsage - LuaSandbox::setMemoryLimit - - - - - diff --git a/reference/luasandbox/luasandbox/getprofilerfunctionreport.xml b/reference/luasandbox/luasandbox/getprofilerfunctionreport.xml deleted file mode 100644 index 6301d38a94df..000000000000 --- a/reference/luasandbox/luasandbox/getprofilerfunctionreport.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - LuaSandbox::getProfilerFunctionReport - Fetch profiler data - - - - &reftitle.description; - - public arrayLuaSandbox::getProfilerFunctionReport - intunitsLuaSandbox::SECONDS - - - For a profiling instance previously started by - LuaSandbox::enableProfiler, get a - report of the cost of each function. - - - The measurement unit used for the cost is determined by the - $units parameter: - - - - LuaSandbox::SAMPLES - Measure in number of samples. - - - LuaSandbox::SECONDS - Measure in seconds of CPU time. - - - LuaSandbox::PERCENT - Measure percentage of CPU time. - - - - - - &reftitle.parameters; - - - units - - - Measurement unit constant. - - - - - - - - &reftitle.returnvalues; - - Returns profiler measurements, sorted in descending order, as an associative - array. Keys are the Lua function names (with source file and line - defined in angle brackets), values are the measurements as int - or float. - - - - On Windows, this function always returns an empty array. On operating systems that do - not support CLOCK_THREAD_CPUTIME_ID, such as FreeBSD - and Mac OS X, this function will report the elapsed wall-clock time, not - CPU time. - - - - - - &reftitle.examples; - - Profiling Lua code - -enableProfiler( 0.01 ); - -// ... Execute some Lua code here ... - -// Fetch the profiler data -$data = $sandbox->getProfilerFunctionReport(); - -?> -]]> - - - - - - diff --git a/reference/luasandbox/luasandbox/getversioninfo.xml b/reference/luasandbox/luasandbox/getversioninfo.xml deleted file mode 100644 index 69d1b7d5ef48..000000000000 --- a/reference/luasandbox/luasandbox/getversioninfo.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - LuaSandbox::getVersionInfo - Return the versions of LuaSandbox and Lua - - - - &reftitle.description; - - public static arrayLuaSandbox::getVersionInfo - - - - Returns the versions of LuaSandbox and Lua. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an array with two keys: - - - - - elementtypedescription - - - - LuaSandbox - string - The version of the LuaSandbox extension. - - - Lua - string - The library name and version as defined by the LUA_RELEASE macro, for example, "Lua 5.1.5". - - - - - - - - diff --git a/reference/luasandbox/luasandbox/loadbinary.xml b/reference/luasandbox/luasandbox/loadbinary.xml deleted file mode 100644 index 3be70973a698..000000000000 --- a/reference/luasandbox/luasandbox/loadbinary.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - LuaSandbox::loadBinary - Load a precompiled binary chunk into the Lua environment - - - - &reftitle.description; - - public LuaSandboxFunctionLuaSandbox::loadBinary - stringcode - stringchunkName'' - - - Loads data generated by LuaSandboxFunction::dump. - - - - - &reftitle.parameters; - - - code - - - Data from LuaSandboxFunction::dump. - - - - - chunkName - - - Name for the loaded function. - - - - - - - - &reftitle.returnvalues; - - Returns a LuaSandboxFunction. - - - - - &reftitle.seealso; - - LuaSandbox::loadString - - - - - diff --git a/reference/luasandbox/luasandbox/loadstring.xml b/reference/luasandbox/luasandbox/loadstring.xml deleted file mode 100644 index ed71a7fd82f5..000000000000 --- a/reference/luasandbox/luasandbox/loadstring.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - LuaSandbox::loadString - Load Lua code into the Lua environment - - - - &reftitle.description; - - public LuaSandboxFunctionLuaSandbox::loadString - stringcode - stringchunkName'' - - - Loads Lua code into the Lua environment. - - - This is the equivalent of standard Lua's loadstring() function. - - - - - - &reftitle.parameters; - - - code - - - Lua code. - - - - - chunkName - - - Name for the loaded chunk, for use in error traces. - - - - - - - - &reftitle.returnvalues; - - Returns a LuaSandboxFunction which, when executed, will execute the passed $code. - - - - - &reftitle.examples; - - Loading code into Lua - -loadString( -<<call() ); - -?> -]]> - - &example.outputs; - - - string(12) "Hello, world" -} -]]> - - - - - - &reftitle.seealso; - - LuaSandbox::registerLibrary - LuaSandbox::wrapPhpFunction - - - - - diff --git a/reference/luasandbox/luasandbox/pauseusagetimer.xml b/reference/luasandbox/luasandbox/pauseusagetimer.xml deleted file mode 100644 index 8bf4d7b0fb06..000000000000 --- a/reference/luasandbox/luasandbox/pauseusagetimer.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - LuaSandbox::pauseUsageTimer - Pause the CPU usage timer - - - - &reftitle.description; - - public boolLuaSandbox::pauseUsageTimer - - - - Pauses the CPU usage timer. - - - This only has effect when called from within a callback from Lua. When - execution returns to Lua, the timer will be automatically unpaused. If - a new call into Lua is made, the timer will be unpaused for the - duration of that call. - - - If a PHP callback calls into Lua again with timer not paused, and then - that Lua function calls into PHP again, the second PHP call will not be - able to pause the timer. The logic is that even though the second PHP - call would avoid counting the CPU usage against the limit, the first - call still counts it. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a bool indicating whether the timer is now paused. - - - - - &reftitle.examples; - - Manipulating the usage timer - -setCPULimit( 1 ); - -function doWait( $t ) { - $end = microtime( true ) + $t; - while ( microtime( true ) < $end ) { - // waste CPU cycles - } -} - -// Register a PHP callback -$sandbox->registerLibrary( 'php', [ - 'test' => function () use ( $sandbox ) { - $sandbox->pauseUsageTimer(); - doWait( 5 ); - - $sandbox->unpauseUsageTimer(); - doWait( 0.1 ); - }, - 'test2' => function () use ( $sandbox ) { - $sandbox->pauseUsageTimer(); - $sandbox->unpauseUsageTimer(); - doWait( 1.1 ); - } -] ); - -echo "This should not time out...\n"; -$sandbox->loadString( 'php.test()' )->call(); - -echo "This should time out.\n"; -try { - $sandbox->loadString( 'php.test2()' )->call(); - echo "It did not?\n"; -} catch ( LuaSandboxTimeoutError $ex ) { - echo "It did! " . $ex->getMessage() . "\n"; -} - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - LuaSandbox::setCPULimit - LuaSandbox::unpauseUsageTimer - - - - - diff --git a/reference/luasandbox/luasandbox/registerlibrary.xml b/reference/luasandbox/luasandbox/registerlibrary.xml deleted file mode 100644 index 0e19cfbca64b..000000000000 --- a/reference/luasandbox/luasandbox/registerlibrary.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - LuaSandbox::registerLibrary - Register a set of PHP functions as a Lua library - - - - &reftitle.description; - - public voidLuaSandbox::registerLibrary - stringlibname - arrayfunctions - - - Registers a set of PHP functions as a Lua library, so that Lua can call - the relevant PHP code. - - - For more information about calling Lua functions and the return values, - see LuaSandboxFunction::call. - - - - - - &reftitle.parameters; - - - libname - - - The name of the library. In the Lua state, the global variable of this - name will be set to the table of functions. If the table already exists, - the new functions will be added to it. - - - - - functions - - - An array, where each key is a function name, and each value is a - corresponding PHP callable. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Registering PHP functions to call from Lua - -registerLibrary( 'php', [ - 'frobnosticate' => 'frobnosticate', - 'output' => function ( $string ) { - echo "$string\n"; - }, - 'error' => function () { - throw new LuaSandboxRuntimeError( "Something is wrong" ); - } -] ); - -?> -]]> - - - - - - &reftitle.seealso; - - LuaSandbox::loadString - LuaSandbox::wrapPhpFunction - - - - - diff --git a/reference/luasandbox/luasandbox/setcpulimit.xml b/reference/luasandbox/luasandbox/setcpulimit.xml deleted file mode 100644 index cb8ff4e2cac2..000000000000 --- a/reference/luasandbox/luasandbox/setcpulimit.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - LuaSandbox::setCPULimit - Set the CPU time limit for the Lua environment - - - - &reftitle.description; - - public voidLuaSandbox::setCPULimit - floatboollimit - - - Sets the CPU time limit for the Lua environment. - - - If the total user and system time used by the environment after the call - to this method exceeds this limit, a LuaSandboxTimeoutError - exception is thrown. - - - Time used in PHP callbacks is included in the limit. - - - Setting the time limit from a callback while Lua is running causes the - timer to be reset, or started if it was not already running. - - - - On Windows, the CPU limit will be ignored. On operating systems that do - not support CLOCK_THREAD_CPUTIME_ID, such as FreeBSD - and Mac OS X, wall-clock time rather than CPU time will be limited. - - - - - - &reftitle.parameters; - - - limit - - - Limit as a float in seconds, or &false; for no limit. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Calling a Lua function - -setCPULimit( 2 ); - -// Run Lua code -$sandbox->loadString( 'while true do end' )->call(); - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - LuaSandbox::getCPUUsage - LuaSandbox::setMemoryLimit - - - - - diff --git a/reference/luasandbox/luasandbox/setmemorylimit.xml b/reference/luasandbox/luasandbox/setmemorylimit.xml deleted file mode 100644 index 4a64f37847fd..000000000000 --- a/reference/luasandbox/luasandbox/setmemorylimit.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - LuaSandbox::setMemoryLimit - Set the memory limit for the Lua environment - - - - &reftitle.description; - - public voidLuaSandbox::setMemoryLimit - intlimit - - - Sets the memory limit for the Lua environment. - - - If this limit is exceeded, a LuaSandboxMemoryError - exception is thrown. - - - - - - &reftitle.parameters; - - - limit - - - Memory limit in bytes. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Calling a Lua function - -setMemoryLimit( 50 * 1024 * 1024 ); - -// Run Lua code -$sandbox->loadString( 'local x = "x"; while true do x = x .. x; end' )->call(); - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - LuaSandbox::getMemoryUsage - LuaSandbox::getPeakMemoryUsage - LuaSandbox::setCPULimit - - - - - diff --git a/reference/luasandbox/luasandbox/unpauseusagetimer.xml b/reference/luasandbox/luasandbox/unpauseusagetimer.xml deleted file mode 100644 index 37127b11d01e..000000000000 --- a/reference/luasandbox/luasandbox/unpauseusagetimer.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - LuaSandbox::unpauseUsageTimer - Unpause the timer paused by LuaSandbox::pauseUsageTimer - - - - &reftitle.description; - - public voidLuaSandbox::unpauseUsageTimer - - - - Unpauses the timer paused by LuaSandbox::pauseUsageTimer. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - LuaSandbox::pauseUsageTimer - LuaSandbox::setCPULimit - - - - - diff --git a/reference/luasandbox/luasandbox/wrapphpfunction.xml b/reference/luasandbox/luasandbox/wrapphpfunction.xml deleted file mode 100644 index 079360c6840f..000000000000 --- a/reference/luasandbox/luasandbox/wrapphpfunction.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - LuaSandbox::wrapPhpFunction - Wrap a PHP callable in a LuaSandboxFunction - - - - &reftitle.description; - - public LuaSandboxFunctionLuaSandbox::wrapPhpFunction - callablefunction - - - Wraps a PHP callable in a LuaSandboxFunction, so it - can be passed into Lua as an anonymous function. - - - The function must return either an array of values (which may be empty), - or &null; which is equivalent to returning the empty array. - - - Exceptions will be raised as errors in Lua, however only - LuaSandboxRuntimeError exceptions may be caught - inside Lua with pcall() or xpcall(). - - - For more information about calling Lua functions and the return values, - see LuaSandboxFunction::call. - - - - - &reftitle.parameters; - - - function - - - Callable to wrap. - - - - - - - - &reftitle.returnvalues; - - Returns a LuaSandboxFunction. - - - - - &reftitle.seealso; - - LuaSandbox::loadString - LuaSandbox::registerLibrary - - - - - diff --git a/reference/luasandbox/luasandboxerror.xml b/reference/luasandbox/luasandboxerror.xml deleted file mode 100644 index f653f279f0d6..000000000000 --- a/reference/luasandbox/luasandboxerror.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - The LuaSandboxError class - LuaSandboxError - - - - -
    - &reftitle.intro; - - Base class for LuaSandbox exceptions - -
    - - -
    - &reftitle.classsynopsis; - - - - LuaSandboxError - - - - - LuaSandboxError - - - - extends - Exception - - - - &Constants; - - const - int - LuaSandboxError::RUN - 2 - - - const - int - LuaSandboxError::SYNTAX - 3 - - - const - int - LuaSandboxError::MEM - 4 - - - const - int - LuaSandboxError::ERR - 5 - - - &InheritedProperties; - - - - - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.constants; - - - - LuaSandboxError::RUN - - - - - - - LuaSandboxError::SYNTAX - - - - - - - LuaSandboxError::MEM - - - - - - - LuaSandboxError::ERR - - - - - - -
    - - - -
    - - - -
    - diff --git a/reference/luasandbox/luasandboxerrorerror.xml b/reference/luasandbox/luasandboxerrorerror.xml deleted file mode 100644 index 95f7f5dbe6e7..000000000000 --- a/reference/luasandbox/luasandboxerrorerror.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - The LuaSandboxErrorError class - LuaSandboxErrorError - - - - -
    - &reftitle.intro; - - Exception thrown when Lua encounters an error inside an error handler. - -
    - - -
    - &reftitle.classsynopsis; - - - - LuaSandboxErrorError - - - - - LuaSandboxErrorError - - - - extends - LuaSandboxFatalError - - - - - &InheritedProperties; - - - - - - &InheritedMethods; - - - - - -
    - -
    - - - -
    - diff --git a/reference/luasandbox/luasandboxfatalerror.xml b/reference/luasandbox/luasandboxfatalerror.xml deleted file mode 100644 index ae9f253532c5..000000000000 --- a/reference/luasandbox/luasandboxfatalerror.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - The LuaSandboxFatalError class - LuaSandboxFatalError - - - - -
    - &reftitle.intro; - - Uncatchable LuaSandbox exceptions. - - - These may not be caught inside Lua using - pcall() or xpcall(). - -
    - - -
    - &reftitle.classsynopsis; - - - - LuaSandboxFatalError - - - - - LuaSandboxFatalError - - - - extends - LuaSandboxError - - - - - &InheritedProperties; - - - - - - &InheritedMethods; - - - - - -
    - -
    - - - -
    - diff --git a/reference/luasandbox/luasandboxfunction.xml b/reference/luasandbox/luasandboxfunction.xml deleted file mode 100644 index a967c4be5e93..000000000000 --- a/reference/luasandbox/luasandboxfunction.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - The LuaSandboxFunction class - LuaSandboxFunction - - - - -
    - &reftitle.intro; - - Represents a Lua function, allowing it to be called from PHP. - - - A LuaSandboxFunction may be obtained as a return value from Lua, as a parameter - passed to a callback from Lua, or by using - LuaSandbox::wrapPhpFunction, - LuaSandbox::loadString, or - LuaSandbox::loadBinary. - -
    - - -
    - &reftitle.classsynopsis; - - - - LuaSandboxFunction - - - - - LuaSandboxFunction - - - - - &Methods; - - - - -
    - -
    - - &reference.luasandbox.entities.luasandboxfunction; - -
    - diff --git a/reference/luasandbox/luasandboxfunction/call.xml b/reference/luasandbox/luasandboxfunction/call.xml deleted file mode 100644 index c0536015e9a5..000000000000 --- a/reference/luasandbox/luasandboxfunction/call.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - - LuaSandboxFunction::call - Call a Lua function - - - - &reftitle.description; - - public arrayboolLuaSandboxFunction::call - stringargs - - - Calls a Lua function. - - - Errors considered to be the fault of the PHP code will result in the - function returning &false; and E_WARNING - being raised, for example, a resource type being used as an - argument. Lua errors will result in a LuaSandboxRuntimeError - exception being thrown. - - - PHP and Lua types are converted as follows: - - - - PHP &null; is Lua nil, and vice versa. - - - - PHP ints and floats are converted to Lua - numbers. Infinity and NAN are supported. - - - - - Lua numbers without a fractional part between approximately -2**53 - and 2**53 are converted to PHP ints, with others - being converted to PHP floats. - - - - PHP bools are Lua booleans, and vice versa. - - - PHP strings are Lua strings, and vice versa. - - - - Lua functions are PHP LuaSandboxFunction objects, and vice versa. - General PHP callables are not supported. - - - - - PHP arrays are converted to Lua tables, and vice versa. - - - - - Note that Lua typically indexes arrays from 1, while PHP indexes - arrays from 0. No adjustment is made for these differing - conventions. - - - - Self-referential arrays are not supported in either direction. - - - PHP references are dereferenced. - - - - Lua __pairs and __ipairs are processed. - __index is ignored. - - - - - When converting from PHP to Lua, integer keys between - -2**53 and 2**53 are represented - as Lua numbers. All other keys are represented as Lua strings. - - - - - When converting from Lua to PHP, keys other than strings and - numbers will result in an error, as will collisions when converting - numbers to strings or vice versa (since PHP considers things like - $a[0] and $a["0"] as being equivalent). - - - - - - - All other types are unsupported and will raise an error/exception, - including general PHP objects and Lua userdata and thread types. - - - - - Lua functions inherently return a list of results. So on success, this - method returns an array containing all of the values returned by Lua, - with int keys starting from zero. Lua may return no results, in - which case an empty array is returned. - - - - - &reftitle.parameters; - - - args - - - Arguments passed to the function. - - - - - - - - &reftitle.returnvalues; - - Returns an array of values returned by the function, which may be empty, - &return.falseforfailure;. - - - - - diff --git a/reference/luasandbox/luasandboxfunction/construct.xml b/reference/luasandbox/luasandboxfunction/construct.xml deleted file mode 100644 index ae94d0972b3b..000000000000 --- a/reference/luasandbox/luasandboxfunction/construct.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - LuaSandboxFunction::__construct - Unused - - - - &reftitle.description; - - final private LuaSandboxFunction::__construct - - - - LuaSandboxFunction are obtained as a return value from Lua, - as a parameter passed to a callback from Lua, or by using - LuaSandbox::wrapPhpFunction, - LuaSandbox::loadString, or - LuaSandbox::loadBinary. They cannot be constructed directly. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - diff --git a/reference/luasandbox/luasandboxfunction/dump.xml b/reference/luasandbox/luasandboxfunction/dump.xml deleted file mode 100644 index 4c76c59ee129..000000000000 --- a/reference/luasandbox/luasandboxfunction/dump.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - LuaSandboxFunction::dump - Dump the function as a binary blob - - - - &reftitle.description; - - public stringLuaSandboxFunction::dump - - - - Dumps the function as a binary blob. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a string that may be passed to LuaSandbox::loadBinary. - - - - - diff --git a/reference/luasandbox/luasandboxmemoryerror.xml b/reference/luasandbox/luasandboxmemoryerror.xml deleted file mode 100644 index 9ae6439a924d..000000000000 --- a/reference/luasandbox/luasandboxmemoryerror.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - The LuaSandboxMemoryError class - LuaSandboxMemoryError - - - - -
    - &reftitle.intro; - - Exception thrown when Lua cannot allocate memory. - -
    - - -
    - &reftitle.classsynopsis; - - - - LuaSandboxMemoryError - - - - - LuaSandboxMemoryError - - - - extends - LuaSandboxFatalError - - - - - &InheritedProperties; - - - - - - &InheritedMethods; - - - - - -
    - -
    - &reftitle.seealso; - - LuaSandbox::setMemoryLimit - -
    - -
    - - - -
    - diff --git a/reference/luasandbox/luasandboxruntimeerror.xml b/reference/luasandbox/luasandboxruntimeerror.xml deleted file mode 100644 index 68a40b2c1d2e..000000000000 --- a/reference/luasandbox/luasandboxruntimeerror.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - The LuaSandboxRuntimeError class - LuaSandboxRuntimeError - - - - -
    - &reftitle.intro; - - Catchable LuaSandbox runtime exceptions. - - - These may be caught inside Lua using - pcall() or xpcall(). - -
    - - -
    - &reftitle.classsynopsis; - - - - LuaSandboxRuntimeError - - - - - LuaSandboxRuntimeError - - - - extends - LuaSandboxError - - - - - &InheritedProperties; - - - - - - &InheritedMethods; - - - - - -
    - -
    - - - -
    - diff --git a/reference/luasandbox/luasandboxsyntaxerror.xml b/reference/luasandbox/luasandboxsyntaxerror.xml deleted file mode 100644 index 75c2ae450954..000000000000 --- a/reference/luasandbox/luasandboxsyntaxerror.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - The LuaSandboxSyntaxError class - LuaSandboxSyntaxError - - - - -
    - &reftitle.intro; - - Exception thrown when Lua code cannot be parsed. - -
    - - -
    - &reftitle.classsynopsis; - - - - LuaSandboxSyntaxError - - - - - LuaSandboxSyntaxError - - - - extends - LuaSandboxFatalError - - - - - &InheritedProperties; - - - - - - &InheritedMethods; - - - - - -
    - -
    - - - -
    - diff --git a/reference/luasandbox/luasandboxtimeouterror.xml b/reference/luasandbox/luasandboxtimeouterror.xml deleted file mode 100644 index 978f453b4ae9..000000000000 --- a/reference/luasandbox/luasandboxtimeouterror.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - The LuaSandboxTimeoutError class - LuaSandboxTimeoutError - - - - -
    - &reftitle.intro; - - Exception thrown when the configured CPU time limit is exceeded. - -
    - - -
    - &reftitle.classsynopsis; - - - - LuaSandboxTimeoutError - - - - - LuaSandboxTimeoutError - - - - extends - LuaSandboxFatalError - - - - - &InheritedProperties; - - - - - - &InheritedMethods; - - - - - -
    - -
    - &reftitle.seealso; - - LuaSandbox::setCPULimit - -
    - -
    - - - -
    - diff --git a/reference/luasandbox/setup.xml b/reference/luasandbox/setup.xml deleted file mode 100644 index c85c1ab55f86..000000000000 --- a/reference/luasandbox/setup.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - &reftitle.setup; - -
    - &reftitle.required; - - To use this extension, Lua 5.1 will need to be installed, available on the Lua homepage. - - - To make full use of the timer features, LuaSandbox should be installed on - Linux. - - - If FreeBSD or Mac OS X is used, only real (wall-clock) time is - supported, the functions purporting to return CPU time will actually return - wall clock time. - - - If Windows is used, no timer functions will be supported. The time limits - will be inoperable. - -
    - -
    - &reftitle.install; - - - If the operating system is Debian 10 or later, or Ubuntu 18.04 or later, then - LuaSandbox should typically be installed from the package - php-luasandbox: - - - - - - - - To install LuaSandbox using PIE, - run the following command: - - - - - - - - Old releases can be found in the LuaSandbox PECL package. - - - -
    - -
    - diff --git a/reference/luasandbox/versions.xml b/reference/luasandbox/versions.xml deleted file mode 100644 index 46cb2ea3561c..000000000000 --- a/reference/luasandbox/versions.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/lzf/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/lzf/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/lzf/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/lzf/book.xml b/reference/lzf/book.xml deleted file mode 100644 index 25ab569d17f6..000000000000 --- a/reference/lzf/book.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - LZF - LZF - - - - &reftitle.intro; - - LZF is a very fast compression algorithm, ideal for saving space with - only slight speed cost. It can be optimized for speed or space at the - time of compilation. This extension is using liblzf - library by Marc Lehmann for its operations. - - - - - &reference.lzf.setup; - &reference.lzf.reference; - - - diff --git a/reference/lzf/configure.xml b/reference/lzf/configure.xml deleted file mode 100644 index 9b1298b62f32..000000000000 --- a/reference/lzf/configure.xml +++ /dev/null @@ -1,41 +0,0 @@ - - -
    - &reftitle.install; - - &pecl.moved; - &pecl.info; - &url.pecl.package;lzf. - - - In order to use these functions you must compile PHP with lzf support - by using the - configure option. You may also pass - to - optimize LZF for space rather than speed. - - - Windows users will enable php_lzf.dll inside - of &php.ini; in order to use these functions. - -
    - diff --git a/reference/lzf/functions/lzf-compress.xml b/reference/lzf/functions/lzf-compress.xml deleted file mode 100644 index d091ce41689e..000000000000 --- a/reference/lzf/functions/lzf-compress.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - lzf_compress - - LZF compression - - - - &reftitle.description; - - stringlzf_compress - stringdata - - - lzf_compress compresses the given - data string using LZF encoding. - - - - &reftitle.parameters; - - - data - - - The string to compress. - - - - - - - &reftitle.returnvalues; - - Returns the compressed data or &false; if an error occurred. - - - - &reftitle.seealso; - - lzf_decompress - - - - diff --git a/reference/lzf/functions/lzf-decompress.xml b/reference/lzf/functions/lzf-decompress.xml deleted file mode 100644 index af37ed29b193..000000000000 --- a/reference/lzf/functions/lzf-decompress.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - lzf_decompress - - LZF decompression - - - - &reftitle.description; - - stringlzf_decompress - stringdata - - - lzf_compress decompresses the given - data string containing lzf encoded data. - - - - &reftitle.parameters; - - - data - - - The compressed string. - - - - - - - &reftitle.returnvalues; - - Returns the decompressed data or &false; if an error occurred. - - - - &reftitle.seealso; - - lzf_compress - - - - diff --git a/reference/lzf/functions/lzf-optimized-for.xml b/reference/lzf/functions/lzf-optimized-for.xml deleted file mode 100644 index c7e694995b52..000000000000 --- a/reference/lzf/functions/lzf-optimized-for.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - lzf_optimized_for - - Determines what LZF extension was optimized for - - - - &reftitle.description; - - intlzf_optimized_for - - - - Determines what was LZF extension optimized for during compilation. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns 1 if LZF was optimized for speed, 0 for compression. - - - - diff --git a/reference/lzf/reference.xml b/reference/lzf/reference.xml deleted file mode 100644 index a6306154a943..000000000000 --- a/reference/lzf/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - LZF &Functions; - - &reference.lzf.entities.functions; - - - - diff --git a/reference/lzf/setup.xml b/reference/lzf/setup.xml deleted file mode 100644 index 07070ab9058d..000000000000 --- a/reference/lzf/setup.xml +++ /dev/null @@ -1,33 +0,0 @@ - - - - - &reftitle.setup; - - - &reference.lzf.configure; - - - - - - diff --git a/reference/lzf/versions.xml b/reference/lzf/versions.xml deleted file mode 100644 index 6306aac69496..000000000000 --- a/reference/lzf/versions.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - - - - - - diff --git a/reference/mailparse/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/mailparse/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/mailparse/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/mailparse/book.xml b/reference/mailparse/book.xml deleted file mode 100644 index 7cd4d94f5947..000000000000 --- a/reference/mailparse/book.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - Mailparse - - - - &reftitle.intro; - - Mailparse is an extension for parsing and working with email messages. - It can deal with RFC 822 and RFC 2045 (MIME) compliant - messages. - - - Mailparse is stream based, which means that it does not keep in-memory - copies of the files it processes - so it is very resource efficient when - dealing with large messages. - - - - Mailparse requires the mbstring - extension, and mbstring must be loaded before mailparse. - - - - - - &reference.mailparse.setup; - &reference.mailparse.constants; - - &reference.mailparse.reference; - - - diff --git a/reference/mailparse/configure.xml b/reference/mailparse/configure.xml deleted file mode 100644 index e92c20f59df4..000000000000 --- a/reference/mailparse/configure.xml +++ /dev/null @@ -1,44 +0,0 @@ - - -
    - &reftitle.install; - - &pecl.moved; - &pecl.info; - &url.pecl.package;mailparse. - - - In order to use these functions you must compile PHP with mailparse support - by using the configure - option. - - - Windows users will enable php_mailparse.dll inside - of &php.ini; in order to use these functions. - &pecl.windows.download.avail; - - - It is necessary that the mbstring - extension is loaded before mailparse. - -
    - diff --git a/reference/mailparse/constants.xml b/reference/mailparse/constants.xml deleted file mode 100644 index 0664f9274bb1..000000000000 --- a/reference/mailparse/constants.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - &reftitle.constants; - &extension.constants; - - - - MAILPARSE_EXTRACT_OUTPUT - (int) - - - - - - - - - MAILPARSE_EXTRACT_STREAM - (int) - - - - - - - - - MAILPARSE_EXTRACT_RETURN - (int) - - - - - - - - - - diff --git a/reference/mailparse/functions/mailparse-determine-best-xfer-encoding.xml b/reference/mailparse/functions/mailparse-determine-best-xfer-encoding.xml deleted file mode 100644 index 69306365475d..000000000000 --- a/reference/mailparse/functions/mailparse-determine-best-xfer-encoding.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - mailparse_determine_best_xfer_encoding - Gets the best way of encoding - - - &reftitle.description; - - stringmailparse_determine_best_xfer_encoding - resourcefp - - - Figures out the best way of encoding the content read from the given file - pointer. - - - - - &reftitle.parameters; - - - fp - - - A valid file pointer, which must be seek-able. - - - - - - - - &reftitle.returnvalues; - - Returns one of the character encodings supported by the - mbstring module. - - - - - - &reftitle.examples; - - <function>mailparse_determine_best_xfer_encoding</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/mailparse/functions/mailparse-msg-create.xml b/reference/mailparse/functions/mailparse-msg-create.xml deleted file mode 100644 index f37f1997d5cc..000000000000 --- a/reference/mailparse/functions/mailparse-msg-create.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - mailparse_msg_create - Create a mime mail resource - - - &reftitle.description; - - resourcemailparse_msg_create - - - - Create a MIME mail resource. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a handle that can be used to parse a message. - - - - - &reftitle.notes; - - - It is recommended to call mailparse_msg_free on the result - of this function, when it is no longer needed, to avoid memory leaks. - - - - - - &reftitle.seealso; - - mailparse_msg_free - mailparse_msg_parse_file - - - - - diff --git a/reference/mailparse/functions/mailparse-msg-extract-part-file.xml b/reference/mailparse/functions/mailparse-msg-extract-part-file.xml deleted file mode 100644 index f10de454f80a..000000000000 --- a/reference/mailparse/functions/mailparse-msg-extract-part-file.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - mailparse_msg_extract_part_file - Extracts/decodes a message section - - - &reftitle.description; - - stringmailparse_msg_extract_part_file - resourcemimemail - mixedfilename - callablecallbackfunc - - - Extracts/decodes a message section from the supplied filename. - - - The contents of the section will be decoded according to their transfer - encoding - base64, quoted-printable and uuencoded text are supported. - - - - - &reftitle.parameters; - - - mimemail - - - A valid MIME resource, created with - mailparse_msg_create. - - - - - filename - - - Can be a file name or a valid stream resource. - - - - - callbackfunc - - - If set, this must be either a valid callback that will be passed the - extracted section, or &null; to make this function return the - extracted section. - - - If not specified, the contents will be sent to "stdout". - - - - - - - - &reftitle.returnvalues; - - If callbackfunc is not &null; returns &true; on - success. - - - If callbackfunc is set to &null;, returns the - extracted section as a string. - - - Returns &false; on error. - - - - - &reftitle.seealso; - - mailparse_msg_extract_part - mailparse_msg_extract_whole_part_file - - - - - diff --git a/reference/mailparse/functions/mailparse-msg-extract-part.xml b/reference/mailparse/functions/mailparse-msg-extract-part.xml deleted file mode 100644 index 46b70f18b475..000000000000 --- a/reference/mailparse/functions/mailparse-msg-extract-part.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - mailparse_msg_extract_part - - Extracts/decodes a message section - - - - &reftitle.description; - - voidmailparse_msg_extract_part - resourcemimemail - stringmsgbody - callablecallbackfunc - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - mimemail - - - A valid MIME resource. - - - - - msgbody - - - - - - - callbackfunc - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - mailparse_msg_extract_part_file - mailparse_msg_extract_whole_part_file - - - - - diff --git a/reference/mailparse/functions/mailparse-msg-extract-whole-part-file.xml b/reference/mailparse/functions/mailparse-msg-extract-whole-part-file.xml deleted file mode 100644 index ff37575c2920..000000000000 --- a/reference/mailparse/functions/mailparse-msg-extract-whole-part-file.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - mailparse_msg_extract_whole_part_file - Extracts a message section including headers without decoding the transfer encoding - - - &reftitle.description; - - stringmailparse_msg_extract_whole_part_file - resourcemimemail - stringfilename - callablecallbackfunc - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - mimemail - - - A valid MIME resource. - - - - - filename - - - - - - - callbackfunc - - - - - - - - - - &reftitle.returnvalues; - - - - - - &reftitle.seealso; - - mailparse_msg_extract_part - mailparse_msg_extract_part_file - - - - - diff --git a/reference/mailparse/functions/mailparse-msg-free.xml b/reference/mailparse/functions/mailparse-msg-free.xml deleted file mode 100644 index ded38f4977fc..000000000000 --- a/reference/mailparse/functions/mailparse-msg-free.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - mailparse_msg_free - Frees a MIME resource - - - &reftitle.description; - - boolmailparse_msg_free - resourcemimemail - - - Frees a MIME resource. - - - - - &reftitle.parameters; - - - mimemail - - - A valid MIME resource allocated by - mailparse_msg_create or - mailparse_msg_parse_file. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - mailparse_msg_create - mailparse_msg_parse_file - - - - - diff --git a/reference/mailparse/functions/mailparse-msg-get-part-data.xml b/reference/mailparse/functions/mailparse-msg-get-part-data.xml deleted file mode 100644 index cb50d978e354..000000000000 --- a/reference/mailparse/functions/mailparse-msg-get-part-data.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - mailparse_msg_get_part_data - Returns an associative array of info about the message - - - &reftitle.description; - - arraymailparse_msg_get_part_data - resourcemimemail - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - mimemail - - - A valid MIME resource. - - - - - - - - diff --git a/reference/mailparse/functions/mailparse-msg-get-part.xml b/reference/mailparse/functions/mailparse-msg-get-part.xml deleted file mode 100644 index c8d2fc15c861..000000000000 --- a/reference/mailparse/functions/mailparse-msg-get-part.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - mailparse_msg_get_part - Returns a handle on a given section in a mimemessage - - - &reftitle.description; - - resourcemailparse_msg_get_part - resourcemimemail - stringmimesection - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - mimemail - - - A valid MIME resource. - - - - - mimesection - - - - - - - - - - diff --git a/reference/mailparse/functions/mailparse-msg-get-structure.xml b/reference/mailparse/functions/mailparse-msg-get-structure.xml deleted file mode 100644 index 155e343515a1..000000000000 --- a/reference/mailparse/functions/mailparse-msg-get-structure.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - mailparse_msg_get_structure - Returns an array of mime section names in the supplied message - - - &reftitle.description; - - arraymailparse_msg_get_structure - resourcemimemail - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - mimemail - - - A valid MIME resource. - - - - - - - - diff --git a/reference/mailparse/functions/mailparse-msg-parse-file.xml b/reference/mailparse/functions/mailparse-msg-parse-file.xml deleted file mode 100644 index 6bcf82ba8a61..000000000000 --- a/reference/mailparse/functions/mailparse-msg-parse-file.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - mailparse_msg_parse_file - Parses a file - - - &reftitle.description; - - resourcemailparse_msg_parse_file - stringfilename - - - Parses a file. - This is the optimal way of parsing a mail file that you have on disk. - - - - - &reftitle.parameters; - - - filename - - - Path to the file holding the message. - The file is opened and streamed through the parser. - - - - The message contained in filename is supposed to end with a newline - (CRLF); otherwise the last line of the message will not be parsed. - - - - - - - - - &reftitle.returnvalues; - - Returns a MIME resource representing the structure, or - &false; on error. - - - - - &reftitle.notes; - - - It is recommended to call mailparse_msg_free on the result - of this function, when it is no longer needed, to avoid memory leaks. - - - - - - &reftitle.seealso; - - mailparse_msg_free - mailparse_msg_create - - - - - diff --git a/reference/mailparse/functions/mailparse-msg-parse.xml b/reference/mailparse/functions/mailparse-msg-parse.xml deleted file mode 100644 index 1b07ae0b809d..000000000000 --- a/reference/mailparse/functions/mailparse-msg-parse.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - mailparse_msg_parse - Incrementally parse data into buffer - - - &reftitle.description; - - boolmailparse_msg_parse - resourcemimemail - stringdata - - - Incrementally parse data into the supplied mime mail resource. - - - This function allow you to stream portions of a file at a time, rather - than read and parse the whole thing. - - - - - &reftitle.parameters; - - - mimemail - - - A valid MIME resource. - - - - - data - - - - The final chunk of data is supposed to end with a newline - (CRLF); otherwise the last line of the message will not be parsed. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/mailparse/functions/mailparse-rfc822-parse-addresses.xml b/reference/mailparse/functions/mailparse-rfc822-parse-addresses.xml deleted file mode 100644 index b30da0866bd6..000000000000 --- a/reference/mailparse/functions/mailparse-rfc822-parse-addresses.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - mailparse_rfc822_parse_addresses - Parse RFC 822 compliant addresses - - - &reftitle.description; - - arraymailparse_rfc822_parse_addresses - stringaddresses - - - Parses a RFC 822 compliant recipient - list, such as that found in the To: header. - - - - - &reftitle.parameters; - - - addresses - - - A string containing addresses, like in: - Wez Furlong <wez@example.com>, doe@example.com - - - - This string must not include the header name. - - - - - - - - - &reftitle.returnvalues; - - Returns an array of associative arrays with the following keys for each - recipient: - - - - - display - - The recipient name, for display purpose. If this part is not set for a - recipient, this key will hold the same value as - address. - - - - address - The email address - - - is_group - &true; if the recipient is a newsgroup, &false; otherwise. - - - - - - - - - &reftitle.examples; - - <function>mailparse_rfc822_parse_addresses</function> example - -, doe@example.com'; -var_dump(mailparse_rfc822_parse_addresses($to)); - -?> -]]> - - &example.outputs; - - - array(3) { - ["display"]=> - string(11) "Wez Furlong" - ["address"]=> - string(15) "wez@example.com" - ["is_group"]=> - bool(false) - } - [1]=> - array(3) { - ["display"]=> - string(15) "doe@example.com" - ["address"]=> - string(15) "doe@example.com" - ["is_group"]=> - bool(false) - } -} -]]> - - - - - - diff --git a/reference/mailparse/functions/mailparse-stream-encode.xml b/reference/mailparse/functions/mailparse-stream-encode.xml deleted file mode 100644 index 41c37cf96761..000000000000 --- a/reference/mailparse/functions/mailparse-stream-encode.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - mailparse_stream_encode - - Streams data from source file pointer, apply encoding and write to destfp - - - - &reftitle.description; - - boolmailparse_stream_encode - resourcesourcefp - resourcedestfp - stringencoding - - - Streams data from the source file pointer, apply - encoding and write to the destination file pointer. - - - - - &reftitle.parameters; - - - sourcefp - - - A valid file handle. The file is streamed through the parser. - - - - - destfp - - - The destination file handle in which the encoded data will be written. - - - - - encoding - - - One of the character encodings supported by the - mbstring module. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>mailparse_stream_encode</function> example - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/mailparse/functions/mailparse-uudecode-all.xml b/reference/mailparse/functions/mailparse-uudecode-all.xml deleted file mode 100644 index 12ae26833c6a..000000000000 --- a/reference/mailparse/functions/mailparse-uudecode-all.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - mailparse_uudecode_all - - Scans the data from fp and extract each embedded uuencoded file - - - - &reftitle.description; - - arraymailparse_uudecode_all - resourcefp - - - Scans the data from the given file pointer and extract each embedded - uuencoded file into a temporary file. - - - - - &reftitle.parameters; - - - fp - - - A valid file pointer. - - - - - - - - &reftitle.returnvalues; - - Returns an array of associative arrays listing filename information. - - - - - filename - Path to the temporary file name created - - - origfilename - The original filename, for uuencoded parts only - - - - - The first filename entry is the message body. The next entries are the - decoded uuencoded files. - - - - - &reftitle.examples; - - <function>mailparse_uudecode_all</function> example - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/mailparse/reference.xml b/reference/mailparse/reference.xml deleted file mode 100644 index d72ed1681589..000000000000 --- a/reference/mailparse/reference.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - Mailparse &Functions; - -&reference.mailparse.entities.functions; - - - diff --git a/reference/mailparse/setup.xml b/reference/mailparse/setup.xml deleted file mode 100644 index 5abf24b0bc49..000000000000 --- a/reference/mailparse/setup.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - &reftitle.setup; - - - &reference.mailparse.configure; - - - -
    - &reftitle.runtime; - &extension.runtime; - - - Mailparse &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - mailparse.def_charset - "us-ascii" - INI_SYSTEM - - - - -
    - &ini.php.constants; -
    - - &ini.descriptions.title; - - - - - mailparse.def_charset - string - - - - The default character set. - - - - -
    - - - -
    - &reftitle.resources; - - Mailparse defines the resource type mailparse_mail_structure, - which is returned by mailparse_msg_create and - mailparse_msg_parse_file. - -
    - - -
    - diff --git a/reference/mailparse/versions.xml b/reference/mailparse/versions.xml deleted file mode 100644 index 636430fd2ad3..000000000000 --- a/reference/mailparse/versions.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/mcrypt/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/mcrypt/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/mcrypt/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/mcrypt/book.xml b/reference/mcrypt/book.xml deleted file mode 100644 index 91393f5eed5a..000000000000 --- a/reference/mcrypt/book.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - Mcrypt - - - - &reftitle.intro; - - &warn.deprecated.feature.7-1-0.removed.7-2-0.alternatives; - - - Sodium - (available as of PHP 7.2.0) - - - OpenSSL - - - - - - - &pecl.moved-ver;7.2.0. - - - - - This is an interface to the mcrypt library, which supports a wide - variety of block algorithms such as DES, TripleDES, Blowfish - (default), 3-WAY, SAFER-SK64, SAFER-SK128, TWOFISH, TEA, RC2 and - GOST in CBC, OFB, CFB and ECB cipher modes. Additionally, it - supports RC6 and IDEA which are considered "non-free". - CFB/OFB are 8bit by default. - - - - - &reference.mcrypt.setup; - &reference.mcrypt.constants; - &reference.mcrypt.ciphers; - &reference.mcrypt.reference; - - - diff --git a/reference/mcrypt/ciphers.xml b/reference/mcrypt/ciphers.xml deleted file mode 100644 index a06cd654991f..000000000000 --- a/reference/mcrypt/ciphers.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - Mcrypt ciphers - - Here is a list of ciphers which are currently supported by the mcrypt - extension. For a complete list of supported ciphers, see the defines at - the end of mcrypt.h. The general rule with the - mcrypt-2.2.x API is that you can access the cipher from PHP with - MCRYPT_ciphername. With the libmcrypt-2.4.x and libmcrypt-2.5.x API these constants also work, - but it is possible to specify the name of the cipher as a string with a - call to mcrypt_module_open. - - MCRYPT_3DES - MCRYPT_ARCFOUR_IV (libmcrypt > 2.4.x only) - MCRYPT_ARCFOUR (libmcrypt > 2.4.x only) - MCRYPT_BLOWFISH - MCRYPT_CAST_128 - MCRYPT_CAST_256 - MCRYPT_CRYPT - MCRYPT_DES - MCRYPT_DES_COMPAT (libmcrypt 2.2.x only) - MCRYPT_ENIGMA (libmcrypt > 2.4.x only, alias for MCRYPT_CRYPT) - MCRYPT_GOST - MCRYPT_IDEA (non-free) - MCRYPT_LOKI97 (libmcrypt > 2.4.x only) - MCRYPT_MARS (libmcrypt > 2.4.x only, non-free) - MCRYPT_PANAMA (libmcrypt > 2.4.x only) - MCRYPT_RIJNDAEL_128 (libmcrypt > 2.4.x only) - MCRYPT_RIJNDAEL_192 (libmcrypt > 2.4.x only) - MCRYPT_RIJNDAEL_256 (libmcrypt > 2.4.x only) - MCRYPT_RC2 - MCRYPT_RC4 (libmcrypt 2.2.x only) - MCRYPT_RC6 (libmcrypt > 2.4.x only) - MCRYPT_RC6_128 (libmcrypt 2.2.x only) - MCRYPT_RC6_192 (libmcrypt 2.2.x only) - MCRYPT_RC6_256 (libmcrypt 2.2.x only) - MCRYPT_SAFER64 - MCRYPT_SAFER128 - MCRYPT_SAFERPLUS (libmcrypt > 2.4.x only) - MCRYPT_SERPENT(libmcrypt > 2.4.x only) - MCRYPT_SERPENT_128 (libmcrypt 2.2.x only) - MCRYPT_SERPENT_192 (libmcrypt 2.2.x only) - MCRYPT_SERPENT_256 (libmcrypt 2.2.x only) - MCRYPT_SKIPJACK (libmcrypt > 2.4.x only) - MCRYPT_TEAN (libmcrypt 2.2.x only) - MCRYPT_THREEWAY - MCRYPT_TRIPLEDES (libmcrypt > 2.4.x only) - MCRYPT_TWOFISH (for older mcrypt 2.x versions, or mcrypt > 2.4.x ) - MCRYPT_TWOFISH128 (TWOFISHxxx are available in newer 2.x versions, but not in the 2.4.x versions) - MCRYPT_TWOFISH192 - MCRYPT_TWOFISH256 - MCRYPT_WAKE (libmcrypt > 2.4.x only) - MCRYPT_XTEA (libmcrypt > 2.4.x only) - - - - You must (in CFB and OFB mode) - or can (in CBC mode) supply an - initialization vector (IV) to the respective cipher function. The - IV must be unique and must be the same when - decrypting/encrypting. With data which is stored encrypted, you - can take the output of a function of the index under which the - data is stored (e.g. the MD5 key of the filename). - Alternatively, you can transmit the IV together with the encrypted - data (see chapter 9.3 of &book.applied.cryptography; for a - discussion of this topic). - - - diff --git a/reference/mcrypt/configure.xml b/reference/mcrypt/configure.xml deleted file mode 100644 index 500529191e41..000000000000 --- a/reference/mcrypt/configure.xml +++ /dev/null @@ -1,32 +0,0 @@ - - -
    - &reftitle.install; - - &pecl.moved-ver;7.2.0 - - - &pecl.info; - &url.pecl.package;mcrypt. - -
    - diff --git a/reference/mcrypt/constants.xml b/reference/mcrypt/constants.xml deleted file mode 100644 index 60ace1d467ed..000000000000 --- a/reference/mcrypt/constants.xml +++ /dev/null @@ -1,161 +0,0 @@ - - - - &reftitle.constants; - &extension.constants; - - Mcrypt can operate in four block cipher modes (CBC, - OFB, CFB, and - ECB). If linked against libmcrypt-2.4.x or higher the - functions can also operate in the block cipher mode nOFB - and in STREAM mode. Below you find a list with all - supported encryption modes together with the constants that are - defined for the encryption mode. For a more complete reference and - discussion see &book.applied.cryptography;. - - - - MCRYPT_MODE_ECB (electronic - codebook) is a block cipher mode that is generally - unsuitable for most purposes. The use of this mode is not recommended. - - - - - MCRYPT_MODE_CBC (cipher block - chaining) is a block cipher mode that is significantly - more secure than ECB mode. - - - - - MCRYPT_MODE_CFB (cipher - feedback, in 8-bit mode) is a stream cipher mode. - It is recommended to use NCFB mode rather - than CFB mode. - - - - - MCRYPT_MODE_OFB (output feedback, in - 8-bit mode) is a stream cipher mode comparable to CFB, but - can be used in applications where error propagation cannot - be tolerated. - It is recommended to use NOFB mode rather - than OFB mode. - - - - - MCRYPT_MODE_NOFB (output feedback, - in n-bit mode) is comparable to OFB mode, - but operates on the full block size of the algorithm. - - - - - MCRYPT_MODE_STREAM is an extra mode to include - some stream algorithms like "WAKE" or "RC4". - - - - - - - Mcrypt supports some other modes of operation for which there are no predefined constants. - They can be utilised by passing a string in place of the missing constants. - - - - "ctr" (counter mode) is a stream cipher mode. - - - - - "ncfb" (cipher feedback, - in n-bit mode) is comparable to CFB mode, - but operates on the full block size of the algorithm. - - - - - - - Some other mode and random device constants: - - - - MCRYPT_ENCRYPT - (int) - - - - - - - - - - MCRYPT_DECRYPT - (int) - - - - - - - - - - MCRYPT_DEV_RANDOM - (int) - - - - - - - - - - MCRYPT_DEV_URANDOM - (int) - - - - - - - - - - MCRYPT_RAND - (int) - - - - - - - - - - - - diff --git a/reference/mcrypt/functions/mcrypt-create-iv.xml b/reference/mcrypt/functions/mcrypt-create-iv.xml deleted file mode 100644 index 7af8c29d42ec..000000000000 --- a/reference/mcrypt/functions/mcrypt-create-iv.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - mcrypt_create_iv - Creates an initialization vector (IV) from a random source - - - - - &warn.deprecated.function.7-1-0.removed.7-2-0.alternatives; - - random_bytes - - - - - - &reftitle.description; - - stringmcrypt_create_iv - intsize - intsourceMCRYPT_DEV_URANDOM - - - Creates an initialization vector (IV) from a random source. - - - The IV is only meant to give an alternative seed to the encryption - routines. This IV does not need to be secret at all, though it can be - desirable. You even can send it along with your ciphertext without - losing security. - - - - - &reftitle.parameters; - - - size - - - The size of the IV. - - - - - source - - - The source of the IV. The source can be - MCRYPT_RAND (system random number generator), - MCRYPT_DEV_RANDOM (read data from - /dev/random) and - MCRYPT_DEV_URANDOM (read data from - /dev/urandom). Prior to 5.3.0, - MCRYPT_RAND was the only one supported on Windows. - - - Note that the default value of this parameter was - MCRYPT_DEV_RANDOM prior to PHP 5.6.0. - - - - Note that MCRYPT_DEV_RANDOM may block until more - entropy is available. - - - - - - - - - &reftitle.returnvalues; - - Returns the initialization vector, or &false; on error. - - - - - &reftitle.examples; - - <function>mcrypt_create_iv</function> Example - - -]]> - - - - - - &reftitle.seealso; - - &url.mcrypt.iv; - &url.mcrypt.bcm; - Chapter 9.3 of &book.applied.cryptography; - random_bytes - - - - diff --git a/reference/mcrypt/functions/mcrypt-decrypt.xml b/reference/mcrypt/functions/mcrypt-decrypt.xml deleted file mode 100644 index 2badcdb1c2c4..000000000000 --- a/reference/mcrypt/functions/mcrypt-decrypt.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - mcrypt_decrypt - Decrypts crypttext with given parameters - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - stringfalsemcrypt_decrypt - stringcipher - stringkey - stringdata - stringmode - stringiv - - - Decrypts the data and returns the unencrypted data. - - - - &reftitle.parameters; - - - cipher - - &mcrypt.parameter.cipher; - - - - key - - - The key with which the data was encrypted. If the provided key size is - not supported by the cipher, the function will emit a warning and return &false; - - - - - data - - - The data that will be decrypted with the given cipher - and mode. If the size of the data is not n * blocksize, - the data will be padded with '\0'. - - - - - mode - - &mcrypt.parameter.mode; - - - - iv - - &mcrypt.parameter.iv.strict; - - - - - - - &reftitle.returnvalues; - - Returns the decrypted data as a string &return.falseforfailure;. - - - - - &reftitle.seealso; - - mcrypt_encrypt - - - - diff --git a/reference/mcrypt/functions/mcrypt-enc-get-algorithms-name.xml b/reference/mcrypt/functions/mcrypt-enc-get-algorithms-name.xml deleted file mode 100644 index 9d0c348a98a5..000000000000 --- a/reference/mcrypt/functions/mcrypt-enc-get-algorithms-name.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - mcrypt_enc_get_algorithms_name - Returns the name of the opened algorithm - - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - - &reftitle.description; - - stringmcrypt_enc_get_algorithms_name - resourcetd - - - This function returns the name of the algorithm. - - - - - &reftitle.parameters; - - - td - - - The encryption descriptor. - - - - - - - - &reftitle.returnvalues; - - Returns the name of the opened algorithm as a string. - - - - - &reftitle.examples; - - <function>mcrypt_enc_get_algorithms_name</function> example - - -]]> - - &example.outputs; - - - - - - - diff --git a/reference/mcrypt/functions/mcrypt-enc-get-block-size.xml b/reference/mcrypt/functions/mcrypt-enc-get-block-size.xml deleted file mode 100644 index e4b559e77a93..000000000000 --- a/reference/mcrypt/functions/mcrypt-enc-get-block-size.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - mcrypt_enc_get_block_size - Returns the blocksize of the opened algorithm - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - intmcrypt_enc_get_block_size - resourcetd - - - Gets the blocksize of the opened algorithm. - - - - &reftitle.parameters; - - - td - - - The encryption descriptor. - - - - - - - &reftitle.returnvalues; - - Returns the block size of the specified algorithm in bytes. - - - - diff --git a/reference/mcrypt/functions/mcrypt-enc-get-iv-size.xml b/reference/mcrypt/functions/mcrypt-enc-get-iv-size.xml deleted file mode 100644 index 7f3b74caff64..000000000000 --- a/reference/mcrypt/functions/mcrypt-enc-get-iv-size.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - mcrypt_enc_get_iv_size - Returns the size of the IV of the opened algorithm - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - intmcrypt_enc_get_iv_size - resourcetd - - - This function returns the size of the IV of the algorithm specified by the - encryption descriptor in bytes. An IV is used in cbc, cfb and ofb modes, - and in some algorithms in stream mode. - - - - &reftitle.parameters; - - - td - - - The encryption descriptor. - - - - - - - &reftitle.returnvalues; - - Returns the size of the IV, or 0 if the IV is ignored by the algorithm. - - - - diff --git a/reference/mcrypt/functions/mcrypt-enc-get-key-size.xml b/reference/mcrypt/functions/mcrypt-enc-get-key-size.xml deleted file mode 100644 index 5dc131634a64..000000000000 --- a/reference/mcrypt/functions/mcrypt-enc-get-key-size.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - mcrypt_enc_get_key_size - Returns the maximum supported keysize of the opened mode - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - intmcrypt_enc_get_key_size - resourcetd - - - Gets the maximum supported key size of the algorithm in bytes. - - - - &reftitle.parameters; - - - td - - - The encryption descriptor. - - - - - - - &reftitle.returnvalues; - - Returns the maximum supported key size of the algorithm in bytes. - - - - diff --git a/reference/mcrypt/functions/mcrypt-enc-get-modes-name.xml b/reference/mcrypt/functions/mcrypt-enc-get-modes-name.xml deleted file mode 100644 index 016557583d2a..000000000000 --- a/reference/mcrypt/functions/mcrypt-enc-get-modes-name.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - mcrypt_enc_get_modes_name - Returns the name of the opened mode - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - stringmcrypt_enc_get_modes_name - resourcetd - - - This function returns the name of the mode. - - - - &reftitle.parameters; - - - td - - - The encryption descriptor. - - - - - - - &reftitle.returnvalues; - - Returns the name as a string. - - - - &reftitle.examples; - - <function>mcrypt_enc_get_modes_name</function> example - - -]]> - - &example.outputs; - - - - - - - diff --git a/reference/mcrypt/functions/mcrypt-enc-get-supported-key-sizes.xml b/reference/mcrypt/functions/mcrypt-enc-get-supported-key-sizes.xml deleted file mode 100644 index b1db0d632cb9..000000000000 --- a/reference/mcrypt/functions/mcrypt-enc-get-supported-key-sizes.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - mcrypt_enc_get_supported_key_sizes - Returns an array with the supported keysizes of the opened algorithm - - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - - &reftitle.description; - - arraymcrypt_enc_get_supported_key_sizes - resourcetd - - - Gets the supported key sizes of the opened algorithm. - - - - - &reftitle.parameters; - - - td - - - The encryption descriptor. - - - - - - - - &reftitle.returnvalues; - - Returns an array with the key sizes supported by the algorithm - specified by the encryption descriptor. If it returns an empty - array then all key sizes between 1 and - mcrypt_enc_get_key_size are supported by the - algorithm. - - - - - &reftitle.examples; - - <function>mcrypt_enc_get_supported_key_sizes</function> example - - -]]> - - &example.outputs; - - - int(16) - [1]=> - int(24) - [2]=> - int(32) -} -]]> - - - - - diff --git a/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm-mode.xml b/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm-mode.xml deleted file mode 100644 index 4fde77e22cbe..000000000000 --- a/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm-mode.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - mcrypt_enc_is_block_algorithm_mode - Checks whether the encryption of the opened mode works on blocks - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - boolmcrypt_enc_is_block_algorithm_mode - resourcetd - - - Tells whether the algorithm of the opened mode works on blocks (e.g. - &false; for stream, and &true; for cbc, cfb, ofb).. - - - - &reftitle.parameters; - - - td - - - The encryption descriptor. - - - - - - - &reftitle.returnvalues; - - Returns &true; if the mode is for use with block algorithms, otherwise it - returns &false;. - - - - diff --git a/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm.xml b/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm.xml deleted file mode 100644 index 635df7391ef5..000000000000 --- a/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - mcrypt_enc_is_block_algorithm - Checks whether the algorithm of the opened mode is a block algorithm - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - boolmcrypt_enc_is_block_algorithm - resourcetd - - - Tells whether the algorithm of the opened mode is a block algorithm. - - - - &reftitle.parameters; - - - td - - - The encryption descriptor. - - - - - - - &reftitle.returnvalues; - - Returns &true; if the algorithm is a block algorithm or &false; if it is - a stream one. - - - - diff --git a/reference/mcrypt/functions/mcrypt-enc-is-block-mode.xml b/reference/mcrypt/functions/mcrypt-enc-is-block-mode.xml deleted file mode 100644 index 94186970b12e..000000000000 --- a/reference/mcrypt/functions/mcrypt-enc-is-block-mode.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - mcrypt_enc_is_block_mode - Checks whether the opened mode outputs blocks - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - boolmcrypt_enc_is_block_mode - resourcetd - - - Tells whether the opened mode outputs blocks (e.g. &true; for cbc and ecb, - and &false; for cfb and stream). - - - - &reftitle.parameters; - - - td - - - The encryption descriptor. - - - - - - - &reftitle.returnvalues; - - Returns &true; if the mode outputs blocks of bytes, - or &false; if it outputs just bytes. - - - - diff --git a/reference/mcrypt/functions/mcrypt-enc-self-test.xml b/reference/mcrypt/functions/mcrypt-enc-self-test.xml deleted file mode 100644 index 263526c9dd50..000000000000 --- a/reference/mcrypt/functions/mcrypt-enc-self-test.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - mcrypt_enc_self_test - Runs a self test on the opened module - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - intmcrypt_enc_self_test - resourcetd - - - This function runs the self test on the algorithm specified by the - descriptor td. - - - - &reftitle.parameters; - - - td - - - The encryption descriptor. - - - - - - - &reftitle.returnvalues; - - Returns 0 on success and a negative &integer; on failure. - - - - diff --git a/reference/mcrypt/functions/mcrypt-encrypt.xml b/reference/mcrypt/functions/mcrypt-encrypt.xml deleted file mode 100644 index cec4be3fe4cc..000000000000 --- a/reference/mcrypt/functions/mcrypt-encrypt.xml +++ /dev/null @@ -1,183 +0,0 @@ - - - - - mcrypt_encrypt - Encrypts plaintext with given parameters - - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - - &reftitle.description; - - stringfalsemcrypt_encrypt - stringcipher - stringkey - stringdata - stringmode - stringiv - - - Encrypts the data and returns it. - - - - - &reftitle.parameters; - - - cipher - - &mcrypt.parameter.cipher; - - - - key - - - The key with which the data will be encrypted. If the provided key size is - not supported by the cipher, the function will emit a warning and return &false; - - - - - data - - - The data that will be encrypted with the given cipher - and mode. If the size of the data is not n * blocksize, - the data will be padded with '\0'. - - - The returned crypttext can be larger than the size of the data that was - given by data. - - - - - mode - - &mcrypt.parameter.mode; - - - - iv - - &mcrypt.parameter.iv.strict; - - - - - - - &reftitle.returnvalues; - - Returns the encrypted data as a string &return.falseforfailure;. - - - - - &reftitle.examples; - - <function>mcrypt_encrypt</function> Example - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - mcrypt_decrypt - mcrypt_module_open - - - - diff --git a/reference/mcrypt/functions/mcrypt-generic-deinit.xml b/reference/mcrypt/functions/mcrypt-generic-deinit.xml deleted file mode 100644 index 8bfa1b85cbb4..000000000000 --- a/reference/mcrypt/functions/mcrypt-generic-deinit.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - mcrypt_generic_deinit - This function deinitializes an encryption module - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - boolmcrypt_generic_deinit - resourcetd - - - This function terminates encryption specified by the encryption - descriptor (td). It clears all buffers, but does - not close the module. You need to call - mcrypt_module_close yourself. (But PHP does this for - you at the end of the script.) - - - - - &reftitle.parameters; - - - td - - - The encryption descriptor. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - mcrypt_module_open - mcrypt_generic_init - - - - - diff --git a/reference/mcrypt/functions/mcrypt-generic-init.xml b/reference/mcrypt/functions/mcrypt-generic-init.xml deleted file mode 100644 index 4d117af8d300..000000000000 --- a/reference/mcrypt/functions/mcrypt-generic-init.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - mcrypt_generic_init - This function initializes all buffers needed for encryption - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - intmcrypt_generic_init - resourcetd - stringkey - stringiv - - - You need to call this function before every call to - mcrypt_generic or - mdecrypt_generic. - - - - &reftitle.parameters; - - - td - - - The encryption descriptor. - - - - - key - - - The maximum length of the key should be the one obtained by calling - mcrypt_enc_get_key_size and every value smaller - than this is legal. - - - - - iv - - - The IV should normally have the size of the algorithms block size, but - you must obtain the size by calling - mcrypt_enc_get_iv_size. IV is ignored in ECB. IV - MUST exist in CFB, CBC, STREAM, nOFB and OFB modes. It needs to be - random and unique (but not secret). The same IV must be used for - encryption/decryption. If you do not want to use it you should set it - to zeros, but this is not recommended. - - - - - - - &reftitle.returnvalues; - - The function returns a negative value on error: -3 when the key length - was incorrect, -4 when there was a memory allocation problem and any - other return value is an unknown error. If an error occurs a warning will - be displayed accordingly. &false; is returned if incorrect parameters - were passed. - - - - &reftitle.seealso; - - mcrypt_module_open - - - - diff --git a/reference/mcrypt/functions/mcrypt-generic.xml b/reference/mcrypt/functions/mcrypt-generic.xml deleted file mode 100644 index 550ae900f6cc..000000000000 --- a/reference/mcrypt/functions/mcrypt-generic.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - mcrypt_generic - This function encrypts data - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - stringmcrypt_generic - resourcetd - stringdata - - - This function encrypts data. The data is padded with "\0" - to make sure the length of the data is n * blocksize. This - function returns the encrypted data. Note that the length - of the returned string can in fact be longer than the input, - due to the padding of the data. - - - If you want to store the encrypted data in a database make sure to store - the entire string as returned by mcrypt_generic, or the string will not - entirely decrypt properly. If your original string is 10 characters long - and the block size is 8 (use - mcrypt_enc_get_block_size to determine the - blocksize), you would need at least 16 characters in your database field. - Note the string returned by mdecrypt_generic will be - 16 characters as well...use rtrim($str, "\0") to remove the padding. - - - If you are for example storing the data in a MySQL database remember that - varchar fields automatically have trailing spaces removed during - insertion. As encrypted data can end in a space (ASCII 32), the data will - be damaged by this removal. Store data in a tinyblob/tinytext (or - larger) field instead. - - - - - &reftitle.parameters; - - - td - - - The encryption descriptor. - - - The encryption handle should always be initialized with - mcrypt_generic_init with a key and an IV before - calling this function. Where the encryption is done, you should free the - encryption buffers by calling mcrypt_generic_deinit. - See mcrypt_module_open for an example. - - - - - data - - - The data to encrypt. - - - - - - - - &reftitle.returnvalues; - - Returns the encrypted data. - - - - - &reftitle.seealso; - - mdecrypt_generic - mcrypt_generic_init - mcrypt_generic_deinit - - - - - diff --git a/reference/mcrypt/functions/mcrypt-get-block-size.xml b/reference/mcrypt/functions/mcrypt-get-block-size.xml deleted file mode 100644 index aaa2ff9df0cf..000000000000 --- a/reference/mcrypt/functions/mcrypt-get-block-size.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - mcrypt_get_block_size - Gets the block size of the specified cipher - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - intfalsemcrypt_get_block_size - intcipher - - - intfalsemcrypt_get_block_size - stringcipher - stringmode - - - The first prototype is when linked against libmcrypt 2.2.x, the - second when linked against libmcrypt 2.4.x or 2.5.x. - - - mcrypt_get_block_size is used to get the - size of a block of the specified cipher (in - combination with an encryption mode). - - - It is more useful to use the mcrypt_enc_get_block_size - function as this uses the resource returned by - mcrypt_module_open. - - - - - &reftitle.parameters; - - - cipher - - &mcrypt.parameter.cipher; - - - - mode - - &mcrypt.parameter.mode; - - - - - - - &reftitle.returnvalues; - - Returns the algorithm block size in bytes &return.falseforfailure;. - - - - - &reftitle.examples; - - <function>mcrypt_get_block_size</function> example - - This example shows how to use this function when linked against libmcrypt - 2.4.x and 2.5.x. - - - -]]> - - - - - - &reftitle.seealso; - - mcrypt_get_key_size - mcrypt_enc_get_block_size - mcrypt_encrypt - - - - - diff --git a/reference/mcrypt/functions/mcrypt-get-cipher-name.xml b/reference/mcrypt/functions/mcrypt-get-cipher-name.xml deleted file mode 100644 index 40e89ba5c821..000000000000 --- a/reference/mcrypt/functions/mcrypt-get-cipher-name.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - mcrypt_get_cipher_name - Gets the name of the specified cipher - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - stringmcrypt_get_cipher_name - intcipher - - - stringmcrypt_get_cipher_name - stringcipher - - - mcrypt_get_cipher_name is used to get the - name of the specified cipher. - - - mcrypt_get_cipher_name takes the cipher - number as an argument (libmcrypt 2.2.x) or takes the cipher name - as an argument (libmcrypt 2.4.x or higher) and returns the name of the cipher - or &false;, if the cipher does not exist. - - - - &reftitle.parameters; - - - cipher - - &mcrypt.parameter.cipher; - - - - - - - &reftitle.returnvalues; - - This function returns the name of the cipher or &false; if the cipher does - not exist. - - - - - &reftitle.examples; - - <function>mcrypt_get_cipher_name</function> Example - - -]]> - - &example.outputs; - - - - - - - diff --git a/reference/mcrypt/functions/mcrypt-get-iv-size.xml b/reference/mcrypt/functions/mcrypt-get-iv-size.xml deleted file mode 100644 index e728ad62ad59..000000000000 --- a/reference/mcrypt/functions/mcrypt-get-iv-size.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - mcrypt_get_iv_size - Returns the size of the IV belonging to a specific cipher/mode combination - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - intmcrypt_get_iv_size - stringcipher - stringmode - - - Gets the size of the IV belonging to a specific - cipher/mode combination. - - - It is more useful to use the mcrypt_enc_get_iv_size - function as this uses the resource returned by - mcrypt_module_open. - - - - - &reftitle.parameters; - - - cipher - - &mcrypt.parameter.cipher; - - - - mode - - &mcrypt.parameter.mode; - - The IV is ignored in ECB mode as this mode does not require it. You will - need to have the same IV (think: starting point) both at encryption and - decryption stages, otherwise your encryption will fail. - - - - - - - - &reftitle.returnvalues; - - Returns the size of the Initialization Vector (IV) in bytes. On error the - function returns &false;. If the IV is ignored in the specified cipher/mode - combination zero is returned. - - - - - &reftitle.examples; - - <function>mcrypt_get_iv_size</function> Example - - -]]> - - - - - - &reftitle.seealso; - - mcrypt_get_block_size - mcrypt_enc_get_iv_size - mcrypt_create_iv - - - - - diff --git a/reference/mcrypt/functions/mcrypt-get-key-size.xml b/reference/mcrypt/functions/mcrypt-get-key-size.xml deleted file mode 100644 index d5c27164aacf..000000000000 --- a/reference/mcrypt/functions/mcrypt-get-key-size.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - mcrypt_get_key_size - Gets the key size of the specified cipher - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - intfalsemcrypt_get_key_size - intcipher - - - intfalsemcrypt_get_key_size - stringcipher - stringmode - - - The first prototype is when linked against libmcrypt 2.2.x, the - second when linked against libmcrypt 2.4.x or 2.5.x. - - - mcrypt_get_key_size is used to get the size - of a key of the specified cipher (in - combination with an encryption mode). - - - It is more useful to use the mcrypt_enc_get_key_size - function as this uses the resource returned by mcrypt_module_open. - - - - - &reftitle.parameters; - - - cipher - - &mcrypt.parameter.cipher; - - - - mode - - &mcrypt.parameter.mode; - - - - - - - &reftitle.returnvalues; - - Returns the maximum supported key size of the algorithm in bytes - &return.falseforfailure;. - - - - - &reftitle.examples; - - <function>mcrypt_get_key_size</function> Example - - -]]> - - - The example above shows how to use this function when - linked against libmcrypt 2.4.x or 2.5.x. - - &example.outputs; - - - - - - - &reftitle.seealso; - - mcrypt_get_block_size - mcrypt_enc_get_key_size - mcrypt_encrypt - - - - - diff --git a/reference/mcrypt/functions/mcrypt-list-algorithms.xml b/reference/mcrypt/functions/mcrypt-list-algorithms.xml deleted file mode 100644 index 4b1e797eddb9..000000000000 --- a/reference/mcrypt/functions/mcrypt-list-algorithms.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - mcrypt_list_algorithms - Gets an array of all supported ciphers - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - arraymcrypt_list_algorithms - stringlib_dirini_get("mcrypt.algorithms_dir") - - - Gets the list of all supported algorithms in the - lib_dir parameter. - - - - - &reftitle.parameters; - - - lib_dir - - - Specifies the directory where all algorithms are located. If not - specified, the value of the mcrypt.algorithms_dir - &php.ini; directive is used. - - - - - - - - &reftitle.returnvalues; - - Returns an array with all the supported algorithms. - - - - - &reftitle.examples; - - <function>mcrypt_list_algorithms</function> Example - - -]]> - - &example.outputs.similar; - - cast-128 - [1] => gost - [2] => rijndael-128 - [3] => twofish - [4] => arcfour - [5] => cast-256 - [6] => loki97 - [7] => rijndael-192 - [8] => saferplus - [9] => wake - [10] => blowfish-compat - [11] => des - [12] => rijndael-256 - [13] => serpent - [14] => xtea - [15] => blowfish - [16] => enigma - [17] => rc2 - [18] => tripledes -) -]]> - - - - - diff --git a/reference/mcrypt/functions/mcrypt-list-modes.xml b/reference/mcrypt/functions/mcrypt-list-modes.xml deleted file mode 100644 index 7267e9eb46fa..000000000000 --- a/reference/mcrypt/functions/mcrypt-list-modes.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - mcrypt_list_modes - Gets an array of all supported modes - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - arraymcrypt_list_modes - stringlib_dirini_get("mcrypt.modes_dir") - - - Gets the list of all supported modes in the - lib_dir parameter. - - - - - &reftitle.parameters; - - - lib_dir - - - Specifies the directory where all modes are located. If not - specified, the value of the mcrypt.modes_dir - &php.ini; directive is used. - - - - - - - - &reftitle.returnvalues; - - Returns an array with all the supported modes. - - - - - &reftitle.examples; - - <function>mcrypt_list_modes</function> Example - -\n"; - } -?> -]]> - - - The example above will produce a list with all supported - algorithms in the default mode directory. If it is not set - with the mcrypt.modes_dir &php.ini; - directive, the default directory of mcrypt is used (which - is /usr/local/lib/libmcrypt). - - - - - diff --git a/reference/mcrypt/functions/mcrypt-module-close.xml b/reference/mcrypt/functions/mcrypt-module-close.xml deleted file mode 100644 index b6cc358fb6ba..000000000000 --- a/reference/mcrypt/functions/mcrypt-module-close.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - mcrypt_module_close - Closes the mcrypt module - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - boolmcrypt_module_close - resourcetd - - - Closes the specified encryption handle. - - - - &reftitle.parameters; - - - td - - - The encryption descriptor. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - mcrypt_module_open - - - - diff --git a/reference/mcrypt/functions/mcrypt-module-get-algo-block-size.xml b/reference/mcrypt/functions/mcrypt-module-get-algo-block-size.xml deleted file mode 100644 index 434c8139240f..000000000000 --- a/reference/mcrypt/functions/mcrypt-module-get-algo-block-size.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - mcrypt_module_get_algo_block_size - Returns the blocksize of the specified algorithm - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - intmcrypt_module_get_algo_block_size - stringalgorithm - stringlib_dir - - - Gets the blocksize of the specified algorithm. - - - - &reftitle.parameters; - - - algorithm - - - The algorithm name. - - - - - lib_dir - - - This optional parameter can contain the location where the mode module - is on the system. - - - - - - - &reftitle.returnvalues; - - Returns the block size of the algorithm specified in bytes. - - - - diff --git a/reference/mcrypt/functions/mcrypt-module-get-algo-key-size.xml b/reference/mcrypt/functions/mcrypt-module-get-algo-key-size.xml deleted file mode 100644 index 0a953cb0b925..000000000000 --- a/reference/mcrypt/functions/mcrypt-module-get-algo-key-size.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - mcrypt_module_get_algo_key_size - Returns the maximum supported keysize of the opened mode - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - intmcrypt_module_get_algo_key_size - stringalgorithm - stringlib_dir - - - Gets the maximum supported keysize of the opened mode. - - - - &reftitle.parameters; - - - algorithm - - - The algorithm name. - - - - - lib_dir - - - This optional parameter can contain the location where the mode module - is on the system. - - - - - - - &reftitle.returnvalues; - - This function returns the maximum supported key size of the - algorithm specified in bytes. - - - - diff --git a/reference/mcrypt/functions/mcrypt-module-get-supported-key-sizes.xml b/reference/mcrypt/functions/mcrypt-module-get-supported-key-sizes.xml deleted file mode 100644 index 17f614a68c21..000000000000 --- a/reference/mcrypt/functions/mcrypt-module-get-supported-key-sizes.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - mcrypt_module_get_supported_key_sizes - Returns an array with the supported keysizes of the opened algorithm - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - arraymcrypt_module_get_supported_key_sizes - stringalgorithm - stringlib_dir - - - Returns an array with the key sizes supported by the specified algorithm. - If it returns an empty array then all key sizes between 1 and - mcrypt_module_get_algo_key_size are supported by the - algorithm. - - - - &reftitle.parameters; - - - algorithm - - - The algorithm to be used. - - - - - lib_dir - - - The optional lib_dir parameter can contain the - location where the algorithm module is on the system. - - - - - - - - &reftitle.returnvalues; - - Returns an array with the key sizes supported by the specified algorithm. - If it returns an empty array then all key sizes between 1 and - mcrypt_module_get_algo_key_size are supported by the - algorithm. - - - - - &reftitle.seealso; - - mcrypt_enc_get_supported_key_sizes - - - - diff --git a/reference/mcrypt/functions/mcrypt-module-is-block-algorithm-mode.xml b/reference/mcrypt/functions/mcrypt-module-is-block-algorithm-mode.xml deleted file mode 100644 index 9c4d16fd89db..000000000000 --- a/reference/mcrypt/functions/mcrypt-module-is-block-algorithm-mode.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - mcrypt_module_is_block_algorithm_mode - Returns if the specified module is a block algorithm or not - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - boolmcrypt_module_is_block_algorithm_mode - stringmode - stringlib_dir - - - This function returns &true; if the mode is for use with block - algorithms, otherwise it returns &false;. (e.g. &false; for stream, and - &true; for cbc, cfb, ofb). - - - - &reftitle.parameters; - - - mode - - - The mode to check. - - - - - lib_dir - - - The optional lib_dir parameter can contain the - location where the algorithm module is on the system. - - - - - - - - &reftitle.returnvalues; - - This function returns &true; if the mode is for use with block - algorithms, otherwise it returns &false;. (e.g. &false; for stream, and - &true; for cbc, cfb, ofb). - - - - diff --git a/reference/mcrypt/functions/mcrypt-module-is-block-algorithm.xml b/reference/mcrypt/functions/mcrypt-module-is-block-algorithm.xml deleted file mode 100644 index e19866c7e9e2..000000000000 --- a/reference/mcrypt/functions/mcrypt-module-is-block-algorithm.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - mcrypt_module_is_block_algorithm - This function checks whether the specified algorithm is a block algorithm - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - boolmcrypt_module_is_block_algorithm - stringalgorithm - stringlib_dir - - - This function returns &true; if the specified algorithm is a block - algorithm, or &false; if it is a stream one. - - - - - &reftitle.parameters; - - - algorithm - - - The algorithm to check. - - - - - lib_dir - - - The optional lib_dir parameter can contain the - location where the algorithm module is on the system. - - - - - - - - &reftitle.returnvalues; - - This function returns &true; if the specified algorithm is a block - algorithm, or &false; if it is a stream one. - - - - diff --git a/reference/mcrypt/functions/mcrypt-module-is-block-mode.xml b/reference/mcrypt/functions/mcrypt-module-is-block-mode.xml deleted file mode 100644 index 7c24a7fab02c..000000000000 --- a/reference/mcrypt/functions/mcrypt-module-is-block-mode.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - mcrypt_module_is_block_mode - Returns if the specified mode outputs blocks or not - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - boolmcrypt_module_is_block_mode - stringmode - stringlib_dir - - - This function returns &true; if the mode outputs blocks of bytes or - &false; if it outputs just bytes. (e.g. &true; for cbc and ecb, and - &false; for cfb and stream). - - - - - &reftitle.parameters; - - - mode - - &mcrypt.parameter.mode; - - - - lib_dir - - - The optional lib_dir parameter can contain the - location where the algorithm module is on the system. - - - - - - - - &reftitle.returnvalues; - - This function returns &true; if the mode outputs blocks of bytes or - &false; if it outputs just bytes. (e.g. &true; for cbc and ecb, and - &false; for cfb and stream). - - - - diff --git a/reference/mcrypt/functions/mcrypt-module-open.xml b/reference/mcrypt/functions/mcrypt-module-open.xml deleted file mode 100644 index df6223025063..000000000000 --- a/reference/mcrypt/functions/mcrypt-module-open.xml +++ /dev/null @@ -1,175 +0,0 @@ - - - - - mcrypt_module_open - Opens the module of the algorithm and the mode to be used - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - resourcemcrypt_module_open - stringalgorithm - stringalgorithm_directory - stringmode - stringmode_directory - - - This function opens the module of the algorithm and the mode to be used. - The name of the algorithm is specified in algorithm, e.g. "twofish" or is - one of the MCRYPT_ciphername constants. The module is closed by calling - mcrypt_module_close. - - - - - &reftitle.parameters; - - - algorithm - - &mcrypt.parameter.cipher; - - - - algorithm_directory - - - The algorithm_directory parameter is used to locate - the encryption module. When you supply a directory name, it is used. When - you set it to an empty string (""), the value set by the - mcrypt.algorithms_dir &php.ini; directive is used. When - it is not set, the default directory that is used is the one that was compiled - into libmcrypt (usually /usr/local/lib/libmcrypt). - - - - - mode - - &mcrypt.parameter.mode; - - - - mode_directory - - - The mode_directory parameter is used to locate - the encryption module. When you supply a directory name, it is used. When - you set it to an empty string (""), the value set by the - mcrypt.modes_dir &php.ini; directive is used. When - it is not set, the default directory that is used is the one that was compiled-in - into libmcrypt (usually /usr/local/lib/libmcrypt). - - - - - - - - &reftitle.returnvalues; - - Normally it returns an encryption descriptor, or &false; on error. - - - - - &reftitle.examples; - - <function>mcrypt_module_open</function> Examples - - -]]> - - - - The first line in the example above will try to open the DES cipher from - the default directory and the ECB mode from the directory - /usr/lib/mcrypt-modes. The second example uses - strings as name for the cipher and mode, this only works when the - extension is linked against libmcrypt 2.4.x or 2.5.x. - - - - Using <function>mcrypt_module_open</function> in encryption - - -]]> - - - - - - &reftitle.seealso; - - mcrypt_module_close - mcrypt_generic - mdecrypt_generic - mcrypt_generic_init - mcrypt_generic_deinit - - - - diff --git a/reference/mcrypt/functions/mcrypt-module-self-test.xml b/reference/mcrypt/functions/mcrypt-module-self-test.xml deleted file mode 100644 index 6f3d575c79f5..000000000000 --- a/reference/mcrypt/functions/mcrypt-module-self-test.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - mcrypt_module_self_test - This function runs a self test on the specified module - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - boolmcrypt_module_self_test - stringalgorithm - stringlib_dir - - - This function runs the self test on the algorithm specified. - - - - - &reftitle.parameters; - - - algorithm - - &mcrypt.parameter.cipher; - - - - lib_dir - - - The optional lib_dir parameter can contain the - location where the algorithm module is on the system. - - - - - - - - &reftitle.returnvalues; - - The function returns &true; if the self test succeeds, or &false; when it - fails. - - - - - &reftitle.examples; - - <function>mcrypt_module_self_test</function> example - - -]]> - - &example.outputs; - - - - - - - diff --git a/reference/mcrypt/functions/mdecrypt-generic.xml b/reference/mcrypt/functions/mdecrypt-generic.xml deleted file mode 100644 index c4fc9f3e68cd..000000000000 --- a/reference/mcrypt/functions/mdecrypt-generic.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - mdecrypt_generic - Decrypts data - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - stringmdecrypt_generic - resourcetd - stringdata - - - This function decrypts data. Note that the length of the returned string - can in fact be longer than the unencrypted string, due to the padding of - the data. - - - - - &reftitle.parameters; - - - td - - - An encryption descriptor returned by - mcrypt_module_open - - - - - data - - - Encrypted data. - - - - - - - - &reftitle.returnvalues; - - Returns decrypted string. - - - - - &reftitle.examples; - - <function>mdecrypt_generic</function> Example - - -]]> - - - - The example above shows how to check if the data before the encryption is - the same as the data after the decryption. It is very important to - reinitialize the encryption buffer with - mcrypt_generic_init before you try to decrypt the - data. - - - The decryption handle should always be initialized with - mcrypt_generic_init with a key and an IV before - calling this function. Where the encryption is done, you should free the - encryption buffers by calling mcrypt_generic_deinit. - See mcrypt_module_open for an example. - - - - - &reftitle.seealso; - - mcrypt_generic - mcrypt_generic_init - mcrypt_generic_deinit - - - - diff --git a/reference/mcrypt/ini.xml b/reference/mcrypt/ini.xml deleted file mode 100644 index 6bdc65bece87..000000000000 --- a/reference/mcrypt/ini.xml +++ /dev/null @@ -1,89 +0,0 @@ - - -
    - &reftitle.runtime; - &extension.runtime; - - - Mcrypt configuration options - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - mcrypt.algorithms_dir - &null; - INI_ALL - - - - mcrypt.modes_dir - &null; - INI_ALL - - - - -
    - &ini.php.constants; -
    - - &ini.descriptions.title; - - - - mcrypt.algorithms_dir - string - - - - The directory that contains the algorithms. Defaults to the directories - compiled within libmcrypt, which is typically - /usr/local/lib/libmcrypt. See - mcrypt_list_algorithms for additional details. - - - - - - mcrypt.modes_dir - string - - - - The directory that contains the modes. Defaults to the directories - compiled within libmcrypt, which is typically - /usr/local/lib/libmcrypt. See - mcrypt_list_modes for additional details. - - - - - -
    - diff --git a/reference/mcrypt/reference.xml b/reference/mcrypt/reference.xml deleted file mode 100644 index 86f9568504e8..000000000000 --- a/reference/mcrypt/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - Mcrypt &Functions; - - &reference.mcrypt.entities.functions; - - - - diff --git a/reference/mcrypt/setup.xml b/reference/mcrypt/setup.xml deleted file mode 100644 index 43b8607cfd19..000000000000 --- a/reference/mcrypt/setup.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - &reftitle.setup; - - -
    - &reftitle.required; - - These functions work using mcrypt. - To use it, download libmcrypt-x.x.tar.gz from &url.mcrypt; and follow the included - installation instructions. - - - libmcrypt Version 2.5.6 or greater is required. - - - Windows users will find the library is the PHP 5.2 Windows binaries release. - PHP 5.3 Windows binaries uses the static version of the MCrypt library, no - DLL are needed. - - - If you linked against libmcrypt 2.4.x or higher, the following additional - block algorithms are supported: CAST, LOKI97, RIJNDAEL, SAFERPLUS, - SERPENT and the following stream ciphers: ENIGMA (crypt), PANAMA, RC4 and - WAKE. With libmcrypt 2.4.x or higher another cipher mode is also - available; nOFB. - -
    - - - - &reference.mcrypt.configure; - - - - &reference.mcrypt.ini; - - - -
    - &reftitle.resources; - - mcrypt_module_open returns an encryption descriptor. - -
    - - -
    - diff --git a/reference/mcrypt/versions.xml b/reference/mcrypt/versions.xml deleted file mode 100644 index eb87a808cf3c..000000000000 --- a/reference/mcrypt/versions.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/memcache/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/memcache/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/memcache/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/memcache/book.xml b/reference/memcache/book.xml deleted file mode 100644 index ec195c02fa23..000000000000 --- a/reference/memcache/book.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - Memcache - - - - &reftitle.intro; - - Memcache module provides handy procedural and object-oriented interface - to memcached, highly effective caching daemon, which was especially - designed to decrease database load in dynamic web applications. - - - The Memcache module also provides a session handler (memcache). - - - More information about memcached can be found at &url.memcache;. - - - - - &reference.memcache.setup; - &reference.memcache.constants; - &reference.memcache.examples; - &reference.memcache.memcache; - &reference.memcache.reference; - - - diff --git a/reference/memcache/configure.xml b/reference/memcache/configure.xml deleted file mode 100644 index 01e07b98bfe1..000000000000 --- a/reference/memcache/configure.xml +++ /dev/null @@ -1,39 +0,0 @@ - - -
    - &reftitle.install; - - &pecl.moved; - &pecl.info; - &url.pecl.package;memcache. - - - - It's possible to disable memcache session handler support. The 'pecl install' option - prompts for this (default is enabled) however when compiling statically into PHP the - configure option may be - used. - - - -
    - diff --git a/reference/memcache/constants.xml b/reference/memcache/constants.xml deleted file mode 100644 index 67a24e962bbf..000000000000 --- a/reference/memcache/constants.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - &reftitle.constants; - - Memcache Constants - - - - Name - Description - - - - - - MEMCACHE_COMPRESSED - (int) - - - Used to turn on-the-fly data compression on with - Memcache::set, - Memcache::add&listendand; - Memcache::replace. - - - - - MEMCACHE_HAVE_SESSION - (int) - - - 1 if this Memcache session handler is available, 0 otherwise. - - - - - MEMCACHE_USER1 - (int) - - - Used to turn user-defined application flag on with - Memcache::set, - Memcache::add&listendand; - Memcache::replace. - - - - - MEMCACHE_USER2 - (int) - - - Used to turn user-defined application flag on with - Memcache::set, - Memcache::add&listendand; - Memcache::replace. - - - - - MEMCACHE_USER3 - (int) - - - Used to turn user-defined application flag on with - Memcache::set, - Memcache::add&listendand; - Memcache::replace. - - - - - MEMCACHE_USER4 - (int) - - - Used to turn user-defined application flag on with - Memcache::set, - Memcache::add&listendand; - Memcache::replace. - - - - -
    -
    - - diff --git a/reference/memcache/examples.xml b/reference/memcache/examples.xml deleted file mode 100644 index cc49a39c64e5..000000000000 --- a/reference/memcache/examples.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - &reftitle.examples; -
    - Basic usage - - memcache extension overview example - - In this example, an object is being saved in the cache and then - retrieved back. Object and other non-scalar types are serialized - before saving, so it's impossible to store resources (i.e. connection - identifiers and others) in the cache. - - -connect('localhost', 11211) or die ("Could not connect"); - -$version = $memcache->getVersion(); -echo "Server's version: ".$version."
    \n"; - -$tmp_object = new stdClass; -$tmp_object->str_attr = 'test'; -$tmp_object->int_attr = 123; - -$memcache->set('key', $tmp_object, false, 10) or die ("Failed to save data at the server"); -echo "Store data in the cache (data will expire in 10 seconds)
    \n"; - -$get_result = $memcache->get('key'); -echo "Data from the cache:
    \n"; - -var_dump($get_result); - -?> -]]> -
    -
    - - Using memcache session handler - - -]]> - - -
    -
    - diff --git a/reference/memcache/functions/memcache-debug.xml b/reference/memcache/functions/memcache-debug.xml deleted file mode 100644 index ee4c10dbf367..000000000000 --- a/reference/memcache/functions/memcache-debug.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - memcache_debug - Turn debug output on/off - - - - &reftitle.description; - - boolmemcache_debug - boolon_off - - - - memcache_debug turns on debug output if parameter - on_off is equal to &true; and turns off if it's - &false;. - - - memcache_debug is accessible only if PHP was built - with --enable-debug option and always returns &true; in this case. - Otherwise, this function has no effect and always returns &false;. - - - - - - - - &reftitle.parameters; - - - on_off - - - Turns debug output on if equals to &true;. - Turns debug output off if equals to &false;. - - - - - - - - &reftitle.returnvalues; - - Returns &true; if PHP was built with --enable-debug option, otherwise - returns &false;. - - - - - diff --git a/reference/memcache/ini.xml b/reference/memcache/ini.xml deleted file mode 100644 index 3a6bf69c9330..000000000000 --- a/reference/memcache/ini.xml +++ /dev/null @@ -1,316 +0,0 @@ - - -
    - &reftitle.runtime; - &extension.runtime; - - - Memcache Configuration Options - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - memcache.allow_failover - "1" - INI_ALL - Available since memcache 2.0.2. - - - memcache.max_failover_attempts - "20" - INI_ALL - Available since memcache 2.1.0. - - - memcache.chunk_size - "8192" - INI_ALL - Available since memcache 2.0.2. - - - memcache.default_port - "11211" - INI_ALL - Available since memcache 2.0.2. - - - memcache.hash_strategy - "standard" - INI_ALL - Available since memcache 2.2.0. - - - memcache.hash_function - "crc32" - INI_ALL - Available since memcache 2.2.0. - - - memcache.protocol - ascii - INI_ALL - Supported since memcache 3.0.0 - - - memcache.redundancy - 1 - INI_ALL - Supported since memcache 3.0.0 - - - memcache.session_redundancy - 2 - INI_ALL - Supported since memcache 3.0.0 - - - memcache.compress_threshold - 20000 - INI_ALL - Supported since memcache 3.0.3 - - - memcache.lock_timeout - 15 - INI_ALL - Supported since memcache 3.0.4 - - - -
    - - Session Configuration Options Affecting Memcache Behavior - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - session.save_handler - "files" - INI_ALL - Supported since memcache 2.1.2 - - - session.save_path - "" - INI_ALL - Supported since memcache 2.1.2 - - - -
    - &ini.php.constants; -
    - -&ini.descriptions.title; - - - - - - memcache.allow_failover - bool - - - - Whether to transparently failover to other servers on - errors. - - - - - - - memcache.max_failover_attempts - int - - - - Defines how many servers to try when setting and getting data. - Used only in conjunction with memcache.allow_failover. - - - - - - - memcache.chunk_size - int - - - - Data will be transferred in chunks of this size, setting - the value lower requires more network writes. Try - increasing this value to 32768 if noticing otherwise - inexplicable slowdowns. - - - - - - - memcache.default_port - string - - - - The default TCP port number to use when connecting to - the memcached server if no other port is specified. - - - - - - - memcache.hash_strategy - string - - - - Controls which strategy to use when mapping keys to servers. Set this value to - consistent to enable consistent hashing which allows servers - to be added or removed from the pool without causing keys to be remapped. - Setting this value to standard results in the old strategy - being used. - - - - - - - memcache.hash_function - string - - - - Controls which hash function to apply when mapping keys to servers, crc32 - uses the standard CRC32 hash while fnv uses FNV-1a. - - - - - - - memcache.protocol - string - - - - - - - - - - - memcache.redundancy - int - - - - - - - - - - - memcache.session_redundancy - int - - - - - - - - - - - memcache.compress_threshold - int - - - - - - - - - - - memcache.lock_timeout - int - - - - - - - - - - - session.save_handler - string - - - - Use memcache as a session handler by setting this value to memcache. - - - - - - - session.save_path - string - - - - Defines a comma separated of server urls to use for session storage, for example - "tcp://host1:11211, tcp://host2:11211". - - - Each url may contain parameters which are applied to that server, they are the same - as for the Memcache::addServer method. For example - "tcp://host1:11211?persistent=1&weight=1&timeout=1&retry_interval=15" - - - - - -
    - diff --git a/reference/memcache/memcache.xml b/reference/memcache/memcache.xml deleted file mode 100644 index 33ae22e739f2..000000000000 --- a/reference/memcache/memcache.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - The Memcache class - Memcache - - - - -
    - &reftitle.intro; - - Represents a connection to a set of memcache servers. - -
    - - -
    - &reftitle.classsynopsis; - - - - Memcache - - - - - Memcache - - - - - - - - -
    - -
    - - &reference.memcache.entities.memcache; - -
    - diff --git a/reference/memcache/memcache/add.xml b/reference/memcache/memcache/add.xml deleted file mode 100644 index f5a3dec95280..000000000000 --- a/reference/memcache/memcache/add.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - Memcache::add - memcache_add - Add an item to the server - - - - &reftitle.description; - - boolMemcache::add - stringkey - mixedvar - intflag - intexpire - - - boolmemcache_add - Memcachememcache - stringkey - mixedvar - intflag - intexpire - - - - Memcache::add stores variable - var with key only if such - key doesn't exist at the server yet. - - - - - - &reftitle.parameters; - - - key - - - The key that will be associated with the item. - - - - - var - - - The variable to store. Strings and integers are stored as is, other - types are stored serialized. - - - - - flag - - - Use MEMCACHE_COMPRESSED to store the item - compressed (uses zlib). - - - - - expire - - - Expiration time of the item. If it's equal to zero, the item will never - expire. You can also use Unix timestamp or a number of seconds starting - from current time, but in the latter case the number of seconds may not - exceed 2592000 (30 days). - - - - - - - - &reftitle.returnvalues; - - &return.success; - Returns &false; if such key already exist. For the rest - Memcache::add behaves similarly to - Memcache::set. - - - - - &reftitle.examples; - - <function>Memcache::add</function> example - -add('var_key', 'test variable', false, 30); - -?> -]]> - - - - - - &reftitle.seealso; - - Memcache::set - Memcache::replace - - - - - diff --git a/reference/memcache/memcache/addserver.xml b/reference/memcache/memcache/addserver.xml deleted file mode 100644 index 61ba70babba1..000000000000 --- a/reference/memcache/memcache/addserver.xml +++ /dev/null @@ -1,253 +0,0 @@ - - - - - Memcache::addServer - memcache_add_server - Add a memcached server to connection pool - - - - &reftitle.description; - - boolMemcache::addServer - stringhost - intport11211 - boolpersistent - intweight - inttimeout - intretry_interval - boolstatus - callablefailure_callback - inttimeoutms - - - boolmemcache_add_server - Memcachememcache - stringhost - intport11211 - boolpersistent - intweight - inttimeout - intretry_interval - boolstatus - callablefailure_callback - inttimeoutms - - - - Memcache::addServer adds a server to the connection pool. - - - - When using this method (as opposed to Memcache::connect and - Memcache::pconnect) the network connection is not established - until actually needed. Thus there is no overhead in adding a large number of servers - to the pool, even though they might not all be used. - - - - Failover may occur at any stage in any of the methods, as long as other - servers are available the request the user won't notice. Any kind of - socket or Memcached server level errors (except out-of-memory) may trigger - the failover. Normal client errors such as adding an existing key will not - trigger a failover. - - - - - This function has been added to Memcache version 2.0.0. - - - - - - - &reftitle.parameters; - - - host - - - Point to the host where memcached is listening for connections. This parameter - may also specify other transports like unix:///path/to/memcached.sock - to use UNIX domain sockets, in this case port must also - be set to 0. - - - - - port - - - Point to the port where memcached is listening for connections. - Set this - parameter to 0 when using UNIX domain sockets. - - - Please note: port defaults to - memcache.default_port - if not specified. For this reason it is wise to specify the port - explicitly in this method call. - - - - - persistent - - - Controls the use of a persistent connection. Default to &true;. - - - - - weight - - - Number of buckets to create for this server which in turn control its - probability of it being selected. The probability is relative to the - total weight of all servers. - - - - - timeout - - - Value in seconds which will be used for connecting to the daemon. Think - twice before changing the default value of 1 second - you can lose all - the advantages of caching if your connection is too slow. - - - - - retry_interval - - - Controls how often a failed server will be retried, the default value - is 15 seconds. Setting this parameter to -1 disables automatic retry. - Neither this nor the persistent parameter has any - effect when the extension is loaded dynamically via dl. - - - Each failed connection struct has its own timeout and before it has expired - the struct will be skipped when selecting backends to serve a request. Once - expired the connection will be successfully reconnected or marked as failed - for another retry_interval seconds. The typical - effect is that each web server child will retry the connection about every - retry_interval seconds when serving a page. - - - - - status - - - Controls if the server should be flagged as online. Setting this parameter - to &false; and retry_interval to -1 allows a failed - server to be kept in the pool so as not to affect the key distribution - algorithm. Requests for this server will then failover or fail immediately - depending on the memcache.allow_failover setting. - Default to &true;, meaning the server should be considered online. - - - - - failure_callback - - - Allows the user to specify a callback function to run upon encountering an - error. The callback is run before failover is attempted. The function takes - two parameters, the hostname and port of the failed server. - - - - - timeoutms - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>Memcache::addServer</function> example - -addServer('memcache_host', 11211); -$memcache->addServer('memcache_host2', 11211); - -/* procedural API */ - -$memcache_obj = memcache_connect('memcache_host', 11211); -memcache_add_server($memcache_obj, 'memcache_host2', 11211); - -?> -]]> - - - - - - &reftitle.notes; - - - When the port is unspecified, this method defaults to the - value set of the PHP ini directive - memcache.default_port - If this value was changed elsewhere in your application it might lead to - unexpected results: for this reason it is wise to always specify the port - explicitly in this method call. - - - - - - &reftitle.seealso; - - Memcache::connect - Memcache::pconnect - Memcache::close - Memcache::setServerParams - Memcache::getServerStatus - - - - - diff --git a/reference/memcache/memcache/close.xml b/reference/memcache/memcache/close.xml deleted file mode 100644 index 2f54184ff767..000000000000 --- a/reference/memcache/memcache/close.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - Memcache::close - memcache_close - Close memcached server connection - - - - &reftitle.description; - - boolMemcache::close - - - - boolmemcache_close - Memcachememcache - - - - Memcache::close closes connection to memcached - server. This function doesn't close persistent connections, which are - closed only during web-server shutdown/restart. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>Memcache::close</function> example - -connect('memcache_host', 11211); -/* -do something here... -*/ -$memcache_obj->close(); - -?> -]]> - - - - - - &reftitle.seealso; - - Memcache::connect - Memcache::pconnect - - - - - diff --git a/reference/memcache/memcache/connect.xml b/reference/memcache/memcache/connect.xml deleted file mode 100644 index ef293eeeef63..000000000000 --- a/reference/memcache/memcache/connect.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - Memcache::connect - memcache_connect - Open memcached server connection - - - - &reftitle.description; - - boolMemcache::connect - stringhost - intport - inttimeout - - - Memcachememcache_connect - stringhost - intport - inttimeout - - - - Memcache::connect establishes a connection to the - memcached server. - The connection, which was opened using - Memcache::connect will be automatically closed at the - end of script execution. Also you can close it with - Memcache::close. - - - - - - &reftitle.parameters; - - - host - - - Point to the host where memcached is listening for connections. This parameter - may also specify other transports like unix:///path/to/memcached.sock - to use UNIX domain sockets, in this case port must also - be set to 0. - - - - - port - - - Point to the port where memcached is listening for connections. Set this - parameter to 0 when using UNIX domain sockets. - - - Please note: port defaults to - memcache.default_port - if not specified. For this reason it is wise to specify the port - explicitly in this method call. - - - - - timeout - - - Value in seconds which will be used for connecting to the daemon. Think - twice before changing the default value of 1 second - you can lose all - the advantages of caching if your connection is too slow. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>Memcache::connect</function> example - -connect('memcache_host', 11211); - -?> -]]> - - - - - - &reftitle.notes; - - - When the port is unspecified, this method defaults to the - value set of the PHP ini directive - memcache.default_port - If this value was changed elsewhere in your application it might lead to - unexpected results: for this reason it is wise to always specify the port - explicitly in this method call. - - - - - - &reftitle.seealso; - - Memcache::pconnect - Memcache::close - - - - - diff --git a/reference/memcache/memcache/decrement.xml b/reference/memcache/memcache/decrement.xml deleted file mode 100644 index 580024582440..000000000000 --- a/reference/memcache/memcache/decrement.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - Memcache::decrement - memcache_decrement - Decrement item's value - - - - &reftitle.description; - - intfalseMemcache::decrement - stringkey - intvalue1 - - - intfalsememcache_decrement - Memcachememcache - stringkey - intvalue1 - - - - Memcache::decrement decrements value of the - item by value. Similarly to - Memcache::increment, current value of the item is - being converted to numerical and after that value - is subtracted. - - - New item's value will not be less than zero. - - - - - Do not use Memcache::decrement with item, which was - stored compressed, because consequent call to - Memcache::get will fail. - - - Memcache::decrement does not - create an item if it didn't exist. - - - - - - &reftitle.parameters; - - - key - - - Key of the item do decrement. - - - - - value - - - Decrement the item by value. - - - - - - - - &reftitle.returnvalues; - - Returns item's new value on success&return.falseforfailure;. - - - - - &reftitle.examples; - - <function>Memcache::decrement</function> example - -connect('memcache_host', 11211); -/* decrement item by 3 */ -$new_value = $memcache_obj->decrement('test_item', 3); -?> -]]> - - - - - - &reftitle.seealso; - - Memcache::increment - Memcache::replace - - - - - diff --git a/reference/memcache/memcache/delete.xml b/reference/memcache/memcache/delete.xml deleted file mode 100644 index 86735bc33c27..000000000000 --- a/reference/memcache/memcache/delete.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - Memcache::delete - memcache_delete - Delete item from the server - - - - &reftitle.description; - - boolMemcache::delete - stringkey - intexptime0 - - - boolmemcache_delete - Memcachememcache - stringkey - intexptime0 - - - - Memcache::delete deletes an item with the key. - - - - - - &reftitle.parameters; - - - key - - - The key associated with the item to delete. - - - - - exptime - - - This deprecated parameter is not supported, and defaults to 0 seconds. - Do not use this parameter. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL memcache 3.0.5 - - The exptime is deprecated, and should not be supplied. - Values other than 0 may cause unexpected errors. - - - - - - - - - &reftitle.examples; - - <function>Memcache::delete</function> example - -connect('memcache_host', 11211); - -$memcache_obj->delete('key_to_delete'); - -?> -]]> - - - - - - &reftitle.seealso; - - Memcache::set - Memcache::replace - - - - - diff --git a/reference/memcache/memcache/flush.xml b/reference/memcache/memcache/flush.xml deleted file mode 100644 index e971b01b9018..000000000000 --- a/reference/memcache/memcache/flush.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - Memcache::flush - memcache_flush - Flush all existing items at the server - - - - &reftitle.description; - - boolMemcache::flush - - - - boolmemcache_flush - Memcachememcache - - - - Memcache::flush immediately invalidates all - existing items. Memcache::flush doesn't - actually free any resources, it only marks all the items as expired, so - occupied memory will be overwritten by new items. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>Memcache::flush</function> example - -connect('memcache_host', 11211); - -$memcache_obj->flush(); - -?> -]]> - - - - - - diff --git a/reference/memcache/memcache/get.xml b/reference/memcache/memcache/get.xml deleted file mode 100644 index 3a99ff1ceac7..000000000000 --- a/reference/memcache/memcache/get.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - Memcache::get - memcache_get - Retrieve item from the server - - - - &reftitle.description; - - stringMemcache::get - stringkey - intflags - - - arrayMemcache::get - arraykeys - arrayflags - - - stringmemcache_get - Memcachememcache - stringkey - intflags - - - arraymemcache_get - Memcachememcache - arraykeys - arrayflags - - - - Memcache::get returns previously stored data of - an item, if such key exists on the server at this - moment. - - - - You can pass array of keys to Memcache::get to get - array of values. The result array will contain only found key-value pairs. - - - - - - &reftitle.parameters; - - - key - - - The key or array of keys to fetch. - - - - - flags - - - If present, flags fetched along with the values will be written to this parameter. These - flags are the same as the ones given to for example Memcache::set. - The lowest byte of the int is reserved for pecl/memcache internal usage (e.g. to indicate - compression and serialization status). - - - - - - - - &reftitle.returnvalues; - - Returns the value associated with the key or - an array of found key-value pairs when key is an array. - Returns &false; on failure, key is not found or - key is an empty array. - - - - - &reftitle.examples; - - <function>Memcache::get</function> example - -connect('memcache_host', 11211); -$var = $memcache_obj->get('some_key'); - -/* -You also can use array of keys as a parameter. -If such item wasn't found at the server, the result -array simply will not include such key. -*/ - -/* procedural API */ -$memcache_obj = memcache_connect('memcache_host', 11211); -$var = memcache_get($memcache_obj, Array('some_key', 'another_key')); - -/* OO API */ -$memcache_obj = new Memcache; -$memcache_obj->connect('memcache_host', 11211); -$var = $memcache_obj->get(Array('some_key', 'second_key')); - -?> -]]> - - - - - - diff --git a/reference/memcache/memcache/getextendedstats.xml b/reference/memcache/memcache/getextendedstats.xml deleted file mode 100644 index b32b1b0f0ac6..000000000000 --- a/reference/memcache/memcache/getextendedstats.xml +++ /dev/null @@ -1,174 +0,0 @@ - - - - - Memcache::getExtendedStats - memcache_get_extended_stats - Get statistics from all servers in pool - - - - &reftitle.description; - - arrayMemcache::getExtendedStats - stringtype - intslabid - intlimit100 - - - arraymemcache_get_extended_stats - Memcachememcache - stringtype - intslabid - intlimit100 - - - - Memcache::getExtendedStats returns a two-dimensional - associative array with server statistics. Array keys correspond to - host:port of server and values contain the individual server statistics. - A failed server will have its corresponding entry set to &false;. - - - - - This function has been added to Memcache version 2.0.0. - - - - - - - &reftitle.parameters; - - - - type - - - The type of statistics to fetch. Valid values are {reset, - malloc, maps, cachedump, slabs, items, sizes}. According to - the memcached protocol spec these additional arguments "are - subject to change for the convenience of memcache developers". - - - - - slabid - - - Used in conjunction with type set to - cachedump to identify the slab to dump from. The cachedump - command ties up the server and is strictly to be used for - debugging purposes. - - - - - limit - - - Used in conjunction with type set to - cachedump to limit the number of entries to dump. - - - - - - - The cachedump stat type has been removed from the memcached daemon - due to security reasons. - - - - - - - - &reftitle.returnvalues; - - Returns a two-dimensional associative array of server statistics or &false; - on failure. - - - - - &reftitle.examples; - - <function>Memcache::getExtendedStats</function> example - -addServer('memcache_host', 11211); - $memcache_obj->addServer('failed_host', 11211); - - $stats = $memcache_obj->getExtendedStats(); - print_r($stats); -?> -]]> - - &example.outputs; - - Array - ( - [pid] => 3756 - [uptime] => 603011 - [time] => 1133810435 - [version] => 1.1.12 - [rusage_user] => 0.451931 - [rusage_system] => 0.634903 - [curr_items] => 2483 - [total_items] => 3079 - [bytes] => 2718136 - [curr_connections] => 2 - [total_connections] => 807 - [connection_structures] => 13 - [cmd_get] => 9748 - [cmd_set] => 3096 - [get_hits] => 5976 - [get_misses] => 3772 - [bytes_read] => 3448968 - [bytes_written] => 2318883 - [limit_maxbytes] => 33554432 - ) - - [failed_host:11211] => false -) -]]> - - - - - - &reftitle.seealso; - - Memcache::getVersion - Memcache::getStats - - - - - diff --git a/reference/memcache/memcache/getserverstatus.xml b/reference/memcache/memcache/getserverstatus.xml deleted file mode 100644 index 84c35385add5..000000000000 --- a/reference/memcache/memcache/getserverstatus.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - Memcache::getServerStatus - memcache_get_server_status - Returns server status - - - - &reftitle.description; - - intMemcache::getServerStatus - stringhost - intport11211 - - - intmemcache_get_server_status - Memcachememcache - stringhost - intport11211 - - - - Memcache::getServerStatus returns a the servers - online/offline status. - - - - - This function has been added to Memcache version 2.1.0. - - - - - - - &reftitle.parameters; - - - host - - - Point to the host where memcached is listening for connections. - - - - - port - - - Point to the port where memcached is listening for connections. - - - - - - - - &reftitle.returnvalues; - - Returns a the servers status. 0 if server is failed, non-zero otherwise - - - - - &reftitle.examples; - - <function>Memcache::getServerStatus</function> example - -addServer('memcache_host', 11211); -echo $memcache->getServerStatus('memcache_host', 11211); - -/* procedural API */ -$memcache = memcache_connect('memcache_host', 11211); -echo memcache_get_server_status($memcache, 'memcache_host', 11211); - -?> -]]> - - - - - - &reftitle.seealso; - - Memcache::addServer - Memcache::setServerParams - - - - - diff --git a/reference/memcache/memcache/getstats.xml b/reference/memcache/memcache/getstats.xml deleted file mode 100644 index e05e1381edd3..000000000000 --- a/reference/memcache/memcache/getstats.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - Memcache::getStats - memcache_get_stats - Get statistics of the server - - - - &reftitle.description; - - arrayfalseMemcache::getStats - stringtype - intslabid - intlimit100 - - - arrayfalsememcache_get_stats - Memcachememcache - stringtype - intslabid - intlimit100 - - - - Memcache::getStats returns an associative array - with server's statistics. Array keys correspond to stats parameters and - values to parameter's values. - - - - - - &reftitle.parameters; - - - type - - - The type of statistics to fetch. Valid values are {reset, - malloc, maps, cachedump, slabs, items, sizes}. According to - the memcached protocol spec these additional arguments "are - subject to change for the convenience of memcache developers". - - - - - slabid - - - Used in conjunction with type set to - cachedump to identify the slab to dump from. The cachedump - command ties up the server and is strictly to be used for - debugging purposes. - - - - - limit - - - Used in conjunction with type set to - cachedump to limit the number of entries to dump. - - - - - - - - &reftitle.returnvalues; - - Returns an associative array of server statistics&return.falseforfailure;. - - - - - &reftitle.seealso; - - Memcache::getVersion - Memcache::getExtendedStats - - - - - diff --git a/reference/memcache/memcache/getversion.xml b/reference/memcache/memcache/getversion.xml deleted file mode 100644 index 4ee8a4b5878d..000000000000 --- a/reference/memcache/memcache/getversion.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - Memcache::getVersion - memcache_get_version - Return version of the server - - - - &reftitle.description; - - stringfalseMemcache::getVersion - - - - stringfalsememcache_get_version - Memcachememcache - - - - Memcache::getVersion returns a string with server's - version number. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a string of server version number&return.falseforfailure;. - - - - - &reftitle.examples; - - <function>Memcache::getVersion</function> example - -connect('memcache_host', 11211); -echo $memcache->getVersion(); - -/* procedural API */ -$memcache = memcache_connect('memcache_host', 11211); -echo memcache_get_version($memcache); - -?> -]]> - - - - - - &reftitle.seealso; - - Memcache::getExtendedStats - Memcache::getStats - - - - - diff --git a/reference/memcache/memcache/increment.xml b/reference/memcache/memcache/increment.xml deleted file mode 100644 index 341c99fcc54e..000000000000 --- a/reference/memcache/memcache/increment.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - Memcache::increment - memcache_increment - Increment item's value - - - - &reftitle.description; - - intfalseMemcache::increment - stringkey - intvalue1 - - - intfalsememcache_increment - Memcachememcache - stringkey - intvalue1 - - - - Memcache::increment increments value of an item by - the specified value. If item specified by - key was not numeric and cannot be converted to a - number, it will change its value to value. - Memcache::increment does not - create an item if it doesn't already exist. - - - Do not use Memcache::increment with items that have been - stored compressed because subsequent calls to - Memcache::get will fail. - - - - - - - - &reftitle.parameters; - - - key - - - Key of the item to increment. - - - - - value - - - Increment the item by value. - - - - - - - - &reftitle.returnvalues; - - Returns new items value on success &return.falseforfailure;. - - - - - &reftitle.examples; - - <function>Memcache::increment</function> example - -connect('memcache_host', 11211); -/* increment counter by 3 */ -$current_value = $memcache_obj->increment('counter', 3); - -?> -]]> - - - - - - &reftitle.seealso; - - Memcache::decrement - Memcache::replace - - - - - diff --git a/reference/memcache/memcache/pconnect.xml b/reference/memcache/memcache/pconnect.xml deleted file mode 100644 index ed09e4fce1c3..000000000000 --- a/reference/memcache/memcache/pconnect.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - Memcache::pconnect - memcache_pconnect - Open memcached server persistent connection - - - - &reftitle.description; - - boolMemcache::pconnect - stringhost - intport - inttimeout - - - MemcacheMemcache::pconnect - stringhost - intport - inttimeout - - - - Memcache::pconnect is similar to - Memcache::connect with the difference, that - the connection it establishes is persistent. - This connection is not closed after the end of script execution and - by Memcache::close function. - - - - - - &reftitle.parameters; - - - host - - - Point to the host where memcached is listening for connections. This parameter - may also specify other transports like unix:///path/to/memcached.sock - to use UNIX domain sockets, in this case port must also - be set to 0. - - - - - port - - - Point to the port where memcached is listening for connections. Set this - parameter to 0 when using UNIX domain sockets. - - - - - timeout - - - Value in seconds which will be used for connecting to the daemon. Think - twice before changing the default value of 1 second - you can lose all - the advantages of caching if your connection is too slow. - - - - - - - - &reftitle.returnvalues; - - Returns a Memcache object&return.falseforfailure;. - - - - - &reftitle.examples; - - <function>Memcache::pconnect</function> example - -pconnect('memcache_host', 11211); - -?> -]]> - - - - - - &reftitle.seealso; - - Memcache::connect - - - - - diff --git a/reference/memcache/memcache/replace.xml b/reference/memcache/memcache/replace.xml deleted file mode 100644 index 4891a4196ad4..000000000000 --- a/reference/memcache/memcache/replace.xml +++ /dev/null @@ -1,138 +0,0 @@ - - - - - Memcache::replace - memcache_replace - Replace value of the existing item - - - - &reftitle.description; - - boolMemcache::replace - stringkey - mixedvar - intflag - intexpire - - - boolmemcache_replace - Memcachememcache - stringkey - mixedvar - intflag - intexpire - - - - Memcache::replace should be used to replace value of - existing item with key. In case if item with such - key doesn't exists, Memcache::replace returns - &false;. For the rest Memcache::replace behaves - similarly to Memcache::set. - - - - - - &reftitle.parameters; - - - key - - - The key that will be associated with the item. - - - - - var - - - The variable to store. Strings and integers are stored as is, other - types are stored serialized. - - - - - flag - - - Use MEMCACHE_COMPRESSED to store the item - compressed (uses zlib). - - - - - expire - - - Expiration time of the item. If it's equal to zero, the item will never - expire. You can also use Unix timestamp or a number of seconds starting - from current time, but in the latter case the number of seconds may not - exceed 2592000 (30 days). - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>Memcache::replace</function> example - -replace("test_key", "some variable", false, 30); - -?> -]]> - - - - - - &reftitle.seealso; - - Memcache::set - Memcache::add - - - - - diff --git a/reference/memcache/memcache/set.xml b/reference/memcache/memcache/set.xml deleted file mode 100644 index 98145f3ff00e..000000000000 --- a/reference/memcache/memcache/set.xml +++ /dev/null @@ -1,179 +0,0 @@ - - - - - Memcache::set - memcache_set - Store data at the server - - - - &reftitle.description; - - boolMemcache::set - stringkey - mixedvar - intflag - intexpire - - - boolmemcache_set - Memcachememcache - stringkey - mixedvar - intflag - intexpire - - - - Memcache::set stores an item - var with key on the - memcached server. Parameter expire is expiration - time in seconds. If it's 0, the item never expires (but memcached server - doesn't guarantee this item to be stored all the time, it could be deleted - from the cache to make place for other items). - You can use MEMCACHE_COMPRESSED constant as - flag value if you want to use on-the-fly - compression (uses zlib). - - - Remember that resource variables (i.e. file and connection descriptors) - cannot be stored in the cache, because they cannot be adequately - represented in serialized state. - - - - - - - - &reftitle.parameters; - - - key - - - The key that will be associated with the item. - - - - - var - - - The variable to store. Strings and integers are stored as is, other - types are stored serialized. - - - - - flag - - - Use MEMCACHE_COMPRESSED to store the item - compressed (uses zlib). - - - - - expire - - - Expiration time of the item. If it's equal to zero, the item will never - expire. You can also use Unix timestamp or a number of seconds starting - from current time, but in the latter case the number of seconds may not - exceed 2592000 (30 days). - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - <function>Memcache::set</function> example - - -]]> - - - - <function>Memcache::set</function> example - -connect('memcache_host', 11211); - -/* -set value of item with key 'var_key', using on-the-fly compression -expire time is 50 seconds -*/ -$memcache_obj->set('var_key', 'some really big variable', MEMCACHE_COMPRESSED, 50); - -echo $memcache_obj->get('var_key'); - -?> -]]> - - - - - - - &reftitle.seealso; - - Memcache::add - Memcache::replace - - - - diff --git a/reference/memcache/memcache/setcompressthreshold.xml b/reference/memcache/memcache/setcompressthreshold.xml deleted file mode 100644 index 22b77de801af..000000000000 --- a/reference/memcache/memcache/setcompressthreshold.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - Memcache::setCompressThreshold - memcache_set_compress_threshold - Enable automatic compression of large values - - - - &reftitle.description; - - boolMemcache::setCompressThreshold - intthreshold - floatmin_savings - - - boolmemcache_set_compress_threshold - Memcachememcache - intthreshold - floatmin_savings - - - - Memcache::setCompressThreshold enables automatic - compression of large values. - - - - - This function has been added to Memcache version 2.0.0. - - - - - - - &reftitle.parameters; - - - threshold - - - Controls the minimum value length before attempting to compress automatically. - - - - - min_saving - - - Specifies the minimum amount of savings to actually store the value - compressed. The supplied value must be between 0 and 1. Default value - is 0.2 giving a minimum 20% compression savings. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>Memcache::setCompressThreshold</function> example - -addServer('memcache_host', 11211); -$memcache_obj->setCompressThreshold(20000, 0.2); - -/* procedural API */ - -$memcache_obj = memcache_connect('memcache_host', 11211); -memcache_set_compress_threshold($memcache_obj, 20000, 0.2); - -?> -]]> - - - - - - diff --git a/reference/memcache/memcache/setserverparams.xml b/reference/memcache/memcache/setserverparams.xml deleted file mode 100644 index a6547952c8af..000000000000 --- a/reference/memcache/memcache/setserverparams.xml +++ /dev/null @@ -1,178 +0,0 @@ - - - - - Memcache::setServerParams - memcache_set_server_params - Changes server parameters and status at runtime - - - - &reftitle.description; - - boolMemcache::setServerParams - stringhost - intport11211 - inttimeout - intretry_interval&false; - boolstatus - callablefailure_callback - - - boolmemcache_set_server_params - Memcachememcache - stringhost - intport11211 - inttimeout - intretry_interval&false; - boolstatus - callablefailure_callback - - - - Memcache::setServerParams changes server parameters at runtime. - - - - - This function has been added to Memcache version 2.1.0. - - - - - - - &reftitle.parameters; - - - host - - - Point to the host where memcached is listening for connections. - - - - - port - - - Point to the port where memcached is listening for connections. - - - - - timeout - - - Value in seconds which will be used for connecting to the daemon. Think - twice before changing the default value of 1 second - you can lose all - the advantages of caching if your connection is too slow. - - - - - retry_interval - - - Controls how often a failed server will be retried, the default value - is 15 seconds. Setting this parameter to -1 disables automatic retry. - Neither this nor the persistent parameter has any - effect when the extension is loaded dynamically via dl. - - - - - status - - - Controls if the server should be flagged as online. Setting this parameter - to &false; and retry_interval to -1 allows a failed - server to be kept in the pool so as not to affect the key distribution - algorithm. Requests for this server will then failover or fail immediately - depending on the memcache.allow_failover setting. - Default to &true;, meaning the server should be considered online. - - - - - failure_callback - - - Allows the user to specify a callback function to run upon encountering an - error. The callback is run before failover is attempted. The function takes - two parameters, the hostname and port of the failed server. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>Memcache::setServerParams</function> example - -addServer('memcache_host', 11211, false, 1, 1, -1, false); - -// Bring the server back online -$memcache->setServerParams('memcache_host', 11211, 1, 15, true, '_callback_memcache_failure'); - -/* procedural API */ - -$memcache_obj = memcache_connect('memcache_host', 11211); -memcache_set_server_params($memcache_obj, 'memcache_host', 11211, 1, 15, true, '_callback_memcache_failure'); - -?> -]]> - - - - - - &reftitle.seealso; - - Memcache::addServer - Memcache::getServerStatus - - - - - diff --git a/reference/memcache/reference.xml b/reference/memcache/reference.xml deleted file mode 100644 index 343a6e3f8391..000000000000 --- a/reference/memcache/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - Memcache &Functions; - &reference.memcache.entities.functions; - - - - - diff --git a/reference/memcache/setup.xml b/reference/memcache/setup.xml deleted file mode 100644 index 2a435844bd31..000000000000 --- a/reference/memcache/setup.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - &reftitle.setup; - - -
    - &reftitle.required; - - This module uses functions of zlib - to support on-the-fly data compression. Zlib is required to install - this module. - -
    - - - - &reference.memcache.configure; - - - - &reference.memcache.ini; - - - -
    - &reftitle.resources; - - There is only one resource type used in memcache module - it's - the link identifier for a cache server connection. - -
    - - -
    - diff --git a/reference/memcache/versions.xml b/reference/memcache/versions.xml deleted file mode 100644 index 44bca1ce5d4e..000000000000 --- a/reference/memcache/versions.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/memcached/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/memcached/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/memcached/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/memcached/book.xml b/reference/memcached/book.xml deleted file mode 100644 index d9bbe22643b1..000000000000 --- a/reference/memcached/book.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Memcached - Memcached - - - &reftitle.intro; - - memcached is a high-performance, - distributed memory object caching system, generic in nature, but intended - for use in speeding up dynamic web applications by alleviating database - load. - - - This extension uses the libmemcached library to provide an API for communicating - with memcached servers. It also provides a session handler - (memcached). - - - Information about libmemcached can be found at &url.libmemcached;. - - - - &reference.memcached.setup; - &reference.memcached.constants; - &reference.memcached.expiration; - &reference.memcached.callbacks; - &reference.memcached.sessions; - &reference.memcached.memcached; - &reference.memcached.memcachedexception; - - - - - diff --git a/reference/memcached/callbacks.xml b/reference/memcached/callbacks.xml deleted file mode 100644 index 223a06f4f21a..000000000000 --- a/reference/memcached/callbacks.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - Callbacks - -
    - Result callbacks - - Result callables are invoked by - Memcached::getDelayed or - Memcached::getDelayedBykey methods for each item in - the result set. The callback is passed the Memcached object and the array - with the item information. The callback does not have to return anything. - - - Result callback example - -addServer('localhost', 11211); -$items = array( - 'key1' => 'value1', - 'key2' => 'value2', - 'key3' => 'value3' -); -$m->setMulti($items); -$m->getDelayed(array('key1', 'key3'), true, 'result_cb'); - -function result_cb($memc, $item) -{ - var_dump($item); -} -?> -]]> - - &example.outputs.similar; - - - string(4) "key1" - ["value"]=> - string(6) "value1" - ["cas"]=> - float(49) -} -array(3) { - ["key"]=> - string(4) "key3" - ["value"]=> - string(6) "value3" - ["cas"]=> - float(50) -} -]]> - - -
    - -
    - Read-through cache callbacks - - Read-through cache callbacks are invoked when an item cannot be retrieved - from the server. The callback is passed the Memcached object, the requested - key, and the by-reference value variable. The callback is responsible for - setting the value and returning true or false. If the callback returns true, - Memcached will store the populated value on the server and return it to the - original calling function. Only Memcached::get and - Memcached::getByKey support these callbacks, - because the memcache protocol does not provide information on which keys - were not found in the multi-key request. - - - Read-through callback example - -addServer('localhost', 11211); - -$profile_info = $m->get('user:'.$user_id, 'user_info_cb'); - -function user_info_cb($memc, $key, &$value) -{ - $user_id = substr($key, 5); - /* lookup profile info in the DB */ - /* ... */ - $value = $profile_info; - return true; -} -?> -]]> - - -
    - -
    - - diff --git a/reference/memcached/configure.xml b/reference/memcached/configure.xml deleted file mode 100644 index 5ea873c36bb9..000000000000 --- a/reference/memcached/configure.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - -
    - &reftitle.install; - - &pecl.info; - &url.pecl.package;memcached. - - - If libmemcached is installed in a non-standard location, use switch, where DIR is the - libmemcached install prefix. This directory has to contain the - include/libmemcached/memcached.h file. - - - Zlib is required for compression support. To specify non-standard - installation of Zlib, use switch, where DIR is the Zlib - install prefix. - - - Session handler support is enabled by default. To disable it, use switch. - - - SASL authentication support is disabled by default. To enable it, use - switch. This - requires that libsasl2 has been installed and that libmemcached has been - built with SASL support enabled. - -
    - - - diff --git a/reference/memcached/constants.xml b/reference/memcached/constants.xml deleted file mode 100644 index 29dfba336ec7..000000000000 --- a/reference/memcached/constants.xml +++ /dev/null @@ -1,951 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - - - Memcached::OPT_COMPRESSION - - - Enables or disables payload compression. When enabled, - item values longer than a certain threshold (currently 2000 bytes) will be - compressed during storage and decompressed during retrieval - transparently. The threshold can be configured using the - memcached.compression_threshold - ini setting. - - Type: bool, default: &true;. - - - - - Memcached::OPT_COMPRESSION_TYPE - - - Specifies the compression algorithm to use, if compression is enabled. - The valid algorithms are Memcached::COMPRESSION_FASTLZ, - Memcached::COMPRESSION_ZLIB and - Memcached::COMPRESSION_ZSTD. - - Type: int, default: Memcached::COMPRESSION_FASTLZ. - - - - - Memcached::COMPRESSION_FASTLZ - - - The FASTLZ compression algorithm. - - - - - - Memcached::COMPRESSION_ZLIB - - The ZLIB compression algorithm. - - - - - Memcached::COMPRESSION_ZSTD - - - The ZSTD compression algorithm. - - - Available as of Memcached 3.3.0. - - - - - - Memcached::OPT_COMPRESSION_LEVEL - - - Specifies the compression level to use, if compression is enabled. - - - Memcached::COMPRESSION_FASTLZ does not support compression levels. - Memcached::COMPRESSION_ZSTD: minimum level is -22 and maximum level is 22. - Memcached::COMPRESSION_ZLIB: minimum level is 0 and maximum level is 9. - - Type: int, default: 3. - - - - - Memcached::OPT_SERIALIZER - - - Specifies the serializer to use for serializing non-scalar values. - The valid serializers are Memcached::SERIALIZER_PHP, - Memcached::SERIALIZER_IGBINARY, - Memcached::SERIALIZER_JSON, - Memcached::SERIALIZER_JSON_ARRAY and - Memcached::SERIALIZER_MSGPACK. - - - Type: int, default: Memcached::SERIALIZER_IGBINARY if available, - then Memcached::SERIALIZER_MSGPACK if available, - then Memcached::SERIALIZER_PHP. - - - - - - Memcached::SERIALIZER_PHP - - The default PHP serializer. - - - - - Memcached::SERIALIZER_IGBINARY - - - The igbinary serializer. - Instead of textual representation it stores PHP data structures in a - compact binary form, resulting in space and time gains. - - - This serializer is supported only if memcached is configured with - option and the - igbinary extension is loaded. - - - - - - Memcached::SERIALIZER_JSON - - The JSON serializer. This serializer deserializes JSON to an object. - - - - - Memcached::SERIALIZER_JSON_ARRAY - - - The JSON array serializer. - This serializer deserializes JSON to an associative array - - - - - - Memcached::SERIALIZER_MSGPACK - - - The MessagePack serializer. - - - This serializer is supported only if memcached is configured with - option and the - msgpack extension is loaded. - - - - - - Memcached::OPT_PREFIX_KEY - - - This can be used to create a "domain" for your item keys. The value - specified here will be prefixed to each of the keys. It cannot be - longer than 128 characters and will reduce the - maximum available key size. The prefix is applied only to the item keys, - not to the server keys. - - Type: string, default: "". - - - - - Memcached::OPT_HASH - - - Specifies the hashing algorithm used for the item keys. The valid - values are supplied via Memcached::HASH_* constants. - Each hash algorithm has its advantages and its disadvantages. Go with the - default if you don't know or don't care. - - Type: int, default: Memcached::HASH_DEFAULT - - - - - Memcached::HASH_DEFAULT - - The default (Jenkins one-at-a-time) item key hashing algorithm. - - - - - Memcached::HASH_MD5 - - MD5 item key hashing algorithm. - - - - - Memcached::HASH_CRC - - CRC item key hashing algorithm. - - - - - Memcached::HASH_FNV1_64 - - FNV1_64 item key hashing algorithm. - - - - - Memcached::HASH_FNV1A_64 - - FNV1_64A item key hashing algorithm. - - - - - Memcached::HASH_FNV1_32 - - FNV1_32 item key hashing algorithm. - - - - - Memcached::HASH_FNV1A_32 - - FNV1_32A item key hashing algorithm. - - - - - Memcached::HASH_HSIEH - - Hsieh item key hashing algorithm. - - - - - Memcached::HASH_MURMUR - - Murmur item key hashing algorithm. - - - - - Memcached::OPT_DISTRIBUTION - - - Specifies the method of distributing item keys to the servers. - Currently supported methods are modulo and consistent hashing. Consistent - hashing delivers better distribution and allows servers to be added to - the cluster with minimal cache losses. - - Type: int, default: Memcached::DISTRIBUTION_MODULA. - - - - - Memcached::DISTRIBUTION_MODULA - - Modulo-based key distribution algorithm. - - - - - Memcached::DISTRIBUTION_CONSISTENT - - Consistent hashing key distribution algorithm (based on libketama). - - - - - Memcached::DISTRIBUTION_VIRTUAL_BUCKET - - - Virtual Bucket hashing key distribution algorithm (also called vbucket). - - - - - - Memcached::OPT_LIBKETAMA_COMPATIBLE - - - Enables or disables compatibility with libketama-like behavior. When - enabled, the item key hashing algorithm is set to MD5 and distribution is - set to be weighted consistent hashing distribution. This is useful - because other libketama-based clients (Python, Ruby, etc.) with the same - server configuration will be able to access the keys transparently. - - - - It is highly recommended to enable this option if you want to use - consistent hashing, and it may be enabled by default in future - releases. - - - Type: bool, default: &false;. - - - - - Memcached::OPT_LIBKETAMA_HASH - - - Specifies the hashing algorithm for host mapping. - - Type: int. - - - - - Memcached::OPT_TCP_KEEPALIVE - - - Enables TCP keep alive. - - Type: bool, default: &false;. - - - - - Memcached::OPT_BUFFER_WRITES - - - Enables or disables buffered I/O. Enabling buffered I/O causes - storage commands to "buffer" instead of being sent. Any action that - retrieves data causes this buffer to be sent to the remote connection. - Quitting the connection or closing down the connection will also cause - the buffered data to be pushed to the remote connection. - - Type: bool, default: &false;. - - - - - Memcached::OPT_BINARY_PROTOCOL - - - Enable the use of the binary protocol. Please note that you cannot - toggle this option on an open connection. - - Type: bool, default: &false;. - - - - - Memcached::OPT_NO_BLOCK - - - Enables or disables asynchronous I/O. This is the fastest transport - available for storage functions. - - Type: bool, default: &false;. - - - - - Memcached::OPT_NOREPLY - - - Enables or disables ignoring the result of storage commands - (set, add, replace, append, prepend, delete, increment, decrement, etc.). - Storage commands will be sent without spending time waiting for a reply - (there would be no reply). - Retrieval commands such as Memcached::get are unaffected by this setting. - - Type: bool, default: &false;. - - - - - Memcached::OPT_TCP_NODELAY - - - Enables or disables the no-delay feature for connecting sockets (may - be faster in some environments). - - Type: bool, default: &false;. - - - - - Memcached::OPT_SOCKET_SEND_SIZE - - The maximum socket send buffer in bytes. - - Type: int, default: varies by platform/kernel - configuration. - - - - - - Memcached::OPT_SOCKET_RECV_SIZE - - The maximum socket receive buffer in bytes. - - Type: int, default: varies by platform/kernel - configuration. - - - - - - Memcached::OPT_CONNECT_TIMEOUT - - - In non-blocking mode this set the value of the timeout during socket - connection, in milliseconds. - - Type: int, default: 1000. - - - - - Memcached::OPT_RETRY_TIMEOUT - - - The amount of time, in seconds, to wait until retrying a failed - connection attempt. - - Type: int, default: 2. - - - - - Memcached::OPT_DEAD_TIMEOUT - - - The amount of time, in seconds, to wait until retrying dead servers. - 0 means no retry. - - Type: int, default: 0. - - - - - Memcached::OPT_SEND_TIMEOUT - - - Socket sending timeout, in microseconds. In cases where you cannot - use non-blocking I/O this will allow you to still have timeouts on the - sending of data. - - Type: int, default: 0. - - - - - Memcached::OPT_RECV_TIMEOUT - - - Socket reading timeout, in microseconds. In cases where you cannot - use non-blocking I/O this will allow you to still have timeouts on the - reading of data. - - Type: int, default: 0. - - - - - Memcached::OPT_POLL_TIMEOUT - - Timeout for connection polling, in milliseconds. - Type: int, default: 1000. - - - - - Memcached::OPT_CACHE_LOOKUPS - - Enables or disables caching of DNS lookups. - Type: bool, default: &false;. - - - - - Memcached::OPT_SERVER_FAILURE_LIMIT - - - Specifies the failure limit for server connection attempts. - The server will be removed after this many continuous connection failures. - - Type: int, default: 5. - - - - - Memcached::OPT_SERVER_TIMEOUT_LIMIT - - - Specifies the timeout limit for server connection attempts. - The server will be removed after this many continuous connection timeouts. - - Type: int, default: 0. - - - - - Memcached::OPT_AUTO_EJECT_HOSTS - - - Removes disabled servers from the list. Use together with - Memcached::OPT_SERVER_FAILURE_LIMIT and - Memcached::OPT_SERVER_TIMEOUT_LIMIT. - - - - This option is replaced by - Memcached::OPT_REMOVE_FAILED_SERVERS. - - - Type: bool, default: &false;. - - - - - Memcached::OPT_VERIFY_KEY - - - Enables verification of keys by memcached. - - Type: bool, default: &false;. - - - - - Memcached::OPT_USE_UDP - - - Uses UDP instead of TCP. - - Type: bool, default: &false;. - - - - - Memcached::OPT_NUMBER_OF_REPLICAS - - - Stores this many replicas of each item on different servers. - - Type: int, default: 0. - - - - - Memcached::OPT_RANDOMIZE_REPLICA_READS - - - Randomizes replica read server. - - Type: bool, default: &false;. - - - - - Memcached::OPT_REMOVE_FAILED_SERVERS - - - Removes disabled servers from the list. Use together with - Memcached::OPT_SERVER_FAILURE_LIMIT and - Memcached::OPT_SERVER_TIMEOUT_LIMIT. - - Type: bool, default: &false;. - - - - - Memcached::HAVE_IGBINARY - - Indicates whether igbinary serializer support is available. - Type: bool. - - - - - Memcached::HAVE_JSON - - Indicates whether JSON serializer support is available. - Type: bool. - - - - - Memcached::HAVE_MSGPACK - - Indicates whether MessagePack serializer support is available. - Type: bool. - Available as of Memcached 3.0.0. - - - - - Memcached::HAVE_ZSTD - - Indicates whether ZSTD compression support is available. - Type: bool. - Available as of Memcached 3.3.0. - - - - - Memcached::HAVE_ENCODING - - - Indicates whether data encryption using - Memcached::setEncodingKey is supported. - - Type: bool. - Available as of Memcached 3.1.0. - - - - - Memcached::HAVE_SESSION - - Type: bool. - Available as of Memcached 3.0.0. - - - - - Memcached::HAVE_SASL - - Type: bool. - Available as of Memcached 3.0.0. - - - - - Memcached::GET_EXTENDED - - - A flag for Memcached::get, Memcached::getMulti and - Memcached::getMultiByKey to ensure that the CAS token values - are returned as well. - - Available as of Memcached 3.0.0. - - - - - Memcached::GET_PRESERVE_ORDER - - - A flag for Memcached::getMulti and - Memcached::getMultiByKey to ensure that the keys are - returned in the same order as they were requested in. Non-existing keys - get a default value of &null;. - - - - - - Memcached::RES_SUCCESS - - The operation was successful. - - - - - Memcached::RES_FAILURE - - The operation failed in some fashion. - - - - - Memcached::RES_HOST_LOOKUP_FAILURE - - DNS lookup failed. - - - - - Memcached::RES_UNKNOWN_READ_FAILURE - - Failed to read network data. - - - - - Memcached::RES_PROTOCOL_ERROR - - Bad command in memcached protocol. - - - - - Memcached::RES_CLIENT_ERROR - - Error on the client side. - - - - - Memcached::RES_SERVER_ERROR - - Error on the server side. - - - - - Memcached::RES_WRITE_FAILURE - - Failed to write network data. - - - - - Memcached::RES_DATA_EXISTS - - Failed to do compare-and-swap: item you are trying to store has been - modified since you last fetched it. - - - - - Memcached::RES_NOTSTORED - - - Item was not stored: but not because of an error. This normally - means that either the condition for an "add" or a "replace" command - wasn't met, or that the item is in a delete queue. - - - - - - Memcached::RES_NOTFOUND - - - Item with this key was not found (with "get" operation or "cas" - operations). - - - - - - Memcached::RES_PARTIAL_READ - - Partial network data read error. - - - - - Memcached::RES_SOME_ERRORS - - Some errors occurred during multi-get. - - - - - Memcached::RES_NO_SERVERS - - Server list is empty. - - - - - Memcached::RES_END - - End of result set. - - - - - Memcached::RES_ERRNO - - System error. - - - - - Memcached::RES_BUFFERED - - The operation was buffered. - - - - - Memcached::RES_TIMEOUT - - The operation timed out. - - - - - Memcached::RES_BAD_KEY_PROVIDED - - Bad key. - - - - - Memcached::RES_STORED - - Item stored. - - - - - Memcached::RES_DELETED - - Item deleted. - - - - - Memcached::RES_STAT - - Statistics. - - - - - Memcached::RES_ITEM - - Item. - - - - - Memcached::RES_NOT_SUPPORTED - - Not supported. - - - - - Memcached::RES_FETCH_NOTFINISHED - - Fetch not finished. - - - - - Memcached::RES_SERVER_MARKED_DEAD - - Server marked dead. - - - - - Memcached::RES_UNKNOWN_STAT_KEY - - Unknown stat key. - - - - - Memcached::RES_INVALID_HOST_PROTOCOL - - Invalid host protocol. - - - - - Memcached::RES_MEMORY_ALLOCATION_FAILURE - - Memory allocation failure. - - - - - Memcached::RES_CONNECTION_SOCKET_CREATE_FAILURE - - Failed to create network socket. - - - - - Memcached::RES_PAYLOAD_FAILURE - - Payload failure: could not compress/decompress or serialize/unserialize the value. - - - - - Memcached::RES_AUTH_PROBLEM - - Available as of Memcached 3.0.0. - - - - - Memcached::RES_AUTH_FAILURE - - Available as of Memcached 3.0.0. - - - - - Memcached::RES_AUTH_CONTINUE - - Available as of Memcached 3.0.0. - - - - - Memcached::RES_E2BIG - - Available as of Memcached 3.0.0. - - - - - Memcached::RES_KEY_TOO_BIG - - Available as of Memcached 3.0.0. - - - - - Memcached::RES_SERVER_TEMPORARILY_DISABLED - - Available as of Memcached 3.0.0. - - - - - Memcached::RES_SERVER_MEMORY_ALLOCATION_FAILURE - - Available as of Memcached 3.0.0. - - - - - - - - diff --git a/reference/memcached/expiration.xml b/reference/memcached/expiration.xml deleted file mode 100644 index a596cacd1ece..000000000000 --- a/reference/memcached/expiration.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - Expiration Times - - Some storage commands involve sending an expiration value (relative to an - item or to an operation requested by the client) to the server. In all such - cases, the actual value sent may either be Unix time (number of seconds - since January 1, 1970, as an integer), or a number of seconds starting from - current time. In the latter case, this number of seconds may not exceed - 60*60*24*30 (number of seconds in 30 days); if the expiration value is - larger than that, the server will consider it to be real Unix time value - rather than an offset from current time. - - - If the expiration value is 0 (the default), the item - never expires (although it may be deleted from the server to make place for - other items). - - - - - diff --git a/reference/memcached/ini.xml b/reference/memcached/ini.xml deleted file mode 100644 index f1eb326565c5..000000000000 --- a/reference/memcached/ini.xml +++ /dev/null @@ -1,682 +0,0 @@ - - - -
    - &reftitle.runtime; - &extension.runtime; - - - Memcached &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - memcached.sess_locking - On - INI_ALL - Available as of memcached 0.1.0. - - - memcached.sess_consistent_hash - On - INI_ALL - Available as of memcached 2.1.0. Default value is On as of memcached 3.0.0. - - - memcached.sess_binary - Off - INI_ALL - Available as of memcached 2.0.0. Replaced by memcached.sess_binary_protocol as of memcached 3.0.0. - - - memcached.sess_lock_wait - 150000 - INI_ALL - Available as of memcached 0.1.0. Removed as of memcached 3.0.0. - - - memcached.sess_prefix - memc.sess.key. - INI_ALL - Available as of memcached 0.1.0. - - - memcached.sess_number_of_replicas - 0 - INI_ALL - Available as of memcached 2.1.0. - - - memcached.sess_randomize_replica_read - Off - INI_ALL - Available as of memcached 2.1.0. - - - memcached.sess_remove_failed - On - INI_ALL - Available as of memcached 2.1.0. Replaced by memcached.sess_remove_failed_servers as of memcached 3.0.0. - - - memcached.compression_type - fastlz - INI_ALL - Available as of memcached 0.1.0. - - - memcached.compression_factor - 1.3 - INI_ALL - Available as of memcached 0.1.0. - - - memcached.compression_threshold - 2000 - INI_ALL - Available as of memcached 0.1.0. - - - memcached.serializer - igbinary - INI_ALL - Available as of memcached 0.1.0. - - - memcached.use_sasl - Off - INI_ALL - Available as of memcached 2.2.0. Removed as of memcached 3.0.0. - - - memcached.default_binary_protocol - Off - INI_ALL - Available as of memcached 3.0.0. - - - memcached.default_connect_timeout - 0 - INI_ALL - Available as of memcached 3.0.0. - - - memcached.default_consistent_hash - Off - INI_ALL - Available as of memcached 3.0.0. - - - memcached.sess_binary_protocol - On - INI_ALL - Available as of memcached 3.0.0. Replace memcached.sess_binary. - - - memcached.sess_connect_timeout - 1000 - INI_ALL - Available as of memcached 2.2.0. - - - memcached.sess_consistent_hash_type - ketama - INI_ALL - Available as of memcached 3.1.0. - - - memcached.sess_lock_expire - 0 - INI_ALL - Available as of memcached 2.2.0. - - - memcached.sess_lock_retries - 5 - INI_ALL - Available as of memcached 3.0.0. - - - memcached.sess_lock_wait_max - 150 - INI_ALL - Available as of memcached 3.0.0. Default value 150 as of memcached 3.1.0 (previously 2000). - - - memcached.sess_lock_wait_min - 150 - INI_ALL - Available as of memcached 3.0.0. Default value 150 as of memcached 3.1.0 (previously 1000). - - - memcached.sess_persistent - Off - INI_ALL - Available as of memcached 3.0.0. - - - memcached.sess_remove_failed_servers - Off - INI_ALL - Available as of memcached 3.0.0. Replace memcached.sess_remove_failed. - - - memcached.sess_server_failure_limit - 0 - INI_ALL - Available as of memcached 3.0.0. - - - memcached.sess_sasl_password - null - INI_ALL - Available as of memcached 2.2.0. - - - memcached.sess_sasl_username - null - INI_ALL - Available as of memcached 2.2.0. - - - memcached.store_retry_count - 0 - INI_ALL - - Available as of memcached 2.2.0. - Default value 0 as of memcached 3.2.0 - (previously 2). - - - - -
    -
    - - &ini.descriptions.title; - - - - - - memcached.sess_locking - bool - - - - Use session locking. Valid values: On, Off, the default is On. - - - - - - memcached.sess_consistent_hash - bool - - - - If set to On, consistent hashing (libketama) is used for session handling. - When consistent hashing is used, - one can add or remove cache node(s) without messing up too much with existing keys. - Default is On. - - - - - - memcached.sess_binary - bool - - - - Use memcached session binary mode. Libmemcached replicas only work if - binary mode is enabled. The default is Off. - - - - - - memcached.sess_lock_wait - int - - - - Session spin lock retry wait time in microseconds. Be careful when - setting this value. Valid values are integers, where 0 is interpreted - as the default value. Negative values result in a reduces locking to a - try lock. The default is 150000. - - - - - - memcached.sess_prefix - string - - - - Memcached session key prefix. Valid values are strings less than 219 - bytes long. The default value is memc.sess.key. - - - - - - memcached.sess_number_of_replicas - int - - - - Write data to a number of additional memcached servers. This is "poor man's HA" as libmemcached calls it. - If this value is positive and sess_remove_failed_servers is enabled - when a memcached server fails the session will continue to be available from a replica. - However, if the failed memcache server becomes available again it will read the session - from there which could have old data or no data at all. - Default is 0. - - - - - - memcached.sess_randomize_replica_read - bool - - - - Memcached session replica read randomize. - - - - - - memcached.sess_remove_failed - int - - - - Allow failed memcached server to automatically be removed. - - - - - - memcached.compression_type - string - - - - Set the compression type, valid values are: fastlz, zlib. - The default is fastlz. - - - - - - memcached.compression_factor - float - - - - Compression factor. Store compressed value only if the compression - factor (saving) exceeds the set limit. Store compressed if: - plain_len > comp_len * factor. The default value - is 1.3 (23% space saving). - - - - - - memcached.compression_threshold - int - - - - The compression threshold. Do not compress serialized values below this - threshold. The default is 2000 bytes. - - - - - - memcached.serializer - string - - - - Set the default serializer for new memcached objects. Valid values - are: php, igbinary, json, - json_array, msgpack. - - - - json - - - Standard PHP JSON encoding. This serializer is fast and compact but - only works on UTF-8 encoded data and does not fully implement - serializing. See the JSON extension. Available as of memcached 0.2.0. - - - - - json_array - - - As json, but decodes into arrays. Available as of memcached 2.0.0. - - - - - php - - - The standard PHP serializer. - - - - - igbinary - - - A binary serializer. Available as of memcached 0.1.4. - - - - - msgpack - - - A cross-language binary serializer. Available as of memcached 2.2.0. - - - - - - The default is igbinary if available, then msgpack if - available, then php otherwise. - - - - - - memcached.use_sasl - bool - - - - Use SASL authentication for connections. Valid values: On, Off. The - default is Off. - - - - - - memcached.default_binary_protocol - bool - - - - Sets the default memcached protocol for new connections. (To configure the memcached protocol for - connections used by sessions, use memcached.sess_binary_protocol instead.) - - If set to On, the memcached binary protocol is used by default. - If set to Off, the memcached text protocol is used. - Default is Off. - - - - - - memcached.default_connect_timeout - int - - - - Sets the default memcached connection timeout for new connections. - (To configure the memcached connection timeout for sessions, use memcached.sess_connect_timeout instead.) - - In non-blocking mode this changes the value of the timeout. - During socket connection in milliseconds. - Specifying -1 means an infinite timeout. - Specifying 0 means using the memcached library's default connection timeout. - Default is 0. - - - - - - memcached.default_consistent_hash - bool - - - - Sets the default for consistent hashing for new connections. - (To configure consistent hashing for session connections, - use memcached.sess_consistent_hash instead.) - - If set to On, consistent hashing (libketama) is used for - session handling. When consistent hashing is used, one can add or remove cache node(s) - without messing up too much with existing keys default is Off. - - - - - - memcached.sess_binary_protocol - bool - - - - Use the memcached binary protocol for memcached sessions instead of the text protocol. - libmemcached replicas only work if the binary mode is enabled. - However, certain proxies (such as twemproxy) will only work if the binary protocol is disabled. - Default is On as of libmemcached 1.0.18. - Prior to libmemcached 1.0.18, the default was Off. - - - - In previous versions of php-memcached, this setting was called - memcached.sess_binary. - - - - - - - memcached.sess_connect_timeout - int - - - - memcached connect timeout value - In non-blocking mode this changes the value of the timeout - during socket connection in milliseconds. - Specifying -1 means an infinite timeout. - - - - - - memcached.sess_consistent_hash_type - string - - - - Memcached session consistent hash type. - If set to ketama, consistent hashing (libketama) - is used for session handling. - If set to ketama_weighted, weighted consistent hashing (libketama) - is used for session handling. - Default is ketama. - Prior to php-memcached 3.0, the default was ketama_weighted. - - - - - - memcached.sess_lock_expire - int - - - - The time, in seconds, before a lock should release itself. - Setting to 0 results in the default behaviour, - which is to use PHP's max_execution_time. - Default is 0. - - - - - - memcached.sess_lock_retries - int - - - - The number of times to retry locking the session lock, not including the first attempt. - Default is 5. - - - - - - memcached.sess_lock_wait_max - int - - - - The maximum time, in milliseconds, to wait between session lock attempts. - The default is 150. - - - - - - memcached.sess_lock_wait_min - int - - - - The minimum time, in milliseconds, to wait between session lock attempts. - This value is double on each lock retry until memcached.sess_lock_wait_max is - reached, after which any further retries will take - memcached.sess_lock_wait_max seconds. - The default is 150. - - - - - - memcached.sess_persistent - bool - - - - Whether or not to re-use the memcached connections corresponding to the value(s) of - session.save_path after the execution of the script ends. Don't use this if - certain settings (e.g. SASL settings, sess_binary_protocol) would be overridden between requests. - Default is Off. - - - - - - memcached.sess_remove_failed_servers - bool - - - - Allow failed memcached server to automatically be removed. - Default is Off. - - - - In previous versions of php-memcached, this setting was called - memcached.sess_remove_failed. - - - - - - - memcached.sess_server_failure_limit - int - - - - Set this value to enable the server be removed after - configured number of continuous times connection failure. - Default is 0. - - - - - - memcached.sess_sasl_password - string - - - - Session SASL password. - Both username and password need to be set for SASL to be enabled. - - - - - - memcached.sess_sasl_username - string - - - - Session SASL username. - Both username and password need to be set for SASL to be enabled. - - - - - - memcached.store_retry_count - int - - - - The amount of retries for failed store commands. - This mechanism allows transparent fail-over to secondary servers when - set/increment/decrement/setMulti operations fail on - the desired server in a multi-server environment. - The default is 2. - - - - - -
    - - diff --git a/reference/memcached/memcached.xml b/reference/memcached/memcached.xml deleted file mode 100644 index c05f72351f73..000000000000 --- a/reference/memcached/memcached.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - The Memcached class - Memcached - - - - -
    - &reftitle.intro; - - Represents a connection to a set of memcached servers. - -
    - - -
    - &reftitle.classsynopsis; - - - - - Memcached - - - - - Memcached - - - - &Methods; - - - - - -
    - -
    - - &reference.memcached.entities.memcached; - -
    - diff --git a/reference/memcached/memcached/add.xml b/reference/memcached/memcached/add.xml deleted file mode 100644 index e78dba2484b2..000000000000 --- a/reference/memcached/memcached/add.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - Memcached::add - Add an item under a new key - - - - &reftitle.description; - - public boolMemcached::add - stringkey - mixedvalue - intexpiration0 - - - Memcached::add is similar to - Memcached::set, but the operation fails if the - key already exists on the server. - - - - - &reftitle.parameters; - - - - key - - - &memcached.parameter.key; - - - - - value - - - &memcached.parameter.value; - - - - - expiration - - - &memcached.parameter.expiration; - - - - - - - - - &reftitle.returnvalues; - - &return.success; - The Memcached::getResultCode will return - Memcached::RES_NOTSTORED if the key already exists. - - - - - &reftitle.seealso; - - - Memcached::addByKey - Memcached::set - Memcached::replace - - - - - - diff --git a/reference/memcached/memcached/addbykey.xml b/reference/memcached/memcached/addbykey.xml deleted file mode 100644 index d4a98f1d1995..000000000000 --- a/reference/memcached/memcached/addbykey.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - Memcached::addByKey - Add an item under a new key on a specific server - - - - &reftitle.description; - - public boolMemcached::addByKey - stringserver_key - stringkey - mixedvalue - intexpiration0 - - - Memcached::addByKey is functionally equivalent to - Memcached::add, except that the free-form - server_key can be used to map the - key to a specific server. This is useful if you need - to keep a bunch of related keys on a certain server. - - - - - &reftitle.parameters; - - - - server_key - - - &memcached.parameter.server_key; - - - - - key - - - &memcached.parameter.key; - - - - - value - - - &memcached.parameter.value; - - - - - expiration - - - &memcached.parameter.expiration; - - - - - - - - - &reftitle.returnvalues; - - &return.success; - The Memcached::getResultCode will return - Memcached::RES_NOTSTORED if the key already exists. - - - - - &reftitle.seealso; - - - Memcached::add - Memcached::set - Memcached::replace - - - - - - diff --git a/reference/memcached/memcached/addserver.xml b/reference/memcached/memcached/addserver.xml deleted file mode 100644 index c6c5df84a057..000000000000 --- a/reference/memcached/memcached/addserver.xml +++ /dev/null @@ -1,138 +0,0 @@ - - - - - Memcached::addServer - Add a server to the server pool - - - - &reftitle.description; - - public boolMemcached::addServer - stringhost - intport - intweight0 - - - Memcached::addServer adds the specified server to the - server pool. No connection is established to the server at this time, but - if you are using consistent key distribution option (via - Memcached::DISTRIBUTION_CONSISTENT or - Memcached::OPT_LIBKETAMA_COMPATIBLE), some of the - internal data structures will have to be updated. Thus, if you need to add - multiple servers, it is better to use - Memcached::addServers as the update then happens - only once. - - - The same server may appear multiple times in the server pool, because no - duplication checks are made. This is not advisable; instead, use the - weight option to increase the selection weighting of - this server. - - - - - &reftitle.parameters; - - - - host - - - The hostname of the memcache server. If the hostname is invalid, - data-related operations will set - Memcached::RES_HOST_LOOKUP_FAILURE result code. As - of version 2.0.0b1, this parameter may also specify the path of a unix - socket filepath ex. /path/to/memcached.sock - to use UNIX domain sockets, in this case port - must also be set to 0. - - - - - port - - - The port on which memcache is running. Usually, this is - 11211. As of version 2.0.0b1, set this parameter to 0 when - using UNIX domain sockets. - - - - - weight - - - The weight of the server relative to the total weight of all the - servers in the pool. This controls the probability of the server being - selected for operations. This is used only with consistent distribution - option and usually corresponds to the amount of memory available to - memcache on that server. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - <function>Memcached::addServer</function> example - -addServer('mem1.domain.com', 11211, 33); -$m->addServer('mem2.domain.com', 11211, 67); -?> -]]> - - - - - - - &reftitle.seealso; - - - Memcached::addServers - Memcached::resetServerList - - - - - - diff --git a/reference/memcached/memcached/addservers.xml b/reference/memcached/memcached/addservers.xml deleted file mode 100644 index 4bb99510a413..000000000000 --- a/reference/memcached/memcached/addservers.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - Memcached::addServers - Add multiple servers to the server pool - - - - &reftitle.description; - - public boolMemcached::addServers - arrayservers - - - Memcached::addServers adds - servers to the server pool. Each entry in - servers is supposed to be an array containing hostname, - port, and, optionally, weight of the server. No connection is established - to the servers at this time. - - - The same server may appear multiple times in the server pool, because no - duplication checks are made. This is not advisable; instead, use the - weight option to increase the selection weighting of - this server. - - - - - &reftitle.parameters; - - - - array - - - Array of the servers to add to the pool. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - <function>Memcached::addServers</function> example - -addServers($servers); -?> -]]> - - - - - - - &reftitle.seealso; - - - Memcached::addServer - Memcached::resetServerList - - - - - - diff --git a/reference/memcached/memcached/append.xml b/reference/memcached/memcached/append.xml deleted file mode 100644 index 9a402ed7f29b..000000000000 --- a/reference/memcached/memcached/append.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - Memcached::append - Append data to an existing item - - - - &reftitle.description; - - public boolnullMemcached::append - stringkey - stringvalue - - - Memcached::append appends the given - value string to the value of an existing item. The - reason that value is forced to be a string is - that appending mixed types is not well-defined. - - - - If the Memcached::OPT_COMPRESSION is enabled, the - operation will fail and a warning will be issued, because appending - compressed data to a value that is potentially already compressed is not - possible. - - - - - - &reftitle.parameters; - - - - key - - - &memcached.parameter.key; - - - - - value - - - The string to append. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - Returns &null; when compression is on. - - - - - &reftitle.errors; - - Returns &null; and raises an E_WARNING when - compression is enabled. - - - - - &reftitle.examples; - - - <function>Memcached::append</function> example - -addServer('localhost', 11211); -$m->setOption(Memcached::OPT_COMPRESSION, false); - -$m->set('foo', 'abc'); -$m->append('foo', 'def'); -var_dump($m->get('foo')); -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - - Memcached::appendByKey - Memcached::prepend - - - - - - diff --git a/reference/memcached/memcached/appendbykey.xml b/reference/memcached/memcached/appendbykey.xml deleted file mode 100644 index 756b4bdcc39a..000000000000 --- a/reference/memcached/memcached/appendbykey.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - Memcached::appendByKey - Append data to an existing item on a specific server - - - - &reftitle.description; - - public boolnullMemcached::appendByKey - stringserver_key - stringkey - stringvalue - - - Memcached::appendByKey is functionally equivalent to - Memcached::append, except that the free-form - server_key can be used to map the - key to a specific server. - - - - - &reftitle.parameters; - - - - server_key - - - &memcached.parameter.server_key; - - - - - key - - - &memcached.parameter.key; - - - - - value - - - The string to append. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - Returns &null; when compression is on. - - - - - &reftitle.errors; - - Returns &null; and raises an E_WARNING when - compression is enabled. - - - - - &reftitle.seealso; - - - Memcached::append - Memcached::prepend - - - - - - diff --git a/reference/memcached/memcached/cas.xml b/reference/memcached/memcached/cas.xml deleted file mode 100644 index 40d6e2c5aa19..000000000000 --- a/reference/memcached/memcached/cas.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - Memcached::cas - Compare and swap an item - - - - &reftitle.description; - - public boolMemcached::cas - stringintfloatcas_token - stringkey - mixedvalue - intexpiration0 - - - Memcached::cas performs a "check and set" operation, - so that the item will be stored only if no other client has updated it - since it was last fetched by this client. The check is done via the - cas_token parameter which is a unique 64-bit - value assigned to the existing item by memcache. See the documentation for - Memcached::get* methods for how to obtain this - token. Note that the token is represented as a float due to the - limitations of PHP's integer space. - - - - - &reftitle.parameters; - - - - cas_token - - - Unique value associated with the existing item. Generated by memcache. - - - - - key - - - &memcached.parameter.key; - - - - - value - - - &memcached.parameter.value; - - - - - expiration - - - &memcached.parameter.expiration; - - - - - - - - - &reftitle.returnvalues; - - &return.success; - The Memcached::getResultCode will return - Memcached::RES_DATA_EXISTS if the item you are trying - to store has been modified since you last fetched it. - - - - - &reftitle.examples; - - - <function>Memcached::cas</function> example - -addServer('localhost', 11211); - -do { - /* fetch IP list and its token */ - $ips = $m->get('ip_block', null, $cas); - /* if list doesn't exist yet, create it and do - an atomic add which will fail if someone else already added it */ - if ($m->getResultCode() == Memcached::RES_NOTFOUND) { - $ips = array($_SERVER['REMOTE_ADDR']); - $m->add('ip_block', $ips); - /* otherwise, add IP to the list and store via compare-and-swap - with the token, which will fail if someone else updated the list */ - } else { - $ips[] = $_SERVER['REMOTE_ADDR']; - $m->cas($cas, 'ip_block', $ips); - } -} while ($m->getResultCode() != Memcached::RES_SUCCESS); - -?> -]]> - - - - - - - &reftitle.seealso; - - - Memcached::casByKey - - - - - - diff --git a/reference/memcached/memcached/casbykey.xml b/reference/memcached/memcached/casbykey.xml deleted file mode 100644 index 1b192d27a090..000000000000 --- a/reference/memcached/memcached/casbykey.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - Memcached::casByKey - Compare and swap an item on a specific server - - - - &reftitle.description; - - public boolMemcached::casByKey - stringintfloatcas_token - stringserver_key - stringkey - mixedvalue - intexpiration0 - - - Memcached::casByKey is functionally equivalent to - Memcached::cas, except that the free-form - server_key can be used to map the - key to a specific server. This is useful if you need - to keep a bunch of related keys on a certain server. - - - - - &reftitle.parameters; - - - - cas_token - - - Unique value associated with the existing item. Generated by memcache. - - - - - server_key - - - &memcached.parameter.server_key; - - - - - key - - - &memcached.parameter.key; - - - - - value - - - &memcached.parameter.value; - - - - - expiration - - - &memcached.parameter.expiration; - - - - - - - - - &reftitle.returnvalues; - - &return.success; - The Memcached::getResultCode will return - Memcached::RES_DATA_EXISTS if the item you are trying - to store has been modified since you last fetched it. - - - - - &reftitle.seealso; - - - Memcached::cas - - - - - - diff --git a/reference/memcached/memcached/construct.xml b/reference/memcached/memcached/construct.xml deleted file mode 100644 index 9bb6dfefafe7..000000000000 --- a/reference/memcached/memcached/construct.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - Memcached::__construct - Create a Memcached instance - - - - &reftitle.description; - - public Memcached::__construct - stringnullpersistent_id&null; - callablenullcallback&null; - stringnullconnection_str&null; - - - Creates a Memcached instance representing the connection to the memcache - servers. - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - persistent_id - - - By default the Memcached instances are destroyed at the end of the - request. To create an instance that persists between requests, use - persistent_id to specify a unique ID for the - instance. All instances created with the same - persistent_id will share the same connection. - - - - - callback - - - voidcallback - Memcachedmemcached - stringnullpersistent_id - - - The callback parameter is called when the - connection is established. It should be a valid PHP callable - that receive the Memcached object as its first - parameter, and persistent_id as its second. - - - - - connection_str - - - This parameter is used to pass additional connection options to - the memcache servers, such as a server weight in a cluster. - - - - - - - - - &reftitle.examples; - - - Creating a Memcached object - - -]]> - - - - - - - diff --git a/reference/memcached/memcached/decrement.xml b/reference/memcached/memcached/decrement.xml deleted file mode 100644 index 8f0e0ab038c8..000000000000 --- a/reference/memcached/memcached/decrement.xml +++ /dev/null @@ -1,146 +0,0 @@ - - - - - Memcached::decrement - Decrement numeric item's value - - - - &reftitle.description; - - public intfalseMemcached::decrement - stringkey - intoffset1 - intinitial_value0 - intexpiry0 - - - Memcached::decrement decrements a numeric item's value - by the specified offset. If the item's value is not - numeric, an error will result. If the operation would - decrease the value below 0, the new value will be 0. - Memcached::decrement will set the item to the - initial_value parameter if the key doesn't exist. - - - - - &reftitle.parameters; - - - - key - - - The key of the item to decrement. - - - - - offset - - - The amount by which to decrement the item's value. - - - - - initial_value - - - The value to set the item to if it doesn't currently exist. - - - - - expiry - - - The expiry time to set on the item. - - - - - - - - - &reftitle.returnvalues; - - Returns item's new value on success&return.falseforfailure;. - - - - - &reftitle.examples; - - - <function>Memcached::decrement</function> example - -addServer('localhost', 11211); - -$m->set('counter', 5); -$n = $m->decrement('counter'); -var_dump($n); - -$n = $m->decrement('counter', 10); -var_dump($n); - -var_dump($m->get('counter')); - -$m->set('counter', 'abc'); -$n = $m->increment('counter'); -// ^ will fail due to item value not being numeric -var_dump($n); -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - - Memcached::increment - Memcached::incrementByKey - Memcached::decrementByKey - - - - - - diff --git a/reference/memcached/memcached/decrementbykey.xml b/reference/memcached/memcached/decrementbykey.xml deleted file mode 100644 index b4de2b90b064..000000000000 --- a/reference/memcached/memcached/decrementbykey.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - Memcached::decrementByKey - Decrement numeric item's value, stored on a specific server - - - - &reftitle.description; - - public intfalseMemcached::decrementByKey - stringserver_key - stringkey - intoffset1 - intinitial_value0 - intexpiry0 - - - Memcached::decrementByKey decrements a numeric item's - value by the specified offset. If the item's value - is not numeric, an error will result. If the operation - would decrease the value below 0, the new value will be 0. - Memcached::decrementByKey will set the item to the - initial_value parameter if the key doesn't exist. - - - - - &reftitle.parameters; - - - - server_key - - - &memcached.parameter.server_key; - - - - - key - - - The key of the item to decrement. - - - - - offset - - - The amount by which to decrement the item's value. - - - - - initial_value - - - The value to set the item to if it doesn't currently exist. - - - - - expiry - - - The expiry time to set on the item. - - - - - - - - - &reftitle.returnvalues; - - Returns item's new value on success&return.falseforfailure;. - - - - - &reftitle.seealso; - - - Memcached::decrement - Memcached::increment - Memcached::incrementByKey - - - - - - diff --git a/reference/memcached/memcached/delete.xml b/reference/memcached/memcached/delete.xml deleted file mode 100644 index c2b0baa8e83e..000000000000 --- a/reference/memcached/memcached/delete.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - Memcached::delete - Delete an item - - - - &reftitle.description; - - public boolMemcached::delete - stringkey - inttime0 - - - Delete the key from the server. - - - - - &reftitle.parameters; - - - - key - - - The key to be deleted. - - - - - time - - - The amount of time the server will wait to delete the item. - - &memcached.note.delete-time; - - - - - - - - &reftitle.returnvalues; - - &return.success; - The Memcached::getResultCode will return - Memcached::RES_NOTFOUND if the key does not exist. - - - - - &reftitle.examples; - - - <function>Memcached::delete</function> example - -addServer('localhost', 11211); - -$m->delete('key1'); -?> -]]> - - - - - - - &reftitle.seealso; - - - Memcached::deleteByKey - Memcached::deleteMulti - - - - - - diff --git a/reference/memcached/memcached/deletebykey.xml b/reference/memcached/memcached/deletebykey.xml deleted file mode 100644 index c987e525b3d2..000000000000 --- a/reference/memcached/memcached/deletebykey.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - Memcached::deleteByKey - Delete an item from a specific server - - - - &reftitle.description; - - public boolMemcached::deleteByKey - stringserver_key - stringkey - inttime0 - - - Memcached::deleteByKey is functionally equivalent to - Memcached::delete, except that the free-form - server_key can be used to map the - key to a specific server. - - - - - &reftitle.parameters; - - - - server_key - - - &memcached.parameter.server_key; - - - - - key - - - The key to be deleted. - - - - - time - - - The amount of time the server will wait to delete the item. - - &memcached.note.delete-time; - - - - - - - - &reftitle.returnvalues; - - &return.success; - The Memcached::getResultCode will return - Memcached::RES_NOTFOUND if the key does not exist. - - - - - &reftitle.seealso; - - - Memcached::delete - Memcached::deleteMulti - Memcached::deleteMultiByKey - - - - - - diff --git a/reference/memcached/memcached/deletemulti.xml b/reference/memcached/memcached/deletemulti.xml deleted file mode 100644 index ef8b8bbe4626..000000000000 --- a/reference/memcached/memcached/deletemulti.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - Memcached::deleteMulti - Delete multiple items - - - - &reftitle.description; - - public arrayMemcached::deleteMulti - arraykeys - inttime0 - - - Delete the array of keys from the server. - - - - - &reftitle.parameters; - - - - keys - - - The keys to be deleted. - - - - - time - - - The amount of time the server will wait to delete the items. - - &memcached.note.delete-time; - - - - - - - - &reftitle.returnvalues; - &memcached.result.delete-multi; - - - - &reftitle.seealso; - - - Memcached::delete - Memcached::deleteByKey - Memcached::deleteMultiByKey - - - - - - diff --git a/reference/memcached/memcached/deletemultibykey.xml b/reference/memcached/memcached/deletemultibykey.xml deleted file mode 100644 index 9b489cf852ef..000000000000 --- a/reference/memcached/memcached/deletemultibykey.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - Memcached::deleteMultiByKey - Delete multiple items from a specific server - - - - &reftitle.description; - - public arrayMemcached::deleteMultiByKey - stringserver_key - arraykeys - inttime0 - - - Memcached::deleteMultiByKey is functionally equivalent to - Memcached::deleteMulti, except that the free-form - server_key can be used to map the - keys to a specific server. - - - - - - &reftitle.parameters; - - - - server_key - - - &memcached.parameter.server_key; - - - - - keys - - - The keys to be deleted. - - - - - time - - - The amount of time the server will wait to delete the items. - - &memcached.note.delete-time; - - - - - - - - &reftitle.returnvalues; - &memcached.result.delete-multi; - - - - &reftitle.seealso; - - - Memcached::delete - Memcached::deleteByKey - Memcached::deleteMulti - - - - - - diff --git a/reference/memcached/memcached/fetch.xml b/reference/memcached/memcached/fetch.xml deleted file mode 100644 index 04bf6411ffac..000000000000 --- a/reference/memcached/memcached/fetch.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - Memcached::fetch - Fetch the next result - - - - &reftitle.description; - - public arrayfalseMemcached::fetch - - - - Memcached::fetch retrieves the next result from the - last request. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the next result or &false; otherwise. - The Memcached::getResultCode will return - Memcached::RES_END if result set is exhausted. - - - - - &reftitle.examples; - - - <function>Memcached::fetch</function> example - -addServer('localhost', 11211); - -$m->set('int', 99); -$m->set('string', 'a simple string'); -$m->set('array', array(11, 12)); - -$m->getDelayed(array('int', 'array'), true); -while ($result = $m->fetch()) { - var_dump($result); -} -?> -]]> - - &example.outputs.similar; - - - string(3) "int" - ["value"]=> - int(99) - ["cas"]=> - float(2363) -} -array(3) { - ["key"]=> - string(5) "array" - ["value"]=> - array(2) { - [0]=> - int(11) - [1]=> - int(12) - } - ["cas"]=> - float(2365) -} -]]> - - - - - - - &reftitle.seealso; - - - Memcached::fetchAll - Memcached::getDelayed - - - - - - diff --git a/reference/memcached/memcached/fetchall.xml b/reference/memcached/memcached/fetchall.xml deleted file mode 100644 index c579694cd249..000000000000 --- a/reference/memcached/memcached/fetchall.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - Memcached::fetchAll - Fetch all the remaining results - - - - &reftitle.description; - - public arrayfalseMemcached::fetchAll - - - - Memcached::fetchAll retrieves all the remaining - results from the last request. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the results&return.falseforfailure;. - &memcached.result.getresultcode; - - - - - &reftitle.examples; - - - <function>Memcached::getDelayed</function> example - -addServer('localhost', 11211); - -$m->set('int', 99); -$m->set('string', 'a simple string'); -$m->set('array', array(11, 12)); - -$m->getDelayed(array('int', 'array'), true); -var_dump($m->fetchAll()); -?> -]]> - - &example.outputs; - - - array(3) { - ["key"]=> - string(3) "int" - ["value"]=> - int(99) - ["cas"]=> - float(2363) - } - [1]=> - array(3) { - ["key"]=> - string(5) "array" - ["value"]=> - array(2) { - [0]=> - int(11) - [1]=> - int(12) - } - ["cas"]=> - float(2365) - } -} -]]> - - - - - - - &reftitle.seealso; - - - Memcached::fetch - Memcached::getDelayed - - - - - - diff --git a/reference/memcached/memcached/flush.xml b/reference/memcached/memcached/flush.xml deleted file mode 100644 index 85afd18b5418..000000000000 --- a/reference/memcached/memcached/flush.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - Memcached::flush - Invalidate all items in the cache - - - - &reftitle.description; - - public boolMemcached::flush - intdelay0 - - - Memcached::flush invalidates all existing cache items - immediately (by default) or after the delay - specified. After invalidation none of the items will be returned in - response to a retrieval command (unless it's stored again under the same - key after Memcached::flush has invalidated the items). - The flush does not actually free all the memory taken up by the existing - items; that will happen gradually as new items are stored. - - - - - &reftitle.parameters; - - - - delay - - - Number of seconds to wait before invalidating the items. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - &memcached.result.getresultcode; - - - - - &reftitle.examples; - - - <function>Memcached::flush</function> example - -addServer('localhost', 11211); - -/* flush all items in 10 seconds */ -$m->flush(10); -?> -]]> - - - - - - - diff --git a/reference/memcached/memcached/get.xml b/reference/memcached/memcached/get.xml deleted file mode 100644 index 493bfb549142..000000000000 --- a/reference/memcached/memcached/get.xml +++ /dev/null @@ -1,175 +0,0 @@ - - - - - Memcached::get - Retrieve an item - - - - &reftitle.description; - - public mixedMemcached::get - stringkey - callablenullcache_cb&null; - intget_flags0 - - - Memcached::get returns the item that was previously - stored under the key. If the item is found and - the get_flags is given Memcached::GET_EXTENDED, - it will also return the CAS token value for the item. See - Memcached::cas for how to use CAS tokens. - Read-through caching callback may be - specified via cache_cb parameter. - - - - - - - &reftitle.parameters; - - - - key - - - The key of the item to retrieve. - - - - - cache_cb - - - Read-through caching callback or &null;. - - - - - get_flags - - - Flags to control the returned result. When Memcached::GET_EXTENDED - is given, the function will also return the CAS token. - - - - - - - - - &reftitle.returnvalues; - - Returns the value stored in the cache or &false; otherwise. - If the get_flags is set to Memcached::GET_EXTENDED, - an array containing the value and the CAS token is returned instead of only the value. - The Memcached::getResultCode will return - Memcached::RES_NOTFOUND if the key does not exist. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL memcached 3.0.0 - - The cas_token parameter was removed. - Instead get_flags was added and when it is given the value of Memcached::GET_EXTENDED it will ensure the CAS token to be fetched. - - - - - - - - - &reftitle.examples; - - - <function>Memcached::get</function> example #1 - -addServer('localhost', 11211); - -$m->set('foo', 100); -var_dump($m->get('foo')); -?> -]]> - - &example.outputs; - - - - - - <function>Memcached::get</function> example #2 - -addServer('localhost', 11211); - -if (!($ip = $m->get('ip_block'))) { - if ($m->getResultCode() == Memcached::RES_NOTFOUND) { - $ip = array(); - $m->set('ip_block', $ip); - } else { - /* log error */ - /* ... */ - } -} -?> -]]> - - - - - - - &reftitle.seealso; - - - Memcached::getByKey - Memcached::getMulti - Memcached::getDelayed - - - - - - diff --git a/reference/memcached/memcached/getallkeys.xml b/reference/memcached/memcached/getallkeys.xml deleted file mode 100644 index c69666ff3e73..000000000000 --- a/reference/memcached/memcached/getallkeys.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - Memcached::getAllKeys - Gets the keys stored on all the servers - - - - &reftitle.description; - - public arrayfalseMemcached::getAllKeys - - - - Memcached::getAllKeys queries each memcache server - and retrieves an array of all keys stored on them at that point in time. - This is not an atomic operation, so it isn't a truly consistent snapshot of - the keys at point in time. As memcache doesn't guarantee to return all keys - you also cannot assume that all keys have been returned. - - - - This method is intended for debugging purposes and should not be used at scale! - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the keys stored on all the servers on success&return.falseforfailure;. - - - - - diff --git a/reference/memcached/memcached/getbykey.xml b/reference/memcached/memcached/getbykey.xml deleted file mode 100644 index 3138e8f39611..000000000000 --- a/reference/memcached/memcached/getbykey.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - Memcached::getByKey - Retrieve an item from a specific server - - - - &reftitle.description; - - public mixedMemcached::getByKey - stringserver_key - stringkey - callablenullcache_cb&null; - intget_flags0 - - - Memcached::getByKey is functionally equivalent to - Memcached::get, except that the free-form - server_key can be used to map the - key to a specific server. - - - - - &reftitle.parameters; - - - - server_key - - - &memcached.parameter.server_key; - - - - - key - - - The key of the item to fetch. - - - - - cache_cb - - - Read-through caching callback or &null; - - - - - get_flags - - - Flags to control the returned result. When value of Memcached::GET_EXTENDED - is given will return the CAS token. - - - - - - - - - &reftitle.returnvalues; - - Returns the value stored in the cache or &false; otherwise. - The Memcached::getResultCode will return - Memcached::RES_NOTFOUND if the key does not exist. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL memcached 3.0.0 - - The cas_token parameter was removed. - Instead get_flags was added and when it is given the value of Memcached::GET_EXTENDED it will ensure the CAS token to be fetched. - - - - - - - - - &reftitle.seealso; - - - Memcached::get - Memcached::getMulti - Memcached::getDelayed - - - - - - diff --git a/reference/memcached/memcached/getdelayed.xml b/reference/memcached/memcached/getdelayed.xml deleted file mode 100644 index 2c0ef5889c50..000000000000 --- a/reference/memcached/memcached/getdelayed.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - Memcached::getDelayed - Request multiple items - - - - &reftitle.description; - - public boolMemcached::getDelayed - arraykeys - boolwith_cas&false; - callablenullvalue_cb&null; - - - Memcached::getDelayed issues a request to memcache for - multiple items the keys of which are specified in the - keys array. The method does not wait for response - and returns right away. When you are ready to collect the items, call - either Memcached::fetch or - Memcached::fetchAll. If with_cas - is true, the CAS token values will also be requested. - - - Instead of fetching the results explicitly, you can specify a result callback via - value_cb parameter. - - - - - &reftitle.parameters; - - - - keys - - - Array of keys to request. - - - - - with_cas - - - Whether to request CAS token values also. - - - - - value_cb - - - The result callback or &null;. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - &memcached.result.getresultcode; - - - - - &reftitle.examples; - - - <function>Memcached::getDelayed</function> example - -addServer('localhost', 11211); - -$m->set('int', 99); -$m->set('string', 'a simple string'); -$m->set('array', array(11, 12)); - -$m->getDelayed(array('int', 'array'), true); -var_dump($m->fetchAll()); -?> -]]> - - &example.outputs; - - - array(3) { - ["key"]=> - string(3) "int" - ["value"]=> - int(99) - ["cas"]=> - float(2363) - } - [1]=> - array(3) { - ["key"]=> - string(5) "array" - ["value"]=> - array(2) { - [0]=> - int(11) - [1]=> - int(12) - } - ["cas"]=> - float(2365) - } -} -]]> - - - - - - - &reftitle.seealso; - - - Memcached::getDelayedByKey - Memcached::fetch - Memcached::fetchAll - - - - - - diff --git a/reference/memcached/memcached/getdelayedbykey.xml b/reference/memcached/memcached/getdelayedbykey.xml deleted file mode 100644 index 92f4c76a709b..000000000000 --- a/reference/memcached/memcached/getdelayedbykey.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - Memcached::getDelayedByKey - Request multiple items from a specific server - - - - &reftitle.description; - - public boolMemcached::getDelayedByKey - stringserver_key - arraykeys - boolwith_cas&false; - callablenullvalue_cb&null; - - - Memcached::getDelayedByKey is functionally equivalent to - Memcached::getDelayed, except that the free-form - server_key can be used to map the - keys to a specific server. - - - - - &reftitle.parameters; - - - - server_key - - - &memcached.parameter.server_key; - - - - - keys - - - Array of keys to request. - - - - - with_cas - - - Whether to request CAS token values also. - - - - - value_cb - - - The result callback or &null;. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - &memcached.result.getresultcode; - - - - - &reftitle.seealso; - - - Memcached::getDelayed - Memcached::fetch - Memcached::fetchAll - - - - - - diff --git a/reference/memcached/memcached/getmulti.xml b/reference/memcached/memcached/getmulti.xml deleted file mode 100644 index 169c59447ab8..000000000000 --- a/reference/memcached/memcached/getmulti.xml +++ /dev/null @@ -1,299 +0,0 @@ - - - - - Memcached::getMulti - Retrieve multiple items - - - - &reftitle.description; - - public arrayfalseMemcached::getMulti - arraykeys - intget_flags0 - - - Memcached::getMulti is similar to - Memcached::get, but instead of a single key - item, it retrieves multiple items the keys of which are specified in the - keys array. - - - Before v3.0 a second argument cas_tokens was in use. - It was filled with the CAS token values for the found items. - The cas_tokens parameter was removed in v3.0 of the extension. - It was replaced with a new flag Memcached::GET_EXTENDED - that needs is to be used as the value for get_flags. - - - - - The get_flags parameter can be used to specify - additional options for Memcached::getMulti. - Memcached::GET_PRESERVE_ORDER ensures that the - keys are returned in the same order as they were requested in. - Memcached::GET_EXTENDED ensures that the - CAS tokens will be fetched too. - - - - - &reftitle.parameters; - - - - keys - - - Array of keys to retrieve. - - - - - get_flags - - - The flags for the get operation. - - - - - - - - - &reftitle.returnvalues; - - Returns the array of found items&return.falseforfailure;. - &memcached.result.getresultcode; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL memcached 3.0.0 - - The cas_tokens parameter was removed. - The Memcached::GET_EXTENDED was added and when passed as a flag it ensures the CAS tokens to be fetched. - - - - - - - - - &reftitle.examples; - - - <function>Memcached::getMulti</function> example for Memcached v3 - -addServer('localhost', 11211); - -$items = array( - 'key1' => 'value1', - 'key2' => 'value2', - 'key3' => 'value3' -); -$m->setMulti($items); -$result = $m->getMulti(array('key1', 'key3', 'badkey')); -var_dump($result); -?> -]]> - - &example.outputs.similar; - - - string(6) "value1" - ["key3"]=> - string(6) "value3" -} -]]> - - - - - - - <function>Memcached::getMulti</function> example for Memcached v1 and v2 - -addServer('localhost', 11211); - -$items = array( - 'key1' => 'value1', - 'key2' => 'value2', - 'key3' => 'value3' -); -$m->setMulti($items); -$result = $m->getMulti(array('key1', 'key3', 'badkey'), $cas); -var_dump($result, $cas); -?> -]]> - - &example.outputs.similar; - - - string(6) "value1" - ["key3"]=> - string(6) "value3" -} -array(2) { - ["key1"]=> - float(2360) - ["key3"]=> - float(2362) -} -]]> - - - - - - - <constant>Memcached::GET_PRESERVE_ORDER</constant> example for Memcached v3 - -addServer('localhost', 11211); - -$data = array( - 'foo' => 'foo-data', - 'bar' => 'bar-data', - 'baz' => 'baz-data', - 'lol' => 'lol-data', - 'kek' => 'kek-data', -); - -$m->setMulti($data, 3600); - -$keys = array_keys($data); -$keys[] = 'zoo'; -$got = $m->getMulti($keys, Memcached::GET_PRESERVE_ORDER); - -foreach ($got as $k => $v) { - echo "$k $v\n"; -} -?> -]]> - - &example.outputs.similar; - - - - - - - - - <constant>Memcached::GET_PRESERVE_ORDER</constant> example for Memcached v1 and v2 - -addServer('localhost', 11211); - -$data = array( - 'foo' => 'foo-data', - 'bar' => 'bar-data', - 'baz' => 'baz-data', - 'lol' => 'lol-data', - 'kek' => 'kek-data', -); - -$m->setMulti($data, 3600); - -$null = null; -$keys = array_keys($data); -$keys[] = 'zoo'; -$got = $m->getMulti($keys, $null, Memcached::GET_PRESERVE_ORDER); - -foreach ($got as $k => $v) { - echo "$k $v\n"; -} -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Memcached::getMultiByKey - Memcached::get - Memcached::getDelayed - - - - - - diff --git a/reference/memcached/memcached/getmultibykey.xml b/reference/memcached/memcached/getmultibykey.xml deleted file mode 100644 index 5196d24dd9cf..000000000000 --- a/reference/memcached/memcached/getmultibykey.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - Memcached::getMultiByKey - Retrieve multiple items from a specific server - - - - &reftitle.description; - - public arrayfalseMemcached::getMultiByKey - stringserver_key - arraykeys - intget_flags0 - - - Memcached::getMultiByKey is functionally equivalent to - Memcached::getMulti, except that the free-form - server_key can be used to map the - keys to a specific server. - - - - - &reftitle.parameters; - - - - server_key - - - &memcached.parameter.server_key; - - - - - keys - - - Array of keys to retrieve. - - - - - get_flags - - - The flags for the get operation. - - - - - - - - - &reftitle.returnvalues; - - Returns the array of found items&return.falseforfailure;. - &memcached.result.getresultcode; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL memcached 3.0.0 - - The cas_tokens parameter was removed. - The Memcached::GET_EXTENDED was added and when passed as a flag it ensures the CAS tokens to be fetched. - - - - - - - - - &reftitle.seealso; - - - Memcached::getMulti - Memcached::get - Memcached::getDelayed - - - - - - diff --git a/reference/memcached/memcached/getoption.xml b/reference/memcached/memcached/getoption.xml deleted file mode 100644 index a2b146faad6a..000000000000 --- a/reference/memcached/memcached/getoption.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - Memcached::getOption - Retrieve a Memcached option value - - - - &reftitle.description; - - public mixedMemcached::getOption - intoption - - - This method returns the value of a Memcached option. Some options - correspond to the ones defined by libmemcached, and some are specific to - the extension. See Memcached - Constants for more information. - - - - - &reftitle.parameters; - - - - option - - - One of the Memcached::OPT_* constants. - - - - - - - - - &reftitle.returnvalues; - - Returns the value of the requested option, or &false; on - error. - - - - - &reftitle.examples; - - - Retrieving Memcached options - -getOption(Memcached::OPT_COMPRESSION)); -var_dump($m->getOption(Memcached::OPT_POLL_TIMEOUT)); -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Memcached::getOption - Memcached::setOption - Memcached Constants - - - - - - diff --git a/reference/memcached/memcached/getresultcode.xml b/reference/memcached/memcached/getresultcode.xml deleted file mode 100644 index a94bed4236c4..000000000000 --- a/reference/memcached/memcached/getresultcode.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - Memcached::getResultCode - Return the result code of the last operation - - - - &reftitle.description; - - public intMemcached::getResultCode - - - - Memcached::getResultCode returns one of the - Memcached::RES_* constants that is the result of the - last executed Memcached method. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Result code of the last Memcached operation. - - - - - &reftitle.examples; - - - <function>Memcached::getResultCode</function> example - -addServer('localhost', 11211); - -$m->add('foo', 'bar'); -if ($m->getResultCode() == Memcached::RES_NOTSTORED) { - /* ... */ -} -?> -]]> - - - - - - - diff --git a/reference/memcached/memcached/getresultmessage.xml b/reference/memcached/memcached/getresultmessage.xml deleted file mode 100644 index 4d8c5dd6c612..000000000000 --- a/reference/memcached/memcached/getresultmessage.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - Memcached::getResultMessage - Return the message describing the result of the last operation - - - - &reftitle.description; - - public stringMemcached::getResultMessage - - - - Memcached::getResultMessage returns a string that - describes the result code of the last executed Memcached method. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Message describing the result of the last Memcached operation. - - - - - &reftitle.examples; - - - <function>Memcached::getResultMessage</function> example - -addServer('localhost', 11211); - -$m->add('foo', 'bar'); // first time should succeed -$m->add('foo', 'bar'); -echo $m->getResultMessage(),"\n"; -?> -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/memcached/memcached/getserverbykey.xml b/reference/memcached/memcached/getserverbykey.xml deleted file mode 100644 index b1f784a8fdb9..000000000000 --- a/reference/memcached/memcached/getserverbykey.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - Memcached::getServerByKey - Map a key to a server - - - - &reftitle.description; - - public arrayfalseMemcached::getServerByKey - stringserver_key - - - Memcached::getServerByKey returns the server that - would be selected by a particular server_key in all - the Memcached::*ByKey operations. - - - - - &reftitle.parameters; - - - - server_key - - - &memcached.parameter.server_key; - - - - - - - - - &reftitle.returnvalues; - - Returns an array containing three keys of host, - port, and weight on success&return.falseforfailure;. - &memcached.result.getresultcode; - - - - - &reftitle.examples; - - - <function>Memcached::getServerByKey</function> example - -addServers(array( - array('mem1.domain.com', 11211, 40), - array('mem2.domain.com', 11211, 40), - array('mem3.domain.com', 11211, 20), -)); - -$m->setOption(Memcached::OPT_LIBKETAMA_COMPATIBLE, true); - -var_dump($m->getServerByKey('user')); -var_dump($m->getServerByKey('log')); -var_dump($m->getServerByKey('ip')); -?> -]]> - - &example.outputs.similar; - - - string(15) "mem3.domain.com" - ["port"]=> - int(11211) - ["weight"]=> - int(20) -} -array(3) { - ["host"]=> - string(15) "mem2.domain.com" - ["port"]=> - int(11211) - ["weight"]=> - int(40) -} -array(3) { - ["host"]=> - string(15) "mem2.domain.com" - ["port"]=> - int(11211) - ["weight"]=> - int(40) -} -]]> - - - - - - - diff --git a/reference/memcached/memcached/getserverlist.xml b/reference/memcached/memcached/getserverlist.xml deleted file mode 100644 index ca7e053a1af0..000000000000 --- a/reference/memcached/memcached/getserverlist.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - Memcached::getServerList - Get the list of the servers in the pool - - - - &reftitle.description; - - public arrayMemcached::getServerList - - - - Memcached::getServerList returns the list of all - servers that are in its server pool. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The list of all servers in the server pool. - - - - - &reftitle.examples; - - - <function>Memcached::getServerList</function> example - -addServers(array( - array('mem1.domain.com', 11211, 20), - array('mem2.domain.com', 11311, 80), -)); -var_dump($m->getServerList()); -?> -]]> - - &example.outputs; - - - array(3) { - ["host"]=> - string(15) "mem1.domain.com" - ["port"]=> - int(11211) - ["weight"]=> - int(20) - } - [1]=> - array(3) { - ["host"]=> - string(15) "mem2.domain.com" - ["port"]=> - int(11311) - ["weight"]=> - int(80) - } -} -]]> - - - - - - - diff --git a/reference/memcached/memcached/getstats.xml b/reference/memcached/memcached/getstats.xml deleted file mode 100644 index b42ade783e87..000000000000 --- a/reference/memcached/memcached/getstats.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - Memcached::getStats - Get server pool statistics - - - - &reftitle.description; - - public arrayfalseMemcached::getStats - stringnulltype&null; - - - Memcached::getStats returns an array containing the - state of all available memcache servers. See - memcache protocol - specification for details on these statistics. - - - - - &reftitle.parameters; - - - - type - - - The type of statistics to fetch. - - - - - - - - - &reftitle.returnvalues; - - Array of server statistics, one entry per server, &return.falseforfailure;. - - - - - &reftitle.examples; - - - <function>Memcached::getStats</function> example - -addServer('localhost', 11211); - -print_r($m->getStats()); -?> -]]> - - &example.outputs.similar; - - Array - ( - [pid] => 4933 - [uptime] => 786123 - [threads] => 1 - [time] => 1233868010 - [pointer_size] => 32 - [rusage_user_seconds] => 0 - [rusage_user_microseconds] => 140000 - [rusage_system_seconds] => 23 - [rusage_system_microseconds] => 210000 - [curr_items] => 145 - [total_items] => 2374 - [limit_maxbytes] => 67108864 - [curr_connections] => 2 - [total_connections] => 151 - [connection_structures] => 3 - [bytes] => 20345 - [cmd_get] => 213343 - [cmd_set] => 2381 - [get_hits] => 204223 - [get_misses] => 9120 - [evictions] => 0 - [bytes_read] => 9092476 - [bytes_written] => 15420512 - [version] => 1.2.6 - ) - -) -]]> - - - - - - - diff --git a/reference/memcached/memcached/getversion.xml b/reference/memcached/memcached/getversion.xml deleted file mode 100644 index eb0e79fbeb83..000000000000 --- a/reference/memcached/memcached/getversion.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - Memcached::getVersion - Get server pool version info - - - - &reftitle.description; - - public arrayfalseMemcached::getVersion - - - - Memcached::getVersion returns an array containing the - version info for all available memcache servers. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Array of server versions, one entry per server. - - - - - &reftitle.examples; - - - <function>Memcached::getVersion</function> example - -addServer('localhost', 11211); - -print_r($m->getVersion()); -?> -]]> - - &example.outputs.similar; - - 1.2.6 -) -]]> - - - - - - - diff --git a/reference/memcached/memcached/increment.xml b/reference/memcached/memcached/increment.xml deleted file mode 100644 index 5625689521b5..000000000000 --- a/reference/memcached/memcached/increment.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - Memcached::increment - Increment numeric item's value - - - - &reftitle.description; - - public intfalseMemcached::increment - stringkey - intoffset1 - intinitial_value0 - intexpiry0 - - - Memcached::increment increments a numeric item's value - by the specified offset. If the item's value is not - numeric, an error will result. - Memcached::increment will set the item to the - initial_value parameter if the key doesn't exist. - - - - - &reftitle.parameters; - - - - key - - - The key of the item to increment. - - - - - offset - - - The amount by which to increment the item's value. - - - - - initial_value - - - The value to set the item to if it doesn't currently exist. - - - - - expiry - - - The expiry time to set on the item. - - - - - - - - - &reftitle.returnvalues; - - Returns new item's value on success&return.falseforfailure;. - - - - - &reftitle.examples; - - - <function>Memcached::increment</function> example - -addServer('localhost', 11211); - -$m->set('counter', 0); -$m->increment('counter'); -$n = $m->increment('counter', 10); -var_dump($n); - -$m->set('counter', 'abc'); -$n = $m->increment('counter'); -// ^ will fail due to item value not being numeric -var_dump($n); -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - - Memcached::decrement - Memcached::decrementByKey - Memcached::incrementByKey - - - - - - diff --git a/reference/memcached/memcached/incrementbykey.xml b/reference/memcached/memcached/incrementbykey.xml deleted file mode 100644 index 1e8cc8d7517c..000000000000 --- a/reference/memcached/memcached/incrementbykey.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - Memcached::incrementByKey - Increment numeric item's value, stored on a specific server - - - - &reftitle.description; - - public intfalseMemcached::incrementByKey - stringserver_key - stringkey - intoffset1 - intinitial_value0 - intexpiry0 - - - Memcached::incrementByKey increments a numeric item's value - by the specified offset. If the item's value is not - numeric, an error will result. - Memcached::incrementByKey will set the item to the - initial_value parameter if the key doesn't exist. - - - - - &reftitle.parameters; - - - - server_key - - - &memcached.parameter.server_key; - - - - - key - - - The key of the item to increment. - - - - - offset - - - The amount by which to increment the item's value. - - - - - initial_value - - - The value to set the item to if it doesn't currently exist. - - - - - expiry - - - The expiry time to set on the item. - - - - - - - - - &reftitle.returnvalues; - - Returns new item's value on success&return.falseforfailure;. - - - - - &reftitle.seealso; - - - Memcached::decrement - Memcached::decrementByKey - Memcached::increment - - - - - - diff --git a/reference/memcached/memcached/ispersistent.xml b/reference/memcached/memcached/ispersistent.xml deleted file mode 100644 index 52a183663a68..000000000000 --- a/reference/memcached/memcached/ispersistent.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - Memcached::isPersistent - Check if a persistent connection to memcache is being used - - - - &reftitle.description; - - public boolMemcached::isPersistent - - - - Memcached::isPersistent checks if the connections to - the memcache servers are persistent connections. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; if Memcache instance uses a persistent connection, &false; otherwise. - - - - - &reftitle.seealso; - - - Memcached::isPristine - - - - - - diff --git a/reference/memcached/memcached/ispristine.xml b/reference/memcached/memcached/ispristine.xml deleted file mode 100644 index 5052afaef167..000000000000 --- a/reference/memcached/memcached/ispristine.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - Memcached::isPristine - Check if the instance was recently created - - - - &reftitle.description; - - public boolMemcached::isPristine - - - - Memcached::isPristine checks if the Memcache instance - was recently created. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; if instance is recently created, &false; otherwise. - - - - - &reftitle.seealso; - - - Memcached::isPersistent - - - - - - diff --git a/reference/memcached/memcached/prepend.xml b/reference/memcached/memcached/prepend.xml deleted file mode 100644 index 25a204bd4252..000000000000 --- a/reference/memcached/memcached/prepend.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - Memcached::prepend - Prepend data to an existing item - - - - &reftitle.description; - - public boolnullMemcached::prepend - stringkey - stringvalue - - - Memcached::prepend prepends the given - value string to the value of an existing item. The - reason that value is forced to be a string is - that prepending mixed types is not well-defined. - - - - If the Memcached::OPT_COMPRESSION is enabled, the - operation will fail and a warning will be issued, because prepending - compressed data to a value that is potentially already compressed is not - possible. - - - - - - &reftitle.parameters; - - - - key - - - The key of the item to prepend the data to. - - - - - value - - - The string to prepend. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - Returns &null; when compression is on. - - - - - &reftitle.errors; - - Returns &null; and raises an E_WARNING when - compression is enabled. - - - - - &reftitle.examples; - - - <function>Memcached::prepend</function> example - -addServer('localhost', 11211); -$m->setOption(Memcached::OPT_COMPRESSION, false); - -$m->set('foo', 'abc'); -$m->prepend('foo', 'def'); -var_dump($m->get('foo')); -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - - Memcached::prependByKey - Memcached::append - - - - - - diff --git a/reference/memcached/memcached/prependbykey.xml b/reference/memcached/memcached/prependbykey.xml deleted file mode 100644 index c89f14a79b6d..000000000000 --- a/reference/memcached/memcached/prependbykey.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - Memcached::prependByKey - Prepend data to an existing item on a specific server - - - - &reftitle.description; - - public boolnullMemcached::prependByKey - stringserver_key - stringkey - stringvalue - - - Memcached::prependByKey is functionally equivalent to - Memcached::prepend, except that the free-form - server_key can be used to map the - key to a specific server. - - - - - &reftitle.parameters; - - - - server_key - - - &memcached.parameter.server_key; - - - - - key - - - The key of the item to prepend the data to. - - - - - value - - - The string to prepend. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - Returns &null; when compression is on. - - - - - &reftitle.errors; - - Returns &null; and raises an E_WARNING when - compression is enabled. - - - - - &reftitle.seealso; - - - Memcached::prepend - Memcached::append - - - - - - diff --git a/reference/memcached/memcached/quit.xml b/reference/memcached/memcached/quit.xml deleted file mode 100644 index ad3c3e51526c..000000000000 --- a/reference/memcached/memcached/quit.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - Memcached::quit - Close any open connections - - - - &reftitle.description; - - public boolMemcached::quit - - - - Memcached::quit closes any open connections to the - memcache servers. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/memcached/memcached/replace.xml b/reference/memcached/memcached/replace.xml deleted file mode 100644 index fdae37c0189f..000000000000 --- a/reference/memcached/memcached/replace.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - Memcached::replace - Replace the item under an existing key - - - - &reftitle.description; - - public boolMemcached::replace - stringkey - mixedvalue - intexpiration0 - - - Memcached::replace is similar to - Memcached::set, but the operation fails if the - key does not exist on the server. - - - - - &reftitle.parameters; - - - - key - - - &memcached.parameter.key; - - - - - value - - - &memcached.parameter.value; - - - - - expiration - - - &memcached.parameter.expiration; - - - - - - - - - &reftitle.returnvalues; - - &return.success; - The Memcached::getResultCode will return - Memcached::RES_NOTSTORED if the key does not exist. - - - - - &reftitle.seealso; - - - Memcached::replaceByKey - Memcached::set - Memcached::add - - - - - - diff --git a/reference/memcached/memcached/replacebykey.xml b/reference/memcached/memcached/replacebykey.xml deleted file mode 100644 index 589410783657..000000000000 --- a/reference/memcached/memcached/replacebykey.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - Memcached::replaceByKey - Replace the item under an existing key on a specific server - - - - &reftitle.description; - - public boolMemcached::replaceByKey - stringserver_key - stringkey - mixedvalue - intexpiration0 - - - Memcached::replaceByKey is functionally equivalent to - Memcached::replace, except that the free-form - server_key can be used to map the - key to a specific server. This is useful if you need - to keep a bunch of related keys on a certain server. - - - - - &reftitle.parameters; - - - - server_key - - - &memcached.parameter.server_key; - - - - - key - - - &memcached.parameter.key; - - - - - value - - - &memcached.parameter.value; - - - - - expiration - - - &memcached.parameter.expiration; - - - - - - - - - &reftitle.returnvalues; - - &return.success; - The Memcached::getResultCode will return - Memcached::RES_NOTSTORED if the key does not exist. - - - - - &reftitle.seealso; - - - Memcached::replace - Memcached::set - Memcached::add - - - - - - diff --git a/reference/memcached/memcached/resetserverlist.xml b/reference/memcached/memcached/resetserverlist.xml deleted file mode 100644 index 4c6a55a58647..000000000000 --- a/reference/memcached/memcached/resetserverlist.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - Memcached::resetServerList - Clears all servers from the server list - - - - &reftitle.description; - - public boolMemcached::resetServerList - - - - Memcached::resetserverlist removes all memcache - servers from the known server list, resetting it back to empty. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - Memcached::addServer - Memcached::addServers - - - - - - diff --git a/reference/memcached/memcached/set.xml b/reference/memcached/memcached/set.xml deleted file mode 100644 index 4e335ceb3e4e..000000000000 --- a/reference/memcached/memcached/set.xml +++ /dev/null @@ -1,146 +0,0 @@ - - - - - Memcached::set - Store an item - - - - &reftitle.description; - - public boolMemcached::set - stringkey - mixedvalue - intexpiration0 - - - Memcached::set stores the value - on a memcache server under the specified key. The - expiration parameter can be used to control when the - value is considered expired. - - - The value can be any valid PHP type except for resources, because those - cannot be represented in a serialized form. If the - Memcached::OPT_COMPRESSION option is turned on, the - serialized value will also be compressed before storage. - - - - - &reftitle.parameters; - - - - key - - - &memcached.parameter.key; - - - - - value - - - &memcached.parameter.value; - - - - - expiration - - - &memcached.parameter.expiration; - - - - - - - - - &reftitle.returnvalues; - - &return.success; - &memcached.result.getresultcode; - - - - - &reftitle.examples; - - - <function>Memcached::set</function> example - -addServer('localhost', 11211); - -$m->set('int', 99); -$m->set('string', 'a simple string'); -$m->set('array', array(11, 12)); -/* expire 'object' key in 5 minutes */ -$m->set('object', new stdClass, time() + 300); - - -var_dump($m->get('int')); -var_dump($m->get('string')); -var_dump($m->get('array')); -var_dump($m->get('object')); -?> -]]> - - &example.outputs.similar; - - - int(11) - [1]=> - int(12) -} -object(stdClass)#1 (0) { -} -]]> - - - - - - - &reftitle.seealso; - - - Memcached::setByKey - Memcached::add - Memcached::replace - - - - - - diff --git a/reference/memcached/memcached/setbykey.xml b/reference/memcached/memcached/setbykey.xml deleted file mode 100644 index 815f71bdd17f..000000000000 --- a/reference/memcached/memcached/setbykey.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - Memcached::setByKey - Store an item on a specific server - - - - &reftitle.description; - - public boolMemcached::setByKey - stringserver_key - stringkey - mixedvalue - intexpiration0 - - - Memcached::setByKey is functionally equivalent to - Memcached::set, except that the free-form - server_key can be used to map the - key to a specific server. This is useful if you need - to keep a bunch of related keys on a certain server. - - - - - &reftitle.parameters; - - - - server_key - - - &memcached.parameter.server_key; - - - - - key - - - &memcached.parameter.key; - - - - - value - - - &memcached.parameter.value; - - - - - expiration - - - &memcached.parameter.expiration; - - - - - - - - - &reftitle.returnvalues; - - &return.success; - &memcached.result.getresultcode; - - - - - &reftitle.examples; - - - <function>Memcached::setByKey</function> example - -addServer('localhost', 11211); - -/* keep IP blocks on a certain server */ -$m->setByKey('api-cache', 'block-ip:169.254.253.252', 1); -$m->setByKey('api-cache', 'block-ip:169.127.127.202', 1); -?> -]]> - - - - - - - &reftitle.seealso; - - - Memcached::set - - - - - - diff --git a/reference/memcached/memcached/setencodingkey.xml b/reference/memcached/memcached/setencodingkey.xml deleted file mode 100644 index 5d5ff3884931..000000000000 --- a/reference/memcached/memcached/setencodingkey.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - Memcached::setEncodingKey - Set AES encryption key for data in Memcached - - - - &reftitle.description; - - public boolMemcached::setEncodingKey - stringkey - - - This method sets the AES encryption/decryption key for data written to and read from Memcached. - - - - - &reftitle.parameters; - - - key - - - The AES key. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - Memcached::get - Memcached::add - Memcached::set - - - - - diff --git a/reference/memcached/memcached/setmulti.xml b/reference/memcached/memcached/setmulti.xml deleted file mode 100644 index 144afe825846..000000000000 --- a/reference/memcached/memcached/setmulti.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - Memcached::setMulti - Store multiple items - - - - &reftitle.description; - - public boolMemcached::setMulti - arrayitems - intexpiration0 - - - Memcached::setMulti is similar to - Memcached::set, but instead of a single key/value - item, it works on multiple items specified in - items. The expiration time - applies to all the items at once. - - - - - &reftitle.parameters; - - - - items - - - &memcached.parameter.items; - - - - - expiration - - - &memcached.parameter.expiration; - - - - - - - - - &reftitle.returnvalues; - - &return.success; - &memcached.result.getresultcode; - - - - - &reftitle.examples; - - - <function>Memcached::setMulti</function> example - -addServer('localhost', 11211); - -$items = array( - 'key1' => 'value1', - 'key2' => 'value2', - 'key3' => 'value3' -); -$m->setMulti($items, time() + 300); -?> -]]> - - - - - - - &reftitle.seealso; - - - Memcached::setMultiByKey - Memcached::set - - - - - - diff --git a/reference/memcached/memcached/setmultibykey.xml b/reference/memcached/memcached/setmultibykey.xml deleted file mode 100644 index 1709bb50ada6..000000000000 --- a/reference/memcached/memcached/setmultibykey.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - Memcached::setMultiByKey - Store multiple items on a specific server - - - - &reftitle.description; - - public boolMemcached::setMultiByKey - stringserver_key - arrayitems - intexpiration0 - - - Memcached::setMultiByKey is functionally equivalent to - Memcached::setMulti, except that the free-form - server_key can be used to map the keys from - items to a specific server. This is useful if you - need to keep a bunch of related keys on a certain server. - - - - - &reftitle.parameters; - - - - server_key - - - &memcached.parameter.server_key; - - - - - items - - - &memcached.parameter.items; - - - - - expiration - - - &memcached.parameter.expiration; - - - - - - - - - &reftitle.returnvalues; - - &return.success; - &memcached.result.getresultcode; - - - - - &reftitle.seealso; - - - Memcached::setMulti - Memcached::set - - - - - - diff --git a/reference/memcached/memcached/setoption.xml b/reference/memcached/memcached/setoption.xml deleted file mode 100644 index a790fc6dc183..000000000000 --- a/reference/memcached/memcached/setoption.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - Memcached::setOption - Set a Memcached option - - - - &reftitle.description; - - public boolMemcached::setOption - intoption - mixedvalue - - - This method sets the value of a Memcached option. - Some options correspond to the ones defined by libmemcached, and some are - specific to the extension. - - - - - &reftitle.parameters; - - - - option - - - One of the Memcached::OPT_* constant. - See Memcached Constants for more information. - - - - - value - - - The value to be set. - - - - The options listed below require values specified via constants. - - - Memcached::OPT_HASH requires - Memcached::HASH_* - values. - - - Memcached::OPT_DISTRIBUTION requires - Memcached::DISTRIBUTION_* - values. - - - Memcached::OPT_SERIALIZER requires - Memcached::SERIALIZER_* - values. - - - Memcached::OPT_COMPRESSION_TYPE requires - Memcached::COMPRESSION_* - values. - - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Setting a Memcached option - -getOption(Memcached::OPT_HASH) == Memcached::HASH_DEFAULT); -$m->setOption(Memcached::OPT_HASH, Memcached::HASH_MURMUR); -$m->setOption(Memcached::OPT_PREFIX_KEY, "widgets"); -echo "Prefix key is now: ", $m->getOption(Memcached::OPT_PREFIX_KEY), "\n"; -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - - Memcached::getOption - Memcached::setOptions - Memcached Constants - - - - - - diff --git a/reference/memcached/memcached/setoptions.xml b/reference/memcached/memcached/setoptions.xml deleted file mode 100644 index f5debf114e4e..000000000000 --- a/reference/memcached/memcached/setoptions.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - Memcached::setOptions - Set Memcached options - - - - &reftitle.description; - - public boolMemcached::setOptions - arrayoptions - - - Memcached::setOptions is a variation of the - Memcached::setOption that takes an array of - options to be set. - - - - - &reftitle.parameters; - - - options - - - An associative array of options where the key is the option to set and - the value is the new value for the option. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Setting Memcached options - -getOption(Memcached::OPT_HASH) == Memcached::HASH_DEFAULT); - -$m->setOptions(array(Memcached::OPT_HASH => Memcached::HASH_MURMUR, Memcached::OPT_PREFIX_KEY => "widgets")); - -var_dump($m->getOption(Memcached::OPT_HASH) == Memcached::HASH_DEFAULT); -echo "Prefix key is now: ", $m->getOption(Memcached::OPT_PREFIX_KEY), "\n"; -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - - Memcached::getOption - Memcached::setOption - Memcached Constants - - - - - - diff --git a/reference/memcached/memcached/setsaslauthdata.xml b/reference/memcached/memcached/setsaslauthdata.xml deleted file mode 100644 index 63cfd1c04de6..000000000000 --- a/reference/memcached/memcached/setsaslauthdata.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - Memcached::setSaslAuthData - Set the credentials to use for authentication - - - - &reftitle.description; - - public boolMemcached::setSaslAuthData - stringusername - stringpassword - - - Memcached::setSaslAuthData sets the username and - password that should be used for SASL authentication with the memcache - servers. - - - This method is only available when the memcached extension is - built with SASL support. Please refer to - Memcached setup for how to do this. - - - - - &reftitle.parameters; - - - - username - - - The username to use for authentication. - - - - - password - - - The password to use for authentication. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/memcached/memcached/touch.xml b/reference/memcached/memcached/touch.xml deleted file mode 100644 index cb50f310d701..000000000000 --- a/reference/memcached/memcached/touch.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - Memcached::touch - Set a new expiration on an item - - - - &reftitle.description; - - public boolMemcached::touch - stringkey - intexpiration0 - - - Memcached::touch sets a new expiration value on the given key. - - - - - &reftitle.parameters; - - - - key - - - &memcached.parameter.key; - - - - - expiration - - - &memcached.parameter.expiration; - - - - - - - - - &reftitle.returnvalues; - - &return.success; - &memcached.result.getresultcode; - - - - - &reftitle.seealso; - - - Memcached::touchByKey - - - - - - diff --git a/reference/memcached/memcached/touchbykey.xml b/reference/memcached/memcached/touchbykey.xml deleted file mode 100644 index 5c77f6127b4e..000000000000 --- a/reference/memcached/memcached/touchbykey.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - Memcached::touchByKey - Set a new expiration on an item on a specific server - - - - &reftitle.description; - - public boolMemcached::touchByKey - stringserver_key - stringkey - intexpiration0 - - - Memcached::touchByKey is functionally equivalent to - Memcached::touch, except that the free-form - server_key can be used to map the - key to a specific server. - - - - - &reftitle.parameters; - - - - server_key - - - &memcached.parameter.server_key; - - - - - key - - - &memcached.parameter.key; - - - - - expiration - - - &memcached.parameter.expiration; - - - - - - - - - &reftitle.returnvalues; - - &return.success; - &memcached.result.getresultcode; - - - - - &reftitle.seealso; - - - Memcached::touch - - - - - - diff --git a/reference/memcached/memcachedexception.xml b/reference/memcached/memcachedexception.xml deleted file mode 100644 index 3c10b5007bcb..000000000000 --- a/reference/memcached/memcachedexception.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - The MemcachedException class - MemcachedException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - MemcachedException - - - - - MemcachedException - - - - extends - RuntimeException - - - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
    - - -
    - -
    - - diff --git a/reference/memcached/sessions.xml b/reference/memcached/sessions.xml deleted file mode 100644 index f9cc49362c07..000000000000 --- a/reference/memcached/sessions.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - Sessions support - Memcached provides a custom session handler that can be used to store - user sessions in memcache. A completely separate memcached instance is used - for that internally, so you can use a different server pool if necessary. The - session keys are stored under the prefix - memc.sess.key., so be aware of this if you use the - same server pool for sessions and generic caching. - - - - - - session.save_handler - string - - - - Set to memcached to enable sessions support. - - - - - - - session.save_path - string - - - - Defines a comma separated of hostname:port entries to - use for session server pool, for example - "sess1:11211, sess2:11211". - - - - - - - - - diff --git a/reference/memcached/setup.xml b/reference/memcached/setup.xml deleted file mode 100644 index 6590fe5cf767..000000000000 --- a/reference/memcached/setup.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - This extension requires libmemcached client library - (version 1.0.0 or greater). For SASL authentication support, libmemcached - must be built with SASL enabled. - - - Since version 0.2.0, this extension requires PHP version 5.2.0 or higher. - -
    - - - &reference.memcached.configure; - - - - &reference.memcached.ini; - - -
    - - - diff --git a/reference/memcached/versions.xml b/reference/memcached/versions.xml deleted file mode 100644 index b9e16d9ed0d3..000000000000 --- a/reference/memcached/versions.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/misc/functions/hrtime.xml b/reference/misc/functions/hrtime.xml index 70f93f2e8704..af41c854644b 100644 --- a/reference/misc/functions/hrtime.xml +++ b/reference/misc/functions/hrtime.xml @@ -101,7 +101,7 @@ Array &reftitle.seealso; - The High resolution timing extension + The High resolution timing extension microtime time_nanosleep diff --git a/reference/mongodb/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/mongodb/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/mongodb/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/mongodb/architecture.xml b/reference/mongodb/architecture.xml deleted file mode 100644 index e65963e526c8..000000000000 --- a/reference/mongodb/architecture.xml +++ /dev/null @@ -1,991 +0,0 @@ - - - - Driver Architecture and Internals - Explains the driver architecture, and special features - -
    - Architecture - Architecture Overview - - - This article explains how all the different components of the PHP driver fit - together, from base system libraries, through the extension, and to the PHP - libraries on top. - - - - - - MongoDB PHP Driver Architecture Diagram. The lowest level of the driver is - our system libraries: libmongoc, libbson, and libmongocrypt. The middle - level is the MongoDB PHP extension. The upper level is PHP userland and - includes the MongoDB PHP library and higher-level packages such as - framework integrations and applications. - - - - - - - - - At the top of this stack sits a - PHP library, - which is distributed as a - Composer package. - This library provides an API consistent with other MongoDB - drivers - and implements various cross-driver - specifications. - While the extension can be used directly, the library has minimal overhead and - should be a common dependency for most applications built with MongoDB. - - - - Sitting below that library is a PHP extension, which is distributed through - PECL. - The extension forms the glue between PHP and our system libraries - (libmongoc, - libbson, and - libmongocrypt). - Its public API provides only the most essential functionality: - - - Connection management - BSON encoding and decoding - Object document serialization (to support ODM libraries) - Executing commands, queries, and write operations - Handling cursors for command and query results - - - - - - Driver Source Code and JIRA Projects - - - - Project - GitHub - JIRA - - - - - PHP Library - mongodb/mongo-php-library - PHPLIB - - - PHP Extension - mongodb/mongo-php-driver - PHPC - - - -
    -
    -
    - -
    - Connections - Connection handling and persistence - - &mongodb.note.forking; - -
    - Connection and topology persistence (PHP version since 1.2.0) - - - All versions of the extension since 1.2.0 persist the - libmongoc client object in - the PHP worker process, which allows it to re-use database connections, - authentication states, and topology information across - multiple requests. - - - - When MongoDB\Driver\Manager::__construct is - invoked, a hash is created from its arguments (i.e. URI string and array - options). The extension will attempt to find a previously persisted - libmongoc client object for - that hash. If an existing client cannot be found for the hash, a new client - will be created and persisted for future use. This behavior can be disabled - via the "disableClientPersistence" driver option. - - - - Each client contains its own database connections and a view of the server - topology (e.g. standalone, replica set, shard cluster). By persisting the - client between PHP requests, the extension is able to re-use established - database connections and remove the need for - discovering the server topology - on each request. - - - - Consider the following example: - - - - 'myReplicaSet']), -]; - -foreach ($managers as $manager) { - $manager->executeCommand('test', new MongoDB\Driver\Command(['ping' => 1])); -} - -?> -]]> - - - - The first two Manager objects will share the same - libmongoc client since - their constructor arguments are identical. The third and fourth objects will - each use their own client. In total, three clients will be created and the - PHP worker executing this script will open two connections to - 127.0.0.1 and one connection to each of - rs1.example.com and rs2.example.com. - If the extension discovers additional members of the replica set after - issuing hello commands, it will open additional - connections to those servers as well. - - - - If the same worker executes the script again in a second request, the three - clients will be re-used and no new connections will be made. Depending on - how long ago the previous request was served, the extension may need to - issue additional hello commands to update its view of the - topologies. - -
    - -
    - Socket persistence (PHP versions before 1.2.0) - - - Versions of the extension before 1.2.0 utilize PHP's Streams API for - database connections, using an API within - libmongoc to designate - custom handlers for socket communication; however, a new libmongoc client is - created for each MongoDB\Driver\Manager. As a result, - the extension persists individual database connections but not - authentication state or topology information. This means that the extension - needs to issue commands at the start of each request to authenticate and - discover the server topology. - - - - Database connections are persisted by a hash derived from the server's - host, port, and the URI string used to construct the - MongoDB\Driver\Manager. The constructor's array - options are not included in this hash. - - - - - Versions of the extension >= 1.1.8 and < 1.2.0 do not persist sockets - for SSL connections. See - PHPC-720 for - additional information. - - - - - Despite its shortcomings with persisting SSL connections when and topology - information, this version of the extension supports all - SSL context options since it uses - PHP's Streams API. - -
    -
    - -
    - Persisting Data - Serialization and deserialization of PHP variables into MongoDB - - - This document discusses how compound structures (i.e. documents, arrays, and - objects) are converted between BSON and PHP values. - - -
    - Serialization to BSON - -
    - Arrays - - - If an array is a packed array — i.e. empty array or - the keys start at 0 and are sequential without gaps: BSON - array. - - - - If the array is not packed — i.e. having associative (string) keys, the - keys don't start at 0, or when there are gaps:: BSON - object - - - - A top-level (root) document, always serializes as a - BSON document. - - -
    - Examples - - - These serialize as a BSON array: - - - - [ 8, 5, 2, 3 ] -[ 0 => 4, 1 => 9 ] => [ 4, 9 ] -]]> - - - - These serialize as a BSON document: - - - - 1, 2 => 8, 3 => 12 ] => { "0" : 1, "2" : 8, "3" : 12 } -[ "foo" => 42 ] => { "foo" : 42 } -[ 1 => 9, 0 => 10 ] => { "1" : 9, "0" : 10 } -]]> - - - - Note that the five examples are extracts of a full - document, and represent only one value inside a - document. - - -
    -
    - -
    - Objects - - - If an object is of the stdClass class, serialize - as a BSON document. - - - - If an object is a supported class that implements - MongoDB\BSON\Type, then use the BSON - serialization logic for that specific type. - MongoDB\BSON\Type instances (excluding - MongoDB\BSON\Serializable may only be - serialized as a document field value. Attempting to serialize such an - object as a root document will throw a - MongoDB\Driver\Exception\UnexpectedValueException - - - - If an object is of an unknown class implementing the - MongoDB\BSON\Type interface, then throw a - MongoDB\Driver\Exception\UnexpectedValueException - - - - If an object is of any other class, without implementing any special - interface, serialize as a BSON document. Keep only - public properties, and ignore - protected and private - properties. - - - - If an object is of a class that implements the - MongoDB\BSON\Serializable interface, call - MongoDB\BSON\Serializable::bsonSerialize and use - the returned array or stdClass to serialize as a - BSON document or array. The BSON type will be determined by the following: - - - - - - Root documents must be serialized as a BSON - document. - - - - - MongoDB\BSON\Persistable objects must be - serialized as a BSON document. - - - - - If MongoDB\BSON\Serializable::bsonSerialize - returns a packed array, serialize as a BSON array. - - - - - If MongoDB\BSON\Serializable::bsonSerialize - returns a non-packed array or stdClass, - serialize as a BSON document. - - - - - If MongoDB\BSON\Serializable::bsonSerialize - did not return an array or stdClass, throw an - MongoDB\Driver\Exception\UnexpectedValueException - exception. - - - - - - - If an object is of a class that implements the - MongoDB\BSON\Persistable interface (which - implies MongoDB\BSON\Serializable), obtain - the properties in a similar way as in the previous paragraphs, but - also add an additional property - __pclass as a Binary value, with subtype - 0x80 and data bearing the fully qualified class name - of the object that is being serialized. - - - - The __pclass property is added to the array or - object returned by - MongoDB\BSON\Serializable::bsonSerialize, which - means it will overwrite any __pclass key/property in - the MongoDB\BSON\Serializable::bsonSerialize - return value. If you want to avoid this behaviour and set your own - __pclass value, you must not - implement MongoDB\BSON\Persistable and - should instead implement - MongoDB\BSON\Serializable directly. - - -
    - Examples - - - {"foo": 42} - -class MyClass -{ - public $foo = 42; - protected $prot = 'wine'; - private $fpr = 'cheese'; -} // => {"foo": 42} - -class AnotherClass1 implements MongoDB\BSON\Serializable -{ - public $foo = 42; - protected $prot = 'wine'; - private $fpr = 'cheese'; - - public function bsonSerialize(): array - { - return ['foo' => $this->foo, 'prot' => $this->prot]; - } -} // => {"foo": 42, "prot": "wine"} - -class AnotherClass2 implements MongoDB\BSON\Serializable -{ - public $foo = 42; - - public function bsonSerialize(): self - { - return $this; - } -} // => MongoDB\Driver\Exception\UnexpectedValueException("bsonSerialize() did not return an array or stdClass") - -class AnotherClass3 implements MongoDB\BSON\Serializable -{ - private $elements = ['foo', 'bar']; - - public function bsonSerialize(): array - { - return $this->elements; - } -} // => {"0": "foo", "1": "bar"} - -/** - * Nesting Serializable classes - */ - -class AnotherClass4 implements MongoDB\BSON\Serializable -{ - private $elements = [0 => 'foo', 2 => 'bar']; - - public function bsonSerialize(): array - { - return $this->elements; - } -} // => {"0": "foo", "2": "bar"} - -class ContainerClass1 implements MongoDB\BSON\Serializable -{ - public $things; - - public function __construct() - { - $this->things = new AnotherClass4(); - } - - function bsonSerialize(): array - { - return ['things' => $this->things]; - } -} // => {"things": {"0": "foo", "2": "bar"}} - - -class AnotherClass5 implements MongoDB\BSON\Serializable -{ - private $elements = [0 => 'foo', 2 => 'bar']; - - public function bsonSerialize(): array - { - return array_values($this->elements); - } -} // => {"0": "foo", "1": "bar"} as a root class - // ["foo", "bar"] as a nested value - -class ContainerClass2 implements MongoDB\BSON\Serializable -{ - public $things; - - public function __construct() - { - $this->things = new AnotherClass5(); - } - - public function bsonSerialize(): array - { - return ['things' => $this->things]; - } -} // => {"things": ["foo", "bar"]} - - -class AnotherClass6 implements MongoDB\BSON\Serializable -{ - private $elements = ['foo', 'bar']; - - function bsonSerialize(): object - { - return (object) $this->elements; - } -} // => {"0": "foo", "1": "bar"} - -class ContainerClass3 implements MongoDB\BSON\Serializable -{ - public $things; - - public function __construct() - { - $this->things = new AnotherClass6(); - } - - public function bsonSerialize(): array - { - return ['things' => $this->things]; - } -} // => {"things": {"0": "foo", "1": "bar"}} - -class UpperClass implements MongoDB\BSON\Persistable -{ - public $foo = 42; - protected $prot = 'wine'; - private $fpr = 'cheese'; - - private $data; - - public function bsonUnserialize(array $data): void - { - $this->data = $data; - } - - public function bsonSerialize(): array - { - return ['foo' => $this->foo, 'prot' => $this->prot]; - } -} // => {"foo": 42, "prot": "wine", "__pclass": {"$type": "80", "$binary": "VXBwZXJDbGFzcw=="}} - -?> -]]> - -
    -
    -
    - -
    - Deserialization from BSON - - &mongodb.warning.duplicate-keys; - - - The legacy mongo extension deserialized - both BSON documents and arrays as PHP arrays. While PHP arrays are - convenient to work with, this behavior was problematic because different - BSON types could deserialize to the same PHP value (e.g. - {"0": "foo"} and ["foo"]) and make it - impossible to infer the original BSON type. By default, the - mongodb extension addresses this concern by ensuring that BSON - arrays and documents are converted to PHP arrays and objects, respectively. - - - For compound types, there are three data types: - - - - - - root - - - refers to the top-level BSON document only - - - - - document - - - refers to embedded BSON documents only - - - - - array - - - refers to a BSON array - - - - - - - - Besides the three collective types, it is also possible to configure - specific fields in your document to map to the data types mentioned below. - As an example, the following type map allows you to - map each embedded document within an "addresses" array to - an Address class and each - "city" field within those embedded address documents to - a City class: - - - [ - 'addresses.$' => 'MyProject\Address', - 'addresses.$.city' => 'MyProject\City', - ], -] -]]> - - - - - Each of those three data types, as well as the field specific mappings, - can be mapped against different PHP types. The possible mapping values - are: - - - - - - not set or NULL (default) - - - - - - A BSON array will be deserialized as a PHP array. - - - - - A BSON document (root or embedded) without a - __pclass property - - - A __pclass property is only deemed to exist if - there exists a property with that name, and it is a Binary value, - and the sub-type of the Binary value is 0x80. If any of these three - conditions is not met, the __pclass property does not exist and - should be treated as any other normal property. - - - becomes a PHP stdClass object, with each - BSON document key set as a public stdClass - property. - - - - - A BSON document (root or embedded) with a - __pclass property becomes a PHP object of - the class name as defined by the __pclass - property. - - - If the named class implements the - MongoDB\BSON\Persistable interface, - then the properties of the BSON document, including the - __pclass property, are sent as an associative - array to the - MongoDB\BSON\Unserializable::bsonUnserialize - function to initialise the object's properties. - - - If the named class does not exist or does not implement the - MongoDB\BSON\Persistable interface, - stdClass will be used and each BSON document - key (including __pclass) will be set as a - public stdClass property. - - - The __pclass functionality relies on the - property being part of a retrieved MongoDB document. If you use a - projection - when querying for documents, you need to include the - __pclass field in the projection for this - functionality to work. - - - - - - - - - "array" - - - Turns a BSON array or BSON document into a PHP array. There will be no - special treatment of a __pclass property , - but it may be set as an element in the returned array if it was - present in the BSON document. - - - - - - "object" or "stdClass" - - - Turns a BSON array or BSON document into a - stdClass object. There will be no special - treatment of a __pclass property , but it may - be set as a public property in the returned object if it was present - in the BSON document. - - - - - - "bson" - - - Turns a BSON array into a MongoDB\BSON\PackedArray - and a BSON document into a MongoDB\BSON\Document, - regardless of whether the BSON document has a __pclass - property . - - - - The bson value is only available for the three root - types, not in the field specific mappings. - - - - - - - any other string - - - Defines the class name that the BSON array or BSON object should be - deserialized as. For BSON objects that include - __pclass properties, that class will take - priority. - - - - If the named class does not exist, is not concrete (i.e. it is - abstract or an interface), or does not implement - MongoDB\BSON\Unserializable then an - MongoDB\Driver\Exception\InvalidArgumentException - exception is thrown. - - - - If the BSON object has a __pclass property and - that class exists and implements - MongoDB\BSON\Persistable it will - supersede the class provided in the type map. - - - - The properties of the BSON document, including - the __pclass property if it exists, will be sent - as an associative array to the - MongoDB\BSON\Unserializable::bsonUnserialize - function to initialise the object's properties. - - - - - - -
    - TypeMaps - - - TypeMaps can be set through the - MongoDB\Driver\Cursor::setTypeMap method on a - MongoDB\Driver\Cursor object, or the - $typeMap argument of - MongoDB\BSON\toPHP, - MongoDB\BSON\Document::toPHP, and - MongoDB\BSON\PackedArray::toPHP. Each of the three - classes (root, document, and - array) can be individually set, in addition to the - field specific types. - - - - If the value in the map is NULL, it means the same as the - default value for that item. - -
    - -
    - Examples - - - These examples use the following classes: - - - - - - MyClass - - - which does not implement any interface - - - - - YourClass - - - which implements - MongoDB\BSON\Unserializable - - - - - OurClass - - - which implements - MongoDB\BSON\Persistable - - - - - TheirClass - - - which extends OurClass - - - - - - - - The MongoDB\BSON\Unserializable::bsonUnserialize - method of YourClass, OurClass, TheirClass iterate over the array and set - the properties without modifications. It also sets - the $unserialized property to &true;: - - - $value ) - { - $this->$k = $value; - } - $this->unserialized = true; -} -]]> - - - - - - stdClass { $foo => 'yes', $bar => false } - -{ "foo": "no", "array" : [ 5, 6 ] } - -> stdClass { $foo => 'no', $array => [ 5, 6 ] } - -{ "foo": "no", "obj" : { "embedded" : 3.14 } } - -> stdClass { $foo => 'no', $obj => stdClass { $embedded => 3.14 } } - -{ "foo": "yes", "__pclass": "MyClass" } - -> stdClass { $foo => 'yes', $__pclass => 'MyClass' } - -{ "foo": "yes", "__pclass": { "$type" : "80", "$binary" : "MyClass" } } - -> stdClass { $foo => 'yes', $__pclass => Binary(0x80, 'MyClass') } - -{ "foo": "yes", "__pclass": { "$type" : "80", "$binary" : "YourClass") } - -> stdClass { $foo => 'yes', $__pclass => Binary(0x80, 'YourClass') } - -{ "foo": "yes", "__pclass": { "$type" : "80", "$binary" : "OurClass") } - -> OurClass { $foo => 'yes', $__pclass => Binary(0x80, 'OurClass'), $unserialized => true } - -{ "foo": "yes", "__pclass": { "$type" : "44", "$binary" : "YourClass") } - -> stdClass { $foo => 'yes', $__pclass => Binary(0x44, 'YourClass') } -]]> - - - - - - "MissingClass" ] */ -{ "foo": "yes" } - -> MongoDB\Driver\Exception\InvalidArgumentException("MissingClass does not exist") - -/* typemap: [ "root" => "MyClass" ] */ -{ "foo": "yes", "__pclass" : { "$type": "80", "$binary": "MyClass" } } - -> MongoDB\Driver\Exception\InvalidArgumentException("MyClass does not implement Unserializable interface") - -/* typemap: [ "root" => "MongoDB\BSON\Unserializable" ] */ -{ "foo": "yes" } - -> MongoDB\Driver\Exception\InvalidArgumentException("Unserializable is not a concrete class") - -/* typemap: [ "root" => "YourClass" ] */ -{ "foo": "yes", "__pclass" : { "$type": "80", "$binary": "MongoDB\BSON\Unserializable" } } - -> YourClass { $foo => "yes", $__pclass => Binary(0x80, "MongoDB\BSON\Unserializable"), $unserialized => true } - -/* typemap: [ "root" => "YourClass" ] */ -{ "foo": "yes", "__pclass" : { "$type": "80", "$binary": "MyClass" } } - -> YourClass { $foo => "yes", $__pclass => Binary(0x80, "MyClass"), $unserialized => true } - -/* typemap: [ "root" => "YourClass" ] */ -{ "foo": "yes", "__pclass" : { "$type": "80", "$binary": "OurClass" } } - -> OurClass { $foo => "yes", $__pclass => Binary(0x80, "OurClass"), $unserialized => true } - -/* typemap: [ "root" => "YourClass" ] */ -{ "foo": "yes", "__pclass" : { "$type": "80", "$binary": "TheirClass" } } - -> TheirClass { $foo => "yes", $__pclass => Binary(0x80, "TheirClass"), $unserialized => true } - -/* typemap: [ "root" => "OurClass" ] */ -{ foo: "yes", "__pclass" : { "$type": "80", "$binary": "TheirClass" } } - -> TheirClass { $foo => "yes", $__pclass => Binary(0x80, "TheirClass"), $unserialized => true } -]]> - - - - - - 'YourClass' ] */ -{ foo: "yes", "__pclass" : { "$type": "80", "$binary": "YourClass" } } - -> YourClass { $foo => 'yes', $__pclass => Binary(0x80, 'YourClass'), $unserialized => true } -]]> - - - - - - 'array', 'document' => 'array' ] */ -{ "foo": "yes", "bar" : false } - -> [ "foo" => "yes", "bar" => false ] - -{ "foo": "no", "array" : [ 5, 6 ] } - -> [ "foo" => "no", "array" => [ 5, 6 ] ] - -{ "foo": "no", "obj" : { "embedded" : 3.14 } } - -> [ "foo" => "no", "obj" => [ "embedded => 3.14 ] ] - -{ "foo": "yes", "__pclass": "MyClass" } - -> [ "foo" => "yes", "__pclass" => "MyClass" ] - -{ "foo": "yes", "__pclass" : { "$type": "80", "$binary": "MyClass" } } - -> [ "foo" => "yes", "__pclass" => Binary(0x80, "MyClass") ] - -{ "foo": "yes", "__pclass" : { "$type": "80", "$binary": "OurClass" } } - -> [ "foo" => "yes", "__pclass" => Binary(0x80, "OurClass") ] -]]> - - - - - - 'object', 'document' => 'object' ] */ -{ "foo": "yes", "__pclass": { "$type": "80", "$binary": "MyClass" } } - -> stdClass { $foo => "yes", "__pclass" => Binary(0x80, "MyClass") } -]]> - - - -
    -
    - -
    -
    - - diff --git a/reference/mongodb/book.xml b/reference/mongodb/book.xml deleted file mode 100644 index 8f3f46e04f68..000000000000 --- a/reference/mongodb/book.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - MongoDB Extension - MongoDB - - - - - This extension is developed atop the - libmongoc and - libbson libraries. - It provides a minimal API for core driver functionality: - commands, - queries, - writes, - connection management, - and BSON serialization. - - - Userland PHP libraries that depend on this extension may provide higher - level APIs, such as query builders, individual command helper methods, and - GridFS. Application developers should consider using this extension in - conjunction with the - MongoDB PHP library, which - implements the same higher level APIs found in MongoDB drivers for other - languages. This separation of concerns allows the extension to focus on - essential features for which an extension implementation is paramount for - performance. - - - - - &reference.mongodb.setup; - &reference.mongodb.constants; - &reference.mongodb.tutorial; - &reference.mongodb.architecture; - &reference.mongodb.security; - - &reference.mongodb.mongodb; - &reference.mongodb.bson; - &reference.mongodb.monitoring; - &reference.mongodb.exceptions; - - - diff --git a/reference/mongodb/bson.xml b/reference/mongodb/bson.xml deleted file mode 100644 index ca46af976487..000000000000 --- a/reference/mongodb/bson.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - MongoDB BSON Classes and Functions - MongoDB\BSON - - - &Functions; - &reference.mongodb.functions.entities.bson; - - - &reference.mongodb.bson.document; - &reference.mongodb.bson.packedarray; - &reference.mongodb.bson.iterator; - - &reference.mongodb.bson.binary; - &reference.mongodb.bson.vectortype; - &reference.mongodb.bson.decimal128; - &reference.mongodb.bson.javascript; - &reference.mongodb.bson.maxkey; - &reference.mongodb.bson.minkey; - &reference.mongodb.bson.objectid; - &reference.mongodb.bson.regex; - &reference.mongodb.bson.timestamp; - &reference.mongodb.bson.utcdatetime; - - &reference.mongodb.bson.type; - &reference.mongodb.bson.persistable; - &reference.mongodb.bson.serializable; - &reference.mongodb.bson.unserializable; - - &reference.mongodb.bson.binaryinterface; - &reference.mongodb.bson.decimal128interface; - &reference.mongodb.bson.javascriptinterface; - &reference.mongodb.bson.maxkeyinterface; - &reference.mongodb.bson.minkeyinterface; - &reference.mongodb.bson.objectidinterface; - &reference.mongodb.bson.regexinterface; - &reference.mongodb.bson.timestampinterface; - &reference.mongodb.bson.utcdatetimeinterface; - - &reference.mongodb.bson.dbpointer; - &reference.mongodb.bson.int64; - &reference.mongodb.bson.symbol; - &reference.mongodb.bson.undefined; - diff --git a/reference/mongodb/bson/binary.xml b/reference/mongodb/bson/binary.xml deleted file mode 100644 index 2649cc6424c2..000000000000 --- a/reference/mongodb/bson/binary.xml +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - The MongoDB\BSON\Binary class - MongoDB\BSON\Binary - - - - -
    - &reftitle.intro; - - BSON type for binary data (i.e. array of bytes). Binary values also have a - subtype, which is used to indicate what kind of data is in the byte array. - Subtypes from zero to 127 are predefined or reserved. Subtypes from 128-255 - are user-defined. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\BSON\Binary - - - - final - - MongoDB\BSON\Binary - - - - MongoDB\BSON\BinaryInterface - - - - MongoDB\BSON\Type - - - - JsonSerializable - - - - Stringable - - - - &Constants; - - const - int - MongoDB\BSON\Binary::TYPE_GENERIC - 0 - - - const - int - MongoDB\BSON\Binary::TYPE_FUNCTION - 1 - - - const - int - MongoDB\BSON\Binary::TYPE_OLD_BINARY - 2 - - - const - int - MongoDB\BSON\Binary::TYPE_OLD_UUID - 3 - - - const - int - MongoDB\BSON\Binary::TYPE_UUID - 4 - - - const - int - MongoDB\BSON\Binary::TYPE_MD5 - 5 - - - const - int - MongoDB\BSON\Binary::TYPE_ENCRYPTED - 6 - - - const - int - MongoDB\BSON\Binary::TYPE_COLUMN - 7 - - - const - int - MongoDB\BSON\Binary::TYPE_SENSITIVE - 8 - - - const - int - MongoDB\BSON\Binary::TYPE_VECTOR - 9 - - - const - int - MongoDB\BSON\Binary::TYPE_USER_DEFINED - 128 - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - MongoDB\BSON\Binary::TYPE_GENERIC - - Generic binary data. - - - - - MongoDB\BSON\Binary::TYPE_FUNCTION - - Function. - - - - - MongoDB\BSON\Binary::TYPE_OLD_BINARY - - Generic binary data (deprecated in favor of MongoDB\BSON\Binary::TYPE_GENERIC). - - - - - MongoDB\BSON\Binary::TYPE_OLD_UUID - - - Universally unique identifier (deprecated in favor of - MongoDB\BSON\Binary::TYPE_UUID). When using this - type, the Binary's data should be 16 bytes in length. - - - Historically, other drivers encoded values with this type based on their - language conventions (e.g. varying endianness), which makes it - non-portable. The PHP extension applies no special handling for encoding - or decoding data with this type. - - - - - - MongoDB\BSON\Binary::TYPE_UUID - - - Universally unique identifier. When using this type, the Binary's - data should be 16 bytes in length and encoded according to - RFC 4122. - - - - - - MongoDB\BSON\Binary::TYPE_MD5 - - MD5 hash. When using this type, the Binary's data should be 16 bytes in length. - - - - - MongoDB\BSON\Binary::TYPE_ENCRYPTED - - Encrypted value. This subtype is used for client-side encryption. - - - - - MongoDB\BSON\Binary::TYPE_COLUMN - - Column data. This subtype is used for time-series collections. - - - - - MongoDB\BSON\Binary::TYPE_SENSITIVE - - - Sensitive data. This subtype is used for sensitive data that should be - excluded from server-side logging when possible. - - - - - - MongoDB\BSON\Binary::TYPE_VECTOR - - - Vector data. This subtype is used to efficiently store vector data for - use with MongoDB's vector search. - - - - - - MongoDB\BSON\Binary::TYPE_USER_DEFINED - - - User-defined type. While types between 0 and 127 are predefined or - reserved, types between 128 and 255 are user-defined and may be used for - anything. - - - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.2.0 - - Added MongoDB\BSON\Binary::TYPE_VECTOR, as well as the - MongoDB\BSON\Binary::fromVector, - MongoDB\BSON\Binary::getVectorType, and - MongoDB\BSON\Binary::toArray functions. - - - &mongodb.changelog.serializable-interface-removed; - - PECL mongodb 1.17.0 - - Added MongoDB\BSON\Binary::TYPE_SENSITIVE. - - - - PECL mongodb 1.12.0 - - - Implements Stringable for PHP 8.0+. - - - Added MongoDB\BSON\Binary::TYPE_COLUMN. - - - - - PECL mongodb 1.7.0 - - Added MongoDB\BSON\Binary::TYPE_ENCRYPTED. - - - - PECL mongodb 1.3.0 - - Implements MongoDB\BSON\BinaryInterface. - - - - PECL mongodb 1.2.0 - - Implements Serializable and - JsonSerializable. - - - - - -
    - -
    - - &reference.mongodb.bson.entities.binary; - -
    - - diff --git a/reference/mongodb/bson/binary/construct.xml b/reference/mongodb/bson/binary/construct.xml deleted file mode 100644 index 959c1d89244e..000000000000 --- a/reference/mongodb/bson/binary/construct.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - - MongoDB\BSON\Binary::__construct - Construct a new Binary - - - - &reftitle.description; - - final public MongoDB\BSON\Binary::__construct - stringdata - inttypeMongoDB\BSON\Binary::TYPE_GENERIC - - - - - &reftitle.parameters; - - - data (string) - - - Binary data. - - - - - type (int) - - - Unsigned 8-bit integer denoting the data's type. Defaults to MongoDB\BSON\Binary::TYPE_GENERIC if not specified. - - - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\InvalidArgumentException if type is not an unsigned 8-bit integer. - Throws MongoDB\Driver\Exception\InvalidArgumentException if type is MongoDB\BSON\Binary::TYPE_UUID or MongoDB\BSON\Binary::TYPE_OLD_UUID and data is not exactly 16 bytes in length. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.15.0 - - - The type parameter defaults to - MongoDB\BSON\Binary::TYPE_GENERIC if not specified. - - - - - PECL mongodb 1.3.0 - - - MongoDB\Driver\Exception\InvalidArgumentException - is thrown if type is - MongoDB\BSON\Binary::TYPE_UUID or - MongoDB\BSON\Binary::TYPE_OLD_UUID and - data is not exactly 16 bytes in length. - - - - - PECL mongodb 1.1.3 - - - MongoDB\Driver\Exception\InvalidArgumentException - is thrown if type is not an unsigned 8-bit - integer. - - - - - - - - - - &reftitle.examples; - - <function>MongoDB\BSON\Binary::__construct</function> example - - -]]> - - &example.outputs; - - - string(3) "foo" - ["type"]=> - int(0) -} -]]> - - - - - - - &reftitle.seealso; - - BSON Types - - - - - - diff --git a/reference/mongodb/bson/binary/fromvector.xml b/reference/mongodb/bson/binary/fromvector.xml deleted file mode 100644 index 92cdf2ac8cf9..000000000000 --- a/reference/mongodb/bson/binary/fromvector.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - MongoDB\BSON\Binary::fromVector - Creates a new binary with subtype MongoDB\BSON\Binary::SUBTYPE_VECTOR from the given array and vector type - - - - &reftitle.description; - - final public static MongoDB\BSON\BinaryMongoDB\BSON\Binary::fromVector - arrayvector - MongoDB\BSON\VectorTypevectorType - - - - - &reftitle.parameters; - - - vector (array) - - - An array of values representing the vector data. The type of each value must match the type indicated by the vectorType parameter: - - for MongoDB\BSON\VectorType::Float32, each value must be a float - for MongoDB\BSON\VectorType::Int8, each value must be an 8-bit int, i.e. from -127 to 128 - for MongoDB\BSON\VectorType::PackedBit, each value must be a bool or 1-bit int, i.e. 0 or 1 - - - - - - vectorType (MongoDB\BSON\VectorType) - - - The vector data type. - - - - - - - - &reftitle.returnvalues; - - Returns a new Binary with subtype MongoDB\BSON\Binary::SUBTYPE_VECTOR. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\BSON\Binary::toArray - MongoDB\BSON\Binary::getVectorType - MongoDB\BSON\VectorType - BSON Types - - - - - - diff --git a/reference/mongodb/bson/binary/getdata.xml b/reference/mongodb/bson/binary/getdata.xml deleted file mode 100644 index f2ed51e56d4a..000000000000 --- a/reference/mongodb/bson/binary/getdata.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - MongoDB\BSON\Binary::getData - Returns the Binary's data - - - - &reftitle.description; - - final public stringMongoDB\BSON\Binary::getData - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the Binary's data. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - <function>MongoDB\BSON\Binary::getData</function> example - -getData()); - -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - BSON Types - - - - - - diff --git a/reference/mongodb/bson/binary/gettype.xml b/reference/mongodb/bson/binary/gettype.xml deleted file mode 100644 index fd1d29f11928..000000000000 --- a/reference/mongodb/bson/binary/gettype.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - MongoDB\BSON\Binary::getType - Returns the Binary's type - - - - &reftitle.description; - - final public intMongoDB\BSON\Binary::getType - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the Binary's type. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - <function>MongoDB\BSON\Binary::getType</function> example - -getType()); - -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - BSON Types - - - - - - diff --git a/reference/mongodb/bson/binary/getvectortype.xml b/reference/mongodb/bson/binary/getvectortype.xml deleted file mode 100644 index d858645fedb1..000000000000 --- a/reference/mongodb/bson/binary/getvectortype.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - MongoDB\BSON\Binary::getVectorType - Returns the data type for a Binary with the vector subtype - - - - &reftitle.description; - - final public MongoDB\BSON\VectorTypeMongoDB\BSON\Binary::getVectorType - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the data type of the Binary vector. - - - - - &reftitle.errors; - - Throws MongoDB\Driver\Exception\LogicException if the subtype is not MongoDB\BSON\Binary::SUBTYPE_VECTOR. - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - BSON Types - MongoDB\BSON\VectorType - - - - - - diff --git a/reference/mongodb/bson/binary/jsonserialize.xml b/reference/mongodb/bson/binary/jsonserialize.xml deleted file mode 100644 index 8aa93754fd77..000000000000 --- a/reference/mongodb/bson/binary/jsonserialize.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - MongoDB\BSON\Binary::jsonSerialize - Returns a representation that can be converted to JSON - - - - &reftitle.description; - - final public mixedMongoDB\BSON\Binary::jsonSerialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns data which can be serialized by json_encode to - produce an extended JSON representation of the - MongoDB\BSON\Binary. - - &mongodb.note.extended-json; - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - JsonSerializable::jsonSerialize - json_encode - MongoDB\BSON\toCanonicalExtendedJSON - MongoDB\BSON\toRelaxedExtendedJSON - MongoDB Extended JSON - - - - - - diff --git a/reference/mongodb/bson/binary/toarray.xml b/reference/mongodb/bson/binary/toarray.xml deleted file mode 100644 index e73e98115eb5..000000000000 --- a/reference/mongodb/bson/binary/toarray.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - MongoDB\BSON\Binary::toArray - Returns the vector as an array for a Binary with subtype MongoDB\BSON\Binary::SUBTYPE_VECTOR - - - - &reftitle.description; - - final public arrayMongoDB\BSON\Binary::toArray - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an array containing the vector data. - - - - - &reftitle.errors; - - Throws MongoDB\Driver\Exception\LogicException if the subtype is not MongoDB\BSON\Binary::SUBTYPE_VECTOR. - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\BSON\Binary::fromVector - BSON Types - - - - - - diff --git a/reference/mongodb/bson/binary/tostring.xml b/reference/mongodb/bson/binary/tostring.xml deleted file mode 100644 index 38dab03888fa..000000000000 --- a/reference/mongodb/bson/binary/tostring.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - MongoDB\BSON\Binary::__toString - Returns the Binary's data - - - - &reftitle.description; - - final public stringMongoDB\BSON\Binary::__toString - - - - &info.method.alias; MongoDB\BSON\Binary::getData. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the Binary's data. - - - - - &reftitle.examples; - - <function>MongoDB\BSON\Binary::__toString</function> example - - -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - MongoDB\BSON\Binary::getData - BSON Types - - - - - - diff --git a/reference/mongodb/bson/binaryinterface.xml b/reference/mongodb/bson/binaryinterface.xml deleted file mode 100644 index 12892959fc87..000000000000 --- a/reference/mongodb/bson/binaryinterface.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - The MongoDB\BSON\BinaryInterface interface - MongoDB\BSON\BinaryInterface - - -
    - &reftitle.intro; - - This interface is implemented by MongoDB\BSON\Binary - to be used as a parameter, return, or property type in userland classes. - -
    - -
    - &reftitle.classsynopsis; - - MongoDB\BSON\BinaryInterface - - - MongoDB\BSON\BinaryInterface - - - &Methods; - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.tentative-return-types-enforced; - &mongodb.changelog.tentative-return-types; - - - -
    -
    - - &reference.mongodb.bson.entities.binaryinterface; - -
    - - diff --git a/reference/mongodb/bson/binaryinterface/getdata.xml b/reference/mongodb/bson/binaryinterface/getdata.xml deleted file mode 100644 index 9d0c42a9eca6..000000000000 --- a/reference/mongodb/bson/binaryinterface/getdata.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\BSON\BinaryInterface::getData - Returns the BinaryInterface's data - - - - &reftitle.description; - - abstract public stringMongoDB\BSON\BinaryInterface::getData - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the BinaryInterface's data. - - - - - &reftitle.seealso; - - MongoDB\BSON\Binary::getData - - - - - - diff --git a/reference/mongodb/bson/binaryinterface/gettype.xml b/reference/mongodb/bson/binaryinterface/gettype.xml deleted file mode 100644 index d9b425936f4c..000000000000 --- a/reference/mongodb/bson/binaryinterface/gettype.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\BSON\BinaryInterface::getType - Returns the BinaryInterface's type - - - - &reftitle.description; - - abstract public intMongoDB\BSON\BinaryInterface::getType - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the BinaryInterface's type. - - - - - &reftitle.seealso; - - MongoDB\BSON\Binary::getType - - - - - - diff --git a/reference/mongodb/bson/binaryinterface/tostring.xml b/reference/mongodb/bson/binaryinterface/tostring.xml deleted file mode 100644 index 435f6b84783c..000000000000 --- a/reference/mongodb/bson/binaryinterface/tostring.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - MongoDB\BSON\BinaryInterface::__toString - Returns the BinaryInterface's data - - - - &reftitle.description; - - abstract public stringMongoDB\BSON\BinaryInterface::__toString - - - - &info.method.alias; MongoDB\BSON\BinaryInterface::getData. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the BinaryInterface's data. - - - - - &reftitle.seealso; - - MongoDB\BSON\BinaryInterface::getData - MongoDB\BSON\Binary::__toString - - - - - - diff --git a/reference/mongodb/bson/dbpointer.xml b/reference/mongodb/bson/dbpointer.xml deleted file mode 100644 index 0f75b3fdba56..000000000000 --- a/reference/mongodb/bson/dbpointer.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - The MongoDB\BSON\DBPointer class - MongoDB\BSON\DBPointer - - - - -
    - &reftitle.intro; - - BSON type for the "DBPointer" type. This BSON type is deprecated, and this - class can not be instantiated. It will be created from a BSON DBPointer - type while converting BSON to PHP, and can also be converted back into - BSON while storing documents in the database. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\BSON\DBPointer - - - - final - - MongoDB\BSON\DBPointer - - - - MongoDB\BSON\Type - - - - JsonSerializable - - - - Stringable - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.serializable-interface-removed; - - PECL mongodb 1.12.0 - - Implements Stringable for PHP 8.0+. - - - - - -
    - -
    - - &reference.mongodb.bson.entities.dbpointer; - -
    - - diff --git a/reference/mongodb/bson/dbpointer/construct.xml b/reference/mongodb/bson/dbpointer/construct.xml deleted file mode 100644 index 2b8064c6b2c2..000000000000 --- a/reference/mongodb/bson/dbpointer/construct.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - MongoDB\BSON\DBPointer::__construct - Construct a new DBPointer (unused) - - - - &reftitle.description; - - final private MongoDB\BSON\DBPointer::__construct - - - - MongoDB\BSON\DBPointer objects are created through - conversion from a deprecated BSON type and cannot be constructed directly. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.seealso; - - BSON Types - - - - - - diff --git a/reference/mongodb/bson/dbpointer/jsonserialize.xml b/reference/mongodb/bson/dbpointer/jsonserialize.xml deleted file mode 100644 index 71d996e04a98..000000000000 --- a/reference/mongodb/bson/dbpointer/jsonserialize.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - MongoDB\BSON\DBPointer::jsonSerialize - Returns a representation that can be converted to JSON - - - - &reftitle.description; - - final public mixedMongoDB\BSON\DBPointer::jsonSerialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns data which can be serialized by json_encode to - produce an extended JSON representation of the - MongoDB\BSON\DBPointer. - - &mongodb.note.extended-json; - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - JsonSerializable::jsonSerialize - json_encode - MongoDB\BSON\toCanonicalExtendedJSON - MongoDB\BSON\toRelaxedExtendedJSON - MongoDB Extended JSON - - - - - - diff --git a/reference/mongodb/bson/dbpointer/tostring.xml b/reference/mongodb/bson/dbpointer/tostring.xml deleted file mode 100644 index 314af969581e..000000000000 --- a/reference/mongodb/bson/dbpointer/tostring.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\BSON\DBPointer::__toString - Returns an empty string - - - - &reftitle.description; - - final public stringMongoDB\BSON\DBPointer::__toString - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an empty string. - - - - - &reftitle.seealso; - - BSON Types - - - - - - diff --git a/reference/mongodb/bson/decimal128.xml b/reference/mongodb/bson/decimal128.xml deleted file mode 100644 index 17d5f2a02a3c..000000000000 --- a/reference/mongodb/bson/decimal128.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - The MongoDB\BSON\Decimal128 class - MongoDB\BSON\Decimal128 - - - - -
    - &reftitle.intro; - - BSON type for the - Decimal128 floating-point format, - which supports numbers with up to 34 decimal digits (i.e. significant - digits) and an exponent range of −6143 to +6144. - - - Unlike the double BSON type (i.e. float in PHP), which only - stores an approximation of the decimal values, the decimal data type stores - the exact value. For example, MongoDB\BSON\Decimal128('9.99') - has a precise value of 9.99 where as a double 9.99 would have an approximate - value of 9.9900000000000002131628…. - - &mongodb.note.decimal128; -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\BSON\Decimal128 - - - - final - - MongoDB\BSON\Decimal128 - - - - MongoDB\BSON\Decimal128Interface - - - - MongoDB\BSON\Type - - - - JsonSerializable - - - - Stringable - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.serializable-interface-removed; - - PECL mongodb 1.12.0 - - Implements Stringable for PHP 8.0+. - - - - PECL mongodb 1.3.0 - - Implements MongoDB\BSON\Decimal128Interface. - - - - PECL mongodb 1.2.0 - - Implements Serializable and - JsonSerializable. - - - - - -
    - -
    - - &reference.mongodb.bson.entities.decimal128; - -
    - - diff --git a/reference/mongodb/bson/decimal128/construct.xml b/reference/mongodb/bson/decimal128/construct.xml deleted file mode 100644 index 48b29afe4d00..000000000000 --- a/reference/mongodb/bson/decimal128/construct.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - MongoDB\BSON\Decimal128::__construct - Construct a new Decimal128 - - - - &reftitle.description; - - final public MongoDB\BSON\Decimal128::__construct - stringvalue - - &mongodb.note.decimal128; - - - - &reftitle.parameters; - - - value (string) - - - A decimal string. - - - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\InvalidArgumentException if value is not a valid decimal string. - - - - - - &reftitle.examples; - - <function>MongoDB\BSON\Decimal128::__construct</function> example - - -]]> - - &example.outputs.similar; - - - string(9) "1234.5678" -} -object(MongoDB\BSON\Decimal128)#1 (1) { - ["dec"]=> - string(3) "NaN" -} -object(MongoDB\BSON\Decimal128)#1 (1) { - ["dec"]=> - string(8) "Infinity" -} - -]]> - - - - - - - &reftitle.seealso; - - Decimal128 floating-point format - BSON Types - - - - - - diff --git a/reference/mongodb/bson/decimal128/jsonserialize.xml b/reference/mongodb/bson/decimal128/jsonserialize.xml deleted file mode 100644 index a4fc5aecf001..000000000000 --- a/reference/mongodb/bson/decimal128/jsonserialize.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - MongoDB\BSON\Decimal128::jsonSerialize - Returns a representation that can be converted to JSON - - - - &reftitle.description; - - final public mixedMongoDB\BSON\Decimal128::jsonSerialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns data which can be serialized by json_encode to - produce an extended JSON representation of the - MongoDB\BSON\Decimal128. - - &mongodb.note.extended-json; - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - JsonSerializable::jsonSerialize - json_encode - MongoDB\BSON\toCanonicalExtendedJSON - MongoDB\BSON\toRelaxedExtendedJSON - MongoDB Extended JSON - - - - - - diff --git a/reference/mongodb/bson/decimal128/tostring.xml b/reference/mongodb/bson/decimal128/tostring.xml deleted file mode 100644 index b31ead105a7d..000000000000 --- a/reference/mongodb/bson/decimal128/tostring.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - MongoDB\BSON\Decimal128::__toString - Returns the string representation of this Decimal128 - - - - &reftitle.description; - - final public stringMongoDB\BSON\Decimal128::__toString - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the string representation of this Decimal128. - - - - - &reftitle.examples; - - <function>MongoDB\BSON\Decimal128::__toString</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - Decimal128 floating-point format - BSON Types - - - - - - diff --git a/reference/mongodb/bson/decimal128interface.xml b/reference/mongodb/bson/decimal128interface.xml deleted file mode 100644 index a1ec9a7581df..000000000000 --- a/reference/mongodb/bson/decimal128interface.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - The MongoDB\BSON\Decimal128Interface interface - MongoDB\BSON\Decimal128Interface - - -
    - &reftitle.intro; - - This interface is implemented by - MongoDB\BSON\Decimal128 to be used as a parameter, - return, or property type in userland classes. - -
    - -
    - &reftitle.classsynopsis; - - MongoDB\BSON\Decimal128Interface - - - MongoDB\BSON\Decimal128Interface - - - &Methods; - - -
    -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.tentative-return-types-enforced; - &mongodb.changelog.tentative-return-types; - - - -
    -
    - - &reference.mongodb.bson.entities.decimal128interface; - -
    - - diff --git a/reference/mongodb/bson/decimal128interface/tostring.xml b/reference/mongodb/bson/decimal128interface/tostring.xml deleted file mode 100644 index 2b2a0f589ccc..000000000000 --- a/reference/mongodb/bson/decimal128interface/tostring.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\BSON\Decimal128Interface::__toString - Returns the string representation of this Decimal128Interface - - - - &reftitle.description; - - abstract public stringMongoDB\BSON\Decimal128Interface::__toString - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the string representation of this Decimal128Interface. - - - - - &reftitle.seealso; - - MongoDB\BSON\Decimal128::__toString - - - - - - diff --git a/reference/mongodb/bson/document.xml b/reference/mongodb/bson/document.xml deleted file mode 100644 index 20af840bb2f0..000000000000 --- a/reference/mongodb/bson/document.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - The MongoDB\BSON\Document class - MongoDB\BSON\Document - - - - -
    - &reftitle.intro; - - Represents a BSON document. This class is used when reading data as raw BSON - and cannot be modified. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\BSON\Document - - - - final - - MongoDB\BSON\Document - - - - MongoDB\BSON\Type - - - - ArrayAccess - - - - IteratorAggregate - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.serializable-interface-removed; - - PECL mongodb 1.17.0 - - Implements MongoDB\BSON\Type. - - - - - -
    - -
    - - &reference.mongodb.bson.entities.document; - -
    - - diff --git a/reference/mongodb/bson/document/construct.xml b/reference/mongodb/bson/document/construct.xml deleted file mode 100644 index 58594d517d87..000000000000 --- a/reference/mongodb/bson/document/construct.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\BSON\Document::__construct - Construct a new BSON document (unused) - - - - &reftitle.description; - - final private MongoDB\BSON\Document::__construct - - - - MongoDB\BSON\Document objects are created through - static factory methods and cannot be instantiated directly. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.seealso; - - MongoDB\BSON\Document::fromPHP - MongoDB\BSON\Document::fromBSON - MongoDB\BSON\Document::fromJSON - BSON Types - - - - - - diff --git a/reference/mongodb/bson/document/frombson.xml b/reference/mongodb/bson/document/frombson.xml deleted file mode 100644 index 87a76ce07127..000000000000 --- a/reference/mongodb/bson/document/frombson.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - MongoDB\BSON\Document::fromBSON - Construct a new document instance from a BSON string - - - - &reftitle.description; - - final static public MongoDB\BSON\DocumentMongoDB\BSON\Document::fromBSON - stringbson - - - - - &reftitle.parameters; - - - bson (string) - - - A string containing a document in BSON format. - - - - - - - - &reftitle.returnvalues; - - Returns a new MongoDB\BSON\Document instance. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\UnexpectedValueException if bson is an invalid BSON string or contains more than a single document. - - - - - &reftitle.seealso; - - MongoDB\BSON\Document::fromPHP - MongoDB\BSON\Document::fromJSON - BSON Types - - - - - - diff --git a/reference/mongodb/bson/document/fromjson.xml b/reference/mongodb/bson/document/fromjson.xml deleted file mode 100644 index 23e460fb9eb8..000000000000 --- a/reference/mongodb/bson/document/fromjson.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - MongoDB\BSON\Document::fromJSON - Construct a new document instance from a JSON string - - - - &reftitle.description; - - final static public MongoDB\BSON\DocumentMongoDB\BSON\Document::fromJSON - stringjson - - - Converts an - extended JSON - string to its BSON representation. - - - - - &reftitle.parameters; - - - json (string) - - - JSON value to be converted. - - - - - - - - &reftitle.returnvalues; - - Returns a new MongoDB\BSON\Document instance. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - Throws - MongoDB\Driver\Exception\UnexpectedValueException if - the JSON value cannot be converted to a BSON document (e.g. due to a syntax - error). - - - - - - &reftitle.seealso; - - MongoDB\BSON\Document::fromPHP - MongoDB\BSON\Document::fromBSON - MongoDB Extended JSON - BSON Types - - - - - - diff --git a/reference/mongodb/bson/document/fromphp.xml b/reference/mongodb/bson/document/fromphp.xml deleted file mode 100644 index 1f6fba507429..000000000000 --- a/reference/mongodb/bson/document/fromphp.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - MongoDB\BSON\Document::fromPHP - Construct a new document instance from PHP data - - - - &reftitle.description; - - final static public MongoDB\BSON\DocumentMongoDB\BSON\Document::fromPHP - objectarrayvalue - - - - - &reftitle.parameters; - - - value (objectarray) - - - A PHP object or array containing the document. When passing an array with - numeric keys, the numeric values are converted to strings and used as - document keys. - - - - - - - - &reftitle.returnvalues; - - Returns a new MongoDB\BSON\Document instance. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\BSON\Document::fromBSON - MongoDB\BSON\Document::fromJSON - BSON Types - - - - - - diff --git a/reference/mongodb/bson/document/get.xml b/reference/mongodb/bson/document/get.xml deleted file mode 100644 index c9f4186e1f1c..000000000000 --- a/reference/mongodb/bson/document/get.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - MongoDB\BSON\Document::get - Returns the value of a key in the document - - - - &reftitle.description; - - final public mixedMongoDB\BSON\Document::get - stringkey - - - - - &reftitle.parameters; - - - key (string) - - - The key to retrieve from the document. - - - - - - - - &reftitle.returnvalues; - - Returns the value associated with the given key. If the key is not present in - the document, an exception is thrown. - - - - When encountering a value encoded as 64-bit integer in the BSON document, - the return value of this method will be a - MongoDB\BSON\Int64 instance. - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\RuntimeException if the key is not present in the document. - - - - - &reftitle.seealso; - - MongoDB\BSON\Document::has - BSON Types - - - - - - diff --git a/reference/mongodb/bson/document/getiterator.xml b/reference/mongodb/bson/document/getiterator.xml deleted file mode 100644 index 1992625f6daa..000000000000 --- a/reference/mongodb/bson/document/getiterator.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - MongoDB\BSON\Document::getIterator - Returns an iterator for the BSON document - - - - &reftitle.description; - - final public MongoDB\BSON\IteratorMongoDB\BSON\Document::getIterator - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a MongoDB\BSON\Iterator instance that can be - used to iterate over all keys in the document. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\UnexpectedValueException if the BSON iterator could not be initialized. - - - - - &reftitle.seealso; - - BSON Types - - - - - - diff --git a/reference/mongodb/bson/document/has.xml b/reference/mongodb/bson/document/has.xml deleted file mode 100644 index 88c0f473b2df..000000000000 --- a/reference/mongodb/bson/document/has.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - MongoDB\BSON\Document::has - Returns whether a key is present in the document - - - - &reftitle.description; - - final public boolMongoDB\BSON\Document::has - stringkey - - - - - &reftitle.parameters; - - - key (string) - - - The key to look for in the document. - - - - - - - - &reftitle.returnvalues; - - Returns &true; if the key is present in the document and &false; otherwise. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\BSON\Document::get - BSON Types - - - - - - diff --git a/reference/mongodb/bson/document/offsetexists.xml b/reference/mongodb/bson/document/offsetexists.xml deleted file mode 100644 index 2acc0669943f..000000000000 --- a/reference/mongodb/bson/document/offsetexists.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - MongoDB\BSON\Document::offsetExists - Returns whether a key is present in the document - - - &reftitle.description; - - final public boolMongoDB\BSON\Document::offsetExists - mixedkey - - - - - &reftitle.parameters; - - - - key - - - The key to look for in the document. - - - - - - - - - &reftitle.returnvalues; - - Returns &true; if the key is present in the document and &false; otherwise. - - - - - &reftitle.seealso; - - - ArrayAccess::offsetExists - MongoDB\BSON\Document::has - - - - - - diff --git a/reference/mongodb/bson/document/offsetget.xml b/reference/mongodb/bson/document/offsetget.xml deleted file mode 100644 index 8463b5aef5cc..000000000000 --- a/reference/mongodb/bson/document/offsetget.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - MongoDB\BSON\Document::offsetGet - Returns the value of a key in the document - - - &reftitle.description; - - final public mixedMongoDB\BSON\Document::offsetGet - mixedkey - - - - - &reftitle.parameters; - - - - key - - - The key to retrieve from the document. - - - - - - - - - &reftitle.returnvalues; - - Returns the value associated with the given key. If the key is not present in - the document, an exception is thrown. - - - - When encountering a value encoded as 64-bit integer in the BSON document, - the return value of this method will be a - MongoDB\BSON\Int64 instance. - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\RuntimeException if the key is not present in the document. - - - - - &reftitle.seealso; - - - ArrayAccess::offsetGet - MongoDB\BSON\Document::get - - - - - - diff --git a/reference/mongodb/bson/document/offsetset.xml b/reference/mongodb/bson/document/offsetset.xml deleted file mode 100644 index 9109ac6b5e76..000000000000 --- a/reference/mongodb/bson/document/offsetset.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - MongoDB\BSON\Document::offsetSet - Implementation of ArrayAccess - - - &reftitle.description; - - final public voidMongoDB\BSON\Document::offsetSet - mixedkey - mixedvalue - - - - Sets the value at the specified key to value. - - - - - &reftitle.parameters; - - - - key - - - The index being set. - - - - - value - - - The new value for the key. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - Always throws a MongoDB\Driver\Exception\LogicException. - - - - - diff --git a/reference/mongodb/bson/document/offsetunset.xml b/reference/mongodb/bson/document/offsetunset.xml deleted file mode 100644 index b175dabf8700..000000000000 --- a/reference/mongodb/bson/document/offsetunset.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - MongoDB\BSON\Document::offsetUnset - Implementation of ArrayAccess - - - &reftitle.description; - - final public voidMongoDB\BSON\Document::offsetUnset - mixedkey - - - Unsets the value at the specified index. - - - - - &reftitle.parameters; - - - - key - - - The index being unset. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - Always throws a MongoDB\Driver\Exception\LogicException. - - - - - diff --git a/reference/mongodb/bson/document/tocanonicalextendedjson.xml b/reference/mongodb/bson/document/tocanonicalextendedjson.xml deleted file mode 100644 index 55413c48df96..000000000000 --- a/reference/mongodb/bson/document/tocanonicalextendedjson.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - - MongoDB\BSON\Document::toCanonicalExtendedJSON - Returns the Canonical Extended JSON representation of the BSON document - - - - &reftitle.description; - - final public stringMongoDB\BSON\Document::toCanonicalExtendedJSON - - - - Converts the BSON document 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; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a string containing the - Canonical Extended JSON - representation of the BSON document. - - - - - &reftitle.examples; - - <methodname>MongoDB\BSON\Document::toCanonicalExtendedJSON</methodname> 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\Document::fromPHP($document); - echo $bson->toCanonicalExtendedJSON(), "\n"; -} - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\BSON\Document::fromJSON - MongoDB\BSON\Document::toRelaxedExtendedJSON - MongoDB\BSON\toCanonicalExtendedJSON - Extended JSON Specification - BSON Types - - - - - - diff --git a/reference/mongodb/bson/document/tophp.xml b/reference/mongodb/bson/document/tophp.xml deleted file mode 100644 index 3aad47e7d5e7..000000000000 --- a/reference/mongodb/bson/document/tophp.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - MongoDB\BSON\Document::toPHP - Returns the PHP representation of the BSON document - - - - &reftitle.description; - - final public arrayobjectMongoDB\BSON\Document::toPHP - arraynulltypeMap&null; - - - Unserializes the BSON document to its PHP representation. The - typeMap parameter 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; - - &mongodb.parameter.typeMap; - - - - - &reftitle.returnvalues; - - The decoded PHP value. - - - - When encountering a value encoded as 64-bit integer in the BSON document, - the return value of this method will be a - MongoDB\BSON\Int64 instance. - - - - - - &reftitle.errors; - - - Throws - MongoDB\Driver\Exception\InvalidArgumentException if - a class in the type map cannot be instantiated or does not implement - MongoDB\BSON\Unserializable. - - - - - - &reftitle.seealso; - - MongoDB\BSON\toPHP - BSON Types - - - - - - diff --git a/reference/mongodb/bson/document/torelaxedextendedjson.xml b/reference/mongodb/bson/document/torelaxedextendedjson.xml deleted file mode 100644 index 569f7a0d5754..000000000000 --- a/reference/mongodb/bson/document/torelaxedextendedjson.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - MongoDB\BSON\Document::toRelaxedExtendedJSON - Returns the Relaxed Extended JSON representation of the BSON document - - - - &reftitle.description; - - final public stringMongoDB\BSON\Document::toRelaxedExtendedJSON - - - - Converts the BSON document 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; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a string containing the - Relaxed Extended JSON - representation of the BSON document. - - - - - &reftitle.examples; - - <methodname>MongoDB\BSON\Document::toRelaxedExtendedJSON</methodname> 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\Document::fromPHP($document); - echo $bson->toRelaxedExtendedJSON(), "\n"; -} - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\BSON\Document::fromJSON - MongoDB\BSON\Document::toCanonicalExtendedJSON - MongoDB\BSON\toRelaxedExtendedJSON - Extended JSON Specification - BSON Types - - - - - - diff --git a/reference/mongodb/bson/document/tostring.xml b/reference/mongodb/bson/document/tostring.xml deleted file mode 100644 index 4cf5f2beb84f..000000000000 --- a/reference/mongodb/bson/document/tostring.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\BSON\Document::__toString - Returns the string representation of this BSON Document - - - - &reftitle.description; - - final public stringMongoDB\BSON\Document::__toString - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the string representation of this document as BSON. - - - - - &reftitle.seealso; - - BSON Types - - - - - - diff --git a/reference/mongodb/bson/int64.xml b/reference/mongodb/bson/int64.xml deleted file mode 100644 index 20696326f869..000000000000 --- a/reference/mongodb/bson/int64.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - The MongoDB\BSON\Int64 class - MongoDB\BSON\Int64 - - - - -
    - &reftitle.intro; - - BSON type for a 64-bit integer. When decoding BSON to PHP data, this class - is used when a 64-bit integer cannot be represented as a PHP integer on - 32-bit platforms. These objects support overloaded - arithmetic, - bitwise, and - comparison operators. - - - When working with raw BSON data through the - MongoDB\BSON\Document, - MongoDB\BSON\PackedArray, and - MongoDB\BSON\Iterator classes, any 64-bit integer - will be returned as an instance of this class, regardless of platform and - whether the value can be represented as a PHP integer. This ensures that - values can be roundtripped without changing the type. - - - During BSON encoding, objects of this class will convert back to a 64-bit - integer type, even when the value would fit in a 32-bit integer. This - allows explicitly storing values as 64-bit integers in BSON. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\BSON\Int64 - - - - final - - MongoDB\BSON\Int64 - - - - MongoDB\BSON\Type - - - - JsonSerializable - - - - Stringable - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.serializable-interface-removed; - - PECL mongodb 1.16.0 - - The class can now be instantiated on all platforms. Added support for - overloaded arithmetic, bitwise, and comparison operators. - - - - PECL mongodb 1.12.0 - - Implements Stringable for PHP 8.0+. - - - - - -
    - -
    - - &reference.mongodb.bson.entities.int64; - -
    - - diff --git a/reference/mongodb/bson/int64/construct.xml b/reference/mongodb/bson/int64/construct.xml deleted file mode 100644 index 955f62c20341..000000000000 --- a/reference/mongodb/bson/int64/construct.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - MongoDB\BSON\Int64::__construct - Construct a new Int64 - - - - &reftitle.description; - - final public MongoDB\BSON\Int64::__construct - intstringvalue - - - Creates a new MongoDB\BSON\Int64 instance for the - given integer value. - - - - - &reftitle.parameters; - - - value (intstring) - - - The value to assign to the Int64 instance. This - value can be provided as an int or string, the - latter being required on 32-bit platforms to represent 64-bit values. - - - - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.16.0 - - - This method was made public to support creating Int64 instances when - working with raw BSON. - - - - - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\InvalidArgumentException if string value cannot be parsed as a 64-bit integer. - - - - - &reftitle.seealso; - - BSON Types - - - - - - diff --git a/reference/mongodb/bson/int64/jsonserialize.xml b/reference/mongodb/bson/int64/jsonserialize.xml deleted file mode 100644 index b0739436e75b..000000000000 --- a/reference/mongodb/bson/int64/jsonserialize.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - MongoDB\BSON\Int64::jsonSerialize - Returns a representation that can be converted to JSON - - - - &reftitle.description; - - final public mixedMongoDB\BSON\Int64::jsonSerialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns data which can be serialized by json_encode to - produce an extended JSON representation of the - MongoDB\BSON\Int64. - - - - The output is consistent with the - MongoDB\BSON\toCanonicalExtendedJSON function, which - uses the - canonical - extended JSON format. This differs from other BSON classes, which use the - driver-specific legacy extended JSON format - (MongoDB\BSON\toJSON), in order to ensure that the - 64-bit integer value is correctly represented on 32-bit platforms. - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - JsonSerializable::jsonSerialize - json_encode - MongoDB\BSON\toCanonicalExtendedJSON - MongoDB\BSON\toRelaxedExtendedJSON - MongoDB Extended JSON - - - - - - diff --git a/reference/mongodb/bson/int64/tostring.xml b/reference/mongodb/bson/int64/tostring.xml deleted file mode 100644 index 0a8f2e5b99bf..000000000000 --- a/reference/mongodb/bson/int64/tostring.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - MongoDB\BSON\Int64::__toString - Returns the string representation of this Int64 - - - - &reftitle.description; - - final public stringMongoDB\BSON\Int64::__toString - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the string representation of this Int64. - - - - - &reftitle.examples; - - <function>MongoDB\BSON\Int64::__toString</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - BSON Types - - - - - - diff --git a/reference/mongodb/bson/iterator.xml b/reference/mongodb/bson/iterator.xml deleted file mode 100644 index 51ba20ade7fe..000000000000 --- a/reference/mongodb/bson/iterator.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - The MongoDB\BSON\Iterator class - MongoDB\BSON\Iterator - - - - -
    - &reftitle.intro; - - Iterator used to iterate a BSON document or array. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\BSON\Iterator - - - - final - - MongoDB\BSON\Iterator - - - - Iterator - - - - - &Methods; - - - - -
    - -
    - - &reference.mongodb.bson.entities.iterator; - -
    - - diff --git a/reference/mongodb/bson/iterator/construct.xml b/reference/mongodb/bson/iterator/construct.xml deleted file mode 100644 index 0c24fe263502..000000000000 --- a/reference/mongodb/bson/iterator/construct.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - MongoDB\BSON\Iterator::__construct - Construct a new BSON iterator (unused) - - - - &reftitle.description; - - final private MongoDB\BSON\Iterator::__construct - - - - MongoDB\BSON\Iterator objects are created by calling - MongoDB\BSON\Document::getIterator or - MongoDB\BSON\PackedArray::getIterator and cannot be - instantiated directly. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.seealso; - - MongoDB\BSON\Document::getIterator - MongoDB\BSON\PackedArray::getIterator - BSON Types - - - - - - diff --git a/reference/mongodb/bson/iterator/current.xml b/reference/mongodb/bson/iterator/current.xml deleted file mode 100644 index 28c3ccf329ba..000000000000 --- a/reference/mongodb/bson/iterator/current.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - MongoDB\BSON\Iterator::current - Returns the current element - - - - &reftitle.description; - - public mixedMongoDB\BSON\Iterator::current - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the value of the current element. - - - - When encountering a value encoded as 64-bit integer in the BSON structure, - the return value of this method will be a - MongoDB\BSON\Int64 instance. - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\LogicException if the iterator is not valid. - - - - - &reftitle.seealso; - - Iterator::current - - - - diff --git a/reference/mongodb/bson/iterator/key.xml b/reference/mongodb/bson/iterator/key.xml deleted file mode 100644 index 902d0f3fb29a..000000000000 --- a/reference/mongodb/bson/iterator/key.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - MongoDB\BSON\Iterator::key - Returns the key of the current element - - - - &reftitle.description; - - public stringintMongoDB\BSON\Iterator::key - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the key of the current element. When iterating a BSON document, the - key will always be a string. When iterating a BSON array, the - key will be an int. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\LogicException if the iterator is not valid. - - - - - &reftitle.seealso; - - Iterator::key - - - - diff --git a/reference/mongodb/bson/iterator/next.xml b/reference/mongodb/bson/iterator/next.xml deleted file mode 100644 index e4e1cea444d4..000000000000 --- a/reference/mongodb/bson/iterator/next.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - MongoDB\BSON\Iterator::next - Advances the iterator to next element - - - - &reftitle.description; - - public voidMongoDB\BSON\Iterator::next - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.seealso; - - Iterator::next - - - - diff --git a/reference/mongodb/bson/iterator/rewind.xml b/reference/mongodb/bson/iterator/rewind.xml deleted file mode 100644 index 3b29ba9ec01c..000000000000 --- a/reference/mongodb/bson/iterator/rewind.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - MongoDB\BSON\Iterator::rewind - Rewinds the Iterator to the first element - - - - &reftitle.description; - - public voidMongoDB\BSON\Iterator::rewind - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.seealso; - - Iterator::rewind - - - - diff --git a/reference/mongodb/bson/iterator/valid.xml b/reference/mongodb/bson/iterator/valid.xml deleted file mode 100644 index 692699c4891f..000000000000 --- a/reference/mongodb/bson/iterator/valid.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - MongoDB\BSON\Iterator::valid - Checks if current position is valid - - - - &reftitle.description; - - public boolMongoDB\BSON\Iterator::valid - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; if the current iterator position is valid, &false; otherwise. - - - - - &reftitle.seealso; - - Iterator::valid - - - - diff --git a/reference/mongodb/bson/javascript.xml b/reference/mongodb/bson/javascript.xml deleted file mode 100644 index e3f5635e66da..000000000000 --- a/reference/mongodb/bson/javascript.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - The MongoDB\BSON\Javascript class - MongoDB\BSON\Javascript - - - - -
    - &reftitle.intro; - - BSON type for Javascript code. An optional scope document may be specified - that maps identifiers to values and defines the scope in which the code - should be evaluated by the server. - - - - This BSON type is mainly used when executing database commands that take a - Javascript function as a parameter, such as - mapReduce. - - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\BSON\Javascript - - - - final - - MongoDB\BSON\Javascript - - - - MongoDB\BSON\JavascriptInterface - - - - MongoDB\BSON\Type - - - - JsonSerializable - - - - Stringable - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.serializable-interface-removed; - - PECL mongodb 1.12.0 - - Implements Stringable for PHP 8.0+. - - - - PECL mongodb 1.3.0 - - Implements MongoDB\BSON\JavascriptInterface. - - - - PECL mongodb 1.2.0 - - Implements Serializable and - JsonSerializable. - - - - - -
    - -
    - - &reference.mongodb.bson.entities.javascript; - -
    - - diff --git a/reference/mongodb/bson/javascript/construct.xml b/reference/mongodb/bson/javascript/construct.xml deleted file mode 100644 index 3ddff9dcd562..000000000000 --- a/reference/mongodb/bson/javascript/construct.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - MongoDB\BSON\Javascript::__construct - Construct a new Javascript - - - - &reftitle.description; - - final public MongoDB\BSON\Javascript::__construct - stringcode - arrayobjectnullscope&null; - - - - - &reftitle.parameters; - - - code (string) - - - Javascript code. - - - - - scope (arrayobject) - - - Javascript scope. - - - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\InvalidArgumentException if code contains null bytes. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.2.0 - - - MongoDB\Driver\Exception\InvalidArgumentException - is thrown if code contains null bytes. - Previously, values would be truncated at the first null byte. - - - - - - - - - - &reftitle.examples; - - <function>MongoDB\BSON\Javascript::__construct</function> example - - 'bar']); -var_dump($codews); - -?> -]]> - - &example.outputs; - - - string(24) "function() { return 1; }" - ["scope"]=> - object(stdClass)#2 (0) { - } -} -object(MongoDB\BSON\Javascript)#2 (2) { - ["javascript"]=> - string(26) "function() { return foo; }" - ["scope"]=> - object(stdClass)#1 (1) { - ["foo"]=> - string(3) "bar" - } -} -]]> - - - - - - - &reftitle.seealso; - - BSON Types - - - - - - diff --git a/reference/mongodb/bson/javascript/getcode.xml b/reference/mongodb/bson/javascript/getcode.xml deleted file mode 100644 index df2ed9431866..000000000000 --- a/reference/mongodb/bson/javascript/getcode.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - MongoDB\BSON\Javascript::getCode - Returns the Javascript's code - - - - &reftitle.description; - - final public stringMongoDB\BSON\Javascript::getCode - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the Javascript's code. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - <function>MongoDB\BSON\Javascript::getCode</function> example - -getCode()); - -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - BSON Types - - - - - - diff --git a/reference/mongodb/bson/javascript/getscope.xml b/reference/mongodb/bson/javascript/getscope.xml deleted file mode 100644 index 4edb7bd35460..000000000000 --- a/reference/mongodb/bson/javascript/getscope.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - MongoDB\BSON\Javascript::getScope - Returns the Javascript's scope document - - - - &reftitle.description; - - final public objectnullMongoDB\BSON\Javascript::getScope - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the Javascript's scope document, or &null; if the is no scope. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - <function>MongoDB\BSON\Javascript::getScope</function> example - -getScope()); - -$js = new MongoDB\BSON\Javascript('function foo() { return foo; }', ['foo' => 42]); -var_dump($js->getScope()); - -?> -]]> - - &example.outputs; - - - int(42) -} -]]> - - - - - - - &reftitle.seealso; - - BSON Types - - - - - - diff --git a/reference/mongodb/bson/javascript/jsonserialize.xml b/reference/mongodb/bson/javascript/jsonserialize.xml deleted file mode 100644 index 897fb6fbf4ce..000000000000 --- a/reference/mongodb/bson/javascript/jsonserialize.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - MongoDB\BSON\Javascript::jsonSerialize - Returns a representation that can be converted to JSON - - - - &reftitle.description; - - final public mixedMongoDB\BSON\Javascript::jsonSerialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns data which can be serialized by json_encode to - produce an extended JSON representation of the - MongoDB\BSON\Javascript. - - &mongodb.note.extended-json; - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - JsonSerializable::jsonSerialize - json_encode - MongoDB\BSON\toCanonicalExtendedJSON - MongoDB\BSON\toRelaxedExtendedJSON - MongoDB Extended JSON - - - - - - diff --git a/reference/mongodb/bson/javascript/tostring.xml b/reference/mongodb/bson/javascript/tostring.xml deleted file mode 100644 index ac38d5311609..000000000000 --- a/reference/mongodb/bson/javascript/tostring.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - MongoDB\BSON\Javascript::__toString - Returns the Javascript's code - - - - &reftitle.description; - - final public stringMongoDB\BSON\Javascript::__toString - - - - &info.method.alias; MongoDB\BSON\Javascript::getCode. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the Javascript's code. - - - - - &reftitle.examples; - - <function>MongoDB\BSON\Javascript::__toString</function> example - - -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - MongoDB\BSON\Javascript::getCode - BSON Types - - - - - - diff --git a/reference/mongodb/bson/javascriptinterface.xml b/reference/mongodb/bson/javascriptinterface.xml deleted file mode 100644 index e7eb147f2053..000000000000 --- a/reference/mongodb/bson/javascriptinterface.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - The MongoDB\BSON\JavascriptInterface interface - MongoDB\BSON\JavascriptInterface - - -
    - &reftitle.intro; - - This interface is implemented by - MongoDB\BSON\Javascript to be used as a parameter, - return, or property type in userland classes. - -
    - -
    - &reftitle.classsynopsis; - - MongoDB\BSON\JavascriptInterface - - - MongoDB\BSON\JavascriptInterface - - - &Methods; - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.tentative-return-types-enforced; - &mongodb.changelog.tentative-return-types; - - - -
    -
    - - &reference.mongodb.bson.entities.javascriptinterface; - -
    - - diff --git a/reference/mongodb/bson/javascriptinterface/getcode.xml b/reference/mongodb/bson/javascriptinterface/getcode.xml deleted file mode 100644 index ed08bade2a81..000000000000 --- a/reference/mongodb/bson/javascriptinterface/getcode.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\BSON\JavascriptInterface::getCode - Returns the JavascriptInterface's code - - - - &reftitle.description; - - abstract public stringMongoDB\BSON\JavascriptInterface::getCode - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the JavascriptInterface's code. - - - - - &reftitle.seealso; - - MongoDB\BSON\Javascript::getCode - - - - - - diff --git a/reference/mongodb/bson/javascriptinterface/getscope.xml b/reference/mongodb/bson/javascriptinterface/getscope.xml deleted file mode 100644 index 67b5ddbf398d..000000000000 --- a/reference/mongodb/bson/javascriptinterface/getscope.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\BSON\JavascriptInterface::getScope - Returns the JavascriptInterface's scope document - - - - &reftitle.description; - - abstract public objectnullMongoDB\BSON\JavascriptInterface::getScope - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the JavascriptInterface's scope document. - - - - - &reftitle.seealso; - - MongoDB\BSON\Javascript::getScope - - - - - - diff --git a/reference/mongodb/bson/javascriptinterface/tostring.xml b/reference/mongodb/bson/javascriptinterface/tostring.xml deleted file mode 100644 index 767fa1d2962a..000000000000 --- a/reference/mongodb/bson/javascriptinterface/tostring.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - MongoDB\BSON\JavascriptInterface::__toString - Returns the JavascriptInterface's code - - - - &reftitle.description; - - abstract public stringMongoDB\BSON\JavascriptInterface::__toString - - - - &info.method.alias; MongoDB\BSON\JavascriptInterface::getCode. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the JavascriptInterface's code. - - - - - &reftitle.seealso; - - MongoDB\BSON\JavascriptInterface::getCode - MongoDB\BSON\Javascript::__toString - - - - - - diff --git a/reference/mongodb/bson/maxkey.xml b/reference/mongodb/bson/maxkey.xml deleted file mode 100644 index c110090327e1..000000000000 --- a/reference/mongodb/bson/maxkey.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - The MongoDB\BSON\MaxKey class - MongoDB\BSON\MaxKey - - - - -
    - &reftitle.intro; - - Special BSON type which compares higher than all other possible BSON element - values. - - - - This is an internal MongoDB type used for indexing and sharding. - - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\BSON\MaxKey - - - - final - - MongoDB\BSON\MaxKey - - - - MongoDB\BSON\MaxKeyInterface - - - - MongoDB\BSON\Type - - - - JsonSerializable - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.serializable-interface-removed; - - PECL mongodb 1.3.0 - - Implements MongoDB\BSON\MaxKeyInterface. - - - - PECL mongodb 1.2.0 - - Implements Serializable and - JsonSerializable. - - - - - -
    - -
    - - &reference.mongodb.bson.entities.maxkey; - -
    - - diff --git a/reference/mongodb/bson/maxkey/construct.xml b/reference/mongodb/bson/maxkey/construct.xml deleted file mode 100644 index 5b5e25c70c3a..000000000000 --- a/reference/mongodb/bson/maxkey/construct.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - MongoDB\BSON\MaxKey::__construct - Construct a new MaxKey - - - - &reftitle.description; - - final public MongoDB\BSON\MaxKey::__construct - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - <function>MongoDB\BSON\MaxKey::__construct</function> example - - -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - BSON Types - - - - - - diff --git a/reference/mongodb/bson/maxkey/jsonserialize.xml b/reference/mongodb/bson/maxkey/jsonserialize.xml deleted file mode 100644 index b30e8d095947..000000000000 --- a/reference/mongodb/bson/maxkey/jsonserialize.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - MongoDB\BSON\MaxKey::jsonSerialize - Returns a representation that can be converted to JSON - - - - &reftitle.description; - - final public mixedMongoDB\BSON\MaxKey::jsonSerialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns data which can be serialized by json_encode to - produce an extended JSON representation of the - MongoDB\BSON\MaxKey. - - &mongodb.note.extended-json; - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - JsonSerializable::jsonSerialize - json_encode - MongoDB\BSON\toCanonicalExtendedJSON - MongoDB\BSON\toRelaxedExtendedJSON - MongoDB Extended JSON - - - - - - diff --git a/reference/mongodb/bson/maxkeyinterface.xml b/reference/mongodb/bson/maxkeyinterface.xml deleted file mode 100644 index 9a8e70a3a038..000000000000 --- a/reference/mongodb/bson/maxkeyinterface.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - The MongoDB\BSON\MaxKeyInterface interface - MongoDB\BSON\MaxKeyInterface - - -
    - &reftitle.intro; - - This interface is implemented by MongoDB\BSON\MaxKey - to be used as a parameter, return, or property type in userland classes. - -
    - -
    - &reftitle.classsynopsis; - - MongoDB\BSON\MaxKeyInterface - - - MongoDB\BSON\MaxKeyInterface - - - - - - This interface has no methods. - -
    -
    - -
    - - diff --git a/reference/mongodb/bson/minkey.xml b/reference/mongodb/bson/minkey.xml deleted file mode 100644 index e0b8ec05686c..000000000000 --- a/reference/mongodb/bson/minkey.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - The MongoDB\BSON\MinKey class - MongoDB\BSON\MinKey - - - - -
    - &reftitle.intro; - - Special BSON type which compares lower than all other possible BSON element - values. - - - - This is an internal MongoDB type used for indexing and sharding. - - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\BSON\MinKey - - - - final - - MongoDB\BSON\MinKey - - - - MongoDB\BSON\MinKeyInterface - - - - MongoDB\BSON\Type - - - - JsonSerializable - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.serializable-interface-removed; - - PECL mongodb 1.3.0 - - Implements MongoDB\BSON\MinKeyInterface. - - - - PECL mongodb 1.2.0 - - Implements Serializable and - JsonSerializable. - - - - - -
    - -
    - - &reference.mongodb.bson.entities.minkey; - -
    - - diff --git a/reference/mongodb/bson/minkey/construct.xml b/reference/mongodb/bson/minkey/construct.xml deleted file mode 100644 index 6d7ceae548b4..000000000000 --- a/reference/mongodb/bson/minkey/construct.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - MongoDB\BSON\MinKey::__construct - Construct a new MinKey - - - - &reftitle.description; - - final public MongoDB\BSON\MinKey::__construct - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - <function>MongoDB\BSON\MinKey::__construct</function> example - - -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - BSON Types - - - - - - diff --git a/reference/mongodb/bson/minkey/jsonserialize.xml b/reference/mongodb/bson/minkey/jsonserialize.xml deleted file mode 100644 index 2ed71f5f0089..000000000000 --- a/reference/mongodb/bson/minkey/jsonserialize.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - MongoDB\BSON\MinKey::jsonSerialize - Returns a representation that can be converted to JSON - - - - &reftitle.description; - - final public mixedMongoDB\BSON\MinKey::jsonSerialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns data which can be serialized by json_encode to - produce an extended JSON representation of the - MongoDB\BSON\MinKey. - - &mongodb.note.extended-json; - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - JsonSerializable::jsonSerialize - json_encode - MongoDB\BSON\toCanonicalExtendedJSON - MongoDB\BSON\toRelaxedExtendedJSON - MongoDB Extended JSON - - - - - - diff --git a/reference/mongodb/bson/minkeyinterface.xml b/reference/mongodb/bson/minkeyinterface.xml deleted file mode 100644 index a8a4dbd81c34..000000000000 --- a/reference/mongodb/bson/minkeyinterface.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - The MongoDB\BSON\MinKeyInterface interface - MongoDB\BSON\MinKeyInterface - - -
    - &reftitle.intro; - - This interface is implemented by MongoDB\BSON\MinKey - to be used as a parameter, return, or property type in userland classes. - -
    - -
    - &reftitle.classsynopsis; - - MongoDB\BSON\MinKeyInterface - - - MongoDB\BSON\MinKeyInterface - - - - - - This interface has no methods. - -
    -
    - -
    - - diff --git a/reference/mongodb/bson/objectid.xml b/reference/mongodb/bson/objectid.xml deleted file mode 100644 index cdc091b9c1dd..000000000000 --- a/reference/mongodb/bson/objectid.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - The MongoDB\BSON\ObjectId class - MongoDB\BSON\ObjectId - - - - -
    - &reftitle.intro; - - BSON type for an - ObjectId. The - value consists of 12 bytes, where the first four bytes are a timestamp - that reflect the ObjectId's creation. Specifically, the value consists of: - - - a 4-byte value representing the seconds since the Unix epoch, - a 5-byte random number unique to a machine and process, and - a 3-byte counter, starting with a random value. - - - In MongoDB, each document stored in a collection requires a unique - _id field that acts as a primary key. If an inserted - document omits the _id field, the extension automatically - generates an ObjectId for the _id field. - - - Using ObjectIds for the _id field provides the following - additional benefits: - - - The creation time of the ObjectId may be accessed using the MongoDB\BSON\ObjectId::getTimestamp method. - Sorting on an _id field that stores ObjectId values is roughly equivalent to sorting by creation time. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\BSON\ObjectId - - - - final - - MongoDB\BSON\ObjectId - - - - MongoDB\BSON\ObjectIdInterface - - - - MongoDB\BSON\Type - - - - JsonSerializable - - - - Stringable - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.serializable-interface-removed; - - PECL mongodb 1.12.0 - - Implements Stringable for PHP 8.0+. - - - - PECL mongodb 1.3.0 - - - Renamed from MongoDB\BSON\ObjectID to - MongoDB\BSON\ObjectId. - - - Implements MongoDB\BSON\ObjectIdInterface. - - - - - PECL mongodb 1.2.0 - - Implements Serializable and - JsonSerializable. - - - - - -
    - -
    - - &reference.mongodb.bson.entities.objectid; - -
    - - diff --git a/reference/mongodb/bson/objectid/construct.xml b/reference/mongodb/bson/objectid/construct.xml deleted file mode 100644 index e47250b04d54..000000000000 --- a/reference/mongodb/bson/objectid/construct.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - MongoDB\BSON\ObjectId::__construct - Construct a new ObjectId - - - - &reftitle.description; - - final public MongoDB\BSON\ObjectId::__construct - stringnullid&null; - - - - - &reftitle.parameters; - - - id (string) - - - A 24-character hexadecimal string. If not provided, the extension will - generate an ObjectId. - - - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\InvalidArgumentException if id is not a 24-character hexadecimal string. - - - - - - &reftitle.examples; - - <function>MongoDB\BSON\ObjectId::__construct</function> example - - -]]> - - &example.outputs.similar; - - - string(24) "56732d3dda14d81214634921" -} -object(MongoDB\BSON\ObjectId)#1 (1) { - ["oid"]=> - string(24) "000000000000000000000001" -} - -]]> - - - - - - - &reftitle.seealso; - - ObjectId Reference - BSON Types: ObjectId - - - - - - diff --git a/reference/mongodb/bson/objectid/gettimestamp.xml b/reference/mongodb/bson/objectid/gettimestamp.xml deleted file mode 100644 index 692ebfb8f265..000000000000 --- a/reference/mongodb/bson/objectid/gettimestamp.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - MongoDB\BSON\ObjectId::getTimestamp - Returns the timestamp component of this ObjectId - - - - &reftitle.description; - - final public intMongoDB\BSON\ObjectId::getTimestamp - - - - The timestamp component of an ObjectId is its most significant 32 bits, which - denotes the number of seconds since the Unix epoch. This value is read as an - unsigned 32-bit integer with big-endian byte order. - - &mongodb.note.uint32; - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the timestamp component of this ObjectId. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - <function>MongoDB\BSON\ObjectId::getTimestamp</function> example - -getTimestamp()); - -var_dump((new MongoDB\BSON\ObjectId('0000002a0000000000000000'))->getTimestamp()); - -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - ObjectId Reference - BSON Types: ObjectId - - - - - - diff --git a/reference/mongodb/bson/objectid/jsonserialize.xml b/reference/mongodb/bson/objectid/jsonserialize.xml deleted file mode 100644 index a1da1e483737..000000000000 --- a/reference/mongodb/bson/objectid/jsonserialize.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - MongoDB\BSON\ObjectId::jsonSerialize - Returns a representation that can be converted to JSON - - - - &reftitle.description; - - final public mixedMongoDB\BSON\ObjectId::jsonSerialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns data which can be serialized by json_encode to - produce an extended JSON representation of the - MongoDB\BSON\ObjectId. - - &mongodb.note.extended-json; - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - JsonSerializable::jsonSerialize - json_encode - MongoDB\BSON\toCanonicalExtendedJSON - MongoDB\BSON\toRelaxedExtendedJSON - MongoDB Extended JSON - - - - - - diff --git a/reference/mongodb/bson/objectid/tostring.xml b/reference/mongodb/bson/objectid/tostring.xml deleted file mode 100644 index 30d1f95e28b3..000000000000 --- a/reference/mongodb/bson/objectid/tostring.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - MongoDB\BSON\ObjectId::__toString - Returns the hexadecimal representation of this ObjectId - - - - &reftitle.description; - - final public stringMongoDB\BSON\ObjectId::__toString - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the hexadecimal representation of this ObjectId. - - - - - &reftitle.examples; - - <function>MongoDB\BSON\ObjectId::__toString</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - ObjectId Reference - BSON Types: ObjectId - - - - - - diff --git a/reference/mongodb/bson/objectidinterface.xml b/reference/mongodb/bson/objectidinterface.xml deleted file mode 100644 index 5bd8a81d848a..000000000000 --- a/reference/mongodb/bson/objectidinterface.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - The MongoDB\BSON\ObjectIdInterface interface - MongoDB\BSON\ObjectIdInterface - - -
    - &reftitle.intro; - - This interface is implemented by - MongoDB\BSON\ObjectId to be used as a parameter, - return, or property type in userland classes. - -
    - -
    - &reftitle.classsynopsis; - - MongoDB\BSON\ObjectIdInterface - - - MongoDB\BSON\ObjectIdInterface - - - &Methods; - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.tentative-return-types-enforced; - &mongodb.changelog.tentative-return-types; - - - -
    -
    - - &reference.mongodb.bson.entities.objectidinterface; - -
    - - diff --git a/reference/mongodb/bson/objectidinterface/gettimestamp.xml b/reference/mongodb/bson/objectidinterface/gettimestamp.xml deleted file mode 100644 index c9fc395c18a3..000000000000 --- a/reference/mongodb/bson/objectidinterface/gettimestamp.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\BSON\ObjectIdInterface::getTimestamp - Returns the timestamp component of this ObjectIdInterface - - - - &reftitle.description; - - abstract public intMongoDB\BSON\ObjectIdInterface::getTimestamp - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the timestamp component of this ObjectIdInterface. - - - - - &reftitle.seealso; - - MongoDB\BSON\ObjectId::getTimestamp - - - - - - diff --git a/reference/mongodb/bson/objectidinterface/tostring.xml b/reference/mongodb/bson/objectidinterface/tostring.xml deleted file mode 100644 index 2ddb803d845f..000000000000 --- a/reference/mongodb/bson/objectidinterface/tostring.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\BSON\ObjectIdInterface::__toString - Returns the hexadecimal representation of this ObjectIdInterface - - - - &reftitle.description; - - abstract public stringMongoDB\BSON\ObjectIdInterface::__toString - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the hexadecimal representation of this ObjectIdInterface. - - - - - &reftitle.seealso; - - MongoDB\BSON\ObjectId::__toString - - - - - - diff --git a/reference/mongodb/bson/packedarray.xml b/reference/mongodb/bson/packedarray.xml deleted file mode 100644 index 4ec141476f51..000000000000 --- a/reference/mongodb/bson/packedarray.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - The MongoDB\BSON\PackedArray class - MongoDB\BSON\PackedArray - - - - -
    - &reftitle.intro; - - Represents a BSON array. This class is used when reading data as raw BSON - and cannot be modified. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\BSON\PackedArray - - - - final - - MongoDB\BSON\PackedArray - - - - MongoDB\BSON\Type - - - - ArrayAccess - - - - IteratorAggregate - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.serializable-interface-removed; - - PECL mongodb 1.17.0 - - Implements MongoDB\BSON\Type. - - - - PECL mongodb 1.17.0 - - MongoDB\BSON\PackedArray cannot be serialized - in contexts where a BSON document is expected. In earlier versions, - the BSON array would have been converted to a document. - - - - - -
    - -
    - - &reference.mongodb.bson.entities.packedarray; - -
    - - diff --git a/reference/mongodb/bson/packedarray/construct.xml b/reference/mongodb/bson/packedarray/construct.xml deleted file mode 100644 index c00592605b64..000000000000 --- a/reference/mongodb/bson/packedarray/construct.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - MongoDB\BSON\PackedArray::__construct - Construct a new BSON array (unused) - - - - &reftitle.description; - - final private MongoDB\BSON\PackedArray::__construct - - - - MongoDB\BSON\PackedArray objects are created through - static factory methods and cannot be instantiated directly. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.seealso; - - MongoDB\BSON\PackedArray::fromPHP - BSON Types - - - - - - diff --git a/reference/mongodb/bson/packedarray/fromjson.xml b/reference/mongodb/bson/packedarray/fromjson.xml deleted file mode 100644 index d671f426d6c6..000000000000 --- a/reference/mongodb/bson/packedarray/fromjson.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - MongoDB\BSON\PackedArray::fromJSON - Construct a new BSON array instance from a JSON string - - - - &reftitle.description; - - final static public MongoDB\BSON\PackedArrayMongoDB\BSON\PackedArray::fromJSON - stringjson - - - Converts an - extended JSON - string to its BSON representation. - - - - - &reftitle.parameters; - - - json (string) - - - JSON value to be converted. - - - - - - - - &reftitle.returnvalues; - - Returns a new MongoDB\BSON\PackedArray instance. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - Throws - MongoDB\Driver\Exception\UnexpectedValueException if - the JSON value cannot be converted to a BSON array (e.g. due to a syntax - error). - - - - - - &reftitle.examples; - - <methodname>MongoDB\BSON\PackedArray::fromJSON</methodname> example - - -]]> - - &example.outputs; - - - string(68) "MQAAAAIwAAQAAABmb28AEDEAewAAABIyAP////8AAAAABzMAVjFafGEY/RuSAnCxAA==" - ["value"]=> - array(4) { - [0]=> - string(3) "foo" - [1]=> - int(123) - [2]=> - int(4294967295) - [3]=> - object(MongoDB\BSON\ObjectId)#2 (1) { - ["oid"]=> - string(24) "56315a7c6118fd1b920270b1" - } - } -} -]]> - - - - - - &reftitle.seealso; - - MongoDB\BSON\PackedArray::fromPHP - MongoDB Extended JSON - BSON Types - - - - - diff --git a/reference/mongodb/bson/packedarray/fromphp.xml b/reference/mongodb/bson/packedarray/fromphp.xml deleted file mode 100644 index aaa46329e4f5..000000000000 --- a/reference/mongodb/bson/packedarray/fromphp.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - MongoDB\BSON\PackedArray::fromPHP - Construct a new BSON array instance from PHP data - - - - &reftitle.description; - - final static public MongoDB\BSON\PackedArrayMongoDB\BSON\PackedArray::fromPHP - arrayvalue - - - - - &reftitle.parameters; - - - value (array) - - - The PHP array to convert to a BSON array. The array must be a list (i.e. - have sequential numeric keys starting with 0). - - - - - - - - &reftitle.returnvalues; - - Returns a new MongoDB\BSON\PackedArray instance. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\InvalidArgumentException if the given array is not a list (i.e. has sequential numeric keys starting with 0). - - - - - &reftitle.seealso; - - BSON Types - - - - - - diff --git a/reference/mongodb/bson/packedarray/get.xml b/reference/mongodb/bson/packedarray/get.xml deleted file mode 100644 index 6f89e44cb7ee..000000000000 --- a/reference/mongodb/bson/packedarray/get.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - MongoDB\BSON\PackedArray::get - Returns the value of an index in the array - - - - &reftitle.description; - - final public mixedMongoDB\BSON\PackedArray::get - intkey - - - - - &reftitle.parameters; - - - key (int) - - - The index to retrieve from the array. - - - - - - - - &reftitle.returnvalues; - - Returns the value associated with the given index. If the index is not - present in the array, an exception is thrown. - - - - When encountering a value encoded as 64-bit integer in the BSON array, - the return value of this method will be a - MongoDB\BSON\Int64 instance. - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\RuntimeException if the index is not present in the array. - - - - - &reftitle.seealso; - - MongoDB\BSON\PackedArray::has - BSON Types - - - - - - diff --git a/reference/mongodb/bson/packedarray/getiterator.xml b/reference/mongodb/bson/packedarray/getiterator.xml deleted file mode 100644 index a96fd1a1d684..000000000000 --- a/reference/mongodb/bson/packedarray/getiterator.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - MongoDB\BSON\PackedArray::getIterator - Returns an iterator for the BSON array - - - - &reftitle.description; - - final public MongoDB\BSON\IteratorMongoDB\BSON\PackedArray::getIterator - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a MongoDB\BSON\Iterator instance that can be - used to iterate over all indexes in the array. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\UnexpectedValueException if the BSON iterator could not be initialized. - - - - - &reftitle.seealso; - - BSON Types - - - - - - diff --git a/reference/mongodb/bson/packedarray/has.xml b/reference/mongodb/bson/packedarray/has.xml deleted file mode 100644 index bea5d2aa26f5..000000000000 --- a/reference/mongodb/bson/packedarray/has.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - MongoDB\BSON\PackedArray::has - Returns whether a index is present in the array - - - - &reftitle.description; - - final public boolMongoDB\BSON\PackedArray::has - intindex - - - - - &reftitle.parameters; - - - index (int) - - - The index to look for in the array. - - - - - - - - &reftitle.returnvalues; - - Returns &true; if the index is present in the array and &false; otherwise. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\BSON\PackedArray::get - BSON Types - - - - - - diff --git a/reference/mongodb/bson/packedarray/offsetexists.xml b/reference/mongodb/bson/packedarray/offsetexists.xml deleted file mode 100644 index 7f2ff74a8568..000000000000 --- a/reference/mongodb/bson/packedarray/offsetexists.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - MongoDB\BSON\PackedArray::offsetExists - Returns whether a index is present in the array - - - &reftitle.description; - - final public boolMongoDB\BSON\PackedArray::offsetExists - mixedkey - - - - - &reftitle.parameters; - - - - key - - - The index to look for in the array. - - - - - - - - - &reftitle.returnvalues; - - Returns &true; if the index is present in the array and &false; otherwise. - - - - - &reftitle.seealso; - - - ArrayAccess::offsetExists - MongoDB\BSON\PackedArray::has - - - - - - diff --git a/reference/mongodb/bson/packedarray/offsetget.xml b/reference/mongodb/bson/packedarray/offsetget.xml deleted file mode 100644 index 46b38b6fdc3f..000000000000 --- a/reference/mongodb/bson/packedarray/offsetget.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - MongoDB\BSON\PackedArray::offsetGet - Returns the value of an index in the array - - - &reftitle.description; - - final public mixedMongoDB\BSON\PackedArray::offsetGet - mixedkey - - - - - &reftitle.parameters; - - - - key - - - The index to retrieve from the array. Only int is supported. - - - - - - - - - &reftitle.returnvalues; - - Returns the value associated with the given index. If the index is not - present in the array, an exception is thrown. - - - - When encountering a value encoded as 64-bit integer in the BSON array, - the return value of this method will be a - MongoDB\BSON\Int64 instance. - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\RuntimeException if the index is not present in the array. - - - - - &reftitle.seealso; - - - ArrayAccess::offsetGet - MongoDB\BSON\PackedArray::get - - - - - - diff --git a/reference/mongodb/bson/packedarray/offsetset.xml b/reference/mongodb/bson/packedarray/offsetset.xml deleted file mode 100644 index edf95ca9dce2..000000000000 --- a/reference/mongodb/bson/packedarray/offsetset.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - MongoDB\BSON\PackedArray::offsetSet - Implementation of ArrayAccess - - - &reftitle.description; - - final public voidMongoDB\BSON\PackedArray::offsetSet - mixedkey - mixedvalue - - - - Sets the value at the specified key to value. - - - - - &reftitle.parameters; - - - - key - - - The index being set. - - - - - value - - - The new value for the key. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - Always throws a MongoDB\Driver\Exception\LogicException. - - - - - diff --git a/reference/mongodb/bson/packedarray/offsetunset.xml b/reference/mongodb/bson/packedarray/offsetunset.xml deleted file mode 100644 index 6ecaead40668..000000000000 --- a/reference/mongodb/bson/packedarray/offsetunset.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - MongoDB\BSON\PackedArray::offsetUnset - Implementation of ArrayAccess - - - &reftitle.description; - - final public voidMongoDB\BSON\PackedArray::offsetUnset - mixedkey - - - Unsets the value at the specified index. - - - - - &reftitle.parameters; - - - - key - - - The index being unset. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - Always throws a MongoDB\Driver\Exception\LogicException. - - - - - diff --git a/reference/mongodb/bson/packedarray/tocanonicalextendedjson.xml b/reference/mongodb/bson/packedarray/tocanonicalextendedjson.xml deleted file mode 100644 index 59d5d8c6c9ca..000000000000 --- a/reference/mongodb/bson/packedarray/tocanonicalextendedjson.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - MongoDB\BSON\PackedArray::toCanonicalExtendedJSON - Returns the Canonical Extended JSON representation of the BSON array - - - - &reftitle.description; - - final public stringMongoDB\BSON\PackedArray::toCanonicalExtendedJSON - - - - Converts the BSON array 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; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a string containing the - Canonical Extended JSON - representation of the BSON array. - - - - - &reftitle.examples; - - <methodname>MongoDB\BSON\PackedArray::toCanonicalExtendedJSON</methodname> example - - toCanonicalExtendedJSON(), "\n"; - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\BSON\PackedArray::fromJSON - MongoDB\BSON\PackedArray::toRelaxedExtendedJSON - MongoDB\BSON\toCanonicalExtendedJSON - Extended JSON Specification - BSON Types - - - - - diff --git a/reference/mongodb/bson/packedarray/tophp.xml b/reference/mongodb/bson/packedarray/tophp.xml deleted file mode 100644 index 45304188f1bd..000000000000 --- a/reference/mongodb/bson/packedarray/tophp.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - MongoDB\BSON\PackedArray::toPHP - Returns the PHP representation of the BSON array - - - - &reftitle.description; - - final public arrayobjectMongoDB\BSON\PackedArray::toPHP - arraynulltypeMap&null; - - - - - &reftitle.parameters; - - &mongodb.parameter.typeMap; - - - - - &reftitle.returnvalues; - - The decoded PHP value. - - - - When encountering a value encoded as 64-bit integer in the BSON array, - the return value of this method will be a - MongoDB\BSON\Int64 instance. - - - - - - &reftitle.errors; - - - Throws - MongoDB\Driver\Exception\InvalidArgumentException if - a class in the type map cannot be instantiated or does not implement - MongoDB\BSON\Unserializable. - - - - - - &reftitle.seealso; - - MongoDB\BSON\toPHP - BSON Types - - - - - - diff --git a/reference/mongodb/bson/packedarray/torelaxedextendedjson.xml b/reference/mongodb/bson/packedarray/torelaxedextendedjson.xml deleted file mode 100644 index c59f74b06b9b..000000000000 --- a/reference/mongodb/bson/packedarray/torelaxedextendedjson.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - MongoDB\BSON\PackedArray::toRelaxedExtendedJSON - Returns the Relaxed Extended JSON representation of the BSON array - - - - &reftitle.description; - - final public stringMongoDB\BSON\PackedArray::toRelaxedExtendedJSON - - - - Converts the BSON array 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; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a string containing the - Relaxed Extended JSON - representation of the BSON array. - - - - - &reftitle.examples; - - <methodname>MongoDB\BSON\PackedArray::toRelaxedExtendedJSON</methodname> example - - toRelaxedExtendedJSON(), "\n"; - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\BSON\PackedArray::fromJSON - MongoDB\BSON\PackedArray::toCanonicalExtendedJSON - MongoDB\BSON\toRelaxedExtendedJSON - Extended JSON Specification - BSON Types - - - - - diff --git a/reference/mongodb/bson/packedarray/tostring.xml b/reference/mongodb/bson/packedarray/tostring.xml deleted file mode 100644 index f0ae7dddec6f..000000000000 --- a/reference/mongodb/bson/packedarray/tostring.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\BSON\PackedArray::__toString - Returns the string representation of this BSON array - - - - &reftitle.description; - - final public stringMongoDB\BSON\PackedArray::__toString - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the string representation of this array as BSON. - - - - - &reftitle.seealso; - - BSON Types - - - - - - diff --git a/reference/mongodb/bson/persistable.xml b/reference/mongodb/bson/persistable.xml deleted file mode 100644 index 38a65446953e..000000000000 --- a/reference/mongodb/bson/persistable.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - The MongoDB\BSON\Persistable interface - MongoDB\BSON\Persistable - - - - -
    - &reftitle.intro; - - Classes may implement this interface to take advantage of automatic ODM - (object document mapping) behavior in the extension. During serialization, - the extension will inject a __pclass property - containing the PHP class name into the data returned by - MongoDB\BSON\Serializable::bsonSerialize. During - unserialization, the same __pclass property will then - be used to infer the PHP class (independent of any - type map configuration) - to be constructed before - MongoDB\BSON\Unserializable::bsonUnserialize is - invoked. See for additional - information. - - - - Even if MongoDB\BSON\Serializable::bsonSerialize would - return a sequential array, injection of the __pclass - property will cause the object to be serialized as a BSON document. - - -
    - - -
    - &reftitle.interfacesynopsis; - - - - MongoDB\BSON\Persistable - - - - - MongoDB\BSON\Persistable - - - - MongoDB\BSON\Unserializable - - - - MongoDB\BSON\Serializable - - - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -
    - - &reference.mongodb.bson.entities.persistable; - -
    - - diff --git a/reference/mongodb/bson/persistable/bsonserialize.xml b/reference/mongodb/bson/persistable/bsonserialize.xml deleted file mode 100644 index 1990b5c92473..000000000000 --- a/reference/mongodb/bson/persistable/bsonserialize.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - MongoDB\BSON\Persistable::bsonSerialize - Provides an array or document to serialize as BSON - - - - &reftitle.description; - - abstract public arraystdClassMongoDB\BSON\DocumentMongoDB\BSON\Persistable::bsonSerialize - - - - Called during serialization of the object to BSON. The method must return an - array, stdClass, or - MongoDB\BSON\Document. - - - The return value will always be serialized as a BSON document. The serialized - document will include a field containing the class name of the object. For - this reason, it is not possible to return a - MongoDB\BSON\PackedArray instance in this method. - - - Users are encouraged to include an _id property (e.g. a - MongoDB\BSON\ObjectId initialized in the constructor) - when returning data for a BSON root document. In the absence of an - _id property, the extension or server will generate a - MongoDB\BSON\ObjectId for insert or upsert - operations, respectively. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - An array, stdClass, or MongoDB\BSON\Document - to be serialized as a BSON document. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.tentative-return-types-enforced; - - PECL mongodb 1.17.0 - - - This method may now also return MongoDB\BSON\Document - instances in addition to array and stdClass. - - - - - - - - - - &reftitle.seealso; - - MongoDB\BSON\Serializable::bsonSerialize - MongoDB\BSON\Unserializable::bsonUnserialize - MongoDB\BSON\Persistable - - - - - - - diff --git a/reference/mongodb/bson/regex.xml b/reference/mongodb/bson/regex.xml deleted file mode 100644 index aba85a913103..000000000000 --- a/reference/mongodb/bson/regex.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - The MongoDB\BSON\Regex class - MongoDB\BSON\Regex - - - - -
    - &reftitle.intro; - - BSON type for a regular expression pattern and optional - flags. - - - - This BSON type is mainly used when querying the database. Alternatively, - the - $regex - query operator may be used. - - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\BSON\Regex - - - - final - - MongoDB\BSON\Regex - - - - MongoDB\BSON\RegexInterface - - - - MongoDB\BSON\Type - - - - JsonSerializable - - - - Stringable - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.serializable-interface-removed; - - PECL mongodb 1.12.0 - - Implements Stringable for PHP 8.0+. - - - - PECL mongodb 1.3.0 - - Implements MongoDB\BSON\RegexInterface. - - - - PECL mongodb 1.2.0 - - Implements Serializable and - JsonSerializable. - - - - - -
    - -
    - - &reference.mongodb.bson.entities.regex; - -
    - - diff --git a/reference/mongodb/bson/regex/construct.xml b/reference/mongodb/bson/regex/construct.xml deleted file mode 100644 index b22c5ce9b32d..000000000000 --- a/reference/mongodb/bson/regex/construct.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - - MongoDB\BSON\Regex::__construct - Construct a new Regex - - - - &reftitle.description; - - final public MongoDB\BSON\Regex::__construct - stringpattern - stringflags"" - - - - - &reftitle.parameters; - - - pattern (string) - - - The regular expression pattern. - - - - The pattern should not be wrapped with delimiter characters. - - - - - - flags (string) - - - The regular - expression flags. Characters in this argument will be sorted - alphabetically. - - - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\InvalidArgumentException if pattern or flags contain null bytes. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.2.0 - - - The flags argument is optional and defaults to - an empty string. - - - Characters in the flags argument will be sorted - alphabetically when a Regex is constructed. Previously, the characters - were stored in the order provided. - - - MongoDB\Driver\Exception\InvalidArgumentException - is thrown if pattern or - flags contain null bytes. Previously, values - would be truncated at the first null byte. - - - - - - - - - - &reftitle.examples; - - <function>MongoDB\BSON\Regex::__construct</function> example - - -]]> - - &example.outputs; - - - string(4) "^foo" - ["flags"]=> - string(1) "i" -} -]]> - - - - - - - &reftitle.seealso; - - BSON Types - Supported regular expression flags - - - - - - diff --git a/reference/mongodb/bson/regex/getflags.xml b/reference/mongodb/bson/regex/getflags.xml deleted file mode 100644 index a1c375c3868c..000000000000 --- a/reference/mongodb/bson/regex/getflags.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - MongoDB\BSON\Regex::getFlags - Returns the Regex's flags - - - - &reftitle.description; - - final public stringMongoDB\BSON\Regex::getFlags - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the Regex's flags. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - <function>MongoDB\BSON\Regex::getFlags</function> example - -getFlags()); - -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - BSON Types - Supported regular expression flags - - - - - - diff --git a/reference/mongodb/bson/regex/getpattern.xml b/reference/mongodb/bson/regex/getpattern.xml deleted file mode 100644 index 5b7457fa9c01..000000000000 --- a/reference/mongodb/bson/regex/getpattern.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - MongoDB\BSON\Regex::getPattern - Returns the Regex's pattern - - - - &reftitle.description; - - final public stringMongoDB\BSON\Regex::getPattern - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the Regex's pattern. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - <function>MongoDB\BSON\Regex::getPattern</function> example - -getPattern()); - -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - BSON Types - - - - - - diff --git a/reference/mongodb/bson/regex/jsonserialize.xml b/reference/mongodb/bson/regex/jsonserialize.xml deleted file mode 100644 index 5ad23a0a6868..000000000000 --- a/reference/mongodb/bson/regex/jsonserialize.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - MongoDB\BSON\Regex::jsonSerialize - Returns a representation that can be converted to JSON - - - - &reftitle.description; - - final public mixedMongoDB\BSON\Regex::jsonSerialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns data which can be serialized by json_encode to - produce an extended JSON representation of the - MongoDB\BSON\Regex. - - &mongodb.note.extended-json; - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - JsonSerializable::jsonSerialize - json_encode - MongoDB\BSON\toCanonicalExtendedJSON - MongoDB\BSON\toRelaxedExtendedJSON - MongoDB Extended JSON - - - - - - diff --git a/reference/mongodb/bson/regex/tostring.xml b/reference/mongodb/bson/regex/tostring.xml deleted file mode 100644 index 951f5db64c25..000000000000 --- a/reference/mongodb/bson/regex/tostring.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - MongoDB\BSON\Regex::__toString - Returns the string representation of this Regex - - - - &reftitle.description; - - final public stringMongoDB\BSON\Regex::__toString - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the string representation of this Regex. - - - - - &reftitle.examples; - - <function>MongoDB\BSON\Regex::__toString</function> example - - -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - BSON Types - - - - - - diff --git a/reference/mongodb/bson/regexinterface.xml b/reference/mongodb/bson/regexinterface.xml deleted file mode 100644 index e1764c5360f1..000000000000 --- a/reference/mongodb/bson/regexinterface.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - The MongoDB\BSON\RegexInterface interface - MongoDB\BSON\RegexInterface - - -
    - &reftitle.intro; - - This interface is implemented by MongoDB\BSON\Regex - to be used as a parameter, return, or property type in userland classes. - -
    - -
    - &reftitle.classsynopsis; - - MongoDB\BSON\RegexInterface - - - MongoDB\BSON\RegexInterface - - - &Methods; - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.tentative-return-types-enforced; - &mongodb.changelog.tentative-return-types; - - - -
    -
    - - &reference.mongodb.bson.entities.regexinterface; - -
    - - diff --git a/reference/mongodb/bson/regexinterface/getflags.xml b/reference/mongodb/bson/regexinterface/getflags.xml deleted file mode 100644 index 9dc14aaa4c44..000000000000 --- a/reference/mongodb/bson/regexinterface/getflags.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\BSON\RegexInterface::getFlags - Returns the RegexInterface's flags - - - - &reftitle.description; - - abstract public stringMongoDB\BSON\RegexInterface::getFlags - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the RegexInterface's flags. - - - - - &reftitle.seealso; - - MongoDB\BSON\Regex::getFlags - - - - - - diff --git a/reference/mongodb/bson/regexinterface/getpattern.xml b/reference/mongodb/bson/regexinterface/getpattern.xml deleted file mode 100644 index c4a027f50e9a..000000000000 --- a/reference/mongodb/bson/regexinterface/getpattern.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\BSON\RegexInterface::getPattern - Returns the RegexInterface's pattern - - - - &reftitle.description; - - abstract public stringMongoDB\BSON\RegexInterface::getPattern - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the RegexInterface's pattern. - - - - - &reftitle.seealso; - - MongoDB\BSON\Regex::getPattern - - - - - - diff --git a/reference/mongodb/bson/regexinterface/tostring.xml b/reference/mongodb/bson/regexinterface/tostring.xml deleted file mode 100644 index dced9001cf33..000000000000 --- a/reference/mongodb/bson/regexinterface/tostring.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\BSON\RegexInterface::__toString - Returns the string representation of this RegexInterface - - - - &reftitle.description; - - abstract public stringMongoDB\BSON\RegexInterface::__toString - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the string representation of this RegexInterface. - - - - - &reftitle.seealso; - - MongoDB\BSON\Regex::__toString - - - - - - diff --git a/reference/mongodb/bson/serializable.xml b/reference/mongodb/bson/serializable.xml deleted file mode 100644 index c422b91541d9..000000000000 --- a/reference/mongodb/bson/serializable.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - The MongoDB\BSON\Serializable interface - MongoDB\BSON\Serializable - - - - -
    - &reftitle.intro; - - Classes that implement this interface may return data to be serialized as a - BSON array or document in lieu of the object's public properties. - -
    - - -
    - &reftitle.interfacesynopsis; - - - - MongoDB\BSON\Serializable - - - - - MongoDB\BSON\Serializable - - - - MongoDB\BSON\Type - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.tentative-return-types-enforced; - &mongodb.changelog.tentative-return-types; - - - -
    -
    - - &reference.mongodb.bson.entities.serializable; - -
    - - diff --git a/reference/mongodb/bson/serializable/bsonserialize.xml b/reference/mongodb/bson/serializable/bsonserialize.xml deleted file mode 100644 index bdf8e55d5089..000000000000 --- a/reference/mongodb/bson/serializable/bsonserialize.xml +++ /dev/null @@ -1,245 +0,0 @@ - - - - - - MongoDB\BSON\Serializable::bsonSerialize - Provides an array or document to serialize as BSON - - - - &reftitle.description; - - abstract public arraystdClassMongoDB\BSON\DocumentMongoDB\BSON\PackedArrayMongoDB\BSON\Serializable::bsonSerialize - - - - Called during serialization of the object to BSON. The method must return an - array, stdClass, MongoDB\BSON\Document, - or MongoDB\BSON\PackedArray. - - - Root documents (e.g. a - MongoDB\BSON\Serializable passed to - MongoDB\BSON\Document::fromPHP) will always be - serialized as a BSON document. For field values, associative arrays and - stdClass instances will be serialized as a BSON - document and sequential arrays (i.e. sequential, numeric indexes starting at - 0) will be serialized as a BSON array. - - - Users are encouraged to include an _id property (e.g. a - MongoDB\BSON\ObjectId initialized in the constructor) - when returning data for a BSON root document. In the absence of an - _id property, the extension or server will generate a - MongoDB\BSON\ObjectId for insert or upsert - operations, respectively. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - An array, stdClass, MongoDB\BSON\Document, - or MongoDB\BSON\PackedArray to be serialized as a BSON - array or document. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.tentative-return-types-enforced; - - PECL mongodb 1.17.0 - - - The return type was changed from arrayobject. - Instead of object, the return type now specifies stdClass. - Classes that implement this interface must be changed to no longer - declare an object return type. As the return type is - tentative, a deprecation warning is emitted on PHP 8.1 and newer. - - - In addition to the changes above, the extension now also supports - returning instances of MongoDB\BSON\Document - and MongoDB\BSON\PackedArray. Please note that - any MongoDB\BSON\PackedArray instances returned - are silently converted to objects when stored as root documents. They - are stored as arrays when used as an embedded field value. - - - - - - - - - - - &reftitle.examples; - - <function>MongoDB\BSON\Serializable::bsonSerialize</function> returning an associative array for root document - -id = new MongoDB\BSON\ObjectId; - } - - function bsonSerialize(): array - { - return ['_id' => $this->id, 'foo' => 'bar']; - } -} - -echo MongoDB\BSON\Document::fromPHP(new MyDocument)->toRelaxedExtendedJSON(), "\n"; - -?> -]]> - - &example.outputs.similar; - - - - - - - <function>MongoDB\BSON\Serializable::bsonSerialize</function> returning a sequential array for root document - -toRelaxedExtendedJSON(), "\n"; - -?> -]]> - - &example.outputs; - - - - - - - <function>MongoDB\BSON\Serializable::bsonSerialize</function> returning an associative array for document field - - 'bar']; - } -} - -$value = ['document' => new MyDocument]; - -echo MongoDB\BSON\Document::fromPHP($value)->toRelaxedExtendedJSON(), "\n"; - -?> -]]> - - &example.outputs; - - - - - - - <function>MongoDB\BSON\Serializable::bsonSerialize</function> returning a sequential array for document field - - new MyArray]; - -echo MongoDB\BSON\Document::fromPHP($value)->toRelaxedExtendedJSON(), "\n"; - -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - MongoDB\BSON\Unserializable::bsonUnserialize - MongoDB\BSON\Persistable - - - - - - - diff --git a/reference/mongodb/bson/symbol.xml b/reference/mongodb/bson/symbol.xml deleted file mode 100644 index 0040c943b191..000000000000 --- a/reference/mongodb/bson/symbol.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - The MongoDB\BSON\Symbol class - MongoDB\BSON\Symbol - - - - -
    - &reftitle.intro; - - BSON type for the "Symbol" type. This BSON type is deprecated, and this - class can not be instantiated. It will be created from a BSON symbol - type while converting BSON to PHP, and can also be converted back into - BSON while storing documents in the database. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\BSON\Symbol - - - - final - - MongoDB\BSON\Symbol - - - - MongoDB\BSON\Type - - - - JsonSerializable - - - - Stringable - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.serializable-interface-removed; - - PECL mongodb 1.12.0 - - Implements Stringable for PHP 8.0+. - - - - - -
    - -
    - - &reference.mongodb.bson.entities.symbol; - -
    - - diff --git a/reference/mongodb/bson/symbol/construct.xml b/reference/mongodb/bson/symbol/construct.xml deleted file mode 100644 index 377c971ddceb..000000000000 --- a/reference/mongodb/bson/symbol/construct.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - MongoDB\BSON\Symbol::__construct - Construct a new Symbol (unused) - - - - &reftitle.description; - - final private MongoDB\BSON\Symbol::__construct - - - - MongoDB\BSON\Symbol objects are created through - conversion from a deprecated BSON type and cannot be constructed directly. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.seealso; - - BSON Types - - - - - - diff --git a/reference/mongodb/bson/symbol/jsonserialize.xml b/reference/mongodb/bson/symbol/jsonserialize.xml deleted file mode 100644 index 531156ff7655..000000000000 --- a/reference/mongodb/bson/symbol/jsonserialize.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - MongoDB\BSON\Symbol::jsonSerialize - Returns a representation that can be converted to JSON - - - - &reftitle.description; - - final public mixedMongoDB\BSON\Symbol::jsonSerialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns data which can be serialized by json_encode to - produce an extended JSON representation of the - MongoDB\BSON\Symbol. - - &mongodb.note.extended-json; - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - JsonSerializable::jsonSerialize - json_encode - MongoDB\BSON\toCanonicalExtendedJSON - MongoDB\BSON\toRelaxedExtendedJSON - MongoDB Extended JSON - - - - - - diff --git a/reference/mongodb/bson/symbol/tostring.xml b/reference/mongodb/bson/symbol/tostring.xml deleted file mode 100644 index 1599ec296c0b..000000000000 --- a/reference/mongodb/bson/symbol/tostring.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\BSON\Symbol::__toString - Returns the Symbol as a string - - - - &reftitle.description; - - final public stringMongoDB\BSON\Symbol::__toString - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the string representation of this Symbol. - - - - - &reftitle.seealso; - - BSON Types - - - - - - diff --git a/reference/mongodb/bson/timestamp.xml b/reference/mongodb/bson/timestamp.xml deleted file mode 100644 index 3169aa1c3644..000000000000 --- a/reference/mongodb/bson/timestamp.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - The MongoDB\BSON\Timestamp class - MongoDB\BSON\Timestamp - - - - -
    - &reftitle.intro; - - Represents a - BSON timestamp, - The value consists of a 4-byte timestamp (i.e. seconds since the epoch) and - a 4-byte increment. - - - - This is an internal MongoDB type used for replication and sharding. It is - not intended for general date storage - (MongoDB\BSON\UTCDateTime should be used instead). - - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\BSON\Timestamp - - - - final - - MongoDB\BSON\Timestamp - - - - MongoDB\BSON\TimestampInterface - - - - MongoDB\BSON\Type - - - - JsonSerializable - - - - Stringable - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.serializable-interface-removed; - - PECL mongodb 1.12.0 - - Implements Stringable for PHP 8.0+. - - - - PECL mongodb 1.3.0 - - Implements MongoDB\BSON\TimestampInterface. - - - - PECL mongodb 1.2.0 - - Implements Serializable and - JsonSerializable. - - - - - -
    - -
    - - &reference.mongodb.bson.entities.timestamp; - -
    - - diff --git a/reference/mongodb/bson/timestamp/construct.xml b/reference/mongodb/bson/timestamp/construct.xml deleted file mode 100644 index 4955b2c2abf3..000000000000 --- a/reference/mongodb/bson/timestamp/construct.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - MongoDB\BSON\Timestamp::__construct - Construct a new Timestamp - - - - &reftitle.description; - - final public MongoDB\BSON\Timestamp::__construct - intincrement - inttimestamp - - - - - &reftitle.parameters; - - - increment (int) - - - 32-bit integer denoting the incrementing ordinal for operations within a - given second. - - - - - timestamp (int) - - - 32-bit integer denoting seconds since the Unix epoch. - - - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - <function>MongoDB\BSON\Timestamp::__construct</function> example - - -]]> - - &example.outputs; - - - int(1234) - ["timestamp"]=> - int(5678) -} -]]> - - - - - - - &reftitle.seealso; - - BSON Types: Timestamps - - - - - - diff --git a/reference/mongodb/bson/timestamp/getincrement.xml b/reference/mongodb/bson/timestamp/getincrement.xml deleted file mode 100644 index 9a9c1a9b2225..000000000000 --- a/reference/mongodb/bson/timestamp/getincrement.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - MongoDB\BSON\Timestamp::getIncrement - Returns the increment component of this Timestamp - - - - &reftitle.description; - - final public intMongoDB\BSON\Timestamp::getIncrement - - - - The increment component of a Timestamp is its least significant 32 bits, - which denotes the incrementing ordinal for operations within a given second. - This value is read as an unsigned 32-bit integer with big-endian byte order. - - &mongodb.note.uint32; - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the increment component of this Timestamp. - - - - On 32-bit systems this method may return a negative number. Although the - increment and timestamp parts of the BSON timestamp type consists of two - unsigned 32-bit values, PHP can not represent these on 32-bit platforms. - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - BSON Types: Timestamps - - - - - - diff --git a/reference/mongodb/bson/timestamp/gettimestamp.xml b/reference/mongodb/bson/timestamp/gettimestamp.xml deleted file mode 100644 index 52051dc607b1..000000000000 --- a/reference/mongodb/bson/timestamp/gettimestamp.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - MongoDB\BSON\Timestamp::getTimestamp - Returns the timestamp component of this Timestamp - - - - &reftitle.description; - - final public intMongoDB\BSON\Timestamp::getTimestamp - - - - The timestamp component of a Timestamp is its most significant 32 bits, which - denotes the number of seconds since the Unix epoch. This value is read as an - unsigned 32-bit integer with big-endian byte order. - - &mongodb.note.uint32; - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the timestamp component of this Timestamp. - - - - On 32-bit systems this method may return a negative number. Although the - increment and timestamp parts of the BSON timestamp type consists of two - unsigned 32-bit values, PHP can not represent these on 32-bit platforms. - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - BSON Types: Timestamps - - - - - - diff --git a/reference/mongodb/bson/timestamp/jsonserialize.xml b/reference/mongodb/bson/timestamp/jsonserialize.xml deleted file mode 100644 index 536f01d4295e..000000000000 --- a/reference/mongodb/bson/timestamp/jsonserialize.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - MongoDB\BSON\Timestamp::jsonSerialize - Returns a representation that can be converted to JSON - - - - &reftitle.description; - - final public mixedMongoDB\BSON\Timestamp::jsonSerialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns data which can be serialized by json_encode to - produce an extended JSON representation of the - MongoDB\BSON\Timestamp. - - &mongodb.note.extended-json; - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - JsonSerializable::jsonSerialize - json_encode - MongoDB\BSON\toCanonicalExtendedJSON - MongoDB\BSON\toRelaxedExtendedJSON - MongoDB Extended JSON - - - - - - diff --git a/reference/mongodb/bson/timestamp/tostring.xml b/reference/mongodb/bson/timestamp/tostring.xml deleted file mode 100644 index f0109ac51a5a..000000000000 --- a/reference/mongodb/bson/timestamp/tostring.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - MongoDB\BSON\Timestamp::__toString - Returns the string representation of this Timestamp - - - - &reftitle.description; - - final public stringMongoDB\BSON\Timestamp::__toString - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the string representation of this Timestamp. - - - - - &reftitle.examples; - - <function>MongoDB\BSON\Timestamp::__toString</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - BSON Types: Timestamps - - - - - - diff --git a/reference/mongodb/bson/timestampinterface.xml b/reference/mongodb/bson/timestampinterface.xml deleted file mode 100644 index f2b6967ab91f..000000000000 --- a/reference/mongodb/bson/timestampinterface.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - The MongoDB\BSON\TimestampInterface interface - MongoDB\BSON\TimestampInterface - - -
    - &reftitle.intro; - - This interface is implemented by - MongoDB\BSON\Timestamp to be used as a - parameter, return, or property type in userland classes. - -
    - -
    - &reftitle.classsynopsis; - - MongoDB\BSON\TimestampInterface - - - MongoDB\BSON\TimestampInterface - - - &Methods; - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.tentative-return-types-enforced; - &mongodb.changelog.tentative-return-types; - - - -
    -
    - - &reference.mongodb.bson.entities.timestampinterface; - -
    - - diff --git a/reference/mongodb/bson/timestampinterface/getincrement.xml b/reference/mongodb/bson/timestampinterface/getincrement.xml deleted file mode 100644 index d34ba20c6996..000000000000 --- a/reference/mongodb/bson/timestampinterface/getincrement.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - MongoDB\BSON\TimestampInterface::getIncrement - Returns the increment component of this TimestampInterface - - - - &reftitle.description; - - abstract public intMongoDB\BSON\TimestampInterface::getIncrement - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the increment component of this TimestampInterface. - - - - On 32-bit systems this method may return a negative number. Although the - increment and timestamp parts of the BSON timestamp type consists of two - unsigned 32-bit values, PHP can not represent these on 32-bit platforms. - - - - - - &reftitle.seealso; - - MongoDB\BSON\Timestamp::getIncrement - - - - - - diff --git a/reference/mongodb/bson/timestampinterface/gettimestamp.xml b/reference/mongodb/bson/timestampinterface/gettimestamp.xml deleted file mode 100644 index e5c05ccbd782..000000000000 --- a/reference/mongodb/bson/timestampinterface/gettimestamp.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - MongoDB\BSON\TimestampInterface::getTimestamp - Returns the timestamp component of this TimestampInterface - - - - &reftitle.description; - - abstract public intMongoDB\BSON\TimestampInterface::getTimestamp - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the timestamp component of this TimestampInterface. - - - - On 32-bit systems this method may return a negative number. Although the - increment and timestamp parts of the BSON timestamp type consists of two - unsigned 32-bit values, PHP can not represent these on 32-bit platforms. - - - - - - &reftitle.seealso; - - MongoDB\BSON\Timestamp::getTimestamp - - - - - - diff --git a/reference/mongodb/bson/timestampinterface/tostring.xml b/reference/mongodb/bson/timestampinterface/tostring.xml deleted file mode 100644 index 9c60d392be1e..000000000000 --- a/reference/mongodb/bson/timestampinterface/tostring.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\BSON\TimestampInterface::__toString - Returns the string representation of this TimestampInterface - - - - &reftitle.description; - - abstract public stringMongoDB\BSON\TimestampInterface::__toString - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the string representation of this TimestampInterface. - - - - - &reftitle.seealso; - - MongoDB\BSON\Timestamp::__toString - - - - - - diff --git a/reference/mongodb/bson/type.xml b/reference/mongodb/bson/type.xml deleted file mode 100644 index a0962ac8c0d6..000000000000 --- a/reference/mongodb/bson/type.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - The MongoDB\BSON\Type interface - MongoDB\BSON\Type - - - - -
    - &reftitle.intro; - - Abstract base interface that should not be implemented directly. - -
    - - -
    - &reftitle.interfacesynopsis; - - - - MongoDB\BSON\Type - - - - - MongoDB\BSON\Type - - - - - - - - - This interface has no methods. Its only purpose is to be the base interface - for all BSON type classes. - - -
    - -
    - -
    - - diff --git a/reference/mongodb/bson/undefined.xml b/reference/mongodb/bson/undefined.xml deleted file mode 100644 index 992676c79b58..000000000000 --- a/reference/mongodb/bson/undefined.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - The MongoDB\BSON\Undefined class - MongoDB\BSON\Undefined - - - - -
    - &reftitle.intro; - - BSON type for the "Undefined" type. This BSON type is deprecated, and this - class can not be instantiated. It will be created from a BSON undefined - type while converting BSON to PHP, and can also be converted back into - BSON while storing documents in the database. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\BSON\Undefined - - - - final - - MongoDB\BSON\Undefined - - - - MongoDB\BSON\Type - - - - JsonSerializable - - - - Stringable - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.serializable-interface-removed; - - PECL mongodb 1.12.0 - - Implements Stringable for PHP 8.0+. - - - - - -
    - -
    - - &reference.mongodb.bson.entities.undefined; - -
    - - diff --git a/reference/mongodb/bson/undefined/construct.xml b/reference/mongodb/bson/undefined/construct.xml deleted file mode 100644 index 925ed8ec2141..000000000000 --- a/reference/mongodb/bson/undefined/construct.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - MongoDB\BSON\Undefined::__construct - Construct a new Undefined (unused) - - - - &reftitle.description; - - final private MongoDB\BSON\Undefined::__construct - - - - MongoDB\BSON\Undefined objects are created through - conversion from a deprecated BSON type and cannot be constructed directly. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.seealso; - - BSON Types - - - - - - diff --git a/reference/mongodb/bson/undefined/jsonserialize.xml b/reference/mongodb/bson/undefined/jsonserialize.xml deleted file mode 100644 index 1e1fbac25743..000000000000 --- a/reference/mongodb/bson/undefined/jsonserialize.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - MongoDB\BSON\Undefined::jsonSerialize - Returns a representation that can be converted to JSON - - - - &reftitle.description; - - final public mixedMongoDB\BSON\Undefined::jsonSerialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns data which can be serialized by json_encode to - produce an extended JSON representation of the - MongoDB\BSON\Undefined. - - &mongodb.note.extended-json; - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - JsonSerializable::jsonSerialize - json_encode - MongoDB\BSON\toCanonicalExtendedJSON - MongoDB\BSON\toRelaxedExtendedJSON - MongoDB Extended JSON - - - - - - diff --git a/reference/mongodb/bson/undefined/tostring.xml b/reference/mongodb/bson/undefined/tostring.xml deleted file mode 100644 index 0fd0d71818ec..000000000000 --- a/reference/mongodb/bson/undefined/tostring.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\BSON\Undefined::__toString - Returns an empty string - - - - &reftitle.description; - - final public stringMongoDB\BSON\Undefined::__toString - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an empty string. - - - - - &reftitle.seealso; - - BSON Types - - - - - - diff --git a/reference/mongodb/bson/unserializable.xml b/reference/mongodb/bson/unserializable.xml deleted file mode 100644 index ea084db32df0..000000000000 --- a/reference/mongodb/bson/unserializable.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - The MongoDB\BSON\Unserializable interface - MongoDB\BSON\Unserializable - - - - -
    - &reftitle.intro; - - Classes that implement this interface may be specified in a - type map for - unserializing BSON arrays and documents (both root and embedded). - -
    - - -
    - &reftitle.interfacesynopsis; - - - - MongoDB\BSON\Unserializable - - - - - MongoDB\BSON\Unserializable - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.tentative-return-types-enforced; - &mongodb.changelog.tentative-return-types; - - - -
    -
    - - &reference.mongodb.bson.entities.unserializable; - -
    - - diff --git a/reference/mongodb/bson/unserializable/bsonunserialize.xml b/reference/mongodb/bson/unserializable/bsonunserialize.xml deleted file mode 100644 index f2fafa69aa4c..000000000000 --- a/reference/mongodb/bson/unserializable/bsonunserialize.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - MongoDB\BSON\Unserializable::bsonUnserialize - Constructs the object from a BSON array or document - - - - &reftitle.description; - - abstract public voidMongoDB\BSON\Unserializable::bsonUnserialize - arraydata - - - Called during unserialization of the object from BSON. The properties of the - BSON array or document will be passed to the method as an array. - - - Remember to check for an _id property when handling data - from a BSON document. - - - - This method acts as the - constructor of the - object. The __construct() method - will not be called after this method. - - - - - - &reftitle.parameters; - - - data (array) - - - Properties within the BSON array or document. - - - - - - - - &reftitle.returnvalues; - - The return value from this method is ignored. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.tentative-return-types-enforced; - - - - - - - &reftitle.examples; - - <function>MongoDB\BSON\Unserializable::bsonUnserialize</function> example - -data = $data; - } -} - -$bson = MongoDB\BSON\Document::fromJSON('{ "foo": "bar" }'); - -var_dump($bson->toPHP(['root' => 'MyDocument'])); - -?> -]]> - - &example.outputs; - - - array(1) { - ["foo"]=> - string(3) "bar" - } -} -]]> - - - - - - - &reftitle.seealso; - - MongoDB\BSON\Serializable::bsonSerialize - MongoDB\BSON\Persistable - - - - - - - diff --git a/reference/mongodb/bson/utcdatetime.xml b/reference/mongodb/bson/utcdatetime.xml deleted file mode 100644 index 13875ed36d0f..000000000000 --- a/reference/mongodb/bson/utcdatetime.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - The MongoDB\BSON\UTCDateTime class - MongoDB\BSON\UTCDateTime - - - - -
    - &reftitle.intro; - - Represents a - BSON date. The value - is a 64-bit integer that represents the number of milliseconds since the - Unix epoch (Jan 1, 1970). Negative values represent dates before 1970. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\BSON\UTCDateTime - - - - final - - MongoDB\BSON\UTCDateTime - - - - MongoDB\BSON\UTCDateTimeInterface - - - - MongoDB\BSON\Type - - - - JsonSerializable - - - - Stringable - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.serializable-interface-removed; - - PECL mongodb 1.12.0 - - Implements Stringable for PHP 8.0+. - - - - PECL mongodb 1.3.0 - - Implements MongoDB\BSON\UTCDateTimeInterface. - - - - PECL mongodb 1.2.0 - - Implements Serializable and - JsonSerializable. - - - - - -
    - -
    - - &reference.mongodb.bson.entities.utcdatetime; - -
    - - diff --git a/reference/mongodb/bson/utcdatetime/construct.xml b/reference/mongodb/bson/utcdatetime/construct.xml deleted file mode 100644 index 5c4473ce2d12..000000000000 --- a/reference/mongodb/bson/utcdatetime/construct.xml +++ /dev/null @@ -1,164 +0,0 @@ - - - - - - MongoDB\BSON\UTCDateTime::__construct - Construct a new UTCDateTime - - - - &reftitle.description; - - final public MongoDB\BSON\UTCDateTime::__construct - intMongoDB\BSON\Int64DateTimeInterfacenullmilliseconds&null; - - - - - &reftitle.parameters; - - - milliseconds (intMongoDB\BSON\Int64DateTimeInterfacenull) - - - Number of milliseconds since the Unix epoch (Jan 1, 1970). Negative values - represent dates before 1970. This value may be provided as a 64-bit - int. For compatibility on 32-bit systems, this parameter - may also be provided as a MongoDB\BSON\Int64. - - - If the argument is a DateTimeInterface, the number - of milliseconds since the Unix epoch will be derived from that value. - - - If this argument is &null;, the current time will be used by default. - - - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.0.0 - - - The milliseconds no longer accepts a - string or float argument. - - - - - PECL mongodb 1.20.0 - - - The milliseconds argument now accepts a - MongoDB\BSON\Int64 object (for compatibility on - 32-bit platforms). Specifying a string or - float is deprecated. - - - - - PECL mongodb 1.2.0 - - - The milliseconds argument is optional and - defaults to &null; (i.e. current time). The argument also accepts a - DateTimeInterface, which may be used to derive - the number of milliseconds since the Unix epoch. Previously, only - int, float, and string types - were accepted. - - - - - - - - - - &reftitle.examples; - - <function>MongoDB\BSON\UTCDateTime::__construct</function> example - - -]]> - - &example.outputs.similar; - - - string(13) "1484852905560" -} -object(MongoDB\BSON\UTCDateTime)#1 (1) { - ["milliseconds"]=> - string(13) "1484852905560" -} -object(MongoDB\BSON\UTCDateTime)#1 (1) { - ["milliseconds"]=> - string(13) "1416445411987" -} -]]> - - - - - - - &reftitle.seealso; - - BSON Types: Date - - - - - - diff --git a/reference/mongodb/bson/utcdatetime/jsonserialize.xml b/reference/mongodb/bson/utcdatetime/jsonserialize.xml deleted file mode 100644 index 872a4bf4635d..000000000000 --- a/reference/mongodb/bson/utcdatetime/jsonserialize.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - MongoDB\BSON\UTCDateTime::jsonSerialize - Returns a representation that can be converted to JSON - - - - &reftitle.description; - - final public mixedMongoDB\BSON\UTCDateTime::jsonSerialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns data which can be serialized by json_encode to - produce an extended JSON representation of the - MongoDB\BSON\UTCDateTime. - - &mongodb.note.extended-json; - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - JsonSerializable::jsonSerialize - json_encode - MongoDB\BSON\toCanonicalExtendedJSON - MongoDB\BSON\toRelaxedExtendedJSON - MongoDB Extended JSON - - - - - - diff --git a/reference/mongodb/bson/utcdatetime/todatetime.xml b/reference/mongodb/bson/utcdatetime/todatetime.xml deleted file mode 100644 index 5327be347d7a..000000000000 --- a/reference/mongodb/bson/utcdatetime/todatetime.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - MongoDB\BSON\UTCDateTime::toDateTime - Returns the DateTime representation of this UTCDateTime - - - - &reftitle.description; - - final public DateTimeMongoDB\BSON\UTCDateTime::toDateTime - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the DateTime representation of this - UTCDateTime. The returned DateTime will use the UTC - time zone. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - <function>MongoDB\BSON\UTCDatetime::toDateTime</function> example - -toDateTime(); -var_dump($datetime->format('r')); -var_dump($datetime->format('U.u')); -var_dump($datetime->getTimezone()); - -?> -]]> - - &example.outputs.similar; - - - int(1) - ["timezone"]=> - string(6) "+00:00" -} -]]> - - - - - - - &reftitle.seealso; - - MongoDB\BSON\UTCDateTime::toDateTimeImmutable - BSON Types: Date - - - - - - diff --git a/reference/mongodb/bson/utcdatetime/todatetimeimmutable.xml b/reference/mongodb/bson/utcdatetime/todatetimeimmutable.xml deleted file mode 100644 index 493c4ab19f57..000000000000 --- a/reference/mongodb/bson/utcdatetime/todatetimeimmutable.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - MongoDB\BSON\UTCDateTime::toDateTimeImmutable - Returns the DateTimeImmutable representation of this UTCDateTime - - - - &reftitle.description; - - final public DateTimeImmutableMongoDB\BSON\UTCDateTime::toDateTimeImmutable - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the DateTimeImmutable representation of this - UTCDateTime. The returned DateTimeImmutable will use the UTC - time zone. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - &reftitle.examples; - - <function>MongoDB\BSON\UTCDatetime::toDateTimeImmutable</function> example - -toDateTimeImmutable(); -var_dump($datetime->format('r')); -var_dump($datetime->format('U.u')); -var_dump($datetime->getTimezone()); - -?> -]]> - - &example.outputs.similar; - - - int(1) - ["timezone"]=> - string(6) "+00:00" -} -]]> - - - - - - - &reftitle.seealso; - - MongoDB\BSON\UTCDateTime::toDateTime - BSON Types: Date - - - - - - diff --git a/reference/mongodb/bson/utcdatetime/tostring.xml b/reference/mongodb/bson/utcdatetime/tostring.xml deleted file mode 100644 index 91ca268e1e1b..000000000000 --- a/reference/mongodb/bson/utcdatetime/tostring.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - MongoDB\BSON\UTCDateTime::__toString - Returns the string representation of this UTCDateTime - - - - &reftitle.description; - - final public stringMongoDB\BSON\UTCDateTime::__toString - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the string representation of this UTCDateTime. - - - - - &reftitle.examples; - - <function>MongoDB\BSON\UTCDateTime::__toString</function> example - - -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - BSON Types: Date - - - - - - diff --git a/reference/mongodb/bson/utcdatetimeinterface.xml b/reference/mongodb/bson/utcdatetimeinterface.xml deleted file mode 100644 index f9ae03b65b7c..000000000000 --- a/reference/mongodb/bson/utcdatetimeinterface.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - The MongoDB\BSON\UTCDateTimeInterface interface - MongoDB\BSON\UTCDateTimeInterface - - -
    - &reftitle.intro; - - This interface is implemented by - MongoDB\BSON\UTCDateTime to be used as a - parameter, return, or property type in userland classes. - -
    - -
    - &reftitle.classsynopsis; - - MongoDB\BSON\UTCDateTimeInterface - - - MongoDB\BSON\UTCDateTimeInterface - - - &Methods; - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.tentative-return-types-enforced; - &mongodb.changelog.tentative-return-types; - - - -
    -
    - - &reference.mongodb.bson.entities.utcdatetimeinterface; - -
    - - diff --git a/reference/mongodb/bson/utcdatetimeinterface/todatetime.xml b/reference/mongodb/bson/utcdatetimeinterface/todatetime.xml deleted file mode 100644 index d1570087b873..000000000000 --- a/reference/mongodb/bson/utcdatetimeinterface/todatetime.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - MongoDB\BSON\UTCDateTimeInterface::toDateTime - Returns the DateTime representation of this UTCDateTimeInterface - - - - &reftitle.description; - - abstract public DateTimeMongoDB\BSON\UTCDateTimeInterface::toDateTime - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the DateTime representation of this - UTCDateTimeInterface. The returned DateTime should use - the UTC time zone. - - - - - &reftitle.seealso; - - MongoDB\BSON\UTCDateTime::toDateTime - - - - - - diff --git a/reference/mongodb/bson/utcdatetimeinterface/todatetimeimmutable.xml b/reference/mongodb/bson/utcdatetimeinterface/todatetimeimmutable.xml deleted file mode 100644 index 6e0beec3ae95..000000000000 --- a/reference/mongodb/bson/utcdatetimeinterface/todatetimeimmutable.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - MongoDB\BSON\UTCDateTimeInterface::toDateTimeImmutable - Returns the DateTimeImmutable representation of this UTCDateTimeInterface - - - - &reftitle.description; - - abstract public DateTimeImmutableMongoDB\BSON\UTCDateTimeInterface::toDateTimeImmutable - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the DateTimeImmutable representation of this - UTCDateTimeInterface. The returned DateTimeImmutable will use the UTC - time zone. - - - - - &reftitle.seealso; - - MongoDB\BSON\UTCDateTime::toDateTimeImmutable - - - - - - diff --git a/reference/mongodb/bson/utcdatetimeinterface/tostring.xml b/reference/mongodb/bson/utcdatetimeinterface/tostring.xml deleted file mode 100644 index f84fca9d87ac..000000000000 --- a/reference/mongodb/bson/utcdatetimeinterface/tostring.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\BSON\UTCDateTimeInterface::__toString - Returns the string representation of this UTCDateTimeInterface - - - - &reftitle.description; - - abstract public stringMongoDB\BSON\UTCDateTimeInterface::__toString - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the string representation of this UTCDateTimeInterface. - - - - - &reftitle.seealso; - - MongoDB\BSON\UTCDateTime::__toString - - - - - - diff --git a/reference/mongodb/bson/vectortype.xml b/reference/mongodb/bson/vectortype.xml deleted file mode 100644 index 90a0396be362..000000000000 --- a/reference/mongodb/bson/vectortype.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - The MongoDB\BSON\VectorType enum - MongoDB\BSON\VectorType - - -
    - &reftitle.intro; - - The MongoDB\BSON\VectorType enum is used to specify the type of - vector data stored in a MongoDB\BSON\Binary with - subtype MongoDB\BSON\Binary::TYPE_VECTOR. - -
    - -
    - &reftitle.enumsynopsis; - - - MongoDB\BSON\VectorType - - - Float32 - - Each element in the vector is a 32-bit floating point value. - - - - - Int8 - - Each element in the vector is an 8-bit integer value. - - - - - PackedBit - - Each element in the vector is a 1-bit value. When creating vectors of this - type, you may pass either bool or 1-bit int values, i.e. 0 or 1. - - - -
    -
    -
    - - diff --git a/reference/mongodb/configure.xml b/reference/mongodb/configure.xml deleted file mode 100644 index b43044fa6a59..000000000000 --- a/reference/mongodb/configure.xml +++ /dev/null @@ -1,332 +0,0 @@ - - - -
    - &reftitle.install; - -
    - Installing the MongoDB PHP Extension with PIE - - &pecl.moving.to.pie; - - - To install the MongoDB extension using PIE, run the following command: - - - - - -
    - -
    - Installing the MongoDB PHP Extension with PECL - - - &pecl.info; - &url.pecl.package;mongodb - - - - Linux, Unix, and macOS users may run the following command to install the - extension: - - - - - - - On systems with multiple version of PHP installed (e.g. macOS default, - Homebrew), each version of PHP - will have its own pecl - command and &php.ini; file(s). Additionally, each PHP environments (e.g. - CLI, web) may use separate &php.ini; files. - - - - As of extension version 1.17.0, PECL will prompt for various - configure options. To install the extension with default - options in a non-interactive script, empty string input may be piped to - pecl install using the yes command: - - - - - - - A complete list of supported configure options can be - found in the package.xml file included in the PECL - package. To install the extension with specific configure - options in a non-interactive script, the - --configureoptions option for - pecl install may be used: - - - - - - - By default, installing the extension via PECL will use bundled versions of - libbson, - libmongoc, and - libmongocrypt and attempt to - automatically configure them. - - - - - If the build process fails to find an SSL library, check that the - development packages (e.g. libssl-dev) and - pkg-config are both - installed. If that does not resolve the problem, consider using the - manual installation - process. - - - - - Finally, add the following line to the &php.ini; file for each environment - that will need to use the extension: - - - - -
    - -
    - Installing the MongoDB PHP Extension on macOS with Homebrew - - - Homebrew 1.5.0 - deprecated the Homebrew/php tap - and removed formulae for individual PHP extensions. Going forward, macOS - users are advised to install the - php formula - and follow the standard - PECL installation instructions - using the pecl command provided by the - Homebrew PHP installation. - - - Alternatively, the - shivammathur/extensions tap - provides formulae for individual PHP extensions. For example, to install the - extension for PHP 8.4, run: - - - - Please note that only the latest extension version is available in brew. - - - Install required dependencies - - To ensure that SSL support can be configured correctly, make sure that the - openssl and pkgconf formulae are - installed. If either of these packages are missing, the extension will be - compiled with Secure Transport, which can lead to compatibility issues. - - -
    - -
    - Installing the MongoDB PHP Extension on Windows - - - Precompiled binaries are attached to the project's - Github releases. - Archives are published for various combinations of PHP version, thread safety - (TS or NTS), and architecture (x86 or x64). Determining the correct archive - for the PHP environment and extract the php_mongodb.dll - file to the extension directory ("ext" by default). - - - - Add the following line to the &php.ini; file for each environment that will - need to use the extension: - - - - - - - Failure to select the correct binary will result in an error when attempting - to load the extension DLL at runtime: - - - - - - - Ensure that the downloaded DLL corresponds to the following PHP runtime - properties: - - PHP version (PHP_VERSION) - Thread safety (PHP_ZTS) - Architecture (PHP_INT_SIZE) - - - - - In addition to the aforementioned constants, these properties can also be - inferred from phpinfo. If a system has multiple PHP - runtimes installed, double-check that the phpinfo output - is for the correct environment. - - - - Additional DLL dependencies for Windows Users - - &ext.windows.path.dll; - libsasl.dll - - -
    - -
    - Building the MongoDB PHP Driver from source - - - For developers and users interested in the latest bugfixes, the extension - may be compiled from the latest source code on - Github. Run the following - commands to clone and build the project: - - - - - - - On systems with multiple version of PHP installed (e.g. macOS default, - Homebrew), each version of PHP - will have its own phpize - command and &php.ini; file(s). Additionally, each PHP environments (e.g. - CLI, web) may use separate &php.ini; files. - - - - By default, the extension will use bundled versions of - libbson, - libmongoc, and - libmongocrypt and - attempt to configure them automatically. If these libraries are already - installed as system libraries, the extension can utilize them by - specifying --with-mongodb-system-libs=yes as an option to - configure. - - - - For a complete list of configure options, run - configure --help. - - - - When using bundled versions of libmongoc and libmongocrypt, the extension - will also attempt to select an SSL library according to the - --with-mongodb-ssl configure option. - As of extension version 1.17.0, OpenSSL is always preferred by default. - Previously, Secure Transport was the default on macOS and OpenSSL was the - default on all other platforms. - - - - - If the build process fails to find an SSL library, check that the - development packages (e.g. libssl-dev) and - pkg-config are both - installed. - - - - When using Homebrew on macOS, it is common for a system to have multiple - versions of OpenSSL installed. To ensure that the desired version of OpenSSL - is selected, the PKG_CONFIG_PATH environment variable may - be used to control the search path for pkg-config. - - - - - The final build step, make install, will report where - mongodb.so has been installed, similar to: - - - - - - - Ensure that the extension_dir option - in &php.ini; points to the directory where mongodb.so - was installed. The option may be queried by running: - - /usr/lib/php/extensions/debug-non-zts-20220829 => - /usr/lib/php/extensions/debug-non-zts-20220829 -]]> - - - - - If the directories differ, either change - extension_dir in &php.ini; or - manually move mongodb.so to the correct directory. - - - - Finally, add the following line to the &php.ini; file for each environment - that will need to use the extension: - - - - -
    - -
    - - - diff --git a/reference/mongodb/constants.xml b/reference/mongodb/constants.xml deleted file mode 100644 index 955fe521f806..000000000000 --- a/reference/mongodb/constants.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - - - - MONGODB_VERSION - (string) - - - - x.y.z style version number of the extension - - - - - - MONGODB_STABILITY - (string) - - - - Current stability (alpha/beta/stable) - - - - - - - - diff --git a/reference/mongodb/exceptions.xml b/reference/mongodb/exceptions.xml deleted file mode 100644 index a819727c8fc3..000000000000 --- a/reference/mongodb/exceptions.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - MongoDB\Driver\Exception - Exception classes - - &reference.mongodb.mongodb.driver.exception.authenticationexception; - &reference.mongodb.mongodb.driver.exception.bulkwriteexception; - &reference.mongodb.mongodb.driver.exception.bulkwritecommandexception; - &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.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; - -
    - Class Tree - MongoDB Exception Class Tree - - - The class hierarchy for MongoDB exceptions is modeled after that of the - SPL Exceptions. Base classes extend - their SPL counterpart and all exception classes in the extension implement - the MongoDB\Driver\Exception\Exception interface. - - - - MongoDB\Driver\Exception\LogicException (extends LogicException) - MongoDB\Driver\Exception\InvalidArgumentException (extends InvalidArgumentException) - MongoDB\Driver\Exception\UnexpectedValueException (extends UnexpectedValueException) - - MongoDB\Driver\Exception\RuntimeException (extends RuntimeException) - - - MongoDB\Driver\Exception\ConnectionException - - MongoDB\Driver\Exception\AuthenticationException - MongoDB\Driver\Exception\ConnectionTimeoutException - MongoDB\Driver\Exception\SSLConnectionException (deprecated) - - - MongoDB\Driver\Exception\EncryptionException - - MongoDB\Driver\Exception\ServerException - - MongoDB\Driver\Exception\BulkWriteCommandException - MongoDB\Driver\Exception\CommandException - MongoDB\Driver\Exception\ExecutionTimeoutException - - MongoDB\Driver\Exception\WriteException (deprecated) - - MongoDB\Driver\Exception\BulkWriteException - - - - - - - -
    - -
    diff --git a/reference/mongodb/functions/bson/fromjson.xml b/reference/mongodb/functions/bson/fromjson.xml deleted file mode 100644 index a91e0e0b2df1..000000000000 --- a/reference/mongodb/functions/bson/fromjson.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - MongoDB\BSON\fromJSON - Returns the BSON representation of a JSON value - - - - - - This function has been DEPRECATED as of extension - version 1.20.0 and was removed in 2.0. Applications should use - MongoDB\BSON\Document::fromJSON instead. - - - - - - &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.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.function-removed; - - - - - - - &reftitle.examples; - - <function>MongoDB\BSON\fromJSON</function> example - - -]]> - - &example.outputs; - - - object(MongoDB\BSON\ObjectId)#1 (1) { - ["oid"]=> - string(24) "563143b280d2387c91807965" - } -} -]]> - - - - - - - &reftitle.seealso; - - MongoDB\BSON\Document::fromJSON - 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 d7d45261bc52..000000000000 --- a/reference/mongodb/functions/bson/fromphp.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - - MongoDB\BSON\fromPHP - Returns the BSON representation of a PHP value - - - - - - This function has been DEPRECATED as of extension - version 1.20.0 and was removed in 2.0. Applications should use - MongoDB\BSON\Document::fromPHP instead. - - - - - - &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.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.function-removed; - - - - - - - &reftitle.examples; - - <function>MongoDB\BSON\fromPHP</function> example - - 1]); -echo bin2hex($bson), "\n"; - -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - MongoDB\BSON\Document::fromPHP - 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 63f8cde31402..000000000000 --- a/reference/mongodb/functions/bson/tocanonicalextendedjson.xml +++ /dev/null @@ -1,184 +0,0 @@ - - - - - - MongoDB\BSON\toCanonicalExtendedJSON - Returns the Canonical Extended JSON representation of a BSON value - - - - - - This function has been DEPRECATED as of extension - version 1.20.0 and was removed in 2.0. Applications should use - MongoDB\BSON\Document::toCanonicalExtendedJSON - instead. - - - - - - &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.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.function-removed; - - - - - - - &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\Document::fromJSON - MongoDB\BSON\Document::toCanonicalExtendedJSON - 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 44d1aff0d19b..000000000000 --- a/reference/mongodb/functions/bson/tojson.xml +++ /dev/null @@ -1,209 +0,0 @@ - - - - - - MongoDB\BSON\toJSON - Returns the Legacy Extended JSON representation of a BSON value - - - - - - This function has been DEPRECATED as of extension - version 1.20.0 and was removed in 2.0. Applications should use - MongoDB\BSON\Document::toCanonicalExtendedJSON or - MongoDB\BSON\Document::toRelaxedExtendedJSON - instead. - - - - - - &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.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.function-removed; - - - - - - - &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 55fd33728a67..000000000000 --- a/reference/mongodb/functions/bson/tophp.xml +++ /dev/null @@ -1,178 +0,0 @@ - - - - - - MongoDB\BSON\toPHP - Returns the PHP representation of a BSON value - - - - - - This function has been DEPRECATED as of extension - version 1.20.0 and was removed in 2.0. Applications should use - MongoDB\BSON\Document::toPHP instead. - - - - - - &reftitle.description; - - arrayobjectMongoDB\BSON\toPHP - stringbson - arraytypeMaparray() - - - Unserializes a BSON document (i.e. binary string) to its PHP representation. - The typeMap parameter 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; - - - - &mongodb.changelog.function-removed; - - PECL mongodb 1.4.0 - - - If the input contains an unsupported, deprecated BSON type, the - extension 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 extension 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\Document::toPHP - 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 e767d51aedfe..000000000000 --- a/reference/mongodb/functions/bson/torelaxedextendedjson.xml +++ /dev/null @@ -1,183 +0,0 @@ - - - - - - MongoDB\BSON\toRelaxedExtendedJSON - Returns the Relaxed Extended JSON representation of a BSON value - - - - - - This function has been DEPRECATED as of extension - version 1.20.0 and was removed in 2.0. Applications should use - MongoDB\BSON\Document::toRelaxedExtendedJSON - instead. - - - - - - &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.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.function-removed; - - - - - - - &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\Document::fromJSON - MongoDB\BSON\Document::toRelaxedExtendedJSON - MongoDB\BSON\fromJSON - MongoDB\BSON\toCanonicalExtendedJSON - Extended JSON - MongoDB BSON - - - - - - diff --git a/reference/mongodb/functions/driver/monitoring/addsubscriber.xml b/reference/mongodb/functions/driver/monitoring/addsubscriber.xml deleted file mode 100644 index 38f749792790..000000000000 --- 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 extension 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 f5d9db72ff09..000000000000 --- 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/images/driver_arch.svg b/reference/mongodb/images/driver_arch.svg deleted file mode 100644 index a978d2cbbeb9..000000000000 --- a/reference/mongodb/images/driver_arch.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/reference/mongodb/ini.xml b/reference/mongodb/ini.xml deleted file mode 100644 index ea8fdf8dca9b..000000000000 --- a/reference/mongodb/ini.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - -
    - &reftitle.runtime; - &extension.runtime; - - - mongodb &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - mongodb.debug - "" - INI_ALL - - - - -
    -
    - - &ini.descriptions.title; - - - - - - mongodb.debug - string - - - - This option can be used to enable or disable trace-level debug logging in - the extension (and libmongoc). - - - Specify an empty string, "0", - "off", "no", or - "false" to disable logging. - - - Specify "stderr" or "stdout" to log - to stderr or stdout, respectively. - - - Specify "1", "on", - "yes", or "true" to log to a new - temporary file within the default system temp directory (i.e. - sys_get_temp_dir). - - - Specify any other string to log to a new temporary file within that - directory. If the directory cannot be used, the default system temp - directory will be used instead. - - - - Please note that the debug log can contain sensitive information, such - as credentials to the MongoDB server and full documents written to or - read from the server. Please review any debug logs before sharing them - with other people. - - - - - - -
    - - diff --git a/reference/mongodb/mongodb.xml b/reference/mongodb/mongodb.xml deleted file mode 100644 index 7aeae83349e0..000000000000 --- a/reference/mongodb/mongodb.xml +++ /dev/null @@ -1,34 +0,0 @@ - - - - - - MongoDB Extension Classes - MongoDB\Driver - - &reference.mongodb.mongodb.driver.manager; - &reference.mongodb.mongodb.driver.command; - &reference.mongodb.mongodb.driver.query; - &reference.mongodb.mongodb.driver.bulkwrite; - &reference.mongodb.mongodb.driver.bulkwritecommand; - &reference.mongodb.mongodb.driver.session; - &reference.mongodb.mongodb.driver.clientencryption; - &reference.mongodb.mongodb.driver.serverapi; - - &reference.mongodb.mongodb.driver.writeconcern; - &reference.mongodb.mongodb.driver.readpreference; - &reference.mongodb.mongodb.driver.readconcern; - - &reference.mongodb.mongodb.driver.cursor; - &reference.mongodb.mongodb.driver.cursorid; - &reference.mongodb.mongodb.driver.cursorinterface; - - &reference.mongodb.mongodb.driver.server; - &reference.mongodb.mongodb.driver.serverdescription; - &reference.mongodb.mongodb.driver.topologydescription; - - &reference.mongodb.mongodb.driver.writeconcernerror; - &reference.mongodb.mongodb.driver.writeerror; - &reference.mongodb.mongodb.driver.writeresult; - &reference.mongodb.mongodb.driver.bulkwritecommandresult; - diff --git a/reference/mongodb/mongodb/driver/bulkwrite.xml b/reference/mongodb/mongodb/driver/bulkwrite.xml deleted file mode 100644 index 81e2df95c796..000000000000 --- 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' => $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 fulfilled, 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 2e6ef9d1a6d2..000000000000 --- a/reference/mongodb/mongodb/driver/bulkwrite/construct.xml +++ /dev/null @@ -1,233 +0,0 @@ - - - - - - MongoDB\Driver\BulkWrite::__construct - Create a new BulkWrite - - - - &reftitle.description; - - public MongoDB\Driver\BulkWrite::__construct - arraynulloptions&null; - - - 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; - - - comment - mixed - - - An arbitrary comment to help trace the operation through the - database profiler, currentOp output, and logs. - - - This option is available in MongoDB 4.4+ and will result in an - exception at execution time if specified for an older server - version. - - - - &mongodb.option.let; - - 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.14.0 - - Added the "comment" and "let" - options. - - - - 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' => $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 279eea7556b6..000000000000 --- a/reference/mongodb/mongodb/driver/bulkwrite/count.xml +++ /dev/null @@ -1,118 +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 ebab03538894..000000000000 --- a/reference/mongodb/mongodb/driver/bulkwrite/delete.xml +++ /dev/null @@ -1,169 +0,0 @@ - - - - - - MongoDB\Driver\BulkWrite::delete - Add a delete operation to the bulk - - - - &reftitle.description; - - public voidMongoDB\Driver\BulkWrite::delete - arrayobjectfilter - arraynulldeleteOptions&null; - - - 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 b47bb58cdb5a..000000000000 --- a/reference/mongodb/mongodb/driver/bulkwrite/insert.xml +++ /dev/null @@ -1,153 +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 - - 1]; -$doc2 = ['_id' => 'custom-id', 'x' => 2]; -$doc3 = ['_id' => new MongoDB\BSON\ObjectId('0123456789abcdef01234567'), 'x' => 3]; - -$id1 = $bulk->insert($doc1); -$id2 = $bulk->insert($doc2); -$id3 = $bulk->insert($doc3); - -var_dump($id1, $id2, $id3); - -$manager = new MongoDB\Driver\Manager('mongodb://localhost:27017'); -$result = $manager->executeBulkWrite('db.collection', $bulk); - -?> -]]> - - &example.outputs.similar; - - - string(24) "67f58058d1a0aa2fd80d55d0" -} -string(9) "custom-id" -object(MongoDB\BSON\ObjectId)#4 (1) { - ["oid"]=> - string(24) "0123456789abcdef01234567" -} -]]> - - - - - - - &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 f56e6cecfb55..000000000000 --- a/reference/mongodb/mongodb/driver/bulkwrite/update.xml +++ /dev/null @@ -1,265 +0,0 @@ - - - - - - MongoDB\Driver\BulkWrite::update - Add an update operation to the bulk - - - - &reftitle.description; - - public voidMongoDB\Driver\BulkWrite::update - arrayobjectfilter - arrayobjectnewObj - arraynullupdateOptions&null; - - - 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; - - - sort - arrayobject - - - Specify which document the operation updates if the query matches - multiple documents. The first document matched by the sort order - will be updated. - - - This option cannot be used if "multi" is &true;. - - - This option is available in MongoDB 8.0+ and will result in an - exception at execution time if specified for an older server - version. - - - - - 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.21.0 - - Added the "sort" option. - - - - 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/bulkwritecommand.xml b/reference/mongodb/mongodb/driver/bulkwritecommand.xml deleted file mode 100644 index ab837a85a28a..000000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommand.xml +++ /dev/null @@ -1,202 +0,0 @@ - - - - - - The MongoDB\Driver\BulkWriteCommand class - MongoDB\Driver\BulkWriteCommand - - - - -
    - &reftitle.intro; - - MongoDB\Driver\BulkWriteCommand collects one or more - write operations that should be sent to the server using the - bulkWrite - command introduced in MongoDB 8.0. After adding any number of insert, - update, and delete operations, the command may be executed via - MongoDB\Driver\Manager::executeBulkWriteCommand. - - - Unlike MongoDB\Driver\BulkWrite, where all write - operations must target the same collection, each write operation within - MongoDB\Driver\BulkWriteCommand may target a - different collection. - - - 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\BulkWriteCommand - - - - final - - MongoDB\Driver\BulkWriteCommand - - - - Countable - - - - - &Methods; - - - - -
    - -
    - &reftitle.examples; - - - Mixed write operations - - Mixed write operations (i.e. inserts, updates, and deletes) will be sent - to the server using a single - bulkWrite - command. - - -deleteMany('db.coll_one', []); -$bulk->deleteMany('db.coll_two', []); - -// Insert documents into two collections -$bulk->insertOne('db.coll_one', ['_id' => 1]); -$bulk->insertOne('db.coll_two', ['_id' => 2]); -$bulk->insertOne('db.coll_two', ['_id' => 3]); - -// Update a document in "coll_one" -$bulk->updateOne('db.coll_one', ['_id' => 1], ['$set' => ['x' => 1]]); - -$result = $manager->executeBulkWriteCommand($bulk); - -printf("Inserted %d document(s)\n", $result->getInsertedCount()); -printf("Updated %d document(s)\n", $result->getModifiedCount()); - -?> -]]> - - &example.outputs; - - - - - - Ordered write operations causing an error - -deleteMany('db.coll', []); -$bulk->insertOne('db.coll', ['_id' => 1]); -$bulk->insertOne('db.coll', ['_id' => 2]); -$bulk->insertOne('db.coll', ['_id' => 1]); -$bulk->insertOne('db.coll', ['_id' => 3]); - -try { - $result = $manager->executeBulkWriteCommand($bulk); -} catch (MongoDB\Driver\Exception\BulkWriteCommandException $e) { - $result = $e->getPartialResult(); - - var_dump($e->getWriteErrors()); -} - -printf("Inserted %d document(s)\n", $result->getInsertedCount()); - -?> -]]> - - &example.outputs.similar; - - - object(MongoDB\Driver\WriteError)#5 (4) { - ["message"]=> - string(78) "E11000 duplicate key error collection: db.coll index: _id_ dup key: { _id: 1 }" - ["code"]=> - int(11000) - ["index"]=> - int(3) - ["info"]=> - object(stdClass)#6 (0) { - } - } -} -Inserted 2 document(s) -]]> - - -
    - -
    - &reftitle.seealso; - - MongoDB\Driver\Manager::executeBulkWriteCommand - MongoDB\Driver\BulkWriteCommandResult - MongoDB\Driver\Exception\BulkWriteCommandException - MongoDB\Driver\WriteConcern - MongoDB\Driver\WriteConcernError - MongoDB\Driver\WriteError - -
    - -
    - - &reference.mongodb.mongodb.driver.entities.bulkwritecommand; - -
    - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommand/construct.xml b/reference/mongodb/mongodb/driver/bulkwritecommand/construct.xml deleted file mode 100644 index a3912fc9f0fa..000000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommand/construct.xml +++ /dev/null @@ -1,184 +0,0 @@ - - - - - - MongoDB\Driver\BulkWriteCommand::__construct - Create a new BulkWriteCommand - - - - &reftitle.description; - - public MongoDB\Driver\BulkWriteCommand::__construct - arraynulloptions&null; - - - Constructs a new MongoDB\Driver\BulkWriteCommand, - which may be used to perform many insert, update, and delete operations on - multiple collections in a single request using the - bulkWrite - command introduced in MongoDB 8.0. This differs from - MongoDB\Driver\BulkWrite, which is supported by all - server versions but limited to a single collection. - - - After all write operations have been added, this object may be executed with - MongoDB\Driver\Manager::executeBulkWriteCommand. - - - - - &reftitle.parameters; - - - options (array) - - - - options - - - - Option - Type - Description - Default - - - - - bypassDocumentValidation - bool - - - If &true;, allows insert and update operations to circumvent - document level validation. - - - &false; - - - comment - mixed - - - An arbitrary comment to help trace the operation through the - database profiler, currentOp output, and logs. - - - - &mongodb.option.let; - - ordered - bool - - - Whether the operations in this bulk write should be executed in - the order in which they were specified. If &false;, writes will - continue to be executed if an individual write fails. If &true;, - writes will stop executing if an individual write fails. - - - &true; - - - verboseResults - bool - - - Whether detailed results for each successful operation should be - included in the returned - MongoDB\Driver\BulkWriteCommandResult. - - - &false; - - - -
    -
    -
    -
    -
    -
    - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - <function>MongoDB\Driver\BulkWriteCommand::__construct</function> example - -deleteMany('db.coll_one', []); -$bulk->deleteMany('db.coll_two', []); - -// Insert documents into two collections -$bulk->insertOne('db.coll_one', ['_id' => 1]); -$bulk->insertOne('db.coll_two', ['_id' => 2]); -$bulk->insertOne('db.coll_two', ['_id' => 3]); - -// Update a document in "coll_one" -$bulk->updateOne('db.coll_one', ['_id' => 1], ['$set' => ['x' => 1]]); - -$result = $manager->executeBulkWriteCommand($bulk); - -printf("Inserted %d document(s)\n", $result->getInsertedCount()); -printf("Updated %d document(s)\n", $result->getModifiedCount()); - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::executeBulkWriteCommand - MongoDB\Driver\BulkWriteCommandResult - - - -
    - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommand/count.xml b/reference/mongodb/mongodb/driver/bulkwritecommand/count.xml deleted file mode 100644 index c0541c0af572..000000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommand/count.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - MongoDB\Driver\BulkWriteCommand::count - Count number of write operations in the BulkWriteCommand - - - - &reftitle.description; - - public intMongoDB\Driver\BulkWriteCommand::count - - - - Returns the number of write operations added to the - MongoDB\Driver\BulkWriteCommand object. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns number of write operations added to the - MongoDB\Driver\BulkWriteCommand object. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - <function>MongoDB\Driver\BulkWriteCommand::count</function> example - -insertOne('db.coll', ['_id' => 1, 'x' => 1]); -$bulk->insertOne('db.coll', ['_id' => 2, 'x' => 2]); -$bulk->updateOne('db.coll', ['x' => 2], ['$set' => ['x' => 1]]); -$bulk->deleteMany('db.coll', ['x' => 1]); - -var_dump(count($bulk)); - -?> -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommand/deletemany.xml b/reference/mongodb/mongodb/driver/bulkwritecommand/deletemany.xml deleted file mode 100644 index f686534fe618..000000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommand/deletemany.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - MongoDB\Driver\BulkWriteCommand::deleteMany - Add a deleteMany operation - - - - &reftitle.description; - - public voidMongoDB\Driver\BulkWriteCommand::deleteMany - stringnamespace - arrayobjectfilter - arraynulloptions&null; - - - Add a deleteMany operation to the - MongoDB\Driver\BulkWriteCommand. All documents - matching filter in the collection identified by - namespace will be deleted. - - - - - &reftitle.parameters; - - &mongodb.parameter.namespace; - &mongodb.parameter.filter; - - options - - - - options - - - - 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. - - - - - -
    -
    -
    -
    -
    -
    - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - <function>MongoDB\Driver\BulkWriteCommand::deleteMany</function> example - -deleteMany('db.coll', ['x' => ['$gt' => 1]]); - -$result = $manager->executeBulkWriteCommand($bulk); - -?> -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWriteCommand::deleteOne - MongoDB\Driver\Manager::executeBulkWriteCommand - MongoDB\Driver\BulkWriteCommandResult - - - -
    - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommand/deleteone.xml b/reference/mongodb/mongodb/driver/bulkwritecommand/deleteone.xml deleted file mode 100644 index bc0f369652e1..000000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommand/deleteone.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - MongoDB\Driver\BulkWriteCommand::deleteOne - Add a deleteOne operation - - - - &reftitle.description; - - public voidMongoDB\Driver\BulkWriteCommand::deleteOne - stringnamespace - arrayobjectfilter - arraynulloptions&null; - - - Add a deleteOne operation to the - MongoDB\Driver\BulkWriteCommand. The first document - matching filter in the collection identified by - namespace will be deleted. - - - - - &reftitle.parameters; - - &mongodb.parameter.namespace; - &mongodb.parameter.filter; - - options - - - - options - - - - 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. - - - - - -
    -
    -
    -
    -
    -
    - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - <function>MongoDB\Driver\BulkWriteCommand::deleteOne</function> example - -deleteOne('db.coll', ['x' => 1]); - -$result = $manager->executeBulkWriteCommand($bulk); - -?> -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWriteCommand::deleteMany - MongoDB\Driver\Manager::executeBulkWriteCommand - MongoDB\Driver\BulkWriteCommandResult - - - -
    - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommand/insertone.xml b/reference/mongodb/mongodb/driver/bulkwritecommand/insertone.xml deleted file mode 100644 index 9ff47f8529d0..000000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommand/insertone.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - MongoDB\Driver\BulkWriteCommand::insertOne - Add an insertOne operation - - - - &reftitle.description; - - public mixedMongoDB\Driver\BulkWriteCommand::insertOne - stringnamespace - arrayobjectdocument - - - Add an insertOne operation to the - MongoDB\Driver\BulkWriteCommand. The document will - be inserted into the collection identified by - namespace. - - - - - &reftitle.parameters; - - &mongodb.parameter.namespace; - - 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.examples; - - <function>MongoDB\Driver\BulkWriteCommand::insertOne</function> example - - 1]; -$doc2 = ['_id' => 'custom-id', 'x' => 2]; -$doc3 = ['_id' => new MongoDB\BSON\ObjectId('0123456789abcdef01234567'), 'x' => 3]; - -$id1 = $bulk->insertOne('db.coll', $doc1); -$id2 = $bulk->insertOne('db.coll', $doc2); -$id3 = $bulk->insertOne('db.coll', $doc3); - -var_dump($id1, $id2, $id3); - -$result = $manager->executeBulkWriteCommand($bulk); - -?> -]]> - - &example.outputs.similar; - - - string(24) "67f58058d1a0aa2fd80d55d0" -} -string(9) "custom-id" -object(MongoDB\BSON\ObjectId)#4 (1) { - ["oid"]=> - string(24) "0123456789abcdef01234567" -} -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::executeBulkWriteCommand - MongoDB\Driver\BulkWriteCommandResult - MongoDB\BSON\ObjectId - - - - - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommand/replaceone.xml b/reference/mongodb/mongodb/driver/bulkwritecommand/replaceone.xml deleted file mode 100644 index 95c12b7c4bc7..000000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommand/replaceone.xml +++ /dev/null @@ -1,165 +0,0 @@ - - - - - - MongoDB\Driver\BulkWriteCommand::replaceOne - Add a replaceOne operation - - - - &reftitle.description; - - public voidMongoDB\Driver\BulkWriteCommand::replaceOne - stringnamespace - arrayobjectfilter - arrayobjectreplacement - arraynulloptions&null; - - - Add a replaceOne operation to the - MongoDB\Driver\BulkWriteCommand. The first document - matching filter in the collection identified by - namespace will be replaced. - - - - - - &reftitle.parameters; - - &mongodb.parameter.namespace; - &mongodb.parameter.filter; - - replacement (arrayobject) - - - A replacement document. - - - - - options - - - - options - - - - 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. - - - - - sort - arrayobject - - - Specify which document the operation replaces if the query matches - multiple documents. The first document matched by the sort order - will be replaced. - - - - - upsert - bool - - If filter does not match an existing document, - insert a single document. The document will be - created from replacement. - - &false; - - - -
    -
    -
    -
    -
    -
    - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - <function>MongoDB\Driver\BulkWriteCommand::replaceOne</function> example - -replaceOne('db.coll', ['x' => 1], ['x' => 1, 'y' => 2]); - -$result = $manager->executeBulkWriteCommand($bulk); - -?> -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWriteCommand::updateOne - MongoDB\Driver\BulkWriteCommand::updateMany - MongoDB\Driver\Manager::executeBulkWriteCommand - MongoDB\Driver\BulkWriteCommandResult - - - -
    - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommand/updatemany.xml b/reference/mongodb/mongodb/driver/bulkwritecommand/updatemany.xml deleted file mode 100644 index 86a3005db55a..000000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommand/updatemany.xml +++ /dev/null @@ -1,169 +0,0 @@ - - - - - - MongoDB\Driver\BulkWriteCommand::updateMany - Add an updateMany operation - - - - &reftitle.description; - - public voidMongoDB\Driver\BulkWriteCommand::updateMany - stringnamespace - arrayobjectfilter - arrayobjectupdate - arraynulloptions&null; - - - Add an updateMany operation to the - MongoDB\Driver\BulkWriteCommand. All documents - matching filter in the collection identified by - namespace will be updated. - - - - - - &reftitle.parameters; - - &mongodb.parameter.namespace; - &mongodb.parameter.filter; - - update (arrayobject) - - - A document containing either update operators (e.g. - $set) or an - aggregation pipeline. - - - - - options - - - - options - - - - 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. - - - - &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. - - - - - upsert - bool - - If filter does not match an existing document, - insert a single document. The document will be - created by applying operators in update to any - field values in filter. - - &false; - - - -
    -
    -
    -
    -
    -
    - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - <function>MongoDB\Driver\BulkWriteCommand::updateMany</function> example - -updateMany('db.coll', ['x' => ['$gt' => 1]], ['$set' => ['y' => 2]]); - -$result = $manager->executeBulkWriteCommand($bulk); - -?> -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWriteCommand::replaceOne - MongoDB\Driver\BulkWriteCommand::updateMany - MongoDB\Driver\Manager::executeBulkWriteCommand - MongoDB\Driver\BulkWriteCommandResult - - - -
    - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommand/updateone.xml b/reference/mongodb/mongodb/driver/bulkwritecommand/updateone.xml deleted file mode 100644 index 85b041f6f70d..000000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommand/updateone.xml +++ /dev/null @@ -1,180 +0,0 @@ - - - - - - MongoDB\Driver\BulkWriteCommand::updateOne - Add an updateOne operation - - - - &reftitle.description; - - public voidMongoDB\Driver\BulkWriteCommand::updateOne - stringnamespace - arrayobjectfilter - arrayobjectupdate - arraynulloptions&null; - - - Add an updateOne operation to the - MongoDB\Driver\BulkWriteCommand. The first document - matching filter in the collection identified by - namespace will be updated. - - - - - - &reftitle.parameters; - - &mongodb.parameter.namespace; - &mongodb.parameter.filter; - - update (arrayobject) - - - A document containing either update operators (e.g. - $set) or an - aggregation pipeline. - - - - - options - - - - options - - - - 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. - - - - &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. - - - - - sort - arrayobject - - - Specify which document the operation updates if the query matches - multiple documents. The first document matched by the sort order - will be updated. - - - - - upsert - bool - - If filter does not match an existing document, - insert a single document. The document will be - created by applying operators in update to any - field values in filter. - - &false; - - - -
    -
    -
    -
    -
    -
    - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - <function>MongoDB\Driver\BulkWriteCommand::updateOne</function> example - -updateOne('db.coll', ['x' => 1], ['$set' => ['y' => 2]]); - -$result = $manager->executeBulkWriteCommand($bulk); - -?> -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWriteCommand::replaceOne - MongoDB\Driver\BulkWriteCommand::updateMany - MongoDB\Driver\Manager::executeBulkWriteCommand - MongoDB\Driver\BulkWriteCommandResult - - - -
    - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommandresult.xml b/reference/mongodb/mongodb/driver/bulkwritecommandresult.xml deleted file mode 100644 index 2e6b0b331c2c..000000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommandresult.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - The MongoDB\Driver\BulkWriteCommandResult class - MongoDB\Driver\BulkWriteCommandResult - - - - -
    - &reftitle.intro; - - The MongoDB\Driver\BulkWriteCommandResult class - encapsulates information about an executed - MongoDB\Driver\BulkWriteCommand and is returned by - MongoDB\Driver\Manager::executeBulkWriteCommand. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\BulkWriteCommandResult - - - - final - - MongoDB\Driver\BulkWriteCommandResult - - - - - &Methods; - - - - -
    - -
    - - &reference.mongodb.mongodb.driver.entities.bulkwritecommandresult; - -
    - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommandresult/getdeletedcount.xml b/reference/mongodb/mongodb/driver/bulkwritecommandresult/getdeletedcount.xml deleted file mode 100644 index 7ad751d43995..000000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommandresult/getdeletedcount.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - MongoDB\Driver\BulkWriteCommandResult::getDeletedCount - Returns the number of documents deleted - - - - &reftitle.description; - - final public intMongoDB\Driver\BulkWriteCommandResult::getDeletedCount - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the total number of documents deleted by all operations. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - &mongodb.throws.unacknowledged; - - - - - &reftitle.examples; - - <function>MongoDB\Driver\BulkWriteCommandResult::getDeletedCount</function> example - -insertOne('db.coll', ['x' => 1]); -$bulk->updateOne('db.coll', ['x' => 1], ['$set' => ['y' => 3]]); -$bulk->updateOne('db.coll', ['x' => 2], ['$set' => ['y' => 1]], ['upsert' => true]); -$bulk->updateOne('db.coll', ['x' => 3], ['$set' => ['y' => 2]], ['upsert' => true]); -$bulk->deleteMany('db.coll', []); - -$result = $manager->executeBulkWriteCommand($bulk); - -var_dump($result->getDeletedCount()); - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWriteCommandResult::getDeleteResults - MongoDB\Driver\BulkWriteCommandResult::isAcknowledged - - - - - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommandresult/getdeleteresults.xml b/reference/mongodb/mongodb/driver/bulkwritecommandresult/getdeleteresults.xml deleted file mode 100644 index 9c5d235f528b..000000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommandresult/getdeleteresults.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - MongoDB\Driver\BulkWriteCommandResult::getDeleteResults - Returns verbose results for successful deletes - - - - &reftitle.description; - - final public MongoDB\BSON\DocumentnullMongoDB\Driver\BulkWriteCommandResult::getDeleteResults - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a document containing the result of each successful delete - operation, or &null; if verbose results were not requested. The document - keys will correspond to the index of the write operation from - MongoDB\Driver\BulkWriteCommand. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - &mongodb.throws.unacknowledged; - - - - - &reftitle.examples; - - <function>MongoDB\Driver\BulkWriteCommandResult::getDeleteResults</function> example - - true]); -$bulk->insertOne('db.coll', ['x' => 1]); -$bulk->updateOne('db.coll', ['x' => 1], ['$set' => ['y' => 3]]); -$bulk->updateOne('db.coll', ['x' => 2], ['$set' => ['y' => 1]], ['upsert' => true]); -$bulk->updateOne('db.coll', ['x' => 3], ['$set' => ['y' => 2]], ['upsert' => true]); -$bulk->deleteMany('db.coll', []); - -$result = $manager->executeBulkWriteCommand($bulk); - -var_dump($result->getDeleteResults()->toPHP()); - -?> -]]> - - &example.outputs.similar; - - - object(stdClass)#6 (1) { - ["deletedCount"]=> - object(MongoDB\BSON\Int64)#5 (1) { - ["integer"]=> - string(1) "3" - } - } -} -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWriteCommandResult::getDeletedCount - MongoDB\Driver\BulkWriteCommandResult::isAcknowledged - - - - - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommandresult/getinsertedcount.xml b/reference/mongodb/mongodb/driver/bulkwritecommandresult/getinsertedcount.xml deleted file mode 100644 index 5abe75d4735c..000000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommandresult/getinsertedcount.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - MongoDB\Driver\BulkWriteCommandResult::getInsertedCount - Returns the number of documents inserted - - - - &reftitle.description; - - final public intMongoDB\Driver\BulkWriteCommandResult::getInsertedCount - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the total number of documents inserted (excluding upserts) by all - operations. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - &mongodb.throws.unacknowledged; - - - - - &reftitle.examples; - - <function>MongoDB\Driver\BulkWriteCommandResult::getInsertedCount</function> example - -insertOne('db.coll', ['x' => 1]); -$bulk->updateOne('db.coll', ['x' => 1], ['$set' => ['y' => 3]]); -$bulk->updateOne('db.coll', ['x' => 2], ['$set' => ['y' => 1]], ['upsert' => true]); -$bulk->updateOne('db.coll', ['x' => 3], ['$set' => ['y' => 2]], ['upsert' => true]); -$bulk->deleteMany('db.coll', []); - -$result = $manager->executeBulkWriteCommand($bulk); - -var_dump($result->getInsertedCount()); - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWriteCommandResult::getInsertResults - MongoDB\Driver\BulkWriteCommandResult::isAcknowledged - - - - - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommandresult/getinsertresults.xml b/reference/mongodb/mongodb/driver/bulkwritecommandresult/getinsertresults.xml deleted file mode 100644 index 4a1986e5fa01..000000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommandresult/getinsertresults.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - MongoDB\Driver\BulkWriteCommandResult::getInsertResults - Returns verbose results for successful inserts - - - - &reftitle.description; - - final public MongoDB\BSON\DocumentnullMongoDB\Driver\BulkWriteCommandResult::getInsertResults - - - - Since _id fields for inserted documents are generated by - the extension when not explicitly provided, the value of - insertedId in each result will match the return value of - MongoDB\Driver\BulkWriteCommand::insertOne for - the corresponding insert operation. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a document containing the result of each successful insert - operation, or &null; if verbose results were not requested. The document - keys will correspond to the index of the write operation from - MongoDB\Driver\BulkWriteCommand. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - &mongodb.throws.unacknowledged; - - - - - &reftitle.examples; - - <function>MongoDB\Driver\BulkWriteCommandResult::getInsertResults</function> example - - true]); - -$generatedId = $bulk->insertOne('db.coll', ['x' => 1]); - -$bulk->updateOne('db.coll', ['x' => 1], ['$set' => ['y' => 3]]); -$bulk->updateOne('db.coll', ['x' => 2], ['$set' => ['y' => 1]], ['upsert' => true]); -$bulk->updateOne('db.coll', ['x' => 3], ['$set' => ['y' => 2]], ['upsert' => true]); -$bulk->deleteMany('db.coll', []); - -$result = $manager->executeBulkWriteCommand($bulk); - -var_dump($generatedId); - -var_dump($result->getInsertResults()->toPHP()); - -?> -]]> - - &example.outputs.similar; - - - string(24) "67f7ee69783dcce702097b41" -} -object(stdClass)#8 (1) { - ["0"]=> - object(stdClass)#7 (1) { - ["insertedId"]=> - object(MongoDB\BSON\ObjectId)#6 (1) { - ["oid"]=> - string(24) "67f7ee69783dcce702097b41" - } - } -} -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWriteCommandResult::getInsertedCount - MongoDB\Driver\BulkWriteCommandResult::isAcknowledged - MongoDB\Driver\BulkWriteCommand::insertOne - - - - - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommandresult/getmatchedcount.xml b/reference/mongodb/mongodb/driver/bulkwritecommandresult/getmatchedcount.xml deleted file mode 100644 index 8fb2a9a7bd03..000000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommandresult/getmatchedcount.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - MongoDB\Driver\BulkWriteCommandResult::getMatchedCount - Returns the number of documents selected for update - - - - &reftitle.description; - - final public intMongoDB\Driver\BulkWriteCommandResult::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\BulkWriteCommandResult::getModifiedCount. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the total number of documents selected for update by all operations. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - &mongodb.throws.unacknowledged; - - - - - &reftitle.examples; - - <function>MongoDB\Driver\BulkWriteCommandResult::getMatchedCount</function> example - -insertOne('db.coll', ['x' => 1]); -$bulk->updateOne('db.coll', ['x' => 1], ['$set' => ['y' => 3]]); -$bulk->updateOne('db.coll', ['x' => 2], ['$set' => ['y' => 1]], ['upsert' => true]); -$bulk->updateOne('db.coll', ['x' => 3], ['$set' => ['y' => 2]], ['upsert' => true]); -$bulk->deleteMany('db.coll', []); - -$result = $manager->executeBulkWriteCommand($bulk); - -var_dump($result->getMatchedCount()); - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWriteCommandResult::getModifiedCount - MongoDB\Driver\BulkWriteCommandResult::getUpdateResults - MongoDB\Driver\BulkWriteCommandResult::isAcknowledged - - - - - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommandresult/getmodifiedcount.xml b/reference/mongodb/mongodb/driver/bulkwritecommandresult/getmodifiedcount.xml deleted file mode 100644 index 3e68521a7e32..000000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommandresult/getmodifiedcount.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - MongoDB\Driver\BulkWriteCommandResult::getModifiedCount - Returns the number of existing documents updated - - - - &reftitle.description; - - final public intMongoDB\Driver\BulkWriteCommandResult::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\BulkWriteCommandResult::getMatchedCount. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the total number of existing documents updated by all operations. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - &mongodb.throws.unacknowledged; - - - - - &reftitle.examples; - - <function>MongoDB\Driver\BulkWriteCommandResult::getModifiedCount</function> example - -insertOne('db.coll', ['x' => 1]); -$bulk->updateOne('db.coll', ['x' => 1], ['$set' => ['y' => 3]]); -$bulk->updateOne('db.coll', ['x' => 2], ['$set' => ['y' => 1]], ['upsert' => true]); -$bulk->updateOne('db.coll', ['x' => 3], ['$set' => ['y' => 2]], ['upsert' => true]); -$bulk->deleteMany('db.coll', []); - -$result = $manager->executeBulkWriteCommand($bulk); - -var_dump($result->getModifiedCount()); - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWriteCommandResult::getMatchedCount - MongoDB\Driver\BulkWriteCommandResult::getUpdateResults - MongoDB\Driver\BulkWriteCommandResult::isAcknowledged - - - - - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommandresult/getupdateresults.xml b/reference/mongodb/mongodb/driver/bulkwritecommandresult/getupdateresults.xml deleted file mode 100644 index cab3f1e1d039..000000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommandresult/getupdateresults.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - - MongoDB\Driver\BulkWriteCommandResult::getUpdateResults - Returns verbose results for successful updates - - - - &reftitle.description; - - final public MongoDB\BSON\DocumentnullMongoDB\Driver\BulkWriteCommandResult::getUpdateResults - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a document containing the result of each successful update - operation, or &null; if verbose results were not requested. The document - keys will correspond to the index of the write operation from - MongoDB\Driver\BulkWriteCommand. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - &mongodb.throws.unacknowledged; - - - - - &reftitle.examples; - - <function>MongoDB\Driver\BulkWriteCommandResult::getUpdateResults</function> example - - true]); -$bulk->insertOne('db.coll', ['x' => 1]); -$bulk->updateOne('db.coll', ['x' => 1], ['$set' => ['y' => 3]]); -$bulk->updateOne('db.coll', ['x' => 2], ['$set' => ['y' => 1]], ['upsert' => true]); -$bulk->updateOne('db.coll', ['x' => 3], ['$set' => ['y' => 2]], ['upsert' => true]); -$bulk->deleteMany('db.coll', []); - -$result = $manager->executeBulkWriteCommand($bulk); - -var_dump($result->getUpdateResults()->toPHP()); - -?> -]]> - - &example.outputs.similar; - - - object(stdClass)#7 (2) { - ["matchedCount"]=> - object(MongoDB\BSON\Int64)#5 (1) { - ["integer"]=> - string(1) "1" - } - ["modifiedCount"]=> - object(MongoDB\BSON\Int64)#6 (1) { - ["integer"]=> - string(1) "1" - } - } - ["2"]=> - object(stdClass)#11 (3) { - ["matchedCount"]=> - object(MongoDB\BSON\Int64)#8 (1) { - ["integer"]=> - string(1) "1" - } - ["modifiedCount"]=> - object(MongoDB\BSON\Int64)#9 (1) { - ["integer"]=> - string(1) "0" - } - ["upsertedId"]=> - object(MongoDB\BSON\ObjectId)#10 (1) { - ["oid"]=> - string(24) "67f7eb9b1f198bbcb880d575" - } - } - ["3"]=> - object(stdClass)#15 (3) { - ["matchedCount"]=> - object(MongoDB\BSON\Int64)#12 (1) { - ["integer"]=> - string(1) "1" - } - ["modifiedCount"]=> - object(MongoDB\BSON\Int64)#13 (1) { - ["integer"]=> - string(1) "0" - } - ["upsertedId"]=> - object(MongoDB\BSON\ObjectId)#14 (1) { - ["oid"]=> - string(24) "67f7eb9b1f198bbcb880d576" - } - } -} -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWriteCommandResult::getMatchedCount - MongoDB\Driver\BulkWriteCommandResult::getModifiedCount - MongoDB\Driver\BulkWriteCommandResult::getUpsertedCount - MongoDB\Driver\BulkWriteCommandResult::isAcknowledged - - - - - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommandresult/getupsertedcount.xml b/reference/mongodb/mongodb/driver/bulkwritecommandresult/getupsertedcount.xml deleted file mode 100644 index e42e4c3b1ebf..000000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommandresult/getupsertedcount.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - MongoDB\Driver\BulkWriteCommandResult::getUpsertedCount - Returns the number of documents upserted - - - - &reftitle.description; - - final public intMongoDB\Driver\BulkWriteCommandResult::getUpsertedCount - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the total number of documents upserted by all operations. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - &mongodb.throws.unacknowledged; - - - - - &reftitle.examples; - - <function>MongoDB\Driver\BulkWriteCommandResult::getUpsertedCount</function> example - -insertOne('db.coll', ['x' => 1]); -$bulk->updateOne('db.coll', ['x' => 1], ['$set' => ['y' => 3]]); -$bulk->updateOne('db.coll', ['x' => 2], ['$set' => ['y' => 1]], ['upsert' => true]); -$bulk->updateOne('db.coll', ['x' => 3], ['$set' => ['y' => 2]], ['upsert' => true]); -$bulk->deleteMany('db.coll', []); - -$result = $manager->executeBulkWriteCommand($bulk); - -var_dump($result->getUpsertedCount()); - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWriteCommandResult::getUpdateResults - MongoDB\Driver\BulkWriteCommandResult::isAcknowledged - - - - - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommandresult/isacknowledged.xml b/reference/mongodb/mongodb/driver/bulkwritecommandresult/isacknowledged.xml deleted file mode 100644 index 9b833136db49..000000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommandresult/isacknowledged.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - MongoDB\Driver\BulkWriteCommandResult::isAcknowledged - Returns whether the write was acknowledged - - - - &reftitle.description; - - final public boolMongoDB\Driver\BulkWriteCommandResult::isAcknowledged - - - - If the write is acknowledged, other fields will be available on the - MongoDB\Driver\BulkWriteCommandResult 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\BulkWriteCommandResult::isAcknowledged</function> with acknowledged write concern - -insertOne('db.coll', ['x' => 1]); - -$result = $manager->executeBulkWriteCommand($bulk); - -var_dump($result->isAcknowledged()); - -?> -]]> - - &example.outputs; - - - - - - <function>MongoDB\Driver\BulkWriteCommandResult::isAcknowledged</function> with unacknowledged write concern - - false]); -$bulk->insertOne('db.coll', ['x' => 1]); - -$writeConcern = new MongoDB\Driver\WriteConcern(0); - -$result = $manager->executeBulkWriteCommand($bulk, ['writeConcern' => $writeConcern]); - -var_dump($result->isAcknowledged()); - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\WriteConcern - Write Concern reference - - - - - - diff --git a/reference/mongodb/mongodb/driver/clientencryption.xml b/reference/mongodb/mongodb/driver/clientencryption.xml deleted file mode 100644 index fd10c73c35ee..000000000000 --- a/reference/mongodb/mongodb/driver/clientencryption.xml +++ /dev/null @@ -1,254 +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 - - - const - string - MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED - Indexed - - - const - string - MongoDB\Driver\ClientEncryption::ALGORITHM_UNINDEXED - Unindexed - - - const - string - MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE - Range - - - const - string - MongoDB\Driver\ClientEncryption::QUERY_TYPE_EQUALITY - equality - - - const - string - MongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE - range - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - MongoDB\Driver\ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_DETERMINISTIC - - Specifies an algorithm for deterministic encryption, which is suitable for querying. - - - - - MongoDB\Driver\ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_RANDOM - - Specifies an algorithm for randomized encryption - - - - - MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED - - Specifies an algorithm for an indexed, encrypted payload, which can be used with queryable encryption. - To insert or query with an indexed, encrypted payload, the MongoDB\Driver\Manager must be configured with the "autoEncryption" driver option. The "bypassQueryAnalysis" auto encryption option may be &true;. The "bypassAutoEncryption" auto encryption option must be &false;. - - - - - MongoDB\Driver\ClientEncryption::ALGORITHM_UNINDEXED - - Specifies an algorithm for an unindexed, encrypted payload. - - - - - MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE - - - Specifies an algorithm for a range encrypted payload, which can be used - with queryable encryption. - - - To query with a range encrypted payload, the - MongoDB\Driver\Manager must be configured with the - "autoEncryption" driver option. The - "bypassQueryAnalysis" auto encryption option may be - &true;. The "bypassAutoEncryption" auto encryption - option must be &false;. - - - The extension does not yet support range queries for Decimal128 BSON field types. - - - - - - MongoDB\Driver\ClientEncryption::QUERY_TYPE_EQUALITY - - - Specifies an equality query type, which is used in conjunction with - MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED. - - - - - - MongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE - - - Specifies a range query type, which is used in conjunction with - MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE. - - - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.0.0 - - - Removed MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW - and MongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE_PREVIEW. - - - - - PECL mongodb 1.20.0 - - - Added MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE - and MongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE. - - - Deprecated MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW - and MongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE_PREVIEW. - - - - - PECL mongodb 1.16.0 - - Added MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW - and MongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE_PREVIEW. - - - - PECL mongodb 1.14.0 - - Added MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED, - MongoDB\Driver\ClientEncryption::ALGORITHM_UNINDEXED, - and MongoDB\Driver\ClientEncryption::QUERY_TYPE_EQUALITY. - - - - - -
    - -
    - &reftitle.seealso; - - MongoDB\Driver\Manager::createClientEncryption - -
    - -
    - - &reference.mongodb.mongodb.driver.entities.clientencryption; - -
    - - diff --git a/reference/mongodb/mongodb/driver/clientencryption/addkeyaltname.xml b/reference/mongodb/mongodb/driver/clientencryption/addkeyaltname.xml deleted file mode 100644 index a48595e1d43f..000000000000 --- a/reference/mongodb/mongodb/driver/clientencryption/addkeyaltname.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - MongoDB\Driver\ClientEncryption::addKeyAltName - Adds an alternate name to a key document - - - - &reftitle.description; - - final public objectnullMongoDB\Driver\ClientEncryption::addKeyAltName - MongoDB\BSON\BinarykeyId - stringkeyAltName - - - Adds keyAltName to the set of alternate names for the - key document with the given UUID keyId. - - - - - &reftitle.parameters; - - - keyId - - - A MongoDB\BSON\Binary instance with subtype 4 - (UUID) identifying the key document. - - - - - - keyAltName - - - Alternate name to add to the key document. - - - - - - - - &reftitle.returnvalues; - - Returns the previous version of the key document, or &null; if no document - matched. - - - - - &reftitle.errors; - - &mongodb.throws.std; - Throws MongoDB\Driver\Exception\RuntimeException on other errors. - - - - - &reftitle.seealso; - - MongoDB\Driver\ClientEncryption::getKeyByAltName - MongoDB\Driver\ClientEncryption::removeKeyAltName - - - - - diff --git a/reference/mongodb/mongodb/driver/clientencryption/construct.xml b/reference/mongodb/mongodb/driver/clientencryption/construct.xml deleted file mode 100644 index 044af3620ec5..000000000000 --- a/reference/mongodb/mongodb/driver/clientencryption/construct.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - MongoDB\Driver\ClientEncryption::__construct - Create a new ClientEncryption object - - - - &reftitle.description; - - final public MongoDB\Driver\ClientEncryption::__construct - arrayoptions - - - Constructs a new MongoDB\Driver\ClientEncryption object with the specified options. - - - - - &reftitle.parameters; - - - options - - - - options - - - - Option - Type - Description - - - - - keyVaultClient - MongoDB\Driver\Manager - The Manager used to route data key queries. This option is required (unlike with MongoDB\Driver\Manager::createClientEncryption). - - &mongodb.option.encryption.keyVaultNamespace; - &mongodb.option.encryption.kmsProviders; - &mongodb.option.encryption.tlsOptions; - - -
    -
    -
    -
    -
    -
    - - - &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.16.0 - - - The AWS KMS provider for client-side encryption now accepts a - "sessionToken" option, which can be used to - authenticate with temporary AWS credentials. - - - Added "tlsDisableOCSPEndpointCheck" to the - "tlsOptions" option. - - - If an empty document is specified for the "azure" or - "gcp" KMS provider, the driver will attempt to - configure the provider using - Automatic Credentials. - - - - - PECL mongodb 1.15.0 - - - If an empty document is specified for the "aws" KMS - provider, the driver will attempt to configure the provider using - Automatic Credentials. - - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::createClientEncryption - Explicit (Manual) Client-Side Field Level Encryption in the MongoDB manual - - - -
    - - diff --git a/reference/mongodb/mongodb/driver/clientencryption/createdatakey.xml b/reference/mongodb/mongodb/driver/clientencryption/createdatakey.xml deleted file mode 100644 index 995bfad5c5b1..000000000000 --- a/reference/mongodb/mongodb/driver/clientencryption/createdatakey.xml +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - MongoDB\Driver\ClientEncryption::createDataKey - Creates a key document - - - - &reftitle.description; - - final public MongoDB\BSON\BinaryMongoDB\Driver\ClientEncryption::createDataKey - stringkmsProvider - arraynulloptions&null; - - - Creates a new key document and inserts it into the key vault collection. - - - - - &reftitle.parameters; - - - kmsProvider - - - The KMS provider (e.g. "local", - "aws") that will be used to encrypt the new data key. - - - - - - options - - - - Data key options - - - - Option - Type - Description - - - - - masterKey - array - - - The masterKey document identifies a KMS-specific key used to encrypt - the new data key. This option is required unless - kmsProvider is "local". - - &mongodb.option.encryption.masterKey-options-by-provider; - - - - 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. - - - - - keyMaterial - MongoDB\BSON\Binary - - - An optional 96-byte value to use as custom key material for the data - key being created. If keyMaterial is given, the custom key material - is used for encrypting and decrypting data. Otherwise, the key - material for the new data key is generated from a cryptographically - secure random device. - - - - - -
    -
    -
    -
    -
    -
    - - - &reftitle.returnvalues; - - Returns the identifier of the new key as a - MongoDB\BSON\Binary object with subtype 4 (UUID). - - - - - &reftitle.errors; - - &mongodb.throws.std; - Throws MongoDB\Driver\Exception\RuntimeException on other errors. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.20.0 - - Added "delegated" to the KMIP provider masterKey options. - - - - PECL mongodb 1.15.0 - - Added the "keyMaterial" option. - - - - 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 7753f4996cd4..000000000000 --- 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/deletekey.xml b/reference/mongodb/mongodb/driver/clientencryption/deletekey.xml deleted file mode 100644 index 398b5397b4b4..000000000000 --- a/reference/mongodb/mongodb/driver/clientencryption/deletekey.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - MongoDB\Driver\ClientEncryption::deleteKey - Deletes a key document - - - - &reftitle.description; - - final public objectMongoDB\Driver\ClientEncryption::deleteKey - MongoDB\BSON\BinarykeyId - - - Removes the key document with the given UUID keyId - from the key vault collection. - - - - - &reftitle.parameters; - - - keyId - - - A MongoDB\BSON\Binary instance with subtype 4 - (UUID) identifying the key document. - - - - - - - - &reftitle.returnvalues; - - Returns the result of the internal deleteOne operation on - the key vault collection. - - - - - &reftitle.errors; - - &mongodb.throws.std; - Throws MongoDB\Driver\Exception\RuntimeException on other errors. - - - - - diff --git a/reference/mongodb/mongodb/driver/clientencryption/encrypt.xml b/reference/mongodb/mongodb/driver/clientencryption/encrypt.xml deleted file mode 100644 index af39a7e2b529..000000000000 --- a/reference/mongodb/mongodb/driver/clientencryption/encrypt.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - MongoDB\Driver\ClientEncryption::encrypt - Encrypt a value - - - - &reftitle.description; - - final public MongoDB\BSON\BinaryMongoDB\Driver\ClientEncryption::encrypt - mixedvalue - arraynulloptions&null; - - - 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. - - - - &mongodb.parameter.encryptOpts; - - - - - &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.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.20.0 - - Added the "trimFactor" range option. The - "sparsity" range option is now optional. - - - - PECL mongodb 1.16.0 - - Added the "rangeOpts" option. - - - - PECL mongodb 1.14.0 - - Added the "contentionFactor" and - "queryType" options. - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\ClientEncryption::decrypt - MongoDB\Driver\ClientEncryption::encryptExpression - - - - - - diff --git a/reference/mongodb/mongodb/driver/clientencryption/encryptexpression.xml b/reference/mongodb/mongodb/driver/clientencryption/encryptexpression.xml deleted file mode 100644 index 284b88462b89..000000000000 --- a/reference/mongodb/mongodb/driver/clientencryption/encryptexpression.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - MongoDB\Driver\ClientEncryption::encryptExpression - Encrypts a match or aggregate expression - - - - &reftitle.description; - - final public objectMongoDB\Driver\ClientEncryption::encryptExpression - arrayobjectexpr - arraynulloptions&null; - - - Encrypts a match or aggregate expression to query a range index. - - To query with a range encrypted payload, the MongoDB\Driver\Manager must be configured with the "autoEncryption" driver option. The "bypassQueryAnalysis" auto encryption option may be &true;. The "bypassAutoEncryption" auto encryption option must be &false;. - - The extension does not yet support range queries for Decimal128 BSON field types. - - - - - &reftitle.parameters; - - - expr - - - The match or aggregate expression to be encrypted. Expressions must use at - least one of the $gt, $gte, - $lt, or $lte operators. A top-level - $and operator is required, even if only a single - comparison operator is used. - - - An example of a supported match expression (applies to queries and the - $match aggregation stage) is as follows: - - - [ - [ '' => [ '$gt' => '' ] ], - [ '' => [ '$lte' => '' ] ], - ], -] -]]> - - - An example of a supported aggregate expression is as follows: - - - [ - [ '$gte' => [ '', '' ] ], - [ '$lt' => [ '', '' ] ], - ], -] -]]> - - - - &mongodb.parameter.encryptOpts; - - - - - &reftitle.returnvalues; - - Returns the encrypted expression as an object. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\EncryptionException if an error occurs while encrypting the expression - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.20.0 - - Added the "trimFactor" range option. The - "sparsity" range option is now optional. - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::__construct - MongoDB\Driver\ClientEncryption::encrypt - - - - - - diff --git a/reference/mongodb/mongodb/driver/clientencryption/getkey.xml b/reference/mongodb/mongodb/driver/clientencryption/getkey.xml deleted file mode 100644 index 6d60326359d2..000000000000 --- a/reference/mongodb/mongodb/driver/clientencryption/getkey.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - MongoDB\Driver\ClientEncryption::getKey - Gets a key document - - - - &reftitle.description; - - final public objectnullMongoDB\Driver\ClientEncryption::getKey - MongoDB\BSON\BinarykeyId - - - Finds a single key document in the key vault collection with the given UUID - keyId. - - - - - &reftitle.parameters; - - - keyId - - - A MongoDB\BSON\Binary instance with subtype 4 - (UUID) identifying the key document. - - - - - - - - &reftitle.returnvalues; - - Returns the key document, or &null; if no document matched. - - - - - &reftitle.errors; - - &mongodb.throws.std; - Throws MongoDB\Driver\Exception\RuntimeException on other errors. - - - - - diff --git a/reference/mongodb/mongodb/driver/clientencryption/getkeybyaltname.xml b/reference/mongodb/mongodb/driver/clientencryption/getkeybyaltname.xml deleted file mode 100644 index 3fa9f2def180..000000000000 --- a/reference/mongodb/mongodb/driver/clientencryption/getkeybyaltname.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - MongoDB\Driver\ClientEncryption::getKeyByAltName - Gets a key document by an alternate name - - - - &reftitle.description; - - final public objectnullMongoDB\Driver\ClientEncryption::getKeyByAltName - stringkeyAltName - - - Finds a single key document in the key vault collection with the given - alternate name keyAltName. - - - - - &reftitle.parameters; - - - keyAltName - - - Alternate name for the key document. - - - - - - - - &reftitle.returnvalues; - - Returns the key document, or &null; if no document matched. - - - - - &reftitle.errors; - - &mongodb.throws.std; - Throws MongoDB\Driver\Exception\RuntimeException on other errors. - - - - - &reftitle.seealso; - - MongoDB\Driver\ClientEncryption::addKeyAltName - MongoDB\Driver\ClientEncryption::removeKeyAltName - - - - - diff --git a/reference/mongodb/mongodb/driver/clientencryption/getkeys.xml b/reference/mongodb/mongodb/driver/clientencryption/getkeys.xml deleted file mode 100644 index db0a84be4dd0..000000000000 --- a/reference/mongodb/mongodb/driver/clientencryption/getkeys.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - MongoDB\Driver\ClientEncryption::getKeys - Gets all key documents - - - - &reftitle.description; - - final public MongoDB\Driver\CursorMongoDB\Driver\ClientEncryption::getKeys - - - - Finds all key documents in the key vault collection. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - &mongodb.returns.cursor; - - - - &reftitle.errors; - - &mongodb.throws.std; - Throws MongoDB\Driver\Exception\RuntimeException on other errors. - - - - - diff --git a/reference/mongodb/mongodb/driver/clientencryption/removekeyaltname.xml b/reference/mongodb/mongodb/driver/clientencryption/removekeyaltname.xml deleted file mode 100644 index 25f59ed161fd..000000000000 --- a/reference/mongodb/mongodb/driver/clientencryption/removekeyaltname.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - MongoDB\Driver\ClientEncryption::removeKeyAltName - Removes an alternate name from a key document - - - - &reftitle.description; - - final public objectnullMongoDB\Driver\ClientEncryption::removeKeyAltName - MongoDB\BSON\BinarykeyId - stringkeyAltName - - - Removes keyAltName from the set of alternate names for - the key document with the given UUID keyId. - - - - - &reftitle.parameters; - - - keyId - - - A MongoDB\BSON\Binary instance with subtype 4 - (UUID) identifying the key document. - - - - - - keyAltName - - - Alternate name to remove from the key document. - - - - - - - - &reftitle.returnvalues; - - Returns the previous version of the key document, or &null; if no document - matched. - - - - - &reftitle.errors; - - &mongodb.throws.std; - Throws MongoDB\Driver\Exception\RuntimeException on other errors. - - - - - &reftitle.seealso; - - MongoDB\Driver\ClientEncryption::addKeyAltName - MongoDB\Driver\ClientEncryption::getKeyByAltName - - - - - diff --git a/reference/mongodb/mongodb/driver/clientencryption/rewrapmanydatakey.xml b/reference/mongodb/mongodb/driver/clientencryption/rewrapmanydatakey.xml deleted file mode 100644 index 66e7b9036310..000000000000 --- a/reference/mongodb/mongodb/driver/clientencryption/rewrapmanydatakey.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - MongoDB\Driver\ClientEncryption::rewrapManyDataKey - Rewraps data keys - - - - &reftitle.description; - - final public objectMongoDB\Driver\ClientEncryption::rewrapManyDataKey - arrayobjectfilter - arraynulloptions&null; - - - Rewraps (i.e. decrypts and re-encrypts) zero or more data keys in the key - vault collection that match the given filter. - - - If the "provider" option is not specified, matching data - keys will be rewrapped with their current KMS provider. Otherwise, matching - data keys will be re-encrypted according to the specified - "provider" and "masterKey" options. - - - - - &reftitle.parameters; - - &mongodb.parameter.filter; - - options - - - - RewrapManyDataKey options - - - - Option - Type - Description - - - - - provider - string - - - The KMS provider (e.g. "local", - "aws") that will be used to re-encrypt the - matched data keys. - - - If a KMS provider is not specified, matched data keys will be - re-encrypted with their current KMS provider. - - - - - masterKey - array - - - The masterKey identifies a KMS-specific key used to encrypt the new - data key. This option should not be specified without the - "provider" option. This option is required if - "provider" is specified and not - "local". - - &mongodb.option.encryption.masterKey-options-by-provider; - - - - -
    -
    -
    -
    -
    -
    - - - &reftitle.returnvalues; - - Returns an object, which will have an optional - bulkWriteResult property containing the result of the - internal bulkWrite operation as an object. If no data keys - matched the filter or the write was unacknowledged, the - bulkWriteResult property will be &null;. - - - - - &reftitle.errors; - - &mongodb.throws.std; - Throws MongoDB\Driver\Exception\EncryptionException if an error occurs while decrypting or re-encrypting a data key. - Throws MongoDB\Driver\Exception\RuntimeException on other errors. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.20.0 - - Added "delegated" to the KMIP provider masterKey options. - - - - - - -
    - - diff --git a/reference/mongodb/mongodb/driver/command.xml b/reference/mongodb/mongodb/driver/command.xml deleted file mode 100644 index 270a15db2681..000000000000 --- 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 6956c79c0f1c..000000000000 --- a/reference/mongodb/mongodb/driver/command/construct.xml +++ /dev/null @@ -1,260 +0,0 @@ - - - - - - MongoDB\Driver\Command::__construct - Create a new Command - - - - &reftitle.description; - - final public MongoDB\Driver\Command::__construct - arrayobjectdocument - arraynullcommandOptions&null; - - - 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 c1edfc430563..000000000000 --- a/reference/mongodb/mongodb/driver/cursor.xml +++ /dev/null @@ -1,312 +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 - - - - - &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 6a0f1acf4363..000000000000 --- 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 6792469237bb..000000000000 --- 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 arrayobjectnullMongoDB\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 9a5c99b80187..000000000000 --- a/reference/mongodb/mongodb/driver/cursor/getid.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - - MongoDB\Driver\Cursor::getId - Returns the ID for this cursor - - - - &reftitle.description; - - final public MongoDB\BSON\Int64MongoDB\Driver\Cursor::getId - - - - Returns the ID for this cursor, which uniquely identifies the cursor on the - server. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the ID for this cursor. The ID will be returned as a - MongoDB\BSON\Int64 object. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.0.0 - - The return type was changed to MongoDB\BSON\Int64. - The asInt64 parameter was removed. - - - - PECL mongodb 1.20.0 - - Deprecated returning a MongoDB\Driver\CursorId. - Added the asInt64 argument to ease migration for - future versions. If asInt64 is &true;, the ID - will be returned as a MongoDB\BSON\Int64. - - - - - - - - - &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(true)); - -?> -]]> - - &example.outputs.similar; - - - string(11) "94810124093" -} -]]> - - - - - - - &reftitle.seealso; - - MongoDB\BSON\Int64 - - - - - - diff --git a/reference/mongodb/mongodb/driver/cursor/getserver.xml b/reference/mongodb/mongodb/driver/cursor/getserver.xml deleted file mode 100644 index c4c754dace80..000000000000 --- 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 2c1f917888b7..000000000000 --- 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 53672b72a53e..000000000000 --- 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 2f66d3a325b3..000000000000 --- 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 548d1ec8e3ac..000000000000 --- 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 2d74b8fad38f..000000000000 --- 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 4b7e6c275198..000000000000 --- 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 253fc9a568ec..000000000000 --- 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 6285ae7c2f9f..000000000000 --- a/reference/mongodb/mongodb/driver/cursorid.xml +++ /dev/null @@ -1,121 +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. - - - - This class has been DEPRECATED as of extension - version 1.20.0 and was removed in 2.0. Applications have to update their - usage of MongoDB\Driver\Cursor::getId to return - MongoDB\BSON\Int64 instead. - - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\CursorId - - - - final - - MongoDB\Driver\CursorId - - - - Serializable - - - - Stringable - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.class-removed; - - PECL mongodb 1.20.0 - - This class has been deprecated and will be removed in version 2.0. - - - - 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 b8b85a174ce1..000000000000 --- 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/tostring.xml b/reference/mongodb/mongodb/driver/cursorid/tostring.xml deleted file mode 100644 index 9cd67482153b..000000000000 --- 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/cursorinterface.xml b/reference/mongodb/mongodb/driver/cursorinterface.xml deleted file mode 100644 index 84f3689135d4..000000000000 --- a/reference/mongodb/mongodb/driver/cursorinterface.xml +++ /dev/null @@ -1,101 +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 - - - - Iterator - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.0.0 - - - This interface now extends Iterator. - - - Return types previously declared as tentative are now enforced. - - - - &mongodb.changelog.tentative-return-types; - - - -
    - -
    - - &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 fad90fef74f9..000000000000 --- a/reference/mongodb/mongodb/driver/cursorinterface/getid.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - MongoDB\Driver\CursorInterface::getId - Returns the ID for this cursor - - - - &reftitle.description; - - abstract public MongoDB\BSON\Int64MongoDB\Driver\CursorInterface::getId - - - - Returns the ID for this cursor, which uniquely identifies the cursor on the - server. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the ID for this cursor. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.20.0 - - Added MongoDB\BSON\Int64 to the tentative return - type for this method. MongoDB\Driver\CursorId - will be removed from the return type in version 2.0. - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Cursor::getId - MongoDB\Driver\CursorId - MongoDB\BSON\Int64 - - - - - - diff --git a/reference/mongodb/mongodb/driver/cursorinterface/getserver.xml b/reference/mongodb/mongodb/driver/cursorinterface/getserver.xml deleted file mode 100644 index 1c69a5c2a9e1..000000000000 --- 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 9f46c8306776..000000000000 --- 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 54fcec2ade1b..000000000000 --- 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 e1f1dfecc936..000000000000 --- 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/exception/authenticationexception.xml b/reference/mongodb/mongodb/driver/exception/authenticationexception.xml deleted file mode 100644 index 879dd85b086a..000000000000 --- 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/bulkwritecommandexception.xml b/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception.xml deleted file mode 100644 index cc34384f21cf..000000000000 --- a/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception.xml +++ /dev/null @@ -1,165 +0,0 @@ - - - - - - The MongoDB\Driver\Exception\BulkWriteCommandException class - MongoDB\Driver\Exception\BulkWriteCommandException - - - - -
    - &reftitle.intro; - - Exception thrown due to failed execution of a - MongoDB\Driver\BulkWriteCommand. The methods of this - class provide more details of the error that occurred, including the error - reply and partial results from the bulk write. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Exception\BulkWriteCommandException - - - - - MongoDB\Driver\Exception\BulkWriteCommandException - - - - extends - MongoDB\Driver\Exception\ServerException - - - - MongoDB\Driver\Exception\Exception - - - - &Properties; - - private - MongoDB\BSON\Documentnull - errorReply - - - private - MongoDB\Driver\BulkWriteCommandResultnull - partialResult - - - private - array - writeConcernErrors - - - private - array - writeErrors - - - &InheritedProperties; - - - - - - &Methods; - - - &InheritedMethods; - - - - - - - -
    - - -
    - &reftitle.properties; - - - errorReply - - - Any top-level error that occurred when attempting to communicate with - the server or execute the bulk write. This value may be &null; if the - exception was thrown due to errors occurring on individual writes. - - - - - partialResult - - - A MongoDB\Driver\BulkWriteCommandResult reporting - the result of any successful operations that were performed before the - error was encountered. This value may be &null; if it cannot be - determined that at least one write was successfully performed (and - acknowledged). - - - - - writeConcernErrors - - - An array of any MongoDB\Driver\WriteConcernErrors - that occurred while executing the bulk write. This list may have - multiple items if more than one server command was required to execute - the bulk write. - - - - - writeErrors - - - An array of any MongoDB\Driver\WriteErrors - that occurred during the execution of individual write operations. Array - keys will correspond to the index of the write operation from - MongoDB\Driver\BulkWriteCommand. This map will - contain at most one entry if the bulk write was ordered. - - - - -
    - - -
    - - &reference.mongodb.mongodb.driver.exception.entities.bulkwritecommandexception; - -
    - - diff --git a/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception/geterrorreply.xml b/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception/geterrorreply.xml deleted file mode 100644 index ea1504190bd7..000000000000 --- a/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception/geterrorreply.xml +++ /dev/null @@ -1,144 +0,0 @@ - - - - - - MongoDB\Driver\Exception\BulkWriteCommandException::getErrorReply - Returns any top-level command error - - - - &reftitle.description; - - final public MongoDB\BSON\DocumentnullMongoDB\Driver\Exception\BulkWriteCommandException::getErrorReply - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns any top-level error that occurred when attempting to communicate - with the server or execute the bulk write. This value may be &null; if the - exception was thrown due to errors occurring on individual writes. - - - - - &reftitle.examples; - - <function>MongoDB\Driver\Exception\BulkWriteCommandException::getErrorReply</function> example - -executeCommand('admin', new MongoDB\Driver\Command([ - 'configureFailPoint' => 'failCommand', - 'mode' => ['times' => 1], - 'data' => [ - 'failCommands' => ['bulkWrite'], - 'errorCode' => 8, /* UnknownError */ - ], -])); - -$bulk = new MongoDB\Driver\BulkWriteCommand; -$bulk->insertOne('db.coll', ['x' => 1]); - -try { - $result = $manager->executeBulkWriteCommand($bulk); -} catch (MongoDB\Driver\Exception\BulkWriteCommandException $e) { - var_dump($e->getErrorReply()?->toPHP()); -} - -?> -]]> - - &example.outputs.similar; - - - float(0) - ["errmsg"]=> - string(43) "Failing command via 'failCommand' failpoint" - ["code"]=> - int(8) - ["codeName"]=> - string(12) "UnknownError" - ["$clusterTime"]=> - object(stdClass)#10 (2) { - ["clusterTime"]=> - object(MongoDB\BSON\Timestamp)#6 (2) { - ["increment"]=> - string(1) "7" - ["timestamp"]=> - string(10) "1744319389" - } - ["signature"]=> - object(stdClass)#9 (2) { - ["hash"]=> - object(MongoDB\BSON\Binary)#7 (2) { - ["data"]=> - string(20) "" - ["type"]=> - int(0) - } - ["keyId"]=> - object(MongoDB\BSON\Int64)#8 (1) { - ["integer"]=> - string(1) "0" - } - } - } - ["operationTime"]=> - object(MongoDB\BSON\Timestamp)#11 (2) { - ["increment"]=> - string(1) "7" - ["timestamp"]=> - string(10) "1744319389" - } -} -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::executeBulkWriteCommand - - - - - - diff --git a/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception/getpartialresult.xml b/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception/getpartialresult.xml deleted file mode 100644 index d09a00b4a372..000000000000 --- a/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception/getpartialresult.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - MongoDB\Driver\Exception\BulkWriteCommandException::getPartialResult - Returns the result of any successful write operations - - - - &reftitle.description; - - final public MongoDB\Driver\BulkWriteCommandResultnullMongoDB\Driver\Exception\BulkWriteCommandException::getPartialResult - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a MongoDB\Driver\BulkWriteCommandResult - reporting the result of any successful operations that were performed before - the error was encountered. The return value will be &null; if it cannot be - determined that at least one write was successfully performed (and - acknowledged). - - - - - &reftitle.examples; - - Partial result if at least one write is successful - -deleteMany('db.coll', []); -$bulk->insertOne('db.coll', ['_id' => 1]); -$bulk->insertOne('db.coll', ['_id' => 1]); - -try { - $result = $manager->executeBulkWriteCommand($bulk); -} catch (MongoDB\Driver\Exception\BulkWriteCommandException $e) { - $result = $e->getPartialResult(); -} - -var_dump($result?->getInsertedCount()); - -?> -]]> - - &example.outputs; - - - - - - No partial result if no writes are successful - -deleteMany('db.coll', []); -$bulk->insertOne('db.coll', ['_id' => 1]); -$manager->executeBulkWriteCommand($bulk); - -$bulk = new MongoDB\Driver\BulkWriteCommand; -$bulk->insertOne('db.coll', ['_id' => 1]); - -try { - $result = $manager->executeBulkWriteCommand($bulk); -} catch (MongoDB\Driver\Exception\BulkWriteCommandException $e) { - $result = $e->getPartialResult(); -} - -var_dump($result?->getInsertedCount()); - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWriteCommandResult - MongoDB\Driver\Manager::executeBulkWriteCommand - - - - - - diff --git a/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception/getwriteconcernerrors.xml b/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception/getwriteconcernerrors.xml deleted file mode 100644 index b8198261d6dc..000000000000 --- a/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception/getwriteconcernerrors.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - MongoDB\Driver\Exception\BulkWriteCommandException::getWriteConcernErrors - Returns any write concern errors - - - - &reftitle.description; - - final public arrayMongoDB\Driver\Exception\BulkWriteCommandException::getWriteConcernErrors - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - An array of any MongoDB\Driver\WriteConcernErrors - that occurred while executing the bulk write. This list may have multiple - items if more than one server command was required to execute the bulk - write. - - - - - &reftitle.examples; - - <function>MongoDB\Driver\Exception\BulkWriteCommandException::getWriteConcernErrors</function> example - -insertOne('db.coll', ['x' => 1]); - -$writeConcern = new MongoDB\Driver\WriteConcern(50); - -try { - $result = $manager->executeBulkWriteCommand($bulk, ['writeConcern' => $writeConcern]); -} catch (MongoDB\Driver\Exception\BulkWriteCommandException $e) { - var_dump($e->getWriteConcernErrors()); -} - -?> -]]> - - &example.outputs.similar; - - - object(MongoDB\Driver\WriteConcernError)#6 (3) { - ["message"]=> - string(29) "Not enough data-bearing nodes" - ["code"]=> - int(100) - ["info"]=> - object(stdClass)#8 (1) { - ["writeConcern"]=> - object(stdClass)#7 (3) { - ["w"]=> - int(50) - ["wtimeout"]=> - int(0) - ["provenance"]=> - string(14) "clientSupplied" - } - } - } -} -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::executeBulkWriteCommand - MongoDB\Driver\WriteConcern - MongoDB\Driver\WriteConcernError - - - - - - diff --git a/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception/getwriteerrors.xml b/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception/getwriteerrors.xml deleted file mode 100644 index 1d80e52c5680..000000000000 --- a/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception/getwriteerrors.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - MongoDB\Driver\Exception\BulkWriteCommandException::getWriteErrors - Returns any write errors - - - - &reftitle.description; - - final public arrayMongoDB\Driver\Exception\BulkWriteCommandException::getWriteErrors - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - An array of any MongoDB\Driver\WriteErrors that - occurred during the execution of individual write operations. Array keys - will correspond to the index of the write operation from - MongoDB\Driver\BulkWriteCommand. This map will - contain at most one entry if the bulk write was ordered. - - - - - &reftitle.examples; - - <function>MongoDB\Driver\Exception\BulkWriteCommandException::getWriteErrors</function> example - - false]); -$bulk->deleteMany('db.coll', []); -$bulk->insertOne('db.coll', ['_id' => 1]); -$bulk->insertOne('db.coll', ['_id' => 1]); -$bulk->insertOne('db.coll', ['_id' => 1]); - -try { - $result = $manager->executeBulkWriteCommand($bulk); -} catch (MongoDB\Driver\Exception\BulkWriteCommandException $e) { - var_dump($e->getWriteErrors()); -} - -?> -]]> - - &example.outputs.similar; - - - object(MongoDB\Driver\WriteError)#5 (4) { - ["message"]=> - string(78) "E11000 duplicate key error collection: db.coll index: _id_ dup key: { _id: 1 }" - ["code"]=> - int(11000) - ["index"]=> - int(2) - ["info"]=> - object(stdClass)#6 (0) { - } - } - [3]=> - object(MongoDB\Driver\WriteError)#7 (4) { - ["message"]=> - string(78) "E11000 duplicate key error collection: db.coll index: _id_ dup key: { _id: 1 }" - ["code"]=> - int(11000) - ["index"]=> - int(3) - ["info"]=> - object(stdClass)#8 (0) { - } - } -} -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::executeBulkWriteCommand - MongoDB\Driver\WriteError - - - - - - diff --git a/reference/mongodb/mongodb/driver/exception/bulkwriteexception.xml b/reference/mongodb/mongodb/driver/exception/bulkwriteexception.xml deleted file mode 100644 index c6b8f08ca006..000000000000 --- a/reference/mongodb/mongodb/driver/exception/bulkwriteexception.xml +++ /dev/null @@ -1,146 +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\ServerException - - - - MongoDB\Driver\Exception\Exception - - - - &Properties; - - public - readonly - 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 2.3.0 - - The writeResult property is now - public readonly. - - - - PECL mongodb 2.0.0 - - - This class now extends - MongoDB\Driver\Exception\ServerException - instead of - MongoDB\Driver\Exception\WriteException. - - - - - - -
    -
    - - &reference.mongodb.mongodb.driver.exception.entities.bulkwriteexception; - -
    - - diff --git a/reference/mongodb/mongodb/driver/exception/bulkwriteexception/getwriteresult.xml b/reference/mongodb/mongodb/driver/exception/bulkwriteexception/getwriteresult.xml deleted file mode 100644 index f155b4d6d398..000000000000 --- a/reference/mongodb/mongodb/driver/exception/bulkwriteexception/getwriteresult.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - MongoDB\Driver\Exception\BulkWriteException::getWriteResult - Returns the WriteResult for the failed write operation - - - - &reftitle.description; - - final public MongoDB\Driver\WriteResultMongoDB\Driver\Exception\BulkWriteException::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\BulkWriteException::getWriteResult</function> example - -insert(['_id' => 1]); -$bulk->insert(['_id' => 1]); - -try { - $manager->executeBulkWrite('db.collection', $bulk); -} catch (MongoDB\Driver\Exception\BulkWriteException $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/exception/commandexception.xml b/reference/mongodb/mongodb/driver/exception/commandexception.xml deleted file mode 100644 index f817719aab09..000000000000 --- a/reference/mongodb/mongodb/driver/exception/commandexception.xml +++ /dev/null @@ -1,136 +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; - - public - readonly - object - resultDocument - - - &InheritedProperties; - - - - - - &Methods; - - - &InheritedMethods; - - - - - - - - -
    - - - -
    - &reftitle.properties; - - - resultDocument - - - The result document associated with the failed command. - - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - The resultDocument property is now - public readonly. - - - - - -
    - -
    - - &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 02a2a6b62420..000000000000 --- 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 eebc83cc6c6b..000000000000 --- 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 d3ee0ab22d09..000000000000 --- 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 b64ed7224c1d..000000000000 --- 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/exception.xml b/reference/mongodb/mongodb/driver/exception/exception.xml deleted file mode 100644 index 28eaba256557..000000000000 --- a/reference/mongodb/mongodb/driver/exception/exception.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - The MongoDB\Driver\Exception\Exception interface - MongoDB\Driver\Exception\Exception - - - - -
    - &reftitle.intro; - - Common interface for all extension exceptions. This interface is also used - by the library, and may be used to identify any exceptions originating from - the MongoDB PHP driver (i.e. extension and library). - -
    - - -
    - &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 37539dc8b7b9..000000000000 --- a/reference/mongodb/mongodb/driver/exception/executiontimeoutexception.xml +++ /dev/null @@ -1,113 +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 ac0c7e16d39f..000000000000 --- 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 b16ad2886f76..000000000000 --- 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 b14ad24ef95a..000000000000 --- a/reference/mongodb/mongodb/driver/exception/runtimeexception.xml +++ /dev/null @@ -1,143 +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 0f6f2081bc05..000000000000 --- a/reference/mongodb/mongodb/driver/exception/runtimeexception/haserrorlabel.xml +++ /dev/null @@ -1,77 +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 extension to - indicate specific situations that may be handled by an application. A common - situation might be determining whether to safely retry a transaction that - failed due to a transient error (e.g. network error, 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 ed13e9e0e0ee..000000000000 --- 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 3c275913d9ff..000000000000 --- a/reference/mongodb/mongodb/driver/exception/sslconnectionexception.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - The MongoDB\Driver\Exception\SSLConnectionException class - MongoDB\Driver\Exception\SSLConnectionException - - - - - - This exception class is DEPRECATED as of extension - version 1.5.0 and was removed in 2.0. This exception was never thrown - by the extension. Applications should use - MongoDB\Driver\Exception\ConnectionException instead. - - - - -
    - &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 3ea6b237241c..000000000000 --- 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 b8b0b43452dd..000000000000 --- a/reference/mongodb/mongodb/driver/exception/writeexception.xml +++ /dev/null @@ -1,158 +0,0 @@ - - - - - - The MongoDB\Driver\Exception\WriteException class - MongoDB\Driver\Exception\WriteException - - - - - - This exception class is DEPRECATED as of extension - version 1.20.0 and was removed in 2.0. This exception was never directly - thrown by the extension. Applications should use - MongoDB\Driver\Exception\BulkWriteException instead. - - - - -
    - &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; - - - - &mongodb.changelog.class-removed; - - PECL mongodb 1.20.0 - - This class has been deprecated and will be removed in version 2.0. - - - - 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 9110f5208f83..000000000000 --- 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 41c4102e1579..000000000000 --- 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 90e3772f3b5e..000000000000 --- a/reference/mongodb/mongodb/driver/manager/addsubscriber.xml +++ /dev/null @@ -1,97 +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; - - Throws - MongoDB\Driver\Exception\InvalidArgumentException if - subscriber is a - MongoDB\Driver\Monitoring\LogSubscriber, since - loggers can only be registered globally. - - - - - - &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 7421ee3c122f..000000000000 --- a/reference/mongodb/mongodb/driver/manager/construct.xml +++ /dev/null @@ -1,1301 +0,0 @@ - - - - - - MongoDB\Driver\Manager::__construct - Create new MongoDB Manager - - - - &reftitle.description; - - final public MongoDB\Driver\Manager::__construct - stringnulluri&null; - arraynulluriOptions&null; - arraynulldriverOptions&null; - - - 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 extension 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: - - - - - Defaults to "mongodb://127.0.0.1:27017" if unspecified. - - - For details on supported URI options, see - Connection String Options - in the MongoDB manual. - Connection pool options - are not supported, as the extension 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". - - - - - 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). - - - - - enableOverloadRetargeting - bool - - - When set to &true; it forces server selection after a - SystemOverloadedError. Defaults to &false;. - - - - - 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. - - - - - maxAdaptiveRetries - int - - - This option can be used to change the maximum number of retries - when a SystemOverloadedError occurs. Must be a - positive integer; defaults to 2. - - - - - 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. - - - - - 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". - - - - - 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 - - - - - autoEncryption - array - - - Provides options to enable automatic client-side field level - encryption. The list of options is described in the table below. - - - - 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 (see - libmongocrypt: Auto Encryption Allow-List). To bypass automatic encryption - for all operations, set bypassAutoEncryption to - &true;. - - - Automatic encryption requires the authenticated user to have the - listCollections - privilege action. - - - Explicit encryption/decryption and automatic decryption is a - community feature. The driver can still automatically decrypt when - bypassAutoEncryption is &true;. - - - - - - ca_dir - string - - - Path to a correctly hashed certificate directory. The system - certificate store will be used by default. - - - - - 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 a higher level library to append its own metadata to the - server handshake. By default, the extension submits its own name, - version, and platform (i.e. PHP version) in the handshake. Strings - can be specified for the "name", - "version", and "platform" keys - of this array, and will be appended to the respective field(s) in - the handshake document. - - - - Handshake information is limited to 512 bytes. The extension will - truncate handshake data to fit within this 512-byte string. Higher - level libraries are encouraged to keep their own metadata concise. - - - - - - serverApi - MongoDB\Driver\ServerApi - - - This option is used to declare a server API version for the manager. - If omitted, no API version is declared. - - - - - -
    -
    - - Options supported by automatic encryption through the autoEncryption driver option: - - autoEncryption - - - - Option - Type - Description - - - - &mongodb.option.encryption.keyVaultClient; - &mongodb.option.encryption.keyVaultNamespace; - &mongodb.option.encryption.kmsProviders; - &mongodb.option.encryption.tlsOptions; - - schemaMap - arrayobject - - - Map of collection namespaces to a local JSON schema. This is - used to configure automatic encryption. See - Automatic Encryption Rules - in the MongoDB manual for more information. It is an error to - specify a collection in both schemaMap and - encryptedFieldsMap. - - - - 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 - - If &true;, mongocryptd will not be spawned - automatically. This is used to disable automatic encryption. - Defaults to &false;. - - - - bypassQueryAnalysis - bool - - - If &true;, automatic analysis of outgoing commands will be - disabled and mongocryptd will not be - spawned automatically. This enables the use case of explicit - encryption for querying indexed fields without requiring the - enterprise licensed crypt_shared library or - mongocryptd process. Defaults to &false;. - - - - - encryptedFieldsMap - arrayobject - - - Map of collection namespaces to an - encryptedFields document. This is used to - configure queryable encryption. See - Field Encryption and Queryability - in the MongoDB manual for more information. It is an error to - specify a collection in both - encryptedFieldsMap and - schemaMap. - - - - Supplying an encryptedFieldsMap provides - more security than relying on an - encryptedFields obtained from the server. - It protects against a malicious server advertising a false - encryptedFields. - - - - - - extraOptions - array - - - The extraOptions relate to the - mongocryptd process. The following options - are supported: - - - mongocryptdURI (string): URI to connect to an existing mongocryptd process. Defaults to "mongodb://localhost:27020". - mongocryptdBypassSpawn (bool): If &true;, prevent the driver from spawning mongocryptd. Defaults to &false;. - mongocryptdSpawnPath (string): Absolute path to search for mongocryptd binary. Defaults to empty string and consults system paths. - mongocryptdSpawnArgs (array): Array of string arguments to pass to mongocryptd when spawning. Defaults to ["--idleShutdownTimeoutSecs=60"]. - cryptSharedLibPath (string): Absolute path to crypt_shared shared library. Defaults to empty string and consults system paths. - cryptSharedLibRequired (bool): If &true;, require the driver to load crypt_shared. Defaults to &false;. - - - 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. - - -
    -
    -
    -
    -
    - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\RuntimeException if the uri format is invalid - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.0.0 - - - The "canonicalizeHostname" URI option was removed. - Use the "CANONICALIZE_HOST_NAME" property of the - "authMechanismProperties" URI option instead. - - - The "gssapiServiceName" URI option was removed. - Use the "SERVICE_NAME" property of the - "authMechanismProperties" URI option instead. - - - The "safe" URI option was removed. Use the - "w" and "wTimeoutMS" URI options - instead. - - - The "ssl" URI option was removed. Use the - "tls" URI option instead. - - - The "allow_invalid_hostname" driver option was - removed. Use the "tlsAllowInvalidHostnames" URI - option instead. - - - The "ca_file" driver option was removed. Use the - "tlsCAFile" URI option instead. - - - The "context" driver option was removed. All context - options were deprecated in favor of the various URI options related to - TLS. - - - The "pem_file" driver option was removed. Use the - "tlsCertificateKeyFile" URI option instead. - - - The "pem_pwd" driver option was removed. Use the - "tlsCertificateKeyFilePassword" URI option instead. - - - The "weak_cert_validation" driver option was removed. - Use the "tlsAllowInvalidCertificates" URI option - instead. - - - - - PECL mongodb 1.16.0 - - - The AWS KMS provider for client-side encryption now accepts a - "sessionToken" option, which can be used to - authenticate with temporary AWS credentials. - - - Added "tlsDisableOCSPEndpointCheck" to the - "tlsOptions" field of the - "autoEncryption" driver option. - - - If an empty document is specified for the "azure" or - "gcp" KMS provider, the driver will attempt to - configure the provider using - Automatic Credentials. - - - - - PECL mongodb 1.15.0 - - - If an empty document is specified for the "aws" KMS - provider, the driver will attempt to configure the provider using - Automatic Credentials. - - - - - PECL mongodb 1.14.0 - - - Added the "bypassQueryAnalysis" and - "encryptedFieldsMap" auto encryption options. - Additional options pertaining to crypt_shared are - now supported in the "extraOptions" auto encryption - option. - - - - - 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 extension 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 641d47370a1b..000000000000 --- a/reference/mongodb/mongodb/driver/manager/createclientencryption.xml +++ /dev/null @@ -1,164 +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.16.0 - - - The AWS KMS provider for client-side encryption now accepts a - "sessionToken" option, which can be used to - authenticate with temporary AWS credentials. - - - Added "tlsDisableOCSPEndpointCheck" to the - "tlsOptions" option. - - - If an empty document is specified for the "azure" or - "gcp" KMS provider, the driver will attempt to - configure the provider using - Automatic Credentials. - - - - - PECL mongodb 1.15.0 - - - If an empty document is specified for the "aws" KMS - provider, the driver will attempt to configure the provider using - Automatic Credentials. - - - - - 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::__construct - 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 e41371889240..000000000000 --- a/reference/mongodb/mongodb/driver/manager/executebulkwrite.xml +++ /dev/null @@ -1,236 +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 - arraynulloptions&null; - - - 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. - - - The default value for the "writeConcern" option will be - inferred from an active transaction (indicated by the - "session" option), followed by the - connection URI. - - - - - &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 2.0.0 - - The options parameter no longer accepts a - MongoDB\Driver\WriteConcern instance. - - - - PECL mongodb 1.21.0 - - Passing a MongoDB\Driver\WriteConcern object as - options is deprecated and will be removed in 2.0. - - - - 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 parameter 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' => $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/executebulkwritecommand.xml b/reference/mongodb/mongodb/driver/manager/executebulkwritecommand.xml deleted file mode 100644 index 5a1f138169c7..000000000000 --- a/reference/mongodb/mongodb/driver/manager/executebulkwritecommand.xml +++ /dev/null @@ -1,211 +0,0 @@ - - - - - - MongoDB\Driver\Manager::executeBulkWriteCommand - Execute write operations using the bulkWrite command - - - - &reftitle.description; - - final public MongoDB\Driver\BulkWriteCommandResultMongoDB\Driver\Manager::executeBulkWriteCommand - MongoDB\Driver\BulkWriteCommandbulk - arraynulloptions&null; - - - Executes one or more write operations on the primary server using the - bulkWrite - command introduced in MongoDB 8.0. - - - A MongoDB\Driver\BulkWriteCommand can be constructed - with one or more write operations of varying types (e.g. inserts, updates, - and deletes). Each write operation may target a different collection. - - - The default value for the "writeConcern" option will be - inferred from an active transaction (indicated by the - "session" option), followed by the - connection URI. - - - - - &reftitle.parameters; - - &mongodb.parameter.bulkwritecommand; - - options - - - - options - - - - Option - Type - Description - - - - &mongodb.option.session; - &mongodb.option.writeConcern; - - -
    -
    -
    -
    -
    -
    - - - &reftitle.returnvalues; - &mongodb.returns.bulkwritecommandresult; - - - - &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\BulkWriteCommand objects may not be executed multiple times. - &mongodb.throws.session-unacknowledged; - &mongodb.throws.std; - &mongodb.throws.bulkwritecommandexception; - Throws MongoDB\Driver\Exception\RuntimeException on other errors. - - - - - &reftitle.examples; - - Mixed write operations - - Mixed write operations (i.e. inserts, updates, and deletes) will be sent - to the server using a single - bulkWrite - command. - - -deleteMany('db.coll_one', []); -$bulk->deleteMany('db.coll_two', []); - -// Insert documents into two collections -$bulk->insertOne('db.coll_one', ['_id' => 1]); -$bulk->insertOne('db.coll_two', ['_id' => 2]); -$bulk->insertOne('db.coll_two', ['_id' => 3]); - -// Update a document in "coll_one" -$bulk->updateOne('db.coll_one', ['_id' => 1], ['$set' => ['x' => 1]]); - -$result = $manager->executeBulkWriteCommand($bulk); - -printf("Inserted %d document(s)\n", $result->getInsertedCount()); -printf("Updated %d document(s)\n", $result->getModifiedCount()); - -?> -]]> - - &example.outputs; - - - - - - Ordered write operations causing an error - -deleteMany('db.coll', []); -$bulk->insertOne('db.coll', ['_id' => 1]); -$bulk->insertOne('db.coll', ['_id' => 2]); -$bulk->insertOne('db.coll', ['_id' => 1]); -$bulk->insertOne('db.coll', ['_id' => 3]); - -try { - $result = $manager->executeBulkWriteCommand($bulk); -} catch (MongoDB\Driver\Exception\BulkWriteCommandException $e) { - $result = $e->getPartialResult(); - - var_dump($e->getWriteErrors()); -} - -printf("Inserted %d document(s)\n", $result->getInsertedCount()); - -?> -]]> - - &example.outputs.similar; - - - object(MongoDB\Driver\WriteError)#5 (4) { - ["message"]=> - string(78) "E11000 duplicate key error collection: db.coll index: _id_ dup key: { _id: 1 }" - ["code"]=> - int(11000) - ["index"]=> - int(3) - ["info"]=> - object(stdClass)#6 (0) { - } - } -} -Inserted 2 document(s) -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWriteCommand - MongoDB\Driver\BulkWriteCommandResult - MongoDB\Driver\WriteConcern - MongoDB\Driver\Server::executeBulkWriteCommand - - - -
    - - diff --git a/reference/mongodb/mongodb/driver/manager/executecommand.xml b/reference/mongodb/mongodb/driver/manager/executecommand.xml deleted file mode 100644 index 941fa4eb80eb..000000000000 --- a/reference/mongodb/mongodb/driver/manager/executecommand.xml +++ /dev/null @@ -1,314 +0,0 @@ - - - - - - MongoDB\Driver\Manager::executeCommand - Execute a database command - - - - &reftitle.description; - - final public MongoDB\Driver\CursorMongoDB\Driver\Manager::executeCommand - stringdb - MongoDB\Driver\Commandcommand - arraynulloptions&null; - - - Selects a server according to the "readPreference" option - and executes the command on that server. - - - This method applies no special logic to the command. The - Default values for the "readPreference", - "readConcern", and "writeConcern" - options will be inferred from an active transaction (indicated by the - "session" option). If there is no active transaction, a - primary read preference will be used for server selection. - - - Default values will not be inferred from the - connection URI. - 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 2.0.0 - - The options parameter no longer accepts a - MongoDB\Driver\ReadPreference instance. - - - - PECL mongodb 1.21.0 - - Passing a MongoDB\Driver\ReadPreference object as - options is deprecated and will be removed in 2.0. - - - - 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 parameter 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. - - - - - This method does not default to using the read preference from the - MongoDB Connection - URI. Applications in need of that behavior should consider using - MongoDB\Driver\Manager::executeReadCommand. - - - - - - &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 b0287a24606f..000000000000 --- a/reference/mongodb/mongodb/driver/manager/executequery.xml +++ /dev/null @@ -1,230 +0,0 @@ - - - - - - MongoDB\Driver\Manager::executeQuery - Execute a database query - - - - &reftitle.description; - - final public MongoDB\Driver\CursorMongoDB\Driver\Manager::executeQuery - stringnamespace - MongoDB\Driver\Queryquery - arraynulloptions&null; - - - Selects a server according to the "readPreference" option - and executes the query on that server. - - - Default values for the "readPreference" option and Query's - "readConcern" option will be inferred from an active - transaction (indicated by the "session" option), followed - by the connection URI. - - - - - &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 2.0.0 - - The options parameter no longer accepts a - MongoDB\Driver\ReadPreference instance. - - - - PECL mongodb 1.21.0 - - Passing a MongoDB\Driver\ReadPreference object as - options is deprecated and will be removed in 2.0. - - - - PECL mongodb 1.4.0 - - The third parameter is now an options array. - For backwards compatibility, this parameter 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 da1922943959..000000000000 --- a/reference/mongodb/mongodb/driver/manager/executereadcommand.xml +++ /dev/null @@ -1,112 +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 - arraynulloptions&null; - - - Selects a server according to the "readPreference" option - and executes the command on that server. - - - This method will apply logic that is specific to commands that read (e.g. - distinct). - Default values for the "readPreference" and - "readConcern" options will be inferred from an active - transaction (indicated by the "session" option), followed - by the 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 b335d0bae78d..000000000000 --- a/reference/mongodb/mongodb/driver/manager/executereadwritecommand.xml +++ /dev/null @@ -1,136 +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 - arraynulloptions&null; - - - Executes the command on the primary server. - - - This method will apply logic that is specific to commands that read and write - (e.g. aggregate). - Default values for the "readConcern" and - "writeConcern" options will be inferred from an active - transaction (indicated by the "session" option), followed - by the 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 a7ddec1abdbd..000000000000 --- a/reference/mongodb/mongodb/driver/manager/executewritecommand.xml +++ /dev/null @@ -1,146 +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 - arraynulloptions&null; - - - Executes the command on the primary server. - - - This method will apply logic that is specific to commands that write (e.g. - drop). - The default value for the "writeConcern" option will be - inferred from an active transaction (indicated by the - "session" option), followed by the - 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 - operations. - - - - - - &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/getencryptedfieldsmap.xml b/reference/mongodb/mongodb/driver/manager/getencryptedfieldsmap.xml deleted file mode 100644 index 5ebeb71df41b..000000000000 --- a/reference/mongodb/mongodb/driver/manager/getencryptedfieldsmap.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - MongoDB\Driver\Manager::getEncryptedFieldsMap - Return the encryptedFieldsMap auto encryption option for the Manager - - - - &reftitle.description; - - final public arrayobjectnullMongoDB\Driver\Manager::getEncryptedFieldsMap - - - - Returns the encryptedFieldsMap auto encryption option for - the Manager, if specified. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The encryptedFieldsMap auto encryption option for the - Manager, or &null; if it was not specified. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::__construct - - - - - - diff --git a/reference/mongodb/mongodb/driver/manager/getreadconcern.xml b/reference/mongodb/mongodb/driver/manager/getreadconcern.xml deleted file mode 100644 index 0661bff37fa6..000000000000 --- 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 b2fcf000b15b..000000000000 --- 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 3d7e4cc618a9..000000000000 --- 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 1ff1268a0313..000000000000 --- 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 d3ec7ca73789..000000000000 --- 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 7110a4cf5cd8..000000000000 --- a/reference/mongodb/mongodb/driver/manager/selectserver.xml +++ /dev/null @@ -1,118 +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 3f528d8e136b..000000000000 --- a/reference/mongodb/mongodb/driver/manager/startsession.xml +++ /dev/null @@ -1,222 +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 - arraynulloptions&null; - - - 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 - Causal 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 - Causal 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 1e3326b445eb..000000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent.xml +++ /dev/null @@ -1,252 +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 - - - - - &Properties; - - public - readonly - string - host - - - public - readonly - int - port - - - public - readonly - string - commandName - - - public - readonly - string - databaseName - - - public - readonly - int - duration - - - public - readonly - Exception - error - - - public - readonly - object - reply - - - public - readonly - string - operationId - - - public - readonly - string - requestId - - - public - readonly - MongoDB\BSON\ObjectIdnull - serviceId - - - public - readonly - intnull - serverConnectionId - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - host - - The hostname of the server that executed the command. - - - - port - - The port of the server that executed the command. - - - - commandName - - The command name. - - - - databaseName - - The database name. - - - - duration - - - The duration of the command in microseconds. The duration is a - calculated value that includes the time to send the message and - receive the response from the server. - - - - - error - - The exception that was thrown when the command failed. - - - - reply - - The failure reply document returned by the server. - - - - operationId - - - The operation ID. This may be used to link events together such as - bulk writes, which may dispatch multiple commands. - - - - - requestId - - - The request ID. This may be used to associate this - MongoDB\Driver\Monitoring\CommandFailedEvent - with a corresponding - MongoDB\Driver\Monitoring\CommandStartedEvent. - - - - - serviceId - - - The service ID, or &null; if the server does not support it (i.e. - not using load-balanced mode). - - - - - serverConnectionId - - - The server connection ID, or &null; if not available. - - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - Added public readonly properties. The - duration property replaces the - getDurationMicros method. - - - - - -
    - -
    - - &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 f9c39ca18990..000000000000 --- 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/getdatabasename.xml b/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getdatabasename.xml deleted file mode 100644 index 293006672ef2..000000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getdatabasename.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandFailedEvent::getDatabaseName - Returns the database on which the command was executed - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\CommandFailedEvent::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/commandfailedevent/getdurationmicros.xml b/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getdurationmicros.xml deleted file mode 100644 index af7e3baadb3e..000000000000 --- 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 8560a208a95f..000000000000 --- 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/gethost.xml b/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/gethost.xml deleted file mode 100644 index 9d4bc726e481..000000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/gethost.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandFailedEvent::getHost - Returns the server hostname for the command - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\CommandFailedEvent::getHost - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the hostname of the server on which the command was executed. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - 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 857be002864d..000000000000 --- 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 extension 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/getport.xml b/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getport.xml deleted file mode 100644 index c63d85d8b649..000000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getport.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandFailedEvent::getPort - Returns the server port for the command - - - - &reftitle.description; - - final public intMongoDB\Driver\Monitoring\CommandFailedEvent::getPort - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the port of the server on which the command was executed. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - 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 feef33fc8d5e..000000000000 --- 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 34a51818629b..000000000000 --- 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 extension 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 89cae4858f1e..000000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getserver.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandFailedEvent::getServer - Returns the Server on which the command was executed - - - - - - This method has been DEPRECATED as of extension - version 1.20.0 and was removed in 2.0. Applications should use - MongoDB\Driver\Monitoring\CommandFailedEvent::getHost - and - MongoDB\Driver\Monitoring\CommandFailedEvent::getPort - instead. - - - - - - &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.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.method-removed; - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\CommandStartedEvent::getServer - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getserverconnectionid.xml b/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getserverconnectionid.xml deleted file mode 100644 index 3716b26903f6..000000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getserverconnectionid.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandFailedEvent::getServerConnectionId - Returns the server connection ID for the command - - - - &reftitle.description; - - final public intnullMongoDB\Driver\Monitoring\CommandFailedEvent::getServerConnectionId - - - - Returns the server connection ID for the command. The server connection ID is - distinct from server (i.e. - MongoDB\Driver\Monitoring\CommandFailedEvent::getServer) - and is returned in the "connectionId" field of a hello - command response MongoDB 4.2+. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the server connection ID, or &null; if it is not available. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - - 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 7a9470ed781d..000000000000 --- 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 a424520acdf1..000000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent.xml +++ /dev/null @@ -1,222 +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 - - - - - &Properties; - - public - readonly - string - host - - - public - readonly - int - port - - - public - readonly - string - commandName - - - public - readonly - string - databaseName - - - public - readonly - object - command - - - public - readonly - string - operationId - - - public - readonly - string - requestId - - - public - readonly - MongoDB\BSON\ObjectIdnull - serviceId - - - public - readonly - intnull - serverConnectionId - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - host - - The hostname of the server that executed the command. - - - - port - - The port of the server that executed the command. - - - - commandName - - The command name. - - - - databaseName - - The database name. - - - - command - - The command document. - - - - operationId - - - The operation ID. This may be used to link events together such as - bulk writes, which may dispatch multiple commands. - - - - - requestId - - - The request ID. This may be used to associate this - MongoDB\Driver\Monitoring\CommandStartedEvent - with a corresponding - MongoDB\Driver\Monitoring\CommandSucceededEvent - or - MongoDB\Driver\Monitoring\CommandFailedEvent. - - - - - serviceId - - - The service ID, or &null; if the server does not support it (i.e. - not using load-balanced mode). - - - - - serverConnectionId - - The server connection ID, or &null; if not available. - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - Added public readonly properties. - - - - - -
    - -
    - - &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 256ce6d88690..000000000000 --- 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 a7439155ec64..000000000000 --- 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 891e2c4b5541..000000000000 --- 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/gethost.xml b/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/gethost.xml deleted file mode 100644 index 60b58fdbf8cc..000000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/gethost.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandStartedEvent::getHost - Returns the server hostname for the command - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\CommandStartedEvent::getHost - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the hostname of the server on which the command was executed. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - 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 2af1a3c476d5..000000000000 --- 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 extension 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/getport.xml b/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getport.xml deleted file mode 100644 index a9304fa92a9c..000000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getport.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandStartedEvent::getPort - Returns the server port for the command - - - - &reftitle.description; - - final public intMongoDB\Driver\Monitoring\CommandStartedEvent::getPort - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the port of the server on which the command was executed. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - 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 576aa56c0bec..000000000000 --- 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 extension 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 78e7d6e6dcf4..000000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getserver.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandStartedEvent::getServer - Returns the Server on which the command was executed - - - - - - This method has been DEPRECATED as of extension - version 1.20.0 and was removed in 2.0. Applications should use - MongoDB\Driver\Monitoring\CommandStartedEvent::getHost - and - MongoDB\Driver\Monitoring\CommandStartedEvent::getPort - instead. - - - - - - &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.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.method-removed; - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\CommandFailedEvent::getServer - MongoDB\Driver\Monitoring\CommandSucceededEvent::getServer - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getserverconnectionid.xml b/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getserverconnectionid.xml deleted file mode 100644 index b416b2b078d7..000000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getserverconnectionid.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandStartedEvent::getServerConnectionId - Returns the server connection ID for the command - - - - &reftitle.description; - - final public intnullMongoDB\Driver\Monitoring\CommandStartedEvent::getServerConnectionId - - - - Returns the server connection ID for the command. The server connection ID is - distinct from server (i.e. - MongoDB\Driver\Monitoring\CommandStartedEvent::getServer) - and is returned in the "connectionId" field of a hello - command response MongoDB 4.2+. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the server connection ID, or &null; if it is not available. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - - 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 7783cd334e05..000000000000 --- 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 247e83aaaead..000000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandsubscriber.xml +++ /dev/null @@ -1,90 +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; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.tentative-return-types-enforced; - &mongodb.changelog.tentative-return-types; - - - -
    -
    - - &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 d696c975e66d..000000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandsubscriber/commandfailed.xml +++ /dev/null @@ -1,80 +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 is registered, this method is called when a command fails. - - - - - &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 760b0df4d57e..000000000000 --- 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 is registered, this method is called when a command is sent - to the server. - - - - - &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 9b4de978f99c..000000000000 --- 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 is registered, this method is called when a command - succeeds. - - - - - &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 5ce7329c7ce3..000000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent.xml +++ /dev/null @@ -1,238 +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 - - - - - &Properties; - - public - readonly - string - host - - - public - readonly - int - port - - - public - readonly - string - commandName - - - public - readonly - string - databaseName - - - public - readonly - int - duration - - - public - readonly - object - reply - - - public - readonly - string - operationId - - - public - readonly - string - requestId - - - public - readonly - MongoDB\BSON\ObjectIdnull - serviceId - - - public - readonly - intnull - serverConnectionId - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - host - - The hostname of the server that executed the command. - - - - port - - The port of the server that executed the command. - - - - commandName - - The command name. - - - - databaseName - - The database name. - - - - duration - - - The duration of the command in microseconds. The duration is a - calculated value that includes the time to send the message and - receive the response from the server. - - - - - reply - - The reply document returned by the server. - - - - operationId - - - The operation ID. This may be used to link events together such as - bulk writes, which may dispatch multiple commands. - - - - - requestId - - - The request ID. This may be used to associate this - MongoDB\Driver\Monitoring\CommandSucceededEvent - with a corresponding - MongoDB\Driver\Monitoring\CommandStartedEvent. - - - - - serviceId - - - The service ID, or &null; if the server does not support it (i.e. - not using load-balanced mode). - - - - - serverConnectionId - - The server connection ID, or &null; if not available. - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - Added public readonly properties. The - duration property replaces the - getDurationMicros method. - - - - - -
    - -
    - - &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 871a3af3101f..000000000000 --- 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/getdatabasename.xml b/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getdatabasename.xml deleted file mode 100644 index d69ea55db23b..000000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getdatabasename.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandSucceededEvent::getDatabaseName - Returns the database on which the command was executed - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\CommandSucceededEvent::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/commandsucceededevent/getdurationmicros.xml b/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getdurationmicros.xml deleted file mode 100644 index 6b7b88e76bf5..000000000000 --- 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/gethost.xml b/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/gethost.xml deleted file mode 100644 index 07662125ac3b..000000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/gethost.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandSucceededEvent::getHost - Returns the server hostname for the command - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\CommandSucceededEvent::getHost - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the hostname of the server on which the command was executed. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - 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 76114e14d7af..000000000000 --- 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 extension 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/getport.xml b/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getport.xml deleted file mode 100644 index 179a2a679708..000000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getport.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandSucceededEvent::getPort - Returns the server port for the command - - - - &reftitle.description; - - final public intMongoDB\Driver\Monitoring\CommandSucceededEvent::getPort - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the port of the server on which the command was executed. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - 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 471ade691e00..000000000000 --- 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 5f4e0cdaeaab..000000000000 --- 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 extension 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 9ae678dec59f..000000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getserver.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandSucceededEvent::getServer - Returns the Server on which the command was executed - - - - - - This method has been DEPRECATED as of extension - version 1.20.0 and was removed in 2.0. Applications should use - MongoDB\Driver\Monitoring\CommandSucceededEvent::getHost - and - MongoDB\Driver\Monitoring\CommandSucceededEvent::getPort - instead. - - - - - - &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.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.method-removed; - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\CommandStartedEvent::getServer - MongoDB\Driver\Cursor::getServer - MongoDB\Driver\WriteResult::getServer - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getserverconnectionid.xml b/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getserverconnectionid.xml deleted file mode 100644 index b7bd4005f9b7..000000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getserverconnectionid.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandSucceededEvent::getServerConnectionId - Returns the server connection ID for the command - - - - &reftitle.description; - - final public intnullMongoDB\Driver\Monitoring\CommandSucceededEvent::getServerConnectionId - - - - Returns the server connection ID for the command. The server connection ID is - distinct from server (i.e. - MongoDB\Driver\Monitoring\CommandSucceededEvent::getServer) - and is returned in the "connectionId" field of a hello - command response MongoDB 4.2+. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the server connection ID, or &null; if it is not available. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - - 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 89cd897bf46b..000000000000 --- 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/logsubscriber.xml b/reference/mongodb/mongodb/driver/monitoring/logsubscriber.xml deleted file mode 100644 index 9d22b8026a61..000000000000 --- a/reference/mongodb/mongodb/driver/monitoring/logsubscriber.xml +++ /dev/null @@ -1,184 +0,0 @@ - - - - - - The MongoDB\Driver\Monitoring\LogSubscriber interface - MongoDB\Driver\Monitoring\LogSubscriber - - - - -
    - &reftitle.intro; - - Classes implementing this interface may be registered as a subscriber and - receive log messages from the extension. This is similar to stream-based - debug logging (i.e. mongodb.debug) - except that trace-level log messages are not received. - - - As with stream-based logging, it is only possible to register a logger - globally using MongoDB\Driver\Monitoring\addSubscriber. - The extension is not able to distinguish log messages for individual - MongoDB\Driver\Manager objects. - -
    - - -
    - &reftitle.interfacesynopsis; - - - - MongoDB\Driver\Monitoring\LogSubscriber - - - - - MongoDB\Driver\Monitoring\LogSubscriber - - - - MongoDB\Driver\Monitoring\Subscriber - - - - - &Constants; - - const - int - MongoDB\Driver\Monitoring\LogSubscriber::LEVEL_ERROR - 0 - - - const - int - MongoDB\Driver\Monitoring\LogSubscriber::LEVEL_CRITICAL - 1 - - - const - int - MongoDB\Driver\Monitoring\LogSubscriber::LEVEL_WARNING - 2 - - - const - int - MongoDB\Driver\Monitoring\LogSubscriber::LEVEL_MESSAGE - 3 - - - const - int - MongoDB\Driver\Monitoring\LogSubscriber::LEVEL_INFO - 4 - - - const - int - MongoDB\Driver\Monitoring\LogSubscriber::LEVEL_DEBUG - 5 - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - MongoDB\Driver\Monitoring\LogSubscriber::LEVEL_ERROR - - - Error log level. An error condition that the extension is unable to report - through its API. This is the most severe log level in the extension. - - - - - - MongoDB\Driver\Monitoring\LogSubscriber::LEVEL_CRITICAL - - - Critical log level. An error condition with slightly less severity. This - constant exists for consistency with libmongoc; however, the extension is - unlikely to use it in practice. - - - - - - MongoDB\Driver\Monitoring\LogSubscriber::LEVEL_WARNING - - - Warning log level. Indicates a situation where undesirable application - behavior may occur. - - - - - - MongoDB\Driver\Monitoring\LogSubscriber::LEVEL_MESSAGE - - - Message or notice log level. Indicates an event that is unusual but not - problematic. - - - - - - MongoDB\Driver\Monitoring\LogSubscriber::LEVEL_INFO - - - Info log level. High-level information about normal driver behavior. - - - - - - MongoDB\Driver\Monitoring\LogSubscriber::LEVEL_DEBUG - - - Debug log level. Detailed information that may be helpful when debugging - an application. - - - - -
    - -
    - - &reference.mongodb.mongodb.driver.monitoring.entities.logsubscriber; - -
    - - diff --git a/reference/mongodb/mongodb/driver/monitoring/logsubscriber/log.xml b/reference/mongodb/mongodb/driver/monitoring/logsubscriber/log.xml deleted file mode 100644 index db50276f5388..000000000000 --- a/reference/mongodb/mongodb/driver/monitoring/logsubscriber/log.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\LogSubscriber::log - Notification method for a log message - - - - &reftitle.description; - - abstract public voidMongoDB\Driver\Monitoring\LogSubscriber::log - intlevel - stringdomain - stringmessage - - - If the subscriber is registered, this method is called for each logged - message. - - - - - &reftitle.parameters; - - - level - - - The severity level. This will be one of the - interface constants. - - - - - domain - - - The name of the driver component that emitted the log message. - - - - - message - - - The log message. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\addSubscriber - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber.xml b/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber.xml deleted file mode 100644 index 4ee5df7074cf..000000000000 --- a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber.xml +++ /dev/null @@ -1,92 +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; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.tentative-return-types-enforced; - &mongodb.changelog.tentative-return-types; - - - -
    -
    - - &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 3947d17d2821..000000000000 --- a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serverchanged.xml +++ /dev/null @@ -1,82 +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 is registered, this method is called when a server's - description changes. For example, a server's type changing from secondary to - primary would cause its server description to change. - - - - - &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 484ea6d6d04a..000000000000 --- 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 is registered, this method is called when an existing - server is removed from the topology. - - - - - &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 f5140adee706..000000000000 --- 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 is registered, this method is called when a server - heartbeat (i.e. - hello - command issued through - server monitoring) fails. - - - - - &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 52d272a80502..000000000000 --- a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serverheartbeatstarted.xml +++ /dev/null @@ -1,85 +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 is registered, this method is called when a server - heartbeat (i.e. - hello - command issued through - server monitoring) is sent to - the server. - - - - - &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 a35f31cb30e1..000000000000 --- a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serverheartbeatsucceeded.xml +++ /dev/null @@ -1,84 +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 is registered, this method is called when a server - heartbeat (i.e. - hello - command issued through - server monitoring) succeeds. - - - - - &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 f9ed3ec56b4f..000000000000 --- 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 is registered, this method is called when a new server is - added to the topology. - - - - - &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 7bb232574a4b..000000000000 --- a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/topologychanged.xml +++ /dev/null @@ -1,82 +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 is registered, this method is called when the topology's - description changes. For example, a topology discovering a new replica set - primary would cause its topology description to change. - - - - - &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 fff086106bfe..000000000000 --- a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/topologyclosed.xml +++ /dev/null @@ -1,90 +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 is registered, this method is called when the topology is - closed. - - - - Due to the driver's - connection handling and persistence - behavior, this event can only be observed when a - MongoDB\Driver\Manager is created with the - "disableClientPersistence" driver option and freed before - request shutdown (RSHUTDOWN). - - - - - - &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 7545681215eb..000000000000 --- a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/topologyopening.xml +++ /dev/null @@ -1,89 +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 is registered, this method is called when the topology is - opened. - - - - Due to the driver's - connection handling and persistence - behavior, this event may not be observed if a - MongoDB\Driver\Manager uses a previously persisted - libmongoc client. - - - - - - &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 1f82160a8f36..000000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverchangedevent.xml +++ /dev/null @@ -1,163 +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. For - example, a server's type changing from secondary to primary would cause its - server description to change. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Monitoring\ServerChangedEvent - - - - final - - MongoDB\Driver\Monitoring\ServerChangedEvent - - - - - &Properties; - - public - readonly - string - host - - - public - readonly - int - port - - - public - readonly - MongoDB\BSON\ObjectId - topologyId - - - public - readonly - MongoDB\Driver\ServerDescription - newDescription - - - public - readonly - MongoDB\Driver\ServerDescription - previousDescription - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - host - - The hostname of the server. - - - - port - - The port of the server. - - - - topologyId - - The topology ID. - - - - newDescription - - The new server description. - - - - previousDescription - - The previous server description. - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - Added public readonly properties. - - - - - -
    - -
    - - &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 534a79d9efac..000000000000 --- 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 0e7fa1676e49..000000000000 --- 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 c3a28ead8f55..000000000000 --- 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 d94579eb0955..000000000000 --- 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 fb0a3b7c3f7d..000000000000 --- 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 6fd48ae69b28..000000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverclosedevent.xml +++ /dev/null @@ -1,138 +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. This corresponds to an - existing server being removed from the topology. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Monitoring\ServerClosedEvent - - - - final - - MongoDB\Driver\Monitoring\ServerClosedEvent - - - - - &Properties; - - public - readonly - string - host - - - public - readonly - int - port - - - public - readonly - MongoDB\BSON\ObjectId - topologyId - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - host - - The hostname of the server. - - - - port - - The port of the server. - - - - topologyId - - The topology ID. - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - Added public readonly properties. - - - - - -
    - -
    - - &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 bfd5bd570df4..000000000000 --- 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 8d4aa9b6b4a8..000000000000 --- 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 abb1d4baaf0b..000000000000 --- 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 26c41fdc94e6..000000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent.xml +++ /dev/null @@ -1,174 +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 (i.e. - hello - command issued through - server monitoring). - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent - - - - final - - MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent - - - - - &Properties; - - public - readonly - string - host - - - public - readonly - int - port - - - public - readonly - bool - awaited - - - public - readonly - int - duration - - - public - readonly - Exception - error - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - host - - The hostname of the server. - - - - port - - The port of the server. - - - - awaited - - - Whether the heartbeat used a streaming protocol. The extension does - not use the streaming protocol for monitoring, so this method will always - return &false;. - - - - - duration - - - The duration of the heartbeat in microseconds. The duration is a - calculated value that includes the time to send the message and - receive the response from the server. - - - - - error - - The exception that was thrown when the heartbeat failed. - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - Added public readonly properties. The - duration property replaces the - getDurationMicros method. - - - - - -
    - -
    - - &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 3aed3ed9a641..000000000000 --- 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 c32abbb6cec5..000000000000 --- 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 8ce4e79740e7..000000000000 --- 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 fe712d6e631a..000000000000 --- 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 7ea0c94f2bf2..000000000000 --- 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 extension 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 7e9c4a920a1b..000000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatstartedevent.xml +++ /dev/null @@ -1,144 +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 (i.e. - hello - command issued through - server monitoring). - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent - - - - final - - MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent - - - - - &Properties; - - public - readonly - string - host - - - public - readonly - int - port - - - public - readonly - bool - awaited - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - host - - The hostname of the server. - - - - port - - The port of the server. - - - - awaited - - - Whether the heartbeat used a streaming protocol. The extension does - not use the streaming protocol for monitoring, so this method will always - return &false;. - - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - Added public readonly properties. - - - - - -
    - -
    - - &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 b2826ecb5cae..000000000000 --- 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 b8e70233812d..000000000000 --- 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 5218841a3c73..000000000000 --- 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 extension 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 354c0344b589..000000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent.xml +++ /dev/null @@ -1,174 +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 (i.e. - hello - command issued through - server monitoring). - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent - - - - final - - MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent - - - - - &Properties; - - public - readonly - string - host - - - public - readonly - int - port - - - public - readonly - bool - awaited - - - public - readonly - int - duration - - - public - readonly - object - reply - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - host - - The hostname of the server. - - - - port - - The port of the server. - - - - awaited - - - Whether the heartbeat used a streaming protocol. The extension does - not use the streaming protocol for monitoring, so this method will always - return &false;. - - - - - duration - - - The duration of the heartbeat in microseconds. The duration is a - calculated value that includes the time to send the message and - receive the response from the server. - - - - - reply - - The reply document returned by the server. - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - Added public readonly properties. The - duration property replaces the - getDurationMicros method. - - - - - -
    - -
    - - &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 9e727a9d69eb..000000000000 --- 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 b34941ec53c0..000000000000 --- 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 5295ef5f075f..000000000000 --- 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 ec7a7800a0d3..000000000000 --- 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 7c313ee9c5b0..000000000000 --- 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 extension 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 bb7d68d91bc1..000000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serveropeningevent.xml +++ /dev/null @@ -1,138 +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. This corresponds to a - new server being added to the topology. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Monitoring\ServerOpeningEvent - - - - final - - MongoDB\Driver\Monitoring\ServerOpeningEvent - - - - - &Properties; - - public - readonly - string - host - - - public - readonly - int - port - - - public - readonly - MongoDB\BSON\ObjectId - topologyId - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - host - - The hostname of the server. - - - - port - - The port of the server. - - - - topologyId - - The topology ID. - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - Added public readonly properties. - - - - - -
    - -
    - - &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 c3b6232259cc..000000000000 --- 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 f35623293c3b..000000000000 --- 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 5e2014b92227..000000000000 --- 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 74fa3d877223..000000000000 --- 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 2000a13ff817..000000000000 --- a/reference/mongodb/mongodb/driver/monitoring/topologychangedevent.xml +++ /dev/null @@ -1,139 +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. For - example, a topology discovering a new replica set primary would cause its - topology description to change. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Monitoring\TopologyChangedEvent - - - - final - - MongoDB\Driver\Monitoring\TopologyChangedEvent - - - - - &Properties; - - public - readonly - MongoDB\BSON\ObjectId - topologyId - - - public - readonly - MongoDB\Driver\TopologyDescription - newDescription - - - public - readonly - MongoDB\Driver\TopologyDescription - previousDescription - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - topologyId - - The topology ID. - - - - newDescription - - The new topology description. - - - - previousDescription - - The previous topology description. - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - Added public readonly properties. - - - - - -
    - -
    - - &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 17bddbe314d1..000000000000 --- 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 b0f822499102..000000000000 --- 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 2e3900424bd2..000000000000 --- 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 2d0f0c780c7b..000000000000 --- a/reference/mongodb/mongodb/driver/monitoring/topologyclosedevent.xml +++ /dev/null @@ -1,123 +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. - - - - Due to the driver's - connection handling and persistence - behavior, this event can only be observed when a - MongoDB\Driver\Manager is created with the - "disableClientPersistence" driver option and freed - before request shutdown (RSHUTDOWN). - - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Monitoring\TopologyClosedEvent - - - - final - - MongoDB\Driver\Monitoring\TopologyClosedEvent - - - - - &Properties; - - public - readonly - MongoDB\BSON\ObjectId - topologyId - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - topologyId - - The topology ID. - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - Added public readonly properties. - - - - - -
    - -
    - - &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 ccb02bb53447..000000000000 --- 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 276f2e3f7056..000000000000 --- a/reference/mongodb/mongodb/driver/monitoring/topologyopeningevent.xml +++ /dev/null @@ -1,122 +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. - - - - Due to the driver's - connection handling and persistence - behavior, this event may not be observed if a - MongoDB\Driver\Manager uses a previously persisted - libmongoc client. - - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Monitoring\TopologyOpeningEvent - - - - final - - MongoDB\Driver\Monitoring\TopologyOpeningEvent - - - - - &Properties; - - public - readonly - MongoDB\BSON\ObjectId - topologyId - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - topologyId - - The topology ID. - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - Added public readonly properties. - - - - - -
    - -
    - - &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 e59a82c4fc54..000000000000 --- 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 16dcbc0278bb..000000000000 --- 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 c49a9274fd77..000000000000 --- a/reference/mongodb/mongodb/driver/query/construct.xml +++ /dev/null @@ -1,544 +0,0 @@ - - - - - - MongoDB\Driver\Query::__construct - Create a new Query - - - - &reftitle.description; - - final public MongoDB\Driver\Query::__construct - arrayobjectfilter - arraynullqueryOptions&null; - - - 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 - mixed - - - An arbitrary comment to help trace the operation through the - database profiler, currentOp output, and logs. - - - The comment can be any valid BSON type for MongoDB 4.4+. Earlier - server versions only support string values. - - - 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. - - - - &mongodb.option.let; - - 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. - - - - - 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. - - - - - 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. - - - - - noCursorTimeout - bool - - Prevents the server from timing out idle cursors after an inactivity - period (10 minutes). - - - - 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 - extension 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. - - - 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 2.0.0 - - - The "partial" option was removed. Use the - "allowPartialResults" option instead. - - - The "maxScan" option was removed. Support for this - option was removed in MongoDB 4.2. - - - The "modifiers" option was removed. This option was - used for legacy query modifiers, which are all deprecated. - - - The "oplogReplay" option was removed. It is ignored - in MongoDB 4.4 and newer. - - - The "snapshot" option was removed. Support for this - option was removed in MongoDB 4.0. - - - A negative value for the "limit" option no longer - implies &true; for the "singleBatch" option. To only - receive a single batch of results, combine a positive - "limit" value with the - "singleBatch" option. - - - - - PECL mongodb 1.14.0 - - - Added the "let" option. The - "comment" option now accepts any type. - - - - - 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::PRIMARY); -$cursor = $manager->executeQuery('databaseName.collectionName', $query, ['readPreference' => $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 141dc1f79e92..000000000000 --- a/reference/mongodb/mongodb/driver/readconcern.xml +++ /dev/null @@ -1,343 +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 - - - - &Properties; - - public - readonly - stringnull - level - - - &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.properties; - - - level - - - The read concern level. &null; if no level was specified. - - - - -
    - - - -
    - &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 2.3.0 - - Added public readonly properties. - - - - 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 d19e66c397dd..000000000000 --- 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 stdClassMongoDB\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\Document::fromPHP($rc)->toRelaxedExtendedJSON(); - -?> -]]> - - &example.outputs.similar; - - - - - <function>MongoDB\Driver\ReadConcern::bsonSerialize</function> with local read concern - -bsonSerialize()); - -echo "\n", MongoDB\BSON\Document::fromPHP($rc)->toRelaxedExtendedJSON(); - -?> -]]> - - &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 3741b22b6047..000000000000 --- 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 - stringnulllevel&null; - - - 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 a2c0240e1ee2..000000000000 --- 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 e13e048b7809..000000000000 --- 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 - 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/readpreference.xml b/reference/mongodb/mongodb/driver/readpreference.xml deleted file mode 100644 index 2f5c6498cae6..000000000000 --- a/reference/mongodb/mongodb/driver/readpreference.xml +++ /dev/null @@ -1,362 +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 - - - - &Properties; - - public - readonly - string - mode - - - public - readonly - arraynull - tags - - - public - readonly - int - maxStalenessSeconds - - - public - readonly - objectnull - hedge - - - &Constants; - - 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.properties; - - - mode - - - The read preference mode as a string (e.g. - "primary", "secondary"). - - - - - tags - - - The tag set list used by the read preference, or &null; if no tag - sets were specified. - - - - - maxStalenessSeconds - - - The maximum staleness in seconds for reads, or - MongoDB\Driver\ReadPreference::NO_MAX_STALENESS - if no maximum staleness was specified. - - - - - hedge - - - A document specifying the hedge options for the read preference, or - &null; if no hedge options were specified. - - - - This property is deprecated as hedged reads are deprecated in - MongoDB 8.0. - - - - - -
    - - - -
    - &reftitle.constants; - - - - 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 2.3.0 - - Added public readonly properties. - - - - PECL mongodb 2.0.0 - - - Removed the - MongoDB\Driver\ReadPreference::RP_PRIMARY, - MongoDB\Driver\ReadPreference::RP_PRIMARY_PREFERRED, - MongoDB\Driver\ReadPreference::RP_SECONDARY, - MongoDB\Driver\ReadPreference::RP_SECONDARY_PREFERRED, - and MongoDB\Driver\ReadPreference::RP_NEAREST - constants. The getMode method was also removed. - - - - - PECL mongodb 1.20.0 - - - Deprecated the - MongoDB\Driver\ReadPreference::RP_PRIMARY, - MongoDB\Driver\ReadPreference::RP_PRIMARY_PREFERRED, - MongoDB\Driver\ReadPreference::RP_SECONDARY, - MongoDB\Driver\ReadPreference::RP_SECONDARY_PREFERRED, - and MongoDB\Driver\ReadPreference::RP_NEAREST - constants. - - - - - 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, - and 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 ff7d1503c2e8..000000000000 --- 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 stdClassMongoDB\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\Document::fromPHP($rp)->toRelaxedExtendedJSON(); - -?> -]]> - - &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\Document::fromPHP($rp)->toRelaxedExtendedJSON(); - -?> -]]> - - &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\Document::fromPHP($rp)->toRelaxedExtendedJSON(); - -?> -]]> - - &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 59a3d2fe03a6..000000000000 --- a/reference/mongodb/mongodb/driver/readpreference/construct.xml +++ /dev/null @@ -1,338 +0,0 @@ - - - - - - MongoDB\Driver\ReadPreference::__construct - Create a new ReadPreference - - - - &reftitle.description; - - final public MongoDB\Driver\ReadPreference::__construct - stringmode - arraynulltagSets&null; - arraynulloptions&null; - - - Constructs a new MongoDB\Driver\ReadPreference, which - is an immutable value object. - - - - - &reftitle.parameters; - - - mode - - - - Read preference mode - - - - Value - Description - - - - - "primary" - - - All operations read from the current replica set primary. This is - the default read preference for MongoDB. - - - - - "primaryPreferred" - - - In most situations, operations read from the primary but if it is - unavailable, operations read from secondary members. - - - - - "secondary" - - - All operations read from the secondary members of the replica set. - - - - - "secondaryPreferred" - - - In most situations, operations read from secondary members but if no - secondary members are available, operations read from the primary. - - - - - "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 "primary" mode and, - in general, only apply when selecting a secondary member of a set for a - read operation. However, the "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 "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 2.0.0 - - Passing an int for the mode argument - is no longer supported. - - - - PECL mongodb 1.20.0 - - Passing an int for the mode argument - is DEPRECATED. - - - - 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::SECONDARY, null, ['maxStalenessSeconds' => 120])); - -/* Explicitly enable server hedged reads */ -var_dump(new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::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 98288c102cce..000000000000 --- 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 d4c6ac71e1c7..000000000000 --- 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::SECONDARY, null, [ - 'maxStalenessSeconds' => MongoDB\Driver\ReadPreference::NO_MAX_STALENESS, -]); -var_dump($rp->getMaxStalenessSeconds()); - -$rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::SECONDARY, null, [ - 'maxStalenessSeconds' => MongoDB\Driver\ReadPreference::SMALLEST_MAX_STALENESS_SECONDS, -]); -var_dump($rp->getMaxStalenessSeconds()); - -$rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::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 087031bb47ae..000000000000 --- a/reference/mongodb/mongodb/driver/readpreference/getmode.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - MongoDB\Driver\ReadPreference::getMode - Returns the ReadPreference's "mode" option - - - - - - This function has been DEPRECATED as of extension - version 1.20.0 and was removed in 2.0. Applications should use - MongoDB\Driver\ReadPreference::getModeString - instead. - - - - - - &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.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.method-removed; - - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\ReadPreference::getMode</function> example - -getMode()); - -$rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::PRIMARY_PREFERRED); -var_dump($rp->getMode()); - -$rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::SECONDARY); -var_dump($rp->getMode()); - -$rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::SECONDARY_PREFERRED); -var_dump($rp->getMode()); - -$rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::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 ca231f2a6bf9..000000000000 --- a/reference/mongodb/mongodb/driver/readpreference/getmodestring.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - MongoDB\Driver\ReadPreference::getModeString - Returns the ReadPreference's "mode" option - - - - &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 4d140e9fbeaa..000000000000 --- 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/server.xml b/reference/mongodb/mongodb/driver/server.xml deleted file mode 100644 index 34a9f77470b3..000000000000 --- a/reference/mongodb/mongodb/driver/server.xml +++ /dev/null @@ -1,237 +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 member 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 ac01ee210070..000000000000 --- 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 05ed61f5b33e..000000000000 --- a/reference/mongodb/mongodb/driver/server/executebulkwrite.xml +++ /dev/null @@ -1,175 +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 - arraynulloptions&null; - - - 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. - - - The default value for the "writeConcern" option will be - inferred from an active transaction (indicated by the - "session" option), followed by the - connection URI. - - - - - &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 2.0.0 - - The options parameter no longer accepts a - MongoDB\Driver\WriteConcern instance. - - - - PECL mongodb 1.21.0 - - Passing a MongoDB\Driver\WriteConcern object as - options is deprecated and will be removed in 2.0. - - - - 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 parameter 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/executebulkwritecommand.xml b/reference/mongodb/mongodb/driver/server/executebulkwritecommand.xml deleted file mode 100644 index bef524c3aced..000000000000 --- a/reference/mongodb/mongodb/driver/server/executebulkwritecommand.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - MongoDB\Driver\Server::executeBulkWriteCommand - Execute write operations on this server using the bulkWrite command - - - - &reftitle.description; - - final public MongoDB\Driver\BulkWriteCommandResultMongoDB\Driver\Server::executeBulkWriteCommand - MongoDB\Driver\BulkWriteCommandbulk - arraynulloptions&null; - - - Executes one or more write operations on this server using the - bulkWrite - command introduced in MongoDB 8.0. - - - A MongoDB\Driver\BulkWriteCommand can be constructed - with one or more write operations of varying types (e.g. inserts, updates, - and deletes). Each write operation may target a different collection. - - - The default value for the "writeConcern" option will be - inferred from an active transaction (indicated by the - "session" option), followed by the - connection URI. - - - - - &reftitle.parameters; - - &mongodb.parameter.bulkwritecommand; - - options - - - - options - - - - Option - Type - Description - - - - &mongodb.option.session; - &mongodb.option.writeConcern; - - -
    -
    -
    -
    -
    -
    - - - &reftitle.returnvalues; - &mongodb.returns.bulkwritecommandresult; - - - - &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\BulkWriteCommand objects may not be executed multiple times. - &mongodb.throws.session-unacknowledged; - &mongodb.throws.std; - &mongodb.throws.bulkwritecommandexception; - Throws MongoDB\Driver\Exception\RuntimeException on other errors. - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWriteCommand - MongoDB\Driver\BulkWriteCommandResult - MongoDB\Driver\WriteConcern - MongoDB\Driver\Manager::executeBulkWriteCommand - - - -
    - - diff --git a/reference/mongodb/mongodb/driver/server/executecommand.xml b/reference/mongodb/mongodb/driver/server/executecommand.xml deleted file mode 100644 index 8bd725182fd1..000000000000 --- a/reference/mongodb/mongodb/driver/server/executecommand.xml +++ /dev/null @@ -1,171 +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 - arraynulloptions&null; - - - Executes the command on this server. - - - This method applies no special logic to the command. The - Default values for the "readPreference", - "readConcern", and "writeConcern" - options will be inferred from an active transaction (indicated by the - "session" option). If there is no active transaction, a - primary read preference will be used for server selection. - - - Default values will not be inferred from the - connection URI. - 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 2.0.0 - - The options parameter no longer accepts a - MongoDB\Driver\ReadPreference instance. - - - - PECL mongodb 1.21.0 - - Passing a MongoDB\Driver\ReadPreference object as - options is deprecated and will be removed in 2.0. - - - - 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 parameter 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 24014368bac8..000000000000 --- a/reference/mongodb/mongodb/driver/server/executequery.xml +++ /dev/null @@ -1,143 +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 - arraynulloptions&null; - - - Executes the query on this server. - - - Default values for the "readPreference" option and Query's - "readConcern" option will be inferred from an active - transaction (indicated by the "session" option), followed - by the connection URI. - - &mongodb.note.server.readpreference; - - - - &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 2.0.0 - - The options parameter no longer accepts a - MongoDB\Driver\ReadPreference instance. - - - - PECL mongodb 1.21.0 - - Passing a MongoDB\Driver\ReadPreference object as - options is deprecated and will be removed in 2.0. - - - - PECL mongodb 1.4.0 - - The third parameter is now an options array. - For backwards compatibility, this parameter 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 667c3a119bb6..000000000000 --- a/reference/mongodb/mongodb/driver/server/executereadcommand.xml +++ /dev/null @@ -1,113 +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 - arraynulloptions&null; - - - Executes the command on this server, irrespective of the - "readPreference" option. - - - This method will apply logic that is specific to commands that read (e.g. - distinct). - Default values for the "readPreference" and - "readConcern" options will be inferred from an active - transaction (indicated by the "session" option), followed - by the 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 dfa143c74b3e..000000000000 --- a/reference/mongodb/mongodb/driver/server/executereadwritecommand.xml +++ /dev/null @@ -1,141 +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 - arraynulloptions&null; - - - Executes the command on this server. - - - This method will apply logic that is specific to commands that read and write - (e.g. aggregate). - Default values for the "readConcern" and - "writeConcern" options will be inferred from an active - transaction (indicated by the "session" option), followed - by the 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 ad5e6e25dc9c..000000000000 --- a/reference/mongodb/mongodb/driver/server/executewritecommand.xml +++ /dev/null @@ -1,151 +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 - arraynulloptions&null; - - - Executes the command on this server. - - - This method will apply logic that is specific to commands that write (e.g. - drop). - The default value for the "writeConcern" option will be - inferred from an active transaction (indicated by the - "session" option), followed by the - 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 - operations. - - - - - - &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 560dea0aefd6..000000000000 --- a/reference/mongodb/mongodb/driver/server/gethost.xml +++ /dev/null @@ -1,96 +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(); - -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 3aeaf8662f1f..000000000000 --- a/reference/mongodb/mongodb/driver/server/getinfo.xml +++ /dev/null @@ -1,260 +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 d0305dd21c5f..000000000000 --- a/reference/mongodb/mongodb/driver/server/getlatency.xml +++ /dev/null @@ -1,123 +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(); - -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 08434410cdeb..000000000000 --- a/reference/mongodb/mongodb/driver/server/getport.xml +++ /dev/null @@ -1,96 +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(); - -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 dd00da0b31c2..000000000000 --- 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 505254bc6072..000000000000 --- 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 d395c1e357d4..000000000000 --- 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 2444240b061f..000000000000 --- 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 88f854237df9..000000000000 --- 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 5e6cb5129b9a..000000000000 --- 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 ad45b7dea848..000000000000 --- 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 172685eb4741..000000000000 --- 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 912cba728b85..000000000000 --- 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 510e7d7dc685..000000000000 --- 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 stdClassMongoDB\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 6cc8ef288f4c..000000000000 --- a/reference/mongodb/mongodb/driver/serverapi/construct.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - MongoDB\Driver\ServerApi::__construct - Create a new ServerApi instance - - - - &reftitle.description; - - final public MongoDB\Driver\ServerApi::__construct - stringversion - boolnullstrict&null; - boolnulldeprecationErrors&null; - - - - Creates a new MongoDB\Driver\ServerApi instance used to - declare an API version when creating a - MongoDB\Driver\Manager. - - - - - &reftitle.parameters; - - - version - - - A server API version. - - - Supported API versions are provided as constants in - MongoDB\Driver\ServerApi. The only supported API - version is MongoDB\Driver\ServerApi::V1. - - - - - strict - - - If the strict parameter is set to &true;, the - server will yield an error for any command that is not part of the - specified API version. If no value is provided, the server default value - (&false;) is used. - - - - - deprecationErrors - - - If the deprecationErrors parameter is set to &true;, - the server will yield an error when using a command that is deprecated in - the specified API version. If no value is provided, the server default value - (&false;) is used. - - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/serverdescription.xml b/reference/mongodb/mongodb/driver/serverdescription.xml deleted file mode 100644 index 1c9c09a2d488..000000000000 --- 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 4e7605e6a7bc..000000000000 --- 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 38f528cfdcc0..000000000000 --- 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 152b328bd455..000000000000 --- 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 23e7e0398d57..000000000000 --- 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 eb6f03f551e3..000000000000 --- 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 intnullMongoDB\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 3ec04f71d428..000000000000 --- 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 f752a418ed1e..000000000000 --- 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 with 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 cb03deca2abf..000000000000 --- 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 deaf3ac6fe0a..000000000000 --- 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 8dc7657788bd..000000000000 --- 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 24770db07b20..000000000000 --- 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 - "UnknownTransactionCommitResult" value, it is safe to re-try - the whole transaction. In newer versions of the - extension, - 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 committed (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 3b687a447aa8..000000000000 --- 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 aed0800fc51a..000000000000 --- 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 248f468cbd1e..000000000000 --- 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 7bf28358e11f..000000000000 --- 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 2e1355f40fec..000000000000 --- 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 7209fe7a81b6..000000000000 --- 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 216f0b320f07..000000000000 --- 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 c61035ccfec1..000000000000 --- 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 f07297de3850..000000000000 --- 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 7f372462e0e0..000000000000 --- 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 01f953196679..000000000000 --- a/reference/mongodb/mongodb/driver/session/starttransaction.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - MongoDB\Driver\Session::startTransaction - Starts a transaction - - - - &reftitle.description; - - final public voidMongoDB\Driver\Session::startTransaction - arraynulloptions&null; - - - 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 8d64fc79f088..000000000000 --- 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 305332c7c070..000000000000 --- 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 43ea094f15ab..000000000000 --- 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 2c66513fffa3..000000000000 --- 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 4763f63d8b05..000000000000 --- 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 c1769066b76e..000000000000 --- a/reference/mongodb/mongodb/driver/writeconcern.xml +++ /dev/null @@ -1,197 +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" - - - &Properties; - - public - readonly - stringintnull - w - - - public - readonly - boolnull - j - - - public - readonly - int - wtimeout - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - w - - - The write concern value (integer number of nodes, the string - "majority", or a custom write concern tag name), - or &null; if not set. - - - - - j - - - Whether write operations must be committed to the journal before - acknowledged, or &null; if not specified. - - - - - wtimeout - - - The timeout in milliseconds to wait for write concern acknowledgement. - A value of 0 means to wait indefinitely. - - - - -
    - - - -
    - &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 2.3.0 - - Added public readonly properties. - - - - 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 583db2322951..000000000000 --- 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 stdClassMongoDB\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\Document::fromPHP($wc)->toRelaxedExtendedJSON(); - -?> -]]> - - &example.outputs.similar; - - - string(8) "majority" -} - -{ "w" : "majority" } -]]> - - - <function>MongoDB\Driver\WriteConcern::bsonSerialize</function> with wtimeout and journal - -bsonSerialize()); - -echo "\n", MongoDB\BSON\Document::fromPHP($wc)->toRelaxedExtendedJSON(); - -?> -]]> - - &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 19c0c04ae4b1..000000000000 --- a/reference/mongodb/mongodb/driver/writeconcern/construct.xml +++ /dev/null @@ -1,229 +0,0 @@ - - - - - - MongoDB\Driver\WriteConcern::__construct - Create a new WriteConcern - - - - &reftitle.description; - - final public MongoDB\Driver\WriteConcern::__construct - stringintw - intnullwtimeout&null; - boolnulljournal&null; - - - 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 5a078cc8acec..000000000000 --- 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 8fda4ab1f0cc..000000000000 --- 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 facd0ad51c6b..000000000000 --- a/reference/mongodb/mongodb/driver/writeconcern/getwtimeout.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - MongoDB\Driver\WriteConcern::getWtimeout - Returns the WriteConcern's "wtimeout" option - - - - &reftitle.description; - - final public intMongoDB\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 always truncate the wTimeout - value if it exceeds the 32-bit range. In that case, a warning will be - emitted. - - - - - - - - - - &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 c6d3ef7344e1..000000000000 --- 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/writeconcernerror.xml b/reference/mongodb/mongodb/driver/writeconcernerror.xml deleted file mode 100644 index f6f8533554fd..000000000000 --- a/reference/mongodb/mongodb/driver/writeconcernerror.xml +++ /dev/null @@ -1,140 +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 - - - - - &Properties; - - public - readonly - string - message - - - public - readonly - int - code - - - public - readonly - objectnull - info - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - message - - The error message. - - - - code - - The error code. - - - - info - - - Additional information for the error, or &null; if not available. - - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - Added public readonly properties. - - - - - -
    - -
    - - &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 acee94a89879..000000000000 --- 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' => $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 693bca00fb74..000000000000 --- 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' => $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 fc2a4e62345b..000000000000 --- 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' => $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 9ebcef86575d..000000000000 --- a/reference/mongodb/mongodb/driver/writeerror.xml +++ /dev/null @@ -1,155 +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 - - - - - &Properties; - - public - readonly - string - message - - - public - readonly - int - code - - - public - readonly - int - index - - - public - readonly - objectnull - info - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - message - - The error message. - - - - code - - The error code. - - - - index - - - The index of the write operation within the - MongoDB\Driver\BulkWrite that caused the error. - - - - - info - - - Additional information for the error, or &null; if not available. - - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - Added public readonly properties. - - - - - -
    - -
    - - &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 c2be05e720f6..000000000000 --- 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 df6199a72b99..000000000000 --- 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 4f607ab9935e..000000000000 --- 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 461221c71d8e..000000000000 --- 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 e14aee3a9082..000000000000 --- a/reference/mongodb/mongodb/driver/writeresult.xml +++ /dev/null @@ -1,269 +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 - - - - - &Properties; - - public - readonly - intnull - insertedCount - - - public - readonly - intnull - matchedCount - - - public - readonly - intnull - modifiedCount - - - public - readonly - intnull - deletedCount - - - public - readonly - intnull - upsertedCount - - - public - readonly - MongoDB\Driver\Server - server - - - public - readonly - array - upsertedIds - - - public - readonly - array - writeErrors - - - public - readonly - MongoDB\Driver\WriteConcernErrornull - writeConcernError - - - public - readonly - MongoDB\Driver\WriteConcernnull - writeConcern - - - public - readonly - array - errorReplies - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - insertedCount - - - The number of documents inserted (excluding upserts), or &null; if - the write concern did not request acknowledgement. - - - - - matchedCount - - - The number of documents matched by update and replace operations, or - &null; if the write concern did not request acknowledgement. - - - - - modifiedCount - - - The number of documents modified by update and replace operations, or - &null; if the write concern did not request acknowledgement or if the - server did not report this information. - - - - - deletedCount - - - The number of documents deleted, or &null; if the write concern did - not request acknowledgement. - - - - - upsertedCount - - - The number of documents upserted, or &null; if the write concern did - not request acknowledgement. - - - - - server - - - The server that executed the bulk write. - - - - - upsertedIds - - - An array of _id values for upserted documents. - Array keys will correspond to the index of the write operation from - MongoDB\Driver\BulkWrite. - - - - - writeErrors - - - An array of MongoDB\Driver\WriteErrors for any - write errors that occurred during execution. - - - - - writeConcernError - - - The MongoDB\Driver\WriteConcernError that - occurred, or &null; if no write concern error occurred. - - - - - writeConcern - - - The MongoDB\Driver\WriteConcern used for the - bulk write, or &null; if not available. - - - - - errorReplies - - - An array of error reply documents from the server. - - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - Added public readonly properties. - - - - - -
    - -
    - - &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 5815c6838eb9..000000000000 --- a/reference/mongodb/mongodb/driver/writeresult/getdeletedcount.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - MongoDB\Driver\WriteResult::getDeletedCount - Returns the number of documents deleted - - - - &reftitle.description; - - final public intMongoDB\Driver\WriteResult::getDeletedCount - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the number of documents deleted. - - - - - &reftitle.errors; - - &mongodb.throws.unacknowledged; - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.throw-unacknowledged-write; - - - - - - - &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 68c94bb4ccb8..000000000000 --- a/reference/mongodb/mongodb/driver/writeresult/getinsertedcount.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - MongoDB\Driver\WriteResult::getInsertedCount - Returns the number of documents inserted (excluding upserts) - - - - &reftitle.description; - - final public intMongoDB\Driver\WriteResult::getInsertedCount - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the number of documents inserted (excluding upserts). - - - - - &reftitle.errors; - - &mongodb.throws.unacknowledged; - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.throw-unacknowledged-write; - - - - - - - &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 6319c769b599..000000000000 --- a/reference/mongodb/mongodb/driver/writeresult/getmatchedcount.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - MongoDB\Driver\WriteResult::getMatchedCount - Returns the number of documents selected for update - - - - &reftitle.description; - - final public intMongoDB\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. - - - - - &reftitle.errors; - - &mongodb.throws.unacknowledged; - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.throw-unacknowledged-write; - - - - - - - &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 acbe6da8c830..000000000000 --- a/reference/mongodb/mongodb/driver/writeresult/getmodifiedcount.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - MongoDB\Driver\WriteResult::getModifiedCount - Returns the number of existing documents updated - - - - &reftitle.description; - - final public intMongoDB\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. - - - - - &reftitle.errors; - - &mongodb.throws.unacknowledged; - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.throw-unacknowledged-write; - - - - - - - &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 1a3fa8213bfb..000000000000 --- 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(); - -$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 79b278e1726c..000000000000 --- a/reference/mongodb/mongodb/driver/writeresult/getupsertedcount.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - MongoDB\Driver\WriteResult::getUpsertedCount - Returns the number of documents inserted by an upsert - - - - &reftitle.description; - - final public intMongoDB\Driver\WriteResult::getUpsertedCount - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the number of documents inserted by an upsert. - - - - - &reftitle.errors; - - &mongodb.throws.unacknowledged; - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.throw-unacknowledged-write; - - - - - - - &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 b8122fc332ca..000000000000 --- 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 a0968a7c5c2a..000000000000 --- 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' => $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 e0d7055c8a64..000000000000 --- 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 68f7ba66c4f9..000000000000 --- a/reference/mongodb/mongodb/driver/writeresult/isacknowledged.xml +++ /dev/null @@ -1,129 +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]); - -$writeConcern = new MongoDB\Driver\WriteConcern(0); - -$result = $manager->executeBulkWrite('db.collection', $bulk, ['writeConcern' => $writeConcern]); - -var_dump($result->isAcknowledged()); - -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\WriteConcern - Write Concern reference - - - - - - diff --git a/reference/mongodb/monitoring.xml b/reference/mongodb/monitoring.xml deleted file mode 100644 index 58ad6eae0ce3..000000000000 --- a/reference/mongodb/monitoring.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - Monitoring classes and subscriber functions - MongoDB\Driver\Monitoring - - - &Functions; - &reference.mongodb.functions.driver.entities.monitoring; - - - &reference.mongodb.mongodb.driver.monitoring.commandfailedevent; - &reference.mongodb.mongodb.driver.monitoring.commandstartedevent; - &reference.mongodb.mongodb.driver.monitoring.commandsucceededevent; - - &reference.mongodb.mongodb.driver.monitoring.serverchangedevent; - &reference.mongodb.mongodb.driver.monitoring.serverclosedevent; - &reference.mongodb.mongodb.driver.monitoring.serveropeningevent; - &reference.mongodb.mongodb.driver.monitoring.serverheartbeatfailedevent; - &reference.mongodb.mongodb.driver.monitoring.serverheartbeatstartedevent; - &reference.mongodb.mongodb.driver.monitoring.serverheartbeatsucceededevent; - &reference.mongodb.mongodb.driver.monitoring.topologychangedevent; - &reference.mongodb.mongodb.driver.monitoring.topologyclosedevent; - &reference.mongodb.mongodb.driver.monitoring.topologyopeningevent; - - &reference.mongodb.mongodb.driver.monitoring.commandsubscriber; - &reference.mongodb.mongodb.driver.monitoring.logsubscriber; - &reference.mongodb.mongodb.driver.monitoring.sdamsubscriber; - &reference.mongodb.mongodb.driver.monitoring.subscriber; - diff --git a/reference/mongodb/security.xml b/reference/mongodb/security.xml deleted file mode 100644 index 31455353c718..000000000000 --- a/reference/mongodb/security.xml +++ /dev/null @@ -1,182 +0,0 @@ - - - - - Security - -
    - Request Injection Attacks - - If you are passing $_GET (or $_POST) - parameters to your queries, make sure that they are cast to strings first. - Users can insert associative arrays in GET and POST requests, which could - then become unwanted $-queries. - - - - A fairly innocuous example: suppose you are looking up a user's information - with the request http://www.example.com?username=bob. - Your application creates the query - $q = new \MongoDB\Driver\Query( [ 'username' => $_GET['username'] ]). - - - - Someone could subvert this by getting - http://www.example.com?username[$ne]=foo, which PHP - will magically turn into an associative array, turning your query into - $q = new \MongoDB\Driver\Query( [ 'username' => [ '$ne' => 'foo' ] ] ), - which will return all users not named "foo" (all of your users, probably). - - - - This is a fairly easy attack to defend against: make sure $_GET and $_POST - parameters are the type you expect before you send them to the database. - PHP has the filter_var function to assist with this. - - - - Note that this type of attack can be used with any database interaction that - locates a document, including updates, upserts, deletes, and findAndModify - commands. - - - - See the main documentation - for more information about SQL-injection-like issues with MongoDB. - -
    - -
    - Script Injection Attacks - - If you are using JavaScript, make sure that any variables that cross the PHP- - to-JavaScript boundary are passed in the scope field of - MongoDB\BSON\Javascript, not interpolated into the - JavaScript string. This can come up when using $where - clauses in queries, mapReduce and group commands, and any other time you may - pass JavaScript into the database. - - - For example, suppose we have some JavaScript to greet a user in the database - logs. We could do: - - - "print('Hello, $username!');" -] ); - -$r = $m->executeCommand( 'dramio', $cmd ); -?> -]]> - - - However, what if a malicious user passes in some JavaScript? - - - "print('Hello, $username!');" -] ); - -$r = $m->executeCommand( 'dramio', $cmd ); -?> -]]> - - - Now MongoDB executes the JavaScript string - "print('Hello, '); db.users.drop(); print('!');". - This attack is easy to avoid: use args to pass - variables from PHP to JavaScript: - - - "function greet(username) { print('Hello, ' + username + '!'); }", - 'args' => $args, -] ); - -$r = $m->executeCommand( 'dramio', $cmd ); -?> -]]> - - - This adds an argument to the JavaScript scope, which gets used as argument - for the greet function. Now if - someone tries to send malicious code, MongoDB will harmlessly print - Hello, '); db.dropDatabase(); print('!. - - - - Using arguments helps to prevent malicious input from being executed by the - database. However, you must make sure that your code does not turn around - and execute the input anyway! It is best to avoid executing - any JavaScript on the server in the first place. - - - - You are strongly recommended to stay clear of the $where - clause with queries, as it impacts performance significantly. Where - possible, use either normal query operators, or the Aggregation - Framework. - - - - As alternative to MapReduce, which uses - JavaScript, consider using the Aggregation - Framework. Unlike Map/Reduce, it uses an idiomatic language to - construct queries, without having to write, and use, the slower JavaScript - approach that Map/Reduce requires. - - - - The eval command - has been deprecated since MongoDB 3.0, and should also be avoided. - -
    -
    - - diff --git a/reference/mongodb/setup.xml b/reference/mongodb/setup.xml deleted file mode 100644 index 2d111214eb37..000000000000 --- a/reference/mongodb/setup.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - As of version 1.21.0, the extension requires PHP 8.1 or higher. Previous - versions of the extension allow compatibility with older PHP versions. - - - The extension requires - libbson and - libmongoc, and will use - bundled versions of both libraries by default. System libraries may also be - used, as discussed in the - manual installation - documentation. - - - The extension, via libmongoc, optionally depends on a TLS library (e.g. - OpenSSL) and will use it if available. If the build process fails to find a - TLS library, users should check that the appropriate development package - (e.g. libssl-dev) and - pkg-config are both - installed. The process for detecting and configuring TLS libraries is - discussed in more detail in the - manual installation - documentation. - - - Cyrus SASL is an optional dependency to - support Kerberos authentication and will be used if available. - - - - Due to potential problems representing 64-bit integers on 32-bit platforms, - users are advised to use 64-bit environments. When using a 32-bit platform, - be aware that any 64-bit integer read from the database will be returned as - a MongoDB\BSON\Int64 instance instead of a PHP - integer type. - - -
    - - &reference.mongodb.configure; - &reference.mongodb.ini; - - -
    - - diff --git a/reference/mongodb/tutorial.xml b/reference/mongodb/tutorial.xml deleted file mode 100644 index cbeca557b291..000000000000 --- a/reference/mongodb/tutorial.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - Tutorials - Tutorials - - - - - In this section you will find several tutorials on how to use the MongoDB - driver for PHP. - - - - - &reference.mongodb.tutorial.library; - &reference.mongodb.tutorial.apm; - - - - diff --git a/reference/mongodb/tutorial/apm.xml b/reference/mongodb/tutorial/apm.xml deleted file mode 100644 index 60a3acdad501..000000000000 --- a/reference/mongodb/tutorial/apm.xml +++ /dev/null @@ -1,209 +0,0 @@ - - - -
    - Application Performance Monitoring (APM) - - - The extension contains an event subscriber API, which allows applications to - monitor commands and internal activity pertaining to the - Server Discovery and Monitoring Specification. - This tutorial will demonstrate command monitoring using the - MongoDB\Driver\Monitoring\CommandSubscriber interface. - - - - The MongoDB\Driver\Monitoring\CommandSubscriber - interface defines three methods: commandStarted, - commandSucceeded, and commandFailed. - Each of these three methods accept a single event - argument of a specific class for the respective event. For example, the - commandSucceeded's event argument - is a MongoDB\Driver\Monitoring\CommandSucceededEvent - object. - - - - In this tutorial we will implement a subscriber that creates a list of all - the query profiles and the average time they took. - - -
    - Subscriber Class Scaffolding - - - We start with the framework for our subscriber: - - - - -]]> - -
    - -
    - Registering the Subscriber - - - Once a subscriber object is instantiated, it needs to be registered with the - extensions's monitoring system. This is done by calling - MongoDB\Driver\Monitoring\addSubscriber or - MongoDB\Driver\Manager::addSubscriber to register - the subscriber globally or with a specific Manager, respectively. - - - - -]]> - -
    - -
    - Implementing the Logic - - - With the object registered, the only thing left is to implement the logic - in the subscriber class. To correlate the two events that make up a - successfully executed command (commandStarted and commandSucceeded), each - event object exposes a requestId field. - - - To record the average time per query shape, we will start by checking for a - find command in the commandStarted event. We will then add - an item to the pendingCommands property indexed by its - requestId and with its value representing the query shape. - - - If we receive a corresponding commandSucceeded event with the same - requestId, we add the duration of the event (from - durationMicros) to the total time and increment the - operation count. - - - If a corresponding commandFailed event is encountered, we just remove the - entry from the pendingCommands property. - - - -getCommandName() ) - { - $queryShape = $this->createQueryShape( (array) $event->getCommand()->filter ); - $this->pendingCommands[$event->getRequestId()] = $queryShape; - } - } - - public function commandSucceeded( \MongoDB\Driver\Monitoring\CommandSucceededEvent $event ): void - { - $requestId = $event->getRequestId(); - if ( array_key_exists( $requestId, $this->pendingCommands ) ) - { - $this->queryShapeStats[$this->pendingCommands[$requestId]]['count']++; - $this->queryShapeStats[$this->pendingCommands[$requestId]]['duration'] += $event->getDurationMicros(); - unset( $this->pendingCommands[$requestId] ); - } - } - - public function commandFailed( \MongoDB\Driver\Monitoring\CommandFailedEvent $event ): void - { - if ( array_key_exists( $event->getRequestId(), $this->pendingCommands ) ) - { - unset( $this->pendingCommands[$event->getRequestId()] ); - } - } - - public function __destruct() - { - foreach( $this->queryShapeStats as $shape => $stats ) - { - echo "Shape: ", $shape, " (", $stats['count'], ")\n ", - $stats['duration'] / $stats['count'], "µs\n\n"; - } - } -} - -$m = new \MongoDB\Driver\Manager( 'mongodb://localhost:27016' ); - -/* Add the subscriber */ -\MongoDB\Driver\Monitoring\addSubscriber( new QueryTimeCollector() ); - -/* Do a bunch of queries */ -$query = new \MongoDB\Driver\Query( [ - 'region_slug' => 'scotland-highlands', 'age' => [ '$gte' => 20 ] -] ); -$cursor = $m->executeQuery( 'dramio.whisky', $query ); - -$query = new \MongoDB\Driver\Query( [ - 'region_slug' => 'scotland-lowlands', 'age' => [ '$gte' => 15 ] -] ); -$cursor = $m->executeQuery( 'dramio.whisky', $query ); - -$query = new \MongoDB\Driver\Query( [ 'region_slug' => 'scotland-lowlands' ] ); -$cursor = $m->executeQuery( 'dramio.whisky', $query ); - -?> -]]> - -
    - -
    - - diff --git a/reference/mongodb/tutorial/library.xml b/reference/mongodb/tutorial/library.xml deleted file mode 100644 index e9246570e089..000000000000 --- a/reference/mongodb/tutorial/library.xml +++ /dev/null @@ -1,178 +0,0 @@ - - - -
    - Using the PHP Library for MongoDB (PHPLIB) - - - After the initial extension set-up, we will continue explaining how to get - started with the corresponding userland library to write our first project. - - -
    - Installing the PHP Library with Composer - - - The last thing we still need to install to get started on the application - itself, is the PHP library. - - - - The library needs to be installed with - Composer, a package manager - for PHP. Instructions for installing Composer on various platforms may be - found on its website. - - - - Install the library by running: - - - - - - -It will output something akin to: - - - - - - - - Composer will create several files: composer.json, - composer.lock, and a vendor directory that will - contain the library and any other dependencies your project might require. - -
    - -
    - Using the PHP Library - - - In addition to managing your dependencies, Composer will also provide you - with an autoloader (for those dependencies' classes). Ensure that it is - included at the start of your script or in your application's bootstrap - code: - - - - - - - With this done, you can now use any of the functionality as described in the - library documentation. - - - - If you have used MongoDB drivers in other languages, the library's API - should look familiar. It contains a - Client - class for connecting to MongoDB, a - Database - class for database-level operations (e.g. commands, collection management), - and a - Collection - class for collection-level operations (e.g. - CRUD methods, index management). - - - - As an example, this is how you insert a document into the - beers collection of the demo - database: - -demo->beers; - -$result = $collection->insertOne( [ 'name' => 'Hinterland', 'brewery' => 'BrewDog' ] ); - -echo "Inserted with Object ID '{$result->getInsertedId()}'"; -?> -]]> - - - - - Since the inserted document did not contain an _id field, the - extension will generate an MongoDB\BSON\ObjectId for - the server to use as the _id. This value is also made available - to the caller via the result object returned by the insertOne - method. - - - - After insertion, you can query for the data that you have just inserted. - For that, you use the find method, which returns an iterable - cursor: - -demo->beers; - -$result = $collection->find( [ 'name' => 'Hinterland', 'brewery' => 'BrewDog' ] ); - -foreach ($result as $entry) { - echo $entry['_id'], ': ', $entry['name'], "\n"; -} -?> -]]> - - - - - While it may not be apparent in the examples, BSON documents and arrays are - unserialized as special classes in the library by default. These classes - extend ArrayObject for usability and implement the - extension's MongoDB\BSON\Serializable and - MongoDB\BSON\Unserializable interfaces to - ensure that values preserve their type when serialized back into BSON. This - avoids a caveat in the legacy mongo extension where arrays - might turn into documents, and vice versa. See the - specification for more information on - how values are converted between PHP and BSON. - -
    -
    - diff --git a/reference/mongodb/versions.xml b/reference/mongodb/versions.xml deleted file mode 100644 index 33f49c555e55..000000000000 --- a/reference/mongodb/versions.xml +++ /dev/null @@ -1,538 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/mqseries/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/mqseries/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/mqseries/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/mqseries/book.xml b/reference/mqseries/book.xml deleted file mode 100644 index 7de924e71783..000000000000 --- a/reference/mqseries/book.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - mqseries - - - - &reftitle.intro; - &warn.experimental; - - This extension aims to provide an interface for communicating with IBMs - WebSphere MQ series Queue managers. - - - The interface mimics the C-API client interface of WebSphere MQ Series as - close as possible. Using the same naming conventions and possibilities of the - C-API. In order to understand the workings of this extension some level of - understanding the C-API is required. - - - For MQ-options, MQ-structures, MQ-results etc. please read the WebSphere MQ - Application Programming Guide and WebSphere MQ Application Programming - Reference. - - - - - &reference.mqseries.setup; - &reference.mqseries.constants; - &reference.mqseries.reference; - - - diff --git a/reference/mqseries/configure.xml b/reference/mqseries/configure.xml deleted file mode 100644 index 78898190925c..000000000000 --- a/reference/mqseries/configure.xml +++ /dev/null @@ -1,53 +0,0 @@ - - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; &url.pecl.package;mqseries. - - - - The official name of this extension is mqseries. - - - - There are two ways to connect to a queue manager. These depend on the way the extension is compiled and linked. - - - - First one and also the default one is using the mqic libraries. Compiling and linking the - extension against these IBM WebSphere MQSeries libraries allows the extension to connect to the - Queue manager using the client interface. Remote connections are possible this way. - - - - The other way is to compile and link against the mqm libraries. Using these libraries it is - possible to make use of the transaction management of a queue manager. - - - - Currently selecting the libraries to use is done by changing the config.m4 file. -
    - diff --git a/reference/mqseries/constants.xml b/reference/mqseries/constants.xml deleted file mode 100644 index 5c200aacd704..000000000000 --- a/reference/mqseries/constants.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - &reftitle.constants; - - For each WebSphere MQ Constant there is a mqseries counterpart. - - For definitions and usage see the WebSphere MQ Application Programming Guide and WebSphere MQ - Application Programming Reference red books. - - The name of the mqseries counterpart is made by appending the WebSphere MQ constant with MQSERIES_, - for example the CompletionCode constants are: - - - mqseries constants - - - - PHP Constant - MQ Constant - - - - - MQSERIES_MQCC_OK - MQCC_OK - - - MQSERIES_MQCC_WARNING - MQCC_WARNING - - - MQSERIES_MQCC_FAILED - MQCC_FAILED - - - MQSERIES_MQCC_UNKNOWN - MQCC_UNKNOWN - - - -
    - -
    - diff --git a/reference/mqseries/functions/mqseries-back.xml b/reference/mqseries/functions/mqseries-back.xml deleted file mode 100644 index 04c66bed7ca7..000000000000 --- a/reference/mqseries/functions/mqseries-back.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - mqseries_back - MQSeries MQBACK - - - - &reftitle.description; - - voidmqseries_back - resourcehconn - resourcecompCode - resourcereason - - - The - mqseries_back - (MQBACK) call indicates to the queue manager that all the message gets and - puts that have occurred since the last syncpoint are to be backed out. - Messages put as part of a unit of work are deleted; messages retrieved as - part of a unit of work are reinstated on the queue. - - - Using - mqseries_back - only works in conjunction with - mqseries_begin - and only function when connecting directly to a Queueu manager. Not via the - mqclient interface. - - - - - &reftitle.parameters; - - - - hConn - - - Connection handle. - This handle represents the connection to the queue manager. - - - - - compCode - - - Completion code. - - - - - reason - - - Reason code qualifying the compCode. - - - - - - - &reftitle.returnvalues; - &return.void; - - - - &reftitle.examples; - - - <function>mqseries_back</function> - example - - -\n", $comp_code, $reason, mqseries_strerror($reason)); - } -?> -]]> - - - - - - &reftitle.notes; - - - mqseries_back - will not function when using MQSeries Client to connect to a Queueu Manager. - - - - - - &reftitle.seealso; - - mqseries_conn - mqseries_connx - mqseries_begin - - - - diff --git a/reference/mqseries/functions/mqseries-begin.xml b/reference/mqseries/functions/mqseries-begin.xml deleted file mode 100644 index aeb33ab1afd7..000000000000 --- a/reference/mqseries/functions/mqseries-begin.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - mqseries_begin - MQseries MQBEGIN - - - - &reftitle.description; - - voidmqseries_begin - resourcehconn - arraybeginOptions - resourcecompCode - resourcereason - - - The - mqseries_begin - (MQBEGIN) call begins a unit of work that is coordinated by the queue - manager, and that may involve external resource managers. - - - Using - mqseries_begin - starts the unit of work. Either - mqseries_back - or - mqseries_cmit - ends the unit of work. - - - - - &reftitle.parameters; - - - - hConn - - - Connection handle. - This handle represents the connection to the queue manager. - - - - - compCode - - - Completion code. - - - - - reason - - - Reason code qualifying the compCode. - - - - - - - &reftitle.returnvalues; - &return.void; - - - - &reftitle.examples; - - - <function>mqseries_begin</function> - example - - -\n", $comp_code, $reason, mqseries_strerror($reason)); - } - } -?> -]]> - - - - - - &reftitle.notes; - - - mqseries_begin - will not function when using MQSeries Client to connect to a Queueu Manager. - - - - - - &reftitle.seealso; - - mqseries_conn - mqseries_connx - mqseries_back - mqseries_cmit - - - - diff --git a/reference/mqseries/functions/mqseries-close.xml b/reference/mqseries/functions/mqseries-close.xml deleted file mode 100644 index 2f506711bd63..000000000000 --- a/reference/mqseries/functions/mqseries-close.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - mqseries_close - MQSeries MQCLOSE - - - - &reftitle.description; - - voidmqseries_close - resourcehconn - resourcehobj - intoptions - resourcecompCode - resourcereason - - - The - mqseries_close - (MQCLOSE) call relinquishes access to an object, and is the inverse of the - mqseries_open - (MQOPEN) call. - - - - - &reftitle.parameters; - - - - hConn - - - Connection handle. - This handle represents the connection to the queue manager. - - - - - hObj - - - Object handle. - This handle represents the object to be used. - - - - - options - - - - - - - - compCode - - - Completion code. - - - - - reason - - - Reason code qualifying the compCode. - - - - - - - &reftitle.returnvalues; - &return.void; - - - - &reftitle.examples; - - - <function>mqseries_close</function> - example - - -\n", $comp_code, $reason, mqseries_strerror($reason)); - } -?> -]]> - - - - - - &reftitle.seealso; - - mqseries_open - mqseries_conn - mqseries_connx - - - - diff --git a/reference/mqseries/functions/mqseries-cmit.xml b/reference/mqseries/functions/mqseries-cmit.xml deleted file mode 100644 index f507efe066b7..000000000000 --- a/reference/mqseries/functions/mqseries-cmit.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - mqseries_cmit - MQSeries MQCMIT - - - - &reftitle.description; - - voidmqseries_cmit - resourcehconn - resourcecompCode - resourcereason - - - The - mqseries_cmit - (MQCMIT) call indicates to the queue manager that the application has reached - a syncpoint, and that all of the message gets and puts that have occurred - since the last syncpoint are to be made permanent. Messages put as part of a - unit of work are made available to other applications; messages retrieved as - part of a unit of work are deleted. - - - - - &reftitle.parameters; - - - - hConn - - - Connection handle. - This handle represents the connection to the queue manager. - - - - - compCode - - - Completion code. - - - - - reason - - - Reason code qualifying the compCode. - - - - - - - &reftitle.returnvalues; - &return.void; - - - - &reftitle.examples; - - - <function>mqseries_cmit</function> - example - - -\n", $comp_code, $reason, mqseries_strerror($reason)); - } -?> -]]> - - - - - - &reftitle.notes; - - - mqseries_back - will not function when using MQSeries Client to connect to a Queueu Manager. - - - - - - &reftitle.seealso; - - mqseries_begin - mqseries_back - mqseries_conn - mqseries_connx - - - - diff --git a/reference/mqseries/functions/mqseries-conn.xml b/reference/mqseries/functions/mqseries-conn.xml deleted file mode 100644 index f5f7679e263a..000000000000 --- a/reference/mqseries/functions/mqseries-conn.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - mqseries_conn - MQSeries MQCONN - - - - &reftitle.description; - - voidmqseries_conn - stringqManagerName - resourcehconn - resourcecompCode - resourcereason - - - The - mqseries_conn - (MQCONN) call connects an application program to a queue manager. It provides - a queue manager connection handle, which is used by the application on - subsequent message queuing calls. - - - - - &reftitle.parameters; - - - - qManagerName - - - Name of queue manager. - Name of the queue manager the application wishes to connect. - - - - - hConn - - - Connection handle. - This handle represents the connection to the queue manager. - - - - - compCode - - - Completion code. - - - - - reason - - - Reason code qualifying the compCode. - - - - - - - &reftitle.returnvalues; - &return.void; - - - - &reftitle.examples; - - - <function>mqseries_conn</function> - example - - -\n", $comp_code, $reason, mqseries_strerror($reason)); - exit; - } -?> -]]> - - - - - - &reftitle.seealso; - - mqseries_disc - - - - diff --git a/reference/mqseries/functions/mqseries-connx.xml b/reference/mqseries/functions/mqseries-connx.xml deleted file mode 100644 index 4374789999db..000000000000 --- a/reference/mqseries/functions/mqseries-connx.xml +++ /dev/null @@ -1,184 +0,0 @@ - - - - - mqseries_connx - MQSeries MQCONNX - - - - &reftitle.description; - - voidmqseries_connx - stringqManagerName - arrayconnOptions - resourcehconn - resourcecompCode - resourcereason - - - The - mqseries_connx - (MQCONNX) call connects an application program to a queue manager. It - provides a queue manager connection handle, which is used by the application - on subsequent MQ calls. - - - The mqseries_connx call is like the - mqseries_conn (MQCONN) call, except that MQCONNX - allows options to be specified to control the way that the call works. - - - - - &reftitle.parameters; - - - - qManagerName - - - Name of queue manager. - Name of the queue manager the application wishes to connect. - - - - - connOps - - - Options that control the action of function - See also the MQCNO structure. - - - - - - hConn - - - Connection handle. - This handle represents the connection to the queue manager. - - - - - compCode - - - Completion code. - - - - - reason - - - Reason code qualifying the compCode. - - - - - - - &reftitle.returnvalues; - &return.void; - - - - &reftitle.examples; - - - - <function>mqseries_connx</function> - example - - - MQSERIES_MQCNO_VERSION_2, - 'Options' => MQSERIES_MQCNO_STANDARD_BINDING, - 'MQCD' => array('ChannelName' => 'MQNX9420.CLIENT', - 'ConnectionName' => 'localhost', - 'TransportType' => MQSERIES_MQXPT_TCP) - ); - - mqseries_connx('MQNX9420', $mqcno, $conn, $comp_code,$reason); - if ($comp_code !== MQSERIES_MQCC_OK) { - printf("Connx CompCode:%d Reason:%d Text:%s
    \n", $comp_code, $reason, mqseries_strerror($reason)); - exit; - } - -?> -]]> -
    -
    - - - <function>mqseries_connx</function> - example using SSL connection & OCSP Responder URL - - - 4, //MQCNO_VERSION_4 - 'Options' => MQSERIES_MQCNO_STANDARD_BINDING, - 'MQCD' => array( - 'Version' => 7, //MQCD_VERSION_7 - 'ConnectionName' => 'localhost', - 'TransportType' => MQSERIES_MQXPT_TCP, - 'ChannelName' => 'CONNECTIONCHANNEL', - 'SSLCipherSpec' => 'NULL_SHA' - ), - 'MQSCO' => array( - 'KeyRepository' => '/var/mqm/qmgrs/QUEUEMGR/ssl/key', //Local path where the SSL key repository can be found - 'MQAIR' => array( - 'Version' => 2, //MQAIR_VERSION_2 - 'AuthInfoType' => 2, //MQAIT_OCSP - 'OCSPResponderURL' => 'http://dummy.OCSP.responder' - ) - ) - ); - - mqseries_connx('QUEUEMGR', $mqcno, $conn, $comp_code,$reason); - if ($comp_code !== MQSERIES_MQCC_OK) { - printf("Connx CompCode:%d Reason:%d Text:%s
    \n", $comp_code, $reason, mqseries_strerror($reason)); - exit; - } - -?> -]]> -
    -
    -
    -
    - - - &reftitle.seealso; - - mqseries_disc - - -
    - diff --git a/reference/mqseries/functions/mqseries-disc.xml b/reference/mqseries/functions/mqseries-disc.xml deleted file mode 100644 index e71eec97785d..000000000000 --- a/reference/mqseries/functions/mqseries-disc.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - mqseries_disc - MQSeries MQDISC - - - - &reftitle.description; - - voidmqseries_disc - resourcehconn - resourcecompCode - resourcereason - - - The - mqseries_disc - (MQDISC) call breaks the connection between the queue manager and the - application program, and is the inverse of the - mqseries_conn - (MQCONN) or - mqseries_connx - (MQCONNX) call. - - - - - &reftitle.parameters; - - - - hConn - - - Connection handle. - This handle represents the connection to the queue manager. - - - - - compCode - - - Completion code. - - - - - reason - - - Reason code qualifying the compCode. - - - - - - - &reftitle.returnvalues; - &return.void; - - - - &reftitle.examples; - - - <function>mqseries_disc</function> - example - - -\n", $comp_code, $reason, mqseries_strerror($reason)); - } -?> -]]> - - - - - - &reftitle.seealso; - - mqseries_conn - mqseries_connx - - - - diff --git a/reference/mqseries/functions/mqseries-get.xml b/reference/mqseries/functions/mqseries-get.xml deleted file mode 100644 index b4ad0fa7c652..000000000000 --- a/reference/mqseries/functions/mqseries-get.xml +++ /dev/null @@ -1,196 +0,0 @@ - - - - - mqseries_get - MQSeries MQGET - - - - &reftitle.description; - - voidmqseries_get - resourcehConn - resourcehObj - arraymd - arraygmo - intbufferLength - stringmsg - intdata_length - resourcecompCode - resourcereason - - - The - mqseries_get - (MQGET) call retrieves a message from a local queue that has been opened - using the - mqseries_open - (MQOPEN) call - - - - - &reftitle.parameters; - - - - hConn - - - Connection handle. - This handle represents the connection to the queue manager. - - - - - hObj - - - Object handle. - This handle represents the object to be used. - - - - - md - - - Message descriptor (MQMD). - - - - - gmo - - - Get message options (MQGMO). - - - - - bufferLength - - - Expected length of the result buffer - - - - - msg - - - - Buffer holding the message that was retrieved from the object. - - - - - - data_length - - - Actual buffer length - - - - - compCode - - - Completion code. - - - - - reason - - - Reason code qualifying the compCode. - - - - - - - &reftitle.returnvalues; - &return.void; - - - - &reftitle.examples; - - - <function>mqseries_get</function> - example - - - 'TESTQ'), - MQSERIES_MQOO_INPUT_AS_Q_DEF | MQSERIES_MQOO_FAIL_IF_QUIESCING | MQSERIES_MQOO_OUTPUT, - $obj, - $comp_code, - $reason); -// $obj now holds the reference to the object (TESTQ) - -// setup empty message descriptor. - $mdg = array(); -// setup get message options - $gmo = array('Options' => MQSERIES_MQGMO_FAIL_IF_QUIESCING | MQSERIES_MQGMO_WAIT, 'WaitInterval' => 3000); - -// get the message from the queue - mqseries_get($conn, $obj, $mdg, $gmo, 255, $msg, $data_length, $comp_code, $reason); - if ($comp_code !== MQSERIES_MQCC_OK) { - printf("GET CompCode:%d Reason:%d Text:%s
    ", $comp_code, $reason, mqseries_strerror($reason)); - } - -// close the object reference $obj - mqseries_close($conn, $obj, MQSERIES_MQCO_NONE, $comp_code, $reason); - -// disconnect from the queue manager. - mqseries_disc($conn, $comp_code, $reason); - -?> -]]> -
    -
    -
    - - - &reftitle.seealso; - - mqseries_conn - mqseries_connx - mqseries_open - mqseries_put - - -
    - diff --git a/reference/mqseries/functions/mqseries-inq.xml b/reference/mqseries/functions/mqseries-inq.xml deleted file mode 100644 index 77b9262f642d..000000000000 --- a/reference/mqseries/functions/mqseries-inq.xml +++ /dev/null @@ -1,179 +0,0 @@ - - - - - mqseries_inq - MQSeries MQINQ - - - - &reftitle.description; - - voidmqseries_inq - resourcehconn - resourcehobj - intselectorCount - arrayselectors - intintAttrCount - resourceintAttr - intcharAttrLength - resourcecharAttr - resourcecompCode - resourcereason - - - The - mqseries_inq - (MQINQ) call returns an array of integers and a set of character strings - containing the attributes of an object. - - - - - &reftitle.parameters; - - - - hConn - - - Connection handle. - This handle represents the connection to the queue manager. - - - - - hObj - - - Object handle. - This handle represents the object to be used. - - - - - selectorCount - - - Count of selectors. - - - - - selectors - - - Array of attribute selectors. - - - - - intAttrLength - - - Count of integer attributes. - - - - - intAttr - - - Array of integer attributes. - - - - - charAttrLength - - - Length of character attributes buffer. - - - - - charAttr - - - Character attributes. - - - - - compCode - - - Completion code. - - - - - reason - - - Reason code qualifying the compCode. - - - - - - - &reftitle.returnvalues; - &return.void; - - - - &reftitle.examples; - - - <function>mqseries_inq</function> - example - - -\n", $comp_code, $reason, mqseries_strerror($reason)); - } else { - echo "INQ QManager name result ".$char_attr."
    \n"; - } -?> -]]> -
    -
    -
    - - - &reftitle.seealso; - - mqseries_conn - mqseries_connx - mqseries_open - - -
    - diff --git a/reference/mqseries/functions/mqseries-open.xml b/reference/mqseries/functions/mqseries-open.xml deleted file mode 100644 index 1f43c7a59cc2..000000000000 --- a/reference/mqseries/functions/mqseries-open.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - mqseries_open - MQSeries MQOPEN - - - - &reftitle.description; - - voidmqseries_open - resourcehconn - arrayobjDesc - intoption - resourcehobj - resourcecompCode - resourcereason - - - The - mqseries_open - (MQOPEN) call establishes access to an object. - - - - - &reftitle.parameters; - - - - hConn - - - Connection handle. - This handle represents the connection to the queue manager. - - - - - objDesc - - - Object descriptor. (MQOD) - - - - - options - - - Options that control the action of the function. - - - - - hObj - - - Object handle. - This handle represents the object to be used. - - - - - compCode - - - Completion code. - - - - - reason - - - Reason code qualifying the compCode. - - - - - - - &reftitle.returnvalues; - &return.void; - - - - &reftitle.examples; - - - <function>mqseries_open</function> - example - - - 'TESTQ'); - mqseries_open( - $conn, - $mqods, - MQSERIES_MQOO_INPUT_AS_Q_DEF | MQSERIES_MQOO_FAIL_IF_QUIESCING | MQSERIES_MQOO_OUTPUT, - $obj, - $comp_code, - $reason); - if ($comp_code !== MQSERIES_MQCC_OK) { - printf("open CompCode:%d Reason:%d Text:%s
    \n", $comp_code, $reason, mqseries_strerror($reason)); - exit; - } -?> -]]> -
    -
    -
    - - - &reftitle.seealso; - - mqseries_close - - -
    - diff --git a/reference/mqseries/functions/mqseries-put.xml b/reference/mqseries/functions/mqseries-put.xml deleted file mode 100644 index 72ee5ca457bd..000000000000 --- a/reference/mqseries/functions/mqseries-put.xml +++ /dev/null @@ -1,183 +0,0 @@ - - - - - mqseries_put - MQSeries MQPUT - - - - &reftitle.description; - - voidmqseries_put - resourcehConn - resourcehObj - arraymd - arraypmo - stringmessage - resourcecompCode - resourcereason - - - The - mqseries_put - (MQPUT) call puts a message on a queue or distribution list. The queue or - distribution list must already be open. - - - - - &reftitle.parameters; - - - - hConn - - - Connection handle. - This handle represents the connection to the queue manager. - - - - - hObj - - - Object handle. - This handle represents the object to be used. - - - - - md - - - Message descriptor (MQMD). - - - - - pmo - - - Put message options (MQPMO). - - - - - message - - - The actual message to put onto the queue. - - - - - compCode - - - Completion code. - - - - - reason - - - Reason code qualifying the compCode. - - - - - - - &reftitle.returnvalues; - &return.void; - - - - &reftitle.examples; - - - <function>mqseries_put</function> - example - - - 'TESTQ'), - MQSERIES_MQOO_INPUT_AS_Q_DEF | MQSERIES_MQOO_FAIL_IF_QUIESCING | MQSERIES_MQOO_OUTPUT, - $obj, - $comp_code, - $reason); -// $obj now holds the reference to the object (TESTQ) - -// setup the message descriptor array. Check MQSeries reference manuals. - $md = array( - 'Version' => MQSERIES_MQMD_VERSION_1, - 'Expiry' => MQSERIES_MQEI_UNLIMITED, - 'Report' => MQSERIES_MQRO_NONE, - 'MsgType' => MQSERIES_MQMT_DATAGRAM, - 'Format' => MQSERIES_MQFMT_STRING, - 'Priority' => 1, - 'Persistence' => MQSERIES_MQPER_PERSISTENT); - -// setup the put message options. - $pmo = array('Options' => MQSERIES_MQPMO_NEW_MSG_ID|MQSERIES_MQPMO_SYNCPOINT); - -// put the message 'Ping' on the queueu. - mqseries_put($conn, $obj, $md, $pmo, 'Ping', $comp_code, $reason); - - if ($comp_code !== MQSERIES_MQCC_OK) { - printf("put CompCode:%d Reason:%d Text:%s
    \n", $comp_code, $reason, mqseries_strerror($reason)); - } - -// close the object reference $obj - mqseries_close($conn, $obj, MQSERIES_MQCO_NONE, $comp_code, $reason); - -// disconnect from the queue manager. - mqseries_disc($conn, $comp_code, $reason); - -?> -]]> -
    -
    -
    - - - &reftitle.seealso; - - mqseries_conn - mqseries_connx - mqseries_open - mqseries_get - - -
    - diff --git a/reference/mqseries/functions/mqseries-put1.xml b/reference/mqseries/functions/mqseries-put1.xml deleted file mode 100644 index a6c47f9f5107..000000000000 --- a/reference/mqseries/functions/mqseries-put1.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - mqseries_put1 - MQSeries MQPUT1 - - - - &reftitle.description; - - voidmqseries_put1 - resourcehconn - resourceobjDesc - resourcemsgDesc - resourcepmo - stringbuffer - resourcecompCode - resourcereason - - - The - mqseries_put1 - (MQPUT1) call puts one message on a queue. The queue need not be open. - - - You can use both the mqseries_put and mqseries_put1 - calls to put messages on a queue; which call to use depends on the circumstances. - Use the mqseries_put (MQPUT) call to place multiple messages on the same queue. - Use the mqseries_put1 (MQPUT1) call to put only one message on a queue. - This call encapsulates the MQOPEN, MQPUT, and MQCLOSE calls into a single call, minimizing the - number of calls that must be issued. - - - - - &reftitle.parameters; - - - - hConn - - - Connection handle. - This handle represents the connection to the queue manager. - - - - - objDesc - - - Object descriptor. (MQOD) - - This is a structure which identifies the queue to which the message is - added. - - - - - - msgDesc - - - Message descriptor (MQMD). - - - - - pmo - - - Put message options (MQPMO). - - - - - - compCode - - - Completion code. - - - - - reason - - - Reason code qualifying the compCode. - - - - - - - &reftitle.returnvalues; - &return.void; - - - - &reftitle.seealso; - - mqseries_conn - mqseries_connx - mqseries_open - mqseries_get - - - - diff --git a/reference/mqseries/functions/mqseries-set.xml b/reference/mqseries/functions/mqseries-set.xml deleted file mode 100644 index a5900ff99a92..000000000000 --- a/reference/mqseries/functions/mqseries-set.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - mqseries_set - MQSeries MQSET - - - - &reftitle.description; - - voidmqseries_set - resourcehConn - resourcehObj - intselectorCount - arrayselectors - intintAttrCount - arrayintAttrs - intcharAttrLength - arraycharAttrs - resourcecompCode - resourcereason - - - The mqseries_set - (MQSET) call is used to change the attributes of an object represented by a - handle. The object must be a queue. - - - - - &reftitle.parameters; - - - - hConn - - - Connection handle. - This handle represents the connection to the queue manager. - - - - - hObj - - - Object handle. - This handle represents the object to be used. - - - - - selectorCount - - - Count of selectors. - - - - - selectors - - - Array of attribute selectors. - - - - - intAttrCount - - - Count of integer attributes. - - - - - intAttrs - - - Array of integer attributes. - - - - - charAttrLength - - - Length of character attributes buffer. - - - - - charAttrs - - - Character attributes. - - - - - compCode - - - Completion code. - - - - - reason - - - Reason code qualifying the compCode. - - - - - - - &reftitle.returnvalues; - &return.void; - - - - &reftitle.seealso; - - mqseries_inq - - - - diff --git a/reference/mqseries/functions/mqseries-strerror.xml b/reference/mqseries/functions/mqseries-strerror.xml deleted file mode 100644 index 1645acbc57b2..000000000000 --- a/reference/mqseries/functions/mqseries-strerror.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - mqseries_strerror - Returns the error message corresponding to a result code (MQRC) - - - - &reftitle.description; - - stringmqseries_strerror - intreason - - - mqseries_strerror - returns the message that correspond to the reason result code. - - - - - &reftitle.parameters; - - - - reason - - - Reason code qualifying the compCode. - - - - - - - &reftitle.returnvalues; - string representation of the reason code message. - - - - &reftitle.examples; - - - <function>mqseries_strerror</function> - example - - -\n", $comp_code, $reason, mqseries_strerror($reason)); - exit; - } -?> -]]> - - &example.outputs; - - - - - - - diff --git a/reference/mqseries/ini.xml b/reference/mqseries/ini.xml deleted file mode 100644 index f05a114a9259..000000000000 --- a/reference/mqseries/ini.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - -
    - &reftitle.runtime; - &extension.runtime; - &no.config; -
    - - diff --git a/reference/mqseries/reference.xml b/reference/mqseries/reference.xml deleted file mode 100644 index d0e11e270a11..000000000000 --- a/reference/mqseries/reference.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - mqseries &Functions; - &reference.mqseries.entities.functions; - - - - diff --git a/reference/mqseries/resources.xml b/reference/mqseries/resources.xml deleted file mode 100644 index 044e029406a8..000000000000 --- a/reference/mqseries/resources.xml +++ /dev/null @@ -1,35 +0,0 @@ - - -
    - &reftitle.resources; - - This extension defines a connection and object_handle resources. - - - The mqseries_conn and mqseries_connx define the - connectionn handles. - - - The mqseries_open defines the object handle. - -
    - diff --git a/reference/mqseries/setup.xml b/reference/mqseries/setup.xml deleted file mode 100644 index 44bcc7a67c9b..000000000000 --- a/reference/mqseries/setup.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - &reftitle.setup; - - -
    - &reftitle.required; - - A working IBM WebSphere MQ installation. If building the extension the SDK - for IBM WebSphere MQ is also required. - - - - Be aware that when running against a IBM WebSphere MQ Client installation - some methods are not available. This is not a problem of the extension but - just the way the WebSphere MQ Client Interface works. - - - -
    - - - - &reference.mqseries.configure; - - - - &reference.mqseries.ini; - - - - &reference.mqseries.resources; - - -
    - - - diff --git a/reference/mqseries/versions.xml b/reference/mqseries/versions.xml deleted file mode 100644 index a432e4949e42..000000000000 --- a/reference/mqseries/versions.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/mysql/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/mysql/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/mysql/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/mysql/book.xml b/reference/mysql/book.xml deleted file mode 100644 index 6cece2f2bd61..000000000000 --- a/reference/mysql/book.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - Original MySQL API - MySQL (Original) - - - - &reftitle.intro; - - This extension is deprecated as of PHP 5.5.0, and - has been removed as of PHP 7.0.0. Instead, either the - mysqli or - PDO_MySQL extension should be - used. See also the MySQL API - Overview for further help while choosing a MySQL API. - - - These functions allow you to access MySQL database servers. - More information about MySQL can be found at &url.mysql;. - - - Documentation for MySQL can be found at &url.mysql.docs;. - - - - - &reference.mysql.setup; - &reference.mysql.changelog; - &reference.mysql.constants; - &reference.mysql.examples; - &reference.mysql.reference; - - - diff --git a/reference/mysql/changelog.xml b/reference/mysql/changelog.xml deleted file mode 100644 index 8e273d15f075..000000000000 --- a/reference/mysql/changelog.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - &ChangelogListingTitle; - &ChangelogListingDescription; - - - General Changelog for the ext/mysql extension - - This changelog references the ext/mysql extension. - - - - - Global ext/mysql changes - - The following is a list of changes to the entire ext/mysql extension. - - - - - - &Version; - &Description; - - - - - 7.0.0 - - - This extension was removed from PHP. For details, see - . - - - - - - - - - - Changes to existing functions - - The following list is a compilation of changelog entries from - the ext/mysql functions. - - - - - - diff --git a/reference/mysql/configure.xml b/reference/mysql/configure.xml deleted file mode 100644 index 10fe32acb109..000000000000 --- a/reference/mysql/configure.xml +++ /dev/null @@ -1,165 +0,0 @@ - - -
    - &reftitle.install; - - - &mysql.alternative.note; - - - - For compiling, simply use the - - configuration option where the optional [DIR] points to - the MySQL installation directory. - - - Although this MySQL extension is compatible with MySQL 4.1.0 and greater, - it doesn't support the extra functionality that these versions provide. - For that, use the MySQLi extension. - - - If you would like to install the mysql extension along with the mysqli extension - you have to use the same client library to avoid any conflicts. - - -
    - Installation on Linux Systems - - Note: [DIR] is the path to the MySQL client library - files (headers and libraries), which can be downloaded from - MySQL. - - - ext/mysql compile time support matrix - - - - PHP &Version; - &Default; - &ConfigureOptions;: mysqlnd - &ConfigureOptions;: libmysqlclient - &Changelog; - - - - - 4.x.x - libmysqlclient - &NotAvailable; - to disable - MySQL enabled by default, MySQL client libraries are bundled - - - 5.0.x, 5.1.x, 5.2.x - libmysqlclient - &NotAvailable; - - - MySQL is no longer enabled by default, and the MySQL client libraries - are no longer bundled - - - - 5.3.x - libmysqlclient - - - mysqlnd is now available - - - 5.4.x - mysqlnd - - - mysqlnd is now the default - - - -
    -
    - -
    - Installation on Windows Systems -
    - PHP 5.0.x, 5.1.x, 5.2.x - - MySQL is no longer enabled by default, so the - php_mysql.dll DLL must be enabled inside of - &php.ini;. Also, PHP needs access to the MySQL client library. A file - named libmysql.dll is included in the Windows PHP - distribution and in order for PHP to talk to MySQL this file needs to be - available to the Windows systems PATH. See the FAQ - titled "How do I add my PHP - directory to the PATH on Windows" for information on how to do - this. Although copying libmysql.dll to the Windows - system directory also works (because the system directory is by default in - the system's PATH), it's not recommended. - - - As with enabling any PHP extension (such as - php_mysql.dll), the PHP directive - extension_dir should be set to - the directory where the PHP extensions are located. See also the - Manual Windows Installation - Instructions. An example extension_dir value for PHP 5 is - c:\php\ext - - - - If when starting the web server an error similar to the following occurs: - "Unable to load dynamic library './php_mysql.dll'", - this is because php_mysql.dll and/or - libmysql.dll cannot be found by the system. - - -
    -
    - PHP 5.3.0+ - - The MySQL Native Driver is enabled by - default. Include php_mysql.dll, but libmysql.dll - is no longer required or used. - -
    -
    - -
    - MySQL Installation Notes - - - Crashes and startup problems of PHP may be encountered - when loading this extension in conjunction with the recode extension. - See the recode extension for more - information. - - - - - If you need charsets other than latin (default), you - have to install external (not bundled) libmysqlclient with compiled charset - support. - - -
    -
    - diff --git a/reference/mysql/constants.xml b/reference/mysql/constants.xml deleted file mode 100644 index 579929bb71bb..000000000000 --- a/reference/mysql/constants.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - &reftitle.constants; - &extension.constants; - - It is possible to specify additional client flags for the - mysql_connect and mysql_pconnect - functions. The following constants are defined: - - MySQL client constants - - - - Constant - Description - - - - - MYSQL_CLIENT_COMPRESS - Use compression protocol - - - MYSQL_CLIENT_IGNORE_SPACE - Allow space after function names - - - MYSQL_CLIENT_INTERACTIVE - Allow interactive_timeout seconds (instead of ) of - inactivity before closing the connection. - - - MYSQL_CLIENT_SSL - Use SSL encryption. This flag is only available with version 4.x - of the MySQL client library or newer. Version 3.23.x is bundled both - with PHP 4 and Windows binaries of PHP 5. - - - - -
    -
    - - - The function mysql_fetch_array uses a constant for - the different types of result arrays. The following constants are - defined: - - MySQL fetch constants - - - - Constant - Description - - - - - MYSQL_ASSOC - - Columns are returned into the array having the fieldname as the array - index. - - - - MYSQL_BOTH - - Columns are returned into the array having both a numerical index - and the fieldname as the array index. - - - - MYSQL_NUM - - Columns are returned into the array having a numerical index to the - fields. This index starts with 0, the first field in the result. - - - - -
    -
    -
    - - diff --git a/reference/mysql/examples.xml b/reference/mysql/examples.xml deleted file mode 100644 index aa7ce8395e1c..000000000000 --- a/reference/mysql/examples.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - &reftitle.examples; -
    - MySQL extension overview example - - This simple example shows how to connect, execute a query, print - resulting rows and disconnect from a MySQL database. - - MySQL extension overview example - -\n"; -while ($line = mysql_fetch_array($result, MYSQL_ASSOC)) { - echo "\t\n"; - foreach ($line as $col_value) { - echo "\t\t$col_value\n"; - } - echo "\t\n"; -} -echo "\n"; - -// Free resultset -mysql_free_result($result); - -// Closing connection -mysql_close($link); -?> -]]> - - - -
    -
    - - - diff --git a/reference/mysql/functions/mysql-affected-rows.xml b/reference/mysql/functions/mysql-affected-rows.xml deleted file mode 100644 index 6422d41bf721..000000000000 --- a/reference/mysql/functions/mysql-affected-rows.xml +++ /dev/null @@ -1,180 +0,0 @@ - - - - - mysql_affected_rows - Get number of affected rows in previous MySQL operation - - - - - &mysql.alternative.note; - - mysqli_affected_rows - PDOStatement::rowCount - - - - - - &reftitle.description; - - intmysql_affected_rows - resourcelink_identifierNULL - - - Get the number of affected rows by the last INSERT, UPDATE, REPLACE - or DELETE query associated with link_identifier. - - - - - &reftitle.parameters; - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - Returns the number of affected rows on success, and -1 if the last query - failed. - - - If the last query was a DELETE query with no WHERE clause, all - of the records will have been deleted from the table but this - function will return zero with MySQL versions prior to 4.1.2. - - - When using UPDATE, MySQL will not update columns where the new value is the - same as the old value. This creates the possibility that - mysql_affected_rows may not actually equal the number - of rows matched, only the number of rows that were literally affected by - the query. - - - The REPLACE statement first deletes the record with the same primary key - and then inserts the new record. This function returns the number of - deleted records plus the number of inserted records. - - - In the case of "INSERT ... ON DUPLICATE KEY UPDATE" queries, the - return value will be 1 if an insert was performed, - or 2 for an update of an existing row. - - - - - &reftitle.examples; - - <function>mysql_affected_rows</function> example - - -]]> - - &example.outputs.similar; - - - - - - <function>mysql_affected_rows</function> example using transactions - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.notes; - - Transactions - - If you are using transactions, you need to call - mysql_affected_rows after your INSERT, UPDATE, or - DELETE query, not after the COMMIT. - - - - SELECT Statements - - To retrieve the number of rows returned by a SELECT, it is possible to - use mysql_num_rows. - - - - Cascaded Foreign Keys - - mysql_affected_rows does not count rows affected - implicitly through the use of ON DELETE CASCADE and/or ON UPDATE CASCADE - in foreign key constraints. - - - - - - &reftitle.seealso; - - mysql_num_rows - mysql_info - - - - diff --git a/reference/mysql/functions/mysql-client-encoding.xml b/reference/mysql/functions/mysql-client-encoding.xml deleted file mode 100644 index 3712a8e5520d..000000000000 --- a/reference/mysql/functions/mysql-client-encoding.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - mysql_client_encoding - Returns the name of the character set - - - - - &mysql.alternative.note; - - mysqli_character_set_name - - - - - - &reftitle.description; - - stringmysql_client_encoding - resourcelink_identifierNULL - - - Retrieves the character_set variable from MySQL. - - - - - &reftitle.parameters; - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - Returns the default character set name for the current connection. - - - - - &reftitle.examples; - - <function>mysql_client_encoding</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - mysql_set_charset - mysql_real_escape_string - - - - diff --git a/reference/mysql/functions/mysql-close.xml b/reference/mysql/functions/mysql-close.xml deleted file mode 100644 index a2501fe0a5df..000000000000 --- a/reference/mysql/functions/mysql-close.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - mysql_close - Close MySQL connection - - - - - &mysql.alternative.note; - - mysqli_close - PDO: Assign the value of &null; to the PDO object - - - - - - &reftitle.description; - - boolmysql_close - resourcelink_identifierNULL - - - mysql_close closes the non-persistent connection to - the MySQL server that's associated with the specified link identifier. If - link_identifier isn't specified, the last opened - link is used. - - &mysql.close.connections.result.sets; - - - - &reftitle.parameters; - - &mysql.linkid-noreopen.description; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>mysql_close</function> example - - -]]> - - &example.outputs; - - - - - - - - &reftitle.notes; - - - mysql_close will not close persistent links - created by mysql_pconnect. - For additional details, see the manual page on - persistent connections. - - - - - - &reftitle.seealso; - - mysql_connect - mysql_free_result - - - - diff --git a/reference/mysql/functions/mysql-connect.xml b/reference/mysql/functions/mysql-connect.xml deleted file mode 100644 index 96858d728168..000000000000 --- a/reference/mysql/functions/mysql-connect.xml +++ /dev/null @@ -1,241 +0,0 @@ - - - - - mysql_connect - Open a connection to a MySQL Server - - - - - &mysql.alternative.note; - - mysqli_connect - PDO::__construct - - - - - - &reftitle.description; - - resourcefalsemysql_connect - stringserverini_get("mysql.default_host") - stringusernameini_get("mysql.default_user") - stringpasswordini_get("mysql.default_password") - boolnew_link&false; - intclient_flags0 - - - Opens or reuses a connection to a MySQL server. - - - - - &reftitle.parameters; - - - server - - - The MySQL server. It can also include a port number. e.g. - "hostname:port" or a path to a local socket e.g. ":/path/to/socket" for - the localhost. - - - If the PHP directive - mysql.default_host is undefined (default), then the default - value is 'localhost:3306'. In &sqlsafemode;, this parameter is ignored - and value 'localhost:3306' is always used. - - - - - username - - - The username. Default value is defined by mysql.default_user. In - &sqlsafemode;, this parameter is ignored and the name of the user that - owns the server process is used. - - - - - password - - - The password. Default value is defined by mysql.default_password. In - &sqlsafemode;, this parameter is ignored and empty password is used. - - - - - new_link - - - If a second call is made to mysql_connect - with the same arguments, no new link will be established, but - instead, the link identifier of the already opened link will be - returned. The new_link parameter modifies this - behavior and makes mysql_connect always open - a new link, even if mysql_connect was called - before with the same parameters. - In &sqlsafemode;, this parameter is ignored. - - - - - client_flags - - - The client_flags parameter can be a combination - of the following constants: - 128 (enable LOAD DATA LOCAL handling), - MYSQL_CLIENT_SSL, - MYSQL_CLIENT_COMPRESS, - MYSQL_CLIENT_IGNORE_SPACE or - MYSQL_CLIENT_INTERACTIVE. - Read the section about for further information. - In &sqlsafemode;, this parameter is ignored. - - - - - - - - &reftitle.returnvalues; - - Returns a MySQL link identifier on success&return.falseforfailure;. - - - - - &reftitle.examples; - - <function>mysql_connect</function> example - - -]]> - - - - <function>mysql_connect</function> example using <literal>hostname:port</literal> syntax - - -]]> - - - - <function>mysql_connect</function> example using ":/path/to/socket" syntax - - -]]> - - - - - - &reftitle.notes; - - - Whenever you specify "localhost" or - "localhost:port" as server, the MySQL client library will - override this and try to connect to a local socket (named pipe on - Windows). If you want to use TCP/IP, use "127.0.0.1" - instead of "localhost". If the MySQL client library tries to - connect to the wrong local socket, the correct path should be set as - mysql.default_host in &php.ini; and the server field - left blank. - - - - - The link to the server will be closed as soon as the execution of - the script ends, unless it's closed earlier by explicitly calling - mysql_close. - - - - - Error "Can't create TCP/IP socket (10106)" usually means that the variables_order configure directive - doesn't contain character E. On Windows, if the - environment is not copied the SYSTEMROOT environment - variable won't be available and PHP will have problems loading Winsock. - - - - - - &reftitle.seealso; - - mysql_pconnect - mysql_close - - - - diff --git a/reference/mysql/functions/mysql-create-db.xml b/reference/mysql/functions/mysql-create-db.xml deleted file mode 100644 index ea11e1fa5692..000000000000 --- a/reference/mysql/functions/mysql-create-db.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - mysql_create_db - Create a MySQL database - - - - - &mysql.alternative.note.4-3-0; - - mysqli_query - PDO::query - - - - - - &reftitle.description; - - boolmysql_create_db - stringdatabase_name - resourcelink_identifierNULL - - - mysql_create_db attempts to create a new - database on the server associated with the specified link - identifier. - - - - - &reftitle.parameters; - - - database_name - - - The name of the database being created. - - - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>mysql_create_db</function> alternative example - - The function mysql_create_db is deprecated. It is - preferable to use mysql_query to issue an sql - CREATE DATABASE statement instead. - - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.notes; - - - &info.deprecated.alias; - mysql_createdb - - - - - This function will not be available if the MySQL extension was built - against a MySQL 4.x client library. - - - - - - &reftitle.seealso; - - mysql_query - mysql_select_db - - - - diff --git a/reference/mysql/functions/mysql-data-seek.xml b/reference/mysql/functions/mysql-data-seek.xml deleted file mode 100644 index 53933ae009ca..000000000000 --- a/reference/mysql/functions/mysql-data-seek.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - mysql_data_seek - Move internal result pointer - - - - - &mysql.alternative.note; - - mysqli_data_seek - PDO::FETCH_ORI_ABS - - - - - - &reftitle.description; - - boolmysql_data_seek - resourceresult - introw_number - - - mysql_data_seek moves the internal row - pointer of the MySQL result associated with the specified result - identifier to point to the specified row number. The next call - to a MySQL fetch function, such as mysql_fetch_assoc, - would return that row. - - - row_number starts at 0. The - row_number should be a value in the range from 0 to - mysql_num_rows - 1. However if the result set - is empty (mysql_num_rows == 0), a seek to 0 will - fail with an E_WARNING and - mysql_data_seek will return &false;. - - - - - &reftitle.parameters; - - &mysql.result.description; - - row_number - - - The desired row number of the new result pointer. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>mysql_data_seek</function> example - -= 0; $i--) { - if (!mysql_data_seek($result, $i)) { - echo "Cannot seek to row $i: " . mysql_error() . "\n"; - continue; - } - - if (!($row = mysql_fetch_assoc($result))) { - continue; - } - - echo $row['last_name'] . ' ' . $row['first_name'] . "
    \n"; -} - -mysql_free_result($result); -?> -]]> -
    -
    -
    - - - &reftitle.notes; - - - The function mysql_data_seek can be used in - conjunction only with mysql_query, not with - mysql_unbuffered_query. - - - - - - &reftitle.seealso; - - mysql_query - mysql_num_rows - mysql_fetch_row - mysql_fetch_assoc - mysql_fetch_array - mysql_fetch_object - - -
    - diff --git a/reference/mysql/functions/mysql-db-name.xml b/reference/mysql/functions/mysql-db-name.xml deleted file mode 100644 index bf06fe0c7f90..000000000000 --- a/reference/mysql/functions/mysql-db-name.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - mysql_db_name - Retrieves database name from the call to mysql_list_dbs - - - - - &mysql.alternative.note; - - Query: SELECT DATABASE() - - - - - - &reftitle.description; - - stringmysql_db_name - resourceresult - introw - mixedfieldNULL - - - Retrieve the database name from a call to - mysql_list_dbs. - - - - - &reftitle.parameters; - - - result - - - The result pointer from a call to mysql_list_dbs. - - - - - row - - - The index into the result set. - - - - - field - - - The field name. - - - - - - - - &reftitle.returnvalues; - - Returns the database name on success, and &false; on failure. If &false; - is returned, use mysql_error to determine the nature - of the error. - - - - - &reftitle.examples; - - <function>mysql_db_name</function> example - - -]]> - - - - - - &reftitle.notes; - - - &info.deprecated.alias; - mysql_dbname - - - - - - &reftitle.seealso; - - mysql_list_dbs - mysql_tablename - - - - diff --git a/reference/mysql/functions/mysql-db-query.xml b/reference/mysql/functions/mysql-db-query.xml deleted file mode 100644 index da49bacfddca..000000000000 --- a/reference/mysql/functions/mysql-db-query.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - mysql_db_query - Selects a database and executes a query on it - - - - - &mysql.alternative.note.5-3-0; - - mysqli_select_db then the query - PDO::__construct - - - - - - &reftitle.description; - - resourceboolmysql_db_query - stringdatabase - stringquery - resourcelink_identifierNULL - - - mysql_db_query selects a database, and executes a - query on it. - - - - - &reftitle.parameters; - - - database - - - The name of the database that will be selected. - - - - - query - - - The MySQL query. - - - Data inside the query should be properly escaped. - - - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - Returns a positive MySQL result resource to the query result, - or &false; on error. The function also returns &true;/&false; for - INSERT/UPDATE/DELETE - queries to indicate success/failure. - - - - - &reftitle.examples; - - <function>mysql_db_query</function> alternative example - - -]]> - - - - - - &reftitle.notes; - - - Be aware that this function does NOT - switch back to the database you were connected before. In other words, - you can't use this function to temporarily run a - sql query on another database, you would have to manually switch back. - Users are strongly encouraged to use the - database.table syntax in their sql queries or - mysql_select_db instead of this function. - - - - - - &reftitle.seealso; - - mysql_query - mysql_select_db - - - - diff --git a/reference/mysql/functions/mysql-drop-db.xml b/reference/mysql/functions/mysql-drop-db.xml deleted file mode 100644 index 432ff55c7fc2..000000000000 --- a/reference/mysql/functions/mysql-drop-db.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - mysql_drop_db - Drop (delete) a MySQL database - - - - - &mysql.alternative.note.4-3-0; - - Execute a DROP DATABASE query - - - - - - &reftitle.description; - - boolmysql_drop_db - stringdatabase_name - resourcelink_identifierNULL - - - mysql_drop_db attempts to drop (remove) an - entire database from the server associated with the specified - link identifier. This function is deprecated, it is preferable to use - mysql_query to issue an sql - DROP DATABASE statement instead. - - - - - &reftitle.parameters; - - - database_name - - - The name of the database that will be deleted. - - - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>mysql_drop_db</function> alternative example - - -]]> - - - - - - &reftitle.notes; - - - This function will not be available if the MySQL extension was built - against a MySQL 4.x client library. - - - - - &info.deprecated.alias; - mysql_dropdb - - - - - - &reftitle.seealso; - - mysql_query - - - - diff --git a/reference/mysql/functions/mysql-errno.xml b/reference/mysql/functions/mysql-errno.xml deleted file mode 100644 index 2f0eb7f44746..000000000000 --- a/reference/mysql/functions/mysql-errno.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - mysql_errno - Returns the numerical value of the error message from previous MySQL operation - - - - - &mysql.alternative.note; - - mysqli_errno - PDO::errorCode - - - - - - &reftitle.description; - - intmysql_errno - resourcelink_identifierNULL - - - Returns the error number from the last MySQL function. - - - Errors coming back from the MySQL database backend no longer - issue warnings. Instead, use mysql_errno to - retrieve the error code. Note that this function only returns the - error code from the most recently executed MySQL function (not - including mysql_error and - mysql_errno), so if you want to use it, - make sure you check the value before calling another MySQL - function. - - - - - &reftitle.parameters; - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - Returns the error number from the last MySQL function, or - 0 (zero) if no error occurred. - - - - - &reftitle.examples; - - <function>mysql_errno</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - mysql_error - MySQL error codes - - - - diff --git a/reference/mysql/functions/mysql-error.xml b/reference/mysql/functions/mysql-error.xml deleted file mode 100644 index 20babf41731b..000000000000 --- a/reference/mysql/functions/mysql-error.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - mysql_error - Returns the text of the error message from previous MySQL operation - - - - - &mysql.alternative.note; - - mysqli_error - PDO::errorInfo - - - - - - &reftitle.description; - - stringmysql_error - resourcelink_identifierNULL - - - Returns the error text from the last MySQL function. - Errors coming back from the MySQL database backend no longer - issue warnings. Instead, use mysql_error to - retrieve the error text. Note that this function only returns the - error text from the most recently executed MySQL function (not - including mysql_error and - mysql_errno), so if you want to use it, make - sure you check the value before calling another MySQL function. - - - - - &reftitle.parameters; - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - Returns the error text from the last MySQL function, or - '' (empty string) if no error occurred. - - - - - &reftitle.examples; - - <function>mysql_error</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - mysql_errno - MySQL error codes - - - - diff --git a/reference/mysql/functions/mysql-escape-string.xml b/reference/mysql/functions/mysql-escape-string.xml deleted file mode 100644 index a28322331069..000000000000 --- a/reference/mysql/functions/mysql-escape-string.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - mysql_escape_string - Escapes a string for use in a mysql_query - - - - - &mysql.alternative.note.4-3-0; - - mysqli_escape_string - PDO::quote - - - - - - &reftitle.description; - - stringmysql_escape_string - stringunescaped_string - - - This function will escape the unescaped_string, - so that it is safe to place it in a mysql_query. - This function is deprecated. - - - This function is identical to mysql_real_escape_string - except that mysql_real_escape_string takes a - connection handler and escapes the string according to the current - character set. mysql_escape_string does not take a - connection argument and does not respect the current charset setting. - - - - - &reftitle.parameters; - - - unescaped_string - - - The string that is to be escaped. - - - - - - - - &reftitle.returnvalues; - - Returns the escaped string. - - - - - &reftitle.examples; - - <function>mysql_escape_string</function> example - - -]]> - - &example.outputs; - - - - - - - - &reftitle.notes; - - - mysql_escape_string does not escape - % and _. - - - - - - &reftitle.seealso; - - mysql_real_escape_string - - - - diff --git a/reference/mysql/functions/mysql-fetch-array.xml b/reference/mysql/functions/mysql-fetch-array.xml deleted file mode 100644 index 83bfc1fbaa91..000000000000 --- a/reference/mysql/functions/mysql-fetch-array.xml +++ /dev/null @@ -1,188 +0,0 @@ - - - - - mysql_fetch_array - Fetch a result row as an associative array, a numeric array, or both - - - - - &mysql.alternative.note; - - mysqli_fetch_array - PDOStatement::fetch - - - - - - &reftitle.description; - - arraymysql_fetch_array - resourceresult - intresult_typeMYSQL_BOTH - - - Returns an array that corresponds to the fetched row - and moves the internal data pointer ahead. - - - - - &reftitle.parameters; - - &mysql.result.description; - - result_type - - - The type of array that is to be fetched. It's a constant and can - take the following values: MYSQL_ASSOC, - MYSQL_NUM, and - MYSQL_BOTH. - - - - - - - - &reftitle.returnvalues; - - Returns an array of strings that corresponds to the fetched row, or &false; - if there are no more rows. The type of returned array depends on - how result_type is defined. By using - MYSQL_BOTH (default), you'll get an array with both - associative and number indices. Using MYSQL_ASSOC, you - only get associative indices (as mysql_fetch_assoc - works), using MYSQL_NUM, you only get number indices - (as mysql_fetch_row works). - - - If two or more columns of the result have the same field names, - the last column will take precedence. To access the other column(s) - of the same name, you must use the numeric index of the column or - make an alias for the column. For aliased columns, you cannot - access the contents with the original column name. - - - - - &reftitle.examples; - - Query with aliased duplicate field names - - - - - - <function>mysql_fetch_array</function> with <constant>MYSQL_NUM</constant> - - -]]> - - - - <function>mysql_fetch_array</function> with <constant>MYSQL_ASSOC</constant> - - -]]> - - - - <function>mysql_fetch_array</function> with <constant>MYSQL_BOTH</constant> - - -]]> - - - - - - &reftitle.notes; - - Performance - - An important thing to note is that using - mysql_fetch_array is not - significantly slower than using - mysql_fetch_row, while it provides - a significant added value. - - - &database.field-case; - &database.fetch-null; - - - - &reftitle.seealso; - - mysql_fetch_row - mysql_fetch_assoc - mysql_data_seek - mysql_query - - - - diff --git a/reference/mysql/functions/mysql-fetch-assoc.xml b/reference/mysql/functions/mysql-fetch-assoc.xml deleted file mode 100644 index 12e1868900ad..000000000000 --- a/reference/mysql/functions/mysql-fetch-assoc.xml +++ /dev/null @@ -1,161 +0,0 @@ - - - - - mysql_fetch_assoc - Fetch a result row as an associative array - - - - - &mysql.alternative.note; - - mysqli_fetch_assoc - - PDOStatement::fetch - with mode as PDO::FETCH_ASSOC - - - - - - - &reftitle.description; - - arraymysql_fetch_assoc - resourceresult - - - Returns an associative array that corresponds to the fetched row - and moves the internal data pointer ahead. - mysql_fetch_assoc is equivalent to calling - mysql_fetch_array with MYSQL_ASSOC for the - optional second parameter. It only returns an associative array. - - - - - &reftitle.parameters; - - &mysql.result.description; - - - - - &reftitle.returnvalues; - - Returns an associative array of strings that corresponds to the fetched row, or - &false; if there are no more rows. - - - If two or more columns of the result have the same field names, - the last column will take precedence. To access the other - column(s) of the same name, you either need to access the - result with numeric indices by using - mysql_fetch_row or add alias names. - See the example at the mysql_fetch_array - description about aliases. - - - - - &reftitle.examples; - - An expanded <function>mysql_fetch_assoc</function> example - - -]]> - - - - - - &reftitle.notes; - - Performance - - An important thing to note is that using - mysql_fetch_assoc is not - significantly slower than using - mysql_fetch_row, while it - provides a significant added value. - - - &database.field-case; - &database.fetch-null; - - - - &reftitle.seealso; - - mysql_fetch_row - mysql_fetch_array - mysql_data_seek - mysql_query - mysql_error - - - - diff --git a/reference/mysql/functions/mysql-fetch-field.xml b/reference/mysql/functions/mysql-fetch-field.xml deleted file mode 100644 index 2b00cdba2748..000000000000 --- a/reference/mysql/functions/mysql-fetch-field.xml +++ /dev/null @@ -1,204 +0,0 @@ - - - - - mysql_fetch_field - Get column information from a result and return as an object - - - - - &mysql.alternative.note; - - mysqli_fetch_field - PDOStatement::getColumnMeta - - - - - - &reftitle.description; - - objectmysql_fetch_field - resourceresult - intfield_offset0 - - - Returns an object containing field information. This function can be used - to obtain information about fields in the provided query result. - - - - - &reftitle.parameters; - - &mysql.result.description; - - field_offset - - - The numerical field offset. If the field offset is not specified, the - next field that was not yet retrieved by this function is retrieved. - The field_offset starts at 0. - - - - - - - - &reftitle.returnvalues; - - Returns an object containing field information. The properties - of the object are: - - - - - name - column name - - - - - table - name of the table the column belongs to, which is the alias name if one is defined - - - - - max_length - maximum length of the column - - - - - not_null - 1 if the column cannot be &null; - - - - - primary_key - 1 if the column is a primary key - - - - - unique_key - 1 if the column is a unique key - - - - - multiple_key - 1 if the column is a non-unique key - - - - - numeric - 1 if the column is numeric - - - - - blob - 1 if the column is a BLOB - - - - - type - the type of the column - - - - - unsigned - 1 if the column is unsigned - - - - - zerofill - 1 if the column is zero-filled - - - - - - - &reftitle.examples; - - <function>mysql_fetch_field</function> example - -\n"; - $meta = mysql_fetch_field($result, $i); - if (!$meta) { - echo "No information available
    \n"; - } - echo "
    -blob:         $meta->blob
    -max_length:   $meta->max_length
    -multiple_key: $meta->multiple_key
    -name:         $meta->name
    -not_null:     $meta->not_null
    -numeric:      $meta->numeric
    -primary_key:  $meta->primary_key
    -table:        $meta->table
    -type:         $meta->type
    -unique_key:   $meta->unique_key
    -unsigned:     $meta->unsigned
    -zerofill:     $meta->zerofill
    -
    "; - $i++; -} -mysql_free_result($result); -?> -]]> -
    -
    -
    - - - &reftitle.notes; - &database.field-case; - - - If field or tablenames are aliased in the SQL query the aliased name will - be returned. The original name can be retrieved for instance by using - mysqli_result::fetch_field. - - - - - - &reftitle.seealso; - - mysql_field_seek - - -
    - diff --git a/reference/mysql/functions/mysql-fetch-lengths.xml b/reference/mysql/functions/mysql-fetch-lengths.xml deleted file mode 100644 index d4bd2b46d406..000000000000 --- a/reference/mysql/functions/mysql-fetch-lengths.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - mysql_fetch_lengths - Get the length of each output in a result - - - - - &mysql.alternative.note; - - mysqli_fetch_lengths - PDOStatement::getColumnMeta - - - - - - &reftitle.description; - - arrayfalsemysql_fetch_lengths - resourceresult - - - Returns an array that corresponds to the lengths of each field - in the last row fetched by MySQL. - - - mysql_fetch_lengths stores the lengths of - each result column in the last row returned by - mysql_fetch_row, - mysql_fetch_assoc, - mysql_fetch_array, and - mysql_fetch_object in an array, starting at - offset 0. - - - - - &reftitle.parameters; - - &mysql.result.description; - - - - - &reftitle.returnvalues; - - An array of lengths on success&return.falseforfailure;. - - - - - &reftitle.examples; - - A <function>mysql_fetch_lengths</function> example - - -]]> - - &example.outputs.similar; - - 42 - [email] => user@example.com -) -Array -( - [0] => 2 - [1] => 16 -) -]]> - - - - - - &reftitle.seealso; - - mysql_field_len - mysql_fetch_row - strlen - - - - diff --git a/reference/mysql/functions/mysql-fetch-object.xml b/reference/mysql/functions/mysql-fetch-object.xml deleted file mode 100644 index d118207131a0..000000000000 --- a/reference/mysql/functions/mysql-fetch-object.xml +++ /dev/null @@ -1,163 +0,0 @@ - - - - - mysql_fetch_object - Fetch a result row as an object - - - - - &mysql.alternative.note; - - mysqli_fetch_object - - PDOStatement::fetch - with mode as PDO::FETCH_OBJ - - - - - - - &reftitle.description; - - objectmysql_fetch_object - resourceresult - stringclass_name - arrayparams - - - Returns an object with properties that correspond to the fetched row - and moves the internal data pointer ahead. - - - - - &reftitle.parameters; - - &mysql.result.description; - - class_name - - - The name of the class to instantiate, set the properties of and return. - If not specified, a stdClass object is returned. - - - - - params - - - An optional array of parameters to pass to the constructor - for class_name objects. - - - - - - - - &reftitle.returnvalues; - - Returns an object with string properties that correspond to the - fetched row, or &false; if there are no more rows. - - - - - &reftitle.examples; - - <function>mysql_fetch_object</function> example - -user_id; - echo $row->fullname; -} -mysql_free_result($result); -?> -]]> - - - - <function>mysql_fetch_object</function> example - - -]]> - - - - - - &reftitle.notes; - - Performance - - Speed-wise, the function is identical to - mysql_fetch_array, and almost as quick as - mysql_fetch_row (the difference is - insignificant). - - - - - mysql_fetch_object is similar to - mysql_fetch_array, with one difference - an - object is returned, instead of an array. Indirectly, that means - that you can only access the data by the field names, and not by - their offsets (numbers are illegal property names). - - - &database.field-case; - &database.fetch-null; - - - - &reftitle.seealso; - - mysql_fetch_array - mysql_fetch_assoc - mysql_fetch_row - mysql_data_seek - mysql_query - - - - diff --git a/reference/mysql/functions/mysql-fetch-row.xml b/reference/mysql/functions/mysql-fetch-row.xml deleted file mode 100644 index 3e877a7af507..000000000000 --- a/reference/mysql/functions/mysql-fetch-row.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - mysql_fetch_row - Get a result row as an enumerated array - - - - - &mysql.alternative.note; - - mysqli_fetch_row - - PDOStatement::fetch - with mode as PDO::FETCH_NUM - - - - - - - &reftitle.description; - - arraymysql_fetch_row - resourceresult - - - Returns a numerical array that corresponds to the fetched row - and moves the internal data pointer ahead. - - - - - &reftitle.parameters; - - &mysql.result.description; - - - - - &reftitle.returnvalues; - - Returns an numerical array of strings that corresponds to the fetched row, or - &false; if there are no more rows. - - - mysql_fetch_row fetches one row of data from - the result associated with the specified result identifier. The - row is returned as an array. Each result column is stored in an - array offset, starting at offset 0. - - - - - &reftitle.examples; - - Fetching one row with <function>mysql_fetch_row</function> - - -]]> - - - - - - &reftitle.notes; - &database.fetch-null; - - - - &reftitle.seealso; - - mysql_fetch_array - mysql_fetch_assoc - mysql_fetch_object - mysql_data_seek - mysql_fetch_lengths - mysql_result - - - - diff --git a/reference/mysql/functions/mysql-field-flags.xml b/reference/mysql/functions/mysql-field-flags.xml deleted file mode 100644 index 372861f951a4..000000000000 --- a/reference/mysql/functions/mysql-field-flags.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - mysql_field_flags - Get the flags associated with the specified field in a result - - - - - &mysql.alternative.note; - - mysqli_fetch_field_direct [flags] - PDOStatement::getColumnMeta [flags] - - - - - - &reftitle.description; - - stringfalsemysql_field_flags - resourceresult - intfield_offset - - - mysql_field_flags returns the field flags of - the specified field. The flags are reported as a single word - per flag separated by a single space, so that you can split the - returned value using explode. - - - - - &reftitle.parameters; - - &mysql.result.description; - &mysql.field-offset.req.description; - - - - - &reftitle.returnvalues; - - Returns a string of flags associated with the result&return.falseforfailure;. - - - The following flags are reported, if your version of MySQL - is current enough to support them: "not_null", - "primary_key", "unique_key", - "multiple_key", "blob", - "unsigned", "zerofill", - "binary", "enum", - "auto_increment" and "timestamp". - - - - - &reftitle.examples; - - A <function>mysql_field_flags</function> example - - -]]> - - &example.outputs.similar; - - not_null - [1] => primary_key - [2] => auto_increment -) -]]> - - - - - - &reftitle.notes; - - - &info.deprecated.alias; - mysql_fieldflags - - - - - - &reftitle.seealso; - - mysql_field_type - mysql_field_len - - - - - diff --git a/reference/mysql/functions/mysql-field-len.xml b/reference/mysql/functions/mysql-field-len.xml deleted file mode 100644 index 679d9c9dc78f..000000000000 --- a/reference/mysql/functions/mysql-field-len.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - mysql_field_len - Returns the length of the specified field - - - - - &mysql.alternative.note; - - mysqli_fetch_field_direct [length] - PDOStatement::getColumnMeta [len] - - - - - - &reftitle.description; - - intfalsemysql_field_len - resourceresult - intfield_offset - - - mysql_field_len returns the length of the - specified field. - - - - - &reftitle.parameters; - - &mysql.result.description; - &mysql.field-offset.req.description; - - - - - &reftitle.returnvalues; - - The length of the specified field index on success&return.falseforfailure;. - - - - - &reftitle.examples; - - <function>mysql_field_len</function> example - - -]]> - - - - - - &reftitle.notes; - - - &info.deprecated.alias; - mysql_fieldlen - - - - - - &reftitle.seealso; - - mysql_fetch_lengths - strlen - - - - diff --git a/reference/mysql/functions/mysql-field-name.xml b/reference/mysql/functions/mysql-field-name.xml deleted file mode 100644 index 9d23f5bca98c..000000000000 --- a/reference/mysql/functions/mysql-field-name.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - mysql_field_name - Get the name of the specified field in a result - - - - - &mysql.alternative.note; - - mysqli_fetch_field_direct [name] or [orgname] - PDOStatement::getColumnMeta [name] - - - - - - &reftitle.description; - - stringfalsemysql_field_name - resourceresult - intfield_offset - - - mysql_field_name returns the name of the - specified field index. - - - - - &reftitle.parameters; - - &mysql.result.description; - &mysql.field-offset.req.description; - - - - - &reftitle.returnvalues; - - The name of the specified field index on success&return.falseforfailure;. - - - - - &reftitle.examples; - - <function>mysql_field_name</function> example - - -]]> - - &example.outputs; - - - - - - - - &reftitle.notes; - &database.field-case; - - - &info.deprecated.alias; - mysql_fieldname - - - - - - &reftitle.seealso; - - mysql_field_type - mysql_field_len - - - - - diff --git a/reference/mysql/functions/mysql-field-seek.xml b/reference/mysql/functions/mysql-field-seek.xml deleted file mode 100644 index c1cb581b4455..000000000000 --- a/reference/mysql/functions/mysql-field-seek.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - mysql_field_seek - Set result pointer to a specified field offset - - - - - &mysql.alternative.note; - - mysqli_field_seek - - PDOStatement::fetch using the - cursor_orientation and - offset parameters - - - - - - - &reftitle.description; - - boolmysql_field_seek - resourceresult - intfield_offset - - - Seeks to the specified field offset. If the next call to - mysql_fetch_field doesn't include a field - offset, the field offset specified in - mysql_field_seek will be returned. - - - - - &reftitle.parameters; - - &mysql.result.description; - &mysql.field-offset.req.description; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - mysql_fetch_field - - - - diff --git a/reference/mysql/functions/mysql-field-table.xml b/reference/mysql/functions/mysql-field-table.xml deleted file mode 100644 index 8c256f2aeb9d..000000000000 --- a/reference/mysql/functions/mysql-field-table.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - mysql_field_table - Get name of the table the specified field is in - - - - - &mysql.alternative.note; - - mysqli_fetch_field_direct [table] or [orgtable] - PDOStatement::getColumnMeta [table] - - - - - - &reftitle.description; - - stringmysql_field_table - resourceresult - intfield_offset - - - Returns the name of the table that the specified field is in. - - - - - &reftitle.parameters; - - &mysql.result.description; - &mysql.field-offset.req.description; - - - - - &reftitle.returnvalues; - - The name of the table on success. - - - - - &reftitle.examples; - - A <function>mysql_field_table</function> example - - -]]> - - - - - - &reftitle.notes; - - - &info.deprecated.alias; - mysql_fieldtable - - - - - - &reftitle.seealso; - - mysql_list_tables - - - - diff --git a/reference/mysql/functions/mysql-field-type.xml b/reference/mysql/functions/mysql-field-type.xml deleted file mode 100644 index 7578758f02c5..000000000000 --- a/reference/mysql/functions/mysql-field-type.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - mysql_field_type - Get the type of the specified field in a result - - - - - &mysql.alternative.note; - - mysqli_fetch_field_direct [type] - PDOStatement::getColumnMeta [driver:decl_type] or [pdo_type] - - - - - - &reftitle.description; - - stringmysql_field_type - resourceresult - intfield_offset - - - mysql_field_type is similar to the - mysql_field_name function. The arguments are - identical, but the field type is returned instead. - - - - - &reftitle.parameters; - - &mysql.result.description; - &mysql.field-offset.req.description; - - - - - &reftitle.returnvalues; - - The returned field type - will be one of "int", "real", - "string", "blob", and others as - detailed in the MySQL - documentation. - - - - - &reftitle.examples; - - <function>mysql_field_type</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.notes; - - - &info.deprecated.alias; - mysql_fieldtype - - - - - - &reftitle.seealso; - - mysql_field_name - mysql_field_len - - - - - diff --git a/reference/mysql/functions/mysql-free-result.xml b/reference/mysql/functions/mysql-free-result.xml deleted file mode 100644 index 575915e688a3..000000000000 --- a/reference/mysql/functions/mysql-free-result.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - mysql_free_result - Free result memory - - - - - &mysql.alternative.note; - - mysqli_free_result - Assign the value of &null; to the PDO object, or PDOStatement::closeCursor - - - - - - &reftitle.description; - - boolmysql_free_result - resourceresult - - - mysql_free_result will free all memory - associated with the result identifier result. - - - mysql_free_result only needs to be called if - you are concerned about how much memory is being used for queries - that return large result sets. All associated result memory is - automatically freed at the end of the script's execution. - - - - - &reftitle.parameters; - - &mysql.result.description; - - - - - &reftitle.returnvalues; - - &return.success; - - - If a non-resource is used for the result, an - error of level E_WARNING will be emitted. It's worth noting that - mysql_query only returns a resource - for SELECT, SHOW, EXPLAIN, and DESCRIBE queries. - - - - - &reftitle.examples; - - A <function>mysql_free_result</function> example - - -]]> - - - - - - &reftitle.notes; - - - &info.deprecated.alias; - mysql_freeresult - - - - - - &reftitle.seealso; - - mysql_query - is_resource - - - - diff --git a/reference/mysql/functions/mysql-get-client-info.xml b/reference/mysql/functions/mysql-get-client-info.xml deleted file mode 100644 index 286d34421bb6..000000000000 --- a/reference/mysql/functions/mysql-get-client-info.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - mysql_get_client_info - Get MySQL client info - - - - - &mysql.alternative.note; - - mysqli_get_client_info - - PDO::getAttribute - with attribute as PDO::ATTR_CLIENT_VERSION - - - - - - - &reftitle.description; - - stringmysql_get_client_info - - - - mysql_get_client_info returns a string that - represents the client library version. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The MySQL client version. - - - - - &reftitle.examples; - - <function>mysql_get_client_info</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - mysql_get_host_info - mysql_get_proto_info - mysql_get_server_info - - - - diff --git a/reference/mysql/functions/mysql-get-host-info.xml b/reference/mysql/functions/mysql-get-host-info.xml deleted file mode 100644 index 802c0d131f83..000000000000 --- a/reference/mysql/functions/mysql-get-host-info.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - mysql_get_host_info - Get MySQL host info - - - - - &mysql.alternative.note; - - mysqli_get_host_info - - PDO::getAttribute - with attribute as PDO::ATTR_CONNECTION_STATUS - - - - - - - &reftitle.description; - - stringfalsemysql_get_host_info - resourcelink_identifierNULL - - - Describes the type of connection in use for the connection, including the - server host name. - - - - - &reftitle.parameters; - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - Returns a string describing the type of MySQL connection in use for the - connection&return.falseforfailure;. - - - - - &reftitle.examples; - - <function>mysql_get_host_info</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - mysql_get_client_info - mysql_get_proto_info - mysql_get_server_info - - - - diff --git a/reference/mysql/functions/mysql-get-proto-info.xml b/reference/mysql/functions/mysql-get-proto-info.xml deleted file mode 100644 index 44b04b3abb80..000000000000 --- a/reference/mysql/functions/mysql-get-proto-info.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - mysql_get_proto_info - Get MySQL protocol info - - - - - &mysql.alternative.note; - - mysqli_get_proto_info - - - - - - &reftitle.description; - - intfalsemysql_get_proto_info - resourcelink_identifierNULL - - - Retrieves the MySQL protocol. - - - - - &reftitle.parameters; - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - Returns the MySQL protocol on success&return.falseforfailure;. - - - - - &reftitle.examples; - - <function>mysql_get_proto_info</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - mysql_get_client_info - mysql_get_host_info - mysql_get_server_info - - - - diff --git a/reference/mysql/functions/mysql-get-server-info.xml b/reference/mysql/functions/mysql-get-server-info.xml deleted file mode 100644 index 13e34b52584e..000000000000 --- a/reference/mysql/functions/mysql-get-server-info.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - mysql_get_server_info - Get MySQL server info - - - - - &mysql.alternative.note; - - mysqli_get_server_info - - PDO::getAttribute - with attribute as PDO::ATTR_SERVER_VERSION - - - - - - - &reftitle.description; - - stringfalsemysql_get_server_info - resourcelink_identifierNULL - - - Retrieves the MySQL server version. - - - - - &reftitle.parameters; - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - Returns the MySQL server version on success&return.falseforfailure;. - - - - - &reftitle.examples; - - <function>mysql_get_server_info</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - mysql_get_client_info - mysql_get_host_info - mysql_get_proto_info - phpversion - - - - diff --git a/reference/mysql/functions/mysql-info.xml b/reference/mysql/functions/mysql-info.xml deleted file mode 100644 index 76796bd66943..000000000000 --- a/reference/mysql/functions/mysql-info.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - mysql_info - Get information about the most recent query - - - - - &mysql.alternative.note; - - mysqli_info - - - - - - &reftitle.description; - - stringmysql_info - resourcelink_identifierNULL - - - Returns detailed information about the last query. - - - - - &reftitle.parameters; - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - Returns information about the statement on success, or &false; on - failure. See the example below for which statements provide information, - and what the returned value may look like. Statements that are not listed - will return &false;. - - - - - &reftitle.examples; - - Relevant MySQL Statements - - Statements that return string values. The numbers are only for - illustrating purpose; their values will correspond to the query. - - - - - - - - - &reftitle.notes; - - - mysql_info returns a non-&false; value for the - INSERT ... VALUES statement only if multiple value lists are - specified in the statement. - - - - - - &reftitle.seealso; - - mysql_affected_rows - mysql_insert_id - mysql_stat - - - - diff --git a/reference/mysql/functions/mysql-insert-id.xml b/reference/mysql/functions/mysql-insert-id.xml deleted file mode 100644 index cccbeeda8dc0..000000000000 --- a/reference/mysql/functions/mysql-insert-id.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - mysql_insert_id - Get the ID generated in the last query - - - - - &mysql.alternative.note; - - mysqli_insert_id - PDO::lastInsertId - - - - - - &reftitle.description; - - intmysql_insert_id - resourcelink_identifierNULL - - - Retrieves the ID generated for an AUTO_INCREMENT column by the previous - query (usually INSERT). - - - - - &reftitle.parameters; - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - The ID generated for an AUTO_INCREMENT column by the previous - query on success, 0 if the previous - query does not generate an AUTO_INCREMENT value, or &false; if - no MySQL connection was established. - - - - - &reftitle.examples; - - <function>mysql_insert_id</function> example - - -]]> - - - - - - &reftitle.notes; - - - mysql_insert_id will convert the return type of the - native MySQL C API function mysql_insert_id() to a type - of long (named int in PHP). If your - AUTO_INCREMENT column has a column type of BIGINT (64 bits) the - conversion may result in an incorrect value. Instead, use the internal - MySQL SQL function LAST_INSERT_ID() in an SQL query. For more information - about PHP's maximum integer values, please see the - integer documentation. - - - - - Because mysql_insert_id acts on the last performed - query, be sure to call mysql_insert_id immediately - after the query that generates the value. - - - - - The value of the MySQL SQL function - LAST_INSERT_ID() always contains the most - recently generated AUTO_INCREMENT value, and is not reset - between queries. - - - - - - &reftitle.seealso; - - mysql_query - mysql_info - - - - diff --git a/reference/mysql/functions/mysql-list-dbs.xml b/reference/mysql/functions/mysql-list-dbs.xml deleted file mode 100644 index 595dc27a89d9..000000000000 --- a/reference/mysql/functions/mysql-list-dbs.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - mysql_list_dbs - List databases available on a MySQL server - - - - - &mysql.alternative.note.5-4-0; - - SQL Query: SHOW DATABASES - - - - - - &reftitle.description; - - resourcemysql_list_dbs - resourcelink_identifierNULL - - - Returns a result pointer containing the databases available from the - current mysql daemon. - - - - - &reftitle.parameters; - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - Returns a result pointer resource on success, or &false; on - failure. Use the mysql_tablename function to traverse - this result pointer, or any function for result tables, such as - mysql_fetch_array. - - - - - &reftitle.examples; - - <function>mysql_list_dbs</function> example - -Database . "\n"; -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.notes; - - - &info.deprecated.alias; - mysql_listdbs - - - - - - &reftitle.seealso; - - mysql_db_name - mysql_select_db - - - - diff --git a/reference/mysql/functions/mysql-list-fields.xml b/reference/mysql/functions/mysql-list-fields.xml deleted file mode 100644 index a9a3b736c143..000000000000 --- a/reference/mysql/functions/mysql-list-fields.xml +++ /dev/null @@ -1,156 +0,0 @@ - - - - - mysql_list_fields - List MySQL table fields - - - - - &mysql.alternative.note.5-4-0; - - SQL Query: SHOW COLUMNS FROM sometable - - - - - - &reftitle.description; - - resourcemysql_list_fields - stringdatabase_name - stringtable_name - resourcelink_identifierNULL - - - Retrieves information about the given table name. - - - This function is deprecated. It is preferable to use - mysql_query to issue an SQL SHOW COLUMNS FROM - table [LIKE 'name'] statement instead. - - - - - &reftitle.parameters; - - - database_name - - - The name of the database that's being queried. - - - - - table_name - - - The name of the table that's being queried. - - - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - A result pointer resource on success, or &false; on - failure. - - - The returned result can be used with mysql_field_flags, - mysql_field_len, - mysql_field_name&listendand; - mysql_field_type. - - - - - &reftitle.examples; - - Alternate to deprecated <function>mysql_list_fields</function> - - 0) { - while ($row = mysql_fetch_assoc($result)) { - print_r($row); - } -} -?> -]]> - - &example.outputs.similar; - - id - [Type] => int(7) - [Null] => - [Key] => PRI - [Default] => - [Extra] => auto_increment -) -Array -( - [Field] => email - [Type] => varchar(100) - [Null] => - [Key] => - [Default] => - [Extra] => -) -]]> - - - - - - &reftitle.notes; - - - &info.deprecated.alias; - mysql_listfields - - - - - - &reftitle.seealso; - - mysql_field_flags - mysql_info - - - - diff --git a/reference/mysql/functions/mysql-list-processes.xml b/reference/mysql/functions/mysql-list-processes.xml deleted file mode 100644 index ef91dfdb2cf2..000000000000 --- a/reference/mysql/functions/mysql-list-processes.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - mysql_list_processes - List MySQL processes - - - - - &mysql.alternative.note; - - mysqli_thread_id - - - - - - &reftitle.description; - - resourcefalsemysql_list_processes - resourcelink_identifierNULL - - - Retrieves the current MySQL server threads. - - - - - &reftitle.parameters; - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - A result pointer resource on success&return.falseforfailure;. - - - - - &reftitle.examples; - - <function>mysql_list_processes</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - mysql_thread_id - mysql_stat - - - - diff --git a/reference/mysql/functions/mysql-list-tables.xml b/reference/mysql/functions/mysql-list-tables.xml deleted file mode 100644 index 36798fd5d7ce..000000000000 --- a/reference/mysql/functions/mysql-list-tables.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - mysql_list_tables - List tables in a MySQL database - - - - - &mysql.alternative.note.4-3-0; - - SQL Query: SHOW TABLES FROM dbname - - - - - - &reftitle.description; - - resourcefalsemysql_list_tables - stringdatabase - resourcelink_identifierNULL - - - Retrieves a list of table names from a MySQL database. - - - This function is deprecated. It is preferable to use - mysql_query to issue an SQL SHOW TABLES - [FROM db_name] [LIKE 'pattern'] statement instead. - - - - - &reftitle.parameters; - - - database - - - The name of the database - - - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - A result pointer resource on success&return.falseforfailure;. - - - Use the mysql_tablename function to - traverse this result pointer, or any function for result tables, - such as mysql_fetch_array. - - - - - &reftitle.examples; - - <function>mysql_list_tables</function> alternative example - - -]]> - - - - - - &reftitle.notes; - - - &info.deprecated.alias; - mysql_listtables - - - - - - &reftitle.seealso; - - mysql_list_dbs - mysql_tablename - - - - diff --git a/reference/mysql/functions/mysql-num-fields.xml b/reference/mysql/functions/mysql-num-fields.xml deleted file mode 100644 index c525e0d6a0e5..000000000000 --- a/reference/mysql/functions/mysql-num-fields.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - mysql_num_fields - Get number of fields in result - - - - - &mysql.alternative.note; - - mysqli_num_fields - PDOStatement::columnCount - - - - - - &reftitle.description; - - intfalsemysql_num_fields - resourceresult - - - Retrieves the number of fields from a query. - - - - - &reftitle.parameters; - - &mysql.result.description; - - - - - &reftitle.returnvalues; - - Returns the number of fields in the result set resource on - success&return.falseforfailure;. - - - - - &reftitle.examples; - - A <function>mysql_num_fields</function> example - - -]]> - - - - - - &reftitle.notes; - - - &info.deprecated.alias; - mysql_numfields - - - - - - &reftitle.seealso; - - mysql_select_db - mysql_query - mysql_fetch_field - mysql_num_rows - - - - diff --git a/reference/mysql/functions/mysql-num-rows.xml b/reference/mysql/functions/mysql-num-rows.xml deleted file mode 100644 index bc43c5340487..000000000000 --- a/reference/mysql/functions/mysql-num-rows.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - mysql_num_rows - Get number of rows in result - - - - - &mysql.alternative.note; - - mysqli_num_rows - mysqli_stmt_num_rows - PDOStatement::rowCount - - - - - - &reftitle.description; - - intfalsemysql_num_rows - resourceresult - - - Retrieves the number of rows from a result set. This command is only valid - for statements like SELECT or SHOW that return an actual result set. - To retrieve the number of rows affected by a INSERT, UPDATE, REPLACE or - DELETE query, use mysql_affected_rows. - - - - - &reftitle.parameters; - - &mysql.result.description; - - - - - &reftitle.returnvalues; - - The number of rows in a result set on success&return.falseforfailure;. - - - - - &reftitle.examples; - - <function>mysql_num_rows</function> example - - -]]> - - - - - - &reftitle.notes; - - - If you use mysql_unbuffered_query, - mysql_num_rows will not return the - correct value until all the rows in the result set have been - retrieved. - - - - - &info.deprecated.alias; - mysql_numrows - - - - - - &reftitle.seealso; - - mysql_affected_rows - mysql_connect - mysql_data_seek - mysql_select_db - mysql_query - - - - diff --git a/reference/mysql/functions/mysql-pconnect.xml b/reference/mysql/functions/mysql-pconnect.xml deleted file mode 100644 index bb4c83d4c8fa..000000000000 --- a/reference/mysql/functions/mysql-pconnect.xml +++ /dev/null @@ -1,170 +0,0 @@ - - - - - mysql_pconnect - Open a persistent connection to a MySQL server - - - - - &mysql.alternative.note; - - mysqli_connect with p: host prefix - PDO::__construct with PDO::ATTR_PERSISTENT as a driver option - - - - - - &reftitle.description; - - resourcemysql_pconnect - stringserverini_get("mysql.default_host") - stringusernameini_get("mysql.default_user") - stringpasswordini_get("mysql.default_password") - intclient_flags0 - - - - Establishes a persistent connection to a MySQL server. - - - - mysql_pconnect acts very much like - mysql_connect with two major differences. - - - First, when connecting, the function would first try to find a - (persistent) link that's already open with the same host, - username and password. If one is found, an identifier for it - will be returned instead of opening a new connection. - - - Second, the connection to the SQL server will not be closed when - the execution of the script ends. Instead, the link will remain - open for future use (mysql_close will not - close links established by mysql_pconnect). - - - This type of link is therefore called 'persistent'. - - - - - &reftitle.parameters; - - - server - - - The MySQL server. It can also include a port number. e.g. - "hostname:port" or a path to a local socket e.g. ":/path/to/socket" for - the localhost. - - - If the PHP directive - mysql.default_host is undefined (default), then the default - value is 'localhost:3306' - - - - - username - - - The username. Default value is the name of the user that owns the - server process. - - - - - password - - - The password. Default value is an empty password. - - - - - client_flags - - - The client_flags parameter can be a combination - of the following constants: - 128 (enable LOAD DATA LOCAL handling), - MYSQL_CLIENT_SSL, - MYSQL_CLIENT_COMPRESS, - MYSQL_CLIENT_IGNORE_SPACE or - MYSQL_CLIENT_INTERACTIVE. - - - - - - - - &reftitle.returnvalues; - - Returns a MySQL persistent link identifier on success, or &false; on - failure. - - - - - &reftitle.notes; - - - Note, that these kind of links only work if you are using - a module version of PHP. See the - Persistent - Database Connections section for more information. - - - - - Using persistent connections can require a bit of tuning of your Apache - and MySQL configurations to ensure that you do not exceed the number of - connections allowed by MySQL. - - - - - - &reftitle.seealso; - - mysql_connect - Persistent - Database Connections - - - - diff --git a/reference/mysql/functions/mysql-ping.xml b/reference/mysql/functions/mysql-ping.xml deleted file mode 100644 index 570cffe9e634..000000000000 --- a/reference/mysql/functions/mysql-ping.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - mysql_ping - Ping a server connection or reconnect if there is no connection - - - - - &mysql.alternative.note; - - mysqli_ping - - - - - - &reftitle.description; - - boolmysql_ping - resourcelink_identifierNULL - - - Checks whether or not the connection to - the server is working. If it has gone down, an automatic reconnection is - attempted. This function can be used by scripts that remain idle for a - long while, to check whether or not the server has closed the connection - and reconnect if necessary. - - - - Automatic reconnection is disabled by default in versions of MySQL >= 5.0.3. - - - - - - &reftitle.parameters; - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - Returns &true; if the connection to the server MySQL server is working, - otherwise &false;. - - - - - &reftitle.examples; - - A <function>mysql_ping</function> example - - -]]> - - - - - - &reftitle.seealso; - - mysql_thread_id - mysql_list_processes - - - - diff --git a/reference/mysql/functions/mysql-query.xml b/reference/mysql/functions/mysql-query.xml deleted file mode 100644 index 39e974a5af7a..000000000000 --- a/reference/mysql/functions/mysql-query.xml +++ /dev/null @@ -1,189 +0,0 @@ - - - - - mysql_query - Send a MySQL query - - - - - &mysql.alternative.note; - - mysqli_query - PDO::query - - - - - - &reftitle.description; - - mixedmysql_query - stringquery - resourcelink_identifierNULL - - - mysql_query sends a unique query (multiple queries - are not supported) to the currently - active database on the server that's associated with the - specified link_identifier. - - - - - &reftitle.parameters; - - - query - - - An SQL query - - - The query string should not end with a semicolon. - Data inside the query should be properly escaped. - - - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - For SELECT, SHOW, DESCRIBE, EXPLAIN and other statements returning resultset, - mysql_query - returns a resource on success, or &false; on - error. - - - For other type of SQL statements, INSERT, UPDATE, DELETE, DROP, etc, - mysql_query returns &true; on success - or &false; on error. - - - The returned result resource should be passed to - mysql_fetch_array, and other - functions for dealing with result tables, to access the returned data. - - - Use mysql_num_rows to find out how many rows - were returned for a SELECT statement or - mysql_affected_rows to find out how many - rows were affected by a DELETE, INSERT, REPLACE, or UPDATE - statement. - - - mysql_query will also fail and return &false; - if the user does not have permission to access the table(s) referenced by - the query. - - - - - &reftitle.examples; - - Invalid Query - - The following query is syntactically invalid, so - mysql_query fails and returns &false;. - - - -]]> - - - - Valid Query - - The following query is valid, so mysql_query - returns a resource. - - - -]]> - - - - - - &reftitle.seealso; - - mysql_connect - mysql_error - mysql_real_escape_string - mysql_result - mysql_fetch_assoc - mysql_unbuffered_query - - - - - diff --git a/reference/mysql/functions/mysql-real-escape-string.xml b/reference/mysql/functions/mysql-real-escape-string.xml deleted file mode 100644 index 9424be20a2e2..000000000000 --- a/reference/mysql/functions/mysql-real-escape-string.xml +++ /dev/null @@ -1,224 +0,0 @@ - - - - - mysql_real_escape_string - Escapes special characters in a string for use in an SQL statement - - - - - &mysql.alternative.note; - - mysqli_real_escape_string - PDO::quote - - - - - - &reftitle.description; - - stringmysql_real_escape_string - stringunescaped_string - resourcelink_identifierNULL - - - Escapes special characters in the unescaped_string, - taking into account the current character set of the connection so that it - is safe to place it in a mysql_query. If binary data - is to be inserted, this function must be used. - - - mysql_real_escape_string calls MySQL's library function - mysql_real_escape_string, which prepends backslashes to the following characters: - \x00, \n, - \r, \, ', - " and \x1a. - - - This function must always (with few exceptions) be used to make data - safe before sending a query to MySQL. - - - - Security: the default character set - - The character set must be set either at the server level, or with - the API function mysql_set_charset for it to affect - mysql_real_escape_string. See the concepts section - on character sets for - more information. - - - - - - &reftitle.parameters; - - - unescaped_string - - - The string that is to be escaped. - - - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - Returns the escaped string, or &false; on error. - - - - - &reftitle.errors; - - Executing this function without a MySQL connection present will - also emit E_WARNING level PHP errors. Only - execute this function with a valid MySQL connection present. - - - - - &reftitle.examples; - - Simple <function>mysql_real_escape_string</function> example - - -]]> - - - - <function>mysql_real_escape_string</function> requires a connection example - - This example demonstrates what happens if a MySQL connection is not - present when calling this function. - - - -]]> - - &example.outputs.similar; - - - - - - An example SQL Injection Attack - - -]]> - - - The query sent to MySQL: - - - - - - This would allow anyone to log in without a valid password. - - - - - - &reftitle.notes; - - - A MySQL connection is required before using - mysql_real_escape_string otherwise an error of - level E_WARNING is generated, and &false; is - returned. If link_identifier isn't defined, the - last MySQL connection is used. - - - - - If this function is not used to escape data, the query is vulnerable to - SQL Injection Attacks. - - - - - mysql_real_escape_string does not escape - % and _. These are wildcards in - MySQL if combined with LIKE, GRANT, - or REVOKE. - - - - - - &reftitle.seealso; - - mysql_set_charset - mysql_client_encoding - - - - diff --git a/reference/mysql/functions/mysql-result.xml b/reference/mysql/functions/mysql-result.xml deleted file mode 100644 index 097a3e289786..000000000000 --- a/reference/mysql/functions/mysql-result.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - mysql_result - Get result data - - - - - &mysql.alternative.note; - - - mysqli_data_seek in conjunction with - mysqli_field_seek and - mysqli_fetch_field - - PDOStatement::fetchColumn - - - - - - &reftitle.description; - - stringmysql_result - resourceresult - introw - mixedfield0 - - - Retrieves the contents of one cell from a MySQL result set. - - - When working on large result sets, you should consider using one - of the functions that fetch an entire row (specified below). As - these functions return the contents of multiple cells in one - function call, they're MUCH quicker than - mysql_result. Also, note that specifying a - numeric offset for the field argument is much quicker than - specifying a fieldname or tablename.fieldname argument. - - - - - &reftitle.parameters; - - &mysql.result.description; - - row - - - The row number from the result that's being retrieved. Row numbers - start at 0. - - - - - field - - - The name or offset of the field being retrieved. - - - It can be the field's offset, the field's name, or the field's table - dot field name (tablename.fieldname). If the column name has been - aliased ('select foo as bar from...'), use the alias instead of the - column name. If undefined, the first field is retrieved. - - - - - - - - &reftitle.returnvalues; - - The contents of one cell from a MySQL result set on success, or - &false; on failure. - - - - - &reftitle.examples; - - <function>mysql_result</function> example - - -]]> - - - - - - &reftitle.notes; - - - Calls to mysql_result should not be mixed - with calls to other functions that deal with the result set. - - - - - - &reftitle.seealso; - - mysql_fetch_row - mysql_fetch_array - mysql_fetch_assoc - mysql_fetch_object - - - - diff --git a/reference/mysql/functions/mysql-select-db.xml b/reference/mysql/functions/mysql-select-db.xml deleted file mode 100644 index 32ab346a2f59..000000000000 --- a/reference/mysql/functions/mysql-select-db.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - mysql_select_db - Select a MySQL database - - - - - &mysql.alternative.note; - - mysqli_select_db - PDO::__construct (part of dsn) - - - - - - &reftitle.description; - - boolmysql_select_db - stringdatabase_name - resourcelink_identifierNULL - - - Sets the current active database on the server that's associated with the - specified link identifier. Every subsequent call to - mysql_query will be made on the active database. - - - - - &reftitle.parameters; - - - database_name - - - The name of the database that is to be selected. - - - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>mysql_select_db</function> example - - -]]> - - - - - - &reftitle.notes; - - - &info.deprecated.alias; - mysql_selectdb - - - - - - &reftitle.seealso; - - mysql_connect - mysql_pconnect - mysql_query - - - - diff --git a/reference/mysql/functions/mysql-set-charset.xml b/reference/mysql/functions/mysql-set-charset.xml deleted file mode 100644 index 20997dbc1044..000000000000 --- a/reference/mysql/functions/mysql-set-charset.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - mysql_set_charset - Sets the client character set - - - - - &mysql.alternative.note; - - mysqli_set_charset - PDO: Add charset to the connection string, such as charset=utf8 - - - - - - &reftitle.description; - - boolmysql_set_charset - stringcharset - resourcelink_identifierNULL - - - Sets the default character set for the current connection. - - - - - &reftitle.parameters; - - - charset - - - A valid character set name. - - - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.notes; - - - This function requires MySQL 5.0.7 or later. - - - - - This is the preferred way to change the charset. Using - mysql_query to set it (such as SET NAMES utf8) - is not recommended. See the MySQL character set concepts - section for more information. - - - - - - &reftitle.seealso; - - Setting character sets in MySQL - List of character sets that MySQL supports - mysql_client_encoding - - - - - diff --git a/reference/mysql/functions/mysql-stat.xml b/reference/mysql/functions/mysql-stat.xml deleted file mode 100644 index 019715df9143..000000000000 --- a/reference/mysql/functions/mysql-stat.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - mysql_stat - Get current system status - - - - - &mysql.alternative.note; - - mysqli_stat - - PDO::getAttribute - with attribute as PDO::ATTR_SERVER_INFO - - - - - - - &reftitle.description; - - stringmysql_stat - resourcelink_identifierNULL - - - mysql_stat returns the current server status. - - - - - &reftitle.parameters; - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - Returns a string with the status for uptime, threads, queries, open tables, - flush tables and queries per second. For a complete list of other status - variables, you have to use the SHOW STATUS SQL command. - If link_identifier is invalid, &null; is returned. - - - - - &reftitle.examples; - - <function>mysql_stat</function> example - - -]]> - - &example.outputs.similar; - - Uptime: 5380 - [1] => Threads: 2 - [2] => Questions: 1321299 - [3] => Slow queries: 0 - [4] => Opens: 26 - [5] => Flush tables: 1 - [6] => Open tables: 17 - [7] => Queries per second avg: 245.595 -) -]]> - - - - Alternative <function>mysql_stat</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - mysql_get_server_info - mysql_list_processes - - - - - diff --git a/reference/mysql/functions/mysql-tablename.xml b/reference/mysql/functions/mysql-tablename.xml deleted file mode 100644 index af1002f9822b..000000000000 --- a/reference/mysql/functions/mysql-tablename.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - mysql_tablename - Get table name of field - - - - - &mysql.alternative.note; - - SQL Query: SHOW TABLES - - - - - - &reftitle.description; - - stringfalsemysql_tablename - resourceresult - inti - - - Retrieves the table name from a result. - - - This function is deprecated. It is preferable to use - mysql_query to issue an SQL SHOW TABLES - [FROM db_name] [LIKE 'pattern'] statement instead. - - - - - &reftitle.parameters; - - - result - - - A result pointer resource that's returned from - mysql_list_tables. - - - - - i - - - The integer index (row/table number) - - - - - - - - &reftitle.returnvalues; - - The name of the table on success&return.falseforfailure;. - - - Use the mysql_tablename function to - traverse this result pointer, or any function for result tables, - such as mysql_fetch_array. - - - - - &reftitle.examples; - - <function>mysql_tablename</function> example - - -]]> - - - - - - &reftitle.notes; - - - The mysql_num_rows function may be used to - determine the number of tables in the result pointer. - - - - - - &reftitle.seealso; - - mysql_list_tables - mysql_field_table - mysql_db_name - - - - diff --git a/reference/mysql/functions/mysql-thread-id.xml b/reference/mysql/functions/mysql-thread-id.xml deleted file mode 100644 index aec4c5fd29f6..000000000000 --- a/reference/mysql/functions/mysql-thread-id.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - mysql_thread_id - Return the current thread ID - - - - - &mysql.alternative.note; - - mysqli_thread_id - - - - - - &reftitle.description; - - intfalsemysql_thread_id - resourcelink_identifierNULL - - - Retrieves the current thread ID. If the connection is lost, and a reconnect - with mysql_ping is executed, the thread ID will - change. This means only retrieve the thread ID when needed. - - - - - &reftitle.parameters; - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - The thread ID on success&return.falseforfailure;. - - - - - &reftitle.examples; - - <function>mysql_thread_id</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - mysql_ping - mysql_list_processes - - - - diff --git a/reference/mysql/functions/mysql-unbuffered-query.xml b/reference/mysql/functions/mysql-unbuffered-query.xml deleted file mode 100644 index 251d536710a0..000000000000 --- a/reference/mysql/functions/mysql-unbuffered-query.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - mysql_unbuffered_query - Send an SQL query to MySQL without fetching and buffering the result rows - - - - - &mysql.alternative.note; - - See: Buffered and Unbuffered queries - - - - - - &reftitle.description; - - resourcemysql_unbuffered_query - stringquery - resourcelink_identifierNULL - - - mysql_unbuffered_query sends the SQL query - query to MySQL without automatically - fetching and buffering the result rows as - mysql_query does. This saves a considerable - amount of memory with SQL queries that produce large result sets, - and you can start working on the result set immediately after the - first row has been retrieved as you don't have to wait until the - complete SQL query has been performed. To use - mysql_unbuffered_query while multiple database - connections are open, you must specify the optional parameter - link_identifier to identify which connection - you want to use. - - - - - &reftitle.parameters; - - - query - - - The SQL query to execute. - - - Data inside the query should be properly escaped. - - - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - For SELECT, SHOW, DESCRIBE or EXPLAIN statements, - mysql_unbuffered_query - returns a resource on success, or &false; on - error. - - - For other type of SQL statements, UPDATE, DELETE, DROP, etc, - mysql_unbuffered_query returns &true; on success - or &false; on error. - - - - - &reftitle.notes; - - - The benefits of mysql_unbuffered_query come - at a cost: you cannot use mysql_num_rows and - mysql_data_seek on a result set returned from - mysql_unbuffered_query, until all rows are fetched. - You also have to fetch all result rows from an unbuffered SQL query - before you can send a new SQL query to MySQL, using the same - link_identifier. - - - - - - &reftitle.seealso; - - mysql_query - - - - diff --git a/reference/mysql/ini.xml b/reference/mysql/ini.xml deleted file mode 100644 index 89fa35fe0da6..000000000000 --- a/reference/mysql/ini.xml +++ /dev/null @@ -1,268 +0,0 @@ - - -
    - &reftitle.runtime; - &extension.runtime; - - - MySQL Configuration Options - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - mysql.allow_local_infile - "1" - INI_SYSTEM - - - - mysql.allow_persistent - "1" - INI_SYSTEM - - - - mysql.max_persistent - "-1" - INI_SYSTEM - - - - mysql.max_links - "-1" - INI_SYSTEM - - - - mysql.trace_mode - "0" - INI_ALL - - - - mysql.default_port - NULL - INI_ALL - - - - mysql.default_socket - NULL - INI_ALL - - - - mysql.default_host - NULL - INI_ALL - - - - mysql.default_user - NULL - INI_ALL - - - - mysql.default_password - NULL - INI_ALL - - - - mysql.connect_timeout - "60" - INI_ALL - - - - -
    - &ini.php.constants; -
    - -&ini.descriptions.title; - - - - - - mysql.allow_local_infile - int - - - - Allow accessing, from PHP's perspective, local files with LOAD DATA - statements - - - - - - - mysql.allow_persistent - bool - - - - Whether to allow - persistent connections - to MySQL. - - - - - - - mysql.max_persistent - int - - - - The maximum number of persistent MySQL connections per - process. - - - - - - - mysql.max_links - int - - - - The maximum number of MySQL connections per process, including - persistent connections. - - - - - - - mysql.trace_mode - bool - - - - Trace mode. When mysql.trace_mode is enabled, warnings - for table/index scans, non free result sets, and SQL-Errors will be - displayed. (Introduced in PHP 4.3.0) - - - - - - - mysql.default_port - string - - - - The default TCP port number to use when connecting to - the database server if no other port is specified. If - no default is specified, the port will be obtained - from the MYSQL_TCP_PORT environment - variable, the mysql-tcp entry in - /etc/services or the compile-time - MYSQL_PORT constant, in that order. Win32 - will only use the MYSQL_PORT constant. - - - - - - - mysql.default_socket - string - - - - The default socket name to use when connecting to a local - database server if no other socket name is specified. - - - - - - mysql.default_host - string - - - - The default server host to use when connecting to the database - server if no other host is specified. Doesn't apply in - &sqlsafemode;. - - - - - - - mysql.default_user - string - - - - The default user name to use when connecting to the database - server if no other name is specified. Doesn't apply in - &sqlsafemode;. - - - - - - - mysql.default_password - string - - - - The default password to use when connecting to the database - server if no other password is specified. Doesn't apply in - &sqlsafemode;. - - - - - - mysql.connect_timeout - int - - - - Connect timeout in seconds. On Linux this timeout is also used for - waiting for the first answer from the server. - - - - - -
    - diff --git a/reference/mysql/reference.xml b/reference/mysql/reference.xml deleted file mode 100644 index 630c7d7869b6..000000000000 --- a/reference/mysql/reference.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - MySQL &Functions; - - -
    - &reftitle.notes; - - - Most MySQL functions accept link_identifier as - the last optional parameter. If it is not provided, last opened - connection is used. If it doesn't exist, connection is tried to - establish with default parameters defined in &php.ini;. If it is not - successful, functions return &false;. - - -
    -
    - -&reference.mysql.entities.functions; - -
    - diff --git a/reference/mysql/setup.xml b/reference/mysql/setup.xml deleted file mode 100644 index 076f1d13853c..000000000000 --- a/reference/mysql/setup.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - &reftitle.setup; - - -
    - &reftitle.required; - - In order to have these functions available, you must compile PHP with - MySQL support. - - - &mysql.alternative.note; - -
    - - - - &reference.mysql.configure; - - - - &reference.mysql.ini; - - - -
    - &reftitle.resources; - - There are two resource types used in the MySQL module. The first one - is the link identifier for a database connection, the second a resource - which holds the result of a query. - -
    - - -
    - diff --git a/reference/mysql/versions.xml b/reference/mysql/versions.xml deleted file mode 100644 index 416295d752fb..000000000000 --- a/reference/mysql/versions.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/mysql_xdevapi/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/mysql_xdevapi/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/mysql_xdevapi/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/mysql_xdevapi/book.xml b/reference/mysql_xdevapi/book.xml deleted file mode 100644 index 8feb18d4e26b..000000000000 --- a/reference/mysql_xdevapi/book.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - Mysql_xdevapi - Mysql_xdevapi - - - &reftitle.intro; - - This extension provides access to the MySQL Document Store via the X DevAPI. The X DevAPI - is a common API provided by multiple MySQL Connectors providing easy access to relational - tables as well as collections of documents, which are represented in JSON, from a API - with CRUD-style operations. - - - The X DevAPI uses the X Protocol, the new generation client-server protocol of the MySQL - 8.0 server. - - - For general information about the MySQL Document Store, please refer to the - MySQL Document Store - chapter in the MySQL manual. - - - - &reference.mysql-xdevapi.setup; - &reference.mysql-xdevapi.constants; - &reference.mysql-xdevapi.changelog; - &reference.mysql-xdevapi.examples; - &reference.mysql-xdevapi.reference; - - &reference.mysql-xdevapi.mysql-xdevapi.baseresult; - &reference.mysql-xdevapi.mysql-xdevapi.client; - &reference.mysql-xdevapi.mysql-xdevapi.collection; - &reference.mysql-xdevapi.mysql-xdevapi.collectionadd; - &reference.mysql-xdevapi.mysql-xdevapi.collectionfind; - &reference.mysql-xdevapi.mysql-xdevapi.collectionmodify; - &reference.mysql-xdevapi.mysql-xdevapi.collectionremove; - &reference.mysql-xdevapi.mysql-xdevapi.columnresult; - &reference.mysql-xdevapi.mysql-xdevapi.crudoperationbindable; - &reference.mysql-xdevapi.mysql-xdevapi.crudoperationlimitable; - &reference.mysql-xdevapi.mysql-xdevapi.crudoperationskippable; - &reference.mysql-xdevapi.mysql-xdevapi.crudoperationsortable; - &reference.mysql-xdevapi.mysql-xdevapi.databaseobject; - &reference.mysql-xdevapi.mysql-xdevapi.docresult; - &reference.mysql-xdevapi.mysql-xdevapi.driver; - &reference.mysql-xdevapi.mysql-xdevapi.exception; - &reference.mysql-xdevapi.mysql-xdevapi.executable; - &reference.mysql-xdevapi.mysql-xdevapi.executionstatus; - &reference.mysql-xdevapi.mysql-xdevapi.expression; - &reference.mysql-xdevapi.mysql-xdevapi.fieldmetadata; - &reference.mysql-xdevapi.mysql-xdevapi.result; - &reference.mysql-xdevapi.mysql-xdevapi.rowresult; - &reference.mysql-xdevapi.mysql-xdevapi.schema; - &reference.mysql-xdevapi.mysql-xdevapi.schemaobject; - &reference.mysql-xdevapi.mysql-xdevapi.session; - &reference.mysql-xdevapi.mysql-xdevapi.sqlstatement; - &reference.mysql-xdevapi.mysql-xdevapi.sqlstatementresult; - &reference.mysql-xdevapi.mysql-xdevapi.statement; - &reference.mysql-xdevapi.mysql-xdevapi.table; - &reference.mysql-xdevapi.mysql-xdevapi.tabledelete; - &reference.mysql-xdevapi.mysql-xdevapi.tableinsert; - &reference.mysql-xdevapi.mysql-xdevapi.tableselect; - &reference.mysql-xdevapi.mysql-xdevapi.tableupdate; - &reference.mysql-xdevapi.mysql-xdevapi.warning; - - - - diff --git a/reference/mysql_xdevapi/changelog.xml b/reference/mysql_xdevapi/changelog.xml deleted file mode 100644 index b947cd385725..000000000000 --- a/reference/mysql_xdevapi/changelog.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - &ChangelogListingTitle; - &ChangelogListingDescription; - - - General Changelog for the ext/mysql_xdevapi extension - - This changelog references the ext/mysql_xdevapi extension. - - - - - Global ext/mysql_xdevapi changes - - - - - - &Version; - &Description; - - - - - 8.0.28 - - - Removed TLSv1 and TLSv1.1 support. The values "TLSv1", "TLSv1.0", - and "TLSv1.1" are now considered invalid for the "tls-versions" - connection attribute. - - - - - 8.0.26 - - - Deprecated TLSv1 and TLSv1.1 support. - - - - - - - - - - - - diff --git a/reference/mysql_xdevapi/constants.xml b/reference/mysql_xdevapi/constants.xml deleted file mode 100644 index a27b318f728a..000000000000 --- a/reference/mysql_xdevapi/constants.xml +++ /dev/null @@ -1,412 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - - - - MYSQLX_CLIENT_SSL - (int) - - - - - - - - - MYSQLX_TYPE_DECIMAL - (int) - - - - - - - - - MYSQLX_TYPE_TINY - (int) - - - - - - - - - MYSQLX_TYPE_SHORT - (int) - - - - - - - - - MYSQLX_TYPE_SMALLINT - (int) - - - - - - - - - MYSQLX_TYPE_MEDIUMINT - (int) - - - - - - - - - MYSQLX_TYPE_INT - (int) - - - - - - - - - MYSQLX_TYPE_BIGINT - (int) - - - - - - - - - MYSQLX_TYPE_LONG - (int) - - - - - - - - - MYSQLX_TYPE_FLOAT - (int) - - - - - - - - - MYSQLX_TYPE_DOUBLE - (int) - - - - - - - - - MYSQLX_TYPE_NULL - (int) - - - - - - - - - MYSQLX_TYPE_TIMESTAMP - (int) - - - - - - - - - MYSQLX_TYPE_LONGLONG - (int) - - - - - - - - - MYSQLX_TYPE_INT24 - (int) - - - - - - - - - MYSQLX_TYPE_DATE - (int) - - - - - - - - - MYSQLX_TYPE_TIME - (int) - - - - - - - - - MYSQLX_TYPE_DATETIME - (int) - - - - - - - - - MYSQLX_TYPE_YEAR - (int) - - - - - - - - - MYSQLX_TYPE_NEWDATE - (int) - - - - - - - - - MYSQLX_TYPE_ENUM - (int) - - - - - - - - - MYSQLX_TYPE_SET - (int) - - - - - - - - - MYSQLX_TYPE_TINY_BLOB - (int) - - - - - - - - - MYSQLX_TYPE_MEDIUM_BLOB - (int) - - - - - - - - - MYSQLX_TYPE_LONG_BLOB - (int) - - - - - - - - - MYSQLX_TYPE_BLOB - (int) - - - - - - - - - MYSQLX_TYPE_VAR_STRING - (int) - - - - - - - - - MYSQLX_TYPE_STRING - (int) - - - - - - - - - MYSQLX_TYPE_CHAR - (int) - - - - - - - - - MYSQLX_TYPE_BYTES - (int) - - - - - - - - - MYSQLX_TYPE_INTERVAL - (int) - - - - - - - - - MYSQLX_TYPE_GEOMETRY - (int) - - - - - - - - - MYSQLX_TYPE_JSON - (int) - - - - - - - - - MYSQLX_TYPE_NEWDECIMAL - (int) - - - - - - - - - MYSQLX_TYPE_BIT - (int) - - - - - - - - - MYSQLX_LOCK_DEFAULT - (int) - - - - - - - - - MYSQLX_LOCK_NOWAIT - (int) - - - - - - - - - MYSQLX_LOCK_SKIP_LOCKED - (int) - - - - - - - - - - - diff --git a/reference/mysql_xdevapi/examples.xml b/reference/mysql_xdevapi/examples.xml deleted file mode 100644 index 3285536097c2..000000000000 --- a/reference/mysql_xdevapi/examples.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - &reftitle.examples; - - The central entry point to the X DevAPI is the mysql_xdevapi\getSession - function, which receives a URI to a MySQL 8.0 Server and returns a - mysql_xdevapi\Session object. - - - Connecting to a MySQL Server - -getMessage()); -} - -// ... use $session -?> -]]> - - - - The session provides full access to the API. For a new MySQL Server installation, - the first step is to create a database schema with a collection - to store data: - - - Creating a Schema and Collection on the MySQL Server - -createSchema("test"); -$collection = $schema->createCollection("example"); -?> -]]> - - - - When storing data, typically json_encode is used to encode - the data into JSON, which can then be stored inside a collection. - - - The following example stores data into the collection we created earlier, - and then retrieve parts of it again. - - - Storing and Retrieving Data - - "Marco", - "age" => 19, - "job" => "Programmer" -]; -$mike = [ - "name" => "Mike", - "age" => 39, - "job" => "Manager" -]; - -$schema = $session->getSchema("test"); -$collection = $schema->getCollection("example"); - -$collection->add($marco, $mike)->execute(); - -var_dump($collection->find("name = 'Mike'")->execute()->fetchOne()); -?> -]]> - - &example.outputs.similar; - - - string(28) "00005ad66aaf0000000000000003" - ["age"]=> - int(39) - ["job"]=> - string(7) "Manager" - ["name"]=> - string(4) "Mike" -} -]]> - - - - The example demonstrates that the MySQL Server adds an extra field named - _id, which serves as primary key to the document. - - - The example also demonstrates that retrieved data is sorted alphabetically. - That specific order comes from the efficient binary storage inside the MySQL server, but - it should not be relied upon. Refer to the MySQL JSON datatype documentation for details. - - - Optionally use PHP's iterators to fetch multiple documents: - - - Fetching and Iterating Multiple Documents - -find()->execute(); -foreach ($result as $doc) { - echo "{$doc["name"]} is a {$doc["job"]}.\n"; -} -?> -]]> - - &example.outputs.similar; - - - - - - - diff --git a/reference/mysql_xdevapi/functions/mysql-xdevapi.expression.xml b/reference/mysql_xdevapi/functions/mysql-xdevapi.expression.xml deleted file mode 100644 index 4806da7886bd..000000000000 --- a/reference/mysql_xdevapi/functions/mysql-xdevapi.expression.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - expression - Bind prepared statement variables as parameters - - - - &reftitle.description; - - objectmysql_xdevapi\expression - stringexpression - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - expression - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Expression</function> example - -find("age > 30")->fields($expression)->limit(3)->execute(); -$data = $res->fetchAll(); - -print_r($data); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mysql_xdevapi/functions/mysql-xdevapi.getsession.xml b/reference/mysql_xdevapi/functions/mysql-xdevapi.getsession.xml deleted file mode 100644 index d22628cc6d9c..000000000000 --- a/reference/mysql_xdevapi/functions/mysql-xdevapi.getsession.xml +++ /dev/null @@ -1,253 +0,0 @@ - - - - - - getSession - Connect to a MySQL server - - - - &reftitle.description; - - mysql_xdevapi\Sessionmysql_xdevapi\getSession - stringuri - - - Connects to the MySQL server. - - - - - &reftitle.parameters; - - - uri - - - The URI to the MySQL server, such as mysqlx://user:password@host. - - - URI format: - - - scheme://[user[:[password]]@]target[:port][?attribute1=value1&attribute2=value2... - - - - scheme: required, the connection protocol - In mysql_xdevapi it is always 'mysqlx' (for X Protocol) - - - user: optional, the MySQL user account for authentication - - - password: optional, the MySQL user's password for authentication - - - target: required, the server instance the connection refers to: - * TCP connection (host name, IPv4 address, or IPv6 address) - * Unix socket path (local file path) - * Windows named-pipe (local file path) - - - port: optional, network port of MySQL server. - by default port for X Protocol is 33060 - - - - ?attribute=value: this element is optional and specifies a data dictionary - that contains different options, including: - - - - - The auth (authentication mechanism) attribute as it relates to encrypted connections. - For additional information, see Command - Options for Encrypted Connections. - The following 'auth' values are supported: plain, - mysql41, external, and sha256_mem. - - - - - The connect-timeout attribute affects the connection - and not subsequent operations. It is set per connection whether on - a single or multiple hosts. - - - Pass in a positive integer to define the connection timeout in seconds, - or pass in 0 (zero) to disable the timeout (infinite). Not defining - connect-timeout uses the default value of 10. - - - Related, the MYSQLX_CONNECTION_TIMEOUT (timeout in seconds) and MYSQLX_TEST_CONNECTION_TIMEOUT (used while running tests) - environment variables can be set and used instead of connect-timeout in the URI. The - connect-timeout URI option has precedence over these environment variables. - - - - - The optional compression attribute accepts these values: - preferred (client negotiates with server to find a supported algorithm; connection is uncompressed if a mutually supported algorithm is not found), - required (like "preferred", but connection is terminated if a mutually supported algorithm is not found), or - disabled (connection is uncompressed). Defaults to preferred. - - - This option was added in version 8.0.20. - - - - - The optional compression-algorithms attribute defines - the desired compression algorithms (and their preferred usage order): - zstd_stream (alias: zstd), - lz4_message (alias: lz4), or - deflate_stream (aliases: deflate or zlib). - By default, the order used (depending on system availability) is lz4_message, zstd_stream, then deflate_stream. - For example, passing in compression-algorithms=[lz4,zstd_stream] uses lz4 if it's available, otherwise - zstd_stream is used. If both are unavailable then behavior depends on the compression value - e.g., if compression=required then it'll fail with an error. - - - This option was added in version 8.0.22. - - - - - - - - URI examples - -mysqlx://foobar -mysqlx://root@localhost?socket=%2Ftmp%2Fmysqld.sock%2F -mysqlx://foo:bar@localhost:33060 -mysqlx://foo:bar@localhost:33160?ssl-mode=disabled -mysqlx://foo:bar@localhost:33260?ssl-mode=required -mysqlx://foo:bar@localhost:33360?ssl-mode=required&auth=mysql41 -mysqlx://foo:bar@(/path/to/socket) -mysqlx://foo:bar@(/path/to/socket)?auth=sha256_mem -mysqlx://foo:bar@[localhost:33060, 127.0.0.1:33061] -mysqlx://foobar?ssl-ca=(/path/to/ca.pem)&ssl-crl=(/path/to/crl.pem) -mysqlx://foo:bar@[localhost:33060, 127.0.0.1:33061]?ssl-mode=disabled -mysqlx://foo:bar@localhost:33160/?connect-timeout=0 -mysqlx://foo:bar@localhost:33160/?connect-timeout=10&compression=required -mysqlx://foo:bar@localhost:33160/?connect-timeout=10&compression=required&compression-algorithms=[lz4,zstd_stream] - - - - - For related information, see MySQL Shell's - Connecting using a URI String. - - - - - - - - - &reftitle.returnvalues; - - A Session object. - - - - - &reftitle.errors; - - A connection failure throws an Exception. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\getSession</function> example - -getMessage()); -} - -$schemas = $session->getSchemas(); -print_r($schemas); - -$mysql_version = $session->getServerVersion(); -print_r($mysql_version); - -var_dump($collection->find("name = 'Alfred'")->execute()->fetchOne()); -?> -]]> - - &example.outputs.similar; - - mysql_xdevapi\Schema Object - ( - [name] => helloworld - ) - [1] => mysql_xdevapi\Schema Object - ( - [name] => information_schema - ) - [2] => mysql_xdevapi\Schema Object - ( - [name] => mysql - ) - [3] => mysql_xdevapi\Schema Object - ( - [name] => performance_schema - ) - [4] => mysql_xdevapi\Schema Object - ( - [name] => sys - ) -) - -80012 - -array(4) { - ["_id"]=> - string(28) "00005ad66abf0001000400000003" - ["age"]=> - int(42) - ["job"]=> - string(7) "Butler" - ["name"]=> - string(4) "Alfred" -} -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/ini.xml b/reference/mysql_xdevapi/ini.xml deleted file mode 100644 index 8e1a076aa179..000000000000 --- a/reference/mysql_xdevapi/ini.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - -
    - &reftitle.runtime; - &extension.runtime; - - - Mysql_xdevapi &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - xmysqlnd.collect_memory_statistics - 0 - INI_SYSTEM - - - - xmysqlnd.collect_statistics - 1 - INI_ALL - - - - xmysqlnd.debug - - INI_SYSTEM - - - - xmysqlnd.mempool_default_size - 16000 - INI_ALL - - - - xmysqlnd.net_read_timeout - 31536000 - INI_SYSTEM - - - - xmysqlnd.trace_alloc - - INI_SYSTEM - - - - -
    -
    - - &ini.descriptions.title; - - - - - - xmysqlnd.collect_memory_statistics - int - - - - - - - - - - xmysqlnd.collect_statistics - int - - - - - - - - - - xmysqlnd.debug - string - - - - - - - - - - xmysqlnd.mempool_default_size - int - - - - - - - - - - xmysqlnd.net_read_timeout - int - - - - - - - - - - xmysqlnd.trace_alloc - string - - - - - - - - - - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.baseresult.xml b/reference/mysql_xdevapi/mysql-xdevapi.baseresult.xml deleted file mode 100644 index c319d8a85eba..000000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.baseresult.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - BaseResult interface - mysql_xdevapi\BaseResult - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\BaseResult - - - - - mysql_xdevapi\BaseResult - - - - - &Methods; - - - - -
    - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.baseresult; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.client.xml b/reference/mysql_xdevapi/mysql-xdevapi.client.xml deleted file mode 100644 index 12637dba4dd1..000000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.client.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - Client class - mysql_xdevapi\Client - - - - -
    - &reftitle.intro; - - Provides access to the connection pool. - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\Client - - - - - mysql_xdevapi\Client - - - - - &Methods; - - - - -
    - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.client; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.collection.xml b/reference/mysql_xdevapi/mysql-xdevapi.collection.xml deleted file mode 100644 index 769b0ba79de6..000000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.collection.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - Collection class - mysql_xdevapi\Collection - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\Collection - - - - - mysql_xdevapi\Collection - - - - mysql_xdevapi\SchemaObject - - - - &Properties; - - public - name - - - - &Methods; - - - - -
    - - - -
    - &reftitle.properties; - - - name - - - - - -
    - - - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.collection; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.collectionadd.xml b/reference/mysql_xdevapi/mysql-xdevapi.collectionadd.xml deleted file mode 100644 index c3353d6a4432..000000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.collectionadd.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - CollectionAdd class - mysql_xdevapi\CollectionAdd - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\CollectionAdd - - - - - mysql_xdevapi\CollectionAdd - - - - mysql_xdevapi\Executable - - - - - &Methods; - - - - -
    - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.collectionadd; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.collectionfind.xml b/reference/mysql_xdevapi/mysql-xdevapi.collectionfind.xml deleted file mode 100644 index ac02dbb63ba1..000000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.collectionfind.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - CollectionFind class - mysql_xdevapi\CollectionFind - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\CollectionFind - - - - - mysql_xdevapi\CollectionFind - - - - mysql_xdevapi\Executable - - - - mysql_xdevapi\CrudOperationBindable - - - - mysql_xdevapi\CrudOperationLimitable - - - - mysql_xdevapi\CrudOperationSortable - - - - - &Methods; - - - - -
    - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.collectionfind; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.collectionmodify.xml b/reference/mysql_xdevapi/mysql-xdevapi.collectionmodify.xml deleted file mode 100644 index 0fc9e70cd091..000000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.collectionmodify.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - CollectionModify class - mysql_xdevapi\CollectionModify - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\CollectionModify - - - - - mysql_xdevapi\CollectionModify - - - - mysql_xdevapi\Executable - - - - mysql_xdevapi\CrudOperationBindable - - - - mysql_xdevapi\CrudOperationLimitable - - - - mysql_xdevapi\CrudOperationSkippable - - - - mysql_xdevapi\CrudOperationSortable - - - - - &Methods; - - - - -
    - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.collectionmodify; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.collectionremove.xml b/reference/mysql_xdevapi/mysql-xdevapi.collectionremove.xml deleted file mode 100644 index 36c4939bbfaa..000000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.collectionremove.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - CollectionRemove class - mysql_xdevapi\CollectionRemove - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\CollectionRemove - - - - - mysql_xdevapi\CollectionRemove - - - - mysql_xdevapi\Executable - - - - mysql_xdevapi\CrudOperationBindable - - - - mysql_xdevapi\CrudOperationLimitable - - - - mysql_xdevapi\CrudOperationSortable - - - - - &Methods; - - - - -
    - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.collectionremove; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.columnresult.xml b/reference/mysql_xdevapi/mysql-xdevapi.columnresult.xml deleted file mode 100644 index f0fd29380c72..000000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.columnresult.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - ColumnResult class - mysql_xdevapi\ColumnResult - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\ColumnResult - - - - - mysql_xdevapi\ColumnResult - - - - - &Methods; - - - - -
    - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.columnresult; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.crudoperationbindable.xml b/reference/mysql_xdevapi/mysql-xdevapi.crudoperationbindable.xml deleted file mode 100644 index 8927219c32c2..000000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.crudoperationbindable.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - CrudOperationBindable interface - mysql_xdevapi\CrudOperationBindable - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\CrudOperationBindable - - - - - mysql_xdevapi\CrudOperationBindable - - - - - &Methods; - - - - -
    - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.crudoperationbindable; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.crudoperationlimitable.xml b/reference/mysql_xdevapi/mysql-xdevapi.crudoperationlimitable.xml deleted file mode 100644 index 0da4aad0e86d..000000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.crudoperationlimitable.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - CrudOperationLimitable interface - mysql_xdevapi\CrudOperationLimitable - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\CrudOperationLimitable - - - - - mysql_xdevapi\CrudOperationLimitable - - - - - &Methods; - - - - -
    - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.crudoperationlimitable; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.crudoperationskippable.xml b/reference/mysql_xdevapi/mysql-xdevapi.crudoperationskippable.xml deleted file mode 100644 index e7f8671ff156..000000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.crudoperationskippable.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - CrudOperationSkippable interface - mysql_xdevapi\CrudOperationSkippable - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\CrudOperationSkippable - - - - - mysql_xdevapi\CrudOperationSkippable - - - - - &Methods; - - - - -
    - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.crudoperationskippable; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.crudoperationsortable.xml b/reference/mysql_xdevapi/mysql-xdevapi.crudoperationsortable.xml deleted file mode 100644 index 71909b428fce..000000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.crudoperationsortable.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - CrudOperationSortable interface - mysql_xdevapi\CrudOperationSortable - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\CrudOperationSortable - - - - - mysql_xdevapi\CrudOperationSortable - - - - - &Methods; - - - - -
    - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.crudoperationsortable; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.databaseobject.xml b/reference/mysql_xdevapi/mysql-xdevapi.databaseobject.xml deleted file mode 100644 index a059c14f84cd..000000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.databaseobject.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - DatabaseObject interface - mysql_xdevapi\DatabaseObject - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\DatabaseObject - - - - - mysql_xdevapi\DatabaseObject - - - - - &Methods; - - - - -
    - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.databaseobject; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.docresult.xml b/reference/mysql_xdevapi/mysql-xdevapi.docresult.xml deleted file mode 100644 index 55753313b720..000000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.docresult.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - DocResult class - mysql_xdevapi\DocResult - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\DocResult - - - - - mysql_xdevapi\DocResult - - - - mysql_xdevapi\BaseResult - - - - Traversable - - - - - &Methods; - - - - -
    - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.docresult; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.driver.xml b/reference/mysql_xdevapi/mysql-xdevapi.driver.xml deleted file mode 100644 index 6ba5432e3e4e..000000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.driver.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - Driver class - mysql_xdevapi\Driver - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\Driver - - - - - mysql_xdevapi\Driver - - - - &Constants; - - const - string - mysql_xdevapi\Driver::version - 8.0.3 - - - - - -
    - - -
    - &reftitle.constants; - - - - mysql_xdevapi\Driver::version - - - - - - -
    - - - -
    - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.exception.xml b/reference/mysql_xdevapi/mysql-xdevapi.exception.xml deleted file mode 100644 index 991b524a503b..000000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.exception.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - Exception class - mysql_xdevapi\Exception - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\Exception - - - - - mysql_xdevapi\Exception - - - - extends - RuntimeException - - - - Throwable - - - - - - - - -
    - -
    - - - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.executable.xml b/reference/mysql_xdevapi/mysql-xdevapi.executable.xml deleted file mode 100644 index f023de7de9e8..000000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.executable.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - Executable interface - mysql_xdevapi\Executable - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\Executable - - - - - mysql_xdevapi\Executable - - - - - &Methods; - - - - -
    - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.executable; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.executionstatus.xml b/reference/mysql_xdevapi/mysql-xdevapi.executionstatus.xml deleted file mode 100644 index 298111b008be..000000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.executionstatus.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - ExecutionStatus class - mysql_xdevapi\ExecutionStatus - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\ExecutionStatus - - - - - mysql_xdevapi\ExecutionStatus - - - - &Properties; - - public - affectedItems - - - public - matchedItems - - - public - foundItems - - - public - lastInsertId - - - public - lastDocumentId - - - - Constructor - - - - -
    - - - -
    - &reftitle.properties; - - - affectedItems - - - - - - matchedItems - - - - - - foundItems - - - - - - lastInsertId - - - - - - lastDocumentId - - - - - -
    - - - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.executionstatus; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.expression.xml b/reference/mysql_xdevapi/mysql-xdevapi.expression.xml deleted file mode 100644 index 0b8cf1c06e10..000000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.expression.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Expression class - mysql_xdevapi\Expression - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\Expression - - - - - mysql_xdevapi\Expression - - - - &Properties; - - public - name - - - - Constructor - - - - -
    - - - -
    - &reftitle.properties; - - - name - - - - - -
    - - - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.expression; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.fieldmetadata.xml b/reference/mysql_xdevapi/mysql-xdevapi.fieldmetadata.xml deleted file mode 100644 index ff9696b5250e..000000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.fieldmetadata.xml +++ /dev/null @@ -1,205 +0,0 @@ - - - - - - FieldMetadata class - mysql_xdevapi\FieldMetadata - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\FieldMetadata - - - - - mysql_xdevapi\FieldMetadata - - - - &Properties; - - public - type - - - public - type_name - - - public - name - - - public - original_name - - - public - table - - - public - original_table - - - public - schema - - - public - catalog - - - public - collation - - - public - fractional_digits - - - public - length - - - public - flags - - - public - content_type - - - - - - -
    - - - -
    - &reftitle.properties; - - - type - - - - - - type_name - - - - - - name - - - - - - original_name - - - - - - table - - - - - - original_table - - - - - - schema - - - - - - catalog - - - - - - collation - - - - - - fractional_digits - - - - - - length - - - - - - flags - - - - - - content_type - - - - - -
    - - - -
    - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.result.xml b/reference/mysql_xdevapi/mysql-xdevapi.result.xml deleted file mode 100644 index 098a6ab46b68..000000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.result.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - Result class - mysql_xdevapi\Result - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\Result - - - - - mysql_xdevapi\Result - - - - mysql_xdevapi\BaseResult - - - - Traversable - - - - - &Methods; - - - - -
    - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.result; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.rowresult.xml b/reference/mysql_xdevapi/mysql-xdevapi.rowresult.xml deleted file mode 100644 index d2de1dff4758..000000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.rowresult.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - RowResult class - mysql_xdevapi\RowResult - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\RowResult - - - - - mysql_xdevapi\RowResult - - - - mysql_xdevapi\BaseResult - - - - Traversable - - - - - &Methods; - - - - -
    - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.rowresult; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.schema.xml b/reference/mysql_xdevapi/mysql-xdevapi.schema.xml deleted file mode 100644 index 7878f026a6c1..000000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.schema.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - Schema class - mysql_xdevapi\Schema - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\Schema - - - - - mysql_xdevapi\Schema - - - - mysql_xdevapi\DatabaseObject - - - - &Properties; - - public - name - - - - &Methods; - - - - -
    - - - -
    - &reftitle.properties; - - - name - - - - - -
    - - - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.schema; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.schemaobject.xml b/reference/mysql_xdevapi/mysql-xdevapi.schemaobject.xml deleted file mode 100644 index 47187ebf3b68..000000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.schemaobject.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - SchemaObject interface - mysql_xdevapi\SchemaObject - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\SchemaObject - - - - - mysql_xdevapi\SchemaObject - - - - mysql_xdevapi\DatabaseObject - - - - - &Methods; - - - - -
    - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.schemaobject; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.session.xml b/reference/mysql_xdevapi/mysql-xdevapi.session.xml deleted file mode 100644 index a8f951c18d51..000000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.session.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - Session class - mysql_xdevapi\Session - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\Session - - - - - mysql_xdevapi\Session - - - - - &Methods; - - - - -
    - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.session; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.sqlstatement.xml b/reference/mysql_xdevapi/mysql-xdevapi.sqlstatement.xml deleted file mode 100644 index 863dec265436..000000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.sqlstatement.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - SqlStatement class - mysql_xdevapi\SqlStatement - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\SqlStatement - - - - - mysql_xdevapi\SqlStatement - - - - &Constants; - - const - int - mysql_xdevapi\SqlStatement::EXECUTE_ASYNC - 1 - - - const - int - mysql_xdevapi\SqlStatement::BUFFERED - 2 - - - &Properties; - - public - statement - - - - &Methods; - - - - -
    - - - -
    - &reftitle.properties; - - - statement - - - - - -
    - - - - -
    - &reftitle.constants; - - - - mysql_xdevapi\SqlStatement::EXECUTE_ASYNC - - - - - - - mysql_xdevapi\SqlStatement::BUFFERED - - - - - - -
    - - - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.sqlstatement; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.sqlstatementresult.xml b/reference/mysql_xdevapi/mysql-xdevapi.sqlstatementresult.xml deleted file mode 100644 index f54836f92a67..000000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.sqlstatementresult.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - SqlStatementResult class - mysql_xdevapi\SqlStatementResult - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\SqlStatementResult - - - - - mysql_xdevapi\SqlStatementResult - - - - mysql_xdevapi\BaseResult - - - - Traversable - - - - - &Methods; - - - - -
    - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.sqlstatementresult; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.statement.xml b/reference/mysql_xdevapi/mysql-xdevapi.statement.xml deleted file mode 100644 index a10288499373..000000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.statement.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Statement class - mysql_xdevapi\Statement - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\Statement - - - - - mysql_xdevapi\Statement - - - - &Constants; - - const - int - mysql_xdevapi\Statement::EXECUTE_ASYNC - 1 - - - const - int - mysql_xdevapi\Statement::BUFFERED - 2 - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - mysql_xdevapi\Statement::EXECUTE_ASYNC - - - - - - - mysql_xdevapi\Statement::BUFFERED - - - - - - -
    - - - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.statement; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.table.xml b/reference/mysql_xdevapi/mysql-xdevapi.table.xml deleted file mode 100644 index d11ad5ca3cef..000000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.table.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - Table class - mysql_xdevapi\Table - - - - -
    - &reftitle.intro; - - Provides access to the table through INSERT/SELECT/UPDATE/DELETE statements. - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\Table - - - - - mysql_xdevapi\Table - - - - mysql_xdevapi\SchemaObject - - - - &Properties; - - public - name - - - - &Methods; - - - - -
    - - - -
    - &reftitle.properties; - - - name - - - - - -
    - - - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.table; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.tabledelete.xml b/reference/mysql_xdevapi/mysql-xdevapi.tabledelete.xml deleted file mode 100644 index 0c2888c1e5f9..000000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.tabledelete.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - TableDelete class - mysql_xdevapi\TableDelete - - - - -
    - &reftitle.intro; - - A statement for delete operations on Table. - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\TableDelete - - - - - mysql_xdevapi\TableDelete - - - - mysql_xdevapi\Executable - - - - - &Methods; - - - - -
    - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.tabledelete; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.tableinsert.xml b/reference/mysql_xdevapi/mysql-xdevapi.tableinsert.xml deleted file mode 100644 index 0753598f7683..000000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.tableinsert.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - TableInsert class - mysql_xdevapi\TableInsert - - - - -
    - &reftitle.intro; - - A statement for insert operations on Table. - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\TableInsert - - - - - mysql_xdevapi\TableInsert - - - - mysql_xdevapi\Executable - - - - - &Methods; - - - - -
    - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.tableinsert; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.tableselect.xml b/reference/mysql_xdevapi/mysql-xdevapi.tableselect.xml deleted file mode 100644 index f744208ec0e7..000000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.tableselect.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - TableSelect class - mysql_xdevapi\TableSelect - - - - -
    - &reftitle.intro; - - A statement for record retrieval operations on a Table. - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\TableSelect - - - - - mysql_xdevapi\TableSelect - - - - mysql_xdevapi\Executable - - - - - &Methods; - - - - -
    - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.tableselect; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.tableupdate.xml b/reference/mysql_xdevapi/mysql-xdevapi.tableupdate.xml deleted file mode 100644 index f7caafbdeec8..000000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.tableupdate.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - TableUpdate class - mysql_xdevapi\TableUpdate - - - - -
    - &reftitle.intro; - - A statement for record update operations on a Table. - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\TableUpdate - - - - - mysql_xdevapi\TableUpdate - - - - mysql_xdevapi\Executable - - - - - &Methods; - - - - -
    - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.tableupdate; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.warning.xml b/reference/mysql_xdevapi/mysql-xdevapi.warning.xml deleted file mode 100644 index eb98f1d00f0c..000000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.warning.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - Warning class - mysql_xdevapi\Warning - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\Warning - - - - - mysql_xdevapi\Warning - - - - &Properties; - - public - message - - - public - level - - - public - code - - - - Constructor - - - - -
    - - - -
    - &reftitle.properties; - - - message - - - - - - level - - - - - - code - - - - - -
    - - - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.warning; - -
    - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/baseresult/getwarnings.xml b/reference/mysql_xdevapi/mysql_xdevapi/baseresult/getwarnings.xml deleted file mode 100644 index 73a7897ab9a1..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/baseresult/getwarnings.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - BaseResult::getWarnings - Fetch warnings from last operation - - - - &reftitle.description; - - abstract public arraymysql_xdevapi\BaseResult::getWarnings - - - - Fetches warnings generated by MySQL server's last operation. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - An array of Warning objects from the last operation. Each object - defines an error 'message', error 'level', and error 'code'. An empty - array is returned if no errors are present. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\RowResult::getWarnings</function> example - -sql("CREATE DATABASE foo")->execute(); -$session->sql("CREATE TABLE foo.test_table(x int)")->execute(); - -$schema = $session->getSchema("foo"); -$table = $schema->getTable("test_table"); - -$table->insert(['x'])->values([1])->values([2])->execute(); - -$res = $table->select(['x/0 as bad_x'])->execute(); -$warnings = $res->getWarnings(); - -print_r($warnings); -?> -]]> - - &example.outputs.similar; - - mysql_xdevapi\Warning Object - ( - [message] => Division by 0 - [level] => 2 - [code] => 1365 - ) - [1] => mysql_xdevapi\Warning Object - ( - [message] => Division by 0 - [level] => 2 - [code] => 1365 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/baseresult/getwarningscount.xml b/reference/mysql_xdevapi/mysql_xdevapi/baseresult/getwarningscount.xml deleted file mode 100644 index ac2818c95982..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/baseresult/getwarningscount.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - BaseResult::getWarningsCount - Fetch warning count from last operation - - - - &reftitle.description; - - abstract public intmysql_xdevapi\BaseResult::getWarningsCount - - - - Returns the number of warnings raised by the last operation. Specifically, - these warnings are raised by the MySQL server. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The number of warnings from the last operation. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\RowResult::getWarningsCount</function> example - -sql("DROP DATABASE IF EXISTS foo")->execute(); -$session->sql("CREATE DATABASE foo")->execute(); -$session->sql("CREATE TABLE foo.test_table(x int)")->execute(); - -$schema = $session->getSchema("foo"); -$table = $schema->getTable("test_table"); - -$table->insert(['x'])->values([1])->values([2])->execute(); - -$res = $table->select(['x/0 as bad_x'])->execute(); - -echo $res->getWarningsCount(); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/client/close.xml b/reference/mysql_xdevapi/mysql_xdevapi/client/close.xml deleted file mode 100755 index 3676fb6810d8..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/client/close.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - mysql_xdevapi\Client::close - Close client - - - - &reftitle.description; - - public boolmysql_xdevapi\Client::close - - - - Close all client connections with the server. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; if connections are closed. - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/client/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/client/construct.xml deleted file mode 100755 index 1726f2f893a3..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/client/construct.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - Client::__construct - Client constructor - - - - &reftitle.description; - - private mysql_xdevapi\Client::__construct - - - - Construct a client object. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.examples; - - <function>mysql_xdevapi\Client::__construct</function> example - -getSession(); -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/client/getsession.xml b/reference/mysql_xdevapi/mysql_xdevapi/client/getsession.xml deleted file mode 100755 index 8f51fbd2d87c..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/client/getsession.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - Client::getClient - Get client session - - - - &reftitle.description; - - public mysql_xdevapi\Sessionmysql_xdevapi\Client::getSession - - - - Get session associated with the client. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A Session object. - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/add.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/add.xml deleted file mode 100644 index 4f31a881536f..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/add.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - Collection::add - Add collection document - - - - &reftitle.description; - - public mysql_xdevapi\CollectionAddmysql_xdevapi\Collection::add - mixeddocument - - - Triggers the insertion of the given document(s) into the collection, and - multiple variants of this method are supported. Options include: - - - - - Add a single document as a JSON string. - - - - - Add a single document as an array as: - [ 'field' => 'value', 'field2' => 'value2' ... ] - - - - - A mix of both, and multiple documents can be added in the same operation. - - - - - - - &reftitle.parameters; - - - document - - - One or multiple documents, and this can be either JSON or an array of fields with - their associated values. This cannot be an empty array. - - - The MySQL server automatically generates unique _id values for - each document (recommended), although this can be manually added as well. This value must be - unique as otherwise the add operation will fail. - - - - - - - - &reftitle.returnvalues; - - A CollectionAdd object. Use execute() to return a Result that can be used to query the number - of affected items, the number warnings generated by the operation, or to fetch a list of - generated IDs for the inserted documents. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Collection::add</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); - -$collection = $schema->getCollection("people"); - -// Add two documents -$collection->add('{"name": "Fred", "age": 21, "job": "Construction"}')->execute(); -$collection->add('{"name": "Wilma", "age": 23, "job": "Teacher"}')->execute(); - -// Add two documents using a single JSON object -$result = $collection->add( - '{"name": "Bernie", - "jobs": [{"title":"Cat Herder","Salary":42000}, {"title":"Father","Salary":0}], - "hobbies": ["Sports","Making cupcakes"]}', - '{"name": "Jane", - "jobs": [{"title":"Scientist","Salary":18000}, {"title":"Mother","Salary":0}], - "hobbies": ["Walking","Making pies"]}')->execute(); - -// Fetch a list of generated ID's from the last add() -$ids = $result->getGeneratedIds(); -print_r($ids); -?> -]]> - - &example.outputs.similar; - - 00005b6b53610000000000000056 - [1] => 00005b6b53610000000000000057 -) -]]> - - - - - - &reftitle.notes; - - - A unique _id is generated by MySQL Server 8.0 or higher, as demonstrated - in the example. The _id field must be manually defined if using - MySQL Server 5.7. - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/addorreplaceone.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/addorreplaceone.xml deleted file mode 100644 index bfc2bbffdf90..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/addorreplaceone.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - Collection::addOrReplaceOne - Add or replace collection document - - - - &reftitle.description; - - public mysql_xdevapi\Resultmysql_xdevapi\Collection::addOrReplaceOne - stringid - stringdoc - - - Add a new document, or replace a document if it already exists. - - - Here are several scenarios for this method: - - - - - If neither the id or any unique key values conflict with any document in the collection, - then the document is added. - - - - - If the id does not match any document but one or more unique key values conflict with a - document in the collection, then an error is raised. - - - - - If id matches an existing document and no unique keys are defined for the collection, - then the document is replaced. - - - - - If id matches an existing document, and either all unique keys in the replacement document - match that same document or they don't conflict with any other documents in the collection, - then the document is replaced. - - - - - If id matches an existing document and one or more unique keys match a different document - from the collection, then an error is raised. - - - - - - - - &reftitle.parameters; - - - id - - - This is the filter id. If this id or any other field that has a unique index already - exists in the collection, then it will update the matching document instead. - - - By default, this id is automatically generated by MySQL Server when the - record was added, and is referenced as a field named '_id'. - - - - - doc - - - This is the document to add or replace, which is a JSON string. - - - - - - - - &reftitle.returnvalues; - - A Result object. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Collection::addOrReplaceOne</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); - -$collection = $schema->getCollection("people"); - -// Using add() -$result = $collection->add('{"name": "Wilma", "age": 23, "job": "Teacher"}')->execute(); - -// Using addOrReplaceOne() -// Note: we're passing in a known _id value here -$result = $collection->addOrReplaceOne('00005b6b53610000000000000056', '{"name": "Fred", "age": 21, "job": "Construction"}'); - -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/construct.xml deleted file mode 100644 index 51e5301051d1..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/construct.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - Collection::__construct - Collection constructor - - - - &reftitle.description; - - private mysql_xdevapi\Collection::__construct - - - - Construct a Collection object. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.examples; - - <function>mysql_xdevapi\Collection::getOne</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -$result = $collection->add('{"name": "Alfred", "age": 42, "job": "Butler"}')->execute(); - -// A unique _id is (by default, and recommended) generated by MySQL Server -// This retrieves the generated _id's; only one in this example, so $ids[0] -$ids = $result->getGeneratedIds(); -$alfreds_id = $ids[0]; - -// ... - -print_r($alfreds_id); -print_r($collection->getOne($alfreds_id)); -?> -]]> - - &example.outputs.similar; - - 00005b6b536100000000000000b1 - [age] => 42 - [job] => Butler - [name] => Alfred -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/count.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/count.xml deleted file mode 100644 index fc8ce0d3fea0..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/count.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - Collection::count - Get document count - - - - &reftitle.description; - - public intmysql_xdevapi\Collection::count - - - - This functionality is similar to a SELECT COUNT(*) SQL - operation against the MySQL server for the current schema and collection. - In other words, it counts the number of documents in the collection. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The number of documents in the collection. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Collection::count</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); - -$collection = $schema->getCollection("people"); - -$result = $collection - ->add( - '{"name": "Bernie", - "jobs": [ - {"title":"Cat Herder","Salary":42000}, - {"title":"Father","Salary":0} - ], - "hobbies": ["Sports","Making cupcakes"]}', - '{"name": "Jane", - "jobs": [ - {"title":"Scientist","Salary":18000}, - {"title":"Mother","Salary":0} - ], - "hobbies": ["Walking","Making pies"]}') - ->execute(); - -var_dump($collection->count()); -?> -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/createindex.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/createindex.xml deleted file mode 100644 index c813ce2736ab..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/createindex.xml +++ /dev/null @@ -1,178 +0,0 @@ - - - - - - Collection::createIndex - Create collection index - - - - &reftitle.description; - - public voidmysql_xdevapi\Collection::createIndex - stringindex_name - stringindex_desc_json - - - Creates an index on the collection. - - - An exception is thrown if an index with the same name already exists, - or if index definition is not correctly formed. - - - - - &reftitle.parameters; - - - index_name - - - The name of the index that to create. This name must be a valid index name as - accepted by the CREATE INDEX SQL query. - - - - - index_desc_json - - - Definition of the index to create. It contains an array of IndexField objects, - and each object describes a single document member to include in the index, - and an optional string for the type of index that might be INDEX (default) or SPATIAL. - - - A single IndexField description consists of the following fields: - - - - - field: string, the full document path to the document member or field to be indexed. - - - - - type: string, one of the supported SQL column types to map the field into. - For numeric types, the optional UNSIGNED keyword may follow. - For the TEXT type, the length to consider for indexing may be added. - - - - - required: bool, (optional) true if the field is required to exist in the document. - Defaults to &false;, except for GEOJSON where it defaults to &true;. - - - - - options: integer, (optional) special option flags for use - when decoding GEOJSON data. - - - - - srid: integer, (optional) srid value for use when - decoding GEOJSON data. - - - - - - It is an error to include other fields not described above in - IndexDefinition or IndexField documents. - - - - - - - - &reftitle.returnvalues; - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Collection::createIndex</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -// Creating a text index -$collection->createIndex( - 'myindex1', - '{"fields": [{ - "field": "$.name", - "type": "TEXT(25)", - "required": true}], - "unique": false}' -); - -// A spatial index -$collection->createIndex( - 'myindex2', - '{"fields": [{ - "field": "$.home", - "type": "GEOJSON", - "required": true}], - "type": "SPATIAL"}' -); - -// Index with multiple fields -$collection->createIndex( - 'myindex3', - '{"fields": [ - { - "field": "$.name", - "type": "TEXT(20)", - "required": true - }, - { - "field": "$.age", - "type": "INTEGER" - }, - { - "field": "$.job", - "type": "TEXT(30)", - "required": false - } - ], - "unique": true - }' -); -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/dropindex.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/dropindex.xml deleted file mode 100644 index 315db6ac9003..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/dropindex.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - Collection::dropIndex - Drop collection index - - - - &reftitle.description; - - public boolmysql_xdevapi\Collection::dropIndex - stringindex_name - - - Drop a collection index. - - - This operation does not yield an error if the index does not exist, but - &false; is returned in that case. - - - - - &reftitle.parameters; - - - index_name - - - Name of collection index to drop. - - - - - - - - &reftitle.returnvalues; - - &true; if the DROP INDEX operation succeeded, otherwise &false;. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Collection::dropIndex</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); - -// ... - -$collection = $schema->getCollection("people"); - -$collection->createIndex( - 'myindex', - '{"fields": [{"field": "$.name", "type": "TEXT(25)", "required": true}], "unique": false}' -); - -// ... - -if ($collection->dropIndex('myindex')) { - echo "An index named 'myindex' was found, and dropped."; -} -?> -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/existsindatabase.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/existsindatabase.xml deleted file mode 100644 index d4899e35a028..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/existsindatabase.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Collection::existsInDatabase - Check if collection exists in database - - - - &reftitle.description; - - public boolmysql_xdevapi\Collection::existsInDatabase - - - - Checks if the Collection object refers to a collection in the database (schema). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; if collection exists in the database, else &false; if it does not. - - - A table defined with two columns (doc and _id) is considered a collection, - and a third _json_schema column as of MySQL 8.0.21. - Adding an additional column means existsInDatabase() will no longer see it as a collection. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Collection::existsInDatabase</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); - -// ... - -$collection = $schema->getCollection("people"); - -// ... - -if (!$collection->existsInDatabase()) { - echo "The collection no longer exists in the database named addressbook. What happened?"; -} -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/find.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/find.xml deleted file mode 100644 index ecc70a03e4b5..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/find.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - Collection::find - Search for document - - - - &reftitle.description; - - public mysql_xdevapi\CollectionFindmysql_xdevapi\Collection::find - stringsearch_condition - - - Search a database collection for a document or set of documents. The - found documents are returned as a CollectionFind object is to - further modify or fetch results from. - - - - - &reftitle.parameters; - - - search_condition - - - Although optional, normally a condition is defined to limit the results - to a subset of documents. - - - Multiple elements might build the condition and the syntax supports parameter binding. - The expression used as search condition must be a valid SQL expression. - If no search condition is provided (field empty) then find('true') is assumed. - - - - - - - - &reftitle.returnvalues; - - A CollectionFind object to verify the operation, - or fetch the found documents. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Collection::find</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -$collection->add('{"name": "Alfred", "age": 18, "job": "Butler"}')->execute(); -$collection->add('{"name": "Bob", "age": 19, "job": "Swimmer"}')->execute(); -$collection->add('{"name": "Fred", "age": 20, "job": "Construction"}')->execute(); -$collection->add('{"name": "Wilma", "age": 21, "job": "Teacher"}')->execute(); -$collection->add('{"name": "Suki", "age": 22, "job": "Teacher"}')->execute(); - -$find = $collection->find('job LIKE :job AND age > :age'); -$result = $find - ->bind(['job' => 'Teacher', 'age' => 20]) - ->sort('age DESC') - ->limit(2) - ->execute(); - -print_r($result->fetchAll()); -?> -]]> - - &example.outputs; - - Array - ( - [_id] => 00005b6b536100000000000000a8 - [age] => 22 - [job] => Teacher - [name] => Suki - ) - [1] => Array - ( - [_id] => 00005b6b536100000000000000a7 - [age] => 21 - [job] => Teacher - [name] => Wilma - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/getname.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/getname.xml deleted file mode 100644 index 154832f6f951..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/getname.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - Collection::getName - Get collection name - - - - &reftitle.description; - - public stringmysql_xdevapi\Collection::getName - - - - Retrieve the collection's name. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The collection name, as a string. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Collection::getName</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - - -// ... - -var_dump($collection->getName()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/getone.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/getone.xml deleted file mode 100644 index 48b77772f815..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/getone.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - Collection::getOne - Get one document - - - - &reftitle.description; - - public Documentmysql_xdevapi\Collection::getOne - stringid - - - Fetches one document from the collection. - - - This is a shortcut for: - Collection.find("_id = :id").bind("id", id).execute().fetchOne(); - - - - - &reftitle.parameters; - - - id - - - The document _id in the collection. - - - - - - - - &reftitle.returnvalues; - - The collection object, or &null; if the _id does not match a document. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Collection::getOne</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -$result = $collection->add('{"name": "Alfred", "age": 42, "job": "Butler"}')->execute(); - -// A unique _id is (by default, and recommended) generated by MySQL Server -// This retrieves the generated _id's; only one in this example, so $ids[0] -$ids = $result->getGeneratedIds(); -$alfreds_id = $ids[0]; - -// ... - -print_r($alfreds_id); -print_r($collection->getOne($alfreds_id)); -?> -]]> - - &example.outputs.similar; - - 00005b6b536100000000000000b1 - [age] => 42 - [job] => Butler - [name] => Alfred -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/getschema.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/getschema.xml deleted file mode 100644 index fb0c93bc6335..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/getschema.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - Collection::getSchema - Get schema object - - - - &reftitle.description; - - public Schema Objectmysql_xdevapi\Collection::getSchema - - - - Retrieve the schema object that contains the collection. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The schema object on success, or &null; if the object cannot be retrieved - for the given collection. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Collection::getSchema</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -var_dump($collection->getSchema()); -?> -]]> - - &example.outputs.similar; - - - string(11) "addressbook" -} -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/getsession.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/getsession.xml deleted file mode 100644 index 941eb242754f..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/getsession.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Collection::getSession - Get session object - - - - &reftitle.description; - - public Sessionmysql_xdevapi\Collection::getSession - - - - Get a new Session object from the Collection object. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A Session object. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Collection::getSession</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -// ... - -$newsession = $collection->getSession(); - -var_dump($session); -var_dump($newsession); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/modify.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/modify.xml deleted file mode 100644 index f10bc00bf5c2..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/modify.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - Collection::modify - Modify collection documents - - - - &reftitle.description; - - public mysql_xdevapi\CollectionModifymysql_xdevapi\Collection::modify - stringsearch_condition - - - Modify the documents of a collection that meet specific search conditions. - Multiple operations are allowed, and parameter binding - is supported. - - - - - &reftitle.parameters; - - - search_condition - - - Must be a valid SQL expression used to match the documents to modify. - This expression might be as simple as &true;, which matches all - documents, or it might use functions and operators such as - 'CAST(_id AS SIGNED) >= 10', - 'age MOD 2 = 0 OR age MOD 3 = 0', or - '_id IN ["2","5","7","10"]'. - - - - - - - - &reftitle.returnvalues; - - If the operation is not executed, then the function will return - a Modify object that can be used to add additional - modify operations. - - - If the modify operation is executed, then the returned object will contain - the result of the operation. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Collection::modify</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -$collection->add('{"name": "Alfred", "age": 18, "job": "Butler"}')->execute(); -$collection->add('{"name": "Bob", "age": 19, "job": "Painter"}')->execute(); - -// Add two new jobs for all Painters: Artist and Crafter -$collection - ->modify("job in ('Butler', 'Painter')") - ->arrayAppend('job', 'Artist') - ->arrayAppend('job', 'Crafter') - ->execute(); - -// Remove the 'beer' field from all documents with the age 21 -$collection - ->modify('age < 21') - ->unset(['beer']) - ->execute(); -?> -]]> - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/remove.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/remove.xml deleted file mode 100644 index 902271d4979a..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/remove.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - Collection::remove - Remove collection documents - - - - &reftitle.description; - - public mysql_xdevapi\CollectionRemovemysql_xdevapi\Collection::remove - stringsearch_condition - - - Removes documents of a collection that meet specific search conditions. - Multiple operations are allowed, and parameter binding is supported. - - - - - &reftitle.parameters; - - - search_condition - - - Must be a valid SQL expression used to match the documents to remove. - This expression might be as simple as &true;, which matches all - documents, or it might use functions and operators such as - 'CAST(_id AS SIGNED) >= 10', - 'age MOD 2 = 0 OR age MOD 3 = 0', or - '_id IN ["2","5","7","10"]'. - - - - - - - - &reftitle.returnvalues; - - If the operation is not executed, then the function will return - a Remove object that can be used to add additional - remove operations. - - - If the remove operation is executed, then the returned object will contain - the result of the operation. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Collection::remove</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -$collection->add('{"name": "Alfred", "age": 18, "job": "Butler"}')->execute(); -$collection->add('{"name": "Bob", "age": 19, "job": "Painter"}')->execute(); - -// Remove all painters -$collection - ->remove("job in ('Painter')") - ->execute(); - -// Remove the oldest butler -$collection - ->remove("job in ('Butler')") - ->sort('age desc') - ->limit(1) - ->execute(); - -// Remove record with highest age -$collection - ->remove('true') - ->sort('age desc') - ->limit(1) - ->execute(); -?> -]]> - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/removeone.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/removeone.xml deleted file mode 100644 index 054ff728bcb9..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/removeone.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - Collection::removeOne - Remove one collection document - - - - &reftitle.description; - - public mysql_xdevapi\Resultmysql_xdevapi\Collection::removeOne - stringid - - - Remove one document from the collection with the corresponding ID. - This is a shortcut for Collection.remove("_id = :id").bind("id", id).execute(). - - - - - - &reftitle.parameters; - - - id - - - The ID of the collection document to remove. Typically this is - the _id that was generated by MySQL Server when the record - was added. - - - - - - - - &reftitle.returnvalues; - - A Result object that can be used to query the number of affected items or the - number warnings generated by the operation. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Collection::removeOne</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -$result = $collection->add('{"name": "Alfred", "age": 18, "job": "Butler"}')->execute(); - -// Normally the _id is known by other means, -// but for this example let's fetch the generated id and use it -$ids = $result->getGeneratedIds(); -$alfred_id = $ids[0]; - -$result = $collection->removeOne($alfred_id); - -if(!$result->getAffectedItemsCount()) { - echo "Alfred with id $alfred_id was not removed."; -} else { - echo "Goodbye, Alfred, you can take _id $alfred_id with you."; -} -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/replaceone.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/replaceone.xml deleted file mode 100644 index 2840989be668..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/replaceone.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - Collection::replaceOne - Replace one collection document - - - - &reftitle.description; - - public mysql_xdevapi\Resultmysql_xdevapi\Collection::replaceOne - stringid - stringdoc - - - Updates (or replaces) the document identified by ID, if it exists. - - - - - - &reftitle.parameters; - - - id - - - ID of the document to replace or update. Typically this is - the _id that was generated by MySQL Server when the record - was added. - - - - - doc - - - Collection document to update or replace the document matching - the parameter. - - - This document can be either a document object or a valid JSON string - describing the new document. - - - - - - - - &reftitle.returnvalues; - - A Result object that can be used to query the number of affected items and the - number warnings generated by the operation. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Collection::replaceOne</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -$result = $collection->add('{"name": "Alfred", "age": 18, "job": "Butler"}')->execute(); - -// Normally the _id is known by other means, -// but for this example let's fetch the generated id and use it -$ids = $result->getGeneratedIds(); -$alfred_id = $ids[0]; - -// ... - -$alfred = $collection->getOne($alfred_id); -$alfred['age'] = 81; -$alfred['job'] = 'Guru'; - -$collection->replaceOne($alfred_id, $alfred); - -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionadd/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionadd/construct.xml deleted file mode 100644 index 7448ec437b17..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionadd/construct.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - CollectionAdd::__construct - CollectionAdd constructor - - - - &reftitle.description; - - private mysql_xdevapi\CollectionAdd::__construct - - - - Use to add a document to a collection; called from a Collection object. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.examples; - - <function>mysql_xdevapi\CollectionAdd::__construct</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); - -$collection = $schema->getCollection("people"); - -// Add two documents -$collection - ->add('{"name": "Fred", "age": 21, "job": "Construction"}') - ->execute(); - -$collection - ->add('{"name": "Wilma", "age": 23, "job": "Teacher"}') - ->execute(); - -// Add two documents using a single JSON object -$result = $collection - ->add( - '{"name": "Bernie", - "jobs": [{"title":"Cat Herder","Salary":42000}, {"title":"Father","Salary":0}], - "hobbies": ["Sports","Making cupcakes"]}', - '{"name": "Jane", - "jobs": [{"title":"Scientist","Salary":18000}, {"title":"Mother","Salary":0}], - "hobbies": ["Walking","Making pies"]}') - ->execute(); - -// Fetch a list of generated ID's from the last add() -$ids = $result->getGeneratedIds(); -print_r($ids); - -?> -]]> - - &example.outputs.similar; - - 00005b6b53610000000000000056 - [1] => 00005b6b53610000000000000057 -) -]]> - - - - - - &reftitle.notes; - - - A unique _id is generated by MySQL Server 8.0 or higher, as demonstrated - in the example. The _id field must be manually defined if using - MySQL Server 5.7. - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionadd/execute.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionadd/execute.xml deleted file mode 100644 index b33eedce738f..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionadd/execute.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - CollectionAdd::execute - Execute the statement - - - - &reftitle.description; - - public mysql_xdevapi\Resultmysql_xdevapi\CollectionAdd::execute - - - - The execute method is required to send the CRUD operation request - to the MySQL server. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A Result object that can be used to verify the status of the operation, - such as the number of affected rows. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\CollectionAdd::execute</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); - -$collection = $schema->getCollection("people"); - -// Add two documents -$collection - ->add('{"name": "Fred", "age": 21, "job": "Construction"}') - ->execute(); - -$collection - ->add('{"name": "Wilma", "age": 23, "job": "Teacher"}') - ->execute(); - -// Add two documents using a single JSON object -$result = $collection - ->add( - '{"name": "Bernie", - "jobs": [{"title":"Cat Herder","Salary":42000}, {"title":"Father","Salary":0}], - "hobbies": ["Sports","Making cupcakes"]}', - '{"name": "Jane", - "jobs": [{"title":"Scientist","Salary":18000}, {"title":"Mother","Salary":0}], - "hobbies": ["Walking","Making pies"]}') - ->execute(); - -// Fetch a list of generated ID's from the last add() -$ids = $result->getGeneratedIds(); -print_r($ids); -?> -]]> - - &example.outputs.similar; - - 00005b6b53610000000000000056 - [1] => 00005b6b53610000000000000057 -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/bind.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/bind.xml deleted file mode 100644 index fc81e9d2f222..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/bind.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - CollectionFind::bind - Bind value to query placeholder - - - - &reftitle.description; - - public mysql_xdevapi\CollectionFindmysql_xdevapi\CollectionFind::bind - arrayplaceholder_values - - - It allows the user to bind a parameter to the placeholder in the search condition of the find operation. - The placeholder has the form of :NAME where ':' is a common prefix that must always exists before any NAME, - NAME is the actual name of the placeholder. The bind function accepts a list of placeholders if multiple - entities have to be substituted in the search condition. - - - - - - - &reftitle.parameters; - - - placeholder_values - - - Values to substitute in the search condition; multiple values are allowed - and are passed as an array where "PLACEHOLDER_NAME => PLACEHOLDER_VALUE". - - - - - - - - &reftitle.returnvalues; - - A CollectionFind object, - or chain with execute() to return a Result object. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\CollectionFind::bind</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); -$result = $create - ->add('{"name": "Alfred", "age": 18, "job": "Butler"}') - ->execute(); - -// ... - -$collection = $schema->getCollection("people"); - -$result = $collection - ->find('job like :job and age > :age') - ->bind(['job' => 'Butler', 'age' => 16]) - ->execute(); - -var_dump($result->fetchAll()); -?> -]]> - - &example.outputs.similar; - - - array(4) { - ["_id"]=> - string(28) "00005b6b536100000000000000cf" - ["age"]=> - int(18) - ["job"]=> - string(6) "Butler" - ["name"]=> - string(6) "Alfred" - } -} -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/construct.xml deleted file mode 100644 index d235ebb5abf7..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/construct.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - CollectionFind::__construct - CollectionFind constructor - - - - &reftitle.description; - - private mysql_xdevapi\CollectionFind::__construct - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.examples; - - CollectionFind example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); -$result = $create - ->add('{"name": "Alfred", "age": 18, "job": "Butler"}') - ->execute(); - -// ... - -$collection = $schema->getCollection("people"); - -$result = $collection - ->find('job like :job and age > :age') - ->bind(['job' => 'Butler', 'age' => 16]) - ->execute(); - -var_dump($result->fetchAll()); -?> -]]> - - &example.outputs.similar; - - - array(4) { - ["_id"]=> - string(28) "00005b6b536100000000000000cf" - ["age"]=> - int(18) - ["job"]=> - string(6) "Butler" - ["name"]=> - string(6) "Alfred" - } -} -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/execute.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/execute.xml deleted file mode 100644 index b6fbdfd58dd1..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/execute.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - CollectionFind::execute - Execute the statement - - - - &reftitle.description; - - public mysql_xdevapi\DocResultmysql_xdevapi\CollectionFind::execute - - - - Execute the find operation; - this functionality allows for method chaining. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A mysql_xdevapi\DocResult object that can be used - to either fetch results from, or to query the status of the operation. - - - - - &reftitle.examples; - - CollectionFind example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); - -$create - ->add('{"name": "Alfred", "age": 18, "job": "Butler"}') - ->execute(); - -// ... - -$collection = $schema->getCollection("people"); - -$result = $collection - ->find('job like :job and age > :age') - ->bind(['job' => 'Butler', 'age' => 16]) - ->execute(); - -var_dump($result->fetchAll()); -?> -]]> - - &example.outputs.similar; - - - array(4) { - ["_id"]=> - string(28) "00005b6b536100000000000000cf" - ["age"]=> - int(18) - ["job"]=> - string(6) "Butler" - ["name"]=> - string(6) "Alfred" - } -} -]]> - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/fields.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/fields.xml deleted file mode 100644 index 12c863837d75..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/fields.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - CollectionFind::fields - Set document field filter - - - - &reftitle.description; - - public mysql_xdevapi\CollectionFindmysql_xdevapi\CollectionFind::fields - stringprojection - - - Defines the columns for the query to return. If not defined, - all columns are used. - - - - - - &reftitle.parameters; - - - projection - - - Can either be a single string or an array of strings identifying the - columns to be returned for each document that match the search condition. - - - - - - - - &reftitle.returnvalues; - - A CollectionFind object that can be used for further processing. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\CollectionFind::fields</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); - -$create - ->add('{"name": "Alfred", "age": 18, "job": "Butler"}') - ->execute(); - -// ... - -$collection = $schema->getCollection("people"); - -$result = $collection - ->find('job like :job and age > :age') - ->bind(['job' => 'Butler', 'age' => 16]) - ->fields('name') - ->execute(); - -var_dump($result->fetchAll()); -?> -]]> - - &example.outputs.similar; - - - array(1) { - ["name"]=> - string(6) "Alfred" - } -} -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/groupby.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/groupby.xml deleted file mode 100644 index d976ac3f8b00..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/groupby.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - CollectionFind::groupBy - Set grouping criteria - - - - &reftitle.description; - - public mysql_xdevapi\CollectionFindmysql_xdevapi\CollectionFind::groupBy - stringsort_expr - - - This function can be used to group the result set by one or more columns. - It is often used with aggregate functions such as COUNT, - MAX, MIN, SUM etc. - - - - - &reftitle.parameters; - - - sort_expr - - - The column or columns that have to be used for the group operation, this can either be a single string - or an array of string arguments, one for each column. - - - - - - - - &reftitle.returnvalues; - - A CollectionFind object that can be used for further processing. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\CollectionFind::groupBy</function> example - -find()->groupBy('name')->execute(); - -?> -]]> - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/having.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/having.xml deleted file mode 100644 index 5130619948ec..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/having.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - CollectionFind::having - Set condition for aggregate functions - - - - &reftitle.description; - - public mysql_xdevapi\CollectionFindmysql_xdevapi\CollectionFind::having - stringsort_expr - - - This function can be used after the 'field' operation in order to make a selection on the documents to extract. - - - - - - &reftitle.parameters; - - - sort_expr - - - This must be a valid SQL expression, the use of aggreate functions is allowed - - - - - - - - &reftitle.returnvalues; - - CollectionFind object that can be used for further processing - - - - - &reftitle.examples; - - <function>mysql_xdevapi\CollectionFind::having</function> example - -find()->fields(['name','age'])->having('age > 40')->execute(); - -?> -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/limit.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/limit.xml deleted file mode 100644 index 9a6f6a60d2f6..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/limit.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - CollectionFind::limit - Limit number of returned documents - - - - &reftitle.description; - - public mysql_xdevapi\CollectionFindmysql_xdevapi\CollectionFind::limit - introws - - - Set the maximum number of documents to return. - - - - - &reftitle.parameters; - - - rows - - - Maximum number of documents. - - - - - - - - &reftitle.returnvalues; - - A CollectionFind object that can be used for additional processing; - chain with the execute() method to return a DocResult object. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\CollectionFind::limit</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); -$create - ->add('{"name": "Alfred", "age": 18, "job": "Butler"}') - ->execute(); -$create - ->add('{"name": "Reginald", "age": 42, "job": "Butler"}') - ->execute(); - - -// ... - -$collection = $schema->getCollection("people"); - -$result = $collection - ->find('job like :job and age > :age') - ->bind(['job' => 'Butler', 'age' => 16]) - ->sort('age desc') - ->limit(1) - ->execute(); - -var_dump($result->fetchAll()); -?> -]]> - - &example.outputs.similar; - - - array(4) { - ["_id"]=> - string(28) "00005b6b536100000000000000f3" - ["age"]=> - int(42) - ["job"]=> - string(6) "Butler" - ["name"]=> - string(8) "Reginald" - } -} -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/lockexclusive.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/lockexclusive.xml deleted file mode 100644 index a328f4c77312..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/lockexclusive.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - CollectionFind::lockExclusive - Execute operation with EXCLUSIVE LOCK - - - - &reftitle.description; - - public mysql_xdevapi\CollectionFindmysql_xdevapi\CollectionFind::lockExclusive - intlock_waiting_option - - - Locks the document exclusively. - As long as the document is locked, - other transactions can't update the document, - use SELECT ... LOCK IN SHARE MODE, - or read the data in certain transaction isolation levels. - Consistent reads ignore any locks set on the records that exist in the read view. - - - To avoid concurrency problems, it makes sense to use this function with the - mysql_xdevapi\Collection::modify method. Essentially, this function uses row locks to serialise - access to rows. - - - - - &reftitle.parameters; - - - lock_waiting_option - - - Optional waiting option. By default it is MYSQLX_LOCK_DEFAULT. Valid values are these constants: - - - MYSQLX_LOCK_DEFAULT - MYSQLX_LOCK_NOWAIT - MYSQLX_LOCK_SKIP_LOCKED - - - - - - - - &reftitle.returnvalues; - - Returns a CollectionFind object that can be used for further processing. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\CollectionFind::lockExclusive</function> example - -getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -$session->startTransaction(); - -$result = $collection - ->find("age > 50") - ->lockExclusive() - ->execute(); - -// ... do an operation on the object - -// Complete the transaction and unlock the document -$session->commit(); -?> -]]> - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/lockshared.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/lockshared.xml deleted file mode 100644 index e8851ee99c61..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/lockshared.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - CollectionFind::lockShared - Execute operation with SHARED LOCK - - - - &reftitle.description; - - public mysql_xdevapi\CollectionFindmysql_xdevapi\CollectionFind::lockShared - intlock_waiting_option - - - Allows to share the documents between multiple transactions which are locking in shared mode. - - - Other sessions can read the rows, but cannot modify them until your transaction commits. - - - If any of these rows were changed by another transaction that hasn't been committed, - the query will wait until that transaction has ended to be able to use the latest values. - - - - - &reftitle.parameters; - - - lock_waiting_option - - - Optional waiting option. By default it is MYSQLX_LOCK_DEFAULT. Valid values are these constants: - - - MYSQLX_LOCK_DEFAULT - MYSQLX_LOCK_NOWAIT - MYSQLX_LOCK_SKIP_LOCKED - - - - - - - - &reftitle.returnvalues; - - A CollectionFind object that can be used for further processing - - - - - &reftitle.examples; - - <function>mysql_xdevapi\CollectionFind::lockShared</function> example - -getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -$session->startTransaction(); - -$result = $collection - ->find("age > 50") - ->lockShared() - ->execute(); - -// ... read the object in shared mode - -// Complete the transaction and unlock the document -$session->commit(); -?> -]]> - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/offset.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/offset.xml deleted file mode 100644 index 58b553e8a77c..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/offset.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - CollectionFind::offset - Skip given number of elements to be returned - - - - &reftitle.description; - - public mysql_xdevapi\CollectionFindmysql_xdevapi\CollectionFind::offset - intposition - - - Skip (offset) these number of elements that otherwise would be returned - by the find operation. Use with the limit() method. - - - Defining an offset larger than the result set size results in an empty set. - - - - - &reftitle.parameters; - - - position - - - Number of elements to skip for the limit() operation. - - - - - - - - &reftitle.returnvalues; - - A CollectionFind object that can be used for additional processing. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\CollectionFind::offset</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); -$create - ->add('{"name": "Alfred", "age": 18, "job": "Butler"}') - ->execute(); -$create - ->add('{"name": "Reginald", "age": 42, "job": "Butler"}') - ->execute(); - -// ... - -$collection = $schema->getCollection("people"); - -$result = $collection - ->find() - ->sort('age asc') - ->offset(1) - ->limit(1) - ->execute(); - -var_dump($result->fetchAll()); -?> -]]> - - &example.outputs.similar; - - - array(4) { - ["_id"]=> - string(28) "00005b6b536100000000000000f3" - ["age"]=> - int(42) - ["job"]=> - string(6) "Butler" - ["name"]=> - string(8) "Reginald" - } -} -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/sort.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/sort.xml deleted file mode 100644 index e6ff0f006887..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/sort.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - CollectionFind::sort - Set the sorting criteria - - - - &reftitle.description; - - public mysql_xdevapi\CollectionFindmysql_xdevapi\CollectionFind::sort - stringsort_expr - - - Sort the result set by the field selected in the sort_expr argument. The allowed - orders are ASC (Ascending) or DESC (Descending). This operation is equivalent to the 'ORDER BY' SQL operation - and it follows the same set of rules. - - - - - - &reftitle.parameters; - - - sort_expr - - - One or more sorting expressions can be provided. The evaluation is from left to right, - and each expression is separated by a comma. - - - - - - - - &reftitle.returnvalues; - - A CollectionFind object that can be used to execute the command, or to add additional operations. - - - - - - &reftitle.examples; - - <function>mysql_xdevapi\CollectionFind::sort</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); -$create - ->add('{"name": "Alfred", "age": 18, "job": "Butler"}') - ->execute(); -$create - ->add('{"name": "Reginald", "age": 42, "job": "Butler"}') - ->execute(); - -// ... - -$collection = $schema->getCollection("people"); - -$result = $collection - ->find() - ->sort('job desc', 'age asc') - ->execute(); - -var_dump($result->fetchAll()); -?> -]]> - - &example.outputs.similar; - - - array(4) { - ["_id"]=> - string(28) "00005b6b53610000000000000106" - ["age"]=> - int(18) - ["job"]=> - string(6) "Butler" - ["name"]=> - string(6) "Alfred" - } - [1]=> - array(4) { - ["_id"]=> - string(28) "00005b6b53610000000000000107" - ["age"]=> - int(42) - ["job"]=> - string(6) "Butler" - ["name"]=> - string(8) "Reginald" - } -} -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/arrayappend.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/arrayappend.xml deleted file mode 100644 index cd2ee3337af4..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/arrayappend.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - CollectionModify::arrayAppend - Append element to an array field - - - - &reftitle.description; - - public mysql_xdevapi\CollectionModifymysql_xdevapi\CollectionModify::arrayAppend - stringcollection_field - stringexpression_or_literal - - - Add an element to a document's field, as multiple elements of a field are represented as an array. - Unlike arrayInsert(), arrayAppend() always appends the new element - at the end of the array, whereas arrayInsert() can define the location. - - - - - &reftitle.parameters; - - - collection_field - - - The identifier of the field where the new element is inserted. - - - - - expression_or_literal - - - The new element to insert at the end of the document field array. - - - - - - - - &reftitle.returnvalues; - - A CollectionModify object that can be used to execute the command, or to add additional operations. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\CollectionModify::arrayAppend</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -$result = $collection - ->add( - '{"name": "Bernie", - "traits": ["Friend", "Brother", "Human"]}') - ->execute(); - -$collection - ->modify("name in ('Bernie', 'Jane')") - ->arrayAppend('traits', 'Happy') - ->execute(); - -$result = $collection - ->find() - ->execute(); - -print_r($result->fetchAll()); -?> -]]> - - &example.outputs.similar; - - Array - ( - [_id] => 00005b6b5361000000000000010c - [name] => Bernie - [traits] => Array - ( - [0] => Friend - [1] => Brother - [2] => Human - [3] => Happy - ) - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/arrayinsert.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/arrayinsert.xml deleted file mode 100644 index 3739603289c0..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/arrayinsert.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - CollectionModify::arrayInsert - Insert element into an array field - - - - &reftitle.description; - - public mysql_xdevapi\CollectionModifymysql_xdevapi\CollectionModify::arrayInsert - stringcollection_field - stringexpression_or_literal - - - Adds an element to a document's field, as multiple elements of a field are - represented as an array. Unlike - mysql_xdevapi\CollectionModify::arrayAppend this - method allows to specify where the new element is inserted by defining - which item it is after, whereas - mysql_xdevapi\CollectionModify::arrayAppend always - appends the new element at the end of the array. - - - - - &reftitle.parameters; - - - collection_field - - - Identifies the item in the array after which the new element will be inserted. - The format of this parameter is - FIELD_NAME[ INDEX ] where - FIELD_NAME is the name of the document field - to add the element to, and INDEX - is the INDEX of the element within the field. - - - The INDEX field is zero based, so the first item of the array has an index of 0. - - - - - expression_or_literal - - - The new element to insert after FIELD_NAME[ INDEX ] - - - - - - - - &reftitle.returnvalues; - - A CollectionModify object that can be used to execute the command, or to add additional operations - - - - - &reftitle.examples; - - <function>mysql_xdevapi\CollectionModify::arrayInsert</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -$result = $collection - ->add( - '{"name": "Bernie", - "traits": ["Friend", "Brother", "Human"]}') - ->execute(); - -$collection - ->modify("name in ('Bernie', 'Jane')") - ->arrayInsert('traits[1]', 'Happy') - ->execute(); - -$result = $collection - ->find() - ->execute(); - -print_r($result->fetchAll()); -?> -]]> - - &example.outputs.similar; - - Array - ( - [_id] => 00005b6b5361000000000000010d - [name] => Bernie - [traits] => Array - ( - [0] => Friend - [1] => Happy - [2] => Brother - [3] => Human - ) - ) -) -]]> - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/bind.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/bind.xml deleted file mode 100644 index b2f9a9ae6475..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/bind.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - CollectionModify::bind - Bind value to query placeholder - - - - &reftitle.description; - - public mysql_xdevapi\CollectionModifymysql_xdevapi\CollectionModify::bind - arrayplaceholder_values - - - Bind a parameter to the placeholder in the search condition of the modify operation. - - - The placeholder has the form of :NAME where ':' is a common prefix that must always exists before any NAME - where NAME is the name of the placeholder. The bind method accepts a list of placeholders if multiple - entities have to be substituted in the search condition of the modify operation. - - - - - - &reftitle.parameters; - - - placeholder_values - - - Placeholder values to substitute in the search condition. Multiple values are allowed - and have to be passed as an array of mappings PLACEHOLDER_NAME->PLACEHOLDER_VALUE. - - - - - - - - &reftitle.returnvalues; - - A CollectionModify object that can be used to execute the command, or to add additional operations. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\CollectionModify::bind</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -$result = $collection - ->add( - '{"name": "Bernie", - "traits": ["Friend", "Brother", "Human"]}') - ->execute(); - -$collection - ->modify("name = :name") - ->bind(['name' => 'Bernie']) - ->arrayAppend('traits', 'Happy') - ->execute(); - -$result = $collection - ->find() - ->execute(); - -print_r($result->fetchAll()); -?> -]]> - - &example.outputs.similar; - - Array - ( - [_id] => 00005b6b53610000000000000110 - [name] => Bernie - [traits] => Array - ( - [0] => Friend - [1] => Brother - [2] => Human - [3] => Happy - ) - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/construct.xml deleted file mode 100644 index 8cf5e2cc42cf..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/construct.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - CollectionModify::__construct - CollectionModify constructor - - - - &reftitle.description; - - private mysql_xdevapi\CollectionModify::__construct - - - - Modifies (updates) a collection and is instantiated by the - mysql_xdevapi\Collection::modify method. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.examples; - - <function>mysql_xdevapi\CollectionModify::__construct</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -$result = $collection - ->add( - '{"name": "Bernie", - "traits": ["Friend", "Brother", "Human"]}') - ->execute(); - -$collection - ->modify("name in ('Bernie', 'Jane')") - ->arrayAppend('traits', 'Happy') - ->execute(); - -$result = $collection - ->find() - ->execute(); - -print_r($result->fetchAll()); -?> -]]> - - &example.outputs.similar; - - Array - ( - [_id] => 00005b6b5361000000000000010c - [name] => Bernie - [traits] => Array - ( - [0] => Friend - [1] => Brother - [2] => Human - [3] => Happy - ) - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/execute.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/execute.xml deleted file mode 100644 index 8e75a0fa9034..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/execute.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - CollectionModify::execute - Execute modify operation - - - - &reftitle.description; - - public mysql_xdevapi\Resultmysql_xdevapi\CollectionModify::execute - - - - The execute method is required to send the CRUD operation request - to the MySQL server. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A Result object that can be used to verify the status of the operation, - such as the number of affected rows. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\CollectionModify::execute</function> example - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/limit.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/limit.xml deleted file mode 100644 index 8654ab410261..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/limit.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - CollectionModify::limit - Limit number of modified documents - - - - &reftitle.description; - - public mysql_xdevapi\CollectionModifymysql_xdevapi\CollectionModify::limit - introws - - - Limit the number of documents modified by this operation. - Optionally combine with skip() to define an offset value. - - - - - &reftitle.parameters; - - - rows - - - The maximum number of documents to modify. - - - - - - - - &reftitle.returnvalues; - - A CollectionModify object. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\CollectionModify::limit</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -$collection->add('{"name": "Fred", "age": 21, "job": "Construction"}')->execute(); -$collection->add('{"name": "Wilma", "age": 23, "job": "Teacher"}')->execute(); -$collection->add('{"name": "Betty", "age": 24, "job": "Teacher"}')->execute(); - -$collection - ->modify("job = :job") - ->bind(['job' => 'Teacher']) - ->set('job', 'Principal') - ->limit(1) - ->execute(); - -$result = $collection - ->find() - ->execute(); - -print_r($result->fetchAll()); -?> -]]> - - &example.outputs.similar; - - Array - ( - [_id] => 00005b6b53610000000000000118 - [age] => 21 - [job] => Construction - [name] => Fred - ) - [1] => Array - ( - [_id] => 00005b6b53610000000000000119 - [age] => 23 - [job] => Principal - [name] => Wilma - ) - [2] => Array - ( - [_id] => 00005b6b5361000000000000011a - [age] => 24 - [job] => Teacher - [name] => Betty - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/patch.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/patch.xml deleted file mode 100644 index f0a5cd577267..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/patch.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - CollectionModify::patch - Patch document - - - - &reftitle.description; - - public mysql_xdevapi\CollectionModifymysql_xdevapi\CollectionModify::patch - stringdocument - - - Takes a patch object and applies it on one or more documents, and - can update multiple document properties. - - - - - &reftitle.parameters; - - - document - - - A document with the properties to apply to the matching documents. - - - - - - - - &reftitle.returnvalues; - - A CollectionModify object. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\CollectionModify::patch</function> example - -modify('"Programmatore" IN job')->patch('{"Hobby" : "Programmare"}')->execute(); - -?> -]]> - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/replace.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/replace.xml deleted file mode 100644 index bab259cbc042..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/replace.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - CollectionModify::replace - Replace document field - - - - &reftitle.description; - - public mysql_xdevapi\CollectionModifymysql_xdevapi\CollectionModify::replace - stringcollection_field - stringexpression_or_literal - - - Replace (update) a given field value with a new one. - - - - - &reftitle.parameters; - - - collection_field - - - The document path of the item to set. - - - - - expression_or_literal - - - The value to set on the specified attribute. - - - - - - - - &reftitle.returnvalues; - - A CollectionModify object. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\CollectionModify::replace</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -$result = $collection - ->add( - '{"name": "Bernie", - "traits": ["Friend", "Brother", "Human"]}') - ->execute(); - -$collection - ->modify("name = :name") - ->bind(['name' => 'Bernie']) - ->replace("name", "Bern") - ->execute(); - -$result = $collection - ->find() - ->execute(); - -print_r($result->fetchAll()); -?> -]]> - - &example.outputs.similar; - - Array - ( - [_id] => 00005b6b5361000000000000011b - [name] => Bern - [traits] => Array - ( - [0] => Friend - [1] => Brother - [2] => Human - ) - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/set.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/set.xml deleted file mode 100644 index 9eca3fd2aa5b..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/set.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - CollectionModify::set - Set document attribute - - - - &reftitle.description; - - public mysql_xdevapi\CollectionModifymysql_xdevapi\CollectionModify::set - stringcollection_field - stringexpression_or_literal - - - Sets or updates attributes on documents in a collection. - - - - - &reftitle.parameters; - - - collection_field - - - The document path (name) of the item to set. - - - - - expression_or_literal - - - The value to set it to. - - - - - - - - &reftitle.returnvalues; - - A CollectionModify object. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\CollectionModify::set</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -$result = $collection - ->add( - '{"name": "Bernie", - "traits": ["Friend", "Brother", "Human"]}') - ->execute(); - -$collection - ->modify("name = :name") - ->bind(['name' => 'Bernie']) - ->set("name", "Bern") - ->execute(); - -$result = $collection - ->find() - ->execute(); - -print_r($result->fetchAll()); -?> -]]> - - &example.outputs.similar; - - Array - ( - [_id] => 00005b6b53610000000000000111 - [name] => Bern - [traits] => Array - ( - [0] => Friend - [1] => Brother - [2] => Human - ) - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/skip.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/skip.xml deleted file mode 100644 index 2e006364cbf9..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/skip.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - CollectionModify::skip - Skip elements - - - - &reftitle.description; - - public mysql_xdevapi\CollectionModifymysql_xdevapi\CollectionModify::skip - intposition - - - Skips the first N elements that would otherwise be returned by a find operation. - If the number of elements skipped is larger than the size of the result set, - then the find operation returns an empty set. - - - - - &reftitle.parameters; - - - position - - - Number of elements to skip. - - - - - - - - &reftitle.returnvalues; - - A CollectionModify object to use for further processing. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\CollectionModify::skip</function> example - -modify('age > :age')->sort('age desc')->unset(['age'])->bind(['age' => 20])->limit(4)->skip(1)->execute(); - -?> -]]> - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/sort.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/sort.xml deleted file mode 100644 index 6bc4f9d2e5cd..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/sort.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - CollectionModify::sort - Set the sorting criteria - - - - &reftitle.description; - - public mysql_xdevapi\CollectionModifymysql_xdevapi\CollectionModify::sort - stringsort_expr - - - Sorts the result set by the field selected in the sort_expr argument. The allowed - orders are ASC (Ascending) or DESC (Descending). This operation is equivalent to the 'ORDER BY' SQL operation - and it follows the same set of rules. - - - - - &reftitle.parameters; - - - sort_expr - - - One or more sort expressions can be provided. The evaluation is from - left to right and each expression must be separated by a comma. - - - - - - - - &reftitle.returnvalues; - - CollectionModify object that can be used for further processing. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\CollectionModify::sort</function> example - -modify('true')->sort('name desc', 'age asc')->limit(4)->set('Married', 'NO')->execute(); - -?> -]]> - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/unset.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/unset.xml deleted file mode 100644 index 48f8f14672cc..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/unset.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - CollectionModify::unset - Unset the value of document fields - - - - &reftitle.description; - - public mysql_xdevapi\CollectionModifymysql_xdevapi\CollectionModify::unset - arrayfields - - - Removes attributes from documents in a collection. - - - - - &reftitle.parameters; - - - fields - - - The attributes to remove from documents in a collection. - - - - - - - - &reftitle.returnvalues; - - CollectionModify object that can be used for further processing. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\CollectionModify::unset</function> example - -modify('job like :job_name')->unset(["age", "name"])->bind(['job_name' => 'Plumber'])->execute(); - -?> -]]> - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionremove/bind.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionremove/bind.xml deleted file mode 100644 index 17e50ec9d9de..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionremove/bind.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - CollectionRemove::bind - Bind value to placeholder - - - - &reftitle.description; - - public mysql_xdevapi\CollectionRemovemysql_xdevapi\CollectionRemove::bind - arrayplaceholder_values - - - Bind a parameter to the placeholder in the search condition of the remove operation. - - - The placeholder has the form of :NAME where ':' is a common prefix that must always exists before any NAME - where NAME is the name of the placeholder. The bind method accepts a list of placeholders if multiple - entities have to be substituted in the search condition of the remove operation. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - placeholder_values - - - Placeholder values to substitute in the search condition. Multiple values are allowed - and have to be passed as an array of mappings PLACEHOLDER_NAME->PLACEHOLDER_VALUE. - - - - - - - - &reftitle.returnvalues; - - A CollectionRemove object that can be used to execute the command, or to add additional operations. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\CollectionRemove::bind</function> example - -remove('age > :age_from and age < :age_to')->bind(['age_from' => 20, 'age_to' => 50])->limit(7)->execute(); - -?> -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionremove/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionremove/construct.xml deleted file mode 100644 index 70b7e0ae22ef..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionremove/construct.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - CollectionRemove::__construct - CollectionRemove constructor - - - - &reftitle.description; - - private mysql_xdevapi\CollectionRemove::__construct - - - - Removes collection documents and is instantiated by the - mysql_xdevapi\Collection::remove method. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.examples; - - <function>mysql_xdevapi\Collection::remove</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -$collection->add('{"name": "Alfred", "age": 18, "job": "Butler"}')->execute(); -$collection->add('{"name": "Bob", "age": 19, "job": "Painter"}')->execute(); - -// Remove all painters -$collection - ->remove("job in ('Painter')") - ->execute(); - -// Remove the oldest butler -$collection - ->remove("job in ('Butler')") - ->sort('age desc') - ->limit(1) - ->execute(); - -// Remove record with lowest age -$collection - ->remove('true') - ->sort('age desc') - ->limit(1) - ->execute(); -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionremove/execute.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionremove/execute.xml deleted file mode 100644 index c61f65d1079b..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionremove/execute.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - CollectionRemove::execute - Execute remove operation - - - - &reftitle.description; - - public mysql_xdevapi\Resultmysql_xdevapi\CollectionRemove::execute - - - - The execute function needs to be invoked in order to trigger the client to send the CRUD operation request to the server. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Result object. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\CollectionRemove::execute</function> example - -remove('true')->sort('age desc')->limit(2)->execute(); - -?> -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionremove/limit.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionremove/limit.xml deleted file mode 100644 index 7ba407ece86e..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionremove/limit.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - CollectionRemove::limit - Limit number of documents to remove - - - - &reftitle.description; - - public mysql_xdevapi\CollectionRemovemysql_xdevapi\CollectionRemove::limit - introws - - - Sets the maximum number of documents to remove. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - rows - - - The maximum number of documents to remove. - - - - - - - - &reftitle.returnvalues; - - Returns a CollectionRemove object that can be used to execute the command, - or to add additional operations. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\CollectionRemove::limit</function> example - -remove('job in (\'Barista\', \'Programmatore\', \'Ballerino\', \'Programmatrice\')')->limit(5)->sort(['age desc', 'name asc'])->execute(); - -?> -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionremove/sort.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionremove/sort.xml deleted file mode 100644 index cd14ec6a275e..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionremove/sort.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - CollectionRemove::sort - Set the sorting criteria - - - - &reftitle.description; - - public mysql_xdevapi\CollectionRemovemysql_xdevapi\CollectionRemove::sort - stringsort_expr - - - Sort the result set by the field selected in the sort_expr argument. The allowed - orders are ASC (Ascending) or DESC (Descending). This operation is equivalent to the 'ORDER BY' SQL operation - and it follows the same set of rules. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - sort_expr - - - One or more sorting expressions can be provided. The evaluation is from left to right, - and each expression is separated by a comma. - - - - - - - - &reftitle.returnvalues; - - A CollectionRemove object that can be used to execute the command, or to add additional operations. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\CollectionRemove::sort</function> example - -remove('true')->sort('age desc')->limit(2)->execute(); - -?> -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/columnresult/construct.xml deleted file mode 100644 index 11b56891262e..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/construct.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - ColumnResult::__construct - ColumnResult constructor - - - - &reftitle.description; - - private mysql_xdevapi\ColumnResult::__construct - - - - Retrieves column metadata, such as its character set; this is instantiated - by the mysql_xdevapi\RowResult::getColumns method. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.examples; - - <function>mysql_xdevapi\ColumnResult::__construct</function> example - -sql("DROP DATABASE IF EXISTS nonsense")->execute(); -$session->sql("CREATE DATABASE nonsense")->execute(); -$session->sql("CREATE TABLE nonsense.numbers (hello int, world float unsigned)")->execute(); -$session->sql("INSERT INTO nonsense.numbers values (42, 42)")->execute(); - -$schema = $session->getSchema("nonsense"); -$table = $schema->getTable("numbers"); - -$result1 = $table->select('hello','world')->execute(); - -// Returns an array of ColumnResult objects -$columns = $result1->getColumns(); - -foreach ($columns as $column) { - echo "\nColumn label " , $column->getColumnLabel(); - echo " is type " , $column->getType(); - echo " and is ", ($column->isNumberSigned() === 0) ? "unsigned." : "signed."; -} - -// Alternatively -$result2 = $session->sql("SELECT * FROM nonsense.numbers")->execute(); - -// Returns an array of FieldMetadata objects -print_r($result2->getColumns()); -]]> - - &example.outputs.similar; - - mysql_xdevapi\FieldMetadata Object - ( - [type] => 1 - [type_name] => SINT - [name] => hello - [original_name] => hello - [table] => numbers - [original_table] => numbers - [schema] => nonsense - [catalog] => def - [collation] => 0 - [fractional_digits] => 0 - [length] => 11 - [flags] => 0 - [content_type] => 0 - ) - [1] => mysql_xdevapi\FieldMetadata Object - ( - [type] => 6 - [type_name] => FLOAT - [name] => world - [original_name] => world - [table] => numbers - [original_table] => numbers - [schema] => nonsense - [catalog] => def - [collation] => 0 - [fractional_digits] => 31 - [length] => 12 - [flags] => 1 - [content_type] => 0 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getcharactersetname.xml b/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getcharactersetname.xml deleted file mode 100644 index e2ceb9c31623..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getcharactersetname.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - ColumnResult::getCharacterSetName - Get character set - - - - &reftitle.description; - - public stringmysql_xdevapi\ColumnResult::getCharacterSetName - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - <function>mysql_xdevapi\ColumnResult::getCharacterSetName</function> example - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getcollationname.xml b/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getcollationname.xml deleted file mode 100644 index 9a3ea337f3ca..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getcollationname.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - ColumnResult::getCollationName - Get collation name - - - - &reftitle.description; - - public stringmysql_xdevapi\ColumnResult::getCollationName - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - <function>mysql_xdevapi\ColumnResult::getCollationName</function> example - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getcolumnlabel.xml b/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getcolumnlabel.xml deleted file mode 100644 index 2ef90221ecda..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getcolumnlabel.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - ColumnResult::getColumnLabel - Get column label - - - - &reftitle.description; - - public stringmysql_xdevapi\ColumnResult::getColumnLabel - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - <function>mysql_xdevapi\ColumnResult::getColumnLabel</function> example - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getcolumnname.xml b/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getcolumnname.xml deleted file mode 100644 index 701746b8d396..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getcolumnname.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - ColumnResult::getColumnName - Get column name - - - - &reftitle.description; - - public stringmysql_xdevapi\ColumnResult::getColumnName - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - <function>mysql_xdevapi\ColumnResult::getColumnName</function> example - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getfractionaldigits.xml b/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getfractionaldigits.xml deleted file mode 100644 index 70064d1c5664..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getfractionaldigits.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - ColumnResult::getFractionalDigits - Get fractional digit length - - - - &reftitle.description; - - public intmysql_xdevapi\ColumnResult::getFractionalDigits - - - - Fetch the number of fractional digits for column. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - <function>mysql_xdevapi\ColumnResult::getFractionalDigits</function> example - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getlength.xml b/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getlength.xml deleted file mode 100644 index ca3dab2d5f87..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getlength.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - ColumnResult::getLength - Get column field length - - - - &reftitle.description; - - public intmysql_xdevapi\ColumnResult::getLength - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - <function>mysql_xdevapi\ColumnResult::getLength</function> example - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getschemaname.xml b/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getschemaname.xml deleted file mode 100644 index ba0937baedae..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getschemaname.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - ColumnResult::getSchemaName - Get schema name - - - - &reftitle.description; - - public stringmysql_xdevapi\ColumnResult::getSchemaName - - - - Fetch the schema name where the column is stored. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - <function>mysql_xdevapi\ColumnResult::getSchemaName</function> example - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/gettablelabel.xml b/reference/mysql_xdevapi/mysql_xdevapi/columnresult/gettablelabel.xml deleted file mode 100644 index 10b284981498..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/gettablelabel.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - ColumnResult::getTableLabel - Get table label - - - - &reftitle.description; - - public stringmysql_xdevapi\ColumnResult::getTableLabel - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - <function>mysql_xdevapi\ColumnResult::getTableLabel</function> example - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/gettablename.xml b/reference/mysql_xdevapi/mysql_xdevapi/columnresult/gettablename.xml deleted file mode 100644 index bbcfb0d7d55b..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/gettablename.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - ColumnResult::getTableName - Get table name - - - - &reftitle.description; - - public stringmysql_xdevapi\ColumnResult::getTableName - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Name of the table for the column. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\ColumnResult::getTableName</function> example - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/gettype.xml b/reference/mysql_xdevapi/mysql_xdevapi/columnresult/gettype.xml deleted file mode 100644 index aef5b09fed24..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/gettype.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - ColumnResult::getType - Get column type - - - - &reftitle.description; - - public intmysql_xdevapi\ColumnResult::getType - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - <function>mysql_xdevapi\ColumnResult::getType</function> example - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/isnumbersigned.xml b/reference/mysql_xdevapi/mysql_xdevapi/columnresult/isnumbersigned.xml deleted file mode 100644 index b9d7c9567e06..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/isnumbersigned.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - ColumnResult::isNumberSigned - Check if signed type - - - - &reftitle.description; - - public intmysql_xdevapi\ColumnResult::isNumberSigned - - - - Retrieves a table's column information and is instantiated by the - mysql_xdevapi\RowResult::getColumns method. - - - &warn.undocumented.func; - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; if a given column has a signed type. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\ColumnResult::isNumberSigned</function> example - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/ispadded.xml b/reference/mysql_xdevapi/mysql_xdevapi/columnresult/ispadded.xml deleted file mode 100644 index d35395440257..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/ispadded.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - ColumnResult::isPadded - Check if padded - - - - &reftitle.description; - - public intmysql_xdevapi\ColumnResult::isPadded - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; if a given column is padded. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\ColumnResult::isPadded</function> example - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/crudoperationbindable/bind.xml b/reference/mysql_xdevapi/mysql_xdevapi/crudoperationbindable/bind.xml deleted file mode 100644 index 9b1e82990595..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/crudoperationbindable/bind.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - CrudOperationBindable::bind - Bind value to placeholder - - - - &reftitle.description; - - abstract public mysql_xdevapi\CrudOperationBindablemysql_xdevapi\CrudOperationBindable::bind - arrayplaceholder_values - - - Binds a value to a specific placeholder. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - placeholder_values - - - The name of the placeholders and the values to bind. - - - - - - - - &reftitle.returnvalues; - - A CrudOperationBindable object. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\CrudOperationBindable::bind</function> example - -modify('name like :name')->arrayInsert('job[0]', 'Calciatore')->bind(['name' => 'ENTITY'])->execute(); -$res = $table->delete()->orderby('age desc')->where('age < 20 and age > 12 and name != :name')->bind(['name' => 'Tierney'])->limit(2)->execute(); - -?> -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/crudoperationlimitable/limit.xml b/reference/mysql_xdevapi/mysql_xdevapi/crudoperationlimitable/limit.xml deleted file mode 100644 index a0c9da170b47..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/crudoperationlimitable/limit.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - CrudOperationLimitable::limit - Set result limit - - - - &reftitle.description; - - abstract public mysql_xdevapi\CrudOperationLimitablemysql_xdevapi\CrudOperationLimitable::limit - introws - - - Sets the maximum number of records or documents to return. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - rows - - - The maximum number of records or documents. - - - - - - - - &reftitle.returnvalues; - - A CrudOperationLimitable object. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\CrudOperationLimitable::limit</function> example - -find()->fields(['name as n','age as a','job as j'])->groupBy('j')->limit(11)->execute(); -$res = $table->update()->set('age',69)->where('age > 15 and age < 22')->limit(4)->orderby(['age asc','name desc'])->execute(); - -?> -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/crudoperationskippable/skip.xml b/reference/mysql_xdevapi/mysql_xdevapi/crudoperationskippable/skip.xml deleted file mode 100644 index 83b36aa131fe..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/crudoperationskippable/skip.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - CrudOperationSkippable::skip - Number of operations to skip - - - - &reftitle.description; - - abstract public mysql_xdevapi\CrudOperationSkippablemysql_xdevapi\CrudOperationSkippable::skip - intskip - - - Skip this number of records in the returned operation. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - skip - - - Number of elements to skip. - - - - - - - - &reftitle.returnvalues; - - A CrudOperationSkippable object. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\CrudOperationSkippable::skip</function> example - -find('job like \'Programmatore\'')->limit(1)->skip(3)->sort('age asc')->execute(); - -?> -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/crudoperationsortable/sort.xml b/reference/mysql_xdevapi/mysql_xdevapi/crudoperationsortable/sort.xml deleted file mode 100644 index e9c642eba348..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/crudoperationsortable/sort.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - CrudOperationSortable::sort - Sort results - - - - &reftitle.description; - - abstract public mysql_xdevapi\CrudOperationSortable - mysql_xdevapi\CrudOperationSortable::sort - stringsort_expr - - - Sort the result set by the field selected in the sort_expr argument. The allowed - orders are ASC (Ascending) or DESC (Descending). This operation is equivalent to the 'ORDER BY' SQL operation - and it follows the same set of rules. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - sort_expr - - - One or more sorting expressions can be provided. The evaluation is from left to right, - and each expression is separated by a comma. - - - - - - - - &reftitle.returnvalues; - - A CrudOperationSortable object. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\CrudOperationSortable::sort</function> example - -find('job like \'Cavia\'')->sort('age desc', '_id desc')->execute(); - -?> -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/databaseobject/existsindatabase.xml b/reference/mysql_xdevapi/mysql_xdevapi/databaseobject/existsindatabase.xml deleted file mode 100644 index 72c64326643f..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/databaseobject/existsindatabase.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - DatabaseObject::existsInDatabase - Check if object exists in database - - - - &reftitle.description; - - abstract public boolmysql_xdevapi\DatabaseObject::existsInDatabase - - - - Verifies if the database object refers to an object that exists in the database. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; if object exists in the database, else &false; if it does not. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\DatabaseObject::existsInDatabase</function> example - -existsInDatabase(); - -?> -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/databaseobject/getname.xml b/reference/mysql_xdevapi/mysql_xdevapi/databaseobject/getname.xml deleted file mode 100644 index c4e13be793c6..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/databaseobject/getname.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - DatabaseObject::getName - Get object name - - - - &reftitle.description; - - abstract public stringmysql_xdevapi\DatabaseObject::getName - - - - Fetch name of this database object. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The name of this database object. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\DatabaseObject::getName</function> example - -getName(); - -?> -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/databaseobject/getsession.xml b/reference/mysql_xdevapi/mysql_xdevapi/databaseobject/getsession.xml deleted file mode 100644 index 72afb71e41ce..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/databaseobject/getsession.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - DatabaseObject::getSession - Get session name - - - - &reftitle.description; - - abstract public mysql_xdevapi\Sessionmysql_xdevapi\DatabaseObject::getSession - - - - Fetch session associated to the database object. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The Session object. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\DatabaseObject::getSession</function> example - -getSession(); - -?> -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/docresult/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/docresult/construct.xml deleted file mode 100644 index 88551a9923c7..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/docresult/construct.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - DocResult::__construct - DocResult constructor - - - - &reftitle.description; - - private mysql_xdevapi\DocResult::__construct - - - - Fetch document results and warnings, - and is instantiated by CollectionFind. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.examples; - - A DocResult example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); - -$create->add('{"name": "Alfred", "age": 18, "job": "Butler"}')->execute(); -$create->add('{"name": "Reginald", "age": 42, "job": "Butler"}')->execute(); - -// ... - -$collection = $schema->getCollection("people"); - -// Yields a DocResult object -$result = $collection - ->find('job like :job and age > :age') - ->bind(['job' => 'Butler', 'age' => 16]) - ->sort('age desc') - ->limit(1) - ->execute(); - -var_dump($result->fetchAll()); -?> -]]> - - &example.outputs.similar; - - - array(4) { - ["_id"]=> - string(28) "00005b6b536100000000000000f3" - ["age"]=> - int(42) - ["job"]=> - string(6) "Butler" - ["name"]=> - string(8) "Reginald" - } -} -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/docresult/fetchall.xml b/reference/mysql_xdevapi/mysql_xdevapi/docresult/fetchall.xml deleted file mode 100644 index e1c1fdd946ff..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/docresult/fetchall.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - DocResult::fetchAll - Get all rows - - - - &reftitle.description; - - public arraymysql_xdevapi\DocResult::fetchAll - - - - Fetch all results from a result set. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A numerical array with all results from the query; each result is - an associative array. An empty array is returned if no - rows are present. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\DocResult::fetchAll</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); - -$create->add('{"name": "Alfred", "age": 18, "job": "Butler"}')->execute(); -$create->add('{"name": "Reginald", "age": 42, "job": "Butler"}')->execute(); - -// ... - -$collection = $schema->getCollection("people"); - -// Yields a DocResult object -$result = $collection - ->find('job like :job and age > :age') - ->bind(['job' => 'Butler', 'age' => 16]) - ->sort('age desc') - ->execute(); - -var_dump($result->fetchAll()); -?> -]]> - - &example.outputs.similar; - - - array(4) { - ["_id"]=> - string(28) "00005b6b53610000000000000123" - ["age"]=> - int(42) - ["job"]=> - string(6) "Butler" - ["name"]=> - string(8) "Reginald" - } - - [1]=> - array(4) { - ["_id"]=> - string(28) "00005b6b53610000000000000122" - ["age"]=> - int(18) - ["job"]=> - string(6) "Butler" - ["name"]=> - string(6) "Alfred" - } - -} -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/docresult/fetchone.xml b/reference/mysql_xdevapi/mysql_xdevapi/docresult/fetchone.xml deleted file mode 100644 index 42a0cf0ff54a..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/docresult/fetchone.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - DocResult::fetchOne - Get one row - - - - &reftitle.description; - - public arraymysql_xdevapi\DocResult::fetchOne - - - - Fetch one result from a result set. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The result, as an associative array - or &null; if no results are present. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\DocResult::fetchOne</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); - -$create->add('{"name": "Alfred", "age": 18, "job": "Butler"}')->execute(); -$create->add('{"name": "Reginald", "age": 42, "job": "Butler"}')->execute(); - -// ... - -$collection = $schema->getCollection("people"); - -// Yields a DocResult object -$result = $collection - ->find('job like :job and age > :age') - ->bind(['job' => 'Butler', 'age' => 16]) - ->sort('age desc') - ->execute(); - -var_dump($result->fetchOne()); -?> -]]> - - &example.outputs.similar; - - - string(28) "00005b6b53610000000000000125" - ["age"]=> - int(42) - ["job"]=> - string(6) "Butler" - ["name"]=> - string(8) "Reginald" -} -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/docresult/getwarnings.xml b/reference/mysql_xdevapi/mysql_xdevapi/docresult/getwarnings.xml deleted file mode 100644 index adcdebce17af..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/docresult/getwarnings.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - DocResult::getWarnings - Get warnings from last operation - - - - &reftitle.description; - - public Arraymysql_xdevapi\DocResult::getWarnings - - - - Fetches warnings generated by MySQL server's last operation. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - An array of Warning objects from the last operation. Each object - defines an error 'message', error 'level', and error 'code'. An empty - array is returned if no errors are present. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\DocResult::getWarnings</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); - -$create->add('{"name": "Alfred", "age": 18, "job": "Butler"}')->execute(); -$create->add('{"name": "Reginald", "age": 42, "job": "Butler"}')->execute(); - -// ... - -$collection = $schema->getCollection("people"); - -// Yields a DocResult object -$result = $collection - ->find('job like :job and age > :age') - ->bind(['job' => 'Butler', 'age' => 16]) - ->sort('age desc') - ->execute(); - -if (!$result->getWarningsCount()) { - echo "There was an error:\n"; - print_r($result->getWarnings()); - exit; -} - -var_dump($result->fetchOne()); -?> -]]> - - &example.outputs.similar; - - mysql_xdevapi\Warning Object - ( - [message] => Something bad and so on - [level] => 2 - [code] => 1365 - ) - [1] => mysql_xdevapi\Warning Object - ( - [message] => Something bad and so on - [level] => 2 - [code] => 1365 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/docresult/getwarningscount.xml b/reference/mysql_xdevapi/mysql_xdevapi/docresult/getwarningscount.xml deleted file mode 100644 index 2da360f981b9..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/docresult/getwarningscount.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - DocResult::getWarningsCount - Get warning count from last operation - - - - &reftitle.description; - - public intmysql_xdevapi\DocResult::getWarningsCount - - - - Returns the number of warnings raised by the last operation. Specifically, - these warnings are raised by the MySQL server. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The number of warnings from the last operation. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\DocResult::getWarningsCount</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); - -$create->add('{"name": "Alfred", "age": 18, "job": "Butler"}')->execute(); -$create->add('{"name": "Reginald", "age": 42, "job": "Butler"}')->execute(); - -// ... - -$collection = $schema->getCollection("people"); - -// Yields a DocResult object -$result = $collection - ->find('job like :job and age > :age') - ->bind(['job' => 'Butler', 'age' => 16]) - ->sort('age desc') - ->execute(); - -if (!$result->getWarningsCount()) { - echo "There was an error:\n"; - print_r($result->getWarnings()); - exit; -} - -var_dump($result->fetchOne()); -?> -]]> - - &example.outputs.similar; - - - string(28) "00005b6b53610000000000000135" - ["age"]=> - int(42) - ["job"]=> - string(6) "Butler" - ["name"]=> - string(8) "Reginald" -} -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/executable/execute.xml b/reference/mysql_xdevapi/mysql_xdevapi/executable/execute.xml deleted file mode 100644 index 77a620df0541..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/executable/execute.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - Executable::execute - Execute statement - - - - &reftitle.description; - - abstract public mysql_xdevapi\Resultmysql_xdevapi\Executable::execute - - - - Execute the statement from either a collection operation or a table query; - this functionality allows for method chaining. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - One of the Result objects, such as Result or SqlStatementResult. - - - - - &reftitle.examples; - - execute() examples - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$result_sql = $session->sql("CREATE DATABASE addressbook")->execute(); - -var_dump($result_sql); - - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("humans"); - -$result_collection = $collection->add( - '{"name": "Jane", - "jobs": [{"title":"Scientist","Salary":18000}, {"title":"Mother","Salary":0}], - "hobbies": ["Walking","Making pies"]}'); - -$result_collection_executed = $result_collection->execute(); - -var_dump($result_collection); -var_dump($result_collection_executed); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/executionstatus/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/executionstatus/construct.xml deleted file mode 100644 index a5f80923998c..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/executionstatus/construct.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - ExecutionStatus::__construct - ExecutionStatus constructor - - - - &reftitle.description; - - private mysql_xdevapi\ExecutionStatus::__construct - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - - &reftitle.examples; - - <function>mysql_xdevapi\ExecutionStatus::__construct</function> example - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/expression/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/expression/construct.xml deleted file mode 100644 index e7578e1bb75e..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/expression/construct.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Expression::__construct - Expression constructor - - - - &reftitle.description; - - public mysql_xdevapi\Expression::__construct - stringexpression - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - expression - - - - - - - - - - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Expression::__construct</function> example - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/result/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/result/construct.xml deleted file mode 100644 index 27a19c014fbf..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/result/construct.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - Result::__construct - Result constructor - - - - &reftitle.description; - - private mysql_xdevapi\Result::__construct - - - - An object that retrieves generated IDs, AUTO_INCREMENT values, and warnings, - for a Result set. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.examples; - - <function>mysql_xdevapi\Result::__construct</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql(" - CREATE TABLE addressbook.names - (id INT NOT NULL AUTO_INCREMENT, name VARCHAR(30), age INT, PRIMARY KEY (id)) - ")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$result = $table->insert("name", "age")->values(["Suzanne", 31],["Julie", 43])->execute(); -$result = $table->insert("name", "age")->values(["Suki", 34])->execute(); - -$ai = $result->getAutoIncrementValue(); -var_dump($ai); -?> -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/result/getaffecteditemscount.xml b/reference/mysql_xdevapi/mysql_xdevapi/result/getaffecteditemscount.xml deleted file mode 100644 index e1fe71a3de8d..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/result/getaffecteditemscount.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - Result::getAffectedItemsCount - Get affected row count - - - - &reftitle.description; - - public intmysql_xdevapi\Result::getAffectedItemsCount - - - - Get the number of affected rows by the previous operation. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The number (as an integer) of affected rows. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Result::getAffectedItemsCount</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); - -$collection = $schema->getCollection("people"); - -$result = $collection->add('{"name": "Wilma", "age": 23, "job": "Teacher"}')->execute(); - -var_dump( $res->getAffectedItemsCount() ); -?> -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/result/getautoincrementvalue.xml b/reference/mysql_xdevapi/mysql_xdevapi/result/getautoincrementvalue.xml deleted file mode 100644 index 9b62b24a5db9..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/result/getautoincrementvalue.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - Result::getAutoIncrementValue - Get autoincremented value - - - - &reftitle.description; - - public intmysql_xdevapi\Result::getAutoIncrementValue - - - - Get the last AUTO_INCREMENT value (last insert id). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The last AUTO_INCREMENT value. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Result::getAutoIncrementValue</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql(" - CREATE TABLE addressbook.names - (id INT NOT NULL AUTO_INCREMENT, name VARCHAR(30), age INT, PRIMARY KEY (id)) - ")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$result = $table->insert("name", "age")->values(["Suzanne", 31],["Julie", 43])->execute(); -$result = $table->insert("name", "age")->values(["Suki", 34])->execute(); - -$ai = $result->getAutoIncrementValue(); -var_dump($ai); -?> -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/result/getgeneratedids.xml b/reference/mysql_xdevapi/mysql_xdevapi/result/getgeneratedids.xml deleted file mode 100644 index f947c36ab97a..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/result/getgeneratedids.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - Result::getGeneratedIds - Get generated ids - - - - &reftitle.description; - - public arraymysql_xdevapi\Result::getGeneratedIds - - - - Fetch the generated _id values from the last operation. - The unique _id field is generated by the MySQL server. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - An array of generated _id's from the last operation, - or an empty array if there are none. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Result::getGeneratedIds</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); - -$collection = $schema->getCollection("people"); - -$result = $collection->add( - '{"name": "Bernie", - "jobs": [{"title":"Cat Herder","Salary":42000}, {"title":"Father","Salary":0}], - "hobbies": ["Sports","Making cupcakes"]}', - '{"name": "Jane", - "jobs": [{"title":"Scientist","Salary":18000}, {"title":"Mother","Salary":0}], - "hobbies": ["Walking","Making pies"]}')->execute(); - -$ids = $result->getGeneratedIds(); -var_dump($ids); -?> -]]> - - &example.outputs.similar; - - - string(28) "00005b6b53610000000000000064" - [1]=> - string(28) "00005b6b53610000000000000065" -} -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/result/getwarnings.xml b/reference/mysql_xdevapi/mysql_xdevapi/result/getwarnings.xml deleted file mode 100644 index 2271b26339b1..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/result/getwarnings.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - Result::getWarnings - Get warnings from last operation - - - - &reftitle.description; - - public arraymysql_xdevapi\Result::getWarnings - - - - Retrieve warnings from the last Result operation. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - An array of Warning objects from the last operation. Each object - defines an error 'message', error 'level', and error 'code'. An - empty array is returned if no errors are present. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\RowResult::getWarnings</function> example - -sql("CREATE DATABASE foo")->execute(); -$session->sql("CREATE TABLE foo.test_table(x int)")->execute(); - -$schema = $session->getSchema("foo"); -$table = $schema->getTable("test_table"); - -$table->insert(['x'])->values([1])->values([2])->execute(); - -$res = $table->select(['x/0 as bad_x'])->execute(); -$warnings = $res->getWarnings(); - -print_r($warnings); -?> -]]> - - &example.outputs.similar; - - mysql_xdevapi\Warning Object - ( - [message] => Division by 0 - [level] => 2 - [code] => 1365 - ) - [1] => mysql_xdevapi\Warning Object - ( - [message] => Division by 0 - [level] => 2 - [code] => 1365 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/result/getwarningscount.xml b/reference/mysql_xdevapi/mysql_xdevapi/result/getwarningscount.xml deleted file mode 100644 index ac7a3077733a..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/result/getwarningscount.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - Result::getWarningsCount - Get warning count from last operation - - - - &reftitle.description; - - public intmysql_xdevapi\Result::getWarningsCount - - - - Retrieve the number of warnings from the last Result operation. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The number of warnings generated by the last operation. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\RowResult::getWarningsCount</function> example - -sql("DROP DATABASE IF EXISTS foo")->execute(); -$session->sql("CREATE DATABASE foo")->execute(); -$session->sql("CREATE TABLE foo.test_table(x int)")->execute(); - -$schema = $session->getSchema("foo"); -$table = $schema->getTable("test_table"); - -$table->insert(['x'])->values([1])->values([2])->execute(); - -$res = $table->select(['x/0 as bad_x'])->execute(); - -echo $res->getWarningsCount(); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/rowresult/construct.xml deleted file mode 100644 index 8f41e374f695..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/construct.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - RowResult::__construct - RowResult constructor - - - - &reftitle.description; - - private mysql_xdevapi\RowResult::__construct - - - - Represents the result set obtained from querying the database. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.examples; - - <function>mysql_xdevapi\RowResult::__construct</function> example - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$row = $table->select('name', 'age')->where('age > 18')->execute()->fetchAll(); - -print_r($row); -]]> - - &example.outputs.similar; - - Array - ( - [name] => John - [age] => 42 - ) - [1] => Array - ( - [name] => Sam - [age] => 33 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/fetchall.xml b/reference/mysql_xdevapi/mysql_xdevapi/rowresult/fetchall.xml deleted file mode 100644 index 44762f8afacd..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/fetchall.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - RowResult::fetchAll - Get all rows from result - - - - &reftitle.description; - - public arraymysql_xdevapi\RowResult::fetchAll - - - - Fetch all the rows from the result set. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A numerical array with all results from the query; each result is - an associative array. An empty array is returned if no - rows are present. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\RowResult::fetchAll</function> example - -sql("DROP DATABASE addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$row = $table->select('name', 'age')->execute()->fetchAll(); - -print_r($row); -]]> - - &example.outputs.similar; - - Array - ( - [name] => John - [age] => 42 - ) - [1] => Array - ( - [name] => Sam - [age] => 33 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/fetchone.xml b/reference/mysql_xdevapi/mysql_xdevapi/rowresult/fetchone.xml deleted file mode 100644 index 68f29b7c4107..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/fetchone.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - RowResult::fetchOne - Get row from result - - - - &reftitle.description; - - public arraymysql_xdevapi\RowResult::fetchOne - - - - Fetch one result from the result set. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The result, as an associative array - or &null; if no results are present. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\RowResult::fetchOne</function> example - -sql("DROP DATABASE addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$row = $table->select('name', 'age')->where('age < 40')->execute()->fetchOne(); - -print_r($row); -]]> - - &example.outputs.similar; - - Sam - [age] => 33 -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getcolumncount.xml b/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getcolumncount.xml deleted file mode 100644 index c52e404899cb..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getcolumncount.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - RowResult::getColumnsCount - Get column count - - - - &reftitle.description; - - public intmysql_xdevapi\RowResult::getColumnsCount - - - - Retrieve the column count for columns present in the result set. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The number of columns; 0 if there are none. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - 8.0.14 - - Method renamed from getColumnCount() to getColumnsCount(). - - - - - - - - - &reftitle.examples; - - <function>mysql_xdevapi\RowResult::getColumnsCount</function> example - -sql("DROP DATABASE addressbook")->execute(); -$session->sql("CREATE DATABASE foo")->execute(); -$session->sql("CREATE TABLE foo.test_table(x int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$sql = $session->sql("SELECT * from addressbook.names")->execute(); - -echo $sql->getColumnsCount(); -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getcolumnnames.xml b/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getcolumnnames.xml deleted file mode 100644 index f33515f7bfbc..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getcolumnnames.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - RowResult::getColumnNames - Get all column names - - - - &reftitle.description; - - public arraymysql_xdevapi\RowResult::getColumnNames - - - - Retrieve column names for columns present in the result set. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A numerical array of table columns names, - or an empty array if the result set is empty. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\RowResult::getColumnNames</function> example - -sql("DROP DATABASE addressbook")->execute(); -$session->sql("CREATE DATABASE foo")->execute(); -$session->sql("CREATE TABLE foo.test_table(x int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$sql = $session->sql("SELECT * from addressbook.names")->execute(); - -$colnames = $sql->getColumnNames(); - -print_r($colnames); -]]> - - &example.outputs.similar; - - name - [1] => age -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getcolumns.xml b/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getcolumns.xml deleted file mode 100644 index f98ea68549f6..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getcolumns.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - RowResult::getColumns - Get column metadata - - - - &reftitle.description; - - public arraymysql_xdevapi\RowResult::getColumns - - - - Retrieve column metadata for columns present in the result set. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - An array of FieldMetadata objects representing the columns in the result, - or an empty array if the result set is empty. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\RowResult::getColumns</function> example - -sql("DROP DATABASE addressbook")->execute(); -$session->sql("CREATE DATABASE foo")->execute(); -$session->sql("CREATE TABLE foo.test_table(x int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$sql = $session->sql("SELECT * from addressbook.names")->execute(); - -$cols = $sql->getColumns(); - -print_r($cols); -]]> - - &example.outputs.similar; - - mysql_xdevapi\FieldMetadata Object - ( - [type] => 7 - [type_name] => BYTES - [name] => name - [original_name] => name - [table] => names - [original_table] => names - [schema] => addressbook - [catalog] => def - [collation] => 255 - [fractional_digits] => 0 - [length] => 65535 - [flags] => 0 - [content_type] => 0 - ) - [1] => mysql_xdevapi\FieldMetadata Object - ( - [type] => 1 - [type_name] => SINT - [name] => age - [original_name] => age - [table] => names - [original_table] => names - [schema] => addressbook - [catalog] => def - [collation] => 0 - [fractional_digits] => 0 - [length] => 11 - [flags] => 0 - [content_type] => 0 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getwarnings.xml b/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getwarnings.xml deleted file mode 100644 index a6bbe8f423c3..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getwarnings.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - RowResult::getWarnings - Get warnings from last operation - - - - &reftitle.description; - - public arraymysql_xdevapi\RowResult::getWarnings - - - - Retrieve warnings from the last RowResult operation. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - An array of Warning objects from the last operation. Each object - defines an error 'message', error 'level', and error 'code'. An empty - array is returned if no errors are present. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\RowResult::getWarnings</function> example - -sql("CREATE DATABASE foo")->execute(); -$session->sql("CREATE TABLE foo.test_table(x int)")->execute(); - -$schema = $session->getSchema("foo"); -$table = $schema->getTable("test_table"); - -$table->insert(['x'])->values([1])->values([2])->execute(); - -$res = $table->select(['x/0 as bad_x'])->execute(); -$warnings = $res->getWarnings(); - -print_r($warnings); -?> -]]> - - &example.outputs.similar; - - mysql_xdevapi\Warning Object - ( - [message] => Division by 0 - [level] => 2 - [code] => 1365 - ) - [1] => mysql_xdevapi\Warning Object - ( - [message] => Division by 0 - [level] => 2 - [code] => 1365 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getwarningscount.xml b/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getwarningscount.xml deleted file mode 100644 index 7b4d5daee828..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getwarningscount.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - RowResult::getWarningsCount - Get warning count from last operation - - - - &reftitle.description; - - public intmysql_xdevapi\RowResult::getWarningsCount - - - - Retrieve the number of warnings from the last RowResult operation. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The number of warnings generated by the last operation. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\RowResult::getWarningsCount</function> example - -sql("DROP DATABASE IF EXISTS foo")->execute(); -$session->sql("CREATE DATABASE foo")->execute(); -$session->sql("CREATE TABLE foo.test_table(x int)")->execute(); - -$schema = $session->getSchema("foo"); -$table = $schema->getTable("test_table"); - -$table->insert(['x'])->values([1])->values([2])->execute(); - -$res = $table->select(['x/0 as bad_x'])->execute(); - -echo $res->getWarningsCount(); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/schema/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/schema/construct.xml deleted file mode 100644 index c343f3145ef8..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/schema/construct.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - Schema::__construct - Schema constructor - - - - &reftitle.description; - - private mysql_xdevapi\Schema::__construct - - - - The Schema object provides full access to the schema (database). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.examples; - - <methodname>mysql_xdevapi\Schema::__construct</methodname> example - -sql("DROP DATABASE IF EXISTS food")->execute(); -$session->sql("CREATE DATABASE food")->execute(); -$session->sql("CREATE TABLE food.fruit(name text, rating text)")->execute(); - -$schema = $session->getSchema("food"); -$schema->createCollection("trees"); - -print_r($schema->gettables()); -print_r($schema->getcollections()); -]]> - - &example.outputs.similar; - - mysql_xdevapi\Table Object - ( - [name] => fruit - ) -) -Array -( - [trees] => mysql_xdevapi\Collection Object - ( - [name] => trees - ) -) -]]> - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/schema/createcollection.xml b/reference/mysql_xdevapi/mysql_xdevapi/schema/createcollection.xml deleted file mode 100644 index 939f0472ee6d..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/schema/createcollection.xml +++ /dev/null @@ -1,166 +0,0 @@ - - - - - Schema::createCollection - Add collection to schema - - - - &reftitle.description; - - public mysql_xdevapi\Collectionmysql_xdevapi\Schema::createCollection - stringname - stringvalidate - - - Create a collection within the schema. - - - - - &reftitle.parameters; - - - name - - - Collection name. - - - - - validate - - - Validation definition, as a JSON object. - - - - - - - - &reftitle.returnvalues; - - The Collection object. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - 8.0.20 - - Added the optional validate parameter. - - - - - - - - - &reftitle.examples; - - <methodname>mysql_xdevapi\Schema::createCollection</methodname> example - -sql("DROP DATABASE IF EXISTS food")->execute(); -$session->sql("CREATE DATABASE food")->execute(); -$session->sql("CREATE TABLE food.fruit(name text, rating text)")->execute(); - -$schema = $session->getSchema("food"); -$schema->createCollection("trees"); - -print_r($schema->gettables()); -print_r($schema->getcollections()); -]]> - - &example.outputs.similar; - - mysql_xdevapi\Table Object - ( - [name] => fruit - ) -) -Array -( - [trees] => mysql_xdevapi\Collection Object - ( - [name] => trees - ) -) -]]> - - - - <methodname>mysql_xdevapi\Schema::createCollection</methodname> example - - createCollection("mycollection", '{ - "validation": { - "level": "strict", - "schema": { - "id": "http://json-schema.org/geo", - "description": "A geographical coordinate", - "type": "object", - "properties": { - "latitude": { - "type": "number" - }, - "longitude": { - "type": "number" - } - }, - "required": ["latitude", "longitude"] - } - } -}'); -// Succeeds -$collection->add('{"latitude": 10, "longitude": 20}')->execute(); - -// Fails, invalid types (not numbers) -$collection->add('{"latitude": "lat", "longitude": "long"}')->execute(); -]]> - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/schema/dropcollection.xml b/reference/mysql_xdevapi/mysql_xdevapi/schema/dropcollection.xml deleted file mode 100644 index faca6cd1babd..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/schema/dropcollection.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - Schema::dropCollection - Drop collection from schema - - - - &reftitle.description; - - public boolmysql_xdevapi\Schema::dropCollection - stringcollection_name - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - collection_name - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - <methodname>mysql_xdevapi\Schema::dropCollection</methodname> example - -sql("DROP DATABASE IF EXISTS food")->execute(); -$session->sql("CREATE DATABASE food")->execute(); -$session->sql("CREATE TABLE food.fruit(name text, rating text)")->execute(); - -$schema = $session->getSchema("food"); - -$schema->createCollection("trees"); -$schema->dropCollection("trees"); -$schema->createCollection("buildings"); - -print_r($schema->gettables()); -print_r($schema->getcollections()); -]]> - - &example.outputs.similar; - - mysql_xdevapi\Table Object - ( - [name] => fruit - ) -) -Array -( - [buildings] => mysql_xdevapi\Collection Object - ( - [name] => buildings - ) -) -]]> - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/schema/existsindatabase.xml b/reference/mysql_xdevapi/mysql_xdevapi/schema/existsindatabase.xml deleted file mode 100644 index 7ce35ed3979b..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/schema/existsindatabase.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - Schema::existsInDatabase - Check if exists in database - - - - &reftitle.description; - - public boolmysql_xdevapi\Schema::existsInDatabase - - - - Checks if the current object (schema, table, collection, or view) exists - in the schema object. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; if the schema, table, collection, or view still exists in the schema, else &false;. - - - - - &reftitle.examples; - - <methodname>mysql_xdevapi\Schema::existsInDatabase</methodname> example - -sql("DROP DATABASE IF EXISTS food")->execute(); -$session->sql("CREATE DATABASE food")->execute(); -$session->sql("CREATE TABLE food.fruit(name text, rating text)")->execute(); - -$schema = $session->getSchema("food"); -$schema->createCollection("trees"); - -// ... - -$trees = $schema->getCollection("trees"); - -// ... - -// Is this collection still in the database (schema)? -if ($trees->existsInDatabase()) { - echo "Yes, the 'trees' collection is still present."; -} -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/schema/getcollection.xml b/reference/mysql_xdevapi/mysql_xdevapi/schema/getcollection.xml deleted file mode 100644 index aba236ade36c..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/schema/getcollection.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - Schema::getCollection - Get collection from schema - - - - &reftitle.description; - - public mysql_xdevapi\Collectionmysql_xdevapi\Schema::getCollection - stringname - - - Get a collection from the schema. - - - - - &reftitle.parameters; - - - name - - - Collection name to retrieve. - - - - - - - - &reftitle.returnvalues; - - The Collection object for the selected collection. - - - - - &reftitle.examples; - - <methodname>mysql_xdevapi\Schema::getCollection</methodname> example - -sql("DROP DATABASE IF EXISTS food")->execute(); -$session->sql("CREATE DATABASE food")->execute(); - -$schema = $session->getSchema("food"); -$schema->createCollection("trees"); - -// ... - -$trees = $schema->getCollection("trees"); - -var_dump($trees); -]]> - - &example.outputs.similar; - - - string(5) "trees" -} -]]> - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/schema/getcollectionastable.xml b/reference/mysql_xdevapi/mysql_xdevapi/schema/getcollectionastable.xml deleted file mode 100644 index a5cd83018d1a..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/schema/getcollectionastable.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - Schema::getCollectionAsTable - Get collection as a Table object - - - - &reftitle.description; - - public mysql_xdevapi\Tablemysql_xdevapi\Schema::getCollectionAsTable - stringname - - - Get a collection, but as a Table object instead of a Collection object. - - - - - &reftitle.parameters; - - - name - - - Name of the collection to instantiate a Table object from. - - - - - - - - &reftitle.returnvalues; - - A mysql_xdevapi\Table object for the collection. - - - - - &reftitle.examples; - - <methodname>mysql_xdevapi\Schema::getCollectionAsTable</methodname> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collect = $schema->createCollection("people"); -$collect->add('{"name": "Fred", "age": 21, "job": "Construction"}')->execute(); -$collect->add('{"name": "Wilma", "age": 23, "job": "Teacher"}')->execute(); - -$table = $schema->getCollectionAsTable("people"); -$collection = $schema->getCollection("people"); - -var_dump($table); -var_dump($collection); -]]> - - &example.outputs.similar; - - - string(6) "people" -} - -object(mysql_xdevapi\Collection)#5 (1) { - ["name"]=> - string(6) "people" -} -]]> - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/schema/getcollections.xml b/reference/mysql_xdevapi/mysql_xdevapi/schema/getcollections.xml deleted file mode 100644 index 5be8091cca2e..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/schema/getcollections.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - Schema::getCollections - Get all schema collections - - - - &reftitle.description; - - public arraymysql_xdevapi\Schema::getCollections - - - - Fetch a list of collections for this schema. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Array of all collections in this schema, where each array element - value is a Collection object with the collection name as the key. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Schema::getCollections</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collect = $schema->createCollection("people"); -$collect->add('{"name": "Fred", "age": 21, "job": "Construction"}')->execute(); -$collect->add('{"name": "Wilma", "age": 23, "job": "Teacher"}')->execute(); - -$collections = $schema->getCollections(); -var_dump($collections); -?> -]]> - - &example.outputs.similar; - - - object(mysql_xdevapi\Collection)#4 (1) { - ["name"]=> - string(6) "people" - } -} -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/schema/getname.xml b/reference/mysql_xdevapi/mysql_xdevapi/schema/getname.xml deleted file mode 100644 index d8bd4a925483..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/schema/getname.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - Schema::getName - Get schema name - - - - &reftitle.description; - - public stringmysql_xdevapi\Schema::getName - - - - Get the name of the schema. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The name of the schema connected to the schema object, as a string. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Schema::getName</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); - -// ... - -var_dump($schema->getName()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/schema/getsession.xml b/reference/mysql_xdevapi/mysql_xdevapi/schema/getsession.xml deleted file mode 100644 index 0e3f4082680d..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/schema/getsession.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Schema::getSession - Get schema session - - - - &reftitle.description; - - public mysql_xdevapi\Sessionmysql_xdevapi\Schema::getSession - - - - Get a new Session object from the Schema object. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A Session object. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Schema::getSession</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); - -// ... - -$newsession = $schema->getSession(); - -var_dump($session); -var_dump($newsession); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/schema/gettable.xml b/reference/mysql_xdevapi/mysql_xdevapi/schema/gettable.xml deleted file mode 100644 index 90f76535519c..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/schema/gettable.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - Schema::getTable - Get schema table - - - - &reftitle.description; - - public mysql_xdevapi\Tablemysql_xdevapi\Schema::getTable - stringname - - - Fetch a Table object for the provided table in the schema. - - - - - &reftitle.parameters; - - - name - - - Name of the table. - - - - - - - - &reftitle.returnvalues; - - A Table object. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Schema::getTable</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$row = $table->select('name', 'age')->execute()->fetchAll(); - -print_r($row); -?> -]]> - - &example.outputs.similar; - - Array - ( - [name] => John - [age] => 42 - ) - [1] => Array - ( - [name] => Sam - [age] => 33 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/schema/gettables.xml b/reference/mysql_xdevapi/mysql_xdevapi/schema/gettables.xml deleted file mode 100644 index 9ae5812560b5..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/schema/gettables.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Schema::getTables - Get schema tables - - - - &reftitle.description; - - public arraymysql_xdevapi\Schema::getTables - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Array of all tables in this schema, where each array element - value is a Table object with the table name as the key. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Schema::getTables</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$session->sql("CREATE TABLE addressbook.cities(name text, population int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('Portland', 639863), ('Seattle', 704352)")->execute(); - -$schema = $session->getSchema("addressbook"); -$tables = $schema->getTables(); - -var_dump($tables); -?> -]]> - - &example.outputs.similar; - - - object(mysql_xdevapi\Table)#3 (1) { - ["name"]=> - string(6) "cities" - } - - ["names"]=> - object(mysql_xdevapi\Table)#4 (1) { - ["name"]=> - string(5) "names" - } -} -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/schemaobject/getschema.xml b/reference/mysql_xdevapi/mysql_xdevapi/schemaobject/getschema.xml deleted file mode 100644 index 0e5a94a9d00d..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/schemaobject/getschema.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - SchemaObject::getSchema - Get schema object - - - - &reftitle.description; - - abstract mysql_xdevapi\Schemamysql_xdevapi\SchemaObject::getSchema - - - - Used by other objects to retrieve a schema object. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The current Schema object. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Session::getSchema</function> example - -getSchema("addressbook"); - -print_r($schema); -]]> - - &example.outputs.similar; - - addressbook -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/close.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/close.xml deleted file mode 100644 index 61d28582e0c5..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/close.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - Session::close - Close session - - - - &reftitle.description; - - public boolmysql_xdevapi\Session::close - - - - Close the session with the server. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; if the session closed. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Session::close</function> example - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$session->close(); -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/commit.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/commit.xml deleted file mode 100644 index 5d919b81b80c..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/commit.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - Session::commit - Commit transaction - - - - &reftitle.description; - - public Objectmysql_xdevapi\Session::commit - - - - Commit the transaction. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - An SqlStatementResult object. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Session::commit</function> example - -getSchema("addressbook")->getCollection("friends"); - -$session->startTransaction(); - -$collection->add('{"John":42, "Sam":33}')->execute(); -$savepoint = $session->setSavepoint(); - -$session->commit(); -$session->close(); -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/construct.xml deleted file mode 100644 index b923d422e56a..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/construct.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - Session::__construct - Description constructor - - - - &reftitle.description; - - private mysql_xdevapi\Session::__construct - - - - A Session object, as initiated by getSession(). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.examples; - - <function>mysql_xdevapi\Session::__construct</function> example - -close(); -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/createschema.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/createschema.xml deleted file mode 100644 index 37b0c047f7e5..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/createschema.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - Session::createSchema - Create new schema - - - - &reftitle.description; - - public mysql_xdevapi\Schemamysql_xdevapi\Session::createSchema - stringschema_name - - - Creates a new schema. - - - - - &reftitle.parameters; - - - schema_name - - - Name of the schema to create. - - - - - - - - - &reftitle.returnvalues; - - A Schema object on success, and emits an exception on failure. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Session::createSchema</function> example - -createSchema('fruit')) { - echo "Info: I created a schema named 'fruit'\n"; - } - -} catch (Exception $e) { - - echo $e->getMessage(); - -} -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/dropschema.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/dropschema.xml deleted file mode 100644 index cc5684082e09..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/dropschema.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - Session::dropSchema - Drop a schema - - - - &reftitle.description; - - public boolmysql_xdevapi\Session::dropSchema - stringschema_name - - - Drop a schema (database). - - - - - &reftitle.parameters; - - - schema_name - - - Name of the schema to drop. - - - - - - - - &reftitle.returnvalues; - - &true; if the schema is dropped, or &false; if it does not exist - or can't be dropped. - - - An E_WARNING level error is generated if the - schema does not exist. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Session::dropSchema</function> example - -dropSchema("addressbook"); - -$session->close(); -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/generateuuid.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/generateuuid.xml deleted file mode 100644 index 9f52d6c93da7..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/generateuuid.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - Session::generateUUID - Get new UUID - - - - &reftitle.description; - - public stringmysql_xdevapi\Session::generateUUID - - - - Generate a Universal Unique IDentifier (UUID) generated according to - RFC 4122. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The UUID; a string with a length of 32. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Session::generateUuid</function> example - -generateUuid(); - -var_dump($uuid); -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/getdefaultschema.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/getdefaultschema.xml deleted file mode 100755 index ba8c9b4bdcee..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/getdefaultschema.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - Session::getDefaultSchema - Get default schema name - - - - &reftitle.description; - - public mysql_xdevapi\Schemanullmysql_xdevapi\Session::getDefaultSchema - - - - Retrieve the default schema that's typically set in the connection URI. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The default schema defined by the connection, or &null; if one was not set. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Session::getSchema</function> example - -getDefaultSchema(); -echo $schema->getName(); -?> -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/getschema.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/getschema.xml deleted file mode 100644 index c2a0aea4cbe0..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/getschema.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Session::getSchema - Get a new schema object - - - - &reftitle.description; - - public mysql_xdevapi\Schemamysql_xdevapi\Session::getSchema - stringschema_name - - - A new Schema object for the provided schema name. - - - - - &reftitle.parameters; - - - schema_name - - - Name of the schema (database) to fetch a Schema object for. - - - - - - - - &reftitle.returnvalues; - - A Schema object. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Session::getSchema</function> example - -getSchema("addressbook"); - -print_r($schema); -]]> - - &example.outputs.similar; - - addressbook -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/getschemas.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/getschemas.xml deleted file mode 100644 index 246337c5be9e..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/getschemas.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Session::getSchemas - Get the schemas - - - - &reftitle.description; - - public arraymysql_xdevapi\Session::getSchemas - - - - Get schema objects for all schemas available to the session. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - An array containing objects that represent all of the schemas - available to the session. - - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Session::getSchemas</function> example - -getSchemas(); - -print_r($schemas); -]]> - - &example.outputs.similar; - - mysql_xdevapi\Schema Object - ( - [name] => addressbook - ) - [1] => mysql_xdevapi\Schema Object - ( - [name] => information_schema - ) - ... -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/getserverversion.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/getserverversion.xml deleted file mode 100644 index 72abd99be953..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/getserverversion.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - Session::getServerVersion - Get server version - - - - &reftitle.description; - - public intmysql_xdevapi\Session::getServerVersion - - - - Retrieve the MySQL server version for the session. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The MySQL server version for the session, as an integer such as "80012". - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Session::getServerVersion</function> example - -getServerVersion(); - -var_dump($version); -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/listclients.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/listclients.xml deleted file mode 100644 index 94b702b2c3e6..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/listclients.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - Session::listClients - Get client list - - - - &reftitle.description; - - public arraymysql_xdevapi\Session::listClients - - - - Get a list of client connections to the session's MySQL server. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - An array containing the currently logged clients. The array - elements are "client_id", "user", "host", and "sql_session". - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Session::listClients</function> example - -listClients(); - -var_dump($ids); -?> -]]> - - &example.outputs.similar; - - - array(4) { - ["client_id"]=> - int(61) - ["user"]=> - string(4) "root" - ["host"]=> - string(9) "localhost" - ["sql_session"]=> - int(72) - } -} -]]> - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/quotename.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/quotename.xml deleted file mode 100644 index d905a7d15491..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/quotename.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - Session::quoteName - Add quotes - - - - &reftitle.description; - - public stringmysql_xdevapi\Session::quoteName - stringname - - - A quoting function to escape SQL names and identifiers. It escapes the identifier - given in accordance to the settings of the current connection. This escape - function should not be used to escape values. - - - - - &reftitle.parameters; - - - name - - - The string to quote. - - - - - - - - &reftitle.returnvalues; - - The quoted string. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Session::quoteName</function> example - -quoteName($first)); - -$second = 'Another `test` "like" `this`'; -var_dump($second); -var_dump($session->quoteName($second)); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/releasesavepoint.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/releasesavepoint.xml deleted file mode 100644 index 1a4d01ac757b..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/releasesavepoint.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Session::releaseSavepoint - Release set savepoint - - - - &reftitle.description; - - public voidmysql_xdevapi\Session::releaseSavepoint - stringname - - - Release a previously set savepoint. - - - - - &reftitle.parameters; - - - name - - - Name of the savepoint to release. - - - - - - - - - &reftitle.returnvalues; - - An SqlStatementResult object. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Session::releaseSavepoint</function> example - -getSchema("addressbook")->getCollection("friends"); - -$session->startTransaction(); -$collection->add( '{"test1":1, "test2":2}' )->execute(); - -$savepoint = $session->setSavepoint(); - -$collection->add( '{"test3":3, "test4":4}' )->execute(); - -$session->releaseSavepoint($savepoint); -$session->rollback(); -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/rollback.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/rollback.xml deleted file mode 100644 index fdeff7bf2eb5..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/rollback.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - Session::rollback - Rollback transaction - - - - &reftitle.description; - - public voidmysql_xdevapi\Session::rollback - - - - Rollback the transaction. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - An SqlStatementResult object. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Session::rollback</function> example - -getSchema("addressbook")->getCollection("names"); - -$session->startTransaction(); -$collection->add( '{"test1":1, "test2":2}' )->execute(); - -$savepoint = $session->setSavepoint(); - -$collection->add( '{"test3":3, "test4":4}' )->execute(); - -$session->releaseSavepoint($savepoint); -$session->rollback(); -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/rollbackto.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/rollbackto.xml deleted file mode 100644 index 41fd6f4c98ce..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/rollbackto.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Session::rollbackTo - Rollback transaction to savepoint - - - - &reftitle.description; - - public voidmysql_xdevapi\Session::rollbackTo - stringname - - - Rollback the transaction back to the savepoint. - - - - - &reftitle.parameters; - - - name - - - Name of the savepoint to rollback to; case-insensitive. - - - - - - - - &reftitle.returnvalues; - - An SqlStatementResult object. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Session::rollbackTo</function> example - -getSchema("addressbook")->getCollection("names"); - -$session->startTransaction(); -$collection->add( '{"test1":1, "test2":2}' )->execute(); - -$savepoint1 = $session->setSavepoint(); - -$collection->add( '{"test3":3, "test4":4}' )->execute(); - -$savepoint2 = $session->setSavepoint(); - -$session->rollbackTo($savepoint1); -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/setsavepoint.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/setsavepoint.xml deleted file mode 100644 index ed49d206199a..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/setsavepoint.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - Session::setSavepoint - Create savepoint - - - - &reftitle.description; - - public stringmysql_xdevapi\Session::setSavepoint - stringname - - - Create a new savepoint for the transaction. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - name - - - The name of the savepoint. The name is auto-generated if the optional name - parameter is not defined as 'SAVEPOINT1', 'SAVEPOINT2', and so on. - - - - - - - - &reftitle.returnvalues; - - The name of the save point. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Session::setSavepoint</function> example - -getSchema("addressbook")->getCollection("names"); - -$session->startTransaction(); -$collection->add( '{"test1":1, "test2":2}' )->execute(); - -$savepoint = $session->setSavepoint(); - -$collection->add( '{"test3":3, "test4":4}' )->execute(); - -$session->releaseSavepoint($savepoint); -$session->rollback(); -?> -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/sql.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/sql.xml deleted file mode 100644 index 54f5e2240abf..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/sql.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - Session::sql - Create SQL query - - - - &reftitle.description; - - public mysql_xdevapi\SqlStatementmysql_xdevapi\Session::sql - stringquery - - - Create a native SQL statement. Placeholders are supported using the native "?" syntax. - Use the execute method to execute the SQL statement. - - - - - &reftitle.parameters; - - - query - - - SQL statement to execute. - - - - - - - - &reftitle.returnvalues; - - An SqlStatement object. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Session::sql</function> example - -sql("CREATE DATABASE addressbook")->execute(); -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/starttransaction.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/starttransaction.xml deleted file mode 100644 index a78b0fac0abf..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/starttransaction.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - Session::startTransaction - Start transaction - - - - &reftitle.description; - - public voidmysql_xdevapi\Session::startTransaction - - - - Start a new transaction. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - An SqlStatementResult object. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Session::startTransaction</function> example - -getSchema("addressbook")->getCollection("friends"); - -$session->startTransaction(); -$collection->add( '{"test1":1, "test2":2}' )->execute(); - -$savepoint = $session->setSavepoint(); - -$collection->add( '{"test3":3, "test4":4}' )->execute(); - -$session->releaseSavepoint($savepoint); -$session->rollback(); -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/bind.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/bind.xml deleted file mode 100644 index 1abf9b1889ba..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/bind.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - SqlStatement::bind - Bind statement parameters - - - - &reftitle.description; - - public mysql_xdevapi\SqlStatementmysql_xdevapi\SqlStatement::bind - stringparam - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - param - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - <function>mysql_xdevapi\SqlStatement::bind</function> example - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/construct.xml deleted file mode 100644 index dfa2682aee63..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/construct.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - SqlStatement::__construct - Description constructor - - - - &reftitle.description; - - private mysql_xdevapi\SqlStatement::__construct - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - - &reftitle.examples; - - <function>mysql_xdevapi\SqlStatement::__construct</function> example - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/execute.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/execute.xml deleted file mode 100644 index 129a35a9c2a3..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/execute.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - SqlStatement::execute - Execute the operation - - - - &reftitle.description; - - public mysql_xdevapi\Resultmysql_xdevapi\SqlStatement::execute - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - <function>mysql_xdevapi\SqlStatement::execute</function> example - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/getnextresult.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/getnextresult.xml deleted file mode 100644 index e2cf22db0716..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/getnextresult.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - SqlStatement::getNextResult - Get next result - - - - &reftitle.description; - - public mysql_xdevapi\Resultmysql_xdevapi\SqlStatement::getNextResult - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - <function>mysql_xdevapi\SqlStatement::getNextResult</function> example - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/getresult.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/getresult.xml deleted file mode 100644 index 20ded52c0bba..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/getresult.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - SqlStatement::getResult - Get result - - - - &reftitle.description; - - public mysql_xdevapi\Resultmysql_xdevapi\SqlStatement::getResult - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - <function>mysql_xdevapi\SqlStatement::getResult</function> example - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/hasmoreresults.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/hasmoreresults.xml deleted file mode 100644 index b8a77407a03e..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/hasmoreresults.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - SqlStatement::hasMoreResults - Check for more results - - - - &reftitle.description; - - public boolmysql_xdevapi\SqlStatement::hasMoreResults - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; if the result set has more objects to fetch. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\SqlStatement::hasMoreResults</function> example - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/construct.xml deleted file mode 100644 index 9d4f59854c45..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/construct.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - SqlStatementResult::__construct - Description constructor - - - - &reftitle.description; - - private mysql_xdevapi\SqlStatementResult::__construct - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - - &reftitle.examples; - - <function>mysql_xdevapi\SqlStatementResult::__construct</function> example - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/fetchall.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/fetchall.xml deleted file mode 100644 index daa235de5538..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/fetchall.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - SqlStatementResult::fetchAll - Get all rows from result - - - - &reftitle.description; - - public arraymysql_xdevapi\SqlStatementResult::fetchAll - - - - Fetch all the rows from the result set. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A numerical array with all results from the query; each result is - an associative array. An empty array is returned if no - rows are present. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\SqlStatementResult::fetchAll</function> example - -sql("DROP DATABASE IF EXISTS dbtest")->execute(); -$session->sql("CREATE DATABASE dbtest")->execute(); -$session->sql("CREATE TABLE dbtest.workers(name text, age int, job text)")->execute(); -$session->sql("INSERT INTO dbtest.workers values ('John', 42, 'bricklayer'), ('Sam', 33, 'carpenter')")->execute(); - -$schema = $session->getSchema("dbtest"); -$table = $schema->getTable("workers"); - -$rows = $session->sql("SELECT * FROM dbtest.workers")->execute()->fetchAll(); - -print_r($rows); -?> -]]> - - - &example.outputs.similar; - - Array - ( - [name] => John - [age] => 42 - ) - [1] => Array - ( - [name] => Sam - [age] => 33 - ) -) -]]> - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/fetchone.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/fetchone.xml deleted file mode 100644 index 86032d0cba87..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/fetchone.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - SqlStatementResult::fetchOne - Get single row - - - - &reftitle.description; - - public arraymysql_xdevapi\SqlStatementResult::fetchOne - - - - Fetch one row from the result set. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The result, as an associative array. In case there is not any - result, null will be returned. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\SqlStatementResult::fetchOne</function> example - -sql("DROP DATABASE IF EXISTS dbtest")->execute(); -$session->sql("CREATE DATABASE dbtest")->execute(); -$session->sql("CREATE TABLE dbtest.workers(name text, age int, job text)")->execute(); -$session->sql("INSERT INTO dbtest.workers values ('John', 42, 'bricklayer'), ('Sam', 33, 'carpenter')")->execute(); - -$schema = $session->getSchema("dbtest"); -$table = $schema->getTable("workers"); - -$rows = $session->sql("SELECT * FROM dbtest.workers")->execute()->fetchOne(); - -print_r($rows); -?> -]]> - - &example.outputs.similar; - - John - [age] => 42 - [job] => bricklayer -) -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getaffecteditemscount.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getaffecteditemscount.xml deleted file mode 100644 index 496c70d7d9e5..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getaffecteditemscount.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - SqlStatementResult::getAffectedItemsCount - Get affected row count - - - - &reftitle.description; - - public intmysql_xdevapi\SqlStatementResult::getAffectedItemsCount - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - <function>mysql_xdevapi\SqlStatementResult::getAffectedItemsCount</function> example - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getcolumncount.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getcolumncount.xml deleted file mode 100644 index d4b3eef8a41e..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getcolumncount.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - SqlStatementResult::getColumnsCount - Get column count - - - - &reftitle.description; - - public intmysql_xdevapi\SqlStatementResult::getColumnsCount - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The number of columns; 0 if there are none. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - 8.0.14 - - Method renamed from getColumnCount() to getColumnsCount(). - - - - - - - - - &reftitle.examples; - - <function>mysql_xdevapi\SqlStatementResult::getColumnsCount</function> example - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getcolumnnames.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getcolumnnames.xml deleted file mode 100644 index 48b0acd1fdcb..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getcolumnnames.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - SqlStatementResult::getColumnNames - Get column names - - - - &reftitle.description; - - public arraymysql_xdevapi\SqlStatementResult::getColumnNames - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - <function>mysql_xdevapi\SqlStatementResult::getColumnNames</function> example - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getcolumns.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getcolumns.xml deleted file mode 100644 index 80844578cced..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getcolumns.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - SqlStatementResult::getColumns - Get columns - - - - &reftitle.description; - - public Arraymysql_xdevapi\SqlStatementResult::getColumns - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - <function>mysql_xdevapi\SqlStatementResult::getColumns</function> example - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getgeneratedids.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getgeneratedids.xml deleted file mode 100644 index 8ee7f7a4119b..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getgeneratedids.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - SqlStatementResult::getGeneratedIds - Get generated ids - - - - &reftitle.description; - - public arraymysql_xdevapi\SqlStatementResult::getGeneratedIds - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - An array of generated _id's from the last operation, - or an empty array if there are none. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\SqlStatementResult::getGeneratedIds</function> example - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getlastinsertid.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getlastinsertid.xml deleted file mode 100644 index e03544717cd1..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getlastinsertid.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - SqlStatementResult::getLastInsertId - Get last insert id - - - - &reftitle.description; - - public Stringmysql_xdevapi\SqlStatementResult::getLastInsertId - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The ID for the last insert operation. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\SqlStatementResult::getLastInsertId</function> example - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getwarnings.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getwarnings.xml deleted file mode 100644 index 5efacb90adf5..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getwarnings.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - SqlStatementResult::getWarnings - Get warnings from last operation - - - - &reftitle.description; - - public arraymysql_xdevapi\SqlStatementResult::getWarnings - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - An array of Warning objects from the last operation. Each object - defines an error 'message', error 'level', and error 'code'. An empty - array is returned if no errors are present. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\SqlStatementResult::getWarnings</function> example - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getwarningscount.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getwarningscount.xml deleted file mode 100644 index 82b4d2e79091..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getwarningscount.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - SqlStatementResult::getWarningsCount - Get warning count from last operation - - - - &reftitle.description; - - public intmysql_xdevapi\SqlStatementResult::getWarningCounts - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The number of warnings raised during the last CRUD operation. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\SqlStatementResult::getWarningsCount</function> example - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/hasdata.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/hasdata.xml deleted file mode 100644 index 528e5912a07a..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/hasdata.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - SqlStatementResult::hasData - Check if result has data - - - - &reftitle.description; - - public boolmysql_xdevapi\SqlStatementResult::hasData - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; if the result set has data. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\SqlStatementResult::hasData</function> example - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/nextresult.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/nextresult.xml deleted file mode 100644 index 581961120329..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/nextresult.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - SqlStatementResult::nextResult - Get next result - - - - &reftitle.description; - - public mysql_xdevapi\Resultmysql_xdevapi\SqlStatementResult::nextResult - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The next Result object from the result set. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\SqlStatementResult::nextResult</function> example - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/statement/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/statement/construct.xml deleted file mode 100644 index e235fa52babd..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/statement/construct.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - Statement::__construct - Description constructor - - - - &reftitle.description; - - private mysql_xdevapi\Statement::__construct - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Statement::__construct</function> example - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/statement/getnextresult.xml b/reference/mysql_xdevapi/mysql_xdevapi/statement/getnextresult.xml deleted file mode 100644 index 72e560545af7..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/statement/getnextresult.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Statement::getNextResult - Get next result - - - - &reftitle.description; - - public mysql_xdevapi\Resultmysql_xdevapi\Statement::getNextResult - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Statement::getNextResult</function> example - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/statement/getresult.xml b/reference/mysql_xdevapi/mysql_xdevapi/statement/getresult.xml deleted file mode 100644 index 928cf7cf936e..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/statement/getresult.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Statement::getResult - Get result - - - - &reftitle.description; - - public mysql_xdevapi\Resultmysql_xdevapi\Statement::getResult - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Statement::getResult</function> example - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/statement/hasmoreresults.xml b/reference/mysql_xdevapi/mysql_xdevapi/statement/hasmoreresults.xml deleted file mode 100644 index 3c02231f0a29..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/statement/hasmoreresults.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Statement::hasMoreResults - Check if more results - - - - &reftitle.description; - - public boolmysql_xdevapi\Statement::hasMoreResults - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Statement::hasMoreResults</function> example - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/table/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/table/construct.xml deleted file mode 100644 index 95ede0175137..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/table/construct.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - Table::__construct - Table constructor - - - - &reftitle.description; - - private mysql_xdevapi\Table::__construct - - - - Construct a table object. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.examples; - - <function>mysql_xdevapi\Table::__construct</function> example - -getSchema("addressbook"); -$table = $schema->getTable("names"); -?> -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/table/count.xml b/reference/mysql_xdevapi/mysql_xdevapi/table/count.xml deleted file mode 100644 index d1d3bf03f0d2..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/table/count.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - Table::count - Get row count - - - - &reftitle.description; - - public intmysql_xdevapi\Table::count - - - - Fetch the number of rows in the table. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The total number of rows in the table. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Table::count</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -var_dump($table->count()); -?> -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/table/delete.xml b/reference/mysql_xdevapi/mysql_xdevapi/table/delete.xml deleted file mode 100644 index ca0b3a3c9d5f..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/table/delete.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - Table::delete - Delete rows from table - - - - &reftitle.description; - - public mysql_xdevapi\TableDeletemysql_xdevapi\Table::delete - - - - Deletes rows from a table. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A TableDelete object; use the execute() method to execute the delete query. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Table::delete</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$table->delete()->where("name = :name")->orderby("age DESC")->limit(1)->bind(['name' => 'John'])->execute(); -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/table/existsindatabase.xml b/reference/mysql_xdevapi/mysql_xdevapi/table/existsindatabase.xml deleted file mode 100644 index 78c75506c4cd..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/table/existsindatabase.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - Table::existsInDatabase - Check if table exists in database - - - - &reftitle.description; - - public boolmysql_xdevapi\Table::existsInDatabase - - - - Verifies if this table exists in the database. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; if table exists in the database, else &false; if it does not. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Table::existsInDatabase</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -if ($table->existsInDatabase()) { - echo "Yes, this table still exists in the session's schema."; -} -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/table/getname.xml b/reference/mysql_xdevapi/mysql_xdevapi/table/getname.xml deleted file mode 100644 index 0da195809b71..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/table/getname.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - Table::getName - Get table name - - - - &reftitle.description; - - public stringmysql_xdevapi\Table::getName - - - - Returns the name of this database object. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The name of this database object. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Table::getName</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -var_dump($table->getName()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/table/getschema.xml b/reference/mysql_xdevapi/mysql_xdevapi/table/getschema.xml deleted file mode 100644 index 950f21c72e6c..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/table/getschema.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Table::getSchema - Get table schema - - - - &reftitle.description; - - public mysql_xdevapi\Schemamysql_xdevapi\Table::getSchema - - - - Fetch the schema associated with the table. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A Schema object. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Table::getSchema</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -var_dump($table->getSchema()); -?> -]]> - - &example.outputs.similar; - - - string(11) "addressbook" -} -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/table/getsession.xml b/reference/mysql_xdevapi/mysql_xdevapi/table/getsession.xml deleted file mode 100644 index 96ac3e99f1a6..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/table/getsession.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Table::getSession - Get table session - - - - &reftitle.description; - - public mysql_xdevapi\Sessionmysql_xdevapi\Table::getSession - - - - Get session associated with the table. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A Session object. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Table::getSession</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -var_dump($table->getSession()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/table/insert.xml b/reference/mysql_xdevapi/mysql_xdevapi/table/insert.xml deleted file mode 100644 index 04ba68055235..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/table/insert.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Table::insert - Insert table rows - - - - &reftitle.description; - - public mysql_xdevapi\TableInsertmysql_xdevapi\Table::insert - mixedcolumns - mixedmore_columns - - - Inserts rows into a table. - - - - - - &reftitle.parameters; - - - columns - - - The columns to insert data into. Can be an array - with one or more values, or a string. - - - - - more_columns - - - Additional columns definitions. - - - - - - - - &reftitle.returnvalues; - - A TableInsert object; use the execute() method to execute the insert statement. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Table::insert</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$table ->insert("name", "age") - ->values(["Suzanne", 31],["Julie", 43]) - ->execute(); -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/table/isview.xml b/reference/mysql_xdevapi/mysql_xdevapi/table/isview.xml deleted file mode 100644 index 1c59136ab00a..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/table/isview.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - Table::isView - Check if table is view - - - - &reftitle.description; - - public boolmysql_xdevapi\Table::isView - - - - Determine if the underlying object is a view or not. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; if the underlying object is a view, otherwise &false;. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Table::isView</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -if ($table->isView()) { - echo "This is a view."; -} else { - echo "This is not a view."; -} -?> -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/table/select.xml b/reference/mysql_xdevapi/mysql_xdevapi/table/select.xml deleted file mode 100644 index 5fd93814abf9..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/table/select.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - Table::select - Select rows from table - - - - &reftitle.description; - - public mysql_xdevapi\TableSelectmysql_xdevapi\Table::select - mixedcolumns - mixedmore_columns - - - Fetches data from a table. - - - - - - &reftitle.parameters; - - - columns - - - The columns to select data from. Can be an array - with one or more values, or a string. - - - - - more_columns - - - Additional columns parameter definitions. - - - - - - - - &reftitle.returnvalues; - - A TableSelect object; use the execute() method to execute the - select and return a RowResult object. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Table::count</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$row = $table->select('name', 'age')->execute()->fetchAll(); - -print_r($row); -]]> - - &example.outputs.similar; - - Array - ( - [name] => John - [age] => 42 - ) - [1] => Array - ( - [name] => Sam - [age] => 33 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/table/update.xml b/reference/mysql_xdevapi/mysql_xdevapi/table/update.xml deleted file mode 100644 index 7c5f0d243e4d..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/table/update.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - Table::update - Update rows in table - - - - &reftitle.description; - - public mysql_xdevapi\TableUpdatemysql_xdevapi\Table::update - - - - Updates columns in a table. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A TableUpdate object; use the execute() method to execute the update statement. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Table::update</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$table->update()->set('age',34)->where('name = "Sam"')->limit(1)->execute(); -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/bind.xml b/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/bind.xml deleted file mode 100644 index e71bdb52e2a7..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/bind.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - TableDelete::bind - Bind delete query parameters - - - - &reftitle.description; - - public mysql_xdevapi\TableDeletemysql_xdevapi\TableDelete::bind - arrayplaceholder_values - - - Binds a value to a specific placeholder. - - - - - - &reftitle.parameters; - - - placeholder_values - - - The name of the placeholder and the value to bind. - - - - - - - - &reftitle.returnvalues; - - A TableDelete object. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\TableDelete::bind</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$table->delete() - ->where("name = :name") - ->bind(['name' => 'John']) - ->orderby("age DESC") - ->limit(1) - ->execute(); - -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/construct.xml deleted file mode 100644 index 0979fb01ee03..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/construct.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - TableDelete::__construct - TableDelete constructor - - - - &reftitle.description; - - private mysql_xdevapi\TableDelete::__construct - - - - Initiated by using the delete() method. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.examples; - - <function>mysql_xdevapi\TableDelete::__construct</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$table->delete() - ->where("name = :name") - ->bind(['name' => 'John']) - ->orderby("age DESC") - ->limit(1) - ->execute(); - -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/execute.xml b/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/execute.xml deleted file mode 100644 index 4f394cf20334..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/execute.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - TableDelete::execute - Execute delete query - - - - &reftitle.description; - - public mysql_xdevapi\Resultmysql_xdevapi\TableDelete::execute - - - - Execute the delete query. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A Result object. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\TableDelete::execute</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$table->delete() - ->where("name = :name") - ->bind(['name' => 'John']) - ->orderby("age DESC") - ->limit(1) - ->execute(); - -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/limit.xml b/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/limit.xml deleted file mode 100644 index 3b4a1fb1a74c..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/limit.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - TableDelete::limit - Limit deleted rows - - - - &reftitle.description; - - public mysql_xdevapi\TableDeletemysql_xdevapi\TableDelete::limit - introws - - - Sets the maximum number of records or documents to delete. - - - - - - &reftitle.parameters; - - - rows - - - The maximum number of records or documents to delete. - - - - - - - - &reftitle.returnvalues; - - TableDelete object. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\TableDelete::limit</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$table->delete() - ->where("name = :name") - ->bind(['name' => 'John']) - ->orderby("age DESC") - ->limit(1) - ->execute(); - -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/orderby.xml b/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/orderby.xml deleted file mode 100644 index 4492f2b1add4..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/orderby.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - TableDelete::orderby - Set delete sort criteria - - - - &reftitle.description; - - public mysql_xdevapi\TableDeletemysql_xdevapi\TableDelete::orderby - stringorderby_expr - - - Set the order options for a result set. - - - - - - &reftitle.parameters; - - - orderby_expr - - - The sort definition. - - - - - - - - &reftitle.returnvalues; - - A TableDelete object. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\TableDelete::orderBy</function> example - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$table->delete() - ->where("age = :age") - ->bind(['age' => 42]) - ->orderby("name DESC") - ->limit(1) - ->execute(); - -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/where.xml b/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/where.xml deleted file mode 100644 index b76a80049aee..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/where.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - TableDelete::where - Set delete search condition - - - - &reftitle.description; - - public mysql_xdevapi\TableDeletemysql_xdevapi\TableDelete::where - stringwhere_expr - - - Sets the search condition to filter. - - - - - - &reftitle.parameters; - - - where_expr - - - Define the search condition to filter documents or records. - - - - - - - - &reftitle.returnvalues; - - TableDelete object. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\TableDelete::where</function> example - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$table->delete() - ->where("id = :id") - ->bind(['id' => 42]) - ->limit(1) - ->execute(); - -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableinsert/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableinsert/construct.xml deleted file mode 100644 index 0053cb98d31b..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableinsert/construct.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - TableInsert::__construct - TableInsert constructor - - - - &reftitle.description; - - private mysql_xdevapi\TableInsert::__construct - - - - Initiated by using the insert() method. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.examples; - - <function>mysql_xdevapi\TableInsert::__construct</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$table - ->insert("name", "age") - ->values(["Suzanne", 31],["Julie", 43]) - ->execute(); -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableinsert/execute.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableinsert/execute.xml deleted file mode 100644 index 6c609b190dd4..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableinsert/execute.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - TableInsert::execute - Execute insert query - - - - &reftitle.description; - - public mysql_xdevapi\Resultmysql_xdevapi\TableInsert::execute - - - - Execute the statement. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A Result object. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\TableInsert::execute</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$table - ->insert("name", "age") - ->values(["Suzanne", 31],["Julie", 43]) - ->execute(); -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableinsert/values.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableinsert/values.xml deleted file mode 100644 index 1ee3fd1745a3..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableinsert/values.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - TableInsert::values - Add insert row values - - - - &reftitle.description; - - public mysql_xdevapi\TableInsertmysql_xdevapi\TableInsert::values - arrayrow_values - - - Set the values to be inserted. - - - - - - &reftitle.parameters; - - - row_values - - - Values (an array) of columns to insert. - - - - - - - - &reftitle.returnvalues; - - A TableInsert object. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\TableInsert::values</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$table - ->insert("name", "age") - ->values(["Suzanne", 31],["Julie", 43]) - ->execute(); -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/bind.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/bind.xml deleted file mode 100644 index 236e6d40a794..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/bind.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - TableSelect::bind - Bind select query parameters - - - - &reftitle.description; - - public mysql_xdevapi\TableSelectmysql_xdevapi\TableSelect::bind - arrayplaceholder_values - - - Binds a value to a specific placeholder. - - - - - - &reftitle.parameters; - - - placeholder_values - - - The name of the placeholder, and the value to bind. - - - - - - - - &reftitle.returnvalues; - - A TableSelect object. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\TableSelect::bind</function> example - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$result = $table->select('name','age') - ->where('name like :name and age > :age') - ->bind(['name' => 'John', 'age' => 42]) - ->execute(); - -$row = $result->fetchAll(); -print_r($row); -?> -]]> - - &example.outputs.similar; - - Array - ( - [name] => John - [age] => 42 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/construct.xml deleted file mode 100644 index 490854d5053d..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/construct.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - TableSelect::__construct - TableSelect constructor - - - - &reftitle.description; - - private mysql_xdevapi\TableSelect::__construct - - - - An object returned by the select() method; use execute() to - execute the query. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.examples; - - <function>mysql_xdevapi\TableSelect::__construct</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$result = $table->select('name','age') - ->where('name like :name and age > :age') - ->bind(['name' => 'John', 'age' => 42]) - ->orderBy('age desc') - ->execute(); - -$row = $result->fetchAll(); -print_r($row); - -?> -]]> - - &example.outputs.similar; - - Array - ( - [name] => John - [age] => 42 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/execute.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/execute.xml deleted file mode 100644 index a7ddab57d97e..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/execute.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - TableSelect::execute - Execute select statement - - - - &reftitle.description; - - public mysql_xdevapi\RowResultmysql_xdevapi\TableSelect::execute - - - - Execute the select statement by chaining it with the execute() method. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A RowResult object. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\TableSelect::execute</function> example - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$result = $table->select('name','age') - ->where('name like :name and age > :age') - ->bind(['name' => 'John', 'age' => 42]) - ->orderBy('age desc') - ->execute(); - -$row = $result->fetchAll(); -?> -]]> - - &example.outputs.similar; - - Array - ( - [name] => John - [age] => 42 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/groupby.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/groupby.xml deleted file mode 100644 index 89de849ebe21..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/groupby.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - TableSelect::groupBy - Set select grouping criteria - - - - &reftitle.description; - - public mysql_xdevapi\TableSelectmysql_xdevapi\TableSelect::groupBy - mixedsort_expr - - - Sets a grouping criteria for the result set. - - - - - - &reftitle.parameters; - - - sort_expr - - - The grouping criteria. - - - - - - - - &reftitle.returnvalues; - - A TableSelect object. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\TableSelect::groupBy</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 42)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('Suki', 31)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$result = $table->select('count(*) as count', 'age') - ->groupBy('age')->orderBy('age asc') - ->execute(); - -$row = $result->fetchAll(); -print_r($row); -?> -]]> - - &example.outputs.similar; - - Array - ( - [count] => 1 - [age] => 31 - ) - [1] => Array - ( - [count] => 2 - [age] => 42 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/having.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/having.xml deleted file mode 100644 index ac26f2b12f01..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/having.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - TableSelect::having - Set select having condition - - - - &reftitle.description; - - public mysql_xdevapi\TableSelectmysql_xdevapi\TableSelect::having - stringsort_expr - - - Sets a condition for records to consider in aggregate function operations. - - - - - &reftitle.parameters; - - - sort_expr - - - A condition on the aggregate functions used on the grouping criteria. - - - - - - - - &reftitle.returnvalues; - - A TableSelect object. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\TableSelect::having</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 42)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('Suki', 31)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$result = $table->select('count(*) as count', 'age') - ->groupBy('age')->orderBy('age asc') - ->having('count > 1') - ->execute(); - -$row = $result->fetchAll(); -print_r($row); -?> -]]> - - &example.outputs.similar; - - Array - ( - [count] => 2 - [age] => 42 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/limit.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/limit.xml deleted file mode 100644 index d3a4270f7952..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/limit.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - TableSelect::limit - Limit selected rows - - - - &reftitle.description; - - public mysql_xdevapi\TableSelectmysql_xdevapi\TableSelect::limit - introws - - - Sets the maximum number of records or documents to return. - - - - - - &reftitle.parameters; - - - rows - - - The maximum number of records or documents. - - - - - - - - &reftitle.returnvalues; - - A TableSelect object. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\TableSelect::limit</function> example - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$result = $table->select('name', 'age') - ->limit(1) - ->execute(); - -$row = $result->fetchAll(); -print_r($row); -?> -]]> - - &example.outputs.similar; - - Array - ( - [name] => John - [age] => 42 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/lockexclusive.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/lockexclusive.xml deleted file mode 100644 index 72625d33e909..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/lockexclusive.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - TableSelect::lockExclusive - Execute EXCLUSIVE LOCK - - - - &reftitle.description; - - public mysql_xdevapi\TableSelectmysql_xdevapi\TableSelect::lockExclusive - intlock_waiting_option - - - Execute a read operation with EXCLUSIVE LOCK. Only one lock can be active at a time. - - - - - - &reftitle.parameters; - - - lock_waiting_option - - - The optional waiting option that defaults to MYSQLX_LOCK_DEFAULT. - Valid values are: - - - MYSQLX_LOCK_DEFAULT - MYSQLX_LOCK_NOWAIT - MYSQLX_LOCK_SKIP_LOCKED - - - - - - - - &reftitle.returnvalues; - - TableSelect object. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\TableSelect::lockExclusive</function> example - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$session->startTransaction(); - -$result = $table->select('name', 'age') - ->lockExclusive(MYSQLX_LOCK_NOWAIT) - ->execute(); - -$session->commit(); - -$row = $result->fetchAll(); -print_r($row); -?> -]]> - - &example.outputs.similar; - - Array - ( - [name] => John - [age] => 42 - ) - [1] => Array - ( - [name] => Sam - [age] => 42 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/lockshared.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/lockshared.xml deleted file mode 100644 index eeb9a03a2f55..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/lockshared.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - TableSelect::lockShared - Execute SHARED LOCK - - - - &reftitle.description; - - public mysql_xdevapi\TableSelectmysql_xdevapi\TableSelect::lockShared - intlock_waiting_option - - - Execute a read operation with SHARED LOCK. Only one lock can be active at a time. - - - - - - &reftitle.parameters; - - - lock_waiting_option - - - The optional waiting option that defaults to MYSQLX_LOCK_DEFAULT. - Valid values are: - - - MYSQLX_LOCK_DEFAULT - MYSQLX_LOCK_NOWAIT - MYSQLX_LOCK_SKIP_LOCKED - - - - - - - - &reftitle.returnvalues; - - A TableSelect object. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\TableSelect::lockShared</function> example - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$session->startTransaction(); - -$result = $table->select('name', 'age') - ->lockShared(MYSQLX_LOCK_NOWAIT) - ->execute(); - -$session->commit(); - -$row = $result->fetchAll(); -print_r($row); -?> -]]> - - &example.outputs.similar; - - Array - ( - [name] => John - [age] => 42 - ) - [1] => Array - ( - [name] => Sam - [age] => 42 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/offset.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/offset.xml deleted file mode 100644 index 1eb802653798..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/offset.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - TableSelect::offset - Set limit offset - - - - &reftitle.description; - - public mysql_xdevapi\TableSelectmysql_xdevapi\TableSelect::offset - intposition - - - Skip given number of rows in result. - - - - - - &reftitle.parameters; - - - position - - - The limit offset. - - - - - - - - &reftitle.returnvalues; - - A TableSelect object. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\TableSelect::offset</function> example - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 42)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$result = $table->select('name', 'age') - ->limit(1) - ->offset(1) - ->execute(); - -$row = $result->fetchAll(); -print_r($row); -?> -]]> - - &example.outputs.similar; - - Array - ( - [name] => Sam - [age] => 42 - ) -) -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/orderby.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/orderby.xml deleted file mode 100644 index 908e1537aa0e..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/orderby.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - TableSelect::orderby - Set select sort criteria - - - - &reftitle.description; - - public mysql_xdevapi\TableSelectmysql_xdevapi\TableSelect::orderby - mixedsort_expr - mixedsort_exprs - - - Sets the order by criteria. - - - - - - &reftitle.parameters; - - - sort_expr - - - The expressions that define the order by criteria. Can be an array - with one or more expressions, or a string. - - - - - sort_exprs - - - Additional sort_expr parameters. - - - - - - - - &reftitle.returnvalues; - - A TableSelect object. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\TableSelect::orderBy</function> example - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$result = $table->select('name', 'age') - ->orderBy('name desc') - ->execute(); - -$row = $result->fetchAll(); -print_r($row); -?> -]]> - - &example.outputs.similar; - - Array - ( - [name] => Sam - [age] => 42 - ) - [1] => Array - ( - [name] => John - [age] => 42 - ) -) -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/where.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/where.xml deleted file mode 100644 index e0d062c739b7..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/where.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - TableSelect::where - Set select search condition - - - - &reftitle.description; - - public mysql_xdevapi\TableSelectmysql_xdevapi\TableSelect::where - stringwhere_expr - - - Sets the search condition to filter. - - - - - - &reftitle.parameters; - - - where_expr - - - Define the search condition to filter documents or records. - - - - - - - - &reftitle.returnvalues; - - A TableSelect object. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\TableSelect::where</function> example - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$result = $table->select('name','age') - ->where('name like :name and age > :age') - ->bind(['name' => 'John', 'age' => 42]) - ->execute(); - -$row = $result->fetchAll(); -print_r($row); -?> -]]> - - &example.outputs.similar; - - Array - ( - [name] => John - [age] => 42 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/bind.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/bind.xml deleted file mode 100644 index c18830221476..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/bind.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - TableUpdate::bind - Bind update query parameters - - - - &reftitle.description; - - public mysql_xdevapi\TableUpdatemysql_xdevapi\TableUpdate::bind - arrayplaceholder_values - - - Binds a value to a specific placeholder. - - - - - - &reftitle.parameters; - - - placeholder_values - - - The name of the placeholder, and the value to bind, defined - as a JSON array. - - - - - - - - &reftitle.returnvalues; - - A TableUpdate object. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\TableUpdate::bind</function> example - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$table->update() - ->set('status', 'admin') - ->where('name = :name and age > :age') - ->bind(['name' => 'Bernie', 'age' => 2000]) - ->execute(); - -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/construct.xml deleted file mode 100644 index baec3abb0841..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/construct.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - TableUpdate::__construct - TableUpdate constructor - - - - &reftitle.description; - - private mysql_xdevapi\TableUpdate::__construct - - - - Initiated by using the update() method. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.examples; - - <function>mysql_xdevapi\TableUpdate::__construct</function> example - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$res = $table->update() - ->set('level', 3) - ->where('age > 15 and age < 22') - ->limit(4) - ->orderby(['age asc','name desc']) - ->execute(); - -?> -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/execute.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/execute.xml deleted file mode 100644 index 65b78d23590a..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/execute.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - TableUpdate::execute - Execute update query - - - - &reftitle.description; - - public mysql_xdevapi\TableUpdatemysql_xdevapi\TableUpdate::execute - - - - Executes the update statement. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A TableUpdate object. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\TableUpdate::execute</function> example - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$res = $table->update() - ->set('level', 3) - ->where('age > 15 and age < 22') - ->limit(4) - ->orderby(['age asc','name desc']) - ->execute(); - -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/limit.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/limit.xml deleted file mode 100644 index 4140162ed769..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/limit.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - TableUpdate::limit - Limit update row count - - - - &reftitle.description; - - public mysql_xdevapi\TableUpdatemysql_xdevapi\TableUpdate::limit - introws - - - Set the maximum number of records or documents update. - - - - - - &reftitle.parameters; - - - rows - - - The maximum number of records or documents to update. - - - - - - - - &reftitle.returnvalues; - - A TableUpdate object. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\TableUpdate::limit</function> example - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$res = $table->update() - ->set('level', 3) - ->where('age > 15 and age < 22') - ->limit(4) - ->orderby(['age asc','name desc']) - ->execute(); - -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/orderby.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/orderby.xml deleted file mode 100644 index fa41d2f9e5e0..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/orderby.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - TableUpdate::orderby - Set sorting criteria - - - - &reftitle.description; - - public mysql_xdevapi\TableUpdatemysql_xdevapi\TableUpdate::orderby - mixedorderby_expr - mixedorderby_exprs - - - Sets the sorting criteria. - - - - - - &reftitle.parameters; - - - orderby_expr - - - The expressions that define the order by criteria. Can be an array - with one or more expressions, or a string. - - - - - orderby_exprs - - - Additional sort_expr parameters. - - - - - - - - &reftitle.returnvalues; - - TableUpdate object. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\TableUpdate::orderby</function> example - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$res = $table->update() - ->set('level', 3) - ->where('age > 15 and age < 22') - ->limit(4) - ->orderby(['age asc','name desc']) - ->execute(); -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/set.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/set.xml deleted file mode 100644 index 684f5b8e1c5b..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/set.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - TableUpdate::set - Add field to be updated - - - - &reftitle.description; - - public mysql_xdevapi\TableUpdatemysql_xdevapi\TableUpdate::set - stringtable_field - stringexpression_or_literal - - - Updates the column value on records in a table. - - - - - - &reftitle.parameters; - - - table_field - - - The column name to be updated. - - - - - expression_or_literal - - - The value to be set on the specified column. - - - - - - - - &reftitle.returnvalues; - - TableUpdate object. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\TableUpdate::set</function> example - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$res = $table->update() - ->set('level', 3) - ->where('age > 15 and age < 22') - ->limit(4) - ->orderby(['age asc','name desc']) - ->execute(); - -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/where.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/where.xml deleted file mode 100644 index 7b967c6ea897..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/where.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - TableUpdate::where - Set search filter - - - - &reftitle.description; - - public mysql_xdevapi\TableUpdatemysql_xdevapi\TableUpdate::where - stringwhere_expr - - - Set the search condition to filter. - - - - - - &reftitle.parameters; - - - where_expr - - - The search condition to filter documents or records. - - - - - - - - &reftitle.returnvalues; - - A TableUpdate object. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\TableUpdate::where</function> example - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$res = $table->update() - ->set('level', 3) - ->where('age > 15 and age < 22') - ->limit(4) - ->orderby(['age asc','name desc']) - ->execute(); - -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/warning/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/warning/construct.xml deleted file mode 100644 index 3f7cbd9e4c54..000000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/warning/construct.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - Warning::__construct - Warning constructor - - - - &reftitle.description; - - private mysql_xdevapi\Warning::__construct - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - - &reftitle.examples; - - <function>mysql_xdevapi\Warning::__construct</function> example - - -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/reference.xml b/reference/mysql_xdevapi/reference.xml deleted file mode 100644 index d8f77eabc962..000000000000 --- a/reference/mysql_xdevapi/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - Mysql_xdevapi &Functions; - - &reference.mysql-xdevapi.entities.functions; - - - - diff --git a/reference/mysql_xdevapi/setup.xml b/reference/mysql_xdevapi/setup.xml deleted file mode 100644 index 7905ccee8a43..000000000000 --- a/reference/mysql_xdevapi/setup.xml +++ /dev/null @@ -1,167 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - This extension requires a MySQL 8+ server with the X plugin - enabled (default). - - - Prerequisite libraries for compiling this extension are: - Boost (1.53.0 or higher), OpenSSL, and Protobuf. - - -
    - -
    - &reftitle.install; - - - &pecl.moved; - - - - An example installation procedure on Ubuntu 18.04 with PHP 7.2: - - - - - - - The pecl install command does not enable PHP extensions (by default) - and enabling PHP extensions can be done in several ways. - Another PHP 7.2 on Ubuntu 18.04 example: - - - - /etc/php/7.2/mods-available/mysql_xdevapi.ini - -// Use the 'phpenmod' command (note: it's Debian/Ubuntu specific) -$ phpenmod -v 7.2 -s ALL mysql_xdevapi - -// A 'phpenmod' alternative is to manually symlink it -// $ ln -s /etc/php/7.2/mods-available/mysql_xdevapi.ini /etc/php/7.2/cli/conf.d/20-mysql_xdevapi.ini - -// Let's see which MySQL extensions are enabled now -$ php -m |grep mysql - -mysql_xdevapi -mysqli -mysqlnd -pdo_mysql -]]> - - - - &pecl.info; - &url.pecl.package;mysql_xdevapi. - -
    - - - &reference.mysql-xdevapi.ini; - - -
    - Building / Compiling From Source - - Considerations for compiling this extension from source. - - - - - - The extension name is 'mysql_xdevapi', so use --enable-mysql-xdevapi. - - - - - Boost: required, optionally use the --with-boost=DIR configure option - or set the MYSQL_XDEVAPI_BOOST_ROOT environment variable. Only the - boost header files are required; not the binaries. - - - - - Google Protocol Buffers (protobuf): required, optionally use the --with-protobuf=DIR - configure option or set the MYSQL_XDEVAPI_PROTOBUF_ROOT environment variable. - - - Optionally use make protobufs to generate protobuf files (*.pb.cc/.h), - and make clean-protobufs to delete generate protobuf files. - - - Windows specific protobuf note: depending on your environment, - the static library with a multi-threaded DLL runtime may be needed. - To prepare, use the following options: - -Dprotobuf_MSVC_STATIC_RUNTIME=OFF -Dprotobuf_BUILD_SHARED_LIBS=OFF - - - - - Google Protocol Buffers / protocol compiler (protoc): required, ensure that proper - 'protoc' is available in the PATH while building. It is especially - important as Windows PHP SDK batch scripts may overwrite the environment. - - - - - Bison: required, and available from the PATH. - - - Windows specific bison note: we strongly recommended that bison delivered with the - chosen PHP SDKis used else an error similar to "zend_globals_macros.h(39): - error C2375: 'zendparse': redefinition; different linkage - Zend/zend_language_parser.h(214): note: see declaration of 'zendparse'" may - be the result. Also, Windows PHP SDK batch scripts may overwrite the environment. - - - - - Windows Specific Notes: To prepare the environment, see the official - Windows build documentation for - the current SDK. - - - We recommend using the backslash '\\' instead of a slash '/' for all paths. - - - -
    -
    - - diff --git a/reference/mysql_xdevapi/versions.xml b/reference/mysql_xdevapi/versions.xml deleted file mode 100644 index e30f41e1fcaf..000000000000 --- a/reference/mysql_xdevapi/versions.xml +++ /dev/null @@ -1,291 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/mysqli/setup.xml b/reference/mysqli/setup.xml index a93c09e3fb01..c58bd440dace 100644 --- a/reference/mysqli/setup.xml +++ b/reference/mysqli/setup.xml @@ -23,15 +23,15 @@ The server requested authentication method unknown to the client [caching_sha2_password] even when caching_sha2_password is not used. - + This is because MySQL 8 defaults to caching_sha2_password, a plugin that is not recognized by the older PHP (mysqlnd) releases. Instead, change it by setting default_authentication_plugin=mysql_native_password in my.cnf. The caching_sha2_password plugin is fully supported as of PHP 7.4.4. For older releases, the - mysql_xdevapi extension does + mysql_xdevapi extension does support it. - + diff --git a/reference/mysqlinfo/set.xml b/reference/mysqlinfo/set.xml index cbeb998edd61..5471976c767e 100644 --- a/reference/mysqlinfo/set.xml +++ b/reference/mysqlinfo/set.xml @@ -466,8 +466,6 @@ $ ./configure --with-mysqli=/path/to/mysql_config --with-pdo-mysql=/path/to/mysq &reference.mysqli.book; - &reference.mysql-xdevapi.book; - &reference.mysql.book; &reference.mysqlnd.book; diff --git a/reference/oauth/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/oauth/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/oauth/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/oauth/book.xml b/reference/oauth/book.xml deleted file mode 100644 index ab305ef480c5..000000000000 --- a/reference/oauth/book.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - - - OAuth - - - &reftitle.intro; - - This extension provides OAuth 1.0a consumer and provider bindings. OAuth is an - authorization protocol built on top of HTTP which allows applications - to securely access data without having to store usernames and - passwords. - - - - &reference.oauth.setup; - &reference.oauth.constants; - &reference.oauth.examples; - &reference.oauth.reference; - &reference.oauth.oauth; - &reference.oauth.oauthprovider; - &reference.oauth.oauthexception; - - - diff --git a/reference/oauth/configure.xml b/reference/oauth/configure.xml deleted file mode 100644 index 96dd50dffdd4..000000000000 --- a/reference/oauth/configure.xml +++ /dev/null @@ -1,29 +0,0 @@ - - -
    - &reftitle.install; - - &pecl.info; - &url.pear.package;oauth - -
    - diff --git a/reference/oauth/constants.xml b/reference/oauth/constants.xml deleted file mode 100644 index 54a0646af142..000000000000 --- a/reference/oauth/constants.xml +++ /dev/null @@ -1,349 +0,0 @@ - - - - &reftitle.constants; - &extension.constants; - - Most of these constants involve problems, which are also described within the official - OAuth Problem Reporting - documentation. Note however, that these constant names are specific to PHP, although - the naming scheme is similar. - - - - - - OAUTH_SIG_METHOD_RSASHA1 - (string) - - - - OAuth RSA-SHA1 signature method. - - - - - - OAUTH_SIG_METHOD_HMACSHA1 - (string) - - - - OAuth HMAC-SHA1 signature method. - - - - - - OAUTH_SIG_METHOD_HMACSHA256 - (string) - - - - OAuth HMAC-SHA256 signature method. - - - - - - OAUTH_AUTH_TYPE_AUTHORIZATION - (string) - - - - This constant represents putting OAuth parameters in the - Authorization header. - - - - - - OAUTH_AUTH_TYPE_NONE - (string) - - - - This constant indicates a NoAuth OAuth request. - - - - - - OAUTH_AUTH_TYPE_URI - (string) - - - - This constant represents putting OAuth parameters in the request - URI. - - - - - - OAUTH_AUTH_TYPE_FORM - (string) - - - - This constant represents putting OAuth parameters as part of the - HTTP POST body. - - - - - - OAUTH_HTTP_METHOD_GET - (string) - - - - Use the GET method for the OAuth request. - - - - - - OAUTH_HTTP_METHOD_POST - (string) - - - - Use the POST method for the OAuth request. - - - - - - OAUTH_HTTP_METHOD_PUT - (string) - - - - Use the PUT method for the OAuth request. - - - - - - OAUTH_HTTP_METHOD_HEAD - (string) - - - - Use the HEAD method for the OAuth request. - - - - - - OAUTH_HTTP_METHOD_DELETE - (string) - - - - Use the DELETE method for the OAuth request. - - - - - - OAUTH_REQENGINE_STREAMS - (int) - - - - Used by OAuth::setRequestEngine to set the engine to - PHP streams, - as opposed to OAUTH_REQENGINE_CURL for - Curl. - - - - - - OAUTH_REQENGINE_CURL - (int) - - - - Used by OAuth::setRequestEngine to set the engine to - Curl, as opposed to - OAUTH_REQENGINE_STREAMS for PHP streams. - - - - - - OAUTH_OK - (int) - - - - Life is good. - - - - - - OAUTH_BAD_NONCE - (int) - - - - The oauth_nonce value was used in a previous request, - therefore it cannot be used now. - - - - - - OAUTH_BAD_TIMESTAMP - (int) - - - - The oauth_timestamp value was not accepted by the service provider. In - this case, the response should also contain the oauth_acceptable_timestamps - parameter. - - - - - - OAUTH_CONSUMER_KEY_UNKNOWN - (int) - - - - The oauth_consumer_key is temporarily unacceptable to the service provider. - For example, the service provider may be throttling the consumer. - - - - - - OAUTH_CONSUMER_KEY_REFUSED - (int) - - - - The consumer key was refused. - - - - - - OAUTH_INVALID_SIGNATURE - (int) - - - - The oauth_signature is invalid, as it does not match the - signature computed by the service provider. - - - - - - OAUTH_TOKEN_USED - (int) - - - - The oauth_token has been consumed. It can no longer be - used because it has already been used in the previous request(s). - - - - - - OAUTH_TOKEN_EXPIRED - (int) - - - - The oauth_token has expired. - - - - - - OAUTH_TOKEN_REVOKED - (int) - - - - The oauth_token has been revoked, and will never be accepted. - - - - - - OAUTH_TOKEN_REJECTED - (int) - - - - The oauth_token was not accepted by the service provider. - The reason is not known, but it might be because the token was never issued, - already consumed, expired, and/or forgotten by the service provider. - - - - - - OAUTH_VERIFIER_INVALID - (int) - - - - The oauth_verifier is incorrect. - - - - - - OAUTH_PARAMETER_ABSENT - (int) - - - - A required parameter was not received. In this case, the response should also - contain the oauth_parameters_absent parameter. - - - - - - OAUTH_SIGNATURE_METHOD_REJECTED - (int) - - - - The oauth_signature_method was not accepted by service provider. - - - - - - diff --git a/reference/oauth/examples.xml b/reference/oauth/examples.xml deleted file mode 100644 index cd18f296a116..000000000000 --- a/reference/oauth/examples.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - &reftitle.examples; - -
    - FireEagle - - - <programlisting role="php" xml:id="oauth.examples.fireeagle.location"> -<![CDATA[ -<?php -$req_url = 'https://fireeagle.yahooapis.com/oauth/request_token'; -$authurl = 'https://fireeagle.yahoo.net/oauth/authorize'; -$acc_url = 'https://fireeagle.yahooapis.com/oauth/access_token'; -$api_url = 'https://fireeagle.yahooapis.com/api/0.1'; -$conskey = 'your_consumer_key'; -$conssec = 'your_consumer_secret'; - -session_start(); - -// In state=1 the next request should include an oauth_token. -// If it doesn't go back to 0 -if(!isset($_GET['oauth_token']) && $_SESSION['state']==1) $_SESSION['state'] = 0; -try { - $oauth = new OAuth($conskey,$conssec,OAUTH_SIG_METHOD_HMACSHA1,OAUTH_AUTH_TYPE_URI); - $oauth->enableDebug(); - if(!isset($_GET['oauth_token']) && !$_SESSION['state']) { - $request_token_info = $oauth->getRequestToken($req_url); - $_SESSION['secret'] = $request_token_info['oauth_token_secret']; - $_SESSION['state'] = 1; - header('Location: '.$authurl.'?oauth_token='.$request_token_info['oauth_token']); - exit; - } else if($_SESSION['state']==1) { - $oauth->setToken($_GET['oauth_token'],$_SESSION['secret']); - $access_token_info = $oauth->getAccessToken($acc_url); - $_SESSION['state'] = 2; - $_SESSION['token'] = $access_token_info['oauth_token']; - $_SESSION['secret'] = $access_token_info['oauth_token_secret']; - } - $oauth->setToken($_SESSION['token'],$_SESSION['secret']); - $oauth->fetch("$api_url/user.json"); - $json = json_decode($oauth->getLastResponse()); - print_r($json); -} catch(OAuthException $E) { - print_r($E); -} -?> -]]> - </programlisting> - </example> - </section> - -</chapter> -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/oauth/functions/oauth-get-sbs.xml b/reference/oauth/functions/oauth-get-sbs.xml deleted file mode 100644 index 1f214dcd0763..000000000000 --- a/reference/oauth/functions/oauth-get-sbs.xml +++ /dev/null @@ -1,79 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.oauth-get-sbs"> - <refnamediv> - <refname>oauth_get_sbs</refname> - <refpurpose>Generate a Signature Base String</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>string</type><methodname>oauth_get_sbs</methodname> - <methodparam><type>string</type><parameter>http_method</parameter></methodparam> - <methodparam><type>string</type><parameter>uri</parameter></methodparam> - <methodparam choice="opt"><type>array</type><parameter>request_parameters</parameter></methodparam> - </methodsynopsis> - <simpara> - Generates a Signature Base String according to pecl/oauth. - </simpara> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <variablelist> - <varlistentry> - <term><parameter>http_method</parameter></term> - <listitem> - <simpara> - The HTTP method. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>uri</parameter></term> - <listitem> - <simpara> - URI to encode. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>request_parameters</parameter></term> - <listitem> - <simpara> - Array of request parameters. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <simpara> - Returns a Signature Base String. - </simpara> - </refsect1> - -</refentry> -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/oauth/functions/oauth-urlencode.xml b/reference/oauth/functions/oauth-urlencode.xml deleted file mode 100644 index ed1bb5fbebe9..000000000000 --- a/reference/oauth/functions/oauth-urlencode.xml +++ /dev/null @@ -1,61 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.oauth-urlencode"> - <refnamediv> - <refname>oauth_urlencode</refname> - <refpurpose>Encode a URI to RFC 3986</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>string</type><methodname>oauth_urlencode</methodname> - <methodparam><type>string</type><parameter>uri</parameter></methodparam> - </methodsynopsis> - <simpara> - Encodes a URI to <link xlink:href="&url.rfc;3986">RFC 3986</link>. - </simpara> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <variablelist> - <varlistentry> - <term><parameter>uri</parameter></term> - <listitem> - <simpara> - URI to encode. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <simpara> - Returns an <link xlink:href="&url.rfc;3986">RFC 3986</link> encoded string. - </simpara> - </refsect1> - -</refentry> -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/oauth/oauth.xml b/reference/oauth/oauth.xml deleted file mode 100644 index 27bef25ecb56..000000000000 --- a/reference/oauth/oauth.xml +++ /dev/null @@ -1,105 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.oauth" role="class"> - <title>The OAuth class - OAuth - - - - -
    - &reftitle.intro; - - The OAuth extension provides a simple interface to interact with - data providers using the OAuth HTTP specification to protect - private resources. - -
    - - -
    - &reftitle.classsynopsis; - - - - OAuth - - - - - OAuth - - - - - &Properties; - - public - debug - - - public - sslChecks - - - public - debugInfo - - - &Methods; - - - - - -
    - -
    - &reftitle.properties; - - - debug - - - - - - sslChecks - - - - - - debugInfo - - - - - -
    - -
    - - &reference.oauth.entities.oauth; - - - diff --git a/reference/oauth/oauth/construct.xml b/reference/oauth/oauth/construct.xml deleted file mode 100644 index 503795e67ed6..000000000000 --- a/reference/oauth/oauth/construct.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - OAuth::__construct - Create a new OAuth object - - - - &reftitle.description; - - public OAuth::__construct - stringconsumer_key - stringconsumer_secret - stringsignature_methodOAUTH_SIG_METHOD_HMACSHA1 - intauth_type0 - - - Creates a new OAuth object - - - - - &reftitle.parameters; - - - consumer_key - - - The consumer key provided by the service provider. - - - - - consumer_secret - - - The consumer secret provided by the service provider. - - - - - signature_method - - - This optional parameter defines which signature method to use, by default it is OAUTH_SIG_METHOD_HMACSHA1 (HMAC-SHA1). - - - - - auth_type - - - This optional parameter defines how to pass the OAuth parameters - to a consumer, by default it is - OAUTH_AUTH_TYPE_AUTHORIZATION (in the - Authorization header). - - - - - - - - diff --git a/reference/oauth/oauth/destruct.xml b/reference/oauth/oauth/destruct.xml deleted file mode 100644 index 65e73865ba38..000000000000 --- a/reference/oauth/oauth/destruct.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - OAuth::__destruct - The destructor - - - - &reftitle.description; - - public voidOAuth::__destruct - - - - The destructor. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - OAuth::__construct - - - - - diff --git a/reference/oauth/oauth/disabledebug.xml b/reference/oauth/oauth/disabledebug.xml deleted file mode 100644 index 6e6950d3e7b4..000000000000 --- a/reference/oauth/oauth/disabledebug.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - OAuth::disableDebug - Turn off verbose debugging - - - - &reftitle.description; - - public boolOAuth::disableDebug - - - - Turns off verbose request information (off by default). - Alternatively, the debug property can - be set to a &false; value to turn debug off. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL oauth 0.99.8 - - The related debug property was added. - - - - - - - - - &reftitle.seealso; - - OAuth::enableDebug - - - - - diff --git a/reference/oauth/oauth/disableredirects.xml b/reference/oauth/oauth/disableredirects.xml deleted file mode 100644 index b04b4bc8c6a1..000000000000 --- a/reference/oauth/oauth/disableredirects.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - OAuth::disableRedirects - Turn off redirects - - - - &reftitle.description; - - public boolOAuth::disableRedirects - - - - Disable redirects from being followed automatically, thus allowing the request to be manually redirected. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; - - - - - &reftitle.seealso; - - OAuth::enableRedirects - - - - - diff --git a/reference/oauth/oauth/disablesslchecks.xml b/reference/oauth/oauth/disablesslchecks.xml deleted file mode 100644 index a5955ba1fa1d..000000000000 --- a/reference/oauth/oauth/disablesslchecks.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - OAuth::disableSSLChecks - Turn off SSL checks - - - - &reftitle.description; - - public boolOAuth::disableSSLChecks - - - - Turns off the usual SSL peer certificate and host checks, - this is not for production environments. Alternatively, the - sslChecks member can be set to &false; - to turn SSL checks off. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL oauth 0.99.8 - - The sslChecks member was added - - - - - - - - - &reftitle.seealso; - - OAuth::enableSSLChecks - - - - - diff --git a/reference/oauth/oauth/enabledebug.xml b/reference/oauth/oauth/enabledebug.xml deleted file mode 100644 index 20a5517b8ad2..000000000000 --- a/reference/oauth/oauth/enabledebug.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - OAuth::enableDebug - Turn on verbose debugging - - - - &reftitle.description; - - public boolOAuth::enableDebug - - - - Turns on verbose request information useful for debugging, - the debug information is stored in the debugInfo - member. Alternatively, the debug member can - be set to a non-&false; value to turn debug on. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL oauth 0.99.8 - - The debug and debugInfo members were added - - - - - - - - - &reftitle.seealso; - - OAuth::disableDebug - - - - - diff --git a/reference/oauth/oauth/enableredirects.xml b/reference/oauth/oauth/enableredirects.xml deleted file mode 100644 index 49575da8a18c..000000000000 --- a/reference/oauth/oauth/enableredirects.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - OAuth::enableRedirects - Turn on redirects - - - - &reftitle.description; - - public boolOAuth::enableRedirects - - - - Follow and sign redirects automatically, which is enabled by default. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; - - - - - &reftitle.seealso; - - OAuth::disableRedirects - - - - - diff --git a/reference/oauth/oauth/enablesslchecks.xml b/reference/oauth/oauth/enablesslchecks.xml deleted file mode 100644 index 46840ac1eb9e..000000000000 --- a/reference/oauth/oauth/enablesslchecks.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - OAuth::enableSSLChecks - Turn on SSL checks - - - - &reftitle.description; - - public boolOAuth::enableSSLChecks - - - - Turns on the usual SSL peer certificate and host checks (enabled by default). - Alternatively, the sslChecks property can be set to a - non-&false; value to turn SSL checks on. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL oauth 0.99.8 - - The sslChecks member was added - - - - - - - - - &reftitle.seealso; - - OAuth::disableSSLChecks - - - - - diff --git a/reference/oauth/oauth/fetch.xml b/reference/oauth/oauth/fetch.xml deleted file mode 100644 index 5508d8ffc5bb..000000000000 --- a/reference/oauth/oauth/fetch.xml +++ /dev/null @@ -1,164 +0,0 @@ - - - - - OAuth::fetch - Fetch an OAuth protected resource - - - - &reftitle.description; - - public mixedOAuth::fetch - stringprotected_resource_url - arrayextra_parameters - stringhttp_method - arrayhttp_headers - - - Fetch a resource. - - - - - &reftitle.parameters; - - - protected_resource_url - - - URL to the OAuth protected resource. - - - - - extra_parameters - - - Extra parameters to send with the request for the resource. - - - - - http_method - - - One of the OAUTH_HTTP_METHOD_* - OAUTH constants, which includes - GET, POST, PUT, HEAD, or DELETE. - - - HEAD (OAUTH_HTTP_METHOD_HEAD) can be useful for - discovering information prior to the request (if OAuth credentials are - in the Authorization header). - - - - - http_headers - - - HTTP client headers (such as User-Agent, Accept, etc.) - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL oauth 1.0.0 - - &oauth.changelog.error.null; - - - - PECL oauth 0.99.5 - - The http_method parameter was added - - - - PECL oauth 0.99.8 - - The http_headers parameter was added - - - - - - - - - &reftitle.examples; - - <function>OAuth::fetch</function> example - -setToken("access_token","access_token_secret"); - - $oauth->fetch("http://photos.example.net/photo?file=vacation.jpg"); - - $response_info = $oauth->getLastResponseInfo(); - header("Content-Type: {$response_info["content_type"]}"); - echo $oauth->getLastResponse(); -} catch(OAuthException $E) { - echo "Exception caught!\n"; - echo "Response: ". $E->lastResponse . "\n"; -} -?> -]]> - - - - - - &reftitle.seealso; - - OAuth::getLastResponse - OAuth::getLastResponseInfo - OAuth::setToken - - - - - diff --git a/reference/oauth/oauth/generatesignature.xml b/reference/oauth/oauth/generatesignature.xml deleted file mode 100644 index 62c21cfc2c55..000000000000 --- a/reference/oauth/oauth/generatesignature.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - OAuth::generateSignature - Generate a signature - - - - &reftitle.description; - - public stringfalseOAuth::generateSignature - stringhttp_method - stringurl - mixedextra_parameters - - - Generate a signature based on the final HTTP method, URL and a string/array of parameters. - - - - - - &reftitle.parameters; - - - http_method - - - HTTP method for request - - - - - url - - - URL for request - - - - - extra_parameters - - - String or array of additional parameters. - - - - - - - - &reftitle.returnvalues; - - A string containing the generated signature&return.falseforfailure; - - - - - - diff --git a/reference/oauth/oauth/getaccesstoken.xml b/reference/oauth/oauth/getaccesstoken.xml deleted file mode 100644 index a89a5e4d1098..000000000000 --- a/reference/oauth/oauth/getaccesstoken.xml +++ /dev/null @@ -1,171 +0,0 @@ - - - - - OAuth::getAccessToken - Fetch an access token - - - - &reftitle.description; - - public arrayOAuth::getAccessToken - stringaccess_token_url - stringauth_session_handle - stringverifier_token - stringhttp_method - - - Fetch an access token, secret and any additional response parameters from the service provider. - - - - - &reftitle.parameters; - - - access_token_url - - - URL to the access token API. - - - - - auth_session_handle - - - Authorization session handle, this parameter does not have any - citation in the core OAuth 1.0 specification but may be - implemented by large providers. - See ScalableOAuth - for more information. - - - - - verifier_token - - - For service providers which support 1.0a, a verifier_token - must be passed while exchanging the request token for the access - token. If the verifier_token is present in $_GET - or $_POST it is passed automatically and the caller - does not need to specify a verifier_token (usually if the access token - is exchanged at the oauth_callback URL). - See ScalableOAuth - for more information. - - - - - http_method - - - HTTP method to use, e.g. GET or POST. - - - - - - - - &reftitle.returnvalues; - - Returns an array containing the parsed OAuth response on success or &false; on failure. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL oauth 1.0.0 - - &oauth.changelog.error.null; - - - - PECL oauth 0.99.9 - - The verifier_token parameter was added - - - - - - - - - &reftitle.examples; - - <function>OAuth::getAccessToken</function> example - -setToken($request_token,$request_token_secret); - $access_token_info = $oauth->getAccessToken("https://example.com/oauth/access_token"); - if(!empty($access_token_info)) { - print_r($access_token_info); - } else { - print "Failed fetching access token, response was: " . $oauth->getLastResponse(); - } -} catch(OAuthException $E) { - echo "Response: ". $E->lastResponse . "\n"; -} -?> -]]> - - &example.outputs.similar; - - some_token - [oauth_token_secret] => some_token_secret -) -]]> - - - - - - &reftitle.seealso; - - OAuth::getLastResponse - OAuth::getLastResponseInfo - OAuth::setToken - - - - - diff --git a/reference/oauth/oauth/getcapath.xml b/reference/oauth/oauth/getcapath.xml deleted file mode 100644 index 22f2513f0720..000000000000 --- a/reference/oauth/oauth/getcapath.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - OAuth::getCAPath - Gets CA information - - - - &reftitle.description; - - public arrayOAuth::getCAPath - - - - Gets the Certificate Authority information, which includes the - ca_path and ca_info set by OAuth::setCaPath. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - An array of Certificate Authority information, specifically as - ca_path and ca_info keys within the returned - associative array. - - - - - &reftitle.seealso; - - OAuth::setCAPath - OAuth::getLastResponseInfo - - - - - diff --git a/reference/oauth/oauth/getlastresponse.xml b/reference/oauth/oauth/getlastresponse.xml deleted file mode 100644 index 333e20e93c1b..000000000000 --- a/reference/oauth/oauth/getlastresponse.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - OAuth::getLastResponse - Get the last response - - - - &reftitle.description; - - public stringOAuth::getLastResponse - - - - Get the raw response of the most recent request. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a string containing the last response. - - - - - &reftitle.seealso; - - OAuth::getLastResponseInfo - OAuth::fetch - - - - - diff --git a/reference/oauth/oauth/getlastresponseheaders.xml b/reference/oauth/oauth/getlastresponseheaders.xml deleted file mode 100644 index 1a1df9e29518..000000000000 --- a/reference/oauth/oauth/getlastresponseheaders.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - OAuth::getLastResponseHeaders - Get headers for last response - - - - &reftitle.description; - - public stringfalseOAuth::getLastResponseHeaders - - - - Get headers for last response. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A string containing the last response's headers&return.falseforfailure; - - - - - - diff --git a/reference/oauth/oauth/getlastresponseinfo.xml b/reference/oauth/oauth/getlastresponseinfo.xml deleted file mode 100644 index 221990d77719..000000000000 --- a/reference/oauth/oauth/getlastresponseinfo.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - OAuth::getLastResponseInfo - Get HTTP information about the last response - - - - &reftitle.description; - - public arrayOAuth::getLastResponseInfo - - - - Get HTTP information about the last response. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an array containing the response information for the last - request. Constants from curl_getinfo may be - used. - - - - - &reftitle.seealso; - - OAuth::fetch - OAuth::getLastResponse - - - - - diff --git a/reference/oauth/oauth/getrequestheader.xml b/reference/oauth/oauth/getrequestheader.xml deleted file mode 100644 index df39f8f7a6c3..000000000000 --- a/reference/oauth/oauth/getrequestheader.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - OAuth::getRequestHeader - Generate OAuth header string signature - - - - &reftitle.description; - - public stringfalseOAuth::getRequestHeader - stringhttp_method - stringurl - mixedextra_parameters - - - Generate OAuth header string signature based on the final HTTP method, URL and a string/array of parameters - - - - - &reftitle.parameters; - - - http_method - - - HTTP method for request. - - - - - url - - - URL for request. - - - - - extra_parameters - - - String or array of additional parameters. - - - - - - - - &reftitle.returnvalues; - - A string containing the generated request header&return.falseforfailure; - - - - - - diff --git a/reference/oauth/oauth/getrequesttoken.xml b/reference/oauth/oauth/getrequesttoken.xml deleted file mode 100644 index e3fb021df4ec..000000000000 --- a/reference/oauth/oauth/getrequesttoken.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - OAuth::getRequestToken - Fetch a request token - - - - &reftitle.description; - - public arrayOAuth::getRequestToken - stringrequest_token_url - stringcallback_url - stringhttp_method - - - Fetch a request token, secret and any additional response parameters from the service provider. - - - - - &reftitle.parameters; - - - request_token_url - - - URL to the request token API. - - - - - callback_url - - - OAuth callback URL. If callback_url is passed and is an empty value, it is set to "oob" to address the OAuth 2009.1 advisory. - - - - - http_method - - - HTTP method to use, e.g. GET or POST. - - - - - - - - &reftitle.returnvalues; - - Returns an array containing the parsed OAuth response on success or &false; on failure. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL oauth 1.0.0 - - &oauth.changelog.error.null; - - - - PECL oauth 0.99.9 - - The callback_url parameter was added - - - - - - - - - &reftitle.examples; - - <function>OAuth::getRequestToken</function> example - -getRequestToken("https://example.com/oauth/request_token"); - if(!empty($request_token_info)) { - print_r($request_token_info); - } else { - print "Failed fetching request token, response was: " . $oauth->getLastResponse(); - } -} catch(OAuthException $E) { - echo "Response: ". $E->lastResponse . "\n"; -} -?> -]]> - - &example.outputs.similar; - - some_token - [oauth_token_secret] => some_token_secret -) -]]> - - - - - - &reftitle.seealso; - - OAuth::getLastResponse - OAuth::getLastResponseInfo - - - - - diff --git a/reference/oauth/oauth/setauthtype.xml b/reference/oauth/oauth/setauthtype.xml deleted file mode 100644 index 2c7c1fbba8c1..000000000000 --- a/reference/oauth/oauth/setauthtype.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - OAuth::setAuthType - Set authorization type - - - - &reftitle.description; - - public boolOAuth::setAuthType - intauth_type - - - Set where the OAuth parameters should be passed. - - - - - &reftitle.parameters; - - - auth_type - - - auth_type can be one of the following flags (in order of decreasing preference as per OAuth 1.0 section 5.2): - - - OAUTH_AUTH_TYPE_AUTHORIZATION - - - Pass the OAuth parameters in the HTTP Authorization header. - - - - - OAUTH_AUTH_TYPE_FORM - - - Append the OAuth parameters to the HTTP POST request body. - - - - - OAUTH_AUTH_TYPE_URI - - - Append the OAuth parameters to the request URI. - - - - - OAUTH_AUTH_TYPE_NONE - - - None. - - - - - - - - - - - - &reftitle.returnvalues; - - Returns &true; if a parameter is correctly set, otherwise &false; - (e.g., if an invalid auth_type is passed in.) - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL oauth 1.0.0 - - &oauth.changelog.error.null; - - - - - - - - - diff --git a/reference/oauth/oauth/setcapath.xml b/reference/oauth/oauth/setcapath.xml deleted file mode 100644 index 4b15758c2019..000000000000 --- a/reference/oauth/oauth/setcapath.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - OAuth::setCAPath - Set CA path and info - - - - &reftitle.description; - - public mixedOAuth::setCAPath - stringca_path - stringca_info - - - Sets the Certificate Authority (CA), both for path - and info. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - ca_path - - - The CA Path being set. - - - - - ca_info - - - The CA Info being set. - - - - - - - - - &reftitle.returnvalues; - - Returns &true; on success, or &false; if either ca_path - or ca_info are considered invalid. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL oauth 1.0.0 - - &oauth.changelog.error.null; - - - - - - - - - &reftitle.seealso; - - OAuth::getCaPath - - - - - diff --git a/reference/oauth/oauth/setnonce.xml b/reference/oauth/oauth/setnonce.xml deleted file mode 100644 index 342028afcb0f..000000000000 --- a/reference/oauth/oauth/setnonce.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - OAuth::setNonce - Set the nonce for subsequent requests - - - - &reftitle.description; - - public mixedOAuth::setNonce - stringnonce - - - Sets the nonce for all subsequent requests. - - - - - &reftitle.parameters; - - - nonce - - - The value for oauth_nonce. - - - - - - - - &reftitle.returnvalues; - - Returns &true; on success, or &false; if the - nonce is considered invalid. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL oauth 1.0.0 - - &oauth.changelog.error.null; - - - - - - - - - &reftitle.seealso; - - OAuth::setToken - OAuth::setAuthType - OAuth::setVersion - - - - - diff --git a/reference/oauth/oauth/setrequestengine.xml b/reference/oauth/oauth/setrequestengine.xml deleted file mode 100644 index c29a0dbe6e9a..000000000000 --- a/reference/oauth/oauth/setrequestengine.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - OAuth::setRequestEngine - The setRequestEngine purpose - - - - &reftitle.description; - - public voidOAuth::setRequestEngine - intreqengine - - - Sets the Request Engine, that will be sending the HTTP requests. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - reqengine - - - The desired request engine. Set to OAUTH_REQENGINE_STREAMS - to use PHP Streams, or OAUTH_REQENGINE_CURL to use - Curl. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - Emits an OAuthException exception if an invalid - request engine is chosen. - - - - - &reftitle.examples; - - <function>OAuth::setRequestEngine</function> example - -setRequestEngine(OAUTH_REQENGINE_STREAMS); -?> -]]> - - - - - - &reftitle.seealso; - - Curl - PHP streams - OAuthException - - - - diff --git a/reference/oauth/oauth/setrsacertificate.xml b/reference/oauth/oauth/setrsacertificate.xml deleted file mode 100644 index e05891e16456..000000000000 --- a/reference/oauth/oauth/setrsacertificate.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - OAuth::setRSACertificate - Set the RSA certificate - - - - &reftitle.description; - - public mixedOAuth::setRSACertificate - stringcert - - - Sets the RSA certificate. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - cert - - - The RSA certificate. - - - - - - - - &reftitle.returnvalues; - - Returns &true; on success, or &false; on failure (e.g., the RSA certificate - cannot be parsed.) - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL oauth 1.0.0 - - &oauth.changelog.error.null; - - - - - - - - - &reftitle.examples; - - An <methodname>OAuth::setRsaCertificate</methodname> example - -setRSACertificate(file_get_contents('test.pem')); -?> -]]> - - - - - - &reftitle.seealso; - - OAuth::setCaPath - - - - - diff --git a/reference/oauth/oauth/setsslchecks.xml b/reference/oauth/oauth/setsslchecks.xml deleted file mode 100644 index 2a736bf9da75..000000000000 --- a/reference/oauth/oauth/setsslchecks.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - OAuth::setSSLChecks - Tweak specific SSL checks for requests - - - - &reftitle.description; - - public boolOAuth::setSSLChecks - intsslcheck - - - Tweak specific SSL checks for requests. - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - sslcheck - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/oauth/oauth/settimestamp.xml b/reference/oauth/oauth/settimestamp.xml deleted file mode 100644 index 1d2c405c87eb..000000000000 --- a/reference/oauth/oauth/settimestamp.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - OAuth::setTimestamp - Set the timestamp - - - - &reftitle.description; - - public mixedOAuth::setTimestamp - stringtimestamp - - - Sets the OAuth timestamp for subsequent requests. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - timestamp - - - The timestamp. - - - - - - - - &reftitle.returnvalues; - - Returns &true;, unless the timestamp is invalid, in which - case &false; is returned. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL oauth 1.0.0 - - &oauth.changelog.error.null; - - - - - - - - - &reftitle.seealso; - - OAuth::setNonce - - - - - diff --git a/reference/oauth/oauth/settoken.xml b/reference/oauth/oauth/settoken.xml deleted file mode 100644 index c895962a9049..000000000000 --- a/reference/oauth/oauth/settoken.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - OAuth::setToken - Sets the token and secret - - - - &reftitle.description; - - public boolOAuth::setToken - stringtoken - stringtoken_secret - - - Set the token and secret for subsequent requests. - - - - - &reftitle.parameters; - - - token - - - The OAuth token. - - - - - token_secret - - - The OAuth token secret. - - - - - - - - &reftitle.returnvalues; - - &true; - - - - - &reftitle.examples; - - <function>OAuth::setToken</function> example - -setToken("token","token-secret"); -?> -]]> - - - - - - diff --git a/reference/oauth/oauth/setversion.xml b/reference/oauth/oauth/setversion.xml deleted file mode 100644 index 7f96fcce644e..000000000000 --- a/reference/oauth/oauth/setversion.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - OAuth::setVersion - Set the OAuth version - - - - &reftitle.description; - - public boolOAuth::setVersion - stringversion - - - Sets the OAuth version for subsequent requests - - - - - &reftitle.parameters; - - - version - - - OAuth version, default value is always "1.0" - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/oauth/oauthexception.xml b/reference/oauth/oauthexception.xml deleted file mode 100644 index 8f380b17d4e8..000000000000 --- a/reference/oauth/oauthexception.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - OAuthException class - OAuthException - - - - -
    - &reftitle.intro; - - This exception is thrown when exceptional errors occur while using the OAuth extension and contains useful debugging information. - -
    - - -
    - &reftitle.classsynopsis; - - - - OAuthException - - - - - OAuthException - - - - extends - Exception - - - - &Properties; - - public - lastResponse - - - public - debugInfo - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
    - - - -
    - &reftitle.properties; - - - lastResponse - - The response of the exception which occurred, if any - - - - debugInfo - - - - - -
    - - -
    - -
    - diff --git a/reference/oauth/oauthprovider.xml b/reference/oauth/oauthprovider.xml deleted file mode 100644 index 90352860097f..000000000000 --- a/reference/oauth/oauthprovider.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - The OAuthProvider class - OAuthProvider - - - - -
    - &reftitle.intro; - - Manages an OAuth provider class. - - - See also an external in-depth tutorial titled - Writing an OAuth Provider Service, - which takes a hands-on approach to providing this service. There are also - OAuth provider examples within the OAuth - extensions sources. - -
    - - -
    - &reftitle.classsynopsis; - - - - OAuthProvider - - - - - OAuthProvider - - - - - &Methods; - - - - -
    - -
    - - &reference.oauth.entities.oauthprovider; - -
    - diff --git a/reference/oauth/oauthprovider/addrequiredparameter.xml b/reference/oauth/oauthprovider/addrequiredparameter.xml deleted file mode 100644 index ec694b532df6..000000000000 --- a/reference/oauth/oauthprovider/addrequiredparameter.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - OAuthProvider::addRequiredParameter - Add required parameters - - - - &reftitle.description; - - final public boolOAuthProvider::addRequiredParameter - stringreq_params - - - Add required oauth provider parameters. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - req_params - - - The required parameters. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - OAuthProvider::removeRequiredParameter - - - - - diff --git a/reference/oauth/oauthprovider/callconsumerhandler.xml b/reference/oauth/oauthprovider/callconsumerhandler.xml deleted file mode 100644 index 3df61cf0435f..000000000000 --- a/reference/oauth/oauthprovider/callconsumerhandler.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - OAuthProvider::callconsumerHandler - Calls the consumerNonceHandler callback - - - - &reftitle.description; - - public voidOAuthProvider::callconsumerHandler - - - - Calls the registered consumer handler callback function, which is set - with OAuthProvider::consumerHandler. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &oauth.callback.error; - - - - - &reftitle.seealso; - - OAuthProvider::consumerHandler - - - - - diff --git a/reference/oauth/oauthprovider/calltimestampnoncehandler.xml b/reference/oauth/oauthprovider/calltimestampnoncehandler.xml deleted file mode 100644 index 6b19bb822902..000000000000 --- a/reference/oauth/oauthprovider/calltimestampnoncehandler.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - OAuthProvider::callTimestampNonceHandler - Calls the timestampNonceHandler callback - - - - &reftitle.description; - - public voidOAuthProvider::callTimestampNonceHandler - - - - Calls the registered timestamp handler callback function, which is set - with OAuthProvider::timestampNonceHandler. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &oauth.callback.error; - - - - - &reftitle.seealso; - - OAuthProvider::timestampNonceHandler - - - - - diff --git a/reference/oauth/oauthprovider/calltokenhandler.xml b/reference/oauth/oauthprovider/calltokenhandler.xml deleted file mode 100644 index 050d3a9b0c4f..000000000000 --- a/reference/oauth/oauthprovider/calltokenhandler.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - OAuthProvider::calltokenHandler - Calls the tokenNonceHandler callback - - - - &reftitle.description; - - public voidOAuthProvider::calltokenHandler - - - - Calls the registered token handler callback function, which is set - with OAuthProvider::tokenHandler. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &oauth.callback.error; - - - - - &reftitle.seealso; - - OAuthProvider::tokenHandler - - - - - diff --git a/reference/oauth/oauthprovider/checkoauthrequest.xml b/reference/oauth/oauthprovider/checkoauthrequest.xml deleted file mode 100644 index 8b06ac3a8124..000000000000 --- a/reference/oauth/oauthprovider/checkoauthrequest.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - OAuthProvider::checkOAuthRequest - Check an oauth request - - - - &reftitle.description; - - public voidOAuthProvider::checkOAuthRequest - stringuri - stringmethod - - - Checks an OAuth request. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - uri - - - The optional URI, or endpoint. - - - - - method - - - The HTTP method. Optionally pass in one of the - OAUTH_HTTP_METHOD_* OAuth constants. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - Emits an E_ERROR level error if - the HTTP method cannot be detected. - - - - - &reftitle.seealso; - - OAuthProvider::reportProblem - - - - - diff --git a/reference/oauth/oauthprovider/construct.xml b/reference/oauth/oauthprovider/construct.xml deleted file mode 100644 index 9b54240a92a9..000000000000 --- a/reference/oauth/oauthprovider/construct.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - OAuthProvider::__construct - Constructs a new OAuthProvider object - - - - &reftitle.description; - - public OAuthProvider::__construct - arrayparams_array - - - Initiates a new OAuthProvider object. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - params_array - - - Setting these optional parameters is limited to the - CLI SAPI. - - - - - - - - &reftitle.returnvalues; - - An OAuthProvider object. - - - - - &reftitle.examples; - - <function>OAuthProvider::__construct</function> example - -consumerHandler(array($this, 'lookupConsumer')); - $op->timestampNonceHandler(array($this, 'timestampNonceChecker')); - $op->tokenHandler(array($this, 'myTokenHandler')); - - // Ignore the foo_uri parameter - $op->setParam('foo_uri', NULL); - - // No token needed for this end point - $op->setRequestTokenPath('/v1/oauth/request_token'); - - $op->checkOAuthRequest(); - -} catch (OAuthException $e) { - - echo OAuthProvider::reportProblem($e); -} -?> -]]> - - - - - - &reftitle.seealso; - - OAuthProvider::setParam - - - - - diff --git a/reference/oauth/oauthprovider/consumerhandler.xml b/reference/oauth/oauthprovider/consumerhandler.xml deleted file mode 100644 index 092d541723a1..000000000000 --- a/reference/oauth/oauthprovider/consumerhandler.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - OAuthProvider::consumerHandler - Set the consumerHandler handler callback - - - - &reftitle.description; - - public voidOAuthProvider::consumerHandler - callablecallback_function - - - Sets the consumer handler callback, which will later be called with - OAuthProvider::callConsumerHandler. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - callback_function - - - The callable functions name. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Example <methodname>OAuthProvider::consumerHandler</methodname> callback - -consumer_key === 'unknown') { - return OAUTH_CONSUMER_KEY_UNKNOWN; - } else if($provider->consumer_key == 'blacklisted' || $provider->consumer_key === 'throttled') { - return OAUTH_CONSUMER_KEY_REFUSED; - } - - $provider->consumer_secret = "the_consumers_secret"; - - return OAUTH_OK; -} -?> -]]> - - - - - - &reftitle.seealso; - - OAuthProvider::callConsumerHandler - - - - - diff --git a/reference/oauth/oauthprovider/generatetoken.xml b/reference/oauth/oauthprovider/generatetoken.xml deleted file mode 100644 index 344ccebb31e0..000000000000 --- a/reference/oauth/oauthprovider/generatetoken.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - OAuthProvider::generateToken - Generate a random token - - - - &reftitle.description; - - final public static stringOAuthProvider::generateToken - intsize - boolstrong&false; - - - Generates a string of pseudo-random bytes. - - - - - &reftitle.parameters; - - - size - - - The desired token length, in terms of bytes. - - - - - strong - - - Setting to &true; means /dev/random will be used for - entropy, as otherwise the non-blocking /dev/urandom is used. - This parameter is ignored on Windows. - - - - - - - - &reftitle.returnvalues; - - The generated token, as a string of bytes. - - - - - &reftitle.errors; - - If the strong parameter is &true;, then an - E_WARNING level error will be emitted when the - fallback rand implementation is used to fill - the remaining random bytes (e.g., when not enough random data was found, - initially). - - - - - &reftitle.examples; - - <function>OAuthProvider::generateToken</function> example - -generateToken(4); - -echo strlen($t), PHP_EOL; -echo bin2hex($t), PHP_EOL; - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.notes; - - - When not enough random data is available to the system, this function will - fill the remaining random bytes using the internal PHP rand - implementation. - - - - - - &reftitle.seealso; - - openssl_random_pseudo_bytes - mcrypt_create_iv - - - - - diff --git a/reference/oauth/oauthprovider/is2leggedendpoint.xml b/reference/oauth/oauthprovider/is2leggedendpoint.xml deleted file mode 100644 index 5b02a339d302..000000000000 --- a/reference/oauth/oauthprovider/is2leggedendpoint.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - OAuthProvider::is2LeggedEndpoint - is2LeggedEndpoint - - - - &reftitle.description; - - public voidOAuthProvider::is2LeggedEndpoint - mixedparams_array - - - The 2-legged flow, or request signing. It does not require a token. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - params_array - - - - - - - - - - - &reftitle.returnvalues; - - An OAuthProvider object. - - - - - &reftitle.examples; - - <function>OAuthProvider::is2LeggedEndpoint</function> example - -is2LeggedEndpoint(true); - -?> -]]> - - - - - - &reftitle.seealso; - - OAuthProvider::__construct - - - - - diff --git a/reference/oauth/oauthprovider/isrequesttokenendpoint.xml b/reference/oauth/oauthprovider/isrequesttokenendpoint.xml deleted file mode 100644 index 7b192c9fa5ec..000000000000 --- a/reference/oauth/oauthprovider/isrequesttokenendpoint.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - OAuthProvider::isRequestTokenEndpoint - Sets isRequestTokenEndpoint - - - - &reftitle.description; - - public voidOAuthProvider::isRequestTokenEndpoint - boolwill_issue_request_token - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - will_issue_request_token - - - Sets whether or not it will issue a request token, thus determining if - OAuthProvider::tokenHandler needs to be called. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - OAuthProvider::setRequestTokenPath - OAuthProvider::reportProblem - - - - - diff --git a/reference/oauth/oauthprovider/removerequiredparameter.xml b/reference/oauth/oauthprovider/removerequiredparameter.xml deleted file mode 100644 index b13fd46791b0..000000000000 --- a/reference/oauth/oauthprovider/removerequiredparameter.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - OAuthProvider::removeRequiredParameter - Remove a required parameter - - - - &reftitle.description; - - final public boolOAuthProvider::removeRequiredParameter - stringreq_params - - - Removes a required parameter. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - req_params - - - The required parameter to be removed. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - OAuthProvider::setParam - OAuthProvider::addRequiredParameter - - - - - diff --git a/reference/oauth/oauthprovider/reportproblem.xml b/reference/oauth/oauthprovider/reportproblem.xml deleted file mode 100644 index 109eab1a6ce6..000000000000 --- a/reference/oauth/oauthprovider/reportproblem.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - OAuthProvider::reportProblem - Report a problem - - - - &reftitle.description; - - final public static stringOAuthProvider::reportProblem - stringoauthexception - boolsend_headers&true; - - - Pass in a problem as an OAuthException, with possible problems listed - in the OAuth constants section. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - oauthexception - - - The OAuthException. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - OAuthProvider::checkOAuthRequest - OAuthProvider::isRequestTokenEndpoint - - - - - diff --git a/reference/oauth/oauthprovider/setparam.xml b/reference/oauth/oauthprovider/setparam.xml deleted file mode 100644 index 9504da506903..000000000000 --- a/reference/oauth/oauthprovider/setparam.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - OAuthProvider::setParam - Set a parameter - - - - &reftitle.description; - - final public boolOAuthProvider::setParam - stringparam_key - mixedparam_val - - - Sets a parameter. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - param_key - - - The parameter key. - - - - - param_val - - - The optional parameter value. - - - To exclude a parameter from signature verification, set - its value to &null;. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - OAuthProvider::addRequiredParameter - - - - - diff --git a/reference/oauth/oauthprovider/setrequesttokenpath.xml b/reference/oauth/oauthprovider/setrequesttokenpath.xml deleted file mode 100644 index 60aa80684749..000000000000 --- a/reference/oauth/oauthprovider/setrequesttokenpath.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - OAuthProvider::setRequestTokenPath - Set request token path - - - - &reftitle.description; - - final public boolOAuthProvider::setRequestTokenPath - stringpath - - - Sets the request tokens path. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - path - - - The path. - - - - - - - - &reftitle.returnvalues; - - &true; - - - - - &reftitle.seealso; - - OAuthProvider::tokenHandler - - - - - diff --git a/reference/oauth/oauthprovider/timestampnoncehandler.xml b/reference/oauth/oauthprovider/timestampnoncehandler.xml deleted file mode 100644 index ee8887666a36..000000000000 --- a/reference/oauth/oauthprovider/timestampnoncehandler.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - OAuthProvider::timestampNonceHandler - Set the timestampNonceHandler handler callback - - - - &reftitle.description; - - public voidOAuthProvider::timestampNonceHandler - callablecallback_function - - - Sets the timestamp nonce handler callback, which will later be called with - OAuthProvider::callTimestampNonceHandler. Errors related to - timestamp/nonce are thrown to this callback. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - callback_function - - - The callable functions name. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Example <methodname>OAuthProvider::timestampNonceHandler</methodname> callback - -nonce === 'bad') { - return OAUTH_BAD_NONCE; - } elseif ($provider->timestamp == '0') { - return OAUTH_BAD_TIMESTAMP; - } - - return OAUTH_OK; -} -?> -]]> - - - - - - &reftitle.seealso; - - OAuthProvider::callTimestampNonceHandler - - - - - diff --git a/reference/oauth/oauthprovider/tokenhandler.xml b/reference/oauth/oauthprovider/tokenhandler.xml deleted file mode 100644 index 57093cc09fbe..000000000000 --- a/reference/oauth/oauthprovider/tokenhandler.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - OAuthProvider::tokenHandler - Set the tokenHandler handler callback - - - - &reftitle.description; - - public voidOAuthProvider::tokenHandler - callablecallback_function - - - Sets the token handler callback, which will later be called with - OAuthProvider::callTokenHandler. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - callback_function - - - The callable functions name. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Example <methodname>OAuthProvider::tokenHandler</methodname> callback - -token === 'rejected') { - return OAUTH_TOKEN_REJECTED; - } elseif ($provider->token === 'revoked') { - return OAUTH_TOKEN_REVOKED; - } - - $provider->token_secret = "the_tokens_secret"; - return OAUTH_OK; -} -?> -]]> - - - - - - &reftitle.seealso; - - OAuthProvider::callTokenHandler - - - - - diff --git a/reference/oauth/reference.xml b/reference/oauth/reference.xml deleted file mode 100644 index 88445283d773..000000000000 --- a/reference/oauth/reference.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - OAuth &Functions; - - &reference.oauth.entities.functions; - - - - - diff --git a/reference/oauth/setup.xml b/reference/oauth/setup.xml deleted file mode 100644 index e7f20effd269..000000000000 --- a/reference/oauth/setup.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - &reftitle.setup; - -
    - &reftitle.required; - - PECL/oauth requires PHP 5.1 or newer, ext/hash and ext/pcre. - - - PECL/oauth may optionally require libcurl if selected at build - time. If configured with libcurl, it must be built with HTTPS - support. - -
    - - - &reference.oauth.configure; - - -
    - diff --git a/reference/oauth/versions.xml b/reference/oauth/versions.xml deleted file mode 100644 index 8313b8987a1e..000000000000 --- a/reference/oauth/versions.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/openal/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/openal/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/openal/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/openal/book.xml b/reference/openal/book.xml deleted file mode 100644 index a99175c2cd97..000000000000 --- a/reference/openal/book.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - OpenAL Audio Bindings - OpenAL - - - - &reftitle.intro; - - Platform independent audio bindings. - Requires the OpenAL library. - - - - - &reference.openal.setup; - &reference.openal.constants; - &reference.openal.reference; - - - diff --git a/reference/openal/configure.xml b/reference/openal/configure.xml deleted file mode 100644 index 3e9790e51092..000000000000 --- a/reference/openal/configure.xml +++ /dev/null @@ -1,35 +0,0 @@ - - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;openal. - - - &pecl.windows.download; - -
    - diff --git a/reference/openal/constants.xml b/reference/openal/constants.xml deleted file mode 100644 index 32d1473ddd93..000000000000 --- a/reference/openal/constants.xml +++ /dev/null @@ -1,413 +0,0 @@ - - - - &reftitle.constants; - &extension.constants; - - - - ALC_FREQUENCY - (int) - - - - Context Attribute - - - - - - ALC_REFRESH - (int) - - - - Context Attribute - - - - - - ALC_SYNC - (int) - - - - Context Attribute - - - - - - AL_FREQUENCY - (int) - - - - Buffer Setting - - - - - - AL_BITS - (int) - - - - Buffer Setting - - - - - - AL_CHANNELS - (int) - - - - Buffer Setting - - - - - - AL_SIZE - (int) - - - - Buffer Setting - - - - - - AL_BUFFER - (int) - - - - Source/Listener Setting (Integer) - - - - - - AL_SOURCE_RELATIVE - (int) - - - - Source/Listener Setting (Integer) - - - - - - AL_SOURCE_STATE - (int) - - - - Source/Listener Setting (Integer) - - - - - - AL_PITCH - (int) - - - - Source/Listener Setting (Float) - - - - - - AL_GAIN - (int) - - - - Source/Listener Setting (Float) - - - - - - AL_MIN_GAIN - (int) - - - - Source/Listener Setting (Float) - - - - - - AL_MAX_GAIN - (int) - - - - Source/Listener Setting (Float) - - - - - - AL_MAX_DISTANCE - (int) - - - - Source/Listener Setting (Float) - - - - - - AL_ROLLOFF_FACTOR - (int) - - - - Source/Listener Setting (Float) - - - - - - AL_CONE_OUTER_GAIN - (int) - - - - Source/Listener Setting (Float) - - - - - - AL_CONE_INNER_ANGLE - (int) - - - - Source/Listener Setting (Float) - - - - - - AL_CONE_OUTER_ANGLE - (int) - - - - Source/Listener Setting (Float) - - - - - - AL_REFERENCE_DISTANCE - (int) - - - - Source/Listener Setting (Float) - - - - - - AL_POSITION - (int) - - - - Source/Listener Setting (Float Vector) - - - - - - AL_VELOCITY - (int) - - - - Source/Listener Setting (Float Vector) - - - - - - AL_DIRECTION - (int) - - - - Source/Listener Setting (Float Vector) - - - - - - AL_ORIENTATION - (int) - - - - Source/Listener Setting (Float Vector) - - - - - - AL_FORMAT_MONO8 - (int) - - - - PCM Format - - - - - - AL_FORMAT_MONO16 - (int) - - - - PCM Format - - - - - - AL_FORMAT_STEREO8 - (int) - - - - PCM Format - - - - - - AL_FORMAT_STEREO16 - (int) - - - - PCM Format - - - - - - AL_INITIAL - (int) - - - - Source State - - - - - - AL_PLAYING - (int) - - - - Source State - - - - - - AL_PAUSED - (int) - - - - Source State - - - - - - AL_STOPPED - (int) - - - - Source State - - - - - - AL_LOOPING - (int) - - - - Source State - - - - - - AL_TRUE - (int) - - - - Boolean value recognized by OpenAL - - - - - - AL_FALSE - (int) - - - - Boolean value recognized by OpenAL - - - - - - diff --git a/reference/openal/functions/openal-buffer-create.xml b/reference/openal/functions/openal-buffer-create.xml deleted file mode 100644 index 88a38b0d3bb0..000000000000 --- a/reference/openal/functions/openal-buffer-create.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - openal_buffer_create - - Generate OpenAL buffer - - - - &reftitle.description; - - resourceopenal_buffer_create - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an Open AL(Buffer) resource on success or - &false; on failure. - - - - &reftitle.seealso; - - openal_buffer_loadwav - openal_buffer_data - - - - diff --git a/reference/openal/functions/openal-buffer-data.xml b/reference/openal/functions/openal-buffer-data.xml deleted file mode 100644 index ad23e7bec490..000000000000 --- a/reference/openal/functions/openal-buffer-data.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - openal_buffer_data - - Load a buffer with data - - - - &reftitle.description; - - boolopenal_buffer_data - resourcebuffer - intformat - stringdata - intfreq - - - - &reftitle.parameters; - - - buffer - - - An Open AL(Buffer) resource - (previously created by openal_buffer_create). - - - - - format - - - Format of data, one of: - AL_FORMAT_MONO8, - AL_FORMAT_MONO16, - AL_FORMAT_STEREO8&listendand; - AL_FORMAT_STEREO16 - - - - - data - - - Block of binary audio data in the format and - freq specified. - - - - - freq - - - Frequency of data given in Hz. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - openal_buffer_loadwav - openal_stream - - - - diff --git a/reference/openal/functions/openal-buffer-destroy.xml b/reference/openal/functions/openal-buffer-destroy.xml deleted file mode 100644 index 091b449053f8..000000000000 --- a/reference/openal/functions/openal-buffer-destroy.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - openal_buffer_destroy - - Destroys an OpenAL buffer - - - - &reftitle.description; - - boolopenal_buffer_destroy - resourcebuffer - - - - &reftitle.parameters; - - - buffer - - - An Open AL(Buffer) resource - (previously created by openal_buffer_create). - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - openal_buffer_create - - - - diff --git a/reference/openal/functions/openal-buffer-get.xml b/reference/openal/functions/openal-buffer-get.xml deleted file mode 100644 index 1eb1523bc97c..000000000000 --- a/reference/openal/functions/openal-buffer-get.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - openal_buffer_get - - Retrieve an OpenAL buffer property - - - - &reftitle.description; - - intfalseopenal_buffer_get - resourcebuffer - intproperty - - - - &reftitle.parameters; - - - buffer - - - An Open AL(Buffer) resource - (previously created by openal_buffer_create). - - - - - property - - - Specific property, one of: - AL_FREQUENCY, - AL_BITS, - AL_CHANNELS&listendand; - AL_SIZE. - - - - - - - - &reftitle.returnvalues; - - Returns an integer value appropriate to the property - requested&return.falseforfailure;. - - - - &reftitle.seealso; - - openal_buffer_create - - - - diff --git a/reference/openal/functions/openal-buffer-loadwav.xml b/reference/openal/functions/openal-buffer-loadwav.xml deleted file mode 100644 index de0b68d02be4..000000000000 --- a/reference/openal/functions/openal-buffer-loadwav.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - openal_buffer_loadwav - - Load a .wav file into a buffer - - - - &reftitle.description; - - boolopenal_buffer_loadwav - resourcebuffer - stringwavfile - - - - &reftitle.parameters; - - - buffer - - - An Open AL(Buffer) resource - (previously created by openal_buffer_create). - - - - - wavfile - - - Path to .wav file on - local file system. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - openal_buffer_data - openal_stream - - - - diff --git a/reference/openal/functions/openal-context-create.xml b/reference/openal/functions/openal-context-create.xml deleted file mode 100644 index 58c838897fb9..000000000000 --- a/reference/openal/functions/openal-context-create.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - openal_context_create - - Create an audio processing context - - - - &reftitle.description; - - resourceopenal_context_create - resourcedevice - - - - &reftitle.parameters; - - - device - - - An Open AL(Device) resource - (previously created by openal_device_open). - - - - - - - &reftitle.returnvalues; - - Returns an Open AL(Context) resource on success or - &false; on failure. - - - - &reftitle.seealso; - - openal_device_open - openal_context_destroy - - - - diff --git a/reference/openal/functions/openal-context-current.xml b/reference/openal/functions/openal-context-current.xml deleted file mode 100644 index 1dd4ea11de93..000000000000 --- a/reference/openal/functions/openal-context-current.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - openal_context_current - - Make the specified context current - - - - &reftitle.description; - - boolopenal_context_current - resourcecontext - - - - &reftitle.parameters; - - - context - - - An Open AL(Context) resource - (previously created by openal_context_create). - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - openal_context_create - - - - diff --git a/reference/openal/functions/openal-context-destroy.xml b/reference/openal/functions/openal-context-destroy.xml deleted file mode 100644 index 69dd09e25e94..000000000000 --- a/reference/openal/functions/openal-context-destroy.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - openal_context_destroy - - Destroys a context - - - - &reftitle.description; - - boolopenal_context_destroy - resourcecontext - - - - &reftitle.parameters; - - - context - - - An Open AL(Context) resource - (previously created by openal_context_create). - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - openal_context_create - - - - diff --git a/reference/openal/functions/openal-context-process.xml b/reference/openal/functions/openal-context-process.xml deleted file mode 100644 index 864e2fc8e459..000000000000 --- a/reference/openal/functions/openal-context-process.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - openal_context_process - - Process the specified context - - - - &reftitle.description; - - boolopenal_context_process - resourcecontext - - - - &reftitle.parameters; - - - context - - - An Open AL(Context) resource - (previously created by openal_context_create). - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - openal_context_create - openal_context_current - openal_context_suspend - - - - diff --git a/reference/openal/functions/openal-context-suspend.xml b/reference/openal/functions/openal-context-suspend.xml deleted file mode 100644 index 6733c13a19c2..000000000000 --- a/reference/openal/functions/openal-context-suspend.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - openal_context_suspend - - Suspend the specified context - - - - &reftitle.description; - - boolopenal_context_suspend - resourcecontext - - - - &reftitle.parameters; - - - context - - - An Open AL(Context) resource - (previously created by openal_context_create). - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - openal_context_create - openal_context_current - openal_context_process - - - - diff --git a/reference/openal/functions/openal-device-close.xml b/reference/openal/functions/openal-device-close.xml deleted file mode 100644 index 6b92a01c6c2d..000000000000 --- a/reference/openal/functions/openal-device-close.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - openal_device_close - - Close an OpenAL device - - - - &reftitle.description; - - boolopenal_device_close - resourcedevice - - - - &reftitle.parameters; - - - device - - - An Open AL(Device) resource - (previously created by openal_device_open) - to be closed. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - openal_device_open - - - - diff --git a/reference/openal/functions/openal-device-open.xml b/reference/openal/functions/openal-device-open.xml deleted file mode 100644 index 0582af84ff86..000000000000 --- a/reference/openal/functions/openal-device-open.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - openal_device_open - - Initialize the OpenAL audio layer - - - - &reftitle.description; - - resourceopenal_device_open - stringdevice_desc - - - - &reftitle.parameters; - - - device_desc - - - Open an audio device optionally specified by device_desc. - If device_desc is not specified the first available audio - device will be used. - - - - - - - &reftitle.returnvalues; - - Returns an Open AL(Device) resource on success or - &false; on failure. - - - - &reftitle.seealso; - - openal_device_close - openal_context_create - - - - diff --git a/reference/openal/functions/openal-listener-get.xml b/reference/openal/functions/openal-listener-get.xml deleted file mode 100644 index bad4dba33a20..000000000000 --- a/reference/openal/functions/openal-listener-get.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - openal_listener_get - - Retrieve a listener property - - - - &reftitle.description; - - mixedopenal_listener_get - intproperty - - - - &reftitle.parameters; - - - property - - - Property to retrieve, one of: - AL_GAIN (float), - AL_POSITION (array(float,float,float)), - AL_VELOCITY (array(float,float,float))&listendand; - AL_ORIENTATION (array(float,float,float)). - - - - - - - &reftitle.returnvalues; - - Returns a float or array of floats (as appropriate)&return.falseforfailure;. - - - - &reftitle.seealso; - - openal_listener_set - - - - diff --git a/reference/openal/functions/openal-listener-set.xml b/reference/openal/functions/openal-listener-set.xml deleted file mode 100644 index 4b453cb3ddda..000000000000 --- a/reference/openal/functions/openal-listener-set.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - openal_listener_set - - Set a listener property - - - - &reftitle.description; - - boolopenal_listener_set - intproperty - mixedsetting - - - - &reftitle.parameters; - - - property - - - Property to set, one of: - AL_GAIN (float), - AL_POSITION (array(float,float,float)), - AL_VELOCITY (array(float,float,float))&listendand; - AL_ORIENTATION (array(float,float,float)). - - - - - setting - - - Value to set, either float, or an array of floats as appropriate. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - openal_listener_get - - - - diff --git a/reference/openal/functions/openal-source-create.xml b/reference/openal/functions/openal-source-create.xml deleted file mode 100644 index 6534db392ceb..000000000000 --- a/reference/openal/functions/openal-source-create.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - openal_source_create - - Generate a source resource - - - - &reftitle.description; - - resourceopenal_source_create - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an Open AL(Source) resource on success or - &false; on failure. - - - - &reftitle.seealso; - - openal_source_set - openal_source_play - openal_source_destroy - - - - diff --git a/reference/openal/functions/openal-source-destroy.xml b/reference/openal/functions/openal-source-destroy.xml deleted file mode 100644 index ec0b7d69c0bc..000000000000 --- a/reference/openal/functions/openal-source-destroy.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - openal_source_destroy - - Destroy a source resource - - - - &reftitle.description; - - boolopenal_source_destroy - resourcesource - - - - &reftitle.parameters; - - - source - - - An Open AL(Source) resource - (previously created by openal_source_create). - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - openal_source_create - - - - diff --git a/reference/openal/functions/openal-source-get.xml b/reference/openal/functions/openal-source-get.xml deleted file mode 100644 index 9cf9bb3e4067..000000000000 --- a/reference/openal/functions/openal-source-get.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - openal_source_get - - Retrieve an OpenAL source property - - - - &reftitle.description; - - mixedopenal_source_get - resourcesource - intproperty - - - - &reftitle.parameters; - - - source - - - An Open AL(Source) resource - (previously created by openal_source_create). - - - - - property - - - Property to get, one of: - AL_SOURCE_RELATIVE (int), - AL_SOURCE_STATE (int), - AL_PITCH (float), - AL_GAIN (float), - AL_MIN_GAIN (float), - AL_MAX_GAIN (float), - AL_MAX_DISTANCE (float), - AL_ROLLOFF_FACTOR (float), - AL_CONE_OUTER_GAIN (float), - AL_CONE_INNER_ANGLE (float), - AL_CONE_OUTER_ANGLE (float), - AL_REFERENCE_DISTANCE (float), - AL_POSITION (array(float,float,float)), - AL_VELOCITY (array(float,float,float)), - AL_DIRECTION (array(float,float,float)). - - - - - - - &reftitle.returnvalues; - - Returns the type associated with the property being retrieved - &return.falseforfailure;. - - - - &reftitle.seealso; - - openal_source_create - openal_source_set - openal_source_play - - - - diff --git a/reference/openal/functions/openal-source-pause.xml b/reference/openal/functions/openal-source-pause.xml deleted file mode 100644 index f6b600204ea7..000000000000 --- a/reference/openal/functions/openal-source-pause.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - openal_source_pause - - Pause the source - - - - &reftitle.description; - - boolopenal_source_pause - resourcesource - - - - &reftitle.parameters; - - - source - - - An Open AL(Source) resource - (previously created by openal_source_create). - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - openal_source_stop - openal_source_play - openal_source_rewind - - - - diff --git a/reference/openal/functions/openal-source-play.xml b/reference/openal/functions/openal-source-play.xml deleted file mode 100644 index ae999d7e48f5..000000000000 --- a/reference/openal/functions/openal-source-play.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - openal_source_play - - Start playing the source - - - - &reftitle.description; - - boolopenal_source_play - resourcesource - - - - &reftitle.parameters; - - - source - - - An Open AL(Source) resource - (previously created by openal_source_create). - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - openal_source_stop - openal_source_pause - openal_source_rewind - - - - diff --git a/reference/openal/functions/openal-source-rewind.xml b/reference/openal/functions/openal-source-rewind.xml deleted file mode 100644 index ccec745de6e3..000000000000 --- a/reference/openal/functions/openal-source-rewind.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - openal_source_rewind - - Rewind the source - - - - &reftitle.description; - - boolopenal_source_rewind - resourcesource - - - - &reftitle.parameters; - - - source - - - An Open AL(Source) resource - (previously created by openal_source_create). - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - openal_source_stop - openal_source_pause - openal_source_play - - - - diff --git a/reference/openal/functions/openal-source-set.xml b/reference/openal/functions/openal-source-set.xml deleted file mode 100644 index 3ab6b5f8592a..000000000000 --- a/reference/openal/functions/openal-source-set.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - openal_source_set - - Set source property - - - - &reftitle.description; - - boolopenal_source_set - resourcesource - intproperty - mixedsetting - - - - &reftitle.parameters; - - - source - - - An Open AL(Source) resource - (previously created by openal_source_create). - - - - - property - - - Property to set, one of: - AL_BUFFER (OpenAL(Source)), - AL_LOOPING (bool), - AL_SOURCE_RELATIVE (int), - AL_SOURCE_STATE (int), - AL_PITCH (float), - AL_GAIN (float), - AL_MIN_GAIN (float), - AL_MAX_GAIN (float), - AL_MAX_DISTANCE (float), - AL_ROLLOFF_FACTOR (float), - AL_CONE_OUTER_GAIN (float), - AL_CONE_INNER_ANGLE (float), - AL_CONE_OUTER_ANGLE (float), - AL_REFERENCE_DISTANCE (float), - AL_POSITION (array(float,float,float)), - AL_VELOCITY (array(float,float,float)), - AL_DIRECTION (array(float,float,float)). - - - - - setting - - - Value to assign to specified property. - Refer to the description of property - for a description of the value(s) expected. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - openal_source_create - openal_source_get - openal_source_play - - - - diff --git a/reference/openal/functions/openal-source-stop.xml b/reference/openal/functions/openal-source-stop.xml deleted file mode 100644 index a2ffd49c2508..000000000000 --- a/reference/openal/functions/openal-source-stop.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - openal_source_stop - - Stop playing the source - - - - &reftitle.description; - - boolopenal_source_stop - resourcesource - - - - &reftitle.parameters; - - - source - - - An Open AL(Source) resource - (previously created by openal_source_create). - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - openal_source_play - openal_source_pause - openal_source_rewind - - - - diff --git a/reference/openal/functions/openal-stream.xml b/reference/openal/functions/openal-stream.xml deleted file mode 100644 index 4c5dc9eeac23..000000000000 --- a/reference/openal/functions/openal-stream.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - openal_stream - - Begin streaming on a source - - - - &reftitle.description; - - resourcefalseopenal_stream - resourcesource - intformat - intrate - - - - &reftitle.parameters; - - - source - - - An Open AL(Source) resource - (previously created by openal_source_create). - - - - - format - - - Format of data, one of: - AL_FORMAT_MONO8, - AL_FORMAT_MONO16, - AL_FORMAT_STEREO8&listendand; - AL_FORMAT_STEREO16 - - - - - rate - - - Frequency of data to stream given in Hz. - - - - - - - &reftitle.returnvalues; - - Returns a stream resource on success&return.falseforfailure;. - - - - &reftitle.seealso; - - openal_source_create - fwrite - - - - diff --git a/reference/openal/reference.xml b/reference/openal/reference.xml deleted file mode 100644 index 577a6cf6e6ae..000000000000 --- a/reference/openal/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - OpenAL &Functions; - - &reference.openal.entities.functions; - - - - diff --git a/reference/openal/resources.xml b/reference/openal/resources.xml deleted file mode 100644 index a45474e9de76..000000000000 --- a/reference/openal/resources.xml +++ /dev/null @@ -1,34 +0,0 @@ - - -
    - &reftitle.resources; - - - This extension defines four resource types: - Open AL(Device) - Returned by openal_device_open, - Open AL(Context) - Returned by openal_context_create, - Open AL(Buffer) - Returned by openal_buffer_create, - and Open AL(Source) - Returned by openal_source_create. - - -
    - diff --git a/reference/openal/setup.xml b/reference/openal/setup.xml deleted file mode 100644 index 231bec3e4423..000000000000 --- a/reference/openal/setup.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - - - &reftitle.setup; - - - &reference.openal.configure; - - - - &reference.openal.resources; - - - - - - diff --git a/reference/openal/versions.xml b/reference/openal/versions.xml deleted file mode 100644 index 9af60e51ed6b..000000000000 --- a/reference/openal/versions.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/operator/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/operator/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/operator/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/operator/book.xml b/reference/operator/book.xml deleted file mode 100644 index 4788283f7626..000000000000 --- a/reference/operator/book.xml +++ /dev/null @@ -1,28 +0,0 @@ - - - - - Operator Overloading for Objects - Operator Overloading - - - - &reftitle.intro; - - This extension defines and implements operator overloading for objects. - It allows defining how an object reacts when an operator is used on it. - - - One example of this is creating a collection type object that has the addition - operator overloaded to allow adding elements to the collection or adding two - collections together. - - - Another example is creating an enhanced string class that has the multiplication - operator overloaded to allow repeating the string a certain number of times. - - - - &reference.operator.setup; - &reference.operator.overloading; - diff --git a/reference/operator/overloading.xml b/reference/operator/overloading.xml deleted file mode 100644 index 7c623f6f76a2..000000000000 --- a/reference/operator/overloading.xml +++ /dev/null @@ -1,340 +0,0 @@ - - - - - Operator Overloading Magic Methods - - The operator overloading extension allows you to define how an object reacts to operators. This is done by implementing the following magic methods: - - - Arithmetic operators: - - $a::__add($b) - $a::__sub($b) - $a::__mul($b) - $a::__div($b) - $a::__mod($b) - $a::__pow($b) - - - - Assignment operators: - - $a::__assign($b) - $a::__assign_add($b) - $a::__assign_sub($b) - $a::__assign_mul($b) - $a::__assign_div($b) - $a::__assign_mod($b) - $a::__assign_pow($b) - $a::__assign_bw_and($b) - $a::__assign_bw_or($b) - $a::__assign_bw_xor($b) - $a::__assign_sl($b) - $a::__assign_sr($b) - $a::__assign_concat($b) - - - - Bitwise operators: - - $a::__bw_and($b) - $a::__bw_or($b) - $a::__bw_xor($b) - $a::__bw_not() - $a::__sl($b) - $a::__sr($b) - - - - Comparison operators: - - $a::__is_equal($b) - $a::__is_not_equal($b) - $a::__is_identical($b) - $a::__is_not_identical($b) - $a::__is_smaller($b) - $a::__is_smaller_or_equal($b) - $a::__is_greater($b) - $a::__is_greater_or_equal($b) - $a::__spaceship($b) - - - - Incrementing and decrementing operators: - - $a::__pre_inc() - $a::__post_inc() - $a::__pre_dec() - $a::__post_dec() - - - - String operators: - - $a::__concat($b) - - -
    - Operator Overloading Examples - - The following is the class that is used in the testing of the operator overloading extension. - It overloads all of the possible operators that can be overloaded for testing. - - - Complete class for operator overloading - -value; - } - - public function __set(string $name, mixed $value) - { - $this->value = $value; - } - - public function __construct(mixed $init = null) - { - $this->value = $init; - } - //endregion - - //region Arithmetic Operators - public function __add(mixed $val): int|float - { - return $this->value + $val; - } - - public function __div(mixed $val): int|float - { - return $this->value / $val; - } - - public function __mod(mixed $val): int - { - return $this->value % $val; - } - - public function __mul(mixed $val): int|float - { - return $this->value * $val; - } - - public function __pow(mixed $val): int|float - { - return $this->value ** $val; - } - - public function __sub(mixed $val): int|float - { - return $this->value - $val; - } - //endregion - - //region Assignment Operators - public function __assign(mixed $val): mixed - { - return $this->value = $val; - } - - public function __assign_add(mixed $val): mixed - { - return $this->value += $val; - } - - public function __assign_bw_and(mixed $val): mixed - { - return $this->value &= $val; - } - - public function __assign_bw_or(mixed $val): mixed - { - return $this->value |= $val; - } - - public function __assign_concat(mixed $val): string - { - return $this->value .= $val; - } - - public function __assign_div(mixed $val): mixed - { - return $this->value /= $val; - } - - public function __assign_mod(mixed $val): mixed - { - return $this->value %= $val; - } - - public function __assign_mul(mixed $val): mixed - { - return $this->value *= $val; - } - - public function __assign_pow(mixed $val): mixed - { - return $this->value **= $val; - } - - public function __assign_sl(mixed $val): mixed - { - return $this->value <<= $val; - } - - public function __assign_sr(mixed $val): mixed - { - return $this->value >>= $val; - } - - public function __assign_sub(mixed $val): mixed - { - return $this->value -= $val; - } - //endregion - - //region Bitwise Operators - public function __bw_and(mixed $val): int - { - return $this->value & $val; - } - - public function __bw_not(): int|string - { - return ~$this->value; - } - - public function __bw_or(mixed $val): int - { - return $this->value | $val; - } - - public function __bw_xor(mixed $val): int - { - return $this->value ^ $val; - } - - public function __sl(mixed $val): int - { - return $this->value << $val; - } - - public function __sr(mixed $val): int - { - return $this->value >> $val; - } - //endregion - - //region Comparison Operators - public function __is_equal(mixed $val): bool - { - return $this->value == $val; - } - - public function __is_greater(mixed $val): bool - { - return $this->value > $val; - } - - public function __is_greater_or_equal(mixed $val): bool - { - return $this->value >= $val; - } - - public function __is_identical(mixed $val): bool - { - return $this->value === $val; - } - - public function __is_not_equal(mixed $val): bool - { - return $this->value != $val; - } - - public function __is_not_identical(mixed $val): bool - { - return $this->value !== $val; - } - - public function __is_smaller(mixed $val): bool - { - return $this->value < $val; - } - - public function __is_smaller_or_equal(mixed $val): bool - { - return $this->value <= $val; - } - - public function __spaceship(mixed $val): int - { - return $this->value <=> $val; - } - //endregion - - //region Incrementing/Decrementing Operators - public function __post_dec(): mixed - { - return $this->value--; - } - - public function __post_inc(): mixed - { - return $this->value++; - } - - public function __pre_dec(): mixed - { - return --$this->value; - } - - public function __pre_inc(): mixed - { - return ++$this->value; - } - //endregion - - //region String Operators - public function __concat(mixed $val): string - { - return $this->value . $val; - } - //endregion - -} - -]]> - - - Using the above class, you can overload the operators as follows: - - - - - - The above code will output: - - - - - -
    -
    diff --git a/reference/operator/setup.xml b/reference/operator/setup.xml deleted file mode 100644 index 2778b671b803..000000000000 --- a/reference/operator/setup.xml +++ /dev/null @@ -1,20 +0,0 @@ - - - - - &reftitle.setup; -
    - &reftitle.install; - - &pecl.info; - &url.pecl.package;operator. - - - Windows users can download prebuilt release binaries from the PECL website. - - - operator releases are hosted by PECL and the source code by - github. - -
    -
    diff --git a/reference/parallel/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/parallel/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/parallel/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/parallel/book.xml b/reference/parallel/book.xml deleted file mode 100644 index 923c45b7fac3..000000000000 --- a/reference/parallel/book.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - parallel - parallel - - - &reftitle.intro; - - parallel is a parallel concurrency extension for PHP ≥ 7.2.0. - As of parallel 1.2.0, PHP ≥ 8.0.0 is required. - - - 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 d170437eb2b0..000000000000 --- a/reference/parallel/configure.xml +++ /dev/null @@ -1,34 +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 1d0ae52518f2..000000000000 --- a/reference/parallel/functional.xml +++ /dev/null @@ -1,47 +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 75473bd1fd86..000000000000 --- a/reference/parallel/functions/parallel.bootstrap.xml +++ /dev/null @@ -1,82 +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 32c5e6cf34a9..000000000000 --- a/reference/parallel/functions/parallel.run.xml +++ /dev/null @@ -1,76 +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 0867e97a8267..000000000000 --- a/reference/parallel/parallel.channel.xml +++ /dev/null @@ -1,120 +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 c9b6ee5cd629..000000000000 --- 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 869fda5f4587..000000000000 --- a/reference/parallel/parallel.events.event.xml +++ /dev/null @@ -1,87 +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 dd2e24a8ac4b..000000000000 --- a/reference/parallel/parallel.events.input.xml +++ /dev/null @@ -1,74 +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 b45d5e9f58f4..000000000000 --- a/reference/parallel/parallel.events.xml +++ /dev/null @@ -1,83 +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 34204f3bfef2..000000000000 --- a/reference/parallel/parallel.future.xml +++ /dev/null @@ -1,123 +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 2fe9d3574844..000000000000 --- a/reference/parallel/parallel.runtime.xml +++ /dev/null @@ -1,96 +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 226ce00931e1..000000000000 --- a/reference/parallel/parallel.sync.xml +++ /dev/null @@ -1,81 +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 81abefb52607..000000000000 --- a/reference/parallel/parallel/channel/close.xml +++ /dev/null @@ -1,50 +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 69bd167132d9..000000000000 --- a/reference/parallel/parallel/channel/construct.xml +++ /dev/null @@ -1,62 +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 2559bf8c14e2..000000000000 --- a/reference/parallel/parallel/channel/make.xml +++ /dev/null @@ -1,80 +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 1a117d431de3..000000000000 --- a/reference/parallel/parallel/channel/open.xml +++ /dev/null @@ -1,50 +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 245a8de6ece1..000000000000 --- a/reference/parallel/parallel/channel/recv.xml +++ /dev/null @@ -1,50 +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 fde8399f9b87..000000000000 --- a/reference/parallel/parallel/channel/send.xml +++ /dev/null @@ -1,55 +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 ea780221db62..000000000000 --- a/reference/parallel/parallel/events/addchannel.xml +++ /dev/null @@ -1,49 +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 44365caa5477..000000000000 --- a/reference/parallel/parallel/events/addfuture.xml +++ /dev/null @@ -1,50 +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 86074a52a3ed..000000000000 --- a/reference/parallel/parallel/events/poll.xml +++ /dev/null @@ -1,62 +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 306f00f4c036..000000000000 --- a/reference/parallel/parallel/events/remove.xml +++ /dev/null @@ -1,49 +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 ef6bcee77269..000000000000 --- a/reference/parallel/parallel/events/setblocking.xml +++ /dev/null @@ -1,60 +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 df0324f75418..000000000000 --- a/reference/parallel/parallel/events/setinput.xml +++ /dev/null @@ -1,40 +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 6f4123b27c71..000000000000 --- a/reference/parallel/parallel/events/settimeout.xml +++ /dev/null @@ -1,56 +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 a658dd01ce46..000000000000 --- a/reference/parallel/parallel/future/cancel.xml +++ /dev/null @@ -1,64 +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 855b2a7ff7d9..000000000000 --- a/reference/parallel/parallel/future/cancelled.xml +++ /dev/null @@ -1,41 +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 ad17c389448a..000000000000 --- a/reference/parallel/parallel/future/done.xml +++ /dev/null @@ -1,41 +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 d3f1e77f3e41..000000000000 --- a/reference/parallel/parallel/future/value.xml +++ /dev/null @@ -1,70 +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 618477679f9c..000000000000 --- a/reference/parallel/parallel/input/add.xml +++ /dev/null @@ -1,55 +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 af70b6762594..000000000000 --- a/reference/parallel/parallel/input/clear.xml +++ /dev/null @@ -1,40 +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 23444d774cd8..000000000000 --- a/reference/parallel/parallel/input/remove.xml +++ /dev/null @@ -1,49 +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 ab42e072d89e..000000000000 --- a/reference/parallel/parallel/runtime/close.xml +++ /dev/null @@ -1,55 +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 1d402835297c..000000000000 --- a/reference/parallel/parallel/runtime/construct.xml +++ /dev/null @@ -1,76 +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 69948af15752..000000000000 --- a/reference/parallel/parallel/runtime/kill.xml +++ /dev/null @@ -1,60 +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 39b06180a9fe..000000000000 --- a/reference/parallel/parallel/runtime/run.xml +++ /dev/null @@ -1,180 +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 637f799ff392..000000000000 --- a/reference/parallel/parallel/sync/construct.xml +++ /dev/null @@ -1,58 +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 8a40daf295e4..000000000000 --- a/reference/parallel/parallel/sync/get.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - parallel\Sync::get - Access - - - - &reftitle.description; - - public scalarparallel\Sync::get - - - - Shall atomically return the synchronization objects value - - - - - - diff --git a/reference/parallel/parallel/sync/invoke.xml b/reference/parallel/parallel/sync/invoke.xml deleted file mode 100644 index 6903f5a170b8..000000000000 --- a/reference/parallel/parallel/sync/invoke.xml +++ /dev/null @@ -1,41 +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 91adea8cc5cd..000000000000 --- a/reference/parallel/parallel/sync/notify.xml +++ /dev/null @@ -1,41 +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 543b6a634d9f..000000000000 --- a/reference/parallel/parallel/sync/set.xml +++ /dev/null @@ -1,50 +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 df573818f81f..000000000000 --- a/reference/parallel/parallel/sync/wait.xml +++ /dev/null @@ -1,41 +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 28eebbfd3f5f..000000000000 --- a/reference/parallel/philosophy.xml +++ /dev/null @@ -1,75 +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 17b6c65b6ad6..000000000000 --- a/reference/parallel/setup.xml +++ /dev/null @@ -1,60 +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 pthreadVC?.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 7f6bc0c402d3..000000000000 --- a/reference/parallel/versions.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/parle/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/parle/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/parle/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/parle/book.xml b/reference/parle/book.xml deleted file mode 100644 index 2e870489e832..000000000000 --- a/reference/parle/book.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - Parsing and lexing - Parle - - - &reftitle.intro; - &warn.experimental; - - The parle extension provides general purpose lexing and parsing facilities. The implementation is based on these libraries and requires a C++14 capable compiler. The lexer is based on the regex matching, the parser is LALR(1). Lexers and parsers are generated on the fly and can be used immediately after they've been finalized. Parle deals with parsing and lexing, the appropriate data structures representation and processing are the implementer's task. Serialization and code generation are not supported by the extension, yet. - - - Lexer analysis is a process of splitting a character sequence into a list of lexemes. The lexeme list can be then used for the syntax analysis against a formal grammar. These operations are also known as lexing and parsing. This documentation doesn't aim to provide an exhaustive information on lexing and parsing. Good information in this regard is available on the numerous resources on the net. Several usage examples are included, to show the functionality. The extension is useful for PHP programmers both willing to learn or to utilize parsing and lexing. State machines and grammar parsing don't have to be implemented manually, these complex tasks are taken away by parle. Thanks to that, the development can be focused on the actual problem solving. - - - The common use case for parle is, when a data format is too complex to be handled by the regex matching with PCRE. The practical application is herewith wide. Be it a specific data format, a behavior modification of existing functions, even an own programming language and beyond. The helper methods such as Parle\Lexer::dump to inspect the generated state machine, or Parle\Parser::dump to inspect the generated grammar, are useful. The method Parle\Parser::trace can also be used to track the parsing operation. - - - - &reference.parle.setup; - &reference.parle.constants; - &reference.parle.pattern.matching; - &reference.parle.examples; - &reference.parle.parle.lexer; - &reference.parle.parle.rlexer; - &reference.parle.parle.parser; - &reference.parle.parle.rparser; - &reference.parle.parle.stack; - &reference.parle.parle.token; - &reference.parle.parle.errorinfo; - &reference.parle.parle.lexerexception; - &reference.parle.parle.parserexception; - - - - diff --git a/reference/parle/configure.xml b/reference/parle/configure.xml deleted file mode 100644 index 8ff3be4a78ed..000000000000 --- a/reference/parle/configure.xml +++ /dev/null @@ -1,35 +0,0 @@ - - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;parle - - - -
    - - - diff --git a/reference/parle/constants.xml b/reference/parle/constants.xml deleted file mode 100644 index 4fc28dcaefe8..000000000000 --- a/reference/parle/constants.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - - &reftitle.constants; - &extension.constants; - - - - Parle\INTERNAL_UTF32 - bool - - - - Flag whether the internal UTF-32 support is compiled in. Available since parle 0.7.2. - - - - - - - diff --git a/reference/parle/examples.xml b/reference/parle/examples.xml deleted file mode 100644 index 62f8544fc427..000000000000 --- a/reference/parle/examples.xml +++ /dev/null @@ -1,235 +0,0 @@ - - - - - &reftitle.examples; - -
    - Lexer examples - - Tokenize comma separated integer list - - id */ -$token = array( - "COMMA" => 1, - "CRLF" => 2, - "DECIMAL" => 3, -); -/* id => name */ -$tokenIdToName = array_flip($token); - -$lex = new Lexer; -$lex->push("[\x2c]", $token["COMMA"]); -$lex->push("[\r][\n]", $token["CRLF"]); -$lex->push("[\d]+", $token["DECIMAL"]); -$lex->build(); - -$in = "0,1,2\r\n3,42,5\r\n6,77,8\r\n"; - -$lex->consume($in); - -do { - $lex->advance(); - $tok = $lex->getToken(); - - if (Token::UNKNOWN == $tok->id) { - throw new LexerException("Unknown token '{$tok->value}' at offset {$lex->marker}."); - } - - echo "TOKEN: ", $tokenIdToName[$tok->id], PHP_EOL; -} while (Token::EOI != $tok->id); -]]> - - - - Tokenize assign statement - -push("\$[a-zA-Z_][a-zA-Z0-9_]*", 1); -$lex->push("=", 2); -$lex->push("\d+", 3); -$lex->push(";", 4); - -$lex->build(); - -$lex->consume('$x = 42; $y = 24;'); - - -do { - $lex->advance(); - $tok = $lex->getToken(); - var_dump($tok); -} while (Token::EOI != $tok->id); -]]> - - -
    -
    - Parser examples - - Simple calculator - -token("INTEGER"); -$p->left("'+' '-' '*' '/'"); - -$p->push("start", "exp"); -$prod_add = $p->push("exp", "exp '+' exp"); -$prod_sub = $p->push("exp", "exp '-' exp"); -$prod_mul = $p->push("exp", "exp '*' exp"); -$prod_div = $p->push("exp", "exp '/' exp"); -$p->push("exp", "INTEGER"); /* Production index unused. */ - -$p->build(); - -$lex = new Lexer; -$lex->push("[+]", $p->tokenId("'+'")); -$lex->push("[-]", $p->tokenId("'-'")); -$lex->push("[*]", $p->tokenId("'*'")); -$lex->push("[/]", $p->tokenId("'/'")); -$lex->push("\\d+", $p->tokenId("INTEGER")); -$lex->push("\\s+", Token::SKIP); - -$lex->build(); - -$exp = array( - "1 + 1", - "33 / 10", - "100 * 45", - "17 - 45", -); - -foreach ($exp as $in) { - if (!$p->validate($in, $lex)) { - throw new ParserException("Failed to validate input"); - } - - $p->consume($in, $lex); - - while (Parser::ACTION_ERROR != $p->action && Parser::ACTION_ACCEPT != $p->action) { - switch ($p->action) { - case Parser::ACTION_ERROR: - throw new ParserException("Parser error"); - break; - case Parser::ACTION_SHIFT: - case Parser::ACTION_GOTO: - case Parser::ACTION_ACCEPT: - break; - case Parser::ACTION_REDUCE: - switch ($p->reduceId) { - case $prod_add: - $l = $p->sigil(0); - $r = $p->sigil(2); - echo "$l + $r = " . ($l + $r) . "\n"; - break; - case $prod_sub: - $l = $p->sigil(0); - $r = $p->sigil(2); - echo "$l - $r = " . ($l - $r) . "\n"; - break; - case $prod_mul: - $l = $p->sigil(0); - $r = $p->sigil(2); - echo "$l * $r = " . ($l * $r) . "\n"; - break; - case $prod_div: - $l = $p->sigil(0); - $r = $p->sigil(2); - echo "$l / $r = " . ($l / $r) . "\n"; - break; - } - break; - } - $p->advance(); - } -} -]]> - - - - Parse words out from a sentence - -token("WORD"); -$p->push("START", "SENTENCE"); -$p->push("SENTENCE", "WORDS"); -$prod_word_0 = $p->push("WORDS", "WORDS WORD"); -$prod_word_1 = $p->push("WORDS", "WORD"); -$p->build(); - -$lex = new Lexer; -$lex->push("[^\s]{-}[\.,\:\;\?]+", $p->tokenId("WORD")); -$lex->push("[\s\.,\:\;\?]+", Token::SKIP); -$lex->build(); - -$in = "Dis-moi où est ton papa?"; -$p->consume($in, $lex); -do { - switch ($p->action) { - case Parser::ACTION_ERROR: - throw new ParserException("Error"); - break; - case Parser::ACTION_SHIFT: - case Parser::ACTION_GOTO: - /* var_dump($p->trace());*/ - break; - case Parser::ACTION_REDUCE: - $rid = $p->reduceId(); - if ($rid == $prod_word_1) { - var_dump($p->sigil(0)); - } if ($rid == $prod_word_0) { - var_dump($p->sigil(1)); - } - break; - } - $p->advance(); -} while (Parser::ACTION_ACCEPT != $p->action); -]]> - - -
    -
    - - diff --git a/reference/parle/parle.errorinfo.xml b/reference/parle/parle.errorinfo.xml deleted file mode 100644 index 50ddc5ea9e9a..000000000000 --- a/reference/parle/parle.errorinfo.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - The Parle\ErrorInfo class - Parle\ErrorInfo - - - - -
    - &reftitle.intro; - - The class represents detailed error information as supplied by Parle\Parser::errorInfo - -
    - - -
    - &reftitle.classsynopsis; - - - - Parle\ErrorInfo - - - - - Parle\ErrorInfo - - - - &Properties; - - public - int - id - - - public - int - position - - - public - mixed - token - - - - &Methods; - - - - - -
    - - - -
    - &reftitle.properties; - - - id - - Error id. - - - - position - - Position in the input, where the error occurred. - - - - token - - If applicable - the Parle\Token related to the error, otherwise &null;. - - - -
    - - - -
    - - - -
    - - diff --git a/reference/parle/parle.lexer.xml b/reference/parle/parle.lexer.xml deleted file mode 100644 index 33f51b8c2ac9..000000000000 --- a/reference/parle/parle.lexer.xml +++ /dev/null @@ -1,213 +0,0 @@ - - - - - - The Parle\Lexer class - Parle\Lexer - - - - -
    - &reftitle.intro; - - Single state lexer class. Lexemes can be defined on the fly. If the particular lexer instance is meant to be used with Parle\Parser, the token IDs need to be taken from there. Otherwise, arbitrary token IDs can be supplied. This lexer can give a certain performance advantage over Parle\RLexer, if no multiple states are required. Note, that Parle\RParser is not compatible with this lexer. - -
    - - -
    - &reftitle.classsynopsis; - - - - Parle\Lexer - - - - - Parle\Lexer - - - - &Constants; - - const - int - Parle\Lexer::ICASE - 1 - - - const - int - Parle\Lexer::DOT_NOT_LF - 2 - - - const - int - Parle\Lexer::DOT_NOT_CRLF - 4 - - - const - int - Parle\Lexer::SKIP_WS - 8 - - - const - int - Parle\Lexer::MATCH_ZERO_LEN - 16 - - - &Properties; - - public - bool - bol - &false; - - - public - int - flags - 0 - - - public - int - state - 0 - - - public - int - marker - 0 - - - public - int - cursor - 0 - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - Parle\Lexer::ICASE - - - - - - - Parle\Lexer::DOT_NOT_LF - - - - - - - Parle\Lexer::DOT_NOT_CRLF - - - - - - - Parle\Lexer::SKIP_WS - - - - - - - Parle\Lexer::MATCH_ZERO_LEN - - - - - - -
    - - - -
    - &reftitle.properties; - - - bol - - Start of input flag. - - - - flags - - Lexer flags. - - - - state - - Current lexer state, readonly. - - - - marker - - Position of the latest token match, readonly. - - - - cursor - - Current input offset, readonly. - - - -
    - - -
    - - - &reference.parle.parle.entities.lexer; - -
    - - diff --git a/reference/parle/parle.lexerexception.xml b/reference/parle/parle.lexerexception.xml deleted file mode 100644 index 0dbdabfe444e..000000000000 --- a/reference/parle/parle.lexerexception.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - The Parle\LexerException class - Parle\LexerException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Parle\LexerException - - - - - Parle\LexerException - - - - extends - Exception - - - - Throwable - - - - &InheritedProperties; - - - - &Methods; - - - - &InheritedMethods; - - - - - -
    - -
    - - - -
    - - diff --git a/reference/parle/parle.parser.xml b/reference/parle/parle.parser.xml deleted file mode 100644 index 192732ef8b61..000000000000 --- a/reference/parle/parle.parser.xml +++ /dev/null @@ -1,216 +0,0 @@ - - - - - - The Parle\Parser class - Parle\Parser - - - - -
    - &reftitle.intro; - - Parser class. Rules can be defined on the fly. Once finalized, a Parle\Lexer instance is required to deliver the token stream. - -
    - - -
    - &reftitle.classsynopsis; - - - - Parle\Parser - - - - - Parle\Parser - - - - &Constants; - - const - int - Parle\Parser::ACTION_ERROR - 0 - - - const - int - Parle\Parser::ACTION_SHIFT - 1 - - - const - int - Parle\Parser::ACTION_REDUCE - 2 - - - const - int - Parle\Parser::ACTION_GOTO - 3 - - - const - int - Parle\Parser::ACTION_ACCEPT - 4 - - - const - int - Parle\Parser::ERROR_SYNTAX - 0 - - - const - int - Parle\Parser::ERROR_NON_ASSOCIATIVE - 1 - - - const - int - Parle\Parser::ERROR_UNKNOWN_TOKEN - 2 - - - &Properties; - - public - int - action - 0 - - - public - int - reduceId - 0 - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - Parle\Parser::ACTION_ERROR - - - - - - - Parle\Parser::ACTION_SHIFT - - - - - - - Parle\Parser::ACTION_REDUCE - - - - - - - Parle\Parser::ACTION_GOTO - - - - - - - Parle\Parser::ACTION_ACCEPT - - - - - - - Parle\Parser::ERROR_SYNTAX - - - - - - - Parle\Parser::ERROR_NON_ASSOCIATIVE - - - - - - - Parle\Parser::ERROR_UNKNOWN_TOKEN - - - - - - -
    - - - -
    - &reftitle.properties; - - - action - - Current parser action that matches one of the action class constants, readonly. - - - - reduceId - - Grammar rule id just processed in the reduce action. The value corresponds either to a token or to a production id. Readonly. - - - -
    - - -
    - - - &reference.parle.parle.entities.parser; - -
    - - diff --git a/reference/parle/parle.parserexception.xml b/reference/parle/parle.parserexception.xml deleted file mode 100644 index 42e227b985c0..000000000000 --- a/reference/parle/parle.parserexception.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - The Parle\ParserException class - Parle\ParserException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Parle\ParserException - - - - - Parle\ParserException - - - - extends - Exception - - - - Throwable - - - - &InheritedProperties; - - - - &Methods; - - - - &InheritedMethods; - - - - - -
    - -
    - - - -
    - - diff --git a/reference/parle/parle.rlexer.xml b/reference/parle/parle.rlexer.xml deleted file mode 100644 index 7f476c66d351..000000000000 --- a/reference/parle/parle.rlexer.xml +++ /dev/null @@ -1,213 +0,0 @@ - - - - - - The Parle\RLexer class - Parle\RLexer - - - - -
    - &reftitle.intro; - - Multistate lexer class. Lexemes can be defined on the fly. If the particular lexer instance is meant to be used with Parle\RParser, the token IDs need to be taken from there. Otherwise, arbitrary token IDs can be supplied. Note, that Parle\Parser is not compatible with this lexer. - -
    - - -
    - &reftitle.classsynopsis; - - - - Parle\RLexer - - - - - Parle\RLexer - - - - &Constants; - - const - int - Parle\RLexer::ICASE - 1 - - - const - int - Parle\RLexer::DOT_NOT_LF - 2 - - - const - int - Parle\RLexer::DOT_NOT_CRLF - 4 - - - const - int - Parle\RLexer::SKIP_WS - 8 - - - const - int - Parle\RLexer::MATCH_ZERO_LEN - 16 - - - &Properties; - - public - bool - bol - &false; - - - public - int - flags - 0 - - - public - int - state - 0 - - - public - int - marker - 0 - - - public - int - cursor - 0 - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - Parle\RLexer::ICASE - - - - - - - Parle\RLexer::DOT_NOT_LF - - - - - - - Parle\RLexer::DOT_NOT_CRLF - - - - - - - Parle\RLexer::SKIP_WS - - - - - - - Parle\RLexer::MATCH_ZERO_LEN - - - - - - -
    - - - -
    - &reftitle.properties; - - - bol - - Start of input flag. - - - - flags - - Lexer flags. - - - - state - - Current lexer state, readonly. - - - - marker - - Position of the latest token match, readonly. - - - - cursor - - Current input offset, readonly. - - - -
    - - -
    - - - &reference.parle.parle.entities.rlexer; - -
    - - diff --git a/reference/parle/parle.rparser.xml b/reference/parle/parle.rparser.xml deleted file mode 100644 index 8f3cf28d7cb8..000000000000 --- a/reference/parle/parle.rparser.xml +++ /dev/null @@ -1,216 +0,0 @@ - - - - - - The Parle\RParser class - Parle\RParser - - - - -
    - &reftitle.intro; - - Parser class. Rules can be defined on the fly. Once finalized, a Parle\RLexer instance is required to deliver the token stream. - -
    - - -
    - &reftitle.classsynopsis; - - - - Parle\RParser - - - - - Parle\RParser - - - - &Constants; - - const - int - Parle\RParser::ACTION_ERROR - 0 - - - const - int - Parle\RParser::ACTION_SHIFT - 1 - - - const - int - Parle\RParser::ACTION_REDUCE - 2 - - - const - int - Parle\RParser::ACTION_GOTO - 3 - - - const - int - Parle\RParser::ACTION_ACCEPT - 4 - - - const - int - Parle\RParser::ERROR_SYNTAX - 0 - - - const - int - Parle\RParser::ERROR_NON_ASSOCIATIVE - 1 - - - const - int - Parle\RParser::ERROR_UNKNOWN_TOKEN - 2 - - - &Properties; - - public - int - action - 0 - - - public - int - reduceId - 0 - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - Parle\RParser::ACTION_ERROR - - - - - - - Parle\RParser::ACTION_SHIFT - - - - - - - Parle\RParser::ACTION_REDUCE - - - - - - - Parle\RParser::ACTION_GOTO - - - - - - - Parle\RParser::ACTION_ACCEPT - - - - - - - Parle\RParser::ERROR_SYNTAX - - - - - - - Parle\RParser::ERROR_NON_ASSOCIATIVE - - - - - - - Parle\RParser::ERROR_UNKNOWN_TOKEN - - - - - - -
    - - - -
    - &reftitle.properties; - - - action - - Current parser action that matches one of the action class constants, readonly. - - - - reduceId - - Grammar rule id just processed in the reduce action. The value corresponds either to a token or to a production id. Readonly. - - - -
    - - -
    - - - &reference.parle.parle.entities.rparser; - -
    - - diff --git a/reference/parle/parle.stack.xml b/reference/parle/parle.stack.xml deleted file mode 100644 index 928abfa1006d..000000000000 --- a/reference/parle/parle.stack.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - The Parle\Stack class - Parle\Stack - - - - -
    - &reftitle.intro; - - Parle\Stack is a LIFO stack. The elements are inserted and removed only from one end. - -
    - - -
    - &reftitle.classsynopsis; - - - - Parle\Stack - - - - - Parle\Stack - - - - - &Properties; - - public - bool - empty - &true; - - - public - int - size - 0 - - - public - mixed - top - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - empty - - Whether the stack is empty, readonly. - - - - size - - Stack size, readonly. - - - - top - - Element on the top of the stack. - - - -
    - - -
    - - - &reference.parle.parle.entities.stack; - -
    - - diff --git a/reference/parle/parle.token.xml b/reference/parle/parle.token.xml deleted file mode 100644 index d938c041340e..000000000000 --- a/reference/parle/parle.token.xml +++ /dev/null @@ -1,153 +0,0 @@ - - - - - - The Parle\Token class - Parle\Token - - - - -
    - &reftitle.intro; - - This class represents a token. Lexer returns instances of this class. - -
    - - -
    - &reftitle.classsynopsis; - - - - Parle\Token - - - - - Parle\Token - - - - &Constants; - - const - int - Parle\Token::EOI - 0 - - - const - int - Parle\Token::UNKNOWN - -1 - - - const - int - Parle\Token::SKIP - -2 - - - &Properties; - - public - int - id - - - public - string - value - - - - &Methods; - - - - - -
    - - - -
    - &reftitle.properties; - - - id - - Token id. - - - - value - - Token value. - - - -
    - - - - -
    - &reftitle.constants; - - - - Parle\Token::EOI - - End of input token id. - - - - - Parle\Token::UNKNOWN - - Unknown token id. - - - - - Parle\Token::SKIP - - Skip token id. - - - - -
    - - - -
    - - - -
    - - diff --git a/reference/parle/parle/lexer/advance.xml b/reference/parle/parle/lexer/advance.xml deleted file mode 100644 index 051a9c5e710c..000000000000 --- a/reference/parle/parle/lexer/advance.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Parle\Lexer::advance - Process next lexer rule - - - - &reftitle.description; - - public voidParle\Lexer::advance - - - - Processes the next rule and prepares the resulting token data. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/lexer/build.xml b/reference/parle/parle/lexer/build.xml deleted file mode 100644 index 9575e551d535..000000000000 --- a/reference/parle/parle/lexer/build.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Parle\Lexer::build - Finalize the lexer rule set - - - - &reftitle.description; - - public voidParle\Lexer::build - - - - Rules, previously added with Parle\Lexer::push are finalized. This method call has to be done after all the necessary rules was pushed. The rule set becomes read only. The lexing can begin. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/lexer/callout.xml b/reference/parle/parle/lexer/callout.xml deleted file mode 100644 index 989c6b3b3f04..000000000000 --- a/reference/parle/parle/lexer/callout.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Parle\Lexer::callout - Define token callback - - - - &reftitle.description; - - public voidParle\Lexer::callout - intid - callablecallback - - - Define a callback to be invoked once lexer encounters a particular token. - - - - - &reftitle.parameters; - - - id - - - Token id. - - - - - callback - - - Callable to be invoked. The callable doesn't receive any arguments and its return value is ignored. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/lexer/consume.xml b/reference/parle/parle/lexer/consume.xml deleted file mode 100644 index 2018cf6a3d08..000000000000 --- a/reference/parle/parle/lexer/consume.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Parle\Lexer::consume - Pass the data for processing - - - - &reftitle.description; - - public voidParle\Lexer::consume - stringdata - - - Consume the data for lexing. - - - - - &reftitle.parameters; - - - data - - - Data to be lexed. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/lexer/dump.xml b/reference/parle/parle/lexer/dump.xml deleted file mode 100644 index 63f52ef6259d..000000000000 --- a/reference/parle/parle/lexer/dump.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Parle\Lexer::dump - Dump the state machine - - - - &reftitle.description; - - public voidParle\Lexer::dump - - - - Dump the current state machine to stdout. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/lexer/gettoken.xml b/reference/parle/parle/lexer/gettoken.xml deleted file mode 100644 index 79f1374eb0b3..000000000000 --- a/reference/parle/parle/lexer/gettoken.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Parle\Lexer::getToken - Retrieve the current token - - - - &reftitle.description; - - public Parle\TokenParle\Lexer::getToken - - - - Retrieve the current token. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an instance of Parle\Token. - - - - - - - diff --git a/reference/parle/parle/lexer/insertmacro.xml b/reference/parle/parle/lexer/insertmacro.xml deleted file mode 100644 index 979dd723d2c8..000000000000 --- a/reference/parle/parle/lexer/insertmacro.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Parle\Lexer::insertMacro - Insert regex macro - - - - &reftitle.description; - - public voidParle\Lexer::insertMacro - stringname - stringregex - - - Insert a regex macro, that can be later used as a shortcut and included in other regular expressions. - - - - - &reftitle.parameters; - - - name - - - Name of the macros. - - - - - regex - - - Regular expression. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/lexer/push.xml b/reference/parle/parle/lexer/push.xml deleted file mode 100644 index ee0e8519ae3f..000000000000 --- a/reference/parle/parle/lexer/push.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - Parle\Lexer::push - Add a lexer rule - - - - &reftitle.description; - - public voidParle\Lexer::push - stringregex - intid - - - - Push a pattern for lexeme recognition. - - - - - &reftitle.parameters; - - - regex - - - Regular expression used for token matching. - - - - - id - - - Token id. If the lexer instance is meant to be used standalone, this can be an arbitrary number. If the lexer instance is going to be passed to the parser, it has to be an id returned by Parle\Parser::tokenid. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/lexer/reset.xml b/reference/parle/parle/lexer/reset.xml deleted file mode 100644 index 41359ca407e3..000000000000 --- a/reference/parle/parle/lexer/reset.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Parle\Lexer::reset - Reset lexer - - - - &reftitle.description; - - public voidParle\Lexer::reset - intpos - - - Reset lexing optionally supplying the desired offset. - - - - - &reftitle.parameters; - - - pos - - - Reset position. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/parser/advance.xml b/reference/parle/parle/parser/advance.xml deleted file mode 100644 index c57168d2f6d1..000000000000 --- a/reference/parle/parle/parser/advance.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Parle\Parser::advance - Process next parser rule - - - - &reftitle.description; - - public voidParle\Parser::advance - - - - Process next parser rule. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/parser/build.xml b/reference/parle/parle/parser/build.xml deleted file mode 100644 index b7936aa6cec7..000000000000 --- a/reference/parle/parle/parser/build.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Parle\Parser::build - Finalize the grammar rules - - - - &reftitle.description; - - public voidParle\Parser::build - - - - Any tokens and grammar rules previously added are finalized. The rule set becomes readonly and the parser is ready to start. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/parser/consume.xml b/reference/parle/parle/parser/consume.xml deleted file mode 100644 index 5cd79e8da718..000000000000 --- a/reference/parle/parle/parser/consume.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Parle\Parser::consume - Consume the data for processing - - - - &reftitle.description; - - public voidParle\Parser::consume - stringdata - Parle\Lexerlexer - - - Consume the data for parsing. - - - - - &reftitle.parameters; - - - data - - - Data to be parsed. - - - - - lexer - - - A lexer object containing the lexing rules prepared for the particular grammar. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/parser/dump.xml b/reference/parle/parle/parser/dump.xml deleted file mode 100644 index a9f4ed6d54ee..000000000000 --- a/reference/parle/parle/parser/dump.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Parle\Parser::dump - Dump the grammar - - - - &reftitle.description; - - public voidParle\Parser::dump - - - - Dump the current grammar to stdout. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/parser/errorinfo.xml b/reference/parle/parle/parser/errorinfo.xml deleted file mode 100644 index 3da6e1bae9b6..000000000000 --- a/reference/parle/parle/parser/errorinfo.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Parle\Parser::errorInfo - Retrieve the error information - - - - &reftitle.description; - - public Parle\ErrorInfoParle\Parser::errorInfo - - - - Retrieve the error information in case Parle\Parser::action returned the error action. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an instance of Parle\ErrorInfo. - - - - - - - diff --git a/reference/parle/parle/parser/left.xml b/reference/parle/parle/parser/left.xml deleted file mode 100644 index 90e93d48e0f3..000000000000 --- a/reference/parle/parle/parser/left.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Parle\Parser::left - Declare a token with left-associativity - - - - &reftitle.description; - - public voidParle\Parser::left - stringtok - - - Declare a terminal with left associativity. - - - - - &reftitle.parameters; - - - tok - - - Token name. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/parser/nonassoc.xml b/reference/parle/parle/parser/nonassoc.xml deleted file mode 100644 index d536d6751685..000000000000 --- a/reference/parle/parle/parser/nonassoc.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Parle\Parser::nonassoc - Declare a token with no associativity - - - - &reftitle.description; - - public voidParle\Parser::nonassoc - stringtok - - - Declare a terminal, that cannot appear more than once in the row. - - - - - &reftitle.parameters; - - - tok - - - Token name. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/parser/precedence.xml b/reference/parle/parle/parser/precedence.xml deleted file mode 100644 index 65f085b79beb..000000000000 --- a/reference/parle/parle/parser/precedence.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Parle\Parser::precedence - Declare a precedence rule - - - - &reftitle.description; - - public voidParle\Parser::precedence - stringtok - - - Declares a precedence rule for a fictitious terminal symbol. This rule can be later used in the specific grammar rules. - - - - - &reftitle.parameters; - - - tok - - - Token name. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/parser/push.xml b/reference/parle/parle/parser/push.xml deleted file mode 100644 index a40783867cbc..000000000000 --- a/reference/parle/parle/parser/push.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Parle\Parser::push - Add a grammar rule - - - - &reftitle.description; - - public intParle\Parser::push - stringname - stringrule - - - Push a grammar rule. The production id returned can be used later in the parsing process to identify the rule matched. - - - - - &reftitle.parameters; - - - name - - - Rule name. - - - - - rule - - - The rule to be added. The syntax is Bison compatible. - - - - - - - - &reftitle.returnvalues; - - Returns &integer; representing the rule index. - - - - - - - diff --git a/reference/parle/parle/parser/reset.xml b/reference/parle/parle/parser/reset.xml deleted file mode 100644 index ac93e570e540..000000000000 --- a/reference/parle/parle/parser/reset.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Parle\Parser::reset - Reset parser state - - - - &reftitle.description; - - public voidParle\Parser::reset - inttokenId - - - Reset parser state using the given token id. - - - - - &reftitle.parameters; - - - tokenId - - - Token id. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/parser/right.xml b/reference/parle/parle/parser/right.xml deleted file mode 100644 index 50f867167587..000000000000 --- a/reference/parle/parle/parser/right.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Parle\Parser::right - Declare a token with right-associativity - - - - &reftitle.description; - - public voidParle\Parser::right - stringtok - - - Declare a terminal with right associativity. - - - - - &reftitle.parameters; - - - tok - - - Token name. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/parser/sigil.xml b/reference/parle/parle/parser/sigil.xml deleted file mode 100644 index c737ba254677..000000000000 --- a/reference/parle/parle/parser/sigil.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Parle\Parser::sigil - Retrieve a matching part of a rule - - - - &reftitle.description; - - public stringParle\Parser::sigil - intidx - - - Retrieve a part of the match by a rule. This method is equivalent to the pseudo variable functionality in Bison. - - - - - &reftitle.parameters; - - - idx - - - Match index, zero based. - - - - - - - - &reftitle.returnvalues; - - Returns a &string; with the matched part. - - - - - - - diff --git a/reference/parle/parle/parser/sigilcount.xml b/reference/parle/parle/parser/sigilcount.xml deleted file mode 100644 index 193526f42f37..000000000000 --- a/reference/parle/parle/parser/sigilcount.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Parle\Parser::sigilCount - Number of elements in matched rule - - - - &reftitle.description; - - public intParle\Parser::sigilCount - - - - Get number of elements in the matched rule. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &integer; - - - - - - - diff --git a/reference/parle/parle/parser/sigilname.xml b/reference/parle/parle/parser/sigilname.xml deleted file mode 100644 index eef341799174..000000000000 --- a/reference/parle/parle/parser/sigilname.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Parle\Parser::sigilName - Retrieve a rule or token name - - - - &reftitle.description; - - public stringParle\Parser::sigilName - intidx - - - Retrieve a partial rule name or token name corresponding to the sigil index. - - - - - &reftitle.parameters; - - - idx - - - Match index, zero based. - - - - - - - - &reftitle.returnvalues; - - Returns a &string; with the matched part. - - - - - - - diff --git a/reference/parle/parle/parser/token.xml b/reference/parle/parle/parser/token.xml deleted file mode 100644 index 21c17f358614..000000000000 --- a/reference/parle/parle/parser/token.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Parle\Parser::token - Declare a token - - - - &reftitle.description; - - public voidParle\Parser::token - stringtok - - - Declare a terminal to be used in the grammar. - - - - - &reftitle.parameters; - - - tok - - - Token name. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/parser/tokenid.xml b/reference/parle/parle/parser/tokenid.xml deleted file mode 100644 index 922a18b26ef6..000000000000 --- a/reference/parle/parle/parser/tokenid.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Parle\Parser::tokenId - Get token id - - - - &reftitle.description; - - public intParle\Parser::tokenId - stringtok - - - Retrieve the id of the named token. - - - - - &reftitle.parameters; - - - tok - - - Name of the token as used in Parle\Parser::token. - - - - - - - - &reftitle.returnvalues; - - Returns &integer; representing the token id. - - - - - - - diff --git a/reference/parle/parle/parser/trace.xml b/reference/parle/parle/parser/trace.xml deleted file mode 100644 index 9dfa7e2fbe2d..000000000000 --- a/reference/parle/parle/parser/trace.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Parle\Parser::trace - Trace the parser operation - - - - &reftitle.description; - - public stringParle\Parser::trace - - - - Retrieve the current parser operation description. This can be especially useful for studying the parser and to optimize the grammar. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a &string; with the trace information. - - - - - - - diff --git a/reference/parle/parle/parser/validate.xml b/reference/parle/parle/parser/validate.xml deleted file mode 100644 index f255e23054b8..000000000000 --- a/reference/parle/parle/parser/validate.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Parle\Parser::validate - Validate input - - - - &reftitle.description; - - public boolParle\Parser::validate - stringdata - Parle\Lexerlexer - - - Validate an input string. The string is parsed internally, thus this method is useful for the quick input validation. - - - - - &reftitle.parameters; - - - data - - - String to be validated. - - - - - lexer - - - A lexer object containing the lexing rules prepared for the particular grammar. - - - - - - - - &reftitle.returnvalues; - - Returns &boolean; witnessing whether the input chimes or not with the defined rules. - - - - - - - diff --git a/reference/parle/parle/rlexer/advance.xml b/reference/parle/parle/rlexer/advance.xml deleted file mode 100644 index 4201985d98fb..000000000000 --- a/reference/parle/parle/rlexer/advance.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Parle\RLexer::advance - Process next lexer rule - - - - &reftitle.description; - - public voidParle\RLexer::advance - - - - Processes the next rule and prepares the resulting token data. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/rlexer/build.xml b/reference/parle/parle/rlexer/build.xml deleted file mode 100644 index d428fc1df9ac..000000000000 --- a/reference/parle/parle/rlexer/build.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Parle\RLexer::build - Finalize the lexer rule set - - - - &reftitle.description; - - public voidParle\RLexer::build - - - - Rules, previously added with Parle\RLexer::push are finalized. This method call has to be done after all the necessary rules was pushed. The rule set becomes read only. The lexing can begin. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/rlexer/callout.xml b/reference/parle/parle/rlexer/callout.xml deleted file mode 100644 index 54c4370c4512..000000000000 --- a/reference/parle/parle/rlexer/callout.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Parle\RLexer::callout - Define token callback - - - - &reftitle.description; - - public voidParle\RLexer::callout - intid - callablecallback - - - Define a callback to be invoked once lexer encounters a particular token. - - - - - &reftitle.parameters; - - - id - - - Token id. - - - - - callback - - - Callable to be invoked. The callable doesn't receive any arguments and its return value is ignored. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/rlexer/consume.xml b/reference/parle/parle/rlexer/consume.xml deleted file mode 100644 index 53f561c30863..000000000000 --- a/reference/parle/parle/rlexer/consume.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Parle\RLexer::consume - Pass the data for processing - - - - &reftitle.description; - - public voidParle\RLexer::consume - stringdata - - - Consume the data for lexing. - - - - - &reftitle.parameters; - - - data - - - Data to be lexed. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/rlexer/dump.xml b/reference/parle/parle/rlexer/dump.xml deleted file mode 100644 index ca8a4f44f471..000000000000 --- a/reference/parle/parle/rlexer/dump.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Parle\RLexer::dump - Dump the state machine - - - - &reftitle.description; - - public voidParle\RLexer::dump - - - - Dump the current state machine to stdout. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/rlexer/gettoken.xml b/reference/parle/parle/rlexer/gettoken.xml deleted file mode 100644 index 2e9e4069015b..000000000000 --- a/reference/parle/parle/rlexer/gettoken.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Parle\RLexer::getToken - Retrieve the current token - - - - &reftitle.description; - - public Parle\TokenParle\RLexer::getToken - - - - Retrive the current token. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an instance of Parle\Token. - - - - - - - diff --git a/reference/parle/parle/rlexer/insertmacro.xml b/reference/parle/parle/rlexer/insertmacro.xml deleted file mode 100644 index cc5187dff5dc..000000000000 --- a/reference/parle/parle/rlexer/insertmacro.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Parle\RLexer::insertMacro - Insert regex macro - - - - &reftitle.description; - - public voidParle\RLexer::insertMacro - stringname - stringregex - - - Insert a regex macro, that can be later used as a shortcut and included in other regular expressions. - - - - - &reftitle.parameters; - - - name - - - Name of the macros. - - - - - regex - - - Regular expression. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/rlexer/push.xml b/reference/parle/parle/rlexer/push.xml deleted file mode 100644 index 445f2ba13912..000000000000 --- a/reference/parle/parle/rlexer/push.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - Parle\RLexer::push - Add a lexer rule - - - - &reftitle.description; - - public voidParle\RLexer::push - stringregex - intid - - - - public voidParle\RLexer::push - stringstate - stringregex - intid - stringnewState - - - - public voidParle\RLexer::push - stringstate - stringregex - stringnewState - - - Push a pattern for lexeme recognition. - - A 'start state' and 'exit state' can be specified by using a suitable signature. - - - - - &reftitle.parameters; - - - regex - - - Regular expression used for token matching. - - - - - id - - - Token id. If the lexer instance is meant to be used standalone, this can be an arbitrary number. If the lexer instance is going to be passed to the parser, it has to be an id returned by Parle\RParser::tokenid. - - - - - state - - - State name. If '*' is used as start state, then the rule is applied to all lexer states. - - - - - newState - - - New state name, after the rule was applied. - - - If '.' is specified as the exit state, then the lexer state is unchanged when that rule matches. An exit state with '>' before the name means push. Use the signature without id for either continuation or to start matching, when a continuation or recursion is required. - - - If '<' is specified as exit state, it means pop. In that case, the signature containing the id can be used to identify the match. Note that even in the case an id is specified, the rule will finish first when all the previous pushes popped. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/rlexer/pushstate.xml b/reference/parle/parle/rlexer/pushstate.xml deleted file mode 100644 index 1ec44f8e2d40..000000000000 --- a/reference/parle/parle/rlexer/pushstate.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Parle\RLexer::pushState - Push a new start state - - - - &reftitle.description; - - public intParle\RLexer::pushState - stringstate - - - This lexer type can have more than one state machine. This allows you to lex different tokens depending on context, thus allowing simple parsing to take place. Once a state pushed, it can be used with a suitable Parle\RLexer::push signature variant. - - - - - &reftitle.parameters; - - - state - - - Name of the state. - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/parle/parle/rlexer/reset.xml b/reference/parle/parle/rlexer/reset.xml deleted file mode 100644 index 3075e62efc81..000000000000 --- a/reference/parle/parle/rlexer/reset.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Parle\RLexer::reset - Reset lexer - - - - &reftitle.description; - - public voidParle\RLexer::reset - intpos - - - Reset lexing optionally supplying the desired offset. - - - - - &reftitle.parameters; - - - pos - - - Reset position. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/rparser/advance.xml b/reference/parle/parle/rparser/advance.xml deleted file mode 100644 index 65fb8519cdf5..000000000000 --- a/reference/parle/parle/rparser/advance.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Parle\RParser::advance - Process next parser rule - - - - &reftitle.description; - - public voidParle\RParser::advance - - - - Prosess next parser rule. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/rparser/build.xml b/reference/parle/parle/rparser/build.xml deleted file mode 100644 index b48745c52981..000000000000 --- a/reference/parle/parle/rparser/build.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Parle\RParser::build - Finalize the grammar rules - - - - &reftitle.description; - - public voidParle\RParser::build - - - - Any tokens and grammar rules previously added are finalized. The rule set becomes readonly and the parser is ready to start. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/rparser/consume.xml b/reference/parle/parle/rparser/consume.xml deleted file mode 100644 index 8de0f5f94d99..000000000000 --- a/reference/parle/parle/rparser/consume.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Parle\RParser::consume - Consume the data for processing - - - - &reftitle.description; - - public voidParle\RParser::consume - stringdata - Parle\RLexerrlexer - - - Consume the data for parsing. - - - - - &reftitle.parameters; - - - data - - - Data to be parsed. - - - - - lexer - - - A lexer object containing the lexing rules prepared for the particular grammar. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/rparser/dump.xml b/reference/parle/parle/rparser/dump.xml deleted file mode 100644 index 0d6bd2ee7a0b..000000000000 --- a/reference/parle/parle/rparser/dump.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Parle\RParser::dump - Dump the grammar - - - - &reftitle.description; - - public voidParle\RParser::dump - - - - Dump the current grammar to stdout. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/rparser/errorinfo.xml b/reference/parle/parle/rparser/errorinfo.xml deleted file mode 100644 index 1e0c89121ba4..000000000000 --- a/reference/parle/parle/rparser/errorinfo.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Parle\RParser::errorInfo - Retrieve the error information - - - - &reftitle.description; - - public Parle\ErrorInfoParle\RParser::errorInfo - - - - Retrieve the error information in case Parle\RParser::action returned the error action. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an instance of Parle\ErrorInfo. - - - - - - - diff --git a/reference/parle/parle/rparser/left.xml b/reference/parle/parle/rparser/left.xml deleted file mode 100644 index 5632cc383163..000000000000 --- a/reference/parle/parle/rparser/left.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Parle\RParser::left - Declare a token with left-associativity - - - - &reftitle.description; - - public voidParle\RParser::left - stringtok - - - Declare a terminal with left associativity. - - - - - &reftitle.parameters; - - - tok - - - Token name. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/rparser/nonassoc.xml b/reference/parle/parle/rparser/nonassoc.xml deleted file mode 100644 index 30d89f13c487..000000000000 --- a/reference/parle/parle/rparser/nonassoc.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Parle\RParser::nonassoc - Declare a token with no associativity - - - - &reftitle.description; - - public voidParle\RParser::nonassoc - stringtok - - - Declare a terminal, that cannot appear more than once in the row. - - - - - &reftitle.parameters; - - - tok - - - Token name. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/rparser/precedence.xml b/reference/parle/parle/rparser/precedence.xml deleted file mode 100644 index c0bfa43a13c6..000000000000 --- a/reference/parle/parle/rparser/precedence.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Parle\RParser::precedence - Declare a precedence rule - - - - &reftitle.description; - - public voidParle\RParser::precedence - stringtok - - - Declares a precedence rule for a fictious terminal symbol. This rule can be later used in the specific grammar rules. - - - - - &reftitle.parameters; - - - tok - - - Token name. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/rparser/push.xml b/reference/parle/parle/rparser/push.xml deleted file mode 100644 index 68170695ccdd..000000000000 --- a/reference/parle/parle/rparser/push.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Parle\RParser::push - Add a grammar rule - - - - &reftitle.description; - - public intParle\RParser::push - stringname - stringrule - - - Push a grammar rule. The production id returned can be used later in the parsing process to identify the rule matched. - - - - - &reftitle.parameters; - - - name - - - Rule name. - - - - - rule - - - The rule to be added. The syntax is Bison compatible. - - - - - - - - &reftitle.returnvalues; - - Returns &integer; representing the rule index. - - - - - - - diff --git a/reference/parle/parle/rparser/reset.xml b/reference/parle/parle/rparser/reset.xml deleted file mode 100644 index 2ab1539d8d8b..000000000000 --- a/reference/parle/parle/rparser/reset.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Parle\RParser::reset - Reset parser state - - - - &reftitle.description; - - public voidParle\RParser::reset - inttokenId - - - Reset parser state using the given token id. - - - - - &reftitle.parameters; - - - tokenId - - - Token id. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/rparser/right.xml b/reference/parle/parle/rparser/right.xml deleted file mode 100644 index 4bc75be44693..000000000000 --- a/reference/parle/parle/rparser/right.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Parle\RParser::right - Declare a token with right-associativity - - - - &reftitle.description; - - public voidParle\RParser::right - stringtok - - - Declare a terminal with right associativity. - - - - - &reftitle.parameters; - - - tok - - - Token name. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/rparser/sigil.xml b/reference/parle/parle/rparser/sigil.xml deleted file mode 100644 index 94829a6774fd..000000000000 --- a/reference/parle/parle/rparser/sigil.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Parle\RParser::sigil - Retrieve a matching part of a rule - - - - &reftitle.description; - - public stringParle\RParser::sigil - intidx - - - Retrieve a part of the match by a rule. This method is equivalent to the pseudo variable functionality in Bison. - - - - - &reftitle.parameters; - - - idx - - - Match index, zero based. - - - - - - - - &reftitle.returnvalues; - - Returns a &string; with the matched part. - - - - - - - diff --git a/reference/parle/parle/rparser/sigilcount.xml b/reference/parle/parle/rparser/sigilcount.xml deleted file mode 100644 index 87e27015991a..000000000000 --- a/reference/parle/parle/rparser/sigilcount.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Parle\RParser::sigilCount - Number of elements in matched rule - - - - &reftitle.description; - - public intParle\RParser::sigilCount - - - - Get number of elements in the matched rule. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &integer; - - - - - - - diff --git a/reference/parle/parle/rparser/sigilname.xml b/reference/parle/parle/rparser/sigilname.xml deleted file mode 100644 index 0d67d9b7ff5c..000000000000 --- a/reference/parle/parle/rparser/sigilname.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Parle\RParser::sigilName - Retrieve a rule or token name - - - - &reftitle.description; - - public stringParle\RParser::sigilName - intidx - - - Retrieve a partial rule name or token name corresponding to the sigil index. - - - - - &reftitle.parameters; - - - idx - - - Match index, zero based. - - - - - - - - &reftitle.returnvalues; - - Returns a &string; with the matched part. - - - - - - - diff --git a/reference/parle/parle/rparser/token.xml b/reference/parle/parle/rparser/token.xml deleted file mode 100644 index d745da7e3033..000000000000 --- a/reference/parle/parle/rparser/token.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Parle\RParser::token - Declare a token - - - - &reftitle.description; - - public voidParle\RParser::token - stringtok - - - Declare a terminal to be used in the grammar. - - - - - &reftitle.parameters; - - - tok - - - Token name. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/rparser/tokenid.xml b/reference/parle/parle/rparser/tokenid.xml deleted file mode 100644 index cde47ea9cc29..000000000000 --- a/reference/parle/parle/rparser/tokenid.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Parle\RParser::tokenId - Get token id - - - - &reftitle.description; - - public intParle\RParser::tokenId - stringtok - - - Retrieve the id of the named token. - - - - - &reftitle.parameters; - - - tok - - - Name of the token as used in Parle\RParser::token. - - - - - - - - &reftitle.returnvalues; - - Returns &integer; representing the token id. - - - - - - - diff --git a/reference/parle/parle/rparser/trace.xml b/reference/parle/parle/rparser/trace.xml deleted file mode 100644 index 703e0f377c24..000000000000 --- a/reference/parle/parle/rparser/trace.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Parle\RParser::trace - Trace the parser operation - - - - &reftitle.description; - - public stringParle\RParser::trace - - - - Retrieve the current parser operation description. This can be especially useful to study the parser and to optimize the grammar. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a &string; with the trace information. - - - - - - - diff --git a/reference/parle/parle/rparser/validate.xml b/reference/parle/parle/rparser/validate.xml deleted file mode 100644 index e3fe2b24b919..000000000000 --- a/reference/parle/parle/rparser/validate.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Parle\RParser::validate - Validate input - - - - &reftitle.description; - - public boolParle\RParser::validate - stringdata - Parle\RLexerlexer - - - Validate an input string. The string is parsed internally, thus this method is useful for the quick input validation. - - - - - &reftitle.parameters; - - - data - - - String to be validated. - - - - - lexer - - - A lexer object containing the lexing rules prepared for the particular grammar. - - - - - - - - &reftitle.returnvalues; - - Returns &boolean; whitnessing whether the input chimes or not with the defined rules. - - - - - - - diff --git a/reference/parle/parle/stack/pop.xml b/reference/parle/parle/stack/pop.xml deleted file mode 100644 index 7b4c62912977..000000000000 --- a/reference/parle/parle/stack/pop.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Parle\Stack::pop - Pop an item from the stack - - - - &reftitle.description; - - public voidParle\Stack::pop - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/parle/stack/push.xml b/reference/parle/parle/stack/push.xml deleted file mode 100644 index 1292b164130b..000000000000 --- a/reference/parle/parle/stack/push.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Parle\Stack::push - Push an item into the stack - - - - &reftitle.description; - - public voidParle\Stack::push - mixeditem - - - - - - - - &reftitle.parameters; - - - item - - - Variable to be pushed. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/parle/pattern.matching.xml b/reference/parle/pattern.matching.xml deleted file mode 100644 index bef88be5c21b..000000000000 --- a/reference/parle/pattern.matching.xml +++ /dev/null @@ -1,410 +0,0 @@ - - - Parle pattern matching - Pattern matching - - Parle supports regex matching similar to flex. - Also supported are the following POSIX character sets: - - [:alnum:] - [:alpha:] - [:blank:] - [:cntrl:] - [:digit:] - [:graph:] - [:lower:] - [:print:] - [:punct:] - [:space:] - [:upper:] - [:xdigit:] - . - - - The Unicode character classes are currently not enabled by default, pass --enable-parle-utf32 to make them available. - A particular encoding can be mapped with a correctly constructed regex. - For example, to match the EURO symbol encoded in UTF-8, the regular expression [\xe2][\x82][\xac] can be used. - The pattern for an UTF-8 encoded string could be [ -\x7f]{+}[\x80-\xbf]{+}[\xc2-\xdf]{+}[\xe0-\xef]{+}[\xf0-\xff]+. - - -
    - Character representations - - - Character representations - - - - SequenceDescription - - - - - \aAlert (bell). - - - \bBackspace. - - - \eESC character, \x1b. - - - \nNewline. - - - \rCarriage return. - - - \fForm feed, \x0c. - - - \tHorizontal tab, \x09. - - - \vVertical tab, \x0b. - - - \octCharacter specified by a three-digit octal code. - - - \xhexCharacter specified by a hex code. - - - \ccharNamed control character. - - - -
    -
    -
    -
    - Character classes - - - Character classes - - - - SequenceDescription - - - - - [...]A single character listed or contained within a listed range. Ranges can be combined with the {+} and {-} operators. For example [a-z]{+}[0-9] is the same as [0-9a-z] and [a-z]{-}[aeiou] is the same as [b-df-hj-np-tv-z]. - - - [^...]A single character not listed and not contained within a listed range. - - - .Any character, default [^\n]. - - - \dDigit character, [0-9]. - - - \DNon-digit character, [^0-9]. - - - \sWhite space character, [ \t\n\r\f\v]. - - - \SNon-white space character, [^ \t\n\r\f\v]. - - - \wWord character, [a-zA-Z0-9_]. - - - \WNon-word character, [^a-zA-Z0-9_]. - - - -
    -
    -
    -
    - Unicode character classes - - - Unicode character classes - - - - SequenceDescription - - - - - \p{C}Other. - - - \p{Cc}Other, control. - - - \p{Cf}Other, format. - - - \p{Co}Other, private use. - - - \p{Cs}Other, surrogate. - - - \p{L}Letter. - - - \p{LC}Letter, cased. - - - \p{Ll}Letter, lowercase. - - - \p{Lm}Letter, modifier. - - - \p{Lo}Letter, other. - - - \p{Lt}Letter, titlecase. - - - \p{Lu}Letter, uppercase. - - - \p{M}Mark. - - - \p{Mc}Mark, space combining. - - - \p{Me}Mark, enclosing. - - - \p{Mn}Mark, nonspacing. - - - \p{N}Number. - - - \p{Nd}Number, decimal digit. - - - \p{Nl}Number, letter. - - - \p{No}Number, other. - - - \p{P}Punctuation. - - - \p{Pc}Punctiation, connector. - - - \p{Pd}Punctuation, dash. - - - \p{Pe}Punctuation, close. - - - \p{Pf}Punctuation, final quote. - - - \p{Pi}Punctuation, initial quote. - - - \p{Po}Punctuation, other. - - - \p{Ps}Punctuation, open. - - - \p{S}Symbol. - - - \p{Sc}Symbol, currency. - - - \p{Sk}Symbol, modifier. - - - \p{Sm}Symbol, math. - - - \p{So}Symbol, other. - - - \p{Z}Separator. - - - \p{Zl}Separator, line. - - - \p{Zp}Separator, paragraph. - - - \p{Zs}Separator, space. - - - -
    -
    - - These character classes are only available, if the option --enable-parle-utf32 was passed at the compilation time. - -
    -
    - Alternation and repetition - - - Alternation and repetition - - - - SequenceGreedyDescription - - - - - ...|...-Try sub-patterns in alternation. - - - *yesMatch 0 or more times. - - - +yesMatch 1 or more times. - - - ?yesMatch 0 or 1 times. - - - {n}noMatch exactly n times. - - - {n,}yesMatch at least n times. - - - {n,m}yesMatch at least n times but no more than m times. - - - *?noMatch 0 or more times. - - - +?noMatch 1 or more times. - - - ??noMatch 0 or 1 times. - - - {n,}?noMatch at least n times. - - - {n,m}?noMatch at least n times but no more than m times. - - - {MACRO}-Include the regex MACRO in the current regex. - - - -
    -
    -
    -
    - Anchors - - - Anchors - - - - SequenceDescription - - - - - ^Start of string or after a newline. - - - $End of string or before a newline. - - - -
    -
    -
    -
    - Grouping - - - Grouping - - - - Sequence - Description - - - - - (...) - Group a regular expression to override default operator precedence. - - - (?r-s:pattern) - - - Apply option r and omit option s while interpreting pattern. - Options may be zero or more of the characters i, s, or x. - - - i means case-insensitive. - - - -i means case-sensitive. - - - s alters the meaning of . to match any character whatsoever. - - - -s alters the meaning of . to match any character except \n. - - - x ignores comments and whitespace in patterns. - Whitespace is ignored unless it is backslash-escaped, contained within ""s, - or appears inside a character range. - - - These options can be applied globally at the rules level by passing a combination of the bit flags to the lexer. - - - - - (?# comment ) - Omit everything within (). The first ) character encountered ends the pattern. It is not possible for the comment to contain a ) character. The comment may span lines. - - - -
    -
    -
    -
    - - diff --git a/reference/parle/setup.xml b/reference/parle/setup.xml deleted file mode 100644 index 2dfd5784b65a..000000000000 --- a/reference/parle/setup.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - PHP 7.4 or above is supported. A C++14 capable compiler is required. A successful extension build was produced with at least clang 5.0, GCC 5.0 and Visual Studio 2015. - -
    - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;parle. - - - - Available configure options - - - - OptionDescription - - - - - --enable-parleEnable parle extension. - - - --enable-parle-utf32Enable internal UTF-32 support. Available since parle 0.7.2. - - - -
    -
    -
    - - - -
    - - diff --git a/reference/parle/versions.xml b/reference/parle/versions.xml deleted file mode 100644 index 9528df2f3b21..000000000000 --- a/reference/parle/versions.xml +++ /dev/null @@ -1,138 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/pdo/drivers.xml b/reference/pdo/drivers.xml index e293e86ad9c0..52f0b50b0bc7 100644 --- a/reference/pdo/drivers.xml +++ b/reference/pdo/drivers.xml @@ -17,7 +17,7 @@ - PDO_CUBRID + PDO_CUBRID Cubrid @@ -29,11 +29,11 @@ Firebird - PDO_IBM + PDO_IBM IBM DB2 - PDO_INFORMIX + PDO_INFORMIX IBM Informix Dynamic Server @@ -57,7 +57,7 @@ SQLite 3 and SQLite 2 - PDO_SQLSRV + PDO_SQLSRV Microsoft SQL Server / SQL Azure @@ -66,16 +66,12 @@ - &reference.pdo-cubrid.reference; &reference.pdo-dblib.reference; &reference.pdo-dblib.pdo-dblib; &reference.pdo-firebird.reference; &reference.pdo-firebird.pdo-firebird; - &reference.pdo-ibm.reference; - &reference.pdo-informix.reference; &reference.pdo-mysql.reference; &reference.pdo-mysql.pdo-mysql; - &reference.pdo-sqlsrv.reference; &reference.pdo-oci.reference; &reference.pdo-odbc.reference; &reference.pdo-odbc.pdo-odbc; diff --git a/reference/pdo_cubrid/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/pdo_cubrid/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/pdo_cubrid/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/pdo_cubrid/configure.xml b/reference/pdo_cubrid/configure.xml deleted file mode 100644 index 8ad8101eeb7c..000000000000 --- a/reference/pdo_cubrid/configure.xml +++ /dev/null @@ -1,48 +0,0 @@ - - -
    - &reftitle.install; - - To build the PDO_CUBRID extension, the CUBRID DBMS must be installed on the - same system as PHP. - - PDO_CUBRID is a &link.pecl; extension, so follow the instructions in - - to install the PDO_CUBRID extension. - Issue the configure command to point to the location of the - CUBRID base dir as follows: - - - - The configure command defaults to the value of the - CUBRID - environment variable. - - - &pecl.windows.download; Detailed information about installation on Linux and - Windows manually, please read build-guide.html in PECL package CUBRID for - reference. - -
    - diff --git a/reference/pdo_cubrid/constants.xml b/reference/pdo_cubrid/constants.xml deleted file mode 100644 index e6bba23c09b1..000000000000 --- a/reference/pdo_cubrid/constants.xml +++ /dev/null @@ -1,213 +0,0 @@ - - -
    - &reftitle.constants; - &pdo.driver-constants; - - The following constants can be used when setting the database attribute. - They can be passed to PDO::getAttribute or - PDO::setAttribute. - - PDO::CUBRID attribute flags - - - - Constant - Description - - - - - PDO::CUBRID_ATTR_ISOLATION_LEVEL - Transaction isolation level for the database connection. - - - PDO::CUBRID_ATTR_LOCK_TIMEOUT - Transaction timeout in seconds. - - - PDO::CUBRID_ATTR_MAX_STRING_LENGTH - Read only. The maximum string length for bit, varbit, char, - varchar, nchar, nchar varying data types when using CUBRID PDO - API. - - - -
    -
    - - - The following constants can be used when setting the transaction isolation - level. They can be passed to PDO::getAttribute or - returned by PDO::setAttribute. - - PDO::CUBRID isolation level flags - - - - Constant - Description - - - - - PDO::TRAN_COMMIT_CLASS_UNCOMMIT_INSTANCE - The lowest isolation level (1). A dirty, non-repeatable or - phantom read may occur for the tuple and a non-repeatable read may - occur for the table as well. - - - PDO::TRAN_COMMIT_CLASS_COMMIT_INSTANCE - A relatively low isolation level (2). A dirty read does not - occur, but non-repeatable or phantom read may occur. - - - PDO::TRAN_REP_CLASS_UNCOMMIT_INSTANCE - The default isolation of CUBRID (3). A dirty, non-repeatable or - phantom read may occur for the tuple, but repeatable read is ensured - for the table. - - - PDO::TRAN_REP_CLASS_COMMIT_INSTANCE - A relatively low isolation level (4). A dirty read does not - occur, but non-repeatable or phantom read may. - - - PDO::TRAN_REP_CLASS_REP_INSTANCE - A relatively high isolation level (5). A dirty or non-repeatable - read does not occur, but a phantom read may. - - - PDO::TRAN_SERIALIZABLE - The highest isolation level (6). Problems concerning concurrency - (e.g. dirty read, non-repeatable read, phantom read, etc.) do not - occur. - - - -
    -
    - - - The following constants can be used when getting schema information. They - can be passed to PDO::cubrid_schema. - - PDO::CUBRID schema flags - - - - Constant - Description - - - - - PDO::CUBRID_SCH_TABLE - Get name and type of table in CUBRID. - - - PDO::CUBRID_SCH_VIEW - Get name and type of view in CUBRID. - - - PDO::CUBRID_SCH_QUERY_SPEC - Get the query definition of view. - - - PDO::CUBRID_SCH_ATTRIBUTE - Get the attributes of table column. - - - PDO::CUBRID_SCH_TABLE_ATTRIBUTE - Get the attributes of table. - - - PDO::CUBRID_SCH_METHOD - Get the instance method. The instance method is a method called - by a class instance. It is used more often than the class method - because most operations are executed in the instance. - - - PDO::CUBRID_SCH_TABLE_METHOD - Get the class method. The class method is a method called by a - class object. It is usually used to create a new class instance or to - initialize it. It is also used to access or update class - attributes. - - - PDO::CUBRID_SCH_METHOD_FILE - Get the information of the file where the method of the table is - defined. - - - PDO::CUBRID_SCH_SUPER_TABLE - Get the name and type of table which table inherites attributes - from. - - - PDO::CUBRID_SCH_SUB_TABLE - Get the name and type of table which inherites attributes from - this table. - - - PDO::CUBRID_SCH_CONSTRAINT - Get the table constraints. - - - PDO::CUBRID_SCH_TRIGGER - Get the table triggers. - - - PDO::CUBRID_SCH_TABLE_PRIVILEGE - Get the privilege information of table. - - - PDO::CUBRID_SCH_COL_PRIVILEGE - Get the privilege information of column. - - - PDO::CUBRID_SCH_DIRECT_SUPER_TABLE - Get the direct super table of table. - - - PDO::CUBRID_SCH_PRIMARY_KEY - Get the table primary key. - - - PDO::CUBRID_SCH_IMPORTED_KEYS - Get imported keys of table. - - - PDO::CUBRID_SCH_EXPORTED_KEYS - Get exported keys of table. - - - PDO::CUBRID_SCH_CROSS_REFERENCE - Get reference relationship of two tables. - - - -
    -
    -
    - - diff --git a/reference/pdo_cubrid/pdo_overloaded/cubrid-schema.xml b/reference/pdo_cubrid/pdo_overloaded/cubrid-schema.xml deleted file mode 100644 index b2339b268d30..000000000000 --- a/reference/pdo_cubrid/pdo_overloaded/cubrid-schema.xml +++ /dev/null @@ -1,545 +0,0 @@ - - - - - - PDO::cubrid_schema - Get the requested schema information - - - &reftitle.description; - - public arrayPDO::cubrid_schema - intschema_type - stringtable_name - stringcol_name - - - This function is used to get the requested schema information from - database. You have to designate table_name, if you - want to get information on certain table, col_name, - if you want to get information on certain column (can be used only with - PDO::CUBRID_SCH_COL_PRIVILEGE). - - - - The result of this function is returned as a two-dimensional array (column - (associative array) * row (numeric array)). The following tables shows types - of schema and the column structure of the result array to be returned based - on the schema type. - - - - Result Composition of Each Type - - - - Schema - Column Number - Column Name - Value - - - - - PDO::CUBRID_SCH_TABLE - 1 - NAME - - - - - 2 - TYPE - 0:system table 1:view 2:table - - - - PDO::CUBRID_SCH_VIEW - 1 - NAME - - - - - 2 - TYPE - 1:view - - - - PDO::CUBRID_SCH_QUERY_SPEC - 1 - QUERY_SPEC - - - - - PDO::CUBRID_SCH_ATTRIBUTE / PDO::CUBRID_SCH_TABLE_ATTRIBUTE - 1 - ATTR_NAME - - - - - 2 - DOMAIN - - - - - 3 - SCALE - - - - - 4 - PRECISION - - - - - 5 - INDEXED - 1:indexed - - - - 6 - NOT NULL - 1:not null - - - - 7 - SHARED - 1:shared - - - - 8 - UNIQUE - 1:unique - - - - 9 - DEFAULT - - - - - 10 - ATTR_ORDER - base:1 - - - - 11 - CLASS_NAME - - - - - 12 - SOURCE_CLASS - - - - - 13 - IS_KEY - 1:key - - - - PDO::CUBRID_SCH_METHOD / PDO::CUBRID_SCH_TABLE_METHOD - 1 - NAME - - - - - 2 - RET_DOMAIN - - - - - 3 - ARG_DOMAIN - - - - - PDO::CUBRID_SCH_METHOD_FILE - 1 - METHOD_FILE - - - - - PDO::CUBRID_SCH_SUPER_TABLE / PDO::CUBRID_SCH_DIRECT_SUPER_TABLE / PDO::CUBRID_SCH_SUB_TABLE - 1 - CLASS_NAME - - - - - 2 - TYPE - 0:system table 1:view 2:table - - - - PDO::CUBRID_SCH_CONSTRAINT - 1 - TYPE - 0:unique 1:index 2:reverse unique 3:reverse index - - - - 2 - NAME - - - - - 3 - ATTR_NAME - - - - - 4 - NUM_PAGES - - - - - 5 - NUM_KEYS - - - - - 6 - PRIMARY_KEY - 1:primary key - - - - 7 - KEY_ORDER - base:1 - - - - PDO::CUBRID_SCH_TRIGGER - 1 - NAME - - - - - 2 - STATUS - - - - - 3 - EVENT - - - - - 4 - TARGET_CLASS - - - - - 5 - TARGET_ATTR - - - - - 6 - ACTION_TIME - - - - - 7 - ACTION - - - - - 8 - PRIORITY - - - - - 9 - CONDITION_TIME - - - - - 10 - CONDITION - - - - - PDO::CUBRID_SCH_TABLE_PRIVILEGE / PDO::CUBRID_SCH_COL_PRIVILEGE - 1 - CLASS_NAME / ATTR_NAME - - - - - 2 - PRIVILEGE - - - - - 3 - GRANTABLE - - - - - PDO::CUBRID_SCH_PRIMARY_KEY - 1 - CLASS_NAME - - - - - 2 - ATTR_NAME - - - - - 3 - KEY_SEQ - base:1 - - - - 4 - KEY_NAME - - - - - PDO::CUBRID_SCH_IMPORTED_KEYS / PDO::CUBRID_SCH_EXPORTED_KEYS / PDO::CUBRID_SCH_CROSS_REFERENCE - 1 - PKTABLE_NAME - - - - - 2 - PKCOLUMN_NAME - - - - - 3 - FKTABLE_NAME - base:1 - - - - 4 - FKCOLUMN_NAME - - - - - 5 - KEY_SEQ - base:1 - - - - 6 - UPDATE_ACTION - 0:cascade 1:restrict 2:no action 3:set null - - - - 7 - DELETE_ACTION - 0:cascade 1:restrict 2:no action 3:set null - - - - 8 - FK_NAME - - - - - 9 - PK_NAME - - - - -
    - -
    - - &reftitle.parameters; - - - schema_type - - - Schema type that you want to know. - - - - - table_name - - - Table you want to know the schema of. - - - - - col_name - - - Column you want to know the schema of. - - - - - - - - &reftitle.returnvalues; - - Array containing the schema information, when process is successful; - - - FALSE, when process is unsuccessful - - - - - &reftitle.examples; - - A <function>PDO::cubrid_schema</function> example - - This example shows how to get primary key and foreign keys of table game. - - -cubrid_schema(PDO::CUBRID_SCH_PRIMARY_KEY, "game"); -print_r($pk_list); - -$fk_list = $dbh->cubrid_schema(PDO::CUBRID_SCH_IMPORTED_KEYS, "game"); -print_r($fk_list); -?> -]]> - - &example.outputs; - - Array - ( - [CLASS_NAME] => game - [ATTR_NAME] => athlete_code - [KEY_SEQ] => 3 - [KEY_NAME] => pk_game_host_year_event_code_athlete_code - ) - - [1] => Array - ( - [CLASS_NAME] => game - [ATTR_NAME] => event_code - [KEY_SEQ] => 2 - [KEY_NAME] => pk_game_host_year_event_code_athlete_code - ) - - [2] => Array - ( - [CLASS_NAME] => game - [ATTR_NAME] => host_year - [KEY_SEQ] => 1 - [KEY_NAME] => pk_game_host_year_event_code_athlete_code - ) - -) -Array -( - [0] => Array - ( - [PKTABLE_NAME] => athlete - [PKCOLUMN_NAME] => code - [FKTABLE_NAME] => game - [FKCOLUMN_NAME] => athlete_code - [KEY_SEQ] => 1 - [UPDATE_RULE] => 1 - [DELETE_RULE] => 1 - [FK_NAME] => fk_game_athlete_code - [PK_NAME] => pk_athlete_code - ) - - [1] => Array - ( - [PKTABLE_NAME] => event - [PKCOLUMN_NAME] => code - [FKTABLE_NAME] => game - [FKCOLUMN_NAME] => event_code - [KEY_SEQ] => 1 - [UPDATE_RULE] => 1 - [DELETE_RULE] => 1 - [FK_NAME] => fk_game_event_code - [PK_NAME] => pk_event_code - ) - -) -]]> - - - - -
    - diff --git a/reference/pdo_cubrid/reference.xml b/reference/pdo_cubrid/reference.xml deleted file mode 100644 index 4d69210fff5a..000000000000 --- a/reference/pdo_cubrid/reference.xml +++ /dev/null @@ -1,333 +0,0 @@ - - - CUBRID PDO Driver (PDO_CUBRID) - CUBRID PDO Driver - - -
    &reftitle.intro; - - PDO_CUBRID is a driver that implements the - PHP Data Objects (PDO) interface - to enable access from PHP to CUBRID databases. - - - Current version of PDO_CUBRID doesn't support persistent connection now. - -
    - - - &reference.pdo-cubrid.configure; - -
    - PDO_CUBRID Features - -
    - Scrollable cursors - - PDO_CUBRID supports scrollable cursors. The default cursor type is - forward only, and you can use parameter driver_options in - PDO::prepare to change cursor type. - -
    - -
    - Timeout - - PDO_CUBRID supports sql statement execution timeout setting; - You can use PDO::setAttribute to set timeout value. - -
    - -
    - Autocommit_mode and Transaction - - - PDO_CUBRID supports both autocommit_mode and transaction, and - autocommit_mode is enabled by default. You can use - PDO::setAttribute to change its state. - - - - If you use PDO::beginTransaction to begin a - transaction, it will disable autocommit_mode automatically and - restore it after PDO::commit or - PDO::rollBack. - - - - - Prior do disabling autocommit_mode - any pending work is automatically committed. - - -
    - -
    - Multiple SQL Statements - - - PDO_CUBRID supports Multiple SQL statements. - Multiple SQL statements are separated by semicolons (;). - -
    - -
    - Schema Information - - - PDO_CUBRID implements PDO::cubrid_schema - to get schema information. - -
    - -
    - LOBs - - - PDO_CUBRID supports BLOB/CLOB data type. The LOB in PDO is - represented as a stream, so you can insert LOBs by binding a stream, - and get LOBs by reading a stream returned by CUBRID PDO. - For example: - - - - Insert LOBs in CUBRID PDO - -prepare($sql_stmt); -$ret = $stmt->bindParam(1, $fp, PDO::PARAM_LOB); -$ret = $stmt->execute(); -?> -]]> - - - - - Fetch LOBs in CUBRID PDO - -prepare($sql_stmt); -$stmt->execute(); -$result = $stmt->fetch(PDO::FETCH_NUM); - -header("Content-Type: image/png"); -fpassthru($result[0]); -?> -]]> - - -
    - -
    - Column meta - - - The PDOStatement::getColumnMeta in CUBRID PDO - will return an associative array containing the following values: - - type - name - table - def - precision - scale - not_null - auto_increment - unique_key - multiple_key - primary_key - foreign_key - reverse_index - reverse_unique - - -
    - -
    - Collection Data Type - - - PDO_CUBRID supports SET/MULTISET/SEQUENCE data type. - If you don't specify data type, the default data type is char. - For example: - - - - Insert set in CUBRID PDO with default data type. - -exec("DROP TABLE if exists test_tbl"); -$cubrid_pdo->exec("CREATE TABLE test_tbl (col_1 SET(VARCHAR))"); - -$sql_stmt_insert = "INSERT INTO test_tbl VALUES (?);"; -$stmt = $cubrid_pdo->prepare($sql_stmt_insert); -$data = array("abc","def","ghi"); -$ret = $stmt->bindParam(1, $data, PDO::PARAM_NULL); -$ret = $stmt->execute(); -var_Dump($ret); -?> -]]> - - - - - Specify data type when insert set in CUBRID PDO - -exec("DROP TABLE if exists test_tbl"); -$cubrid_pdo->exec("CREATE TABLE test_tbl (col_1 SET(int))"); - -$sql_stmt_insert = "INSERT INTO test_tbl VALUES (?);"; -$stmt = $cubrid_pdo->prepare($sql_stmt_insert); -$data = array(1,2,3,4); -$ret = $stmt->bindParam(1, $data, 0,0,"int"); -$ret = $stmt->execute(); -var_Dump($ret); -?> -]]> - - - - - CUBRID Bind Data Types for the fifth parameter of - PDOStatement::bindParam: - - CHAR - STRING - NCHAR - VARNCHAR - BIT - VARBIT - NUMERIC - NUMBER - INT - SHORT - BIGINT - MONETARY - FLOAT - DOUBLE - DATE - TIME - DATETIME - TIMESTAMP - - -
    -
    - - - &reference.pdo-cubrid.constants; - -
    - - - - PDO_CUBRID DSN - Connecting to CUBRID databases - - - - &reftitle.description; - - The PDO_CUBRID Data Source Name (DSN) is composed of the following elements, delimited by semicolons: - - - DSN prefix - - - The DSN prefix is cubrid:. - - - - - host - - - The hostname on which the database server resides. - - - - - port - - - The port on which the database server is running. - - - - - dbname - - - The name of the database. - - - - - - - - - &reftitle.notes; - - - When you establish the connection to CUBRID, you should give username and - password except DSN. - - - - - - &reftitle.examples; - - PDO_CUBRID DSN examples - - The following example shows a PDO_CUBRID DSN for connecting to a CUBRID database: - - - - - - - - &reference.pdo-cubrid.entities.pdo-overloaded; - -
    - diff --git a/reference/pdo_ibm/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/pdo_ibm/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/pdo_ibm/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/pdo_ibm/configure.xml b/reference/pdo_ibm/configure.xml deleted file mode 100644 index 1f62f321d8ed..000000000000 --- a/reference/pdo_ibm/configure.xml +++ /dev/null @@ -1,57 +0,0 @@ - - -
    - &reftitle.install; - - To build the PDO_IBM extension, the DB2 Client v9.1 or later must be - installed on the same system as PHP. The DB2 Client can be downloaded - from the IBM Application Development - Site. - - - Note - - The DB2 Client v9.1 or later supports direct access to DB2 for Linux, - UNIX, and Windows v8 and v9.1 servers. - - - The DB2 Client v9.1 also supports access to DB2 UDB for i5 and DB2 UDB - for z/OS servers using the separately purchased DB2 - Connect product. - - - - PDO_IBM is a &link.pecl; extension, so follow the instructions in - to install the PDO_IBM extension. - Issue the configure command to point to the location of the - DB2 Client header files and libraries as follows: - - - - The configure command defaults to the value of the - DB2DIR environment variable. - -
    - - diff --git a/reference/pdo_ibm/ini.xml b/reference/pdo_ibm/ini.xml deleted file mode 100644 index f036a85b1510..000000000000 --- a/reference/pdo_ibm/ini.xml +++ /dev/null @@ -1,109 +0,0 @@ - - -
    - &reftitle.runtime; - &extension.runtime; - - - PDO_IBM Configuration Options - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - pdo_ibm.i5_dbcs_alloc - "0" - INI_SYSTEM - Added in PDO_IBM 1.5.0 - - - pdo_ibm.i5_override_ccsid - "0" - INI_SYSTEM - Added in PDO_IBM 1.5.0 - - - -
    - &ini.php.constants; -
    - -&ini.descriptions.title; - - - - - - pdo_ibm.i5_dbcs_alloc - int - - - - This options affects the internal buffer allocation strategy on IBM i. - By default, this option is 0. When this option is set, buffers are - allocated with a much larger size, in case the database is misleading - about character size when converting between encodings. This option uses - six times as much memory for buffers (to account for the largest possible - UTF-8 sequences), but may be needed if truncated data is returned. - - - - 0 - Minimum size buffers are allocated. - - - - - 1 - Larger size buffers are allocated. - - - - - - - - - pdo_ibm.i5_override_ccsid - int - - - - The ASCII CCSID to use for conversion from EBCDIC on IBM i. Setting this - to 1208 will use UTF-8. By default, this is 0, which will select the - default ASCII job CCSID. - - - To learn more about CCSIDs on IBM i, consult the - IBM documentation. - - - - - -
    - - diff --git a/reference/pdo_ibm/reference.xml b/reference/pdo_ibm/reference.xml deleted file mode 100644 index 1e34f476f67b..000000000000 --- a/reference/pdo_ibm/reference.xml +++ /dev/null @@ -1,176 +0,0 @@ - - - - IBM PDO Driver (PDO_IBM) - IBM PDO Driver - - -
    - &reftitle.intro; - - PDO_IBM is a driver that implements the PHP Data - Objects (PDO) interface to enable access from PHP to IBM databases. - -
    - - - &reference.pdo-ibm.configure; - - &reference.pdo-ibm.ini; - -
    - - - - PDO_IBM DSN - Connecting to IBM databases - - - - &reftitle.description; - - The PDO_IBM Data Source Name (DSN) is based on the IBM CLI DSN. The major - components of the PDO_IBM DSN are: - - - DSN prefix - - - The DSN prefix is ibm:. - - - - - DSN - - - The DSN can be any of the following: - - - - a) Data source setup using db2cli.ini - or odbc.ini - - - - - b) Catalogued database name i.e. database alias in the DB2 client - catalog - - - - - c) Complete connection string in the following format: - DRIVER={IBM DB2 ODBC DRIVER};DATABASE=database;HOSTNAME=hostname;PORT=port;PROTOCOL=TCPIP;UID=username;PWD=password; - where the parameters represent the following values: - - - database - - - The name of the database. - - - - - hostname - - - The hostname or IP address of the database server. - - - - - port - - - The TCP/IP port on which the database is listening for - requests. - - - - - username - - - The username with which you are connecting to the - database. - - - - - password - - - The password with which you are connecting to the database. - - - - - - - - - - - - - - - &reftitle.examples; - - - PDO_IBM DSN example using <filename>db2cli.ini</filename> - - The following example shows a PDO_IBM DSN for connecting to an DB2 - database cataloged as DB2_9 in db2cli.ini: - - - - - PDO_IBM DSN example using a connection string - - The following example shows a PDO_IBM DSN for connecting to an DB2 - database named testdb using the DB2 CLI - connection string syntax. - - - - - - - - - -
    - diff --git a/reference/pdo_informix/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/pdo_informix/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/pdo_informix/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/pdo_informix/configure.xml b/reference/pdo_informix/configure.xml deleted file mode 100644 index 0137a6d14ab2..000000000000 --- a/reference/pdo_informix/configure.xml +++ /dev/null @@ -1,45 +0,0 @@ - - -
    - &reftitle.install; - - To build the PDO_INFORMIX extension, the Informix Client SDK 2.81 UC1 or - higher must be installed on the same system as PHP. The Informix Client - SDK is available from the IBM Informix - Support Site. - - - PDO_INFORMIX is a &link.pecl; extension, so follow the instructions in - to install the PDO_INFORMIX extension. - Issue the configure command to point to the location of the - Informix Client SDK header files and libraries as follows: - - - - The configure command defaults to the value of the - INFORMIXDIR environment variable. - -
    - - diff --git a/reference/pdo_informix/reference.xml b/reference/pdo_informix/reference.xml deleted file mode 100644 index d9c934adc4ad..000000000000 --- a/reference/pdo_informix/reference.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - Informix PDO Driver (PDO_INFORMIX) - Informix PDO Driver - - -
    - &reftitle.intro; - - PDO_INFORMIX is a driver that implements the PHP Data - Objects (PDO) interface to enable access from PHP to Informix databases. - -
    - - - &reference.pdo-informix.configure; - -
    - Scrollable cursors - - PDO_INFORMIX supports scrollable cursors; however, they are not enabled - by default. To enable scrollable cursor support, you must either set - ENABLESCROLLABLECURSORS=1 in the corresponding ODBC - connection settings in odbc.ini or pass - the EnableScrollableCursors=1 clause in the DSN - connection string. - -
    - -
    - - - - PDO_INFORMIX DSN - Connecting to Informix databases - - - - &reftitle.description; - - The PDO_INFORMIX Data Source Name (DSN) is based on the Informix ODBC DSN - string. Details on configuring an Informix ODBC DSN are available from - the Informix Dynamic Server Information - Center. The major components of the PDO_INFORMIX DSN are: - - - DSN prefix - - - The DSN prefix is informix:. - - - - - DSN - - - The DSN can be either a data source setup using - odbc.ini or a complete connection string. - - - - - - - - &reftitle.examples; - - - PDO_INFORMIX DSN example using <filename>odbc.ini</filename> - - The following example shows a PDO_INFORMIX DSN for connecting to - an Informix database cataloged as Infdrv33 in - odbc.ini: - - - - - - PDO_INFORMIX DSN example using a connection string - - The following example shows a PDO_INFORMIX DSN for connecting to - an Informix database named common_db using the - Informix connection string syntax. - - - - - - - - - -
    - diff --git a/reference/pdo_mysql/reference.xml b/reference/pdo_mysql/reference.xml index 7f6835effa52..e562eb166f51 100644 --- a/reference/pdo_mysql/reference.xml +++ b/reference/pdo_mysql/reference.xml @@ -1,7 +1,7 @@ - + MySQL PDO Driver (PDO_MYSQL) MySQL PDO Driver @@ -29,15 +29,15 @@ The server requested authentication method unknown to the client [caching_sha2_password] even when caching_sha2_password is not used. - + This is because MySQL 8 defaults to caching_sha2_password, a plugin that is not recognized by the older PHP (mysqlnd) releases. Instead, change it by setting default_authentication_plugin=mysql_native_password in my.cnf. The caching_sha2_password plugin is fully supported as of PHP 7.4.4. For older releases, the - mysql_xdevapi extension does + mysql_xdevapi extension does support it. - + diff --git a/reference/pdo_sqlsrv/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/pdo_sqlsrv/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/pdo_sqlsrv/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/pdo_sqlsrv/configure.xml b/reference/pdo_sqlsrv/configure.xml deleted file mode 100644 index 7a2cbbaa30bb..000000000000 --- a/reference/pdo_sqlsrv/configure.xml +++ /dev/null @@ -1,45 +0,0 @@ - - -
    - &reftitle.install; - - The most recent version of the driver is available for download here: - SQLSRV download. - The driver sources are hosted in a public repository. - - - For more information about system requirements, see - SQLSRV System Requirements. - - - On Windows the PDO_SQLSRV extension is enabled by downloading and adding - appropriate DLL files to the PHP extension directory and the corresponding - entry to the &php.ini; file. - - - On Linux and macOS, the PDO_SQLSRV extension can be installed using - &link.pecl;. - See the installation tutorial - for details. - -
    - diff --git a/reference/pdo_sqlsrv/constants.xml b/reference/pdo_sqlsrv/constants.xml deleted file mode 100644 index 8258a7db19b2..000000000000 --- a/reference/pdo_sqlsrv/constants.xml +++ /dev/null @@ -1,179 +0,0 @@ - - -
    - &reftitle.constants; - &pdo.driver-constants; - - - - PDO::SQLSRV_TXN_READ_UNCOMMITTED - (int) - - - - This constant is an acceptable value for the SQLSRV DSN key TransactionIsolation. - This constant sets the transaction isolation level for the connection to - Read Uncommitted. - - - - - - PDO::SQLSRV_TXN_READ_COMMITTED - (int) - - - - This constant is an acceptable value for the SQLSRV DSN key TransactionIsolation. - This constant sets the transaction isolation level for the connection to - Read Committed. - - - - - - PDO::SQLSRV_TXN_REPEATABLE_READ - (int) - - - - This constant is an acceptable value for the SQLSRV DSN key TransactionIsolation. - This constant sets the transaction isolation level for the connection to - Repeateable Read. - - - - - - PDO::SQLSRV_TXN_SNAPSHOT - (int) - - - - This constant is an acceptable value for the SQLSRV DSN key TransactionIsolation. - This constant sets the transaction isolation level for the connection to Snapshot. - - - - - - PDO::SQLSRV_TXN_SERIALIZABLE - (int) - - - - This constant is an acceptable value for the SQLSRV DSN key TransactionIsolation. - This constant sets the transaction isolation level for the connection to - Serializable. - - - - - - PDO::SQLSRV_ENCODING_BINARY - (int) - - - - Specifies that data is sent/retrieved as a raw byte stream to/from the server - without performing encoding or translation. This constant can be passed to - PDOStatement::setAttribute, PDO::prepare, PDOStatement::bindColumn, and - PDOStatement::bindParam. - - - - - - PDO::SQLSRV_ENCODING_SYSTEM - (int) - - - - Specifies that data is sent/retrieved to/from the server as 8-bit characters - as specified in the code page of the Windows locale that is set on the system. - Any multi-byte characters or characters that do not map into this code page - are substituted with a single byte question mark (?) character. This constant - can be passed to PDOStatement::setAttribute, PDO::setAttribute, PDO::prepare, - PDOStatement::bindColumn, and PDOStatement::bindParam. - - - - - - PDO::SQLSRV_ENCODING_UTF8 - (int) - - - - Specifies that data is sent/retrieved to/from the server in UTF-8 encoding. - This is the default encoding. This constant can be passed to - PDOStatement::setAttribute, PDO::setAttribute, PDO::prepare, - PDOStatement::bindColumn, and PDOStatement::bindParam. - - - - - - PDO::SQLSRV_ENCODING_DEFAULT - (int) - - - - Specifies that data is sent/retrieved to/from the server according to - PDO::SQLSRV_ENCODING_SYSTEM if specified during connection. The connection's - encoding is used if specified in a prepare statement. This constant can be - passed to PDOStatement::setAttribute, PDO::setAttribute, PDO::prepare, - PDOStatement::bindColumn, and PDOStatement::bindParam. - - - - - - PDO::SQLSRV_ATTR_QUERY_TIMEOUT - (int) - - - - A non-negative integer representing the timeout period, in seconds. Zero (0) - is the default and means no timeout. This constant can be passed to - PDOStatement::setAttribute, PDO::setAttribute, and PDO::prepare. - - - - - - PDO::SQLSRV_ATTR_DIRECT_QUERY - (int) - - - - Indicates that a query should be executed directly, without being prepared. - This constant can be passed to PDO::setAttribute, and PDO::prepare. For more - information, see - Direct and Prepared Statement Execution. - - - - -
    - - diff --git a/reference/pdo_sqlsrv/reference.xml b/reference/pdo_sqlsrv/reference.xml deleted file mode 100644 index 8519db3ef16e..000000000000 --- a/reference/pdo_sqlsrv/reference.xml +++ /dev/null @@ -1,220 +0,0 @@ - - - - Microsoft SQL Server PDO Driver (PDO_SQLSRV) - MS SQL Server PDO Driver - - -
    - &reftitle.intro; - - PDO_SQLSRV is a driver that implements the PHP - Data Objects (PDO) interface - to enable access from PHP to MS SQL Server (starting with SQL Server 2005) - and SQL Azure databases. - -
    - &reference.pdo-sqlsrv.configure; - &reference.pdo-sqlsrv.constants; -
    - - - - PDO_SQLSRV DSN - Connecting to MS SQL Server and SQL Azure databases - - - - &reftitle.description; - - The PDO_SQLSRV Data Source Name (DSN) is composed of the following elements: - - - DSN prefix - - - The DSN prefix is sqlsrv:. - - - - - APP - - - The application name used in tracing. - - - - - ConnectionPooling - - - Specifies whether the connection is assigned from a connection pool - (1 or &true;) or not (0 or &false;). - - - - - Database - - - The name of the database. - - - - - Encrypt - - - Specifies whether the communication with SQL Server is encrypted - (1 or &true;) or unencrypted (0 or &false;). - - - - - Failover_Partner - - - Specifies the server and instance of the database's mirror (if enabled - and configured) to use when the primary server is unavailable. - - - - - LoginTimeout - - - Specifies the number of seconds to wait before failing the connection attempt. - - - - - MultipleActiveResultSets - - - Disables or explicitly enables support for multiple active Result sets (MARS). - - - - - QuotedId - - - Specifies whether to use SQL-92 rules for quoted identifiers (1 or &true;) - or to use legacy Transact-SQL rules (0 or &false;). - - - - - Server - - - The name of the database server. - - - - - TraceFile - - - Specifies the path for the file used for trace data. - - - - - TraceOn - - - Specifies whether ODBC tracing is enabled (1 or &true;) or disabled - (0 or &false;) for the connection being established. - - - - - TransactionIsolation - - - Specifies the transaction isolation level. The accepted values for this - option are PDO::SQLSRV_TXN_READ_UNCOMMITTED, PDO::SQLSRV_TXN_READ_COMMITTED, - PDO::SQLSRV_TXN_REPEATABLE_READ, PDO::SQLSRV_TXN_SNAPSHOT, and - PDO::SQLSRV_TXN_SERIALIZABLE. - - - - - TrustServerCertificate - - - Specifies whether the client should trust (1 or &true;) or reject - (0 or &false;) a self-signed server certificate. - - - - - WSID - - - Specifies the name of the computer for tracing. - - - - - - - - - &reftitle.examples; - - PDO_SQLSRV DSN examples - - The following example shows how to connect to a specified MS SQL Server database: - - - - - - The following example shows how to connect to a MS SQL Server database on - a specified port: - - - - - - The following example shows how to connect to a SQL Azure database with - server ID 12345abcde. Note that when you connect to SQL Azure with PDO, - your username will be UserName@12345abcde (UserName@ServerId). - - - - - - - - -
    - diff --git a/reference/ps/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/ps/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/ps/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/ps/book.xml b/reference/ps/book.xml deleted file mode 100644 index ae6d2cba9413..000000000000 --- a/reference/ps/book.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - PostScript document creation - PS - - - - &reftitle.intro; - - This module allows to create PostScript documents. It has many - similarities with the pdf extension. Actually the API is almost - identical and one can in many cases just replace the prefix of - each function from pdf_ to ps_. This also works for functions which - has no meaning in the PostScript document (like adding hyperlinks) - but will have an effect if the document is converted to PDF. - - Documents created by this extension are sometimes even superior - to documents created with the pdf extension, because pslib's text - rendering functions can handle kerning, hyphenation and ligatures - which results in much better output of boxed text. - - - - - &reference.ps.setup; - &reference.ps.constants; - &reference.ps.reference; - - - - - diff --git a/reference/ps/configure.xml b/reference/ps/configure.xml deleted file mode 100644 index 63b384c73267..000000000000 --- a/reference/ps/configure.xml +++ /dev/null @@ -1,31 +0,0 @@ - - -
    - &reftitle.install; - - &pecl.info; - &url.pecl.package;ps. - -
    - - - diff --git a/reference/ps/constants.xml b/reference/ps/constants.xml deleted file mode 100644 index d695ec10e6f3..000000000000 --- a/reference/ps/constants.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - &reftitle.constants; - &extension.constants; - - The following two tables lists all constants defined by the ps extension. - - Constants for line caps - - - - Name - Meaning - - - - - ps_LINECAP_BUTT - - - - ps_LINECAP_ROUND - - - - ps_LINECAP_SQUARED - - - - -
    - - - Constants for line joins - - - - Name - Meaning - - - - - ps_LINEJOIN_MITER - - - - ps_LINEJOIN_ROUND - - - - ps_LINEJOIN_BEVEL - - - - -
    -
    -
    - - diff --git a/reference/ps/functions/ps-add-bookmark.xml b/reference/ps/functions/ps-add-bookmark.xml deleted file mode 100644 index 8ef8002e22a1..000000000000 --- a/reference/ps/functions/ps-add-bookmark.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - ps_add_bookmark - Add bookmark to current page - - - - &reftitle.description; - - intps_add_bookmark - resourcepsdoc - stringtext - intparent0 - intopen0 - - - Adds a bookmark for the current page. Bookmarks usually appear in - PDF-Viewers left of the page in a hierarchical tree. Clicking on a - bookmark will jump to the given page. - - &ps.note.visible; - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - text - - - The text used for displaying the bookmark. - - - - - parent - - - A bookmark previously created by this function which - is used as the parent of the new bookmark. - - - - - open - - - If open is unequal to zero the bookmark will - be shown open by the pdf viewer. - - - - - - - - - &reftitle.returnvalues; - - The returned value is a reference for the bookmark. It is only used if - the bookmark shall be used as a parent. The value is greater zero if - the function succeeds. In case of an error zero will - be returned. - - - - - &reftitle.seealso; - - - ps_add_launchlink - ps_add_pdflink - ps_add_weblink - - - - - - - diff --git a/reference/ps/functions/ps-add-launchlink.xml b/reference/ps/functions/ps-add-launchlink.xml deleted file mode 100644 index ff860b67f92a..000000000000 --- a/reference/ps/functions/ps-add-launchlink.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - ps_add_launchlink - Adds link which launches file - - - - &reftitle.description; - - boolps_add_launchlink - resourcepsdoc - floatllx - floatlly - floaturx - floatury - stringfilename - - - Places a hyperlink at the given position pointing to a file program - which is being started when clicked on. The hyperlink's source position - is a rectangle - with its lower left corner at (llx, lly) and its upper right corner at - (urx, ury). The rectangle has by default a thin blue border. - - &ps.note.visible; - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - llx - - - The x-coordinate of the lower left corner. - - - - - lly - - - The y-coordinate of the lower left corner. - - - - - urx - - - The x-coordinate of the upper right corner. - - - - - ury - - - The y-coordinate of the upper right corner. - - - - - filename - - - The path of the program to be started, when the link is clicked on. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_add_locallink - ps_add_pdflink - ps_add_weblink - - - - - - - diff --git a/reference/ps/functions/ps-add-locallink.xml b/reference/ps/functions/ps-add-locallink.xml deleted file mode 100644 index 99ca817bd315..000000000000 --- a/reference/ps/functions/ps-add-locallink.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - ps_add_locallink - Adds link to a page in the same document - - - - &reftitle.description; - - boolps_add_locallink - resourcepsdoc - floatllx - floatlly - floaturx - floatury - intpage - stringdest - - - Places a hyperlink at the given position pointing to a page in the same - document. Clicking on the link will jump to the given page. The first page - in a document has number 1. - - - The hyperlink's source position is a rectangle with its lower left corner at - (llx, lly) and its upper - right corner at (urx, ury). - The rectangle has by default a thin blue border. - - &ps.note.visible; - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - llx - - - The x-coordinate of the lower left corner. - - - - - lly - - - The y-coordinate of the lower left corner. - - - - - urx - - - The x-coordinate of the upper right corner. - - - - - ury - - - The y-coordinate of the upper right corner. - - - - - page - - - The number of the page displayed when clicking on the link. - - - - - dest - - - The parameter dest determines how the document - is being viewed. It can be fitpage, - fitwidth, fitheight, or - fitbbox. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_add_launchlink - ps_add_pdflink - ps_add_weblink - - - - - - - diff --git a/reference/ps/functions/ps-add-note.xml b/reference/ps/functions/ps-add-note.xml deleted file mode 100644 index 36d345428afd..000000000000 --- a/reference/ps/functions/ps-add-note.xml +++ /dev/null @@ -1,160 +0,0 @@ - - - - - - ps_add_note - Adds note to current page - - - - &reftitle.description; - - boolps_add_note - resourcepsdoc - floatllx - floatlly - floaturx - floatury - stringcontents - stringtitle - stringicon - intopen - - - Adds a note at a certain position on the page. Notes are like little - rectangular sheets with text on it, which can be placed anywhere on - a page. They - are shown either folded or unfolded. If folded, the specified icon - is used as a placeholder. - - &ps.note.visible; - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - llx - - - The x-coordinate of the lower left corner. - - - - - lly - - - The y-coordinate of the lower left corner. - - - - - urx - - - The x-coordinate of the upper right corner. - - - - - ury - - - The y-coordinate of the upper right corner. - - - - - contents - - - The text of the note. - - - - - title - - - The title of the note as displayed in the header of the note. - - - - - icon - - - The icon shown if the note is folded. This parameter can be set - to comment, insert, - note, paragraph, - newparagraph, key, or - help. - - - - - open - - - If open is unequal to zero the note will - be shown unfolded after opening the document with a pdf viewer. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_add_pdflink - ps_add_launchlink - ps_add_locallink - ps_add_weblink - - - - - - - diff --git a/reference/ps/functions/ps-add-pdflink.xml b/reference/ps/functions/ps-add-pdflink.xml deleted file mode 100644 index c5243bf37a5c..000000000000 --- a/reference/ps/functions/ps-add-pdflink.xml +++ /dev/null @@ -1,153 +0,0 @@ - - - - - - ps_add_pdflink - Adds link to a page in a second pdf document - - - - &reftitle.description; - - boolps_add_pdflink - resourcepsdoc - floatllx - floatlly - floaturx - floatury - stringfilename - intpage - stringdest - - - Places a hyperlink at the given position pointing to a second pdf document. - Clicking on the link will branch to the document at the given page. The - first page in a document has number 1. - - - The hyperlink's source position is a rectangle with its lower left corner at - (llx, lly) and its upper - right corner at (urx, ury). - The rectangle has by default a thin blue border. - - &ps.note.visible; - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - llx - - - The x-coordinate of the lower left corner. - - - - - lly - - - The y-coordinate of the lower left corner. - - - - - urx - - - The x-coordinate of the upper right corner. - - - - - ury - - - The y-coordinate of the upper right corner. - - - - - filename - - - The name of the pdf document to be opened when clicking on - this link. - - - - - page - - - The page number of the destination pdf document - - - - - dest - - - The parameter dest determines how the document - is being viewed. It can be fitpage, - fitwidth, fitheight, or - fitbbox. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_add_launchlink - ps_add_locallink - ps_add_weblink - - - - - - - diff --git a/reference/ps/functions/ps-add-weblink.xml b/reference/ps/functions/ps-add-weblink.xml deleted file mode 100644 index 16078990f7ba..000000000000 --- a/reference/ps/functions/ps-add-weblink.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - ps_add_weblink - Adds link to a web location - - - - &reftitle.description; - - boolps_add_weblink - resourcepsdoc - floatllx - floatlly - floaturx - floatury - stringurl - - - Places a hyperlink at the given position pointing to a web page. The - hyperlink's source position is a rectangle with its lower left corner at - (llx, lly) and - its upper right corner at (urx, - ury). The rectangle has by default a thin - blue border. - - &ps.note.visible; - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - llx - - - The x-coordinate of the lower left corner. - - - - - lly - - - The y-coordinate of the lower left corner. - - - - - urx - - - The x-coordinate of the upper right corner. - - - - - ury - - - The y-coordinate of the upper right corner. - - - - - url - - - The url of the hyperlink to be opened when clicking on - this link, e.g. http://www.php.net. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_add_launchlink - ps_add_locallink - ps_add_pdflink - - - - - - - diff --git a/reference/ps/functions/ps-arc.xml b/reference/ps/functions/ps-arc.xml deleted file mode 100644 index 0d0bc013af1e..000000000000 --- a/reference/ps/functions/ps-arc.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - ps_arc - Draws an arc counterclockwise - - - - &reftitle.description; - - boolps_arc - resourcepsdoc - floatx - floaty - floatradius - floatalpha - floatbeta - - - Draws a portion of a circle with at middle point at - (x, y). The arc starts at an - angle of alpha and ends at an angle of - beta. It is drawn counterclockwise (use - ps_arcn to draw clockwise). The subpath added - to the current path starts on the arc at angle alpha - and ends on the arc at angle beta. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - x - - - The x-coordinate of the circle's middle point. - - - - - y - - - The y-coordinate of the circle's middle point. - - - - - radius - - - The radius of the circle - - - - - alpha - - - The start angle given in degrees. - - - - - beta - - - The end angle given in degrees. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_arcn - - - - - - - diff --git a/reference/ps/functions/ps-arcn.xml b/reference/ps/functions/ps-arcn.xml deleted file mode 100644 index 0a6e8346713f..000000000000 --- a/reference/ps/functions/ps-arcn.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - ps_arcn - Draws an arc clockwise - - - - &reftitle.description; - - boolps_arcn - resourcepsdoc - floatx - floaty - floatradius - floatalpha - floatbeta - - - Draws a portion of a circle with at middle point at - (x, y). The arc starts at an - angle of alpha and ends at an angle of - beta. It is drawn clockwise (use - ps_arc to draw counterclockwise). The subpath added to - the current path starts on the arc at angle beta and - ends on the arc at angle alpha. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - x - - - The x-coordinate of the circle's middle point. - - - - - y - - - The y-coordinate of the circle's middle point. - - - - - radius - - - The radius of the circle - - - - - alpha - - - The starting angle given in degrees. - - - - - beta - - - The end angle given in degrees. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_arc - - - - - - - diff --git a/reference/ps/functions/ps-begin-page.xml b/reference/ps/functions/ps-begin-page.xml deleted file mode 100644 index 084c18edf18d..000000000000 --- a/reference/ps/functions/ps-begin-page.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - - ps_begin_page - Start a new page - - - - &reftitle.description; - - boolps_begin_page - resourcepsdoc - floatwidth - floatheight - - - Starts a new page. Although the parameters width - and height imply a different page size for each - page, this is not possible in PostScript. The first call of - ps_begin_page will set the page size for the whole - document. Consecutive calls will have no effect, except for creating a new - page. The situation is different if you intent to convert the PostScript - document into PDF. This function places pdfmarks into the document which - can set the size for each page indiviually. The resulting PDF document will - have different page sizes. - - - Though PostScript does not know different page sizes, pslib places - a bounding box for each page into the document. This size is evaluated - by some PostScript viewers and will have precedence over the BoundingBox - in the Header of the document. This can lead to unexpected results when - you set a BoundingBox whose lower left corner is not (0, 0), because the - bounding box of the page will always have a lower left corner (0, 0) - and overwrites the global setting. - - - Each page is encapsulated into save/restore. This means, that most of the - settings made on one page will not be retained on the next page. - - - If there is up to the first call of ps_begin_page no - call of ps_findfont, then the header of the PostScript - document will be output and the bounding box will be set to the size of - the first page. The lower left corner of the bounding box is set to (0, 0). - If ps_findfont was called before, then the - header has been output already, and the document will not have a valid - bounding box. In order to prevent this, one should call - ps_set_info to set the info field - BoundingBox and possibly Orientation - before any ps_findfont or - ps_begin_page calls. - - - - Up to version 0.2.6 of pslib, this function will always overwrite - the BoundingBox and Orientation, if it has been set before with - ps_set_info and ps_findfont - has not been called before. - - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - width - - - The width of the page in pixel, e.g. 596 for A4 format. - - - - - height - - - The height of the page in pixel, e.g. 842 for A4 format. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_end_page - ps_findfont - ps_set_info - - - - - - - diff --git a/reference/ps/functions/ps-begin-pattern.xml b/reference/ps/functions/ps-begin-pattern.xml deleted file mode 100644 index fe9c63352243..000000000000 --- a/reference/ps/functions/ps-begin-pattern.xml +++ /dev/null @@ -1,174 +0,0 @@ - - - - - - ps_begin_pattern - Start a new pattern - - - - &reftitle.description; - - intfalseps_begin_pattern - resourcepsdoc - floatwidth - floatheight - floatxstep - floatystep - intpainttype - - - Starts a new pattern. A pattern is like a page containing e.g. a drawing - which can be used for filling areas. It is used like a color by calling - ps_setcolor and setting the color space to - pattern. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - width - - - The width of the pattern in pixel. - - - - - height - - - The height of the pattern in pixel. - - - - - xstep - - - The distance in pixel of placements of the pattern in - horizontal direction. - - - - - ystep - - - The distance in pixel of placements of the pattern in - vertical direction. - - - - - painttype - - - Must be 1 or 2. - - - - - - - - - &reftitle.returnvalues; - - The identifier of the pattern &return.falseforfailure;. - - - - - &reftitle.examples; - - - Creating and using a pattern - - -]]> - - - - - - - &reftitle.seealso; - - - ps_end_pattern - ps_setcolor - ps_shading_pattern - - - - - - - diff --git a/reference/ps/functions/ps-begin-template.xml b/reference/ps/functions/ps-begin-template.xml deleted file mode 100644 index b131a6767321..000000000000 --- a/reference/ps/functions/ps-begin-template.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - ps_begin_template - Start a new template - - - - &reftitle.description; - - intps_begin_template - resourcepsdoc - floatwidth - floatheight - - - Starts a new template. A template is called a form in the postscript - language. It is created similar to a pattern but used like an image. - Templates are often used for drawings which are placed several times - through out the document, e.g. like a company logo. All drawing functions - may be used within a template. The template will not be drawn until - it is placed by ps_place_image. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - width - - - The width of the template in pixel. - - - - - height - - - The height of the template in pixel. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Creating and using a template - - -]]> - - - - - - - &reftitle.seealso; - - - ps_end_template - - - - - - - diff --git a/reference/ps/functions/ps-circle.xml b/reference/ps/functions/ps-circle.xml deleted file mode 100644 index 530ba9a240a2..000000000000 --- a/reference/ps/functions/ps-circle.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - ps_circle - Draws a circle - - - - &reftitle.description; - - boolps_circle - resourcepsdoc - floatx - floaty - floatradius - - - Draws a circle with its middle point at (x, - y). The circle starts and ends at position - (x+radius, - y). If this function is called outside a path it - will start a new path. If it is called within a path it will add the circle - as a subpath. If the last drawing operation does not end in point - (x+radius, - y) then there will be a gap in the path. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - x - - - The x-coordinate of the circle's middle point. - - - - - y - - - The y-coordinate of the circle's middle point. - - - - - radius - - - The radius of the circle - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_arc - ps_arcn - - - - - - - diff --git a/reference/ps/functions/ps-clip.xml b/reference/ps/functions/ps-clip.xml deleted file mode 100644 index 5d293e96db11..000000000000 --- a/reference/ps/functions/ps-clip.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - ps_clip - Clips drawing to current path - - - - &reftitle.description; - - boolps_clip - resourcepsdoc - - - Takes the current path and uses it to define the border of a clipping area. - Everything drawn outside of that area will not be visible. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_closepath - - - - - - - diff --git a/reference/ps/functions/ps-close-image.xml b/reference/ps/functions/ps-close-image.xml deleted file mode 100644 index 608452b68383..000000000000 --- a/reference/ps/functions/ps-close-image.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - ps_close_image - Closes image and frees memory - - - - &reftitle.description; - - voidfalseps_close_image - resourcepsdoc - intimageid - - - Closes an image and frees its resources. Once an image is closed - it cannot be used anymore. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - imageid - - - Resource identifier of the image as returned by - ps_open_image or - ps_open_image_file. - - - - - - - - - &reftitle.returnvalues; - - Returns &null; on success&return.falseforfailure;. - - - - - &reftitle.seealso; - - - ps_open_image - ps_open_image_file - - - - - - - diff --git a/reference/ps/functions/ps-close.xml b/reference/ps/functions/ps-close.xml deleted file mode 100644 index b9d02100786c..000000000000 --- a/reference/ps/functions/ps-close.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - ps_close - Closes a PostScript document - - - - &reftitle.description; - - boolps_close - resourcepsdoc - - - Closes the PostScript document. - - - This function writes the trailer of the PostScript document. - It also writes the bookmark tree. ps_close does - not free any resources, which is done by ps_delete. - - - This function is also called by ps_delete if it - has not been called before. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_open_file - ps_delete - - - - - - - diff --git a/reference/ps/functions/ps-closepath-stroke.xml b/reference/ps/functions/ps-closepath-stroke.xml deleted file mode 100644 index 19d9c632222e..000000000000 --- a/reference/ps/functions/ps-closepath-stroke.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - ps_closepath_stroke - Closes and strokes path - - - - &reftitle.description; - - boolps_closepath_stroke - resourcepsdoc - - - Connects the last point with first point of a path and draws the resulting - closed line. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_closepath - - - - - - - diff --git a/reference/ps/functions/ps-closepath.xml b/reference/ps/functions/ps-closepath.xml deleted file mode 100644 index b3638daa344b..000000000000 --- a/reference/ps/functions/ps-closepath.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - ps_closepath - Closes path - - - - &reftitle.description; - - boolps_closepath - resourcepsdoc - - - Connects the last point with the first point of a path. The resulting - path can be used for stroking, filling, clipping, etc.. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_clip - ps_closepath_stroke - - - - - - - diff --git a/reference/ps/functions/ps-continue-text.xml b/reference/ps/functions/ps-continue-text.xml deleted file mode 100644 index 2bf1aded0d62..000000000000 --- a/reference/ps/functions/ps-continue-text.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - ps_continue_text - Continue text in next line - - - - &reftitle.description; - - boolps_continue_text - resourcepsdoc - stringtext - - - Output a text one line below the last line. The line spacing is - taken from the value "leading" which must be set with - ps_set_value. The actual position of the - text is determined by the values "textx" and "texty" which can be requested - with ps_get_value - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - text - - - The text to output. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_show - ps_show_xy - ps_show_boxed - - - - - - - diff --git a/reference/ps/functions/ps-curveto.xml b/reference/ps/functions/ps-curveto.xml deleted file mode 100644 index 453127f2702e..000000000000 --- a/reference/ps/functions/ps-curveto.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - ps_curveto - Draws a curve - - - - &reftitle.description; - - boolps_curveto - resourcepsdoc - floatx1 - floaty1 - floatx2 - floaty2 - floatx3 - floaty3 - - - Add a section of a cubic Bézier curve described by the three given control - points to the current path. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - x1 - - - x-coordinate of first control point. - - - - - y1 - - - y-coordinate of first control point. - - - - - x2 - - - x-coordinate of second control point. - - - - - y2 - - - y-coordinate of second control point. - - - - - x3 - - - x-coordinate of third control point. - - - - - y3 - - - y-coordinate of third control point. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_lineto - - - - - - - diff --git a/reference/ps/functions/ps-delete.xml b/reference/ps/functions/ps-delete.xml deleted file mode 100644 index 40ec9eefcd74..000000000000 --- a/reference/ps/functions/ps-delete.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - ps_delete - Deletes all resources of a PostScript document - - - - &reftitle.description; - - boolps_delete - resourcepsdoc - - - Mainly frees memory used by the document. Also closes a file, if it was not - closed before with ps_close. You should in any case - close the file with ps_close before, because - ps_close not just closes the file but also outputs a - trailor containing PostScript comments like the number of pages in the - document and adding the bookmark hierarchy. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_close - - - - - - - diff --git a/reference/ps/functions/ps-end-page.xml b/reference/ps/functions/ps-end-page.xml deleted file mode 100644 index 496fc9dc6e4c..000000000000 --- a/reference/ps/functions/ps-end-page.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - ps_end_page - End a page - - - - &reftitle.description; - - boolps_end_page - resourcepsdoc - - - Ends a page which was started with ps_begin_page. - Ending a page will leave the current drawing context, which e.g. requires - to reload fonts if they were loading within the page, and to set many - other drawing parameters like the line width, or color. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_begin_page - - - - - - - diff --git a/reference/ps/functions/ps-end-pattern.xml b/reference/ps/functions/ps-end-pattern.xml deleted file mode 100644 index 6ee2ab204205..000000000000 --- a/reference/ps/functions/ps-end-pattern.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - ps_end_pattern - End a pattern - - - - &reftitle.description; - - boolps_end_pattern - resourcepsdoc - - - Ends a pattern which was started with ps_begin_pattern. - Once a pattern has been ended, it can be used like a color to fill - areas. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_begin_pattern - - - - - - - diff --git a/reference/ps/functions/ps-end-template.xml b/reference/ps/functions/ps-end-template.xml deleted file mode 100644 index 72fadedca6b7..000000000000 --- a/reference/ps/functions/ps-end-template.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - ps_end_template - End a template - - - - &reftitle.description; - - boolps_end_template - resourcepsdoc - - - Ends a template which was started with ps_begin_template. - Once a template has been ended, it can be used like an image. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_begin_template - - - - - - - diff --git a/reference/ps/functions/ps-fill-stroke.xml b/reference/ps/functions/ps-fill-stroke.xml deleted file mode 100644 index c81d44da87d8..000000000000 --- a/reference/ps/functions/ps-fill-stroke.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - ps_fill_stroke - Fills and strokes the current path - - - - &reftitle.description; - - boolps_fill_stroke - resourcepsdoc - - - Fills and draws the path constructed with previously called drawing - functions like ps_lineto. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_fill - ps_stroke - - - - - - - diff --git a/reference/ps/functions/ps-fill.xml b/reference/ps/functions/ps-fill.xml deleted file mode 100644 index b263334d975c..000000000000 --- a/reference/ps/functions/ps-fill.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - ps_fill - Fills the current path - - - - &reftitle.description; - - boolps_fill - resourcepsdoc - - - Fills the path constructed with previously called drawing functions like - ps_lineto. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_fill_stroke - ps_stroke - - - - - - - diff --git a/reference/ps/functions/ps-findfont.xml b/reference/ps/functions/ps-findfont.xml deleted file mode 100644 index 288334c5bb07..000000000000 --- a/reference/ps/functions/ps-findfont.xml +++ /dev/null @@ -1,144 +0,0 @@ - - - - - - ps_findfont - Loads a font - - - - &reftitle.description; - - intps_findfont - resourcepsdoc - stringfontname - stringencoding - boolembed&false; - - - Loads a font for later use. Before text is output with a loaded font it - must be set with ps_setfont. This function needs the - adobe font metric file in order to calculate the space used up by the - characters. A font which is loaded within a page will only be available on - that page. Fonts which are to be used in the complete document have to be - loaded before the first call of ps_begin_page. Calling - ps_findfont between pages will make that font - available for all following pages. - - - The name of the afm file must be - fontname.afm. If the font - shall be embedded the file - fontname.pfb containing - the font outline must be present as well. - - - Calling ps_findfont before the first page requires - to output the postscript header which includes the BoundingBox for - the whole document. Usually the BoundingBox is set with the first call - of ps_begin_page which now comes after - ps_findfont. Consequently the BoundingBox has not - been set and a warning will be issued when ps_findfont - is called. In order to prevent this situation, one should call - ps_set_parameter to set the BoundingBox before - ps_findfont is called. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - fontname - - - The name of the font. - - - - - encoding - - - ps_findfont will try to load the file passed in - the parameter encoding. Encoding files are of - the same syntax as those used by dvips(1). They - contain a font encoding vector (which is currently not used but must be - present) and a list of extra ligatures to extend the list of ligatures - derived from the afm file. - - - encoding can be &null; or the empty string if - the default encoding (TeXBase1) shall be used. - - - If the encoding is set to builtin then there - will be no reencoding and the font specific encoding will be used. This - is very useful with symbol fonts. - - - - - embed - - - If set to a value >0 the font will be embedded into the document. This - requires the font outline (.pfb file) to be present. - - - - - - - - - &reftitle.returnvalues; - - Returns the identifier of the font or zero in case of an error. The - identifier is a positive number. - - - - - &reftitle.seealso; - - - ps_begin_page - ps_setfont - - - - - - - diff --git a/reference/ps/functions/ps-get-buffer.xml b/reference/ps/functions/ps-get-buffer.xml deleted file mode 100644 index 1c37fb54b348..000000000000 --- a/reference/ps/functions/ps-get-buffer.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - ps_get_buffer - Fetches the full buffer containig the generated PS data - - - - &reftitle.description; - - stringps_get_buffer - resourcepsdoc - - This function is not implemented yet. It will always return an empty - string. The idea for a later implementation is to write the contents of - the postscript file into an internal buffer if in memory creation is - requested, and retrieve the buffer content with this function. - Currently, documents - created in memory are send to the browser without buffering. - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - - - - - &reftitle.seealso; - - - ps_open_file - - - - - - - diff --git a/reference/ps/functions/ps-get-parameter.xml b/reference/ps/functions/ps-get-parameter.xml deleted file mode 100644 index 39cd9947fbaa..000000000000 --- a/reference/ps/functions/ps-get-parameter.xml +++ /dev/null @@ -1,210 +0,0 @@ - - - - - - ps_get_parameter - Gets certain parameters - - - - &reftitle.description; - - stringfalseps_get_parameter - resourcepsdoc - stringname - floatmodifier - - - Gets several parameters which were directly set by - ps_set_parameter or indirectly by one of the other - functions. Parameters are by definition string - values. This function cannot be used to retrieve resources which were also - set by ps_set_parameter. - - - The parameter name can have the following values. - - - - - fontname - - - The name of the currently active font or the font whose - identifier is passed in parameter modifier. - - - - - fontencoding - - - The encoding of the currently active font. - - - - - dottedversion - - - The version of the underlying pslib library in the format - <major>.<minor>.<subminor> - - - - - scope - - - The current drawing scope. Can be object, document, null, page, - pattern, path, template, prolog, font, glyph. - - - - - ligaturedisolvechar - - - The character which dissolves a ligature. If your are using a font - which contains the ligature `ff' and `|' is the char to dissolve the - ligature, then `f|f' will result in two `f' instead of the ligature `ff'. - - - - - imageencoding - - - The encoding used for encoding images. Can be either - hex or 85. hex encoding - uses two bytes in the postscript file each byte in the image. - 85 stand for Ascii85 encoding. - - - - - linenumbermode - - - Set to paragraph if lines are numbered - within a paragraph or box if they are - numbered within the surrounding box. - - - - - linebreak - - - Only used if text is output with ps_show_boxed. - If set to &true; a carriage return will add a line - break. - - - - - parbreak - - - Only used if text is output with ps_show_boxed. - If set to &true; a carriage return will start - a new paragraph. - - - - - hyphenation - - - Only used if text is output with ps_show_boxed. - If set to &true; the paragraph will be hyphenated - if a hypen dictionary is set and exists. - - - - - hyphendict - - - Filename of the dictionary used for hyphenation pattern. - - - - - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - name - - - Name of the parameter. - - - - - modifier - - - An identifier needed if a parameter of a resource is requested, - e.g. the size of an image. In such a case the resource id is - passed. - - - - - - - - - &reftitle.returnvalues; - - Returns the value of the parameter &return.falseforfailure;. - - - - - &reftitle.seealso; - - - ps_set_parameter - - - - - - - diff --git a/reference/ps/functions/ps-get-value.xml b/reference/ps/functions/ps-get-value.xml deleted file mode 100644 index 798acdcb17ef..000000000000 --- a/reference/ps/functions/ps-get-value.xml +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - ps_get_value - Gets certain values - - - - &reftitle.description; - - floatps_get_value - resourcepsdoc - stringname - floatmodifier - - Gets several values which were set by - ps_set_value. Values are by definition float values. - - - The parameter name can have the following values. - - - - - fontsize - - - The size of the currently active font or the font whose - identifier is passed in parameter modifier. - - - - - font - - - The currently active font itself. - - - - - imagewidth - - - The width of the image whose id is passed in the parameter - modifier. - - - - - imageheight - - - The height of the image whose id is passed in the parameter - modifier. - - - - - capheight - - - The height of a capital M in the currently active font or the font - whose identifier is passed in parameter - modifier. - - - - - ascender - - - The ascender of the currently active font or the font - whose identifier is passed in parameter - modifier. - - - - - descender - - - The descender of the currently active font or the font - whose identifier is passed in parameter - modifier. - - - - - italicangle - - - The italicangle of the currently active font or the font - whose identifier is passed in parameter - modifier. - - - - - underlineposition - - - The underlineposition of the currently active font or the font - whose identifier is passed in parameter - modifier. - - - - - underlinethickness - - - The underlinethickness of the currently active font or the font - whose identifier is passed in parameter - modifier. - - - - - textx - - - The current x-position for text output. - - - - - texty - - - The current y-position for text output. - - - - - textrendering - - - The current mode for text rendering. - - - - - textrise - - - The space by which text is risen above the base line. - - - - - leading - - - The distance between text lines in points. - - - - - wordspacing - - - The space between words as a multiple of the width of a space char. - - - - - charspacing - - - The space between chars. If charspacing is != 0.0 ligatures will - always be dissolved. - - - - - hyphenminchars - - - Minimum number of chars hyphenated at the end of a word. - - - - - parindent - - - Indention of the first n line in a paragraph. - - - - - numindentlines - - - Number of line in a paragraph to indent if parindent != 0.0. - - - - - parskip - - - Distance between paragraphs. - - - - - linenumberspace - - - Overall space in front of each line for the line number. - - - - - linenumbersep - - - Space between the line and the line number. - - - - - major - - - The major version number of pslib. - - - - - minor - - - The minor version number of pslib. - - - - - subminor, revision - - - The subminor version number of pslib. - - - - - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - name - - - Name of the value. - - - - - modifier - - - The parameter modifier specifies the resource - for which the value is to be retrieved. This can be the id of a font or - an image. - - - - - - - - - &reftitle.returnvalues; - - Returns the value of the parameter or &false;. - - - - - &reftitle.seealso; - - - ps_set_value - - - - - - - diff --git a/reference/ps/functions/ps-hyphenate.xml b/reference/ps/functions/ps-hyphenate.xml deleted file mode 100644 index 0d8fbe27d1ca..000000000000 --- a/reference/ps/functions/ps-hyphenate.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - ps_hyphenate - Hyphenates a word - - - - &reftitle.description; - - arrayfalseps_hyphenate - resourcepsdoc - stringtext - - - Hyphenates the passed word. ps_hyphenate evaluates the - value hyphenminchars (set by ps_set_value) and - the parameter hyphendict (set by ps_set_parameter). - hyphendict must be set before calling this function. - - - This function requires the locale category LC_CTYPE to be set properly. - This is done when the extension is initialized by using the environment - variables. On Unix systems read the man page of locale for more information. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - text - - - text should not contain any non alpha - characters. Possible positions for breaks are returned in an array of - integer numbers. Each number is the position of the char in - text after which a hyphenation can take place. - - - - - - - - - &reftitle.returnvalues; - - An array of integers indicating the position of possible breaks in - the text &return.falseforfailure;. - - - - - &reftitle.examples; - - - Hyphennate a text - - -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - - - ps_show_boxed - locale(1) - - - - - - - diff --git a/reference/ps/functions/ps-include-file.xml b/reference/ps/functions/ps-include-file.xml deleted file mode 100644 index 893a2e45f71b..000000000000 --- a/reference/ps/functions/ps-include-file.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - ps_include_file - Reads an external file with raw PostScript code - - - - &reftitle.description; - - boolps_include_file - resourcepsdoc - stringfile - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - file - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - diff --git a/reference/ps/functions/ps-lineto.xml b/reference/ps/functions/ps-lineto.xml deleted file mode 100644 index 4b4870db50dc..000000000000 --- a/reference/ps/functions/ps-lineto.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - ps_lineto - Draws a line - - - - &reftitle.description; - - boolps_lineto - resourcepsdoc - floatx - floaty - - - Adds a straight line from the current point to the given coordinates to the - current path. Use ps_moveto to set the starting point - of the line. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - x - - - x-coordinate of the end point of the line. - - - - - y - - - y-coordinate of the end point of the line. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Drawing a rectangle - - -]]> - - - - - - - &reftitle.seealso; - - - ps_moveto - - - - - - - diff --git a/reference/ps/functions/ps-makespotcolor.xml b/reference/ps/functions/ps-makespotcolor.xml deleted file mode 100644 index 10bcfe6c6cb1..000000000000 --- a/reference/ps/functions/ps-makespotcolor.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - ps_makespotcolor - Create spot color - - - - &reftitle.description; - - intps_makespotcolor - resourcepsdoc - stringname - intreserved0 - - - Creates a spot color from the current fill color. The fill color must be - defined in rgb, cmyk or gray colorspace. The spot color name can be an - arbitrary name. A spot color can be set as any color with - ps_setcolor. When the document is not printed - but displayed by an postscript viewer the given color in the specified - color space is use. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - name - - - Name of the spot color, e.g. Pantone 5565. - - - - - - - - - &reftitle.returnvalues; - - The id of the new spot color or 0 in case of an error. - - - - - &reftitle.examples; - - - Creating and using a spot color - - -]]> - - - This example creates the spot color "PANTONE 5565 C" which - is a darker green (olive) and fills a rectangle with 50% intensity. - - - - - - - &reftitle.seealso; - - - ps_setcolor - - - - - - - diff --git a/reference/ps/functions/ps-moveto.xml b/reference/ps/functions/ps-moveto.xml deleted file mode 100644 index 2d92d0c74bfe..000000000000 --- a/reference/ps/functions/ps-moveto.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - ps_moveto - Sets current point - - - - &reftitle.description; - - boolps_moveto - resourcepsdoc - floatx - floaty - - - Sets the current point to new coordinates. If this is the first call of - ps_moveto after a previous path has been ended then it - will start a new path. If this function is called in the middle of a path - it will just set the current point and start a subpath. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - x - - - x-coordinate of the point to move to. - - - - - y - - - y-coordinate of the point to move to. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_lineto - - - - - - - diff --git a/reference/ps/functions/ps-new.xml b/reference/ps/functions/ps-new.xml deleted file mode 100644 index 53ee4ef7ced3..000000000000 --- a/reference/ps/functions/ps-new.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - ps_new - Creates a new PostScript document object - - - - &reftitle.description; - - resourcefalseps_new - - - - Creates a new document instance. It does not create the file on disk or in - memory, it just sets up everything. ps_new is usually - followed by a call of ps_open_file to actually create - the postscript document. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Resource of PostScript document&return.falseforfailure;. The return value - is passed to all other functions as the first argument. - - - - - &reftitle.seealso; - - - ps_delete - - - - - - - diff --git a/reference/ps/functions/ps-open-file.xml b/reference/ps/functions/ps-open-file.xml deleted file mode 100644 index 3faa89323da4..000000000000 --- a/reference/ps/functions/ps-open-file.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - ps_open_file - Opens a file for output - - - - &reftitle.description; - - boolps_open_file - resourcepsdoc - stringfilename - - - Creates a new file on disk and writes the PostScript document into it. The - file will be closed when ps_close is called. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - filename - - - The name of the postscript file. - If filename is not passed the document will be - created in memory and all output will go straight to the browser. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_close - - - - - - - diff --git a/reference/ps/functions/ps-open-image-file.xml b/reference/ps/functions/ps-open-image-file.xml deleted file mode 100644 index 148d53dc22b8..000000000000 --- a/reference/ps/functions/ps-open-image-file.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - ps_open_image_file - Opens image from file - - - - &reftitle.description; - - intps_open_image_file - resourcepsdoc - stringtype - stringfilename - stringstringparam - intintparam0 - - - Loads an image for later use. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - type - - - The type of the image. Possible values are png, - jpeg, or eps. - - - - - filename - - - The name of the file containing the image data. - - - - - stringparam - - - Not used. - - - - - intparam - - - Not used. - - - - - - - - - &reftitle.returnvalues; - - Returns identifier of image or zero in case of an error. The identifier is - a positive number greater than 0. - - - - - &reftitle.seealso; - - - ps_open_image - ps_place_image - ps_close_image - - - - - - - diff --git a/reference/ps/functions/ps-open-image.xml b/reference/ps/functions/ps-open-image.xml deleted file mode 100644 index 685663fd78e2..000000000000 --- a/reference/ps/functions/ps-open-image.xml +++ /dev/null @@ -1,166 +0,0 @@ - - - - - - ps_open_image - Reads an image for later placement - - - - &reftitle.description; - - intps_open_image - resourcepsdoc - stringtype - stringsource - stringdata - intlength - intwidth - intheight - intcomponents - intbpc - stringparams - - - Reads an image which is already available in memory. The parameter - source is currently not evaluated and assumed to be - memory. The image data is a sequence of pixels starting - in th upper left corner and ending in the lower right corner. Each pixel - consists of components color components, and each - component has bpc bits. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - type - - - The type of the image. Possible values are png, - jpeg, or eps. - - - - - source - - - Not used. - - - - - data - - - The image data. - - - - - length - - - The length of the image data. - - - - - width - - - The width of the image. - - - - - height - - - The height of the image. - - - - - components - - - The number of components for each pixel. This can be - 1 (gray scale images), 3 (rgb images), or 4 (cmyk, rgba images). - - - - - bpc - - - Number of bits per component (quite often 8). - - - - - params - - - - - - - - - - - &reftitle.returnvalues; - - Returns identifier of image or zero in case of an error. The identifier is - a positive number greater than 0. - - - - - &reftitle.seealso; - - - ps_open_image_file - ps_place_image - ps_close_image - - - - - - - - diff --git a/reference/ps/functions/ps-open-memory-image.xml b/reference/ps/functions/ps-open-memory-image.xml deleted file mode 100644 index b7ea3fcf49b8..000000000000 --- a/reference/ps/functions/ps-open-memory-image.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - ps_open_memory_image - Takes an GD image and returns an image for placement in a PS document - - - - &reftitle.description; - - intps_open_memory_image - resourcepsdoc - intgd - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - gd - - - - - - - - - - - - - diff --git a/reference/ps/functions/ps-place-image.xml b/reference/ps/functions/ps-place-image.xml deleted file mode 100644 index dd4ed8d32808..000000000000 --- a/reference/ps/functions/ps-place-image.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - ps_place_image - Places image on the page - - - - &reftitle.description; - - boolps_place_image - resourcepsdoc - intimageid - floatx - floaty - floatscale - - - Places a formerly loaded image on the page. The image can be scaled. - If the image shall be rotated as well, you will have to rotate the - coordinate system before with ps_rotate. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - imageid - - - The resource identifier of the image as returned by - ps_open_image or - ps_open_image_file. - - - - - x - - - x-coordinate of the lower left corner of the image. - - - - - y - - - y-coordinate of the lower left corner of the image. - - - - - scale - - - The scaling factor for the image. A scale of 1.0 will result - in a resolution of 72 dpi, because each pixel is equivalent to - 1 point. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_open_image - ps_open_image_file - - - - - - - diff --git a/reference/ps/functions/ps-rect.xml b/reference/ps/functions/ps-rect.xml deleted file mode 100644 index fa2f81e7c757..000000000000 --- a/reference/ps/functions/ps-rect.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - ps_rect - Draws a rectangle - - - - &reftitle.description; - - boolps_rect - resourcepsdoc - floatx - floaty - floatwidth - floatheight - - - Draws a rectangle with its lower left corner at (x, - y). The rectangle starts and ends in its lower left - corner. If this function is called outside a path it will start a new path. - If it is called within a path it will add the rectangle as a subpath. If - the last drawing operation does not end in the lower left corner then there - will be a gap in the path. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - x - - - x-coordinate of the lower left corner of the rectangle. - - - - - y - - - y-coordinate of the lower left corner of the rectangle. - - - - - width - - - The width of the image. - - - - - height - - - The height of the image. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_arc - ps_circle - ps_lineto - - - - - - - diff --git a/reference/ps/functions/ps-restore.xml b/reference/ps/functions/ps-restore.xml deleted file mode 100644 index 590e3d2dfe93..000000000000 --- a/reference/ps/functions/ps-restore.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - ps_restore - Restore previously save context - - - - &reftitle.description; - - boolps_restore - resourcepsdoc - - - Restores a previously saved graphics context. Any call of - ps_save must be accompanied by a call to - ps_restore. All coordinate transformations, line - style settings, color settings, etc. are being restored to the state - before the call of ps_save. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_save - - - - - - - diff --git a/reference/ps/functions/ps-rotate.xml b/reference/ps/functions/ps-rotate.xml deleted file mode 100644 index 6d954e21aa2c..000000000000 --- a/reference/ps/functions/ps-rotate.xml +++ /dev/null @@ -1,151 +0,0 @@ - - - - - - ps_rotate - Sets rotation factor - - - - &reftitle.description; - - boolps_rotate - resourcepsdoc - floatrot - - - Sets the rotation of the coordinate system. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - rot - - - Angle of rotation in degree. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Rotation of the coordinate system - - -]]> - - - The above example illustrates a very common way of rotating a - graphic (in this case just a rectangle) by simply rotating the - coordinate system. Since the graphic's coordinate system assumes - (0,0) to be the origin, the page coordinate system is also translated - to place the graphics not on the edge of the page. Pay attention - to the order of ps_translate and - ps_rotate. In the above case the rectancle is - rotated around the point (100, 100) in the untranslated coordinate - system. Switching the two statements has a completely - different result. - - - In order to output the following text at the original position, all - modifications of the coordinate system are encapsulated in - ps_save and ps_restore. - - - - - - - &reftitle.seealso; - - - ps_scale - ps_translate - - - - - - - diff --git a/reference/ps/functions/ps-save.xml b/reference/ps/functions/ps-save.xml deleted file mode 100644 index f9f170d845d6..000000000000 --- a/reference/ps/functions/ps-save.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - ps_save - Save current context - - - - &reftitle.description; - - boolps_save - resourcepsdoc - - - Saves the current graphics context, containing colors, translation and - rotation settings and some more. A saved context can be restored with - ps_restore. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_restore - - - - - - - diff --git a/reference/ps/functions/ps-scale.xml b/reference/ps/functions/ps-scale.xml deleted file mode 100644 index 5f7bfdb1d42e..000000000000 --- a/reference/ps/functions/ps-scale.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - ps_scale - Sets scaling factor - - - - &reftitle.description; - - boolps_scale - resourcepsdoc - floatx - floaty - - - Sets horizontal and vertical scaling of the coordinate system. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - x - - - Scaling factor in horizontal direction. - - - - - y - - - Scaling factor in vertical direction. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_rotate - ps_translate - - - - - - - diff --git a/reference/ps/functions/ps-set-border-color.xml b/reference/ps/functions/ps-set-border-color.xml deleted file mode 100644 index 9bfc127ef2f9..000000000000 --- a/reference/ps/functions/ps-set-border-color.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - ps_set_border_color - Sets color of border for annotations - - - - &reftitle.description; - - boolps_set_border_color - resourcepsdoc - floatred - floatgreen - floatblue - - - Links added with one of the functions ps_add_weblink, - ps_add_pdflink, etc. will be displayed with a - surounded rectangle when the postscript document is converted to - pdf and viewed in a pdf viewer. This rectangle is not visible in - the postscript document. - This function sets the color of the rectangle's border line. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - red - - - The red component of the border color. - - - - - green - - - The green component of the border color. - - - - - blue - - - The blue component of the border color. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_set_border_dash - ps_set_border_style - - - - - - - diff --git a/reference/ps/functions/ps-set-border-dash.xml b/reference/ps/functions/ps-set-border-dash.xml deleted file mode 100644 index 5d0d7eae9206..000000000000 --- a/reference/ps/functions/ps-set-border-dash.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - ps_set_border_dash - Sets length of dashes for border of annotations - - - - &reftitle.description; - - boolps_set_border_dash - resourcepsdoc - floatblack - floatwhite - - - Links added with one of the functions ps_add_weblink, - ps_add_pdflink, etc. will be displayed with a - surounded rectangle when the postscript document is converted to - pdf and viewed in a pdf viewer. This rectangle is not visible in - the postscript document. - This function sets the length of the black and white portion of a - dashed border line. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - black - - - The length of the dash. - - - - - white - - - The length of the gap between dashes. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_set_border_color - ps_set_border_style - - - - - - - diff --git a/reference/ps/functions/ps-set-border-style.xml b/reference/ps/functions/ps-set-border-style.xml deleted file mode 100644 index e1c439a6edf1..000000000000 --- a/reference/ps/functions/ps-set-border-style.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - ps_set_border_style - Sets border style of annotations - - - - &reftitle.description; - - boolps_set_border_style - resourcepsdoc - stringstyle - floatwidth - - - Links added with one of the functions ps_add_weblink, - ps_add_pdflink, etc. will be displayed with a - surounded rectangle when the postscript document is converted to - pdf and viewed in a pdf viewer. This rectangle is not visible in - the postscript document. - This function sets the appearance and width of the border line. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - style - - - style can be solid or - dashed. - - - - - width - - - The line width of the border. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_set_border_color - ps_set_border_dash - - - - - - - diff --git a/reference/ps/functions/ps-set-info.xml b/reference/ps/functions/ps-set-info.xml deleted file mode 100644 index b00cf190998f..000000000000 --- a/reference/ps/functions/ps-set-info.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - ps_set_info - Sets information fields of document - - - - &reftitle.description; - - boolps_set_info - resourcepsdoc - stringkey - stringvalue - - - Sets certain information fields of the document. This fields will be shown - as a comment in the header of the PostScript file. If the document is - converted to pdf this fields will also be used for the document - information. - - - The BoundingBox is usually set to the value given to the - first page. This only works if ps_findfont has not - been called before. In such cases the BoundingBox would be left unset - unless you set it explicitly with this function. - - - This function will have no effect anymore when the header of the postscript - file has been already written. It must be called before the first page - or the first call of ps_findfont. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - key - - - The name of the information field to set. The values which can be - set are Keywords, Subject, - Title, Creator, - Author, BoundingBox, and - Orientation. Be aware that some of them has a - meaning to PostScript viewers. - - - - - value - - - The value of the information field. The field - Orientation can be set to either - Portrait or Landscape. The - BoundingBox is a string consisting of four numbers. - The first two numbers are the coordinates of the lower left corner of - the page. The last two numbers are the coordinates of the upper - right corner. - - - - Up to version 0.2.6 of pslib, the BoundingBox and Orientation - will be overwritten by ps_begin_page, - unless ps_findfont has been called before. - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_findfont - ps_begin_page - - - - - - - diff --git a/reference/ps/functions/ps-set-parameter.xml b/reference/ps/functions/ps-set-parameter.xml deleted file mode 100644 index dd263eb897e2..000000000000 --- a/reference/ps/functions/ps-set-parameter.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - ps_set_parameter - Sets certain parameters - - - - &reftitle.description; - - boolps_set_parameter - resourcepsdoc - stringname - stringvalue - - - Sets several parameters which are used by many functions. Parameters are by - definition string values. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - name - - - For a list of possible names see ps_get_parameter. - - - - - value - - - The value of the parameter. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_get_parameters - ps_set_value - - - - - - - diff --git a/reference/ps/functions/ps-set-text-pos.xml b/reference/ps/functions/ps-set-text-pos.xml deleted file mode 100644 index dd42dd48f27c..000000000000 --- a/reference/ps/functions/ps-set-text-pos.xml +++ /dev/null @@ -1,138 +0,0 @@ - - - - - - ps_set_text_pos - Sets position for text output - - - - &reftitle.description; - - boolps_set_text_pos - resourcepsdoc - floatx - floaty - - - Set the position for the next text output. You may alternatively set the x - and y value separately by calling ps_set_value and - choosing textx respectively texty as - the value name. - - - If you want to output text at a certain position it is more convenient - to use ps_show_xy instead of setting the text position - and calling ps_show. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - x - - - x-coordinate of the new text position. - - - - - y - - - y-coordinate of the new text position. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Placing text at a given position - - -]]> - - - - - - - &reftitle.seealso; - - - ps_set_value - ps_show - - - - - - - diff --git a/reference/ps/functions/ps-set-value.xml b/reference/ps/functions/ps-set-value.xml deleted file mode 100644 index be58ad777cfa..000000000000 --- a/reference/ps/functions/ps-set-value.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - - ps_set_value - Sets certain values - - - - &reftitle.description; - - boolps_set_value - resourcepsdoc - stringname - floatvalue - - - Sets several values which are used by many functions. Parameters are by - definition float values. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - name - - - The name can be one of the following: - - - textrendering - - - The way how text is shown. - - - - - textx - - - The x coordinate for text output. - - - - - texty - - - The y coordinate for text output. - - - - - wordspacing - - - The distance between words relative to the width of a space. - - - - - leading - - - The distance between lines in pixels. - - - - - - - - - value - - - The value of the parameter. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_get_value - ps_set_parameter - - - - - - - diff --git a/reference/ps/functions/ps-setcolor.xml b/reference/ps/functions/ps-setcolor.xml deleted file mode 100644 index 8e4c79710816..000000000000 --- a/reference/ps/functions/ps-setcolor.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - - ps_setcolor - Sets current color - - - - &reftitle.description; - - boolps_setcolor - resourcepsdoc - stringtype - stringcolorspace - floatc1 - floatc2 - floatc3 - floatc4 - - - Sets the color for drawing, filling, or both. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - type - - - The parameter type can be - both, fill, or - fillstroke. - - - - - colorspace - - - The colorspace should be one of gray, - rgb, cmyk, - spot, pattern. Depending on the - colorspace either only the first, the first three or all parameters - will be used. - - - - - c1 - - - Depending on the colorspace this is either the red component (rgb), - the cyan component (cmyk), the gray value (gray), the identifier of - the spot color or the identifier of the pattern. - - - - - c2 - - - Depending on the colorspace this is either the green component (rgb), - the magenta component (cmyk). - - - - - c3 - - - Depending on the colorspace this is either the blue component (rgb), - the yellow component (cmyk). - - - - - c4 - - - This must only be set in cmyk colorspace and specifies the black - component. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.notes; - - - The second parameter is currently not always evaluated. The color is - sometimes set for filling and drawing just as if - fillstroke were passed. - - - - - - diff --git a/reference/ps/functions/ps-setdash.xml b/reference/ps/functions/ps-setdash.xml deleted file mode 100644 index 09deb8103ce7..000000000000 --- a/reference/ps/functions/ps-setdash.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - ps_setdash - Sets appearance of a dashed line - - - - &reftitle.description; - - boolps_setdash - resourcepsdoc - floaton - floatoff - - - Sets the length of the black and white portions of a dashed line. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - on - - - The length of the dash. - - - - - off - - - The length of the gap between dashes. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_setpolydash - - - - - - - diff --git a/reference/ps/functions/ps-setflat.xml b/reference/ps/functions/ps-setflat.xml deleted file mode 100644 index 88926dcecab9..000000000000 --- a/reference/ps/functions/ps-setflat.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - ps_setflat - Sets flatness - - - - &reftitle.description; - - boolps_setflat - resourcepsdoc - floatvalue - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - value - - - The value must be between 0.2 and 1. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/ps/functions/ps-setfont.xml b/reference/ps/functions/ps-setfont.xml deleted file mode 100644 index 5c2d452d2dc2..000000000000 --- a/reference/ps/functions/ps-setfont.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - ps_setfont - Sets font to use for following output - - - - &reftitle.description; - - boolps_setfont - resourcepsdoc - intfontid - floatsize - - - Sets a font, which has to be loaded before with - ps_findfont. Outputting text without setting a font - results in an error. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - fontid - - - The font identifier as returned by ps_findfont. - - - - - size - - - The size of the font. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_findfont - ps_set_text_pos for an example. - - - - - - - diff --git a/reference/ps/functions/ps-setgray.xml b/reference/ps/functions/ps-setgray.xml deleted file mode 100644 index 20e59e6d4f6c..000000000000 --- a/reference/ps/functions/ps-setgray.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - ps_setgray - Sets gray value - - - - &reftitle.description; - - boolps_setgray - resourcepsdoc - floatgray - - - Sets the gray value for all following drawing operations. - - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - gray - - - The value must be between 0 (white) and 1 (black). - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_setcolor - - - - - - - diff --git a/reference/ps/functions/ps-setlinecap.xml b/reference/ps/functions/ps-setlinecap.xml deleted file mode 100644 index 4fec1ecf2c01..000000000000 --- a/reference/ps/functions/ps-setlinecap.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - ps_setlinecap - Sets appearance of line ends - - - - &reftitle.description; - - boolps_setlinecap - resourcepsdoc - inttype - - - Sets how line ends look like. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - type - - - The type of line ends. Possible values are - PS_LINECAP_BUTT, - PS_LINECAP_ROUND, or - PS_LINECAP_SQUARED. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_setlinejoin - ps_setlinewidth - ps_setmiterlimit - - - - - - - diff --git a/reference/ps/functions/ps-setlinejoin.xml b/reference/ps/functions/ps-setlinejoin.xml deleted file mode 100644 index f645a31597d0..000000000000 --- a/reference/ps/functions/ps-setlinejoin.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - ps_setlinejoin - Sets how contected lines are joined - - - - &reftitle.description; - - boolps_setlinejoin - resourcepsdoc - inttype - - - Sets how lines are joined. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - type - - - The way lines are joined. Possible values are - PS_LINEJOIN_MITER, - PS_LINEJOIN_ROUND, or - PS_LINEJOIN_BEVEL. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_setlinecap - ps_setlinewidth - ps_setmiterlimit - - - - - - - diff --git a/reference/ps/functions/ps-setlinewidth.xml b/reference/ps/functions/ps-setlinewidth.xml deleted file mode 100644 index 1d6a667f1b7e..000000000000 --- a/reference/ps/functions/ps-setlinewidth.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - ps_setlinewidth - Sets width of a line - - - - &reftitle.description; - - boolps_setlinewidth - resourcepsdoc - floatwidth - - - Sets the line width for all following drawing operations. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - width - - - The width of lines in points. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_setlinecap - ps_setlinejoin - ps_setmiterlimit - - - - - - - diff --git a/reference/ps/functions/ps-setmiterlimit.xml b/reference/ps/functions/ps-setmiterlimit.xml deleted file mode 100644 index 17fe1f6914a5..000000000000 --- a/reference/ps/functions/ps-setmiterlimit.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - ps_setmiterlimit - Sets the miter limit - - - - &reftitle.description; - - boolps_setmiterlimit - resourcepsdoc - floatvalue - - - If two lines join in a small angle and the line join is set to - PS_LINEJOIN_MITER, then - the resulting spike will be very long. The miter limit is the maximum - ratio of the miter length (the length of the spike) and the line width. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - value - - - The maximum ratio between the miter length and the line width. Larger - values (> 10) will result in very long spikes when two lines meet - in a small angle. Keep the default unless you know what you are doing. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_setlinecap - ps_setlinejoin - ps_setlinewidth - - - - - - - diff --git a/reference/ps/functions/ps-setoverprintmode.xml b/reference/ps/functions/ps-setoverprintmode.xml deleted file mode 100644 index 68cc16497eea..000000000000 --- a/reference/ps/functions/ps-setoverprintmode.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - ps_setoverprintmode - Sets overprint mode - - - - &reftitle.description; - - boolps_setoverprintmode - resourcepsdoc - intmode - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - mode - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/ps/functions/ps-setpolydash.xml b/reference/ps/functions/ps-setpolydash.xml deleted file mode 100644 index a48b24805e3d..000000000000 --- a/reference/ps/functions/ps-setpolydash.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - ps_setpolydash - Sets appearance of a dashed line - - - - &reftitle.description; - - boolps_setpolydash - resourcepsdoc - floatarr - - - Sets the length of the black and white portions of a dashed line. - ps_setpolydash is used to set more complicated dash - patterns. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - arr - - - arr is a list of length elements alternately for - the black and white portion. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Drawing a dashed line - - -]]> - - - This example draws a line with a 10 and 2 points long line, and - gaps of 5 points inbetween. - - - - - - - &reftitle.seealso; - - - ps_setdash - - - - - - - diff --git a/reference/ps/functions/ps-shading-pattern.xml b/reference/ps/functions/ps-shading-pattern.xml deleted file mode 100644 index ca47ee5fd561..000000000000 --- a/reference/ps/functions/ps-shading-pattern.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - ps_shading_pattern - Creates a pattern based on a shading - - - - &reftitle.description; - - intfalseps_shading_pattern - resourcepsdoc - intshadingid - stringoptlist - - - Creates a pattern based on a shading, which has to be created before with - ps_shading. Shading patterns can be used like regular - patterns. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - shadingid - - - The identifier of a shading previously created with - ps_shading. - - - - - optlist - - - This argument is not currently used. - - - - - - - - - &reftitle.returnvalues; - - The identifier of the pattern &return.falseforfailure;. - - - - - &reftitle.seealso; - - - ps_shading - ps_shfill - - - - - - - diff --git a/reference/ps/functions/ps-shading.xml b/reference/ps/functions/ps-shading.xml deleted file mode 100644 index 6e611f556d88..000000000000 --- a/reference/ps/functions/ps-shading.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - ps_shading - Creates a shading for later use - - - - &reftitle.description; - - intfalseps_shading - resourcepsdoc - stringtype - floatx0 - floaty0 - floatx1 - floaty1 - floatc1 - floatc2 - floatc3 - floatc4 - stringoptlist - - - Creates a shading, which can be used by ps_shfill or - ps_shading_pattern. - - - The color of the shading can be in any color space except for - pattern. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - type - - - The type of shading can be either radial or - axial. Each shading starts with the current fill - color and ends with the given color values passed in the parameters - c1 to c4 - (see ps_setcolor for their meaning). - - - - - x0, x1, y0, y1 - - - The coordinates x0, y0, - x1, y1 are the start and - end point of the shading. If the type of shading is - radial the two points are the middle points of - a starting and ending circle. - - - - - c1, c2, c3, c4 - - - See ps_setcolor for their meaning. - - - - - optlist - - - If the shading is of type radial the - optlist must also contain the parameters - r0 and r1 with the radius of the - start and end circle. - - - - - - - - - &reftitle.returnvalues; - - Returns the identifier of the pattern &return.falseforfailure;. - - - - - &reftitle.seealso; - - - ps_shading_pattern - ps_shfill - - - - - - - diff --git a/reference/ps/functions/ps-shfill.xml b/reference/ps/functions/ps-shfill.xml deleted file mode 100644 index 394cdbd843d9..000000000000 --- a/reference/ps/functions/ps-shfill.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - ps_shfill - Fills an area with a shading - - - - &reftitle.description; - - boolps_shfill - resourcepsdoc - intshadingid - - - Fills an area with a shading, which has to be created before with - ps_shading. This is an alternative way to creating - a pattern from a shading ps_shading_pattern and using - the pattern as the filling color. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - shadingid - - - The identifier of a shading previously created with - ps_shading. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_shading - ps_shading_pattern - - - - - - - diff --git a/reference/ps/functions/ps-show-boxed.xml b/reference/ps/functions/ps-show-boxed.xml deleted file mode 100644 index ed7887b6969b..000000000000 --- a/reference/ps/functions/ps-show-boxed.xml +++ /dev/null @@ -1,319 +0,0 @@ - - - - - - ps_show_boxed - Output text in a box - - - - &reftitle.description; - - intps_show_boxed - resourcepsdoc - stringtext - floatleft - floatbottom - floatwidth - floatheight - stringhmode - stringfeature - - - Outputs a text in a given box. The lower left corner of the box is at - (left, bottom). Line breaks - will be inserted where needed. Multiple spaces are treated as one. - Tabulators are treated as spaces. - - - The text will be hyphenated if the parameter - hyphenation is set to &true; - and the parameter hyphendict contains a valid - filename for a hyphenation - file. The line spacing is taken from the value leading. - Paragraphs can be - separated by an empty line just like in TeX. If the value - parindent is - set to value > 0.0 then the first n lines will be indented. The number n - of lines is set by the parameter numindentlines. - In order to prevent - indenting of the first m paragraphs set the value - parindentskip to a - positive number. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - text - - - The text to be output into the given box. - - - - - left - - - x-coordinate of the lower left corner of the box. - - - - - bottom - - - y-coordinate of the lower left corner of the box. - - - - - width - - - Width of the box. - - - - - height - - - Height of the box. - - - - - hmode - - - The parameter hmode can be justify, - fulljustify, right, left, or center. - The difference of justify and fulljustify just affects the last line of the box. In - fulljustify mode the last line will be left and right justified unless - this is also the last line of paragraph. In justify mode it will always - be left justified. - - - - - feature - - - - - - - - - - - Used parameters - - The output of ps_show_boxed can be configured with - several parameters and values which must be set with either - ps_set_parameter or ps_set_value. - Beside the parameters and values which affect text output, the following - parameters and values are evaluated. - - - leading (value) - - Distance between baselines of two consecutive lines. - - - - linebreak (parameter) - - - Set to &true; if you want a carriage return to start a new line instead - of treating it as a space. Defaults to &false;. - - - - - parbreak (parameter) - - - Set to &true; if you want a carriage return on a single line to start a - new paragraph instead of treating it as a space. Defaults to &true;. - - - - - hyphenation (parameter) - - - Set to &true; in order to turn hyphenation on. This requires a - dictionary to be set with the parameter hyphendict. Defaults to - &false;. - - - - - hyphendict (parameter) - - - Filename of the dictionary used for hyphenation pattern (see below). - - - - - hyphenminchar (value) - - - The number of chars which must at least be left over before or after - the hyphen. This implies that only words of at least two times this - value will be hyphenated. The default value is three. Setting a value - of zero will result in the default value. - - - - - parindent (value) - - - Set the amount of space in pixel for indenting the first m lines of a - paragraph. m can be set with the value numindentlines. - - - - - parskip (value) - - - Set the amount of extra space in pixel between paragraphs. Defaults to - 0 which will result in a normal line distance. - - - - - numindentlines (value) - - - Number of lines from the start of the paragraph which will be indented. - Defaults to 1. - - - - - parindentskip (value) - - - Number of paragraphs in the box whose first lines will not be indented. - This defaults to 0. This is useful for paragraphs right after a section - heading or text being continued in a second box. In both case one would - set this to 1. - - - - - linenumbermode (parameter) - - - Set how lines are to be numbered. Possible values are box for - numbering lines in the whole box or paragraph to number lines within - each paragraph. - - - - - linenumberspace (value) - - - The space for the column left of the numbered line containing the line - number. The line number will be right justified into this column. - Defaults to 20. - - - - - linenumbersep (value) - - - The space between the column with line numbers and the line itself. - Defaults to 5. - - - - - - - - - Hyphenation - - Text is hyphenated if the parameter hyphenation is set - to true and a valid hyphenation dictionary is set. pslib does not ship its own - hyphenation dictionary but uses one from openoffice, scribus or koffice. - You can find their dictionaries for different languages in one of the - following directories if the software is installed: - - - /usr/share/apps/koffice/hyphdicts/ - - - /usr/lib/scribus/dicts/ - - - /usr/lib/openoffice/share/dict/ooo/ - - - Currently scribus appears to have the most complete hyphenation - dictionaries. - - - - - - &reftitle.returnvalues; - - Number of characters that could not be written. - - - - - &reftitle.seealso; - - - ps_continue_text - - - - - - - diff --git a/reference/ps/functions/ps-show-xy.xml b/reference/ps/functions/ps-show-xy.xml deleted file mode 100644 index 2ff14292bca2..000000000000 --- a/reference/ps/functions/ps-show-xy.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - ps_show_xy - Output text at given position - - - - &reftitle.description; - - boolps_show_xy - resourcepsdoc - stringtext - floatx - floaty - - - Output a text at the given text position. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - text - - - The text to be output. - - - - - x - - - x-coordinate of the lower left corner of the box surrounding the text. - - - - - y - - - y-coordinate of the lower left corner of the box surrounding the text. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_continue_text - ps_show - - - - - - - diff --git a/reference/ps/functions/ps-show-xy2.xml b/reference/ps/functions/ps-show-xy2.xml deleted file mode 100644 index a892cd85cd3e..000000000000 --- a/reference/ps/functions/ps-show-xy2.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - ps_show_xy2 - Output text at position - - - - &reftitle.description; - - boolps_show_xy2 - resourcepsdoc - stringtext - intlen - floatxcoor - floatycoor - - &warn.undocumented.func; - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/ps/functions/ps-show.xml b/reference/ps/functions/ps-show.xml deleted file mode 100644 index de397b263ec1..000000000000 --- a/reference/ps/functions/ps-show.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - ps_show - Output text - - - - &reftitle.description; - - boolps_show - resourcepsdoc - stringtext - - - Output a text at the current text position. The text position can be set - by storing the x and y coordinates into the values textx - and texty with the function - ps_set_value. The function will issue an - error if a font was not set before with ps_setfont. - - - ps_show evaluates the following parameters and values - as set by ps_set_parameter and - ps_set_value. - - - - charspacing (value) - - - Distance between two consecutive glyphs. If this value is unequal to - zero then all ligatures will be resolved. Values less than zero are - allowed. - - - - - kerning (parameter) - - - Setting this parameter to "false" will turn off kerning. Kerning is - turned on by default. - - - - - ligatures (parameter) - - - Setting this parameter to "false" will turn off the use of ligatures. - Ligatures are turned on by default. - - - - - underline (parameter) - - - Setting this parameter to "true" will turn on underlining. Underlining - is turned off by default. - - - - - overline (parameter) - - - Setting this parameter to "true" will turn on overlining. Overlining is - turned off by default. - - - - - strikeout (parameter) - - - Setting this parameter to "true" will turn on striking out. Striking out - is turned off by default. - - - - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - text - - - The text to be output. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_continue_text - ps_show_xy - ps_setfont - - - - - - - diff --git a/reference/ps/functions/ps-show2.xml b/reference/ps/functions/ps-show2.xml deleted file mode 100644 index a00dd68c00bf..000000000000 --- a/reference/ps/functions/ps-show2.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - ps_show2 - Output a text at current position - - - - &reftitle.description; - - boolps_show2 - resourcepsdoc - stringtext - intlen - - - Output text at the current position. Do not print more than len characters. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - text - - - The text to be output. - - - - - len - - - The maximum number of characters to print. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/ps/functions/ps-string-geometry.xml b/reference/ps/functions/ps-string-geometry.xml deleted file mode 100644 index f052af4a2a23..000000000000 --- a/reference/ps/functions/ps-string-geometry.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - ps_string_geometry - Gets geometry of a string - - - - &reftitle.description; - - arrayps_string_geometry - resourcepsdoc - stringtext - intfontid0 - floatsize0.0 - - - This function is similar to ps_stringwidth but returns - an array of dimensions containing the width, ascender, and descender - of the text. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - text - - - The text for which the geometry is to be calculated. - - - - - fontid - - - The identifier of the font to be used. If not font is specified - the current font will be used. - - - - - size - - - The size of the font. If no size is specified the current size - is used. - - - - - - - - - &reftitle.returnvalues; - - An array of the dimensions of a string. The element 'width' contains the - width of the string as returned by ps_stringwidth. The - element 'descender' contains the maximum descender and 'ascender' the - maximum ascender of the string. - - - - - &reftitle.seealso; - - - ps_continue_text - ps_stringwidth - - - - - - - diff --git a/reference/ps/functions/ps-stringwidth.xml b/reference/ps/functions/ps-stringwidth.xml deleted file mode 100644 index 5572b113003f..000000000000 --- a/reference/ps/functions/ps-stringwidth.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - ps_stringwidth - Gets width of a string - - - - &reftitle.description; - - floatps_stringwidth - resourcepsdoc - stringtext - intfontid0 - floatsize0.0 - - - Calculates the width of a string in points if it was output - in the given font and font size. - This function needs an Adobe font - metrics file to calculate the precise width. If kerning is turned on, - it will be taken into account. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - text - - - The text for which the width is to be calculated. - - - - - fontid - - - The identifier of the font to be used. If not font is specified - the current font will be used. - - - - - size - - - The size of the font. If no size is specified the current size - is used. - - - - - - - - - &reftitle.returnvalues; - - Width of a string in points. - - - - - &reftitle.seealso; - - - ps_string_geometry - - - - - - - diff --git a/reference/ps/functions/ps-stroke.xml b/reference/ps/functions/ps-stroke.xml deleted file mode 100644 index 865b995873ec..000000000000 --- a/reference/ps/functions/ps-stroke.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - ps_stroke - Draws the current path - - - - &reftitle.description; - - boolps_stroke - resourcepsdoc - - - Draws the path constructed with previously called drawing functions like - ps_lineto. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_closepath_stroke - ps_fill - ps_fill_stroke - - - - - - - diff --git a/reference/ps/functions/ps-symbol-name.xml b/reference/ps/functions/ps-symbol-name.xml deleted file mode 100644 index 4807c2df2fc5..000000000000 --- a/reference/ps/functions/ps-symbol-name.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - ps_symbol_name - Gets name of a glyph - - - - &reftitle.description; - - stringps_symbol_name - resourcepsdoc - intord - intfontid0 - - - This function needs an Adobe font metrics file to know which glyphs are - available. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - ord - - - The parameter ord is the position of the glyph - in the font encoding vector. - - - - - fontid - - - The identifier of the font to be used. If not font is specified - the current font will be used. - - - - - - - - - &reftitle.returnvalues; - - The name of a glyph in the given font. - - - - - &reftitle.seealso; - - - ps_symbol - ps_symbol_width - - - - - - - diff --git a/reference/ps/functions/ps-symbol-width.xml b/reference/ps/functions/ps-symbol-width.xml deleted file mode 100644 index 84872d6af29f..000000000000 --- a/reference/ps/functions/ps-symbol-width.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - ps_symbol_width - Gets width of a glyph - - - - &reftitle.description; - - floatps_symbol_width - resourcepsdoc - intord - intfontid0 - floatsize0.0 - - - Calculates the width of a glyph in points if it was output in the given - font and font size. This function needs an Adobe font metrics file to - calculate the precise width. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - ord - - - The position of the glyph in the font encoding vector. - - - - - fontid - - - The identifier of the font to be used. If not font is specified - the current font will be used. - - - - - size - - - The size of the font. If no size is specified the current size - is used. - - - - - - - - - &reftitle.returnvalues; - - The width of a glyph in points. - - - - - &reftitle.seealso; - - - ps_symbol - ps_symbol_name - - - - - - - diff --git a/reference/ps/functions/ps-symbol.xml b/reference/ps/functions/ps-symbol.xml deleted file mode 100644 index 978e94dc2b8d..000000000000 --- a/reference/ps/functions/ps-symbol.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - ps_symbol - Output a glyph - - - - &reftitle.description; - - boolps_symbol - resourcepsdoc - intord - - - Output the glyph at position ord in the font - encoding vector of the current font. The font encoding for a font can be - set when loading the font with ps_findfont. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - ord - - - The position of the glyph in the font encoding vector. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_symbol_name - ps_symbol_width - - - - - - - diff --git a/reference/ps/functions/ps-translate.xml b/reference/ps/functions/ps-translate.xml deleted file mode 100644 index 5c4521bfec63..000000000000 --- a/reference/ps/functions/ps-translate.xml +++ /dev/null @@ -1,165 +0,0 @@ - - - - - - ps_translate - Sets translation - - - - &reftitle.description; - - boolps_translate - resourcepsdoc - floatx - floaty - - - Sets a new initial point of the coordinate system. - - - - - &reftitle.parameters; - - - - psdoc - - - Resource identifier of the postscript file - as returned by ps_new. - - - - - x - - - x-coordinate of the origin of the translated coordinate system. - - - - - y - - - y-coordinate of the origin of the translated coordinate system. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Translation of the coordinate system - - - -]]> - - The above example demonstrates two possible ways to place - a graphic (in this case just a rectangle) at any position on the page, - while the graphic itself uses its own coordinate system. The trick is - to change the origin of the current coordinate system before drawing - the rectangle. The translation has to be undone after the graphic has - been drawn. - - - On the second page a slightly different and more elegant approach is - applied. Instead of undoing the translation with a second call of - ps_translate the graphics context is saved before - modifying the coordinate system and restored after drawing the rectangle. - - - - - - - &reftitle.seealso; - - - ps_scale - ps_rotate - - - - - - - diff --git a/reference/ps/reference.xml b/reference/ps/reference.xml deleted file mode 100644 index fca9882f3f1c..000000000000 --- a/reference/ps/reference.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - PS &Functions; - - -
    - Contact Information - - If you have comments, bugfixes, enhancements for either this extension or - pslib then please drop me a mail - steinm@php.net. Any help is very - welcome. - -
    - -
    - - &reference.ps.entities.functions; - -
    - - diff --git a/reference/ps/setup.xml b/reference/ps/setup.xml deleted file mode 100644 index e0d5098017ef..000000000000 --- a/reference/ps/setup.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - &reftitle.setup; - - -
    - &reftitle.required; - - You need at least pslib >= 0.1.12. The ps library (pslib) - is available at &url.pslib;. - -
    - - - - &reference.ps.configure; - - - -
    - &reftitle.resources; - - This extension defines a PostScript document resource returned by - ps_new. - -
    - - -
    - - - diff --git a/reference/ps/versions.xml b/reference/ps/versions.xml deleted file mode 100644 index d7f126044588..000000000000 --- a/reference/ps/versions.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/pthreads/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/pthreads/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/pthreads/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/pthreads/book.xml b/reference/pthreads/book.xml deleted file mode 100644 index b60c8b78b542..000000000000 --- a/reference/pthreads/book.xml +++ /dev/null @@ -1,162 +0,0 @@ - - - - - pthreads - pthreads - - - &reftitle.intro; - - pthreads is an object-orientated API that provides all of the tools needed - for multi-threading in PHP. PHP applications can create, read, write, - execute and synchronize with Threads, Workers and Threaded objects. - - - - This extension is considered unmaintained and dead. - - - - - Consider using parallel instead. - - - - - The pthreads extension cannot be used in a web server environment. - Threading in PHP is therefore restricted to CLI-based applications only. - - - - - pthreads (v3) can only be used with PHP 7.2+: This is due to ZTS - mode being unsafe in 7.0 and 7.1. - - - - The Threaded class forms the basis of the - functionality that allows pthreads to operate. It exposes synchronization - methods and some useful interfaces for the programmer. - - - The Thread class enables for threads to be created by - simply extending it and implementing a run method. Any - members can be written to and read by any context with a reference to the - thread. Any context can also execute any public and protected methods. - The body of the run method will be executed in a separate thread when the - Thread::start method of the implementation is - called from the context that created it. Only the context that creates a - thread can start and join it. - - - The Worker class has a persistent state, and will be - available from the call to Thread::start (an - inherited method) until the object goes out of scope, or is explicitly - shutdown (via Worker::shutdown). Any context with a - reference to the worker object can stack tasks onto the Worker (via - Worker::stack), where these tasks will be executed - by the worker in a separate thread. The run method of a - worker object will be executed before any objects on the worker's stack, - enabling for resources to be initialized that the objects to be executed may - need. - - - The Pool class is used to create a group of workers - to distribute Threaded objects amongst them. It is - the easiest and most efficient way of using multiple threads in PHP - applications. - - - - The Pool class does not extend the - Threaded class, and so pool-based objects are - considered a normal PHP objects. As such, its instances of it should not be - shared amongst different contexts. - - - - The Volatile class is new to pthreads v3. It is used - to denote mutable Threaded properties of - Threaded classes (since these are now immutable by - default). It is also used to store PHP arrays in - Threaded contexts. - - - Synchronization is an important ability when threading. All of the objects - that pthreads creates have built in synchronization in the (which will be - familiar to java programmers) form of - Threaded::wait and - Threaded::notify. Calling - Threaded::wait on an object will cause the context - to wait for another context to call - Threaded::notify on the same object. This mechanism - allows for powerful synchronization between Threaded - objects in PHP. - - - - Any objects that are intended for use in the multi-threaded parts of your - application should extend Threaded. - - - - Data Storage: - As a rule of thumb, any data type that can be serialized can be used as a member of a Threaded object, it can be read and written from any context with a reference to the Threaded Object. - Not every type of data is stored serially, basic types are stored in their true form. - Complex types, Arrays, and Objects that are not Threaded are stored serially; they can be read and written to the Threaded Object from any context with a reference. - With the exception of Threaded Objects any reference used to set a member of a Threaded Object is separated from the reference in the Threaded Object; - the same data can be read directly from the Threaded Object at any time by any context with a reference to the Threaded Object. - - - Static Members: - When a new context is created ( Thread or Worker ), they are generally copied, but resources and objects with internal state are nullified (for safety reasons). This allows them to function as a kind of thread local storage. For example, upon starting the context, a class whose static members include connection information for a database server, and the connection itself, will only have the simple connection information copied, not the connection. Allowing the new context to initiate a connection in the same way as the context that created it, storing the connection in the same place without affecting the original context. - - - - When print_r, var_dump and other object debug functions are executed, they do not include recursion protection. - - - - - Resources: - The extensions and functionality that define resources in PHP are completely unprepared for this kind of environment; pthreads makes provisions for Resources to be shared among contexts, however, for most types of resource it should be considered unsafe. Extreme caution and care should be used when sharing resources among contexts. - - - - - In the environment which pthreads executes, some restrictions and limitations are necessary in order to provide a stable environment. - - - - - &reference.pthreads.setup; - &reference.pthreads.constants; - &reference.pthreads.threaded; - &reference.pthreads.thread; - &reference.pthreads.worker; - &reference.pthreads.collectable; - &reference.pthreads.pool; - &reference.pthreads.volatile; - - - diff --git a/reference/pthreads/collectable.xml b/reference/pthreads/collectable.xml deleted file mode 100644 index 51553ec798d9..000000000000 --- a/reference/pthreads/collectable.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - The Collectable interface - Collectable - - - -
    - &reftitle.intro; - - - Represents a garbage-collectable object. - -
    - - -
    - &reftitle.interfacesynopsis; - - - - Collectable - - - - - Collectable - - - - - &Methods; - - - - - -
    - -
    - - &reference.pthreads.entities.collectable; - -
    - diff --git a/reference/pthreads/collectable/isgarbage.xml b/reference/pthreads/collectable/isgarbage.xml deleted file mode 100644 index 1001901c0c24..000000000000 --- a/reference/pthreads/collectable/isgarbage.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - Collectable::isGarbage - Determine whether an object has been marked as garbage - - - - &reftitle.description; - - public trueCollectable::isGarbage - - - - Can be called in Pool::collect to determine if this object is garbage. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.true.always; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &return.type.true; - - - - - - - &reftitle.seealso; - - Pool::collect - - - - - diff --git a/reference/pthreads/configure.xml b/reference/pthreads/configure.xml deleted file mode 100644 index c925c2fe42f0..000000000000 --- a/reference/pthreads/configure.xml +++ /dev/null @@ -1,42 +0,0 @@ - - -
    - &reftitle.install; - - - Use when compiling PHP. - - - - Windows users should include php_pthreads.dll into &php.ini; - - - - - Windows users also have to make sure that pthreadVC2.dll - (included with the distribution) is present in one of the folders specified - in the PATH environment variable. - - - -
    - diff --git a/reference/pthreads/constants.xml b/reference/pthreads/constants.xml deleted file mode 100644 index ebcdb94c2ed5..000000000000 --- a/reference/pthreads/constants.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - &reftitle.constants; - &extension.constants; - - - - PTHREADS_INHERIT_ALL - (int) - - - - The default options for all Threads, causes pthreads to copy the environment when new Threads are started - - - - - - PTHREADS_INHERIT_NONE - (int) - - - - Do not inherit anything when new Threads are started - - - - - - PTHREADS_INHERIT_INI - (int) - - - - Inherit INI entries when new Threads are started - - - - - - PTHREADS_INHERIT_CONSTANTS - (int) - - - - Inherit user declared constants when new Threads are started - - - - - - PTHREADS_INHERIT_CLASSES - (int) - - - - Inherit user declared classes when new Threads are started - - - - - - PTHREADS_INHERIT_FUNCTIONS - (int) - - - - Inherit user declared functions when new Threads are started - - - - - - PTHREADS_INHERIT_INCLUDES - (int) - - - - Inherit included file information when new Threads are started - - - - - - PTHREADS_INHERIT_COMMENTS - (int) - - - - Inherit all comments when new Threads are started - - - - - - PTHREADS_ALLOW_HEADERS - (int) - - - - Allow new Threads to send headers to standard output (normally prohibited) - - - - - - diff --git a/reference/pthreads/pool.xml b/reference/pthreads/pool.xml deleted file mode 100644 index f8eb53aa9cd9..000000000000 --- a/reference/pthreads/pool.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - The Pool class - Pool - - - - -
    - &reftitle.intro; - - A Pool is a container for, and controller of, an adjustable number of Workers. - - - Pooling provides a higher level abstraction of the Worker functionality, including the management of references in the way required by pthreads. - -
    - - -
    - &reftitle.classsynopsis; - - - - Pool - - - - - Pool - - - - &Properties; - - protected - size - - - protected - class - - - protected - workers - - - protected - ctor - - - protected - last - - - &Methods; - - - - - -
    - - - -
    - &reftitle.properties; - - - size - - maximum number of Workers this Pool can use - - - - class - - the class of the Worker - - - - workers - - references to Workers - - - - ctor - - the arguments for constructor of new Workers - - - - last - - offset in workers of the last Worker used - - - -
    - - - -
    - - &reference.pthreads.entities.pool; - -
    - diff --git a/reference/pthreads/pool/collect.xml b/reference/pthreads/pool/collect.xml deleted file mode 100644 index 43c7ee071738..000000000000 --- a/reference/pthreads/pool/collect.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - Pool::collect - Collect references to completed tasks - - - - &reftitle.description; - - public intPool::collect - Callablecollector - - - Allows the pool to collect references determined to be garbage by the - optionally given collector. - - - - - &reftitle.parameters; - - - collector - - - A Callable collector that returns a boolean on whether the task can be - collected or not. Only in rare cases should a custom collector need to - be used. - - - - - - - - &reftitle.returnvalues; - - The number of remaining tasks in the pool to be collected. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL pthreads 3.0.0 - - An integer is now returned, and the collector - parameter is now optional. - - - - - - - - - &reftitle.examples; - - A basic example of <methodname>Pool::collect</methodname> - -submit(new class extends Threaded {}); -} - -while ($pool->collect()); // blocks until all tasks have finished executing - -$pool->shutdown(); -]]> - - - - - - diff --git a/reference/pthreads/pool/construct.xml b/reference/pthreads/pool/construct.xml deleted file mode 100644 index 83a9c07afbff..000000000000 --- a/reference/pthreads/pool/construct.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - Pool::__construct - Creates a new Pool of Workers - - - - &reftitle.description; - - public Pool::__construct - intsize - stringclass - arrayctor - - - Construct a new pool of workers. Pools lazily create their threads, which - means new threads will only be spawned when they are required to execute - tasks. - - - - - &reftitle.parameters; - - - size - - - The maximum number of workers for this pool to create - - - - - class - - - The class for new Workers. If no class is given, then it defaults to the - Worker class. - - - - - ctor - - - An array of arguments to be passed to new workers' constructors - - - - - - - - &reftitle.examples; - - Creating Pools - -something = $something; - } - - public function run() { - /** ... **/ - } -} - -$pool = new Pool(8, \MyWorker::class, [new Something()]); - -var_dump($pool); -?> -]]> - - &example.outputs; - - - int(8) - ["class":protected]=> - string(8) "MyWorker" - ["workers":protected]=> - NULL - ["work":protected]=> - NULL - ["ctor":protected]=> - array(1) { - [0]=> - object(Something)#2 (0) { - } - } - ["last":protected]=> - int(0) -} -]]> - - - - - - diff --git a/reference/pthreads/pool/resize.xml b/reference/pthreads/pool/resize.xml deleted file mode 100644 index d5be09548360..000000000000 --- a/reference/pthreads/pool/resize.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - Pool::resize - Resize the Pool - - - - &reftitle.description; - - public voidPool::resize - intsize - - - Resize the Pool - - - - - &reftitle.parameters; - - - size - - - The maximum number of Workers this Pool can create - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/pthreads/pool/shutdown.xml b/reference/pthreads/pool/shutdown.xml deleted file mode 100644 index 91550d200146..000000000000 --- a/reference/pthreads/pool/shutdown.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - Pool::shutdown - Shutdown all workers - - - - &reftitle.description; - - public voidPool::shutdown - - - - Shuts down all of the workers in the pool. This will block until all - submitted tasks have been executed. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Shutting down a pool - -submit(new Task()); -} - -$pool->shutdown(); // blocks until all submitted tasks have finished executing -]]> - - - - - diff --git a/reference/pthreads/pool/submit.xml b/reference/pthreads/pool/submit.xml deleted file mode 100644 index ec96bed83c90..000000000000 --- a/reference/pthreads/pool/submit.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - Pool::submit - Submits an object for execution - - - - &reftitle.description; - - public intPool::submit - Threadedtask - - - Submit the task to the next Worker in the Pool - - - - - &reftitle.parameters; - - - task - - - The task for execution - - - - - - - - &reftitle.returnvalues; - - the identifier of the Worker executing the object - - - - - &reftitle.examples; - - Submitting Tasks - -something = $something; - } - - public function run() { - /** ... **/ - } -} - -$pool = new Pool(8, \MyWorker::class, [new Something()]); -$pool->submit(new MyWork()); -var_dump($pool); -?> -]]> - - &example.outputs; - - - int(8) - ["class":protected]=> - string(8) "MyWorker" - ["workers":protected]=> - array(1) { - [0]=> - object(MyWorker)#4 (1) { - ["something"]=> - object(Something)#5 (0) { - } - } - } - ["work":protected]=> - array(1) { - [0]=> - object(MyWork)#3 (1) { - ["worker"]=> - object(MyWorker)#5 (1) { - ["something"]=> - object(Something)#6 (0) { - } - } - } - } - ["ctor":protected]=> - array(1) { - [0]=> - object(Something)#2 (0) { - } - } - ["last":protected]=> - int(1) -} -]]> - - - - - - diff --git a/reference/pthreads/pool/submitTo.xml b/reference/pthreads/pool/submitTo.xml deleted file mode 100644 index cfec954c9f72..000000000000 --- a/reference/pthreads/pool/submitTo.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - Pool::submitTo - Submits a task to a specific worker for execution - - - - &reftitle.description; - - public intPool::submitTo - intworker - Threadedtask - - - Submit a task to the specified worker in the pool. The workers are indexed - from 0, and will only exist if the pool has needed to create them (since - threads are lazily spawned). - - - - - &reftitle.parameters; - - - worker - - - The worker to stack the task onto, indexed from 0. - - - - - task - - - The task for execution. - - - - - - - - &reftitle.returnvalues; - - The identifier of the worker that accepted the task. - - - - - &reftitle.examples; - - Submitting tasks to a specific worker - -submit(new Task()); - -for ($i = 0; $i < 5; ++$i) { - $pool->submitTo(0, new Task()); // stack all tasks onto the first worker -} - -$pool->submitTo(1, new Task()); // cannot stack the task onto the second worker due to it not existing yet - -$pool->shutdown(); -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/pthreads/setup.xml b/reference/pthreads/setup.xml deleted file mode 100644 index 97318f420cb1..000000000000 --- a/reference/pthreads/setup.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - &reftitle.setup; - -
    - &reftitle.required; - - pthreads 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. - - - - pthreads 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; - - pthreads releases are hosted by PECL and the source code by - github, - the easiest route to installation is the normal PECL route: - &url.pecl.package;pthreads. - - - 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/pthreads/thread.xml b/reference/pthreads/thread.xml deleted file mode 100644 index 3093a869ebda..000000000000 --- a/reference/pthreads/thread.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - The Thread class - Thread - - - - -
    - &reftitle.intro; - - When the start method of a Thread is invoked, the run method code will be executed in separate Thread, in parallel. - - - After the run method is executed the Thread will exit immediately, it will be joined with the creating Thread at the appropriate time. - - - - Relying on the engine to determine when a Thread should join may cause undesirable behaviour; the programmer should be explicit, where possible. - - -
    - - -
    - &reftitle.classsynopsis; - - - - Thread - - - - - Thread - - - - extends - Threaded - - - - Countable - - - - Traversable - - - - ArrayAccess - - - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -
    - - &reference.pthreads.entities.thread; - -
    - diff --git a/reference/pthreads/thread/getcreatorid.xml b/reference/pthreads/thread/getcreatorid.xml deleted file mode 100644 index 5fe20d26a8b5..000000000000 --- a/reference/pthreads/thread/getcreatorid.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - Thread::getCreatorId - Identification - - - - &reftitle.description; - - public intThread::getCreatorId - - - - Will return the identity of the Thread that created the referenced Thread - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A numeric identity - - - - - &reftitle.examples; - - Return the identity of the Thread or Process that created the referenced Thread - -getCreatorId()); - } -} -$my = new My(); -$my->start(); -?> -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/pthreads/thread/getcurrentthread.xml b/reference/pthreads/thread/getcurrentthread.xml deleted file mode 100644 index 74b19ea612c0..000000000000 --- a/reference/pthreads/thread/getcurrentthread.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - Thread::getCurrentThread - Identification - - - - &reftitle.description; - - public static ThreadThread::getCurrentThread - - - - Return a reference to the currently executing Thread - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - An object representing the currently executing Thread - - - - - &reftitle.examples; - - Return the currently executing Thread - -start(); -?> -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/pthreads/thread/getcurrentthreadid.xml b/reference/pthreads/thread/getcurrentthreadid.xml deleted file mode 100644 index 1cc35796e48c..000000000000 --- a/reference/pthreads/thread/getcurrentthreadid.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - Thread::getCurrentThreadId - Identification - - - - &reftitle.description; - - public static intThread::getCurrentThreadId - - - - Will return the identity of the currently executing Thread - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A numeric identity - - - - - &reftitle.examples; - - Return the identity of the currently executing Thread - -start(); -?> -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/pthreads/thread/getthreadid.xml b/reference/pthreads/thread/getthreadid.xml deleted file mode 100644 index 3beab6e40373..000000000000 --- a/reference/pthreads/thread/getthreadid.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - Thread::getThreadId - Identification - - - - &reftitle.description; - - public intThread::getThreadId - - - - Will return the identity of the referenced Thread - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A numeric identity - - - - - &reftitle.examples; - - Return the identity of the referenced Thread - -getThreadId()); - } -} -$my = new My(); -$my->start(); -?> -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/pthreads/thread/isjoined.xml b/reference/pthreads/thread/isjoined.xml deleted file mode 100644 index d687caf89dbb..000000000000 --- a/reference/pthreads/thread/isjoined.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - Thread::isJoined - State Detection - - - - &reftitle.description; - - public boolThread::isJoined - - - - Tell if the referenced Thread has been joined - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Detect the state of the referenced Thread - -synchronized(function($thread){ - if (!$thread->done) - $thread->wait(); - }, $this); - } -} -$my = new My(); -$my->start(); -var_dump($my->isJoined()); -$my->synchronized(function($thread){ - $thread->done = true; - $thread->notify(); -}, $my); -?> -]]> - - &example.outputs; - - - - - - - diff --git a/reference/pthreads/thread/isstarted.xml b/reference/pthreads/thread/isstarted.xml deleted file mode 100644 index adc3efab4ceb..000000000000 --- a/reference/pthreads/thread/isstarted.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - Thread::isStarted - State Detection - - - - &reftitle.description; - - public boolThread::isStarted - - - - Tell if the referenced Thread was started - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Tell if the referenced Thread was started - -start(); -var_dump($worker->isStarted()); -?> -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/pthreads/thread/join.xml b/reference/pthreads/thread/join.xml deleted file mode 100644 index b73729fcd0f6..000000000000 --- a/reference/pthreads/thread/join.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - Thread::join - Synchronization - - - - &reftitle.description; - - public boolThread::join - - - - Causes the calling context to wait for the referenced Thread to finish executing - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Join with the referenced Thread - -start(); -/* ... */ -var_dump($my->join()); -/* ... */ -?> -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/pthreads/thread/start.xml b/reference/pthreads/thread/start.xml deleted file mode 100644 index 3fc234e73935..000000000000 --- a/reference/pthreads/thread/start.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - Thread::start - Execution - - - - &reftitle.description; - - public boolThread::start - intoptions - - - Will start a new Thread to execute the implemented run method - - - - - &reftitle.parameters; - - - options - - - An optional mask of inheritance constants, by default PTHREADS_INHERIT_ALL - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Starting Threads - -start()); -?> -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/pthreads/threaded.xml b/reference/pthreads/threaded.xml deleted file mode 100644 index 9988c1757c40..000000000000 --- a/reference/pthreads/threaded.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - The Threaded class - Threaded - - - - -
    - &reftitle.intro; - - Threaded objects form the basis of pthreads ability to execute user code in parallel; they expose synchronization methods and various useful interfaces. - - - Threaded objects, most importantly, provide implicit safety for the programmer; all operations on the object scope are safe. - -
    - - -
    - &reftitle.classsynopsis; - - - - Threaded - - - - - Threaded - - - - Collectable - - - - Traversable - - - - Countable - - - - ArrayAccess - - - - - &Methods; - - - - -
    - -
    - - &reference.pthreads.entities.threaded; - -
    - diff --git a/reference/pthreads/threaded/chunk.xml b/reference/pthreads/threaded/chunk.xml deleted file mode 100644 index 48487c151fc9..000000000000 --- a/reference/pthreads/threaded/chunk.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - Threaded::chunk - Manipulation - - - - &reftitle.description; - - public arrayThreaded::chunk - intsize - boolpreserve - - - Fetches a chunk of the objects property table of the given size, optionally preserving keys - - - - - &reftitle.parameters; - - - size - - - The number of items to fetch - - - - - preserve - - - Preserve the keys of members, by default false - - - - - - - - &reftitle.returnvalues; - - An array of items from the objects property table - - - - - &reftitle.examples; - - Fetch a chunk of the property table - -chunk(5)); -?> -]]> - - &example.outputs; - - - int(0) - [1]=> - int(1) - [2]=> - int(2) - [3]=> - int(3) - [4]=> - int(4) -} -]]> - - - - - - diff --git a/reference/pthreads/threaded/count.xml b/reference/pthreads/threaded/count.xml deleted file mode 100644 index 0d6400ef2755..000000000000 --- a/reference/pthreads/threaded/count.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - Threaded::count - Manipulation - - - - &reftitle.description; - - public intThreaded::count - - - - Returns the number of properties for this object - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Counting the properties of an object - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/pthreads/threaded/extend.xml b/reference/pthreads/threaded/extend.xml deleted file mode 100644 index 51c5bcc70b48..000000000000 --- a/reference/pthreads/threaded/extend.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - Threaded::extend - Runtime Manipulation - - - - &reftitle.description; - - public boolThreaded::extend - stringclass - - - Makes thread safe standard class at runtime - - - - - &reftitle.parameters; - - - class - - - The class to extend - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Runtime inheritance - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/pthreads/threaded/isrunning.xml b/reference/pthreads/threaded/isrunning.xml deleted file mode 100644 index 6f1282eec5d5..000000000000 --- a/reference/pthreads/threaded/isrunning.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - Threaded::isRunning - State Detection - - - - &reftitle.description; - - public boolThreaded::isRunning - - - - Tell if the referenced object is executing - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A boolean indication of state - - - An object is considered running while executing the run method - - - - - - - &reftitle.examples; - - Detect the state of the referenced object - -synchronized(function($thread){ - if (!$thread->done) - $thread->wait(); - }, $this); - } -} -$my = new My(); -$my->start(); -var_dump($my->isRunning()); -$my->synchronized(function($thread){ - $thread->done = true; - $thread->notify(); -}, $my); -?> -]]> - - &example.outputs; - - - - - - - diff --git a/reference/pthreads/threaded/isterminated.xml b/reference/pthreads/threaded/isterminated.xml deleted file mode 100644 index d3d04f4089af..000000000000 --- a/reference/pthreads/threaded/isterminated.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - Threaded::isTerminated - State Detection - - - - &reftitle.description; - - public boolThreaded::isTerminated - - - - Tell if the referenced object was terminated during execution; suffered fatal errors, or threw uncaught exceptions - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A boolean indication of state - - - - - &reftitle.examples; - - Detect the state of the referenced object - -start(); -$my->join(); -var_dump($my->isTerminated()); -?> -]]> - - &example.outputs; - - - - - - - diff --git a/reference/pthreads/threaded/merge.xml b/reference/pthreads/threaded/merge.xml deleted file mode 100644 index 4101731a255d..000000000000 --- a/reference/pthreads/threaded/merge.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - Threaded::merge - Manipulation - - - - &reftitle.description; - - public boolThreaded::merge - mixedfrom - booloverwrite - - - Merges data into the current object - - - - - &reftitle.parameters; - - - from - - - The data to merge - - - - - overwrite - - - Overwrite existing keys, by default true - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Merging into the property table of a threaded object - -foo = "foo"; -$stdClass->bar = "bar"; -$stdClass->baz = "baz"; - -$safe = new Threaded(); -$safe->merge($array); - -$safe->foo = "bar"; -$safe->merge($stdClass, false); - -var_dump($safe); -?> -]]> - - &example.outputs; - - - int(0) - ["1"]=> - int(1) - ["2"]=> - int(2) - ["3"]=> - int(3) - ["4"]=> - int(4) - ["5"]=> - int(5) - ["6"]=> - int(6) - ["7"]=> - int(7) - ["8"]=> - int(8) - ["9"]=> - int(9) - ["foo"]=> - string(3) "bar" - ["bar"]=> - string(3) "bar" - ["baz"]=> - string(3) "baz" -} -]]> - - - - - diff --git a/reference/pthreads/threaded/notify.xml b/reference/pthreads/threaded/notify.xml deleted file mode 100644 index d02455943d11..000000000000 --- a/reference/pthreads/threaded/notify.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - Threaded::notify - Synchronization - - - - &reftitle.description; - - public boolThreaded::notify - - - - Send notification to the referenced object - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Notifications and Waiting - -synchronized(function($thread){ - if (!$thread->done) - $thread->wait(); - }, $this); - } -} -$my = new My(); -$my->start(); -/** send notification to the waiting thread **/ -$my->synchronized(function($thread){ - $thread->done = true; - $thread->notify(); -}, $my); -var_dump($my->join()); -?> -]]> - - &example.outputs; - - - - - - - diff --git a/reference/pthreads/threaded/notifyone.xml b/reference/pthreads/threaded/notifyone.xml deleted file mode 100644 index 3b990dfb63a2..000000000000 --- a/reference/pthreads/threaded/notifyone.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - Threaded::notifyOne - Synchronization - - - - &reftitle.description; - - public boolThreaded::notifyOne - - - - Send notification to the referenced object. This unblocks at least one of the - blocked threads (as opposed to unblocking all of them, as seen with - Threaded::notify). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Notifications and Waiting - -synchronized(function($thread){ - if (!$thread->done) - $thread->wait(); - }, $this); - } -} -$my = new My(); -$my->start(); -/** send notification to the waiting thread **/ -$my->synchronized(function($thread){ - $thread->done = true; - $thread->notifyOne(); -}, $my); -var_dump($my->join()); -?> -]]> - - &example.outputs; - - - - - - - diff --git a/reference/pthreads/threaded/pop.xml b/reference/pthreads/threaded/pop.xml deleted file mode 100644 index b318051948ae..000000000000 --- a/reference/pthreads/threaded/pop.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - Threaded::pop - Manipulation - - - - &reftitle.description; - - public boolThreaded::pop - - - - Pops an item from the objects property table - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The last item from the objects property table - - - - - &reftitle.examples; - - Popping the last item from the property table of a threaded object - -pop()); -?> -]]> - - &example.outputs; - - - - - - - diff --git a/reference/pthreads/threaded/run.xml b/reference/pthreads/threaded/run.xml deleted file mode 100644 index 85f42b008529..000000000000 --- a/reference/pthreads/threaded/run.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - Threaded::run - Execution - - - - &reftitle.description; - - public voidThreaded::run - - - - The programmer should always implement the run method for objects that are intended for execution. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The methods return value, if used, will be ignored - - - - - - diff --git a/reference/pthreads/threaded/shift.xml b/reference/pthreads/threaded/shift.xml deleted file mode 100644 index a1f4d9b9648f..000000000000 --- a/reference/pthreads/threaded/shift.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - Threaded::shift - Manipulation - - - - &reftitle.description; - - public mixedThreaded::shift - - - - Shifts an item from the objects property table - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The first item from the objects property table - - - - - &reftitle.examples; - - Shifting the first item from the property table of a threaded object - -shift()); -?> -]]> - - &example.outputs; - - - - - - - diff --git a/reference/pthreads/threaded/synchronized.xml b/reference/pthreads/threaded/synchronized.xml deleted file mode 100644 index 19024ab483ca..000000000000 --- a/reference/pthreads/threaded/synchronized.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - Threaded::synchronized - Synchronization - - - - &reftitle.description; - - public mixedThreaded::synchronized - Closureblock - mixedargs - - - Executes the block while retaining the referenced objects synchronization lock for the calling context - - - - - &reftitle.parameters; - - - block - - - The block of code to execute - - - - - args - - - Variable length list of arguments to use as function arguments to the block - - - - - - - - &reftitle.returnvalues; - - The return value from the block - - - - - &reftitle.examples; - - Synchronizing - -synchronized(function($thread){ - if (!$thread->done) - $thread->wait(); - }, $this); - } -} -$my = new My(); -$my->start(); -$my->synchronized(function($thread){ - $thread->done = true; - $thread->notify(); -}, $my); -var_dump($my->join()); -?> -]]> - - &example.outputs; - - - - - - - diff --git a/reference/pthreads/threaded/wait.xml b/reference/pthreads/threaded/wait.xml deleted file mode 100644 index a6e5de14f880..000000000000 --- a/reference/pthreads/threaded/wait.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - Threaded::wait - Synchronization - - - - &reftitle.description; - - public boolThreaded::wait - inttimeout - - - Will cause the calling context to wait for notification from the referenced object - - - - - &reftitle.parameters; - - - timeout - - - An optional timeout in microseconds - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Notifications and Waiting - -synchronized(function($thread){ - if (!$thread->done) - $thread->wait(); - }, $this); - } -} -$my = new My(); -$my->start(); -/** send notification to the waiting thread **/ -$my->synchronized(function($thread){ - $thread->done = true; - $thread->notify(); -}, $my); -var_dump($my->join()); -?> -]]> - - &example.outputs; - - - - - - - diff --git a/reference/pthreads/versions.xml b/reference/pthreads/versions.xml deleted file mode 100644 index f14b5742e1cc..000000000000 --- a/reference/pthreads/versions.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/pthreads/volatile.xml b/reference/pthreads/volatile.xml deleted file mode 100644 index 9d1dd0a50700..000000000000 --- a/reference/pthreads/volatile.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - The Volatile class - Volatile - - - -
    - &reftitle.intro; - - The Volatile class is new to pthreads v3. Its - introduction is a consequence of the new immutability semantics of - Threaded members of Threaded - classes. The Volatile class enables for mutability - of its Threaded members, and is also used to store - PHP arrays in Threaded contexts. - -
    - -
    - &reftitle.classsynopsis; - - - Volatile - - - - Volatile - - - - extends - Threaded - - - - Collectable - - - - Traversable - - - - &InheritedMethods; - - - -
    - -
    - &reftitle.examples; - - New immutability semantics of Threaded - -data = new Threaded(); - - // attempt to overwrite a Threaded property of a Threaded class (invalid) - $this->data = new stdClass(); - } -} - -var_dump((new Task())->data); -]]> - - &example.outputs.similar; - - - - - - Volatile use-case - -data = new Threaded(); - - // attempt to overwrite a Threaded property of a Volatile class (valid) - $this->data = new stdClass(); - } -} - -var_dump((new Task())->data); -]]> - - &example.outputs.similar; - - - - -
    - -
    - -
    - diff --git a/reference/pthreads/worker.xml b/reference/pthreads/worker.xml deleted file mode 100644 index a0f511a5599a..000000000000 --- a/reference/pthreads/worker.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - The Worker class - Worker - - - - -
    - &reftitle.intro; - - Worker Threads have a persistent context, as such should be used over Threads in most cases. - - - When a Worker is started, the run method will be executed, but the Thread will not leave until one of the following conditions are met: - - - - the Worker goes out of scope (no more references remain) - - - the programmer calls shutdown - - - the script dies - - - - This means the programmer can reuse the context throughout execution; placing objects on the stack of the Worker will cause the Worker to - execute the stacked objects run method. - -
    - - -
    - &reftitle.classsynopsis; - - - - Worker - - - - - Worker - - - - extends - Thread - - - - Traversable - - - - Countable - - - - ArrayAccess - - - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -
    - - &reference.pthreads.entities.worker; - -
    - diff --git a/reference/pthreads/worker/collect.xml b/reference/pthreads/worker/collect.xml deleted file mode 100644 index 3eabd66ddd82..000000000000 --- a/reference/pthreads/worker/collect.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - Worker::collect - Collect references to completed tasks - - - - &reftitle.description; - - public intWorker::collect - Callablecollector - - - Allows the worker to collect references determined to be garbage by the - optionally given collector. - - - - - &reftitle.parameters; - - - collector - - - A Callable collector that returns a boolean on whether the task can be - collected or not. Only in rare cases should a custom collector need to - be used. - - - - - - - - &reftitle.returnvalues; - - The number of remaining tasks on the worker's stack to be collected. - - - - - &reftitle.examples; - - A basic example of <methodname>Worker::collect</methodname> - -collect()} tasks on the stack to be collected\n"; - -for ($i = 0; $i < 15; ++$i) { - $worker->stack(new class extends Threaded {}); -} - -echo "There are {$worker->collect()} tasks remaining on the stack to be collected\n"; - -$worker->start(); - -while ($worker->collect()); // blocks until all tasks have finished executing - -echo "There are now {$worker->collect()} tasks on the stack to be collected\n"; - -$worker->shutdown(); -]]> - - &example.outputs; - - - - - - - diff --git a/reference/pthreads/worker/getstacked.xml b/reference/pthreads/worker/getstacked.xml deleted file mode 100644 index b685a3e79745..000000000000 --- a/reference/pthreads/worker/getstacked.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - Worker::getStacked - Gets the remaining stack size - - - - &reftitle.description; - - public intWorker::getStacked - - - - Returns the number of tasks left on the stack - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the number of tasks currently waiting to be executed by the worker - - - - - &reftitle.examples; - - A basic example of <classname>Worker::getStacked</classname> - -stack(new class extends Threaded {}); -} - -echo "There are {$worker->getStacked()} stacked tasks\n"; -]]> - - &example.outputs; - - - - - - - diff --git a/reference/pthreads/worker/isshutdown.xml b/reference/pthreads/worker/isshutdown.xml deleted file mode 100644 index 7387dc1d9b1d..000000000000 --- a/reference/pthreads/worker/isshutdown.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - Worker::isShutdown - State Detection - - - - &reftitle.description; - - public boolWorker::isShutdown - - - - Whether the worker has been shutdown or not. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns whether the worker has been shutdown or not. - - - - - &reftitle.examples; - - Detect the state of a worker - -start(); - -var_dump($worker->isShutdown()); - -$worker->shutdown(); - -var_dump($worker->isShutdown()); -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/pthreads/worker/shutdown.xml b/reference/pthreads/worker/shutdown.xml deleted file mode 100644 index efe438c5a863..000000000000 --- a/reference/pthreads/worker/shutdown.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - Worker::shutdown - Shutdown the worker - - - - &reftitle.description; - - public boolWorker::shutdown - - - - Shuts down the worker after executing all of the stacked tasks. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Shutdown the referenced worker - -start(); -/* stack/execute tasks */ -var_dump($my->shutdown()); -]]> - - &example.outputs; - - - - - - - diff --git a/reference/pthreads/worker/stack.xml b/reference/pthreads/worker/stack.xml deleted file mode 100644 index 5f52d80aea9a..000000000000 --- a/reference/pthreads/worker/stack.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - Worker::stack - Stacking work - - - - &reftitle.description; - - public intWorker::stack - Threadedwork - - - Appends the new work to the stack of the referenced worker. - - - - - &reftitle.parameters; - - - work - - - A Threaded object to be executed by the worker. - - - - - - - - &reftitle.returnvalues; - - The new size of the stack. - - - - - &reftitle.examples; - - Stacking a task for execution onto a worker - -stack($work));]]> - - &example.outputs; - - - - - - - diff --git a/reference/pthreads/worker/unstack.xml b/reference/pthreads/worker/unstack.xml deleted file mode 100644 index 8eda43e85276..000000000000 --- a/reference/pthreads/worker/unstack.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - Worker::unstack - Unstacking work - - - - &reftitle.description; - - public intWorker::unstack - - - - Removes the first task (the oldest one) in the stack. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The new size of the stack. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL pthreads 3.0.0 - - The parameter to specify the task to unstack has been removed. Now, only the - first task in the stack is removed. - - - - - - - - - &reftitle.examples; - - Removing objects from the stack of Workers - -stack($work)); -var_dump($my->unstack()); -]]> - - &example.outputs; - - - - - - - diff --git a/reference/quickhash/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/quickhash/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/quickhash/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/quickhash/book.xml b/reference/quickhash/book.xml deleted file mode 100644 index 06d1b87a66b8..000000000000 --- a/reference/quickhash/book.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - Quickhash - Quickhash - - - &reftitle.intro; - - The quickhash extension contains a set of specific strongly-typed classes - to deal with specific set and hash implementations. - - - - &reference.quickhash.setup; - &reference.quickhash.examples; - - &reference.quickhash.quickhashintset; - &reference.quickhash.quickhashinthash; - &reference.quickhash.quickhashstringinthash; - &reference.quickhash.quickhashintstringhash; - - diff --git a/reference/quickhash/examples.xml b/reference/quickhash/examples.xml deleted file mode 100644 index d3344306b32f..000000000000 --- a/reference/quickhash/examples.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - &reftitle.examples; - - Quickhash Example - -add( 1 ); -$set->add( 3 ); - -var_dump( $set->exists( 3 ) ); -var_dump( $set->exists( 4 ) ); - -$set->saveToFile( "/tmp/test-set.set" ); - -$newSet = QuickHashIntSet::loadFromFile( - "/tmp/test-set.set" -); - -var_dump( $newSet->exists( 3 ) ); -var_dump( $newSet->exists( 4 ) ); -?> -]]> - - &example.outputs.similar; - - - - - - Quickhash ArrayAccess Example - - -]]> - - &example.outputs.similar; - - - - - - Quickhash Iterator Example - - $value ) -{ - echo $key, ' => ', $value, "\n"; -} -?> -]]> - - &example.outputs.similar; - - -4234 -4 => 712314 -1 => 145926 -2 => 1415926 -3 => 72 -]]> - - - - Quickhash String Values Example - -add( 2, "one more" ); - -foreach( $hash as $key => $value ) -{ - echo $key, ' => ', $value, "\n"; -} -?> -]]> - - &example.outputs.similar; - - one million four hundred fifteen thousand nine hundred twenty six -2 => one more -]]> - - - - - diff --git a/reference/quickhash/quickhashinthash.xml b/reference/quickhash/quickhashinthash.xml deleted file mode 100644 index e11d18640de4..000000000000 --- a/reference/quickhash/quickhashinthash.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - - The QuickHashIntHash class - QuickHashIntHash - - - - -
    - &reftitle.intro; - - This class wraps around a hash containing integer numbers, where the - values are also integer numbers. Hashes are also available as - implementation of the ArrayAccess interface. - - - Hashes can also be iterated over with foreach as the Iterator interface is - implemented as well. The order of which elements are returned in is not - guaranteed. - -
    - - -
    - &reftitle.classsynopsis; - - - - QuickHashIntHash - - - - - QuickHashIntHash - - - - &Constants; - - const - int - QuickHashIntHash::CHECK_FOR_DUPES - 1 - - - const - int - QuickHashIntHash::DO_NOT_USE_ZEND_ALLOC - 2 - - - const - int - QuickHashIntHash::HASHER_NO_HASH - 256 - - - const - int - QuickHashIntHash::HASHER_JENKINS1 - 512 - - - const - int - QuickHashIntHash::HASHER_JENKINS2 - 1024 - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - QuickHashIntHash::CHECK_FOR_DUPES - - If enabled, adding duplicate elements to a set (through either QuickHashIntHash::add or - QuickHashIntHash::loadFromFile) will result in those elements to be dropped from the - set. This will take up extra time, so only used when it is required. - - - - - QuickHashIntHash::DO_NOT_USE_ZEND_ALLOC - - Disables the use of PHP's internal memory manager for internal - set structures. With this option enabled, internal allocations will not - count towards the memory_limit settings. - - - - - QuickHashIntHash::HASHER_NO_HASH - - Selects to not use a hashing function, but merely use a modulo to - find the bucket list index. This is not faster than normal hashing, and - gives more collisions. - - - - - QuickHashIntHash::HASHER_JENKINS1 - - This is the default hashing function to turn the integer hashes - into bucket list indexes. - - - - - QuickHashIntHash::HASHER_JENKINS2 - - Selects a variant hashing algorithm. - - - - -
    - - - -
    - - &reference.quickhash.entities.quickhashinthash; - -
    - diff --git a/reference/quickhash/quickhashinthash/add.xml b/reference/quickhash/quickhashinthash/add.xml deleted file mode 100644 index d85702ec4475..000000000000 --- a/reference/quickhash/quickhashinthash/add.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - QuickHashIntHash::add - This method adds a new entry to the hash - - - - &reftitle.description; - - public boolQuickHashIntHash::add - intkey - intvalue - - - This method adds a new entry to the hash, and returns whether the entry was - added. Entries are by default always added unless - QuickHashIntHash::CHECK_FOR_DUPES has been passed when the hash was created. - - - - - &reftitle.parameters; - - - key - - - The key of the entry to add. - - - - - value - - - The optional value of the entry to add. If no value is specified, - 1 will be used. - - - - - - - - &reftitle.returnvalues; - - &true; when the entry was added, and &false; if the entry was not added. - - - - - &reftitle.examples; - - <function>QuickHashIntHash::add</function> example - -exists( 4 ) ); -var_dump( $hash->get( 4 ) ); -var_dump( $hash->add( 4, 22 ) ); -var_dump( $hash->exists( 4 ) ); -var_dump( $hash->get( 4 ) ); -var_dump( $hash->add( 4, 12 ) ); - -echo "\nwith dupe checking\n"; -$hash = new QuickHashIntHash( 1024, QuickHashIntHash::CHECK_FOR_DUPES ); -var_dump( $hash->exists( 4 ) ); -var_dump( $hash->get( 4 ) ); -var_dump( $hash->add( 4, 78 ) ); -var_dump( $hash->exists( 4 ) ); -var_dump( $hash->get( 4 ) ); -var_dump( $hash->add( 4, 9 ) ); - -echo "\ndefault value\n"; -var_dump( $hash->add( 5 ) ); -var_dump( $hash->get( 5 ) ); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/quickhash/quickhashinthash/construct.xml b/reference/quickhash/quickhashinthash/construct.xml deleted file mode 100644 index 7ba6b1ce9ec2..000000000000 --- a/reference/quickhash/quickhashinthash/construct.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - QuickHashIntHash::__construct - Creates a new QuickHashIntHash object - - - - &reftitle.description; - - public QuickHashIntHash::__construct - intsize - intoptions - - - This constructor creates a new QuickHashIntHash. The size is the amount of - bucket lists to create. The more lists there are, the less collisions you - will have. Options are also supported. - - - - - &reftitle.parameters; - - - size - - - The amount of bucket lists to configure. The number you pass in will be - automatically rounded up to the next power of two. It is also - automatically limited from 64 to 4194304. - - - - - options - - - The options that you can pass in are: QuickHashIntHash::CHECK_FOR_DUPES, - which makes sure no duplicate entries are added to the hash; - QuickHashIntHash::DO_NOT_USE_ZEND_ALLOC to not use PHP's internal memory - manager as well as one of QuickHashIntHash::HASHER_NO_HASH, - QuickHashIntHash::HASHER_JENKINS1 or QuickHashIntHash::HASHER_JENKINS2. - These last three configure which hashing algorithm to use. All options - can be combined using bitmasks. - - - - - - - - &reftitle.returnvalues; - - Returns a new QuickHashIntHash object. - - - - - &reftitle.examples; - - <function>QuickHashIntHash::__construct</function> example - - -]]> - - - - - - - diff --git a/reference/quickhash/quickhashinthash/delete.xml b/reference/quickhash/quickhashinthash/delete.xml deleted file mode 100644 index 6f6f7c0c9b75..000000000000 --- a/reference/quickhash/quickhashinthash/delete.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - QuickHashIntHash::delete - This method deletes an entry from the hash - - - - &reftitle.description; - - public boolQuickHashIntHash::delete - intkey - - - This method deletes an entry from the hash, and returns whether the entry was - deleted or not. Associated memory structures will not be freed immediately, - but rather when the hash itself is freed. - - - Elements can not be deleted when the hash is used in an iterator. The - method will not throw an exception, but simply return &false; like would - happen with any other deletion failure. - - - - - &reftitle.parameters; - - - key - - - The key of the entry to delete. - - - - - - - - &reftitle.returnvalues; - - &true; when the entry was deleted, and &false; if the entry was not deleted. - - - - - &reftitle.examples; - - <function>QuickHashIntHash::delete</function> example - -exists( 4 ) ); -var_dump( $hash->add( 4, 5 ) ); -var_dump( $hash->delete( 4 ) ); -var_dump( $hash->exists( 4 ) ); -var_dump( $hash->delete( 4 ) ); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/quickhash/quickhashinthash/exists.xml b/reference/quickhash/quickhashinthash/exists.xml deleted file mode 100644 index 9feabc65a1f8..000000000000 --- a/reference/quickhash/quickhashinthash/exists.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - QuickHashIntHash::exists - This method checks whether a key is part of the hash - - - - &reftitle.description; - - public boolQuickHashIntHash::exists - intkey - - - This method checks whether an entry with the provided key exists in the - hash. - - - - - &reftitle.parameters; - - - key - - - The key of the entry to check for whether it exists in the hash. - - - - - - - - &reftitle.returnvalues; - - Returns &true; when the entry was found, or &false; when the entry is not - found. - - - - - &reftitle.examples; - - <function>QuickHashIntHash::exists</function> example - -add( $key, 56 ); -} - -echo "Doing 1000 tests: ", microtime( true ), "\n"; -foreach( $testForEntries as $key ) -{ - $foundCount += $hash->exists( $key ); -} -echo "Done, $foundCount found: ", microtime( true ), "\n"; -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/quickhash/quickhashinthash/get.xml b/reference/quickhash/quickhashinthash/get.xml deleted file mode 100644 index 2b6f23566858..000000000000 --- a/reference/quickhash/quickhashinthash/get.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - QuickHashIntHash::get - This method retrieves a value from the hash by its key - - - - &reftitle.description; - - public intQuickHashIntHash::get - intkey - - - This method retrieves a value from the hash by its key. - - - - - &reftitle.parameters; - - - key - - - The key of the entry to retrieve. - - - - - - - - &reftitle.returnvalues; - - The value if the key exists, or &null; if the key wasn't part of the hash. - - - - - &reftitle.examples; - - <function>QuickHashIntHash::get</function> example - -get( 1 ) ); - -var_dump( $hash->add( 2 ) ); -var_dump( $hash->get( 2 ) ); - -var_dump( $hash->add( 3, 5 ) ); -var_dump( $hash->get( 3 ) ); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/quickhash/quickhashinthash/getsize.xml b/reference/quickhash/quickhashinthash/getsize.xml deleted file mode 100644 index 400939a74b46..000000000000 --- a/reference/quickhash/quickhashinthash/getsize.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - QuickHashIntHash::getSize - Returns the number of elements in the hash - - - - &reftitle.description; - - public intQuickHashIntHash::getSize - - - Returns the number of elements in the hash. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The number of elements in the hash. - - - - - &reftitle.examples; - - <function>QuickHashIntHash::getSize</function> example - -add( 2 ) ); -var_dump( $hash->add( 3, 5 ) ); -var_dump( $hash->getSize() ); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/quickhash/quickhashinthash/loadfromfile.xml b/reference/quickhash/quickhashinthash/loadfromfile.xml deleted file mode 100644 index 2d5c58f8f0fb..000000000000 --- a/reference/quickhash/quickhashinthash/loadfromfile.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - QuickHashIntHash::loadFromFile - This factory method creates a hash from a file - - - - &reftitle.description; - - public static QuickHashIntHashQuickHashIntHash::loadFromFile - stringfilename - intoptions - - - This factory method creates a new hash from a definition file on disk. The - file format consists of a signature 'QH\0x11\0', the number of elements as - a 32 bit signed integer in system Endianness, followed by 32 bit signed - integers packed together in the Endianness that the system that the code - runs on uses. For each hash element there are two 32 bit signed integers - stored. The first of each element is the key, and the second is the value - belonging to the key. An example could be: - - - QuickHash IntHash file format - - - - QuickHash IntHash file format - - - - - - - &reftitle.parameters; - - - filename - - - The filename of the file to read the hash from. - - - - - options - - - The same options that the class' constructor takes; except that the size - option is ignored. It is automatically calculated to be the same as the - number of entries in the hash, rounded up to the nearest power of two - with a maximum limit of 4194304. - - - - - - - - &reftitle.returnvalues; - - Returns a new QuickHashIntHash. - - - - - &reftitle.examples; - - <function>QuickHashIntHash::loadFromFile</function> example - -exists( $key ) ? 'set' : 'unset' - ); -} -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/quickhash/quickhashinthash/loadfromstring.xml b/reference/quickhash/quickhashinthash/loadfromstring.xml deleted file mode 100644 index bc20e9cc3f12..000000000000 --- a/reference/quickhash/quickhashinthash/loadfromstring.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - QuickHashIntHash::loadFromString - This factory method creates a hash from a string - - - - &reftitle.description; - - public static QuickHashIntHashQuickHashIntHash::loadFromString - stringcontents - intoptions - - - This factory method creates a new hash from a definition in a string. The - file format consists of 32 bit signed integers packed together in the - Endianness that the system that the code runs on uses. For each element - there are two 32 bit signed integers stored. The first of each element is - the key, and the second is the value belonging to the key. - - - - - &reftitle.parameters; - - - contents - - - The string containing a serialized format of the hash. - - - - - options - - - The same options that the class' constructor takes; except that the size - option is ignored. It is automatically calculated to be the same as the - number of entries in the hash, rounded up to the nearest power of two - with a maximum limit of 4194304. - - - - - - - - &reftitle.returnvalues; - - Returns a new QuickHashIntHash. - - - - - &reftitle.examples; - - <function>QuickHashIntHash::loadFromString</function> example - -exists( $key ) ? 'set' : 'unset' - ); -} -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/quickhash/quickhashinthash/savetofile.xml b/reference/quickhash/quickhashinthash/savetofile.xml deleted file mode 100644 index fb0d7ac04b13..000000000000 --- a/reference/quickhash/quickhashinthash/savetofile.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - QuickHashIntHash::saveToFile - This method stores an in-memory hash to disk - - - - &reftitle.description; - - public voidQuickHashIntHash::saveToFile - stringfilename - - - This method stores an existing hash to a file on disk, in the same format - that QuickHashIntHash::loadFromFile can read. - - - - - &reftitle.parameters; - - - filename - - - The filename of the file to store the hash in. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <function>QuickHashIntHash::saveToFile</function> example - -exists( 4 ) ); -var_dump( $hash->add( 4, 43 ) ); -var_dump( $hash->exists( 4 ) ); -var_dump( $hash->add( 4, 52 ) ); - -$hash->saveToFile( '/tmp/test.hash' ); -?> -]]> - - - - - - - diff --git a/reference/quickhash/quickhashinthash/savetostring.xml b/reference/quickhash/quickhashinthash/savetostring.xml deleted file mode 100644 index 554657cb7107..000000000000 --- a/reference/quickhash/quickhashinthash/savetostring.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - QuickHashIntHash::saveToString - This method returns a serialized version of the hash - - - - &reftitle.description; - - public stringQuickHashIntHash::saveToString - - - This method returns a serialized version of the hash in the same format that - QuickHashIntHash::loadFromString can read. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - This method returns a string containing a serialized format of the hash. - Each element is stored as a four byte value in the Endianness that the - current system uses. - - - - - &reftitle.examples; - - <function>QuickHashIntHash::saveToString</function> example - -exists( 4 ) ); -var_dump( $hash->add( 4, 34 ) ); -var_dump( $hash->exists( 4 ) ); -var_dump( $hash->add( 4, 55 ) ); - -var_dump( $hash->saveToString() ); -?> -]]> - - - - - - - diff --git a/reference/quickhash/quickhashinthash/set.xml b/reference/quickhash/quickhashinthash/set.xml deleted file mode 100644 index 8cad6bd2aa90..000000000000 --- a/reference/quickhash/quickhashinthash/set.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - QuickHashIntHash::set - This method updates an entry in the hash with a new value, or - adds a new one if the entry doesn't exist - - - - &reftitle.description; - - public intQuickHashIntHash::set - intkey - intvalue - - - This method tries to update an entry with a new value. In case the entry - did not yet exist, it will instead add a new entry. It returns whether the - entry was added or update. If there are duplicate keys, only the first - found element will get an updated value. Use - QuickHashIntHash::CHECK_FOR_DUPES during hash creation to prevent duplicate - keys from being part of the hash. - - - - - &reftitle.parameters; - - - key - - - The key of the entry to add or update. - - - - - value - - - The new value to set the entry with. - - - - - - - - &reftitle.returnvalues; - - 2 if the entry was newly added, 1 if the entry was found and updated, or 0 - if there was an error. - - - - - &reftitle.examples; - - <function>QuickHashIntHash::set</function> example - -Add\n"; -var_dump($hash->get(46692)); -var_dump($hash->set(46692, 16091)); -var_dump($hash->get(46692)); - -echo "\n\nSet->Update\n"; -var_dump($hash->set(46692, 29906)); -var_dump($hash->get(46692)); -]]> - - &example.outputs.similar; - -Add -bool(false) -int(2) -int(16091) - -Set->Update -int(1) -int(29906) -]]> - - - - - - - diff --git a/reference/quickhash/quickhashinthash/update.xml b/reference/quickhash/quickhashinthash/update.xml deleted file mode 100644 index 2f519c976bae..000000000000 --- a/reference/quickhash/quickhashinthash/update.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - QuickHashIntHash::update - This method updates an entry in the hash with a new value - - - - &reftitle.description; - - public boolQuickHashIntHash::update - intkey - intvalue - - - This method updates an entry with a new value, and returns whether the entry was - update. If there are duplicate keys, only the first found element will get - an updated value. Use QuickHashIntHash::CHECK_FOR_DUPES during hash - creation to prevent duplicate keys from being part of the hash. - - - - - &reftitle.parameters; - - - key - - - The key of the entry to update. - - - - - value - - - The new value to update the entry with. - - - - - - - - &reftitle.returnvalues; - - &true; when the entry was found and updated, and &false; if the entry was - not part of the hash already. - - - - - &reftitle.examples; - - <function>QuickHashIntHash::update</function> example - -add( 141421, 173205 ) ); -var_dump( $hash->update( 141421, 223606 ) ); -var_dump( $hash->get( 141421 ) ); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/quickhash/quickhashintset.xml b/reference/quickhash/quickhashintset.xml deleted file mode 100644 index f4f67f0fd375..000000000000 --- a/reference/quickhash/quickhashintset.xml +++ /dev/null @@ -1,153 +0,0 @@ - - - - - The QuickHashIntSet class - QuickHashIntSet - - - - -
    - &reftitle.intro; - - This class wraps around a set containing integer numbers. - - - Sets can also be iterated over with foreach as the Iterator interface is - implemented as well. The order of which elements are returned in is not - guaranteed. - -
    - - -
    - &reftitle.classsynopsis; - - - - QuickHashIntSet - - - - - QuickHashIntSet - - - - &Constants; - - const - int - QuickHashIntSet::CHECK_FOR_DUPES - 1 - - - const - int - QuickHashIntSet::DO_NOT_USE_ZEND_ALLOC - 2 - - - const - int - QuickHashIntSet::HASHER_NO_HASH - 256 - - - const - int - QuickHashIntSet::HASHER_JENKINS1 - 512 - - - const - int - QuickHashIntSet::HASHER_JENKINS2 - 1024 - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - QuickHashIntSet::CHECK_FOR_DUPES - - If enabled, adding duplicate elements to a set (through either QuickHashIntSet::add or - QuickHashIntSet::loadFromFile) will result in those elements to be dropped from the - set. This will take up extra time, so only used when it is required. - - - - - QuickHashIntSet::DO_NOT_USE_ZEND_ALLOC - - Disables the use of PHP's internal memory manager for internal - set structures. With this option enabled, internal allocations will not - count towards the memory_limit settings. - - - - - QuickHashIntSet::HASHER_NO_HASH - - Selects to not use a hashing function, but merely use a modulo to - find the bucket list index. This is not faster than normal hashing, and - gives more collisions. - - - - - QuickHashIntSet::HASHER_JENKINS1 - - This is the default hashing function to turn the integer hashes - into bucket list indexes. - - - - - QuickHashIntSet::HASHER_JENKINS2 - - Selects a variant hashing algorithm. - - - - -
    - - - -
    - - &reference.quickhash.entities.quickhashintset; - -
    - diff --git a/reference/quickhash/quickhashintset/add.xml b/reference/quickhash/quickhashintset/add.xml deleted file mode 100644 index 2a38463881fa..000000000000 --- a/reference/quickhash/quickhashintset/add.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - QuickHashIntSet::add - This method adds a new entry to the set - - - - &reftitle.description; - - public boolQuickHashIntSet::add - intkey - - - This method adds a new entry to the set, and returns whether the entry was - added. Entries are by default always added unless - QuickHashIntSet::CHECK_FOR_DUPES has been passed when the set was created. - - - - - &reftitle.parameters; - - - key - - - The key of the entry to add. - - - - - - - - &reftitle.returnvalues; - - &true; when the entry was added, and &false; if the entry was not added. - - - - - &reftitle.examples; - - <function>QuickHashIntSet::add</function> example - -exists( 4 ) ); -var_dump( $set->add( 4 ) ); -var_dump( $set->exists( 4 ) ); -var_dump( $set->add( 4 ) ); - -echo "\nwith dupe checking\n"; -$set = new QuickHashIntSet( 1024, QuickHashIntSet::CHECK_FOR_DUPES ); -var_dump( $set->exists( 4 ) ); -var_dump( $set->add( 4 ) ); -var_dump( $set->exists( 4 ) ); -var_dump( $set->add( 4 ) ); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/quickhash/quickhashintset/construct.xml b/reference/quickhash/quickhashintset/construct.xml deleted file mode 100644 index be488e71f3ae..000000000000 --- a/reference/quickhash/quickhashintset/construct.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - QuickHashIntSet::__construct - Creates a new QuickHashIntSet object - - - - &reftitle.description; - - public QuickHashIntSet::__construct - intsize - intoptions - - - This constructor creates a new QuickHashIntSet. The size is the amount of - bucket lists to create. The more lists there are, the less collisions you - will have. Options are also supported. - - - - - &reftitle.parameters; - - - size - - - The amount of bucket lists to configure. The number you pass in will be - automatically rounded up to the next power of two. It is also - automatically limited from 4 to 4194304. - - - - - options - - - The options that you can pass in are: QuickHashIntSet::CHECK_FOR_DUPES, - which makes sure no duplicate entries are added to the set; - QuickHashIntSet::DO_NOT_USE_ZEND_ALLOC to not use PHP's internal memory - manager as well as one of QuickHashIntSet::HASHER_NO_HASH, - QuickHashIntSet::HASHER_JENKINS1 or QuickHashIntSet::HASHER_JENKINS2. - These last three configure which hashing algorithm to use. All options - can be combined using bitmasks. - - - - - - - - &reftitle.returnvalues; - - Returns a new QuickHashIntSet object. - - - - - &reftitle.examples; - - <function>QuickHashIntSet::__construct</function> example - - -]]> - - - - - - - diff --git a/reference/quickhash/quickhashintset/delete.xml b/reference/quickhash/quickhashintset/delete.xml deleted file mode 100644 index a54d42390219..000000000000 --- a/reference/quickhash/quickhashintset/delete.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - QuickHashIntSet::delete - This method deletes an entry from the set - - - - &reftitle.description; - - public boolQuickHashIntSet::delete - intkey - - - This method deletes an entry from the set, and returns whether the entry was - deleted or not. Associated memory structures will not be freed immediately, - but rather when the set itself is freed. - - - - - &reftitle.parameters; - - - key - - - The key of the entry to delete. - - - - - - - - &reftitle.returnvalues; - - &true; when the entry was deleted, and &false; if the entry was not deleted. - - - - - &reftitle.examples; - - <function>QuickHashIntSet::delete</function> example - -exists( 4 ) ); -var_dump( $set->add( 4 ) ); -var_dump( $set->delete( 4 ) ); -var_dump( $set->exists( 4 ) ); -var_dump( $set->delete( 4 ) ); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/quickhash/quickhashintset/exists.xml b/reference/quickhash/quickhashintset/exists.xml deleted file mode 100644 index 80462da314b5..000000000000 --- a/reference/quickhash/quickhashintset/exists.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - QuickHashIntSet::exists - This method checks whether a key is part of the set - - - - &reftitle.description; - - public boolQuickHashIntSet::exists - intkey - - - This method checks whether an entry with the provided key exists in the - set. - - - - - &reftitle.parameters; - - - key - - - The key of the entry to check for whether it exists in the set. - - - - - - - - &reftitle.returnvalues; - - Returns &true; when the entry was found, or &false; when the entry is not - found. - - - - - &reftitle.examples; - - <function>QuickHashIntSet::exists</function> example - -add( $key ); -} - -echo "Doing 1000 tests: ", microtime( true ), "\n"; -foreach( $testForEntries as $key ) -{ - $foundCount += $set->exists( $key ); -} -echo "Done, $foundCount found: ", microtime( true ), "\n"; -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/quickhash/quickhashintset/getsize.xml b/reference/quickhash/quickhashintset/getsize.xml deleted file mode 100644 index 4a9c6d7470a0..000000000000 --- a/reference/quickhash/quickhashintset/getsize.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - QuickHashIntSet::getSize - Returns the number of elements in the set - - - - &reftitle.description; - - publicintQuickHashIntSet::getSize - - - Returns the number of elements in the set. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The number of elements in the set. - - - - - &reftitle.examples; - - <function>QuickHashIntSet::getSize</function> example - -add( 2 ) ); -var_dump( $set->add( 3 ) ); -var_dump( $set->getSize() ); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/quickhash/quickhashintset/loadfromfile.xml b/reference/quickhash/quickhashintset/loadfromfile.xml deleted file mode 100644 index b083b4306d03..000000000000 --- a/reference/quickhash/quickhashintset/loadfromfile.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - QuickHashIntSet::loadFromFile - This factory method creates a set from a file - - - - &reftitle.description; - - public static QuickHashIntSetQuickHashIntSet::loadFromFile - stringfilename - intsize - intoptions - - - This factory method creates a new set from a definition file on disk. The - file format consists of 32 bit signed integers packed together in the - Endianness that the system that the code runs on uses. - - - - - &reftitle.parameters; - - - filename - - - The filename of the file to read the set from. - - - - - size - - - The amount of bucket lists to configure. The number you pass in will be - automatically rounded up to the next power of two. It is also - automatically limited from 4 to 4194304. - - - - - options - - - The same options that the class' constructor takes; except that the size - option is ignored. It is automatically calculated to be the same as the - number of entries in the set, rounded up to the nearest power of two - with a maximum limit of 4194304. - - - - - - - - &reftitle.returnvalues; - - Returns a new QuickHashIntSet. - - - - - &reftitle.examples; - - <function>QuickHashIntSet::loadFromFile</function> example - -exists( $key ) ? 'set' : 'unset' - ); -} -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/quickhash/quickhashintset/loadfromstring.xml b/reference/quickhash/quickhashintset/loadfromstring.xml deleted file mode 100644 index d3d0001c3211..000000000000 --- a/reference/quickhash/quickhashintset/loadfromstring.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - QuickHashIntSet::loadFromString - This factory method creates a set from a string - - - - &reftitle.description; - - public static QuickHashIntSetQuickHashIntSet::loadFromString - stringcontents - intsize - intoptions - - - This factory method creates a new set from a definition in a string. The - file format consists of 32 bit signed integers packed together in the - Endianness that the system that the code runs on uses. - - - - - &reftitle.parameters; - - - contents - - - The string containing a serialized format of the set. - - - - - size - - - The amount of bucket lists to configure. The number you pass in will be - automatically rounded up to the next power of two. It is also - automatically limited from 4 to 4194304. - - - - - options - - - The same options that the class' constructor takes; except that the size - option is ignored. It is automatically calculated to be the same as the - number of entries in the set, rounded up to the nearest power of two - automatically limited from 64 to 4194304. - - - - - - - - &reftitle.returnvalues; - - Returns a new QuickHashIntSet. - - - - - &reftitle.examples; - - <function>QuickHashIntSet::loadFromString</function> example - -exists( $key ) ? 'set' : 'unset' - ); -} -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/quickhash/quickhashintset/savetofile.xml b/reference/quickhash/quickhashintset/savetofile.xml deleted file mode 100644 index f3c55336a8f2..000000000000 --- a/reference/quickhash/quickhashintset/savetofile.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - QuickHashIntSet::saveToFile - This method stores an in-memory set to disk - - - - &reftitle.description; - - public voidQuickHashIntSet::saveToFile - stringfilename - - - This method stores an existing set to a file on disk, in the same format - that QuickHashIntSet::loadFromFile can read. - - - - - &reftitle.parameters; - - - filename - - - The filename of the file to store the hash in. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <function>QuickHashIntSet::saveToFile</function> example - -exists( 4 ) ); -var_dump( $set->add( 4 ) ); -var_dump( $set->exists( 4 ) ); -var_dump( $set->add( 4 ) ); - -$set->saveToFile( '/tmp/test.set' ); -?> -]]> - - - - - - - diff --git a/reference/quickhash/quickhashintset/savetostring.xml b/reference/quickhash/quickhashintset/savetostring.xml deleted file mode 100644 index 88739feed541..000000000000 --- a/reference/quickhash/quickhashintset/savetostring.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - QuickHashIntSet::saveToString - This method returns a serialized version of the set - - - - &reftitle.description; - - public stringQuickHashIntSet::saveToString - - - This method returns a serialized version of the set in the same format that - QuickHashIntSet::loadFromString can read. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - This method returns a string containing a serialized format of the set. - Each element is stored as a four byte value in the Endianness that the - current system uses. - - - - - &reftitle.examples; - - <function>QuickHashIntSet::saveToString</function> example - -exists( 4 ) ); -var_dump( $set->add( 4 ) ); -var_dump( $set->exists( 4 ) ); -var_dump( $set->add( 4 ) ); - -var_dump( $set->saveToString() ); -?> -]]> - - - - - - - diff --git a/reference/quickhash/quickhashintstringhash.xml b/reference/quickhash/quickhashintstringhash.xml deleted file mode 100644 index b01650ddb663..000000000000 --- a/reference/quickhash/quickhashintstringhash.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - - The QuickHashIntStringHash class - QuickHashIntStringHash - - - - -
    - &reftitle.intro; - - This class wraps around a hash containing integer numbers, where the - values are strings. Hashes are also available as implementation of the - ArrayAccess interface. - - - Hashes can also be iterated over with foreach as the Iterator interface is - implemented as well. The order of which elements are returned in is not - guaranteed. - -
    - - -
    - &reftitle.classsynopsis; - - - - QuickHashIntStringHash - - - - - QuickHashIntStringHash - - - - &Constants; - - const - int - QuickHashIntStringHash::CHECK_FOR_DUPES - 1 - - - const - int - QuickHashIntStringHash::DO_NOT_USE_ZEND_ALLOC - 2 - - - const - int - QuickHashIntStringHash::HASHER_NO_HASH - 256 - - - const - int - QuickHashIntStringHash::HASHER_JENKINS1 - 512 - - - const - int - QuickHashIntStringHash::HASHER_JENKINS2 - 1024 - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - QuickHashIntStringHash::CHECK_FOR_DUPES - - If enabled, adding duplicate elements to a set (through either QuickHashIntStringHash::add or - QuickHashIntStringHash::loadFromFile) will result in those elements to be dropped from the - set. This will take up extra time, so only used when it is required. - - - - - QuickHashIntStringHash::DO_NOT_USE_ZEND_ALLOC - - Disables the use of PHP's internal memory manager for internal - set structures. With this option enabled, internal allocations will not - count towards the memory_limit settings. - - - - - QuickHashIntStringHash::HASHER_NO_HASH - - Selects to not use a hashing function, but merely use a modulo to - find the bucket list index. This is not faster than normal hashing, and - gives more collisions. - - - - - QuickHashIntStringHash::HASHER_JENKINS1 - - This is the default hashing function to turn the integer hashes - into bucket list indexes. - - - - - QuickHashIntStringHash::HASHER_JENKINS2 - - Selects a variant hashing algorithm. - - - - -
    - - - -
    - - &reference.quickhash.entities.quickhashintstringhash; - -
    - diff --git a/reference/quickhash/quickhashintstringhash/add.xml b/reference/quickhash/quickhashintstringhash/add.xml deleted file mode 100644 index 8c1da7fe83a7..000000000000 --- a/reference/quickhash/quickhashintstringhash/add.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - QuickHashIntStringHash::add - This method adds a new entry to the hash - - - - &reftitle.description; - - public boolQuickHashIntStringHash::add - intkey - stringvalue - - - This method adds a new entry to the hash, and returns whether the entry was - added. Entries are by default always added unless - QuickHashIntStringHash::CHECK_FOR_DUPES has been passed when the hash was created. - - - - - &reftitle.parameters; - - - key - - - The key of the entry to add. - - - - - value - - - The value of the entry to add. If a non-string is passed, it will be - converted to a string automatically if possible. - - - - - - - - &reftitle.returnvalues; - - &true; when the entry was added, and &false; if the entry was not added. - - - - - &reftitle.examples; - - <function>QuickHashIntStringHash::add</function> example - -exists( 4 ) ); -var_dump( $hash->get( 4 ) ); -var_dump( $hash->add( 4, "twenty two" ) ); -var_dump( $hash->exists( 4 ) ); -var_dump( $hash->get( 4 ) ); -var_dump( $hash->add( 4, "twelve" ) ); - -echo "\nwith dupe checking\n"; -$hash = new QuickHashIntStringHash( 1024, QuickHashIntStringHash::CHECK_FOR_DUPES ); -var_dump( $hash->exists( 4 ) ); -var_dump( $hash->get( 4 ) ); -var_dump( $hash->add( 4, "seventy eight" ) ); -var_dump( $hash->exists( 4 ) ); -var_dump( $hash->get( 4 ) ); -var_dump( $hash->add( 4, "nine" ) ); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/quickhash/quickhashintstringhash/construct.xml b/reference/quickhash/quickhashintstringhash/construct.xml deleted file mode 100644 index d9a8ff8cc104..000000000000 --- a/reference/quickhash/quickhashintstringhash/construct.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - QuickHashIntStringHash::__construct - Creates a new QuickHashIntStringHash object - - - - &reftitle.description; - - public QuickHashIntStringHash::__construct - intsize - intoptions0 - - - This constructor creates a new QuickHashIntStringHash. The size is the amount of - bucket lists to create. The more lists there are, the less collisions you - will have. Options are also supported. - - - - - &reftitle.parameters; - - - size - - - The amount of bucket lists to configure. The number you pass in will be - automatically rounded up to the next power of two. It is also - automatically limited from 64 to 4194304. - - - - - options - - - The options that you can pass in are: QuickHashIntStringHash::CHECK_FOR_DUPES, - which makes sure no duplicate entries are added to the hash; - QuickHashIntStringHash::DO_NOT_USE_ZEND_ALLOC to not use PHP's internal memory - manager as well as one of QuickHashIntStringHash::HASHER_NO_HASH, - QuickHashIntStringHash::HASHER_JENKINS1 or QuickHashIntStringHash::HASHER_JENKINS2. - These last three configure which hashing algorithm to use. All options - can be combined using bitmasks. - - - - - - - - &reftitle.returnvalues; - - Returns a new QuickHashIntStringHash object. - - - - - &reftitle.examples; - - <function>QuickHashIntStringHash::__construct</function> example - - -]]> - - - - - - - diff --git a/reference/quickhash/quickhashintstringhash/delete.xml b/reference/quickhash/quickhashintstringhash/delete.xml deleted file mode 100644 index db78a1f4d47b..000000000000 --- a/reference/quickhash/quickhashintstringhash/delete.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - QuickHashIntStringHash::delete - This method deletes an entry from the hash - - - - &reftitle.description; - - public boolQuickHashIntStringHash::delete - intkey - - - This method deletes an entry from the hash, and returns whether the entry was - deleted or not. Associated memory structures will not be freed immediately, - but rather when the hash itself is freed. - - - Elements can not be deleted when the hash is used in an iterator. The - method will not throw an exception, but simply return &false; like would - happen with any other deletion failure. - - - - - &reftitle.parameters; - - - key - - - The key of the entry to delete. - - - - - - - - &reftitle.returnvalues; - - &true; when the entry was deleted, and &false; if the entry was not deleted. - - - - - &reftitle.examples; - - <function>QuickHashIntStringHash::delete</function> example - -exists( 4 ) ); -var_dump( $hash->add( 4, "five" ) ); -var_dump( $hash->delete( 4 ) ); -var_dump( $hash->exists( 4 ) ); -var_dump( $hash->delete( 4 ) ); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/quickhash/quickhashintstringhash/exists.xml b/reference/quickhash/quickhashintstringhash/exists.xml deleted file mode 100644 index 02aeedee0f8d..000000000000 --- a/reference/quickhash/quickhashintstringhash/exists.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - QuickHashIntStringHash::exists - This method checks whether a key is part of the hash - - - - &reftitle.description; - - public boolQuickHashIntStringHash::exists - intkey - - - This method checks whether an entry with the provided key exists in the - hash. - - - - - &reftitle.parameters; - - - key - - - The key of the entry to check for whether it exists in the hash. - - - - - - - - &reftitle.returnvalues; - - Returns &true; when the entry was found, or &false; when the entry is not - found. - - - - - diff --git a/reference/quickhash/quickhashintstringhash/get.xml b/reference/quickhash/quickhashintstringhash/get.xml deleted file mode 100644 index 4d25e125d133..000000000000 --- a/reference/quickhash/quickhashintstringhash/get.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - QuickHashIntStringHash::get - This method retrieves a value from the hash by its key - - - - &reftitle.description; - - public mixedQuickHashIntStringHash::get - intkey - - - This method retrieves a value from the hash by its key. - - - - - &reftitle.parameters; - - - key - - - The key of the entry to retrieve. - - - - - - - - &reftitle.returnvalues; - - The value if the key exists, or &null; if the key wasn't part of the hash. - - - - - &reftitle.examples; - - <function>QuickHashIntStringHash::get</function> example - -get( 1 ) ); - -var_dump( $hash->add( 2, "two" ) ); -var_dump( $hash->get( 2 ) ); - -var_dump( $hash->add( 3, 5 ) ); -var_dump( $hash->get( 3 ) ); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/quickhash/quickhashintstringhash/getsize.xml b/reference/quickhash/quickhashintstringhash/getsize.xml deleted file mode 100644 index 759f0a9cc043..000000000000 --- a/reference/quickhash/quickhashintstringhash/getsize.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - QuickHashIntStringHash::getSize - Returns the number of elements in the hash - - - - &reftitle.description; - - public intQuickHashIntStringHash::getSize - - - Returns the number of elements in the hash. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The number of elements in the hash. - - - - - &reftitle.examples; - - <function>QuickHashIntStringHash::getSize</function> example - -add( 2, "two" ) ); -var_dump( $hash->add( 3, 5 ) ); -var_dump( $hash->getSize() ); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/quickhash/quickhashintstringhash/loadfromfile.xml b/reference/quickhash/quickhashintstringhash/loadfromfile.xml deleted file mode 100644 index c4399960ab45..000000000000 --- a/reference/quickhash/quickhashintstringhash/loadfromfile.xml +++ /dev/null @@ -1,171 +0,0 @@ - - - - - QuickHashIntStringHash::loadFromFile - This factory method creates a hash from a file - - - - &reftitle.description; - - public static QuickHashIntStringHashQuickHashIntStringHash::loadFromFile - stringfilename - intsize0 - intoptions0 - - - This factory method creates a new hash from a definition file on disk. The - file format consists of a signature 'QH\0x12\0', the number of elements as - a 32 bit signed integer in system Endianness, an unsigned 32 bit integer - containing the number of element data to follow in characters. This element - data contains all the strings. After the header and the strings, the - elements follow in pairs of two unsigned 32 bit integers where the first - one is the key, and the second one the index in the element data - string. An example could be: - - - QuickHash IntString file format - - - - QuickHash IntString file format - - - - - - &reftitle.parameters; - - - filename - - - The filename of the file to read the hash from. - - - - - size - - - The amount of bucket lists to configure. The number you pass in will be - automatically rounded up to the next power of two. It is also - automatically limited from 4 to 4194304. - - - - - options - - - The same options that the class' constructor takes; except that the size - option is ignored. It is automatically calculated to be the same as the - number of entries in the hash, rounded up to the nearest power of two - with a maximum limit of 4194304. - - - - - - - - &reftitle.returnvalues; - - Returns a new QuickHashIntStringHash. - - - - - &reftitle.examples; - - <function>QuickHashIntStringHash::loadFromFile</function> example - -exists( $key ) ? 'set' : 'unset' - ); -} -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/quickhash/quickhashintstringhash/loadfromstring.xml b/reference/quickhash/quickhashintstringhash/loadfromstring.xml deleted file mode 100644 index eeb787754835..000000000000 --- a/reference/quickhash/quickhashintstringhash/loadfromstring.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - QuickHashIntStringHash::loadFromString - This factory method creates a hash from a string - - - - &reftitle.description; - - public static QuickHashIntStringHashQuickHashIntStringHash::loadFromString - stringcontents - intsize0 - intoptions0 - - - This factory method creates a new hash from a definition in a string. The - format is the same as the one used in "loadFromFile". - - - - - &reftitle.parameters; - - - contents - - - The string containing a serialized format of the hash. - - - - - size - - - The amount of bucket lists to configure. The number you pass in will be - automatically rounded up to the next power of two. It is also - automatically limited from 4 to 4194304. - - - - - options - - - The same options that the class' constructor takes; except that the size - option is ignored. It is automatically calculated to be the same as the - number of entries in the hash, rounded up to the nearest power of two - with a maximum limit of 4194304. - - - - - - - - &reftitle.returnvalues; - - Returns a new QuickHashIntStringHash. - - - - - &reftitle.examples; - - <function>QuickHashIntStringHash::loadFromString</function> example - -exists( $key ) ? 'set' : 'unset' - ); -} -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/quickhash/quickhashintstringhash/savetofile.xml b/reference/quickhash/quickhashintstringhash/savetofile.xml deleted file mode 100644 index 7e4a000c8b6f..000000000000 --- a/reference/quickhash/quickhashintstringhash/savetofile.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - QuickHashIntStringHash::saveToFile - This method stores an in-memory hash to disk - - - - &reftitle.description; - - public voidQuickHashIntStringHash::saveToFile - stringfilename - - - This method stores an existing hash to a file on disk, in the same format - that loadFromFile() can read. - - - - - &reftitle.parameters; - - - filename - - - The filename of the file to store the hash in. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <function>QuickHashIntStringHash::saveToFile</function> example - -exists( 4 ) ); -var_dump( $hash->add( 4, "forty three" ) ); -var_dump( $hash->exists( 4 ) ); -var_dump( $hash->add( 4, "fifty two" ) ); - -$hash->saveToFile( '/tmp/test.string.hash' ); -?> -]]> - - - - - - - diff --git a/reference/quickhash/quickhashintstringhash/savetostring.xml b/reference/quickhash/quickhashintstringhash/savetostring.xml deleted file mode 100644 index bdf4eee30f60..000000000000 --- a/reference/quickhash/quickhashintstringhash/savetostring.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - QuickHashIntStringHash::saveToString - This method returns a serialized version of the hash - - - - &reftitle.description; - - public stringQuickHashIntStringHash::saveToString - - - This method returns a serialized version of the hash in the same format that - QuickHashIntStringHash::loadFromString can read. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - This method returns a string containing a serialized format of the hash. - Each element is stored as a four byte value in the Endianness that the - current system uses. - - - - - &reftitle.examples; - - <function>QuickHashIntStringHash::saveToString</function> example - -exists( 4 ) ); -var_dump( $hash->add( 4, "thirty four" ) ); -var_dump( $hash->exists( 4 ) ); -var_dump( $hash->add( 5, "fifty five" ) ); - -var_dump( $hash->saveToString() ); -?> -]]> - - - - - - - diff --git a/reference/quickhash/quickhashintstringhash/set.xml b/reference/quickhash/quickhashintstringhash/set.xml deleted file mode 100644 index 7eda7c21bd40..000000000000 --- a/reference/quickhash/quickhashintstringhash/set.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - QuickHashIntStringHash::set - This method updates an entry in the hash with a new value, or - adds a new one if the entry doesn't exist - - - - &reftitle.description; - - public intQuickHashIntStringHash::set - intkey - stringvalue - - - This method tries to update an entry with a new value. In case the entry - did not yet exist, it will instead add a new entry. It returns whether the - entry was added or update. If there are duplicate keys, only the first - found element will get an updated value. Use - QuickHashIntStringHash::CHECK_FOR_DUPES during hash creation to prevent duplicate - keys from being part of the hash. - - - - - &reftitle.parameters; - - - key - - - The key of the entry to add or update. - - - - - value - - - The value of the entry to add. If a non-string is passed, it will be - converted to a string automatically if possible. - - - - - - - - &reftitle.returnvalues; - - 2 if the entry was found and updated, 1 if the entry was newly added or 0 - if there was an error. - - - - - &reftitle.examples; - - <function>QuickHashIntStringHash::set</function> example - -Add\n"; -var_dump( $hash->get( 46692 ) ); -var_dump( $hash->set( 46692, "sixteen thousand ninety one" ) ); -var_dump( $hash->get( 46692 ) ); - -echo "Set->Update\n"; -var_dump( $hash->set( 46692, "twenty nine thousand nine hundred six" ) ); -var_dump( $hash->get( 46692 ) ); -?> -]]> - - &example.outputs.similar; - -Add -bool(false) -int(2) -string(27) "sixteen thousand ninety one" -Set->Update -int(1) -string(37) "twenty nine thousand nine hundred six" -]]> - - - - - - - diff --git a/reference/quickhash/quickhashintstringhash/update.xml b/reference/quickhash/quickhashintstringhash/update.xml deleted file mode 100644 index c049ace25116..000000000000 --- a/reference/quickhash/quickhashintstringhash/update.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - QuickHashIntStringHash::update - This method updates an entry in the hash with a new value - - - - &reftitle.description; - - public boolQuickHashIntStringHash::update - intkey - stringvalue - - - This method updates an entry with a new value, and returns whether the entry was - update. If there are duplicate keys, only the first found element will get - an updated value. Use QuickHashIntStringHash::CHECK_FOR_DUPES during hash - creation to prevent duplicate keys from being part of the hash. - - - - - &reftitle.parameters; - - - key - - - The key of the entry to update. - - - - - value - - - The new value for the entry. If a non-string is passed, it will be - converted to a string automatically if possible. - - - - - - - - &reftitle.returnvalues; - - &true; when the entry was found and updated, and &false; if the entry was - not part of the hash already. - - - - - &reftitle.examples; - - <function>QuickHashIntStringHash::update</function> example - -add( 161803398, "--" ); -$hash->add( 314159265, "a lot" ); - -echo $hash->get( 161803398 ), "\n"; -echo $hash->get( 314159265 ), "\n"; - -var_dump( $hash->update( 314159265, "a lot plus one" ) ); -var_dump( $hash->update( 314159999, "a lot plus one" ) ); - -echo $hash->get( 161803398 ), "\n"; -echo $hash->get( 314159265 ), "\n"; -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/quickhash/quickhashstringinthash.xml b/reference/quickhash/quickhashstringinthash.xml deleted file mode 100644 index 7267486d8bbe..000000000000 --- a/reference/quickhash/quickhashstringinthash.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - The QuickHashStringIntHash class - QuickHashStringIntHash - - - - -
    - &reftitle.intro; - - This class wraps around a hash containing strings, where the - values are integer numbers. Hashes are also available as - implementation of the ArrayAccess interface. - - - Hashes can also be iterated over with foreach as the Iterator interface is - implemented as well. The order of which elements are returned in is not - guaranteed. - -
    - - -
    - &reftitle.classsynopsis; - - - - QuickHashStringIntHash - - - - - QuickHashStringIntHash - - - - &Constants; - - const - int - QuickHashStringIntHash::CHECK_FOR_DUPES - 1 - - - const - int - QuickHashStringIntHash::DO_NOT_USE_ZEND_ALLOC - 2 - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - QuickHashStringIntHash::CHECK_FOR_DUPES - - If enabled, adding duplicate elements to a set (through either QuickHashStringIntHash::add or - QuickHashStringIntHash::loadFromFile) will result in those elements to be dropped from the - set. This will take up extra time, so only used when it is required. - - - - - QuickHashStringIntHash::DO_NOT_USE_ZEND_ALLOC - - Disables the use of PHP's internal memory manager for internal - set structures. With this option enabled, internal allocations will not - count towards the memory_limit settings. - - - - -
    - - - -
    - - &reference.quickhash.entities.quickhashstringinthash; - -
    - diff --git a/reference/quickhash/quickhashstringinthash/add.xml b/reference/quickhash/quickhashstringinthash/add.xml deleted file mode 100644 index 9a39d5a111a7..000000000000 --- a/reference/quickhash/quickhashstringinthash/add.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - QuickHashStringIntHash::add - This method adds a new entry to the hash - - - - &reftitle.description; - - public boolQuickHashStringIntHash::add - stringkey - intvalue - - - This method adds a new entry to the hash, and returns whether the entry was - added. Entries are by default always added unless - QuickHashStringIntHash::CHECK_FOR_DUPES has been passed when the hash was created. - - - - - &reftitle.parameters; - - - key - - - The key of the entry to add. - - - - - value - - - The value of the entry to add. - - - - - - - - &reftitle.returnvalues; - - &true; when the entry was added, and &false; if the entry was not added. - - - - - &reftitle.examples; - - <function>QuickHashStringIntHash::add</function> example - -exists( "four" ) ); -var_dump( $hash->get( "four" ) ); -var_dump( $hash->add( "four", 22 ) ); -var_dump( $hash->exists( "four" ) ); -var_dump( $hash->get( "four" ) ); -var_dump( $hash->add( "four", 12 ) ); - -echo "\nwith dupe checking\n"; -$hash = new QuickHashStringIntHash( 1024, QuickHashStringIntHash::CHECK_FOR_DUPES ); -var_dump( $hash ); -var_dump( $hash->exists( "four" ) ); -var_dump( $hash->get( "four" ) ); -var_dump( $hash->add( "four", 78 ) ); -var_dump( $hash->exists( "four" ) ); -var_dump( $hash->get( "four" ) ); -var_dump( $hash->add( "four", 9 ) ); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/quickhash/quickhashstringinthash/construct.xml b/reference/quickhash/quickhashstringinthash/construct.xml deleted file mode 100644 index c64878013cd6..000000000000 --- a/reference/quickhash/quickhashstringinthash/construct.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - QuickHashStringIntHash::__construct - Creates a new QuickHashStringIntHash object - - - - &reftitle.description; - - public QuickHashStringIntHash::__construct - intsize - intoptions0 - - - This constructor creates a new QuickHashStringIntHash. The size is the amount of - bucket lists to create. The more lists there are, the less collisions you - will have. Options are also supported. - - - - - &reftitle.parameters; - - - size - - - The amount of bucket lists to configure. The number you pass in will be - automatically rounded up to the next power of two. It is also - automatically limited from 64 to 4194304. - - - - - options - - - The options that you can pass in are: - QuickHashStringIntHash::CHECK_FOR_DUPES, which makes sure no duplicate - entries are added to the hash and - QuickHashStringIntHash::DO_NOT_USE_ZEND_ALLOC to not use PHP's internal - memory manager. - - - - - - - - &reftitle.returnvalues; - - Returns a new QuickHashStringIntHash object. - - - - - &reftitle.examples; - - <function>QuickHashStringIntHash::__construct</function> example - - -]]> - - - - - - - diff --git a/reference/quickhash/quickhashstringinthash/delete.xml b/reference/quickhash/quickhashstringinthash/delete.xml deleted file mode 100644 index dc73c7eb41b0..000000000000 --- a/reference/quickhash/quickhashstringinthash/delete.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - QuickHashStringIntHash::delete - This method deletes an entry from the hash - - - - &reftitle.description; - - public boolQuickHashStringIntHash::delete - stringkey - - - This method deletes an entry from the hash, and returns whether the entry was - deleted or not. Associated memory structures will not be freed immediately, - but rather when the hash itself is freed. - - - Elements can not be deleted when the hash is used in an iterator. The - method will not throw an exception, but simply return &false; like would - happen with any other deletion failure. - - - - - &reftitle.parameters; - - - key - - - The key of the entry to delete. - - - - - - - - &reftitle.returnvalues; - - &true; when the entry was deleted, and &false; if the entry was not deleted. - - - - - &reftitle.examples; - - <function>QuickHashStringIntHash::delete</function> example - -exists( 'four' ) ); -var_dump( $hash->add( 'four', 5 ) ); -var_dump( $hash->get( 'four' ) ); -var_dump( $hash->delete( 'four' ) ); -var_dump( $hash->exists( 'four' ) ); -var_dump( $hash->get( 'four' ) ); -var_dump( $hash->delete( 'four' ) ); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/quickhash/quickhashstringinthash/exists.xml b/reference/quickhash/quickhashstringinthash/exists.xml deleted file mode 100644 index 770a6da1de72..000000000000 --- a/reference/quickhash/quickhashstringinthash/exists.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - QuickHashStringIntHash::exists - This method checks whether a key is part of the hash - - - - &reftitle.description; - - public boolQuickHashStringIntHash::exists - stringkey - - - This method checks whether an entry with the provided key exists in the - hash. - - - - - &reftitle.parameters; - - - key - - - The key of the entry to check for whether it exists in the hash. - - - - - - - - &reftitle.returnvalues; - - Returns &true; when the entry was found, or &false; when the entry is not - found. - - - - - diff --git a/reference/quickhash/quickhashstringinthash/get.xml b/reference/quickhash/quickhashstringinthash/get.xml deleted file mode 100644 index 92e95eed4d82..000000000000 --- a/reference/quickhash/quickhashstringinthash/get.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - QuickHashStringIntHash::get - This method retrieves a value from the hash by its key - - - - &reftitle.description; - - public mixedQuickHashStringIntHash::get - stringkey - - - This method retrieves a value from the hash by its key. - - - - - &reftitle.parameters; - - - key - - - The key of the entry to retrieve. - - - - - - - - &reftitle.returnvalues; - - The value if the key exists, or &null; if the key wasn't part of the hash. - - - - - &reftitle.examples; - - <function>QuickHashStringIntHash::get</function> example - -get( "one" ) ); - -var_dump( $hash->add( "two", 2 ) ); -var_dump( $hash->get( "two" ) ); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/quickhash/quickhashstringinthash/getsize.xml b/reference/quickhash/quickhashstringinthash/getsize.xml deleted file mode 100644 index 198da274aa38..000000000000 --- a/reference/quickhash/quickhashstringinthash/getsize.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - QuickHashStringIntHash::getSize - Returns the number of elements in the hash - - - - &reftitle.description; - - public intQuickHashStringIntHash::getSize - - - Returns the number of elements in the hash. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The number of elements in the hash. - - - - - &reftitle.examples; - - <function>QuickHashStringIntHash::getSize</function> example - -add( "two", 2 ) ); -var_dump( $hash->add( "three", 5 ) ); -var_dump( $hash->getSize() ); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/quickhash/quickhashstringinthash/loadfromfile.xml b/reference/quickhash/quickhashstringinthash/loadfromfile.xml deleted file mode 100644 index a98e309699fe..000000000000 --- a/reference/quickhash/quickhashstringinthash/loadfromfile.xml +++ /dev/null @@ -1,182 +0,0 @@ - - - - - QuickHashStringIntHash::loadFromFile - This factory method creates a hash from a file - - - - &reftitle.description; - - public static QuickHashStringIntHashQuickHashStringIntHash::loadFromFile - stringfilename - intsize0 - intoptions0 - - - This factory method creates a new hash from a definition file on disk. The - file format consists of a signature 'QH\0x21\0', the number of elements as - a 32 bit signed integer in system Endianness, an unsigned 32 bit integer - containing the number of element data to follow in characters. This element - data contains all the strings. The follows another signed 32 bit integer - containing the number of bucket lists. After the header and the strings, - the elements follow. They are ordered by bucket list so that the keys don't - have to be hashed in order to restore the hash. For each bucket list, the - following information is stored (all as 32 bit integers): the bucket list - index, the number of elements in that list, and then in pairs of two - unsigned 32 bit integers the elements, where the first one is the index - into the string list containing the keys, and the second one the value. An - example could be: - - - QuickHash StringIntHash file format - - - - QuickHash IntHash file format - - - - - - &reftitle.parameters; - - - filename - - - The filename of the file to read the hash from. - - - - - size - - - The amount of bucket lists to configure. The number you pass in will be - automatically rounded up to the next power of two. It is also - automatically limited from 4 to 4194304. - - - - - options - - - The same options that the class' constructor takes; except that the size - option is ignored. It is read from the file format (unlike the - QuickHashIntHash and QuickHashIntStringHash classes, where it is - automatically calculated from the number of entries in the hash.) - - - - - - - - &reftitle.returnvalues; - - Returns a new QuickHashStringIntHash. - - - - - &reftitle.examples; - - <function>QuickHashStringIntHash::loadFromFile</function> example - - ', $hash->get( $k ), "\n"; -} -?> -]]> - - &example.outputs.similar; - - 48712 -12uf => 50343 -143q => 51974 -15d1 => 53605 -16mc => 55236 -17vn => 56867 -194y => 58498 -1ae9 => 60129 -1bnk => 61760 -1cwv => 63391 -1e66 => 65022 -1ffh => 66653 -1gos => 68284 -1hy3 => 69915 -1j7e => 71546 -1kgp => 73177 -]]> - - - - - - - diff --git a/reference/quickhash/quickhashstringinthash/loadfromstring.xml b/reference/quickhash/quickhashstringinthash/loadfromstring.xml deleted file mode 100644 index b11f61bfbbaa..000000000000 --- a/reference/quickhash/quickhashstringinthash/loadfromstring.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - QuickHashStringIntHash::loadFromString - This factory method creates a hash from a string - - - - &reftitle.description; - - public static QuickHashStringIntHashQuickHashStringIntHash::loadFromString - stringcontents - intsize0 - intoptions0 - - - This factory method creates a new hash from a definition in a string. The - format is the same as the one used in "loadFromFile". - - - - - &reftitle.parameters; - - - contents - - - The string containing a serialized format of the hash. - - - - - size - - - The amount of bucket lists to configure. The number you pass in will be - automatically rounded up to the next power of two. It is also - automatically limited from 4 to 4194304. - - - - - options - - - The same options that the class' constructor takes; except that the size - option is ignored. It is automatically calculated to be the same as the - number of entries in the hash, rounded up to the nearest power of two - with a maximum limit of 4194304. - - - - - - - - &reftitle.returnvalues; - - Returns a new QuickHashStringIntHash. - - - - - &reftitle.examples; - - <function>QuickHashStringIntHash::loadFromString</function> example - - ', $hash->get( $k ), "\n"; -} -?> -]]> - - &example.outputs.similar; - - 48712 -12uf => 50343 -143q => 51974 -15d1 => 53605 -16mc => 55236 -17vn => 56867 -194y => 58498 -1ae9 => 60129 -1bnk => 61760 -1cwv => 63391 -1e66 => 65022 -1ffh => 66653 -1gos => 68284 -1hy3 => 69915 -1j7e => 71546 -1kgp => 73177 -]]> - - - - - - - diff --git a/reference/quickhash/quickhashstringinthash/savetofile.xml b/reference/quickhash/quickhashstringinthash/savetofile.xml deleted file mode 100644 index 9a02a7024b10..000000000000 --- a/reference/quickhash/quickhashstringinthash/savetofile.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - QuickHashStringIntHash::saveToFile - This method stores an in-memory hash to disk - - - - &reftitle.description; - - public voidQuickHashStringIntHash::saveToFile - stringfilename - - - This method stores an existing hash to a file on disk, in the same format - that loadFromFile() can read. - - - - - &reftitle.parameters; - - - filename - - - The filename of the file to store the hash in. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <function>QuickHashStringIntHash::saveToFile</function> example - -add( "forty three", 42 ) ); -var_dump( $hash->add( "fifty two", 52 ) ); - -$hash->saveToFile( '/tmp/test.hash.string' ); -?> -]]> - - - - - - - diff --git a/reference/quickhash/quickhashstringinthash/savetostring.xml b/reference/quickhash/quickhashstringinthash/savetostring.xml deleted file mode 100644 index 9560477cab0e..000000000000 --- a/reference/quickhash/quickhashstringinthash/savetostring.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - QuickHashStringIntHash::saveToString - This method returns a serialized version of the hash - - - - &reftitle.description; - - public stringQuickHashStringIntHash::saveToString - - - This method returns a serialized version of the hash in the same format that - QuickHashStringIntHash::loadFromString can read. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - This method returns a serialized format of an existing hash, in the same format - that QuickHashStringIntHash::loadFromString can read. - - - - - &reftitle.examples; - - <function>QuickHashStringIntHash::saveToString</function> example - -add( "forty three", 42 ) ); -var_dump( $hash->add( "fifty two", 52 ) ); - -var_dump( $hash->saveToString() ); -?> -]]> - - - - - - - diff --git a/reference/quickhash/quickhashstringinthash/set.xml b/reference/quickhash/quickhashstringinthash/set.xml deleted file mode 100644 index 287e5d51803f..000000000000 --- a/reference/quickhash/quickhashstringinthash/set.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - QuickHashStringIntHash::set - This method updates an entry in the hash with a new value, or - adds a new one if the entry doesn't exist - - - - &reftitle.description; - - public intQuickHashStringIntHash::set - stringkey - intvalue - - - This method tries to update an entry with a new value. In case the entry - did not yet exist, it will instead add a new entry. It returns whether the - entry was added or update. If there are duplicate keys, only the first - found element will get an updated value. Use - QuickHashStringIntHash::CHECK_FOR_DUPES during hash creation to prevent duplicate - keys from being part of the hash. - - - - - &reftitle.parameters; - - - key - - - The key of the entry to add or update. - - - - - value - - - The value of the entry to add. If a non-string is passed, it will be - converted to a string automatically if possible. - - - - - - - - &reftitle.returnvalues; - - 2 if the entry was found and updated, 1 if the entry was newly added or 0 - if there was an error. - - - - - &reftitle.examples; - - <function>QuickHashStringIntHash::set</function> example - -Add\n"; -var_dump( $hash->get( "forty six thousand six hundred ninety two" ) ); -var_dump( $hash->set( "forty six thousand six hundred ninety two", 16091 ) ); -var_dump( $hash->get( "forty six thousand six hundred ninety two" ) ); - -echo "Set->Update\n"; -var_dump( $hash->set( "forty six thousand six hundred ninety two", 29906 ) ); -var_dump( $hash->get( "forty six thousand six hundred ninety two" ) ); -?> -]]> - - &example.outputs.similar; - -Add -bool(false) -int(2) -int(16091) -Set->Update -int(1) -int(29906) -]]> - - - - - - - diff --git a/reference/quickhash/quickhashstringinthash/update.xml b/reference/quickhash/quickhashstringinthash/update.xml deleted file mode 100644 index e85e604a64e5..000000000000 --- a/reference/quickhash/quickhashstringinthash/update.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - QuickHashStringIntHash::update - This method updates an entry in the hash with a new value - - - - &reftitle.description; - - public boolQuickHashStringIntHash::update - stringkey - intvalue - - - This method updates an entry with a new value, and returns whether the entry was - update. If there are duplicate keys, only the first found element will get - an updated value. Use QuickHashStringIntHash::CHECK_FOR_DUPES during hash - creation to prevent duplicate keys from being part of the hash. - - - - - &reftitle.parameters; - - - key - - - The key of the entry to update. - - - - - value - - - The new value for the entry. If a non-string is passed, it will be - converted to a string automatically if possible. - - - - - - - - &reftitle.returnvalues; - - &true; when the entry was found and updated, and &false; if the entry was - not part of the hash already. - - - - - &reftitle.examples; - - <function>QuickHashStringIntHash::update</function> example - -add( 'six', 314159265 ); -$hash->add( "a lot", 314159265 ); - -echo $hash->get( 'six' ), "\n"; -echo $hash->get( 'a lot' ), "\n"; - -var_dump( $hash->update( 'a lot', 314159266 ) ); -var_dump( $hash->update( "a lot plus one", 314159999 ) ); - -echo $hash->get( 'six' ), "\n"; -echo $hash->get( 'a lot' ), "\n"; -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/quickhash/setup.xml b/reference/quickhash/setup.xml deleted file mode 100644 index 845652e51805..000000000000 --- a/reference/quickhash/setup.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - &reftitle.setup; - -
    - &reftitle.required; - - This extension requires no additional libraries. - -
    - -
    - &reftitle.install; - - &pecl.info; - &url.pecl.package;quickhash - -
    - -
    - diff --git a/reference/quickhash/versions.xml b/reference/quickhash/versions.xml deleted file mode 100644 index 765d28430f96..000000000000 --- a/reference/quickhash/versions.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/radius/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/radius/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/radius/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/radius/book.xml b/reference/radius/book.xml deleted file mode 100644 index 3aa5c354bb78..000000000000 --- a/reference/radius/book.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - Radius - - - - &reftitle.intro; - - This package is based on the libradius (Remote Authentication Dial In User - Service) of FreeBSD. It allows clients to perform authentication and - accounting by means of network requests to remote servers. - - - This PECL extension adds full support for Radius Authentication - (RFC 2865) and Radius Accounting - (RFC 2866). This package is available - for Unix (tested on FreeBSD and Linux) and for Windows. - - - - An exact description for libradius can be found - here. A detailed description of the - configuration file can be found here. - - - - - - &reference.radius.setup; - &reference.radius.constants; - &reference.radius.examples; - &reference.radius.reference; - - - diff --git a/reference/radius/configure.xml b/reference/radius/configure.xml deleted file mode 100644 index 781f5e4fe40a..000000000000 --- a/reference/radius/configure.xml +++ /dev/null @@ -1,32 +0,0 @@ - - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;radius. - -
    - diff --git a/reference/radius/constants.xml b/reference/radius/constants.xml deleted file mode 100644 index 38a5714f4db1..000000000000 --- a/reference/radius/constants.xml +++ /dev/null @@ -1,2004 +0,0 @@ - - - - &reftitle.constants; - &extension.constants; - - - - - RADIUS_MPPE_KEY_LEN - (int) - - - - The maximum length of MPPE keys. - - - - - -
    - RADIUS Options - - - Several RADIUS functions accept option flags as bitmasks. The constants - representing those flags are listed below. - - - - - - RADIUS_OPTION_SALT - (int) - - - - When set, this option will result in the attribute value being - salt-encrypted. - - - - - - RADIUS_OPTION_TAGGED - (int) - - - - When set, this option will result in the attribute value being tagged - with the value of the tag parameter. - - - - -
    - -
    - RADIUS Packet Types - - - RADIUS packets, whether requests or responses, always include a type. These - constants are provided to make it easier to specify types when using - radius_create_request and when comparing the result of - radius_send_request. - - - - - - RADIUS_ACCESS_REQUEST - (int) - - - - An Access-Request, used to authenticate a user against a RADIUS server. - Access request packets must include a - RADIUS_NAS_IP_ADDRESS - or a - RADIUS_NAS_IDENTIFIER - attribute, must also include a - RADIUS_USER_PASSWORD, - RADIUS_CHAP_PASSWORD - or a - RADIUS_STATE - attribute, and should include a - RADIUS_USER_NAME - attribute. - - - - - - RADIUS_ACCESS_ACCEPT - (int) - - - - An Access-Accept response to an Access-Request indicating that the - RADIUS server authenticated the user successfully. - - - - - - RADIUS_ACCESS_REJECT - (int) - - - - An Access-Reject response to an Access-Request indicating that the - RADIUS server could not authenticate the user. - - - - - - RADIUS_ACCESS_CHALLENGE - (int) - - - - An Access-Challenge response to an Access-Request indicating that the - RADIUS server requires further information in another Access-Request - before authenticating the user. - - - - - - RADIUS_ACCOUNTING_REQUEST - (int) - - - - An Accounting-Request, used to convey accounting information for a - service to the RADIUS server. - - - - - - RADIUS_ACCOUNTING_RESPONSE - (int) - - - - An Accounting-Response response to an Accounting-Request. - - - - - - RADIUS_COA_REQUEST - (int) - - - - A CoA-Request, sent from the RADIUS server to indicate that the - authorisations within the user session have changed. A response must be - sent in the form of a CoA-ACK or a CoA-NAK. - - - This constant is available in PECL radius 1.3.0 and later. - - - - - - RADIUS_COA_ACK - (int) - - - - A CoA-ACK, sent to the RADIUS server to indicate that the user - authorisations have been updated. - - - This constant is available in PECL radius 1.3.0 and later. - - - - - - RADIUS_COA_NAK - (int) - - - - A CoA-NAK, sent to the RADIUS server to indicate that the user - authorisations could not be updated. - - - This constant is available in PECL radius 1.3.0 and later. - - - - - - RADIUS_DISCONNECT_REQUEST - (int) - - - - A Disconnect-Request, sent from the RADIUS server to indicate that the - user session must be terminated. - - - This constant is available in PECL radius 1.3.0 and later. - - - - - - RADIUS_DISCONNECT_ACK - (int) - - - - A Disconnect-ACK, sent to the RADIUS server to indicate that the user - session has been terminated. - - - This constant is available in PECL radius 1.3.0 and later. - - - - - - RADIUS_DISCONNECT_NAK - (int) - - - - A Disconnect-NAK, sent to the RADIUS server to indicate that the user - session could not be terminated. - - - This constant is available in PECL radius 1.3.0 and later. - - - - -
    - -
    - RADIUS Attribute Types - - - These constants define RADIUS attribute types that can be used with - radius_put_addr, radius_put_attr, - radius_put_int and - radius_put_string. - - - - - - RADIUS_USER_NAME - (int) - - - - The User-Name attribute. The attribute value is expected to be a - string containing the name of the user being authenticated, - and can be set using radius_put_attr. - - - - - - RADIUS_USER_PASSWORD - (int) - - - - The User-Password attribute. The attribute value is expected to be a - string containing the user's password, and can be set using - radius_put_attr. This value will be obfuscated on - transmission as described in - section 5.2 of RFC 2865. - - - - - - RADIUS_CHAP_PASSWORD - (int) - - - - The Chap-Password attribute. The attribute value is expected to be a - string with the first byte containing the CHAP identifier, - and the subsequent 16 bytes containing the MD5 hash of the CHAP - identifier, the plaintext password and the CHAP challenge value - concatenated together. Note that the CHAP challenge value should also be - sent separately in a - RADIUS_CHAP_CHALLENGE - attribute. - - - Using CHAP passwords - - -]]> - - - - - - - RADIUS_NAS_IP_ADDRESS - (int) - - - - The NAS-IP-Address attribute. The attribute value is expected to the IP - address of the RADIUS client encoded as an int, which - can be set using radius_put_addr. - - - - - - RADIUS_NAS_PORT - (int) - - - - The NAS-Port attribute. The attribute value is expected to be the - physical port of the user on the RADIUS client encoded as an - int, which can be set using - radius_put_int. - - - - - - RADIUS_SERVICE_TYPE - (int) - - - - The Service-Type attribute. The attribute value indicates the service - type the user is requesting, and is expected to be an - int, which can be set using - radius_put_int. - - - A number of constants are provided to represent the possible values of - this attribute. They include: - - RADIUS_LOGIN - RADIUS_FRAMED - RADIUS_CALLBACK_LOGIN - RADIUS_CALLBACK_FRAMED - RADIUS_OUTBOUND - RADIUS_ADMINISTRATIVE - RADIUS_NAS_PROMPT - RADIUS_AUTHENTICATE_ONLY - RADIUS_CALLBACK_NAS_PROMPT - - - - - - - RADIUS_FRAMED_PROTOCOL - (int) - - - - The Framed-Protocol attribute. The attribute value is expected to be an - int indicating the framing to be used for framed - access, and can be set using radius_put_int. The - possible attribute values include these constants: - - RADIUS_PPP - RADIUS_SLIP - RADIUS_ARAP - RADIUS_GANDALF - RADIUS_XYLOGICS - - - - - - - RADIUS_FRAMED_IP_ADDRESS - (int) - - - - The Framed-IP-Address attribute. The attribute value is expected to be - the address of the user's network encoded as an int, - which can be set using radius_put_addr and - retrieved using radius_cvt_addr. - - - - - - RADIUS_FRAMED_IP_NETMASK - (int) - - - - The Framed-IP-Netmask attribute. The attribute value is expected to be - the netmask of the user's network encoded as an int, - which can be set using radius_put_addr and - retrieved using radius_cvt_addr. - - - - - - RADIUS_FRAMED_ROUTING - (int) - - - - The Framed-Routing attribute. The attribute value is expected to be an - int indicating the routing method for the user, which - can be set using radius_put_int. - - - Possible values include: - - 0: No routing - 1: Send routing packets - 2: Listen for routing packets - 3: Send and listen - - - - - - - RADIUS_FILTER_ID - (int) - - - - The Filter-ID attribute. The attribute value is expected to be an - implementation-specific, human-readable string of filters, - which can be set using radius_put_attr. - - - - - - RADIUS_FRAMED_MTU - (int) - - - - The Framed-MTU attribute. The attribute value is expected to be an - int indicating the MTU to be configured for the user, - and can be set using radius_put_int. - - - - - - RADIUS_FRAMED_COMPRESSION - (int) - - - - The Framed-Compression attribute. The attribute value is expected to be - an int indicating the compression protocol to be used, - and can be set using radius_put_int. Possible - values include these constants: - - RADIUS_COMP_NONE: No compression - RADIUS_COMP_VJ: VJ TCP/IP header compression - RADIUS_COMP_IPXHDR: IPX header compression - - RADIUS_COMP_STAC_LZS: - Stac-LZS compression (added in PECL radius 1.3.0b2) - - - - - - - - RADIUS_LOGIN_IP_HOST - (int) - - - - The Login-IP-Host attribute. The attribute value is expected to the IP - address to connect the user to, encoded as an int, - which can be set using radius_put_addr. - - - - - - RADIUS_LOGIN_SERVICE - (int) - - - - The Login-Service attribute. The attribute value is an - int indicating the service to connect the user to on - the login host. The value can be converted to a PHP integer via - radius_cvt_int. - - - - - - RADIUS_LOGIN_TCP_PORT - (int) - - - - The Login-TCP-Port attribute. The attribute value is an - int indicating the port to connect the user to on the - login host. The value can be converted to a PHP integer via - radius_cvt_int. - - - - - - RADIUS_REPLY_MESSAGE - (int) - - - - The Reply-Message attribute. The attribute value is a - string containing text that may be displayed to the user in - response to an access request. - - - - - - RADIUS_CALLBACK_NUMBER - (int) - - - - The Callback-Number attribute. The attribute value is a - string containing the dialing string to use for callback. - - - - - - RADIUS_CALLBACK_ID - (int) - - - - The Callback-Id attribute. The attribute value is a string - containing an implementation-specific name of the place to be called. - - - - - - RADIUS_FRAMED_ROUTE - (int) - - - - The Framed-Route attribute. The attribute value is a string - containing an implementation-specific set of routes to be configured for - the user. - - - - - - RADIUS_FRAMED_IPX_NETWORK - (int) - - - - The Framed-IPX-Network attribute. The attribute value is an - int containing the IPX network to be configured for the - user, or 0xFFFFFFFE to indicate that the RADIUS - client should select the network, and can be accessed via - radius_cvt_int. - - - - - - RADIUS_STATE - (int) - - - - The State attribute. The attribute value is an implementation-defined - string included in an Access-Challenge from a server that - must be included in the subsequent Access-Request, and can be set using - radius_put_attr. - - - - - - RADIUS_CLASS - (int) - - - - The Class attribute. The attribute value is an arbitrary - string included in an Access-Accept message that should - then be sent to the accounting server in Accounting-Request messages, - and can be set using radius_put_attr. - - - - - - RADIUS_VENDOR_SPECIFIC - (int) - - - - The Vendor-Specific attribute. In general, vendor attribute values - should be set using radius_put_vendor_addr, - radius_put_vendor_attr, - radius_put_vendor_int and - radius_put_vendor_string, rather than directly. - - - This constant is mostly useful when interpreting vendor specific - attributes in responses from a RADIUS server; when a vendor specific - attribute is received, the radius_get_vendor_attr - function should be used to access the vendor ID, attribute type and - attribute value. - - - - - - RADIUS_SESSION_TIMEOUT - (int) - - - - Session timeout - - - - - - RADIUS_IDLE_TIMEOUT - (int) - - - - Idle timeout - - - - - - RADIUS_TERMINATION_ACTION - (int) - - - - Termination action - - - - - - RADIUS_CALLED_STATION_ID - (int) - - - - Called Station Id - - - - - - RADIUS_CALLING_STATION_ID - (int) - - - - Calling Station Id - - - - - - RADIUS_NAS_IDENTIFIER - (int) - - - - NAS ID - - - - - - RADIUS_PROXY_STATE - (int) - - - - Proxy State - - - - - - RADIUS_LOGIN_LAT_SERVICE - (int) - - - - Login LAT Service - - - - - - RADIUS_LOGIN_LAT_NODE - (int) - - - - Login LAT Node - - - - - - RADIUS_LOGIN_LAT_GROUP - (int) - - - - Login LAT Group - - - - - - RADIUS_FRAMED_APPLETALK_LINK - (int) - - - - Framed Appletalk Link - - - - - - RADIUS_FRAMED_APPLETALK_NETWORK - (int) - - - - Framed Appletalk Network - - - - - - RADIUS_FRAMED_APPLETALK_ZONE - (int) - - - - Framed Appletalk Zone - - - - - - RADIUS_CHAP_CHALLENGE - (int) - - - - Challenge - - - - - - RADIUS_NAS_PORT_TYPE - (int) - - - - NAS port type, one of: - - RADIUS_ASYNC - RADIUS_SYNC - RADIUS_ISDN_SYNC - RADIUS_ISDN_ASYNC_V120 - RADIUS_ISDN_ASYNC_V110 - RADIUS_VIRTUAL - RADIUS_PIAFS - RADIUS_HDLC_CLEAR_CHANNEL - RADIUS_X_25 - RADIUS_X_75 - RADIUS_G_3_FAX - RADIUS_SDSL - RADIUS_ADSL_CAP - RADIUS_ADSL_DMT - RADIUS_IDSL - RADIUS_ETHERNET - RADIUS_XDSL - RADIUS_CABLE - RADIUS_WIRELESS_OTHER - RADIUS_WIRELESS_IEEE_802_11 - - - - - - - RADIUS_PORT_LIMIT - (int) - - - - Port Limit - - - - - - RADIUS_LOGIN_LAT_PORT - (int) - - - - Login LAT Port - - - - - - RADIUS_CONNECT_INFO - (int) - - - - Connect info - - - - - - RADIUS_ACCT_STATUS_TYPE - (int) - - - - Accounting status type, one of: - - RADIUS_START - RADIUS_STOP - RADIUS_ACCOUNTING_ON - RADIUS_ACCOUNTING_OFF - - - - - - - RADIUS_ACCT_DELAY_TIME - (int) - - - - Accounting delay time - - - - - - RADIUS_ACCT_INPUT_OCTETS - (int) - - - - Accounting input bytes - - - - - - RADIUS_ACCT_OUTPUT_OCTETS - (int) - - - - Accounting output bytes - - - - - - RADIUS_ACCT_SESSION_ID - (int) - - - - Accounting session ID - - - - - - RADIUS_ACCT_AUTHENTIC - (int) - - - - Accounting authentic, one of: - - RADIUS_AUTH_RADIUS - RADIUS_AUTH_LOCAL - RADIUS_AUTH_REMOTE - - - - - - - RADIUS_ACCT_SESSION_TIME - (int) - - - - Accounting session time - - - - - - RADIUS_ACCT_INPUT_PACKETS - (int) - - - - Accounting input packets - - - - - - RADIUS_ACCT_OUTPUT_PACKETS - (int) - - - - Accounting output packets - - - - - - RADIUS_ACCT_TERMINATE_CAUSE - (int) - - - - Accounting terminate cause, one of: - - RADIUS_TERM_USER_REQUEST - RADIUS_TERM_LOST_CARRIER - RADIUS_TERM_LOST_SERVICE - RADIUS_TERM_IDLE_TIMEOUT - RADIUS_TERM_SESSION_TIMEOUT - RADIUS_TERM_ADMIN_RESET - RADIUS_TERM_ADMIN_REBOOT - RADIUS_TERM_PORT_ERROR - RADIUS_TERM_NAS_ERROR - RADIUS_TERM_NAS_REQUEST - RADIUS_TERM_NAS_REBOOT - RADIUS_TERM_PORT_UNNEEDED - RADIUS_TERM_PORT_PREEMPTED - RADIUS_TERM_PORT_SUSPENDED - RADIUS_TERM_SERVICE_UNAVAILABLE - RADIUS_TERM_CALLBACK - RADIUS_TERM_USER_ERROR - RADIUS_TERM_HOST_REQUEST - - - - - - - RADIUS_ACCT_MULTI_SESSION_ID - (int) - - - - Accounting multi session ID - - - - - - RADIUS_ACCT_LINK_COUNT - (int) - - - - Accounting link count - - - - - - Service-Type Constants - - - RADIUS_LOGIN - - - - - - - - - RADIUS_FRAMED - - - - - - - - - RADIUS_CALLBACK_LOGIN - - - - - - - - - RADIUS_CALLBACK_FRAMED - - - - - - - - - RADIUS_OUTBOUND - - - - - - - - - RADIUS_ADMINISTRATIVE - - - - - - - - - RADIUS_NAS_PROMPT - - - - - - - - - RADIUS_AUTHENTICATE_ONLY - - - - - - - - - RADIUS_CALLBACK_NAS_PROMPT - - - - - - - - - - Framed-Protocol Constants - - - RADIUS_PPP - - - - - - - - - RADIUS_SLIP - - - - - - - - - RADIUS_ARAP - - - - - - - - - RADIUS_GANDALF - - - - - - - - - RADIUS_XYLOGICS - - - - - - - - - - Framed-Compression Constants - - - RADIUS_COMP_NONE - - - - - - - - - RADIUS_COMP_VJ - - - - - - - - - RADIUS_COMP_IPXHDR - - - - - - - - - RADIUS_COMP_STAC_LZS - - - - - - - - - - NAS Port Type Constants - - - RADIUS_ASYNC - - - - - - - - - RADIUS_SYNC - - - - - - - - - RADIUS_ISDN_SYNC - - - - - - - - - RADIUS_ISDN_ASYNC_V120 - - - - - - - - - RADIUS_ISDN_ASYNC_V110 - - - - - - - - - RADIUS_VIRTUAL - - - - - - - - - RADIUS_PIAFS - - - - - - - - - RADIUS_HDLC_CLEAR_CHANNEL - - - - - - - - - RADIUS_X_25 - - - - - - - - - RADIUS_X_75 - - - - - - - - - RADIUS_G_3_FAX - - - - - - - - - RADIUS_SDSL - - - - - - - - - RADIUS_ADSL_CAP - - - - - - - - - RADIUS_ADSL_DMT - - - - - - - - - RADIUS_IDSL - - - - - - - - - RADIUS_ETHERNET - - - - - - - - - RADIUS_XDSL - - - - - - - - - RADIUS_CABLE - - - - - - - - - RADIUS_WIRELESS_OTHER - - - - - - - - - RADIUS_WIRELESS_IEEE_802_11 - - - - - - - - - - Accounting Status Type Constants - - - RADIUS_START - - - - - - - - - RADIUS_STOP - - - - - - - - - RADIUS_ACCOUNTING_ON - - - - - - - - - RADIUS_ACCOUNTING_OFF - - - - - - - - - - Accounting Authentic Constants - - - RADIUS_AUTH_RADIUS - - - - - - - - - RADIUS_AUTH_LOCAL - - - - - - - - - RADIUS_AUTH_REMOTE - - - - - - - - - - Accounting Terminate Cause Constants - - - RADIUS_TERM_USER_REQUEST - - - - - - - - - RADIUS_TERM_LOST_CARRIER - - - - - - - - - RADIUS_TERM_LOST_SERVICE - - - - - - - - - RADIUS_TERM_IDLE_TIMEOUT - - - - - - - - - RADIUS_TERM_SESSION_TIMEOUT - - - - - - - - - RADIUS_TERM_ADMIN_RESET - - - - - - - - - RADIUS_TERM_ADMIN_REBOOT - - - - - - - - - RADIUS_TERM_PORT_ERROR - - - - - - - - - RADIUS_TERM_NAS_ERROR - - - - - - - - - RADIUS_TERM_NAS_REQUEST - - - - - - - - - RADIUS_TERM_NAS_REBOOT - - - - - - - - - RADIUS_TERM_PORT_UNNEEDED - - - - - - - - - RADIUS_TERM_PORT_PREEMPTED - - - - - - - - - RADIUS_TERM_PORT_SUSPENDED - - - - - - - - - RADIUS_TERM_SERVICE_UNAVAILABLE - - - - - - - - - RADIUS_TERM_CALLBACK - - - - - - - - - RADIUS_TERM_USER_ERROR - - - - - - - - - RADIUS_TERM_HOST_REQUEST - - - - - - - -
    - -
    - RADIUS Vendor Specific Attribute Types - - - - - RADIUS_VENDOR_MICROSOFT - (int) - - - - Microsoft specific vendor attributes (RFC 2548), one of: - - RADIUS_MICROSOFT_MS_CHAP_RESPONSE - RADIUS_MICROSOFT_MS_CHAP_ERROR - RADIUS_MICROSOFT_MS_CHAP_PW_1 - RADIUS_MICROSOFT_MS_CHAP_PW_2 - RADIUS_MICROSOFT_MS_CHAP_LM_ENC_PW - RADIUS_MICROSOFT_MS_CHAP_NT_ENC_PW - RADIUS_MICROSOFT_MS_MPPE_ENCRYPTION_POLICY - RADIUS_MICROSOFT_MS_MPPE_ENCRYPTION_TYPES - RADIUS_MICROSOFT_MS_RAS_VENDOR - RADIUS_MICROSOFT_MS_CHAP_DOMAIN - RADIUS_MICROSOFT_MS_CHAP_CHALLENGE - RADIUS_MICROSOFT_MS_CHAP_MPPE_KEYS - RADIUS_MICROSOFT_MS_BAP_USAGE - RADIUS_MICROSOFT_MS_LINK_UTILIZATION_THRESHOLD - RADIUS_MICROSOFT_MS_LINK_DROP_TIME_LIMIT - RADIUS_MICROSOFT_MS_MPPE_SEND_KEY - RADIUS_MICROSOFT_MS_MPPE_RECV_KEY - RADIUS_MICROSOFT_MS_RAS_VERSION - RADIUS_MICROSOFT_MS_OLD_ARAP_PASSWORD - RADIUS_MICROSOFT_MS_NEW_ARAP_PASSWORD - RADIUS_MICROSOFT_MS_ARAP_PASSWORD_CHANGE_REASON - RADIUS_MICROSOFT_MS_FILTER - RADIUS_MICROSOFT_MS_ACCT_AUTH_TYPE - RADIUS_MICROSOFT_MS_ACCT_EAP_TYPE - RADIUS_MICROSOFT_MS_CHAP2_RESPONSE - RADIUS_MICROSOFT_MS_CHAP2_SUCCESS - RADIUS_MICROSOFT_MS_CHAP2_PW - RADIUS_MICROSOFT_MS_PRIMARY_DNS_SERVER - RADIUS_MICROSOFT_MS_SECONDARY_DNS_SERVER - RADIUS_MICROSOFT_MS_PRIMARY_NBNS_SERVER - RADIUS_MICROSOFT_MS_SECONDARY_NBNS_SERVER - RADIUS_MICROSOFT_MS_ARAP_CHALLENGE - - - - - - - RADIUS_MICROSOFT_MS_CHAP_RESPONSE - - - - - - - - - RADIUS_MICROSOFT_MS_CHAP_ERROR - - - - - - - - - RADIUS_MICROSOFT_MS_CHAP_PW_1 - - - - - - - - - RADIUS_MICROSOFT_MS_CHAP_PW_2 - - - - - - - - - RADIUS_MICROSOFT_MS_CHAP_LM_ENC_PW - - - - - - - - - RADIUS_MICROSOFT_MS_CHAP_NT_ENC_PW - - - - - - - - - RADIUS_MICROSOFT_MS_MPPE_ENCRYPTION_POLICY - - - - - - - - - RADIUS_MICROSOFT_MS_MPPE_ENCRYPTION_TYPES - - - - - - - - - RADIUS_MICROSOFT_MS_RAS_VENDOR - - - - - - - - - RADIUS_MICROSOFT_MS_CHAP_DOMAIN - - - - - - - - - RADIUS_MICROSOFT_MS_CHAP_CHALLENGE - - - - - - - - - RADIUS_MICROSOFT_MS_CHAP_MPPE_KEYS - - - - - - - - - RADIUS_MICROSOFT_MS_BAP_USAGE - - - - - - - - - RADIUS_MICROSOFT_MS_LINK_UTILIZATION_THRESHOLD - - - - - - - - - RADIUS_MICROSOFT_MS_LINK_DROP_TIME_LIMIT - - - - - - - - - RADIUS_MICROSOFT_MS_MPPE_SEND_KEY - - - - - - - - - RADIUS_MICROSOFT_MS_MPPE_RECV_KEY - - - - - - - - - RADIUS_MICROSOFT_MS_RAS_VERSION - - - - - - - - - RADIUS_MICROSOFT_MS_OLD_ARAP_PASSWORD - - - - - - - - - RADIUS_MICROSOFT_MS_NEW_ARAP_PASSWORD - - - - - - - - - RADIUS_MICROSOFT_MS_ARAP_PASSWORD_CHANGE_REASON - - - - - - - - - RADIUS_MICROSOFT_MS_FILTER - - - - - - - - - RADIUS_MICROSOFT_MS_ACCT_AUTH_TYPE - - - - - - - - - RADIUS_MICROSOFT_MS_ACCT_EAP_TYPE - - - - - - - - - RADIUS_MICROSOFT_MS_CHAP2_RESPONSE - - - - - - - - - RADIUS_MICROSOFT_MS_CHAP2_SUCCESS - - - - - - - - - RADIUS_MICROSOFT_MS_CHAP2_PW - - - - - - - - - RADIUS_MICROSOFT_MS_PRIMARY_DNS_SERVER - - - - - - - - - RADIUS_MICROSOFT_MS_SECONDARY_DNS_SERVER - - - - - - - - - RADIUS_MICROSOFT_MS_PRIMARY_NBNS_SERVER - - - - - - - - - RADIUS_MICROSOFT_MS_SECONDARY_NBNS_SERVER - - - - - - - - - RADIUS_MICROSOFT_MS_ARAP_CHALLENGE - - - - - - - -
    -
    - diff --git a/reference/radius/examples.xml b/reference/radius/examples.xml deleted file mode 100644 index 23393df55202..000000000000 --- a/reference/radius/examples.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - &reftitle.examples; - - - Howto start? - - get a radius resource - configure the library - create the request - put attributes - send the request - receive attributes - close the radius resource (optional) - - Take also a look at the examples in this package. - - - The package contains an example php script. This script demonstrates howto - authenticate with radius using PAP or CHAP (md5). If you authenticate with - Microsoft Radius servers then its not possible to use CHAP (md5). If you - would like to authenticate with Microsoft Servers you have to use - MS-CHAPv1 or MS-CHAPv2, but its more complicated, because you need md4, - sha1 and des to generate the right data. The enclosed examples demonstrate - all authentication-methods, including MS-CHAPv1 and MS-CHAPv2. To get the - MS-CHAP to work you need the mcrypt and - the mhash extension, starting with - version 1.2 of the package, the mcrypt extension is no longer needed. - - - diff --git a/reference/radius/functions/radius-acct-open.xml b/reference/radius/functions/radius-acct-open.xml deleted file mode 100644 index e8e528743254..000000000000 --- a/reference/radius/functions/radius-acct-open.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - radius_acct_open - Creates a Radius handle for accounting - - - - &reftitle.description; - - resourceradius_acct_open - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a handle on success, &false; on error. This function only fails if - insufficient memory is available. - - - - - &reftitle.examples; - - <function>radius_acct_open</function> example - - -]]> - - - - - diff --git a/reference/radius/functions/radius-add-server.xml b/reference/radius/functions/radius-add-server.xml deleted file mode 100644 index df74a4b3368e..000000000000 --- a/reference/radius/functions/radius-add-server.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - radius_add_server - Adds a server - - - - &reftitle.description; - - boolradius_add_server - resourceradius_handle - stringhostname - intport - stringsecret - inttimeout - intmax_tries - - - radius_add_server may be called multiple times, and it - may be used together with radius_config. At most 10 - servers may be specified. When multiple servers are given, they are tried - in round-robin fashion until a valid response is received, or until each - server's max_tries limit has been reached. - - - - - &reftitle.parameters; - - - radius_handle - - - - - - - hostname - - - The hostname parameter specifies the server host, - either as a fully qualified domain name or as a dotted-quad IP address - in text form. - - - - - port - - - The port specifies the UDP port to contact on - the server. If port is given as 0, the library looks up the - radius/udp or - radacct/udp service in the - network services database, and uses the port found there. If no entry - is found, the library uses the standard Radius ports, 1812 for - authentication and 1813 for accounting. - - - - - secret - - - The shared secret for the server host is passed to the - secret parameter. The Radius protocol ignores - all but the leading 128 bytes of the shared secret. - - - - - timeout - - - The timeout for receiving replies from the server is passed to the - timeout parameter, in units of seconds. - - - - - max_tries - - - The maximum number of repeated requests to make before giving up is - passed into the max_tries. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>radius_add_server</function> example - -"; - exit; -} -?> -]]> - - - - - - &reftitle.seealso; - - radius_config - - - - diff --git a/reference/radius/functions/radius-auth-open.xml b/reference/radius/functions/radius-auth-open.xml deleted file mode 100644 index ff99e4e99cff..000000000000 --- a/reference/radius/functions/radius-auth-open.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - radius_auth_open - Creates a Radius handle for authentication - - - - &reftitle.description; - - resourceradius_auth_open - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a handle on success, &false; on error. This function only fails if - insufficient memory is available. - - - - - &reftitle.examples; - - <function>radius_auth_open</function> example - - -]]> - - - - - diff --git a/reference/radius/functions/radius-close.xml b/reference/radius/functions/radius-close.xml deleted file mode 100644 index 9bfd0869fdf6..000000000000 --- a/reference/radius/functions/radius-close.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - radius_close - Frees all ressources - - - - &reftitle.description; - - boolradius_close - resourceradius_handle - - - It is not needed to call this function because php frees all resources at - the end of each request. - - - - - &reftitle.parameters; - - &radius.parameter.handle; - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/radius/functions/radius-config.xml b/reference/radius/functions/radius-config.xml deleted file mode 100644 index 9913aab34f06..000000000000 --- a/reference/radius/functions/radius-config.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - radius_config - Causes the library to read the given configuration file - - - - &reftitle.description; - - boolradius_config - resourceradius_handle - stringfile - - - Before issuing any Radius requests, the library must be made aware of the - servers it can contact. The easiest way to configure the library is to - call radius_config. radius_config - causes the library to read a configuration file whose format is described - in radius.conf. - - - - - &reftitle.parameters; - - - radius_handle - - - - - - - - file - - - The pathname of the configuration file is passed as the file argument - to radius_config. The library can also be - configured programmatically by calls to - radius_add_server. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - radius_add_server - - - - diff --git a/reference/radius/functions/radius-create-request.xml b/reference/radius/functions/radius-create-request.xml deleted file mode 100644 index 543ac9a626ec..000000000000 --- a/reference/radius/functions/radius-create-request.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - radius_create_request - Create accounting or authentication request - - - - &reftitle.description; - - boolradius_create_request - resourceradius_handle - inttype - - - A Radius request consists of a code specifying the kind of request, and - zero or more attributes which provide additional information. To begin - constructing a new request, call radius_create_request. - - - - Attention: You must call this function, before you can put any attribute! - - - - - - &reftitle.parameters; - - - radius_handle - - - - - - - type - - - Type is RADIUS_ACCESS_REQUEST or - RADIUS_ACCOUNTING_REQUEST. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>radius_create_request</function> example - -"; - exit; -} -?> -]]> - - - - - - &reftitle.seealso; - - radius_send_request - - - - diff --git a/reference/radius/functions/radius-cvt-addr.xml b/reference/radius/functions/radius-cvt-addr.xml deleted file mode 100644 index 3ad4396805a3..000000000000 --- a/reference/radius/functions/radius-cvt-addr.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - radius_cvt_addr - Converts raw data to IP-Address - - - - &reftitle.description; - - stringradius_cvt_addr - stringdata - - - Converts raw data to IP-Address - - - - - &reftitle.parameters; - - - data - - - Input data - - - - - - - - &reftitle.returnvalues; - - Returns the IP-Address. - - - - - &reftitle.examples; - - <function>radius_cvt_addr</function> example - -\n"; - break; - - case RADIUS_FRAMED_IP_NETMASK: - $mask = radius_cvt_addr($data); - echo "MASK: $mask
    \n"; - break; - } -} -?> -]]> -
    -
    -
    - - - &reftitle.seealso; - - radius_cvt_int - radius_cvt_string - - -
    - diff --git a/reference/radius/functions/radius-cvt-int.xml b/reference/radius/functions/radius-cvt-int.xml deleted file mode 100644 index 83b0ef72e258..000000000000 --- a/reference/radius/functions/radius-cvt-int.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - radius_cvt_int - Converts raw data to integer - - - - &reftitle.description; - - intradius_cvt_int - stringdata - - - Converts raw data to integer - - - - - &reftitle.parameters; - - - data - - - Input data - - - - - - - - &reftitle.returnvalues; - - Returns the integer, retrieved from data. - - - - - &reftitle.examples; - - <function>radius_cvt_int</function> example - -\n"; - break; - } -} -?> -]]> - - - - - - &reftitle.seealso; - - radius_cvt_addr - radius_cvt_string - - - - diff --git a/reference/radius/functions/radius-cvt-string.xml b/reference/radius/functions/radius-cvt-string.xml deleted file mode 100644 index 8e84a2e3e05c..000000000000 --- a/reference/radius/functions/radius-cvt-string.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - radius_cvt_string - Converts raw data to string - - - - &reftitle.description; - - stringradius_cvt_string - stringdata - - - Converts raw data to string - - - - - &reftitle.parameters; - - - data - - - Input data - - - - - - - - &reftitle.returnvalues; - - Returns the string, retrieved from data. - - - - - &reftitle.examples; - - <function>radius_cvt_string</function> example - -\n"; - break; - } -} -?> -]]> - - - - - - &reftitle.seealso; - - radius_cvt_addr - radius_cvt_int - - - - diff --git a/reference/radius/functions/radius-demangle-mppe-key.xml b/reference/radius/functions/radius-demangle-mppe-key.xml deleted file mode 100644 index 0fbf976de672..000000000000 --- a/reference/radius/functions/radius-demangle-mppe-key.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - radius_demangle_mppe_key - Derives mppe-keys from mangled data - - - - &reftitle.description; - - stringradius_demangle_mppe_key - resourceradius_handle - stringmangled - - - When using MPPE with MS-CHAPv2, the send- and recv-keys are mangled - (see RFC 2548), however this function is - useless, because I don't think that there is or will be a PPTP-MPPE - implementation in PHP. - - - - - &reftitle.parameters; - - &radius.parameter.handle; - - mangled - - - The mangled data to demangle - - - - - - - - &reftitle.returnvalues; - - Returns the demangled string, or &false; on error. - - - - diff --git a/reference/radius/functions/radius-demangle.xml b/reference/radius/functions/radius-demangle.xml deleted file mode 100644 index 7040e2ae5511..000000000000 --- a/reference/radius/functions/radius-demangle.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - radius_demangle - Demangles data - - - - &reftitle.description; - - stringradius_demangle - resourceradius_handle - stringmangled - - - Some data (Passwords, MS-CHAPv1 MPPE-Keys) is mangled for security reasons, - and must be demangled before you can use them. - - - - - &reftitle.parameters; - - &radius.parameter.handle; - - mangled - - - The mangled data to demangle - - - - - - - - &reftitle.returnvalues; - - Returns the demangled string, or &false; on error. - - - - diff --git a/reference/radius/functions/radius-get-attr.xml b/reference/radius/functions/radius-get-attr.xml deleted file mode 100644 index f47d90642ebe..000000000000 --- a/reference/radius/functions/radius-get-attr.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - radius_get_attr - Extracts an attribute - - - - &reftitle.description; - - mixedradius_get_attr - resourceradius_handle - - - Like Radius requests, each response may contain zero or more attributes. - After a response has been received successfully by - radius_send_request, its attributes can be extracted - one by one using radius_get_attr. Each time - radius_get_attr is called, it gets the next attribute - from the current response. - - - - - &reftitle.parameters; - - &radius.parameter.handle; - - - - - &reftitle.returnvalues; - - Returns an associative array containing the attribute-type and the data, or - error number <= 0. - - - - - &reftitle.examples; - - <function>radius_get_attr</function> example - - -]]> - - - - - - &reftitle.seealso; - - radius_put_attr - radius_get_vendor_attr - radius_put_vendor_attr - radius_send_request - - - - diff --git a/reference/radius/functions/radius-get-tagged-attr-data.xml b/reference/radius/functions/radius-get-tagged-attr-data.xml deleted file mode 100644 index 6e6e043da02b..000000000000 --- a/reference/radius/functions/radius-get-tagged-attr-data.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - radius_get_tagged_attr_data - Extracts the data from a tagged attribute - - - - &reftitle.description; - - stringfalseradius_get_tagged_attr_data - stringdata - - - If a tagged attribute has been returned from - radius_get_attr, - radius_get_tagged_attr_data will return the data from - the attribute. - - - - - &reftitle.parameters; - - - data - - - The tagged attribute to be decoded. - - - - - - - - &reftitle.returnvalues; - - Returns the data from the tagged attribute &return.falseforfailure;. - - - - - &reftitle.examples; - - <function>radius_get_tagged_attr_data</function> example - - -]]> - - - - - - &reftitle.seealso; - - radius_get_attr - radius_get_tagged_attr_tag - - - - diff --git a/reference/radius/functions/radius-get-tagged-attr-tag.xml b/reference/radius/functions/radius-get-tagged-attr-tag.xml deleted file mode 100644 index edd086c15921..000000000000 --- a/reference/radius/functions/radius-get-tagged-attr-tag.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - radius_get_tagged_attr_tag - Extracts the tag from a tagged attribute - - - - &reftitle.description; - - intfalseradius_get_tagged_attr_tag - stringdata - - - If a tagged attribute has been returned from - radius_get_attr, - radius_get_tagged_attr_data will return the tag from - the attribute. - - - - - &reftitle.parameters; - - - data - - - The tagged attribute to be decoded. - - - - - - - - &reftitle.returnvalues; - - Returns the tag from the tagged attribute &return.falseforfailure;. - - - - - &reftitle.examples; - - <function>radius_get_tagged_attr_tag</function> example - - -]]> - - - - - - &reftitle.seealso; - - radius_get_attr - radius_get_tagged_attr_data - - - - diff --git a/reference/radius/functions/radius-get-vendor-attr.xml b/reference/radius/functions/radius-get-vendor-attr.xml deleted file mode 100644 index d4ea39c22dbe..000000000000 --- a/reference/radius/functions/radius-get-vendor-attr.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - radius_get_vendor_attr - Extracts a vendor specific attribute - - - - &reftitle.description; - - arrayfalseradius_get_vendor_attr - stringdata - - - If radius_get_attr returns - RADIUS_VENDOR_SPECIFIC, - radius_get_vendor_attr may be called to determine the - vendor. - - - - - &reftitle.parameters; - - - data - - - Input data - - - - - - - - &reftitle.returnvalues; - - Returns an associative array containing the attribute-type, vendor and the - data, or &false; on error. - - - - - &reftitle.examples; - - <function>radius_get_vendor_attr</function> example - - -]]> - - - - - - &reftitle.seealso; - - radius_get_attr - radius_put_vendor_attr - - - - diff --git a/reference/radius/functions/radius-put-addr.xml b/reference/radius/functions/radius-put-addr.xml deleted file mode 100644 index 721f3873a440..000000000000 --- a/reference/radius/functions/radius-put-addr.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - radius_put_addr - Attaches an IP address attribute - - - - &reftitle.description; - - boolradius_put_addr - resourceradius_handle - inttype - stringaddr - intoptions0 - inttag - - - Attaches an IP address attribute to the current RADIUS request. - - &radius.request.required; - - - - &reftitle.parameters; - - &radius.parameter.handle; - &radius.parameter.attribute-type; - - addr - - - An IPv4 address in string form, such as 10.0.0.1. - - - - &radius.parameter.options; - &radius.parameter.tag; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL radius 1.3.0 - - The options and tag - parameters were added. - - - - - - - - - diff --git a/reference/radius/functions/radius-put-attr.xml b/reference/radius/functions/radius-put-attr.xml deleted file mode 100644 index b45d50a763b8..000000000000 --- a/reference/radius/functions/radius-put-attr.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - radius_put_attr - Attaches a binary attribute - - - - &reftitle.description; - - boolradius_put_attr - resourceradius_handle - inttype - stringvalue - intoptions0 - inttag - - - Attaches a binary attribute to the current RADIUS request. - - &radius.request.required; - - - - &reftitle.parameters; - - &radius.parameter.handle; - &radius.parameter.attribute-type; - - value - - - The attribute value, which will be treated as a raw binary string. - - - - &radius.parameter.options; - &radius.parameter.tag; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL radius 1.3.0 - - The options and tag - parameters were added. - - - - - - - - - &reftitle.examples; - - <function>radius_put_attr</function> example - - "; - exit; -} -?> -]]> - - - - - - &reftitle.seealso; - - radius_get_attr - radius_get_vendor_attr - radius_put_vendor_attr - - - - diff --git a/reference/radius/functions/radius-put-int.xml b/reference/radius/functions/radius-put-int.xml deleted file mode 100644 index 983fe0441a6e..000000000000 --- a/reference/radius/functions/radius-put-int.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - radius_put_int - Attaches an integer attribute - - - - &reftitle.description; - - boolradius_put_int - resourceradius_handle - inttype - intvalue - intoptions0 - inttag - - - Attaches an integer attribute to the current RADIUS request. - - &radius.request.required; - - - - &reftitle.parameters; - - &radius.parameter.handle; - &radius.parameter.attribute-type; - - value - - - The attribute value. - - - - &radius.parameter.options; - &radius.parameter.tag; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL radius 1.3.0 - - The options and tag - parameters were added. - - - - - - - - - &reftitle.examples; - - <function>radius_put_int</function> example - -"; - exit; -} -?> -]]> - - - - - - &reftitle.seealso; - - radius_put_string - radius_put_vendor_int - radius_put_vendor_string - - - - diff --git a/reference/radius/functions/radius-put-string.xml b/reference/radius/functions/radius-put-string.xml deleted file mode 100644 index 712498540f63..000000000000 --- a/reference/radius/functions/radius-put-string.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - radius_put_string - Attaches a string attribute - - - - &reftitle.description; - - boolradius_put_string - resourceradius_handle - inttype - stringvalue - intoptions0 - inttag - - - Attaches a string attribute to the current RADIUS request. In general, - radius_put_attr is a more useful function for - attaching string attributes, as it is binary safe. - - &radius.request.required; - - - - &reftitle.parameters; - - &radius.parameter.handle; - &radius.parameter.attribute-type; - - value - - - The attribute value. This value is expected by the underlying library - to be null terminated, therefore this parameter is not binary safe. - - - - &radius.parameter.options; - &radius.parameter.tag; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL radius 1.3.0 - - The options and tag - parameters were added. - - - - - - - - - &reftitle.examples; - - <function>radius_put_string</function> example - -"; - exit; -} -?> -]]> - - - - - - &reftitle.seealso; - - radius_put_int - radius_put_vendor_int - radius_put_vendor_string - - - - diff --git a/reference/radius/functions/radius-put-vendor-addr.xml b/reference/radius/functions/radius-put-vendor-addr.xml deleted file mode 100644 index 2c574a186506..000000000000 --- a/reference/radius/functions/radius-put-vendor-addr.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - radius_put_vendor_addr - Attaches a vendor specific IP address attribute - - - - &reftitle.description; - - boolradius_put_vendor_addr - resourceradius_handle - intvendor - inttype - stringaddr - - - Attaches an IP address vendor specific attribute to the current RADIUS - request. - - &radius.request.required; - - - - &reftitle.parameters; - - &radius.parameter.handle; - &radius.parameter.vendor; - &radius.parameter.attribute-type; - - addr - - - An IPv4 address in string form, such as 10.0.0.1. - - - - &radius.parameter.options; - &radius.parameter.tag; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL radius 1.3.0 - - The options and tag - parameters were added. - - - - - - - - - diff --git a/reference/radius/functions/radius-put-vendor-attr.xml b/reference/radius/functions/radius-put-vendor-attr.xml deleted file mode 100644 index f75af26f3a17..000000000000 --- a/reference/radius/functions/radius-put-vendor-attr.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - radius_put_vendor_attr - Attaches a vendor specific binary attribute - - - - &reftitle.description; - - boolradius_put_vendor_attr - resourceradius_handle - intvendor - inttype - stringvalue - intoptions0 - inttag - - - Attaches a vendor specific binary attribute to the current RADIUS request. - - &radius.request.required; - - - - &reftitle.parameters; - - &radius.parameter.handle; - &radius.parameter.vendor; - &radius.parameter.attribute-type; - - value - - - The attribute value, which will be treated as a raw binary string. - - - - &radius.parameter.options; - &radius.parameter.tag; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL radius 1.3.0 - - The options and tag - parameters were added. - - - - - - - - - &reftitle.examples; - - <function>radius_put_vendor_attr</function> example - -"; - exit; -} -?> -]]> - - - - - - &reftitle.seealso; - - radius_get_vendor_attr - - - - - diff --git a/reference/radius/functions/radius-put-vendor-int.xml b/reference/radius/functions/radius-put-vendor-int.xml deleted file mode 100644 index 16aeae851b77..000000000000 --- a/reference/radius/functions/radius-put-vendor-int.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - radius_put_vendor_int - Attaches a vendor specific integer attribute - - - - &reftitle.description; - - boolradius_put_vendor_int - resourceradius_handle - intvendor - inttype - intvalue - intoptions0 - inttag - - - Attaches a vendor specific integer attribute to the current RADIUS request. - - &radius.request.required; - - - - &reftitle.parameters; - - &radius.parameter.handle; - &radius.parameter.vendor; - &radius.parameter.attribute-type; - - value - - - The attribute value. - - - - &radius.parameter.options; - &radius.parameter.tag; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL radius 1.3.0 - - The options and tag - parameters were added. - - - - - - - - - &reftitle.seealso; - - radius_put_vendor_string - - - - diff --git a/reference/radius/functions/radius-put-vendor-string.xml b/reference/radius/functions/radius-put-vendor-string.xml deleted file mode 100644 index 46eb4cdc9c7b..000000000000 --- a/reference/radius/functions/radius-put-vendor-string.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - radius_put_vendor_string - Attaches a vendor specific string attribute - - - - &reftitle.description; - - boolradius_put_vendor_string - resourceradius_handle - intvendor - inttype - stringvalue - intoptions0 - inttag - - - Attaches a vendor specific string attribute to the current RADIUS request. - In general, radius_put_vendor_attr is a more useful - function for attaching string attributes, as it is binary safe. - - &radius.request.required; - - - - &reftitle.parameters; - - &radius.parameter.handle; - &radius.parameter.vendor; - &radius.parameter.attribute-type; - - value - - - The attribute value. This value is expected by the underlying library - to be null terminated, therefore this parameter is not binary safe. - - - - &radius.parameter.options; - &radius.parameter.tag; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL radius 1.3.0 - - The options and tag - parameters were added. - - - - - - - - - &reftitle.seealso; - - radius_put_vendor_int - - - - diff --git a/reference/radius/functions/radius-request-authenticator.xml b/reference/radius/functions/radius-request-authenticator.xml deleted file mode 100644 index 796482b10f0d..000000000000 --- a/reference/radius/functions/radius-request-authenticator.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - radius_request_authenticator - Returns the request authenticator - - - - &reftitle.description; - - stringradius_request_authenticator - resourceradius_handle - - - The request authenticator is needed for demangling mangled data like - passwords and encryption-keys. - - - - - &reftitle.parameters; - - &radius.parameter.handle; - - - - - &reftitle.returnvalues; - - Returns the request authenticator as string, or &false; on error. - - - - - &reftitle.seealso; - - radius_demangle - - - - diff --git a/reference/radius/functions/radius-salt-encrypt-attr.xml b/reference/radius/functions/radius-salt-encrypt-attr.xml deleted file mode 100644 index ae4f5d5585ef..000000000000 --- a/reference/radius/functions/radius-salt-encrypt-attr.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - radius_salt_encrypt_attr - Salt-encrypts a value - - - - &reftitle.description; - - stringfalseradius_salt_encrypt_attr - resourceradius_handle - stringdata - - - Applies the RADIUS salt-encryption algorithm to the given value. - - - In general, this is achieved automatically by providing the - RADIUS_OPTION_SALT option to an attribute setter - function, but this function can be used if low-level request construction - is required. - - - - - &reftitle.parameters; - - - data - - - The data to be salt-encrypted. - - - - - - - - &reftitle.returnvalues; - - Returns the salt-encrypted data &return.falseforfailure;. - - - - - &reftitle.seealso; - - radius_put_addr - radius_put_attr - radius_put_int - radius_put_string - - - - diff --git a/reference/radius/functions/radius-send-request.xml b/reference/radius/functions/radius-send-request.xml deleted file mode 100644 index cc30df0d6343..000000000000 --- a/reference/radius/functions/radius-send-request.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - radius_send_request - Sends the request and waits for a reply - - - - &reftitle.description; - - intradius_send_request - resourceradius_handle - - - After the Radius request has been constructed, it is sent by - radius_send_request. - - - The radius_send_request function sends the request and - waits for a valid reply, retrying the defined servers in round-robin - fashion as necessary. - - - - - &reftitle.parameters; - - &radius.parameter.handle; - - - - - &reftitle.returnvalues; - - If a valid response is received, radius_send_request - returns the Radius code which specifies the type of the response. This will - typically be RADIUS_ACCESS_ACCEPT, - RADIUS_ACCESS_REJECT, or - RADIUS_ACCESS_CHALLENGE. If no valid response is - received, radius_send_request returns &false;. - - - - - &reftitle.seealso; - - radius_create_request - - - - diff --git a/reference/radius/functions/radius-server-secret.xml b/reference/radius/functions/radius-server-secret.xml deleted file mode 100644 index 79cfd6b30e91..000000000000 --- a/reference/radius/functions/radius-server-secret.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - radius_server_secret - Returns the shared secret - - - - &reftitle.description; - - stringradius_server_secret - resourceradius_handle - - - The shared secret is needed as salt for demangling mangled data like - passwords and encryption-keys. - - - - - &reftitle.parameters; - - &radius.parameter.handle; - - - - - &reftitle.returnvalues; - - Returns the server's shared secret as string, or &false; on error. - - - - diff --git a/reference/radius/functions/radius-strerror.xml b/reference/radius/functions/radius-strerror.xml deleted file mode 100644 index 75b441af92ab..000000000000 --- a/reference/radius/functions/radius-strerror.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - radius_strerror - Returns an error message - - - - &reftitle.description; - - stringradius_strerror - resourceradius_handle - - - If Radius-functions fail then they record an error message. This error - message can be retrieved with this function. - - - - - &reftitle.parameters; - - &radius.parameter.handle; - - - - - &reftitle.returnvalues; - - Returns error messages as string from failed radius functions. - - - - diff --git a/reference/radius/reference.xml b/reference/radius/reference.xml deleted file mode 100644 index 91feca46d95e..000000000000 --- a/reference/radius/reference.xml +++ /dev/null @@ -1,28 +0,0 @@ - - - - - Radius &Functions; - - &reference.radius.entities.functions; - - - diff --git a/reference/radius/setup.xml b/reference/radius/setup.xml deleted file mode 100644 index 6cd9dd57c6fd..000000000000 --- a/reference/radius/setup.xml +++ /dev/null @@ -1,33 +0,0 @@ - - - - - &reftitle.setup; - - - &reference.radius.configure; - - - - - - diff --git a/reference/radius/versions.xml b/reference/radius/versions.xml deleted file mode 100644 index b659f6833c40..000000000000 --- a/reference/radius/versions.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/rar/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/rar/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/rar/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/rar/book.xml b/reference/rar/book.xml deleted file mode 100644 index 47e9a39e9cd6..000000000000 --- a/reference/rar/book.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - Rar Archiving - Rar - - - - &reftitle.intro; - - Rar is a powerful and effective archiver created by Eugene Roshal. - This extension gives you possibility to read Rar archives but - doesn't support writing Rar archives, because this is not supported - by the UnRar library and is directly prohibited by its license. - - - More information about Rar and UnRar can be found at &url.rar;. - - - - - &reference.rar.setup; - &reference.rar.constants; - &reference.rar.examples; - &reference.rar.reference; - &reference.rar.rararchive; - &reference.rar.rarentry; - &reference.rar.rarexception; - - - diff --git a/reference/rar/constants.xml b/reference/rar/constants.xml deleted file mode 100644 index 1eee6cdd9696..000000000000 --- a/reference/rar/constants.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - - - RAR_HOST_MSDOS - (int) - - - - Use RarEntry::HOST_MSDOS instead. - - - - - - RAR_HOST_OS2 - (int) - - - - Use RarEntry::HOST_OS2 instead. - - - - - - RAR_HOST_WIN32 - (int) - - - - Use RarEntry::HOST_WIN32 instead. - - - - - - RAR_HOST_UNIX - (int) - - - - Use RarEntry::HOST_UNIX instead. - - - - - - RAR_HOST_BEOS - (int) - - - - Use RarEntry::HOST_BEOS instead. - - - - - - - - diff --git a/reference/rar/examples.xml b/reference/rar/examples.xml deleted file mode 100644 index e8fa7cbc7853..000000000000 --- a/reference/rar/examples.xml +++ /dev/null @@ -1,171 +0,0 @@ - - - - &reftitle.examples; - - - See also the examples under rar:// wrapper. - - - - On-the-fly decompression - -getEntries(); -if ($entries === FALSE) - die("Cannot retrieve entries"); - -if (!array_key_exists($index, $entries)) - die("No such index: $index"); - -$orfilename = $entries[$index]->getName(); //UTF-8 encoded - -$filesize = $entries[$index]->getUnpackedSize(); - -/* you could check HTTP_IF_MODIFIED_SINCE here and compare with - * $entries[$index]->getFileTime(). You could also send a - * "Last modified" header */ - -$fp = $entries[$index]->getStream(); -if ($fp === FALSE) - die("Cannot open file with index $index insided the archive."); - -$arch->close(); //no longer needed; stream is independent - -function detectUserAgent() { - if (!array_key_exists('HTTP_USER_AGENT', $_SERVER)) - return "Other"; - - $uas = $_SERVER['HTTP_USER_AGENT']; - if (preg_match("@Opera/@", $uas)) - return "Opera"; - if (preg_match("@Firefox/@", $uas)) - return "Firefox"; - if (preg_match("@Chrome/@", $uas)) - return "Chrome"; - if (preg_match("@MSIE ([0-9.]+);@", $uas, $matches)) { - if (((float) $matches[1]) >= 7.0) - return "IE"; - } - - return "Other"; -} - -/* - * We have 3 options: - * - For FF and Opera, which support RFC 2231, use that format. - * - For IE and Chrome, use attwithfnrawpctenclong - * (http://greenbytes.de/tech/tc2231/#attwithfnrawpctenclong) - * - For the others, convert to ISO-8859-1, if possible - */ -$formatRFC2231 = 'Content-Disposition: attachment; filename*=UTF-8\'\'%s'; -$formatDef = 'Content-Disposition: attachment; filename="%s"'; - -switch (detectUserAgent()) { - case "Opera": - case "Firefox": - $orfilename = rawurlencode($orfilename); - $format = $formatRFC2231; - break; - - case "IE": - case "Chrome": - $orfilename = rawurlencode($orfilename); - $format = $formatDef; - break; - default: - if (function_exists('iconv')) - $orfilename = - @iconv("UTF-8", "ISO-8859-1//TRANSLIT", $orfilename); - $format = $formatDef; -} - -header(sprintf($format, $orfilename)); -//cannot send error messages from now on (headers already sent) - -//replace by real content type, perhaps infering from the file extension -$contentType = "application/octet-stream"; -header("Content-Type: $contentType"); - -header("Content-Transfer-Encoding: binary"); - -header("Content-Length: $filesize"); - -if ($_SERVER['REQUEST_METHOD'] == "HEAD") - die(); - -while (!feof($fp)) { - $s = @fread($fp, 8192); - if ($s === false) - break; //useless to send error messages - - echo $s; -} -?> -]]> - - - - This example opens a RAR file and presents the requested file inside the RAR archive for download to the client. - - - - RAR extension filesystem extraction example - -getName() . "\n"; - echo 'Packed size: ' . $entry->getPackedSize() . "\n"; - echo 'Unpacked size: ' . $entry->getUnpackedSize() . "\n"; - - $entry->extract('/dir/extract/to/'); -} - -rar_close($rar_file); - -?> -]]> - - - - This example opens a RAR file archive and extracts each entry to the - specified directory. - - - - diff --git a/reference/rar/functions/rar-wrapper-cache-stats.xml b/reference/rar/functions/rar-wrapper-cache-stats.xml deleted file mode 100644 index b8b8c2b413d9..000000000000 --- a/reference/rar/functions/rar-wrapper-cache-stats.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - rar_wrapper_cache_stats - Cache hits and misses for the URL wrapper - - - - &reftitle.description; - - stringrar_wrapper_cache_stats - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/rar/rararchive.xml b/reference/rar/rararchive.xml deleted file mode 100644 index a158b5adb053..000000000000 --- a/reference/rar/rararchive.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - The RarArchive class - RarArchive - - - - -
    - &reftitle.intro; - - This class represents a RAR archive, which may be formed by several volumes (parts) and which contains - a number of RAR entries (i.e., files, directories and other special objects such as symbolic links). - - - Objects of this class can be traversed, yielding the entries stored in the respective RAR archive. - Those entries can also be obtained through RarArchive::getEntry and - RarArchive::getEntries. - -
    - - -
    - &reftitle.classsynopsis; - - - - RarArchive - - - - - final - RarArchive - - - - Traversable - - - - - &Methods; - - - - -
    - -
    - - &reference.rar.entities.rararchive; - -
    - diff --git a/reference/rar/rararchive/close.xml b/reference/rar/rararchive/close.xml deleted file mode 100644 index bdcbc7f67fff..000000000000 --- a/reference/rar/rararchive/close.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - RarArchive::close - rar_close - Close RAR archive and free all resources - - - - &reftitle.description; - &style.oop; (method): - - public boolRarArchive::close - - - &style.procedural;: - - boolrar_close - RarArchiverarfile - - - Close RAR archive and free all allocated resources. - - - - - &reftitle.parameters; - - - rarfile - - - A RarArchive object, opened with rar_open. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL rar 2.0.0 - - The RAR entries returned by RarArchive::getEntry - and RarArchive::getEntries are now invalidated when - calling this method. This means that all instance methods called for - such entries and not guaranteed to succeed. - - - - - - - - - &reftitle.examples; - - &style.oop; - -close(); -echo $rar_arch."\n"; -?> -]]> - - &example.outputs.similar; - - - - - - &style.procedural; - - -]]> - - - - - - - diff --git a/reference/rar/rararchive/getcomment.xml b/reference/rar/rararchive/getcomment.xml deleted file mode 100644 index 3c197af145f7..000000000000 --- a/reference/rar/rararchive/getcomment.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - RarArchive::getComment - rar_comment_get - Get comment text from the RAR archive - - - - &reftitle.description; - &style.oop; (method): - - public stringRarArchive::getComment - - - &style.procedural;: - - stringrar_comment_get - RarArchiverarfile - - - Get the (global) comment stored in the RAR archive. It may be up to 64 KiB long. - - - - This extension does not support comments at the entry level. - - - - - - &reftitle.parameters; - - - rarfile - - - A RarArchive object, opened with rar_open. - - - - - - - - &reftitle.returnvalues; - - Returns the comment or &null; if there is none. - - - - RAR has currently no support for unicode comments. The encoding of the - result of this function is not specified, but it will probably be - Windows-1252. - - - - - - &reftitle.examples; - - &style.oop; - -getComment(); -?> -]]> - - &example.outputs.similar; - - - - - - &style.procedural; - - -]]> - - - - - - - diff --git a/reference/rar/rararchive/getentries.xml b/reference/rar/rararchive/getentries.xml deleted file mode 100644 index 981992e53b0b..000000000000 --- a/reference/rar/rararchive/getentries.xml +++ /dev/null @@ -1,169 +0,0 @@ - - - - - RarArchive::getEntries - rar_list - Get full list of entries from the RAR archive - - - - &reftitle.description; - &style.oop; (method): - - public arrayfalseRarArchive::getEntries - - - &style.procedural;: - - arrayfalserar_list - RarArchiverarfile - - - Get entries list (files and directories) from the RAR archive. - - - - If the archive has - entries with the same name, this method, together with RarArchive - foreach iteration and array-like access with numeric indexes, - are the only ones to access all the entries (i.e., - RarArchive::getEntry and the - rar:// wrapper are insufficient). - - - - - - &reftitle.parameters; - - - rarfile - - - A RarArchive object, opened with rar_open. - - - - - - - - &reftitle.returnvalues; - - rar_list returns array of RarEntry objects - &return.falseforfailure;. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL rar 3.0.0 - - Support for RAR archives with repeated entry names is no longer defective. - - - - - - - - - &reftitle.examples; - - &style.oop; - -getEntries(); -if ($rar_entries === FALSE) - die("Could not retrieve entries."); - -echo "Found " . count($rar_entries) . " entries.\n"; - -foreach ($rar_entries as $e) { - echo $e; - echo "\n"; -} -$rar_arch->close(); -?> -]]> - - &example.outputs.similar; - - - - - - &style.procedural; - - -]]> - - - - - - &reftitle.seealso; - - RarArchive::getEntry - rar:// wrapper - - - - - diff --git a/reference/rar/rararchive/getentry.xml b/reference/rar/rararchive/getentry.xml deleted file mode 100644 index f98731c75df7..000000000000 --- a/reference/rar/rararchive/getentry.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - RarArchive::getEntry - rar_entry_get - Get entry object from the RAR archive - - - - &reftitle.description; - &style.oop; (method): - - public RarEntryfalseRarArchive::getEntry - stringentryname - - &style.procedural;: - - RarEntryfalserar_entry_get - RarArchiverarfile - stringentryname - - - Get entry object (file or directory) from the RAR archive. - - - You can also get entry objects using RarArchive::getEntries. - Note that a RAR archive can have multiple entries with the same name; this method - will retrieve only the first. - - - - - &reftitle.parameters; - - - rarfile - - - A RarArchive object, opened with rar_open. - - - - - entryname - - - Path to the entry within the RAR archive. - - - The path must be the same returned by - RarEntry::getName. - - - - - - - - &reftitle.returnvalues; - - Returns the matching RarEntry object &return.falseforfailure;. - - - - - &reftitle.examples; - - &style.oop; - -getEntry('tese.txt'); -if ($rar_entry === FALSE) - die("Could not get such entry"); -echo get_class($rar_entry)."\n"; -echo $rar_entry; -$rar_arch->close(); -?> -]]> - - &example.outputs.similar; - - - - - - &style.procedural; - - -]]> - - - - - - &reftitle.seealso; - - RarArchive::getEntries - rar:// wrapper - - - - - diff --git a/reference/rar/rararchive/isbroken.xml b/reference/rar/rararchive/isbroken.xml deleted file mode 100644 index 1b1a5046f471..000000000000 --- a/reference/rar/rararchive/isbroken.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - RarArchive::isBroken - rar_broken_is - Test whether an archive is broken (incomplete) - - - - &reftitle.description; - &style.oop; (method): - - public boolRarArchive::isBroken - - - &style.procedural;: - - boolrar_broken_is - RarArchiverarfile - - - This function determines whether an archive is incomplete, i.e., if a volume is missing or a volume is truncated. - - - - - &reftitle.parameters; - - - rarfile - - - A RarArchive object, opened with rar_open. - - - - - - - - &reftitle.returnvalues; - - Returns &true; if the archive is broken, &false; otherwise. This function may also - return &false; if the passed file has already been closed. The only way - to tell the two cases apart is to enable - exceptions with RarException::setUsingExceptions; however, - this should be unnecessary as a program should not operate on closed files. - - - - - &reftitle.examples; - - &style.oop; - -isBroken()); -?> -]]> - - &example.outputs.similar; - - - - - - &style.procedural; - - -]]> - - - - - - &reftitle.seealso; - - RarArchive::setAllowBroken - - - - - diff --git a/reference/rar/rararchive/issolid.xml b/reference/rar/rararchive/issolid.xml deleted file mode 100644 index b111a94ed136..000000000000 --- a/reference/rar/rararchive/issolid.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - RarArchive::isSolid - rar_solid_is - Check whether the RAR archive is solid - - - - &reftitle.description; - &style.oop; (method): - - public boolRarArchive::isSolid - - - &style.procedural;: - - boolrar_solid_is - RarArchiverarfile - - - Check whether the RAR archive is solid. Individual file extraction is slower on solid - archives. - - - - - &reftitle.parameters; - - - rarfile - - - A RarArchive object, opened with rar_open. - - - - - - - - &reftitle.returnvalues; - - Returns &true; if the archive is solid, &false; otherwise. - - - - - &reftitle.examples; - - &style.oop; - -isSolid()?'yes':'no') ."\n"; -echo "$arch2: " . ($arch2->isSolid()?'yes':'no') . "\n"; -?> -]]> - - &example.outputs.similar; - - - - - - &style.procedural; - - -]]> - - - - - - diff --git a/reference/rar/rararchive/open.xml b/reference/rar/rararchive/open.xml deleted file mode 100644 index b7014b3216ab..000000000000 --- a/reference/rar/rararchive/open.xml +++ /dev/null @@ -1,237 +0,0 @@ - - - - - RarArchive::open - rar_open - Open RAR archive - - - - &reftitle.description; - &style.oop; (method): - - public static RarArchivefalseRarArchive::open - stringfilename - stringpasswordNULL - callablevolume_callbackNULL - - &style.procedural;: - - RarArchivefalserar_open - stringfilename - stringpasswordNULL - callablevolume_callbackNULL - - - Open specified RAR archive and return RarArchive instance representing it. - - - - If opening a multi-volume archive, the path of the first volume should be passed as the first parameter. - Otherwise, not all files will be shown. This is by design. - - - - - - &reftitle.parameters; - - - filename - - - Path to the Rar archive. - - - - - password - - - A plain password, if needed to decrypt the headers. It will also be used by default - if encrypted files are found. Note that the files may have - different passwords in respect to the headers and among them. - - - - - volume_callback - - - A function that receives one parameter – the path of the volume - that was not found – and returns a string with the correct path - for such volume or &null; if such volume does - not exist or is not known. The programmer should ensure the - passed function doesn't cause loops as this function is called - repeatedly if the path returned in a previous call did not - correspond to the needed volume. Specifying this parameter omits - the notice that would otherwise be emitted whenever a volume is - not found; an implementation that only returns &null; - can therefore be used to merely omit such notices. - - - - - - - Prior to version 2.0.0, this function would not handle relative - paths correctly. Use realpath as a workaround. - - - - - - &reftitle.returnvalues; - - Returns the requested RarArchive instance &return.falseforfailure;. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL rar 3.0.0 - - volume_callback was added. - - - - - - - - - &reftitle.examples; - - &style.oop; - -getEntries(); -if ($entries === FALSE) - die("Failed fetching entries"); - -echo "Found " . count($entries) . " files.\n"; - -if (empty($entries)) - die("No valid entries found."); - -$stream = reset($entries)->getStream(); -if ($stream === FALSE) - die("Failed opening first file"); - -$rar_arch->close(); - -echo "Content of first one follows:\n"; -echo stream_get_contents($stream); - -fclose($stream); -?> -]]> - - &example.outputs.similar; - - - - - - &style.procedural; - -getStream(); -if ($stream === FALSE) - die("Failed opening first file"); - -rar_close($rar_arch); - -echo "Content of first one follows:\n"; -echo stream_get_contents($stream); - -fclose($stream); -?> -]]> - - - - Volume Callback - -getEntry('file2.txt'); -$entry->extract(null, dirname(__FILE__) . "/temp_file2.txt"); -?> -]]> - - - - - - &reftitle.seealso; - - rar:// wrapper - - - - - - diff --git a/reference/rar/rararchive/setallowbroken.xml b/reference/rar/rararchive/setallowbroken.xml deleted file mode 100644 index 9526c0ac41d8..000000000000 --- a/reference/rar/rararchive/setallowbroken.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - RarArchive::setAllowBroken - Whether opening broken archives is allowed - - - - &reftitle.description; - &style.oop; (method): - - public boolRarArchive::setAllowBroken - boolallow_broken - - &style.procedural;: - - boolrar_allow_broken_set - RarArchiverarfile - boolallow_broken - - - This method defines whether broken archives can be read or all the operations that - attempt to extract the archive entries will fail. Broken archives are archives for - which no error is detected when the file is opened but an error occurs when reading - the entries. - - - - - &reftitle.parameters; - - - rarfile - - - A RarArchive object, opened with rar_open. - - - - - allow_broken - - - Whether to allow reading broken files (&true;) or not (&false;). - - - - - - - - &reftitle.returnvalues; - - Returns &true; &return.falseforfailure;. It will only fail if the file has - already been closed. - - - - - &reftitle.examples; - - &style.oop; - -setAllowBroken(true); -foreach ($a->getEntries() as $e) { - echo "$e\n"; -} -var_dump(count($a)); -?> -]]> - - &example.outputs.similar; - - - - - - &style.procedural; - - -]]> - - - - - - &reftitle.seealso; - - RarArchive::isBroken - - - - - diff --git a/reference/rar/rararchive/tostring.xml b/reference/rar/rararchive/tostring.xml deleted file mode 100644 index 1126fb56210b..000000000000 --- a/reference/rar/rararchive/tostring.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - RarArchive::__toString - Get text representation - - - - &reftitle.description; - - public stringRarArchive::__toString - - - - Provides a string representation for this RarArchive object. It currently shows - the full path name of the archive volume that was opened and whether the resource is valid - or was already closed through a call to RarArchive::close. - - - This method may be used only for debugging purposes, as there are no guarantees as to which - information the result contains or how it is formatted. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A textual representation of this RarArchive object. - The content of this representation is unspecified. - - - - - &reftitle.examples; - - <methodname>RarArchive::__toString</methodname> example - -close(); -echo $rar_arch."\n"; -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/rar/rarentry.xml b/reference/rar/rarentry.xml deleted file mode 100644 index 839b07553cfe..000000000000 --- a/reference/rar/rarentry.xml +++ /dev/null @@ -1,680 +0,0 @@ - - - - - The <classname>RarEntry</classname> class - RarEntry - - - - -
    - &reftitle.intro; - - A RAR entry, representing a directory or a compressed file inside a RAR archive. - -
    - - -
    - &reftitle.classsynopsis; - - - - RarEntry - - - - - final - RarEntry - - - - &Constants; - - const - int - RarEntry::HOST_MSDOS - 0 - - - const - int - RarEntry::HOST_OS2 - 1 - - - const - int - RarEntry::HOST_WIN32 - 2 - - - const - int - RarEntry::HOST_UNIX - 3 - - - const - int - RarEntry::HOST_MACOS - 4 - - - const - int - RarEntry::HOST_BEOS - 5 - - - const - int - RarEntry::ATTRIBUTE_WIN_READONLY - 1 - - - const - int - RarEntry::ATTRIBUTE_WIN_HIDDEN - 2 - - - const - int - RarEntry::ATTRIBUTE_WIN_SYSTEM - 4 - - - const - int - RarEntry::ATTRIBUTE_WIN_DIRECTORY - 16 - - - const - int - RarEntry::ATTRIBUTE_WIN_ARCHIVE - 32 - - - const - int - RarEntry::ATTRIBUTE_WIN_DEVICE - 64 - - - const - int - RarEntry::ATTRIBUTE_WIN_NORMAL - 128 - - - const - int - RarEntry::ATTRIBUTE_WIN_TEMPORARY - 256 - - - const - int - RarEntry::ATTRIBUTE_WIN_SPARSE_FILE - 512 - - - const - int - RarEntry::ATTRIBUTE_WIN_REPARSE_POINT - 1024 - - - const - int - RarEntry::ATTRIBUTE_WIN_COMPRESSED - 2048 - - - const - int - RarEntry::ATTRIBUTE_WIN_OFFLINE - 4096 - - - const - int - RarEntry::ATTRIBUTE_WIN_NOT_CONTENT_INDEXED - 8192 - - - const - int - RarEntry::ATTRIBUTE_WIN_ENCRYPTED - 16384 - - - const - int - RarEntry::ATTRIBUTE_WIN_VIRTUAL - 65536 - - - const - int - RarEntry::ATTRIBUTE_UNIX_WORLD_EXECUTE - 1 - - - const - int - RarEntry::ATTRIBUTE_UNIX_WORLD_WRITE - 2 - - - const - int - RarEntry::ATTRIBUTE_UNIX_WORLD_READ - 4 - - - const - int - RarEntry::ATTRIBUTE_UNIX_GROUP_EXECUTE - 8 - - - const - int - RarEntry::ATTRIBUTE_UNIX_GROUP_WRITE - 16 - - - const - int - RarEntry::ATTRIBUTE_UNIX_GROUP_READ - 32 - - - const - int - RarEntry::ATTRIBUTE_UNIX_OWNER_EXECUTE - 64 - - - const - int - RarEntry::ATTRIBUTE_UNIX_OWNER_WRITE - 128 - - - const - int - RarEntry::ATTRIBUTE_UNIX_OWNER_READ - 256 - - - const - int - RarEntry::ATTRIBUTE_UNIX_STICKY - 512 - - - const - int - RarEntry::ATTRIBUTE_UNIX_SETGID - 1024 - - - const - int - RarEntry::ATTRIBUTE_UNIX_SETUID - 2048 - - - const - int - RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET - 61440 - - - const - int - RarEntry::ATTRIBUTE_UNIX_FIFO - 4096 - - - const - int - RarEntry::ATTRIBUTE_UNIX_CHAR_DEV - 8192 - - - const - int - RarEntry::ATTRIBUTE_UNIX_DIRECTORY - 16384 - - - const - int - RarEntry::ATTRIBUTE_UNIX_BLOCK_DEV - 24576 - - - const - int - RarEntry::ATTRIBUTE_UNIX_REGULAR_FILE - 32768 - - - const - int - RarEntry::ATTRIBUTE_UNIX_SYM_LINK - 40960 - - - const - int - RarEntry::ATTRIBUTE_UNIX_SOCKET - 49152 - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - RarEntry::HOST_MSDOS - - If the return value of RarEntry::getHostOs equals this constant, MS-DOS was used to - add this entry. Use instead of RAR_HOST_MSDOS. - - - - - RarEntry::HOST_OS2 - - If the return value of RarEntry::getHostOs equals this constant, OS/2 was used to - add this entry. Intended to replace RAR_HOST_OS2. - - - - - RarEntry::HOST_WIN32 - - If the return value of RarEntry::getHostOs equals this constant, Microsoft Windows was used to - add this entry. Intended to replace RAR_HOST_WIN32. - - - - - RarEntry::HOST_UNIX - - If the return value of RarEntry::getHostOs equals this constant, an unspecified UNIX OS was used to - add this entry. Intended to replace RAR_HOST_UNIX. - - - - - RarEntry::HOST_MACOS - - If the return value of RarEntry::getHostOs equals this constant, Mac OS was used to - add this entry. - - - - - RarEntry::HOST_BEOS - - If the return value of RarEntry::getHostOs equals this constant, BeOS was used to - add this entry. Intended to replace RAR_HOST_BEOS. - - - - - RarEntry::ATTRIBUTE_WIN_READONLY - - Bit that represents a Windows entry with a read-only attribute. To be used with - RarEntry::getAttr on entries whose host OS is Microsoft Windows. - - - - - RarEntry::ATTRIBUTE_WIN_HIDDEN - - Bit that represents a Windows entry with a hidden attribute. To be used with - RarEntry::getAttr on entries whose host OS is Microsoft Windows. - - - - - RarEntry::ATTRIBUTE_WIN_SYSTEM - - Bit that represents a Windows entry with a system attribute. To be used with - RarEntry::getAttr on entries whose host OS is Microsoft Windows. - - - - - RarEntry::ATTRIBUTE_WIN_DIRECTORY - - Bit that represents a Windows entry with a directory attribute (entry is a directory). To be used with - RarEntry::getAttr on entries whose host OS is Microsoft Windows. See also - RarEntry::isDirectory, which also works with entries that were not added in WinRAR. - - - - - RarEntry::ATTRIBUTE_WIN_ARCHIVE - - Bit that represents a Windows entry with an archive attribute. To be used with - RarEntry::getAttr on entries whose host OS is Microsoft Windows. - - - - - RarEntry::ATTRIBUTE_WIN_DEVICE - - Bit that represents a Windows entry with a device attribute. To be used with - RarEntry::getAttr on entries whose host OS is Microsoft Windows. - - - - - RarEntry::ATTRIBUTE_WIN_NORMAL - - Bit that represents a Windows entry with a normal file attribute (entry is NOT a directory). To be used with - RarEntry::getAttr on entries whose host OS is Microsoft Windows. See also - RarEntry::isDirectory, which also works with entries that were not added in WinRAR. - - - - - RarEntry::ATTRIBUTE_WIN_TEMPORARY - - Bit that represents a Windows entry with a temporary attribute. To be used with - RarEntry::getAttr on entries whose host OS is Microsoft Windows. - - - - - RarEntry::ATTRIBUTE_WIN_SPARSE_FILE - - Bit that represents a Windows entry with a sparse file attribute (file is an NTFS sparse file). To be used with - RarEntry::getAttr on entries whose host OS is Microsoft Windows. - - - - - RarEntry::ATTRIBUTE_WIN_REPARSE_POINT - - Bit that represents a Windows entry with a reparse point attribute (entry is an NTFS reparse point, e.g. a - directory junction or a mount file system). To be used with - RarEntry::getAttr on entries whose host OS is Microsoft Windows. - - - - - RarEntry::ATTRIBUTE_WIN_COMPRESSED - - Bit that represents a Windows entry with a compressed attribute (NTFS only). To be used with - RarEntry::getAttr on entries whose host OS is Microsoft Windows. - - - - - RarEntry::ATTRIBUTE_WIN_OFFLINE - - Bit that represents a Windows entry with an offline attribute (entry is offline and not accessible). To be used with - RarEntry::getAttr on entries whose host OS is Microsoft Windows. - - - - - RarEntry::ATTRIBUTE_WIN_NOT_CONTENT_INDEXED - - Bit that represents a Windows entry with a not content indexed attribute (entry is to be indexed). To be used with - RarEntry::getAttr on entries whose host OS is Microsoft Windows. - - - - - RarEntry::ATTRIBUTE_WIN_ENCRYPTED - - Bit that represents a Windows entry with an encrypted attribute (NTFS only). To be used with - RarEntry::getAttr on entries whose host OS is Microsoft Windows. - - - - - RarEntry::ATTRIBUTE_WIN_VIRTUAL - - Bit that represents a Windows entry with a virtual attribute. To be used with - RarEntry::getAttr on entries whose host OS is Microsoft Windows. - - - - - RarEntry::ATTRIBUTE_UNIX_WORLD_EXECUTE - - Bit that represents a UNIX entry that is world executable. To be used with - RarEntry::getAttr on entries whose host OS is UNIX. - - - - - RarEntry::ATTRIBUTE_UNIX_WORLD_WRITE - - Bit that represents a UNIX entry that is world writable. To be used with - RarEntry::getAttr on entries whose host OS is UNIX. - - - - - RarEntry::ATTRIBUTE_UNIX_WORLD_READ - - Bit that represents a UNIX entry that is world readable. To be used with - RarEntry::getAttr on entries whose host OS is UNIX. - - - - - RarEntry::ATTRIBUTE_UNIX_GROUP_EXECUTE - - Bit that represents a UNIX entry that is group executable. To be used with - RarEntry::getAttr on entries whose host OS is UNIX. - - - - - RarEntry::ATTRIBUTE_UNIX_GROUP_WRITE - - Bit that represents a UNIX entry that is group writable. To be used with - RarEntry::getAttr on entries whose host OS is UNIX. - - - - - RarEntry::ATTRIBUTE_UNIX_GROUP_READ - - Bit that represents a UNIX entry that is group readable. To be used with - RarEntry::getAttr on entries whose host OS is UNIX. - - - - - RarEntry::ATTRIBUTE_UNIX_OWNER_EXECUTE - - Bit that represents a UNIX entry that is owner executable. To be used with - RarEntry::getAttr on entries whose host OS is UNIX. - - - - - RarEntry::ATTRIBUTE_UNIX_OWNER_WRITE - - Bit that represents a UNIX entry that is owner writable. To be used with - RarEntry::getAttr on entries whose host OS is UNIX. - - - - - RarEntry::ATTRIBUTE_UNIX_OWNER_READ - - Bit that represents a UNIX entry that is owner readable. To be used with - RarEntry::getAttr on entries whose host OS is UNIX. - - - - - RarEntry::ATTRIBUTE_UNIX_STICKY - - Bit that represents the UNIX sticky bit. To be used with - RarEntry::getAttr on entries whose host OS is UNIX. - - - - - RarEntry::ATTRIBUTE_UNIX_SETGID - - Bit that represents the UNIX setgid attribute. To be used with - RarEntry::getAttr on entries whose host OS is UNIX. - - - - - RarEntry::ATTRIBUTE_UNIX_SETUID - - Bit that represents the UNIX setuid attribute. To be used with - RarEntry::getAttr on entries whose host OS is UNIX. - - - - - RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET - - Mask to isolate the last four bits (nibble) of UNIX attributes - (_S_IFMT, the type of file mask). To be used with - RarEntry::getAttr on entries whose host OS is UNIX and with the - constants RarEntry::ATTRIBUTE_UNIX_FIFO, - RarEntry::ATTRIBUTE_UNIX_CHAR_DEV, - RarEntry::ATTRIBUTE_UNIX_DIRECTORY, - RarEntry::ATTRIBUTE_UNIX_BLOCK_DEV, - RarEntry::ATTRIBUTE_UNIX_REGULAR_FILE, - RarEntry::ATTRIBUTE_UNIX_SYM_LINK and - RarEntry::ATTRIBUTE_UNIX_SOCKET. - - - - - RarEntry::ATTRIBUTE_UNIX_FIFO - - Unix FIFOs will have attributes whose last four bits have this value. To be used with - RarEntry::getAttr on entries whose host OS is UNIX and with the - constant - RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET. - - - - - RarEntry::ATTRIBUTE_UNIX_CHAR_DEV - - Unix character devices will have attributes whose last four bits have this value. To be used with - RarEntry::getAttr on entries whose host OS is UNIX and with the - constant - RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET. - - - - - RarEntry::ATTRIBUTE_UNIX_DIRECTORY - - Unix directories will have attributes whose last four bits have this value. To be used with - RarEntry::getAttr on entries whose host OS is UNIX and with the - constant - RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET. See also - RarEntry::isDirectory, which also works with entries that - were added in other operating systems. - - - - - RarEntry::ATTRIBUTE_UNIX_BLOCK_DEV - - Unix block devices will have attributes whose last four bits have this value. To be used with - RarEntry::getAttr on entries whose host OS is UNIX and with the - constant - RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET. - - - - - RarEntry::ATTRIBUTE_UNIX_REGULAR_FILE - - Unix regular files (not directories) will have attributes whose last four bits have this value. To be used with - RarEntry::getAttr on entries whose host OS is UNIX and with the - constant - RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET. See also - RarEntry::isDirectory, which also works with entries that - were added in other operating systems. - - - - - RarEntry::ATTRIBUTE_UNIX_SYM_LINK - - Unix symbolic links will have attributes whose last four bits have this value. To be used with - RarEntry::getAttr on entries whose host OS is UNIX and with the - constant - RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET. - - - - - RarEntry::ATTRIBUTE_UNIX_SOCKET - - Unix sockets will have attributes whose last four bits have this value. To be used with - RarEntry::getAttr on entries whose host OS is UNIX and with the - constant - RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET. - - - - -
    - - - -
    - - &reference.rar.entities.rarentry; - -
    - diff --git a/reference/rar/rarentry/extract.xml b/reference/rar/rarentry/extract.xml deleted file mode 100644 index 8fe1cd89a129..000000000000 --- a/reference/rar/rarentry/extract.xml +++ /dev/null @@ -1,191 +0,0 @@ - - - - - RarEntry::extract - Extract entry from the archive - - - - &reftitle.description; - - public boolRarEntry::extract - stringdir - stringfilepath"" - stringpasswordNULL - boolextended_data&false; - - - RarEntry::extract extracts the entry's data. - It will create new file in the specified - dir with the name identical to the entry's name, - unless the second argument is specified. See below for more information. - - - - - &reftitle.parameters; - - - dir - - - Path to the directory where files should be extracted. This parameter is - considered if and only if filepath is not. If both - parameters are empty an extraction to the current directory will be - attempted. - - - - - - filepath - - - Path (relative or absolute) containing the directory and filename of the - extracted file. This parameter overrides both the parameter - dir and the original file name. - - - - - - password - - - The password used to encrypt this entry. If the entry is not encrypted, this value will not be used and can - be omitted. If this parameter is omitted and the entry is encrypted, the password given to - rar_open, if any, will be used. If a wrong password is given, either explicitly - or implicitly via rar_open, CRC checking will fail and this method will fail and return &false;. - If no password is given and one is required, this method will fail and return &false;. - You can check whether an entry is encrypted with RarEntry::isEncrypted. - - - - - - extended_data - - - If &true;, extended information such as NTFS ACLs and Unix owner information will be set in the extract - files, as long as it's present in the archive. - - - - - - Prior to version 2.0.0, this function would not handle relative - paths correctly. Use realpath as a workaround. - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL rar 3.0.0 - - extended_data was added. - - - - PECL rar 3.0.0 - - Support for RAR archives with repeated entry names is no longer defective. - - - - - - - - - &reftitle.examples; - - - <methodname>RarEntry::extract</methodname> example - -extract('/dir/to'); // create /dir/to/Dir/file.txt -$entry->extract(false, '/dir/to/new_name.txt'); // create /dir/to/new_name.txt - -?> -]]> - - - - How to extract all files in archive: - -extract("."); // extract to the current dir -} -rar_close($rar_file); - -?> -]]> - - - - - - - &reftitle.seealso; - - RarEntry::getStream - rar:// wrapper - - - - - diff --git a/reference/rar/rarentry/getattr.xml b/reference/rar/rarentry/getattr.xml deleted file mode 100644 index 0df6a2a67471..000000000000 --- a/reference/rar/rarentry/getattr.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - RarEntry::getAttr - Get attributes of the entry - - - - &reftitle.description; - - public intRarEntry::getAttr - - - - Returns the OS-dependent attributes of the archive entry. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the attributes or &false; on error. - - - - - &reftitle.examples; - - <methodname>RarEntry::getAttr</methodname> example - -getHostOs(); -$attr = $entry->getAttr(); - -switch($host_os) { - case RAR_HOST_MSDOS: - case RAR_HOST_OS2: - case RAR_HOST_WIN32: - case RAR_HOST_MACOS: - printf("%c%c%c%c%c%c\n", - ($attr & 0x08) ? 'V' : '.', - ($attr & 0x10) ? 'D' : '.', - ($attr & 0x01) ? 'R' : '.', - ($attr & 0x02) ? 'H' : '.', - ($attr & 0x04) ? 'S' : '.', - ($attr & 0x20) ? 'A' : '.'); - break; - case RAR_HOST_UNIX: - case RAR_HOST_BEOS: - switch ($attr & 0xF000) - { - case 0x4000: - printf("d"); - break; - case 0xA000: - printf("l"); - break; - default: - printf("-"); - break; - } - printf("%c%c%c%c%c%c%c%c%c\n", - ($attr & 0x0100) ? 'r' : '-', - ($attr & 0x0080) ? 'w' : '-', - ($attr & 0x0040) ? (($attr & 0x0800) ? 's':'x'):(($attr & 0x0800) ? 'S':'-'), - ($attr & 0x0020) ? 'r' : '-', - ($attr & 0x0010) ? 'w' : '-', - ($attr & 0x0008) ? (($attr & 0x0400) ? 's':'x'):(($attr & 0x0400) ? 'S':'-'), - ($attr & 0x0004) ? 'r' : '-', - ($attr & 0x0002) ? 'w' : '-', - ($attr & 0x0001) ? 'x' : '-'); - break; -} - -rar_close($rar_file); - -?> -]]> - - - - - - - &reftitle.seealso; - - RarEntry::getHostOs - The constants in RarEntry - - - - - diff --git a/reference/rar/rarentry/getcrc.xml b/reference/rar/rarentry/getcrc.xml deleted file mode 100644 index 93c7eb5000c2..000000000000 --- a/reference/rar/rarentry/getcrc.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - RarEntry::getCrc - Get CRC of the entry - - - - &reftitle.description; - - public stringRarEntry::getCrc - - - - Returns an hexadecimal string representation of the CRC of the archive entry. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the CRC of the archive entry or &false; on error. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL rar 2.0.0 - - This method now returns correct values for multiple volume archives. - - - - - - - - - diff --git a/reference/rar/rarentry/getfiletime.xml b/reference/rar/rarentry/getfiletime.xml deleted file mode 100644 index fd39b3c4ded6..000000000000 --- a/reference/rar/rarentry/getfiletime.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - RarEntry::getFileTime - Get entry last modification time - - - - &reftitle.description; - - public stringRarEntry::getFileTime - - - - Gets entry last modification time. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns entry last modification time as string in format - YYYY-MM-DD HH:II:SS, or &false; on error. - - - - - diff --git a/reference/rar/rarentry/gethostos.xml b/reference/rar/rarentry/gethostos.xml deleted file mode 100644 index cb41184daae3..000000000000 --- a/reference/rar/rarentry/gethostos.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - RarEntry::getHostOs - Get entry host OS - - - - &reftitle.description; - - public intRarEntry::getHostOs - - - - Returns the code of the host OS of the archive entry. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the code of the host OS, or &false; on error. - - - - - &reftitle.examples; - - - <methodname>RarEntry::getHostOs</methodname> example (version >= 2.0.0) - -getHostOs()) { - case RarEntry::HOST_MSDOS: - echo "MS-DOS\n"; - break; - case RarEntry::HOST_OS2: - echo "OS2\n"; - break; - case RarEntry::HOST_WIN32: - echo "Win32\n"; - break; - case RarEntry::HOST_MACOS: - echo "MacOS\n"; - break; - case RarEntry::HOST_UNIX: - echo "Unix/Linux\n"; - break; - case RarEntry::HOST_BEOS: - echo "BeOS\n"; - break; -} - -?> -]]> - - - - - <methodname>RarEntry::getHostOs</methodname> example (version <= 1.0.0) - -getHostOs()) { - case RAR_HOST_MSDOS: - echo "MS-DOS\n"; - break; - case RAR_HOST_OS2: - echo "OS2\n"; - break; - case RAR_HOST_WIN32: - echo "Win32\n"; - break; - case RAR_HOST_MACOS: - echo "MacOS\n"; - break; - case RAR_HOST_UNIX: - echo "Unix/Linux\n"; - break; - case RAR_HOST_BEOS: - echo "BeOS\n"; - break; -} - -?> -]]> - - - - - - - &reftitle.seealso; - - RarEntry::extract - - - - - diff --git a/reference/rar/rarentry/getmethod.xml b/reference/rar/rarentry/getmethod.xml deleted file mode 100644 index 0a5fe81cf39f..000000000000 --- a/reference/rar/rarentry/getmethod.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - RarEntry::getMethod - Get pack method of the entry - - - - &reftitle.description; - - public intRarEntry::getMethod - - - - RarEntry::getMethod returns number of the method used when adding - current archive entry. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the method number or &false; on error. - - - - - &reftitle.examples; - - <methodname>RarEntry::getMethod</methodname> example - -getMethod(); - -?> -]]> - - - - - - diff --git a/reference/rar/rarentry/getname.xml b/reference/rar/rarentry/getname.xml deleted file mode 100644 index 14ccde1b657d..000000000000 --- a/reference/rar/rarentry/getname.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - RarEntry::getName - Get name of the entry - - - - &reftitle.description; - - public stringRarEntry::getName - - - - Returns the name (with path) of the archive entry. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the entry name as a string, or &false; on error. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL rar 2.0.0 - - As of version 2.0.0, the returned string is encoded in Unicode/UTF-8. - - - - - - - - - &reftitle.examples; - - <methodname>RarEntry::getName</methodname> example - -getName(), - ENT_COMPAT, - "UTF-8" - ), - "HTML-ENTITIES", - "UTF-8" -); - -?> -]]> - - - - - - diff --git a/reference/rar/rarentry/getpackedsize.xml b/reference/rar/rarentry/getpackedsize.xml deleted file mode 100644 index 487a66f036b1..000000000000 --- a/reference/rar/rarentry/getpackedsize.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - RarEntry::getPackedSize - Get packed size of the entry - - - - &reftitle.description; - - public intRarEntry::getPackedSize - - - - Get packed size of the archive entry. - - - Note that on platforms with 32-bit longs (that includes Windows - x64), the maximum size returned is capped at 2 GiB. Check the constant - PHP_INT_MAX. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the packed size, or &false; on error. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL rar 2.0.0 - - This method now returns correct values of packed sizes bigger than 2 GiB - on platforms with 64-bit ints and never - returns negative values on other platforms. - - - - - - - - - &reftitle.examples; - - <methodname>RarEntry::getPackedSize</methodname> example - -getName() . " = " . $entry->getPackedSize() . " bytes"; - -?> -]]> - - - - - - diff --git a/reference/rar/rarentry/getstream.xml b/reference/rar/rarentry/getstream.xml deleted file mode 100644 index b22facb229bf..000000000000 --- a/reference/rar/rarentry/getstream.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - RarEntry::getStream - Get file handler for entry - - - - &reftitle.description; - - public resourcefalseRarEntry::getStream - stringpassword - - - Returns a file handler that - supports read operations. This handler provides on-the-fly decompression - for this entry. - - - The handler is not invalidated by calling - rar_close. - - - The resulting stream has no integrity verification. In particular, file corruption and - decryption with a wrong a key will not be detected. It is the programmer's responsability to use the entry's CRC - to check for integrity, if he so wishes. - - - - - &reftitle.parameters; - - - password - - - The password used to encrypt this entry. If the entry is not encrypted, this value will not be used and can - be omitted. If this parameter is omitted and the entry is encrypted, the password given to - rar_open, if any, will be used. If a wrong password is given, either explicitly - or implicitly via rar_open, this method's resulting stream will produce wrong - output. If no password is given and one is required, this method will fail and return &false;. - You can check whether an entry is encrypted with RarEntry::isEncrypted. - - - - - - - - &reftitle.returnvalues; - - The file handler &return.falseforfailure;. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL rar 3.0.0 - - Support for RAR archives with repeated entry names is no longer defective. - - - - - - - - - &reftitle.examples; - - <methodname>RarEntry::getStream</methodname> example - -getStream(); -if ($stream === false) - die("Failed to obtain stream."); - -rar_close($rar_file); //stream is independent from file - -while (!feof($stream)) { - $buff = fread($stream, 8192); - if ($buff !== false) - echo $buff; - else - break; //fread error -} - -fclose($stream); - -?> -]]> - - - - - - &reftitle.seealso; - - RarEntry::extract - rar:// wrapper - - - - - diff --git a/reference/rar/rarentry/getunpackedsize.xml b/reference/rar/rarentry/getunpackedsize.xml deleted file mode 100644 index 15c987a2da1e..000000000000 --- a/reference/rar/rarentry/getunpackedsize.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - RarEntry::getUnpackedSize - Get unpacked size of the entry - - - - &reftitle.description; - - public intRarEntry::getUnpackedSize - - - - Get unpacked size of the archive entry. - - - Note that on platforms with 32-bit longs (that includes Windows - x64), the maximum size returned is capped at 2 GiB. Check the constant - PHP_INT_MAX. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the unpacked size, or &false; on error. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL rar 2.0.0 - - This method now returns correct values of unpacked sizes bigger than - 2 GiB on platforms with 64-bit ints and never - returns negative values on other platforms. - - - - - - - - - &reftitle.returnvalues; - - <methodname>RarEntry::getUnpackedSize</methodname> example - -getName() . " = " . $entry->getUnpackedSize() . " bytes"; - -?> -]]> - - - - - - diff --git a/reference/rar/rarentry/getversion.xml b/reference/rar/rarentry/getversion.xml deleted file mode 100644 index 2984d76ba2ae..000000000000 --- a/reference/rar/rarentry/getversion.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - RarEntry::getVersion - Get minimum version of RAR program required to unpack the entry - - - - &reftitle.description; - - public intRarEntry::getVersion - - - - Returns minimum version of RAR program (e.g. WinRAR) required to unpack the entry. - It is encoded as 10 * major version + minor version. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the version or &false; on error. - - - - - &reftitle.examples; - - <methodname>RarEntry::getVersion</methodname> example - -getVersion(); - -?> -]]> - - - - - - diff --git a/reference/rar/rarentry/isdirectory.xml b/reference/rar/rarentry/isdirectory.xml deleted file mode 100644 index d591f319d669..000000000000 --- a/reference/rar/rarentry/isdirectory.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - RarEntry::isDirectory - Test whether an entry represents a directory - - - - &reftitle.description; - - public boolRarEntry::isDirectory - - - - Tests whether the current entry is a directory. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; if this entry is a directory and &false; otherwise. - - - - - &reftitle.notes; - - This function is only available starting with version 2.0.0, but one can - also test whether an entry is a directory by checking the entry attributes, - like this (only works for files compressed in RAR for Windows or Unix): - -getHostOs() == RAR_HOST_WIN32) && ($e->getAttr() & 0x10)) || - (($e->getHostOs() == RAR_HOST_UNIX) && (($e->getAttr() & 0xf000) == 0x4000))); -?> -]]> - - - - - - diff --git a/reference/rar/rarentry/isencrypted.xml b/reference/rar/rarentry/isencrypted.xml deleted file mode 100644 index 1e2de6487eb1..000000000000 --- a/reference/rar/rarentry/isencrypted.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - RarEntry::isEncrypted - Test whether an entry is encrypted - - - - &reftitle.description; - - public boolRarEntry::isEncrypted - - - - Tests whether the current entry contents are encrypted. - - - The password used may differ between files inside the same RAR archive. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; if the current entry is encrypted and &false; otherwise. - - - - - - diff --git a/reference/rar/rarentry/tostring.xml b/reference/rar/rarentry/tostring.xml deleted file mode 100644 index 2a0d80cba4e1..000000000000 --- a/reference/rar/rarentry/tostring.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - RarEntry::__toString - Get text representation of entry - - - - &reftitle.description; - - public stringRarEntry::__toString - - - - RarEntry::__toString returns a textual representation for this entry. It includes whether - the entry is a file or a directory (symbolic links and other special objects will be treated as files), - the UTF-8 name of the entry and its CRC. The form and content of this representation may be changed in the future, - so they cannot be relied upon. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A textual representation for the entry. - - - - - - diff --git a/reference/rar/rarexception.xml b/reference/rar/rarexception.xml deleted file mode 100644 index cb5283dc2be6..000000000000 --- a/reference/rar/rarexception.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - The RarException class - RarException - - - - -
    - &reftitle.intro; - - This class serves two purposes: it is the type of the exceptions thrown by the RAR extension - functions and methods and it allows, through static methods to query and define the error - behaviour of the extension, i.e., whether exceptions are thrown or only warnings are emitted. - - - The following error codes are used: - - - - - -1 - error outside UnRAR library - - - - - 11 - insufficient memory - - - - - - 12 - bad data - - - - - - 13 - bad archive - - - - - - 14 - unknown format - - - - - - 15 - file open error - - - - - - 16 - file create error - - - - - - 17 - file close error - - - - - - 18 - read error - - - - - 19 - write error - - - - - - 20 - buffer too small - - - - - - 21 - unknown RAR error - - - - - - 22 - password required but not given - - - -
    - - -
    - &reftitle.classsynopsis; - - - - RarException - - - - - final - RarException - - - - extends - Exception - - - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -
    - - &reference.rar.entities.rarexception; - -
    - diff --git a/reference/rar/rarexception/isusingexceptions.xml b/reference/rar/rarexception/isusingexceptions.xml deleted file mode 100644 index 390f100376d3..000000000000 --- a/reference/rar/rarexception/isusingexceptions.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - RarException::isUsingExceptions - Check whether error handling with exceptions is in use - - - - &reftitle.description; - - public static boolRarException::isUsingExceptions - - - - Checks whether the RAR functions will emit warnings and return error values or whether they - will throw exceptions in most of the circumstances (does not include some programmatic - errors such as passing the wrong type of arguments). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; if exceptions are being used, &false; otherwise. - - - - - &reftitle.examples; - - <function>RarException::isUsingExceptions</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - RarException::setUsingExceptions - - - - - diff --git a/reference/rar/rarexception/setusingexceptions.xml b/reference/rar/rarexception/setusingexceptions.xml deleted file mode 100644 index 89bd365e508f..000000000000 --- a/reference/rar/rarexception/setusingexceptions.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - RarException::setUsingExceptions - Activate and deactivate error handling with exceptions - - - - &reftitle.description; - - public static voidRarException::setUsingExceptions - boolusing_exceptions - - - If and only if the argument is &true;, then, instead of emitting warnings and returning a special value indicating error when the UnRAR library encounters an error, an exception of type RarException will be thrown. - - - Exceptions will also be thrown for the following errors, which occur outside the library (their error code will be -1): - - - - - attempting some operations on a closed RarArchive object or a RarEntry object relative to the first; - - - - - - attempting to get an entry that does not exist with RarArchive::getEntry. - - - - - - - - &reftitle.parameters; - - - using_exceptions - - - Should be &true; to activate exception throwing, &false; to deactivate (the default). - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <function>RarException::setUsingExceptions</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - RarException::isUsingExceptions - - - - - diff --git a/reference/rar/reference.xml b/reference/rar/reference.xml deleted file mode 100644 index 227798807b0f..000000000000 --- a/reference/rar/reference.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - Rar &Functions; - - &reference.rar.entities.functions; - - - diff --git a/reference/rar/setup.xml b/reference/rar/setup.xml deleted file mode 100644 index 8f591d1221d0..000000000000 --- a/reference/rar/setup.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - &reftitle.setup; - - -
    - &reftitle.install; - - Rar is currently available through PECL - &url.pecl.package;rar. - - - Also you can use the PECL installer to install the Rar extension, - using the following command: pecl -v install rar. - - - You can always download the tar.gz package and install Rar by hand: - - Rar installation - - - - - - - Windows users will enable php_rar.dll inside - of &php.ini; in order to use these functions. - -
    - - - -
    - &reftitle.resources; - - This extension registers three internal classes: - the archive representations returned by rar_open – - RarArchive, the entry representations returned by - rar_list and rar_entry_get – - RarEntry and the exception type RarException. - - - This extension also register a stream resource, called "rar" and a URL - wrapper called "rar wrapper" and registered under the prefix "rar". - -
    - - -
    - diff --git a/reference/rar/versions.xml b/reference/rar/versions.xml deleted file mode 100644 index e20045e76309..000000000000 --- a/reference/rar/versions.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/recode/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/recode/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/recode/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/recode/book.xml b/reference/recode/book.xml deleted file mode 100644 index 8550fb19aa44..000000000000 --- a/reference/recode/book.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - GNU Recode - Recode - - - - &reftitle.intro; - &warn.pecl.unmaintained; - - This module contains an interface to the GNU Recode library. The GNU - Recode library converts files between various coded character sets and - surface encodings. When this cannot be achieved exactly, it may get rid - of the offending characters or fall back on approximations. The library - recognises or produces nearly 150 different character sets and is able to - convert files between almost any pair. Most - RFC 1345 character sets are - supported. - - - - This extension is unbundled and moved to PECL - as of PHP 7.4.0. - Consider to use the Multibyte String or - iconv extensions instead. - - - ¬e.no-windows.extension; - - - - &reference.recode.setup; - &reference.recode.reference; - - - diff --git a/reference/recode/configure.xml b/reference/recode/configure.xml deleted file mode 100644 index 18c79a9c2625..000000000000 --- a/reference/recode/configure.xml +++ /dev/null @@ -1,57 +0,0 @@ - - -
    - &reftitle.install; - -
    - PHP 7.4 - - &pecl.moved-ver;7.4.0 - - - &pecl.info; - &url.pecl.package;recode. - -
    - -
    - PHP < 7.4 - - To be able to use the functions defined in this - module you must compile your PHP interpreter using the - - option. - - - - Crashes and startup problems of PHP may be encountered - when loading the recode as extension after loading any extension of mysql or imap. Loading the recode before those - extension has proved to fix the problem. This is due a technical problem - that both the c-client library used by imap and recode have their own - hash_lookup() function and both mysql and recode have - their own hash_insert function. - - - &warn.imaprecodeyaz; -
    -
    - diff --git a/reference/recode/functions/recode-file.xml b/reference/recode/functions/recode-file.xml deleted file mode 100644 index 00db5b578ad7..000000000000 --- a/reference/recode/functions/recode-file.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - recode_file - Recode from file to file according to recode request - - - - &reftitle.description; - - boolrecode_file - stringrequest - resourceinput - resourceoutput - - - Recode the file referenced by file handle - input into the file referenced by file - handle output according to the recode - request. - - - - - &reftitle.parameters; - - - request - - - The desired recode request type - - - - - input - - - A local file handle resource for - the input - - - - - output - - - A local file handle resource for - the output - - - - - - - - &reftitle.returnvalues; - - Returns &false;, if unable to comply, &true; otherwise. - - - - - &reftitle.examples; - - Basic <function>recode_file</function> example - - -]]> - - - - - - &reftitle.notes; - - This function does not currently process file handles referencing - remote files (URLs). Both file handles must refer to local files. - - - - - &reftitle.seealso; - - fopen - - - - - diff --git a/reference/recode/functions/recode-string.xml b/reference/recode/functions/recode-string.xml deleted file mode 100644 index 4cc32aa96669..000000000000 --- a/reference/recode/functions/recode-string.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - recode_string - Recode a string according to a recode request - - - - &reftitle.description; - - stringrecode_string - stringrequest - stringstring - - - Recode the string string according to - the recode request request. - - - - - &reftitle.parameters; - - - request - - - The desired recode request type - - - - - string - - - The string to be recoded - - - - - - - - &reftitle.returnvalues; - - Returns the recoded string or &false;, if unable to - perform the recode request. - - - - - &reftitle.examples; - - Basic <function>recode_string</function> example - - - -]]> - - - - - - &reftitle.notes; - - A simple recode request may be "lat1..iso646-de". - - - - - &reftitle.seealso; - - - The GNU Recode documentation of your installation for detailed - instructions about recode requests. - - mb_convert_encoding - UConverter::transcode - iconv - - - - - diff --git a/reference/recode/functions/recode.xml b/reference/recode/functions/recode.xml deleted file mode 100644 index eba43335d941..000000000000 --- a/reference/recode/functions/recode.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - - recode - &Alias; recode_string - - - - &reftitle.description; - - &info.function.alias; - recode_string. - - - - - diff --git a/reference/recode/reference.xml b/reference/recode/reference.xml deleted file mode 100644 index cb018c339c00..000000000000 --- a/reference/recode/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - Recode &Functions; - - &reference.recode.entities.functions; - - - - diff --git a/reference/recode/setup.xml b/reference/recode/setup.xml deleted file mode 100644 index d58cb86b71cc..000000000000 --- a/reference/recode/setup.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - &reftitle.setup; - - -
    - &reftitle.required; - - You must have GNU Recode 3.5 or higher installed on your system. - You can download the package from &url.recode;. - - - - The Recode library version 3.6 adds weird characters behind converted - strings under certain circumstances. Thus it's safer to use Recode v3.5 - or one of the available alternatives like the - iconv or - mbstring extension. - - -
    - - - - &reference.recode.configure; - - -
    - diff --git a/reference/recode/versions.xml b/reference/recode/versions.xml deleted file mode 100644 index 0cd03fbdfcc4..000000000000 --- a/reference/recode/versions.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - - - - - - diff --git a/reference/rnp/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/rnp/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/rnp/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/rnp/book.xml b/reference/rnp/book.xml deleted file mode 100644 index 7c283f6d1e52..000000000000 --- a/reference/rnp/book.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - - - Rnp - Rnp - - - &reftitle.intro; - &warn.experimental; - - This module allows you to use RNP library. - RNP is a high performance C++ OpenPGP - library used by Mozilla Thunderbird. - - - - &reference.rnp.setup; - &reference.rnp.constants; - &reference.rnp.examples; - &reference.rnp.reference; - - &reference.rnp.rnpffi; - - - diff --git a/reference/rnp/configure.xml b/reference/rnp/configure.xml deleted file mode 100644 index 40b85fec37e2..000000000000 --- a/reference/rnp/configure.xml +++ /dev/null @@ -1,30 +0,0 @@ - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;rnp - - -
    - diff --git a/reference/rnp/constants.xml b/reference/rnp/constants.xml deleted file mode 100644 index 86d84e17d09d..000000000000 --- a/reference/rnp/constants.xml +++ /dev/null @@ -1,361 +0,0 @@ - - - &reftitle.constants; - &extension.constants; - - - - RNP_KEYSTORE_GPG - (string) - - - - Keystore format "GPG". - - - - - - RNP_KEYSTORE_KBX - (string) - - - - Keystore format "KBX". For public keys only. - A keybox is a file format used to store public keys along with meta information and indices. - - - - - - RNP_KEYSTORE_G10 - (string) - - - - Keystore format "G10". For private keys. - - - - - - RNP_LOAD_SAVE_PUBLIC_KEYS - (integer) - - - - Load or save public keys only. Can be OR-ed with RNP_LOAD_SAVE_SECRET_KEYS - to load both public and private keys to the FFI context or save them from the context. - - - - - - RNP_LOAD_SAVE_SECRET_KEYS - (integer) - - - - Load or save secret keys only. Can be OR-ed with RNP_LOAD_SAVE_PUBLIC_KEYS - to load both public and private keys to the FFI context or save them from the context. - - - - - - RNP_LOAD_SAVE_PERMISSIVE - (integer) - - - - Allows to ignore bad signature/key/subkey packets during key import. - - - - - - RNP_LOAD_SAVE_SINGLE - (integer) - - - - If set, only the first key will be loaded. - - - - - - RNP_LOAD_SAVE_BASE64 - (integer) - - - - Allow import of base64-encoded keys (autocrypt ones). - - - - - - RNP_FEATURE_SYMM_ALG - (string) - - - - List available symmetric encryption algorithms. - - - - - - RNP_FEATURE_AEAD_ALG - (string) - - - - List available AEAD algorithms. - - - - - - RNP_FEATURE_PROT_MODE - (string) - - - - List available protection modes. - - - - - - RNP_FEATURE_PK_ALG - (string) - - - - List available public key algorithms. - - - - - - RNP_FEATURE_HASH_ALG - (string) - - - - List available hash algorithms. - - - - - - RNP_FEATURE_COMP_ALG - (string) - - - - List available compression algorithms. - - - - - - RNP_FEATURE_CURVE - (string) - - - - List available elliptic curves. - - - - - - RNP_DUMP_MPI - (integer) - - - - Dump MPI (Multi-precision integer) values. - - - - - - RNP_DUMP_RAW - (integer) - - - - Dump raw packet contents as well. - - - - - - RNP_DUMP_GRIP - (integer) - - - - Dump key fingerprints and grips. - - - - - - RNP_JSON_DUMP_MPI - (integer) - - - - Dump MPI (Multi-precision integer) values. - - - - - - RNP_JSON_DUMP_RAW - (integer) - - - - Dump raw packet contents as well. - - - - - - RNP_JSON_DUMP_GRIP - (integer) - - - - Dump key fingerprints and grips. - - - - - - RNP_ENCRYPT_NOWRAP - (integer) - - - - Allows encryption of signed message. Message is not wrapped - into literal data packet. - - - - - - RNP_KEY_EXPORT_ARMORED - (integer) - - - - Enable ASCII-armoring of exported data. - - - - - - RNP_KEY_EXPORT_PUBLIC - (integer) - - - - Export public key. - - - - - - RNP_KEY_EXPORT_SECRET - (integer) - - - - Export secret key. - - - - - - RNP_KEY_EXPORT_SUBKEYS - (integer) - - - - If primary key is being exported, all subkeys will be exported too. - - - - - - RNP_KEY_EXPORT_BASE64 - (integer) - - - - Export base64-encoded autocrypt key instead of binary. - - - - - - RNP_KEY_REMOVE_PUBLIC - (integer) - - - - Remove public key. - - - - - - RNP_KEY_REMOVE_SECRET - (integer) - - - - Remove secret key. - - - - - - RNP_KEY_REMOVE_SUBKEYS - (integer) - - - - If primary key is being deleted, all of its subkeys will be removed too. - - - - - - diff --git a/reference/rnp/examples.xml b/reference/rnp/examples.xml deleted file mode 100644 index 6ce2920c464f..000000000000 --- a/reference/rnp/examples.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - &reftitle.examples; -
    - Clearsign text - - This example will clearsign a given text. - - - RNP clearsign example - - -]]> - - -
    -
    - diff --git a/reference/rnp/functions/rnp-backend-string.xml b/reference/rnp/functions/rnp-backend-string.xml deleted file mode 100644 index 3e95ecdfaa34..000000000000 --- a/reference/rnp/functions/rnp-backend-string.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - rnp_backend_string - Return cryptographic backend library name - - - - &reftitle.description; - - stringrnp_backend_string - - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Backend name string. Currently supported - backends are "Botan" and "OpenSSL". - - - - - - diff --git a/reference/rnp/functions/rnp-backend-version.xml b/reference/rnp/functions/rnp-backend-version.xml deleted file mode 100644 index ddc1afbd62cb..000000000000 --- a/reference/rnp/functions/rnp-backend-version.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - rnp_backend_version - Return cryptographic backend library version - - - - &reftitle.description; - - stringrnp_backend_version - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Version string. - - - - - - diff --git a/reference/rnp/functions/rnp-decrypt.xml b/reference/rnp/functions/rnp-decrypt.xml deleted file mode 100644 index 375eb3afe68b..000000000000 --- a/reference/rnp/functions/rnp-decrypt.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - rnp_decrypt - Decrypt PGP message - - - - &reftitle.description; - - stringfalsernp_decrypt - RnpFFIffi - stringinput - - - Private keys used for decryption should be loaded into the FFI object before calling this function. - If password encryption was used, then password provider should be set by calling - rnp_ffi_set_pass_provider. - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - input - - - Encrypted message. - - - - - - - - &reftitle.returnvalues; - - Decrypted message on success&return.falseforfailure;. - - - - - - diff --git a/reference/rnp/functions/rnp-dump-packets-to-json.xml b/reference/rnp/functions/rnp-dump-packets-to-json.xml deleted file mode 100644 index 1165c609868f..000000000000 --- a/reference/rnp/functions/rnp-dump-packets-to-json.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - rnp_dump_packets_to_json - Dump OpenPGP packets stream information to the JSON string - - - - &reftitle.description; - - stringfalsernp_dump_packets_to_json - stringinput - intflags - - - - - - - - - &reftitle.parameters; - - - input - - - Input string containing OpenPGP data, either in binary or ASCII-armored format. - - - - - flags - - - See RNP_JSON_DUMP_* predefined constants. - - - - - - - - &reftitle.returnvalues; - - JSON string with dump&return.falseforfailure;. - - - - - - diff --git a/reference/rnp/functions/rnp-dump-packets.xml b/reference/rnp/functions/rnp-dump-packets.xml deleted file mode 100644 index bb36934cb00a..000000000000 --- a/reference/rnp/functions/rnp-dump-packets.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - rnp_dump_packets - Dump OpenPGP packets stream information in humand-readable format - - - - &reftitle.description; - - stringfalsernp_dump_packets - stringinput - intflags - - - - - - - - - &reftitle.parameters; - - - input - - - Input string containing OpenPGP data, either in binary or ASCII-armored format. - - - - - flags - - - See RNP_DUMP_* predefined constants. - - - - - - - - &reftitle.returnvalues; - - Text describing packet sequence&return.falseforfailure;. - - - - - - diff --git a/reference/rnp/functions/rnp-ffi-create.xml b/reference/rnp/functions/rnp-ffi-create.xml deleted file mode 100644 index 60f5a0a81e97..000000000000 --- a/reference/rnp/functions/rnp-ffi-create.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - rnp_ffi_create - Create the top-level object used for interacting with the library - - - - &reftitle.description; - - RnpFFIfalsernp_ffi_create - stringpub_format - stringsec_format - - - - - - - - - - &reftitle.parameters; - - - pub_format - - - the format of the public keyring, RNP_KEYSTORE_GPG or other - RNP_KEYSTORE_* constant. - - - - - sec_format - - - the format of the secret keyring, RNP_KEYSTORE_GPG or other - RNP_KEYSTORE_* constant - - - - - - - - &reftitle.returnvalues; - - Returns RnpFFI object on success&return.falseforfailure;. - - - - - - diff --git a/reference/rnp/functions/rnp-ffi-destroy.xml b/reference/rnp/functions/rnp-ffi-destroy.xml deleted file mode 100644 index 445f4b4483a3..000000000000 --- a/reference/rnp/functions/rnp-ffi-destroy.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - rnp_ffi_destroy - Destroy the top-level object used for interacting with the library - - - - &reftitle.description; - - voidrnp_ffi_destroy - RnpFFIffi - - - - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/rnp/functions/rnp-ffi-set-pass-provider.xml b/reference/rnp/functions/rnp-ffi-set-pass-provider.xml deleted file mode 100644 index 9541be180c7f..000000000000 --- a/reference/rnp/functions/rnp-ffi-set-pass-provider.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - rnp_ffi_set_pass_provider - Set password provider callback function - - - - &reftitle.description; - - boolrnp_ffi_set_pass_provider - RnpFFIffi - callablepassword_callback - - - Sets password provider function. This function can ask for the password on a standard input - (if PHP script is executed in a command line environment), display GUI dialog or provide - password in any other possible ways. Requested passwords are used to encrypt or decrypt - secret keys or perform symmetric encryption/decryption operations. - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - password_callback - - - The function that is to be called for every password request. It has the following signature: - - boolpassword_callback - stringkey_fp - stringpgp_context - stringpassword - - - $key_fp - The key fingerprint, if any. Can be empty. - $pgp_context - String describing why the key is being requested. - $password - Password string reference where provided password should be stored to. - - Callback function should return &true; if password was successfully set&return.falseforfailure;. - - - - - - - - &reftitle.returnvalues; - - Returns &true; on success&return.falseforfailure;. - - - - - &reftitle.examples; - - simple callback function example - - - - - - - - diff --git a/reference/rnp/functions/rnp-import-keys.xml b/reference/rnp/functions/rnp-import-keys.xml deleted file mode 100644 index b8a372c0c8e1..000000000000 --- a/reference/rnp/functions/rnp-import-keys.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - rnp_import_keys - Import keys from PHP string to the keyring and receive JSON describing new/updated keys - - - - &reftitle.description; - - stringfalsernp_import_keys - RnpFFIffi - stringinput - intflags - - - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - input - - - OpenPGP packets containing key(s) to be loaded. Can be either binary or ASCII armored. - - - - - flags - - - See RNP_LOAD_SAVE_* predefined constants. - - - - - - - - &reftitle.returnvalues; - - JSON string with information about new and updated keys on success&return.falseforfailure;. - - - - - - diff --git a/reference/rnp/functions/rnp-import-signatures.xml b/reference/rnp/functions/rnp-import-signatures.xml deleted file mode 100644 index 08ef6bb3b3c0..000000000000 --- a/reference/rnp/functions/rnp-import-signatures.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - rnp_import_signatures - Import standalone signatures to the keyring and receive JSON describing updated keys - - - - &reftitle.description; - - stringfalsernp_import_signatures - RnpFFIffi - stringinput - intflags - - - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - input - - - OpenPGP packets containing signatures to be imported. Can be either binary or ASCII armored. - - - - - flags - - - Currently must be 0. - - - - - - - - &reftitle.returnvalues; - - JSON string with information about updated keys on success&return.falseforfailure;. - - - - - - diff --git a/reference/rnp/functions/rnp-key-export-autocrypt.xml b/reference/rnp/functions/rnp-key-export-autocrypt.xml deleted file mode 100644 index 2ffd07add302..000000000000 --- a/reference/rnp/functions/rnp-key-export-autocrypt.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - rnp_key_export_autocrypt - - Export minimal key for autocrypt feature (just 5 packets: key, uid, signature, - encryption subkey, signature) - - - - - &reftitle.description; - - stringfalsernp_key_export_autocrypt - RnpFFIffi - stringkey_fp - stringsubkey_fp - stringuid - intflags - - - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - key_fp - - - Primary key fingerprint. - - - - - subkey_fp - - - Subkey to export. Can be an empty string - to pick the first suitable subkey. - - - - - uid - - - User ID to export. Can be an empty string - if exported key has only one uid. - - - - - flags - - - Only RNP_KEY_EXPORT_BASE64 is currently supported. Enabling - it would export base64-encoded key data instead of binary. - - - - - - - - &reftitle.returnvalues; - - OpenPGP packets of exported key on success&return.falseforfailure;. - - - - - - diff --git a/reference/rnp/functions/rnp-key-export-revocation.xml b/reference/rnp/functions/rnp-key-export-revocation.xml deleted file mode 100644 index f2b726e4c9c0..000000000000 --- a/reference/rnp/functions/rnp-key-export-revocation.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - rnp_key_export_revocation - Generate and export primary key revocation signature - - - - &reftitle.description; - - stringfalsernp_key_export_revocation - RnpFFIffi - stringkey_fp - intflags - arrayoptions - - - Note: to revoke a key you'll need to import this signature into the keystore or use - rnp_key_revoke function. - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - key_fp - - - Key fingerprint of the primary key to be revoked. - - - - - flags - - - RNP_KEY_EXPORT_ARMORED or 0. - - - - - options - - - An associative array with options. - - - - - - Key - Data type - &Description; - - - - - "hash" - string - Set hash algorithm used during signature calculation. - - - "code" - string - Code reason for revocation code. Possible values: 'no', 'superseded', 'compromised', - 'retired'. If not defined, then value 'no' will be used by default. - - - "reason" - string - Textual representation of the reason for revocation. - - - - - - - - - - - &reftitle.returnvalues; - - Exported revocation signature on success&return.falseforfailure;. - - - - - - diff --git a/reference/rnp/functions/rnp-key-export.xml b/reference/rnp/functions/rnp-key-export.xml deleted file mode 100644 index 0de544b5f002..000000000000 --- a/reference/rnp/functions/rnp-key-export.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - rnp_key_export - Export a key - - - - &reftitle.description; - - stringfalsernp_key_export - RnpFFIffi - stringkey_fp - intflags - - - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - key_fp - - - Key fingerprint. - - - - - flags - - - See RNP_KEY_EXPORT_* predefined constants - (except RNP_KEY_EXPORT_BASE64). - - - - - - - - &reftitle.returnvalues; - - OpenPGP packets of exported key (binary or ASCII-armored) on success&return.falseforfailure;. - - - - - - diff --git a/reference/rnp/functions/rnp-key-get-info.xml b/reference/rnp/functions/rnp-key-get-info.xml deleted file mode 100644 index d3449edb272a..000000000000 --- a/reference/rnp/functions/rnp-key-get-info.xml +++ /dev/null @@ -1,211 +0,0 @@ - - - - rnp_key_get_info - Get information about the key - - - - &reftitle.description; - - arrayfalsernp_key_get_info - RnpFFIffi - stringkey_fp - - - - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - key_fp - - - Key fingerprint. - - - - - - - - &reftitle.returnvalues; - - An associative array with information about the key&return.falseforfailure;. - - - - - - Key - Data type - &Description; - - - - - "is_primary" - boolean - - &true; if this key is the primary key. - - - - "is_sub" - boolean - - &true; if this key is a subkey. - - - - "is_valid" - boolean - - &true; if public key is valid. - This includes checks of the self-signatures, - expiration times, revocations and so on. - - - - "is_revoked" - boolean - - &true; if this key is revoked. - - - - "is_superseded" - boolean - - &true; if this key is superseded. Present only if the key is revoked. - - - - "is_compromised" - boolean - - &true; if this key is compromised. Present only if the key is revoked. - - - - "is_retired" - boolean - - &true; if this key is retired. Present only if the key is revoked. - - - - "is_expired" - boolean - - &true; if this key is expired. - - - - "have_secret" - boolean - - &true; if this key has secret part. - - - - "is_locked" - boolean - - &true; if this key is currently locked. Only present for secret keys. - - - - "is_protected" - boolean - - &true; if this key is protected. Only present for secret keys. - A protected key is one that is encrypted and can be safely held in memory - and locked/unlocked as needed. - - - - "have_public" - boolean - - &true; if this key has public part. Generally all keys would have public part. - - - - "valid_till" - integer - - The timestamp till which key can be considered as valid. - Note: this will take into account not only key's expiration, but revocations as well. - For the subkey primary key's validity time will be also checked. - - - - "bits" - integer - - Number of bits in the key. For EC-based keys it will contain size of the curve. - - - - "alg" - string - - Key algorithm name. - - - - "subkeys" - array - - An indexed array containing fingerprint strings of subkeys. Only present for - primary keys. Could be empty if primary key has no subkeys. - - - - "uids" - array - - An indexed array containing user ID strings. Only present for - primary keys. Could be empty if primary key has no user ID-s. - - - - - - - - - - diff --git a/reference/rnp/functions/rnp-key-remove.xml b/reference/rnp/functions/rnp-key-remove.xml deleted file mode 100644 index 6c811cb4c737..000000000000 --- a/reference/rnp/functions/rnp-key-remove.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - rnp_key_remove - Remove a key from keyring(s) - - - - &reftitle.description; - - boolrnp_key_remove - RnpFFIffi - stringkey_fp - intflags - - - Note: you need to call rnp_save_keys to write updated keyring(s) out. - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - key_fp - - - Key fingerprint. - - - - - flags - - - See RNP_KEY_REMOVE_* constants. Flag RNP_KEY_REMOVE_SUBKEYS will work only for - the primary key and will remove all of its subkeys as well. - - - - - - - - &reftitle.returnvalues; - - Returns &true; on success&return.falseforfailure;. - - - - - - diff --git a/reference/rnp/functions/rnp-key-revoke.xml b/reference/rnp/functions/rnp-key-revoke.xml deleted file mode 100644 index ffc2aedc8269..000000000000 --- a/reference/rnp/functions/rnp-key-revoke.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - rnp_key_revoke - Revoke a key or subkey by generating and adding revocation signature - - - - &reftitle.description; - - boolrnp_key_revoke - RnpFFIffi - stringkey_fp - intflags - arrayoptions - - - Note: you need to call rnp_save_keys to write updated keyring(s) out. - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - key_fp - - - Key fingerprint. - - - - - flags - - - Currently must be 0. - - - - - options - - - An associative array with options. - - - - - - Key - Data type - &Description; - - - - - "hash" - string - Set hash algorithm used during signature calculation. - - - "code" - string - Code reason for revocation code. Possible values: 'no', 'superseded', 'compromised', - 'retired'. If not defined, then value 'no' will be used by default. - - - "reason" - string - Textual representation of the reason for revocation. - - - - - - - - - - - &reftitle.returnvalues; - - Returns &true; on success&return.falseforfailure;. - - - - - - diff --git a/reference/rnp/functions/rnp-list-keys.xml b/reference/rnp/functions/rnp-list-keys.xml deleted file mode 100644 index d8700260f20a..000000000000 --- a/reference/rnp/functions/rnp-list-keys.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - rnp_list_keys - Enumerate all keys present in a keyring by specified identifer type - - - - &reftitle.description; - - arrayfalsernp_list_keys - RnpFFIffi - stringidentifier_type - - - - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - identifier_type - - - Key identifier type ("userid", "keyid", "grip", "fingerprint"). - - - - - - - - &reftitle.returnvalues; - - An associative array where key is an identifier string and value is a PGP key fingerprint&return.falseforfailure;. - - - - - - diff --git a/reference/rnp/functions/rnp-load-keys-from-path.xml b/reference/rnp/functions/rnp-load-keys-from-path.xml deleted file mode 100644 index bd720d023816..000000000000 --- a/reference/rnp/functions/rnp-load-keys-from-path.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - rnp_load_keys_from_path - Load keys from specified path - - - - &reftitle.description; - - boolrnp_load_keys_from_path - RnpFFIffi - stringformat - stringinput_path - intflags - - - Note that for G10, the input must be a directory (which must already exist). - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - format - - - &rnp.parameter.key-format; - - - - - input_path - - - file or directory containing the keys. - - - - - flags - - - &rnp.parameter.loadsave-flags; - - - - - - - - &reftitle.returnvalues; - - Returns &true; on success&return.falseforfailure;. - - - - - - diff --git a/reference/rnp/functions/rnp-load-keys.xml b/reference/rnp/functions/rnp-load-keys.xml deleted file mode 100644 index 8aad54993aa8..000000000000 --- a/reference/rnp/functions/rnp-load-keys.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - rnp_load_keys - Load keys from PHP string - - - - &reftitle.description; - - boolrnp_load_keys - RnpFFIffi - stringformat - stringinput - intflags - - - Note that for G10, the input must be a directory (which must already exist). - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - format - - - &rnp.parameter.key-format; - - - - - input - - - OpenPGP packets containing key(s) to be loaded. Can be either binary or ASCII armored. - - - - - flags - - - &rnp.parameter.loadsave-flags; - - - - - - - - &reftitle.returnvalues; - - Returns &true; on success&return.falseforfailure;. - - - - - - diff --git a/reference/rnp/functions/rnp-locate-key.xml b/reference/rnp/functions/rnp-locate-key.xml deleted file mode 100644 index 33f5d4ac6f5c..000000000000 --- a/reference/rnp/functions/rnp-locate-key.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - rnp_locate_key - Search for the key - - - - &reftitle.description; - - stringfalsernp_locate_key - RnpFFIffi - stringidentifier_type - stringidentifier - - - Note: only valid userids are checked while searching by userid. - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - identifier_type - - - Identifier type string: "userid", "keyid", "fingerprint", "grip". - - - - - identifier - - - PGP User ID (name and email) for "userid" type, hexadecimal string - that represents key id, fingerprint or key grip correspondingly. - - - - - - - - &reftitle.returnvalues; - - Returns hexadecimal fingerprint of the key found on success&return.falseforfailure;. - - - - - - diff --git a/reference/rnp/functions/rnp-op-encrypt.xml b/reference/rnp/functions/rnp-op-encrypt.xml deleted file mode 100644 index 6e950d50c562..000000000000 --- a/reference/rnp/functions/rnp-op-encrypt.xml +++ /dev/null @@ -1,187 +0,0 @@ - - - - rnp_op_encrypt - Encrypt message - - - - &reftitle.description; - - stringfalsernp_op_encrypt - RnpFFIffi - stringmessage - arrayrecipient_keys_fp - arrayoptions - - - - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - message - - - Message to be encrypted. - - - - - recipient_keys_fp - - - Array with fingerprints of recipient's keys. At least one key must be present. - - - - - options - - - An associative array with options. - - - - - - Key - Data type - &Description; - - - - - "compression_alg" - string - Compression algorithm. Both - "compression_alg" and "compression_level" - must be set in order to enable data compression. - - - - "compression_level" - integer - Compression level, 0-9. 0 disables compression. - - - "armor" - boolean - Enable ASCII-armored output. Disabled by default. - - - "add_signature" - boolean - Encrypted message will be also signed. - - - "hash" - string - Set hash algorithm used during signature calculation. "add_signature" option should be set to &true; - - - "creation_time" - integer - Set signature creation time in seconds since Jan, 1 1970 UTC. By default current time is used. - - - "expiration_time" - integer - Set signature expiration time in seconds since the creation time. 0 value is used to mark - signature as non-expiring (default value). - - - "password" - string - Add password which is used to encrypt data. - - - "cipher" - string - - Set symmetric encryption algorithm. Possible values are "IDEA", "TRIPLEDES", - "CAST5", "BLOWFISH", "AES128", "AES192", "AES256", "TWOFISH", "CAMELLIA128", - "CAMELLIA192", "CAMELLIA256", "SM4". - - - - "aead" - string - - Set AEAD mode algorithm. Possible values are "None" to disable AEAD, "EAX", "OCB". - - - - "aead_bits" - integer - Set chunk length for AEAD mode via number of chunk size bits. Must be between 0 to 56. - - - "flags" - integer - - Set additional encryption flags. Supported flags: RNP_ENCRYPT_NOWRAP - do not wrap the data in a literal data packet. This - would allow to encrypt already signed data. - - - - "file_name" - string - Set the internally stored file name for the data being encrypted. Special value _CONSOLE may be used to mark message - as 'for your eyes only', i.e. it should not be stored anywhere but only displayed - to the receiver. Default is the empty string. - - - "file_mtime" - integer - Set input file modification date in seconds since Jan, 1 1970 UTC. - - - - - - - - - - - &reftitle.returnvalues; - - Encrypted data on success&return.falseforfailure;. - - - - - - diff --git a/reference/rnp/functions/rnp-op-generate-key.xml b/reference/rnp/functions/rnp-op-generate-key.xml deleted file mode 100644 index 180da42717b8..000000000000 --- a/reference/rnp/functions/rnp-op-generate-key.xml +++ /dev/null @@ -1,171 +0,0 @@ - - - - rnp_op_generate_key - Generate key - - - - &reftitle.description; - - stringfalsernp_op_generate_key - RnpFFIffi - stringuserid - stringkey_alg - stringsub_alg - arrayoptions - - - - - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - userid - - - PGP User ID - text that is intended to represent - the name and email address of the key holder. - - - - - key_alg - - - Primary key algorithm (i.e. 'RSA', 'DSA', etc). - - - - - sub_alg - - - Subkey algorithm. If not set, subkey will not be generated. - - - - - options - - - An associative array with options. - - - - - - Key - Data type - &Description; - - - - - "bits" - integer - Primary key size in bits. Applicable only to RSA, DSA and El-Gamal keys. - - - "hash" - string - Hash algorithm used in self signature or subkey binding signature. - - - "dsa_qbits" - integer - Set size of a q parameter for DSA key. - Note: appropriate default value will be set, depending on key bits. However you may - override it if needed. - - - "curve" - string - Set the curve used for ECC key. Note: this is only applicable for ECDSA, ECDH and SM2 keys. - - - "request_password" - boolean - Enable requesting password via password provider. This password - will be used for key encryption. Password provider callback function should be set in - advance by calling rnp_ffi_set_pass_provider. - Note: this setting will be ignored if password was set via"password" - - - "password" - string - Set the password used to encrypt the secret key data. - - - "expiration" - integer - Set the key and subkey expiration time in seconds. - - - "sub_bits" - integer - Subkey size in bits. Applicable only to RSA, DSA and El-Gamal keys. - - - "sub_hash" - string - Hash algorithm used in subkey self signature or subkey binding signature. - - - "sub_curve" - string - Set the curve used for ECC subkey. Note: this is only applicable for ECDSA, ECDH and SM2 keys. - - - - - - - - - - - &reftitle.returnvalues; - - Fingerprint of the generated primary key&return.falseforfailure;. This fingerprint can be used - later to reference the key in sign and encrypt operations. The key data is stored in FFI - memory context and can be saved using - rnp_save_keys or rnp_save_keys_to_path. - - - - - - diff --git a/reference/rnp/functions/rnp-op-sign-cleartext.xml b/reference/rnp/functions/rnp-op-sign-cleartext.xml deleted file mode 100644 index 337ccbe4fb5e..000000000000 --- a/reference/rnp/functions/rnp-op-sign-cleartext.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - rnp_op_sign_cleartext - Perform signing operation on a textual data, return cleartext signed message - - - - &reftitle.description; - - stringfalsernp_op_sign_cleartext - RnpFFIffi - stringdata - arraykeys_fp - arrayoptions - - - - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - data - - - Data to be signed. - - - - - keys_fp - - - Array with key fingerprints. At least one key must be provided. - Keys should be present in ffi. - - - - - options - - - An associative array with options. - - - - - - Key - Data type - &Description; - - - - - "armor" - boolean - Enable ASCII-armored output. Disabled by default. - - - "hash" - string - Set hash algorithm used during signature calculation. - - - "creation_time" - integer - Set signature creation time in seconds since Jan, 1 1970 UTC. By default current time is used. - - - "expiration_time" - integer - Set signature expiration time in seconds since the creation time. 0 value is used to mark - signature as non-expiring (default value). - - - - - - - - - - - &reftitle.returnvalues; - - Cleartext signed message containing source data with - additional headers and ASCII-armored signature on success&return.falseforfailure;. - - - - - - diff --git a/reference/rnp/functions/rnp-op-sign-detached.xml b/reference/rnp/functions/rnp-op-sign-detached.xml deleted file mode 100644 index 3824bab71b50..000000000000 --- a/reference/rnp/functions/rnp-op-sign-detached.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - rnp_op_sign_detached - Perform signing operation, return detached signature(s) - - - - &reftitle.description; - - stringfalsernp_op_sign_detached - RnpFFIffi - stringdata - arraykeys_fp - arrayoptions - - - - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - data - - - Data to be signed. - - - - - keys_fp - - - Array with key fingerprints. At least one key must be provided. - Keys should be present in ffi. - - - - - options - - - An associative array with options. - - - - - - Key - Data type - &Description; - - - - - "armor" - boolean - Enable ASCII-armored output. Disabled by default. - - - "hash" - string - Set hash algorithm used during signature calculation. - - - "creation_time" - integer - Set signature creation time in seconds since Jan, 1 1970 UTC. By default current time is used. - - - "expiration_time" - integer - Set signature expiration time in seconds since the creation time. 0 value is used to mark - signature as non-expiring (default value). - - - - - - - - - - - &reftitle.returnvalues; - - Detached signature(s) data on success&return.falseforfailure;. - - - - - - diff --git a/reference/rnp/functions/rnp-op-sign.xml b/reference/rnp/functions/rnp-op-sign.xml deleted file mode 100644 index 8a7125c3a0cf..000000000000 --- a/reference/rnp/functions/rnp-op-sign.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - rnp_op_sign - Perform signing operation on a binary data, return embedded signature(s) - - - - &reftitle.description; - - stringfalsernp_op_sign - RnpFFIffi - stringdata - arraykeys_fp - arrayoptions - - - - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - data - - - Data to be signed. - - - - - keys_fp - - - Array with key fingerprints. At least one key must be provided. - Keys should be present in ffi. - - - - - options - - - An associative array with options. - - - - - - Key - Data type - &Description; - - - - - "compression_alg" - string - Compression algorithm. Both - "compression_alg" and "compression_level" - must be set in order to enable data compression. - - - - "compression_level" - integer - Compression level, 0-9. 0 disables compression. - - - "armor" - boolean - Enable ASCII-armored output. Disabled by default. - - - "hash" - string - Set hash algorithm used during signature calculation. - - - "creation_time" - integer - Set signature creation time in seconds since Jan, 1 1970 UTC. By default current time is used. - - - "expiration_time" - integer - Set signature expiration time in seconds since the creation time. 0 value is used to mark - signature as non-expiring (default value). - - - "file_name" - string - Set input file name.Special value _CONSOLE may be used to mark message - as 'for your eyes only', i.e. it should not be stored anywhere but only displayed - to the receiver. Default is the empty string. - - - "file_mtime" - integer - Set input file modification date in seconds since Jan, 1 1970 UTC. - - - - - - - - - - - &reftitle.returnvalues; - - Data with embedded signature(s) on success&return.falseforfailure;. - - - - - - diff --git a/reference/rnp/functions/rnp-op-verify-detached.xml b/reference/rnp/functions/rnp-op-verify-detached.xml deleted file mode 100644 index 6b04837f0601..000000000000 --- a/reference/rnp/functions/rnp-op-verify-detached.xml +++ /dev/null @@ -1,188 +0,0 @@ - - - - rnp_op_verify_detached - Verify detached signatures - - - - &reftitle.description; - - arrayfalsernp_op_verify_detached - RnpFFIffi - stringdata - stringsignature - - - - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - data - - - Source data. - - - - - signature - - - Detached signature data. - - - - - - - - &reftitle.returnvalues; - - An associative array with information about verification results&return.falseforfailure;. - - - - - - Key - Data type - &Description; - - - - - "verification_status" - string - - Overall verification result, either "Success" string or appropriate error message. - "Success" result is set when at least one signature is valid and successfully verified. - Individual verification results for each signature can be checked in the "signatures" array. - - - - "file_name" - string - File name. - - - "file_mtime" - integer - File modification time. - - - "mode" - string - Data protection (encryption) mode used in processed message. - Currently defined values are "none", "cfb", "cfb-mdc", "aead-ocb", "aead-eax". - - - - "cipher" - string - Symmetric cipher used for data encryption. - - - "valid_integrity" - boolean - &true; if message integrity protection was used (i.e. MDC or AEAD) and it was - validated successfully. - - - - "signatures" - array - - An associative array describing each signature found. See description below. - - - - - - - "signatures" sub-array. - - - - - - Key - Data type - &Description; - - - - - "verification_status" - string - Signature verification status, either "Success" string or appropriate error message. - - - "creation_time" - integer - Signature creation time in seconds since Jan, 1 1970 UTC. - - - "expiration_time" - integer - Signature expiration time in seconds since the creation time or 0 if signature never expires. - - - "hash" - string - Hash function algorithm used to calculate the signature. - - - "signing_key" - string - Fingerprint of the key used for signing. Could be "Not found" if corresponding public key is not loaded to the FFI object. - - - "signature_type" - string - - Signature type. Currently defined values are: 'binary', 'text', 'standalone', 'certification (generic)', 'certification (persona)', - 'certification (casual)', 'certification (positive)', 'subkey binding', 'primary key binding', 'direct', 'key revocation', - 'subkey revocation', 'certification revocation', 'timestamp', 'uknown: 0..255'. - - - - - - - - - - diff --git a/reference/rnp/functions/rnp-op-verify.xml b/reference/rnp/functions/rnp-op-verify.xml deleted file mode 100644 index 087df9957e2b..000000000000 --- a/reference/rnp/functions/rnp-op-verify.xml +++ /dev/null @@ -1,179 +0,0 @@ - - - - rnp_op_verify - Verify embedded or cleartext signatures - - - - &reftitle.description; - - arrayfalsernp_op_verify - RnpFFIffi - stringdata - - - - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - data - - - Signed data. - - - - - - - - &reftitle.returnvalues; - - An associative array with information about verification results&return.falseforfailure;. - - - - - - Key - Data type - &Description; - - - - - "verification_status" - string - - Overall verification result, either "Success" string or appropriate error message. - "Success" result is set when at least one signature is valid and successfully verified. - Individual verification results for each signature can be checked in the "signatures" array. - - - - "file_name" - string - File name. - - - "file_mtime" - integer - File modification time. - - - "mode" - string - Data protection (encryption) mode used in processed message. - Currently defined values are "none", "cfb", "cfb-mdc", "aead-ocb", "aead-eax". - - - - "cipher" - string - Symmetric cipher used for data encryption. - - - "valid_integrity" - boolean - &true; if message integrity protection was used (i.e. MDC or AEAD) and it was - validated successfully. - - - - "signatures" - array - - An associative array describing each signature found. See description below. - - - - - - - "signatures" sub-array. - - - - - - Key - Data type - &Description; - - - - - "verification_status" - string - Signature verification status, either "Success" string or appropriate error message. - - - "creation_time" - integer - Signature creation time in seconds since Jan, 1 1970 UTC. - - - "expiration_time" - integer - Signature expiration time in seconds since the creation time or 0 if signature never expires. - - - "hash" - string - Hash function algorithm used to calculate the signature. - - - "signing_key" - string - Fingerprint of the key used for signing. Could be "Not found" if corresponding public key is not loaded to the FFI object. - - - "signature_type" - string - - Signature type. Currently defined values are: 'binary', 'text', 'standalone', 'certification (generic)', 'certification (persona)', - 'certification (casual)', 'certification (positive)', 'subkey binding', 'primary key binding', 'direct', 'key revocation', - 'subkey revocation', 'certification revocation', 'timestamp', 'uknown: 0..255'. - - - - - - - - - - diff --git a/reference/rnp/functions/rnp-save-keys-to-path.xml b/reference/rnp/functions/rnp-save-keys-to-path.xml deleted file mode 100644 index 0949051b3f66..000000000000 --- a/reference/rnp/functions/rnp-save-keys-to-path.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - rnp_save_keys_to_path - Save keys to specified path - - - - &reftitle.description; - - boolrnp_save_keys_to_path - RnpFFIffi - stringformat - stringoutput_path - intflags - - - Saves keys present in the FFI object (loaded or generated) to the specified file or directory. - - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - format - - - &rnp.parameter.key-format; - - - - - output_path - - - File or directory path where keys should be saved to. - - - - - flags - - - &rnp.parameter.loadsave-flags; - - - - - - - - &reftitle.returnvalues; - - Returns &true; on success&return.falseforfailure;. - - - - - - diff --git a/reference/rnp/functions/rnp-save-keys.xml b/reference/rnp/functions/rnp-save-keys.xml deleted file mode 100644 index d46cc2ddfe75..000000000000 --- a/reference/rnp/functions/rnp-save-keys.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - rnp_save_keys - Save keys to PHP string - - - - &reftitle.description; - - boolrnp_save_keys - RnpFFIffi - stringformat - stringoutput - intflags - - - Note that for G10, the output must be a directory (which must already exist). - - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - format - - - &rnp.parameter.key-format; - - - - - output - - - key packets will be saved to the string referenced by output. - - - - - flags - - - &rnp.parameter.loadsave-flags; - - - - - - - - &reftitle.returnvalues; - - Returns &true; on success&return.falseforfailure;. - - - - - - diff --git a/reference/rnp/functions/rnp-supported-features.xml b/reference/rnp/functions/rnp-supported-features.xml deleted file mode 100644 index 0d54f6ed7a0f..000000000000 --- a/reference/rnp/functions/rnp-supported-features.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - rnp_supported_features - Get supported features in JSON format - - - - &reftitle.description; - - stringfalsernp_supported_features - stringtype - - - Get the JSON formatted string containing array of supported rnp feature values (algorithms, curves, etc) by type. - - - - - - &reftitle.parameters; - - - type - - - See RNP_FEATURE_* constants for supported values. - - - - - - - - &reftitle.returnvalues; - - String containing JSON formatted array of supported algorithms, curves, etc&return.falseforfailure;. - - - - - - diff --git a/reference/rnp/functions/rnp-version-string-full.xml b/reference/rnp/functions/rnp-version-string-full.xml deleted file mode 100644 index 33e10a52fc23..000000000000 --- a/reference/rnp/functions/rnp-version-string-full.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - rnp_version_string_full - Full version string of RNP library - - - - &reftitle.description; - - stringrnp_version_string_full - - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns full version string of RNP library. - - - - - - diff --git a/reference/rnp/functions/rnp-version-string.xml b/reference/rnp/functions/rnp-version-string.xml deleted file mode 100644 index e277f615df51..000000000000 --- a/reference/rnp/functions/rnp-version-string.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - rnp_version_string - RNP library version - - - - &reftitle.description; - - stringrnp_version_string - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns RNP library version string. - - - - - - diff --git a/reference/rnp/reference.xml b/reference/rnp/reference.xml deleted file mode 100644 index a330159f40ef..000000000000 --- a/reference/rnp/reference.xml +++ /dev/null @@ -1,27 +0,0 @@ - - - Rnp &Functions; - - &reference.rnp.entities.functions; - - - diff --git a/reference/rnp/rnpffi.xml b/reference/rnp/rnpffi.xml deleted file mode 100644 index 6b7490b6e3d2..000000000000 --- a/reference/rnp/rnpffi.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - The RnpFFI class - RnpFFI - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - RnpFFI - - - - - RnpFFI - - - - - - - -
    - -
    - -
    - diff --git a/reference/rnp/setup.xml b/reference/rnp/setup.xml deleted file mode 100644 index 4ddd8ad602a6..000000000000 --- a/reference/rnp/setup.xml +++ /dev/null @@ -1,35 +0,0 @@ - - - &reftitle.setup; - -
    - &reftitle.required; - - In order to use RNP library functions you need to install theRNP library. RNP library version >= 0.16.2 - is required. - -
    - - &reference.rnp.configure; - -
    - diff --git a/reference/rnp/versions.xml b/reference/rnp/versions.xml deleted file mode 100644 index d72dfd92e48e..000000000000 --- a/reference/rnp/versions.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/rpminfo/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/rpminfo/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/rpminfo/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/rpminfo/book.xml b/reference/rpminfo/book.xml deleted file mode 100644 index 395e53f2a49c..000000000000 --- a/reference/rpminfo/book.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - RpmInfo - RpmInfo - - - &reftitle.intro; - - This extension enables you to retrieve information from RPM files - or from the installed RPMs database. - - - It also provides a rpm stream wrapper to retrieve RPM content - (since version 1.0.0 with librpm >= 4.13). - - - - &reference.rpminfo.setup; - &reference.rpminfo.constants; - &reference.rpminfo.reference; - - - diff --git a/reference/rpminfo/constants.xml b/reference/rpminfo/constants.xml deleted file mode 100644 index c7d59aa18e41..000000000000 --- a/reference/rpminfo/constants.xml +++ /dev/null @@ -1,2937 +0,0 @@ - - - - &reftitle.constants; - &extension.constants; - - - Miscellaneous constants - - - RPMVERSION - (string) - - - - System librpm version. - - - - - - - RPM Senses - - - RPMSENSE_ANY - (int) - - - - - - - - - RPMSENSE_LESS - (int) - - - - - - - - - RPMSENSE_GREATER - (int) - - - - - - - - - RPMSENSE_EQUAL - (int) - - - - - - - - - RPMSENSE_POSTTRANS - (int) - - - - - - - - - RPMSENSE_PREREQ - (int) - - - - - - - - - RPMSENSE_PRETRANS - (int) - - - - - - - - - RPMSENSE_INTERP - (int) - - - - - - - - - RPMSENSE_SCRIPT_PRE - (int) - - - - - - - - - RPMSENSE_SCRIPT_POST - (int) - - - - - - - - - RPMSENSE_SCRIPT_PREUN - (int) - - - - - - - - - RPMSENSE_SCRIPT_POSTUN - (int) - - - - - - - - - RPMSENSE_SCRIPT_VERIFY - (int) - - - - - - - - - RPMSENSE_FIND_REQUIRES - (int) - - - - - - - - - RPMSENSE_FIND_PROVIDES - (int) - - - - - - - - - RPMSENSE_TRIGGERIN - (int) - - - - - - - - - RPMSENSE_TRIGGERUN - (int) - - - - - - - - - RPMSENSE_TRIGGERPOSTUN - (int) - - - - - - - - - RPMSENSE_MISSINGOK - (int) - - - - - - - - - RPMSENSE_RPMLIB - (int) - - - - - - - - - RPMSENSE_TRIGGERPREIN - (int) - - - - - - - - - RPMSENSE_KEYRING - (int) - - - - - - - - - RPMSENSE_CONFIG - (int) - - - - - - - - - - RPM Mire - - - RPMMIRE_DEFAULT - (int) - - - - Search pattern is a regular expression with - \., .*, - and ^...$ added. - - - - - - RPMMIRE_STRCMP - (int) - - - - Search pattern is a string, - using strcmp(3). - - - - - - RPMMIRE_REGEX - (int) - - - - Search pattern is a regular expression, - using regcomp(3). - - - - - - RPMMIRE_GLOB - (int) - - - - Search pattern is a glob expression, - using fnmatch(3). - - - - - - - RPM tags - - - RPMTAG_ARCH - (int) - - - - - - - - - RPMTAG_ARCHSUFFIX - (int) - - - - Requires librpm >= 4.18 - - - - - - RPMTAG_ARCHIVESIZE - (int) - - - - - - - - - RPMTAG_BASENAMES - (int) - - - - Name (not path) of files, with database index. - - - - - - RPMTAG_BUGURL - (int) - - - - - - - - - RPMTAG_BUILDARCHS - (int) - - - - - - - - - RPMTAG_BUILDHOST - (int) - - - - - - - - - RPMTAG_BUILDTIME - (int) - - - - - - - - - RPMTAG_C - (int) - - - - - - - - - RPMTAG_CHANGELOGNAME - (int) - - - - - - - - - RPMTAG_CHANGELOGTEXT - (int) - - - - - - - - - RPMTAG_CHANGELOGTIME - (int) - - - - - - - - - RPMTAG_CLASSDICT - (int) - - - - - - - - - RPMTAG_CONFLICTFLAGS - (int) - - - - - - - - - RPMTAG_CONFLICTNAME - (int) - - - - Conflicting dependencies, with database index. - - - - - - RPMTAG_CONFLICTNEVRS - (int) - - - - - - - - - RPMTAG_CONFLICTS - (int) - - - - - - - - - RPMTAG_CONFLICTVERSION - (int) - - - - - - - - - RPMTAG_COOKIE - (int) - - - - - - - - - RPMTAG_DBINSTANCE - (int) - - - - - - - - - RPMTAG_DEPENDSDICT - (int) - - - - - - - - - RPMTAG_DESCRIPTION - (int) - - - - - - - - - RPMTAG_DIRINDEXES - (int) - - - - - - - - - RPMTAG_DIRNAMES - (int) - - - - Directory of files, with database index. - - - - - - RPMTAG_DISTRIBUTION - (int) - - - - - - - - - RPMTAG_DISTTAG - (int) - - - - - - - - - RPMTAG_DISTURL - (int) - - - - - - - - - RPMTAG_DSAHEADER - (int) - - - - - - - - - RPMTAG_E - (int) - - - - - - - - - RPMTAG_ENCODING - (int) - - - - - - - - - RPMTAG_ENHANCEFLAGS - (int) - - - - - - - - - RPMTAG_ENHANCENAME - (int) - - - - Weak dependencies, with database index, requires librpm >= 4.13. - - - - - - RPMTAG_ENHANCENEVRS - (int) - - - - - - - - - RPMTAG_ENHANCES - (int) - - - - - - - - - RPMTAG_ENHANCEVERSION - (int) - - - - - - - - - RPMTAG_EPOCH - (int) - - - - - - - - - RPMTAG_EPOCHNUM - (int) - - - - - - - - - RPMTAG_EVR - (int) - - - - - - - - - RPMTAG_EXCLUDEARCH - (int) - - - - - - - - - RPMTAG_EXCLUDEOS - (int) - - - - - - - - - RPMTAG_EXCLUSIVEARCH - (int) - - - - - - - - - RPMTAG_EXCLUSIVEOS - (int) - - - - - - - - - RPMTAG_FILECAPS - (int) - - - - - - - - - RPMTAG_FILECLASS - (int) - - - - - - - - - RPMTAG_FILECOLORS - (int) - - - - - - - - - RPMTAG_FILECONTEXTS - (int) - - - - - - - - - RPMTAG_FILEDEPENDSN - (int) - - - - - - - - - RPMTAG_FILEDEPENDSX - (int) - - - - - - - - - RPMTAG_FILEDEVICES - (int) - - - - - - - - - RPMTAG_FILEDIGESTALGO - (int) - - - - - - - - - RPMTAG_FILEDIGESTS - (int) - - - - - - - - - RPMTAG_FILEFLAGS - (int) - - - - - - - - - RPMTAG_FILEGROUPNAME - (int) - - - - - - - - - RPMTAG_FILEINODES - (int) - - - - - - - - - RPMTAG_FILELANGS - (int) - - - - - - - - - RPMTAG_FILELINKTOS - (int) - - - - - - - - - RPMTAG_FILEMD5S - (int) - - - - - - - - - RPMTAG_FILEMODES - (int) - - - - - - - - - RPMTAG_FILEMTIMES - (int) - - - - - - - - - RPMTAG_FILENAMES - (int) - - - - - - - - - RPMTAG_FILENLINKS - (int) - - - - - - - - - RPMTAG_FILEPROVIDE - (int) - - - - - - - - - RPMTAG_FILERDEVS - (int) - - - - - - - - - RPMTAG_FILEREQUIRE - (int) - - - - - - - - - RPMTAG_FILESIGNATURELENGTH - (int) - - - - - - - - - RPMTAG_FILESIGNATURES - (int) - - - - - - - - - RPMTAG_FILESIZES - (int) - - - - - - - - - RPMTAG_FILESTATES - (int) - - - - - - - - - RPMTAG_FILETRIGGERCONDS - (int) - - - - - - - - - RPMTAG_FILETRIGGERFLAGS - (int) - - - - - - - - - RPMTAG_FILETRIGGERINDEX - (int) - - - - - - - - - RPMTAG_FILETRIGGERNAME - (int) - - - - File trigger name, with database index, requires librpm >= 4.13. - - - - - - RPMTAG_FILETRIGGERPRIORITIES - (int) - - - - - - - - - RPMTAG_FILETRIGGERSCRIPTFLAGS - (int) - - - - - - - - - RPMTAG_FILETRIGGERSCRIPTPROG - (int) - - - - - - - - - RPMTAG_FILETRIGGERSCRIPTS - (int) - - - - - - - - - RPMTAG_FILETRIGGERTYPE - (int) - - - - - - - - - RPMTAG_FILETRIGGERVERSION - (int) - - - - - - - - - RPMTAG_FILEUSERNAME - (int) - - - - - - - - - RPMTAG_FILEVERIFYFLAGS - (int) - - - - - - - - - RPMTAG_FSCONTEXTS - (int) - - - - - - - - - RPMTAG_GIF - (int) - - - - - - - - - RPMTAG_GROUP - (int) - - - - Group of the package, with database index. - - - - - - RPMTAG_HDRID - (int) - - - - Deprecated, use RPMTAG_SHA1HEADER instead. Removed in librpm 6. - - - - - - RPMTAG_HEADERCOLOR - (int) - - - - - - - - - RPMTAG_HEADERI18NTABLE - (int) - - - - - - - - - RPMTAG_HEADERIMAGE - (int) - - - - - - - - - RPMTAG_HEADERIMMUTABLE - (int) - - - - - - - - - RPMTAG_HEADERREGIONS - (int) - - - - - - - - - RPMTAG_HEADERSIGNATURES - (int) - - - - - - - - - RPMTAG_ICON - (int) - - - - - - - - - RPMTAG_INSTALLCOLOR - (int) - - - - - - - - - RPMTAG_INSTALLTID - (int) - - - - Installation transaction ID, with database index. - - - - - - RPMTAG_INSTALLTIME - (int) - - - - - - - - - RPMTAG_INSTFILENAMES - (int) - - - - Path of files, with database index. - - - - - - RPMTAG_INSTPREFIXES - (int) - - - - - - - - - RPMTAG_LICENSE - (int) - - - - - - - - - RPMTAG_LONGARCHIVESIZE - (int) - - - - - - - - - RPMTAG_LONGFILESIZES - (int) - - - - - - - - - RPMTAG_LONGSIGSIZE - (int) - - - - - - - - - RPMTAG_LONGSIZE - (int) - - - - - - - - - RPMTAG_MODULARITYLABEL - (int) - - - - - - - - - RPMTAG_N - (int) - - - - - - - - - RPMTAG_NAME - (int) - - - - Package name, with database index. - - - - - - RPMTAG_NEVR - (int) - - - - - - - - - RPMTAG_NEVRA - (int) - - - - - - - - - RPMTAG_NOPATCH - (int) - - - - - - - - - RPMTAG_NOSOURCE - (int) - - - - - - - - - RPMTAG_NVR - (int) - - - - - - - - - RPMTAG_NVRA - (int) - - - - - - - - - RPMTAG_O - (int) - - - - - - - - - RPMTAG_OBSOLETEFLAGS - (int) - - - - - - - - - RPMTAG_OBSOLETENAME - (int) - - - - Obsoleted packages, with database index. - - - - - - RPMTAG_OBSOLETENEVRS - (int) - - - - - - - - - RPMTAG_OBSOLETES - (int) - - - - - - - - - RPMTAG_OBSOLETEVERSION - (int) - - - - - - - - - RPMTAG_OLDENHANCES - (int) - - - - - - - - - RPMTAG_OLDENHANCESFLAGS - (int) - - - - - - - - - RPMTAG_OLDENHANCESNAME - (int) - - - - - - - - - RPMTAG_OLDENHANCESVERSION - (int) - - - - - - - - - RPMTAG_OLDFILENAMES - (int) - - - - - - - - - RPMTAG_OLDSUGGESTS - (int) - - - - - - - - - RPMTAG_OLDSUGGESTSFLAGS - (int) - - - - - - - - - RPMTAG_OLDSUGGESTSNAME - (int) - - - - - - - - - RPMTAG_OLDSUGGESTSVERSION - (int) - - - - - - - - - RPMTAG_OPTFLAGS - (int) - - - - - - - - - RPMTAG_ORDERFLAGS - (int) - - - - - - - - - RPMTAG_ORDERNAME - (int) - - - - - - - - - RPMTAG_ORDERVERSION - (int) - - - - - - - - - RPMTAG_ORIGBASENAMES - (int) - - - - - - - - - RPMTAG_ORIGDIRINDEXES - (int) - - - - - - - - - RPMTAG_ORIGDIRNAMES - (int) - - - - - - - - - RPMTAG_ORIGFILENAMES - (int) - - - - - - - - - RPMTAG_OS - (int) - - - - - - - - - RPMTAG_P - (int) - - - - - - - - - RPMTAG_PACKAGER - (int) - - - - - - - - - RPMTAG_PATCH - (int) - - - - - - - - - RPMTAG_PATCHESFLAGS - (int) - - - - - - - - - RPMTAG_PATCHESNAME - (int) - - - - - - - - - RPMTAG_PATCHESVERSION - (int) - - - - - - - - - RPMTAG_PAYLOADCOMPRESSOR - (int) - - - - - - - - - RPMTAG_PAYLOADDIGEST - (int) - - - - - - - - - RPMTAG_PAYLOADDIGESTALT - (int) - - - - With librpm >= 4.16. - - - - - - RPMTAG_PAYLOADDIGESTALGO - (int) - - - - - - - - - RPMTAG_PAYLOADFLAGS - (int) - - - - - - - - - RPMTAG_PAYLOADFORMAT - (int) - - - - - - - - - RPMTAG_PKGID - (int) - - - - Deprecated, use RPMTAG_SIGMD5 instead. Removed in librpm 6. - - - - - - RPMTAG_PLATFORM - (int) - - - - - - - - - RPMTAG_POLICIES - (int) - - - - - - - - - RPMTAG_POLICYFLAGS - (int) - - - - - - - - - RPMTAG_POLICYNAMES - (int) - - - - - - - - - RPMTAG_POLICYTYPES - (int) - - - - - - - - - RPMTAG_POLICYTYPESINDEXES - (int) - - - - - - - - - RPMTAG_POSTIN - (int) - - - - - - - - - RPMTAG_POSTINFLAGS - (int) - - - - - - - - - RPMTAG_POSTINPROG - (int) - - - - - - - - - RPMTAG_POSTTRANS - (int) - - - - - - - - - RPMTAG_POSTTRANSFLAGS - (int) - - - - - - - - - RPMTAG_POSTTRANSPROG - (int) - - - - - - - - - RPMTAG_POSTUN - (int) - - - - - - - - - RPMTAG_POSTUNFLAGS - (int) - - - - - - - - - RPMTAG_POSTUNPROG - (int) - - - - - - - - - RPMTAG_POSTUNTRANS - (int) - - - - Requires librpm >= 4.19 - - - - - - RPMTAG_POSTUNTRANSFLAGS - (int) - - - - Requires librpm >= 4.19 - - - - - - RPMTAG_POSTUNTRANSPROG - (int) - - - - Requires librpm >= 4.19 - - - - - - RPMTAG_PREFIXES - (int) - - - - - - - - - RPMTAG_PREIN - (int) - - - - - - - - - RPMTAG_PREINFLAGS - (int) - - - - - - - - - RPMTAG_PREINPROG - (int) - - - - - - - - - RPMTAG_PRETRANS - (int) - - - - - - - - - RPMTAG_PRETRANSFLAGS - (int) - - - - - - - - - RPMTAG_PRETRANSPROG - (int) - - - - - - - - - RPMTAG_PREUN - (int) - - - - - - - - - RPMTAG_PREUNFLAGS - (int) - - - - - - - - - RPMTAG_PREUNPROG - (int) - - - - - - - - - RPMTAG_PREUNTRANS - (int) - - - - Requires librpm >= 4.19 - - - - - - RPMTAG_PREUNTRANSFLAGS - (int) - - - - Requires librpm >= 4.19 - - - - - - RPMTAG_PREUNTRANSPROG - (int) - - - - Requires librpm >= 4.19 - - - - - - RPMTAG_PROVIDEFLAGS - (int) - - - - - - - - - RPMTAG_PROVIDENAME - (int) - - - - Provided dependencies, with database index. - - - - - - RPMTAG_PROVIDENEVRS - (int) - - - - - - - - - RPMTAG_PROVIDES - (int) - - - - - - - - - RPMTAG_PROVIDEVERSION - (int) - - - - - - - - - RPMTAG_PUBKEYS - (int) - - - - - - - - - RPMTAG_R - (int) - - - - - - - - - RPMTAG_RECOMMENDFLAGS - (int) - - - - - - - - - RPMTAG_RECOMMENDNAME - (int) - - - - Recommended weak dependencies, with database index, requires librpm >= 4.13. - - - - - - RPMTAG_RECOMMENDNEVRS - (int) - - - - - - - - - RPMTAG_RECOMMENDS - (int) - - - - - - - - - RPMTAG_RECOMMENDVERSION - (int) - - - - - - - - - RPMTAG_RECONTEXTS - (int) - - - - - - - - - RPMTAG_RELEASE - (int) - - - - - - - - - RPMTAG_REMOVETID - (int) - - - - - - - - - RPMTAG_REQUIREFLAGS - (int) - - - - - - - - - RPMTAG_REQUIRENAME - (int) - - - - Required dependencies, with database index. - - - - - - RPMTAG_REQUIRENEVRS - (int) - - - - - - - - - RPMTAG_REQUIRES - (int) - - - - - - - - - RPMTAG_REQUIREVERSION - (int) - - - - - - - - - RPMTAG_RPMVERSION - (int) - - - - - - - - - RPMTAG_RSAHEADER - (int) - - - - - - - - - RPMTAG_SHA1HEADER - (int) - - - - SHA1 signature, with database index. - - - - - - RPMTAG_SHA256HEADER - (int) - - - - - - - - - RPMTAG_SIGGPG - (int) - - - - - - - - - RPMTAG_SIGMD5 - (int) - - - - MD5 signature, with database index. - - - - - - RPMTAG_SIGPGP - (int) - - - - - - - - - RPMTAG_SIGSIZE - (int) - - - - - - - - - RPMTAG_SIZE - (int) - - - - - - - - - RPMTAG_SOURCE - (int) - - - - - - - - - RPMTAG_SOURCEPACKAGE - (int) - - - - - - - - - RPMTAG_SOURCEPKGID - (int) - - - - - - - - - RPMTAG_SOURCERPM - (int) - - - - - - - - - RPMTAG_SPEC - (int) - - - - Requires librpm >= 4.18 - - - - - - RPMTAG_SUGGESTFLAGS - (int) - - - - - - - - - RPMTAG_SUGGESTNAME - (int) - - - - Suggested weak dependencies, with database index, requires librpm >= 4.13. - - - - - - RPMTAG_SUGGESTNEVRS - (int) - - - - - - - - - RPMTAG_SUGGESTS - (int) - - - - - - - - - RPMTAG_SUGGESTVERSION - (int) - - - - - - - - - RPMTAG_SUMMARY - (int) - - - - - - - - - RPMTAG_SUPPLEMENTFLAGS - (int) - - - - - - - - - RPMTAG_SUPPLEMENTNAME - (int) - - - - Weak dependencies, with database index, requires librpm >= 4.13. - - - - - - RPMTAG_SUPPLEMENTNEVRS - (int) - - - - - - - - - RPMTAG_SUPPLEMENTS - (int) - - - - - - - - - RPMTAG_SUPPLEMENTVERSION - (int) - - - - - - - - - RPMTAG_SYSUSERS - (int) - - - - Requires librpm >= 4.19 - - - - - - RPMTAG_TRANSFILETRIGGERCONDS - (int) - - - - - - - - - RPMTAG_TRANSFILETRIGGERFLAGS - (int) - - - - - - - - - RPMTAG_TRANSFILETRIGGERINDEX - (int) - - - - - - - - - RPMTAG_TRANSFILETRIGGERNAME - (int) - - - - Transaction file trigger name, with database index, requires librpm >= 4.13. - - - - - - RPMTAG_TRANSFILETRIGGERPRIORITIES - (int) - - - - - - - - - RPMTAG_TRANSFILETRIGGERSCRIPTFLAGS - (int) - - - - - - - - - RPMTAG_TRANSFILETRIGGERSCRIPTPROG - (int) - - - - - - - - - RPMTAG_TRANSFILETRIGGERSCRIPTS - (int) - - - - - - - - - RPMTAG_TRANSFILETRIGGERTYPE - (int) - - - - - - - - - RPMTAG_TRANSFILETRIGGERVERSION - (int) - - - - - - - - - RPMTAG_TRANSLATIONURL - (int) - - - - Requires librpm >= 4.18 - - - - - - RPMTAG_TRIGGERCONDS - (int) - - - - - - - - - RPMTAG_TRIGGERFLAGS - (int) - - - - - - - - - RPMTAG_TRIGGERINDEX - (int) - - - - - - - - - RPMTAG_TRIGGERNAME - (int) - - - - Trigger name, with database index. - - - - - - RPMTAG_TRIGGERSCRIPTFLAGS - (int) - - - - - - - - - RPMTAG_TRIGGERSCRIPTPROG - (int) - - - - - - - - - RPMTAG_TRIGGERSCRIPTS - (int) - - - - - - - - - RPMTAG_TRIGGERTYPE - (int) - - - - - - - - - RPMTAG_TRIGGERVERSION - (int) - - - - - - - - - RPMTAG_UPSTREAMRELEASES - (int) - - - - Requires librpm >= 4.18 - - - - - - RPMTAG_URL - (int) - - - - - - - - - RPMTAG_V - (int) - - - - - - - - - RPMTAG_VCS - (int) - - - - - - - - - RPMTAG_VENDOR - (int) - - - - - - - - - RPMTAG_VERBOSE - (int) - - - - - - - - - RPMTAG_VERIFYSCRIPT - (int) - - - - - - - - - RPMTAG_VERIFYSCRIPTFLAGS - (int) - - - - - - - - - RPMTAG_VERIFYSCRIPTPROG - (int) - - - - - - - - - RPMTAG_VERITYSIGNATUREALGO - (int) - - - - With librpm >= 4.17. - - - - - - RPMTAG_VERITYSIGNATURES - (int) - - - - With librpm >= 4.17. - - - - - - RPMTAG_VERSION - (int) - - - - - - - - - RPMTAG_XPM - (int) - - - - - - - - - diff --git a/reference/rpminfo/functions/rpmaddtag.xml b/reference/rpminfo/functions/rpmaddtag.xml deleted file mode 100644 index 2ec234cc8df8..000000000000 --- a/reference/rpminfo/functions/rpmaddtag.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - rpmaddtag - Add tag retrieved in query - - - - &reftitle.description; - - boolrpmaddtag - inttag - - - Add an additional retrieved tag in subsequent queries. - - - - - &reftitle.parameters; - - - tag - - - One of RPMTAG_* constant. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - rpminfo - rpmdbinfo - rpmdbsearch - - - - - diff --git a/reference/rpminfo/functions/rpmdbinfo.xml b/reference/rpminfo/functions/rpmdbinfo.xml deleted file mode 100644 index 5f6a4569aa84..000000000000 --- a/reference/rpminfo/functions/rpmdbinfo.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - rpmdbinfo - Get information from installed RPM - - - - &reftitle.description; - - arraynullrpmdbinfo - stringnevr - boolfull&false; - - - Retrieve information about an installed package, from the system RPM database. - - - - - &reftitle.parameters; - - - nevr - - - Name with optional epoch, version and release. - - - - - full - - - If &true; all information headers for the file are retrieved, else only a minimal set. - - - - - - - - &reftitle.returnvalues; - - An array of array of information, or &null; on error. - - - - - &reftitle.examples; - - A <function>rpmdbinfo</function> example - - -]]> - - &example.outputs; - - Array - ( - [Name] => php-pecl-rpminfo - [Version] => 0.4.2 - [Release] => 1.fc31 - [Summary] => RPM information - [Installtime] => 1586244687 - [Arch] => x86_64 - ) -) -]]> - - - - - - &reftitle.seealso; - - rpmaddtag - - - - - diff --git a/reference/rpminfo/functions/rpmdbsearch.xml b/reference/rpminfo/functions/rpmdbsearch.xml deleted file mode 100644 index 91ee47f47558..000000000000 --- a/reference/rpminfo/functions/rpmdbsearch.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - rpmdbsearch - Search RPM packages - - - - &reftitle.description; - - arraynullrpmdbsearch - stringpattern - intrpmtagRPMTAG_NAME - intrpmmire-1 - boolfull&false; - - - Search packages in the system RPM database. - - - - - &reftitle.parameters; - - - pattern - - - Value to search for. - - - - - rpmtag - - - Search criterion, which is one of the - RPMTAG_* constants. - - - - - rpmmire - - - Pattern type, which is one of the - RPMMIRE_* constants. - When < 0 the criterion must equal the value, and database index is used if possible. - - - - - full - - - If &true; all information headers for the file are retrieved, else only a minimal set. - - - - - - - - &reftitle.returnvalues; - - An array of array of information, or &null; on error. - - - - - &reftitle.examples; - - Searching for the package owning a file - - -]]> - - &example.outputs; - - Array - ( - [Name] => php-cli - [Version] => 7.4.4 - [Release] => 1.fc32 - [Summary] => Command-line interface for PHP - [Arch] => x86_64 - ) - -) -]]> - - - - - - &reftitle.seealso; - - rpmaddtag - - - - - diff --git a/reference/rpminfo/functions/rpmdefine.xml b/reference/rpminfo/functions/rpmdefine.xml deleted file mode 100644 index df70c5eddca6..000000000000 --- a/reference/rpminfo/functions/rpmdefine.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - rpmdefine - Define or change a RPM macro value - - - - &reftitle.description; - - boolrpmdefine - stringtext - - - Define or change a RPM macro value. - - - This can be used to select the database path and backend to use - instead of system default one. - - - - - &reftitle.parameters; - - - text - - - Macro name, options, body. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - A <function>rpmdefine</function> example - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - rpmexpand - rpmdbinfo - - - - - diff --git a/reference/rpminfo/functions/rpmexpand.xml b/reference/rpminfo/functions/rpmexpand.xml deleted file mode 100644 index 0ed967e89036..000000000000 --- a/reference/rpminfo/functions/rpmexpand.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - rpmexpand - Retrieve expanded value of a RPM macro - - - - &reftitle.description; - - stringrpmexpand - stringtext - - - Retrieve expanded value of a RPM macro. - - - - - &reftitle.parameters; - - - text - - - Text with RPM macros to expand. - - - - - - - - &reftitle.returnvalues; - - A string with concatenated macro expansions. - - - - - &reftitle.examples; - - A <function>rpmexpand</function> example - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - rpmexpandnumeric - - - - - diff --git a/reference/rpminfo/functions/rpmexpandnumeric.xml b/reference/rpminfo/functions/rpmexpandnumeric.xml deleted file mode 100644 index d630a926e8ec..000000000000 --- a/reference/rpminfo/functions/rpmexpandnumeric.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - rpmexpandnumeric - Retrieve numerical value of a RPM macro - - - - &reftitle.description; - - intrpmexpandnumeric - stringtext - - - Retrieve numerical value of a RPM macro. - - - - - &reftitle.parameters; - - - text - - - Text with RPM macros to expand. - - - - - - - - &reftitle.returnvalues; - - Macro expansion as a int. - Boolean values (Y or y returns 1, - N or n returns 0) - are permitted as well. - An undefined macro returns 0. - - - - - &reftitle.examples; - - A <function>rpmexpandnumeric</function> example - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - rpmexpand - - - - - diff --git a/reference/rpminfo/functions/rpmgetsymlink.xml b/reference/rpminfo/functions/rpmgetsymlink.xml deleted file mode 100644 index d72f746ca6d8..000000000000 --- a/reference/rpminfo/functions/rpmgetsymlink.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - rpmgetsymlink - Get target of a symlink - - - - &reftitle.description; - - stringnullrpmgetsymlink - stringpath - stringname - - - Get target of a symlink. - - - - - &reftitle.parameters; - - - path - - - Path of the RPM file. - - - - - name - - - Name of the symlink file. - - - - - - - - &reftitle.returnvalues; - - A string with target of the symlink, - &null; on error, or an empty string if not a symlink. - - - - - diff --git a/reference/rpminfo/functions/rpminfo.xml b/reference/rpminfo/functions/rpminfo.xml deleted file mode 100644 index ed0b1eda573d..000000000000 --- a/reference/rpminfo/functions/rpminfo.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - rpminfo - Get information from a RPM file - - - - &reftitle.description; - - arraynullrpminfo - stringpath - boolfull&false; - stringerror - - - Retrieve information about a local file, a RPM package. - - - - - &reftitle.parameters; - - - path - - - Path of the RPM file. - - - - - full - - - If &true; all information headers for the file are retrieved, - else only a minimal set. - - - - - error - - - If provided, will receive the possible error message, - and will avoid a runtime warning. - - - - - - - - &reftitle.returnvalues; - - An array of information, or &null; on error. - - - - - &reftitle.examples; - - A <function>rpminfo</function> example - - -]]> - - &example.outputs; - - php-pecl-rpminfo - [Version] => 0.4.2 - [Release] => 1.el8 - [Summary] => RPM information - [Buildtime] => 1586244821 - [Arch] => x86_64 -) -]]> - - - - - - &reftitle.seealso; - - rpmaddtag - - - - - diff --git a/reference/rpminfo/functions/rpmvercmp.xml b/reference/rpminfo/functions/rpmvercmp.xml deleted file mode 100644 index 3e7db17bec7a..000000000000 --- a/reference/rpminfo/functions/rpmvercmp.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - rpmvercmp - RPM version comparison - - - - &reftitle.description; - - intboolrpmvercmp - stringevr1 - stringevr2 - stringnulloperator&null; - - - Compare two RPM package versions. - - - - - &reftitle.parameters; - - - evr1 - - - First epoch:version-release string. - - - - - evr2 - - - Second epoch:version-release string. - - - - - operator - - - An optional operator. - The possible operators are: - - < - lt - <= - le - > - gt - >= - ge - == - = - eq - != - <> - ne - . - - - This parameter is case-sensitive, values should be lowercase. - - - - - - - - &reftitle.returnvalues; - - Returns -1 if evr1 is less than - evr2, 1 if evr1 is - greater than evr2, and 0 if they are equal. - - - When using the optional operator argument, the - function will return &true; if the relationship is the one specified - by the operator, &false; otherwise. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL rpminfo 0.7.0 - - Optional operator was added. - - - - - - - - - diff --git a/reference/rpminfo/reference.xml b/reference/rpminfo/reference.xml deleted file mode 100644 index 795ea5478720..000000000000 --- a/reference/rpminfo/reference.xml +++ /dev/null @@ -1,28 +0,0 @@ - - - - RpmInfo &Functions; - - &reference.rpminfo.entities.functions; - - - diff --git a/reference/rpminfo/setup.xml b/reference/rpminfo/setup.xml deleted file mode 100644 index 4e0f8d39e9f5..000000000000 --- a/reference/rpminfo/setup.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - &reftitle.setup; - -
    - &reftitle.required; - - This extension requires librpm version 4.11.3 or higher. - -
    - -
    - Installation via PECL - - &pecl.info; - &url.pecl.package;rpminfo. - -
    - -
    - diff --git a/reference/rpminfo/versions.xml b/reference/rpminfo/versions.xml deleted file mode 100644 index ca4e295df6ef..000000000000 --- a/reference/rpminfo/versions.xml +++ /dev/null @@ -1,36 +0,0 @@ - - - - - - - - - - - - - - - - - diff --git a/reference/rrd/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/rrd/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/rrd/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/rrd/book.xml b/reference/rrd/book.xml deleted file mode 100644 index b9c2d8c989a5..000000000000 --- a/reference/rrd/book.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - RRDtool - RRD - - - &reftitle.intro; - - The PECL/rrd extension provides bindings to the RRDtool C library. - RRDtool is the open source industry standard, high performance data - logging and graphing system for time series data. - - - The RRDtool homepage is &url.rrd;. - - - - &reference.rrd.setup; - &reference.rrd.examples; - &reference.rrd.reference; - - &reference.rrd.rrdcreator; - &reference.rrd.rrdgraph; - &reference.rrd.rrdupdater; - - diff --git a/reference/rrd/configure.xml b/reference/rrd/configure.xml deleted file mode 100644 index 0ab2eadb38d1..000000000000 --- a/reference/rrd/configure.xml +++ /dev/null @@ -1,31 +0,0 @@ - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;rrd - - -
    - diff --git a/reference/rrd/examples.xml b/reference/rrd/examples.xml deleted file mode 100644 index f69c7dff142d..000000000000 --- a/reference/rrd/examples.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - &reftitle.examples; -
    - Procedural PECL/rrd example - - Procedural usage of rrd - - -]]> - - -
    - -
    - OOP PECL/rrd example - - OO usage of rrd - -addDataSource("speed:COUNTER:600:U:U"); -$creator->addArchive("AVERAGE:0.5:1:24"); -$creator->addArchive("AVERAGE:0.5:6:10"); -$creator->save(); - -$updater = new RRDUpdater($rrdFile); -$updater->update(array("speed" => "12345"), "920804700"); -$updater->update(array("speed" => "12357"), "920805000"); - -$graphObj = new RRDGraph($outputPngFile); -$graphObj->setOptions( - array( - "--start" => "920804400", - "--end" => 920808000, - "--vertical-label" => "m/s", - "DEF:myspeed=$rrdFile:speed:AVERAGE", - "CDEF:realspeed=myspeed,1000,*", - "LINE2:realspeed#FF0000" - ) -); -$graphObj->save(); -?> -]]> - - -
    - -
    - diff --git a/reference/rrd/functions/rrd-create.xml b/reference/rrd/functions/rrd-create.xml deleted file mode 100644 index 5fc90c196226..000000000000 --- a/reference/rrd/functions/rrd-create.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - rrd_create - Creates rrd database file - - - - &reftitle.description; - - boolrrd_create - stringfilename - arrayoptions - - - Creates the rdd database file. - - - - - &reftitle.parameters; - - - filename - - - Filename for newly created rrd file. - - - - - options - - - Options for rrd create - list of strings. See man page of rrd create - for whole list of options. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/rrd/functions/rrd-error.xml b/reference/rrd/functions/rrd-error.xml deleted file mode 100644 index e17d13558179..000000000000 --- a/reference/rrd/functions/rrd-error.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - rrd_error - Gets latest error message - - - - &reftitle.description; - - stringrrd_error - - - - Returns latest global rrd error message. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Latest error message. - - - - - diff --git a/reference/rrd/functions/rrd-fetch.xml b/reference/rrd/functions/rrd-fetch.xml deleted file mode 100644 index 0f78a72d2747..000000000000 --- a/reference/rrd/functions/rrd-fetch.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - rrd_fetch - Fetch the data for graph as array - - - - &reftitle.description; - - arrayrrd_fetch - stringfilename - arrayoptions - - - Gets data for graph output from RRD database file as array. This function - has same result as rrd_graph, but fetched data are - returned as array, no image file is created. - - - - - &reftitle.parameters; - - - filename - - - RRD database file name. - - - - - options - - - Array of options for resolution specification. - - - - - - - - &reftitle.returnvalues; - - Returns information about retrieved graph data. - - - - - diff --git a/reference/rrd/functions/rrd-first.xml b/reference/rrd/functions/rrd-first.xml deleted file mode 100644 index d545e7e1b3cc..000000000000 --- a/reference/rrd/functions/rrd-first.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - rrd_first - Gets the timestamp of the first sample from rrd file - - - - &reftitle.description; - - intrrd_first - stringfile - intraaindex0 - - - Returns the first data sample from the specified RRA of the RRD file. - - - - - &reftitle.parameters; - - - file - - - RRD database file name. - - - - - raaindex - - - The index number of the RRA that is to be examined. Default value is 0. - - - - - - - - &reftitle.returnvalues; - - Integer number of unix timestamp,&return.falseforfailure;. - - - - - diff --git a/reference/rrd/functions/rrd-graph.xml b/reference/rrd/functions/rrd-graph.xml deleted file mode 100644 index 0fb120af5a33..000000000000 --- a/reference/rrd/functions/rrd-graph.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - rrd_graph - Creates image from a data - - - - &reftitle.description; - - arrayrrd_graph - stringfilename - arrayoptions - - - Creates image for a particular data from RRD file. - - - - - &reftitle.parameters; - - - filename - - - The filename to output the graph to. This will generally end in either - .png, .svg or - .eps, depending on the format you want to output. - - - - - options - - - Options for generating image. See man page of rrd graph for all - possible options. All options (data definitions, variable definitions, etc.) - are allowed. - - - - - - - - &reftitle.returnvalues; - - Array with information about generated image is returned,&return.falseforfailure;. - - - - diff --git a/reference/rrd/functions/rrd-info.xml b/reference/rrd/functions/rrd-info.xml deleted file mode 100644 index 53cfc952e8eb..000000000000 --- a/reference/rrd/functions/rrd-info.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - rrd_info - Gets information about rrd file - - - - &reftitle.description; - - arrayrrd_info - stringfilename - - - Returns information about particular RRD database file. - - - - - &reftitle.parameters; - - - file - - - RRD database file name. - - - - - - - - &reftitle.returnvalues; - - Array with information about requested RRD file,&return.falseforfailure;. - - - - - - diff --git a/reference/rrd/functions/rrd-last.xml b/reference/rrd/functions/rrd-last.xml deleted file mode 100644 index 5252bc6e24cc..000000000000 --- a/reference/rrd/functions/rrd-last.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - rrd_last - Gets unix timestamp of the last sample - - - - &reftitle.description; - - intrrd_last - stringfilename - - - Returns the UNIX timestamp of the most recent update of the RRD database. - - - - - &reftitle.parameters; - - - filename - - - RRD database file name. - - - - - - - - &reftitle.returnvalues; - - Integer as unix timestamp of the most recent data from the RRD database. - - - - - diff --git a/reference/rrd/functions/rrd-lastupdate.xml b/reference/rrd/functions/rrd-lastupdate.xml deleted file mode 100644 index 6ef4fd2f5951..000000000000 --- a/reference/rrd/functions/rrd-lastupdate.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - rrd_lastupdate - Gets information about last updated data - - - - &reftitle.description; - - arrayrrd_lastupdate - stringfilename - - - Gets array of the UNIX timestamp and the values stored for each date in the - most recent update of the RRD database file. - - - - - &reftitle.parameters; - - - file - - - RRD database file name. - - - - - - - - &reftitle.returnvalues; - - Array of information about last update,&return.falseforfailure;. - - - - diff --git a/reference/rrd/functions/rrd-restore.xml b/reference/rrd/functions/rrd-restore.xml deleted file mode 100644 index b044e6f94b8b..000000000000 --- a/reference/rrd/functions/rrd-restore.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - rrd_restore - Restores the RRD file from XML dump - - - - &reftitle.description; - - boolrrd_restore - stringxml_file - stringrrd_file - arrayoptions - - - Restores the RRD file from the XML dump. - - - - - &reftitle.parameters; - - - xml_file - - - XML filename with the dump of the original RRD database file. - - - - - rrd_file - - - Restored RRD database file name. - - - - - options - - - Array of options for restoring. See man page for rrd restore. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/rrd/functions/rrd-tune.xml b/reference/rrd/functions/rrd-tune.xml deleted file mode 100644 index af1663ea0959..000000000000 --- a/reference/rrd/functions/rrd-tune.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - rrd_tune - Tunes some RRD database file header options - - - - &reftitle.description; - - boolrrd_tune - stringfilename - arrayoptions - - - Change some options in the RRD dabase header file. E.g. renames the source for - the data etc. - - - - - &reftitle.parameters; - - - filename - - - RRD database file name. - - - - - options - - - Options with RRD database file properties which will be changed. See - rrd tune man page for details. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/rrd/functions/rrd-update.xml b/reference/rrd/functions/rrd-update.xml deleted file mode 100644 index fec478ef6c27..000000000000 --- a/reference/rrd/functions/rrd-update.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - rrd_update - Updates the RRD database - - - - &reftitle.description; - - boolrrd_update - stringfilename - arrayoptions - - - Updates the RRD database file. The input data is time interpolated according to the - properties of the RRD database file. - - - - - &reftitle.parameters; - - - filename - - - RRD database file name. This database will be updated. - - - - - options - - - Options for updating the RRD database. This is list of strings. See man page of rrd update - for whole list of options. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/rrd/functions/rrd-version.xml b/reference/rrd/functions/rrd-version.xml deleted file mode 100644 index 505415be38e9..000000000000 --- a/reference/rrd/functions/rrd-version.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - rrd_version - Gets information about underlying rrdtool library - - - - &reftitle.description; - - stringrrd_version - - - - Returns information about underlying rrdtool library. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - String with rrdtool version number e.g. "1.4.3". - - - - - diff --git a/reference/rrd/functions/rrd-xport.xml b/reference/rrd/functions/rrd-xport.xml deleted file mode 100644 index 5ab548a81ffe..000000000000 --- a/reference/rrd/functions/rrd-xport.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - rrd_xport - Exports the information about RRD database - - - - &reftitle.description; - - arrayrrd_xport - arrayoptions - - - Exports the information about RRD database file. This data can be converted - to XML file via user space PHP script and then restored back as RRD database - file. - - - - - &reftitle.parameters; - - - options - - - Array of options for the export, see rrd xport man page. - - - - - - - - &reftitle.returnvalues; - - Array with information about RRD database file,&return.falseforfailure;. - - - - - diff --git a/reference/rrd/functions/rrdc-disconnect.xml b/reference/rrd/functions/rrdc-disconnect.xml deleted file mode 100644 index 3eb8c804d3f0..000000000000 --- a/reference/rrd/functions/rrdc-disconnect.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - rrdc_disconnect - Close any outstanding connection to rrd caching daemon - - - - &reftitle.description; - - voidrrdc_disconnect - - - - Close any outstanding connection to rrd caching daemon. - - - This function is automatically called when the whole PHP process is terminated. - It depends on used SAPI. For example, it's called automatically at the end - of command line script. - - - It's up user whether he wants to call this function at the end of every request - or otherwise. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/rrd/reference.xml b/reference/rrd/reference.xml deleted file mode 100644 index 3a49b799a0f6..000000000000 --- a/reference/rrd/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - RRD &Functions; - - &reference.rrd.entities.functions; - - - - diff --git a/reference/rrd/rrdcreator.xml b/reference/rrd/rrdcreator.xml deleted file mode 100644 index f6ff937b8642..000000000000 --- a/reference/rrd/rrdcreator.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - The RRDCreator class - RRDCreator - - - - -
    - &reftitle.intro; - - Class for creation of RRD database file. - -
    - - -
    - &reftitle.classsynopsis; - - - - RRDCreator - - - - - RRDCreator - - - - - &Methods; - - - - - -
    - -
    - - &reference.rrd.entities.rrdcreator; - -
    - diff --git a/reference/rrd/rrdcreator/addarchive.xml b/reference/rrd/rrdcreator/addarchive.xml deleted file mode 100644 index 80d10b28d964..000000000000 --- a/reference/rrd/rrdcreator/addarchive.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - RRDCreator::addArchive - Adds RRA - archive of data values for each data source - - - - &reftitle.description; - - public voidRRDCreator::addArchive - stringdescription - - - Adds RRA definition by description of archive. Archive consists of a - number of data values or statistics for each of the defined data-sources (DS). - Data sources are defined by method RRDCreator::addDataSource. - You need call this method for each requested archive. - - - - - &reftitle.parameters; - - - description - - - Definition of archive - RRA. This has same format as RRA definition in - rrd create command. See man page of rrd create for more details. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/rrd/rrdcreator/adddatasource.xml b/reference/rrd/rrdcreator/adddatasource.xml deleted file mode 100644 index 13dfb5146a8f..000000000000 --- a/reference/rrd/rrdcreator/adddatasource.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - RRDCreator::addDataSource - Adds data source definition for RRD database - - - - &reftitle.description; - - public voidRRDCreator::addDataSource - stringdescription - - - RRD can accept input from several data sources (DS), e.g incoming and outgoing - traffic. This method adds data source by description. You need call - this method for each data source. - - - - - &reftitle.parameters; - - - description - - - Definition of data source - DS. This has same format as DS definition in - rrd create command. See man page of rrd create for more details. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/rrd/rrdcreator/construct.xml b/reference/rrd/rrdcreator/construct.xml deleted file mode 100644 index 0750a72ca5bb..000000000000 --- a/reference/rrd/rrdcreator/construct.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - RRDCreator::__construct - Creates new RRDCreator instance - - - - &reftitle.description; - - public RRDCreator::__construct - stringpath - stringstartTime - intstep0 - - - Creates new RRDCreator instance. - - - - - &reftitle.parameters; - - - path - - - Path for newly created RRD database file. - - - - - startTime - - - Time for the first value in RRD database. Parameter supports all formats - which are supported by rrd create call. - - - - - intstep - - - Base interval in seconds with which data will be fed into the RRD database. - - - - - - - - diff --git a/reference/rrd/rrdcreator/save.xml b/reference/rrd/rrdcreator/save.xml deleted file mode 100644 index 1028ca9ba302..000000000000 --- a/reference/rrd/rrdcreator/save.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - RRDCreator::save - Saves the RRD database to a file - - - - &reftitle.description; - - public boolRRDCreator::save - - - - Saves the RRD database into file, which name is defined by RRDCreator::__construct. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/rrd/rrdgraph.xml b/reference/rrd/rrdgraph.xml deleted file mode 100644 index 3c501064d833..000000000000 --- a/reference/rrd/rrdgraph.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - The RRDGraph class - RRDGraph - - - - -
    - &reftitle.intro; - - Class for exporting data from RRD database to image file. - -
    - - -
    - &reftitle.classsynopsis; - - - - RRDGraph - - - - - RRDGraph - - - - - &Methods; - - - - - -
    - -
    - - &reference.rrd.entities.rrdgraph; - -
    - diff --git a/reference/rrd/rrdgraph/construct.xml b/reference/rrd/rrdgraph/construct.xml deleted file mode 100644 index 48471e19dcc5..000000000000 --- a/reference/rrd/rrdgraph/construct.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - RRDGraph::__construct - Creates new RRDGraph instance - - - - &reftitle.description; - - public RRDGraph::__construct - stringpath - - - Creates new RRDGraph instance. This instance is responsible for rendering - the result of RRD database query into image. - - - - - &reftitle.parameters; - - - path - - - Full path for the newly created image. - - - - - - - - diff --git a/reference/rrd/rrdgraph/save.xml b/reference/rrd/rrdgraph/save.xml deleted file mode 100644 index 84f7487fe44c..000000000000 --- a/reference/rrd/rrdgraph/save.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - RRDGraph::save - Saves the result of query into image - - - - &reftitle.description; - - public arrayRRDGraph::save - - - - Saves the result of RRD database query into image defined by - RRDGraph::__construct. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns array with information about generated image,&return.falseforfailure;. - - - - diff --git a/reference/rrd/rrdgraph/saveverbose.xml b/reference/rrd/rrdgraph/saveverbose.xml deleted file mode 100644 index f85f95839e8a..000000000000 --- a/reference/rrd/rrdgraph/saveverbose.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - RRDGraph::saveVerbose - Saves the RRD database query into image and returns the verbose - information about generated graph - - - - - &reftitle.description; - - public arrayRRDGraph::saveVerbose - - - - Saves the RRD database query into image file defined by method RRDGraph::__construct - and returns the verbose information about generated graph, if "-" is used as image - filename, image data are also returned in result array. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns array with detailed information about generated image,&return.falseforfailure;. - - - - diff --git a/reference/rrd/rrdgraph/setoptions.xml b/reference/rrd/rrdgraph/setoptions.xml deleted file mode 100644 index 5ac27770af45..000000000000 --- a/reference/rrd/rrdgraph/setoptions.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - RRDGraph::setOptions - Sets the options for rrd graph export - - - - &reftitle.description; - - public voidRRDGraph::setOptions - arrayoptions - - - - - - - - &reftitle.parameters; - - - options - - - List of options for the image generation from the RRD database file. It can - be list of strings or list of strings with keys for better readability. Read - the rrd graph man pages for list of available options. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - <methodname>RRDGraph::setOptions</methodname> example - -setOptions(array( - "--start" => "920804400", - "--end" => 920808000, - "--vertical-label" => "m/s", - "DEF:myspeed=$rrdFile:speed:AVERAGE", - "CDEF:realspeed=myspeed,1000,*", - "LINE2:realspeed#FF0000" -)); -?> -]]> - - - - - Set multiple color options - -setOptions(array( - "--start" => "920804400", - "--end" => 920808000, - "--vertical-label" => "m/s", - "--color=BACK#00000000", - "--color=GRID#00000000", - "--color=MGRID#00000000", - "DEF:myspeed=$rrdFile:speed:AVERAGE", - "CDEF:realspeed=myspeed,1000,*", - "LINE2:realspeed#FF0000" -)); -?> -]]> - - - Don't use key value syntax for same rrd option. It looks more readable, but - it doesn't work. - - -setOptions(array( - "--color" => "BACK#00000000", - "--color" => "GRID#00000000", - "--color" => "MGRID#00000000" -)); -?> -]]> - - - In nature of php it's same as - - -setOptions(array( - "--color" => "MGRID#00000000" -)); -?> -]]> - - - - - - diff --git a/reference/rrd/rrdupdater.xml b/reference/rrd/rrdupdater.xml deleted file mode 100644 index 48ff5926ab64..000000000000 --- a/reference/rrd/rrdupdater.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - The RRDUpdater class - RRDUpdater - - - - -
    - &reftitle.intro; - - Class for updating RDD database file. - -
    - - -
    - &reftitle.classsynopsis; - - - - RRDUpdater - - - - - RRDUpdater - - - - - &Methods; - - - - - -
    - -
    - - &reference.rrd.entities.rrdupdater; - -
    - diff --git a/reference/rrd/rrdupdater/construct.xml b/reference/rrd/rrdupdater/construct.xml deleted file mode 100644 index a10b1cae0566..000000000000 --- a/reference/rrd/rrdupdater/construct.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - RRDUpdater::__construct - Creates new RRDUpdater instance - - - - &reftitle.description; - - public RRDUpdater::__construct - stringpath - - - Creates new RRDUpdater instance. This instance is responsible for updating - the RRD database file. - - - - - &reftitle.parameters; - - - path - - - Filesystem path for RRD database file, which will be updated. - - - - - - - - diff --git a/reference/rrd/rrdupdater/update.xml b/reference/rrd/rrdupdater/update.xml deleted file mode 100644 index 78d0b1c211d8..000000000000 --- a/reference/rrd/rrdupdater/update.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - RRDUpdater::update - Update the RRD database file - - - - &reftitle.description; - - public boolRRDUpdater::update - arrayvalues - stringtime - time() - - - - Updates the RRD file defined via RRDUpdater::__construct. - The file is updated with a specific values. - - - - - &reftitle.parameters; - - - values - - - Data for update. Key is data source name. - - - - - time - - - Time value for updating the RRD with a particular data. Default value - is current time. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - Throws a Exception on error. - - - - - &reftitle.examples; - - <methodname>RRDUpdater::update</methodname> examples - -update(array("speed" => "12411"), "920807700"); -?> -]]> - - - - - diff --git a/reference/rrd/setup.xml b/reference/rrd/setup.xml deleted file mode 100644 index 95fea8424b40..000000000000 --- a/reference/rrd/setup.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - &reftitle.setup; - -
    - &reftitle.required; - - You need to install librrd first to be able to use PECL/rrd. Most common option - is using of librrd-dev package from your favourite Linux distro. - PECL/rrd is tested with librrd 1.4.3, older or newer versions might or might not - work for you. - - - - Librrd and hence extension itself aren't mostly thread safe. There are many - global and shared states in librrd. It can be dangerous use this extension - in multi threaded environments like Apache2 mpm worker. - If there are many parallel requests, one request can change some global - librrd state of other runnig requests. - - -
    - -
    - &reftitle.install; - - &pecl.info; - &url.pecl.package;rrd. - -
    - -
    - diff --git a/reference/rrd/versions.xml b/reference/rrd/versions.xml deleted file mode 100644 index 254198bc74dd..000000000000 --- a/reference/rrd/versions.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/runkit7/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/runkit7/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/runkit7/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/runkit7/book.xml b/reference/runkit7/book.xml deleted file mode 100644 index 88bcd9f94876..000000000000 --- a/reference/runkit7/book.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - runkit7 - runkit7 - - - &reftitle.intro; - - The runkit7 extension provides means to modify constants, - user-defined functions, and user-defined classes. - It also provides for custom superglobal variables. - - - - This package is a fork of the - runkit package providing PHP 7 support. - - - - &reference.runkit7.setup; - &reference.runkit7.constants; - &reference.runkit7.reference; - - - - diff --git a/reference/runkit7/constants.xml b/reference/runkit7/constants.xml deleted file mode 100644 index 20a74373a6d2..000000000000 --- a/reference/runkit7/constants.xml +++ /dev/null @@ -1,209 +0,0 @@ - - - - &reftitle.constants; - &extension.constants; - - - - RUNKIT7_IMPORT_FUNCTIONS - (int) - - - - runkit7_import flag indicating - that normal functions should be imported from the - specified file. - - - - - - RUNKIT7_IMPORT_CLASS_METHODS - (int) - - - - runkit7_import flag indicating - that class methods should be imported from the - specified file. - - - - - - RUNKIT7_IMPORT_CLASS_CONSTS - (int) - - - - runkit7_import flag indicating - that class constants should be imported from the - specified file. - - - - - - RUNKIT7_IMPORT_CLASS_PROPS - (int) - - - - runkit7_import flag indicating - that class standard properties should be imported - from the specified file. - - - - - - RUNKIT7_IMPORT_CLASS_STATIC_PROPS - (int) - - - - runkit7_import flag indicating - that class static properties should be imported - from the specified file. Available since Runkit 1.0.1. - - - - - - RUNKIT7_IMPORT_CLASSES - (int) - - - - runkit7_import flag representing - a bitwise OR of the RUNKIT7_IMPORT_CLASS_* - constants. - - - - - - RUNKIT7_IMPORT_OVERRIDE - (int) - - - - runkit7_import flag indicating that - if any of the imported functions, methods, constants, - or properties already exist, they should be replaced with - the new definitions. If this flag is not set, then any - imported definitions which already exist will be discarded. - - - - - - RUNKIT7_ACC_RETURN_REFERENCE - (int) - - - - Include this flag to make the function or method being created or redeclared return a reference. - - - - - - RUNKIT7_ACC_PUBLIC - (int) - - - - Flag for runkit7_method_add and runkit7_method_redefine to make the method public. - - - - - - RUNKIT7_ACC_PROTECTED - (int) - - - - Flag for runkit7_method_add and runkit7_method_redefine to make the method protected. - - - - - - RUNKIT7_ACC_PRIVATE - (int) - - - - Flag for runkit7_method_add and runkit7_method_redefine to make the method private. - - - - - - RUNKIT7_ACC_STATIC - (int) - - - - Flag for runkit7_method_add and runkit7_method_redefine to make the method static. - - - - - - RUNKIT7_FEATURE_MANIPULATION - (int) - - - - Equal to 1 if runtime manipulation is enabled, and 0 otherwise. - - - - - - RUNKIT7_FEATURE_SUPERGLOBALS - (int) - - - - Equal to 1 if custom superglobals are enabled, and 0 otherwise. - - - - - - RUNKIT7_FEATURE_SANDBOX - (int) - - - - Always 0, it's impractical to implement the sandbox feature in php 7. - - - - - - diff --git a/reference/runkit7/functions/runkit7-constant-add.xml b/reference/runkit7/functions/runkit7-constant-add.xml deleted file mode 100644 index 2e1603614c1a..000000000000 --- a/reference/runkit7/functions/runkit7-constant-add.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - runkit7_constant_add - - Similar to define(), but allows defining in class definitions as well - - - - - &reftitle.description; - - boolrunkit7_constant_add - stringconstant_name - mixedvalue - intnewVisibility - - - - - &reftitle.parameters; - - - constant_name - - - Name of constant to declare. Either a string to indicate a global constant, - or classname::constname to indicate a class constant. - - - - - value - - - NULL, Bool, Long, Double, String, Array, or Resource value to store in the new constant. - - - - - newVisibility - - - Visibility of the constant, for class constants. Public by default. - One of the RUNKIT7_ACC_* constants. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - define - runkit7_constant_redefine - runkit7_constant_remove - - - - - diff --git a/reference/runkit7/functions/runkit7-constant-redefine.xml b/reference/runkit7/functions/runkit7-constant-redefine.xml deleted file mode 100644 index 4a13862b1f89..000000000000 --- a/reference/runkit7/functions/runkit7-constant-redefine.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - runkit7_constant_redefine - Redefine an already defined constant - - - - &reftitle.description; - - boolrunkit7_constant_redefine - stringconstant_name - mixedvalue - intnew_visibility - - - - - - - - &reftitle.parameters; - - - constant_name - - - Constant to redefine. Either the name of a global constant, - or classname::constname indicating class constant. - - - - - value - - - Value to assign to the constant. - - - - - new_visibility - - - The new visibility of the constant, for class constants. - Unchanged by default. - One of the RUNKIT7_ACC_* constants. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - runkit7_constant_add - runkit7_constant_remove - - - - - - diff --git a/reference/runkit7/functions/runkit7-constant-remove.xml b/reference/runkit7/functions/runkit7-constant-remove.xml deleted file mode 100644 index f743ae0b7fbc..000000000000 --- a/reference/runkit7/functions/runkit7-constant-remove.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - runkit7_constant_remove - - Remove/Delete an already defined constant - - - - - &reftitle.description; - - boolrunkit7_constant_remove - stringconstant_name - - - - - &reftitle.parameters; - - - constant_name - - - Name of the constant to remove. Either the name of a global constant, - or classname::constname indicating a class constant. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - define - runkit7_constant_add - runkit7_constant_redefine - - - - - - diff --git a/reference/runkit7/functions/runkit7-function-add.xml b/reference/runkit7/functions/runkit7-function-add.xml deleted file mode 100644 index e5df6aa94f21..000000000000 --- a/reference/runkit7/functions/runkit7-function-add.xml +++ /dev/null @@ -1,165 +0,0 @@ - - - - - runkit7_function_add - - Add a new function, similar to create_function - - - - - &reftitle.description; - - boolrunkit7_function_add - stringfunction_name - stringargument_list - stringcode - boolreturn_by_reference&null; - stringdoc_comment&null; - stringreturn_type - boolis_strict - - - boolrunkit7_function_add - stringfunction_name - Closureclosure - stringdoc_comment&null; - stringreturn_type - boolis_strict - - - - - &reftitle.parameters; - - - function_name - - - Name of the function to be created - - - - - argument_list - - - Comma separated argument list - - - - - code - - - Code making up the function - - - - - closure - - - A closure that defines the function. - - - - - return_by_reference - - - Whether the function should return by reference. - - - - - doc_comment - - - The doc comment of the function. - - - - - return_type - - - The return type of the function. - - - - - is_strict - - - Whether the function should behave as if it were declared in a file with strict_types=1 - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - A <function>runkit7_function_add</function> example - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - create_function - runkit7_function_redefine - runkit7_function_copy - runkit7_function_rename - runkit7_function_remove - runkit7_method_add - - - - - - diff --git a/reference/runkit7/functions/runkit7-function-copy.xml b/reference/runkit7/functions/runkit7-function-copy.xml deleted file mode 100644 index 46b0fd0bb993..000000000000 --- a/reference/runkit7/functions/runkit7-function-copy.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - runkit7_function_copy - - Copy a function to a new function name - - - - - &reftitle.description; - - boolrunkit7_function_copy - stringsource_name - stringtarget_name - - - - - &reftitle.parameters; - - - source_name - - - Name of the existing function - - - - - target_name - - - Name of the new function to copy the definition to - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - &reftitle.examples; - - A <function>runkit7_function_copy</function> example - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - runkit7_function_add - runkit7_function_redefine - runkit7_function_rename - runkit7_function_remove - - - - - diff --git a/reference/runkit7/functions/runkit7-function-redefine.xml b/reference/runkit7/functions/runkit7-function-redefine.xml deleted file mode 100644 index 4969f757718a..000000000000 --- a/reference/runkit7/functions/runkit7-function-redefine.xml +++ /dev/null @@ -1,170 +0,0 @@ - - - - - runkit7_function_redefine - - Replace a function definition with a new implementation - - - - - &reftitle.description; - - boolrunkit7_function_redefine - stringfunction_name - stringargument_list - stringcode - boolreturn_by_reference&null; - stringdoc_comment&null; - stringreturn_type - boolis_strict - - - boolrunkit7_function_redefine - stringfunction_name - Closureclosure - stringdoc_comment&null; - stringreturn_type - boolis_strict - - - ¬e.runkit.internal-override; - - - - - &reftitle.parameters; - - - function_name - - - Name of function to redefine - - - - - argument_list - - - New list of arguments to be accepted by function - - - - - code - - - New code implementation - - - - - closure - - - A closure that defines the function. - - - - - return_by_reference - - - Whether the function should return by reference. - - - - - doc_comment - - - The doc comment of the function. - - - - - return_type - - - The return type of the function. - - - - - is_strict - - - Whether the function behaves as if it was declared in a file with strict_types=1 - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - A <function>runkit7_function_redefine</function> example - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - runkit7_function_add - runkit7_function_copy - runkit7_function_rename - runkit7_function_remove - runkit7_method_redefine - - - - - diff --git a/reference/runkit7/functions/runkit7-function-remove.xml b/reference/runkit7/functions/runkit7-function-remove.xml deleted file mode 100644 index dab175505e6a..000000000000 --- a/reference/runkit7/functions/runkit7-function-remove.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - runkit7_function_remove - - Remove a function definition - - - - - &reftitle.description; - - boolrunkit7_function_remove - stringfunction_name - - - ¬e.runkit.internal-override; - - - - - &reftitle.parameters; - - - function_name - - - Name of the function to be deleted - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - runkit7_function_add - runkit7_function_copy - runkit7_function_redefine - runkit7_function_rename - - - - - - diff --git a/reference/runkit7/functions/runkit7-function-rename.xml b/reference/runkit7/functions/runkit7-function-rename.xml deleted file mode 100644 index f25286456af2..000000000000 --- a/reference/runkit7/functions/runkit7-function-rename.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - runkit7_function_rename - - Change a function's name - - - - - &reftitle.description; - - boolrunkit7_function_rename - stringsource_name - stringtarget_name - - - ¬e.runkit.internal-override; - - - - - &reftitle.parameters; - - - source_name - - - Current function name - - - - - target_name - - - New function name - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - runkit7_function_add - runkit7_function_copy - runkit7_function_redefine - runkit7_function_remove - - - - - - diff --git a/reference/runkit7/functions/runkit7-import.xml b/reference/runkit7/functions/runkit7-import.xml deleted file mode 100644 index 363423784d8b..000000000000 --- a/reference/runkit7/functions/runkit7-import.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - runkit7_import - - Process a PHP file importing function and class definitions, overwriting where appropriate - - - - - - This feature has been removed in PECL runkit7 4.0.0. - - - - - &reftitle.description; - - boolrunkit7_import - stringfilename - intflags - - - Similar to include. However, any code residing outside - of a function or class is simply ignored. - Additionally, depending on the value of flags, - any functions or classes which already exist in the currently running environment - may be automatically overwritten by their new definitions. - - - - - &reftitle.parameters; - - - filename - - - Filename to import function and class definitions from - - - - - flags - - - Bitwise OR of the RUNKIT7_IMPORT_* - family of constants. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/runkit7/functions/runkit7-method-add.xml b/reference/runkit7/functions/runkit7-method-add.xml deleted file mode 100644 index 4dd2bf829755..000000000000 --- a/reference/runkit7/functions/runkit7-method-add.xml +++ /dev/null @@ -1,193 +0,0 @@ - - - - - runkit7_method_add - Dynamically adds a new method to a given class - - - - &reftitle.description; - - boolrunkit7_method_add - stringclass_name - stringmethod_name - stringargument_list - stringcode - intflagsRUNKIT7_ACC_PUBLIC - stringdoc_comment&null; - stringreturn_type - boolis_strict - - - boolrunkit7_method_add - stringclass_name - stringmethod_name - Closureclosure - intflagsRUNKIT7_ACC_PUBLIC - stringdoc_comment&null; - stringreturn_type - boolis_strict - - - - &reftitle.parameters; - - - class_name - - - The class to which this method will be added - - - - - method_name - - - The name of the method to add - - - - - argument_list - - - Comma-delimited list of arguments for the newly-created method - - - - - code - - - The code to be evaluated when method_name - is called - - - - - closure - - - A closure that defines the method. - - - - - flags - - - The type of method to create, can be - RUNKIT7_ACC_PUBLIC, - RUNKIT7_ACC_PROTECTED or - RUNKIT7_ACC_PRIVATE optionally combined via bitwise OR with - RUNKIT7_ACC_STATIC - - - - - doc_comment - - - The doc comment of the method. - - - - - return_type - - - The return type of the method. - - - - - - is_strict - - - Whether the method behaves as if it were declared in a file with strict_types=1 - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - &reftitle.examples; - - <function>runkit7_method_add</function> example - -add(12, 4); -?> -]]> - - &example.outputs; - - - - - - - &reftitle.seealso; - - runkit7_method_copy - runkit7_method_redefine - runkit7_method_remove - runkit7_method_rename - runkit7_function_add - - - - diff --git a/reference/runkit7/functions/runkit7-method-copy.xml b/reference/runkit7/functions/runkit7-method-copy.xml deleted file mode 100644 index 62c4cddac272..000000000000 --- a/reference/runkit7/functions/runkit7-method-copy.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - runkit7_method_copy - Copies a method from class to another - - - - &reftitle.description; - - boolrunkit7_method_copy - stringdestination_class - stringdestination_method_name - stringsource_class - stringsource_method_name - - - - - &reftitle.parameters; - - - destination_class - - - Destination class for copied method - - - - - destination_method_name - - - Destination method name - - - - - source_class - - - Source class of the method to copy - - - - - source_method_name - - - Name of the method to copy from the source class. If this parameter is - omitted, the value of destination_method_name is assumed. - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - <function>runkit7_method_copy</function> example - - -]]> - - &example.outputs; - - - - - - - &reftitle.seealso; - - runkit7_method_add - runkit7_method_redefine - runkit7_method_remove - runkit7_method_rename - runkit7_function_copy - - - - - diff --git a/reference/runkit7/functions/runkit7-method-redefine.xml b/reference/runkit7/functions/runkit7-method-redefine.xml deleted file mode 100644 index e8bbfce4b1bb..000000000000 --- a/reference/runkit7/functions/runkit7-method-redefine.xml +++ /dev/null @@ -1,197 +0,0 @@ - - - - - runkit7_method_redefine - Dynamically changes the code of the given method - - - - &reftitle.description; - - boolrunkit7_method_redefine - stringclass_name - stringmethod_name - stringargument_list - stringcode - intflagsRUNKIT7_ACC_PUBLIC - stringdoc_comment&null; - stringreturn_type - boolis_strict - - - boolrunkit7_method_redefine - stringclass_name - stringmethod_name - Closureclosure - intflagsRUNKIT7_ACC_PUBLIC - stringdoc_comment&null; - stringreturn_type - boolis_strict - - - - - &reftitle.parameters; - - - class_name - - - The class in which to redefine the method - - - - - method_name - - - The name of the method to redefine - - - - - argument_list - - - Comma-delimited list of arguments for the redefined method - - - - - code - - - The new code to be evaluated when method_name - is called - - - - - closure - - - A closure that defines the method. - - - - - flags - - - The redefined method can be - RUNKIT7_ACC_PUBLIC, - RUNKIT7_ACC_PROTECTED or - RUNKIT7_ACC_PRIVATE optionally combined via bitwise OR with - RUNKIT7_ACC_STATIC - - - - - doc_comment - - - The doc comment of the method. - - - - - return_type - - - The return type of the method. - - - - - is_strict - - - Whether the method behaves as if it was declared in a file with strict_types=1. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>runkit7_method_redefine</function> example - -foo(); - -// Redefine the 'foo' method -runkit7_method_redefine( - 'Example', - 'foo', - '', - 'return "bar!\n";', - RUNKIT7_ACC_PUBLIC -); - -// output Example::foo() (after redefine) -echo "After: " . $e->foo(); -?> -]]> - - &example.outputs; - - - - - - - &reftitle.seealso; - - runkit7_method_add - runkit7_method_copy - runkit7_method_remove - runkit7_method_rename - runkit7_function_redefine - - - - - diff --git a/reference/runkit7/functions/runkit7-method-remove.xml b/reference/runkit7/functions/runkit7-method-remove.xml deleted file mode 100644 index 0dfb8b03f8bf..000000000000 --- a/reference/runkit7/functions/runkit7-method-remove.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - runkit7_method_remove - Dynamically removes the given method - - - - &reftitle.description; - - boolrunkit7_method_remove - stringclass_name - stringmethod_name - - ¬e.runkit.selfmanipulation; - - - - &reftitle.parameters; - - - class_name - - - The class in which to remove the method - - - - - method_name - - - The name of the method to remove - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - <function>runkit7_method_remove</function> example - - -]]> - - &example.outputs; - - - - - - - &reftitle.seealso; - - runkit7_method_add - runkit7_method_copy - runkit7_method_redefine - runkit7_method_rename - runkit7_function_remove - - - - - - diff --git a/reference/runkit7/functions/runkit7-method-rename.xml b/reference/runkit7/functions/runkit7-method-rename.xml deleted file mode 100644 index d1cde58ae0ee..000000000000 --- a/reference/runkit7/functions/runkit7-method-rename.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - runkit7_method_rename - Dynamically changes the name of the given method - - - - &reftitle.description; - - boolrunkit7_method_rename - stringclass_name - stringsource_method_name - stringtarget_method_name - - ¬e.runkit.selfmanipulation; - - - - &reftitle.parameters; - - - class_name - - - The class in which to rename the method - - - - - source_method_name - - - The name of the method to rename - - - - - target_method_name - - - The new name to give to the renamed method - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - <function>runkit7_method_rename</function> example - -bar(); -?> -]]> - - &example.outputs; - - - - - - - &reftitle.seealso; - - runkit7_method_add - runkit7_method_copy - runkit7_method_redefine - runkit7_method_remove - runkit7_function_rename - - - - diff --git a/reference/runkit7/functions/runkit7-object-id.xml b/reference/runkit7/functions/runkit7-object-id.xml deleted file mode 100644 index 979ce50dc6fa..000000000000 --- a/reference/runkit7/functions/runkit7-object-id.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - runkit7_object_id - - Return the integer object handle for given object - - - - - &reftitle.description; - - intrunkit7_object_id - objectobj - - - This function is equivalent to spl_object_id. - - - This function returns a unique identifier for the object. The object id is - unique for the lifetime of the object. Once the object is destroyed, its id - may be reused for other objects. This behavior is similar to - spl_object_hash. - - - - - &reftitle.parameters; - - - obj - - - Any object. - - - - - - - - &reftitle.returnvalues; - - An integer identifier that is unique for each currently existing object and - is always the same for each object. - - - - - &reftitle.notes; - - - When an object is destroyed, its id may be reused for other objects. - - - - - &reftitle.seealso; - - spl_object_id - - - - diff --git a/reference/runkit7/functions/runkit7-superglobals.xml b/reference/runkit7/functions/runkit7-superglobals.xml deleted file mode 100644 index bd581a5a2e58..000000000000 --- a/reference/runkit7/functions/runkit7-superglobals.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - runkit7_superglobals - - Return numerically indexed array of registered superglobals - - - - - &reftitle.description; - - arrayrunkit7_superglobals - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a numerically indexed array of the currently registered superglobals. - i.e. _GET, _POST, _REQUEST, _COOKIE, _SESSION, _SERVER, _ENV, _FILES - - - - - &reftitle.seealso; - - Variable Scope - - - - - diff --git a/reference/runkit7/functions/runkit7-zval-inspect.xml b/reference/runkit7/functions/runkit7-zval-inspect.xml deleted file mode 100644 index aa5bb696fa3e..000000000000 --- a/reference/runkit7/functions/runkit7-zval-inspect.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - runkit7_zval_inspect - Returns information about the passed in value with data types, reference counts, etc - - - - &reftitle.description; - - arrayrunkit7_zval_inspect - stringvalue - - - - - &reftitle.parameters; - - - value - - - The value to return the representation of - - - - - - - - &reftitle.returnvalues; - - The array returned by this function contains the following elements: - - address - refcount (optional) - is_ref (optional) - type - - - - - - &reftitle.examples; - - <function>runkit7_zval_inspect</function> example - - -]]> - - &example.outputs; - - - string(14) "0x7f45ab21b1e0" - ["refcount"]=> - int(2) - ["is_ref"]=> - bool(false) - ["type"]=> - int(8) -} - -array(2) { - ["address"]=> - string(14) "0x7f45ab21b1e0" - ["type"]=> - int(4) -} -]]> - - - - - - &reftitle.seealso; - - References Explained - References Explained (by Derick Rethans) - - - - diff --git a/reference/runkit7/ini.xml b/reference/runkit7/ini.xml deleted file mode 100644 index c22358cb98bf..000000000000 --- a/reference/runkit7/ini.xml +++ /dev/null @@ -1,108 +0,0 @@ - - -
    - &reftitle.runtime; - &extension.runtime; - - - Runkit Configuration Options - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - runkit.superglobal - "" - INI_PERDIR - - - - runkit.internal_override - "0" - INI_SYSTEM - - - - -
    - &ini.php.constants; -
    - - &ini.descriptions.title; - - - - - runkit.superglobal - string - - - - Comma-separated list of variable names to be treated as superglobals. - This value should be set in the systemwide php.ini file, but may work - in perdir configuration contexts depending on your SAPI. - - - Custom Superglobals with runkit.superglobal=_FOO,_BAR in php.ini - - -]]> - - - - - - - - runkit.internal_override - bool - - - - Enables ability to modify/rename/remove internal functions. - - - - - -
    - diff --git a/reference/runkit7/reference.xml b/reference/runkit7/reference.xml deleted file mode 100644 index cf9c69f04814..000000000000 --- a/reference/runkit7/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - runkit7 &Functions; - - &reference.runkit7.entities.functions; - - - - diff --git a/reference/runkit7/setup.xml b/reference/runkit7/setup.xml deleted file mode 100644 index 3ecef8b9d023..000000000000 --- a/reference/runkit7/setup.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - &reftitle.setup; - -
    - &reftitle.required; - - Modifying Constants, Functions, Classes, and Methods - as well as Custom Superglobals - works with all releases of PHP 7. No special requirements are - necessary. - -
    - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;runkit7. - - - &pecl.windows.download.avail; - -
    - - &reference.runkit7.ini; - -
    - diff --git a/reference/runkit7/versions.xml b/reference/runkit7/versions.xml deleted file mode 100644 index 6a56e5199cae..000000000000 --- a/reference/runkit7/versions.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/scoutapm/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/scoutapm/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/scoutapm/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/scoutapm/book.xml b/reference/scoutapm/book.xml deleted file mode 100644 index 48914cbad050..000000000000 --- a/reference/scoutapm/book.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - - - ScoutAPM - ScoutAPM - - - &reftitle.intro; - ¬e.no-windows.extension; - - ScoutAPM's extension for PHP provides additional capabilities to application - monitoring over just using the base PHP userland library. - - - - &reference.scoutapm.setup; - &reference.scoutapm.reference; - - - diff --git a/reference/scoutapm/configure.xml b/reference/scoutapm/configure.xml deleted file mode 100644 index 117c9d1d803f..000000000000 --- a/reference/scoutapm/configure.xml +++ /dev/null @@ -1,32 +0,0 @@ - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;scoutapm - - - -
    - diff --git a/reference/scoutapm/functions/scoutapm-get-calls.xml b/reference/scoutapm/functions/scoutapm-get-calls.xml deleted file mode 100644 index c4c5febb343e..000000000000 --- a/reference/scoutapm/functions/scoutapm-get-calls.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - scoutapm_get_calls - Returns a list of instrumented calls that have occurred - - - - &reftitle.description; - - arrayscoutapm_get_calls - - - Returns a list of any instrumented function calls since scoutapm_get_calls was last called. The list is cleared each time the function is called. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - scoutapm_get_calls returns an array containing a list - of all recorded calls to instrumented function calls. - - - - - &reftitle.examples; - Fetch instrumented calls - - -]]> - - &example.outputs.similar; - - Array - ( - [function] => file_get_contents - [entered] => 1576839727.7934 - [exited] => 1576839727.7935 - [time_taken] => 2.7894973754883E-5 - [argv] => Array - ( - [0] => a.txt - ) - - ) - - [1] => Array - ( - [function] => file_get_contents - [entered] => 1576839727.7935 - [exited] => 1576839727.7935 - [time_taken] => 7.8678131103516E-6 - [argv] => Array - ( - [0] => b.txt - ) - - ) - -) -]]> - - - - - - - diff --git a/reference/scoutapm/functions/scoutapm-list-instrumented-functions.xml b/reference/scoutapm/functions/scoutapm-list-instrumented-functions.xml deleted file mode 100644 index 6d1bfc68758b..000000000000 --- a/reference/scoutapm/functions/scoutapm-list-instrumented-functions.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - scoutapm_list_instrumented_functions - List functions scoutapm will instrument. - - - - &reftitle.description; - - arrayscoutapm_list_instrumented_functions - - - Returns a list of the functions the extension will instrument. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - scoutapm_list_instrumented_functions returns an array - containing a list of all functions that the scoutapm extension is able to - instrument in the current installation. - - - - - &reftitle.examples; - Fetch the list of functions scoutapm will instrument - - -]]> - - &example.outputs.similar; - - file_get_contents - [1] => file_put_contents - [2] => fopen - [3] => fread - [4] => fwrite - [5] => pdo->exec - [6] => pdo->query - [7] => pdo->prepare - [8] => pdostatement->execute -) -]]> - - - - - - - diff --git a/reference/scoutapm/reference.xml b/reference/scoutapm/reference.xml deleted file mode 100644 index 7042d566b30a..000000000000 --- a/reference/scoutapm/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - Scoutapm &Functions; - - &reference.scoutapm.entities.functions; - - - - diff --git a/reference/scoutapm/setup.xml b/reference/scoutapm/setup.xml deleted file mode 100644 index b9df23f224b5..000000000000 --- a/reference/scoutapm/setup.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - &reftitle.setup; - -
    - &reftitle.required; - - - PHP >= 7.1.0 - - - Windows is not currently supported - - -
    - -
    - &reftitle.install; - - This extension is available on PECL. Run: - - - - You may need to add Scout to your php.ini, for example: - - - - -
    - -
    - diff --git a/reference/scoutapm/versions.xml b/reference/scoutapm/versions.xml deleted file mode 100644 index 8941641eec7d..000000000000 --- a/reference/scoutapm/versions.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - - - - - - diff --git a/reference/seaslog/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/seaslog/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/seaslog/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/seaslog/book.xml b/reference/seaslog/book.xml deleted file mode 100644 index 66f77d0a764b..000000000000 --- a/reference/seaslog/book.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - Seaslog - Seaslog - - - &reftitle.intro; - - The Seaslog is an effective,fast,stable log extension for PHP. - - - The log journal,which is usually the operate record of the system, - software and the application record. - Through the analysis of the log,it can facilitate users to understand the operation of the system, - software and the application situation. - If your application log is rich enough, - it can also analyze the previous use’s operation behavior,type, - regional distribution or other more information. - The application log also points the multiple levels at the same time, - you can easily get the application analysis of health status, - timely find problems and quick positioning, and solve the problem, remedy the loss. - - - The error_log, syslog function which built in PHP is powerful and excellent performance, - but due to various defects (error_log have no error level, no fixed format, syslog regardless of module, - and mix with system log ), reducing a lot of flexibility , and can't meet the application requirements. - - - The good news is that there are a number of third-party log class library established - to make up for the defects, such as log4php, plog, monolog (of course, - there are many applications in the project development of the log class). - - - So is there a log of libraries meet the following requirements: - - Modules, classification - Simple configuration (preferably without configuration) - Clear log format and easy understanding - Simple application and well performance - - Seaslog just meet these demands. - - - What is provided at present: - - In the PHP project, record the log specification and repidly. - Configure the default log directory and module - Specified log directory and capture current configuration - Preliminary analysis of the early warning framework - Efficient log buffer and convenient buffer debug - Follow the PSR-3 log interface specification - Automatically record error information - Automatically record abnormal information - Support Connect the TCP port, send with RFC5424 - Support Connect the UDP port, send with RFC5424 - Support RequestId differentiated requests - Support for log template customizations - - - - Read More SeasLog Document at Github. - - - - &reference.seaslog.setup; - &reference.seaslog.constants; - &reference.seaslog.examples; - &reference.seaslog.reference; - &reference.seaslog.seaslog; - - - diff --git a/reference/seaslog/configure.xml b/reference/seaslog/configure.xml deleted file mode 100644 index f7b4ce23c8d9..000000000000 --- a/reference/seaslog/configure.xml +++ /dev/null @@ -1,32 +0,0 @@ - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;seaslog - - - -
    - diff --git a/reference/seaslog/constants.xml b/reference/seaslog/constants.xml deleted file mode 100644 index 95d8e78d9c38..000000000000 --- a/reference/seaslog/constants.xml +++ /dev/null @@ -1,268 +0,0 @@ - - - - &reftitle.constants; - &extension.constants; - - - - SEASLOG_VERSION - (string) - - - - - - - - - SEASLOG_AUTHOR - (string) - - - - - - - - - SEASLOG_ALL - (string) - - - - "ALL" - - - - - - SEASLOG_DEBUG - (string) - - - - "DEBUG" - Detailed debug information.Fine-grained information events. - - - - - - SEASLOG_INFO - (string) - - - - "INFO" - Interesting events.Emphasizes the running process of the application. - - - - - - SEASLOG_NOTICE - (string) - - - - "NOTICE" - Normal but significant events.Information that is more important than the INFO level during execution. - - - - - - SEASLOG_WARNING - (string) - - - - "WARNING" - Exceptional occurrences that are not errors.Potentially aberrant information that needs attention and needs to be repaired. - - - - - - SEASLOG_ERROR - (string) - - - - "ERROR" - Runtime errors that do not require immediate action but should typically. - - - - - - SEASLOG_CRITICAL - (string) - - - - "CRITICAL" - Critical conditions.Need to be repaired immediately, and the program component is unavailable. - - - - - - SEASLOG_ALERT - (string) - - - - "ALERT" - Action must be taken immediately.Immediate attention should be given to relevant personnel for emergency repairs. - - - - - - SEASLOG_EMERGENCY - (string) - - - - "EMERGENCY" - System is unusable. - - - - - - SEASLOG_DETAIL_ORDER_ASC - (int) - - - - 1 - - - - - - SEASLOG_DETAIL_ORDER_DESC - (int) - - - - 2 - - - - - - SEASLOG_APPENDER_FILE - (int) - - - - 1 - - - - - - SEASLOG_APPENDER_TCP - (int) - - - - 2 - - - - - - SEASLOG_APPENDER_UDP - (int) - - - - 3 - - - - - - SEASLOG_CLOSE_LOGGER_STREAM_MOD_ALL - (int) - - - - 1 - - - - - - SEASLOG_CLOSE_LOGGER_STREAM_MOD_ASSIGN - (int) - - - - 2 - - - - - - SEASLOG_REQUEST_VARIABLE_DOMAIN_PORT - (int) - - - - 1 - - - - - - SEASLOG_REQUEST_VARIABLE_REQUEST_URI - (int) - - - - 2 - - - - - - SEASLOG_REQUEST_VARIABLE_REQUEST_METHOD - (int) - - - - 3 - - - - - - SEASLOG_REQUEST_VARIABLE_CLIENT_IP - (int) - - - - 4 - - - - - - diff --git a/reference/seaslog/examples.xml b/reference/seaslog/examples.xml deleted file mode 100644 index 46907abbdabc..000000000000 --- a/reference/seaslog/examples.xml +++ /dev/null @@ -1,212 +0,0 @@ - - - - &reftitle.examples; - - - Get and set base path - - -]]> - - &example.outputs.similar; - - - - - - - Get and set logger - - -]]> - - &example.outputs.similar; - - - - - - - Fast write log - - 'neeke')); -SeasLog::info('this is a info log'); -SeasLog::notice('this is a notice log'); -SeasLog::warning('your {website} was down,please {action} it ASAP!',array('{website}' => 'github.com','{action}' => 'rboot')); -SeasLog::error('a error log'); -SeasLog::critical('some thing was critical'); -SeasLog::alert('yes this is a {messageName}',array('{messageName}' => 'alertMSG')); -SeasLog::emergency('Just now, the house next door was completely burnt out! {note}',array('{note}' => 'it`s a joke')); -?> -]]> - - - As the default, seaslog.default_template = "%T | %L | %P | %Q | %t | %M". - That's mean,as the default,log record style is: `{dateTime} | {level} | {pid} | {uniqid} | {timeStamp} | {logInfo}`. - - &example.outputs.similar; - - seaslog.appender = 1 - - - - - &example.outputs.similar; - - seaslog.appender = 2 or seaslog.appender = 3 - - -1 2017-08-27T01:24:59+08:00 vagrant-ubuntu-trusty test/logger[27171]: 2016-06-25 00:59:43 | DEBUG | 21423 | 599157af4e937 | 1466787583.322 | this is a neeke debug -<14>1 2017-08-27T01:24:59+08:00 vagrant-ubuntu-trusty test/logger[27171]: 2016-06-25 00:59:43 | INFO | 21423 | 599157af4e937 | 1466787583.323 | this is a info log -<13>1 2017-08-27T01:24:59+08:00 vagrant-ubuntu-trusty test/logger[27171]: 2016-06-25 00:59:43 | NOTICE | 21423 | 599157af4e937 | 1466787583.324 | this is a notice log -]]> - - - - - Fast count some type of log count value - - SeasLog get count value of `grep -wc` use system pipe and return to PHP (array or int). - - - -]]> - - &example.outputs.similar; - - - int(3) - ["INFO"]=> - int(3) - ["NOTICE"]=> - int(3) - ["WARNING"]=> - int(3) - ["ERROR"]=> - int(6) - ["CRITICAL"]=> - int(3) - ["ALERT"]=> - int(3) - ["EMERGENCY"]=> - int(3) -} -int(7) -int(1) -]]> - - - - - Acquisit some type of log list - - SeasLog get count value of `grep -w` use system pipe and return array to PHP. - - - -]]> - - &example.outputs.similar; - - - string(83) "2014-02-24 00:14:02 | ERROR | 8568 | 599157af4e937 | 1393172042.717 | test error 3 " - [1] => - string(83) "2014-02-24 00:14:04 | ERROR | 8594 | 5991576584446 | 1393172044.104 | test error 3 " - [2] => - string(83) "2014-02-24 00:14:04 | ERROR | 8620 | 1502697015147 | 1393172044.862 | test error 3 " - [3] => - string(83) "2014-02-24 00:14:05 | ERROR | 8646 | 599159975a9ff | 1393172045.989 | test error 3 " - [4] => - string(83) "2014-02-24 00:14:07 | ERROR | 8672 | 599159986ec28 | 1393172047.882 | test error 3 " - [5] => - string(83) "2014-02-24 00:14:08 | ERROR | 8698 | 5991599981cec | 1393172048.736 | test error 3 " -} - -array(2) { - [0] => - string(83) "2014-02-24 00:14:02 | ERROR | 8568 | 599157af4e937 | 1393172042.717 | test error 3 " - [1] => - string(83) "2014-02-24 00:14:04 | ERROR | 8594 | 5991576584446 | 1393172044.104 | test error 3 " -} -]]> - - - - - diff --git a/reference/seaslog/functions/seaslog-get-author.xml b/reference/seaslog/functions/seaslog-get-author.xml deleted file mode 100644 index 0485117cd778..000000000000 --- a/reference/seaslog/functions/seaslog-get-author.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - seaslog_get_author - Get SeasLog author. - - - - &reftitle.description; - - stringseaslog_get_author - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Return SeasLog author as string. - - - - - &reftitle.examples; - - <function>seaslog_get_author</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/seaslog/functions/seaslog-get-version.xml b/reference/seaslog/functions/seaslog-get-version.xml deleted file mode 100644 index 18e51f3adfbf..000000000000 --- a/reference/seaslog/functions/seaslog-get-version.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - seaslog_get_version - Get SeasLog version. - - - - &reftitle.description; - - stringseaslog_get_version - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Return SeasLog version (SEASLOG_VERSION) as string. - - - - - &reftitle.examples; - - <function>seaslog_get_version</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/seaslog/ini.xml b/reference/seaslog/ini.xml deleted file mode 100644 index cb94b2832a68..000000000000 --- a/reference/seaslog/ini.xml +++ /dev/null @@ -1,628 +0,0 @@ - - -
    - &reftitle.runtime; - &extension.runtime; - - Seaslog &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - seaslog.appender - 1 - INI_SYSTEM - - - - seaslog.appender_retry - 0 - INI_ALL - - - - seaslog.level - 8 - INI_ALL - - - - seaslog.remote_host - 127.0.0.1 - INI_ALL - - - - seaslog.remote_port - 514 - INI_ALL - - - - seaslog.remote_timeout - 1 - INI_SYSTEM - - - - seaslog.default_basepath - /var/log/www - INI_SYSTEM - - - - seaslog.default_logger - default - INI_SYSTEM - - - - seaslog.default_template - %T | %L | %P | %Q | %t | %M - INI_SYSTEM - - - - seaslog.default_datetime_format - Y-m-d H:i:s - INI_SYSTEM - - - - seaslog.trace_error - 1 - INI_ALL - - - - seaslog.trace_exception - 0 - INI_SYSTEM - - - - seaslog.trace_notice - 0 - INI_ALL - - - - seaslog.trace_warning - 0 - INI_ALL - - - - seaslog.use_buffer - 0 - INI_SYSTEM - - - - seaslog.buffer_size - 0 - INI_ALL - - - - seaslog.buffer_disabled_in_cli - 0 - INI_SYSTEM - - - - seaslog.disting_type - 0 - INI_SYSTEM - - - - seaslog.disting_folder - 1 - INI_SYSTEM - - - - seaslog.disting_by_hour - 0 - INI_SYSTEM - - - - seaslog.recall_depth - 0 - INI_ALL - - - - seaslog.trim_wrap - 0 - INI_ALL - - - - seaslog.ignore_warning - 1 - INI_ALL - - - - seaslog.throw_exception - 1 - INI_ALL - - - - -
    - - &ini.descriptions.title; - - - - - seaslog.appender - int - - - - Switch the Record Log Data Store. 1File 2TCP 3UDP (Switch default 1) - - - SeasLog will send log to tcp://remote_host:remote_port or udp://remote_host:remote_port server, - when seaslog.appender configured to 2 (TCP) or 3 (UDP). - - - When SeasLog send log to TCP/UDP,style follow RFC5424. - The {logInfo} affected by seaslog.default_template. - - - 1 2017-08-27T01:24:59+08:00 vagrant-ubuntu-trusty test/logger[27171]: 2016-06-25 00:59:43 | DEBUG | 21423 | 599157af4e937 | 1466787583.322 | this is a neeke debug -<14>1 2017-08-27T01:24:59+08:00 vagrant-ubuntu-trusty test/logger[27171]: 2016-06-25 00:59:43 | INFO | 21423 | 599157af4e937 | 1466787583.323 | this is a info log -<13>1 2017-08-27T01:24:59+08:00 vagrant-ubuntu-trusty test/logger[27171]: 2016-06-25 00:59:43 | NOTICE | 21423 | 599157af4e937 | 1466787583.324 | this is a notice log - ]]> - - - - - - seaslog.appender_retry - int - - - - Record Log Retry Count. - Default 0 (Do Not Retry) - - - - - - seaslog.buffer_disabled_in_cli - int - - - - Disable buffer in cli. 1-Y 0-N(Default) - - - Switch the configure buffer_disabled_in_cli on. - The buffer_disabled_in_cli switch default off. - If switch buffer_disabled_in_cli on, and running in cli, - seaslog.use_buffer setting will be discarded, - Seaslog write to the Data Store IMMEDIATELY. - - - - - - seaslog.buffer_size - int - - - - Configure the buffer_size with 100. - The buffer_size default 0, it’s meaning don’t use buffer. - If buffer_size > 0,SeasLog will rewritten down into the Data Store - when the prerecorded log in memory count >= this buffer_size,and then refresh the memory poll. - - - - - - seaslog.default_basepath - string - - - - Default Log Base Path. Defult "/var/log/www". - - - - - - seaslog.default_datetime_format - string - - - - The DateTime Style. Default "Y-m-d H:i:s". - - - - - - seaslog.default_logger - string - - - - Default Logger Path. Default "default". - - - - - - seaslog.disting_by_hour - int - - - - Switch use the logger with hour. 1-Y 0-N(Default) - - - - seaslog.disting_by_hour = 1 Switch use Logger DisTing by hour. - It’s meaning SeasLog will create the file each one hour. - - - - - - - seaslog.disting_folder - int - - - - Switch use the logger with folder. 1-Y(Default) 0-N - - - - seaslog.disting_folder = 1 Switch use Logger DisTing by folder, - it’s meaning SeasLog will create the file deistic by folder, - and when this configure close SeasLog will create file - use underline connect Logger and Time like default_20180211.log. - - - - - - - seaslog.disting_type - int - - - - Switch use the logger with type. 1-Y 0-N(Default) - - - - seaslog.disting_type = 1 Switch use Logger DisTing by type, - it’s meaning SeasLog will create the file deistic info\warn\error and the other type. - - - - - - - seaslog.ignore_warning - int - - - - Switch ignore SeasLog warning. 1-On(Default) 0-Off - - - - seaslog.ignore_warning = 1 Open a warning to ignore SeasLog itself. - When directory permissions or receive server ports are blocked, they are ignored; - when closed, a warning is thrown. - - - - - - - seaslog.level - int - - - - Record logger level. Default 8 (All of them). - 0-EMERGENCY 1-ALERT 2-CRITICAL 3-ERROR 4-WARNING 5-NOTICE 6-INFO 7-DEBUG 8-ALL - - - - Tips: The configuration item has changed since the 1.7.0 version. - Before the 1.7.0 version, the smaller the value, the more logs are taken according to the level: - 0-all 1-debug 2-info 3-notice 4-warning 5-error 6-critical 7-alert 8-emergency - Before the 1.7.0 version, Default 0 (All of them). - - - - - - - seaslog.recall_depth - int - - - - Log function recall depth.Will affected variable LineNo in %F. - Default 0 - - - - - - seaslog.remote_host - string - - - - If you use Record TCP or UDP, configure this remote ip. Default "127.0.0.1" - - - - - - seaslog.remote_port - int - - - - If you use Record TCP or UDP, configure this remote port. Default 514 - - - - - - seaslog.remote_timeout - int - - - - If you use Record TCP or UDP, configure this remote timeout. Default 1 second - - - - - - seaslog.throw_exception - int - - - - Switch throw SeasLog exception. 1-On(Default) 0-Off - - - - seaslog.throw_exception = 1 Open an exception that throws the SeasLog to throw itself. - When the directory authority or the receive server port is blocked, - throw an exception; do not throw an exception when closed. - - - - - - - seaslog.trace_error - int - - - - Automatic Record final error with default logger. 1-Y(Default) 0-N - - - - - - seaslog.trace_exception - int - - - - Automatic Record exception with default logger. 1-Y 0-N(Default) - - - - - - seaslog.trace_notice - int - - - - Automatic Record notice with default logger. 1-Y 0-N(Default) - - - - - - seaslog.trace_warning - int - - - - Automatic Record warning with default logger. 1-Y 0-N(Default) - - - - - - seaslog.trim_wrap - int - - - - Trim the \n and \r in log message. 1-On 0-Off(Default) - - - - - - seaslog.use_buffer - int - - - - Switch use the log buffer with memory. 1-Y 0-N(Default) - - - - seaslog.use_buffer = 1 Switch the configure use_buffer on. - The use_buffer switch default off. - If switch use_buffer on, SeasLog prerecord the log with memory, - and them would be rewritten down into the Data Store by request shutdown - or php process exit (PHP RSHUTDOWN or PHP MSHUTDOWN). - - - - - - - seaslog.default_template - string - - - - Default Log template. - Default "%T | %L | %P | %Q | %t | %M". - - - - The following default variables are provided, - which can be used directly in the log template and replaced as a corresponding value - when the log is eventually generated. - - - Default log template is: seaslog.default_template = "%T | %L | %P | %Q | %t | %M", - that's mean,default log style is: {dateTime} | {level} | {pid} | {uniqid} | {timeStamp} | {logInfo} - - - If you custom log template, such as: seaslog.default_template = "[%T]:%L %P %Q %t %M", - that's will mean,log style was custom as: [{dateTime}]:{level} {pid} {uniqid} {timeStamp} {logInfo} - - - Seaslog Default Variable Table - - - - Variable Name - Description - - - - - %L - Level. - - - %M - Message. - - - %T - DateTime. Such as 2017-08-16 19:15:02, affected by seaslog.default_datetime_format. - - - %t - Timestamp. Such as 1502882102.862,accurate to milliseconds. - - - %Q - RequestId. To distinguish a single request, - such as not invoking the SeasLog::setRequestId($string) function, - the unique value generated by the built-in static char *get_uniqid () - function is used when the request is initialized. - - - %H - HostName. - - - %P - ProcessId. - - - %D - Domain:Port. Such as www.cloudwise.com:80; When Cli, Such as cli. - - - %R - Request URI. Such as /app/user/signin; - When Cli it's the index script, Such as CliIndex.php. - - - %m - Request Method. Such as Get; When Cli it's the command script, Such as /bin/bash. - - - %I - Client IP; When Cli it's local. - Priority value: HTTP_X_REAL_IP > HTTP_X_FORWARDED_FOR > REMOTE_ADDR - - - %F - FileName:LineNo. Such as UserService.php:118. - - - %U - MemoryUsage. byte. Call zend_memory_usage. - - - %u - PeakMemoryUsage. byte. Call zend_memory_peak_usage. - - - %C - TODO Class::Action. Such as UserService::getUserInfo - - - -
    -
    -
    -
    -
    -
    - diff --git a/reference/seaslog/reference.xml b/reference/seaslog/reference.xml deleted file mode 100644 index e95a5412621c..000000000000 --- a/reference/seaslog/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - Seaslog &Functions; - - &reference.seaslog.entities.functions; - - - - diff --git a/reference/seaslog/seaslog.xml b/reference/seaslog/seaslog.xml deleted file mode 100644 index c91a1185a03e..000000000000 --- a/reference/seaslog/seaslog.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - The SeasLog class - SeasLog - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - SeasLog - - - - - SeasLog - - - - - &Methods; - - - - -
    - -
    - - &reference.seaslog.entities.seaslog; - -
    - diff --git a/reference/seaslog/seaslog/alert.xml b/reference/seaslog/seaslog/alert.xml deleted file mode 100644 index 7f33abc54a0b..000000000000 --- a/reference/seaslog/seaslog/alert.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - - SeasLog::alert - Record alert log information - - - - &reftitle.description; - - public static boolSeasLog::alert - stringmessage - arraycontent - stringlogger - - - Record alert log information. - - - "ALERT" - Action must be taken immediately. - Immediate attention should be given to relevant personnel for emergency repairs. - - - - - - - - &reftitle.parameters; - - - message - - - The log message. - - - - - content - - - The `message` contain placeholders which implementors replace with values from content array. - Sush as `message` is `log info from {NAME}` and `content` is `array('NAME' => neeke)`, - the log information will `log info from neeke`. - - - - - logger - - - The `logger` cased by the third param would be used right this right now, - like a temp logger, when the function SeasLog::setLogger() called in pre content. - If `logger` NULL or "", SeasLog will use lastest logger setted by SeasLog::setLogger. - - - - - - - - &reftitle.returnvalues; - - Return TRUE on record log information success, FALSE on failure. - - - - - &reftitle.examples; - - <function>SeasLog::alert</function> example - - 'neeke'))); - -//with tmp logger -var_dump(SeasLog::alert('log message from {NAME}',array('NAME' => 'neeke'),'tmp_logger')); - -var_dump(SeasLog::getBuffer()); - -?> -]]> - - &example.outputs.similar; - - - array(2) { - [0]=> - string(81) "2018-07-07 11:45:49 | ALERT | 73263 | 5b40376d1067c | 1530935149.68 | log message -" - [1]=> - string(92) "2018-07-07 11:45:49 | ALERT | 73263 | 5b40376d1067c | 1530935149.68 | log message from neeke -" - } - ["/var/log/www/tmp_logger/20180707.log"]=> - array(1) { - [0]=> - string(92) "2018-07-07 11:45:49 | ALERT | 73263 | 5b40376d1067c | 1530935149.68 | log message from neeke -" - } -} -]]> - - - - - - &reftitle.seealso; - - seaslog.default_template - SeasLog::debug - SeasLog::info - SeasLog::notice - SeasLog::warning - SeasLog::error - SeasLog::critical - SeasLog::emergency - SeasLog::log - - - - - - diff --git a/reference/seaslog/seaslog/analyzercount.xml b/reference/seaslog/seaslog/analyzercount.xml deleted file mode 100644 index 8168dbdfc6d2..000000000000 --- a/reference/seaslog/seaslog/analyzercount.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - SeasLog::analyzerCount - Get log count by level, log_path and key_word - - - - &reftitle.description; - - public static mixedSeasLog::analyzerCount - stringlevel - stringlog_path - stringkey_word - - - `SeasLog` get count value of `grep -ai '{level}' | grep -aic '{key_word}'` - use system pipe and return to PHP (array or int). - - - - - - &reftitle.parameters; - - - level - - - String. The log information level. - - - - - log_path - - - String. The log information path. - - - - - key_word - - - String. The search key word for log information. - - - - - - - - &reftitle.returnvalues; - - If `level` is SEASLOG_ALL or Empty, return all levels count as `array`. - If `level` is SEASLOG_INFO or the other level, return count as `int`. - - - - - &reftitle.examples; - - <function>SeasLog::analyzerCount</function> example - - -]]> - - &example.outputs.similar; - - - int(180) - ["INFO"]=> - int(214) - ["NOTICE"]=> - int(0) - ["WARNING"]=> - int(0) - ["ERROR"]=> - int(228) - ["CRITICAL"]=> - int(244) - ["ALERT"]=> - int(1) - ["EMERGENCY"]=> - int(0) -} - -int(180) - -int(228) - -int(29) -]]> - - - - - - &reftitle.seealso; - - SeasLog::analyzerDetail - - - - - diff --git a/reference/seaslog/seaslog/analyzerdetail.xml b/reference/seaslog/seaslog/analyzerdetail.xml deleted file mode 100644 index b09dd856b4c8..000000000000 --- a/reference/seaslog/seaslog/analyzerdetail.xml +++ /dev/null @@ -1,183 +0,0 @@ - - - - - SeasLog::analyzerDetail - Get log detail by level, log_path, key_word, start, limit, order - - - - &reftitle.description; - - public static mixedSeasLog::analyzerDetail - stringlevel - stringlog_path - stringkey_word - intstart - intlimit - intorder - - - `SeasLog` get results of - `grep -ai '{level}' | grep -ai '{key_word}' | sed -n '{start},{limit}'p` - use system pipe and return array to PHP. - - - - - - &reftitle.parameters; - - - level - - - String. The log information level. - - - - - log_path - - - String. The log information path. - - - - - key_word - - - String. The search key word for log information. - - - - - start - - - Int. Default is `1`. - - - - - limit - - - Int. Default is `20`. - - - - - order - - - Int. Default is SEASLOG_DETAIL_ORDER_ASC. - See also: - - SEASLOG_DETAIL_ORDER_ASC - SEASLOG_DETAIL_ORDER_DESC - - - - - - - - - &reftitle.returnvalues; - - Return results as array. - - - When `start`,`limit` is not NULL and in Windows, - SeasLog will threw exception with message 'Param start and limit don't support Windows'. - - - - - - - &reftitle.examples; - - <function>SeasLog::analyzerDetail</function> example - - -]]> - - &example.outputs.similar; - - - string(93) "2018-07-09 12:52:53 | ERROR | 12247 | 5b42ea2580e51 | 1531111973.528 | log message from neeke" - [1]=> - string(93) "2018-07-09 12:52:54 | ERROR | 12256 | 5b42ea26d6657 | 1531111974.878 | log message from neeke" - [2]=> - string(93) "2018-07-09 12:52:55 | ERROR | 12265 | 5b42ea277b8d4 | 1531111975.506 | log message from neeke" - [3]=> - string(104) "2018-07-09 12:52:55 | ERROR | 12274 | 5b42ea27db5dc | 1531111975.898 | log message from the other people" -... -} - -array(3) { - [0]=> - string(93) "2018-07-09 12:52:53 | ERROR | 12247 | 5b42ea2580e51 | 1531111973.528 | log message from neeke" - [1]=> - string(93) "2018-07-09 12:52:54 | ERROR | 12256 | 5b42ea26d6657 | 1531111974.878 | log message from neeke" - [2]=> - string(93) "2018-07-09 12:52:55 | ERROR | 12265 | 5b42ea277b8d4 | 1531111975.506 | log message from neeke" -} - -array(2) { - [0]=> - string(93) "2018-07-09 12:52:53 | ERROR | 12247 | 5b42ea2580e51 | 1531111973.528 | log message from neeke" - [1]=> - string(93) "2018-07-09 12:52:54 | ERROR | 12256 | 5b42ea26d6657 | 1531111974.878 | log message from neeke" -} -]]> - - - - - - &reftitle.seealso; - - SeasLog::analyzerCount - - - - - - diff --git a/reference/seaslog/seaslog/closeloggerstream.xml b/reference/seaslog/seaslog/closeloggerstream.xml deleted file mode 100644 index 8adefbbcde10..000000000000 --- a/reference/seaslog/seaslog/closeloggerstream.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - SeasLog::closeLoggerStream - Manually release stream flow from logger - - - - &reftitle.description; - - public static boolSeasLog::closeLoggerStream - intmodel - stringlogger - - - Manually release stream flow from logger. - SeasLog caches the stream handle opened by the log logger to save the overhead of creating a stream. The handle will be automatically released at the end of the request. - If in CLI mode, the process will also automatically release when it exits. Or you can use the following functions to manually release(manually release function needs to update SeasLog 1.8.6 or updated version). - - - - - - &reftitle.parameters; - - - model - - - Constant int. - - SEASLOG_CLOSE_LOGGER_STREAM_MOD_ALL - SEASLOG_CLOSE_LOGGER_STREAM_MOD_ASSIGN - - - - - - logger - - - The logger name. - - - - - - - - &reftitle.returnvalues; - - Return TRUE on released stream flow success, FALSE on failure. - - - - - &reftitle.examples; - - <methodname>SeasLog::closeLoggerStream</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SeasLog::setLogger - SeasLog::getLastLogger - - - - - diff --git a/reference/seaslog/seaslog/construct.xml b/reference/seaslog/seaslog/construct.xml deleted file mode 100644 index 09514e369c73..000000000000 --- a/reference/seaslog/seaslog/construct.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - SeasLog::__construct - Description - - - - &reftitle.description; - - public SeasLog::__construct - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - - &reftitle.examples; - - <function>SeasLog::__construct</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/seaslog/seaslog/critical.xml b/reference/seaslog/seaslog/critical.xml deleted file mode 100644 index 329c20010a4c..000000000000 --- a/reference/seaslog/seaslog/critical.xml +++ /dev/null @@ -1,153 +0,0 @@ - - - - - SeasLog::critical - Record critical log information - - - - &reftitle.description; - - public static boolSeasLog::critical - stringmessage - arraycontent - stringlogger - - - Record critical log information. - - - "CRITICAL" - Critical conditions.Need to be repaired immediately, and the program component is unavailable. - - - - - - - - &reftitle.parameters; - - - message - - - The log message. - - - - - content - - - The `message` contain placeholders which implementors replace with values from content array. - Sush as `message` is `log info from {NAME}` and `content` is `array('NAME' => neeke)`, - the log information will `log info from neeke`. - - - - - logger - - - The `logger` cased by the third param would be used right this right now, - like a temp logger, when the function SeasLog::setLogger() called in pre content. - If `logger` NULL or "", SeasLog will use lastest logger setted by SeasLog::setLogger. - - - - - - - - &reftitle.returnvalues; - - Return TRUE on record log information success, FALSE on failure. - - - - - &reftitle.examples; - - <function>SeasLog::critical</function> example - - 'neeke'))); - -//with tmp logger -var_dump(SeasLog::critical('log message from {NAME}',array('NAME' => 'neeke'),'tmp_logger')); - -var_dump(SeasLog::getBuffer()); - -?> -]]> - - &example.outputs.similar; - - - array(2) { - [0]=> - string(81) "2018-07-07 11:45:49 | CRITICAL | 73263 | 5b40376d1067c | 1530935149.68 | log message -" - [1]=> - string(92) "2018-07-07 11:45:49 | CRITICAL | 73263 | 5b40376d1067c | 1530935149.68 | log message from neeke -" - } - ["/var/log/www/tmp_logger/20180707.log"]=> - array(1) { - [0]=> - string(92) "2018-07-07 11:45:49 | CRITICAL | 73263 | 5b40376d1067c | 1530935149.68 | log message from neeke -" - } -} -]]> - - - - - - &reftitle.seealso; - - seaslog.default_template - SeasLog::debug - SeasLog::info - SeasLog::notice - SeasLog::warning - SeasLog::error - SeasLog::alert - SeasLog::emergency - SeasLog::log - - - - - diff --git a/reference/seaslog/seaslog/debug.xml b/reference/seaslog/seaslog/debug.xml deleted file mode 100644 index c532adeec8ac..000000000000 --- a/reference/seaslog/seaslog/debug.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - SeasLog::debug - Record debug log information - - - - &reftitle.description; - - public static boolSeasLog::debug - stringmessage - arraycontent - stringlogger - - - Record debug log information. - - - "DEBUG" - Detailed debug information.Fine-grained information events. - - - - - - - - &reftitle.parameters; - - - message - - - The log message. - - - - - content - - - The `message` contain placeholders which implementors replace with values from content array. - Sush as `message` is `log info from {NAME}` and `content` is `array('NAME' => neeke)`, - the log information will `log info from neeke`. - - - - - logger - - - The `logger` cased by the third param would be used right this right now, - like a temp logger, when the function SeasLog::setLogger() called in pre content. - If `logger` NULL or "", SeasLog will use lastest logger setted by SeasLog::setLogger. - - - - - - - - &reftitle.returnvalues; - - Return TRUE on record log information success, FALSE on failure. - - - - - &reftitle.examples; - - <function>SeasLog::debug</function> example - - 'neeke'))); - -//with tmp logger -var_dump(SeasLog::debug('log message from {NAME}',array('NAME' => 'neeke'),'tmp_logger')); - -var_dump(SeasLog::getBuffer()); - -?> -]]> - - &example.outputs.similar; - - - array(2) { - [0]=> - string(81) "2018-07-07 11:45:49 | DEBUG | 73263 | 5b40376d1067c | 1530935149.68 | log message -" - [1]=> - string(92) "2018-07-07 11:45:49 | DEBUG | 73263 | 5b40376d1067c | 1530935149.68 | log message from neeke -" - } - ["/var/log/www/tmp_logger/20180707.log"]=> - array(1) { - [0]=> - string(92) "2018-07-07 11:45:49 | DEBUG | 73263 | 5b40376d1067c | 1530935149.68 | log message from neeke -" - } -} -]]> - - - - - - &reftitle.seealso; - - seaslog.default_template - SeasLog::info - SeasLog::notice - SeasLog::warning - SeasLog::error - SeasLog::critical - SeasLog::alert - SeasLog::emergency - SeasLog::log - - - - - - diff --git a/reference/seaslog/seaslog/destruct.xml b/reference/seaslog/seaslog/destruct.xml deleted file mode 100644 index 67c5179e91a8..000000000000 --- a/reference/seaslog/seaslog/destruct.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - SeasLog::__destruct - Description - - - - &reftitle.description; - - public SeasLog::__destruct - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - <function>SeasLog::__destruct</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/seaslog/seaslog/emergency.xml b/reference/seaslog/seaslog/emergency.xml deleted file mode 100644 index 3233cdd4d884..000000000000 --- a/reference/seaslog/seaslog/emergency.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - SeasLog::emergency - Record emergency log information - - - - &reftitle.description; - - public static boolSeasLog::emergency - stringmessage - arraycontent - stringlogger - - - Record emergency log information. - - - "EMERGENCY" - System is unusable. - - - - - - - - &reftitle.parameters; - - - message - - - The log message. - - - - - content - - - The `message` contain placeholders which implementors replace with values from content array. - Sush as `message` is `log info from {NAME}` and `content` is `array('NAME' => neeke)`, - the log information will `log info from neeke`. - - - - - logger - - - The `logger` cased by the third param would be used right this right now, - like a temp logger, when the function SeasLog::setLogger() called in pre content. - If `logger` NULL or "", SeasLog will use lastest logger setted by SeasLog::setLogger. - - - - - - - - &reftitle.returnvalues; - - Return TRUE on record log information success, FALSE on failure. - - - - - &reftitle.examples; - - <function>SeasLog::emergency</function> example - - 'neeke'))); - -//with tmp logger -var_dump(SeasLog::emergency('log message from {NAME}',array('NAME' => 'neeke'),'tmp_logger')); - -var_dump(SeasLog::getBuffer()); - -?> -]]> - - &example.outputs.similar; - - - array(2) { - [0]=> - string(81) "2018-07-07 11:45:49 | EMERGENCY | 73263 | 5b40376d1067c | 1530935149.68 | log message -" - [1]=> - string(92) "2018-07-07 11:45:49 | EMERGENCY | 73263 | 5b40376d1067c | 1530935149.68 | log message from neeke -" - } - ["/var/log/www/tmp_logger/20180707.log"]=> - array(1) { - [0]=> - string(92) "2018-07-07 11:45:49 | EMERGENCY | 73263 | 5b40376d1067c | 1530935149.68 | log message from neeke -" - } -} -]]> - - - - - - &reftitle.seealso; - - seaslog.default_template - SeasLog::debug - SeasLog::info - SeasLog::notice - SeasLog::warning - SeasLog::error - SeasLog::critical - SeasLog::alert - SeasLog::log - - - - - - diff --git a/reference/seaslog/seaslog/error.xml b/reference/seaslog/seaslog/error.xml deleted file mode 100644 index 53277504a1e2..000000000000 --- a/reference/seaslog/seaslog/error.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - SeasLog::error - Record error log information - - - - &reftitle.description; - - public static boolSeasLog::error - stringmessage - arraycontent - stringlogger - - - Record error log information. - - - "ERROR" - Runtime errors that do not require immediate action but should typically. - - - - - - - - &reftitle.parameters; - - - message - - - The log message. - - - - - content - - - The `message` contain placeholders which implementors replace with values from content array. - Sush as `message` is `log info from {NAME}` and `content` is `array('NAME' => neeke)`, - the log information will `log info from neeke`. - - - - - logger - - - The `logger` cased by the third param would be used right this right now, - like a temp logger, when the function SeasLog::setLogger() called in pre content. - If `logger` NULL or "", SeasLog will use lastest logger setted by SeasLog::setLogger. - - - - - - - - &reftitle.returnvalues; - - Return TRUE on record log information success, FALSE on failure. - - - - - &reftitle.examples; - - <function>SeasLog::error</function> example - - 'neeke'))); - -//with tmp logger -var_dump(SeasLog::error('log message from {NAME}',array('NAME' => 'neeke'),'tmp_logger')); - -var_dump(SeasLog::getBuffer()); - -?> -]]> - - &example.outputs.similar; - - - array(2) { - [0]=> - string(81) "2018-07-07 11:45:49 | ERROR | 73263 | 5b40376d1067c | 1530935149.68 | log message -" - [1]=> - string(92) "2018-07-07 11:45:49 | ERROR | 73263 | 5b40376d1067c | 1530935149.68 | log message from neeke -" - } - ["/var/log/www/tmp_logger/20180707.log"]=> - array(1) { - [0]=> - string(92) "2018-07-07 11:45:49 | ERROR | 73263 | 5b40376d1067c | 1530935149.68 | log message from neeke -" - } -} -]]> - - - - - - &reftitle.seealso; - - seaslog.default_template - SeasLog::debug - SeasLog::info - SeasLog::notice - SeasLog::warning - SeasLog::critical - SeasLog::alert - SeasLog::emergency - SeasLog::log - - - - - - diff --git a/reference/seaslog/seaslog/flushbuffer.xml b/reference/seaslog/seaslog/flushbuffer.xml deleted file mode 100644 index 6fbd39717ea7..000000000000 --- a/reference/seaslog/seaslog/flushbuffer.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - SeasLog::flushBuffer - Flush logs buffer, dump to appender file, or send to remote api with tcp/udp - - - - &reftitle.description; - - public static boolSeasLog::flushBuffer - - - - Flush logs buffer by seaslog.appender: - dump to file, or send to remote api with tcp/udp. - - - See also: - seaslog.appender_retry - seaslog.remote_host - seaslog.remote_port - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Return TRUE on flush buffer success, FALSE on failure. - - - - - &reftitle.examples; - - <function>SeasLog::flushBuffer</function> example - - -]]> - - &example.outputs.similar; - - - array(2) { - [0]=> - string(79) "2018-07-07 10:47:58 | INFO | 71910 | 5b4029ded6009 | 1530931678.877 | info log -" - [1]=> - string(81) "2018-07-07 10:47:58 | DEBUG | 71910 | 5b4029ded6009 | 1530931678.877 | debug log -" - } -} -bool(true) -array(0) { -} -]]> - - - - - - &reftitle.seealso; - - seaslog.use_buffer - seaslog.buffer_size - seaslog.buffer_disabled_in_cli - SeasLog::getBufferEnabled - SeasLog::getBuffer - - - - - - diff --git a/reference/seaslog/seaslog/getbasepath.xml b/reference/seaslog/seaslog/getbasepath.xml deleted file mode 100644 index 027114ac6635..000000000000 --- a/reference/seaslog/seaslog/getbasepath.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - SeasLog::getBasePath - Get SeasLog base path. - - - - &reftitle.description; - - public static stringSeaslog::getBasePath - - - - Use the Function SeasLog::getBasePath - will get the value of seaslog.default_basepath - what configured in php.ini(seaslog.ini). - - - If you use Seaslog::setBasePath, will change the result. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Return seaslog.default_basepath as string. - - - - - &reftitle.examples; - - <methodname>SeasLog::getBasePath</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/seaslog/seaslog/getbuffer.xml b/reference/seaslog/seaslog/getbuffer.xml deleted file mode 100644 index 3b2e50d732f4..000000000000 --- a/reference/seaslog/seaslog/getbuffer.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - SeasLog::getBuffer - Get the logs buffer in memory as array - - - - &reftitle.description; - - public static arraySeasLog::getBuffer - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Return an array from logs buffer in memory. - - - - - &reftitle.examples; - - <function>SeasLog::getBuffer</function> example - - -]]> - - &example.outputs.similar; - - - array(2) { - [0]=> - string(79) "2018-07-07 10:43:32 | INFO | 71785 | 5b4028d4c58d5 | 1530931412.810 | info log -" - [1]=> - string(81) "2018-07-07 10:43:32 | DEBUG | 71785 | 5b4028d4c58d5 | 1530931412.810 | debug log -" - } -} -]]> - - - - - - &reftitle.seealso; - - seaslog.use_buffer - seaslog.buffer_size - seaslog.buffer_disabled_in_cli - SeasLog::getBufferEnabled - SeasLog::flushBuffer - - - - - - diff --git a/reference/seaslog/seaslog/getbufferenabled.xml b/reference/seaslog/seaslog/getbufferenabled.xml deleted file mode 100644 index 1da3fcf24a7f..000000000000 --- a/reference/seaslog/seaslog/getbufferenabled.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - SeasLog::getBufferEnabled - Determin if buffer enabled - - - - &reftitle.description; - - public static boolSeasLog::getBufferEnabled - - - - Result join seaslog.use_buffer - and seaslog.buffer_disabled_in_cli. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Return TRUE on seaslog.use_buffer is true. - If switch seaslog.buffer_disabled_in_cli on, and running in cli, - seaslog.use_buffer setting will be discarded, Seaslog write to the Data Store IMMEDIATELY. - - - - - &reftitle.examples; - - <function>SeasLog::getBufferEnabled</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - seaslog.use_buffer - seaslog.buffer_size - seaslog.buffer_disabled_in_cli - SeasLog::getBuffer - SeasLog::flushBuffer - - - - - - diff --git a/reference/seaslog/seaslog/getdatetimeformat.xml b/reference/seaslog/seaslog/getdatetimeformat.xml deleted file mode 100644 index 590310883f4f..000000000000 --- a/reference/seaslog/seaslog/getdatetimeformat.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - SeasLog::getDatetimeFormat - Get SeasLog datetime format style - - - - &reftitle.description; - - public static stringSeasLog::getDatetimeFormat - - - - Get SeasLog datetime format style. - Use the Function SeasLog::getDatetimeFormat will - get the value of seaslog.default_datetime_format - what configured in php.ini(seaslog.ini). - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Get SeasLog datetime format style of - seaslog.default_datetime_format. - Use the Function SeasLog::setDatetimeFormat - will change this value. - - - - - &reftitle.examples; - - <function>SeasLog::getDatetimeFormat</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SeasLog::setDatetimeFormat - - - - - - diff --git a/reference/seaslog/seaslog/getlastlogger.xml b/reference/seaslog/seaslog/getlastlogger.xml deleted file mode 100644 index 541ed10a4a05..000000000000 --- a/reference/seaslog/seaslog/getlastlogger.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - SeasLog::getLastLogger - Get SeasLog last logger path - - - - &reftitle.description; - - public static stringSeasLog::getLastLogger - - - - Use the Function SeasLog::getLastLogger will - get the value of seaslog.default_logger - what configured in php.ini(seaslog.ini). - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Use the Function SeasLog::setLogger - will change the value of function SeasLog::getLastLogger. - - - - - &reftitle.examples; - - <function>SeasLog::getLastLogger</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SeasLog::setLogger - - - - - - diff --git a/reference/seaslog/seaslog/getrequestid.xml b/reference/seaslog/seaslog/getrequestid.xml deleted file mode 100644 index d0e2e08a0f9d..000000000000 --- a/reference/seaslog/seaslog/getrequestid.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - SeasLog::getRequestID - Get SeasLog request_id differentiated requests - - - - &reftitle.description; - - public static stringSeasLog::getRequestID - - - - To distinguish a single request, such as not invoking the - SeasLog::setRequestId function, - the unique value generated by the built-in `static char *get_uniqid ()` - function is used when the request is initialized. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Return string generated by the built-in `static char *get_uniqid ()` function, - or setted by SeasLog::setRequestId function. - - - - - &reftitle.examples; - - <function>SeasLog::getRequestID</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SeasLog::setRequestID - The Variable `%Q` in - Seaslog Default Variable Table. - - - - - - diff --git a/reference/seaslog/seaslog/getrequestvariable.xml b/reference/seaslog/seaslog/getrequestvariable.xml deleted file mode 100644 index 4ea982274883..000000000000 --- a/reference/seaslog/seaslog/getrequestvariable.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - SeasLog::getRequestVariable - Get SeasLog request variable - - - - &reftitle.description; - - public static boolSeasLog::getRequestVariable - intkey - - - Get SeasLog request variable. - - - - - - &reftitle.parameters; - - - key - - - Constant int. - - SEASLOG_REQUEST_VARIABLE_DOMAIN_PORT - SEASLOG_REQUEST_VARIABLE_REQUEST_URI - SEASLOG_REQUEST_VARIABLE_REQUEST_METHOD - SEASLOG_REQUEST_VARIABLE_CLIENT_IP - - - - - - - - - &reftitle.returnvalues; - - Return request variable value on set success. - - - - - &reftitle.examples; - - <methodname>SeasLog::getRequestVariable</methodname> example - -setRequestVariable(SEASLOG_REQUEST_VARIABLE_DOMAIN_PORT, $sDomainPort)); -var_dump($oSeasLog->setRequestVariable(SEASLOG_REQUEST_VARIABLE_REQUEST_URI, $sRequestUri)); -var_dump($oSeasLog->setRequestVariable(SEASLOG_REQUEST_VARIABLE_REQUEST_METHOD, $sRequestMethod)); -var_dump($oSeasLog->setRequestVariable(SEASLOG_REQUEST_VARIABLE_CLIENT_IP, $sClientIp)); - -var_dump($oSeasLog->setRequestVariable($iErrorKey,NULL)); - -var_dump($oSeasLog->getRequestVariable(SEASLOG_REQUEST_VARIABLE_DOMAIN_PORT) == $sDomainPort); -var_dump($oSeasLog->getRequestVariable(SEASLOG_REQUEST_VARIABLE_REQUEST_URI) == $sRequestUri); -var_dump($oSeasLog->getRequestVariable(SEASLOG_REQUEST_VARIABLE_REQUEST_METHOD) == $sRequestMethod); -var_dump($oSeasLog->getRequestVariable(SEASLOG_REQUEST_VARIABLE_CLIENT_IP) == $sClientIp); - -var_dump($oSeasLog->getRequestVariable($iErrorKey)); - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SeasLog::setRequestVariable - - - - - diff --git a/reference/seaslog/seaslog/info.xml b/reference/seaslog/seaslog/info.xml deleted file mode 100644 index eb70baeccc88..000000000000 --- a/reference/seaslog/seaslog/info.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - SeasLog::info - Record info log information - - - - &reftitle.description; - - public static boolSeasLog::info - stringmessage - arraycontent - stringlogger - - - Record info log information. - - - "INFO" - Interesting events.Emphasizes the running process of the application. - - - - - - - - &reftitle.parameters; - - - message - - - The log message. - - - - - content - - - The `message` contain placeholders which implementors replace with values from content array. - Sush as `message` is `log info from {NAME}` and `content` is `array('NAME' => neeke)`, - the log information will `log info from neeke`. - - - - - logger - - - The `logger` cased by the third param would be used right this right now, - like a temp logger, when the function SeasLog::setLogger() called in pre content. - If `logger` NULL or "", SeasLog will use lastest logger setted by SeasLog::setLogger. - - - - - - - - &reftitle.returnvalues; - - Return TRUE on record log information success, FALSE on failure. - - - - - &reftitle.examples; - - <function>SeasLog::info</function> example - - 'neeke'))); - -//with tmp logger -var_dump(SeasLog::info('log message from {NAME}',array('NAME' => 'neeke'),'tmp_logger')); - -var_dump(SeasLog::getBuffer()); - -?> -]]> - - &example.outputs.similar; - - - array(2) { - [0]=> - string(81) "2018-07-07 11:45:49 | INFO | 73263 | 5b40376d1067c | 1530935149.68 | log message -" - [1]=> - string(92) "2018-07-07 11:45:49 | INFO | 73263 | 5b40376d1067c | 1530935149.68 | log message from neeke -" - } - ["/var/log/www/tmp_logger/20180707.log"]=> - array(1) { - [0]=> - string(92) "2018-07-07 11:45:49 | INFO | 73263 | 5b40376d1067c | 1530935149.68 | log message from neeke -" - } -} -]]> - - - - - - &reftitle.seealso; - - seaslog.default_template - SeasLog::debug - SeasLog::notice - SeasLog::warning - SeasLog::error - SeasLog::critical - SeasLog::alert - SeasLog::emergency - SeasLog::log - - - - - - diff --git a/reference/seaslog/seaslog/log.xml b/reference/seaslog/seaslog/log.xml deleted file mode 100644 index 45ff072eb8ea..000000000000 --- a/reference/seaslog/seaslog/log.xml +++ /dev/null @@ -1,194 +0,0 @@ - - - - - SeasLog::log - The Common Record Log Function - - - - &reftitle.description; - - public static boolSeasLog::log - stringlevel - stringmessage - arraycontent - stringlogger - - - The Common Record Log Function. - - - - - - &reftitle.parameters; - - - level - - - Can use level in: - - SEASLOG_DEBUG - SEASLOG_INFO - SEASLOG_NOTICE - SEASLOG_WARNING - SEASLOG_ERROR - SEASLOG_CRITICAL - SEASLOG_ALERT - SEASLOG_EMERGENCY - - Or you can create a new level self-help. - - - - - message - - - The log message. - - - - - content - - - The `message` contain placeholders which implementors replace with values from content array. - Sush as `message` is `log info from {NAME}` and `content` is `array('NAME' => neeke)`, - the log information will `log info from neeke`. - - - - - logger - - - The `logger` cased by the third param would be used right this right now, - like a temp logger, when the function SeasLog::setLogger() called in pre content. - If `logger` NULL or "", SeasLog will use lastest logger setted by SeasLog::setLogger. - - - - - - - - &reftitle.returnvalues; - - Return TRUE on record log information success, FALSE on failure. - - - - - &reftitle.examples; - - <function>SeasLog::log</function> example - - 'neeke'))); -var_dump(SeasLog::getBuffer()); - -//with `logger` -var_dump(SeasLog::log('MySelfLevel','info log {NAME}',array('NAME' => 'neeke'),'tmp_logger')); -var_dump(SeasLog::getBuffer()); - - -?> -]]> - - &example.outputs.similar; - - - array(1) { - [0]=> - string(79) "2018-07-07 11:12:37 | INFO | 72427 | 5b402fa56a2ea | 1530933157.436 | info log -" - } -} - -bool(true) -array(1) { - ["/var/log/www/default/20180707.log"]=> - array(1) { - [0]=> - string(86) "2018-07-07 11:13:59 | MySelfLevel | 72470 | 5b402ff781c5e | 1530933239.532 | info log -" - } -} - -bool(true) -array(1) { - ["/var/log/www/tmp_logger/20180707.log"]=> - array(1) { - [0]=> - string(92) "2018-07-07 11:28:12 | MySelfLevel | 72833 | 5b40334ce6a2f | 1530934092.946 | info log neeke -" - } -} - -bool(true) -array(1) { - ["/var/log/www/default/20180707.log"]=> - array(1) { - [0]=> - string(86) "2018-07-07 11:20:12 | INFO | 72616 | 5b40316c3641e | 1530933612.222 | info log neeke -" - } -} -]]> - - - - - - &reftitle.seealso; - - seaslog.default_template - SeasLog::debug - SeasLog::info - SeasLog::notice - SeasLog::warning - SeasLog::error - SeasLog::critical - SeasLog::alert - SeasLog::emergency - - - - - - diff --git a/reference/seaslog/seaslog/notice.xml b/reference/seaslog/seaslog/notice.xml deleted file mode 100644 index ea3c2023501e..000000000000 --- a/reference/seaslog/seaslog/notice.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - - SeasLog::notice - Record notice log information - - - - &reftitle.description; - - public static boolSeasLog::notice - stringmessage - arraycontent - stringlogger - - - Record notice log information. - - - "NOTICE" - Normal but significant events.Information that is more important than the INFO level during execution. - - - - - - - - &reftitle.parameters; - - - message - - - The log message. - - - - - content - - - The `message` contain placeholders which implementors replace with values from content array. - Sush as `message` is `log info from {NAME}` and `content` is `array('NAME' => neeke)`, - the log information will `log info from neeke`. - - - - - logger - - - The `logger` cased by the third param would be used right this right now, - like a temp logger, when the function SeasLog::setLogger() called in pre content. - If `logger` NULL or "", SeasLog will use lastest logger setted by SeasLog::setLogger. - - - - - - - - &reftitle.returnvalues; - - Return TRUE on record log information success, FALSE on failure. - - - - - &reftitle.examples; - - <function>SeasLog::notice</function> example - - 'neeke'))); - -//with tmp logger -var_dump(SeasLog::notice('log message from {NAME}',array('NAME' => 'neeke'),'tmp_logger')); - -var_dump(SeasLog::getBuffer()); - -?> -]]> - - &example.outputs.similar; - - - array(2) { - [0]=> - string(81) "2018-07-07 11:45:49 | NOTICE | 73263 | 5b40376d1067c | 1530935149.68 | log message -" - [1]=> - string(92) "2018-07-07 11:45:49 | NOTICE | 73263 | 5b40376d1067c | 1530935149.68 | log message from neeke -" - } - ["/var/log/www/tmp_logger/20180707.log"]=> - array(1) { - [0]=> - string(92) "2018-07-07 11:45:49 | NOTICE | 73263 | 5b40376d1067c | 1530935149.68 | log message from neeke -" - } -} -]]> - - - - - - &reftitle.seealso; - - seaslog.default_template - SeasLog::debug - SeasLog::info - SeasLog::warning - SeasLog::error - SeasLog::critical - SeasLog::alert - SeasLog::emergency - SeasLog::log - - - - - - - diff --git a/reference/seaslog/seaslog/setbasepath.xml b/reference/seaslog/seaslog/setbasepath.xml deleted file mode 100644 index 8e6781b86c87..000000000000 --- a/reference/seaslog/seaslog/setbasepath.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - SeasLog::setBasePath - Set SeasLog base path - - - - &reftitle.description; - - public static boolSeasLog::setBasePath - stringbase_path - - - Set SeasLog base path. - - - - - - &reftitle.parameters; - - - base_path - - - String. - - - - - - - - &reftitle.returnvalues; - - Return TRUE on setted base path success, FALSE on failure. - - - - - &reftitle.examples; - - <methodname>SeasLog::setBasePath</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/seaslog/seaslog/setdatetimeformat.xml b/reference/seaslog/seaslog/setdatetimeformat.xml deleted file mode 100644 index a641455a43a3..000000000000 --- a/reference/seaslog/seaslog/setdatetimeformat.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - SeasLog::setDatetimeFormat - Set SeasLog datetime format style - - - - &reftitle.description; - - public static boolSeasLog::setDatetimeFormat - stringformat - - - Set SeasLog datetime format style. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - format - - - String. Such as `Y-m-d H:i:s` or `Ymd His`. See also first param `format` at date. - - - - - - - - &reftitle.returnvalues; - - Return TRUE on setted datetime format success, FALSE on failure. - - - - - &reftitle.examples; - - <function>SeasLog::setDatetimeFormat</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SeasLog::getDateTimeFormat - - - - - - diff --git a/reference/seaslog/seaslog/setlogger.xml b/reference/seaslog/seaslog/setlogger.xml deleted file mode 100644 index d6833c4b577a..000000000000 --- a/reference/seaslog/seaslog/setlogger.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - SeasLog::setLogger - Set SeasLog logger name - - - - &reftitle.description; - - public static boolSeasLog::setLogger - stringlogger - - - Use the Function SeasLog::setLogger - will change the value of function SeasLog::getLastLogger. - Than's mean, SeasLog will record loginfo into the logger directory. - - - - - - &reftitle.parameters; - - - logger - - - Logger name. - - - - - - - - &reftitle.returnvalues; - - Return TRUE on created logger disectory success, FALSE on failure. - - - - - &reftitle.examples; - - <function>SeasLog::setLogger</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SeasLog::getLastLogger - SeasLog::closeLoggerStream - - - - - - diff --git a/reference/seaslog/seaslog/setrequestid.xml b/reference/seaslog/seaslog/setrequestid.xml deleted file mode 100644 index a44ad97cd54d..000000000000 --- a/reference/seaslog/seaslog/setrequestid.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - SeasLog::setRequestID - Set SeasLog request_id differentiated requests - - - - &reftitle.description; - - public static boolSeasLog::setRequestID - stringrequest_id - - - To distinguish a single request, such as not invoking the - SeasLog::setRequestId function, - the unique value generated by the built-in `static char *get_uniqid ()` - function is used when the request is initialized. - - - - - &reftitle.parameters; - - - request_id - - - String. - - - - - - - - &reftitle.returnvalues; - - Return TRUE on set request_id success, FALSE on failure. - - - - - &reftitle.examples; - - <function>SeasLog::setRequestID</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SeasLog::getRequestID - - - - - - diff --git a/reference/seaslog/seaslog/setrequestvariable.xml b/reference/seaslog/seaslog/setrequestvariable.xml deleted file mode 100644 index d8821b4a797a..000000000000 --- a/reference/seaslog/seaslog/setrequestvariable.xml +++ /dev/null @@ -1,138 +0,0 @@ - - - - - SeasLog::setRequestVariable - Manually set SeasLog request variable - - - - &reftitle.description; - - public static boolSeasLog::setRequestVariable - intkey - stringvalue - - - Manually set SeasLog request variable. - - - - - - &reftitle.parameters; - - - key - - - Constant int. - - SEASLOG_REQUEST_VARIABLE_DOMAIN_PORT - SEASLOG_REQUEST_VARIABLE_REQUEST_URI - SEASLOG_REQUEST_VARIABLE_REQUEST_METHOD - SEASLOG_REQUEST_VARIABLE_CLIENT_IP - - - - - - value - - - The request variable value. - - - - - - - - &reftitle.returnvalues; - - Return TRUE on set success, FALSE on failure. - - - - - &reftitle.examples; - - <methodname>SeasLog::setRequestVariable</methodname> example - -setRequestVariable(SEASLOG_REQUEST_VARIABLE_DOMAIN_PORT, $sDomainPort)); -var_dump($oSeasLog->setRequestVariable(SEASLOG_REQUEST_VARIABLE_REQUEST_URI, $sRequestUri)); -var_dump($oSeasLog->setRequestVariable(SEASLOG_REQUEST_VARIABLE_REQUEST_METHOD, $sRequestMethod)); -var_dump($oSeasLog->setRequestVariable(SEASLOG_REQUEST_VARIABLE_CLIENT_IP, $sClientIp)); - -var_dump($oSeasLog->setRequestVariable($iErrorKey,NULL)); - -var_dump($oSeasLog->getRequestVariable(SEASLOG_REQUEST_VARIABLE_DOMAIN_PORT) == $sDomainPort); -var_dump($oSeasLog->getRequestVariable(SEASLOG_REQUEST_VARIABLE_REQUEST_URI) == $sRequestUri); -var_dump($oSeasLog->getRequestVariable(SEASLOG_REQUEST_VARIABLE_REQUEST_METHOD) == $sRequestMethod); -var_dump($oSeasLog->getRequestVariable(SEASLOG_REQUEST_VARIABLE_CLIENT_IP) == $sClientIp); - -var_dump($oSeasLog->getRequestVariable($iErrorKey)); - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SeasLog::getRequestVariable - - - - - diff --git a/reference/seaslog/seaslog/warning.xml b/reference/seaslog/seaslog/warning.xml deleted file mode 100644 index bbcdf598ae0d..000000000000 --- a/reference/seaslog/seaslog/warning.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - - SeasLog::warning - Record warning log information - - - - &reftitle.description; - - public static boolSeasLog::warning - stringmessage - arraycontent - stringlogger - - - Record warning log information. - - - "WARNING" - Exceptional occurrences that are not errors. - Potentially aberrant information that needs attention and needs to be repaired. - - - - - - - - &reftitle.parameters; - - - message - - - The log message. - - - - - content - - - The `message` contain placeholders which implementors replace with values from content array. - Sush as `message` is `log info from {NAME}` and `content` is `array('NAME' => neeke)`, - the log information will `log info from neeke`. - - - - - logger - - - The `logger` cased by the third param would be used right this right now, - like a temp logger, when the function SeasLog::setLogger() called in pre content. - If `logger` NULL or "", SeasLog will use lastest logger setted by SeasLog::setLogger. - - - - - - - - &reftitle.returnvalues; - - Return TRUE on record log information success, FALSE on failure. - - - - - &reftitle.examples; - - <function>SeasLog::warning</function> example - - 'neeke'))); - -//with tmp logger -var_dump(SeasLog::warning('log message from {NAME}',array('NAME' => 'neeke'),'tmp_logger')); - -var_dump(SeasLog::getBuffer()); - -?> -]]> - - &example.outputs.similar; - - - array(2) { - [0]=> - string(81) "2018-07-07 11:45:49 | WARNING | 73263 | 5b40376d1067c | 1530935149.68 | log message -" - [1]=> - string(92) "2018-07-07 11:45:49 | WARNING | 73263 | 5b40376d1067c | 1530935149.68 | log message from neeke -" - } - ["/var/log/www/tmp_logger/20180707.log"]=> - array(1) { - [0]=> - string(92) "2018-07-07 11:45:49 | WARNING | 73263 | 5b40376d1067c | 1530935149.68 | log message from neeke -" - } -} -]]> - - - - - - &reftitle.seealso; - - seaslog.default_template - SeasLog::debug - SeasLog::info - SeasLog::notice - SeasLog::error - SeasLog::critical - SeasLog::alert - SeasLog::emergency - SeasLog::log - - - - - - diff --git a/reference/seaslog/setup.xml b/reference/seaslog/setup.xml deleted file mode 100644 index 7f7a5cad2e13..000000000000 --- a/reference/seaslog/setup.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - &reftitle.setup; - -
    - &reftitle.required; - - - -
    - - - &reference.seaslog.configure; - - - - &reference.seaslog.ini; - - -
    - &reftitle.resources; - - - -
    - -
    - diff --git a/reference/seaslog/versions.xml b/reference/seaslog/versions.xml deleted file mode 100644 index 874dc5f96e57..000000000000 --- a/reference/seaslog/versions.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/session/ini.xml b/reference/session/ini.xml index bfbc3f691029..16da18dd6b7b 100644 --- a/reference/session/ini.xml +++ b/reference/session/ini.xml @@ -1,6 +1,6 @@ -
    +
    &reftitle.runtime; &extension.runtime; @@ -384,7 +384,7 @@ internal formats (name php and php_binary) and WDDX are supported (name wddx). WDDX is only available, if PHP is - compiled with WDDX + compiled with WDDX support. php_serialize uses plain serialize/unserialize function internally and does not have limitations that php diff --git a/reference/simdjson/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/simdjson/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/simdjson/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/simdjson/book.xml b/reference/simdjson/book.xml deleted file mode 100644 index 2c0025954886..000000000000 --- a/reference/simdjson/book.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - - Simdjson - Simdjson - - - &reftitle.intro; - - Provides faster JSON decoding through simdjson bindings for PHP (Single Instruction, Multiple Data) - - - - &reference.simdjson.setup; - &reference.simdjson.constants; - &reference.simdjson.reference; - - &reference.simdjson.simdjsonexception; - &reference.simdjson.simdjsonvalueerror; - - diff --git a/reference/simdjson/constants.xml b/reference/simdjson/constants.xml deleted file mode 100644 index 3c85d56de586..000000000000 --- a/reference/simdjson/constants.xml +++ /dev/null @@ -1,356 +0,0 @@ - - - &reftitle.constants; - &extension.constants; - - - - SIMDJSON_ERR_CAPACITY - (&integer;) - - - - This parser can't support a document that big. - Thrown when parsing a JSON string that is over 4GiB long. - - - - - - SIMDJSON_ERR_TAPE_ERROR - (&integer;) - - - - The JSON document has an improper structure: missing or superfluous commas, braces, missing keys, etc. - - - - - - SIMDJSON_ERR_DEPTH_ERROR - (&integer;) - - - - The JSON document was too deep (too many nested objects and arrays) - - - - - - SIMDJSON_ERR_STRING_ERROR - (&integer;) - - - Problem while parsing a string - - - - - - SIMDJSON_ERR_T_ATOM_ERROR - (&integer;) - - - Problem while parsing an atom starting with the letter 't' - - - - - - SIMDJSON_ERR_F_ATOM_ERROR - (&integer;) - - - - Problem while parsing an atom starting with the letter 'f' - - - - - - SIMDJSON_ERR_N_ATOM_ERROR - (&integer;) - - - - Problem while parsing an atom starting with the letter 'n' - - - - - - SIMDJSON_ERR_NUMBER_ERROR - (&integer;) - - - - Problem while parsing a number - - - - - - SIMDJSON_ERR_UTF8_ERROR - (&integer;) - - - - The input is not valid UTF-8 - - - - - - SIMDJSON_ERR_UNINITIALIZED - (&integer;) - - - - The parser used by simdjson is uninitialized. Should not happen. - - - - - - SIMDJSON_ERR_EMPTY - (&integer;) - - - Empty: no JSON found - - - - - - SIMDJSON_ERR_UNESCAPED_CHARS - (&integer;) - - - Within strings, some characters must be escaped, we found unescaped characters - - - - - - SIMDJSON_ERR_UNCLOSED_STRING - (&integer;) - - - - A string is opened, but never closed. - - - - - - SIMDJSON_ERR_UNSUPPORTED_ARCHITECTURE - (&integer;) - - - - simdjson does not have an implementation supported by this CPU architecture (perhaps it's a non-SIMD CPU?). - - - - - - SIMDJSON_ERR_INCORRECT_TYPE - (&integer;) - - - - Should not happen. - - - - - - SIMDJSON_ERR_NUMBER_OUT_OF_RANGE - (&integer;) - - - - The JSON number is too large or too small to fit within the requested type. - Note that the C simdjson library is a fork and this error is ignored to match php's - handling of JSON numbers that are too large or too small. - - - - - - SIMDJSON_ERR_INDEX_OUT_OF_BOUNDS - (&integer;) - - - - Should not happen. - - - - - - SIMDJSON_ERR_NO_SUCH_FIELD - (&integer;) - - - Should not happen. - - - - - - SIMDJSON_ERR_IO_ERROR - (&integer;) - - - Should not happen. - - - - - - SIMDJSON_ERR_INVALID_JSON_POINTER - (&integer;) - - - - Invalid JSON pointer syntax in simdjson_key_value - and other functions accepting a JSON pointer $key. - - - - - - SIMDJSON_ERR_INVALID_URI_FRAGMENT - (&integer;) - - - Invalid URI fragment syntax. - - - - - - SIMDJSON_ERR_UNEXPECTED_ERROR - (&integer;) - - - Unexpected error, consider reporting this problem as you may have found a bug in the simdjson PECL - - - - - - SIMDJSON_ERR_PARSER_IN_USE - (&integer;) - - - Should not happen. - - - - - - SIMDJSON_ERR_OUT_OF_ORDER_ITERATION - (&integer;) - - - Should not happen. - - - - - - SIMDJSON_ERR_INSUFFICIENT_PADDING - (&integer;) - - - Should not happen. - - - - - - SIMDJSON_ERR_INCOMPLETE_ARRAY_OR_OBJECT - (&integer;) - - - JSON document ended early in the middle of an object or array. - - - - - - SIMDJSON_ERR_SCALAR_DOCUMENT_AS_VALUE - (&integer;) - - - Should not happen. - - - - - - SIMDJSON_ERR_OUT_OF_BOUNDS - (&integer;) - - - Attempted to access location outside of document. - - - - - - SIMDJSON_ERR_TRAILING_CONTENT - (&integer;) - - - - - - - - - SIMDJSON_ERR_KEY_COUNT_NOT_COUNTABLE - (&integer;) - - - - - - - - - SIMDJSON_ERR_INVALID_PROPERTY - (&integer;) - - - Invalid property name for an stdClass when decoding a value - with simdjson_decode or simdjson_key_value - - - - - - diff --git a/reference/simdjson/functions/simdjson-decode.xml b/reference/simdjson/functions/simdjson-decode.xml deleted file mode 100644 index 4c232a53a223..000000000000 --- a/reference/simdjson/functions/simdjson-decode.xml +++ /dev/null @@ -1,302 +0,0 @@ - - - - simdjson_decode - Decodes a JSON string - - - - &reftitle.description; - - mixedsimdjson_decode - stringjson - boolassociative&false; - intdepth512 - - - Takes a JSON encoded string and converts it into a PHP value. - This uses a faster Simultaneous Instruction, Multiple Data implementation - than json_decode when it is supported by the computer architecture. - - - - - &reftitle.parameters; - - - json - - - The json string being decoded. - - - This function only works with UTF-8 encoded strings. - - - This function parses valid inputs which - json_decode can decode, - provided that they are less than 4 GiB long. - - - - - associative - - - When &true;, JSON objects will be returned as - associative &array;s; when &false;, JSON objects will be returned as &object;s. - - - - - depth - - - Maximum nesting depth of the structure being decoded. - The value must be greater than 0, - and less than or equal to 2147483647. - - Callers should use reasonably small values, - because larger depths require more buffer space and will - increase the recursion depth, unlike the current json_decode implementation. - - - - - - - - &reftitle.returnvalues; - - Returns the value encoded in json in appropriate - PHP type. Values true, false and - null are returned as &true;, &false; and &null; - respectively. - - - - - &reftitle.errors; - - If json is invalid, a SimdJsonException is thrown as of PECL simdjson 2.1.0, - while previously, a RuntimeException was thrown. - - - If depth is outside the allowed range, - a SimdJsonValueError is thrown as of PECL simdjson 3.0.0, - while previously, an error of level E_WARNING was raised. - - - - - &reftitle.examples; - - - <function>simdjson_decode</function> examples - - -]]> - - &example.outputs; - - - int(1) - ["b"]=> - int(2) - ["c"]=> - int(3) -} -array(3) { - ["a"]=> - int(1) - ["b"]=> - int(2) - ["c"]=> - int(3) -} -]]> - - - - Accessing invalid object properties - - Accessing elements within an object that contain characters not - permitted under PHP's naming convention (e.g. the hyphen) can be - accomplished by encapsulating the element name within braces and the apostrophe. - - -{'foo-bar'}; // 12345 - -?> -]]> - - - - common mistakes using <function>simdjson_decode</function> - - -]]> - - - - <parameter>depth</parameter> errors - - array -> array -> string) -$json = json_encode( - [ - 1 => [ - 'English' => [ - 'One', - 'January' - ], - 'French' => [ - 'Une', - 'Janvier' - ] - ] - ] -); - -// Show the errors for different depths. -var_dump(simdjson_decode($json, true, 4)); -try { - var_dump(simdjson_decode($json, true, 3)); -} catch (SimdJsonException $e) { - echo "Caught: ", $e->getMessage(), "\n"; -} -?> -]]> - - &example.outputs; - - - array(2) { - ["English"]=> - array(2) { - [0]=> - string(3) "One" - [1]=> - string(7) "January" - } - ["French"]=> - array(2) { - [0]=> - string(3) "Une" - [1]=> - string(7) "Janvier" - } - } -} -Caught: The JSON document was too deep (too many nested objects and arrays) -]]> - - - - <function>simdjson_decode</function> of large integers - - -]]> - - &example.outputs; - - - float(1.2345678901235E+19) -} -]]> - - - - - - - &reftitle.notes; - - - The JSON spec is not JavaScript, but a subset of JavaScript. - - - - - In the event of a failure to decode, - a SimdJsonException is thrown - and SimdJsonException::getCode and - SimdJsonException::getMessage can be used - to determine the exact nature of the error. - - - - - - &reftitle.seealso; - - json_encode - json_decode - - - - diff --git a/reference/simdjson/functions/simdjson-is-valid.xml b/reference/simdjson/functions/simdjson-is-valid.xml deleted file mode 100644 index e7eff39b35b2..000000000000 --- a/reference/simdjson/functions/simdjson-is-valid.xml +++ /dev/null @@ -1,186 +0,0 @@ - - - - simdjson_is_valid - Check if a JSON string is valid - - - - &reftitle.description; - - boolsimdjson_is_valid - stringjson - intdepth512 - - - Takes a JSON encoded string and returns true if it is valid. - - - - - &reftitle.parameters; - - - json - - - The json string being validated. - - - This function only works with UTF-8 encoded strings. - - - This function validates inputs which - json_decode can decode, - provided that they are less than 4 GiB long. - - - - - depth - - - Maximum nesting depth of the structure being validated. - The value must be greater than 0, - and less than or equal to 2147483647. - - Callers should use reasonably small values, - because larger depths require more buffer space and will - increase the recursion depth, unlike the current json_decode implementation. - - - - - - - - &reftitle.returnvalues; - - Returns &true; if json is a valid JSON - string, &false; otherwise. - - - - - &reftitle.errors; - - If json is longer than 4 GiB, a SimdJsonException is thrown as of PECL simdjson 2.1.0, - while previously, a RuntimeException was thrown. - - - If depth is outside the allowed range, - a SimdJsonValueError is thrown as of PECL simdjson 3.0.0, - while previously, an error of level E_WARNING was raised. - - - - - &reftitle.examples; - - - <function>simdjson_decode</function> examples - - -]]> - - &example.outputs; - - - - - - <parameter>depth</parameter> errors - - array -> array -> string) -$json = json_encode( - [ - 1 => [ - 'English' => [ - 'One', - 'January' - ], - 'French' => [ - 'Une', - 'Janvier' - ] - ] - ] -); - -// Show the errors for different depths. -var_dump(simdjson_is_valid($json, 4)); -var_dump(simdjson_is_valid($json, 3)); -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.notes; - - - The JSON spec is not JavaScript, but a subset of JavaScript. - - - - - In the event of a failure to decode, - a SimdJsonException is thrown - and SimdJsonException::getCode and - SimdJsonException::getMessage can be used - to determine the exact nature of the error. - - - - - - &reftitle.seealso; - - json_encode - json_decode - - - - diff --git a/reference/simdjson/functions/simdjson-key-count.xml b/reference/simdjson/functions/simdjson-key-count.xml deleted file mode 100644 index 997d77030031..000000000000 --- a/reference/simdjson/functions/simdjson-key-count.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - simdjson_key_count - Returns the value at a JSON pointer. - - - - &reftitle.description; - - intsimdjson_key_count - stringjson - stringkey - intdepth512 - boolthrow_if_uncountable&false; - - - Count the number of elements of the object/array found at the requested JSON pointer. - - - - - &reftitle.parameters; - - - json - - - The json string being queried. - - - - - key - - - The JSON pointer string. - - - - - depth - - - Maximum nesting depth of the structure being validated. - The value must be greater than 0, - and less than or equal to 2147483647. - - Callers should use reasonably small values, - because larger depths require more buffer space and will - increase the recursion depth, unlike the current json_decode implementation. - - - - - throw_if_uncountable - - - When true, a SimdJsonException will be thrown - instead of returning 0 when the value the JSON pointer points to - is neither an object nor an array. - - - - - - - - &reftitle.returnvalues; - - Returns an &integer; with the number of elements of the value at the given JSON pointer. - - - - - - diff --git a/reference/simdjson/functions/simdjson-key-exists.xml b/reference/simdjson/functions/simdjson-key-exists.xml deleted file mode 100644 index e46e1c227371..000000000000 --- a/reference/simdjson/functions/simdjson-key-exists.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - simdjson_key_exists - Check if the JSON contains the value referred to by a JSON pointer. - - - - &reftitle.description; - - boolsimdjson_key_exists - stringjson - stringkey - intdepth - - - Count the number of elements of the object/array found at the requested JSON pointer. - - - - - &reftitle.parameters; - - - json - - - The json string being queried. - - - - - key - - - The JSON pointer string. - - - - - depth - - - Maximum nesting depth of the structure being validated. - The value must be greater than 0, - and less than or equal to 2147483647. - - Callers should use reasonably small values, - because larger depths require more buffer space and will - increase the recursion depth, unlike the current json_decode implementation. - - - - - throw_if_uncountable - - - When true, a SimdJsonException will be thrown - instead of returning 0 when the value the JSON pointer points to - is neither an object nor an array. - - - - - - - - &reftitle.returnvalues; - - Returns &true; if the JSON pointer is valid and refers to a value found within a valid JSON string. - Returns &false; if the JSON is valid but does not contain the JSON pointer. - - - - - - diff --git a/reference/simdjson/functions/simdjson-key-value.xml b/reference/simdjson/functions/simdjson-key-value.xml deleted file mode 100644 index 7d736da450d0..000000000000 --- a/reference/simdjson/functions/simdjson-key-value.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - simdjson_key_value - Decodes the value of a JSON string located at the requested JSON pointer. - - - - &reftitle.description; - - mixedsimdjson_key_value - stringjson - stringkey - boolassociative&false; - intdepth512 - - - Decodes and returns the value found at the requested JSON pointer. - - - - - &reftitle.parameters; - - - json - - - The json string being queried and decoded. - - - This function only works with UTF-8 encoded strings. - - - This function parses valid inputs which - json_decode can decode, - provided that they are less than 4 GiB long. - - - - - key - - - The JSON pointer string. - - - - - associative - - - When &true;, JSON objects will be returned as - associative &array;s; when &false;, JSON objects will be returned as &object;s. - - - - - depth - - - Maximum nesting depth of the structure being decoded. - The value must be greater than 0, - and less than or equal to 2147483647. - - Callers should use reasonably small values, - because larger depths require more buffer space and will - increase the recursion depth, unlike the current json_decode implementation. - - - - - - - - &reftitle.returnvalues; - - Returns the part of the value encoded in json - that key refers to in appropriate - PHP type. Values true, false and - null are returned as &true;, &false; and &null; - respectively. - - - - &reftitle.errors; - - If json or key is invalid, - or key could not be found within json, - a SimdJsonException is thrown as of PECL simdjson 2.1.0, - while previously, a RuntimeException was thrown. - - - If depth is outside the allowed range, - a SimdJsonValueError is thrown as of PECL simdjson 3.0.0, - while previously, an error of level E_WARNING was raised. - - - - &reftitle.seealso; - - json_encode - simdjson_decode - - - - diff --git a/reference/simdjson/reference.xml b/reference/simdjson/reference.xml deleted file mode 100644 index 65a6a5261552..000000000000 --- a/reference/simdjson/reference.xml +++ /dev/null @@ -1,27 +0,0 @@ - - - Simdjson &Functions; - - &reference.simdjson.entities.functions; - - - diff --git a/reference/simdjson/setup.xml b/reference/simdjson/setup.xml deleted file mode 100644 index ff85d8adffe9..000000000000 --- a/reference/simdjson/setup.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - &reftitle.setup; - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;simdjson. - - - &pecl.windows.download.avail; - -
    -
    - diff --git a/reference/simdjson/simdjsonexception.xml b/reference/simdjson/simdjsonexception.xml deleted file mode 100644 index f182e85cff5c..000000000000 --- a/reference/simdjson/simdjsonexception.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - The SimdJsonException class - SimdJsonException - - - - -
    - &reftitle.intro; - - Exception thrown if simdjson_decode, - simdjson_key_count, - simdjson_key_exists, - or simdjson_key_value. - - For possible values see the simdjson error codes constants. - -
    - - -
    - &reftitle.classsynopsis; - - - - SimdJsonException - - - - - SimdJsonException - - - - extends - RuntimeException - - - - - &InheritedProperties; - - - - - -
    - -
    -
    - diff --git a/reference/simdjson/simdjsonvalueerror.xml b/reference/simdjson/simdjsonvalueerror.xml deleted file mode 100644 index 757e6696d4da..000000000000 --- a/reference/simdjson/simdjsonvalueerror.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - The SimdJsonValueError class - SimdJsonValueError - - - - -
    - &reftitle.intro; - - A SimdJsonValueError is thrown when the - type of an argument to a function from simdjson is correct but the value - of it is incorrect. - E.g. when the JSON decoding $depth is not positive or the $depth is too large. - -
    - - -
    - &reftitle.classsynopsis; - - - - SimdJsonValueError - - - - - SimdJsonValueError - - - - extends - ValueError - - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PHP 8.0.0 - - SimdJsonValueError extends ValueError - now instead of Error. - - - - - -
    -
    - -
    - diff --git a/reference/simdjson/versions.xml b/reference/simdjson/versions.xml deleted file mode 100644 index 99708937c54c..000000000000 --- a/reference/simdjson/versions.xml +++ /dev/null @@ -1,36 +0,0 @@ - - - - - - - - - - - - - - - - - diff --git a/reference/solr/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/solr/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/solr/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/solr/book.xml b/reference/solr/book.xml deleted file mode 100644 index 27ff135b18e0..000000000000 --- a/reference/solr/book.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - Apache Solr - Solr - - - &reftitle.intro; - - The Solr extension allows you to communicate effectively with the Apache Solr Server in PHP. - - - The Solr extension is an extremely fast, light-weight, feature-rich library that allows PHP developers to communicate effectively with Solr server instances. - Versions 1.x of The PECL Extension supports Apache Solr Server 1.3-3.x - Versions 2.x of The PECL Extension supports Apache Solr Server 4.0+ - There are built-in tools to add documents and make updates to the solr server. - It also contains tools that allows you to build advanced queries to the server when searching for documents. - - - &reference.solr.setup; - &reference.solr.constants; - &reference.solr.reference; - - &reference.solr.examples; - - &reference.solr.solrutils; - - &reference.solr.solrinputdocument; - &reference.solr.solrdocument; - &reference.solr.solrdocumentfield; - - &reference.solr.solrobject; - - &reference.solr.solrclient; - - &reference.solr.solrresponse; - &reference.solr.solrqueryresponse; - &reference.solr.solrupdateresponse; - &reference.solr.solrpingresponse; - &reference.solr.solrgenericresponse; - - &reference.solr.solrparams; - &reference.solr.solrmodifiableparams; - &reference.solr.solrquery; - &reference.solr.solrdismaxquery; - &reference.solr.solrcollapsefunction; - - &reference.solr.solrexception; - &reference.solr.solrclientexception; - &reference.solr.solrserverexception; - &reference.solr.solrillegalargumentexception; - &reference.solr.solrillegaloperationexception; - &reference.solr.solrmissingmandatoryparameterexception; - - - - - - diff --git a/reference/solr/constants.xml b/reference/solr/constants.xml deleted file mode 100644 index 3892dba5ffef..000000000000 --- a/reference/solr/constants.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - - - - SOLR_MAJOR_VERSION - (int) - - - - - - - - - SOLR_MINOR_VERSION - (int) - - - - - - - - - SOLR_PATCH_VERSION - (int) - - - - - - - - - SOLR_EXTENSION_VERSION - (string) - - - - - - - - - - - - diff --git a/reference/solr/examples.xml b/reference/solr/examples.xml deleted file mode 100644 index 364e1641c513..000000000000 --- a/reference/solr/examples.xml +++ /dev/null @@ -1,1280 +0,0 @@ - - - - - &reftitle.examples; - - - Examples of how to use the Apache Solr extension in PHP - - - Contents of the BootStrap file - - - -]]> - - - - - - Adding a document to the index - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$client = new SolrClient($options); - -$doc = new SolrInputDocument(); - -$doc->addField('id', 334455); -$doc->addField('cat', 'Software'); -$doc->addField('cat', 'Lucene'); - -$updateResponse = $client->addDocument($doc); - -print_r($updateResponse->getResponse()); - -?> - -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [status] => 0 - [QTime] => 446 - ) - -) -]]> - - - - - Merging one document into another document - - addField('id', 1123); - -$doc->features = "PHP Client Side"; -$doc->features = "Fast development cycles"; - -$doc['cat'] = 'Software'; -$doc['cat'] = 'Custom Search'; -$doc->cat = 'Information Technology'; - -$second_doc->addField('cat', 'Lucene Search'); - -$second_doc->merge($doc, true); - -print_r($second_doc->toArray()); - - -?> - -]]> - - &example.outputs.similar; - - 0 - [field_count] => 3 - [fields] => Array - ( - [0] => SolrDocumentField Object - ( - [name] => cat - [boost] => 0 - [values] => Array - ( - [0] => Software - [1] => Custom Search - [2] => Information Technology - ) - - ) - - [1] => SolrDocumentField Object - ( - [name] => id - [boost] => 0 - [values] => Array - ( - [0] => 1123 - ) - - ) - - [2] => SolrDocumentField Object - ( - [name] => features - [boost] => 0 - [values] => Array - ( - [0] => PHP Client Side - [1] => Fast development cycles - ) - - ) - - ) - -) -]]> - - - - - - Searching for documents - SolrObject responses - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$client = new SolrClient($options); - -$query = new SolrQuery(); - -$query->setQuery('lucene'); - -$query->setStart(0); - -$query->setRows(50); - -$query->addField('cat')->addField('features')->addField('id')->addField('timestamp'); - -$query_response = $client->query($query); - -$response = $query_response->getResponse(); - -print_r($response); - -?> - -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [status] => 0 - [QTime] => 1 - [params] => SolrObject Object - ( - [wt] => xml - [rows] => 50 - [start] => 0 - [indent] => on - [q] => lucene - [fl] => cat,features,id,timestamp - [version] => 2.2 - ) - - ) - - [response] => SolrObject Object - ( - [numFound] => 3 - [start] => 0 - [docs] => Array - ( - [0] => SolrObject Object - ( - [cat] => Array - ( - [0] => Software - [1] => Lucene - ) - - [id] => 334456 - ) - - [1] => SolrObject Object - ( - [cat] => Array - ( - [0] => Software - [1] => Lucene - ) - - [id] => 334455 - ) - - [2] => SolrObject Object - ( - [cat] => Array - ( - [0] => software - [1] => search - ) - - [features] => Array - ( - [0] => Advanced Full-Text Search Capabilities using Lucene - [1] => Optimized for High Volume Web Traffic - [2] => Standards Based Open Interfaces - XML and HTTP - [3] => Comprehensive HTML Administration Interfaces - [4] => Scalability - Efficient Replication to other Solr Search Servers - [5] => Flexible and Adaptable with XML configuration and Schema - [6] => Good unicode support: héllo (hello with an accent over the e) - ) - - [id] => SOLR1000 - [timestamp] => 2009-09-04T20:38:55.906 - ) - - ) - - ) - -) -]]> - - - - - Searching for documents - SolrDocument responses - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$client = new SolrClient($options); - -$query = new SolrQuery(); - -$query->setQuery('lucene'); - -$query->setStart(0); - -$query->setRows(50); - -$query->addField('cat')->addField('features')->addField('id')->addField('timestamp'); - -$query_response = $client->query($query); - -$query_response->setParseMode(SolrQueryResponse::PARSE_SOLR_DOC); - -$response = $query_response->getResponse(); - -print_r($response); - -?> - -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [status] => 0 - [QTime] => 1 - [params] => SolrObject Object - ( - [wt] => xml - [rows] => 50 - [start] => 0 - [indent] => on - [q] => lucene - [fl] => cat,features,id,timestamp - [version] => 2.2 - ) - - ) - - [response] => SolrObject Object - ( - [numFound] => 3 - [start] => 0 - [docs] => Array - ( - [0] => SolrDocument Object - ( - [_hashtable_index:SolrDocument:private] => 19740 - ) - - [1] => SolrDocument Object - ( - [_hashtable_index:SolrDocument:private] => 25485 - ) - - [2] => SolrDocument Object - ( - [_hashtable_index:SolrDocument:private] => 25052 - ) - - ) - - ) - -) -]]> - - - - - Simple TermsComponent example - basic - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$client = new SolrClient($options); - -$query = new SolrQuery(); - -$query->setTerms(true); - -$query->setTermsField('cat'); - -$updateResponse = $client->query($query); - -print_r($updateResponse->getResponse()); - -?> -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [status] => 0 - [QTime] => 2 - ) - - [terms] => SolrObject Object - ( - [cat] => SolrObject Object - ( - [electronics] => 14 - [Lucene] => 4 - [Software] => 4 - [memory] => 3 - [card] => 2 - [connector] => 2 - [drive] => 2 - [graphics] => 2 - [hard] => 2 - [monitor] => 2 - ) - - ) - -) - -]]> - - - - - Simple TermsComponent example - using a prefix - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$client = new SolrClient($options); - -$query = new SolrQuery(); - -$query->setTerms(true); - -/* Return only terms starting with $prefix */ -$prefix = 'c'; - -$query->setTermsField('cat')->setTermsPrefix($prefix); - -$updateResponse = $client->query($query); - -print_r($updateResponse->getResponse()); - -?> -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [status] => 0 - [QTime] => 1 - ) - - [terms] => SolrObject Object - ( - [cat] => SolrObject Object - ( - [card] => 2 - [connector] => 2 - [camera] => 1 - [copier] => 1 - ) - - ) - -) -]]> - - - - - Simple TermsComponent example - specifying a minimum frequency - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$client = new SolrClient($options); - -$query = new SolrQuery(); - -$query->setTerms(true); - -/* Return only terms starting with $prefix */ -$prefix = 'c'; - -/* Return only terms with a frequency of 2 or greater */ -$min_frequency = 2; - -$query->setTermsField('cat')->setTermsPrefix($prefix)->setTermsMinCount($min_frequency); - -$updateResponse = $client->query($query); - -print_r($updateResponse->getResponse()); - -?> -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [status] => 0 - [QTime] => 0 - ) - - [terms] => SolrObject Object - ( - [cat] => SolrObject Object - ( - [card] => 2 - [connector] => 2 - ) - - ) - -) -]]> - - - - -Simple Facet Example - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$client = new SolrClient($options); - -$query = new SolrQuery('*:*'); - -$query->setFacet(true); - -$query->addFacetField('cat')->addFacetField('name')->setFacetMinCount(2); - -$updateResponse = $client->query($query); - -$response_array = $updateResponse->getResponse(); - -$facet_data = $response_array->facet_counts->facet_fields; - -print_r($facet_data); - -?> -]]> - -&example.outputs.similar; - - SolrObject Object - ( - [electronics] => 14 - [memory] => 3 - [Lucene] => 2 - [Software] => 2 - [card] => 2 - [connector] => 2 - [drive] => 2 - [graphics] => 2 - [hard] => 2 - [monitor] => 2 - [search] => 2 - [software] => 2 - ) - - [name] => SolrObject Object - ( - [gb] => 6 - [1] => 3 - [184] => 3 - [2] => 3 - [3200] => 3 - [400] => 3 - [500] => 3 - [ddr] => 3 - [i] => 3 - [ipod] => 3 - [memori] => 3 - [pc] => 3 - [pin] => 3 - [pod] => 3 - [sdram] => 3 - [system] => 3 - [unbuff] => 3 - [canon] => 2 - [corsair] => 2 - [drive] => 2 - [hard] => 2 - [mb] => 2 - [n] => 2 - [power] => 2 - [retail] => 2 - [video] => 2 - [x] => 2 - ) - -) -]]> - - - - - Simple Facet Example - with optional field override for mincount - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$client = new SolrClient($options); - -$query = new SolrQuery('*:*'); - -$query->setFacet(true); - -$query->addFacetField('cat')->addFacetField('name')->setFacetMinCount(2)->setFacetMinCount(4, 'name'); - -$updateResponse = $client->query($query); - -$response_array = $updateResponse->getResponse(); - -$facet_data = $response_array->facet_counts->facet_fields; - -print_r($facet_data); - -?> -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [electronics] => 14 - [memory] => 3 - [Lucene] => 2 - [Software] => 2 - [card] => 2 - [connector] => 2 - [drive] => 2 - [graphics] => 2 - [hard] => 2 - [monitor] => 2 - [search] => 2 - [software] => 2 - ) - - [name] => SolrObject Object - ( - [gb] => 6 - ) - -) -]]> - - - - -Facet Date Example - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$client = new SolrClient($options); - -$query = new SolrQuery('*:*'); - -$query->setFacet(true); - -$query->addFacetDateField('manufacturedate_dt'); - -$query->setFacetDateStart('2006-02-13T00:00:00Z'); - -$query->setFacetDateEnd('2012-02-13T00:00:00Z'); - -$query->setFacetDateGap('+1YEAR'); - -$query->setFacetDateHardEnd(1); - -$query->addFacetDateOther('before'); - -$updateResponse = $client->query($query); - -$response_array = $updateResponse->getResponse(); - -$facet_data = $response_array->facet_counts->facet_dates; - -print_r($facet_data); - -?> -]]> - -&example.outputs.similar; - - SolrObject Object - ( - [2006-02-13T00:00:00Z] => 9 - [2007-02-13T00:00:00Z] => 0 - [2008-02-13T00:00:00Z] => 0 - [2009-02-13T00:00:00Z] => 0 - [2010-02-13T00:00:00Z] => 0 - [2011-02-13T00:00:00Z] => 0 - [gap] => +1YEAR - [start] => 2006-02-13T00:00:00Z - [end] => 2012-02-13T00:00:00Z - [before] => 2 - ) - -) -]]> - - - - - Connecting to SSL-Enabled Server - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, - 'timeout' => SOLR_SERVER_TIMEOUT, - 'secure' => SOLR_SECURE, - 'ssl_cert' => SOLR_SSL_CERT_ONLY, - 'ssl_key' => SOLR_SSL_KEY, - 'ssl_keypassword' => SOLR_SSL_KEYPASSWORD, - 'ssl_cainfo' => SOLR_SSL_CAINFO, -); - -$client = new SolrClient($options); - -$query = new SolrQuery('*:*'); - -$query->setFacet(true); - -$query->addFacetField('cat')->addFacetField('name')->setFacetMinCount(2)->setFacetMinCount(4, 'name'); - -$updateResponse = $client->query($query); - -$response_array = $updateResponse->getResponse(); - -$facet_data = $response_array->facet_counts->facet_fields; - -print_r($facet_data); - -?> -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [electronics] => 14 - [memory] => 3 - [Lucene] => 2 - [Software] => 2 - [card] => 2 - [connector] => 2 - [drive] => 2 - [graphics] => 2 - [hard] => 2 - [monitor] => 2 - [search] => 2 - [software] => 2 - ) - - [name] => SolrObject Object - ( - [gb] => 6 - ) - -) -]]> - - - - - - Collapsing a <type>SolrQuery</type> - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, - 'path' => SOLR_SERVER_PATH -); - -$client = new SolrClient($options); - -$query = new SolrQuery('*:*'); - -$collapseFunction = new SolrCollapseFunction('manu_id_s'); - -$collapseFunction -->setSize(2) -->setNullPolicy(SolrCollapseFunction::NULLPOLICY_IGNORE); - -$query -->collapse($collapseFunction) -->setRows(4); - -$queryResponse = $client->query($query); - -$response = $queryResponse->getResponse(); - -print_r($response); -?> -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [status] => 0 - [QTime] => 1 - [params] => SolrObject Object - ( - [q] => *:* - [indent] => on - [fq] => {!collapse field=manu_id_s size=2 nullPolicy=ignore} - [rows] => 4 - [version] => 2.2 - [wt] => xml - ) - - ) - - [response] => SolrObject Object - ( - [numFound] => 14 - [start] => 0 - [docs] => Array - ( - [0] => SolrObject Object - ( - [id] => SP2514N - [name] => Array - ( - [0] => Samsung SpinPoint P120 SP2514N - hard drive - 250 GB - ATA-133 - ) - - [manu] => Array - ( - [0] => Samsung Electronics Co. Ltd. - ) - - [manu_id_s] => samsung - [cat] => Array - ( - [0] => electronics - [1] => hard drive - ) - - [features] => Array - ( - [0] => 7200RPM, 8MB cache, IDE Ultra ATA-133 - [1] => NoiseGuard, SilentSeek technology, Fluid Dynamic Bearing (FDB) motor - ) - - [price] => Array - ( - [0] => 92 - ) - - [popularity] => Array - ( - [0] => 6 - ) - - [inStock] => Array - ( - [0] => 1 - ) - - [manufacturedate_dt] => 2006-02-13T15:26:37Z - [store] => Array - ( - [0] => 35.0752,-97.032 - ) - - [_version_] => 1510294336412057600 - ) - - [1] => SolrObject Object - ( - [id] => 6H500F0 - [name] => Array - ( - [0] => Maxtor DiamondMax 11 - hard drive - 500 GB - SATA-300 - ) - - [manu] => Array - ( - [0] => Maxtor Corp. - ) - - [manu_id_s] => maxtor - [cat] => Array - ( - [0] => electronics - [1] => hard drive - ) - - [features] => Array - ( - [0] => SATA 3.0Gb/s, NCQ - [1] => 8.5ms seek - [2] => 16MB cache - ) - - [price] => Array - ( - [0] => 350 - ) - - [popularity] => Array - ( - [0] => 6 - ) - - [inStock] => Array - ( - [0] => 1 - ) - - [store] => Array - ( - [0] => 45.17614,-93.87341 - ) - - [manufacturedate_dt] => 2006-02-13T15:26:37Z - [_version_] => 1510294336449806336 - ) - - [2] => SolrObject Object - ( - [id] => F8V7067-APL-KIT - [name] => Array - ( - [0] => Belkin Mobile Power Cord for iPod w/ Dock - ) - - [manu] => Array - ( - [0] => Belkin - ) - - [manu_id_s] => belkin - [cat] => Array - ( - [0] => electronics - [1] => connector - ) - - [features] => Array - ( - [0] => car power adapter, white - ) - - [weight] => Array - ( - [0] => 4 - ) - - [price] => Array - ( - [0] => 19.95 - ) - - [popularity] => Array - ( - [0] => 1 - ) - - [inStock] => Array - ( - [0] => - ) - - [store] => Array - ( - [0] => 45.18014,-93.87741 - ) - - [manufacturedate_dt] => 2005-08-01T16:30:25Z - [_version_] => 1510294336458194944 - ) - - [3] => SolrObject Object - ( - [id] => MA147LL/A - [name] => Array - ( - [0] => Apple 60 GB iPod with Video Playback Black - ) - - [manu] => Array - ( - [0] => Apple Computer Inc. - ) - - [manu_id_s] => apple - [cat] => Array - ( - [0] => electronics - [1] => music - ) - - [features] => Array - ( - [0] => iTunes, Podcasts, Audiobooks - [1] => Stores up to 15,000 songs, 25,000 photos, or 150 hours of video - [2] => 2.5-inch, 320x240 color TFT LCD display with LED backlight - [3] => Up to 20 hours of battery life - [4] => Plays AAC, MP3, WAV, AIFF, Audible, Apple Lossless, H.264 video - [5] => Notes, Calendar, Phone book, Hold button, Date display, Photo wallet, Built-in games, JPEG photo playback, Upgradeable firmware, USB 2.0 compatibility, Playback speed control, Rechargeable capability, Battery level indication - ) - - [includes] => Array - ( - [0] => earbud headphones, USB cable - ) - - [weight] => Array - ( - [0] => 5.5 - ) - - [price] => Array - ( - [0] => 399 - ) - - [popularity] => Array - ( - [0] => 10 - ) - - [inStock] => Array - ( - [0] => 1 - ) - - [store] => Array - ( - [0] => 37.7752,-100.0232 - ) - - [manufacturedate_dt] => 2005-10-12T08:00:00Z - [_version_] => 1510294336562003968 - ) - - ) - - ) - -) -]]> - - - - - Solr Real Time Get (RTG) example <function>SolrClient::getById</function> - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, - 'path' => SOLR_SERVER_PATH -); - -$client = new SolrClient($options); -$response = $client->getById('GB18030TEST'); -print_r($response->getResponse()); - -?> -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [id] => GB18030TEST - [name] => Array - ( - [0] => Test with some GB18030 encoded characters - ) - - [features] => Array - ( - [0] => No accents here - [1] => 这是一个功能 - [2] => This is a feature (translated) - [3] => 这份文件是很有光泽 - [4] => This document is very shiny (translated) - ) - - [price] => Array - ( - [0] => 0 - ) - - [inStock] => Array - ( - [0] => 1 - ) - - [_version_] => 1510294336239042560 - ) - -) -]]> - - - - - - - diff --git a/reference/solr/functions/solr-get-version.xml b/reference/solr/functions/solr-get-version.xml deleted file mode 100644 index abc02eaa4598..000000000000 --- a/reference/solr/functions/solr-get-version.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - solr_get_version - Returns the current version of the Apache Solr extension - - - - &reftitle.description; - - stringsolr_get_version - - - - This function returns the current version of the extension as a string. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - It returns a string on success and &false; on failure. - - - - - &reftitle.errors; - - This function throws no errors or exceptions. - - - - - &reftitle.examples; - - - <function>solr_get_version</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - SolrUtils::getSolrVersion - - - - - - - diff --git a/reference/solr/reference.xml b/reference/solr/reference.xml deleted file mode 100644 index b3ccec9481f1..000000000000 --- a/reference/solr/reference.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - Solr &Functions; - - &reference.solr.entities.functions; - - - - - diff --git a/reference/solr/setup.xml b/reference/solr/setup.xml deleted file mode 100644 index a4fc6854e101..000000000000 --- a/reference/solr/setup.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - - The libxml and curl extensions must also be enabled for - the Apache Solr extension to be available. - - - libxml2 2.6.31 or later is required. - - - libcurl 7.18.0 or later is also required. - - - The above library versions are required and attempting to - hack the code to make it compile is strongly discouraged. - It will fail, possibly with errors that could be hard to debug. - -
    - - -
    - &reftitle.install; - - &pecl.info; - &url.pecl.package;solr. - - - For help and support, please visit the extension Google group - Apache Solr PHP Extension. - - - &pecl.windows.download.avail; - - - - The solr module can be compiled in debug mode by passing the flag to configure. - - - When building manually, be sure to include curl and libxml support within the build. - - -
    - - -
    - - - diff --git a/reference/solr/solrclient.xml b/reference/solr/solrclient.xml deleted file mode 100644 index 867f26cbc6e1..000000000000 --- a/reference/solr/solrclient.xml +++ /dev/null @@ -1,237 +0,0 @@ - - - - - - The SolrClient class - SolrClient - - - - -
    - &reftitle.intro; - - Used to send requests to a Solr server. Currently, cloning and serialization of SolrClient instances is not supported. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrClient - - - - - final - SolrClient - - - - &Constants; - - const - int - SolrClient::SEARCH_SERVLET_TYPE - 1 - - - const - int - SolrClient::UPDATE_SERVLET_TYPE - 2 - - - const - int - SolrClient::THREADS_SERVLET_TYPE - 4 - - - const - int - SolrClient::PING_SERVLET_TYPE - 8 - - - const - int - SolrClient::TERMS_SERVLET_TYPE - 16 - - - const - int - SolrClient::SYSTEM_SERVLET_TYPE - 32 - - - const - string - SolrClient::DEFAULT_SEARCH_SERVLET - select - - - const - string - SolrClient::DEFAULT_UPDATE_SERVLET - update - - - const - string - SolrClient::DEFAULT_THREADS_SERVLET - admin/threads - - - const - string - SolrClient::DEFAULT_PING_SERVLET - admin/ping - - - const - string - SolrClient::DEFAULT_TERMS_SERVLET - terms - - - const - string - SolrClient::DEFAULT_SYSTEM_SERVLET - admin/system - - - &Methods; - - - - - - -
    - - -
    - &reftitle.constants; - - - - SolrClient::SEARCH_SERVLET_TYPE - - Used when updating the search servlet. - - - - - SolrClient::UPDATE_SERVLET_TYPE - - Used when updating the update servlet. - - - - - SolrClient::THREADS_SERVLET_TYPE - - Used when updating the threads servlet. - - - - - SolrClient::PING_SERVLET_TYPE - - Used when updating the ping servlet. - - - - - SolrClient::TERMS_SERVLET_TYPE - - Used when updating the terms servlet. - - - - - SolrClient::SYSTEM_SERVLET_TYPE - - Used when retrieving system information from the system servlet. - - - - - SolrClient::DEFAULT_SEARCH_SERVLET - - This is the initial value for the search servlet. - - - - - SolrClient::DEFAULT_UPDATE_SERVLET - - This is the initial value for the update servlet. - - - - - SolrClient::DEFAULT_THREADS_SERVLET - - This is the initial value for the threads servlet. - - - - - SolrClient::DEFAULT_PING_SERVLET - - This is the initial value for the ping servlet. - - - - - SolrClient::DEFAULT_TERMS_SERVLET - - This is the initial value for the terms servlet used for the TermsComponent - - - - - SolrClient::DEFAULT_SYSTEM_SERVLET - - This is the initial value for the system servlet used to obtain Solr Server information - - - - -
    - - - -
    - - &reference.solr.entities.solrclient; - -
    - - diff --git a/reference/solr/solrclient/adddocument.xml b/reference/solr/solrclient/adddocument.xml deleted file mode 100644 index fad5cde278d2..000000000000 --- a/reference/solr/solrclient/adddocument.xml +++ /dev/null @@ -1,229 +0,0 @@ - - - - - - SolrClient::addDocument - Adds a document to the index - - - - &reftitle.description; - - public SolrUpdateResponseSolrClient::addDocument - SolrInputDocumentdoc - booloverwrite&true; - intcommitWithin0 - - - This method adds a document to the index. - - - - - - &reftitle.parameters; - - - - doc - - - The SolrInputDocument instance. - - - - - overwrite - - - Whether to overwrite existing document or not. If &false; there will be duplicates (several documents with the same ID). - - - - - PECL Solr < 2.0 $allowDups was used instead of $overwrite, which does the same functionality with exact opposite bool flag. - - - $allowDups = false is the same as $overwrite = true - - - - - - commitWithin - - - Number of milliseconds within which to auto commit this document. Available since Solr 1.4 . Default (0) means disabled. - - - When this value specified, it leaves the control of when to do the commit - to Solr itself, optimizing number of commits to a minimum while still - fulfilling - the update latency requirements, and Solr will automatically do a commit - when the oldest add in the buffer is due. - - - - - - - - - &reftitle.returnvalues; - - Returns a SolrUpdateResponse object or throws an Exception on failure. - - - - - &reftitle.errors; - - Throws SolrClientException if the client had failed, or there was a connection issue. - - - Throws SolrServerException if the Solr Server had failed to process the request. - - - - - &reftitle.examples; - - - <methodname>SolrClient::addDocument</methodname> example - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$client = new SolrClient($options); - -$doc = new SolrInputDocument(); - -$doc->addField('id', 334455); -$doc->addField('cat', 'Software'); -$doc->addField('cat', 'Lucene'); - -$updateResponse = $client->addDocument($doc); - -// you will have to commit changes to be written if you didn't use $commitWithin -$client->commit(); - -print_r($updateResponse->getResponse()); - -?> - -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [status] => 0 - [QTime] => 1 - ) - -) - -]]> - - - - - - <methodname>SolrClient::addDocument</methodname> example 2 - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$client = new SolrClient($options); - -$doc = new SolrInputDocument(); - -$doc->addField('id', 334455); -$doc->addField('cat', 'Software'); -$doc->addField('cat', 'Lucene'); - -// No need to call commit() because $commitWithin is passed, so Solr Server will auto commit within 10 seconds -$updateResponse = $client->addDocument($doc, false, 10000); - -print_r($updateResponse->getResponse()); - -?> - -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [status] => 0 - [QTime] => 1 - ) - -) - -]]> - - - - - - - - &reftitle.seealso; - - - SolrClient::addDocuments - SolrClient::commit - - - - - - - diff --git a/reference/solr/solrclient/adddocuments.xml b/reference/solr/solrclient/adddocuments.xml deleted file mode 100644 index 49ea37a2e0df..000000000000 --- a/reference/solr/solrclient/adddocuments.xml +++ /dev/null @@ -1,180 +0,0 @@ - - - - - - SolrClient::addDocuments - Adds a collection of SolrInputDocument instances to the index - - - - &reftitle.description; - - public voidSolrClient::addDocuments - arraydocs - booloverwrite&true; - intcommitWithin0 - - - Adds a collection of documents to the index. - - - - - - &reftitle.parameters; - - - - docs - - - An array containing the collection of SolrInputDocument instances. This array must be an actual variable. - - - - - overwrite - - - Whether to overwrite existing documents or not. If &false; there will be duplicates (several documents with the same ID). - - - - - PECL Solr < 2.0 $allowDups was used instead of $overwrite, which does the same functionality with exact opposite bool flag. - - - $allowDups = false is the same as $overwrite = true - - - - - - commitWithin - - - Number of milliseconds within which to auto commit this document. Available since Solr 1.4 . Default (0) means disabled. - - - When this value specified, it leaves the control of when to do the commit - to Solr itself, optimizing number of commits to a minimum while still - fulfilling - the update latency requirements, and Solr will automatically do a commit - when the oldest add in the buffer is due. - - - - - - - - - &reftitle.returnvalues; - - Returns a SolrUpdateResponse object or throws an exception on failure. - - - - - &reftitle.errors; - - Throws SolrClientException if the client had failed, or there was a connection issue. - - - Throws SolrServerException if the Solr Server had failed to process the request. - - - - - &reftitle.examples; - - - <methodname>SolrClient::addDocuments</methodname> example - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$client = new SolrClient($options); - -$doc = new SolrInputDocument(); - -$doc->addField('id', 334455); -$doc->addField('cat', 'Software'); -$doc->addField('cat', 'Lucene'); - -$doc2 = clone $doc; - -$doc2->deleteField('id'); -$doc2->addField('id', 334456); - -$docs = array($doc, $doc2); - -$updateResponse = $client->addDocuments($docs); - -// no changes will be written to disk unless $commitWithin is passed or SolrClient::commit is called - -print_r($updateResponse->getResponse()); - -?> -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [status] => 0 - [QTime] => 2 - ) - -) - -]]> - - - - - - - &reftitle.seealso; - - - SolrClient::addDocument - SolrClient::commit - - - - - - - diff --git a/reference/solr/solrclient/commit.xml b/reference/solr/solrclient/commit.xml deleted file mode 100644 index b3943bed8f5f..000000000000 --- a/reference/solr/solrclient/commit.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - - SolrClient::commit - Finalizes all add/deletes made to the index - - - - &reftitle.description; - - public SolrUpdateResponseSolrClient::commit - boolsoftCommit&false; - boolwaitSearcher&true; - boolexpungeDeletes&false; - - - This method finalizes all add/deletes made to the index. - - - - - - &reftitle.parameters; - - - - softCommit - - - This will refresh the 'view' of the index in a more performant manner, but without "on-disk" guarantees. (Solr4.0+) - - - A soft commit is much faster since it only makes index changes visible and does not fsync index files or write a new index descriptor. - If the JVM crashes or there is a loss of power, changes that occurred after the last hard commit will be lost. - Search collections that have near-real-time requirements (that want index changes to be quickly visible to searches) will want to soft commit often but hard commit less frequently. - - - - - waitSearcher - - - block until a new searcher is opened and registered as the main query searcher, making the changes visible. - - - - - expungeDeletes - - - Merge segments with deletes away. (Solr1.4+) - - - - - - - - - &reftitle.returnvalues; - - Returns a SolrUpdateResponse object on success or throws an exception on failure. - - - - - &reftitle.errors; - - Throws SolrClientException if the client had failed, or there was a connection issue. - - - Throws SolrServerException if the Solr Server had failed to process the request. - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL solr 1.1.0, PECL solr 2.0.0 - - $maxSegments removed - - - - PECL solr 2.0.0b - - API Changed: SolrClient::commit ([ int $maxSegments = 0 [, bool $softCommit = false [, bool $waitSearcher = true[, bool $expungeDeletes = false ]]] ) - - - - - PECL solr 0.9.2 - - Signature: SolrClient::commit ([ int $maxSegments = 1 [, bool $waitFlush = true [, bool $waitSearcher = true ]]] ). - $waitFlush: Block until index changes are flushed to disk. - - - - - - - - - &reftitle.notes; - - - PECL Solr >= 2.0 only supports Solr Server >= 4.0 - - - - - &reftitle.seealso; - - - SolrClient::optimize - SolrClient::rollback - - - - - - - diff --git a/reference/solr/solrclient/construct.xml b/reference/solr/solrclient/construct.xml deleted file mode 100644 index 882eb9ab6fd4..000000000000 --- a/reference/solr/solrclient/construct.xml +++ /dev/null @@ -1,144 +0,0 @@ - - - - - - SolrClient::__construct - Constructor for the SolrClient object - - - - &reftitle.description; - - public SolrClient::__construct - arrayclientOptions - - - Constructor for the SolrClient object - - - - - - &reftitle.parameters; - - - - clientOptions - - - This is an array containing one of the following keys : - - - - - - - - - - - - - &reftitle.errors; - - Throws SolrIllegalArgumentException on failure. - - - - - &reftitle.examples; - - - <methodname>SolrClient::__construct</methodname> example - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, - 'path' => SOLR_PATH_TO_SOLR, - 'wt' => 'xml', -); - -$client = new SolrClient($options); - -$doc = new SolrInputDocument(); - -$doc->addField('id', 334455); -$doc->addField('cat', 'Software'); -$doc->addField('cat', 'Lucene'); - -$updateResponse = $client->addDocument($doc); - -?> - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - SolrClient::getOptions - - - - - - diff --git a/reference/solr/solrclient/deletebyid.xml b/reference/solr/solrclient/deletebyid.xml deleted file mode 100644 index 7deb676bbde7..000000000000 --- a/reference/solr/solrclient/deletebyid.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - SolrClient::deleteById - Delete by Id - - - - &reftitle.description; - - public SolrUpdateResponseSolrClient::deleteById - stringid - - - Deletes the document with the specified ID. Where ID is the value of the uniqueKey field declared in the schema - - - - - - &reftitle.parameters; - - - - id - - - The value of the uniqueKey field declared in the schema - - - - - - - - - &reftitle.returnvalues; - - Returns a SolrUpdateResponse on success and throws an exception on failure. - - - - - &reftitle.errors; - - Throws SolrClientException if the client had failed, or there was a connection issue. - - - Throws SolrServerException if the Solr Server had failed to process the request. - - - - - &reftitle.seealso; - - - SolrClient::deleteByIds - SolrClient::deleteByQuery - SolrClient::deleteByQueries - - - - - - - diff --git a/reference/solr/solrclient/deletebyids.xml b/reference/solr/solrclient/deletebyids.xml deleted file mode 100644 index 19f2cfc2ccd1..000000000000 --- a/reference/solr/solrclient/deletebyids.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - SolrClient::deleteByIds - Deletes by Ids - - - - &reftitle.description; - - public SolrUpdateResponseSolrClient::deleteByIds - arrayids - - - Deletes a collection of documents with the specified set of ids. - - - - - - &reftitle.parameters; - - - - ids - - - An array of IDs representing the uniqueKey field declared in the schema for each document to be deleted. This must be an actual php variable. - - - - - - - - - &reftitle.returnvalues; - - Returns a SolrUpdateResponse on success and throws an exception on failure. - - - - - &reftitle.errors; - - Throws SolrClientException if the client had failed, or there was a connection issue. - - - Throws SolrServerException if the Solr Server had failed to process the request. - - - - - &reftitle.seealso; - - - SolrClient::deleteById - SolrClient::deleteByQuery - SolrClient::deleteByQueries - - - - - - - diff --git a/reference/solr/solrclient/deletebyqueries.xml b/reference/solr/solrclient/deletebyqueries.xml deleted file mode 100644 index 92e0e96838c4..000000000000 --- a/reference/solr/solrclient/deletebyqueries.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - SolrClient::deleteByQueries - Removes all documents matching any of the queries - - - - &reftitle.description; - - public SolrUpdateResponseSolrClient::deleteByQueries - arrayqueries - - - Removes all documents matching any of the queries - - - - - &reftitle.parameters; - - - - queries - - - The array of queries. This must be an actual php variable. - - - - - - - - - &reftitle.returnvalues; - - Returns a SolrUpdateResponse on success and throws a SolrClientException on failure. - - - - - &reftitle.errors; - - Throws SolrClientException if the client had failed, or there was a connection issue. - - - Throws SolrServerException if the Solr Server had failed to process the request. - - - - - &reftitle.seealso; - - - SolrClient::deleteById - SolrClient::deleteByIds - SolrClient::deleteByQuery - - - - - - - diff --git a/reference/solr/solrclient/deletebyquery.xml b/reference/solr/solrclient/deletebyquery.xml deleted file mode 100644 index 25d7631396de..000000000000 --- a/reference/solr/solrclient/deletebyquery.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - SolrClient::deleteByQuery - Deletes all documents matching the given query - - - - &reftitle.description; - - public SolrUpdateResponseSolrClient::deleteByQuery - stringquery - - - Deletes all documents matching the given query. - - - - - - &reftitle.parameters; - - - - query - - - The query - - - - - - - - - &reftitle.returnvalues; - - Returns a SolrUpdateResponse on success and throws an exception on failure. - - - - - &reftitle.errors; - - Throws SolrClientException if the client had failed, or there was a connection issue. - - - Throws SolrServerException if the Solr Server had failed to process the request. - - - - - &reftitle.examples; - - - <methodname>SolrQuery::deleteByQuery</methodname> example - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$client = new SolrClient($options); - -//This will erase the entire index -$client->deleteByQuery("*:*"); -$client->commit(); - -?> -]]> - - - - - - - &reftitle.seealso; - - - SolrClient::deleteById - SolrClient::deleteByIds - SolrClient::deleteByQueries - - - - - - - diff --git a/reference/solr/solrclient/destruct.xml b/reference/solr/solrclient/destruct.xml deleted file mode 100644 index 977a7d3f28d5..000000000000 --- a/reference/solr/solrclient/destruct.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - SolrClient::__destruct - Destructor for SolrClient - - - - &reftitle.description; - - public SolrClient::__destruct - - - - Destructor - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Destructor for SolrClient - - - - - &reftitle.seealso; - - - SolrClient::__construct - - - - - - - diff --git a/reference/solr/solrclient/getbyid.xml b/reference/solr/solrclient/getbyid.xml deleted file mode 100644 index 1315538e55dc..000000000000 --- a/reference/solr/solrclient/getbyid.xml +++ /dev/null @@ -1,138 +0,0 @@ - - - - - - SolrClient::getById - Get Document By Id. Utilizes Solr Realtime Get (RTG) - - - - &reftitle.description; - - public SolrQueryResponseSolrClient::getById - stringid - - - Get Document By Id. Utilizes Solr Realtime Get (RTG). - - - - - &reftitle.parameters; - - - id - - - Document ID - - - - - - - - &reftitle.returnvalues; - - SolrQueryResponse - - - - - &reftitle.examples; - - <function>SolrClient::getById</function> example - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, - 'path' => SOLR_SERVER_PATH -); - -$client = new SolrClient($options); -$response = $client->getById('GB18030TEST'); -print_r($response->getResponse()); - -?> -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [id] => GB18030TEST - [name] => Array - ( - [0] => Test with some GB18030 encoded characters - ) - - [features] => Array - ( - [0] => No accents here - [1] => 这是一个功能 - [2] => This is a feature (translated) - [3] => 这份文件是很有光泽 - [4] => This document is very shiny (translated) - ) - - [price] => Array - ( - [0] => 0 - ) - - [inStock] => Array - ( - [0] => 1 - ) - - [_version_] => 1510294336239042560 - ) - -) -]]> - - - - - - - &reftitle.seealso; - - SolrClient::getByIds - - - - - - diff --git a/reference/solr/solrclient/getbyids.xml b/reference/solr/solrclient/getbyids.xml deleted file mode 100644 index ac1aa821dbeb..000000000000 --- a/reference/solr/solrclient/getbyids.xml +++ /dev/null @@ -1,201 +0,0 @@ - - - - - - SolrClient::getByIds - Get Documents by their Ids. Utilizes Solr Realtime Get (RTG) - - - - &reftitle.description; - - public SolrQueryResponseSolrClient::getByIds - arrayids - - - Get Documents by their Ids. Utilizes Solr Realtime Get (RTG). - - - - - - &reftitle.parameters; - - - ids - - - Document ids - - - - - - - - &reftitle.returnvalues; - - SolrQueryResponse - - - - - &reftitle.examples; - - <function>SolrClient::getByIds</function> example - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, - 'path' => SOLR_SERVER_PATH -); - -$client = new SolrClient($options); -$response = $client->getByIds(['GB18030TEST', '6H500F0']); - -print_r($response->getResponse()); - -?> -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [numFound] => 2 - [start] => 0 - [docs] => Array - ( - [0] => SolrObject Object - ( - [id] => GB18030TEST - [name] => Array - ( - [0] => Test with some GB18030 encoded characters - ) - - [features] => Array - ( - [0] => No accents here - [1] => 这是一个功能 - [2] => This is a feature (translated) - [3] => 这份文件是很有光泽 - [4] => This document is very shiny (translated) - ) - - [price] => Array - ( - [0] => 0 - ) - - [inStock] => Array - ( - [0] => 1 - ) - - [_version_] => 1510294336239042560 - ) - - [1] => SolrObject Object - ( - [id] => 6H500F0 - [name] => Array - ( - [0] => Maxtor DiamondMax 11 - hard drive - 500 GB - SATA-300 - ) - - [manu] => Array - ( - [0] => Maxtor Corp. - ) - - [manu_id_s] => maxtor - [cat] => Array - ( - [0] => electronics - [1] => hard drive - ) - - [features] => Array - ( - [0] => SATA 3.0Gb/s, NCQ - [1] => 8.5ms seek - [2] => 16MB cache - ) - - [price] => Array - ( - [0] => 350 - ) - - [popularity] => Array - ( - [0] => 6 - ) - - [inStock] => Array - ( - [0] => 1 - ) - - [store] => Array - ( - [0] => 45.17614,-93.87341 - ) - - [manufacturedate_dt] => 2006-02-13T15:26:37Z - [_version_] => 1510294336449806336 - ) - - ) - - ) - -) -]]> - - - - - - - &reftitle.seealso; - - SolrClient::getById - - - - - - diff --git a/reference/solr/solrclient/getdebug.xml b/reference/solr/solrclient/getdebug.xml deleted file mode 100644 index 14a0ded4d127..000000000000 --- a/reference/solr/solrclient/getdebug.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrClient::getDebug - Returns the debug data for the last connection attempt - - - - &reftitle.description; - - public stringSolrClient::getDebug - - - - Returns the debug data for the last connection attempt - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a string on success and null if there is nothing to return. - - - - - - diff --git a/reference/solr/solrclient/getoptions.xml b/reference/solr/solrclient/getoptions.xml deleted file mode 100644 index 811728eb9ad4..000000000000 --- a/reference/solr/solrclient/getoptions.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - SolrClient::getOptions - Returns the client options set internally - - - - &reftitle.description; - - public arraySolrClient::getOptions - - - - Returns the client options set internally. Very useful for debugging. The values returned are readonly and can only be set when the object is instantiated. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an array containing all the options for the SolrClient object set internally. - - - - - &reftitle.seealso; - - - SolrClient::__construct - - - - - - - diff --git a/reference/solr/solrclient/optimize.xml b/reference/solr/solrclient/optimize.xml deleted file mode 100644 index 1d73667f4dc4..000000000000 --- a/reference/solr/solrclient/optimize.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - SolrClient::optimize - Defragments the index - - - - &reftitle.description; - - public SolrUpdateResponseSolrClient::optimize - intmaxSegments1 - boolsoftCommit&true; - boolwaitSearcher&true; - - - Defragments the index for faster search performance. - - - - - - &reftitle.parameters; - - - - maxSegments - - - Optimizes down to at most this number of segments. Since Solr 1.3 - - - - - softCommit - - - This will refresh the 'view' of the index in a more performant manner, but without "on-disk" guarantees. (Solr4.0+) - - - - - waitSearcher - - - Block until a new searcher is opened and registered as the main query searcher, making the changes visible. - - - - - - - - - &reftitle.returnvalues; - - Returns a SolrUpdateResponse on success or throws an exception on failure. - - - - - &reftitle.errors; - - Throws SolrClientException if the client had failed, or there was a connection issue. - - - Throws SolrServerException if the Solr Server had failed to process the request. - - - - - &reftitle.notes; - - - PECL Solr >= 2.0 only supports Solr Server >= 4.0 - - - Prior to PECL Solr 2.0 this method used to accept these arguments "int $maxSegments, bool $waitFlush, bool $waitSearcher". - - - - - - &reftitle.seealso; - - - SolrClient::commit - SolrClient::rollback - - - - - - - diff --git a/reference/solr/solrclient/ping.xml b/reference/solr/solrclient/ping.xml deleted file mode 100644 index 9e2c7652a219..000000000000 --- a/reference/solr/solrclient/ping.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - SolrClient::ping - Checks if Solr server is still up - - - - &reftitle.description; - - public SolrPingResponseSolrClient::ping - - - - Checks if the Solr server is still alive. Sends a HEAD request to the Apache Solr server. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a SolrPingResponse object on success and throws an exception on failure. - - - - - &reftitle.errors; - - Throws SolrClientException if the client had failed, or there was a connection issue. - - - Throws SolrServerException if the Solr Server had failed to satisfy the request. - - - - - &reftitle.examples; - - - <methodname>SolrClient::ping</methodname> example - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$client = new SolrClient($options); - -$pingresponse = $client->ping(); - -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/solr/solrclient/query.xml b/reference/solr/solrclient/query.xml deleted file mode 100644 index c37b70e6fc20..000000000000 --- a/reference/solr/solrclient/query.xml +++ /dev/null @@ -1,175 +0,0 @@ - - - - - - SolrClient::query - Sends a query to the server - - - - &reftitle.description; - - public SolrQueryResponseSolrClient::query - SolrParamsquery - - - Sends a query to the server. - - - - - - &reftitle.parameters; - - - - query - - - A SolrParams object. It is recommended to use SolrQuery for advanced queries. - - - - - - - - - &reftitle.returnvalues; - - Returns a SolrQueryResponse object on success and throws an exception on failure. - - - - - &reftitle.errors; - - Throws SolrClientException if the client had failed, or there was a connection issue. - - - Throws SolrServerException if the Solr Server had failed to satisfy the query. - - - - - &reftitle.examples; - - - <methodname>SolrClient::query</methodname> example - - 'localhost', - 'login' => 'username', - 'password' => 'password', - 'port' => '8983', -); - -$client = new SolrClient($options); - -$query = new SolrQuery(); - -$query->setQuery('lucene'); - -$query->setStart(0); - -$query->setRows(50); - -$query->addField('cat')->addField('features')->addField('id')->addField('timestamp'); - -$query_response = $client->query($query); - -$response = $query_response->getResponse(); - -print_r($response); - -?> -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [status] => 0 - [QTime] => 3 - [params] => SolrObject Object - ( - [fl] => cat,features,id,timestamp - [indent] => on - [start] => 0 - [q] => lucene - [wt] => xml - [version] => 2.2 - [rows] => 50 - ) - - ) - - [response] => SolrObject Object - ( - [numFound] => 1 - [start] => 0 - [docs] => Array - ( - [0] => SolrObject Object - ( - [id] => SOLR1000 - [cat] => Array - ( - [0] => software - [1] => search - ) - - [features] => Array - ( - [0] => Advanced Full-Text Search Capabilities using Lucene - [1] => Optimized for High Volume Web Traffic - [2] => Standards Based Open Interfaces - XML and HTTP - [3] => Comprehensive HTML Administration Interfaces - [4] => Scalability - Efficient Replication to other Solr Search Servers - [5] => Flexible and Adaptable with XML configuration and Schema - [6] => Good unicode support: héllo (hello with an accent over the e) - ) - - ) - - ) - - ) - -) -]]> - - - - - - - - diff --git a/reference/solr/solrclient/request.xml b/reference/solr/solrclient/request.xml deleted file mode 100644 index 64991cefc3ff..000000000000 --- a/reference/solr/solrclient/request.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - SolrClient::request - Sends a raw update request - - - - &reftitle.description; - - public SolrUpdateResponseSolrClient::request - stringraw_request - - - Sends a raw XML update request to the server - - - - - - &reftitle.parameters; - - - - raw_request - - - An XML string with the raw request to the server. - - - - - - - - - &reftitle.returnvalues; - - Returns a SolrUpdateResponse on success. Throws an exception on failure. - - - - - &reftitle.errors; - - Throws SolrIllegalArgumentException if raw_request was an empty string - - - Throws SolrClientException if the client had failed, or there was a connection issue. - - - Throws SolrServerException if the Solr Server had failed to satisfy the query. - - - - - &reftitle.examples; - - - <methodname>SolrClient::request</methodname> example - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$client = new SolrClient($options); - -$update_response = $client->request(""); - -$response = $update_response->getResponse(); - -print_r($response); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/solr/solrclient/rollback.xml b/reference/solr/solrclient/rollback.xml deleted file mode 100644 index 465e1e596ecf..000000000000 --- a/reference/solr/solrclient/rollback.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - SolrClient::rollback - Rollbacks all add/deletes made to the index since the last commit - - - - &reftitle.description; - - public SolrUpdateResponseSolrClient::rollback - - - - Rollbacks all add/deletes made to the index since the last commit. It neither calls any event listeners nor creates a new searcher. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a SolrUpdateResponse on success or throws a SolrClientException on failure. - - - - - &reftitle.seealso; - - - SolrClient::commit - SolrClient::optimize - - - - - - - diff --git a/reference/solr/solrclient/setresponsewriter.xml b/reference/solr/solrclient/setresponsewriter.xml deleted file mode 100644 index f51e17a76a39..000000000000 --- a/reference/solr/solrclient/setresponsewriter.xml +++ /dev/null @@ -1,144 +0,0 @@ - - - - - - SolrClient::setResponseWriter - Sets the response writer used to prepare the response from Solr - - - - &reftitle.description; - - public voidSolrClient::setResponseWriter - stringresponseWriter - - - Sets the response writer used to prepare the response from Solr - - - - - - &reftitle.parameters; - - - - responseWriter - - One of the following: - - json - phps - xml - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - <methodname>SolrClient::setResponseWriter</methodname> example - -$property_name; - - } else if (isset($_properties[$property_name])) { - - return $_properties[$property_name]; - } - - return null; - } -} - -$options = array -( - 'hostname' => 'localhost', - 'port' => 8983, - 'path' => '/solr/core1' -); - -$client = new SolrClient($options); - -$client->setResponseWriter("json"); - -//$response = $client->ping(); - -$query = new SolrQuery(); - -$query->setQuery("*:*"); - -$query->set("objectClassName", "SolrClass"); - -$query->set("objectPropertiesStorageMode", 1); // 0 for independent properties, 1 for combined - -try -{ - -$response = $client->query($query); - -$resp = $response->getResponse(); - -print_r($response); - -print_r($resp); - -} catch (Exception $e) { - -print_r($e); - -} - -?> -]]> - - - - - - - - diff --git a/reference/solr/solrclient/setservlet.xml b/reference/solr/solrclient/setservlet.xml deleted file mode 100644 index 22392cf62ee2..000000000000 --- a/reference/solr/solrclient/setservlet.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - SolrClient::setServlet - Changes the specified servlet type to a new value - - - - &reftitle.description; - - public boolSolrClient::setServlet - inttype - stringvalue - - - Changes the specified servlet type to a new value - - - - - - &reftitle.parameters; - - - - type - - One of the following : - - - - - - - value - - - The new value for the servlet - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrclient/system.xml b/reference/solr/solrclient/system.xml deleted file mode 100644 index cfb20dc86c78..000000000000 --- a/reference/solr/solrclient/system.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - SolrClient::system - Retrieve Solr Server information - - - - &reftitle.description; - - public voidSolrClient::system - - - - Retrieve Solr Server information - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a SolrGenericResponse object on success. - - - - - &reftitle.errors; - - Emits SolrClientException if the client failed, or there was a connection issue. - - - Emits SolrServerException if the Solr Server failed to satisfy the query. - - - - - - diff --git a/reference/solr/solrclient/threads.xml b/reference/solr/solrclient/threads.xml deleted file mode 100644 index e125c7df62c6..000000000000 --- a/reference/solr/solrclient/threads.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - SolrClient::threads - Checks the threads status - - - - &reftitle.description; - - public voidSolrClient::threads - - - - Checks the threads status - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a SolrGenericResponse object. - - - - - &reftitle.errors; - - Throws SolrClientException if the client failed, or there was a connection issue. - - - throws SolrServerException if the Solr Server failed to process the request. - - - - - - diff --git a/reference/solr/solrclientexception.xml b/reference/solr/solrclientexception.xml deleted file mode 100644 index e6346efc5153..000000000000 --- a/reference/solr/solrclientexception.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - The SolrClientException class - SolrClientException - - - - -
    - &reftitle.intro; - - An exception thrown when there is an error while making a request to the server from the client. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrClientException - - - - - SolrClientException - - - - extends - SolrException - - - - - &InheritedProperties; - - - - &Methods; - - - &InheritedMethods; - - - - - - -
    - - -
    - - &reference.solr.entities.solrclientexception; - -
    - - diff --git a/reference/solr/solrclientexception/getinternalinfo.xml b/reference/solr/solrclientexception/getinternalinfo.xml deleted file mode 100644 index c18f2f4dcc4b..000000000000 --- a/reference/solr/solrclientexception/getinternalinfo.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrClientException::getInternalInfo - Returns internal information where the Exception was thrown - - - - &reftitle.description; - - public arraySolrClientException::getInternalInfo - - - - Returns internal information where the Exception was thrown. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an array containing internal information where the error was thrown. Used only for debugging by extension developers. - - - - - - diff --git a/reference/solr/solrcollapsefunction.xml b/reference/solr/solrcollapsefunction.xml deleted file mode 100644 index 17bd79f58813..000000000000 --- a/reference/solr/solrcollapsefunction.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - The SolrCollapseFunction class - SolrCollapseFunction - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrCollapseFunction - - - - - SolrCollapseFunction - - - - &Constants; - - const - string - SolrCollapseFunction::NULLPOLICY_IGNORE - ignore - - - const - string - SolrCollapseFunction::NULLPOLICY_EXPAND - expand - - - const - string - SolrCollapseFunction::NULLPOLICY_COLLAPSE - collapse - - - &Methods; - - - - - -
    - - -
    - &reftitle.constants; - - - - SolrCollapseFunction::NULLPOLICY_IGNORE - - - - - - - SolrCollapseFunction::NULLPOLICY_EXPAND - - - - - - - SolrCollapseFunction::NULLPOLICY_COLLAPSE - - - - - - -
    - - - -
    - - &reference.solr.entities.solrcollapsefunction; - -
    - - diff --git a/reference/solr/solrcollapsefunction/construct.xml b/reference/solr/solrcollapsefunction/construct.xml deleted file mode 100644 index 70f4d97f5f22..000000000000 --- a/reference/solr/solrcollapsefunction/construct.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - SolrCollapseFunction::__construct - Constructor - - - - &reftitle.description; - - public SolrCollapseFunction::__construct - stringfield - - - Collapse Function constructor - - - - - - &reftitle.parameters; - - - field - - - The field name to collapse on. - - - In order to collapse a result. The field type must be a single valued String, Int or Float. - - - - - - - - &reftitle.examples; - - <function>SolrCollapseFunction::__construct</function> example - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, - 'path' => SOLR_SERVER_PATH -); - -$client = new SolrClient($options); - -$query = new SolrQuery('*:*'); - -$func = new SolrCollapseFunction('field_name'); - -$func->setMax('sum(cscore(),field(some_other_field))'); -$func->setSize(100); -$func->setNullPolicy(SolrCollapseFunction::NULLPOLICY_EXPAND); - -$query->collapse($func); - -$queryResponse = $client->query($query); - -$response = $queryResponse->getResponse(); - -print_r($response); - -?> -]]> - - - - - - - &reftitle.seealso; - - SolrQuery::collapse - - - - - - diff --git a/reference/solr/solrcollapsefunction/getfield.xml b/reference/solr/solrcollapsefunction/getfield.xml deleted file mode 100644 index 864a8077baf2..000000000000 --- a/reference/solr/solrcollapsefunction/getfield.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - SolrCollapseFunction::getField - Returns the field that is being collapsed on - - - - &reftitle.description; - - public stringSolrCollapseFunction::getField - - - - Returns the field that is being collapsed on. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrCollapseFunction::setField - - - - - - diff --git a/reference/solr/solrcollapsefunction/gethint.xml b/reference/solr/solrcollapsefunction/gethint.xml deleted file mode 100644 index bbbb2f952748..000000000000 --- a/reference/solr/solrcollapsefunction/gethint.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - SolrCollapseFunction::getHint - Returns collapse hint - - - - &reftitle.description; - - public stringSolrCollapseFunction::getHint - - - - Returns collapse hint - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrCollapseFunction::setHint - - - - - - diff --git a/reference/solr/solrcollapsefunction/getmax.xml b/reference/solr/solrcollapsefunction/getmax.xml deleted file mode 100644 index f4c40fe2549f..000000000000 --- a/reference/solr/solrcollapsefunction/getmax.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - SolrCollapseFunction::getMax - Returns max parameter - - - - &reftitle.description; - - public stringSolrCollapseFunction::getMax - - - - Returns max parameter - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrCollapseFunction::setMax - - - - - - diff --git a/reference/solr/solrcollapsefunction/getmin.xml b/reference/solr/solrcollapsefunction/getmin.xml deleted file mode 100644 index 7e66925b53c7..000000000000 --- a/reference/solr/solrcollapsefunction/getmin.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - SolrCollapseFunction::getMin - Returns min parameter - - - - &reftitle.description; - - public stringSolrCollapseFunction::getMin - - - - Returns min parameter - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrCollapseFunction::setMin - - - - - - diff --git a/reference/solr/solrcollapsefunction/getnullpolicy.xml b/reference/solr/solrcollapsefunction/getnullpolicy.xml deleted file mode 100644 index a22b7d65d3f8..000000000000 --- a/reference/solr/solrcollapsefunction/getnullpolicy.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - SolrCollapseFunction::getNullPolicy - Returns null policy - - - - &reftitle.description; - - public stringSolrCollapseFunction::getNullPolicy - - - - Returns null policy used or null - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrCollapseFunction::setNullPolicy - - - - - - diff --git a/reference/solr/solrcollapsefunction/getsize.xml b/reference/solr/solrcollapsefunction/getsize.xml deleted file mode 100644 index ae8a58d2481d..000000000000 --- a/reference/solr/solrcollapsefunction/getsize.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - SolrCollapseFunction::getSize - Returns size parameter - - - - &reftitle.description; - - public intSolrCollapseFunction::getSize - - - - Gets the initial size of the collapse data structures when collapsing on a numeric field only - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrCollapseFunction::setSize - - - - - - diff --git a/reference/solr/solrcollapsefunction/setfield.xml b/reference/solr/solrcollapsefunction/setfield.xml deleted file mode 100644 index 80baf741890c..000000000000 --- a/reference/solr/solrcollapsefunction/setfield.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrCollapseFunction::setField - Sets the field to collapse on - - - - &reftitle.description; - - public SolrCollapseFunctionSolrCollapseFunction::setField - stringfieldName - - - The field name to collapse on. - - In order to collapse a result. The field type must be a single valued String, Int or Float. - - - - - - &reftitle.parameters; - - - fieldName - - - - - - - - - - - &reftitle.returnvalues; - - SolrCollapseFunction - - - - - - diff --git a/reference/solr/solrcollapsefunction/sethint.xml b/reference/solr/solrcollapsefunction/sethint.xml deleted file mode 100644 index 8fd999db364a..000000000000 --- a/reference/solr/solrcollapsefunction/sethint.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - SolrCollapseFunction::setHint - Sets collapse hint - - - - &reftitle.description; - - public SolrCollapseFunctionSolrCollapseFunction::setHint - stringhint - - - Sets collapse hint - - - - - - &reftitle.parameters; - - - hint - - - Currently there is only one hint available "top_fc", which stands for top level FieldCache - - - - - - - - &reftitle.returnvalues; - - SolrCollapseFunction - - - - - &reftitle.examples; - - <function>SolrCollapseFunction::setHint</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/solr/solrcollapsefunction/setmax.xml b/reference/solr/solrcollapsefunction/setmax.xml deleted file mode 100644 index 181bea054f31..000000000000 --- a/reference/solr/solrcollapsefunction/setmax.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - SolrCollapseFunction::setMax - Selects the group heads by the max value of a numeric field or function query - - - - &reftitle.description; - - public SolrCollapseFunctionSolrCollapseFunction::setMax - stringmax - - - Selects the group heads by the max value of a numeric field or function query. - - - - - - &reftitle.parameters; - - - max - - - - - - - - - - - &reftitle.returnvalues; - - SolrCollapseFunction - - - - - &reftitle.examples; - - <function>SolrCollapseFunction::setMax</function> example - -setMax('sum(cscore(),field(some_field))'); - -$query = new SolrQuery('*:*'); - -$query->collapse($func); - -?> -]]> - - - - - - diff --git a/reference/solr/solrcollapsefunction/setmin.xml b/reference/solr/solrcollapsefunction/setmin.xml deleted file mode 100644 index 49b1049fff06..000000000000 --- a/reference/solr/solrcollapsefunction/setmin.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - SolrCollapseFunction::setMin - Sets the initial size of the collapse data structures when collapsing on a numeric field only - - - - &reftitle.description; - - public SolrCollapseFunctionSolrCollapseFunction::setMin - stringmin - - - Sets the initial size of the collapse data structures when collapsing on a numeric field only - - - - - - &reftitle.parameters; - - - min - - - - - - - - - - - &reftitle.returnvalues; - - SolrCollapseFunction - - - - - - diff --git a/reference/solr/solrcollapsefunction/setnullpolicy.xml b/reference/solr/solrcollapsefunction/setnullpolicy.xml deleted file mode 100644 index 83fe76c063cf..000000000000 --- a/reference/solr/solrcollapsefunction/setnullpolicy.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - SolrCollapseFunction::setNullPolicy - Sets the NULL Policy - - - - &reftitle.description; - - public SolrCollapseFunctionSolrCollapseFunction::setNullPolicy - stringnullPolicy - - - Sets the NULL Policy. One of the 3 policies defined as class constants shall be passed. - Accepts ignore, expand, or collapse policies. - - - - - - &reftitle.parameters; - - - nullPolicy - - - - - - - - - - - &reftitle.returnvalues; - - SolrCollapseFunction - - - - - - diff --git a/reference/solr/solrcollapsefunction/setsize.xml b/reference/solr/solrcollapsefunction/setsize.xml deleted file mode 100644 index 85a89ec3c7a2..000000000000 --- a/reference/solr/solrcollapsefunction/setsize.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - SolrCollapseFunction::setSize - Sets the initial size of the collapse data structures when collapsing on a numeric field only - - - - &reftitle.description; - - public SolrCollapseFunctionSolrCollapseFunction::setSize - intsize - - - Sets the initial size of the collapse data structures when collapsing on a numeric field only. - - - - - - &reftitle.parameters; - - - size - - - - - - - - - - - &reftitle.returnvalues; - - SolrCollapseFunction - - - - - - diff --git a/reference/solr/solrcollapsefunction/tostring.xml b/reference/solr/solrcollapsefunction/tostring.xml deleted file mode 100644 index ae78287d94fe..000000000000 --- a/reference/solr/solrcollapsefunction/tostring.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrCollapseFunction::__toString - Returns a string representing the constructed collapse function - - - - &reftitle.description; - - public stringSolrCollapseFunction::__toString - - - - Returns a string representing the constructed collapse function - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/solr/solrdismaxquery.xml b/reference/solr/solrdismaxquery.xml deleted file mode 100644 index 1df92564c5fc..000000000000 --- a/reference/solr/solrdismaxquery.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - - The SolrDisMaxQuery class - SolrDisMaxQuery - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrDisMaxQuery - - - - - SolrDisMaxQuery - - - - extends - SolrQuery - - - - Serializable - - - - - &InheritedProperties; - - - - &Methods; - - - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.constants; - - - - SolrDisMaxQuery::ORDER_ASC - - Used to specify that the sorting should be in acending order (Duplicated for easier migration) - - - - - SolrDisMaxQuery::ORDER_DESC - - Used to specify that the sorting should be in descending order (Duplicated for easier migration) - - - - - SolrDisMaxQuery::FACET_SORT_INDEX - - Used to specify that the facet should sort by index (Duplicated for easier migration) - - - - - SolrDisMaxQuery::FACET_SORT_COUNT - - Used to specify that the facet should sort by count (Duplicated for easier migration) - - - - - SolrDisMaxQuery::TERMS_SORT_INDEX - - Used in the TermsComponent (Duplicated for easier migration) - - - - - SolrDisMaxQuery::TERMS_SORT_COUNT - - Used in the TermsComponent (Duplicated for easier migration) - - - - -
    - - - -
    - - &reference.solr.entities.solrdismaxquery; - -
    - - diff --git a/reference/solr/solrdismaxquery/addbigramphrasefield.xml b/reference/solr/solrdismaxquery/addbigramphrasefield.xml deleted file mode 100644 index 08c80ca0f362..000000000000 --- a/reference/solr/solrdismaxquery/addbigramphrasefield.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - SolrDisMaxQuery::addBigramPhraseField - Adds a Phrase Bigram Field (pf2 parameter) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::addBigramPhraseField - stringfield - stringboost - stringslop - - - Adds a Phrase Bigram Field (pf2 parameter) - output format: field~slop^boost OR field^boost - Slop is optional - - - - - - &reftitle.parameters; - - - field - - - - - - - - boost - - - - - - - - slop - - - - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - <function>SolrDisMaxQuery::addBigramPhraseField</function> example - -addBigramPhraseField('cat', 2, 5.1) - ->addBigramPhraseField('feature', 4.5) -; -echo $dismaxQuery; - -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::removeBigramPhraseField - SolrDisMaxQuery::setBigramPhraseFields - SolrDisMaxQuery::setBigramPhraseSlop - - - - - - diff --git a/reference/solr/solrdismaxquery/addboostquery.xml b/reference/solr/solrdismaxquery/addboostquery.xml deleted file mode 100644 index 865d14cc8a0a..000000000000 --- a/reference/solr/solrdismaxquery/addboostquery.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - SolrDisMaxQuery::addBoostQuery - Adds a boost query field with value and optional boost (bq parameter) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::addBoostQuery - stringfield - stringvalue - stringboost - - - Adds a Boost Query field with value [and boost] (bq parameter) - - - - - - &reftitle.parameters; - - - field - - - - - - - - value - - - - - - - - boost - - - - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - <function>SolrDisMaxQuery::addBoostQuery</function> example - -addBoostQuery('cat', 'clothing', 2) - ->addBoostQuery('cat', 'electronics', 5.1) -; -echo $dismaxQuery.PHP_EOL; -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::removeBoostQuery - SolrDisMaxQuery::setBoostQuery - - - - - - diff --git a/reference/solr/solrdismaxquery/addphrasefield.xml b/reference/solr/solrdismaxquery/addphrasefield.xml deleted file mode 100644 index be7ba0325bbd..000000000000 --- a/reference/solr/solrdismaxquery/addphrasefield.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - SolrDisMaxQuery::addPhraseField - Adds a Phrase Field (pf parameter) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::addPhraseField - stringfield - stringboost - stringslop - - - Adds a Phrase Field (pf parameter) - - - - - - &reftitle.parameters; - - - field - - - field name - - - - - boost - - - - - - - - slop - - - - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - <function>SolrDisMaxQuery::addPhraseField</function> example - -addPhraseField('cat', 3, 1) - ->addPhraseField('third', 4, 2) - ->addPhraseField('source', 55) -; -echo $dismaxQuery; -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::removePhraseField - SolrDisMaxQuery::setPhraseFields - - - - - - diff --git a/reference/solr/solrdismaxquery/addqueryfield.xml b/reference/solr/solrdismaxquery/addqueryfield.xml deleted file mode 100644 index a8bba9b2a039..000000000000 --- a/reference/solr/solrdismaxquery/addqueryfield.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - SolrDisMaxQuery::addQueryField - Add a query field with optional boost (qf parameter) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::addQueryField - stringfield - stringboost - - - Add a query field with optional boost (qf parameter) - - - - - - &reftitle.parameters; - - - field - - - field name - - - - - boost - - - Boost value. Boosts documents with matching terms. - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - <function>SolrDisMaxQuery::addQueryField</function> example - -addQueryField("location", 4) - ->addQueryField("price") - ->addQueryField("sku") - ->addQueryField("title",3.4) -; -echo $dismaxQuery; - -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::removeQueryField - - - - - - diff --git a/reference/solr/solrdismaxquery/addtrigramphrasefield.xml b/reference/solr/solrdismaxquery/addtrigramphrasefield.xml deleted file mode 100644 index 9631a24df14c..000000000000 --- a/reference/solr/solrdismaxquery/addtrigramphrasefield.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - SolrDisMaxQuery::addTrigramPhraseField - Adds a Trigram Phrase Field (pf3 parameter) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::addTrigramPhraseField - stringfield - stringboost - stringslop - - - Adds a Trigram Phrase Field (pf3 parameter) - - - - - - &reftitle.parameters; - - - field - - - Field Name - - - - - boost - - - Field Boost - - - - - slop - - - Field Slop - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - <function>SolrDisMaxQuery::addTrigramPhraseField</function> example - -addTrigramPhraseField('cat', 2, 5.1) -->addTrigramPhraseField('feature', 4.5) -; -echo $dismaxQuery.PHP_EOL; - -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::removeTrigramPhraseField - SolrDisMaxQuery::setTrigramPhraseFields - SolrDisMaxQuery::setTrigramPhraseSlop - - - - - - diff --git a/reference/solr/solrdismaxquery/adduserfield.xml b/reference/solr/solrdismaxquery/adduserfield.xml deleted file mode 100644 index 5c70f6163a86..000000000000 --- a/reference/solr/solrdismaxquery/adduserfield.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - SolrDisMaxQuery::addUserField - Adds a field to User Fields Parameter (uf) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::addUserField - stringfield - - - Adds a field to The User Fields Parameter (uf) - - - - - - - &reftitle.parameters; - - - field - - - Field Name - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - <function>SolrDisMaxQuery::addUserField</function> example - -addUserField('cat') -->addUserField('text') -->addUserField('*_dt'); - -echo $dismaxQuery.PHP_EOL; - -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::removeUserField - SolrDisMaxQuery::setUserFields - - - - - - diff --git a/reference/solr/solrdismaxquery/construct.xml b/reference/solr/solrdismaxquery/construct.xml deleted file mode 100644 index b1fc1cc44174..000000000000 --- a/reference/solr/solrdismaxquery/construct.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - SolrDisMaxQuery::__construct - Class Constructor - - - - &reftitle.description; - - public SolrDisMaxQuery::__construct - stringq - - - Class constructor initializes the object and sets the q parameter if passed - - - - - &reftitle.parameters; - - - q - - - Search Query (q parameter) - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.errors; - - Emits SolrIllegalArgumentException in case of an invalid parameter was passed. - - - - - &reftitle.examples; - - <function>SolrDisMaxQuery::__construct</function> example - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/solr/solrdismaxquery/removebigramphrasefield.xml b/reference/solr/solrdismaxquery/removebigramphrasefield.xml deleted file mode 100644 index 431b60c7147f..000000000000 --- a/reference/solr/solrdismaxquery/removebigramphrasefield.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - SolrDisMaxQuery::removeBigramPhraseField - Removes phrase bigram field (pf2 parameter) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::removeBigramPhraseField - stringfield - - - Removes a Bigram Phrase Field (pf2 parameter) that was previously added using SolrDisMaxQuery::addBigramPhraseField - - - - - - &reftitle.parameters; - - - field - - - The Field Name - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - <function>SolrDisMaxQuery::removeBigramPhraseField</function> example - -addBigramPhraseField('cat', 2, 5.1) - ->addBigramPhraseField('feature', 4.5) -; -echo $dismaxQuery.PHP_EOL; - -// remove cat from pf2 -$dismaxQuery - ->removeBigramPhraseField('cat'); -echo $dismaxQuery.PHP_EOL; - -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::addBigramPhraseField - SolrDisMaxQuery::setBigramPhraseFields - SolrDisMaxQuery::setBigramPhraseSlop - - - - - - diff --git a/reference/solr/solrdismaxquery/removeboostquery.xml b/reference/solr/solrdismaxquery/removeboostquery.xml deleted file mode 100644 index 546acf772f91..000000000000 --- a/reference/solr/solrdismaxquery/removeboostquery.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - SolrDisMaxQuery::removeBoostQuery - Removes a boost query partial by field name (bq) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::removeBoostQuery - stringfield - - - Removes a boost query partial from the existing query, only if SolrDisMaxQuery::addBoostQuery was used. - - - - &reftitle.parameters; - - - field - - - Field Name - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - <function>SolrDisMaxQuery::removeBoostQuery</function> example - -addBoostQuery('cat', 'electronics', 5.1) - ->addBoostQuery('cat', 'hard drive') -; -echo $dismaxQuery.PHP_EOL; -// now remove a query part with field 'cat' -$dismaxQuery -->removeBoostQuery('cat'); -echo $dismaxQuery . PHP_EOL; - -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::addBoostQuery - SolrDisMaxQuery::setBoostQuery - - - - - - diff --git a/reference/solr/solrdismaxquery/removephrasefield.xml b/reference/solr/solrdismaxquery/removephrasefield.xml deleted file mode 100644 index a81aff2610e3..000000000000 --- a/reference/solr/solrdismaxquery/removephrasefield.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - SolrDisMaxQuery::removePhraseField - Removes a Phrase Field (pf parameter) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::removePhraseField - stringfield - - - Removes a Phrase Field (pf parameter) that was previously added using SolrDisMaxQuery::addPhraseField - - - - - - &reftitle.parameters; - - - field - - - Field Name - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - <function>SolrDisMaxQuery::removePhraseField</function> example - -addPhraseField('first', 3, 1) - ->addPhraseField('second', 4, 1) - ->addPhraseField('cat', 55); -echo $dismaxQuery . PHP_EOL; -echo $dismaxQuery->removePhraseField('second'); -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::addPhraseField - SolrDisMaxQuery::setPhraseFields - - - - - - diff --git a/reference/solr/solrdismaxquery/removequeryfield.xml b/reference/solr/solrdismaxquery/removequeryfield.xml deleted file mode 100644 index 860735486542..000000000000 --- a/reference/solr/solrdismaxquery/removequeryfield.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - SolrDisMaxQuery::removeQueryField - Removes a Query Field (qf parameter) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::removeQueryField - stringfield - - - Removes a Query Field (qf parameter) from the field list added by SolrDisMaxQuery::addQueryField - - - qf: When building DisjunctionMaxQueries from the user's query it specifies the fields to search in, and boosts for those fields. - - - - - - &reftitle.parameters; - - - field - - - Field Name - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - <function>SolrDisMaxQuery::removeQueryField</function> example - -addQueryField('first', 3) - ->addQueryField('second', 0.2) - ->addQueryField('cat'); -echo $dismaxQuery . PHP_EOL; -// remove field 'second' -echo $dismaxQuery->removeQueryField('second'); -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::addQueryField - - - - - - diff --git a/reference/solr/solrdismaxquery/removetrigramphrasefield.xml b/reference/solr/solrdismaxquery/removetrigramphrasefield.xml deleted file mode 100644 index 1885bc72e0a9..000000000000 --- a/reference/solr/solrdismaxquery/removetrigramphrasefield.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - SolrDisMaxQuery::removeTrigramPhraseField - Removes a Trigram Phrase Field (pf3 parameter) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::removeTrigramPhraseField - stringfield - - - Removes a Trigram Phrase Field (pf3 parameter) - - - - - - &reftitle.parameters; - - - field - - - Field Name - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - <function>SolrDisMaxQuery::removeTrigramPhraseField</function> example - -addTrigramPhraseField('cat', 2, 5.1) -->addTrigramPhraseField('feature', 4.5) -; -echo $dismaxQuery.PHP_EOL; -// reverse -$dismaxQuery -->removeTrigramPhraseField('cat'); -echo $dismaxQuery.PHP_EOL; - -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::addTrigramPhraseField - SolrDisMaxQuery::setTrigramPhraseFields - SolrDisMaxQuery::setTrigramPhraseSlop - - - - - - diff --git a/reference/solr/solrdismaxquery/removeuserfield.xml b/reference/solr/solrdismaxquery/removeuserfield.xml deleted file mode 100644 index 5a1005943028..000000000000 --- a/reference/solr/solrdismaxquery/removeuserfield.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - SolrDisMaxQuery::removeUserField - Removes a field from The User Fields Parameter (uf) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::removeUserField - stringfield - - - Removes a field from The User Fields Parameter (uf) - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - field - - - Field Name - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - <function>SolrDisMaxQuery::removeUserField</function> example - -addUserField('cat') -->addUserField('text') -->addUserField('*_dt') -; -echo $dismaxQuery.PHP_EOL; - -// remove field named 'text' -$dismaxQuery -->removeUserField('text'); -echo $dismaxQuery.PHP_EOL; - -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::addUserField - SolrDisMaxQuery::setUserFields - - - - - - diff --git a/reference/solr/solrdismaxquery/setbigramphrasefields.xml b/reference/solr/solrdismaxquery/setbigramphrasefields.xml deleted file mode 100644 index b506674f2cfc..000000000000 --- a/reference/solr/solrdismaxquery/setbigramphrasefields.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - SolrDisMaxQuery::setBigramPhraseFields - Sets Bigram Phrase Fields and their boosts (and slops) using pf2 parameter - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::setBigramPhraseFields - stringfields - - - Sets Bigram Phrase Fields (pf2) and their boosts (and slops) - - - - - &reftitle.parameters; - - - fields - - - Fields boosts (slops) - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - <function>SolrDisMaxQuery::setBigramPhraseFields</function> example - -setBigramPhraseFields("cat~5.1^2 feature^4.5"); -echo $dismaxQuery.PHP_EOL; - -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::setBigramPhraseSlop - SolrDisMaxQuery::addBigramPhraseFields - SolrDisMaxQuery::removeBigramPhraseField - SolrDisMaxQuery::setTrigramPhraseFields - - - - - - diff --git a/reference/solr/solrdismaxquery/setbigramphraseslop.xml b/reference/solr/solrdismaxquery/setbigramphraseslop.xml deleted file mode 100644 index 41e489a23cf6..000000000000 --- a/reference/solr/solrdismaxquery/setbigramphraseslop.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - SolrDisMaxQuery::setBigramPhraseSlop - Sets Bigram Phrase Slop (ps2 parameter) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::setBigramPhraseSlop - stringslop - - - Sets Bigram Phrase Slop (ps2 parameter). A default slop for Bigram phrase fields. - - - - - - &reftitle.parameters; - - - slop - - - - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - <function>SolrDisMaxQuery::setBigramPhraseSlop</function> example - -setBigramPhraseSlop(5); -echo $dismaxQuery.PHP_EOL; - -?> -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/solr/solrdismaxquery/setboostfunction.xml b/reference/solr/solrdismaxquery/setboostfunction.xml deleted file mode 100644 index b5f9c9700972..000000000000 --- a/reference/solr/solrdismaxquery/setboostfunction.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - SolrDisMaxQuery::setBoostFunction - Sets a Boost Function (bf parameter) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::setBoostFunction - stringfunction - - - Sets Boost Function (bf parameter). - - - Functions (with optional boosts) that will be included in the - user's query to influence the score. Any function supported natively - by Solr can be used, along with a boost value. e.g.: - - - recip(rord(myfield),1,2,3)^1.5 - - - - - &reftitle.parameters; - - - function - - - - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - <function>SolrDisMaxQuery::setBoostFunction</function> example - -setBoostFunction($boostRecentDocsFunction); - -echo $dismaxQuery.PHP_EOL; - -?> -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/solr/solrdismaxquery/setboostquery.xml b/reference/solr/solrdismaxquery/setboostquery.xml deleted file mode 100644 index df122f4c4979..000000000000 --- a/reference/solr/solrdismaxquery/setboostquery.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - SolrDisMaxQuery::setBoostQuery - Directly Sets Boost Query Parameter (bq) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::setBoostQuery - stringq - - - Sets Boost Query Parameter (bq) - - - - - - &reftitle.parameters; - - - q - - - query - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - <function>SolrDisMaxQuery::setBoostQuery</function> example - -setBoostQuery('cat:electronics manu:local^2'); -echo $dismaxQuery.PHP_EOL; -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::addBoostQuery - SolrDisMaxQuery::removeBoostQuery - - - - - - diff --git a/reference/solr/solrdismaxquery/setminimummatch.xml b/reference/solr/solrdismaxquery/setminimummatch.xml deleted file mode 100644 index d01684a6c120..000000000000 --- a/reference/solr/solrdismaxquery/setminimummatch.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - SolrDisMaxQuery::setMinimumMatch - Set Minimum "Should" Match (mm) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::setMinimumMatch - stringvalue - - - Set Minimum "Should" Match parameter (mm). If the default query operator is AND then mm=100%, if the default query operator (q.op) is OR, then mm=0%. - - - - - &reftitle.parameters; - - - value - - - Minimum match value/expression - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - <function>SolrDisMaxQuery::setMinimumMatch</function> example - -setMinimumMatch("75%"); -echo $dismaxQuery . PHP_EOL; - -?> -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/solr/solrdismaxquery/setphrasefields.xml b/reference/solr/solrdismaxquery/setphrasefields.xml deleted file mode 100644 index 30783ad29142..000000000000 --- a/reference/solr/solrdismaxquery/setphrasefields.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - SolrDisMaxQuery::setPhraseFields - Sets Phrase Fields and their boosts (and slops) using pf2 parameter - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::setPhraseFields - stringfields - - - Sets Phrase Fields (pf) and their boosts (and slops) - - - - - &reftitle.parameters; - - - fields - - - Fields, boosts [, slops] - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - <function>SolrDisMaxQuery::setPhraseFields</function> example - -setPhraseFields("cat~5.1^2 feature^4.5"); -echo $dismaxQuery.PHP_EOL; - -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::addPhraseFields - SolrDisMaxQuery::removePhraseField - - - - - - diff --git a/reference/solr/solrdismaxquery/setphraseslop.xml b/reference/solr/solrdismaxquery/setphraseslop.xml deleted file mode 100644 index 639d97c09ac4..000000000000 --- a/reference/solr/solrdismaxquery/setphraseslop.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - SolrDisMaxQuery::setPhraseSlop - Sets the default slop on phrase queries (ps parameter) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::setPhraseSlop - stringslop - - - Sets the default amount of slop on phrase queries built with "pf", "pf2" and/or "pf3" fields (affects boosting). - "ps" parameter - - - - - - &reftitle.parameters; - - - slop - - - - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - <function>SolrDisMaxQuery::setPhraseSlop</function> example - -setPhraseSlop(4); -echo $dismaxQuery.PHP_EOL; - -?> -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/solr/solrdismaxquery/setqueryalt.xml b/reference/solr/solrdismaxquery/setqueryalt.xml deleted file mode 100644 index 3cd85b862958..000000000000 --- a/reference/solr/solrdismaxquery/setqueryalt.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - SolrDisMaxQuery::setQueryAlt - Set Query Alternate (q.alt parameter) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::setQueryAlt - stringq - - - Set Query Alternate (q.alt parameter) - - - When the main q parameter is not specified or is blank. The q.alt parameter is used - - - - - - &reftitle.parameters; - - - q - - - Query String - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - <function>SolrDisMaxQuery::setQueryAlt</function> example - -setQueryAlt('*:*'); - -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/solr/solrdismaxquery/setqueryphraseslop.xml b/reference/solr/solrdismaxquery/setqueryphraseslop.xml deleted file mode 100644 index eff66b9b2744..000000000000 --- a/reference/solr/solrdismaxquery/setqueryphraseslop.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - SolrDisMaxQuery::setQueryPhraseSlop - Specifies the amount of slop permitted on phrase queries explicitly included in the user's query string (qf parameter) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::setQueryPhraseSlop - stringslop - - - The Query Phrase Slop is the amount of slop permitted on phrase queries explicitly included in the user's query string with the qf parameter. - - - slop refers to the number of positions one token needs to be moved in relation to another token in order to match a phrase specified in a query. - - - - - - &reftitle.parameters; - - - slop - - - Amount of slop - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - <function>SolrDisMaxQuery::setQueryPhraseSlop</function> example - -setQueryPhraseSlop(3); -echo $dismaxQuery; -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/solr/solrdismaxquery/settiebreaker.xml b/reference/solr/solrdismaxquery/settiebreaker.xml deleted file mode 100644 index 75e4553f64d4..000000000000 --- a/reference/solr/solrdismaxquery/settiebreaker.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - SolrDisMaxQuery::setTieBreaker - Sets Tie Breaker parameter (tie parameter) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::setTieBreaker - stringtieBreaker - - - Sets Tie Breaker parameter (tie parameter) - - - - - &reftitle.parameters; - - - tieBreaker - - - The tie parameter specifies a float value (which should be something much less than 1) to use as tiebreaker in DisMax queries. - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - <function>SolrDisMaxQuery::setTieBreaker</function> example - -setTieBreaker(0.1); - -echo $dismaxQuery; - -?> -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/solr/solrdismaxquery/settrigramphrasefields.xml b/reference/solr/solrdismaxquery/settrigramphrasefields.xml deleted file mode 100644 index 7bed4ecf25a9..000000000000 --- a/reference/solr/solrdismaxquery/settrigramphrasefields.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - SolrDisMaxQuery::setTrigramPhraseFields - Directly Sets Trigram Phrase Fields (pf3 parameter) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::setTrigramPhraseFields - stringfields - - - Directly Sets Trigram Phrase Fields (pf3 parameter) - - - - - - &reftitle.parameters; - - - fields - - - Trigram Phrase Fields - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - <function>SolrDisMaxQuery::setTrigramPhraseFields</function> example - -setTrigramPhraseFields('cat~5.1^2 feature^4.5'); -echo $dismaxQuery.PHP_EOL; - -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::addTrigramPhraseField - SolrDisMaxQuery::removeTrigramPhraseField - SolrDisMaxQuery::setTrigramPhraseSlop - - - - - - diff --git a/reference/solr/solrdismaxquery/settrigramphraseslop.xml b/reference/solr/solrdismaxquery/settrigramphraseslop.xml deleted file mode 100644 index 80ac656f664f..000000000000 --- a/reference/solr/solrdismaxquery/settrigramphraseslop.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - SolrDisMaxQuery::setTrigramPhraseSlop - Sets Trigram Phrase Slop (ps3 parameter) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::setTrigramPhraseSlop - stringslop - - - Sets Trigram Phrase Slop (ps3 parameter) - - - - - - &reftitle.parameters; - - - slop - - - Phrase slop - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - <function>SolrDisMaxQuery::setTrigramPhraseSlop</function> example - -setTrigramPhraseSlop(2); -echo $dismaxQuery.PHP_EOL; - -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::addTrigramPhraseField - SolrDisMaxQuery::removeTrigramPhraseField - SolrDisMaxQuery::setTrigramPhraseFields - - - - - - diff --git a/reference/solr/solrdismaxquery/setuserfields.xml b/reference/solr/solrdismaxquery/setuserfields.xml deleted file mode 100644 index d311b9d46ec8..000000000000 --- a/reference/solr/solrdismaxquery/setuserfields.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - SolrDisMaxQuery::setUserFields - Sets User Fields parameter (uf) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::setUserFields - stringfields - - - Sets User Fields parameter (uf) - - - User Fields: Specifies which schema fields the end user shall be allowed to query. - - - - - - &reftitle.parameters; - - - fields - - - Fields names separated by space - - - This parameter supports wildcards. - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - <function>SolrDisMaxQuery::setUserFields</function> example - -setUserFields('field1 field2 *_txt'); -echo $dismaxQuery.PHP_EOL; - -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::addUserField - SolrDisMaxQuery::removeUserField - - - - - - diff --git a/reference/solr/solrdismaxquery/usedismaxqueryparser.xml b/reference/solr/solrdismaxquery/usedismaxqueryparser.xml deleted file mode 100644 index 8ed928dd63f9..000000000000 --- a/reference/solr/solrdismaxquery/usedismaxqueryparser.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - SolrDisMaxQuery::useDisMaxQueryParser - Switch QueryParser to be DisMax Query Parser - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::useDisMaxQueryParser - - - - Switch QueryParser to be DisMax Query Parser - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - <function>SolrDisMaxQuery::useDisMaxQueryParser</function> example - -useDisMaxQueryParser(); -echo $dismaxQuery; -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::useDisMaxQueryParser - - - - - - diff --git a/reference/solr/solrdismaxquery/useedismaxqueryparser.xml b/reference/solr/solrdismaxquery/useedismaxqueryparser.xml deleted file mode 100644 index e67e469a2e84..000000000000 --- a/reference/solr/solrdismaxquery/useedismaxqueryparser.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - SolrDisMaxQuery::useEDisMaxQueryParser - Switch QueryParser to be EDisMax - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::useEDisMaxQueryParser - - - - Switch QueryParser to be EDisMax. By default the query builder uses edismax, if it was switched using SolrDisMaxQuery::useDisMaxQueryParser, it can be switched back using this method. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - <function>SolrDisMaxQuery::useEDisMaxQueryParser</function> example - -useEDisMaxQueryParser(); -echo $dismaxQuery; - -?> -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/solr/solrdocument.xml b/reference/solr/solrdocument.xml deleted file mode 100644 index 08ed06e8f8fa..000000000000 --- a/reference/solr/solrdocument.xml +++ /dev/null @@ -1,172 +0,0 @@ - - - - - - The SolrDocument class - SolrDocument - - - - -
    - &reftitle.intro; - - Represents a Solr document retrieved from a query response. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrDocument - - - - - final - SolrDocument - - - - ArrayAccess - - - - Iterator - - - - Serializable - - - - &Constants; - - const - int - SolrDocument::SORT_DEFAULT - 1 - - - const - int - SolrDocument::SORT_ASC - 1 - - - const - int - SolrDocument::SORT_DESC - 2 - - - const - int - SolrDocument::SORT_FIELD_NAME - 1 - - - const - int - SolrDocument::SORT_FIELD_VALUE_COUNT - 2 - - - const - int - SolrDocument::SORT_FIELD_BOOST_VALUE - 4 - - - &Methods; - - - - - - -
    - - - -
    - &reftitle.constants; - - - - SolrDocument::SORT_DEFAULT - - Default mode for sorting fields within the document. - - - - - SolrDocument::SORT_ASC - - Sorts the fields in ascending order - - - - - SolrDocument::SORT_DESC - - Sorts the fields in descending order - - - - - SolrDocument::SORT_FIELD_NAME - - Sorts the fields by field name. - - - - - SolrDocument::SORT_FIELD_VALUE_COUNT - - Sorts the fields by number of values in each field. - - - - - SolrDocument::SORT_FIELD_BOOST_VALUE - - Sorts the fields by their boost values. - - - - -
    - - - -
    - - &reference.solr.entities.solrdocument; - -
    - - diff --git a/reference/solr/solrdocument/addfield.xml b/reference/solr/solrdocument/addfield.xml deleted file mode 100644 index dca46a778a55..000000000000 --- a/reference/solr/solrdocument/addfield.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - SolrDocument::addField - Adds a field to the document - - - - &reftitle.description; - - public boolSolrDocument::addField - stringfieldName - stringfieldValue - - - This method adds a field to the SolrDocument instance. - - - - - - &reftitle.parameters; - - - - fieldName - - - The name of the field - - - - - fieldValue - - - The value of the field. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrdocument/clear.xml b/reference/solr/solrdocument/clear.xml deleted file mode 100644 index 0b3c001a1d95..000000000000 --- a/reference/solr/solrdocument/clear.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrDocument::clear - Drops all the fields in the document - - - - &reftitle.description; - - public boolSolrDocument::clear - - - - Resets the current object. Discards all the fields and resets the document boost to zero. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrdocument/clone.xml b/reference/solr/solrdocument/clone.xml deleted file mode 100644 index ba03a02bca5f..000000000000 --- a/reference/solr/solrdocument/clone.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrDocument::__clone - Creates a copy of a SolrDocument object - - - - &reftitle.description; - - public voidSolrDocument::__clone - - - - Creates a copy of a SolrDocument object. Not to be called directly. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - None. - - - - - - diff --git a/reference/solr/solrdocument/construct.xml b/reference/solr/solrdocument/construct.xml deleted file mode 100644 index 35b28f6432d5..000000000000 --- a/reference/solr/solrdocument/construct.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrDocument::__construct - Constructor - - - - &reftitle.description; - - public SolrDocument::__construct - - - - Constructor for SolrDocument - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/solr/solrdocument/current.xml b/reference/solr/solrdocument/current.xml deleted file mode 100644 index 534a76f7a6d7..000000000000 --- a/reference/solr/solrdocument/current.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - SolrDocument::current - Retrieves the current field - - - - &reftitle.description; - - public SolrDocumentFieldSolrDocument::current - - - - Retrieves the current field - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the field - - - - - - - diff --git a/reference/solr/solrdocument/deletefield.xml b/reference/solr/solrdocument/deletefield.xml deleted file mode 100644 index e91804563839..000000000000 --- a/reference/solr/solrdocument/deletefield.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - SolrDocument::deleteField - Removes a field from the document - - - - &reftitle.description; - - public boolSolrDocument::deleteField - stringfieldName - - - Removes a field from the document. - - - - - - - - &reftitle.parameters; - - - - fieldName - - - Name of the field - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrdocument/destruct.xml b/reference/solr/solrdocument/destruct.xml deleted file mode 100644 index 3ac50ed5d31c..000000000000 --- a/reference/solr/solrdocument/destruct.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrDocument::__destruct - Destructor - - - - &reftitle.description; - - public SolrDocument::__destruct - - - - Destructor for SolrDocument. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/solr/solrdocument/fieldexists.xml b/reference/solr/solrdocument/fieldexists.xml deleted file mode 100644 index c69f1d151032..000000000000 --- a/reference/solr/solrdocument/fieldexists.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrDocument::fieldExists - Checks if a field exists in the document - - - - &reftitle.description; - - public boolSolrDocument::fieldExists - stringfieldName - - - Checks if the requested field as a valid fieldname in the document. - - - - - - &reftitle.parameters; - - - - fieldName - - - The name of the field. - - - - - - - - - &reftitle.returnvalues; - - Returns &true; if the field is present and &false; if it does not. - - - - - - diff --git a/reference/solr/solrdocument/get.xml b/reference/solr/solrdocument/get.xml deleted file mode 100644 index ceb77016a7d9..000000000000 --- a/reference/solr/solrdocument/get.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - SolrDocument::__get - Access the field as a property - - - - &reftitle.description; - - public SolrDocumentFieldSolrDocument::__get - stringfieldName - - - Magic method for accessing the field as a property. - - - - - - - - &reftitle.parameters; - - - - fieldName - - - The name of the field. - - - - - - - - - &reftitle.returnvalues; - - Returns a SolrDocumentField instance. - - - - - - diff --git a/reference/solr/solrdocument/getchilddocuments.xml b/reference/solr/solrdocument/getchilddocuments.xml deleted file mode 100644 index 355c7c41231f..000000000000 --- a/reference/solr/solrdocument/getchilddocuments.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - SolrDocument::getChildDocuments - Returns an array of child documents (SolrDocument) - - - - &reftitle.description; - - public arraySolrDocument::getChildDocuments - - - - Returns an array of child documents (SolrDocument) - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrDocument::hasChildDocuments - SolrDocument::getChildDocumentsCount - - - - - diff --git a/reference/solr/solrdocument/getchilddocumentscount.xml b/reference/solr/solrdocument/getchilddocumentscount.xml deleted file mode 100644 index a7098305ca5f..000000000000 --- a/reference/solr/solrdocument/getchilddocumentscount.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - SolrDocument::getChildDocumentsCount - Returns the number of child documents - - - - &reftitle.description; - - public intSolrDocument::getChildDocumentsCount - - - - Returns the number of child documents - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrDocument::hasChildDocuments - SolrDocument::getChildDocuments - - - - - - diff --git a/reference/solr/solrdocument/getfield.xml b/reference/solr/solrdocument/getfield.xml deleted file mode 100644 index a3b53d4db4e3..000000000000 --- a/reference/solr/solrdocument/getfield.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrDocument::getField - Retrieves a field by name - - - - &reftitle.description; - - public SolrDocumentFieldSolrDocument::getField - stringfieldName - - - Retrieves a field by name. - - - - - - &reftitle.parameters; - - - - fieldName - - - Name of the field. - - - - - - - - - &reftitle.returnvalues; - - Returns a SolrDocumentField on success and &false; on failure. - - - - - - diff --git a/reference/solr/solrdocument/getfieldcount.xml b/reference/solr/solrdocument/getfieldcount.xml deleted file mode 100644 index 5e5d539330d8..000000000000 --- a/reference/solr/solrdocument/getfieldcount.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - SolrDocument::getFieldCount - Returns the number of fields in this document - - - - &reftitle.description; - - public intSolrDocument::getFieldCount - - - - Returns the number of fields in this document. Multi-value fields are only counted once. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an integer on success and &false; on failure. - - - - - - diff --git a/reference/solr/solrdocument/getfieldnames.xml b/reference/solr/solrdocument/getfieldnames.xml deleted file mode 100644 index ad00efc0938d..000000000000 --- a/reference/solr/solrdocument/getfieldnames.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrDocument::getFieldNames - Returns an array of fields names in the document - - - - &reftitle.description; - - public arraySolrDocument::getFieldNames - - - - Returns an array of fields names in the document. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an array containing the names of the fields in this document. - - - - - - diff --git a/reference/solr/solrdocument/getinputdocument.xml b/reference/solr/solrdocument/getinputdocument.xml deleted file mode 100644 index c5fdb472ec8f..000000000000 --- a/reference/solr/solrdocument/getinputdocument.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrDocument::getInputDocument - Returns a SolrInputDocument equivalent of the object - - - - &reftitle.description; - - public SolrInputDocumentSolrDocument::getInputDocument - - - - Returns a SolrInputDocument equivalent of the object. This is useful if one wishes to resubmit/update a document retrieved from a query. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a SolrInputDocument on success and &null; on failure. - - - - - - diff --git a/reference/solr/solrdocument/haschilddocuments.xml b/reference/solr/solrdocument/haschilddocuments.xml deleted file mode 100644 index d8eb79be99ab..000000000000 --- a/reference/solr/solrdocument/haschilddocuments.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - SolrDocument::hasChildDocuments - Checks whether the document has any child documents - - - - &reftitle.description; - - public boolSolrDocument::hasChildDocuments - - - - Checks whether the document has any child documents - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrDocument::getChildDocuments - SolrDocument::getChildDocumentsCount - - - - - - diff --git a/reference/solr/solrdocument/isset.xml b/reference/solr/solrdocument/isset.xml deleted file mode 100644 index 48c2af060782..000000000000 --- a/reference/solr/solrdocument/isset.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - SolrDocument::__isset - Checks if a field exists - - - - &reftitle.description; - - public boolSolrDocument::__isset - stringfieldName - - - Checks if a field exists - - - - - - - - &reftitle.parameters; - - - - fieldName - - - Name of the field. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrdocument/key.xml b/reference/solr/solrdocument/key.xml deleted file mode 100644 index 7a96640687c5..000000000000 --- a/reference/solr/solrdocument/key.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrDocument::key - Retrieves the current key - - - - &reftitle.description; - - public stringSolrDocument::key - - - - Retrieves the current key. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the current key. - - - - - - diff --git a/reference/solr/solrdocument/merge.xml b/reference/solr/solrdocument/merge.xml deleted file mode 100644 index d8857d4d244a..000000000000 --- a/reference/solr/solrdocument/merge.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - SolrDocument::merge - Merges source to the current SolrDocument - - - - &reftitle.description; - - public boolSolrDocument::merge - SolrDocumentsourceDoc - booloverwrite&true; - - - Merges source to the current SolrDocument. - - - - - - &reftitle.parameters; - - - - sourceDoc - - - The source document. - - - - - overwrite - - - If this is &true; then fields with the same name in the destination document will be overwritten. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrdocument/next.xml b/reference/solr/solrdocument/next.xml deleted file mode 100644 index 1a6dace9d62f..000000000000 --- a/reference/solr/solrdocument/next.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - SolrDocument::next - Moves the internal pointer to the next field - - - - &reftitle.description; - - public voidSolrDocument::next - - - - Moves the internal pointer to the next field. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - This method has no return value. - - - - - - diff --git a/reference/solr/solrdocument/offsetexists.xml b/reference/solr/solrdocument/offsetexists.xml deleted file mode 100644 index 82cf328a9376..000000000000 --- a/reference/solr/solrdocument/offsetexists.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrDocument::offsetExists - Checks if a particular field exists - - - - &reftitle.description; - - public boolSolrDocument::offsetExists - stringfieldName - - - Checks if a particular field exists. This is used when the object is treated as an array. - - - - - - &reftitle.parameters; - - - - fieldName - - - The name of the field. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrdocument/offsetget.xml b/reference/solr/solrdocument/offsetget.xml deleted file mode 100644 index d616c56da00f..000000000000 --- a/reference/solr/solrdocument/offsetget.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - SolrDocument::offsetGet - Retrieves a field - - - - &reftitle.description; - - public SolrDocumentFieldSolrDocument::offsetGet - stringfieldName - - - This is used to retrieve the field when the object is treated as an array. - - - - - - - - &reftitle.parameters; - - - - fieldName - - - The name of the field. - - - - - - - - - &reftitle.returnvalues; - - Returns a SolrDocumentField object. - - - - - - diff --git a/reference/solr/solrdocument/offsetset.xml b/reference/solr/solrdocument/offsetset.xml deleted file mode 100644 index 193121a175e9..000000000000 --- a/reference/solr/solrdocument/offsetset.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - SolrDocument::offsetSet - Adds a field to the document - - - - &reftitle.description; - - public voidSolrDocument::offsetSet - stringfieldName - stringfieldValue - - - Used when the object is treated as an array to add a field to the document. - - - - - - &reftitle.parameters; - - - - fieldName - - - The name of the field. - - - - - fieldValue - - - The value for this field. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrdocument/offsetunset.xml b/reference/solr/solrdocument/offsetunset.xml deleted file mode 100644 index d8e167e38d07..000000000000 --- a/reference/solr/solrdocument/offsetunset.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - SolrDocument::offsetUnset - Removes a field - - - - &reftitle.description; - - public voidSolrDocument::offsetUnset - stringfieldName - - - Removes a field from the document. - - - - - - - - &reftitle.parameters; - - - - fieldName - - - The name of the field. - - - - - - - - - &reftitle.returnvalues; - - No return value. - - - - - - diff --git a/reference/solr/solrdocument/reset.xml b/reference/solr/solrdocument/reset.xml deleted file mode 100644 index 716c1a1897fa..000000000000 --- a/reference/solr/solrdocument/reset.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - SolrDocument::reset - &Alias; SolrDocument::clear - - - - &reftitle.description; - - public boolSolrDocument::reset - - - - This is an alias to SolrDocument::clear() - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrdocument/rewind.xml b/reference/solr/solrdocument/rewind.xml deleted file mode 100644 index 2a798ca238e5..000000000000 --- a/reference/solr/solrdocument/rewind.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - SolrDocument::rewind - Resets the internal pointer to the beginning - - - - &reftitle.description; - - public voidSolrDocument::rewind - - - - Resets the internal pointer to the beginning. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - This method has no return value. - - - - - - diff --git a/reference/solr/solrdocument/serialize.xml b/reference/solr/solrdocument/serialize.xml deleted file mode 100644 index 607a4ff8d4ff..000000000000 --- a/reference/solr/solrdocument/serialize.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - SolrDocument::serialize - Used for custom serialization - - - - &reftitle.description; - - public stringSolrDocument::serialize - - - - Used for custom serialization. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a string representing the serialized Solr document. - - - - - - diff --git a/reference/solr/solrdocument/set.xml b/reference/solr/solrdocument/set.xml deleted file mode 100644 index cfc74ac2a752..000000000000 --- a/reference/solr/solrdocument/set.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - SolrDocument::__set - Adds another field to the document - - - - &reftitle.description; - - public boolSolrDocument::__set - stringfieldName - stringfieldValue - - - Adds another field to the document. Used to set the fields as new properties. - - - - - - &reftitle.parameters; - - - - fieldName - - - Name of the field. - - - - - fieldValue - - - Field value. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrdocument/sort.xml b/reference/solr/solrdocument/sort.xml deleted file mode 100644 index 9a446f51cadb..000000000000 --- a/reference/solr/solrdocument/sort.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - SolrDocument::sort - Sorts the fields in the document - - - - &reftitle.description; - - public boolSolrDocument::sort - intsortOrderBy - intsortDirectionSolrDocument::SORT_ASC - - - - - - - - &reftitle.parameters; - - - - sortOrderBy - - - The sort criteria. - - - - - sortDirection - - - The sort direction. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrdocument/toarray.xml b/reference/solr/solrdocument/toarray.xml deleted file mode 100644 index e0e7b3a4cb64..000000000000 --- a/reference/solr/solrdocument/toarray.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - SolrDocument::toArray - Returns an array representation of the document - - - - &reftitle.description; - - public arraySolrDocument::toArray - - - - Returns an array representation of the document. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an array representation of the document. - - - - - &reftitle.examples; - - - <methodname>SolrDocument::toArray</methodname> example - -addField('id', 1123); - -$doc->features = "PHP Client Side"; -$doc->features = "Fast development cycles"; - -$doc['cat'] = 'Software'; -$doc['cat'] = 'Custom Search'; -$doc->cat = 'Information Technology'; - -print_r($doc->toArray()); - -?> -]]> - - &example.outputs.similar; - - 0 - [field_count] => 3 - [fields] => Array - ( - [0] => SolrDocumentField Object - ( - [name] => id - [boost] => 0 - [values] => Array - ( - [0] => 1123 - ) - - ) - - [1] => SolrDocumentField Object - ( - [name] => features - [boost] => 0 - [values] => Array - ( - [0] => PHP Client Side - [1] => Fast development cycles - ) - - ) - - [2] => SolrDocumentField Object - ( - [name] => cat - [boost] => 0 - [values] => Array - ( - [0] => Software - [1] => Custom Search - [2] => Information Technology - ) - - ) - - ) - -) -]]> - - - - - - - - diff --git a/reference/solr/solrdocument/unserialize.xml b/reference/solr/solrdocument/unserialize.xml deleted file mode 100644 index a24d6f7109d2..000000000000 --- a/reference/solr/solrdocument/unserialize.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - SolrDocument::unserialize - Custom serialization of SolrDocument objects - - - - &reftitle.description; - - public voidSolrDocument::unserialize - stringserialized - - - Custom serialization of SolrDocument objects - - - - - - - - &reftitle.parameters; - - - - serialized - - - An XML representation of the document. - - - - - - - - - &reftitle.returnvalues; - - None. - - - - - - diff --git a/reference/solr/solrdocument/unset.xml b/reference/solr/solrdocument/unset.xml deleted file mode 100644 index 4e59efcf3568..000000000000 --- a/reference/solr/solrdocument/unset.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - SolrDocument::__unset - Removes a field from the document - - - - &reftitle.description; - - public boolSolrDocument::__unset - stringfieldName - - - Removes a field from the document when the field is access as an object property. - - - - - - - - &reftitle.parameters; - - - - fieldName - - - The name of the field. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrdocument/valid.xml b/reference/solr/solrdocument/valid.xml deleted file mode 100644 index 16724130157b..000000000000 --- a/reference/solr/solrdocument/valid.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrDocument::valid - Checks if the current position internally is still valid - - - - &reftitle.description; - - public boolSolrDocument::valid - - - - Checks if the current position internally is still valid. It is used during foreach operations. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; on success and &false; if the current position is no longer valid. - - - - - - diff --git a/reference/solr/solrdocumentfield.xml b/reference/solr/solrdocumentfield.xml deleted file mode 100644 index ccb8ab0e2868..000000000000 --- a/reference/solr/solrdocumentfield.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - The SolrDocumentField class - SolrDocumentField - - - - -
    - &reftitle.intro; - - This represents a field in a Solr document. All its properties are read-only. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrDocumentField - - - - - final - SolrDocumentField - - - - &Properties; - - public - readonly - string - name - - - public - readonly - float - boost - - - public - readonly - array - values - - - - &Methods; - - - - - -
    - - - -
    - &reftitle.properties; - - - name - - The name of the field. - - - - boost - - The boost value for the field - - - - values - - An array of values for this field - - - -
    - - - -
    - - &reference.solr.entities.solrdocumentfield; - -
    - - diff --git a/reference/solr/solrdocumentfield/construct.xml b/reference/solr/solrdocumentfield/construct.xml deleted file mode 100644 index 6def2fdca3ba..000000000000 --- a/reference/solr/solrdocumentfield/construct.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrDocumentField::__construct - Constructor - - - - &reftitle.description; - - public SolrDocumentField::__construct - - - - Constructor. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - None. - - - - - - diff --git a/reference/solr/solrdocumentfield/destruct.xml b/reference/solr/solrdocumentfield/destruct.xml deleted file mode 100644 index 8dc732c399e6..000000000000 --- a/reference/solr/solrdocumentfield/destruct.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrDocumentField::__destruct - Destructor - - - - &reftitle.description; - - public SolrDocumentField::__destruct - - - - Destructor. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - None. - - - - - - diff --git a/reference/solr/solrexception.xml b/reference/solr/solrexception.xml deleted file mode 100644 index c2079d73b86e..000000000000 --- a/reference/solr/solrexception.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - The SolrException class - SolrException - - - - -
    - &reftitle.intro; - - This is the base class for all exception thrown by the Solr extension classes. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrException - - - - - SolrException - - - - extends - Exception - - - - &Properties; - - protected - int - sourceline - - - protected - string - sourcefile - - - protected - string - zif_name - - - &InheritedProperties; - - - &Methods; - - - &InheritedMethods; - - - - - -
    - - - -
    - &reftitle.properties; - - - sourceline - - The line in c-space source file where exception was generated - - - - sourcefile - - The c-space source file where exception was generated - - - - zif_name - - The c-space function where exception was generated - - - -
    - - - -
    - - &reference.solr.entities.solrexception; - -
    - - diff --git a/reference/solr/solrexception/getinternalinfo.xml b/reference/solr/solrexception/getinternalinfo.xml deleted file mode 100644 index e05e2848865b..000000000000 --- a/reference/solr/solrexception/getinternalinfo.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrException::getInternalInfo - Returns internal information where the Exception was thrown - - - - &reftitle.description; - - public arraySolrException::getInternalInfo - - - - Returns internal information where the Exception was thrown. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an array containing internal information where the error was thrown. Used only for debugging by extension developers. - - - - - - diff --git a/reference/solr/solrgenericresponse.xml b/reference/solr/solrgenericresponse.xml deleted file mode 100644 index 9b8f5b2ddd75..000000000000 --- a/reference/solr/solrgenericresponse.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - The SolrGenericResponse class - SolrGenericResponse - - - - -
    - &reftitle.intro; - - Represents a response from the solr server. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrGenericResponse - - - - - final - SolrGenericResponse - - - - extends - SolrResponse - - - - &Constants; - - const - int - SolrGenericResponse::PARSE_SOLR_OBJ - 0 - - - const - int - SolrGenericResponse::PARSE_SOLR_DOC - 1 - - - &InheritedProperties; - - - &Methods; - - - - &InheritedMethods; - - - - - -
    - - - -
    - &reftitle.constants; -
    - SolrGenericResponse Class constants - - - - SolrGenericResponse::PARSE_SOLR_OBJ - - Documents should be parsed as SolrObject instances - - - - - SolrGenericResponse::PARSE_SOLR_DOC - - Documents should be parsed as SolrDocument instances. - - - - -
    -
    - - - -
    - - &reference.solr.entities.solrgenericresponse; - -
    - - diff --git a/reference/solr/solrgenericresponse/construct.xml b/reference/solr/solrgenericresponse/construct.xml deleted file mode 100644 index 34f68909215b..000000000000 --- a/reference/solr/solrgenericresponse/construct.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrGenericResponse::__construct - Constructor - - - - &reftitle.description; - - public SolrGenericResponse::__construct - - - - Constructor - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - None - - - - - - diff --git a/reference/solr/solrgenericresponse/destruct.xml b/reference/solr/solrgenericresponse/destruct.xml deleted file mode 100644 index b742e9124009..000000000000 --- a/reference/solr/solrgenericresponse/destruct.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - SolrGenericResponse::__destruct - Destructor - - - - &reftitle.description; - - public SolrGenericResponse::__destruct - - - - Destructor. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - None - - - - - - diff --git a/reference/solr/solrillegalargumentexception.xml b/reference/solr/solrillegalargumentexception.xml deleted file mode 100644 index f674dac425f6..000000000000 --- a/reference/solr/solrillegalargumentexception.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - The SolrIllegalArgumentException class - SolrIllegalArgumentException - - - - -
    - &reftitle.intro; - - This object is thrown when an illegal or invalid argument is passed to a method. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrIllegalArgumentException - - - - - SolrIllegalArgumentException - - - - extends - SolrException - - - - &InheritedProperties; - - - - &Methods; - - - &InheritedMethods; - - - - - - -
    - - -
    - - &reference.solr.entities.solrillegalargumentexception; - -
    - - diff --git a/reference/solr/solrillegalargumentexception/getinternalinfo.xml b/reference/solr/solrillegalargumentexception/getinternalinfo.xml deleted file mode 100644 index b71bc780fa5c..000000000000 --- a/reference/solr/solrillegalargumentexception/getinternalinfo.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - SolrIllegalArgumentException::getInternalInfo - Returns internal information where the Exception was thrown - - - - &reftitle.description; - - public arraySolrIllegalArgumentException::getInternalInfo - - - - Returns internal information where the Exception was thrown. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an array containing internal information where the error was thrown. Used only for debugging by extension developers. - - - - - - diff --git a/reference/solr/solrillegaloperationexception.xml b/reference/solr/solrillegaloperationexception.xml deleted file mode 100644 index 68b0d6c703be..000000000000 --- a/reference/solr/solrillegaloperationexception.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - The SolrIllegalOperationException class - SolrIllegalOperationException - - - - -
    - &reftitle.intro; - - This object is thrown when an illegal or unsupported operation is performed on an object. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrIllegalOperationException - - - - - SolrIllegalOperationException - - - - extends - SolrException - - - - &InheritedProperties; - - - - &Methods; - - - &InheritedMethods; - - - - - - -
    - - -
    - - &reference.solr.entities.solrillegaloperationexception; - -
    - - diff --git a/reference/solr/solrillegaloperationexception/getinternalinfo.xml b/reference/solr/solrillegaloperationexception/getinternalinfo.xml deleted file mode 100644 index 03c0864550f9..000000000000 --- a/reference/solr/solrillegaloperationexception/getinternalinfo.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - SolrIllegalOperationException::getInternalInfo - Returns internal information where the Exception was thrown - - - - &reftitle.description; - - public arraySolrIllegalOperationException::getInternalInfo - - - - Returns internal information where the Exception was thrown. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an array containing internal information where the error was thrown. Used only for debugging by extension developers. - - - - - - diff --git a/reference/solr/solrinputdocument.xml b/reference/solr/solrinputdocument.xml deleted file mode 100644 index 66cd286268ec..000000000000 --- a/reference/solr/solrinputdocument.xml +++ /dev/null @@ -1,162 +0,0 @@ - - - - - - The SolrInputDocument class - SolrInputDocument - - - - -
    - &reftitle.intro; - - This class represents a Solr document that is about to be submitted to the Solr index. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrInputDocument - - - - - final - SolrInputDocument - - - - &Constants; - - const - int - SolrInputDocument::SORT_DEFAULT - 1 - - - const - int - SolrInputDocument::SORT_ASC - 1 - - - const - int - SolrInputDocument::SORT_DESC - 2 - - - const - int - SolrInputDocument::SORT_FIELD_NAME - 1 - - - const - int - SolrInputDocument::SORT_FIELD_VALUE_COUNT - 2 - - - const - int - SolrInputDocument::SORT_FIELD_BOOST_VALUE - 4 - - - &Methods; - - - - - - -
    - - -
    - &reftitle.constants; -
    - SolrInputDocument Class Constants - - - - SolrInputDocument::SORT_DEFAULT - - Sorts the fields in ascending order. - - - - - SolrInputDocument::SORT_ASC - - Sorts the fields in ascending order. - - - - - SolrInputDocument::SORT_DESC - - Sorts the fields in descending order. - - - - - SolrInputDocument::SORT_FIELD_NAME - - Sorts the fields by name - - - - - SolrInputDocument::SORT_FIELD_VALUE_COUNT - - Sorts the fields by number of values. - - - - - SolrInputDocument::SORT_FIELD_BOOST_VALUE - - Sorts the fields by boost value. - - - - -
    -
    - - - -
    - - &reference.solr.entities.solrinputdocument; - -
    - - diff --git a/reference/solr/solrinputdocument/addchilddocument.xml b/reference/solr/solrinputdocument/addchilddocument.xml deleted file mode 100644 index 325314f5d56a..000000000000 --- a/reference/solr/solrinputdocument/addchilddocument.xml +++ /dev/null @@ -1,162 +0,0 @@ - - - - - - SolrInputDocument::addChildDocument - Adds a child document for block indexing - - - - &reftitle.description; - - public voidSolrInputDocument::addChildDocument - SolrInputDocumentchild - - - Adds a child document to construct a document block with nested documents. - - - - - &reftitle.parameters; - - - child - - - A SolrInputDocument object. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - Throws SolrIllegalArgumentException on failure. - - - Throws SolrException on internal failure. - - - - - &reftitle.examples; - - <function>SolrInputDocument::addChildDocument</function> example - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, - 'path' => SOLR_SERVER_STORE_PATH, -); - -$client = new SolrClient($options); - -$product = new SolrInputDocument(); - -$product->addField('id', 'P-BLACK'); -$product->addField('cat', 'tshirt'); -$product->addField('cat', 'polo'); -$product->addField('content_type', 'product'); - -$small = new SolrInputDocument(); -$small->addField('id', 'TS-BLK-S'); -$small->addField('content_type', 'sku'); -$small->addField('size', 'S'); -$small->addField('inventory', 100); - -$medium = new SolrInputDocument(); -$medium->addField('id', 'TS-BLK-M'); -$medium->addField('content_type', 'sku'); -$medium->addField('size', 'M'); -$medium->addField('inventory', 200); - -$large = new SolrInputDocument(); -$large->addField('id', 'TS-BLK-L'); -$large->addField('content_type', 'sku'); -$large->addField('size', 'L'); -$large->addField('inventory', 300); - -// add child documents -$product->addChildDocument($small); -$product->addChildDocument($medium); -$product->addChildDocument($large); - -// add product document block to the index -$updateResponse = $client->addDocument( - $product, - true, // overwrite if the document exists - 10000 // commit within 10 seconds -); - -print_r($updateResponse->getResponse()); - -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [status] => 0 - [QTime] => 5 - ) -) -]]> - - - - - - - &reftitle.seealso; - - SolrInputDocument::addChildDocuments - SolrInputDocument::hasChildDocuments - SolrInputDocument::getChildDocuments - SolrInputDocument::getChildDocumentsCount - - - - - - diff --git a/reference/solr/solrinputdocument/addchilddocuments.xml b/reference/solr/solrinputdocument/addchilddocuments.xml deleted file mode 100644 index a2c56ae4cf76..000000000000 --- a/reference/solr/solrinputdocument/addchilddocuments.xml +++ /dev/null @@ -1,162 +0,0 @@ - - - - - - SolrInputDocument::addChildDocuments - Adds an array of child documents - - - - &reftitle.description; - - public voidSolrInputDocument::addChildDocuments - arraydocs - - - Adds an array of child documents to the current input document. - - - - - - &reftitle.parameters; - - - docs - - - An array of SolrInputDocument objects. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - Throws SolrIllegalArgumentException on failure. - - - Throws SolrException on internal failure. - - - - - &reftitle.examples; - - <function>SolrInputDocument::addChildDocuments</function> example - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, - 'path' => SOLR_SERVER_STORE_PATH, -); - -$client = new SolrClient($options); - -$product = new SolrInputDocument(); - -$product->addField('id', 'P-BLACK'); -$product->addField('cat', 'tshirt'); -$product->addField('cat', 'polo'); -$product->addField('content_type', 'product'); - -$small = new SolrInputDocument(); -$small->addField('id', 'TS-BLK-S'); -$small->addField('content_type', 'sku'); -$small->addField('size', 'S'); -$small->addField('inventory', 100); - -$medium = new SolrInputDocument(); -$medium->addField('id', 'TS-BLK-M'); -$medium->addField('content_type', 'sku'); -$medium->addField('size', 'M'); -$medium->addField('inventory', 200); - -$large = new SolrInputDocument(); -$large->addField('id', 'TS-BLK-L'); -$large->addField('content_type', 'sku'); -$large->addField('size', 'L'); -$large->addField('inventory', 300); - -// add child documents -$skus = [$small, $medium, $large]; -$product->addChildDocuments($skus); - -// add the product document block to the index -$updateResponse = $client->addDocument( - $product, - true, // overwrite if the document exists - 10000 // commit within 10 seconds -); - -print_r($updateResponse->getResponse()); - -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [status] => 0 - [QTime] => 5 - ) -) -]]> - - - - - - - &reftitle.seealso; - - SolrInputDocument::addChildDocument - SolrInputDocument::hasChildDocuments - SolrInputDocument::getChildDocuments - SolrInputDocument::getChildDocumentsCount - - - - - - diff --git a/reference/solr/solrinputdocument/addfield.xml b/reference/solr/solrinputdocument/addfield.xml deleted file mode 100644 index 5af9e4e65946..000000000000 --- a/reference/solr/solrinputdocument/addfield.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - SolrInputDocument::addField - Adds a field to the document - - - - &reftitle.description; - - public boolSolrInputDocument::addField - stringfieldName - stringfieldValue - floatfieldBoostValue0.0 - - - For multi-value fields, if a valid boost value is specified, the specified value will be multiplied by the current boost value for this field. - - - - - - &reftitle.parameters; - - - - fieldName - - - The name of the field - - - - - fieldValue - - - The value for the field. - - - - - fieldBoostValue - - - The index time boost for the field. Though this cannot be negative, you can still pass values less than 1.0 but they must be greater than zero. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrinputdocument/clear.xml b/reference/solr/solrinputdocument/clear.xml deleted file mode 100644 index 2e9921d686e3..000000000000 --- a/reference/solr/solrinputdocument/clear.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrInputDocument::clear - Resets the input document - - - - &reftitle.description; - - public boolSolrInputDocument::clear - - - - Resets the document by dropping all the fields and resets the document boost to zero. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrinputdocument/clone.xml b/reference/solr/solrinputdocument/clone.xml deleted file mode 100644 index d372d6c617e0..000000000000 --- a/reference/solr/solrinputdocument/clone.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrInputDocument::__clone - Creates a copy of a SolrDocument - - - - &reftitle.description; - - public voidSolrInputDocument::__clone - - - - Should not be called directly. It is used to create a deep copy of a SolrInputDocument. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Creates a new SolrInputDocument instance. - - - - - - diff --git a/reference/solr/solrinputdocument/construct.xml b/reference/solr/solrinputdocument/construct.xml deleted file mode 100644 index cd62c7b62cc0..000000000000 --- a/reference/solr/solrinputdocument/construct.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrInputDocument::__construct - Constructor - - - - &reftitle.description; - - public SolrInputDocument::__construct - - - - Constructor. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - None. - - - - - - diff --git a/reference/solr/solrinputdocument/deletefield.xml b/reference/solr/solrinputdocument/deletefield.xml deleted file mode 100644 index 2aca3b9e6697..000000000000 --- a/reference/solr/solrinputdocument/deletefield.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrInputDocument::deleteField - Removes a field from the document - - - - &reftitle.description; - - public boolSolrInputDocument::deleteField - stringfieldName - - - Removes a field from the document. - - - - - - &reftitle.parameters; - - - - fieldName - - - The name of the field. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrinputdocument/destruct.xml b/reference/solr/solrinputdocument/destruct.xml deleted file mode 100644 index 3e7649fe3f0a..000000000000 --- a/reference/solr/solrinputdocument/destruct.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - SolrInputDocument::__destruct - Destructor - - - - &reftitle.description; - - public SolrInputDocument::__destruct - - - - Destructor - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - None. - - - - - - diff --git a/reference/solr/solrinputdocument/fieldexists.xml b/reference/solr/solrinputdocument/fieldexists.xml deleted file mode 100644 index d5c7594f09ee..000000000000 --- a/reference/solr/solrinputdocument/fieldexists.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrInputDocument::fieldExists - Checks if a field exists - - - - &reftitle.description; - - public boolSolrInputDocument::fieldExists - stringfieldName - - - Checks if a field exists - - - - - - &reftitle.parameters; - - - - fieldName - - - Name of the field. - - - - - - - - - &reftitle.returnvalues; - - Returns &true; if the field was found and &false; if it was not found. - - - - - - diff --git a/reference/solr/solrinputdocument/getboost.xml b/reference/solr/solrinputdocument/getboost.xml deleted file mode 100644 index d607dd300ac2..000000000000 --- a/reference/solr/solrinputdocument/getboost.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - SolrInputDocument::getBoost - Retrieves the current boost value for the document - - - - &reftitle.description; - - public floatSolrInputDocument::getBoost - - - - Retrieves the current boost value for the document. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the boost value on success and &false; on failure. - - - - - - diff --git a/reference/solr/solrinputdocument/getchilddocuments.xml b/reference/solr/solrinputdocument/getchilddocuments.xml deleted file mode 100644 index c9b7772764c9..000000000000 --- a/reference/solr/solrinputdocument/getchilddocuments.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - SolrInputDocument::getChildDocuments - Returns an array of child documents (SolrInputDocument) - - - - &reftitle.description; - - public arraySolrInputDocument::getChildDocuments - - - - Returns an array of child documents (SolrInputDocument) - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrInputDocument::addChildDocument - SolrInputDocument::addChildDocuments - SolrInputDocument::hasChildDocuments - SolrInputDocument::getChildDocumentsCount - - - - - - diff --git a/reference/solr/solrinputdocument/getchilddocumentscount.xml b/reference/solr/solrinputdocument/getchilddocumentscount.xml deleted file mode 100644 index cced021d0c94..000000000000 --- a/reference/solr/solrinputdocument/getchilddocumentscount.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - SolrInputDocument::getChildDocumentsCount - Returns the number of child documents - - - - &reftitle.description; - - public intSolrInputDocument::getChildDocumentsCount - - - - Returns the number of child documents - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrInputDocument::addChildDocument - SolrInputDocument::addChildDocuments - SolrInputDocument::hasChildDocuments - SolrInputDocument::getChildDocuments - - - - - - diff --git a/reference/solr/solrinputdocument/getfield.xml b/reference/solr/solrinputdocument/getfield.xml deleted file mode 100644 index 07e4a918aaf8..000000000000 --- a/reference/solr/solrinputdocument/getfield.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrInputDocument::getField - Retrieves a field by name - - - - &reftitle.description; - - public SolrDocumentFieldSolrInputDocument::getField - stringfieldName - - - Retrieves a field in the document. - - - - - - &reftitle.parameters; - - - - fieldName - - - The name of the field. - - - - - - - - - &reftitle.returnvalues; - - Returns a SolrDocumentField object on success and &false; on failure. - - - - - - diff --git a/reference/solr/solrinputdocument/getfieldboost.xml b/reference/solr/solrinputdocument/getfieldboost.xml deleted file mode 100644 index 02562be4edfe..000000000000 --- a/reference/solr/solrinputdocument/getfieldboost.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrInputDocument::getFieldBoost - Retrieves the boost value for a particular field - - - - &reftitle.description; - - public floatSolrInputDocument::getFieldBoost - stringfieldName - - - Retrieves the boost value for a particular field. - - - - - - &reftitle.parameters; - - - - fieldName - - - The name of the field. - - - - - - - - - &reftitle.returnvalues; - - Returns the boost value for the field or &false; if there was an error. - - - - - - diff --git a/reference/solr/solrinputdocument/getfieldcount.xml b/reference/solr/solrinputdocument/getfieldcount.xml deleted file mode 100644 index eabfeb5abde7..000000000000 --- a/reference/solr/solrinputdocument/getfieldcount.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrInputDocument::getFieldCount - Returns the number of fields in the document - - - - &reftitle.description; - - public intfalseSolrInputDocument::getFieldCount - - - - Returns the number of fields in the document. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an integer on success&return.falseforfailure;. - - - - - - diff --git a/reference/solr/solrinputdocument/getfieldnames.xml b/reference/solr/solrinputdocument/getfieldnames.xml deleted file mode 100644 index dda4b6368a0e..000000000000 --- a/reference/solr/solrinputdocument/getfieldnames.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrInputDocument::getFieldNames - Returns an array containing all the fields in the document - - - - &reftitle.description; - - public arraySolrInputDocument::getFieldNames - - - - Returns an array containing all the fields in the document. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an array on success and &false; on failure. - - - - - - diff --git a/reference/solr/solrinputdocument/haschilddocuments.xml b/reference/solr/solrinputdocument/haschilddocuments.xml deleted file mode 100644 index aa25dce3ed3d..000000000000 --- a/reference/solr/solrinputdocument/haschilddocuments.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - SolrInputDocument::hasChildDocuments - Returns true if the document has any child documents - - - - &reftitle.description; - - public boolSolrInputDocument::hasChildDocuments - - - - Checks whether the document has any child documents - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrInputDocument::addChildDocument - SolrInputDocument::addChildDocuments - SolrInputDocument::getChildDocuments - SolrInputDocument::getChildDocumentsCount - - - - - - diff --git a/reference/solr/solrinputdocument/merge.xml b/reference/solr/solrinputdocument/merge.xml deleted file mode 100644 index ef7b0607c6d6..000000000000 --- a/reference/solr/solrinputdocument/merge.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - SolrInputDocument::merge - Merges one input document into another - - - - &reftitle.description; - - public boolSolrInputDocument::merge - SolrInputDocumentsourceDoc - booloverwrite&true; - - - Merges one input document into another. - - - - - - &reftitle.parameters; - - - - sourceDoc - - - The source document. - - - - - overwrite - - - If this is &true; it will replace matching fields in the destination document. - - - - - - - - - &reftitle.returnvalues; - - &return.success; In the future, this will be modified to return the number of fields in the new document. - - - - - - diff --git a/reference/solr/solrinputdocument/reset.xml b/reference/solr/solrinputdocument/reset.xml deleted file mode 100644 index dab04e32050a..000000000000 --- a/reference/solr/solrinputdocument/reset.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - SolrInputDocument::reset - &Alias; SolrInputDocument::clear - - - - &reftitle.description; - - public boolSolrInputDocument::reset - - - - This is an alias of SolrInputDocument::clear - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - diff --git a/reference/solr/solrinputdocument/setboost.xml b/reference/solr/solrinputdocument/setboost.xml deleted file mode 100644 index 4cfc81fa2df3..000000000000 --- a/reference/solr/solrinputdocument/setboost.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrInputDocument::setBoost - Sets the boost value for this document - - - - &reftitle.description; - - public boolSolrInputDocument::setBoost - floatdocumentBoostValue - - - Sets the boost value for this document. - - - - - - &reftitle.parameters; - - - - documentBoostValue - - - The index-time boost value for this document. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrinputdocument/setfieldboost.xml b/reference/solr/solrinputdocument/setfieldboost.xml deleted file mode 100644 index c6cd0e4a228c..000000000000 --- a/reference/solr/solrinputdocument/setfieldboost.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - SolrInputDocument::setFieldBoost - Sets the index-time boost value for a field - - - - &reftitle.description; - - public boolSolrInputDocument::setFieldBoost - stringfieldName - floatfieldBoostValue - - - Sets the index-time boost value for a field. This replaces the current boost value for this field. - - - - - - &reftitle.parameters; - - - - fieldName - - - The name of the field. - - - - - fieldBoostValue - - - The index time boost value. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrinputdocument/sort.xml b/reference/solr/solrinputdocument/sort.xml deleted file mode 100644 index 4849f40cc499..000000000000 --- a/reference/solr/solrinputdocument/sort.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - SolrInputDocument::sort - Sorts the fields within the document - - - - &reftitle.description; - - public boolSolrInputDocument::sort - intsortOrderBy - intsortDirectionSolrInputDocument::SORT_ASC - - - - - - - - - - - &reftitle.parameters; - - - - sortOrderBy - - - The sort criteria - - - - - sortDirection - - - The sort direction - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrinputdocument/toarray.xml b/reference/solr/solrinputdocument/toarray.xml deleted file mode 100644 index 43eda7dacdd7..000000000000 --- a/reference/solr/solrinputdocument/toarray.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrInputDocument::toArray - Returns an array representation of the input document - - - - &reftitle.description; - - public arraySolrInputDocument::toArray - - - - Returns an array representation of the input document. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an array containing the fields. It returns &false; on failure. - - - - - - diff --git a/reference/solr/solrmissingmandatoryparameterexception.xml b/reference/solr/solrmissingmandatoryparameterexception.xml deleted file mode 100644 index 725c676c3644..000000000000 --- a/reference/solr/solrmissingmandatoryparameterexception.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - The SolrMissingMandatoryParameterException class - SolrMissingMandatoryParameterException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrMissingMandatoryParameterException - - - - - SolrMissingMandatoryParameterException - - - - extends - SolrException - - - - &InheritedProperties; - - - - - &InheritedMethods; - - - - - - -
    - -
    - - - -
    - - diff --git a/reference/solr/solrmodifiableparams.xml b/reference/solr/solrmodifiableparams.xml deleted file mode 100644 index 4288151ba9f0..000000000000 --- a/reference/solr/solrmodifiableparams.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - The SolrModifiableParams class - SolrModifiableParams - - - - -
    - &reftitle.intro; - - Represents a collection of name-value pairs sent to the Solr server during a request. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrModifiableParams - - - - - SolrModifiableParams - - - - extends - SolrParams - - - - Serializable - - - - - &Methods; - - - - &InheritedMethods; - - - - - -
    - -
    - - &reference.solr.entities.solrmodifiableparams; - -
    - - diff --git a/reference/solr/solrmodifiableparams/construct.xml b/reference/solr/solrmodifiableparams/construct.xml deleted file mode 100644 index c4c1f164b454..000000000000 --- a/reference/solr/solrmodifiableparams/construct.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrModifiableParams::__construct - Constructor - - - - &reftitle.description; - - public SolrModifiableParams::__construct - - - - Constructor - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - None - - - - - - diff --git a/reference/solr/solrmodifiableparams/destruct.xml b/reference/solr/solrmodifiableparams/destruct.xml deleted file mode 100644 index 60f318193228..000000000000 --- a/reference/solr/solrmodifiableparams/destruct.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrModifiableParams::__destruct - Destructor - - - - &reftitle.description; - - public SolrModifiableParams::__destruct - - - - Destructor - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - None - - - - - - diff --git a/reference/solr/solrobject.xml b/reference/solr/solrobject.xml deleted file mode 100644 index 1b348965c82e..000000000000 --- a/reference/solr/solrobject.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - The SolrObject class - SolrObject - - - - -
    - &reftitle.intro; - - This is an object whose properties can also by accessed using the array syntax. All its properties are read-only. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrObject - - - - - final - SolrObject - - - - ArrayAccess - - - - - &Methods; - - - - - - -
    - -
    - - &reference.solr.entities.solrobject; - -
    - - diff --git a/reference/solr/solrobject/construct.xml b/reference/solr/solrobject/construct.xml deleted file mode 100644 index 19ddfd32e454..000000000000 --- a/reference/solr/solrobject/construct.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - SolrObject::__construct - Creates Solr object - - - - &reftitle.description; - - public SolrObject::__construct - - - - Creates Solr object. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - None - - - - - &reftitle.examples; - - - <methodname>SolrObject::__construct</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/solr/solrobject/destruct.xml b/reference/solr/solrobject/destruct.xml deleted file mode 100644 index 2c9ac140187b..000000000000 --- a/reference/solr/solrobject/destruct.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrObject::__destruct - Destructor - - - - &reftitle.description; - - public SolrObject::__destruct - - - - The destructor - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - None. - - - - - - diff --git a/reference/solr/solrobject/getpropertynames.xml b/reference/solr/solrobject/getpropertynames.xml deleted file mode 100644 index 0d165fd2691a..000000000000 --- a/reference/solr/solrobject/getpropertynames.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrObject::getPropertyNames - Returns an array of all the names of the properties - - - - &reftitle.description; - - public arraySolrObject::getPropertyNames - - - - Returns an array of all the names of the properties - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an array. - - - - - - diff --git a/reference/solr/solrobject/offsetexists.xml b/reference/solr/solrobject/offsetexists.xml deleted file mode 100644 index c33bfd1e383b..000000000000 --- a/reference/solr/solrobject/offsetexists.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrObject::offsetExists - Checks if the property exists - - - - &reftitle.description; - - public boolSolrObject::offsetExists - stringproperty_name - - - Checks if the property exists. This is used when the object is treated as an array. - - - - - - &reftitle.parameters; - - - - property_name - - - The name of the property. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrobject/offsetget.xml b/reference/solr/solrobject/offsetget.xml deleted file mode 100644 index b33b07b753a2..000000000000 --- a/reference/solr/solrobject/offsetget.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - SolrObject::offsetGet - Used to retrieve a property - - - - &reftitle.description; - - public mixedSolrObject::offsetGet - stringproperty_name - - - Used to get the value of a property. This is used when the object is treated as an array. - - - - - &reftitle.parameters; - - - - property_name - - - Name of the property. - - - - - - - - - &reftitle.returnvalues; - - Returns the property value. - - - - - - diff --git a/reference/solr/solrobject/offsetset.xml b/reference/solr/solrobject/offsetset.xml deleted file mode 100644 index afeecfbb8d95..000000000000 --- a/reference/solr/solrobject/offsetset.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - SolrObject::offsetSet - Sets the value for a property - - - - &reftitle.description; - - public voidSolrObject::offsetSet - stringproperty_name - stringproperty_value - - - Sets the value for a property. This is used when the object is treated as an array. This object is read-only. This should never be attempted. - - - - - - &reftitle.parameters; - - - - property_name - - - The name of the property. - - - - - property_value - - - The new value. - - - - - - - - - &reftitle.returnvalues; - - None. - - - - - - diff --git a/reference/solr/solrobject/offsetunset.xml b/reference/solr/solrobject/offsetunset.xml deleted file mode 100644 index 7c842b867315..000000000000 --- a/reference/solr/solrobject/offsetunset.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - SolrObject::offsetUnset - Unsets the value for the property - - - - &reftitle.description; - - public voidSolrObject::offsetUnset - stringproperty_name - - - Unsets the value for the property. This is used when the object is treated as an array. This object is read-only. This should never be attempted. - - - - - - &reftitle.parameters; - - - - property_name - - - The name of the property. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - <methodname>SolrObject::offsetUnset</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/solr/solrparams.xml b/reference/solr/solrparams.xml deleted file mode 100644 index c8a84f1f6d4d..000000000000 --- a/reference/solr/solrparams.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - The SolrParams class - SolrParams - - - - -
    - &reftitle.intro; - - Represents a collection of name-value pairs sent to the Solr server during a request. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrParams - - - - - abstract - SolrParams - - - - Serializable - - - - - - &Methods; - - - - -
    - -
    - - &reference.solr.entities.solrparams; - -
    - - diff --git a/reference/solr/solrparams/add.xml b/reference/solr/solrparams/add.xml deleted file mode 100644 index da7cab6fb90c..000000000000 --- a/reference/solr/solrparams/add.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - SolrParams::add - &Alias; SolrParams::addParam - - - - &reftitle.description; - - final public SolrParamsSolrParams::add - stringname - stringvalue - - - This is an alias for SolrParams::addParam - - - - - - &reftitle.parameters; - - - - name - - - The name of the parameter - - - - - value - - - The value of the parameter - - - - - - - - - &reftitle.returnvalues; - -Returns a SolrParams instance on success - - - - - - - diff --git a/reference/solr/solrparams/addparam.xml b/reference/solr/solrparams/addparam.xml deleted file mode 100644 index 53d74b3fd7be..000000000000 --- a/reference/solr/solrparams/addparam.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - SolrParams::addParam - Adds a parameter to the object - - - - &reftitle.description; - - public SolrParamsSolrParams::addParam - stringname - stringvalue - - - Adds a parameter to the object. This is used for parameters that can be specified multiple times. - - - - - &reftitle.parameters; - - - - name - - - Name of parameter - - - - - value - - - Value of parameter - - - - - - - - - &reftitle.returnvalues; - - Returns a SolrParam object on success and &false; on failure. - - - - - - diff --git a/reference/solr/solrparams/get.xml b/reference/solr/solrparams/get.xml deleted file mode 100644 index f7d12d45d196..000000000000 --- a/reference/solr/solrparams/get.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - SolrParams::get - &Alias; SolrParams::getParam - - - - &reftitle.description; - - final public mixedSolrParams::get - stringparam_name - - - This is an alias for SolrParams::getParam - - - - - - &reftitle.parameters; - - - - param_name - - - Then name of the parameter - - - - - - - - - &reftitle.returnvalues; - -Returns an array or string depending on the type of parameter - - - - - - - diff --git a/reference/solr/solrparams/getparam.xml b/reference/solr/solrparams/getparam.xml deleted file mode 100644 index d1ed755cbd7c..000000000000 --- a/reference/solr/solrparams/getparam.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - SolrParams::getParam - Returns a parameter value - - - - &reftitle.description; - - final public mixedSolrParams::getParam - stringparam_name - - - Returns a parameter with name param_name. - - - - - - &reftitle.parameters; - - - - param_name - - - The name of the parameter. - - - - - - - - - &reftitle.returnvalues; - - Returns a &string; or an &array; depending on the type of the parameter. - - - - - - - diff --git a/reference/solr/solrparams/getparams.xml b/reference/solr/solrparams/getparams.xml deleted file mode 100644 index 1d2295e07c55..000000000000 --- a/reference/solr/solrparams/getparams.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrParams::getParams - Returns an array of non URL-encoded parameters - - - - &reftitle.description; - - final public arraySolrParams::getParams - - - - Returns an array of non URL-encoded parameters - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an array of non URL-encoded parameters - - - - - - diff --git a/reference/solr/solrparams/getpreparedparams.xml b/reference/solr/solrparams/getpreparedparams.xml deleted file mode 100644 index f38f9c8ead39..000000000000 --- a/reference/solr/solrparams/getpreparedparams.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrParams::getPreparedParams - Returns an array of URL-encoded parameters - - - - &reftitle.description; - - final public arraySolrParams::getPreparedParams - - - - Returns an array on URL-encoded parameters - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an array on URL-encoded parameters - - - - - - diff --git a/reference/solr/solrparams/serialize.xml b/reference/solr/solrparams/serialize.xml deleted file mode 100644 index e6d193bd6ccc..000000000000 --- a/reference/solr/solrparams/serialize.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - SolrParams::serialize - Used for custom serialization - - - - &reftitle.description; - - final public stringSolrParams::serialize - - - - Used for custom serialization - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Used for custom serialization - - - - - - diff --git a/reference/solr/solrparams/set.xml b/reference/solr/solrparams/set.xml deleted file mode 100644 index ee22bd40cbc9..000000000000 --- a/reference/solr/solrparams/set.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - SolrParams::set - &Alias; SolrParams::setParam - - - - &reftitle.description; - - final public voidSolrParams::set - stringname - stringvalue - - - An alias of SolrParams::setParam - - - - - &reftitle.parameters; - - - - name - - - Then name of the parameter - - - - - value - - - The parameter value - - - - - - - - - &reftitle.returnvalues; - -Returns an instance of the SolrParams object on success - - - - - - - diff --git a/reference/solr/solrparams/setparam.xml b/reference/solr/solrparams/setparam.xml deleted file mode 100644 index 14ba4203f26d..000000000000 --- a/reference/solr/solrparams/setparam.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - SolrParams::setParam - Sets the parameter to the specified value - - - - &reftitle.description; - - public SolrParamsSolrParams::setParam - stringname - stringvalue - - - Sets the query parameter to the specified value. This is used for parameters that can only be specified once. Subsequent calls with the same parameter name will override the existing value - - - - - - &reftitle.parameters; - - - - name - - - Name of the parameter - - - - - value - - - Value of the parameter - - - - - - - - - &reftitle.returnvalues; - - Returns a SolrParam object on success and &false; on value. - - - - - &reftitle.examples; - - - <methodname>SolrParams::setParam</methodname> example - -setParam('q', 'solr')->setParam('rows', 2); - -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/solr/solrparams/tostring.xml b/reference/solr/solrparams/tostring.xml deleted file mode 100644 index 6e7f2c9899b2..000000000000 --- a/reference/solr/solrparams/tostring.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - SolrParams::toString - Returns all the name-value pair parameters in the object - - - - &reftitle.description; - - final public stringSolrParams::toString - boolurl_encode&false; - - - Returns all the name-value pair parameters in the object - - - - - - &reftitle.parameters; - - - - url_encode - - - Whether to return URL-encoded values - - - - - - - - - &reftitle.returnvalues; - - Returns a string on success and &false; on failure. - - - - - - - diff --git a/reference/solr/solrparams/unserialize.xml b/reference/solr/solrparams/unserialize.xml deleted file mode 100644 index 62b5e6d20847..000000000000 --- a/reference/solr/solrparams/unserialize.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - SolrParams::unserialize - Used for custom serialization - - - - &reftitle.description; - - final public voidSolrParams::unserialize - stringserialized - - - Used for custom serialization - - - - - &reftitle.parameters; - - - - serialized - - - The serialized representation of the object - - - - - - - - - &reftitle.returnvalues; - - None - - - - - - diff --git a/reference/solr/solrpingresponse.xml b/reference/solr/solrpingresponse.xml deleted file mode 100644 index d6f277b275b8..000000000000 --- a/reference/solr/solrpingresponse.xml +++ /dev/null @@ -1,192 +0,0 @@ - - - - - - The SolrPingResponse class - SolrPingResponse - - - - -
    - &reftitle.intro; - - Represents a response to a ping request to the server - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrPingResponse - - - - - final - SolrPingResponse - - - - extends - SolrResponse - - - - &Constants; - - const - int - SolrPingResponse::PARSE_SOLR_OBJ - 0 - - - const - int - SolrPingResponse::PARSE_SOLR_DOC - 1 - - - &Properties; - - - &Methods; - - - - - &InheritedMethods; - - - - - -
    - - - -
    - &reftitle.properties; - - - http_status - - The http status of the response. - - - - parser_mode - - Whether to parse the solr documents as SolrObject or SolrDocument instances. - - - - success - - Was there an error during the request - - - - http_status_message - - Detailed message on http status - - - - http_request_url - - The request URL - - - - http_raw_request_headers - - A string of raw headers sent during the request - - - - http_raw_request - - The raw request sent to the server - - - - http_raw_response_headers - - Response headers from the Solr server - - - - http_raw_response - - The response message from the server - - - - http_digested_response - - The response in PHP serialized format. - - - -
    - - - - -
    - &reftitle.constants; -
    - SolrPingResponse Class Constants - - - - SolrPingResponse::PARSE_SOLR_OBJ - - Documents should be parsed as SolrObject instances - - - - - SolrPingResponse::PARSE_SOLR_DOC - - Documents should be parsed as SolrDocument instances. - - - - -
    -
    - - - -
    - - &reference.solr.entities.solrpingresponse; - -
    - - diff --git a/reference/solr/solrpingresponse/construct.xml b/reference/solr/solrpingresponse/construct.xml deleted file mode 100644 index b675465ccaf4..000000000000 --- a/reference/solr/solrpingresponse/construct.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - SolrPingResponse::__construct - Constructor - - - - &reftitle.description; - - public SolrPingResponse::__construct - - - - Constructor - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - None - - - - - - diff --git a/reference/solr/solrpingresponse/destruct.xml b/reference/solr/solrpingresponse/destruct.xml deleted file mode 100644 index d52c0e201a64..000000000000 --- a/reference/solr/solrpingresponse/destruct.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - SolrPingResponse::__destruct - Destructor - - - - &reftitle.description; - - public SolrPingResponse::__destruct - - - - Destructor - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - None - - - - - - diff --git a/reference/solr/solrpingresponse/getresponse.xml b/reference/solr/solrpingresponse/getresponse.xml deleted file mode 100644 index 033dad2a00a9..000000000000 --- a/reference/solr/solrpingresponse/getresponse.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrPingResponse::getResponse - Returns the response from the server - - - - &reftitle.description; - - public stringSolrPingResponse::getResponse - - - - Returns the response from the server. This should be empty because the request as a HEAD request. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an empty string. - - - - - - diff --git a/reference/solr/solrquery.xml b/reference/solr/solrquery.xml deleted file mode 100644 index 0e9c18ed6baf..000000000000 --- a/reference/solr/solrquery.xml +++ /dev/null @@ -1,176 +0,0 @@ - - - - - - The SolrQuery class - SolrQuery - - - - -
    - &reftitle.intro; - - Represents a collection of name-value pairs sent to the Solr server during a request. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrQuery - - - - - SolrQuery - - - - extends - SolrModifiableParams - - - - Serializable - - - - &Constants; - - const - int - SolrQuery::ORDER_ASC - 0 - - - const - int - SolrQuery::ORDER_DESC - 1 - - - const - int - SolrQuery::FACET_SORT_INDEX - 0 - - - const - int - SolrQuery::FACET_SORT_COUNT - 1 - - - const - int - SolrQuery::TERMS_SORT_INDEX - 0 - - - const - int - SolrQuery::TERMS_SORT_COUNT - 1 - - - &Properties; - - - &Methods; - - - - - &InheritedMethods; - - - - - - -
    - - - -
    - &reftitle.constants; - - - - SolrQuery::ORDER_ASC - - Used to specify that the sorting should be in acending order - - - - - SolrQuery::ORDER_DESC - - Used to specify that the sorting should be in descending order - - - - - SolrQuery::FACET_SORT_INDEX - - Used to specify that the facet should sort by index - - - - - SolrQuery::FACET_SORT_COUNT - - Used to specify that the facet should sort by count - - - - - SolrQuery::TERMS_SORT_INDEX - - Used in the TermsComponent - - - - - SolrQuery::TERMS_SORT_COUNT - - Used in the TermsComponent - - - - -
    - - - -
    - - &reference.solr.entities.solrquery; - -
    - - diff --git a/reference/solr/solrquery/addexpandfilterquery.xml b/reference/solr/solrquery/addexpandfilterquery.xml deleted file mode 100644 index 59880b87644f..000000000000 --- a/reference/solr/solrquery/addexpandfilterquery.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - SolrQuery::addExpandFilterQuery - Overrides main filter query, determines which documents to include in the main group - - - - &reftitle.description; - - public SolrQuerySolrQuery::addExpandFilterQuery - stringfq - - - Overrides main filter query, determines which documents to include in the main group. - - - - - - &reftitle.parameters; - - - fq - - - - - - - - - - - &reftitle.returnvalues; - - SolrQuery - - - - - &reftitle.seealso; - - SolrQuery::setExpand - SolrQuery::addExpandSortField - SolrQuery::removeExpandSortField - SolrQuery::setExpandRows - SolrQuery::setExpandQuery - SolrQuery::removeExpandFilterQuery - - - - - - diff --git a/reference/solr/solrquery/addexpandsortfield.xml b/reference/solr/solrquery/addexpandsortfield.xml deleted file mode 100644 index 86d1326e3256..000000000000 --- a/reference/solr/solrquery/addexpandsortfield.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - SolrQuery::addExpandSortField - Orders the documents within the expanded groups (expand.sort parameter) - - - - &reftitle.description; - - public SolrQuerySolrQuery::addExpandSortField - stringfield - stringorder - - - Orders the documents within the expanded groups (expand.sort parameter). - - - - - - &reftitle.parameters; - - - field - - - field name - - - - - order - - - Order ASC/DESC, utilizes SolrQuery::ORDER_* constants. - - - Default: SolrQuery::ORDER_DESC - - - - - - - - &reftitle.returnvalues; - - SolrQuery - - - - - &reftitle.seealso; - - SolrQuery::setExpand - SolrQuery::removeExpandSortField - SolrQuery::setExpandRows - SolrQuery::setExpandQuery - SolrQuery::addExpandFilterQuery - SolrQuery::removeExpandFilterQuery - - - - - diff --git a/reference/solr/solrquery/addfacetdatefield.xml b/reference/solr/solrquery/addfacetdatefield.xml deleted file mode 100644 index b6a7a7d5d0b7..000000000000 --- a/reference/solr/solrquery/addfacetdatefield.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - SolrQuery::addFacetDateField - Maps to facet.date - - - - &reftitle.description; - - public SolrQuerySolrQuery::addFacetDateField - stringdateField - - - This method allows you to specify a field which should be treated as a facet. - - It can be used multiple times with different field names to indicate multiple facet fields - - - - - &reftitle.parameters; - - - - dateField - - - The name of the date field. - - - - - - - - - &reftitle.returnvalues; - - Returns a SolrQuery object. - - - - - - diff --git a/reference/solr/solrquery/addfacetdateother.xml b/reference/solr/solrquery/addfacetdateother.xml deleted file mode 100644 index 2084e96b5870..000000000000 --- a/reference/solr/solrquery/addfacetdateother.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - SolrQuery::addFacetDateOther - Adds another facet.date.other parameter - - - - &reftitle.description; - - public SolrQuerySolrQuery::addFacetDateOther - stringvalue - stringfield_override - - - Sets the facet.date.other parameter. Accepts an optional field override - - - - - - &reftitle.parameters; - - - - value - - - The value to use. - - - - - field_override - - - The field name for the override. - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/addfacetfield.xml b/reference/solr/solrquery/addfacetfield.xml deleted file mode 100644 index e5de8e4c47cb..000000000000 --- a/reference/solr/solrquery/addfacetfield.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - SolrQuery::addFacetField - Adds another field to the facet - - - - &reftitle.description; - - public SolrQuerySolrQuery::addFacetField - stringfield - - - Adds another field to the facet - - - - - - &reftitle.parameters; - - - - field - - - The name of the field - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - &reftitle.examples; - - - <methodname>SolrQuery::addFacetField</methodname> example - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$client = new SolrClient($options); - -$query = new SolrQuery(); - -$query->setQuery($query); - -$query->addField('price')->addField('color'); - -$query->setFacet(true); - -$query->addFacetField('price')->addFacetField('color'); - -$query_response = $client->query($query); - -$response = $query_response->getResponse(); - -print_r($response['facet_counts']['facet_fields']); - -?> -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [blue] => 20 - [green] => 100 - ) - -) -]]> - - - - - - - - diff --git a/reference/solr/solrquery/addfacetquery.xml b/reference/solr/solrquery/addfacetquery.xml deleted file mode 100644 index 61a059c3ef18..000000000000 --- a/reference/solr/solrquery/addfacetquery.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - SolrQuery::addFacetQuery - Adds a facet query - - - - &reftitle.description; - - public SolrQuerySolrQuery::addFacetQuery - stringfacetQuery - - - Adds a facet query - - - - - - &reftitle.parameters; - - - - facetQuery - - - The facet query - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - &reftitle.examples; - - - <methodname>SolrQuery::addFacetField</methodname> example - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$client = new SolrClient($options); - -$query = new SolrQuery('*:*'); - -$query->setFacet(true); - -$query->addFacetQuery('price:[* TO 500]')->addFacetQuery('price:[500 TO *]'); - -$query_response = $client->query($query); - -$response = $query_response->getResponse(); - -print_r($response->facet_counts->facet_queries); - -?> -]]> - - &example.outputs.similar; - - 14 - [price:[500 TO *]] => 2 -) - -]]> - - - - - - - - diff --git a/reference/solr/solrquery/addfield.xml b/reference/solr/solrquery/addfield.xml deleted file mode 100644 index bad49529b988..000000000000 --- a/reference/solr/solrquery/addfield.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - SolrQuery::addField - Specifies which fields to return in the result - - - - &reftitle.description; - - public SolrQuerySolrQuery::addField - stringfield - - - This method is used to used to specify a set of fields to return, thereby restricting the amount of data returned in the response. - - It should be called multiple time, once for each field name. - - - - - &reftitle.parameters; - - - - field - - - The name of the field - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object - - - - - - diff --git a/reference/solr/solrquery/addfilterquery.xml b/reference/solr/solrquery/addfilterquery.xml deleted file mode 100644 index cb75940f87ce..000000000000 --- a/reference/solr/solrquery/addfilterquery.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - SolrQuery::addFilterQuery - Specifies a filter query - - - - &reftitle.description; - - public SolrQuerySolrQuery::addFilterQuery - stringfq - - - Specifies a filter query - - - - - - &reftitle.parameters; - - - - fq - - - The filter query - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object. - - - - - &reftitle.examples; - - - <methodname>SolrQuery::addFilterQuery</methodname> example - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$client = new SolrClient($options); - -$query = new SolrQuery(); - -$query->setQuery('*:*'); - -$query->addFilterQuery('color:blue,green'); - -$query_response = $client->query($query); - -$response = $query_response->getResponse(); - -print_r($response['facet_counts']['facet_fields']); - -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/solr/solrquery/addgroupfield.xml b/reference/solr/solrquery/addgroupfield.xml deleted file mode 100644 index f8f3269adb96..000000000000 --- a/reference/solr/solrquery/addgroupfield.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - SolrQuery::addGroupField - Add a field to be used to group results - - - - &reftitle.description; - - public SolrQuerySolrQuery::addGroupField - stringvalue - - - The name of the field by which to group results. The field must be single-valued, and either be indexed - or a field type that has a value source and works in a function query, - such as ExternalFileField. It must also be a string-based field, such as StrField or TextField - Uses group.field parameter - - - - - - &reftitle.parameters; - - - value - - - The name of the field. - - - - - - - - &reftitle.returnvalues; - - Returns an instance of SolrQuery. - - - - - &reftitle.seealso; - - SolrQuery::setGroup - SolrQuery::addGroupFunction - SolrQuery::addGroupQuery - SolrQuery::addGroupSortField - SolrQuery::setGroupFacet - SolrQuery::setGroupOffset - SolrQuery::setGroupLimit - SolrQuery::setGroupMain - SolrQuery::setGroupNGroups - SolrQuery::setGroupTruncate - SolrQuery::setGroupFormat - SolrQuery::setGroupCachePercent - - - - - diff --git a/reference/solr/solrquery/addgroupfunction.xml b/reference/solr/solrquery/addgroupfunction.xml deleted file mode 100644 index eeab5df0ec88..000000000000 --- a/reference/solr/solrquery/addgroupfunction.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - SolrQuery::addGroupFunction - Allows grouping results based on the unique values of a function query (group.func parameter) - - - - &reftitle.description; - - public SolrQuerySolrQuery::addGroupFunction - stringvalue - - - Adds a group function (group.func parameter) - Allows grouping results based on the unique values of a function query. - - - - - - &reftitle.parameters; - - - value - - - - - - - - - - - &reftitle.returnvalues; - - SolrQuery - - - - &reftitle.seealso; - - SolrQuery::setGroup - SolrQuery::addGroupField - SolrQuery::addGroupQuery - SolrQuery::addGroupSortField - SolrQuery::setGroupFacet - SolrQuery::setGroupOffset - SolrQuery::setGroupLimit - SolrQuery::setGroupMain - SolrQuery::setGroupNGroups - SolrQuery::setGroupTruncate - SolrQuery::setGroupFormat - SolrQuery::setGroupCachePercent - - - - - diff --git a/reference/solr/solrquery/addgroupquery.xml b/reference/solr/solrquery/addgroupquery.xml deleted file mode 100644 index b450079d77de..000000000000 --- a/reference/solr/solrquery/addgroupquery.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - SolrQuery::addGroupQuery - Allows grouping of documents that match the given query - - - - &reftitle.description; - - public SolrQuerySolrQuery::addGroupQuery - stringvalue - - - Allows grouping of documents that match the given query. - Adds query to the group.query parameter - - - - - &reftitle.parameters; - - - value - - - - - - - - - - - &reftitle.returnvalues; - - SolrQuery - - - - &reftitle.seealso; - - SolrQuery::setGroup - SolrQuery::addGroupField - SolrQuery::addGroupFunction - SolrQuery::addGroupSortField - SolrQuery::setGroupFacet - SolrQuery::setGroupOffset - SolrQuery::setGroupLimit - SolrQuery::setGroupMain - SolrQuery::setGroupNGroups - SolrQuery::setGroupTruncate - SolrQuery::setGroupFormat - SolrQuery::setGroupCachePercent - - - - - diff --git a/reference/solr/solrquery/addgroupsortfield.xml b/reference/solr/solrquery/addgroupsortfield.xml deleted file mode 100644 index 0403c4a2efca..000000000000 --- a/reference/solr/solrquery/addgroupsortfield.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - SolrQuery::addGroupSortField - Add a group sort field (group.sort parameter) - - - - &reftitle.description; - - public SolrQuerySolrQuery::addGroupSortField - stringfield - intorder - - - Allow sorting group documents, using group sort field (group.sort parameter). - - - - - - &reftitle.parameters; - - - field - - - Field name - - - - - order - - - Order ASC/DESC, utilizes SolrQuery::ORDER_* constants - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - <function>SolrQuery::addGroupSortField</function> example - -setGroup(true) - ->addGroupSortField('price', SolrQuery::ORDER_ASC); - -echo $solrQuery; -?> -]]> - - &example.outputs.similar; - - - - - - - &reftitle.seealso; - - SolrQuery::setGroup - SolrQuery::addGroupField - SolrQuery::addGroupFunction - SolrQuery::addGroupQuery - SolrQuery::setGroupFacet - SolrQuery::setGroupOffset - SolrQuery::setGroupLimit - SolrQuery::setGroupMain - SolrQuery::setGroupNGroups - SolrQuery::setGroupTruncate - SolrQuery::setGroupFormat - SolrQuery::setGroupCachePercent - - - - - diff --git a/reference/solr/solrquery/addhighlightfield.xml b/reference/solr/solrquery/addhighlightfield.xml deleted file mode 100644 index 4e5600396680..000000000000 --- a/reference/solr/solrquery/addhighlightfield.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrQuery::addHighlightField - Maps to hl.fl - - - - &reftitle.description; - - public SolrQuerySolrQuery::addHighlightField - stringfield - - - Maps to hl.fl. This is used to specify that highlighted snippets should be generated for a particular field - - - - - - &reftitle.parameters; - - - - field - - - Name of the field - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/addmltfield.xml b/reference/solr/solrquery/addmltfield.xml deleted file mode 100644 index 893d7a3e1998..000000000000 --- a/reference/solr/solrquery/addmltfield.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - SolrQuery::addMltField - Sets a field to use for similarity - - - - &reftitle.description; - - public SolrQuerySolrQuery::addMltField - stringfield - - - Maps to mlt.fl. It specifies that a field should be used for similarity. - - - - - &reftitle.parameters; - - - - field - - - The name of the field - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/addmltqueryfield.xml b/reference/solr/solrquery/addmltqueryfield.xml deleted file mode 100644 index 2094c6178cf9..000000000000 --- a/reference/solr/solrquery/addmltqueryfield.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - SolrQuery::addMltQueryField - Maps to mlt.qf - - - - &reftitle.description; - - public SolrQuerySolrQuery::addMltQueryField - stringfield - floatboost - - - Maps to mlt.qf. It is used to specify query fields and their boosts - - - - - - &reftitle.parameters; - - - - field - - - The name of the field - - - - - boost - - - Its boost value - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/addsortfield.xml b/reference/solr/solrquery/addsortfield.xml deleted file mode 100644 index 098dc8fe27f4..000000000000 --- a/reference/solr/solrquery/addsortfield.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - SolrQuery::addSortField - Used to control how the results should be sorted - - - - &reftitle.description; - - public SolrQuerySolrQuery::addSortField - stringfield - intorderSolrQuery::ORDER_DESC - - - Used to control how the results should be sorted. - - - - - - &reftitle.parameters; - - - - field - - - The name of the field - - - - - order - - - The sort direction. This should be either SolrQuery::ORDER_ASC or SolrQuery::ORDER_DESC. - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object. - - - - - - diff --git a/reference/solr/solrquery/addstatsfacet.xml b/reference/solr/solrquery/addstatsfacet.xml deleted file mode 100644 index ecafb2b91d88..000000000000 --- a/reference/solr/solrquery/addstatsfacet.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrQuery::addStatsFacet - Requests a return of sub results for values within the given facet - - - - &reftitle.description; - - public SolrQuerySolrQuery::addStatsFacet - stringfield - - - Requests a return of sub results for values within the given facet. Maps to the stats.facet field - - - - - - &reftitle.parameters; - - - - field - - - The name of the field - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/addstatsfield.xml b/reference/solr/solrquery/addstatsfield.xml deleted file mode 100644 index 96e0e54af37e..000000000000 --- a/reference/solr/solrquery/addstatsfield.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrQuery::addStatsField - Maps to stats.field parameter - - - - &reftitle.description; - - public SolrQuerySolrQuery::addStatsField - stringfield - - - Maps to stats.field parameter This methods adds another stats.field parameter. - - - - - - &reftitle.parameters; - - - - field - - - The name of the field - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/collapse.xml b/reference/solr/solrquery/collapse.xml deleted file mode 100644 index ddf300bbf304..000000000000 --- a/reference/solr/solrquery/collapse.xml +++ /dev/null @@ -1,367 +0,0 @@ - - - - - - SolrQuery::collapse - Collapses the result set to a single document per group - - - - &reftitle.description; - - public SolrQuerySolrQuery::collapse - SolrCollapseFunctioncollapseFunction - - - Collapses the result set to a single document per group before it forwards - the result set to the rest of the search components. - - - So all downstream components (faceting, highlighting, etc...) will work with - the collapsed result set. - - - - - - &reftitle.parameters; - - - - collapseFunction - - - - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object - - - - &reftitle.examples; - - <methodname>SolrQuery::collapse</methodname> example - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, - 'path' => SOLR_SERVER_PATH -); - -$client = new SolrClient($options); - -$query = new SolrQuery('*:*'); - -$collapseFunction = new SolrCollapseFunction('manu_id_s'); - -$collapseFunction -->setSize(2) -->setNullPolicy(SolrCollapseFunction::NULLPOLICY_IGNORE); - -$query -->collapse($collapseFunction) -->setRows(4); - -$queryResponse = $client->query($query); - -$response = $queryResponse->getResponse(); - -print_r($response); - -?> -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [status] => 0 - [QTime] => 1 - [params] => SolrObject Object - ( - [q] => *:* - [indent] => on - [fq] => {!collapse field=manu_id_s size=2 nullPolicy=ignore} - [rows] => 4 - [version] => 2.2 - [wt] => xml - ) - - ) - - [response] => SolrObject Object - ( - [numFound] => 14 - [start] => 0 - [docs] => Array - ( - [0] => SolrObject Object - ( - [id] => SP2514N - [name] => Array - ( - [0] => Samsung SpinPoint P120 SP2514N - hard drive - 250 GB - ATA-133 - ) - - [manu] => Array - ( - [0] => Samsung Electronics Co. Ltd. - ) - - [manu_id_s] => samsung - [cat] => Array - ( - [0] => electronics - [1] => hard drive - ) - - [features] => Array - ( - [0] => 7200RPM, 8MB cache, IDE Ultra ATA-133 - [1] => NoiseGuard, SilentSeek technology, Fluid Dynamic Bearing (FDB) motor - ) - - [price] => Array - ( - [0] => 92 - ) - - [popularity] => Array - ( - [0] => 6 - ) - - [inStock] => Array - ( - [0] => 1 - ) - - [manufacturedate_dt] => 2006-02-13T15:26:37Z - [store] => Array - ( - [0] => 35.0752,-97.032 - ) - - [_version_] => 1510294336412057600 - ) - - [1] => SolrObject Object - ( - [id] => 6H500F0 - [name] => Array - ( - [0] => Maxtor DiamondMax 11 - hard drive - 500 GB - SATA-300 - ) - - [manu] => Array - ( - [0] => Maxtor Corp. - ) - - [manu_id_s] => maxtor - [cat] => Array - ( - [0] => electronics - [1] => hard drive - ) - - [features] => Array - ( - [0] => SATA 3.0Gb/s, NCQ - [1] => 8.5ms seek - [2] => 16MB cache - ) - - [price] => Array - ( - [0] => 350 - ) - - [popularity] => Array - ( - [0] => 6 - ) - - [inStock] => Array - ( - [0] => 1 - ) - - [store] => Array - ( - [0] => 45.17614,-93.87341 - ) - - [manufacturedate_dt] => 2006-02-13T15:26:37Z - [_version_] => 1510294336449806336 - ) - - [2] => SolrObject Object - ( - [id] => F8V7067-APL-KIT - [name] => Array - ( - [0] => Belkin Mobile Power Cord for iPod w/ Dock - ) - - [manu] => Array - ( - [0] => Belkin - ) - - [manu_id_s] => belkin - [cat] => Array - ( - [0] => electronics - [1] => connector - ) - - [features] => Array - ( - [0] => car power adapter, white - ) - - [weight] => Array - ( - [0] => 4 - ) - - [price] => Array - ( - [0] => 19.95 - ) - - [popularity] => Array - ( - [0] => 1 - ) - - [inStock] => Array - ( - [0] => - ) - - [store] => Array - ( - [0] => 45.18014,-93.87741 - ) - - [manufacturedate_dt] => 2005-08-01T16:30:25Z - [_version_] => 1510294336458194944 - ) - - [3] => SolrObject Object - ( - [id] => MA147LL/A - [name] => Array - ( - [0] => Apple 60 GB iPod with Video Playback Black - ) - - [manu] => Array - ( - [0] => Apple Computer Inc. - ) - - [manu_id_s] => apple - [cat] => Array - ( - [0] => electronics - [1] => music - ) - - [features] => Array - ( - [0] => iTunes, Podcasts, Audiobooks - [1] => Stores up to 15,000 songs, 25,000 photos, or 150 hours of video - [2] => 2.5-inch, 320x240 color TFT LCD display with LED backlight - [3] => Up to 20 hours of battery life - [4] => Plays AAC, MP3, WAV, AIFF, Audible, Apple Lossless, H.264 video - [5] => Notes, Calendar, Phone book, Hold button, Date display, Photo wallet, Built-in games, JPEG photo playback, Upgradeable firmware, USB 2.0 compatibility, Playback speed control, Rechargeable capability, Battery level indication - ) - - [includes] => Array - ( - [0] => earbud headphones, USB cable - ) - - [weight] => Array - ( - [0] => 5.5 - ) - - [price] => Array - ( - [0] => 399 - ) - - [popularity] => Array - ( - [0] => 10 - ) - - [inStock] => Array - ( - [0] => 1 - ) - - [store] => Array - ( - [0] => 37.7752,-100.0232 - ) - - [manufacturedate_dt] => 2005-10-12T08:00:00Z - [_version_] => 1510294336562003968 - ) - - ) - - ) - -) -]]> - - - - - - diff --git a/reference/solr/solrquery/construct.xml b/reference/solr/solrquery/construct.xml deleted file mode 100644 index 3df5bbbf265d..000000000000 --- a/reference/solr/solrquery/construct.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - SolrQuery::__construct - Constructor - - - - &reftitle.description; - - public SolrQuery::__construct - stringq - - - Constructor. - - - - - - &reftitle.parameters; - - - - q - - - Optional search query - - - - - - - - - &reftitle.returnvalues; - - None - - - - &reftitle.errors; - - Emits SolrIllegalArgumentException in case of an invalid parameter was passed. - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL solr 2.0.0 - - If q was invalid, then a - SolrIllegalArgumentException is now thrown. Previously an error was emitted. - - - - - - - - - - diff --git a/reference/solr/solrquery/destruct.xml b/reference/solr/solrquery/destruct.xml deleted file mode 100644 index 8da07b545899..000000000000 --- a/reference/solr/solrquery/destruct.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrQuery::__destruct - Destructor - - - - &reftitle.description; - - public SolrQuery::__destruct - - - - Destructor - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - None. - - - - - - diff --git a/reference/solr/solrquery/getexpand.xml b/reference/solr/solrquery/getexpand.xml deleted file mode 100644 index 483e4c359658..000000000000 --- a/reference/solr/solrquery/getexpand.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - SolrQuery::getExpand - Returns true if group expanding is enabled - - - - &reftitle.description; - - public boolSolrQuery::getExpand - - - - Returns &true; if group expanding is enabled - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns whether group expanding is enabled. - - - - - - diff --git a/reference/solr/solrquery/getexpandfilterqueries.xml b/reference/solr/solrquery/getexpandfilterqueries.xml deleted file mode 100644 index 26f404db996b..000000000000 --- a/reference/solr/solrquery/getexpandfilterqueries.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrQuery::getExpandFilterQueries - Returns the expand filter queries - - - - &reftitle.description; - - public arraySolrQuery::getExpandFilterQueries - - - - Returns the expand filter queries - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the expand filter queries. - - - - - - diff --git a/reference/solr/solrquery/getexpandquery.xml b/reference/solr/solrquery/getexpandquery.xml deleted file mode 100644 index 8860ee780142..000000000000 --- a/reference/solr/solrquery/getexpandquery.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - SolrQuery::getExpandQuery - Returns the expand query expand.q parameter - - - - &reftitle.description; - - public arraySolrQuery::getExpandQuery - - - - Returns the expand query expand.q parameter - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the expand query. - - - - - - diff --git a/reference/solr/solrquery/getexpandrows.xml b/reference/solr/solrquery/getexpandrows.xml deleted file mode 100644 index 9980b6ad2175..000000000000 --- a/reference/solr/solrquery/getexpandrows.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrQuery::getExpandRows - Returns The number of rows to display in each group (expand.rows) - - - - &reftitle.description; - - public intSolrQuery::getExpandRows - - - - Returns The number of rows to display in each group (expand.rows) - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the number of rows. - - - - - - diff --git a/reference/solr/solrquery/getexpandsortfields.xml b/reference/solr/solrquery/getexpandsortfields.xml deleted file mode 100644 index 1d339bb995d8..000000000000 --- a/reference/solr/solrquery/getexpandsortfields.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - SolrQuery::getExpandSortFields - Returns an array of fields - - - - &reftitle.description; - - public arraySolrQuery::getExpandSortFields - - - - Returns an array of fields - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an array of fields. - - - - - - diff --git a/reference/solr/solrquery/getfacet.xml b/reference/solr/solrquery/getfacet.xml deleted file mode 100644 index f07e4db9cb9d..000000000000 --- a/reference/solr/solrquery/getfacet.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - SolrQuery::getFacet - Returns the value of the facet parameter - - - - &reftitle.description; - - public boolSolrQuery::getFacet - - - - Returns the value of the facet parameter. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Returns a boolean on success and &null; if not set - - - - - - - diff --git a/reference/solr/solrquery/getfacetdateend.xml b/reference/solr/solrquery/getfacetdateend.xml deleted file mode 100644 index 9503e0aa58e3..000000000000 --- a/reference/solr/solrquery/getfacetdateend.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - SolrQuery::getFacetDateEnd - Returns the value for the facet.date.end parameter - - - - &reftitle.description; - - public stringSolrQuery::getFacetDateEnd - stringfield_override - - - Returns the value for the facet.date.end parameter. This method accepts an optional field override - - - - - - &reftitle.parameters; - - - - field_override - - - The name of the field - - - - - - - - - &reftitle.returnvalues; - -Returns a string on success and &null; if not set - - - - - - - diff --git a/reference/solr/solrquery/getfacetdatefields.xml b/reference/solr/solrquery/getfacetdatefields.xml deleted file mode 100644 index cae00ffeb430..000000000000 --- a/reference/solr/solrquery/getfacetdatefields.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrQuery::getFacetDateFields - Returns all the facet.date fields - - - - &reftitle.description; - - public arraySolrQuery::getFacetDateFields - - - Returns all the facet.date fields - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns all the facet.date fields as an array or &null; if none was set - - - - - - - diff --git a/reference/solr/solrquery/getfacetdategap.xml b/reference/solr/solrquery/getfacetdategap.xml deleted file mode 100644 index 13cb22f9baf2..000000000000 --- a/reference/solr/solrquery/getfacetdategap.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - SolrQuery::getFacetDateGap - Returns the value of the facet.date.gap parameter - - - - &reftitle.description; - - public stringSolrQuery::getFacetDateGap - stringfield_override - - - Returns the value of the facet.date.gap parameter. It accepts an optional field override - - - - - - &reftitle.parameters; - - - - field_override - - - The name of the field - - - - - - - - - &reftitle.returnvalues; - -Returns a string on success and &null; if not set - - - - - - - diff --git a/reference/solr/solrquery/getfacetdatehardend.xml b/reference/solr/solrquery/getfacetdatehardend.xml deleted file mode 100644 index 8326758f9303..000000000000 --- a/reference/solr/solrquery/getfacetdatehardend.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrQuery::getFacetDateHardEnd - Returns the value of the facet.date.hardend parameter - - - - &reftitle.description; - - public stringSolrQuery::getFacetDateHardEnd - stringfield_override - - - Returns the value of the facet.date.hardend parameter. Accepts an optional field override - - - - - - &reftitle.parameters; - - - - field_override - - - The name of the field - - - - - - - - - &reftitle.returnvalues; - -Returns a string on success and &null; if not set - - - - - - diff --git a/reference/solr/solrquery/getfacetdateother.xml b/reference/solr/solrquery/getfacetdateother.xml deleted file mode 100644 index 55d250bc485b..000000000000 --- a/reference/solr/solrquery/getfacetdateother.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - SolrQuery::getFacetDateOther - Returns the value for the facet.date.other parameter - - - - &reftitle.description; - - public arraySolrQuery::getFacetDateOther - stringfield_override - - - Returns the value for the facet.date.other parameter. This method accepts an optional field override. - - - - - - &reftitle.parameters; - - - - field_override - - - The name of the field - - - - - - - - - &reftitle.returnvalues; - -Returns an &array; on success and &null; if not set. - - - - - - - diff --git a/reference/solr/solrquery/getfacetdatestart.xml b/reference/solr/solrquery/getfacetdatestart.xml deleted file mode 100644 index d05c428c7f9d..000000000000 --- a/reference/solr/solrquery/getfacetdatestart.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - SolrQuery::getFacetDateStart - Returns the lower bound for the first date range for all date faceting on this field - - - - &reftitle.description; - - public stringSolrQuery::getFacetDateStart - stringfield_override - - - Returns the lower bound for the first date range for all date faceting on this field. Accepts an optional field override - - - - - &reftitle.parameters; - - - - field_override - - - The name of the field - - - - - - - - - &reftitle.returnvalues; - -Returns a string on success and &null; if not set - - - - - - diff --git a/reference/solr/solrquery/getfacetfields.xml b/reference/solr/solrquery/getfacetfields.xml deleted file mode 100644 index d3100b14b575..000000000000 --- a/reference/solr/solrquery/getfacetfields.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - SolrQuery::getFacetFields - Returns all the facet fields - - - - &reftitle.description; - - public arraySolrQuery::getFacetFields - - - - Returns all the facet fields - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Returns an array of all the fields and &null; if none was set - - - - - diff --git a/reference/solr/solrquery/getfacetlimit.xml b/reference/solr/solrquery/getfacetlimit.xml deleted file mode 100644 index a2cb3e497d72..000000000000 --- a/reference/solr/solrquery/getfacetlimit.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrQuery::getFacetLimit - Returns the maximum number of constraint counts that should be returned for the facet fields - - - - &reftitle.description; - - public intSolrQuery::getFacetLimit - stringfield_override - - - Returns the maximum number of constraint counts that should be returned for the facet fields. This method accepts an optional field override - - - - - - &reftitle.parameters; - - - - field_override - - - The name of the field to override for - - - - - - - - - &reftitle.returnvalues; - -Returns an integer on success and &null; if not set - - - - - - diff --git a/reference/solr/solrquery/getfacetmethod.xml b/reference/solr/solrquery/getfacetmethod.xml deleted file mode 100644 index cc4c37ee66e0..000000000000 --- a/reference/solr/solrquery/getfacetmethod.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - SolrQuery::getFacetMethod - Returns the value of the facet.method parameter - - - - &reftitle.description; - - public stringSolrQuery::getFacetMethod - stringfield_override - - - Returns the value of the facet.method parameter. This accepts an optional field override. - - - - - - &reftitle.parameters; - - - - field_override - - - The name of the field - - - - - - - - - &reftitle.returnvalues; - - Returns a string on success and &null; if not set - - - - - - - diff --git a/reference/solr/solrquery/getfacetmincount.xml b/reference/solr/solrquery/getfacetmincount.xml deleted file mode 100644 index e8c2a71df130..000000000000 --- a/reference/solr/solrquery/getfacetmincount.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrQuery::getFacetMinCount - Returns the minimum counts for facet fields should be included in the response - - - - &reftitle.description; - - public intSolrQuery::getFacetMinCount - stringfield_override - - - Returns the minimum counts for facet fields should be included in the response. It accepts an optional field override - - - - - - &reftitle.parameters; - - - - field_override - - - The name of the field - - - - - - - - - &reftitle.returnvalues; - -Returns an integer on success and &null; if not set - - - - - - diff --git a/reference/solr/solrquery/getfacetmissing.xml b/reference/solr/solrquery/getfacetmissing.xml deleted file mode 100644 index 4031b062bd41..000000000000 --- a/reference/solr/solrquery/getfacetmissing.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - SolrQuery::getFacetMissing - Returns the current state of the facet.missing parameter - - - - &reftitle.description; - - public boolSolrQuery::getFacetMissing - stringfield_override - - - Returns the current state of the facet.missing parameter. This accepts an optional field override - - - - - - &reftitle.parameters; - - - - field_override - - - The name of the field - - - - - - - - - &reftitle.returnvalues; - -Returns a boolean on success and &null; if not set - - - - - - - diff --git a/reference/solr/solrquery/getfacetoffset.xml b/reference/solr/solrquery/getfacetoffset.xml deleted file mode 100644 index 6ef7536cb749..000000000000 --- a/reference/solr/solrquery/getfacetoffset.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrQuery::getFacetOffset - Returns an offset into the list of constraints to be used for pagination - - - - &reftitle.description; - - public intSolrQuery::getFacetOffset - stringfield_override - - - Returns an offset into the list of constraints to be used for pagination. Accepts an optional field override - - - - - - &reftitle.parameters; - - - - field_override - - - The name of the field to override for. - - - - - - - - - &reftitle.returnvalues; - -Returns an integer on success and &null; if not set - - - - - - diff --git a/reference/solr/solrquery/getfacetprefix.xml b/reference/solr/solrquery/getfacetprefix.xml deleted file mode 100644 index 8663348eca68..000000000000 --- a/reference/solr/solrquery/getfacetprefix.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - SolrQuery::getFacetPrefix - Returns the facet prefix - - - - &reftitle.description; - - public stringSolrQuery::getFacetPrefix - stringfield_override - - - Returns the facet prefix - - - - - - &reftitle.parameters; - - - - field_override - - - The name of the field - - - - - - - - - &reftitle.returnvalues; - -Returns a string on success and &null; if not set. - - - - - - - diff --git a/reference/solr/solrquery/getfacetqueries.xml b/reference/solr/solrquery/getfacetqueries.xml deleted file mode 100644 index 47920e11b202..000000000000 --- a/reference/solr/solrquery/getfacetqueries.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrQuery::getFacetQueries - Returns all the facet queries - - - - &reftitle.description; - - public arraySolrQuery::getFacetQueries - - - -Returns all the facet queries - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Returns an array on success and &null; if not set. - - - - - - - diff --git a/reference/solr/solrquery/getfacetsort.xml b/reference/solr/solrquery/getfacetsort.xml deleted file mode 100644 index 7161bc7e7e78..000000000000 --- a/reference/solr/solrquery/getfacetsort.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrQuery::getFacetSort - Returns the facet sort type - - - - &reftitle.description; - - public intSolrQuery::getFacetSort - stringfield_override - - - Returns an integer (SolrQuery::FACET_SORT_INDEX or SolrQuery::FACET_SORT_COUNT) - - - - - - &reftitle.parameters; - - - - field_override - - - The name of the field - - - - - - - - - &reftitle.returnvalues; - - Returns an integer (SolrQuery::FACET_SORT_INDEX or SolrQuery::FACET_SORT_COUNT) on success or &null; if not set. - - - - - - diff --git a/reference/solr/solrquery/getfields.xml b/reference/solr/solrquery/getfields.xml deleted file mode 100644 index 146b31cc58cc..000000000000 --- a/reference/solr/solrquery/getfields.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - SolrQuery::getFields - Returns the list of fields that will be returned in the response - - - - &reftitle.description; - - public arraySolrQuery::getFields - - - - Returns the list of fields that will be returned in the response - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Returns an array on success and &null; if not set. - - - - - diff --git a/reference/solr/solrquery/getfilterqueries.xml b/reference/solr/solrquery/getfilterqueries.xml deleted file mode 100644 index 2e9917a0e389..000000000000 --- a/reference/solr/solrquery/getfilterqueries.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrQuery::getFilterQueries - Returns an array of filter queries - - - - &reftitle.description; - - public arraySolrQuery::getFilterQueries - - - - Returns an array of filter queries. These are queries that can be used to restrict the super set of documents that can be returned, without influencing score - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Returns an array on success and &null; if not set. - - - - - - - diff --git a/reference/solr/solrquery/getgroup.xml b/reference/solr/solrquery/getgroup.xml deleted file mode 100644 index ce71eed4ba8b..000000000000 --- a/reference/solr/solrquery/getgroup.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - SolrQuery::getGroup - Returns true if grouping is enabled - - - - &reftitle.description; - - public boolSolrQuery::getGroup - - - - Returns true if grouping is enabled - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrQuery::setGroup - - - - - - diff --git a/reference/solr/solrquery/getgroupcachepercent.xml b/reference/solr/solrquery/getgroupcachepercent.xml deleted file mode 100644 index 73fa45cfbdfd..000000000000 --- a/reference/solr/solrquery/getgroupcachepercent.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - SolrQuery::getGroupCachePercent - Returns group cache percent value - - - - &reftitle.description; - - public intSolrQuery::getGroupCachePercent - - - - Returns group cache percent value - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrQuery::setGroupCachePercent - - - - - - diff --git a/reference/solr/solrquery/getgroupfacet.xml b/reference/solr/solrquery/getgroupfacet.xml deleted file mode 100644 index 3c2117730853..000000000000 --- a/reference/solr/solrquery/getgroupfacet.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - SolrQuery::getGroupFacet - Returns the group.facet parameter value - - - - &reftitle.description; - - public boolSolrQuery::getGroupFacet - - - - Returns the group.facet parameter value - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrQuery::setGroupFacet - - - - - - diff --git a/reference/solr/solrquery/getgroupfields.xml b/reference/solr/solrquery/getgroupfields.xml deleted file mode 100644 index a670ef48fd13..000000000000 --- a/reference/solr/solrquery/getgroupfields.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - SolrQuery::getGroupFields - Returns group fields (group.field parameter values) - - - - &reftitle.description; - - public arraySolrQuery::getGroupFields - - - - Returns group fields (group.field parameter values) - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrQuery::addGroupField - - - - - - diff --git a/reference/solr/solrquery/getgroupformat.xml b/reference/solr/solrquery/getgroupformat.xml deleted file mode 100644 index c5adfab0343d..000000000000 --- a/reference/solr/solrquery/getgroupformat.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - SolrQuery::getGroupFormat - Returns the group.format value - - - - &reftitle.description; - - public stringSolrQuery::getGroupFormat - - - - Returns the group.format value - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrQuery::setGroupFormat - - - - - - diff --git a/reference/solr/solrquery/getgroupfunctions.xml b/reference/solr/solrquery/getgroupfunctions.xml deleted file mode 100644 index 61bfb9364f73..000000000000 --- a/reference/solr/solrquery/getgroupfunctions.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - SolrQuery::getGroupFunctions - Returns group functions (group.func parameter values) - - - - &reftitle.description; - - public arraySolrQuery::getGroupFunctions - - - - Returns group functions (group.func parameter values) - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrQuery::addGroupFunction - - - - - - diff --git a/reference/solr/solrquery/getgrouplimit.xml b/reference/solr/solrquery/getgrouplimit.xml deleted file mode 100644 index 7445b2075b77..000000000000 --- a/reference/solr/solrquery/getgrouplimit.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - SolrQuery::getGroupLimit - Returns the group.limit value - - - - &reftitle.description; - - public intSolrQuery::getGroupLimit - - - - Returns the group.limit value - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrQuery::setGroupLimit - - - - - - diff --git a/reference/solr/solrquery/getgroupmain.xml b/reference/solr/solrquery/getgroupmain.xml deleted file mode 100644 index 53bc7b636bba..000000000000 --- a/reference/solr/solrquery/getgroupmain.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - SolrQuery::getGroupMain - Returns the group.main value - - - - &reftitle.description; - - public boolSolrQuery::getGroupMain - - - - Returns the group.main value - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrQuery::setGroupMain - - - - - - diff --git a/reference/solr/solrquery/getgroupngroups.xml b/reference/solr/solrquery/getgroupngroups.xml deleted file mode 100644 index 0689d50d79d3..000000000000 --- a/reference/solr/solrquery/getgroupngroups.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - SolrQuery::getGroupNGroups - Returns the group.ngroups value - - - - &reftitle.description; - - public boolSolrQuery::getGroupNGroups - - - - Returns the group.ngroups value - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrQuery::setGroupNGroups - - - - - - diff --git a/reference/solr/solrquery/getgroupoffset.xml b/reference/solr/solrquery/getgroupoffset.xml deleted file mode 100644 index 5d03478fc7c0..000000000000 --- a/reference/solr/solrquery/getgroupoffset.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - SolrQuery::getGroupOffset - Returns the group.offset value - - - - &reftitle.description; - - public intSolrQuery::getGroupOffset - - - - Returns the group.offset value - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrQuery::setGroupOffset - - - - - - diff --git a/reference/solr/solrquery/getgroupqueries.xml b/reference/solr/solrquery/getgroupqueries.xml deleted file mode 100644 index 9f0056bf21d8..000000000000 --- a/reference/solr/solrquery/getgroupqueries.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - SolrQuery::getGroupQueries - Returns all the group.query parameter values - - - - &reftitle.description; - - public arraySolrQuery::getGroupQueries - - - - Returns all the group.query parameter values - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - array - - - - - &reftitle.seealso; - - SolrQuery::addGroupQuery - - - - - - diff --git a/reference/solr/solrquery/getgroupsortfields.xml b/reference/solr/solrquery/getgroupsortfields.xml deleted file mode 100644 index bc5540807aef..000000000000 --- a/reference/solr/solrquery/getgroupsortfields.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - SolrQuery::getGroupSortFields - Returns the group.sort value - - - - &reftitle.description; - - public arraySolrQuery::getGroupSortFields - - - - Returns the group.sort value - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrQuery::addGroupSortField - - - - - - diff --git a/reference/solr/solrquery/getgrouptruncate.xml b/reference/solr/solrquery/getgrouptruncate.xml deleted file mode 100644 index 8af0bfdd9d23..000000000000 --- a/reference/solr/solrquery/getgrouptruncate.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - SolrQuery::getGroupTruncate - Returns the group.truncate value - - - - &reftitle.description; - - public boolSolrQuery::getGroupTruncate - - - - Returns the group.truncate value - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrQuery::setGroupTruncate - - - - - - diff --git a/reference/solr/solrquery/gethighlight.xml b/reference/solr/solrquery/gethighlight.xml deleted file mode 100644 index 233e374394c0..000000000000 --- a/reference/solr/solrquery/gethighlight.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - SolrQuery::getHighlight - Returns the state of the hl parameter - - - - &reftitle.description; - - public boolSolrQuery::getHighlight - - - - Returns a boolean indicating whether to enable highlighted snippets to be generated in the query response. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Returns a boolean on success and &null; if not set. - - - - - - - diff --git a/reference/solr/solrquery/gethighlightalternatefield.xml b/reference/solr/solrquery/gethighlightalternatefield.xml deleted file mode 100644 index 642971fe69d6..000000000000 --- a/reference/solr/solrquery/gethighlightalternatefield.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - SolrQuery::getHighlightAlternateField - Returns the highlight field to use as backup or default - - - - &reftitle.description; - - public stringSolrQuery::getHighlightAlternateField - stringfield_override - - - Returns the highlight field to use as backup or default. It accepts an optional override. - - - - - - &reftitle.parameters; - - - - field_override - - - The name of the field - - - - - - - - - &reftitle.returnvalues; - -Returns a string on success and &null; if not set. - - - - - - - diff --git a/reference/solr/solrquery/gethighlightfields.xml b/reference/solr/solrquery/gethighlightfields.xml deleted file mode 100644 index 4205d21bf343..000000000000 --- a/reference/solr/solrquery/gethighlightfields.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrQuery::getHighlightFields - Returns all the fields that Solr should generate highlighted snippets for - - - - &reftitle.description; - - public arraySolrQuery::getHighlightFields - - - - Returns all the fields that Solr should generate highlighted snippets for - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Returns an array on success and &null; if not set. - - - - - - - diff --git a/reference/solr/solrquery/gethighlightformatter.xml b/reference/solr/solrquery/gethighlightformatter.xml deleted file mode 100644 index 40d99267abcf..000000000000 --- a/reference/solr/solrquery/gethighlightformatter.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrQuery::getHighlightFormatter - Returns the formatter for the highlighted output - - - - &reftitle.description; - - public stringSolrQuery::getHighlightFormatter - stringfield_override - - - Returns the formatter for the highlighted output - - - - - - &reftitle.parameters; - - - - field_override - - - The name of the field - - - - - - - - - &reftitle.returnvalues; - -Returns a string on success and &null; if not set. - - - - - - diff --git a/reference/solr/solrquery/gethighlightfragmenter.xml b/reference/solr/solrquery/gethighlightfragmenter.xml deleted file mode 100644 index bf18a70c1d30..000000000000 --- a/reference/solr/solrquery/gethighlightfragmenter.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - SolrQuery::getHighlightFragmenter - Returns the text snippet generator for highlighted text - - - - &reftitle.description; - - public stringSolrQuery::getHighlightFragmenter - stringfield_override - - - Returns the text snippet generator for highlighted text. Accepts an optional field override. - - - - - - - - &reftitle.parameters; - - - - field_override - - - The name of the field - - - - - - - - - &reftitle.returnvalues; - -Returns a string on success and &null; if not set. - - - - - - - diff --git a/reference/solr/solrquery/gethighlightfragsize.xml b/reference/solr/solrquery/gethighlightfragsize.xml deleted file mode 100644 index 5ba14990e849..000000000000 --- a/reference/solr/solrquery/gethighlightfragsize.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - SolrQuery::getHighlightFragsize - Returns the number of characters of fragments to consider for highlighting - - - - &reftitle.description; - - public intSolrQuery::getHighlightFragsize - stringfield_override - - - Returns the number of characters of fragments to consider for highlighting. Zero implies no fragmenting. The entire field should be used. - - - - - - &reftitle.parameters; - - - - field_override - - - The name of the field - - - - - - - - - &reftitle.returnvalues; - -Returns an integer on success or &null; if not set. - - - - - diff --git a/reference/solr/solrquery/gethighlighthighlightmultiterm.xml b/reference/solr/solrquery/gethighlighthighlightmultiterm.xml deleted file mode 100644 index 2b8a9cd8775e..000000000000 --- a/reference/solr/solrquery/gethighlighthighlightmultiterm.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrQuery::getHighlightHighlightMultiTerm - Returns whether or not to enable highlighting for range/wildcard/fuzzy/prefix queries - - - - &reftitle.description; - - public boolSolrQuery::getHighlightHighlightMultiTerm - - - - Returns whether or not to enable highlighting for range/wildcard/fuzzy/prefix queries - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Returns a boolean on success and &null; if not set. - - - - - - - diff --git a/reference/solr/solrquery/gethighlightmaxalternatefieldlength.xml b/reference/solr/solrquery/gethighlightmaxalternatefieldlength.xml deleted file mode 100644 index 72eb40ae934a..000000000000 --- a/reference/solr/solrquery/gethighlightmaxalternatefieldlength.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - SolrQuery::getHighlightMaxAlternateFieldLength - Returns the maximum number of characters of the field to return - - - - &reftitle.description; - - public intSolrQuery::getHighlightMaxAlternateFieldLength - stringfield_override - - - Returns the maximum number of characters of the field to return - - - - - - &reftitle.parameters; - - - - field_override - - - The name of the field - - - - - - - - - &reftitle.returnvalues; - -Returns an integer on success and &null; if not set. - - - - - - - diff --git a/reference/solr/solrquery/gethighlightmaxanalyzedchars.xml b/reference/solr/solrquery/gethighlightmaxanalyzedchars.xml deleted file mode 100644 index be62878ba60f..000000000000 --- a/reference/solr/solrquery/gethighlightmaxanalyzedchars.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrQuery::getHighlightMaxAnalyzedChars - Returns the maximum number of characters into a document to look for suitable snippets - - - - &reftitle.description; - - public intSolrQuery::getHighlightMaxAnalyzedChars - - - - Returns the maximum number of characters into a document to look for suitable snippets - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Returns an integer on success and &null; if not set. - - - - - - diff --git a/reference/solr/solrquery/gethighlightmergecontiguous.xml b/reference/solr/solrquery/gethighlightmergecontiguous.xml deleted file mode 100644 index e67ec81e1895..000000000000 --- a/reference/solr/solrquery/gethighlightmergecontiguous.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - SolrQuery::getHighlightMergeContiguous - Returns whether or not the collapse contiguous fragments into a single fragment - - - - &reftitle.description; - - public boolSolrQuery::getHighlightMergeContiguous - stringfield_override - - - Returns whether or not the collapse contiguous fragments into a single fragment. Accepts an optional field override. - - - - - - &reftitle.parameters; - - - - field_override - - - The name of the field - - - - - - - - - &reftitle.returnvalues; - -Returns a boolean on success and &null; if not set. - - - - - - - diff --git a/reference/solr/solrquery/gethighlightquery.xml b/reference/solr/solrquery/gethighlightquery.xml deleted file mode 100644 index 299b687c1f58..000000000000 --- a/reference/solr/solrquery/gethighlightquery.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - SolrQuery::getHighlightQuery - Return the highlight query - - - - &reftitle.description; - - public stringnullSolrQuery::getHighlightQuery - - - - Returns previously set highlight query from the - hl.q parameter. - This parameter allows you to highlight different terms or fields than those being used to retrieve documents. - See the Highlighting - section for more details. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a string that contains the highlight query of the current SolrQuery, - or &null; if highlight query is not set. - - - - - &reftitle.seealso; - - SolrQuery::setHighlightQuery - SolrQuery::getHighlightFields - SolrQuery::setHighlightFields - - - - diff --git a/reference/solr/solrquery/gethighlightregexmaxanalyzedchars.xml b/reference/solr/solrquery/gethighlightregexmaxanalyzedchars.xml deleted file mode 100644 index e91217ba5f53..000000000000 --- a/reference/solr/solrquery/gethighlightregexmaxanalyzedchars.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - SolrQuery::getHighlightRegexMaxAnalyzedChars - Returns the maximum number of characters from a field when using the regex fragmenter - - - - &reftitle.description; - - public intSolrQuery::getHighlightRegexMaxAnalyzedChars - - - - Returns the maximum number of characters from a field when using the regex fragmenter - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Returns an integer on success and &null; if not set. - - - - - - - diff --git a/reference/solr/solrquery/gethighlightregexpattern.xml b/reference/solr/solrquery/gethighlightregexpattern.xml deleted file mode 100644 index 1a6ba2e6365b..000000000000 --- a/reference/solr/solrquery/gethighlightregexpattern.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrQuery::getHighlightRegexPattern - Returns the regular expression for fragmenting - - - - &reftitle.description; - - public stringSolrQuery::getHighlightRegexPattern - - - - Returns the regular expression used for fragmenting - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Returns a string on success and &null; if not set. - - - - - - - diff --git a/reference/solr/solrquery/gethighlightregexslop.xml b/reference/solr/solrquery/gethighlightregexslop.xml deleted file mode 100644 index 393bf7dbd142..000000000000 --- a/reference/solr/solrquery/gethighlightregexslop.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - SolrQuery::getHighlightRegexSlop - Returns the deviation factor from the ideal fragment size - - - - &reftitle.description; - - public floatSolrQuery::getHighlightRegexSlop - - - - Returns the factor by which the regex fragmenter can deviate from the ideal fragment size to accommodate the regular expression - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a float on success and &null; if not set. - - - - - - - diff --git a/reference/solr/solrquery/gethighlightrequirefieldmatch.xml b/reference/solr/solrquery/gethighlightrequirefieldmatch.xml deleted file mode 100644 index 59d6fb66e6f7..000000000000 --- a/reference/solr/solrquery/gethighlightrequirefieldmatch.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - SolrQuery::getHighlightRequireFieldMatch - Returns if a field will only be highlighted if the query matched in this particular field - - - - &reftitle.description; - - public boolSolrQuery::getHighlightRequireFieldMatch - - - - Returns if a field will only be highlighted if the query matched in this particular field. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Returns a boolean on success and &null; if not set. - - - - - - - diff --git a/reference/solr/solrquery/gethighlightsimplepost.xml b/reference/solr/solrquery/gethighlightsimplepost.xml deleted file mode 100644 index 24071b5af3a9..000000000000 --- a/reference/solr/solrquery/gethighlightsimplepost.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrQuery::getHighlightSimplePost - Returns the text which appears after a highlighted term - - - - &reftitle.description; - - public stringSolrQuery::getHighlightSimplePost - stringfield_override - - - Returns the text which appears after a highlighted term. Accepts an optional field override - - - - - &reftitle.parameters; - - - - field_override - - - The name of the field - - - - - - - - - &reftitle.returnvalues; - -Returns a string on success and &null; if not set. - - - - - - - diff --git a/reference/solr/solrquery/gethighlightsimplepre.xml b/reference/solr/solrquery/gethighlightsimplepre.xml deleted file mode 100644 index 8654122fa3c6..000000000000 --- a/reference/solr/solrquery/gethighlightsimplepre.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - SolrQuery::getHighlightSimplePre - Returns the text which appears before a highlighted term - - - - &reftitle.description; - - public stringSolrQuery::getHighlightSimplePre - stringfield_override - - - Returns the text which appears before a highlighted term. Accepts an optional field override - - - - - - - - &reftitle.parameters; - - - - field_override - - - The name of the field - - - - - - - - - &reftitle.returnvalues; - -Returns a string on success and &null; if not set. - - - - - - - diff --git a/reference/solr/solrquery/gethighlightsnippets.xml b/reference/solr/solrquery/gethighlightsnippets.xml deleted file mode 100644 index f404ce1026f8..000000000000 --- a/reference/solr/solrquery/gethighlightsnippets.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - SolrQuery::getHighlightSnippets - Returns the maximum number of highlighted snippets to generate per field - - - - &reftitle.description; - - public intSolrQuery::getHighlightSnippets - stringfield_override - - - Returns the maximum number of highlighted snippets to generate per field. Accepts an optional field override - - - - - - - - &reftitle.parameters; - - - - field_override - - - The name of the field - - - - - - - - - &reftitle.returnvalues; - -Returns an integer on success and &null; if not set. - - - - - - - diff --git a/reference/solr/solrquery/gethighlightusephrasehighlighter.xml b/reference/solr/solrquery/gethighlightusephrasehighlighter.xml deleted file mode 100644 index 564d89119cbe..000000000000 --- a/reference/solr/solrquery/gethighlightusephrasehighlighter.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - SolrQuery::getHighlightUsePhraseHighlighter - Returns the state of the hl.usePhraseHighlighter parameter - - - - &reftitle.description; - - public boolSolrQuery::getHighlightUsePhraseHighlighter - - - - Returns whether or not to use SpanScorer to highlight phrase terms only when they appear within the query phrase in the document. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Returns a boolean on success and &null; if not set. - - - - - - - diff --git a/reference/solr/solrquery/getmlt.xml b/reference/solr/solrquery/getmlt.xml deleted file mode 100644 index 79bdf4981734..000000000000 --- a/reference/solr/solrquery/getmlt.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - SolrQuery::getMlt - Returns whether or not MoreLikeThis results should be enabled - - - - &reftitle.description; - - public boolSolrQuery::getMlt - - - - Returns whether or not MoreLikeThis results should be enabled - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Returns a boolean on success and &null; if not set. - - - - - - - diff --git a/reference/solr/solrquery/getmltboost.xml b/reference/solr/solrquery/getmltboost.xml deleted file mode 100644 index b410da87be56..000000000000 --- a/reference/solr/solrquery/getmltboost.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - SolrQuery::getMltBoost - Returns whether or not the query will be boosted by the interesting term relevance - - - - &reftitle.description; - - public boolSolrQuery::getMltBoost - - - - Returns whether or not the query will be boosted by the interesting term relevance - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Returns a boolean on success and &null; if not set. - - - - - - - diff --git a/reference/solr/solrquery/getmltcount.xml b/reference/solr/solrquery/getmltcount.xml deleted file mode 100644 index a258070d8751..000000000000 --- a/reference/solr/solrquery/getmltcount.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - SolrQuery::getMltCount - Returns the number of similar documents to return for each result - - - - &reftitle.description; - - public intSolrQuery::getMltCount - - - - Returns the number of similar documents to return for each result - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Returns an integer on success and &null; if not set. - - - - - - - diff --git a/reference/solr/solrquery/getmltfields.xml b/reference/solr/solrquery/getmltfields.xml deleted file mode 100644 index 9827a809dde1..000000000000 --- a/reference/solr/solrquery/getmltfields.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - SolrQuery::getMltFields - Returns all the fields to use for similarity - - - - &reftitle.description; - - public arraySolrQuery::getMltFields - - - -Returns all the fields to use for similarity - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Returns an array on success and &null; if not set. - - - - - - - diff --git a/reference/solr/solrquery/getmltmaxnumqueryterms.xml b/reference/solr/solrquery/getmltmaxnumqueryterms.xml deleted file mode 100644 index 7b288be596fc..000000000000 --- a/reference/solr/solrquery/getmltmaxnumqueryterms.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrQuery::getMltMaxNumQueryTerms - Returns the maximum number of query terms that will be included in any generated query - - - - &reftitle.description; - - public intSolrQuery::getMltMaxNumQueryTerms - - - - Returns the maximum number of query terms that will be included in any generated query - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Returns an integer on success and &null; if not set. - - - - - - diff --git a/reference/solr/solrquery/getmltmaxnumtokens.xml b/reference/solr/solrquery/getmltmaxnumtokens.xml deleted file mode 100644 index 92309b7dea75..000000000000 --- a/reference/solr/solrquery/getmltmaxnumtokens.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - SolrQuery::getMltMaxNumTokens - Returns the maximum number of tokens to parse in each document field that is not stored with TermVector support - - - - &reftitle.description; - - public intSolrQuery::getMltMaxNumTokens - - - - Returns the maximum number of tokens to parse in each document field that is not stored with TermVector support - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Returns an integer on success and &null; if not set. - - - - - - - diff --git a/reference/solr/solrquery/getmltmaxwordlength.xml b/reference/solr/solrquery/getmltmaxwordlength.xml deleted file mode 100644 index 88f4e68833b0..000000000000 --- a/reference/solr/solrquery/getmltmaxwordlength.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrQuery::getMltMaxWordLength - Returns the maximum word length above which words will be ignored - - - - &reftitle.description; - - public intSolrQuery::getMltMaxWordLength - - - - Returns the maximum word length above which words will be ignored - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Returns an integer on success and &null; if not set. - - - - - - diff --git a/reference/solr/solrquery/getmltmindocfrequency.xml b/reference/solr/solrquery/getmltmindocfrequency.xml deleted file mode 100644 index ee584d9390b5..000000000000 --- a/reference/solr/solrquery/getmltmindocfrequency.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - SolrQuery::getMltMinDocFrequency - Returns the treshold frequency at which words will be ignored which do not occur in at least this many docs - - - - &reftitle.description; - - public intSolrQuery::getMltMinDocFrequency - - - - Returns the treshold frequency at which words will be ignored which do not occur in at least this many docs - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Returns an integer on success and &null; if not set. - - - - - - - diff --git a/reference/solr/solrquery/getmltmintermfrequency.xml b/reference/solr/solrquery/getmltmintermfrequency.xml deleted file mode 100644 index a883b9f9f86e..000000000000 --- a/reference/solr/solrquery/getmltmintermfrequency.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - SolrQuery::getMltMinTermFrequency - Returns the frequency below which terms will be ignored in the source document - - - - &reftitle.description; - - public intSolrQuery::getMltMinTermFrequency - - - - Returns the frequency below which terms will be ignored in the source document - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Returns an integer on success and &null; if not set. - - - - - - - diff --git a/reference/solr/solrquery/getmltminwordlength.xml b/reference/solr/solrquery/getmltminwordlength.xml deleted file mode 100644 index 671bfb570e63..000000000000 --- a/reference/solr/solrquery/getmltminwordlength.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - SolrQuery::getMltMinWordLength - Returns the minimum word length below which words will be ignored - - - - &reftitle.description; - - public intSolrQuery::getMltMinWordLength - - - - Returns the minimum word length below which words will be ignored - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Returns an integer on success and &null; if not set. - - - - - - - diff --git a/reference/solr/solrquery/getmltqueryfields.xml b/reference/solr/solrquery/getmltqueryfields.xml deleted file mode 100644 index 429d53e8e543..000000000000 --- a/reference/solr/solrquery/getmltqueryfields.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - SolrQuery::getMltQueryFields - Returns the query fields and their boosts - - - - &reftitle.description; - - public arraySolrQuery::getMltQueryFields - - - - Returns the query fields and their boosts - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Returns an array on success and &null; if not set. - - - - - - - diff --git a/reference/solr/solrquery/getquery.xml b/reference/solr/solrquery/getquery.xml deleted file mode 100644 index d4ccafd8acd3..000000000000 --- a/reference/solr/solrquery/getquery.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - SolrQuery::getQuery - Returns the main query - - - - &reftitle.description; - - public stringSolrQuery::getQuery - - - -Returns the main search query - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Returns a string on success and &null; if not set. - - - - - - - diff --git a/reference/solr/solrquery/getrows.xml b/reference/solr/solrquery/getrows.xml deleted file mode 100644 index 44e4e186faac..000000000000 --- a/reference/solr/solrquery/getrows.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - SolrQuery::getRows - Returns the maximum number of documents - - - - &reftitle.description; - - public intSolrQuery::getRows - - - - Returns the maximum number of documents from the complete result set to return to the client for every request - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Returns an integer on success and &null; if not set. - - - - - - - diff --git a/reference/solr/solrquery/getsortfields.xml b/reference/solr/solrquery/getsortfields.xml deleted file mode 100644 index 55f977095817..000000000000 --- a/reference/solr/solrquery/getsortfields.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - SolrQuery::getSortFields - Returns all the sort fields - - - - &reftitle.description; - - public arraySolrQuery::getSortFields - - - -Returns all the sort fields - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Returns an array on success and &null; if none of the parameters was set. - - - - - diff --git a/reference/solr/solrquery/getstart.xml b/reference/solr/solrquery/getstart.xml deleted file mode 100644 index 7baca1ea0c08..000000000000 --- a/reference/solr/solrquery/getstart.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - SolrQuery::getStart - Returns the offset in the complete result set - - - - &reftitle.description; - - public intSolrQuery::getStart - - - - Returns the offset in the complete result set for the queries where the set of returned documents should begin. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Returns an integer on success and &null; if not set. - - - - - - - diff --git a/reference/solr/solrquery/getstats.xml b/reference/solr/solrquery/getstats.xml deleted file mode 100644 index 39b2051bb734..000000000000 --- a/reference/solr/solrquery/getstats.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - SolrQuery::getStats - Returns whether or not stats is enabled - - - - &reftitle.description; - - public boolSolrQuery::getStats - - - - Returns whether or not stats is enabled - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Returns a boolean on success and &null; if not set. - - - - - - - diff --git a/reference/solr/solrquery/getstatsfacets.xml b/reference/solr/solrquery/getstatsfacets.xml deleted file mode 100644 index 19bd6653b70c..000000000000 --- a/reference/solr/solrquery/getstatsfacets.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrQuery::getStatsFacets - Returns all the stats facets that were set - - - - &reftitle.description; - - public arraySolrQuery::getStatsFacets - - - - Returns all the stats facets that were set - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Returns an array on success and &null; if not set. - - - - - - - diff --git a/reference/solr/solrquery/getstatsfields.xml b/reference/solr/solrquery/getstatsfields.xml deleted file mode 100644 index bc8a33ee7aa2..000000000000 --- a/reference/solr/solrquery/getstatsfields.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - SolrQuery::getStatsFields - Returns all the statistics fields - - - - &reftitle.description; - - public arraySolrQuery::getStatsFields - - - - Returns all the statistics fields - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Returns an array on success and &null; if not set. - - - - - - - diff --git a/reference/solr/solrquery/getterms.xml b/reference/solr/solrquery/getterms.xml deleted file mode 100644 index 4dbdced45a08..000000000000 --- a/reference/solr/solrquery/getterms.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - SolrQuery::getTerms - Returns whether or not the TermsComponent is enabled - - - - &reftitle.description; - - public boolSolrQuery::getTerms - - - - Returns whether or not the TermsComponent is enabled - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Returns a boolean on success and &null; if not set. - - - - - - - diff --git a/reference/solr/solrquery/gettermsfield.xml b/reference/solr/solrquery/gettermsfield.xml deleted file mode 100644 index 99c4ea654020..000000000000 --- a/reference/solr/solrquery/gettermsfield.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - SolrQuery::getTermsField - Returns the field from which the terms are retrieved - - - - &reftitle.description; - - public stringSolrQuery::getTermsField - - - - Returns the field from which the terms are retrieved - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Returns a string on success and &null; if not set. - - - - - - - diff --git a/reference/solr/solrquery/gettermsincludelowerbound.xml b/reference/solr/solrquery/gettermsincludelowerbound.xml deleted file mode 100644 index 2e012d0bc402..000000000000 --- a/reference/solr/solrquery/gettermsincludelowerbound.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrQuery::getTermsIncludeLowerBound - Returns whether or not to include the lower bound in the result set - - - - &reftitle.description; - - public boolSolrQuery::getTermsIncludeLowerBound - - - - Returns whether or not to include the lower bound in the result set - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Returns a boolean on success and &null; if not set. - - - - - - diff --git a/reference/solr/solrquery/gettermsincludeupperbound.xml b/reference/solr/solrquery/gettermsincludeupperbound.xml deleted file mode 100644 index 78b1d87236fd..000000000000 --- a/reference/solr/solrquery/gettermsincludeupperbound.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - SolrQuery::getTermsIncludeUpperBound - Returns whether or not to include the upper bound term in the result set - - - - &reftitle.description; - - public boolSolrQuery::getTermsIncludeUpperBound - - - - Returns whether or not to include the upper bound term in the result set - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Returns a boolean on success and &null; if not set. - - - - - - - diff --git a/reference/solr/solrquery/gettermslimit.xml b/reference/solr/solrquery/gettermslimit.xml deleted file mode 100644 index 060de467d2d7..000000000000 --- a/reference/solr/solrquery/gettermslimit.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - SolrQuery::getTermsLimit - Returns the maximum number of terms Solr should return - - - - &reftitle.description; - - public intSolrQuery::getTermsLimit - - - - Returns the maximum number of terms Solr should return - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Returns an integer on success and &null; if not set. - - - - - - - diff --git a/reference/solr/solrquery/gettermslowerbound.xml b/reference/solr/solrquery/gettermslowerbound.xml deleted file mode 100644 index fdaa78e36a0b..000000000000 --- a/reference/solr/solrquery/gettermslowerbound.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - SolrQuery::getTermsLowerBound - Returns the term to start at - - - - &reftitle.description; - - public stringSolrQuery::getTermsLowerBound - - - - Returns the term to start at - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Returns a string on success and &null; if not set. - - - - - - - diff --git a/reference/solr/solrquery/gettermsmaxcount.xml b/reference/solr/solrquery/gettermsmaxcount.xml deleted file mode 100644 index ee0e14364231..000000000000 --- a/reference/solr/solrquery/gettermsmaxcount.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - SolrQuery::getTermsMaxCount - Returns the maximum document frequency - - - - &reftitle.description; - - public intSolrQuery::getTermsMaxCount - - - - Returns the maximum document frequency - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Returns an integer on success and &null; if not set. - - - - - - - diff --git a/reference/solr/solrquery/gettermsmincount.xml b/reference/solr/solrquery/gettermsmincount.xml deleted file mode 100644 index 1fd87e7e8ff0..000000000000 --- a/reference/solr/solrquery/gettermsmincount.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - SolrQuery::getTermsMinCount - Returns the minimum document frequency to return in order to be included - - - - &reftitle.description; - - public intSolrQuery::getTermsMinCount - - - - Returns the minimum document frequency to return in order to be included - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Returns an integer on success and &null; if not set. - - - - - - - diff --git a/reference/solr/solrquery/gettermsprefix.xml b/reference/solr/solrquery/gettermsprefix.xml deleted file mode 100644 index d631f7b08fbe..000000000000 --- a/reference/solr/solrquery/gettermsprefix.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - SolrQuery::getTermsPrefix - Returns the term prefix - - - - &reftitle.description; - - public stringSolrQuery::getTermsPrefix - - - - Returns the prefix to which matching terms must be restricted. This will restrict matches to only terms that start with the prefix - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Returns a string on success and &null; if not set. - - - - - - - diff --git a/reference/solr/solrquery/gettermsreturnraw.xml b/reference/solr/solrquery/gettermsreturnraw.xml deleted file mode 100644 index 2e3a4f8236ab..000000000000 --- a/reference/solr/solrquery/gettermsreturnraw.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - SolrQuery::getTermsReturnRaw - Whether or not to return raw characters - - - - &reftitle.description; - - public boolSolrQuery::getTermsReturnRaw - - - - Returns a boolean indicating whether or not to return the raw characters of the indexed term, regardless of if it is human readable - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Returns a boolean on success and &null; if not set. - - - - - - - diff --git a/reference/solr/solrquery/gettermssort.xml b/reference/solr/solrquery/gettermssort.xml deleted file mode 100644 index 8645e34fa198..000000000000 --- a/reference/solr/solrquery/gettermssort.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrQuery::getTermsSort - Returns an integer indicating how terms are sorted - - - - &reftitle.description; - - public intSolrQuery::getTermsSort - - - - SolrQuery::TERMS_SORT_INDEX indicates that the terms are returned by index order. SolrQuery::TERMS_SORT_COUNT implies that the terms are sorted by term frequency (highest count first) - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Returns an integer on success and &null; if not set. - - - - - - - diff --git a/reference/solr/solrquery/gettermsupperbound.xml b/reference/solr/solrquery/gettermsupperbound.xml deleted file mode 100644 index 4b6e21708c07..000000000000 --- a/reference/solr/solrquery/gettermsupperbound.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrQuery::getTermsUpperBound - Returns the term to stop at - - - - &reftitle.description; - - public stringSolrQuery::getTermsUpperBound - - - - Returns the term to stop at - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Returns a string on success and &null; if not set. - - - - - - - diff --git a/reference/solr/solrquery/gettimeallowed.xml b/reference/solr/solrquery/gettimeallowed.xml deleted file mode 100644 index 864b7b5928c9..000000000000 --- a/reference/solr/solrquery/gettimeallowed.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - SolrQuery::getTimeAllowed - Returns the time in milliseconds allowed for the query to finish - - - - &reftitle.description; - - public intSolrQuery::getTimeAllowed - - - -Returns the time in milliseconds allowed for the query to finish. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Returns and integer on success and &null; if it is not set. - - - - - - - diff --git a/reference/solr/solrquery/removeexpandfilterquery.xml b/reference/solr/solrquery/removeexpandfilterquery.xml deleted file mode 100644 index c4f6faf027fb..000000000000 --- a/reference/solr/solrquery/removeexpandfilterquery.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - SolrQuery::removeExpandFilterQuery - Removes an expand filter query - - - - &reftitle.description; - - public SolrQuerySolrQuery::removeExpandFilterQuery - stringfq - - - Removes an expand filter query. - - - - - - &reftitle.parameters; - - - fq - - - - - - - - - - - &reftitle.returnvalues; - - SolrQuery - - - - - &reftitle.seealso; - - SolrQuery::setExpand - SolrQuery::addExpandSortField - SolrQuery::removeExpandSortField - SolrQuery::setExpandRows - SolrQuery::setExpandQuery - SolrQuery::addExpandFilterQuery - - - - - diff --git a/reference/solr/solrquery/removeexpandsortfield.xml b/reference/solr/solrquery/removeexpandsortfield.xml deleted file mode 100644 index 39191f39c1e2..000000000000 --- a/reference/solr/solrquery/removeexpandsortfield.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - SolrQuery::removeExpandSortField - Removes an expand sort field from the expand.sort parameter - - - - &reftitle.description; - - public SolrQuerySolrQuery::removeExpandSortField - stringfield - - - Removes an expand sort field from the expand.sort parameter. - - - - - &reftitle.parameters; - - - field - - - field name - - - - - - - - &reftitle.returnvalues; - - SolrQuery - - - - &reftitle.seealso; - - SolrQuery::setExpand - SolrQuery::addExpandSortField - SolrQuery::setExpandRows - SolrQuery::setExpandQuery - SolrQuery::addExpandFilterQuery - SolrQuery::removeExpandFilterQuery - - - - - diff --git a/reference/solr/solrquery/removefacetdatefield.xml b/reference/solr/solrquery/removefacetdatefield.xml deleted file mode 100644 index 92570e91b625..000000000000 --- a/reference/solr/solrquery/removefacetdatefield.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrQuery::removeFacetDateField - Removes one of the facet date fields - - - - &reftitle.description; - - public SolrQuerySolrQuery::removeFacetDateField - stringfield - - - The name of the field - - - - - - &reftitle.parameters; - - - - field - - - The name of the date field to remove - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/removefacetdateother.xml b/reference/solr/solrquery/removefacetdateother.xml deleted file mode 100644 index 0f968cc1d6ba..000000000000 --- a/reference/solr/solrquery/removefacetdateother.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - SolrQuery::removeFacetDateOther - Removes one of the facet.date.other parameters - - - - &reftitle.description; - - public SolrQuerySolrQuery::removeFacetDateOther - stringvalue - stringfield_override - - - Removes one of the facet.date.other parameters - - - - - - &reftitle.parameters; - - - - value - - - The value - - - - - field_override - - - The name of the field. - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - - diff --git a/reference/solr/solrquery/removefacetfield.xml b/reference/solr/solrquery/removefacetfield.xml deleted file mode 100644 index 261b5c29367b..000000000000 --- a/reference/solr/solrquery/removefacetfield.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrQuery::removeFacetField - Removes one of the facet.date parameters - - - - &reftitle.description; - - public SolrQuerySolrQuery::removeFacetField - stringfield - - - Removes one of the facet.date parameters - - - - - - &reftitle.parameters; - - - - field - - - The name of the field - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/removefacetquery.xml b/reference/solr/solrquery/removefacetquery.xml deleted file mode 100644 index c02d3353d68a..000000000000 --- a/reference/solr/solrquery/removefacetquery.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrQuery::removeFacetQuery - Removes one of the facet.query parameters - - - - &reftitle.description; - - public SolrQuerySolrQuery::removeFacetQuery - stringvalue - - - Removes one of the facet.query parameters. - - - - - - &reftitle.parameters; - - - - value - - - The value - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/removefield.xml b/reference/solr/solrquery/removefield.xml deleted file mode 100644 index 870da3e31af3..000000000000 --- a/reference/solr/solrquery/removefield.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrQuery::removeField - Removes a field from the list of fields - - - - &reftitle.description; - - public SolrQuerySolrQuery::removeField - stringfield - - - Removes a field from the list of fields - - - - - - &reftitle.parameters; - - - - field - - - Name of the field. - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/removefilterquery.xml b/reference/solr/solrquery/removefilterquery.xml deleted file mode 100644 index b001b4c4d936..000000000000 --- a/reference/solr/solrquery/removefilterquery.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrQuery::removeFilterQuery - Removes a filter query - - - - &reftitle.description; - - public SolrQuerySolrQuery::removeFilterQuery - stringfq - - - Removes a filter query. - - - - - - &reftitle.parameters; - - - - fq - - - The filter query to remove - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/removehighlightfield.xml b/reference/solr/solrquery/removehighlightfield.xml deleted file mode 100644 index c621a390119e..000000000000 --- a/reference/solr/solrquery/removehighlightfield.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrQuery::removeHighlightField - Removes one of the fields used for highlighting - - - - &reftitle.description; - - public SolrQuerySolrQuery::removeHighlightField - stringfield - - - Removes one of the fields used for highlighting. - - - - - - &reftitle.parameters; - - - - field - - - The name of the field - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/removemltfield.xml b/reference/solr/solrquery/removemltfield.xml deleted file mode 100644 index 753969d3d90e..000000000000 --- a/reference/solr/solrquery/removemltfield.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrQuery::removeMltField - Removes one of the moreLikeThis fields - - - - &reftitle.description; - - public SolrQuerySolrQuery::removeMltField - stringfield - - - Removes one of the moreLikeThis fields. - - - - - - &reftitle.parameters; - - - - field - - - Name of the field - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/removemltqueryfield.xml b/reference/solr/solrquery/removemltqueryfield.xml deleted file mode 100644 index 7488c5bda2de..000000000000 --- a/reference/solr/solrquery/removemltqueryfield.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrQuery::removeMltQueryField - Removes one of the moreLikeThis query fields - - - - &reftitle.description; - - public SolrQuerySolrQuery::removeMltQueryField - stringqueryField - - - Removes one of the moreLikeThis query fields. - - - - - - &reftitle.parameters; - - - - queryField - - - The query field - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/removesortfield.xml b/reference/solr/solrquery/removesortfield.xml deleted file mode 100644 index 7a8f93cef716..000000000000 --- a/reference/solr/solrquery/removesortfield.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrQuery::removeSortField - Removes one of the sort fields - - - - &reftitle.description; - - public SolrQuerySolrQuery::removeSortField - stringfield - - - Removes one of the sort fields - - - - - - &reftitle.parameters; - - - - field - - - The name of the field - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/removestatsfacet.xml b/reference/solr/solrquery/removestatsfacet.xml deleted file mode 100644 index 35decee68369..000000000000 --- a/reference/solr/solrquery/removestatsfacet.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrQuery::removeStatsFacet - Removes one of the stats.facet parameters - - - - &reftitle.description; - - public SolrQuerySolrQuery::removeStatsFacet - stringvalue - - - Removes one of the stats.facet parameters - - - - - - &reftitle.parameters; - - - - value - - - The value - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/removestatsfield.xml b/reference/solr/solrquery/removestatsfield.xml deleted file mode 100644 index 8e38ed24f057..000000000000 --- a/reference/solr/solrquery/removestatsfield.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrQuery::removeStatsField - Removes one of the stats.field parameters - - - - &reftitle.description; - - public SolrQuerySolrQuery::removeStatsField - stringfield - - - Removes one of the stats.field parameters - - - - - - &reftitle.parameters; - - - - field - - - The name of the field. - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/setechohandler.xml b/reference/solr/solrquery/setechohandler.xml deleted file mode 100644 index abf314a457ab..000000000000 --- a/reference/solr/solrquery/setechohandler.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - SolrQuery::setEchoHandler - Toggles the echoHandler parameter - - - - &reftitle.description; - - public SolrQuerySolrQuery::setEchoHandler - boolflag - - - If set to true, Solr places the name of the handle used in the response to the client for debugging purposes. - - - - - &reftitle.parameters; - - - - flag - - - &true; or &false; - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/setechoparams.xml b/reference/solr/solrquery/setechoparams.xml deleted file mode 100644 index e9d580d8a978..000000000000 --- a/reference/solr/solrquery/setechoparams.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - SolrQuery::setEchoParams - Determines what kind of parameters to include in the response - - - - &reftitle.description; - - public SolrQuerySolrQuery::setEchoParams - stringtype - - - Instructs Solr what kinds of Request parameters should be included in the response for debugging purposes, legal values include: - - - - - - - - - - - &reftitle.parameters; - - - - type - - - The type of parameters to include - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/setexpand.xml b/reference/solr/solrquery/setexpand.xml deleted file mode 100644 index dae57122405c..000000000000 --- a/reference/solr/solrquery/setexpand.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - SolrQuery::setExpand - Enables/Disables the Expand Component - - - - &reftitle.description; - - public SolrQuerySolrQuery::setExpand - boolvalue - - - Enables/Disables the Expand Component. - - - - - - &reftitle.parameters; - - - value - - - Bool flag - - - - - - - - &reftitle.returnvalues; - - SolrQuery - - - - - &reftitle.examples; - - <function>SolrQuery::setExpand</function> example - -setExpand(true) - ->setExpandRows(50) - ->setExpandQuery('text:product') - ->addExpandFilterQuery('manu:apple') - ->addExpandFilterQuery('inStock:true') - ->addExpandSortField('score', SolrQuery::ORDER_DESC) - ->addExpandSortField('title', SolrQuery::ORDER_ASC); - -echo $query.PHP_EOL; - -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - SolrQuery::addExpandSortField - SolrQuery::removeExpandSortField - SolrQuery::setExpandRows - SolrQuery::setExpandQuery - SolrQuery::addExpandFilterQuery - SolrQuery::removeExpandFilterQuery - - - - - - diff --git a/reference/solr/solrquery/setexpandquery.xml b/reference/solr/solrquery/setexpandquery.xml deleted file mode 100644 index d46ad49d9c8e..000000000000 --- a/reference/solr/solrquery/setexpandquery.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - SolrQuery::setExpandQuery - Sets the expand.q parameter - - - - &reftitle.description; - - public SolrQuerySolrQuery::setExpandQuery - stringq - - - Sets the expand.q parameter. - - - Overrides the main q parameter, - determines which documents to include in the main group. - - - - - &reftitle.parameters; - - - q - - - - - - - - - - - &reftitle.returnvalues; - - SolrQuery - - - - &reftitle.seealso; - - SolrQuery::setExpand - SolrQuery::addExpandSortField - SolrQuery::removeExpandSortField - SolrQuery::setExpandRows - SolrQuery::addExpandFilterQuery - SolrQuery::removeExpandFilterQuery - - - - - diff --git a/reference/solr/solrquery/setexpandrows.xml b/reference/solr/solrquery/setexpandrows.xml deleted file mode 100644 index 2f6a1885d9e4..000000000000 --- a/reference/solr/solrquery/setexpandrows.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - SolrQuery::setExpandRows - Sets the number of rows to display in each group (expand.rows). Server Default 5 - - - - &reftitle.description; - - public SolrQuerySolrQuery::setExpandRows - intvalue - - - Sets the number of rows to display in each group (expand.rows). Server Default 5 - - - - - &reftitle.parameters; - - - value - - - - - - - - - - - &reftitle.returnvalues; - - SolrQuery - - - - &reftitle.seealso; - - SolrQuery::setExpand - SolrQuery::addExpandSortField - SolrQuery::removeExpandSortField - SolrQuery::setExpandQuery - SolrQuery::addExpandFilterQuery - SolrQuery::removeExpandFilterQuery - - - - - diff --git a/reference/solr/solrquery/setexplainother.xml b/reference/solr/solrquery/setexplainother.xml deleted file mode 100644 index f5dcb11f0f6e..000000000000 --- a/reference/solr/solrquery/setexplainother.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - SolrQuery::setExplainOther - Sets the explainOther common query parameter - - - - &reftitle.description; - - public SolrQuerySolrQuery::setExplainOther - stringquery - - - Sets the explainOther common query parameter - - - - - &reftitle.parameters; - - - - query - - - The Lucene query to identify a set of documents - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/setfacet.xml b/reference/solr/solrquery/setfacet.xml deleted file mode 100644 index 1ced961e4f52..000000000000 --- a/reference/solr/solrquery/setfacet.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrQuery::setFacet - Maps to the facet parameter. Enables or disables facetting - - - - &reftitle.description; - - public SolrQuerySolrQuery::setFacet - boolflag - - - Enables or disables faceting. - - - - - - &reftitle.parameters; - - - - value - - - &true; enables faceting and &false; disables it. - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/setfacetdateend.xml b/reference/solr/solrquery/setfacetdateend.xml deleted file mode 100644 index 959ff942c5bd..000000000000 --- a/reference/solr/solrquery/setfacetdateend.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - SolrQuery::setFacetDateEnd - Maps to facet.date.end - - - - &reftitle.description; - - public SolrQuerySolrQuery::setFacetDateEnd - stringvalue - stringfield_override - - - Maps to facet.date.end - - - - - - &reftitle.parameters; - - - - value - - - See facet.date.end - - - - - field_override - - - Name of the field - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/setfacetdategap.xml b/reference/solr/solrquery/setfacetdategap.xml deleted file mode 100644 index c3cdb73174ff..000000000000 --- a/reference/solr/solrquery/setfacetdategap.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - SolrQuery::setFacetDateGap - Maps to facet.date.gap - - - - &reftitle.description; - - public SolrQuerySolrQuery::setFacetDateGap - stringvalue - stringfield_override - - - Maps to facet.date.gap - - - - - - &reftitle.parameters; - - - - value - - - See facet.date.gap - - - - - field_override - - - The name of the field - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/setfacetdatehardend.xml b/reference/solr/solrquery/setfacetdatehardend.xml deleted file mode 100644 index 63d96bee1ecc..000000000000 --- a/reference/solr/solrquery/setfacetdatehardend.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - SolrQuery::setFacetDateHardEnd - Maps to facet.date.hardend - - - - &reftitle.description; - - public SolrQuerySolrQuery::setFacetDateHardEnd - boolvalue - stringfield_override - - - Maps to facet.date.hardend - - - - - - &reftitle.parameters; - - - - value - - - See facet.date.hardend - - - - - field_override - - - The name of the field - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/setfacetdatestart.xml b/reference/solr/solrquery/setfacetdatestart.xml deleted file mode 100644 index 7383a83a136b..000000000000 --- a/reference/solr/solrquery/setfacetdatestart.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - SolrQuery::setFacetDateStart - Maps to facet.date.start - - - - &reftitle.description; - - public SolrQuerySolrQuery::setFacetDateStart - stringvalue - stringfield_override - - - Maps to facet.date.start - - - - - &reftitle.parameters; - - - - value - - - See facet.date.start - - - - - field_override - - - The name of the field. - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/setfacetenumcachemindefaultfrequency.xml b/reference/solr/solrquery/setfacetenumcachemindefaultfrequency.xml deleted file mode 100644 index e2e35f7ff824..000000000000 --- a/reference/solr/solrquery/setfacetenumcachemindefaultfrequency.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - SolrQuery::setFacetEnumCacheMinDefaultFrequency - Sets the minimum document frequency used for determining term count - - - - &reftitle.description; - - public SolrQuerySolrQuery::setFacetEnumCacheMinDefaultFrequency - intfrequency - stringfield_override - - - Sets the minimum document frequency used for determining term count - - - - - &reftitle.parameters; - - - - value - - - The minimum frequency - - - - - field_override - - - The name of the field. - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/setfacetlimit.xml b/reference/solr/solrquery/setfacetlimit.xml deleted file mode 100644 index 760af30efb67..000000000000 --- a/reference/solr/solrquery/setfacetlimit.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - SolrQuery::setFacetLimit - Maps to facet.limit - - - - &reftitle.description; - - public SolrQuerySolrQuery::setFacetLimit - intlimit - stringfield_override - - - Maps to facet.limit. Sets the maximum number of constraint counts that should be returned for the facet fields. - - - - - - &reftitle.parameters; - - - - limit - - - The maximum number of constraint counts - - - - - field_override - - - The name of the field. - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/setfacetmethod.xml b/reference/solr/solrquery/setfacetmethod.xml deleted file mode 100644 index bb7b5f7d769e..000000000000 --- a/reference/solr/solrquery/setfacetmethod.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - SolrQuery::setFacetMethod - Specifies the type of algorithm to use when faceting a field - - - - &reftitle.description; - - public SolrQuerySolrQuery::setFacetMethod - stringmethod - stringfield_override - - - Specifies the type of algorithm to use when faceting a field. This method accepts optional field override. - - - - - - &reftitle.parameters; - - - - method - - - The method to use. - - - - - field_override - - - The name of the field. - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/setfacetmincount.xml b/reference/solr/solrquery/setfacetmincount.xml deleted file mode 100644 index e861baae500d..000000000000 --- a/reference/solr/solrquery/setfacetmincount.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - SolrQuery::setFacetMinCount - Maps to facet.mincount - - - - &reftitle.description; - - public SolrQuerySolrQuery::setFacetMinCount - intmincount - stringfield_override - - - Sets the minimum counts for facet fields that should be included in the response - - - - - - &reftitle.parameters; - - - - mincount - - - The minimum count - - - - - field_override - - - The name of the field. - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/setfacetmissing.xml b/reference/solr/solrquery/setfacetmissing.xml deleted file mode 100644 index 8ba5d2d76c95..000000000000 --- a/reference/solr/solrquery/setfacetmissing.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - SolrQuery::setFacetMissing - Maps to facet.missing - - - - &reftitle.description; - - public SolrQuerySolrQuery::setFacetMissing - boolflag - stringfield_override - - - Used to indicate that in addition to the Term-based constraints of a facet field, a count of all matching results which have no value for the field should be computed - - - - - - &reftitle.parameters; - - - - flag - - - &true; turns this feature on. &false; disables it. - - - - - field_override - - - The name of the field. - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/setfacetoffset.xml b/reference/solr/solrquery/setfacetoffset.xml deleted file mode 100644 index ea9e68f16814..000000000000 --- a/reference/solr/solrquery/setfacetoffset.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - SolrQuery::setFacetOffset - Sets the offset into the list of constraints to allow for pagination - - - - &reftitle.description; - - public SolrQuerySolrQuery::setFacetOffset - intoffset - stringfield_override - - - Sets the offset into the list of constraints to allow for pagination. - - - - - - &reftitle.parameters; - - - - offset - - - The offset - - - - - field_override - - - The name of the field. - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/setfacetprefix.xml b/reference/solr/solrquery/setfacetprefix.xml deleted file mode 100644 index eeb65e7481c8..000000000000 --- a/reference/solr/solrquery/setfacetprefix.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - SolrQuery::setFacetPrefix - Specifies a string prefix with which to limits the terms on which to facet - - - - &reftitle.description; - - public SolrQuerySolrQuery::setFacetPrefix - stringprefix - stringfield_override - - - Specifies a string prefix with which to limits the terms on which to facet. - - - - - - &reftitle.parameters; - - - - prefix - - - The prefix string - - - - - field_override - - - The name of the field. - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/setfacetsort.xml b/reference/solr/solrquery/setfacetsort.xml deleted file mode 100644 index bfd508b6071d..000000000000 --- a/reference/solr/solrquery/setfacetsort.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - SolrQuery::setFacetSort - Determines the ordering of the facet field constraints - - - - &reftitle.description; - - public SolrQuerySolrQuery::setFacetSort - intfacetSort - stringfield_override - - - Determines the ordering of the facet field constraints - - - - - - &reftitle.parameters; - - - - facetSort - - - Use SolrQuery::FACET_SORT_INDEX for sorting by index order or SolrQuery::FACET_SORT_COUNT for sorting by count. - - - - - field_override - - - The name of the field. - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/setgroup.xml b/reference/solr/solrquery/setgroup.xml deleted file mode 100644 index 1957dafc5895..000000000000 --- a/reference/solr/solrquery/setgroup.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - SolrQuery::setGroup - Enable/Disable result grouping (group parameter) - - - - &reftitle.description; - - public SolrQuerySolrQuery::setGroup - boolvalue - - - Enable/Disable result grouping (group parameter) - - - - - &reftitle.parameters; - - - value - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrQuery::getGroup - SolrQuery::addGroupField - SolrQuery::addGroupFunction - SolrQuery::addGroupQuery - SolrQuery::addGroupSortField - SolrQuery::setGroupFacet - SolrQuery::setGroupOffset - SolrQuery::setGroupLimit - SolrQuery::setGroupMain - SolrQuery::setGroupNGroups - SolrQuery::setGroupTruncate - SolrQuery::setGroupFormat - SolrQuery::setGroupCachePercent - - - - - - diff --git a/reference/solr/solrquery/setgroupcachepercent.xml b/reference/solr/solrquery/setgroupcachepercent.xml deleted file mode 100644 index 3264b5f27704..000000000000 --- a/reference/solr/solrquery/setgroupcachepercent.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - SolrQuery::setGroupCachePercent - Enables caching for result grouping - - - - &reftitle.description; - - public SolrQuerySolrQuery::setGroupCachePercent - intpercent - - - Setting this parameter to a number greater than 0 enables caching for result grouping. - Result Grouping executes two searches; this option caches the second search. The server default value is 0. - - Testing has shown that group caching only improves search time with Boolean, wildcard, and fuzzy queries. For simple queries like term or "match all" queries, group caching degrades performance. - group.cache.percent parameter - - - - - &reftitle.parameters; - - - percent - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.errors; - - Emits SolrIllegalArgumentException in case of an invalid parameter was passed. - - - - - &reftitle.seealso; - - SolrQuery::setGroup - SolrQuery::addGroupField - SolrQuery::addGroupFunction - SolrQuery::addGroupQuery - SolrQuery::addGroupSortField - SolrQuery::setGroupFacet - SolrQuery::setGroupOffset - SolrQuery::setGroupLimit - SolrQuery::setGroupMain - SolrQuery::setGroupNGroups - SolrQuery::setGroupTruncate - SolrQuery::setGroupFormat - - - - - - diff --git a/reference/solr/solrquery/setgroupfacet.xml b/reference/solr/solrquery/setgroupfacet.xml deleted file mode 100644 index ce7325904116..000000000000 --- a/reference/solr/solrquery/setgroupfacet.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - SolrQuery::setGroupFacet - Sets group.facet parameter - - - - &reftitle.description; - - public SolrQuerySolrQuery::setGroupFacet - boolvalue - - - Determines whether to compute grouped facets for the field facets specified in facet.field parameters. - Grouped facets are computed based on the first specified group. - - - - - &reftitle.parameters; - - - value - - - - - - - - - - - &reftitle.returnvalues; - - - - - - &reftitle.seealso; - - SolrQuery::setGroup - SolrQuery::addGroupField - SolrQuery::addGroupFunction - SolrQuery::addGroupQuery - SolrQuery::addGroupSortField - SolrQuery::setGroupOffset - SolrQuery::setGroupLimit - SolrQuery::setGroupMain - SolrQuery::setGroupNGroups - SolrQuery::setGroupTruncate - SolrQuery::setGroupFormat - SolrQuery::setGroupCachePercent - - - - - diff --git a/reference/solr/solrquery/setgroupformat.xml b/reference/solr/solrquery/setgroupformat.xml deleted file mode 100644 index 7e17dfe2f965..000000000000 --- a/reference/solr/solrquery/setgroupformat.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - SolrQuery::setGroupFormat - Sets the group format, result structure (group.format parameter) - - - - &reftitle.description; - - public SolrQuerySolrQuery::setGroupFormat - stringvalue - - - Sets the group.format parameter. - If this parameter is set to simple, the grouped documents are presented in a single flat list, and the start and rows parameters affect the numbers of documents instead of groups. - Accepts: grouped/simple - - - - - &reftitle.parameters; - - - value - - - - - - - - - - - &reftitle.returnvalues; - - - - - - &reftitle.seealso; - - SolrQuery::setGroup - SolrQuery::addGroupField - SolrQuery::addGroupFunction - SolrQuery::addGroupQuery - SolrQuery::addGroupSortField - SolrQuery::setGroupFacet - SolrQuery::setGroupOffset - SolrQuery::setGroupLimit - SolrQuery::setGroupMain - SolrQuery::setGroupNGroups - SolrQuery::setGroupTruncate - SolrQuery::setGroupCachePercent - - - - - diff --git a/reference/solr/solrquery/setgrouplimit.xml b/reference/solr/solrquery/setgrouplimit.xml deleted file mode 100644 index d0f2908786c4..000000000000 --- a/reference/solr/solrquery/setgrouplimit.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - SolrQuery::setGroupLimit - Specifies the number of results to return for each group. The server default value is 1 - - - - &reftitle.description; - - public SolrQuerySolrQuery::setGroupLimit - intvalue - - - Specifies the number of results to return for each group. The server default value is 1. - - - - - &reftitle.parameters; - - - value - - - - - - - - - - - &reftitle.returnvalues; - - - - - - &reftitle.seealso; - - SolrQuery::setGroup - SolrQuery::addGroupField - SolrQuery::addGroupFunction - SolrQuery::addGroupQuery - SolrQuery::addGroupSortField - SolrQuery::setGroupFacet - SolrQuery::setGroupOffset - SolrQuery::setGroupMain - SolrQuery::setGroupNGroups - SolrQuery::setGroupTruncate - SolrQuery::setGroupFormat - SolrQuery::setGroupCachePercent - - - - - diff --git a/reference/solr/solrquery/setgroupmain.xml b/reference/solr/solrquery/setgroupmain.xml deleted file mode 100644 index 481cd28b12fe..000000000000 --- a/reference/solr/solrquery/setgroupmain.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - SolrQuery::setGroupMain - If true, the result of the first field grouping command is used as the main result list in the response, using group.format=simple - - - - &reftitle.description; - - public SolrQuerySolrQuery::setGroupMain - stringvalue - - - If &true;, the result of the first field grouping command is used as the main result list in the response, using group.format=simple. - - - - - - &reftitle.parameters; - - - value - - - If &true;, the result of the first field grouping command is used as the main result list in the response. - - - - - - - - &reftitle.returnvalues; - - Returns an instance of SolrQuery. - - - - - &reftitle.seealso; - - SolrQuery::setGroup - SolrQuery::addGroupField - SolrQuery::addGroupFunction - SolrQuery::addGroupQuery - SolrQuery::addGroupSortField - SolrQuery::setGroupFacet - SolrQuery::setGroupOffset - SolrQuery::setGroupMain - SolrQuery::setGroupNGroups - SolrQuery::setGroupTruncate - SolrQuery::setGroupFormat - SolrQuery::setGroupCachePercent - - - - - diff --git a/reference/solr/solrquery/setgroupngroups.xml b/reference/solr/solrquery/setgroupngroups.xml deleted file mode 100644 index f12e8d420435..000000000000 --- a/reference/solr/solrquery/setgroupngroups.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - SolrQuery::setGroupNGroups - If true, Solr includes the number of groups that have matched the query in the results - - - - &reftitle.description; - - public SolrQuerySolrQuery::setGroupNGroups - boolvalue - - - If true, Solr includes the number of groups that have matched the query in the results. - - - - - - &reftitle.parameters; - - - value - - - - - - - - - - - &reftitle.returnvalues; - - - - - - &reftitle.seealso; - - SolrQuery::setGroup - SolrQuery::addGroupField - SolrQuery::addGroupFunction - SolrQuery::addGroupQuery - SolrQuery::addGroupSortField - SolrQuery::setGroupFacet - SolrQuery::setGroupOffset - SolrQuery::setGroupLimit - SolrQuery::setGroupMain - SolrQuery::setGroupTruncate - SolrQuery::setGroupFormat - SolrQuery::setGroupCachePercent - - - - - diff --git a/reference/solr/solrquery/setgroupoffset.xml b/reference/solr/solrquery/setgroupoffset.xml deleted file mode 100644 index 2f787fe59cf5..000000000000 --- a/reference/solr/solrquery/setgroupoffset.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - SolrQuery::setGroupOffset - Sets the group.offset parameter - - - - &reftitle.description; - - public SolrQuerySolrQuery::setGroupOffset - intvalue - - - Sets the group.offset parameter. - - - - - - &reftitle.parameters; - - - value - - - - - - - - - - - &reftitle.returnvalues; - - - - - - &reftitle.seealso; - - SolrQuery::setGroup - SolrQuery::addGroupField - SolrQuery::addGroupFunction - SolrQuery::addGroupQuery - SolrQuery::addGroupSortField - SolrQuery::setGroupFacet - SolrQuery::setGroupLimit - SolrQuery::setGroupMain - SolrQuery::setGroupNGroups - SolrQuery::setGroupTruncate - SolrQuery::setGroupFormat - SolrQuery::setGroupCachePercent - - - - - diff --git a/reference/solr/solrquery/setgrouptruncate.xml b/reference/solr/solrquery/setgrouptruncate.xml deleted file mode 100644 index c66262772d59..000000000000 --- a/reference/solr/solrquery/setgrouptruncate.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - SolrQuery::setGroupTruncate - If true, facet counts are based on the most relevant document of each group matching the query - - - - &reftitle.description; - - public SolrQuerySolrQuery::setGroupTruncate - boolvalue - - - If true, facet counts are based on the most relevant document of each group matching the query. - The server default value is false. - group.truncate parameter - - - - - - &reftitle.parameters; - - - value - - - - - - - - - - - &reftitle.returnvalues; - - - - - - &reftitle.seealso; - - SolrQuery::setGroup - SolrQuery::addGroupField - SolrQuery::addGroupFunction - SolrQuery::addGroupQuery - SolrQuery::addGroupSortField - SolrQuery::setGroupFacet - SolrQuery::setGroupOffset - SolrQuery::setGroupLimit - SolrQuery::setGroupMain - SolrQuery::setGroupNGroups - SolrQuery::setGroupFormat - SolrQuery::setGroupCachePercent - - - - - diff --git a/reference/solr/solrquery/sethighlight.xml b/reference/solr/solrquery/sethighlight.xml deleted file mode 100644 index 4c57cf244d56..000000000000 --- a/reference/solr/solrquery/sethighlight.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - SolrQuery::setHighlight - Enables or disables highlighting - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlight - boolflag - - - Setting it to &true; enables highlighted snippets to be generated in the query response. - - - Setting it to &false; disables highlighting - - - - &reftitle.parameters; - - - - flag - - - Enable or disable highlighting - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/sethighlightalternatefield.xml b/reference/solr/solrquery/sethighlightalternatefield.xml deleted file mode 100644 index a2c6eb2ee594..000000000000 --- a/reference/solr/solrquery/sethighlightalternatefield.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - SolrQuery::setHighlightAlternateField - Specifies the backup field to use - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlightAlternateField - stringfield - stringfield_override - - - If a snippet cannot be generated because there were no matching terms, one can specify a field to use as the backup or default summary - - - - - - &reftitle.parameters; - - - - field - - - The name of the backup field - - - - - field_override - - - The name of the field we are overriding this setting for. - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/sethighlightformatter.xml b/reference/solr/solrquery/sethighlightformatter.xml deleted file mode 100644 index 5b4c297ff1c2..000000000000 --- a/reference/solr/solrquery/sethighlightformatter.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - SolrQuery::setHighlightFormatter - Specify a formatter for the highlight output - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlightFormatter - stringformatter - stringfield_override - - - Specify a formatter for the highlight output. - - - - - &reftitle.parameters; - - - - formatter - - - Currently the only legal value is "simple" - - - - - field_override - - - The name of the field. - - - - - - - - - &reftitle.returnvalues; - - Returns an instance of SolrQuery. - - - - - diff --git a/reference/solr/solrquery/sethighlightfragmenter.xml b/reference/solr/solrquery/sethighlightfragmenter.xml deleted file mode 100644 index f755ed08e0bd..000000000000 --- a/reference/solr/solrquery/sethighlightfragmenter.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - SolrQuery::setHighlightFragmenter - Sets a text snippet generator for highlighted text - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlightFragmenter - stringfragmenter - stringfield_override - - - Specify a text snippet generator for highlighted text. - - - - - &reftitle.parameters; - - - - fragmenter - - - The standard fragmenter is gap. Another option is regex, which tries to create fragments that resembles a certain regular expression - - - - - field_override - - - The name of the field. - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/sethighlightfragsize.xml b/reference/solr/solrquery/sethighlightfragsize.xml deleted file mode 100644 index cd2187641209..000000000000 --- a/reference/solr/solrquery/sethighlightfragsize.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - SolrQuery::setHighlightFragsize - The size of fragments to consider for highlighting - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlightFragsize - intsize - stringfield_override - - - Sets the size, in characters, of fragments to consider for highlighting. "0" indicates that the whole field value should be used (no fragmenting). - - - - - &reftitle.parameters; - - - - size - - - The size, in characters, of fragments to consider for highlighting - - - - - field_override - - - The name of the field. - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/sethighlighthighlightmultiterm.xml b/reference/solr/solrquery/sethighlighthighlightmultiterm.xml deleted file mode 100644 index 5b0f3e0a09ee..000000000000 --- a/reference/solr/solrquery/sethighlighthighlightmultiterm.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - SolrQuery::setHighlightHighlightMultiTerm - Use SpanScorer to highlight phrase terms - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlightHighlightMultiTerm - boolflag - - - Use SpanScorer to highlight phrase terms only when they appear within the query phrase in the document. - - - - - &reftitle.parameters; - - - - flag - - - Whether or not to use SpanScorer to highlight phrase terms only when they appear within the query phrase in the document. - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/sethighlightmaxalternatefieldlength.xml b/reference/solr/solrquery/sethighlightmaxalternatefieldlength.xml deleted file mode 100644 index 1a6bb0603282..000000000000 --- a/reference/solr/solrquery/sethighlightmaxalternatefieldlength.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - SolrQuery::setHighlightMaxAlternateFieldLength - Sets the maximum number of characters of the field to return - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlightMaxAlternateFieldLength - intfieldLength - stringfield_override - - - If SolrQuery::setHighlightAlternateField() was passed the value &true;, this parameter specifies the maximum number of characters of the field to return - - - Any value less than or equal to 0 means unlimited. - - - - - &reftitle.parameters; - - - - fieldLength - - - The length of the field - - - - - field_override - - - The name of the field. - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/sethighlightmaxanalyzedchars.xml b/reference/solr/solrquery/sethighlightmaxanalyzedchars.xml deleted file mode 100644 index 53afa4c33804..000000000000 --- a/reference/solr/solrquery/sethighlightmaxanalyzedchars.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrQuery::setHighlightMaxAnalyzedChars - Specifies the number of characters into a document to look for suitable snippets - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlightMaxAnalyzedChars - intvalue - - - Specifies the number of characters into a document to look for suitable snippets - - - - - - &reftitle.parameters; - - - - value - - - The number of characters into a document to look for suitable snippets - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/sethighlightmergecontiguous.xml b/reference/solr/solrquery/sethighlightmergecontiguous.xml deleted file mode 100644 index 801bc49a11a7..000000000000 --- a/reference/solr/solrquery/sethighlightmergecontiguous.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - SolrQuery::setHighlightMergeContiguous - Whether or not to collapse contiguous fragments into a single fragment - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlightMergeContiguous - boolflag - stringfield_override - - - Whether or not to collapse contiguous fragments into a single fragment - - - - - - &reftitle.parameters; - - - - value - - - Whether or not to collapse contiguous fragments into a single fragment - - - - - field_override - - - The name of the field. - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/sethighlightquery.xml b/reference/solr/solrquery/sethighlightquery.xml deleted file mode 100644 index 19ee9a77be92..000000000000 --- a/reference/solr/solrquery/sethighlightquery.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - SolrQuery::setHighlightQuery - A query designated for highlighting - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlightQuery - stringq - - - A query to use for highlighting and which will be set as the value of the Solr hl.q parameter. - This parameter allows one to highlight different terms or fields than those being used to retrieve documents. - - - - Default value when not set: the value of the request's q parameter. - - - - See the Highlighting - section for more details about the Solr hl.q parameter. - - - - - &reftitle.parameters; - - - - q - - - Highlight Query. - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object. - - - - - &reftitle.seealso; - - SolrQuery::getHighlightQuery - SolrQuery::setHighlightFields - SolrQuery::getHighlightFields - - - - - diff --git a/reference/solr/solrquery/sethighlightregexmaxanalyzedchars.xml b/reference/solr/solrquery/sethighlightregexmaxanalyzedchars.xml deleted file mode 100644 index dd941d24f836..000000000000 --- a/reference/solr/solrquery/sethighlightregexmaxanalyzedchars.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrQuery::setHighlightRegexMaxAnalyzedChars - Specify the maximum number of characters to analyze - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlightRegexMaxAnalyzedChars - intmaxAnalyzedChars - - - Specify the maximum number of characters to analyze from a field when using the regex fragmenter - - - - - - &reftitle.parameters; - - - - maxAnalyzedChars - - - The maximum number of characters to analyze from a field when using the regex fragmenter - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/sethighlightregexpattern.xml b/reference/solr/solrquery/sethighlightregexpattern.xml deleted file mode 100644 index a1a3d818ffda..000000000000 --- a/reference/solr/solrquery/sethighlightregexpattern.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrQuery::setHighlightRegexPattern - Specify the regular expression for fragmenting - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlightRegexPattern - stringvalue - - - Specifies the regular expression for fragmenting. This could be used to extract sentences - - - - - - &reftitle.parameters; - - - - value - - - The regular expression for fragmenting. This could be used to extract sentences - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/sethighlightregexslop.xml b/reference/solr/solrquery/sethighlightregexslop.xml deleted file mode 100644 index 859be71d52ca..000000000000 --- a/reference/solr/solrquery/sethighlightregexslop.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrQuery::setHighlightRegexSlop - Sets the factor by which the regex fragmenter can stray from the ideal fragment size - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlightRegexSlop - floatfactor - - - The factor by which the regex fragmenter can stray from the ideal fragment size ( specfied by SolrQuery::setHighlightFragsize )to accommodate the regular expression - - - - - - &reftitle.parameters; - - - - factor - - - The factor by which the regex fragmenter can stray from the ideal fragment size - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/sethighlightrequirefieldmatch.xml b/reference/solr/solrquery/sethighlightrequirefieldmatch.xml deleted file mode 100644 index 49ca28881d07..000000000000 --- a/reference/solr/solrquery/sethighlightrequirefieldmatch.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - SolrQuery::setHighlightRequireFieldMatch - Require field matching during highlighting - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlightRequireFieldMatch - boolflag - - - If &true;, then a field will only be highlighted if the query matched in this particular field. - - - This will only work if SolrQuery::setHighlightUsePhraseHighlighter() was set to &true; - - - - - &reftitle.parameters; - - - - flag - - - &true; or &false; - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/sethighlightsimplepost.xml b/reference/solr/solrquery/sethighlightsimplepost.xml deleted file mode 100644 index 48f316366d52..000000000000 --- a/reference/solr/solrquery/sethighlightsimplepost.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - SolrQuery::setHighlightSimplePost - Sets the text which appears after a highlighted term - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlightSimplePost - stringsimplePost - stringfield_override - - - Sets the text which appears before a highlighted term - - - - - - &reftitle.parameters; - - - - simplePost - - - Sets the text which appears after a highlighted term - - ]]> - - - - field_override - - - The name of the field. - - - - - - - - - &reftitle.returnvalues; - - Returns an instance of SolrQuery. - - - - - - diff --git a/reference/solr/solrquery/sethighlightsimplepre.xml b/reference/solr/solrquery/sethighlightsimplepre.xml deleted file mode 100644 index f64ad1805880..000000000000 --- a/reference/solr/solrquery/sethighlightsimplepre.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - SolrQuery::setHighlightSimplePre - Sets the text which appears before a highlighted term - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlightSimplePre - stringsimplePre - stringfield_override - - - Sets the text which appears before a highlighted term - - ]]> - - - - &reftitle.parameters; - - - - simplePre - - - The text which appears before a highlighted term - - - - - field_override - - - The name of the field. - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/sethighlightsnippets.xml b/reference/solr/solrquery/sethighlightsnippets.xml deleted file mode 100644 index c33169fb2e16..000000000000 --- a/reference/solr/solrquery/sethighlightsnippets.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - SolrQuery::setHighlightSnippets - Sets the maximum number of highlighted snippets to generate per field - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlightSnippets - intvalue - stringfield_override - - - Sets the maximum number of highlighted snippets to generate per field - - - - - - &reftitle.parameters; - - - - value - - - The maximum number of highlighted snippets to generate per field - - - - - field_override - - - The name of the field. - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/sethighlightusephrasehighlighter.xml b/reference/solr/solrquery/sethighlightusephrasehighlighter.xml deleted file mode 100644 index 9cab4840f70d..000000000000 --- a/reference/solr/solrquery/sethighlightusephrasehighlighter.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrQuery::setHighlightUsePhraseHighlighter - Whether to highlight phrase terms only when they appear within the query phrase - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlightUsePhraseHighlighter - boolflag - - - Sets whether or not to use SpanScorer to highlight phrase terms only when they appear within the query phrase in the document - - - - - - &reftitle.parameters; - - - - value - - - Whether or not to use SpanScorer to highlight phrase terms only when they appear within the query phrase in the document - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/setmlt.xml b/reference/solr/solrquery/setmlt.xml deleted file mode 100644 index edb494a89269..000000000000 --- a/reference/solr/solrquery/setmlt.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrQuery::setMlt - Enables or disables moreLikeThis - - - - &reftitle.description; - - public SolrQuerySolrQuery::setMlt - boolflag - - - Enables or disables moreLikeThis - - - - - - &reftitle.parameters; - - - - flag - - - &true; enables it and &false; turns it off. - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/setmltboost.xml b/reference/solr/solrquery/setmltboost.xml deleted file mode 100644 index 5732a51b45ff..000000000000 --- a/reference/solr/solrquery/setmltboost.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrQuery::setMltBoost - Set if the query will be boosted by the interesting term relevance - - - - &reftitle.description; - - public SolrQuerySolrQuery::setMltBoost - boolflag - - - Set if the query will be boosted by the interesting term relevance - - - - - - &reftitle.parameters; - - - - value - - - Sets to &true; or &false; - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/setmltcount.xml b/reference/solr/solrquery/setmltcount.xml deleted file mode 100644 index 6874281d236c..000000000000 --- a/reference/solr/solrquery/setmltcount.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrQuery::setMltCount - Set the number of similar documents to return for each result - - - - &reftitle.description; - - public SolrQuerySolrQuery::setMltCount - intcount - - - Set the number of similar documents to return for each result - - - - - - &reftitle.parameters; - - - - count - - - The number of similar documents to return for each result - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/setmltmaxnumqueryterms.xml b/reference/solr/solrquery/setmltmaxnumqueryterms.xml deleted file mode 100644 index 2ada1de56ff8..000000000000 --- a/reference/solr/solrquery/setmltmaxnumqueryterms.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrQuery::setMltMaxNumQueryTerms - Sets the maximum number of query terms included - - - - &reftitle.description; - - public SolrQuerySolrQuery::setMltMaxNumQueryTerms - intvalue - - - Sets the maximum number of query terms that will be included in any generated query. - - - - - - &reftitle.parameters; - - - - value - - - The maximum number of query terms that will be included in any generated query - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/setmltmaxnumtokens.xml b/reference/solr/solrquery/setmltmaxnumtokens.xml deleted file mode 100644 index 2c5447318c9f..000000000000 --- a/reference/solr/solrquery/setmltmaxnumtokens.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - SolrQuery::setMltMaxNumTokens - Specifies the maximum number of tokens to parse - - - - &reftitle.description; - - public SolrQuerySolrQuery::setMltMaxNumTokens - intvalue - - - Specifies the maximum number of tokens to parse in each example doc field that is not stored with TermVector support. - - - - - &reftitle.parameters; - - - - value - - - The maximum number of tokens to parse - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/setmltmaxwordlength.xml b/reference/solr/solrquery/setmltmaxwordlength.xml deleted file mode 100644 index bfcfba0e8ae9..000000000000 --- a/reference/solr/solrquery/setmltmaxwordlength.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrQuery::setMltMaxWordLength - Sets the maximum word length - - - - &reftitle.description; - - public SolrQuerySolrQuery::setMltMaxWordLength - intmaxWordLength - - - Sets the maximum word length above which words will be ignored. - - - - - - &reftitle.parameters; - - - - maxWordLength - - - The maximum word length above which words will be ignored - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/setmltmindocfrequency.xml b/reference/solr/solrquery/setmltmindocfrequency.xml deleted file mode 100644 index 5dd94dd5f33f..000000000000 --- a/reference/solr/solrquery/setmltmindocfrequency.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrQuery::setMltMinDocFrequency - Sets the mltMinDoc frequency - - - - &reftitle.description; - - public SolrQuerySolrQuery::setMltMinDocFrequency - intminDocFrequency - - - The frequency at which words will be ignored which do not occur in at least this many docs. - - - - - - &reftitle.parameters; - - - - minDocFrequency - - - Sets the frequency at which words will be ignored which do not occur in at least this many docs. - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/setmltmintermfrequency.xml b/reference/solr/solrquery/setmltmintermfrequency.xml deleted file mode 100644 index 7afba4a8a2da..000000000000 --- a/reference/solr/solrquery/setmltmintermfrequency.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrQuery::setMltMinTermFrequency - Sets the frequency below which terms will be ignored in the source docs - - - - &reftitle.description; - - public SolrQuerySolrQuery::setMltMinTermFrequency - intminTermFrequency - - - Sets the frequency below which terms will be ignored in the source docs - - - - - - &reftitle.parameters; - - - - minTermFrequency - - - The frequency below which terms will be ignored in the source docs - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/setmltminwordlength.xml b/reference/solr/solrquery/setmltminwordlength.xml deleted file mode 100644 index 04892cece88a..000000000000 --- a/reference/solr/solrquery/setmltminwordlength.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrQuery::setMltMinWordLength - Sets the minimum word length - - - - &reftitle.description; - - public SolrQuerySolrQuery::setMltMinWordLength - intminWordLength - - - Sets the minimum word length below which words will be ignored. - - - - - - &reftitle.parameters; - - - - minWordLength - - - The minimum word length below which words will be ignored - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/setomitheader.xml b/reference/solr/solrquery/setomitheader.xml deleted file mode 100644 index 5c8e2bb65f9c..000000000000 --- a/reference/solr/solrquery/setomitheader.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrQuery::setOmitHeader - Exclude the header from the returned results - - - - &reftitle.description; - - public SolrQuerySolrQuery::setOmitHeader - boolflag - - - Exclude the header from the returned results. - - - - - - &reftitle.parameters; - - - - flag - - - &true; excludes the header from the result. - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/setquery.xml b/reference/solr/solrquery/setquery.xml deleted file mode 100644 index 4ee583833e0e..000000000000 --- a/reference/solr/solrquery/setquery.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrQuery::setQuery - Sets the search query - - - - &reftitle.description; - - public SolrQuerySolrQuery::setQuery - stringquery - - - Sets the search query. - - - - - - &reftitle.parameters; - - - - query - - - The search query - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object - - - - - - diff --git a/reference/solr/solrquery/setrows.xml b/reference/solr/solrquery/setrows.xml deleted file mode 100644 index 9298ce7e35bd..000000000000 --- a/reference/solr/solrquery/setrows.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrQuery::setRows - Specifies the maximum number of rows to return in the result - - - - &reftitle.description; - - public SolrQuerySolrQuery::setRows - introws - - - Specifies the maximum number of rows to return in the result - - - - - - &reftitle.parameters; - - - - rows - - - The maximum number of rows to return - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object. - - - - - - diff --git a/reference/solr/solrquery/setshowdebuginfo.xml b/reference/solr/solrquery/setshowdebuginfo.xml deleted file mode 100644 index c45ef9a9c3e8..000000000000 --- a/reference/solr/solrquery/setshowdebuginfo.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrQuery::setShowDebugInfo - Flag to show debug information - - - - &reftitle.description; - - public SolrQuerySolrQuery::setShowDebugInfo - boolflag - - - Whether to show debug info - - - - - - &reftitle.parameters; - - - - flag - - - Whether to show debug info. &true; or &false; - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/setstart.xml b/reference/solr/solrquery/setstart.xml deleted file mode 100644 index 96ebdbd13b1e..000000000000 --- a/reference/solr/solrquery/setstart.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrQuery::setStart - Specifies the number of rows to skip - - - - &reftitle.description; - - public SolrQuerySolrQuery::setStart - intstart - - - Specifies the number of rows to skip. Useful in pagination of results. - - - - - - &reftitle.parameters; - - - - start - - - The number of rows to skip. - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object. - - - - - - diff --git a/reference/solr/solrquery/setstats.xml b/reference/solr/solrquery/setstats.xml deleted file mode 100644 index d096ac0af5af..000000000000 --- a/reference/solr/solrquery/setstats.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrQuery::setStats - Enables or disables the Stats component - - - - &reftitle.description; - - public SolrQuerySolrQuery::setStats - boolflag - - - Enables or disables the Stats component. - - - - - - &reftitle.parameters; - - - - flag - - - &true; turns on the stats component and &false; disables it. - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/setterms.xml b/reference/solr/solrquery/setterms.xml deleted file mode 100644 index 3a07b5567ab4..000000000000 --- a/reference/solr/solrquery/setterms.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrQuery::setTerms - Enables or disables the TermsComponent - - - - &reftitle.description; - - public SolrQuerySolrQuery::setTerms - boolflag - - - Enables or disables the TermsComponent - - - - - - &reftitle.parameters; - - - - flag - - - &true; enables it. &false; turns it off - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/settermsfield.xml b/reference/solr/solrquery/settermsfield.xml deleted file mode 100644 index 148970eda8c9..000000000000 --- a/reference/solr/solrquery/settermsfield.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - SolrQuery::setTermsField - Sets the name of the field to get the Terms from - - - - &reftitle.description; - - public SolrQuerySolrQuery::setTermsField - stringfieldname - - - Sets the name of the field to get the terms from - - - - - &reftitle.parameters; - - - - fieldname - - - The field name - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/settermsincludelowerbound.xml b/reference/solr/solrquery/settermsincludelowerbound.xml deleted file mode 100644 index 023d982e384f..000000000000 --- a/reference/solr/solrquery/settermsincludelowerbound.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrQuery::setTermsIncludeLowerBound - Include the lower bound term in the result set - - - - &reftitle.description; - - public SolrQuerySolrQuery::setTermsIncludeLowerBound - boolflag - - - Include the lower bound term in the result set. - - - - - - &reftitle.parameters; - - - - flag - - - Include the lower bound term in the result set - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/settermsincludeupperbound.xml b/reference/solr/solrquery/settermsincludeupperbound.xml deleted file mode 100644 index d5068b701996..000000000000 --- a/reference/solr/solrquery/settermsincludeupperbound.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrQuery::setTermsIncludeUpperBound - Include the upper bound term in the result set - - - - &reftitle.description; - - public SolrQuerySolrQuery::setTermsIncludeUpperBound - boolflag - - - Include the upper bound term in the result set. - - - - - - &reftitle.parameters; - - - - flag - - - &true; or &false; - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/settermslimit.xml b/reference/solr/solrquery/settermslimit.xml deleted file mode 100644 index f946316245e2..000000000000 --- a/reference/solr/solrquery/settermslimit.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrQuery::setTermsLimit - Sets the maximum number of terms to return - - - - &reftitle.description; - - public SolrQuerySolrQuery::setTermsLimit - intlimit - - - Sets the maximum number of terms to return - - - - - - &reftitle.parameters; - - - - limit - - - The maximum number of terms to return. All the terms will be returned if the limit is negative. - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/settermslowerbound.xml b/reference/solr/solrquery/settermslowerbound.xml deleted file mode 100644 index 3b2a571819f2..000000000000 --- a/reference/solr/solrquery/settermslowerbound.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrQuery::setTermsLowerBound - Specifies the Term to start from - - - - &reftitle.description; - - public SolrQuerySolrQuery::setTermsLowerBound - stringlowerBound - - - Specifies the Term to start from - - - - - - &reftitle.parameters; - - - - lowerBound - - - The lower bound Term - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/settermsmaxcount.xml b/reference/solr/solrquery/settermsmaxcount.xml deleted file mode 100644 index 33ffce03ec6b..000000000000 --- a/reference/solr/solrquery/settermsmaxcount.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - SolrQuery::setTermsMaxCount - Sets the maximum document frequency - - - - &reftitle.description; - - public SolrQuerySolrQuery::setTermsMaxCount - intfrequency - - - Sets the maximum document frequency. - - - - - &reftitle.parameters; - - - - frequency - - - The maximum document frequency. - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/settermsmincount.xml b/reference/solr/solrquery/settermsmincount.xml deleted file mode 100644 index 84775b1d2d9c..000000000000 --- a/reference/solr/solrquery/settermsmincount.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrQuery::setTermsMinCount - Sets the minimum document frequency - - - - &reftitle.description; - - public SolrQuerySolrQuery::setTermsMinCount - intfrequency - - - Sets the minimum doc frequency to return in order to be included - - - - - - &reftitle.parameters; - - - - frequency - - - The minimum frequency - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/settermsprefix.xml b/reference/solr/solrquery/settermsprefix.xml deleted file mode 100644 index f846d8dc1fc7..000000000000 --- a/reference/solr/solrquery/settermsprefix.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrQuery::setTermsPrefix - Restrict matches to terms that start with the prefix - - - - &reftitle.description; - - public SolrQuerySolrQuery::setTermsPrefix - stringprefix - - - Restrict matches to terms that start with the prefix - - - - - - &reftitle.parameters; - - - - prefix - - - Restrict matches to terms that start with the prefix - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/settermsreturnraw.xml b/reference/solr/solrquery/settermsreturnraw.xml deleted file mode 100644 index 51b37acb5b58..000000000000 --- a/reference/solr/solrquery/settermsreturnraw.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrQuery::setTermsReturnRaw - Return the raw characters of the indexed term - - - - &reftitle.description; - - public SolrQuerySolrQuery::setTermsReturnRaw - boolflag - - - If true, return the raw characters of the indexed term, regardless of if it is human readable - - - - - - &reftitle.parameters; - - - - value - - - &true; or &false; - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/settermssort.xml b/reference/solr/solrquery/settermssort.xml deleted file mode 100644 index 948ac9d2dc5d..000000000000 --- a/reference/solr/solrquery/settermssort.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrQuery::setTermsSort - Specifies how to sort the returned terms - - - - &reftitle.description; - - public SolrQuerySolrQuery::setTermsSort - intsortType - - - If SolrQuery::TERMS_SORT_COUNT, sorts the terms by the term frequency (highest count first). If SolrQuery::TERMS_SORT_INDEX, returns the terms in index order - - - - - - &reftitle.parameters; - - - - sortType - - - SolrQuery::TERMS_SORT_INDEX or SolrQuery::TERMS_SORT_COUNT - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/settermsupperbound.xml b/reference/solr/solrquery/settermsupperbound.xml deleted file mode 100644 index 660a07b53e85..000000000000 --- a/reference/solr/solrquery/settermsupperbound.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrQuery::setTermsUpperBound - Sets the term to stop at - - - - &reftitle.description; - - public SolrQuerySolrQuery::setTermsUpperBound - stringupperBound - - - Sets the term to stop at - - - - - - &reftitle.parameters; - - - - upperBound - - - The term to stop at - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrquery/settimeallowed.xml b/reference/solr/solrquery/settimeallowed.xml deleted file mode 100644 index 42b43e55c643..000000000000 --- a/reference/solr/solrquery/settimeallowed.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrQuery::setTimeAllowed - The time allowed for search to finish - - - - &reftitle.description; - - public SolrQuerySolrQuery::setTimeAllowed - inttimeAllowed - - - The time allowed for a search to finish. This value only applies to the search and not to requests in general. Time is in milliseconds. Values less than or equal to zero implies no time restriction. Partial results may be returned, if there are any. - - - - - - &reftitle.parameters; - - - - timeAllowed - - - The time allowed for a search to finish. - - - - - - - - - &reftitle.returnvalues; - - Returns the current SolrQuery object, if the return value is used. - - - - - - diff --git a/reference/solr/solrqueryresponse.xml b/reference/solr/solrqueryresponse.xml deleted file mode 100644 index 7a549875be4b..000000000000 --- a/reference/solr/solrqueryresponse.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - The SolrQueryResponse class - SolrQueryResponse - - - - -
    - &reftitle.intro; - - Represents a response to a query request. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrQueryResponse - - - - - final - SolrQueryResponse - - - - extends - SolrResponse - - - - &Constants; - - const - int - SolrQueryResponse::PARSE_SOLR_OBJ - 0 - - - const - int - SolrQueryResponse::PARSE_SOLR_DOC - 1 - - - &InheritedProperties; - - - &Methods; - - - - &InheritedMethods; - - - - - -
    - - - -
    - &reftitle.constants; -
    - SolrQueryResponse Class constants - - - - SolrQueryResponse::PARSE_SOLR_OBJ - - Documents should be parsed as SolrObject instances - - - - - SolrQueryResponse::PARSE_SOLR_DOC - - Documents should be parsed as SolrDocument instances. - - - - -
    -
    - - - -
    - - &reference.solr.entities.solrqueryresponse; - -
    - - diff --git a/reference/solr/solrqueryresponse/construct.xml b/reference/solr/solrqueryresponse/construct.xml deleted file mode 100644 index ff97d7a5d92e..000000000000 --- a/reference/solr/solrqueryresponse/construct.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - SolrQueryResponse::__construct - Constructor - - - - &reftitle.description; - - public SolrQueryResponse::__construct - - - - Constructor - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - None - - - - - - diff --git a/reference/solr/solrqueryresponse/destruct.xml b/reference/solr/solrqueryresponse/destruct.xml deleted file mode 100644 index e0e0509fd03c..000000000000 --- a/reference/solr/solrqueryresponse/destruct.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrQueryResponse::__destruct - Destructor - - - - &reftitle.description; - - public SolrQueryResponse::__destruct - - - - Destructor. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - None - - - - - - diff --git a/reference/solr/solrresponse.xml b/reference/solr/solrresponse.xml deleted file mode 100644 index 6fe3b8acd19f..000000000000 --- a/reference/solr/solrresponse.xml +++ /dev/null @@ -1,231 +0,0 @@ - - - - - - The SolrResponse class - SolrResponse - - - - -
    - &reftitle.intro; - - Represents a response from the Solr server. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrResponse - - - - - abstract - SolrResponse - - - - &Constants; - - const - int - SolrResponse::PARSE_SOLR_OBJ - 0 - - - const - int - SolrResponse::PARSE_SOLR_DOC - 1 - - - &Properties; - - protected - int - http_status - - - protected - int - parser_mode - - - protected - bool - success - - - protected - string - http_status_message - - - protected - string - http_request_url - - - protected - string - http_raw_request_headers - - - protected - string - http_raw_request - - - protected - string - http_raw_response_headers - - - protected - string - http_raw_response - - - protected - string - http_digested_response - - - - &Methods; - - - - -
    - - - -
    - &reftitle.properties; - - - http_status - - The http status of the response. - - - - parser_mode - - Whether to parse the solr documents as SolrObject or SolrDocument instances. - - - - success - - Was there an error during the request - - - - http_status_message - - Detailed message on http status - - - - http_request_url - - The request URL - - - - http_raw_request_headers - - A string of raw headers sent during the request. - - - - http_raw_request - - The raw request sent to the server - - - - http_raw_response_headers - - Response headers from the Solr server. - - - - http_raw_response - - The response message from the server. - - - - http_digested_response - - The response in PHP serialized format. - - - -
    - - - - -
    - &reftitle.constants; -
    - SolrResponse Class Constants - - - - SolrResponse::PARSE_SOLR_OBJ - - Documents should be parsed as SolrObject instances - - - - - SolrResponse::PARSE_SOLR_DOC - - Documents should be parsed as SolrDocument instances. - - - - -
    -
    - - - -
    - - &reference.solr.entities.solrresponse; - -
    - - diff --git a/reference/solr/solrresponse/getdigestedresponse.xml b/reference/solr/solrresponse/getdigestedresponse.xml deleted file mode 100644 index 841b3ea60ca6..000000000000 --- a/reference/solr/solrresponse/getdigestedresponse.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - SolrResponse::getDigestedResponse - Returns the XML response as serialized PHP data - - - - &reftitle.description; - - public stringSolrResponse::getDigestedResponse - - - - Returns the XML response as serialized PHP data - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the XML response as serialized PHP data - - - - - - diff --git a/reference/solr/solrresponse/gethttpstatus.xml b/reference/solr/solrresponse/gethttpstatus.xml deleted file mode 100644 index beb79495e98c..000000000000 --- a/reference/solr/solrresponse/gethttpstatus.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrResponse::getHttpStatus - Returns the HTTP status of the response - - - - &reftitle.description; - - public intSolrResponse::getHttpStatus - - - - Returns the HTTP status of the response. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the HTTP status of the response. - - - - - - diff --git a/reference/solr/solrresponse/gethttpstatusmessage.xml b/reference/solr/solrresponse/gethttpstatusmessage.xml deleted file mode 100644 index 0df1f0c36939..000000000000 --- a/reference/solr/solrresponse/gethttpstatusmessage.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrResponse::getHttpStatusMessage - Returns more details on the HTTP status - - - - &reftitle.description; - - public stringSolrResponse::getHttpStatusMessage - - - - Returns more details on the HTTP status. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns more details on the HTTP status - - - - - - diff --git a/reference/solr/solrresponse/getrawrequest.xml b/reference/solr/solrresponse/getrawrequest.xml deleted file mode 100644 index 81d46b240ecc..000000000000 --- a/reference/solr/solrresponse/getrawrequest.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrResponse::getRawRequest - Returns the raw request sent to the Solr server - - - - &reftitle.description; - - public stringSolrResponse::getRawRequest - - - - Returns the raw request sent to the Solr server. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the raw request sent to the Solr server - - - - - - diff --git a/reference/solr/solrresponse/getrawrequestheaders.xml b/reference/solr/solrresponse/getrawrequestheaders.xml deleted file mode 100644 index 68c820d04ff2..000000000000 --- a/reference/solr/solrresponse/getrawrequestheaders.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrResponse::getRawRequestHeaders - Returns the raw request headers sent to the Solr server - - - - &reftitle.description; - - public stringSolrResponse::getRawRequestHeaders - - - - Returns the raw request headers sent to the Solr server. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the raw request headers sent to the Solr server - - - - - - diff --git a/reference/solr/solrresponse/getrawresponse.xml b/reference/solr/solrresponse/getrawresponse.xml deleted file mode 100644 index 9ab10de29dd7..000000000000 --- a/reference/solr/solrresponse/getrawresponse.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrResponse::getRawResponse - Returns the raw response from the server - - - - &reftitle.description; - - public stringSolrResponse::getRawResponse - - - - Returns the raw response from the server. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the raw response from the server. - - - - - - diff --git a/reference/solr/solrresponse/getrawresponseheaders.xml b/reference/solr/solrresponse/getrawresponseheaders.xml deleted file mode 100644 index 59a59d11a8a6..000000000000 --- a/reference/solr/solrresponse/getrawresponseheaders.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrResponse::getRawResponseHeaders - Returns the raw response headers from the server - - - - &reftitle.description; - - public stringSolrResponse::getRawResponseHeaders - - - - Returns the raw response headers from the server. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the raw response headers from the server. - - - - - - diff --git a/reference/solr/solrresponse/getrequesturl.xml b/reference/solr/solrresponse/getrequesturl.xml deleted file mode 100644 index 7d4973697fd9..000000000000 --- a/reference/solr/solrresponse/getrequesturl.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - SolrResponse::getRequestUrl - Returns the full URL the request was sent to - - - - &reftitle.description; - - public stringSolrResponse::getRequestUrl - - - - Returns the full URL the request was sent to. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the full URL the request was sent to - - - - - - diff --git a/reference/solr/solrresponse/getresponse.xml b/reference/solr/solrresponse/getresponse.xml deleted file mode 100644 index d5b634d98b5e..000000000000 --- a/reference/solr/solrresponse/getresponse.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - SolrResponse::getResponse - Returns a SolrObject representing the XML response from the server - - - - &reftitle.description; - - public SolrObjectSolrResponse::getResponse - - - - Returns a SolrObject representing the XML response from the server. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a SolrObject representing the XML response from the server - - - - - - diff --git a/reference/solr/solrresponse/setparsemode.xml b/reference/solr/solrresponse/setparsemode.xml deleted file mode 100644 index 7f512a768a23..000000000000 --- a/reference/solr/solrresponse/setparsemode.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrResponse::setParseMode - Sets the parse mode - - - - &reftitle.description; - - public boolSolrResponse::setParseMode - intparser_mode0 - - - Sets the parse mode. - - - - - - &reftitle.parameters; - - - - parser_mode - - - SolrResponse::PARSE_SOLR_DOC parses documents in SolrDocument instances. SolrResponse::PARSE_SOLR_OBJ parses document into SolrObjects. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrresponse/success.xml b/reference/solr/solrresponse/success.xml deleted file mode 100644 index 729d71e327d2..000000000000 --- a/reference/solr/solrresponse/success.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrResponse::success - Was the request a success - - - - &reftitle.description; - - public boolSolrResponse::success - - - - Used to check if the request to the server was successful. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; if it was successful and &false; if it was not. - - - - - - diff --git a/reference/solr/solrserverexception.xml b/reference/solr/solrserverexception.xml deleted file mode 100644 index d587393e9da6..000000000000 --- a/reference/solr/solrserverexception.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - The SolrServerException class - SolrServerException - - - - -
    - &reftitle.intro; - - An exception thrown when there is an error produced by the Solr Server itself. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrServerException - - - - - SolrServerException - - - - extends - SolrException - - - - - &InheritedProperties; - - - - &Methods; - - - &InheritedMethods; - - - - - - -
    - - -
    - - &reference.solr.entities.solrserverexception; - -
    - - diff --git a/reference/solr/solrserverexception/getinternalinfo.xml b/reference/solr/solrserverexception/getinternalinfo.xml deleted file mode 100644 index e6e4130da72e..000000000000 --- a/reference/solr/solrserverexception/getinternalinfo.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrServerException::getInternalInfo - Returns internal information where the Exception was thrown - - - - &reftitle.description; - - public arraySolrServerException::getInternalInfo - - - - Returns internal information where the Exception was thrown. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an array containing internal information where the error was thrown. Used only for debugging by extension developers. - - - - - - diff --git a/reference/solr/solrupdateresponse.xml b/reference/solr/solrupdateresponse.xml deleted file mode 100644 index 5611caa995af..000000000000 --- a/reference/solr/solrupdateresponse.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - The SolrUpdateResponse class - SolrUpdateResponse - - - - -
    - &reftitle.intro; - - Represents a response to an update request. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrUpdateResponse - - - - - final - SolrUpdateResponse - - - - extends - SolrResponse - - - - &Constants; - - const - int - SolrUpdateResponse::PARSE_SOLR_OBJ - 0 - - - const - int - SolrUpdateResponse::PARSE_SOLR_DOC - 1 - - - &InheritedProperties; - - - &Methods; - - - - &InheritedMethods; - - - - - -
    - - - -
    - &reftitle.constants; -
    - SolrUpdateResponse Class Constants - - - - SolrUpdateResponse::PARSE_SOLR_OBJ - - Documents should be parsed as SolrObject instances - - - - - SolrUpdateResponse::PARSE_SOLR_DOC - - Documents should be parsed as SolrDocument instances. - - - - -
    -
    - - - -
    - - &reference.solr.entities.solrupdateresponse; - -
    - - diff --git a/reference/solr/solrupdateresponse/construct.xml b/reference/solr/solrupdateresponse/construct.xml deleted file mode 100644 index 9a148cad3637..000000000000 --- a/reference/solr/solrupdateresponse/construct.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrUpdateResponse::__construct - Constructor - - - - &reftitle.description; - - public SolrUpdateResponse::__construct - - - - Constructor - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - None - - - - - - diff --git a/reference/solr/solrupdateresponse/destruct.xml b/reference/solr/solrupdateresponse/destruct.xml deleted file mode 100644 index a0bf1ce4a223..000000000000 --- a/reference/solr/solrupdateresponse/destruct.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - SolrUpdateResponse::__destruct - Destructor - - - - &reftitle.description; - - public SolrUpdateResponse::__destruct - - - - Destructor - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - None - - - - - - diff --git a/reference/solr/solrutils.xml b/reference/solr/solrutils.xml deleted file mode 100644 index 7e08be2de500..000000000000 --- a/reference/solr/solrutils.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - The SolrUtils class - SolrUtils - - - - -
    - &reftitle.intro; - - Contains utility methods for retrieving the current extension version and preparing query phrases. - - Also contains method for escaping query strings and parsing XML responses. -
    - - -
    - &reftitle.classsynopsis; - - - - SolrUtils - - - - - abstract - SolrUtils - - - - - &Methods; - - - - -
    - -
    - - &reference.solr.entities.solrutils; - -
    - - diff --git a/reference/solr/solrutils/digestxmlresponse.xml b/reference/solr/solrutils/digestxmlresponse.xml deleted file mode 100644 index 3c0e797d8959..000000000000 --- a/reference/solr/solrutils/digestxmlresponse.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - SolrUtils::digestXmlResponse - Parses an response XML string into a SolrObject - - - - &reftitle.description; - - public static SolrObjectSolrUtils::digestXmlResponse - stringxmlresponse - intparse_mode0 - - - This method parses an response XML string from the Apache Solr server into a SolrObject. It throws a SolrException if there was an error. - - - - - - &reftitle.parameters; - - - - xmlresponse - - - The XML response string from the Solr server. - - - - - parse_mode - - - Use SolrResponse::PARSE_SOLR_OBJ or SolrResponse::PARSE_SOLR_DOC - - - - - - - - - &reftitle.returnvalues; - - Returns the SolrObject representing the XML response. - - - If the parse_mode parameter is set to SolrResponse::PARSE_SOLR_OBJ Solr documents will be parses as SolrObject instances. - - If it is set to SolrResponse::PARSE_SOLR_DOC, they will be parsed as SolrDocument instances. - - - - - - diff --git a/reference/solr/solrutils/escapequerychars.xml b/reference/solr/solrutils/escapequerychars.xml deleted file mode 100644 index 854c93ad6b12..000000000000 --- a/reference/solr/solrutils/escapequerychars.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - SolrUtils::escapeQueryChars - Escapes a lucene query string - - - - &reftitle.description; - - public static stringfalseSolrUtils::escapeQueryChars - stringstr - - - Lucene supports escaping special characters that are part of the query syntax. - - - The current list special characters are: - - - These characters are part of the query syntax and must be escaped - - - - - &reftitle.parameters; - - - - str - - - This is the query string to be escaped. - - - - - - - - - &reftitle.returnvalues; - - Returns the escaped string&return.falseforfailure;. - - - - - - diff --git a/reference/solr/solrutils/getsolrversion.xml b/reference/solr/solrutils/getsolrversion.xml deleted file mode 100644 index 56295f2a168d..000000000000 --- a/reference/solr/solrutils/getsolrversion.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrUtils::getSolrVersion - Returns the current version of the Solr extension - - - - &reftitle.description; - - public static stringSolrUtils::getSolrVersion - - - - Returns the current Solr version. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The current version of the Apache Solr extension. - - - - - - diff --git a/reference/solr/solrutils/queryphrase.xml b/reference/solr/solrutils/queryphrase.xml deleted file mode 100644 index ae8715e1a9e2..000000000000 --- a/reference/solr/solrutils/queryphrase.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrUtils::queryPhrase - Prepares a phrase from an unescaped lucene string - - - - &reftitle.description; - - public static stringSolrUtils::queryPhrase - stringstr - - - Prepares a phrase from an unescaped lucene string. - - - - - - &reftitle.parameters; - - - - str - - - The lucene phrase. - - - - - - - - - &reftitle.returnvalues; - - Returns the phrase contained in double quotes. - - - - - - diff --git a/reference/solr/versions.xml b/reference/solr/versions.xml deleted file mode 100644 index fa704b31ae76..000000000000 --- a/reference/solr/versions.xml +++ /dev/null @@ -1,528 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/sqlsrv/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/sqlsrv/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/sqlsrv/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/sqlsrv/book.xml b/reference/sqlsrv/book.xml deleted file mode 100644 index e21045332212..000000000000 --- a/reference/sqlsrv/book.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - Microsoft SQL Server Driver for PHP - SQLSRV - - - - &reftitle.intro; - - The SQLSRV extension allows you to access Microsoft SQL Server and SQL Azure - databases. The 3.0 release of the driver supports - SQL Server, beginning with SQL Server 2005, including SQL Server 2012 and SQL - Server 2012 LocalDB. (For more information about LocalDB, see - PHP Driver for SQL Server Support for LocalDB - and SQL Server 2012 Express LocalDB.) - - - The SQLSRV extension is supported by Microsoft and available for download here: - &url.sqlsrv;. SQL Server 2012 LocalDB can be - downloaded here: &url.sqlsrv.localdbdownload;. - - - - - &reference.sqlsrv.setup; - &reference.sqlsrv.constants; - &reference.sqlsrv.reference; - - - diff --git a/reference/sqlsrv/configure.xml b/reference/sqlsrv/configure.xml deleted file mode 100644 index 3b2910e485a6..000000000000 --- a/reference/sqlsrv/configure.xml +++ /dev/null @@ -1,41 +0,0 @@ - - -
    - &reftitle.install; - - The SQLSRV extension is enabled by adding appropriate DLL file to your PHP - extension directory and the corresponding entry to the &php.ini; file. The SQLSRV - download comes with 8 driver files, four of which are for PDO support. - - - The most recent version of the driver is available for download here: - SQLSRV download. - - - For more information about SQLSRV requirements, see - SQLSRV System Requirements. - - - Since version 4.0 the SQLSRV extension is compatible only with PHP 7.0 running on Linux or Windows. - -
    - diff --git a/reference/sqlsrv/constants.xml b/reference/sqlsrv/constants.xml deleted file mode 100644 index 3587788af8ee..000000000000 --- a/reference/sqlsrv/constants.xml +++ /dev/null @@ -1,979 +0,0 @@ - - - - &reftitle.constants; - &extension.constants; - - - - SQLSRV_FETCH_ASSOC - (int) - - - - Forces sqlsrv_fetch_array to return an associative - array when passed as a parameter. - - - - - - SQLSRV_FETCH_NUMERIC - (int) - - - - Forces sqlsrv_fetch_array to return an array with - numeric when passed as a parameter. - - - - - - SQLSRV_FETCH_BOTH - (int) - - - - Forces sqlsrv_fetch_array to return an array with both - associative and numeric keys when passed as a parameter (the default behavior). - - - - - - SQLSRV_ERR_ALL - (int) - - - - Forces sqlsrv_errors to return both errors and warnings - when passed as a parameter (the default behavior). - - - - - - SQLSRV_ERR_ERRORS - (int) - - - - Forces sqlsrv_errors to return errors only (no warnings) - when passed as a parameter. - - - - - - SQLSRV_ERR_WARNINGS - (int) - - - - Forces sqlsrv_errors to return warnings only (no errors) - when passed as a parameter. - - - - - - SQLSRV_LOG_SYSTEM_ALL - (int) - - - - Turns on logging of all subsystems when passed to - sqlsrv_configure as a parameter. - - - - - - SQLSRV_LOG_SYSTEM_CONN - (int) - - - - Turns on logging of connection activity when passed to - sqlsrv_configure as a parameter. - - - - - - SQLSRV_LOG_SYSTEM_INIT - (int) - - - - Turns on logging of initialization activity when passed to - sqlsrv_configure as a parameter. - - - - - - SQLSRV_LOG_SYSTEM_OFF - (int) - - - - Turns off logging of all subsystems when passed to - sqlsrv_configure as a parameter. - - - - - - SQLSRV_LOG_SYSTEM_STMT - (int) - - - - Turns on logging of statement activity when passed to - sqlsrv_configure as a parameter. - - - - - - SQLSRV_LOG_SYSTEM_UTIL - (int) - - - - Turns on logging of error function activity when passed to - sqlsrv_configure as a parameter. - - - - - - SQLSRV_LOG_SEVERITY_ALL - (int) - - - - Specifies that errors, warnings, and notices will be logged - when passed to sqlsrv_configure as a parameter. - - - - - - SQLSRV_LOG_SEVERITY_ERROR - (int) - - - - Specifies that errors will be logged when passed to - sqlsrv_configure as a parameter. - - - - - - SQLSRV_LOG_SEVERITY_NOTICE - (int) - - - - Specifies that notices will be logged when passed to - sqlsrv_configure as a parameter. - - - - - - SQLSRV_LOG_SEVERITY_WARNING - (int) - - - - Specifies that warnings will be logged when passed to - sqlsrv_configure as a parameter. - - - - - - SQLSRV_NULLABLE_YES - (int) - - - - Indicates that a column is nullable. - - - - - - SQLSRV_NULLABLE_NO - (int) - - - - Indicates that a column is not nullable. - - - - - - SQLSRV_NULLABLE_UNKNOWN - (int) - - - - Indicates that it is not known if a column is nullable. - - - - - - SQLSRV_PARAM_IN - (int) - - - - Indicates an input parameter when passed to sqlsrv_query - or sqlsrv_prepare. - - - - - - SQLSRV_PARAM_INOUT - (int) - - - - Indicates a bidirectional parameter when passed to sqlsrv_query - or sqlsrv_prepare. - - - - - - SQLSRV_PARAM_OUT - (int) - - - - Indicates an output parameter when passed to sqlsrv_query or - sqlsrv_prepare. - - - - - - SQLSRV_PHPTYPE_INT - (int) - - - - Specifies an integer PHP data type. For usage information, see - How to: Specify PHP Types. - - - - - - SQLSRV_PHPTYPE_DATETIME - (int) - - - - Specifies a datetime PHP data type. For usage information, see - How to: Specify PHP Types. - - - - - - SQLSRV_PHPTYPE_FLOAT - (int) - - - - Specifies a float PHP data type. For usage information, see - How to: Specify PHP Types. - - - - - - SQLSRV_PHPTYPE_STREAM - (int) - - - - Specifies a PHP stream. This constant works like a function and accepts an - encoding constant. See the SQLSRV_ENC_* constants. For usage information, see - How to: Specify PHP Types. - - - - - - SQLSRV_PHPTYPE_STRING - (int) - - - - Specifies a string PHP data type. This constant works like a function and - accepts an encoding constant. See the SQLSRV_ENC_* constants. For usage information, - see How to: Specify PHP Types. - - - - - - SQLSRV_ENC_BINARY - (int) - - - - Specifies that data is returned as a raw byte stream from the server without - performing encoding or translation. For usage information, see - How to: Specify PHP Types. - - - - - - SQLSRV_ENC_CHAR - (int) - - - - Data is returned in 8-bit characters as specified in the code page of the - Windows locale that is set on the system. Any multi-byte characters or characters - that do not map into this code page are substituted with a single byte question - mark (?) character. This is the default encoding. For usage information, - see How to: Specify PHP Types. - - - - - - SQLSRV_SQLTYPE_BIGINT - (int) - - - - Describes the bigint SQL Server data type. For usage information, see - How to: Specify SQL Types. - - - - - - SQLSRV_SQLTYPE_BINARY - (int) - - - - Describes the binary SQL Server data type. For usage information, see - How to: Specify SQL Types. - - - - - - SQLSRV_SQLTYPE_BIT - (int) - - - - Describes the bit SQL Server data type. For usage information, see - How to: Specify SQL Types. - - - - - - SQLSRV_SQLTYPE_CHAR - (int) - - - - Describes the char SQL Server data type. This constant works like a function - and accepts a parameter indicating the number characters. For usage information, - see How to: Specify SQL Types. - - - - - - SQLSRV_SQLTYPE_DATE - (int) - - - - Describes the date SQL Server data type. For usage information, see - How to: Specify SQL Types. - - - - - - SQLSRV_SQLTYPE_DATETIME - (int) - - - - Describes the datetime SQL Server data type. For usage information, see - How to: Specify SQL Types. - - - - - - SQLSRV_SQLTYPE_DATETIME2 - (int) - - - - Describes the datetime2 SQL Server data type. For usage information, see - How to: Specify SQL Types. - - - - - - SQLSRV_SQLTYPE_DATETIMEOFFSET - (int) - - - - Describes the datetimeoffset SQL Server data type. For usage information, see - How to: Specify SQL Types. - - - - - - SQLSRV_SQLTYPE_DECIMAL - (int) - - - - Describes the decimal SQL Server data type. This constant works like a function - and accepts two parameters indicating (in order) precision and scale. For usage information, - see How to: Specify SQL Types. - - - - - - SQLSRV_SQLTYPE_FLOAT - (int) - - - - Describes the float SQL Server data type. For usage information, see - How to: Specify SQL Types. - - - - - - SQLSRV_SQLTYPE_IMAGE - (int) - - - - Describes the image SQL Server data type. For usage information, see - How to: Specify SQL Types. - - - - - - SQLSRV_SQLTYPE_INT - (int) - - - - Describes the int SQL Server data type. For usage information, see - How to: Specify SQL Types. - - - - - - SQLSRV_SQLTYPE_MONEY - (int) - - - - Describes the money SQL Server data type. For usage information, see - How to: Specify SQL Types. - - - - - - SQLSRV_SQLTYPE_NCHAR - (int) - - - - Describes the nchar SQL Server data type. This constant works like a function - and accepts a single parameter indicating the character count. For usage information, - see How to: Specify SQL Types. - - - - - - SQLSRV_SQLTYPE_NUMERIC - (int) - - - - Describes the numeric SQL Server data type. This constant works like a function - and accepts two parameter indicating (in order) precision and scale. For usage - information, see How to: Specify SQL Types. - - - - - - SQLSRV_SQLTYPE_NVARCHAR - (int) - - - - Describes the nvarchar SQL Server data type. This constant works like a function - and accepts a single parameter indicating the character count. For usage - information, see How to: Specify SQL Types. - - - - - - SQLSRV_SQLTYPE_NVARCHAR('max') - (int) - - - - Describes the nvarchar(MAX) SQL Server data type. For usage information, - see How to: Specify SQL Types. - - - - - - SQLSRV_SQLTYPE_NTEXT - (int) - - - - Describes the ntext SQL Server data type. For usage information, see - How to: Specify SQL Types. - - - - - - SQLSRV_SQLTYPE_REAL - (int) - - - - Describes the real SQL Server data type. For usage information, see - How to: Specify SQL Types. - - - - - - SQLSRV_SQLTYPE_SMALLDATETIME - (int) - - - - Describes the smalldatetime SQL Server data type. For usage information, see - How to: Specify SQL Types. - - - - - - SQLSRV_SQLTYPE_SMALLINT - (int) - - - - Describes the smallint SQL Server data type. For usage information, see - How to: Specify SQL Types. - - - - - - SQLSRV_SQLTYPE_SMALLMONEY - (int) - - - - Describes the smallmoney SQL Server data type. For usage information, see - How to: Specify SQL Types. - - - - - - SQLSRV_SQLTYPE_TEXT - (int) - - - - Describes the text SQL Server data type. For usage information, see - How to: Specify SQL Types. - - - - - - SQLSRV_SQLTYPE_TIME - (int) - - - - Describes the time SQL Server data type. For usage information, see - How to: Specify SQL Types. - - - - - - SQLSRV_SQLTYPE_TIMESTAMP - (int) - - - - Describes the timestamp SQL Server data type. For usage information, see - How to: Specify SQL Types. - - - - - - SQLSRV_SQLTYPE_TINYINT - (int) - - - - Describes the tinyint SQL Server data type. For usage information, see - How to: Specify SQL Types. - - - - - - SQLSRV_SQLTYPE_UNIQUEIDENTIFIER - (int) - - - - Describes the uniqueidentifier SQL Server data type. For usage information, see - How to: Specify SQL Types. - - - - - - SQLSRV_SQLTYPE_UDT - (int) - - - - Describes the UDT SQL Server data type. For usage information, see - How to: Specify SQL Types. - - - - - - SQLSRV_SQLTYPE_VARBINARY - (int) - - - - Describes the varbinary SQL Server data type. This constant works like a function - and accepts a single parameter indicating the byte count. For usage information, - see How to: Specify SQL Types. - - - - - - SQLSRV_SQLTYPE_VARBINARY('max') - (int) - - - - Describes the varbinary(MAX) SQL Server data type. For usage information, see - How to: Specify SQL Types. - - - - - - SQLSRV_SQLTYPE_VARCHAR - (int) - - - - Describes the varchar SQL Server data type. This constant works like a function - and accepts a single parameter indicating the character count. For usage information, - see How to: Specify SQL Types. - - - - - - SQLSRV_SQLTYPE_VARCHAR('max') - (int) - - - - Describes the varchar(MAX) SQL Server data type. For usage information, see - How to: Specify SQL Types. - - - - - - SQLSRV_SQLTYPE_XML - (int) - - - - Describes the XML SQL Server data type. For usage information, see - How to: Specify SQL Types. - - - - - - SQLSRV_TXN_READ_UNCOMMITTED - (int) - - - - Indicates a transaction isolation level of READ UNCOMMITTED. This value is - used to set the TransactionIsolation level in the $connectionOptions array - passed to sqlsrv_connect. - - - - - - SQLSRV_TXN_READ_COMMITTED - (int) - - - - Indicates a transaction isolation level of READ COMMITTED. This value is - used to set the TransactionIsolation level in the $connectionOptions array - passed to sqlsrv_connect. - - - - - - SQLSRV_TXN_REPEATABLE_READ - (int) - - - - Indicates a transaction isolation level of REPEATABLE READ. This value is - used to set the TransactionIsolation level in the $connectionOptions array - passed to sqlsrv_connect. - - - - - - SQLSRV_TXN_SNAPSHOT - (int) - - - - Indicates a transaction isolation level of SNAPSHOT. This value is used to - set the TransactionIsolation level in the $connectionOptions array passed - to sqlsrv_connect. - - - - - - SQLSRV_TXN_READ_SERIALIZABLE - (int) - - - - Indicates a transaction isolation level of SERIALIZABLE. This value is used - to set the TransactionIsolation level in the $connectionOptions array passed - to sqlsrv_connect. - - - - - - SQLSRV_CURSOR_FORWARD - (int) - - - - Indicates a forward-only cursor. For usage information, see - Specifying a Cursor Type and Selecting Rows. - - - - - - SQLSRV_CURSOR_STATIC - (int) - - - - Indicates a static cursor. For usage information, see - Specifying a Cursor Type and Selecting Rows. - - - - - - SQLSRV_CURSOR_DYNAMIC - (int) - - - - Indicates a dynamic cursor. For usage information, see - Specifying a Cursor Type and Selecting Rows. - - - - - - SQLSRV_CURSOR_KEYSET - (int) - - - - Indicates a keyset cursor. For usage information, see - Specifying a Cursor Type and Selecting Rows. - - - - - - SQLSRV_CURSOR_BUFFERED - (int) - - - - Creates a client-side cursor query. Lets you access rows in any order. For usage information, see - Specifying a Cursor Type and Selecting Rows. - - - - - - SQLSRV_SCROLL_NEXT - (int) - - - - Specifies which row to select in a result set. For usage information, see - Specifying a Cursor Type and Selecting Rows. - - - - - - SQLSRV_SCROLL_PRIOR - (int) - - - - Specifies which row to select in a result set. For usage information, see - Specifying a Cursor Type and Selecting Rows. - - - - - - SQLSRV_SCROLL_FIRST - (int) - - - - Specifies which row to select in a result set. For usage information, see - Specifying a Cursor Type and Selecting Rows. - - - - - - SQLSRV_SCROLL_LAST - (int) - - - - Specifies which row to select in a result set. For usage information, see - Specifying a Cursor Type and Selecting Rows. - - - - - - SQLSRV_SCROLL_ABSOLUTE - (int) - - - - Specifies which row to select in a result set. For usage information, see - Specifying a Cursor Type and Selecting Rows. - - - - - - SQLSRV_SCROLL_RELATIVE - (int) - - - - Specifies which row to select in a result set. For usage information, see - Specifying a Cursor Type and Selecting Rows. - - - - - - diff --git a/reference/sqlsrv/functions/sqlsrv-begin-transaction.xml b/reference/sqlsrv/functions/sqlsrv-begin-transaction.xml deleted file mode 100644 index 93a458acca9a..000000000000 --- a/reference/sqlsrv/functions/sqlsrv-begin-transaction.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - sqlsrv_begin_transaction - Begins a database transaction - - - &reftitle.description; - - boolsqlsrv_begin_transaction - resourceconn - - - The transaction begun by sqlsrv_begin_transaction includes - all statements that were executed after the call to - sqlsrv_begin_transaction and before calls to - sqlsrv_rollback or sqlsrv_commit. - Explicit transactions should be started and committed or rolled back using - these functions instead of executing SQL statements that begin and commit/roll - back transactions. For more information, see - SQLSRV Transactions. - - - - &reftitle.parameters; - - - conn - - - The connection resource returned by a call to sqlsrv_connect. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>sqlsrv_begin_transaction</function> example - - The following example demonstrates how to use - sqlsrv_begin_transaction together with - sqlsrv_commit and sqlsrv_rollback. - - -"dbName", "UID"=>"userName", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo); -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true )); -} - -/* Begin the transaction. */ -if ( sqlsrv_begin_transaction( $conn ) === false ) { - die( print_r( sqlsrv_errors(), true )); -} - -/* Initialize parameter values. */ -$orderId = 1; $qty = 10; $productId = 100; - -/* Set up and execute the first query. */ -$sql1 = "INSERT INTO OrdersTable (ID, Quantity, ProductID) - VALUES (?, ?, ?)"; -$params1 = array( $orderId, $qty, $productId ); -$stmt1 = sqlsrv_query( $conn, $sql1, $params1 ); - -/* Set up and execute the second query. */ -$sql2 = "UPDATE InventoryTable - SET Quantity = (Quantity - ?) - WHERE ProductID = ?"; -$params2 = array($qty, $productId); -$stmt2 = sqlsrv_query( $conn, $sql2, $params2 ); - -/* If both queries were successful, commit the transaction. */ -/* Otherwise, rollback the transaction. */ -if( $stmt1 && $stmt2 ) { - sqlsrv_commit( $conn ); - echo "Transaction committed.
    "; -} else { - sqlsrv_rollback( $conn ); - echo "Transaction rolled back.
    "; -} -?> -]]> -
    - &example.outputs.similar; -
    -
    - - - &reftitle.seealso; - - sqlsrv_commit - sqlsrv_rollback - - -
    - diff --git a/reference/sqlsrv/functions/sqlsrv-cancel.xml b/reference/sqlsrv/functions/sqlsrv-cancel.xml deleted file mode 100644 index b7552aae2cd8..000000000000 --- a/reference/sqlsrv/functions/sqlsrv-cancel.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - sqlsrv_cancel - Cancels a statement - - - &reftitle.description; - - boolsqlsrv_cancel - resourcestmt - - - Cancels a statement. Any results associated with the statement that have not - been consumed are deleted. After sqlsrv_cancel has been - called, the specified statement can be re-executed if it was created with - sqlsrv_prepare. Calling sqlsrv_cancel - is not necessary if all the results associated with the statement have been - consumed. - - - - - &reftitle.parameters; - - - stmt - - - The statement resource to be cancelled. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>sqlsrv_cancel</function> example - -"dbName", "UID"=>"username", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo); -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -$sql = "SELECT Sales FROM Table_1"; - -$stmt = sqlsrv_prepare( $conn, $sql); - -if( $stmt === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -if( sqlsrv_execute( $stmt ) === false) { - die( print_r( sqlsrv_errors(), true)); -} - -$salesTotal = 0; -$count = 0; - -while( ($row = sqlsrv_fetch_array( $stmt)) && $salesTotal <=100000) -{ - $qty = $row[0]; - $price = $row[1]; - $salesTotal += ( $price * $qty); - $count++; -} - -echo "$count sales accounted for the first $$salesTotal in revenue.
    "; - -// Cancel the pending results. The statement can be reused. -sqlsrv_cancel( $stmt); -?> -]]> -
    -
    -
    - - - &reftitle.notes; - - The main difference between sqlsrv_cancel and - sqlsrv_free_stmt is that a statement resource cancelled with - sqlsrv_cancel can be re-executed if it was created with - sqlsrv_prepare. A statement resource cancelled with - sqlsrv_free_statement cannot be re-executed. - - - - - &reftitle.seealso; - - sqlsrv_free_stmt - sqlsrv_prepare - - -
    - diff --git a/reference/sqlsrv/functions/sqlsrv-client-info.xml b/reference/sqlsrv/functions/sqlsrv-client-info.xml deleted file mode 100644 index de8d0403759b..000000000000 --- a/reference/sqlsrv/functions/sqlsrv-client-info.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - sqlsrv_client_info - Returns information about the client and specified connection - - - &reftitle.description; - - arraysqlsrv_client_info - resourceconn - - - Returns information about the client and specified connection - - - - - &reftitle.parameters; - - - conn - - - The connection about which information is returned. - - - - - - - - &reftitle.returnvalues; - - Returns an associative array with keys described in the table below. - Returns &false; otherwise. - - Array returned by sqlsrv_client_info - - - - Key - Description - - - - - DriverDllName - SQLNCLI10.DLL - - - DriverODBCVer - ODBC version (xx.yy) - - - DriverVer - SQL Server Native Client DLL version (10.5.xxx) - - - ExtensionVer - php_sqlsrv.dll version (2.0.xxx.x) - - - -
    -
    -
    - - - &reftitle.examples; - - <function>sqlsrv_client_info</function> example - -"username", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connOptions ); - -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -if( $client_info = sqlsrv_client_info( $conn)) { - foreach( $client_info as $key => $value) { - echo $key.": ".$value."
    "; - } -} else { - echo "Error in retrieving client info.
    "; -} -?> -]]> -
    -
    -
    - - - &reftitle.seealso; - - sqlsrv_server_info - - -
    - diff --git a/reference/sqlsrv/functions/sqlsrv-close.xml b/reference/sqlsrv/functions/sqlsrv-close.xml deleted file mode 100644 index 869b01674d3b..000000000000 --- a/reference/sqlsrv/functions/sqlsrv-close.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - sqlsrv_close - Closes an open connection and releases resources associated with the connection - - - &reftitle.description; - - boolsqlsrv_close - resourceconn - - - Closes an open connection and releases resources associated with the connection. - - - - - &reftitle.parameters; - - - conn - - - The connection to be closed. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>sqlsrv_close</function> example - -"username", "PWD"=>"password", "Database"=>"dbname"); -$conn = sqlsrv_connect( $serverName, $connOptions ); -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -//------------------------------------- -// Perform database operations here. -//------------------------------------- - -// Close the connection. -sqlsrv_close( $conn ); -?> -]]> - - - - - - &reftitle.seealso; - - sqlsrv_connect - - - - diff --git a/reference/sqlsrv/functions/sqlsrv-commit.xml b/reference/sqlsrv/functions/sqlsrv-commit.xml deleted file mode 100644 index 2d79896aaa74..000000000000 --- a/reference/sqlsrv/functions/sqlsrv-commit.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - sqlsrv_commit - Commits a transaction that was begun with sqlsrv_begin_transaction - - - &reftitle.description; - - boolsqlsrv_commit - resourceconn - - - Commits a transaction that was begun with sqlsrv_begin_transaction. - The connection is returned to auto-commit mode after sqlsrv_commit - is called. The transaction that is committed includes all statements that were - executed after the call to sqlsrv_begin_transaction. - Explicit transactions should be started and committed or rolled back using these - functions instead of executing SQL statements that begin and commit/roll back - transactions. For more information, see - SQLSRV Transactions. - - - - - &reftitle.parameters; - - - conn - - - The connection on which the transaction is to be committed. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>sqlsrv_commit</function> example - - The following example demonstrates how to use sqlsrv_commit - together with sqlsrv_begin_transaction and - sqlsrv_rollback. - - -"dbName", "UID"=>"userName", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo); -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true )); -} - -/* Begin the transaction. */ -if ( sqlsrv_begin_transaction( $conn ) === false ) { - die( print_r( sqlsrv_errors(), true )); -} - -/* Initialize parameter values. */ -$orderId = 1; $qty = 10; $productId = 100; - -/* Set up and execute the first query. */ -$sql1 = "INSERT INTO OrdersTable (ID, Quantity, ProductID) - VALUES (?, ?, ?)"; -$params1 = array( $orderId, $qty, $productId ); -$stmt1 = sqlsrv_query( $conn, $sql1, $params1 ); - -/* Set up and execute the second query. */ -$sql2 = "UPDATE InventoryTable - SET Quantity = (Quantity - ?) - WHERE ProductID = ?"; -$params2 = array($qty, $productId); -$stmt2 = sqlsrv_query( $conn, $sql2, $params2 ); - -/* If both queries were successful, commit the transaction. */ -/* Otherwise, rollback the transaction. */ -if( $stmt1 && $stmt2 ) { - sqlsrv_commit( $conn ); - echo "Transaction committed.
    "; -} else { - sqlsrv_rollback( $conn ); - echo "Transaction rolled back.
    "; -} -?> -]]> -
    -
    -
    - - - &reftitle.seealso; - - sqlsrv_begin_transaction - sqlsrv_rollback - - -
    - diff --git a/reference/sqlsrv/functions/sqlsrv-configure.xml b/reference/sqlsrv/functions/sqlsrv-configure.xml deleted file mode 100644 index d6ae7acf7810..000000000000 --- a/reference/sqlsrv/functions/sqlsrv-configure.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - sqlsrv_configure - Changes the driver error handling and logging configurations - - - &reftitle.description; - - boolsqlsrv_configure - stringsetting - mixedvalue - - - Changes the driver error handling and logging configurations. - - - - - &reftitle.parameters; - - - setting - - - The name of the setting to set. The possible values are - "WarningsReturnAsErrors", "LogSubsystems", and "LogSeverity". - - - - - value - - - The value of the specified setting. The following table shows possible values: - - Error and Logging Setting Options - - - - Setting - Options - - - - - WarningsReturnAsErrors - 1 (&true;) or 0 (&false;) - - - LogSubsystems - SQLSRV_LOG_SYSTEM_ALL (-1) - SQLSRV_LOG_SYSTEM_CONN (2) - SQLSRV_LOG_SYSTEM_INIT (1) - SQLSRV_LOG_SYSTEM_OFF (0) - SQLSRV_LOG_SYSTEM_STMT (4) - SQLSRV_LOG_SYSTEM_UTIL (8) - - - LogSeverity - SQLSRV_LOG_SEVERITY_ALL (-1) - SQLSRV_LOG_SEVERITY_ERROR (1) - SQLSRV_LOG_SEVERITY_NOTICE (4) - SQLSRV_LOG_SEVERITY_WARNING (2) - - - -
    -
    -
    -
    -
    -
    - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - SQLSRV Error Handling. - Logging SQLSRV Activity. - - -
    - diff --git a/reference/sqlsrv/functions/sqlsrv-connect.xml b/reference/sqlsrv/functions/sqlsrv-connect.xml deleted file mode 100644 index f0cb13fc7b7e..000000000000 --- a/reference/sqlsrv/functions/sqlsrv-connect.xml +++ /dev/null @@ -1,166 +0,0 @@ - - - - - sqlsrv_connect - Opens a connection to a Microsoft SQL Server database - - - &reftitle.description; - - resourcesqlsrv_connect - stringserverName - arrayconnectionInfo - - - Opens a connection to a Microsoft SQL Server database. By default, the connection - is attempted using Windows Authentication. To connect using SQL Server - Authentication, include "UID" and "PWD" in the connection options array. - - - - - &reftitle.parameters; - - - serverName - - - The name of the server to which a connection is established. To connect - to a specific instance, follow the server name with a backward slash - and the instance name (e.g. serverName\sqlexpress). - - - - - connectionInfo - - - An associative array that specifies options for connecting to the server. - If values for the UID and PWD keys are not specified, the connection - will be attempted using Windows Authentication. For a complete list of supported - keys, see SQLSRV Connection Options. - - - - - - - - &reftitle.returnvalues; - - A connection resource. If a connection cannot be successfully opened, &false; is returned. - - - - - &reftitle.examples; - - Connect using Windows Authentication. - -"dbName"); -$conn = sqlsrv_connect( $serverName, $connectionInfo); - -if( $conn ) { - echo "Connection established.
    "; -}else{ - echo "Connection could not be established.
    "; - die( print_r( sqlsrv_errors(), true)); -} -?> -]]> -
    -
    - - Connect by specifying a user name and password. - -"dbName", "UID"=>"userName", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo); - -if( $conn ) { - echo "Connection established.
    "; -}else{ - echo "Connection could not be established.
    "; - die( print_r( sqlsrv_errors(), true)); -} -?> -]]> -
    -
    - - Connect on a specified port. - -"dbName", "UID"=>"userName", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo); - -if( $conn ) { - echo "Connection established.
    "; -}else{ - echo "Connection could not be established.
    "; - die( print_r( sqlsrv_errors(), true)); -} -?> -]]> -
    -
    -
    - - - &reftitle.notes; - - By default, the sqlsrv_connect uses connection pooling to - improve connection performance. To turn off connection pooling (i.e. force a - new connection on each call), set the "ConnectionPooling" option in the - $connectionOptions array to 0 (or &false;). For more information, see - SQLSRV Connection Pooling. - - - The SQLSRV extension does not have a dedicated function for changing which - database is connected to. The target database is specified in the - $connectionOptions array that is passed to sqlsrv_connect. To change the - database on an open connection, execute the following query "USE dbName" - (e.g. sqlsrv_query($conn, "USE dbName")). - - - - - &reftitle.seealso; - - sqlsrv_close - sqlsrv_errors - sqlsrv_query - - -
    - diff --git a/reference/sqlsrv/functions/sqlsrv-errors.xml b/reference/sqlsrv/functions/sqlsrv-errors.xml deleted file mode 100644 index f3a5b390be2f..000000000000 --- a/reference/sqlsrv/functions/sqlsrv-errors.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - sqlsrv_errors - Returns error and warning information about the last SQLSRV operation performed - - - &reftitle.description; - - - mixedsqlsrv_errors - interrorsOrWarnings - - - Returns error and warning information about the last SQLSRV operation performed. - - - - - &reftitle.parameters; - - - errorsOrWarnings - - - Determines whether error information, warning information, or both are - returned. If this parameter is not supplied, both error information and - warning information are returned. The following are the supported values - for this parameter: SQLSRV_ERR_ALL, SQLSRV_ERR_ERRORS, SQLSRV_ERR_WARNINGS. - - - - - - - - &reftitle.returnvalues; - - If errors and/or warnings occurred on the last sqlsrv operation, an array of - arrays containing error information is returned. If no errors and/or warnings - occurred on the last sqlsrv operation, &null; is returned. The following table - describes the structure of the returned arrays: - - Array returned by sqlsrv_errors - - - - Key - Description - - - - - SQLSTATE - For errors that originate from the ODBC driver, the SQLSTATE returned - by ODBC. For errors that originate from the Microsoft Drivers for PHP for - SQL Server, a SQLSTATE of IMSSP. For warnings that originate from the - Microsoft Drivers for PHP for SQL Server, a SQLSTATE of 01SSP. - - - - code - For errors that originate from SQL Server, the native SQL Server - error code. For errors that originate from the ODBC driver, the error - code returned by ODBC. For errors that originate from the Microsoft Drivers - for PHP for SQL Server, the Microsoft Drivers for PHP for SQL Server error code. - - - - message - A description of the error. - - - -
    -
    -
    - - - &reftitle.examples; - - <function>functionname</function> example - -"dbName", "UID"=>"username", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo); -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -/* Set up a query to select an invalid column name. */ -$sql = "SELECT BadColumnName FROM Table_1"; - -/* Execution of the query will fail because of the bad column name. */ -$stmt = sqlsrv_query( $conn, $sql ); -if( $stmt === false ) { - if( ($errors = sqlsrv_errors() ) != null) { - foreach( $errors as $error ) { - echo "SQLSTATE: ".$error[ 'SQLSTATE']."
    "; - echo "code: ".$error[ 'code']."
    "; - echo "message: ".$error[ 'message']."
    "; - } - } -} -?> -]]> -
    -
    -
    - - - &reftitle.notes; - - By default, warnings generated on a call to any SQLSRV function are treated - as errors. This means that if a warning occurs on a call to a SQLSRV function, - the function returns &false;. However, warnings that correspond to SQLSTATE - values 01000, 01001, 01003, and 01S02 are never treated as errors. For - information about changing this behavior, see sqlsrv_configure - and the WarningsReturnAsErrors setting. - - - - - &reftitle.seealso; - - sqlsrv_configure - - -
    - diff --git a/reference/sqlsrv/functions/sqlsrv-execute.xml b/reference/sqlsrv/functions/sqlsrv-execute.xml deleted file mode 100644 index 18e33dc8bfbf..000000000000 --- a/reference/sqlsrv/functions/sqlsrv-execute.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - sqlsrv_execute - Executes a statement prepared with sqlsrv_prepare - - - &reftitle.description; - - boolsqlsrv_execute - resourcestmt - - - Executes a statement prepared with sqlsrv_prepare. This - function is ideal for executing a prepared statement multiple times with - different parameter values. - - - - - &reftitle.parameters; - - - stmt - - - A statement resource returned by sqlsrv_prepare. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>sqlsrv_execute</function> example - - This example demonstrates how to prepare a statement with - sqlsrv_prepare and re-execute it multiple times (with - different parameter values) using sqlsrv_execute. - - -"dbName", "UID"=>"username", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo); -if( $conn === false) { - die( print_r( sqlsrv_errors(), true)); -} - -$sql = "UPDATE Table_1 - SET OrderQty = ? - WHERE SalesOrderID = ?"; - -// Initialize parameters and prepare the statement. -// Variables $qty and $id are bound to the statement, $stmt. -$qty = 0; $id = 0; -$stmt = sqlsrv_prepare( $conn, $sql, array( &$qty, &$id)); -if( !$stmt ) { - die( print_r( sqlsrv_errors(), true)); -} - -// Set up the SalesOrderDetailID and OrderQty information. -// This array maps the order ID to order quantity in key=>value pairs. -$orders = array( 1=>10, 2=>20, 3=>30); - -// Execute the statement for each order. -foreach( $orders as $id => $qty) { - // Because $id and $qty are bound to $stmt1, their updated - // values are used with each execution of the statement. - if( sqlsrv_execute( $stmt ) === false ) { - die( print_r( sqlsrv_errors(), true)); - } -} -?> -]]> - - - - - - &reftitle.notes; - - When you prepare a statement that uses variables as parameters, the variables - are bound to the statement. This means that if you update the values of the - variables, the next time you execute the statement it will run with updated - parameter values. For statements that you plan to execute only once, use - sqlsrv_query. - - - - - &reftitle.seealso; - - sqlsrv_prepare - sqlsrv_query - - - - diff --git a/reference/sqlsrv/functions/sqlsrv-fetch-array.xml b/reference/sqlsrv/functions/sqlsrv-fetch-array.xml deleted file mode 100644 index b727a40f4962..000000000000 --- a/reference/sqlsrv/functions/sqlsrv-fetch-array.xml +++ /dev/null @@ -1,188 +0,0 @@ - - - - - sqlsrv_fetch_array - Returns a row as an array - - - &reftitle.description; - - arraysqlsrv_fetch_array - resourcestmt - intfetchType - introw - intoffset - - - Returns the next available row of data as an associative array, a numeric - array, or both (the default). - - - - - &reftitle.parameters; - - - stmt - - - A statement resource returned by sqlsrv_query or sqlsrv_prepare. - - - - - fetchType - - - A predefined constant specifying the type of array to return. Possible - values are SQLSRV_FETCH_ASSOC, - SQLSRV_FETCH_NUMERIC, and - SQLSRV_FETCH_BOTH (the default). - - - A fetch type of SQLSRV_FETCH_ASSOC should not be used when consuming a - result set with multiple columns of the same name. - - - - - row - - - Specifies the row to access in a result set that uses a scrollable cursor. - Possible values are SQLSRV_SCROLL_NEXT, - SQLSRV_SCROLL_PRIOR, SQLSRV_SCROLL_FIRST, - SQLSRV_SCROLL_LAST, SQLSRV_SCROLL_ABSOLUTE and, - SQLSRV_SCROLL_RELATIVE (the default). When this parameter - is specified, the fetchType must be explicitly defined. - - - - - offset - - - Specifies the row to be accessed if the row parameter is set to - SQLSRV_SCROLL_ABSOLUTE or - SQLSRV_SCROLL_RELATIVE. Note that the first row in - a result set has index 0. - - - - - - - - &reftitle.returnvalues; - - Returns an array on success, &null; if there are no more rows to return, and - &false; if an error occurs. - - - - - &reftitle.examples; - - Retrieving an associative array. - -"dbName", "UID"=>"username", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo ); -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -$sql = "SELECT FirstName, LastName FROM SomeTable"; -$stmt = sqlsrv_query( $conn, $sql ); -if( $stmt === false) { - die( print_r( sqlsrv_errors(), true) ); -} - -while( $row = sqlsrv_fetch_array( $stmt, SQLSRV_FETCH_ASSOC) ) { - echo $row['LastName'].", ".$row['FirstName']."
    "; -} - -sqlsrv_free_stmt( $stmt); -?> -]]> -
    -
    - - Retrieving a numeric array. - -"dbName", "UID"=>"username", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo ); -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -$sql = "SELECT FirstName, LastName FROM SomeTable"; -$stmt = sqlsrv_query( $conn, $sql ); -if( $stmt === false) { - die( print_r( sqlsrv_errors(), true) ); -} - -while( $row = sqlsrv_fetch_array( $stmt, SQLSRV_FETCH_NUMERIC) ) { - echo $row[0].", ".$row[1]."
    "; -} - -sqlsrv_free_stmt( $stmt); -?> -]]> -
    -
    -
    - - - &reftitle.notes; - - Not specifying the fetchType or explicitly using the - SQLSRV_FETCH_TYPE constant in the examples above will - return an array that has both associative and numeric keys. - - - If more than one column is returned with the same name, the last column will - take precedence. To avoid field name collisions, use aliases. - - - If a column with no name is returned, the associative key for the array element - will be an empty string (""). - - - - - &reftitle.seealso; - - sqlsrv_connect - sqlsrv_query - sqlsrv_errors - sqlsrv_fetch - - -
    - diff --git a/reference/sqlsrv/functions/sqlsrv-fetch-object.xml b/reference/sqlsrv/functions/sqlsrv-fetch-object.xml deleted file mode 100644 index 6d9e375a0b64..000000000000 --- a/reference/sqlsrv/functions/sqlsrv-fetch-object.xml +++ /dev/null @@ -1,184 +0,0 @@ - - - - - sqlsrv_fetch_object - Retrieves the next row of data in a result set as an object - - - &reftitle.description; - - mixedsqlsrv_fetch_object - resourcestmt - stringclassName - arrayctorParams - introw - intoffset - - - Retrieves the next row of data in a result set as an instance of the specified - class with properties that match the row field names and values that correspond - to the row field values. - - - - - &reftitle.parameters; - - - stmt - - - A statement resource created by sqlsrv_query or - sqlsrv_execute. - - - - - className - - - The name of the class to instantiate. If no class name is specified, - stdClass is instantiated. - - - - - ctorParams - - - Values passed to the constructor of the specified class. If the constructor - of the specified class takes parameters, the ctorParams array must be - supplied. - - - - - row - - - The row to be accessed. This parameter can only be used if the specified - statement was prepared with a scrollable cursor. In that case, this parameter - can take on one of the following values: - - SQLSRV_SCROLL_NEXT - SQLSRV_SCROLL_PRIOR - SQLSRV_SCROLL_FIRST - SQLSRV_SCROLL_LAST - SQLSRV_SCROLL_ABSOLUTE - SQLSRV_SCROLL_RELATIVE - - - - - - offset - - - Specifies the row to be accessed if the row parameter is set to - SQLSRV_SCROLL_ABSOLUTE or - SQLSRV_SCROLL_RELATIVE. Note that the first row in - a result set has index 0. - - - - - - - - &reftitle.returnvalues; - - Returns an object on success, &null; if there are no more rows to return, - and &false; if an error occurs or if the specified class does not exist. - - - - - &reftitle.examples; - - <function>sqlsrv_fetch_object</function> example - - The following example demonstrates how to retrieve a row as a stdClass object. - - -"dbName", "UID"=>"username", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo); -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -$sql = "SELECT fName, lName FROM Table_1"; -$stmt = sqlsrv_query( $conn, $sql); -if( $stmt === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -// Retrieve each row as an object. -// Because no class is specified, each row will be retrieved as a stdClass object. -// Property names correspond to field names. -while( $obj = sqlsrv_fetch_object( $stmt)) { - echo $obj->fName.", ".$obj->lName."
    "; -} -?> -]]> -
    -
    -
    - - - &reftitle.notes; - - If a class name is specified with the optional $className parameter and the - class has properties whose names match the result set field names, the corresponding - result set values are applied to the properties. If a result set field name - does not match a class property, a property with the result set field name is added - to the object and the result set value is applied to the property. The following - rules apply when using the $className parameter: - - Field-property name matching is case-sensitive. - Field-property matching occurs regardless of access modifiers. - Class property data types are ignored when applying a field value to a property. - If the class does not exist, the function returns &false; and adds an error to the error collection. - - Regardless of whether the $className parameter is supplied, if a field with no - name is returned, the field value will be ignored and a warning will be added - to the error collection. - - - When consuming a result set that has multiple columns with the same name, it may - be better to use sqlsrv_fetch_array or the combination of - sqlsrv_fetch and sqlsrv_get_field. - - - - - &reftitle.seealso; - - sqlsrv_fetch - sqlsrv_fetch_array - - -
    - diff --git a/reference/sqlsrv/functions/sqlsrv-fetch.xml b/reference/sqlsrv/functions/sqlsrv-fetch.xml deleted file mode 100644 index 14a9c3610dc1..000000000000 --- a/reference/sqlsrv/functions/sqlsrv-fetch.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - sqlsrv_fetch - Makes the next row in a result set available for reading - - - &reftitle.description; - - - mixedsqlsrv_fetch - resourcestmt - introw - intoffset - - - Makes the next row in a result set available for reading. Use - sqlsrv_get_field to read the fields of the row. - - - - - &reftitle.parameters; - - - stmt - - - A statement resource created by executing sqlsrv_query - or sqlsrv_execute. - - - - - row - - - The row to be accessed. This parameter can only be used if the specified - statement was prepared with a scrollable cursor. In that case, this parameter - can take on one of the following values: - - SQLSRV_SCROLL_NEXT - SQLSRV_SCROLL_PRIOR - SQLSRV_SCROLL_FIRST - SQLSRV_SCROLL_LAST - SQLSRV_SCROLL_ABSOLUTE - SQLSRV_SCROLL_RELATIVE - - - - - - offset - - - Specifies the row to be accessed if the row parameter is set to - SQLSRV_SCROLL_ABSOLUTE or - SQLSRV_SCROLL_RELATIVE. Note that the first row in - a result set has index 0. - - - - - - - - &reftitle.returnvalues; - - Returns &true; if the next row of a result set was successfully retrieved, - &false; if an error occurs, and &null; if there are no more rows in the result set. - - - - - &reftitle.examples; - - <function>sqlsrv_fetch</function> example - - The following example demonstrates how to retrieve a row with - sqlsrv_fetch and get the row fields with - sqlsrv_get_field. - - -"dbName", "UID"=>"username", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo); -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -$sql = "SELECT Name, Comment - FROM Table_1 - WHERE ReviewID=1"; -$stmt = sqlsrv_query( $conn, $sql); -if( $stmt === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -// Make the first (and in this case, only) row of the result set available for reading. -if( sqlsrv_fetch( $stmt ) === false) { - die( print_r( sqlsrv_errors(), true)); -} - -// Get the row fields. Field indices start at 0 and must be retrieved in order. -// Retrieving row fields by name is not supported by sqlsrv_get_field. -$name = sqlsrv_get_field( $stmt, 0); -echo "$name: "; - -$comment = sqlsrv_get_field( $stmt, 1); -echo $comment; -?> -]]> - - - - - - - &reftitle.seealso; - - sqlsrv_get_field - sqlsrv_fetch_array - sqlsrv_fetch_object - - - - diff --git a/reference/sqlsrv/functions/sqlsrv-field-metadata.xml b/reference/sqlsrv/functions/sqlsrv-field-metadata.xml deleted file mode 100644 index 8b3d7c06c31f..000000000000 --- a/reference/sqlsrv/functions/sqlsrv-field-metadata.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - sqlsrv_field_metadata - Retrieves metadata for the fields of a statement prepared by - sqlsrv_prepare or sqlsrv_query - - - - &reftitle.description; - - mixedsqlsrv_field_metadata - resourcestmt - - - Retrieves metadata for the fields of a statement prepared by - sqlsrv_prepare or sqlsrv_query. - sqlsrv_field_metadata can be called on a statement before - or after statement execution. - - - - - &reftitle.parameters; - - - stmt - - - The statement resource for which metadata is returned. - - - - - - - - &reftitle.returnvalues; - - Returns an array of arrays on success. Otherwise, &false; is returned. - Each returned array is described by the following table: - - Array returned by sqlsrv_field_metadata - - - - Key - Description - - - - - Name - The name of the field. - - - Type - The numeric value for the SQL type. - - - Size - The number of characters for fields of character type, the number of - bytes for fields of binary type, or &null; for other types. - - - Precision - The precision for types of variable precision, &null; for other types. - - - Scale - The scale for types of variable scale, &null; for other types. - - - Nullable - An enumeration indicating whether the column is nullable, not nullable, - or if it is not known. - - - -
    - For more information, see sqlsrv_field_metadata - in the Microsoft SQLSRV documentation. -
    -
    - - - &reftitle.examples; - - <function>sqlsrv_field_metadata</function> example - -"AdventureWorks", "UID"=>"username", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo); -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -$sql = "SELECT * FROM Table_1"; -$stmt = sqlsrv_prepare( $conn, $sql ); - -foreach( sqlsrv_field_metadata( $stmt ) as $fieldMetadata ) { - foreach( $fieldMetadata as $name => $value) { - echo "$name: $value
    "; - } - echo "
    "; -} -?> -]]> -
    -
    -
    - - - &reftitle.seealso; - - sqlsrv_client_info - - -
    - diff --git a/reference/sqlsrv/functions/sqlsrv-free-stmt.xml b/reference/sqlsrv/functions/sqlsrv-free-stmt.xml deleted file mode 100644 index a4232d0ee7b3..000000000000 --- a/reference/sqlsrv/functions/sqlsrv-free-stmt.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - sqlsrv_free_stmt - Frees all resources for the specified statement - - - &reftitle.description; - - boolsqlsrv_free_stmt - resourcestmt - - - Frees all resources for the specified statement. The statement cannot be used - after sqlsrv_free_stmt has been called on it. If - sqlsrv_free_stmt is called on an in-progress statement - that alters server state, statement execution is terminated and the statement - is rolled back. - - - - - &reftitle.parameters; - - - stmt - - - The statement for which resources are freed. - Note that &null; is a valid parameter value. This allows the function to be - called multiple times in a script. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>sqlsrv_free_stmt</function> example - -"dbName", "UID"=>"username", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo); -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -$stmt = sqlsrv_query( $conn, "SELECT * FROM Table_1"); -if( $stmt === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -/*------------------------------- - Process query results here. --------------------------------*/ - -/* Free the statement resources. */ -sqlsrv_free_stmt( $stmt); - -?> -]]> - - - - - - &reftitle.notes; - - The main difference between sqlsrv_free_stmt and - sqlsrv_cancel is that a statement resource cancelled with - sqlsrv_cancel can be re-executed if it was created with - sqlsrv_prepare. A statement resource cancelled with - sqlsrv_free_statement cannot be re-executed. - - - - &reftitle.seealso; - - sqlsrv_cancel - - - - diff --git a/reference/sqlsrv/functions/sqlsrv-get-config.xml b/reference/sqlsrv/functions/sqlsrv-get-config.xml deleted file mode 100644 index 674922673a91..000000000000 --- a/reference/sqlsrv/functions/sqlsrv-get-config.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - sqlsrv_get_config - Returns the value of the specified configuration setting - - - &reftitle.description; - - mixedsqlsrv_get_config - stringsetting - - - Returns the value of the specified configuration setting. - - - - - &reftitle.parameters; - - - setting - - - The name of the setting for which the value is returned. For a list of - configurable settings, see sqlsrv_configure. - - - - - - - - &reftitle.returnvalues; - - Returns the value of the specified setting. If an invalid setting is specified, - &false; is returned. - - - - - &reftitle.seealso; - - sqlsrv_configure - - - - diff --git a/reference/sqlsrv/functions/sqlsrv-get-field.xml b/reference/sqlsrv/functions/sqlsrv-get-field.xml deleted file mode 100644 index 031f24c526d6..000000000000 --- a/reference/sqlsrv/functions/sqlsrv-get-field.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - sqlsrv_get_field - Gets field data from the currently selected row - - - &reftitle.description; - - mixedsqlsrv_get_field - resourcestmt - intfieldIndex - intgetAsType - - - Gets field data from the currently selected row. Fields must be accessed in - order. Field indices start at 0. - - - - - &reftitle.parameters; - - - stmt - - - A statement resource returned by sqlsrv_query or - sqlsrv_execute. - - - - - fieldIndex - - - The index of the field to be retrieved. Field indices start at 0. Fields - must be accessed in order. i.e. If you access field index 1, then field - index 0 will not be available. - - - - - getAsType - - - The PHP data type for the returned field data. If this parameter is not - set, the field data will be returned as its default PHP data type. - For information about default PHP data types, see - Default PHP Data Types - in the Microsoft SQLSRV documentation. - - - - - - - - &reftitle.returnvalues; - - Returns data from the specified field on success. Returns &false; otherwise. - - - - - &reftitle.examples; - - <function>sqlsrv_get_field</function> example - - The following example demonstrates how to retrieve a row with - sqlsrv_fetch and get the row fields with - sqlsrv_get_field. - - -"dbName", "UID"=>"username", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo); -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -$sql = "SELECT Name, Comment - FROM Table_1 - WHERE ReviewID=1"; -$stmt = sqlsrv_query( $conn, $sql); -if( $stmt === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -// Make the first (and in this case, only) row of the result set available for reading. -if( sqlsrv_fetch( $stmt ) === false) { - die( print_r( sqlsrv_errors(), true)); -} - -// Get the row fields. Field indices start at 0 and must be retrieved in order. -// Retrieving row fields by name is not supported by sqlsrv_get_field. -$name = sqlsrv_get_field( $stmt, 0); -echo "$name: "; - -$comment = sqlsrv_get_field( $stmt, 1); -echo $comment; -?> -]]> - - - - - - &reftitle.seealso; - - sqlsrv_fetch - sqlsrv_fetch_array - sqlsrv_fetch_object - - - - diff --git a/reference/sqlsrv/functions/sqlsrv-has-rows.xml b/reference/sqlsrv/functions/sqlsrv-has-rows.xml deleted file mode 100644 index 8d70d0b6efb7..000000000000 --- a/reference/sqlsrv/functions/sqlsrv-has-rows.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - sqlsrv_has_rows - Indicates whether the specified statement has rows - - - &reftitle.description; - - boolsqlsrv_has_rows - resourcestmt - - - Indicates whether the specified statement has rows. - - - - - &reftitle.parameters; - - - stmt - - - A statement resource returned by sqlsrv_query or - sqlsrv_execute. - - - - - - - - &reftitle.returnvalues; - - Returns &true; if the specified statement has rows and &false; if the statement - does not have rows or if an error occurred. - - - - - &reftitle.examples; - - <function>sqlsrv_has_rows</function> example - -"dbName", "UID"=>"username", "PWD"=>"password" ); -$conn = sqlsrv_connect( $server, $connectionInfo ); - -$stmt = sqlsrv_query( $conn, "SELECT * FROM Table_1"); - -if ($stmt) { - $rows = sqlsrv_has_rows( $stmt ); - if ($rows === true) - echo "There are rows.
    "; - else - echo "There are no rows.
    "; -} -?> -]]> -
    -
    -
    - - - &reftitle.seealso; - - sqlsrv_num_rows - sqlsrv_query - - -
    - diff --git a/reference/sqlsrv/functions/sqlsrv-next-result.xml b/reference/sqlsrv/functions/sqlsrv-next-result.xml deleted file mode 100644 index 8964f6194ba3..000000000000 --- a/reference/sqlsrv/functions/sqlsrv-next-result.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - sqlsrv_next_result - Makes the next result of the specified statement active - - - &reftitle.description; - - mixedsqlsrv_next_result - - resourcestmt - - - Makes the next result of the specified statement active. Results include result - sets, row counts, and output parameters. - - - - - &reftitle.parameters; - - - stmt - - - The statement on which the next result is being called. - - - - - - - - &reftitle.returnvalues; - - Returns &true; if the next result was successfully retrieved, &false; if an error - occurred, and &null; if there are no more results to retrieve. - - - - - &reftitle.examples; - - <function>sqlsrv_next_result</function> example - - The following example executes a batch query that inserts into a table and - then selects from the table. This produces two results on the statement: - one for the rows affected by the INSERT and one for the rows returned by - the SELECT. To get to the rows returned by the SELECT, - sqlsrv_next_result must be called to move past the first result. - - -"dbName", "UID"=>"userName", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo); - -$query = "INSERT INTO Table_1 (id, data) VALUES (?,?); SELECT * FROM TABLE_1;"; -$params = array(1, "some data"); -$stmt = sqlsrv_query($conn, $query, $params); - -// Consume the first result (rows affected by INSERT) without calling sqlsrv_next_result. -echo "Rows affected: ".sqlsrv_rows_affected($stmt)."
    "; - -// Move to the next result and display results. -$next_result = sqlsrv_next_result($stmt); -if( $next_result ) { - while( $row = sqlsrv_fetch_array( $stmt, SQLSRV_FETCH_ASSOC)){ - echo $row['id'].": ".$row['data']."
    "; - } -} elseif( is_null($next_result)) { - echo "No more results.
    "; -} else { - die(print_r(sqlsrv_errors(), true)); -} -?> -]]> -
    -
    -
    - - - &reftitle.seealso; - - sqlsrv_query - sqlsrv_fetch_array - sqlsrv_rows_affected - - -
    - diff --git a/reference/sqlsrv/functions/sqlsrv-num-fields.xml b/reference/sqlsrv/functions/sqlsrv-num-fields.xml deleted file mode 100644 index e66ce80436b7..000000000000 --- a/reference/sqlsrv/functions/sqlsrv-num-fields.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - sqlsrv_num_fields - Retrieves the number of fields (columns) on a statement - - - &reftitle.description; - - mixedsqlsrv_num_fields - resourcestmt - - - Retrieves the number of fields (columns) on a statement. - - - - - &reftitle.parameters; - - - stmt - - - The statement for which the number of fields is returned. - sqlsrv_num_fields can be called on a statement before - or after statement execution. - - - - - - - - &reftitle.returnvalues; - - Returns the number of fields on success. Returns &false; otherwise. - - - - - &reftitle.examples; - - <function>sqlsrv_num_fields</function> example - -"dbName", "UID"=>"username", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo); -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -$sql = "SELECT * FROM Table_1"; -$stmt = sqlsrv_query($conn, $sql); -if( $stmt === false) { - die( print_r( sqlsrv_errors(), true)); -} - -$numFields = sqlsrv_num_fields( $stmt ); - -while( sqlsrv_fetch( $stmt )) { - // Iterate through the fields of each row. - for($i = 0; $i < $numFields; $i++) { - echo sqlsrv_get_field($stmt, $i)." "; - } - echo "
    "; -} -?> -]]> -
    -
    -
    - - - &reftitle.seealso; - - sqlsrv_field_metadata - sqlsrv_fetch - sqlsrv_get_field - - -
    - diff --git a/reference/sqlsrv/functions/sqlsrv-num-rows.xml b/reference/sqlsrv/functions/sqlsrv-num-rows.xml deleted file mode 100644 index 9a46895028e2..000000000000 --- a/reference/sqlsrv/functions/sqlsrv-num-rows.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - sqlsrv_num_rows - Retrieves the number of rows in a result set - - - &reftitle.description; - - mixedsqlsrv_num_rows - resourcestmt - - - Retrieves the number of rows in a result set. This function requires that the - statement resource be created with a static or keyset cursor. For more information, - see sqlsrv_query, sqlsrv_prepare, - or Specifying a Cursor Type and Selecting Rows - in the Microsoft SQLSRV documentation. - - - - - &reftitle.parameters; - - - stmt - - - The statement for which the row count is returned. The statement resource - must be created with a static or keyset cursor. For more information, see - sqlsrv_query, sqlsrv_prepare, or - Specifying a Cursor Type and Selecting Rows - in the Microsoft SQLSRV documentation. - - - - - - - - &reftitle.returnvalues; - - Returns the number of rows retrieved on success and &false; if an error occurred. - If a forward cursor (the default) or dynamic cursor is used, &false; is returned. - - - - - &reftitle.examples; - - <function>sqlsrv_num_rows</function> example - -"dbName", "UID"=>"username", "PWD"=>"password" ); -$conn = sqlsrv_connect( $server, $connectionInfo ); - -$sql = "SELECT * FROM Table_1"; -$params = array(); -$options = array( "Scrollable" => SQLSRV_CURSOR_KEYSET ); -$stmt = sqlsrv_query( $conn, $sql , $params, $options ); - -$row_count = sqlsrv_num_rows( $stmt ); - -if ($row_count === false) - echo "Error in retrieving row count."; -else - echo $row_count; -?> -]]> - - - - - - &reftitle.seealso; - - sqlsrv_has_rows - sqlsrv_rows_affected - - - - diff --git a/reference/sqlsrv/functions/sqlsrv-prepare.xml b/reference/sqlsrv/functions/sqlsrv-prepare.xml deleted file mode 100644 index d42cd8f47d39..000000000000 --- a/reference/sqlsrv/functions/sqlsrv-prepare.xml +++ /dev/null @@ -1,230 +0,0 @@ - - - - - sqlsrv_prepare - Prepares a query for execution - - - &reftitle.description; - - mixedsqlsrv_prepare - resourceconn - stringsql - arrayparams - arrayoptions - - - Prepares a query for execution. This function is ideal for preparing a query - that will be executed multiple times with different parameter values. - - - - - &reftitle.parameters; - - - conn - - - A connection resource returned by sqlsrv_connect. - - - - - sql - - - The string that defines the query to be prepared and executed. - - - - - params - - - An array specifying parameter information when executing a parameterized - query. Array elements can be any of the following: - - A literal value - A PHP variable - An array with this structure: - array($value [, $direction [, $phpType [, $sqlType]]]) - - The following table describes the elements in the array structure above: - - - Array structure - - - - Element - Description - - - - - $value - A literal value, a PHP variable, or a PHP by-reference variable. - - - $direction (optional) - One of the following SQLSRV constants used to indicate the - parameter direction: SQLSRV_PARAM_IN, SQLSRV_PARAM_OUT, SQLSRV_PARAM_INOUT. - The default value is SQLSRV_PARAM_IN. - - - $phpType (optional) - A SQLSRV_PHPTYPE_* constant that specifies PHP data type of the - returned value. - - - $sqlType (optional) - A SQLSRV_SQLTYPE_* constant that specifies the SQL Server data - type of the input value. - - - -
    -
    -
    - - options - - - An array specifying query property options. The supported keys are described - in the following table: - - - Query Options - - - - Key - Values - Description - - - - - QueryTimeout - A positive integer value. - Sets the query timeout in seconds. By default, the driver will - wait indefinitely for results. - - - SendStreamParamsAtExec - &true; or &false; (the default is &true;) - Configures the driver to send all stream data at execution (&true;), - or to send stream data in chunks (&false;). By default, the value is set to &true;. - For more information, see sqlsrv_send_stream_data. - - - Scrollable - SQLSRV_CURSOR_FORWARD, SQLSRV_CURSOR_STATIC, SQLSRV_CURSOR_DYNAMIC, - or SQLSRV_CURSOR_KEYSET - See Specifying a Cursor Type and Selecting Rows - in the Microsoft SQLSRV documentation. - - - -
    -
    -
    -
    -
    - - - &reftitle.returnvalues; - - Returns a statement resource on success and &false; if an error occurred. - - - - - &reftitle.examples; - - <function>sqlsrv_prepare</function> example - - This example demonstrates how to prepare a statement with sqlsrv_prepare - and re-execute it multiple times (with different parameter values) using sqlsrv_execute. - - -"dbName", "UID"=>"username", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo); -if( $conn === false) { - die( print_r( sqlsrv_errors(), true)); -} - -$sql = "UPDATE Table_1 - SET OrderQty = ? - WHERE SalesOrderID = ?"; - -// Initialize parameters and prepare the statement. -// Variables $qty and $id are bound to the statement, $stmt. -$qty = 0; $id = 0; -$stmt = sqlsrv_prepare( $conn, $sql, array( &$qty, &$id)); -if( !$stmt ) { - die( print_r( sqlsrv_errors(), true)); -} - -// Set up the SalesOrderDetailID and OrderQty information. -// This array maps the order ID to order quantity in key=>value pairs. -$orders = array( 1=>10, 2=>20, 3=>30); - -// Execute the statement for each order. -foreach( $orders as $id => $qty) { - // Because $id and $qty are bound to $stmt1, their updated - // values are used with each execution of the statement. - if( sqlsrv_execute( $stmt ) === false ) { - die( print_r( sqlsrv_errors(), true)); - } -} -?> -]]> - - - - - - &reftitle.notes; - - When you prepare a statement that uses variables as parameters, the variables - are bound to the statement. This means that if you update the values of the - variables, the next time you execute the statement it will run with updated - parameter values. For statements that you plan to execute only once, use - sqlsrv_query. - - - - - &reftitle.seealso; - - sqlsrv_execute - sqlsrv_query - - -
    - diff --git a/reference/sqlsrv/functions/sqlsrv-query.xml b/reference/sqlsrv/functions/sqlsrv-query.xml deleted file mode 100644 index 113e740df963..000000000000 --- a/reference/sqlsrv/functions/sqlsrv-query.xml +++ /dev/null @@ -1,206 +0,0 @@ - - - - - sqlsrv_query - Prepares and executes a query - - - &reftitle.description; - - mixedsqlsrv_query - resourceconn - stringsql - arrayparams - arrayoptions - - - Prepares and executes a query. - - - - - &reftitle.parameters; - - - conn - - - A connection resource returned by sqlsrv_connect. - - - - - sql - - - The string that defines the query to be prepared and executed. - - - - - params - - - An array specifying parameter information when executing a parameterized query. - Array elements can be any of the following: - - A literal value - A PHP variable - An array with this structure: - array($value [, $direction [, $phpType [, $sqlType]]]) - - The following table describes the elements in the array structure above: - - - Array structure - - - - Element - Description - - - - - $value - A literal value, a PHP variable, or a PHP by-reference variable. - - - $direction (optional) - One of the following SQLSRV constants used to indicate the - parameter direction: SQLSRV_PARAM_IN, SQLSRV_PARAM_OUT, SQLSRV_PARAM_INOUT. - The default value is SQLSRV_PARAM_IN. - - - $phpType (optional) - A SQLSRV_PHPTYPE_* constant that specifies PHP data type of the - returned value. - - - $sqlType (optional) - A SQLSRV_SQLTYPE_* constant that specifies the SQL Server data - type of the input value. - - - -
    -
    -
    - - options - - - An array specifying query property options. The supported keys are described - in the following table: - - - Query Options - - - - Key - Values - Description - - - - - QueryTimeout - A positive integer value. - Sets the query timeout in seconds. By default, the driver will - wait indefinitely for results. - - - SendStreamParamsAtExec - &true; or &false; (the default is &true;) - Configures the driver to send all stream data at execution (&true;), - or to send stream data in chunks (&false;). By default, the value is set - to &true;. For more information, see sqlsrv_send_stream_data. - - - Scrollable - SQLSRV_CURSOR_FORWARD, SQLSRV_CURSOR_STATIC, SQLSRV_CURSOR_DYNAMIC, - or SQLSRV_CURSOR_KEYSET - See Specifying - a Cursor Type and Selecting Rows in the Microsoft SQLSRV documentation. - - - -
    -
    -
    -
    -
    - - - &reftitle.returnvalues; - - Returns a statement resource on success and &false; if an error occurred. - - - - - &reftitle.examples; - - <function>sqlsrv_query</function> example - -"dbName", "UID"=>"username", "PWD"=>"password" ); -$conn = sqlsrv_connect( $serverName, $connectionInfo); -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -$sql = "INSERT INTO Table_1 (id, data) VALUES (?, ?)"; -$params = array(1, "some data"); - -$stmt = sqlsrv_query( $conn, $sql, $params); -if( $stmt === false ) { - die( print_r( sqlsrv_errors(), true)); -} -?> -]]> - - - - - - &reftitle.notes; - - For statements that you plan to execute only once, use sqlsrv_query. - If you intend to re-execute a statement with different parameter values, use - the combination of sqlsrv_prepare and sqlsrv_execute. - - - - - &reftitle.seealso; - - sqlsrv_prepare - sqlsrv_execute - - -
    - diff --git a/reference/sqlsrv/functions/sqlsrv-rollback.xml b/reference/sqlsrv/functions/sqlsrv-rollback.xml deleted file mode 100644 index 1bcf2fd0b1ad..000000000000 --- a/reference/sqlsrv/functions/sqlsrv-rollback.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - sqlsrv_rollback - Rolls back a transaction that was begun with - sqlsrv_begin_transaction - - - &reftitle.description; - - boolsqlsrv_rollback - resourceconn - - - Rolls back a transaction that was begun with sqlsrv_begin_transaction - and returns the connection to auto-commit mode. - - - - - &reftitle.parameters; - - - conn - - - The connection resource returned by a call to sqlsrv_connect. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>sqlsrv_rollback</function> example - - The following example demonstrates how to use sqlsrv_begin_transaction - together with sqlsrv_commit and sqlsrv_rollback. - - -"dbName", "UID"=>"userName", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo); -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true )); -} - -/* Begin the transaction. */ -if ( sqlsrv_begin_transaction( $conn ) === false ) { - die( print_r( sqlsrv_errors(), true )); -} - -/* Initialize parameter values. */ -$orderId = 1; $qty = 10; $productId = 100; - -/* Set up and execute the first query. */ -$sql1 = "INSERT INTO OrdersTable (ID, Quantity, ProductID) - VALUES (?, ?, ?)"; -$params1 = array( $orderId, $qty, $productId ); -$stmt1 = sqlsrv_query( $conn, $sql1, $params1 ); - -/* Set up and execute the second query. */ -$sql2 = "UPDATE InventoryTable - SET Quantity = (Quantity - ?) - WHERE ProductID = ?"; -$params2 = array($qty, $productId); -$stmt2 = sqlsrv_query( $conn, $sql2, $params2 ); - -/* If both queries were successful, commit the transaction. */ -/* Otherwise, rollback the transaction. */ -if( $stmt1 && $stmt2 ) { - sqlsrv_commit( $conn ); - echo "Transaction committed.
    "; -} else { - sqlsrv_rollback( $conn ); - echo "Transaction rolled back.
    "; -} -?> -]]> -
    -
    -
    - - - &reftitle.seealso; - - sqlsrv_begin_transaction - sqlsrv_commit - - -
    - diff --git a/reference/sqlsrv/functions/sqlsrv-rows-affected.xml b/reference/sqlsrv/functions/sqlsrv-rows-affected.xml deleted file mode 100644 index fd42ec1fea31..000000000000 --- a/reference/sqlsrv/functions/sqlsrv-rows-affected.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - sqlsrv_rows_affected - Returns the number of rows modified by the last INSERT, UPDATE, or - DELETE query executed - - - &reftitle.description; - - intfalsesqlsrv_rows_affected - resourcestmt - - - Returns the number of rows modified by the last INSERT, UPDATE, or DELETE - query executed. For information about the number of rows returned by a SELECT - query, see sqlsrv_num_rows. - - - - - &reftitle.parameters; - - - stmt - - - The executed statement resource for which the number of affected rows is returned. - - - - - - - - &reftitle.returnvalues; - - Returns the number of rows affected by the last INSERT, UPDATE, or DELETE query. - If no rows were affected, 0 is returned. If the number of affected rows cannot - be determined, -1 is returned. If an error occurred, &false; is returned. - - - - - &reftitle.examples; - - <function>sqlsrv_rows_affected</function> example - -"dbName", "UID"=>"username", "PWD"=>"password" ); -$conn = sqlsrv_connect( $serverName, $connectionInfo); -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -$sql = "UPDATE Table_1 SET data = ? WHERE id = ?"; - -$params = array("updated data", 1); - -$stmt = sqlsrv_query( $conn, $sql, $params); - -$rows_affected = sqlsrv_rows_affected( $stmt); -if( $rows_affected === false) { - die( print_r( sqlsrv_errors(), true)); -} elseif( $rows_affected == -1) { - echo "No information available.
    "; -} else { - echo $rows_affected." rows were updated.
    "; -} -?> -]]> -
    -
    -
    - - - &reftitle.seealso; - - sqlsrv_num_rows - - -
    - diff --git a/reference/sqlsrv/functions/sqlsrv-send-stream-data.xml b/reference/sqlsrv/functions/sqlsrv-send-stream-data.xml deleted file mode 100644 index 19b78c7d1548..000000000000 --- a/reference/sqlsrv/functions/sqlsrv-send-stream-data.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - sqlsrv_send_stream_data - Sends data from parameter streams to the server - - - &reftitle.description; - - boolsqlsrv_send_stream_data - resourcestmt - - - Send data from parameter streams to the server. Up to 8 KB of data is sent - with each call. - - - - - &reftitle.parameters; - - - stmt - - - A statement resource returned by sqlsrv_query or - sqlsrv_execute. - - - - - - - - &reftitle.returnvalues; - - Returns &true; if there is more data to send and &false; if there is not. - - - - - &reftitle.examples; - - <function>sqlsrv_send_stream_data</function> example - -"dbName", "UID"=>"username", "PWD"=>"password" ); -$conn = sqlsrv_connect( $serverName, $connectionInfo); -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -$sql = "UPDATE Table_1 SET data = ( ?) WHERE id = 100"; - -// Open parameter data as a stream and put it in the $params array. -$data = fopen( "data://text/plain,[ Lengthy content here. ]", "r"); -$params = array( &$data); - -// Prepare the statement. Use the $options array to turn off the -// default behavior, which is to send all stream data at the time of query -// execution. -$options = array("SendStreamParamsAtExec"=>0); -$stmt = sqlsrv_prepare( $conn, $sql, $params, $options); - -sqlsrv_execute( $stmt); - -// Send up to 8K of parameter data to the server -// with each call to sqlsrv_send_stream_data. -$i = 1; -while( sqlsrv_send_stream_data( $stmt)) { - $i++; -} -echo "$i calls were made."; -?> -]]> - - - - - - &reftitle.seealso; - - sqlsrv_prepare - sqlsrv_query - - - - diff --git a/reference/sqlsrv/functions/sqlsrv-server-info.xml b/reference/sqlsrv/functions/sqlsrv-server-info.xml deleted file mode 100644 index 3cded37ca7a6..000000000000 --- a/reference/sqlsrv/functions/sqlsrv-server-info.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - sqlsrv_server_info - Returns information about the server - - - &reftitle.description; - - arraysqlsrv_server_info - resourceconn - - - Returns information about the server. - - - - - &reftitle.parameters; - - - conn - - - The connection resource that connects the client and the server. - - - - - - - - &reftitle.returnvalues; - - Returns an array as described in the following table: - - Returned Array - - - - CurrentDatabase - The connected-to database. - - - - - SQLServerVersion - The SQL Server version. - - - SQLServerName - The name of the server. - - - -
    -
    -
    - - - &reftitle.examples; - - <function>sqlsrv_server_info</function> example - - $value) { - echo $key.": ".$value."
    "; - } -} else { - die( print_r( sqlsrv_errors(), true)); -} -?> -]]> -
    -
    -
    - - - &reftitle.seealso; - - sqlsrv_client_info - - -
    - diff --git a/reference/sqlsrv/ini.xml b/reference/sqlsrv/ini.xml deleted file mode 100644 index d1399f268fc5..000000000000 --- a/reference/sqlsrv/ini.xml +++ /dev/null @@ -1,80 +0,0 @@ - - -
    - &reftitle.runtime; - &extension.runtime; - The following table lists the configuration options available in the SQLSRV - extension. For more information about these options, see - Handling SQLSRV Warnings and Errors. - - SQLSRV &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - sqlsrv.WarningsReturnAsErrors - 1 (&true;) - INI_ALL - Available since SQLSRV 1.0 - - - sqlsrv.LogSubsystems - 0 - INI_ALL - Available since SQLSRV 1.0 - - - sqlsrv.LogSeverity - 1 - INI_ALL - Available since SQLSRV 1.0 - - - -
    - - -
    - diff --git a/reference/sqlsrv/reference.xml b/reference/sqlsrv/reference.xml deleted file mode 100644 index d95e3a6f9ff0..000000000000 --- a/reference/sqlsrv/reference.xml +++ /dev/null @@ -1,36 +0,0 @@ - - - - - SQLSRV &Functions; - - - -&reference.sqlsrv.entities.functions; - - - - \ No newline at end of file diff --git a/reference/sqlsrv/setup.xml b/reference/sqlsrv/setup.xml deleted file mode 100644 index 802a26873a9e..000000000000 --- a/reference/sqlsrv/setup.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - &reftitle.setup; - - -
    - &reftitle.required; - - The SQLSRV extension can be used on the following operating systems: - - Windows Vista Service Pack 2 or later - Windows Server 2008 Service Pack 2 or later - Windows Server 2008 R2 - Windows 7 - - - - The SQLSRV extension requires that the Microsoft SQL Server 2012 Native - Client be installed on the same computer that is running PHP. If the Microsoft - SQL Server 2012 Native Client is not already installed, click the appropriate link below - to download it: - - Download the x86 package - Download the x64 package - - - - The SQLSRV download comes 8 driver files, four of which are for PDO support. - - - The most recent version of the driver is available for download here: - SQLSRV download. - - - For more information about SQLSRV requirements, see - SQLSRV System Requirements. - -
    - - - - &reference.sqlsrv.configure; - - - - &reference.sqlsrv.ini; - - - -
    - &reftitle.resources; -
    - Connection resource - - A connection resource returned by sqlsrv_connect. - -
    -
    - Statement resource - - A statement resource returned by sqlsrv_query or by - sqlsrv_prepare. - -
    -
    - - -
    - diff --git a/reference/ssdeep/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/ssdeep/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/ssdeep/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/ssdeep/book.xml b/reference/ssdeep/book.xml deleted file mode 100644 index 198cd3fe3913..000000000000 --- a/reference/ssdeep/book.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - ssdeep Fuzzy Hashing - ssdeep - - - &reftitle.intro; - - ssdeep is a utility for creating and comparing fuzzy hashes or - context-triggered piecewise - hashing. - - - Fuzzy hashing can match signatures which have "...sequences of identical - bytes in the same order, although bytes in between these sequences - may be different in both content and length" ( - ssdeep project page). - - - This extension provides functions for creating and comparing fuzzy hashes. - - - - &reference.ssdeep.setup; - - &reference.ssdeep.reference; - - - diff --git a/reference/ssdeep/configure.xml b/reference/ssdeep/configure.xml deleted file mode 100644 index 3dd67e0c645a..000000000000 --- a/reference/ssdeep/configure.xml +++ /dev/null @@ -1,31 +0,0 @@ - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;ssdeep - - -
    - diff --git a/reference/ssdeep/functions/ssdeep-fuzzy-compare.xml b/reference/ssdeep/functions/ssdeep-fuzzy-compare.xml deleted file mode 100644 index 797b2bcac424..000000000000 --- a/reference/ssdeep/functions/ssdeep-fuzzy-compare.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - ssdeep_fuzzy_compare - Calculates the match score between two fuzzy hash signatures - - - - &reftitle.description; - - intssdeep_fuzzy_compare - stringsignature1 - stringsignature2 - - - Calculates the match score between signature1 - and signature2 using - context-triggered piecewise hashing, and returns the match - score. - - - - - - &reftitle.parameters; - - - signature1 - - - The first fuzzy hash signature string. - - - - - signature2 - - - The second fuzzy hash signature string. - - - - - - - - &reftitle.returnvalues; - - Returns an integer from 0 to 100 on success, &false; otherwise. - - - - - - diff --git a/reference/ssdeep/functions/ssdeep-fuzzy-hash-filename.xml b/reference/ssdeep/functions/ssdeep-fuzzy-hash-filename.xml deleted file mode 100644 index 7de46bd82be7..000000000000 --- a/reference/ssdeep/functions/ssdeep-fuzzy-hash-filename.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - ssdeep_fuzzy_hash_filename - Create a fuzzy hash from a file - - - - &reftitle.description; - - stringssdeep_fuzzy_hash_filename - stringfile_name - - - ssdeep_fuzzy_hash_filename calculates the hash - of the file specified by file_name using - context-triggered piecewise - hashing, and returns that hash. - - - - - - &reftitle.parameters; - - - file_name - - - The filename of the file to hash. - - - - - - - - &reftitle.returnvalues; - - Returns a string on success, &false; otherwise. - - - - - - diff --git a/reference/ssdeep/functions/ssdeep-fuzzy-hash.xml b/reference/ssdeep/functions/ssdeep-fuzzy-hash.xml deleted file mode 100644 index 4c2aced18bb0..000000000000 --- a/reference/ssdeep/functions/ssdeep-fuzzy-hash.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - ssdeep_fuzzy_hash - Create a fuzzy hash from a string - - - - &reftitle.description; - - stringssdeep_fuzzy_hash - stringto_hash - - - ssdeep_fuzzy_hash calculates the hash of - to_hash using - context-triggered piecewise hashing, and returns that hash. - - - - - &reftitle.parameters; - - - to_hash - - - The input string. - - - - - - - - &reftitle.returnvalues; - - Returns a string on success, &false; otherwise. - - - - - - diff --git a/reference/ssdeep/reference.xml b/reference/ssdeep/reference.xml deleted file mode 100644 index 2f676bbcd5e4..000000000000 --- a/reference/ssdeep/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - ssdeep &Functions; - - &reference.ssdeep.entities.functions; - - - - diff --git a/reference/ssdeep/setup.xml b/reference/ssdeep/setup.xml deleted file mode 100644 index f1e004cb902b..000000000000 --- a/reference/ssdeep/setup.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - &reftitle.setup; - -
    - &reftitle.required; - - This extension requires the ssdeep library. - -
    - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;ssdeep. - -
    - -
    - diff --git a/reference/ssdeep/versions.xml b/reference/ssdeep/versions.xml deleted file mode 100644 index 50afdc4514b8..000000000000 --- a/reference/ssdeep/versions.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - - - - - - diff --git a/reference/ssh2/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/ssh2/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/ssh2/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/ssh2/book.xml b/reference/ssh2/book.xml deleted file mode 100644 index dea838953a16..000000000000 --- a/reference/ssh2/book.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - Secure Shell2 - SSH2 - - - - &reftitle.intro; - - Bindings to the libssh2 library which - provide access to resources (shell, remote exec, tunneling, file transfer) - on a remote machine using a secure cryptographic transport. - - - - - &reference.ssh2.setup; - &reference.ssh2.constants; - &reference.ssh2.reference; - - - diff --git a/reference/ssh2/constants.xml b/reference/ssh2/constants.xml deleted file mode 100644 index 922a949df1bb..000000000000 --- a/reference/ssh2/constants.xml +++ /dev/null @@ -1,260 +0,0 @@ - - - - &reftitle.constants; - &extension.constants; - - - - SSH2_FINGERPRINT_MD5 - (int) - - - - Flag to ssh2_fingerprint requesting hostkey - fingerprint as an MD5 hash. - - - - - - SSH2_FINGERPRINT_SHA1 - (int) - - - - Flag to ssh2_fingerprint requesting hostkey - fingerprint as an SHA1 hash. - - - - - - SSH2_FINGERPRINT_HEX - (int) - - - - Flag to ssh2_fingerprint requesting hostkey - fingerprint as a string of hexits. - - - - - - SSH2_FINGERPRINT_RAW - (int) - - - - Flag to ssh2_fingerprint requesting hostkey - fingerprint as a raw string of 8-bit characters. - - - - - - SSH2_TERM_UNIT_CHARS - (int) - - - - Flag to ssh2_shell specifying that - width and height - are provided as character sizes. - - - - - - SSH2_TERM_UNIT_PIXELS - (int) - - - - Flag to ssh2_shell specifying that - width and height - are provided in pixel units. - - - - - - SSH2_DEFAULT_TERM_WIDTH - (int) - - - - Default terminal width requested by ssh2_shell. - - - - - - SSH2_DEFAULT_TERM_HEIGHT - (int) - - - - Default terminal height requested by ssh2_shell. - - - - - - SSH2_DEFAULT_TERM_UNIT - (int) - - - - Default terminal units requested by ssh2_shell. - - - - - - SSH2_STREAM_STDIO - (int) - - - - Flag to ssh2_fetch_stream requesting STDIO subchannel. - - - - - - SSH2_STREAM_STDERR - (int) - - - - Flag to ssh2_fetch_stream requesting STDERR subchannel. - - - - - - SSH2_DEFAULT_TERMINAL - (string) - - - - Default terminal type (e.g. vt102, ansi, xterm, vanilla) requested - by ssh2_shell. - - - - - - SSH2_POLLIN - (int) - - - - - - - - - SSH2_POLLEXT - (int) - - - - - - - - - SSH2_POLLOUT - (int) - - - - - - - - - SSH2_POLLERR - (int) - - - - - - - - - SSH2_POLLHUP - (int) - - - - - - - - - SSH2_POLLNVAL - (int) - - - - - - - - - SSH2_POLL_SESSION_CLOSED - (int) - - - - - - - - - SSH2_POLL_CHANNEL_CLOSED - (int) - - - - - - - - - SSH2_POLL_LISTENER_CLOSED - (int) - - - - - - - - - - diff --git a/reference/ssh2/functions/ssh2-auth-agent.xml b/reference/ssh2/functions/ssh2-auth-agent.xml deleted file mode 100644 index fa8e7c166c19..000000000000 --- a/reference/ssh2/functions/ssh2-auth-agent.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - ssh2_auth_agent - Authenticate over SSH using the ssh agent - - - - &reftitle.description; - - boolssh2_auth_agent - resourcesession - stringusername - - - Authenticate over SSH using the ssh agent - - - - The ssh2_auth_agent function will only be available - when the ssh2 extension is compiled with libssh2 >= 1.2.3. - - - - - - &reftitle.parameters; - - - session - - - An SSH connection link identifier, obtained from a call to - ssh2_connect. - - - - - username - - - Remote user name. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Authenticating with a ssh agent - - -]]> - - - - - - diff --git a/reference/ssh2/functions/ssh2-auth-hostbased-file.xml b/reference/ssh2/functions/ssh2-auth-hostbased-file.xml deleted file mode 100644 index c567433019a9..000000000000 --- a/reference/ssh2/functions/ssh2-auth-hostbased-file.xml +++ /dev/null @@ -1,147 +0,0 @@ - - - - - ssh2_auth_hostbased_file - Authenticate using a public hostkey - - - - &reftitle.description; - - boolssh2_auth_hostbased_file - resourcesession - stringusername - stringhostname - stringpubkeyfile - stringprivkeyfile - stringpassphrase - stringlocal_username - - - Authenticate using a public hostkey read from a file. - - - - - &reftitle.parameters; - - - session - - - An SSH connection link identifier, obtained from a call to - ssh2_connect. - - - - - username - - - - - - - hostname - - - - - - - pubkeyfile - - - - - - - privkeyfile - - - - - - - passphrase - - - If privkeyfile is encrypted (which it should - be), the passphrase must be provided. - - - - - local_username - - - If local_username is omitted, then the value - for username will be used for it. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Authentication using a public hostkey - -'ssh-rsa')); - -if (ssh2_auth_hostbased_file($connection, 'remoteusername', 'myhost.example.com', - '/usr/local/etc/hostkey_rsa.pub', - '/usr/local/etc/hostkey_rsa', 'secret', - 'localusername')) { - echo "Public Key Hostbased Authentication Successful\n"; -} else { - die('Public Key Hostbased Authentication Failed'); -} -?> -]]> - - - - - - &reftitle.notes; - - - ssh2_auth_hostbased_file requires libssh2 >= 0.7 and - PHP/SSH2 >= 0.7 - - - - - - diff --git a/reference/ssh2/functions/ssh2-auth-none.xml b/reference/ssh2/functions/ssh2-auth-none.xml deleted file mode 100644 index 153f99c66221..000000000000 --- a/reference/ssh2/functions/ssh2-auth-none.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - ssh2_auth_none - Authenticate as "none" - - - - &reftitle.description; - - mixedssh2_auth_none - resourcesession - stringusername - - - Attempt "none" authentication which usually will (and should) fail. - As part of the failure, this function will return an array of accepted - authentication methods. - - - - - &reftitle.parameters; - - - session - - - An SSH connection link identifier, obtained from a call to - ssh2_connect. - - - - - username - - - Remote user name. - - - - - - - - &reftitle.returnvalues; - - Returns &true; if the server does accept "none" as an authentication - method, or an array of accepted authentication methods on failure. - - - - - &reftitle.examples; - - Retrieving a list of authentication methods - - -]]> - - - - - - diff --git a/reference/ssh2/functions/ssh2-auth-password.xml b/reference/ssh2/functions/ssh2-auth-password.xml deleted file mode 100644 index 8710f9c907bc..000000000000 --- a/reference/ssh2/functions/ssh2-auth-password.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - ssh2_auth_password - Authenticate over SSH using a plain password - - - - &reftitle.description; - - boolssh2_auth_password - resourcesession - stringusername - stringpassword - - - Authenticate over SSH using a plain password. Since version 0.12 this function - also supports keyboard_interactive method. - - - - - &reftitle.parameters; - - - session - - - An SSH connection link identifier, obtained from a call to - ssh2_connect. - - - - - username - - - Remote user name. - - - - - password - - - Password for username - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Authenticating with a password - - -]]> - - - - - - diff --git a/reference/ssh2/functions/ssh2-auth-pubkey-file.xml b/reference/ssh2/functions/ssh2-auth-pubkey-file.xml deleted file mode 100644 index 8519a945c14b..000000000000 --- a/reference/ssh2/functions/ssh2-auth-pubkey-file.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - ssh2_auth_pubkey_file - Authenticate using a public key read from a file - - - - &reftitle.description; - - boolssh2_auth_pubkey_file - resourcesession - stringusername - stringpubkeyfile - stringprivkeyfile - stringpassphrase - - - Authenticate using a public key read from a file. - - - - - &reftitle.parameters; - - - session - - - An SSH connection link identifier, obtained from a call to - ssh2_connect. - - - - - username - - - Name of the user to authenticate as on the remote server. - - - - - pubkeyfile - - - The public key file needs to be in OpenSSH's format. It should look something like: - - - ssh-rsa AAAAB3NzaC1yc2EAAA....NX6sqSnHA8= rsa-key-20121110 - - - - - privkeyfile - - - - - - - passphrase - - - If privkeyfile is encrypted (which it should - be), the passphrase must be provided. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Authentication using a public key - -'ssh-rsa')); - -if (ssh2_auth_pubkey_file($connection, 'username', - '/home/username/.ssh/id_rsa.pub', - '/home/username/.ssh/id_rsa', 'secret')) { - echo "Public Key Authentication Successful\n"; -} else { - die('Public Key Authentication Failed'); -} -?> -]]> - - - - - - &reftitle.notes; - - - The underlying libssh2 library doesn't support partial auths very cleanly. - That is, if you need to supply both a public key and a password it will - appear as if this function has failed. In this particular case a failure - from this call may just mean that auth hasn't been completed yet. You - would need to ignore this failure and continue on and call - ssh2_auth_password in order to complete - authentication. - - - - - - &reftitle.seealso; - - ssh2_auth_pubkey - - - - - diff --git a/reference/ssh2/functions/ssh2-auth-pubkey.xml b/reference/ssh2/functions/ssh2-auth-pubkey.xml deleted file mode 100644 index a8661f8e3954..000000000000 --- a/reference/ssh2/functions/ssh2-auth-pubkey.xml +++ /dev/null @@ -1,147 +0,0 @@ - - - - - ssh2_auth_pubkey - Authenticate using a public key in a variable - - - - &reftitle.description; - - boolssh2_auth_pubkey - resourcesession - stringusername - stringpubkey - stringprivkey - stringpassphrase - - - Authenticate using a public key in a variable. - - - - - &reftitle.parameters; - - - session - - - An SSH connection link identifier, obtained from a call to - ssh2_connect. - - - - - username - - - Name of the user to authenticate as on the remote server. - - - - - pubkey - - - Public key in OpenSSH's format. It should look something like: - ssh-rsa AAAAB3NzaC1yc2EAAA....NX6sqSnHA8= rsa-key-20121110 - - - - - privkey - - - Private OpenSSH key. It should begin with: - -----BEGIN RSA PRIVATE KEY----- - - - - - passphrase - - - If privkey is encrypted (which it should - be), the passphrase must be provided. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Authentication using a public key - -'ssh-rsa')); -$publicKey = file_get_contents('/home/username/.ssh/id_rsa.pub'); -$privateKey = file_get_contents('/home/username/.ssh/id_rsa'); - -if (ssh2_auth_pubkey($connection, 'username', - $publicKey, - $privateKey, 'secret')) { - echo "Public Key Authentication Successful\n"; -} else { - die('Public Key Authentication Failed'); -} -?> -]]> - - - - - - &reftitle.notes; - - - The underlying libssh2 library doesn't support partial auths very cleanly. - That is, if you need to supply both a public key and a password it will - appear as if this function has failed. In this particular case a failure - from this call may just mean that auth hasn't been completed yet. You - would need to ignore this failure and continue on and call - ssh2_auth_password in order to complete - authentication. - - - - - - &reftitle.seealso; - - ssh2_auth_pubkey_file - - - - - diff --git a/reference/ssh2/functions/ssh2-connect.xml b/reference/ssh2/functions/ssh2-connect.xml deleted file mode 100644 index 5a6ce331655b..000000000000 --- a/reference/ssh2/functions/ssh2-connect.xml +++ /dev/null @@ -1,317 +0,0 @@ - - - - - ssh2_connect - Connect to an SSH server - - - - &reftitle.description; - - resourcefalsessh2_connect - stringhost - intport22 - arraymethods - arraycallbacks - - - Establish a connection to a remote SSH server. - - - Once connected, the client should verify the server's hostkey using - ssh2_fingerprint, then authenticate using either - password or public key. - - - - - &reftitle.parameters; - - - host - - - - - - - port - - - - - - - methods - - - methods may be an associative array with up to four parameters - as described below. - - - <parameter>methods</parameter> may be an associative array - with any or all of the following parameters. - - - - Index - Meaning - Supported Values* - - - - - kex - - List of key exchange methods to advertise, comma separated - in order of preference. - - - diffie-hellman-group1-sha1, - diffie-hellman-group14-sha1, and - diffie-hellman-group-exchange-sha1 - - - - hostkey - - List of hostkey methods to advertise, comma separated - in order of preference. - - - ssh-rsa and - ssh-dss - - - - client_to_server - - Associative array containing crypt, compression, and - message authentication code (MAC) method preferences - for messages sent from client to server. - - - - - server_to_client - - Associative array containing crypt, compression, and - message authentication code (MAC) method preferences - for messages sent from server to client. - - - - - -
    - - * - Supported Values are dependent on methods supported by underlying library. - See libssh2 documentation for additional - information. - - - - <parameter>client_to_server</parameter> and - <parameter>server_to_client</parameter> may be an associative array - with any or all of the following parameters. - - - - - Index - Meaning - Supported Values* - - - - - crypt - List of crypto methods to advertise, comma separated - in order of preference. - - rijndael-cbc@lysator.liu.se, - aes256-cbc, - aes192-cbc, - aes128-cbc, - 3des-cbc, - blowfish-cbc, - cast128-cbc, - arcfour, and - none** - - - - comp - List of compression methods to advertise, comma separated - in order of preference. - - zlib and - none - - - - mac - List of MAC methods to advertise, comma separated - in order of preference. - - hmac-sha1, - hmac-sha1-96, - hmac-ripemd160, - hmac-ripemd160@openssh.com, and - none** - - - - -
    - - Crypt and MAC method "<literal>none</literal>" - - For security reasons, none is disabled by the underlying - libssh2 library unless explicitly enabled - during build time by using the appropriate ./configure options. See documentation - for the underlying library for more information. - - -
    -
    - - callbacks - - - callbacks may be an associative array with any - or all of the following parameters. - - - Callbacks parameters - - - - - Index - Meaning - Prototype - - - - - ignore - - Name of function to call when an - SSH2_MSG_IGNORE packet is received - - void ignore_cb($message) - - - debug - - Name of function to call when an - SSH2_MSG_DEBUG packet is received - - void debug_cb($message, $language, $always_display) - - - macerror - - Name of function to call when a packet is received but the - message authentication code failed. If the callback returns - &true;, the mismatch will be ignored, otherwise the connection - will be terminated. - - bool macerror_cb($packet) - - - disconnect - - Name of function to call when an - SSH2_MSG_DISCONNECT packet is received - - void disconnect_cb($reason, $message, $language) - - - -
    -
    -
    -
    -
    -
    - - - &reftitle.returnvalues; - - Returns a resource on success, or &false; on error. - - - - - &reftitle.examples; - - <function>ssh2_connect</function> example - - Open a connection forcing 3des-cbc when sending packets, any strength - aes cipher when receiving packets, no compression in either direction, - and Group1 key exchange. - - - 'diffie-hellman-group1-sha1', - 'client_to_server' => array( - 'crypt' => '3des-cbc', - 'comp' => 'none'), - 'server_to_client' => array( - 'crypt' => 'aes256-cbc,aes192-cbc,aes128-cbc', - 'comp' => 'none')); - -$callbacks = array('disconnect' => 'my_ssh_disconnect'); - -$connection = ssh2_connect('shell.example.com', 22, $methods, $callbacks); -if (!$connection) die('Connection failed'); -?> -]]> - - - - - - &reftitle.seealso; - - ssh2_fingerprint - ssh2_auth_none - ssh2_auth_password - ssh2_auth_pubkey - ssh2_auth_pubkey_file - ssh2_disconnect - - - -
    - diff --git a/reference/ssh2/functions/ssh2-disconnect.xml b/reference/ssh2/functions/ssh2-disconnect.xml deleted file mode 100644 index 71ca2cfcd979..000000000000 --- a/reference/ssh2/functions/ssh2-disconnect.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - ssh2_disconnect - Close a connection to a remote SSH server - - - - &reftitle.description; - - boolssh2_disconnect - resourcesession - - - Close a connection to a remote SSH server. - - - - - &reftitle.parameters; - - - session - - - An SSH connection link identifier, obtained from a call to - ssh2_connect. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - ssh2_connect - - - - - diff --git a/reference/ssh2/functions/ssh2-exec.xml b/reference/ssh2/functions/ssh2-exec.xml deleted file mode 100644 index 10068837fa8a..000000000000 --- a/reference/ssh2/functions/ssh2-exec.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - ssh2_exec - Execute a command on a remote server - - - - &reftitle.description; - - resourcefalsessh2_exec - resourcesession - stringcommand - stringpty - arrayenv - intwidth80 - intheight25 - intwidth_height_typeSSH2_TERM_UNIT_CHARS - - - Execute a command at the remote end and allocate a channel for it. - - - - - &reftitle.parameters; - - - session - - - An SSH connection link identifier, obtained from a call to - ssh2_connect. - - - - - command - - - - - - - pty - - - - - - - env - - - env may be passed as an associative array of - name/value pairs to set in the target environment. - - - - - width - - - Width of the virtual terminal. - - - - - height - - - Height of the virtual terminal. - - - - - width_height_type - - - width_height_type should be one of - SSH2_TERM_UNIT_CHARS or - SSH2_TERM_UNIT_PIXELS. - - - - - - - - &reftitle.returnvalues; - - Returns a stream on success&return.falseforfailure;. - - - - - &reftitle.examples; - - Executing a command - - -]]> - - - - - - &reftitle.seealso; - - ssh2_connect - ssh2_shell - ssh2_tunnel - - - - - diff --git a/reference/ssh2/functions/ssh2-fetch-stream.xml b/reference/ssh2/functions/ssh2-fetch-stream.xml deleted file mode 100644 index 0a7f07fb5b91..000000000000 --- a/reference/ssh2/functions/ssh2-fetch-stream.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - ssh2_fetch_stream - Fetch an extended data stream - - - - &reftitle.description; - - resourcessh2_fetch_stream - resourcechannel - intstreamid - - - Fetches an alternate substream associated with an SSH2 channel stream. - The SSH2 protocol currently defines only one substream, STDERR, which has - a substream ID of SSH2_STREAM_STDERR (defined as 1). - - - - - &reftitle.parameters; - - - channel - - - - - - - streamid - - - An SSH2 channel stream. - - - - - - - - &reftitle.returnvalues; - - Returns the requested stream resource. - - - - - &reftitle.examples; - - Opening a shell and retrieving the stderr stream associated with it - - -]]> - - - - - - &reftitle.seealso; - - ssh2_shell - ssh2_exec - ssh2_connect - - - - - diff --git a/reference/ssh2/functions/ssh2-fingerprint.xml b/reference/ssh2/functions/ssh2-fingerprint.xml deleted file mode 100644 index 09f0f3c9ed8d..000000000000 --- a/reference/ssh2/functions/ssh2-fingerprint.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - ssh2_fingerprint - Retrieve fingerprint of remote server - - - - &reftitle.description; - - stringssh2_fingerprint - resourcesession - intflagsSSH2_FINGERPRINT_MD5 | SSH2_FINGERPRINT_HEX - - - Returns a server hostkey hash from an active session. - - - - - &reftitle.parameters; - - - session - - - An SSH connection link identifier, obtained from a call to - ssh2_connect. - - - - - flags - - - flags may be either of - SSH2_FINGERPRINT_MD5 or - SSH2_FINGERPRINT_SHA1 logically ORed with - SSH2_FINGERPRINT_HEX or - SSH2_FINGERPRINT_RAW. - - - - - - - - &reftitle.returnvalues; - - Returns the hostkey hash as a string. - - - - - &reftitle.examples; - - Checking the fingerprint against a known value - - -]]> - - - - - - diff --git a/reference/ssh2/functions/ssh2-forward-accept.xml b/reference/ssh2/functions/ssh2-forward-accept.xml deleted file mode 100644 index ad1fa84c802d..000000000000 --- a/reference/ssh2/functions/ssh2-forward-accept.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - ssh2_forward_accept - Accept a connection created by a listener - - - - &reftitle.description; - - resourcefalsessh2_forward_accept - resourcelistener - - - Accepts a connection created by a listener. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - desc - - - An SSH2 Listener resource, obtained from a call to ssh2_forward_listen. - - - - - - - - &reftitle.returnvalues; - - Returns a stream resource, &return.falseforfailure;. - - - - - diff --git a/reference/ssh2/functions/ssh2-forward-listen.xml b/reference/ssh2/functions/ssh2-forward-listen.xml deleted file mode 100644 index 17eca78e274d..000000000000 --- a/reference/ssh2/functions/ssh2-forward-listen.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - ssh2_forward_listen - Bind a port on the remote server and listen for connections - - - - &reftitle.description; - - resourcefalsessh2_forward_listen - resourcesession - intport - stringhost - intmax_connections16 - - - Binds a port on the remote server and listen for connections. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - session - - - An SSH Session resource, obtained from a call to ssh2_connect. - - - - - port - - - The port of the remote server. - - - - - host - - - - - - - - max_connections - - - - - - - - - - - &reftitle.returnvalues; - - Returns an SSH2 Listener, &return.falseforfailure;. - - - - - &reftitle.seealso; - - ssh2_forward_accept - - - - diff --git a/reference/ssh2/functions/ssh2-keepalive-config.xml b/reference/ssh2/functions/ssh2-keepalive-config.xml deleted file mode 100644 index 62bce7d002ce..000000000000 --- a/reference/ssh2/functions/ssh2-keepalive-config.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - ssh2_keepalive_config - Configure how often keepalive messages should be sent - - - - &reftitle.description; - - voidssh2_keepalive_config - resourcesession - boolwant_reply - intinterval - - - Configures how often keepalive messages are sent on the given - session, and whether the server is asked to reply to - them. - - - Keepalive messages are not sent automatically. Once configured, - ssh2_keepalive_send must be called to actually send a - keepalive message. - - - - This function is only available when the extension is built against a - libssh2 version providing keepalive support. - - - - - - &reftitle.parameters; - - - session - - - An SSH connection link identifier, obtained from a call to - ssh2_connect. - - - - - want_reply - - - Whether the server is requested to reply to keepalive messages. - Requesting a reply makes an unresponsive server detectable, at the cost - of some extra traffic. - - - - - interval - - - The number of seconds that may pass without any traffic before a - keepalive message should be sent. A value of 0 - disables keepalive messages, and a value of 1 is - treated as 2 by the underlying library. - - - Accepted values range from 0 to - 4294967295. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - An E_WARNING is emitted when - interval is outside the accepted range, in which - case the keepalive configuration is left unchanged. - - - - - &reftitle.examples; - - Sending keepalive messages - - -]]> - - - - - - &reftitle.seealso; - - ssh2_keepalive_send - ssh2_connect - - - - - diff --git a/reference/ssh2/functions/ssh2-keepalive-send.xml b/reference/ssh2/functions/ssh2-keepalive-send.xml deleted file mode 100644 index 1d33d312b31b..000000000000 --- a/reference/ssh2/functions/ssh2-keepalive-send.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - ssh2_keepalive_send - Send a keepalive message - - - - &reftitle.description; - - intfalsessh2_keepalive_send - resourcesession - - - Sends a keepalive message on the given session, - according to the configuration set with - ssh2_keepalive_config. - - - - This function is only available when the extension is built against a - libssh2 version providing keepalive support. - - - - - - &reftitle.parameters; - - - session - - - An SSH connection link identifier, obtained from a call to - ssh2_connect. - - - - - - - - &reftitle.returnvalues; - - Returns the number of seconds that may pass before another keepalive message - must be sent, or &false; on failure. 0 is returned when - keepalive messages are disabled. - - - Since 0 and &false; are both falsy, the - === operator has to be used to tell them apart. - - - - - &reftitle.examples; - - Sending a keepalive message - - -]]> - - - - - - &reftitle.seealso; - - ssh2_keepalive_config - ssh2_connect - - - - - diff --git a/reference/ssh2/functions/ssh2-methods-negotiated.xml b/reference/ssh2/functions/ssh2-methods-negotiated.xml deleted file mode 100644 index ffa7cb10dafc..000000000000 --- a/reference/ssh2/functions/ssh2-methods-negotiated.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - ssh2_methods_negotiated - Return list of negotiated methods - - - - &reftitle.description; - - arrayssh2_methods_negotiated - resourcesession - - - Returns list of negotiated methods. - - - - - &reftitle.parameters; - - - session - - - An SSH connection link identifier, obtained from a call to - ssh2_connect. - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Determining what methods were negotiated - - -]]> - - - - - - &reftitle.seealso; - - ssh2_connect - - - - - diff --git a/reference/ssh2/functions/ssh2-poll.xml b/reference/ssh2/functions/ssh2-poll.xml deleted file mode 100644 index 16a3ee8b161c..000000000000 --- a/reference/ssh2/functions/ssh2-poll.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - ssh2_poll - Poll the channels/listeners/streams for events - - - - &reftitle.description; - - intssh2_poll - arraydesc - inttimeout30 - - - Polls the channels/listeners/streams for events, - and returns the number of descriptors which returned non-zero revents. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - desc - - - An indexed array of subarrays with the keys - 'resource' and 'events'. - The value of the resource is a (channel) stream or an SSH2 Listener resource. - The value of the event are SSH2_POLL* flags bitwise ORed together. - Each subarray will be populated with an 'revents' element on return, - whose values are SSH2_POLL* flags bitwise ORed together of the events that occurred. - - - - - timeout - - - The timeout in seconds. - - - - - - - - &reftitle.returnvalues; - - Returns the number of descriptors which returned non-zero revents. - - - - - diff --git a/reference/ssh2/functions/ssh2-publickey-add.xml b/reference/ssh2/functions/ssh2-publickey-add.xml deleted file mode 100644 index 0b279afcef70..000000000000 --- a/reference/ssh2/functions/ssh2-publickey-add.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - ssh2_publickey_add - - Add an authorized publickey - - - - - &reftitle.description; - - boolssh2_publickey_add - resourcepkey - stringalgoname - stringblob - booloverwrite&false; - arrayattributes - - - ¬e.ssh2.subsystem.publickey; - - - - - &reftitle.parameters; - - - pkey - - - Publickey Subsystem resource created by ssh2_publickey_init. - - - - - algoname - - - Publickey algorithm (e.g.): ssh-dss, ssh-rsa - - - - - blob - - - Publickey blob as raw binary data - - - - - overwrite - - - If the specified key already exists, should it be overwritten? - - - - - attributes - - - Associative array of attributes to assign to this public key. - Refer to ietf-secsh-publickey-subsystem for a list of supported attributes. - To mark an attribute as mandatory, precede its name with an asterisk. - If the server is unable to support an attribute marked mandatory, - it will abort the add process. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Adding a publickey with <function>ssh2_publickey_add</function> - -"John's Key")); -?> -]]> - - - - - - &reftitle.seealso; - - ssh2_publickey_init - ssh2_publickey_remove - ssh2_publickey_list - - - - - diff --git a/reference/ssh2/functions/ssh2-publickey-init.xml b/reference/ssh2/functions/ssh2-publickey-init.xml deleted file mode 100644 index 88add4ed5f1b..000000000000 --- a/reference/ssh2/functions/ssh2-publickey-init.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - ssh2_publickey_init - - Initialize Publickey subsystem - - - - - &reftitle.description; - - resourcefalsessh2_publickey_init - resourcesession - - - Request the Publickey subsystem from an already connected SSH2 server. - - - The publickey subsystem allows an already connected and authenticated - client to manage the list of authorized public keys stored on the - target server in an implementation agnostic manner. - If the remote server does not support the publickey subsystem, - the ssh2_publickey_init function will return &false;. - - - - - &reftitle.parameters; - - - session - - - - - - - - - - &reftitle.returnvalues; - - Returns an SSH2 Publickey Subsystem resource for use - with all other ssh2_publickey_*() methods&return.falseforfailure;. - - - - - &reftitle.notes; - ¬e.ssh2.subsystem.publickey; - - - - &reftitle.seealso; - - ssh2_publickey_add - ssh2_publickey_remove - ssh2_publickey_list - - - - - diff --git a/reference/ssh2/functions/ssh2-publickey-list.xml b/reference/ssh2/functions/ssh2-publickey-list.xml deleted file mode 100644 index d2bf0f985b55..000000000000 --- a/reference/ssh2/functions/ssh2-publickey-list.xml +++ /dev/null @@ -1,153 +0,0 @@ - - - - - ssh2_publickey_list - - List currently authorized publickeys - - - - - &reftitle.description; - - arrayssh2_publickey_list - resourcepkey - - - List currently authorized publickeys. - - - - - &reftitle.parameters; - - - pkey - - - Publickey Subsystem resource - - - - - - - - &reftitle.returnvalues; - - Returns a numerically indexed array of keys, - each of which is an associative array containing: - name, blob, and attrs elements. - - - Publickey elements - - - - Array Key - Meaning - - - - - name - Name of algorithm used by this publickey, for example: - ssh-dss or ssh-rsa. - - - blob - Publickey blob as raw binary data. - - - attrs - Attributes assigned to this publickey. The most common - attribute, and the only one supported by publickey version 1 - servers, is comment, which may be any freeform - string. - - - -
    -
    - - - &reftitle.examples; - - Listing authorized keys with <function>ssh2_publickey_list</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.notes; - ¬e.ssh2.subsystem.publickey; - - - - &reftitle.seealso; - - ssh2_publickey_init - ssh2_publickey_add - ssh2_publickey_remove - - - -
    - diff --git a/reference/ssh2/functions/ssh2-publickey-remove.xml b/reference/ssh2/functions/ssh2-publickey-remove.xml deleted file mode 100644 index 317083d28595..000000000000 --- a/reference/ssh2/functions/ssh2-publickey-remove.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - ssh2_publickey_remove - - Remove an authorized publickey - - - - - &reftitle.description; - - boolssh2_publickey_remove - resourcepkey - stringalgoname - stringblob - - - Removes an authorized publickey. - - - - - &reftitle.parameters; - - - pkey - - - Publickey Subsystem Resource - - - - - algoname - - - Publickey algorithm (e.g.): ssh-dss, ssh-rsa - - - - - blob - - - Publickey blob as raw binary data - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.notes; - ¬e.ssh2.subsystem.publickey; - - - - &reftitle.seealso; - - ssh2_publickey_init - ssh2_publickey_add - ssh2_publickey_list - - - - diff --git a/reference/ssh2/functions/ssh2-scp-recv.xml b/reference/ssh2/functions/ssh2-scp-recv.xml deleted file mode 100644 index eb42d23f0127..000000000000 --- a/reference/ssh2/functions/ssh2-scp-recv.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - ssh2_scp_recv - Request a file via SCP - - - - &reftitle.description; - - boolssh2_scp_recv - resourcesession - stringremote_file - stringlocal_file - - - Copy a file from the remote server to the local filesystem using the SCP protocol. - - - - - &reftitle.parameters; - - - session - - - An SSH connection link identifier, obtained from a call to - ssh2_connect. - - - - - remote_file - - - Path to the remote file. - - - - - local_file - - - Path to the local file. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Downloading a file via SCP - - -]]> - - - - - - &reftitle.seealso; - - ssh2_scp_send - copy - - - - - diff --git a/reference/ssh2/functions/ssh2-scp-send.xml b/reference/ssh2/functions/ssh2-scp-send.xml deleted file mode 100644 index 210294f1a1db..000000000000 --- a/reference/ssh2/functions/ssh2-scp-send.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - ssh2_scp_send - Send a file via SCP - - - - &reftitle.description; - - boolssh2_scp_send - resourcesession - stringlocal_file - stringremote_file - intcreate_mode0644 - - - Copy a file from the local filesystem to the remote server using the SCP protocol. - - - - - &reftitle.parameters; - - - session - - - An SSH connection link identifier, obtained from a call to - ssh2_connect. - - - - - local_file - - - Path to the local file. - - - - - remote_file - - - Path to the remote file. - - - - - create_mode - - - The file will be created with the mode specified by - create_mode. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Uploading a file via SCP - - -]]> - - - - - - &reftitle.seealso; - - ssh2_scp_recv - copy - - - - - diff --git a/reference/ssh2/functions/ssh2-send-eof.xml b/reference/ssh2/functions/ssh2-send-eof.xml deleted file mode 100644 index 3cdff6f60dea..000000000000 --- a/reference/ssh2/functions/ssh2-send-eof.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - ssh2_send_eof - Send EOF to stream - - - - &reftitle.description; - - boolssh2_send_eof - resourcechannel - - - Sends an EOF to the stream; this is typically used to close standard input, - while keeping output and error alive. For example, one can send a remote - process some data over standard input, close it to start processing, and - still be able to read out the results without creating additional files. - - - - - &reftitle.parameters; - - - channel - - - An SSH stream; can be acquired through functions like ssh2_fetch_stream - or ssh2_connect. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - ssh2_fetch_stream - - - - - diff --git a/reference/ssh2/functions/ssh2-send-signal.xml b/reference/ssh2/functions/ssh2-send-signal.xml deleted file mode 100644 index d907bbc072a1..000000000000 --- a/reference/ssh2/functions/ssh2-send-signal.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - ssh2_send_signal - Send a signal to a remote process - - - - &reftitle.description; - - boolssh2_send_signal - resourcechannel - stringsignal - - - Sends a signal to the process running at the remote end of the given - channel. - - - - This function is only available when the extension is built against - libssh2 >= 1.9.0. - - - - - - &reftitle.parameters; - - - channel - - - An SSH channel stream, as returned by ssh2_exec or - ssh2_shell. - - - - - signal - - - The name of the signal to send, without the SIG - prefix, as defined by the SSH connection protocol - (RFC 4254); for - example TERM, KILL or - INT. - - - The value is forwarded to the server as is; it is not validated - against the names listed by the protocol. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - An E_WARNING is emitted when - channel is not an SSH channel stream, and when the - signal could not be sent. - - - - - &reftitle.examples; - - Interrupting a remote command - - -]]> - - - - - - &reftitle.seealso; - - ssh2_exec - ssh2_shell - ssh2_send_eof - - - - - diff --git a/reference/ssh2/functions/ssh2-set-timeout.xml b/reference/ssh2/functions/ssh2-set-timeout.xml deleted file mode 100644 index b90e8ec905d0..000000000000 --- a/reference/ssh2/functions/ssh2-set-timeout.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - ssh2_set_timeout - Set the timeout for blocking operations on a session - - - - &reftitle.description; - - voidssh2_set_timeout - resourcesession - intseconds - intmicroseconds0 - - - Sets how long a blocking operation on the given - session may wait before it is considered to have - timed out. - - - When the resulting timeout is 0, which is the default, - no timeout is applied and blocking operations may wait indefinitely. - - - - - &reftitle.parameters; - - - session - - - An SSH connection link identifier, obtained from a call to - ssh2_connect. - - - - - seconds - - - The timeout, in seconds. - - - - - microseconds - - - An additional number of microseconds added to the timeout. The - underlying library only supports millisecond precision, so this value - is rounded up to the next whole millisecond. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Limiting how long blocking operations may wait - - -]]> - - - - - - &reftitle.seealso; - - ssh2_connect - ssh2_keepalive_config - stream_set_timeout - - - - - diff --git a/reference/ssh2/functions/ssh2-sftp-chmod.xml b/reference/ssh2/functions/ssh2-sftp-chmod.xml deleted file mode 100644 index 2c4c01644b4d..000000000000 --- a/reference/ssh2/functions/ssh2-sftp-chmod.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - ssh2_sftp_chmod - Changes file mode - - - - &reftitle.description; - - boolssh2_sftp_chmod - resourcesftp - stringfilename - intmode - - - Attempts to change the mode of the specified file to that given in - mode. - - - - - &reftitle.parameters; - - - sftp - - - An SSH2 SFTP resource opened by ssh2_sftp. - - - - - filename - - - Path to the file. - - - - - mode - - - Permissions on the file. See the chmod for more details on this parameter. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Changing the mode of a file on a remote server - - -]]> - - - - - - &reftitle.seealso; - - chmod - ssh2_sftp - ssh2_connect - - - - - diff --git a/reference/ssh2/functions/ssh2-sftp-lstat.xml b/reference/ssh2/functions/ssh2-sftp-lstat.xml deleted file mode 100644 index c4543a9ad51f..000000000000 --- a/reference/ssh2/functions/ssh2-sftp-lstat.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - ssh2_sftp_lstat - Stat a symbolic link - - - - &reftitle.description; - - arrayfalsessh2_sftp_lstat - resourcesftp - stringpath - - - Stats a symbolic link on the remote filesystem without - following the link. - - - This function is similar to using the lstat function - with the ssh2.sftp:// wrapper - and returns the same values. - - - - - &reftitle.parameters; - - - sftp - - - An SSH2 SFTP resource opened by ssh2_sftp. - - - - - path - - - Path to the remote symbolic link. - - - - - - - - &reftitle.returnvalues; - - Returns an array of statistics for the given symbolic link on success&return.falseforfailure;. - See the documentation for stat for details on the - values which may be returned. - - - - - &reftitle.examples; - - Stating a symbolic link via SFTP - - -]]> - - - - - - &reftitle.seealso; - - ssh2_sftp_stat - lstat - stat - - - - - diff --git a/reference/ssh2/functions/ssh2-sftp-mkdir.xml b/reference/ssh2/functions/ssh2-sftp-mkdir.xml deleted file mode 100644 index 403c19e0951d..000000000000 --- a/reference/ssh2/functions/ssh2-sftp-mkdir.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - ssh2_sftp_mkdir - Create a directory - - - - &reftitle.description; - - boolssh2_sftp_mkdir - resourcesftp - stringdirname - intmode0777 - boolrecursive&false; - - - Creates a directory on the remote file server with permissions set to - mode. - - - This function is similar to using mkdir with the - ssh2.sftp:// wrapper. - - - - - &reftitle.parameters; - - - sftp - - - An SSH2 SFTP resource opened by ssh2_sftp. - - - - - dirname - - - Path of the new directory. - - - - - mode - - - Permissions on the new directory. - The actual mode is affected by the current umask. - - - - - recursive - - - If recursive is &true; any parent directories - required for dirname will be automatically created as well. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Creating a directory on a remote server - - -]]> - - - - - - &reftitle.seealso; - - mkdir - ssh2_sftp_rmdir - - - - - diff --git a/reference/ssh2/functions/ssh2-sftp-readlink.xml b/reference/ssh2/functions/ssh2-sftp-readlink.xml deleted file mode 100644 index 6f66e16929a4..000000000000 --- a/reference/ssh2/functions/ssh2-sftp-readlink.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - ssh2_sftp_readlink - Return the target of a symbolic link - - - - &reftitle.description; - - stringfalsessh2_sftp_readlink - resourcesftp - stringlink - - - Returns the target of a symbolic link. - - - - - &reftitle.parameters; - - - sftp - - - An SSH2 SFTP resource opened by ssh2_sftp. - - - - - link - - - Path of the symbolic link. - - - - - - - - &reftitle.returnvalues; - - Returns the target of the symbolic link&return.falseforfailure;. - - - - - &reftitle.examples; - - Reading a symbolic link - - -]]> - - - - - - &reftitle.seealso; - - readlink - ssh2_sftp_symlink - - - - - diff --git a/reference/ssh2/functions/ssh2-sftp-realpath.xml b/reference/ssh2/functions/ssh2-sftp-realpath.xml deleted file mode 100644 index cf75d3b0041b..000000000000 --- a/reference/ssh2/functions/ssh2-sftp-realpath.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - ssh2_sftp_realpath - Resolve the realpath of a provided path string - - - - &reftitle.description; - - stringfalsessh2_sftp_realpath - resourcesftp - stringfilename - - - Translates filename into the effective real path - on the remote filesystem. - - - - - &reftitle.parameters; - - - sftp - - - An SSH2 SFTP resource opened by ssh2_sftp. - - - - - filename - - - - - - - - - - &reftitle.returnvalues; - - Returns the real path as a string&return.falseforfailure;. - - - - - &reftitle.examples; - - Resolving a pathname - - -]]> - - - - - - &reftitle.seealso; - - realpath - ssh2_sftp_symlink - ssh2_sftp_readlink - - - - - diff --git a/reference/ssh2/functions/ssh2-sftp-rename.xml b/reference/ssh2/functions/ssh2-sftp-rename.xml deleted file mode 100644 index e0b4f4109777..000000000000 --- a/reference/ssh2/functions/ssh2-sftp-rename.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - ssh2_sftp_rename - Rename a remote file - - - - &reftitle.description; - - boolssh2_sftp_rename - resourcesftp - stringfrom - stringto - - - Renames a file on the remote filesystem. - - - - - &reftitle.parameters; - - - sftp - - - An SSH2 SFTP resource opened by ssh2_sftp. - - - - - from - - - The current file that is being renamed. - - - - - to - - - The new file name that replaces from. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Renaming a file via sftp - - -]]> - - - - - - &reftitle.seealso; - - rename - - - - - diff --git a/reference/ssh2/functions/ssh2-sftp-rmdir.xml b/reference/ssh2/functions/ssh2-sftp-rmdir.xml deleted file mode 100644 index efb33884bbe6..000000000000 --- a/reference/ssh2/functions/ssh2-sftp-rmdir.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - ssh2_sftp_rmdir - Remove a directory - - - - &reftitle.description; - - boolssh2_sftp_rmdir - resourcesftp - stringdirname - - - Removes a directory from the remote file server. - - - This function is similar to using rmdir with the - ssh2.sftp:// wrapper. - - - - - &reftitle.parameters; - - - sftp - - - An SSH2 SFTP resource opened by ssh2_sftp. - - - - - dirname - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Removing a directory on a remote server - - -]]> - - - - - - &reftitle.seealso; - - rmdir - ssh2_sftp_mkdir - - - - - diff --git a/reference/ssh2/functions/ssh2-sftp-stat.xml b/reference/ssh2/functions/ssh2-sftp-stat.xml deleted file mode 100644 index 7c42d5c41028..000000000000 --- a/reference/ssh2/functions/ssh2-sftp-stat.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - ssh2_sftp_stat - Stat a file on a remote filesystem - - - - &reftitle.description; - - arrayfalsessh2_sftp_stat - resourcesftp - stringpath - - - Stats a file on the remote filesystem following any symbolic links. - - - This function is similar to using the stat function - with the ssh2.sftp:// wrapper - and returns the same values. - - - - - &reftitle.parameters; - - - sftp - - - An SSH2 SFTP resource opened by ssh2_sftp. - - - - - path - - - - - - - - - - &reftitle.returnvalues; - - Returns an array of statistics for the given file on success&return.falseforfailure;. - See the documentation for stat for details on the - values which may be returned. - - - - - &reftitle.examples; - - Stating a file via SFTP - - -]]> - - - - - - &reftitle.seealso; - - ssh2_sftp_lstat - lstat - stat - - - - - diff --git a/reference/ssh2/functions/ssh2-sftp-symlink.xml b/reference/ssh2/functions/ssh2-sftp-symlink.xml deleted file mode 100644 index 347381b91925..000000000000 --- a/reference/ssh2/functions/ssh2-sftp-symlink.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - ssh2_sftp_symlink - Create a symlink - - - - &reftitle.description; - - boolssh2_sftp_symlink - resourcesftp - stringtarget - stringlink - - - Creates a symbolic link named link on the remote - filesystem pointing to target. - - - - - &reftitle.parameters; - - - sftp - - - An SSH2 SFTP resource opened by ssh2_sftp. - - - - - target - - - Target of the symbolic link. - - - - - link - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Creating a symbolic link - - -]]> - - - - - - &reftitle.seealso; - - ssh2_sftp_readlink - symlink - - - - - diff --git a/reference/ssh2/functions/ssh2-sftp-unlink.xml b/reference/ssh2/functions/ssh2-sftp-unlink.xml deleted file mode 100644 index 18db544888dd..000000000000 --- a/reference/ssh2/functions/ssh2-sftp-unlink.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - ssh2_sftp_unlink - Delete a file - - - - &reftitle.description; - - boolssh2_sftp_unlink - resourcesftp - stringfilename - - - Deletes a file on the remote filesystem. - - - - - &reftitle.parameters; - - - sftp - - - An SSH2 SFTP resource opened by ssh2_sftp. - - - - - filename - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Deleting a file - - -]]> - - - - - - &reftitle.seealso; - - unlink - - - - - diff --git a/reference/ssh2/functions/ssh2-sftp.xml b/reference/ssh2/functions/ssh2-sftp.xml deleted file mode 100644 index c985b63754c0..000000000000 --- a/reference/ssh2/functions/ssh2-sftp.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - ssh2_sftp - Initialize SFTP subsystem - - - - &reftitle.description; - - resourcefalsessh2_sftp - resourcesession - - - Request the SFTP subsystem from an already connected SSH2 server. - - - - - &reftitle.parameters; - - - session - - - An SSH connection link identifier, obtained from a call to - ssh2_connect. - - - - - - - - &reftitle.returnvalues; - - This method returns an SSH2 SFTP resource for use with - all other ssh2_sftp_*() methods and the - ssh2.sftp:// fopen wrapper, - &return.falseforfailure;. - - - - - &reftitle.examples; - - Opening a file via SFTP - - -]]> - - - - - - &reftitle.seealso; - - ssh2_scp_recv - ssh2_scp_send - - - - - diff --git a/reference/ssh2/functions/ssh2-shell-resize.xml b/reference/ssh2/functions/ssh2-shell-resize.xml deleted file mode 100644 index f130a02a3ac4..000000000000 --- a/reference/ssh2/functions/ssh2-shell-resize.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - ssh2_shell_resize - Change the dimensions of a channel's pseudo-terminal - - - - &reftitle.description; - - boolssh2_shell_resize - resourcechannel - intwidth - intheight - intwidth_px0 - intheight_px0 - - - Requests that the pseudo-terminal (PTY) attached to the given - channel be resized to the given dimensions. - - - - The extension declares only the first three parameters, under the name - session for channel. As a - result, width_px and - height_px can only be passed positionally. - - - - - - &reftitle.parameters; - - - channel - - - An SSH channel stream, as returned by ssh2_exec or - ssh2_shell. - - - - - width - - - The width of the terminal, in characters. - - - - - height - - - The height of the terminal, in characters. - - - - - width_px - - - The width of the terminal in pixels, or 0 to leave - the pixel dimensions unspecified. - - - - - height_px - - - The height of the terminal in pixels, or 0 to leave - the pixel dimensions unspecified. - - - - - - - - &reftitle.returnvalues; - - Returns &true;, or &false; when channel is not an - SSH channel stream. - - - The outcome of the resize request itself is not reported: &true; is - returned even when the remote end does not honour it. - - - - - &reftitle.errors; - - An E_WARNING is emitted when - channel is not an SSH channel stream. - - - - - &reftitle.examples; - - Resizing the pseudo-terminal of a shell - - -]]> - - - - - - &reftitle.seealso; - - ssh2_shell - ssh2_exec - - - - - diff --git a/reference/ssh2/functions/ssh2-shell.xml b/reference/ssh2/functions/ssh2-shell.xml deleted file mode 100644 index 69368509243f..000000000000 --- a/reference/ssh2/functions/ssh2-shell.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - ssh2_shell - Request an interactive shell - - - - &reftitle.description; - - resourcefalsessh2_shell - resourcesession - stringtermtype"vanilla" - arraynullenv&null; - intwidth80 - intheight25 - intwidth_height_typeSSH2_TERM_UNIT_CHARS - - - Open a shell at the remote end and allocate a stream for it. - - - - - &reftitle.parameters; - - - session - - - An SSH connection link identifier, obtained from a call to - ssh2_connect. - - - - - termtype - - - termtype should correspond to one of the - entries in the target system's /etc/termcap file. - - - - - env - - - env may be passed as an associative array of - name/value pairs to set in the target environment. - - - - - width - - - Width of the virtual terminal. - - - - - height - - - Height of the virtual terminal. - - - - - width_height_type - - - width_height_type should be one of - SSH2_TERM_UNIT_CHARS or - SSH2_TERM_UNIT_PIXELS. - - - - - - - - &reftitle.returnvalues; - - Returns a stream &resource; on success, &return.falseforfailure;. - - - - - &reftitle.examples; - - Requesting an interactive shell - - -]]> - - - - - - &reftitle.seealso; - - ssh2_exec - ssh2_tunnel - ssh2_fetch_stream - - - - - diff --git a/reference/ssh2/functions/ssh2-tunnel.xml b/reference/ssh2/functions/ssh2-tunnel.xml deleted file mode 100644 index bf0b38ecaf6d..000000000000 --- a/reference/ssh2/functions/ssh2-tunnel.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - ssh2_tunnel - Open a tunnel through a remote server - - - - &reftitle.description; - - resourcessh2_tunnel - resourcesession - stringhost - intport - - - Open a socket stream to an arbitrary host/port by way of the currently - connected SSH server. - - - - - &reftitle.parameters; - - - session - - - An SSH connection link identifier, obtained from a call to - ssh2_connect. - - - - - host - - - - - - - port - - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Opening a tunnel to an arbitrary host - - -]]> - - - - - - &reftitle.seealso; - - ssh2_connect - fsockopen - - - - - diff --git a/reference/ssh2/installation.xml b/reference/ssh2/installation.xml deleted file mode 100644 index 6378e43909f3..000000000000 --- a/reference/ssh2/installation.xml +++ /dev/null @@ -1,34 +0,0 @@ - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;ssh2. - - - &pecl.windows.download.avail; - - -
    - diff --git a/reference/ssh2/reference.xml b/reference/ssh2/reference.xml deleted file mode 100644 index bf0ea33debe9..000000000000 --- a/reference/ssh2/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - SSH2 &Functions; - - &reference.ssh2.entities.functions; - - - - diff --git a/reference/ssh2/setup.xml b/reference/ssh2/setup.xml deleted file mode 100644 index d1c341fd2074..000000000000 --- a/reference/ssh2/setup.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - &reftitle.setup; - - -
    - &reftitle.required; - - The - OpenSSL and - libssh2 libraries - are required. Ensure that the development libraries are installed, - where a typical package name might be openssl-dev. - - - Version 1.2 or newer of the libssh2 library is required, although - it's possible newer releases of pecl/ssh2 may require newer - versions (see the release notes). - - - The ssh2_auth_agent function will only be available - with libssh2 >= 1.2.3. - - - support for stream_set_timeout to channel streams - will only be available with libssh2 >= 1.2.9. - - - Libssh2 comes in two flavours: gcrypt or openssl. Some Linux - distributions build libssh2 with the gcrypt library, some use openssl. - Libssh2 has some issues when compiled with gcrypt, please use openssl. - -
    - - - - &reference.ssh2.installation; - - - -
    - &reftitle.resources; - - This extension defines the following resource types: - - SSH2 Session - SSH2 Listener - SSH2 SFTP - SSH2 Publickey Subsystem (as of ssh2 0.10) - - -
    - - -
    - diff --git a/reference/ssh2/versions.xml b/reference/ssh2/versions.xml deleted file mode 100644 index 9b2f3da8119a..000000000000 --- a/reference/ssh2/versions.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/stats/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/stats/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/stats/book.xml b/reference/stats/book.xml deleted file mode 100644 index f22c762ac6eb..000000000000 --- a/reference/stats/book.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - - Statistics - - - - &reftitle.intro; - - &warn.pecl.unmaintained; - This is the statistics extension. It contains few dozens of functions - useful for statistical computations. It is a wrapper around 2 scientific - libraries, namely DCDFLIB (Library of C routines for Cumulative - Distributions Functions, Inverses, and Other parameters) by B. Brown & - J. Lavato and RANDLIB by Barry Brown, James Lavato & Kathy Russell. - Includes CD and PD functions. - - - - - &reference.stats.setup; - &reference.stats.reference; - - - - - diff --git a/reference/stats/functions/stats-absolute-deviation.xml b/reference/stats/functions/stats-absolute-deviation.xml deleted file mode 100644 index eeec79e12a97..000000000000 --- a/reference/stats/functions/stats-absolute-deviation.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - stats_absolute_deviation - Returns the absolute deviation of an array of values - - - &reftitle.description; - - floatstats_absolute_deviation - arraya - - - Returns the absolute deviation of the values in a. - - - - &reftitle.parameters; - - - - a - - - The input array - - - - - - - - - &reftitle.returnvalues; - - Returns the absolute deviation of the values in a, - or &false; if a is empty or is not an array. - - - - - - diff --git a/reference/stats/functions/stats-cdf-beta.xml b/reference/stats/functions/stats-cdf-beta.xml deleted file mode 100644 index d8164345a93d..000000000000 --- a/reference/stats/functions/stats-cdf-beta.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - stats_cdf_beta - Calculates any one parameter of the beta distribution given values for the others - - - &reftitle.description; - - floatstats_cdf_beta - floatpar1 - floatpar2 - floatpar3 - intwhich - - - Returns the cumulative distribution function, its inverse, or one of its parameters, - of the beta distribution. The kind of the return value and parameters (par1, - par2, and par3) are determined by - which. - - - The following table lists the return value and parameters by which. - CDF, x, alpha, and beta denotes cumulative distribution function, the value of the random - variable, and shape parameters of the beta distribution, respectively. - - Return value and parameters - - - - which - Return value - par1 - par2 - par3 - - - - - 1 - CDF - x - alpha - beta - - - 2 - x - CDF - alpha - beta - - - 3 - alpha - x - CDF - beta - - - 4 - beta - x - CDF - alpha - - - -
    -
    -
    - - &reftitle.parameters; - - - - par1 - - - The first parameter - - - - - par2 - - - The second parameter - - - - - par3 - - - The third parameter - - - - - which - - - The flag to determine what to be calculated - - - - - - - - - &reftitle.returnvalues; - - Returns CDF, x, alpha, or beta, determined by which. - - - -
    - - diff --git a/reference/stats/functions/stats-cdf-binomial.xml b/reference/stats/functions/stats-cdf-binomial.xml deleted file mode 100644 index 161e2093ce3d..000000000000 --- a/reference/stats/functions/stats-cdf-binomial.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - stats_cdf_binomial - Calculates any one parameter of the binomial distribution given values for the others - - - &reftitle.description; - - floatstats_cdf_binomial - floatpar1 - floatpar2 - floatpar3 - intwhich - - - Returns the cumulative distribution function, its inverse, or one of its parameters, - of the binomial distribution. The kind of the return value and parameters - (par1, par2, and par3) - are determined by which. - - - The following table lists the return value and parameters by which. - CDF, x, n, and p denotes cumulative distribution function, the number of successes, - the number of trials, and the success rate for each trial, respectively. - - Return value and parameters - - - - which - Return value - par1 - par2 - par3 - - - - - 1 - CDF - x - n - p - - - 2 - x - CDF - n - p - - - 3 - n - x - CDF - p - - - 4 - p - x - CDF - n - - - -
    -
    -
    - - &reftitle.parameters; - - - - par1 - - - The first parameter - - - - - par2 - - - The second parameter - - - - - par3 - - - The third parameter - - - - - which - - - The flag to determine what to be calculated - - - - - - - - - &reftitle.returnvalues; - - Returns CDF, x, n, or p, determined by which. - - - -
    - - diff --git a/reference/stats/functions/stats-cdf-cauchy.xml b/reference/stats/functions/stats-cdf-cauchy.xml deleted file mode 100644 index e585733dc874..000000000000 --- a/reference/stats/functions/stats-cdf-cauchy.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - stats_cdf_cauchy - Calculates any one parameter of the Cauchy distribution given values for the others - - - &reftitle.description; - - floatstats_cdf_cauchy - floatpar1 - floatpar2 - floatpar3 - intwhich - - - Returns the cumulative distribution function, its inverse, or one of its parameters, - of the Cauchy distribution. The kind of the return value and parameters - (par1, par2, and par3) - are determined by which. - - - The following table lists the return value and parameters by which. - CDF, x, x0, and gamma denotes cumulative distribution function, the value of the random - variable, the location and the scale parameter of the Cauchy distribution, respectively. - - Return value and parameters - - - - which - Return value - par1 - par2 - par3 - - - - - 1 - CDF - x - x0 - gamma - - - 2 - x - CDF - x0 - gamma - - - 3 - x0 - x - CDF - gamma - - - 4 - gamma - x - CDF - x0 - - - -
    -
    -
    - - &reftitle.parameters; - - - - par1 - - - The first parameter - - - - - par2 - - - The second parameter - - - - - par3 - - - The third parameter - - - - - which - - - The flag to determine what to be calculated - - - - - - - - - &reftitle.returnvalues; - - Returns CDF, x, x0, or gamma, determined by which. - - - -
    - - diff --git a/reference/stats/functions/stats-cdf-chisquare.xml b/reference/stats/functions/stats-cdf-chisquare.xml deleted file mode 100644 index c12ad1db914d..000000000000 --- a/reference/stats/functions/stats-cdf-chisquare.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - stats_cdf_chisquare - Calculates any one parameter of the chi-square distribution given values for the others - - - &reftitle.description; - - floatstats_cdf_chisquare - floatpar1 - floatpar2 - intwhich - - - Returns the cumulative distribution function, its inverse, or one of its parameters, - of the chi-square distribution. The kind of the return value and parameters - (par1 and par2) are determined by - which. - - - The following table lists the return value and parameters by which. - CDF, x, and k denotes cumulative distribution function, the value of the random variable, - and the degree of freedom of the chi-square distribution, respectively. - - Return value and parameters - - - - which - Return value - par1 - par2 - - - - - 1 - CDF - x - k - - - 2 - x - CDF - k - - - 3 - k - x - CDF - - - -
    -
    -
    - - &reftitle.parameters; - - - - par1 - - - The first parameter - - - - - par2 - - - The second parameter - - - - - which - - - The flag to determine what to be calculated - - - - - - - - - &reftitle.returnvalues; - - Returns CDF, x, or k, determined by which. - - - -
    - - diff --git a/reference/stats/functions/stats-cdf-exponential.xml b/reference/stats/functions/stats-cdf-exponential.xml deleted file mode 100644 index 66845e535d07..000000000000 --- a/reference/stats/functions/stats-cdf-exponential.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - stats_cdf_exponential - Calculates any one parameter of the exponential distribution given values for the others - - - &reftitle.description; - - floatstats_cdf_exponential - floatpar1 - floatpar2 - intwhich - - - Returns the cumulative distribution function, its inverse, or one of its parameters, - of the exponential distribution. The kind of the return value and parameters - (par1 and par2) are determined by - which. - - - The following table lists the return value and parameters by which. - CDF, x, and lambda denotes cumulative distribution function, the value of the random - variable, and the rate parameter of the exponential distribution, respectively. - - Return value and parameters - - - - which - Return value - par1 - par2 - - - - - 1 - CDF - x - lambda - - - 2 - x - CDF - lambda - - - 3 - lambda - x - CDF - - - -
    -
    -
    - - &reftitle.parameters; - - - - par1 - - - The first parameter - - - - - par2 - - - The second parameter - - - - - which - - - The flag to determine what to be calculated - - - - - - - - - &reftitle.returnvalues; - - Returns CDF, x, or lambda, determined by which. - - - -
    - - diff --git a/reference/stats/functions/stats-cdf-f.xml b/reference/stats/functions/stats-cdf-f.xml deleted file mode 100644 index d407db7a21cb..000000000000 --- a/reference/stats/functions/stats-cdf-f.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - stats_cdf_f - Calculates any one parameter of the F distribution given values for the others - - - &reftitle.description; - - floatstats_cdf_f - floatpar1 - floatpar2 - floatpar3 - intwhich - - - Returns the cumulative distribution function, its inverse, or one of its parameters, - of the F distribution. The kind of the return value and parameters - (par1, par2, and par3) - are determined by which. - - - The following table lists the return value and parameters by which. - CDF, x, d1, and d2 denotes cumulative distribution function, the value of the random - variable, and the degree of freedoms of the F distribution, respectively. - - Return value and parameters - - - - which - Return value - par1 - par2 - par3 - - - - - 1 - CDF - x - d1 - d2 - - - 2 - x - CDF - d1 - d2 - - - 3 - d1 - x - CDF - d2 - - - 4 - d2 - x - CDF - d1 - - - -
    -
    -
    - - &reftitle.parameters; - - - - par1 - - - The first parameter - - - - - par2 - - - The second parameter - - - - - par3 - - - The third parameter - - - - - which - - - The flag to determine what to be calculated - - - - - - - - - &reftitle.returnvalues; - - Returns CDF, x, d1, or d2, determined by which. - - - -
    - - diff --git a/reference/stats/functions/stats-cdf-gamma.xml b/reference/stats/functions/stats-cdf-gamma.xml deleted file mode 100644 index fb397ef905d6..000000000000 --- a/reference/stats/functions/stats-cdf-gamma.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - stats_cdf_gamma - Calculates any one parameter of the gamma distribution given values for the others - - - &reftitle.description; - - floatstats_cdf_gamma - floatpar1 - floatpar2 - floatpar3 - intwhich - - - Returns the cumulative distribution function, its inverse, or one of its parameters, - of the gamma distribution. The kind of the return value and parameters - (par1, par2, and par3) - are determined by which. - - - The following table lists the return value and parameters by which. - CDF, x, k, and theta denotes cumulative distribution function, the value of the random - variable, and the shape and the scale parameter of the gamma distribution, respectively. - - Return value and parameters - - - - which - Return value - par1 - par2 - par3 - - - - - 1 - CDF - x - k - theta - - - 2 - x - CDF - k - theta - - - 3 - k - x - CDF - theta - - - 4 - theta - x - CDF - k - - - -
    -
    -
    - - &reftitle.parameters; - - - - par1 - - - The first parameter - - - - - par2 - - - The second parameter - - - - - par3 - - - The third parameter - - - - - which - - - The flag to determine what to be calculated - - - - - - - - - &reftitle.returnvalues; - - Returns CDF, x, k, or theta, determined by which. - - - -
    - - diff --git a/reference/stats/functions/stats-cdf-laplace.xml b/reference/stats/functions/stats-cdf-laplace.xml deleted file mode 100644 index 6c3efc8c6c96..000000000000 --- a/reference/stats/functions/stats-cdf-laplace.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - stats_cdf_laplace - Calculates any one parameter of the Laplace distribution given values for the others - - - &reftitle.description; - - floatstats_cdf_laplace - floatpar1 - floatpar2 - floatpar3 - intwhich - - - Returns the cumulative distribution function, its inverse, or one of its parameters, - of the Laplace distribution. The kind of the return value and parameters - (par1, par2, and par3) - are determined by which. - - - The following table lists the return value and parameters by which. - CDF, x, mu, and b denotes cumulative distribution function, the value of the random - variable, and the location and the scale parameter of the Laplace distribution, respectively. - - Return value and parameters - - - - which - Return value - par1 - par2 - par3 - - - - - 1 - CDF - x - mu - b - - - 2 - x - CDF - mu - b - - - 3 - mu - x - CDF - b - - - 4 - b - x - CDF - mu - - - -
    -
    -
    - - &reftitle.parameters; - - - - par1 - - - The first parameter - - - - - par2 - - - The second parameter - - - - - par3 - - - The third parameter - - - - - which - - - The flag to determine what to be calculated - - - - - - - - - &reftitle.returnvalues; - - Returns CDF, x, mu, or b, determined by which. - - - -
    - - diff --git a/reference/stats/functions/stats-cdf-logistic.xml b/reference/stats/functions/stats-cdf-logistic.xml deleted file mode 100644 index 852d541c5ffd..000000000000 --- a/reference/stats/functions/stats-cdf-logistic.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - stats_cdf_logistic - Calculates any one parameter of the logistic distribution given values for the others - - - &reftitle.description; - - floatstats_cdf_logistic - floatpar1 - floatpar2 - floatpar3 - intwhich - - - Returns the cumulative distribution function, its inverse, or one of its parameters, - of the logistic distribution. The kind of the return value and parameters - (par1, par2, and par3) - are determined by which. - - - The following table lists the return value and parameters by which. - CDF, x, mu, and s denotes cumulative distribution function, the value of the random - variable, and the location and the scale parameter of the logistic distribution, respectively. - - Return value and parameters - - - - which - Return value - par1 - par2 - par3 - - - - - 1 - CDF - x - mu - s - - - 2 - x - CDF - mu - s - - - 3 - mu - x - CDF - s - - - 4 - s - x - CDF - mu - - - -
    -
    -
    - - &reftitle.parameters; - - - - par1 - - - The first parameter - - - - - par2 - - - The second parameter - - - - - par3 - - - The third parameter - - - - - which - - - The flag to determine what to be calculated - - - - - - - - - &reftitle.returnvalues; - - Returns CDF, x, mu, or s, determined by which. - - - -
    - - diff --git a/reference/stats/functions/stats-cdf-negative-binomial.xml b/reference/stats/functions/stats-cdf-negative-binomial.xml deleted file mode 100644 index 9a62d856ef51..000000000000 --- a/reference/stats/functions/stats-cdf-negative-binomial.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - stats_cdf_negative_binomial - Calculates any one parameter of the negative binomial distribution given values for the others - - - &reftitle.description; - - floatstats_cdf_negative_binomial - floatpar1 - floatpar2 - floatpar3 - intwhich - - - Returns the cumulative distribution function, its inverse, or one of its parameters, - of the negative binomial distribution. The kind of the return value and parameters - (par1, par2, and par3) - are determined by which. - - - The following table lists the return value and parameters by which. - CDF, x, r, and p denotes cumulative distribution function, the number of failure, the number - of success, and the success rate for each trial, respectively. - - Return value and parameters - - - - which - Return value - par1 - par2 - par3 - - - - - 1 - CDF - x - r - p - - - 2 - x - CDF - r - p - - - 3 - r - x - CDF - p - - - 4 - p - x - CDF - r - - - -
    -
    -
    - - &reftitle.parameters; - - - - par1 - - - The first parameter - - - - - par2 - - - The second parameter - - - - - par3 - - - The third parameter - - - - - which - - - The flag to determine what to be calculated - - - - - - - - - &reftitle.returnvalues; - - Returns CDF, x, r, or p, determined by which. - - - -
    - - diff --git a/reference/stats/functions/stats-cdf-noncentral-chisquare.xml b/reference/stats/functions/stats-cdf-noncentral-chisquare.xml deleted file mode 100644 index 4a72dd2fdc08..000000000000 --- a/reference/stats/functions/stats-cdf-noncentral-chisquare.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - stats_cdf_noncentral_chisquare - Calculates any one parameter of the non-central chi-square distribution given values for the others - - - &reftitle.description; - - floatstats_cdf_noncentral_chisquare - floatpar1 - floatpar2 - floatpar3 - intwhich - - - Returns the cumulative distribution function, its inverse, or one of its parameters, - of the non-central chi-square distribution. The kind of the return value and parameters - (par1, par2, and par3) - are determined by which. - - - The following table lists the return value and parameters by which. - CDF, x, k, and lambda denotes cumulative distribution function, the value of the random - variable, the degree of freedom and the non-centrality parameter of the distribution, - respectively. - - Return value and parameters - - - - which - Return value - par1 - par2 - par3 - - - - - 1 - CDF - x - k - lambda - - - 2 - x - CDF - k - lambda - - - 3 - k - x - CDF - lambda - - - 4 - lambda - x - CDF - k - - - -
    -
    -
    - - &reftitle.parameters; - - - - par1 - - - The first parameter - - - - - par2 - - - The second parameter - - - - - par3 - - - The third parameter - - - - - which - - - The flag to determine what to be calculated - - - - - - - - - &reftitle.returnvalues; - - Returns CDF, x, k, or lambda, determined by which. - - - -
    - - diff --git a/reference/stats/functions/stats-cdf-noncentral-f.xml b/reference/stats/functions/stats-cdf-noncentral-f.xml deleted file mode 100644 index aa84e0c58f83..000000000000 --- a/reference/stats/functions/stats-cdf-noncentral-f.xml +++ /dev/null @@ -1,164 +0,0 @@ - - - - - stats_cdf_noncentral_f - Calculates any one parameter of the non-central F distribution given values for the others - - - &reftitle.description; - - floatstats_cdf_noncentral_f - floatpar1 - floatpar2 - floatpar3 - floatpar4 - intwhich - - - Returns the cumulative distribution function, its inverse, or one of its parameters, - of the non-central F distribution. The kind of the return value and parameters - (par1, par2, par3, - and par4) are determined by which. - - - The following table lists the return value and parameters by which. - CDF, x, nu1, nu2, and lambda denotes cumulative distribution function, the value of the - random variable, the degree of freedoms and the non-centrality parameter of the distribution, - respectively. - - Return value and parameters - - - - which - Return value - par1 - par2 - par3 - par4 - - - - - 1 - CDF - x - nu1 - nu2 - lambda - - - 2 - x - CDF - nu1 - nu2 - lambda - - - 3 - nu1 - x - CDF - nu2 - lambda - - - 4 - nu2 - x - CDF - nu1 - lambda - - - 5 - lambda - x - CDF - nu1 - nu2 - - - -
    -
    -
    - - &reftitle.parameters; - - - - par1 - - - The first parameter - - - - - par2 - - - The second parameter - - - - - par3 - - - The third parameter - - - - - par4 - - - The fourth parameter - - - - - which - - - The flag to determine what to be calculated - - - - - - - - - &reftitle.returnvalues; - - Returns CDF, x, nu1, nu2, or lambda, determined by which. - - - -
    - - diff --git a/reference/stats/functions/stats-cdf-noncentral-t.xml b/reference/stats/functions/stats-cdf-noncentral-t.xml deleted file mode 100644 index b3bed1118011..000000000000 --- a/reference/stats/functions/stats-cdf-noncentral-t.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - stats_cdf_noncentral_t - Calculates any one parameter of the non-central t-distribution give values for the others - - - - &reftitle.description; - - floatstats_cdf_noncentral_t - floatpar1 - floatpar2 - floatpar3 - intwhich - - - Returns the cumulative distribution function, its inverse, or one of its parameters, - of the non-central t-distribution. The kind of the return value and parameters - (par1, par2, and par3) - are determined by which. - - - The following table lists the return value and parameters by which. - CDF, x, nu, and mu denotes cumulative distribution function, the value of the random - variable, the degrees of freedom and the non-centrality parameter of the distribution, - respectively. - - Return value and parameters - - - - which - Return value - par1 - par2 - par3 - - - - - 1 - CDF - x - nu - mu - - - 2 - x - CDF - nu - mu - - - 3 - nu - x - CDF - mu - - - 4 - mu - x - CDF - nu - - - -
    -
    -
    - - - &reftitle.parameters; - - - - par1 - - - The first parameter - - - - - par2 - - - The second parameter - - - - - par3 - - - The third parameter - - - - - which - - - The flag to determine what to be calculated - - - - - - - - - &reftitle.returnvalues; - - Returns CDF, x, nu, or mu, determined by which. - - - -
    - - diff --git a/reference/stats/functions/stats-cdf-normal.xml b/reference/stats/functions/stats-cdf-normal.xml deleted file mode 100644 index f60844a8f9a2..000000000000 --- a/reference/stats/functions/stats-cdf-normal.xml +++ /dev/null @@ -1,144 +0,0 @@ - - - - - - stats_cdf_normal - Calculates any one parameter of the normal distribution given values for the others - - - - &reftitle.description; - - floatstats_cdf_normal - floatpar1 - floatpar2 - floatpar3 - intwhich - - - Returns the cumulative distribution function, its inverse, or one of its parameters, - of the normal distribution. The kind of the return value and parameters - (par1, par2, and par3) - are determined by which. - - - The following table lists the return value and parameters by which. - CDF, x, mu, and sigma denotes cumulative distribution function, the value of the random - variable, the mean and the standard deviation of the normal distribution, respectively. - - Return value and parameters - - - - which - Return value - par1 - par2 - par3 - - - - - 1 - CDF - x - mu - sigma - - - 2 - x - CDF - mu - sigma - - - 3 - mu - x - CDF - sigma - - - 4 - sigma - x - CDF - mu - - - -
    -
    -
    - - - &reftitle.parameters; - - - - par1 - - - The first parameter - - - - - par2 - - - The second parameter - - - - - par3 - - - The third parameter - - - - - which - - - The flag to determine what to be calculated - - - - - - - - - &reftitle.returnvalues; - - Returns CDF, x, mu, or sigma, determined by which. - - - -
    - - diff --git a/reference/stats/functions/stats-cdf-poisson.xml b/reference/stats/functions/stats-cdf-poisson.xml deleted file mode 100644 index 38d29fb1e75d..000000000000 --- a/reference/stats/functions/stats-cdf-poisson.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - stats_cdf_poisson - Calculates any one parameter of the Poisson distribution given values for the others - - - &reftitle.description; - - floatstats_cdf_poisson - floatpar1 - floatpar2 - intwhich - - - Returns the cumulative distribution function, its inverse, or one of its parameters, of the Poisson distribution. - The kind of the return value and parameters (par1 and par2) are - determined by which. - - - The following table lists the return value and parameters by which. - CDF, x, and lambda denotes cumulative distribution function, the value of the random variable, - and the parameter of the Poisson distribution, respectively. - - Return value and parameters - - - - which - Return value - par1 - par2 - - - - - 1 - CDF - x - lambda - - - 2 - x - CDF - lambda - - - 3 - lambda - x - CDF - - - -
    -
    -
    - - &reftitle.parameters; - - - - par1 - - - The first parameter - - - - - par2 - - - The second parameter - - - - - which - - - The flag to determine what to be calculated - - - - - - - - - &reftitle.returnvalues; - - Returns CDF, x, or lambda, determined by which. - - - -
    - - diff --git a/reference/stats/functions/stats-cdf-t.xml b/reference/stats/functions/stats-cdf-t.xml deleted file mode 100644 index ac192706d532..000000000000 --- a/reference/stats/functions/stats-cdf-t.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - stats_cdf_t - Calculates any one parameter of the t-distribution given values for the others - - - &reftitle.description; - - floatstats_cdf_t - floatpar1 - floatpar2 - intwhich - - - Returns the cumulative distribution function, its inverse, or one of its parameters, - of the t-distribution. The kind of the return value and parameters - (par1 and par2) are determined by - which. - - - The following table lists the return value and parameters by which. - CDF, x, and nu denotes cumulative distribution function, the value of the random - variable, and the degrees of freedom of the t-distribution, respectively. - - Return value and parameters - - - - which - Return value - par1 - par2 - - - - - 1 - CDF - x - nu - - - 2 - x - CDF - nu - - - 3 - nu - x - CDF - - - -
    -
    -
    - - &reftitle.parameters; - - - - par1 - - - The first parameter - - - - - par2 - - - The second parameter - - - - - which - - - The flag to determine what to be calculated - - - - - - - - - &reftitle.returnvalues; - - Returns CDF, x, or nu, determined by which. - - - -
    - - diff --git a/reference/stats/functions/stats-cdf-uniform.xml b/reference/stats/functions/stats-cdf-uniform.xml deleted file mode 100644 index edbd102c4c85..000000000000 --- a/reference/stats/functions/stats-cdf-uniform.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - stats_cdf_uniform - Calculates any one parameter of the uniform distribution given values for the others - - - &reftitle.description; - - floatstats_cdf_uniform - floatpar1 - floatpar2 - floatpar3 - intwhich - - - Returns the cumulative distribution function, its inverse, or one of its parameters, - of the uniform distribution. The kind of the return value and parameters - (par1, par2, and par3) - are determined by which. - - - The following table lists the return value and parameters by which. - CDF, x, a, and b denotes cumulative distribution function, the value of the random variable, - the lower bound and the higher bound of the uniform distribution, respectively. - - Return value and parameters - - - - which - Return value - par1 - par2 - par3 - - - - - 1 - CDF - x - a - b - - - 2 - x - CDF - a - b - - - 3 - a - x - CDF - b - - - 4 - b - x - CDF - a - - - -
    -
    -
    - - &reftitle.parameters; - - - - par1 - - - The first parameter - - - - - par2 - - - The second parameter - - - - - par3 - - - The third parameter - - - - - which - - - The flag to determine what to be calculated - - - - - - - - - &reftitle.returnvalues; - - Returns CDF, x, a, or b, determined by which. - - - -
    - - diff --git a/reference/stats/functions/stats-cdf-weibull.xml b/reference/stats/functions/stats-cdf-weibull.xml deleted file mode 100644 index 8affe9ae8332..000000000000 --- a/reference/stats/functions/stats-cdf-weibull.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - stats_cdf_weibull - Calculates any one parameter of the Weibull distribution given values for the others - - - &reftitle.description; - - floatstats_cdf_weibull - floatpar1 - floatpar2 - floatpar3 - intwhich - - - Returns the cumulative distribution function, its inverse, or one of its parameters, - of the Weibull distribution. The kind of the return value and parameters - (par1, par2, and par3) - are determined by which. - - - The following table lists the return value and parameters by which. - CDF, x, k, and lambda denotes cumulative distribution function, the value of the random variable, - the shape and the scale parameter of the Weibull distribution, respectively. - - Return value and parameters - - - - which - Return value - par1 - par2 - par3 - - - - - 1 - CDF - x - k - lambda - - - 2 - x - CDF - k - lambda - - - 3 - k - x - CDF - lambda - - - 4 - lambda - x - CDF - k - - - -
    -
    -
    - - &reftitle.parameters; - - - - par1 - - - The first parameter - - - - - par2 - - - The second parameter - - - - - par3 - - - The third parameter - - - - - which - - - The flag to determine what to be calculated - - - - - - - - - &reftitle.returnvalues; - - Returns CDF, x, k, or lambda, determined by which. - - - -
    - - diff --git a/reference/stats/functions/stats-covariance.xml b/reference/stats/functions/stats-covariance.xml deleted file mode 100644 index d3c1004c01bb..000000000000 --- a/reference/stats/functions/stats-covariance.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - stats_covariance - Computes the covariance of two data sets - - - &reftitle.description; - - floatstats_covariance - arraya - arrayb - - - Returns the covariance of a and b. - - - - &reftitle.parameters; - - - - a - - - The first array - - - - - b - - - The second array - - - - - - - - - &reftitle.returnvalues; - - Returns the covariance of a and b, - or &false; on failure. - - - - - - diff --git a/reference/stats/functions/stats-dens-beta.xml b/reference/stats/functions/stats-dens-beta.xml deleted file mode 100644 index 2bf9d9282e0c..000000000000 --- a/reference/stats/functions/stats-dens-beta.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - stats_dens_beta - Probability density function of the beta distribution - - - &reftitle.description; - - floatstats_dens_beta - floatx - floata - floatb - - - Returns the probability density at x, where the - random variable follows the beta distribution of which the shape parameters - are a and b. - - - - &reftitle.parameters; - - - - x - - - The value at which the probability density is calculated - - - - - a - - - The shape parameter of the distribution - - - - - b - - - The shape parameter of the distribution - - - - - - - - - &reftitle.returnvalues; - - The probability density at x or &false; for failure. - - - - - - diff --git a/reference/stats/functions/stats-dens-cauchy.xml b/reference/stats/functions/stats-dens-cauchy.xml deleted file mode 100644 index 5ef297c17e42..000000000000 --- a/reference/stats/functions/stats-dens-cauchy.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - stats_dens_cauchy - Probability density function of the Cauchy distribution - - - &reftitle.description; - - floatstats_dens_cauchy - floatx - floatave - floatstdev - - - Returns the probability density at x, where the - random variable follows the Cauchy distribution whose location and scale are - ave and stdev, respectively. - - - - &reftitle.parameters; - - - - x - - - The value at which the probability density is calculated - - - - - ave - - - The location parameter of the distribution - - - - - stdev - - - The scale parameter of the distribution - - - - - - - - - &reftitle.returnvalues; - - The probability density at x or &false; for failure. - - - - - - diff --git a/reference/stats/functions/stats-dens-chisquare.xml b/reference/stats/functions/stats-dens-chisquare.xml deleted file mode 100644 index 64f22ebee2ec..000000000000 --- a/reference/stats/functions/stats-dens-chisquare.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - stats_dens_chisquare - Probability density function of the chi-square distribution - - - &reftitle.description; - - floatstats_dens_chisquare - floatx - floatdfr - - - Returns the probability density at x, where the - random variable follows the chi-square distribution of which the degree of - freedom is dfr. - - - - &reftitle.parameters; - - - - x - - - The value at which the probability density is calculated - - - - - dfr - - - The degree of freedom of the distribution - - - - - - - - - &reftitle.returnvalues; - - The probability density at x or &false; for failure. - - - - - - diff --git a/reference/stats/functions/stats-dens-exponential.xml b/reference/stats/functions/stats-dens-exponential.xml deleted file mode 100644 index 2fa105f17640..000000000000 --- a/reference/stats/functions/stats-dens-exponential.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - stats_dens_exponential - Probability density function of the exponential distribution - - - &reftitle.description; - - floatstats_dens_exponential - floatx - floatscale - - - Returns the probability density at x, where the - random variable follows the exponential distribution of which the scale is - scale. - - - - &reftitle.parameters; - - - - x - - - The value at which the probability density is calculated - - - - - scale - - - The scale of the distribution - - - - - - - - - &reftitle.returnvalues; - - The probability density at x or &false; for failure. - - - - - - diff --git a/reference/stats/functions/stats-dens-f.xml b/reference/stats/functions/stats-dens-f.xml deleted file mode 100644 index 3ebdb39326e2..000000000000 --- a/reference/stats/functions/stats-dens-f.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - stats_dens_f - Probability density function of the F distribution - - - &reftitle.description; - - floatstats_dens_f - floatx - floatdfr1 - floatdfr2 - - - Returns the probability density at x, where the - random variable follows the F distribution of which the degree of freedoms - are dfr1 and dfr2. - - - - &reftitle.parameters; - - - - x - - - The value at which the probability density is calculated - - - - - dfr1 - - - The degree of freedom of the distribution - - - - - dfr2 - - - The degree of freedom of the distribution - - - - - - - - - &reftitle.returnvalues; - - The probability density at x or &false; for failure. - - - - - - diff --git a/reference/stats/functions/stats-dens-gamma.xml b/reference/stats/functions/stats-dens-gamma.xml deleted file mode 100644 index d717d1f1c34c..000000000000 --- a/reference/stats/functions/stats-dens-gamma.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - stats_dens_gamma - Probability density function of the gamma distribution - - - &reftitle.description; - - floatstats_dens_gamma - floatx - floatshape - floatscale - - - Returns the probability density at x, where the - random variable follows the gamma distribution of which the shape parameter - is shape and the scale parameter is scale. - - - - &reftitle.parameters; - - - - x - - - The value at which the probability density is calculated - - - - - shape - - - The shape parameter of the distribution - - - - - scale - - - The scale parameter of the distribution - - - - - - - - - &reftitle.returnvalues; - - The probability density at x or &false; for failure. - - - - - - diff --git a/reference/stats/functions/stats-dens-laplace.xml b/reference/stats/functions/stats-dens-laplace.xml deleted file mode 100644 index 4e1f202dc2e7..000000000000 --- a/reference/stats/functions/stats-dens-laplace.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - stats_dens_laplace - Probability density function of the Laplace distribution - - - &reftitle.description; - - floatstats_dens_laplace - floatx - floatave - floatstdev - - - Returns the probability density at x, where the - random variable follows the Laplace distribution of which the location parameter - is ave and the scale parameter is stdev. - - - - &reftitle.parameters; - - - - x - - - The value at which the probability density is calculated - - - - - ave - - - The location parameter of the distribution - - - - - stdev - - - The shape parameter of the distribution - - - - - - - - - &reftitle.returnvalues; - - The probability density at x or &false; for failure. - - - - - - diff --git a/reference/stats/functions/stats-dens-logistic.xml b/reference/stats/functions/stats-dens-logistic.xml deleted file mode 100644 index ebad13484923..000000000000 --- a/reference/stats/functions/stats-dens-logistic.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - stats_dens_logistic - Probability density function of the logistic distribution - - - &reftitle.description; - - floatstats_dens_logistic - floatx - floatave - floatstdev - - - Returns the probability density at x, where the - random variable follows the logistic distribution of which the location parameter - is ave and the scale parameter is stdev. - - - - &reftitle.parameters; - - - - x - - - The value at which the probability density is calculated - - - - - ave - - - The location parameter of the distribution - - - - - stdev - - - The shape parameter of the distribution - - - - - - - - - &reftitle.returnvalues; - - The probability density at x or &false; for failure. - - - - - - diff --git a/reference/stats/functions/stats-dens-normal.xml b/reference/stats/functions/stats-dens-normal.xml deleted file mode 100644 index 1f4b17eace1e..000000000000 --- a/reference/stats/functions/stats-dens-normal.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - stats_dens_normal - Probability density function of the normal distribution - - - &reftitle.description; - - floatstats_dens_normal - floatx - floatave - floatstdev - - - Returns the probability density at x, where the - random variable follows the normal distribution of which the mean is - ave and the standard deviation is - stdev. - - - - &reftitle.parameters; - - - - x - - - The value at which the probability density is calculated - - - - - ave - - - The mean of the distribution - - - - - stdev - - - The standard deviation of the distribution - - - - - - - - - &reftitle.returnvalues; - - The probability density at x or &false; for failure. - - - - - - diff --git a/reference/stats/functions/stats-dens-pmf-binomial.xml b/reference/stats/functions/stats-dens-pmf-binomial.xml deleted file mode 100644 index 3dfb01c8fb9c..000000000000 --- a/reference/stats/functions/stats-dens-pmf-binomial.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - stats_dens_pmf_binomial - Probability mass function of the binomial distribution - - - &reftitle.description; - - floatstats_dens_pmf_binomial - floatx - floatn - floatpi - - - Returns the probability mass at x, where the random variable - follows the binomial distribution of which the number of trials is n - and the success rate is pi. - - - - &reftitle.parameters; - - - - x - - - The value at which the probability mass is calculated - - - - - n - - - The number of trials of the distribution - - - - - pi - - - The success rate of the distribution - - - - - - - - - &reftitle.returnvalues; - - The probability mass at x or &false; for failure. - - - - - - diff --git a/reference/stats/functions/stats-dens-pmf-hypergeometric.xml b/reference/stats/functions/stats-dens-pmf-hypergeometric.xml deleted file mode 100644 index 44277e635bdc..000000000000 --- a/reference/stats/functions/stats-dens-pmf-hypergeometric.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - stats_dens_pmf_hypergeometric - Probability mass function of the hypergeometric distribution - - - &reftitle.description; - - floatstats_dens_pmf_hypergeometric - floatn1 - floatn2 - floatN1 - floatN2 - - - Returns the probability mass at n1, where the random variable - follows the hypergeometric distribution of which the number of failure is - n2, the number of success samples is N1, - and the number of failure samples is N2. - - - - &reftitle.parameters; - - - - n1 - - - The number of success, at which the probability mass is calculated - - - - - n2 - - - The number of failure of the distribution - - - - - N1 - - - The number of success samples of the distribution - - - - - N2 - - - The number of failure samples of the distribution - - - - - - - - - &reftitle.returnvalues; - - The probability mass at n1 or &false; for failure. - - - - - - diff --git a/reference/stats/functions/stats-dens-pmf-negative-binomial.xml b/reference/stats/functions/stats-dens-pmf-negative-binomial.xml deleted file mode 100644 index 06a0203e19d3..000000000000 --- a/reference/stats/functions/stats-dens-pmf-negative-binomial.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - stats_dens_pmf_negative_binomial - Probability mass function of the negative binomial distribution - - - - &reftitle.description; - - floatstats_dens_pmf_negative_binomial - floatx - floatn - floatpi - - - Returns the probability mass at x, where the - random variable follows the negative binomial distribution of which - the number of the success is n and the success - rate is pi. - - - - - &reftitle.parameters; - - - - x - - - The value at which the probability mass is calculated - - - - - n - - - The number of the success of the distribution - - - - - pi - - - The success rate of the distribution - - - - - - - - - &reftitle.returnvalues; - - The probability mass at x or &false; for failure. - - - - - - diff --git a/reference/stats/functions/stats-dens-pmf-poisson.xml b/reference/stats/functions/stats-dens-pmf-poisson.xml deleted file mode 100644 index edd15cf62c40..000000000000 --- a/reference/stats/functions/stats-dens-pmf-poisson.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - stats_dens_pmf_poisson - Probability mass function of the Poisson distribution - - - &reftitle.description; - - floatstats_dens_pmf_poisson - floatx - floatlb - - - Returns the probability mass at x, where the random variable - follows the Poisson distribution whose parameter is lb. - - - - &reftitle.parameters; - - - - x - - - The value at which the probability mass is calculated - - - - - lb - - - The parameter of the Poisson distribution - - - - - - - - - &reftitle.returnvalues; - - The probability mass at x or &false; for failure. - - - - - - diff --git a/reference/stats/functions/stats-dens-t.xml b/reference/stats/functions/stats-dens-t.xml deleted file mode 100644 index edba7c80c5bc..000000000000 --- a/reference/stats/functions/stats-dens-t.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - stats_dens_t - Probability density function of the t-distribution - - - &reftitle.description; - - floatstats_dens_t - floatx - floatdfr - - - Returns the probability density at x, where the - random variable follows the t-distribution of which the degree of - freedom is dfr. - - - - &reftitle.parameters; - - - - x - - - The value at which the probability density is calculated - - - - - dfr - - - The degree of freedom of the distribution - - - - - - - - - &reftitle.returnvalues; - - The probability density at x or &false; for failure. - - - - - - diff --git a/reference/stats/functions/stats-dens-uniform.xml b/reference/stats/functions/stats-dens-uniform.xml deleted file mode 100644 index aa8c144ebb39..000000000000 --- a/reference/stats/functions/stats-dens-uniform.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - stats_dens_uniform - Probability density function of the uniform distribution - - - - &reftitle.description; - - floatstats_dens_uniform - floatx - floata - floatb - - - Returns the probability density at x, where the - random variable follows the uniform distribution of which the lower bound is - a and the upper bound is b. - - - - - &reftitle.parameters; - - - - x - - - The value at which the probability density is calculated - - - - - a - - - The lower bound of the distribution - - - - - b - - - The upper bound of the distribution - - - - - - - - - &reftitle.returnvalues; - - The probability density at x or &false; for failure. - - - - - - diff --git a/reference/stats/functions/stats-dens-weibull.xml b/reference/stats/functions/stats-dens-weibull.xml deleted file mode 100644 index 54077e2c10f9..000000000000 --- a/reference/stats/functions/stats-dens-weibull.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - stats_dens_weibull - Probability density function of the Weibull distribution - - - &reftitle.description; - - floatstats_dens_weibull - floatx - floata - floatb - - - Returns the probability density at x, where the - random variable follows the Weibull distribution of which the shape parameter - is a and the scale parameter is b. - - - - &reftitle.parameters; - - - - x - - - The value at which the probability density is calculated - - - - - a - - - The shape parameter of the distribution - - - - - b - - - The scale parameter of the distribution - - - - - - - - - &reftitle.returnvalues; - - The probability density at x or &false; for failure. - - - - - - diff --git a/reference/stats/functions/stats-harmonic-mean.xml b/reference/stats/functions/stats-harmonic-mean.xml deleted file mode 100644 index 8a10d56dd2cc..000000000000 --- a/reference/stats/functions/stats-harmonic-mean.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - stats_harmonic_mean - Returns the harmonic mean of an array of values - - - &reftitle.description; - - numberstats_harmonic_mean - arraya - - - Returns the harmonic mean of the values in a. - - - - &reftitle.parameters; - - - - a - - - The input array - - - - - - - - - &reftitle.returnvalues; - - Returns the harmonic mean of the values in a, - or &false; if a is empty or is not an array. - - - - - - diff --git a/reference/stats/functions/stats-kurtosis.xml b/reference/stats/functions/stats-kurtosis.xml deleted file mode 100644 index d7c43760d30f..000000000000 --- a/reference/stats/functions/stats-kurtosis.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - stats_kurtosis - Computes the kurtosis of the data in the array - - - &reftitle.description; - - floatstats_kurtosis - arraya - - - Returns the kurtosis of the values in a. - - - - &reftitle.parameters; - - - - a - - - The input array - - - - - - - - - &reftitle.returnvalues; - - Returns the kurtosis of the values in a, - or &false; if a is empty or is not an array. - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-beta.xml b/reference/stats/functions/stats-rand-gen-beta.xml deleted file mode 100644 index 09de6e26ea32..000000000000 --- a/reference/stats/functions/stats-rand-gen-beta.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - stats_rand_gen_beta - Generates a random deviate from the beta distribution - - - &reftitle.description; - - floatstats_rand_gen_beta - floata - floatb - - - Returns a random deviate from the beta distribution with parameters A and - B. The density of the beta is x^(a-1) * (1-x)^(b-1) / B(a,b) for 0 < x - <. Method R. C. H. Cheng. - - - - - &reftitle.parameters; - - - - a - - - The shape parameter of the beta distribution - - - - - b - - - The shape parameter of the beta distribution - - - - - - - - - &reftitle.returnvalues; - - A random deviate - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-chisquare.xml b/reference/stats/functions/stats-rand-gen-chisquare.xml deleted file mode 100644 index 6d6645e0a922..000000000000 --- a/reference/stats/functions/stats-rand-gen-chisquare.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - stats_rand_gen_chisquare - Generates a random deviate from the chi-square distribution - - - &reftitle.description; - - floatstats_rand_gen_chisquare - floatdf - - - Returns a random deviate from the chi-square distribution where the degrees of - freedom is df. - - - - &reftitle.parameters; - - - - df - - - The degrees of freedom - - - - - - - - - &reftitle.returnvalues; - - A random deviate - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-exponential.xml b/reference/stats/functions/stats-rand-gen-exponential.xml deleted file mode 100644 index c86e6fdc2c3a..000000000000 --- a/reference/stats/functions/stats-rand-gen-exponential.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - stats_rand_gen_exponential - Generates a random deviate from the exponential distribution - - - &reftitle.description; - - floatstats_rand_gen_exponential - floatav - - - Returns a random deviate from the exponential distribution of which the scale is - av. - - - - &reftitle.parameters; - - - - av - - - The scale parameter - - - - - - - - - &reftitle.returnvalues; - - A random deviate - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-f.xml b/reference/stats/functions/stats-rand-gen-f.xml deleted file mode 100644 index e55ba3e1fcce..000000000000 --- a/reference/stats/functions/stats-rand-gen-f.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - stats_rand_gen_f - Generates a random deviate from the F distribution - - - &reftitle.description; - - floatstats_rand_gen_f - floatdfn - floatdfd - - - Generates a random deviate from the F (variance ratio) distribution with - "dfn" degrees of freedom in the numerator and "dfd" degrees of freedom in - the denominator. Method : directly generates ratio of chisquare variates. - - - - &reftitle.parameters; - - - - dfn - - - The degrees of freedom in the numerator - - - - - dfd - - - The degrees of freedom in the denominator - - - - - - - - - &reftitle.returnvalues; - - A random deviate - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-funiform.xml b/reference/stats/functions/stats-rand-gen-funiform.xml deleted file mode 100644 index 44fcb84163ec..000000000000 --- a/reference/stats/functions/stats-rand-gen-funiform.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - stats_rand_gen_funiform - Generates uniform float between low (exclusive) and high (exclusive) - - - &reftitle.description; - - floatstats_rand_gen_funiform - floatlow - floathigh - - - Returns a random deviate from the uniform distribution from - low to high. - - - - &reftitle.parameters; - - - - low - - - The lower bound (exclusive) - - - - - high - - - The upper bound (exclusive) - - - - - - - - - &reftitle.returnvalues; - - A random deviate - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-gamma.xml b/reference/stats/functions/stats-rand-gen-gamma.xml deleted file mode 100644 index e7dd1f1a3f42..000000000000 --- a/reference/stats/functions/stats-rand-gen-gamma.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - stats_rand_gen_gamma - Generates a random deviate from the gamma distribution - - - &reftitle.description; - - floatstats_rand_gen_gamma - floata - floatr - - - Generates a random deviate from the gamma distribution whose density is - (A**R)/Gamma(R) * X**(R-1) * Exp(-A*X). - - - - - &reftitle.parameters; - - - - a - - - location parameter of Gamma distribution (a - > 0). - - - - - r - - - shape parameter of Gamma distribution (r > - 0). - - - - - - - - &reftitle.returnvalues; - - A random deviate - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-ibinomial-negative.xml b/reference/stats/functions/stats-rand-gen-ibinomial-negative.xml deleted file mode 100644 index 37ab921ffaca..000000000000 --- a/reference/stats/functions/stats-rand-gen-ibinomial-negative.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - stats_rand_gen_ibinomial_negative - Generates a random deviate from the negative binomial distribution - - - &reftitle.description; - - intstats_rand_gen_ibinomial_negative - intn - floatp - - - Returns a random deviate from a negative binomial distribution where the number of success is - n and the success rate is p. - - - - &reftitle.parameters; - - - - n - - - The number of success - - - - - p - - - The success rate - - - - - - - - - &reftitle.returnvalues; - - A random deviate, which is the number of failure. - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-ibinomial.xml b/reference/stats/functions/stats-rand-gen-ibinomial.xml deleted file mode 100644 index 434d1900f704..000000000000 --- a/reference/stats/functions/stats-rand-gen-ibinomial.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - stats_rand_gen_ibinomial - Generates a random deviate from the binomial distribution - - - &reftitle.description; - - intstats_rand_gen_ibinomial - intn - floatpp - - - Returns a random deviate from the binomial distribution whose number of trials is n - and whose probability of an event in each trial is pp. - - - - &reftitle.parameters; - - - - n - - - The number of trials - - - - - pp - - - The probability of an event in each trial - - - - - - - - - &reftitle.returnvalues; - - A random deviate - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-int.xml b/reference/stats/functions/stats-rand-gen-int.xml deleted file mode 100644 index 5988ce16caa7..000000000000 --- a/reference/stats/functions/stats-rand-gen-int.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - stats_rand_gen_int - Generates random integer between 1 and 2147483562 - - - &reftitle.description; - - intstats_rand_gen_int - - - - Returns a random integer between 1 and 2147483562 - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A random integer - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-ipoisson.xml b/reference/stats/functions/stats-rand-gen-ipoisson.xml deleted file mode 100644 index 04d9c35237f6..000000000000 --- a/reference/stats/functions/stats-rand-gen-ipoisson.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - stats_rand_gen_ipoisson - Generates a single random deviate from a Poisson distribution - - - &reftitle.description; - - intstats_rand_gen_ipoisson - floatmu - - - Returns a random deviate from the Poisson distribution with parameter mu. - - - - &reftitle.parameters; - - - - mu - - - The parameter of the Poisson distribution - - - - - - - - - &reftitle.returnvalues; - - A random deviate - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-iuniform.xml b/reference/stats/functions/stats-rand-gen-iuniform.xml deleted file mode 100644 index 3c62d01446b6..000000000000 --- a/reference/stats/functions/stats-rand-gen-iuniform.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - stats_rand_gen_iuniform - Generates integer uniformly distributed between LOW (inclusive) and HIGH (inclusive) - - - &reftitle.description; - - intstats_rand_gen_iuniform - intlow - inthigh - - - Returns a random integer from the discrete uniform distribution between low (inclusive) - and high (inclusive). - - - - &reftitle.parameters; - - - - low - - - The lower bound - - - - - high - - - The upper bound - - - - - - - - - &reftitle.returnvalues; - - A random integer - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-noncentral-chisquare.xml b/reference/stats/functions/stats-rand-gen-noncentral-chisquare.xml deleted file mode 100644 index f48e065b1263..000000000000 --- a/reference/stats/functions/stats-rand-gen-noncentral-chisquare.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - stats_rand_gen_noncentral_chisquare - Generates a random deviate from the non-central chi-square distribution - - - - &reftitle.description; - - floatstats_rand_gen_noncentral_chisquare - floatdf - floatxnonc - - - Returns a random deviate from the non-central chi-square distribution with degrees of freedom, - df, and non-centrality parameter, xnonc. - - - - - &reftitle.parameters; - - - - df - - - The degrees of freedom - - - - - xnonc - - - The non-centrality parameter - - - - - - - - - &reftitle.returnvalues; - - A random deviate - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-noncentral-f.xml b/reference/stats/functions/stats-rand-gen-noncentral-f.xml deleted file mode 100644 index effe10ef6ff9..000000000000 --- a/reference/stats/functions/stats-rand-gen-noncentral-f.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - stats_rand_gen_noncentral_f - Generates a random deviate from the noncentral F distribution - - - &reftitle.description; - - floatstats_rand_gen_noncentral_f - floatdfn - floatdfd - floatxnonc - - - Returns a random deviate from the non-central F distribution where the degrees of freedoms are - dfn (numerator) and dfd (denominator), and the non-centrality - parameter is xnonc. - - - - &reftitle.parameters; - - - - dfn - - - The degrees of freedom of the numerator - - - - - dfd - - - The degrees of freedom of the denominator - - - - - xnonc - - - The non-centrality parameter - - - - - - - - - &reftitle.returnvalues; - - A random deviate - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-noncentral-t.xml b/reference/stats/functions/stats-rand-gen-noncentral-t.xml deleted file mode 100644 index e70ca0edf707..000000000000 --- a/reference/stats/functions/stats-rand-gen-noncentral-t.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - stats_rand_gen_noncentral_t - Generates a single random deviate from a non-central t-distribution - - - &reftitle.description; - - floatstats_rand_gen_noncentral_t - floatdf - floatxnonc - - - Returns a random deviate from the non-central t-distribution with the degrees of freedom, - df, and the non-centrality parameter, xnonc. - - - - &reftitle.parameters; - - - - df - - - The degrees of freedom - - - - - xnonc - - - The non-centrality parameter - - - - - - - - - &reftitle.returnvalues; - - A random deviate - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-normal.xml b/reference/stats/functions/stats-rand-gen-normal.xml deleted file mode 100644 index 1ea6d90fd44c..000000000000 --- a/reference/stats/functions/stats-rand-gen-normal.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - stats_rand_gen_normal - Generates a single random deviate from a normal distribution - - - &reftitle.description; - - floatstats_rand_gen_normal - floatav - floatsd - - - Returns a random deviate from the normal distribution with mean, av, and standard deviation, - sd. - - - - &reftitle.parameters; - - - - av - - - The mean of the normal distribution - - - - - sd - - - The standard deviation of the normal distribution - - - - - - - - - &reftitle.returnvalues; - - A random deviate - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-t.xml b/reference/stats/functions/stats-rand-gen-t.xml deleted file mode 100644 index 490239342e01..000000000000 --- a/reference/stats/functions/stats-rand-gen-t.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - stats_rand_gen_t - Generates a single random deviate from a t-distribution - - - &reftitle.description; - - floatstats_rand_gen_t - floatdf - - - Returns a random deviate from the t-distribution with the degrees of freedom, df. - - - - &reftitle.parameters; - - - - df - - - The degrees of freedom - - - - - - - - - &reftitle.returnvalues; - - A random deviate - - - - - - diff --git a/reference/stats/functions/stats-rand-get-seeds.xml b/reference/stats/functions/stats-rand-get-seeds.xml deleted file mode 100644 index 414e4568f99e..000000000000 --- a/reference/stats/functions/stats-rand-get-seeds.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - stats_rand_get_seeds - Get the seed values of the random number generator - - - &reftitle.description; - - arraystats_rand_get_seeds - - - - Returns the current seed values of the random number generator - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an array of two integers. - - - - - - diff --git a/reference/stats/functions/stats-rand-phrase-to-seeds.xml b/reference/stats/functions/stats-rand-phrase-to-seeds.xml deleted file mode 100644 index 7ed41f5698bb..000000000000 --- a/reference/stats/functions/stats-rand-phrase-to-seeds.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - stats_rand_phrase_to_seeds - Generate two seeds for the RGN random number generator - - - &reftitle.description; - - arraystats_rand_phrase_to_seeds - stringphrase - - - Generate two seeds for the random number generator from a phrase. - - - - &reftitle.parameters; - - - - phrase - - - The input phrase - - - - - - - - - &reftitle.returnvalues; - - Returns an array of two integers. - - - - - - diff --git a/reference/stats/functions/stats-rand-ranf.xml b/reference/stats/functions/stats-rand-ranf.xml deleted file mode 100644 index c59eb209b73e..000000000000 --- a/reference/stats/functions/stats-rand-ranf.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - stats_rand_ranf - Generates a random floating point number between 0 and 1 - - - &reftitle.description; - - floatstats_rand_ranf - - - - Returns a random floating point number from a uniform distribution between 0 (exclusive) and 1 (exclusive). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A random floating point number - - - - - - diff --git a/reference/stats/functions/stats-rand-setall.xml b/reference/stats/functions/stats-rand-setall.xml deleted file mode 100644 index 6fd439237a5d..000000000000 --- a/reference/stats/functions/stats-rand-setall.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - stats_rand_setall - Set seed values to the random generator - - - &reftitle.description; - - voidstats_rand_setall - intiseed1 - intiseed2 - - - Set iseed1 and iseed2 as seed values to the random generator - used in statistic functions. - - - - &reftitle.parameters; - - - - iseed1 - - - The value which is used as the random seed - - - - - iseed2 - - - The value which is used as the random seed - - - - - - - - - &reftitle.returnvalues; - - No values are returned. - - - - - - diff --git a/reference/stats/functions/stats-skew.xml b/reference/stats/functions/stats-skew.xml deleted file mode 100644 index dea1100bef6a..000000000000 --- a/reference/stats/functions/stats-skew.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - stats_skew - Computes the skewness of the data in the array - - - &reftitle.description; - - floatstats_skew - arraya - - - Returns the skewness of the values in a. - - - - &reftitle.parameters; - - - - a - - - The input array - - - - - - - - - &reftitle.returnvalues; - - Returns the skewness of the values in a, - or &false; if a is empty or is not an array. - - - - - - diff --git a/reference/stats/functions/stats-standard-deviation.xml b/reference/stats/functions/stats-standard-deviation.xml deleted file mode 100644 index 3ffa3ad8c6a9..000000000000 --- a/reference/stats/functions/stats-standard-deviation.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - stats_standard_deviation - Returns the standard deviation - - - &reftitle.description; - - floatstats_standard_deviation - arraya - boolsample&false; - - - Returns the standard deviation of the values in a. - - - - &reftitle.parameters; - - - - a - - - The array of data to find the standard deviation for. Note that all - values of the array will be cast to float. - - - - - sample - - - Indicates if a represents a sample of the - population; defaults to &false;. - - - - - - - - - &reftitle.returnvalues; - - Returns the standard deviation on success; &false; on failure. - - - - - &reftitle.errors; - - Raises an E_WARNING when there are fewer than 2 - values in a. - - - - - - diff --git a/reference/stats/functions/stats-stat-binomial-coef.xml b/reference/stats/functions/stats-stat-binomial-coef.xml deleted file mode 100644 index bf499b8e3395..000000000000 --- a/reference/stats/functions/stats-stat-binomial-coef.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - stats_stat_binomial_coef - Returns a binomial coefficient - - - &reftitle.description; - - floatstats_stat_binomial_coef - intx - intn - - - Returns the binomial coefficient of n choose x. - - - - &reftitle.parameters; - - - - x - - - The number of chooses from the set - - - - - n - - - The number of elements in the set - - - - - - - - - &reftitle.returnvalues; - - Returns the binomial coefficient - - - - - - diff --git a/reference/stats/functions/stats-stat-correlation.xml b/reference/stats/functions/stats-stat-correlation.xml deleted file mode 100644 index 3fa8c140624b..000000000000 --- a/reference/stats/functions/stats-stat-correlation.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - stats_stat_correlation - Returns the Pearson correlation coefficient of two data sets - - - &reftitle.description; - - floatstats_stat_correlation - arrayarr1 - arrayarr2 - - - Returns the Pearson correlation coefficient between arr1 and arr2. - - - - &reftitle.parameters; - - - - arr1 - - - The first array - - - - - arr2 - - - The second array - - - - - - - - - &reftitle.returnvalues; - - Returns the Pearson correlation coefficient between arr1 and arr2, - or &false; on failure. - - - - - - diff --git a/reference/stats/functions/stats-stat-factorial.xml b/reference/stats/functions/stats-stat-factorial.xml deleted file mode 100644 index 27b5ded36329..000000000000 --- a/reference/stats/functions/stats-stat-factorial.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - stats_stat_factorial - Returns the factorial of an integer - - - - &reftitle.description; - - floatstats_stat_factorial - intn - - - Returns the factorial of an integer, n. - - - - - &reftitle.parameters; - - - n - - - An integer - - - - - - - - &reftitle.returnvalues; - - The factorial of n. - - - - - - diff --git a/reference/stats/functions/stats-stat-independent-t.xml b/reference/stats/functions/stats-stat-independent-t.xml deleted file mode 100644 index 30a86c44eb5b..000000000000 --- a/reference/stats/functions/stats-stat-independent-t.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - stats_stat_independent_t - Returns the t-value from the independent two-sample t-test - - - &reftitle.description; - - floatstats_stat_independent_t - arrayarr1 - arrayarr2 - - - Returns the t-value of the independent two-sample t-test between - arr1 and arr2. - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - arr1 - - - The first set of values - - - - - arr2 - - - The second set of values - - - - - - - - - &reftitle.returnvalues; - - Returns the t-value, or &false; if failure. - - - - - - diff --git a/reference/stats/functions/stats-stat-innerproduct.xml b/reference/stats/functions/stats-stat-innerproduct.xml deleted file mode 100644 index 14c4323a0d1a..000000000000 --- a/reference/stats/functions/stats-stat-innerproduct.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - stats_stat_innerproduct - Returns the inner product of two vectors - - - &reftitle.description; - - floatstats_stat_innerproduct - arrayarr1 - arrayarr2 - - - Returns the inner product of arr1 and arr2. - - - - &reftitle.parameters; - - - - arr1 - - - The first array - - - - - arr2 - - - The second array - - - - - - - - - &reftitle.returnvalues; - - Returns the inner product of arr1 and arr2, - or &false; on failure. - - - - - - diff --git a/reference/stats/functions/stats-stat-paired-t.xml b/reference/stats/functions/stats-stat-paired-t.xml deleted file mode 100644 index f8b6c597c924..000000000000 --- a/reference/stats/functions/stats-stat-paired-t.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - stats_stat_paired_t - Returns the t-value of the dependent t-test for paired samples - - - &reftitle.description; - - floatstats_stat_paired_t - arrayarr1 - arrayarr2 - - - Returns the t-value of the dependent t-test for paired samples - arr1 and arr2. - - - - &reftitle.parameters; - - - - arr1 - - - The first samples - - - - - arr2 - - - The second samples - - - - - - - - - &reftitle.returnvalues; - - Returns the t-value, or &false; if failure. - - - - - - diff --git a/reference/stats/functions/stats-stat-percentile.xml b/reference/stats/functions/stats-stat-percentile.xml deleted file mode 100644 index b44d7774e2da..000000000000 --- a/reference/stats/functions/stats-stat-percentile.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - stats_stat_percentile - Returns the percentile value - - - &reftitle.description; - - floatstats_stat_percentile - arrayarr - floatperc - - - Returns the perc-th percentile value of the array arr. - - - - &reftitle.parameters; - - - - arr - - - The input array - - - - - perc - - - The percentile - - - - - - - - - &reftitle.returnvalues; - - Returns the percentile values of the input array. - - - - - - diff --git a/reference/stats/functions/stats-stat-powersum.xml b/reference/stats/functions/stats-stat-powersum.xml deleted file mode 100644 index 60cd6e3582e4..000000000000 --- a/reference/stats/functions/stats-stat-powersum.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - stats_stat_powersum - Returns the power sum of a vector - - - &reftitle.description; - - floatstats_stat_powersum - arrayarr - floatpower - - - Returns the sum of the power-th power of a vector represented as an array arr. - - - - &reftitle.parameters; - - - - arr - - - The input array - - - - - power - - - The power - - - - - - - - - &reftitle.returnvalues; - - Returns the power sum of the input array. - - - - - - diff --git a/reference/stats/functions/stats-variance.xml b/reference/stats/functions/stats-variance.xml deleted file mode 100644 index 0b711ae389fa..000000000000 --- a/reference/stats/functions/stats-variance.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - stats_variance - Returns the variance - - - &reftitle.description; - - floatstats_variance - arraya - boolsample&false; - - - Returns the variance of the values in a. - - - - &reftitle.parameters; - - - - a - - - The array of data to find the standard deviation for. Note that all - values of the array will be cast to float. - - - - - sample - - - Indicates if a represents a sample of the - population; defaults to &false;. - - - - - - - - - &reftitle.returnvalues; - - Returns the variance on success; &false; on failure. - - - - - - diff --git a/reference/stats/reference.xml b/reference/stats/reference.xml deleted file mode 100644 index 03288799321d..000000000000 --- a/reference/stats/reference.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - Statistic &Functions; - - &reference.stats.entities.functions; - - - - diff --git a/reference/stats/setup.xml b/reference/stats/setup.xml deleted file mode 100644 index 38de124f586e..000000000000 --- a/reference/stats/setup.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - &reftitle.setup; - - -
    - &reftitle.required; - - No external libraries are needed. The extension comes bundled with the libraries used. - -
    - - - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info.dead; - &url.pecl.package;stats. - - - &pecl.windows.download.avail; - -
    - - -
    - - - diff --git a/reference/stats/versions.xml b/reference/stats/versions.xml deleted file mode 100644 index 47aa966291fb..000000000000 --- a/reference/stats/versions.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/stomp/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/stomp/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/stomp/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/stomp/book.xml b/reference/stomp/book.xml deleted file mode 100644 index 00ea816c28ac..000000000000 --- a/reference/stomp/book.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - Stomp Client - Stomp - - - &reftitle.intro; - -This extension allows php applications to communicate with any Stomp compliant Message Brokers through easy object-oriented and procedural interfaces. Stomp official site - - - - &reference.stomp.setup; - &reference.stomp.examples; - &reference.stomp.reference; - &reference.stomp.stomp; - &reference.stomp.stompframe; - &reference.stomp.stompexception; - - diff --git a/reference/stomp/examples.xml b/reference/stomp/examples.xml deleted file mode 100644 index d093b0572efd..000000000000 --- a/reference/stomp/examples.xml +++ /dev/null @@ -1,162 +0,0 @@ - - - - &reftitle.examples; - - - &style.oop; - -getMessage()); -} - -/* send a message to the queue 'foo' */ -$stomp->send($queue, $msg); - -/* subscribe to messages from the queue 'foo' */ -$stomp->subscribe($queue); - -/* read a frame */ -$frame = $stomp->readFrame(); - -if ($frame->body === $msg) { - var_dump($frame); - - /* acknowledge that the frame was received */ - $stomp->ack($frame); -} - -/* close connection */ -unset($stomp); - -?> -]]> - - &example.outputs.similar; - - - string(7) "MESSAGE" - ["headers"]=> - array(5) { - ["message-id"]=> - string(41) "ID:php.net-55293-1257226743606-4:2:-1:1:1" - ["destination"]=> - string(10) "/queue/foo" - ["timestamp"]=> - string(13) "1257226805828" - ["expires"]=> - string(1) "0" - ["priority"]=> - string(1) "0" - } - ["body"]=> - string(3) "bar" -} -]]> - - - - &style.procedural; - - 't1')); - -/* commit a transaction */ -stomp_commit($link, 't1'); - -/* subscribe to messages from the queue 'foo' */ -stomp_subscribe($link, $queue); - -/* read a frame */ -$frame = stomp_read_frame($link); - -if ($frame['body'] === $msg) { - var_dump($frame); - - /* acknowledge that the frame was received */ - stomp_ack($link, $frame['headers']['message-id']); -} - -/* close connection */ -stomp_close($link); - -?> -]]> - - &example.outputs.similar; - - - string(7) "MESSAGE" - ["body"]=> - string(3) "bar" - ["headers"]=> - array(6) { - ["transaction"]=> - string(2) "t1" - ["message-id"]=> - string(41) "ID:php.net-55293-1257226743606-4:3:-1:1:1" - ["destination"]=> - string(10) "/queue/foo" - ["timestamp"]=> - string(13) "1257227037059" - ["expires"]=> - string(1) "0" - ["priority"]=> - string(1) "0" - } -} -]]> - - - - - diff --git a/reference/stomp/functions/stomp-connect-error.xml b/reference/stomp/functions/stomp-connect-error.xml deleted file mode 100644 index e63c64f90200..000000000000 --- a/reference/stomp/functions/stomp-connect-error.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - stomp_connect_error - Returns a string description of the last connect error - - - - &reftitle.description; - - stringstomp_connect_error - - - - Returns a string description of the last connect error. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A string that describes the error, or &null; if no error occurred. - - - - - &reftitle.examples; - - <function>stomp_connect_error</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/stomp/functions/stomp-version.xml b/reference/stomp/functions/stomp-version.xml deleted file mode 100644 index 79146bdb4011..000000000000 --- a/reference/stomp/functions/stomp-version.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - stomp_version - Gets the current stomp extension version - - - - &reftitle.description; - - stringstomp_version - - - - Returns a string containing the version of the current stomp extension. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - It returns the current stomp extension version - - - - - &reftitle.examples; - - <function>stomp_version</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/stomp/ini.xml b/reference/stomp/ini.xml deleted file mode 100644 index 8e0cb0685fcf..000000000000 --- a/reference/stomp/ini.xml +++ /dev/null @@ -1,114 +0,0 @@ - - -
    - &reftitle.runtime; - &extension.runtime; - - Stomp &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - stomp.default_broker - tcp://localhost:61613 - INI_ALL - - - - stomp.default_connection_timeout_sec - 2 - INI_ALL - - - - stomp.default_connection_timeout_usec - 0 - INI_ALL - - - - - stomp.default_read_timeout_sec - 2 - INI_ALL - - - - stomp.default_read_timeout_usec - 0 - INI_ALL - - - - -
    - - &ini.descriptions.title; - - - - - stomp.default_broker - string - - - - The default broker URI to use when connecting to the message broker if no other URI is specified. - - - - - - stomp.default_connection_timeout_sec - int - - - - The seconds part of the default connection timeout. - - - - - - stomp.default_connection_timeout_usec - int - - - - The microseconds part of the default connection timeout. - - - - - - - stomp.default_read_timeout_sec - int - - - - The seconds part of the default reading timeout. - - - - - - stomp.default_read_timeout_usec - int - - - - The microseconds part of the default reading timeout. - - - - - -
    diff --git a/reference/stomp/reference.xml b/reference/stomp/reference.xml deleted file mode 100644 index ed24d112c184..000000000000 --- a/reference/stomp/reference.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - Stomp &Functions; - - &reference.stomp.entities.functions; - - - - - diff --git a/reference/stomp/setup.xml b/reference/stomp/setup.xml deleted file mode 100644 index 9814f0307ab9..000000000000 --- a/reference/stomp/setup.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - &reftitle.setup; - -
    - &reftitle.required; - The OpenSSL package >= 0.9.6 and the openssl extension may also be required to use stomp over SSL. -
    - -
    - &reftitle.install; - - &pecl.info; - &url.pecl.package;stomp - -
    - - - &reference.stomp.ini; - - - -
    - &reftitle.resources; - - There is only one resource type used in the stomp extension - it's - the link identifier for a stomp connection. - -
    - - -
    - diff --git a/reference/stomp/stomp.xml b/reference/stomp/stomp.xml deleted file mode 100644 index 5298b7c30be1..000000000000 --- a/reference/stomp/stomp.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - The Stomp class - Stomp - - - - -
    - &reftitle.intro; - -Represents a connection between PHP and a Stomp compliant Message Broker. - -
    - - -
    - &reftitle.classsynopsis; - - - - Stomp - - - - - Stomp - - - - - &Methods; - - - - - - -
    - -
    - - &reference.stomp.entities.stomp; - -
    - diff --git a/reference/stomp/stomp/abort.xml b/reference/stomp/stomp/abort.xml deleted file mode 100644 index ae1f25c7a37b..000000000000 --- a/reference/stomp/stomp/abort.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - Stomp::abort - stomp_abort - Rolls back a transaction in progress - - - - &reftitle.description; - &style.oop; (method): - - public boolStomp::abort - stringtransaction_id - arrayheaders - - &style.procedural;: - - boolstomp_abort - resourcelink - stringtransaction_id - arrayheaders - - - Rolls back a transaction in progress. - - - - - &reftitle.parameters; - - &stomp.param.link; - - transaction_id - - - The transaction to abort. - - - - &stomp.param.headers; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - &style.oop; - -getMessage()); -} - -/* begin a transaction */ -$stomp->begin('t1'); - -/* send a message to the queue */ -$stomp->send('/queue/foo', 'bar', array('transaction' => 't1')); - -/* rollback */ -$stomp->abort('t1'); - -/* close connection */ -unset($stomp); -?> -]]> - - - - &style.procedural; - - 't1')); - -/* rollback */ -stomp_abort($link, 't1'); - -/* close connection */ -stomp_close($link); - -?> -]]> - - - - - - &reftitle.notes; - &stomp.note.sync; - - - - diff --git a/reference/stomp/stomp/ack.xml b/reference/stomp/stomp/ack.xml deleted file mode 100644 index 745eebbf14ab..000000000000 --- a/reference/stomp/stomp/ack.xml +++ /dev/null @@ -1,170 +0,0 @@ - - - - - Stomp::ack - stomp_ack - Acknowledges consumption of a message - - - - &reftitle.description; - &style.oop; (method): - - public boolStomp::ack - mixedmsg - arrayheaders - - &style.procedural;: - - boolstomp_ack - resourcelink - mixedmsg - arrayheaders - - - Acknowledges consumption of a message from a subscription using client acknowledgment. - - - - - &reftitle.parameters; - - &stomp.param.link; - - msg - - - The message/messageId to be acknowledged. - - - - &stomp.param.headers; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - &style.oop; - -getMessage()); -} - -/* send a message to the queue 'foo' */ -$stomp->send($queue, $msg); - -/* subscribe to messages from the queue 'foo' */ -$stomp->subscribe($queue); - -/* read a frame */ -$frame = $stomp->readFrame(); - -if ($frame->body === $msg) { - /* acknowledge that the frame was received */ - $stomp->ack($frame); -} - -/* remove the subscription */ -$stomp->unsubscribe($queue); - -/* close connection */ -unset($stomp); - -?> -]]> - - - - &style.procedural; - - 't1')); - -/* commit a transaction */ -stomp_commit($link, 't1'); - -/* subscribe to messages from the queue 'foo' */ -stomp_subscribe($link, $queue); - -/* read a frame */ -$frame = stomp_read_frame($link); - -if ($frame['body'] === $msg) { - /* acknowledge that the frame was received */ - stomp_ack($link, $frame['headers']['message-id']); -} - -/* remove the subscription */ -stomp_unsubscribe($link, $queue); - -/* close connection */ -stomp_close($link); - -?> -]]> - - - - - - &reftitle.notes; - &stomp.note.transaction; - &stomp.note.sync; - - - - diff --git a/reference/stomp/stomp/begin.xml b/reference/stomp/stomp/begin.xml deleted file mode 100644 index c206436f950d..000000000000 --- a/reference/stomp/stomp/begin.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - Stomp::begin - stomp_begin - Starts a transaction - - - - &reftitle.description; - &style.oop; (method): - - public boolStomp::begin - stringtransaction_id - arrayheaders - - &style.procedural;: - - boolstomp_begin - resourcelink - stringtransaction_id - arrayheaders - - - Starts a transaction. - - - - - &reftitle.parameters; - - &stomp.param.link; - - transaction_id - - - The transaction id. - - - - &stomp.param.headers; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - See stomp_commit or stomp_abort. - - - - - &reftitle.notes; - &stomp.note.sync; - - - - diff --git a/reference/stomp/stomp/commit.xml b/reference/stomp/stomp/commit.xml deleted file mode 100644 index c27aa4f47bf1..000000000000 --- a/reference/stomp/stomp/commit.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - Stomp::commit - stomp_commit - Commits a transaction in progress - - - - &reftitle.description; - &style.oop; (method): - - public boolStomp::commit - stringtransaction_id - arrayheaders - - &style.procedural;: - - boolstomp_commit - resourcelink - stringtransaction_id - arrayheaders - - - Commits a transaction in progress. - - - - - &reftitle.parameters; - - &stomp.param.link; - - transaction_id - - - The transaction id. - - - - &stomp.param.headers; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - &style.oop; - -getMessage()); -} - -/* begin a transaction */ -$stomp->begin('t1'); - -/* send a message to the queue */ -$stomp->send('/queue/foo', 'bar', array('transaction' => 't1')); - -/* commit */ -$stomp->commit('t1'); - -/* close connection */ -unset($stomp); - -?> -]]> - - - - &style.procedural; - - 't1')); - -/* commit */ -stomp_commit($link, 't1'); - -/* close connection */ -stomp_close($link); - -?> -]]> - - - - - - &reftitle.notes; - &stomp.note.sync; - - - - diff --git a/reference/stomp/stomp/construct.xml b/reference/stomp/stomp/construct.xml deleted file mode 100644 index 93b5d191a6e8..000000000000 --- a/reference/stomp/stomp/construct.xml +++ /dev/null @@ -1,156 +0,0 @@ - - - - - Stomp::__construct - stomp_connect - Opens a connection - - - - &reftitle.description; - &style.oop; (constructor): - - public Stomp::__construct - stringbrokerini_get("stomp.default_broker_uri") - stringusername - stringpassword - arrayheaders - - &style.procedural;: - - resourcestomp_connect - stringbrokerini_get("stomp.default_broker_uri") - stringusername - stringpassword - arrayheaders - - - Opens a connection to a stomp compliant Message Broker. - - - - - &reftitle.parameters; - - - broker - - - The broker URI - - - - - username - - - The username. - - - - - password - - - The password. - - - - &stomp.param.headers; - - - - - &reftitle.returnvalues; - &stomp.note.transaction; - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL stomp 1.0.1 - - The headers parameter was added - - - - - - - - - &reftitle.examples; - - &style.oop; - -getMessage()); -} - -/* close connection */ -unset($stomp); - -?> -]]> - - - - &style.procedural; - - -]]> - - - - - - diff --git a/reference/stomp/stomp/destruct.xml b/reference/stomp/stomp/destruct.xml deleted file mode 100644 index 0aa8e8b7cf4e..000000000000 --- a/reference/stomp/stomp/destruct.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - Stomp::__destruct - stomp_close - Closes stomp connection - - - - &reftitle.description; - &style.oop; (destructor): - - public Stomp::__destruct - - - &style.procedural;: - - boolstomp_close - resourcelink - - - Closes a previously opened connection. - - - - - &reftitle.parameters; - - &stomp.param.link; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - See stomp_connect. - - - - diff --git a/reference/stomp/stomp/error.xml b/reference/stomp/stomp/error.xml deleted file mode 100644 index 0ee9e66c7903..000000000000 --- a/reference/stomp/stomp/error.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - Stomp::error - stomp_error - Gets the last stomp error - - - - &reftitle.description; - &style.oop; (method): - - public stringStomp::error - - - &style.procedural;: - - stringstomp_error - resourcelink - - - Gets the last stomp error. - - - - - &reftitle.parameters; - - &stomp.param.link; - - - - - &reftitle.returnvalues; - - Returns an error string or &false; if no error occurred. - - - - - &reftitle.examples; - - &style.oop; - -getMessage()); -} - -var_dump($stomp->error()); - -if (!$stomp->abort('unknown-transaction', array('receipt' => 'foo'))) { - var_dump($stomp->error()); -} - -/* close connection */ -unset($stomp); - -?> -]]> - - &example.outputs.similar; - - - - - - &style.procedural; - - 'foo'))) { - var_dump(stomp_error($link)); -} - -/* close connection */ -stomp_close($link); - -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/stomp/stomp/getreadtimeout.xml b/reference/stomp/stomp/getreadtimeout.xml deleted file mode 100644 index aa2464e7f733..000000000000 --- a/reference/stomp/stomp/getreadtimeout.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - Stomp::getReadTimeout - stomp_get_read_timeout - Gets read timeout - - - - &reftitle.description; - &style.oop; (method): - - public arrayStomp::getReadTimeout - - - &style.procedural;: - - arraystomp_get_read_timeout - resourcelink - - - Gets read timeout - - - - - &reftitle.parameters; - - &stomp.param.link; - - - - - &reftitle.returnvalues; - - Returns an array with 2 elements: sec and usec. - - - - - &reftitle.examples; - - &style.oop; - -getMessage()); -} - -var_dump($stomp->getReadTimeout()); - -/* close connection */ -unset($stomp); - -?> -]]> - - &example.outputs.similar; - - - int(2) - ["usec"]=> - int(0) -} -]]> - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - int(2) - ["usec"]=> - int(0) -} -]]> - - - - - - - diff --git a/reference/stomp/stomp/getsessionid.xml b/reference/stomp/stomp/getsessionid.xml deleted file mode 100644 index 976d685fe7f6..000000000000 --- a/reference/stomp/stomp/getsessionid.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - Stomp::getSessionId - stomp_get_session_id - Gets the current stomp session ID - - - - &reftitle.description; - &style.oop; (method): - - public stringfalseStomp::getSessionId - - - &style.procedural;: - - stringfalsestomp_get_session_id - resourcelink - - - Gets the current stomp session ID. - - - - - &reftitle.parameters; - - &stomp.param.link; - - - - - &reftitle.returnvalues; - - &string; session id on success&return.falseforfailure;. - - - - - &reftitle.examples; - - &style.oop; - -getMessage()); -} - -var_dump($stomp->getSessionId()); - -/* close connection */ -unset($stomp); - -?> -]]> - - &example.outputs.similar; - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/stomp/stomp/hasframe.xml b/reference/stomp/stomp/hasframe.xml deleted file mode 100644 index 8934e9c583cd..000000000000 --- a/reference/stomp/stomp/hasframe.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - Stomp::hasFrame - stomp_has_frame - Indicates whether or not there is a frame ready to read - - - - &reftitle.description; - &style.oop; (method): - - public boolStomp::hasFrame - - - &style.procedural;: - - boolstomp_has_frame - resourcelink - - - Indicates whether or not there is a frame ready to read. - - - - - &reftitle.parameters; - - &stomp.param.link; - - - - - &reftitle.returnvalues; - - Returns &true; if a frame is ready to read, or &false; otherwise. - - - - - diff --git a/reference/stomp/stomp/readframe.xml b/reference/stomp/stomp/readframe.xml deleted file mode 100644 index 77e0362ea7f7..000000000000 --- a/reference/stomp/stomp/readframe.xml +++ /dev/null @@ -1,196 +0,0 @@ - - - - - Stomp::readFrame - stomp_read_frame - Reads the next frame - - - - &reftitle.description; - &style.oop; (method): - - public stompframeStomp::readFrame - stringclass_name"stompFrame" - - &style.procedural;: - - arraystomp_read_frame - resourcelink - - - Reads the next frame. It is possible to instantiate an object of a specific class, and pass parameters to that class's constructor. - - - - - &reftitle.parameters; - - &stomp.param.link; - - class_name - - - The name of the class to instantiate. If not specified, a stompFrame object is returned. - - - - - - - - &reftitle.returnvalues; - &stomp.note.transaction; - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL stomp 0.4.0 - - class_name parameter was added. - - - - - - - - - &reftitle.examples; - - &style.oop; - -getMessage()); -} - -/* subscribe to messages from the queue 'foo' */ -$stomp->subscribe('/queue/foo'); - -/* read a frame */ -var_dump($stomp->readFrame()); - -/* close connection */ -unset($stomp); - -?> -]]> - - &example.outputs.similar; - - - string(7) "MESSAGE" - ["headers"]=> - array(5) { - ["message-id"]=> - string(41) "ID:php.net-55293-1257226743606-4:2:-1:1:1" - ["destination"]=> - string(10) "/queue/foo" - ["timestamp"]=> - string(13) "1257226805828" - ["expires"]=> - string(1) "0" - ["priority"]=> - string(1) "0" - } - ["body"]=> - string(3) "bar" -} -]]> - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - string(7) "MESSAGE" - ["body"]=> - string(3) "bar" - ["headers"]=> - array(6) { - ["transaction"]=> - string(2) "t1" - ["message-id"]=> - string(41) "ID:php.net-55293-1257226743606-4:3:-1:1:1" - ["destination"]=> - string(10) "/queue/foo" - ["timestamp"]=> - string(13) "1257227037059" - ["expires"]=> - string(1) "0" - ["priority"]=> - string(1) "0" - } -} -]]> - - - - - - diff --git a/reference/stomp/stomp/send.xml b/reference/stomp/stomp/send.xml deleted file mode 100644 index 503b712e6b41..000000000000 --- a/reference/stomp/stomp/send.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - Stomp::send - stomp_send - Sends a message - - - - &reftitle.description; - &style.oop; (method): - - public boolStomp::send - stringdestination - mixedmsg - arrayheaders - - &style.procedural;: - - boolstomp_send - resourcelink - stringdestination - mixedmsg - arrayheaders - - - Sends a message to the Message Broker. - - - - - &reftitle.parameters; - - &stomp.param.link; - - destination - - - Where to send the message - - - - - msg - - - Message to send. - - - - &stomp.param.headers; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - See stomp_ack. - - - - - &reftitle.notes; - &stomp.note.transaction; - &stomp.note.sync; - - - - diff --git a/reference/stomp/stomp/setreadtimeout.xml b/reference/stomp/stomp/setreadtimeout.xml deleted file mode 100644 index 77dcf81f88ec..000000000000 --- a/reference/stomp/stomp/setreadtimeout.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - Stomp::setReadTimeout - stomp_set_read_timeout - Sets read timeout - - - - &reftitle.description; - &style.oop; (method): - - public voidStomp::setReadTimeout - intseconds - intmicroseconds - - &style.procedural;: - - voidstomp_set_read_timeout - resourcelink - intseconds - intmicroseconds - - - Sets read timeout. - - - - - &reftitle.parameters; - - &stomp.param.link; - - seconds - - - The seconds part of the timeout to be set. - - - - - microseconds - - - The microseconds part of the timeout to be set. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - &style.oop; - -getMessage()); -} - -$stomp->setReadTimeout(10); - -/* close connection */ -unset($stomp); - -?> -]]> - - - - &style.procedural; - - -]]> - - - - - - diff --git a/reference/stomp/stomp/subscribe.xml b/reference/stomp/stomp/subscribe.xml deleted file mode 100644 index cf07173ca95f..000000000000 --- a/reference/stomp/stomp/subscribe.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - Stomp::subscribe - stomp_subscribe - Registers to listen to a given destination - - - - &reftitle.description; - &style.oop; (method): - - public boolStomp::subscribe - stringdestination - arrayheaders - - &style.procedural;: - - boolstomp_subscribe - resourcelink - stringdestination - arrayheaders - - - Registers to listen to a given destination. - - - - - &reftitle.parameters; - - &stomp.param.link; - - destination - - - Destination to subscribe to. - - - - &stomp.param.headers; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - See stomp_ack. - - - - - &reftitle.notes; - &stomp.note.sync; - - - - diff --git a/reference/stomp/stomp/unsubscribe.xml b/reference/stomp/stomp/unsubscribe.xml deleted file mode 100644 index faa20fafb8d5..000000000000 --- a/reference/stomp/stomp/unsubscribe.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - Stomp::unsubscribe - stomp_unsubscribe - Removes an existing subscription - - - - &reftitle.description; - &style.oop; (method): - - public boolStomp::unsubscribe - stringdestination - arrayheaders - - &style.procedural;: - - boolstomp_unsubscribe - resourcelink - stringdestination - arrayheaders - - - Removes an existing subscription. - - - - - &reftitle.parameters; - - &stomp.param.link; - - destination - - - Subscription to remove. - - - - &stomp.param.headers; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - See stomp_ack. - - - - - &reftitle.notes; - &stomp.note.sync; - - - - diff --git a/reference/stomp/stompexception.xml b/reference/stomp/stompexception.xml deleted file mode 100644 index b2fb456efbc3..000000000000 --- a/reference/stomp/stompexception.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - The StompException class - StompException - - - - -
    - &reftitle.intro; - -Represents an error raised by the stomp extension. See Exceptions for more information about Exceptions in PHP. - -
    - - -
    - &reftitle.classsynopsis; - - - - StompException - - - - - StompException - - - - extends - Exception - - - - - &InheritedMethods; - - - &Methods; - - - - -
    -
    - - &reference.stomp.entities.stompexception; - -
    - diff --git a/reference/stomp/stompexception/getdetails.xml b/reference/stomp/stompexception/getdetails.xml deleted file mode 100644 index d098dc8d9ab9..000000000000 --- a/reference/stomp/stompexception/getdetails.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - StompException::getDetails - Get exception details - - - - &reftitle.description; - - public stringStompException::getDetails - - - - Get exception details. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &string; containing the error details. - - - - - diff --git a/reference/stomp/stompframe.xml b/reference/stomp/stompframe.xml deleted file mode 100644 index 161ddc476b89..000000000000 --- a/reference/stomp/stompframe.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - The StompFrame class - StompFrame - - - - -
    - &reftitle.intro; - - Represents a message which was sent or received from a Stomp compliant Message Broker. - -
    - - -
    - &reftitle.classsynopsis; - - - - StompFrame - - - - - StompFrame - - - - &Properties; - - public - command - - - public - headers - - - public - body - - - - &Methods; - - - - -
    - - - -
    - &reftitle.properties; - - - command - - Frame command. - - - - headers - - Frame headers (&array;). - - - - body - - Frame body. - - - -
    - - - -
    - - &reference.stomp.entities.stompframe; - -
    - diff --git a/reference/stomp/stompframe/construct.xml b/reference/stomp/stompframe/construct.xml deleted file mode 100644 index 6da14748e64d..000000000000 --- a/reference/stomp/stompframe/construct.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - StompFrame::__construct - Constructor - - - - &reftitle.description; - - StompFrame::__construct - stringcommand - arrayheaders - stringbody - - - Constructor. - - - - - &reftitle.parameters; - - - command - - - Frame command - - - - - headers - - - Frame headers (&array;). - - - - - body - - - Frame body. - - - - - - - diff --git a/reference/stomp/versions.xml b/reference/stomp/versions.xml deleted file mode 100644 index 0d4b023832d1..000000000000 --- a/reference/stomp/versions.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/svm/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/svm/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/svm/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/svm/book.xml b/reference/svm/book.xml deleted file mode 100644 index a0118a2ccc20..000000000000 --- a/reference/svm/book.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - - - - Support Vector Machine - SVM - - - &reftitle.intro; - &warn.experimental; - - LibSVM is an efficient solver for SVM classification and regression problems. - The svm extension wraps this in a PHP interface for easy use in PHP scripts. - - - - &reference.svm.setup; - &reference.svm.examples; - - &reference.svm.svm; - &reference.svm.svmmodel; - &reference.svm.svmexception; - - - diff --git a/reference/svm/configure.xml b/reference/svm/configure.xml deleted file mode 100644 index d37c7fb2969a..000000000000 --- a/reference/svm/configure.xml +++ /dev/null @@ -1,31 +0,0 @@ - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;svm - - -
    - diff --git a/reference/svm/examples.xml b/reference/svm/examples.xml deleted file mode 100644 index a9ae39d00108..000000000000 --- a/reference/svm/examples.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - &reftitle.examples; - - - The basic process is to define parameters, supply training data to generate a - model on, then make predictions based on the model. There are a default set - of parameters that should get some results with most any input, so we'll start - by looking at the data. - - - Data is supplied in either a file, a stream, or as an array. If supplied in - a file or a stream, it must contain one line per training example, which must - be formatted as an integer class (usually 1 and -1) followed by a series of - feature/value pairs, in increasing feature order. The features are integers, - the values floats, usually scaled 0-1. For example: - - - -1 1:0.43 3:0.12 9284:0.2 - - - In a document classification problem, say a spam checker, each line would - represent a document. There would be two classes, -1 for spam, 1 for ham. - Each feature would represent some word, and the value would represent that - importance of that word to the document (perhaps the frequency count, with - the total scaled to unit length). Features that were 0 (e.g. the word did - not appear in the document at all) would simply not be included. - - - In array mode, the data must be passed as an array of arrays. Each sub-array - must have the class as the first element, then key => value sets for the - feature values pairs. - - - This data is passed to the SVM class's train function, which will return an - SVM model is successful. - - - Once a model has been generated, it can be used to make predictions about - previously unseen data. This can be passed as an array to the model's - predict function, in the same format as before, but without the label. - The response will be the class. - - - Models can be saved and restored as required, using the save and load - functions, which both take a file location. - - - - Train from array - - 0.43, 3 => 0.12, 9284 => 0.2), - array(1, 1 => 0.22, 5 => 0.01, 94 => 0.11), -); - -$svm = new SVM(); -$model = $svm->train($data); - -$data = array(1 => 0.43, 3 => 0.12, 9284 => 0.2); -$result = $model->predict($data); -var_dump($result); -$model->save('model.svm'); -?> -]]> - - &example.outputs.similar; - - - - - - Train from a file - -train("traindata.txt"); -?> -]]> - - - - - diff --git a/reference/svm/setup.xml b/reference/svm/setup.xml deleted file mode 100644 index 37b68cee60b1..000000000000 --- a/reference/svm/setup.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - &reftitle.setup; - -
    - &reftitle.required; - - Libsvm itself is required, and is available through some package - management - libsvm-devel for RPM based system or libsvm-dev for - Debian based ones. Alternatively it is available direct from the website. - If installing from the official website - then some steps will need to be taken as the package does not install - automatically. For example, assuming the latest version is 3.1: - - - - - - - This last step should show libsvm is installed. - -
    - -
    - &reftitle.install; - - &pecl.info; - &url.pecl.package;svm - -
    - -
    - diff --git a/reference/svm/svm.xml b/reference/svm/svm.xml deleted file mode 100644 index 913588775b96..000000000000 --- a/reference/svm/svm.xml +++ /dev/null @@ -1,365 +0,0 @@ - - - - - The SVM class - SVM - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - SVM - - - - - SVM - - - - &Constants; - - const - int - SVM::C_SVC - 0 - - - const - int - SVM::NU_SVC - 1 - - - const - int - SVM::ONE_CLASS - 2 - - - const - int - SVM::EPSILON_SVR - 3 - - - const - int - SVM::NU_SVR - 4 - - - const - int - SVM::KERNEL_LINEAR - 0 - - - const - int - SVM::KERNEL_POLY - 1 - - - const - int - SVM::KERNEL_RBF - 2 - - - const - int - SVM::KERNEL_SIGMOID - 3 - - - const - int - SVM::KERNEL_PRECOMPUTED - 4 - - - const - int - SVM::OPT_TYPE - 101 - - - const - int - SVM::OPT_KERNEL_TYPE - 102 - - - const - int - SVM::OPT_DEGREE - 103 - - - const - int - SVM::OPT_SHRINKING - 104 - - - const - int - SVM::OPT_PROBABILITY - 105 - - - const - int - SVM::OPT_GAMMA - 201 - - - const - int - SVM::OPT_NU - 202 - - - const - int - SVM::OPT_EPS - 203 - - - const - int - SVM::OPT_P - 204 - - - const - int - SVM::OPT_COEF_ZERO - 205 - - - const - int - SVM::OPT_C - 206 - - - const - int - SVM::OPT_CACHE_SIZE - 207 - - - &Methods; - - - - - -
    - - -
    - &reftitle.constants; -
    - SVM Constants - - - - SVM::C_SVC - - The basic C_SVC SVM type. The default, and a good starting point - - - - - SVM::NU_SVC - - The NU_SVC type uses a different, more flexible, error weighting - - - - - SVM::ONE_CLASS - - One class SVM type. Train just on a single class, using outliers as negative examples - - - - - SVM::EPSILON_SVR - - A SVM type for regression (predicting a value rather than just a class) - - - - - SVM::NU_SVR - - A NU style SVM regression type - - - - - SVM::KERNEL_LINEAR - - A very simple kernel, can work well on large document classification problems - - - - - SVM::KERNEL_POLY - - A polynomial kernel - - - - - SVM::KERNEL_RBF - - The common Gaussian RBD kernel. Handles non-linear problems well and is a good default for classification - - - - - SVM::KERNEL_SIGMOID - - A kernel based on the sigmoid function. Using this makes the SVM very similar to a two layer sigmoid based neural network - - - - - SVM::KERNEL_PRECOMPUTED - - A precomputed kernel - currently unsupported. - - - - - SVM::OPT_TYPE - - The options key for the SVM type - - - - - SVM::OPT_KERNEL_TYPE - - The options key for the kernel type - - - - - SVM::OPT_DEGREE - - - - - - - SVM::OPT_SHRINKING - - Training parameter, boolean, for whether to use the shrinking heuristics - - - - - SVM::OPT_PROBABILITY - - Training parameter, boolean, for whether to collect and use probability estimates - - - - - SVM::OPT_GAMMA - - Algorithm parameter for Poly, RBF and Sigmoid kernel types. - - - - - SVM::OPT_NU - - The option key for the nu parameter, only used in the NU_ SVM types - - - - - SVM::OPT_EPS - - The option key for the Epsilon parameter, used in epsilon regression - - - - - SVM::OPT_P - - Training parameter used by Episilon SVR regression - - - - - SVM::OPT_COEF_ZERO - - Algorithm parameter for poly and sigmoid kernels - - - - - SVM::OPT_C - - The option for the cost parameter that controls tradeoff between errors and generality - effectively the penalty for misclassifying training examples. - - - - - SVM::OPT_CACHE_SIZE - - Memory cache size, in MB - - - -
    -
    - - - -
    - - &reference.svm.entities.svm; - -
    - diff --git a/reference/svm/svm/construct.xml b/reference/svm/svm/construct.xml deleted file mode 100644 index 20791b6ab455..000000000000 --- a/reference/svm/svm/construct.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - SVM::__construct - Construct a new SVM object - - - - &reftitle.description; - - public SVM::__construct - - - - Constructs a new SVM object ready to accept training data. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.errors; - - Throws a SVMException if the libsvm - library could not be loaded. - - - - - diff --git a/reference/svm/svm/crossvalidate.xml b/reference/svm/svm/crossvalidate.xml deleted file mode 100644 index 032ecc15f199..000000000000 --- a/reference/svm/svm/crossvalidate.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - SVM::crossvalidate - Test training params on subsets of the training data - - - - &reftitle.description; - - public floatsvm::crossvalidate - arrayproblem - intnumber_of_folds - - - Crossvalidate can be used to test the effectiveness of the current - parameter set on a subset of the training data. Given a problem set - and a n "folds", it separates the problem set into n subsets, and the - repeatedly trains on one subset and tests on another. While the accuracy - will generally be lower than a SVM trained on the entire data set, the - accuracy score returned should be relatively useful, so it can be used to - test different training parameters. - - - - - - &reftitle.parameters; - - - problem - - - The problem data. This can either be in the form of an array, the URL - of an SVMLight formatted file, or a stream to an opened SVMLight - formatted datasource. - - - - - number_of_folds - - - The number of sets the data should be divided into and cross tested. - A higher number means smaller training sets and less reliability. 5 is - a good number to start with. - - - - - - - - &reftitle.returnvalues; - - The correct percentage, expressed as a floating point number from 0-1. - In the case of NU_SVC or EPSILON_SVR kernels the mean squared error will - returned instead. - - - - - &reftitle.seealso; - - SVM::train - - - - - diff --git a/reference/svm/svm/getoptions.xml b/reference/svm/svm/getoptions.xml deleted file mode 100644 index 51c8a188a372..000000000000 --- a/reference/svm/svm/getoptions.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - SVM::getOptions - Return the current training parameters - - - - &reftitle.description; - - public arraySVM::getOptions - - - - Retrieve an array containing the training parameters. - The parameters will be keyed on the predefined SVM constants. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an array of configuration settings. - - - - - - diff --git a/reference/svm/svm/setoptions.xml b/reference/svm/svm/setoptions.xml deleted file mode 100644 index fde81fd0ac29..000000000000 --- a/reference/svm/svm/setoptions.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - SVM::setOptions - Set training parameters - - - - &reftitle.description; - - public boolSVM::setOptions - arrayparams - - - Set one or more training parameters. - - - - - - &reftitle.parameters; - - - params - - - An array of training parameters, keyed on the SVM constants. - - - - - - - - &reftitle.returnvalues; - - Return true on success, throws SVMException on error. - - - - diff --git a/reference/svm/svm/train.xml b/reference/svm/svm/train.xml deleted file mode 100644 index 6d7e378e1c42..000000000000 --- a/reference/svm/svm/train.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - SVM::train - Create a SVMModel based on training data - - - - &reftitle.description; - - public SVMModelsvm::train - arrayproblem - arrayweights - - - Train a support vector machine based on the supplied training data. - - - - - - &reftitle.parameters; - - - problem - - - The problem can be provided in three different ways. - An array, where the data should start with the class label - (usually 1 or -1) then followed by a sparse data set of - dimension => data pairs. - A URL to a file containing a SVM Light formatted problem, with the - each line being a new training example, the start of each line - containing the class (1, -1) then a series of tab separated data - values shows as key:value. - A opened stream pointing to a data source formatted as in the file above. - - - - - weights - - - Weights are an optional set of weighting parameters for the different - classes, to help account for unbalanced training sets. For example, - if the classes were 1 and -1, and -1 had significantly more example - than one, the weight for -1 could be 0.5. Weights should be in the range 0-1. - - - - - - - - &reftitle.returnvalues; - - Returns an SVMModel that can be used to classify previously unseen data. - Throws SVMException on error - - - - - diff --git a/reference/svm/svmexception.xml b/reference/svm/svmexception.xml deleted file mode 100644 index 7ee17a5dab65..000000000000 --- a/reference/svm/svmexception.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - The SVMException class - SVMException - - - - -
    - &reftitle.intro; - - The exception object thrown on errors from the SVM and SVMModel classes. - -
    - - -
    - &reftitle.classsynopsis; - - - - SVMException - - - - - SVMException - - - - extends - Exception - - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
    - - -
    - -
    - diff --git a/reference/svm/svmmodel.xml b/reference/svm/svmmodel.xml deleted file mode 100644 index af151a7cd786..000000000000 --- a/reference/svm/svmmodel.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - The SVMModel class - SVMModel - - - - -
    - &reftitle.intro; - - The SVMModel is the end result of the training process. - It can be used to classify previously unseen data. - -
    - - -
    - &reftitle.classsynopsis; - - - - SVMModel - - - - - SVMModel - - - - - &Methods; - - - - - -
    - -
    - - &reference.svm.entities.svmmodel; - -
    - diff --git a/reference/svm/svmmodel/checkprobabilitymodel.xml b/reference/svm/svmmodel/checkprobabilitymodel.xml deleted file mode 100644 index d0c8eb96a308..000000000000 --- a/reference/svm/svmmodel/checkprobabilitymodel.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - SVMModel::checkProbabilityModel - Returns true if the model has probability information - - - - &reftitle.description; - - public boolSVMModel::checkProbabilityModel - - - - Returns true if the model contains probability information. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Return a boolean value - - - - - diff --git a/reference/svm/svmmodel/construct.xml b/reference/svm/svmmodel/construct.xml deleted file mode 100644 index 473228eba4d7..000000000000 --- a/reference/svm/svmmodel/construct.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - SVMModel::__construct - Construct a new SVMModel - - - - &reftitle.description; - - public SVMModel::__construct - stringfilename - - - Build a new SVMModel. Models will usually be created from the - SVM::train function, but then saved models may be restored directly. - - - - - - &reftitle.parameters; - - - filename - - - The filename for the saved model file this model should load. - - - - - - - - &reftitle.errors; - - Throws a SVMException on error - - - - - &reftitle.seealso; - - SVMModel::load - - - - - diff --git a/reference/svm/svmmodel/getlabels.xml b/reference/svm/svmmodel/getlabels.xml deleted file mode 100644 index 81ca072d20b8..000000000000 --- a/reference/svm/svmmodel/getlabels.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - SVMModel::getLabels - Get the labels the model was trained on - - - - &reftitle.description; - - public arraySVMModel::getLabels - - - - Return an array of labels that the model was trained on. For regression and one class - models an empty array is returned. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Return an array of labels - - - - - &reftitle.seealso; - - SVMModel::getNrClass - - - - - diff --git a/reference/svm/svmmodel/getnrclass.xml b/reference/svm/svmmodel/getnrclass.xml deleted file mode 100644 index 2c8e7bb87144..000000000000 --- a/reference/svm/svmmodel/getnrclass.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - SVMModel::getNrClass - Returns the number of classes the model was trained with - - - - &reftitle.description; - - public intSVMModel::getNrClass - - - - Returns the number of classes the model was trained with, will return 2 for one class and regression models. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Return an integer number of classes - - - - - diff --git a/reference/svm/svmmodel/getsvmtype.xml b/reference/svm/svmmodel/getsvmtype.xml deleted file mode 100644 index 941d4b707a40..000000000000 --- a/reference/svm/svmmodel/getsvmtype.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - SVMModel::getSvmType - Get the SVM type the model was trained with - - - - &reftitle.description; - - public intSVMModel::getSvmType - - - - Returns an integer value representing the type of the SVM model used, e.g SVM::C_SVC. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Return an integer SVM type - - - - - diff --git a/reference/svm/svmmodel/getsvrprobability.xml b/reference/svm/svmmodel/getsvrprobability.xml deleted file mode 100644 index d63a040e2436..000000000000 --- a/reference/svm/svmmodel/getsvrprobability.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - SVMModel::getSvrProbability - Get the sigma value for regression types - - - - &reftitle.description; - - public floatSVMModel::getSvrProbability - - - - For regression models, returns a sigma value. If there is no probability - information or the model is not SVR, 0 is returned. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a sigma value - - - - - diff --git a/reference/svm/svmmodel/load.xml b/reference/svm/svmmodel/load.xml deleted file mode 100644 index 185b8c6c37dc..000000000000 --- a/reference/svm/svmmodel/load.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - SVMModel::load - Load a saved SVM Model - - - - &reftitle.description; - - public boolSVMModel::load - stringfilename - - - Load a model file ready for classification or regression. - - - - - - &reftitle.parameters; - - - filename - - - The filename of the model. - - - - - - - - &reftitle.returnvalues; - - Throws SVMException on error. - Returns true on success. - - - - - &reftitle.seealso; - - SVMModel::save - - - - - diff --git a/reference/svm/svmmodel/predict-probability.xml b/reference/svm/svmmodel/predict-probability.xml deleted file mode 100644 index 4d570082ad70..000000000000 --- a/reference/svm/svmmodel/predict-probability.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - SVMModel::predict_probability - Return class probabilities for previous unseen data - - - - &reftitle.description; - - public floatSVMModel::predict_probability - arraydata - - - This function accepts an array of data and attempts to predict the class, as with the predict function. - Additionally, however, this function returns an array of probabilities, one per class in the model, which - represent the estimated chance of the data supplied being a member of that class. Requires that the model - to be used has been trained with the probability parameter set to true. - - - - - - &reftitle.parameters; - - - data - - - The array to be classified. This should be a series of key => value - pairs in increasing key order, but not necessarily continuous. - - - - - probabilities - - - The supplied value will be filled with the probabilities. This will be either null, in the case - of a model without probability information, or an array where the index is the class name and the value - the predicted probability. - - - - - - - - &reftitle.returnvalues; - - Float the predicted value. This will be a class label in the case of - classification, a real value in the case of regression. - Throws SVMException on error - - - - - &reftitle.seealso; - - SVM::predict - - - - - - diff --git a/reference/svm/svmmodel/predict.xml b/reference/svm/svmmodel/predict.xml deleted file mode 100644 index ff8b26f7831b..000000000000 --- a/reference/svm/svmmodel/predict.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - SVMModel::predict - Predict a value for previously unseen data - - - - &reftitle.description; - - public floatSVMModel::predict - arraydata - - - This function accepts an array of data and attempts to predict the class - or regression value based on the model extracted from previously trained data. - - - - - - &reftitle.parameters; - - - data - - - The array to be classified. This should be a series of key => value - pairs in increasing key order, but not necessarily continuous. - - - - - - - - &reftitle.returnvalues; - - Float the predicted value. This will be a class label in the case of - classification, a real value in the case of regression. - Throws SVMException on error - - - - - &reftitle.seealso; - - SVM::train - - - - - - diff --git a/reference/svm/svmmodel/save.xml b/reference/svm/svmmodel/save.xml deleted file mode 100644 index 3b0d35d1e02e..000000000000 --- a/reference/svm/svmmodel/save.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - SVMModel::save - Save a model to a file - - - - &reftitle.description; - - public boolSVMModel::save - stringfilename - - - Save the model data to a file, for later use. - - - - - - &reftitle.parameters; - - - filename - - - The file to save the model to. - - - - - - - - &reftitle.returnvalues; - - Throws SVMException on error. - Returns true on success. - - - - - &reftitle.seealso; - - SVMModel::load - - - - - diff --git a/reference/svm/versions.xml b/reference/svm/versions.xml deleted file mode 100644 index b0be5064d778..000000000000 --- a/reference/svm/versions.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/svn/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/svn/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/svn/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/svn/book.xml b/reference/svn/book.xml deleted file mode 100644 index c753ead26125..000000000000 --- a/reference/svn/book.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - Subversion - SVN - - - - &reftitle.intro; - - This extension implements PHP bindings for - Subversion (SVN), a version - control system, allowing PHP scripts to communicate with SVN repositories - and working copies without direct command line calls to the - svn - executable. - - &warn.experimental; - - - - &reference.svn.setup; - &reference.svn.constants; - &reference.svn.reference; - - - diff --git a/reference/svn/configure.xml b/reference/svn/configure.xml deleted file mode 100644 index f77dc938a6dc..000000000000 --- a/reference/svn/configure.xml +++ /dev/null @@ -1,47 +0,0 @@ - - -
    - &reftitle.install; - - &pecl.info; - - - - If ./configure is having trouble finding the - SVN files (for example, Subversion was installed with a - different prefix directory), use - ./configure --with-svn=$USR_PATH - to specify the directory where the - include/subversion-1/ folder is located. - - - &pecl.windows.download; - - - - If the extension is compiled against libsvn 1.3, - functions that work with working copies will fail - when used on working copies created by Subversion 1.4. - - -
    - diff --git a/reference/svn/constants.xml b/reference/svn/constants.xml deleted file mode 100644 index dfd7c2da00e2..000000000000 --- a/reference/svn/constants.xml +++ /dev/null @@ -1,419 +0,0 @@ - - - - &reftitle.constants; - &extension.constants; - - - - SVN_REVISION_HEAD - (int) - - - - Magic number (-1) specifying the HEAD revision - - - - - - Constants usable with <function>svn_auth_set_parameter</function> - - - SVN_AUTH_PARAM_DEFAULT_USERNAME - (string) - - - - Property for default username to use when performing basic authentication - - - - - - SVN_AUTH_PARAM_DEFAULT_PASSWORD - (string) - - - - Property for default password to use when performing basic authentication - - - - - - SVN_AUTH_PARAM_NON_INTERACTIVE - (string) - - - - - - SVN_AUTH_PARAM_DONT_STORE_PASSWORDS - (string) - - - - - - SVN_AUTH_PARAM_NO_AUTH_CACHE - (string) - - - - - - SVN_AUTH_PARAM_SSL_SERVER_FAILURES - (string) - - - - - - SVN_AUTH_PARAM_SSL_SERVER_CERT_INFO - (string) - - - - - - SVN_AUTH_PARAM_CONFIG - (string) - - - - - - SVN_AUTH_PARAM_SERVER_GROUP - (string) - - - - - - SVN_AUTH_PARAM_CONFIG_DIR - (string) - - - - - - PHP_SVN_AUTH_PARAM_IGNORE_SSL_VERIFY_ERRORS - (string) - - - - Custom property for ignoring SSL cert verification errors - - - - - - Filesystem constants - - - SVN_FS_CONFIG_FS_TYPE - (string) - - - - Configuration key that determines filesystem type - - - - - - SVN_FS_TYPE_BDB - (string) - - - - Filesystem is Berkeley-DB implementation - - - - - - SVN_FS_TYPE_FSFS - (string) - - - - Filesystem is native-filesystem implementation - - - - - - Reserved property constants - - - SVN_PROP_REVISION_DATE - (string) - - - - svn:date - - - - - - SVN_PROP_REVISION_ORIG_DATE - (string) - - - - svn:original-date - - - - - - SVN_PROP_REVISION_AUTHOR - (string) - - - - svn:author - - - - - - SVN_PROP_REVISION_LOG - (string) - - - - svn:log - - - - - - Working copy status constants - - - SVN_WC_STATUS_NONE - (int) - - - - Status does not exist - - - - - - SVN_WC_STATUS_UNVERSIONED - (int) - - - - Item is not versioned in working copy - - - - - - SVN_WC_STATUS_NORMAL - (int) - - - - Item exists, nothing else is happening - - - - - - SVN_WC_STATUS_ADDED - (int) - - - - Item is scheduled for addition - - - - - - SVN_WC_STATUS_MISSING - (int) - - - - Item is versioned but missing from the working copy - - - - - - SVN_WC_STATUS_DELETED - (int) - - - - Item is scheduled for deletion - - - - - - SVN_WC_STATUS_REPLACED - (int) - - - - Item was deleted and then re-added - - - - - - SVN_WC_STATUS_MODIFIED - (int) - - - - Item (text or properties) was modified - - - - - - SVN_WC_STATUS_MERGED - (int) - - - - Item's local modifications were merged with repository modifications - - - - - - SVN_WC_STATUS_CONFLICTED - (int) - - - - Item's local modifications conflicted with repository modifications - - - - - - SVN_WC_STATUS_IGNORED - (int) - - - - Item is unversioned but configured to be ignored - - - - - - SVN_WC_STATUS_OBSTRUCTED - (int) - - - - Unversioned item is in the way of a versioned resource - - - - - - SVN_WC_STATUS_EXTERNAL - (int) - - - - Unversioned path that is populated using svn:externals - - - - - - SVN_WC_STATUS_INCOMPLETE - (int) - - - - Directory does not contain complete entries list - - - - - - Node type constants - - - SVN_NODE_NONE - (int) - - - - Absent - - - - - - SVN_NODE_FILE - (int) - - - - File - - - - - - SVN_NODE_DIR - (int) - - - - Directory - - - - - - SVN_NODE_UNKNOWN - (int) - - - - Something Subversion cannot identify - - - - - - - diff --git a/reference/svn/functions/svn-add.xml b/reference/svn/functions/svn-add.xml deleted file mode 100644 index 99a6b4b5e51b..000000000000 --- a/reference/svn/functions/svn-add.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - svn_add - Schedules the addition of an item in a working directory - - - - &reftitle.description; - - boolsvn_add - stringpath - boolrecursive&true; - boolforce&false; - - - Adds the file, directory or symbolic link at path - to the working directory. The item will be added to the repository - the next time you call svn_commit on the working - copy. - - - - - &reftitle.parameters; - - - path - - - Path of item to add. - - &svn.relativepath; - - - - recursive - - - If item is directory, whether or not to recursively add - all of its contents. Default is &true; - - - - - force - - - If true, Subversion will recurse into already versioned directories - in order to add unversioned files that may be hiding in those - directories. Default is &false; - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>svn_add</function> example - - In a working directory where svn status - returns: - - - - - ...this code: - - -]]> - - - ...will schedule foobar.txt for addition into - the repository. - - - - - - &reftitle.notes; - &warn.experimental.func; - - - - &reftitle.seealso; - - SVN documentation on svn add - - - - - diff --git a/reference/svn/functions/svn-auth-get-parameter.xml b/reference/svn/functions/svn-auth-get-parameter.xml deleted file mode 100644 index 61eeef93613b..000000000000 --- a/reference/svn/functions/svn-auth-get-parameter.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - svn_auth_get_parameter - Retrieves authentication parameter - - - - &reftitle.description; - - stringsvn_auth_get_parameter - stringkey - - - Retrieves authentication parameter at key. - For a list of valid keys and their meanings, consult the - authentication constants list. - - - - - &reftitle.parameters; - - - key - - - String key name. Use the authentication constants - defined by this extension to specify a key. - - - - - - - - &reftitle.returnvalues; - - Returns the string value of the parameter at key; - returns &null; if parameter does not exist. - - - - - &reftitle.notes; - &warn.experimental.func; - - - - &reftitle.seealso; - - svn_auth_set_parameter - Authentication constants - - - - - diff --git a/reference/svn/functions/svn-auth-set-parameter.xml b/reference/svn/functions/svn-auth-set-parameter.xml deleted file mode 100644 index 17146f20bcb3..000000000000 --- a/reference/svn/functions/svn-auth-set-parameter.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - svn_auth_set_parameter - Sets an authentication parameter - - - - &reftitle.description; - - voidsvn_auth_set_parameter - stringkey - stringvalue - - - Sets authentication parameter at key to value. - For a list of valid keys and their meanings, consult the - authentication constants list. - - - - - &reftitle.parameters; - - - key - - - String key name. Use the authentication constants - defined by this extension to specify a key. - - - - - value - - - String value to set to parameter at key. Format of value varies - with the parameter. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Default authentication example - - This example configures SVN so that the default username to use - is 'Bob' and the default password is 'abc123': - - - -]]> - - - - - - &reftitle.notes; - &warn.experimental.func; - - - - &reftitle.seealso; - - svn_auth_get_parameter - Authentication constants - - - - - diff --git a/reference/svn/functions/svn-blame.xml b/reference/svn/functions/svn-blame.xml deleted file mode 100644 index 5f84cc354c84..000000000000 --- a/reference/svn/functions/svn-blame.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - svn_blame - Get the SVN blame for a file - - - - &reftitle.description; - - arraysvn_blame - stringrepository_url - intrevision_noSVN_REVISION_HEAD - - - Get the SVN blame of a file from a repository URL. - - - - - &reftitle.parameters; - - - repository_url - - - The repository URL. - - - - - revision_no - - - The revision number. - - - - - - - - &reftitle.returnvalues; - - An array of SVN blame information separated by line - which includes the revision number, line number, line of code, - author, and date. - - - - - &reftitle.examples; - - <function>svn_blame</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - svn_diff - svn_logs - svn_status - - - - - diff --git a/reference/svn/functions/svn-cat.xml b/reference/svn/functions/svn-cat.xml deleted file mode 100644 index 8233a1f2a0af..000000000000 --- a/reference/svn/functions/svn-cat.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - svn_cat - Returns the contents of a file in a repository - - - - &reftitle.description; - - stringsvn_cat - stringrepos_url - intrevision_no - - - Returns the contents of the URL repos_url to - a file in the repository, optionally at revision number - revision_no. - - - - - &reftitle.parameters; - - - repos_url - - - String URL path to item in a repository. - - - - - revision_no - - - Integer revision number of item to retrieve, default is the HEAD - revision. - - - - - - - - &reftitle.returnvalues; - - Returns the string contents of the item from the repository on - success, and &false; on failure. - - - - - &reftitle.examples; - - Basic example - - This example retrieves the contents of a file at revision 28: - - - -]]> - - - - - - &reftitle.notes; - &warn.experimental.func; - - - - &reftitle.seealso; - - svn_list - SVN documentation on svn cat - - - - - diff --git a/reference/svn/functions/svn-checkout.xml b/reference/svn/functions/svn-checkout.xml deleted file mode 100644 index 0344e74149e8..000000000000 --- a/reference/svn/functions/svn-checkout.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - svn_checkout - Checks out a working copy from the repository - - - - &reftitle.description; - - boolsvn_checkout - stringrepos - stringtargetpath - intrevision - intflags0 - - - Checks out a working copy from the repository at repos - to targetpath at revision revision. - - - - - &reftitle.parameters; - - - repos - - - String URL path to directory in repository to check out. - - - - - targetpath - - - String local path to directory to check out in to - - &svn.relativepath; - - - - revision - - - Integer revision number of repository to check out. Default is - HEAD, the most recent revision. - - - - - flags - - - Any combination of SVN_NON_RECURSIVE and - SVN_IGNORE_EXTERNALS. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Basic example - - This example demonstrates how to check out a directory from - a repository to a directory named calc: - - - -]]> - - - The dirname(__FILE__) call is necessary in order - to convert the calc relative path into an absolute one. If calc - exists, you can also use realpath to retrieve - an absolute path. - - - - - - &reftitle.notes; - &warn.experimental.func; - - - - &reftitle.seealso; - - svn_add - svn_commit - svn_status - svn_update - SVN documentation on svn checkout - - - - - diff --git a/reference/svn/functions/svn-cleanup.xml b/reference/svn/functions/svn-cleanup.xml deleted file mode 100644 index 914a1d52917f..000000000000 --- a/reference/svn/functions/svn-cleanup.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - svn_cleanup - Recursively cleanup a working copy directory, finishing incomplete operations and removing locks - - - - &reftitle.description; - - boolsvn_cleanup - stringworkingdir - - - Recursively cleanup working copy directory workingdir, - finishing any incomplete operations and removing working copy locks. Use - when a working copy is in limbo and needs to be usable again. - - - - - &reftitle.parameters; - - - workingdir - - - String path to local working directory to cleanup - - &svn.relativepath; - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Basic example - - This example demonstrates clean up of a working copy in a - directory named help-me: - - - -]]> - - - The realpath call is necessary due to - SVN's quirky handling of relative paths. - - - - - - &reftitle.notes; - &warn.experimental.func; - - - - &reftitle.seealso; - - update - SVN documentation on svn cleanup - - - - - diff --git a/reference/svn/functions/svn-client-version.xml b/reference/svn/functions/svn-client-version.xml deleted file mode 100644 index 3e7067324d23..000000000000 --- a/reference/svn/functions/svn-client-version.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - svn_client_version - Returns the version of the SVN client libraries - - - - &reftitle.description; - - stringsvn_client_version - - - - Returns the version of the SVN client libraries - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - String version number, usually in form of x.y.z. - - - - - &reftitle.examples; - - Basic example - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-commit.xml b/reference/svn/functions/svn-commit.xml deleted file mode 100644 index 2a6872332c63..000000000000 --- a/reference/svn/functions/svn-commit.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - svn_commit - Sends changes from the local working copy to the repository - - - - &reftitle.description; - - arraysvn_commit - stringlog - arraytargets - boolrecursive&true; - - - Commits changes made in the local working copy files enumerated in - the targets array to the repository, with the - log message log. Directories in the targets - array will be recursively committed unless recursive - is set to &false;. - - - - This function does not have any parameters for specifying authentication, - so a username and password must be set using svn_auth_set_parameter - - - - - - &reftitle.parameters; - - - log - - - String log text to commit - - - - - targets - - - Array of local paths of files to be committed - - - - This parameter must be an array, a string for a single - target is not acceptable. - - - &svn.relativepath; - - - - recursive - - - Boolean flag to disable recursive committing of - directories in the targets array. - Default is &true;. - - - - - - - - &reftitle.returnvalues; - - Returns array in form of: - - - integer revision number of commit - 1 => string ISO 8601 date and time of commit - 2 => name of committer -) -]]> - - - Returns &false; on failure. - - - - - &reftitle.examples; - - Basic example - - This example commits the calculator directory to a repository, using - the username Bob and the password abc123 (hopefully, his password is - stronger): - - - -]]> - - &example.outputs; - - 1415, - 1 => '2007-05-26T01:44:28.453125Z', - 2 => 'Bob' -) -]]> - - - - - - &reftitle.notes; - &warn.experimental.func; - - - - &reftitle.seealso; - - svn_auth_set_parameter - SVN documentation on svn commit - - - - - diff --git a/reference/svn/functions/svn-delete.xml b/reference/svn/functions/svn-delete.xml deleted file mode 100644 index e162c25aa268..000000000000 --- a/reference/svn/functions/svn-delete.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - svn_delete - Delete items from a working copy or repository - - - - &reftitle.description; - - boolsvn_delete - stringpath - boolforce&false; - - - Deletes the file, directory or symbolic link at path - from the working directory. The item will be deleted from the repository - the next time you call svn_commit on the working - copy. - - - - - &reftitle.parameters; - - - path - - - Path of item to delete. - - &svn.relativepath; - - - - force - - - If &true;, the file will be deleted even if it has local modifications. - Otherwise, local modifications will result in a failure. Default is - &false; - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.notes; - &warn.experimental.func; - - - - &reftitle.seealso; - - SVN documentation on svn - delete - - - - - diff --git a/reference/svn/functions/svn-diff.xml b/reference/svn/functions/svn-diff.xml deleted file mode 100644 index bdb3d2513c2e..000000000000 --- a/reference/svn/functions/svn-diff.xml +++ /dev/null @@ -1,204 +0,0 @@ - - - - - svn_diff - Recursively diffs two paths - - - - &reftitle.description; - - arraysvn_diff - stringpath1 - intrev1 - stringpath2 - intrev2 - - - Recursively diffs two paths, path1 and - path2. - - - - This is not a general-purpose diff utility. Only local files - that are versioned may be diffed: other files will fail. - - - - - - &reftitle.parameters; - - - path1 - - - First path to diff. This can be a URL to a file/directory in an SVN - repository or a local file/directory path. - - &svn.relativepath; - - - If a local file path has only backslashes and no forward slashes, - this extension will fail to find the path. Always - replace all backslashes with forward slashes when using this - function. - - - - - - rev1 - - - First path's revision number. Use SVN_REVISION_HEAD - to specify the most recent revision. - - - - - path2 - - - Second path to diff. See path1 for description. - - - - - rev2 - - - Second path's revision number. See rev1 - for description. - - - - - - - - &reftitle.returnvalues; - - Returns an array-list consisting of two streams: the first is the diff output - and the second contains error stream output. The streams can be - read using fread. Returns &false; or &null; on - error. - - - The diff output will, by default, be in the form of Subversion's - custom unified diff format, but an - external - diff engine may be - used depending on Subversion's configuration. - - - - - &reftitle.examples; - - Basic example - - This example demonstrates the basic usage of this function, and - the retrieval of contents from the stream: - - - -]]> - - &example.outputs; - - - - - - Diffing two revisions of a repository path - - This example implements a wrapper function that allows a user - to easily diff two revisions of the same item using an external - repository path (the default syntax is somewhat verbose): - - - -]]> - - - - Portably diffing two local files - - This example implements a wrapper function that portably - diffs two local files, compensating for the realpath - fix and the backslashes bug: - - - -]]> - - - - - - &reftitle.notes; - &warn.experimental.func; - - - - &reftitle.seealso; - - SVN documentation on svn diff - - - - - diff --git a/reference/svn/functions/svn-export.xml b/reference/svn/functions/svn-export.xml deleted file mode 100644 index b596b56681aa..000000000000 --- a/reference/svn/functions/svn-export.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - svn_export - Export the contents of a SVN directory - - - - &reftitle.description; - - boolsvn_export - stringfrompath - stringtopath - boolworking_copy&true; - intrevision_no-1 - - - Export the contents of either a working copy or repository into a - 'clean' directory. - - - - - &reftitle.parameters; - - - frompath - - - The path to the current repository. - - - - - topath - - - The path to the new repository. - - - - - working_copy - - - If &true;, it will export uncommitted files from the working copy. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>svn_export</function> example - - -]]> - - - - - - &reftitle.seealso; - - svn_import - - - - - diff --git a/reference/svn/functions/svn-fs-abort-txn.xml b/reference/svn/functions/svn-fs-abort-txn.xml deleted file mode 100644 index caf7cc3747ab..000000000000 --- a/reference/svn/functions/svn-fs-abort-txn.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - svn_fs_abort_txn - Aborts a transaction - - - - &reftitle.description; - - boolsvn_fs_abort_txn - resourcetxn - - &warn.undocumented.func; - - Aborts a transaction. - - - - - &reftitle.parameters; - - - txn - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-fs-apply-text.xml b/reference/svn/functions/svn-fs-apply-text.xml deleted file mode 100644 index d2c4fd9c550f..000000000000 --- a/reference/svn/functions/svn-fs-apply-text.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - svn_fs_apply_text - Creates and returns a stream that will be used to replace the contents of a file - - - - &reftitle.description; - - resourcesvn_fs_apply_text - resourceroot - stringpath - - &warn.undocumented.func; - - Creates and returns a stream that will be used to replace the contents of a file. - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-fs-begin-txn2.xml b/reference/svn/functions/svn-fs-begin-txn2.xml deleted file mode 100644 index 69654ec99b1a..000000000000 --- a/reference/svn/functions/svn-fs-begin-txn2.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - svn_fs_begin_txn2 - Create a new transaction - - - - &reftitle.description; - - resourcesvn_fs_begin_txn2 - resourcerepos - intrev - - &warn.undocumented.func; - - Create a new transaction - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-fs-change-node-prop.xml b/reference/svn/functions/svn-fs-change-node-prop.xml deleted file mode 100644 index 4e9e4d30a537..000000000000 --- a/reference/svn/functions/svn-fs-change-node-prop.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - svn_fs_change_node_prop - Return true if everything is ok, false otherwise - - - - &reftitle.description; - - boolsvn_fs_change_node_prop - resourceroot - stringpath - stringname - stringvalue - - &warn.undocumented.func; - - Return true if everything is ok, false otherwise - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-fs-check-path.xml b/reference/svn/functions/svn-fs-check-path.xml deleted file mode 100644 index b366ecad5378..000000000000 --- a/reference/svn/functions/svn-fs-check-path.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - svn_fs_check_path - Determines what kind of item lives at path in a given repository fsroot - - - - &reftitle.description; - - intsvn_fs_check_path - resourcefsroot - stringpath - - &warn.undocumented.func; - - Determines what kind of item lives at path in a given repository fsroot - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-fs-contents-changed.xml b/reference/svn/functions/svn-fs-contents-changed.xml deleted file mode 100644 index f71ad3f02de7..000000000000 --- a/reference/svn/functions/svn-fs-contents-changed.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - svn_fs_contents_changed - Return true if content is different, false otherwise - - - - &reftitle.description; - - boolsvn_fs_contents_changed - resourceroot1 - stringpath1 - resourceroot2 - stringpath2 - - &warn.undocumented.func; - - Return true if content is different, false otherwise - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-fs-copy.xml b/reference/svn/functions/svn-fs-copy.xml deleted file mode 100644 index 8d04a85251a0..000000000000 --- a/reference/svn/functions/svn-fs-copy.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - svn_fs_copy - Copies a file or a directory - - - - &reftitle.description; - - boolsvn_fs_copy - resourcefrom_root - stringfrom_path - resourceto_root - stringto_path - - &warn.undocumented.func; - - Copies a file or a directory. - - - - - &reftitle.parameters; - - - from_root - - - - - - - - from_path - - - - - - - - to_root - - - - - - - - to_path - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-fs-delete.xml b/reference/svn/functions/svn-fs-delete.xml deleted file mode 100644 index 5aca845da904..000000000000 --- a/reference/svn/functions/svn-fs-delete.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - svn_fs_delete - Deletes a file or a directory - - - - &reftitle.description; - - boolsvn_fs_delete - resourceroot - stringpath - - &warn.undocumented.func; - - Deletes a file or a directory. - - - - - &reftitle.parameters; - - - root - - - - - - - - path - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-fs-dir-entries.xml b/reference/svn/functions/svn-fs-dir-entries.xml deleted file mode 100644 index aab48816f64c..000000000000 --- a/reference/svn/functions/svn-fs-dir-entries.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - svn_fs_dir_entries - Enumerates the directory entries under path; returns a hash of dir names to file type - - - - &reftitle.description; - - arraysvn_fs_dir_entries - resourcefsroot - stringpath - - &warn.undocumented.func; - - Enumerates the directory entries under path; returns a hash of dir names to file type - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-fs-file-contents.xml b/reference/svn/functions/svn-fs-file-contents.xml deleted file mode 100644 index 288212338b83..000000000000 --- a/reference/svn/functions/svn-fs-file-contents.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - svn_fs_file_contents - Returns a stream to access the contents of a file from a given version of the fs - - - - &reftitle.description; - - resourcesvn_fs_file_contents - resourcefsroot - stringpath - - &warn.undocumented.func; - - Returns a stream to access the contents of a file from a given version of the fs - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-fs-file-length.xml b/reference/svn/functions/svn-fs-file-length.xml deleted file mode 100644 index 16f70702d160..000000000000 --- a/reference/svn/functions/svn-fs-file-length.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - svn_fs_file_length - Returns the length of a file from a given version of the fs - - - - &reftitle.description; - - intsvn_fs_file_length - resourcefsroot - stringpath - - &warn.undocumented.func; - - Returns the length of a file from a given version of the fs - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-fs-is-dir.xml b/reference/svn/functions/svn-fs-is-dir.xml deleted file mode 100644 index 0be03c261cc5..000000000000 --- a/reference/svn/functions/svn-fs-is-dir.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - svn_fs_is_dir - Determines if a path points to a directory - - - - &reftitle.description; - - boolsvn_fs_is_dir - resourceroot - stringpath - - &warn.undocumented.func; - - Determines if the given path points to a directory. - - - - - &reftitle.parameters; - - - root - - - - - - - - path - - - - - - - - - - - &reftitle.returnvalues; - - Returns &true; if the path points to a directory, &false; otherwise. - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-fs-is-file.xml b/reference/svn/functions/svn-fs-is-file.xml deleted file mode 100644 index 4280ee508c60..000000000000 --- a/reference/svn/functions/svn-fs-is-file.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - svn_fs_is_file - Determines if a path points to a file - - - - &reftitle.description; - - boolsvn_fs_is_file - resourceroot - stringpath - - &warn.undocumented.func; - - Determines if the given path points to a file. - - - - - &reftitle.parameters; - - - root - - - - - - - - path - - - - - - - - - - - &reftitle.returnvalues; - - Returns &true; if the path points to a file, &false; otherwise. - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-fs-make-dir.xml b/reference/svn/functions/svn-fs-make-dir.xml deleted file mode 100644 index c42cabe803e2..000000000000 --- a/reference/svn/functions/svn-fs-make-dir.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - svn_fs_make_dir - Creates a new empty directory - - - - &reftitle.description; - - boolsvn_fs_make_dir - resourceroot - stringpath - - &warn.undocumented.func; - - Creates a new empty directory. - - - - - &reftitle.parameters; - - - root - - - - - - - - path - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-fs-make-file.xml b/reference/svn/functions/svn-fs-make-file.xml deleted file mode 100644 index 2ec68b1ea643..000000000000 --- a/reference/svn/functions/svn-fs-make-file.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - svn_fs_make_file - Creates a new empty file - - - - &reftitle.description; - - boolsvn_fs_make_file - resourceroot - stringpath - - &warn.undocumented.func; - - Creates a new empty file. - - - - - &reftitle.parameters; - - - root - - - - - - - - path - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-fs-node-created-rev.xml b/reference/svn/functions/svn-fs-node-created-rev.xml deleted file mode 100644 index ab23c9db5a50..000000000000 --- a/reference/svn/functions/svn-fs-node-created-rev.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - svn_fs_node_created_rev - Returns the revision in which path under fsroot was created - - - - &reftitle.description; - - intsvn_fs_node_created_rev - resourcefsroot - stringpath - - &warn.undocumented.func; - - Returns the revision in which path under fsroot was created - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-fs-node-prop.xml b/reference/svn/functions/svn-fs-node-prop.xml deleted file mode 100644 index b64e8086012f..000000000000 --- a/reference/svn/functions/svn-fs-node-prop.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - svn_fs_node_prop - Returns the value of a property for a node - - - - &reftitle.description; - - stringsvn_fs_node_prop - resourcefsroot - stringpath - stringpropname - - &warn.undocumented.func; - - Returns the value of a property for a node - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-fs-props-changed.xml b/reference/svn/functions/svn-fs-props-changed.xml deleted file mode 100644 index c2ee54334ea8..000000000000 --- a/reference/svn/functions/svn-fs-props-changed.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - svn_fs_props_changed - Return true if props are different, false otherwise - - - - &reftitle.description; - - boolsvn_fs_props_changed - resourceroot1 - stringpath1 - resourceroot2 - stringpath2 - - &warn.undocumented.func; - - Return true if props are different, false otherwise - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-fs-revision-prop.xml b/reference/svn/functions/svn-fs-revision-prop.xml deleted file mode 100644 index 77a8b3af9f15..000000000000 --- a/reference/svn/functions/svn-fs-revision-prop.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - svn_fs_revision_prop - Fetches the value of a named property - - - - &reftitle.description; - - stringsvn_fs_revision_prop - resourcefs - intrevnum - stringpropname - - &warn.undocumented.func; - - Fetches the value of a named property - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-fs-revision-root.xml b/reference/svn/functions/svn-fs-revision-root.xml deleted file mode 100644 index 03f9bb0d5412..000000000000 --- a/reference/svn/functions/svn-fs-revision-root.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - svn_fs_revision_root - Get a handle on a specific version of the repository root - - - - &reftitle.description; - - resourcesvn_fs_revision_root - resourcefs - intrevnum - - &warn.undocumented.func; - - Get a handle on a specific version of the repository root - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-fs-txn-root.xml b/reference/svn/functions/svn-fs-txn-root.xml deleted file mode 100644 index 76567a04449b..000000000000 --- a/reference/svn/functions/svn-fs-txn-root.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - svn_fs_txn_root - Creates and returns a transaction root - - - - &reftitle.description; - - resourcesvn_fs_txn_root - resourcetxn - - &warn.undocumented.func; - - Creates and returns a transaction root - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-fs-youngest-rev.xml b/reference/svn/functions/svn-fs-youngest-rev.xml deleted file mode 100644 index c44a4cd57315..000000000000 --- a/reference/svn/functions/svn-fs-youngest-rev.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - svn_fs_youngest_rev - Returns the number of the youngest revision in the filesystem - - - - &reftitle.description; - - intsvn_fs_youngest_rev - resourcefs - - &warn.undocumented.func; - - Returns the number of the youngest revision in the filesystem - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-import.xml b/reference/svn/functions/svn-import.xml deleted file mode 100644 index 0fb23b6cc7b0..000000000000 --- a/reference/svn/functions/svn-import.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - svn_import - Imports an unversioned path into a repository - - - - &reftitle.description; - - boolsvn_import - stringpath - stringurl - boolnonrecursive - - - Commits unversioned path into repository at - url. If path is a - directory and nonrecursive is &false;, - the directory will be imported recursively. - - - - - &reftitle.parameters; - - - path - - - Path of file or directory to import. - - &svn.relativepath; - - - - url - - - Repository URL to import into. - - - - - nonrecursive - - - Whether or not to refrain from recursively processing directories. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Basic example - - This example demonstrates a basic use-case of this function. To import - a directory named new-files into the repository at - http://www.example.com/svnroot/incoming/abc, use: - - - -]]> - - - - - - &reftitle.notes; - &warn.experimental.func; - - - - &reftitle.seealso; - - svn_add - SVN documentation for svn import - - - - - diff --git a/reference/svn/functions/svn-log.xml b/reference/svn/functions/svn-log.xml deleted file mode 100644 index 6c4787e0980e..000000000000 --- a/reference/svn/functions/svn-log.xml +++ /dev/null @@ -1,224 +0,0 @@ - - - - - svn_log - Returns the commit log messages of a repository URL - - - - &reftitle.description; - - arraysvn_log - stringrepos_url - intstart_revision - intend_revision - intlimit0 - intflagsSVN_DISCOVER_CHANGED_PATHS | SVN_STOP_ON_COPY - - - svn_log returns the complete history of the item at the repository URL - repos_url, or the history of a specific revision - if start_revision is set. This function is equivalent - to svn log --verbose -r $start_revision $repos_url. - - - - - &reftitle.parameters; - - - repos_url - - - Repository URL of the item to retrieve log history from. - - - - - start_revision - - - Revision number of the first log to retrieve. Use - SVN_REVISION_HEAD to retrieve the log from - the most recent revision. - - - - - end_revision - - - Revision number of the last log to retrieve. Defaults to - start_revision if specified or to - SVN_REVISION_INITIAL otherwise. - - - - - limit - - - Number of logs to retrieve. - - - - - flags - - - Any combination of SVN_OMIT_MESSAGES, - SVN_DISCOVER_CHANGED_PATHS and - SVN_STOP_ON_COPY. - - - - - - - - &reftitle.returnvalues; - - On success, this function returns an array file listing in the format - of: - - Array, ordered most recent (highest) revision first -( - [rev] => integer revision number - [author] => string author name - [msg] => string log message - [date] => string date formatted per ISO 8601, i.e. date('c') - [paths] => Array, describing changed files - ( - [0] => Array - ( - [action] => string letter signifying change - [path] => absolute repository path of changed file - ) - [1] => ... - ) -) -[1] => ... -]]> - - - - - The output will always be a numerically indexed array of arrays, - even when there are none or only one log message(s). - - - - The value of action is a subset of the - status output - in the first column, where possible values are: - - - Actions - - - - Letter - Description - - - - - M - Item/props was modified - - - A - Item was added - - - D - Item was deleted - - - R - Item was replaced - - - -
    - - If no changes were made to the item, an empty array is returned. - -
    - - - &reftitle.examples; - - <function>svn_log</function> example - - -]]> - - &example.outputs.similar; - - Array - ( - [rev] => 23 - [author] => 'joe' - [msg] => 'Add cheese and salami to our sandwich.' - [date] => '2007-04-06T16:00:27-04:00' - [paths] => Array - ( - [0] => Array - ( - [action] => 'M' - [path] => '/sandwich.txt' - ) - ) - ) -) -]]> - - - - - - &reftitle.notes; - &warn.experimental.func; - - - - &reftitle.seealso; - - - - SVN documentation on svn log - - - - - -
    - diff --git a/reference/svn/functions/svn-ls.xml b/reference/svn/functions/svn-ls.xml deleted file mode 100644 index 2b19e991ff65..000000000000 --- a/reference/svn/functions/svn-ls.xml +++ /dev/null @@ -1,161 +0,0 @@ - - - - - svn_ls - Returns list of directory contents in repository URL, optionally at revision number - - - &reftitle.description; - - arraysvn_ls - stringrepos_url - intrevision_noSVN_REVISION_HEAD - boolrecurse&false; - boolpeg&false; - - - This function queries the repository URL and returns a list of - files and directories, optionally from a specific revision. This - is equivalent to svn list $repos_url[@$revision_no] - - - - This function does not work with working copies. repos_url - must be a repository URL. - - - - - - &reftitle.parameters; - - - url - - - URL of the repository, eg. http://www.example.com/svnroot. - To access a local Subversion repository via filesystem, use the - file URI scheme, eg. file:///home/user/svn-repos - - - - - revision - - - Integer revision number to retrieve listing of. When omitted, - the HEAD revision is used. - - - - - recurse - - - Enables recursion. - - - - - - - &reftitle.returnvalues; - - On success, this function returns an array file listing in the format - of: - - Array - ( - [created_rev] => integer revision number of last edit - [last_author] => string author name of last edit - [size] => integer byte file size of file - [time] => string date of last edit in form 'M d H:i' - or 'M d Y', depending on how old the file is - [time_t] => integer unix timestamp of last edit - [name] => name of file/directory - [type] => type, can be 'file' or 'dir' - ) -[1] => ... -]]> - - - - - - &reftitle.examples; - - <function>svn_ls</function> example - - -]]> - - &example.outputs.similar; - - Array - ( - [created_rev] => 20 - [last_author] => Joe - [size] => 0 - [time] => Apr 02 09:28 - [time_t] => 1175520529 - [name] => tags - [type] => dir - ) - [1] => Array - ( - [created_rev] => 23 - [last_author] => Bob - [size] => 0 - [time] => Apr 02 15:15 - [time_t] => 1175541322 - [name] => trunk - [type] => dir - ) -) -]]> - - - - - - &reftitle.notes; - &warn.experimental.func; - - - - &reftitle.seealso; - - - SVN documentation on svn list - - - - - diff --git a/reference/svn/functions/svn-mkdir.xml b/reference/svn/functions/svn-mkdir.xml deleted file mode 100644 index 3d004d11395c..000000000000 --- a/reference/svn/functions/svn-mkdir.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - svn_mkdir - Creates a directory in a working copy or repository - - - - &reftitle.description; - - boolsvn_mkdir - stringpath - stringlog_message - - - Creates a directory in a working copy or repository. - - - - - &reftitle.parameters; - - - path - - - The path to the working copy or repository. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - svn_add - svn_copy - - - - - diff --git a/reference/svn/functions/svn-repos-create.xml b/reference/svn/functions/svn-repos-create.xml deleted file mode 100644 index e348d9ee7f85..000000000000 --- a/reference/svn/functions/svn-repos-create.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - svn_repos_create - Create a new subversion repository at path - - - - &reftitle.description; - - resourcesvn_repos_create - stringpath - arrayconfig - arrayfsconfig - - &warn.undocumented.func; - - Create a new subversion repository at path - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-repos-fs-begin-txn-for-commit.xml b/reference/svn/functions/svn-repos-fs-begin-txn-for-commit.xml deleted file mode 100644 index 1234c50c763b..000000000000 --- a/reference/svn/functions/svn-repos-fs-begin-txn-for-commit.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - svn_repos_fs_begin_txn_for_commit - Create a new transaction - - - - &reftitle.description; - - resourcesvn_repos_fs_begin_txn_for_commit - resourcerepos - intrev - stringauthor - stringlog_msg - - &warn.undocumented.func; - - Create a new transaction - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-repos-fs-commit-txn.xml b/reference/svn/functions/svn-repos-fs-commit-txn.xml deleted file mode 100644 index 3d3df55b33e6..000000000000 --- a/reference/svn/functions/svn-repos-fs-commit-txn.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - svn_repos_fs_commit_txn - Commits a transaction and returns the new revision - - - - &reftitle.description; - - intsvn_repos_fs_commit_txn - resourcetxn - - &warn.undocumented.func; - - Commits a transaction and returns the new revision - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-repos-fs.xml b/reference/svn/functions/svn-repos-fs.xml deleted file mode 100644 index 59a9b40bc094..000000000000 --- a/reference/svn/functions/svn-repos-fs.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - svn_repos_fs - Gets a handle on the filesystem for a repository - - - - &reftitle.description; - - resourcesvn_repos_fs - resourcerepos - - &warn.undocumented.func; - - Gets a handle on the filesystem for a repository - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-repos-hotcopy.xml b/reference/svn/functions/svn-repos-hotcopy.xml deleted file mode 100644 index 9426030bd6ee..000000000000 --- a/reference/svn/functions/svn-repos-hotcopy.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - svn_repos_hotcopy - Make a hot-copy of the repos at repospath; copy it to destpath - - - - &reftitle.description; - - boolsvn_repos_hotcopy - stringrepospath - stringdestpath - boolcleanlogs - - &warn.undocumented.func; - - Make a hot-copy of the repos at repospath; copy it to destpath - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-repos-open.xml b/reference/svn/functions/svn-repos-open.xml deleted file mode 100644 index 243830307a02..000000000000 --- a/reference/svn/functions/svn-repos-open.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - svn_repos_open - Open a shared lock on a repository - - - - &reftitle.description; - - resourcesvn_repos_open - stringpath - - &warn.undocumented.func; - - Open a shared lock on a repository. - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-repos-recover.xml b/reference/svn/functions/svn-repos-recover.xml deleted file mode 100644 index 4bfd9d94e902..000000000000 --- a/reference/svn/functions/svn-repos-recover.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - svn_repos_recover - Run recovery procedures on the repository located at path - - - - &reftitle.description; - - boolsvn_repos_recover - stringpath - - &warn.undocumented.func; - - Run recovery procedures on the repository located at path. - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-revert.xml b/reference/svn/functions/svn-revert.xml deleted file mode 100644 index 1c21077c3241..000000000000 --- a/reference/svn/functions/svn-revert.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - svn_revert - Revert changes to the working copy - - - - &reftitle.description; - - boolsvn_revert - stringpath - boolrecursive&false; - - - Revert any local changes to the path in a working copy. - - - - - &reftitle.parameters; - - - path - - - The path to the working repository. - - - - - recursive - - - Optionally make recursive changes. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - svn_delete - svn_export - - - - - diff --git a/reference/svn/functions/svn-status.xml b/reference/svn/functions/svn-status.xml deleted file mode 100644 index 7b9363cdd439..000000000000 --- a/reference/svn/functions/svn-status.xml +++ /dev/null @@ -1,364 +0,0 @@ - - - - - svn_status - Returns the status of working copy files and directories - - - - &reftitle.description; - - arraysvn_status - stringpath - intflags0 - - - Returns the status of working copy files and directories, giving modifications, - additions, deletions and other changes to items in the working copy. - - - - - &reftitle.parameters; - - - path - - - Local path to file or directory to retrieve status of. - - &svn.relativepath; - - - - flags - - - Any combination of Svn::NON_RECURSIVE, - Svn::ALL (regardless of modification status), - Svn::SHOW_UPDATES (entries will be added for items - that are out-of-date), Svn::NO_IGNORE (disregard - svn:ignore properties when scanning for new files) - and Svn::IGNORE_EXTERNALS. - - - - - - - - &reftitle.returnvalues; - - Returns a numerically indexed array of associative arrays detailing - the status of items in the repository: - - - Array ( - // information on item - ) - [1] => ... -) -]]> - - - The information on the item is an associative array that can contain - the following keys: - - - - path - - - String path to file/directory of this entry on local filesystem. - - - - - text_status - - - Status of item's text. &svn.referto.status; - - - - - repos_text_status - - - Status of item's text in repository. Only accurate if - update was set to &true;. - &svn.referto.status; - - - - - prop_status - - - Status of item's properties. &svn.referto.status; - - - - - repos_prop_status - - - Status of item's property in repository. Only accurate if - update was set to &true;. &svn.referto.status; - - - - - locked - - - Whether or not the item is locked. (Only set if &true;.) - - - - - copied - - - Whether or not the item was copied (scheduled for addition with - history). (Only set if &true;.) - - - - - switched - - - Whether or not the item was switched using the switch command. - (Only set if &true;) - - - - - - These keys are only set if the item is versioned: - - - - name - - - Base name of item in repository. - - - - - url - - - URL of item in repository. - - - - - repos - - - Base URL of repository. - - - - - revision - - - Integer revision of item in working copy. - - - - - kind - - - Type of item, i.e. file or directory. &svn.referto.type; - - - - - schedule - - - Scheduled action for item, i.e. addition or deletion. Constants - for these magic numbers are not available, they can - be emulated by using: - - - -]]> - - - - - deleted - - - Whether or not the item was deleted, but parent revision lags - behind. (Only set if &true;.) - - - - - absent - - - Whether or not the item is absent, that is, Subversion knows that - there should be something there but there isn't. (Only set if - &true;.) - - - - - incomplete - - - Whether or not the entries file for a directory is incomplete. - (Only set if &true;.) - - - - - cmt_date - - - Integer Unix timestamp of last commit date. (Unaffected by update.) - - - - - cmt_rev - - - Integer revision of last commit. (Unaffected by update.) - - - - - cmt_author - - - String author of last commit. (Unaffected by update.) - - - - - prop_time - - - Integer Unix timestamp of last up-to-date time for properties - - - - - text_time - - - Integer Unix timestamp of last up-to-date time for text - - - - - - - - - &reftitle.examples; - - Basic example - - This example demonstrates a basic, theoretical usage of this function. - - - -]]> - - &example.outputs.similar; - - Array ( - [path] => /home/bob/wc/sandwich.txt - [text_status] => 8 // item was modified - [repos_text_status] => 1 // no information available, use update - [prop_status] => 3 // no changes - [repos_prop_status] => 1 // no information available, use update - [name] => sandwich.txt - [url] => http://www.example.com/svnroot/deli/trunk/sandwich.txt - [repos] => http://www.example.com/svnroot/ - [revision] => 123 - [kind] => 1 // file - [schedule] => 0 // no special actions scheduled - [cmt_date] => 1165543135 - [cmt_rev] => 120 - [cmt_author] => Alice - [prop_time] => 1180201728 - [text_time] => 1180201729 - ) -) -]]> - - - - - - &reftitle.notes; - &warn.experimental.func; - - - - &reftitle.seealso; - - svn_update - svn_log - SVN documentation for svn status - - - - - diff --git a/reference/svn/functions/svn-update.xml b/reference/svn/functions/svn-update.xml deleted file mode 100644 index a99a586bc9b3..000000000000 --- a/reference/svn/functions/svn-update.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - svn_update - Update working copy - - - - &reftitle.description; - - intsvn_update - stringpath - intrevnoSVN_REVISION_HEAD - boolrecurse&true; - - - Update working copy at path to revision - revno. If recurse is true, - directories will be recursively updated. - - - - - &reftitle.parameters; - - - path - - - Path to local working copy. - - &svn.relativepath; - - - - revno - - - Revision number to update to, default is SVN_REVISION_HEAD. - - - - - recurse - - - Whether or not to recursively update directories. - - - - - - - - &reftitle.returnvalues; - - Returns new revision number on success, returns &false; on failure. - - - - - &reftitle.examples; - - Basic example - - This example demonstrates basic usage of this function: - - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.notes; - &warn.experimental.func; - - - - &reftitle.seealso; - - svn_checkout - svn_commit - SVN documentation for svn update - - - - - diff --git a/reference/svn/reference.xml b/reference/svn/reference.xml deleted file mode 100644 index 4fc56f02000b..000000000000 --- a/reference/svn/reference.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - SVN &Functions; - - &reference.svn.entities.functions; - - - - diff --git a/reference/svn/setup.xml b/reference/svn/setup.xml deleted file mode 100644 index 531ca92fe9f6..000000000000 --- a/reference/svn/setup.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - &reftitle.setup; - - -
    - &reftitle.required; - - The Subversion binaries are not necessary to use this - extension. However, when compiling the extension, libsvn - (the Subversion headers) must be available. - -
    - - - - &reference.svn.configure; - - -
    - diff --git a/reference/svn/versions.xml b/reference/svn/versions.xml deleted file mode 100644 index 66f22ea5ff8c..000000000000 --- a/reference/svn/versions.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/swoole/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/swoole/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/swoole/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/swoole/book.xml b/reference/swoole/book.xml deleted file mode 100644 index 88e2cea060f1..000000000000 --- a/reference/swoole/book.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - Swoole - Swoole - - - - &reftitle.intro; - - Swoole is a parallel network communication engine based on asynchronous event-driven and coroutine, - written in C++, providing coroutine and high-performance network programming support for PHP. - It provides various network server and client modules for multiple communication protocols, making it easy to - quickly implement TCP/UDP services, high-performance Web, WebSocket services, IoT, real-time communication, games, - microservices, etc., breaking the limits of PHP in traditional web domains. - - To get started, please check the Swoole Docs. - - ¬e.no-windows.extension; - - - - &reference.swoole.setup; - &reference.swoole.constants; - &reference.swoole.reference; - - &reference.swoole.swoole.async; - &reference.swoole.swoole.atomic; - &reference.swoole.swoole.buffer; - &reference.swoole.swoole.channel; - &reference.swoole.swoole.client; - &reference.swoole.swoole.connection.iterator; - &reference.swoole.swoole.coroutine; - &reference.swoole.swoole.coroutine.lock; - - - - - &reference.swoole.swoole.event; - &reference.swoole.swoole.exception; - &reference.swoole.swoole.http.client; - &reference.swoole.swoole.http.request; - &reference.swoole.swoole.http.response; - &reference.swoole.swoole.http.server; - &reference.swoole.swoole.lock; - &reference.swoole.swoole.mmap; - &reference.swoole.swoole.module; - &reference.swoole.swoole.mysql; - &reference.swoole.swoole.mysql.exception; - &reference.swoole.swoole.process; - &reference.swoole.swoole.redis.server; - &reference.swoole.swoole.runtime; - &reference.swoole.swoole.serialize; - &reference.swoole.swoole.server; - - &reference.swoole.swoole.table; - &reference.swoole.swoole.timer; - &reference.swoole.swoole.websocket.frame; - &reference.swoole.swoole.websocket.server; - - - - diff --git a/reference/swoole/configure.xml b/reference/swoole/configure.xml deleted file mode 100644 index a6b3947e5d66..000000000000 --- a/reference/swoole/configure.xml +++ /dev/null @@ -1,15 +0,0 @@ - - - -
    - &reftitle.install; - - - Use when compiling PHP. - - - - &pecl.info; - &url.pecl.package;swoole - -
    \ No newline at end of file diff --git a/reference/swoole/constants.xml b/reference/swoole/constants.xml deleted file mode 100644 index c35c06e59d26..000000000000 --- a/reference/swoole/constants.xml +++ /dev/null @@ -1,3874 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - - - - SWOOLE_VERSION - (string) - - - - Swoole version. - - - - - - SWOOLE_VERSION_ID - (int) - - - - Swoole version. - - - - - - SWOOLE_MAJOR_VERSION - (int) - - - - Swoole major version. - - - - - - SWOOLE_MINOR_VERSION - (int) - - - - Swoole minor version. - - - - - - SWOOLE_RELEASE_VERSION - (int) - - - - Swoole release version. - - - - - - SWOOLE_EXTRA_VERSION - (string) - - - - Swoole extra version. - - - - - - SWOOLE_DEBUG - (int) - - - - Debug mode. - - - - - - SWOOLE_HAVE_COMPRESSION - (int) - - - - Enable HTTP response compression mode. - - - - - - SWOOLE_HAVE_ZLIB - (int) - - - - Have zlib compression tool. - - - - - - SWOOLE_HAVE_BROTLI - (int) - - - - Have brotli compression tool. - - - - - - SWOOLE_USE_HTTP2 - (int) - - - - Support http2 server. - - - - - - SWOOLE_USE_SHORTNAME - (int) - - - - Enable/disable short aliases. - - - - - - SWOOLE_SOCK_TCP - (int) - - - - TCP ipv4 socket. - - - - - - SWOOLE_SOCK_TCP6 - (int) - - - - TCP ipv6 socket. - - - - - - SWOOLE_SOCK_UDP - (int) - - - - UDP ipv4 socket. - - - - - - SWOOLE_SOCK_UDP6 - (int) - - - - UDP ipv6 socket. - - - - - - SWOOLE_SOCK_UNIX_DGRAM - (int) - - - - UNIX socket dgram. - - - - - - SWOOLE_SOCK_UNIX_STREAM - (int) - - - - UNIX socket stream. - - - - - - SWOOLE_SOCK_SYNC - (int) - - - - Synchronous client mode. - - - - - - SWOOLE_SOCK_ASYNC - (int) - - - - Asynchronous client mode. - - - - - - SWOOLE_KEEP - (int) - - - - Swoole\Client supports creating a TCP long connection to the server in PHP-FPM/Apache. - - - - - - SWOOLE_SSL - (int) - - - - Enable SSL tunnel encryption. - - - - - - SWOOLE_SSLv3_METHOD - (int) - - - - SSLv3 method. - - - - - - SWOOLE_SSLv3_SERVER_METHOD - (int) - - - - SSLv3 server method. - - - - - - SWOOLE_SSLv3_CLIENT_METHOD - (int) - - - - SSLv3 client method. - - - - - - SWOOLE_TLSv1_METHOD - (int) - - - - TLSv1 method. - - - - - - SWOOLE_TLSv1_SERVER_METHOD - (int) - - - - TLSv1 server method. - - - - - - SWOOLE_TLSv1_CLIENT_METHOD - (int) - - - - TLSv1 client method. - - - - - - SWOOLE_TLSv1_1_METHOD - (int) - - - - TLSv1_1 method. - - - - - - SWOOLE_TLSv1_1_SERVER_METHOD - (int) - - - - TLSv1_1 server method. - - - - - - SWOOLE_TLSv1_1_CLIENT_METHOD - (int) - - - - TLSv1_1 client method. - - - - - - SWOOLE_TLSv1_2_METHOD - (int) - - - - TLSv1_2 method. - - - - - - SWOOLE_TLSv1_2_SERVER_METHOD - (int) - - - - TLSv1_2 server method. - - - - - - SWOOLE_TLSv1_2_CLIENT_METHOD - (int) - - - - TLSv1_2 client method. - - - - - - SWOOLE_DTLS_SERVER_METHOD - (int) - - - - DTLS server method. - - - - - - SWOOLE_DTLS_CLIENT_METHOD - (int) - - - - DTLS client method. - - - - - - SWOOLE_SSLv23_METHOD - (int) - - - - SSLv23 method. - - - - - - SWOOLE_SSLv23_SERVER_METHOD - (int) - - - - SSLv23 server method. - - - - - - SWOOLE_SSLv23_CLIENT_METHOD - (int) - - - - SSLv23 client method. - - - - - - SWOOLE_TLS_METHOD - (int) - - - - TLS method. - - - - - - SWOOLE_TLS_SERVER_METHOD - (int) - - - - TLS server method. - - - - - - SWOOLE_TLS_CLIENT_METHOD - (int) - - - - TLS client method. - - - - - - SWOOLE_SSL_SSLv3 - (int) - - - - SSLv3 protocol. - - - - - - SWOOLE_SSL_TLSv1 - (int) - - - - TLSv1 protocol. - - - - - - SWOOLE_SSL_TLSv1_1 - (int) - - - - TLSv1_1 protocol. - - - - - - SWOOLE_SSL_TLSv1_2 - (int) - - - - TLSv1_2 protocol. - - - - - - SWOOLE_SSL_TLSv1_3 - (int) - - - - TLSv1_3 protocol. - - - - - - SWOOLE_SSL_DTLS - (int) - - - - DTLS protocol. - - - - - - SWOOLE_SSL_SSLv2 - (int) - - - - SSLv2 protocol. - - - - - - SWOOLE_EVENT_READ - (int) - - - - Whether to listen for readable events. - - - - - - SWOOLE_EVENT_WRITE - (int) - - - - Whether to listen for writable events. - - - - - - SWOOLE_STRERROR_SYSTEM - (int) - - - - Convert the system errno no into error messages. - - - - - - SWOOLE_STRERROR_GAI - (int) - - - - Convert the addr info errno no into error messages. - - - - - - SWOOLE_STRERROR_DNS - (int) - - - - Convert the DNS errno no into error messages. - - - - - - SWOOLE_STRERROR_SWOOLE - (int) - - - - Convert the swoole errno no into error messages. - - - - - - SWOOLE_ERROR_MALLOC_FAIL - (int) - - - - Malloc memory fail. - - - - - - SWOOLE_ERROR_SYSTEM_CALL_FAIL - (int) - - - - System call fail. - - - - - - SWOOLE_ERROR_PHP_FATAL_ERROR - (int) - - - - PHP fatal error. - - - - - - SWOOLE_ERROR_NAME_TOO_LONG - (int) - - - - Name too long. - - - - - - SWOOLE_ERROR_INVALID_PARAMS - (int) - - - - Invalid params. - - - - - - SWOOLE_ERROR_QUEUE_FULL - (int) - - - - Queue full. - - - - - - SWOOLE_ERROR_OPERATION_NOT_SUPPORT - (int) - - - - Operation not support. - - - - - - SWOOLE_ERROR_PROTOCOL_ERROR - (int) - - - - Protocol error. - - - - - - SWOOLE_ERROR_WRONG_OPERATION - (int) - - - - Wrong operation. - - - - - - SWOOLE_ERROR_PHP_RUNTIME_NOTICE - (int) - - - - PHP runtime notice. - - - - - - SWOOLE_ERROR_FOR_TEST - (int) - - - - For test. - - - - - - SWOOLE_ERROR_NO_PAYLOAD - (int) - - - - No payload. - - - - - - SWOOLE_ERROR_UNDEFINED_BEHAVIOR - (int) - - - - Undefined behavior. - - - - - - SWOOLE_ERROR_NOT_THREAD_SAFETY - (int) - - - - Not thread safety. - - - - - - SWOOLE_ERROR_FILE_NOT_EXIST - (int) - - - - File not exist. - - - - - - SWOOLE_ERROR_FILE_TOO_LARGE - (int) - - - - File too large. - - - - - - SWOOLE_ERROR_FILE_EMPTY - (int) - - - - File empty. - - - - - - SWOOLE_ERROR_DNSLOOKUP_DUPLICATE_REQUEST - (int) - - - - DNS Lookup duplicate request. - - - - - - SWOOLE_ERROR_DNSLOOKUP_RESOLVE_FAILED - (int) - - - - DNS Lookup resolve failed. - - - - - - SWOOLE_ERROR_DNSLOOKUP_RESOLVE_TIMEOUT - (int) - - - - DNS Lookup resolve timeout. - - - - - - SWOOLE_ERROR_DNSLOOKUP_UNSUPPORTED - (int) - - - - DNS Lookup unsupported. - - - - - - SWOOLE_ERROR_DNSLOOKUP_NO_SERVER - (int) - - - - DNS Lookup no server. - - - - - - SWOOLE_ERROR_BAD_IPV6_ADDRESS - (int) - - - - Bad ipv6 address. - - - - - - SWOOLE_ERROR_UNREGISTERED_SIGNAL - (int) - - - - Unregistered signal. - - - - - - SWOOLE_ERROR_BAD_HOST_ADDR - (int) - - - - Bad host addr. - - - - - - SWOOLE_ERROR_EVENT_SOCKET_REMOVED - (int) - - - - Event socket removed. - - - - - - SWOOLE_ERROR_SESSION_CLOSED_BY_SERVER - (int) - - - - Session closed by server. - - - - - - SWOOLE_ERROR_SESSION_CLOSED_BY_CLIENT - (int) - - - - Session closed by client. - - - - - - SWOOLE_ERROR_SESSION_CLOSING - (int) - - - - Session closing. - - - - - - SWOOLE_ERROR_SESSION_CLOSED - (int) - - - - Session closed. - - - - - - SWOOLE_ERROR_SESSION_NOT_EXIST - (int) - - - - Session not exist. - - - - - - SWOOLE_ERROR_SESSION_INVALID_ID - (int) - - - - Session invalid id. - - - - - - SWOOLE_ERROR_SESSION_DISCARD_TIMEOUT_DATA - (int) - - - - Session discard timeout data. - - - - - - SWOOLE_ERROR_SESSION_DISCARD_DATA - (int) - - - - Session discard data. - - - - - - SWOOLE_ERROR_OUTPUT_BUFFER_OVERFLOW - (int) - - - - Output buffer overflow. - - - - - - SWOOLE_ERROR_OUTPUT_SEND_YIELD - (int) - - - - Output send yield - - - - - - SWOOLE_ERROR_SSL_NOT_READY - (int) - - - - SSL not ready - - - - - - SWOOLE_ERROR_SSL_CANNOT_USE_SENFILE - (int) - - - - SSL cannot use sendfile - - - - - - SWOOLE_ERROR_SSL_EMPTY_PEER_CERTIFICATE - (int) - - - - SSL empty peer certificate. - - - - - - SWOOLE_ERROR_SSL_VERIFY_FAILED - (int) - - - - SSL verify failed. - - - - - - SWOOLE_ERROR_SSL_BAD_CLIENT - (int) - - - - SSL bad client. - - - - - - SWOOLE_ERROR_SSL_BAD_PROTOCOL - (int) - - - - SSL bad protocol. - - - - - - SWOOLE_ERROR_SSL_RESET - (int) - - - - SSL reset. - - - - - - SWOOLE_ERROR_SSL_HANDSHAKE_FAILED - (int) - - - - SSL handshake failed. - - - - - - SWOOLE_ERROR_PACKAGE_LENGTH_TOO_LARGE - (int) - - - - Package length too large. - - - - - - SWOOLE_ERROR_PACKAGE_LENGTH_NOT_FOUND - (int) - - - - Package length not found. - - - - - - SWOOLE_ERROR_DATA_LENGTH_TOO_LARGE - (int) - - - - Data length too large. - - - - - - SWOOLE_ERROR_PACKAGE_MALFORMED_DATA - (int) - - - - Package malformed error data. - - - - - - SWOOLE_ERROR_TASK_PACKAGE_TOO_BIG - (int) - - - - Task package too big. - - - - - - SWOOLE_ERROR_TASK_DISPATCH_FAIL - (int) - - - - Task dispatch fail. - - - - - - SWOOLE_ERROR_TASK_TIMEOUT - (int) - - - - Task timeout. - - - - - - SWOOLE_ERROR_HTTP2_STREAM_ID_TOO_BIG - (int) - - - - Http2 stream id too big. - - - - - - SWOOLE_ERROR_HTTP2_STREAM_NO_HEADER - (int) - - - - Http2 stream no header. - - - - - - SWOOLE_ERROR_HTTP2_STREAM_NOT_FOUND - (int) - - - - Http2 stream not found. - - - - - - SWOOLE_ERROR_HTTP2_STREAM_IGNORE - (int) - - - - Http2 stream ignore. - - - - - - SWOOLE_ERROR_HTTP2_SEND_CONTROL_FRAME_FAILED - (int) - - - - Http2 send control frame failed. - - - - - - SWOOLE_ERROR_AIO_BAD_REQUEST - (int) - - - - Aio bad request. - - - - - - SWOOLE_ERROR_AIO_CANCELED - (int) - - - - Aio canceled. - - - - - - SWOOLE_ERROR_AIO_TIMEOUT - (int) - - - - Aio timeout. - - - - - - SWOOLE_ERROR_CLIENT_NO_CONNECTION - (int) - - - - Client no connection. - - - - - - SWOOLE_ERROR_SOCKET_CLOSED - (int) - - - - Socket closed. - - - - - - SWOOLE_ERROR_SOCKET_POLL_TIMEOUT - (int) - - - - Socket poll timeout. - - - - - - SWOOLE_ERROR_SOCKS5_UNSUPPORT_VERSION - (int) - - - - Socks5 unsupported version. - - - - - - SWOOLE_ERROR_SOCKS5_UNSUPPORT_METHOD - (int) - - - - Socks5 unsupported method. - - - - - - SWOOLE_ERROR_SOCKS5_AUTH_FAILED - (int) - - - - Socks5 auth failed. - - - - - - SWOOLE_ERROR_SOCKS5_SERVER_ERROR - (int) - - - - Socks5 server error. - - - - - - SWOOLE_ERROR_SOCKS5_HANDSHAKE_FAILED - (int) - - - - Socks5 handshake failed. - - - - - - SWOOLE_ERROR_HTTP_PROXY_HANDSHAKE_ERROR - (int) - - - - Http proxy handshake error. - - - - - - SWOOLE_ERROR_HTTP_INVALID_PROTOCOL - (int) - - - - Http invalid protocol. - - - - - - SWOOLE_ERROR_HTTP_PROXY_HANDSHAKE_FAILED - (int) - - - - Http proxy handshake failed. - - - - - - SWOOLE_ERROR_HTTP_PROXY_BAD_RESPONSE - (int) - - - - Http proxy bad response. - - - - - - SWOOLE_ERROR_HTTP_CONFLICT_HEADER - (int) - - - - Http conflict header. - - - - - - SWOOLE_ERROR_HTTP_CONTEXT_UNAVAILABLE - (int) - - - - Http context unavailable. - - - - - - SWOOLE_ERROR_HTTP_COOKIE_UNAVAILABLE - (int) - - - - Http cookie unavailable. - - - - - - SWOOLE_ERROR_WEBSOCKET_BAD_CLIENT - (int) - - - - Websocket bad client. - - - - - - SWOOLE_ERROR_WEBSOCKET_BAD_OPCODE - (int) - - - - Websocket bad opcode. - - - - - - SWOOLE_ERROR_WEBSOCKET_UNCONNECTED - (int) - - - - Websocket unconnected. - - - - - - SWOOLE_ERROR_WEBSOCKET_HANDSHAKE_FAILED - (int) - - - - Websocket handshake failed. - - - - - - SWOOLE_ERROR_WEBSOCKET_PACK_FAILED - (int) - - - - Websocket pack failed. - - - - - - SWOOLE_ERROR_WEBSOCKET_UNPACK_FAILED - (int) - - - - Websocket unpack failed. - - - - - - SWOOLE_ERROR_WEBSOCKET_INCOMPLETE_PACKET - (int) - - - - Websocket incomplete packet. - - - - - - SWOOLE_ERROR_SERVER_MUST_CREATED_BEFORE_CLIENT - (int) - - - - Server must be created before client. - - - - - - SWOOLE_ERROR_SERVER_TOO_MANY_SOCKET - (int) - - - - Server too many socket. - - - - - - SWOOLE_ERROR_SERVER_WORKER_TERMINATED - (int) - - - - Server worker terminated. - - - - - - SWOOLE_ERROR_SERVER_INVALID_LISTEN_PORT - (int) - - - - Server invalid listen port. - - - - - - SWOOLE_ERROR_SERVER_TOO_MANY_LISTEN_PORT - (int) - - - - Server too many listen port. - - - - - - SWOOLE_ERROR_SERVER_PIPE_BUFFER_FULL - (int) - - - - Server pipe buffer full. - - - - - - SWOOLE_ERROR_SERVER_NO_IDLE_WORKER - (int) - - - - Server no idle worker. - - - - - - SWOOLE_ERROR_SERVER_ONLY_START_ONE - (int) - - - - Server only start one. - - - - - - SWOOLE_ERROR_SERVER_SEND_IN_MASTER - (int) - - - - Server send in master. - - - - - - SWOOLE_ERROR_SERVER_INVALID_REQUEST - (int) - - - - Server invalid request. - - - - - - SWOOLE_ERROR_SERVER_CONNECT_FAIL - (int) - - - - Server connect failed. - - - - - - SWOOLE_ERROR_SERVER_INVALID_COMMAND - (int) - - - - Server invalid command. - - - - - - SWOOLE_ERROR_SERVER_IS_NOT_REGULAR_FILE - (int) - - - - Server is not regular file. - - - - - - SWOOLE_ERROR_SERVER_SEND_TO_WOKER_TIMEOUT - (int) - - - - Server send to woker timeout. - - - - - - SWOOLE_ERROR_SERVER_INVALID_CALLBACK - (int) - - - - Server invalid callback. - - - - - - SWOOLE_ERROR_SERVER_UNRELATED_THREAD - (int) - - - - Server unrelated thread. - - - - - - SWOOLE_ERROR_SERVER_WORKER_EXIT_TIMEOUT - (int) - - - - Server worker exit timeout. - - - - - - SWOOLE_ERROR_SERVER_WORKER_ABNORMAL_PIPE_DATA - (int) - - - - Server worker abnormal pipe data. - - - - - - SWOOLE_ERROR_SERVER_WORKER_UNPROCESSED_DATA - (int) - - - - Server worker unprocessed data. - - - - - - SWOOLE_ERROR_CO_OUT_OF_COROUTINE - (int) - - - - Coroutine out of coroutine. - - - - - - SWOOLE_ERROR_CO_HAS_BEEN_BOUND - (int) - - - - Coroutine has been bound. - - - - - - SWOOLE_ERROR_CO_HAS_BEEN_DISCARDED - (int) - - - - Coroutine has been discarded. - - - - - - SWOOLE_ERROR_CO_MUTEX_DOUBLE_UNLOCK - (int) - - - - Coroutine mutex double unlock. - - - - - - SWOOLE_ERROR_CO_BLOCK_OBJECT_LOCKED - (int) - - - - Coroutine block object locked. - - - - - - SWOOLE_ERROR_CO_BLOCK_OBJECT_WAITING - (int) - - - - Coroutine block object waiting. - - - - - - SWOOLE_ERROR_CO_YIELD_FAILED - (int) - - - - Coroutine yield failed. - - - - - - SWOOLE_ERROR_CO_GETCONTEXT_FAILED - (int) - - - - Coroutine getcontext failed. - - - - - - SWOOLE_ERROR_CO_SWAPCONTEXT_FAILED - (int) - - - - Coroutine swapcontext failed. - - - - - - SWOOLE_ERROR_CO_MAKECONTEXT_FAILED - (int) - - - - Coroutine makecontext failed. - - - - - - SWOOLE_ERROR_CO_IOCPINIT_FAILED - (int) - - - - Coroutine iocpinit failed. - - - - - - SWOOLE_ERROR_CO_PROTECT_STACK_FAILED - (int) - - - - Coroutine protect stack failed. - - - - - - SWOOLE_ERROR_CO_STD_THREAD_LINK_ERROR - (int) - - - - Coroutine std thread link error. - - - - - - SWOOLE_ERROR_CO_DISABLED_MULTI_THREAD - (int) - - - - Coroutine disabled multi thread. - - - - - - SWOOLE_ERROR_CO_CANNOT_CANCEL - (int) - - - - Coroutine cannot cancel. - - - - - - SWOOLE_ERROR_CO_NOT_EXISTS - (int) - - - - Coroutine not exists. - - - - - - SWOOLE_ERROR_CO_CANCELED - (int) - - - - Coroutine canceled. - - - - - - SWOOLE_ERROR_CO_TIMEDOUT - (int) - - - - Coroutine timedout. - - - - - - SWOOLE_ERROR_CO_SOCKET_CLOSE_WAIT - (int) - - - - Coroutine socket close wait. - - - - - - SWOOLE_TRACE_SERVER - (int) - - - - Record server log flag. - - - - - - SWOOLE_TRACE_CLIENT - (int) - - - - Record client log flag. - - - - - - SWOOLE_TRACE_BUFFER - (int) - - - - Record buffer log flag. - - - - - - SWOOLE_TRACE_CONN - (int) - - - - Record connect log flag. - - - - - - SWOOLE_TRACE_EVENT - (int) - - - - Record event log flag. - - - - - - SWOOLE_TRACE_WORKER - (int) - - - - Record worker log flag. - - - - - - SWOOLE_TRACE_MEMORY - (int) - - - - Record memory log flag. - - - - - - SWOOLE_TRACE_REACTOR - (int) - - - - Record reactor log flag. - - - - - - SWOOLE_TRACE_PHP - (int) - - - - Record php log flag. - - - - - - SWOOLE_TRACE_HTTP - (int) - - - - Record http log flag. - - - - - - SWOOLE_TRACE_HTTP2 - (int) - - - - Record http2 log flag. - - - - - - SWOOLE_TRACE_EOF_PROTOCOL - (int) - - - - Record eof protocol log flag. - - - - - - SWOOLE_TRACE_LENGTH_PROTOCOL - (int) - - - - Record length protocol log flag. - - - - - - SWOOLE_TRACE_CLOSE - (int) - - - - Record close event log flag. - - - - - - SWOOLE_TRACE_WEBSOCKET - (int) - - - - Record websocket log flag. - - - - - - SWOOLE_TRACE_REDIS_CLIENT - (int) - - - - Record redis client log flag. - - - - - - SWOOLE_TRACE_MYSQL_CLIENT - (int) - - - - Record mysql client log flag. - - - - - - SWOOLE_TRACE_HTTP_CLIENT - (int) - - - - Record http client log flag. - - - - - - SWOOLE_TRACE_AIO - (int) - - - - Record AIO log flag. - - - - - - SWOOLE_TRACE_SSL - (int) - - - - Record SSL log flag. - - - - - - SWOOLE_TRACE_NORMAL - (int) - - - - Record normal log flag. - - - - - - SWOOLE_TRACE_CHANNEL - (int) - - - - Record channel log flag. - - - - - - SWOOLE_TRACE_TIMER - (int) - - - - Record timer log flag. - - - - - - SWOOLE_TRACE_SOCKET - (int) - - - - Record socket log flag. - - - - - - SWOOLE_TRACE_COROUTINE - (int) - - - - Record coroutine log flag. - - - - - - SWOOLE_TRACE_CONTEXT - (int) - - - - Record context log flag. - - - - - - SWOOLE_TRACE_CO_HTTP_SERVER - (int) - - - - Record coroutine http server log flag. - - - - - - SWOOLE_TRACE_TABLE - (int) - - - - Record table log flag. - - - - - - SWOOLE_TRACE_CO_CURL - (int) - - - - Record coroutine curl log flag. - - - - - - SWOOLE_TRACE_CARES - (int) - - - - Record cares log flag. - - - - - - SWOOLE_TRACE_ZLIB - (int) - - - - Record zlib log flag. - - - - - - SWOOLE_TRACE_CO_PGSQL - (int) - - - - Record pgsql coroutine log flag. - - - - - - SWOOLE_TRACE_CO_ODBC - (int) - - - - Record odbc coroutine log flag. - - - - - - SWOOLE_TRACE_CO_ORACLE - (int) - - - - Record oracle coroutine log flag. - - - - - - SWOOLE_TRACE_CO_SQLITE - (int) - - - - Record sqlite coroutine log flag. - - - - - - SWOOLE_TRACE_ALL - (int) - - - - Record all level log flag. - - - - - - SWOOLE_LOG_DEBUG - (int) - - - - Record debug level log flag. - - - - - - SWOOLE_LOG_TRACE - (int) - - - - Record trace level log flag. - - - - - - SWOOLE_LOG_INFO - (int) - - - - Record info level log flag. - - - - - - SWOOLE_LOG_NOTICE - (int) - - - - Record notice level log flag. - - - - - - SWOOLE_LOG_WARNING - (int) - - - - Record warning level log flag. - - - - - - SWOOLE_LOG_ERROR - (int) - - - - Record error level log flag. - - - - - - SWOOLE_LOG_NONE - (int) - - - - Equivalent to turning off log information, log information will not be thrown. - - - - - - SWOOLE_LOG_ROTATION_SINGLE - (int) - - - - disable log rotation. - - - - - - SWOOLE_LOG_ROTATION_MONTHLY - (int) - - - - Rotate logs monthly. - - - - - - SWOOLE_LOG_ROTATION_DAILY - (int) - - - - Rotate logs daily. - - - - - - SWOOLE_LOG_ROTATION_HOURLY - (int) - - - - Rotate logs hourly. - - - - - - SWOOLE_LOG_ROTATION_EVERY_MINUTE - (int) - - - - Rotate logs every minute. - - - - - - SWOOLE_IPC_NONE - (int) - - - - Do not use any inter-process communication (IPC) features. - - - - - - SWOOLE_IPC_UNIXSOCK - (int) - - - - For inter-process communication (IPC), using Unix domain sockets (UnixSocket) in coroutine mode - is highly recommended. - - - - - - SWOOLE_IPC_SOCKET - (int) - - - - To use sockets for inter-process communication (IPC), - the listen method must be called to specify the address and port to monitor. - - - - - - SWOOLE_IOV_MAX - (int) - - - - MAX iov limit. - - - - - - SWOOLE_IOURING_DEFAULT - (int) - - - - In interrupt-driven mode, I/O requests can be submitted via the io_uring_enter syscall, - and completion is determined by directly checking the completion queue status. - - - - - - SWOOLE_IOURING_SQPOLL - (int) - - - - In kernel polling mode, the kernel creates dedicated threads to submit and reap I/O requests, - nearly eliminating user-kernel context switches. - - - - - - SWOOLE_BASE - (int) - - - - Basic mode. - - - - - - SWOOLE_PROCESS - (int) - - - - Multi-process mode. - - - - - - SWOOLE_THREAD - (int) - - - - Multi-thread mode. - - - - - - SWOOLE_IPC_UNSOCK - (int) - - - - The task process communicates with the worker process using a Unix Socket. - - - - - - SWOOLE_IPC_MSGQUEUE - (int) - - - - The task process communicates with the worker process using a sysvmsg queue. - - - - - - SWOOLE_IPC_PREEMPTIVE - (int) - - - - The task process communicates with the worker process using a preemptive mode over a sysvmsg queue. - - - - - - SWOOLE_SERVER_COMMAND_MASTER - (int) - - - - Master process accept requests. - - - - - - SWOOLE_SERVER_COMMAND_MANAGER - (int) - - - - Manager process accept requests. - - - - - - SWOOLE_SERVER_COMMAND_REACTOR_THREAD - (int) - - - - Reactor thread accept requests. - - - - - - SWOOLE_SERVER_COMMAND_EVENT_WORKER - (int) - - - - Event worker thread process accept requests. - - - - - - SWOOLE_SERVER_COMMAND_TASK_WORKER - (int) - - - - Task worker thread process accept requests. - - - - - - SWOOLE_DISPATCH_ROUND - (int) - - - - Round robin mode, each Worker process will be allocated sequentially for every received connection. - - - - - - SWOOLE_DISPATCH_FDMOD - (int) - - - - Allocate Worker based on the connection's file descriptor. This ensures that data from the same connection - will be processed by the same Worker only. - - - - - - SWOOLE_DISPATCH_IDLE_WORKER - (int) - - - - The main process will choose delivery based on the workload status of the Worker, delivering only to idle Workers. - - - - - - SWOOLE_DISPATCH_IPMOD - (int) - - - - Allocate based on client IP using modulo hash, assigning to a specific Worker process. - This ensures that data from the same source IP connection will always be assigned to - the same Worker process. Algorithm: inet_addr_mod(ClientIP, worker_num). - - - - - - SWOOLE_DISPATCH_UIDMOD - (int) - - - - Requires binding a connection to a unique uid by calling Server->bind() in the user code. - Then, the underlying system allocates to different Worker processes based on the value of UID. - Algorithm: UID % worker_num. To use strings as UID, you can use crc32(UID_STRING). - - - - - - SWOOLE_DISPATCH_USERFUNC - (int) - - - - Set a dispatch_func callback function, where its return value determines - which process handles the request. - - - - - - SWOOLE_DISPATCH_CO_CONN_LB - (int) - - - - Determine which process handles the request based on the number of connections. - - - - - - SWOOLE_DISPATCH_CO_REQ_LB - (int) - - - - Determine which process handles the request based on the number of requests. - - - - - - SWOOLE_DISPATCH_CONCURRENT_LB - (int) - - - - Determine which process handles the request based on concurrency count. - - - - - - SWOOLE_WORKER_BUSY - (int) - - - - Process is busy. - - - - - - SWOOLE_WORKER_IDLE - (int) - - - - Process is idle. - - - - - - SWOOLE_WORKER_EXIT - (int) - - - - Process exited. - - - - - - SWOOLE_MUTEX - (int) - - - - Mutex lock. - - - - - - SWOOLE_RWLOCK - (int) - - - - RW lock. - - - - - - SWOOLE_SPINLOCK - (int) - - - - Spin lock. - - - - - - SWOOLE_CORO_MAX_NUM_LIMIT - (int) - - - - Maximum number of coroutines created(PHP_INT_MAX). - - - - - - SWOOLE_CORO_INIT - (int) - - - - Coroutine initializing. - - - - - - SWOOLE_CORO_WAITING - (int) - - - - Coroutine yield. - - - - - - SWOOLE_CORO_RUNNING - (int) - - - - Coroutine completed - - - - - - SWOOLE_CORO_END - (int) - - - - Coroutine completed. - - - - - - SWOOLE_EXIT_IN_COROUTINE - (int) - - - - Executing exit() function in coroutine. - - - - - - SWOOLE_EXIT_IN_SERVER - (int) - - - - Executing exit() function in server. - - - - - - SWOOLE_HTTP2_TYPE_DATA - (int) - - - - HTTP2 data frame. - - - - - - SWOOLE_HTTP2_TYPE_HEADERS - (int) - - - - HTTP2 headers frame. - - - - - - SWOOLE_HTTP2_TYPE_PRIORITY - (int) - - - - HTTP2 priority frame. - - - - - - SWOOLE_HTTP2_TYPE_RST_STREAM - (int) - - - - HTTP2 rst stream frame. - - - - - - SWOOLE_HTTP2_TYPE_SETTINGS - (int) - - - - HTTP2 settings frame. - - - - - - SWOOLE_HTTP2_TYPE_PUSH_PROMISE - (int) - - - - HTTP2 push promise frame. - - - - - - SWOOLE_HTTP2_TYPE_PING - (int) - - - - HTTP2 ping frame. - - - - - - SWOOLE_HTTP2_TYPE_GOAWAY - (int) - - - - HTTP2 goaway frame. - - - - - - SWOOLE_HTTP2_TYPE_WINDOW_UPDATE - (int) - - - - HTTP2 window update frame. - - - - - - SWOOLE_HTTP2_TYPE_CONTINUATION - (int) - - - - HTTP2 continuation frame. - - - - - - SWOOLE_HTTP2_ERROR_NO_ERROR - (int) - - - - HTTP2 no error. - - - - - - SWOOLE_HTTP2_ERROR_PROTOCOL_ERROR - (int) - - - - HTTP2 protocol error. - - - - - - SWOOLE_HTTP2_ERROR_INTERNAL_ERROR - (int) - - - - HTTP2 internal error. - - - - - - SWOOLE_HTTP2_ERROR_FLOW_CONTROL_ERROR - (int) - - - - HTTP2 flow control error. - - - - - - SWOOLE_HTTP2_ERROR_SETTINGS_TIMEOUT - (int) - - - - HTTP2 setting timeout error. - - - - - - SWOOLE_HTTP2_ERROR_STREAM_CLOSED - (int) - - - - HTTP2 stream closed error. - - - - - - SWOOLE_HTTP2_ERROR_FRAME_SIZE_ERROR - (int) - - - - HTTP2 frame size error error. - - - - - - SWOOLE_HTTP2_ERROR_REFUSED_STREAM - (int) - - - - HTTP2 refused stream error. - - - - - - SWOOLE_HTTP2_ERROR_CANCEL - (int) - - - - HTTP2 cancel error. - - - - - - SWOOLE_HTTP2_ERROR_COMPRESSION_ERROR - (int) - - - - HTTP2 compression error. - - - - - - SWOOLE_HTTP2_ERROR_CONNECT_ERROR - (int) - - - - HTTP2 connect error. - - - - - - SWOOLE_HTTP2_ERROR_ENHANCE_YOUR_CALM - (int) - - - - HTTP2 enhance your calm error. - - - - - - SWOOLE_HTTP2_ERROR_INADEQUATE_SECURITY - (int) - - - - HTTP2 inadequate security error. - - - - - - SWOOLE_HTTP2_ERROR_HTTP_1_1_REQUIRED - (int) - - - - HTTP2 require http1.1 error. - - - - - - SWOOLE_HTTP_CLIENT_ESTATUS_CONNECT_FAILED - (int) - - - - Connection timeout, the server is not listening on the port or there is a network failure, - you can read $errCode to get the specific network error code. - - - - - - SWOOLE_HTTP_CLIENT_ESTATUS_REQUEST_TIMEOUT - (int) - - - - Request timeout, the server did not return a response within the specified timeout time. - - - - - - SWOOLE_HTTP_CLIENT_ESTATUS_SERVER_RESET - (int) - - - - After the client's request is sent, the server forcefully disconnects the connection. - - - - - - SWOOLE_HTTP_CLIENT_ESTATUS_SEND_FAILED - (int) - - - - Client send failed (this constant is available in Swoole version >= v4.5.9, - for versions less than this, please use the status code). - - - - - - SWOOLE_MSGQUEUE_ORIENT - (int) - - - - Swoole\Process::pop() will return specific data in the queue with the message type as process id + 1, - Swoole\Process::push() will add the type process id + 1 to the message. - - - - - - SWOOLE_MSGQUEUE_BALANCE - (int) - - - - Swoole\Process::pop() will return the first message in the queue, - Swoole\Process::push() will not add a specific type to the message. - - - - - - SWOOLE_HOOK_TCP - (int) - - - - Coroutine-based stream of TCP Socket type, including the most common ones like Redis, PDO, Mysqli. - - - - - - SWOOLE_HOOK_UDP - (int) - - - - Coroutine-based stream of UDP Socket type. - - - - - - SWOOLE_HOOK_UNIX - (int) - - - - Coroutine-based stream for Unix Stream Socket type. - - - - - - SWOOLE_HOOK_UDG - (int) - - - - Coroutine-based stream for UDG Stream Socket type. - - - - - - SWOOLE_HOOK_SSL - (int) - - - - Coroutine-based stream for SSL Stream Socket type. - - - - - - SWOOLE_HOOK_TLS - (int) - - - - Coroutine-based stream for TLS Stream Socket type. - - - - - - SWOOLE_HOOK_STREAM_FUNCTION - (int) - - - - Coroutine-based stream_*() function. - - - - - - SWOOLE_HOOK_FILE - (int) - - - - Coroutine-based file operations. - - - - - - SWOOLE_HOOK_STDIO - (int) - - - - Coroutine-based STDIO operations. - - - - - - SWOOLE_HOOK_SLEEP - (int) - - - - Coroutine-based sleep operations, including sleep, usleep, time_nanosleep, time_sleep_until. - - - - - - SWOOLE_HOOK_PROC - (int) - - - - Coroutine-based proc* functions, including: proc_open, proc_close, proc_get_status, proc_terminate. - - - - - - SWOOLE_HOOK_CURL - (int) - - - - Coroutine-based for curl extension. - - - - - - SWOOLE_HOOK_NATIVE_CURL - (int) - - - - Coroutine-based for native curl extension. - - - - - - SWOOLE_HOOK_BLOCKING_FUNCTION - (int) - - - - Coroutine-based for blocking function, include gethostbyname, exec, shell_exec. - - - - - - SWOOLE_HOOK_SOCKETS - (int) - - - - Coroutine-based for the sockets extension - - - - - - SWOOLE_HOOK_PDO_PGSQL - (int) - - - - Coroutine-based for pdo_pgsql extension. - - - - - - SWOOLE_HOOK_PDO_ODBC - (int) - - - - Coroutine-based for pdo_odbc extension. - - - - - - SWOOLE_HOOK_PDO_ORACLE - (int) - - - - Coroutine-based for pdo_oci extension. - - - - - - SWOOLE_HOOK_PDO_SQLITE - (int) - - - - Coroutine-based for pdo_sqlite extension. - - - - - - SWOOLE_HOOK_ALL - (int) - - - - Coroutine-based for all block functions and extensions. - - - - - - SOCKET_ECANCELED - (int) - - - - Socket ecanceled error. - - - - - - TCP_INFO - (int) - - - - TCP_INFO. - - - - - - SWOOLE_TIMER_MIN_MS - (int) - - - - Minimum supported timer interval (in milliseconds). - - - - - - SWOOLE_TIMER_MIN_SEC - (double) - - - - Minimum supported timer interval (in seconds). - - - - - - SWOOLE_TIMER_MAX_MS - (int) - - - - Maximum supported timer interval (in milliseconds). - - - - - - SWOOLE_TIMER_MAX_SEC - (int) - - - - Maximum supported timer interval (in seconds). - - - - - - SWOOLE_WEBSOCKET_STATUS_CONNECTION - (int) - - - - WebSocket is establishing a connection. - - - - - - SWOOLE_WEBSOCKET_STATUS_HANDSHAKE - (int) - - - - The WebSocket is in the handshake phase. - - - - - - SWOOLE_WEBSOCKET_STATUS_ACTIVE - (int) - - - - Active WebSocket connection. - - - - - - SWOOLE_WEBSOCKET_STATUS_CLOSING - (int) - - - - WebSocket connection is closed. - - - - - - SWOOLE_WEBSOCKET_OPCODE_CONTINUATION - (int) - - - - Websocket continuation frame. - - - - - - SWOOLE_WEBSOCKET_OPCODE_TEXT - (int) - - - - Websocket text frame. - - - - - - SWOOLE_WEBSOCKET_OPCODE_BINARY - (int) - - - - Websocket binary frame. - - - - - - SWOOLE_WEBSOCKET_OPCODE_CLOSE - (int) - - - - Websocket close frame. - - - - - - SWOOLE_WEBSOCKET_OPCODE_PING - (int) - - - - Websocket ping frame. - - - - - - SWOOLE_WEBSOCKET_OPCODE_PONG - (int) - - - - Websocket pong frame. - - - - - - SWOOLE_WEBSOCKET_FLAG_FIN - (int) - - - - Websocket FIN flag. - - - - - - SWOOLE_WEBSOCKET_FLAG_RSV1 - (int) - - - - Websocket RSV1 flag. - - - - - - SWOOLE_WEBSOCKET_FLAG_RSV2 - (int) - - - - Websocket RSV2 flag. - - - - - - SWOOLE_WEBSOCKET_FLAG_RSV3 - (int) - - - - Websocket RSV3 flag. - - - - - - SWOOLE_WEBSOCKET_FLAG_MASK - (int) - - - - Websocket MASK flag. - - - - - - SWOOLE_WEBSOCKET_FLAG_COMPRESS - (int) - - - - Websocket COMPRESS flag. - - - - - - SWOOLE_WEBSOCKET_CLOSE_NORMAL - (int) - - - - Normal closure (connection completed successfully). - - - - - - SWOOLE_WEBSOCKET_CLOSE_GOING_AWAY - (int) - - - - Endpoint is going away (e.g., browser tab closed). - - - - - - SWOOLE_WEBSOCKET_CLOSE_PROTOCOL_ERROR - (int) - - - - Protocol error (malformed data frame). - - - - - - SWOOLE_WEBSOCKET_CLOSE_DATA_ERROR - (int) - - - - Received unsupported data (e.g., binary when expecting text). - - - - - - SWOOLE_WEBSOCKET_CLOSE_STATUS_ERROR - (int) - - - - No status code provided (sent as a placeholder). - - - - - - SWOOLE_WEBSOCKET_CLOSE_ABNORMAL - (int) - - - - Abnormal closure (no close frame received, e.g., TCP reset). - - - - - - SWOOLE_WEBSOCKET_CLOSE_MESSAGE_ERROR - (int) - - - - Invalid data (e.g., non-UTF-8 text in a text frame). - - - - - - SWOOLE_WEBSOCKET_CLOSE_POLICY_ERROR - (int) - - - - Policy violation (e.g., unauthorized action). - - - - - - SWOOLE_WEBSOCKET_CLOSE_MESSAGE_TOO_BIG - (int) - - - - Message too large (exceeds server’s max size). - - - - - - SWOOLE_WEBSOCKET_CLOSE_EXTENSION_MISSING - (int) - - - - Client didn’t negotiate required extensions. - - - - - - SWOOLE_WEBSOCKET_CLOSE_SERVER_ERROR - (int) - - - - Server encountered an error. - - - - - - SWOOLE_WEBSOCKET_CLOSE_CLOSE_SERVICE_RESTART - (int) - - - - Server is restarting (temporary condition). - - - - - - SWOOLE_WEBSOCKET_CLOSE_TRY_AGAIN_LATER - (int) - - - - Temporary server overload (client should retry). - - - - - - SWOOLE_WEBSOCKET_CLOSE_BAD_GATEWAY - (int) - - - - Invalid response from upstream server. - - - - - - SWOOLE_WEBSOCKET_CLOSE_TLS - (int) - - - - TLS handshake failed (used when HTTPS fails). - - - - - - - - diff --git a/reference/swoole/functions/swoole-async-dns-lookup.xml b/reference/swoole/functions/swoole-async-dns-lookup.xml deleted file mode 100644 index 0fc4097f9951..000000000000 --- a/reference/swoole/functions/swoole-async-dns-lookup.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - swoole_async_dns_lookup - Async and non-blocking hostname to IP lookup - - - - &reftitle.description; - - boolswoole_async_dns_lookup - stringhostname - callablecallback - - - - - - - - - &reftitle.parameters; - - - hostname - - - The host name. - - - - - callback - - - - mixedcallback - stringhostname - stringip - - - - hostname - - - The host name. - - - - - IP - - - The IP address. - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/swoole/functions/swoole-async-read.xml b/reference/swoole/functions/swoole-async-read.xml deleted file mode 100644 index 2fae5fd37c27..000000000000 --- a/reference/swoole/functions/swoole-async-read.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - swoole_async_read - Read file stream asynchronously - - - - &reftitle.description; - - boolswoole_async_read - stringfilename - callablecallback - intchunk_size65536 - intoffset0 - - - - - - - - - &reftitle.parameters; - - - filename - - - The filename of the file being read. - - - - - callback - - - mixedcallback - stringfilename - stringcontent - - - - filename - - - The name of the file. - - - - - content - - - The content read from the file stream. - - - - - - - - chunk_size - - - The chunk length. - - - - - offset - - - The offset. - - - - - - - - &reftitle.returnvalues; - - Whether the read is succeed. - - - - - - diff --git a/reference/swoole/functions/swoole-async-readfile.xml b/reference/swoole/functions/swoole-async-readfile.xml deleted file mode 100644 index 410f9f3e0c48..000000000000 --- a/reference/swoole/functions/swoole-async-readfile.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - swoole_async_readfile - Read a file asynchronously - - - - &reftitle.description; - - boolswoole_async_readfile - stringfilename - callablecallback - - - - - - - - - &reftitle.parameters; - - - filename - - - The filename of the file being read. - - - - - callback - - - mixedcallback - stringfilename - stringcontent - - - - filename - - - The name of the file. - - - - - content - - - The content read from the file. - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - diff --git a/reference/swoole/functions/swoole-async-set.xml b/reference/swoole/functions/swoole-async-set.xml deleted file mode 100644 index 6b7f22b6b9d7..000000000000 --- a/reference/swoole/functions/swoole-async-set.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - swoole_async_set - Update the async I/O options - - - - &reftitle.description; - - voidswoole_async_set - arraysettings - - - - - - - - - &reftitle.parameters; - - - settings - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/swoole/functions/swoole-async-write.xml b/reference/swoole/functions/swoole-async-write.xml deleted file mode 100644 index d401c309047e..000000000000 --- a/reference/swoole/functions/swoole-async-write.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - swoole_async_write - Write data to a file stream asynchronously - - - - &reftitle.description; - - boolswoole_async_write - stringfilename - stringcontent - intoffset - callablecallback - - - - - - - - - &reftitle.parameters; - - - filename - - - The filename being written. - - - - - content - - - The content writing to the file. - - - - - offset - - - The offset. - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - diff --git a/reference/swoole/functions/swoole-async-writefile.xml b/reference/swoole/functions/swoole-async-writefile.xml deleted file mode 100644 index d644b847a20b..000000000000 --- a/reference/swoole/functions/swoole-async-writefile.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - swoole_async_writefile - Write data to a file asynchronously - - - - &reftitle.description; - - boolswoole_async_writefile - stringfilename - stringcontent - callablecallback - intflags0 - - - - - - - - - &reftitle.parameters; - - - filename - - - The filename being written. - - - - - content - - - The content writing to the file. - - - - - callback - - - - - - - - flags - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - diff --git a/reference/swoole/functions/swoole-clear-error.xml b/reference/swoole/functions/swoole-clear-error.xml deleted file mode 100644 index 59262127d362..000000000000 --- a/reference/swoole/functions/swoole-clear-error.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - swoole_clear_error - Clear errors in the socket or on the last error code - - - - &reftitle.description; - - voidswoole_clear_error - - - - Clear errors in the socket or on the last error code. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/swoole/functions/swoole-client-select.xml b/reference/swoole/functions/swoole-client-select.xml deleted file mode 100644 index 783031aae896..000000000000 --- a/reference/swoole/functions/swoole-client-select.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - swoole_client_select - Get the file description which are ready to read/write or error - - - - &reftitle.description; - - intswoole_client_select - arrayread_array - arraywrite_array - arrayerror_array - floattimeout0.5 - - - - - - - - - &reftitle.parameters; - - - read_array - - - - - - - - write_array - - - - - - - - error_array - - - - - - - - timeout - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/functions/swoole-cpu-num.xml b/reference/swoole/functions/swoole-cpu-num.xml deleted file mode 100644 index f76426910e6f..000000000000 --- a/reference/swoole/functions/swoole-cpu-num.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - swoole_cpu_num - Get the number of CPU - - - - &reftitle.description; - - intswoole_cpu_num - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The number of CPU. - - - - - - - diff --git a/reference/swoole/functions/swoole-errno.xml b/reference/swoole/functions/swoole-errno.xml deleted file mode 100644 index 5bea35a4d8e9..000000000000 --- a/reference/swoole/functions/swoole-errno.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - swoole_errno - Get the error code of the latest system call - - - - &reftitle.description; - - intswoole_errno - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/functions/swoole-error-log.xml b/reference/swoole/functions/swoole-error-log.xml deleted file mode 100644 index ec99fb9adf12..000000000000 --- a/reference/swoole/functions/swoole-error-log.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - swoole_error_log - Output error messages to the log - - - - &reftitle.description; - - voidswoole_error_log - intlevel - stringmsg - - - Output error messages to the log. - - - - - &reftitle.parameters; - - - level - - - Log Level, constants can be used: SWOOLE_LOG_DEBUG, - SWOOLE_LOG_TRACE, - SWOOLE_LOG_INFO, - SWOOLE_LOG_NOTICE, - SWOOLE_LOG_WARNING, - SWOOLE_LOG_ERROR, - SWOOLE_LOG_NONE - - - - - msg - - - Message content to be written to the log. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/swoole/functions/swoole-event-add.xml b/reference/swoole/functions/swoole-event-add.xml deleted file mode 100644 index d2591f6e5a13..000000000000 --- a/reference/swoole/functions/swoole-event-add.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - swoole_event_add - Add new callback functions of a socket into the EventLoop - - - - &reftitle.description; - - intswoole_event_add - intfd - callableread_callback - callablewrite_callback - intevents0 - - - - - - - - - &reftitle.parameters; - - - fd - - - - - - - - read_callback - - - - - - - - write_callback - - - - - - - - events - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/functions/swoole-event-defer.xml b/reference/swoole/functions/swoole-event-defer.xml deleted file mode 100644 index e44692ef25dd..000000000000 --- a/reference/swoole/functions/swoole-event-defer.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - swoole_event_defer - Add callback function to the next event loop - - - - &reftitle.description; - - boolswoole_event_defer - callablecallback - - - - - - - - - &reftitle.parameters; - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - diff --git a/reference/swoole/functions/swoole-event-del.xml b/reference/swoole/functions/swoole-event-del.xml deleted file mode 100644 index 89a108e135f6..000000000000 --- a/reference/swoole/functions/swoole-event-del.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - swoole_event_del - Remove all event callback functions of a socket - - - - &reftitle.description; - - boolswoole_event_del - intfd - - - - - - - - - &reftitle.parameters; - - - fd - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - diff --git a/reference/swoole/functions/swoole-event-exit.xml b/reference/swoole/functions/swoole-event-exit.xml deleted file mode 100644 index 4b1fcceed79a..000000000000 --- a/reference/swoole/functions/swoole-event-exit.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - swoole_event_exit - Exit the eventloop, only available at the client side - - - - &reftitle.description; - - voidswoole_event_exit - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/functions/swoole-event-set.xml b/reference/swoole/functions/swoole-event-set.xml deleted file mode 100644 index 049ab15c8101..000000000000 --- a/reference/swoole/functions/swoole-event-set.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - swoole_event_set - Update the event callback functions of a socket - - - - &reftitle.description; - - boolswoole_event_set - intfd - callableread_callback - callablewrite_callback - intevents0 - - - - - - - - - &reftitle.parameters; - - - fd - - - - - - - - read_callback - - - - - - - - write_callback - - - - - - - - events - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/functions/swoole-event-wait.xml b/reference/swoole/functions/swoole-event-wait.xml deleted file mode 100644 index 86d454cbb790..000000000000 --- a/reference/swoole/functions/swoole-event-wait.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - swoole_event_wait - Start the event loop - - - - &reftitle.description; - - voidswoole_event_wait - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/functions/swoole-event-write.xml b/reference/swoole/functions/swoole-event-write.xml deleted file mode 100644 index 87a84eeadba7..000000000000 --- a/reference/swoole/functions/swoole-event-write.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - swoole_event_write - Write data to a socket - - - - &reftitle.description; - - boolswoole_event_write - intfd - stringdata - - - - - - - - - &reftitle.parameters; - - - fd - - - - - - - - data - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - diff --git a/reference/swoole/functions/swoole-get-local-ip.xml b/reference/swoole/functions/swoole-get-local-ip.xml deleted file mode 100644 index 97856c840e1e..000000000000 --- a/reference/swoole/functions/swoole-get-local-ip.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - swoole_get_local_ip - Get the IPv4 IP addresses of each NIC on the machine - - - - &reftitle.description; - - arrayswoole_get_local_ip - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/functions/swoole-last-error.xml b/reference/swoole/functions/swoole-last-error.xml deleted file mode 100644 index eb2814b84b62..000000000000 --- a/reference/swoole/functions/swoole-last-error.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - swoole_last_error - Get the latest error message - - - - &reftitle.description; - - intswoole_last_error - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/functions/swoole-load-module.xml b/reference/swoole/functions/swoole-load-module.xml deleted file mode 100644 index 88f8f37d4ea7..000000000000 --- a/reference/swoole/functions/swoole-load-module.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - swoole_load_module - Load a swoole extension - - - - &reftitle.description; - - mixedswoole_load_module - stringfilename - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/functions/swoole-select.xml b/reference/swoole/functions/swoole-select.xml deleted file mode 100644 index 9b575039e314..000000000000 --- a/reference/swoole/functions/swoole-select.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - swoole_select - Select the file descriptions which are ready to read/write or error in the eventloop - - - - &reftitle.description; - - intswoole_select - arrayread_array - arraywrite_array - arrayerror_array - floattimeout - - - - - - - - - &reftitle.parameters; - - - read_array - - - - - - - - write_array - - - - - - - - error_array - - - - - - - - timeout - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/functions/swoole-set-process-name.xml b/reference/swoole/functions/swoole-set-process-name.xml deleted file mode 100644 index ca62f2f54849..000000000000 --- a/reference/swoole/functions/swoole-set-process-name.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - swoole_set_process_name - Set the process name - - - - &reftitle.description; - - voidswoole_set_process_name - stringprocess_name - intsize128 - - - - - - - - - &reftitle.parameters; - - - process_name - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/functions/swoole-strerror.xml b/reference/swoole/functions/swoole-strerror.xml deleted file mode 100644 index d4807931ae72..000000000000 --- a/reference/swoole/functions/swoole-strerror.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - swoole_strerror - Convert the Errno into error messages - - - - &reftitle.description; - - stringswoole_strerror - interrno - interror_type0 - - - - - - - - - &reftitle.parameters; - - - errno - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/functions/swoole-timer-after.xml b/reference/swoole/functions/swoole-timer-after.xml deleted file mode 100644 index 53c30ff90047..000000000000 --- a/reference/swoole/functions/swoole-timer-after.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - swoole_timer_after - Trigger a one time callback function in the future - - - - &reftitle.description; - - intswoole_timer_after - intms - callablecallback - mixedparam - - - - - - - - - &reftitle.parameters; - - - ms - - - - - - - - callback - - - - - - - - param - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/functions/swoole-timer-exists.xml b/reference/swoole/functions/swoole-timer-exists.xml deleted file mode 100644 index 44c8de59ef56..000000000000 --- a/reference/swoole/functions/swoole-timer-exists.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - swoole_timer_exists - Check if a timer callback function is existed - - - - &reftitle.description; - - boolswoole_timer_exists - inttimer_id - - - - - - - - - &reftitle.parameters; - - - timer_id - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/functions/swoole-timer-tick.xml b/reference/swoole/functions/swoole-timer-tick.xml deleted file mode 100644 index b70a9dc308e2..000000000000 --- a/reference/swoole/functions/swoole-timer-tick.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - swoole_timer_tick - Trigger a timer tick callback function by time interval - - - - &reftitle.description; - - intswoole_timer_tick - intms - callablecallback - mixedparam - - - - - - - - - &reftitle.parameters; - - - ms - - - - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/functions/swoole-version.xml b/reference/swoole/functions/swoole-version.xml deleted file mode 100644 index 9f5dadfe4f14..000000000000 --- a/reference/swoole/functions/swoole-version.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - swoole_version - Get the version of Swoole - - - - &reftitle.description; - - stringswoole_version - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The version of Swoole. - - - - - - - diff --git a/reference/swoole/ini.xml b/reference/swoole/ini.xml deleted file mode 100644 index 545f63cde143..000000000000 --- a/reference/swoole/ini.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - -
    - &reftitle.runtime; - &extension.runtime; - - - Swoole &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - swoole.enable_library - On - INI_ALL - - - - swoole.enable_fiber_mock - Off - INI_ALL - - - - swoole.enable_preemptive_scheduler - Off - INI_ALL - - - - swoole.display_errors - On - INI_ALL - - - - swoole.use_shortname - On - INI_SYSTEM - - - - swoole.unixsock_buffer_size - 8388608 - INI_ALL - - - - -
    -
    - - &ini.descriptions.title; - - - - - - swoole.enable_library - string - - - - Enable/disable the extension's built-in library. - - - - - - swoole.enable_fiber_mock - string - - - - Enable/disable use the xdebug extension to debug Swoole programs. - - - - - - swoole.enable_preemptive_scheduler - string - - - - Prevent some coroutines from consuming CPU time for too long in a tight loop (10ms of CPU time), preventing other coroutines from getting scheduled. - - - - - - swoole.display_errors - string - - - - Enable/disable displaying Swoole error messages. - - - - - - swoole.use_shortname - string - - - - Enable/disable short aliases. - - - - - - swoole.unixsock_buffer_size - int - - - - Set the size of the Socket buffer for inter-process communication. - - - - - -
    - - diff --git a/reference/swoole/reference.xml b/reference/swoole/reference.xml deleted file mode 100644 index 66e9d3b310be..000000000000 --- a/reference/swoole/reference.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - - - Swoole &Functions; - - &reference.swoole.entities.functions; - - \ No newline at end of file diff --git a/reference/swoole/setup.xml b/reference/swoole/setup.xml deleted file mode 100644 index 78b1e18d8196..000000000000 --- a/reference/swoole/setup.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - Swoole requires the libbrotli library. - - - Enabling --enable-swoole-curl option requires the libcurl library, and both PHP and Swoole must link to the - same libcurl shared library and headers to avoid undefined behavior. - - - Enabling --enable-iouring option requires liburing library (version >= 2.0) and Linux kernel (version >= 5.12). - - - Enabling --enable-swoole-thread option requires PHP to be in ZTS (Zend Thread Safety) mode. - - - Enabling the --enable-cares option requires the libc-ares library. - - - Enabling the --enable-zstd option requires the libzstd library (version >= 1.4.0). - - - Enabling the --enable-swoole-sqlite option requires the libsqlite library. - - - Enabling the --enable-swoole-pgsql option requires the libpq library. - - - Enabling the --with-swoole-odbc option requires the unixodbc-dev library. - - - Enabling the --with-swoole-oracle option requires the Oracle Instant Client libraries. - -
    - - - &reference.swoole.configure; - - - - &reference.swoole.ini; - - -
    diff --git a/reference/swoole/swoole.async.xml b/reference/swoole/swoole.async.xml deleted file mode 100644 index cd574e085857..000000000000 --- a/reference/swoole/swoole.async.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - The Swoole\Async class - Swoole\Async - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Async - - - - - Swoole\Async - - - - - &Methods; - - - - -
    - -
    - - &reference.swoole.swoole.entities.async; - -
    - - diff --git a/reference/swoole/swoole.atomic.xml b/reference/swoole/swoole.atomic.xml deleted file mode 100644 index ecc7cdef9c1c..000000000000 --- a/reference/swoole/swoole.atomic.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - The Swoole\Atomic class - Swoole\Atomic - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Atomic - - - - - Swoole\Atomic - - - - - &Methods; - - - - -
    - -
    - - &reference.swoole.swoole.entities.atomic; - -
    - - diff --git a/reference/swoole/swoole.buffer.xml b/reference/swoole/swoole.buffer.xml deleted file mode 100644 index dc91b9c24b1c..000000000000 --- a/reference/swoole/swoole.buffer.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - The Swoole\Buffer class - Swoole\Buffer - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Buffer - - - - - Swoole\Buffer - - - - - &Methods; - - - - -
    - -
    - - &reference.swoole.swoole.entities.buffer; - -
    - - diff --git a/reference/swoole/swoole.channel.xml b/reference/swoole/swoole.channel.xml deleted file mode 100644 index 069131cf99c1..000000000000 --- a/reference/swoole/swoole.channel.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - The Swoole\Channel class - Swoole\Channel - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Channel - - - - - Swoole\Channel - - - - - &Methods; - - - - -
    - -
    - - &reference.swoole.swoole.entities.channel; - -
    - - diff --git a/reference/swoole/swoole.client.xml b/reference/swoole/swoole.client.xml deleted file mode 100644 index edfd68947c96..000000000000 --- a/reference/swoole/swoole.client.xml +++ /dev/null @@ -1,183 +0,0 @@ - - - - - - The Swoole\Client class - Swoole\Client - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Client - - - - - Swoole\Client - - - - &Constants; - - const - int - Swoole\Client::MSG_OOB - 1 - - - const - int - Swoole\Client::MSG_PEEK - 2 - - - const - int - Swoole\Client::MSG_DONTWAIT - 128 - - - const - int - Swoole\Client::MSG_WAITALL - 64 - - - &Properties; - - public - errCode - - - public - sock - - - public - reuse - - - public - reuseCount - - - - &Methods; - - - - -
    - - - -
    - &reftitle.properties; - - - errCode - - - - - - sock - - - - - - reuse - - - - - - reuseCount - - - - - -
    - - - - -
    - &reftitle.constants; - - - - Swoole\Client::MSG_OOB - - - - - - - Swoole\Client::MSG_PEEK - - - - - - - Swoole\Client::MSG_DONTWAIT - - - - - - - Swoole\Client::MSG_WAITALL - - - - - - -
    - - - -
    - - &reference.swoole.swoole.entities.client; - -
    - - diff --git a/reference/swoole/swoole.connection.iterator.xml b/reference/swoole/swoole.connection.iterator.xml deleted file mode 100644 index 606297721037..000000000000 --- a/reference/swoole/swoole.connection.iterator.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - The Swoole\Connection\Iterator class - Swoole\Connection\Iterator - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Connection\Iterator - - - - - Swoole\Connection\Iterator - - - - Iterator - - - - Countable - - - - ArrayAccess - - - - - &Methods; - - - - -
    - -
    - - &reference.swoole.swoole.connection.entities.iterator; - -
    - - diff --git a/reference/swoole/swoole.coroutine.client.xml b/reference/swoole/swoole.coroutine.client.xml deleted file mode 100644 index bd732fadf248..000000000000 --- a/reference/swoole/swoole.coroutine.client.xml +++ /dev/null @@ -1,162 +0,0 @@ - - - - - - The Swoole\Coroutine\Client class - Swoole\Coroutine\Client - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Coroutine\Client - - - - - Swoole\Coroutine\Client - - - - &Constants; - - const - int - Swoole\Coroutine\Client::MSG_OOB - 1 - - - const - int - Swoole\Coroutine\Client::MSG_PEEK - 2 - - - const - int - Swoole\Coroutine\Client::MSG_DONTWAIT - 128 - - - const - int - Swoole\Coroutine\Client::MSG_WAITALL - 64 - - - &Properties; - - public - errCode - - - public - sock - - - - &Methods; - - - -
    - - - -
    - &reftitle.properties; - - - errCode - - - - - - sock - - - - - -
    - - - - -
    - &reftitle.constants; - - - - Swoole\Coroutine\Client::MSG_OOB - - - - - - - Swoole\Coroutine\Client::MSG_PEEK - - - - - - - Swoole\Coroutine\Client::MSG_DONTWAIT - - - - - - - Swoole\Coroutine\Client::MSG_WAITALL - - - - - - -
    - - - -
    - - &reference.swoole.swoole.coroutine.entities.client; - -
    - - diff --git a/reference/swoole/swoole.coroutine.http.client.xml b/reference/swoole/swoole.coroutine.http.client.xml deleted file mode 100644 index df629fdeb46b..000000000000 --- a/reference/swoole/swoole.coroutine.http.client.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - The Swoole\Coroutine\Http\Client class - Swoole\Coroutine\Http\Client - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Coroutine\Http\Client - - - - - Swoole\Coroutine\Http\Client - - - - &Properties; - - public - errCode - - - public - sock - - - - &Methods; - - - - -
    - - - -
    - &reftitle.properties; - - - errCode - - - - - - sock - - - - - -
    - - - -
    - - &reference.swoole.swoole.coroutine.http.entities.client; - -
    - - diff --git a/reference/swoole/swoole.coroutine.lock.xml b/reference/swoole/swoole.coroutine.lock.xml deleted file mode 100644 index d536aeca854f..000000000000 --- a/reference/swoole/swoole.coroutine.lock.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - - The Swoole\Coroutine\Lock class - Swoole\Coroutine\Lock - - - - -
    - &reftitle.intro; - - Swoole 6.0.1 introduced a coroutine lock that supports inter-process and inter-thread sharing. - This lock is designed with non-blocking behavior and enables efficient coroutine synchronization - in multi-process and multi-thread environments. - - - When compiled with the --enable-iouring option and the Linux kernel supports - the io_uring futex feature, Swoole's coroutine lock implements synchronization - using io_uring futex. In this case, coroutines wait for lock wakeups using - an efficient queuing mechanism, significantly improving performance. - - - Without io_uring futex, the coroutine lock falls back to an exponential backoff - sleep mechanism, where the wait time increases by 2^n milliseconds (n being the number of failures) - after each failed attempt to acquire the lock. While this approach avoids busy waiting, it introduces - additional CPU scheduling overhead and latency. - - - The coroutine lock is reentrant, allowing the currently holding coroutine to safely perform - multiple lock operations. - - - - Do not create locks in callback functions like onReceive, as this will cause - continuous memory growth and lead to memory leaks. - - - - - Locking and unlocking must be performed in the same coroutine, otherwise it will break - static conditions. - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Coroutine\Lock - - - - - Swoole\Coroutine\Lock - - - - - &Methods; - - - - -
    - -
    - &reftitle.examples; - - Basic usage - -add(); - $lock->lock(); - sleep(1); - $lock->unlock(); - $waitGroup->done(); - }); - - go(function() use ($lock, $waitGroup) { - $waitGroup->add(); - $lock->lock(); // Wait for the holding coroutine to unlock - sleep(1); - $lock->unlock(); - $waitGroup->done(); - }); - - echo 'Lock does not block the process'; - $waitGroup->wait(); -}); -]]> - - -
    - -
    - - &reference.swoole.swoole.coroutine.entities.lock; -
    - - diff --git a/reference/swoole/swoole.coroutine.mysql.exception.xml b/reference/swoole/swoole.coroutine.mysql.exception.xml deleted file mode 100644 index 5bcff61f264c..000000000000 --- a/reference/swoole/swoole.coroutine.mysql.exception.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - The Swoole\Coroutine\MySQL\Exception class - Swoole\Coroutine\MySQL\Exception - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Coroutine\MySQL\Exception - - - - - Swoole\Coroutine\MySQL\Exception - - - - extends - Exception - - - - Throwable - - - - &InheritedProperties; - - - - - -
    - -
    - -
    - - diff --git a/reference/swoole/swoole.coroutine.mysql.xml b/reference/swoole/swoole.coroutine.mysql.xml deleted file mode 100644 index c1cecd30a6eb..000000000000 --- a/reference/swoole/swoole.coroutine.mysql.xml +++ /dev/null @@ -1,159 +0,0 @@ - - - - - - The Swoole\Coroutine\MySQL class - Swoole\Coroutine\MySQL - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Coroutine\MySQL - - - - - Swoole\Coroutine\MySQL - - - - &Properties; - - public - sock - - - public - connected - - - public - connect_error - - - public - connect_errno - - - public - affected_rows - - - public - insert_id - - - public - error - - - public - errno - - - - &Methods; - - - - -
    - - - -
    - &reftitle.properties; - - - sock - - - - - - connected - - - - - - connect_error - - - - - - connect_errno - - - - - - affected_rows - - - - - - insert_id - - - - - - error - - - - - - errno - - - - - -
    - - - -
    - - &reference.swoole.swoole.coroutine.entities.mysql; - -
    - - diff --git a/reference/swoole/swoole.coroutine.xml b/reference/swoole/swoole.coroutine.xml deleted file mode 100644 index 3a3fa69bfbc2..000000000000 --- a/reference/swoole/swoole.coroutine.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - The Swoole\Coroutine class - Swoole\Coroutine - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Coroutine - - - - - Swoole\Coroutine - - - - - &Methods; - - - - -
    - -
    - - &reference.swoole.swoole.entities.coroutine; - -
    - - diff --git a/reference/swoole/swoole.event.xml b/reference/swoole/swoole.event.xml deleted file mode 100644 index d4cb09ec805d..000000000000 --- a/reference/swoole/swoole.event.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - - The Swoole\Event class - Swoole\Event - - - - -
    - &reftitle.intro; - - The Swoole extension provides low-level interfaces to directly manipulate the underlying epoll/kqueue/poll/select event loop. - It allows adding sockets created by other extensions or PHP's stream/socket extensions to Swoole's EventLoop. - - - - The Event module is low-level, being a basic encapsulation of epoll. Users should have experience with IO multiplexing programming. - - -
    - - -
    - Event Priority - - Signal handler callback functions set via Process::signal - Timer callback functions set via Timer::tick and Timer::after - Deferred execution functions set via Event::defer - Periodic callback functions set via Event::cycle - -
    - -
    - Swoole Event Socket Type - - - - - fd - int - - - - File descriptors, including Swoole\Client->$sock, Swoole\Process->$pipe, or any other file descriptor (fd). - - - - - - stream resource - resource - - - - Resources created by stream_socket_client/fsockopen. - - - - - - socket resource - resource - - - - Resources created by socket_create from the sockets extension require - the --enable-sockets flag during Swoole compilation. - - - - - - object - object - - - - Swoole automatically converts Swoole\Process into UnixSocket and Swoole\Client - into connected client sockets at the underlying level. - - - - - -
    - -
    - &reftitle.classsynopsis; - - - - Swoole\Event - - - - - Swoole\Event - - - - - &Methods; - - - - -
    - -
    - - &reference.swoole.swoole.entities.event; - -
    - - diff --git a/reference/swoole/swoole.exception.xml b/reference/swoole/swoole.exception.xml deleted file mode 100644 index 38bf56259dd7..000000000000 --- a/reference/swoole/swoole.exception.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - The Swoole\Exception class - Swoole\Exception - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Exception - - - - - Swoole\Exception - - - - extends - Exception - - - - Throwable - - - - &InheritedProperties; - - - - - -
    - -
    - -
    - - diff --git a/reference/swoole/swoole.http.client.xml b/reference/swoole/swoole.http.client.xml deleted file mode 100644 index 82f6c335ccad..000000000000 --- a/reference/swoole/swoole.http.client.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - The Swoole\Http\Client class - Swoole\Http\Client - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Http\Client - - - - - Swoole\Http\Client - - - - &Properties; - - public - errCode - - - public - sock - - - - &Methods; - - - - -
    - - - -
    - &reftitle.properties; - - - errCode - - - - - - sock - - - - - -
    - - - -
    - - &reference.swoole.swoole.http.entities.client; - -
    - - diff --git a/reference/swoole/swoole.http.request.xml b/reference/swoole/swoole.http.request.xml deleted file mode 100644 index ac696c7e335e..000000000000 --- a/reference/swoole/swoole.http.request.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - The Swoole\Http\Request class - Swoole\Http\Request - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Http\Request - - - - - Swoole\Http\Request - - - - - &Methods; - - - - -
    - -
    - - &reference.swoole.swoole.http.entities.request; - -
    - - diff --git a/reference/swoole/swoole.http.response.xml b/reference/swoole/swoole.http.response.xml deleted file mode 100644 index 202af8911b44..000000000000 --- a/reference/swoole/swoole.http.response.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - The Swoole\Http\Response class - Swoole\Http\Response - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Http\Response - - - - - Swoole\Http\Response - - - - - &Methods; - - - - -
    - -
    - - &reference.swoole.swoole.http.entities.response; - -
    - - diff --git a/reference/swoole/swoole.http.server.xml b/reference/swoole/swoole.http.server.xml deleted file mode 100644 index 81ad542fa11e..000000000000 --- a/reference/swoole/swoole.http.server.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - The Swoole\Http\Server class - Swoole\Http\Server - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Http\Server - - - - - Swoole\Http\Server - - - - extends - Swoole\Server - - - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -
    - - &reference.swoole.swoole.http.entities.server; - -
    - - diff --git a/reference/swoole/swoole.lock.xml b/reference/swoole/swoole.lock.xml deleted file mode 100644 index 534f732ffe94..000000000000 --- a/reference/swoole/swoole.lock.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - The Swoole\Lock class - Swoole\Lock - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Lock - - - - - Swoole\Lock - - - - - &Methods; - - - - -
    - -
    - - &reference.swoole.swoole.entities.lock; - -
    - - diff --git a/reference/swoole/swoole.mmap.xml b/reference/swoole/swoole.mmap.xml deleted file mode 100644 index 559f6ccac02d..000000000000 --- a/reference/swoole/swoole.mmap.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - The Swoole\Mmap class - Swoole\Mmap - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Mmap - - - - - Swoole\Mmap - - - - - &Methods; - - - - -
    - -
    - - &reference.swoole.swoole.entities.mmap; - -
    - - diff --git a/reference/swoole/swoole.module.xml b/reference/swoole/swoole.module.xml deleted file mode 100644 index 3378860b965c..000000000000 --- a/reference/swoole/swoole.module.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - The Swoole\Module class - Swoole\Module - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Module - - - - - Swoole\Module - - - - - - - -
    - -
    - -
    - - diff --git a/reference/swoole/swoole.mysql.exception.xml b/reference/swoole/swoole.mysql.exception.xml deleted file mode 100644 index d28af0064ad4..000000000000 --- a/reference/swoole/swoole.mysql.exception.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - The Swoole\MySQL\Exception class - Swoole\MySQL\Exception - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\MySQL\Exception - - - - - Swoole\MySQL\Exception - - - - extends - Exception - - - - Throwable - - - - &InheritedProperties; - - - - - - -
    - -
    - -
    - - diff --git a/reference/swoole/swoole.mysql.xml b/reference/swoole/swoole.mysql.xml deleted file mode 100644 index 1a5faa42a4dd..000000000000 --- a/reference/swoole/swoole.mysql.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - The Swoole\MySQL class - Swoole\MySQL - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\MySQL - - - - - Swoole\MySQL - - - - - &Methods; - - - - -
    - -
    - - &reference.swoole.swoole.entities.mysql; - -
    - - diff --git a/reference/swoole/swoole.process.xml b/reference/swoole/swoole.process.xml deleted file mode 100644 index cdcd85849db4..000000000000 --- a/reference/swoole/swoole.process.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - The Swoole\Process class - Swoole\Process - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Process - - - - - Swoole\Process - - - - &Constants; - - const - int - Swoole\Process::IPC_NOWAIT - 256 - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - Swoole\Process::IPC_NOWAIT - - - - - - -
    - - - -
    - - &reference.swoole.swoole.entities.process; - -
    - - diff --git a/reference/swoole/swoole.redis.server.xml b/reference/swoole/swoole.redis.server.xml deleted file mode 100644 index 3c7d5f64e043..000000000000 --- a/reference/swoole/swoole.redis.server.xml +++ /dev/null @@ -1,178 +0,0 @@ - - - - - - The Swoole\Redis\Server class - Swoole\Redis\Server - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Redis\Server - - - - - Swoole\Redis\Server - - - - extends - Swoole\Server - - - - &Constants; - - const - int - Swoole\Redis\Server::NIL - 1 - - - const - int - Swoole\Redis\Server::ERROR - 0 - - - const - int - Swoole\Redis\Server::STATUS - 2 - - - const - int - Swoole\Redis\Server::INT - 3 - - - const - int - Swoole\Redis\Server::STRING - 4 - - - const - int - Swoole\Redis\Server::SET - 5 - - - const - int - Swoole\Redis\Server::MAP - 6 - - - &Methods; - - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.constants; - - - - Swoole\Redis\Server::NIL - - - - - - - Swoole\Redis\Server::ERROR - - - - - - - Swoole\Redis\Server::STATUS - - - - - - - Swoole\Redis\Server::INT - - - - - - - Swoole\Redis\Server::STRING - - - - - - - Swoole\Redis\Server::SET - - - - - - - Swoole\Redis\Server::MAP - - - - - - -
    - - - -
    - - &reference.swoole.swoole.redis.entities.server; - -
    - - diff --git a/reference/swoole/swoole.runtime.xml b/reference/swoole/swoole.runtime.xml deleted file mode 100644 index d96fd45b94e6..000000000000 --- a/reference/swoole/swoole.runtime.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - The Swoole\Runtime class - Swoole\Runtime - - - - -
    - &reftitle.intro; - - Swoole\Runtime provides coroutine support for various PHP functions through hook mechanism, - allowing synchronous code to work asynchronously in coroutine environment. - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Runtime - - - - - Swoole\Runtime - - - - - &Methods; - - - - -
    - -
    - - &reference.swoole.swoole.entities.runtime; - -
    - - diff --git a/reference/swoole/swoole.serialize.xml b/reference/swoole/swoole.serialize.xml deleted file mode 100644 index 1cab8e2d9b31..000000000000 --- a/reference/swoole/swoole.serialize.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - The Swoole\Serialize class - Swoole\Serialize - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Serialize - - - - - Swoole\Serialize - - - - - &Methods; - - - - -
    - -
    - - &reference.swoole.swoole.entities.serialize; - -
    - - diff --git a/reference/swoole/swoole.server.port.xml b/reference/swoole/swoole.server.port.xml deleted file mode 100644 index 58ce58da59e3..000000000000 --- a/reference/swoole/swoole.server.port.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - The Swoole\Server\Port class - Swoole\Server\Port - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Server\Port - - - - - Swoole\Server\Port - - - - - &Methods; - - - - -
    - -
    - - &reference.swoole.swoole.server.entities.port; - -
    - - diff --git a/reference/swoole/swoole.server.xml b/reference/swoole/swoole.server.xml deleted file mode 100644 index a46137f00b61..000000000000 --- a/reference/swoole/swoole.server.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - The Swoole\Server class - Swoole\Server - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Server - - - - - Swoole\Server - - - - - &Methods; - - - - -
    - -
    - - &reference.swoole.swoole.entities.server; - -
    - - diff --git a/reference/swoole/swoole.table.xml b/reference/swoole/swoole.table.xml deleted file mode 100644 index 28d54f8bdc97..000000000000 --- a/reference/swoole/swoole.table.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - The Swoole\Table class - Swoole\Table - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Table - - - - - Swoole\Table - - - - Iterator - - - - Countable - - - - &Constants; - - const - int - Swoole\Table::TYPE_INT - 1 - - - const - int - Swoole\Table::TYPE_STRING - 7 - - - const - int - Swoole\Table::TYPE_FLOAT - 6 - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - Swoole\Table::TYPE_INT - - - - - - - Swoole\Table::TYPE_STRING - - - - - - - Swoole\Table::TYPE_FLOAT - - - - - - -
    - - - -
    - - &reference.swoole.swoole.entities.table; - -
    - - diff --git a/reference/swoole/swoole.timer.xml b/reference/swoole/swoole.timer.xml deleted file mode 100644 index d39a63a9bda6..000000000000 --- a/reference/swoole/swoole.timer.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - The Swoole\Timer class - Swoole\Timer - - - - -
    - &reftitle.intro; - - Millisecond precision timer. The underlying implementation is based on epoll_wait and setitimer, - using a min-heap data structure that supports adding a large number of timers. - - - In synchronous I/O processes, such as the Manager and TaskWorker processes, it is - implemented using setitimer and signals. - - - In asynchronous I/O processes, it is implemented using the timeout of - epoll_wait/kevent/poll/select. - - - The underlying system does not support timers with a delay of 0; - values below 1 millisecond emit an - E_WARNING and the call fails. This differs from - languages such as Node.js. - Swoole\Event::defer - may be used to achieve similar functionality. - - -]]> - - - - Timer Correction: The execution time of the timer callback function does not affect the timing of the - next timer execution. For example, setting a tick timer of 10ms after 0.002s, the first callback will - be executed at 0.012s, if the callback function takes 5ms to execute, the next timer will still trigger - at 0.022s, not at 0.027s. - - - However, if the execution time of the timer callback function is too long, even covering the time of the - next timer execution, the underlying system will perform time correction, discarding the expired behavior - and triggering the timer callback at the next available time. For example, if the callback function - at 0.012s takes 15ms to execute, causing the timer at 0.022s to be delayed, the timer callback - will be triggered again at 0.032s. - - - By default, when a timer is triggered, a coroutine is automatically created - to execute the callback function. This can be disabled with - swoole_async_set. - - - - Timer only works within the current process space. - - - - - Timer is purely asynchronous and incompatible with synchronous I/O functions. - - - - - Timer execution may experience minor timing deviations. - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Timer - - - - - Swoole\Timer - - - - - &Methods; - - - - -
    - -
    - - &reference.swoole.swoole.entities.timer; - -
    - - diff --git a/reference/swoole/swoole.websocket.frame.xml b/reference/swoole/swoole.websocket.frame.xml deleted file mode 100644 index 6717a14ae485..000000000000 --- a/reference/swoole/swoole.websocket.frame.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - The Swoole\WebSocket\Frame class - Swoole\WebSocket\Frame - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\WebSocket\Frame - - - - - Swoole\WebSocket\Frame - - - - - &Methods; - - - - -
    - -
    - -
    - - diff --git a/reference/swoole/swoole.websocket.server.xml b/reference/swoole/swoole.websocket.server.xml deleted file mode 100644 index 63c2a1732087..000000000000 --- a/reference/swoole/swoole.websocket.server.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - The Swoole\WebSocket\Server class - Swoole\WebSocket\Server - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\WebSocket\Server - - - - - Swoole\WebSocket\Server - - - - extends - Swoole\Http\Server - - - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -
    - - &reference.swoole.swoole.websocket.entities.server; - -
    - - diff --git a/reference/swoole/swoole/async/dnslookup.xml b/reference/swoole/swoole/async/dnslookup.xml deleted file mode 100644 index 321231bc7633..000000000000 --- a/reference/swoole/swoole/async/dnslookup.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Swoole\Async::dnsLookup - Async and non-blocking hostname to IP lookup. - - - - &reftitle.description; - - public static voidSwoole\Async::dnsLookup - stringhostname - callablecallback - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - hostname - - - The host name. - - - - - callback - - - mixedcallback - stringhostname - stringip - - - - hostname - - - The host name. - - - - - IP - - - The IP address. - - - - - - - - - - - - diff --git a/reference/swoole/swoole/async/read.xml b/reference/swoole/swoole/async/read.xml deleted file mode 100644 index 9082f7408ad1..000000000000 --- a/reference/swoole/swoole/async/read.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - Swoole\Async::read - Read file stream asynchronously. - - - - &reftitle.description; - - public static boolSwoole\Async::read - stringfilename - callablecallback - intchunk_size - intoffset - - - - - - - - - &reftitle.parameters; - - - filename - - - The name of the file. - - - - - callback - - - mixedcallback - stringfilename - stringcontent - - - - filename - - - The name of the file. - - - - - content - - - The content read from the file stream. - - - - - - - - chunk_size - - - The chunk length. - - - - - offset - - - The offset. - - - - - - - - &reftitle.returnvalues; - - Whether the read is succeed. - - - - - - diff --git a/reference/swoole/swoole/async/readfile.xml b/reference/swoole/swoole/async/readfile.xml deleted file mode 100644 index 1533c8542f9a..000000000000 --- a/reference/swoole/swoole/async/readfile.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - Swoole\Async::readFile - Read a file asynchronously. - - - - &reftitle.description; - - public static voidSwoole\Async::readFile - stringfilename - callablecallback - - - - - - - - - &reftitle.parameters; - - - filename - - - The filename of the file being read. - - - - - callback - - - mixedcallback - stringfilename - stringcontent - - - - filename - - - The name of the file. - - - - - content - - - The content read from the file. - - - - - - - - - - - - diff --git a/reference/swoole/swoole/async/set.xml b/reference/swoole/swoole/async/set.xml deleted file mode 100644 index a957827c811f..000000000000 --- a/reference/swoole/swoole/async/set.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Async::set - Update the async I/O options. - - - - &reftitle.description; - - public static voidSwoole\Async::set - arraysettings - - - - - - - - - &reftitle.parameters; - - - settings - - - - - - - - - - - - diff --git a/reference/swoole/swoole/async/write.xml b/reference/swoole/swoole/async/write.xml deleted file mode 100644 index 55fe480445e8..000000000000 --- a/reference/swoole/swoole/async/write.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - Swoole\Async::write - Write data to a file stream asynchronously. - - - - &reftitle.description; - - public static voidSwoole\Async::write - stringfilename - stringcontent - intoffset - callablecallback - - - - - - - - - &reftitle.parameters; - - - filename - - - The filename being written. - - - - - content - - - The content writing to the file. - - - - - offset - - - The offset. - - - - - callback - - - - - - - - - - - - diff --git a/reference/swoole/swoole/async/writefile.xml b/reference/swoole/swoole/async/writefile.xml deleted file mode 100644 index a6ffa74a2742..000000000000 --- a/reference/swoole/swoole/async/writefile.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - Swoole\Async::writeFile - Description - - - - &reftitle.description; - - public static voidSwoole\Async::writeFile - stringfilename - stringcontent - callablecallback - stringflags - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - filename - - - The filename being written. - - - - - content - - - The content writing to the file. - - - - - callback - - - - - - - - flags - - - - - - - - - - - - diff --git a/reference/swoole/swoole/atomic/add.xml b/reference/swoole/swoole/atomic/add.xml deleted file mode 100644 index d43df187d19e..000000000000 --- a/reference/swoole/swoole/atomic/add.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Atomic::add - Add a number to the value to the atomic object. - - - - &reftitle.description; - - public intSwoole\Atomic::add - intadd_value - - - Add a number to the value to the atomic object. - - - - - - &reftitle.parameters; - - - add_value - - - The value which will be added to the current value. - - - - - - - - &reftitle.returnvalues; - - The new value of the atomic object. - - - - - - - diff --git a/reference/swoole/swoole/atomic/cmpset.xml b/reference/swoole/swoole/atomic/cmpset.xml deleted file mode 100644 index 6c049d5d6c1d..000000000000 --- a/reference/swoole/swoole/atomic/cmpset.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - Swoole\Atomic::cmpset - Compare and set the value of the atomic object. - - - - &reftitle.description; - - public intSwoole\Atomic::cmpset - intcmp_value - intnew_value - - - - - - - - - &reftitle.parameters; - - - cmp_value - - - The value to compare with the current value of the atomic object. - - - - - new_value - - - The value to set to the atomic object if the cmp_value is the same as the current value of - the atomic object. - - - - - - - - &reftitle.returnvalues; - - The new value of the atomic object. - - - - - - - diff --git a/reference/swoole/swoole/atomic/construct.xml b/reference/swoole/swoole/atomic/construct.xml deleted file mode 100644 index 17e912223985..000000000000 --- a/reference/swoole/swoole/atomic/construct.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Atomic::__construct - Construct a swoole atomic object. - - - - &reftitle.description; - - public Swoole\Atomic::__construct - intvalue - - - Swoole atomic object is an integer variable allows any processor to atomically test and modify. - It is implemented based on CPU atomic instructions. The Swoole atomic variables have to - defined before swoole_server->start. - - - - Compare-and-swap (CAS) is an atomic instruction used in multithreading to achieve synchronization. - It compares the content of a memory location with a given value and, only if they are the same, - modifies the content of that memory location to a new given value. - - - - - - &reftitle.parameters; - - - value - - - The value of the atomic object. - - - - - - - - - diff --git a/reference/swoole/swoole/atomic/get.xml b/reference/swoole/swoole/atomic/get.xml deleted file mode 100644 index 35296bb50e1d..000000000000 --- a/reference/swoole/swoole/atomic/get.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Atomic::get - Get the current value of the atomic object. - - - - &reftitle.description; - - public intSwoole\Atomic::get - - - - Get the current value of the atomic object. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The current value of the atomic object. - - - - - - - diff --git a/reference/swoole/swoole/atomic/set.xml b/reference/swoole/swoole/atomic/set.xml deleted file mode 100644 index fd382748f7d2..000000000000 --- a/reference/swoole/swoole/atomic/set.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - Swoole\Atomic::set - Set a new value to the atomic object. - - - - &reftitle.description; - - public intSwoole\Atomic::set - intvalue - - - Set a new value to the atomic object. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - value - - - The value to set to the atomic object. - - - - - - - - &reftitle.returnvalues; - - The current value of the atomic object. - - - - - - - diff --git a/reference/swoole/swoole/atomic/sub.xml b/reference/swoole/swoole/atomic/sub.xml deleted file mode 100644 index 9010dc66a28a..000000000000 --- a/reference/swoole/swoole/atomic/sub.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Atomic::sub - Subtract a number to the value of the atomic object. - - - - &reftitle.description; - - public intSwoole\Atomic::sub - intsub_value - - - Subtract a number to the value of the atomic object. - - - - - - &reftitle.parameters; - - - sub_value - - - The value which will be subtracted to the current value. - - - - - - - - &reftitle.returnvalues; - - The current value of the atomic object. - - - - - - - diff --git a/reference/swoole/swoole/buffer/append.xml b/reference/swoole/swoole/buffer/append.xml deleted file mode 100644 index c988d2d3a155..000000000000 --- a/reference/swoole/swoole/buffer/append.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Buffer::append - Append the string or binary data at the end of the memory buffer and return the new size of memory allocated. - - - - &reftitle.description; - - public intSwoole\Buffer::append - stringdata - - - - - - - - - &reftitle.parameters; - - - data - - - The string or binary data to append at the end of the memory buffer. - - - - - - - - &reftitle.returnvalues; - - The new size of the memory buffer. - - - - - - - diff --git a/reference/swoole/swoole/buffer/clear.xml b/reference/swoole/swoole/buffer/clear.xml deleted file mode 100644 index 1916bbbd242e..000000000000 --- a/reference/swoole/swoole/buffer/clear.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - Swoole\Buffer::clear - Reset the memory buffer. - - - - &reftitle.description; - - public voidSwoole\Buffer::clear - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - diff --git a/reference/swoole/swoole/buffer/construct.xml b/reference/swoole/swoole/buffer/construct.xml deleted file mode 100644 index 4be5c5acc3a8..000000000000 --- a/reference/swoole/swoole/buffer/construct.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - Swoole\Buffer::__construct - Fixed size memory blocks allocation. - - - - &reftitle.description; - - public Swoole\Buffer::__construct - intsize - - - - - - - - - &reftitle.parameters; - - - size - - - The size of the memory to allocate. - - - - - - - - - - - - - diff --git a/reference/swoole/swoole/buffer/destruct.xml b/reference/swoole/swoole/buffer/destruct.xml deleted file mode 100644 index 20ff824859ae..000000000000 --- a/reference/swoole/swoole/buffer/destruct.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - Swoole\Buffer::__destruct - Destruct the Swoole memory buffer. - - - - &reftitle.description; - - public voidSwoole\Buffer::__destruct - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - diff --git a/reference/swoole/swoole/buffer/expand.xml b/reference/swoole/swoole/buffer/expand.xml deleted file mode 100644 index eaf519321c80..000000000000 --- a/reference/swoole/swoole/buffer/expand.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Buffer::expand - Expand the size of memory buffer. - - - - &reftitle.description; - - public intSwoole\Buffer::expand - intsize - - - - - - - - - &reftitle.parameters; - - - size - - - The new size of the memory buffer. - - - - - - - - &reftitle.returnvalues; - - The new size of the memory buffer. - - - - - - - diff --git a/reference/swoole/swoole/buffer/read.xml b/reference/swoole/swoole/buffer/read.xml deleted file mode 100644 index e71a1c4a4e3c..000000000000 --- a/reference/swoole/swoole/buffer/read.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Buffer::read - Read data from the memory buffer based on offset and length. - - - - &reftitle.description; - - public stringSwoole\Buffer::read - intoffset - intlength - - - - - - - - - &reftitle.parameters; - - - offset - - - The offset. - - - - - length - - - The length. - - - - - - - - &reftitle.returnvalues; - - The data read from the memory buffer. - - - - - - - diff --git a/reference/swoole/swoole/buffer/recycle.xml b/reference/swoole/swoole/buffer/recycle.xml deleted file mode 100644 index adea583fe513..000000000000 --- a/reference/swoole/swoole/buffer/recycle.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - Swoole\Buffer::recycle - Release the memory to OS which is not used by the memory buffer. - - - - &reftitle.description; - - public voidSwoole\Buffer::recycle - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - diff --git a/reference/swoole/swoole/buffer/substr.xml b/reference/swoole/swoole/buffer/substr.xml deleted file mode 100644 index 9ee5d794eeed..000000000000 --- a/reference/swoole/swoole/buffer/substr.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - Swoole\Buffer::substr - Read data from the memory buffer based on offset and length. Or remove data from the memory buffer. - - - - &reftitle.description; - - public stringSwoole\Buffer::substr - intoffset - intlength - boolremove - - - If $remove is set to be true and $offset is set to be 0, the data will be removed from the buffer. - The memory for storing the data will be released when the buffer object is deconstructed. - - - - - - &reftitle.parameters; - - - offset - - - The offset. - - - - - length - - - The length. - - - - - remove - - - Whether to remove the data from the memory buffer. - - - - - - - - &reftitle.returnvalues; - - The data or string read from the memory buffer. - - - - - - - diff --git a/reference/swoole/swoole/buffer/tostring.xml b/reference/swoole/swoole/buffer/tostring.xml deleted file mode 100644 index 5446fa179c66..000000000000 --- a/reference/swoole/swoole/buffer/tostring.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Buffer::__toString - Get the string value of the memory buffer. - - - - &reftitle.description; - - public stringSwoole\Buffer::__toString - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The string value of the memory buffer. - - - - - - - diff --git a/reference/swoole/swoole/buffer/write.xml b/reference/swoole/swoole/buffer/write.xml deleted file mode 100644 index 079b956fb8f8..000000000000 --- a/reference/swoole/swoole/buffer/write.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Buffer::write - Write data to the memory buffer. The memory allocated for the buffer will not be changed. - - - - &reftitle.description; - - public voidSwoole\Buffer::write - intoffset - stringdata - - - - - - - - - &reftitle.parameters; - - - offset - - - The offset. - - - - - data - - - The data to write to the memory buffer. - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/channel/construct.xml b/reference/swoole/swoole/channel/construct.xml deleted file mode 100644 index ba499f24cfea..000000000000 --- a/reference/swoole/swoole/channel/construct.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - Swoole\Channel::__construct - Construct a Swoole Channel - - - - &reftitle.description; - - public Swoole\Channel::__construct - stringsize - - - Swoole channel is memory data structure works like Chan in Golang, implemented based on - shared memory and mutex locks. It can be used as high performance message queue in memory. - Construct a swoole channel with a fixed size. The minimum size of a swoole channel is 64KB. - Exceptions will be thrown if there is not enough memory. - - - - - - &reftitle.parameters; - - - size - - - The size of the Swoole channel. - - - - - - - - - diff --git a/reference/swoole/swoole/channel/destruct.xml b/reference/swoole/swoole/channel/destruct.xml deleted file mode 100644 index 21f4a160e612..000000000000 --- a/reference/swoole/swoole/channel/destruct.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - Swoole\Channel::__destruct - Destruct a Swoole channel. - - - - &reftitle.description; - - public voidSwoole\Channel::__destruct - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - diff --git a/reference/swoole/swoole/channel/pop.xml b/reference/swoole/swoole/channel/pop.xml deleted file mode 100644 index c03fc5f75f67..000000000000 --- a/reference/swoole/swoole/channel/pop.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Channel::pop - Read and pop data from swoole channel. - - - - &reftitle.description; - - public mixedSwoole\Channel::pop - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - If the channel is empty, the function will return false, or return the unserialized data. - - - - - - - diff --git a/reference/swoole/swoole/channel/push.xml b/reference/swoole/swoole/channel/push.xml deleted file mode 100644 index 9c138f0d2282..000000000000 --- a/reference/swoole/swoole/channel/push.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - Swoole\Channel::push - Write and push data into Swoole channel. - - - - &reftitle.description; - - public boolSwoole\Channel::push - stringdata - - - Data can be any non-empty PHP variable, the variable will be serialized if it is not string type. - - - If size of the data is more than 8KB, swoole channel will use temp files storage. - - - The function will return true if the write operation is succeeded, or return false if there is not enough space. - - - - - - &reftitle.parameters; - - - data - - - The data to push into the Swoole channel. - - - - - - - - &reftitle.returnvalues; - - Whether the data is pushed into the Swoole channel. - - - - - - - diff --git a/reference/swoole/swoole/channel/stats.xml b/reference/swoole/swoole/channel/stats.xml deleted file mode 100644 index 54dd7f4a2b25..000000000000 --- a/reference/swoole/swoole/channel/stats.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Swoole\Channel::stats - Get stats of swoole channel. - - - - &reftitle.description; - - public arraySwoole\Channel::stats - - - - Get the numbers of queued elements and total size of the memory used by the queue. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The stats of the Swoole channel. - - - - - - diff --git a/reference/swoole/swoole/client/close.xml b/reference/swoole/swoole/client/close.xml deleted file mode 100644 index 5f891d4fe572..000000000000 --- a/reference/swoole/swoole/client/close.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Client::close - Close the connection established. - - - - &reftitle.description; - - public boolSwoole\Client::close - boolforce - - - - - - - - - &reftitle.parameters; - - - force - - - Whether force to close the connection. - - - - - - - - &reftitle.returnvalues; - - Whether the connection is closed. - - - - - - - diff --git a/reference/swoole/swoole/client/connect.xml b/reference/swoole/swoole/client/connect.xml deleted file mode 100644 index 8314fb134c56..000000000000 --- a/reference/swoole/swoole/client/connect.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - Swoole\Client::connect - Connect to the remote TCP or UDP port. - - - - &reftitle.description; - - public boolSwoole\Client::connect - stringhost - intport - inttimeout - intflag - - - - - - - - - &reftitle.parameters; - - - host - - - The host name of the remote address. - - - - - port - - - The port number of the remote address. - - - - - timeout - - - The timeout(second) of connect/send/recv, the default value is 0.1s - - - - - flag - - - If the type of client is UDP, the $flag means if to enable the configuration udp_connect. - If the configuration udp_connect is enabled, the client will only receive the data from specified ip:port. - If the type of client is TCP and the $flag is set to 1, it must use swoole_client_select to check the connection status before send/recv. - - - - - - - - &reftitle.returnvalues; - - Whether the connection is established. - - - - - - - diff --git a/reference/swoole/swoole/client/construct.xml b/reference/swoole/swoole/client/construct.xml deleted file mode 100644 index b0e0e488ae34..000000000000 --- a/reference/swoole/swoole/client/construct.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - Swoole\Client::__construct - Create Swoole sync or async TCP/UDP client, with or without SSL. - - - - &reftitle.description; - - public Swoole\Client::__construct - intsock_type - intis_async - - - - - - - - - &reftitle.parameters; - - - sock_type - - - The type of socket: SWOOLE_TCP, SWOOLE_UDP, SWOOLE_ASYNC, SWOOLE_SSL, SWOOLE_KEEP. - - - - - is_async - - - Synchronous or asynchronous client. - - - - - - - - - diff --git a/reference/swoole/swoole/client/destruct.xml b/reference/swoole/swoole/client/destruct.xml deleted file mode 100644 index 2600d6685b8b..000000000000 --- a/reference/swoole/swoole/client/destruct.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - Swoole\Client::__destruct - Destruct the Swoole client. - - - - &reftitle.description; - - public voidSwoole\Client::__destruct - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/swoole/swoole/client/getpeername.xml b/reference/swoole/swoole/client/getpeername.xml deleted file mode 100644 index 6847cbbfd4e7..000000000000 --- a/reference/swoole/swoole/client/getpeername.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Client::getpeername - Get the remote socket name of the connection. - - - - &reftitle.description; - - public arraySwoole\Client::getpeername - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The host and port of the remote socket. - - - - - - - diff --git a/reference/swoole/swoole/client/getsockname.xml b/reference/swoole/swoole/client/getsockname.xml deleted file mode 100644 index f355b5c6f3af..000000000000 --- a/reference/swoole/swoole/client/getsockname.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Client::getsockname - Get the local socket name of the connection. - - - - &reftitle.description; - - public arraySwoole\Client::getsockname - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The host and port of the local socket. - - - - - - - diff --git a/reference/swoole/swoole/client/isconnected.xml b/reference/swoole/swoole/client/isconnected.xml deleted file mode 100644 index 4b540f64709d..000000000000 --- a/reference/swoole/swoole/client/isconnected.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Client::isConnected - Check if the connection is established. - - - - &reftitle.description; - - public boolSwoole\Client::isConnected - - - - This method returns the connection status of application layer. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Whether the connection is established. - - - - - - - diff --git a/reference/swoole/swoole/client/on.xml b/reference/swoole/swoole/client/on.xml deleted file mode 100644 index 3f4ab783fd67..000000000000 --- a/reference/swoole/swoole/client/on.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - Swoole\Client::on - Add callback functions triggered by events. - - - - &reftitle.description; - - public voidSwoole\Client::on - stringevent - callablecallback - - - - - - - - - &reftitle.parameters; - - - event - - - - - - - - callback - - - - - - - - - - - - - diff --git a/reference/swoole/swoole/client/pause.xml b/reference/swoole/swoole/client/pause.xml deleted file mode 100644 index f8dc96cc4adb..000000000000 --- a/reference/swoole/swoole/client/pause.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - Swoole\Client::pause - Pause receiving data. - - - - &reftitle.description; - - public voidSwoole\Client::pause - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - diff --git a/reference/swoole/swoole/client/pipe.xml b/reference/swoole/swoole/client/pipe.xml deleted file mode 100644 index fbac59e5d5ca..000000000000 --- a/reference/swoole/swoole/client/pipe.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Client::pipe - Redirect the data to another file descriptor. - - - - &reftitle.description; - - public voidSwoole\Client::pipe - stringsocket - - - - - - - - - &reftitle.parameters; - - - socket - - - - - - - - - - - - diff --git a/reference/swoole/swoole/client/recv.xml b/reference/swoole/swoole/client/recv.xml deleted file mode 100644 index eb50f9fe4d79..000000000000 --- a/reference/swoole/swoole/client/recv.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - Swoole\Client::recv - Receive data from the remote socket. - - - - &reftitle.description; - - public voidSwoole\Client::recv - stringsize - stringflag - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - size - - - - - - - - flag - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/client/resume.xml b/reference/swoole/swoole/client/resume.xml deleted file mode 100644 index 754603ced1da..000000000000 --- a/reference/swoole/swoole/client/resume.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - Swoole\Client::resume - Resume receiving data. - - - - &reftitle.description; - - public voidSwoole\Client::resume - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - diff --git a/reference/swoole/swoole/client/send.xml b/reference/swoole/swoole/client/send.xml deleted file mode 100644 index 23f8ff965b4f..000000000000 --- a/reference/swoole/swoole/client/send.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - Swoole\Client::send - Send data to the remote TCP socket. - - - - &reftitle.description; - - public intSwoole\Client::send - stringdata - stringflag - - - - - - - - - &reftitle.parameters; - - - data - - - The data to send which can be string or binary - - - - - flag - - - - - - - - - - - &reftitle.returnvalues; - - If the client sends data successfully, it returns the length of data sent. - Or it returns false and sets $swoole_client->errCode. For sync client, - there is no limit for the data to send. For async client, The limit - for the data to send is socket_buffer_size. - - - - - - - diff --git a/reference/swoole/swoole/client/sendfile.xml b/reference/swoole/swoole/client/sendfile.xml deleted file mode 100644 index 443e92a1d30b..000000000000 --- a/reference/swoole/swoole/client/sendfile.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Client::sendfile - Send file to the remote TCP socket. - - - - &reftitle.description; - - public boolSwoole\Client::sendfile - stringfilename - intoffset - - - This is a wrapper of the Linux sendfile system call. - - - - - - &reftitle.parameters; - - - filename - - - File path of the file to send. - - - - - offset - - - Offset of the file to send - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/client/sendto.xml b/reference/swoole/swoole/client/sendto.xml deleted file mode 100644 index bdae8d809803..000000000000 --- a/reference/swoole/swoole/client/sendto.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - Swoole\Client::sendto - Send data to the remote UDP address. - - - - &reftitle.description; - - public boolSwoole\Client::sendto - stringip - intport - stringdata - - - The swoole client should be type of SWOOLE_SOCK_UDP or SWOOLE_SOCK_UDP6. - - - - - - &reftitle.parameters; - - - ip - - - The IP address of remote host, IPv4 or IPv6. - - - - - port - - - The port number of remote host. - - - - - data - - - The data to send which should be less-than 64K. - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/client/set.xml b/reference/swoole/swoole/client/set.xml deleted file mode 100644 index a29f79589034..000000000000 --- a/reference/swoole/swoole/client/set.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Client::set - Set the Swoole client parameters before the connection is established. - - - - &reftitle.description; - - public voidSwoole\Client::set - arraysettings - - - - - - - - - &reftitle.parameters; - - - settings - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/client/sleep.xml b/reference/swoole/swoole/client/sleep.xml deleted file mode 100644 index 7293c366215f..000000000000 --- a/reference/swoole/swoole/client/sleep.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Client::sleep - Remove the TCP client from system event loop. - - - - &reftitle.description; - - public voidSwoole\Client::sleep - - - - Remove the TCP client from system event loop. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/client/wakeup.xml b/reference/swoole/swoole/client/wakeup.xml deleted file mode 100644 index 0f91227b5ad4..000000000000 --- a/reference/swoole/swoole/client/wakeup.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Client::wakeup - Add the TCP client back into the system event loop. - - - - &reftitle.description; - - public voidSwoole\Client::wakeup - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/connection/iterator/count.xml b/reference/swoole/swoole/connection/iterator/count.xml deleted file mode 100644 index ffe6f1d44889..000000000000 --- a/reference/swoole/swoole/connection/iterator/count.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Connection\Iterator::count - Count connections. - - - - &reftitle.description; - - public intSwoole\Connection\Iterator::count - - - - Gets the number of connections. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The number of connections. - - - - - - - diff --git a/reference/swoole/swoole/connection/iterator/current.xml b/reference/swoole/swoole/connection/iterator/current.xml deleted file mode 100644 index 52666a6c741c..000000000000 --- a/reference/swoole/swoole/connection/iterator/current.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Connection\Iterator::current - Return current connection entry. - - - - &reftitle.description; - - public ConnectionSwoole\Connection\Iterator::current - - - - Get current connection entry. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The current connection entry. - - - - - - - diff --git a/reference/swoole/swoole/connection/iterator/key.xml b/reference/swoole/swoole/connection/iterator/key.xml deleted file mode 100644 index bbda357d4621..000000000000 --- a/reference/swoole/swoole/connection/iterator/key.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Connection\Iterator::key - Return key of the current connection. - - - - &reftitle.description; - - public intSwoole\Connection\Iterator::key - - - - This function returns key of the current connection. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Key of the current connection. - - - - - - - diff --git a/reference/swoole/swoole/connection/iterator/next.xml b/reference/swoole/swoole/connection/iterator/next.xml deleted file mode 100644 index 3a03ed7469dc..000000000000 --- a/reference/swoole/swoole/connection/iterator/next.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Connection\Iterator::next - Move to the next connection. - - - - &reftitle.description; - - public ConnectionSwoole\Connection\Iterator::next - - - - The iterator to the next connection. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/connection/iterator/offsetexists.xml b/reference/swoole/swoole/connection/iterator/offsetexists.xml deleted file mode 100644 index 8694305dc3a0..000000000000 --- a/reference/swoole/swoole/connection/iterator/offsetexists.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Connection\Iterator::offsetExists - Check if offset exists. - - - - &reftitle.description; - - public boolSwoole\Connection\Iterator::offsetExists - intindex - - - Check if offset exists. - - - - - - &reftitle.parameters; - - - index - - - The offset being checked. - - - - - - - - &reftitle.returnvalues; - - Returns TRUE if the offset exists, otherwise FALSE. - - - - - - - diff --git a/reference/swoole/swoole/connection/iterator/offsetget.xml b/reference/swoole/swoole/connection/iterator/offsetget.xml deleted file mode 100644 index c9e0e775adb5..000000000000 --- a/reference/swoole/swoole/connection/iterator/offsetget.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Connection\Iterator::offsetGet - Offset to retrieve. - - - - &reftitle.description; - - public ConnectionSwoole\Connection\Iterator::offsetGet - stringindex - - - Return the connection at specified offset. - - - - - - &reftitle.parameters; - - - index - - - The offset to retrieve. - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/connection/iterator/offsetset.xml b/reference/swoole/swoole/connection/iterator/offsetset.xml deleted file mode 100644 index 2360a0210aa6..000000000000 --- a/reference/swoole/swoole/connection/iterator/offsetset.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Connection\Iterator::offsetSet - Assign a Connection to the specified offset. - - - - &reftitle.description; - - public voidSwoole\Connection\Iterator::offsetSet - intoffset - mixedconnection - - - Assign a Connection to the specified offset. - - - - - - &reftitle.parameters; - - - offset - - - The offset to assign the Connection to. - - - - - connection - - - The connection to set. - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/connection/iterator/offsetunset.xml b/reference/swoole/swoole/connection/iterator/offsetunset.xml deleted file mode 100644 index 5044c639fd8e..000000000000 --- a/reference/swoole/swoole/connection/iterator/offsetunset.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Connection\Iterator::offsetUnset - Unset an offset. - - - - &reftitle.description; - - public voidSwoole\Connection\Iterator::offsetUnset - intoffset - - - Unsets an offset. - - - - - - &reftitle.parameters; - - - offset - - - The offset to unset. - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/connection/iterator/rewind.xml b/reference/swoole/swoole/connection/iterator/rewind.xml deleted file mode 100644 index da56660d4e29..000000000000 --- a/reference/swoole/swoole/connection/iterator/rewind.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Connection\Iterator::rewind - Rewinds iterator - - - - &reftitle.description; - - public voidSwoole\Connection\Iterator::rewind - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/connection/iterator/valid.xml b/reference/swoole/swoole/connection/iterator/valid.xml deleted file mode 100644 index f4214f05fe8b..000000000000 --- a/reference/swoole/swoole/connection/iterator/valid.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Connection\Iterator::valid - Check if current position is valid. - - - - &reftitle.description; - - public boolSwoole\Connection\Iterator::valid - - - - Checks if the current position is valid. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns TRUE if the current iterator position is valid, otherwise FALSE. - - - - - - - diff --git a/reference/swoole/swoole/coroutine/call-user-func-array.xml b/reference/swoole/swoole/coroutine/call-user-func-array.xml deleted file mode 100644 index 1dc446bd7c3d..000000000000 --- a/reference/swoole/swoole/coroutine/call-user-func-array.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - Swoole\Coroutine::call_user_func_array - Call a callback with an array of parameters - - - - &reftitle.description; - - public static mixedSwoole\Coroutine::call_user_func_array - callablecallback - arrayparam_array - - - Calls the callback given by the first parameter with the parameters in param_array. - - - - - - &reftitle.parameters; - - - - callback - - - The callable to be called. - - - - - param_array - - - Zero or more parameters in the array to be passed to the callback. - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/call-user-func.xml b/reference/swoole/swoole/coroutine/call-user-func.xml deleted file mode 100644 index 5f08c1e166c6..000000000000 --- a/reference/swoole/swoole/coroutine/call-user-func.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - Swoole\Coroutine::call_user_func - Call a callback given by the first parameter - - - - &reftitle.description; - - public static mixedSwoole\Coroutine::call_user_func - callablecallback - mixedargs - - - Calls the callback given by the first parameter and passes the remaining parameters as arguments. - - - - - - &reftitle.parameters; - - - - callback - - - The callable to be called. - - - - - args - - - Zero or more parameters to be passed to the callback. - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/cli-wait.xml b/reference/swoole/swoole/coroutine/cli-wait.xml deleted file mode 100644 index 8cb6bcfbe876..000000000000 --- a/reference/swoole/swoole/coroutine/cli-wait.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Coroutine::cli_wait - Description - - - - &reftitle.description; - - public static ReturnTypeSwoole\Coroutine::cli_wait - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/client/close.xml b/reference/swoole/swoole/coroutine/client/close.xml deleted file mode 100644 index 5a1ada9486fe..000000000000 --- a/reference/swoole/swoole/coroutine/client/close.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\Client::close - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Client::close - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/client/connect.xml b/reference/swoole/swoole/coroutine/client/connect.xml deleted file mode 100644 index deafe772fc64..000000000000 --- a/reference/swoole/swoole/coroutine/client/connect.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\Client::connect - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Client::connect - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/client/construct.xml b/reference/swoole/swoole/coroutine/client/construct.xml deleted file mode 100644 index 59ed5922d09c..000000000000 --- a/reference/swoole/swoole/coroutine/client/construct.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - Swoole\Coroutine\Client::__construct - Description - - - - &reftitle.description; - - public Swoole\Coroutine\Client::__construct - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/client/destruct.xml b/reference/swoole/swoole/coroutine/client/destruct.xml deleted file mode 100644 index 4aacebd98f43..000000000000 --- a/reference/swoole/swoole/coroutine/client/destruct.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\Client::__destruct - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Client::__destruct - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/client/getpeername.xml b/reference/swoole/swoole/coroutine/client/getpeername.xml deleted file mode 100644 index 7323a07275fa..000000000000 --- a/reference/swoole/swoole/coroutine/client/getpeername.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\Client::getpeername - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Client::getpeername - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/client/getsockname.xml b/reference/swoole/swoole/coroutine/client/getsockname.xml deleted file mode 100644 index f43a0f862c34..000000000000 --- a/reference/swoole/swoole/coroutine/client/getsockname.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\Client::getsockname - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Client::getsockname - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/client/isconnected.xml b/reference/swoole/swoole/coroutine/client/isconnected.xml deleted file mode 100644 index 87ec1bbeb3e6..000000000000 --- a/reference/swoole/swoole/coroutine/client/isconnected.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\Client::isConnected - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Client::isConnected - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/client/recv.xml b/reference/swoole/swoole/coroutine/client/recv.xml deleted file mode 100644 index f16510b1635b..000000000000 --- a/reference/swoole/swoole/coroutine/client/recv.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\Client::recv - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Client::recv - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/client/send.xml b/reference/swoole/swoole/coroutine/client/send.xml deleted file mode 100644 index 96399466d323..000000000000 --- a/reference/swoole/swoole/coroutine/client/send.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\Client::send - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Client::send - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/client/sendfile.xml b/reference/swoole/swoole/coroutine/client/sendfile.xml deleted file mode 100644 index c710f6b7b100..000000000000 --- a/reference/swoole/swoole/coroutine/client/sendfile.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\Client::sendfile - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Client::sendfile - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/client/sendto.xml b/reference/swoole/swoole/coroutine/client/sendto.xml deleted file mode 100644 index 64e054053123..000000000000 --- a/reference/swoole/swoole/coroutine/client/sendto.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\Client::sendto - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Client::sendto - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/client/set.xml b/reference/swoole/swoole/coroutine/client/set.xml deleted file mode 100644 index 004612698e26..000000000000 --- a/reference/swoole/swoole/coroutine/client/set.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\Client::set - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Client::set - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/create.xml b/reference/swoole/swoole/coroutine/create.xml deleted file mode 100644 index 6f75d390b4a1..000000000000 --- a/reference/swoole/swoole/coroutine/create.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine::create - Description - - - - &reftitle.description; - - public static ReturnTypeSwoole\Coroutine::create - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/getuid.xml b/reference/swoole/swoole/coroutine/getuid.xml deleted file mode 100644 index 8a9df0c530a6..000000000000 --- a/reference/swoole/swoole/coroutine/getuid.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine::getuid - Description - - - - &reftitle.description; - - public static ReturnTypeSwoole\Coroutine::getuid - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/http/client/addfile.xml b/reference/swoole/swoole/coroutine/http/client/addfile.xml deleted file mode 100644 index f34131bc4196..000000000000 --- a/reference/swoole/swoole/coroutine/http/client/addfile.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\Http\Client::addFile - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Http\Client::addFile - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/http/client/close.xml b/reference/swoole/swoole/coroutine/http/client/close.xml deleted file mode 100644 index 479b7a96b738..000000000000 --- a/reference/swoole/swoole/coroutine/http/client/close.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\Http\Client::close - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Http\Client::close - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/http/client/construct.xml b/reference/swoole/swoole/coroutine/http/client/construct.xml deleted file mode 100644 index aa2562144e0a..000000000000 --- a/reference/swoole/swoole/coroutine/http/client/construct.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - Swoole\Coroutine\Http\Client::__construct - Description - - - - &reftitle.description; - - public Swoole\Coroutine\Http\Client::__construct - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/http/client/destruct.xml b/reference/swoole/swoole/coroutine/http/client/destruct.xml deleted file mode 100644 index 12642ae666f8..000000000000 --- a/reference/swoole/swoole/coroutine/http/client/destruct.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\Http\Client::__destruct - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Http\Client::__destruct - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/http/client/execute.xml b/reference/swoole/swoole/coroutine/http/client/execute.xml deleted file mode 100644 index 8d087ff76dd7..000000000000 --- a/reference/swoole/swoole/coroutine/http/client/execute.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\Http\Client::execute - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Http\Client::execute - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/http/client/get.xml b/reference/swoole/swoole/coroutine/http/client/get.xml deleted file mode 100644 index 9ad386027b53..000000000000 --- a/reference/swoole/swoole/coroutine/http/client/get.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\Http\Client::get - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Http\Client::get - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/http/client/getdefer.xml b/reference/swoole/swoole/coroutine/http/client/getdefer.xml deleted file mode 100644 index 3747a68cd713..000000000000 --- a/reference/swoole/swoole/coroutine/http/client/getdefer.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\Http\Client::getDefer - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Http\Client::getDefer - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/http/client/isconnected.xml b/reference/swoole/swoole/coroutine/http/client/isconnected.xml deleted file mode 100644 index aa1ae0ea4ea6..000000000000 --- a/reference/swoole/swoole/coroutine/http/client/isconnected.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\Http\Client::isConnected - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Http\Client::isConnected - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/http/client/post.xml b/reference/swoole/swoole/coroutine/http/client/post.xml deleted file mode 100644 index 299361c848e3..000000000000 --- a/reference/swoole/swoole/coroutine/http/client/post.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\Http\Client::post - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Http\Client::post - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/http/client/recv.xml b/reference/swoole/swoole/coroutine/http/client/recv.xml deleted file mode 100644 index 2f12fda196bb..000000000000 --- a/reference/swoole/swoole/coroutine/http/client/recv.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\Http\Client::recv - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Http\Client::recv - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/http/client/set.xml b/reference/swoole/swoole/coroutine/http/client/set.xml deleted file mode 100644 index 5c9008b1e410..000000000000 --- a/reference/swoole/swoole/coroutine/http/client/set.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\Http\Client::set - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Http\Client::set - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/http/client/setcookies.xml b/reference/swoole/swoole/coroutine/http/client/setcookies.xml deleted file mode 100644 index e9bb618d3342..000000000000 --- a/reference/swoole/swoole/coroutine/http/client/setcookies.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\Http\Client::setCookies - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Http\Client::setCookies - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/http/client/setdata.xml b/reference/swoole/swoole/coroutine/http/client/setdata.xml deleted file mode 100644 index 8abf1e581593..000000000000 --- a/reference/swoole/swoole/coroutine/http/client/setdata.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\Http\Client::setData - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Http\Client::setData - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/http/client/setdefer.xml b/reference/swoole/swoole/coroutine/http/client/setdefer.xml deleted file mode 100644 index 2bdf5e4fed24..000000000000 --- a/reference/swoole/swoole/coroutine/http/client/setdefer.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\Http\Client::setDefer - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Http\Client::setDefer - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/http/client/setheaders.xml b/reference/swoole/swoole/coroutine/http/client/setheaders.xml deleted file mode 100644 index cf9a464abe0d..000000000000 --- a/reference/swoole/swoole/coroutine/http/client/setheaders.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\Http\Client::setHeaders - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Http\Client::setHeaders - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/http/client/setmethod.xml b/reference/swoole/swoole/coroutine/http/client/setmethod.xml deleted file mode 100644 index fa63f7497da8..000000000000 --- a/reference/swoole/swoole/coroutine/http/client/setmethod.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\Http\Client::setMethod - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Http\Client::setMethod - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/lock/construct.xml b/reference/swoole/swoole/coroutine/lock/construct.xml deleted file mode 100644 index 384163b7afc8..000000000000 --- a/reference/swoole/swoole/coroutine/lock/construct.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - Swoole\Coroutine\Lock::__construct - Construct a new coroutine lock - - - - &reftitle.description; - - public voidSwoole\Coroutine\Lock::__construct - - - - Create a new coroutine lock instance. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/swoole/swoole/coroutine/lock/lock.xml b/reference/swoole/swoole/coroutine/lock/lock.xml deleted file mode 100644 index 8983fb79ccb8..000000000000 --- a/reference/swoole/swoole/coroutine/lock/lock.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Coroutine\Lock::lock - Acquire the lock, blocking if necessary - - - - &reftitle.description; - - public boolSwoole\Coroutine\Lock::lock - - - - When executing the lock operation, if the lock is already held by another coroutine, - the current coroutine will actively yield CPU control and enter a suspended state. - When the coroutine holding the lock calls unlock(), the waiting coroutine will be - awakened and try to acquire the lock again. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; if the lock was acquired successfully, - &false; otherwise. - - - - - diff --git a/reference/swoole/swoole/coroutine/lock/trylock.xml b/reference/swoole/swoole/coroutine/lock/trylock.xml deleted file mode 100644 index f9faa0deb5ec..000000000000 --- a/reference/swoole/swoole/coroutine/lock/trylock.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Coroutine\Lock::trylock - Attempt to acquire the lock without blocking - - - - &reftitle.description; - - public boolSwoole\Coroutine\Lock::trylock - - - - When calling the lock operation, if the lock is already held by another coroutine, - the function will immediately return false without suspending the current coroutine - or yielding CPU control. This non-blocking design allows the caller to flexibly - handle contention situations, such as retrying, giving up, or executing other logic. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; if the lock was acquired successfully, - &false; if the lock is not available. - - - - - diff --git a/reference/swoole/swoole/coroutine/lock/unlock.xml b/reference/swoole/swoole/coroutine/lock/unlock.xml deleted file mode 100644 index ce1d7530a520..000000000000 --- a/reference/swoole/swoole/coroutine/lock/unlock.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - Swoole\Coroutine\Lock::unlock - Release the lock - - - - &reftitle.description; - - public boolSwoole\Coroutine\Lock::unlock - - - - - - Unlock Behavior - - - - With io_uring futex: the system will precisely wake up one coroutine in the waiting queue. - - - - - Without io_uring futex: waiting coroutines need to wait for their backoff time to end - and compete to reacquire the lock. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; if the lock was released successfully, - &false; otherwise. - - - - - diff --git a/reference/swoole/swoole/coroutine/mysql/close.xml b/reference/swoole/swoole/coroutine/mysql/close.xml deleted file mode 100644 index 9b8438a1c693..000000000000 --- a/reference/swoole/swoole/coroutine/mysql/close.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\MySQL::close - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\MySQL::close - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/mysql/connect.xml b/reference/swoole/swoole/coroutine/mysql/connect.xml deleted file mode 100644 index 58af4b813696..000000000000 --- a/reference/swoole/swoole/coroutine/mysql/connect.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\MySQL::connect - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\MySQL::connect - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/mysql/construct.xml b/reference/swoole/swoole/coroutine/mysql/construct.xml deleted file mode 100644 index 3a71cc450244..000000000000 --- a/reference/swoole/swoole/coroutine/mysql/construct.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - Swoole\Coroutine\MySQL::__construct - Description - - - - &reftitle.description; - - public Swoole\Coroutine\MySQL::__construct - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/mysql/destruct.xml b/reference/swoole/swoole/coroutine/mysql/destruct.xml deleted file mode 100644 index c4163014f7f5..000000000000 --- a/reference/swoole/swoole/coroutine/mysql/destruct.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\MySQL::__destruct - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\MySQL::__destruct - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/mysql/getdefer.xml b/reference/swoole/swoole/coroutine/mysql/getdefer.xml deleted file mode 100644 index 718bdee2175b..000000000000 --- a/reference/swoole/swoole/coroutine/mysql/getdefer.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\MySQL::getDefer - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\MySQL::getDefer - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/mysql/query.xml b/reference/swoole/swoole/coroutine/mysql/query.xml deleted file mode 100644 index f834252b7d41..000000000000 --- a/reference/swoole/swoole/coroutine/mysql/query.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\MySQL::query - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\MySQL::query - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/mysql/recv.xml b/reference/swoole/swoole/coroutine/mysql/recv.xml deleted file mode 100644 index 5e866f42c653..000000000000 --- a/reference/swoole/swoole/coroutine/mysql/recv.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\MySQL::recv - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\MySQL::recv - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/mysql/setdefer.xml b/reference/swoole/swoole/coroutine/mysql/setdefer.xml deleted file mode 100644 index 0b78b8342d72..000000000000 --- a/reference/swoole/swoole/coroutine/mysql/setdefer.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine\MySQL::setDefer - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\MySQL::setDefer - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/resume.xml b/reference/swoole/swoole/coroutine/resume.xml deleted file mode 100644 index f2ef935c6fff..000000000000 --- a/reference/swoole/swoole/coroutine/resume.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine::resume - Description - - - - &reftitle.description; - - public static ReturnTypeSwoole\Coroutine::resume - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/suspend.xml b/reference/swoole/swoole/coroutine/suspend.xml deleted file mode 100644 index 2bb1b3d1de69..000000000000 --- a/reference/swoole/swoole/coroutine/suspend.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Coroutine::suspend - Description - - - - &reftitle.description; - - public static ReturnTypeSwoole\Coroutine::suspend - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/event/add.xml b/reference/swoole/swoole/event/add.xml deleted file mode 100644 index 83266378730e..000000000000 --- a/reference/swoole/swoole/event/add.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - Swoole\Event::add - Add a socket to the underlying reactor event listener - - - - &reftitle.description; - - public static boolSwoole\Event::add - mixedsock - callableread_callback - callablewrite_callback - intflags - - - Adds a socket to the underlying reactor event listener. This function can be used in both Server and Client modes. - - - - A socket that has already been added cannot be added again. Use swoole_event_set to - modify the corresponding callback functions and event types for the socket. - - - - - - &reftitle.parameters; - - - sock - - - File descriptor, stream resource, sockets resource, or object. - - - - - read_callback - - - Callback function for readable events. - - - - - write_callback - - - Callback function for writable events. - - - - - flags - - - Event type mask (e.g. SWOOLE_EVENT_READ, SWOOLE_EVENT_WRITE - or SWOOLE_EVENT_READ | SWOOLE_EVENT_WRITE). - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - <function>Swoole\Event::add</function> example - - -]]> - - - - - - - diff --git a/reference/swoole/swoole/event/cycle.xml b/reference/swoole/swoole/event/cycle.xml deleted file mode 100644 index ca4f2ab3c917..000000000000 --- a/reference/swoole/swoole/event/cycle.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - Swoole\Event::cycle - Define a function to execute at the end of each event loop iteration - - - - &reftitle.description; - - public static boolSwoole\Event::cycle - callablecallback - boolbeforefalse - - - Defines a callback function to execute at the end (or beginning, if before is true) of each event loop iteration. - - - - - &reftitle.parameters; - - - callback - - - The function to execute. Set to null to clear a previously set cycle function. - - - - - before - - - If true, the callback executes before the event loop; if false, after. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Basic usage - - - - - - - - - diff --git a/reference/swoole/swoole/event/defer.xml b/reference/swoole/swoole/event/defer.xml deleted file mode 100644 index 0ab5beadaf98..000000000000 --- a/reference/swoole/swoole/event/defer.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - Swoole\Event::defer - Execute a function at the start of the next event loop - - - - &reftitle.description; - - public static voidSwoole\Event::defer - callablecallback_function - - - Schedules a function to run at the start of the next event loop iteration. - - - - - &reftitle.parameters; - - - callback_function - - - Callback function to execute (no parameters allowed; use use for closure variables). - - - - - - - - &reftitle.returnvalues; - - No return value. - - - - - &reftitle.examples; - - - <function>Swoole\Event::defer</function> example - - -]]> - - - - - - - diff --git a/reference/swoole/swoole/event/del.xml b/reference/swoole/swoole/event/del.xml deleted file mode 100644 index b28270bc6a41..000000000000 --- a/reference/swoole/swoole/event/del.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - Swoole\Event::del - Remove a socket from reactor event listener - - - - &reftitle.description; - - public static boolSwoole\Event::del - mixedsock - - - Removes a socket from the reactor event listener. - - - - Always call Event::del to unregister event monitoring prior to closing the socket. - Failure to do so can result in memory leaks. - - - - - - &reftitle.parameters; - - - sock - - - Socket file descriptor to remove. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/swoole/swoole/event/dispatch.xml b/reference/swoole/swoole/event/dispatch.xml deleted file mode 100644 index 522473db2977..000000000000 --- a/reference/swoole/swoole/event/dispatch.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - Swoole\Event::dispatch - Perform a single event loop iteration - - - - &reftitle.description; - - public static voidSwoole\Event::dispatch - - - - The purpose of this function is to maintain compatibility with some frameworks. - When a framework internally manages its own reactor loop, using Event::wait would allow - Swoole's underlying layer to retain control, preventing the framework from taking over execution. - - - - - &reftitle.returnvalues; - - No return value. - - - - - &reftitle.examples; - - - Manual event loop control - - - - - - - - - diff --git a/reference/swoole/swoole/event/isset.xml b/reference/swoole/swoole/event/isset.xml deleted file mode 100644 index b7faf3f4d573..000000000000 --- a/reference/swoole/swoole/event/isset.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - Swoole\Event::isset - Check if a socket is being monitored in the event loop - - - - &reftitle.description; - - public static boolSwoole\Event::isset - mixedfd - intevents - - SWOOLE_EVENT_READ | SWOOLE_EVENT_WRITE - - - - - Checks whether the specified file descriptor is being monitored for the given event types in the event loop. - - - - - &reftitle.parameters; - - - fd - - - File descriptor (stream/socket resource, integer, or object). - - - - - events - - - Event types to check (bitmask of SWOOLE_EVENT_READ and/or SWOOLE_EVENT_WRITE). - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Checking event monitoring status - - - - - - - - - diff --git a/reference/swoole/swoole/event/set.xml b/reference/swoole/swoole/event/set.xml deleted file mode 100644 index abd5e344ba82..000000000000 --- a/reference/swoole/swoole/event/set.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - Swoole\Event::set - Modify event listener callbacks and mask - - - - &reftitle.description; - - public static boolSwoole\Event::set - mixedsock - callableread_callback - callablewrite_callback - intflags - - - Modifies the event listener callbacks and mask for the given file descriptor. - - - - When $read_callback is not null, the readable event callback function will be modified to the specified function. - - - - - When $write_callback is not null, the writable event callback function will be updated to the specified function. - - - - - Setting SWOOLE_EVENT_READ alone disables write event listening, - while setting SWOOLE_EVENT_WRITE alone disables read event listening. - - - - - Swoole\Event::set replaces callbacks but does not free them. - Specifying null for callbacks (e.g., read_callback/write_callback) - preserves the existing callbacks instead of clearing them. - - - - - Listening for SWOOLE_EVENT_READ without a read_callback (or SWOOLE_EVENT_WRITE without a write_callback) - will cause the operation to fail and return false. - - - - - - &reftitle.parameters; - - - sock - - - File descriptor, stream resource, sockets resource, or object. - - - - - read_callback - - - Callback function for readable events. - - - - - write_callback - - - Callback function for writable events. - - - - - flags - - - Event type mask (e.g. SWOOLE_EVENT_READ, SWOOLE_EVENT_WRITE - or SWOOLE_EVENT_READ | SWOOLE_EVENT_WRITE). - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/swoole/swoole/event/wait.xml b/reference/swoole/swoole/event/wait.xml deleted file mode 100644 index 4993e0b088c4..000000000000 --- a/reference/swoole/swoole/event/wait.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - Swoole\Event::wait - Start event loop - - - - &reftitle.description; - - public static voidSwoole\Event::wait - - - - Starts the event loop. Place this at the end of your PHP program. - - - - - &reftitle.returnvalues; - - No return value. - - - - - &reftitle.examples; - - - <function>Swoole\Event::wait</function> example - - -]]> - - - - - - - diff --git a/reference/swoole/swoole/event/write.xml b/reference/swoole/swoole/event/write.xml deleted file mode 100644 index 2bb01443cbf0..000000000000 --- a/reference/swoole/swoole/event/write.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - Swoole\Event::write - Write data to socket asynchronously - - - - &reftitle.description; - - public static boolSwoole\Event::write - mixedfd - mixeddata - - - Makes data sending asynchronous for stream/sockets resources. - - - - If data is continuously written to a socket but the peer cannot read fast enough, the socket buffer - will eventually fill up. In this case, the Swoole underlying layer will store the excess data - in an in-memory buffer and wait for the writable event to trigger before attempting to write - to the socket again. However, if the in-memory buffer also becomes full, Swoole will throw a - "pipe buffer overflow, reactor will block" error and switch to blocking mode, pausing further - writes until space becomes available. - - - - - The buffer-full return of false is an atomic operation—it guarantees - either complete success (all data written) or total failure (nothing written). - - - - - Event::write cannot be used with SSL/TLS-encrypted streams or sockets (tunneled connections). - - - - - Upon successful execution, Event::write will automatically switch the $socket to non-blocking mode. - - - - - - &reftitle.parameters; - - - fd - - - File descriptor (stream/socket resource, integer, or object). - - - - - data - - - Data to send (length must not exceed socket buffer size). - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - <function>Swoole\Event::write</function> example - - -]]> - - - - - - - diff --git a/reference/swoole/swoole/http/client/addfile.xml b/reference/swoole/swoole/http/client/addfile.xml deleted file mode 100644 index 91646f38bc83..000000000000 --- a/reference/swoole/swoole/http/client/addfile.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - Swoole\Http\Client::addFile - Add a file to the post form. - - - - &reftitle.description; - - public voidSwoole\Http\Client::addFile - stringpath - stringname - stringtype - stringfilename - stringoffset - - - - - - - - - &reftitle.parameters; - - - path - - - - - - - - name - - - - - - - - type - - - - - - - - filename - - - - - - - - offset - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/client/close.xml b/reference/swoole/swoole/http/client/close.xml deleted file mode 100644 index 65ef14a7aac0..000000000000 --- a/reference/swoole/swoole/http/client/close.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Http\Client::close - Close the http connection. - - - - &reftitle.description; - - public voidSwoole\Http\Client::close - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/client/construct.xml b/reference/swoole/swoole/http/client/construct.xml deleted file mode 100644 index 0678852f22ca..000000000000 --- a/reference/swoole/swoole/http/client/construct.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Swoole\Http\Client::__construct - Construct the async HTTP client. - - - - &reftitle.description; - - public Swoole\Http\Client::__construct - stringhost - stringport - boolssl - - - - - - - - - &reftitle.parameters; - - - host - - - The hostname of the remote host. - - - - - port - - - The port number of the remote host. - - - - - ssl - - - Whether to enable SSL. - - - - - - - - - - - - - diff --git a/reference/swoole/swoole/http/client/destruct.xml b/reference/swoole/swoole/http/client/destruct.xml deleted file mode 100644 index a4a8646e1255..000000000000 --- a/reference/swoole/swoole/http/client/destruct.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Http\Client::__destruct - Destruct the HTTP client. - - - - &reftitle.description; - - public voidSwoole\Http\Client::__destruct - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/client/download.xml b/reference/swoole/swoole/http/client/download.xml deleted file mode 100644 index 6bc213c3cabd..000000000000 --- a/reference/swoole/swoole/http/client/download.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - Swoole\Http\Client::download - Download a file from the remote server. - - - - &reftitle.description; - - public voidSwoole\Http\Client::download - stringpath - stringfile - callablecallback - intoffset - - - - - - - - - &reftitle.parameters; - - - path - - - - - - - - file - - - - - - - - callback - - - - - - - - offset - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/client/execute.xml b/reference/swoole/swoole/http/client/execute.xml deleted file mode 100644 index 5ea201cb550f..000000000000 --- a/reference/swoole/swoole/http/client/execute.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Http\Client::execute - Send the HTTP request after setting the parameters. - - - - &reftitle.description; - - public voidSwoole\Http\Client::execute - stringpath - stringcallback - - - - - - - - - &reftitle.parameters; - - - path - - - - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/client/get.xml b/reference/swoole/swoole/http/client/get.xml deleted file mode 100644 index af6fb7c7e23c..000000000000 --- a/reference/swoole/swoole/http/client/get.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Http\Client::get - Send GET http request to the remote server. - - - - &reftitle.description; - - public voidSwoole\Http\Client::get - stringpath - callablecallback - - - - - - - - - &reftitle.parameters; - - - path - - - - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/client/isconnected.xml b/reference/swoole/swoole/http/client/isconnected.xml deleted file mode 100644 index d66fe7ca1431..000000000000 --- a/reference/swoole/swoole/http/client/isconnected.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Http\Client::isConnected - Check if the HTTP connection is connected. - - - - &reftitle.description; - - public boolSwoole\Http\Client::isConnected - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/client/on.xml b/reference/swoole/swoole/http/client/on.xml deleted file mode 100644 index fa4ce8363a9b..000000000000 --- a/reference/swoole/swoole/http/client/on.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Http\Client::on - Register callback function by event name. - - - - &reftitle.description; - - public voidSwoole\Http\Client::on - stringevent_name - callablecallback - - - - - - - - - &reftitle.parameters; - - - event_name - - - - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/client/post.xml b/reference/swoole/swoole/http/client/post.xml deleted file mode 100644 index c2941fc0d0c4..000000000000 --- a/reference/swoole/swoole/http/client/post.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - Swoole\Http\Client::post - Send POST http request to the remote server. - - - - &reftitle.description; - - public voidSwoole\Http\Client::post - stringpath - stringdata - callablecallback - - - - - - - - - &reftitle.parameters; - - - path - - - - - - - - data - - - - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/client/push.xml b/reference/swoole/swoole/http/client/push.xml deleted file mode 100644 index 4b937c16af23..000000000000 --- a/reference/swoole/swoole/http/client/push.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - Swoole\Http\Client::push - Push data to websocket client. - - - - &reftitle.description; - - public voidSwoole\Http\Client::push - stringdata - stringopcode - stringfinish - - - - - - - - - &reftitle.parameters; - - - data - - - - - - - - opcode - - - - - - - - finish - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/client/set.xml b/reference/swoole/swoole/http/client/set.xml deleted file mode 100644 index 54802c9e1a3e..000000000000 --- a/reference/swoole/swoole/http/client/set.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Http\Client::set - Update the HTTP client parameters. - - - - &reftitle.description; - - public voidSwoole\Http\Client::set - arraysettings - - - - - - - - - &reftitle.parameters; - - - settings - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/client/setcookies.xml b/reference/swoole/swoole/http/client/setcookies.xml deleted file mode 100644 index 15f344c01595..000000000000 --- a/reference/swoole/swoole/http/client/setcookies.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Http\Client::setCookies - Set the http request cookies. - - - - &reftitle.description; - - public voidSwoole\Http\Client::setCookies - arraycookies - - - - - - - - - &reftitle.parameters; - - - cookies - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/client/setdata.xml b/reference/swoole/swoole/http/client/setdata.xml deleted file mode 100644 index f9b4d0789f14..000000000000 --- a/reference/swoole/swoole/http/client/setdata.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Http\Client::setData - Set the HTTP request body data. - - - - &reftitle.description; - - public ReturnTypeSwoole\Http\Client::setData - stringdata - - - The HTTP method will be changed to be POST. - - - - - - &reftitle.parameters; - - - data - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/client/setheaders.xml b/reference/swoole/swoole/http/client/setheaders.xml deleted file mode 100644 index 8fa5b87546fa..000000000000 --- a/reference/swoole/swoole/http/client/setheaders.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Http\Client::setHeaders - Set the HTTP request headers. - - - - &reftitle.description; - - public voidSwoole\Http\Client::setHeaders - arrayheaders - - - - - - - - - &reftitle.parameters; - - - headers - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/client/setmethod.xml b/reference/swoole/swoole/http/client/setmethod.xml deleted file mode 100644 index 5beb4992715b..000000000000 --- a/reference/swoole/swoole/http/client/setmethod.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Http\Client::setMethod - Set the HTTP request method. - - - - &reftitle.description; - - public voidSwoole\Http\Client::setMethod - stringmethod - - - - - - - - - &reftitle.parameters; - - - method - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/client/upgrade.xml b/reference/swoole/swoole/http/client/upgrade.xml deleted file mode 100644 index e398a91109b4..000000000000 --- a/reference/swoole/swoole/http/client/upgrade.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Http\Client::upgrade - Upgrade to websocket protocol. - - - - &reftitle.description; - - public voidSwoole\Http\Client::upgrade - stringpath - stringcallback - - - - - - - - - &reftitle.parameters; - - - path - - - - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/request/destruct.xml b/reference/swoole/swoole/http/request/destruct.xml deleted file mode 100644 index a8aa516d82a3..000000000000 --- a/reference/swoole/swoole/http/request/destruct.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Http\Request::__destruct - Destruct the HTTP request. - - - - &reftitle.description; - - public voidSwoole\Http\Request::__destruct - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/request/rawcontent.xml b/reference/swoole/swoole/http/request/rawcontent.xml deleted file mode 100644 index c1ff6bea7335..000000000000 --- a/reference/swoole/swoole/http/request/rawcontent.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Http\Request::rawcontent - Get the raw HTTP POST body. - - - - &reftitle.description; - - public stringSwoole\Http\Request::rawcontent - - - - This method is used for the POST data which isn't in the form of `application/x-www-form-urlencoded`. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/response/cookie.xml b/reference/swoole/swoole/http/response/cookie.xml deleted file mode 100644 index b52185e5370a..000000000000 --- a/reference/swoole/swoole/http/response/cookie.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - Swoole\Http\Response::cookie - Set the cookies of the HTTP response. - - - - &reftitle.description; - - public stringSwoole\Http\Response::cookie - stringname - stringvalue - stringexpires - stringpath - stringdomain - stringsecure - stringhttponly - - - - - - - - - &reftitle.parameters; - - - name - - - - - - - - value - - - - - - - - expires - - - - - - - - path - - - - - - - - domain - - - - - - - - secure - - - - - - - - httponly - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/response/destruct.xml b/reference/swoole/swoole/http/response/destruct.xml deleted file mode 100644 index 6f37f08749c2..000000000000 --- a/reference/swoole/swoole/http/response/destruct.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Http\Response::__destruct - Destruct the HTTP response. - - - - &reftitle.description; - - public voidSwoole\Http\Response::__destruct - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/response/end.xml b/reference/swoole/swoole/http/response/end.xml deleted file mode 100644 index 7b15e190abd6..000000000000 --- a/reference/swoole/swoole/http/response/end.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Http\Response::end - Send data for the HTTP request and finish the response. - - - - &reftitle.description; - - public voidSwoole\Http\Response::end - stringcontent - - - - - - - - - &reftitle.parameters; - - - content - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/response/gzip.xml b/reference/swoole/swoole/http/response/gzip.xml deleted file mode 100644 index 7fc61bbee175..000000000000 --- a/reference/swoole/swoole/http/response/gzip.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - Swoole\Http\Response::gzip - Enable the gzip of response content. - - - - - &reftitle.description; - - public ReturnTypeSwoole\Http\Response::gzip - stringcompress_level - - - The header about Content-Encoding will be added automatically. - - - - - - &reftitle.parameters; - - - compress_level - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/response/header.xml b/reference/swoole/swoole/http/response/header.xml deleted file mode 100644 index d270f738eac3..000000000000 --- a/reference/swoole/swoole/http/response/header.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - Swoole\Http\Response::header - Set the HTTP response headers. - - - - &reftitle.description; - - public voidSwoole\Http\Response::header - stringkey - stringvalue - stringucwords - - - - - - - - - &reftitle.parameters; - - - key - - - - - - - - value - - - - - - - - ucwords - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/response/initheader.xml b/reference/swoole/swoole/http/response/initheader.xml deleted file mode 100644 index 7ed0efb559de..000000000000 --- a/reference/swoole/swoole/http/response/initheader.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Http\Response::initHeader - Init the HTTP response header. - - - - &reftitle.description; - - public ReturnTypeSwoole\Http\Response::initHeader - - - - Init the HTTP response header. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/response/rawcookie.xml b/reference/swoole/swoole/http/response/rawcookie.xml deleted file mode 100644 index a1ee163ac4fd..000000000000 --- a/reference/swoole/swoole/http/response/rawcookie.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - Swoole\Http\Response::rawcookie - Set the raw cookies to the HTTP response. - - - - &reftitle.description; - - public ReturnTypeSwoole\Http\Response::rawcookie - stringname - stringvalue - stringexpires - stringpath - stringdomain - stringsecure - stringhttponly - - - - - - - - - &reftitle.parameters; - - - name - - - - - - - - value - - - - - - - - expires - - - - - - - - path - - - - - - - - domain - - - - - - - - secure - - - - - - - - httponly - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/response/sendfile.xml b/reference/swoole/swoole/http/response/sendfile.xml deleted file mode 100644 index d867a3cfef27..000000000000 --- a/reference/swoole/swoole/http/response/sendfile.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Http\Response::sendfile - Send file through the HTTP response. - - - - &reftitle.description; - - public ReturnTypeSwoole\Http\Response::sendfile - stringfilename - intoffset - - - Send file through the HTTP response. - - - - - - &reftitle.parameters; - - - filename - - - - - - - - offset - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/response/status.xml b/reference/swoole/swoole/http/response/status.xml deleted file mode 100644 index e14e4f5ecd93..000000000000 --- a/reference/swoole/swoole/http/response/status.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Http\Response::status - Set the status code of the HTTP response. - - - - &reftitle.description; - - public ReturnTypeSwoole\Http\Response::status - stringhttp_code - - - Set the status code of the HTTP response. - - - - - - &reftitle.parameters; - - - http_code - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/response/write.xml b/reference/swoole/swoole/http/response/write.xml deleted file mode 100644 index 839b63b80c3d..000000000000 --- a/reference/swoole/swoole/http/response/write.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Http\Response::write - Append HTTP body content to the HTTP response. - - - - &reftitle.description; - - public voidSwoole\Http\Response::write - stringcontent - - - Append HTTP body content to the HTTP response. - - - - - - &reftitle.parameters; - - - content - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/server/on.xml b/reference/swoole/swoole/http/server/on.xml deleted file mode 100644 index 10b47e203fee..000000000000 --- a/reference/swoole/swoole/http/server/on.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Http\Server::on - Bind callback function to HTTP server by event name. - - - - &reftitle.description; - - public voidSwoole\Http\Server::on - stringevent_name - callablecallback - - - Bind callback function to HTTP server by event name. - - - - - - &reftitle.parameters; - - - event_name - - - - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/http/server/start.xml b/reference/swoole/swoole/http/server/start.xml deleted file mode 100644 index 29f2dce65a01..000000000000 --- a/reference/swoole/swoole/http/server/start.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Http\Server::start - Start the swoole http server. - - - - &reftitle.description; - - public voidSwoole\Http\Server::start - - - - Start the swoole http server. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/lock/construct.xml b/reference/swoole/swoole/lock/construct.xml deleted file mode 100644 index 5d638c1c2fa8..000000000000 --- a/reference/swoole/swoole/lock/construct.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - Swoole\Lock::__construct - Construct a memory lock. - - - - &reftitle.description; - - public Swoole\Lock::__construct - stringtype - stringfile_lock_location - - - Swoole lock is used for data synchronization between multiple threads or processes. - - - - - - &reftitle.parameters; - - - type - - - - - - - - file_lock_location - - - - - - - - - - - - - - - - diff --git a/reference/swoole/swoole/lock/destruct.xml b/reference/swoole/swoole/lock/destruct.xml deleted file mode 100644 index 12c7e7ca3423..000000000000 --- a/reference/swoole/swoole/lock/destruct.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Lock::__destruct - Destroy a Swoole memory lock. - - - - &reftitle.description; - - public voidSwoole\Lock::__destruct - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/lock/lock-read.xml b/reference/swoole/swoole/lock/lock-read.xml deleted file mode 100644 index 88e82a8c3f49..000000000000 --- a/reference/swoole/swoole/lock/lock-read.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Lock::lock_read - Lock a read-write lock for reading. - - - - &reftitle.description; - - public voidSwoole\Lock::lock_read - - - - Lock a read-write lock for reading. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/lock/lock.xml b/reference/swoole/swoole/lock/lock.xml deleted file mode 100644 index 2ed2659d6602..000000000000 --- a/reference/swoole/swoole/lock/lock.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Lock::lock - Try to acquire the lock. It will block if the lock is not available. - - - - &reftitle.description; - - public voidSwoole\Lock::lock - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/lock/trylock-read.xml b/reference/swoole/swoole/lock/trylock-read.xml deleted file mode 100644 index 0537d717f3a0..000000000000 --- a/reference/swoole/swoole/lock/trylock-read.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Lock::trylock_read - Try to lock a read-write lock for reading and return straight away even the lock is not available. - - - - &reftitle.description; - - public voidSwoole\Lock::trylock_read - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/lock/trylock.xml b/reference/swoole/swoole/lock/trylock.xml deleted file mode 100644 index 413a5c203278..000000000000 --- a/reference/swoole/swoole/lock/trylock.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Lock::trylock - Try to acquire the lock and return straight away even the lock is not available. - - - - &reftitle.description; - - public voidSwoole\Lock::trylock - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/lock/unlock.xml b/reference/swoole/swoole/lock/unlock.xml deleted file mode 100644 index 12e8f1159bfc..000000000000 --- a/reference/swoole/swoole/lock/unlock.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Lock::unlock - Release the lock. - - - - &reftitle.description; - - public voidSwoole\Lock::unlock - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/mmap/open.xml b/reference/swoole/swoole/mmap/open.xml deleted file mode 100644 index f588c008a4d9..000000000000 --- a/reference/swoole/swoole/mmap/open.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - Swoole\Mmap::open - Map a file into memory and return the stream resource which can be used by PHP stream operations. - - - - &reftitle.description; - - public static ReturnTypeSwoole\Mmap::open - stringfilename - stringsize - stringoffset - - - - - - - - - &reftitle.parameters; - - - filename - - - - - - - - size - - - - - - - - offset - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/mysql/close.xml b/reference/swoole/swoole/mysql/close.xml deleted file mode 100644 index bdc7acd9c395..000000000000 --- a/reference/swoole/swoole/mysql/close.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\MySQL::close - Close the async MySQL connection. - - - - &reftitle.description; - - public voidSwoole\MySQL::close - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/mysql/connect.xml b/reference/swoole/swoole/mysql/connect.xml deleted file mode 100644 index 750b95ba2701..000000000000 --- a/reference/swoole/swoole/mysql/connect.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\MySQL::connect - Connect to the remote MySQL server. - - - - &reftitle.description; - - public voidSwoole\MySQL::connect - arrayserver_config - callablecallback - - - Connect to the remote MySQL server. - - - - - - &reftitle.parameters; - - - server_config - - - - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/mysql/construct.xml b/reference/swoole/swoole/mysql/construct.xml deleted file mode 100644 index f31453d7ee82..000000000000 --- a/reference/swoole/swoole/mysql/construct.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - Swoole\MySQL::__construct - Construct an async MySQL client. - - - - &reftitle.description; - - public Swoole\MySQL::__construct - - - - Construct an async MySQL client. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - - - - diff --git a/reference/swoole/swoole/mysql/destruct.xml b/reference/swoole/swoole/mysql/destruct.xml deleted file mode 100644 index 8b942a668a97..000000000000 --- a/reference/swoole/swoole/mysql/destruct.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\MySQL::__destruct - Destroy the async MySQL client. - - - - &reftitle.description; - - public voidSwoole\MySQL::__destruct - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/mysql/getbuffer.xml b/reference/swoole/swoole/mysql/getbuffer.xml deleted file mode 100644 index 615d3d1ceafb..000000000000 --- a/reference/swoole/swoole/mysql/getbuffer.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\MySQL::getBuffer - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\MySQL::getBuffer - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/mysql/on.xml b/reference/swoole/swoole/mysql/on.xml deleted file mode 100644 index da7dd1987ca8..000000000000 --- a/reference/swoole/swoole/mysql/on.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\MySQL::on - Register callback function based on event name. - - - - &reftitle.description; - - public voidSwoole\MySQL::on - stringevent_name - callablecallback - - - Register callback function based on event name, current only 'close' event is supported. - - - - - - &reftitle.parameters; - - - event_name - - - - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/mysql/query.xml b/reference/swoole/swoole/mysql/query.xml deleted file mode 100644 index 21013dfd22a2..000000000000 --- a/reference/swoole/swoole/mysql/query.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\MySQL::query - Run the SQL query. - - - - &reftitle.description; - - public ReturnTypeSwoole\MySQL::query - stringsql - callablecallback - - - - - - - - - &reftitle.parameters; - - - sql - - - - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/process/alarm.xml b/reference/swoole/swoole/process/alarm.xml deleted file mode 100644 index e38eeda36dc7..000000000000 --- a/reference/swoole/swoole/process/alarm.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Process::alarm - High precision timer which triggers signal with fixed interval. - - - - &reftitle.description; - - public static voidSwoole\Process::alarm - intinterval_usec - - - - - - - - - &reftitle.parameters; - - - interval_usec - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/process/close.xml b/reference/swoole/swoole/process/close.xml deleted file mode 100644 index fc4d27d25e3c..000000000000 --- a/reference/swoole/swoole/process/close.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Process::close - Close the pipe to the child process. - - - - &reftitle.description; - - public voidSwoole\Process::close - - - - Close the pipe to the child process. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/process/construct.xml b/reference/swoole/swoole/process/construct.xml deleted file mode 100644 index 0f490a3ec582..000000000000 --- a/reference/swoole/swoole/process/construct.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Swoole\Process::__construct - Construct a process. - - - - &reftitle.description; - - public Swoole\Process::__construct - callablecallback - boolredirect_stdin_and_stdout - intpipe_type - - - - - - - - - &reftitle.parameters; - - - callback - - - - - - - - redirect_stdin_and_stdout - - - - - - - - pipe_type - - - - - - - - - - - - - - - - diff --git a/reference/swoole/swoole/process/daemon.xml b/reference/swoole/swoole/process/daemon.xml deleted file mode 100644 index 8256fb3969fa..000000000000 --- a/reference/swoole/swoole/process/daemon.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - Swoole\Process::daemon - Change the process to be a daemon process. - - - - &reftitle.description; - - public static voidSwoole\Process::daemon - boolnochdir - boolnoclose - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - nochdir - - - - - - - - noclose - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/process/destruct.xml b/reference/swoole/swoole/process/destruct.xml deleted file mode 100644 index 3d0c35c25dbf..000000000000 --- a/reference/swoole/swoole/process/destruct.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Process::__destruct - Destroy the process. - - - - &reftitle.description; - - public voidSwoole\Process::__destruct - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/process/exec.xml b/reference/swoole/swoole/process/exec.xml deleted file mode 100644 index 11fc8e60b9d1..000000000000 --- a/reference/swoole/swoole/process/exec.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Process::exec - Execute system commands. - - - - &reftitle.description; - - public ReturnTypeSwoole\Process::exec - stringexec_file - stringargs - - - The process will be replaced to be the system command process, but the pipe to the parent process will be kept. - - - - - - &reftitle.parameters; - - - exec_file - - - - - - - - args - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/process/exit.xml b/reference/swoole/swoole/process/exit.xml deleted file mode 100644 index 23bab12a9fb4..000000000000 --- a/reference/swoole/swoole/process/exit.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Process::exit - Stop the child processes. - - - - &reftitle.description; - - public voidSwoole\Process::exit - stringexit_code - - - - - - - - - &reftitle.parameters; - - - exit_code - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/process/freequeue.xml b/reference/swoole/swoole/process/freequeue.xml deleted file mode 100644 index e73a99195757..000000000000 --- a/reference/swoole/swoole/process/freequeue.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Process::freeQueue - Destroy the message queue created by swoole_process::useQueue. - - - - &reftitle.description; - - public voidSwoole\Process::freeQueue - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/process/kill.xml b/reference/swoole/swoole/process/kill.xml deleted file mode 100644 index dd080a592852..000000000000 --- a/reference/swoole/swoole/process/kill.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Process::kill - Send signal to the child process. - - - - &reftitle.description; - - public static boolSwoole\Process::kill - intpid - intsignal_no - - - Send signal to the child process. - - - - - - &reftitle.parameters; - - - pid - - - Process pid - - - - - signal_no - - - Signal to be sent - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - diff --git a/reference/swoole/swoole/process/name.xml b/reference/swoole/swoole/process/name.xml deleted file mode 100644 index bdd61064d15c..000000000000 --- a/reference/swoole/swoole/process/name.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Process::name - Set name of the process. - - - - &reftitle.description; - - public boolSwoole\Process::name - stringprocess_name - - - - - - - - - &reftitle.parameters; - - - process_name - - - Set name of the process. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - diff --git a/reference/swoole/swoole/process/pop.xml b/reference/swoole/swoole/process/pop.xml deleted file mode 100644 index abbde4076728..000000000000 --- a/reference/swoole/swoole/process/pop.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Process::pop - Read and pop data from the message queue. - - - - &reftitle.description; - - public mixedSwoole\Process::pop - intmaxsize - - - - - - - - - &reftitle.parameters; - - - maxsize - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/process/push.xml b/reference/swoole/swoole/process/push.xml deleted file mode 100644 index 197d01e8da55..000000000000 --- a/reference/swoole/swoole/process/push.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Process::push - Write and push data into the message queue. - - - - &reftitle.description; - - public boolSwoole\Process::push - stringdata - - - - - - - - - &reftitle.parameters; - - - data - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/process/read.xml b/reference/swoole/swoole/process/read.xml deleted file mode 100644 index 356408753a96..000000000000 --- a/reference/swoole/swoole/process/read.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Process::read - Read data sending to the process. - - - - &reftitle.description; - - public stringSwoole\Process::read - intmaxsize - - - - - - - - - &reftitle.parameters; - - - maxsize - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/process/signal.xml b/reference/swoole/swoole/process/signal.xml deleted file mode 100644 index b82b967c21dd..000000000000 --- a/reference/swoole/swoole/process/signal.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Process::signal - Send signal to the child processes. - - - - &reftitle.description; - - public static voidSwoole\Process::signal - stringsignal_no - callablecallback - - - - - - - - - &reftitle.parameters; - - - signal_no - - - - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - If signal sent successfully, it returns TRUE, otherwise it returns FALSE. - - - - - - - diff --git a/reference/swoole/swoole/process/start.xml b/reference/swoole/swoole/process/start.xml deleted file mode 100644 index 837226db7b6e..000000000000 --- a/reference/swoole/swoole/process/start.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Process::start - Start the process. - - - - &reftitle.description; - - public voidSwoole\Process::start - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/process/statqueue.xml b/reference/swoole/swoole/process/statqueue.xml deleted file mode 100644 index 60629707eb16..000000000000 --- a/reference/swoole/swoole/process/statqueue.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Process::statQueue - Get the stats of the message queue used as the communication method between processes. - - - - &reftitle.description; - - public arraySwoole\Process::statQueue - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The array of status of the message queue. - - - - - - - - diff --git a/reference/swoole/swoole/process/usequeue.xml b/reference/swoole/swoole/process/usequeue.xml deleted file mode 100644 index 589fc42180dd..000000000000 --- a/reference/swoole/swoole/process/usequeue.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Process::useQueue - Create a message queue as the communication method between the parent process and child processes. - - - - &reftitle.description; - - public boolSwoole\Process::useQueue - intkey - intmode - - - - - - - - - &reftitle.parameters; - - - key - - - - - - - - mode - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/process/wait.xml b/reference/swoole/swoole/process/wait.xml deleted file mode 100644 index bc5ba88b2e48..000000000000 --- a/reference/swoole/swoole/process/wait.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Process::wait - Wait for the events of child processes. - - - - &reftitle.description; - - public static arraySwoole\Process::wait - boolblocking - - - - - - - - - &reftitle.parameters; - - - blocking - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/process/write.xml b/reference/swoole/swoole/process/write.xml deleted file mode 100644 index 7097e05fd93c..000000000000 --- a/reference/swoole/swoole/process/write.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Process::write - Write data into the pipe and communicate with the parent process or child processes. - - - - &reftitle.description; - - public intSwoole\Process::write - stringdata - - - - - - - - - &reftitle.parameters; - - - data - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/redis/server/format.xml b/reference/swoole/swoole/redis/server/format.xml deleted file mode 100644 index 427cb85f3909..000000000000 --- a/reference/swoole/swoole/redis/server/format.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - Swoole\Redis\Server::format - Description - - - - &reftitle.description; - - public static ReturnTypeSwoole\Redis\Server::format - stringtype - stringvalue - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - type - - - - - - - - value - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/redis/server/sethandler.xml b/reference/swoole/swoole/redis/server/sethandler.xml deleted file mode 100644 index 61dc8e195fd0..000000000000 --- a/reference/swoole/swoole/redis/server/sethandler.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - Swoole\Redis\Server::setHandler - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Redis\Server::setHandler - stringcommand - stringcallback - stringnumber_of_string_param - stringtype_of_array_param - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - command - - - - - - - - callback - - - - - - - - number_of_string_param - - - - - - - - type_of_array_param - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/redis/server/start.xml b/reference/swoole/swoole/redis/server/start.xml deleted file mode 100644 index 788cf9de9740..000000000000 --- a/reference/swoole/swoole/redis/server/start.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Swoole\Redis\Server::start - Description - - - - &reftitle.description; - - public ReturnTypeSwoole\Redis\Server::start - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/runtime/enableCoroutine.xml b/reference/swoole/swoole/runtime/enableCoroutine.xml deleted file mode 100644 index 79e6dc613153..000000000000 --- a/reference/swoole/swoole/runtime/enableCoroutine.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - Swoole\Runtime::enableCoroutine - Enable coroutine for specified functions - - - - &reftitle.description; - - public static voidSwoole\Runtime::enableCoroutine - intflagsSWOOLE_HOOK_ALL - - - This method enables coroutine support for specified PHP functions based on the given flags. - It should be called once at the beginning of the application. - - - - - &reftitle.parameters; - - - flags - - - Bitmask of flags specifying which functions to hook. Can be combined using | operator. - Available flags: - SWOOLE_HOOK_TCP, - SWOOLE_HOOK_UDP, - SWOOLE_HOOK_UNIX, - SWOOLE_HOOK_UDG, - SWOOLE_HOOK_SSL, - SWOOLE_HOOK_TLS, - SWOOLE_HOOK_SLEEP, - SWOOLE_HOOK_FILE, - SWOOLE_HOOK_STREAM_FUNCTION, - SWOOLE_HOOK_BLOCKING_FUNCTION, - SWOOLE_HOOK_PROC, - SWOOLE_HOOK_CURL, - SWOOLE_HOOK_NATIVE_CURL, - SWOOLE_HOOK_SOCKETS, - SWOOLE_HOOK_STDIO, - SWOOLE_HOOK_PDO_PGSQL, - SWOOLE_HOOK_PDO_ODBC, - SWOOLE_HOOK_PDO_ORACLE, - SWOOLE_HOOK_PDO_SQLITE, - or SWOOLE_HOOK_ALL for all flags. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/swoole/swoole/runtime/getHookFlags.xml b/reference/swoole/swoole/runtime/getHookFlags.xml deleted file mode 100644 index 93b37eb271fb..000000000000 --- a/reference/swoole/swoole/runtime/getHookFlags.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Runtime::getHookFlags - Get current hook flags - - - - &reftitle.description; - - public static intSwoole\Runtime::getHookFlags - - - - Gets the current hook flags. - Note that the returned flags might differ from what was set if some hooks failed. - - - - - &reftitle.parameters; - - This function has no parameters. - - - - - &reftitle.returnvalues; - - Returns the current hook flags as a bitmask. - - - - - diff --git a/reference/swoole/swoole/runtime/setHookFlags.xml b/reference/swoole/swoole/runtime/setHookFlags.xml deleted file mode 100644 index 6f9052c3d651..000000000000 --- a/reference/swoole/swoole/runtime/setHookFlags.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - Swoole\Runtime::setHookFlags - Set hook flags for coroutine - - - - &reftitle.description; - - public static boolSwoole\Runtime::setHookFlags - intflags - - - Sets the hook flags for coroutine support. - This dynamically changes the hook flags at runtime. - - - - - &reftitle.parameters; - - - flags - - - Bitmask of flags specifying which functions to hook. Same flags as enableCoroutine. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/swoole/swoole/serialize/pack.xml b/reference/swoole/swoole/serialize/pack.xml deleted file mode 100644 index 0bfa9f632886..000000000000 --- a/reference/swoole/swoole/serialize/pack.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Serialize::pack - Serialize the data. - - - - &reftitle.description; - - public static ReturnTypeSwoole\Serialize::pack - stringdata - intis_fast - - - Swoole provides a fast and high performance serialization module. - - - - - - &reftitle.parameters; - - - data - - - - - - - - is_fast - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/serialize/unpack.xml b/reference/swoole/swoole/serialize/unpack.xml deleted file mode 100644 index ee40981d519e..000000000000 --- a/reference/swoole/swoole/serialize/unpack.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Serialize::unpack - Unserialize the data. - - - - &reftitle.description; - - public static ReturnTypeSwoole\Serialize::unpack - stringdata - stringargs - - - Unserialize the data. - - - - - - &reftitle.parameters; - - - string - - - - - - - - args - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/addlistener.xml b/reference/swoole/swoole/server/addlistener.xml deleted file mode 100644 index 895c7521a238..000000000000 --- a/reference/swoole/swoole/server/addlistener.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - Swoole\Server::addlistener - Add a new listener to the server. - - - - &reftitle.description; - - public voidSwoole\Server::addlistener - stringhost - intport - stringsocket_type - - - - - - - - - &reftitle.parameters; - - - host - - - - - - - - port - - - - - - - - socket_type - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/addprocess.xml b/reference/swoole/swoole/server/addprocess.xml deleted file mode 100644 index 87d745343b8a..000000000000 --- a/reference/swoole/swoole/server/addprocess.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Server::addProcess - Add a user defined swoole_process to the server. - - - - &reftitle.description; - - public boolSwoole\Server::addProcess - swoole_processprocess - - - - - - - - - &reftitle.parameters; - - - process - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/after.xml b/reference/swoole/swoole/server/after.xml deleted file mode 100644 index e01cc09d3308..000000000000 --- a/reference/swoole/swoole/server/after.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - Swoole\Server::after - Trigger a callback function after a period of time. - - - - &reftitle.description; - - public ReturnTypeSwoole\Server::after - intafter_time_ms - callablecallback - stringparam - - - - - - - - - &reftitle.parameters; - - - after_time_ms - - - - - - - - callback - - - - - - - - param - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/bind.xml b/reference/swoole/swoole/server/bind.xml deleted file mode 100644 index 94ab2db5f339..000000000000 --- a/reference/swoole/swoole/server/bind.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Server::bind - Bind the connection to a user defined user ID. - - - - &reftitle.description; - - public boolSwoole\Server::bind - intfd - intuid - - - - - - - - - &reftitle.parameters; - - - fd - - - - - - - - uid - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/cleartimer.xml b/reference/swoole/swoole/server/cleartimer.xml deleted file mode 100644 index 662c38a4c121..000000000000 --- a/reference/swoole/swoole/server/cleartimer.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Server::clearTimer - swoole_timer_clear - Stop and destroy a timer. - - - - &reftitle.description; - &style.oop; (method): - - public voidSwoole\Server::clearTimer - inttimer_id - - &style.procedural;: - - voidswoole_timer_clear - inttimer_id - - - Stop and destroy a timer - - - - - - &reftitle.parameters; - - - - timer_id - - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/close.xml b/reference/swoole/swoole/server/close.xml deleted file mode 100644 index 6fe86d77f9fc..000000000000 --- a/reference/swoole/swoole/server/close.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Server::close - Close a connection to the client. - - - - &reftitle.description; - - public boolSwoole\Server::close - intfd - boolreset - - - - - - - - - &reftitle.parameters; - - - fd - - - - - - - - reset - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/confirm.xml b/reference/swoole/swoole/server/confirm.xml deleted file mode 100644 index b0a078a3355b..000000000000 --- a/reference/swoole/swoole/server/confirm.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Server::confirm - Check status of the connection. - - - - &reftitle.description; - - public boolSwoole\Server::confirm - intfd - - - - - - - - - &reftitle.parameters; - - - fd - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/connection-info.xml b/reference/swoole/swoole/server/connection-info.xml deleted file mode 100644 index b3debe462abb..000000000000 --- a/reference/swoole/swoole/server/connection-info.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Server::connection_info - Get the connection info by file description. - - - - &reftitle.description; - - public arraySwoole\Server::connection_info - intfd - intreactor_id - - - - - - - - - &reftitle.parameters; - - - fd - - - - - - - - reactor_id - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/connection-list.xml b/reference/swoole/swoole/server/connection-list.xml deleted file mode 100644 index 0d39969aefae..000000000000 --- a/reference/swoole/swoole/server/connection-list.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Server::connection_list - Get all of the established connections. - - - - &reftitle.description; - - public arraySwoole\Server::connection_list - intstart_fd - intpagesize - - - - - - - - - &reftitle.parameters; - - - start_fd - - - - - - - - pagesize - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/construct.xml b/reference/swoole/swoole/server/construct.xml deleted file mode 100644 index 0d670ed3d6bf..000000000000 --- a/reference/swoole/swoole/server/construct.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - Swoole\Server::__construct - Construct a Swoole server. - - - - &reftitle.description; - - public Swoole\Server::__construct - stringhost - intport - intmode - intsock_type - - - - - - - - - &reftitle.parameters; - - - host - - - - - - - - port - - - - - - - - mode - - - - - - - - sock_type - - - - - - - - - - - - - - - - diff --git a/reference/swoole/swoole/server/defer.xml b/reference/swoole/swoole/server/defer.xml deleted file mode 100644 index c0988ce5d1f0..000000000000 --- a/reference/swoole/swoole/server/defer.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Server::defer - Delay execution of the callback function at the end of current EventLoop. - - - - &reftitle.description; - - public voidSwoole\Server::defer - callablecallback - - - - - - - - - &reftitle.parameters; - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/exist.xml b/reference/swoole/swoole/server/exist.xml deleted file mode 100644 index f51cae45020f..000000000000 --- a/reference/swoole/swoole/server/exist.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Server::exist - Check if the connection is existed. - - - - &reftitle.description; - - public boolSwoole\Server::exist - intfd - - - - - - - - - &reftitle.parameters; - - - fd - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/finish.xml b/reference/swoole/swoole/server/finish.xml deleted file mode 100644 index 06dc3a1b14a1..000000000000 --- a/reference/swoole/swoole/server/finish.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Server::finish - Used in task process for sending result to the worker process when the task is finished. - - - - &reftitle.description; - - public voidSwoole\Server::finish - stringdata - - - - - - - - - &reftitle.parameters; - - - data - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/getclientinfo.xml b/reference/swoole/swoole/server/getclientinfo.xml deleted file mode 100644 index 39a3729e2686..000000000000 --- a/reference/swoole/swoole/server/getclientinfo.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - Swoole\Server::getClientInfo - Get the connection info by file description. - - - - &reftitle.description; - - public arraySwoole\Server::getClientInfo - intfd - intreactor_id - boolignore_error - - - - - - - - - &reftitle.parameters; - - - fd - - - File descriptors. - - - - - reactor_id - - - The Reactor thread ID where the connection is made. - - - - - ignore_error - - - Whether to ignore errors, if set to true, - connection information will be returned even if the connection is closed. - - - - - - - - &reftitle.returnvalues; - - Returns information about the client connection. - - - - - - - diff --git a/reference/swoole/swoole/server/getclientlist.xml b/reference/swoole/swoole/server/getclientlist.xml deleted file mode 100644 index b532ea60fb5a..000000000000 --- a/reference/swoole/swoole/server/getclientlist.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - Swoole\Server::getClientList - Get all of the established connections. - - - - &reftitle.description; - - public arraySwoole\Server::getClientList - intstart_fd - intpagesize - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - start_fd - - - - - - - - pagesize - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/getlasterror.xml b/reference/swoole/swoole/server/getlasterror.xml deleted file mode 100644 index fe19e30996b8..000000000000 --- a/reference/swoole/swoole/server/getlasterror.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Server::getLastError - Get the error code of the most recent error. - - - - &reftitle.description; - - public intSwoole\Server::getLastError - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/heartbeat.xml b/reference/swoole/swoole/server/heartbeat.xml deleted file mode 100644 index 0d55aa36734d..000000000000 --- a/reference/swoole/swoole/server/heartbeat.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Server::heartbeat - Check all the connections on the server. - - - - &reftitle.description; - - public mixedSwoole\Server::heartbeat - boolif_close_connection - - - - - - - - - &reftitle.parameters; - - - if_close_connection - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/listen.xml b/reference/swoole/swoole/server/listen.xml deleted file mode 100644 index cb3dfaf33506..000000000000 --- a/reference/swoole/swoole/server/listen.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - Swoole\Server::listen - Listen on the given IP and port, socket type. - - - - &reftitle.description; - - public boolSwoole\Server::listen - stringhost - intport - stringsocket_type - - - - - - - - - &reftitle.parameters; - - - host - - - - - - - - port - - - - - - - - socket_type - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/on.xml b/reference/swoole/swoole/server/on.xml deleted file mode 100644 index 0100e4088676..000000000000 --- a/reference/swoole/swoole/server/on.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Server::on - Register a callback function by event name. - - - - &reftitle.description; - - public voidSwoole\Server::on - stringevent_name - callablecallback - - - - - - - - - &reftitle.parameters; - - - event_name - - - - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/pause.xml b/reference/swoole/swoole/server/pause.xml deleted file mode 100644 index da7e3b2cbfe9..000000000000 --- a/reference/swoole/swoole/server/pause.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Server::pause - Stop receiving data from the connection. - - - - &reftitle.description; - - public voidSwoole\Server::pause - intfd - - - - - - - - - &reftitle.parameters; - - - fd - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/port/construct.xml b/reference/swoole/swoole/server/port/construct.xml deleted file mode 100644 index 1d2afc2a3902..000000000000 --- a/reference/swoole/swoole/server/port/construct.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - Swoole\Server\Port::__construct - Construct a server port - - - - &reftitle.description; - - private Swoole\Server\Port::__construct - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - - - - diff --git a/reference/swoole/swoole/server/port/destruct.xml b/reference/swoole/swoole/server/port/destruct.xml deleted file mode 100644 index a2d572f395b0..000000000000 --- a/reference/swoole/swoole/server/port/destruct.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Server\Port::__destruct - Destroy server port - - - - &reftitle.description; - - public voidSwoole\Server\Port::__destruct - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/port/on.xml b/reference/swoole/swoole/server/port/on.xml deleted file mode 100644 index 9db4e2da7b77..000000000000 --- a/reference/swoole/swoole/server/port/on.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Server\Port::on - Register callback functions by event. - - - - &reftitle.description; - - public ReturnTypeSwoole\Server\Port::on - stringevent_name - callablecallback - - - - - - - - - &reftitle.parameters; - - - event_name - - - - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/port/set.xml b/reference/swoole/swoole/server/port/set.xml deleted file mode 100644 index b374466bce29..000000000000 --- a/reference/swoole/swoole/server/port/set.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Server\Port::set - Set protocol of the server port. - - - - &reftitle.description; - - public voidSwoole\Server\Port::set - arraysettings - - - - - - - - - &reftitle.parameters; - - - settings - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/protect.xml b/reference/swoole/swoole/server/protect.xml deleted file mode 100644 index 1766199554a5..000000000000 --- a/reference/swoole/swoole/server/protect.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Server::protect - Set the connection to be protected mode. - - - - &reftitle.description; - - public voidSwoole\Server::protect - intfd - boolis_protected - - - - - - - - - &reftitle.parameters; - - - fd - - - - - - - - is_protected - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/reload.xml b/reference/swoole/swoole/server/reload.xml deleted file mode 100644 index 797a5b7b3c3e..000000000000 --- a/reference/swoole/swoole/server/reload.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Server::reload - Restart all the worker process. - - - - &reftitle.description; - - public boolSwoole\Server::reload - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/resume.xml b/reference/swoole/swoole/server/resume.xml deleted file mode 100644 index cb6d7f69577a..000000000000 --- a/reference/swoole/swoole/server/resume.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Server::resume - Start receiving data from the connection. - - - - &reftitle.description; - - public voidSwoole\Server::resume - intfd - - - - - - - - - &reftitle.parameters; - - - fd - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/send.xml b/reference/swoole/swoole/server/send.xml deleted file mode 100644 index fc61c9405ae9..000000000000 --- a/reference/swoole/swoole/server/send.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - Swoole\Server::send - Send data to the client. - - - - &reftitle.description; - - public boolSwoole\Server::send - intfd - stringdata - intreactor_id - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - fd - - - - - - - - data - - - - - - - - reactor_id - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/sendfile.xml b/reference/swoole/swoole/server/sendfile.xml deleted file mode 100644 index e783fd5464a0..000000000000 --- a/reference/swoole/swoole/server/sendfile.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - Swoole\Server::sendfile - Send file to the connection. - - - - &reftitle.description; - - public boolSwoole\Server::sendfile - intfd - stringfilename - intoffset - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - fd - - - - - - - - filename - - - - - - - - offset - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/sendmessage.xml b/reference/swoole/swoole/server/sendmessage.xml deleted file mode 100644 index 0e9f602ab3a6..000000000000 --- a/reference/swoole/swoole/server/sendmessage.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Server::sendMessage - Send message to worker processes by ID. - - - - &reftitle.description; - - public boolSwoole\Server::sendMessage - intworker_id - stringdata - - - - - - - - - &reftitle.parameters; - - - dst_worker_id - - - - - - - - data - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/sendto.xml b/reference/swoole/swoole/server/sendto.xml deleted file mode 100644 index 9f9a0126db16..000000000000 --- a/reference/swoole/swoole/server/sendto.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - Swoole\Server::sendto - Send data to the remote UDP address. - - - - &reftitle.description; - - public boolSwoole\Server::sendto - stringip - intport - stringdata - stringserver_socket - - - - - - - - - &reftitle.parameters; - - - ip - - - - - - - - port - - - - - - - - data - - - - - - - - server_socket - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/sendwait.xml b/reference/swoole/swoole/server/sendwait.xml deleted file mode 100644 index f51e5ec80e89..000000000000 --- a/reference/swoole/swoole/server/sendwait.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - Swoole\Server::sendwait - Send data to the remote socket in the blocking way. - - - - &reftitle.description; - - public boolSwoole\Server::sendwait - intfd - stringdata - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - fd - - - - - - - - data - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/set.xml b/reference/swoole/swoole/server/set.xml deleted file mode 100644 index b115c883edf7..000000000000 --- a/reference/swoole/swoole/server/set.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Server::set - Set the runtime settings of the swoole server. - - - - &reftitle.description; - - public ReturnTypeSwoole\Server::set - arraysettings - - - Set the runtime settings of the swoole server. The settings can be accessed by $server->setting when the swoole server has started. - - - - - - &reftitle.parameters; - - - settings - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/shutdown.xml b/reference/swoole/swoole/server/shutdown.xml deleted file mode 100644 index 47bcbc410288..000000000000 --- a/reference/swoole/swoole/server/shutdown.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Server::shutdown - Shutdown the master server process, this function can be called in worker processes. - - - - &reftitle.description; - - public voidSwoole\Server::shutdown - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/start.xml b/reference/swoole/swoole/server/start.xml deleted file mode 100644 index 835113cf75f9..000000000000 --- a/reference/swoole/swoole/server/start.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Server::start - Start the Swoole server. - - - - &reftitle.description; - - public voidSwoole\Server::start - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/stats.xml b/reference/swoole/swoole/server/stats.xml deleted file mode 100644 index e936618a34d6..000000000000 --- a/reference/swoole/swoole/server/stats.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Server::stats - Get the stats of the Swoole server. - - - - &reftitle.description; - - public arraySwoole\Server::stats - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/stop.xml b/reference/swoole/swoole/server/stop.xml deleted file mode 100644 index c32095252958..000000000000 --- a/reference/swoole/swoole/server/stop.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Server::stop - Stop the Swoole server. - - - - &reftitle.description; - - public boolSwoole\Server::stop - intworker_id - - - - - - - - - &reftitle.parameters; - - - worker_id - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/task.xml b/reference/swoole/swoole/server/task.xml deleted file mode 100644 index 74e0005a7731..000000000000 --- a/reference/swoole/swoole/server/task.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - Swoole\Server::task - Send data to the task worker processes. - - - - &reftitle.description; - - public mixedSwoole\Server::task - stringdata - intdst_worker_id - callablecallback - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - data - - - - - - - - dst_worker_id - - - - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/taskwait.xml b/reference/swoole/swoole/server/taskwait.xml deleted file mode 100644 index 80f4361a6a80..000000000000 --- a/reference/swoole/swoole/server/taskwait.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - Swoole\Server::taskwait - Send data to the task worker processes in blocking way. - - - - &reftitle.description; - - public voidSwoole\Server::taskwait - stringdata - floattimeout - intworker_id - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - data - - - - - - - - timeout - - - - - - - - worker_id - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/taskwaitmulti.xml b/reference/swoole/swoole/server/taskwaitmulti.xml deleted file mode 100644 index a3d05de568a6..000000000000 --- a/reference/swoole/swoole/server/taskwaitmulti.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Server::taskWaitMulti - Execute multiple tasks concurrently. - - - - &reftitle.description; - - public voidSwoole\Server::taskWaitMulti - arraytasks - floattimeout_ms - - - - - - - - - &reftitle.parameters; - - - tasks - - - - - - - - timeout_ms - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/server/tick.xml b/reference/swoole/swoole/server/tick.xml deleted file mode 100644 index 8baac591a234..000000000000 --- a/reference/swoole/swoole/server/tick.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Server::tick - Repeats a given function at every given time-interval. - - - - &reftitle.description; - - public voidSwoole\Server::tick - intinterval_ms - callablecallback - - - - - - - - - &reftitle.parameters; - - - interval_ms - - - - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/table/column.xml b/reference/swoole/swoole/table/column.xml deleted file mode 100644 index ab138d57c087..000000000000 --- a/reference/swoole/swoole/table/column.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - Swoole\Table::column - Set the data type and size of the columns. - - - - &reftitle.description; - - public boolSwoole\Table::column - stringname - stringtype - intsize - - - - - - - - - &reftitle.parameters; - - - name - - - Specify the name of the field. - - - - - type - - - Specify the field type. - - - - - size - - - Specify the maximum length of the string field. - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/table/construct.xml b/reference/swoole/swoole/table/construct.xml deleted file mode 100644 index 67a515d5556f..000000000000 --- a/reference/swoole/swoole/table/construct.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - Swoole\Table::__construct - Construct a Swoole memory table with fixed size. - - - - &reftitle.description; - - public Swoole\Table::__construct - inttable_size - - - - - - - - - &reftitle.parameters; - - - table_size - - - - - - - - - - - - - - - - diff --git a/reference/swoole/swoole/table/count.xml b/reference/swoole/swoole/table/count.xml deleted file mode 100644 index 3fc6fe35a35e..000000000000 --- a/reference/swoole/swoole/table/count.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Table::count - Count the rows in the table, or count all the elements in the table if $mode = 1. - - - - &reftitle.description; - - public intSwoole\Table::count - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/table/create.xml b/reference/swoole/swoole/table/create.xml deleted file mode 100644 index ceed5590167a..000000000000 --- a/reference/swoole/swoole/table/create.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Table::create - Create the swoole memory table. - - - - &reftitle.description; - - public boolSwoole\Table::create - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/table/current.xml b/reference/swoole/swoole/table/current.xml deleted file mode 100644 index 40728de83fc2..000000000000 --- a/reference/swoole/swoole/table/current.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Table::current - Get the current row. - - - - &reftitle.description; - - public arraySwoole\Table::current - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/table/decr.xml b/reference/swoole/swoole/table/decr.xml deleted file mode 100644 index fa1f343f67a9..000000000000 --- a/reference/swoole/swoole/table/decr.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - Swoole\Table::decr - Decrement the value in the Swoole table by $key and $column - - - - &reftitle.description; - - public intSwoole\Table::decr - stringkey - stringcolumn - intdecrby - - - - - - - - - &reftitle.parameters; - - - key - - - Key of the data. - - - - - column - - - Specify the column name. - - - - - decrby - - - Decrement value. - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/table/del.xml b/reference/swoole/swoole/table/del.xml deleted file mode 100644 index e51b9eb37d5d..000000000000 --- a/reference/swoole/swoole/table/del.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Table::del - Delete a row in the Swoole table by $key - - - - &reftitle.description; - - public boolSwoole\Table::del - stringkey - - - - - - - - - &reftitle.parameters; - - - key - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/table/destroy.xml b/reference/swoole/swoole/table/destroy.xml deleted file mode 100644 index 305919efe850..000000000000 --- a/reference/swoole/swoole/table/destroy.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Table::destroy - Destroy the Swoole table. - - - - &reftitle.description; - - public boolSwoole\Table::destroy - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/table/exist.xml b/reference/swoole/swoole/table/exist.xml deleted file mode 100644 index e23a42804918..000000000000 --- a/reference/swoole/swoole/table/exist.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Table::exist - Check if a row is existed by $row_key. - - - - &reftitle.description; - - public boolSwoole\Table::exist - stringkey - - - - - - - - - &reftitle.parameters; - - - key - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/table/get.xml b/reference/swoole/swoole/table/get.xml deleted file mode 100644 index 6fc25128a22d..000000000000 --- a/reference/swoole/swoole/table/get.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Table::get - Get the value in the Swoole table by $key and $field. - - - - &reftitle.description; - - public mixedSwoole\Table::get - stringkey - stringfield - - - - - - - - - &reftitle.parameters; - - - key - - - - - - - - field - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/table/incr.xml b/reference/swoole/swoole/table/incr.xml deleted file mode 100644 index e22376d5bebb..000000000000 --- a/reference/swoole/swoole/table/incr.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - Swoole\Table::incr - Increment the value by $key and $column - - - - &reftitle.description; - - public intSwoole\Table::incr - stringkey - stringcolumn - intincrby - - - - - - - - - &reftitle.parameters; - - - key - - - Key for the data. - - - - - column - - - Specify the column name. - - - - - incrby - - - Increment value. - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/table/key.xml b/reference/swoole/swoole/table/key.xml deleted file mode 100644 index 73548faec0c0..000000000000 --- a/reference/swoole/swoole/table/key.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Table::key - Get the key of current row. - - - - &reftitle.description; - - public mixedSwoole\Table::key - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/table/next.xml b/reference/swoole/swoole/table/next.xml deleted file mode 100644 index 1979c2235095..000000000000 --- a/reference/swoole/swoole/table/next.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Table::next - Advance the iterator to the next row - - - - &reftitle.description; - - public voidSwoole\Table::next - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/table/rewind.xml b/reference/swoole/swoole/table/rewind.xml deleted file mode 100644 index ab988f6481f4..000000000000 --- a/reference/swoole/swoole/table/rewind.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Table::rewind - Rewind the iterator. - - - - &reftitle.description; - - public voidSwoole\Table::rewind - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/table/set.xml b/reference/swoole/swoole/table/set.xml deleted file mode 100644 index 6c4c2656c572..000000000000 --- a/reference/swoole/swoole/table/set.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Table::set - Update a row of the table by $key. - - - - &reftitle.description; - - public boolSwoole\Table::set - stringkey - arrayvalue - - - - - - - - - &reftitle.parameters; - - - key - - - Key of the data. - - - - - value - - - Value of the data. - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/table/valid.xml b/reference/swoole/swoole/table/valid.xml deleted file mode 100644 index afbb030446f8..000000000000 --- a/reference/swoole/swoole/table/valid.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Table::valid - Check if the current row is valid. - - - - &reftitle.description; - - public boolSwoole\Table::valid - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/timer/after.xml b/reference/swoole/swoole/timer/after.xml deleted file mode 100644 index 7cb5d35b9a53..000000000000 --- a/reference/swoole/swoole/timer/after.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - Swoole\Timer::after - Execute a function after a specified time - - - - &reftitle.description; - - public static intfalseSwoole\Timer::after - intms - callablecallback - mixedparams - - - Creates a one-shot timer, which is destroyed once its callback has run. - Unlike sleep, it does not block the current process. - - - - - &reftitle.parameters; - - - ms - - - The delay in milliseconds. Must be greater than or equal to - 1; a lower value emits an E_WARNING - and the call fails. - - - - - callback - - - The function to execute once the delay has elapsed. It is called as - callback(mixed ...$params). Unlike - Swoole\Timer::tick, the timer ID is not passed - to the callback. - - - - - params - - - Additional values passed to callback. - - - - - - - - &reftitle.returnvalues; - - Returns the timer ID, which can be passed to - Swoole\Timer::clear to cancel the timer before it - fires. Returns &false; if the timer could not be created, in particular when - ms is less than 1. - - - - - &reftitle.examples; - - <function>Swoole\Timer::after</function> example - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/swoole/swoole/timer/clear.xml b/reference/swoole/swoole/timer/clear.xml deleted file mode 100644 index 6ab179db4093..000000000000 --- a/reference/swoole/swoole/timer/clear.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - Swoole\Timer::clear - Delete a timer by ID - - - - &reftitle.description; - - public static boolSwoole\Timer::clear - inttimer_id - - - Deletes the timer with the given ID. Only timers created by the current - process can be removed; timers belonging to other processes are not visible - here. - - - - - &reftitle.parameters; - - - timer_id - - - The timer ID returned by Swoole\Timer::tick or - Swoole\Timer::after. - - - - - - - - &reftitle.returnvalues; - - &return.success; - &false; is returned when no timer with this ID exists in the current - process, or when the ID refers to an internal timer. - - - - - &reftitle.examples; - - <function>Swoole\Timer::clear</function> example - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/swoole/swoole/timer/clearAll.xml b/reference/swoole/swoole/timer/clearAll.xml deleted file mode 100644 index 72a72ed81618..000000000000 --- a/reference/swoole/swoole/timer/clearAll.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - Swoole\Timer::clearAll - Clear all timers in the current process. - - - - &reftitle.description; - - public static boolSwoole\Timer::clearAll - - - - Clear all timers in the current process. As of Swoole 4.4.0. - - - - - &reftitle.returnvalues; - - &return.success; - &false; is returned when no timer has been created in this process yet. - Only timers created from PHP are removed; internal timers are left in place. - - - - - diff --git a/reference/swoole/swoole/timer/exists.xml b/reference/swoole/swoole/timer/exists.xml deleted file mode 100644 index 9513c8192772..000000000000 --- a/reference/swoole/swoole/timer/exists.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - Swoole\Timer::exists - Check if a timer is existed. - - - - &reftitle.description; - - public static boolSwoole\Timer::exists - inttimer_id - - - Checks whether a timer with the given ID exists in the current process. - - - - - - &reftitle.parameters; - - - timer_id - - - The timer ID returned by Swoole\Timer::tick or - Swoole\Timer::after. - - - - - - - - &reftitle.returnvalues; - - Returns &true; if a timer with this ID exists in the current process, - &false; otherwise. - - - - - - - diff --git a/reference/swoole/swoole/timer/info.xml b/reference/swoole/swoole/timer/info.xml deleted file mode 100644 index 35e785a1299c..000000000000 --- a/reference/swoole/swoole/timer/info.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - - Swoole\Timer::info - Get information about a timer. - - - - &reftitle.description; - - public static arraynullSwoole\Timer::info - inttimer_id - - - Get information about a timer. As of Swoole 4.4.0. - - - - - &reftitle.parameters; - - - timer_id - - - The timer ID returned by Swoole\Timer::tick or - Swoole\Timer::after. - - - - - - - - &reftitle.returnvalues; - - Returns an array describing the timer, or &null; if no timer with this ID - exists in the current process. The array contains the following keys: - - - - exec_msec - - - The time of the next execution, in milliseconds, counted from the moment - the timer subsystem was started. It is not a duration. - - - - - exec_count - - - The number of times the callback has been executed. - Available as of Swoole 4.8.0. - - - - - interval - - - The interval of the timer, in milliseconds. - - - - - round - - - The number of the timer loop round in which the timer was created. - - - - - removed - - - Whether the timer has been removed. - - - - - - - - &reftitle.examples; - - <function>Swoole\Timer::info</function> example - - -]]> - - &example.outputs.similar; - - - int(1000) - ["exec_count"]=> - int(0) - ["interval"]=> - int(1000) - ["round"]=> - int(0) - ["removed"]=> - bool(false) -} -]]> - - - - - - diff --git a/reference/swoole/swoole/timer/list.xml b/reference/swoole/swoole/timer/list.xml deleted file mode 100644 index fce061baf553..000000000000 --- a/reference/swoole/swoole/timer/list.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - Swoole\Timer::list - Get an iterator over the timers of the current process - - - - &reftitle.description; - - public static Swoole\Timer\IteratorSwoole\Timer::list - - - - Returns an iterator over the IDs of the timers created from PHP in the - current process. Timers created internally by Swoole are not listed. - As of Swoole 4.4.0. - - - - - &reftitle.returnvalues; - - Returns a Swoole\Timer\Iterator object, which - extends ArrayIterator and yields the timer IDs as - int values. The iterator is a snapshot taken when the method is - called; it is empty when no timer exists. - - - - - &reftitle.examples; - - <function>Swoole\Timer::list</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/swoole/swoole/timer/set.xml b/reference/swoole/swoole/timer/set.xml deleted file mode 100644 index 78cca7975243..000000000000 --- a/reference/swoole/swoole/timer/set.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - Swoole\Timer::set - Set timer-related parameters - - - - &reftitle.description; - - public static voidSwoole\Timer::set - arraysettings - - - Sets the options used by the timers of the current process. - - - - - This method was deprecated in Swoole 4.6.0 and removed in Swoole 6.0.0. - Use swoole_async_set instead. - - - - - - &reftitle.parameters; - - - settings - - - An associative array of options. Only enable_coroutine - is recognised: when set to &false;, the timer callbacks are executed - directly instead of inside a newly created coroutine. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/swoole/swoole/timer/stats.xml b/reference/swoole/swoole/timer/stats.xml deleted file mode 100644 index e7424e481e55..000000000000 --- a/reference/swoole/swoole/timer/stats.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Swoole\Timer::stats - Get timer statistics. - - - - &reftitle.description; - - public static arraySwoole\Timer::stats - - - - Get timer statistics. As of Swoole 4.4.0. - - - - - &reftitle.returnvalues; - - Returns an array with the following keys: - - - - initialized - - - Whether the timer subsystem has been started. It is &false; until the - first timer is created. - - - - - num - - - The number of timers currently registered in the process. - - - - - round - - - The current round of the timer loop. - - - - - - - - &reftitle.examples; - - <function>Swoole\Timer::stats</function> example - - -]]> - - &example.outputs.similar; - - - bool(true) - ["num"]=> - int(1) - ["round"]=> - int(0) -} -]]> - - - - - - diff --git a/reference/swoole/swoole/timer/tick.xml b/reference/swoole/swoole/timer/tick.xml deleted file mode 100644 index 5c8a20bca9d1..000000000000 --- a/reference/swoole/swoole/timer/tick.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - Swoole\Timer::tick - Set a repeating interval timer - - - - &reftitle.description; - - public static intfalseSwoole\Timer::tick - intms - callablecallback - mixedparams - - - Sets a timer that triggers every ms milliseconds. - Unlike a timer created with Swoole\Timer::after, - it keeps triggering until it is removed with - Swoole\Timer::clear. - - - - - &reftitle.parameters; - - - ms - - - The interval in milliseconds. Must be greater than or equal to - 1; a lower value emits an E_WARNING - and the call fails. - - - - - callback - - - The function to execute on every tick. It is called as - callback(int $timer_id, mixed ...$params): the ID of - the timer is passed as the first argument, followed by the values given - in params. - - - - - params - - - Additional values passed to callback after the - timer ID. - - - - - - - - &reftitle.returnvalues; - - Returns the timer ID, which can be passed to - Swoole\Timer::clear. Returns &false; if the timer - could not be created, in particular when ms is less - than 1. - - - - - &reftitle.examples; - - <function>Swoole\Timer::tick</function> example - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/swoole/swoole/websocket/server/exist.xml b/reference/swoole/swoole/websocket/server/exist.xml deleted file mode 100644 index 5f1ed84e3d2e..000000000000 --- a/reference/swoole/swoole/websocket/server/exist.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\WebSocket\Server::exist - Check if the file descriptor exists. - - - - &reftitle.description; - - public boolSwoole\WebSocket\Server::exist - intfd - - - - - - - - - &reftitle.parameters; - - - fd - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/websocket/server/on.xml b/reference/swoole/swoole/websocket/server/on.xml deleted file mode 100644 index 4aa7063d05d2..000000000000 --- a/reference/swoole/swoole/websocket/server/on.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\WebSocket\Server::on - Register event callback function - - - - &reftitle.description; - - public ReturnTypeSwoole\WebSocket\Server::on - stringevent_name - callablecallback - - - Register event callback function - - - - - - &reftitle.parameters; - - - event_name - - - - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/websocket/server/pack.xml b/reference/swoole/swoole/websocket/server/pack.xml deleted file mode 100644 index fd3ab7481744..000000000000 --- a/reference/swoole/swoole/websocket/server/pack.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - Swoole\WebSocket\Server::pack - Get a pack of binary data to send in a single frame. - - - - &reftitle.description; - - public static binarySwoole\WebSocket\Server::pack - stringdata - stringopcode - stringfinish - stringmask - - - - - - - - - &reftitle.parameters; - - - data - - - - - - - - opcode - - - - - - - - finish - - - - - - - - mask - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/websocket/server/push.xml b/reference/swoole/swoole/websocket/server/push.xml deleted file mode 100644 index a174649c8810..000000000000 --- a/reference/swoole/swoole/websocket/server/push.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - Swoole\WebSocket\Server::push - Push data to the remote client. - - - - &reftitle.description; - - public voidSwoole\WebSocket\Server::push - stringfd - stringdata - stringopcode - stringfinish - - - - - - - - - &reftitle.parameters; - - - fd - - - - - - - - data - - - - - - - - opcode - - - - - - - - finish - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/websocket/server/unpack.xml b/reference/swoole/swoole/websocket/server/unpack.xml deleted file mode 100644 index 4f36a78723f6..000000000000 --- a/reference/swoole/swoole/websocket/server/unpack.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\WebSocket\Server::unpack - Unpack the binary data received from the client. - - - - &reftitle.description; - - public static stringSwoole\WebSocket\Server::unpack - binarydata - - - - - - - - - &reftitle.parameters; - - - data - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/versions.xml b/reference/swoole/versions.xml deleted file mode 100644 index 257c2e756658..000000000000 --- a/reference/swoole/versions.xml +++ /dev/null @@ -1,918 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/sync/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/sync/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/sync/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/sync/book.xml b/reference/sync/book.xml deleted file mode 100644 index 8b8f7109609c..000000000000 --- a/reference/sync/book.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - Sync - Sync - - - &reftitle.intro; - - The sync extension introduces cross-platform synchronization objects into PHP. - Named and unnamed Mutex, Semaphore, Event, Reader-Writer, and named Shared Memory - objects provide OS-level synchronization on both POSIX (e.g. Linux) and Windows - platforms. - - - Automatic cleanup of acquired synchronization objects takes place during extension - teardown. This means that if PHP prematurely terminates a script (e.g. script - execution time is exceeded), objects will not be left in an unknown state. The - only exception to this is if PHP itself crashes (e.g. an internal buffer overflow). - - - Unnamed synchronization objects don't have a lot of use outside of a multithreaded - scenario. Unnamed objects are more useful in conjunction with the pthreads PECL - extension. - - - - Named objects require additional care to be used on all systems. - If an object is instantiated with a specific set of parameters, it must always - be instantiated with those parameters or the object will probably end up in an - inconsistent state until the next reboot or a system administrator cleans up - the mess. - - - - - &reference.sync.setup; - &reference.sync.syncmutex; - &reference.sync.syncsemaphore; - &reference.sync.syncevent; - &reference.sync.syncreaderwriter; - &reference.sync.syncsharedmemory; - - - diff --git a/reference/sync/configure.xml b/reference/sync/configure.xml deleted file mode 100644 index d41e6a028c00..000000000000 --- a/reference/sync/configure.xml +++ /dev/null @@ -1,31 +0,0 @@ - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;sync - - -
    - diff --git a/reference/sync/setup.xml b/reference/sync/setup.xml deleted file mode 100644 index 095fcbba7060..000000000000 --- a/reference/sync/setup.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - &reftitle.setup; - -
    - &reftitle.required; - - A system with support for POSIX shared memory (shm_open()) or running Windows. - -
    - -
    - &reftitle.install; - - &pecl.info; - &url.pecl.package;sync. - -
    - -
    - diff --git a/reference/sync/syncevent.xml b/reference/sync/syncevent.xml deleted file mode 100644 index 919efec427b3..000000000000 --- a/reference/sync/syncevent.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - The SyncEvent class - SyncEvent - - - - -
    - &reftitle.intro; - - A cross-platform, native implementation of named and unnamed event objects. - Both automatic and manual event objects are supported. - - - An event object waits, without polling, for the object to be fired/set. - One instance waits on the event object while another instance fires/sets - the event. Event objects are useful wherever a long-running process would - otherwise poll a resource (e.g. checking to see if uploaded data needs to - be processed). - -
    - - -
    - &reftitle.classsynopsis; - - - - SyncEvent - - - - - SyncEvent - - - - - &Methods; - - - - -
    - -
    - - &reference.sync.entities.syncevent; - -
    - diff --git a/reference/sync/syncevent/construct.xml b/reference/sync/syncevent/construct.xml deleted file mode 100644 index 666e91319c0a..000000000000 --- a/reference/sync/syncevent/construct.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - SyncEvent::__construct - Constructs a new SyncEvent object - - - - &reftitle.description; - - public SyncEvent::__construct - stringname - boolmanual&false; - boolprefire&false; - - - Constructs a named or unnamed event object. - - - - - &reftitle.parameters; - - - name - - - The name of the event if this is a named event object. - - - - If the name already exists, it must be able to be opened by the current user - that the process is running as or an exception will be thrown with a meaningless - error message. - - - - - - manual - - - Specifies whether or not the event object must be reset manually. - - - - Manual reset event objects allow all waiting processes through until the - object is reset. - - - - - - prefire - - - Specifies whether or not to prefire (signal) the event object. - - - - Only has impact if the calling process/thread is the first to create the object. - - - - - - - - - &reftitle.returnvalues; - - The new SyncEvent object. - - - - - &reftitle.errors; - - An exception is thrown if the event object cannot be created or opened. - - - - - &reftitle.examples; - - <function>SyncEvent::__construct</function> example - -fire(); - -// In a cron job: -$event = new SyncEvent("GetAppReport"); -$event->wait(); -?> -]]> - - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL sync 1.1.0 - - - Added prefire. - - - - - - - - - - &reftitle.seealso; - - SyncEvent::fire - SyncEvent::reset - SyncEvent::wait - - - - - diff --git a/reference/sync/syncevent/fire.xml b/reference/sync/syncevent/fire.xml deleted file mode 100644 index 21b487be125f..000000000000 --- a/reference/sync/syncevent/fire.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - SyncEvent::fire - Fires/sets the event - - - - &reftitle.description; - - public boolSyncEvent::fire - - - - Fires/sets a SyncEvent object. Lets multiple threads through that are waiting - if the event object was created with a manual value of &true;. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>SyncEvent::fire</function> example - -fire(); - -// In a cron job: -$event = new SyncEvent("GetAppReport"); -$event->wait(); -?> -]]> - - - - - - &reftitle.seealso; - - SyncEvent::reset - SyncEvent::wait - - - - - diff --git a/reference/sync/syncevent/reset.xml b/reference/sync/syncevent/reset.xml deleted file mode 100644 index 83cf874bca17..000000000000 --- a/reference/sync/syncevent/reset.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - SyncEvent::reset - Resets a manual event - - - - &reftitle.description; - - public boolSyncEvent::reset - - - - Resets a SyncEvent object that has been fired/set. Only valid for manual event objects. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>SyncEvent::reset</function> example - -wait(); - -// In a cron job: -$event = new SyncEvent("DemoApplication", true); -$event->reset(); -/* ... Do some maintenance task(s) ... */ -$event->fire(); -?> -]]> - - - - - - &reftitle.seealso; - - SyncEvent::fire - SyncEvent::reset - SyncEvent::wait - - - - - diff --git a/reference/sync/syncevent/wait.xml b/reference/sync/syncevent/wait.xml deleted file mode 100644 index e3171251b868..000000000000 --- a/reference/sync/syncevent/wait.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - SyncEvent::wait - Waits for the event to be fired/set - - - - &reftitle.description; - - public boolSyncEvent::wait - intwait-1 - - - Waits for the SyncEvent object to be fired. - - - - - &reftitle.parameters; - - - wait - - - The number of milliseconds to wait for the event to be fired. - A value of -1 is infinite. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>SyncEvent::wait</function> example - -fire(); - -// In a cron job: -$event = new SyncEvent("GetAppReport"); -$event->wait(); -?> -]]> - - - - - - &reftitle.seealso; - - SyncEvent::fire - - - - - diff --git a/reference/sync/syncmutex.xml b/reference/sync/syncmutex.xml deleted file mode 100644 index ac21d2ae424c..000000000000 --- a/reference/sync/syncmutex.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - The SyncMutex class - SyncMutex - - - - -
    - &reftitle.intro; - - A cross-platform, native implementation of named and unnamed countable mutex objects. - - - A mutex is a mutual exclusion object that restricts access to a shared resource (e.g. a file) to a single instance. - Countable mutexes acquire the mutex a single time and internally track the number of times the mutex is locked. - The mutex is unlocked as soon as it goes out of scope or is unlocked the same number of times that it was locked. - -
    - - -
    - &reftitle.classsynopsis; - - - - SyncMutex - - - - - SyncMutex - - - - - &Methods; - - - - -
    - -
    - - &reference.sync.entities.syncmutex; - -
    - diff --git a/reference/sync/syncmutex/construct.xml b/reference/sync/syncmutex/construct.xml deleted file mode 100644 index 5ff75c557117..000000000000 --- a/reference/sync/syncmutex/construct.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - SyncMutex::__construct - Constructs a new SyncMutex object - - - - &reftitle.description; - - public SyncMutex::__construct - stringname - - - Constructs a named or unnamed countable mutex. - - - - - &reftitle.parameters; - - - name - - - The name of the mutex if this is a named mutex object. - - - - If the name already exists, it must be able to be opened by the current user - that the process is running as or an exception will be thrown with a meaningless - error message. - - - - - - - - - &reftitle.returnvalues; - - The new SyncMutex object. - - - - - &reftitle.errors; - - An exception is thrown if the mutex cannot be created or opened. - - - - - &reftitle.examples; - - <function>SyncMutex::__construct</function> named mutex with lock timeout example - -lock(3000)) -{ - echo "Unable to lock mutex."; - - exit(); -} - -/* ... */ - -$mutex->unlock(); -?> -]]> - - - - <function>SyncMutex::__construct</function> unnamed mutex example - -lock(); - -/* ... */ - -$mutex->unlock(); -?> -]]> - - - - - - &reftitle.seealso; - - SyncMutex::lock - SyncMutex::unlock - - - - - diff --git a/reference/sync/syncmutex/lock.xml b/reference/sync/syncmutex/lock.xml deleted file mode 100644 index 5a7791d2e03f..000000000000 --- a/reference/sync/syncmutex/lock.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - SyncMutex::lock - Waits for an exclusive lock - - - - &reftitle.description; - - public boolSyncMutex::lock - intwait-1 - - - Obtains an exclusive lock on a SyncMutex object. - If the lock is already acquired, then this increments an internal counter. - - - - - &reftitle.parameters; - - - wait - - - The number of milliseconds to wait for the exclusive lock. - A value of -1 is infinite. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>SyncMutex::lock</function> example - -lock(3000)) -{ - echo "Unable to lock mutex."; - - exit(); -} - -/* ... */ - -$mutex->unlock(); -?> -]]> - - - - - - &reftitle.seealso; - - SyncMutex::unlock - - - - - diff --git a/reference/sync/syncmutex/unlock.xml b/reference/sync/syncmutex/unlock.xml deleted file mode 100644 index 75a5cd0f6527..000000000000 --- a/reference/sync/syncmutex/unlock.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - SyncMutex::unlock - Unlocks the mutex - - - - &reftitle.description; - - public boolSyncMutex::unlock - boolall&false; - - - Decreases the internal counter of a SyncMutex object. - When the internal counter reaches zero, the actual lock on the object is released. - - - - - &reftitle.parameters; - - - all - - - Specifies whether or not to set the internal counter to zero and therefore release the lock. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>SyncMutex::unlock</function> example - -lock(); - -/* ... */ - -$mutex->unlock(); -?> -]]> - - - - - - &reftitle.seealso; - - SyncMutex::lock - - - - - diff --git a/reference/sync/syncreaderwriter.xml b/reference/sync/syncreaderwriter.xml deleted file mode 100644 index 551ebf5a744a..000000000000 --- a/reference/sync/syncreaderwriter.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - The SyncReaderWriter class - SyncReaderWriter - - - - -
    - &reftitle.intro; - - A cross-platform, native implementation of named and unnamed reader-writer objects. - - - A reader-writer object allows many readers or one writer to access a resource. - This is an efficient solution for managing resources where access will primarily be - read-only but exclusive write access is occasionally necessary. - -
    - - -
    - &reftitle.classsynopsis; - - - - SyncReaderWriter - - - - - SyncReaderWriter - - - - - &Methods; - - - - -
    - -
    - - &reference.sync.entities.syncreaderwriter; - -
    - diff --git a/reference/sync/syncreaderwriter/construct.xml b/reference/sync/syncreaderwriter/construct.xml deleted file mode 100644 index 8bc769e70cb4..000000000000 --- a/reference/sync/syncreaderwriter/construct.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - SyncReaderWriter::__construct - Constructs a new SyncReaderWriter object - - - - &reftitle.description; - - public SyncReaderWriter::__construct - stringname - intautounlock1 - - - Constructs a named or unnamed reader-writer object. - - - - - &reftitle.parameters; - - - name - - - The name of the reader-writer if this is a named reader-writer object. - - - - If the name already exists, it must be able to be opened by the current user - that the process is running as or an exception will be thrown with a meaningless - error message. - - - - - On Windows, name must not contain backslashes. - - - - - - autounlock - - - Specifies whether or not to automatically unlock the reader-writer at the - conclusion of the PHP script. - - - - If an object is: A named reader-writer with an autounlock of FALSE, the - object is locked for either reading or writing, and the PHP script concludes - before the object is unlocked, then the underlying objects will end up in an - inconsistent state. - - - - - - - - - &reftitle.returnvalues; - - The new SyncReaderWriter object. - - - - - &reftitle.errors; - - An exception is thrown if the reader-writer cannot be created or opened. - - - - - &reftitle.examples; - - <function>SyncReaderWriter::__construct</function> example - -readlock(); -/* ... */ -$readwrite->readunlock(); - -$readwrite->writelock(); -/* ... */ -$readwrite->writeunlock(); -?> -]]> - - - - - - &reftitle.seealso; - - SyncReaderWriter::readlock - SyncReaderWriter::readunlock - SyncReaderWriter::writelock - SyncReaderWriter::writeunlock - - - - - diff --git a/reference/sync/syncreaderwriter/readlock.xml b/reference/sync/syncreaderwriter/readlock.xml deleted file mode 100644 index 8234bb6c27ef..000000000000 --- a/reference/sync/syncreaderwriter/readlock.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - SyncReaderWriter::readlock - Waits for a read lock - - - - &reftitle.description; - - public boolSyncReaderWriter::readlock - intwait-1 - - - Obtains a read lock on a SyncReaderWriter object. - - - - - &reftitle.parameters; - - - wait - - - The number of milliseconds to wait for a lock. - A value of -1 is infinite. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>SyncReaderWriter::readlock</function> example - -readlock(); -/* ... */ -$readwrite->readunlock(); -?> -]]> - - - - - - &reftitle.seealso; - - SyncReaderWriter::readunlock - - - - - diff --git a/reference/sync/syncreaderwriter/readunlock.xml b/reference/sync/syncreaderwriter/readunlock.xml deleted file mode 100644 index 1095994da7e6..000000000000 --- a/reference/sync/syncreaderwriter/readunlock.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - SyncReaderWriter::readunlock - Releases a read lock - - - - &reftitle.description; - - public boolSyncReaderWriter::readunlock - - - - Releases a read lock on a SyncReaderWriter object. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>SyncReaderWriter::readunlock</function> example - -readlock(); -/* ... */ -$readwrite->readunlock(); -?> -]]> - - - - - - &reftitle.seealso; - - SyncReaderWriter::readlock - - - - - diff --git a/reference/sync/syncreaderwriter/writelock.xml b/reference/sync/syncreaderwriter/writelock.xml deleted file mode 100644 index 212a54b9e3e6..000000000000 --- a/reference/sync/syncreaderwriter/writelock.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - SyncReaderWriter::writelock - Waits for an exclusive write lock - - - - &reftitle.description; - - public boolSyncReaderWriter::writelock - intwait-1 - - - Obtains an exclusive write lock on a SyncReaderWriter object. - - - - - &reftitle.parameters; - - - wait - - - The number of milliseconds to wait for a lock. - A value of -1 is infinite. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>SyncReaderWriter::writelock</function> example - -writelock(); -/* ... */ -$readwrite->writeunlock(); -?> -]]> - - - - - - &reftitle.seealso; - - SyncReaderWriter::writeunlock - - - - - diff --git a/reference/sync/syncreaderwriter/writeunlock.xml b/reference/sync/syncreaderwriter/writeunlock.xml deleted file mode 100644 index b9fba06ec186..000000000000 --- a/reference/sync/syncreaderwriter/writeunlock.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - SyncReaderWriter::writeunlock - Releases a write lock - - - - &reftitle.description; - - public boolSyncReaderWriter::writeunlock - - - - Releases a write lock on a SyncReaderWriter object. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>SyncReaderWriter::writeunlock</function> example - -writelock(); -/* ... */ -$readwrite->writeunlock(); -?> -]]> - - - - - - &reftitle.seealso; - - SyncReaderWriter::writelock - - - - - diff --git a/reference/sync/syncsemaphore.xml b/reference/sync/syncsemaphore.xml deleted file mode 100644 index 34a52c292848..000000000000 --- a/reference/sync/syncsemaphore.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - The SyncSemaphore class - SyncSemaphore - - - - -
    - &reftitle.intro; - - A cross-platform, native implementation of named and unnamed semaphore objects. - - - A semaphore restricts access to a limited resource to a limited number of instances. - Semaphores differ from mutexes in that they can allow more than one instance to - access a resource at one time while a mutex only allows one instance at a time. - -
    - - -
    - &reftitle.classsynopsis; - - - - SyncSemaphore - - - - - SyncSemaphore - - - - - &Methods; - - - - -
    - -
    - - &reference.sync.entities.syncsemaphore; - -
    - diff --git a/reference/sync/syncsemaphore/construct.xml b/reference/sync/syncsemaphore/construct.xml deleted file mode 100644 index baa6e5c46203..000000000000 --- a/reference/sync/syncsemaphore/construct.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - SyncSemaphore::__construct - Constructs a new SyncSemaphore object - - - - &reftitle.description; - - public SyncSemaphore::__construct - stringname - intinitialval1 - boolautounlock&true; - - - Constructs a named or unnamed semaphore. - - - - - &reftitle.parameters; - - - name - - - The name of the semaphore if this is a named semaphore object. - - - - If the name already exists, it must be able to be opened by the current user - that the process is running as or an exception will be thrown with a meaningless - error message. - - - - - - initialval - - - The initial value of the semaphore. This is the number of locks that may be obtained. - - - - - autounlock - - - Specifies whether or not to automatically unlock the semaphore at the - conclusion of the PHP script. - - - - If an object is: A named semaphore with an autounlock of &false;, the object is - locked, and the PHP script concludes before the object is unlocked, then the - underlying semaphore will end up in an inconsistent state. - - - - - - - - - &reftitle.returnvalues; - - The new SyncSemaphore object. - - - - - &reftitle.errors; - - An exception is thrown if the semaphore cannot be created or opened. - - - - - &reftitle.examples; - - <function>SyncSemaphore::__construct</function> example - -lock(3000)) -{ - echo "Unable to lock semaphore."; - - exit(); -} - -/* ... */ - -$semaphore->unlock(); -?> -]]> - - - - - - &reftitle.seealso; - - SyncSemaphore::lock - SyncSemaphore::unlock - - - - - diff --git a/reference/sync/syncsemaphore/lock.xml b/reference/sync/syncsemaphore/lock.xml deleted file mode 100644 index fe4b9323b7ee..000000000000 --- a/reference/sync/syncsemaphore/lock.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - SyncSemaphore::lock - Decreases the count of the semaphore or waits - - - - &reftitle.description; - - public boolSyncSemaphore::lock - intwait-1 - - - Decreases the count of a SyncSemaphore object or waits until the semaphore becomes non-zero. - - - - - &reftitle.parameters; - - - wait - - - The number of milliseconds to wait for the semaphore. - A value of -1 is infinite. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>SyncSemaphore::lock</function> example - -lock(3000)) -{ - echo "Unable to lock semaphore."; - - exit(); -} - -/* ... */ - -$semaphore->unlock(); -?> -]]> - - - - - - &reftitle.seealso; - - SyncSemaphore::unlock - - - - - diff --git a/reference/sync/syncsemaphore/unlock.xml b/reference/sync/syncsemaphore/unlock.xml deleted file mode 100644 index 57d4c178e830..000000000000 --- a/reference/sync/syncsemaphore/unlock.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - SyncSemaphore::unlock - Increases the count of the semaphore - - - - &reftitle.description; - - public boolSyncSemaphore::unlock - intprevcount - - - Increases the count of a SyncSemaphore object. - - - - - &reftitle.parameters; - - - prevcount - - - Returns the previous count of the semaphore. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>SyncSemaphore::unlock</function> example - -lock(3000)) -{ - echo "Unable to lock semaphore."; - - exit(); -} - -/* ... */ - -$semaphore->unlock(); -?> -]]> - - - - - - &reftitle.seealso; - - SyncSemaphore::lock - - - - - diff --git a/reference/sync/syncsharedmemory.xml b/reference/sync/syncsharedmemory.xml deleted file mode 100644 index 9c1442795234..000000000000 --- a/reference/sync/syncsharedmemory.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - The SyncSharedMemory class - SyncSharedMemory - - - - -
    - &reftitle.intro; - - A cross-platform, native, consistent implementation of named shared memory - objects. - - - Shared memory lets two separate processes communicate without the need for - complex pipes or sockets. There are several integer-based shared memory - implementations for PHP. Named shared memory is an alternative. - - - Synchronization objects (e.g. SyncMutex) are still required to protect most - uses of shared memory. - -
    - - -
    - &reftitle.classsynopsis; - - - - SyncSharedMemory - - - - - SyncSharedMemory - - - - - &Methods; - - - - -
    - -
    - - &reference.sync.entities.syncsharedmemory; - -
    - diff --git a/reference/sync/syncsharedmemory/construct.xml b/reference/sync/syncsharedmemory/construct.xml deleted file mode 100644 index 37db997c993a..000000000000 --- a/reference/sync/syncsharedmemory/construct.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - SyncSharedMemory::__construct - Constructs a new SyncSharedMemory object - - - - &reftitle.description; - - public SyncSharedMemory::__construct - stringname - intsize - - - Constructs a named shared memory object. - - - - - &reftitle.parameters; - - - name - - - The name of the shared memory object. - - - - If the name already exists, it must be able to be opened by the current user - that the process is running as or an exception will be thrown with a meaningless - error message. - - - - - - size - - - The size, in bytes, of shared memory to reserve. - - - - The amount of memory cannot be resized later. Request sufficient storage up front. - - - - - - - - - &reftitle.returnvalues; - - The new SyncSharedMemory object. - - - - - &reftitle.errors; - - An exception is thrown if the shared memory object cannot be created or opened. - - - - - &reftitle.examples; - - <function>SyncSharedMemory::__construct</function> example - -first()) -{ - // Do first time initialization work here. -} - -$result = $mem->write(json_encode(array("name" => "my_report.txt"))); -?> -]]> - - - - - - &reftitle.seealso; - - SyncSharedMemory::first - SyncSharedMemory::size - SyncSharedMemory::write - SyncSharedMemory::read - - - - - diff --git a/reference/sync/syncsharedmemory/first.xml b/reference/sync/syncsharedmemory/first.xml deleted file mode 100644 index 3ecfa36dbbc1..000000000000 --- a/reference/sync/syncsharedmemory/first.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - SyncSharedMemory::first - Check to see if the object is the first instance system-wide of named shared memory - - - - &reftitle.description; - - public boolSyncSharedMemory::first - - - - Retrieves the system-wide first instance status of a SyncSharedMemory object. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>SyncSharedMemory::first</function> example - -first()) -{ - // Do first time initialization work here. -} - -var_dump($mem->first()); - -$mem2 = new SyncSharedMemory("AppReportName", 1024); - -var_dump($mem2->first()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SyncSharedMemory::write - SyncSharedMemory::read - - - - - diff --git a/reference/sync/syncsharedmemory/read.xml b/reference/sync/syncsharedmemory/read.xml deleted file mode 100644 index d745d76f9b82..000000000000 --- a/reference/sync/syncsharedmemory/read.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - SyncSharedMemory::read - Copy data from named shared memory - - - - &reftitle.description; - - public SyncSharedMemory::read - intstart0 - intlength - - - Copies data from named shared memory. - - - - - &reftitle.parameters; - - - start - - - The start/offset, in bytes, to begin reading. - - - - If the value is negative, the starting position will begin at the specified - number of bytes from the end of the shared memory segment. - - - - - - length - - - The number of bytes to read. - - - - If unspecified, reading will stop at the end of the shared memory segment. - - - If the value is negative, reading will stop the specified number of bytes - from the end of the shared memory segment. - - - - - - - - - &reftitle.returnvalues; - - A string containing the data read from shared memory. - - - - - &reftitle.examples; - - <function>SyncSharedMemory::__construct</function> example - -first()) -{ - // Do first time initialization work here. -} - -$result = $mem->write("report.txt"); - -$result = $mem->read(3, -4); -var_dump($result); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SyncSharedMemory::__construct - SyncSharedMemory::first - SyncSharedMemory::write - SyncSharedMemory::read - - - - - diff --git a/reference/sync/syncsharedmemory/size.xml b/reference/sync/syncsharedmemory/size.xml deleted file mode 100644 index bdd7b70b71d0..000000000000 --- a/reference/sync/syncsharedmemory/size.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - SyncSharedMemory::size - Returns the size of the named shared memory - - - - &reftitle.description; - - public intSyncSharedMemory::size - - - - Retrieves the shared memory size of a SyncSharedMemory object. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - An integer containing the size of the shared memory. This will be the same size that was passed to the constructor. - - - - - &reftitle.examples; - - <function>SyncSharedMemory::size</function> example - -size()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SyncSharedMemory::__construct - SyncSharedMemory::write - SyncSharedMemory::read - - - - - diff --git a/reference/sync/syncsharedmemory/write.xml b/reference/sync/syncsharedmemory/write.xml deleted file mode 100644 index 058a190f1ac7..000000000000 --- a/reference/sync/syncsharedmemory/write.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - SyncSharedMemory::write - Copy data to named shared memory - - - - &reftitle.description; - - public SyncSharedMemory::write - stringstring - intstart0 - - - Copies data to named shared memory. - - - - - &reftitle.parameters; - - - string - - - The data to write to shared memory. - - - - If the size of the data exceeds the size of the shared memory, the number of - bytes written returned will be less than the length of the input. - - - - - - start - - - The start/offset, in bytes, to begin writing. - - - - If the value is negative, the starting position will begin at the specified - number of bytes from the end of the shared memory segment. - - - - - - - - - &reftitle.returnvalues; - - An integer containing the number of bytes written to shared memory. - - - - - &reftitle.examples; - - <function>SyncSharedMemory::write</function> example - -first()) -{ - // Do first time initialization work here. -} - -$result = $mem->write("report.txt"); -var_dump($result); - -$result = $mem->write("report.txt", -3); -var_dump($result); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SyncSharedMemory::__construct - SyncSharedMemory::first - SyncSharedMemory::write - SyncSharedMemory::read - - - - - diff --git a/reference/sync/versions.xml b/reference/sync/versions.xml deleted file mode 100644 index 8dab271e52d9..000000000000 --- a/reference/sync/versions.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/taint/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/taint/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/taint/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/taint/book.xml b/reference/taint/book.xml deleted file mode 100644 index 74ead3a7848e..000000000000 --- a/reference/taint/book.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - Taint - Taint - - - &reftitle.intro; - - Taint is an extension for detecting XSS code (tainted strings). It can - also be used to spot SQL injection, command injection, file path - injection and similar vulnerabilities. - - - When taint is enabled, strings received from user input — - $_GET, $_POST and - $_COOKIE — are marked as tainted at request startup, - and the mark is tracked through string operations. When a tainted - string reaches a dangerous sink (output, SQL query, shell command, - file path, ...), taint raises a warning pointing at that spot. See - Propagation and Checked Sinks for - the complete lists. - - - Taint is a development and auditing tool, not a runtime defense: it - only reports possible problems and never blocks or alters data. It is - deliberately conservative and may over-report, so a clean run means - only "nothing taint could see", never "provably secure". Do not enable - it in production environments. - - - Taint example - - -]]> - - &example.outputs.similar; - - - - - - - &reference.taint.setup; - &reference.taint.detail; - &reference.taint.reference; - - - - diff --git a/reference/taint/configure.xml b/reference/taint/configure.xml deleted file mode 100644 index fe737e0327a0..000000000000 --- a/reference/taint/configure.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;taint. - - - - Install it with PECL: - - - - - - - - - The source code is hosted on - GitHub. To build the - extension from source: - - - - - - - Then enable the extension by adding - extension=taint.so (or extension=php_taint.dll - on Windows) to &php.ini;, and set - taint.enable to - 1. - - - - - Taint is a development and auditing tool. Do not enable it in - production environments: the instrumentation slows every request down - and disables the OPcache JIT, and the warnings may leak request data - into logs. - - -
    - - diff --git a/reference/taint/detail.xml b/reference/taint/detail.xml deleted file mode 100644 index 1c2cc8e0fb45..000000000000 --- a/reference/taint/detail.xml +++ /dev/null @@ -1,294 +0,0 @@ - - - - - Propagation and Checked Sinks - -
    - How the taint mark is propagated - - The taint mark is a single bit stored on the string itself, not on the - variable holding it. Assigning, passing or otherwise sharing a tainted - string keeps the mark. String concatenation and interpolation propagate - it as well: - - - - Operators which propagate the taint mark - - - - = (assignment, including list()/array destructuring) - - - . (concatenation) - - - .= (concatenating assignment) - - - "{$var}" (string interpolation, including the ROPE fast path) - - - -
    -
    - - In addition, taint understands a fixed set of string functions: when any - of the relevant string arguments is tainted, the returned string is - marked tainted too. Both the regular call and, on PHP 8.4+, the - frameless fast-path call are covered. - - - - Functions which propagate the taint mark - - - - trim, rtrim, ltrim - - - substr, strstr - - - str_replace, str_ireplace - - - str_pad, strtolower, strtoupper, strval - - - explode (every element of the resulting array) - - - implode/join (a tainted separator taints the result as well) - - - sprintf, vsprintf (only the %s specifier carries the mark; sprintf("%d", $t) returns a clean string) - - - dirname, basename, pathinfo - - - -
    -
    - - Any function taint does not explicitly understand returns a fresh, - unmarked string — including escaping helpers such as - htmlspecialchars, htmlentities or - mysqli_real_escape_string. This is deliberate: taint - over-reports rather than trying to decide whether a value is - safe for a particular output context. Use - untaint to clear the mark on values you have validated - yourself. - -
    - -
    - Where taint raises warnings - - When a tainted string reaches one of the sinks below, taint raises a - warning (by default an E_USER_WARNING; the level is - configurable via taint.error_level). - Only top-level string arguments are inspected; dumping an array that - merely contains tainted values does not warn. - - - - Output sinks - - - SinkChecked - - - - echo, print - the echoed/printed expression - - - printf, vprintf - the format string and the substituted values - - - print_r, var_dump, var_export - the value being dumped, when it is a string - - - exit/die with a message - the message - - - file_put_contents, fwrite, fputs to php://output - the data being written - - - -
    -
    - - - Filesystem sinks - - - SinkChecked - - - - fopen, opendir, unlink - the path - - - file, readfile, file_get_contents, highlight_file/show_source - the path - - - copy, rename, move_uploaded_file - both the source and destination paths - - - mkdir, rmdir, touch - the path - - - include, include_once, require, require_once - the file path - - - -
    -
    - - - SQL sinks - - - SinkChecked - - - - mysqli_query, mysqli_prepare, mysqli_real_query, mysqli_multi_query - the query string - - - mysql_query, sqlite_query, sqlite_single_query, oci_parse, pg_query, pg_send_query - the query string - - - mysqli::query, mysqli::prepare, mysqli::real_query, mysqli::multi_query - the query string - - - PDO::query, PDO::prepare, PDO::exec - the query string - - - SQLite3::query, SQLite3::prepare, SQLite3::exec, SQLiteDatabase::query, SQLiteDatabase::singleQuery - the query string - - - -
    -
    - - - Command execution sinks - - - SinkChecked - - - - exec, system, passthru, shell_exec (including the backtick operator) - the command string - - - proc_open, popen - the command string - - - eval - the evaluated code - - - dynamic calls such as $func(), $obj->$method(), call_user_func, array callables - the function/method/class name being resolved - - - preg_match, preg_match_all, preg_replace, preg_split, preg_grep, preg_replace_callback - the pattern (and the callback name for preg_replace_callback) - - - -
    -
    - - - Header and cookie sinks - - - SinkChecked - - - - header - the header string - - - setcookie, setrawcookie - the cookie name and value - - - -
    -
    - - - Other sinks - - - SinkChecked - - - - unserialize - the serialized string - - - mail - to, subject, additional parameters and additional headers (the message body is content and is not checked) - - - -
    -
    - - Warnings follow the format - function_name() [sink]: message, where - sink identifies the checked operation (for example - echo, include or the function name) and - the message describes what was found to be possibly tainted. - -
    - -
    - - diff --git a/reference/taint/functions/is-tainted.xml b/reference/taint/functions/is-tainted.xml deleted file mode 100644 index 9f6ec527df31..000000000000 --- a/reference/taint/functions/is-tainted.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - is_tainted - Check whether a string is tainted - - - - &reftitle.description; - - boolis_tainted - stringstring - - - Checks whether the given value carries the taint mark. Only strings can - ever be tainted; any other type returns &false;. - - - - - &reftitle.parameters; - - - string - - - The value to check. - - - - - - - - &reftitle.returnvalues; - - Returns &true; if the value is a tainted string, &false; otherwise. - Always returns &false; when - taint.enable is off. - - - - - &reftitle.examples; - - <function>is_tainted</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - taint - untaint - - - - - - - diff --git a/reference/taint/functions/taint.xml b/reference/taint/functions/taint.xml deleted file mode 100644 index cce73f9728df..000000000000 --- a/reference/taint/functions/taint.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - taint - Mark strings as tainted - - - - &reftitle.description; - - booltaint - stringstring - stringstrings - - - Manually marks the given strings as tainted, as if they had arrived - from user input. The variables are passed by reference, but the mark - itself is stored on the string rather than on the variable: every - variable sharing the same string becomes tainted at once. - - - This is mainly useful for testing, and for simulating user input in - CLI scripts where the $_GET, - $_POST and - $_COOKIE - superglobals are not populated. - - - - - &reftitle.parameters; - - - string - - - A variable holding the string to mark. - - - - - strings - - - Further variables to mark. - - - - - - - - &reftitle.returnvalues; - - Always returns &true;. When - taint.enable is off, the - function does nothing and still returns &true;. - - - - - &reftitle.examples; - - <function>taint</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.notes; - - - Only non-empty strings are marked; variables holding other types, or - empty strings, are silently ignored. - - - - - Interned, persistent and permanent strings (string literals, opcache - shared strings) can never carry the mark and are silently skipped. - - - - - - &reftitle.seealso; - - - untaint - is_tainted - - - - - - - diff --git a/reference/taint/functions/untaint.xml b/reference/taint/functions/untaint.xml deleted file mode 100644 index 27b14560fe67..000000000000 --- a/reference/taint/functions/untaint.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - untaint - Remove the taint mark from strings - - - - &reftitle.description; - - booluntaint - stringstring - stringstrings - - - Clears the taint mark on the given strings. - - - The mark is stored on the string itself, not on the variable, so this - clears it for every variable sharing the same string at once. Use it to - whitelist values you have validated yourself, for example after a strict - allow-list check. - - - - - &reftitle.parameters; - - - string - - - A variable holding the string to clean. - - - - - strings - - - Further variables to clean. - - - - - - - - &reftitle.returnvalues; - - Always returns &true;. When - taint.enable is off, the - function does nothing and still returns &true;. - - - - - &reftitle.examples; - - <function>untaint</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.notes; - - - Only string values can carry the mark; passing a non-string is a - no-op. - - - - - - &reftitle.seealso; - - - taint - is_tainted - - - - - - - diff --git a/reference/taint/ini.xml b/reference/taint/ini.xml deleted file mode 100644 index 8e2b3824e1f0..000000000000 --- a/reference/taint/ini.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - -
    - &reftitle.runtime; - &extension.runtime; - - - Taint &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - taint.enable - 0 - INI_SYSTEM - - - - taint.error_level - 512 (E_USER_WARNING) - INI_ALL - - - - -
    -
    - - &ini.descriptions.title; - - - - - - taint.enable - bool - - - - Master switch. When enabled, taint hooks the executor and marks - strings from $_GET, $_POST and - $_COOKIE as tainted at request startup. - - - This is an &php.ini;-only directive: enabling it requires a process - restart, so it cannot be toggled per request or per directory. - - - - Do not enable this directive in production environments: the - instrumentation slows every request down and is incompatible with - the OPcache JIT. - - - - - - - taint.error_level - int - - - - The error level used when taint reports a possibly tainted string. - Defaults to E_USER_WARNING (512). - - - Because this directive is INI_ALL, it can be - changed at runtime. For example, to silence taint warnings for the - current script: - - - - -]]> - - - - - - -
    - - diff --git a/reference/taint/reference.xml b/reference/taint/reference.xml deleted file mode 100644 index 1c818daa5122..000000000000 --- a/reference/taint/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - Taint &Functions; - - &reference.taint.entities.functions; - - - - diff --git a/reference/taint/setup.xml b/reference/taint/setup.xml deleted file mode 100644 index e754cedd9ea4..000000000000 --- a/reference/taint/setup.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - Taint 3.x requires PHP 8.0 or newer. For PHP 7.x use the taint 2.1.x - releases, and for PHP 5.x the taint 1.x releases. - -
    - - - &reference.taint.configure; - - - - &reference.taint.ini; - - -
    - &reftitle.resources; - - Taint defines no resource types. The taint mark itself is stored in the - internal zend_string structure, not in a user-visible - resource. - -
    - -
    - - diff --git a/reference/taint/versions.xml b/reference/taint/versions.xml deleted file mode 100644 index 2ece4f6ffe07..000000000000 --- a/reference/taint/versions.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - - - - - - - diff --git a/reference/tcpwrap/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/tcpwrap/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/tcpwrap/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/tcpwrap/book.xml b/reference/tcpwrap/book.xml deleted file mode 100644 index 1b31f4c36f33..000000000000 --- a/reference/tcpwrap/book.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - - - - TCP Wrappers - TCP - - - - &reftitle.intro; - - The TCP wrappers provides a classical Unix mechanism which has been - designed to check if the remote client is able to connect from the given IP - address. - - - - - &reference.tcpwrap.setup; - &reference.tcpwrap.reference; - - - - - diff --git a/reference/tcpwrap/configure.xml b/reference/tcpwrap/configure.xml deleted file mode 100644 index d2ef476ec6d4..000000000000 --- a/reference/tcpwrap/configure.xml +++ /dev/null @@ -1,33 +0,0 @@ - - -
    - &reftitle.install; - - &pecl.info; - &url.pecl.package;tcpwrap. - - - &pecl.windows.download; - -
    - - diff --git a/reference/tcpwrap/functions/tcpwrap-check.xml b/reference/tcpwrap/functions/tcpwrap-check.xml deleted file mode 100644 index 14f3669e646f..000000000000 --- a/reference/tcpwrap/functions/tcpwrap-check.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - tcpwrap_check - Performs a tcpwrap check - - - &reftitle.description; - - booltcpwrap_check - stringdaemon - stringaddress - stringuser - boolnodns&false; - - - This function consults the /etc/hosts.allow and - /etc/hosts.deny files to check if access to service - daemon should be granted or denied for a client. - - - - &reftitle.parameters; - - - - daemon - - - The service name. - - - - - address - - - The client remote address. Can be either an IP address or a domain name. - - - - - user - - - An optional user name. - - - - - nodns - - - If address looks like domain name then DNS is - used to resolve it to IP address; set nodns to - &true; to avoid this. - - - - - - - - &reftitle.returnvalues; - - This function returns &true; if access should be granted, &false; otherwise. - - - - &reftitle.examples; - - Deny all connections from localhost - - If your /etc/hosts.deny file contains: - - - - - - And your code looks like: - - - -]]> - - - - - &reftitle.seealso; - - For more details please consult hosts_access(3) man page. - - - - - diff --git a/reference/tcpwrap/reference.xml b/reference/tcpwrap/reference.xml deleted file mode 100644 index eeae41c61ce5..000000000000 --- a/reference/tcpwrap/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - TCP &Functions; - - &reference.tcpwrap.entities.functions; - - - - diff --git a/reference/tcpwrap/setup.xml b/reference/tcpwrap/setup.xml deleted file mode 100644 index 91b75ef13900..000000000000 --- a/reference/tcpwrap/setup.xml +++ /dev/null @@ -1,33 +0,0 @@ - - - - - &reftitle.setup; - - - &reference.tcpwrap.configure; - - - - - - diff --git a/reference/tcpwrap/versions.xml b/reference/tcpwrap/versions.xml deleted file mode 100644 index 7aad56180867..000000000000 --- a/reference/tcpwrap/versions.xml +++ /dev/null @@ -1,27 +0,0 @@ - - - - - - - - diff --git a/reference/trader/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/trader/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/trader/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/trader/book.xml b/reference/trader/book.xml deleted file mode 100644 index cf6538d96ccd..000000000000 --- a/reference/trader/book.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - Technical Analysis for Traders - Trader - - - &reftitle.intro; - - The trader extension is a free open source stock library based on TA-Lib. It's dedicated to trading software developers requiring to perform technical analysis of financial market data. Alongside many indicators like ADX, MACD, RSI, Stochastic, TRIX the candlestick pattern recognition and several vector arithmetic and algebraic functions are present. - - - Calculations can be done in two modes - TA-Lib and Metastock. Changing it using trader_set_compat() will affect the way some trader functions work. - - - Some trader functions provide different results depending of the "starting point" of the data being involved. This is often referred as a function having memories. An example of such function is the Exponential Moving Average. It is possible to control the unstable period (the amount of data to strip off) using trader_set_unstable_period() function. - - - Extended documentation about indicators, formulas and implementations in other programming languages can be found under &url.trader.lib;. - - - - &reference.trader.setup; - &reference.trader.constants; - - &reference.trader.reference; - - - - diff --git a/reference/trader/configure.xml b/reference/trader/configure.xml deleted file mode 100644 index e6b68662c2fe..000000000000 --- a/reference/trader/configure.xml +++ /dev/null @@ -1,35 +0,0 @@ - - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;trader - - - -
    - - - diff --git a/reference/trader/constants.xml b/reference/trader/constants.xml deleted file mode 100644 index a7ec666c3755..000000000000 --- a/reference/trader/constants.xml +++ /dev/null @@ -1,602 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - - - - TRADER_MA_TYPE_SMA - (int) - - - - - - - - - TRADER_MA_TYPE_EMA - (int) - - - - - - - - - TRADER_MA_TYPE_WMA - (int) - - - - - - - - - TRADER_MA_TYPE_DEMA - (int) - - - - - - - - - TRADER_MA_TYPE_TEMA - (int) - - - - - - - - - TRADER_MA_TYPE_TRIMA - (int) - - - - - - - - - TRADER_MA_TYPE_KAMA - (int) - - - - - - - - - TRADER_MA_TYPE_MAMA - (int) - - - - - - - - - TRADER_MA_TYPE_T3 - (int) - - - - - - - - - TRADER_REAL_MIN - (float) - - - - - - - - - TRADER_REAL_MAX - (float) - - - - - - - - - TRADER_FUNC_UNST_ADX - (int) - - - - - - - - - TRADER_FUNC_UNST_ADXR - (int) - - - - - - - - - TRADER_FUNC_UNST_ATR - (int) - - - - - - - - - TRADER_FUNC_UNST_CMO - (int) - - - - - - - - - TRADER_FUNC_UNST_DX - (int) - - - - - - - - - TRADER_FUNC_UNST_EMA - (int) - - - - - - - - - TRADER_FUNC_UNST_HT_DCPERIOD - (int) - - - - - - - - - TRADER_FUNC_UNST_HT_DCPHASE - (int) - - - - - - - - - TRADER_FUNC_UNST_HT_PHASOR - (int) - - - - - - - - - TRADER_FUNC_UNST_HT_SINE - (int) - - - - - - - - - TRADER_FUNC_UNST_HT_TRENDLINE - (int) - - - - - - - - - TRADER_FUNC_UNST_HT_TRENDMODE - (int) - - - - - - - - - TRADER_FUNC_UNST_KAMA - (int) - - - - - - - - - TRADER_FUNC_UNST_MAMA - (int) - - - - - - - - - TRADER_FUNC_UNST_MFI - (int) - - - - - - - - - TRADER_FUNC_UNST_MINUS_DI - (int) - - - - - - - - - TRADER_FUNC_UNST_MINUS_DM - (int) - - - - - - - - - TRADER_FUNC_UNST_NATR - (int) - - - - - - - - - TRADER_FUNC_UNST_PLUS_DI - (int) - - - - - - - - - TRADER_FUNC_UNST_PLUS_DM - (int) - - - - - - - - - TRADER_FUNC_UNST_RSI - (int) - - - - - - - - - TRADER_FUNC_UNST_STOCHRSI - (int) - - - - - - - - - TRADER_FUNC_UNST_T3 - (int) - - - - - - - - - TRADER_FUNC_UNST_ALL - (int) - - - - - - - - - TRADER_FUNC_UNST_NONE - (int) - - - - - - - - - TRADER_COMPATIBILITY_DEFAULT - (int) - - - - - - - - - TRADER_COMPATIBILITY_METASTOCK - (int) - - - - - - - - - TRADER_ERR_SUCCESS - (int) - - - - - - - - - TRADER_ERR_LIB_NOT_INITIALIZE - (int) - - - - - - - - - TRADER_ERR_BAD_PARAM - (int) - - - - - - - - - TRADER_ERR_ALLOC_ERR - (int) - - - - - - - - - TRADER_ERR_GROUP_NOT_FOUND - (int) - - - - - - - - - TRADER_ERR_FUNC_NOT_FOUND - (int) - - - - - - - - - TRADER_ERR_INVALID_HANDLE - (int) - - - - - - - - - TRADER_ERR_INVALID_PARAM_HOLDER - (int) - - - - - - - - - TRADER_ERR_INVALID_PARAM_HOLDER_TYPE - (int) - - - - - - - - - TRADER_ERR_INVALID_PARAM_FUNCTION - (int) - - - - - - - - - TRADER_ERR_INPUT_NOT_ALL_INITIALIZE - (int) - - - - - - - - - TRADER_ERR_OUTPUT_NOT_ALL_INITIALIZE - (int) - - - - - - - - - TRADER_ERR_OUT_OF_RANGE_START_INDEX - (int) - - - - - - - - - TRADER_ERR_OUT_OF_RANGE_END_INDEX - (int) - - - - - - - - - TRADER_ERR_INVALID_LIST_TYPE - (int) - - - - - - - - - TRADER_ERR_BAD_OBJECT - (int) - - - - - - - - - TRADER_ERR_NOT_SUPPORTED - (int) - - - - - - - - - TRADER_ERR_INTERNAL_ERROR - (int) - - - - - - - - - TRADER_ERR_UNKNOWN_ERROR - (int) - - - - - - - - - - - diff --git a/reference/trader/functions/trader-acos.xml b/reference/trader/functions/trader-acos.xml deleted file mode 100644 index bacee78ccd24..000000000000 --- a/reference/trader/functions/trader-acos.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - trader_acos - Vector Trigonometric ACos - - - - &reftitle.description; - - arraytrader_acos - arrayreal - - - Calculates the arc cosine for each value in - real and returns the resulting array. - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-ad.xml b/reference/trader/functions/trader-ad.xml deleted file mode 100644 index bcfd4fdd50f3..000000000000 --- a/reference/trader/functions/trader-ad.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_ad - Chaikin A/D Line - - - - &reftitle.description; - - arraytrader_ad - arrayhigh - arraylow - arrayclose - arrayvolume - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - volume - - - &trader.arg.array.of.real.volume; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-add.xml b/reference/trader/functions/trader-add.xml deleted file mode 100644 index 6cb48fd0f02d..000000000000 --- a/reference/trader/functions/trader-add.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - trader_add - Vector Arithmetic Add - - - - &reftitle.description; - - arraytrader_add - arrayreal0 - arrayreal1 - - - Calculates the vector addition of real0 to - real1 and returns the resulting vector. - - - - - &reftitle.parameters; - - - real0 - - - &trader.arg.array.of.real; - - - - - real1 - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-adosc.xml b/reference/trader/functions/trader-adosc.xml deleted file mode 100644 index c490998c5ea8..000000000000 --- a/reference/trader/functions/trader-adosc.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - trader_adosc - Chaikin A/D Oscillator - - - - &reftitle.description; - - arraytrader_adosc - arrayhigh - arraylow - arrayclose - arrayvolume - intfastPeriod - intslowPeriod - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - volume - - - &trader.arg.array.of.real.volume; - - - - - fastPeriod - - - &trader.arg.fast.period; - - - - - slowPeriod - - - &trader.arg.slow.period; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-adx.xml b/reference/trader/functions/trader-adx.xml deleted file mode 100644 index fc3acd73c184..000000000000 --- a/reference/trader/functions/trader-adx.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_adx - Average Directional Movement Index - - - - &reftitle.description; - - arraytrader_adx - arrayhigh - arraylow - arrayclose - inttimePeriod - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-adxr.xml b/reference/trader/functions/trader-adxr.xml deleted file mode 100644 index 8260d0965908..000000000000 --- a/reference/trader/functions/trader-adxr.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_adxr - Average Directional Movement Index Rating - - - - &reftitle.description; - - arraytrader_adxr - arrayhigh - arraylow - arrayclose - inttimePeriod - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-apo.xml b/reference/trader/functions/trader-apo.xml deleted file mode 100644 index af3071fc8792..000000000000 --- a/reference/trader/functions/trader-apo.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_apo - Absolute Price Oscillator - - - - &reftitle.description; - - arraytrader_apo - arrayreal - intfastPeriod - intslowPeriod - intmAType - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - fastPeriod - - - &trader.arg.fast.period; - - - - - slowPeriod - - - &trader.arg.slow.period; - - - - - mAType - - - &trader.arg.ma.type; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-aroon.xml b/reference/trader/functions/trader-aroon.xml deleted file mode 100644 index 7aa1702a6896..000000000000 --- a/reference/trader/functions/trader-aroon.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - trader_aroon - Aroon - - - - &reftitle.description; - - arraytrader_aroon - arrayhigh - arraylow - inttimePeriod - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-aroonosc.xml b/reference/trader/functions/trader-aroonosc.xml deleted file mode 100644 index 353920bbeafd..000000000000 --- a/reference/trader/functions/trader-aroonosc.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - trader_aroonosc - Aroon Oscillator - - - - &reftitle.description; - - arraytrader_aroonosc - arrayhigh - arraylow - inttimePeriod - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-asin.xml b/reference/trader/functions/trader-asin.xml deleted file mode 100644 index fc3a5d0d3ce9..000000000000 --- a/reference/trader/functions/trader-asin.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - trader_asin - Vector Trigonometric ASin - - - - &reftitle.description; - - arraytrader_asin - arrayreal - - - Calculates the arc sine for each value in - real and returns the resulting array. - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-atan.xml b/reference/trader/functions/trader-atan.xml deleted file mode 100644 index 7f8323b728ba..000000000000 --- a/reference/trader/functions/trader-atan.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - trader_atan - Vector Trigonometric ATan - - - - &reftitle.description; - - arraytrader_atan - arrayreal - - - Calculates the arc tangent for each value in - real and returns the resulting array. - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-atr.xml b/reference/trader/functions/trader-atr.xml deleted file mode 100644 index b7051da7575c..000000000000 --- a/reference/trader/functions/trader-atr.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_atr - Average True Range - - - - &reftitle.description; - - arraytrader_atr - arrayhigh - arraylow - arrayclose - inttimePeriod - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-avgprice.xml b/reference/trader/functions/trader-avgprice.xml deleted file mode 100644 index 1233f68a2a69..000000000000 --- a/reference/trader/functions/trader-avgprice.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_avgprice - Average Price - - - - &reftitle.description; - - arraytrader_avgprice - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-bbands.xml b/reference/trader/functions/trader-bbands.xml deleted file mode 100644 index 08274f21822c..000000000000 --- a/reference/trader/functions/trader-bbands.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - trader_bbands - Bollinger Bands - - - - &reftitle.description; - - arraytrader_bbands - arrayreal - inttimePeriod - floatnbDevUp - floatnbDevDn - intmAType - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - nbDevUp - - - &trader.arg.nbdevup; - - - - - nbDevDn - - - &trader.arg.nbdevdn; - - - - - mAType - - - &trader.arg.ma.type; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-beta.xml b/reference/trader/functions/trader-beta.xml deleted file mode 100644 index 1882bd894eaa..000000000000 --- a/reference/trader/functions/trader-beta.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - trader_beta - Beta - - - - &reftitle.description; - - arraytrader_beta - arrayreal0 - arrayreal1 - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real0 - - - &trader.arg.array.of.real; - - - - - real1 - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-bop.xml b/reference/trader/functions/trader-bop.xml deleted file mode 100644 index af873106c7bc..000000000000 --- a/reference/trader/functions/trader-bop.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_bop - Balance Of Power - - - - &reftitle.description; - - arraytrader_bop - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cci.xml b/reference/trader/functions/trader-cci.xml deleted file mode 100644 index 48ce0dc57081..000000000000 --- a/reference/trader/functions/trader-cci.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cci - Commodity Channel Index - - - - &reftitle.description; - - arraytrader_cci - arrayhigh - arraylow - arrayclose - inttimePeriod - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdl2crows.xml b/reference/trader/functions/trader-cdl2crows.xml deleted file mode 100644 index bc2f350bed6e..000000000000 --- a/reference/trader/functions/trader-cdl2crows.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdl2crows - Two Crows - - - - &reftitle.description; - - arraytrader_cdl2crows - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdl3blackcrows.xml b/reference/trader/functions/trader-cdl3blackcrows.xml deleted file mode 100644 index 8645eb7e1859..000000000000 --- a/reference/trader/functions/trader-cdl3blackcrows.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdl3blackcrows - Three Black Crows - - - - &reftitle.description; - - arraytrader_cdl3blackcrows - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdl3inside.xml b/reference/trader/functions/trader-cdl3inside.xml deleted file mode 100644 index d14260eaf148..000000000000 --- a/reference/trader/functions/trader-cdl3inside.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdl3inside - Three Inside Up/Down - - - - &reftitle.description; - - arraytrader_cdl3inside - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdl3linestrike.xml b/reference/trader/functions/trader-cdl3linestrike.xml deleted file mode 100644 index e5dc18263efc..000000000000 --- a/reference/trader/functions/trader-cdl3linestrike.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdl3linestrike - Three-Line Strike - - - - &reftitle.description; - - arraytrader_cdl3linestrike - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdl3outside.xml b/reference/trader/functions/trader-cdl3outside.xml deleted file mode 100644 index ca4ea91bd707..000000000000 --- a/reference/trader/functions/trader-cdl3outside.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdl3outside - Three Outside Up/Down - - - - &reftitle.description; - - arraytrader_cdl3outside - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdl3starsinsouth.xml b/reference/trader/functions/trader-cdl3starsinsouth.xml deleted file mode 100644 index 39ce3b2dd630..000000000000 --- a/reference/trader/functions/trader-cdl3starsinsouth.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdl3starsinsouth - Three Stars In The South - - - - &reftitle.description; - - arraytrader_cdl3starsinsouth - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdl3whitesoldiers.xml b/reference/trader/functions/trader-cdl3whitesoldiers.xml deleted file mode 100644 index 3a171b6a36ef..000000000000 --- a/reference/trader/functions/trader-cdl3whitesoldiers.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdl3whitesoldiers - Three Advancing White Soldiers - - - - &reftitle.description; - - arraytrader_cdl3whitesoldiers - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdlabandonedbaby.xml b/reference/trader/functions/trader-cdlabandonedbaby.xml deleted file mode 100644 index e67b1539cb7e..000000000000 --- a/reference/trader/functions/trader-cdlabandonedbaby.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - trader_cdlabandonedbaby - Abandoned Baby - - - - &reftitle.description; - - arraytrader_cdlabandonedbaby - arrayopen - arrayhigh - arraylow - arrayclose - floatpenetration - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - penetration - - - &trader.arg.penetration; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdladvanceblock.xml b/reference/trader/functions/trader-cdladvanceblock.xml deleted file mode 100644 index f79f83218254..000000000000 --- a/reference/trader/functions/trader-cdladvanceblock.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdladvanceblock - Advance Block - - - - &reftitle.description; - - arraytrader_cdladvanceblock - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdlbelthold.xml b/reference/trader/functions/trader-cdlbelthold.xml deleted file mode 100644 index 73ec15629503..000000000000 --- a/reference/trader/functions/trader-cdlbelthold.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdlbelthold - Belt-hold - - - - &reftitle.description; - - arraytrader_cdlbelthold - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdlbreakaway.xml b/reference/trader/functions/trader-cdlbreakaway.xml deleted file mode 100644 index d87f1d7c500e..000000000000 --- a/reference/trader/functions/trader-cdlbreakaway.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdlbreakaway - Breakaway - - - - &reftitle.description; - - arraytrader_cdlbreakaway - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdlclosingmarubozu.xml b/reference/trader/functions/trader-cdlclosingmarubozu.xml deleted file mode 100644 index 0bc0a33980b2..000000000000 --- a/reference/trader/functions/trader-cdlclosingmarubozu.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdlclosingmarubozu - Closing Marubozu - - - - &reftitle.description; - - arraytrader_cdlclosingmarubozu - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdlconcealbabyswall.xml b/reference/trader/functions/trader-cdlconcealbabyswall.xml deleted file mode 100644 index abe73f65911c..000000000000 --- a/reference/trader/functions/trader-cdlconcealbabyswall.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdlconcealbabyswall - Concealing Baby Swallow - - - - &reftitle.description; - - arraytrader_cdlconcealbabyswall - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdlcounterattack.xml b/reference/trader/functions/trader-cdlcounterattack.xml deleted file mode 100644 index ef75296537fe..000000000000 --- a/reference/trader/functions/trader-cdlcounterattack.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdlcounterattack - Counterattack - - - - &reftitle.description; - - arraytrader_cdlcounterattack - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdldarkcloudcover.xml b/reference/trader/functions/trader-cdldarkcloudcover.xml deleted file mode 100644 index 58cda82a79cf..000000000000 --- a/reference/trader/functions/trader-cdldarkcloudcover.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - trader_cdldarkcloudcover - Dark Cloud Cover - - - - &reftitle.description; - - arraytrader_cdldarkcloudcover - arrayopen - arrayhigh - arraylow - arrayclose - floatpenetration - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - penetration - - - &trader.arg.penetration; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdldoji.xml b/reference/trader/functions/trader-cdldoji.xml deleted file mode 100644 index f66841a8d8b7..000000000000 --- a/reference/trader/functions/trader-cdldoji.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdldoji - Doji - - - - &reftitle.description; - - arraytrader_cdldoji - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdldojistar.xml b/reference/trader/functions/trader-cdldojistar.xml deleted file mode 100644 index ae133149c50f..000000000000 --- a/reference/trader/functions/trader-cdldojistar.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdldojistar - Doji Star - - - - &reftitle.description; - - arraytrader_cdldojistar - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdldragonflydoji.xml b/reference/trader/functions/trader-cdldragonflydoji.xml deleted file mode 100644 index 9484bfb999e3..000000000000 --- a/reference/trader/functions/trader-cdldragonflydoji.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdldragonflydoji - Dragonfly Doji - - - - &reftitle.description; - - arraytrader_cdldragonflydoji - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdlengulfing.xml b/reference/trader/functions/trader-cdlengulfing.xml deleted file mode 100644 index 75d35ac62907..000000000000 --- a/reference/trader/functions/trader-cdlengulfing.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdlengulfing - Engulfing Pattern - - - - &reftitle.description; - - arraytrader_cdlengulfing - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdleveningdojistar.xml b/reference/trader/functions/trader-cdleveningdojistar.xml deleted file mode 100644 index aaf73002a669..000000000000 --- a/reference/trader/functions/trader-cdleveningdojistar.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - trader_cdleveningdojistar - Evening Doji Star - - - - &reftitle.description; - - arraytrader_cdleveningdojistar - arrayopen - arrayhigh - arraylow - arrayclose - floatpenetration - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - penetration - - - &trader.arg.penetration; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdleveningstar.xml b/reference/trader/functions/trader-cdleveningstar.xml deleted file mode 100644 index 2d7d1046053b..000000000000 --- a/reference/trader/functions/trader-cdleveningstar.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - trader_cdleveningstar - Evening Star - - - - &reftitle.description; - - arraytrader_cdleveningstar - arrayopen - arrayhigh - arraylow - arrayclose - floatpenetration - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - penetration - - - &trader.arg.penetration; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdlgapsidesidewhite.xml b/reference/trader/functions/trader-cdlgapsidesidewhite.xml deleted file mode 100644 index edfc1216ad51..000000000000 --- a/reference/trader/functions/trader-cdlgapsidesidewhite.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdlgapsidesidewhite - Up/Down-gap side-by-side white lines - - - - &reftitle.description; - - arraytrader_cdlgapsidesidewhite - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdlgravestonedoji.xml b/reference/trader/functions/trader-cdlgravestonedoji.xml deleted file mode 100644 index ade8b0b5959f..000000000000 --- a/reference/trader/functions/trader-cdlgravestonedoji.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdlgravestonedoji - Gravestone Doji - - - - &reftitle.description; - - arraytrader_cdlgravestonedoji - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdlhammer.xml b/reference/trader/functions/trader-cdlhammer.xml deleted file mode 100644 index 2bc4cd8b4c6b..000000000000 --- a/reference/trader/functions/trader-cdlhammer.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdlhammer - Hammer - - - - &reftitle.description; - - arraytrader_cdlhammer - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdlhangingman.xml b/reference/trader/functions/trader-cdlhangingman.xml deleted file mode 100644 index 52233e2128a3..000000000000 --- a/reference/trader/functions/trader-cdlhangingman.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdlhangingman - Hanging Man - - - - &reftitle.description; - - arraytrader_cdlhangingman - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdlharami.xml b/reference/trader/functions/trader-cdlharami.xml deleted file mode 100644 index bd6e3ed3f9a1..000000000000 --- a/reference/trader/functions/trader-cdlharami.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdlharami - Harami Pattern - - - - &reftitle.description; - - arraytrader_cdlharami - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdlharamicross.xml b/reference/trader/functions/trader-cdlharamicross.xml deleted file mode 100644 index b171fa0efe6e..000000000000 --- a/reference/trader/functions/trader-cdlharamicross.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdlharamicross - Harami Cross Pattern - - - - &reftitle.description; - - arraytrader_cdlharamicross - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdlhighwave.xml b/reference/trader/functions/trader-cdlhighwave.xml deleted file mode 100644 index ff36abba0da0..000000000000 --- a/reference/trader/functions/trader-cdlhighwave.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdlhighwave - High-Wave Candle - - - - &reftitle.description; - - arraytrader_cdlhighwave - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdlhikkake.xml b/reference/trader/functions/trader-cdlhikkake.xml deleted file mode 100644 index 926772637f7b..000000000000 --- a/reference/trader/functions/trader-cdlhikkake.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdlhikkake - Hikkake Pattern - - - - &reftitle.description; - - arraytrader_cdlhikkake - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdlhikkakemod.xml b/reference/trader/functions/trader-cdlhikkakemod.xml deleted file mode 100644 index 55d1398a646c..000000000000 --- a/reference/trader/functions/trader-cdlhikkakemod.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdlhikkakemod - Modified Hikkake Pattern - - - - &reftitle.description; - - arraytrader_cdlhikkakemod - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdlhomingpigeon.xml b/reference/trader/functions/trader-cdlhomingpigeon.xml deleted file mode 100644 index cd21c519b33c..000000000000 --- a/reference/trader/functions/trader-cdlhomingpigeon.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdlhomingpigeon - Homing Pigeon - - - - &reftitle.description; - - arraytrader_cdlhomingpigeon - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdlidentical3crows.xml b/reference/trader/functions/trader-cdlidentical3crows.xml deleted file mode 100644 index 584b8cbdf673..000000000000 --- a/reference/trader/functions/trader-cdlidentical3crows.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdlidentical3crows - Identical Three Crows - - - - &reftitle.description; - - arraytrader_cdlidentical3crows - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdlinneck.xml b/reference/trader/functions/trader-cdlinneck.xml deleted file mode 100644 index e17ae3705e8a..000000000000 --- a/reference/trader/functions/trader-cdlinneck.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdlinneck - In-Neck Pattern - - - - &reftitle.description; - - arraytrader_cdlinneck - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdlinvertedhammer.xml b/reference/trader/functions/trader-cdlinvertedhammer.xml deleted file mode 100644 index f287f51d2f62..000000000000 --- a/reference/trader/functions/trader-cdlinvertedhammer.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdlinvertedhammer - Inverted Hammer - - - - &reftitle.description; - - arraytrader_cdlinvertedhammer - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdlkicking.xml b/reference/trader/functions/trader-cdlkicking.xml deleted file mode 100644 index 574f33338c4f..000000000000 --- a/reference/trader/functions/trader-cdlkicking.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdlkicking - Kicking - - - - &reftitle.description; - - arraytrader_cdlkicking - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdlkickingbylength.xml b/reference/trader/functions/trader-cdlkickingbylength.xml deleted file mode 100644 index 5c445be7a8df..000000000000 --- a/reference/trader/functions/trader-cdlkickingbylength.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdlkickingbylength - Kicking - bull/bear determined by the longer marubozu - - - - &reftitle.description; - - arraytrader_cdlkickingbylength - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdlladderbottom.xml b/reference/trader/functions/trader-cdlladderbottom.xml deleted file mode 100644 index e926abd550ca..000000000000 --- a/reference/trader/functions/trader-cdlladderbottom.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdlladderbottom - Ladder Bottom - - - - &reftitle.description; - - arraytrader_cdlladderbottom - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdllongleggeddoji.xml b/reference/trader/functions/trader-cdllongleggeddoji.xml deleted file mode 100644 index 763eaf7c8483..000000000000 --- a/reference/trader/functions/trader-cdllongleggeddoji.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdllongleggeddoji - Long Legged Doji - - - - &reftitle.description; - - arraytrader_cdllongleggeddoji - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdllongline.xml b/reference/trader/functions/trader-cdllongline.xml deleted file mode 100644 index 44f95bdb7f00..000000000000 --- a/reference/trader/functions/trader-cdllongline.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdllongline - Long Line Candle - - - - &reftitle.description; - - arraytrader_cdllongline - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdlmarubozu.xml b/reference/trader/functions/trader-cdlmarubozu.xml deleted file mode 100644 index 54178ecca55b..000000000000 --- a/reference/trader/functions/trader-cdlmarubozu.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdlmarubozu - Marubozu - - - - &reftitle.description; - - arraytrader_cdlmarubozu - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdlmatchinglow.xml b/reference/trader/functions/trader-cdlmatchinglow.xml deleted file mode 100644 index 4aad7898350a..000000000000 --- a/reference/trader/functions/trader-cdlmatchinglow.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdlmatchinglow - Matching Low - - - - &reftitle.description; - - arraytrader_cdlmatchinglow - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdlmathold.xml b/reference/trader/functions/trader-cdlmathold.xml deleted file mode 100644 index 3fa20a2cb532..000000000000 --- a/reference/trader/functions/trader-cdlmathold.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - trader_cdlmathold - Mat Hold - - - - &reftitle.description; - - arraytrader_cdlmathold - arrayopen - arrayhigh - arraylow - arrayclose - floatpenetration - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - penetration - - - &trader.arg.penetration; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdlmorningdojistar.xml b/reference/trader/functions/trader-cdlmorningdojistar.xml deleted file mode 100644 index d730ce517742..000000000000 --- a/reference/trader/functions/trader-cdlmorningdojistar.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - trader_cdlmorningdojistar - Morning Doji Star - - - - &reftitle.description; - - arraytrader_cdlmorningdojistar - arrayopen - arrayhigh - arraylow - arrayclose - floatpenetration - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - penetration - - - &trader.arg.penetration; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdlmorningstar.xml b/reference/trader/functions/trader-cdlmorningstar.xml deleted file mode 100644 index 4d2859feadf3..000000000000 --- a/reference/trader/functions/trader-cdlmorningstar.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - trader_cdlmorningstar - Morning Star - - - - &reftitle.description; - - arraytrader_cdlmorningstar - arrayopen - arrayhigh - arraylow - arrayclose - floatpenetration - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - penetration - - - &trader.arg.penetration; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdlonneck.xml b/reference/trader/functions/trader-cdlonneck.xml deleted file mode 100644 index 6cbb6376ba7b..000000000000 --- a/reference/trader/functions/trader-cdlonneck.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdlonneck - On-Neck Pattern - - - - &reftitle.description; - - arraytrader_cdlonneck - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdlpiercing.xml b/reference/trader/functions/trader-cdlpiercing.xml deleted file mode 100644 index 5805177dcaec..000000000000 --- a/reference/trader/functions/trader-cdlpiercing.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdlpiercing - Piercing Pattern - - - - &reftitle.description; - - arraytrader_cdlpiercing - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdlrickshawman.xml b/reference/trader/functions/trader-cdlrickshawman.xml deleted file mode 100644 index 7a53148ec065..000000000000 --- a/reference/trader/functions/trader-cdlrickshawman.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdlrickshawman - Rickshaw Man - - - - &reftitle.description; - - arraytrader_cdlrickshawman - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdlrisefall3methods.xml b/reference/trader/functions/trader-cdlrisefall3methods.xml deleted file mode 100644 index 3c6b570eb8b1..000000000000 --- a/reference/trader/functions/trader-cdlrisefall3methods.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdlrisefall3methods - Rising/Falling Three Methods - - - - &reftitle.description; - - arraytrader_cdlrisefall3methods - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdlseparatinglines.xml b/reference/trader/functions/trader-cdlseparatinglines.xml deleted file mode 100644 index 386075fb44bb..000000000000 --- a/reference/trader/functions/trader-cdlseparatinglines.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdlseparatinglines - Separating Lines - - - - &reftitle.description; - - arraytrader_cdlseparatinglines - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdlshootingstar.xml b/reference/trader/functions/trader-cdlshootingstar.xml deleted file mode 100644 index 9496a2cbf701..000000000000 --- a/reference/trader/functions/trader-cdlshootingstar.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdlshootingstar - Shooting Star - - - - &reftitle.description; - - arraytrader_cdlshootingstar - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdlshortline.xml b/reference/trader/functions/trader-cdlshortline.xml deleted file mode 100644 index 6cd1fd1c8131..000000000000 --- a/reference/trader/functions/trader-cdlshortline.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdlshortline - Short Line Candle - - - - &reftitle.description; - - arraytrader_cdlshortline - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdlspinningtop.xml b/reference/trader/functions/trader-cdlspinningtop.xml deleted file mode 100644 index 0da1ef5bceaa..000000000000 --- a/reference/trader/functions/trader-cdlspinningtop.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdlspinningtop - Spinning Top - - - - &reftitle.description; - - arraytrader_cdlspinningtop - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdlstalledpattern.xml b/reference/trader/functions/trader-cdlstalledpattern.xml deleted file mode 100644 index b2b3b88973c6..000000000000 --- a/reference/trader/functions/trader-cdlstalledpattern.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdlstalledpattern - Stalled Pattern - - - - &reftitle.description; - - arraytrader_cdlstalledpattern - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdlsticksandwich.xml b/reference/trader/functions/trader-cdlsticksandwich.xml deleted file mode 100644 index c10168725dc3..000000000000 --- a/reference/trader/functions/trader-cdlsticksandwich.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdlsticksandwich - Stick Sandwich - - - - &reftitle.description; - - arraytrader_cdlsticksandwich - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdltakuri.xml b/reference/trader/functions/trader-cdltakuri.xml deleted file mode 100644 index 775da73f7714..000000000000 --- a/reference/trader/functions/trader-cdltakuri.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdltakuri - Takuri (Dragonfly Doji with very long lower shadow) - - - - &reftitle.description; - - arraytrader_cdltakuri - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdltasukigap.xml b/reference/trader/functions/trader-cdltasukigap.xml deleted file mode 100644 index 3406811ab29e..000000000000 --- a/reference/trader/functions/trader-cdltasukigap.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdltasukigap - Tasuki Gap - - - - &reftitle.description; - - arraytrader_cdltasukigap - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdlthrusting.xml b/reference/trader/functions/trader-cdlthrusting.xml deleted file mode 100644 index 843d05e12704..000000000000 --- a/reference/trader/functions/trader-cdlthrusting.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdlthrusting - Thrusting Pattern - - - - &reftitle.description; - - arraytrader_cdlthrusting - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdltristar.xml b/reference/trader/functions/trader-cdltristar.xml deleted file mode 100644 index 1c7c121cbf57..000000000000 --- a/reference/trader/functions/trader-cdltristar.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdltristar - Tristar Pattern - - - - &reftitle.description; - - arraytrader_cdltristar - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdlunique3river.xml b/reference/trader/functions/trader-cdlunique3river.xml deleted file mode 100644 index fbe8cc7d156c..000000000000 --- a/reference/trader/functions/trader-cdlunique3river.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdlunique3river - Unique 3 River - - - - &reftitle.description; - - arraytrader_cdlunique3river - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdlupsidegap2crows.xml b/reference/trader/functions/trader-cdlupsidegap2crows.xml deleted file mode 100644 index 9917d41e2c46..000000000000 --- a/reference/trader/functions/trader-cdlupsidegap2crows.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdlupsidegap2crows - Upside Gap Two Crows - - - - &reftitle.description; - - arraytrader_cdlupsidegap2crows - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cdlxsidegap3methods.xml b/reference/trader/functions/trader-cdlxsidegap3methods.xml deleted file mode 100644 index 83093c09bff6..000000000000 --- a/reference/trader/functions/trader-cdlxsidegap3methods.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_cdlxsidegap3methods - Upside/Downside Gap Three Methods - - - - &reftitle.description; - - arraytrader_cdlxsidegap3methods - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-ceil.xml b/reference/trader/functions/trader-ceil.xml deleted file mode 100644 index 4da33e05b32b..000000000000 --- a/reference/trader/functions/trader-ceil.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - trader_ceil - Vector Ceil - - - - &reftitle.description; - - arraytrader_ceil - arrayreal - - - Calculates the next highest integer for each value in - real and returns the resulting array. - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cmo.xml b/reference/trader/functions/trader-cmo.xml deleted file mode 100644 index 165d3849930d..000000000000 --- a/reference/trader/functions/trader-cmo.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - trader_cmo - Chande Momentum Oscillator - - - - &reftitle.description; - - arraytrader_cmo - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-correl.xml b/reference/trader/functions/trader-correl.xml deleted file mode 100644 index a719766719c8..000000000000 --- a/reference/trader/functions/trader-correl.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - trader_correl - Pearson's Correlation Coefficient (r) - - - - &reftitle.description; - - arraytrader_correl - arrayreal0 - arrayreal1 - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real0 - - - &trader.arg.array.of.real; - - - - - real1 - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cos.xml b/reference/trader/functions/trader-cos.xml deleted file mode 100644 index cc447f949e91..000000000000 --- a/reference/trader/functions/trader-cos.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - trader_cos - Vector Trigonometric Cos - - - - &reftitle.description; - - arraytrader_cos - arrayreal - - - Calculates the cosine for each value in - real and returns the resulting array. - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-cosh.xml b/reference/trader/functions/trader-cosh.xml deleted file mode 100644 index 73c310cdcbad..000000000000 --- a/reference/trader/functions/trader-cosh.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - trader_cosh - Vector Trigonometric Cosh - - - - &reftitle.description; - - arraytrader_cosh - arrayreal - - - Calculates the hyperbolic cosine for each value in - real and returns the resulting array. - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-dema.xml b/reference/trader/functions/trader-dema.xml deleted file mode 100644 index 52126d451d48..000000000000 --- a/reference/trader/functions/trader-dema.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - trader_dema - Double Exponential Moving Average - - - - &reftitle.description; - - arraytrader_dema - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-div.xml b/reference/trader/functions/trader-div.xml deleted file mode 100644 index 43c7b2f5538e..000000000000 --- a/reference/trader/functions/trader-div.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - trader_div - Vector Arithmetic Div - - - - &reftitle.description; - - arraytrader_div - arrayreal0 - arrayreal1 - - - Divides each value from real0 by the corresponding - value from real1 and returns the resulting array. - - - - - &reftitle.parameters; - - - real0 - - - &trader.arg.array.of.real; - - - - - real1 - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-dx.xml b/reference/trader/functions/trader-dx.xml deleted file mode 100644 index 99a10c481594..000000000000 --- a/reference/trader/functions/trader-dx.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_dx - Directional Movement Index - - - - &reftitle.description; - - arraytrader_dx - arrayhigh - arraylow - arrayclose - inttimePeriod - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-ema.xml b/reference/trader/functions/trader-ema.xml deleted file mode 100644 index c9aa231c5d4d..000000000000 --- a/reference/trader/functions/trader-ema.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - trader_ema - Exponential Moving Average - - - - &reftitle.description; - - arraytrader_ema - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-errno.xml b/reference/trader/functions/trader-errno.xml deleted file mode 100644 index e1cfc4da3ce4..000000000000 --- a/reference/trader/functions/trader-errno.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - trader_errno - Get error code - - - - &reftitle.description; - - inttrader_errno - - - - Get error code of the last operation. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - Returns the error code identified by one of the TRADER_ERR_* constants. - - - - diff --git a/reference/trader/functions/trader-exp.xml b/reference/trader/functions/trader-exp.xml deleted file mode 100644 index 186e1fec8dd1..000000000000 --- a/reference/trader/functions/trader-exp.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - trader_exp - Vector Arithmetic Exp - - - - &reftitle.description; - - arraytrader_exp - arrayreal - - - Calculates e raised to the power of each value in real. Returns an array with the calculated data. - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-floor.xml b/reference/trader/functions/trader-floor.xml deleted file mode 100644 index 0ae61f3632bf..000000000000 --- a/reference/trader/functions/trader-floor.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - trader_floor - Vector Floor - - - - &reftitle.description; - - arraytrader_floor - arrayreal - - - Calculates the next lowest integer for each value in - real and returns the resulting array. - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-get-compat.xml b/reference/trader/functions/trader-get-compat.xml deleted file mode 100644 index 05512ee73a0b..000000000000 --- a/reference/trader/functions/trader-get-compat.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - trader_get_compat - Get compatibility mode - - - - &reftitle.description; - - inttrader_get_compat - - - - Get compatibility mode which affects the way calculations are done by all the extension functions. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - Returns the compatibility mode id which can be identified by TRADER_COMPATIBILITY_* series of constants. - - - - - diff --git a/reference/trader/functions/trader-get-unstable-period.xml b/reference/trader/functions/trader-get-unstable-period.xml deleted file mode 100644 index e71f9c420aad..000000000000 --- a/reference/trader/functions/trader-get-unstable-period.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - trader_get_unstable_period - Get unstable period - - - - &reftitle.description; - - inttrader_get_unstable_period - intfunctionId - - - Get unstable period factor for a particular function. - - - - - &reftitle.parameters; - - - functionId - - - Function ID the factor to be read for. TRADER_FUNC_UNST_* series of constants should be used. - - - - - - - - &reftitle.returnvalues; - Returns the unstable period factor for the corresponding function. - - - - - - diff --git a/reference/trader/functions/trader-ht-dcperiod.xml b/reference/trader/functions/trader-ht-dcperiod.xml deleted file mode 100644 index 86e5efef5aae..000000000000 --- a/reference/trader/functions/trader-ht-dcperiod.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - trader_ht_dcperiod - Hilbert Transform - Dominant Cycle Period - - - - &reftitle.description; - - arraytrader_ht_dcperiod - arrayreal - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-ht-dcphase.xml b/reference/trader/functions/trader-ht-dcphase.xml deleted file mode 100644 index af700e60fa62..000000000000 --- a/reference/trader/functions/trader-ht-dcphase.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - trader_ht_dcphase - Hilbert Transform - Dominant Cycle Phase - - - - &reftitle.description; - - arraytrader_ht_dcphase - arrayreal - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-ht-phasor.xml b/reference/trader/functions/trader-ht-phasor.xml deleted file mode 100644 index 8c22813be893..000000000000 --- a/reference/trader/functions/trader-ht-phasor.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - trader_ht_phasor - Hilbert Transform - Phasor Components - - - - &reftitle.description; - - arraytrader_ht_phasor - arrayreal - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-ht-sine.xml b/reference/trader/functions/trader-ht-sine.xml deleted file mode 100644 index eff84c895392..000000000000 --- a/reference/trader/functions/trader-ht-sine.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - trader_ht_sine - Hilbert Transform - SineWave - - - - &reftitle.description; - - arraytrader_ht_sine - arrayreal - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-ht-trendline.xml b/reference/trader/functions/trader-ht-trendline.xml deleted file mode 100644 index b2fb4120aab7..000000000000 --- a/reference/trader/functions/trader-ht-trendline.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - trader_ht_trendline - Hilbert Transform - Instantaneous Trendline - - - - &reftitle.description; - - arraytrader_ht_trendline - arrayreal - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-ht-trendmode.xml b/reference/trader/functions/trader-ht-trendmode.xml deleted file mode 100644 index 22d17939caa1..000000000000 --- a/reference/trader/functions/trader-ht-trendmode.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - trader_ht_trendmode - Hilbert Transform - Trend vs Cycle Mode - - - - &reftitle.description; - - arraytrader_ht_trendmode - arrayreal - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-kama.xml b/reference/trader/functions/trader-kama.xml deleted file mode 100644 index 38a10b0c110a..000000000000 --- a/reference/trader/functions/trader-kama.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - trader_kama - Kaufman Adaptive Moving Average - - - - &reftitle.description; - - arraytrader_kama - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-linearreg-angle.xml b/reference/trader/functions/trader-linearreg-angle.xml deleted file mode 100644 index 766fb62fad92..000000000000 --- a/reference/trader/functions/trader-linearreg-angle.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - trader_linearreg_angle - Linear Regression Angle - - - - &reftitle.description; - - arraytrader_linearreg_angle - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-linearreg-intercept.xml b/reference/trader/functions/trader-linearreg-intercept.xml deleted file mode 100644 index 7c4b07876e22..000000000000 --- a/reference/trader/functions/trader-linearreg-intercept.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - trader_linearreg_intercept - Linear Regression Intercept - - - - &reftitle.description; - - arraytrader_linearreg_intercept - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-linearreg-slope.xml b/reference/trader/functions/trader-linearreg-slope.xml deleted file mode 100644 index 5e0e361e0016..000000000000 --- a/reference/trader/functions/trader-linearreg-slope.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - trader_linearreg_slope - Linear Regression Slope - - - - &reftitle.description; - - arraytrader_linearreg_slope - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-linearreg.xml b/reference/trader/functions/trader-linearreg.xml deleted file mode 100644 index 39891f4e1be5..000000000000 --- a/reference/trader/functions/trader-linearreg.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - trader_linearreg - Linear Regression - - - - &reftitle.description; - - arraytrader_linearreg - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-ln.xml b/reference/trader/functions/trader-ln.xml deleted file mode 100644 index 9e673d40b4d6..000000000000 --- a/reference/trader/functions/trader-ln.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - trader_ln - Vector Log Natural - - - - &reftitle.description; - - arraytrader_ln - arrayreal - - - Calculates the natural logarithm for each value in - real and returns the resulting array. - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-log10.xml b/reference/trader/functions/trader-log10.xml deleted file mode 100644 index bb2c3ebc8767..000000000000 --- a/reference/trader/functions/trader-log10.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - trader_log10 - Vector Log10 - - - - &reftitle.description; - - arraytrader_log10 - arrayreal - - - Calculates the base-10 logarithm for each value in - real and returns the resulting array. - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-ma.xml b/reference/trader/functions/trader-ma.xml deleted file mode 100644 index 70edcdd4fcd2..000000000000 --- a/reference/trader/functions/trader-ma.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - trader_ma - Moving average - - - - &reftitle.description; - - arraytrader_ma - arrayreal - inttimePeriod - intmAType - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - mAType - - - &trader.arg.ma.type; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-macd.xml b/reference/trader/functions/trader-macd.xml deleted file mode 100644 index 23579d759fa4..000000000000 --- a/reference/trader/functions/trader-macd.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_macd - Moving Average Convergence/Divergence - - - - &reftitle.description; - - arraytrader_macd - arrayreal - intfastPeriod - intslowPeriod - intsignalPeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - fastPeriod - - - &trader.arg.fast.period; - - - - - slowPeriod - - - &trader.arg.slow.period; - - - - - signalPeriod - - - &trader.arg.signal.period; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-macdext.xml b/reference/trader/functions/trader-macdext.xml deleted file mode 100644 index cc45d1c97074..000000000000 --- a/reference/trader/functions/trader-macdext.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - trader_macdext - MACD with controllable MA type - - - - &reftitle.description; - - arraytrader_macdext - arrayreal - intfastPeriod - intfastMAType - intslowPeriod - intslowMAType - intsignalPeriod - intsignalMAType - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - fastPeriod - - - &trader.arg.fast.period; - - - - - fastMAType - - - &trader.arg.fast.ma.type; - - - - - slowPeriod - - - &trader.arg.slow.period; - - - - - slowMAType - - - &trader.arg.slow.ma.type; - - - - - signalPeriod - - - &trader.arg.signal.period; - - - - - signalMAType - - - &trader.arg.signal.ma.type; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-macdfix.xml b/reference/trader/functions/trader-macdfix.xml deleted file mode 100644 index e6c2d025068b..000000000000 --- a/reference/trader/functions/trader-macdfix.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - trader_macdfix - Moving Average Convergence/Divergence Fix 12/26 - - - - &reftitle.description; - - arraytrader_macdfix - arrayreal - intsignalPeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - signalPeriod - - - &trader.arg.signal.period; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-mama.xml b/reference/trader/functions/trader-mama.xml deleted file mode 100644 index 0ea5e2d1a11a..000000000000 --- a/reference/trader/functions/trader-mama.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - trader_mama - MESA Adaptive Moving Average - - - - &reftitle.description; - - arraytrader_mama - arrayreal - floatfastLimit - floatslowLimit - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - fastLimit - - - &trader.arg.fast.limit; - - - - - slowLimit - - - &trader.arg.slow.limit; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-mavp.xml b/reference/trader/functions/trader-mavp.xml deleted file mode 100644 index 3ca71ad07905..000000000000 --- a/reference/trader/functions/trader-mavp.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - trader_mavp - Moving average with variable period - - - - &reftitle.description; - - arraytrader_mavp - arrayreal - arrayperiods - intminPeriod - intmaxPeriod - intmAType - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - periods - - - &trader.arg.array.of.real.periods; - - - - - minPeriod - - - &trader.arg.min.period; - - - - - maxPeriod - - - &trader.arg.max.period; - - - - - mAType - - - &trader.arg.ma.type; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-max.xml b/reference/trader/functions/trader-max.xml deleted file mode 100644 index e83bcffc3b91..000000000000 --- a/reference/trader/functions/trader-max.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - trader_max - Highest value over a specified period - - - - &reftitle.description; - - arraytrader_max - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-maxindex.xml b/reference/trader/functions/trader-maxindex.xml deleted file mode 100644 index 93cd40c87407..000000000000 --- a/reference/trader/functions/trader-maxindex.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - trader_maxindex - Index of highest value over a specified period - - - - &reftitle.description; - - arraytrader_maxindex - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-medprice.xml b/reference/trader/functions/trader-medprice.xml deleted file mode 100644 index c18104d29ae0..000000000000 --- a/reference/trader/functions/trader-medprice.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - trader_medprice - Median Price - - - - &reftitle.description; - - arraytrader_medprice - arrayhigh - arraylow - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-mfi.xml b/reference/trader/functions/trader-mfi.xml deleted file mode 100644 index d01af78bba7c..000000000000 --- a/reference/trader/functions/trader-mfi.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - trader_mfi - Money Flow Index - - - - &reftitle.description; - - arraytrader_mfi - arrayhigh - arraylow - arrayclose - arrayvolume - inttimePeriod - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - volume - - - &trader.arg.array.of.real.volume; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-midpoint.xml b/reference/trader/functions/trader-midpoint.xml deleted file mode 100644 index fbcfa8cc9033..000000000000 --- a/reference/trader/functions/trader-midpoint.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - trader_midpoint - MidPoint over period - - - - &reftitle.description; - - arraytrader_midpoint - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-midprice.xml b/reference/trader/functions/trader-midprice.xml deleted file mode 100644 index 9a46c5d0afe4..000000000000 --- a/reference/trader/functions/trader-midprice.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - trader_midprice - Midpoint Price over period - - - - &reftitle.description; - - arraytrader_midprice - arrayhigh - arraylow - inttimePeriod - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-min.xml b/reference/trader/functions/trader-min.xml deleted file mode 100644 index ca6754641b20..000000000000 --- a/reference/trader/functions/trader-min.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - trader_min - Lowest value over a specified period - - - - &reftitle.description; - - arraytrader_min - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-minindex.xml b/reference/trader/functions/trader-minindex.xml deleted file mode 100644 index 57f1cfffd51d..000000000000 --- a/reference/trader/functions/trader-minindex.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - trader_minindex - Index of lowest value over a specified period - - - - &reftitle.description; - - arraytrader_minindex - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-minmax.xml b/reference/trader/functions/trader-minmax.xml deleted file mode 100644 index 0c15e8835128..000000000000 --- a/reference/trader/functions/trader-minmax.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - trader_minmax - Lowest and highest values over a specified period - - - - &reftitle.description; - - arraytrader_minmax - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-minmaxindex.xml b/reference/trader/functions/trader-minmaxindex.xml deleted file mode 100644 index 92696e691787..000000000000 --- a/reference/trader/functions/trader-minmaxindex.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - trader_minmaxindex - Indexes of lowest and highest values over a specified period - - - - &reftitle.description; - - arraytrader_minmaxindex - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-minus-di.xml b/reference/trader/functions/trader-minus-di.xml deleted file mode 100644 index 4e96bfc22578..000000000000 --- a/reference/trader/functions/trader-minus-di.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_minus_di - Minus Directional Indicator - - - - &reftitle.description; - - arraytrader_minus_di - arrayhigh - arraylow - arrayclose - inttimePeriod - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-minus-dm.xml b/reference/trader/functions/trader-minus-dm.xml deleted file mode 100644 index 9f410b83c75c..000000000000 --- a/reference/trader/functions/trader-minus-dm.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - trader_minus_dm - Minus Directional Movement - - - - &reftitle.description; - - arraytrader_minus_dm - arrayhigh - arraylow - inttimePeriod - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-mom.xml b/reference/trader/functions/trader-mom.xml deleted file mode 100644 index a821c5270120..000000000000 --- a/reference/trader/functions/trader-mom.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - trader_mom - Momentum - - - - &reftitle.description; - - arraytrader_mom - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-mult.xml b/reference/trader/functions/trader-mult.xml deleted file mode 100644 index 5eed97abdd5d..000000000000 --- a/reference/trader/functions/trader-mult.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - trader_mult - Vector Arithmetic Mult - - - - &reftitle.description; - - arraytrader_mult - arrayreal0 - arrayreal1 - - - Calculates the vector dot product of real0 with - real1 and returns the resulting vector. - - - - - &reftitle.parameters; - - - real0 - - - &trader.arg.array.of.real; - - - - - real1 - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-natr.xml b/reference/trader/functions/trader-natr.xml deleted file mode 100644 index e3738055e1f4..000000000000 --- a/reference/trader/functions/trader-natr.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_natr - Normalized Average True Range - - - - &reftitle.description; - - arraytrader_natr - arrayhigh - arraylow - arrayclose - inttimePeriod - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-obv.xml b/reference/trader/functions/trader-obv.xml deleted file mode 100644 index f9d41a3031b6..000000000000 --- a/reference/trader/functions/trader-obv.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - trader_obv - On Balance Volume - - - - &reftitle.description; - - arraytrader_obv - arrayreal - arrayvolume - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - volume - - - &trader.arg.array.of.real.volume; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-plus-di.xml b/reference/trader/functions/trader-plus-di.xml deleted file mode 100644 index 3be262eb9d8d..000000000000 --- a/reference/trader/functions/trader-plus-di.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_plus_di - Plus Directional Indicator - - - - &reftitle.description; - - arraytrader_plus_di - arrayhigh - arraylow - arrayclose - inttimePeriod - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-plus-dm.xml b/reference/trader/functions/trader-plus-dm.xml deleted file mode 100644 index 331a79c511df..000000000000 --- a/reference/trader/functions/trader-plus-dm.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - trader_plus_dm - Plus Directional Movement - - - - &reftitle.description; - - arraytrader_plus_dm - arrayhigh - arraylow - inttimePeriod - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-ppo.xml b/reference/trader/functions/trader-ppo.xml deleted file mode 100644 index 7e5a5c4276f8..000000000000 --- a/reference/trader/functions/trader-ppo.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_ppo - Percentage Price Oscillator - - - - &reftitle.description; - - arraytrader_ppo - arrayreal - intfastPeriod - intslowPeriod - intmAType - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - fastPeriod - - - &trader.arg.fast.period; - - - - - slowPeriod - - - &trader.arg.slow.period; - - - - - mAType - - - &trader.arg.ma.type; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-roc.xml b/reference/trader/functions/trader-roc.xml deleted file mode 100644 index abb053ea9ca8..000000000000 --- a/reference/trader/functions/trader-roc.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - trader_roc - Rate of change : ((price/prevPrice)-1)*100 - - - - &reftitle.description; - - arraytrader_roc - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-rocp.xml b/reference/trader/functions/trader-rocp.xml deleted file mode 100644 index e5788a1b9df5..000000000000 --- a/reference/trader/functions/trader-rocp.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - trader_rocp - Rate of change Percentage: (price-prevPrice)/prevPrice - - - - &reftitle.description; - - arraytrader_rocp - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-rocr.xml b/reference/trader/functions/trader-rocr.xml deleted file mode 100644 index 40081f72b234..000000000000 --- a/reference/trader/functions/trader-rocr.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - trader_rocr - Rate of change ratio: (price/prevPrice) - - - - &reftitle.description; - - arraytrader_rocr - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-rocr100.xml b/reference/trader/functions/trader-rocr100.xml deleted file mode 100644 index d1d6f61d6b4a..000000000000 --- a/reference/trader/functions/trader-rocr100.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - trader_rocr100 - Rate of change ratio 100 scale: (price/prevPrice)*100 - - - - &reftitle.description; - - arraytrader_rocr100 - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-rsi.xml b/reference/trader/functions/trader-rsi.xml deleted file mode 100644 index a9e7d28ea503..000000000000 --- a/reference/trader/functions/trader-rsi.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - trader_rsi - Relative Strength Index - - - - &reftitle.description; - - arraytrader_rsi - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-sar.xml b/reference/trader/functions/trader-sar.xml deleted file mode 100644 index b7f022ec00da..000000000000 --- a/reference/trader/functions/trader-sar.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_sar - Parabolic SAR - - - - &reftitle.description; - - arraytrader_sar - arrayhigh - arraylow - floatacceleration - floatmaximum - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - acceleration - - - Acceleration Factor used up to the Maximum value. Valid range from 0 to TRADER_REAL_MAX. - - - - - maximum - - - Acceleration Factor Maximum value. Valid range from 0 to TRADER_REAL_MAX. - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-sarext.xml b/reference/trader/functions/trader-sarext.xml deleted file mode 100644 index d0e08e643ea3..000000000000 --- a/reference/trader/functions/trader-sarext.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - trader_sarext - Parabolic SAR - Extended - - - - &reftitle.description; - - arraytrader_sarext - arrayhigh - arraylow - floatstartValue - floatoffsetOnReverse - floataccelerationInitLong - floataccelerationLong - floataccelerationMaxLong - floataccelerationInitShort - floataccelerationShort - floataccelerationMaxShort - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - startValue - - - Start value and direction. 0 for Auto, >0 for Long, <0 for Short. Valid range from TRADER_REAL_MIN to TRADER_REAL_MAX. - - - - - offsetOnReverse - - - Percent offset added/removed to initial stop on short/long reversal. Valid range from 0 to TRADER_REAL_MAX. - - - - - accelerationInitLong - - - Acceleration Factor initial value for the Long direction. Valid range from 0 to TRADER_REAL_MAX. - - - - - accelerationLong - - - Acceleration Factor for the Long direction. Valid range from 0 to TRADER_REAL_MAX. - - - - - accelerationMaxLong - - - Acceleration Factor maximum value for the Long direction. Valid range from 0 to TRADER_REAL_MAX. - - - - - accelerationInitShort - - - Acceleration Factor initial value for the Short direction. Valid range from 0 to TRADER_REAL_MAX. - - - - - accelerationShort - - - Acceleration Factor for the Short direction. Valid range from 0 to TRADER_REAL_MAX. - - - - - accelerationMaxShort - - - Acceleration Factor maximum value for the Short direction. Valid range from 0 to TRADER_REAL_MAX. - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-set-compat.xml b/reference/trader/functions/trader-set-compat.xml deleted file mode 100644 index 6a41bc2117fc..000000000000 --- a/reference/trader/functions/trader-set-compat.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - trader_set_compat - Set compatibility mode - - - - &reftitle.description; - - voidtrader_set_compat - intcompatId - - - Set compatibility mode which will affect the way calculations are done by all the extension functions. - - - - - &reftitle.parameters; - - - compatId - - - Compatibility Id. TRADER_COMPATIBILITY_* series of constants should be used. - - - - - - - - &reftitle.returnvalues; - &return.void; - - - - - - diff --git a/reference/trader/functions/trader-set-unstable-period.xml b/reference/trader/functions/trader-set-unstable-period.xml deleted file mode 100644 index 2a6411cad7b4..000000000000 --- a/reference/trader/functions/trader-set-unstable-period.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - trader_set_unstable_period - Set unstable period - - - - &reftitle.description; - - voidtrader_set_unstable_period - intfunctionId - inttimePeriod - - - Influences unstable period factor for functions, which are sensible to it. More information about unstable periods can be found on the TA-Lib API documentation page. - - - - - &reftitle.parameters; - - - functionId - - - Function ID the factor should be set for. TRADER_FUNC_UNST_* constant series can be used to affect the corresponding function. - - - - - timePeriod - - - Unstable period value. - - - - - - - - &reftitle.returnvalues; - &return.void; - - - - - - diff --git a/reference/trader/functions/trader-sin.xml b/reference/trader/functions/trader-sin.xml deleted file mode 100644 index 196644068ed5..000000000000 --- a/reference/trader/functions/trader-sin.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - trader_sin - Vector Trigonometric Sin - - - - &reftitle.description; - - arraytrader_sin - arrayreal - - - Calculates the sine for each value in - real and returns the resulting array. - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-sinh.xml b/reference/trader/functions/trader-sinh.xml deleted file mode 100644 index 32dc4a51d667..000000000000 --- a/reference/trader/functions/trader-sinh.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - trader_sinh - Vector Trigonometric Sinh - - - - &reftitle.description; - - arraytrader_sinh - arrayreal - - - Calculates the hyperbolic sine for each value in - real and returns the resulting array. - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-sma.xml b/reference/trader/functions/trader-sma.xml deleted file mode 100644 index 2a941e2f3c78..000000000000 --- a/reference/trader/functions/trader-sma.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - trader_sma - Simple Moving Average - - - - &reftitle.description; - - arraytrader_sma - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-sqrt.xml b/reference/trader/functions/trader-sqrt.xml deleted file mode 100644 index 5f5de5dad533..000000000000 --- a/reference/trader/functions/trader-sqrt.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - trader_sqrt - Vector Square Root - - - - &reftitle.description; - - arraytrader_sqrt - arrayreal - - - Calculates the square root of each value in - real and returns the resulting array. - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-stddev.xml b/reference/trader/functions/trader-stddev.xml deleted file mode 100644 index de0e91ac3746..000000000000 --- a/reference/trader/functions/trader-stddev.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - trader_stddev - Standard Deviation - - - - &reftitle.description; - - arraytrader_stddev - arrayreal - inttimePeriod - floatnbDev - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - nbDev - - - - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-stoch.xml b/reference/trader/functions/trader-stoch.xml deleted file mode 100644 index e55a75a0476f..000000000000 --- a/reference/trader/functions/trader-stoch.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - trader_stoch - Stochastic - - - - &reftitle.description; - - arraytrader_stoch - arrayhigh - arraylow - arrayclose - intfastK_Period - intslowK_Period - intslowK_MAType - intslowD_Period - intslowD_MAType - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - fastK_Period - - - &trader.arg.fastk.period; - - - - - slowK_Period - - - &trader.arg.slowk.period; - - - - - slowK_MAType - - - &trader.arg.slowk.ma.type; - - - - - slowD_Period - - - &trader.arg.slowd.period; - - - - - slowD_MAType - - - &trader.arg.slowd.ma.type; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-stochf.xml b/reference/trader/functions/trader-stochf.xml deleted file mode 100644 index ca66a7eed8a9..000000000000 --- a/reference/trader/functions/trader-stochf.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - trader_stochf - Stochastic Fast - - - - &reftitle.description; - - arraytrader_stochf - arrayhigh - arraylow - arrayclose - intfastK_Period - intfastD_Period - intfastD_MAType - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - fastK_Period - - - &trader.arg.fastk.period; - - - - - fastD_Period - - - &trader.arg.fastd.period; - - - - - fastD_MAType - - - &trader.arg.fastd.ma.type; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-stochrsi.xml b/reference/trader/functions/trader-stochrsi.xml deleted file mode 100644 index 41254da1cd2e..000000000000 --- a/reference/trader/functions/trader-stochrsi.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - trader_stochrsi - Stochastic Relative Strength Index - - - - &reftitle.description; - - arraytrader_stochrsi - arrayreal - inttimePeriod - intfastK_Period - intfastD_Period - intfastD_MAType - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - fastK_Period - - - &trader.arg.fastk.period; - - - - - fastD_Period - - - &trader.arg.fastd.period; - - - - - fastD_MAType - - - &trader.arg.fastd.ma.type; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-sub.xml b/reference/trader/functions/trader-sub.xml deleted file mode 100644 index a656729151e4..000000000000 --- a/reference/trader/functions/trader-sub.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - trader_sub - Vector Arithmetic Subtraction - - - - &reftitle.description; - - arraytrader_sub - arrayreal0 - arrayreal1 - - - Calculates the vector subtraction of real1 from - real0 and returns the resulting vector. - - - - - &reftitle.parameters; - - - real0 - - - &trader.arg.array.of.real; - - - - - real1 - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-sum.xml b/reference/trader/functions/trader-sum.xml deleted file mode 100644 index 07d66cf7c1e7..000000000000 --- a/reference/trader/functions/trader-sum.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - trader_sum - Summation - - - - &reftitle.description; - - arraytrader_sum - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-t3.xml b/reference/trader/functions/trader-t3.xml deleted file mode 100644 index ad74fb4cee8a..000000000000 --- a/reference/trader/functions/trader-t3.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - trader_t3 - Triple Exponential Moving Average (T3) - - - - &reftitle.description; - - arraytrader_t3 - arrayreal - inttimePeriod - floatvFactor - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - vFactor - - - &trader.arg.vfactor; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-tan.xml b/reference/trader/functions/trader-tan.xml deleted file mode 100644 index 5c9fa020f85b..000000000000 --- a/reference/trader/functions/trader-tan.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - trader_tan - Vector Trigonometric Tan - - - - &reftitle.description; - - arraytrader_tan - arrayreal - - - Calculates the tangent for each value in - real and returns the resulting array. - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-tanh.xml b/reference/trader/functions/trader-tanh.xml deleted file mode 100644 index ba7dfd89e628..000000000000 --- a/reference/trader/functions/trader-tanh.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - trader_tanh - Vector Trigonometric Tanh - - - - &reftitle.description; - - arraytrader_tanh - arrayreal - - - Calculates the hyperbolic tangent for each value in - real and returns the resulting array. - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-tema.xml b/reference/trader/functions/trader-tema.xml deleted file mode 100644 index b23f422e0411..000000000000 --- a/reference/trader/functions/trader-tema.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - trader_tema - Triple Exponential Moving Average - - - - &reftitle.description; - - arraytrader_tema - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-trange.xml b/reference/trader/functions/trader-trange.xml deleted file mode 100644 index e99fc4222a78..000000000000 --- a/reference/trader/functions/trader-trange.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - trader_trange - True Range - - - - &reftitle.description; - - arraytrader_trange - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-trima.xml b/reference/trader/functions/trader-trima.xml deleted file mode 100644 index 33915e2929af..000000000000 --- a/reference/trader/functions/trader-trima.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - trader_trima - Triangular Moving Average - - - - &reftitle.description; - - arraytrader_trima - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-trix.xml b/reference/trader/functions/trader-trix.xml deleted file mode 100644 index 1029fbc42b9b..000000000000 --- a/reference/trader/functions/trader-trix.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - trader_trix - 1-day Rate-Of-Change (ROC) of a Triple Smooth EMA - - - - &reftitle.description; - - arraytrader_trix - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-tsf.xml b/reference/trader/functions/trader-tsf.xml deleted file mode 100644 index c66d8d36fb4b..000000000000 --- a/reference/trader/functions/trader-tsf.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - trader_tsf - Time Series Forecast - - - - &reftitle.description; - - arraytrader_tsf - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-typprice.xml b/reference/trader/functions/trader-typprice.xml deleted file mode 100644 index c83a7d54fada..000000000000 --- a/reference/trader/functions/trader-typprice.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - trader_typprice - Typical Price - - - - &reftitle.description; - - arraytrader_typprice - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-ultosc.xml b/reference/trader/functions/trader-ultosc.xml deleted file mode 100644 index 3009559f3afa..000000000000 --- a/reference/trader/functions/trader-ultosc.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - trader_ultosc - Ultimate Oscillator - - - - &reftitle.description; - - arraytrader_ultosc - arrayhigh - arraylow - arrayclose - inttimePeriod1 - inttimePeriod2 - inttimePeriod3 - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - timePeriod1 - - - Number of bars for 1st period. Valid range from 1 to 100000. - - - - - timePeriod2 - - - Number of bars for 2nd period. Valid range from 1 to 100000. - - - - - timePeriod3 - - - Number of bars for 3rd period. Valid range from 1 to 100000. - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-var.xml b/reference/trader/functions/trader-var.xml deleted file mode 100644 index 3365f3ec1f96..000000000000 --- a/reference/trader/functions/trader-var.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - trader_var - Variance - - - - &reftitle.description; - - arraytrader_var - arrayreal - inttimePeriod - floatnbDev - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - nbDev - - - - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-wclprice.xml b/reference/trader/functions/trader-wclprice.xml deleted file mode 100644 index b6e2022c16b7..000000000000 --- a/reference/trader/functions/trader-wclprice.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - trader_wclprice - Weighted Close Price - - - - &reftitle.description; - - arraytrader_wclprice - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-willr.xml b/reference/trader/functions/trader-willr.xml deleted file mode 100644 index a2c814bec1e4..000000000000 --- a/reference/trader/functions/trader-willr.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - trader_willr - Williams' %R - - - - &reftitle.description; - - arraytrader_willr - arrayhigh - arraylow - arrayclose - inttimePeriod - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/functions/trader-wma.xml b/reference/trader/functions/trader-wma.xml deleted file mode 100644 index e2890d09e44d..000000000000 --- a/reference/trader/functions/trader-wma.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - trader_wma - Weighted Moving Average - - - - &reftitle.description; - - arraytrader_wma - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Returns an array with calculated data or false on failure. - - - - - - diff --git a/reference/trader/ini.xml b/reference/trader/ini.xml deleted file mode 100644 index 75fc067eb4e1..000000000000 --- a/reference/trader/ini.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - -
    - &reftitle.runtime; - &extension.runtime; - - - Trader &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - trader.real_precision - 3 - INI_ALL - Since trader 0.2.1 - - - trader.real_round_mode - HALF_DOWN - INI_ALL - Since trader 0.3.0 - - - -
    -
    - - &ini.descriptions.title; - - - - - - trader.real_precision - int - - - - All the values in the returned arrays will be rounded to this precision. - However the calculations inside TA-Lib happen with unrounded values. - - - - - - trader.real_round_mode - string - - - - Controls the trader real rounding policy. Valid values are HALF_UP, - HALF_DOWN, HALF_EVEN and HALF_ODD. The behaviour is identical to the round() function used with the mode argument. - - - - - -
    - - diff --git a/reference/trader/reference.xml b/reference/trader/reference.xml deleted file mode 100644 index c387864e7e2b..000000000000 --- a/reference/trader/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - Trader &Functions; - - &reference.trader.entities.functions; - - - - diff --git a/reference/trader/setup.xml b/reference/trader/setup.xml deleted file mode 100644 index 52932e87371d..000000000000 --- a/reference/trader/setup.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - The trader extension is based on TA-Lib. TA-Lib is fully integrated into the extension, therefore no external libraries are needed. - -
    - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;trader. - -
    - - - &reference.trader.ini; - - - - -
    - - diff --git a/reference/trader/versions.xml b/reference/trader/versions.xml deleted file mode 100644 index 4f65bdf740fa..000000000000 --- a/reference/trader/versions.xml +++ /dev/null @@ -1,190 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/ui/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/ui/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/ui/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/ui/book.xml b/reference/ui/book.xml deleted file mode 100644 index 353dca65d15a..000000000000 --- a/reference/ui/book.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - UI - UI - - - &reftitle.intro; - - &warn.experimental; - This extension wraps libui - to provide an object-oriented API for the cross platform development - of native look-and-feel user interfaces. - - - - &reference.ui.setup; - - - &reference.ui.ui.point; - &reference.ui.ui.size; - - &reference.ui.ui.window; - &reference.ui.ui.control; - &reference.ui.ui.menu; - &reference.ui.ui.menuitem; - &reference.ui.ui.area; - &reference.ui.ui.executor; - - &reference.ui.ui.controls.tab; - &reference.ui.ui.controls.check; - &reference.ui.ui.controls.button; - &reference.ui.ui.controls.colorbutton; - &reference.ui.ui.controls.label; - &reference.ui.ui.controls.entry; - &reference.ui.ui.controls.multilineentry; - &reference.ui.ui.controls.spin; - &reference.ui.ui.controls.slider; - &reference.ui.ui.controls.progress; - &reference.ui.ui.controls.separator; - &reference.ui.ui.controls.combo; - &reference.ui.ui.controls.editablecombo; - &reference.ui.ui.controls.radio; - &reference.ui.ui.controls.picker; - - &reference.ui.ui.controls.form; - &reference.ui.ui.controls.grid; - &reference.ui.ui.controls.group; - &reference.ui.ui.controls.box; - - &reference.ui.ui.draw.pen; - &reference.ui.ui.draw.path; - &reference.ui.ui.draw.matrix; - &reference.ui.ui.draw.color; - &reference.ui.ui.draw.stroke; - &reference.ui.ui.draw.brush; - &reference.ui.ui.draw.brush.gradient; - &reference.ui.ui.draw.brush.lineargradient; - &reference.ui.ui.draw.brush.radialgradient; - - &reference.ui.ui.draw.text.layout; - &reference.ui.ui.draw.text.font; - &reference.ui.ui.draw.text.font.descriptor; - - &reference.ui.reference; - - &reference.ui.ui.draw.text.font.weight; - &reference.ui.ui.draw.text.font.italic; - &reference.ui.ui.draw.text.font.stretch; - &reference.ui.ui.draw.line.cap; - &reference.ui.ui.draw.line.join; - &reference.ui.ui.key; - - &reference.ui.ui.exception.invalidargumentexception; - &reference.ui.ui.exception.runtimeexception; - - - diff --git a/reference/ui/configure.xml b/reference/ui/configure.xml deleted file mode 100644 index fdf622081f2a..000000000000 --- a/reference/ui/configure.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - -
    - &reftitle.install; - - - Use when compiling PHP. - - - - Windows users should include php_ui.dll into &php.ini; - - -
    - - - diff --git a/reference/ui/functions/ui.draw.text.font.fontfamilies.xml b/reference/ui/functions/ui.draw.text.font.fontfamilies.xml deleted file mode 100644 index db95341fc9e3..000000000000 --- a/reference/ui/functions/ui.draw.text.font.fontfamilies.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - UI\Draw\Text\Font\fontFamilies - Retrieve Font Families - - - - &reftitle.description; - - arrayUI\Draw\Text\Font\fontFamilies - - - - Returns an array of valid font families for the current system - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an &array; of valid font families for the current system. - - - - - - diff --git a/reference/ui/functions/ui.quit.xml b/reference/ui/functions/ui.quit.xml deleted file mode 100644 index 0238e27fc16c..000000000000 --- a/reference/ui/functions/ui.quit.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\quit - Quit UI Loop - - - - &reftitle.description; - - voidUI\quit - - - - Shall cause the main loop to be exited - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/functions/ui.run.xml b/reference/ui/functions/ui.run.xml deleted file mode 100644 index 502001cad328..000000000000 --- a/reference/ui/functions/ui.run.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - UI\run - Enter UI Loop - - - - &reftitle.description; - - voidUI\run - intflags - - - Shall cause PHP to enter into the main loop, by default control will not be returned to the caller - - - - - - &reftitle.parameters; - - - flags - - - Set UI\Loop to return control, and UI\Wait to return control after waiting - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/reference.xml b/reference/ui/reference.xml deleted file mode 100644 index 7791a1ed35c0..000000000000 --- a/reference/ui/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - UI &Functions; - - &reference.ui.entities.functions; - - - - diff --git a/reference/ui/setup.xml b/reference/ui/setup.xml deleted file mode 100644 index 8d6cc37b4efb..000000000000 --- a/reference/ui/setup.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - Installation requires the libui library, and PHP 7 or newer. - - - This extension requires the libui library - version 0.1.0 or higher to be installed. See the libui documentation - for a list of prerequisites. - -
    - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;ui. - - - &pecl.windows.download.avail; - -
    - -
    - - diff --git a/reference/ui/ui.area.xml b/reference/ui/ui.area.xml deleted file mode 100644 index 5ba1fc9f974c..000000000000 --- a/reference/ui/ui.area.xml +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - Area - UI\Area - - - - -
    - &reftitle.intro; - - An Area represents a canvas which can be used to draw, and respond to mouse and key events. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Area - - - - - UI\Area - - - - extends - UI\Control - - - - &Constants; - - const - int - UI\Area::Ctrl - - - const - int - UI\Area::Alt - - - const - int - UI\Area::Shift - - - const - int - UI\Area::Super - - - const - int - UI\Area::Down - - - const - int - UI\Area::Up - - - &Methods; - - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.constants; - - - - UI\Area::Ctrl - - - Shall be set in the modifiers passed to key and mouse events - when the CTRL key is active - - - - - - UI\Area::Alt - - - Shall be set in the modifiers passed to key and mouse events - when the ALT key is active - - - - - - UI\Area::Shift - - - Shall be set in the modifiers passed to key and mouse events - when the SHIFT key is active - - - - - - UI\Area::Super - - - - - - - UI\Area::Down - - Shall be set in the modifiers passed to key and mouse events - - - - - UI\Area::Up - - Shall be set in the modifiers passed to key and mouse events - - - - -
    - - - -
    - - &reference.ui.ui.entities.area; - -
    - - diff --git a/reference/ui/ui.control.xml b/reference/ui/ui.control.xml deleted file mode 100644 index 7a48c946591c..000000000000 --- a/reference/ui/ui.control.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - Control - UI\Control - - - - -
    - &reftitle.intro; - - This is the closed base class for all UI Controls. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Control - - - - - final - UI\Control - - - - - &Methods; - - - - -
    - -
    - - &reference.ui.ui.entities.control; - -
    - - diff --git a/reference/ui/ui.controls.box.xml b/reference/ui/ui.controls.box.xml deleted file mode 100644 index 07448f1f3152..000000000000 --- a/reference/ui/ui.controls.box.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - - Control Box (Arrangement) - UI\Controls\Box - - - - -
    - &reftitle.intro; - - A Box allows the arrangement of other controls - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\Box - - - - - UI\Controls\Box - - - - extends - UI\Control - - - - - &Constants; - - const - int - UI\Controls\Box::Vertical - - - const - int - UI\Controls\Box::Horizontal - - - &Properties; - - protected - controls - - - Constructor - - - &Methods; - - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.properties; - - - controls - - - Contains controls, should not be manipulated directly - - - - -
    - - - -
    - &reftitle.constants; - - - - UI\Controls\Box::Vertical - - - - - - - UI\Controls\Box::Horizontal - - - - - - -
    - - - -
    - - &reference.ui.ui.controls.entities.box; - -
    - - diff --git a/reference/ui/ui.controls.button.xml b/reference/ui/ui.controls.button.xml deleted file mode 100644 index a98ffcec0d9e..000000000000 --- a/reference/ui/ui.controls.button.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - Button Control - UI\Controls\Button - - - - -
    - &reftitle.intro; - - Represents a labelled clickable button - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\Button - - - - - UI\Controls\Button - - - - extends - UI\Control - - - - - Constructor - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -
    - - &reference.ui.ui.controls.entities.button; - -
    - - diff --git a/reference/ui/ui.controls.check.xml b/reference/ui/ui.controls.check.xml deleted file mode 100644 index b8d573bcbb5a..000000000000 --- a/reference/ui/ui.controls.check.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - Check Control - UI\Controls\Check - - - - -
    - &reftitle.intro; - - A Check is a labelled checkable box - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\Check - - - - - UI\Controls\Check - - - - extends - UI\Control - - - - - Constructor - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -
    - - &reference.ui.ui.controls.entities.check; - -
    - - diff --git a/reference/ui/ui.controls.colorbutton.xml b/reference/ui/ui.controls.colorbutton.xml deleted file mode 100644 index 1c080bb97f16..000000000000 --- a/reference/ui/ui.controls.colorbutton.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - ColorButton Control - UI\Controls\ColorButton - - - - -
    - &reftitle.intro; - - A Color Button is a button which displays a color picker when clicked - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\ColorButton - - - - - UI\Controls\ColorButton - - - - extends - UI\Control - - - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -
    - - &reference.ui.ui.controls.entities.colorbutton; - -
    - - diff --git a/reference/ui/ui.controls.combo.xml b/reference/ui/ui.controls.combo.xml deleted file mode 100644 index 4ef69d0973ef..000000000000 --- a/reference/ui/ui.controls.combo.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - Combo Control - UI\Controls\Combo - - - - -
    - &reftitle.intro; - - A Combo control represents a list of options, like the familiar select HTML element. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\Combo - - - - - UI\Controls\Combo - - - - extends - UI\Control - - - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -
    - - &reference.ui.ui.controls.entities.combo; - -
    - - diff --git a/reference/ui/ui.controls.editablecombo.xml b/reference/ui/ui.controls.editablecombo.xml deleted file mode 100644 index 3046942c8236..000000000000 --- a/reference/ui/ui.controls.editablecombo.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - EditableCombo Control - UI\Controls\EditableCombo - - - - -
    - &reftitle.intro; - - An Editable Combo is a Combo which allows the user to enter custom options - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\EditableCombo - - - - - UI\Controls\EditableCombo - - - - extends - UI\Control - - - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -
    - - &reference.ui.ui.controls.entities.editablecombo; - -
    - - diff --git a/reference/ui/ui.controls.entry.xml b/reference/ui/ui.controls.entry.xml deleted file mode 100644 index e774e9fb4df3..000000000000 --- a/reference/ui/ui.controls.entry.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - Entry Control - UI\Controls\Entry - - - - -
    - &reftitle.intro; - - An Entry is a text entry control, suitable for entering plain text, passwords, or search terms. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\Entry - - - - - UI\Controls\Entry - - - - extends - UI\Control - - - - &Constants; - - const - int - UI\Controls\Entry::Normal - - - const - int - UI\Controls\Entry::Password - - - const - int - UI\Controls\Entry::Search - - - Constructor - - - &Methods; - - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.constants; - - - - UI\Controls\Entry::Normal - - A normal single line entry - - - - - UI\Controls\Entry::Password - - A password entry - - - - - UI\Controls\Entry::Search - - A search entry - - - - -
    - - - -
    - - &reference.ui.ui.controls.entities.entry; - -
    - - diff --git a/reference/ui/ui.controls.form.xml b/reference/ui/ui.controls.form.xml deleted file mode 100644 index 4c90ba3f53d1..000000000000 --- a/reference/ui/ui.controls.form.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - Control Form (Arrangement) - UI\Controls\Form - - - - -
    - &reftitle.intro; - - A Form is a control which allows the arrangement of other controls into a familiar layout (the form). - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\Form - - - - - UI\Controls\Form - - - - extends - UI\Control - - - - - &Properties; - - protected - controls - - - &Methods; - - - &InheritedMethods; - - - - - - -
    - &reftitle.properties; - - - controls - - - Contains controls, should not be manipulated directly - - - - -
    - - -
    - -
    - - &reference.ui.ui.controls.entities.form; - -
    - - diff --git a/reference/ui/ui.controls.grid.xml b/reference/ui/ui.controls.grid.xml deleted file mode 100644 index 1c7953e57653..000000000000 --- a/reference/ui/ui.controls.grid.xml +++ /dev/null @@ -1,205 +0,0 @@ - - - - - - Control Grid (Arrangement) - UI\Controls\Grid - - - - -
    - &reftitle.intro; - - A Grid is a control which is allows the arrangement of children into a grid - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\Grid - - - - - UI\Controls\Grid - - - - extends - UI\Control - - - - &Constants; - - const - int - UI\Controls\Grid::Fill - - - const - int - UI\Controls\Grid::Start - - - const - int - UI\Controls\Grid::Center - - - const - int - UI\Controls\Grid::End - - - const - int - UI\Controls\Grid::Leading - - - const - int - UI\Controls\Grid::Top - - - const - int - UI\Controls\Grid::Trailing - - - const - int - UI\Controls\Grid::Bottom - - - &Properties; - - protected - controls - - - &Methods; - - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.constants; - - - - UI\Controls\Grid::Fill - - - - - - - UI\Controls\Grid::Start - - - - - - - UI\Controls\Grid::Center - - - - - - - UI\Controls\Grid::End - - - - - - - UI\Controls\Grid::Leading - - - - - - - UI\Controls\Grid::Top - - - - - - - UI\Controls\Grid::Trailing - - - - - - - UI\Controls\Grid::Bottom - - - - - - -
    - - - -
    - &reftitle.properties; - - - controls - - - Contains controls, should not be manipulated directly - - - - -
    - - - -
    - - &reference.ui.ui.controls.entities.grid; - -
    - - diff --git a/reference/ui/ui.controls.group.xml b/reference/ui/ui.controls.group.xml deleted file mode 100644 index db8114e0a4a9..000000000000 --- a/reference/ui/ui.controls.group.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - Control Group (Arrangement) - UI\Controls\Group - - - - -
    - &reftitle.intro; - - A Group is a titled container for child controls - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\Group - - - - - UI\Controls\Group - - - - extends - UI\Control - - - - - &Properties; - - protected - controls - - - Constructor - - - &Methods; - - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.properties; - - - controls - - - Contains controls, should not be manipulated directly - - - - -
    - - -
    - - &reference.ui.ui.controls.entities.group; - -
    - - diff --git a/reference/ui/ui.controls.label.xml b/reference/ui/ui.controls.label.xml deleted file mode 100644 index 325260352610..000000000000 --- a/reference/ui/ui.controls.label.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - Label Control - UI\Controls\Label - - - - -
    - &reftitle.intro; - - A Label is a single line of text, meant to identify, for the user, some element of the interface. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\Label - - - - - UI\Controls\Label - - - - extends - UI\Control - - - - - Constructor - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -
    - - &reference.ui.ui.controls.entities.label; - -
    - - diff --git a/reference/ui/ui.controls.multilineentry.xml b/reference/ui/ui.controls.multilineentry.xml deleted file mode 100644 index 5cd0c1dc6a6e..000000000000 --- a/reference/ui/ui.controls.multilineentry.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - MultilineEntry Control - UI\Controls\MultilineEntry - - - - -
    - &reftitle.intro; - - A Multiline Entry is a text entry control able to hold multiple lines of text, with or without wrapping. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\MultilineEntry - - - - - UI\Controls\MultilineEntry - - - - extends - UI\Control - - - - &Constants; - - const - int - UI\Controls\MultilineEntry::Wrap - - - const - int - UI\Controls\MultilineEntry::NoWrap - - - Constructor - - - &Methods; - - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.constants; - - - - UI\Controls\MultilineEntry::Wrap - - Allow lines to wrap - - - - - UI\Controls\MultilineEntry::NoWrap - - Do not allow lines to wrap - - - - -
    - - - -
    - - &reference.ui.ui.controls.entities.multilineentry; - -
    - - diff --git a/reference/ui/ui.controls.picker.xml b/reference/ui/ui.controls.picker.xml deleted file mode 100644 index ec3fd1e54384..000000000000 --- a/reference/ui/ui.controls.picker.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - Picker Control - UI\Controls\Picker - - - - -
    - &reftitle.intro; - - A Picker represents a button which when clicked presents a native Date/Time/DateTime Picker interface to the user. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\Picker - - - - - UI\Controls\Picker - - - - extends - UI\Control - - - - &Constants; - - const - int - UI\Controls\Picker::Date - - - const - int - UI\Controls\Picker::Time - - - const - int - UI\Controls\Picker::DateTime - - - Constructor - - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.constants; - - - - UI\Controls\Picker::Date - - A Date Picker - - - - - UI\Controls\Picker::Time - - A Time Picker - - - - - UI\Controls\Picker::DateTime - - A Date and Time Picker - - - - -
    - - - -
    - - &reference.ui.ui.controls.entities.picker; - -
    - - diff --git a/reference/ui/ui.controls.progress.xml b/reference/ui/ui.controls.progress.xml deleted file mode 100644 index 7954f7fed8cf..000000000000 --- a/reference/ui/ui.controls.progress.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - Progress Control - UI\Controls\Progress - - - - -
    - &reftitle.intro; - - A Progress control is a familiar Progress bar: It represents progress as a percentage, with a possible range of 0 to 100 (inclusive). - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\Progress - - - - - UI\Controls\Progress - - - - extends - UI\Control - - - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -
    - - &reference.ui.ui.controls.entities.progress; - -
    - - diff --git a/reference/ui/ui.controls.radio.xml b/reference/ui/ui.controls.radio.xml deleted file mode 100644 index ead101137579..000000000000 --- a/reference/ui/ui.controls.radio.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - Radio Control - UI\Controls\Radio - - - - -
    - &reftitle.intro; - - A Radio is similar to the radio input type familiar from HTML - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\Radio - - - - - UI\Controls\Radio - - - - extends - UI\Control - - - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -
    - - &reference.ui.ui.controls.entities.radio; - -
    - - diff --git a/reference/ui/ui.controls.separator.xml b/reference/ui/ui.controls.separator.xml deleted file mode 100644 index f4d425d7ce7f..000000000000 --- a/reference/ui/ui.controls.separator.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - Control Separator - UI\Controls\Separator - - - - -
    - &reftitle.intro; - - A Separator represents a control separator, it has no other function. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\Separator - - - - - UI\Controls\Separator - - - - extends - UI\Control - - - - &Constants; - - const - int - UI\Controls\Separator::Horizontal - - - const - int - UI\Controls\Separator::Vertical - - - Constructor - - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.constants; - - - - UI\Controls\Separator::Horizontal - - A Horizontal Separator - - - - - UI\Controls\Separator::Vertical - - A Vertical Separator - - - - -
    - - - -
    - - &reference.ui.ui.controls.entities.separator; - -
    - - diff --git a/reference/ui/ui.controls.slider.xml b/reference/ui/ui.controls.slider.xml deleted file mode 100644 index 7f9a69603be7..000000000000 --- a/reference/ui/ui.controls.slider.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - Slider Control - UI\Controls\Slider - - - - -
    - &reftitle.intro; - - A Slider is a control which represents a range, and a current value in the range. The sliding element of the control (sometimes called the "thumb") reflects the value, and can be adjusted within the range. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\Slider - - - - - UI\Controls\Slider - - - - extends - UI\Control - - - - - Constructor - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -
    - - &reference.ui.ui.controls.entities.slider; - -
    - - diff --git a/reference/ui/ui.controls.spin.xml b/reference/ui/ui.controls.spin.xml deleted file mode 100644 index aed7d171168a..000000000000 --- a/reference/ui/ui.controls.spin.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - Spin Control - UI\Controls\Spin - - - - -
    - &reftitle.intro; - - A Spin box is a text box with an up-down control which changes the integer value in the box, within a defined range - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\Spin - - - - - UI\Controls\Spin - - - - extends - UI\Control - - - - - Constructor - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -
    - - &reference.ui.ui.controls.entities.spin; - -
    - - diff --git a/reference/ui/ui.controls.tab.xml b/reference/ui/ui.controls.tab.xml deleted file mode 100644 index 6bb2938e4fc3..000000000000 --- a/reference/ui/ui.controls.tab.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - Tab Control - UI\Controls\Tab - - - - -
    - &reftitle.intro; - - A Tab can contain many pages of Controls, each with a title, each selectable by the user. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\Tab - - - - - UI\Controls\Tab - - - - extends - UI\Control - - - - - &Properties; - - protected - controls - - - &Methods; - - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.properties; - - - controls - - - Contains controls, should not be manipulated directly - - - - -
    - - -
    - - &reference.ui.ui.controls.entities.tab; - -
    - - diff --git a/reference/ui/ui.draw.brush.gradient.xml b/reference/ui/ui.draw.brush.gradient.xml deleted file mode 100644 index 99c0f61224bc..000000000000 --- a/reference/ui/ui.draw.brush.gradient.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - Gradient Brushes - UI\Draw\Brush\Gradient - - - - -
    - &reftitle.intro; - - Abstract for gradient brushes - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Draw\Brush\Gradient - - - - - abstract - UI\Draw\Brush\Gradient - - - - extends - UI\Draw\Brush - - - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -
    - - &reference.ui.ui.draw.entities.brush.gradient; - -
    - - diff --git a/reference/ui/ui.draw.brush.lineargradient.xml b/reference/ui/ui.draw.brush.lineargradient.xml deleted file mode 100644 index 12010456c996..000000000000 --- a/reference/ui/ui.draw.brush.lineargradient.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - Linear Gradient - UI\Draw\Brush\LinearGradient - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Draw\Brush\LinearGradient - - - - - UI\Draw\Brush\LinearGradient - - - - extends - UI\Draw\Brush\Gradient - - - - - Constructor - - - - - &InheritedMethods; - - - - - -
    - -
    - - &reference.ui.ui.draw.entities.brush.lineargradient; - -
    - - diff --git a/reference/ui/ui.draw.brush.radialgradient.xml b/reference/ui/ui.draw.brush.radialgradient.xml deleted file mode 100644 index 7b63ab701cfc..000000000000 --- a/reference/ui/ui.draw.brush.radialgradient.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - Radial Gradient - UI\Draw\Brush\RadialGradient - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Draw\Brush\RadialGradient - - - - - UI\Draw\Brush\RadialGradient - - - - extends - UI\Draw\Brush\Gradient - - - - - Constructor - - - - - &InheritedMethods; - - - - - -
    - -
    - - &reference.ui.ui.draw.entities.brush.radialgradient; - -
    - - diff --git a/reference/ui/ui.draw.brush.xml b/reference/ui/ui.draw.brush.xml deleted file mode 100644 index 6a003796be97..000000000000 --- a/reference/ui/ui.draw.brush.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - Brushes - UI\Draw\Brush - - - - -
    - &reftitle.intro; - - Represents a solid color brush - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Draw\Brush - - - - - UI\Draw\Brush - - - - - Constructor - - - &Methods; - - - - -
    - -
    - - &reference.ui.ui.draw.entities.brush; - -
    - - diff --git a/reference/ui/ui.draw.color.xml b/reference/ui/ui.draw.color.xml deleted file mode 100644 index 0ff735a7937e..000000000000 --- a/reference/ui/ui.draw.color.xml +++ /dev/null @@ -1,181 +0,0 @@ - - - - - - Color Representation - UI\Draw\Color - - - - -
    - &reftitle.intro; - - Represents RGBA colours, individual channels are accessible via public properties. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Draw\Color - - - - - UI\Draw\Color - - - - &Constants; - - const - int - UI\Draw\Color::Red - - - const - int - UI\Draw\Color::Green - - - const - int - UI\Draw\Color::Blue - - - const - int - UI\Draw\Color::Alpha - - - &Properties; - - public - r - - - public - g - - - public - b - - - public - a - - - Constructor - - - &Methods; - - - - -
    - - - -
    - &reftitle.properties; - - - r - - Provides access to the red channel - - - - g - - Provides access to the green channel - - - - b - - Provides access to the blue channel - - - - a - - Provides access to the alpha channel - - - -
    - - - - -
    - &reftitle.constants; - - - - UI\Draw\Color::Red - - Identifies the red channel - - - - - UI\Draw\Color::Green - - Identifies the green channel - - - - - UI\Draw\Color::Blue - - Identifies the blue channel - - - - - UI\Draw\Color::Alpha - - Identifies the alpha channel - - - - -
    - - - -
    - - &reference.ui.ui.draw.entities.color; - -
    - - diff --git a/reference/ui/ui.draw.line.cap.xml b/reference/ui/ui.draw.line.cap.xml deleted file mode 100644 index 2a9488989229..000000000000 --- a/reference/ui/ui.draw.line.cap.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - Line Cap Settings - UI\Draw\Line\Cap - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Draw\Line\Cap - - - - - final - UI\Draw\Line\Cap - - - - &Constants; - - const - int - UI\Draw\Line\Cap::Flat - - - const - int - UI\Draw\Line\Cap::Round - - - const - int - UI\Draw\Line\Cap::Square - - - - - -
    - - -
    - &reftitle.constants; - - - - UI\Draw\Line\Cap::Flat - - - - - - UI\Draw\Line\Cap::Round - - - - - - UI\Draw\Line\Cap::Square - - - - - - -
    - -
    - -
    - - diff --git a/reference/ui/ui.draw.line.join.xml b/reference/ui/ui.draw.line.join.xml deleted file mode 100644 index 91303b3ad8cc..000000000000 --- a/reference/ui/ui.draw.line.join.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - Line Join Settings - UI\Draw\Line\Join - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Draw\Line\Join - - - - - final - UI\Draw\Line\Join - - - - &Constants; - - const - int - UI\Draw\Line\Join::Miter - - - const - int - UI\Draw\Line\Join::Round - - - const - int - UI\Draw\Line\Join::Bevel - - - - - -
    - - -
    - &reftitle.constants; - - - - UI\Draw\Line\Join::Miter - - - - - - UI\Draw\Line\Join::Round - - - - - - UI\Draw\Line\Join::Bevel - - - - - - -
    - -
    - -
    - - diff --git a/reference/ui/ui.draw.matrix.xml b/reference/ui/ui.draw.matrix.xml deleted file mode 100644 index 54ae7ea24eba..000000000000 --- a/reference/ui/ui.draw.matrix.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - Draw Matrix - UI\Draw\Matrix - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Draw\Matrix - - - - - UI\Draw\Matrix - - - - - &Methods; - - - - -
    - -
    - - &reference.ui.ui.draw.entities.matrix; - -
    - - diff --git a/reference/ui/ui.draw.path.xml b/reference/ui/ui.draw.path.xml deleted file mode 100644 index 273238d76db0..000000000000 --- a/reference/ui/ui.draw.path.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - Draw Path - UI\Draw\Path - - - - -
    - &reftitle.intro; - - A Draw Path guides a Draw Pen, telling the Pen where to draw on an Area. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Draw\Path - - - - - UI\Draw\Path - - - - &Constants; - - const - int - UI\Draw\Path::Winding - - - const - int - UI\Draw\Path::Alternate - - - Constructor - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - UI\Draw\Path::Winding - - - This is the default draw path mode - - - - - - UI\Draw\Path::Alternate - - - This is the alternate draw path mode - - - - - -
    - - - -
    - - &reference.ui.ui.draw.entities.path; - -
    - - diff --git a/reference/ui/ui.draw.pen.xml b/reference/ui/ui.draw.pen.xml deleted file mode 100644 index dd83be9f78bb..000000000000 --- a/reference/ui/ui.draw.pen.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - Draw Pen - UI\Draw\Pen - - - - -
    - &reftitle.intro; - - The Pen is passed to the Area Draw event handler, it is used for clipping, filling, stroking, and writing to Draw Paths. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Draw\Pen - - - - - final - UI\Draw\Pen - - - - - &Methods; - - - - -
    - -
    - - &reference.ui.ui.draw.entities.pen; - -
    - - diff --git a/reference/ui/ui.draw.stroke.xml b/reference/ui/ui.draw.stroke.xml deleted file mode 100644 index c11b3d434f1c..000000000000 --- a/reference/ui/ui.draw.stroke.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - Draw Stroke - UI\Draw\Stroke - - - - -
    - &reftitle.intro; - - Holds the configuration for the Pen to perform a stroke - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Draw\Stroke - - - - - UI\Draw\Stroke - - - - - Constructor - - - &Methods; - - - - -
    - -
    - - &reference.ui.ui.draw.entities.stroke; - -
    - - diff --git a/reference/ui/ui.draw.text.font.descriptor.xml b/reference/ui/ui.draw.text.font.descriptor.xml deleted file mode 100644 index 1acec0444525..000000000000 --- a/reference/ui/ui.draw.text.font.descriptor.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - Font Descriptor - UI\Draw\Text\Font\Descriptor - - - - -
    - &reftitle.intro; - - Describes a font - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Draw\Text\Font\Descriptor - - - - - UI\Draw\Text\Font\Descriptor - - - - - Constructor - - - &Methods; - - - - -
    - -
    - - &reference.ui.ui.draw.text.entities.font.descriptor; - -
    - - diff --git a/reference/ui/ui.draw.text.font.italic.xml b/reference/ui/ui.draw.text.font.italic.xml deleted file mode 100644 index 34c1bbaa53e7..000000000000 --- a/reference/ui/ui.draw.text.font.italic.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - Italic Font Settings - UI\Draw\Text\Font\Italic - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Draw\Text\Font\Italic - - - - - final - UI\Draw\Text\Font\Italic - - - - &Constants; - - const - int - UI\Draw\Text\Font\Italic::Normal - 0 - - - const - int - UI\Draw\Text\Font\Italic::Oblique - 1 - - - const - int - UI\Draw\Text\Font\Italic::Italic - 2 - - - - - -
    - - -
    - &reftitle.constants; - - - - UI\Draw\Text\Font\Italic::Normal - - - - - - UI\Draw\Text\Font\Italic::Oblique - - - - - - UI\Draw\Text\Font\Italic::Italic - - - - - - -
    - -
    - -
    - - diff --git a/reference/ui/ui.draw.text.font.stretch.xml b/reference/ui/ui.draw.text.font.stretch.xml deleted file mode 100644 index 4f3da6c698b6..000000000000 --- a/reference/ui/ui.draw.text.font.stretch.xml +++ /dev/null @@ -1,182 +0,0 @@ - - - - - - Font Stretch Settings - UI\Draw\Text\Font\Stretch - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Draw\Text\Font\Stretch - - - - - final - UI\Draw\Text\Font\Stretch - - - - &Constants; - - const - int - UI\Draw\Text\Font\Stretch::UltraCondensed - 0 - - - const - int - UI\Draw\Text\Font\Stretch::ExtraCondensed - 1 - - - const - int - UI\Draw\Text\Font\Stretch::Condensed - 2 - - - const - int - UI\Draw\Text\Font\Stretch::SemiCondensed - 3 - - - const - int - UI\Draw\Text\Font\Stretch::Normal - 4 - - - const - int - UI\Draw\Text\Font\Stretch::SemiExpanded - 5 - - - const - int - UI\Draw\Text\Font\Stretch::Expanded - 6 - - - const - int - UI\Draw\Text\Font\Stretch::ExtraExpanded - 7 - - - const - int - UI\Draw\Text\Font\Stretch::UltraExpanded - 8 - - - - - -
    - - -
    - &reftitle.constants; - - - - UI\Draw\Text\Font\Stretch::UltraCondensed - - - - - - UI\Draw\Text\Font\Stretch::ExtraCondensed - - - - - - UI\Draw\Text\Font\Stretch::Condensed - - - - - - UI\Draw\Text\Font\Stretch::SemiCondensed - - - - - - UI\Draw\Text\Font\Stretch::Normal - - - - - - UI\Draw\Text\Font\Stretch::SemiExpanded - - - - - - UI\Draw\Text\Font\Stretch::Expanded - - - - - - UI\Draw\Text\Font\Stretch::ExtraExpanded - - - - - - UI\Draw\Text\Font\Stretch::UltraExpanded - - - - - - -
    - -
    - -
    - - diff --git a/reference/ui/ui.draw.text.font.weight.xml b/reference/ui/ui.draw.text.font.weight.xml deleted file mode 100644 index ab3952e8c857..000000000000 --- a/reference/ui/ui.draw.text.font.weight.xml +++ /dev/null @@ -1,195 +0,0 @@ - - - - - - Font Weight Settings - UI\Draw\Text\Font\Weight - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Draw\Text\Font\Weight - - - - - final - UI\Draw\Text\Font\Weight - - - - &Constants; - - const - int - UI\Draw\Text\Font\Weight::Thin - - - const - int - UI\Draw\Text\Font\Weight::UltraLight - - - const - int - UI\Draw\Text\Font\Weight::Light - - - const - int - UI\Draw\Text\Font\Weight::Book - - - const - int - UI\Draw\Text\Font\Weight::Normal - - - const - int - UI\Draw\Text\Font\Weight::Medium - - - const - int - UI\Draw\Text\Font\Weight::SemiBold - - - const - int - UI\Draw\Text\Font\Weight::Bold - - - const - int - UI\Draw\Text\Font\Weight::UltraBold - - - const - int - UI\Draw\Text\Font\Weight::Heavy - - - const - int - UI\Draw\Text\Font\Weight::UltraHeavy - - - - - -
    - - -
    - &reftitle.constants; - - - - UI\Draw\Text\Font\Weight::Thin - - - - - - UI\Draw\Text\Font\Weight::UltraLight - - - - - - UI\Draw\Text\Font\Weight::Light - - - - - - UI\Draw\Text\Font\Weight::Book - - - - - - UI\Draw\Text\Font\Weight::Normal - - - - - - UI\Draw\Text\Font\Weight::Medium - - - - - - UI\Draw\Text\Font\Weight::SemiBold - - - - - - UI\Draw\Text\Font\Weight::Bold - - - - - - UI\Draw\Text\Font\Weight::UltraBold - - - - - - UI\Draw\Text\Font\Weight::Heavy - - - - - - UI\Draw\Text\Font\Weight::UltraHeavy - - - - - - -
    - -
    - -
    - - diff --git a/reference/ui/ui.draw.text.font.xml b/reference/ui/ui.draw.text.font.xml deleted file mode 100644 index f1084d49a84c..000000000000 --- a/reference/ui/ui.draw.text.font.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - Represents a Font - UI\Draw\Text\Font - - - - -
    - &reftitle.intro; - - Loads a described font - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Draw\Text\Font - - - - - UI\Draw\Text\Font - - - - - Constructor - - - &Methods; - - - - - -
    - -
    - - &reference.ui.ui.draw.text.entities.font; - -
    - - diff --git a/reference/ui/ui.draw.text.layout.xml b/reference/ui/ui.draw.text.layout.xml deleted file mode 100644 index 5a86970d2f21..000000000000 --- a/reference/ui/ui.draw.text.layout.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - Represents Text Layout - UI\Draw\Text\Layout - - - - -
    - &reftitle.intro; - - A Text Layout represents the layout of text which will be drawn by the Pen - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Draw\Text\Layout - - - - - UI\Draw\Text\Layout - - - - - Constructor - - - &Methods; - - - - -
    - -
    - - &reference.ui.ui.draw.text.entities.layout; - -
    - - diff --git a/reference/ui/ui.exception.invalidargumentexception.xml b/reference/ui/ui.exception.invalidargumentexception.xml deleted file mode 100644 index 434da197d86d..000000000000 --- a/reference/ui/ui.exception.invalidargumentexception.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - InvalidArgumentException - UI\Exception\InvalidArgumentException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Exception\InvalidArgumentException - - - - - UI\Exception\InvalidArgumentException - - - - extends - InvalidArgumentException - - - - Throwable - - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
    - -
    - -
    - - diff --git a/reference/ui/ui.exception.runtimeexception.xml b/reference/ui/ui.exception.runtimeexception.xml deleted file mode 100644 index 89f379417214..000000000000 --- a/reference/ui/ui.exception.runtimeexception.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - RuntimeException - UI\Exception\RuntimeException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Exception\RuntimeException - - - - - UI\Exception\RuntimeException - - - - extends - RuntimeException - - - - Throwable - - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
    - -
    - -
    - - diff --git a/reference/ui/ui.executor.xml b/reference/ui/ui.executor.xml deleted file mode 100644 index cf240f1bc7fa..000000000000 --- a/reference/ui/ui.executor.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - Execution Scheduler - UI\Executor - - - - -
    - &reftitle.intro; - - This facility schedules repetitive execution of a callback, useful for animations and other such activities. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Executor - - - - - abstract - UI\Executor - - - - - Constructor - - - &Methods; - - - - -
    - -
    - - &reference.ui.ui.entities.executor; - -
    - - diff --git a/reference/ui/ui.key.xml b/reference/ui/ui.key.xml deleted file mode 100644 index cf1e612c87bc..000000000000 --- a/reference/ui/ui.key.xml +++ /dev/null @@ -1,503 +0,0 @@ - - - - - - Key Identifiers - UI\Key - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Key - - - - - final - UI\Key - - - - &Constants; - - const - int - UI\Key::Escape - - - const - int - UI\Key::Insert - - - const - int - UI\Key::Delete - - - const - int - UI\Key::Home - - - const - int - UI\Key::End - - - const - int - UI\Key::PageUp - - - const - int - UI\Key::PageDown - - - const - int - UI\Key::Up - - - const - int - UI\Key::Down - - - const - int - UI\Key::Left - - - const - int - UI\Key::Right - - - const - int - UI\Key::F1 - - - const - int - UI\Key::F2 - - - const - int - UI\Key::F3 - - - const - int - UI\Key::F4 - - - const - int - UI\Key::F5 - - - const - int - UI\Key::F6 - - - const - int - UI\Key::F7 - - - const - int - UI\Key::F8 - - - const - int - UI\Key::F9 - - - const - int - UI\Key::F10 - - - const - int - UI\Key::F11 - - - const - int - UI\Key::F12 - - - const - int - UI\Key::N0 - - - const - int - UI\Key::N1 - - - const - int - UI\Key::N2 - - - const - int - UI\Key::N3 - - - const - int - UI\Key::N4 - - - const - int - UI\Key::N5 - - - const - int - UI\Key::N6 - - - const - int - UI\Key::N7 - - - const - int - UI\Key::N8 - - - const - int - UI\Key::N9 - - - const - int - UI\Key::NDot - - - const - int - UI\Key::NEnter - - - const - int - UI\Key::NAdd - - - const - int - UI\Key::NSubtract - - - const - int - UI\Key::NMultiply - - - const - int - UI\Key::NDivide - - - - - -
    - - -
    - &reftitle.constants; - - - - UI\Key::Escape - - - - - - UI\Key::Insert - - - - - - UI\Key::Delete - - - - - - UI\Key::Home - - - - - - UI\Key::End - - - - - - UI\Key::PageUp - - - - - - UI\Key::PageDown - - - - - - UI\Key::Up - - - - - - UI\Key::Down - - - - - - UI\Key::Left - - - - - - UI\Key::Right - - - - - - UI\Key::F1 - - - - - - UI\Key::F2 - - - - - - UI\Key::F3 - - - - - - UI\Key::F4 - - - - - - UI\Key::F5 - - - - - - UI\Key::F6 - - - - - - UI\Key::F7 - - - - - - UI\Key::F8 - - - - - - UI\Key::F9 - - - - - - UI\Key::F10 - - - - - - UI\Key::F11 - - - - - - UI\Key::F12 - - - - - - UI\Key::N0 - - - - - - UI\Key::N1 - - - - - - UI\Key::N2 - - - - - - UI\Key::N3 - - - - - - UI\Key::N4 - - - - - - UI\Key::N5 - - - - - - UI\Key::N6 - - - - - - UI\Key::N7 - - - - - - UI\Key::N8 - - - - - - UI\Key::N9 - - - - - - UI\Key::NDot - - - - - - UI\Key::NEnter - - - - - - UI\Key::NAdd - - - - - - UI\Key::NSubtract - - - - - - UI\Key::NMultiply - - - - - - UI\Key::NDivide - - - - - - -
    - -
    - -
    - - diff --git a/reference/ui/ui.menu.xml b/reference/ui/ui.menu.xml deleted file mode 100644 index dce779bc860d..000000000000 --- a/reference/ui/ui.menu.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - Menu - UI\Menu - - - - -
    - &reftitle.intro; - - Menus must be constructed before the first Window, and can be shown on any Window - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Menu - - - - - UI\Menu - - - - - Constructor - - - &Methods; - - - - -
    - -
    - - &reference.ui.ui.entities.menu; - -
    - - diff --git a/reference/ui/ui.menuitem.xml b/reference/ui/ui.menuitem.xml deleted file mode 100644 index 165720394dba..000000000000 --- a/reference/ui/ui.menuitem.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - Menu Item - UI\MenuItem - - - - -
    - &reftitle.intro; - - Menu Items should only be created by the Menu - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\MenuItem - - - - - UI\MenuItem - - - - - &Methods; - - - - -
    - -
    - - &reference.ui.ui.entities.menuitem; - -
    - - diff --git a/reference/ui/ui.point.xml b/reference/ui/ui.point.xml deleted file mode 100644 index 2e47a6987afb..000000000000 --- a/reference/ui/ui.point.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - Represents a position (x,y) - UI\Point - - - - -
    - &reftitle.intro; - - Points are used throughout UI to represent co-ordinates on a screen, control, or area. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Point - - - - - final - UI\Point - - - - &Properties; - - public - x - - - public - y - - - Constructor - - - &Methods; - - - - -
    - - - -
    - &reftitle.properties; - - - x - - - Holds the X co-ordinate, can be read/written directly - - - - - y - - - Holds the Y co-ordinate, can be read/written directly - - - - -
    - - - -
    - - &reference.ui.ui.entities.point; - -
    - - diff --git a/reference/ui/ui.size.xml b/reference/ui/ui.size.xml deleted file mode 100644 index a285ac0aeab6..000000000000 --- a/reference/ui/ui.size.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Represents dimensions (width, height) - UI\Size - - - - -
    - &reftitle.intro; - - Sizes are used throughout UI to represent the size of a screen, control, or area. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Size - - - - - final - UI\Size - - - - &Properties; - - public - width - - - public - height - - - Constructor - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - width - - - Holds the width, can be read/written directly - - - - - height - - - Holds the height, can be read/written directly - - - - -
    - - -
    - - &reference.ui.ui.entities.size; - -
    - - diff --git a/reference/ui/ui.window.xml b/reference/ui/ui.window.xml deleted file mode 100644 index 4a63a06d1bac..000000000000 --- a/reference/ui/ui.window.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Window - UI\Window - - - - -
    - &reftitle.intro; - - Represents a UI Window - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Window - - - - - UI\Window - - - - extends - UI\Control - - - - &Properties; - - protected - controls - - - Constructor - - - &Methods; - - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.properties; - - - controls - - - Contains controls, should not be manipulated directly - - - - -
    - - -
    - - &reference.ui.ui.entities.window; - -
    - - diff --git a/reference/ui/ui/area/ondraw.xml b/reference/ui/ui/area/ondraw.xml deleted file mode 100644 index f971e9ef3fb8..000000000000 --- a/reference/ui/ui/area/ondraw.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - UI\Area::onDraw - Draw Callback - - - - &reftitle.description; - - protected UI\Area::onDraw - UI\Draw\Penpen - UI\SizeareaSize - UI\PointclipPoint - UI\SizeclipSize - - - Shall be invoked when this Area requires redrawing - - - - - - &reftitle.parameters; - - - pen - - - A Pen suitable for drawing in this Area - - - - - areaSize - - - The size of the Area - - - - - clipPoint - - - The clip point of the Area - - - - - clipSize - - - The clip size of the Area - - - - - - - - - diff --git a/reference/ui/ui/area/onkey.xml b/reference/ui/ui/area/onkey.xml deleted file mode 100644 index 9a22470403b4..000000000000 --- a/reference/ui/ui/area/onkey.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - UI\Area::onKey - Key Callback - - - - &reftitle.description; - - protected UI\Area::onKey - stringkey - intext - intflags - - - Shall be executed on key events - - - - - - &reftitle.parameters; - - - key - - - The key pressed - - - - - ext - - - The extended key pressed - - - - - flags - - - Event modifiers - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/area/onmouse.xml b/reference/ui/ui/area/onmouse.xml deleted file mode 100644 index da448b6584cb..000000000000 --- a/reference/ui/ui/area/onmouse.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - UI\Area::onMouse - Mouse Callback - - - - &reftitle.description; - - protected UI\Area::onMouse - UI\PointareaPoint - UI\SizeareaSize - intflags - - - Shall be executed on mouse events - - - - - - &reftitle.parameters; - - - areaPoint - - - The co-ordinates of the event - - - - - areaSize - - - The size of the area of the event - - - - - flags - - - Event modifiers - - - - - - - - - diff --git a/reference/ui/ui/area/redraw.xml b/reference/ui/ui/area/redraw.xml deleted file mode 100644 index 9fb70ec27a55..000000000000 --- a/reference/ui/ui/area/redraw.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Area::redraw - Redraw Area - - - - &reftitle.description; - - public UI\Area::redraw - - - - Requests that this Area is redrawn - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/area/scrollto.xml b/reference/ui/ui/area/scrollto.xml deleted file mode 100644 index 43ef2d991b93..000000000000 --- a/reference/ui/ui/area/scrollto.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - UI\Area::scrollTo - Area Scroll - - - - &reftitle.description; - - public UI\Area::scrollTo - UI\Pointpoint - UI\Sizesize - - - Scroll this Area - - - - - - &reftitle.parameters; - - - point - - - The point to scroll to - - - - - size - - - The size of the scroll pane - - - - - - - - - diff --git a/reference/ui/ui/area/setsize.xml b/reference/ui/ui/area/setsize.xml deleted file mode 100644 index 49d734b23eb7..000000000000 --- a/reference/ui/ui/area/setsize.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Area::setSize - Set Size - - - - &reftitle.description; - - public UI\Area::setSize - UI\Sizesize - - - Sets the size of this Area - - - - - - &reftitle.parameters; - - - size - - - The new size - - - - - - - - - - diff --git a/reference/ui/ui/control/destroy.xml b/reference/ui/ui/control/destroy.xml deleted file mode 100644 index 0dfe346966ec..000000000000 --- a/reference/ui/ui/control/destroy.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Control::destroy - Destroy Control - - - - &reftitle.description; - - public UI\Control::destroy - - - - Shall destroy this Control - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/control/disable.xml b/reference/ui/ui/control/disable.xml deleted file mode 100644 index b1df41f497e4..000000000000 --- a/reference/ui/ui/control/disable.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Control::disable - Disable Control - - - - &reftitle.description; - - public UI\Control::disable - - - - Shall disable this Control - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/control/enable.xml b/reference/ui/ui/control/enable.xml deleted file mode 100644 index 907ebc1ce8a3..000000000000 --- a/reference/ui/ui/control/enable.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Control::enable - Enable Control - - - - &reftitle.description; - - public UI\Control::enable - - - - Shall enable this Control - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/control/getparent.xml b/reference/ui/ui/control/getparent.xml deleted file mode 100644 index 3945071b0d7e..000000000000 --- a/reference/ui/ui/control/getparent.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Control::getParent - Get Parent Control - - - - &reftitle.description; - - public UI\ControlUI\Control::getParent - - - - Shall return the parent Control - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/control/gettoplevel.xml b/reference/ui/ui/control/gettoplevel.xml deleted file mode 100644 index 0fa6de8a430b..000000000000 --- a/reference/ui/ui/control/gettoplevel.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Control::getTopLevel - Get Top Level - - - - &reftitle.description; - - public intUI\Control::getTopLevel - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/control/hide.xml b/reference/ui/ui/control/hide.xml deleted file mode 100644 index b8dd6da8cb1c..000000000000 --- a/reference/ui/ui/control/hide.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Control::hide - Hide Control - - - - &reftitle.description; - - public UI\Control::hide - - - - Shall hide this Control - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/control/isenabled.xml b/reference/ui/ui/control/isenabled.xml deleted file mode 100644 index 07a33918b0c3..000000000000 --- a/reference/ui/ui/control/isenabled.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Control::isEnabled - Determine if Control is enabled - - - - &reftitle.description; - - public boolUI\Control::isEnabled - - - - Shall detect if this Control is enabled - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/control/isvisible.xml b/reference/ui/ui/control/isvisible.xml deleted file mode 100644 index 0d7d70428e71..000000000000 --- a/reference/ui/ui/control/isvisible.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Control::isVisible - Determine if Control is visible - - - - &reftitle.description; - - public boolUI\Control::isVisible - - - - Shall detect if this Control is visible - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/control/setparent.xml b/reference/ui/ui/control/setparent.xml deleted file mode 100644 index 851a728e2a1d..000000000000 --- a/reference/ui/ui/control/setparent.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - UI\Control::setParent - Set Parent Control - - - - &reftitle.description; - - public UI\Control::setParent - UI\Controlparent - - - Shall set the parent Control of this Control - - - - - - &reftitle.parameters; - - - parent - - - The parent Control - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/control/show.xml b/reference/ui/ui/control/show.xml deleted file mode 100644 index 8fe37f6d1ff4..000000000000 --- a/reference/ui/ui/control/show.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Control::show - Control Show - - - - &reftitle.description; - - public UI\Control::show - - - - Shall show this Control - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/controls/box/append.xml b/reference/ui/ui/controls/box/append.xml deleted file mode 100644 index 0d199a8bcdce..000000000000 --- a/reference/ui/ui/controls/box/append.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - UI\Controls\Box::append - Append Control - - - - &reftitle.description; - - public intUI\Controls\Box::append - Controlcontrol - boolstretchy&false; - - - Shall append the given control to this Box - - - - - - &reftitle.parameters; - - - control - - - The control to append - - - - - stretchy - - - Set true to stretch the control - - - - - - - - &reftitle.returnvalues; - - Shall return the index of the appended control, may be 0 - - - - - - - diff --git a/reference/ui/ui/controls/box/construct.xml b/reference/ui/ui/controls/box/construct.xml deleted file mode 100644 index 6d3b2b20102c..000000000000 --- a/reference/ui/ui/controls/box/construct.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - UI\Controls\Box::__construct - Construct a new Box - - - - &reftitle.description; - - public UI\Controls\Box::__construct - intorientationUI\Controls\Box::Horizontal - - - Shall construct a new box - - - - - - &reftitle.parameters; - - - orientation - - - Box::Horizontal or Box::Vertical - - - - - - - - - - - diff --git a/reference/ui/ui/controls/box/delete.xml b/reference/ui/ui/controls/box/delete.xml deleted file mode 100644 index 36f5c12efe27..000000000000 --- a/reference/ui/ui/controls/box/delete.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - UI\Controls\Box::delete - Delete Control - - - - &reftitle.description; - - public boolUI\Controls\Box::delete - intindex - - - Shall delete the control at the given index from this Box - - - - - - &reftitle.parameters; - - - index - - - The index of the control to delete - - - - - - - - &reftitle.returnvalues; - - Indication of success - - - - - - diff --git a/reference/ui/ui/controls/box/getorientation.xml b/reference/ui/ui/controls/box/getorientation.xml deleted file mode 100644 index c3de918e9098..000000000000 --- a/reference/ui/ui/controls/box/getorientation.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - UI\Controls\Box::getOrientation - Get Orientation - - - - &reftitle.description; - - public intUI\Controls\Box::getOrientation - - - - Shall retrieve the orientation of this Box - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - diff --git a/reference/ui/ui/controls/box/ispadded.xml b/reference/ui/ui/controls/box/ispadded.xml deleted file mode 100644 index beb15d6a406d..000000000000 --- a/reference/ui/ui/controls/box/ispadded.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Controls\Box::isPadded - Padding Detection - - - - &reftitle.description; - - public boolUI\Controls\Box::isPadded - - - - Shall detect if padding is enabled on this Box - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/controls/box/setpadded.xml b/reference/ui/ui/controls/box/setpadded.xml deleted file mode 100644 index f20137f83a8e..000000000000 --- a/reference/ui/ui/controls/box/setpadded.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\Box::setPadded - Set Padding - - - - &reftitle.description; - - public UI\Controls\Box::setPadded - boolpadded - - - Shall enable or disable padding on this Box - - - - - - &reftitle.parameters; - - - padded - - - - - - - - - - - - - diff --git a/reference/ui/ui/controls/button/construct.xml b/reference/ui/ui/controls/button/construct.xml deleted file mode 100644 index 36dcb48dd1c8..000000000000 --- a/reference/ui/ui/controls/button/construct.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - UI\Controls\Button::__construct - Construct a new Button - - - - &reftitle.description; - - public UI\Controls\Button::__construct - stringtext - - - Shall construct a new Button - - - - - - &reftitle.parameters; - - - text - - - The text (label) for this Button - - - - - - - - - - - diff --git a/reference/ui/ui/controls/button/gettext.xml b/reference/ui/ui/controls/button/gettext.xml deleted file mode 100644 index fda90a4e6f8d..000000000000 --- a/reference/ui/ui/controls/button/gettext.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Controls\Button::getText - Get Text - - - - &reftitle.description; - - public stringUI\Controls\Button::getText - - - - Shall retrieve the text (label) for this Button - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The current text (label) - - - - - - - diff --git a/reference/ui/ui/controls/button/onclick.xml b/reference/ui/ui/controls/button/onclick.xml deleted file mode 100644 index 6fdf9ce4d444..000000000000 --- a/reference/ui/ui/controls/button/onclick.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - UI\Controls\Button::onClick - Click Handler - - - - &reftitle.description; - - protected UI\Controls\Button::onClick - - - - Shall be executed when this Button is clicked - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - diff --git a/reference/ui/ui/controls/button/settext.xml b/reference/ui/ui/controls/button/settext.xml deleted file mode 100644 index 6604cddd9d99..000000000000 --- a/reference/ui/ui/controls/button/settext.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - UI\Controls\Button::setText - Set Text - - - - &reftitle.description; - - public UI\Controls\Button::setText - stringtext - - - Shall set the text (label) for this Button - - - - - - &reftitle.parameters; - - - text - - - The new text (label) - - - - - - - - - diff --git a/reference/ui/ui/controls/check/construct.xml b/reference/ui/ui/controls/check/construct.xml deleted file mode 100644 index 600c1e9aebdc..000000000000 --- a/reference/ui/ui/controls/check/construct.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - UI\Controls\Check::__construct - Construct a new Check - - - - &reftitle.description; - - public UI\Controls\Check::__construct - stringtext - - - Shall construct a new Check - - - - - - &reftitle.parameters; - - - text - - - The text (label) for the Check box - - - - - - - - - diff --git a/reference/ui/ui/controls/check/gettext.xml b/reference/ui/ui/controls/check/gettext.xml deleted file mode 100644 index 4856d3daf3fa..000000000000 --- a/reference/ui/ui/controls/check/gettext.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Controls\Check::getText - Get Text - - - - &reftitle.description; - - public stringUI\Controls\Check::getText - - - - Shall return the text (label) for this Check - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The current text (label) - - - - - - - diff --git a/reference/ui/ui/controls/check/ischecked.xml b/reference/ui/ui/controls/check/ischecked.xml deleted file mode 100644 index 1c35432049e3..000000000000 --- a/reference/ui/ui/controls/check/ischecked.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Controls\Check::isChecked - Checked Detection - - - - &reftitle.description; - - public boolUI\Controls\Check::isChecked - - - - Shall detect the status of this Check - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/controls/check/ontoggle.xml b/reference/ui/ui/controls/check/ontoggle.xml deleted file mode 100644 index aa2e59effe66..000000000000 --- a/reference/ui/ui/controls/check/ontoggle.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Controls\Check::onToggle - Toggle Callback - - - - &reftitle.description; - - protected UI\Controls\Check::onToggle - - - - Shall be executed when the status of this Check is changed - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/controls/check/setchecked.xml b/reference/ui/ui/controls/check/setchecked.xml deleted file mode 100644 index 46c2400ef3eb..000000000000 --- a/reference/ui/ui/controls/check/setchecked.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\Check::setChecked - Set Checked - - - - &reftitle.description; - - public UI\Controls\Check::setChecked - boolchecked - - - Shall change the status of this Check - - - - - - &reftitle.parameters; - - - checked - - - The new status - - - - - - - - - - diff --git a/reference/ui/ui/controls/check/settext.xml b/reference/ui/ui/controls/check/settext.xml deleted file mode 100644 index de2642afe79c..000000000000 --- a/reference/ui/ui/controls/check/settext.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\Check::setText - Set Text - - - - &reftitle.description; - - public UI\Controls\Check::setText - stringtext - - - Shall set the text (label) for this Check - - - - - - &reftitle.parameters; - - - text - - - The new text (label) - - - - - - - - - - diff --git a/reference/ui/ui/controls/colorbutton/getcolor.xml b/reference/ui/ui/controls/colorbutton/getcolor.xml deleted file mode 100644 index f5205749c2fc..000000000000 --- a/reference/ui/ui/controls/colorbutton/getcolor.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Controls\ColorButton::getColor - Get Color - - - - &reftitle.description; - - public UI\ColorUI\Controls\ColorButton::getColor - - - - Shall retrieve the currently selected Color - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/controls/colorbutton/onchange.xml b/reference/ui/ui/controls/colorbutton/onchange.xml deleted file mode 100644 index a9256e50a87a..000000000000 --- a/reference/ui/ui/controls/colorbutton/onchange.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Controls\ColorButton::onChange - Change Handler - - - - &reftitle.description; - - protected UI\Controls\ColorButton::onChange - - - - Shall be executed when the selected Color is changed - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/controls/colorbutton/setcolor.xml b/reference/ui/ui/controls/colorbutton/setcolor.xml deleted file mode 100644 index 07b2dd1fab55..000000000000 --- a/reference/ui/ui/controls/colorbutton/setcolor.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - UI\Controls\ColorButton::setColor - Set Color - - - - &reftitle.description; - - public UI\Controls\ColorButton::setColor - UI\Draw\Colorcolor - - - public UI\Controls\ColorButton::setColor - intcolor - - - Shall set the currently selected Color - - - - - - &reftitle.parameters; - - - color - - - The new color - - - - - - - - - - diff --git a/reference/ui/ui/controls/combo/append.xml b/reference/ui/ui/controls/combo/append.xml deleted file mode 100644 index be6012ab7916..000000000000 --- a/reference/ui/ui/controls/combo/append.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\Combo::append - Append Option - - - - &reftitle.description; - - public UI\Controls\Combo::append - stringtext - - - Append an option to this Combo - - - - - - &reftitle.parameters; - - - text - - - The text for the new option - - - - - - - - - - diff --git a/reference/ui/ui/controls/combo/getselected.xml b/reference/ui/ui/controls/combo/getselected.xml deleted file mode 100644 index 0feb52925e72..000000000000 --- a/reference/ui/ui/controls/combo/getselected.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Controls\Combo::getSelected - Get Selected Option - - - - &reftitle.description; - - public intUI\Controls\Combo::getSelected - - - - Shall retrieve the index of the option selected in this Combo - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/controls/combo/onselected.xml b/reference/ui/ui/controls/combo/onselected.xml deleted file mode 100644 index 57f7ff8d6893..000000000000 --- a/reference/ui/ui/controls/combo/onselected.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Controls\Combo::onSelected - Selected Handler - - - - &reftitle.description; - - protected UI\Controls\Combo::onSelected - - - - Shall be executed when an option is selected in this Combo - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/controls/combo/setselected.xml b/reference/ui/ui/controls/combo/setselected.xml deleted file mode 100644 index 1755fcbb6459..000000000000 --- a/reference/ui/ui/controls/combo/setselected.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\Combo::setSelected - Set Selected Option - - - - &reftitle.description; - - public UI\Controls\Combo::setSelected - intindex - - - Shall set the currently selected option in this Combo - - - - - - &reftitle.parameters; - - - index - - - The index of the option to select - - - - - - - - - - diff --git a/reference/ui/ui/controls/editablecombo/append.xml b/reference/ui/ui/controls/editablecombo/append.xml deleted file mode 100644 index 333b35c7da72..000000000000 --- a/reference/ui/ui/controls/editablecombo/append.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\EditableCombo::append - Append Option - - - - &reftitle.description; - - public UI\Controls\EditableCombo::append - stringtext - - - Shall append a new option to this Editable Combo - - - - - - &reftitle.parameters; - - - text - - - The text for the new option - - - - - - - - - - diff --git a/reference/ui/ui/controls/editablecombo/gettext.xml b/reference/ui/ui/controls/editablecombo/gettext.xml deleted file mode 100644 index f9b151094a8c..000000000000 --- a/reference/ui/ui/controls/editablecombo/gettext.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Controls\EditableCombo::getText - Get Text - - - - &reftitle.description; - - public stringUI\Controls\EditableCombo::getText - - - - Get the value of the currently selected option in this Editable Combo - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/controls/editablecombo/onchange.xml b/reference/ui/ui/controls/editablecombo/onchange.xml deleted file mode 100644 index 09b9a4735df3..000000000000 --- a/reference/ui/ui/controls/editablecombo/onchange.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - UI\Controls\EditableCombo::onChange - Change Handler - - - - &reftitle.description; - - protected UI\Controls\EditableCombo::onChange - - - - Shall be executed when the value of this Editable Combobox changes - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - diff --git a/reference/ui/ui/controls/editablecombo/settext.xml b/reference/ui/ui/controls/editablecombo/settext.xml deleted file mode 100644 index 82982d41e80c..000000000000 --- a/reference/ui/ui/controls/editablecombo/settext.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\EditableCombo::setText - Set Text - - - - &reftitle.description; - - public UI\Controls\EditableCombo::setText - stringtext - - - Shall set the text of the currently selected option in this Editable Combo - - - - - - &reftitle.parameters; - - - text - - - The new text - - - - - - - - - - diff --git a/reference/ui/ui/controls/entry/construct.xml b/reference/ui/ui/controls/entry/construct.xml deleted file mode 100644 index a645a77e7c4f..000000000000 --- a/reference/ui/ui/controls/entry/construct.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - UI\Controls\Entry::__construct - Construct a new Entry - - - - &reftitle.description; - - public UI\Controls\Entry::__construct - inttypeUI\Controls\Entry::Normal - - - Construct a new entry of the given type - - - - - - &reftitle.parameters; - - - type - - - Entry::Normal, Entry::Password, or Entry::Search - - - - - - - - - diff --git a/reference/ui/ui/controls/entry/gettext.xml b/reference/ui/ui/controls/entry/gettext.xml deleted file mode 100644 index 56d0d914ede9..000000000000 --- a/reference/ui/ui/controls/entry/gettext.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Controls\Entry::getText - Get Text - - - - &reftitle.description; - - public stringUI\Controls\Entry::getText - - - - Shall return the current text from this Entry - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The current text - - - - - - - diff --git a/reference/ui/ui/controls/entry/isreadonly.xml b/reference/ui/ui/controls/entry/isreadonly.xml deleted file mode 100644 index e6231563e52e..000000000000 --- a/reference/ui/ui/controls/entry/isreadonly.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Controls\Entry::isReadOnly - Detect Read Only - - - - &reftitle.description; - - public boolUI\Controls\Entry::isReadOnly - - - - Shall detect if this Entry is read only - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/controls/entry/onchange.xml b/reference/ui/ui/controls/entry/onchange.xml deleted file mode 100644 index 570e1eec1664..000000000000 --- a/reference/ui/ui/controls/entry/onchange.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - UI\Controls\Entry::onChange - Change Handler - - - - &reftitle.description; - - protected UI\Controls\Entry::onChange - - - - Shall be executed when the text in this Entry changes - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - diff --git a/reference/ui/ui/controls/entry/setreadonly.xml b/reference/ui/ui/controls/entry/setreadonly.xml deleted file mode 100644 index a7151962f9d7..000000000000 --- a/reference/ui/ui/controls/entry/setreadonly.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\Entry::setReadOnly - Set Read Only - - - - &reftitle.description; - - public UI\Controls\Entry::setReadOnly - boolreadOnly - - - Shall enable or disable read only for this Entry - - - - - - &reftitle.parameters; - - - readOnly - - - - - - - - - - - - - diff --git a/reference/ui/ui/controls/entry/settext.xml b/reference/ui/ui/controls/entry/settext.xml deleted file mode 100644 index 2c7399359333..000000000000 --- a/reference/ui/ui/controls/entry/settext.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\Entry::setText - Set Text - - - - &reftitle.description; - - public UI\Controls\Entry::setText - stringtext - - - Shall set the text for this Entry - - - - - - &reftitle.parameters; - - - text - - - The new text - - - - - - - - - - diff --git a/reference/ui/ui/controls/form/append.xml b/reference/ui/ui/controls/form/append.xml deleted file mode 100644 index 123b37f37b00..000000000000 --- a/reference/ui/ui/controls/form/append.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - UI\Controls\Form::append - Append Control - - - - &reftitle.description; - - public intUI\Controls\Form::append - stringlabel - UI\Controlcontrol - boolstretchy&false; - - - Shall append the control to the form, and set the label - - - - - - &reftitle.parameters; - - - label - - - The text for the label - - - - - control - - - A control - - - - - stretchy - - - Should be set true to stretch the control - - - - - - - - &reftitle.returnvalues; - - Shall return the index of the appended control, may be 0 - - - - - - - diff --git a/reference/ui/ui/controls/form/delete.xml b/reference/ui/ui/controls/form/delete.xml deleted file mode 100644 index cd7a95b71c14..000000000000 --- a/reference/ui/ui/controls/form/delete.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - UI\Controls\Form::delete - Delete Control - - - - &reftitle.description; - - public boolUI\Controls\Form::delete - intindex - - - Shall delete the control at the given index in this Form - - - - - &reftitle.parameters; - - - index - - - The index of the control to remove - - - - - - - - &reftitle.returnvalues; - - Indication of success - - - - - - - diff --git a/reference/ui/ui/controls/form/ispadded.xml b/reference/ui/ui/controls/form/ispadded.xml deleted file mode 100644 index e37a922b1d52..000000000000 --- a/reference/ui/ui/controls/form/ispadded.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Controls\Form::isPadded - Padding Detection - - - - &reftitle.description; - - public boolUI\Controls\Form::isPadded - - - - Shall detect if padding is enabled on this Form - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/controls/form/setpadded.xml b/reference/ui/ui/controls/form/setpadded.xml deleted file mode 100644 index e7625f6d65e2..000000000000 --- a/reference/ui/ui/controls/form/setpadded.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\Form::setPadded - Set Padding - - - - &reftitle.description; - - public UI\Controls\Form::setPadded - boolpadded - - - Shall enable or disable padding on this Form - - - - - - &reftitle.parameters; - - - padded - - - - - - - - - - - - - diff --git a/reference/ui/ui/controls/grid/append.xml b/reference/ui/ui/controls/grid/append.xml deleted file mode 100644 index d99c64137d4c..000000000000 --- a/reference/ui/ui/controls/grid/append.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - UI\Controls\Grid::append - Append Control - - - - &reftitle.description; - - public UI\Controls\Grid::append - UI\Controlcontrol - intleft - inttop - intxspan - intyspan - boolhexpand - inthalign - boolvexpand - intvalign - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - control - - - The Control to append - - - - - left - - - - - - - - top - - - - - - - - xspan - - - - - - - - yspan - - - - - - - - hexpand - - - - - - - - halign - - - - - - - - vexpand - - - - - - - - valign - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/controls/grid/ispadded.xml b/reference/ui/ui/controls/grid/ispadded.xml deleted file mode 100644 index 0b2a8648668a..000000000000 --- a/reference/ui/ui/controls/grid/ispadded.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Controls\Grid::isPadded - Padding Detection - - - - &reftitle.description; - - public boolUI\Controls\Grid::isPadded - - - - Shall detect if padding is enabled on this Grid - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/controls/grid/setpadded.xml b/reference/ui/ui/controls/grid/setpadded.xml deleted file mode 100644 index 0cb609e54b38..000000000000 --- a/reference/ui/ui/controls/grid/setpadded.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\Grid::setPadded - Set Padding - - - - &reftitle.description; - - public UI\Controls\Grid::setPadded - boolpadding - - - Shall enable or disable padding for this Grid - - - - - - &reftitle.parameters; - - - padding - - - - - - - - - - - - - diff --git a/reference/ui/ui/controls/group/append.xml b/reference/ui/ui/controls/group/append.xml deleted file mode 100644 index 3ca0a77ec738..000000000000 --- a/reference/ui/ui/controls/group/append.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\Group::append - Append Control - - - - &reftitle.description; - - public UI\Controls\Group::append - UI\Controlcontrol - - - Shall append a control to this Group - - - - - - &reftitle.parameters; - - - control - - - The control to append - - - - - - - - - - diff --git a/reference/ui/ui/controls/group/construct.xml b/reference/ui/ui/controls/group/construct.xml deleted file mode 100644 index 5137f3430659..000000000000 --- a/reference/ui/ui/controls/group/construct.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - UI\Controls\Group::__construct - Construct a new Group - - - - &reftitle.description; - - public UI\Controls\Group::__construct - stringtitle - - - Shall construct a new Group with the given title - - - - - - &reftitle.parameters; - - - title - - - The text for the title label - - - - - - - - - - - diff --git a/reference/ui/ui/controls/group/gettitle.xml b/reference/ui/ui/controls/group/gettitle.xml deleted file mode 100644 index 10e8026b5ceb..000000000000 --- a/reference/ui/ui/controls/group/gettitle.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Controls\Group::getTitle - Get Title - - - - &reftitle.description; - - public stringUI\Controls\Group::getTitle - - - - Shall return the current title for this Group - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The current title - - - - - - - diff --git a/reference/ui/ui/controls/group/hasmargin.xml b/reference/ui/ui/controls/group/hasmargin.xml deleted file mode 100644 index 34d4f30c9568..000000000000 --- a/reference/ui/ui/controls/group/hasmargin.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Controls\Group::hasMargin - Margin Detection - - - - &reftitle.description; - - public boolUI\Controls\Group::hasMargin - - - - Shall detect if this Group has a margin - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/controls/group/setmargin.xml b/reference/ui/ui/controls/group/setmargin.xml deleted file mode 100644 index 021d40276a6e..000000000000 --- a/reference/ui/ui/controls/group/setmargin.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\Group::setMargin - Set Margin - - - - &reftitle.description; - - public UI\Controls\Group::setMargin - boolmargin - - - Shall enable or disable margins for this Group - - - - - - &reftitle.parameters; - - - margin - - - - - - - - - - - - - diff --git a/reference/ui/ui/controls/group/settitle.xml b/reference/ui/ui/controls/group/settitle.xml deleted file mode 100644 index a5b4f1c7f65d..000000000000 --- a/reference/ui/ui/controls/group/settitle.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\Group::setTitle - Set Title - - - - &reftitle.description; - - public UI\Controls\Group::setTitle - stringtitle - - - Shall set the title for this Group - - - - - - &reftitle.parameters; - - - title - - - The text for the new title - - - - - - - - - - diff --git a/reference/ui/ui/controls/label/construct.xml b/reference/ui/ui/controls/label/construct.xml deleted file mode 100644 index 05544f24a184..000000000000 --- a/reference/ui/ui/controls/label/construct.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - UI\Controls\Label::__construct - Construct a new Label - - - - &reftitle.description; - - public UI\Controls\Label::__construct - stringtext - - - Shall construct a new Label - - - - - - &reftitle.parameters; - - - text - - - The text for this label - - - - - - - - - diff --git a/reference/ui/ui/controls/label/gettext.xml b/reference/ui/ui/controls/label/gettext.xml deleted file mode 100644 index e7e2fd5195de..000000000000 --- a/reference/ui/ui/controls/label/gettext.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\Label::getText - Get Text - - - - &reftitle.description; - - public stringUI\Controls\Label::getText - - - - Shall return the current text for this Label - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/controls/label/settext.xml b/reference/ui/ui/controls/label/settext.xml deleted file mode 100644 index bf9391cff054..000000000000 --- a/reference/ui/ui/controls/label/settext.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - UI\Controls\Label::setText - Set Text - - - - &reftitle.description; - - public UI\Controls\Label::setText - stringtext - - - Shall set the text for this Label - - - - - - &reftitle.parameters; - - - text - - - The new text - - - - - - - - - diff --git a/reference/ui/ui/controls/multilineentry/append.xml b/reference/ui/ui/controls/multilineentry/append.xml deleted file mode 100644 index 3971e70392e3..000000000000 --- a/reference/ui/ui/controls/multilineentry/append.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\MultilineEntry::append - Append Text - - - - &reftitle.description; - - public UI\Controls\MultilineEntry::append - stringtext - - - Shall append the given text to the text in this Multiline Entry - - - - - - &reftitle.parameters; - - - text - - - The text to append - - - - - - - - - - diff --git a/reference/ui/ui/controls/multilineentry/construct.xml b/reference/ui/ui/controls/multilineentry/construct.xml deleted file mode 100644 index 17ec057cd93b..000000000000 --- a/reference/ui/ui/controls/multilineentry/construct.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - UI\Controls\MultilineEntry::__construct - Construct a new Multiline Entry - - - - &reftitle.description; - - public UI\Controls\MultilineEntry::__construct - inttype - - - Shall construct a new Multiline Entry of the given type - - - - - - &reftitle.parameters; - - - type - - - MultilineEntry::Wrap or MultilineEntry::NoWrap - - - - - - - - - - - diff --git a/reference/ui/ui/controls/multilineentry/gettext.xml b/reference/ui/ui/controls/multilineentry/gettext.xml deleted file mode 100644 index 9e2d48fd3bdc..000000000000 --- a/reference/ui/ui/controls/multilineentry/gettext.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Controls\MultilineEntry::getText - Get Text - - - - &reftitle.description; - - public stringUI\Controls\MultilineEntry::getText - - - - Shall return the text in this Multiline Entry - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/controls/multilineentry/isreadonly.xml b/reference/ui/ui/controls/multilineentry/isreadonly.xml deleted file mode 100644 index 413e3efc12d2..000000000000 --- a/reference/ui/ui/controls/multilineentry/isreadonly.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Controls\MultilineEntry::isReadOnly - Read Only Detection - - - - &reftitle.description; - - public boolUI\Controls\MultilineEntry::isReadOnly - - - - Shall detect if this Multiline Entry is read only - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/controls/multilineentry/onchange.xml b/reference/ui/ui/controls/multilineentry/onchange.xml deleted file mode 100644 index 2c9f18bbec5c..000000000000 --- a/reference/ui/ui/controls/multilineentry/onchange.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - UI\Controls\MultilineEntry::onChange - Change Handler - - - - &reftitle.description; - - protected UI\Controls\MultilineEntry::onChange - - - - Shall be executed when the text in this Multiline Entry is changed - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - diff --git a/reference/ui/ui/controls/multilineentry/setreadonly.xml b/reference/ui/ui/controls/multilineentry/setreadonly.xml deleted file mode 100644 index 107be40102e2..000000000000 --- a/reference/ui/ui/controls/multilineentry/setreadonly.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\MultilineEntry::setReadOnly - Set Read Only - - - - &reftitle.description; - - public UI\Controls\MultilineEntry::setReadOnly - boolreadOnly - - - Shall enable or disable read only on this Multiline Entry - - - - - - &reftitle.parameters; - - - readOnly - - - - - - - - - - - - - diff --git a/reference/ui/ui/controls/multilineentry/settext.xml b/reference/ui/ui/controls/multilineentry/settext.xml deleted file mode 100644 index 367b3a00c657..000000000000 --- a/reference/ui/ui/controls/multilineentry/settext.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - UI\Controls\MultilineEntry::setText - Set Text - - - - &reftitle.description; - - public UI\Controls\MultilineEntry::setText - stringtext - - - Shall set the text in this Multiline Entry - - - - - - &reftitle.parameters; - - - text - - - The new text - - - - - - - - - diff --git a/reference/ui/ui/controls/picker/construct.xml b/reference/ui/ui/controls/picker/construct.xml deleted file mode 100644 index 68ee370cd78d..000000000000 --- a/reference/ui/ui/controls/picker/construct.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - UI\Controls\Picker::__construct - Construct a new Picker - - - - &reftitle.description; - - public UI\Controls\Picker::__construct - inttypeUI\Controls\Picker::Date - - - Construct a new Picker of the given type - - - - - - &reftitle.parameters; - - - type - - - Picker::Date, Picker::Time, or Picker::DateTime - - - - - - - - - - - diff --git a/reference/ui/ui/controls/progress/getvalue.xml b/reference/ui/ui/controls/progress/getvalue.xml deleted file mode 100644 index 286f05001ad0..000000000000 --- a/reference/ui/ui/controls/progress/getvalue.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Controls\Progress::getValue - Get Value - - - - &reftitle.description; - - public intUI\Controls\Progress::getValue - - - - Shall retrieve the current value of this Progress bar - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/controls/progress/setvalue.xml b/reference/ui/ui/controls/progress/setvalue.xml deleted file mode 100644 index ce736ee82477..000000000000 --- a/reference/ui/ui/controls/progress/setvalue.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - UI\Controls\Progress::setValue - Set Value - - - - &reftitle.description; - - public UI\Controls\Progress::setValue - intvalue - - - Shall set the value for this Progress bar - - - - - - &reftitle.parameters; - - - value - - - An integer between 0 and 100 (inclusive) - - - - - - - - - diff --git a/reference/ui/ui/controls/radio/append.xml b/reference/ui/ui/controls/radio/append.xml deleted file mode 100644 index 1ebfd2e02f55..000000000000 --- a/reference/ui/ui/controls/radio/append.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\Radio::append - Append Option - - - - &reftitle.description; - - public UI\Controls\Radio::append - stringtext - - - Shall append a new option to this Radio - - - - - - &reftitle.parameters; - - - text - - - The text (label) for the option - - - - - - - - - - diff --git a/reference/ui/ui/controls/radio/getselected.xml b/reference/ui/ui/controls/radio/getselected.xml deleted file mode 100644 index 104fdca6356d..000000000000 --- a/reference/ui/ui/controls/radio/getselected.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Controls\Radio::getSelected - Get Selected Option - - - - &reftitle.description; - - public intUI\Controls\Radio::getSelected - - - - Shall retrieve the index of the currently selected option in this Radio - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/controls/radio/onselected.xml b/reference/ui/ui/controls/radio/onselected.xml deleted file mode 100644 index 63494f126558..000000000000 --- a/reference/ui/ui/controls/radio/onselected.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - UI\Controls\Radio::onSelected - Selected Handler - - - - &reftitle.description; - - protected UI\Controls\Radio::onSelected - - - - Shall be executed when the option selected in this Radio changes - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - diff --git a/reference/ui/ui/controls/radio/setselected.xml b/reference/ui/ui/controls/radio/setselected.xml deleted file mode 100644 index 01fd2379d65b..000000000000 --- a/reference/ui/ui/controls/radio/setselected.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\Radio::setSelected - Set Selected Option - - - - &reftitle.description; - - public UI\Controls\Radio::setSelected - intindex - - - Shall set the currently selected option in this Radio - - - - - - &reftitle.parameters; - - - index - - - The index of the option to select - - - - - - - - - - diff --git a/reference/ui/ui/controls/separator/construct.xml b/reference/ui/ui/controls/separator/construct.xml deleted file mode 100644 index 7285028a2985..000000000000 --- a/reference/ui/ui/controls/separator/construct.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - UI\Controls\Separator::__construct - Construct a new Separator - - - - &reftitle.description; - - public UI\Controls\Separator::__construct - inttypeUI\Controls\Separator::Horizontal - - - Shall construct a new Separator of the given type - - - - - - &reftitle.parameters; - - - type - - - Separator::Horizontal or Separator::Vertical - - - - - - - - - diff --git a/reference/ui/ui/controls/slider/construct.xml b/reference/ui/ui/controls/slider/construct.xml deleted file mode 100644 index f23dccda992c..000000000000 --- a/reference/ui/ui/controls/slider/construct.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - UI\Controls\Slider::__construct - Construct a new Slider - - - - &reftitle.description; - - public UI\Controls\Slider::__construct - intmin - intmax - - - Construct a new Slider with the given range - - - - - - &reftitle.parameters; - - - min - - - The minimum allowed value - - - - - max - - - The maximum allowed value - - - - - - - - - diff --git a/reference/ui/ui/controls/slider/getvalue.xml b/reference/ui/ui/controls/slider/getvalue.xml deleted file mode 100644 index 1c5acdab2f21..000000000000 --- a/reference/ui/ui/controls/slider/getvalue.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Controls\Slider::getValue - Get Value - - - - &reftitle.description; - - public intUI\Controls\Slider::getValue - - - - Get the value from this Slider - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/controls/slider/onchange.xml b/reference/ui/ui/controls/slider/onchange.xml deleted file mode 100644 index 8de3d27710f1..000000000000 --- a/reference/ui/ui/controls/slider/onchange.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Controls\Slider::onChange - Change Handler - - - - &reftitle.description; - - protected UI\Controls\Slider::onChange - - - - Shall be executed when the value of this Slider changes - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/controls/slider/setvalue.xml b/reference/ui/ui/controls/slider/setvalue.xml deleted file mode 100644 index 9aeeec9b0e35..000000000000 --- a/reference/ui/ui/controls/slider/setvalue.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - UI\Controls\Slider::setValue - Set Value - - - - &reftitle.description; - - public UI\Controls\Slider::setValue - intvalue - - - Shall set the value for this Slider - - - - - - &reftitle.parameters; - - - value - - - The new value - - - - - - - - - diff --git a/reference/ui/ui/controls/spin/construct.xml b/reference/ui/ui/controls/spin/construct.xml deleted file mode 100644 index 9c45077ecbd3..000000000000 --- a/reference/ui/ui/controls/spin/construct.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - UI\Controls\Spin::__construct - Construct a new Spin - - - - &reftitle.description; - - public UI\Controls\Spin::__construct - intmin - intmax - - - Constructs a new Spin with the given range - - - - - - &reftitle.parameters; - - - min - - - The minimum value allowed - - - - - max - - - The maximum value allowed - - - - - - - - - - - diff --git a/reference/ui/ui/controls/spin/getvalue.xml b/reference/ui/ui/controls/spin/getvalue.xml deleted file mode 100644 index 929954d22c12..000000000000 --- a/reference/ui/ui/controls/spin/getvalue.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - UI\Controls\Spin::getValue - Get Value - - - - &reftitle.description; - - public intUI\Controls\Spin::getValue - - - - Get the value in this Spin - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - diff --git a/reference/ui/ui/controls/spin/onchange.xml b/reference/ui/ui/controls/spin/onchange.xml deleted file mode 100644 index 7a788ec36923..000000000000 --- a/reference/ui/ui/controls/spin/onchange.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Controls\Spin::onChange - Change Handler - - - - &reftitle.description; - - protected UI\Controls\Spin::onChange - - - - Shall be executed when the value in this Spin changes - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/controls/spin/setvalue.xml b/reference/ui/ui/controls/spin/setvalue.xml deleted file mode 100644 index 324a6f236444..000000000000 --- a/reference/ui/ui/controls/spin/setvalue.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\Spin::setValue - Set Value - - - - &reftitle.description; - - public UI\Controls\Spin::setValue - intvalue - - - Set the value in this Spin - - - - - - &reftitle.parameters; - - - value - - - The new value - - - - - - - - - - diff --git a/reference/ui/ui/controls/tab/append.xml b/reference/ui/ui/controls/tab/append.xml deleted file mode 100644 index 28d2fc9c6bf6..000000000000 --- a/reference/ui/ui/controls/tab/append.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - UI\Controls\Tab::append - Append Page - - - - &reftitle.description; - - public intUI\Controls\Tab::append - stringname - UI\Controlcontrol - - - Append a new page to this Tab - - - - - - &reftitle.parameters; - - - name - - - The name for the new page - - - - - control - - - The control for the new page - - - - - - - - &reftitle.returnvalues; - - Shall return the index of the appended control, may be 0 - - - - - - - diff --git a/reference/ui/ui/controls/tab/delete.xml b/reference/ui/ui/controls/tab/delete.xml deleted file mode 100644 index e9c4d2830fb6..000000000000 --- a/reference/ui/ui/controls/tab/delete.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - UI\Controls\Tab::delete - Delete Page - - - - &reftitle.description; - - public boolUI\Controls\Tab::delete - intindex - - - Shall remove the selected page from this Tab - - - - - - &reftitle.parameters; - - - index - - - The index of the page to remove - - - - - - - - &reftitle.returnvalues; - - Indication of success - - - - - - diff --git a/reference/ui/ui/controls/tab/hasmargin.xml b/reference/ui/ui/controls/tab/hasmargin.xml deleted file mode 100644 index 658ff37a785d..000000000000 --- a/reference/ui/ui/controls/tab/hasmargin.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - UI\Controls\Tab::hasMargin - Margin Detection - - - - &reftitle.description; - - public boolUI\Controls\Tab::hasMargin - intpage - - - Shall detect if the given page has a margin. - - - - - &reftitle.parameters; - - - page - - - The index of the page - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/controls/tab/insertat.xml b/reference/ui/ui/controls/tab/insertat.xml deleted file mode 100644 index 387b8fe453ac..000000000000 --- a/reference/ui/ui/controls/tab/insertat.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - UI\Controls\Tab::insertAt - Insert Page - - - - &reftitle.description; - - public UI\Controls\Tab::insertAt - stringname - intpage - UI\Controlcontrol - - - Shall insert a new page into this Tab - - - - - - &reftitle.parameters; - - - name - - - The name for the new page - - - - - page - - - The index to perform the insertion before - - - - - control - - - The control for the new page - - - - - - - - - diff --git a/reference/ui/ui/controls/tab/pages.xml b/reference/ui/ui/controls/tab/pages.xml deleted file mode 100644 index 20d8760f529c..000000000000 --- a/reference/ui/ui/controls/tab/pages.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Controls\Tab::pages - Page Count - - - - &reftitle.description; - - public intUI\Controls\Tab::pages - - - - Shall return the number of pages in this Tab - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The number of pages in this Tab - - - - - - - diff --git a/reference/ui/ui/controls/tab/setmargin.xml b/reference/ui/ui/controls/tab/setmargin.xml deleted file mode 100644 index 4143018a94c2..000000000000 --- a/reference/ui/ui/controls/tab/setmargin.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - UI\Controls\Tab::setMargin - Set Margin - - - - &reftitle.description; - - public UI\Controls\Tab::setMargin - intpage - boolmargin - - - Shall enable or disable margins on the selected page - - - - - - &reftitle.parameters; - - - page - - - The page to select - - - - - margin - - - Margin switch - - - - - - - - - diff --git a/reference/ui/ui/draw/brush.gradient/addstop.xml b/reference/ui/ui/draw/brush.gradient/addstop.xml deleted file mode 100644 index ac77d0387114..000000000000 --- a/reference/ui/ui/draw/brush.gradient/addstop.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - UI\Draw\Brush\Gradient::addStop - Stop Manipulation - - - - &reftitle.description; - - public intUI\Draw\Brush\Gradient::addStop - floatposition - UI\Draw\Colorcolor - - - public intUI\Draw\Brush\Gradient::addStop - floatposition - intcolor - - - Shall add a stop of the given color at the given position - - - - - - &reftitle.parameters; - - - position - - - The position for the new stop - - - - - color - - - The color for the new stop, may be UI\Draw\Color or RRGGBBAA - - - - - - - - &reftitle.returnvalues; - - Total number of stops - - - - - - - diff --git a/reference/ui/ui/draw/brush.gradient/delstop.xml b/reference/ui/ui/draw/brush.gradient/delstop.xml deleted file mode 100644 index 7a40a0a32b01..000000000000 --- a/reference/ui/ui/draw/brush.gradient/delstop.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - UI\Draw\Brush\Gradient::delStop - Stop Manipulation - - - - &reftitle.description; - - public intUI\Draw\Brush\Gradient::delStop - intindex - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - index - - - - - - - - - - - &reftitle.returnvalues; - - Total number of stops - - - - - - - diff --git a/reference/ui/ui/draw/brush.gradient/setstop.xml b/reference/ui/ui/draw/brush.gradient/setstop.xml deleted file mode 100644 index f0944eebd64a..000000000000 --- a/reference/ui/ui/draw/brush.gradient/setstop.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - UI\Draw\Brush\Gradient::setStop - Stop Manipulation - - - - &reftitle.description; - - public boolUI\Draw\Brush\Gradient::setStop - intindex - floatposition - UI\Draw\Colorcolor - - - public boolUI\Draw\Brush\Gradient::setStop - intindex - floatposition - intcolor - - - - - - - - - &reftitle.parameters; - - - index - - - The index of the stop to set - - - - - position - - - The position for the stop - - - - - color - - - The color for the stop, may be UI\Draw\Color or RRGGBBAA - - - - - - - - &reftitle.returnvalues; - - Indication of success - - - - - - - diff --git a/reference/ui/ui/draw/brush.lineargradient/construct.xml b/reference/ui/ui/draw/brush.lineargradient/construct.xml deleted file mode 100644 index 20ffabefc2b2..000000000000 --- a/reference/ui/ui/draw/brush.lineargradient/construct.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - UI\Draw\Brush\LinearGradient::__construct - Construct a Linear Gradient - - - - &reftitle.description; - - public UI\Draw\Brush\LinearGradient::__construct - UI\Pointstart - UI\Pointend - - - Shall construct a new linear gradient - - - - - - &reftitle.parameters; - - - start - - - - - - - - end - - - - - - - - - - - - - - - - diff --git a/reference/ui/ui/draw/brush.radialgradient/construct.xml b/reference/ui/ui/draw/brush.radialgradient/construct.xml deleted file mode 100644 index 6269dc12800e..000000000000 --- a/reference/ui/ui/draw/brush.radialgradient/construct.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - UI\Draw\Brush\RadialGradient::__construct - Construct a new Radial Gradient - - - - &reftitle.description; - - public UI\Draw\Brush\RadialGradient::__construct - UI\Pointstart - UI\Pointouter - floatradius - - - Shall construct a new radial gradient - - - - - - &reftitle.parameters; - - - start - - - - - - - - outer - - - - - - - - radius - - - - - - - - - - - - - - - - diff --git a/reference/ui/ui/draw/brush/construct.xml b/reference/ui/ui/draw/brush/construct.xml deleted file mode 100644 index e73d31713067..000000000000 --- a/reference/ui/ui/draw/brush/construct.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - UI\Draw\Brush::__construct - Construct a new Brush - - - - &reftitle.description; - - public UI\Draw\Brush::__construct - UI\Draw\Colorcolor - - - public UI\Draw\Brush::__construct - intcolor - - - Shall construct a solid brush using the given color - - - - - - &reftitle.parameters; - - - color - - - Can be a UI\Draw\Color or RRGGBBAA - - - - - - - - - diff --git a/reference/ui/ui/draw/brush/getcolor.xml b/reference/ui/ui/draw/brush/getcolor.xml deleted file mode 100644 index e9c47cee5992..000000000000 --- a/reference/ui/ui/draw/brush/getcolor.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Draw\Brush::getColor - Get Color - - - - &reftitle.description; - - public UI\Draw\ColorUI\Draw\Brush::getColor - - - - Shall return a UI\Draw\Color for this brush - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The current color of the brush - - - - - - - diff --git a/reference/ui/ui/draw/brush/setcolor.xml b/reference/ui/ui/draw/brush/setcolor.xml deleted file mode 100644 index 7bb1dc66c274..000000000000 --- a/reference/ui/ui/draw/brush/setcolor.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - UI\Draw\Brush::setColor - Set Color - - - - &reftitle.description; - - public voidUI\Draw\Brush::setColor - UI\Draw\Colorcolor - - - public voidUI\Draw\Brush::setColor - intcolor - - - Shall set the color of this brush to the color provided - - - - - - &reftitle.parameters; - - - color - - - Can be a UI\Draw\Color or RRGGBBAA - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/draw/color/construct.xml b/reference/ui/ui/draw/color/construct.xml deleted file mode 100644 index 5c24d4224063..000000000000 --- a/reference/ui/ui/draw/color/construct.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - UI\Draw\Color::__construct - Construct new Color - - - - &reftitle.description; - - public UI\Draw\Color::__construct - UI\Draw\Colorcolor - - - public UI\Draw\Color::__construct - intcolor - - - Shall construct a new color - - - - - - &reftitle.parameters; - - - color - - - May be UI\Draw\Color or RRGGBBAA - - - - - - - - - - - - - diff --git a/reference/ui/ui/draw/color/getchannel.xml b/reference/ui/ui/draw/color/getchannel.xml deleted file mode 100644 index 12d55ce9bb81..000000000000 --- a/reference/ui/ui/draw/color/getchannel.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - UI\Draw\Color::getChannel - Color Manipulation - - - - &reftitle.description; - - public floatUI\Draw\Color::getChannel - intchannel - - - Shall retrieve the value for a channel - - - - - - &reftitle.parameters; - - - channel - - - Constant channel identity - - - - - - - - &reftitle.returnvalues; - - The current value of the requested channel - - - - - - - diff --git a/reference/ui/ui/draw/color/setchannel.xml b/reference/ui/ui/draw/color/setchannel.xml deleted file mode 100644 index 2e11e9ef5929..000000000000 --- a/reference/ui/ui/draw/color/setchannel.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - UI\Draw\Color::setChannel - Color Manipulation - - - - &reftitle.description; - - public voidUI\Draw\Color::setChannel - intchannel - floatvalue - - - Shall set the selected channel to the given value - - - - - - &reftitle.parameters; - - - channel - - - Constant channel identity - - - - - value - - - The new value for the selected channel - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/draw/matrix/invert.xml b/reference/ui/ui/draw/matrix/invert.xml deleted file mode 100644 index ff8fe35c84a8..000000000000 --- a/reference/ui/ui/draw/matrix/invert.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Draw\Matrix::invert - Invert Matrix - - - - &reftitle.description; - - public UI\Draw\Matrix::invert - - - - Shall invert this matrix - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/draw/matrix/isinvertible.xml b/reference/ui/ui/draw/matrix/isinvertible.xml deleted file mode 100644 index a8db70be8748..000000000000 --- a/reference/ui/ui/draw/matrix/isinvertible.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Draw\Matrix::isInvertible - Invertible Detection - - - - &reftitle.description; - - public boolUI\Draw\Matrix::isInvertible - - - - Shall detect if this Matrix may be inverted - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/draw/matrix/multiply.xml b/reference/ui/ui/draw/matrix/multiply.xml deleted file mode 100644 index a7edc58eda7f..000000000000 --- a/reference/ui/ui/draw/matrix/multiply.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - UI\Draw\Matrix::multiply - Multiply Matrix - - - - &reftitle.description; - - public UI\Draw\MatrixUI\Draw\Matrix::multiply - UI\Draw\Matrixmatrix - - - Shall multiply this matrix with the given matrix - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The new Matrix - - - - - - diff --git a/reference/ui/ui/draw/matrix/rotate.xml b/reference/ui/ui/draw/matrix/rotate.xml deleted file mode 100644 index b0c1f13cd077..000000000000 --- a/reference/ui/ui/draw/matrix/rotate.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - UI\Draw\Matrix::rotate - Rotate Matrix - - - - &reftitle.description; - - public UI\Draw\Matrix::rotate - UI\Pointpoint - floatamount - - - Shall rotate this Matrix - - - - - - &reftitle.parameters; - - - point - - - - - - - - amount - - - - - - - - - - - - - diff --git a/reference/ui/ui/draw/matrix/scale.xml b/reference/ui/ui/draw/matrix/scale.xml deleted file mode 100644 index 68471373f452..000000000000 --- a/reference/ui/ui/draw/matrix/scale.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - UI\Draw\Matrix::scale - Scale Matrix - - - - &reftitle.description; - - public UI\Draw\Matrix::scale - UI\Pointcenter - UI\Pointpoint - - - Shall scale this Matrix - - - - - - &reftitle.parameters; - - - center - - - - - - - - point - - - - - - - - - - - - - diff --git a/reference/ui/ui/draw/matrix/skew.xml b/reference/ui/ui/draw/matrix/skew.xml deleted file mode 100644 index 9897d82347b6..000000000000 --- a/reference/ui/ui/draw/matrix/skew.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - UI\Draw\Matrix::skew - Skew Matrix - - - - &reftitle.description; - - public UI\Draw\Matrix::skew - UI\Pointpoint - UI\Pointamount - - - Shall skew this Matrix - - - - - - &reftitle.parameters; - - - point - - - - - - - - amount - - - - - - - - - - - - - diff --git a/reference/ui/ui/draw/matrix/translate.xml b/reference/ui/ui/draw/matrix/translate.xml deleted file mode 100644 index ffd9cd1ae867..000000000000 --- a/reference/ui/ui/draw/matrix/translate.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Draw\Matrix::translate - Translate Matrix - - - - &reftitle.description; - - public UI\Draw\Matrix::translate - UI\Pointpoint - - - Shall translate this Matrix - - - - - - &reftitle.parameters; - - - point - - - - - - - - - - - - - diff --git a/reference/ui/ui/draw/path/addrectangle.xml b/reference/ui/ui/draw/path/addrectangle.xml deleted file mode 100644 index 721818a39c6c..000000000000 --- a/reference/ui/ui/draw/path/addrectangle.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - UI\Draw\Path::addRectangle - Draw a Rectangle - - - - &reftitle.description; - - public UI\Draw\Path::addRectangle - UI\Pointpoint - UI\Sizesize - - - Shall map the path of a rectangle of the given size, at the given point - - - - - - &reftitle.parameters; - - - point - - - The point to begin the shape - - - - - size - - - The size of the rectangle - - - - - - - - - diff --git a/reference/ui/ui/draw/path/arcto.xml b/reference/ui/ui/draw/path/arcto.xml deleted file mode 100644 index c427a883cb37..000000000000 --- a/reference/ui/ui/draw/path/arcto.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - UI\Draw\Path::arcTo - Draw an Arc - - - - &reftitle.description; - - public UI\Draw\Path::arcTo - UI\Pointpoint - floatradius - floatangle - floatsweep - floatnegative - - - Shall map the path for an arc - - - - - - &reftitle.parameters; - - - point - - - The point to begin mapping - - - - - radius - - - The radius of the arc - - - - - angle - - - The angle of the arc - - - - - sweep - - - The sweep of the arc - - - - - negative - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/draw/path/bezierto.xml b/reference/ui/ui/draw/path/bezierto.xml deleted file mode 100644 index c06a23f2a8c1..000000000000 --- a/reference/ui/ui/draw/path/bezierto.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - UI\Draw\Path::bezierTo - Draw Bezier Curve - - - - &reftitle.description; - - public UI\Draw\Path::bezierTo - UI\Pointpoint - floatradius - floatangle - floatsweep - floatnegative - - - Shall draw a bezier curve - - - - - - &reftitle.parameters; - - - point - - - The point at which to begin mapping - - - - - radius - - - The radius of the curve - - - - - angle - - - The angle of the curve - - - - - sweep - - - The sweep of the curve - - - - - negative - - - - - - - - - - - - - diff --git a/reference/ui/ui/draw/path/closefigure.xml b/reference/ui/ui/draw/path/closefigure.xml deleted file mode 100644 index 3342696f2e43..000000000000 --- a/reference/ui/ui/draw/path/closefigure.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Draw\Path::closeFigure - Close Figure - - - - &reftitle.description; - - public UI\Draw\Path::closeFigure - - - - Shall close the current figure - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/draw/path/construct.xml b/reference/ui/ui/draw/path/construct.xml deleted file mode 100644 index bc5318bbbddd..000000000000 --- a/reference/ui/ui/draw/path/construct.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - UI\Draw\Path::__construct - Construct a new Path - - - - &reftitle.description; - - public UI\Draw\Path::__construct - intmodeUI\Draw\Path::Winding - - - Shall construct a new path in the given mode - - - - - - &reftitle.parameters; - - - mode - - - Path::Winding or Path::Alternate - - - - - - - - - diff --git a/reference/ui/ui/draw/path/end.xml b/reference/ui/ui/draw/path/end.xml deleted file mode 100644 index 5f9ea233deee..000000000000 --- a/reference/ui/ui/draw/path/end.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Draw\Path::end - Finalize Path - - - - &reftitle.description; - - public UI\Draw\Path::end - - - - Shall finalize this Path - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/draw/path/lineto.xml b/reference/ui/ui/draw/path/lineto.xml deleted file mode 100644 index 4eb6bd3007c5..000000000000 --- a/reference/ui/ui/draw/path/lineto.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - UI\Draw\Path::lineTo - Draw a Line - - - - &reftitle.description; - - public UI\Draw\Path::lineTo - UI\Pointpoint - floatradius - floatangle - floatsweep - floatnegative - - - Shall map the path for a line - - - - - - &reftitle.parameters; - - - point - - - The point to begin mapping - - - - - radius - - - - - - - - angle - - - - - - - - sweep - - - - - - - - negative - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/draw/path/newfigure.xml b/reference/ui/ui/draw/path/newfigure.xml deleted file mode 100644 index 57cb3b47e447..000000000000 --- a/reference/ui/ui/draw/path/newfigure.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Draw\Path::newFigure - Draw Figure - - - - &reftitle.description; - - public UI\Draw\Path::newFigure - UI\Pointpoint - - - Shall map a new figure at the given point - - - - - - &reftitle.parameters; - - - point - - - The point to begin mapping - - - - - - - - - - diff --git a/reference/ui/ui/draw/path/newfigurewitharc.xml b/reference/ui/ui/draw/path/newfigurewitharc.xml deleted file mode 100644 index d62cb219ee9a..000000000000 --- a/reference/ui/ui/draw/path/newfigurewitharc.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - UI\Draw\Path::newFigureWithArc - Draw Figure with Arc - - - - &reftitle.description; - - public UI\Draw\Path::newFigureWithArc - UI\Pointpoint - floatradius - floatangle - floatsweep - floatnegative - - - - - - - - - &reftitle.parameters; - - - point - - - - - - - - radius - - - - - - - - angle - - - - - - - - sweep - - - - - - - - negative - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/draw/pen/clip.xml b/reference/ui/ui/draw/pen/clip.xml deleted file mode 100644 index 6bbe11506ea4..000000000000 --- a/reference/ui/ui/draw/pen/clip.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Draw\Pen::clip - Clip a Path - - - - &reftitle.description; - - public UI\Draw\Pen::clip - UI\Draw\Pathpath - - - Shall clip the given Path - - - - - - &reftitle.parameters; - - - path - - - The path to clip - - - - - - - - - - diff --git a/reference/ui/ui/draw/pen/fill.xml b/reference/ui/ui/draw/pen/fill.xml deleted file mode 100644 index 4cb78daa8352..000000000000 --- a/reference/ui/ui/draw/pen/fill.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - UI\Draw\Pen::fill - Fill a Path - - - - &reftitle.description; - - public UI\Draw\Pen::fill - UI\Draw\Pathpath - UI\Draw\Brushwith - - - public UI\Draw\Pen::fill - UI\Draw\Pathpath - UI\Draw\Colorwith - - - public UI\Draw\Pen::fill - UI\Draw\Pathpath - intwith - - - Shall fill the given path - - - - - - &reftitle.parameters; - - - path - - - The path to fill - - - - - with - - - The color or brush to fill with - - - - - - - - - - diff --git a/reference/ui/ui/draw/pen/restore.xml b/reference/ui/ui/draw/pen/restore.xml deleted file mode 100644 index ef8f80bf301b..000000000000 --- a/reference/ui/ui/draw/pen/restore.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Draw\Pen::restore - Restore - - - - &reftitle.description; - - public UI\Draw\Pen::restore - - - - Shall restore a previously saved Pen - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/draw/pen/save.xml b/reference/ui/ui/draw/pen/save.xml deleted file mode 100644 index 7f854f860675..000000000000 --- a/reference/ui/ui/draw/pen/save.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Draw\Pen::save - Save - - - - &reftitle.description; - - public UI\Draw\Pen::save - - - - Shall save the Pen - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/draw/pen/stroke.xml b/reference/ui/ui/draw/pen/stroke.xml deleted file mode 100644 index 1bc47e9663b6..000000000000 --- a/reference/ui/ui/draw/pen/stroke.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - UI\Draw\Pen::stroke - Stroke a Path - - - - &reftitle.description; - - public UI\Draw\Pen::stroke - UI\Draw\Pathpath - UI\Draw\Brushwith - UI\Draw\Strokestroke - - - public UI\Draw\Pen::stroke - UI\Draw\Pathpath - UI\Draw\Colorwith - UI\Draw\Strokestroke - - - public UI\Draw\Pen::stroke - UI\Draw\Pathpath - intwith - UI\Draw\Strokestroke - - - Shall stroke the given path - - - - - - &reftitle.parameters; - - - path - - - The path to stroke - - - - - with - - - The color or brush to stroke with - - - - - stroke - - - The configuration of the stroke - - - - - - - - - diff --git a/reference/ui/ui/draw/pen/transform.xml b/reference/ui/ui/draw/pen/transform.xml deleted file mode 100644 index e421240c6a16..000000000000 --- a/reference/ui/ui/draw/pen/transform.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - UI\Draw\Pen::transform - Matrix Transform - - - - &reftitle.description; - - public UI\Draw\Pen::transform - UI\Draw\Matrixmatrix - - - Shall perform matrix transformation - - - - - - &reftitle.parameters; - - - matrix - - - The matrix to use - - - - - - - - - diff --git a/reference/ui/ui/draw/pen/write.xml b/reference/ui/ui/draw/pen/write.xml deleted file mode 100644 index 4d0d67c80b17..000000000000 --- a/reference/ui/ui/draw/pen/write.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - UI\Draw\Pen::write - Draw Text at Point - - - - &reftitle.description; - - public UI\Draw\Pen::write - UI\Pointpoint - UI\Draw\Text\Layoutlayout - - - Shall draw the given text layout at the given point - - - - - - &reftitle.parameters; - - - point - - - The point to perform the drawing - - - - - layout - - - The layout of the text to draw - - - - - - - - - - diff --git a/reference/ui/ui/draw/stroke/construct.xml b/reference/ui/ui/draw/stroke/construct.xml deleted file mode 100644 index 073e0b7b51c3..000000000000 --- a/reference/ui/ui/draw/stroke/construct.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - UI\Draw\Stroke::__construct - Construct a new Stroke - - - - &reftitle.description; - - public UI\Draw\Stroke::__construct - intcapUI\Draw\Line\Cap::Flat - intjoinUI\Draw\Line\Join::Miter - floatthickness1 - floatmiterLimit10 - - - Shall construct a new Stroke - - - - - - &reftitle.parameters; - - - cap - - - UI\Draw\Line\Cap::Flat, UI\Draw\Line\Cap::Round, or UI\Draw\Line\Cap::Square - - - - - join - - - UI\Draw\Line\Join::Miter, UI\Draw\Line\Join::Round, or UI\Draw\Line\Join::Bevel - - - - - thickness - - - The thickness of the stroke - - - - - miterLimit - - - Miter limit (default is sensible for all supported platforms) - - - - - - - - - - - diff --git a/reference/ui/ui/draw/stroke/getcap.xml b/reference/ui/ui/draw/stroke/getcap.xml deleted file mode 100644 index 3a04f4343278..000000000000 --- a/reference/ui/ui/draw/stroke/getcap.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Draw\Stroke::getCap - Get Line Cap - - - - &reftitle.description; - - public intUI\Draw\Stroke::getCap - - - - Shall retrieve the line cap setting of this Stroke - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - UI\Draw\Line\Cap::Flat, UI\Draw\Line\Cap::Round, or UI\Draw\Line\Cap::Square - - - - - - - diff --git a/reference/ui/ui/draw/stroke/getjoin.xml b/reference/ui/ui/draw/stroke/getjoin.xml deleted file mode 100644 index f6c376454369..000000000000 --- a/reference/ui/ui/draw/stroke/getjoin.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Draw\Stroke::getJoin - Get Line Join - - - - &reftitle.description; - - public intUI\Draw\Stroke::getJoin - - - - Shall retrieve the line join setting of this Stroke - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - UI\Draw\Line\Join::Miter, UI\Draw\Line\Join::Round, or UI\Draw\Line\Join::Bevel - - - - - - - diff --git a/reference/ui/ui/draw/stroke/getmiterlimit.xml b/reference/ui/ui/draw/stroke/getmiterlimit.xml deleted file mode 100644 index 25489411503c..000000000000 --- a/reference/ui/ui/draw/stroke/getmiterlimit.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Draw\Stroke::getMiterLimit - Get Miter Limit - - - - &reftitle.description; - - public floatUI\Draw\Stroke::getMiterLimit - - - - Shall retrieve the miter limit of this Stroke - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The current miter limit - - - - - - - diff --git a/reference/ui/ui/draw/stroke/getthickness.xml b/reference/ui/ui/draw/stroke/getthickness.xml deleted file mode 100644 index 4a1cf9de6eea..000000000000 --- a/reference/ui/ui/draw/stroke/getthickness.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Draw\Stroke::getThickness - Get Thickness - - - - &reftitle.description; - - public floatUI\Draw\Stroke::getThickness - - - - Shall retrieve the thickness of this Stroke - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The current thickness - - - - - - - diff --git a/reference/ui/ui/draw/stroke/setcap.xml b/reference/ui/ui/draw/stroke/setcap.xml deleted file mode 100644 index 63116e09d5cf..000000000000 --- a/reference/ui/ui/draw/stroke/setcap.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Draw\Stroke::setCap - Set Line Cap - - - - &reftitle.description; - - public UI\Draw\Stroke::setCap - intcap - - - Shall set the line cap setting for this Stroke - - - - - &reftitle.parameters; - - - cap - - - UI\Draw\Line\Cap::Flat, UI\Draw\Line\Cap::Round, or UI\Draw\Line\Cap::Square - - - - - - - - - diff --git a/reference/ui/ui/draw/stroke/setjoin.xml b/reference/ui/ui/draw/stroke/setjoin.xml deleted file mode 100644 index e82b558af25e..000000000000 --- a/reference/ui/ui/draw/stroke/setjoin.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - UI\Draw\Stroke::setJoin - Set Line Join - - - - &reftitle.description; - - public UI\Draw\Stroke::setJoin - intjoin - - - Shall set the line join setting for this Stroke - - - - - - &reftitle.parameters; - - - join - - - UI\Draw\Line\Join::Miter, UI\Draw\Line\Join::Round, or UI\Draw\Line\Join::Bevel - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/draw/stroke/setmiterlimit.xml b/reference/ui/ui/draw/stroke/setmiterlimit.xml deleted file mode 100644 index 5b9cbb1515fa..000000000000 --- a/reference/ui/ui/draw/stroke/setmiterlimit.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Draw\Stroke::setMiterLimit - Set Miter Limit - - - - &reftitle.description; - - public UI\Draw\Stroke::setMiterLimit - floatlimit - - - Set the miter limit for this Stroke - - - - - - &reftitle.parameters; - - - limit - - - The new limit - - - - - - - - - - diff --git a/reference/ui/ui/draw/stroke/setthickness.xml b/reference/ui/ui/draw/stroke/setthickness.xml deleted file mode 100644 index e1bc054f3ff9..000000000000 --- a/reference/ui/ui/draw/stroke/setthickness.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Draw\Stroke::setThickness - Set Thickness - - - - &reftitle.description; - - public UI\Draw\Stroke::setThickness - floatthickness - - - Shall set the thickness for this Stroke - - - - - - &reftitle.parameters; - - - thickness - - - The new thickness - - - - - - - - - - diff --git a/reference/ui/ui/draw/text/font.descriptor/construct.xml b/reference/ui/ui/draw/text/font.descriptor/construct.xml deleted file mode 100644 index 6c1b47738b2a..000000000000 --- a/reference/ui/ui/draw/text/font.descriptor/construct.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - UI\Draw\Text\Font\Descriptor::__construct - Construct a new Font Descriptor - - - - &reftitle.description; - - public UI\Draw\Text\Font\Descriptor::__construct - stringfamily - floatsize - intweightUI\Draw\Text\Font\Weight::Normal - intitalicUI\Draw\Text\Font\Italic::Normal - intstretchUI\Draw\Text\Font\Stretch::Normal - - - Shall construct a new Font Descriptor - - - - - - &reftitle.parameters; - - - family - - - The name of a valid family of fonts - - - - - size - - - The preferred size - - - - - weight - - - UI\Draw\Text\Font\Weight constant - - - - - italic - - - UI\Draw\Text\Font\Italic constant - - - - - stretch - - - UI\Draw\Text\Font\Stretch constant - - - - - - - - - - - - - diff --git a/reference/ui/ui/draw/text/font.descriptor/getfamily.xml b/reference/ui/ui/draw/text/font.descriptor/getfamily.xml deleted file mode 100644 index 591f46b56677..000000000000 --- a/reference/ui/ui/draw/text/font.descriptor/getfamily.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Draw\Text\Font\Descriptor::getFamily - Get Font Family - - - - &reftitle.description; - - public stringUI\Draw\Text\Font\Descriptor::getFamily - - - - Shall return the requested font family - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/draw/text/font.descriptor/getitalic.xml b/reference/ui/ui/draw/text/font.descriptor/getitalic.xml deleted file mode 100644 index 667a8acfdc43..000000000000 --- a/reference/ui/ui/draw/text/font.descriptor/getitalic.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Draw\Text\Font\Descriptor::getItalic - Style Detection - - - - &reftitle.description; - - public intUI\Draw\Text\Font\Descriptor::getItalic - - - - Shall return constant setting - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/draw/text/font.descriptor/getsize.xml b/reference/ui/ui/draw/text/font.descriptor/getsize.xml deleted file mode 100644 index ccd31d80c582..000000000000 --- a/reference/ui/ui/draw/text/font.descriptor/getsize.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Draw\Text\Font\Descriptor::getSize - Size Detection - - - - &reftitle.description; - - public floatUI\Draw\Text\Font\Descriptor::getSize - - - - Shall return the requested size - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/draw/text/font.descriptor/getstretch.xml b/reference/ui/ui/draw/text/font.descriptor/getstretch.xml deleted file mode 100644 index 06bc62956d61..000000000000 --- a/reference/ui/ui/draw/text/font.descriptor/getstretch.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Draw\Text\Font\Descriptor::getStretch - Style Detection - - - - &reftitle.description; - - public intUI\Draw\Text\Font\Descriptor::getStretch - - - - Shall return requested stretch - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/draw/text/font.descriptor/getweight.xml b/reference/ui/ui/draw/text/font.descriptor/getweight.xml deleted file mode 100644 index 2fc7ef5f1e71..000000000000 --- a/reference/ui/ui/draw/text/font.descriptor/getweight.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Draw\Text\Font\Descriptor::getWeight - Weight Detection - - - - &reftitle.description; - - public intUI\Draw\Text\Font\Descriptor::getWeight - - - - Shall return requested weight - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/draw/text/font/construct.xml b/reference/ui/ui/draw/text/font/construct.xml deleted file mode 100644 index ff73a497eb7f..000000000000 --- a/reference/ui/ui/draw/text/font/construct.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - UI\Draw\Text\Font::__construct - Construct a new Font - - - - &reftitle.description; - - public UI\Draw\Text\Font::__construct - UI\Draw\Text\Font\Descriptordescriptor - - - Shall construct a new Font using the given descriptor - - - - - - &reftitle.parameters; - - - descriptor - - - The descriptor for the Font - - - - - - - - - diff --git a/reference/ui/ui/draw/text/font/getascent.xml b/reference/ui/ui/draw/text/font/getascent.xml deleted file mode 100644 index 7d0e202f3ba5..000000000000 --- a/reference/ui/ui/draw/text/font/getascent.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Draw\Text\Font::getAscent - Font Metrics - - - - &reftitle.description; - - public floatUI\Draw\Text\Font::getAscent - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/draw/text/font/getdescent.xml b/reference/ui/ui/draw/text/font/getdescent.xml deleted file mode 100644 index d6248a6dd6c2..000000000000 --- a/reference/ui/ui/draw/text/font/getdescent.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Draw\Text\Font::getDescent - Font Metrics - - - - &reftitle.description; - - public floatUI\Draw\Text\Font::getDescent - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/draw/text/font/getleading.xml b/reference/ui/ui/draw/text/font/getleading.xml deleted file mode 100644 index bbf0e83ee4d6..000000000000 --- a/reference/ui/ui/draw/text/font/getleading.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Draw\Text\Font::getLeading - Font Metrics - - - - &reftitle.description; - - public floatUI\Draw\Text\Font::getLeading - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/draw/text/font/getunderlineposition.xml b/reference/ui/ui/draw/text/font/getunderlineposition.xml deleted file mode 100644 index dd178b938dc8..000000000000 --- a/reference/ui/ui/draw/text/font/getunderlineposition.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Draw\Text\Font::getUnderlinePosition - Font Metrics - - - - &reftitle.description; - - public floatUI\Draw\Text\Font::getUnderlinePosition - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/draw/text/font/getunderlinethickness.xml b/reference/ui/ui/draw/text/font/getunderlinethickness.xml deleted file mode 100644 index 7e989fb94d40..000000000000 --- a/reference/ui/ui/draw/text/font/getunderlinethickness.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Draw\Text\Font::getUnderlineThickness - Font Metrics - - - - &reftitle.description; - - public floatUI\Draw\Text\Font::getUnderlineThickness - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/draw/text/layout/construct.xml b/reference/ui/ui/draw/text/layout/construct.xml deleted file mode 100644 index e52d13520d33..000000000000 --- a/reference/ui/ui/draw/text/layout/construct.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - UI\Draw\Text\Layout::__construct - Construct a new Text Layout - - - - &reftitle.description; - - public UI\Draw\Text\Layout::__construct - stringtext - UI\Draw\Text\Fontfont - floatwidth - - - Shall construct a new Text Layout - - - - - - &reftitle.parameters; - - - text - - - The text for the layout - - - - - font - - - The font to use for writing - - - - - width - - - The width of the layout - - - - - - - - - - - diff --git a/reference/ui/ui/draw/text/layout/setcolor.xml b/reference/ui/ui/draw/text/layout/setcolor.xml deleted file mode 100644 index e299ecd3bccb..000000000000 --- a/reference/ui/ui/draw/text/layout/setcolor.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - UI\Draw\Text\Layout::setColor - Set Color - - - - &reftitle.description; - - public UI\Draw\Text\Layout::setColor - UI\Draw\Colorcolor - intstart0 - intend - - - public UI\Draw\Text\Layout::setColor - intcolor - intstart0 - intend - - - Shall set the Color for all of, or a range of the text in the Layout - - - - - - &reftitle.parameters; - - - color - - - The color to use - - - - - start - - - The starting character - - - - - end - - - The ending character, by default the end of the string - - - - - - - - - - diff --git a/reference/ui/ui/draw/text/layout/setwidth.xml b/reference/ui/ui/draw/text/layout/setwidth.xml deleted file mode 100644 index 031c7f5df5fb..000000000000 --- a/reference/ui/ui/draw/text/layout/setwidth.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Draw\Text\Layout::setWidth - Set Width - - - - &reftitle.description; - - public UI\Draw\Text\Layout::setWidth - floatwidth - - - Shall set the width of this Text Layout - - - - - - &reftitle.parameters; - - - width - - - The new width - - - - - - - - - - diff --git a/reference/ui/ui/executor/construct.xml b/reference/ui/ui/executor/construct.xml deleted file mode 100644 index 7f7dda552c2f..000000000000 --- a/reference/ui/ui/executor/construct.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - UI\Executor::__construct - Construct a new Executor - - - - &reftitle.description; - - public UI\Executor::__construct - - - - public UI\Executor::__construct - intmicroseconds - - - public UI\Executor::__construct - intseconds - intmicroseconds - - - Shall construct an executor with the given interval, will not start executing until main loop is entered - - - - - - &reftitle.parameters; - - - seconds - - - Seconds between executions - - - - - microseconds - - - Microseconds between executions - - - - - - - - - - - - - diff --git a/reference/ui/ui/executor/kill.xml b/reference/ui/ui/executor/kill.xml deleted file mode 100644 index 7bffdc877dd5..000000000000 --- a/reference/ui/ui/executor/kill.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Executor::kill - Stop Executor - - - - &reftitle.description; - - public voidUI\Executor::kill - - - - Shall stop an executor, the executor cannot be restarted - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/executor/onexecute.xml b/reference/ui/ui/executor/onexecute.xml deleted file mode 100644 index 81c6f665f5f8..000000000000 --- a/reference/ui/ui/executor/onexecute.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Executor::onExecute - Execution Callback - - - - &reftitle.description; - - abstract protected voidUI\Executor::onExecute - - - - Shall be repetitively queued for execution in the main thread - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/executor/setinterval.xml b/reference/ui/ui/executor/setinterval.xml deleted file mode 100644 index b0914670c7aa..000000000000 --- a/reference/ui/ui/executor/setinterval.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - UI\Executor::setInterval - Interval Manipulation - - - - &reftitle.description; - - public boolUI\Executor::setInterval - intmicroseconds - - - public boolUI\Executor::setInterval - intseconds - intmicroseconds - - - Shall set the new interval. An interval of 0 will pause the executor until a new interval has been set - - - - - - &reftitle.parameters; - - - seconds - - - - - - - - microseconds - - - - - - - - - - - &reftitle.returnvalues; - - Indication of success - - - - - - - diff --git a/reference/ui/ui/menu/append.xml b/reference/ui/ui/menu/append.xml deleted file mode 100644 index 98e183927900..000000000000 --- a/reference/ui/ui/menu/append.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - UI\Menu::append - Append Menu Item - - - - &reftitle.description; - - public UI\MenuItemUI\Menu::append - stringname - stringtypeUI\MenuItem::class - - - Shall append a new Menu Item - - - - - - &reftitle.parameters; - - - name - - - The name (text) for the new item - - - - - type - - - The type for the new item - - - - - - - - &reftitle.returnvalues; - - A constructed object of the given type - - - - - - - diff --git a/reference/ui/ui/menu/appendabout.xml b/reference/ui/ui/menu/appendabout.xml deleted file mode 100644 index c105998668c5..000000000000 --- a/reference/ui/ui/menu/appendabout.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - UI\Menu::appendAbout - Append About Menu Item - - - - &reftitle.description; - - public UI\MenuItemUI\Menu::appendAbout - stringtypeUI\MenuItem::class - - - Shall append an About menu item - - - - - - &reftitle.parameters; - - - type - - - The type for the new item - - - - - - - - &reftitle.returnvalues; - - A constructed About menu item of the given type - - - - - - - diff --git a/reference/ui/ui/menu/appendcheck.xml b/reference/ui/ui/menu/appendcheck.xml deleted file mode 100644 index 2c6d7dff221b..000000000000 --- a/reference/ui/ui/menu/appendcheck.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - UI\Menu::appendCheck - Append Checkable Menu Item - - - - &reftitle.description; - - public UI\MenuItemUI\Menu::appendCheck - stringname - stringtypeUI\MenuItem::class - - - Shall append a checkable menu item - - - - - - &reftitle.parameters; - - - name - - - The name (text) for the new item - - - - - type - - - The type for the new item - - - - - - - - &reftitle.returnvalues; - - A constructed checkable menu item of the given type - - - - - - - diff --git a/reference/ui/ui/menu/appendpreferences.xml b/reference/ui/ui/menu/appendpreferences.xml deleted file mode 100644 index 2dbab7656381..000000000000 --- a/reference/ui/ui/menu/appendpreferences.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - UI\Menu::appendPreferences - Append Preferences Menu Item - - - - &reftitle.description; - - public UI\MenuItemUI\Menu::appendPreferences - stringtypeUI\MenuItem::class - - - Shall append a Preferences menu item - - - - - - &reftitle.parameters; - - - type - - - The type for the new item - - - - - - - - &reftitle.returnvalues; - - A constructed Preferences menu item of the given type - - - - - - - diff --git a/reference/ui/ui/menu/appendquit.xml b/reference/ui/ui/menu/appendquit.xml deleted file mode 100644 index a1d03b0b3ce4..000000000000 --- a/reference/ui/ui/menu/appendquit.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - UI\Menu::appendQuit - Append Quit Menu Item - - - - &reftitle.description; - - public UI\MenuItemUI\Menu::appendQuit - stringtypeUI\MenuItem::class - - - Shall append a Quit menu item - - - - - - &reftitle.parameters; - - - type - - - The type for the new item - - - - - - - - &reftitle.returnvalues; - - A constructed Quit menu item of the given type - - - - - - - diff --git a/reference/ui/ui/menu/appendseparator.xml b/reference/ui/ui/menu/appendseparator.xml deleted file mode 100644 index 078c254984e8..000000000000 --- a/reference/ui/ui/menu/appendseparator.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Menu::appendSeparator - Append Menu Item Separator - - - - &reftitle.description; - - public UI\Menu::appendSeparator - - - - Shall append a separator - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/menu/construct.xml b/reference/ui/ui/menu/construct.xml deleted file mode 100644 index cd326d0e9054..000000000000 --- a/reference/ui/ui/menu/construct.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - UI\Menu::__construct - Construct a new Menu - - - - &reftitle.description; - - public UI\Menu::__construct - stringname - - - Shall construct a new Menu - - - - - - &reftitle.parameters; - - - name - - - The name (text) for the menu - - - - - - - - - diff --git a/reference/ui/ui/menuitem/disable.xml b/reference/ui/ui/menuitem/disable.xml deleted file mode 100644 index 16d9dced3365..000000000000 --- a/reference/ui/ui/menuitem/disable.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\MenuItem::disable - Disable Menu Item - - - - &reftitle.description; - - public UI\MenuItem::disable - - - - Shall disable this Menu Item - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/menuitem/enable.xml b/reference/ui/ui/menuitem/enable.xml deleted file mode 100644 index ff96fe1c2129..000000000000 --- a/reference/ui/ui/menuitem/enable.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\MenuItem::enable - Enable Menu Item - - - - &reftitle.description; - - public UI\MenuItem::enable - - - - Shall enable this Menu Item - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/menuitem/ischecked.xml b/reference/ui/ui/menuitem/ischecked.xml deleted file mode 100644 index f79262d35f70..000000000000 --- a/reference/ui/ui/menuitem/ischecked.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\MenuItem::isChecked - Detect Checked - - - - &reftitle.description; - - public boolUI\MenuItem::isChecked - - - - Shall detect if this Menu Item is checked - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/menuitem/onclick.xml b/reference/ui/ui/menuitem/onclick.xml deleted file mode 100644 index 67192168a441..000000000000 --- a/reference/ui/ui/menuitem/onclick.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\MenuItem::onClick - On Click Callback - - - - &reftitle.description; - - protected UI\MenuItem::onClick - - - - Shall be executed when this Menu Item is clicked - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/menuitem/setchecked.xml b/reference/ui/ui/menuitem/setchecked.xml deleted file mode 100644 index af2409f2fbde..000000000000 --- a/reference/ui/ui/menuitem/setchecked.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - UI\MenuItem::setChecked - Set Checked - - - - &reftitle.description; - - public UI\MenuItem::setChecked - boolchecked - - - Shall set the checked status of this Menu Item - - - - - - &reftitle.parameters; - - - checked - - - The new status - - - - - - - - - diff --git a/reference/ui/ui/point/at.xml b/reference/ui/ui/point/at.xml deleted file mode 100644 index 857af3b100ae..000000000000 --- a/reference/ui/ui/point/at.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - UI\Point::at - Size Coercion - - - - &reftitle.description; - - public static UI\PointUI\Point::at - floatpoint - - - public static UI\PointUI\Point::at - UI\Sizesize - - - Shall return a UI\Point object where x and y are equal to those supplied, either in float or UI\Size form - - - - - - &reftitle.parameters; - - - point - - - The value for x and y - - - - - size - - - The Size to convert - - - - - - - - &reftitle.returnvalues; - - The resulting Point - - - - - - - diff --git a/reference/ui/ui/point/construct.xml b/reference/ui/ui/point/construct.xml deleted file mode 100644 index f6b436eac0a8..000000000000 --- a/reference/ui/ui/point/construct.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - UI\Point::__construct - Construct a new Point - - - - &reftitle.description; - - public UI\Point::__construct - floatx - floaty - - - Construct a new Point using new co-ordinates - - - - - &reftitle.parameters; - - - x - - - The new X co-ordinate - - - - - y - - - The new Y co-ordinate - - - - - - - - - diff --git a/reference/ui/ui/point/getx.xml b/reference/ui/ui/point/getx.xml deleted file mode 100644 index a0ea3ec3ee80..000000000000 --- a/reference/ui/ui/point/getx.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - UI\Point::getX - Retrieves X - - - - &reftitle.description; - - public floatUI\Point::getX - - - - Retrieves the X co-ordinate - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The current X co-ordinate - - - - - - - diff --git a/reference/ui/ui/point/gety.xml b/reference/ui/ui/point/gety.xml deleted file mode 100644 index 81091f840802..000000000000 --- a/reference/ui/ui/point/gety.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - UI\Point::getY - Retrieves Y - - - - &reftitle.description; - - public floatUI\Point::getY - - - - Retrieves the Y co-ordinate - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The current Y co-ordinate - - - - - - - diff --git a/reference/ui/ui/point/setx.xml b/reference/ui/ui/point/setx.xml deleted file mode 100644 index 89bdaa4fb3bf..000000000000 --- a/reference/ui/ui/point/setx.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - UI\Point::setX - Set X - - - - &reftitle.description; - - public UI\Point::setX - floatpoint - - - Set the X co-ordinate - - - - - &reftitle.parameters; - - - point - - - The new X co-ordinate - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/point/sety.xml b/reference/ui/ui/point/sety.xml deleted file mode 100644 index 8032d4bf5354..000000000000 --- a/reference/ui/ui/point/sety.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - UI\Point::setY - Set Y - - - - &reftitle.description; - - public UI\Point::setY - floatpoint - - - Set the Y co-ordinate - - - - - &reftitle.parameters; - - - point - - - The new Y co-ordinate - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/size/construct.xml b/reference/ui/ui/size/construct.xml deleted file mode 100644 index 026366a3abba..000000000000 --- a/reference/ui/ui/size/construct.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - UI\Size::__construct - Construct a new Size - - - - &reftitle.description; - - public UI\Size::__construct - floatwidth - floatheight - - - Construct a new Size using new width and height - - - - - - &reftitle.parameters; - - - width - - - The new width - - - - - height - - - The new height - - - - - - - - - - - - - diff --git a/reference/ui/ui/size/getheight.xml b/reference/ui/ui/size/getheight.xml deleted file mode 100644 index 074078af2c6d..000000000000 --- a/reference/ui/ui/size/getheight.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - UI\Size::getHeight - Retrieves Height - - - - &reftitle.description; - - public floatUI\Size::getHeight - - - - Retrieves the Height - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The current Height - - - - - diff --git a/reference/ui/ui/size/getwidth.xml b/reference/ui/ui/size/getwidth.xml deleted file mode 100644 index 2e54545997ce..000000000000 --- a/reference/ui/ui/size/getwidth.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Size::getWidth - Retrieves Width - - - - &reftitle.description; - - public floatUI\Size::getWidth - - - - Retrieves the Width - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The current Width - - - - - - - diff --git a/reference/ui/ui/size/of.xml b/reference/ui/ui/size/of.xml deleted file mode 100644 index 476f97809f3c..000000000000 --- a/reference/ui/ui/size/of.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - UI\Size::of - Point Coercion - - - - &reftitle.description; - - public static UI\SizeUI\Size::of - floatsize - - - public static UI\SizeUI\Size::of - UI\Pointpoint - - - Shall return a UI\Size object where width and height are equal to those supplied, either in float or UI\Point form - - - - - - &reftitle.parameters; - - - size - - - The value for width and height - - - - - point - - - The Point to convert - - - - - - - - &reftitle.returnvalues; - - The resulting Size - - - - - - - diff --git a/reference/ui/ui/size/setheight.xml b/reference/ui/ui/size/setheight.xml deleted file mode 100644 index 2d505cd403a9..000000000000 --- a/reference/ui/ui/size/setheight.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - UI\Size::setHeight - Set Height - - - - &reftitle.description; - - public UI\Size::setHeight - floatsize - - - Set new Height - - - - - - &reftitle.parameters; - - - size - - - The new Height - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/size/setwidth.xml b/reference/ui/ui/size/setwidth.xml deleted file mode 100644 index 6269bbb7fd93..000000000000 --- a/reference/ui/ui/size/setwidth.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - UI\Size::setWidth - Set Width - - - - &reftitle.description; - - public UI\Size::setWidth - floatsize - - - Set new Width - - - - - - &reftitle.parameters; - - - size - - - The new Width - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/window/add.xml b/reference/ui/ui/window/add.xml deleted file mode 100644 index 584e36d62320..000000000000 --- a/reference/ui/ui/window/add.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - UI\Window::add - Add a Control - - - - &reftitle.description; - - public UI\Window::add - UI\Controlcontrol - - - Shall add a Control to this Window - - - - - - &reftitle.parameters; - - - control - - - The Control to add - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/window/construct.xml b/reference/ui/ui/window/construct.xml deleted file mode 100644 index 704c4692c8c0..000000000000 --- a/reference/ui/ui/window/construct.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - UI\Window::__construct - Construct a new Window - - - - &reftitle.description; - - public UI\Window::__construct - stringtitle - Sizesize - boolmenu&false; - - - Shall construct a new Window - - - - - - &reftitle.parameters; - - - title - - - The title of the Window - - - - - size - - - The size of the Window - - - - - menu - - - Menu switch - - - - - - - - - - - - - diff --git a/reference/ui/ui/window/error.xml b/reference/ui/ui/window/error.xml deleted file mode 100644 index 1d19857c7bf7..000000000000 --- a/reference/ui/ui/window/error.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - UI\Window::error - Show Error Box - - - - &reftitle.description; - - public UI\Window::error - stringtitle - stringmsg - - - Shall show an error box - - - - - - &reftitle.parameters; - - - title - - - The title of the error box - - - - - msg - - - The message for the error box - - - - - - - - - - diff --git a/reference/ui/ui/window/getsize.xml b/reference/ui/ui/window/getsize.xml deleted file mode 100644 index 398db5fd58d8..000000000000 --- a/reference/ui/ui/window/getsize.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Window::getSize - Get Window Size - - - - &reftitle.description; - - public UI\SizeUI\Window::getSize - - - - Shall return the size of this Window - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/window/gettitle.xml b/reference/ui/ui/window/gettitle.xml deleted file mode 100644 index 6687a4411b56..000000000000 --- a/reference/ui/ui/window/gettitle.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Window::getTitle - Get Title - - - - &reftitle.description; - - public stringUI\Window::getTitle - - - - Shall retrieve the title of this Window - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/window/hasborders.xml b/reference/ui/ui/window/hasborders.xml deleted file mode 100644 index 7f601c91b3e5..000000000000 --- a/reference/ui/ui/window/hasborders.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Window::hasBorders - Border Detection - - - - &reftitle.description; - - public boolUI\Window::hasBorders - - - - Shall detect if borders are used on this Window - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/window/hasmargin.xml b/reference/ui/ui/window/hasmargin.xml deleted file mode 100644 index dd730ad7f773..000000000000 --- a/reference/ui/ui/window/hasmargin.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Window::hasMargin - Margin Detection - - - - &reftitle.description; - - public boolUI\Window::hasMargin - - - - Shall detect if margins are used on this Window - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/window/isfullscreen.xml b/reference/ui/ui/window/isfullscreen.xml deleted file mode 100644 index be55a2704e7a..000000000000 --- a/reference/ui/ui/window/isfullscreen.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Window::isFullScreen - Full Screen Detection - - - - &reftitle.description; - - public boolUI\Window::isFullScreen - - - - Shall detect if this Window is using the whole screen - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/window/msg.xml b/reference/ui/ui/window/msg.xml deleted file mode 100644 index a229906ec6d3..000000000000 --- a/reference/ui/ui/window/msg.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - UI\Window::msg - Show Message Box - - - - &reftitle.description; - - public UI\Window::msg - stringtitle - stringmsg - - - Shall show a message box - - - - - - &reftitle.parameters; - - - title - - - The title of the message box - - - - - msg - - - The message - - - - - - - - - - diff --git a/reference/ui/ui/window/onclosing.xml b/reference/ui/ui/window/onclosing.xml deleted file mode 100644 index 6c7653fe16a9..000000000000 --- a/reference/ui/ui/window/onclosing.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Window::onClosing - Closing Callback - - - - &reftitle.description; - - protected intUI\Window::onClosing - - - - Should gracefully destroy this Window - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/window/open.xml b/reference/ui/ui/window/open.xml deleted file mode 100644 index 5e4f799d6a2d..000000000000 --- a/reference/ui/ui/window/open.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Window::open - Open Dialog - - - - &reftitle.description; - - public stringUI\Window::open - - - - Shall show an open file dialog - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the name of the file selected for opening - - - - - - - diff --git a/reference/ui/ui/window/save.xml b/reference/ui/ui/window/save.xml deleted file mode 100644 index bebbc89f543c..000000000000 --- a/reference/ui/ui/window/save.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Window::save - Save Dialog - - - - &reftitle.description; - - public stringUI\Window::save - - - - Shall show a save dialog - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the file name selecting for saving - - - - - - - diff --git a/reference/ui/ui/window/setborders.xml b/reference/ui/ui/window/setborders.xml deleted file mode 100644 index 2074dccc6772..000000000000 --- a/reference/ui/ui/window/setborders.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Window::setBorders - Border Use - - - - &reftitle.description; - - public UI\Window::setBorders - boolborders - - - Shall enable or disable the use of borders on this Window - - - - - - &reftitle.parameters; - - - borders - - - - - - - - - - - - - diff --git a/reference/ui/ui/window/setfullscreen.xml b/reference/ui/ui/window/setfullscreen.xml deleted file mode 100644 index 59b1e61527b4..000000000000 --- a/reference/ui/ui/window/setfullscreen.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - UI\Window::setFullScreen - Full Screen Use - - - - &reftitle.description; - - public UI\Window::setFullScreen - boolfull - - - Shall enable or disable the use of the full screen for this Window - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - full - - - - - - - - - - - - - diff --git a/reference/ui/ui/window/setmargin.xml b/reference/ui/ui/window/setmargin.xml deleted file mode 100644 index ebbd5d03603b..000000000000 --- a/reference/ui/ui/window/setmargin.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Window::setMargin - Margin Use - - - - &reftitle.description; - - public UI\Window::setMargin - boolmargin - - - Shall enable or disable the use of margins for this Window - - - - - - &reftitle.parameters; - - - margin - - - - - - - - - - - - - diff --git a/reference/ui/ui/window/setsize.xml b/reference/ui/ui/window/setsize.xml deleted file mode 100644 index 3cfa9af1d813..000000000000 --- a/reference/ui/ui/window/setsize.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - UI\Window::setSize - Set Size - - - - &reftitle.description; - - public UI\Window::setSize - UI\Sizesize - - - Shall set the size of this Window - - - - - - &reftitle.parameters; - - - size - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/window/settitle.xml b/reference/ui/ui/window/settitle.xml deleted file mode 100644 index 86131fc232b1..000000000000 --- a/reference/ui/ui/window/settitle.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Window::setTitle - Window Title - - - - &reftitle.description; - - public UI\Window::setTitle - stringtitle - - - Shall set the title for this Window - - - - - - &reftitle.parameters; - - - title - - - The new title - - - - - - - - - - diff --git a/reference/ui/versions.xml b/reference/ui/versions.xml deleted file mode 100644 index dd379e5d04a7..000000000000 --- a/reference/ui/versions.xml +++ /dev/null @@ -1,539 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/uopz/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/uopz/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/uopz/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/uopz/book.xml b/reference/uopz/book.xml deleted file mode 100644 index f36619cea571..000000000000 --- a/reference/uopz/book.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - User Operations for Zend - uopz - - - &reftitle.intro; - - The uopz - User Operations for Zend - - extension exposes Zend Engine functionality normally - used at compilation and execution time in order to - allow modification of the internal structures that represent PHP code, - and for user code to interact with the VM. - - - uopz supports the following activities: - - - Overloading some opcodes including ZEND_EXIT and ZEND_NEW - Backup and restore functions and methods - Renaming functions and methods - Copying of functions and methods - Deletion of functions and methods - Redefinition of global and class constants - Deletion of global and class constants - Runtime composition and modification of classes - - - - All of the activities supported are compatible with opcache - - - - - PECL uopz 6.1.1 is not compatible with Xdebug >= 2.9.4. - Later uopz versions are not compatible with Xdebug < 2.9.4. - - - - - &reference.uopz.setup; - &reference.uopz.constants; - &reference.uopz.reference; - - - - diff --git a/reference/uopz/configure.xml b/reference/uopz/configure.xml deleted file mode 100644 index ac2389dee875..000000000000 --- a/reference/uopz/configure.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - -
    - &reftitle.install; - - - Use when compiling PHP. - - - - Windows users should include php_uopz.dll into &php.ini; - - -
    - - - diff --git a/reference/uopz/constants.xml b/reference/uopz/constants.xml deleted file mode 100644 index 7ff31d9daed8..000000000000 --- a/reference/uopz/constants.xml +++ /dev/null @@ -1,319 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - The following opcodes are defined as constants by uopz before 5.0.0: - - - - - - ZEND_EXIT - (int) - - - - Invoked by exit() and die(), receives no arguments. - Return boolean &true; to exit, &false; to continue - - - - - - ZEND_NEW - (int) - - - - Invoked by object construction, - receives the class of object being created as the only argument - - - - - - ZEND_THROW - (int) - - - - Invoked by the throw construct, - receives the class of exception being thrown as the only argument - - - - - - ZEND_FETCH_CLASS - (int) - - - - Invoked upon composure, - receives the class the name of the class being fetched as the only argument - - - - - - ZEND_ADD_TRAIT - (int) - - - - Invoked upon composure, - receives the class the trait is being added to as the first argument, - and the name of the trait as the second argument - - - - - - ZEND_ADD_INTERFACE - (int) - - - - Invoked upon composure, - receives the class the interface is being added to as the first argument, - and the name of the interface as the second argument - - - - - - ZEND_INSTANCEOF - (int) - - - - Invoked by instanceof operator, - receives the object being verified as the first argument, - and the name of the class which that object should be as the second argument - - - - - - - The following constants control the VM's behaviour after a user handler is invoked, - be extremely careful! - These constants are removed as of uopz 5.0.0. - - - - - - ZEND_USER_OPCODE_CONTINUE - (int) - - - - Advance 1 opcode and continuue - - - - - - ZEND_USER_OPCODE_ENTER - (int) - - - - Enter into new op_array without recursion - - - - - - ZEND_USER_OPCODE_LEAVE - (int) - - - - Return to calling op_array within the same executor - - - - - - ZEND_USER_OPCODE_DISPATCH - (int) - - - - Dispatch to original opcode handler - - - - - - ZEND_USER_OPCODE_DISPATCH_TO - (int) - - - - Dispatch to a specific handler (OR'd with ZEND opcode constant) - - - - - - ZEND_USER_OPCODE_RETURN - (int) - - - - Exit from executor (return from function) - - - - - - - The following modifiers are registered as constants by uopz - - - - - - ZEND_ACC_PUBLIC - (int) - - - - Mark function as public, the default - - - - - - ZEND_ACC_PROTECTED - (int) - - - - Mark function as protected - - - - - - ZEND_ACC_PRIVATE - (int) - - - - Mark function as private - - - - - - ZEND_ACC_STATIC - (int) - - - - Mark function as static - - - - - - ZEND_ACC_FINAL - (int) - - - - Mark function as final - - - - - - ZEND_ACC_ABSTRACT - (int) - - - - Mark function as abstract - - - - - - ZEND_ACC_CLASS - (int) - - - - Dummy registered for consistency, the default kind of class entry. - Removed as of uopz 5.0.0. - - - - - - ZEND_ACC_INTERFACE - (int) - - - - Mark class as interface. - Removed as of uopz 5.0.0. - - - - - - ZEND_ACC_TRAIT - (int) - - - - Mark class as trait. - Removed as of uopz 5.0.0. - - - - - - ZEND_ACC_FETCH - (int) - - - - Used for getting flags only. - Removed as of uopz 5.0.0. - - - - - - - - - diff --git a/reference/uopz/functions/uopz-add-function.xml b/reference/uopz/functions/uopz-add-function.xml deleted file mode 100644 index 86b4f3525366..000000000000 --- a/reference/uopz/functions/uopz-add-function.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - uopz_add_function - Adds non-existent function or method - - - - &reftitle.description; - - booluopz_add_function - stringfunction - Closurehandler - intflagsZEND_ACC_PUBLIC - - - booluopz_add_function - stringclass - stringfunction - Closurehandler - intflagsZEND_ACC_PUBLIC - intall&true; - - - Adds a non-existent function or method. - - - - - &reftitle.parameters; - - - class - - - The name of the class. - - - - - function - - - The name of the function or method. - - - - - handler - - - The Closure that defines the new function or method. - - - - - flags - - - Flags to set for the new function or method. - - - - - all - - - Whether all classes that descend from class will - also be affected. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - uopz_add_function throws a RuntimeException - if the function or method to add already exists. - - - - - &reftitle.examples; - - Basic <function>uopz_add_function</function> Usage - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - uopz_del_function - uopz_set_return - - - - - - diff --git a/reference/uopz/functions/uopz-allow-exit.xml b/reference/uopz/functions/uopz-allow-exit.xml deleted file mode 100644 index 563f78d5492c..000000000000 --- a/reference/uopz/functions/uopz-allow-exit.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - uopz_allow_exit - Allows control over disabled exit opcode - - - - &reftitle.description; - - voiduopz_allow_exit - boolallow - - - By default uopz disables the exit opcode, so exit calls - are practically ignored. uopz_allow_exit - allows to control this behavior. - - - - - &reftitle.parameters; - - - allow - - - Whether to allow the execution of exit opcodes or not. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <function>uopz_allow_exit</function> example - - -]]> - - &example.outputs; - - - - - - - - &reftitle.notes; - - - OPcache optimizes away dead code after unconditional exit. - - - - - - &reftitle.seealso; - - uopz_get_exit_status - - - - - - diff --git a/reference/uopz/functions/uopz-backup.xml b/reference/uopz/functions/uopz-backup.xml deleted file mode 100644 index 49b4dbd7432a..000000000000 --- a/reference/uopz/functions/uopz-backup.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - uopz_backup - Backup a function - - - - &uopz.warn.removed.function-5-0-0; - - - - &reftitle.description; - - voiduopz_backup - stringfunction - - - voiduopz_backup - stringclass - stringfunction - - - Backup a function at runtime, to be restored on shutdown - - - - - - &reftitle.parameters; - - - class - - - The name of the class containing the function to backup - - - - - function - - - The name of the function - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - <function>uopz_backup</function> example - - -]]> - - &example.outputs; - - - - - - - - - - diff --git a/reference/uopz/functions/uopz-compose.xml b/reference/uopz/functions/uopz-compose.xml deleted file mode 100644 index 88b5a65a1b4f..000000000000 --- a/reference/uopz/functions/uopz-compose.xml +++ /dev/null @@ -1,153 +0,0 @@ - - - - - - uopz_compose - Compose a class - - - - &uopz.warn.removed.function-5-0-0; - - - - &reftitle.description; - - voiduopz_compose - stringname - arrayclasses - arraymethods - arrayproperties - intflags - - - Creates a new class of the given name that implements, extends, or uses all of the provided classes - - - - - &reftitle.parameters; - - - name - - - A legal class name - - - - - classes - - - An array of class, interface and trait names - - - - - methods - - - An associative array of methods, values are either closures or [modifiers => closure] - - - - - properties - - - An associative array of properties, keys are names, values are modifiers - - - - - flags - - - Entry type, by default ZEND_ACC_CLASS - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - <function>uopz_compose</function> example - - function() { - /* ... */ - } -]); - -var_dump( - class_uses(Composed::class), - class_parents(Composed::class), - class_implements(Composed::class)); -?> -]]> - - &example.outputs; - - - string(7) "myTrait" -} -array(1) { - ["myClass"]=> - string(7) "myClass" -} -array(1) { - ["myInterface"]=> - string(11) "myInterface" -} -]]> - - - - - - - - diff --git a/reference/uopz/functions/uopz-copy.xml b/reference/uopz/functions/uopz-copy.xml deleted file mode 100644 index ea9e85a69260..000000000000 --- a/reference/uopz/functions/uopz-copy.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - uopz_copy - Copy a function - - - - &uopz.warn.removed.function-5-0-0; - - - - &reftitle.description; - - Closureuopz_copy - stringfunction - - - Closureuopz_copy - stringclass - stringfunction - - - Copy a function by name - - - - - - &reftitle.parameters; - - - class - - - The name of the class containing the function to copy - - - - - function - - - The name of the function - - - - - - - - &reftitle.returnvalues; - - A Closure for the specified function - - - - - &reftitle.examples; - - <function>uopz_copy</function> example - - -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/uopz/functions/uopz-del-function.xml b/reference/uopz/functions/uopz-del-function.xml deleted file mode 100644 index 4215982becf5..000000000000 --- a/reference/uopz/functions/uopz-del-function.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - uopz_del_function - Deletes previously added function or method - - - - &reftitle.description; - - booluopz_del_function - stringfunction - - - booluopz_del_function - stringclass - stringfunction - intall&true; - - - Deletes a previously added function or method. - - - - - &reftitle.parameters; - - - class - - - The name of the class. - - - - - function - - - The name of the function or method. - - - - - all - - - Whether all classes that descend from class will - also be affected. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - uopz_del_function throws a RuntimeException - if the function or method to delete has not been added by uopz_add_function. - - - - - &reftitle.examples; - - Basic <function>uopz_del_function</function> Usage - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - uopz_add_function - uopz_unset_return - - - - - - diff --git a/reference/uopz/functions/uopz-delete.xml b/reference/uopz/functions/uopz-delete.xml deleted file mode 100644 index fab090309282..000000000000 --- a/reference/uopz/functions/uopz-delete.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - uopz_delete - Delete a function - - - - &uopz.warn.removed.function-5-0-0; - - - - &reftitle.description; - - voiduopz_delete - stringfunction - - - voiduopz_delete - stringclass - stringfunction - - - Deletes a function or method - - - - - &reftitle.parameters; - - - class - - - - - - - function - - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - <function>uopz_delete</function> example - - -]]> - - &example.outputs.similar; - - - - - - <function>uopz_delete</function> class example - - -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/uopz/functions/uopz-extend.xml b/reference/uopz/functions/uopz-extend.xml deleted file mode 100644 index 171ec21bde8a..000000000000 --- a/reference/uopz/functions/uopz-extend.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - uopz_extend - Extend a class at runtime - - - - &reftitle.description; - - booluopz_extend - stringclass - stringparent - - - Makes class extend parent - - - - - &reftitle.parameters; - - - class - - - The name of the class to extend - - - - - parent - - - The name of the class to inherit - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - As of PHP 7.4.0, uopz_extend throws a RuntimeException, - if OPcache is enabled, - and the class entry of either class - or parent (if it is a trait) is immutable. - - - - - &reftitle.examples; - - <function>uopz_extend</function> example - - -]]> - - &example.outputs; - - - string(1) "B" -} -]]> - - - - - - - diff --git a/reference/uopz/functions/uopz-flags.xml b/reference/uopz/functions/uopz-flags.xml deleted file mode 100644 index e92880c7bc0f..000000000000 --- a/reference/uopz/functions/uopz-flags.xml +++ /dev/null @@ -1,185 +0,0 @@ - - - - - - uopz_flags - Get or set flags on function or class - - - - &reftitle.description; - - intuopz_flags - stringfunction - intflagsPHP_INT_MAX - - - intuopz_flags - stringclass - stringfunction - intflagsPHP_INT_MAX - - - Get or set the flags on a class or function entry at runtime - - - - - - &reftitle.parameters; - - - class - - - The name of a class - - - - - function - - - The name of the function. If class is given and an empty string - is passed as function, uopz_flags - gets or sets the flags of the class entry. - - - - - flags - - - A valid set of ZEND_ACC_ flags. - If omitted, uopz_flags acts as getter. - - - - - - - - &reftitle.returnvalues; - - If setting, returns old flags, else returns flags - - - - - &reftitle.errors; - - As of PHP 7.4.0, if the parameter flags is passed, - uopz_flags throws a RuntimeException, - if OPcache is enabled, - and the class entry of class - or the function entry of function is immutable. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL uopz 5.0.0 - - The flags parameter is now optional. Formerly, - ZEND_ACC_FETCH had to be passed to use uopz_flags - as getter. - - - - - - - - - &reftitle.examples; - - <function>uopz_flags</function> example - - -]]> - - &example.outputs; - - - - - - "Unfinalize" a Class - -isFinal()); -?> -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/uopz/functions/uopz-function.xml b/reference/uopz/functions/uopz-function.xml deleted file mode 100644 index 79b208885769..000000000000 --- a/reference/uopz/functions/uopz-function.xml +++ /dev/null @@ -1,147 +0,0 @@ - - - - - - uopz_function - Creates a function at runtime - - - - &uopz.warn.removed.function-5-0-0; - - - - &reftitle.description; - - voiduopz_function - stringfunction - Closurehandler - intmodifiers - - - voiduopz_function - stringclass - stringfunction - Closurehandler - intmodifiers - - - Creates a function at runtime - - - - - - &reftitle.parameters; - - - class - - - The name of the class to receive the new function - - - - - function - - - The name of the function - - - - - handler - - - The Closure for the function - - - - - modifiers - - - The modifiers for the function, by default copied or ZEND_ACC_PUBLIC - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - <function>uopz_function</function> example - - -]]> - - &example.outputs; - - - - - - <function>uopz_function</function> class example - - -]]> - - &example.outputs; - - - - - - - - - - diff --git a/reference/uopz/functions/uopz-get-exit-status.xml b/reference/uopz/functions/uopz-get-exit-status.xml deleted file mode 100644 index 3f1035ede329..000000000000 --- a/reference/uopz/functions/uopz-get-exit-status.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - uopz_get_exit_status - Retrieve the last set exit status - - - - &reftitle.description; - - mixeduopz_get_exit_status - - - - Retrieves the last set exit status, i.e. the value passed to - exit. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - This function returns the last exit status, or &null; if exit - has not been called. - - - - - &reftitle.examples; - - <function>uopz_get_exit_status</function> example - - -]]> - - &example.outputs; - - - - - - - - &reftitle.notes; - - - OPcache optimizes away dead code after unconditional exit. - - - - - - &reftitle.seealso; - - uopz_allow_exit - - - - - - diff --git a/reference/uopz/functions/uopz-get-hook.xml b/reference/uopz/functions/uopz-get-hook.xml deleted file mode 100644 index 2b3bc23857b4..000000000000 --- a/reference/uopz/functions/uopz-get-hook.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - uopz_get_hook - Gets previously set hook on function or method - - - - &reftitle.description; - - Closureuopz_get_hook - stringfunction - - - Closureuopz_get_hook - stringclass - stringfunction - - - Gets the previously set hook on a function or method. - - - - - &reftitle.parameters; - - - class - - - The name of the class. - - - - - function - - - The name of the function or method. - - - - - - - - &reftitle.returnvalues; - - Returns the previously set hook on a function or method, or &null; if no hook - has been set. - - - - - &reftitle.examples; - - Basic <function>uopz_get_hook</function> Usage - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - uopz_set_hook - uopz_unset_hook - - - - - - diff --git a/reference/uopz/functions/uopz-get-mock.xml b/reference/uopz/functions/uopz-get-mock.xml deleted file mode 100644 index acc6abbb8610..000000000000 --- a/reference/uopz/functions/uopz-get-mock.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - uopz_get_mock - Get the current mock for a class - - - - &reftitle.description; - - mixeduopz_get_mock - stringclass - - - Returns the current mock for class. - - - - - &reftitle.parameters; - - - class - - - The name of the mocked class. - - - - - - - &reftitle.returnvalues; - - Either a string containing the name of the mock, or an object, - or &null; if no mock has been set. - - - - - &reftitle.examples; - - <function>uopz_get_mock</function> example - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - uopz_set_mock - uopz_unset_mock - - - - - - diff --git a/reference/uopz/functions/uopz-get-property.xml b/reference/uopz/functions/uopz-get-property.xml deleted file mode 100644 index 6576e91c8122..000000000000 --- a/reference/uopz/functions/uopz-get-property.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - uopz_get_property - Gets value of class or instance property - - - - &reftitle.description; - - mixeduopz_get_property - stringclass - stringproperty - - - mixeduopz_get_property - objectinstance - stringproperty - - - Gets the value of a static class property, if class - is given, or the value of an instance property, if instance - is given. - - - - - &reftitle.parameters; - - - class - - - The name of the class. - - - - - instance - - - The object instance. - - - - - property - - - The name of the property. - - - - - - - - &reftitle.returnvalues; - - Returns the value of the class or instance property, or &null; if the property - is not defined. - - - - - &reftitle.examples; - - Basic <function>uopz_get_property</function> Usage - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - uopz_set_property - - - - - - diff --git a/reference/uopz/functions/uopz-get-return.xml b/reference/uopz/functions/uopz-get-return.xml deleted file mode 100644 index 41fed270e6b8..000000000000 --- a/reference/uopz/functions/uopz-get-return.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - uopz_get_return - Gets a previous set return value for a function - - - - &reftitle.description; - - mixeduopz_get_return - stringfunction - - - mixeduopz_get_return - stringclass - stringfunction - - - Gets the return value of the function previously set by uopz_set_return. - - - - - &reftitle.parameters; - - - class - - - The name of the class containing the function - - - - - function - - - The name of the function - - - - - - - - &reftitle.returnvalues; - - The return value or Closure previously set. - - - - - &reftitle.examples; - - <function>uopz_get_return</function> example - - -]]> - - &example.outputs; - - - - - - - - - - diff --git a/reference/uopz/functions/uopz-get-static.xml b/reference/uopz/functions/uopz-get-static.xml deleted file mode 100644 index 93ce34b94ed2..000000000000 --- a/reference/uopz/functions/uopz-get-static.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - uopz_get_static - Gets the static variables from function or method scope - - - - &reftitle.description; - - arrayuopz_get_static - stringclass - stringfunction - - - arrayuopz_get_static - stringfunction - - - Gets the static variables from function or method scope. - - - - - &reftitle.parameters; - - - class - - - The name of the class. - - - - - function - - - The name of the function or method. - - - - - - - - &reftitle.returnvalues; - - Returns an associative array of variable names mapped to their - current values on success, or &null; if the function or method does not exist. - - - As of PHP 8.3.0, static initializers are either computed during compile time, - or if that is not possible, only when the function or method is run the first - time, in which case the value of the static variable is reported as &null; - prior to the first invocation. - - - - - &reftitle.examples; - - Basic <function>uopz_get_static</function> Usage - - -]]> - - &example.outputs; - - - string(3) "baz" -} -]]> - - - - - - &reftitle.seealso; - - ReflectionFunctionAbstract::getStaticVariables - uopz_set_static - - - - - - diff --git a/reference/uopz/functions/uopz-implement.xml b/reference/uopz/functions/uopz-implement.xml deleted file mode 100644 index 6ed8b25fa823..000000000000 --- a/reference/uopz/functions/uopz-implement.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - uopz_implement - Implements an interface at runtime - - - - &reftitle.description; - - booluopz_implement - stringclass - stringinterface - - - Makes class implement interface - - - - - - &reftitle.parameters; - - - class - - - - - - - - interface - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - As of PHP 7.4.0, uopz_implement throws a RuntimeException, - if OPcache is enabled, - and the class entry of class is immutable. - - - - - &reftitle.examples; - - <function>uopz_implement</function> example - - -]]> - - &example.outputs; - - - string(11) "myInterface" -} -]]> - - - - - - - - diff --git a/reference/uopz/functions/uopz-overload.xml b/reference/uopz/functions/uopz-overload.xml deleted file mode 100644 index 0539df8f3380..000000000000 --- a/reference/uopz/functions/uopz-overload.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - uopz_overload - Overload a VM opcode - - - - &uopz.warn.removed.function-5-0-0; - - - - &reftitle.description; - - voiduopz_overload - intopcode - Callablecallable - - - Overloads the specified opcode with the user defined function - - - - - - &reftitle.parameters; - - - opcode - - - A valid opcode, see constants for details of supported codes - - - - - callable - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - <function>uopz_overload</function> example - - -]]> - - &example.outputs; - - - - - - - - - - diff --git a/reference/uopz/functions/uopz-redefine.xml b/reference/uopz/functions/uopz-redefine.xml deleted file mode 100644 index 6bece72b59b6..000000000000 --- a/reference/uopz/functions/uopz-redefine.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - uopz_redefine - Redefine a constant - - - - &reftitle.description; - - booluopz_redefine - stringconstant - mixedvalue - - - booluopz_redefine - stringclass - stringconstant - mixedvalue - - - Redefines the given constant as value - - - - - &reftitle.parameters; - - - class - - - The name of the class containing the constant - - - - - constant - - - The name of the constant - - - - - value - - - The new value for the constant, must be a valid type for a constant variable - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>uopz_redefine</function> example - - -]]> - - &example.outputs; - - - - - - - - - - diff --git a/reference/uopz/functions/uopz-rename.xml b/reference/uopz/functions/uopz-rename.xml deleted file mode 100644 index 064747c993be..000000000000 --- a/reference/uopz/functions/uopz-rename.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - uopz_rename - Rename a function at runtime - - - - &uopz.warn.removed.function-5-0-0; - - - - &reftitle.description; - - voiduopz_rename - stringfunction - stringrename - - - voiduopz_rename - stringclass - stringfunction - stringrename - - - Renames function to rename - - - - If both functions exist, this effectively swaps their names - - - - - - &reftitle.parameters; - - - class - - - The name of the class containing the function - - - - - function - - - The name of an existing function - - - - - rename - - - The new name for the function - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - <function>uopz_rename</function> example - - -]]> - - &example.outputs; - - - - - - <function>uopz_rename</function> class example - - -]]> - - &example.outputs; - - - - - - - - - - diff --git a/reference/uopz/functions/uopz-restore.xml b/reference/uopz/functions/uopz-restore.xml deleted file mode 100644 index 80a67864046d..000000000000 --- a/reference/uopz/functions/uopz-restore.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - uopz_restore - Restore a previously backed up function - - - - &uopz.warn.removed.function-5-0-0; - - - - &reftitle.description; - - voiduopz_restore - stringfunction - - - voiduopz_restore - stringclass - stringfunction - - - Restore a previously backed up function - - - - - - &reftitle.parameters; - - - class - - - The name of the class containing the function to restore - - - - - function - - - The name of the function - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - <function>uopz_restore</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/uopz/functions/uopz-set-hook.xml b/reference/uopz/functions/uopz-set-hook.xml deleted file mode 100644 index 6cf4041c6067..000000000000 --- a/reference/uopz/functions/uopz-set-hook.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - uopz_set_hook - Sets hook to execute when entering a function or method - - - - &reftitle.description; - - booluopz_set_hook - stringfunction - Closurehook - - - booluopz_set_hook - stringclass - stringfunction - Closurehook - - - Sets a hook to execute when entering a function or method. - - - - - &reftitle.parameters; - - - class - - - The name of the class. - - - - - function - - - The name of the function or method. - - - - - hook - - - A closure to execute when entering the function or method. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Basic <function>uopz_set_hook</function> Usage - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - uopz_get_hook - uopz_unset_hook - - - - - - diff --git a/reference/uopz/functions/uopz-set-mock.xml b/reference/uopz/functions/uopz-set-mock.xml deleted file mode 100644 index fedc74606f83..000000000000 --- a/reference/uopz/functions/uopz-set-mock.xml +++ /dev/null @@ -1,217 +0,0 @@ - - - - - - uopz_set_mock - Use mock instead of class for new objects - - - - &reftitle.description; - - voiduopz_set_mock - stringclass - mixedmock - - - If mock is a string containing the name of a class then it will be instantiated instead of - class. mock can also be an object. - - - - Only dynamic access to properties and methods will use the mock object. - Static access still uses the original class. - See example below. - - - - - - &reftitle.parameters; - - - class - - - The name of the class to be mocked. - - - - - mock - - - The mock to use in the form of a string containing the name of the class to use or an object. - If a string is passed, it has to be the fully qualified class name. It is - recommended to use the ::class magic constant in this case. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL uopz 6.0.0 - - Mocking static members is no longer supported by this function. - uopz_redefine and uopz_set_return, - or Componere can be used instead. - - - - - - - - - &reftitle.examples; - - <function>uopz_set_mock</function> example - -who(); -?> -]]> - - &example.outputs; - - - - - - <function>uopz_set_mock</function> example - -who(); -?> -]]> - - &example.outputs; - - - - - - <function>uopz_set_mock</function> and static members - - As of uopz 6.0.0 mocking static members is no longer supported. - - - -]]> - - &example.outputs; - - - - - Output of the above example in uopz 5: - - - - - - - - - &reftitle.seealso; - - uopz_get_mock - uopz_unset_mock - - - - - - diff --git a/reference/uopz/functions/uopz-set-property.xml b/reference/uopz/functions/uopz-set-property.xml deleted file mode 100644 index e8377d9e2354..000000000000 --- a/reference/uopz/functions/uopz-set-property.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - uopz_set_property - Sets value of existing class or instance property - - - - &reftitle.description; - - voiduopz_set_property - stringclass - stringproperty - mixedvalue - - - voiduopz_set_property - objectinstance - stringproperty - mixedvalue - - - Sets the value of an existing static class property, if class - is given, or the value of an instance property (regardless whether the instance property already exists), if instance - is given. - - - - - &reftitle.parameters; - - - class - - - The name of the class. - - - - - instance - - - The object instance. - - - - - property - - - The name of the property. - - - - - value - - - The value to assign to the property. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Basic <function>uopz_set_property</function> Usage - -bar; - } -} -$foo = new Foo; -uopz_set_property('Foo', 'staticBar', 10); -uopz_set_property($foo, 'bar', 100); -var_dump(Foo::testStaticBar()); -var_dump($foo->testBar()); -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - uopz_get_property - - - - - - diff --git a/reference/uopz/functions/uopz-set-return.xml b/reference/uopz/functions/uopz-set-return.xml deleted file mode 100644 index e0400cc03856..000000000000 --- a/reference/uopz/functions/uopz-set-return.xml +++ /dev/null @@ -1,164 +0,0 @@ - - - - - - uopz_set_return - Provide a return value for an existing function - - - - &reftitle.description; - - booluopz_set_return - stringfunction - mixedvalue - boolexecute&false; - - - booluopz_set_return - stringclass - stringfunction - mixedvalue - boolexecute&false; - - - Sets the return value of the function to value. If value - is a Closure and execute is set, the Closure will be executed in place of the original function. - It is possible to call the original function from the Closure. - - - - This function replaces uopz_rename. - - - - - - &reftitle.parameters; - - - class - - - The name of the class containing the function - - - - - function - - - The name of an existing function - - - - - value - - - The value the function should return. If a Closure is provided and the execute flag is set, the Closure will be executed in place of the original function. - - - - - execute - - - If true, and a Closure was provided as the value, the Closure will be executed in place of the original function. - - - - - - - - &reftitle.returnvalues; - - True if succeeded, false otherwise. - - - - - &reftitle.examples; - - <function>uopz_set_return</function> example - - -]]> - - &example.outputs; - - - - - - <function>uopz_set_return</function> example - - -]]> - - &example.outputs; - - - - - - <function>uopz_set_return</function> class example - - -]]> - - &example.outputs; - - - - - - - - - - diff --git a/reference/uopz/functions/uopz-undefine.xml b/reference/uopz/functions/uopz-undefine.xml deleted file mode 100644 index ef16d3467bb0..000000000000 --- a/reference/uopz/functions/uopz-undefine.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - uopz_undefine - Undefine a constant - - - - &reftitle.description; - - booluopz_undefine - stringconstant - - - booluopz_undefine - stringclass - stringconstant - - - Removes the constant at runtime - - - - - &reftitle.parameters; - - - class - - - The name of the class containing constant - - - - - constant - - - The name of an existing constant - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>uopz_undefine</function> example - - -]]> - - &example.outputs; - - - - - - - - - - diff --git a/reference/uopz/functions/uopz-unset-hook.xml b/reference/uopz/functions/uopz-unset-hook.xml deleted file mode 100644 index a12820ea9aff..000000000000 --- a/reference/uopz/functions/uopz-unset-hook.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - uopz_unset_hook - Removes previously set hook on function or method - - - - &reftitle.description; - - booluopz_unset_hook - stringfunction - - - booluopz_unset_hook - stringclass - stringfunction - - - Removes the previously set hook on a function or method. - - - - - &reftitle.parameters; - - - class - - - The name of the class. - - - - - function - - - The name of the function or method. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Basic <function>uopz_unset_hook</function> Usage - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - uopz_set_hook - uopz_get_hook - - - - - - diff --git a/reference/uopz/functions/uopz-unset-mock.xml b/reference/uopz/functions/uopz-unset-mock.xml deleted file mode 100644 index fc83562a0288..000000000000 --- a/reference/uopz/functions/uopz-unset-mock.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - uopz_unset_mock - Unset previously set mock - - - - &reftitle.description; - - voiduopz_unset_mock - stringclass - - - Unsets the previously set mock for class. - - - - - &reftitle.parameters; - - - class - - - The name of the mocked class. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - A RuntimeException is thrown, if no mock was previously - set for class. - - - - - &reftitle.examples; - - <function>uopz_unset_mock</function> example - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - uopz_set_mock - uopz_get_mock - - - - - - diff --git a/reference/uopz/functions/uopz-unset-return.xml b/reference/uopz/functions/uopz-unset-return.xml deleted file mode 100644 index a9437042dde4..000000000000 --- a/reference/uopz/functions/uopz-unset-return.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - uopz_unset_return - Unsets a previously set return value for a function - - - - &reftitle.description; - - booluopz_unset_return - stringfunction - - - booluopz_unset_return - stringclass - stringfunction - - - Unsets the return value of the function previously set by uopz_set_return. - - - - - &reftitle.parameters; - - - class - - - The name of the class containing the function - - - - - function - - - The name of the function - - - - - - - - &reftitle.returnvalues; - - True on success - - - - - &reftitle.examples; - - <function>uopz_unset_return</function> example - - -]]> - - &example.outputs; - - - - - - - - - - diff --git a/reference/uopz/functions/uopz_set_static.xml b/reference/uopz/functions/uopz_set_static.xml deleted file mode 100644 index 52b09fab9f61..000000000000 --- a/reference/uopz/functions/uopz_set_static.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - uopz_set_static - Sets the static variables in function or method scope - - - - &reftitle.description; - - voiduopz_set_static - stringfunction - arraystatic - - - voiduopz_set_static - stringclass - stringfunction - arraystatic - - - Sets the static variables in function or method scope. - - - - - &reftitle.parameters; - - - class - - - The name of the class. - - - - - function - - - The name of the function or method. - - - - - static - - - The associative array of variable names mapped to their - values. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Basic <function>uopz_set_static</function> Usage - - 'qux']); -foo(); -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - uopz_get_static - - - - - - diff --git a/reference/uopz/reference.xml b/reference/uopz/reference.xml deleted file mode 100644 index 1ab119f2d0be..000000000000 --- a/reference/uopz/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - Uopz &Functions; - - &reference.uopz.entities.functions; - - - - diff --git a/reference/uopz/setup.xml b/reference/uopz/setup.xml deleted file mode 100644 index 076648b53a16..000000000000 --- a/reference/uopz/setup.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - As of uopz 5.0 PHP 7.0 is required. As of uopz 5.1, PHP 7.1+ is required. - -
    - -
    - &reftitle.install; - - uopz releases are hosted by PECL and the source code by - github, - the easiest route to installation is the normal PECL route: - &url.pecl.package;uopz. - - - Windows users can download prebuilt release binaries from the PECL website. - - - As of uopz 5.0.0 the extension must be loaded as - extension. Before this version it must be - loaded as zend_extension. - -
    - -
    - &reftitle.runtime; - &extension.runtime; - - - uopz &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - uopz.disable - "0" - INI_SYSTEM - Available as of uopz 5.0.2 - - - uopz.exit - "0" - INI_SYSTEM - Available as of uopz 6.0.1 - - - uopz.overloads - "1" - INI_SYSTEM - Available as of uopz 2.0.2. Removed as of uopz 5.0.0. - - - -
    - &ini.php.constants; -
    - - &ini.descriptions.title; - - - - - - uopz.disable - bool - - - - If enabled, uopz should stop having any effect on the engine. - - - - - - uopz.exit - bool - - - - Whether to allow the execution of exit opcodes or not. - This setting can be overridden during runtime by calling uopz_allow_exit. - - - - - - uopz.overloads - bool - - - - Enables the ability to use uopz_overload. - - - - - - - - - When running with OPcache enabled, it may be necessary to disable all - OPcache optimizations - (opcache.optimization_level=0). - - -
    - -
    - - diff --git a/reference/uopz/test.out b/reference/uopz/test.out deleted file mode 100644 index 9085588c017a..000000000000 --- a/reference/uopz/test.out +++ /dev/null @@ -1,4 +0,0 @@ -array(1) { - ["myInterface"]=> - string(11) "myInterface" -} diff --git a/reference/uopz/versions.xml b/reference/uopz/versions.xml deleted file mode 100644 index ed2224f3989c..000000000000 --- a/reference/uopz/versions.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/v8js/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/v8js/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/v8js/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/v8js/book.xml b/reference/v8js/book.xml deleted file mode 100644 index 7bc3c086f596..000000000000 --- a/reference/v8js/book.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - - V8 Javascript Engine Integration - V8js - - - &reftitle.intro; - - This extension embeds the V8 Javascript Engine into PHP. - - - - &reference.v8js.setup; - &reference.v8js.examples; - - &reference.v8js.v8js; - &reference.v8js.v8jsexception; - - - - diff --git a/reference/v8js/configure.xml b/reference/v8js/configure.xml deleted file mode 100644 index 843a22356747..000000000000 --- a/reference/v8js/configure.xml +++ /dev/null @@ -1,35 +0,0 @@ - - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;v8js - - - -
    - - - diff --git a/reference/v8js/examples.xml b/reference/v8js/examples.xml deleted file mode 100644 index 20ed5fca38b0..000000000000 --- a/reference/v8js/examples.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - &reftitle.examples; - - Basic usage - - - Basic Javascript execution - -executeString($JS, 'basic.js')); -} catch (V8JsException $e) { - var_dump($e); -} - -?> -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/v8js/ini.xml b/reference/v8js/ini.xml deleted file mode 100644 index 636ece6753fd..000000000000 --- a/reference/v8js/ini.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - -
    - &reftitle.runtime; - &extension.runtime; - - - V8js &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - v8js.max_disposed_contexts - 25 - INI_ALL - - - - v8js.flags - - INI_ALL - - - - -
    -
    - - &ini.descriptions.title; - - - - - - v8js.max_disposed_contexts - int - - - - Sets limit for disposed contexts before forcing V8 to do garbage - collection. - - - - - - v8js.flags - string - - - - Sets V8 command line flags. The list of available flags can be - obtained in CLI mode by setting this parameter to - --help. Example: - - - - - - - - For these flags to be effective in runtime the ini_set() call has - to be done before any V8Js objects are instantiated! - - - - - - - - -
    - - diff --git a/reference/v8js/setup.xml b/reference/v8js/setup.xml deleted file mode 100644 index 83e6faa9253a..000000000000 --- a/reference/v8js/setup.xml +++ /dev/null @@ -1,39 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - PHP and V8 library and headers installed in proper paths. - -
    - - &reference.v8js.configure; - - &reference.v8js.ini; - -
    - - diff --git a/reference/v8js/v8js.xml b/reference/v8js/v8js.xml deleted file mode 100644 index 059ff7fe2b25..000000000000 --- a/reference/v8js/v8js.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - The <classname>V8Js</classname> class - V8Js - - - - -
    - &reftitle.intro; - - This is the core class for V8Js extension. Each instance created from - this class has own context in which all JavaScript is compiled and - executed. - - - See V8Js::__construct for more information. - -
    - - -
    - &reftitle.classsynopsis; - - - - V8Js - - - - - V8Js - - - - &Constants; - - const - string - V8Js::V8_VERSION - - - const - int - V8Js::FLAG_NONE - 1 - - - const - int - V8Js::FLAG_FORCE_ARRAY - 2 - - - &Methods; - - - - - -
    - - -
    - &reftitle.constants; - - - - V8Js::V8_VERSION - - The V8 Javascript Engine version. - - - - - V8Js::FLAG_NONE - - No flags. - - - - - V8Js::FLAG_FORCE_ARRAY - - Forces all JS objects to be associative arrays in PHP. - - - - -
    - - - -
    - - &reference.v8js.entities.v8js; - -
    - - diff --git a/reference/v8js/v8js/construct.xml b/reference/v8js/v8js/construct.xml deleted file mode 100644 index 838906a21ba7..000000000000 --- a/reference/v8js/v8js/construct.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - V8Js::__construct - Construct a new V8Js object - - - - &reftitle.description; - - public V8Js::__construct - stringobject_name"PHP" - arrayvariablesarray() - arrayextensionsarray() - boolreport_uncaught_exceptions&true; - - - Constructs a new V8Js object. - - - - - - &reftitle.parameters; - - - object_name - - - The name of the object passed to Javascript. - - - - - variables - - - Map of PHP variables that will be available in Javascript. Must be an associative array - in format array("name-for-js" => "name-of-php-variable"). Defaults to empty array. - - - - - extensions - - - List of extensions registered using V8Js::registerExtension which should be available - in the Javascript context of the created V8Js object. - - - Extensions registered to be enabled automatically do not need to be listed in this array. - Also if an extension has dependencies, those dependencies can be omitted as well. Defaults to empty array. - - - - - - - report_uncaught_exceptions - - - Controls whether uncaught Javascript exceptions are reported immediately or not. Defaults to &true;. If set to &false; - the uncaught exception can be accessed using V8Js::getPendingException. - - - - - - - - - diff --git a/reference/v8js/v8js/executestring.xml b/reference/v8js/v8js/executestring.xml deleted file mode 100644 index 1e427a1cd996..000000000000 --- a/reference/v8js/v8js/executestring.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - V8Js::executeString - Execute a string as Javascript code - - - - &reftitle.description; - - public mixedV8Js::executeString - stringscript - stringidentifier"V8Js::executeString()" - intflagsV8Js::FLAG_NONE - - - Compiles and executes the string passed with script as Javascript code. - - - - - &reftitle.parameters; - - - script - - - The code string to be executed. - - - - - identifier - - - Identifier string for the executed code. Used for debugging. - - - - - flags - - - Execution flags. This value must be one of the - V8Js::FLAG_* constants, defaulting to - V8Js::FLAG_NONE. - - - - V8Js::FLAG_NONE: no flags - - - - - V8Js::FLAG_FORCE_ARRAY: forces all Javascript - objects passed to PHP to be associative arrays - - - - - - - - - - - &reftitle.returnvalues; - - Returns the last variable instantiated in the Javascript code converted to matching PHP variable type. - - - - - diff --git a/reference/v8js/v8js/getextensions.xml b/reference/v8js/v8js/getextensions.xml deleted file mode 100644 index dbe9114cc40a..000000000000 --- a/reference/v8js/v8js/getextensions.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - V8Js::getExtensions - Return an array of registered extensions - - - - &reftitle.description; - - public static arrayV8Js::getExtensions - - - - This function returns array of Javascript extensions registered using V8Js::registerExtension. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an array of registered extensions or an empty array if there are none. - - - - - - diff --git a/reference/v8js/v8js/getpendingexception.xml b/reference/v8js/v8js/getpendingexception.xml deleted file mode 100644 index 217564dc3438..000000000000 --- a/reference/v8js/v8js/getpendingexception.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - V8Js::getPendingException - Return pending uncaught Javascript exception - - - - &reftitle.description; - - public V8JsExceptionV8Js::getPendingException - - - - Returns any pending uncaught Javascript exception as V8JsException - left from earlier V8Js::executeString call(s). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Either V8JsException or &null;. - - - - - - diff --git a/reference/v8js/v8js/registerextension.xml b/reference/v8js/v8js/registerextension.xml deleted file mode 100644 index 07ff8422b6c9..000000000000 --- a/reference/v8js/v8js/registerextension.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - V8Js::registerExtension - Register Javascript extensions for V8Js - - - - &reftitle.description; - - public static boolV8Js::registerExtension - stringextension_name - stringscript - arraydependenciesarray() - boolauto_enable&false; - - - Registers passed Javascript script as extension to - be used in V8Js contexts. - - - - - &reftitle.parameters; - - - extension_name - - - Name of the extension to be registered. - - - - - script - - - The Javascript code to be registered. - - - - - dependencies - - - Array of extension names the extension to be registered depends on. Any such extension is - enabled automatically when this extension is loaded. - - - All extensions, including the dependencies, must be registered before any V8Js - are created which use them. - - - - - - - auto_enable - - - If set to &true;, the extension will be enabled automatically in all V8Js contexts. - - - - - - - - &reftitle.returnvalues; - - Returns &true; if extension was registered successfully, &false; otherwise. - - - - - - - diff --git a/reference/v8js/v8jsexception.xml b/reference/v8js/v8jsexception.xml deleted file mode 100644 index 4e5cb3c7c2cb..000000000000 --- a/reference/v8js/v8jsexception.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - The <classname>V8JsException</classname> class - V8JsException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - V8JsException - - - - - V8JsException - - - - extends - Exception - - - - &Properties; - - protected - JsFileName - - - protected - JsLineNumber - - - protected - JsSourceLine - - - protected - JsTrace - - - &InheritedProperties; - - - &Methods; - - - &InheritedMethods; - - - - - -
    - - - -
    - &reftitle.properties; - - - JsFileName - - - - - - JsLineNumber - - - - - - JsSourceLine - - - - - - JsTrace - - - - - -
    - - - -
    - - &reference.v8js.entities.v8jsexception; - -
    - - diff --git a/reference/v8js/v8jsexception/getjsfilename.xml b/reference/v8js/v8jsexception/getjsfilename.xml deleted file mode 100644 index d5926ad3b1ca..000000000000 --- a/reference/v8js/v8jsexception/getjsfilename.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - V8JsException::getJsFileName - The getJsFileName purpose - - - - &reftitle.description; - - final public stringV8JsException::getJsFileName - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/v8js/v8jsexception/getjslinenumber.xml b/reference/v8js/v8jsexception/getjslinenumber.xml deleted file mode 100644 index 172fd7d3d8fa..000000000000 --- a/reference/v8js/v8jsexception/getjslinenumber.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - V8JsException::getJsLineNumber - The getJsLineNumber purpose - - - - &reftitle.description; - - final public intV8JsException::getJsLineNumber - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/v8js/v8jsexception/getjssourceline.xml b/reference/v8js/v8jsexception/getjssourceline.xml deleted file mode 100644 index adc21d43e8ac..000000000000 --- a/reference/v8js/v8jsexception/getjssourceline.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - V8JsException::getJsSourceLine - The getJsSourceLine purpose - - - - &reftitle.description; - - final public stringV8JsException::getJsSourceLine - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/v8js/v8jsexception/getjstrace.xml b/reference/v8js/v8jsexception/getjstrace.xml deleted file mode 100644 index dc3489a54591..000000000000 --- a/reference/v8js/v8jsexception/getjstrace.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - V8JsException::getJsTrace - The getJsTrace purpose - - - - &reftitle.description; - - final public stringV8JsException::getJsTrace - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/v8js/versions.xml b/reference/v8js/versions.xml deleted file mode 100644 index 062fcedf12ab..000000000000 --- a/reference/v8js/versions.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/var_representation/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/var_representation/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/var_representation/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/var_representation/book.xml b/reference/var_representation/book.xml deleted file mode 100644 index 3ba88d19a753..000000000000 --- a/reference/var_representation/book.xml +++ /dev/null @@ -1,39 +0,0 @@ - - - - var_representation - var_representation - - - &reftitle.intro; - - The var_representation extension provides a compact alternative to var_export that properly escapes control characters. - - - - &reference.var-representation.setup; - &reference.var-representation.constants; - &reference.var-representation.reference; - - - - diff --git a/reference/var_representation/constants.xml b/reference/var_representation/constants.xml deleted file mode 100644 index a67d0615b62f..000000000000 --- a/reference/var_representation/constants.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - &reftitle.constants; - &extension.constants; - - - - - VAR_REPRESENTATION_SINGLE_LINE - (int) - - - - var_representation flag indicating that newlines - should not be used for whitespace in variable representations. - - - - - - VAR_REPRESENTATION_UNESCAPED - (int) - - - - var_representation flag indicating that strings should be encoded - as single quoted strings with unescaped control characters. - - - - - - - diff --git a/reference/var_representation/functions/var-representation.xml b/reference/var_representation/functions/var-representation.xml deleted file mode 100644 index e274129c7a2b..000000000000 --- a/reference/var_representation/functions/var-representation.xml +++ /dev/null @@ -1,222 +0,0 @@ - - - - var_representation - Returns a short, readable, parsable string representation of a variable - - - - &reftitle.description; - - stringvar_representation - mixedvalue - intflags0 - - - var_representation (from the var_representation PECL) returns a string with structured information about the - given variable. It is similar to var_export with differences in indentation, string escaping, and array representations. - - - - - &reftitle.parameters; - - - value - - - The variable to generate a representation of. - - - - - flags - - - Bitmask consisting of - VAR_REPRESENTATION_SINGLE_LINE, - VAR_REPRESENTATION_UNESCAPED. - The behaviour of these constants is described on the - var_representation constants page. - - - - - - - - &reftitle.returnvalues; - - Returns the variable representation. - - - - - &reftitle.examples; - - - <function>var_representation</function> Examples - - 'value']]; -echo var_representation($a), "\n"; -echo var_representation($a, VAR_REPRESENTATION_SINGLE_LINE), "\n"; -?> -]]> - - &example.outputs; - - 'value', - ], -] -[1, 2, ['key' => 'value']] -]]> - - - - - - Escaping control characters - - - - &example.outputs; - - - - - - - - Exporting <classname>stdClass</classname> - -name = 'ElePHPant ElePHPantsdotter'; -$person->website = 'https://php.net/elephpant.php'; - -echo var_representation($person); -]]> - - &example.outputs; - - 'ElePHPant ElePHPantsdotter', - 'website' => 'https://php.net/elephpant.php', -] -]]> - - - - - - Exporting classes - -var = 5; -echo var_representation($a); -?> -]]> - - &example.outputs; - - 5, -]) -]]> - - - - - - Using <link linkend="object.set-state">__set_state()</link> - -var1 = $an_array['var1']; - $obj->var2 = $an_array['var2']; - return $obj; - } -} - -$a = new A; -$a->var1 = 5; -$a->var2 = 'foo'; - -eval('$b = ' . var_representation($a) . ';'); // $b = \A::__set_state([ - // 'var1' => 5, - // 'var2' => 'foo', - // ]); -var_dump($b); -?> -]]> - - &example.outputs; - - - int(5) - ["var2"]=> - string(3) "foo" -} -]]> - - - - - - - &reftitle.seealso; - - - var_export - - - - - diff --git a/reference/var_representation/reference.xml b/reference/var_representation/reference.xml deleted file mode 100644 index 55469e0b56f9..000000000000 --- a/reference/var_representation/reference.xml +++ /dev/null @@ -1,27 +0,0 @@ - - - var_representation &Functions; - - &reference.var-representation.entities.functions; - - - diff --git a/reference/var_representation/setup.xml b/reference/var_representation/setup.xml deleted file mode 100644 index 32ebb0ebb5cc..000000000000 --- a/reference/var_representation/setup.xml +++ /dev/null @@ -1,39 +0,0 @@ - - - &reftitle.setup; - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;var_representation. - - - &pecl.windows.download.avail; - -
    - -
    - diff --git a/reference/var_representation/versions.xml b/reference/var_representation/versions.xml deleted file mode 100644 index 2aae41a7cac2..000000000000 --- a/reference/var_representation/versions.xml +++ /dev/null @@ -1,27 +0,0 @@ - - - - - - - - diff --git a/reference/varnish/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/varnish/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/varnish/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/varnish/book.xml b/reference/varnish/book.xml deleted file mode 100644 index 1d729556d2c7..000000000000 --- a/reference/varnish/book.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - Varnish - Varnish - - - &reftitle.intro; - - Varnish Cache is an open source, state of the art web application - accelerator. The extension makes it possible to interact with a running - varnish instance through TCP socket or shared memory. - - - - &reference.varnish.setup; - &reference.varnish.constants; - &reference.varnish.examples; - - &reference.varnish.varnishadmin; - &reference.varnish.varnishstat; - &reference.varnish.varnishlog; - &reference.varnish.varnishexception; - - - - diff --git a/reference/varnish/configure.xml b/reference/varnish/configure.xml deleted file mode 100644 index 46494e7c22c0..000000000000 --- a/reference/varnish/configure.xml +++ /dev/null @@ -1,35 +0,0 @@ - - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;varnish - - - -
    - - - diff --git a/reference/varnish/constants.xml b/reference/varnish/constants.xml deleted file mode 100644 index ad2decb75cdd..000000000000 --- a/reference/varnish/constants.xml +++ /dev/null @@ -1,222 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - - - - VARNISH_STATUS_SYNTAX - (int) - - - - - - - - - VARNISH_STATUS_UNKNOWN - (int) - - - - - - - - - VARNISH_STATUS_UNIMPL - (int) - - - - - - - - - VARNISH_STATUS_TOOFEW - (int) - - - - - - - - - VARNISH_STATUS_TOOMANY - (int) - - - - - - - - - VARNISH_STATUS_PARAM - (int) - - - - - - - - - VARNISH_STATUS_AUTH - (int) - - - - - - - - - VARNISH_STATUS_OK - (int) - - - - - - - - - VARNISH_STATUS_CANT - (int) - - - - - - - - - VARNISH_STATUS_COMMS - (int) - - - - - - - - - VARNISH_STATUS_CLOSE - (int) - - - - - - - - - VARNISH_CONFIG_IDENT - (string) - - - - - - - - - VARNISH_CONFIG_HOST - (string) - - - - - - - - - VARNISH_CONFIG_PORT - (string) - - - - - - - - - VARNISH_CONFIG_TIMEOUT - (string) - - - - - - - - - VARNISH_CONFIG_SECRET - (string) - - - - - - - - - VARNISH_CONFIG_COMPAT - (string) - - - - - - - - - VARNISH_COMPAT_2 - (int) - - - - - - - - - VARNISH_COMPAT_3 - (int) - - - - - - - - - - - diff --git a/reference/varnish/examples.xml b/reference/varnish/examples.xml deleted file mode 100644 index bbdd67e1e608..000000000000 --- a/reference/varnish/examples.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - &reftitle.examples; -
    - Basic VarnishAdmin usage - - The example illustrates a simple usage of the ban functionality - - - Ban an URL - - "::1", - VARNISH_CONFIG_PORT => 6082, - VARNISH_CONFIG_SECRET => "5174826b-8595-4958-aa7a-0609632ad7ca", - VARNISH_CONFIG_TIMEOUT => 300, -); - -$va = new VarnishAdmin($args); - -try { - if(!$va->connect()) { - throw new VarnishException("Connection failed\n"); - } -} catch (VarnishException $e) { - echo $e->getMessage(); - exit(3); -} - -try { - if(!$va->auth()) { - throw new VarnishException("Auth failed\n"); - } -} catch (VarnishException $e) { - echo $e->getMessage(); - exit(3); -} - -try { - $status = $va->ban('req.url ~ "^/$"'); - if (VARNISH_STATUS_OK != $status) { - throw new VarnishException("Ban method returned $status status\n"); - } -} catch (VarnishException $e) { - echo $e->getMessage(); - exit(3); -} - -exit(0); - -?> -]]> - - -
    -
    - Basic VarnishStat usage - - The example illustrates getting varnish statistic snapshot from shared - memory - - - Get statistic snapshot - -getSnapshot(); -} catch (VarnishException $e) { - echo $e->getMessage(); - exit(3); -} - -exit(0); -?> -]]> - - -
    -
    - Basic VarnishLog usage - - The example illustrates reading varnish log lines from shared memory - - - Read varnish shared memory log - -getLine(); - printf("%s %d %s", VarnishLog::getTagName($line['tag']), $line['id'], - $line['data']); -} - -exit(0); -?> -]]> - - -
    -
    - - - diff --git a/reference/varnish/setup.xml b/reference/varnish/setup.xml deleted file mode 100644 index f9f705a09920..000000000000 --- a/reference/varnish/setup.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - To use this extension, a version of Varnish Cache greater than or equal to 3.0 is required to be installed, - which is available on the Varnish Cache homepage. - -
    - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;varnish. - -
    - -
    - - diff --git a/reference/varnish/varnishadmin.xml b/reference/varnish/varnishadmin.xml deleted file mode 100644 index 6288354f865f..000000000000 --- a/reference/varnish/varnishadmin.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - The VarnishAdmin class - VarnishAdmin - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - VarnishAdmin - - - - - VarnishAdmin - - - - - &Methods; - - - - -
    - -
    - - &reference.varnish.entities.varnishadmin; - -
    - - diff --git a/reference/varnish/varnishadmin/auth.xml b/reference/varnish/varnishadmin/auth.xml deleted file mode 100644 index ca30da15e5df..000000000000 --- a/reference/varnish/varnishadmin/auth.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - VarnishAdmin::auth - Authenticate on a varnish instance - - - - &reftitle.description; - - public boolVarnishAdmin::auth - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - diff --git a/reference/varnish/varnishadmin/ban.xml b/reference/varnish/varnishadmin/ban.xml deleted file mode 100644 index 2b37d5f365a3..000000000000 --- a/reference/varnish/varnishadmin/ban.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - VarnishAdmin::ban - Ban URLs using a VCL expression - - - - &reftitle.description; - - public intVarnishAdmin::ban - stringvcl_regex - - - - - - - - &reftitle.parameters; - - - - vcl_regex - - - Varnish VCL expression. It's based on the varnish ban command. - - - - - - - - - &reftitle.returnvalues; - - Returns the varnish command status. - - - - - - - diff --git a/reference/varnish/varnishadmin/banurl.xml b/reference/varnish/varnishadmin/banurl.xml deleted file mode 100644 index 437db78bb9e3..000000000000 --- a/reference/varnish/varnishadmin/banurl.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - VarnishAdmin::banUrl - Ban an URL using a VCL expression - - - - &reftitle.description; - - public intVarnishAdmin::banUrl - stringvcl_regex - - - - - - - - &reftitle.parameters; - - - - vcl_regex - - - URL regular expression in PCRE compatible syntax. It's based on the - ban.url varnish command. - - - - - - - - - &reftitle.returnvalues; - - Returns the varnish command status. - - - - - - - diff --git a/reference/varnish/varnishadmin/clearpanic.xml b/reference/varnish/varnishadmin/clearpanic.xml deleted file mode 100644 index 8fafee3468a6..000000000000 --- a/reference/varnish/varnishadmin/clearpanic.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - VarnishAdmin::clearPanic - Clear varnish instance panic messages - - - - &reftitle.description; - - public intVarnishAdmin::clearPanic - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the varnish command status. - - - - - - - diff --git a/reference/varnish/varnishadmin/connect.xml b/reference/varnish/varnishadmin/connect.xml deleted file mode 100644 index 3462976d1cf9..000000000000 --- a/reference/varnish/varnishadmin/connect.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - VarnishAdmin::connect - Connect to a varnish instance administration interface - - - - &reftitle.description; - - public boolVarnishAdmin::connect - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - diff --git a/reference/varnish/varnishadmin/construct.xml b/reference/varnish/varnishadmin/construct.xml deleted file mode 100644 index b2cc38a68619..000000000000 --- a/reference/varnish/varnishadmin/construct.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - VarnishAdmin::__construct - VarnishAdmin constructor - - - - &reftitle.description; - - public VarnishAdmin::__construct - arrayargs - - - - - - - - &reftitle.parameters; - - - args - - - Configuration arguments. The possible keys are: - - - - - - - - - &reftitle.returnvalues; - - - - - - &reftitle.examples; - - <function>VarnishAdmin::__construct</function> example - - "::1", - VARNISH_CONFIG_PORT => 6082, - VARNISH_CONFIG_SECRET => "5174826b-8595-4958-aa7a-0609632ad7ca", - VARNISH_CONFIG_TIMEOUT => 300, - ); - $va = new VarnishAdmin($args); -?> -]]> - - - - - - - diff --git a/reference/varnish/varnishadmin/disconnect.xml b/reference/varnish/varnishadmin/disconnect.xml deleted file mode 100644 index 62b704adf655..000000000000 --- a/reference/varnish/varnishadmin/disconnect.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - VarnishAdmin::disconnect - Disconnect from a varnish instance administration interface - - - - &reftitle.description; - - public boolVarnishAdmin::disconnect - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - diff --git a/reference/varnish/varnishadmin/getpanic.xml b/reference/varnish/varnishadmin/getpanic.xml deleted file mode 100644 index 1ad6b6b77f5a..000000000000 --- a/reference/varnish/varnishadmin/getpanic.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - VarnishAdmin::getPanic - Get the last panic message on a varnish instance - - - - &reftitle.description; - - public stringVarnishAdmin::getPanic - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - &reftitle.returnvalues; - - Returns the last panic message on the current varnish instance. - - - - - - - diff --git a/reference/varnish/varnishadmin/getparams.xml b/reference/varnish/varnishadmin/getparams.xml deleted file mode 100644 index a07cee2e2426..000000000000 --- a/reference/varnish/varnishadmin/getparams.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - VarnishAdmin::getParams - Fetch current varnish instance configuration parameters - - - - &reftitle.description; - - public arrayVarnishAdmin::getParams - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an array with the varnish configuration parameters. - - - - - - - diff --git a/reference/varnish/varnishadmin/isrunning.xml b/reference/varnish/varnishadmin/isrunning.xml deleted file mode 100644 index 2a88d860fda7..000000000000 --- a/reference/varnish/varnishadmin/isrunning.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - VarnishAdmin::isRunning - Check if the varnish slave process is currently running - - - - &reftitle.description; - - public boolVarnishAdmin::isRunning - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - diff --git a/reference/varnish/varnishadmin/setcompat.xml b/reference/varnish/varnishadmin/setcompat.xml deleted file mode 100644 index 9f47fc8ff8c5..000000000000 --- a/reference/varnish/varnishadmin/setcompat.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - VarnishAdmin::setCompat - Set the class compat configuration param - - - - &reftitle.description; - - public voidVarnishAdmin::setCompat - intcompat - - - - - - - - &reftitle.parameters; - - - - compat - - - Varnish compatibility option. - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/varnish/varnishadmin/sethost.xml b/reference/varnish/varnishadmin/sethost.xml deleted file mode 100644 index a72bcaa062c8..000000000000 --- a/reference/varnish/varnishadmin/sethost.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - VarnishAdmin::setHost - Set the class host configuration param - - - - &reftitle.description; - - public voidVarnishAdmin::setHost - stringhost - - - - - - - - &reftitle.parameters; - - - - host - - - Connection host configuration parameter. - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/varnish/varnishadmin/setident.xml b/reference/varnish/varnishadmin/setident.xml deleted file mode 100644 index 37b56a3acd0f..000000000000 --- a/reference/varnish/varnishadmin/setident.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - VarnishAdmin::setIdent - Set the class ident configuration param - - - - &reftitle.description; - - public voidVarnishAdmin::setIdent - stringident - - - - - - - - &reftitle.parameters; - - - - ident - - - Connection ident configuration parameter. - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/varnish/varnishadmin/setparam.xml b/reference/varnish/varnishadmin/setparam.xml deleted file mode 100644 index e3262f8da2a1..000000000000 --- a/reference/varnish/varnishadmin/setparam.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - VarnishAdmin::setParam - Set configuration param on the current varnish instance - - - - &reftitle.description; - - public intVarnishAdmin::setParam - stringname - stringintvalue - - - - - - - - &reftitle.parameters; - - - - name - - - Varnish configuration param name. - - - - - value - - - Varnish configuration param value. - - - - - - - - - &reftitle.returnvalues; - - Returns the varnish command status. - - - - - - - diff --git a/reference/varnish/varnishadmin/setport.xml b/reference/varnish/varnishadmin/setport.xml deleted file mode 100644 index b554f92d31b1..000000000000 --- a/reference/varnish/varnishadmin/setport.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - VarnishAdmin::setPort - Set the class port configuration param - - - - &reftitle.description; - - public voidVarnishAdmin::setPort - intport - - - - - - - - &reftitle.parameters; - - - - port - - - Connection port configuration parameter. - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/varnish/varnishadmin/setsecret.xml b/reference/varnish/varnishadmin/setsecret.xml deleted file mode 100644 index ca8311b4cee4..000000000000 --- a/reference/varnish/varnishadmin/setsecret.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - VarnishAdmin::setSecret - Set the class secret configuration param - - - - &reftitle.description; - - public voidVarnishAdmin::setSecret - stringsecret - - - - - - - - &reftitle.parameters; - - - - secret - - - Connection secret configuration parameter. - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/varnish/varnishadmin/settimeout.xml b/reference/varnish/varnishadmin/settimeout.xml deleted file mode 100644 index 6e4df91d77b8..000000000000 --- a/reference/varnish/varnishadmin/settimeout.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - VarnishAdmin::setTimeout - Set the class timeout configuration param - - - - &reftitle.description; - - public voidVarnishAdmin::setTimeout - inttimeout - - - - - - - - &reftitle.parameters; - - - - timeout - - - Connection timeout configuration parameter. - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/varnish/varnishadmin/start.xml b/reference/varnish/varnishadmin/start.xml deleted file mode 100644 index 4e7ae04738eb..000000000000 --- a/reference/varnish/varnishadmin/start.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - VarnishAdmin::start - Start varnish worker process - - - - &reftitle.description; - - public intVarnishAdmin::start - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the varnish command status. - - - - - - - diff --git a/reference/varnish/varnishadmin/stop.xml b/reference/varnish/varnishadmin/stop.xml deleted file mode 100644 index 73b131b0e20d..000000000000 --- a/reference/varnish/varnishadmin/stop.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - VarnishAdmin::stop - Stop varnish worker process - - - - &reftitle.description; - - public intVarnishAdmin::stop - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the varnish command status. - - - - - - - diff --git a/reference/varnish/varnishexception.xml b/reference/varnish/varnishexception.xml deleted file mode 100644 index 008f90297fb7..000000000000 --- a/reference/varnish/varnishexception.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - The VarnishException class - VarnishException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - VarnishException - - - - - VarnishException - - - - extends - Exception - - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
    - - -
    - -
    - - diff --git a/reference/varnish/varnishlog.xml b/reference/varnish/varnishlog.xml deleted file mode 100644 index 04aa68e21c44..000000000000 --- a/reference/varnish/varnishlog.xml +++ /dev/null @@ -1,754 +0,0 @@ - - - - - - The VarnishLog class - VarnishLog - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - VarnishLog - - - - - VarnishLog - - - - &Constants; - - const - int - VarnishLog::TAG_Debug - 0 - - - const - int - VarnishLog::TAG_Error - 1 - - - const - int - VarnishLog::TAG_CLI - 2 - - - const - int - VarnishLog::TAG_StatSess - 3 - - - const - int - VarnishLog::TAG_ReqEnd - 4 - - - const - int - VarnishLog::TAG_SessionOpen - 5 - - - const - int - VarnishLog::TAG_SessionClose - 6 - - - const - int - VarnishLog::TAG_BackendOpen - 7 - - - const - int - VarnishLog::TAG_BackendXID - 8 - - - const - int - VarnishLog::TAG_BackendReuse - 9 - - - const - int - VarnishLog::TAG_BackendClose - 10 - - - const - int - VarnishLog::TAG_HttpGarbage - 11 - - - const - int - VarnishLog::TAG_Backend - 12 - - - const - int - VarnishLog::TAG_Length - 13 - - - const - int - VarnishLog::TAG_FetchError - 14 - - - const - int - VarnishLog::TAG_RxRequest - 15 - - - const - int - VarnishLog::TAG_RxResponse - 16 - - - const - int - VarnishLog::TAG_RxStatus - 17 - - - const - int - VarnishLog::TAG_RxURL - 18 - - - const - int - VarnishLog::TAG_RxProtocol - 19 - - - const - int - VarnishLog::TAG_RxHeader - 20 - - - const - int - VarnishLog::TAG_TxRequest - 21 - - - const - int - VarnishLog::TAG_TxResponse - 22 - - - const - int - VarnishLog::TAG_TxStatus - 23 - - - const - int - VarnishLog::TAG_TxURL - 24 - - - const - int - VarnishLog::TAG_TxProtocol - 25 - - - const - int - VarnishLog::TAG_TxHeader - 26 - - - const - int - VarnishLog::TAG_ObjRequest - 27 - - - const - int - VarnishLog::TAG_ObjResponse - 28 - - - const - int - VarnishLog::TAG_ObjStatus - 29 - - - const - int - VarnishLog::TAG_ObjURL - 30 - - - const - int - VarnishLog::TAG_ObjProtocol - 31 - - - const - int - VarnishLog::TAG_ObjHeader - 32 - - - const - int - VarnishLog::TAG_LostHeader - 33 - - - const - int - VarnishLog::TAG_TTL - 34 - - - const - int - VarnishLog::TAG_Fetch_Body - 35 - - - const - int - VarnishLog::TAG_VCL_acl - 36 - - - const - int - VarnishLog::TAG_VCL_call - 37 - - - const - int - VarnishLog::TAG_VCL_trace - 38 - - - const - int - VarnishLog::TAG_VCL_return - 39 - - - const - int - VarnishLog::TAG_VCL_error - 40 - - - const - int - VarnishLog::TAG_ReqStart - 41 - - - const - int - VarnishLog::TAG_Hit - 42 - - - const - int - VarnishLog::TAG_HitPass - 43 - - - const - int - VarnishLog::TAG_ExpBan - 44 - - - const - int - VarnishLog::TAG_ExpKill - 45 - - - const - int - VarnishLog::TAG_WorkThread - 46 - - - const - int - VarnishLog::TAG_ESI_xmlerror - 47 - - - const - int - VarnishLog::TAG_Hash - 48 - - - const - int - VarnishLog::TAG_Backend_health - 49 - - - const - int - VarnishLog::TAG_VCL_Log - 50 - - - const - int - VarnishLog::TAG_Gzip - 51 - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - VarnishLog::TAG_Debug - - - - - - - VarnishLog::TAG_Error - - - - - - - VarnishLog::TAG_CLI - - - - - - - VarnishLog::TAG_StatSess - - - - - - - VarnishLog::TAG_ReqEnd - - - - - - - VarnishLog::TAG_SessionOpen - - - - - - - VarnishLog::TAG_SessionClose - - - - - - - VarnishLog::TAG_BackendOpen - - - - - - - VarnishLog::TAG_BackendXID - - - - - - - VarnishLog::TAG_BackendReuse - - - - - - - VarnishLog::TAG_BackendClose - - - - - - - VarnishLog::TAG_HttpGarbage - - - - - - - VarnishLog::TAG_Backend - - - - - - - VarnishLog::TAG_Length - - - - - - - VarnishLog::TAG_FetchError - - - - - - - VarnishLog::TAG_RxRequest - - - - - - - VarnishLog::TAG_RxResponse - - - - - - - VarnishLog::TAG_RxStatus - - - - - - - VarnishLog::TAG_RxURL - - - - - - - VarnishLog::TAG_RxProtocol - - - - - - - VarnishLog::TAG_RxHeader - - - - - - - VarnishLog::TAG_TxRequest - - - - - - - VarnishLog::TAG_TxResponse - - - - - - - VarnishLog::TAG_TxStatus - - - - - - - VarnishLog::TAG_TxURL - - - - - - - VarnishLog::TAG_TxProtocol - - - - - - - VarnishLog::TAG_TxHeader - - - - - - - VarnishLog::TAG_ObjRequest - - - - - - - VarnishLog::TAG_ObjResponse - - - - - - - VarnishLog::TAG_ObjStatus - - - - - - - VarnishLog::TAG_ObjURL - - - - - - - VarnishLog::TAG_ObjProtocol - - - - - - - VarnishLog::TAG_ObjHeader - - - - - - - VarnishLog::TAG_LostHeader - - - - - - - VarnishLog::TAG_TTL - - - - - - - VarnishLog::TAG_Fetch_Body - - - - - - - VarnishLog::TAG_VCL_acl - - - - - - - VarnishLog::TAG_VCL_call - - - - - - - VarnishLog::TAG_VCL_trace - - - - - - - VarnishLog::TAG_VCL_return - - - - - - - VarnishLog::TAG_VCL_error - - - - - - - VarnishLog::TAG_ReqStart - - - - - - - VarnishLog::TAG_Hit - - - - - - - VarnishLog::TAG_HitPass - - - - - - - VarnishLog::TAG_ExpBan - - - - - - - VarnishLog::TAG_ExpKill - - - - - - - VarnishLog::TAG_WorkThread - - - - - - - VarnishLog::TAG_ESI_xmlerror - - - - - - - VarnishLog::TAG_Hash - - - - - - - VarnishLog::TAG_Backend_health - - - - - - - VarnishLog::TAG_VCL_Log - - - - - - - VarnishLog::TAG_Gzip - - - - - - -
    - - - -
    - - &reference.varnish.entities.varnishlog; - -
    - - diff --git a/reference/varnish/varnishlog/construct.xml b/reference/varnish/varnishlog/construct.xml deleted file mode 100644 index dd03cc1ab835..000000000000 --- a/reference/varnish/varnishlog/construct.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - VarnishLog::__construct - Varnishlog constructor - - - - &reftitle.description; - - public VarnishLog::__construct - arrayargs - - - - - - - - &reftitle.parameters; - - - args - - - Configuration arguments. The possible keys are: - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/varnish/varnishlog/getline.xml b/reference/varnish/varnishlog/getline.xml deleted file mode 100644 index 34c26da027f4..000000000000 --- a/reference/varnish/varnishlog/getline.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - VarnishLog::getLine - Get next log line - - - - &reftitle.description; - - public arrayVarnishLog::getLine - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an array with the log line data. - - - - - - - diff --git a/reference/varnish/varnishlog/gettagname.xml b/reference/varnish/varnishlog/gettagname.xml deleted file mode 100644 index 6a7e351c9d93..000000000000 --- a/reference/varnish/varnishlog/gettagname.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - VarnishLog::getTagName - Get the log tag string representation by its index - - - - &reftitle.description; - - public static stringVarnishLog::getTagName - intindex - - - - - - - - &reftitle.parameters; - - - - index - - - Log tag index. - - - - - - - - - &reftitle.returnvalues; - - Returns the log tag name as &string;. - - - - - - - diff --git a/reference/varnish/varnishstat.xml b/reference/varnish/varnishstat.xml deleted file mode 100644 index d6ce39da076b..000000000000 --- a/reference/varnish/varnishstat.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - The VarnishStat class - VarnishStat - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - VarnishStat - - - - - VarnishStat - - - - - &Methods; - - - - -
    - -
    - - &reference.varnish.entities.varnishstat; - -
    - - diff --git a/reference/varnish/varnishstat/construct.xml b/reference/varnish/varnishstat/construct.xml deleted file mode 100644 index a350dab9b819..000000000000 --- a/reference/varnish/varnishstat/construct.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - VarnishStat::__construct - VarnishStat constructor - - - - &reftitle.description; - - public VarnishStat::__construct - arrayargs - - - - - - - - &reftitle.parameters; - - - args - - - Configuration arguments. The possible keys are: - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/varnish/varnishstat/getsnapshot.xml b/reference/varnish/varnishstat/getsnapshot.xml deleted file mode 100644 index 34bd7028de06..000000000000 --- a/reference/varnish/varnishstat/getsnapshot.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - VarnishStat::getSnapshot - Get the current varnish instance statistics snapshot - - - - &reftitle.description; - - public arrayVarnishStat::getSnapshot - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Array with the varnish statistic snapshot. The array keys are identical to - that in the varnishstat tool. - - - - - - - diff --git a/reference/varnish/versions.xml b/reference/varnish/versions.xml deleted file mode 100644 index 5d930004ca77..000000000000 --- a/reference/varnish/versions.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/wddx/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/wddx/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/wddx/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/wddx/book.xml b/reference/wddx/book.xml deleted file mode 100644 index a28344adfaab..000000000000 --- a/reference/wddx/book.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - WDDX - - - - &reftitle.intro; - - - This extension is DEPRECATED and UNBUNDLED as of PHP 7.4.0. - - - - These functions are intended for work with WDDX. - - - - Do not pass untrusted user input to wddx_deserialize. - 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. Use a safe, standard data interchange format such as JSON (via - json_decode and json_encode) if - you need to pass serialized data to the user. - - - - - - &reference.wddx.setup; - &reference.wddx.examples; - &reference.wddx.reference; - - - - diff --git a/reference/wddx/configure.xml b/reference/wddx/configure.xml deleted file mode 100644 index 8e8a0648f398..000000000000 --- a/reference/wddx/configure.xml +++ /dev/null @@ -1,48 +0,0 @@ - - -
    - &reftitle.install; - -
    - PHP 7.4 - - &pecl.moved-ver;7.4.0 - - - &pecl.info; - &url.pecl.package;wddx. - -
    - -
    - PHP < 7.4 - - After installing the required expat library, compile PHP with - , and use - for expat. - - &windows.builtin; -
    -
    - - - diff --git a/reference/wddx/examples.xml b/reference/wddx/examples.xml deleted file mode 100644 index 8a595728ad10..000000000000 --- a/reference/wddx/examples.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - &reftitle.examples; -
    - wddx examples - - All the functions that serialize variables use the first - element of an array to determine whether the array is to be - serialized into an array or structure. If the first element has - string key, then it is serialized into a structure, otherwise, - into an array. - - - - Serializing a single value with WDDX - - -]]> - - - This example will produce: - - -
    -PHP to WDDX packet example -]]> - - - - - Using incremental packets with WDDX - - -]]> - - - This example will produce: - - -
    -3.1415926 -AustinNovato -Seattle -]]> - - - - - - Strings should be encoded in UTF-8; to handle other encodings, convert - the string first using mb_convert_encoding, - UConverter::transcode, or iconv. - - -
    -
    - - - diff --git a/reference/wddx/functions/wddx-add-vars.xml b/reference/wddx/functions/wddx-add-vars.xml deleted file mode 100644 index 6e935507b9a5..000000000000 --- a/reference/wddx/functions/wddx-add-vars.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - wddx_add_vars - Add variables to a WDDX packet with the specified ID - - - - &warn.removed.function-7-4-0; - - - - &reftitle.description; - - boolwddx_add_vars - resourcepacket_id - mixedvar_name - mixedvar_names - - - Serializes the passed variables and add the result to the given packet. - - - - - &reftitle.parameters; - - This function takes a variable number of parameters. - - - packet_id - - - A WDDX packet, returned by wddx_packet_start. - - - - - var_name - - - Can be either a string naming a variable or an array containing - strings naming the variables or another array, etc. - - - - - var_names - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/wddx/functions/wddx-deserialize.xml b/reference/wddx/functions/wddx-deserialize.xml deleted file mode 100644 index 79b516f4cb6a..000000000000 --- a/reference/wddx/functions/wddx-deserialize.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - wddx_deserialize - Unserializes a WDDX packet - - - - &warn.removed.function-7-4-0; - - - - &reftitle.description; - - mixedwddx_deserialize - stringpacket - - - Unserializes a WDDX packet. - - - - Do not pass untrusted user input to wddx_deserialize. - 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. Use a safe, standard data interchange format such as JSON (via - json_decode and json_encode) if - you need to pass serialized data to the user. - - - - - - &reftitle.parameters; - - - - packet - - - A WDDX packet, as a string or stream. - - - - - - - - - &reftitle.returnvalues; - - Returns the deserialized value which can be a string, a number or an - array. Note that structures are deserialized into associative arrays. - - - - - - diff --git a/reference/wddx/functions/wddx-packet-end.xml b/reference/wddx/functions/wddx-packet-end.xml deleted file mode 100644 index 6b82bde966e2..000000000000 --- a/reference/wddx/functions/wddx-packet-end.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - wddx_packet_end - Ends a WDDX packet with the specified ID - - - - &warn.removed.function-7-4-0; - - - - &reftitle.description; - - stringwddx_packet_end - resourcepacket_id - - - Ends and returns the given WDDX packet. - - - - - &reftitle.parameters; - - - - packet_id - - - A WDDX packet, returned by wddx_packet_start. - - - - - - - - - &reftitle.returnvalues; - - Returns the string containing the WDDX packet. - - - - - diff --git a/reference/wddx/functions/wddx-packet-start.xml b/reference/wddx/functions/wddx-packet-start.xml deleted file mode 100644 index d79b2df426fe..000000000000 --- a/reference/wddx/functions/wddx-packet-start.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - wddx_packet_start - Starts a new WDDX packet with structure inside it - - - - &warn.removed.function-7-4-0; - - - - &reftitle.description; - - resourcewddx_packet_start - stringcomment - - - Start a new WDDX packet for incremental addition of variables. - It automatically creates a structure definition inside the packet to - contain the variables. - - - - - &reftitle.parameters; - - - - comment - - - An optional comment string. - - - - - - - - - &reftitle.returnvalues; - - Returns a packet ID for use in later functions, or &false; on error. - - - - - diff --git a/reference/wddx/functions/wddx-serialize-value.xml b/reference/wddx/functions/wddx-serialize-value.xml deleted file mode 100644 index 9162ef7f2055..000000000000 --- a/reference/wddx/functions/wddx-serialize-value.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - wddx_serialize_value - Serialize a single value into a WDDX packet - - - - &warn.removed.function-7-4-0; - - - - &reftitle.description; - - stringwddx_serialize_value - mixedvar - stringcomment - - - Creates a WDDX packet from a single given value. - - - - - &reftitle.parameters; - - - - var - - - The value to be serialized - - - - - comment - - - An optional comment string that appears in the packet header. - - - - - - - - - &reftitle.returnvalues; - - Returns the WDDX packet, or &false; on error. - - - - - diff --git a/reference/wddx/functions/wddx-serialize-vars.xml b/reference/wddx/functions/wddx-serialize-vars.xml deleted file mode 100644 index fb5d2d90cbe4..000000000000 --- a/reference/wddx/functions/wddx-serialize-vars.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - wddx_serialize_vars - Serialize variables into a WDDX packet - - - - &warn.removed.function-7-4-0; - - - - &reftitle.description; - - stringwddx_serialize_vars - mixedvar_name - mixedvar_names - - - Creates a WDDX packet with a structure that contains the serialized - representation of the passed variables. - - - - - &reftitle.parameters; - - This function takes a variable number of parameters. - - - var_name - - - Can be either a string naming a variable or an array containing - strings naming the variables or another array, etc. - - - - - var_names - - - - - - - - - - - &reftitle.returnvalues; - - Returns the WDDX packet, or &false; on error. - - - - - &reftitle.examples; - - - <function>wddx_serialize_vars</function> example - - -]]> - - &example.outputs; - -
    1 -5.5 -blueorangeviolet -colors -]]> - - - - - - - diff --git a/reference/wddx/reference.xml b/reference/wddx/reference.xml deleted file mode 100644 index 88a4b2172ac4..000000000000 --- a/reference/wddx/reference.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - WDDX &Functions; - - &reference.wddx.entities.functions; - - - - - diff --git a/reference/wddx/setup.xml b/reference/wddx/setup.xml deleted file mode 100644 index 1362f52cae1b..000000000000 --- a/reference/wddx/setup.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - &reftitle.setup; - - -
    - &reftitle.required; - &libxml.required; - - In order to use WDDX, you will need to install the expat library - (which comes with Apache 1.3.7 or higher). - -
    - - - - &reference.wddx.configure; - - - -
    - &reftitle.resources; - - This extension defines a WDDX packet identifier returned by - wddx_packet_start. - -
    - - -
    - - - diff --git a/reference/wddx/versions.xml b/reference/wddx/versions.xml deleted file mode 100644 index 9aa08773f3c5..000000000000 --- a/reference/wddx/versions.xml +++ /dev/null @@ -1,33 +0,0 @@ - - - - - - - - - - - - - - diff --git a/reference/win32service/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/win32service/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/win32service/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/win32service/book.xml b/reference/win32service/book.xml deleted file mode 100644 index 6037111edc0b..000000000000 --- a/reference/win32service/book.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - win32service - - - - &reftitle.intro; - - The win32service extension is a Windows specific extension that allows PHP - to communicate with the Service Control Manager to start, stop, register - and unregister services, and even allows your PHP scripts to run as a - service. - - - - - &reference.win32service.setup; - &reference.win32service.constants; - &reference.win32service.win32serviceexception; - &reference.win32service.win32servicerightinfo; - &reference.win32service.examples; - &reference.win32service.reference; - - - - - diff --git a/reference/win32service/constants.xml b/reference/win32service/constants.xml deleted file mode 100644 index 7748b04af8c4..000000000000 --- a/reference/win32service/constants.xml +++ /dev/null @@ -1,1153 +0,0 @@ - - - - &reftitle.constants; - &extension.constants; - - - Win32Service Service Type Bitmasks - - - - Constant - Value - Description - - - - - WIN32_SERVICE_WIN32_OWN_PROCESS - 0x00000010 - - The service runs in its own process. - - - - WIN32_SERVICE_INTERACTIVE_PROCESS - 0x00000100 - - The service can interact with the desktop. This option is not available on Windows Vista or later. - - - - WIN32_SERVICE_WIN32_OWN_PROCESS_INTERACTIVE - 0x00000110 - - The service runs in its own process and can interact with the desktop. This option is not available on Windows Vista or later. - - - - -
    - - - Win32Service Service Status Constants - - - - Constant - Value - Description - - - - - WIN32_SERVICE_CONTINUE_PENDING - 0x00000005 - - The service continue is pending. - - - - WIN32_SERVICE_PAUSE_PENDING - 0x00000006 - - The service pause is pending. - - - - WIN32_SERVICE_PAUSED - 0x00000007 - - The service is paused. - - - - WIN32_SERVICE_RUNNING - 0x00000004 - - The service is running. - - - - WIN32_SERVICE_START_PENDING - 0x00000002 - - The service is starting. - - - - WIN32_SERVICE_STOP_PENDING - 0x00000003 - - The service is stopping. - - - - WIN32_SERVICE_STOPPED - 0x00000001 - - The service is not running. - - - - -
    - - - Win32Service Service Control Message Constants - - - - Constant - Value - Description - - - - - WIN32_SERVICE_CONTROL_CONTINUE - 0x00000003 - - Notifies a paused service that it should resume. - - - - WIN32_SERVICE_CONTROL_DEVICEEVENT - 0x0000000B - - - - - WIN32_SERVICE_CONTROL_HARDWAREPROFILECHANGE - 0x0000000C - - - - - WIN32_SERVICE_CONTROL_INTERROGATE - 0x00000004 - - Notifies a service that it should report its current status information - to the service control manager. - - - - WIN32_SERVICE_CONTROL_NETBINDADD - 0x00000007 - - Notifies a network service that there is a new component for binding. - - - - WIN32_SERVICE_CONTROL_NETBINDDISABLE - 0x0000000A - - Notifies a network service that one of its bindings has been disabled. - - - - WIN32_SERVICE_CONTROL_NETBINDENABLE - 0x00000009 - - Notifies a network service that a disabled binding has been enabled. - - - - WIN32_SERVICE_CONTROL_NETBINDREMOVE - 0x00000008 - - Notifies a network service that a component for binding has been removed. - - - - WIN32_SERVICE_CONTROL_PARAMCHANGE - 0x00000006 - - Notifies a service that its startup parameters have changed. - - - - WIN32_SERVICE_CONTROL_PAUSE - 0x00000002 - - Notifies a service that it should pause. - - - - WIN32_SERVICE_CONTROL_POWEREVENT - 0x0000000D - - - - - WIN32_SERVICE_CONTROL_PRESHUTDOWN - 0x0000000F - - Notifies a service that the system will be shutting down. A service that - handles this notification blocks system shutdown until the service stops - or the preshutdown time-out interval expires. This value is not supported - by Windows Server 2003 and Windows XP/2000. - - - - WIN32_SERVICE_CONTROL_SESSIONCHANGE - 0x0000000E - - - - - WIN32_SERVICE_CONTROL_SHUTDOWN - 0x00000005 - - Notifies a service that the system is shutting down so the service can - perform cleanup tasks. If a service accepts this control code, it must - stop after it performs its cleanup tasks. After the SCM sends this - control code, it will not send other control codes to the service. - - - - WIN32_SERVICE_CONTROL_STOP - 0x00000001 - - Notifies a service that it should stop. - - - - -
    - - - Win32Service Service Control Message Accepted Bitmasks - - - - Constant - Value - Description - - - - - WIN32_SERVICE_ACCEPT_HARDWAREPROFILECHANGE - 0x00000020 - - The service is notified when the computer's hardware profile has changed. - This enables the system to send - WIN32_SERVICE_CONTROL_HARDWAREPROFILECHANGE - notifications to the service. - - - - WIN32_SERVICE_ACCEPT_NETBINDCHANGE - 0x00000010 - - The service is a network component that can accept changes in its - binding without being stopped and restarted. - This control code allows the service to receive - WIN32_SERVICE_CONTROL_NETBINDADD, - WIN32_SERVICE_CONTROL_NETBINDREMOVE, - WIN32_SERVICE_CONTROL_NETBINDENABLE, and - WIN32_SERVICE_CONTROL_NETBINDDISABLE notifications. - - - - WIN32_SERVICE_ACCEPT_PARAMCHANGE - 0x00000008 - - The service can reread its startup parameters without being stopped and restarted. - This control code allows the service to receive - WIN32_SERVICE_CONTROL_PARAMCHANGE notifications. - - - - WIN32_SERVICE_ACCEPT_PAUSE_CONTINUE - 0x00000002 - - The service can be paused and continued. This control code allows the - service to receive WIN32_SERVICE_CONTROL_PAUSE and - WIN32_SERVICE_CONTROL_CONTINUE notifications. - - - - WIN32_SERVICE_ACCEPT_POWEREVENT - 0x00000040 - - The service is notified when the computer's power status has changed. - This enables the system to send - WIN32_SERVICE_CONTROL_POWEREVENT notifications - to the service. - - - - WIN32_SERVICE_ACCEPT_PRESHUTDOWN - 0x00000100 - - The service can perform preshutdown tasks. This control code enables the - service to receive WIN32_SERVICE_CONTROL_PRESHUTDOWN - notifications. This value is not supported by Windows Server 2003 and - Windows XP/2000. - - - - WIN32_SERVICE_ACCEPT_SESSIONCHANGE - 0x00000080 - - The service is notified when the computer's session status has changed. - This enables the system to send - WIN32_SERVICE_CONTROL_SESSIONCHANGE notifications - to the service. - Windows 2000: This value is not supported - - - - WIN32_SERVICE_ACCEPT_SHUTDOWN - 0x00000004 - - The service is notified when system shutdown occurs. This control code - allows the service to receive WIN32_SERVICE_CONTROL_SHUTDOWN - notifications. - - - - WIN32_SERVICE_ACCEPT_STOP - 0x00000001 - - The service can be stopped. This control code allows the service to - receive WIN32_SERVICE_CONTROL_STOP notifications. - - - - WIN32_SERVICE_ACCEPT_TIMECHANGE - 0x00000200 - - The service is notified when the system time has changed. - This enables the system to send - WIN32_SERVICE_CONTROL_TIMECHANGE notifications to the service. - Windows Server 2008, Windows Vista, Windows Server 2003, - and Windows XP/2000: This control code is not supported. - - - - WIN32_SERVICE_ACCEPT_TRIGGEREVENT - 0x00000400 - - The service is notified when an event for which the service has registered occurs. - This enables the system to send - WIN32_SERVICE_CONTROL_TRIGGEREVENT notifications to the service. - Windows Server 2008, Windows Vista, Windows Server 2003, - and Windows XP/2000: This control code is not supported. - - - - -
    - - - Win32Service Service Start Type Constants - - - - Constant - Value - Description - - - - - WIN32_SERVICE_BOOT_START - 0x00000000 - - A device driver started by the system loader. This value is valid only for driver services. - - - - WIN32_SERVICE_SYSTEM_START - 0x00000001 - - A device driver started by the IoInitSystem function. This value is valid only for driver services. - - - - WIN32_SERVICE_AUTO_START - 0x00000002 - - A service started automatically by the service control manager during - system startup. - - - - WIN32_SERVICE_DEMAND_START - 0x00000003 - - A service started by the service control manager when a process calls the - StartService function. - - - - WIN32_SERVICE_DISABLED - 0x00000004 - - A service that cannot be started. Attempts to start the service result in - the error code WIN32_ERROR_SERVICE_DISABLED. - - - - -
    - - - Win32Service Service Error Control Constants - - - - Constant - Value - Description - - - - - WIN32_SERVICE_ERROR_IGNORE - 0x00000000 - - The startup program ignores the error and continues the startup operation. - - - - WIN32_SERVICE_ERROR_NORMAL - 0x00000001 - - The startup program logs the error in the event log but continues the - startup operation. - - - - WIN32_SERVICE_ERROR_SEVERE - 0x00000002 - - The startup program logs the error in the event log. - If the last-known-good configuration is being started, the startup - operation continues. Otherwise, the system is restarted with the - last-known-good configuration. - - - - WIN32_SERVICE_ERROR_CRITICAL - 0x00000003 - - The startup program logs the error in the event log, if possible. - If the last-known-good configuration is being started, the startup - operation fails. Otherwise, the system is restarted with the - last-known good configuration. - - - - -
    - - - Win32Service Service Flag Constants - - - - Constant - Value - Description - - - - - WIN32_SERVICE_RUNS_IN_SYSTEM_PROCESS - 0x00000001 - - The service runs in a system process that must always be running. - - - - -
    - - - - These constants are no longer in use as of Win32Service 1.0.0. - - - - Win32 Error Codes - - - - Constant - Value - Description - - - - - WIN32_ERROR_ACCESS_DENIED - 0x00000005 - - The handle to the SCM database does not have the appropriate access rights. - - - - WIN32_ERROR_CIRCULAR_DEPENDENCY - 0x00000423 - - A circular service dependency was specified. - - - - WIN32_ERROR_DATABASE_DOES_NOT_EXIST - 0x00000429 - - The specified database does not exist. - - - - WIN32_ERROR_DEPENDENT_SERVICES_RUNNING - 0x0000041B - - The service cannot be stopped because other running services are dependent - on it. - - - - WIN32_ERROR_DUPLICATE_SERVICE_NAME - 0x00000436 - - The display name already exists in the service control manager database - either as a service name or as another display name. - - - - WIN32_ERROR_FAILED_SERVICE_CONTROLLER_CONNECT - 0x00000427 - - This error is returned if the program is being run as a console application - rather than as a service. If the program will be run as a console application - for debugging purposes, structure it such that service-specific code is not - called. - - - - WIN32_ERROR_INSUFFICIENT_BUFFER - 0x0000007A - - The buffer is too small for the service status structure. Nothing was - written to the structure. - - - - WIN32_ERROR_INVALID_DATA - 0x0000000D - - The specified service status structure is invalid. - - - - WIN32_ERROR_INVALID_HANDLE - 0x00000006 - - The handle to the specified service control manager database is invalid. - - - - WIN32_ERROR_INVALID_LEVEL - 0x0000007C - - The InfoLevel parameter contains an unsupported value. - - - - WIN32_ERROR_INVALID_NAME - 0x0000007B - - The specified service name is invalid. - - - - WIN32_ERROR_INVALID_PARAMETER - 0x00000057 - - A parameter that was specified is invalid. - - - - WIN32_ERROR_INVALID_SERVICE_ACCOUNT - 0x00000421 - - The user account name specified in the user - parameter does not exist. See win32_create_service. - - - - WIN32_ERROR_INVALID_SERVICE_CONTROL - 0x0000041C - - The requested control code is not valid, or it is unacceptable to the service. - - - - WIN32_ERROR_PATH_NOT_FOUND - 0x00000003 - - The service binary file could not be found. - - - - WIN32_ERROR_SERVICE_ALREADY_RUNNING - 0x00000420 - - An instance of the service is already running. - - - - WIN32_ERROR_SERVICE_CANNOT_ACCEPT_CTRL - 0x00000425 - - The requested control code cannot be sent to the service because the state - of the service is WIN32_SERVICE_STOPPED, - WIN32_SERVICE_START_PENDING, or - WIN32_SERVICE_STOP_PENDING. - - - - WIN32_ERROR_SERVICE_DATABASE_LOCKED - 0x0000041F - - The database is locked. - - - - WIN32_ERROR_SERVICE_DEPENDENCY_DELETED - 0x00000433 - - The service depends on a service that does not exist or has been marked - for deletion. - - - - WIN32_ERROR_SERVICE_DEPENDENCY_FAIL - 0x0000042C - - The service depends on another service that has failed to start. - - - - WIN32_ERROR_SERVICE_DISABLED - 0x00000422 - - The service has been disabled. - - - - WIN32_ERROR_SERVICE_DOES_NOT_EXIST - 0x00000424 - - The specified service does not exist as an installed service. - - - - WIN32_ERROR_SERVICE_EXISTS - 0x00000431 - - The specified service already exists in this database. - - - - WIN32_ERROR_SERVICE_LOGON_FAILED - 0x0000042D - - The service did not start due to a logon failure. This error occurs if - the service is configured to run under an account that does not have the - "Log on as a service" right. - - - - WIN32_ERROR_SERVICE_MARKED_FOR_DELETE - 0x00000430 - - The specified service has already been marked for deletion. - - - - WIN32_ERROR_SERVICE_NO_THREAD - 0x0000041E - - A thread could not be created for the service. - - - - WIN32_ERROR_SERVICE_NOT_ACTIVE - 0x00000426 - - The service has not been started. - - - - WIN32_ERROR_SERVICE_REQUEST_TIMEOUT - 0x0000041D - - The process for the service was started, but it did not call - StartServiceCtrlDispatcher, or the thread that called - StartServiceCtrlDispatcher may be blocked in a control handler function. - - - - WIN32_ERROR_SHUTDOWN_IN_PROGRESS - 0x0000045B - - The system is shutting down; this function cannot be called. - - - - WIN32_ERROR_SERVICE_SPECIFIC_ERROR - 0x0000042A - - The service has returned a service-specific error code. - - - - WIN32_NO_ERROR - 0x00000000 - - No error. - - - - -
    - - - Win32 Base Priority Classes - - - - Constant - Value - Description - - - - - WIN32_ABOVE_NORMAL_PRIORITY_CLASS - 0x00008000 - - Process that has priority above WIN32_NORMAL_PRIORITY_CLASS but below - WIN32_HIGH_PRIORITY_CLASS. - - - - WIN32_BELOW_NORMAL_PRIORITY_CLASS - 0x00004000 - - Process that has priority above WIN32_IDLE_PRIORITY_CLASS but below - WIN32_NORMAL_PRIORITY_CLASS. - - - - WIN32_HIGH_PRIORITY_CLASS - 0x00000080 - - Process that performs time-critical tasks that must be executed - immediately. The threads of the process preempt the threads of normal or - idle priority class processes. An example is the Task List, which must - respond quickly when called by the user, regardless of the load on the - operating system. Use extreme care when using the high-priority class, - because a high-priority class application can use nearly all available - CPU time. - - - - WIN32_IDLE_PRIORITY_CLASS - 0x00000040 - - Process whose threads run only when the system is idle. The threads of the - process are preempted by the threads of any process running in a higher - priority class. An example is a screen saver. The idle-priority class is - inherited by child processes. - - - - WIN32_NORMAL_PRIORITY_CLASS - 0x00000020 - - Process with no special scheduling needs. - - - - WIN32_REALTIME_PRIORITY_CLASS - 0x00000100 - - Process that has the highest possible priority. The threads of the - process preempt the threads of all other processes, including operating - system processes performing important tasks. For example, a real-time - process that executes for more than a very brief interval can cause disk - caches not to flush or cause the mouse to be unresponsive. - - - - -
    - - - Win32 Recovery action - - - - Constant - Value - Description - - - - - WIN32_SC_ACTION_NONE - 0x00000000 - - No action. - - - - WIN32_SC_ACTION_RESTART - 0x00000001 - - Restart the service. - - - - WIN32_SC_ACTION_REBOOT - 0x00000002 - - Restart the server. - - - - WIN32_SC_ACTION_RUN_COMMAND - 0x00000003 - - Run a command. - - - - -
    - - - Win32 Service informations - - - - Constant - Value - Description - - - - - WIN32_INFO_SERVICE - "service" - - - - - WIN32_INFO_DISPLAY - "display" - - - - - WIN32_INFO_USER - "user" - - - - - WIN32_INFO_PASSWORD - "password" - - - - - WIN32_INFO_PATH - "path" - - - - - WIN32_INFO_PARAMS - "params" - - - - - WIN32_INFO_DESCRIPTION - "description" - - - - - WIN32_INFO_START_TYPE - "start_type" - - - - - WIN32_INFO_LOAD_ORDER - "load_order" - - - - - WIN32_INFO_SVC_TYPE - "svc_type" - - - - - WIN32_INFO_ERROR_CONTROL - "error_control" - - - - - WIN32_INFO_DELAYED_START - "delayed_start" - - - - - WIN32_INFO_BASE_PRIORITY - "base_priority" - - - - - WIN32_INFO_DEPENDENCIES - "dependencies" - - - - - WIN32_INFO_RECOVERY_DELAY - "recovery_delay" - - - - - WIN32_INFO_RECOVERY_ACTION_1 - "recovery_action_1" - - - - - WIN32_INFO_RECOVERY_ACTION_2 - "recovery_action_2" - - - - - WIN32_INFO_RECOVERY_ACTION_3 - "recovery_action_3" - - - - - WIN32_INFO_RECOVERY_RESET_PERIOD - "recovery_reset_period" - - - - - WIN32_INFO_RECOVERY_ENABLED - "recovery_enabled" - - - - - WIN32_INFO_RECOVERY_REBOOT_MSG - "recovery_reboot_msg" - - - - - WIN32_INFO_RECOVERY_COMMAND - "recovery_command" - - - - - -
    - - - Win32 Service rights - - - - Constant - Value - Description - - - - - WIN32_SERVICE_ALL_ACCESS - 0x000F003F - - - - - WIN32_SERVICE_CHANGE_CONFIG - 0x00000002 - - - - - WIN32_SERVICE_ENUMERATE_DEPENDENTS - 0x00000008 - - - - - WIN32_SERVICE_INTERROGATE - 0x00000080 - - - - - WIN32_SERVICE_PAUSE_CONTINUE - 0x00000040 - - - - - WIN32_SERVICE_QUERY_CONFIG - 0x00000001 - - - - - WIN32_SERVICE_QUERY_STATUS - 0x00000004 - - - - - WIN32_SERVICE_START - 0x00000010 - - - - - WIN32_SERVICE_STOP - 0x00000020 - - - - - WIN32_SERVICE_USER_DEFINED_CONTROL - 0x00000100 - - - - - WIN32_ACCESS_SYSTEM_SECURITY - 0x00001000 - - - - - WIN32_DELETE - 0x00010000 - - - - - WIN32_READ_CONTROL - 0x00020000 - - - - - WIN32_WRITE_DAC - 0x00040000 - - - - - WIN32_WRITE_OWNER - 0x00080000 - - - - - WIN32_GENERIC_READ - Include rights: - WIN32_STANDARD_RIGHTS_READ, - WIN32_SERVICE_QUERY_CONFIG, - WIN32_SERVICE_QUERY_STATUS, - WIN32_SERVICE_INTERROGATE, - WIN32_SERVICE_ENUMERATE_DEPENDENTS - - - - - - WIN32_GENERIC_WRITE - Include rights: - WIN32_STANDARD_RIGHTS_WRITE, - WIN32_SERVICE_CHANGE_CONFIG - - - - - - WIN32_GENERIC_EXECUTE - Include rights: - WIN32_STANDARD_RIGHTS_EXECUTE, - WIN32_SERVICE_START, - WIN32_SERVICE_STOP, - WIN32_SERVICE_PAUSE_CONTINUE, - WIN32_SERVICE_USER_DEFINED_CONTROL - - - - - - -
    -
    - - diff --git a/reference/win32service/examples.xml b/reference/win32service/examples.xml deleted file mode 100644 index c50c8502a121..000000000000 --- a/reference/win32service/examples.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - &reftitle.examples; - - - Registering a PHP script to run as a service - - 'dummyphp', # the name of your service - 'display' => 'sample dummy PHP service', # short description - 'description' => 'This is a dummy Windows service created using PHP.', # long description - 'params' => '"' . __FILE__ . '" run', # path to the script and parameters -)); -?> -]]> - - - - - - Unregistering a service - - -]]> - - - - - - Running as a service - - -]]> - - - - - - - diff --git a/reference/win32service/functions/win32-add-right-access-service.xml b/reference/win32service/functions/win32-add-right-access-service.xml deleted file mode 100644 index e84d0afc7b66..000000000000 --- a/reference/win32service/functions/win32-add-right-access-service.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - win32_add_right_access_service - Add rights access for an username to the service - - - - &reftitle.description; - - voidwin32_add_right_access_service - stringservicename - stringusername - intright - stringmachine&null; - - - Add the rights access for username on servicename - service. Administrative privileges are required for this to succeed. - - - - - &reftitle.parameters; - - - - servicename - - - The service name to add rights access. - - - - - username - - - Read the rights access for username. - - - - - right - - - The rights allowed for username. - The service rights constants can be used to define this value. - - - - - machine - - - The optional machine name on which you want to create a service. - If omitted, it will use the local machine. - - - - - - - - - &reftitle.returnvalues; - - Return a Win32Service\RightInfo object. - - - - - &reftitle.errors; - - A ValueError is thrown if the - value of service parameter is empty. - - - A ValueError is thrown if the - value of username parameter is empty. - - - A Win32ServiceException is thrown on error. - - - - - &reftitle.seealso; - - - win32_read_all_rights_access_service - win32_read_rights_access_service - win32_remove_right_access_service - Win32 Rights constants - - - - - - - diff --git a/reference/win32service/functions/win32-add-service-env-var.xml b/reference/win32service/functions/win32-add-service-env-var.xml deleted file mode 100644 index 7e74e366a610..000000000000 --- a/reference/win32service/functions/win32-add-service-env-var.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - win32_add_service_env_var - Add a custom environment variables on service - - - - &reftitle.description; - - voidwin32_add_service_env_var - stringservicename - stringvarname - stringvalue - - - Add a custom environment variables varname on servicename - service. This function work only for the local computer. Administrative privileges are required for this to succeed. - - - - - &reftitle.parameters; - - - - servicename - - - The service name to add environment variable. - - - - - varname - - - The environment variable name. - - - - - value - - - The environment variable value. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - A ValueError is thrown if the - value of service parameter is empty. - - - A ValueError is thrown if the - value of varname parameter is empty. - - - A Win32ServiceException is thrown on error. - - - - - &reftitle.seealso; - - - win32_get_service_env_vars - win32_remove_service_env_var - - - - - - - diff --git a/reference/win32service/functions/win32-continue-service.xml b/reference/win32service/functions/win32-continue-service.xml deleted file mode 100644 index 1cbe70a502ee..000000000000 --- a/reference/win32service/functions/win32-continue-service.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - win32_continue_service - Resumes a paused service - - - &reftitle.description; - - voidwin32_continue_service - stringservicename - stringmachine&null; - - - - Resumes a paused, named service. Requires administrative privileges or - an account with appropriate rights set in the service's ACL. - - - - - &reftitle.parameters; - - - - servicename - - - The short name of the service. - - - - - machine - - - Optional machine name. If omitted, the local machine is used. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - Prior to version 1.0.0, &win32service.noerror.false.error; - - - - - &reftitle.errors; - - A ValueError is thrown if the - value of servicename parameter is empty. - - - A Win32ServiceException is thrown on error. - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL win32service 1.0.0 - - Throws a ValueError on invalid data in parameters, - previously &false; was returned. - - - - PECL win32service 1.0.0 - - Throws a Win32ServiceException on error, - previously a - Win32 Error Code - was returned. - - - - PECL win32service 1.0.0 - - The return type is now void, previously it was mixed. - - - - PECL win32service 0.3.0 - - This function does not longer require an administrator account if ACL is set for another account. - - - - - - - - - - &reftitle.seealso; - - - win32_start_service - win32_stop_service - win32_pause_service - win32_send_custom_control - Win32 Error Codes - - - - - - - diff --git a/reference/win32service/functions/win32-create-service.xml b/reference/win32service/functions/win32-create-service.xml deleted file mode 100644 index 8b0af1524520..000000000000 --- a/reference/win32service/functions/win32-create-service.xml +++ /dev/null @@ -1,517 +0,0 @@ - - - - - - win32_create_service - Creates a new service entry in the SCM database - - - - &reftitle.description; - - voidwin32_create_service - arraydetails - stringmachine&null; - - - Attempts to add a service into the SCM database. Administrative - privileges are required for this to succeed. - - - - - &reftitle.parameters; - - - - details - - - An array of service details: - - - service - - - The short name of the service. This is the name that you - will use to control the service using the net - command. The service must be unique (no two services can share the - same name), and, ideally, should avoid having spaces in the name. - - - - - display - - The display name of the service. This is the name that you - will see in the Services Applet. - - - - - description - - The long description of the service. This is the description - that you will see in the Services Applet. - - - - - user - - - The name of the user account under which you want the service to - run. If omitted, the service will run as the LocalSystem account. - If the username is specified, you must also provide a password. - - - - - password - - - The password that corresponds to the user. - - - - - path - - - The full path to the executable module that will be launched when - the service is started. If omitted, the path to the current PHP - process will be used. - - - - - params - - - Command line parameters to pass to the service when it starts. - If you want to run a PHP script as the service, then the first - parameter should be the full path to the PHP script that you intend - to run. If the script name or path contains spaces, then wrap the - full path to the PHP script with ". - - - - - load_order - - - Controls the load_order. This is not yet fully supported. - - - - - svc_type - - - Sets the service type. If omitted, the default value is - WIN32_SERVICE_WIN32_OWN_PROCESS. - Don't change this unless you know what you're doing. - - - - - start_type - - - Specifies how the service should be started. The default is - WIN32_SERVICE_AUTO_START which means the - service will be launched when the machine starts up. - - - - - error_control - - - Informs the SCM what it should do when it detects a problem with - the service. The default is - WIN32_SERVER_ERROR_IGNORE. Changing this - value is not yet fully supported. - - - - - delayed_start - - - If delayed_start is set to &true;, then this - will inform the SCM that this service should be started after other - auto-start services are started plus a short delay. - - - Any service can be marked as a delayed auto-start service; however, - this setting has no effect unless the service's - start_type is - WIN32_SERVICE_AUTO_START. - - - This setting is only applicable on Windows Vista and Windows Server - 2008 or greater. - - - - - base_priority - - - To reduce the impact on processor utilisation, it may be necessary - to set a base priority lower than normal. - - - The base_priority can be set to one of the - constants define in - Win32 Base Priority Classes. - - - - - dependencies - - - To define the dependencies for your service, it may be necessary to set - this parameter to the list of the services names in an array. - - - - - recovery_delay - - - This parameter defines the delay between the fail and the execution - of recovery action. The value is in milliseconds. - - - The default value is 60000. - - - - - recovery_action_1 - - - The action will be executed on first failure. The default value is - WIN32_SC_ACTION_NONE. - - - The recovery_action_1 can be set to one of the - constants defined in - Win32 Recovery action. - - - - - recovery_action_2 - - - The action will be executed on second failure. The default value is - WIN32_SC_ACTION_NONE. - - - The recovery_action_2 can be set to one of the - constants defined in - Win32 Recovery action. - - - - - recovery_action_3 - - - The action will be executed on next failures. The default value is - WIN32_SC_ACTION_NONE. - - - The recovery_action_3 can be set to one of the - constants defined in - Win32 Recovery action. - - - - - recovery_reset_period - - - The failure count will be reset after the delay defined in the parameter. The delay is expirement in seconds. - - - The default value is 86400. - - - - - recovery_enabled - - - Set this parameter at &true; to enable the recovery settings, &false; - to disable. - - - The default value is &false; - - - - - recovery_reboot_msg - - - Set this parameter to define the message saved into the Windows Event - Log before the reboot. Used only if one action is set to - WIN32_SC_ACTION_REBOOT. - - - - - recovery_command - - - Set this parameter to define the command executed when one action is defined on - WIN32_SC_ACTION_RUN_COMMAND. - - - - - - - - - machine - - - The optional machine name on which you want to create a service. - If omitted, it will use the local machine. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - Prior to version 1.0.0, &win32service.noerror.false.error; - - - - - &reftitle.errors; - - A ValueError is thrown if the - value of service parameter is empty. - - - A ValueError is thrown if the - value of path parameter is missing or empty. - - - A ValueError is thrown if the - value of svc_type parameter is wrong. - - - A ValueError is thrown if the - value of start_type parameter is wrong. - - - A ValueError is thrown if the - value of error_control parameter is wrong. - - - A ValueError is thrown if the - value of base_priority parameter is wrong. - - - A ValueError is thrown if the - value of recovery_delay parameter is not between - 0 and PHP_INT_MAX. - - - A ValueError is thrown if the - value of recovery_action_1 parameter is wrong. - - - A ValueError is thrown if the - value of recovery_action_2 parameter is wrong. - - - A ValueError is thrown if the - value of recovery_action_3 parameter is wrong. - - - A ValueError is thrown if the - value of recovery_reset_period parameter is not - between 0 and PHP_INT_MAX. - - - A Win32ServiceException is thrown on error. - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL win32service 1.0.0 - - Throws a ValueError on invalid data in parameters, - previously &false; was returned. - - - - PECL win32service 1.0.0 - - Throws a Win32ServiceException on error, - previously a - Win32 Error Code - was returned. - - - - PECL win32service 1.0.0 - - The return type is now void, previously it was mixed. - - - - PECL win32service 0.4.0 - - The dependencies, recovery_delay, - recovery_action_1, recovery_action_2, - recovery_action_3, recovery_reset_period, - recovery_enabled, recovery_reboot_msg - and recovery_command parameters have been added. - - - - - - - - - - &reftitle.examples; - - - A <function>win32_create_service</function> example - - Create a service with the short name 'dummyphp'. - - - 'dummyphp', // the name of your service - 'display' => 'sample dummy PHP service', // short description - 'description' => 'This is a dummy Windows service created using PHP.', // long description - 'params' => '"' . __FILE__ . '" run', // path to the script and parameters -)); -debug_zval_dump($x); -?> -]]> - - - - - - A <function>win32_create_service</function> example with dependencies - - Create a service with the short name 'dummyphp' and dependencies. - - - 'dummyphp', // the name of your service - 'display' => 'sample dummy PHP service', // short description - 'description' => 'This is a dummy Windows service created using PHP.', // long description - 'params' => '"' . __FILE__ . '" run', // path to the script and parameters - 'dependencies' => array("Netman"), // The list of the dependencies -)); -debug_zval_dump($x); -?> -]]> - - - - - - A <function>win32_create_service</function> example with recovery - - Create a service with the short name 'dummyphp' and recovery settings. - - - 'dummyphp', // the name of your service - 'display' => 'sample dummy PHP service', // short description - 'description' => 'This is a dummy Windows service created using PHP.', // long description - 'params' => '"' . __FILE__ . '" run', // path to the script and parameters - 'recovery_delay' => 120000, // Recovery action is executed after 2 minutes - 'recovery_action_1' => WIN32_SC_ACTION_RESTART, // On first failure, restart the service - 'recovery_action_2' => WIN32_SC_ACTION_RUN_COMMAND, // On second failure, execute the commmand - 'recovery_action_3' => WIN32_SC_ACTION_NONE, // On other failure, do nothing - 'recovery_reset_period' => 86400, // Reset the fail counter after 1 day - 'recovery_enabled' => true, // Enable the recovery parameter - 'recovery_reboot_msg' => null, // Do not define a reboot message, it's not needed here - 'recovery_command' => "c:\clean-service.bat", // When the action is WIN32_SC_ACTION_RUN_COMMAND, execute this command -)); -debug_zval_dump($x); -?> -]]> - - - - - - - &reftitle.seealso; - - - win32_delete_service - Win32 Base Priority Classes - Win32 Recovery action - Win32 Error Codes - - - - - - - diff --git a/reference/win32service/functions/win32-delete-service.xml b/reference/win32service/functions/win32-delete-service.xml deleted file mode 100644 index 380ff42620fd..000000000000 --- a/reference/win32service/functions/win32-delete-service.xml +++ /dev/null @@ -1,167 +0,0 @@ - - - - - - win32_delete_service - Deletes a service entry from the SCM database - - - &reftitle.description; - - voidwin32_delete_service - stringservicename - stringmachine&null; - - - - Attempts to delete a service from the SCM database. Administrative - privileges are required for this to succeed. - - - This function really just marks the service for deletion. If other - processes (such as the Services Applet) are open, then the deletion will be - deferred until those applications are closed. If a service is marked for - deletion, further attempts to delete it will fail, and attempts to create a - new service with that name will also fail. - - - - - - &reftitle.parameters; - - - - servicename - - - The short name of the service. - - - - - machine - - - The optional machine name. If omitted, the local machine will be used. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - Prior to version 1.0.0, &win32service.noerror.false.error; - - - - - &reftitle.errors; - - A ValueError is thrown if the - value of servicename parameter is empty. - - - - A Win32ServiceException is thrown on error. - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL win32service 1.0.0 - - Throws a ValueError on invalid data in parameters, - previously &false; was returned. - - - - PECL win32service 1.0.0 - - Throws a Win32ServiceException on error, - previously a - Win32 Error Code - was returned. - - - - PECL win32service 1.0.0 - - The return type is now void, previously it was mixed. - - - - - - - - - - &reftitle.examples; - - - A <function>win32_delete_service</function> example - - Deletes the dummyphp service. - - - -]]> - - - - - - - &reftitle.seealso; - - - win32_create_service - Win32 Error Codes - - - - - - - diff --git a/reference/win32service/functions/win32-get-last-control-message.xml b/reference/win32service/functions/win32-get-last-control-message.xml deleted file mode 100644 index 473d8945e7b7..000000000000 --- a/reference/win32service/functions/win32-get-last-control-message.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - win32_get_last_control_message - Returns the last control message that was sent to this service - - - &reftitle.description; - - intwin32_get_last_control_message - - - - - Returns the control code that was last sent to this service process. - When running as a service you should periodically check this to determine if - your service needs to stop running. - - - - - Since version 0.2.0, this function work only in "cli" SAPI. On other SAPI - this function is disabled. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a control constant which will be one of the - Win32Service Service Control Message Constants: - WIN32_SERVICE_CONTROL_CONTINUE, - WIN32_SERVICE_CONTROL_DEVICEEVENT, - WIN32_SERVICE_CONTROL_HARDWAREPROFILECHANGE, - WIN32_SERVICE_CONTROL_INTERROGATE, - WIN32_SERVICE_CONTROL_NETBINDADD, - WIN32_SERVICE_CONTROL_NETBINDDISABLE, - WIN32_SERVICE_CONTROL_NETBINDENABLE, - WIN32_SERVICE_CONTROL_NETBINDREMOVE, - WIN32_SERVICE_CONTROL_PARAMCHANGE, - WIN32_SERVICE_CONTROL_PAUSE, - WIN32_SERVICE_CONTROL_POWEREVENT, - WIN32_SERVICE_CONTROL_PRESHUTDOWN, - WIN32_SERVICE_CONTROL_SESSIONCHANGE, - WIN32_SERVICE_CONTROL_SHUTDOWN, - WIN32_SERVICE_CONTROL_STOP. - - - If the value is between 128 and 255, the control code is custom. - - - - - &reftitle.errors; - - Prior to version 1.0.0, if the SAPI is not "cli", this function emits an -E_ERROR level error. - - - As of version 1.0.0, will throw a - Win32ServiceException if SAPI is not - "cli" - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL win32service 1.0.0 - - Throws a ValueError on invalid data in parameters, - previously &false; was returned. - - - - PECL win32service 1.0.0 - - Throws a Win32ServiceException on error, - previously a - Win32 Error Code - was returned. - - - - PECL win32service 0.2.0 - - This function works only in the "cli" SAPI. - - - - - - - - - - &reftitle.seealso; - - - win32_start_service_ctrl_dispatcher - win32_set_service_status - win32_set_service_exit_mode - win32_set_service_exit_code - Win32Service Service Control Message Constants - - - - - - - diff --git a/reference/win32service/functions/win32-get-service-env-vars.xml b/reference/win32service/functions/win32-get-service-env-vars.xml deleted file mode 100644 index d435793a580f..000000000000 --- a/reference/win32service/functions/win32-get-service-env-vars.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - win32_get_service_env_vars - Read all custom environment variables on service - - - - &reftitle.description; - - arraywin32_get_service_env_vars - stringservicename - - - Read all custom environment variables on servicename - service. This function work only for the local computer. Administrative privileges are required for this to succeed. - - - - - &reftitle.parameters; - - - - servicename - - - The service name to read environment variables. - - - - - - - - - &reftitle.returnvalues; - - Return an &array; with variable name in key and variable value in value. - - - - - &reftitle.errors; - - A ValueError is thrown if the - value of service parameter is empty. - - - A Win32ServiceException is thrown on error. - - - - - &reftitle.seealso; - - - win32_add_service_env_var - win32_remove_service_env_var - - - - - - - diff --git a/reference/win32service/functions/win32-pause-service.xml b/reference/win32service/functions/win32-pause-service.xml deleted file mode 100644 index 9e3d1307880a..000000000000 --- a/reference/win32service/functions/win32-pause-service.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - - win32_pause_service - Pauses a service - - - &reftitle.description; - - voidwin32_pause_service - stringservicename - stringmachine&null; - - - - Pauses a named service. Requires administrative privileges or - an account with appropriate rights set in the service's ACL. - - - - - &reftitle.parameters; - - - - servicename - - - The short name of the service. - - - - - machine - - - Optional machine name. If omitted, the local machine is used. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - Prior to version 1.0.0, &win32service.noerror.false.error; - - - - - - &reftitle.errors; - - A ValueError is thrown if the - value of servicename parameter is empty. - - - - A Win32ServiceException is thrown on error. - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL win32service 1.0.0 - - Throws a ValueError on invalid data in parameters, - previously &false; was returned. - - - - PECL win32service 1.0.0 - - Throws a Win32ServiceException on error, - previously a - Win32 Error Code - was returned. - - - - PECL win32service 1.0.0 - - The return type is now void, previously it was mixed. - - - - PECL win32service 0.3.0 - - This function does not longer require an administrator account if ACL is set for another account. - - - - - - - - - - &reftitle.seealso; - - - win32_start_service - win32_stop_service - win32_continue_service - win32_send_custom_control - Win32 Error Codes - - - - - - - diff --git a/reference/win32service/functions/win32-query-service-status.xml b/reference/win32service/functions/win32-query-service-status.xml deleted file mode 100644 index 1a58ac640d11..000000000000 --- a/reference/win32service/functions/win32-query-service-status.xml +++ /dev/null @@ -1,224 +0,0 @@ - - - - - - win32_query_service_status - Queries the status of a service - - - &reftitle.description; - - arraywin32_query_service_status - stringservicename - stringmachine&null; - - - - Queries the current status for a service, returning an array of - information. - - - - - &reftitle.parameters; - - - - servicename - - - The short name of the service. - - - - - machine - - - The optional machine name. If omitted, the local machine will be used. - - - - - - - - - &reftitle.returnvalues; - - Returns an array consisting of the following information on success - - - Prior version 1.0.0&win32service.false.error; - - - - - ServiceType - - - The dwServiceType. See Win32Service Service Type Bitmasks. - - - - - CurrentState - - - The dwCurrentState. See Win32Service Service Status Constants. - - - - - ControlsAccepted - - - Which service controls are accepted by the service. See Win32Service Service Control Message Accepted Bitmasks. - - - - - Win32ExitCode - - - If the service exited, the return code from the process. This value is equal to - WIN32_ERROR_SERVICE_SPECIFIC_ERROR - if the exit mode is not graceful. See - Win32Service error codes and - win32_set_service_exit_mode - - - - - ServiceSpecificExitCode - - - If the service exited with an error condition, the service specific - code that is logged in the event log is visible here. This value is equal - to the value defined by win32_set_service_exit_code - - - - - CheckPoint - - - If the service is shutting down, holds the current check point number. - This is used by the SCM as a kind of heart-beat to detect a wedged service - process. The value of the check point is best interpreted in - conjunction with the WaitHint value. - - - - - WaitHint - - - If the service is shutting down it will set WaitHint to a checkpoint - value that will indicate 100% completion. This can be used to - implement a progress indicator. - - - - - ProcessId - - - The Windows process identifier. If 0, the process is not running. - - - - - ServiceFlags - - - The dwServiceFlags. See Win32Service Service Flag Constants. - - - - - - - - - - - &reftitle.errors; - - A ValueError is thrown if the - value of servicename parameter is empty. - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL win32service 1.0.0 - - Throws a ValueError on invalid data in parameters, - previously &false; was returned. - - - - PECL win32service 1.0.0 - - Throws a Win32ServiceException on error, - previously a - Win32 Error Code - was returned. - - - - PECL win32service 1.0.0 - - The return type is now array, previously it was mixed. - - - - - - - - - - &reftitle.seealso; - - - Win32Service Predefined Constants - - - - - - - diff --git a/reference/win32service/functions/win32-read-all-rights-access-service.xml b/reference/win32service/functions/win32-read-all-rights-access-service.xml deleted file mode 100644 index 07681a7d30fc..000000000000 --- a/reference/win32service/functions/win32-read-all-rights-access-service.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - win32_read_all_rights_access_service - Read all service rights access - - - - &reftitle.description; - - arraywin32_read_all_rights_access_service - stringservicename - stringmachine&null; - - - Read all rights access on servicename - service. Administrative privileges are required for this to succeed. - - - - - &reftitle.parameters; - - - - servicename - - - The service name to read rights access. - - - - - machine - - - The optional machine name on which you want to create a service. - If omitted, it will use the local machine. - - - - - - - - - &reftitle.returnvalues; - - Return an &array; of Win32Service\RightInfo - - - - - &reftitle.errors; - - A ValueError is thrown if the - value of service parameter is empty. - - - A Win32ServiceException is thrown on error. - - - - - &reftitle.seealso; - - - win32_read_rights_access_service - win32_add_right_access_service - win32_remove_right_access_service - Win32 Rights constants - - - - - - - diff --git a/reference/win32service/functions/win32-read-right-access-service.xml b/reference/win32service/functions/win32-read-right-access-service.xml deleted file mode 100644 index 23da1a35dd1b..000000000000 --- a/reference/win32service/functions/win32-read-right-access-service.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - win32_read_right_access_service - Read the service rights access for an username - - - - &reftitle.description; - - Win32Service\RightInfowin32_read_right_access_service - stringservicename - stringusername - stringmachine&null; - - - Read the rights access for username on servicename - service. Administrative privileges are required for this to succeed. - - - - - &reftitle.parameters; - - - - servicename - - - The service name to read rights access. - - - - - username - - - Read the rights access for username - - - - - machine - - - The optional machine name on which you want to create a service. - If omitted, it will use the local machine. - - - - - - - - - &reftitle.returnvalues; - - Return a Win32Service\RightInfo object. - - - - - &reftitle.errors; - - A ValueError is thrown if the - value of service parameter is empty. - - - A ValueError is thrown if the - value of username parameter is empty. - - - A Win32ServiceException is thrown on error. - - - - - &reftitle.seealso; - - - win32_read_all_rights_access_service - win32_add_right_access_service - win32_remove_right_access_service - Win32 Rights constants - - - - - - - diff --git a/reference/win32service/functions/win32-remove-right-access-service.xml b/reference/win32service/functions/win32-remove-right-access-service.xml deleted file mode 100644 index cf1fc520ff76..000000000000 --- a/reference/win32service/functions/win32-remove-right-access-service.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - win32_remove_right_access_service - Remove the service rights access for an username - - - - &reftitle.description; - - voidwin32_remove_right_access_service - stringservicename - stringusername - stringmachine&null; - - - Remove the rights access for username on servicename - service. Administrative privileges are required for this to succeed. - - - - - &reftitle.parameters; - - - - servicename - - - The service name to remove rights access. - - - - - username - - - Read the rights access for username. - - - - - machine - - - The optional machine name on which you want to create a service. - If omitted, it will use the local machine. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - A ValueError is thrown if the - value of service parameter is empty. - - - A ValueError is thrown if the - value of username parameter is empty. - - - A Win32ServiceException is thrown on error. - - - - - &reftitle.seealso; - - - win32_read_all_rights_access_service - win32_read_rights_access_service - win32_add_right_access_service - - - - - - - diff --git a/reference/win32service/functions/win32-remove-service-env-var.xml b/reference/win32service/functions/win32-remove-service-env-var.xml deleted file mode 100644 index 459feecd51e9..000000000000 --- a/reference/win32service/functions/win32-remove-service-env-var.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - win32_remove_service_env_var - Remove a custom environment variables on service - - - - &reftitle.description; - - voidwin32_remove_service_env_var - stringservicename - stringvarname - - - Remove a custom environment variables varname on servicename - service. This function work only for the local computer. Administrative privileges are required for this to succeed. - - - - - &reftitle.parameters; - - - - servicename - - - The service name to remove environment variable. - - - - - varname - - - The environment variable name. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - A ValueError is thrown if the - value of service parameter is empty. - - - A ValueError is thrown if the - value of varname parameter is empty. - - - A Win32ServiceException is thrown on error. - - - - - &reftitle.seealso; - - - win32_get_service_env_vars - win32_add_service_env_var - - - - - - - diff --git a/reference/win32service/functions/win32-send-custom-control.xml b/reference/win32service/functions/win32-send-custom-control.xml deleted file mode 100644 index c86677f54cfa..000000000000 --- a/reference/win32service/functions/win32-send-custom-control.xml +++ /dev/null @@ -1,156 +0,0 @@ - - - - - - win32_send_custom_control - Send a custom control to the service - - - - &reftitle.description; - - voidwin32_send_custom_control - stringservicename - intcontrol - stringmachine&null; - - - - See Microsoft ControlService function for more details - - - - - - &reftitle.parameters; - - - servicename - - - The short name of the service. - - - - - control - - - The custom contole value between 128 and 255. - - - - - machine - - - Optional machine name. If omitted, the local machine is used. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - Prior to version 1.0.0, &win32service.noerror.false.error; - - - - - &reftitle.errors; - - Prior to version 1.0.0, if the control value is not between 128 and 255, this function emits an - E_ERROR level error. - - - A ValueError is thrown if the - value of servicename parameter is empty. - - - A ValueError is thrown if the - value of control parameter is not between 128 and 255. - - - A Win32ServiceException is thrown on error. - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL win32service 1.0.0 - - Throws a ValueError on invalid data in parameters, - previously &false; was returned. - - - - PECL win32service 1.0.0 - - Throws a Win32ServiceException on error, - previously a - Win32 Error Code - was returned. - - - - PECL win32service 1.0.0 - - The return type is now void, previously it was mixed. - - - - - - - - - - &reftitle.seealso; - - win32_start_service - win32_stop_service - win32_pause_service - win32_continue_service - Win32 Error Codes - - - - - - diff --git a/reference/win32service/functions/win32-set-service-exit-code.xml b/reference/win32service/functions/win32-set-service-exit-code.xml deleted file mode 100644 index 166be1209acc..000000000000 --- a/reference/win32service/functions/win32-set-service-exit-code.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - win32_set_service_exit_code - Define or return the exit code for the current running service - - - - &reftitle.description; - - intwin32_set_service_exit_code - intexitCode1 - - - Change or return the exit code. The exit code is used only if the exit mode is not graceful. - If the value is not zero, the recovery configuration can be used after - service fail. See - Microsoft system error codes - for more details - - - - - This function work only in "cli" SAPI. On other SAPI - this function is disabled. - - - - - - &reftitle.parameters; - - - exitCode - - - The return code used on exit. - - - - - - - - &reftitle.returnvalues; - - Return the current or old exit code. - - - - - &reftitle.errors; - - Prior to version 1.0.0, if the SAPI is not "cli", this function emits an - E_ERROR level error. - - - As of version 1.0.0, will throw a - Win32ServiceException if SAPI is not - "cli" - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL win32service 1.0.0 - - Throws a ValueError on invalid data in parameters, - previously &false; was returned. - - - - PECL win32service 1.0.0 - - Throws a Win32ServiceException on error, - previously a - Win32 Error Code - was returned. - - - - - - - - - - &reftitle.seealso; - - win32_start_service_ctrl_dispatcher - win32_set_service_status - win32_set_service_exit_mode - - - - - - diff --git a/reference/win32service/functions/win32-set-service-exit-mode.xml b/reference/win32service/functions/win32-set-service-exit-mode.xml deleted file mode 100644 index 2618d713f0c9..000000000000 --- a/reference/win32service/functions/win32-set-service-exit-mode.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - win32_set_service_exit_mode - Define or return the exit mode for the current running service - - - - &reftitle.description; - - boolwin32_set_service_exit_mode - boolgracefulModetrue - - - If gracefulMode parameter is provided, the exit mode -is changed. When the exit mode is not graceful, the exit code used can be set -with the win32_set_service_exit_code function. - - - - - This function work only in "cli" SAPI. On other SAPI - this function is disabled. - - - - - - &reftitle.parameters; - - - gracefulMode - - - &true; for exit graceful. &false; for exit with error. - - - - - - - - &reftitle.returnvalues; - - Return the current or old exit mode. - - - - - &reftitle.errors; - - Prior to version 1.0.0, if the SAPI is not "cli", this function emits an - E_ERROR level error. - - - - As of version 1.0.0, will throw a - Win32ServiceException if SAPI is not - "cli" - - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL win32service 1.0.0 - - Throws a ValueError on invalid data in parameters, - previously &false; was returned. - - - - PECL win32service 1.0.0 - - Throws a Win32ServiceException on error, - previously a - Win32 Error Code - was returned. - - - - - - - - - - &reftitle.seealso; - - win32_start_service_ctrl_dispatcher - win32_set_service_status - win32_set_service_exit_code - - - - - - diff --git a/reference/win32service/functions/win32-set-service-pause-resume-state.xml b/reference/win32service/functions/win32-set-service-pause-resume-state.xml deleted file mode 100644 index 5d31e740c33b..000000000000 --- a/reference/win32service/functions/win32-set-service-pause-resume-state.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - win32_set_service_pause_resume_state - Define or return the pause/resume capability for the current running service - - - - &reftitle.description; - - boolwin32_set_service_pause_resume_state - boolstatetrue - - - If state parameter is provided, the pause/resume capability -is changed. - - - - - This function work only in "cli" SAPI and in the Windows service running context. On other SAPI - this function is disabled. - - - - - - &reftitle.parameters; - - - state - - - &true; for enable the service pause/resume capability. &false; for disable the service pause/resume capability. - - - - - - - - &reftitle.returnvalues; - - Return the current or old pause/resume capability state. - - - - - &reftitle.errors; - - Prior to version 1.0.0, if the SAPI is not "cli", this function emits an - E_ERROR level error. - - - - As of version 1.0.0, will throw a - Win32ServiceException if SAPI is not - "cli" - - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL win32service 1.0.0 - - Throws a ValueError on invalid data in parameters, - previously &false; was returned. - - - - PECL win32service 1.0.0 - - Throws a Win32ServiceException on error, - previously a - Win32 Error Code - was returned. - - - - - - - - - - &reftitle.seealso; - - win32_start_service_ctrl_dispatcher - win32_set_service_status - win32_set_service_exit_code - - - - - - diff --git a/reference/win32service/functions/win32-set-service-status.xml b/reference/win32service/functions/win32-set-service-status.xml deleted file mode 100644 index 99b3151d1c64..000000000000 --- a/reference/win32service/functions/win32-set-service-status.xml +++ /dev/null @@ -1,174 +0,0 @@ - - - - - - win32_set_service_status - Update the service status - - - &reftitle.description; - - voidwin32_set_service_status - intstatus - intcheckpoint0 - - - Informs the SCM of the current status of a running service. - This call is only valid for a running service process. - - - - - Since version 0.2.0, this function work only in "cli" SAPI. On other SAPI - this function is disabled. - - - - - - &reftitle.parameters; - - - - status - - - The service status code, one of - WIN32_SERVICE_RUNNING, - WIN32_SERVICE_STOPPED, - WIN32_SERVICE_STOP_PENDING, - WIN32_SERVICE_START_PENDING, - WIN32_SERVICE_CONTINUE_PENDING, - WIN32_SERVICE_PAUSE_PENDING, - WIN32_SERVICE_PAUSED. - - - - - checkpoint - - - The checkpoint value the service increments periodically to report its - progress during a lengthy start, stop, pause, or continue operation. - For example, the service should increment this value as it completes - each step of its initialization when it is starting up. - - - The checkpoint is only valid when the - status is one of - WIN32_SERVICE_STOP_PENDING, - WIN32_SERVICE_START_PENDING, - WIN32_SERVICE_CONTINUE_PENDING or - WIN32_SERVICE_PAUSE_PENDING. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - Prior to version 1.0.0, &win32service.noerror.false.error; - - - - - &reftitle.errors; - - Prior to version 1.0.0, if the SAPI is not "cli", this function emits an -E_ERROR level error. - - - As of version 1.0.0, will throw a - Win32ServiceException if SAPI is not - "cli" - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL win32service 1.0.0 - - Throws a ValueError on invalid data in parameters, - previously &false; was returned. - - - - PECL win32service 1.0.0 - - Throws a Win32ServiceException on error, - previously a - Win32 Error Code - was returned. - - - - PECL win32service 1.0.0 - - The return type is now void, previously it was mixed. - - - - PECL win32service 0.2.0 - - This function works only in the "cli" SAPI. - - - - - - - - - - &reftitle.seealso; - - - win32_start_service_ctrl_dispatcher - win32_get_last_control_message - win32_set_service_exit_mode - win32_set_service_exit_code - Win32Service Service Status Constants - - - - - - - diff --git a/reference/win32service/functions/win32-start-service-ctrl-dispatcher.xml b/reference/win32service/functions/win32-start-service-ctrl-dispatcher.xml deleted file mode 100644 index 8110a9ee1078..000000000000 --- a/reference/win32service/functions/win32-start-service-ctrl-dispatcher.xml +++ /dev/null @@ -1,212 +0,0 @@ - - - - - - win32_start_service_ctrl_dispatcher - Registers the script with the SCM, so that it can act as the service with the given name - - - &reftitle.description; - - voidwin32_start_service_ctrl_dispatcher - stringname - boolgracefulModetrue - - - - When launched via the Service Control Manager, a service process is - required to "check-in" with it to establish service monitoring and - communication facilities. This function performs the check-in by spawning - a thread to handle the lower-level communication with the service control - manager. - - - Once started, the service process should do 2 things. The first is to tell - the Service Control Manager that the service is running. This is achieved - by calling win32_set_service_status with the - WIN32_SERVICE_RUNNING constant. If you need to perform - some lengthy process before the service is actually running, then you can - use the WIN32_SERVICE_START_PENDING constant. The - second is to continue to check-in with the service control manager so that - it can determine if it should terminate. This is achieved by periodically - calling win32_get_last_control_message and handling the - return code appropriately. - - - - - Since version 0.2.0, this function work only in "cli" SAPI. On other SAPI - this function is disabled. - - - - - - &reftitle.parameters; - - - - name - - - The short-name of the service, as registered by - win32_create_service. - - - - - gracefulMode - - - &true; for exit graceful. &false; for exit with error. See - win32_set_service_exit_mode for more details. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - Prior to version 1.0.0, &win32service.noerror.false.error; - - - - - &reftitle.errors; - - Prior to version 1.0.0, if the SAPI is not "cli", this function emits an - E_ERROR level error. - - - As of version 1.0.0, will throw a - Win32ServiceException if SAPI is not - "cli" - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL win32service 1.0.0 - - Throws a ValueError on invalid data in parameters, - previously &false; was returned. - - - - PECL win32service 1.0.0 - - Throws a Win32ServiceException on error, - previously a - Win32 Error Code - was returned. - - - - PECL win32service 1.0.0 - - The return type is now void, previously it was mixed. - - - - PECL win32service 0.4.0 - - The parameter gracefulMode has been added. - - - - PECL win32service 0.2.0 - - This function works only in the "cli" SAPI. - - - - - - - - - - &reftitle.examples; - - - A <function>win32_start_service_ctrl_dispatcher</function> example - - Check if the service is runnig under the SCM. - - - -]]> - - - - - - - &reftitle.seealso; - - - win32_set_service_status - win32_get_last_control_message - win32_set_service_exit_mode - win32_set_service_exit_code - Win32 Error Codes - - - - - - - diff --git a/reference/win32service/functions/win32-start-service.xml b/reference/win32service/functions/win32-start-service.xml deleted file mode 100644 index 74c9dabf1612..000000000000 --- a/reference/win32service/functions/win32-start-service.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - win32_start_service - Starts a service - - - &reftitle.description; - - voidwin32_start_service - stringservicename - stringmachine&null; - - - - Attempts to start the named service. Requires administrative privileges or - an account with appropriate rights set in the service's ACL. - - - - - &reftitle.parameters; - - - - servicename - - - The short name of the service. - - - - - machine - - - Optional machine name. If omitted, the local machine is used. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - Prior to version 1.0.0, &win32service.noerror.false.error; - - - - - &reftitle.errors; - - A ValueError is thrown if the - value of servicename parameter is empty. - - - A Win32ServiceException is thrown on error. - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL win32service 1.0.0 - - Throws a ValueError on invalid data in parameters, - previously &false; was returned. - - - - PECL win32service 1.0.0 - - Throws a Win32ServiceException on error, - previously a - Win32 Error Code - was returned. - - - - PECL win32service 1.0.0 - - The return type is now void, previously it was mixed. - - - - PECL win32service 0.3.0 - - This function does not longer require an administrator account if ACL is set for another account. - - - - - - - - - - &reftitle.seealso; - - - win32_stop_service - win32_pause_service - win32_continue_service - win32_send_custom_control - Win32 Error Codes - - - - - - - diff --git a/reference/win32service/functions/win32-stop-service.xml b/reference/win32service/functions/win32-stop-service.xml deleted file mode 100644 index 18b24139baa0..000000000000 --- a/reference/win32service/functions/win32-stop-service.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - win32_stop_service - Stops a service - - - &reftitle.description; - - voidwin32_stop_service - stringservicename - stringmachine&null; - - - - Stops a named service. Requires administrative privileges or - an account with appropriate rights set in the service's ACL. - - - - - &reftitle.parameters; - - - - servicename - - - The short name of the service. - - - - - machine - - - Optional machine name. If omitted, the local machine is used. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - Prior to version 1.0.0, &win32service.noerror.false.error; - - - - - &reftitle.errors; - - A ValueError is thrown if the - value of servicename parameter is empty. - - - A Win32ServiceException is thrown on error. - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL win32service 1.0.0 - - Throws a ValueError on invalid data in parameters, - previously &false; was returned. - - - - PECL win32service 1.0.0 - - Throws a Win32ServiceException on error, - previously a - Win32 Error Code - was returned. - - - - PECL win32service 1.0.0 - - The return type is now void, previously it was mixed. - - - - PECL win32service 0.3.0 - - This function does not longer require an administrator account if ACL is set for another account. - - - - - - - - - - &reftitle.seealso; - - - win32_start_service - win32_pause_service - win32_continue_service - win32_send_custom_control - Win32 Error Codes - - - - - - - diff --git a/reference/win32service/reference.xml b/reference/win32service/reference.xml deleted file mode 100644 index 1a9eda1f00ee..000000000000 --- a/reference/win32service/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - win32service &Functions; - - &reference.win32service.entities.functions; - - - - diff --git a/reference/win32service/rightinfo/construct.xml b/reference/win32service/rightinfo/construct.xml deleted file mode 100644 index 757a8b660250..000000000000 --- a/reference/win32service/rightinfo/construct.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - Win32Service\RightInfo::__construct - Create a new RightInfo (not used) - - - - &reftitle.description; - - final private Win32Service\RightInfo::__construct - - - - Win32Service\RightInfo objects are returned as the - result of win32_read_right_access_service. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - &reftitle.seealso; - - Win32Service\RightInfo::getRights - Win32Service\RightInfo::isGrantAccess - Win32Service\RightInfo::isDenyAccess - Win32Service\RightInfo::getFullUsername - Win32Service\RightInfo::getUsername - Win32Service\RightInfo::getDomain - - - - - - diff --git a/reference/win32service/rightinfo/get-domain.xml b/reference/win32service/rightinfo/get-domain.xml deleted file mode 100644 index bb47f9fa0693..000000000000 --- a/reference/win32service/rightinfo/get-domain.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - Win32Service\RightInfo::getDomain - Return the user's domain - - - - &reftitle.description; - - final public stringnull Win32Service\RightInfo::getDomain - - - - Return the user's domain. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Return the domain name or &null; if no domain found (local account or user GUID resolve fail). - - - - - &reftitle.seealso; - - Win32Service\RightInfo::__construct - Win32Service\RightInfo::getRights - Win32Service\RightInfo::isGrantAccess - Win32Service\RightInfo::isDenyAccess - Win32Service\RightInfo::getFullUsername - Win32Service\RightInfo::getUsername - - - - - - diff --git a/reference/win32service/rightinfo/get-full-username.xml b/reference/win32service/rightinfo/get-full-username.xml deleted file mode 100644 index e5272637245b..000000000000 --- a/reference/win32service/rightinfo/get-full-username.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Win32Service\RightInfo::getFullUsername - Return the domain and username - - - - &reftitle.description; - - final public stringnull Win32Service\RightInfo::getFullUsername - - - - Return the domain and username separated by anti-slash \. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the domain and username. If the domain is &null;, returns only the username; returns &null; if no username is found. - - - - - &reftitle.seealso; - - Win32Service\RightInfo::__construct - Win32Service\RightInfo::getRights - Win32Service\RightInfo::isGrantAccess - Win32Service\RightInfo::isDenyAccess - Win32Service\RightInfo::getUsername - - - - - - diff --git a/reference/win32service/rightinfo/get-rights.xml b/reference/win32service/rightinfo/get-rights.xml deleted file mode 100644 index 61792f8639e5..000000000000 --- a/reference/win32service/rightinfo/get-rights.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Win32Service\RightInfo::getRights - Return the rights list - - - - &reftitle.description; - - final public array Win32Service\RightInfo::getRights - - - - Return the user's right list. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Return the user's right list. - - - The array index is the binary mask of right represented by the constants rights. - - - The value is a string with the Windows constant name (without WIN32_ prefix). - - - - - &reftitle.seealso; - - Win32Service\RightInfo::__construct - Win32Service\RightInfo::isGrantAccess - Win32Service\RightInfo::isDenyAccess - Win32Service\RightInfo::getFullUsername - Win32Service\RightInfo::getUsername - Win32Service\RightInfo::getDomain - Win32 Rights constants - - - - - - diff --git a/reference/win32service/rightinfo/get-username.xml b/reference/win32service/rightinfo/get-username.xml deleted file mode 100644 index ea60238f4d5a..000000000000 --- a/reference/win32service/rightinfo/get-username.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - Win32Service\RightInfo::getUsername - Return the username - - - - &reftitle.description; - - final public stringnull Win32Service\RightInfo::getUsername - - - - Return the username. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Return the username name or GUID if resolve fail. - - - - - &reftitle.seealso; - - Win32Service\RightInfo::__construct - Win32Service\RightInfo::getRights - Win32Service\RightInfo::isGrantAccess - Win32Service\RightInfo::isDenyAccess - Win32Service\RightInfo::getFullUsername - Win32Service\RightInfo::getDomain - - - - - - diff --git a/reference/win32service/rightinfo/is-deny-access.xml b/reference/win32service/rightinfo/is-deny-access.xml deleted file mode 100644 index 1368f5fed25d..000000000000 --- a/reference/win32service/rightinfo/is-deny-access.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - Win32Service\RightInfo::isDenyAccess - Return true if the RightInfo concerns deny access to the resource - - - - &reftitle.description; - - final public bool Win32Service\RightInfo::isDenyAccess - - - - Return &true; if the RightInfo concerns deny access to the resource, otherwise, it is &false;. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Return &true; if the RightInfo concerns deny access to the resource, otherwise, it is &false;. - - - - - &reftitle.seealso; - - Win32Service\RightInfo::__construct - Win32Service\RightInfo::getRights - Win32Service\RightInfo::isGrantAccess - Win32Service\RightInfo::getFullUsername - Win32Service\RightInfo::getUsername - Win32Service\RightInfo::getDomain - - - - - - diff --git a/reference/win32service/rightinfo/is-grant-access.xml b/reference/win32service/rightinfo/is-grant-access.xml deleted file mode 100644 index b223967ea226..000000000000 --- a/reference/win32service/rightinfo/is-grant-access.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - Win32Service\RightInfo::isGrantAccess - Return true if the RightInfo concern grants access to the resource - - - - &reftitle.description; - - final public bool Win32Service\RightInfo::isGrantAccess - - - - Return &true; if the RightInfo concern grants access to the resource, &false; otherwise. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Return &true; if the RightInfo concern grants access to the resource, &false; otherwise. - - - - - &reftitle.seealso; - - Win32Service\RightInfo::__construct - Win32Service\RightInfo::getRights - Win32Service\RightInfo::isDenyAccess - Win32Service\RightInfo::getFullUsername - Win32Service\RightInfo::getUsername - Win32Service\RightInfo::getDomain - - - - - - diff --git a/reference/win32service/setup.xml b/reference/win32service/setup.xml deleted file mode 100644 index 59ef1dbaccde..000000000000 --- a/reference/win32service/setup.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - &reftitle.setup; - - -
    - &reftitle.required; - - The versions of Windows supported are the same as the Visual C++ redistributable package used to build PHP. - -
    - - - -
    - &reftitle.install; - - &pecl.info; - &url.pecl.package;win32service - -
    - - -
    - Security consideration - - This extension needs administrator privileges for some actions such as - create, - delete, - start, - stop, - pause and - continue. - This requirement can cause an elevation of privileges if the service - control is available from the web interface or remote control. - - - The ACL on the service can be set after adding it into SCM to delegate the - current administration tasks to a non administrator account or service account. - - - As of Win32Service 1.1.0, service rights can be managed with PHP. The actual ACLs can be read with - win32_read_all_rights_access_service, an access or deny right can be added with - win32_add_right_access_service, or an access right can be removed with - win32_remove_right_access_service. - - - It is recommended to update to Win32Service 1.1.0. - For further instructions to manage rights without the extension (or a version prior to 1.1.0), see the - Microsoft Knowledge Base. - -
    - -
    - - - diff --git a/reference/win32service/versions.xml b/reference/win32service/versions.xml deleted file mode 100644 index 02c53cf8f19d..000000000000 --- a/reference/win32service/versions.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/win32service/win32serviceexception.xml b/reference/win32service/win32serviceexception.xml deleted file mode 100644 index 57d56dd22ac9..000000000000 --- a/reference/win32service/win32serviceexception.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - The Win32ServiceException class - Win32ServiceException - - - - -
    - &reftitle.intro; - - The exception replaces the old mechanism where the error value needed to be - compared to constants to detect which error was emitted. The Exception code - is equal to the value of the error value and the exception message is based - on the corresponding constant name. - -
    - - -
    - &reftitle.classsynopsis; - - - - Win32ServiceException - - - - - Win32ServiceException - - - - extends - Exception - - - - - &InheritedProperties; - - - - - - &InheritedMethods; - - - - -
    - -
    - - - -
    - - diff --git a/reference/win32service/win32servicerightinfo.xml b/reference/win32service/win32servicerightinfo.xml deleted file mode 100644 index ed34c6f638a2..000000000000 --- a/reference/win32service/win32servicerightinfo.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - The Win32Service\RightInfo class - Win32Service\RightInfo - - - - -
    - &reftitle.intro; - - The Win32Service\RightInfo internal class encapsulates the result of win32_read_right_access_service. - -
    - - -
    - &reftitle.classsynopsis; - - - - Win32Service\RightInfo - - - - final - - Win32Service\RightInfo - - - - - &Methods; - - - - -
    - -
    - - &reference.win32service.entities.rightinfo; - -
    - - diff --git a/reference/wincache/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/wincache/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/wincache/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/wincache/book.xml b/reference/wincache/book.xml deleted file mode 100644 index 1a631d93ed6c..000000000000 --- a/reference/wincache/book.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - Windows Cache for PHP - WinCache - - - &reftitle.intro; - - Windows Cache Extension for PHP is a PHP accelerator that is used to increase the speed of - PHP applications running on Windows and Windows Server. Once the Windows Cache Extension for - PHP is enabled and loaded by the PHP engine, PHP applications can take advantage of the - functionality without any code modifications. - - - The Windows Cache Extension includes 5 different types of caches. The following describes - the purpose of each cache type and the benefits it provides. - - - - - PHP Opcode Cache - PHP is a script processing engine, which reads - an input stream of data that contains text and/or PHP instructions and produces another - stream of data, most commonly in the HTML format. This means that on a web server the - PHP engine reads, parses, compiles and executes a PHP script each time that it is requested - by a Web client. The reading, parsing and compilation operations put additional load on the - web server's CPU and file system and thus affect the overall performance of a PHP web application. - The PHP bytecode (opcode) cache is used to store the compiled script bytecode in shared memory so - that it can be re-used by PHP engine for subsequent executions of the same script. - - - Support for opcode caching was removed in Wincache 2.0.0, all users who - wish to have an opcache should use the OPcache extension - that is included with PHP. - - - - - File Cache - Even with the PHP opcode cache enabled, the PHP engine - has to accesses the script files on a file system. When PHP scripts are stored on a remote - UNC file share, the file operations introduce a significant performance overhead. - The Windows Cache Extension for PHP includes a file cache that is used to store the content - of the PHP script files in shared memory, which reduces the amount of file system operations - performed by PHP engine. - - - - - Resolve File Path Cache - PHP scripts very often include or operate - with files by using relative file paths. Every file path has to be normalized to - an absolute file path by the PHP engine. When a PHP application uses many PHP files and - accesses them by relative paths, the operation of resolving the paths may negatively - impact the application's performance. The Windows Cache Extension for PHP - provides a Resolve File Path cache, which is used to store the mappings between relative - and absolute file paths, thereby reducing the number of path resolutions that the - PHP engine has to perform. - - - - - User Cache (available since version 1.1.0) - PHP scripts can take advantage of - the shared memory cache by using the user cache API's. PHP objects and variables can be stored in the - user cache and then re-used on subsequent requests. This can be used to improve performance of PHP scripts - and to share the data across multiple PHP processes. - - - - - Session Handler (available since version 1.1.0) - The WinCache session handler can be used to - store the PHP session data in the shared memory cache. This avoids file system operations for reading - and writing session data, which improves performance when large amount of data is stored in PHP session. - - - - - - &reference.wincache.setup; - &reference.wincache.reference; - &reference.wincache.win32build; - - - - - diff --git a/reference/wincache/functions/wincache-fcache-fileinfo.xml b/reference/wincache/functions/wincache-fcache-fileinfo.xml deleted file mode 100644 index f5136b4539b5..000000000000 --- a/reference/wincache/functions/wincache-fcache-fileinfo.xml +++ /dev/null @@ -1,186 +0,0 @@ - - - - - wincache_fcache_fileinfo - - Retrieves information about files cached in the file cache - - - - &reftitle.description; - - arrayfalsewincache_fcache_fileinfo - boolsummaryonly&false; - - - Retrieves information about file cache content and its usage. - - - - &reftitle.parameters; - - - - summaryonly - - - Controls whether the returned array will contain information about individual cache entries - along with the file cache summary. - - - - - - - - &reftitle.returnvalues; - - Array of meta data about file cache &return.falseforfailure; - - - The array returned by this function contains the following elements: - - - - total_cache_uptime - total time in seconds that the file cache has been active - - - - - total_file_count - total number of files that are currently in the file cache - - - - - total_hit_count - number of times the files have been served from the file cache - - - - - total_miss_count - number of times the files have not been found in the file cache - - - - - file_entries - an array that contains the information about all the cached files: - - - - file_name - absolute file name of the cached file - - - - - add_time - time in seconds since the file has been added to the file cache - - - - - use_time - time in seconds since the file has been accessed in the file cache - - - - - last_check - time in seconds since the file has been checked for modifications - - - - - hit_count - number of times the file has been served from the cache - - - - - file_size - size of the cached file in bytes - - - - - - - - - - &reftitle.examples; - - - A <function>wincache_fcache_fileinfo</function> example - - - - - -]]> - - &example.outputs; - - 3234 - [total_file_count] => 5 - [total_hit_count] => 0 - [total_miss_count] => 1 - [file_entries] => Array - ( - [1] => Array - ( - [file_name] => c:\inetpub\wwwroot\checkcache.php - [add_time] => 1 - [use_time] => 0 - [last_check] => 1 - [hit_count] => 1 - [file_size] => 2435 - ) - [2] => Array (...iterates for each cached file) - ) -) -]]> - - - - - - - &reftitle.seealso; - - - wincache_fcache_meminfo - wincache_ocache_fileinfo - wincache_ocache_meminfo - wincache_rplist_fileinfo - wincache_rplist_meminfo - wincache_refresh_if_changed - wincache_ucache_meminfo - wincache_ucache_info - wincache_scache_info - wincache_scache_meminfo - - - - - - - diff --git a/reference/wincache/functions/wincache-fcache-meminfo.xml b/reference/wincache/functions/wincache-fcache-meminfo.xml deleted file mode 100644 index 3af238a713fd..000000000000 --- a/reference/wincache/functions/wincache-fcache-meminfo.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - wincache_fcache_meminfo - - Retrieves information about file cache memory usage - - - - &reftitle.description; - - arrayfalsewincache_fcache_meminfo - - - - Retrieves information about memory usage by file cache. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Array of meta data about file cache memory usage &return.falseforfailure; - - - The array returned by this function contains the following elements: - - - - memory_total - amount of memory in bytes allocated for the file cache - - - - - memory_free - amount of free memory in bytes available for the file cache - - - - - num_used_blks - number of memory blocks used by the file cache - - - - - num_free_blks - number of free memory blocks available for the file cache - - - - - memory_overhead - amount of memory in bytes used for the file cache internal structures - - - - - - - - &reftitle.examples; - - - A <function>wincache_fcache_meminfo</function> example - - - - - -]]> - - &example.outputs; - - 134217728 - [memory_free] => 131339120 - [num_used_blks] => 361 - [num_free_blks] => 3 - [memory_overhead] => 5856 -) -]]> - - - - - - - &reftitle.seealso; - - - wincache_fcache_fileinfo - wincache_ocache_fileinfo - wincache_ocache_meminfo - wincache_rplist_fileinfo - wincache_rplist_meminfo - wincache_refresh_if_changed - wincache_ucache_meminfo - wincache_ucache_info - wincache_scache_info - wincache_scache_meminfo - - - - - - - diff --git a/reference/wincache/functions/wincache-lock.xml b/reference/wincache/functions/wincache-lock.xml deleted file mode 100644 index 10fd601643f8..000000000000 --- a/reference/wincache/functions/wincache-lock.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - wincache_lock - - Acquires an exclusive lock on a given key - - - - &reftitle.description; - - boolwincache_lock - stringkey - boolisglobal&false; - - - Obtains an exclusive lock on a given key. The execution of the current script will be blocked until the - lock can be obtained. Once the lock is obtained, the other scripts that try to request the lock by using the same - key will be blocked, until the current script releases the lock by using wincache_unlock. - - - - Using of the wincache_lock and wincache_unlock can cause deadlocks when - executing PHP scripts in a multi-process environment like FastCGI. Do not use these functions unless you are - absolutely sure you need to use them. For the majority of the operations on the user cache it is not necessary to - use these functions. - - - - - &reftitle.parameters; - - - - key - - - Name of the key in the cache to get the lock on. - - - - - isglobal - - - Controls whether the scope of the lock is system-wide or local. Local locks are scoped to the application pool - in IIS FastCGI case or to all php processes that have the same parent process identifier. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - - Using <function>wincache_lock</function> - - -]]> - - - - - - - &reftitle.seealso; - - - wincache_unlock - wincache_ucache_set - wincache_ucache_get - wincache_ucache_delete - wincache_ucache_clear - wincache_ucache_exists - wincache_ucache_meminfo - wincache_ucache_info - wincache_scache_info - - - - - - - diff --git a/reference/wincache/functions/wincache-ocache-fileinfo.xml b/reference/wincache/functions/wincache-ocache-fileinfo.xml deleted file mode 100644 index 1dff02d61cee..000000000000 --- a/reference/wincache/functions/wincache-ocache-fileinfo.xml +++ /dev/null @@ -1,200 +0,0 @@ - - - - - wincache_ocache_fileinfo - - Retrieves information about files cached in the opcode cache - - - - &reftitle.description; - - arrayfalsewincache_ocache_fileinfo - boolsummaryonly&false; - - - Retrieves information about opcode cache content and its usage. - - &warn.removed.function-7-0-0; - - - &reftitle.parameters; - - - - summaryonly - - - Controls whether the returned array will contain information about individual cache entries - along with the opcode cache summary. - - - - - - - - &reftitle.returnvalues; - - Array of meta data about opcode cache &return.falseforfailure; - - - The array returned by this function contains the following elements: - - - - total_cache_uptime - total time in seconds that the opcode cache has been active - - - - - total_file_count - total number of files that are currently in the opcode cache - - - - - total_hit_count - number of times the compiled opcode have been served from the cache - - - - - total_miss_count - number of times the compiled opcode have not been found in the cache - - - - - is_local_cache - true is the cache metadata is for a local cache instance, - false if the metadata is for the global cache - - - - - file_entries - an array that contains the information about all the cached files: - - - - file_name - absolute file name of the cached file - - - - - add_time - time in seconds since the file has been added to the opcode cache - - - - - use_time - time in seconds since the file has been accessed in the opcode cache - - - - - last_check - time in seconds since the file has been checked for modifications - - - - - hit_count - number of times the file has been served from the cache - - - - - function_count - number of functions in the cached file - - - - - class_count - number of classes in the cached file - - - - - - - - - - &reftitle.examples; - - - A <function>wincache_ocache_fileinfo</function> example - - - - - -]]> - - &example.outputs; - - 17357 - [total_file_count] => 121 - [total_hit_count] => 36562 - [total_miss_count] => 201 - [file_entries] => Array - ( - [1] => Array - ( - [file_name] => c:\inetpub\wwwroot\checkcache.php - [add_time] => 17356 - [use_time] => 7 - [last_check] => 10 - [hit_count] => 454 - [function_count] => 0 - [class_count] => 1 - ) - [2] => Array (...iterates for each cached file) - ) -) -]]> - - - - - - - &reftitle.seealso; - - - wincache_fcache_fileinfo - wincache_fcache_meminfo - wincache_ocache_meminfo - wincache_rplist_fileinfo - wincache_rplist_meminfo - wincache_refresh_if_changed - wincache_ucache_meminfo - wincache_ucache_info - wincache_scache_info - wincache_scache_meminfo - - - - - - - diff --git a/reference/wincache/functions/wincache-ocache-meminfo.xml b/reference/wincache/functions/wincache-ocache-meminfo.xml deleted file mode 100644 index 0406a32ba9cf..000000000000 --- a/reference/wincache/functions/wincache-ocache-meminfo.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - wincache_ocache_meminfo - - Retrieves information about opcode cache memory usage - - - - &reftitle.description; - - arrayfalsewincache_ocache_meminfo - - - - Retrieves information about memory usage by opcode cache. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Array of meta data about opcode cache memory usage &return.falseforfailure; - - - The array returned by this function contains the following elements: - - - - memory_total - amount of memory in bytes allocated for the opcode cache - - - - - memory_free - amount of free memory in bytes available for the opcode cache - - - - - num_used_blks - number of memory blocks used by the opcode cache - - - - - num_free_blks - number of free memory blocks available for the opcode cache - - - - - memory_overhead - amount of memory in bytes used for the opcode cache internal structures - - - - - &warn.removed.function-7-0-0; - - - - &reftitle.examples; - - - A <function>wincache_ocache_meminfo</function> example - - - - - -]]> - - &example.outputs; - - 134217728 - [memory_free] => 112106972 - [num_used_blks] => 15469 - [num_free_blks] => 4 - [memory_overhead] => 247600 -) -]]> - - - - - - - &reftitle.seealso; - - - wincache_fcache_fileinfo - wincache_fcache_meminfo - wincache_ocache_fileinfo - wincache_rplist_fileinfo - wincache_rplist_meminfo - wincache_refresh_if_changed - wincache_ucache_meminfo - wincache_ucache_info - wincache_scache_info - wincache_scache_meminfo - - - - - - - diff --git a/reference/wincache/functions/wincache-refresh-if-changed.xml b/reference/wincache/functions/wincache-refresh-if-changed.xml deleted file mode 100644 index a9151b4cec58..000000000000 --- a/reference/wincache/functions/wincache-refresh-if-changed.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - wincache_refresh_if_changed - - Refreshes the cache entries for the cached files - - - - &reftitle.description; - - boolwincache_refresh_if_changed - arrayfilesNULL - - - Refreshes the cache entries for the files, whose names were passed in the input argument. - If no argument is specified then refreshes all the entries in the cache. - - - - &reftitle.parameters; - - - - files - - - An array of file names for files that need to be refreshed. - An absolute or relative file paths can be used. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - WinCache performs regular checks on the cached files to - ensure that if any file has changed then the corresponding entry in the cache is - updated. By default this check is performed every 30 seconds. If, for example, - a PHP script updates another PHP script where the application's - configuration settings are stored, then it may happen that after the - configuration settings have been saved to a file, the application is still using - old settings for some time until the cache is refreshed. In those cases it may be - preferrable to refresh the cache right after the file has been changed. The - following example shows how this can be done. - - A <function>wincache_refresh_if_changed</function> example - -'); -fclose($handle); -wincache_refresh_if_changed(array($filename)); -?> -]]> - - - - - - - &reftitle.seealso; - - - wincache_fcache_fileinfo - wincache_fcache_meminfo - wincache_ocache_fileinfo - wincache_ocache_meminfo - wincache_rplist_fileinfo - wincache_rplist_meminfo - wincache_ucache_meminfo - wincache_ucache_info - - - - - - - diff --git a/reference/wincache/functions/wincache-rplist-fileinfo.xml b/reference/wincache/functions/wincache-rplist-fileinfo.xml deleted file mode 100644 index 3bf66a9ac29a..000000000000 --- a/reference/wincache/functions/wincache-rplist-fileinfo.xml +++ /dev/null @@ -1,151 +0,0 @@ - - - - - wincache_rplist_fileinfo - - Retrieves information about resolve file path cache - - - - &reftitle.description; - - arrayfalsewincache_rplist_fileinfo - boolsummaryonly&false; - - - Retrieves information about cached mappings between relative file paths - and corresponding absolute file paths. - - - - - &reftitle.parameters; - - - - summaryonly - - - - - - - - - - - - &reftitle.returnvalues; - - Array of meta data about the resolve file path cache &return.falseforfailure; - - - The array returned by this function contains the following elements: - - - - total_file_count - total number of file path - mappings stored in the cache - - - - - rplist_entries - an array that contains the information about all - the cached file paths: - - - - resolve_path - path to a file - - - - - subkey_data - corresponding absolute path to a file - - - - - - - - - - - &reftitle.examples; - - - A <function>wincache_rplist_fileinfo</function> example - - - - - -]]> - - &example.outputs; - - 5 - [rplist_entries] => Array - ( - [1] => Array - ( - [resolve_path] => checkcache.php - [subkey_data] => c:\inetpub\wwwroot|c:\inetpub\wwwroot\checkcache.php - ) - - [2] => Array (...iterates for each cached file) - ) -) -]]> - - - - - - - &reftitle.seealso; - - - wincache_fcache_meminfo - wincache_fcache_fileinfo - wincache_ocache_fileinfo - wincache_ocache_meminfo - wincache_rplist_meminfo - wincache_refresh_if_changed - wincache_ucache_meminfo - wincache_ucache_info - wincache_scache_info - wincache_scache_meminfo - - - - - - - diff --git a/reference/wincache/functions/wincache-rplist-meminfo.xml b/reference/wincache/functions/wincache-rplist-meminfo.xml deleted file mode 100644 index 6e7d276f1935..000000000000 --- a/reference/wincache/functions/wincache-rplist-meminfo.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - wincache_rplist_meminfo - - Retrieves information about memory usage by the resolve file path cache - - - - &reftitle.description; - - arrayfalsewincache_rplist_meminfo - - - - Retrieves information about memory usage by resolve file path cache. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Array of meta data that describes memory usage by resolve file path cache. &return.falseforfailure; - - - The array returned by this function contains the following elements: - - - - memory_total - amount of memory in bytes allocated for the resolve file path cache - - - - - memory_free - amount of free memory in bytes available for the resolve file path cache - - - - - num_used_blks - number of memory blocks used by the resolve file path cache - - - - - num_free_blks - number of free memory blocks available for the resolve file path cache - - - - - memory_overhead - amount of memory in bytes used for the internal structures of resolve file path cache - - - - - - - - &reftitle.examples; - - - A <function>wincache_rplist_meminfo</function> example - - - - - -]]> - - &example.outputs; - - 9437184 - [memory_free] => 9416744 - [num_used_blks] => 23 - [num_free_blks] => 1 - [memory_overhead] => 416 -) -]]> - - - - - - - &reftitle.seealso; - - - wincache_fcache_fileinfo - wincache_fcache_meminfo - wincache_ocache_fileinfo - wincache_ocache_meminfo - wincache_rplist_fileinfo - wincache_refresh_if_changed - wincache_ucache_meminfo - wincache_ucache_info - wincache_scache_info - wincache_scache_meminfo - - - - - - - diff --git a/reference/wincache/functions/wincache-scache-info.xml b/reference/wincache/functions/wincache-scache-info.xml deleted file mode 100644 index 00de668e4a2a..000000000000 --- a/reference/wincache/functions/wincache-scache-info.xml +++ /dev/null @@ -1,198 +0,0 @@ - - - - - wincache_scache_info - - Retrieves information about files cached in the session cache - - - - &reftitle.description; - - arrayfalsewincache_scache_info - boolsummaryonly&false; - - - Retrieves information about session cache content and its usage. - - - - &reftitle.parameters; - - - - summaryonly - - - Controls whether the returned array will contain information about individual cache entries - along with the session cache summary. - - - - - - - - &reftitle.returnvalues; - - Array of meta data about session cache &return.falseforfailure; - - - The array returned by this function contains the following elements: - - - - total_cache_uptime - total time in seconds that the session cache has been active - - - - - total_item_count - total number of elements that are currently in the session cache - - - - - is_local_cache - true is the cache metadata is for a local cache instance, - false if the metadata is for the global cache - - - - - total_hit_count - number of times the data has been served from the cache - - - - - total_miss_count - number of times the data has not been found in the cache - - - - - scache_entries - an array that contains the information about all the cached items: - - - - key_name - name of the key which is used to store the data - - - - - value_type - type of value stored by the key - - - - - use_time - time in seconds since the file has been accessed in the opcode cache - - - - - last_check - time in seconds since the file has been checked for modifications - - - - - ttl_seconds - time remaining for the data to live in the cache, 0 meaning infinite - - - - - age_seconds - time elapsed from the time data has been added in the cache - - - - - hitcount - number of times data has been served from the cache - - - - - - - - - - &reftitle.examples; - - - A <function>wincache_scache_info</function> example - - - - - -]]> - - &example.outputs; - - 17357 - [total_file_count] => 121 - [total_hit_count] => 36562 - [total_miss_count] => 201 - [scache_entries] => Array - ( - [1] => Array - ( - [file_name] => c:\inetpub\wwwroot\checkcache.php - [add_time] => 17356 - [use_time] => 7 - [last_check] => 10 - [hit_count] => 454 - [function_count] => 0 - [class_count] => 1 - ) - [2] => Array (...iterates for each cached file) - ) -) -]]> - - - - - - - &reftitle.seealso; - - - wincache_fcache_fileinfo - wincache_fcache_meminfo - wincache_ocache_meminfo - wincache_rplist_fileinfo - wincache_rplist_meminfo - wincache_refresh_if_changed - wincache_ucache_meminfo - wincache_ucache_info - wincache_scache_meminfo - - - - - - - diff --git a/reference/wincache/functions/wincache-scache-meminfo.xml b/reference/wincache/functions/wincache-scache-meminfo.xml deleted file mode 100644 index b54d622d4e5a..000000000000 --- a/reference/wincache/functions/wincache-scache-meminfo.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - wincache_scache_meminfo - - Retrieves information about session cache memory usage - - - - &reftitle.description; - - arrayfalsewincache_scache_meminfo - - - - Retrieves information about memory usage by session cache. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Array of meta data about session cache memory usage &return.falseforfailure; - - - The array returned by this function contains the following elements: - - - - memory_total - amount of memory in bytes allocated for the session cache - - - - - memory_free - amount of free memory in bytes available for the session cache - - - - - num_used_blks - number of memory blocks used by the session cache - - - - - num_free_blks - number of free memory blocks available for the session cache - - - - - memory_overhead - amount of memory in bytes used for the session cache internal structures - - - - - - - - &reftitle.examples; - - - A <function>wincache_scache_meminfo</function> example - - - - - -]]> - - &example.outputs; - - 5242880 - [memory_free] => 5215056 - [num_used_blks] => 6 - [num_free_blks] => 3 - [memory_overhead] => 176 -) -]]> - - - - - - - &reftitle.seealso; - - - wincache_fcache_fileinfo - wincache_fcache_meminfo - wincache_ocache_fileinfo - wincache_rplist_fileinfo - wincache_rplist_meminfo - wincache_refresh_if_changed - wincache_ucache_info - wincache_scache_info - - - - - - - diff --git a/reference/wincache/functions/wincache-ucache-add.xml b/reference/wincache/functions/wincache-ucache-add.xml deleted file mode 100644 index 6ac51d593c61..000000000000 --- a/reference/wincache/functions/wincache-ucache-add.xml +++ /dev/null @@ -1,198 +0,0 @@ - - - - - wincache_ucache_add - - Adds a variable in user cache only if variable does not already exist in the cache - - - - &reftitle.description; - - boolwincache_ucache_add - stringkey - mixedvalue - intttl0 - - - boolwincache_ucache_add - arrayvalues - mixedunusedNULL - intttl0 - - - Adds a variable in user cache, only if this variable doesn't already exist in the cache. - The added variable remains in the user cache unless its time to live expires or it is - deleted by using wincache_ucache_delete or wincache_ucache_clear functions. - - - - &reftitle.parameters; - - - - key - - - Store the variable using this key name. If a variable with same key is already present the function - will fail and return &false;. key is case sensitive. To override the value even if - key is present use wincache_ucache_set function instad. - key can also take array of name => value pairs where names will be used as keys. - This can be used to add multiple values in the cache in one operation, thus avoiding race condition. - - - - - value - - - Value of a variable to store. Value supports all data types except resources, such as file handles. - This parameter is ignored if first argument is an array. A general guidance is to pass &null; - as value while using array as key. If value is an - object, or an array containing objects, then the objects will be serialized. See - __sleep() for details on serializing objects. - - - - - values - - - Associative array of keys and values. - - - - - ttl - - - Time for the variable to live in the cache in seconds. After the value specified in ttl has passed - the stored variable will be deleted from the cache. This parameter takes a default value of 0 which means - the variable will stay in the cache unless explicitly deleted by using wincache_ucache_delete - or wincache_ucache_clear functions. - - - - - - - - &reftitle.returnvalues; - - If key is string, the function returns &true; on success and &false; on failure. - - - If key is an array, the function returns: - - - - If all the name => value pairs in the array can be set, function returns an empty array; - - - - - If all the name => value pairs in the array cannot be set, function returns &false;; - - - - - If some can be set while others cannot, function returns an array with name=>value pair for which the addition failed in the user cache. - - - - - - - &reftitle.examples; - - - <function>wincache_ucache_add</function> with <parameter>key</parameter> as a string - - -]]> - - &example.outputs; - - - - - - - - <function>wincache_ucache_add</function> with <parameter>key</parameter> as an array - - '5', 'Blue' => '6', 'yellow' => '7', 'cyan' => '8'); -var_dump(wincache_ucache_add($colors_array)); -var_dump(wincache_ucache_add($colors_array)); -var_dump(wincache_ucache_get('Blue')); -?> -]]> - - &example.outputs; - - int(-1) - ["Blue"]=> int(-1) - ["yellow"]=> int(-1) - ["cyan"]=> int(-1) -} -string(1) "6" -]]> - - - - - - - &reftitle.seealso; - - - wincache_ucache_set - wincache_ucache_get - wincache_ucache_delete - wincache_ucache_clear - wincache_ucache_exists - wincache_ucache_meminfo - wincache_ucache_info - __sleep() - - - - - - - diff --git a/reference/wincache/functions/wincache-ucache-cas.xml b/reference/wincache/functions/wincache-ucache-cas.xml deleted file mode 100644 index 68045555697a..000000000000 --- a/reference/wincache/functions/wincache-ucache-cas.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - wincache_ucache_cas - - Compares the variable with old value and assigns new value to it - - - - &reftitle.description; - - boolwincache_ucache_cas - stringkey - intold_value - intnew_value - - - Compares the variable associated with the key with old_value - and if it matches then assigns the new_value to it. - - - - &reftitle.parameters; - - - - key - - - The key that is used to store the variable in the cache. - key is case sensitive. - - - - - old_value - - - Old value of the variable pointed by key in the user cache. - The value should be of type long, otherwise the function returns - &false;. - - - - - new_value - - - New value which will get assigned to variable pointer by key if a - match is found. The value should be of type long, otherwise - the function returns &false;. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - - Using <function>wincache_ucache_cas</function> - - -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - - wincache_ucache_inc - wincache_ucache_dec - - - - - - - diff --git a/reference/wincache/functions/wincache-ucache-clear.xml b/reference/wincache/functions/wincache-ucache-clear.xml deleted file mode 100644 index 1a3826a55665..000000000000 --- a/reference/wincache/functions/wincache-ucache-clear.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - wincache_ucache_clear - - Deletes entire content of the user cache - - - - &reftitle.description; - - boolwincache_ucache_clear - - - - Clears/deletes all the values stored in the user cache. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - using <function>wincache_ucache_clear</function> - - -]]> - - &example.outputs; - - int(1) - ["red"]=> int(2) - ["orange"]=> int(4) - ["blue"]=> int(8) - ["cyan"]=> int(16) } -bool(true) -bool(false) -]]> - - - - - - - &reftitle.seealso; - - - wincache_ucache_set - wincache_ucache_add - wincache_ucache_delete - wincache_ucache_get - wincache_ucache_exists - wincache_ucache_meminfo - wincache_ucache_info - - - - - - - diff --git a/reference/wincache/functions/wincache-ucache-dec.xml b/reference/wincache/functions/wincache-ucache-dec.xml deleted file mode 100644 index 6c58a2d95ab1..000000000000 --- a/reference/wincache/functions/wincache-ucache-dec.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - wincache_ucache_dec - - Decrements the value associated with the key - - - - &reftitle.description; - - mixedwincache_ucache_dec - stringkey - intdec_by1 - boolsuccess - - - Decrements the value associated with the key by 1 or as specified - by dec_by. - - - - &reftitle.parameters; - - - - key - - - The key that was used to store the variable in the cache. - key is case sensitive. - - - - - dec_by - - - The value by which the variable associated with the key will get decremented. - If the argument is a floating point number it will be truncated to nearest integer. The variable - associated with the key should be of type long, otherwise - the function fails and returns &false;. - - - - - success - - - Will be set to &true; on success and &false; on failure. - - - - - - - - &reftitle.returnvalues; - - Returns the decremented value on success and &false; on failure. - - - - &reftitle.examples; - - - Using <function>wincache_ucache_dec</function> - - -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - - wincache_ucache_inc - wincache_ucache_cas - - - - - - - diff --git a/reference/wincache/functions/wincache-ucache-delete.xml b/reference/wincache/functions/wincache-ucache-delete.xml deleted file mode 100644 index f88438023594..000000000000 --- a/reference/wincache/functions/wincache-ucache-delete.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - wincache_ucache_delete - - Deletes variables from the user cache - - - - &reftitle.description; - - boolwincache_ucache_delete - mixedkey - - - Deletes the elements in the user cache pointed by key. - - - - &reftitle.parameters; - - - - key - - - The key that was used to store the variable in the cache. - key is case sensitive. key can be an - array of keys. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - If key is an array then the function returns &false; - if every element of the array fails to get deleted from the user cache, otherwise returns an - array which consists of all the keys that are deleted. - - - - &reftitle.examples; - - - Using <function>wincache_ucache_delete</function> with <parameter>key</parameter> as a string - - -]]> - - &example.outputs; - - - - - - - - Using<function>wincache_ucache_delete</function> with <parameter>key</parameter> as an array - - '5', 'blue' => '6', 'yellow' => '7', 'cyan' => '8'); -wincache_ucache_set($array1); -$array2 = array('green', 'blue', 'yellow', 'cyan'); -var_dump(wincache_ucache_delete($array2)); -?> -]]> - - &example.outputs; - - string(5) "green" - [1]=> string(4) "blue" - [2]=> string(6) "yellow" - [3]=> string(4) "cyan" } -]]> - - - - - - Using <function>wincache_ucache_delete</function> with <parameter>key</parameter> as an array where some elements cannot be deleted - - '5', 'blue' => '6', 'yellow' => '7', 'cyan' => '8'); -wincache_ucache_set($array1); -$array2 = array('orange', 'red', 'yellow', 'cyan'); -var_dump(wincache_ucache_delete($array2)); -?> -]]> - - &example.outputs; - - string(6) "yellow" - [1]=> string(4) "cyan" } -]]> - - - - - - &reftitle.seealso; - - - wincache_ucache_set - wincache_ucache_add - wincache_ucache_get - wincache_ucache_clear - wincache_ucache_exists - wincache_ucache_meminfo - wincache_ucache_info - - - - - - - diff --git a/reference/wincache/functions/wincache-ucache-exists.xml b/reference/wincache/functions/wincache-ucache-exists.xml deleted file mode 100644 index 0b8454915311..000000000000 --- a/reference/wincache/functions/wincache-ucache-exists.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - wincache_ucache_exists - - Checks if a variable exists in the user cache - - - - &reftitle.description; - - boolwincache_ucache_exists - stringkey - - - Checks if a variable with the key exists in the user cache or not. - - - - &reftitle.parameters; - - - - key - - - The key that was used to store the variable in the cache. - key is case sensitive. - - - - - - - - &reftitle.returnvalues; - - Returns &true; if variable with the key exitsts, - otherwise returns &false;. - - - - &reftitle.examples; - - - Using <function>wincache_ucache_exists</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - - wincache_ucache_set - wincache_ucache_add - wincache_ucache_get - wincache_ucache_clear - wincache_ucache_delete - wincache_ucache_meminfo - wincache_ucache_info - - - - - - - diff --git a/reference/wincache/functions/wincache-ucache-get.xml b/reference/wincache/functions/wincache-ucache-get.xml deleted file mode 100644 index 88651f80dab1..000000000000 --- a/reference/wincache/functions/wincache-ucache-get.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - wincache_ucache_get - - Gets a variable stored in the user cache - - - - &reftitle.description; - - mixedwincache_ucache_get - mixedkey - boolsuccess - - - Gets a variable stored in the user cache. - - - - &reftitle.parameters; - - - - key - - - The key that was used to store the variable in the cache. - key is case sensitive. key can be an - array of keys. In this case the return value will be an array of values of each element - in the key array. If an object, or an array containing objects, - is returned, then the objects will be unserialized. See - __wakeup() for details on unserializing objects. - - - - - success - - - Will be set to &true; on success and &false; on failure. - - - - - - - - &reftitle.returnvalues; - - If key is a string, the function returns the value of the variable stored with that key. - The success is set to &true; on success and - to &false; on failure. - - - The key is an array, the parameter success - is always set to &true;. The returned array (name => value pairs) will - contain only those name => value pairs for which the get operation in user cache was - successful. If none of the keys in the key array finds a match in the user cache - an empty array will be returned. - - - - &reftitle.examples; - - - <function>wincache_ucache_get</function> with <parameter>key</parameter> as a string - - -]]> - - &example.outputs; - - - - - - - - <function>wincache_ucache_get</function> with <parameter>key</parameter> as an array - - '5', 'Blue' => '6', 'yellow' => '7', 'cyan' => '8'); -wincache_ucache_set($array1); -$array2 = array('green', 'Blue', 'yellow', 'cyan'); -var_dump(wincache_ucache_get($array2, $success)); -var_dump($success); -?> -]]> - - &example.outputs; - - string(1) "5" - ["Blue"]=> string(1) "6" - ["yellow"]=> string(1) "7" - ["cyan"]=> string(1) "8" } -bool(true) -]]> - - - - - - - &reftitle.seealso; - - - wincache_ucache_add - wincache_ucache_set - wincache_ucache_delete - wincache_ucache_clear - wincache_ucache_exists - wincache_ucache_meminfo - wincache_ucache_info - __wakeup() - - - - - - - diff --git a/reference/wincache/functions/wincache-ucache-inc.xml b/reference/wincache/functions/wincache-ucache-inc.xml deleted file mode 100644 index 9d52ecfd72ca..000000000000 --- a/reference/wincache/functions/wincache-ucache-inc.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - wincache_ucache_inc - - Increments the value associated with the key - - - - &reftitle.description; - - mixedwincache_ucache_inc - stringkey - intinc_by1 - boolsuccess - - - Increments the value associated with the key by 1 or as specified - by inc_by. - - - - &reftitle.parameters; - - - - key - - - The key that was used to store the variable in the cache. - key is case sensitive. - - - - - inc_by - - - The value by which the variable associated with the key will get incremented. - If the argument is a floating point number it will be truncated to nearest integer. The variable - associated with the key should be of type long, otherwise - the function fails and returns &false;. - - - - - success - - - Will be set to &true; on success and &false; on failure. - - - - - - - - &reftitle.returnvalues; - - Returns the incremented value on success and &false; on failure. - - - - &reftitle.examples; - - - Using <function>wincache_ucache_inc</function> - - -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - - wincache_ucache_dec - wincache_ucache_cas - - - - - - - diff --git a/reference/wincache/functions/wincache-ucache-info.xml b/reference/wincache/functions/wincache-ucache-info.xml deleted file mode 100644 index 0420be82f000..000000000000 --- a/reference/wincache/functions/wincache-ucache-info.xml +++ /dev/null @@ -1,213 +0,0 @@ - - - - - wincache_ucache_info - - Retrieves information about data stored in the user cache - - - - &reftitle.description; - - arrayfalsewincache_ucache_info - boolsummaryonly&false; - stringkeyNULL - - - Retrieves information about data stored in the user cache. - - - - &reftitle.parameters; - - - - summaryonly - - - Controls whether the returned array will contain information about individual cache entries - along with the user cache summary. - - - - - key - - - The key of an entry in the user cache. If specified then the returned array will contain information - only about that cache entry. If not specified and summaryonly is set to - &false; then the returned array will contain information about all entries in the cache. - - - - - - - - &reftitle.returnvalues; - - Array of meta data about user cache &return.falseforfailure; - - - The array returned by this function contains the following elements: - - - - total_cache_uptime - total time in seconds that the user cache has been active - - - - - total_item_count - total number of elements that are currently in the user cache - - - - - is_local_cache - true is the cache metadata is for a local cache instance, - false if the metadata is for the global cache - - - - - total_hit_count - number of times the data has been served from the cache - - - - - total_miss_count - number of times the data has not been found in the cache - - - - - ucache_entries - an array that contains the information about all the cached items: - - - - key_name - name of the key which is used to store the data - - - - - value_type - type of value stored by the key - - - - - use_time - time in seconds since the file has been accessed in the opcode cache - - - - - last_check - time in seconds since the file has been checked for modifications - - - - - is_session - indicates if the data is a session variable - - - - - ttl_seconds - time remaining for the data to live in the cache, 0 meaning infinite - - - - - age_seconds - time elapsed from the time data has been added in the cache - - - - - hitcount - number of times data has been served from the cache - - - - - - - - - - &reftitle.examples; - - - Using <function>wincache_ucache_info</function> - - -]]> - - &example.outputs; - - int(0) - ["is_local_cache"] => bool(false) - ["total_item_count"] => int(1) - ["total_hit_count"] => int(3) - ["total_miss_count"] => int(1) - ["ucache_entries"] => Array(1) - ( [1] => Array(6) - ( - ["key_name"] => string(5) "green" - ["value_type"] => string(4) "long" - ["is_session"] => int(0) - ["ttl_seconds"] => int(0) - ["age_seconds"] => int(0) - ["hitcount"] => int(3) - ) - ) -) -]]> - - - - - - - &reftitle.seealso; - - - wincache_fcache_meminfo - wincache_ocache_fileinfo - wincache_ocache_meminfo - wincache_rplist_meminfo - wincache_rplist_fileinfo - wincache_refresh_if_changed - wincache_ucache_meminfo - wincache_scache_info - wincache_scache_meminfo - - - - - - - diff --git a/reference/wincache/functions/wincache-ucache-meminfo.xml b/reference/wincache/functions/wincache-ucache-meminfo.xml deleted file mode 100644 index 82d406c2a6cf..000000000000 --- a/reference/wincache/functions/wincache-ucache-meminfo.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - wincache_ucache_meminfo - - Retrieves information about user cache memory usage - - - - &reftitle.description; - - arrayfalsewincache_ucache_meminfo - - - - Retrieves information about memory usage by user cache. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Array of meta data about user cache memory usage &return.falseforfailure; - - - The array returned by this function contains the following elements: - - - - memory_total - amount of memory in bytes allocated for the user cache - - - - - memory_free - amount of free memory in bytes available for the user cache - - - - - num_used_blks - number of memory blocks used by the user cache - - - - - num_free_blks - number of free memory blocks available for the user cache - - - - - memory_overhead - amount of memory in bytes used for the user cache internal structures - - - - - - - - &reftitle.examples; - - - A <function>wincache_ucache_meminfo</function> example - - - - - -]]> - - &example.outputs; - - 5242880 - [memory_free] => 5215056 - [num_used_blks] => 6 - [num_free_blks] => 3 - [memory_overhead] => 176 -) -]]> - - - - - - - &reftitle.seealso; - - - wincache_fcache_fileinfo - wincache_fcache_meminfo - wincache_ocache_fileinfo - wincache_rplist_fileinfo - wincache_rplist_meminfo - wincache_refresh_if_changed - wincache_ucache_info - wincache_scache_info - wincache_scache_meminfo - - - - - - - diff --git a/reference/wincache/functions/wincache-ucache-set.xml b/reference/wincache/functions/wincache-ucache-set.xml deleted file mode 100644 index 3e38b75d139c..000000000000 --- a/reference/wincache/functions/wincache-ucache-set.xml +++ /dev/null @@ -1,197 +0,0 @@ - - - - - wincache_ucache_set - - Adds a variable in user cache and overwrites a variable if it already exists in the cache - - - - &reftitle.description; - - boolwincache_ucache_set - mixedkey - mixedvalue - intttl0 - - - boolwincache_ucache_set - arrayvalues - mixedunusedNULL - intttl0 - - - Adds a variable in user cache. Overwrites a variable if it already exists in the cache. - The added or updated variable remains in the user cache unless its time to live expires or it is - deleted by using wincache_ucache_delete or wincache_ucache_clear functions. - - - - &reftitle.parameters; - - - - key - - - Store the variable using this key name. If a variable with same - key is already present the function will overwrite the previous - value with the new one. key is case sensitive. - key can also take array of name => value pairs where names will be used as - keys. This can be used to add multiple values in the cache in one operation, thus avoiding - race condition. - - - - - value - - - Value of a variable to store. Value supports all data types except resources, such as file handles. - This parameter is ignored if first argument is an array. A general guidance is to pass &null; - as value while using array as key. If value is an - object, or an array containing objects, then the objects will be serialized. See - __sleep() for details on serializing objects. - - - - - values - - - Associative array of keys and values. - - - - - ttl - - - Time for the variable to live in the cache in seconds. After the value specified in ttl has passed - the stored variable will be deleted from the cache. This parameter takes a default value of 0 which means - the variable will stay in the cache unless explicitly deleted by using wincache_ucache_delete - or wincache_ucache_clear functions. - - - - - - - - &reftitle.returnvalues; - - If key is string, the function returns &true; on success and &false; on failure. - - - If key is an array, the function returns: - - - - If all the name => value pairs in the array can be set, function returns an empty array; - - - - - If all the name => value pairs in the array cannot be set, function returns &false;; - - - - - If some can be set while others cannot, function returns an array with name=>value pair for which the addition failed in the user cache. - - - - - - - &reftitle.examples; - - - <function>wincache_ucache_set</function> with <parameter>key</parameter> as a string - - -]]> - - &example.outputs; - - - - - - - - <function>wincache_ucache_set</function> with <parameter>key</parameter> as an array - - '5', 'Blue' => '6', 'yellow' => '7', 'cyan' => '8'); -var_dump(wincache_ucache_set($colors_array)); -var_dump(wincache_ucache_set($colors_array)); -var_dump(wincache_ucache_get('Blue')); -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - - wincache_ucache_add - wincache_ucache_get - wincache_ucache_delete - wincache_ucache_clear - wincache_ucache_exists - wincache_ucache_meminfo - wincache_ucache_info - __sleep() - - - - - - - diff --git a/reference/wincache/functions/wincache-unlock.xml b/reference/wincache/functions/wincache-unlock.xml deleted file mode 100644 index 7b2ec9f31f6b..000000000000 --- a/reference/wincache/functions/wincache-unlock.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - wincache_unlock - - Releases an exclusive lock on a given key - - - - &reftitle.description; - - boolwincache_unlock - stringkey - - - Releases an exclusive lock that was obtained on a given key by using wincache_lock. - If any other process was blocked waiting for the lock on this key, that process will be able to obtain - the lock. - - - - Using of the wincache_lock and wincache_unlock can cause deadlocks when - executing PHP scripts in a multi-process environment like FastCGI. Do not use these functions unless you are - absolutely sure you need to use them. For the majority of the operations on the user cache it is not necessary to - use these functions. - - - - - &reftitle.parameters; - - - - key - - - Name of the key in the cache to release the lock on. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - - Using <function>wincache_unlock</function> - - -]]> - - - - - - - &reftitle.seealso; - - - wincache_lock - wincache_ucache_set - wincache_ucache_get - wincache_ucache_delete - wincache_ucache_clear - wincache_ucache_exists - wincache_ucache_meminfo - wincache_ucache_info - wincache_scache_info - - - - - - - diff --git a/reference/wincache/ini.xml b/reference/wincache/ini.xml deleted file mode 100644 index 4125bcd7c818..000000000000 --- a/reference/wincache/ini.xml +++ /dev/null @@ -1,518 +0,0 @@ - - -
    - &reftitle.runtime; - &extension.runtime; - - The following table lists and explains the configuration settings - provided by the WinCache extension: - - - - WinCache configuration options - - - - &Name; - &Default; - Minimum - Maximum - &Changeable; - &Changelog; - - - - - wincache.fcenabled - "1" - "0" - "1" - INI_ALL - Available as of WinCache 1.0.0 - - - wincache.fcenabledfilter - "NULL" - "NULL" - "NULL" - INI_SYSTEM - Available as of WinCache 1.0.0 - - - wincache.fcachesize - "24" - "5" - "255" - INI_SYSTEM - Available as of WinCache 1.0.0 - - - wincache.fcndetect - "1" - "0" - "1" - INI_SYSTEM - Available as of WinCache 1.1.0 - - - wincache.maxfilesize - "256" - "10" - "2048" - INI_SYSTEM - Available as of WinCache 1.0.0 - - - wincache.ocenabled - "1" - "0" - "1" - INI_ALL - Available as of WinCache 1.0.0. Removed as of 2.0.0.0 - - - wincache.ocenabledfilter - "NULL" - "NULL" - "NULL" - INI_SYSTEM - Available as of WinCache 1.0.0. Removed as of 2.0.0.0 - - - wincache.ocachesize - "96" - "15" - "255" - INI_SYSTEM - Available as of WinCache 1.0.0. Removed as of 2.0.0.0 - - - wincache.filecount - "4096" - "1024" - "16384" - INI_SYSTEM - Available as of WinCache 1.0.0 - - - wincache.chkinterval - "30" - "0" - "300" - INI_SYSTEM - Available as of WinCache 1.0.0 - - - wincache.ttlmax - "1200" - "0" - "7200" - INI_SYSTEM - Available as of WinCache 1.0.0 - - - wincache.enablecli - 0 - 0 - 1 - INI_SYSTEM - Available as of WinCache 1.0.0 - - - wincache.ignorelist - NULL - NULL - NULL - INI_ALL - Available as of WinCache 1.0.0 - - - wincache.namesalt - NULL - NULL - NULL - INI_SYSTEM - Available as of WinCache 1.0.0 - - - wincache.ucenabled - 1 - 0 - 1 - INI_SYSTEM - Available as of WinCache 1.1.0 - - - wincache.ucachesize - 8 - 5 - 85 - INI_SYSTEM - Available as of WinCache 1.1.0 - - - wincache.scachesize - 8 - 5 - 85 - INI_SYSTEM - Available as of WinCache 1.1.0 - - - wincache.rerouteini - NULL - NULL - NULL - INI_SYSTEM - Available as of WinCache 1.2.0. Removed as of 1.3.7 - - - wincache.reroute_enabled - 1 - 0 - 1 - INI_SYSTEM|INI_PERDIR - Available as of WinCache 1.3.7 - - - wincache.srwlocks - 1 - 0 - 1 - INI_SYSTEM - Available as of WinCache 1.3.6.3. Removed as of 2.0.0.0 - - - wincache.filemapdir - NULL - NULL - NULL - INI_SYSTEM - Available as of WinCache 1.3.7.4 - - - -
    - &ini.php.constants; -
    - - &ini.descriptions.title; - - - - - - wincache.fcenabled - bool - - - Enables or disables the file cache functionality. - - - - - wincache.fcenabledfilter - string - - - - Defines a comma-separated list of IIS web site identifiers where file - cache should be enabled or disabled. This setting works in conjunction - with wincache.fcenabled: if wincache.fcenabled - is set to 1, then the sites listed in the wincache.fcenabledfilter - will have the file cache turned off; if wincache.fcenabled - is set to 0, then the sites listed in the wincache.fcenabledfilter - will have the file cache turned on. - - - - - - wincache.fcachesize - int - - - - Defines the maximum memory size (in megabytes) that is allocated for the file cache. - If the total size of all the cached files exceeds the value specified in this setting, - then most stale files will be removed from the file cache. - - - - - - wincache.fcndetect - bool - - - - Enables or disables the file change notification detection functionality. If file change - notification is supported then it will be used to refresh the opcode and file cache entries - as soon as the corresponding files are modified on a file system. If file change notification - is not supported, for example when using network file shares, then wincache will poll for - file changes at regular time intervals specified by wincache.chkinterval. - - - - - - wincache.maxfilesize - int - - - - Defines the maximum allowed size (in kilobytes) for a single file to be cached. - If a file size exceeds the specified value, the file will not be cached. - This setting applies to the file cache only. - - - - - - wincache.ocenabled - bool - - - This option has been REMOVED as of 2.0.0.0 - Enables or disables the opcode cache functionality - - - - - wincache.ocenabledfilter - string - - - This option has been REMOVED as of 2.0.0.0 - - Defines a comma-separated list of IIS web site identifiers where opcode - cache should be enabled or disabled. This setting works in conjunction - with wincache.ocenabled: if wincache.ocenabled - is set to 1, then the sites listed in the wincache.ocenabledfilter - will have the opcode cache turned off; if wincache.ocenabled - is set to 0, then the sites listed in the wincache.ocenabledfilter - will have the opcode cache turned on. - - - - - - wincache.ocachesize - int - - - This option has been REMOVED as of 2.0.0.0 - - Defines the maximum memory size (in megabytes) that is allocated for the - opcode cache. If the cached opcode size exceeds the specified value, - then most stale opcode will be removed from the cache. Note that the opcode - cache size must be at least 3 times bigger than file cache size. - If that is not the case the opcode cache size will be automatically increased. - - - - - - wincache.filecount - int - - - - Defines how many files are expected to be cached by the extension, so that appropriate - memory size is allocated at the startup time. If the number of files exceeds the specified - value, the WinCache will re-allocate more memory as needed. - - - - - - wincache.chkinterval - int - - - - Defines how often (in seconds) the extension checks for file changes in order - to refresh the cache. Setting it to 0 will disable the refreshing of the cache. - The file changes will not be reflected in the cache unless the cache entry for - that file is removed by scavenger or IIS application pool is recycled or - wincache_refresh_if_changed function is called. - - - - - - wincache.ttlmax - int - - - - Defines the maximum time to live (in seconds) for a cached entry without being used. - Setting it to 0 will disable the cache scavenger, so the cached entries will never - be removed from the cache during the lifetime of the IIS worker process. - - - - - - wincache.enablecli - bool - - - - Defines if caching is enabled when PHP is running in command line (CLI) mode. - - - - - - wincache.ignorelist - string - - - - Defines a list of files that should not be cached by the extension. - The files list is specified by using file names only, separated by - the pipe symbol - "|". - - <literal>wincache.ignorelist</literal> example - - - - - - - - - - wincache.namesalt - string - - - - Defines a string that will be used when naming the extension - specific objects that are stored in shared memory. This is used - to avoid conflicts that may be caused if other applications within - an IIS worker process tries to access shared memory. The length of - the namesalt string cannot exceed 8 characters. - - - - - - wincache.ucenabled - bool - - - - Enables or disables the user cache functionality. - - - - - - wincache.ucachesize - int - - - - Defines the maximum memory size in megabytes that is allocated for the user cache. If the total - size of variables stored in the user cache exceeds the specified value, then the most stale variables - will be removed from the cache. - - - - - - wincache.scachesize - int - - - - Defines the maximum memory size in megabytes that is allocated for the session cache. If the total - size of data stored in the session cache exceeds the specified value, then the most stale data - will be removed from the cache. - - - - - - wincache.rerouteini - string - - - - This option has been REMOVED as of 1.3.7. See wincache.reroute_enabled for similar functionality as of 1.3.7. - - - Specifies an absolute or a relateve path to the reroute.ini file that contains the list of PHP functions - whose implementation should be replaced with the WinCache function equivalents. If a relative path is specified - then it is assumed to be relative to the location of php-cgi.exe file. - - - - - - wincache.reroute_enabled - bool - - - - Enables or disables the rerouting of certain file I/O functions through the file cache. - - - - - - wincache.srwlocks - bool - - - This option has been REMOVED as of 2.0.0.0 - - Enables or disables the use of shared reader/writer locks. Disabling is useful when troubleshooting deadlock conditions in WinCache. - - - - - - wincache.filemapdir - string - - - - Specifies an absolute path to a directory where WinCache will store the temporary files used for shared memory segments. - - - This directory must be on the local machine and not on a networked file system. - - - If the directory is not specified, WinCache will use the Windows System Page File for all shared memory segments. - - - - - -
    - - diff --git a/reference/wincache/reference.xml b/reference/wincache/reference.xml deleted file mode 100644 index eaeb30804734..000000000000 --- a/reference/wincache/reference.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - WinCache &Functions; - - &reference.wincache.entities.functions; - - - - - diff --git a/reference/wincache/setup.xml b/reference/wincache/setup.xml deleted file mode 100644 index 3b80e64cc4f2..000000000000 --- a/reference/wincache/setup.xml +++ /dev/null @@ -1,345 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - The extension is currently supported only on the following configurations: - - Windows OS: - - - Windows XP SP3 with IIS 5.1 and FastCGI Extension - - - Windows Server 2003 with IIS 6.0 and FastCGI Extension - - - Windows Vista SP1 with IIS 7.0 and FastCGI Module - - - Windows Server 2008 with IIS 7.0 and FastCGI Module - - - Windows 7 with IIS 7.5 and FastCGI Module - - - Windows Server 2008 R2 with IIS 7.5 and FastCGI Module - - - PHP: - - - PHP 5.2.X, Non-thread-safe build - - - PHP 5.3 X86, Non-thread-safe VC9 build - - - - - The WinCache Extension can only be used when IIS is configured to run PHP via FastCGI. - - -
    -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;wincache. - - - There are two packages for this extension: one package is for PHP versions 5.2.X, - and the other package is for PHP 5.3.X. Select the package that is appropriate for - the PHP version being used. - - - To install and enable the extension, follow these steps: - - - - - Unpack the package into some temporary location. - - - - - Copy the php_wincache.dll file into the PHP extensions folder. - Typically this folder is called "ext" and it is located in the same folder with all - PHP binary files. For example: C:\Program Files\PHP\ext. - - - - - Using a text editor, open the php.ini file, which is usually located in the - same folder where all PHP binary files are. For example: - C:\Program Files\PHP\php.ini. - - - - - Add the following line at the end of the php.ini file: - extension = php_wincache.dll. - - - - - Save and close the php.ini file. - - - - - Recycle the IIS Application Pools for PHP to pick up the configuration changes. - To check that the extension has been enabled, create a file called - phpinfo.php with a PHP code that calls - phpinfo function. - - - - - Save the phpinfo.php file in the root folder of a - IIS web site that uses PHP, then open a browser and make a request to - http://localhost/phpinfo.php. Search within the returned web page - for a section called wincache. If the extension - is enabled, then the phpinfo - output will list the configuration settings provided by the WinCache. - - - - - - Do not forget to remove phpinfo.php file from the web - site's root folder after verifying that extension has been enabled. - - -
    - &reference.wincache.ini; - -
    - WinCache Statistics Script - - The installation package for WinCache includes a PHP script, - wincache.php, that can be used to obtain cache information - and statistics. - - - If the WinCache extension was installed via the Microsoft Web Platform Installer, - then this script is located in - %SystemDrive%\Program Files\IIS\Windows Cache for PHP\. - On a 64-bit version of the Windows Server operating system, the script is located in - %SystemDrive%\Program Files (x86)\IIS\Windows Cache for PHP. - If the extension was installed manually, then the wincache.php - will be located in the same folder from which the content of the installation package was extracted. - - - To use wincache.php, copy it into a root folder of a Web site or - into any subfolder. To protect the script, open it in any text editor and replace the values for - USERNAME and PASSWORD constants. - If any other IIS authentication is enabled on the server, then - follow the instructions in the comments: - - Authentication configuration for <filename>wincache.php</filename> - - -]]> - - - - - Always protect the wincache.php script by using either - the built-in authentication or the server's authentication mechanism. - Leaving this script unprotected may compromise the security of your - web application and web server. - - - -
    -
    - WinCache Session Handler - - The WinCache session handler (available since WinCache 1.1.0) can be used to configure PHP to store the session data in shared memory session cache. - Using shared memory instead of the default file session storage helps improve performance of PHP applications - that store large amount of data in session objects. Wincache session cache uses file-backed shared memory, which ensures - that the session data is not lost during recycling of IIS application pools. - - - To configure PHP to use WinCache session handler set the php.ini setting - session.save_handler to wincache. - By default the Windows temporary file location is used for storing the - session data. To change the location of the session file use - session.save_path directive. - - Enabling WinCache session handler - - - - - -
    -
    - WinCache Functions Reroutes - - NOTE: wincache.rerouteini was removed as of - WinCache 1.3.7.0. It has been replaced with automatic function reroutes. See: - wincache.reroute_enabled. - - - The WinCache functions reroutes (available since WinCache 1.2.0, removed since WinCache 1.3.7.0) can be used to replace built-in PHP functions with their equivalents - that are optimized for a particular purpose. WinCache extension includes Windows-optimized implementation of PHP file functions that - may improve performance of PHP applications in cases when PHP has to access files on network shares. The optimized implementation is - provided for the following functions: - - - - - file_exists - - - - - file_get_contents - - - - - readfile - - - - - is_readable - - - - - is_writable - - - - - is_dir - - - - - realpath - - - - - filesize - - - - - To configure WinCache to use the functions reroutes use the file reroute.ini that is included in - WinCache installation package. Copy this file into the same directory where php.ini - file is located. After that add the wincache.rerouteini setting in php.ini - and specify an absolute or relative path to the reroute.ini file. - - Enabling WinCache functions reroutes - - - - - - - - If WinCache functions reroutes are enabled it is recommended to increase the WinCache file cache size. This - can be done by using wincache.fcachesize setting. - - - - The reroute.ini file contains the mappings between the native PHP functions and - their equivalents in WinCache. Each line in the file defines a mapping by using the following syntax: - - - <PHP function name>:[<number of function parameters>]=<wincache function name> - - - The example of the file is shown below. In this example the calls to PHP function file_get_contents - will be replaced with calls to wincache_file_get_contents only if the number of parameters passed to - the function is less than or equals to 2. Specifying the number of parameters is useful when replacement function - does not handle all the function's parameters. - - Reroute.ini file content - - - - - -
    -
    - - - diff --git a/reference/wincache/versions.xml b/reference/wincache/versions.xml deleted file mode 100644 index d75879822cc4..000000000000 --- a/reference/wincache/versions.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/wincache/win32build.xml b/reference/wincache/win32build.xml deleted file mode 100644 index 4b16fdcaacd7..000000000000 --- a/reference/wincache/win32build.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - Building for Windows -
    - Prerequisites - - Building WinCache extension will require: - - - - PHP source code - - - PHP build environment - - - WinCache source code - - - - For completing first two steps, follow the step-by-step guide for how - to build PHP on Windows. - - - For getting the WinCache source code follow the instructions described in - Downloading PECL extensions. - -
    -
    - Compiling and building - - The following steps describe how to compile and build WinCache on Windows OS: - - - - Open a command prompt which is used to build PHP - - - Go to the root folder where PHP sources are present - - - - Run the command: - - - - - - - - Run the command: - - - - The output will contain a new flag --enable-wincache. - - - - - Run the command: - - - - --enable-wincache is the only extra option which is - required to ensure that WinCache extension gets built properly. - This option will build WinCache and will statically link it with PHP dll. - To build WinCache extension as a stand-alone DLL use the option - --enable-wincache=shared. - - - - - Run the command: - - - - - - -
    -
    - Verifying the build - - The following steps describe how to verify that WinCache has been built correctly: - - - - - Go to the folder where the PHP binaries are built - - - - - Run the command: - - - - If WinCache has been built properly, the output of this command will - list the INI directives and functions supported by WinCache. - - - -
    -
    - - diff --git a/reference/wkhtmltox/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/wkhtmltox/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/wkhtmltox/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/wkhtmltox/book.xml b/reference/wkhtmltox/book.xml deleted file mode 100644 index 4a79d0cc5f3c..000000000000 --- a/reference/wkhtmltox/book.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - - wkhtmltox - wkhtmltox - - - &reftitle.intro; - - libwkhtmltox is an open source LGPLv3 library for rendering HTML into PDF and various image formats - using the QtWebKit rendering engine. - - - - &reference.wkhtmltox.setup; - - &reference.wkhtmltox.wkhtmltox.pdf.converter; - &reference.wkhtmltox.wkhtmltox.pdf.object; - - &reference.wkhtmltox.wkhtmltox.image.converter; - - diff --git a/reference/wkhtmltox/configure.xml b/reference/wkhtmltox/configure.xml deleted file mode 100644 index 89005f44e28d..000000000000 --- a/reference/wkhtmltox/configure.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - -
    - &reftitle.install; - - - Use when compiling PHP. - - - -
    - - - diff --git a/reference/wkhtmltox/ini.xml b/reference/wkhtmltox/ini.xml deleted file mode 100644 index fbdce8e2e311..000000000000 --- a/reference/wkhtmltox/ini.xml +++ /dev/null @@ -1,72 +0,0 @@ - - -
    - &reftitle.runtime; - &extension.runtime; - - - wkhtmltox &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - wkhtmltox.graphics - Off - INI_SYSTEM|INI_PERDIR - >= 0.3.2 - - - -
    - &ini.php.constants; -
    - - &ini.descriptions.title; - - - - - - wkhtmltox.graphics - bool - - - - Allow libwkhtmltox to use graphics. - - - - - - -
    - - - - diff --git a/reference/wkhtmltox/setup.xml b/reference/wkhtmltox/setup.xml deleted file mode 100644 index 6cdba5992853..000000000000 --- a/reference/wkhtmltox/setup.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - libwkhtmltox source and binary releases are distributed at wkhtmltopdf.org. - - - - Windows users need to take the additional step of adding wkhtmltox.dll to their PATH. - - -
    - -
    - &reftitle.install; - - The source code of this extension, and binaries for Windows are hosted by github, - - - Fetching the source code and building the extension: - - - - - - Fetching updates and rebuilding the extension: - - - - -
    - - &reference.wkhtmltox.ini; -
    - - diff --git a/reference/wkhtmltox/versions.xml b/reference/wkhtmltox/versions.xml deleted file mode 100644 index f6c0561a5b94..000000000000 --- a/reference/wkhtmltox/versions.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/wkhtmltox/wkhtmltox.image.converter.xml b/reference/wkhtmltox/wkhtmltox.image.converter.xml deleted file mode 100644 index 5b7c4474e9d2..000000000000 --- a/reference/wkhtmltox/wkhtmltox.image.converter.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - The wkhtmltox\Image\Converter class - wkhtmltox\Image\Converter - - - - -
    - &reftitle.intro; - - Converts an HTML input into various image formats - -
    - - -
    - &reftitle.classsynopsis; - - - - wkhtmltox\Image\Converter - - - - - wkhtmltox\Image\Converter - - - - - Constructor - - - &Methods; - - - - -
    - -
    - - &reference.wkhtmltox.wkhtmltox.image.entities.converter; - -
    - - diff --git a/reference/wkhtmltox/wkhtmltox.pdf.converter.xml b/reference/wkhtmltox/wkhtmltox.pdf.converter.xml deleted file mode 100644 index 8fdf42f543c5..000000000000 --- a/reference/wkhtmltox/wkhtmltox.pdf.converter.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - The wkhtmltox\PDF\Converter class - wkhtmltox\PDF\Converter - - - - -
    - &reftitle.intro; - - Converts an HTML input, or set of HTML inputs, into PDF output - -
    - - -
    - &reftitle.classsynopsis; - - - - wkhtmltox\PDF\Converter - - - - - wkhtmltox\PDF\Converter - - - - - Constructor - - - &Methods; - - - - -
    - -
    - - &reference.wkhtmltox.wkhtmltox.pdf.entities.converter; - -
    - - diff --git a/reference/wkhtmltox/wkhtmltox.pdf.object.xml b/reference/wkhtmltox/wkhtmltox.pdf.object.xml deleted file mode 100644 index f27a3071835b..000000000000 --- a/reference/wkhtmltox/wkhtmltox.pdf.object.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - The wkhtmltox\PDF\Object class - wkhtmltox\PDF\Object - - - - -
    - &reftitle.intro; - - Represents an HTML document, input to PDF converter - -
    - - -
    - &reftitle.classsynopsis; - - - - wkhtmltox\PDF\Object - - - - - wkhtmltox\PDF\Object - - - - - Constructor - - - - - - -
    - -
    - - &reference.wkhtmltox.wkhtmltox.pdf.entities.object; - -
    - - diff --git a/reference/wkhtmltox/wkhtmltox/image/converter/construct.xml b/reference/wkhtmltox/wkhtmltox/image/converter/construct.xml deleted file mode 100644 index c865a7398e8f..000000000000 --- a/reference/wkhtmltox/wkhtmltox/image/converter/construct.xml +++ /dev/null @@ -1,195 +0,0 @@ - - - - - - wkhtmltox\Image\Converter::__construct - Create a new Image converter - - - - &reftitle.description; - - public wkhtmltox\Image\Converter::__construct - stringbuffer - arraysettings - - - Creates an Image converter, optionally taking an input buffer and configuration settings - - - - - &reftitle.parameters; - - - buffer - - - HTML - - - - - settings - - - - - - - - Name - Description - Values - Changelog - - - - - in - URL or path of the input file, if "-" stdin is used - /path/to/markup.html - >= 0.1.0 - - - out - path of output file, if "-" stdout is used, by default an internal buffer is used - /path/to/output.png - >= 0.1.0 - - - fmt - output format to use - -
    - - - - - "" - default - - - jpg - output as JPEG - - - png - output as PNG - - - bmp - output as bitmap - - - svg - output as SVG - - - -
    - - >= 0.1.0 - - - transparent - when outputting a PNG or SVG, make the white background transparent - boolean - >= 0.1.0 - - - screenWidth - the with of the screen used to render in pixels - 800 - >= 0.1.0 - - - smartWidth - when true, screenWidth is expanded to the content width - boolean - >= 0.1.0 - - - quality - compression factor to use when outputting a JPEG image - 94 - >= 0.1.0 - - - crop.left - left/x coordinate of the window to capture in pixels - 200 - >= 0.1.0 - - - crop.top - top/y coordinate of the window to capture in pixels - 200 - >= 0.1.0 - - - crop.width - width of the window to capture in pixels - 200 - >= 0.1.0 - - - crop.height - height of the window to capture in pixels - 200 - >= 0.1.0 - - - load.cookieJar - path of file used to load and store cookies - /tmp/cookies.txt - >= 0.1.0 - - - - - -
    -
    -
    -
    -
    - - - - - -
    - - diff --git a/reference/wkhtmltox/wkhtmltox/image/converter/convert.xml b/reference/wkhtmltox/wkhtmltox/image/converter/convert.xml deleted file mode 100644 index 9551b82f3728..000000000000 --- a/reference/wkhtmltox/wkhtmltox/image/converter/convert.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - wkhtmltox\Image\Converter::convert - Perform Image conversion - - - - &reftitle.description; - - public stringnullwkhtmltox\Image\Converter::convert - - - - Performs conversion of the input buffer - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Where the return value is used, it will be populated with the contents of the conversion buffer - - - - - - - diff --git a/reference/wkhtmltox/wkhtmltox/image/converter/getversion.xml b/reference/wkhtmltox/wkhtmltox/image/converter/getversion.xml deleted file mode 100644 index 94f331a70912..000000000000 --- a/reference/wkhtmltox/wkhtmltox/image/converter/getversion.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - wkhtmltox\Image\Converter::getVersion - Determine version of Converter - - - - &reftitle.description; - - public stringwkhtmltox\Image\Converter::getVersion - - - - Determines the version of Converter as reported by libwkhtmltox - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a version string - - - - This is not yet implemented by libwkhtmltox - - - - - - - diff --git a/reference/wkhtmltox/wkhtmltox/pdf/converter/add.xml b/reference/wkhtmltox/wkhtmltox/pdf/converter/add.xml deleted file mode 100644 index 5b5df64f1a57..000000000000 --- a/reference/wkhtmltox/wkhtmltox/pdf/converter/add.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - wkhtmltox\PDF\Converter::add - Add an object for conversion - - - - &reftitle.description; - - public voidwkhtmltox\PDF\Converter::add - wkhtmltox\PDF\Objectobject - - - Adds the given object to conversion - - - - - &reftitle.parameters; - - - object - - - The object to add - - - - - - - - - - - diff --git a/reference/wkhtmltox/wkhtmltox/pdf/converter/construct.xml b/reference/wkhtmltox/wkhtmltox/pdf/converter/construct.xml deleted file mode 100644 index 2c50157feeb6..000000000000 --- a/reference/wkhtmltox/wkhtmltox/pdf/converter/construct.xml +++ /dev/null @@ -1,249 +0,0 @@ - - - - - - wkhtmltox\PDF\Converter::__construct - Create a new PDF converter - - - - &reftitle.description; - - public wkhtmltox\PDF\Converter::__construct - arraysettings - - - Creates a PDF converter, using optional configuration settings - - - - - &reftitle.parameters; - - - settings - - - - - - - - Name - Description - Values - Changelog - - - - - size.pageSize - paper size of output document - A4 - >= 0.1.0 - - - size.width - with of the output document - 210mm - >= 0.1.0 - - - size.height - height of the output document - 297mm - >= 0.1.0 - - - orientation - orientation of the output document - -
    - - - - - Landscape - - - Portrait - - - -
    - - >= 0.1.0 - - - colorMode - color mode of the output document - - - - - - - Color - - - Greyscale - - - -
    -
    - >= 0.1.0 -
    - - resolution - resolution of the output document - most likely has no effect - >= 0.1.0 - - - dpi - dpi to use while printing - 80 - >= 0.1.0 - - - pageOffset - integer added to page numbers generating headers, footers, and toc - - >= 0.1.0 - - - copies - - - >= 0.1.0 - - - collate - collate copies - boolean - >= 0.1.0 - - - outline - generate PDF outline - boolean - >= 0.1.0 - - - outlineDepth - maximum depth of outline - - >= 0.1.0 - - - dumpOutline - path of file to dump outline XML - - >= 0.1.0 - - - out - path of output file, if "-" stdout is used - - >= 0.1.0 - - - documentTitle - title for the output document - - >= 0.1.0 - - - useCompression - enable or disable lossless compression - boolean - >= 0.1.0 - - - margin.top - size of the top margin - 2cm - >= 0.1.0 - - - margin.bottom - size of the bottom margin - 2cm - >= 0.1.0 - - - margin.left - size of the left margin - 2cm - >= 0.1.0 - - - margin.right - size of the right margin - 2cm - >= 0.1.0 - - - imageDPI - maximum DPI for images in the output document - - >= 0.1.0 - - - imageQuality - the jpeg compression factor for images in the output document - 94 - >= 0.1.0 - - - load.cookieJar - path of file used to load and store cookies - /tmp/cookies.txt - >= 0.1.0 - - - - -
    -
    -
    -
    -
    - - - - - -
    - - diff --git a/reference/wkhtmltox/wkhtmltox/pdf/converter/convert.xml b/reference/wkhtmltox/wkhtmltox/pdf/converter/convert.xml deleted file mode 100644 index 0b5d194366a1..000000000000 --- a/reference/wkhtmltox/wkhtmltox/pdf/converter/convert.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - wkhtmltox\PDF\Converter::convert - Perform PDF conversion - - - - &reftitle.description; - - public stringnullwkhtmltox\PDF\Converter::convert - - - - Performs conversion of all previously added Objects - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Where the return value is used, it will be populated with the contents of the conversion buffer - - - - - - - diff --git a/reference/wkhtmltox/wkhtmltox/pdf/converter/getversion.xml b/reference/wkhtmltox/wkhtmltox/pdf/converter/getversion.xml deleted file mode 100644 index 34091e28554b..000000000000 --- a/reference/wkhtmltox/wkhtmltox/pdf/converter/getversion.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - wkhtmltox\PDF\Converter::getVersion - Determine version of Converter - - - - &reftitle.description; - - public stringwkhtmltox\PDF\Converter::getVersion - - - - Determines the version of Converter as reported by libwkhtmltox - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a version string - - - - - - diff --git a/reference/wkhtmltox/wkhtmltox/pdf/object/construct.xml b/reference/wkhtmltox/wkhtmltox/pdf/object/construct.xml deleted file mode 100644 index a2e01b4aefbd..000000000000 --- a/reference/wkhtmltox/wkhtmltox/pdf/object/construct.xml +++ /dev/null @@ -1,425 +0,0 @@ - - - - - - wkhtmltox\PDF\Object::__construct - Create a new PDF Object - - - - &reftitle.description; - - public wkhtmltox\PDF\Object::__construct - stringbuffer - arraysettings - - - Creates a new PDF Object from the given buffer and optional configuration settings - - - - - - &reftitle.parameters; - - - buffer - - - HTML - - - - - settings - - - - - - - - Name - Description - Values - Changelog - - - - - page - URL or path of the HTML to convert - - >= 0.1.0 - - - useExternalLinks - set true to convert external links in the input into external PDF links in the output - boolean - >= 0.1.0 - - - useLocalLinks - set true to convert internal links in the input into internal PDF links in the output - boolean - >= 0.1.0 - - - produceForms - set true to turn HTML forms into PDF forms - boolean - >= 0.1.0 - - - replacements - undocumented - - >= 0.1.0 - - - includeInOutline - set true to include sections from this object in the outline and toc - boolean - >= 0.1.0 - - - pagesCount - set true to make page count in toc inclusive of the number of pages in this object - boolean - >= 0.1.0 - - - tocXsl - set to style sheet to convert this object into a toc object - - >= 0.1.0 - - - toc.useDottedLines - set true to use dotted lines in toc - boolean - >= 0.1.0 - - - toc.captionText - the caption text for toc - - >= 0.1.0 - - - toc.forwardLinks - set true to create links from toc to content - boolean - >= 0.1.0 - - - toc.backLinks - set true to create links from content to toc - boolean - >= 0.1.0 - - - toc.indentation - indentation for toc - 2em - >= 0.1.0 - - - toc.fontScale - the factor to scale down the font at every toc level - 0.8 - >= 0.1.0 - - - header.fontSize - font size for use in header - 13 - >= 0.1.0 - - - header.fontName - name of font for use in header - times - >= 0.1.0 - - - header.left - text for left of header - - >= 0.1.0 - - - header.center - text for center of header - - >= 0.1.0 - - - header.right - text for right of header - - >= 0.1.0 - - - header.line - enable or disable horizontal rule under header - boolean - >= 0.1.0 - - - header.spacing - space between header and content - 1.8 - >= 0.1.0 - - - header.htmlUrl - URL or path of HTML to use in header - - >= 0.1.0 - - - footer.fontSize - font size for use in footer - 13 - >= 0.1.0 - - - footer.fontName - name of font for use in footer - times - >= 0.1.0 - - - footer.left - text for left of footer - - >= 0.1.0 - - - footer.center - text for center of footer - - >= 0.1.0 - - - footer.right - text for right of footer - - >= 0.1.0 - - - footer.line - enable or disable horizontal rule under footer - boolean - >= 0.1.0 - - - footer.spacing - space between footer and content - 1.8 - >= 0.1.0 - - - footer.htmlUrl - URL or path of HTML to use in footer - - >= 0.1.0 - - - load.username - user name to use when loging into a website - bart - >= 0.1.0 - - - load.password - the password to used when logging into a website - elbarto - >= 0.1.0 - - - load.jsdelay - the amount of time in milliseconds to wait after a page is loaded until it is captured - 1200 - >= 0.1.0 - - - load.zoomFactor - how much zoom should be applied to the content - 2.2 - >= 0.1.0 - - - load.customHeaders - custom headers to send when requesting the main web page - - >= 0.1.0 - - - load.repertCustomHeaders - set true to send with all requests - boolean - >= 0.1.0 - - - load.cookies - cookie string to send when requesting the main web page - - >= 0.1.0 - - - load.post - post string to send when requesting the main web page - - >= 0.1.0 - - - load.blockLocalFileAccess - disallow local and piped files to access other local files - boolean - >= 0.1.0 - - - load.stopSlowScript - stop slow running javascript - boolean - - - - load.debugJavascript - allow javascript to raise warnings - boolean - >= 0.1.0 - - - load.loadErrorHandling - set error handling strategy - -
    - - - - - abort - abort the convertion process - - - skip - do not add the object to the final output - - - ignore - try to add the object to the final output - - - -
    - - >= 0.1.0 - - - load.proxy - - - >= 0.1.0 - - - web.background - include background image in output - boolean - >= 0.1.0 - - - web.loadImages - include images in output - boolean - >= 0.1.0 - - - web.enableJavascript - enable or disable javascript - boolean - >= 0.1.0 - - - web.enableIntelligentShrinking - enable to attempt to fit more content on page, only applies to PDF output - boolean - >= 0.1.0 - - - web.minimumFontSize - the minimum font size allowed - 9 - >= 0.1.0 - - - web.printMediaType - print content using print media type instead of screen media type - boolean - >= 0.1.0 - - - web.defaultEncoding - content to use where no encoding is specified - utf-8 - >= 0.1.0 - - - web.userStyleSheet - URL or path to a user specified style sheet - /path/to/style.css - >= 0.1.0 - - - web.enablePlugins - enable or disable NS plugins - boolean - >= 0.1.0 - - - - -
    -
    -
    -
    -
    - - - - - -
    - - diff --git a/reference/xattr/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/xattr/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/xattr/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/xattr/book.xml b/reference/xattr/book.xml deleted file mode 100644 index 90c90de50f72..000000000000 --- a/reference/xattr/book.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - - xattr - - - - &reftitle.intro; - - The xattr extension allows for the manipulation of extended attributes on a filesystem. - - - - - &reference.xattr.setup; - &reference.xattr.constants; - &reference.xattr.reference; - - - - - diff --git a/reference/xattr/configure.xml b/reference/xattr/configure.xml deleted file mode 100644 index bf732dff79d0..000000000000 --- a/reference/xattr/configure.xml +++ /dev/null @@ -1,33 +0,0 @@ - - -
    - &reftitle.install; - - &pecl.info; - &url.pecl.package;xattr. - - - &pecl.windows.download; - -
    - - diff --git a/reference/xattr/constants.xml b/reference/xattr/constants.xml deleted file mode 100644 index c236636d96fc..000000000000 --- a/reference/xattr/constants.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - &reftitle.constants; - &extension.constants; - - - - XATTR_ROOT - (int) - - - - Set attribute in root (trusted) namespace. Requires root privileges. - - - - - - XATTR_DONTFOLLOW - (int) - - - - Do not follow the symbolic link but operate on symbolic link itself. - - - - - - XATTR_CREATE - (int) - - - - Function will fail if extended attribute already exists. - - - - - - XATTR_REPLACE - (int) - - - - Function will fail if extended attribute doesn't exist. - - - - - - - diff --git a/reference/xattr/functions/xattr-get.xml b/reference/xattr/functions/xattr-get.xml deleted file mode 100644 index e0a0f41a5fc8..000000000000 --- a/reference/xattr/functions/xattr-get.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - xattr_get - - Get an extended attribute - - - - &reftitle.description; - - stringfalsexattr_get - stringfilename - stringname - intflags0 - - - This function gets the value of an extended attribute of a file. - - &xattr.namespace; - - - &reftitle.parameters; - - - - filename - - - The file from which we get the attribute. - - - - - name - - - The name of the attribute. - - - - - flags - - - - Supported xattr flags - - - - XATTR_DONTFOLLOW - Do not follow the symbolic link but operate on symbolic link itself. - - - XATTR_ROOT - Set attribute in root (trusted) namespace. Requires root privileges. - - - -
    -
    -
    -
    -
    -
    -
    - - &reftitle.returnvalues; - - Returns a string containing the value or &false; if the attribute doesn't - exist. - - - - &reftitle.examples; - - - Checks if system administrator has signed the file - - -]]> - - - - - - &reftitle.seealso; - - - xattr_list - xattr_set - xattr_remove - - - -
    - - diff --git a/reference/xattr/functions/xattr-list.xml b/reference/xattr/functions/xattr-list.xml deleted file mode 100644 index ea22a9df1557..000000000000 --- a/reference/xattr/functions/xattr-list.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - xattr_list - - Get a list of extended attributes - - - - &reftitle.description; - - arrayxattr_list - stringfilename - intflags0 - - - This functions gets a list of names of extended attributes of a file. - - &xattr.namespace; - - - &reftitle.parameters; - - - - filename - - - The path of the file. - - - - - flags - - - - Supported xattr flags - - - - XATTR_DONTFOLLOW - Do not follow the symbolic link but operate on symbolic link itself. - - - XATTR_ROOT - Set attribute in root (trusted) namespace. Requires root privileges. - - - -
    -
    -
    -
    -
    -
    -
    - - &reftitle.returnvalues; - - This function returns an array with names of extended attributes. - - - - &reftitle.examples; - - - Prints names of all extended attributes of file - - -]]> - - - - - - &reftitle.seealso; - - - xattr_get - - - -
    - - diff --git a/reference/xattr/functions/xattr-remove.xml b/reference/xattr/functions/xattr-remove.xml deleted file mode 100644 index 66aa1764463a..000000000000 --- a/reference/xattr/functions/xattr-remove.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - xattr_remove - - Remove an extended attribute - - - - &reftitle.description; - - boolxattr_remove - stringfilename - stringname - intflags0 - - - This function removes an extended attribute of a file. - - &xattr.namespace; - - - &reftitle.parameters; - - - - filename - - - The file from which we remove the attribute. - - - - - name - - - The name of the attribute to remove. - - - - - flags - - - - Supported xattr flags - - - - XATTR_DONTFOLLOW - Do not follow the symbolic link but operate on symbolic link itself. - - - XATTR_ROOT - Set attribute in root (trusted) namespace. Requires root privileges. - - - -
    -
    -
    -
    -
    -
    -
    - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - - Removes all extended attributes of a file - - -]]> - - - - - - &reftitle.seealso; - - - xattr_list - xattr_set - xattr_get - - - -
    - - diff --git a/reference/xattr/functions/xattr-set.xml b/reference/xattr/functions/xattr-set.xml deleted file mode 100644 index b554d3a83493..000000000000 --- a/reference/xattr/functions/xattr-set.xml +++ /dev/null @@ -1,146 +0,0 @@ - - - - - - xattr_set - - Set an extended attribute - - - - &reftitle.description; - - boolxattr_set - stringfilename - stringname - stringvalue - intflags0 - - - This function sets the value of an extended attribute of a file. - - &xattr.namespace; - - - &reftitle.parameters; - - - - filename - - - The file in which we set the attribute. - - - - - name - - - The name of the extended attribute. This attribute will be created if - it doesn't exist or replaced otherwise. You can change this behaviour - by using the flags parameter. - - - - - value - - - The value of the attribute. - - - - - flags - - - - Supported xattr flags - - - - XATTR_CREATE - Function will fail if extended attribute already exists. - - - XATTR_REPLACE - Function will fail if extended attribute doesn't exist. - - - XATTR_DONTFOLLOW - Do not follow the symbolic link but operate on symbolic link itself. - - - XATTR_ROOT - Set attribute in root (trusted) namespace. Requires root privileges. - - - -
    -
    -
    -
    -
    -
    -
    - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - - Sets extended attributes on <filename>.wav</filename> file - - -]]> - - - - - - &reftitle.seealso; - - - xattr_get - xattr_remove - - - -
    - - diff --git a/reference/xattr/functions/xattr-supported.xml b/reference/xattr/functions/xattr-supported.xml deleted file mode 100644 index 1e66dda17f51..000000000000 --- a/reference/xattr/functions/xattr-supported.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - xattr_supported - - Check if filesystem supports extended attributes - - - - &reftitle.description; - - boolxattr_supported - stringfilename - intflags0 - - - This functions checks if the filesystem holding the given file supports - extended attributes. Read access to the file is required. - - - - &reftitle.parameters; - - - - filename - - - The path of the tested file. - - - - - flags - - - - Supported xattr flags - - - - XATTR_DONTFOLLOW - Do not follow the symbolic link but operate on symbolic link itself. - - - -
    -
    -
    -
    -
    -
    -
    - - &reftitle.returnvalues; - - This function returns &true; if filesystem supports extended attributes, - &false; if it doesn't and &null; if it can't be determined (for example - wrong path or lack of permissions to file). - - - - &reftitle.examples; - - - <function>xattr_supported</function> example - - The following code checks if we can use extended attributes. - - - -]]> - - - - - - &reftitle.seealso; - - - xattr_get - xattr_list - - - -
    - - diff --git a/reference/xattr/reference.xml b/reference/xattr/reference.xml deleted file mode 100644 index e40a693a44ff..000000000000 --- a/reference/xattr/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - xattr &Functions; - - &reference.xattr.entities.functions; - - - - diff --git a/reference/xattr/setup.xml b/reference/xattr/setup.xml deleted file mode 100644 index b7a42edca5d5..000000000000 --- a/reference/xattr/setup.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - &reftitle.setup; - - -
    - &reftitle.required; - - To use xattr, you will need libattr installed. It is available - at &url.xattr;. - - - - These functions only work on filesystems that support extended - attributes, and have them enabled at mount time. Some common - filesystems that support extended attributes are ext2, ext3, - reiserfs, jfs, and xfs. - - -
    - - - - &reference.xattr.configure; - - -
    - - - diff --git a/reference/xattr/versions.xml b/reference/xattr/versions.xml deleted file mode 100644 index ba8b1c14a421..000000000000 --- a/reference/xattr/versions.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/xdiff/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/xdiff/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/xdiff/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/xdiff/book.xml b/reference/xdiff/book.xml deleted file mode 100644 index f2e785bb0d05..000000000000 --- a/reference/xdiff/book.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - xdiff - - - - &reftitle.intro; - - xdiff extension enables you to create and apply patch files containing - differences between different revisions of files. - - - This extension supports two modes of operation - on strings and on files, as well - as two different patch formats - unified and binary. Unified patches are excellent - for text files as they are human-readable and easy to review. For binary files like - archives or images, binary patches will be adequate choice as they are binary safe and - handle non-printable characters well. - - - Starting from version 1.5.0 there are two different sets of functions for generating - binary patches. New functions - xdiff_string_rabdiff and - xdiff_file_rabdiff generate output compatible with older functions - but are typically faster and generate smaller results. For more details about methods of - generating binary patches and differences between them, please check - libxdiff website. - - - This extension uses libxdiff to implement these functions. Please see - &url.xdiff; for more information. - - - - - &reference.xdiff.setup; - &reference.xdiff.constants; - &reference.xdiff.reference; - - - - - diff --git a/reference/xdiff/configure.xml b/reference/xdiff/configure.xml deleted file mode 100644 index d5460aa47fd4..000000000000 --- a/reference/xdiff/configure.xml +++ /dev/null @@ -1,33 +0,0 @@ - - -
    - &reftitle.install; - - &pecl.info; - &url.pecl.package;xdiff. - - - &pecl.windows.download.avail; - -
    - - diff --git a/reference/xdiff/constants.xml b/reference/xdiff/constants.xml deleted file mode 100644 index 06bfed02b751..000000000000 --- a/reference/xdiff/constants.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - &reftitle.constants; - &extension.constants; - - - - XDIFF_PATCH_NORMAL - (int) - - - - This flag indicates that xdiff_string_patch and - xdiff_file_patch functions should create result by - applying patch to original content thus creating newer version of file. This is the default - mode of operation. - - - - - - XDIFF_PATCH_REVERSE - (int) - - - - This flag indicated that xdiff_string_patch and - xdiff_file_patch functions should create result by - reversing patch changed from newer content thus creating original version. - - - - - - - diff --git a/reference/xdiff/functions/xdiff-file-bdiff-size.xml b/reference/xdiff/functions/xdiff-file-bdiff-size.xml deleted file mode 100644 index 4242beafaa32..000000000000 --- a/reference/xdiff/functions/xdiff-file-bdiff-size.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - xdiff_file_bdiff_size - Read a size of file created by applying a binary diff - - - - &reftitle.description; - - intxdiff_file_bdiff_size - stringfile - - - Returns a size of a result file that would be created after applying binary patch from file - file to the original file. - - - - - &reftitle.parameters; - - - - file - - - The path to the binary patch created by xdiff_string_bdiff or - xdiff_string_rabdiff function. - - - - - - - - - &reftitle.returnvalues; - - Returns the size of file that would be created. - - - - - &reftitle.examples; - - - <function>xdiff_file_bdiff_size</function> example - - The following code applies reads a size of file that would be created - after applying a binary diff. - - - -]]> - - - - - - - &reftitle.seealso; - - - xdiff_file_bdiff - xdiff_file_rabdiff - xdiff_file_bpatch - - - - - - diff --git a/reference/xdiff/functions/xdiff-file-bdiff.xml b/reference/xdiff/functions/xdiff-file-bdiff.xml deleted file mode 100644 index 165614485468..000000000000 --- a/reference/xdiff/functions/xdiff-file-bdiff.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - xdiff_file_bdiff - Make binary diff of two files - - - - &reftitle.description; - - boolxdiff_file_bdiff - stringold_file - stringnew_file - stringdest - - - Makes a binary diff of two files and stores the result in a patch file. - This function works with both text and binary files. Resulting patch - file can be later applied using xdiff_file_bpatch/xdiff_string_bpatch. - - - - - &reftitle.parameters; - - - - old_file - - - Path to the first file. This file acts as "old" file. - - - - - new_file - - - Path to the second file. This file acts as "new" file. - - - - - dest - - - Path of the resulting patch file. Resulting file contains differences - between "old" and "new" files. It is in binary format and is human-unreadable. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - <function>xdiff_file_bdiff</function> example - - The following code makes binary diff of two archives. - - - -]]> - - - - - - - &reftitle.notes; - - - Both files will be loaded into memory so ensure that your memory_limit is - set high enough. - - - - - - &reftitle.seealso; - - - xdiff_file_bpatch - - - - - - - diff --git a/reference/xdiff/functions/xdiff-file-bpatch.xml b/reference/xdiff/functions/xdiff-file-bpatch.xml deleted file mode 100644 index 1a033b04b38d..000000000000 --- a/reference/xdiff/functions/xdiff-file-bpatch.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - xdiff_file_bpatch - Patch a file with a binary diff - - - - &reftitle.description; - - boolxdiff_file_bpatch - stringfile - stringpatch - stringdest - - - Patches a file with a binary - patch and stores the result in a file dest. - This function accepts patches created both via xdiff_file_bdiff - and xdiff_file_rabdiff functions or their string counterparts. - - - - - &reftitle.parameters; - - - - file - - - The original file. - - - - - patch - - - The binary patch file. - - - - - dest - - - Path of the resulting file. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - <function>xdiff_file_bpatch</function> example - - The following code applies binary diff to a file. - - - -]]> - - - - - - - &reftitle.notes; - - - Both files (file and patch) - will be loaded into memory so ensure that your memory_limit is set high - enough. - - - - - - &reftitle.seealso; - - - xdiff_file_bdiff - xdiff_file_rabdiff - - - - - - - diff --git a/reference/xdiff/functions/xdiff-file-diff-binary.xml b/reference/xdiff/functions/xdiff-file-diff-binary.xml deleted file mode 100644 index 8e149e406f33..000000000000 --- a/reference/xdiff/functions/xdiff-file-diff-binary.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - xdiff_file_diff_binary - &Alias; xdiff_file_bdiff - - - - &reftitle.description; - - boolxdiff_file_diff_binary - stringold_file - stringnew_file - stringdest - - - Makes a binary diff of two files and stores the result in a patch file. - This function works with both text and binary files. Resulting patch - file can be later applied using xdiff_file_bpatch. - - - Starting with version 1.5.0 this function is an alias of xdiff_file_bdiff. - - - - - &reftitle.parameters; - - - - old_file - - - Path to the first file. This file acts as "old" file. - - - - - new_file - - - Path to the second file. This file acts as "new" file. - - - - - dest - - - Path of the resulting patch file. Resulting file contains differences - between "old" and "new" files. It is in binary format and is human-unreadable. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - <function>xdiff_file_diff_binary</function> example - - The following code makes binary diff of two archives. - - - -]]> - - - - - - - &reftitle.notes; - - - Both files will be loaded into memory so ensure that your memory_limit is - set high enough. - - - - - - &reftitle.seealso; - - - xdiff_file_bdiff - xdiff_file_bpatch - - - - - - - diff --git a/reference/xdiff/functions/xdiff-file-diff.xml b/reference/xdiff/functions/xdiff-file-diff.xml deleted file mode 100644 index 46ef12378a3b..000000000000 --- a/reference/xdiff/functions/xdiff-file-diff.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - xdiff_file_diff - Make unified diff of two files - - - - &reftitle.description; - - boolxdiff_file_diff - stringold_file - stringnew_file - stringdest - intcontext3 - boolminimal&false; - - - Makes an unified diff containing differences between old_file and - new_file and stores it in dest file. The - resulting file is human-readable. An optional context parameter - specifies how many lines of context should be added around each change. - Setting minimal parameter to true will result in outputting the shortest - patch file possible (can take a long time). - - - - - &reftitle.parameters; - - - - old_file - - - Path to the first file. This file acts as "old" file. - - - - - new_file - - - Path to the second file. This file acts as "new" file. - - - - - dest - - - Path of the resulting patch file. - - - - - context - - - Indicates how many lines of context you want to include in diff - result. - - - - - minimal - - - Set this parameter to &true; if you want to minimalize size of the result - (can take a long time). - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - <function>xdiff_file_diff</function> example - - The following code makes unified diff of two php files with context length of 2. - - - -]]> - - - - - - - &reftitle.notes; - - - This function doesn't work well with binary files. To make diff of binary - files use xdiff_file_bdiff/xdiff_file_rabdiff function. - - - - - - &reftitle.seealso; - - - xdiff_file_patch - - - - - - diff --git a/reference/xdiff/functions/xdiff-file-merge3.xml b/reference/xdiff/functions/xdiff-file-merge3.xml deleted file mode 100644 index a53afc8c3aff..000000000000 --- a/reference/xdiff/functions/xdiff-file-merge3.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - xdiff_file_merge3 - Merge 3 files into one - - - - &reftitle.description; - - mixedxdiff_file_merge3 - stringold_file - stringnew_file1 - stringnew_file2 - stringdest - - - Merges three files into one and stores the result in a file dest. - The old_file is an original version while new_file1 - and new_file2 are modified versions of an original. - - - - - &reftitle.parameters; - - - - old_file - - - Path to the first file. It acts as "old" file. - - - - - new_file1 - - - Path to the second file. It acts as modified version of old_file. - - - - - new_file2 - - - Path to the third file. It acts as modified version of old_file. - - - - - dest - - - Path of the resulting file, containing merged changed from both new_file1 and - new_file2. - - - - - - - - - &reftitle.returnvalues; - - Returns &true; if merge was successful, string with rejected chunks if - it was not or &false; if an internal error happened. - - - - - &reftitle.examples; - - - <function>xdiff_file_merge3</function> example - - The following code merges three files into one. - - - -]]> - - - - - - - &reftitle.seealso; - - - xdiff_string_merge3 - - - - - - diff --git a/reference/xdiff/functions/xdiff-file-patch-binary.xml b/reference/xdiff/functions/xdiff-file-patch-binary.xml deleted file mode 100644 index fb5b9fc3f480..000000000000 --- a/reference/xdiff/functions/xdiff-file-patch-binary.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - - xdiff_file_patch_binary - &Alias; xdiff_file_bpatch - - - - &reftitle.description; - - boolxdiff_file_patch_binary - stringfile - stringpatch - stringdest - - - Patches a file with a binary - patch and stores the result in a file dest. - This function accepts patches created both via xdiff_file_bdiff - or xdiff_file_rabdiff functions or their string counterparts. - - - Starting with version 1.5.0 this function is an alias of xdiff_file_bpatch. - - - - - &reftitle.parameters; - - - - file - - - The original file. - - - - - patch - - - The binary patch file. - - - - - dest - - - Path of the resulting file. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - <function>xdiff_file_patch_binary</function> example - - The following code applies binary diff to a file. - - - -]]> - - - - - - - &reftitle.notes; - - - Both files (file and patch) - will be loaded into memory so ensure that your memory_limit is set high - enough. - - - - - - &reftitle.seealso; - - - xdiff_string_patch_binary - - - - - - - diff --git a/reference/xdiff/functions/xdiff-file-patch.xml b/reference/xdiff/functions/xdiff-file-patch.xml deleted file mode 100644 index 59ed07ce9c31..000000000000 --- a/reference/xdiff/functions/xdiff-file-patch.xml +++ /dev/null @@ -1,160 +0,0 @@ - - - - - - xdiff_file_patch - Patch a file with an unified diff - - - - &reftitle.description; - - mixedxdiff_file_patch - stringfile - stringpatch - stringdest - intflagsDIFF_PATCH_NORMAL - - - Patches a file with a patch and stores the result in a file. - patch has to be an unified diff created by - xdiff_file_diff/xdiff_string_diff function. - An optional flags parameter specifies mode of operation. - - - - - &reftitle.parameters; - - - - file - - - The original file. - - - - - patch - - - The unified patch file. It has to be created using xdiff_string_diff, - xdiff_file_diff functions or compatible tools. - - - - - dest - - - Path of the resulting file. - - - - - flags - - - Can be either XDIFF_PATCH_NORMAL (default mode, - normal patch) or XDIFF_PATCH_REVERSE (reversed - patch). - - - Starting from version 1.5.0, you can also use binary OR to enable - XDIFF_PATCH_IGNORESPACE flag. - - - - - - - - - &reftitle.returnvalues; - - Returns &false; if an internal error happened, string with rejected - chunks if patch couldn't be applied or &true; if patch has been successfully applied. - - - - - &reftitle.examples; - - - <function>xdiff_file_patch</function> example - - The following code applies unified diff to a file. - - - -]]> - - - - Patch reversing example - - The following code reverses a patch. - - - -]]> - - - - - - - &reftitle.seealso; - - - xdiff_file_diff - - - - - - - diff --git a/reference/xdiff/functions/xdiff-file-rabdiff.xml b/reference/xdiff/functions/xdiff-file-rabdiff.xml deleted file mode 100644 index 11820b4b1efd..000000000000 --- a/reference/xdiff/functions/xdiff-file-rabdiff.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - xdiff_file_rabdiff - Make binary diff of two files using the Rabin's polynomial fingerprinting algorithm - - - - &reftitle.description; - - boolxdiff_file_rabdiff - stringold_file - stringnew_file - stringdest - - - Makes a binary diff of two files and stores the result in a patch file. - The difference between this function and xdiff_file_bdiff is different - algorithm used which should result in faster execution and smaller diff produced. - This function works with both text and binary files. Resulting patch - file can be later applied using xdiff_file_bpatch/xdiff_string_bpatch. - - - For more details about differences between algorithm used please check libxdiff - website. - - - - - &reftitle.parameters; - - - - old_file - - - Path to the first file. This file acts as "old" file. - - - - - new_file - - - Path to the second file. This file acts as "new" file. - - - - - dest - - - Path of the resulting patch file. Resulting file contains differences - between "old" and "new" files. It is in binary format and is human-unreadable. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - <function>xdiff_file_rabdiff</function> example - - The following code makes binary diff of two archives. - - - -]]> - - - - - - - &reftitle.notes; - - - Both files will be loaded into memory so ensure that your memory_limit is - set high enough. - - - - - - &reftitle.seealso; - - - xdiff_file_bpatch - - - - - - - diff --git a/reference/xdiff/functions/xdiff-string-bdiff-size.xml b/reference/xdiff/functions/xdiff-string-bdiff-size.xml deleted file mode 100644 index b2823f79e2ca..000000000000 --- a/reference/xdiff/functions/xdiff-string-bdiff-size.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - xdiff_string_bdiff_size - Read a size of file created by applying a binary diff - - - - &reftitle.description; - - intxdiff_string_bdiff_size - stringpatch - - - Returns a size of a result file that would be created after applying binary patch to - the original file. - - - - - &reftitle.parameters; - - - - patch - - - The binary patch created by xdiff_string_bdiff or - xdiff_string_rabdiff function. - - - - - - - - - &reftitle.returnvalues; - - Returns the size of file that would be created. - - - - - &reftitle.examples; - - - <function>xdiff_string_bdiff_size</function> example - - The following code applies reads a size of file that would be created - after applying a binary diff. - - - -]]> - - - - - - - &reftitle.seealso; - - - xdiff_string_bdiff - xdiff_string_rabdiff - xdiff_string_bpatch - - - - - - diff --git a/reference/xdiff/functions/xdiff-string-bdiff.xml b/reference/xdiff/functions/xdiff-string-bdiff.xml deleted file mode 100644 index 13655c3f3771..000000000000 --- a/reference/xdiff/functions/xdiff-string-bdiff.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - xdiff_string_bdiff - Make binary diff of two strings - - - - &reftitle.description; - - stringxdiff_string_bdiff - stringold_data - stringnew_data - - - Makes a binary diff of two strings and returns the result. - This function works with both text and binary data. Resulting patch - can be later applied using xdiff_string_bpatch/xdiff_file_bpatch. - - - - - &reftitle.parameters; - - - - old_data - - - First string with binary data. It acts as "old" data. - - - - - new_data - - - Second string with binary data. It acts as "new" data. - - - - - - - - - &reftitle.returnvalues; - - Returns string with binary diff containing differences between "old" and "new" - data or &false; if an internal error occurred. - - - - - &reftitle.seealso; - - - xdiff_string_bpatch - - - - - - - diff --git a/reference/xdiff/functions/xdiff-string-bpatch.xml b/reference/xdiff/functions/xdiff-string-bpatch.xml deleted file mode 100644 index eab04ad95147..000000000000 --- a/reference/xdiff/functions/xdiff-string-bpatch.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - xdiff_string_bpatch - Patch a string with a binary diff - - - - &reftitle.description; - - stringxdiff_string_bpatch - stringstr - stringpatch - - - Patches a string str with a binary patch. - This function accepts patches created both via xdiff_string_bdiff - and xdiff_string_rabdiff functions or their file counterparts. - - - - - &reftitle.parameters; - - - - str - - - The original binary string. - - - - - patch - - - The binary patch string. - - - - - - - - - &reftitle.returnvalues; - - Returns the patched string, or &false; on error. - - - - - &reftitle.seealso; - - - xdiff_string_bdiff - xdiff_string_rabdiff - - - - - - - diff --git a/reference/xdiff/functions/xdiff-string-diff-binary.xml b/reference/xdiff/functions/xdiff-string-diff-binary.xml deleted file mode 100644 index 30662d87aa21..000000000000 --- a/reference/xdiff/functions/xdiff-string-diff-binary.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - xdiff_string_diff_binary - &Alias; xdiff_string_bdiff - - - - &reftitle.description; - - stringxdiff_string_bdiff - stringold_data - stringnew_data - - - Makes a binary diff of two strings and returns the result. - This function works with both text and binary data. Resulting patch - can be later applied using xdiff_string_bpatch/xdiff_file_bpatch. - - - Starting with version 1.5.0 this function is an alias of xdiff_string_bdiff. - - - - - &reftitle.parameters; - - - - old_data - - - First string with binary data. It acts as "old" data. - - - - - new_data - - - Second string with binary data. It acts as "new" data. - - - - - - - - - &reftitle.returnvalues; - - Returns string with result or &false; if an internal error happened. - - - - - &reftitle.seealso; - - - xdiff_string_bdiff - xdiff_string_bpatch - - - - - - - diff --git a/reference/xdiff/functions/xdiff-string-diff.xml b/reference/xdiff/functions/xdiff-string-diff.xml deleted file mode 100644 index 78f210475939..000000000000 --- a/reference/xdiff/functions/xdiff-string-diff.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - xdiff_string_diff - Make unified diff of two strings - - - - &reftitle.description; - - stringxdiff_string_diff - stringold_data - stringnew_data - intcontext3 - boolminimal&false; - - - Makes an unified diff containing differences between old_data string and - new_data string and returns it. The resulting diff is human-readable. - An optional context parameter specifies how many lines of context should be - added around each change. Setting minimal parameter - to true will result in outputting the shortest patch file possible (can take a long time). - - - - - &reftitle.parameters; - - - - old_data - - - First string with data. It acts as "old" data. - - - - - new_data - - - Second string with data. It acts as "new" data. - - - - - context - - - Indicates how many lines of context you want to include in the diff - result. - - - - - minimal - - - Set this parameter to &true; if you want to minimalize the size of the - result (can take a long time). - - - - - - - - - &reftitle.returnvalues; - - Returns string with resulting diff or &false; if an internal error happened. - - - - - &reftitle.examples; - - - <function>xdiff_string_diff</function> example - - The following code makes unified diff of two articles. - - - -]]> - - - - - - - &reftitle.notes; - - - This function doesn't work well with binary strings. To make diff of binary - strings use xdiff_string_bdiff/xdiff_string_rabdiff. - - - - - - &reftitle.seealso; - - - xdiff_string_patch - - - - - - diff --git a/reference/xdiff/functions/xdiff-string-merge3.xml b/reference/xdiff/functions/xdiff-string-merge3.xml deleted file mode 100644 index 628ad2a8847a..000000000000 --- a/reference/xdiff/functions/xdiff-string-merge3.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - xdiff_string_merge3 - Merge 3 strings into one - - - - &reftitle.description; - - mixedxdiff_string_merge3 - stringold_data - stringnew_data1 - stringnew_data2 - stringerror - - - Merges three strings into one and returns the result. - The old_data is an original version of data - while new_data1 and new_data2 are modified - versions of an original. An optional error is used to pass any - rejected parts during merging process. - - - - - &reftitle.parameters; - - - - old_data - - - First string with data. It acts as "old" data. - - - - - new_data1 - - - Second string with data. It acts as modified version of old_data. - - - - - new_data2 - - - Third string with data. It acts as modified version of old_data. - - - - - error - - - If provided then rejected parts are stored inside this variable. - - - - - - - - - &reftitle.returnvalues; - - Returns the merged string, &false; if an internal error happened, or &true; - if merged string is empty. - - - - - &reftitle.seealso; - - - xdiff_file_merge3 - - - - - - - diff --git a/reference/xdiff/functions/xdiff-string-patch-binary.xml b/reference/xdiff/functions/xdiff-string-patch-binary.xml deleted file mode 100644 index fc9ee063365b..000000000000 --- a/reference/xdiff/functions/xdiff-string-patch-binary.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - xdiff_string_patch_binary - &Alias; xdiff_string_bpatch - - - - &reftitle.description; - - stringxdiff_string_patch_binary - stringstr - stringpatch - - - Patches a string str with a binary patch. - This function accepts patches created both via xdiff_string_bdiff - and xdiff_string_rabdiff functions or their file counterparts. - - - Starting with version 1.5.0 this function is an alias of xdiff_string_bpatch. - - - - - &reftitle.parameters; - - - - str - - - The original binary string. - - - - - patch - - - The binary patch string. - - - - - - - - - &reftitle.returnvalues; - - Returns the patched string, or &false; on error. - - - - - &reftitle.seealso; - - - xdiff_string_bpatch - xdiff_string_bdiff - xdiff_string_rabdiff - - - - - - - diff --git a/reference/xdiff/functions/xdiff-string-patch.xml b/reference/xdiff/functions/xdiff-string-patch.xml deleted file mode 100644 index da5fa517795b..000000000000 --- a/reference/xdiff/functions/xdiff-string-patch.xml +++ /dev/null @@ -1,146 +0,0 @@ - - - - - - xdiff_string_patch - Patch a string with an unified diff - - - - &reftitle.description; - - stringxdiff_string_patch - stringstr - stringpatch - intflags - stringerror - - - Patches a str string with an unified patch in patch parameter - and returns the result. patch has to be an unified diff created by - xdiff_file_diff/xdiff_string_diff function. - An optional flags parameter specifies mode of operation. Any - rejected parts of the patch will be stored inside error variable if - it is provided. - - - - - &reftitle.parameters; - - - - str - - - The original string. - - - - - patch - - - The unified patch string. It has to be created using xdiff_string_diff, - xdiff_file_diff functions or compatible tools. - - - - - flags - - - flags can be either - XDIFF_PATCH_NORMAL (default mode, normal patch) - or XDIFF_PATCH_REVERSE (reversed patch). - - - Starting from version 1.5.0, you can also use binary OR to enable - XDIFF_PATCH_IGNORESPACE flag. - - - - - error - - - If provided then rejected parts are stored inside this variable. - - - - - - - - - &reftitle.returnvalues; - - Returns the patched string, or &false; on error. - - - - - &reftitle.examples; - - - <function>xdiff_string_patch</function> example - - The following code applies changes to some article. - - - -]]> - - - - - - - &reftitle.seealso; - - - xdiff_string_diff - - - - - - diff --git a/reference/xdiff/functions/xdiff-string-rabdiff.xml b/reference/xdiff/functions/xdiff-string-rabdiff.xml deleted file mode 100644 index becc073d7a24..000000000000 --- a/reference/xdiff/functions/xdiff-string-rabdiff.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - xdiff_string_rabdiff - - Make a binary diff of two strings using the Rabin's polynomial fingerprinting algorithm - - - - - &reftitle.description; - - stringfalsexdiff_string_rabdiff - stringold_data - stringnew_data - - - Makes a binary diff of two strings using the Rabin's polynomial fingerprinting algorithm implemented by - libxdiff. Compared to - xdiff_string_bdiff, this algorithm generally produces smaller diffs and operates faster, - while remaining fully compatible with xdiff_string_bpatch and - xdiff_file_bpatch for applying patches. - - - This function can be used with both text and binary data. The resulting diff data can later be - applied to recreate the new version from the old one. - - - For further information about the algorithm, see the - libxdiff documentation. - - - - - &reftitle.parameters; - - - - old_data - - - The first string containing the "old" binary data. - - - - - new_data - - - The second string containing the "new" binary data. - - - - - - - - - &reftitle.returnvalues; - - Returns a binary diff string containing the differences between the old and new data,&return.falseforfailure;. - - - - - &reftitle.examples; - - - Creation of a binary diff between two strings - - -]]> - - - - - - - &reftitle.seealso; - - - xdiff_string_bdiff - xdiff_string_bpatch - xdiff_file_bpatch - - - - - - diff --git a/reference/xdiff/reference.xml b/reference/xdiff/reference.xml deleted file mode 100644 index 277268b59f50..000000000000 --- a/reference/xdiff/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - xdiff &Functions; - - &reference.xdiff.entities.functions; - - - - diff --git a/reference/xdiff/setup.xml b/reference/xdiff/setup.xml deleted file mode 100644 index 633c3a66a5d8..000000000000 --- a/reference/xdiff/setup.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - &reftitle.setup; - - -
    - &reftitle.required; - - To use xdiff, you will need libxdiff installed, available - on the libxdiff homepage &url.xdiff;. - - - - You'll need at least libxdiff 0.7 for these functions to be aware of memory_limit. - - -
    - - - - &reference.xdiff.configure; - - -
    - - - diff --git a/reference/xdiff/versions.xml b/reference/xdiff/versions.xml deleted file mode 100644 index 40083b2e2bbc..000000000000 --- a/reference/xdiff/versions.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/xhprof/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/xhprof/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/xhprof/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/xhprof/book.xml b/reference/xhprof/book.xml deleted file mode 100644 index 3dd17a123f64..000000000000 --- a/reference/xhprof/book.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - Hierarchical Profiler - Xhprof - - - &reftitle.intro; - - XHProf is a light-weight hierarchical and instrumentation based profiler. - During the data collection phase, it keeps track of call counts and inclusive - metrics for arcs in the dynamic callgraph of a program. It computes exclusive - metrics in the reporting/post processing phase, such as wall (elapsed) time, - CPU time and memory usage. A functions profile can be broken down by callers - or callees. XHProf handles recursive functions by detecting cycles in the - callgraph at data collection time itself and avoiding the cycles by giving unique - depth qualified names for the recursive invocations. - - - XHProf includes a simple HTML based user interface (written in PHP). The browser based - UI for viewing profiler results makes it easy to view results or to share results - with peers. A callgraph image view is also supported. - - - XHProf reports can often be helpful in understanding the structure of the code - being executed. The hierarchical nature of the reports can be used to determine, - for example, what chain of calls led to a particular function getting called. - - - XHProf supports ability to compare two runs (a.k.a. "diff" reports) or aggregate - data from multiple runs. Diff and aggregate reports, much like single run reports, - offer "flat" as well as "hierarchical" views of the profile. - - - Additional documentation can be found via the - facebook xhprof website. - - - - &reference.xhprof.setup; - &reference.xhprof.constants; - &reference.xhprof.examples; - &reference.xhprof.reference; - - - - diff --git a/reference/xhprof/configure.xml b/reference/xhprof/configure.xml deleted file mode 100644 index 1702fc703df0..000000000000 --- a/reference/xhprof/configure.xml +++ /dev/null @@ -1,34 +0,0 @@ - - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;xhprof - - -
    - - - diff --git a/reference/xhprof/constants.xml b/reference/xhprof/constants.xml deleted file mode 100644 index ba59dcd86362..000000000000 --- a/reference/xhprof/constants.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - - - XHPROF_FLAGS_NO_BUILTINS - (int) - - - - Used to skip all built-in (internal) functions. - - - - - - XHPROF_FLAGS_CPU - (int) - - - - Used to add CPU profiling information to the output. - - - - - - XHPROF_FLAGS_MEMORY - (int) - - - - Used to add memory profiling information to the output. - - - - - - - diff --git a/reference/xhprof/examples.xml b/reference/xhprof/examples.xml deleted file mode 100644 index f00295e62a1f..000000000000 --- a/reference/xhprof/examples.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - &reftitle.examples; - - Xhprof example with the optional GUI - - This example starts and stops the profiler, then uses the bundled - GUI interface to save and parse the results. In other words, the - code from the extension itself ends at the call to - xhprof_disable. - - -save_run($xhprof_data, "xhprof_testing"); - -echo "http://localhost/xhprof/xhprof_html/index.php?run={$run_id}&source=xhprof_testing\n"; - -?> -]]> - - &example.outputs.similar; - - - - - - - diff --git a/reference/xhprof/functions/xhprof-disable.xml b/reference/xhprof/functions/xhprof-disable.xml deleted file mode 100644 index 527c71fe0594..000000000000 --- a/reference/xhprof/functions/xhprof-disable.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - xhprof_disable - Stops xhprof profiler - - - - &reftitle.description; - - arraynullxhprof_disable - - - - Stops the profiler, and returns xhprof data from the run. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - An array of xhprof data, from the run. - Returns &null; if profiling is not enabled. - - - - - &reftitle.examples; - - <function>xhprof_disable</function> example - - -]]> - - &example.outputs.similar; - -strlen] => Array - ( - [ct] => 1 - [wt] => 279 - ) - - [main()==>xhprof_disable] => Array - ( - [ct] => 1 - [wt] => 9 - ) - - [main()] => Array - ( - [ct] => 1 - [wt] => 610 - ) - -) -]]> - - - - - - - diff --git a/reference/xhprof/functions/xhprof-enable.xml b/reference/xhprof/functions/xhprof-enable.xml deleted file mode 100644 index fea835695b84..000000000000 --- a/reference/xhprof/functions/xhprof-enable.xml +++ /dev/null @@ -1,138 +0,0 @@ - - - - - - xhprof_enable - Start xhprof profiler - - - - &reftitle.description; - - voidxhprof_enable - intflags0 - arrayoptions - - - Start xhprof profiling. - - - - - &reftitle.parameters; - - - - flags - - - Optional flags to add additional information to the profiling. See the - XHprof constants for further - information about these flags, e.g., XHPROF_FLAGS_MEMORY - to enable memory profiling. - - - - - options - - - An array of optional options, namely, the - 'ignored_functions' option to pass in functions to be ignored - during profiling. - - - - - - - - - &reftitle.returnvalues; - - &null; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL xhprof 0.9.2 - - The optional options parameter was added. - - - - - - - - - - &reftitle.examples; - - <function>xhprof_enable</function> examples - - array('call_user_func', - 'call_user_func_array'))); - -// 3. elapsed time + memory profiling; ignore call_user_func* during profiling -xhprof_enable( - XHPROF_FLAGS_MEMORY, - array('ignored_functions' => array('call_user_func', - 'call_user_func_array'))); -?> -]]> - - - - - - &reftitle.seealso; - - xhprof_disable - xhprof_sample_enable - memory_get_usage - getrusage - - - - - diff --git a/reference/xhprof/functions/xhprof-sample-disable.xml b/reference/xhprof/functions/xhprof-sample-disable.xml deleted file mode 100644 index f3de431883dd..000000000000 --- a/reference/xhprof/functions/xhprof-sample-disable.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - xhprof_sample_disable - Stops xhprof sample profiler - - - - &reftitle.description; - - arraynullxhprof_sample_disable - - - - Stops the sample mode xhprof profiler, and returns the profile info. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - An array of xhprof sample data, from the run. - Returns &null; if profiling is not enabled. - - - - - &reftitle.examples; - - <function>xhprof_sample_disable</function> example - - -]]> - - &example.outputs.similar; - - main() - [1272935300.900000] => main() -) -]]> - - - - - - - - diff --git a/reference/xhprof/functions/xhprof-sample-enable.xml b/reference/xhprof/functions/xhprof-sample-enable.xml deleted file mode 100644 index 143eaef6a05d..000000000000 --- a/reference/xhprof/functions/xhprof-sample-enable.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - xhprof_sample_enable - Start XHProf profiling in sampling mode - - - - &reftitle.description; - - voidxhprof_sample_enable - - - - Starts profiling in sample mode, which is a lighter weight version - of xhprof_enable. The sampling interval is - 0.1 seconds, and samples record the full function call stack. The - main use case is when lower overhead is required when doing - performance monitoring and diagnostics. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &null; - - - - - &reftitle.seealso; - - xhprof_sample_disable - xhprof_enable - memory_get_usage - getrusage - - - - - diff --git a/reference/xhprof/ini.xml b/reference/xhprof/ini.xml deleted file mode 100644 index 544dbff18adc..000000000000 --- a/reference/xhprof/ini.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - -
    - &reftitle.runtime; - &extension.runtime; - - - Xhprof &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - xhprof.output_dir - "" - INI_ALL - - - - -
    -
    - - &ini.descriptions.title; - - - - - xhprof.output_dir - string - - - - Directory used by the default implementation of the iXHProfRuns - interface (namely, the XHProfRuns_Default class) for storing - XHProf runs. - - - - -
    - - diff --git a/reference/xhprof/reference.xml b/reference/xhprof/reference.xml deleted file mode 100644 index 0f3413c5428d..000000000000 --- a/reference/xhprof/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - Xhprof &Functions; - - &reference.xhprof.entities.functions; - - - - diff --git a/reference/xhprof/setup.xml b/reference/xhprof/setup.xml deleted file mode 100644 index 149f91441542..000000000000 --- a/reference/xhprof/setup.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - Although not required, xhprof includes an interface that's written in PHP. - It's used to save and display the profiled data in a usable way, where viewing - is done via a web browser. So, a PHP enabled web server will likely make the - xhprof experience more useful. - - - There's also a fork of the GUI interface at - &url.xhprof.gui.fork1; - -
    - - &reference.xhprof.configure; - &reference.xhprof.ini; - -
    - - diff --git a/reference/xhprof/versions.xml b/reference/xhprof/versions.xml deleted file mode 100644 index 0d28153b63da..000000000000 --- a/reference/xhprof/versions.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - - - - - - - - diff --git a/reference/xlswriter/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/xlswriter/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/xlswriter/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/xlswriter/book.xml b/reference/xlswriter/book.xml deleted file mode 100644 index 2e110bb58ef9..000000000000 --- a/reference/xlswriter/book.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - - XLSWriter - - - - &reftitle.intro; - - An efficient and fast xlsx file export extension. - - - - - &reference.xlswriter.setup; - &reference.xlswriter.xlsx-kernel; - &reference.xlswriter.xlsx-format; - - - - - diff --git a/reference/xlswriter/configure.xml b/reference/xlswriter/configure.xml deleted file mode 100644 index 8c5cf2b817f9..000000000000 --- a/reference/xlswriter/configure.xml +++ /dev/null @@ -1,33 +0,0 @@ - - - -
    - &reftitle.install; - - XML-RPC support in PHP is not enabled by default. You will need to - use the configuration - option when compiling PHP to enable XML-RPC support. - -
    - - - diff --git a/reference/xlswriter/setup.xml b/reference/xlswriter/setup.xml deleted file mode 100644 index ad892596f1e7..000000000000 --- a/reference/xlswriter/setup.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - XLSWriter requires PHP 7.0 and above. - -
    - -
    - &reftitle.install; - - &pecl.info; - &url.pecl.package;xlswriter - -
    - -
    - &reftitle.resources; - - There is one resource used by the procedural version of the XLSWriter - extension: returned by fileName or - \Vtiful\Kernel\Format. - -
    - -
    - - - diff --git a/reference/xlswriter/versions.xml b/reference/xlswriter/versions.xml deleted file mode 100644 index 8b167371fb7b..000000000000 --- a/reference/xlswriter/versions.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/xlswriter/xlsx-format.xml b/reference/xlswriter/xlsx-format.xml deleted file mode 100644 index 4d135d0a8d42..000000000000 --- a/reference/xlswriter/xlsx-format.xml +++ /dev/null @@ -1,287 +0,0 @@ - - - - - - The Vtiful\Kernel\Format class - Vtiful\Kernel\Format - - - - -
    - &reftitle.intro; - - Create a cell format object - -
    - - -
    - &reftitle.classsynopsis; - - - - Vtiful\Kernel\Format - - - - - Vtiful\Kernel\Format - - - - - &Constants; - - const - int - Vtiful\Kernel\Format::FORMAT_ALIGN_LEFT - 1 - - - const - int - Vtiful\Kernel\Format::FORMAT_ALIGN_CENTER - 2 - - - const - int - Vtiful\Kernel\Format::FORMAT_ALIGN_RIGHT - 3 - - - const - int - Vtiful\Kernel\Format::FORMAT_ALIGN_FILL - 4 - - - const - int - Vtiful\Kernel\Format::FORMAT_ALIGN_JUSTIFY - 5 - - - const - int - Vtiful\Kernel\Format::FORMAT_ALIGN_CENTER_ACROSS - 6 - - - const - int - Vtiful\Kernel\Format::FORMAT_ALIGN_DISTRIBUTED - 7 - - - const - int - Vtiful\Kernel\Format::FORMAT_ALIGN_VERTICAL_TOP - 8 - - - const - int - Vtiful\Kernel\Format::FORMAT_ALIGN_VERTICAL_BOTTOM - 9 - - - const - int - Vtiful\Kernel\Format::FORMAT_ALIGN_VERTICAL_CENTER - 10 - - - const - int - Vtiful\Kernel\Format::FORMAT_ALIGN_VERTICAL_JUSTIFY - 11 - - - const - int - Vtiful\Kernel\Format::FORMAT_ALIGN_VERTICAL_DISTRIBUTED - 12 - - - const - int - Vtiful\Kernel\Format::UNDERLINE_SINGLE - 1 - - - const - int - Vtiful\Kernel\Format::UNDERLINE_DOUBLE - 2 - - - const - int - Vtiful\Kernel\Format::UNDERLINE_SINGLE_ACCOUNTING - 3 - - - const - int - Vtiful\Kernel\Format::UNDERLINE_DOUBLE_ACCOUNTING - 4 - - - &Methods; - - - - - -
    - - -
    - &reftitle.constants; - - - - Vtiful\Kernel\Format::FORMAT_ALIGN_LEFT - - - - - - - Vtiful\Kernel\Format::FORMAT_ALIGN_CENTER - - - - - - - Vtiful\Kernel\Format::FORMAT_ALIGN_RIGHT - - - - - - - Vtiful\Kernel\Format::FORMAT_ALIGN_FILL - - - - - - - Vtiful\Kernel\Format::FORMAT_ALIGN_JUSTIFY - - - - - - - Vtiful\Kernel\Format::FORMAT_ALIGN_CENTER_ACROSS - - - - - - - Vtiful\Kernel\Format::FORMAT_ALIGN_DISTRIBUTED - - - - - - - Vtiful\Kernel\Format::FORMAT_ALIGN_VERTICAL_TOP - - - - - - - Vtiful\Kernel\Format::FORMAT_ALIGN_VERTICAL_BOTTOM - - - - - - - Vtiful\Kernel\Format::FORMAT_ALIGN_VERTICAL_CENTER - - - - - - - Vtiful\Kernel\Format::FORMAT_ALIGN_VERTICAL_JUSTIFY - - - - - - - Vtiful\Kernel\Format::FORMAT_ALIGN_VERTICAL_DISTRIBUTED - - - - - - - Vtiful\Kernel\Format::UNDERLINE_SINGLE - - - - - - - Vtiful\Kernel\Format::UNDERLINE_DOUBLE - - - - - - - Vtiful\Kernel\Format::UNDERLINE_SINGLE_ACCOUNTING - - - - - - - Vtiful\Kernel\Format::UNDERLINE_DOUBLE_ACCOUNTING - - - - - - -
    - - -
    - - &reference.xlswriter.entities.xlsx-format; - -
    - - diff --git a/reference/xlswriter/xlsx-format/align.xml b/reference/xlswriter/xlsx-format/align.xml deleted file mode 100644 index e8bcc69e9525..000000000000 --- a/reference/xlswriter/xlsx-format/align.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - Vtiful\Kernel\Format::align - Vtiful\Kernel\Format align - - - - &reftitle.description; - - public Vtiful\Kernel\Format::align - resourcehandle - intstyle - - - set cell align - - - - - &reftitle.parameters; - - - handle - - - xlsx file handle - - - - - style - - - Vtiful\Kernel\Format constant - - - - - - - - &reftitle.returnvalues; - - Resource - - - - - &reftitle.examples; - - Align style example - - './tests' -]; - -$excel = new \Vtiful\Kernel\Excel($config); -$excel->fileName('tutorial01.xlsx'); - -$format = new \Vtiful\Kernel\Format($excel->getHandle()); -$alignStyle = $format->align(\Vtiful\Kernel\Format::FORMAT_ALIGN_LEFT)->toResource(); - -$excel->header(['name', 'age']) - ->data([['viest', 21]]) - ->setColumn('A:A', 200, $alignStyle) - ->output(); -?> -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-format/bold.xml b/reference/xlswriter/xlsx-format/bold.xml deleted file mode 100644 index de42ce604147..000000000000 --- a/reference/xlswriter/xlsx-format/bold.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - Vtiful\Kernel\Format::bold - Vtiful\Kernel\Format bold - - - - &reftitle.description; - - public Vtiful\Kernel\Format::bold - resourcehandle - - - Vtiful\Kernel\Format bold format - - - - - &reftitle.parameters; - - - handle - - - xlsx file handle - - - - - - - - &reftitle.returnvalues; - - Resource - - - - - &reftitle.examples; - - Bold style example - - './tests' -]; - -$excel = new \Vtiful\Kernel\Excel($config); -$excel->fileName('tutorial01.xlsx'); - -$format = new \Vtiful\Kernel\Format($excel->getHandle()); -$boldStyle = $format->bold()->toResource(); - -$excel->header(['name', 'age']) - ->data([['viest', 21]]) - ->setColumn('A:A', 200, $boldStyle) - ->output(); -?> -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-format/italic.xml b/reference/xlswriter/xlsx-format/italic.xml deleted file mode 100644 index 2d7dd07ca84b..000000000000 --- a/reference/xlswriter/xlsx-format/italic.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - Vtiful\Kernel\Format::italic - Vtiful\Kernel\Format italic - - - - &reftitle.description; - - public Vtiful\Kernel\Format::italic - resourcehandle - - - Vtiful\Kernel\Format italic format - - - - - &reftitle.parameters; - - - handle - - - xlsx file handle - - - - - - - - &reftitle.returnvalues; - - Resource - - - - - &reftitle.examples; - - Italic style example - - './tests' -]; - -$excel = new \Vtiful\Kernel\Excel($config); -$excel->fileName('tutorial01.xlsx'); - -$format = new \Vtiful\Kernel\Format($excel->getHandle()); -$italicStyle = $format->italic()->toResource(); - -$excel->header(['name', 'age']) - ->data([['viest', 21]]) - ->setColumn('A:A', 200, $italicStyle) - ->output(); -?> -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-format/underline.xml b/reference/xlswriter/xlsx-format/underline.xml deleted file mode 100644 index c2be0fa9d1b6..000000000000 --- a/reference/xlswriter/xlsx-format/underline.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - Vtiful\Kernel\Format::underline - Vtiful\Kernel\Format underline - - - - &reftitle.description; - - public Vtiful\Kernel\Format::underline - resourcehandle - intstyle - - - Vtiful\Kernel\Format underline format - - - - - &reftitle.parameters; - - - handle - - - xlsx file handle - - - - - style - - - Vtiful\Kernel\Format constant - - - - - - - - &reftitle.returnvalues; - - Resource - - - - - &reftitle.examples; - - Underline style example - - './tests' -]; - -$excel = new \Vtiful\Kernel\Excel($config); -$excel->fileName('tutorial01.xlsx'); - -$format = new \Vtiful\Kernel\Format($excel->getHandle()); -$underlineStyle = $format->underline(\Vtiful\Kernel\Format::UNDERLINE_SINGLE)->toResource(); - -$excel->header(['name', 'age']) - ->data([['viest', 21]]) - ->setColumn('A:A', 200, $underlineStyle) - ->output(); -?> -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-kernel.xml b/reference/xlswriter/xlsx-kernel.xml deleted file mode 100644 index 9f4851fe4a9e..000000000000 --- a/reference/xlswriter/xlsx-kernel.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - The Vtiful\Kernel\Excel class - Vtiful\Kernel\Excel - - - - -
    - &reftitle.intro; - - Create xlsx files and set cells and output xlsx files - -
    - - -
    - &reftitle.classsynopsis; - - - - Vtiful\Kernel\Excel - - - - - Vtiful\Kernel\Excel - - - - - &Methods; - - - - - -
    - -
    - - &reference.xlswriter.entities.xlsx-kernel; - -
    - - diff --git a/reference/xlswriter/xlsx-kernel/add-sheet.xml b/reference/xlswriter/xlsx-kernel/add-sheet.xml deleted file mode 100644 index 014f0f94ef63..000000000000 --- a/reference/xlswriter/xlsx-kernel/add-sheet.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - Vtiful\Kernel\Excel::addSheet - Vtiful\Kernel\Excel addSheet - - - - &reftitle.description; - - public Vtiful\Kernel\Excel::addSheet - stringsheetName - - - Create a new worksheet in the xlsx file. - - - - - &reftitle.parameters; - - - sheetName - - - Worksheet name - - - - - - - - &reftitle.returnvalues; - - Vtiful\Kernel\Excel instance - - - - - &reftitle.examples; - - example - - './tests' -]; - -$fileObject = new \Vtiful\Kernel\Excel($config); - -$file = $fileObject->fileName('tutorial.xlsx', 'sheet_one') - ->header(['name', 'age']) - ->data([ - ['viest', 23], - ['wjx', 23] - ]); - -$file->addSheet('sheet_two') - ->header(['name', 'age']) - ->data([ - ['james', 33], - ['king', 33] - ]); - -$file->output(); -?> -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-kernel/auto-filter.xml b/reference/xlswriter/xlsx-kernel/auto-filter.xml deleted file mode 100644 index c41ed1d62d8f..000000000000 --- a/reference/xlswriter/xlsx-kernel/auto-filter.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - Vtiful\Kernel\Excel::autoFilter - Vtiful\Kernel\Excel autoFilter - - - - &reftitle.description; - - public Vtiful\Kernel\Excel::autoFilter - stringscope - - - Add autofilter to a worksheet. - - - - - &reftitle.parameters; - - - scope - - - Cell start and end coordinate string. - - - - - - - - &reftitle.returnvalues; - - Vtiful\Kernel\Excel instance - - - - - &reftitle.examples; - - example - - './tests' -]; - -$fileObject = new \Vtiful\Kernel\Excel($config); - -$file = $fileObject->fileName('test.xlsx') - ->header(['name', 'age']) - ->data($data) - ->autoFilter('A1:B11') // auto filter - ->output(); -?> -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-kernel/const-memory.xml b/reference/xlswriter/xlsx-kernel/const-memory.xml deleted file mode 100644 index 78fb9179d53b..000000000000 --- a/reference/xlswriter/xlsx-kernel/const-memory.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - Vtiful\Kernel\Excel::constMemory - Vtiful\Kernel\Excel constMemory - - - - &reftitle.description; - - public Vtiful\Kernel\Excel::constMemory - stringfileName - stringsheetName - - - Write a large file with constant memory usage. - - - - - &reftitle.parameters; - - - fileName - - - XLSX file name - - - - - sheetName - - - Worksheet name - - - - - - - - &reftitle.returnvalues; - - Vtiful\Kernel\Excel instance - - - - - &reftitle.examples; - - example - - '/home/viest' -]; - -$fileObject = new \Vtiful\Kernel\Excel($config); - -$file = $fileObject->constMemory('tutorial.xlsx', 'sheet'); -?> -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-kernel/construct.xml b/reference/xlswriter/xlsx-kernel/construct.xml deleted file mode 100644 index f0348d5d3f38..000000000000 --- a/reference/xlswriter/xlsx-kernel/construct.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Vtiful\Kernel\Excel::__construct - Vtiful\Kernel\Excel constructor - - - - &reftitle.description; - - public Vtiful\Kernel\Excel::__construct - arrayconfig - - - Vtiful\Kernel\Excel constructor, create a class object. - - - - - &reftitle.parameters; - - - config - - - XLSX file export configuration - - - - - - - - &reftitle.examples; - - example - - '/home/viest' -]; - -$excelObject = new \Vtiful\Kernel\Excel($config); -?> -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-kernel/data.xml b/reference/xlswriter/xlsx-kernel/data.xml deleted file mode 100644 index c02eec3978c2..000000000000 --- a/reference/xlswriter/xlsx-kernel/data.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Vtiful\Kernel\Excel::data - Vtiful\Kernel\Excel data - - - - &reftitle.description; - - public Vtiful\Kernel\Excel::data - arraydata - - - Write a data in the worksheet. - - - - - &reftitle.parameters; - - - data - - - worksheet data - - - - - - - - &reftitle.returnvalues; - - Vtiful\Kernel\Excel instance - - - - - &reftitle.examples; - - example - - './tests' -]; - -$fileObject = new \Vtiful\Kernel\Excel($config); - -$file = $fileObject->fileName('tutorial.xlsx', 'sheet_one') - ->header(['name', 'age']) - ->data([ - ['viest', 23], - ['wjx', 23], - ]); -?> -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-kernel/file-name.xml b/reference/xlswriter/xlsx-kernel/file-name.xml deleted file mode 100644 index 9ab8497bd12f..000000000000 --- a/reference/xlswriter/xlsx-kernel/file-name.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - Vtiful\Kernel\Excel::fileName - Vtiful\Kernel\Excel fileName - - - - &reftitle.description; - - public Vtiful\Kernel\Excel::fileName - stringfileName - stringsheetName - - - Create a brand new xlsx file and create a worksheet. - - - - - &reftitle.parameters; - - - fileName - - - XLSX file name - - - - - sheetName - - - Worksheet name - - - - - - - - &reftitle.returnvalues; - - Vtiful\Kernel\Excel instance - - - - - &reftitle.examples; - - example - - '/home/viest' -]; - -$fileObject = new \Vtiful\Kernel\Excel($config); - -$file = $fileObject->fileName('tutorial.xlsx', 'sheet'); -?> -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-kernel/get-handle.xml b/reference/xlswriter/xlsx-kernel/get-handle.xml deleted file mode 100644 index 7f4d6d10fd83..000000000000 --- a/reference/xlswriter/xlsx-kernel/get-handle.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - Vtiful\Kernel\Excel::getHandle - Vtiful\Kernel\Excel getHandle - - - - &reftitle.description; - - public Vtiful\Kernel\Excel::getHandle - - - - Get the xlsx text resource handle. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Resource - - - - - &reftitle.examples; - - example - - './tests' -]; - -$fileObject = new \Vtiful\Kernel\Excel($config); - -$file = $fileObject->fileName('tutorial.xlsx', 'sheet_one') - ->header(['name', 'age']); - -$handle = $file->getHandle(); -?> -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-kernel/header.xml b/reference/xlswriter/xlsx-kernel/header.xml deleted file mode 100644 index 6260f06faec7..000000000000 --- a/reference/xlswriter/xlsx-kernel/header.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - Vtiful\Kernel\Excel::header - Vtiful\Kernel\Excel header - - - - &reftitle.description; - - public Vtiful\Kernel\Excel::header - arrayheaderData - - - Write a header in the worksheet. - - - - - &reftitle.parameters; - - - headerData - - - worksheet header data - - - - - - - - &reftitle.returnvalues; - - Vtiful\Kernel\Excel instance - - - - - &reftitle.examples; - - example - - './tests' -]; - -$fileObject = new \Vtiful\Kernel\Excel($config); - -$file = $fileObject->fileName('tutorial.xlsx', 'sheet_one') - ->header(['name', 'age']); -?> -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-kernel/insert-formula.xml b/reference/xlswriter/xlsx-kernel/insert-formula.xml deleted file mode 100644 index a8f2aa2a4618..000000000000 --- a/reference/xlswriter/xlsx-kernel/insert-formula.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - Vtiful\Kernel\Excel::insertFormula - Vtiful\Kernel\Excel insertFormula - - - - &reftitle.description; - - public Vtiful\Kernel\Excel::insertFormula - introw - intcolumn - stringformula - - - Insert calculation formula. - - - - - &reftitle.parameters; - - - row - - - cell row - - - - - column - - - cell column - - - - - formula - - - formula string - - - - - - - - &reftitle.returnvalues; - - Vtiful\Kernel\Excel instance - - - - - &reftitle.examples; - - example - - './tests' -]; - -$excel = new \Vtiful\Kernel\Excel($config); - -$file = $excel->fileName("free.xlsx") - ->header(['name', 'money']); - -for($index = 1; $index < 10; $index++) { - $file->insertText($index, 0, 'viest'); - $file->insertText($index, 1, 10); -} - -$file->insertText(12, 0, "Total"); -$file->insertFormula(12, 1, '=SUM(B2:B11)'); // insert formula - -$file->output(); -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-kernel/insert-image.xml b/reference/xlswriter/xlsx-kernel/insert-image.xml deleted file mode 100644 index 783b72f3bc07..000000000000 --- a/reference/xlswriter/xlsx-kernel/insert-image.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Vtiful\Kernel\Excel::insertImage - Vtiful\Kernel\Excel insertImage - - - - &reftitle.description; - - public Vtiful\Kernel\Excel::insertImage - introw - intcolumn - stringlocalImagePath - - - Insert a local image into the cell. - - - - - &reftitle.parameters; - - - row - - - cell row - - - - - column - - - cell column - - - - - localImagePath - - - local image path - - - - - - - - &reftitle.returnvalues; - - Vtiful\Kernel\Excel instance - - - - - &reftitle.examples; - - example - - './tests' -]; - -$excel = new \Vtiful\Kernel\Excel($config); - -$file = $excel->fileName("free.xlsx"); - -$file->insertImage(5, 0, '/vagrant/ASW-G-66.jpg'); - -$file->output(); -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-kernel/insert-text.xml b/reference/xlswriter/xlsx-kernel/insert-text.xml deleted file mode 100644 index 3396c7b1ab6a..000000000000 --- a/reference/xlswriter/xlsx-kernel/insert-text.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - Vtiful\Kernel\Excel::insertText - Vtiful\Kernel\Excel insertText - - - - &reftitle.description; - - public Vtiful\Kernel\Excel::insertText - introw - intcolumn - intfloatstringdata - stringformat - - - Write text in a cell. - - - - - &reftitle.parameters; - - - row - - - cell row - - - - - column - - - cell column - - - - - data - - - data to be written - - - - - format - - - String format - - - - - - - - &reftitle.returnvalues; - - Vtiful\Kernel\Excel instance - - - - - &reftitle.examples; - - example - - './tests' -]; - -$excel = new \Vtiful\Kernel\Excel($config); - -$file = $excel->fileName("free.xlsx") - ->header(['name', 'money']); - -for ($index = 0; $index < 10; $index++) { - $file->insertText($index+1, 0, 'viest'); - $file->insertText($index+1, 1, 10000, '#,##0'); -} - -$file->output(); -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-kernel/merge-cells.xml b/reference/xlswriter/xlsx-kernel/merge-cells.xml deleted file mode 100644 index 5a60612f444b..000000000000 --- a/reference/xlswriter/xlsx-kernel/merge-cells.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - Vtiful\Kernel\Excel::mergeCells - Vtiful\Kernel\Excel mergeCells - - - - &reftitle.description; - - public Vtiful\Kernel\Excel::mergeCells - stringscope - stringdata - - - Merge Cells. - - - - - &reftitle.parameters; - - - scope - - - cell start and end coordinate strings - - - - - data - - - string data - - - - - - - - &reftitle.returnvalues; - - Vtiful\Kernel\Excel instance - - - - - &reftitle.examples; - - example - - './tests' -]; - -$excel = new \Vtiful\Kernel\Excel($config); - -$excel->fileName("test.xlsx") - ->mergeCells('A1:C1', 'Merge cells') - ->output(); -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-kernel/output.xml b/reference/xlswriter/xlsx-kernel/output.xml deleted file mode 100644 index 925ccee905a3..000000000000 --- a/reference/xlswriter/xlsx-kernel/output.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - Vtiful\Kernel\Excel::output - Vtiful\Kernel\Excel output - - - - &reftitle.description; - - public Vtiful\Kernel\Excel::output - - - - Output xlsx file to disk. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - XLSX file path; - - - - - &reftitle.examples; - - example - - './tests' -]; - -$fileObject = new \Vtiful\Kernel\Excel($config); - -$file = $fileObject->fileName('tutorial.xlsx', 'sheet_one') - ->header(['name', 'age']) - ->data([ - ['viest', 23], - ['wjx', 23], - ]); - -$path = $file->output(); -?> -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-kernel/set-column.xml b/reference/xlswriter/xlsx-kernel/set-column.xml deleted file mode 100644 index a870f8fd9f2e..000000000000 --- a/reference/xlswriter/xlsx-kernel/set-column.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - Vtiful\Kernel\Excel::setColumn - Vtiful\Kernel\Excel setColumn - - - - &reftitle.description; - - public Vtiful\Kernel\Excel::setColumn - stringrange - floatwidth - resourceformat - - - Set the format of the column. - - - - - &reftitle.parameters; - - - range - - - cell start and end coordinate strings - - - - - width - - - column width - - - - - format - - - cell format resource - - - - - - - - &reftitle.returnvalues; - - Vtiful\Kernel\Excel instance - - - - - &reftitle.examples; - - setColumn example - - './tests' -]; - -$excel = new \Vtiful\Kernel\Excel($config); -$excel->fileName('tutorial01.xlsx'); - -$format = new \Vtiful\Kernel\Format($excel->getHandle()); -$boldStyle = $format->bold()->toResource(); - -$excel->header(['name', 'age']) - ->data([['viest', 21]]) - ->setColumn('A:A', 200, $boldStyle) - ->output(); -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-kernel/set-row.xml b/reference/xlswriter/xlsx-kernel/set-row.xml deleted file mode 100644 index 3c863f2a116a..000000000000 --- a/reference/xlswriter/xlsx-kernel/set-row.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - Vtiful\Kernel\Excel::setRow - Vtiful\Kernel\Excel setRow - - - - &reftitle.description; - - public Vtiful\Kernel\Excel::setRow - stringrange - floatheight - resourceformat - - - Set the format of the row. - - - - - &reftitle.parameters; - - - range - - - cell start and end coordinate strings - - - - - height - - - row height - - - - - format - - - cell format resource - - - - - - - - &reftitle.returnvalues; - - Vtiful\Kernel\Excel instance - - - - - &reftitle.examples; - - setRow example - - './tests' -]; - -$excel = new \Vtiful\Kernel\Excel($config); -$excel->fileName('tutorial01.xlsx'); - -$format = new \Vtiful\Kernel\Format($excel->getHandle()); -$boldStyle = $format->bold()->toResource(); - -$excel->header(['name', 'age']) - ->data([['viest', 21]]) - ->setRow('A1', 20, $boldStyle) - ->output(); -]]> - - - - - - - diff --git a/reference/xmldiff/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/xmldiff/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/xmldiff/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/xmldiff/book.xml b/reference/xmldiff/book.xml deleted file mode 100644 index e1419fb99ad8..000000000000 --- a/reference/xmldiff/book.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - - XML diff and merge - XMLDiff - - - &reftitle.intro; - - The extension is able to produce diffs of two XML documents and then to apply the difference to the source document. The diff is a XML document containing copy/insert/delete instruction nodes in human readable format. DOMDocument objects, local files and strings in memory can be processed. - - - - &reference.xmldiff.setup; - - - &reference.xmldiff.xmldiff.base; - &reference.xmldiff.xmldiff.dom; - &reference.xmldiff.xmldiff.memory; - &reference.xmldiff.xmldiff.file; - &reference.xmldiff.xmldiff.exception; - - - - diff --git a/reference/xmldiff/configure.xml b/reference/xmldiff/configure.xml deleted file mode 100644 index 837d62d456d2..000000000000 --- a/reference/xmldiff/configure.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - -
    - &reftitle.install; - - - Use when compiling PHP. - - - - Windows users should include php_xmldiff.dll into &php.ini; - - -
    - - - diff --git a/reference/xmldiff/reference.xml b/reference/xmldiff/reference.xml deleted file mode 100644 index 5f97d210aa62..000000000000 --- a/reference/xmldiff/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - Xmldiff &Functions; - - - - - - diff --git a/reference/xmldiff/setup.xml b/reference/xmldiff/setup.xml deleted file mode 100644 index a534b0c8805a..000000000000 --- a/reference/xmldiff/setup.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - libdiffmark - version 0.10 is bundled with the extension. If diffmark is available from your system packages, its usage is strongly encouraged. - libxml extension - DOM extension -
    - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;xmldiff. - -
    - - - -
    - - diff --git a/reference/xmldiff/versions.xml b/reference/xmldiff/versions.xml deleted file mode 100644 index 87ee4e1a59df..000000000000 --- a/reference/xmldiff/versions.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/xmldiff/xmldiff-base/construct.xml b/reference/xmldiff/xmldiff-base/construct.xml deleted file mode 100644 index b224308cd09e..000000000000 --- a/reference/xmldiff/xmldiff-base/construct.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - XMLDiff\Base::__construct - Constructor - - - - &reftitle.description; - - public XMLDiff\Base::__construct - stringnsname - - - Base constructor for all the worker classes in the xmldiff extension. - - - - - - &reftitle.parameters; - - - nsname - - - Custom namespace name for the diff document. The default namespace is http://www.locus.cz/diffmark and that's enough to avoid namespace conflicts. Use this parameter if you want to change it for some reason. - - - - - - - - - diff --git a/reference/xmldiff/xmldiff-base/diff.xml b/reference/xmldiff/xmldiff-base/diff.xml deleted file mode 100644 index c8d7e9aba269..000000000000 --- a/reference/xmldiff/xmldiff-base/diff.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - XMLDiff\Base::diff - Produce diff of two XML documents - - - - &reftitle.description; - - abstract public mixedXMLDiff\Base::diff - mixedfrom - mixedto - - - Abstract diff method to be implemented by inheriting classes. - - - The basic purpose of this method is to produce diff of the two documents. The param order matters and will produce different output. - - - - - - &reftitle.parameters; - - - from - - - Source XML document. - - - - - to - - - Target XML document. - - - - - - - - &reftitle.returnvalues; - - Implementation dependent. - - - - - - - diff --git a/reference/xmldiff/xmldiff-base/merge.xml b/reference/xmldiff/xmldiff-base/merge.xml deleted file mode 100644 index ac122e472af2..000000000000 --- a/reference/xmldiff/xmldiff-base/merge.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - XMLDiff\Base::merge - Produce new XML document based on diff - - - - &reftitle.description; - - abstract public mixedXMLDiff\Base::merge - mixedsrc - mixeddiff - - - Abstract merge method to be implemented by inheriting classes. - - - Basically the method purpose is to produce a new XML document based on the diff information. - - - - - &reftitle.parameters; - - - src - - - Source XML document. - - - - - diff - - - Document produced by the diff method. - - - - - - - - &reftitle.returnvalues; - - Implementation dependent. - - - - - - - diff --git a/reference/xmldiff/xmldiff-dom/diff.xml b/reference/xmldiff/xmldiff-dom/diff.xml deleted file mode 100644 index 0b69101121fe..000000000000 --- a/reference/xmldiff/xmldiff-dom/diff.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - XMLDiff\DOM::diff - Diff two DOMDocument objects - - - - &reftitle.description; - - public DOMDocumentXMLDiff\DOM::diff - DOMDocumentfrom - DOMDocumentto - - - Diff two DOMDocument instances and produce the new one containing the diff information. - - - - - &reftitle.parameters; - - - from - - - Source DOMDocument object. - - - - - to - - - Target DOMDocument object. - - - - - - - - &reftitle.returnvalues; - - DOMDocument with the diff information or NULL. - - - - - - - diff --git a/reference/xmldiff/xmldiff-dom/merge.xml b/reference/xmldiff/xmldiff-dom/merge.xml deleted file mode 100644 index 9e34e6d2fd47..000000000000 --- a/reference/xmldiff/xmldiff-dom/merge.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - XMLDiff\DOM::merge - Produce merged DOMDocument - - - - &reftitle.description; - - public DOMDocumentXMLDiff\DOM::merge - DOMDocumentsrc - DOMDocumentdiff - - - Create new DOMDocument based on the diff. - - - - - &reftitle.parameters; - - - src - - - Source DOMDocument object. - - - - - diff - - - DOMDocument object containing the diff information. - - - - - - - - &reftitle.returnvalues; - - Merged DOMDocument or NULL. - - - - - - - diff --git a/reference/xmldiff/xmldiff-file/diff.xml b/reference/xmldiff/xmldiff-file/diff.xml deleted file mode 100644 index 35b95c9d91f4..000000000000 --- a/reference/xmldiff/xmldiff-file/diff.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - XMLDiff\File::diff - Diff two XML files - - - - &reftitle.description; - - public stringXMLDiff\File::diff - stringfrom - stringto - - - Diff two local XML files and produce string with the diff information. - - - - - &reftitle.parameters; - - - from - - - Path to the source document. - - - - - to - - - Path to the target document. - - - - - - - - &reftitle.returnvalues; - - String with the XML document containing the diff information or NULL. - - - - - - - diff --git a/reference/xmldiff/xmldiff-file/merge.xml b/reference/xmldiff/xmldiff-file/merge.xml deleted file mode 100644 index 86793b600687..000000000000 --- a/reference/xmldiff/xmldiff-file/merge.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - XMLDiff\File::merge - Produce merged XML document - - - - &reftitle.description; - - public stringXMLDiff\File::merge - stringsrc - stringdiff - - - Create new XML document based on diffs and source document. - - - - - &reftitle.parameters; - - - src - - - Path to the source XML document. - - - - - diff - - - Path to the XML document with the diff information. - - - - - - - - &reftitle.returnvalues; - - String with the new XML document or NULL. - - - - - - - diff --git a/reference/xmldiff/xmldiff-memory/diff.xml b/reference/xmldiff/xmldiff-memory/diff.xml deleted file mode 100644 index b2f791b0b3da..000000000000 --- a/reference/xmldiff/xmldiff-memory/diff.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - XMLDiff\Memory::diff - Diff two XML documents - - - - &reftitle.description; - - public stringXMLDiff\Memory::diff - stringfrom - stringto - - - Diff two strings containing XML documents and produce the diff information. - - - - - &reftitle.parameters; - - - from - - - Source XML document. - - - - - to - - - Target XML document. - - - - - - - - &reftitle.returnvalues; - - String with the XML document containing the diff information or NULL. - - - - - - - diff --git a/reference/xmldiff/xmldiff-memory/merge.xml b/reference/xmldiff/xmldiff-memory/merge.xml deleted file mode 100644 index 31872fd44263..000000000000 --- a/reference/xmldiff/xmldiff-memory/merge.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - XMLDiff\Memory::merge - Produce merged XML document - - - - &reftitle.description; - - public stringXMLDiff\Memory::merge - stringsrc - stringdiff - - - Create new XML document based on diffs and source document. - - - - - &reftitle.parameters; - - - src - - - Source XML document. - - - - - diff - - - XML document containing diff information. - - - - - - - - &reftitle.returnvalues; - - String with the new XML document or NULL. - - - - - - - diff --git a/reference/xmldiff/xmldiff.base.xml b/reference/xmldiff/xmldiff.base.xml deleted file mode 100644 index fd07c8d97e9f..000000000000 --- a/reference/xmldiff/xmldiff.base.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - The XMLDiff\Base class - XMLDiff\Base - - - - -
    - &reftitle.intro; - - Base abstract class for all the comparsion classes in the extension. - -
    - - -
    - &reftitle.classsynopsis; - - - - XMLDiff\Base - - - - - XMLDiff\Base - - - - - &Methods; - - - - - -
    - -
    - - &reference.xmldiff.entities.xmldiff-base; - -
    - - diff --git a/reference/xmldiff/xmldiff.dom.xml b/reference/xmldiff/xmldiff.dom.xml deleted file mode 100644 index 4699a3e7718e..000000000000 --- a/reference/xmldiff/xmldiff.dom.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - The XMLDiff\DOM class - XMLDiff\DOM - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - XMLDiff\DOM - - - - - XMLDiff\DOM - - - - extends - XMLDiff\Base - - - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -
    - - &reference.xmldiff.entities.xmldiff-dom; - -
    - - diff --git a/reference/xmldiff/xmldiff.exception.xml b/reference/xmldiff/xmldiff.exception.xml deleted file mode 100644 index bb0783cb7946..000000000000 --- a/reference/xmldiff/xmldiff.exception.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - The XMLDiff\Exception class - XMLDiff\Exception - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - XMLDiff\Exception - - - - - XMLDiff\Exception - - - - extends - Exception - - - - &InheritedProperties; - - - - &InheritedMethods; - - - - - -
    - -
    - -
    - - diff --git a/reference/xmldiff/xmldiff.file.xml b/reference/xmldiff/xmldiff.file.xml deleted file mode 100644 index c456968e8b6f..000000000000 --- a/reference/xmldiff/xmldiff.file.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - The XMLDiff\File class - XMLDiff\File - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - XMLDiff\File - - - - - XMLDiff\File - - - - extends - XMLDiff\Base - - - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -
    - - &reference.xmldiff.entities.xmldiff-file; - -
    - - diff --git a/reference/xmldiff/xmldiff.memory.xml b/reference/xmldiff/xmldiff.memory.xml deleted file mode 100644 index dcfdbe028ad8..000000000000 --- a/reference/xmldiff/xmldiff.memory.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - The XMLDiff\Memory class - XMLDiff\Memory - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - XMLDiff\Memory - - - - - XMLDiff\Memory - - - - extends - XMLDiff\Base - - - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -
    - - &reference.xmldiff.entities.xmldiff-memory; - -
    - - diff --git a/reference/xmlrpc/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/xmlrpc/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/xmlrpc/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/xmlrpc/book.xml b/reference/xmlrpc/book.xml deleted file mode 100644 index 88a3901155ac..000000000000 --- a/reference/xmlrpc/book.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - XML-RPC - - - - &reftitle.intro; - - These functions can be used to write XML-RPC servers and clients. - You can find more information about XML-RPC at - &url.xmlrpc;, and more - documentation on this extension and its functions at - &url.xmlrpc-epi;. - - &warn.experimental; - - - - &reference.xmlrpc.setup; - &reference.xmlrpc.reference; - - - - - diff --git a/reference/xmlrpc/configure.xml b/reference/xmlrpc/configure.xml deleted file mode 100644 index 34c79ef91c1a..000000000000 --- a/reference/xmlrpc/configure.xml +++ /dev/null @@ -1,32 +0,0 @@ - - -
    - &reftitle.install; - - XML-RPC support in PHP is not enabled by default. You will need to - use the configuration - option when compiling PHP to enable XML-RPC support. - -
    - - - diff --git a/reference/xmlrpc/functions/xmlrpc-decode-request.xml b/reference/xmlrpc/functions/xmlrpc-decode-request.xml deleted file mode 100644 index 35d153150ff8..000000000000 --- a/reference/xmlrpc/functions/xmlrpc-decode-request.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - - - xmlrpc_decode_request - Decodes XML into native PHP types - - - &reftitle.description; - - mixedxmlrpc_decode_request - stringxml - stringmethod - stringencoding - - &warn.experimental.func; - &warn.undocumented.func; - - - - diff --git a/reference/xmlrpc/functions/xmlrpc-decode.xml b/reference/xmlrpc/functions/xmlrpc-decode.xml deleted file mode 100644 index ded1b7fd82c8..000000000000 --- a/reference/xmlrpc/functions/xmlrpc-decode.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - xmlrpc_decode - Decodes XML into native PHP types - - - &reftitle.description; - - mixedxmlrpc_decode - stringxml - stringencoding"iso-8859-1" - - &warn.experimental.func; - - - - &reftitle.parameters; - - - - xml - - - XML response returned by XMLRPC method. - - - - - encoding - - - Input encoding supported by iconv. - - - - - - - - - &reftitle.returnvalues; - - Returns either an array, or an integer, or a string, or a boolean according - to the response returned by the XMLRPC method. - - - - - &reftitle.examples; - - See example by xmlrpc_encode_request. - - - - - &reftitle.seealso; - - - xmlrpc_encode_request - xmlrpc_is_fault - - - - - - - diff --git a/reference/xmlrpc/functions/xmlrpc-encode-request.xml b/reference/xmlrpc/functions/xmlrpc-encode-request.xml deleted file mode 100644 index 751079d066ee..000000000000 --- a/reference/xmlrpc/functions/xmlrpc-encode-request.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - xmlrpc_encode_request - Generates XML for a method request - - - &reftitle.description; - - stringxmlrpc_encode_request - stringmethod - mixedparams - arrayoutput_options - - &warn.experimental.func; - - - - &reftitle.parameters; - - - - method - - - Name of the method to call. - - - - - params - - - Method parameters compatible with method signature. - - - - - output_options - - - Array specifying output options may contain (default values are - emphasised): - - output_type: php, xml - verbosity: no_white_space, newlines_only, pretty - escaping: cdata, non-ascii, non-print, markup - (may be a string with one value or an array with multiple values) - version: simple, xmlrpc, soap 1.1, auto - encoding: iso-8859-1, other character set supported by iconv - - - - - - - - - - &reftitle.returnvalues; - - Returns a string containing the XML representation of the request. - - - - - &reftitle.examples; - - - XMLRPC client functions example - - [ - 'method' => "POST", - 'header' => "Content-Type: text/xml", - 'content' => $request, - ] -]); -$file = file_get_contents("http://www.example.com/xmlrpc", false, $context); -$response = xmlrpc_decode($file); -if ($response && xmlrpc_is_fault($response)) { - trigger_error("xmlrpc: $response[faultString] ($response[faultCode])"); -} else { - print_r($response); -} -?> -]]> - - - - - - - &reftitle.seealso; - - - stream_context_create - file_get_contents - xmlrpc_decode - - - - - - - diff --git a/reference/xmlrpc/functions/xmlrpc-encode.xml b/reference/xmlrpc/functions/xmlrpc-encode.xml deleted file mode 100644 index 75d1b5489fe8..000000000000 --- a/reference/xmlrpc/functions/xmlrpc-encode.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - xmlrpc_encode - Generates XML for a PHP value - - - &reftitle.description; - - stringxmlrpc_encode - mixedvalue - - &warn.experimental.func; - &warn.undocumented.func; - - - - diff --git a/reference/xmlrpc/functions/xmlrpc-get-type.xml b/reference/xmlrpc/functions/xmlrpc-get-type.xml deleted file mode 100644 index 68c854794045..000000000000 --- a/reference/xmlrpc/functions/xmlrpc-get-type.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - xmlrpc_get_type - Gets xmlrpc type for a PHP value - - - &reftitle.description; - - stringxmlrpc_get_type - mixedvalue - - &warn.experimental.func; - - This function is especially useful for base64 and datetime strings. - - - - - &reftitle.parameters; - - - - value - - - PHP value - - - - - - - - - &reftitle.returnvalues; - - Returns the XML-RPC type. - - - - - &reftitle.examples; - - - XML-RPC type example - - -]]> - - - - - - - &reftitle.seealso; - - - xmlrpc_set_type - - - - - - - diff --git a/reference/xmlrpc/functions/xmlrpc-is-fault.xml b/reference/xmlrpc/functions/xmlrpc-is-fault.xml deleted file mode 100644 index e56d15e6e9af..000000000000 --- a/reference/xmlrpc/functions/xmlrpc-is-fault.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - xmlrpc_is_fault - Determines if an array value represents an XMLRPC fault - - - &reftitle.description; - - boolxmlrpc_is_fault - arrayarg - - &warn.experimental.func; - - - - &reftitle.parameters; - - - - arg - - - Array returned by xmlrpc_decode. - - - - - - - - - &reftitle.returnvalues; - - Returns &true; if the argument means fault, &false; otherwise. Fault - description is available in $arg["faultString"], fault - code is in $arg["faultCode"]. - - - - - &reftitle.examples; - - See example by xmlrpc_encode_request. - - - - - &reftitle.seealso; - - - xmlrpc_decode - - - - - - - diff --git a/reference/xmlrpc/functions/xmlrpc-parse-method-descriptions.xml b/reference/xmlrpc/functions/xmlrpc-parse-method-descriptions.xml deleted file mode 100644 index adc0e37ab540..000000000000 --- a/reference/xmlrpc/functions/xmlrpc-parse-method-descriptions.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - xmlrpc_parse_method_descriptions - Decodes XML into a list of method descriptions - - - &reftitle.description; - - arrayxmlrpc_parse_method_descriptions - stringxml - - &warn.experimental.func; - &warn.undocumented.func; - - - - diff --git a/reference/xmlrpc/functions/xmlrpc-server-add-introspection-data.xml b/reference/xmlrpc/functions/xmlrpc-server-add-introspection-data.xml deleted file mode 100644 index 7355ecef955a..000000000000 --- a/reference/xmlrpc/functions/xmlrpc-server-add-introspection-data.xml +++ /dev/null @@ -1,39 +0,0 @@ - - - - - xmlrpc_server_add_introspection_data - Adds introspection documentation - - - &reftitle.description; - - intxmlrpc_server_add_introspection_data - resourceserver - arraydesc - - &warn.experimental.func; - &warn.undocumented.func; - - - - diff --git a/reference/xmlrpc/functions/xmlrpc-server-call-method.xml b/reference/xmlrpc/functions/xmlrpc-server-call-method.xml deleted file mode 100644 index bafb7ca3ed99..000000000000 --- a/reference/xmlrpc/functions/xmlrpc-server-call-method.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - xmlrpc_server_call_method - Parses XML requests and call methods - - - &reftitle.description; - - stringxmlrpc_server_call_method - resourceserver - stringxml - mixeduser_data - arrayoutput_options - - &warn.experimental.func; - &warn.undocumented.func; - - - - diff --git a/reference/xmlrpc/functions/xmlrpc-server-create.xml b/reference/xmlrpc/functions/xmlrpc-server-create.xml deleted file mode 100644 index 1fa8d5b90bce..000000000000 --- a/reference/xmlrpc/functions/xmlrpc-server-create.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - xmlrpc_server_create - Creates an xmlrpc server - - - &reftitle.description; - - resourcexmlrpc_server_create - - - &warn.experimental.func; - &warn.undocumented.func; - - - - diff --git a/reference/xmlrpc/functions/xmlrpc-server-destroy.xml b/reference/xmlrpc/functions/xmlrpc-server-destroy.xml deleted file mode 100644 index d3ba8c629e34..000000000000 --- a/reference/xmlrpc/functions/xmlrpc-server-destroy.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - xmlrpc_server_destroy - Destroys server resources - - - &reftitle.description; - - boolxmlrpc_server_destroy - resourceserver - - &warn.experimental.func; - &warn.undocumented.func; - - - - diff --git a/reference/xmlrpc/functions/xmlrpc-server-register-introspection-callback.xml b/reference/xmlrpc/functions/xmlrpc-server-register-introspection-callback.xml deleted file mode 100644 index 7c14b0fee5ac..000000000000 --- a/reference/xmlrpc/functions/xmlrpc-server-register-introspection-callback.xml +++ /dev/null @@ -1,39 +0,0 @@ - - - - - xmlrpc_server_register_introspection_callback - Register a PHP function to generate documentation - - - &reftitle.description; - - boolxmlrpc_server_register_introspection_callback - resourceserver - stringfunction - - &warn.experimental.func; - &warn.undocumented.func; - - - - diff --git a/reference/xmlrpc/functions/xmlrpc-server-register-method.xml b/reference/xmlrpc/functions/xmlrpc-server-register-method.xml deleted file mode 100644 index d45f440931fb..000000000000 --- a/reference/xmlrpc/functions/xmlrpc-server-register-method.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - - - xmlrpc_server_register_method - Register a PHP function to resource method matching method_name - - - &reftitle.description; - - boolxmlrpc_server_register_method - resourceserver - stringmethod_name - stringfunction - - &warn.experimental.func; - &warn.undocumented.func; - - - - diff --git a/reference/xmlrpc/functions/xmlrpc-set-type.xml b/reference/xmlrpc/functions/xmlrpc-set-type.xml deleted file mode 100644 index c64a2b512b4b..000000000000 --- a/reference/xmlrpc/functions/xmlrpc-set-type.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - xmlrpc_set_type - Sets xmlrpc type, base64 or datetime, for a PHP string value - - - &reftitle.description; - - boolxmlrpc_set_type - stringvalue - stringtype - - - Sets xmlrpc type, base64 or datetime, for a PHP string value. - - &warn.experimental.func; - - - - &reftitle.parameters; - - - - value - - - Value to set the type - - - - - type - - - 'base64' or 'datetime' - - - - - - - - - &reftitle.returnvalues; - - &return.success; - If successful, value is converted to an object. - - - - - &reftitle.errors; - - Issues E_WARNING with type unsupported by XMLRPC. - - - - - &reftitle.examples; - - - A <function>xmlrpc_set_type</function> example - - - - -]]> - - &example.outputs.similar; - - - - - - 20090322T23:43:03 - - - -]]> - - - - - - - - diff --git a/reference/xmlrpc/reference.xml b/reference/xmlrpc/reference.xml deleted file mode 100644 index d6ae6851eca6..000000000000 --- a/reference/xmlrpc/reference.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - XML-RPC &Functions; - -&reference.xmlrpc.entities.functions; - - - - - diff --git a/reference/xmlrpc/setup.xml b/reference/xmlrpc/setup.xml deleted file mode 100644 index ecc711179009..000000000000 --- a/reference/xmlrpc/setup.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - &reftitle.setup; - - -
    - &reftitle.required; - &libxml.required; -
    - - - - &reference.xmlrpc.configure; - - - -
    - &reftitle.resources; - - This extension defines a XML-RPC server resource returned by - xmlrpc_server_create. - -
    - - -
    - - - diff --git a/reference/xmlrpc/versions.xml b/reference/xmlrpc/versions.xml deleted file mode 100644 index 7c4824bc8d73..000000000000 --- a/reference/xmlrpc/versions.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/xpass/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/xpass/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/xpass/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/xpass/book.xml b/reference/xpass/book.xml deleted file mode 100644 index 03b70aefa3ca..000000000000 --- a/reference/xpass/book.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - Xpass - Xpass - - - &reftitle.intro; - - This extension provides password hashing algorithms used by Linux - distributions, using extended crypt library. - - - It also provides additional functions from libxcrypt missing in core PHP. - - - - &reference.xpass.setup; - &reference.xpass.constants; - &reference.xpass.reference; - - - diff --git a/reference/xpass/constants.xml b/reference/xpass/constants.xml deleted file mode 100644 index fe9989e0cb40..000000000000 --- a/reference/xpass/constants.xml +++ /dev/null @@ -1,337 +0,0 @@ - - - - &reftitle.constants; - &extension.constants; - - - Xpass extension provides various set of constants. - Hash methods (CRYPT_PREFIX_*) for - crypt_gensalt prefix parameter. - Error codes (CRYPT_SALT_*) returned by - crypt_checksalt. - Password algorithms (PASSWORD_*) for - password_hash algo parameter. - - - - Hashing methods - - - CRYPT_PREFIX_STD_DES - (string) - - - - The original hashing method from Unix V7, based on the DES block cipher. - Because DES is cheap on modern hardware, - because there are only 4096 possible salts and 2**56 distinct passphrases, - which it truncates to 8 characters, - it is feasible to discover any passphrase hashed with this method. - It should only be used when supporting old operating systems that support - no other hash generation algorithm, due to how weak DES hashes are. - - - - - - CRYPT_PREFIX_EXT_DES - (string) - - - - An extension of traditional DES, which eliminates the length limit, - increases the salt size, and makes the time cost tunable. - It originates with BSDI BSD/OS and is also available on at least NetBSD, - OpenBSD, and FreeBSD due to the use of David Burren's FreeSec library. - It is much better than traditional DES and bigcrypt, - but still should not be used for new hashes. - - - - - - CRYPT_PREFIX_MD5 - (string) - - - - A hash based on the MD5 algorithm, originally developed by Poul-Henning Kamp for FreeBSD. - Supported on most free Unixes and newer versions of Solaris. - Not as weak as the DES-based hashes below, - but MD5 is so cheap on modern hardware that it should not be used for new hashes. - Processing cost is not adjustable. - - - - - - CRYPT_PREFIX_BLOWFISH - (string) - - - - A hash based on the Blowfish block cipher, modified to have an extra-expensive key schedule. - Originally developed by Niels Provos and David Mazieres for OpenBSD and also supported on recent - versions of FreeBSD and NetBSD, on Solaris 10 and newer, and on several GNU/*/Linux distributions. - - - - - - CRYPT_PREFIX_SHA256 - (string) - - - - A hash based on SHA-2 with 256-bit output, originally developed by Ulrich Drepper for GNU libc. - Supported on Linux but not common elsewhere. - Acceptable for new hashes. - The default processing cost parameter is 5000, - which is too low for modern hardware. - - - - - - CRYPT_PREFIX_SHA512 - (string) - - - - A hash based on SHA-2 with 512-bit output, originally developed by Ulrich Drepper for GNU libc. - Supported on Linux but not common elsewhere. - Acceptable for new hashes. - The default processing cost parameter is 5000, - which is too low for modern hardware. - - - - - - CRYPT_PREFIX_SCRYPT - (string) - - - - Scrypt is a password-based key derivation function created by Colin Percival, - originally for the Tarsnap online backup service. - The algorithm was specifically designed to make it costly to perform - large-scale custom hardware attacks by requiring large amounts of memory. - In 2016, the scrypt algorithm was published by IETF as RFC 7914. - - - - - - CRYPT_PREFIX_GOST_YESCRYPT - (string) - - - - Gost-yescrypt uses the output from yescrypt as an input message to HMAC with the - GOST R 34.11-2012 (Streebog) hash function with a 256-bit digest. - Thus, yescrypt's cryptographic properties are superseded by those of the GOST hash function. - This hashing method is useful in applications that need modern passphrase hashing, - but have to rely on GOST algorithms. - The GOST R 34.11-2012 (Streebog) hash function has been published by the IETF as RFC 6986. - Acceptable for new hashes where required. - - - - - - CRYPT_PREFIX_YESCRYPT - (string) - - - - Yescrypt is a scalable passphrase hashing scheme designed by Solar Designer, - which is based on Colin Percival's scrypt. - While yescrypt's strength against password guessing attacks comes from its algorithm design, - its cryptographic security is guaranteed by its use of SHA-256 on the outer layer. - The SHA-256 hash function has been published by NIST in FIPS PUB 180-2 - (and its subsequent revisions such as FIPS PUB 180-4) and by the IETF as RFC 4634 - (and subsequently RFC 6234). - Recommended for new hashes. - - - - - - CRYPT_PREFIX_SM3CRYPT - (string) - - - - A hash based on the ShangMi 3 hash function with 256-bit output, - that uses the same design as sha256crypt and/or sha512crypt. - Supported on EulerOS, Kylin, openEuler, and openKylin, but not common - elsewhere. Acceptable for new hashes where required. The default - processing cost parameter is 5000, which is too low for modern hardware. - - - Available as of 1.2.0 with libcxcrypt >= 4.5.0. - - - - - - CRYPT_PREFIX_SM3_YESCRYPT - (string) - - - - Sm3-yescrypt uses the output from yescrypt as an input message to HMAC - with the ShangMi 3 hash function with a 256-bit digest. Thus, yescrypt's - cryptographic properties are superseded by those of the ShangMi 3 hash - function. This hashing method is useful in applications that need modern - passphrase hashing, but have to rely on algorithms approved by the Chinese - Office of State Commercial Cryptography Administration (OSCCA). The ShangMi - 3 hash function has been published in Part 3: "Dedicated hash-functions" - of the ISO/IEC 10118-3:2018. Acceptable for new hashes where required. - - - Available as of 1.2.0 with libcxcrypt >= 4.5.0. - - - - - - - Error codes - - - CRYPT_SALT_OK - (int) - - - - No error. - - - - - - CRYPT_SALT_INVALID - (int) - - - - Unknown hashing method or invalid parameters. - - - - - - CRYPT_SALT_METHOD_DISABLED - (int) - - - - Hashing method is no longer allowed to be used. - - - - - - CRYPT_SALT_METHOD_LEGACY - (int) - - - - Hashing method is no longer considered strong enough. - - - - - - CRYPT_SALT_TOO_CHEAP - (int) - - - - Cost parameters are considered too cheap. - - - - - - - Password algorithms - - - PASSWORD_SHA512 - (string) - - - - PASSWORD_SHA512 is used to create new password - hashes using the CRYPT_PREFIX_SHA512 algorithm. - - - - - - PASSWORD_YESCRYPT - (string) - - - - PASSWORD_YESCRYPT is used to create new password - hashes using the CRYPT_PREFIX_YESCRYPT algorithm. - - - - - - PASSWORD_SM3CRYPT - (string) - - - - PASSWORD_SM3CRYPT is used to create new password - hashes using the CRYPT_PREFIX_SM3CRYPT algorithm. - - - Available as of 1.2.0 with libcxcrypt >= 4.5.0. - - - - - - PASSWORD_SM3_YESCRYPT - (string) - - - - PASSWORD_SM3_YESCRYPT is used to create new password - hashes using the CRYPT_PREFIX_SM3_YESCRYPT algorithm. - - - Available as of 1.2.0 with libcxcrypt >= 4.5.0. - - - - - - diff --git a/reference/xpass/functions/crypt-checksalt.xml b/reference/xpass/functions/crypt-checksalt.xml deleted file mode 100644 index 729de799630a..000000000000 --- a/reference/xpass/functions/crypt-checksalt.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - crypt_checksalt - Validate a crypt setting string - - - - &reftitle.description; - - stringnullcrypt_checksalt - stringsalt - - - Checks the salt string against the system configuration and reports whether - the hashing method and parameters it specifies are acceptable. - It is intended to be used to determine whether the user's passphrase should - be re-hashed using the currently preferred hashing method. - - - - - &reftitle.parameters; - - - salt - - - Salt string to check. - - - - - - - - &reftitle.returnvalues; - - Returns one of the - CRYPT_SALT_* - as an int. - - - - - &reftitle.examples; - - A <function>crypt_checksalt</function> example - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - crypt_gensalt - - - - - diff --git a/reference/xpass/functions/crypt-gensalt.xml b/reference/xpass/functions/crypt-gensalt.xml deleted file mode 100644 index fa837c031a5d..000000000000 --- a/reference/xpass/functions/crypt-gensalt.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - crypt_gensalt - Compile a string for use as the salt argument to crypt - - - - &reftitle.description; - - stringnullcrypt_gensalt - stringprefix&null; - intcount0 - - - Compile a string for use as the salt argument to crypt. - - - - - &reftitle.parameters; - - - prefix - - - Hashing method. - One of the CRYPT_PREFIX_* constant. - If &null;, the best available hashing method will be selected. - - - - - count - - - Controls the processing cost of the hash; - the valid range and exact meaning of count depend on the hashing method, - but larger numbers correspond to more costly hashes in - terms of CPU time and possibly memory usage. - If count is 0, a low default cost will be selected. - - - - - - - - &reftitle.returnvalues; - - Returns a string with the setting, or &null; in case of an error. - - - - - &reftitle.examples; - - A <function>crypt_gensalt</function> example - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - crypt_preferred_method - crypt - hash_equals - - - - - diff --git a/reference/xpass/functions/crypt-preferred-method.xml b/reference/xpass/functions/crypt-preferred-method.xml deleted file mode 100644 index 319480e2c23e..000000000000 --- a/reference/xpass/functions/crypt-preferred-method.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - crypt_preferred_method - Get the prefix of the preferred hash method - - - - &reftitle.description; - - stringnullcrypt_preferred_method - - - - Get the prefix of the preferred hash method. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a string with the prefix, or &null; in case of an error. - - - - - &reftitle.examples; - - A <function>crypt_preferred_method</function> example - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - crypt_gensalt - - - - - diff --git a/reference/xpass/reference.xml b/reference/xpass/reference.xml deleted file mode 100644 index b27e0f960cad..000000000000 --- a/reference/xpass/reference.xml +++ /dev/null @@ -1,28 +0,0 @@ - - - - Xpass &Functions; - - &reference.xpass.entities.functions; - - - diff --git a/reference/xpass/setup.xml b/reference/xpass/setup.xml deleted file mode 100644 index 6346f87dcb51..000000000000 --- a/reference/xpass/setup.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - &reftitle.setup; - -
    - &reftitle.required; - - This extension requires - libxcrypt - version 4.4 or higher. - -
    - -
    - Installation via PECL - - &pecl.info; - &url.pecl.package;xpass. - -
    - -
    - diff --git a/reference/xpass/versions.xml b/reference/xpass/versions.xml deleted file mode 100644 index 83dc31ab11af..000000000000 --- a/reference/xpass/versions.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - - - - - - - diff --git a/reference/yac/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/yac/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/yac/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/yac/book.xml b/reference/yac/book.xml deleted file mode 100644 index eb137f716dcf..000000000000 --- a/reference/yac/book.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - Yac - Yac - - - &reftitle.intro; - - Yac (Yet Another Cache) is a lock-free, shared memory user data cache, - and can be used to replace APC or local memcached. - - - Yac stores data in shared memory, which makes it visible to every PHP - worker of the same machine without any inter-process communication. - Instead of locking, Yac relies on atomic slot updates plus a few - collision probes, so a cache miss never blocks a request, and a - concurrent write can at worst cause a failed store or a missed read - that the caller can simply retry. - - - With no locks and no inter-process communication in the access - path, a read is essentially a hash lookup in shared memory. As a - result, Yac is extremely fast, with microsecond-level read - latency, and its throughput can scale with the number of - workers as long as writes are spread across keys; see the - benchmarks. - - - Because Yac trades correctness guarantees for speed and throughput, - it is best suited for data that is expensive to produce but easy to - recreate: page fragments, configuration snapshots, small service - responses, and other local caches. It should not be used as the - authoritative store for irreplaceable data. - - - As of yac 2.4.0, small scalar values — - NULL, booleans, most integers (those that fit in - 60 signed bits on 64-bit builds), strings of up to 7 bytes and empty - arrays — are stored directly inside the hash slot - instead of in a separate value block ("embedded values"), which - removes the value-memory allocation and block copy on every access - and significantly improves performance while reducing memory usage. - Version 2.4.0 also switched the compression backend from FastLZ to - LZ4, making compressed reads several times faster. - - - - Shared memory is only visible within one machine. To share a cache - across several servers, use a network cache such as Memcached or - Redis instead. - - - - - &reference.yac.setup; - &reference.yac.memory; - &reference.yac.constants; - - &reference.yac.yac; - - - - diff --git a/reference/yac/constants.xml b/reference/yac/constants.xml deleted file mode 100644 index 279d23bcde75..000000000000 --- a/reference/yac/constants.xml +++ /dev/null @@ -1,138 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - - - - YAC_VERSION - (string) - - - - The version of the extension as a string. - - - - - - YAC_MAX_KEY_LEN - (int) - - - - Maximum length of a key in bytes: 48. An instance prefix counts - against this limit. - - - - - - YAC_MAX_VALUE_RAW_LEN - (int) - - - - Maximum length of a value before serialization, in bytes: - 67,108,863 ((1 << 26) - 1). Larger values - are rejected. - - - - - - YAC_MAX_RAW_COMPRESSED_LEN - (int) - - - - Maximum size of a stored entry, in bytes: 1,048,576 (1M). Values - that do not fit even after compression are rejected. - - - - - - YAC_SERIALIZER_PHP - (int) - - - - Use the PHP serialize format as serializer (the default). - - - - - - YAC_SERIALIZER_JSON - (int) - - - - Use JSON as the serializer. Requires the extension to be built with - . - - - - - - YAC_SERIALIZER_IGBINARY - (int) - - - - Use igbinary as the serializer. Requires the extension to be built - with . - - - - - - YAC_SERIALIZER_MSGPACK - (int) - - - - Use msgpack as the serializer. Requires the extension to be built - with . - - - - - - YAC_SERIALIZER - (string) - - - - The serializer currently used by the extension. - - - - - - - - diff --git a/reference/yac/ini.xml b/reference/yac/ini.xml deleted file mode 100644 index cbf54bbd01d1..000000000000 --- a/reference/yac/ini.xml +++ /dev/null @@ -1,207 +0,0 @@ - - - -
    - &reftitle.runtime; - &extension.runtime; - - - Yac &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - yac.compress_threshold - 4K - INI_SYSTEM - - - - yac.debug - 0 - INI_ALL - - - - yac.enable - 1 - INI_SYSTEM - - - - yac.enable_cli - 0 - INI_SYSTEM - - - - yac.keys_memory_size - 8M - INI_SYSTEM - - - - yac.serializer - php - INI_SYSTEM - - - - yac.values_memory_size - 64M - INI_SYSTEM - - - - -
    -
    - - &ini.descriptions.title; - - - - - - yac.compress_threshold - int - - - - Serialized values larger than this number of bytes are - compressed (with LZ4, since Yac 2.4.0) before being stored. - Values above the 1M stored entry limit - (YAC_MAX_RAW_COMPRESSED_LEN) are always - compressed regardless of this setting, because they cannot be - stored uncompressed. The default of 4K - enables compression; -1 disables it for - values below the stored entry limit, and other positive values - are clamped to the - 1024..1M range. - Compressing large values saves shared memory at the cost of - some CPU on both store and retrieve. - - - - - - yac.debug - int - - - - Reserved for debugging. As of Yac 2.4.0 this directive is - registered but has no effect. - - - - - - yac.enable - int - - - - Whether Yac is enabled. If disabled, creating a - Yac instance throws an exception. - - - - - - yac.enable_cli - int - - - - Whether Yac is enabled when running under the - CLI SAPI. It is disabled by default because - command line scripts usually start and stop immediately, and the - shared memory segment would be created for nothing. - - - - - - yac.keys_memory_size - string - - - - Amount of shared memory for the table of keys. It caps how many - entries can exist at once — the default of - 8M gives around 65,536 entries. Raise this - when the hit rate drops and kicks climb; see - for how a full table - behaves and when that actually matters. - - - - - - yac.values_memory_size - string - - - - Amount of shared memory for storing values. Values are allocated - in a bump allocator over segments of 4M each; when no segment has - room for a new value, an allocator cursor wraps and the oldest - values are silently overwritten ("recycled"). Their reads then - degrade to misses, detected by an integrity guard. Enlarge this - if recycles climb while slots still have room, - or enable yac.compress_threshold - to shrink large payloads. See . - - - - - - yac.serializer - string - - - - Serializer used to turn arbitrary PHP values into bytes before - storing them. Allowed values are php (the - default), json, igbinary and - msgpack. The latter three require the extension - to be built with the corresponding support. Binary serializers such - as igbinary and msgpack are - typically faster and produce smaller payloads than - php. - - - - - - -
    - - diff --git a/reference/yac/memory.xml b/reference/yac/memory.xml deleted file mode 100644 index fce411d067f6..000000000000 --- a/reference/yac/memory.xml +++ /dev/null @@ -1,245 +0,0 @@ - - - - - Memory Management - - - Yac keeps its data in two independent shared-memory pools, configured - with - yac.keys_memory_size - and - yac.values_memory_size. - They fill up and free up in different ways, so it helps to know which - pool a symptom belongs to before touching either knob. - - -
    - What Each Pool Holds - - The two pools store different halves of an entry. The key pool holds - the keys: one slot per cached key, carrying the key itself (up to 48 - bytes) together with its hash, TTL, hit count and last-access time; - the value is only referenced through a pointer to the value pool. The - value pool holds the values: every stored value occupies one block of - serialized bytes — the compressed form when the entry went through - yac.compress_threshold. - - - The one exception is embedded values: tiny scalars — &null;, - &true;, &false;, most integers (those that fit in 60 signed bits on - 64-bit builds), strings of up to 7 bytes and empty arrays — are - stored directly inside the slot, in the pointer that would otherwise - reference a block. Such values occupy no space in the value pool at - all; only their key does. - - - As a rough sizing guide: - - - - the key pool holds around 8,000 keys per MB, so size - yac.keys_memory_size - as the number of distinct keys divided by 8,000 per MB, rounded up - — the default 8M holds around 64,000 keys; - - - - - the value pool must hold every value that may still be read, so - size - yac.values_memory_size - as the number of live values times their average serialized size - (after compression), and allow roughly twice that: the pool is a - ring, and a value only dies once the allocator cursor comes back - around to overwrite it. - - - - Embedded values occupy a slot like any other entry, but consume no - space in the value pool, so leave them out of the second calculation. - -
    - -
    - The key pool (slots) - - yac.keys_memory_size - holds a fixed-size table of slots — the default of - 8M gives around 65,536 slots. Each - stored key occupies exactly one slot, so this pool caps the number - of entries that can exist at once; unlike the value pool, slots are - never individually freed. An expired slot — one past its TTL, or the - tombstone left by Yac::delete — is recycled - for free when a new key needs it. Only when all four candidate slots - of a probe path hold live entries is one of them evicted to make - room — one kick (the - kicks counter of Yac::info). - - - The eviction picks among the four live candidates of the colliding - probe path only: - - - - the least recently used one (the oldest - atime) is evicted; - - - - - on a tie the least-hit entry, then the earliest probe position. - - - - - - A common point of confusion: slots_used reaching - slots_size is not an error - condition. A cache whose working set of keys is larger than the slot - table simply runs at 100% occupancy from then on, evicting and - re-inserting as needed. The only thing that says whether the key - pool is sized correctly is the hit rate - (hits / (hits + miss), computed over the deltas - between two Yac::info snapshots rather than - the lifetime average). A high kicks count on its - own means nothing is wrong — the key distribution is simply not - uniform and some probe paths collide more than others. Only when the - hit rate and kicks are both - bad is the table too small for the key set, and the remedy is a - bigger yac.keys_memory_size. - - - A second consequence of slots never being freed: entries with no TTL - (ttl = 0) that are never read again keep occupying - a slot until an eviction happens to pick them. If an application - stores large amounts of such one-shot data, give those entries a TTL - so they expire and can be recycled without displacing live entries, - or size the key pool for the full key set. - -
    - -
    - The value pool (segments) - - yac.values_memory_size - is split into segments of 4M each, managed as rings: writes advance a - per-segment cursor and space is never freed per entry. When an - allocation no longer fits, the cursor wraps back to the start of a - segment — one recycle (the - recycles counter of - Yac::info). A recycle does not invalidate - the segment at once: overwritten values stay readable until the - wrapped cursor actually overwrites them, at which point their reads - fail the integrity guard and turn into misses. - - - Two sizes matter for this pool: the total - yac.values_memory_size - must hold the working set of live values, and a single entry can - hold at most 1 MB as stored - (YAC_MAX_RAW_COMPRESSED_LEN). Values larger - than that are therefore always compressed before being stored; a - value that cannot shrink below 1 MB — most often because it is - random data — is rejected and bumps the - fails counter. The absolute size limit on the - value itself is much higher: serialized values above 64 MB - (YAC_MAX_VALUE_RAW_LEN, that is - (1 << 26) - 1 bytes) are rejected - outright. - -
    - -
    - Sizing and what to watch - - Start with the defaults and watch the counters of - Yac::info — they accumulate from - start_time, so compare two snapshots taken some - time apart: - - - - - hit rate healthy (say >= 90%): the cache is fine; nothing to do, - whatever the other counters show; - - - - - hit rate low and kicks climbing: the key pool is - too small for the key set — live entries get evicted before they are - re-read. Raise - yac.keys_memory_size; - - - - - recycles frequent: this is a real problem, not a - benign counter. A recycle means the value allocator has wrapped and is - about to overwrite entries — anything overwritten dies before it could - be re-read, so the bytes spent storing it were wasted and the hit rate - suffers. The value pool is too small for the volume of live data. In - order of impact: - - - - give entries a TTL. Values written with ttl = 0 - stay live forever, so they keep occupying the pool and force the - cursor to wrap sooner. A TTL bounds how long each entry may live, - shrinking the live working set the pool has to hold; - - - - - raise - yac.values_memory_size - so the pool holds the whole live value set (remember to budget - roughly twice the live footprint — a value only dies once the - cursor comes back around to overwrite it); - - - - - store less per entry: lower - yac.compress_threshold - if it is set above the 1024 minimum, so large - payloads are compressed, and trim values that do not need to be - cached in full; - - - - - - - - fails growing: values that could not be stored, - most often a single value larger than the 1 MB stored-size limit - even after compression — split the value. - - - -
    - -
    - - diff --git a/reference/yac/setup.xml b/reference/yac/setup.xml deleted file mode 100644 index 4defe5047af7..000000000000 --- a/reference/yac/setup.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - No external library is required. - -
    - - -
    - &reftitle.install; - - Yac can be installed in one of three ways: via PECL, via PIE, or - by building it from source. - - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;yac. - - - &pecl.windows.download.avail; - - - Installing Yac with PECL - - - - - - As of Yac 2.3.2, the extension can be installed with - &link.pie;, the PHP Installer for Extensions, by running the - following on the command line. - - - Installing Yac with PIE - - - - - - Optional serializers can be enabled at install time: - - - Installing Yac with PIE and a serializer - - - - - - The source code is hosted on - GitHub. To - build the extension from source, run the following on the command - line, replacing the paths with those of the local PHP - installation. - - - Building Yac from source - - - - - - The following configure options are available: - - - Values are compressed with LZ4 before being stored. The LZ4 - compression backend was introduced in Yac 2.4.0, replacing the - earlier FastLZ. By default, Yac uses the LZ4 copy bundled with the - extension; no extra flag is needed. To link against the system LZ4 - library instead, use the - switch, which - requires the lz4.h header and - liblz4 to be installed. - - - Alternative serializers can be compiled in with - , - or - , which register the - corresponding extension as an optional dependency. The serializer used at - runtime is selected with the - yac.serializer ini directive. - -
    - - - - &reference.yac.ini; - - -
    - &reftitle.resources; - - This extension does not define any resources. - -
    - -
    - - diff --git a/reference/yac/versions.xml b/reference/yac/versions.xml deleted file mode 100644 index afb0258b6387..000000000000 --- a/reference/yac/versions.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/yac/yac.xml b/reference/yac/yac.xml deleted file mode 100644 index fe96750dda71..000000000000 --- a/reference/yac/yac.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - The Yac class - Yac - - - - -
    - &reftitle.intro; - - The Yac class is the interface to the cache. - Every instance on the same host is a lightweight handle to one - shared cache: all instances read and write the same entries, and - creating one does no allocation beyond the handle itself. - - - The optional prefix passed to - Yac::__construct is prepended to every - key, so several instances (or applications) can share one cache - without their keys colliding. Besides the classic cache operations - (Yac::add, - Yac::set, - Yac::get, - Yac::delete and - Yac::flush), the class provides - Yac::info and - Yac::dump for inspecting the cache, and - overloads property access so that reading or writing an object - property reads or writes a cache entry. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yac - - - - - Yac - - - - &Properties; - - protected - _prefix - - - - &Methods; - - - - - -
    - - - -
    - &reftitle.properties; - - - _prefix - - - The key prefix set through - Yac::__construct. It is prepended to - every key used with the instance; no separator is inserted, so - include one in the prefix when needed. The prefix may not exceed - YAC_MAX_KEY_LEN (48) bytes. - - - - -
    - - - -
    - - &reference.yac.entities.yac; - -
    - - diff --git a/reference/yac/yac/add.xml b/reference/yac/yac/add.xml deleted file mode 100644 index 8da46466dc8e..000000000000 --- a/reference/yac/yac/add.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - - Yac::add - Store a value without overwriting an existing one - - - - &reftitle.description; - - public boolYac::add - stringarraykey - mixedvalue - intttl0 - - - public boolYac::add - arrayvalues - intttl0 - - - Stores a value in the cache. Unlike Yac::set, - it does not overwrite an existing entry that is still valid; the store - is rejected in that case. - - - - - &reftitle.parameters; - - - key - - - A string key, or an array of - key => value pairs to store in one call. - - - - - value - - - The value to store. Every PHP type except resource can - be stored. Only used in the single-key form; when - key is an array, this argument is instead the - optional ttl. - - - - - ttl - - - Time to live in seconds. 0 means the entry never - expires by time. - - - - - - - - &reftitle.returnvalues; - - Returns &true; on success, &false; on failure. A store is also rejected - (returning &false;) when the key already exists and has not expired. - - - - - &reftitle.examples; - - <methodname>Yac::add</methodname> example - -add("foo", "bar")); // bool(true) -var_dump($yac->add("foo", "baz")); // bool(false): "foo" already exists -?> -]]> - - - - Adding an entry with a TTL - -add("short-lived", "value", 5); -sleep(6); -var_dump($yac->get("short-lived")); // bool(false): expired -?> -]]> - - - - Adding multiple entries at once - - value pairs with one call, with a ttl -$yac->add(array("a" => 1, "b" => 2), 60); -?> -]]> - - - - - - &reftitle.seealso; - - - Yac::set - Yac::get - Yac::delete - - - - - - - diff --git a/reference/yac/yac/construct.xml b/reference/yac/yac/construct.xml deleted file mode 100644 index 87b4a3e6d589..000000000000 --- a/reference/yac/yac/construct.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - Yac::__construct - Constructor - - - - &reftitle.description; - - public Yac::__construct - stringprefix"" - - - Creates a new Yac instance. The optional - prefix is prepended to every key this instance stores, - which lets several applications or caches on the same machine use - overlapping key names without colliding. - - - - - &reftitle.parameters; - - - prefix - - - A key prefix, up to 48 bytes (YAC_MAX_KEY_LEN). - - - - - - - - &reftitle.errors; - - Throws an Exception if the cache is disabled - (yac.enable=0), or if prefix is - longer than 48 bytes. - - - - - &reftitle.examples; - - <methodname>Yac::__construct</methodname> example - -set("foo", "bar"); - -$other = new Yac("app2_"); -var_dump($other->get("foo")); // bool(false): different namespace -$other->set("foo", "baz"); // stored as "app2_foo" -?> -]]> - - - - - - &reftitle.seealso; - - - Yac::set - Yac::get - - - - - - - diff --git a/reference/yac/yac/delete.xml b/reference/yac/yac/delete.xml deleted file mode 100644 index 524a958f4e1c..000000000000 --- a/reference/yac/yac/delete.xml +++ /dev/null @@ -1,166 +0,0 @@ - - - - - - Yac::delete - Remove items from cache - - - - &reftitle.description; - - public boolYac::delete - stringarraykey - intdelay0 - - - Removes one or more items from the cache. - - - - Deletion is implemented by marking the entry expired rather than - clearing its slot: the entry immediately stops being readable, but - the slot stays occupied until the same key is stored again or a - later write reclaims the slot. As a result, the used-slot count - reported by Yac::info does not decrease - after a deletion, and Yac::dump still - lists the deleted entry until its slot is recycled; a non-zero - ttl in the past marks a deleted or expired - entry, so when inspecting the output of - Yac::dump, such entries have to be - filtered out by the caller. - - - - - - &reftitle.parameters; - - - key - - - A string key, or an array of keys to be - removed. - - - - - delay - - - Number of seconds before the item becomes invalid. When omitted or - 0, the item is invalidated immediately. A positive - value keeps the item readable for that many seconds before it - expires. - - - - - - - - &reftitle.returnvalues; - - Returns &true; on success, or &false; if the key was not present in - the cache. Because a deletion only marks the entry expired, a key - that was deleted but not yet overwritten still counts as present: - deleting the same key again returns &true;. - - - When an array of keys is given, &true; is returned - only if every key was present; if any key is missing, &false; is - returned. - - - - - &reftitle.examples; - - <methodname>Yac::delete</methodname> example - -set("foo", "bar"); - -var_dump($yac->delete("foo")); // bool(true): marked expired -var_dump($yac->get("foo")); // bool(false): a miss from now on -var_dump($yac->delete("foo")); // bool(true) again: the slot has not - // been overwritten yet -var_dump($yac->delete("never")); // bool(false): was never stored - -// a deletion does not free the slot: slots_used does not drop, and -// the expired entry still shows up in the dump -var_dump($yac->info()["slots_used"]); // int(1) -print_r($yac->dump()); // "foo" is still listed; its ttl - // is in the past -?> -]]> - - - - Delayed deletion - -set("tmp", "value"); -var_dump($yac->delete("tmp", 60)); // bool(true) -?> -]]> - - - - Deleting multiple keys at once - -set("tmp", "value"); - -// returns true only when every key was present -var_dump($yac->delete(array("tmp", "nope"))); // bool(false): "nope" missing -?> -]]> - - - - - - &reftitle.seealso; - - - Yac::set - Yac::flush - Yac::info - Yac::dump - - - - - - - diff --git a/reference/yac/yac/dump.xml b/reference/yac/yac/dump.xml deleted file mode 100644 index 68b3843b335f..000000000000 --- a/reference/yac/yac/dump.xml +++ /dev/null @@ -1,295 +0,0 @@ - - - - - - Yac::dump - Dump cache entries for inspection - - - - &reftitle.description; - - public arrayYac::dump - intlimit100 - intoffset0 - - - Dumps metadata of the entries currently stored in the cache. The - values themselves are not returned. - - - - - &reftitle.parameters; - - - limit - - - Maximum number of entries to return. - - - Passing -1 as limit dumps - every entry the cache currently holds. Note that building the - full list may use a considerable amount of memory for a large - cache; when memory matters, page through the entries with - limit and offset instead. - - - - - offset - - - Number of entries to skip before collecting. This parameter - is available as of PECL yac 2.4.0; earlier versions always - start from the first entry. Combined with - limit, it can be used to page through a - cache that holds more entries than one call may return. - - - - - - - - &reftitle.returnvalues; - - An array with one element per dumped entry. Each element - is itself an array describing the entry: - - - - index - - The slot index of the entry in the hash table. - - - - hash - - The 64-bit hash of the key, used for slot probing. - - - - crc - - The CRC32 checksum of the stored value, used to detect torn reads. - 0 for embedded entries, which have no value block. - - - - ttl - - The expiration timestamp (Unix time). 0 means the - entry never expires by time. Note that - Yac::delete only marks an entry expired, so - deleted entries can still show up in the dump; a non-zero - ttl in the past indicates an expired or deleted - entry. - - - - k_len - - The length of the key, in bytes. - - - - v_len - - The length of the value, in bytes. For compressed entries this is the - length of the original value before compression - (as of yac 2.4.0; earlier versions reported the stored, compressed - length). - - - - c_len - - Only present for compressed entries (as of yac 2.4.0): the length of - the compressed payload actually stored in shared memory, in bytes. - Comparing c_len with v_len shows - how much compression saves per entry. - - - - size - - The allocated size of the value block in shared memory, in bytes. - 0 for embedded entries. - - - - atime - - The last access time (Unix time), updated on each successful - Yac::get. When the cache is full, the entry - with the oldest atime among the candidate slots is - evicted first (as of yac 2.4.0). - - - - hits - - A per-entry hit counter, bumped on each successful - Yac::get and reset when the entry is - overwritten by a new Yac::set or - Yac::add (as of yac 2.4.0). - - - - embedded - - Whether the value is stored directly inside the slot instead of in a - separate value block (as of yac 2.4.0). Small values — - NULL, booleans, small integers, strings of up to - 7 bytes and empty arrays — are embedded this way and allocate no value - memory at all; for them crc and - size are reported as 0. - - - - key - - The cache key, without any instance prefix. - - - - - - - &reftitle.examples; - - <methodname>Yac::dump</methodname> example - -set("foo", "bar"); -$yac->set("baz", "qux"); - -print_r($yac->dump()); -?> -]]> - - &example.outputs.similar; - - Array - ( - [index] => 12345 - [hash] => 14463105906481965911 - [crc] => 0 - [ttl] => 0 - [k_len] => 3 - [v_len] => 3 - [size] => 0 - [atime] => 1725955200 - [hits] => 0 - [embedded] => 1 - [key] => foo - ) - - [1] => Array - ( - [index] => 12987 - [hash] => 15132029420525657053 - [crc] => 0 - [ttl] => 0 - [k_len] => 3 - [v_len] => 3 - [size] => 0 - [atime] => 1725955200 - [hits] => 0 - [embedded] => 1 - [key] => baz - ) - -) -]]> - - - Entries are listed in slot order, not in the order they were stored. - Embedded entries (short scalars kept inside the slot itself) have - crc and size set to zero; entries - stored in a separate value block carry their checksum and block size, - and compressed entries additionally carry c_len. - - - - Paging through a large cache - - limit bounds how many entries a single call returns, - and offset skips that many entries before collecting, - so the two can be combined to page through a cache that holds more - entries than one call may return. - - -set("key$i", $i); -} - -$page_size = 100; -$page_num = 2; - -// skip the first 100 entries and return the next 100 (page 2) -$page = $yac->dump($page_size, $page_size * ($page_num - 1)); - -var_dump(count($page)); -?> -]]> - - &example.outputs.similar; - - - - - Fewer entries than requested are returned when the cache holds fewer - entries than the requested page covers, and an empty array is returned - once the offset points past the last occupied slot. - - - - - - &reftitle.seealso; - - - Yac::info - - - - - - - diff --git a/reference/yac/yac/flush.xml b/reference/yac/yac/flush.xml deleted file mode 100644 index 8204479396c2..000000000000 --- a/reference/yac/yac/flush.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - Yac::flush - Flush the cache - - - - &reftitle.description; - - public boolYac::flush - - - - Removes all cached values. Because the cache is shared by every - process of the same machine, this empties the cache globally; the - key prefix given to Yac::__construct does - not limit what gets flushed. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true;. - - - - - &reftitle.examples; - - <methodname>Yac::flush</methodname> example - -set("foo", "bar"); - -$other = new Yac("app2_"); -$other->set("baz", "qux"); - -// flush empties the whole cache: entries of every instance, -// regardless of the prefix used when they were stored -$yac->flush(); - -var_dump($yac->get("foo")); // bool(false) -var_dump($other->get("baz")); // bool(false) -?> -]]> - - - - - - &reftitle.seealso; - - - Yac::delete - Yac::info - - - - - - - diff --git a/reference/yac/yac/get.xml b/reference/yac/yac/get.xml deleted file mode 100644 index fd8cd0548de4..000000000000 --- a/reference/yac/yac/get.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - - - Yac::get - Retrieve values from cache - - - - &reftitle.description; - - public mixedYac::get - stringarraykey - mixeddefault&null; - - - Retrieve values from cache - - - - - &reftitle.parameters; - - - key - - - A string key, or an array of keys. - - - - - default - - - The value to return when the requested key (or keys) is not - present in the cache, available as of yac 2.4.0. When omitted, a - miss returns &false;. - - - - Before yac 2.4.0, this argument slot held a by-reference - $cas token rather than a default value. Code - that passed or relied on that token must be updated when - upgrading to 2.4.0. - - - - - - - - - &reftitle.returnvalues; - - For a string key, returns the cached value on a hit, - otherwise the default (or &false; when no default - was given). - - - For an array of keys, returns an array containing the - found values indexed by their keys. Keys that are not present in - the cache are omitted from the result as of yac 2.4.0, or filled - with the default when one was given; before - 2.4.0, a &false; placeholder was inserted for every missing key. - - - - - - &reftitle.examples; - - <methodname>Yac::get</methodname> example - -set("foo", "bar"); -var_dump($yac->get("foo")); // string(3) "bar" -var_dump($yac->get("missing")); // bool(false): a miss -?> -]]> - - - - Telling a stored false apart from a miss - -set("flag", false); -var_dump($yac->get("flag")); // bool(false): the stored value -var_dump($yac->get("missing", false)); // bool(false): a miss, same shape -var_dump($yac->get("flag", "__NONE__")); // bool(false): the stored value -var_dump($yac->get("missing", "__NONE__")); // string(8) "__NONE__": a miss -?> -]]> - - - - Getting multiple keys at once - -set("foo", "bar"); -$yac->set("foo2", "bar2"); - -// with an array of keys, only the found keys are present in the result -var_dump($yac->get(array("foo", "foo2", "missing"))); -// array(2) { ["foo"]=> string(3) "bar" ["foo2"]=> string(4) "bar2" } -?> -]]> - - - - - - &reftitle.seealso; - - - Yac::set - Yac::__get - - - - - - - diff --git a/reference/yac/yac/getter.xml b/reference/yac/yac/getter.xml deleted file mode 100644 index 524758760392..000000000000 --- a/reference/yac/yac/getter.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - Yac::__get - Retrieve a value using property syntax - - - - &reftitle.description; - - public mixedYac::__get - stringkey - - - Retrieves a value from the cache, invoked when reading a property of a - Yac instance: $yac->foo is - equivalent to $yac->get("foo"). - - - - - &reftitle.parameters; - - - key - - - The property name, used as the cache key. - - - - - - - - &reftitle.returnvalues; - - The cached value on a hit, &null; when the key is not present in the - cache. - - - - Unlike Yac::get, property syntax cannot - distinguish a stored &null; from a missing key, and only supports - single keys. - - - - - - &reftitle.examples; - - <methodname>Yac::__get</methodname> example - -set("foo", "bar"); - -var_dump($yac->foo); // string(3) "bar" -var_dump($yac->missing); // NULL -?> -]]> - - - - - - &reftitle.seealso; - - - Yac::get - Yac::__set - - - - - - - diff --git a/reference/yac/yac/info.xml b/reference/yac/yac/info.xml deleted file mode 100644 index 572c5fc14f4d..000000000000 --- a/reference/yac/yac/info.xml +++ /dev/null @@ -1,191 +0,0 @@ - - - - - - Yac::info - Status of cache - - - - &reftitle.description; - - public arrayYac::info - - - - Get status of cache system - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an array with the following keys: - - - - memory_size - - Total shared memory in use, in bytes: the slot table plus the value - blocks. - - - - slots_memory_size - - Memory reserved for the hash slot table, in bytes. - - - - values_memory_size - - Memory reserved for the stored values, in bytes. - - - - segment_size - - Size of one value memory segment, in bytes. - - - - segment_num - - Number of value memory segments. - - - - miss - - Number of cache misses: lookups that found nothing or an expired - entry. - - - - hits - - Number of cache hits: successful lookups. - - - - fails - - Number of failed stores: stores that could not allocate a value - block. - - - - kicks - - Number of evictions: how often an existing entry had to be evicted - because the candidate slot path was full. - - - - recycles - - Number of times the allocator reached the end of a segment and - wrapped around to its beginning. - - - - start_time - - The Unix timestamp at which the shared memory cache was initialized. - - - - slots_size - - Total number of hash slots. - - - - slots_used - - Number of hash slots currently occupied. - - - - - - - &reftitle.examples; - - <methodname>Yac::info</methodname> example - -set("foo", "bar"); - -print_r($yac->info()); -?> -]]> - - &example.outputs.similar; - - 75497472 - [slots_memory_size] => 8388608 - [values_memory_size] => 67108864 - [segment_size] => 4194304 - [segment_num] => 16 - [miss] => 0 - [hits] => 0 - [fails] => 0 - [kicks] => 0 - [recycles] => 0 - [start_time] => 1725955200 - [slots_size] => 65536 - [slots_used] => 1 -) -]]> - - - The hit ratio can be computed as hits / (hits + miss); - a growing kicks or fails counter - indicates that the cache is under memory pressure. - - - - - - &reftitle.seealso; - - - Yac::dump - - - - - - - diff --git a/reference/yac/yac/set.xml b/reference/yac/yac/set.xml deleted file mode 100644 index c6d50eb6b02d..000000000000 --- a/reference/yac/yac/set.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - Yac::set - Store a value into the cache - - - - &reftitle.description; - - public boolYac::set - stringarraykey - mixedvalue - intttl0 - - - public boolYac::set - arrayvalues - intttl0 - - - Stores a value in the cache. If the key already exists, the existing - entry is overwritten, regardless of whether it has expired. - - - - - &reftitle.parameters; - - - key - - - A string key, or an array of - key => value pairs to store in one call. - - - - - value - - - The value to store. Every PHP type except resource can - be stored. Only used in the single-key form; when - key is an array, this argument is instead the - optional ttl. - - - - - ttl - - - Time to live in seconds. 0 means the entry never - expires by time. - - - - - - - - &reftitle.returnvalues; - - Returns &true; on success, &false; on failure. - - - - - &reftitle.examples; - - <methodname>Yac::set</methodname> example - -set("foo", "bar"); // store a single value -$yac->set("foo", "baz"); // overwrite the existing entry -?> -]]> - - - - Setting an entry with a TTL - -set("short-lived", "value", 5); -sleep(6); -var_dump($yac->get("short-lived")); // bool(false): expired -?> -]]> - - - - Setting multiple entries at once - - value pairs with one call -$yac->set(array("a" => 1, "b" => 2)); -?> -]]> - - - - - - &reftitle.seealso; - - - Yac::add - Yac::get - Yac::__set - - - - - - - diff --git a/reference/yac/yac/setter.xml b/reference/yac/yac/setter.xml deleted file mode 100644 index 55227798d11a..000000000000 --- a/reference/yac/yac/setter.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - Yac::__set - Store a value using property syntax - - - - &reftitle.description; - - public mixedYac::__set - stringkey - mixedvalue - - - Stores a value in the cache, invoked when writing a property of a - Yac instance: $yac->foo = "bar" - is equivalent to $yac->set("foo", "bar"), with no - ttl. - - - - - &reftitle.parameters; - - - key - - - The property name, used as the cache key. - - - - - value - - - The value to store. Every PHP type except resource can - be stored. - - - - - - - - &reftitle.returnvalues; - - Returns the stored value. - - - - - &reftitle.examples; - - <methodname>Yac::__set</methodname> example - -foo = "bar"; // stored without a ttl -var_dump($yac->get("foo")); // string(3) "bar" -?> -]]> - - - - - - &reftitle.seealso; - - - Yac::set - Yac::__get - - - - - - - diff --git a/reference/yaconf/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/yaconf/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/yaconf/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/yaconf/book.xml b/reference/yaconf/book.xml deleted file mode 100644 index d968aafa7a96..000000000000 --- a/reference/yaconf/book.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - Yaconf - Yaconf - - - &reftitle.intro; - - Yet Another Configurations Container - (Yaconf) is a configuration container. It parses - INI files when PHP starts up and keeps the result - in persistent memory for the whole PHP lifecycle, so every retrieval - is a fast hash lookup with no file I/O and no per-request parsing. - - - Yaconf stores all configurations as interned strings or immutable - arrays. They are not refcounted, so retrieving a configuration from - Yaconf is effectively zero-copy. Since Yaconf 1.2.0, the whole parsed - configuration tree is additionally compacted into a single contiguous - block, which lowers memory overhead and improves cache locality. - - - The parsed configuration lives in persistent memory shared by all - PHP-FPM workers through copy-on-write: until a configuration file - changes, the workers share the same physical memory pages no matter - how many of them are running. - - - Yaconf supports sections and section inheritance in INI files. On - non-ZTS builds it also reloads the files automatically when they - change; on ZTS (thread-safe) builds, configurations are loaded at - startup and a restart is required to pick up changes. - - - Since Yaconf 1.2.0, sub-directories of the configured directory are - loaded recursively (up to 16 levels deep) and addressed with the - directory name as a key level: for example, - Yaconf::get("users.database.master") reads the - master key from the file - database.ini placed in the - users/ sub-directory. - - - Storing sensitive configurations outside the web tree also lowers - the attack surface. Configuration files under the web root can be - retrieved by an attacker, for example through a file disclosure - vulnerability. With Yaconf, the .ini files can - instead be placed in a directory readable only by root, such as - /etc/yaconf: the PHP-FPM master loads the - configurations when the service starts, while the forked workers — - which run under an unprivileged user and are the ones executing - web requests — do not need, and are not given, access to that - directory. - - - Yaconf requires PHP 7.0 or greater. - - - - &reference.yaconf.setup; - &reference.yaconf.yaconf; - - - - diff --git a/reference/yaconf/configure.xml b/reference/yaconf/configure.xml deleted file mode 100644 index 956afad8ef94..000000000000 --- a/reference/yaconf/configure.xml +++ /dev/null @@ -1,35 +0,0 @@ - - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;yaconf - - - -
    - - - diff --git a/reference/yaconf/ini.xml b/reference/yaconf/ini.xml deleted file mode 100644 index 420d19f5badd..000000000000 --- a/reference/yaconf/ini.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - -
    - &reftitle.runtime; - &extension.runtime; - - - Yaconf &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - yaconf.directory - "" - INI_SYSTEM - - - - yaconf.check_delay - 300 - INI_SYSTEM - - - - -
    -
    - - &ini.descriptions.title; - - - - - - yaconf.directory - string - - - - The directory where all INI configuration files are placed. Only - files with the .ini extension are loaded. - Sub-directories are loaded recursively (up to 16 levels deep); - each one acts as a key level, so a file - database.ini placed in the - users/ sub-directory is addressed as - "users.database". Available since Yaconf - 1.2.0; before that only files directly in the directory were - loaded. - - - The examples below assume the following - database.ini placed in the configured - directory, alongside a features.ini that - carries per-feature settings. - - - INI file syntax - - - - - - INI sections example - - - - - - - - - yaconf.check_delay - int - - - - The interval, in seconds, at which Yaconf checks whether any - loaded INI file has changed and reloads the changed ones (the - change is detected by comparing directory modification times). - Setting it to 0 makes Yaconf check on every - request. - - - - This directive is only registered in non-ZTS builds. On ZTS - (thread-safe) builds configurations are loaded at startup and - automatic reloading is not available; restart PHP to pick up - changes. - - - - - - -
    - - diff --git a/reference/yaconf/setup.xml b/reference/yaconf/setup.xml deleted file mode 100644 index 9a9d5d6d8d64..000000000000 --- a/reference/yaconf/setup.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - Yaconf requires PHP 7.0 and above. - -
    - -
    - &reftitle.install; - - Yaconf can be installed in one of three ways: via PECL, via PIE, - or by building it from source. - - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;yaconf. - - - &pecl.windows.download.avail; - - - Installing Yaconf with PECL - - - - - - Since Yaconf 1.2.0, the extension can be installed with - &link.pie;, the PHP Installer for Extensions, by running the - following on the command line. - - - Installing Yaconf with PIE - - - - - - The source code is hosted on - GitHub. To - build the extension from source, run the following on the command - line, replacing the paths with those of the local PHP - installation. - - - Building Yaconf from source - - - - -
    - - &reference.yaconf.ini; - -
    - &reftitle.resources; - - - -
    - -
    - - diff --git a/reference/yaconf/versions.xml b/reference/yaconf/versions.xml deleted file mode 100644 index be012b6fd8a3..000000000000 --- a/reference/yaconf/versions.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - - - - - - - - diff --git a/reference/yaconf/yaconf.xml b/reference/yaconf/yaconf.xml deleted file mode 100644 index 1192bed93b67..000000000000 --- a/reference/yaconf/yaconf.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - The Yaconf class - Yaconf - - - - -
    - &reftitle.intro; - - Yaconf is a configurations container, - it parses INI files, stores the result in - PHP when PHP is started, the result lives - with the whole PHP lifecycle. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaconf - - - - - Yaconf - - - - - &Methods; - - - - -
    - -
    - - &reference.yaconf.entities.yaconf; - -
    - - diff --git a/reference/yaconf/yaconf/debuginfo.xml b/reference/yaconf/yaconf/debuginfo.xml deleted file mode 100644 index 834810185cf0..000000000000 --- a/reference/yaconf/yaconf/debuginfo.xml +++ /dev/null @@ -1,144 +0,0 @@ - - - - - - Yaconf::__debug_info - Inspect how a configuration value is stored - - - - &reftitle.description; - - public static arraynullYaconf::__debug_info - stringname - - - Returns debugging information about the value stored under - name: the memory address of the stored value - and whether the value still lives inside Yaconf's compacted storage - block. - - - - This method exists solely for Yaconf's own test suite, which - uses it to verify that the extension is working correctly. - Do not use it in production code, and do not rely on the - format of its output: the returned array may change at any - time. - - - - - - &reftitle.parameters; - - - name - - - The configuration name to inspect, using the same dot notation as - Yaconf::get. - - - - - - - - &reftitle.returnvalues; - - An array with four entries when the configuration - exists, &null; otherwise: - - - - - key — the name that was looked up. - - - - - address — the memory address of the stored - value. Values are stored as interned strings or immutable arrays, - so this address stays constant until the configuration is - reloaded. - - - - - val — the stored value itself. - - - - - changed — &false; while the value's data still - lives inside the compacted storage block, meaning the operating - system has not had to copy the page (copy-on-write still applies); - &true; when the value has been re-allocated outside the block. - - - - - - - &reftitle.examples; - - <methodname>Yaconf::__debug_info</methodname> example - - - string(8) "app.name" - ["address"]=> - string(14) "0x7f8b1c0a3d20" - ["val"]=> - string(4) "shop" - ["changed"]=> - bool(false) -} -*/ - -var_dump(Yaconf::__debug_info("app.missing")); // NULL -?> -]]> - - - - - - &reftitle.seealso; - - - Yaconf::get - Yaconf::has - - - - - - - diff --git a/reference/yaconf/yaconf/get.xml b/reference/yaconf/yaconf/get.xml deleted file mode 100644 index 9cbbd4e062f0..000000000000 --- a/reference/yaconf/yaconf/get.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - Yaconf::get - Retrieve a configuration value by name - - - - &reftitle.description; - - public static mixedYaconf::get - stringname - mixeddefault&null; - - - Retrieves the configuration value stored under - name. Names use dot notation to traverse - nested keys: "app" addresses the whole parsed - app.ini file, - "app.name" a key inside it, and since Yaconf - 1.2.0 "users.database.master" a key in the - file database.ini placed in the - users/ sub-directory. The dot notation - supports up to 64 levels of nesting. - - - - - &reftitle.parameters; - - - name - - - The configuration name to look up, using dot notation to - traverse nested keys, for example - "app.name", "app.features.1" - or, since Yaconf 1.2.0, "users.database.master" - for files in sub-directories. - - - - - default - - - The value to return when name is not - found. When omitted, &null; is returned. - - - - - - - - &reftitle.returnvalues; - - The stored configuration value, a string or an - array, when name exists; - otherwise the default (or &null; when no - default was given). - - - - - &reftitle.examples; - - The examples below assume the following two files placed in the - directory configured with yaconf.directory. - - - - - - - - - <methodname>Yaconf::get</methodname> example - - -]]> - - - - - - &reftitle.seealso; - - - Yaconf::has - Yaconf::__debug_info - - - - - - - diff --git a/reference/yaconf/yaconf/has.xml b/reference/yaconf/yaconf/has.xml deleted file mode 100644 index 8a77ab7974ff..000000000000 --- a/reference/yaconf/yaconf/has.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - Yaconf::has - Check whether a configuration value exists - - - - &reftitle.description; - - public static boolYaconf::has - stringname - - - Determines whether a configuration value exists under - name, which uses the same dot notation as - Yaconf::get: for example, "app.name" - or, since Yaconf 1.2.0, "users.database.master" for - files in sub-directories. - - - - - &reftitle.parameters; - - - name - - - The configuration name to look up, using dot notation to - traverse nested keys, for example "app.name" - or "users.database.master". - - - - - - - - &reftitle.returnvalues; - - Returns &true; if a configuration value exists at - name, &false; otherwise. - - - - - &reftitle.examples; - - The examples below assume an app.ini placed - in the directory configured with yaconf.directory, - holding the keys name="shop" and - debug=0. - - - <methodname>Yaconf::has</methodname> example - - -]]> - - - - - - &reftitle.seealso; - - - Yaconf::get - Yaconf::__debug_info - - - - - - - diff --git a/reference/yaf/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/yaf/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/yaf/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/yaf/appconfig.xml b/reference/yaf/appconfig.xml deleted file mode 100644 index 6ebd14ddef67..000000000000 --- a/reference/yaf/appconfig.xml +++ /dev/null @@ -1,432 +0,0 @@ - - - - - Application Configuration - - You should give an array of config or an ini config file(see - Yaf_Config_Ini) path to - Yaf_Application::__construct. - - - Yaf will merge the application configurations and user configurations - automatically. The application configurations have prefix "yaf." or - "application.". If both "yaf." and "application." exist, "application." - will be accepted preferentially. - - An PHP array example - - array( - "directory" => dirname(__FILE__), - "dispatcher" => array( - "catchException" => 0, - ), - "view" => array( - "ext" => "phtml", - ), - ), -); - -$app = new Yaf_Application($configs); - -?> -]]> - - - - An ini file example - - - - - - - When the configuration grows large, Yaf_Config_Ini, - which parses the ini file on every request, becomes noticeable overhead. - Yaconf parses all ini - files under one directory only once at PHP startup and keeps the parsed - values in shared memory. Set - yaconf.directory to the folder holding the - configuration, and pass the returned array to - Yaf_Application::__construct: - - - -]]> - - - A file that contains [section] headers is exposed as - one entry per section (inheritance, e.g. - [product : yaf], already resolved). Retrieve a single - section with a dot, - Yaconf::get("application.product"), and pass that - array instead; its keys are exactly the merged entries of that section. - - - - - - Yaf Application Config - - - - &Name; - &Default; - &Changelog; - - - - - application.directory - - - - - application.ext - "php" - - - - application.view.ext - "phtml" - - - - application.modules - "index" - - - - application.library - application.directory . "/library" - - - - application.library.directory - application.directory . "/library" - - - - application.library.namespace - "" - - - - application.bootstrap - application.directory . "/Bootstrap" . application.ext - - - - application.baseUri - "" - - - - application.dispatcher.defaultRoute - - - - - application.dispatcher.throwException - 1 - - - - application.dispatcher.catchException - 0 - - - - application.dispatcher.defaultModule - "index" - - - - application.dispatcher.defaultController - "index" - - - - application.dispatcher.defaultAction - "index" - - - - application.system - - - - - -
    -
    - - &ini.descriptions.title; - - - - - - application.directory - string - - - - The directory of the application, that is the folder which contains the - "controllers", "views", "models", "plugins" folders. - - - - - This config entry is the only one which doesn't has a default value. - You should always define it manually. - - - - - - - - application.ext - string - - - - The file ext of the PHP script, used in class autoloading( - Yaf_Loader). - - - - - - application.view.ext - string - - - - The file ext of the view template scripts. - - - - - - application.modules - string - - - - A comma-separated list of the registered modules, used in the route - process, especially while there are more than three segments in the PATH_INFO, - - - Yaf need a way to find out whether the first segment is a module name or not. - - - - - - application.library - string - - - - The local library directory, see Yaf_Loader and - yaf.library. - - - - After Yaf 2.1.6, this config entry can be an array. The library path - will try to use the items setted in application.library.directory - - - - - - - application.library.directory - string - - - - Alias of application.library. Introduced - in Yaf 2.1.6 - - - - - - application.library.namespace - string - - - - A comma-separated prefix of local library namespace. - - - Introduced in Yaf 2.1.6 - - - - - - application.bootstrap - string - - - - A absolute path of the Bootstrap class script. - - - - - - application.baseUri - string - - - - Used to remove a fixed prefix of request uri in route process. - Take a example, comes a request with request uri - "/prefix/controller/action". if you set application.baseUri to - "/prefix", then only "/controller/action" will take as the PATH_INFO in - route process. - - - In generally, there is no need to set this value. - - - - - - application.dispatcher.throwException - bool - - - - If it set to On, Yaf will throw an exception while some error occurring. - See also Yaf_Dispatcher::throwException. - - - - - - application.dispatcher.catchException - bool - - - - If it set to On, Yaf will forward to Error controller/Action while - there is an unhandled exception. See also - Yaf_Dispatcher::catchException. - - - - - - application.dispatcher.defaultRoute - string - - - - The default Route, if it is not specificed, Static route will be used - as default. See: - Yaf_Router::addRoute. - - - - - - application.dispatcher.defaultModule - string - - - - The default module name, see also - Yaf_Dispatcher::setDefaultModule. - - - - - - application.dispatcher.defaultController - string - - - - The default controller name, see also - Yaf_Dispatcher::setDefaultController. - - - - - - application.dispatcher.defaultAction - string - - - - The default action name, see also - Yaf_Dispatcher::setDefaultAction. - - - - - - - application.system - string - - - - Set yaf runtime configure in application.ini, like: - application.system.lowcase_path - - - only those INI_ALL configures can be set in this way - - - - - - - - -
    - - diff --git a/reference/yaf/book.xml b/reference/yaf/book.xml deleted file mode 100644 index 39a1e3af3ada..000000000000 --- a/reference/yaf/book.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - Yet Another Framework - Yaf - - - &reftitle.intro; - - The Yet Another Framework - (Yaf) extension is a PHP framework that is used to - develop web applications. - - - Unlike typical PHP frameworks, Yaf is written in C and compiled as an - extension: the framework classes, the autoloader, the router and the - dispatch loop all run in compiled code, so the per-request framework - overhead is measured in microseconds rather than milliseconds, and there - are no framework PHP files to load. It is designed for high-traffic - applications where bootstrap cost matters, and for long-lived service - runtimes (such as Swoole) where each request needs a clean dispatch - cycle. - - - Yaf implements the classical MVC architecture with a - single entry script, a configuration file with environment sections, - bootstrap hooks, a plugin system with seven dispatch hooks, six built-in - route types, a PSR-0 style autoloader - (Yaf_Loader) and a lightweight PHP template view - (Yaf_View_Simple). - - - A simple Yaf benchmark can be found at - Yaf Performance. For a - quick start guide, please refer to the - Tutorials section. - - - - Yaf requires PHP 7.0 or newer (the master branch of its source - repository); a php5 branch supports PHP 5.2 and newer. - - - - - &reference.yaf.setup; - &reference.yaf.constants; - &reference.yaf.tutorials; - &reference.yaf.appconfig; - &reference.yaf.yaf-application; - &reference.yaf.yaf-bootstrap-abstract; - &reference.yaf.yaf-dispatcher; - &reference.yaf.yaf-config-abstract; - &reference.yaf.yaf-config-ini; - &reference.yaf.yaf-config-simple; - &reference.yaf.yaf-controller-abstract; - &reference.yaf.yaf-action-abstract; - &reference.yaf.yaf-view-interface; - &reference.yaf.yaf-view-simple; - &reference.yaf.yaf-loader; - &reference.yaf.yaf-plugin-abstract; - &reference.yaf.yaf-registry; - &reference.yaf.yaf-request-abstract; - &reference.yaf.yaf-request-http; - &reference.yaf.yaf-request-simple; - &reference.yaf.yaf-response-abstract; - &reference.yaf.yaf-response-cli; - &reference.yaf.yaf-response-http; - &reference.yaf.yaf-route-interface; - &reference.yaf.yaf-route-map; - &reference.yaf.yaf-route-regex; - &reference.yaf.yaf-route-rewrite; - &reference.yaf.yaf-router; - &reference.yaf.yaf-route-simple; - &reference.yaf.yaf-route-static; - &reference.yaf.yaf-route-supervar; - &reference.yaf.yaf-session; - &reference.yaf.yaf-exception; - &reference.yaf.yaf-exception-typeerror; - &reference.yaf.yaf-exception-startuperror; - &reference.yaf.yaf-exception-dispatchfailed; - &reference.yaf.yaf-exception-routerfailed; - &reference.yaf.yaf-exception-loadfailed; - &reference.yaf.yaf-exception-loadfailed-module; - &reference.yaf.yaf-exception-loadfailed-controller; - &reference.yaf.yaf-exception-loadfailed-action; - &reference.yaf.yaf-exception-loadfailed-view; - - - - diff --git a/reference/yaf/configure.xml b/reference/yaf/configure.xml deleted file mode 100644 index 031b9c7d4395..000000000000 --- a/reference/yaf/configure.xml +++ /dev/null @@ -1,35 +0,0 @@ - - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;yaf - - - -
    - - - diff --git a/reference/yaf/constants.xml b/reference/yaf/constants.xml deleted file mode 100644 index 113e9e06e703..000000000000 --- a/reference/yaf/constants.xml +++ /dev/null @@ -1,215 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - When an error occurs during startup, routing, dispatching or - autoloading, Yaf either throws a subclass of - Yaf_Exception whose exception code is one of the - YAF_ERR_* constants, or triggers a PHP error of the - corresponding type — see - Yaf_Dispatcher::throwException and - Yaf_Application::getLastErrorNo. - - - - - - YAF_VERSION - (string) - - - - The version of the loaded Yaf extension, e.g. - "3.3.8". - - - - - - YAF_ENVIRON - (string) - - - - The value of the - yaf.environ - directive at the time the extension was started, used by - Yaf_Application to select the configuration - section. Defaults to "product". - - - - - - YAF_ERR_STARTUP_FAILED - (int) - - - - Startup failure, value 512. Thrown as a - Yaf_Exception_StartupError when - Yaf_Application could not be started, e.g. the - application directory is missing or the configuration is invalid. - - - - - - YAF_ERR_ROUTE_FAILED - (int) - - - - Routing failure, value 513. Thrown as a - Yaf_Exception_RouterFailed when no route was - able to route the request. - - - - - - YAF_ERR_DISPATCH_FAILED - (int) - - - - Dispatch failure, value 514. Thrown as a - Yaf_Exception_DispatchFailed when the request - could not be dispatched, e.g. when the - yaf.forward_limit is - exceeded. - - - - - - YAF_ERR_NOTFOUND_MODULE - (int) - - - - The module could not be found, value 515. Thrown - as a Yaf_Exception_LoadFailed_Module. - - - - - - YAF_ERR_NOTFOUND_CONTROLLER - (int) - - - - The controller could not be found, value 516. - Thrown as a - Yaf_Exception_LoadFailed_Controller. - - - - - - YAF_ERR_NOTFOUND_ACTION - (int) - - - - The action could not be found, value 517. Thrown - as a Yaf_Exception_LoadFailed_Action. - - - - - - YAF_ERR_NOTFOUND_VIEW - (int) - - - - The view script could not be found, value 518. - Thrown as a Yaf_Exception_LoadFailed_View. - - - - - - YAF_ERR_CALL_FAILED - (int) - - - - Calling a method failed, value 519. Used when an - action method or another callable could not be invoked. - - - - - - YAF_ERR_AUTOLOAD_FAILED - (int) - - - - Autoloading failed, value 520. Triggered by - Yaf_Loader when the file for a class cannot - be loaded, e.g. the resolved path is too long. - - - - - - YAF_ERR_TYPE_ERROR - (int) - - - - A type error occurred, value 521. Thrown as a - Yaf_Exception_TypeError when an argument or a - class definition has an unexpected type, e.g. a controller that is - not a class extending - Yaf_Controller_Abstract. - - - - - - YAF_ERR_ACCESS_ERROR - (int) - - - - Access is not allowed, value 522. Used, for - example, when attempting to call an action method that is not - public. - - - (Available since Yaf 3.2.0.) - - - - - - - - diff --git a/reference/yaf/ini.xml b/reference/yaf/ini.xml deleted file mode 100644 index ce4624f2f99a..000000000000 --- a/reference/yaf/ini.xml +++ /dev/null @@ -1,309 +0,0 @@ - - - -
    - &reftitle.runtime; - &extension.runtime; - - - Yaf &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - yaf.library - "" - INI_ALL - - - - yaf.environ - "product" - INI_SYSTEM - - - - yaf.forward_limit - 5 - INI_ALL - - - - yaf.use_namespace - 0 - INI_ALL - - - - yaf.action_prefer - 0 - INI_ALL - - - - yaf.lowcase_path - 0 - INI_ALL - - - - yaf.use_spl_autoload - 0 - INI_ALL - - - - yaf.name_suffix - 1 - INI_ALL - - - - yaf.name_separator - "" - INI_ALL - - - - -
    -
    - - &ini.descriptions.title; - - - - - The yaf.cache_config directive existed in Yaf 2.x, - where it cached the parsed result of the INI configuration file within - the PHP process. It was removed in Yaf 3.0.0 and is no longer - recognized. - - - - - - - - - yaf.library - string - - - - The global library directory. Yaf_Loader - searches this directory for classes that can not be found in the - application's local library (see - application.library). - - - See also Yaf_Loader::getLibraryPath and - Yaf_Loader::setLibraryPath. - - - - - - yaf.environ - string - - - - The environment name, "product" by default. It is - used by Yaf_Application to pick the section of - the INI configuration file (its first constructor argument) that - becomes the application configuration. - - - For example, if this value is "product", Yaf will - use the section named [product] in the INI - configuration file as the final configuration of the - Yaf_Application. The environment name can also - be overridden per application by passing the second constructor - argument to Yaf_Application::__construct. - - - - - - yaf.forward_limit - int - - - - The maximum number of times - Yaf_Controller_Abstract::forward can be - chained in a single request, 5 by default. - - - This is a protection against recursive - Yaf_Controller_Abstract::forward loops; when - the limit is exceeded, a Yaf_Exception_DispatchFailed - is thrown. Non-positive values are clamped to the default. - - - - - - yaf.use_namespace - int - - - - When enabled, all classes declared by Yaf are named in namespace - style: - - - \Yaf\Route\Rewrite -Yaf_Request_Http => \Yaf\Request\Http -]]> - - - There is an exception for classes whose last component is a reserved - keyword of PHP and thus cannot be used as a class name; such classes - keep the underscore in their last component: - - - \Yaf\Controller_Abstract -Yaf_Route_Static => \Yaf\Route_Static -]]> - - - - Only one of the two naming styles is registered when the extension - starts, so this directive must be set before the extension is - loaded; it can not be toggled per request in any meaningful way. - - - - - - - yaf.action_prefer - int - - - - When there is only one part in the PATH_INFO, - decides whether it should be considered as a controller name or as an - action name. - - - If this configure is on, the single segment is considered as an - action name, and the controller name falls back to the default - controller; otherwise it is considered as a controller name. - - - - - - yaf.lowcase_path - int - - - - Whether to lowercase all path components during class autoloading. - - - - - - yaf.use_spl_autoload - int - - - - When this value is on, if Yaf_Loader can not - find a class, it will return &false;, giving other autoload functions - a chance to be called. - - - When this value is off (the default), if - Yaf_Loader can not find a class, it will - return &true;, and the class autoloading fails immediately: - Yaf_Loader::autoload always returns &true; - in that mode. - - - - Yaf registers its loader during the instantiation of a - Yaf_Application, so any other autoloaders - registered before the instantiation will be called before - Yaf_Loader::autoload. - - - - - - - yaf.name_suffix - int - - - - When this is on (the default), Yaf_Loader - identifies an MVC class by its suffix to decide whether it is a - controller or an action class: IndexController, - IndexAction. - - - When this is off, Yaf_Loader looks at the - prefix of the class name instead: - Controller_Index, Action_Index. - - - - - - yaf.name_separator - string - - - - When this is not empty, Yaf_Loader identifies - MVC classes by this separator instead of the underscore that - separates the name and the MVC suffix. - - - For example, when this value is "_" and - yaf.name_suffix is on, - Yaf_Loader will take - Index_Controller as a controller class, while - IndexController is considered a normal class. - When it is empty (the default), the underscore is used. - - - - - -
    - - diff --git a/reference/yaf/setup.xml b/reference/yaf/setup.xml deleted file mode 100644 index d0ad3fbbe596..000000000000 --- a/reference/yaf/setup.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - &reftitle.setup; - - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;yaf. - - - Yaf has no external dependencies. Install it with: - - - - As of 3.3.8, Yaf can also be installed with &link.pie;, the PHP - Installer for Extensions: - - - - - - The source code is hosted on - GitHub. To build the - extension from source: - - - - and load it by adding the following line to the - php.ini: - - - - - - &pecl.windows.download.avail; - -
    - - - - &reference.yaf.ini; - - -
    - - diff --git a/reference/yaf/tutorials.xml b/reference/yaf/tutorials.xml deleted file mode 100644 index a1ce857edc09..000000000000 --- a/reference/yaf/tutorials.xml +++ /dev/null @@ -1,414 +0,0 @@ - - - - - &reftitle.examples; - -
    - Quick Start - - - A classic Application directory layout - - - - - Set the web server DocumentRoot to the - public directory, so that only the public - assets are accessible from the web. - - - - - A multi-module Application directory layout - - - - - In a multi-module application, each module has its own - controllers and views directory - under application/modules/<ModuleName>/. The - registered modules are declared in - application.modules. - - - - - Entry - - index.php in the public directory is the only way - into the application, you should rewrite all requests to it (you can - use .htaccess in Apache + mod_php, or the - equivalent in your web server, see below). - - -bootstrap() //call bootstrap methods defined in Bootstrap.php - ->run(); -?> -]]> - - - - - Rewrite rule - - "/index.php/$1", - ) -} -]]> - - - - - Bootstrap - - Any method of the Bootstrap class whose name - begins with _init is automatically called, in - definition order, by - Yaf_Application::bootstrap. Each such method - receives the Yaf_Dispatcher instance as its - argument. Methods with other names are not called automatically. - - - -]]> - - - - - Application config - - application.ini is the application configuration - file. Constants defined in index.php can be used - in it, and sections can inherit from one another. - - - - - - - - Application config as a PHP array - - Besides an INI configuration file, a plain PHP array can also be passed - to Yaf_Application::__construct as the - configuration. - - - array( - "directory" => APPLICATION_PATH . "/application/", - ), -); - -$app = new Yaf_Application($config); -?> -]]> - - - - - Default controller - - In Yaf, the default controller is named - IndexController: - - -getView()->content = "Hello World"; - } -} -?> -]]> - - - - - Default view template - - The view script for the default controller/action is - application/views/index/index.phtml. Yaf provides - a small view engine called Yaf_View_Simple, - whose templates are plain PHP scripts. - - - - - Hello World - - - - - -]]> - - - - - Run the Application - - Point the browser at the configured domain - (e.g. http://www.example.com) and the response - will look like: - - &example.outputs.similar; - - - - Hello World - - - hello world - - -]]> - - - - The minimal example above can also be generated with the Yaf code - generator (tools/cg/yaf_cg), which ships with - the Yaf - source repository: - - - - - - yaf_cg generates a more complete, commented - skeleton than the one shown in this tutorial: a - public/ entry with rewrite rules, a Bootstrap - with configuration, plugin and custom-route setup, an example - model, an error controller and view templates. It is a good - starting point for a real application. - - - - -
    - -
    - Custom Routes - - - Custom routes - - Besides the default Yaf_Route_Static route, - custom routes can be registered on the - Yaf_Router route stack, usually in a - _initRoute method of the Bootstrap, using - Yaf_Router::addRoute. Routes can also be - declared in configuration files and loaded with - Yaf_Router::addConfig. - - -getRouter(); - - // /user/123 -> controller=user, action=index, id=123 - $router->addRoute("user", new Yaf_Route_Rewrite( - "/user/:id", - array("controller" => "user", "action" => "index") - )); - } -} -?> -]]> - - - -
    - -
    - Plugins - - - Plugins - - A plugin hooks into the dispatch cycle by extending - Yaf_Plugin_Abstract and overriding one or more - of its six hook methods, then is registered on the dispatcher with - Yaf_Dispatcher::registerPlugin, typically in - the Bootstrap: - - -registerPlugin(new UserPlugin()); - } -} -?> -]]> - - - -
    - -
    - diff --git a/reference/yaf/versions.xml b/reference/yaf/versions.xml deleted file mode 100644 index 4a407519b6ef..000000000000 --- a/reference/yaf/versions.xml +++ /dev/null @@ -1,437 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/yaf/yaf-action-abstract.xml b/reference/yaf/yaf-action-abstract.xml deleted file mode 100644 index 32401e8bd414..000000000000 --- a/reference/yaf/yaf-action-abstract.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - The Yaf_Action_Abstract class - Yaf_Action_Abstract - - - - -
    - &reftitle.intro; - - An action can be defined in a separate file in Yaf (see - Yaf_Controller_Abstract). That is, an action - method can also be a Yaf_Action_Abstract class. - - - Since there should be a entry point which can be called by Yaf, - you must implement the abstract method - Yaf_Action_Abstract::execute in your custom - action class. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Action_Abstract - - - - - Yaf_Action_Abstract - - - - extends - Yaf_Controller_Abstract - - - - &Properties; - - protected - _controller - - - - &Methods; - - - &InheritedMethods; - - - - - -
    - - - -
    - &reftitle.properties; - - - _controller - - - The controller instance that owns this action, retrievable with - Yaf_Action_Abstract::getController. - - - - -
    - - - -
    - - &reference.yaf.entities.yaf-action-abstract; - -
    - - diff --git a/reference/yaf/yaf-application.xml b/reference/yaf/yaf-application.xml deleted file mode 100644 index 3ee8c83fa34f..000000000000 --- a/reference/yaf/yaf-application.xml +++ /dev/null @@ -1,182 +0,0 @@ - - - - - - The Yaf_Application class - Yaf_Application - - - - -
    - &reftitle.intro; - - Yaf_Application provides a bootstrapping facility - for applications which provides reusable resources, common- and - module-based bootstrap classes and dependency checking. - - - - Yaf_Application implements the singleton - pattern, and Yaf_Application can not be - serialized or unserialized, which will cause problems when you try - to use PHPUnit to write some test cases for Yaf. - - - You may use the @backupGlobals annotation of - PHPUnit to control the backup and restore operations for global - variables, thus solving this problem. - - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Application - - - - - final - Yaf_Application - - - - &Properties; - - protected - config - - - protected - dispatcher - - - protected - static - _app - - - protected - _modules - - - protected - _running - - - protected - _environ - - - protected - _err_no - - - protected - _err_msg - - - - &Methods; - - - - - -
    - - - -
    - &reftitle.properties; - - - config - - The application configuration object. - - - - dispatcher - - The Yaf_Dispatcher instance used by - this application. - - - - _app - - Static reference to the single running application - instance. - - - - _modules - - The list of registered module names, parsed from - application.modules. - - - - _running - - Whether the application is currently running. - - - - _environ - - The environment name of the application, defaults to - "product". - - - - _err_no - - The code of the last error, one of the - YAF_ERR_* constants. - - - - _err_msg - - The message of the last error. - - - -
    - - - -
    - - &reference.yaf.entities.yaf-application; - -
    - - diff --git a/reference/yaf/yaf-bootstrap-abstract.xml b/reference/yaf/yaf-bootstrap-abstract.xml deleted file mode 100644 index 1c8fde97b21f..000000000000 --- a/reference/yaf/yaf-bootstrap-abstract.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - The Yaf_Bootstrap_Abstract class - Yaf_Bootstrap_Abstract - - - - -
    - &reftitle.intro; - - Bootstrap is a mechanism used to do some initial config before a - Application run. - - - User may define their own Bootstrap class by inheriting - Yaf_Bootstrap_Abstract - - - Any method declared in Bootstrap class with leading "_init", will be - called by Yaf_Application::bootstrap one by one - according to their defined order. - -
    - - -
    - &reftitle.examples; - - Bootstrap example - - array( - "directory" => dirname(__FILE__) . "/application/", - ), - ); - - $app = new Yaf_Application($config); - $app->bootstrap(); -?> -]]> - - &example.outputs.similar; - - - - -
    - -
    - &reftitle.classsynopsis; - - - - Yaf_Bootstrap_Abstract - - - - - abstract - Yaf_Bootstrap_Abstract - - - &Properties; - - &Methods; - - - -
    - -
    - -
    - - diff --git a/reference/yaf/yaf-config-abstract.xml b/reference/yaf/yaf-config-abstract.xml deleted file mode 100644 index 291d66e50a09..000000000000 --- a/reference/yaf/yaf-config-abstract.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - The Yaf_Config_Abstract class - Yaf_Config_Abstract - - - - -
    - &reftitle.intro; - - Yaf_Config_Abstract is the base class of the - configuration adapters. It provides a uniform way to access a set of - configuration values through nested property syntax - ($config->section->key), array access and - iteration. Concrete implementations are - Yaf_Config_Ini (read-only, INI files with - section inheritance) and Yaf_Config_Simple - (PHP arrays, mutable). - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Config_Abstract - - - - - abstract - Yaf_Config_Abstract - - - - &Properties; - - protected - _config - - - protected - _readonly - - - - &Methods; - - - - -
    - - - -
    - &reftitle.properties; - - - _config - - - - - - _readonly - - - - - -
    - - - -
    - - &reference.yaf.entities.yaf-config-abstract; - -
    - - diff --git a/reference/yaf/yaf-config-ini.xml b/reference/yaf/yaf-config-ini.xml deleted file mode 100644 index 2a0a98dd8a5a..000000000000 --- a/reference/yaf/yaf-config-ini.xml +++ /dev/null @@ -1,205 +0,0 @@ - - - - - - The Yaf_Config_Ini class - Yaf_Config_Ini - - - - -
    - &reftitle.intro; - - Yaf_Config_Ini enables developers to store - configuration data in a familiar INI format and read it in the - application by using nested object property syntax. The INI format is - specialized to provide both the ability to have a hierarchy of - configuration data keys and inheritance between configuration data - sections. Configuration data hierarchies are supported by separating - the keys with the dot or period character ("."). A - section may extend or inherit from another section by following the - section name with a colon character (":") and the - name of the section from which data are to be inherited. - - - - Yaf_Config_Ini utilizes the - parse_ini_file PHP function. Please review this - documentation to be aware of its specific behaviors, which propagate - to Yaf_Config_Ini, such as how the special - values of "&true;", "&false;", "yes", "no", and "&null;" are handled. - - - - - Yaf_Config_Ini parses the configuration file - on every request. If an application manages a large amount of - (mostly static) configuration, consider the - Yaconf extension instead: it keeps - configuration in shared memory across the whole PHP lifecycle, so it - is parsed only once and can be accessed much more efficiently. - Yaconf understands the very same INI syntax — keys separated by dots, - and inheritance between sections through - "[section : parent]" — so the existing - application.ini can be served by Yaconf as-is; - only the way it is passed to - Yaf_Application::__construct changes (see the - tip in Application - Configuration). - - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Config_Ini - - - - - Yaf_Config_Ini - - - - extends - Yaf_Config_Abstract - - - - Iterator - - - - ArrayAccess - - - - Countable - - - - &Properties; - - - &Methods; - - - - &InheritedMethods; - - - - - -
    - - - -
    - &reftitle.properties; - - - _config - - - - - - _readonly - - - - - -
    - - -
    - &reftitle.examples; - - <function>Yaf_Config_Ini</function>example - - This example illustrates a basic use of Yaf_Config_Ini for loading - configuration data from an INI file. In this example there are - configuration data for both a production system and for a staging system. - Because the staging system configuration data are very similar to those - for production, the staging section inherits from the production section. - In this case, the decision is arbitrary and could have been written - conversely, with the production section inheriting from the staging - section, though this may not be the case for more complex situations. - Suppose, then, that the following configuration data are contained in - /path/to/config.ini: - - - - - -database->params->host); -var_dump($config->database->params->dbname); -var_dump($config->get("database.params.username")); -?> -]]> - - &example.outputs.similar; - - - - -
    - -
    - - &reference.yaf.entities.yaf-config-ini; - -
    - - diff --git a/reference/yaf/yaf-config-simple.xml b/reference/yaf/yaf-config-simple.xml deleted file mode 100644 index 5f6f0d22ff9b..000000000000 --- a/reference/yaf/yaf-config-simple.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - The Yaf_Config_Simple class - Yaf_Config_Simple - - - - -
    - &reftitle.intro; - - Yaf_Config_Simple is a configuration adapter - backed by a PHP array (or, optionally, an INI file). In contrast to - Yaf_Config_Ini it is mutable by default: - values can be changed at runtime, which makes it suitable both for - programmatically built configuration and for configuration that - needs to be adjusted during the request. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Config_Simple - - - - - Yaf_Config_Simple - - - - extends - Yaf_Config_Abstract - - - - Iterator - - - - ArrayAccess - - - - Countable - - - - &Properties; - - protected - _readonly - - - - &Methods; - - - - &InheritedMethods; - - - - - -
    - - - -
    - &reftitle.properties; - - - _config - - - - - - _readonly - - - - - -
    - - - -
    - - &reference.yaf.entities.yaf-config-simple; - -
    - - diff --git a/reference/yaf/yaf-controller-abstract.xml b/reference/yaf/yaf-controller-abstract.xml deleted file mode 100644 index 8d7c89e99bbf..000000000000 --- a/reference/yaf/yaf-controller-abstract.xml +++ /dev/null @@ -1,235 +0,0 @@ - - - - - - The Yaf_Controller_Abstract class - Yaf_Controller_Abstract - - - - -
    - &reftitle.intro; - - Yaf_Controller_Abstract is the heart of Yaf's - system. MVC stands for Model-View-Controller and is a design pattern - targeted at separating application logic from display logic. - - - Every custom controller shall inherit - Yaf_Controller_Abstract. - - - Since Yaf_Controller_Abstract::__construct is - called by Yaf with no arguments, - Yaf_Controller_Abstract provides an alternative - constructor-like hook: - Yaf_Controller_Abstract::init. - - - If you have defined a init() method in your custom controller, it will be - called as long as the controller was instantiated. - - - Action may have arguments, when a request coming, if there are the same - name variable in the request parameters(see - Yaf_Request_Abstract::getParam) after routed, - Yaf will pass them to the action method - (see Yaf_Action_Abstract::execute). - - - These arguments are directly fetched without filtering, it should be - carefully processed before use them. - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Controller_Abstract - - - - - abstract - Yaf_Controller_Abstract - - - - &Properties; - - protected - actions - - - protected - _module - - - protected - _name - - - protected - _request - - - protected - _response - - - protected - _invoke_args - - - protected - _view - - - - &Methods; - - - - - -
    - - - -
    - &reftitle.properties; - - - actions - - - You can also define an action method in a separate PHP script by using - this property and Yaf_Action_Abstract. - - define action in a separate file - - "actions/Dummy_action.php", - ); - - /* action method may have arguments */ - public function indexAction($name, $id) { - /* $name and $id are unsafe raw data */ - assert($name == $this->getRequest()->getParam("name")); - assert($id == $this->_request->getParam("id")); - } -} -?> -]]> - - - - Dummy_action.php - - -]]> - - - - - - - _module - - - The name of the module the controller belongs to. - - - - - _name - - - The name of the controller. - - - - - _request - - - The current Yaf_Request_Abstract object. - - - - - _response - - - The current Yaf_Response_Abstract object. - - - - - _invoke_args - - - The invocation arguments passed to the action through - Yaf_Controller_Abstract::forward, as an - array keyed by argument name. - - - - - _view - - - The Yaf_View_Interface object used to render - views. - - - - -
    - - - -
    - - &reference.yaf.entities.yaf-controller-abstract; - -
    - - diff --git a/reference/yaf/yaf-dispatcher.xml b/reference/yaf/yaf-dispatcher.xml deleted file mode 100644 index 1106bdfe3ee1..000000000000 --- a/reference/yaf/yaf-dispatcher.xml +++ /dev/null @@ -1,214 +0,0 @@ - - - - - - The Yaf_Dispatcher class - Yaf_Dispatcher - - - - -
    - &reftitle.intro; - - Yaf_Dispatcher purpose is to initialize - the request environment, route the incoming request, and then dispatch - any discovered actions; it aggregates any responses and returns them - when the process is complete. - - - Yaf_Dispatcher also implements the Singleton pattern, - meaning only a single instance of it may be available at any given time. This - allows it to also act as a registry on which the other objects in the - dispatch process may draw. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Dispatcher - - - - - final - Yaf_Dispatcher - - - - &Properties; - - protected - _router - - - protected - _view - - - protected - _request - - - protected - _plugins - - - protected - static - _instance - - - protected - _auto_render - - - protected - _return_response - - - protected - _instantly_flush - - - protected - _default_module - - - protected - _default_controller - - - protected - _default_action - - - &Methods; - - - - - -
    - - - -
    - &reftitle.properties; - - - _router - - The Yaf_Router instance used by the - dispatcher to route requests. - - - - _view - - The Yaf_View_Interface implementation - used to render views, lazily initialized on first dispatch. - - - - _request - - The request object being dispatched. - - - - _plugins - - The list of plugins registered with - Yaf_Dispatcher::registerPlugin. - - - - _instance - - Static reference to the single dispatcher - instance. - - - - _auto_render - - Whether the dispatcher automatically renders the view after - dispatching. Defaults to &true;. - - - - _return_response - - Whether Yaf_Application::run returns - the response object instead of sending it directly. Defaults to - &false;. - - - - _instantly_flush - - Whether the response body is flushed immediately when it is - set. Defaults to &true;. - - - - _default_module - - The default module name, from the - application.dispatcher.defaultModule - configuration entry. - - - - _default_controller - - The default controller name, from the - application.dispatcher.defaultController - configuration entry. - - - - _default_action - - The default action name, from the - application.dispatcher.defaultAction - configuration entry. - - - -
    - - - -
    - - &reference.yaf.entities.yaf-dispatcher; - -
    - - diff --git a/reference/yaf/yaf-exception-dispatchfailed.xml b/reference/yaf/yaf-exception-dispatchfailed.xml deleted file mode 100644 index c6eecbdb8c97..000000000000 --- a/reference/yaf/yaf-exception-dispatchfailed.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - The Yaf_Exception_DispatchFailed class - Yaf_Exception_DispatchFailed - - - - -
    - &reftitle.intro; - - Yaf_Exception_DispatchFailed is thrown when the - dispatcher fails to dispatch the routed request to a controller action. - Its error code is 514. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Exception_DispatchFailed - - - - - Yaf_Exception_DispatchFailed - - - - extends - Yaf_Exception - - - - &Properties; - - &Methods; - - &InheritedMethods; - - - - - -
    - - - - - - -
    - -
    - - diff --git a/reference/yaf/yaf-exception-loadfailed-action.xml b/reference/yaf/yaf-exception-loadfailed-action.xml deleted file mode 100644 index 46d6a9722328..000000000000 --- a/reference/yaf/yaf-exception-loadfailed-action.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - The Yaf_Exception_LoadFailed_Action class - Yaf_Exception_LoadFailed_Action - - - - -
    - &reftitle.intro; - - Yaf_Exception_LoadFailed_Action is thrown when the - requested action cannot be found or loaded. Its error code is - 517. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Exception_LoadFailed_Action - - - - - Yaf_Exception_LoadFailed_Action - - - - extends - Yaf_Exception_LoadFailed - - - - &Properties; - - - &Methods; - - &InheritedMethods; - - - - - -
    - - - - - - -
    - -
    - - diff --git a/reference/yaf/yaf-exception-loadfailed-controller.xml b/reference/yaf/yaf-exception-loadfailed-controller.xml deleted file mode 100644 index ec5e454d4800..000000000000 --- a/reference/yaf/yaf-exception-loadfailed-controller.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - The Yaf_Exception_LoadFailed_Controller class - Yaf_Exception_LoadFailed_Controller - - - - -
    - &reftitle.intro; - - Yaf_Exception_LoadFailed_Controller is thrown when - the requested controller cannot be found or loaded. Its error code is - 516. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Exception_LoadFailed_Controller - - - - - Yaf_Exception_LoadFailed_Controller - - - - extends - Yaf_Exception_LoadFailed - - - - &Properties; - - &Methods; - - &InheritedMethods; - - - - -
    - - - - - -
    - -
    - - diff --git a/reference/yaf/yaf-exception-loadfailed-module.xml b/reference/yaf/yaf-exception-loadfailed-module.xml deleted file mode 100644 index 4fb6a37a82d9..000000000000 --- a/reference/yaf/yaf-exception-loadfailed-module.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - The Yaf_Exception_LoadFailed_Module class - Yaf_Exception_LoadFailed_Module - - - - -
    - &reftitle.intro; - - Yaf_Exception_LoadFailed_Module is thrown when the - requested module cannot be found or loaded. Its error code is - 515. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Exception_LoadFailed_Module - - - - - Yaf_Exception_LoadFailed_Module - - - - extends - Yaf_Exception_LoadFailed - - - - &Properties; - - - &Methods; - - &InheritedMethods; - - - - - -
    - - - - - -
    - -
    - - diff --git a/reference/yaf/yaf-exception-loadfailed-view.xml b/reference/yaf/yaf-exception-loadfailed-view.xml deleted file mode 100644 index d02fe0035cbb..000000000000 --- a/reference/yaf/yaf-exception-loadfailed-view.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - The Yaf_Exception_LoadFailed_View class - Yaf_Exception_LoadFailed_View - - - - -
    - &reftitle.intro; - - Yaf_Exception_LoadFailed_View is thrown when the - requested view (template) script cannot be found or loaded. Its error code - is 518. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Exception_LoadFailed_View - - - - - Yaf_Exception_LoadFailed_View - - - - extends - Yaf_Exception_LoadFailed - - - - &Properties; - - - &Methods; - - &InheritedMethods; - - - - - -
    - - - - - - -
    - -
    - - diff --git a/reference/yaf/yaf-exception-loadfailed.xml b/reference/yaf/yaf-exception-loadfailed.xml deleted file mode 100644 index dbe3eb762d66..000000000000 --- a/reference/yaf/yaf-exception-loadfailed.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - The Yaf_Exception_LoadFailed class - Yaf_Exception_LoadFailed - - - - -
    - &reftitle.intro; - - Yaf_Exception_LoadFailed is thrown when the loader - fails to load a required script. Its error code is - 520. The more specific failures are represented by - its subclasses Yaf_Exception_LoadFailed_Module, - Yaf_Exception_LoadFailed_Controller, - Yaf_Exception_LoadFailed_Action and - Yaf_Exception_LoadFailed_View. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Exception_LoadFailed - - - - - Yaf_Exception_LoadFailed - - - - extends - Yaf_Exception - - - - &Properties; - - &Methods; - - &InheritedMethods; - - - - - -
    - - - - - - -
    - -
    - - diff --git a/reference/yaf/yaf-exception-routerfailed.xml b/reference/yaf/yaf-exception-routerfailed.xml deleted file mode 100644 index 846c845b9416..000000000000 --- a/reference/yaf/yaf-exception-routerfailed.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - The Yaf_Exception_RouterFailed class - Yaf_Exception_RouterFailed - - - - -
    - &reftitle.intro; - - Yaf_Exception_RouterFailed is thrown when routing - fails, for instance when no registered route matches the incoming request. - Its error code is 513. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Exception_RouterFailed - - - - - Yaf_Exception_RouterFailed - - - - extends - Yaf_Exception - - - - &Properties; - - - &Methods; - - &InheritedMethods; - - - - - -
    - - - - - - -
    - -
    - - diff --git a/reference/yaf/yaf-exception-startuperror.xml b/reference/yaf/yaf-exception-startuperror.xml deleted file mode 100644 index a13ce6f6ba23..000000000000 --- a/reference/yaf/yaf-exception-startuperror.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - The Yaf_Exception_StartupError class - Yaf_Exception_StartupError - - - - -
    - &reftitle.intro; - - Yaf_Exception_StartupError is thrown when the - application fails to start up, i.e. when an error occurs during the - initialization of Yaf_Application before routing - begins. Its error code is 512. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Exception_StartupError - - - - - Yaf_Exception_StartupError - - - - extends - Yaf_Exception - - - - &Properties; - - - &Methods; - - &InheritedMethods; - - - - - -
    - - - - - - -
    - -
    - - diff --git a/reference/yaf/yaf-exception-typeerror.xml b/reference/yaf/yaf-exception-typeerror.xml deleted file mode 100644 index e53f4382c95d..000000000000 --- a/reference/yaf/yaf-exception-typeerror.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - The Yaf_Exception_TypeError class - Yaf_Exception_TypeError - - - - -
    - &reftitle.intro; - - Yaf_Exception_TypeError is thrown when an argument - passed to a Yaf method is of an unexpected type or an invalid value. - Its error code is 521. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Exception_TypeError - - - - - Yaf_Exception_TypeError - - - - extends - Yaf_Exception - - - - &Properties; - - - &Methods; - - &InheritedMethods; - - - - - -
    - - - - - - -
    - -
    - - diff --git a/reference/yaf/yaf-exception.xml b/reference/yaf/yaf-exception.xml deleted file mode 100644 index 5c3a1fad0ad9..000000000000 --- a/reference/yaf/yaf-exception.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - The Yaf_Exception class - Yaf_Exception - - - - -
    - &reftitle.intro; - - Yaf_Exception is the base class of all exceptions - thrown by Yaf. Every other Yaf exception class extends it. - - - It extends RuntimeException when the SPL extension is - loaded, and the built-in Exception otherwise. - Exceptions raised by Yaf carry an error code that identifies the type of - failure. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Exception - - - - - Yaf_Exception - - - - extends - RuntimeException - - - - &InheritedProperties; - - - &Methods; - - - - &InheritedMethods; - - - - - -
    - - -
    - - &reference.yaf.entities.yaf-exception; - -
    - - diff --git a/reference/yaf/yaf-loader.xml b/reference/yaf/yaf-loader.xml deleted file mode 100644 index a45d73818a0a..000000000000 --- a/reference/yaf/yaf-loader.xml +++ /dev/null @@ -1,302 +0,0 @@ - - - - - - The Yaf_Loader class - Yaf_Loader - - - - -
    - &reftitle.intro; - - Yaf_Loader introduces a comprehensive autoloading - solution for Yaf. - - - The first time an instance of Yaf_Application is retrieved, - Yaf_Loader will instance a singleton, and registers itself with - spl_autoload. You retrieve an instance using the Yaf_Loader::getInstance - - - Yaf_Loader attempt to load a class only one shot, if - failed, depend on yaf.use_spl_autoload, if this - config is On Yaf_Loader::autoload will return - &false;, thus give the chance to other autoload function. if it is Off - (by default), Yaf_Loader::autoload will return - &true;, and more important is that a very useful warning will be triggered - (very useful to find out why a class could not be loaded). - - - Please keep yaf.use_spl_autoload Off unless there is some library have - their own autoload mechanism and impossible to rewrite it. - - - - - By default, Yaf_Loader assume all library (class - defined script) store in the global library - directory, which is defined in the php.ini(yaf.library). - - - - If you want Yaf_Loader search some - classes(libraries) in the local class - directory(which is defined in application.ini, and by default, - it is application.directory . "/library"), - you should register the class prefix using the - Yaf_Loader::registerLocalNameSpace - - - - Let's see some examples(assuming APPLICATION_PATH is application.directory): - - Config example - - - - - - Assuming the following local name space is registered: - - Register localnamespace - -registerLocalNameSpace(array("Foo", "Bar")); - } -} -?> -]]> - - - - Then the autoload examples: - - Load class example - - - // APPLICATION_PATH/library/Foo/Bar/Test.php - -class GLO_Name => - // /global_dir/Glo/Name.php - -class BarNon_Test - // /global_dir/Barnon/Test.php -]]> - - - - - Load namespace class example - - - // APPLICATION_PATH/library/Foo/Bar/Dummy.php - -class \FooBar\Bar\Dummy => - // /global_dir/FooBar/Bar/Dummy.php -]]> - - - - - - You may noticed that all the folder with the first letter capitalized, you can make them - lowercase by set yaf.lowcase_path = On in php.ini - - - - Yaf_Loader is also designed to load the MVC classes, - and the rule is: - - MVC class loading example - - -// APPLICATION_PATH/controllers/ - -Model Classes => -// APPLICATION_PATH/models/ - -Plugin Classes => -// APPLICATION_PATH/plugins/ -]]> - - - - Yaf identify a class's suffix(this is by default, you can also change to - the prefix by change the configure yaf.name_suffix) to decide whether it - is a MVC class: - - MVC class distinctions - - - // ***Controller - -Model Classes => - // ***Model - -Plugin Classes => - // ***Plugin -]]> - - - - some examples: - - MVC loading example - - - // APPLICATION_PATH/models/Data.php - -class DummyPlugin => - // APPLICATION_PATH/plugins/Dummy.php - -class A_B_TestModel => - // APPLICATION_PATH/models/A/B/Test.php -]]> - - - - - - As of 2.1.18, Yaf supports Controllers autoloading for user script side, - (which means the autoloading triggered by user php script, eg: access a - controller static property in Bootstrap or Plugins), - but autoloader only try to locate controller class script under the default - module folder, which is "APPLICATION_PATH/controllers/". - - - also, the directory will be affected by yaf.lowcase_path. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Loader - - - - - Yaf_Loader - - - - &Properties; - - protected - _local_ns - - - protected - _library - - - protected - _global_library - - - static - _instance - - - - &Methods; - - - - - -
    - - - -
    - &reftitle.properties; - - - _local_ns - - - - - - _library - - - By default, this value is application.directory . "/library", - you can change this either in the application.ini(application.library) or call to - Yaf_Loader::setLibraryPath - - - - - _global_library - - - - - - _instance - - - - - -
    - - - -
    - - - &reference.yaf.entities.yaf-loader; - -
    - - diff --git a/reference/yaf/yaf-plugin-abstract.xml b/reference/yaf/yaf-plugin-abstract.xml deleted file mode 100644 index 75eb7a837237..000000000000 --- a/reference/yaf/yaf-plugin-abstract.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - - - The Yaf_Plugin_Abstract class - Yaf_Plugin_Abstract - - - - -
    - &reftitle.intro; - - Plugins allow for easy extensibility and customization of the - framework. A plugin is a class extending - Yaf_Plugin_Abstract that overrides one or more - hook methods, which are called automatically at fixed points of the - dispatch cycle: before and after routing, before and after the - dispatch loop, and before and after each single dispatch. - - - A plugin is attached to the dispatcher with - Yaf_Dispatcher::registerPlugin, typically in - the Bootstrap; after registration, all the hook methods the plugin - implements are called at the proper time, each receiving the current - Yaf_Request_Abstract and - Yaf_Response_Abstract instances. - -
    - - -
    - &reftitle.examples; - - Plugin example - -registerPlugin(new TestPlugin()); - } - } - - /* plugin class should be placed under ./application/plugins/ */ - class TestPlugin extends Yaf_Plugin_Abstract { - public function routerStartup(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response) { - /* before router - in this hook, user can do some url rewrite */ - var_dump("routerStartup"); - } - public function routerShutdown(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response) { - /* router complete - in this hook, user can do login check */ - var_dump("routerShutdown"); - } - public function dispatchLoopStartup(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response) { - var_dump("dispatchLoopStartup"); - } - public function preDispatch(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response) { - var_dump("preDispatch"); - } - public function postDispatch(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response) { - var_dump("postDispatch"); - } - public function dispatchLoopShutdown(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response) { - /* final hook - in this hook user can do logging or implement layout */ - var_dump("dispatchLoopShutdown"); - } - } - - Class IndexController extends Yaf_Controller_Abstract { - public function indexAction() { - return FALSE; //prevent rendering - } - } - - $config = array( - "application" => array( - "directory" => dirname(__FILE__) . "/application/", - ), - ); - - $app = new Yaf_Application($config); - $app->bootstrap()->run(); -?> -]]> - - &example.outputs.similar; - - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Plugin_Abstract - - - - - Yaf_Plugin_Abstract - - - - - &Methods; - - - - -
    - -
    - - &reference.yaf.entities.yaf-plugin-abstract; - -
    - - diff --git a/reference/yaf/yaf-registry.xml b/reference/yaf/yaf-registry.xml deleted file mode 100644 index b87b998f3499..000000000000 --- a/reference/yaf/yaf-registry.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - The Yaf_Registry class - Yaf_Registry - - - - -
    - &reftitle.intro; - - Yaf_Registry is a global key-value store. All of - its methods are static, which makes it universally accessible, and - provides the ability to get or set any custom data from anywhere in - your code as necessary. - - - It is typically used to hold objects initialized in the Bootstrap - (a database connection, a logger, shared configuration) so that - controllers, actions and plugins can retrieve them without passing - them around. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Registry - - - - - Yaf_Registry - - - - &Properties; - - static - _instance - - - protected - _entries - - - - &Methods; - - - - - -
    - - - -
    - &reftitle.properties; - - - _instance - - - - - - _entries - - - - - -
    - - - -
    - - &reference.yaf.entities.yaf-registry; - -
    - - diff --git a/reference/yaf/yaf-request-abstract.xml b/reference/yaf/yaf-request-abstract.xml deleted file mode 100644 index 169fab2ccb82..000000000000 --- a/reference/yaf/yaf-request-abstract.xml +++ /dev/null @@ -1,237 +0,0 @@ - - - - - - The Yaf_Request_Abstract class - Yaf_Request_Abstract - - - - -
    - &reftitle.intro; - - Yaf_Request_Abstract is the base class of the - request objects. It encapsulates the request environment: the module, - controller and action resolved by routing, the request parameters, - and accessors for the superglobals (query string, POST, cookie, - server, environment and uploaded files). - - - Two concrete implementations are provided: - Yaf_Request_Http, initialized from an actual - web request, and Yaf_Request_Simple, a - synthetic request used in tests and CLI scripts. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Request_Abstract - - - - - Yaf_Request_Abstract - - - - &Constants; - - const - string - Yaf_Request_Abstract::SCHEME_HTTP - http - - - const - string - Yaf_Request_Abstract::SCHEME_HTTPS - https - - - &Properties; - - public - module - - - public - controller - - - public - action - - - public - method - - - protected - params - - - protected - language - - - protected - _exception - - - protected - _base_uri - - - protected - uri - - - protected - dispatched - - - protected - routed - - - - &Methods; - - - - -
    - - - -
    - &reftitle.properties; - - - module - - - - - - controller - - - - - - action - - - - - - method - - - - - - params - - - - - - language - - - - - - _exception - - - - - - _base_uri - - - - - - uri - - - - - - dispatched - - - - - - routed - - - - - -
    - - - - -
    - &reftitle.constants; - - - - Yaf_Request_Abstract::SCHEME_HTTP - - - - - - - Yaf_Request_Abstract::SCHEME_HTTPS - - - - - - -
    - - - -
    - - &reference.yaf.entities.yaf-request-abstract; - -
    - - diff --git a/reference/yaf/yaf-request-http.xml b/reference/yaf/yaf-request-http.xml deleted file mode 100644 index 503619397bf8..000000000000 --- a/reference/yaf/yaf-request-http.xml +++ /dev/null @@ -1,174 +0,0 @@ - - - - - - The Yaf_Request_Http class - Yaf_Request_Http - - - - -
    - &reftitle.intro; - - Any request from client is initialized as a - Yaf_Request_Http. - you can get the request information like, uri query and - post parameters via methods of this class. - - - For security, $_GET/$_POST are readonly in Yaf, which means - if you set a value to these global variables, you can not get it from - Yaf_Request_Http::getQuery or - Yaf_Request_Http::getPost. - - - But there do is some usage need such feature, like unit testing. thus - Yaf can be built with --enable-yaf-debug, which will allow Yaf read the - value user set via script. - - - in such case, Yaf will throw a E_STRICT warning to remind you about - that: Strict Standards: you are running yaf in debug mode - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Request_Http - - - - - Yaf_Request_Http - - - - extends - Yaf_Request_Abstract - - - - &Properties; - - - &Methods; - - - &InheritedMethods; - - - - - -
    - - - -
    - &reftitle.properties; - - - module - - - - - - controller - - - - - - action - - - - - - method - - - - - - params - - - - - - language - - - - - - _exception - - - - - - _base_uri - - - - - - uri - - - - - - dispatched - - - - - - routed - - - - - -
    - - - -
    - - &reference.yaf.entities.yaf-request-http; - -
    - - diff --git a/reference/yaf/yaf-request-simple.xml b/reference/yaf/yaf-request-simple.xml deleted file mode 100644 index ba7ebb97af0a..000000000000 --- a/reference/yaf/yaf-request-simple.xml +++ /dev/null @@ -1,193 +0,0 @@ - - - - - - The Yaf_Request_Simple class - Yaf_Request_Simple - - - - -
    - &reftitle.intro; - - Yaf_Request_Simple is particularlly used for test - puporse. ie. simulate some espacial request under CLI mode. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Request_Simple - - - - - Yaf_Request_Simple - - - - extends - Yaf_Request_Abstract - - - - &Constants; - - const - string - Yaf_Request_Simple::SCHEME_HTTP - http - - - const - string - Yaf_Request_Simple::SCHEME_HTTPS - https - - - &Properties; - - - &Methods; - - - &InheritedMethods; - - - - - -
    - - - -
    - &reftitle.properties; - - - module - - - - - - controller - - - - - - action - - - - - - method - - - - - - params - - - - - - language - - - - - - _exception - - - - - - _base_uri - - - - - - uri - - - - - - dispatched - - - - - - routed - - - - - -
    - - - - -
    - &reftitle.constants; - - - - Yaf_Request_Simple::SCHEME_HTTP - - - - - - - Yaf_Request_Simple::SCHEME_HTTPS - - - - - - -
    - - - -
    - - &reference.yaf.entities.yaf-request-simple; - -
    - - diff --git a/reference/yaf/yaf-response-abstract.xml b/reference/yaf/yaf-response-abstract.xml deleted file mode 100644 index ef6ce61a3cff..000000000000 --- a/reference/yaf/yaf-response-abstract.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - The Yaf_Response_Abstract class - Yaf_Response_Abstract - - - - -
    - &reftitle.intro; - - Yaf_Response_Abstract is the base class of the - response object, which carries the headers and the content blocks to - be sent to the client. It is instantiated by - Yaf_Dispatcher; use - Yaf_Dispatcher::getResponse to access it, - typically inside controllers, actions or plugins. - - - The concrete subclasses are Yaf_Response_Http - (used in web SAPIs, which actually sends HTTP headers) and - Yaf_Response_Cli (used on the command line). - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Response_Abstract - - - - - Yaf_Response_Abstract - - - - &Constants; - - const - string - Yaf_Response_Abstract::DEFAULT_BODY - "content" - - - &Properties; - - protected - _header - - - protected - _body - - - protected - _sendheader - - - - &Methods; - - - - - -
    - - - -
    - &reftitle.properties; - - - _header - - - The HTTP headers set so far, as an array of header name/value - pairs. Only meaningful for - Yaf_Response_Http. - - - - - _body - - - The content blocks, keyed by the content key (by default - content, i.e. - Yaf_Response_Abstract::DEFAULT_BODY). - - - - - _sendheader - - - Whether headers should be sent together with the content. In - Yaf_Response_Http it also tracks whether the - headers have been sent already. - - - - -
    - - - -
    - - &reference.yaf.entities.yaf-response-abstract; - -
    - - diff --git a/reference/yaf/yaf-response-cli.xml b/reference/yaf/yaf-response-cli.xml deleted file mode 100644 index d7167dad303e..000000000000 --- a/reference/yaf/yaf-response-cli.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - The Yaf_Response_Cli class - Yaf_Response_Cli - - - - -
    - &reftitle.intro; - - Yaf_Response_Cli is the response adapter used - for command-line (CLI) requests. Unlike its HTTP counterpart, it does - not send headers, but simply accumulates the response body and - outputs it directly when the dispatch cycle completes. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Response_Cli - - - - - Yaf_Response_Cli - - - - extends - Yaf_Response_Abstract - - - - &Properties; - - - &InheritedMethods; - - - - - -
    - - - -
    - &reftitle.properties; - - - _header - - - - - - _body - - - - - - _sendheader - - - - - -
    - - - -
    - -
    - - diff --git a/reference/yaf/yaf-response-http.xml b/reference/yaf/yaf-response-http.xml deleted file mode 100644 index bbac5a396350..000000000000 --- a/reference/yaf/yaf-response-http.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - The Yaf_Response_Http class - Yaf_Response_Http - - - - -
    - &reftitle.intro; - - Yaf_Response_Http is the response adapter used - for web requests. It accumulates the headers and body set during the - dispatch cycle and sends them to the client when the dispatch - completes, unless - Yaf_Dispatcher::returnResponse is enabled. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Response_Http - - - - - Yaf_Response_Http - - - - extends - Yaf_Response_Abstract - - - - &Properties; - - protected - _sendheader - - - protected - _response_code - - - - &InheritedMethods; - - - - - -
    - - - -
    - &reftitle.properties; - - - _header - - - - - - _body - - - - - - _sendheader - - - - - - _response_code - - - - - -
    - - - -
    - -
    - - diff --git a/reference/yaf/yaf-route-interface.xml b/reference/yaf/yaf-route-interface.xml deleted file mode 100644 index 5ba5a83e0cf0..000000000000 --- a/reference/yaf/yaf-route-interface.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - The Yaf_Route_Interface class - Yaf_Route_Interface - - - - -
    - &reftitle.intro; - - Yaf_Route_Interface defines the contract every - route must implement: Yaf_Route_Interface::route, - which inspects the request and claims it by setting the module, - controller and action (and optionally request parameters), and - Yaf_Route_Interface::assemble, which builds a - URL from route info. - - - Implement this interface to define a custom route, and register it on - the router with Yaf_Router::addRoute. The - built-in route classes - (Yaf_Route_Static, - Yaf_Route_Simple, - Yaf_Route_Supervar, - Yaf_Route_Rewrite, - Yaf_Route_Regex and - Yaf_Route_Map) all implement it. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Route_Interface - - - - - Yaf_Route_Interface - - - - - &Methods; - - - - -
    - -
    - - &reference.yaf.entities.yaf-route-interface; - -
    - - diff --git a/reference/yaf/yaf-route-map.xml b/reference/yaf/yaf-route-map.xml deleted file mode 100644 index e964c197f3de..000000000000 --- a/reference/yaf/yaf-route-map.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - The Yaf_Route_Map class - Yaf_Route_Map - - - - -
    - &reftitle.intro; - - Yaf_Route_Map is a built-in route that converts - the whole URI endpoint (that part of the URI which comes after the - base URI: see Yaf_Request_Abstract::setBaseUri) - into a single controller name or action name, depending on the - first argument passed to - Yaf_Route_Map::__construct. The path - segments are joined with underscores: - - - A => A - A/B/C => A_B_C - A/B/C/D/E => A_B_C_D_E - - - When the mapping goes to a controller name, its first letter is - uppercased. - - - If the second argument of - Yaf_Route_Map::__construct is specified, only - the part of the URI before the delimiter is used for routing, while - the part after it is parsed as request parameters (see the example - section of Yaf_Route_Map::__construct). - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Route_Map - - - - - Yaf_Route_Map - - - - Yaf_Route_Interface - - - - &Properties; - - protected - _ctl_router - - - protected - _delimiter - - - - &Methods; - - - - - -
    - - - -
    - &reftitle.properties; - - - _ctl_router - - - - - - _delimiter - - - - - -
    - - - -
    - - &reference.yaf.entities.yaf-route-map; - -
    - - diff --git a/reference/yaf/yaf-route-regex.xml b/reference/yaf/yaf-route-regex.xml deleted file mode 100644 index 25a75bd5944d..000000000000 --- a/reference/yaf/yaf-route-regex.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - The Yaf_Route_Regex class - Yaf_Route_Regex - - - - -
    - &reftitle.intro; - - Yaf_Route_Regex is the most flexible route among - the Yaf built-in routes: it matches the request URI against a regular - expression. When the pattern matches, the default module, controller and - action are used, and the captured subpatterns are assigned to request - parameters through a numeric map. - - - It is similar to Yaf_Route_Rewrite, but instead - of a human-friendly pattern it takes a full PCRE pattern, which makes - it able to express matching rules that the other built-in routes - cannot. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Route_Regex - - - - - Yaf_Route_Regex - - - - extends - Yaf_Route_Interface - - - - Yaf_Route_Interface - - - - &Properties; - - protected - _route - - - protected - _default - - - protected - _maps - - - protected - _verify - - - - &Methods; - - - - &InheritedMethods; - - - - - -
    - - - -
    - &reftitle.properties; - - - _route - - - - - - _default - - - - - - _maps - - - - - - _verify - - - - - -
    - - - -
    - - &reference.yaf.entities.yaf-route-regex; - -
    - - diff --git a/reference/yaf/yaf-route-rewrite.xml b/reference/yaf/yaf-route-rewrite.xml deleted file mode 100644 index 44abffb3029a..000000000000 --- a/reference/yaf/yaf-route-rewrite.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - The Yaf_Route_Rewrite class - Yaf_Route_Rewrite - - - - -
    - &reftitle.intro; - - Yaf_Route_Rewrite is a built-in route that maps - a fixed path pattern to a module, controller and action. The pattern - may contain named placeholders (:name, whose value - is set as a request parameter) and a trailing * - wildcard that captures the remaining segments as key/value pairs. - - - For usage, please see the example section of - Yaf_Route_Rewrite::__construct. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Route_Rewrite - - - - - Yaf_Route_Rewrite - - - - extends - Yaf_Route_Interface - - - - Yaf_Route_Interface - - - - &Properties; - - protected - _route - - - protected - _default - - - protected - _verify - - - - &Methods; - - - - &InheritedMethods; - - - - - -
    - - - -
    - &reftitle.properties; - - - _route - - - - - - _default - - - - - - _verify - - - - - -
    - - - -
    - - &reference.yaf.entities.yaf-route-rewrite; - -
    - - diff --git a/reference/yaf/yaf-route-simple.xml b/reference/yaf/yaf-route-simple.xml deleted file mode 100644 index a2d2fe8a0287..000000000000 --- a/reference/yaf/yaf-route-simple.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - The Yaf_Route_Simple class - Yaf_Route_Simple - - - - -
    - &reftitle.intro; - - Yaf_Route_Simple resolves the route info from - the query string. All you need to do is tell - Yaf_Route_Simple which key in - $_GET is the module, which key is the controller, - and which key is the action. - - - Yaf_Route_Simple::route claims the request - (returns &true;) as soon as at least one of those keys is present in - the query string, so routes registered after it in the stack will not - be tried for such a request. It only passes (returns &false;) when - none of the configured keys appear. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Route_Simple - - - - - Yaf_Route_Simple - - - - Yaf_Route_Interface - - - - &Properties; - - protected - controller - - - protected - module - - - protected - action - - - - &Methods; - - - - - -
    - - - -
    - &reftitle.properties; - - - controller - - - - - - module - - - - - - action - - - - - -
    - - - -
    - - &reference.yaf.entities.yaf-route-simple; - -
    - - diff --git a/reference/yaf/yaf-route-static.xml b/reference/yaf/yaf-route-static.xml deleted file mode 100644 index d3d336460cf5..000000000000 --- a/reference/yaf/yaf-route-static.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - The Yaf_Route_Static class - Yaf_Route_Static - - - - -
    - &reftitle.intro; - - Yaf_Route_Static is the default route of - Yaf_Router: it parses the URI path as - /module/controller/action segments and is designed - to handle most routing needs out of the box. - - - - It is unnecessary to instantiate a - Yaf_Route_Static, or to add it to the route - stack of Yaf_Router: there is always one - present in the stack, and it is always tried last. - - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Route_Static - - - - - Yaf_Route_Static - - - - Yaf_Router - - - - - &Methods; - - - - -
    - -
    - - &reference.yaf.entities.yaf-route-static; - -
    - - diff --git a/reference/yaf/yaf-route-supervar.xml b/reference/yaf/yaf-route-supervar.xml deleted file mode 100644 index 7110a258d523..000000000000 --- a/reference/yaf/yaf-route-supervar.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - The Yaf_Route_Supervar class - Yaf_Route_Supervar - - - - -
    - &reftitle.intro; - - Yaf_Route_Supervar is a built-in route that - resolves the request target from a single GET parameter (the - supervar). The value of that parameter is parsed the same way as - PATH_INFO, so a request such as - /?r=/user/list maps to controller - user and action list when the - supervar name is r. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Route_Supervar - - - - - Yaf_Route_Supervar - - - - Yaf_Route_Interface - - - - &Properties; - - protected - _var_name - - - - &Methods; - - - - - -
    - - - -
    - &reftitle.properties; - - - _var_name - - - - - -
    - - - -
    - - &reference.yaf.entities.yaf-route-supervar; - -
    - - diff --git a/reference/yaf/yaf-router.xml b/reference/yaf/yaf-router.xml deleted file mode 100644 index 4437fda41bb3..000000000000 --- a/reference/yaf/yaf-router.xml +++ /dev/null @@ -1,242 +0,0 @@ - - - - - - The Yaf_Router class - Yaf_Router - - - - -
    - &reftitle.intro; - - Yaf_Router is the standard framework router. Routing is - the process of taking a URI endpoint (that part of the URI which comes - after the base URI: see Yaf_Request_Abstract::setBaseUri) - and decomposing it into parameters to determine which module, controller, and - action of that controller should receive the request. This values of the module, - controller, action and other parameters are packaged into a - Yaf_Request_Abstract object which is then processed by - Yaf_Dispatcher. Routing occurs only once: when the request - is initially received and before the first controller is dispatched. - - Yaf_Router is designed to allow for mod_rewrite-like - functionality using pure PHP structures. It is very loosely based on Ruby - on Rails routing and does not require any prior knowledge of webserver URL - rewriting. It is designed to work with a single Apache mod_rewrite rule - (one of): - - Rewrite rule for Apache - - - - - or (preferred): - - Rewrite rule for Apache - - - - - If using Lighttpd, the following rewrite rule is valid: - - Rewrite rule for Lighttpd - - "/index.php?$1", - ".*\.(js|ico|gif|jpg|png|css|html)$" => "$0", - "" => "/index.php" -) -]]> - - - If using Nginx, use the following rewrite rule: - - Rewrite rule for Nginx - - - - - -
    - - -
    - Default route - - Yaf_Router comes preconfigured with a default route - Yaf_Route_Static, which will match URIs in the shape of - controller/action. Additionally, a module name may be specified as the first - path element, allowing URIs of the form module/controller/action. Finally, - it will also match any additional parameters appended to the URI by default - - controller/action/var1/value1/var2/value2. - - - Module name must be defined in config, considering application.module="Index,Foo,Bar", - in this case, only index, foo and bar can be considered as a module name. - if doesn't config, there is only one module named "Index". - - - - - - Some examples of how such routes are matched: - - <classname>Yaf_Route_Static</classname>(default route)example - - array( - "modules" => "Index,Blog", - ), -); - -Controller only: -http://example/news - controller == news -Action only(when defined yaf.action_prefer=1 in php.ini) - action == news - -Invalid module maps to controller name: -http://example/foo - controller == foo - -Module + controller: -http://example/blog/archive - module == blog - controller == archive - -Module + controller + action: -http://example/blog/archive/list - module == blog - controller == archive - action == list - -Module + controller + action + params: -http://example/blog/archive/list/sort/alpha/date/desc - module == blog - controller == archive - action == list - sort == alpha - date == desc -]]> - - - - -
    - -
    - &reftitle.classsynopsis; - - - - Yaf_Router - - - - - Yaf_Router - - - - &Properties; - - protected - _routes - - - protected - _current - - - - &Methods; - - - - - -
    - - - -
    - &reftitle.properties; - - - _routes - - - registered routes stack - - - - - _current - - - after routing phase, this indicated the name of which route - is used to route current request. - - you can get this name by - Yaf_Router::getCurrentRoute. - - - - -
    - - - -
    - - &reference.yaf.entities.yaf-router; - -
    - - diff --git a/reference/yaf/yaf-session.xml b/reference/yaf/yaf-session.xml deleted file mode 100644 index 2f43b69af177..000000000000 --- a/reference/yaf/yaf-session.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - - The Yaf_Session class - Yaf_Session - - - - -
    - &reftitle.intro; - - Yaf_Session is a namespaced wrapper around - PHP's native session support. It is accessed as a singleton through - Yaf_Session::getInstance and works directly - on $_SESSION: session data written through one - interface is visible in the other. - - - Session entries can be accessed and manipulated through property - syntax, method calls (Yaf_Session::get, - Yaf_Session::set, - Yaf_Session::del, - Yaf_Session::has), array access - (ArrayAccess), iteration - (Iterator) and count(). - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Session - - - - - Yaf_Session - - - - Iterator - - - - ArrayAccess - - - - Countable - - - - &Properties; - - protected - static - _instance - - - protected - _session - - - protected - _started - - - - &Methods; - - - - - -
    - - - -
    - &reftitle.properties; - - - _instance - - - - - - _session - - - - - - _started - - - - - -
    - - - -
    - - &reference.yaf.entities.yaf-session; - -
    - - diff --git a/reference/yaf/yaf-view-interface.xml b/reference/yaf/yaf-view-interface.xml deleted file mode 100644 index 7874a365b145..000000000000 --- a/reference/yaf/yaf-view-interface.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - The Yaf_View_Interface class - Yaf_View_Interface - - - - -
    - &reftitle.intro; - - Yaf provides a ability for developers to use custom view engine instead - of built-in engine which is Yaf_View_Simple. There - is a example to explain how to do this, please see - Yaf_Dispatcher::setView. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_View_Interface - - - - - Yaf_View_Interface - - - - - &Methods; - - - - -
    - -
    - - &reference.yaf.entities.yaf-view-interface; - -
    - - diff --git a/reference/yaf/yaf-view-simple.xml b/reference/yaf/yaf-view-simple.xml deleted file mode 100644 index ca7bbf5befec..000000000000 --- a/reference/yaf/yaf-view-simple.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - The Yaf_View_Simple class - Yaf_View_Simple - - - - -
    - &reftitle.intro; - - Yaf_View_Simple is the built-in template engine in - Yaf, it is a simple but fast template engine, and only support PHP script - template. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_View_Simple - - - - - Yaf_View_Simple - - - - Yaf_View_Interface - - - - &Properties; - - protected - _tpl_vars - - - protected - _tpl_dir - - - - &Methods; - - - - - -
    - - - -
    - &reftitle.properties; - - - _tpl_vars - - - - - - _tpl_dir - - - - - -
    - - - -
    - - &reference.yaf.entities.yaf-view-simple; - -
    - - diff --git a/reference/yaf/yaf_action_abstract/execute.xml b/reference/yaf/yaf_action_abstract/execute.xml deleted file mode 100644 index 3987f9a211d6..000000000000 --- a/reference/yaf/yaf_action_abstract/execute.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - Yaf_Action_Abstract::execute - Action entry point - - - - &reftitle.description; - - abstract publicmixedYaf_Action_Abstract::execute - mixedargs - - - user should always define this method for an action, this is the entry point - of an action. - Yaf_Action_Abstract::execute may have arguments. - - - The value retrieved from the request is not safe. you should do some - filtering work before you use it. - - - - - - - &reftitle.parameters; - - - args - - - - - - - - - - - &reftitle.returnvalues; - - The return value of the action method is not used by Yaf; output is - written directly or collected by the view engine. - - - - - &reftitle.examples; - - <function>Yaf_Action_Abstract::execute</function>example - - "actions/Index.php", - ); -} -?> -]]> - - - - <function>Yaf_Action_Abstract::execute</function>example - -getRequest()->getParam("name")); - assert($id == $this->getRequest()->getParam("id")); - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::getParam - Yaf_Controller_Abstract::forward - - - - - - diff --git a/reference/yaf/yaf_action_abstract/getcontroller.xml b/reference/yaf/yaf_action_abstract/getcontroller.xml deleted file mode 100644 index 8743e177d64f..000000000000 --- a/reference/yaf/yaf_action_abstract/getcontroller.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - Yaf_Action_Abstract::getController - Retrieve controller object - - - - &reftitle.description; - - publicYaf_Controller_AbstractnullYaf_Action_Abstract::getController - - - - Retrieves the controller that owns this action. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A Yaf_Controller_Abstract instance, or &null; - if no controller is available. - - - - - &reftitle.examples; - - <methodname>Yaf_Action_Abstract::getController</methodname> example - -getController(); - var_dump($controller instanceof Yaf_Controller_Abstract); - - // e.g. to reach its view engine - $controller->getView()->assign("products", array("yaf", "php")); - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Action_Abstract::getControllerName - Yaf_Controller_Abstract - - - - - - - diff --git a/reference/yaf/yaf_action_abstract/getcontrollername.xml b/reference/yaf/yaf_action_abstract/getcontrollername.xml deleted file mode 100644 index 3057c3e4cf65..000000000000 --- a/reference/yaf/yaf_action_abstract/getcontrollername.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - Yaf_Action_Abstract::getControllerName - Get controller name - - - - &reftitle.description; - - public stringnullYaf_Action_Abstract::getControllerName - - - - Returns the name of the controller that owns this action. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The controller name as a &string;, or &null; if it is not set. - - - - - &reftitle.examples; - - <methodname>Yaf_Action_Abstract::getControllerName</methodname> example - -getControllerName()); - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Action_Abstract::getController - Yaf_Controller_Abstract::getName - - - - - - - diff --git a/reference/yaf/yaf_application/app.xml b/reference/yaf/yaf_application/app.xml deleted file mode 100644 index dea56d9cf047..000000000000 --- a/reference/yaf/yaf_application/app.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - Yaf_Application::app - Retrieve an Application instance - - - - &reftitle.description; - - public static Yaf_ApplicationnullYaf_Application::app - - - - Retrieve the Yaf_Application instance. - Alternatively, Yaf_Dispatcher::getApplication - can also be used. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The Yaf_Application instance, or &null; if no - application has been initialized yet. - - - - - &reftitle.examples; - - <methodname>Yaf_Application::app</methodname> example - -bootstrap()->run(); -?> -]]> - - - - Retrieving the application instance elsewhere - -environ()); - var_dump(Yaf_Application::getInstance() === $app); - - return false; - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::getApplication - - - - - - - diff --git a/reference/yaf/yaf_application/bootstrap.xml b/reference/yaf/yaf_application/bootstrap.xml deleted file mode 100644 index cd5fe13baf7a..000000000000 --- a/reference/yaf/yaf_application/bootstrap.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - - Yaf_Application::bootstrap - Call bootstrap - - - - &reftitle.description; - - public Yaf_ApplicationfalseYaf_Application::bootstrap - - - - Run a Bootstrap. All the public methods of the Bootstrap class whose - name starts with _init are called in declaration - order, each receiving the Yaf_Dispatcher - instance as its only argument. - - - The Bootstrap class must be named Bootstrap and - extend Yaf_Bootstrap_Abstract. If it is not - already defined, it is loaded from - Bootstrap.php in the application directory; the - application.bootstrap configuration entry overrides - its location. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the Yaf_Application object itself on - success, or &false; on failure (for instance if the Bootstrap class - could not be loaded, or if an uncaught exception was thrown by one of - the _init* methods). - - - - - &reftitle.errors; - - Triggers a YAF_ERR_TYPE_ERROR error if the found - class is not a subclass of - Yaf_Bootstrap_Abstract, or an - E_WARNING if the bootstrap file or the - Bootstrap class cannot be found. - - - - - &reftitle.examples; - - A Bootstrap example - - -]]> - - - - <function>Yaf_Application::bootstrap</function> example - -bootstrap(); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Bootstrap_Abstract - Yaf_Application::run - - - - - - - diff --git a/reference/yaf/yaf_application/clearlasterror.xml b/reference/yaf/yaf_application/clearlasterror.xml deleted file mode 100644 index ce098c77f335..000000000000 --- a/reference/yaf/yaf_application/clearlasterror.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - Yaf_Application::clearLastError - Clear the last error info - - - - &reftitle.description; - - public Yaf_ApplicationnullYaf_Application::clearLastError - - - - Clear the code and message of the last error, resetting them to - 0 and an empty string. This is useful in error - handlers, where a handled error should not be reported again. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the Yaf_Application object itself on - success, or &null; if the application is not properly initialized. - - - - - &reftitle.examples; - - <function>Yaf_Application::clearLastError</function> example - -clearLastError(); - var_dump(Yaf_Application::app()->getLastErrorNo()); -} - -$config = array( - "application" => array( - "directory" => "/tmp/notexists", - "dispatcher" => array( - "throwException" => 0, //trigger error instead of throwing an exception when an error occurs - ), - ), -); - -$app = new Yaf_Application($config); -$app->getDispatcher()->setErrorHandler("error_handler", E_RECOVERABLE_ERROR); -$app->run(); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Application::getLastErrorNo - Yaf_Application::getLastErrorMsg - - - - - - - diff --git a/reference/yaf/yaf_application/construct.xml b/reference/yaf/yaf_application/construct.xml deleted file mode 100644 index 99f47d24c0cd..000000000000 --- a/reference/yaf/yaf_application/construct.xml +++ /dev/null @@ -1,172 +0,0 @@ - - - - - - Yaf_Application::__construct - Yaf_Application constructor - - - - &reftitle.description; - - public Yaf_Application::__construct - stringarrayconfig - stringnullenvironnull - - - Instantiate a Yaf_Application. The constructor - also initializes the singleton application, the - Yaf_Loader and the - Yaf_Dispatcher, so it must be called before any - of those are used. - - - - - &reftitle.parameters; - - - config - - - An INI configuration file path, or a configuration array. - - - If it is an INI configuration file, there should be a section named - as the one defined by - yaf.environ, which is - "product" by default. - - - The application configuration entries (and their default values) are - documented in - Application Configuration: - - - - An ini config file example - - - - - - - - - environ - - - Which section will be loaded as the final configuration. If it is - not given, the value of the - yaf.environ directive is - used. - - - - - - - - &reftitle.errors; - - Throws a Yaf_Exception_StartupError exception - (or triggers a YAF_ERR_STARTUP_FAILED error, when - Yaf_Dispatcher::throwException is off) if a - Yaf_Application has already been instantiated, - or if the configuration is invalid. - - - - - &reftitle.examples; - - <function>Yaf_Application::__construct</function> example - -bootstrap()->run(); -?> -]]> - - - - <function>Yaf_Application::__construct</function> example - - array( - "directory" => realpath(dirname(__FILE__)) . "/application", - ), -); - -/** Yaf_Application */ -$application = new Yaf_Application($config); -$application->bootstrap()->run(); -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Config_Ini - Application Configuration - - - - - - - diff --git a/reference/yaf/yaf_application/environ.xml b/reference/yaf/yaf_application/environ.xml deleted file mode 100644 index 5760f197c20d..000000000000 --- a/reference/yaf/yaf_application/environ.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - Yaf_Application::environ - Retrieve the environment - - - - &reftitle.description; - - public stringnullYaf_Application::environ - - - - Retrieve the environment name of the application, which is defined by - the yaf.environ directive (or - the environ constructor parameter), and defaults to - "product". - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The environment name of the application. - - - - - &reftitle.examples; - - <function>Yaf_Application::environ</function> example - - array( - "directory" => realpath(dirname(__FILE__)) . "/application", - ), -); - -/** Yaf_Application */ -$application = new Yaf_Application($config); -print_r($application->environ()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/yaf/yaf_application/execute.xml b/reference/yaf/yaf_application/execute.xml deleted file mode 100644 index 692e645e9359..000000000000 --- a/reference/yaf/yaf_application/execute.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - Yaf_Application::execute - Execute a callback - - - - &reftitle.description; - - public mixedYaf_Application::execute - callablecallback - mixedargs - - - Execute a callback. This method is typically used to run Yaf in a - cron job or other CLI script, so that the script can reuse the - autoloader and the bootstrap mechanism. - - - - - &reftitle.parameters; - - - callback - - - A valid callback to execute. - - - - - args - - - Optional parameters passed to the callback. - - - - - - - - &reftitle.returnvalues; - - Returns whatever the callback returns, or &false; if calling the - callback failed. - - - - - &reftitle.examples; - - <function>Yaf_Application::execute</function> example - - array( - "directory" => realpath(dirname(__FILE__)) . "/application", - ), -); - -/** Yaf_Application */ -$application = new Yaf_Application($config); -$application->execute("main", $argc, $argv); -?> -]]> - - &example.outputs.similar; - - - string(11) "execute.php" - [1]=> - string(3) "arg" -} -]]> - - - - - - &reftitle.seealso; - - - Yaf_Application::bootstrap - - - - - - - diff --git a/reference/yaf/yaf_application/getappdirectory.xml b/reference/yaf/yaf_application/getappdirectory.xml deleted file mode 100644 index 9b589b811c2b..000000000000 --- a/reference/yaf/yaf_application/getappdirectory.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - Yaf_Application::getAppDirectory - Get the application directory - - - - &reftitle.description; - - public stringnullYaf_Application::getAppDirectory - - - - Get the application directory, under which Yaf looks for controllers, - views and modules. It is set by the - application.directory configuration entry, or by - Yaf_Application::setAppDirectory. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The absolute path of the application directory, or &null; if the - application is not properly initialized. - - - - - &reftitle.examples; - - <methodname>Yaf_Application::getAppDirectory</methodname> example - -getAppDirectory()); -var_dump(Yaf_Application::app()->getAppDirectory()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Application::setAppDirectory - - - - - - - diff --git a/reference/yaf/yaf_application/getconfig.xml b/reference/yaf/yaf_application/getconfig.xml deleted file mode 100644 index 90370684b211..000000000000 --- a/reference/yaf/yaf_application/getconfig.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - Yaf_Application::getConfig - Retrieve the config instance - - - - &reftitle.description; - - public Yaf_Config_AbstractnullYaf_Application::getConfig - - - - Retrieve the Yaf_Config_Abstract instance - holding the application configuration passed to the constructor. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A Yaf_Config_Abstract instance (a - Yaf_Config_Simple object when an array is - passed to the constructor, a - Yaf_Config_Ini object when an INI file is - passed), or &null; on failure. - - - - - &reftitle.examples; - - <function>Yaf_Application::getConfig</function> example - - array( - "directory" => realpath(dirname(__FILE__)) . "/application", - ), -); - -/** Yaf_Application */ -$application = new Yaf_Application($config); -print_r($application->getConfig()); -?> -]]> - - &example.outputs.similar; - - Array - ( - [application] => Array - ( - [directory] => /home/laruence/local/www/htdocs/application - ) - - ) - - [_readonly:protected] => 1 -) -]]> - - - - - - - diff --git a/reference/yaf/yaf_application/getdispatcher.xml b/reference/yaf/yaf_application/getdispatcher.xml deleted file mode 100644 index 6afffd4b9685..000000000000 --- a/reference/yaf/yaf_application/getdispatcher.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - Yaf_Application::getDispatcher - Get Yaf_Dispatcher instance - - - - &reftitle.description; - - public Yaf_DispatchernullYaf_Application::getDispatcher - - - - Retrieve the Yaf_Dispatcher instance used by - this application. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The Yaf_Dispatcher instance, or &null; if the - application is not properly initialized. - - - - - &reftitle.examples; - - <function>Yaf_Application::getDispatcher</function> example - - array( - "directory" => realpath(dirname(__FILE__)) . "/application", - ), -); - -/** Yaf_Application */ -$application = new Yaf_Application($config); -print_r($application->getDispatcher()); -?> -]]> - - &example.outputs.similar; - - Yaf_Router Object - ( - [_routes:protected] => Array - ( - [_default] => Yaf_Route_Static Object - ( - ) - - ) - - [_current:protected] => - ) - - [_view:protected] => - [_request:protected] => Yaf_Request_Http Object - ( - [method] => Cli - ) - - [_plugins:protected] => Array - ( - ) - - [_auto_render:protected] => 1 - [_return_response:protected] => - [_instantly_flush:protected] => 1 - [_default_module:protected] => Index - [_default_controller:protected] => Index - [_default_action:protected] => index -) -]]> - - - - - - - diff --git a/reference/yaf/yaf_application/getlasterrormsg.xml b/reference/yaf/yaf_application/getlasterrormsg.xml deleted file mode 100644 index de62ba287e87..000000000000 --- a/reference/yaf/yaf_application/getlasterrormsg.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - Yaf_Application::getLastErrorMsg - Get message of the last occurred error - - - - &reftitle.description; - - public stringnullYaf_Application::getLastErrorMsg - - - - Get the message of the last error that occurred during dispatching. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The error message of the last occurred error, an empty string if no - error occurred yet, or &null; if the application is not properly - initialized. - - - - - &reftitle.examples; - - <function>Yaf_Application::getLastErrorMsg</function> example - -getLastErrorMsg()); -} - -$config = array( - "application" => array( - "directory" => "/tmp/notexists", - "dispatcher" => array( - "throwException" => 0, //trigger error instead of throwing an exception when an error occurs - ), - ), -); - -$app = new Yaf_Application($config); -$app->getDispatcher()->setErrorHandler("error_handler", E_RECOVERABLE_ERROR); -$app->run(); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Application::getLastErrorNo - Yaf_Application::clearLastError - - - - - - - diff --git a/reference/yaf/yaf_application/getlasterrorno.xml b/reference/yaf/yaf_application/getlasterrorno.xml deleted file mode 100644 index cc3645eae1fa..000000000000 --- a/reference/yaf/yaf_application/getlasterrorno.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - Yaf_Application::getLastErrorNo - Get code of the last occurred error - - - - &reftitle.description; - - public intnullYaf_Application::getLastErrorNo - - - - Get the code of the last error that occurred during dispatching, one - of the YAF_ERR_* constants. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The error code of the last occurred error, 0 if no - error occurred yet, or &null; if the application is not properly - initialized. - - - - - &reftitle.examples; - - <function>Yaf_Application::getLastErrorNo</function> example - -getLastErrorNo()); - var_dump(Yaf_Application::app()->getLastErrorNo() == YAF_ERR_NOTFOUND_CONTROLLER); -} - -$config = array( - "application" => array( - "directory" => "/tmp/notexists", - "dispatcher" => array( - "throwException" => 0, //trigger error instead of throwing an exception when an error occurs - ), - ), -); - -$app = new Yaf_Application($config); -$app->getDispatcher()->setErrorHandler("error_handler", E_RECOVERABLE_ERROR); -$app->run(); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/yaf/yaf_application/getmodules.xml b/reference/yaf/yaf_application/getmodules.xml deleted file mode 100644 index 74447507d631..000000000000 --- a/reference/yaf/yaf_application/getmodules.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Yaf_Application::getModules - Get defined module names - - - - &reftitle.description; - - public arraynullYaf_Application::getModules - - - - Get the module names defined in the - application.modules - configuration entry. If none is defined, there will always be a - single module named "Index". - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - An array of module names, or &null; if the application is not - properly initialized. - - - - - &reftitle.examples; - - <function>Yaf_Application::getModules</function> example - - array( - "directory" => realpath(dirname(__FILE__)) . "/application", - ), -); - -/** Yaf_Application */ -$application = new Yaf_Application($config); -print_r($application->getModules()); -?> -]]> - - &example.outputs.similar; - - Index -) -]]> - - - - - - - diff --git a/reference/yaf/yaf_application/run.xml b/reference/yaf/yaf_application/run.xml deleted file mode 100644 index 33c973794d83..000000000000 --- a/reference/yaf/yaf_application/run.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - Yaf_Application::run - Start Yaf_Application - - - - &reftitle.description; - - public Yaf_Response_AbstractfalseYaf_Application::run - - - - Run a Yaf_Application, let the - Yaf_Application accept a request, route this - request, dispatch to controller/action and render a response. Finally, - return the response to the client. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the Yaf_Response_Abstract object on - success, or &false; on failure (for instance if the application is - already running). - - - - - &reftitle.errors; - - Triggers a YAF_ERR_STARTUP_FAILED error if the - application was already started. - - - - - &reftitle.examples; - - <function>Yaf_Application::run</function> example - -bootstrap()->run(); -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Application::bootstrap - Yaf_Dispatcher::dispatch - - - - - - - diff --git a/reference/yaf/yaf_application/setappdirectory.xml b/reference/yaf/yaf_application/setappdirectory.xml deleted file mode 100644 index 03013012da64..000000000000 --- a/reference/yaf/yaf_application/setappdirectory.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - Yaf_Application::setAppDirectory - Change the application directory - - - - &reftitle.description; - - public Yaf_ApplicationnullfalseYaf_Application::setAppDirectory - stringdirectory - - - Change the application directory, under which Yaf looks for - controllers, views and modules. The new directory must be an absolute - path. - - - - - &reftitle.parameters; - - - directory - - - The absolute path of the new application directory. - - - - - - - - &reftitle.returnvalues; - - Returns the Yaf_Application object itself on - success, &false; if directory is empty or not an - absolute path, or &null; if the application is not properly - initialized. - - - - - &reftitle.examples; - - <methodname>Yaf_Application::setAppDirectory</methodname> example - -setAppDirectory("/srv/legacy/mvc/app")); -var_dump($app->getAppDirectory()); - -/* an empty or relative path is rejected */ -var_dump($app->setAppDirectory("")); -var_dump($app->setAppDirectory("relative/path")); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Application::getAppDirectory - - - - - - - diff --git a/reference/yaf/yaf_config_abstract/get.xml b/reference/yaf/yaf_config_abstract/get.xml deleted file mode 100644 index 8d9b72ecd9ba..000000000000 --- a/reference/yaf/yaf_config_abstract/get.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - -Yaf_Config_Abstract::get -Retrieve a configuration value - - - - &reftitle.description; - - public mixedYaf_Config_Abstract::get - stringnameNULL - - Retrieves a configuration value by name. If name is omitted or &null;, the configuration object itself is returned, which can be used to iterate over all values. - - - - &reftitle.parameters; - - - name - -The configuration key. Dot notation (e.g. database.host) may be used to access nested values. - - - - - - &reftitle.returnvalues; -The value associated with name. Array values are wrapped in a Yaf_Config_Abstract object. Returns &null; if the key does not exist, or the configuration object itself when name is &null;. - - - - &reftitle.examples; - - <methodname>Yaf_Config_Abstract::get</methodname> example - -get('database.host'), "\n"; - -$simple = new Yaf_Config_Simple([ - 'database' => ['host' => '127.0.0.1'], -]); - -// Array values are exposed as Yaf_Config_Abstract instances -echo $simple->get('database')->host, "\n"; - -var_dump($config->get('missing.key')); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Abstract::set - Yaf_Config_Ini::get - Yaf_Config_Simple::get - - - - diff --git a/reference/yaf/yaf_config_abstract/readonly.xml b/reference/yaf/yaf_config_abstract/readonly.xml deleted file mode 100644 index 05fdeed6ea6b..000000000000 --- a/reference/yaf/yaf_config_abstract/readonly.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - -Yaf_Config_Abstract::readonly -Check if configuration is read-only - - - - &reftitle.description; - - abstract public boolYaf_Config_Abstract::readonly - - - Checks whether the configuration is read-only. This method is abstract and must be implemented by subclasses. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Returns &true; if the configuration is read-only, &false; otherwise. - - - - &reftitle.examples; - - <methodname>Yaf_Config_Abstract::readonly</methodname> example - -readonly()); // Yaf_Config_Ini is always read-only - -$writable = new Yaf_Config_Simple(['env' => 'development']); -var_dump($writable->readonly()); - -$frozen = new Yaf_Config_Simple(['env' => 'development'], true); -var_dump($frozen->readonly()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Abstract::set - Yaf_Config_Ini::readonly - Yaf_Config_Simple::readonly - - - - diff --git a/reference/yaf/yaf_config_abstract/set.xml b/reference/yaf/yaf_config_abstract/set.xml deleted file mode 100644 index 6b9cdc49e205..000000000000 --- a/reference/yaf/yaf_config_abstract/set.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - -Yaf_Config_Abstract::set -Set a configuration value - - - - &reftitle.description; - - abstract public boolYaf_Config_Abstract::set - stringname - mixedvalue - - Sets a configuration value. This method is abstract and must be implemented by subclasses. Read-only configurations will reject modifications. - - - - &reftitle.parameters; - - - name - -The configuration key to set. - - - - value - -The value to assign. - - - - - - &reftitle.returnvalues; -Returns &true; on success, or &false; on failure (e.g. when the configuration is read-only). - - - - &reftitle.examples; - - <methodname>Yaf_Config_Abstract::set</methodname> example - - 'development']); -var_dump($config->set('env', 'production')); -echo $config->env, "\n"; - -// Read-only implementations reject the modification -$ini = new Yaf_Config_Ini('/etc/myapp/application.ini', 'common'); -var_dump($ini->set('env', 'production')); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Abstract::get - Yaf_Config_Abstract::readonly - - - - diff --git a/reference/yaf/yaf_config_abstract/toarray.xml b/reference/yaf/yaf_config_abstract/toarray.xml deleted file mode 100644 index 7e9509243636..000000000000 --- a/reference/yaf/yaf_config_abstract/toarray.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - -Yaf_Config_Abstract::toArray -Export configuration as array - - - - &reftitle.description; - - public arrayYaf_Config_Abstract::toArray - - - Returns the entire configuration as a plain PHP array. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -The configuration data as an array, or &null; if no configuration data is loaded. - - - - &reftitle.examples; - - <methodname>Yaf_Config_Abstract::toArray</methodname> example - - ['name' => 'MyApp'], - 'database' => ['host' => 'localhost'], -]); - -print_r($config->toArray()); -?> -]]> - - &example.outputs.similar; - - Array - ( - [name] => MyApp - ) - - [database] => Array - ( - [host] => localhost - ) - -) -]]> - - - - - - &reftitle.seealso; - - Yaf_Config_Abstract::get - Yaf_Config_Ini::toArray - Yaf_Config_Simple::toArray - - - - diff --git a/reference/yaf/yaf_config_ini/construct.xml b/reference/yaf/yaf_config_ini/construct.xml deleted file mode 100644 index 0f55a37f35e6..000000000000 --- a/reference/yaf/yaf_config_ini/construct.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - -Yaf_Config_Ini::__construct -Constructor of Yaf_Config_Ini - - - - &reftitle.description; - - publicYaf_Config_Ini::__construct - mixedconfig_file - stringsectionNULL - - Creates a new Yaf_Config_Ini instance from an INI file or an array. The resulting configuration is always read-only. - - - - &reftitle.parameters; - - - config_file - -The path to an INI file, or an array of configuration values. - - - - section - -The INI section name to load. If omitted, all sections are loaded. - - - - - - &reftitle.returnvalues; -No value is returned. - - - - &reftitle.examples; - - <methodname>Yaf_Config_Ini::__construct</methodname> example - -application->name, "\n"; -echo $config->database->host, "\n"; -echo $config->log->level, "\n"; -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Ini::get - Yaf_Config_Ini::set - Yaf_Config_Ini::readonly - - - - - diff --git a/reference/yaf/yaf_config_ini/count.xml b/reference/yaf/yaf_config_ini/count.xml deleted file mode 100644 index 1e0e86aed843..000000000000 --- a/reference/yaf/yaf_config_ini/count.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - -Yaf_Config_Ini::count -Count configuration entries - - - - &reftitle.description; - - public intYaf_Config_Ini::count - - - Returns the number of top-level configuration entries. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -The number of top-level entries as an integer. - - - - &reftitle.examples; - - <methodname>Yaf_Config_Ini::count</methodname> example - -count()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Ini::get - Yaf_Config_Ini::toArray - - - - - diff --git a/reference/yaf/yaf_config_ini/current.xml b/reference/yaf/yaf_config_ini/current.xml deleted file mode 100644 index 8eecd38f3f7a..000000000000 --- a/reference/yaf/yaf_config_ini/current.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - -Yaf_Config_Ini::current -Get current entry value - - - - &reftitle.description; - - public mixedYaf_Config_Ini::current - - - Returns the value of the current configuration entry during iteration. Array values are wrapped in a Yaf_Config_Abstract object. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -The value of the current entry, or &false; if the position is invalid. - - - - &reftitle.examples; - - <methodname>Yaf_Config_Ini::current</methodname> example - -rewind(); -while ($config->valid()) { - $value = $config->current(); - if ($value instanceof Yaf_Config_Abstract) { - echo $config->key(), " => \n"; - } else { - echo $config->key(), " => ", $value, "\n"; - } - $config->next(); -} -?> -]]> - - &example.outputs.similar; - - -version => 1.0 -]]> - - - - - - &reftitle.seealso; - - Yaf_Config_Ini::key - Yaf_Config_Ini::next - Yaf_Config_Ini::rewind - Yaf_Config_Ini::valid - - - - - diff --git a/reference/yaf/yaf_config_ini/get.xml b/reference/yaf/yaf_config_ini/get.xml deleted file mode 100644 index 7eee71a0a695..000000000000 --- a/reference/yaf/yaf_config_ini/get.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - -Yaf_Config_Ini::get -Retrieve a configuration value - - - - &reftitle.description; - - public mixedYaf_Config_Ini::get - stringnameNULL - - Retrieves a configuration value by name. Dot notation (e.g. database.host) can be used to access nested values. If name is omitted or &null;, the configuration object itself is returned. - - - - &reftitle.parameters; - - - name - -The configuration key, optionally using dot notation for nested access. - - - - - - &reftitle.returnvalues; -The value associated with name. Array values are wrapped in a Yaf_Config_Ini object. Returns &null; if the key does not exist, or the configuration object itself when name is &null;. - - - - &reftitle.examples; - - <methodname>Yaf_Config_Ini::get</methodname> example - -get('database.host'), "\n"; - -// Array values are wrapped in a Yaf_Config_Ini object -echo $config->get('database')->port, "\n"; - -// No argument: the configuration object itself is returned -echo $config->get()->application->name, "\n"; - -var_dump($config->get('missing.key')); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Ini::set - Yaf_Config_Ini::toArray - - - - - diff --git a/reference/yaf/yaf_config_ini/isset.xml b/reference/yaf/yaf_config_ini/isset.xml deleted file mode 100644 index 7c5a825a1236..000000000000 --- a/reference/yaf/yaf_config_ini/isset.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - -Yaf_Config_Ini::__isset -Check if a key exists - - - - &reftitle.description; - - public boolYaf_Config_Ini::__isset - stringname - - Checks whether a configuration key exists. This method is invoked when isset() is used on a configuration object. - - - - &reftitle.parameters; - - - name - -The configuration key to check. - - - - - - &reftitle.returnvalues; -Returns &true; if the key exists, &false; otherwise. - - - - &reftitle.examples; - - <methodname>Yaf_Config_Ini::__isset</methodname> example - -database)); -var_dump($config->__isset('database')); -var_dump(isset($config->cache)); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Ini::get - Yaf_Config_Ini::offsetExists - - - - - diff --git a/reference/yaf/yaf_config_ini/key.xml b/reference/yaf/yaf_config_ini/key.xml deleted file mode 100644 index 86b998be5bd3..000000000000 --- a/reference/yaf/yaf_config_ini/key.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - -Yaf_Config_Ini::key -Get current entry key - - - - &reftitle.description; - - public mixedYaf_Config_Ini::key - - - Returns the key of the current configuration entry during iteration. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -The key of the current entry (string or integer), or &false; if the position is invalid. - - - - &reftitle.examples; - - <methodname>Yaf_Config_Ini::key</methodname> example - -rewind(); $config->valid(); $config->next()) { - echo $config->key(), "\n"; -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Ini::current - Yaf_Config_Ini::next - Yaf_Config_Ini::rewind - Yaf_Config_Ini::valid - - - - - diff --git a/reference/yaf/yaf_config_ini/next.xml b/reference/yaf/yaf_config_ini/next.xml deleted file mode 100644 index 50ebbb282ec5..000000000000 --- a/reference/yaf/yaf_config_ini/next.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - -Yaf_Config_Ini::next -Advance to next entry - - - - &reftitle.description; - - public voidYaf_Config_Ini::next - - - Moves the internal iterator to the next configuration entry. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -No value is returned. - - - - &reftitle.examples; - - <methodname>Yaf_Config_Ini::next</methodname> example - -rewind(); -echo $config->key(), "\n"; - -$config->next(); -echo $config->key(), "\n"; - -$config->next(); // past the last entry -var_dump($config->valid()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Ini::current - Yaf_Config_Ini::key - Yaf_Config_Ini::rewind - Yaf_Config_Ini::valid - - - - - diff --git a/reference/yaf/yaf_config_ini/offsetexists.xml b/reference/yaf/yaf_config_ini/offsetexists.xml deleted file mode 100644 index 6fb1503ea9a1..000000000000 --- a/reference/yaf/yaf_config_ini/offsetexists.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - -Yaf_Config_Ini::offsetExists -Check if a key exists (ArrayAccess) - - - - &reftitle.description; - - public boolYaf_Config_Ini::offsetExists - mixedname - - Checks whether a configuration key exists. This method is an alias of Yaf_Config_Ini::__isset and is called when isset() is used with array syntax on a configuration object. - - - - &reftitle.parameters; - - - name - -The configuration key to check. - - - - - - &reftitle.returnvalues; -Returns &true; if the key exists, &false; otherwise. - - - - &reftitle.examples; - - <methodname>Yaf_Config_Ini::offsetExists</methodname> example - -offsetExists('database')); -var_dump(isset($config['cache'])); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Ini::get - Yaf_Config_Ini::__isset - - - - - diff --git a/reference/yaf/yaf_config_ini/offsetget.xml b/reference/yaf/yaf_config_ini/offsetget.xml deleted file mode 100644 index ca3822d4c47a..000000000000 --- a/reference/yaf/yaf_config_ini/offsetget.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - -Yaf_Config_Ini::offsetGet -Get a value (ArrayAccess) - - - - &reftitle.description; - - public mixedYaf_Config_Ini::offsetGet - mixedname - - Retrieves a configuration value by key. This method is an alias of Yaf_Config_Ini::get and is called when array syntax is used to read a configuration object. - - - - &reftitle.parameters; - - - name - -The configuration key to retrieve. - - - - - - &reftitle.returnvalues; -The value associated with name, or &null; if the key does not exist. - - - - &reftitle.examples; - - <methodname>Yaf_Config_Ini::offsetGet</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Ini::get - Yaf_Config_Ini::offsetSet - Yaf_Config_Ini::offsetUnset - - - - - diff --git a/reference/yaf/yaf_config_ini/offsetset.xml b/reference/yaf/yaf_config_ini/offsetset.xml deleted file mode 100644 index 03fcc4c652d5..000000000000 --- a/reference/yaf/yaf_config_ini/offsetset.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - -Yaf_Config_Ini::offsetSet -Set a configuration value (ArrayAccess) - - - - &reftitle.description; - - public voidYaf_Config_Ini::offsetSet - mixedname - mixedvalue - - Attempts to set a configuration value using array syntax. This method is an alias of Yaf_Config_Ini::set. Since Yaf_Config_Ini is always read-only, it always fails and emits a warning. - - - - &reftitle.parameters; - - - name - -The configuration key to set. - - - - value - -The value to assign. - - - - - - &reftitle.returnvalues; -No value is returned. A warning is emitted, because Yaf_Config_Ini is read-only. - - - - &reftitle.examples; - - <methodname>Yaf_Config_Ini::offsetSet</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Ini::set - Yaf_Config_Ini::offsetGet - Yaf_Config_Ini::readonly - - - - - diff --git a/reference/yaf/yaf_config_ini/offsetunset.xml b/reference/yaf/yaf_config_ini/offsetunset.xml deleted file mode 100644 index d9c432aed47b..000000000000 --- a/reference/yaf/yaf_config_ini/offsetunset.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - -Yaf_Config_Ini::offsetUnset -Remove a key (ArrayAccess) - - - - &reftitle.description; - - public voidYaf_Config_Ini::offsetUnset - mixedname - - Removes a configuration entry by key. This method is called when unset() is used with array syntax on a configuration object. - - - - &reftitle.parameters; - - - name - -The configuration key to remove. - - - - - - &reftitle.returnvalues; -No value is returned. A warning is emitted if the configuration is read-only. - - - - &reftitle.examples; - - <methodname>Yaf_Config_Ini::offsetUnset</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Ini::offsetGet - Yaf_Config_Ini::offsetSet - - - - - diff --git a/reference/yaf/yaf_config_ini/readonly.xml b/reference/yaf/yaf_config_ini/readonly.xml deleted file mode 100644 index ac7439d288fb..000000000000 --- a/reference/yaf/yaf_config_ini/readonly.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - -Yaf_Config_Ini::readonly -Check if configuration is read-only - - - - &reftitle.description; - - public boolYaf_Config_Ini::readonly - - - Checks whether the configuration is read-only. Yaf_Config_Ini is always read-only. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Always returns &true;. - - - - &reftitle.examples; - - <methodname>Yaf_Config_Ini::readonly</methodname> example - -readonly()); - -// Attempts to write are rejected (and a warning is emitted) -var_dump($config->set('version', '2.0')); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Ini::set - - - - - diff --git a/reference/yaf/yaf_config_ini/rewind.xml b/reference/yaf/yaf_config_ini/rewind.xml deleted file mode 100644 index cc937b8bdd8b..000000000000 --- a/reference/yaf/yaf_config_ini/rewind.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - -Yaf_Config_Ini::rewind -Reset iterator to first entry - - - - &reftitle.description; - - public voidYaf_Config_Ini::rewind - - - Rewinds the internal iterator to the first configuration entry. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -No value is returned. - - - - &reftitle.examples; - - <methodname>Yaf_Config_Ini::rewind</methodname> example - -next(); -echo $config->key(), "\n"; - -$config->rewind(); -echo $config->key(), "\n"; -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Ini::current - Yaf_Config_Ini::key - Yaf_Config_Ini::next - Yaf_Config_Ini::valid - - - - - diff --git a/reference/yaf/yaf_config_ini/set.xml b/reference/yaf/yaf_config_ini/set.xml deleted file mode 100644 index 54b08f2d0699..000000000000 --- a/reference/yaf/yaf_config_ini/set.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - -Yaf_Config_Ini::set -Set a configuration value - - - - &reftitle.description; - - public boolYaf_Config_Ini::set - stringname - mixedvalue - - Attempts to set a configuration value. Since Yaf_Config_Ini is always read-only, this method always fails and emits a warning. - - - - &reftitle.parameters; - - - name - -The configuration key to set. - - - - value - -The value to assign. - - - - - - &reftitle.returnvalues; -Always returns &false; and emits a warning, because Yaf_Config_Ini is read-only. - - - - &reftitle.examples; - - <methodname>Yaf_Config_Ini::set</methodname> example - -set('database.host', '192.0.2.10')); - -echo $config->get('database.host'), "\n"; -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Ini::get - Yaf_Config_Ini::readonly - - - - - diff --git a/reference/yaf/yaf_config_ini/toarray.xml b/reference/yaf/yaf_config_ini/toarray.xml deleted file mode 100644 index 813719b7e0ce..000000000000 --- a/reference/yaf/yaf_config_ini/toarray.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - -Yaf_Config_Ini::toArray -Export configuration as array - - - - &reftitle.description; - - public arrayYaf_Config_Ini::toArray - - - Returns the entire configuration as a plain PHP array. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -The configuration data as an array. - - - - &reftitle.examples; - - <methodname>Yaf_Config_Ini::toArray</methodname> example - -toArray()); -?> -]]> - - &example.outputs.similar; - - Array - ( - [name] => MyApp - ) - - [database] => Array - ( - [host] => localhost - [port] => 3306 - ) - -) -]]> - - - - - - &reftitle.seealso; - - Yaf_Config_Ini::get - - - - - diff --git a/reference/yaf/yaf_config_ini/valid.xml b/reference/yaf/yaf_config_ini/valid.xml deleted file mode 100644 index 4a43508bc203..000000000000 --- a/reference/yaf/yaf_config_ini/valid.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - -Yaf_Config_Ini::valid -Check if current position is valid - - - - &reftitle.description; - - public boolYaf_Config_Ini::valid - - - Checks whether the current iterator position is valid. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Returns &true; if the current position is valid, &false; otherwise. - - - - &reftitle.examples; - - <methodname>Yaf_Config_Ini::valid</methodname> example - -rewind(); -var_dump($config->valid()); - -$config->next(); -var_dump($config->valid()); - -$config->next(); // past the last entry -var_dump($config->valid()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Ini::current - Yaf_Config_Ini::key - Yaf_Config_Ini::next - Yaf_Config_Ini::rewind - - - - - diff --git a/reference/yaf/yaf_config_simple/construct.xml b/reference/yaf/yaf_config_simple/construct.xml deleted file mode 100644 index 64edf87b4c71..000000000000 --- a/reference/yaf/yaf_config_simple/construct.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - -Yaf_Config_Simple::__construct -Constructor of Yaf_Config_Simple - - - - &reftitle.description; - - publicYaf_Config_Simple::__construct - arrayvalues - boolreadonlyfalse - - Creates a new Yaf_Config_Simple instance from an array of configuration values. - - - - &reftitle.parameters; - - - values - -An array of configuration values. - - - - readonly - -Whether the configuration should be read-only. Defaults to &false; (writable). - - - - - - &reftitle.returnvalues; -No value is returned. - - - - &reftitle.examples; - - <methodname>Yaf_Config_Simple::__construct</methodname> example - - ['name' => 'MyApp', 'env' => 'production'], - 'database' => ['host' => 'localhost', 'port' => 3306], -]); - -echo $config->application->name, "\n"; -echo $config->database->host, "\n"; - -// The optional second argument makes the configuration read-only -$frozen = new Yaf_Config_Simple(['env' => 'testing'], true); -var_dump($frozen->readonly()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Simple::get - Yaf_Config_Simple::set - Yaf_Config_Simple::readonly - - - - - diff --git a/reference/yaf/yaf_config_simple/count.xml b/reference/yaf/yaf_config_simple/count.xml deleted file mode 100644 index 60be74b492f2..000000000000 --- a/reference/yaf/yaf_config_simple/count.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - -Yaf_Config_Simple::count -Count configuration entries - - - - &reftitle.description; - - public intYaf_Config_Simple::count - - - Returns the number of top-level configuration entries. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -The number of top-level entries as an integer. - - - - &reftitle.examples; - - <methodname>Yaf_Config_Simple::count</methodname> example - - ['name' => 'MyApp'], - 'database' => ['host' => 'localhost'], -]); - -// Only the top-level entries ("application" and "database") are counted -var_dump(count($config)); -var_dump($config->count()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Simple::get - Yaf_Config_Simple::toArray - - - - - diff --git a/reference/yaf/yaf_config_simple/current.xml b/reference/yaf/yaf_config_simple/current.xml deleted file mode 100644 index 82f3ddf16f0f..000000000000 --- a/reference/yaf/yaf_config_simple/current.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - -Yaf_Config_Simple::current -Get current entry value - - - - &reftitle.description; - - public mixedYaf_Config_Simple::current - - - Returns the value of the current configuration entry during iteration. Array values are wrapped in a Yaf_Config_Abstract object. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -The value of the current entry, or &false; if the position is invalid. - - - - &reftitle.examples; - - <methodname>Yaf_Config_Simple::current</methodname> example - - ['name' => 'MyApp'], - 'version' => '1.0', -]); - -$config->rewind(); -while ($config->valid()) { - $value = $config->current(); - if ($value instanceof Yaf_Config_Abstract) { - echo $config->key(), " => \n"; - } else { - echo $config->key(), " => ", $value, "\n"; - } - $config->next(); -} -?> -]]> - - &example.outputs.similar; - - -version => 1.0 -]]> - - - - - - &reftitle.seealso; - - Yaf_Config_Simple::key - Yaf_Config_Simple::next - Yaf_Config_Simple::rewind - Yaf_Config_Simple::valid - - - - - diff --git a/reference/yaf/yaf_config_simple/get.xml b/reference/yaf/yaf_config_simple/get.xml deleted file mode 100644 index 9347124f3f8d..000000000000 --- a/reference/yaf/yaf_config_simple/get.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - -Yaf_Config_Simple::get -Retrieve a configuration value - - - - &reftitle.description; - - public mixedYaf_Config_Simple::get - stringnameNULL - - Retrieves a configuration value by name. If name is omitted or &null;, the configuration object itself is returned. - - - - &reftitle.parameters; - - - name - -The configuration key to retrieve. - - - - - - &reftitle.returnvalues; -The value associated with name. Array values are wrapped in a Yaf_Config_Simple object. Returns &null; if the key does not exist, or the configuration object itself when name is &null;. - - - - &reftitle.examples; - - <methodname>Yaf_Config_Simple::get</methodname> example - - ['name' => 'MyApp'], - 'database' => ['host' => 'localhost'], -]); - -// Array values are wrapped in a Yaf_Config_Simple object -echo $config->get('database')->host, "\n"; -echo $config->get('application')->name, "\n"; -var_dump($config->get('missing')); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Simple::set - Yaf_Config_Simple::toArray - - - - - diff --git a/reference/yaf/yaf_config_simple/isset.xml b/reference/yaf/yaf_config_simple/isset.xml deleted file mode 100644 index b03bf29d004b..000000000000 --- a/reference/yaf/yaf_config_simple/isset.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - -Yaf_Config_Simple::__isset -Check if a key exists - - - - &reftitle.description; - - public boolYaf_Config_Simple::__isset - stringname - - Checks whether a configuration key exists. This method is invoked when isset() is used on a configuration object. - - - - &reftitle.parameters; - - - name - -The configuration key to check. - - - - - - &reftitle.returnvalues; -Returns &true; if the key exists, &false; otherwise. - - - - &reftitle.examples; - - <methodname>Yaf_Config_Simple::__isset</methodname> example - - ['name' => 'MyApp'], - 'database' => ['host' => 'localhost'], -]); - -var_dump(isset($config->application)); -var_dump($config->__isset('application')); -var_dump(isset($config->cache)); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Simple::get - Yaf_Config_Simple::offsetExists - - - - - diff --git a/reference/yaf/yaf_config_simple/key.xml b/reference/yaf/yaf_config_simple/key.xml deleted file mode 100644 index e625055c7024..000000000000 --- a/reference/yaf/yaf_config_simple/key.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - -Yaf_Config_Simple::key -Get current entry key - - - - &reftitle.description; - - public mixedYaf_Config_Simple::key - - - Returns the key of the current configuration entry during iteration. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -The key of the current entry (string or integer), or &false; if the position is invalid. - - - - &reftitle.examples; - - <methodname>Yaf_Config_Simple::key</methodname> example - - ['name' => 'MyApp'], - 'database' => ['host' => 'localhost'], -]); - -for ($config->rewind(); $config->valid(); $config->next()) { - echo $config->key(), "\n"; -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Simple::current - Yaf_Config_Simple::next - Yaf_Config_Simple::rewind - Yaf_Config_Simple::valid - - - - - diff --git a/reference/yaf/yaf_config_simple/next.xml b/reference/yaf/yaf_config_simple/next.xml deleted file mode 100644 index 4218a7cfaba5..000000000000 --- a/reference/yaf/yaf_config_simple/next.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - -Yaf_Config_Simple::next -Advance to next entry - - - - &reftitle.description; - - public voidYaf_Config_Simple::next - - - Moves the internal iterator to the next configuration entry. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -No value is returned. - - - - &reftitle.examples; - - <methodname>Yaf_Config_Simple::next</methodname> example - - ['name' => 'MyApp'], - 'database' => ['host' => 'localhost'], -]); - -$config->rewind(); -echo $config->key(), "\n"; - -$config->next(); -echo $config->key(), "\n"; - -$config->next(); // past the last entry -var_dump($config->valid()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Simple::current - Yaf_Config_Simple::key - Yaf_Config_Simple::rewind - Yaf_Config_Simple::valid - - - - - diff --git a/reference/yaf/yaf_config_simple/offsetexists.xml b/reference/yaf/yaf_config_simple/offsetexists.xml deleted file mode 100644 index 867163afa12d..000000000000 --- a/reference/yaf/yaf_config_simple/offsetexists.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - -Yaf_Config_Simple::offsetExists -Check if a key exists (ArrayAccess) - - - - &reftitle.description; - - public boolYaf_Config_Simple::offsetExists - mixedname - - Checks whether a configuration key exists. This method is an alias of Yaf_Config_Simple::__isset and is called when isset() is used with array syntax on a configuration object. - - - - &reftitle.parameters; - - - name - -The configuration key to check. - - - - - - &reftitle.returnvalues; -Returns &true; if the key exists, &false; otherwise. - - - - &reftitle.examples; - - <methodname>Yaf_Config_Simple::offsetExists</methodname> example - - ['name' => 'MyApp'], - 'database' => ['host' => 'localhost'], -]); - -var_dump(isset($config['database'])); -var_dump($config->offsetExists('database')); -var_dump(isset($config['cache'])); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Simple::get - Yaf_Config_Simple::__isset - - - - - diff --git a/reference/yaf/yaf_config_simple/offsetget.xml b/reference/yaf/yaf_config_simple/offsetget.xml deleted file mode 100644 index fea8b064ca48..000000000000 --- a/reference/yaf/yaf_config_simple/offsetget.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - -Yaf_Config_Simple::offsetGet -Get a value (ArrayAccess) - - - - &reftitle.description; - - public mixedYaf_Config_Simple::offsetGet - mixedname - - Retrieves a configuration value by key. This method is an alias of Yaf_Config_Simple::get and is called when array syntax is used to read a configuration object. - - - - &reftitle.parameters; - - - name - -The configuration key to retrieve. - - - - - - &reftitle.returnvalues; -The value associated with name, or &null; if the key does not exist. - - - - &reftitle.examples; - - <methodname>Yaf_Config_Simple::offsetGet</methodname> example - - ['name' => 'MyApp'], - 'database' => ['host' => 'localhost'], -]); - -// Array values are wrapped in a Yaf_Config_Simple object -echo $config['application']->name, "\n"; -echo $config['database']['host'], "\n"; -var_dump($config['missing']); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Simple::get - Yaf_Config_Simple::offsetSet - Yaf_Config_Simple::offsetUnset - - - - - diff --git a/reference/yaf/yaf_config_simple/offsetset.xml b/reference/yaf/yaf_config_simple/offsetset.xml deleted file mode 100644 index 42b5a58c52d1..000000000000 --- a/reference/yaf/yaf_config_simple/offsetset.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - -Yaf_Config_Simple::offsetSet -Set a configuration value (ArrayAccess) - - - - &reftitle.description; - - public voidYaf_Config_Simple::offsetSet - mixedname - mixedvalue - - Sets a configuration value using array syntax. This method is an alias of Yaf_Config_Simple::set. The assignment fails silently if the configuration is read-only. - - - - &reftitle.parameters; - - - name - -The configuration key to set. - - - - value - -The value to assign. - - - - - - &reftitle.returnvalues; -No value is returned. The assignment fails if the configuration is read-only. - - - - &reftitle.examples; - - <methodname>Yaf_Config_Simple::offsetSet</methodname> example - - 'development']); - -// Writable by default -$config['env'] = 'production'; -$config['cache'] = ['enable' => true]; -echo $config['env'], "\n"; -var_dump($config['cache']['enable']); - -// Assignments to a read-only configuration fail silently -$frozen = new Yaf_Config_Simple(['env' => 'development'], true); -$frozen['env'] = 'production'; -echo $frozen['env'], "\n"; -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Simple::set - Yaf_Config_Simple::offsetGet - Yaf_Config_Simple::offsetUnset - - - - - diff --git a/reference/yaf/yaf_config_simple/offsetunset.xml b/reference/yaf/yaf_config_simple/offsetunset.xml deleted file mode 100644 index d5b1a0e52eb1..000000000000 --- a/reference/yaf/yaf_config_simple/offsetunset.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - -Yaf_Config_Simple::offsetUnset -Remove a key (ArrayAccess) - - - - &reftitle.description; - - public voidYaf_Config_Simple::offsetUnset - mixedname - - Removes a configuration entry by key. This method is called when unset() is used with array syntax on a configuration object. - - - - &reftitle.parameters; - - - name - -The configuration key to remove. - - - - - - &reftitle.returnvalues; -No value is returned. A warning is emitted if the configuration is read-only. - - - - &reftitle.examples; - - <methodname>Yaf_Config_Simple::offsetUnset</methodname> example - - ['enable' => true], - 'env' => 'development', -]); - -unset($config['cache']); -var_dump(isset($config['cache'])); - -// Read-only configurations cannot be modified: a warning is emitted -$frozen = new Yaf_Config_Simple(['env' => 'development'], true); -unset($frozen['env']); -var_dump(isset($frozen['env'])); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Simple::offsetGet - Yaf_Config_Simple::offsetSet - - - - - diff --git a/reference/yaf/yaf_config_simple/readonly.xml b/reference/yaf/yaf_config_simple/readonly.xml deleted file mode 100644 index 5f02a3a3745a..000000000000 --- a/reference/yaf/yaf_config_simple/readonly.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - -Yaf_Config_Simple::readonly -Check if configuration is read-only - - - - &reftitle.description; - - public boolYaf_Config_Simple::readonly - - - Checks whether the configuration is read-only. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Returns &true; if the configuration is read-only, &false; otherwise. - - - - &reftitle.examples; - - <methodname>Yaf_Config_Simple::readonly</methodname> example - - 'development']); -var_dump($writable->readonly()); - -$frozen = new Yaf_Config_Simple(['env' => 'development'], true); -var_dump($frozen->readonly()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Simple::set - - - - - diff --git a/reference/yaf/yaf_config_simple/rewind.xml b/reference/yaf/yaf_config_simple/rewind.xml deleted file mode 100644 index 9fbdfe7803df..000000000000 --- a/reference/yaf/yaf_config_simple/rewind.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - -Yaf_Config_Simple::rewind -Reset iterator to first entry - - - - &reftitle.description; - - public voidYaf_Config_Simple::rewind - - - Rewinds the internal iterator to the first configuration entry. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -No value is returned. - - - - &reftitle.examples; - - <methodname>Yaf_Config_Simple::rewind</methodname> example - - ['name' => 'MyApp'], - 'database' => ['host' => 'localhost'], -]); - -$config->next(); -echo $config->key(), "\n"; - -$config->rewind(); -echo $config->key(), "\n"; -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Simple::current - Yaf_Config_Simple::key - Yaf_Config_Simple::next - Yaf_Config_Simple::valid - - - - - diff --git a/reference/yaf/yaf_config_simple/set.xml b/reference/yaf/yaf_config_simple/set.xml deleted file mode 100644 index 9890e1f8a7c2..000000000000 --- a/reference/yaf/yaf_config_simple/set.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - -Yaf_Config_Simple::set -Set a configuration value - - - - &reftitle.description; - - public boolYaf_Config_Simple::set - stringname - mixedvalue - - Sets a configuration value. Fails and returns &false; if the configuration is read-only. - - - - &reftitle.parameters; - - - name - -The configuration key to set. - - - - value - -The value to assign. - - - - - - &reftitle.returnvalues; -Returns &true; on success, or &false; if the configuration is read-only. - - - - &reftitle.examples; - - <methodname>Yaf_Config_Simple::set</methodname> example - - 'development']); - -var_dump($config->set('env', 'production')); -echo $config->env, "\n"; - -// Read-only configurations reject the modification -$frozen = new Yaf_Config_Simple(['env' => 'development'], true); -var_dump($frozen->set('env', 'production')); -echo $frozen->env, "\n"; -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Simple::get - Yaf_Config_Simple::readonly - - - - - diff --git a/reference/yaf/yaf_config_simple/toarray.xml b/reference/yaf/yaf_config_simple/toarray.xml deleted file mode 100644 index 56b723dcbec0..000000000000 --- a/reference/yaf/yaf_config_simple/toarray.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - -Yaf_Config_Simple::toArray -Export configuration as array - - - - &reftitle.description; - - public arrayYaf_Config_Simple::toArray - - - Returns the entire configuration as a plain PHP array. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -The configuration data as an array. - - - - &reftitle.examples; - - <methodname>Yaf_Config_Simple::toArray</methodname> example - - ['name' => 'MyApp'], - 'database' => ['host' => 'localhost', 'port' => 3306], -]); - -print_r($config->toArray()); -?> -]]> - - &example.outputs.similar; - - Array - ( - [name] => MyApp - ) - - [database] => Array - ( - [host] => localhost - [port] => 3306 - ) - -) -]]> - - - - - - &reftitle.seealso; - - Yaf_Config_Simple::get - - - - - diff --git a/reference/yaf/yaf_config_simple/valid.xml b/reference/yaf/yaf_config_simple/valid.xml deleted file mode 100644 index b1ee3160050b..000000000000 --- a/reference/yaf/yaf_config_simple/valid.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - -Yaf_Config_Simple::valid -Check if current position is valid - - - - &reftitle.description; - - public boolYaf_Config_Simple::valid - - - Checks whether the current iterator position is valid. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Returns &true; if the current position is valid, &false; otherwise. - - - - &reftitle.examples; - - <methodname>Yaf_Config_Simple::valid</methodname> example - - ['name' => 'MyApp'], - 'database' => ['host' => 'localhost'], -]); - -$config->rewind(); -var_dump($config->valid()); - -$config->next(); -var_dump($config->valid()); - -$config->next(); // past the last entry -var_dump($config->valid()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Simple::current - Yaf_Config_Simple::key - Yaf_Config_Simple::next - Yaf_Config_Simple::rewind - - - - - diff --git a/reference/yaf/yaf_controller_abstract/construct.xml b/reference/yaf/yaf_controller_abstract/construct.xml deleted file mode 100644 index c2bfb7d08206..000000000000 --- a/reference/yaf/yaf_controller_abstract/construct.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - Yaf_Controller_Abstract::__construct - Constructor of Yaf_Controller_Abstract - - - - &reftitle.description; - - public Yaf_Controller_Abstract::__construct - - - - Yaf_Controller_Abstract::__construct is - called by Yaf when a controller object is created during dispatching. - It takes no arguments, and users should not call it directly. Since - it is not intended to be overridden with custom logic, - Yaf_Controller_Abstract::init is provided as - the userland initialization hook instead. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - No value is returned. - - - - - &reftitle.examples; - - <methodname>Yaf_Controller_Abstract::__construct</methodname> example - -getRequest() instanceof Yaf_Request_Abstract); - var_dump($this->getResponse() instanceof Yaf_Response_Abstract); - var_dump($this->getView() instanceof Yaf_View_Interface); - } - - public function indexAction() { - // ... - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Controller_Abstract::init - - - - - - - diff --git a/reference/yaf/yaf_controller_abstract/display.xml b/reference/yaf/yaf_controller_abstract/display.xml deleted file mode 100644 index c42019d2c45b..000000000000 --- a/reference/yaf/yaf_controller_abstract/display.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - Yaf_Controller_Abstract::display - Render and display a view - - - - &reftitle.description; - - protected boolnullYaf_Controller_Abstract::display - stringtpl - arraynullparameters - - - Renders the view script tpl and sends the - result directly, unlike - Yaf_Controller_Abstract::render, - which returns the rendered output instead. Auto-rendering - of the default action template is controlled by - Yaf_Dispatcher::autoRender. - - - - - &reftitle.parameters; - - - tpl - - - The view script name, relative to the view path. - - - - - parameters - - - An associative array of variables to export to the - view script for this rendering, overriding those - assigned through the view engine. - - - - - - - - &reftitle.returnvalues; - - Returns &true; on success, or &false; / &null; on failure. - - - - - &reftitle.examples; - - <methodname>Yaf_Controller_Abstract::display</methodname> example - -display("product/list.phtml", array( - "products" => array("yaf", "php"), - )); - } -} -?> -]]> - - - - Template example - - -
      - -
    • - -
    -]]> -
    - &example.outputs.similar; - - -
  • yaf
  • -
  • php
  • - -]]> -
    -
    -
    - - - &reftitle.seealso; - - - Yaf_Controller_Abstract::render - Yaf_Dispatcher::autoRender - - - - -
    - - diff --git a/reference/yaf/yaf_controller_abstract/forward.xml b/reference/yaf/yaf_controller_abstract/forward.xml deleted file mode 100644 index 713c7e22575f..000000000000 --- a/reference/yaf/yaf_controller_abstract/forward.xml +++ /dev/null @@ -1,163 +0,0 @@ - - - - - - Yaf_Controller_Abstract::forward - Forward the current request to another action - - - - &reftitle.description; - - public boolnullYaf_Controller_Abstract::forward - stringaction - arraynullparameters - - - public boolnullYaf_Controller_Abstract::forward - stringcontroller - stringaction - arraynullparameters - - - public boolnullYaf_Controller_Abstract::forward - stringmodule - stringcontroller - stringaction - arraynullparameters - - - Forward the current request to another action. The target is - determined from the number and types of the arguments: - - - action only: forward to another action of the current controller. - controller and action: forward to another controller. - module, controller and action: forward to another module. - The optional parameters array carries invocation arguments retrievable with Yaf_Request_Abstract::getParam. - - - - This method does not switch to the destination action immediately; - the switch takes place after the current flow finishes. To hand over - control right away, return from the current action method (returning - &false; also tells Yaf not to auto-render the current view). - - - - - - &reftitle.parameters; - - - module - - - The destination module name. If the current module is given, it is - used as is. - - - - - controller - - - The destination controller name. - - - - - action - - - The destination action name. - - - - - parameters - - - Invocation arguments for the destination action, retrievable - with Yaf_Request_Abstract::getParam. - - - - - - - - &reftitle.returnvalues; - - Returns &true; on success, or &false; / &null; on failure. - - - - - &reftitle.examples; - - <function>Yaf_Controller_Abstract::forward</function> example - -forward("login", array("from" => "Index")); // forward to the login action - return false; // this is important, it ends the current flow - // and tells Yaf not to auto-render - } - - // other processes - } - - public function loginAction() { - echo "login, redirected from ", $this->_request->getParam("from") , " action"; - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Request_Abstract::getParam - - - - - - - diff --git a/reference/yaf/yaf_controller_abstract/getinvokearg.xml b/reference/yaf/yaf_controller_abstract/getinvokearg.xml deleted file mode 100644 index 16ec1415ddf4..000000000000 --- a/reference/yaf/yaf_controller_abstract/getinvokearg.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - Yaf_Controller_Abstract::getInvokeArg - Retrieve one action invocation argument - - - - &reftitle.description; - - public stringnullYaf_Controller_Abstract::getInvokeArg - stringname - - - Returns a single invocation argument of the current action, given its - name. Invocation arguments are passed to the action through - Yaf_Controller_Abstract::forward. - - - - - &reftitle.parameters; - - - name - - - The name of the invocation argument to retrieve. - - - - - - - - &reftitle.returnvalues; - - The argument value, or &null; if it does not exist. - - - - - &reftitle.examples; - - <methodname>Yaf_Controller_Abstract::getInvokeArg</methodname> example - -forward("profile", array("name" => "laruence")); - return false; // ends the current flow - } - - public function profileAction() { - // retrieve one invocation argument by name - var_dump($this->getInvokeArg("name")); - var_dump($this->getInvokeArg("missing")); - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Controller_Abstract::getInvokeArgs - Yaf_Controller_Abstract::forward - - - - - - - diff --git a/reference/yaf/yaf_controller_abstract/getinvokeargs.xml b/reference/yaf/yaf_controller_abstract/getinvokeargs.xml deleted file mode 100644 index 6bdf99468463..000000000000 --- a/reference/yaf/yaf_controller_abstract/getinvokeargs.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - Yaf_Controller_Abstract::getInvokeArgs - Retrieve all action invocation arguments - - - - &reftitle.description; - - public arraynullYaf_Controller_Abstract::getInvokeArgs - - - - Returns all invocation arguments of the current action, as an array - keyed by argument name. Invocation arguments are passed to the action - through Yaf_Controller_Abstract::forward. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - An array of invocation arguments, or &null; if none were given. - - - - - &reftitle.examples; - - <methodname>Yaf_Controller_Abstract::getInvokeArgs</methodname> example - -forward("list", array("category" => "book", "page" => 2)); - return false; // ends the current flow - } - - public function listAction() { - // all invocation arguments of the current action - var_dump($this->getInvokeArgs()); - } -} -?> -]]> - - &example.outputs.similar; - - - string(4) "book" - ["page"]=> - int(2) -} -]]> - - - - - - &reftitle.seealso; - - - Yaf_Controller_Abstract::getInvokeArg - Yaf_Controller_Abstract::forward - - - - - - - diff --git a/reference/yaf/yaf_controller_abstract/getmodulename.xml b/reference/yaf/yaf_controller_abstract/getmodulename.xml deleted file mode 100644 index 970fe6c67bad..000000000000 --- a/reference/yaf/yaf_controller_abstract/getmodulename.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - Yaf_Controller_Abstract::getModuleName - Get module name - - - - &reftitle.description; - - public stringnullYaf_Controller_Abstract::getModuleName - - - - Returns the name of the module the controller belongs to. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The module name as a &string;, or &null; if it is not set. - - - - - &reftitle.examples; - - <methodname>Yaf_Controller_Abstract::getModuleName</methodname> example - -getModuleName()); - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Controller_Abstract::getName - Yaf_Request_Abstract::getModuleName - - - - - - - diff --git a/reference/yaf/yaf_controller_abstract/getname.xml b/reference/yaf/yaf_controller_abstract/getname.xml deleted file mode 100644 index b797b63ec219..000000000000 --- a/reference/yaf/yaf_controller_abstract/getname.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - Yaf_Controller_Abstract::getName - Get controller name - - - - &reftitle.description; - - public stringnullYaf_Controller_Abstract::getName - - - - Returns the name of the controller. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The controller name as a &string;, or &null; if it is not set. - - - - - &reftitle.examples; - - <methodname>Yaf_Controller_Abstract::getName</methodname> example - -getName()); - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Controller_Abstract::getModuleName - Yaf_Request_Abstract::getControllerName - - - - - - - diff --git a/reference/yaf/yaf_controller_abstract/getrequest.xml b/reference/yaf/yaf_controller_abstract/getrequest.xml deleted file mode 100644 index 4e35024c34e3..000000000000 --- a/reference/yaf/yaf_controller_abstract/getrequest.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - Yaf_Controller_Abstract::getRequest - Retrieve current request object - - - - &reftitle.description; - - public Yaf_Request_AbstractnullYaf_Controller_Abstract::getRequest - - - - Returns the Yaf_Request_Abstract instance associated with this controller. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A Yaf_Request_Abstract instance, or &null; if no request is available. - - - - - &reftitle.examples; - - <methodname>Yaf_Controller_Abstract::getRequest</methodname> example - -getRequest(); - var_dump($request->getModuleName()); - var_dump($request->getControllerName()); - var_dump($request->getActionName()); - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Controller_Abstract::getResponse - Yaf_Request_Abstract - - - - - - - diff --git a/reference/yaf/yaf_controller_abstract/getresponse.xml b/reference/yaf/yaf_controller_abstract/getresponse.xml deleted file mode 100644 index 7b053c8df84e..000000000000 --- a/reference/yaf/yaf_controller_abstract/getresponse.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Yaf_Controller_Abstract::getResponse - Retrieve current response object - - - - &reftitle.description; - - public Yaf_Response_AbstractnullYaf_Controller_Abstract::getResponse - - - - Returns the Yaf_Response_Abstract instance associated with this controller. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A Yaf_Response_Abstract instance, or &null; if no response is available. - - - - - &reftitle.examples; - - <methodname>Yaf_Controller_Abstract::getResponse</methodname> example - -disableView(); - - $response = $this->getResponse(); - $response->setHeader("Content-Type", "application/json"); - $response->setBody(json_encode(array("name" => "yaf"))); - // Yaf sends the body after the dispatch loop finishes - } -} -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Controller_Abstract::getRequest - Yaf_Response_Abstract - - - - - - - diff --git a/reference/yaf/yaf_controller_abstract/getview.xml b/reference/yaf/yaf_controller_abstract/getview.xml deleted file mode 100644 index c5d56705ab62..000000000000 --- a/reference/yaf/yaf_controller_abstract/getview.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - Yaf_Controller_Abstract::getView - Retrieve the view engine - - - - &reftitle.description; - - public Yaf_View_InterfacenullYaf_Controller_Abstract::getView - - - - Returns the view engine bound to this controller. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A Yaf_View_Interface instance, or &null; if no view engine is available. - - - - - &reftitle.examples; - - <methodname>Yaf_Controller_Abstract::getView</methodname> example - -getView(); - - // export $products to the template product/index.phtml - $view->assign("products", array("yaf", "php")); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Controller_Abstract::initView - Yaf_View_Interface - - - - - - - diff --git a/reference/yaf/yaf_controller_abstract/getviewpath.xml b/reference/yaf/yaf_controller_abstract/getviewpath.xml deleted file mode 100644 index 21157781bf65..000000000000 --- a/reference/yaf/yaf_controller_abstract/getviewpath.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - Yaf_Controller_Abstract::getViewpath - Get the view path - - - - &reftitle.description; - - public stringnullYaf_Controller_Abstract::getViewpath - - - - Returns the template directory used by the view engine bound to this controller. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The view template directory as a &string;. - - - - - &reftitle.examples; - - <methodname>Yaf_Controller_Abstract::getViewpath</methodname> example - -getViewpath()); - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Controller_Abstract::setViewpath - Yaf_Controller_Abstract::initView - - - - - - - diff --git a/reference/yaf/yaf_controller_abstract/init.xml b/reference/yaf/yaf_controller_abstract/init.xml deleted file mode 100644 index 1202b245c15e..000000000000 --- a/reference/yaf/yaf_controller_abstract/init.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - Yaf_Controller_Abstract::init - Controller initializer - - - - &reftitle.description; - - public voidYaf_Controller_Abstract::init - - - - Yaf_Controller_Abstract::__construct is not - meant to be overridden with custom logic, so - Yaf_Controller_Abstract::init is provided as - the userland initialization hook. If it is defined in a controller, it - is called right after the controller object is instantiated. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - No value is returned. - - - - - &reftitle.examples; - - <methodname>Yaf_Controller_Abstract::init</methodname> example - -getView()->assign("sitename", "Yaf Tutorial"); - } - - public function indexAction() { - // ... - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Controller_Abstract::__construct - - - - - - diff --git a/reference/yaf/yaf_controller_abstract/initview.xml b/reference/yaf/yaf_controller_abstract/initview.xml deleted file mode 100644 index 416a3952fe83..000000000000 --- a/reference/yaf/yaf_controller_abstract/initview.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - Yaf_Controller_Abstract::initView - Initialize the view and return it - - - - &reftitle.description; - - public Yaf_View_InterfacenullYaf_Controller_Abstract::initView - arraynulloptions - - - Returns the view engine bound to this controller. The view engine is - initialized by the Yaf_Dispatcher during - dispatching, using the template path set for the current controller. - - - - - &reftitle.parameters; - - - options - - - Options passed to the view engine, see - Yaf_View_Simple::__construct. - - - - - - - - &reftitle.returnvalues; - - A Yaf_View_Interface instance on success, or - &null; on failure. - - - - - &reftitle.examples; - - <methodname>Yaf_Controller_Abstract::initView</methodname> example - -initView(); - $view->assign("products", array("yaf", "php")); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Controller_Abstract::getView - Yaf_View_Interface - - - - - - - diff --git a/reference/yaf/yaf_controller_abstract/redirect.xml b/reference/yaf/yaf_controller_abstract/redirect.xml deleted file mode 100644 index c4fb3fe8e9d6..000000000000 --- a/reference/yaf/yaf_controller_abstract/redirect.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - Yaf_Controller_Abstract::redirect - Redirect to a URL - - - - &reftitle.description; - - public boolnullYaf_Controller_Abstract::redirect - stringurl - - - Redirects the client to another URL by sending a - Location header (HTTP status 302). - - - - - &reftitle.parameters; - - - url - - - The URL to redirect to. - - - - - - - - &reftitle.returnvalues; - - Returns &true; on success, or &false; / &null; on failure. - - - - - &reftitle.examples; - - <methodname>Yaf_Controller_Abstract::redirect</methodname> example - -getRequest()->getParam("user")) { - // send a Location header with HTTP status 302 - $this->redirect("http://www.example.com/account/login/"); - return false; // skip auto-rendering - } - } -} -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Controller_Abstract::forward - Yaf_Response_Abstract::setRedirect - - - - - - - diff --git a/reference/yaf/yaf_controller_abstract/render.xml b/reference/yaf/yaf_controller_abstract/render.xml deleted file mode 100644 index 7d30e3beabe4..000000000000 --- a/reference/yaf/yaf_controller_abstract/render.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - Yaf_Controller_Abstract::render - Render view template - - - - &reftitle.description; - - protected stringboolnullYaf_Controller_Abstract::render - stringtpl - arraynullparameters - - - Renders the view script tpl and returns the - output, unlike - Yaf_Controller_Abstract::display. - - - - - &reftitle.parameters; - - - tpl - - - The view script name, relative to the view path. - - - - - parameters - - - An associative array of variables to export to the view - script for this rendering. - - - - - - - - &reftitle.returnvalues; - - The rendered output as a &string; on success, or &false; on - failure. - - - - - &reftitle.examples; - - <methodname>Yaf_Controller_Abstract::render</methodname> example - -disableView(); - - // render product/index.phtml and return the output - // instead of sending it directly (as display() would) - $html = $this->render("product/index.phtml", array( - "products" => array("yaf", "php"), - )); - - // post-process and set it as the response body - $this->getResponse()->setBody($html); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Controller_Abstract::display - Yaf_Dispatcher::autoRender - - - - - - - diff --git a/reference/yaf/yaf_controller_abstract/setviewpath.xml b/reference/yaf/yaf_controller_abstract/setviewpath.xml deleted file mode 100644 index d8c402532345..000000000000 --- a/reference/yaf/yaf_controller_abstract/setviewpath.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - Yaf_Controller_Abstract::setViewpath - Set the view path - - - - &reftitle.description; - - public boolnullYaf_Controller_Abstract::setViewpath - stringview_directory - - - Sets the template directory of the view engine bound to this - controller. - - - - - &reftitle.parameters; - - - view_directory - - - The directory that holds the view templates. - - - - - - - - &reftitle.returnvalues; - - Returns &true; on success, or &false; / &null; on failure. - - - - - &reftitle.examples; - - <methodname>Yaf_Controller_Abstract::setViewpath</methodname> example - -setViewpath(APPLICATION_PATH . "/themes/dark/views"); - } - - public function indexAction() { - // renders application/themes/dark/views/product/index.phtml - $this->display("product/index.phtml"); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Controller_Abstract::getViewpath - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/autorender.xml b/reference/yaf/yaf_dispatcher/autorender.xml deleted file mode 100644 index 632e8f88faae..000000000000 --- a/reference/yaf/yaf_dispatcher/autorender.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - Yaf_Dispatcher::autoRender - Switch on/off autorendering - - - - &reftitle.description; - - public Yaf_DispatcherboolYaf_Dispatcher::autoRender - boolnullflagnull - - - Yaf_Dispatcher will render the view - automatically after dispatching an incoming request. You can prevent - the rendering by calling this method with - flag &false;. - - - - You can also simply return &false; in an action to prevent the - auto-rendering of that action only. - - - - - - &reftitle.parameters; - - - flag - - - Whether to enable auto-rendering. - - - - Since Yaf 2.2.0, if this parameter is not given, the current state - is returned instead. - - - - - - - - - &reftitle.returnvalues; - - Returns the Yaf_Dispatcher object itself when - flag is given, or a &boolean; indicating whether - auto-rendering is enabled when it is not. - - - - - &reftitle.examples; - - <function>Yaf_Dispatcher::autoRender</function> example - -getRequest()->isXmlHttpRequest()) { - //do not call render for ajax request - //we will output a json string - Yaf_Dispatcher::getInstance()->autoRender(FALSE); - } - } -} -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::flushInstantly - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/catchexception.xml b/reference/yaf/yaf_dispatcher/catchexception.xml deleted file mode 100644 index c46bd8d574d8..000000000000 --- a/reference/yaf/yaf_dispatcher/catchexception.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - Yaf_Dispatcher::catchException - Switch on/off exception catching - - - - &reftitle.description; - - public Yaf_DispatcherboolYaf_Dispatcher::catchException - boolnullflagnull - - - While - application.dispatcher.throwException - is on (which can also be enabled by calling - Yaf_Dispatcher::throwException), Yaf throws - exceptions when errors occur instead of triggering errors. - - - If exception catching is additionally enabled via this method (or via - application.dispatcher.catchException), - all uncaught exceptions are caught and dispatched to - ErrorController::error, if one is defined. - - - - - &reftitle.parameters; - - - flag - - - Whether Yaf should catch uncaught exceptions and dispatch them to - ErrorController::error. - - - - Since Yaf 2.2.0, if this parameter is not given, the current state - is returned instead. - - - - - - - - - &reftitle.returnvalues; - - Returns the Yaf_Dispatcher object itself when - flag is given, or a &boolean; indicating whether - exception catching is enabled when it is not. - - - - - &reftitle.examples; - - <function>Yaf_Dispatcher::catchException</function> example - -getCode()) { - case YAF_ERR_NOTFOUND_MODULE: - case YAF_ERR_NOTFOUND_CONTROLLER: - case YAF_ERR_NOTFOUND_ACTION: - case YAF_ERR_NOTFOUND_VIEW: - echo 404, ":", $exception->getMessage(); - break; - default : - $message = $exception->getMessage(); - echo 0, ":", $exception->getMessage(); - break; - } - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::throwException - Yaf_Dispatcher::setErrorHandler - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/construct.xml b/reference/yaf/yaf_dispatcher/construct.xml deleted file mode 100644 index dd9e3331cecd..000000000000 --- a/reference/yaf/yaf_dispatcher/construct.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - Yaf_Dispatcher::__construct - Yaf_Dispatcher constructor - - - - &reftitle.description; - - private Yaf_Dispatcher::__construct - - - - Yaf_Dispatcher implements the singleton pattern, - so the constructor is private. Use - Yaf_Dispatcher::getInstance to retrieve the - dispatcher instance, which is created by - Yaf_Application. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <classname>Yaf_Dispatcher</classname> is a singleton - - -]]> - - &example.outputs.similar; - - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::getInstance - Yaf_Application::getDispatcher - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/disableview.xml b/reference/yaf/yaf_dispatcher/disableview.xml deleted file mode 100644 index 92d375d925d5..000000000000 --- a/reference/yaf/yaf_dispatcher/disableview.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - Yaf_Dispatcher::disableView - Disable view rendering - - - - &reftitle.description; - - public Yaf_DispatchernullYaf_Dispatcher::disableView - - - - Turn off view rendering. This is typically used for actions that - generate their own output, such as actions returning JSON data. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the Yaf_Dispatcher object itself on - success, or &null; if the application is not initialized. - - - - - &reftitle.examples; - - <methodname>Yaf_Dispatcher::disableView</methodname> example - -disableView(); - -$app->run(); -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::enableView - Yaf_Dispatcher::autoRender - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/dispatch.xml b/reference/yaf/yaf_dispatcher/dispatch.xml deleted file mode 100644 index 73e8caf67002..000000000000 --- a/reference/yaf/yaf_dispatcher/dispatch.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - Yaf_Dispatcher::dispatch - Dispatch a request - - - - &reftitle.description; - - public Yaf_Response_AbstractnullfalseYaf_Dispatcher::dispatch - Yaf_Request_Abstractrequest - - - This method does the heavy work of the - Yaf_Dispatcher. It takes a request object. - - - The dispatch process has three distinct events: - - Routing - Dispatching - Response - - Routing takes place exactly once, using the values in the request object - when Yaf_Dispatcher::dispatch is called. - Dispatching takes place in a loop; a request may either indicate - multiple actions to dispatch, or the controller or a plugin may reset - the request object to force additional actions to dispatch (see - Yaf_Plugin_Abstract). When all is done, the - Yaf_Dispatcher returns a response. - - - - - &reftitle.parameters; - - - request - - - A Yaf_Request_Abstract instance to dispatch. - - - - - - - - &reftitle.returnvalues; - - The Yaf_Response_Abstract instance on success, - &false; on failure, or &null; if the application is not initialized. - - - - - &reftitle.examples; - - <methodname>Yaf_Dispatcher::dispatch</methodname> example - -bootstrap(); - -// Build a request pointing at ProductController::detailAction and -// dispatch it manually. -$request = new Yaf_Request_Http("/product/detail/id/42"); - -$response = Yaf_Dispatcher::getInstance()->dispatch($request); - -if ($response instanceof Yaf_Response_Abstract) { - $response->response(); -} -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Application::run - Yaf_Plugin_Abstract - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/enableview.xml b/reference/yaf/yaf_dispatcher/enableview.xml deleted file mode 100644 index 2422d2d28e6f..000000000000 --- a/reference/yaf/yaf_dispatcher/enableview.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - Yaf_Dispatcher::enableView - Enable view rendering - - - - &reftitle.description; - - public Yaf_DispatchernullYaf_Dispatcher::enableView - - - - Turn on view rendering. This is the opposite of - Yaf_Dispatcher::disableView. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the Yaf_Dispatcher object itself on - success, or &null; if the application is not initialized. - - - - - &reftitle.examples; - - <methodname>Yaf_Dispatcher::enableView</methodname> example - -getModuleName() === "Api") { - // API actions emit JSON themselves, no view rendering wanted - $dispatcher->disableView(); - } else { - $dispatcher->enableView(); - } - } -} -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::disableView - Yaf_Dispatcher::autoRender - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/flushinstantly.xml b/reference/yaf/yaf_dispatcher/flushinstantly.xml deleted file mode 100644 index faf7ff0cfbdd..000000000000 --- a/reference/yaf/yaf_dispatcher/flushinstantly.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - Yaf_Dispatcher::flushInstantly - Switch on/off the instant flushing - - - - &reftitle.description; - - public Yaf_DispatcherboolYaf_Dispatcher::flushInstantly - boolnullflagnull - - - Switch on/off instant flushing. When enabled (the default), the - response body is flushed to the client immediately once it is set by - Yaf_Response_Abstract::setBody. - - - - - &reftitle.parameters; - - - flag - - - Whether to flush the response body instantly. - - - - Since Yaf 2.2.0, if this parameter is not given, the current state - is returned instead. - - - - - - - - - &reftitle.returnvalues; - - Returns the Yaf_Dispatcher object itself when - flag is given, or a &boolean; indicating the current - state when it is not. - - - - - &reftitle.examples; - - <methodname>Yaf_Dispatcher::flushInstantly</methodname> example - -flushInstantly(false); - -// Since Yaf 2.2.0, calling it without arguments queries the current state -var_dump($dispatcher->flushInstantly()); - -$app->run(); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::returnResponse - Yaf_Response_Abstract::setBody - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/getapplication.xml b/reference/yaf/yaf_dispatcher/getapplication.xml deleted file mode 100644 index 4e6bea404922..000000000000 --- a/reference/yaf/yaf_dispatcher/getapplication.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - Yaf_Dispatcher::getApplication - Retrieve the application - - - - &reftitle.description; - - public Yaf_ApplicationnullYaf_Dispatcher::getApplication - - - - Retrieve the Yaf_Application instance. Same as - Yaf_Application::app. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The Yaf_Application instance, or &null; if no - application has been initialized yet. - - - - - &reftitle.examples; - - <methodname>Yaf_Dispatcher::getApplication</methodname> example - -getApplication() === Yaf_Application::app()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Application::app - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/getdefaultaction.xml b/reference/yaf/yaf_dispatcher/getdefaultaction.xml deleted file mode 100644 index 07efa99d7ee0..000000000000 --- a/reference/yaf/yaf_dispatcher/getdefaultaction.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - Yaf_Dispatcher::getDefaultAction - Retrieve the default action name - - - - &reftitle.description; - - public stringnullYaf_Dispatcher::getDefaultAction - - - - Get the default action name, which is used when an action name can not - be extracted from the request URI. Defaults to - "index". - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The default action name, or &null; if the application is not - initialized. - - - - - &reftitle.examples; - - <methodname>Yaf_Dispatcher::getDefaultAction</methodname> example - -getDefaultAction()); - -$dispatcher->setDefaultAction("main"); -var_dump($dispatcher->getDefaultAction()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::setDefaultAction - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/getdefaultcontroller.xml b/reference/yaf/yaf_dispatcher/getdefaultcontroller.xml deleted file mode 100644 index d637e3cffc30..000000000000 --- a/reference/yaf/yaf_dispatcher/getdefaultcontroller.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Yaf_Dispatcher::getDefaultController - Retrieve the default controller name - - - - &reftitle.description; - - public stringnullYaf_Dispatcher::getDefaultController - - - - Get the default controller name, which is used when a controller name - can not be extracted from the request URI. Defaults to - "Index". - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The default controller name, or &null; if the application is not - initialized. - - - - - &reftitle.examples; - - <methodname>Yaf_Dispatcher::getDefaultController</methodname> example - -getDefaultController()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::setDefaultController - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/getdefaultmodule.xml b/reference/yaf/yaf_dispatcher/getdefaultmodule.xml deleted file mode 100644 index c83338a5c199..000000000000 --- a/reference/yaf/yaf_dispatcher/getdefaultmodule.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Yaf_Dispatcher::getDefaultModule - Retrieve the default module name - - - - &reftitle.description; - - public stringnullYaf_Dispatcher::getDefaultModule - - - - Get the default module name, which is used when a module name can not - be extracted from the request URI. Defaults to - "Index". - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The default module name, or &null; if the application is not - initialized. - - - - - &reftitle.examples; - - <methodname>Yaf_Dispatcher::getDefaultModule</methodname> example - -getDefaultModule()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::setDefaultModule - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/getinstance.xml b/reference/yaf/yaf_dispatcher/getinstance.xml deleted file mode 100644 index 071a16e1c5d5..000000000000 --- a/reference/yaf/yaf_dispatcher/getinstance.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Yaf_Dispatcher::getInstance - Retrieve the dispatcher instance - - - - &reftitle.description; - - public static Yaf_DispatchernullYaf_Dispatcher::getInstance - - - - Retrieve the single Yaf_Dispatcher instance. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The Yaf_Dispatcher instance, or &null; if no - Yaf_Application has been initialized yet. - - - - - &reftitle.examples; - - <methodname>Yaf_Dispatcher::getInstance</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Application::getDispatcher - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/getrequest.xml b/reference/yaf/yaf_dispatcher/getrequest.xml deleted file mode 100644 index be73071cd914..000000000000 --- a/reference/yaf/yaf_dispatcher/getrequest.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - Yaf_Dispatcher::getRequest - Retrieve the request instance - - - - &reftitle.description; - - public Yaf_Request_AbstractnullYaf_Dispatcher::getRequest - - - - Retrieve the request object held by the dispatcher. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The Yaf_Request_Abstract instance, or &null; if - the application is not initialized. - - - - - &reftitle.examples; - - <methodname>Yaf_Dispatcher::getRequest</methodname> example - -getRequest(); - - // The dispatcher holds the very same request object that is - // passed to the controller - var_dump($request === $this->getRequest()); - - return false; - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::setRequest - Yaf_Request_Abstract - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/getresponse.xml b/reference/yaf/yaf_dispatcher/getresponse.xml deleted file mode 100644 index 0e32e05e6e0b..000000000000 --- a/reference/yaf/yaf_dispatcher/getresponse.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Yaf_Dispatcher::getResponse - Get the response object - - - - &reftitle.description; - - public Yaf_Response_AbstractnullYaf_Dispatcher::getResponse - - - - Retrieve the Yaf_Response_Abstract instance used - by the dispatcher. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The Yaf_Response_Abstract instance, or &null; if - the application is not initialized. - - - - - &reftitle.examples; - - <methodname>Yaf_Dispatcher::getResponse</methodname> example - -getResponse()->setHeader( - "Content-Type", "text/html; charset=utf-8" - ); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::setResponse - Yaf_Response_Abstract - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/getrouter.xml b/reference/yaf/yaf_dispatcher/getrouter.xml deleted file mode 100644 index 8b1273492f97..000000000000 --- a/reference/yaf/yaf_dispatcher/getrouter.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - Yaf_Dispatcher::getRouter - Retrieve router instance - - - - &reftitle.description; - - public Yaf_RouternullYaf_Dispatcher::getRouter - - - - Retrieve the Yaf_Router instance used by the - dispatcher to route requests. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The Yaf_Router instance, or &null; if the - application is not initialized. - - - - - &reftitle.examples; - - <methodname>Yaf_Dispatcher::getRouter</methodname> example - -getRouter(); - - // Route /product/42 to ProductController::detailAction - $router->addRoute("product", new Yaf_Route_Rewrite( - "product/:id", - array("controller" => "product", "action" => "detail") - )); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Router - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/initview.xml b/reference/yaf/yaf_dispatcher/initview.xml deleted file mode 100644 index dc6bbc7290ae..000000000000 --- a/reference/yaf/yaf_dispatcher/initview.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - Yaf_Dispatcher::initView - Initialize view and return it - - - - &reftitle.description; - - public Yaf_View_InterfacenullfalseYaf_Dispatcher::initView - stringtemplates_dir - arraynulloptionsnull - - - Initialize and return a Yaf_View_Simple instance - bound to the dispatcher, using the given template directory. - - - - - &reftitle.parameters; - - - templates_dir - - - The directory that holds the view templates. - - - - - options - - - Options passed to the view engine, see - Yaf_View_Simple::__construct. - - - - - - - - &reftitle.returnvalues; - - A Yaf_View_Interface instance on success, or - &false; / &null; on failure. - - - - - &reftitle.examples; - - <methodname>Yaf_Dispatcher::initView</methodname> example - -initView( - dirname(__FILE__) . "/application/views", - array("tpl_suffix" => ".html") -); - -$view->assign("title", "Home"); -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::setView - Yaf_View_Simple - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/registerplugin.xml b/reference/yaf/yaf_dispatcher/registerplugin.xml deleted file mode 100644 index c7090cef1415..000000000000 --- a/reference/yaf/yaf_dispatcher/registerplugin.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Yaf_Dispatcher::registerPlugin - Register a plugin - - - - &reftitle.description; - - public Yaf_DispatchernullfalseYaf_Dispatcher::registerPlugin - Yaf_Plugin_Abstractplugin - - - Register a plugin (see Yaf_Plugin_Abstract). - Generally, plugins are registered in Bootstrap (see - Yaf_Bootstrap_Abstract). - - - - - &reftitle.parameters; - - - plugin - - - A Yaf_Plugin_Abstract instance. - - - - - - - - &reftitle.returnvalues; - - Returns the Yaf_Dispatcher object itself on - success, or &false; / &null; on failure. - - - - - &reftitle.examples; - - <function>Yaf_Dispatcher::registerPlugin</function> example - -registerPlugin($user); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Plugin_Abstract - Yaf_Bootstrap_Abstract - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/returnresponse.xml b/reference/yaf/yaf_dispatcher/returnresponse.xml deleted file mode 100644 index 074e0d056940..000000000000 --- a/reference/yaf/yaf_dispatcher/returnresponse.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - Yaf_Dispatcher::returnResponse - Switch on/off returning the response - - - - &reftitle.description; - - public Yaf_DispatcherboolYaf_Dispatcher::returnResponse - boolflagfalse - - - Switch whether - Yaf_Application::run returns the response - object instead of sending it to the client directly. When enabled, - $response = $app->run() gives you the - Yaf_Response_Abstract instance so it can be - further manipulated. Available since Yaf 3.2.2. - - - - - &reftitle.parameters; - - - flag - - - Whether to return the response instead of sending it. - - - - If this parameter is not given, the current state is returned - instead. - - - - - - - - - &reftitle.returnvalues; - - Returns the Yaf_Dispatcher object itself when - flag is given, or a &boolean; indicating the current - state when it is not. - - - - - &reftitle.examples; - - <methodname>Yaf_Dispatcher::returnResponse</methodname> example - -returnResponse(true); - -// $app->run() now returns the response instead of flushing it -$response = $app->run(); - -$response->setHeader("X-Generator", "Yaf"); -$response->response(); -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Application::run - Yaf_Response_Abstract - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/setdefaultaction.xml b/reference/yaf/yaf_dispatcher/setdefaultaction.xml deleted file mode 100644 index 6323b823d57a..000000000000 --- a/reference/yaf/yaf_dispatcher/setdefaultaction.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - Yaf_Dispatcher::setDefaultAction - Change default action name - - - - &reftitle.description; - - public Yaf_DispatchernullfalseYaf_Dispatcher::setDefaultAction - stringaction - - - Change the action name which is used when an action name can not be - extracted from the request URI. The name is normalized to lowercase. - - - - - &reftitle.parameters; - - - action - - - The name of the action. - - - - - - - - &reftitle.returnvalues; - - Returns the Yaf_Dispatcher object itself on - success, or &false; if the application is not initialized. - - - - - &reftitle.examples; - - <methodname>Yaf_Dispatcher::setDefaultAction</methodname> example - -setDefaultAction("main"); - -$app->run(); -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::setDefaultModule - Yaf_Dispatcher::setDefaultController - Yaf_Dispatcher::getDefaultAction - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/setdefaultcontroller.xml b/reference/yaf/yaf_dispatcher/setdefaultcontroller.xml deleted file mode 100644 index a4a92c2baa5e..000000000000 --- a/reference/yaf/yaf_dispatcher/setdefaultcontroller.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - Yaf_Dispatcher::setDefaultController - Change default controller name - - - - &reftitle.description; - - public Yaf_DispatchernullfalseYaf_Dispatcher::setDefaultController - stringcontroller - - - Change the controller name which is used when a controller name can not - be extracted from the request URI. The name is normalized to - capitalize the first letter. - - - - - &reftitle.parameters; - - - controller - - - The name of the controller. - - - - - - - - &reftitle.returnvalues; - - Returns the Yaf_Dispatcher object itself on - success, or &false; if the application is not initialized. - - - - - &reftitle.examples; - - <methodname>Yaf_Dispatcher::setDefaultController</methodname> example - -setDefaultController("home"); - -$app->run(); -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::setDefaultModule - Yaf_Dispatcher::setDefaultAction - Yaf_Dispatcher::getDefaultController - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/setdefaultmodule.xml b/reference/yaf/yaf_dispatcher/setdefaultmodule.xml deleted file mode 100644 index de6feeb8a1a3..000000000000 --- a/reference/yaf/yaf_dispatcher/setdefaultmodule.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - Yaf_Dispatcher::setDefaultModule - Change default module name - - - - &reftitle.description; - - public Yaf_DispatchernullfalseYaf_Dispatcher::setDefaultModule - stringmodule - - - Change the module name which is used when a module name can not be - extracted from the request URI. The module must be a registered one, - see Yaf_Application::getModules. - - - - - &reftitle.parameters; - - - module - - - The name of a registered module. - - - - - - - - &reftitle.returnvalues; - - Returns the Yaf_Dispatcher object itself on - success, &false; if the given module is not registered (and a - YAF_ERR_TYPE_ERROR is triggered) or if the - application is not initialized, or &null; otherwise. - - - - - &reftitle.errors; - - Triggers a YAF_ERR_TYPE_ERROR error if - module is not a registered module name. - - - - - &reftitle.examples; - - <methodname>Yaf_Dispatcher::setDefaultModule</methodname> example - -setDefaultModule("Home"); - -$app->run(); -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::setDefaultController - Yaf_Dispatcher::setDefaultAction - Yaf_Dispatcher::getDefaultModule - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/seterrorhandler.xml b/reference/yaf/yaf_dispatcher/seterrorhandler.xml deleted file mode 100644 index c003418de820..000000000000 --- a/reference/yaf/yaf_dispatcher/seterrorhandler.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - Yaf_Dispatcher::setErrorHandler - Set error handler - - - - &reftitle.description; - - public Yaf_DispatchernullfalseYaf_Dispatcher::setErrorHandler - mixedcallback - interror_types0 - - - Set an error handler for Yaf. When - application.dispatcher.throwException - is off, Yaf triggers catchable errors when unexpected errors occur. - - - This method is a wrapper of set_error_handler; - the handler is called whenever such an error is raised. - - - - - &reftitle.parameters; - - - callback - - - A callable callback, with the same semantics as the callback passed - to set_error_handler. - - - - error_types - - - The error types to handle, same as the - error_levels parameter of - set_error_handler. Defaults to handling all error types. - - - - - - - - &reftitle.returnvalues; - - Returns the Yaf_Dispatcher object itself on - success, &false; if calling set_error_handler failed, - or &null; if the application is not initialized. - - - - - &reftitle.examples; - - <methodname>Yaf_Dispatcher::setErrorHandler</methodname> example - -setErrorHandler(function ($errno, $errstr) { - // Route errors to ErrorController::errorAction - $request = Yaf_Dispatcher::getInstance()->getRequest(); - $request->setControllerName("Error"); - $request->setActionName("error"); -}); - -$app->run(); -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::throwException - Yaf_Application::getLastErrorNo - Yaf_Application::getLastErrorMsg - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/setrequest.xml b/reference/yaf/yaf_dispatcher/setrequest.xml deleted file mode 100644 index 4f3b7090775a..000000000000 --- a/reference/yaf/yaf_dispatcher/setrequest.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - Yaf_Dispatcher::setRequest - Set the request object - - - - &reftitle.description; - - public Yaf_DispatchernullYaf_Dispatcher::setRequest - Yaf_Request_Abstractrequest - - - Set the request object used by the dispatcher. This allows using a - custom request implementation instead of the built-in - Yaf_Request_Http or - Yaf_Request_Simple. - - - - - &reftitle.parameters; - - - request - - - A Yaf_Request_Abstract instance. - - - - - - - - &reftitle.returnvalues; - - Returns the Yaf_Dispatcher object itself on - success, or &null; if the application is not initialized. - - - - - &reftitle.examples; - - <methodname>Yaf_Dispatcher::setRequest</methodname> example - -setRequest($request); - -$app->run(); -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::getRequest - Yaf_Request_Abstract - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/setresponse.xml b/reference/yaf/yaf_dispatcher/setresponse.xml deleted file mode 100644 index de36b8d4af3e..000000000000 --- a/reference/yaf/yaf_dispatcher/setresponse.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - Yaf_Dispatcher::setResponse - Set the response object - - - - &reftitle.description; - - public Yaf_DispatchernullYaf_Dispatcher::setResponse - Yaf_Response_Abstractresponse - - - Set the response object used by the dispatcher. This allows using a - custom response implementation instead of the built-in ones. - - - - - &reftitle.parameters; - - - response - - - A Yaf_Response_Abstract instance. - - - - - - - - &reftitle.returnvalues; - - Returns the Yaf_Dispatcher object itself on - success, or &null; if the application is not initialized. - - - - - &reftitle.examples; - - <methodname>Yaf_Dispatcher::setResponse</methodname> example - -setResponse(new ApiResponse()); - -$app->run(); -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::getResponse - Yaf_Dispatcher::setRequest - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/setview.xml b/reference/yaf/yaf_dispatcher/setview.xml deleted file mode 100644 index e44932cbfd29..000000000000 --- a/reference/yaf/yaf_dispatcher/setview.xml +++ /dev/null @@ -1,254 +0,0 @@ - - - - - - Yaf_Dispatcher::setView - Set a custom view engine - - - - &reftitle.description; - - public Yaf_DispatchernullYaf_Dispatcher::setView - Yaf_View_Interfaceview - - - This method provides a solution if you want use a custom view - engine instead of Yaf_View_Simple - - - - - - &reftitle.parameters; - - - view - - - A Yaf_View_Interface instance - - - - - - - - &reftitle.returnvalues; - - Returns the Yaf_Dispatcher object itself on - success, or &null; if the application is not initialized. - - - - - &reftitle.examples; - - A custom View engine example - -_smarty = new Smarty; - - if (null !== $tmplPath) { - $this->setScriptPath($tmplPath); - } - - foreach ($extraParams as $key => $value) { - $this->_smarty->$key = $value; - } - } - - /** - * Set the path to the templates - * - * @param string $path The directory to set as the path. - * @return void - */ - public function setScriptPath($path) - { - if (is_readable($path)) { - $this->_smarty->template_dir = $path; - return; - } - - throw new Exception('Invalid path provided'); - } - - /** - * Assign a variable to the template - * - * @param string $key The variable name. - * @param mixed $val The variable value. - * @return void - */ - public function __set($key, $val) - { - $this->_smarty->assign($key, $val); - } - - /** - * Allows testing with empty() and isset() to work - * - * @param string $key - * @return boolean - */ - public function __isset($key) - { - return (null !== $this->_smarty->get_template_vars($key)); - } - - /** - * Allows unset() on object properties to work - * - * @param string $key - * @return void - */ - public function __unset($key) - { - $this->_smarty->clear_assign($key); - } - - /** - * Assign variables to the template - * - * Allows setting a specific key to the specified value, OR passing - * an array of key => value pairs to set en masse. - * - * @see __set() - * @param string|array $spec The assignment strategy to use (key or - * array of key => value pairs) - * @param mixed $value (Optional) If assigning a named variable, - * use this as the value. - * @return void - */ - public function assign($spec, $value = null) { - if (is_array($spec)) { - $this->_smarty->assign($spec); - return; - } - - $this->_smarty->assign($spec, $value); - } - - /** - * Clear all assigned variables - * - * Clears all variables assigned to Yaf_View either via - * {@link assign()} or property overloading - * ({@link __get()}/{@link __set()}). - * - * @return void - */ - public function clearVars() { - $this->_smarty->clear_all_assign(); - } - - /** - * Processes a template and returns the output. - * - * @param string $name The template to process. - * @return string The output. - */ - public function render($name, $value = NULL) { - return $this->_smarty->fetch($name); - } - - public function display($name, $value = NULL) { - echo $this->_smarty->fetch($name); - } - -} -?> -]]> - - - - <function>Yaf_Dispatcher::setView</function> example - -getConfig(); - Yaf_Registry::set("config", $config); - } - - public function _initLocalName() { - /** we put class Smarty_Adapter under the local library directory */ - Yaf_Loader::getInstance()->registerLocalNamespace('Smarty'); - } - - public function _initSmarty(Yaf_Dispatcher $dispatcher) { - $smarty = new Smarty_Adapter(null, Yaf_Registry::get("config")->get("smarty")); - $dispatcher->setView($smarty); - /* now the Smarty view engine become the default view engine of Yaf */ - } -} -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_View_Interface - Yaf_View_Simple - - - - - - diff --git a/reference/yaf/yaf_dispatcher/throwexception.xml b/reference/yaf/yaf_dispatcher/throwexception.xml deleted file mode 100644 index 1bd36b77d379..000000000000 --- a/reference/yaf/yaf_dispatcher/throwexception.xml +++ /dev/null @@ -1,146 +0,0 @@ - - - - - - Yaf_Dispatcher::throwException - Switch on/off exception throwing - - - - &reftitle.description; - - public Yaf_DispatcherboolYaf_Dispatcher::throwException - boolnullflagnull - - - Switch on/off exception throwing when an unexpected error occurs. When - this is on, Yaf throws exceptions instead of triggering catchable - errors. - - - You can also use - application.dispatcher.throwException - to achieve the same purpose. - - - - - &reftitle.parameters; - - - flag - - - Whether Yaf should throw exceptions on errors. - - - - Since Yaf 2.2.0, if this parameter is not given, the current state - is returned instead. - - - - - - - - - &reftitle.returnvalues; - - Returns the Yaf_Dispatcher object itself when - flag is given, or a &boolean; indicating whether - exception throwing is enabled when it is not. - - - - - &reftitle.examples; - - <function>Yaf_Dispatcher::throwException</function> example - - array( - 'directory' => dirname(__FILE__), - ), -); -$app = new Yaf_Application($config); - -$app->getDispatcher()->throwException(true); - -try { - $app->run(); -} catch (Yaf_Exception $e) { - var_dump($e->getMessage()); -} -?> -]]> - - &example.outputs.similar; - - - - - - <function>Yaf_Dispatcher::throwException</function> example - - array( - 'directory' => dirname(__FILE__), - ), -); -$app = new Yaf_Application($config); - -$app->getDispatcher()->throwException(false); - -$app->run(); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::catchException - Yaf_Exception - - - - - - - diff --git a/reference/yaf/yaf_exception/construct.xml b/reference/yaf/yaf_exception/construct.xml deleted file mode 100644 index d8927e5ee59e..000000000000 --- a/reference/yaf/yaf_exception/construct.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - -Yaf_Exception::__construct -Construct a Yaf exception - - - - &reftitle.description; - - public Yaf_Exception::__construct - stringmessage"" - intcode0 - - Constructs a new Yaf_Exception. The code carries the Yaf error code that identifies the type of failure, and is exposed via Exception::getCode. - - - - &reftitle.parameters; - - - message - -The exception message. - - - - code - -The Yaf error code. - - - - - - - &reftitle.returnvalues; - No value is returned. - - - &reftitle.examples; - - <methodname>Yaf_Exception::__construct</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - Yaf_Exception - Yaf_Exception::getPrevious - Yaf_Exception_RouterFailed - - - - - - diff --git a/reference/yaf/yaf_exception/getprevious.xml b/reference/yaf/yaf_exception/getprevious.xml deleted file mode 100644 index 35e8f181a78f..000000000000 --- a/reference/yaf/yaf_exception/getprevious.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - -Yaf_Exception::getPrevious -Retrieve the previous exception - - - - &reftitle.description; - - public ThrowableYaf_Exception::getPrevious - - - This method is inherited from the base Throwable hierarchy and returns the exception that was chained as the previous one, if any. - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - Returns the previous Throwable if available, &null; otherwise. - - - &reftitle.examples; - - <methodname>Yaf_Exception::getPrevious</methodname> example - -getCode()); - $prev = $e->getPrevious(); - var_dump(get_class($prev)); - var_dump($prev->getMessage()); - var_dump($prev->getCode()); -} -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - Yaf_Exception::__construct - Yaf_Exception - - - - - - diff --git a/reference/yaf/yaf_loader/autoload.xml b/reference/yaf/yaf_loader/autoload.xml deleted file mode 100644 index c92741acb5a6..000000000000 --- a/reference/yaf/yaf_loader/autoload.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - -Yaf_Loader::autoload -Autoload a class - - - - &reftitle.description; - - public boolYaf_Loader::autoload - stringclass_name - - Load a class by its name. The class name is converted to a file path: underscores and namespace separators become directory separators. - MVC classes (classes whose names contain _Controller, _Action or _Plugin) are looked up under the application directory, while other classes are looked up in the library directories: the local library for locally registered class prefixes, otherwise the global library. - - - - &reftitle.parameters; - - - class_name - -The class name to load. - - - - - - &reftitle.returnvalues; -Returns &true; on success, or &false; on failure. - - - - &reftitle.examples; - - <methodname>Yaf_Loader::autoload</methodname> example - -autoload("Catalog_PriceService"); - -/* MVC classes are looked up under the application directory */ -$loader->autoload("ProductController"); -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Loader::import - Yaf_Loader::registerLocalNamespace - - - - - diff --git a/reference/yaf/yaf_loader/clearlocalnamespace.xml b/reference/yaf/yaf_loader/clearlocalnamespace.xml deleted file mode 100644 index 4f5d9ef26ceb..000000000000 --- a/reference/yaf/yaf_loader/clearlocalnamespace.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - -Yaf_Loader::clearLocalNamespace -Clear registered namespaces - - - - &reftitle.description; - - public boolYaf_Loader::clearLocalNamespace - - - Clear all registered local namespaces. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Returns &true; on success. - - - - &reftitle.examples; - - <methodname>Yaf_Loader::clearLocalNamespace</methodname> example - -registerLocalNamespace(array("Models", "Services")); -var_dump(count($loader->getLocalNamespace())); - -$loader->clearLocalNamespace(); -var_dump(count($loader->getLocalNamespace())); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Loader::registerLocalNamespace - Yaf_Loader::getLocalNamespace - - - - - diff --git a/reference/yaf/yaf_loader/construct.xml b/reference/yaf/yaf_loader/construct.xml deleted file mode 100644 index 486fd6e1adbb..000000000000 --- a/reference/yaf/yaf_loader/construct.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - -Yaf_Loader::__construct -The constructor is private - - - - &reftitle.description; - - private Yaf_Loader::__construct - - - Constructs a new loader. The constructor is private; Yaf_Loader is a singleton. Use Yaf_Loader::getInstance to obtain the instance. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -No value is returned. - - - - &reftitle.examples; - - Obtaining the <classname>Yaf_Loader</classname> singleton - -getMessage(), PHP_EOL; -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Loader::getInstance - - - - - diff --git a/reference/yaf/yaf_loader/getinstance.xml b/reference/yaf/yaf_loader/getinstance.xml deleted file mode 100644 index 8705899fe78f..000000000000 --- a/reference/yaf/yaf_loader/getinstance.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - -Yaf_Loader::getInstance -Retrieve the Yaf_Loader instance - - - - &reftitle.description; - - public static Yaf_LoaderfalseYaf_Loader::getInstance - stringlocal_library_pathnull - stringglobal_library_pathnull - - Retrieve the singleton Yaf_Loader instance. - If the library paths are given, they are applied to the existing instance. - - - - &reftitle.parameters; - - - local_library_path - -The local library directory, usually the same as the application.library.directory ini setting. - - - - global_library_path - -The global library directory. If not given, the local one is used. - - - - - - &reftitle.returnvalues; -The Yaf_Loader instance, or &false; if the loader has not been initialized (which is normally done by Yaf_Application). - - - - &reftitle.examples; - - <methodname>Yaf_Loader::getInstance</methodname> example - -registerNamespace("Vendor", APPLICATION_PATH . "/library/Vendor"); -?> -]]> - - - - <methodname>Yaf_Loader::getInstance</methodname> before initialization - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Loader::setLibraryPath - Yaf_Loader::getLibraryPath - - - - - diff --git a/reference/yaf/yaf_loader/getlibrarypath.xml b/reference/yaf/yaf_loader/getlibrarypath.xml deleted file mode 100644 index 27e4d2315326..000000000000 --- a/reference/yaf/yaf_loader/getlibrarypath.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - -Yaf_Loader::getLibraryPath -Retrieve the library path - - - - &reftitle.description; - - public stringYaf_Loader::getLibraryPath - boolis_globalfalse - - Retrieve the library directory. - - - - &reftitle.parameters; - - - is_global - -Whether to retrieve the global library directory instead of the local one. - - - - - - &reftitle.returnvalues; -The library directory as a string, or an empty string when the global library directory is requested but not set. - - - - &reftitle.examples; - - <methodname>Yaf_Loader::getLibraryPath</methodname> example - -getLibraryPath(), PHP_EOL; - -/* the global library directory */ -echo $loader->getLibraryPath(true), PHP_EOL; -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Loader::setLibraryPath - - - - - diff --git a/reference/yaf/yaf_loader/getlocalnamespace.xml b/reference/yaf/yaf_loader/getlocalnamespace.xml deleted file mode 100644 index 396a2da8efb8..000000000000 --- a/reference/yaf/yaf_loader/getlocalnamespace.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - -Yaf_Loader::getLocalNamespace -Retrieve registered namespaces - - - - &reftitle.description; - - public arrayYaf_Loader::getLocalNamespace - - - Retrieve all registered local namespaces and their paths. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -An array of the registered local namespaces, keyed by the namespace prefix, or an empty array if none are registered. - - - - &reftitle.examples; - - <methodname>Yaf_Loader::getLocalNamespace</methodname> example - -registerLocalNamespace("Models"); -$loader->registerLocalNamespace("Vendor", APPLICATION_PATH . "/library/Vendor"); - -print_r($loader->getLocalNamespace()); -?> -]]> - - &example.outputs.similar; - - /var/www/shop/application/library - [Vendor] => /var/www/shop/application/library/Vendor -) -]]> - - - - - - &reftitle.seealso; - - Yaf_Loader::registerLocalNamespace - Yaf_Loader::clearLocalNamespace - - - - - diff --git a/reference/yaf/yaf_loader/getnamespacepath.xml b/reference/yaf/yaf_loader/getnamespacepath.xml deleted file mode 100644 index d2002ef70447..000000000000 --- a/reference/yaf/yaf_loader/getnamespacepath.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - -Yaf_Loader::getNamespacePath -Retrieve the library path of a class - - - - &reftitle.description; - - public stringYaf_Loader::getNamespacePath - stringclass_name - - Retrieve the library directory a class would be looked up in. - - - - &reftitle.parameters; - - - class_name - -The class name whose library directory is requested. - - - - - - &reftitle.returnvalues; -The local library directory if the class belongs to a registered local namespace, otherwise the global library directory (falling back to the local one when the global one is not set). - - - - &reftitle.examples; - - <methodname>Yaf_Loader::getNamespacePath</methodname> example - -registerLocalNamespace("Models"); -$loader->setLibraryPath("/usr/local/share/yaf/library", true); - -/* "Models" is a registered local namespace */ -echo $loader->getNamespacePath("Models_Product"), PHP_EOL; - -/* other classes fall back to the global library directory */ -echo $loader->getNamespacePath("Vendor_Payment"), PHP_EOL; -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Loader::isLocalName - Yaf_Loader::getLibraryPath - - - - - diff --git a/reference/yaf/yaf_loader/getnamespaces.xml b/reference/yaf/yaf_loader/getnamespaces.xml deleted file mode 100644 index 5f28ba566dc2..000000000000 --- a/reference/yaf/yaf_loader/getnamespaces.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - -Yaf_Loader::getNamespaces -Alias of getLocalNamespace - - - - &reftitle.description; - - public arrayYaf_Loader::getNamespaces - - - Alias of Yaf_Loader::getLocalNamespace. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - An array of the registered local namespaces, keyed by the namespace prefix, or an empty array if none are registered. - - - - - &reftitle.examples; - - <methodname>Yaf_Loader::getNamespaces</methodname> example - -registerLocalNamespace(array("Models", "Services")); - -/* getNamespaces() is an alias of getLocalNamespace() */ -var_dump($loader->getNamespaces() === $loader->getLocalNamespace()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Loader::getLocalNamespace - - - - - diff --git a/reference/yaf/yaf_loader/import.xml b/reference/yaf/yaf_loader/import.xml deleted file mode 100644 index f2b279dcc2af..000000000000 --- a/reference/yaf/yaf_loader/import.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - -Yaf_Loader::import -Load a PHP script - - - - &reftitle.description; - - public static boolYaf_Loader::import - stringfile - - Load a PHP script file once. If the file is not an absolute path, it is looked up under the local library directory. - A file is only included once; calling Yaf_Loader::import again with the same file returns &true; without re-including it. - - - - &reftitle.parameters; - - - file - -The file to load. - - - - - - &reftitle.returnvalues; -Returns &true; on success (including when the file was already loaded), or &false; on failure. - - - - &reftitle.examples; - - <methodname>Yaf_Loader::import</methodname> example - - -]]> - - - - A file is imported only once - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Loader::autoload - - - - - diff --git a/reference/yaf/yaf_loader/islocalname.xml b/reference/yaf/yaf_loader/islocalname.xml deleted file mode 100644 index 9ce617be1d00..000000000000 --- a/reference/yaf/yaf_loader/islocalname.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - -Yaf_Loader::isLocalName -Whether a class is local - - - - &reftitle.description; - - public boolYaf_Loader::isLocalName - stringclass_name - - Determine whether a class name should be looked up in the local library directory, i.e. whether its prefix belongs to a registered local namespace. - - - - &reftitle.parameters; - - - class_name - -The class name to check. - - - - - - &reftitle.returnvalues; -Returns &true; if the class name belongs to a registered local namespace, &false; otherwise. - - - - &reftitle.examples; - - <methodname>Yaf_Loader::isLocalName</methodname> example - -registerLocalNamespace(array("Models", "Services")); - -var_dump($loader->isLocalName("Models_Product")); -var_dump($loader->isLocalName("Vendor_Session")); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Loader::registerLocalNamespace - Yaf_Loader::getNamespacePath - - - - - diff --git a/reference/yaf/yaf_loader/registerlocalnamespace.xml b/reference/yaf/yaf_loader/registerlocalnamespace.xml deleted file mode 100644 index 1b855fdffe1d..000000000000 --- a/reference/yaf/yaf_loader/registerlocalnamespace.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - -Yaf_Loader::registerLocalNamespace -Register local namespace - - - - &reftitle.description; - - public Yaf_LoaderfalseYaf_Loader::registerLocalNamespace - stringarraynamespace - stringpath&null; - - Register a local namespace. Classes whose prefix belongs to a local namespace are looked up under the given path (or the local library directory when no path is given) instead of the global one. - This lets you place your own classes into the local library directory, while shared classes live in the global library directory (see the yaf.library ini setting). - - - - &reftitle.parameters; - - - namespace - -A namespace prefix string, or an array of prefix/path pairs (when the value is a path string) or prefix strings. -A prefix only matches at an underscore or backslash boundary: registering Models makes Models_User and Models itself local, but not ModelsUser. A leading backslash is ignored, and a class name written with backslashes is looked up as if they were underscores. - - - - path - -The directory to look up the namespace in. If not given, the local library directory is used. - - - - - - &reftitle.returnvalues; -Returns the loader instance itself on success, or &false; if an invalid parameter is provided. - - - - &reftitle.examples; - - <methodname>Yaf_Loader::registerLocalNamespace</methodname> example - -registerLocalNamespace("Models"); - - /* register several prefixes at once, each with its - * own lookup directory */ - $loader->registerLocalNamespace(array( - "Services" => APPLICATION_PATH . "/services", - "Vendor" => APPLICATION_PATH . "/vendor", - )); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Loader::getLocalNamespace - Yaf_Loader::clearLocalNamespace - Yaf_Loader::isLocalName - - - - - diff --git a/reference/yaf/yaf_loader/registernamespace.xml b/reference/yaf/yaf_loader/registernamespace.xml deleted file mode 100644 index 310691e0787a..000000000000 --- a/reference/yaf/yaf_loader/registernamespace.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - -Yaf_Loader::registerNamespace -Alias of registerLocalNamespace - - - - &reftitle.description; - - public Yaf_LoaderfalseYaf_Loader::registerNamespace - stringarraynamespace - stringpath&null; - - Alias of Yaf_Loader::registerLocalNamespace. - - - - &reftitle.parameters; - - - namespace - -A namespace prefix string, or an array of prefix/path pairs (when the value is a path string) or prefix strings. - - - - path - -The directory to look up the namespace in. If not given, the local library directory is used. - - - - - - &reftitle.returnvalues; -Returns the loader instance itself on success, or &false; if an invalid parameter is provided. - - - - - &reftitle.examples; - - <methodname>Yaf_Loader::registerNamespace</methodname> example - -registerNamespace( - "Vendor", - APPLICATION_PATH . "/library/Vendor" - ); - } -} - -/* new Vendor_Payment_Gateway() is now looked up in - * APPLICATION_PATH/library/Vendor/Payment/Gateway.php */ -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Loader::registerLocalNamespace - - - - - diff --git a/reference/yaf/yaf_loader/setlibrarypath.xml b/reference/yaf/yaf_loader/setlibrarypath.xml deleted file mode 100644 index c746f3245cdb..000000000000 --- a/reference/yaf/yaf_loader/setlibrarypath.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - -Yaf_Loader::setLibraryPath -Change the library path - - - - &reftitle.description; - - public Yaf_LoaderYaf_Loader::setLibraryPath - stringlibrary_path - boolis_globalfalse - - Change the library directory. - - - - &reftitle.parameters; - - - library_path - -The new library directory. - - - - is_global - -Whether to change the global library directory instead of the local one. - - - - - - &reftitle.returnvalues; -Returns the loader instance itself. - - - - &reftitle.examples; - - <methodname>Yaf_Loader::setLibraryPath</methodname> example - -setLibraryPath("/var/www/shop/application/library"); - -/* change the global library directory */ -$loader->setLibraryPath("/usr/local/share/yaf/library", true); - -echo $loader->getLibraryPath(), PHP_EOL; -echo $loader->getLibraryPath(true), PHP_EOL; -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Loader::getLibraryPath - - - - - diff --git a/reference/yaf/yaf_plugin_abstract/dispatchloopshutdown.xml b/reference/yaf/yaf_plugin_abstract/dispatchloopshutdown.xml deleted file mode 100644 index 0844a5d001f5..000000000000 --- a/reference/yaf/yaf_plugin_abstract/dispatchloopshutdown.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - -Yaf_Plugin_Abstract::dispatchLoopShutdown -Hook after dispatch loop - - - - &reftitle.description; - - public voidYaf_Plugin_Abstract::dispatchLoopShutdown - Yaf_Request_Abstractrequest - Yaf_Response_Abstractresponse - - This hook is triggered once, after the dispatch loop has finished and all actions have been executed, but before the response is sent to the client. It is usually used for logging or cleanup. - - - - &reftitle.parameters; - - - request - -The Yaf_Request_Abstract instance being dispatched. - - - - response - -The Yaf_Response_Abstract instance. - - - - - - &reftitle.returnvalues; -No value is returned. - - - - &reftitle.examples; - - <methodname>Yaf_Plugin_Abstract::dispatchLoopShutdown</methodname> example - -getRequestUri(), - $request->getControllerName(), - $request->getActionName() - )); - } -} - -/* plugins are registered in the bootstrap */ -class Bootstrap extends Yaf_Bootstrap_Abstract -{ - public function _initPlugin(Yaf_Dispatcher $dispatcher) - { - $dispatcher->registerPlugin(new AccessLogPlugin()); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Plugin_Abstract::routerStartup - Yaf_Plugin_Abstract::routerShutdown - Yaf_Plugin_Abstract::dispatchLoopStartup - Yaf_Plugin_Abstract::preDispatch - Yaf_Plugin_Abstract::postDispatch - Yaf_Plugin_Abstract::preResponse - - - - - diff --git a/reference/yaf/yaf_plugin_abstract/dispatchloopstartup.xml b/reference/yaf/yaf_plugin_abstract/dispatchloopstartup.xml deleted file mode 100644 index 7de52b0561aa..000000000000 --- a/reference/yaf/yaf_plugin_abstract/dispatchloopstartup.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - -Yaf_Plugin_Abstract::dispatchLoopStartup -Hook before dispatch loop - - - - &reftitle.description; - - public voidYaf_Plugin_Abstract::dispatchLoopStartup - Yaf_Request_Abstractrequest - Yaf_Response_Abstractresponse - - This hook is triggered once, right before the dispatch loop starts and the view engine is initialized. - - - - &reftitle.parameters; - - - request - -The Yaf_Request_Abstract instance being dispatched. - - - - response - -The Yaf_Response_Abstract instance. - - - - - - &reftitle.returnvalues; -No value is returned. - - - - &reftitle.examples; - - <methodname>Yaf_Plugin_Abstract::dispatchLoopStartup</methodname> example - -registerPlugin(new BenchmarkPlugin()); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Plugin_Abstract::routerStartup - Yaf_Plugin_Abstract::routerShutdown - Yaf_Plugin_Abstract::preDispatch - Yaf_Plugin_Abstract::postDispatch - Yaf_Plugin_Abstract::dispatchLoopShutdown - Yaf_Plugin_Abstract::preResponse - - - - - diff --git a/reference/yaf/yaf_plugin_abstract/postdispatch.xml b/reference/yaf/yaf_plugin_abstract/postdispatch.xml deleted file mode 100644 index c9b007fa76c6..000000000000 --- a/reference/yaf/yaf_plugin_abstract/postdispatch.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - -Yaf_Plugin_Abstract::postDispatch -Hook after each dispatch - - - - &reftitle.description; - - public voidYaf_Plugin_Abstract::postDispatch - Yaf_Request_Abstractrequest - Yaf_Response_Abstractresponse - - This hook is triggered after each dispatch iteration finishes, i.e. after the action has been executed. Like Yaf_Plugin_Abstract::preDispatch, it may be called more than once per request. - - - - &reftitle.parameters; - - - request - -The Yaf_Request_Abstract instance being dispatched. - - - - response - -The Yaf_Response_Abstract instance. - - - - - - &reftitle.returnvalues; -No value is returned. - - - - &reftitle.examples; - - <methodname>Yaf_Plugin_Abstract::postDispatch</methodname> example - -appendBody(sprintf( - "\n", - $elapsed - )); - } -} - -/* plugins are registered in the bootstrap */ -class Bootstrap extends Yaf_Bootstrap_Abstract -{ - public function _initPlugin(Yaf_Dispatcher $dispatcher) - { - $dispatcher->registerPlugin(new BenchmarkPlugin()); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Plugin_Abstract::routerStartup - Yaf_Plugin_Abstract::routerShutdown - Yaf_Plugin_Abstract::dispatchLoopStartup - Yaf_Plugin_Abstract::preDispatch - Yaf_Plugin_Abstract::dispatchLoopShutdown - Yaf_Plugin_Abstract::preResponse - - - - - diff --git a/reference/yaf/yaf_plugin_abstract/predispatch.xml b/reference/yaf/yaf_plugin_abstract/predispatch.xml deleted file mode 100644 index bad608e93813..000000000000 --- a/reference/yaf/yaf_plugin_abstract/predispatch.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - -Yaf_Plugin_Abstract::preDispatch -Hook before each dispatch - - - - &reftitle.description; - - public voidYaf_Plugin_Abstract::preDispatch - Yaf_Request_Abstractrequest - Yaf_Response_Abstractresponse - - This hook is triggered before each dispatch iteration in the dispatch loop. A dispatch loop may run several iterations, so this hook may be called more than once per request. - - - - &reftitle.parameters; - - - request - -The Yaf_Request_Abstract instance being dispatched. - - - - response - -The Yaf_Response_Abstract instance. - - - - - - &reftitle.returnvalues; -No value is returned. - - - - &reftitle.examples; - - <methodname>Yaf_Plugin_Abstract::preDispatch</methodname> example - -getView(); - if ($request->getModuleName() == "Admin") { - $view->setScriptPath(APPLICATION_PATH . "/modules/admin/views"); - } - } -} - -/* plugins are registered in the bootstrap */ -class Bootstrap extends Yaf_Bootstrap_Abstract -{ - public function _initPlugin(Yaf_Dispatcher $dispatcher) - { - $dispatcher->registerPlugin(new LayoutPlugin()); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Plugin_Abstract::routerStartup - Yaf_Plugin_Abstract::routerShutdown - Yaf_Plugin_Abstract::dispatchLoopStartup - Yaf_Plugin_Abstract::postDispatch - Yaf_Plugin_Abstract::dispatchLoopShutdown - Yaf_Plugin_Abstract::preResponse - - - - - diff --git a/reference/yaf/yaf_plugin_abstract/preresponse.xml b/reference/yaf/yaf_plugin_abstract/preresponse.xml deleted file mode 100644 index bc5c706f1931..000000000000 --- a/reference/yaf/yaf_plugin_abstract/preresponse.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - -Yaf_Plugin_Abstract::preResponse -Hook before the response is sent - - - - &reftitle.description; - - public voidYaf_Plugin_Abstract::preResponse - Yaf_Request_Abstractrequest - Yaf_Response_Abstractresponse - - This hook is intended to be triggered before the response is sent to the client. - - As of this version this hook is never called: it is registered on Yaf_Plugin_Abstract but not wired into the dispatch flow. Overriding it has no effect. - - - - - &reftitle.parameters; - - - request - -The Yaf_Request_Abstract instance being dispatched. - - - - response - -The Yaf_Response_Abstract instance. - - - - - - &reftitle.returnvalues; -No value is returned. - - - - &reftitle.examples; - - <methodname>Yaf_Plugin_Abstract::preResponse</methodname> example - -setBody( - preg_replace("/>\s+<", $response->getBody()) - ); - } -} - -/* plugins are registered in the bootstrap */ -class Bootstrap extends Yaf_Bootstrap_Abstract -{ - public function _initPlugin(Yaf_Dispatcher $dispatcher) - { - $dispatcher->registerPlugin(new MinifyPlugin()); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Plugin_Abstract::routerStartup - Yaf_Plugin_Abstract::routerShutdown - Yaf_Plugin_Abstract::dispatchLoopStartup - Yaf_Plugin_Abstract::preDispatch - Yaf_Plugin_Abstract::postDispatch - Yaf_Plugin_Abstract::dispatchLoopShutdown - - - - - diff --git a/reference/yaf/yaf_plugin_abstract/routershutdown.xml b/reference/yaf/yaf_plugin_abstract/routershutdown.xml deleted file mode 100644 index 59fa7a19c701..000000000000 --- a/reference/yaf/yaf_plugin_abstract/routershutdown.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - -Yaf_Plugin_Abstract::routerShutdown -Hook after routing - - - - &reftitle.description; - - public voidYaf_Plugin_Abstract::routerShutdown - Yaf_Request_Abstractrequest - Yaf_Response_Abstractresponse - - This hook is triggered after the routing process has finished and the controller and action names have been resolved, but before the dispatch loop starts. It is usually used for access control checks such as a login check, because the target controller and action are already known. - - - - &reftitle.parameters; - - - request - -The Yaf_Request_Abstract instance being dispatched. - - - - response - -The Yaf_Response_Abstract instance. - - - - - - &reftitle.returnvalues; -No value is returned. - - - - &reftitle.examples; - - <methodname>Yaf_Plugin_Abstract::routerShutdown</methodname> example - - array("index"), "User" => array("login")); - - $controller = $request->getControllerName(); - $action = $request->getActionName(); - - if (isset($public[$controller]) && in_array($action, $public[$controller])) { - return; - } - - if (!Yaf_Session::getInstance()->has("login")) { - $response->setRedirect("/user/login"); - $request->setDispatched(true); // do not dispatch the request - } - } -} - -/* plugins are registered in the bootstrap */ -class Bootstrap extends Yaf_Bootstrap_Abstract -{ - public function _initPlugin(Yaf_Dispatcher $dispatcher) - { - $dispatcher->registerPlugin(new AuthPlugin()); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Plugin_Abstract::routerStartup - Yaf_Plugin_Abstract::dispatchLoopStartup - Yaf_Plugin_Abstract::preDispatch - Yaf_Plugin_Abstract::postDispatch - Yaf_Plugin_Abstract::dispatchLoopShutdown - Yaf_Plugin_Abstract::preResponse - - - - - diff --git a/reference/yaf/yaf_plugin_abstract/routerstartup.xml b/reference/yaf/yaf_plugin_abstract/routerstartup.xml deleted file mode 100644 index 37a42be80654..000000000000 --- a/reference/yaf/yaf_plugin_abstract/routerstartup.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - -Yaf_Plugin_Abstract::routerStartup -Hook before routing - - - - &reftitle.description; - - public voidYaf_Plugin_Abstract::routerStartup - Yaf_Request_Abstractrequest - Yaf_Response_Abstractresponse - - This hook is triggered right before the request is routed. It is the earliest hook in the dispatch flow, so it is usually used for URL rewriting or for routing decisions that must happen before Yaf_Router::route runs. - - - - &reftitle.parameters; - - - request - -The Yaf_Request_Abstract instance being dispatched. - - - - response - -The Yaf_Response_Abstract instance. - - - - - - &reftitle.returnvalues; -No value is returned. - - - - &reftitle.examples; - - <methodname>Yaf_Plugin_Abstract::routerStartup</methodname> example - -getRequestUri(); - if (preg_match("#^/[a-z]+$#", $uri)) { - $request->setRequestUri("/page" . $uri); - } - } -} - -/* plugins are registered in the bootstrap */ -class Bootstrap extends Yaf_Bootstrap_Abstract -{ - public function _initPlugin(Yaf_Dispatcher $dispatcher) - { - $dispatcher->registerPlugin(new RewritePlugin()); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Plugin_Abstract::routerShutdown - Yaf_Plugin_Abstract::dispatchLoopStartup - Yaf_Plugin_Abstract::preDispatch - Yaf_Plugin_Abstract::postDispatch - Yaf_Plugin_Abstract::dispatchLoopShutdown - Yaf_Plugin_Abstract::preResponse - - - - - diff --git a/reference/yaf/yaf_registry/construct.xml b/reference/yaf/yaf_registry/construct.xml deleted file mode 100644 index 199dfa01f73e..000000000000 --- a/reference/yaf/yaf_registry/construct.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - -Yaf_Registry::__construct -Constructor of Yaf_Registry - - - - &reftitle.description; - - privateYaf_Registry::__construct - - - The constructor is private: Yaf_Registry implements the singleton pattern and cannot be instantiated directly. Use the static methods to read and write registry entries. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -No value is returned. - - - &reftitle.examples; - - <methodname>Yaf_Registry::__construct</methodname> example - - The constructor is private, so direct instantiation is rejected: - - - -]]> - - &example.outputs.similar; - - - - - - Using <classname>Yaf_Registry</classname> through its static methods - -getConfig()->application->version); -var_dump(Yaf_Registry::get("version")); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Registry::set - Yaf_Registry::get - Yaf_Registry::has - - - - - diff --git a/reference/yaf/yaf_registry/del.xml b/reference/yaf/yaf_registry/del.xml deleted file mode 100644 index 333a4a92ea9b..000000000000 --- a/reference/yaf/yaf_registry/del.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - -Yaf_Registry::del -Remove an item from registry - - - - &reftitle.description; - - public static boolYaf_Registry::del - stringname - - Removes an entry from the registry. Removing a name that does not exist is silently accepted. - - - - &reftitle.parameters; - - - name - -The name of the registry entry. - - - - - - &reftitle.returnvalues; -Always returns &true;. - - - - &reftitle.examples; - - <methodname>Yaf_Registry::del</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Registry::get - Yaf_Registry::set - Yaf_Registry::has - - - - - diff --git a/reference/yaf/yaf_registry/get.xml b/reference/yaf/yaf_registry/get.xml deleted file mode 100644 index 612410f584c5..000000000000 --- a/reference/yaf/yaf_registry/get.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - -Yaf_Registry::get -Retrieve an item from registry - - - - &reftitle.description; - - public static mixedYaf_Registry::get - stringname - - Retrieves a value from the registry. - - - - &reftitle.parameters; - - - name - -The name of the registry entry. - - - - - - &reftitle.returnvalues; -The value stored under name, or &null; if there is no entry with that name. - - - - &reftitle.examples; - - <methodname>Yaf_Registry::get</methodname> example - -getView()->assign("visits", $redis->get("site:visits")); - - return true; - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Registry::set - Yaf_Registry::has - Yaf_Registry::del - - - - - diff --git a/reference/yaf/yaf_registry/has.xml b/reference/yaf/yaf_registry/has.xml deleted file mode 100644 index 2be4b215de47..000000000000 --- a/reference/yaf/yaf_registry/has.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - -Yaf_Registry::has -Check whether an item exists - - - - &reftitle.description; - - public static boolYaf_Registry::has - stringname - - Checks whether a value exists in the registry. - - - - &reftitle.parameters; - - - name - -The name of the registry entry. - - - - - - &reftitle.returnvalues; -Returns &true; if an entry with the given name exists, &false; otherwise. - - - - &reftitle.examples; - - <methodname>Yaf_Registry::has</methodname> example - -getConfig()->redis; - - $redis = new Redis(); - $redis->connect($config->host, $config->port); - - Yaf_Registry::set("redis", $redis); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Registry::get - Yaf_Registry::set - Yaf_Registry::del - - - - - diff --git a/reference/yaf/yaf_registry/set.xml b/reference/yaf/yaf_registry/set.xml deleted file mode 100644 index 81ed220562cb..000000000000 --- a/reference/yaf/yaf_registry/set.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - -Yaf_Registry::set -Add an item into registry - - - - &reftitle.description; - - public static boolYaf_Registry::set - stringname - mixedvalue - - Stores a value in the registry. Setting an already existing name overwrites its previous value. - - - - &reftitle.parameters; - - - name - -The name of the registry entry. - - - - value - -The value to store; it may be of any type, including objects. - - - - - - &reftitle.returnvalues; -Returns &true; on success, or &false; on failure. - - - - &reftitle.examples; - - <methodname>Yaf_Registry::set</methodname> example - -getConfig()->redis; - - $redis = new Redis(); - $redis->connect($config->host, $config->port); - - /* the connection is now available to the whole application */ - Yaf_Registry::set("redis", $redis); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Registry::get - Yaf_Registry::has - Yaf_Registry::del - - - - - diff --git a/reference/yaf/yaf_request_abstract/clearparams.xml b/reference/yaf/yaf_request_abstract/clearparams.xml deleted file mode 100644 index 8c58159d6601..000000000000 --- a/reference/yaf/yaf_request_abstract/clearparams.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - -Yaf_Request_Abstract::clearParams -Remove all parameters - - - - &reftitle.description; - - public Yaf_Request_AbstractnullYaf_Request_Abstract::clearParams - - - Remove all parameters set by the router, or by Yaf_Request_Abstract::setParam. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Returns the request object itself. - - - - &reftitle.examples; - - <methodname>Yaf_Request_Abstract::clearParams</methodname> example - -getRequest(); - - $request->setParam("referrer", "newsletter"); - var_dump($request->getParam("referrer")); - - $request->clearParams(); - var_dump($request->getParam("referrer")); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::setParam - Yaf_Request_Abstract::getParam - Yaf_Request_Abstract::getParams - - - - - diff --git a/reference/yaf/yaf_request_abstract/get.xml b/reference/yaf/yaf_request_abstract/get.xml deleted file mode 100644 index bce533038a30..000000000000 --- a/reference/yaf/yaf_request_abstract/get.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - -Yaf_Request_Abstract::get -Retrieve a variable from the request - - - - &reftitle.description; - - public mixedYaf_Request_Abstract::get - stringname - mixeddefault - - Retrieves a variable from the request. The search order is: request parameters set by Yaf_Request_Abstract::setParam, then POST, GET, COOKIE, SERVER. - - - - &reftitle.parameters; - - - name - -The variable name. - - - - default - -The value to return if the variable is not found. - - - - - - &reftitle.returnvalues; -The value if found, or default if it was provided, &null; otherwise. - - - - &reftitle.examples; - - <methodname>Yaf_Request_Abstract::get</methodname> example - -getRequest(); - - // Assuming the request is /search?keyword=yaf&page=2 - $keyword = $request->get("keyword"); - $page = (int) $request->get("page", 1); - $sort = $request->get("sort", "relevance"); - - var_dump($keyword, $page, $sort); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::getQuery - Yaf_Request_Abstract::getRequest - Yaf_Request_Abstract::getPost - Yaf_Request_Abstract::getCookie - Yaf_Request_Abstract::getFiles - Yaf_Request_Abstract::getParam - - - - - diff --git a/reference/yaf/yaf_request_abstract/getactionname.xml b/reference/yaf/yaf_request_abstract/getactionname.xml deleted file mode 100644 index c9d2a7694abe..000000000000 --- a/reference/yaf/yaf_request_abstract/getactionname.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - -Yaf_Request_Abstract::getActionName -Retrieve the action name - - - - &reftitle.description; - - public stringnullYaf_Request_Abstract::getActionName - - - Retrieve the action name - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -The action name, or &null; if not set. - - - - &reftitle.examples; - - <methodname>Yaf_Request_Abstract::getActionName</methodname> example - -getRequest()->getActionName()); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::getModuleName - Yaf_Request_Abstract::getControllerName - Yaf_Request_Abstract::getActionName - Yaf_Request_Abstract::setModuleName - Yaf_Request_Abstract::setControllerName - Yaf_Request_Abstract::setActionName - - - - - diff --git a/reference/yaf/yaf_request_abstract/getbaseuri.xml b/reference/yaf/yaf_request_abstract/getbaseuri.xml deleted file mode 100644 index 930ed9e8dd93..000000000000 --- a/reference/yaf/yaf_request_abstract/getbaseuri.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - -Yaf_Request_Abstract::getBaseUri -Retrieve the base URI - - - - &reftitle.description; - - public stringnullYaf_Request_Abstract::getBaseUri - - - Retrieve the base URI - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -The base URI, or an empty string if not set. - - - - &reftitle.examples; - - <methodname>Yaf_Request_Abstract::getBaseUri</methodname> example - -getRequest(); - - // Assuming the application is served under /myapp, - // and the request is /myapp/product/view - var_dump($request->getBaseUri()); - var_dump($request->getRequestUri()); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::setBaseUri - Yaf_Request_Abstract::getRequestUri - Yaf_Request_Abstract::setRequestUri - - - - - diff --git a/reference/yaf/yaf_request_abstract/getcontrollername.xml b/reference/yaf/yaf_request_abstract/getcontrollername.xml deleted file mode 100644 index 195390369fa0..000000000000 --- a/reference/yaf/yaf_request_abstract/getcontrollername.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - -Yaf_Request_Abstract::getControllerName -Retrieve the controller name - - - - &reftitle.description; - - public stringnullYaf_Request_Abstract::getControllerName - - - Retrieve the controller name - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -The controller name, or &null; if not set. - - - - &reftitle.examples; - - <methodname>Yaf_Request_Abstract::getControllerName</methodname> example - -getRequest()->getControllerName()); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::getModuleName - Yaf_Request_Abstract::getControllerName - Yaf_Request_Abstract::getActionName - Yaf_Request_Abstract::setModuleName - Yaf_Request_Abstract::setControllerName - Yaf_Request_Abstract::setActionName - - - - - diff --git a/reference/yaf/yaf_request_abstract/getcookie.xml b/reference/yaf/yaf_request_abstract/getcookie.xml deleted file mode 100644 index 4a55becf2c55..000000000000 --- a/reference/yaf/yaf_request_abstract/getcookie.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - -Yaf_Request_Abstract::getCookie -Fetch a COOKIE variable - - - - &reftitle.description; - - public mixedYaf_Request_Abstract::getCookie - stringname - mixeddefault - - Retrieves a variable from $_COOKIE. - - - - &reftitle.parameters; - - - name - -The variable name. If omitted, the whole array is returned. - - - - default - -The value to return if the variable is not found. - - - - - - &reftitle.returnvalues; -The cookie value, or default if it is not set. - - - - &reftitle.examples; - - <methodname>Yaf_Request_Abstract::getCookie</methodname> example - -getRequest(); - - $theme = $request->getCookie("theme", "light"); - $sessionId = $request->getCookie("sid"); - - var_dump($theme, $sessionId); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::getQuery - Yaf_Request_Abstract::getRequest - Yaf_Request_Abstract::getPost - Yaf_Request_Abstract::getCookie - Yaf_Request_Abstract::getFiles - Yaf_Request_Abstract::getParam - - - - - diff --git a/reference/yaf/yaf_request_abstract/getenv.xml b/reference/yaf/yaf_request_abstract/getenv.xml deleted file mode 100644 index 26f31904d711..000000000000 --- a/reference/yaf/yaf_request_abstract/getenv.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - -Yaf_Request_Abstract::getEnv -Retrieve an ENV variable - - - - &reftitle.description; - - public mixedYaf_Request_Abstract::getEnv - stringname - mixeddefault - - Retrieves a ENV variable. - - - - &reftitle.parameters; - - - name - -The variable name. - - - - default - -The value to return if the variable is not found. - - - - - - &reftitle.returnvalues; -The variable value, or default if it is not found. - - - - &reftitle.examples; - - <methodname>Yaf_Request_Abstract::getEnv</methodname> example - -getRequest()->getEnv("APPLICATION_ENV", "production"); - - var_dump($env); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::getQuery - Yaf_Request_Abstract::getRequest - Yaf_Request_Abstract::getPost - Yaf_Request_Abstract::getCookie - Yaf_Request_Abstract::getFiles - Yaf_Request_Abstract::getParam - - - - - diff --git a/reference/yaf/yaf_request_abstract/getexception.xml b/reference/yaf/yaf_request_abstract/getexception.xml deleted file mode 100644 index f09d3650a498..000000000000 --- a/reference/yaf/yaf_request_abstract/getexception.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - Yaf_Request_Abstract::getException - Retrieve the exception - - - - &reftitle.description; - - public ExceptionnullYaf_Request_Abstract::getException - - - Retrieve the exception caught during dispatching. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - The Exception caught during dispatching, or &null; if none. - - - - &reftitle.examples; - - <methodname>Yaf_Request_Abstract::getException</methodname> example - -catchException(true); - -class ErrorController extends Yaf_Controller_Abstract -{ - public function errorAction($exception) - { - var_dump($this->getRequest()->getException() === $exception); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Dispatcher::catchException - - - - - diff --git a/reference/yaf/yaf_request_abstract/getfiles.xml b/reference/yaf/yaf_request_abstract/getfiles.xml deleted file mode 100644 index 12970cd6bd4e..000000000000 --- a/reference/yaf/yaf_request_abstract/getfiles.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - -Yaf_Request_Abstract::getFiles -Fetch uploaded files - - - - &reftitle.description; - - public mixedYaf_Request_Abstract::getFiles - stringname - mixeddefault - - Retrieves a variable from $_FILES. - - - - &reftitle.parameters; - - - name - -The variable name. If omitted, the whole array is returned. - - - - default - -The value to return if the variable is not found. - - - - - - &reftitle.returnvalues; -The uploaded files array, or default if it is not set. - - - - &reftitle.examples; - - <methodname>Yaf_Request_Abstract::getFiles</methodname> example - -getRequest()->getFiles("avatar"); - - if (is_array($file) && $file["error"] === UPLOAD_ERR_OK) { - move_uploaded_file( - $file["tmp_name"], - "/var/www/uploads/" . basename($file["name"]) - ); - } - } -} -?>]]> - - - - <methodname>Yaf_Request_Abstract::getFiles</methodname> example - -getRequest()->getFiles("avatar")); - } -} -?>]]> - - &example.outputs.similar; - - - string(9) "photo.jpg" - ["type"]=> - string(10) "image/jpeg" - ["tmp_name"]=> - string(14) "/tmp/phpXvBXqZ" - ["error"]=> - int(0) - ["size"]=> - int(12455) -} -]]> - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::getQuery - Yaf_Request_Abstract::getRequest - Yaf_Request_Abstract::getPost - Yaf_Request_Abstract::getCookie - Yaf_Request_Abstract::getFiles - Yaf_Request_Abstract::getParam - - - - - diff --git a/reference/yaf/yaf_request_abstract/getlanguage.xml b/reference/yaf/yaf_request_abstract/getlanguage.xml deleted file mode 100644 index 193f0f5bae3a..000000000000 --- a/reference/yaf/yaf_request_abstract/getlanguage.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - -Yaf_Request_Abstract::getLanguage -Retrieve the client's preferred language - - - - &reftitle.description; - - public stringnullYaf_Request_Abstract::getLanguage - - - Retrieve the client's preferred language - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -The preferred language string, or &null; if it cannot be determined. - - - - &reftitle.examples; - - <methodname>Yaf_Request_Abstract::getLanguage</methodname> example - -getRequest()->getLanguage(); - - var_dump($language); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::getServer - Yaf_Request_Abstract::getEnv - - - - - diff --git a/reference/yaf/yaf_request_abstract/getmethod.xml b/reference/yaf/yaf_request_abstract/getmethod.xml deleted file mode 100644 index d1168c0d25b1..000000000000 --- a/reference/yaf/yaf_request_abstract/getmethod.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - -Yaf_Request_Abstract::getMethod -Retrieve the request method - - - - &reftitle.description; - - public stringnullYaf_Request_Abstract::getMethod - - - Retrieve the request method - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -The request method as a string, e.g. GET, POST, PUT, DELETE. - - - - &reftitle.examples; - - <methodname>Yaf_Request_Abstract::getMethod</methodname> example - -getRequest(); - - // Assuming the request was sent with POST /order/save - var_dump($request->getMethod()); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::isGet - Yaf_Request_Abstract::isPost - Yaf_Request_Abstract::isPut - Yaf_Request_Abstract::isHead - Yaf_Request_Abstract::isOptions - Yaf_Request_Abstract::isDelete - Yaf_Request_Abstract::isPatch - Yaf_Request_Abstract::isCli - Yaf_Request_Abstract::isXmlHttpRequest - - - - - diff --git a/reference/yaf/yaf_request_abstract/getmodulename.xml b/reference/yaf/yaf_request_abstract/getmodulename.xml deleted file mode 100644 index 8f69fd89e241..000000000000 --- a/reference/yaf/yaf_request_abstract/getmodulename.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - -Yaf_Request_Abstract::getModuleName -Retrieve the module name - - - - &reftitle.description; - - public stringnullYaf_Request_Abstract::getModuleName - - - Retrieve the module name - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -The module name, or &null; if not set. - - - - &reftitle.examples; - - <methodname>Yaf_Request_Abstract::getModuleName</methodname> example - -getRequest()->getModuleName()); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::getModuleName - Yaf_Request_Abstract::getControllerName - Yaf_Request_Abstract::getActionName - Yaf_Request_Abstract::setModuleName - Yaf_Request_Abstract::setControllerName - Yaf_Request_Abstract::setActionName - - - - - diff --git a/reference/yaf/yaf_request_abstract/getparam.xml b/reference/yaf/yaf_request_abstract/getparam.xml deleted file mode 100644 index 5f5ae333c1e7..000000000000 --- a/reference/yaf/yaf_request_abstract/getparam.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - -Yaf_Request_Abstract::getParam -Retrieve a parameter - - - - &reftitle.description; - - public mixedYaf_Request_Abstract::getParam - stringname - mixeddefault - - Retrieves a parameter (a named routing/action parameter) from the request. - - - - &reftitle.parameters; - - - name - -The parameter name. - - - - default - -The value to return if the parameter is not set. - - - - - - &reftitle.returnvalues; -The parameter value, or default if it was provided, &null; otherwise. - - - - &reftitle.examples; - - <methodname>Yaf_Request_Abstract::getParam</methodname> example - -getRequest(); - - // Assuming the request is /product/view/id/17 - $id = (int) $request->getParam("id"); - $referrer = $request->getParam("referrer", "direct"); - - var_dump($id, $referrer); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::setParam - Yaf_Request_Abstract::getParams - Yaf_Request_Abstract::clearParams - Yaf_Request_Abstract::get - - - - - diff --git a/reference/yaf/yaf_request_abstract/getparams.xml b/reference/yaf/yaf_request_abstract/getparams.xml deleted file mode 100644 index b116dcdfdf9a..000000000000 --- a/reference/yaf/yaf_request_abstract/getparams.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - -Yaf_Request_Abstract::getParams -Retrieve all parameters - - - - &reftitle.description; - - public arraynullYaf_Request_Abstract::getParams - - - Retrieves all parameters from the request. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -An array of all parameters, or &null; if none are set. - - - - &reftitle.examples; - - <methodname>Yaf_Request_Abstract::getParams</methodname> example - -getRequest()->getParams()); - } -} -?>]]> - - &example.outputs.similar; - - - string(2) "17" - ["sort"]=> - string(5) "price" -} -]]> - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::setParam - Yaf_Request_Abstract::getParam - Yaf_Request_Abstract::clearParams - - - - - diff --git a/reference/yaf/yaf_request_abstract/getpost.xml b/reference/yaf/yaf_request_abstract/getpost.xml deleted file mode 100644 index 1b4a1fe94442..000000000000 --- a/reference/yaf/yaf_request_abstract/getpost.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - -Yaf_Request_Abstract::getPost -Fetch a POST parameter - - - - &reftitle.description; - - public mixedYaf_Request_Abstract::getPost - stringname - mixeddefault - - Retrieves a variable from $_POST. - - - - &reftitle.parameters; - - - name - -The variable name. If omitted, the whole array is returned. - - - - default - -The value to return if the variable is not found. - - - - - - &reftitle.returnvalues; -The POST parameter value, or default if it is not set. - - - - &reftitle.examples; - - <methodname>Yaf_Request_Abstract::getPost</methodname> example - -getRequest()->isPost()) { - $username = $this->getRequest()->getPost("username"); - $remember = $this->getRequest()->getPost("remember", "no"); - - var_dump($username, $remember); - } - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::getQuery - Yaf_Request_Abstract::getRequest - Yaf_Request_Abstract::getPost - Yaf_Request_Abstract::getCookie - Yaf_Request_Abstract::getFiles - Yaf_Request_Abstract::getParam - - - - - diff --git a/reference/yaf/yaf_request_abstract/getquery.xml b/reference/yaf/yaf_request_abstract/getquery.xml deleted file mode 100644 index 60500d6b846c..000000000000 --- a/reference/yaf/yaf_request_abstract/getquery.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - -Yaf_Request_Abstract::getQuery -Fetch a query parameter - - - - &reftitle.description; - - public mixedYaf_Request_Abstract::getQuery - stringname - mixeddefault - - Retrieves a variable from $_GET. - - - - &reftitle.parameters; - - - name - -The variable name. If omitted, the whole array is returned. - - - - default - -The value to return if the variable is not found. - - - - - - &reftitle.returnvalues; -The query parameter value, or default if it is not set. - - - - &reftitle.examples; - - <methodname>Yaf_Request_Abstract::getQuery</methodname> example - -getRequest()->getQuery("keyword"); - $page = (int) $this->getRequest()->getQuery("page", 1); - - var_dump($keyword, $page); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::getQuery - Yaf_Request_Abstract::getRequest - Yaf_Request_Abstract::getPost - Yaf_Request_Abstract::getCookie - Yaf_Request_Abstract::getFiles - Yaf_Request_Abstract::getParam - - - - - diff --git a/reference/yaf/yaf_request_abstract/getraw.xml b/reference/yaf/yaf_request_abstract/getraw.xml deleted file mode 100644 index 65c856cd7428..000000000000 --- a/reference/yaf/yaf_request_abstract/getraw.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - -Yaf_Request_Abstract::getRaw -Retrieve the raw request body - - - - &reftitle.description; - - public stringnullYaf_Request_Abstract::getRaw - - - Retrieves the raw request body. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -The raw request body as a string, or &null; on failure. - - - - &reftitle.examples; - - <methodname>Yaf_Request_Abstract::getRaw</methodname> example - -getRequest()->getRaw(); - $data = json_decode($raw, true); - - var_dump($data); - } -} -?>]]> - - &example.outputs.similar; - - - string(3) "yaf" - ["version"]=> - int(3) -} -]]> - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::getQuery - Yaf_Request_Abstract::getRequest - Yaf_Request_Abstract::getPost - Yaf_Request_Abstract::getCookie - Yaf_Request_Abstract::getFiles - Yaf_Request_Abstract::getParam - - - - - diff --git a/reference/yaf/yaf_request_abstract/getrequest.xml b/reference/yaf/yaf_request_abstract/getrequest.xml deleted file mode 100644 index 82c0716c93eb..000000000000 --- a/reference/yaf/yaf_request_abstract/getrequest.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - -Yaf_Request_Abstract::getRequest -Fetch a REQUEST variable - - - - &reftitle.description; - - public mixedYaf_Request_Abstract::getRequest - stringname - mixeddefault - - Retrieves a variable from $_REQUEST. - - - - &reftitle.parameters; - - - name - -The variable name. If omitted, the whole array is returned. - - - - default - -The value to return if the variable is not found. - - - - - - &reftitle.returnvalues; -The $_REQUEST variable value, or default if it is not set. - - - - &reftitle.examples; - - <methodname>Yaf_Request_Abstract::getRequest</methodname> example - -getRequest()->getRequest("keyword"); - $source = $this->getRequest()->getRequest("source", "web"); - - var_dump($keyword, $source); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::getQuery - Yaf_Request_Abstract::getRequest - Yaf_Request_Abstract::getPost - Yaf_Request_Abstract::getCookie - Yaf_Request_Abstract::getFiles - Yaf_Request_Abstract::getParam - - - - - diff --git a/reference/yaf/yaf_request_abstract/getrequesturi.xml b/reference/yaf/yaf_request_abstract/getrequesturi.xml deleted file mode 100644 index a8719ed31fce..000000000000 --- a/reference/yaf/yaf_request_abstract/getrequesturi.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - -Yaf_Request_Abstract::getRequestUri -Retrieve the request URI - - - - &reftitle.description; - - public stringnullYaf_Request_Abstract::getRequestUri - - - Retrieve the request URI - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -The request URI, or an empty string if not set. - - - - &reftitle.examples; - - <methodname>Yaf_Request_Abstract::getRequestUri</methodname> example - -getRequest()->getRequestUri()); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::setRequestUri - Yaf_Request_Abstract::getBaseUri - Yaf_Request_Abstract::setBaseUri - - - - - diff --git a/reference/yaf/yaf_request_abstract/getserver.xml b/reference/yaf/yaf_request_abstract/getserver.xml deleted file mode 100644 index 12c25b698145..000000000000 --- a/reference/yaf/yaf_request_abstract/getserver.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - -Yaf_Request_Abstract::getServer -Retrieve a SERVER variable - - - - &reftitle.description; - - public mixedYaf_Request_Abstract::getServer - stringname - mixeddefault - - Retrieves a SERVER variable. - - - - &reftitle.parameters; - - - name - -The variable name. - - - - default - -The value to return if the variable is not found. - - - - - - &reftitle.returnvalues; -The variable value, or default if it is not found. - - - - &reftitle.examples; - - <methodname>Yaf_Request_Abstract::getServer</methodname> example - -getRequest(); - - $host = $request->getServer("HTTP_HOST"); - $protocol = $request->getServer("SERVER_PROTOCOL", "HTTP/1.1"); - - var_dump($host, $protocol); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::getQuery - Yaf_Request_Abstract::getRequest - Yaf_Request_Abstract::getPost - Yaf_Request_Abstract::getCookie - Yaf_Request_Abstract::getFiles - Yaf_Request_Abstract::getParam - - - - - diff --git a/reference/yaf/yaf_request_abstract/iscli.xml b/reference/yaf/yaf_request_abstract/iscli.xml deleted file mode 100644 index 4f934fbef476..000000000000 --- a/reference/yaf/yaf_request_abstract/iscli.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - -Yaf_Request_Abstract::isCli -Determine if the request is a CLI request - - - - &reftitle.description; - - public boolYaf_Request_Abstract::isCli - - - Checks whether the request was sent with the CLI method. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Returns &true; if the request was made on the command line, &false; otherwise. - - - - &reftitle.examples; - - <methodname>Yaf_Request_Abstract::isCli</methodname> example - -isCli()); -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::isGet - Yaf_Request_Abstract::isPost - Yaf_Request_Abstract::isPut - Yaf_Request_Abstract::isHead - Yaf_Request_Abstract::isOptions - Yaf_Request_Abstract::isDelete - Yaf_Request_Abstract::isPatch - Yaf_Request_Abstract::isXmlHttpRequest - - - - - diff --git a/reference/yaf/yaf_request_abstract/isdelete.xml b/reference/yaf/yaf_request_abstract/isdelete.xml deleted file mode 100644 index dabb35c564ee..000000000000 --- a/reference/yaf/yaf_request_abstract/isdelete.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - -Yaf_Request_Abstract::isDelete -Determine if the request is a DELETE request - - - - &reftitle.description; - - public boolYaf_Request_Abstract::isDelete - - - Checks whether the request was sent with the DELETE method. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Returns &true; if the request method is DELETE, &false; otherwise. - - - - &reftitle.examples; - - <methodname>Yaf_Request_Abstract::isDelete</methodname> example - -getRequest()->isDelete()); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::isGet - Yaf_Request_Abstract::isPost - Yaf_Request_Abstract::isPut - Yaf_Request_Abstract::isHead - Yaf_Request_Abstract::isOptions - Yaf_Request_Abstract::isPatch - Yaf_Request_Abstract::isCli - Yaf_Request_Abstract::isXmlHttpRequest - - - - - diff --git a/reference/yaf/yaf_request_abstract/isdispatched.xml b/reference/yaf/yaf_request_abstract/isdispatched.xml deleted file mode 100644 index d66078ad9ad8..000000000000 --- a/reference/yaf/yaf_request_abstract/isdispatched.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - -Yaf_Request_Abstract::isDispatched -Determine if the request is dispatched - - - - &reftitle.description; - - public boolYaf_Request_Abstract::isDispatched - - - Determine whether the request has been dispatched. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Returns &true; if the request has been dispatched, &false; otherwise. - - - - &reftitle.examples; - - <methodname>Yaf_Request_Abstract::isDispatched</methodname> example - -getRequest()->setDispatched(); - - var_dump($this->getRequest()->isDispatched()); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Dispatcher::dispatch - Yaf_Request_Abstract::setDispatched - - - - - diff --git a/reference/yaf/yaf_request_abstract/isget.xml b/reference/yaf/yaf_request_abstract/isget.xml deleted file mode 100644 index 12da3e29a8d5..000000000000 --- a/reference/yaf/yaf_request_abstract/isget.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - -Yaf_Request_Abstract::isGet -Determine if the request is a GET request - - - - &reftitle.description; - - public boolYaf_Request_Abstract::isGet - - - Checks whether the request was sent with the GET method. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Returns &true; if the request method is GET, &false; otherwise. - - - - &reftitle.examples; - - <methodname>Yaf_Request_Abstract::isGet</methodname> example - -getRequest(); - - // Assuming the request was sent with GET /index - var_dump($request->isGet(), $request->isPost()); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::isPost - Yaf_Request_Abstract::isPut - Yaf_Request_Abstract::isHead - Yaf_Request_Abstract::isOptions - Yaf_Request_Abstract::isDelete - Yaf_Request_Abstract::isPatch - Yaf_Request_Abstract::isCli - Yaf_Request_Abstract::isXmlHttpRequest - - - - - diff --git a/reference/yaf/yaf_request_abstract/ishead.xml b/reference/yaf/yaf_request_abstract/ishead.xml deleted file mode 100644 index 012585462351..000000000000 --- a/reference/yaf/yaf_request_abstract/ishead.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - -Yaf_Request_Abstract::isHead -Determine if the request is a HEAD request - - - - &reftitle.description; - - public boolYaf_Request_Abstract::isHead - - - Checks whether the request was sent with the HEAD method. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Returns &true; if the request method is HEAD, &false; otherwise. - - - - &reftitle.examples; - - <methodname>Yaf_Request_Abstract::isHead</methodname> example - -getRequest()->isHead()) { - // Headers only, skip rendering the body - return false; - } - } -} -?>]]> - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::isGet - Yaf_Request_Abstract::isPost - Yaf_Request_Abstract::isPut - Yaf_Request_Abstract::isOptions - Yaf_Request_Abstract::isDelete - Yaf_Request_Abstract::isPatch - Yaf_Request_Abstract::isCli - Yaf_Request_Abstract::isXmlHttpRequest - - - - - diff --git a/reference/yaf/yaf_request_abstract/isoptions.xml b/reference/yaf/yaf_request_abstract/isoptions.xml deleted file mode 100644 index 6751ecb722e2..000000000000 --- a/reference/yaf/yaf_request_abstract/isoptions.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - -Yaf_Request_Abstract::isOptions -Determine if the request is a OPTIONS request - - - - &reftitle.description; - - public boolYaf_Request_Abstract::isOptions - - - Checks whether the request was sent with the OPTIONS method. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Returns &true; if the request method is OPTIONS, &false; otherwise. - - - - &reftitle.examples; - - <methodname>Yaf_Request_Abstract::isOptions</methodname> example - -getRequest()->isOptions()) { - $this->getResponse() - ->setHeader("Allow", "GET, POST, OPTIONS") - ->setBody(""); - return false; - } - } -} -?>]]> - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::isGet - Yaf_Request_Abstract::isPost - Yaf_Request_Abstract::isPut - Yaf_Request_Abstract::isHead - Yaf_Request_Abstract::isDelete - Yaf_Request_Abstract::isPatch - Yaf_Request_Abstract::isCli - Yaf_Request_Abstract::isXmlHttpRequest - - - - - diff --git a/reference/yaf/yaf_request_abstract/ispatch.xml b/reference/yaf/yaf_request_abstract/ispatch.xml deleted file mode 100644 index 3fe9a08ecbc2..000000000000 --- a/reference/yaf/yaf_request_abstract/ispatch.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - -Yaf_Request_Abstract::isPatch -Determine if the request is a PATCH request - - - - &reftitle.description; - - public boolYaf_Request_Abstract::isPatch - - - Checks whether the request was sent with the PATCH method. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Returns &true; if the request method is PATCH, &false; otherwise. - - - - &reftitle.examples; - - <methodname>Yaf_Request_Abstract::isPatch</methodname> example - -getRequest()->isPatch()); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::isGet - Yaf_Request_Abstract::isPost - Yaf_Request_Abstract::isPut - Yaf_Request_Abstract::isHead - Yaf_Request_Abstract::isOptions - Yaf_Request_Abstract::isDelete - Yaf_Request_Abstract::isCli - Yaf_Request_Abstract::isXmlHttpRequest - - - - - diff --git a/reference/yaf/yaf_request_abstract/ispost.xml b/reference/yaf/yaf_request_abstract/ispost.xml deleted file mode 100644 index 8e4748511442..000000000000 --- a/reference/yaf/yaf_request_abstract/ispost.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - -Yaf_Request_Abstract::isPost -Determine if the request is a POST request - - - - &reftitle.description; - - public boolYaf_Request_Abstract::isPost - - - Checks whether the request was sent with the POST method. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Returns &true; if the request method is POST, &false; otherwise. - - - - &reftitle.examples; - - <methodname>Yaf_Request_Abstract::isPost</methodname> example - -getRequest()->isPost()); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::isGet - Yaf_Request_Abstract::isPut - Yaf_Request_Abstract::isHead - Yaf_Request_Abstract::isOptions - Yaf_Request_Abstract::isDelete - Yaf_Request_Abstract::isPatch - Yaf_Request_Abstract::isCli - Yaf_Request_Abstract::isXmlHttpRequest - - - - - diff --git a/reference/yaf/yaf_request_abstract/isput.xml b/reference/yaf/yaf_request_abstract/isput.xml deleted file mode 100644 index a216537c395a..000000000000 --- a/reference/yaf/yaf_request_abstract/isput.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - -Yaf_Request_Abstract::isPut -Determine if the request is a PUT request - - - - &reftitle.description; - - public boolYaf_Request_Abstract::isPut - - - Checks whether the request was sent with the PUT method. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Returns &true; if the request method is PUT, &false; otherwise. - - - - &reftitle.examples; - - <methodname>Yaf_Request_Abstract::isPut</methodname> example - -getRequest()->isPut()) { - $payload = $this->getRequest()->getRaw(); - } - - var_dump($this->getRequest()->isPut()); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::isGet - Yaf_Request_Abstract::isPost - Yaf_Request_Abstract::isHead - Yaf_Request_Abstract::isOptions - Yaf_Request_Abstract::isDelete - Yaf_Request_Abstract::isPatch - Yaf_Request_Abstract::isCli - Yaf_Request_Abstract::isXmlHttpRequest - - - - - diff --git a/reference/yaf/yaf_request_abstract/isrouted.xml b/reference/yaf/yaf_request_abstract/isrouted.xml deleted file mode 100644 index 9522faff6d15..000000000000 --- a/reference/yaf/yaf_request_abstract/isrouted.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - -Yaf_Request_Abstract::isRouted -Determine if the request has been routed - - - - &reftitle.description; - - public boolYaf_Request_Abstract::isRouted - - - Determine whether the request has been routed. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Returns &true; if the request has been routed, &false; otherwise. - - - - &reftitle.examples; - - <methodname>Yaf_Request_Abstract::isRouted</methodname> example - -isRouted()) { - return false; - } - - if (0 === strpos($request->getRequestUri(), "/api/")) { - $request->setControllerName("Api") - ->setActionName("handle"); - return true; - } - - return false; - } - - public function assemble(array $info, array $query = null) {} -} -?>]]> - - - - - - &reftitle.seealso; - - Yaf_Router::route - Yaf_Request_Abstract::setRouted - - - - - diff --git a/reference/yaf/yaf_request_abstract/isxmlhttprequest.xml b/reference/yaf/yaf_request_abstract/isxmlhttprequest.xml deleted file mode 100644 index 14413a1b1dee..000000000000 --- a/reference/yaf/yaf_request_abstract/isxmlhttprequest.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - -Yaf_Request_Abstract::isXmlHttpRequest -Determine if the request is an Ajax request - - - - &reftitle.description; - - public boolYaf_Request_Abstract::isXmlHttpRequest - - - Checks whether the request is an Ajax request by inspecting the HTTP_X_REQUESTED_WITH request header. - - - Yaf_Request_Simple overrides this method and always - returns &false;, since command-line requests are never Ajax requests. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Returns &true; if the request is an Ajax request (the X-Requested-With header equals XMLHttpRequest), &false; otherwise. - - - - &reftitle.examples; - - <methodname>Yaf_Request_Abstract::isXmlHttpRequest</methodname> example - -getRequest()->isXmlHttpRequest()) { - $this->getResponse() - ->setHeader("Content-Type", "application/json") - ->setBody(json_encode(["id" => 17, "name" => "Yaf in Action"])); - return false; - } - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::isGet - Yaf_Request_Abstract::isPost - Yaf_Request_Abstract::isPut - Yaf_Request_Abstract::isHead - Yaf_Request_Abstract::isOptions - Yaf_Request_Abstract::isDelete - Yaf_Request_Abstract::isPatch - Yaf_Request_Abstract::isCli - - - - - diff --git a/reference/yaf/yaf_request_abstract/setactionname.xml b/reference/yaf/yaf_request_abstract/setactionname.xml deleted file mode 100644 index 56979ebd955c..000000000000 --- a/reference/yaf/yaf_request_abstract/setactionname.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - Yaf_Request_Abstract::setActionName - Set action name - - - - &reftitle.description; - - public Yaf_Request_AbstractnullYaf_Request_Abstract::setActionName - stringaction - boolformat_nametrue - - - set action name to request, this is usually used by custom router to set route result action name. - - - - - - &reftitle.parameters; - - - action - - - &string;, action name, it should in lower case style, like "index" or "foo_bar" - - - - - format_name - - - this is introduced in Yaf 3.2.0, by default Yaf will format the name into lower case style, - if this is set to &false; , Yaf will set the original name to request. - - - - - - - - &reftitle.returnvalues; - - Returns the request object itself on success, or &null; on failure. - - - - - &reftitle.examples; - - <methodname>Yaf_Request_Abstract::setActionName</methodname> example - -getRequestUri(), "/api")) { - $request->setControllerName("Api") - ->setActionName("orders"); - return true; - } - - return false; - } - - public function assemble(array $info, array $query = null) {} -} -?>]]> - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::setControllerName - Yaf_Request_Abstract::setModuleName - Yaf_Request_Abstract::getActionName - - - - - diff --git a/reference/yaf/yaf_request_abstract/setbaseuri.xml b/reference/yaf/yaf_request_abstract/setbaseuri.xml deleted file mode 100644 index 5b89e96d09bb..000000000000 --- a/reference/yaf/yaf_request_abstract/setbaseuri.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - Yaf_Request_Abstract::setBaseUri - Set base URI - - - - &reftitle.description; - - public Yaf_Request_AbstractfalseYaf_Request_Abstract::setBaseUri - stringuir - - - Set base URI, base URI is used when doing routing, in routing phase request - URI is used to route a request, while base URI is used to skip the - leading part(base URI) of request URI. - - That is, if comes a request with request URI a/b/c, then if you set base - URI to "a/b", only "/c" will be used in routing phase. - - - generally, you don't need to set this, Yaf will determine it automatically. - - - - - - - - &reftitle.parameters; - - - uir - - - base URI - - - - - - - - &reftitle.returnvalues; - Returns the request object itself on success, or &false; on failure. - - - - &reftitle.examples; - - <methodname>Yaf_Request_Abstract::setBaseUri</methodname> example - -setBaseUri("/myapp"); -$request->setRequestUri("/myapp/product/view"); - -var_dump($request->getBaseUri()); -var_dump($request->getRequestUri()); -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::getBaseUri - Yaf_Request_Abstract::setRequestUri - Yaf_Request_Abstract::getRequestUri - - - - - diff --git a/reference/yaf/yaf_request_abstract/setcontrollername.xml b/reference/yaf/yaf_request_abstract/setcontrollername.xml deleted file mode 100644 index 2ec75e96d7c6..000000000000 --- a/reference/yaf/yaf_request_abstract/setcontrollername.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - Yaf_Request_Abstract::setControllerName - Set controller name - - - - &reftitle.description; - - public Yaf_Request_AbstractnullYaf_Request_Abstract::setControllerName - stringcontroller - boolformat_nametrue - - - set controller name to request, this is usually used by custom router to set route result controller name. - - - - - - &reftitle.parameters; - - - controller - - - &string;, controller name, this should be in camel style, like "Index" or "Foo_Bar" - - - - - format_name - - - this is introduced in Yaf 3.2.0, by default Yaf will format the name into camel mode, - if this is set to &false; , Yaf will set the original name to request. - - - - - - - - &reftitle.returnvalues; - - Returns the request object itself on success, or &null; on failure. - - - - - &reftitle.examples; - - <methodname>Yaf_Request_Abstract::setControllerName</methodname> example - -getRequestUri(), "/api")) { - // Names are formatted to camel style by default, - // so "order_item" becomes "Order_Item" - $request->setControllerName("order_item") - ->setActionName("list"); - return true; - } - - return false; - } - - public function assemble(array $info, array $query = null) {} -} -?>]]> - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::setModuleName - Yaf_Request_Abstract::setActionName - Yaf_Request_Abstract::getControllerName - - - - - diff --git a/reference/yaf/yaf_request_abstract/setdispatched.xml b/reference/yaf/yaf_request_abstract/setdispatched.xml deleted file mode 100644 index 52959429e048..000000000000 --- a/reference/yaf/yaf_request_abstract/setdispatched.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - -Yaf_Request_Abstract::setDispatched -Mark the request as dispatched - - - - &reftitle.description; - - final public Yaf_Request_AbstractYaf_Request_Abstract::setDispatched - boolflagtrue - - Mark the request as dispatched - This is called by the dispatcher after an action is executed; it stops the dispatch loop. It can be called manually, e.g. to skip the remaining dispatch iterations. - - - - &reftitle.parameters; - - - flag - -The state to set. Defaults to &true;. - - - - - - &reftitle.returnvalues; -Returns the request object itself. - - - - &reftitle.examples; - - <methodname>Yaf_Request_Abstract::setDispatched</methodname> example - -setDispatched(); - $response->setRedirect("/account/login"); - } - } -} -?>]]> - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::isDispatched - Yaf_Dispatcher::dispatch - - - - - diff --git a/reference/yaf/yaf_request_abstract/setmodulename.xml b/reference/yaf/yaf_request_abstract/setmodulename.xml deleted file mode 100644 index 17b5c630587b..000000000000 --- a/reference/yaf/yaf_request_abstract/setmodulename.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - Yaf_Request_Abstract::setModuleName - Set module name - - - - &reftitle.description; - - public Yaf_Request_AbstractnullYaf_Request_Abstract::setModuleName - stringmodule - boolformat_nametrue - - - set module name to request, this is usually used by custom router to set route result module name. - - - - - - &reftitle.parameters; - - - module - - - &string; module name, it should be in camel style, like "Index" or "Foo_Bar" - - - - - format_name - - - this is introduced in Yaf 3.2.0, by default Yaf will format the name into camel mode, - if this is set to &false; , Yaf will set the original name to request. - - - - - - - - &reftitle.returnvalues; - - Returns the request object itself on success, or &null; on failure. - - - - - &reftitle.examples; - - <methodname>Yaf_Request_Abstract::setModuleName</methodname> example - -getRequestUri(), "/admin")) { - $request->setModuleName("Admin") - ->setControllerName("Dashboard") - ->setActionName("index"); - return true; - } - - return false; - } - - public function assemble(array $info, array $query = null) {} -} -?>]]> - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::setControllerName - Yaf_Request_Abstract::setActionName - Yaf_Request_Abstract::getModuleName - - - - - diff --git a/reference/yaf/yaf_request_abstract/setparam.xml b/reference/yaf/yaf_request_abstract/setparam.xml deleted file mode 100644 index fe16ce1b3ccf..000000000000 --- a/reference/yaf/yaf_request_abstract/setparam.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - -Yaf_Request_Abstract::setParam -Set a parameter to the request - - - - &reftitle.description; - - public Yaf_Request_AbstractboolnullYaf_Request_Abstract::setParam - mixedname - mixedvalue - - Set a parameter to the request, which can be retrieved by Yaf_Request_Abstract::getParam. - If called with a single array argument, every key/value pair is set as a parameter. - - - - &reftitle.parameters; - - - name - -The parameter name, or an array of key/value pairs. - - - - value - -The parameter value. Required unless name is an array. - - - - - - &reftitle.returnvalues; -Returns the request object itself on success, or &false; on failure. - - - - &reftitle.examples; - - <methodname>Yaf_Request_Abstract::setParam</methodname> example - -getRequest(); - - $request->setParam("referrer", "newsletter"); - $request->setParam(["source" => "email", "campaign" => "spring"]); - - var_dump($request->getParam("referrer")); - var_dump($request->getParams()); - } -} -?>]]> - - &example.outputs.similar; - - - string(10) "newsletter" - ["source"]=> - string(5) "email" - ["campaign"]=> - string(6) "spring" -} -]]> - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::getParam - Yaf_Request_Abstract::getParams - Yaf_Request_Abstract::clearParams - - - - - diff --git a/reference/yaf/yaf_request_abstract/setrequesturi.xml b/reference/yaf/yaf_request_abstract/setrequesturi.xml deleted file mode 100644 index ecf22fc185b4..000000000000 --- a/reference/yaf/yaf_request_abstract/setrequesturi.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - -Yaf_Request_Abstract::setRequestUri -Set the request URI - - - - &reftitle.description; - - public Yaf_Request_AbstractYaf_Request_Abstract::setRequestUri - stringuri - - Set the request URI, overriding the one detected from the environment. - This is useful when dispatching manually, e.g. in tests, with a URI that differs from the real one. - - - - &reftitle.parameters; - - - uri - -The request URI to set. - - - - - - &reftitle.returnvalues; -Returns the request object itself. - - - - &reftitle.examples; - - <methodname>Yaf_Request_Abstract::setRequestUri</methodname> example - -setRequestUri("/product/view/id/17"); - -var_dump($request->getRequestUri()); -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::getRequestUri - Yaf_Request_Abstract::setBaseUri - Yaf_Request_Abstract::getBaseUri - - - - - diff --git a/reference/yaf/yaf_request_abstract/setrouted.xml b/reference/yaf/yaf_request_abstract/setrouted.xml deleted file mode 100644 index c52a86e5846a..000000000000 --- a/reference/yaf/yaf_request_abstract/setrouted.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - -Yaf_Request_Abstract::setRouted -Mark the request as routed - - - - &reftitle.description; - - final public Yaf_Request_AbstractYaf_Request_Abstract::setRouted - boolflagtrue - - Mark the request as routed - This is called by the router once routing has succeeded. Calling it manually can prevent custom routers from being run afterwards. - - - - &reftitle.parameters; - - - flag - -The state to set. Defaults to &true;. - - - - - - &reftitle.returnvalues; -Returns the request object itself. - - - - &reftitle.examples; - - <methodname>Yaf_Request_Abstract::setRouted</methodname> example - -getRequestUri(), "/api/")) { - return false; - } - - $request->setControllerName("Api") - ->setActionName("handle"); - - // Prevent routers registered after this one from running - $request->setRouted(); - - return true; - } - - public function assemble(array $info, array $query = null) {} -} -?>]]> - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::isRouted - Yaf_Router::route - - - - - diff --git a/reference/yaf/yaf_request_http/construct.xml b/reference/yaf/yaf_request_http/construct.xml deleted file mode 100644 index ea12844ed490..000000000000 --- a/reference/yaf/yaf_request_http/construct.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - Yaf_Request_Http::__construct - Constructor of Yaf_Request_Http - - - - &reftitle.description; - - public Yaf_Request_Http::__construct - stringrequest_uri - stringbase_uri - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - &reftitle.examples; - - <methodname>Yaf_Request_Http::__construct</methodname> example - -getMethod()); -var_dump($request->getRequestUri()); -var_dump($request->getBaseUri()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - Yaf_Request_Simple - Yaf_Request_Abstract::getMethod - Yaf_Request_Abstract::getRequestUri - - - - - - diff --git a/reference/yaf/yaf_request_simple/construct.xml b/reference/yaf/yaf_request_simple/construct.xml deleted file mode 100644 index 9f5bad6775a9..000000000000 --- a/reference/yaf/yaf_request_simple/construct.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - Yaf_Request_Simple::__construct - Constructor of Yaf_Request_Simple - - - - &reftitle.description; - - public Yaf_Request_Simple::__construct - stringmethod - stringmodule - stringcontroller - stringaction - arrayparams - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - &reftitle.examples; - - <methodname>Yaf_Request_Simple::__construct</methodname> example - - 10) // request parameters -); - -var_dump($request->isRouted()); /* requests with MVC names are pre-routed */ -var_dump($request->getModuleName()); -var_dump($request->getControllerName()); -var_dump($request->getActionName()); -var_dump($request->getParam("id")); -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - Yaf_Request_Http - Yaf_Request_Abstract::isRouted - Yaf_Request_Abstract::getParam - - - - - - diff --git a/reference/yaf/yaf_response_abstract/appendbody.xml b/reference/yaf/yaf_response_abstract/appendbody.xml deleted file mode 100644 index 88b87a98176f..000000000000 --- a/reference/yaf/yaf_response_abstract/appendbody.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - -Yaf_Response_Abstract::appendBody -Append to the response body - - - - &reftitle.description; - - public Yaf_Response_AbstractfalsenullYaf_Response_Abstract::appendBody - stringbody - stringkey - - Append to the response body - - - - &reftitle.parameters; - - - body - -The content string. - - - - key - -the content key. If not specified, Yaf_Response_Abstract::DEFAULT_BODY will be used. - - - - - - &reftitle.returnvalues; -Returns the response object itself on success, or &false; on failure. - - - &reftitle.examples; - - <function>Yaf_Response_Abstract::appendBody</function> example - -setBody("Hello")->appendBody(" World"); - -echo $response; -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Response_Abstract::getBody - Yaf_Response_Abstract::setBody - Yaf_Response_Abstract::prependBody - Yaf_Response_Abstract::clearBody - - - - - diff --git a/reference/yaf/yaf_response_abstract/clearbody.xml b/reference/yaf/yaf_response_abstract/clearbody.xml deleted file mode 100644 index 59ad3e5a7363..000000000000 --- a/reference/yaf/yaf_response_abstract/clearbody.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - -Yaf_Response_Abstract::clearBody -Discard all existing response bodies - - - - &reftitle.description; - - public Yaf_Response_AbstractfalsenullYaf_Response_Abstract::clearBody - stringkey - - Discard all existing response bodies. - - - - &reftitle.parameters; - - - key - -The content key. If specified, only that content block is cleared; otherwise, all content blocks are cleared. - - - - - - &reftitle.returnvalues; -Returns the response object itself on success, or &null; on failure. - - - - &reftitle.examples; - - <methodname>Yaf_Response_Abstract::clearBody</methodname> example - -getResponse(); - - $response->setBody("Hello", "intro"); - $response->setBody("World"); - - $response->clearBody("intro"); // drop only the "intro" block - var_dump($response->getBody(null)); - - $response->clearBody(); // drop every body block - var_dump($response->getBody(null)); - } -} -?> -]]> - - &example.outputs.similar; - - - string(5) "World" -} -array(0) { -}]]> - - - - - - &reftitle.seealso; - - Yaf_Response_Abstract::setBody - Yaf_Response_Abstract::appendBody - Yaf_Response_Abstract::prependBody - Yaf_Response_Abstract::getBody - - - - - diff --git a/reference/yaf/yaf_response_abstract/clearheaders.xml b/reference/yaf/yaf_response_abstract/clearheaders.xml deleted file mode 100644 index 6a872ea4a620..000000000000 --- a/reference/yaf/yaf_response_abstract/clearheaders.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - -Yaf_Response_Abstract::clearHeaders -Remove all response headers - - - - &reftitle.description; - - public Yaf_Response_AbstractfalsenullYaf_Response_Abstract::clearHeaders - - - Remove all HTTP response headers that have been set. - This method is only fully implemented in the Yaf_Response_Http subclass. In the abstract class it is a stub. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Returns the response object itself on success, or &false; on failure. - - - - &reftitle.examples; - - <methodname>Yaf_Response_Abstract::clearHeaders</methodname> example - -getResponse(); - - $response->setHeader("Content-Type", "application/json"); - $response->clearHeaders(); - - var_dump($response->getHeader()); // array(0) { } - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Response_Abstract::setHeader - Yaf_Response_Abstract::getHeader - Yaf_Response_Abstract::setAllHeaders - - - - - diff --git a/reference/yaf/yaf_response_abstract/construct.xml b/reference/yaf/yaf_response_abstract/construct.xml deleted file mode 100644 index 6bb4e1f40b56..000000000000 --- a/reference/yaf/yaf_response_abstract/construct.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Yaf_Response_Abstract::__construct - Construct a response - - - - &reftitle.description; - - public Yaf_Response_Abstract::__construct - - - - Construct a response object. The constructor takes no arguments; the - concrete subclasses like Yaf_Response_Http and - Yaf_Response_Cli initialize their own defaults - (an HTTP response starts with the 200 response code, - for example). - - - - Usually a response object does not need to be constructed manually: - Yaf_Dispatcher::getResponse returns the one - created by the dispatcher. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - No value is returned. - - - - - &reftitle.examples; - - <methodname>Yaf_Response_Abstract::__construct</methodname> example - -getResponse(); - -/* constructing directly is mostly useful in tests */ -$response = new Yaf_Response_Http(); -$response->setBody("Hello World"); - -echo $response; -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Dispatcher::getResponse - Yaf_Response_Abstract::response - - - - - - diff --git a/reference/yaf/yaf_response_abstract/getbody.xml b/reference/yaf/yaf_response_abstract/getbody.xml deleted file mode 100644 index affc0a048b33..000000000000 --- a/reference/yaf/yaf_response_abstract/getbody.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - -Yaf_Response_Abstract::getBody -Retrieve a response body block - - - - &reftitle.description; - - public mixedYaf_Response_Abstract::getBody - stringkey - - Retrieve the content of a response body block. - - - - &reftitle.parameters; - - - key - -The content key. If not specified, the DEFAULT_BODY block is used; pass &null; to get all content blocks as an array. - - - - - - &reftitle.returnvalues; -The content string, or an array of all content blocks when key is &null;. Returns an empty string if the block is not set. - - - &reftitle.examples; - - <function>Yaf_Response_Abstract::getBody</function> example - -setBody("Hello")->setBody(" World", "footer"); - -var_dump($response->getBody()); -var_dump($response->getBody(Yaf_Response_Abstract::DEFAULT_BODY)); -var_dump($response->getBody("footer")); -var_dump($response->getBody(NULL)); -?>]]> - - &example.outputs.similar; - - - string(5) "Hello" - ["footer"]=> - string(6) " World" -}]]> - - - - - - &reftitle.seealso; - - Yaf_Response_Abstract::setBody - Yaf_Response_Abstract::appendBody - Yaf_Response_Abstract::prependBody - Yaf_Response_Abstract::clearBody - - - - - diff --git a/reference/yaf/yaf_response_abstract/getheader.xml b/reference/yaf/yaf_response_abstract/getheader.xml deleted file mode 100644 index 696b29d5abe1..000000000000 --- a/reference/yaf/yaf_response_abstract/getheader.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - -Yaf_Response_Abstract::getHeader -Retrieve an HTTP response header - - - - &reftitle.description; - - public stringarraynullYaf_Response_Abstract::getHeader - stringname - - Retrieve an HTTP response header. - This method is only fully implemented in the Yaf_Response_Http subclass. In the abstract class it is a stub. - - - - &reftitle.parameters; - - - name - -The header name. If omitted, all headers are returned as an array. - - - - - - &reftitle.returnvalues; -The header value as a string, or an array of all headers when the name is omitted. Returns &null; if the requested header is not set. - - - - &reftitle.examples; - - <methodname>Yaf_Response_Abstract::getHeader</methodname> example - -getResponse(); - $response->setHeader("Content-Type", "application/json"); - - var_dump($response->getHeader("Content-Type")); - var_dump($response->getHeader()); // all headers - var_dump($response->getHeader("X-Missing")); - } -} -?> -]]> - - &example.outputs.similar; - - - string(16) "application/json" -} -NULL]]> - - - - - - &reftitle.seealso; - - Yaf_Response_Abstract::setHeader - Yaf_Response_Abstract::clearHeaders - Yaf_Response_Abstract::setAllHeaders - - - - - diff --git a/reference/yaf/yaf_response_abstract/prependbody.xml b/reference/yaf/yaf_response_abstract/prependbody.xml deleted file mode 100644 index 18d308fd9b07..000000000000 --- a/reference/yaf/yaf_response_abstract/prependbody.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - -Yaf_Response_Abstract::prependBody -Prepend to the response body - - - - &reftitle.description; - - public Yaf_Response_AbstractfalsenullYaf_Response_Abstract::prependBody - stringbody - stringkey - - Prepend to the response body - - - - &reftitle.parameters; - - - body - -The content string. - - - - key - -the content key. If not specified, Yaf_Response_Abstract::DEFAULT_BODY will be used. - - - - - - &reftitle.returnvalues; -Returns the response object itself on success, or &false; on failure. - - - &reftitle.examples; - - <function>Yaf_Response_Abstract::prependBody</function> example - -setBody("World")->prependBody("Hello "); - -echo $response; -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Response_Abstract::getBody - Yaf_Response_Abstract::setBody - Yaf_Response_Abstract::appendBody - Yaf_Response_Abstract::clearBody - - - - - diff --git a/reference/yaf/yaf_response_abstract/response.xml b/reference/yaf/yaf_response_abstract/response.xml deleted file mode 100644 index c94bbf68abde..000000000000 --- a/reference/yaf/yaf_response_abstract/response.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - -Yaf_Response_Abstract::response -Send the response - - - - &reftitle.description; - - public boolnullYaf_Response_Abstract::response - - - Send the response: the headers and all body blocks, in order. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Returns &true; on success, or &null; on failure. - - - &reftitle.examples; - - <function>Yaf_Response_Abstract::response</function> example - -setBody("Hello")->setBody(" World", "footer"); - -$response->response(); -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Response_Abstract::setBody - Yaf_Response_Abstract::clearBody - - - - - diff --git a/reference/yaf/yaf_response_abstract/setallheaders.xml b/reference/yaf/yaf_response_abstract/setallheaders.xml deleted file mode 100644 index 913a60828c5b..000000000000 --- a/reference/yaf/yaf_response_abstract/setallheaders.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - -Yaf_Response_Abstract::setAllHeaders -Set all HTTP response headers - - - - &reftitle.description; - - public boolYaf_Response_Abstract::setAllHeaders - arrayheaders - - Set all HTTP response headers at once. - This method is only fully implemented in the Yaf_Response_Http subclass. In the abstract class it is a stub. - - - - &reftitle.parameters; - - - headers - -An array of header name/value pairs. Any existing header with the same name is replaced. - - - - - - &reftitle.returnvalues; -Returns &true;. - - - - &reftitle.examples; - - <methodname>Yaf_Response_Abstract::setAllHeaders</methodname> example - -getResponse()->setAllHeaders(array( - "Content-Type" => "application/json; charset=utf-8", - "Cache-Control" => "no-cache", - "X-Request-Id" => "7f3c2d91", - )); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Response_Abstract::setHeader - Yaf_Response_Abstract::getHeader - Yaf_Response_Abstract::clearHeaders - - - - - diff --git a/reference/yaf/yaf_response_abstract/setbody.xml b/reference/yaf/yaf_response_abstract/setbody.xml deleted file mode 100644 index 461dedbe2c91..000000000000 --- a/reference/yaf/yaf_response_abstract/setbody.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - -Yaf_Response_Abstract::setBody -Set content to the response - - - - &reftitle.description; - - public Yaf_Response_AbstractfalsenullYaf_Response_Abstract::setBody - stringbody - stringkey - - Set content to the response - - - - &reftitle.parameters; - - - body - -The content string. - - - - key - -the content key. If not specified, Yaf_Response_Abstract::DEFAULT_BODY will be used. - - - - - - &reftitle.returnvalues; -Returns the response object itself on success, or &false; on failure. - - - &reftitle.examples; - - <function>Yaf_Response_Abstract::setBody</function> example - -setBody("Hello")->setBody(" World", "footer"); - -print_r($response); -echo $response; -?>]]> - - &example.outputs.similar; - - Array - ( - ) - - [_body:protected] => Array - ( - [content] => Hello - [footer] => World - ) - - [_sendheader:protected] => 1 - [_response_code:protected] => 200 -) -Hello World]]> - - - - - - &reftitle.seealso; - - Yaf_Response_Abstract::getBody - Yaf_Response_Abstract::appendBody - Yaf_Response_Abstract::prependBody - Yaf_Response_Abstract::clearBody - - - - - diff --git a/reference/yaf/yaf_response_abstract/setheader.xml b/reference/yaf/yaf_response_abstract/setheader.xml deleted file mode 100644 index e89bf60db686..000000000000 --- a/reference/yaf/yaf_response_abstract/setheader.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - -Yaf_Response_Abstract::setHeader -Set an HTTP response header - - - - &reftitle.description; - - public boolYaf_Response_Abstract::setHeader - stringname - stringvalue - boolreplacefalse - intresponse_code0 - - Set an HTTP response header. - This method is only fully implemented in the Yaf_Response_Http subclass. In the abstract class it is a stub. - - - - &reftitle.parameters; - - - name - -The header name. - - - - value - -The header value. - - - - replace - -Whether to replace any existing header with the same name. If &false;, the new value is appended to the existing one, separated by a comma. Note that, although the declared default is &false;, the current implementation replaces the existing header when this parameter is omitted. - - - - response_code - -If non-zero, the HTTP response code to set on the response. - - - - - - &reftitle.returnvalues; -Returns &true; on success, or &false; on failure. - - - - &reftitle.examples; - - <methodname>Yaf_Response_Abstract::setHeader</methodname> example - -getResponse(); - - $response->setHeader("Content-Type", "application/json"); - - /* send a 401 and ask for credentials */ - $response->setHeader("WWW-Authenticate", 'Basic realm="Member Area"', true, 401); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Response_Abstract::getHeader - Yaf_Response_Abstract::clearHeaders - Yaf_Response_Abstract::setAllHeaders - - - - - diff --git a/reference/yaf/yaf_response_abstract/setredirect.xml b/reference/yaf/yaf_response_abstract/setredirect.xml deleted file mode 100644 index 2bbd5632ac7a..000000000000 --- a/reference/yaf/yaf_response_abstract/setredirect.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - -Yaf_Response_Abstract::setRedirect -Redirect to another URL - - - - &reftitle.description; - - public boolnullYaf_Response_Abstract::setRedirect - stringurl - - Redirect the client to another URL (sends a Location header). - - - - &reftitle.parameters; - - - url - -The URL to redirect to. - - - - - - &reftitle.returnvalues; -Returns &true; on success, or &null; on failure. - - - - &reftitle.examples; - - <methodname>Yaf_Response_Abstract::setRedirect</methodname> example - -has("login")) { - /* send a Location header pointing to the login page */ - $this->getResponse()->setRedirect("/account/login"); - return false; // nothing to render here - } - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Controller_Abstract::redirect - - - - - diff --git a/reference/yaf/yaf_response_abstract/tostring.xml b/reference/yaf/yaf_response_abstract/tostring.xml deleted file mode 100644 index 0a75e6809845..000000000000 --- a/reference/yaf/yaf_response_abstract/tostring.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - Yaf_Response_Abstract::__toString - Retrieve all bodys as string - - - - &reftitle.description; - - private stringYaf_Response_Abstract::__toString - - - - Returns all body blocks of the response, concatenated into a single - string in the order in which they were added. This is what is output - when a response object is used in a string context. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The response body as a string. - - - - - - &reftitle.examples; - - <methodname>Yaf_Response_Abstract::__toString</methodname> example - -setBody("Hello")->setBody(" World", "footer"); - -/* using the response in a string context renders all body blocks */ -echo $response; -var_dump((string) $response); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Response_Abstract::getBody - Yaf_Response_Abstract::setBody - Yaf_Response_Abstract::response - - - - - - diff --git a/reference/yaf/yaf_route_interface/assemble.xml b/reference/yaf/yaf_route_interface/assemble.xml deleted file mode 100644 index 182492026246..000000000000 --- a/reference/yaf/yaf_route_interface/assemble.xml +++ /dev/null @@ -1,158 +0,0 @@ - - - - - - Yaf_Route_Interface::assemble - Assemble a request - - - - &reftitle.description; - - abstract public stringYaf_Route_Interface::assemble - arrayinfo - arrayquery - - - this method returns a url according to the argument info, and append - query strings to the url according to the argument query. - - - a route should implement this method according to its own route rules, and - do a reverse progress. - - - - - &reftitle.parameters; - - - info - - - - - - - - - query - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - &reftitle.examples; - - <methodname>Yaf_Route_Interface::assemble</methodname> example - -_match = $match; - $this->_route = $route; - } - - public function route(Yaf_Request_Abstract $request): bool { - if (!preg_match($this->_match, $request->getRequestUri(), $matches)) { - return false; - } - - foreach ($this->_route as $key => $value) { - if (is_string($value) && ':' === $value[0]) { - $value = $matches[substr($value, 1)]; - } - $request->setParam($key, $value); - } - $request->setRouted(); - - return true; - } - - /* reverse the route rules back into a URL */ - public function assemble(array $info, ?array $query = null): string { - $url = "/product"; - if (isset($info[':name'])) { - $url .= "/" . $info[':name']; - } - - if (!empty($query)) { - $url .= "?" . http_build_query($query); - } - - return $url; - } -} - -$router = new Yaf_Router(); -$router->addRoute("custom", - new RewriteRoute("#^/product#", array("controller" => "product")) -); - -var_dump($router->getRoute("custom")->assemble( - array(':name' => 'book'), - array('page' => 2) -)); -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - Yaf_Route_Interface::route - Yaf_Route_Rewrite::assemble - Yaf_Route_Map::assemble - - - - - - diff --git a/reference/yaf/yaf_route_interface/route.xml b/reference/yaf/yaf_route_interface/route.xml deleted file mode 100644 index cc11950a5d32..000000000000 --- a/reference/yaf/yaf_route_interface/route.xml +++ /dev/null @@ -1,175 +0,0 @@ - - - - - - Yaf_Route_Interface::route - Route a request - - - - &reftitle.description; - - abstract public boolYaf_Route_Interface::route - Yaf_Request_Abstractrequest - - - Yaf_Route_Interface::route is the only method - that a custom route should implement. - - - since of 2.3.0, there is another method should also be implemented, - see Yaf_Route_Interface::assemble. - - - - - if this method return &true;, then the route process will be end. otherwise, - Yaf_Router will call next route in the route stack - to route request. - - - - This method would set the route result to the parameter request, by - calling Yaf_Request_Abstract::setControllerName, - Yaf_Request_Abstract::setActionName and - Yaf_Request_Abstract::setModuleName. - - - - This method should also call - Yaf_Request_Abstract::setRouted to make the - request routed at last. - - - - - - &reftitle.parameters; - - - request - - - A Yaf_Request_Abstract instance. - - - - - - - - &reftitle.returnvalues; - - - - - - - - &reftitle.examples; - - <methodname>Yaf_Route_Interface::route</methodname> example - -_prefix = $prefix; - } - - public function route(Yaf_Request_Abstract $request): bool { - $uri = $request->getRequestUri(); - if (0 !== strpos($uri, $this->_prefix)) { - /* not our business, let the router try the next route */ - return false; - } - - /* parse the URI "/api/user/list" into controller/action */ - $segments = explode("/", ltrim(substr($uri, strlen($this->_prefix)), "/")); - $controller = isset($segments[0]) ? ucfirst($segments[0]) : NULL; - $action = isset($segments[1]) ? $segments[1] : NULL; - - if (empty($controller)) { - return false; - } - - $request->setModuleName("index"); - $request->setControllerName($controller); - $request->setActionName($action); - $request->setRouted(); /* the route process ends here */ - - return true; - } - - public function assemble(array $info, ?array $query = null): string { - $uri = $this->_prefix . "/" . strtolower($info[':c']); - if (isset($info[':a'])) { - $uri .= "/" . $info[':a']; - } - - if (!empty($query)) { - $uri .= "?" . http_build_query($query); - } - - return $uri; - } -} - -/** - * register the custom route - */ -Yaf_Dispatcher::getInstance()->getRouter()->addRoute("api", new ApiRoute("/api")); -?> -]]> - - &example.outputs.similar; - - "index", - "controller" => "User", - "action" => "list", -) -]]> - - - - - - &reftitle.seealso; - - Yaf_Route_Interface::assemble - Yaf_Router::addRoute - Yaf_Request_Abstract::setRouted - - - - - - diff --git a/reference/yaf/yaf_route_map/assemble.xml b/reference/yaf/yaf_route_map/assemble.xml deleted file mode 100644 index 835a69d14ed7..000000000000 --- a/reference/yaf/yaf_route_map/assemble.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - Yaf_Route_Map::assemble - Assemble a url - - - - &reftitle.description; - - public stringYaf_Route_Map::assemble - arrayinfo - arrayquery - - - Assemble a url. - - - - - &reftitle.parameters; - - - info - - - - - - - - query - - - - - - - - - - - &reftitle.returnvalues; - - Returns &string; on success or &null; on failure. - - - - - &reftitle.errors; - - May throw Yaf_Exception_TypeError. - - - - - &reftitle.examples; - - <function>Yaf_Route_Map::assemble</function>example - -addRoute("map", $route); - -var_dump($router->getRoute('map')->assemble( - array( - ':c' => 'foo_bar' - ), - array( - 'tkey1' => 'tval1', - 'tkey2' => 'tval2' - ) - ) -); - -$route = new Yaf_Route_Map(true, '_'); -$router->addRoute("map", $route); - -var_dump($router->getRoute('map')->assemble( - array( - ':a' => 'foo_bar' - ), - array( - 'tkey1' => 'tval1', - 'tkey2' => 'tval2' - ) - ) -); -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/yaf/yaf_route_map/construct.xml b/reference/yaf/yaf_route_map/construct.xml deleted file mode 100644 index 42eed1b40052..000000000000 --- a/reference/yaf/yaf_route_map/construct.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - -Yaf_Route_Map::__construct -Construct a map route - - - - &reftitle.description; - - publicYaf_Route_Map::__construct - boolcontroller_preferfalse - stringdelimiter'' - - Construct a map route. A map route maps the whole URI to a controller name or an action name. - - - - &reftitle.parameters; - - - controller_prefer - -Whether to map the URI to a controller name. If &false;, the URI is mapped to an action name. - - - - delimiter - -The delimiter used to separate the mapped name from the request parameters in the URI. If it occurs as a path segment preceded by a slash, everything after it is parsed as request parameters instead of being part of the mapped name. If empty, no such splitting happens during routing. - - - - - - &reftitle.returnvalues; -No value is returned. - - - - &reftitle.examples; - - <classname>Yaf_Route_Map</classname> example - -getRouter()->addRoute("name", - new Yaf_Route_Map()); -?> -]]> - - &example.outputs.similar; - - "product_foo_bar", -) -]]> - - - - <classname>Yaf_Route_Map</classname> example - -getRouter()->addRoute("name", - new Yaf_Route_Map(true, "_")); -?> -]]> - - &example.outputs.similar; - - "User_List", -) - -/** - * and request parameters: - */ -array( - "foo" => "22", -) -]]> - - - - <classname>Yaf_Route_Map</classname> example - - array( - "type" => "map", // Yaf_Route_Map route - "controllerPrefer" => FALSE, - "delimiter" => "#!", - ), -); -Yaf_Dispatcher::getInstance()->getRouter()->addConfig( - new Yaf_Config_Simple($config)); -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Route_Map::route - Yaf_Route_Map::assemble - - - - - diff --git a/reference/yaf/yaf_route_map/route.xml b/reference/yaf/yaf_route_map/route.xml deleted file mode 100644 index 0866e6cadb74..000000000000 --- a/reference/yaf/yaf_route_map/route.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - -Yaf_Route_Map::route -Route a request - - - - &reftitle.description; - - public boolYaf_Route_Map::route - Yaf_Request_Abstractrequest - - Route the request by mapping the whole URI to a controller name or an action name: the path segments of the URI are joined with underscores to form the name. - When the route was constructed with the controller prefer flag on, the result is set as the controller name, otherwise as the action name. - - - - &reftitle.parameters; - - - request - -The Yaf_Request_Abstract instance to route. - - - - - - &reftitle.returnvalues; -Always returns &true;. Note that the map route claims the request even when the URI is empty, in which case no name is set. - - - - &reftitle.examples; - - <methodname>Yaf_Route_Map::route</methodname> example - -setRequestUri("/product/foo/bar"); - -$route = new Yaf_Route_Map(); -var_dump($route->route($request)); -var_dump($request->getActionName()); -?> -]]> - - &example.outputs.similar; - - - - - - <methodname>Yaf_Route_Map::route</methodname> example - -setRequestUri("/user/list/_/foo/22"); - -$route = new Yaf_Route_Map(true, "_"); -var_dump($route->route($request)); -var_dump($request->getControllerName()); -var_dump($request->getParam("foo")); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Route_Map::__construct - Yaf_Route_Map::assemble - - - - - diff --git a/reference/yaf/yaf_route_regex/assemble.xml b/reference/yaf/yaf_route_regex/assemble.xml deleted file mode 100644 index 367b48995284..000000000000 --- a/reference/yaf/yaf_route_regex/assemble.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - Yaf_Route_Regex::assemble - Assemble a url - - - - &reftitle.description; - - public stringnullYaf_Route_Regex::assemble - arrayinfo - arrayquery - - - Assemble a url. - - - - - &reftitle.parameters; - - - info - - - - - - - - query - - - - - - - - - - - &reftitle.returnvalues; - - Returns &string; on success or &null; on failure. - - - - - &reftitle.examples; - - <function>Yaf_Route_Regex::assemble</function>example - - "product", //route to product controller, - ), - array(), - array(), - '/:m/:c/:a' - ); - -$router->addRoute("regex", $route); - -var_dump($router->getRoute('regex')->assemble( - array( - ':m' => 'module', - ':c' => 'controller', - ':a' => 'action' - ), - array( - 'tkey1' => 'tval1', - 'tkey2' => - 'tval2' - ) - ) - ); -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/yaf/yaf_route_regex/construct.xml b/reference/yaf/yaf_route_regex/construct.xml deleted file mode 100644 index 64a7c68d0df4..000000000000 --- a/reference/yaf/yaf_route_regex/construct.xml +++ /dev/null @@ -1,247 +0,0 @@ - - - - - - Yaf_Route_Regex::__construct - Yaf_Route_Regex constructor - - - - &reftitle.description; - - public Yaf_Route_Regex::__construct - stringmatch - arrayroute - arraynullmap&null; - arraynullverify&null; - stringnullreverse&null; - - - Constructs a Yaf_Route_Regex route, which routes a - request URI matching a regular expression to a module, controller and action. - - - - - - &reftitle.parameters; - - - match - - - A complete regular expression pattern, used to match the request URI. - When it does not match, Yaf_Route_Regex::route - returns &false; and the router moves on to the next route. - - - - - route - - - When the pattern matches the request URI, this &array; determines the - module, controller and action to route to. - - - Each of the three entries is optional; when one is not given, the - default is used. An entry whose value starts with : - is resolved against the parameters produced by - map. - - - - - map - - - An &array; mapping capture group indexes to parameter names. Only the - captures listed here become request parameters; a numeric capture that - is not listed is discarded. - - - Named capture groups are always added under their own name and do not - need to be listed. - - - - - verify - - - Accepted and stored on the route, but not used: the current - implementation never consults it while routing. - - - - - reverse - - - A &string;, used to assemble URL, see - Yaf_Route_Regex::assemble. - - - This parameter is introduced in 2.3.0 - - - - - - - - - - &reftitle.returnvalues; - No value is returned. - - - - &reftitle.examples; - - <classname>Yaf_Route_Regex</classname> via <methodname>Yaf_Router::addRoute</methodname> - -getRouter()->addRoute( - "name", - new Yaf_Route_Regex( - "#^/product/([^/]+)/([^/]+)#", // match a URI leading "/product" - array( - 'controller' => "product", // route to the product controller - ), - array( - 1 => "name", // $request->getParam("name") holds the first capture - 2 => "id", // and $request->getParam("id") the second - ) - ) -); -?> -]]> - - - - <classname>Yaf_Route_Regex</classname> using a capture as the controller name - -getRouter()->addRoute( - "name", - new Yaf_Route_Regex( - "#^/product/([^/]+)/([^/]+)#i", // match a URI leading "/product" - array( - 'controller' => ":name", // the "name" capture (see map) becomes the controller - ), - array( - 1 => "name", // $request->getParam("name") holds the first capture - 2 => "id", // and $request->getParam("id") the second - ) - ) -); -?> -]]> - - - - <classname>Yaf_Route_Regex</classname> using a named capture group - -getRouter()->addRoute( - "name", - new Yaf_Route_Regex( - "#^/product/(?[^/]+)/([^/]+)#i", // match a URI leading "/product" - array( - 'controller' => ":name", // the "name" capture becomes the controller - ), - array( - 2 => "id", // group 1 is named, only group 2 needs a map entry - ) - ) -); -?> -]]> - - - - <classname>Yaf_Route_Regex</classname> via <methodname>Yaf_Router::addConfig</methodname> - - array( - "type" => "regex", // a Yaf_Route_Regex route - "match" => "#(.*)#", // match any request URI - "route" => array( - 'controller' => "product", // route to the product controller - 'action' => "dummy", // and to the dummy action - ), - "map" => array( - 1 => "uri", // $request->getParam("uri") holds the matched URI - ), - ), -); - -Yaf_Dispatcher::getInstance()->getRouter()->addConfig( - new Yaf_Config_Simple($config) -); -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Route_Regex::route - Yaf_Route_Regex::assemble - Yaf_Router::addRoute - Yaf_Router::addConfig - Yaf_Route_Static - Yaf_Route_Supervar - Yaf_Route_Simple - Yaf_Route_Rewrite - Yaf_Route_Map - - - - - - diff --git a/reference/yaf/yaf_route_regex/route.xml b/reference/yaf/yaf_route_regex/route.xml deleted file mode 100644 index 3c2f35965254..000000000000 --- a/reference/yaf/yaf_route_regex/route.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - -Yaf_Route_Regex::route -Route a request - - - - &reftitle.description; - - public boolYaf_Route_Regex::route - Yaf_Request_Abstractrequest - - Route the request with a regular expression: the URI is matched against the pattern given to the constructor, and the route result (the module, controller and action) is taken from the captured variables, mapped by the map parameter. - - - - &reftitle.parameters; - - - request - -The Yaf_Request_Abstract instance to route. - - - - - - &reftitle.returnvalues; -Returns &true; if the URI matches, &false; otherwise, which makes the router try the next route. - - - - &reftitle.examples; - - <methodname>Yaf_Route_Regex::route</methodname> example - - "product", // route to the product controller - ), - array( - 1 => "name", // $request->getParam("name") will be "php-book" - ) -); - -var_dump($route->route($request)); - -var_dump($request->getControllerName()); -var_dump($request->getParam("name")); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Route_Regex::__construct - Yaf_Route_Regex::match - Yaf_Route_Regex::assemble - - - - - diff --git a/reference/yaf/yaf_route_rewrite/assemble.xml b/reference/yaf/yaf_route_rewrite/assemble.xml deleted file mode 100644 index 3e4c6f491479..000000000000 --- a/reference/yaf/yaf_route_rewrite/assemble.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - Yaf_Route_Rewrite::assemble - Assemble a url - - - - &reftitle.description; - - public stringYaf_Route_Rewrite::assemble - arrayinfo - arrayquery - - - Assemble a url. - - - - - &reftitle.parameters; - - - info - - - - - - - - query - - - - - - - - - - - &reftitle.returnvalues; - - Returns &string;. - - - - - &reftitle.examples; - - <function>Yaf_Route_Rewrite::assemble</function>example - - "product", - ), - array() -); - -$router->addRoute("rewrite", $route); - -var_dump($router->getRoute('rewrite')->assemble( - array( - ':name' => 'foo', - ':id' => 'bar', - ':tmpkey1' => 'tmpval1' - ), - array( - 'tkey1' => 'tval1', - 'tkey2' => 'tval2' - ) - ) -); - -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/yaf/yaf_route_rewrite/construct.xml b/reference/yaf/yaf_route_rewrite/construct.xml deleted file mode 100644 index ce2725f8501c..000000000000 --- a/reference/yaf/yaf_route_rewrite/construct.xml +++ /dev/null @@ -1,240 +0,0 @@ - - - - - - Yaf_Route_Rewrite::__construct - Yaf_Route_Rewrite constructor - - - - &reftitle.description; - - public Yaf_Route_Rewrite::__construct - stringmatch - arrayroute - arrayverify - - - - - - - - &reftitle.parameters; - - - match - - - A pattern, will be used to match a request uri, if - it doesn't match, Yaf_Route_Rewrite will return - &false;. - - - You can use :name style to name segments matched, and use * to match - the rest of the URL segments. - - - - - route - - - When the match pattern matches the request uri, - Yaf_Route_Rewrite will use this to decide which - module/controller/action is the destination. - - - Either of module/controller/action in this array is optional, if you don't assign a - specific value, it will be routed to default. - - - - - verify - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - <classname>Yaf_Route_Rewrite</classname> example - -getRouter()->addRoute("name", - new Yaf_Route_Rewrite( - "/product/:name/:id/*", //match request uri leading "/product" - array( - 'controller' => "product", //route to product controller, - ), - ) - ); -?> -]]> - - &example.outputs.similar; - - "product", - "module" => "index", //(default) - "action" => "index", //(default) -) - -/** - * and request parameters: - */ -array( - "name" => "foo", - "id" => 22, - "foo" => bar -) -]]> - - - - <classname>Yaf_Route_Rewrite</classname> example - - array( - "type" => "rewrite", //Yaf_Route_Rewrite route - "match" => "/user-list/:id", //match only /user/list/?/ - "route" => array( - 'controller' => "user", //route to user controller, - 'action' => "list", //route to list action - ), - ), - ); - Yaf_Dispatcher::getInstance()->getRouter()->addConfig( - new Yaf_Config_Simple($config)); -?> -]]> - - &example.outputs.similar; - - "user", - "action" => "list", - "module" => "index", //(default) -) - -/** - * and request parameters: - */ -array( - "id" => 22, -) -]]> - - - - <classname>Yaf_Route_Rewrite</classname> (as of 2.3.0) example - - array( - "type" => "rewrite", - "match" => "/user-list/:a/:id", //match only /user-list/* - "route" => array( - 'controller' => "user", //route to user controller, - 'action' => ":a", //route to :a action - ), - ), - ); - Yaf_Dispatcher::getInstance()->getRouter()->addConfig( - new Yaf_Config_Simple($config)); -?> -]]> - - &example.outputs.similar; - - "user", - "action" => "list", - "module" => "index", //(default) -) - -/** - * and request parameters: - */ -array( - "id" => 22, -) -]]> - - - - - - &reftitle.seealso; - - Yaf_Router::addRoute - Yaf_Router::addConfig - Yaf_Route_Static - Yaf_Route_Supervar - Yaf_Route_Simple - Yaf_Route_Regex - Yaf_Route_Map - - - - - - diff --git a/reference/yaf/yaf_route_rewrite/route.xml b/reference/yaf/yaf_route_rewrite/route.xml deleted file mode 100644 index f8e4cdd432e3..000000000000 --- a/reference/yaf/yaf_route_rewrite/route.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - Yaf_Route_Rewrite::route - Route a request - - - - &reftitle.description; - - public boolYaf_Route_Rewrite::route - Yaf_Request_Abstractrequest - - Route the request by matching the URI against the match pattern given to the constructor. When it matches, the module, controller and action are taken from the route array, where a value starting with a colon is resolved from the matched variables. - - - - &reftitle.parameters; - - - request - - The Yaf_Request_Abstract instance to route. - - - - - - - &reftitle.returnvalues; - Returns &true; if the URI matches, &false; otherwise, which makes the router try the next route. - - - - &reftitle.examples; - - <methodname>Yaf_Route_Rewrite::route</methodname> example - - "product", // route to the product controller - ), - array() // no default values -); - -var_dump($route->route($request)); - -var_dump($request->getControllerName()); -var_dump($request->getParam("name")); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Route_Rewrite::__construct - Yaf_Route_Rewrite::match - Yaf_Route_Rewrite::assemble - - - - - diff --git a/reference/yaf/yaf_route_simple/assemble.xml b/reference/yaf/yaf_route_simple/assemble.xml deleted file mode 100644 index 6d9c973a65cc..000000000000 --- a/reference/yaf/yaf_route_simple/assemble.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - Yaf_Route_Simple::assemble - Assemble a url - - - - &reftitle.description; - - public stringYaf_Route_Simple::assemble - arrayinfo - arrayquery - - - Assemble a url. - - - - - &reftitle.parameters; - - - info - - - - - - - - query - - - - - - - - - - - &reftitle.returnvalues; - - Returns a &string;. - - - - - &reftitle.errors; - - Throws Yaf_Exception_TypeError if info - keys ':c' or ':a' are not set. - - - - - &reftitle.examples; - - <function>Yaf_Route_Simple::assemble</function>example - -addRoute("simple", $route); - -var_dump($router->getRoute('simple')->assemble( - array( - ':a' => 'yafaction', - 'tkey' => 'tval', - ':c' => 'yafcontroller', - ':m' => 'yafmodule' - ), - array( - 'tkey1' => 'tval1', - 'tkey2' => 'tval2' - ) - )); -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/yaf/yaf_route_simple/construct.xml b/reference/yaf/yaf_route_simple/construct.xml deleted file mode 100644 index c6b23631474c..000000000000 --- a/reference/yaf/yaf_route_simple/construct.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - Yaf_Route_Simple::__construct - Construct a simple route - - - - &reftitle.description; - - public Yaf_Route_Simple::__construct - stringmodule_name - stringcontroller_name - stringaction_name - - Construct a simple route. A simple route reads the module, controller and action names from the query variables named as the three arguments. For example, with the constructor arguments module, controller and action, the route matches a request like /?module=foo&controller=bar&action=list. - - - - &reftitle.parameters; - - - module_name - - The name of the query variable that carries the module name. - - - - controller_name - - The name of the query variable that carries the controller name. - - - - action_name - - The name of the query variable that carries the action name. - - - - - - - &reftitle.returnvalues; - No value is returned. - - - - &reftitle.examples; - - <methodname>Yaf_Route_Simple::__construct</methodname> example - -getRouter()->addRoute("simple", - new Yaf_Route_Simple("m", "c", "a") -); -?> -]]> - - &example.outputs.similar; - - "main", - "controller" => "product", - "action" => "detail", -) -]]> - - - - - - &reftitle.seealso; - - Yaf_Route_Simple::route - Yaf_Route_Simple::assemble - - - - - diff --git a/reference/yaf/yaf_route_simple/route.xml b/reference/yaf/yaf_route_simple/route.xml deleted file mode 100644 index c982cc233a71..000000000000 --- a/reference/yaf/yaf_route_simple/route.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - -Yaf_Route_Simple::route -Route a request - - - - &reftitle.description; - - public boolYaf_Route_Simple::route - Yaf_Request_Abstractrequest - - Route the request with query parameters: the module, controller and action names are retrieved from the query variables named as the ones given to the constructor. - - - - &reftitle.parameters; - - - request - -The Yaf_Request_Abstract instance to route. - - - - - - &reftitle.returnvalues; -Returns &true; if any of the three query variables is present, &false; otherwise, which makes the router try the next route. - - - - &reftitle.examples; - - <methodname>Yaf_Route_Simple::route</methodname> example - -route($request)); - -var_dump($request->getModuleName()); -var_dump($request->getControllerName()); -var_dump($request->getActionName()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Route_Simple::__construct - Yaf_Route_Simple::assemble - - - - - diff --git a/reference/yaf/yaf_route_static/assemble.xml b/reference/yaf/yaf_route_static/assemble.xml deleted file mode 100644 index 93d8572add35..000000000000 --- a/reference/yaf/yaf_route_static/assemble.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - Yaf_Route_Static::assemble - Assemble a url - - - - &reftitle.description; - - public stringYaf_Route_Static::assemble - arrayinfo - arrayquery - - - Assemble a url. - - - - - &reftitle.parameters; - - - info - - - - - - - - query - - - - - - - - - - - &reftitle.returnvalues; - - Returns a &string;. - - - - - &reftitle.errors; - - Throws Yaf_Exception_TypeError if info - keys ':c' and ':a' are not set. - - - - - &reftitle.examples; - - <function>Yaf_Route_Static::assemble</function>example - -addRoute("static", $route); - -var_dump($router->getRoute('static')->assemble( - array( - ':a' => 'yafaction', - 'tkey' => 'tval', - ':c' => 'yafcontroller', - ':m' => 'yafmodule' - ), - ) -); - -var_dump($router->getRoute('static')->assemble( - array( - ':a' => 'yafaction', - 'tkey' => 'tval', - ':c' => 'yafcontroller', - ':m' => 'yafmodule' - ), - array( - 'tkey1' => 'tval1', - 'tkey2' => 'tval2' - ) - ) -); - -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/yaf/yaf_route_static/match.xml b/reference/yaf/yaf_route_static/match.xml deleted file mode 100644 index d8df87809c44..000000000000 --- a/reference/yaf/yaf_route_static/match.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - -Yaf_Route_Static::match -Whether the route matches a URI - - - - &reftitle.description; - - public boolYaf_Route_Static::match - stringuri - - Determine whether the static route matches a URI. Since the static route matches any URI, this method always returns &true;. - - - - &reftitle.parameters; - - - uri - -The URI to check. - - - - - - &reftitle.returnvalues; -Always returns &true;. - - - - &reftitle.examples; - - <methodname>Yaf_Route_Static::match</methodname> example - -match("/product/detail/id/10")); -var_dump($route->match("/")); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Route_Static::route - - - - - diff --git a/reference/yaf/yaf_route_static/route.xml b/reference/yaf/yaf_route_static/route.xml deleted file mode 100644 index 628d0ab92214..000000000000 --- a/reference/yaf/yaf_route_static/route.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - -Yaf_Route_Static::route -Route a request - - - - &reftitle.description; - - public boolYaf_Route_Static::route - Yaf_Request_Abstractrequest - - Route the request according to the PATH_INFO style URI: the first path segment is treated as the module name only if it is one of the registered modules, otherwise the segments are mapped to the controller and the action in order. The remaining segments become request parameters. - For example, with no module named foo, /foo/bar/age/10 routes to the controller Foo, the action bar, with a parameter age of 10. - - - - &reftitle.parameters; - - - request - -The Yaf_Request_Abstract instance to route. - - - - - - &reftitle.returnvalues; -Always returns &true;. - - - - &reftitle.examples; - - <methodname>Yaf_Route_Static::route</methodname> example - -getRouter()->getRoute("_default"); -var_dump($route->route($request)); - -var_dump($request->getControllerName()); -var_dump($request->getActionName()); -var_dump($request->getParam("id")); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Route_Static::match - Yaf_Route_Static::assemble - - - - - diff --git a/reference/yaf/yaf_route_supervar/assemble.xml b/reference/yaf/yaf_route_supervar/assemble.xml deleted file mode 100644 index 696c1b375889..000000000000 --- a/reference/yaf/yaf_route_supervar/assemble.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - Yaf_Route_Supervar::assemble - Assemble a url - - - - &reftitle.description; - - public stringYaf_Route_Supervar::assemble - arrayinfo - arrayquery - - - Assemble a url. - - - - - &reftitle.parameters; - - - info - - - - - - - - query - - - - - - - - - - - &reftitle.returnvalues; - - Returns a &string;. - - - - - &reftitle.errors; - - Throws Yaf_Exception_TypeError if info - keys ':c' and ':a' are not set. - - - - - &reftitle.examples; - - <function>Yaf_Route_Supervar::assemble</function> example - -addRoute("supervar", $route); - -var_dump($router->getRoute('supervar')->assemble( - array( - ':a' => 'yafaction', - 'tkey' => 'tval', - ':c' => 'yafcontroller', - ':m' => 'yafmodule' - ), - array( - 'tkey1' => 'tval1', - 'tkey2' => 'tval2' - ) -)); - -try { -var_dump($router->getRoute('supervar')->assemble( - array( - ':a' => 'yafaction', - 'tkey' => 'tval', - ':m' => 'yafmodule' - ), - array( - 'tkey1' => 'tval1', - 'tkey2' => 'tval2', - 1 => array(), - ) -)); -} catch (Exception $e) { - var_dump($e->getMessage()); -} -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/yaf/yaf_route_supervar/construct.xml b/reference/yaf/yaf_route_supervar/construct.xml deleted file mode 100644 index b317c0eeb5aa..000000000000 --- a/reference/yaf/yaf_route_supervar/construct.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - -Yaf_Route_Supervar::__construct -Construct a supervar route - - - - &reftitle.description; - - publicYaf_Route_Supervar::__construct - stringsupervar_name - - Construct a supervar route. A supervar route expects a query variable to carry a PATH_INFO style URI. - - - - &reftitle.parameters; - - - supervar_name - -The name of the query variable that carries the URI. - - - - - - &reftitle.returnvalues; -No value is returned. - - - - &reftitle.examples; - - <methodname>Yaf_Route_Supervar::__construct</methodname> example - -getRouter()->addRoute("supervar", - new Yaf_Route_Supervar("_url") -); -?> -]]> - - &example.outputs.similar; - - "product", - "module" => "index", //(default) - "action" => "detail", //(default) -) - -/** - * and request parameters: - */ -array( - "id" => 10 -) -]]> - - - - - - &reftitle.seealso; - - Yaf_Route_Supervar::route - Yaf_Route_Supervar::assemble - - - - - diff --git a/reference/yaf/yaf_route_supervar/route.xml b/reference/yaf/yaf_route_supervar/route.xml deleted file mode 100644 index b6dee0f8009b..000000000000 --- a/reference/yaf/yaf_route_supervar/route.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - -Yaf_Route_Supervar::route -Route a request - - - - &reftitle.description; - - public boolYaf_Route_Supervar::route - Yaf_Request_Abstractrequest - - Route the request with a super variable: the query variable named as the one given to the constructor is expected to carry a PATH_INFO style URI, which is then parsed like Yaf_Route_Static does. - - - - &reftitle.parameters; - - - request - -The Yaf_Request_Abstract instance to route. - - - - - - &reftitle.returnvalues; -Returns &true; if the variable is present and holds a string, &false; otherwise, which makes the router try the next route. - - - - &reftitle.examples; - - <methodname>Yaf_Route_Supervar::route</methodname> example - -route($request)); - -var_dump($request->getControllerName()); -var_dump($request->getActionName()); -var_dump($request->getParam("id")); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Route_Supervar::__construct - Yaf_Route_Supervar::assemble - - - - - diff --git a/reference/yaf/yaf_router/addconfig.xml b/reference/yaf/yaf_router/addconfig.xml deleted file mode 100644 index e3706d8fb740..000000000000 --- a/reference/yaf/yaf_router/addconfig.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - Yaf_Router::addConfig - Add config-defined routes into Router - - - - &reftitle.description; - - public boolYaf_Router::addConfig - Yaf_Config_Abstractconfig - - - Add routes defined by configs into - Yaf_Router's route stack - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - An Yaf_Config_Abstract instance, which should - contains one or more valid route configs - - - - - &reftitle.examples; - - <function>application.ini</function>example - - - - - - <function>Yaf_Dispatcher::autoConfig</function>example - -getConfig(); - Yaf_Registry::set("config", $config); - } - - public function _initRoute(Yaf_Dispatcher $dispatcher) { - $router = $dispatcher->getRouter(); - /** - * we can add some pre-defined routes in application.ini - */ - $router->addConfig(Yaf_Registry::get("config")->routes); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Router::addRoute - Yaf_Route_Static - Yaf_Route_Supervar - Yaf_Route_Simple - Yaf_Route_Regex - Yaf_Route_Rewrite - Yaf_Route_Map - - - - - - diff --git a/reference/yaf/yaf_router/addroute.xml b/reference/yaf/yaf_router/addroute.xml deleted file mode 100644 index c89e23f4f156..000000000000 --- a/reference/yaf/yaf_router/addroute.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - Yaf_Router::addRoute - Add new Route into Router - - - - &reftitle.description; - - public boolYaf_Router::addRoute - stringname - Yaf_Route_Abstractroute - - - defaultly, Yaf_Router using a Yaf_Route_Static as its defualt route. you - can add new routes into router's route stack by calling this method. - - - the newer route will be called before the older(route stack), and if the newer router return - &true;, the router process will be end. otherwise, the older one will be - called. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - <function>Yaf_Dispatcher::autoRender</function>example - -getConfig(); - Yaf_Registry::set("config", $config); - } - - public function _initRoute(Yaf_Dispatcher $dispatcher) { - $router = $dispatcher->getRouter(); - /** - * we can add some pre-defined routes in application.ini - */ - $router->addConfig(Yaf_Registry::get("config")->routes); - /** - * add a Rewrite route, then for a request uri: - * http://example.com/product/list/22/foo - * will be matched by this route, and result: - * - * [module] => - * [controller] => product - * [action] => info - * [method] => GET - * [params:protected] => Array - * ( - * [id] => 22 - * [name] => foo - * ) - * - */ - $route = new Yaf_Route_Rewrite( - "/product/list/:id/:name", - array( - "controller" => "product", - "action" => "info", - ) - ); - - $router->addRoute('dummy', $route); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Router::addConfig - Yaf_Route_Static - Yaf_Route_Supervar - Yaf_Route_Simple - Yaf_Route_Regex - Yaf_Route_Rewrite - Yaf_Route_Map - - - - - - diff --git a/reference/yaf/yaf_router/construct.xml b/reference/yaf/yaf_router/construct.xml deleted file mode 100644 index 7b3dbecb3af9..000000000000 --- a/reference/yaf/yaf_router/construct.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Yaf_Router::__construct - Yaf_Router constructor - - - - &reftitle.description; - - public Yaf_Router::__construct - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - <methodname>Yaf_Router::__construct</methodname> example - - In normal usage the router is not constructed manually, it is owned by - the dispatcher: - - -getRouter(); -var_dump($router); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Dispatcher::getRouter - Yaf_Router::addRoute - - - - - - diff --git a/reference/yaf/yaf_router/getcurrentroute.xml b/reference/yaf/yaf_router/getcurrentroute.xml deleted file mode 100644 index 2d6a3adf5efa..000000000000 --- a/reference/yaf/yaf_router/getcurrentroute.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - - Yaf_Router::getCurrentRoute - Get the effective route name - - - - &reftitle.description; - - public stringYaf_Router::getCurrentRoute - - - - Get the name of the route which is effective in the route process. - - - You should call this method after the route process finished, since - before that, this method will always return &null;. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - String, the name of the effective route. - - - - - &reftitle.examples; - - Register some routes in Bootstrap - -getConfig(); - Yaf_Registry::set("config", $config); - } - - public function _initRoute(Yaf_Dispatcher $dispatcher) { - $router = $dispatcher->getRouter(); - $rewrite_route = new Yaf_Route_Rewrite( - "/product/list/:page", - array( - "controller" => "product", - "action" => "list", - ) - ); - - $regex_route = new Yaf_Route_Rewrite( - "#^/product/info/(\d+)", - array( - "controller" => "product", - "action" => "info", - ) - ); - - $router->addRoute('rewrite', $rewrite_route)->addRoute('regex', $regex_route); - } - - /** - * register plugin - */ - public function __initPlugins(Yaf_Dispatcher $dispatcher) { - $dispatcher->registerPlugin(new DummyPlugin()); - } -} -?> -]]> - - - - plugin Dummy.php (under <link - linkend="configuration.yaf.directory">application.directory</link>/plugins) - -getRouter()->getCurrentRoute()); - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Bootstrap_Abstract - Yaf_Plugin_Abstract - Yaf_Router::addRoute - - - - - - diff --git a/reference/yaf/yaf_router/getroute.xml b/reference/yaf/yaf_router/getroute.xml deleted file mode 100644 index 1207bf4c926b..000000000000 --- a/reference/yaf/yaf_router/getroute.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - Yaf_Router::getRoute - Retrieve a route by name - - - - &reftitle.description; - - public Yaf_Route_InterfaceYaf_Router::getRoute - stringname - - - Retrieve a route by name, see also - Yaf_Router::getCurrentRoute - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - &reftitle.examples; - - <methodname>Yaf_Router::getRoute</methodname> example - -getRouter(); - - $router->addRoute("rewrite", new Yaf_Route_Rewrite( - "/product/:id", - ["controller" => "product", "action" => "detail"] - )); - - /* check what was registered under a given name */ - var_dump($router->getRoute("rewrite")); - - /* an unknown name returns NULL */ - var_dump($router->getRoute("unknown")); - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Bootstrap_Abstract - Yaf_Plugin_Abstract - Yaf_Router::addRoute - Yaf_Router::getCurrentRoute - - - - - - diff --git a/reference/yaf/yaf_router/getroutes.xml b/reference/yaf/yaf_router/getroutes.xml deleted file mode 100644 index d90808895c24..000000000000 --- a/reference/yaf/yaf_router/getroutes.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - Yaf_Router::getRoutes - Retrieve registered routes - - - - &reftitle.description; - - public mixedYaf_Router::getRoutes - - - - Retrieve registered routes - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - <methodname>Yaf_Router::getRoutes</methodname> example - -getRouter(); - - $router->addRoute("rewrite", new Yaf_Route_Rewrite( - "/product/:id", - ["controller" => "product", "action" => "detail"] - )); - - /* besides the custom one, the built-in "_default" route is - also part of the route table */ - var_dump(array_keys($router->getRoutes())); - } -} -?> -]]> - - &example.outputs.similar; - - - string(8) "_default" - [1]=> - string(7) "rewrite" -} -]]> - - - - - - &reftitle.seealso; - - Yaf_Router::getRoute - Yaf_Router::addRoute - Yaf_Dispatcher::getRouter - - - - - - diff --git a/reference/yaf/yaf_router/route.xml b/reference/yaf/yaf_router/route.xml deleted file mode 100644 index e49c96113471..000000000000 --- a/reference/yaf/yaf_router/route.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - -Yaf_Router::route -Route a request - - - - &reftitle.description; - - public boolnullYaf_Router::route - Yaf_Request_Abstractrequest - - Route the request with the registered routes. - Routes are tried in reverse order of registration. The first route that claims the request wins; the request is then marked as routed (see Yaf_Request_Abstract::setRouted) and the name of the winning route is recorded, which can be retrieved via Yaf_Router::getCurrentRoute. - The default route, registered as _default, is Yaf_Route_Static unless a custom default route is configured. - - - - &reftitle.parameters; - - - request - -The Yaf_Request_Abstract instance to route. - - - - - - &reftitle.returnvalues; -Returns &true; if the request has been routed, or &false; if no route matched (e.g. a malformed URI), which makes the dispatcher stop. - - - - &reftitle.examples; - - <methodname>Yaf_Router::route</methodname> example - -getRouter(); - - $router->addRoute("rewrite", new Yaf_Route_Rewrite( - "/product/:id", - ["controller" => "product", "action" => "detail"] - )); - - /* route a hand-built request, e.g. in a unit test */ - $request = new Yaf_Request_Simple("CLI", null, "index.php", - "/product/123", null); - - if ($router->route($request)) { - var_dump($router->getCurrentRoute()); - var_dump($request->getControllerName()); - var_dump($request->getActionName()); - var_dump($request->getParam("id")); - } else { - /* no route matched */ - } - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Router::addRoute - Yaf_Router::getCurrentRoute - Yaf_Dispatcher::dispatch - - - - - diff --git a/reference/yaf/yaf_session/construct.xml b/reference/yaf/yaf_session/construct.xml deleted file mode 100644 index 1313c48ee2aa..000000000000 --- a/reference/yaf/yaf_session/construct.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - -Yaf_Session::__construct -Constructor of Yaf_Session - - - - &reftitle.description; - - privateYaf_Session::__construct - - - The constructor is private: Yaf_Session implements the singleton pattern and cannot be instantiated directly. Use Yaf_Session::getInstance to obtain the session instance. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -No value is returned. - - - - &reftitle.examples; - - <methodname>Yaf_Session::__construct</methodname> example - -start(); - -$session->set("user_id", 42); -echo $session->get("user_id"); -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Session::getInstance - Yaf_Session::start - - - - - diff --git a/reference/yaf/yaf_session/count.xml b/reference/yaf/yaf_session/count.xml deleted file mode 100644 index d399e0c9ad08..000000000000 --- a/reference/yaf/yaf_session/count.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - -Yaf_Session::count -Count session entries - - - - &reftitle.description; - - public intYaf_Session::count - - - Returns the number of entries in the session. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -The number of session entries as an integer. - - - - &reftitle.examples; - - <methodname>Yaf_Session::count</methodname> example - -start(); - -$session->set("user_id", 42); -$session->set("cart_items", 3); - -var_dump(count($session)); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Session::get - Yaf_Session::has - - - - - diff --git a/reference/yaf/yaf_session/current.xml b/reference/yaf/yaf_session/current.xml deleted file mode 100644 index e7b99b2010fb..000000000000 --- a/reference/yaf/yaf_session/current.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - -Yaf_Session::current -Get current session entry value - - - - &reftitle.description; - - public mixedYaf_Session::current - - - Returns the value of the current session entry during iteration. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -The value of the current session entry. - - - - &reftitle.examples; - - <methodname>Yaf_Session::current</methodname> example - -start(); - -$session->set("user_id", 42); -$session->set("is_vip", true); - -foreach ($session as $key => $value) { - // Yaf_Session::current() yields each value while iterating - echo "$key => "; - var_dump($value); -} -?> -]]> - - &example.outputs.similar; - - int(42) -is_vip => bool(true) -]]> - - - - - - &reftitle.seealso; - - Yaf_Session::key - Yaf_Session::next - Yaf_Session::rewind - Yaf_Session::valid - - - - - diff --git a/reference/yaf/yaf_session/del.xml b/reference/yaf/yaf_session/del.xml deleted file mode 100644 index 01e12b7033f0..000000000000 --- a/reference/yaf/yaf_session/del.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - -Yaf_Session::del -Remove a session key - - - - &reftitle.description; - - public boolYaf_Session::del - stringname - - Removes a session key and its value. - - - - &reftitle.parameters; - - - name - -The session key to remove. - - - - - - &reftitle.returnvalues; -Returns &true; on success, or &false; on failure. - - - - &reftitle.examples; - - <methodname>Yaf_Session::del</methodname> example - -start(); - - $expected = $session->get("captcha_code"); - - // one-time code: remove it right after use - $session->del("captcha_code"); - - if ($expected === null - || $this->getRequest()->getPost("code") !== $expected) { - echo "invalid captcha"; - } - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Session::get - Yaf_Session::set - Yaf_Session::has - - - - - diff --git a/reference/yaf/yaf_session/get.xml b/reference/yaf/yaf_session/get.xml deleted file mode 100644 index 90b9af4b8fbf..000000000000 --- a/reference/yaf/yaf_session/get.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - -Yaf_Session::get -Get a session value - - - - &reftitle.description; - - public mixedYaf_Session::get - stringnameNULL - - Retrieves a session value by name. If name is omitted or &null;, the entire session array is returned. - - - - &reftitle.parameters; - - - name - -The session key to retrieve, or &null; to get all session data. - - - - - - &reftitle.returnvalues; -The session value, or &null; if the key does not exist. When name is &null;, the full session array is returned. - - - - &reftitle.examples; - - <methodname>Yaf_Session::get</methodname> example - -start(); - - $userId = $session->get("user_id"); - if ($userId === null) { - return $this->redirect("/account/login"); - } - - echo "welcome back, user #", $userId; - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Session::set - Yaf_Session::has - Yaf_Session::del - - - - - diff --git a/reference/yaf/yaf_session/getinstance.xml b/reference/yaf/yaf_session/getinstance.xml deleted file mode 100644 index 61c17f6c5d2f..000000000000 --- a/reference/yaf/yaf_session/getinstance.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - -Yaf_Session::getInstance -Get the session singleton - - - - &reftitle.description; - - public static Yaf_SessionYaf_Session::getInstance - - - Returns the singleton Yaf_Session instance, creating it if necessary. The session is started automatically on first access. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -The Yaf_Session singleton instance, or &null; if the session could not be started. - - - - &reftitle.examples; - - <methodname>Yaf_Session::getInstance</methodname> example - -start(); -$session->set("user_id", 42); - -// ... later, elsewhere in the application -$same = Yaf_Session::getInstance(); - -var_dump($same === $session); -var_dump($same->get("user_id")); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Session::start - Yaf_Session::get - Yaf_Session::set - - - - - diff --git a/reference/yaf/yaf_session/has.xml b/reference/yaf/yaf_session/has.xml deleted file mode 100644 index e490fb4b9859..000000000000 --- a/reference/yaf/yaf_session/has.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - -Yaf_Session::has -Check if a session key exists - - - - &reftitle.description; - - public boolYaf_Session::has - stringname - - Checks whether a session key exists. - - - - &reftitle.parameters; - - - name - -The session key to check. - - - - - - &reftitle.returnvalues; -Returns &true; if the key exists, &false; otherwise. - - - - &reftitle.examples; - - <methodname>Yaf_Session::has</methodname> example - -start(); - - if (!$session->has("user_id")) { - $this->redirect("/account/login"); - return false; - } - - return true; - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Session::get - Yaf_Session::set - Yaf_Session::del - - - - - diff --git a/reference/yaf/yaf_session/isset.xml b/reference/yaf/yaf_session/isset.xml deleted file mode 100644 index 98783d84c121..000000000000 --- a/reference/yaf/yaf_session/isset.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - -Yaf_Session::__isset -Check if a session key exists - - - - &reftitle.description; - - public boolYaf_Session::__isset - stringname - - Checks whether a session key exists. This method is an alias of Yaf_Session::has and is called when isset() is used on a session object. - - - - &reftitle.parameters; - - - name - -The session key to check. - - - - - - &reftitle.returnvalues; -Returns &true; if the key exists, &false; otherwise. - - - - &reftitle.examples; - - <methodname>Yaf_Session::__isset</methodname> example - -start(); - -$session->user_id = 42; - -var_dump(isset($session->user_id)); -var_dump(isset($session->user_name)); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Session::has - Yaf_Session::get - - - - - diff --git a/reference/yaf/yaf_session/key.xml b/reference/yaf/yaf_session/key.xml deleted file mode 100644 index f70ba13d72f2..000000000000 --- a/reference/yaf/yaf_session/key.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - -Yaf_Session::key -Get current session entry key - - - - &reftitle.description; - - public mixedYaf_Session::key - - - Returns the key of the current session entry during iteration. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -The key of the current session entry. - - - - &reftitle.examples; - - <methodname>Yaf_Session::key</methodname> example - -start(); - -$session->set("user_id", 42); -$session->set("lang", "en"); - -for ($session->rewind(); $session->valid(); $session->next()) { - echo $session->key(), " => ", var_export($session->current(), true), PHP_EOL; -} -?> -]]> - - &example.outputs.similar; - - 42 -lang => 'en' -]]> - - - - - - &reftitle.seealso; - - Yaf_Session::current - Yaf_Session::next - Yaf_Session::rewind - Yaf_Session::valid - - - - - diff --git a/reference/yaf/yaf_session/next.xml b/reference/yaf/yaf_session/next.xml deleted file mode 100644 index db836d5b15e8..000000000000 --- a/reference/yaf/yaf_session/next.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - -Yaf_Session::next -Advance to next session entry - - - - &reftitle.description; - - public voidYaf_Session::next - - - Moves the internal iterator to the next session entry. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -No value is returned. - - - - &reftitle.examples; - - <methodname>Yaf_Session::next</methodname> example - -start(); - -$session->set("user_id", 42); -$session->set("lang", "en"); - -$session->rewind(); -echo $session->key(), PHP_EOL; - -$session->next(); -echo $session->key(), PHP_EOL; -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Session::current - Yaf_Session::key - Yaf_Session::rewind - Yaf_Session::valid - - - - - diff --git a/reference/yaf/yaf_session/offsetexists.xml b/reference/yaf/yaf_session/offsetexists.xml deleted file mode 100644 index 272be8986d6b..000000000000 --- a/reference/yaf/yaf_session/offsetexists.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - -Yaf_Session::offsetExists -Check if a session key exists (ArrayAccess) - - - - &reftitle.description; - - public boolYaf_Session::offsetExists - mixedname - - Checks whether a session key exists. This method is an alias of Yaf_Session::has and is called when isset() is used with array syntax. - - - - &reftitle.parameters; - - - name - -The session key to check. - - - - - - &reftitle.returnvalues; -Returns &true; if the key exists, &false; otherwise. - - - - &reftitle.examples; - - <methodname>Yaf_Session::offsetExists</methodname> example - -start(); - -$session["user_id"] = 42; - -var_dump(isset($session["user_id"])); -var_dump(isset($session["user_name"])); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Session::has - Yaf_Session::offsetGet - - - - - diff --git a/reference/yaf/yaf_session/offsetget.xml b/reference/yaf/yaf_session/offsetget.xml deleted file mode 100644 index 9a6b8cc1f52b..000000000000 --- a/reference/yaf/yaf_session/offsetget.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - -Yaf_Session::offsetGet -Get a session value (ArrayAccess) - - - - &reftitle.description; - - public mixedYaf_Session::offsetGet - mixedname - - Retrieves a session value by key. This method is an alias of Yaf_Session::get and is called when array syntax is used to read a session object. - - - - &reftitle.parameters; - - - name - -The session key to retrieve. - - - - - - &reftitle.returnvalues; -The session value, or &null; if the key does not exist. - - - - &reftitle.examples; - - <methodname>Yaf_Session::offsetGet</methodname> example - -start(); - - // reading with array syntax calls offsetGet() - $userId = $session["user_id"]; - if ($userId === null) { - return $this->redirect("/account/login"); - } - - echo "logged in as user #", $userId; - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Session::get - Yaf_Session::offsetSet - Yaf_Session::offsetUnset - - - - - diff --git a/reference/yaf/yaf_session/offsetset.xml b/reference/yaf/yaf_session/offsetset.xml deleted file mode 100644 index afba0f1f78db..000000000000 --- a/reference/yaf/yaf_session/offsetset.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - -Yaf_Session::offsetSet -Set a session value (ArrayAccess) - - - - &reftitle.description; - - public voidYaf_Session::offsetSet - mixedname - mixedvalue - - Sets a session value. This method is called when array syntax is used to write to a session object. - - - - &reftitle.parameters; - - - name - -The session key to set. - - - - value - -The value to store. - - - - - - &reftitle.returnvalues; -No value is returned. - - - - &reftitle.examples; - - <methodname>Yaf_Session::offsetSet</methodname> example - -start(); - - // writing with array syntax calls offsetSet() - $session["user_id"] = $user->getId(); - $session["login_time"] = time(); - - return $this->redirect("/dashboard"); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Session::set - Yaf_Session::offsetGet - Yaf_Session::offsetUnset - - - - - diff --git a/reference/yaf/yaf_session/offsetunset.xml b/reference/yaf/yaf_session/offsetunset.xml deleted file mode 100644 index e31ae852de09..000000000000 --- a/reference/yaf/yaf_session/offsetunset.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - -Yaf_Session::offsetUnset -Remove a session key (ArrayAccess) - - - - &reftitle.description; - - public voidYaf_Session::offsetUnset - mixedname - - Removes a session key and its value. This method is called when unset() is used with array syntax on a session object. - - - - &reftitle.parameters; - - - name - -The session key to remove. - - - - - - &reftitle.returnvalues; -No value is returned. - - - - &reftitle.examples; - - <methodname>Yaf_Session::offsetUnset</methodname> example - -start(); - -$session["captcha_code"] = "8X2Q"; - -// ... after verifying the captcha, drop the one-time code -unset($session["captcha_code"]); - -var_dump(isset($session["captcha_code"])); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Session::del - Yaf_Session::offsetGet - Yaf_Session::offsetSet - - - - - diff --git a/reference/yaf/yaf_session/rewind.xml b/reference/yaf/yaf_session/rewind.xml deleted file mode 100644 index 86d7988a6fdf..000000000000 --- a/reference/yaf/yaf_session/rewind.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - -Yaf_Session::rewind -Reset session iterator to first entry - - - - &reftitle.description; - - public voidYaf_Session::rewind - - - Rewinds the internal iterator to the first session entry. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -No value is returned. - - - - &reftitle.examples; - - <methodname>Yaf_Session::rewind</methodname> example - -start(); - -$session->set("user_id", 42); -$session->set("lang", "en"); - -foreach ($session as $key => $value) { - echo "$key => $value", PHP_EOL; -} - -// a new foreach implicitly calls rewind() again -foreach ($session as $key => $value) { - echo "$key => $value", PHP_EOL; -} -?> -]]> - - &example.outputs.similar; - - 42 -lang => en -user_id => 42 -lang => en -]]> - - - - - - &reftitle.seealso; - - Yaf_Session::current - Yaf_Session::key - Yaf_Session::next - Yaf_Session::valid - - - - - diff --git a/reference/yaf/yaf_session/set.xml b/reference/yaf/yaf_session/set.xml deleted file mode 100644 index 5ec443a8604e..000000000000 --- a/reference/yaf/yaf_session/set.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - -Yaf_Session::set -Set a session value - - - - &reftitle.description; - - public boolYaf_Session::set - stringname - mixedvalue - - Sets a session value. - - - - &reftitle.parameters; - - - name - -The session key to set. - - - - value - -The value to store. - - - - - - &reftitle.returnvalues; -Returns &true; on success, or &false; on failure. - - - - &reftitle.examples; - - <methodname>Yaf_Session::set</methodname> example - -start(); - - $session->set("user_id", $user->getId()); - $session->set("login_time", time()); - - return $this->redirect("/dashboard"); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Session::get - Yaf_Session::has - Yaf_Session::del - - - - - diff --git a/reference/yaf/yaf_session/start.xml b/reference/yaf/yaf_session/start.xml deleted file mode 100644 index 39f3199b3da5..000000000000 --- a/reference/yaf/yaf_session/start.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - -Yaf_Session::start -Start the session - - - - &reftitle.description; - - public Yaf_SessionYaf_Session::start - - - Starts the session if it has not been started yet. This calls PHP's native session start mechanism. Calling this method multiple times is safe. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Returns the Yaf_Session instance. - - - - &reftitle.examples; - - <methodname>Yaf_Session::start</methodname> example - -start(); - -$session->set("user_id", 42); -echo $session->get("user_id"); -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Session::getInstance - - - - - diff --git a/reference/yaf/yaf_session/unset.xml b/reference/yaf/yaf_session/unset.xml deleted file mode 100644 index 7ac0196b8336..000000000000 --- a/reference/yaf/yaf_session/unset.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - -Yaf_Session::__unset -Remove a session key - - - - &reftitle.description; - - public voidYaf_Session::__unset - stringname - - Removes a session key and its value. This method is called when unset() is used on a session object property. - - - - &reftitle.parameters; - - - name - -The session key to remove. - - - - - - &reftitle.returnvalues; -No value is returned. - - - - &reftitle.examples; - - <methodname>Yaf_Session::__unset</methodname> example - -start(); - -$session->user_id = 42; - -// ... when the user logs out -unset($session->user_id); - -var_dump(isset($session->user_id)); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Session::del - Yaf_Session::offsetUnset - - - - - diff --git a/reference/yaf/yaf_session/valid.xml b/reference/yaf/yaf_session/valid.xml deleted file mode 100644 index 92a4bd7b107a..000000000000 --- a/reference/yaf/yaf_session/valid.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - -Yaf_Session::valid -Check if current session position is valid - - - - &reftitle.description; - - public boolYaf_Session::valid - - - Checks whether the current session iterator position is valid. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -Returns &true; if the current position is valid, &false; otherwise. - - - - &reftitle.examples; - - <methodname>Yaf_Session::valid</methodname> example - -start(); - -$session->set("user_id", 42); - -$session->rewind(); -var_dump($session->valid()); - -$session->next(); -// past the last entry, the position is no longer valid -var_dump($session->valid()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Session::current - Yaf_Session::key - Yaf_Session::next - Yaf_Session::rewind - - - - - diff --git a/reference/yaf/yaf_view_interface/assign.xml b/reference/yaf/yaf_view_interface/assign.xml deleted file mode 100644 index 6e83a921c741..000000000000 --- a/reference/yaf/yaf_view_interface/assign.xml +++ /dev/null @@ -1,138 +0,0 @@ - - - - - -Yaf_View_Interface::assign -Assign a variable to the view - - - - &reftitle.description; - - abstract public boolYaf_View_Interface::assign - mixedname - mixedvalueNULL - - Assigns a variable to the view. Assigned variables are available to the template under their names. - - - - &reftitle.parameters; - - - name - -The name under which the variable becomes available to the template. - - - - value - -The value to assign. - - - - - - &reftitle.returnvalues; -The return value is defined by the concrete implementation. Yaf_View_Simple, the default view engine, returns the view instance. - - - - &reftitle.examples; - - <methodname>Yaf_View_Interface::assign</methodname> example - -tpl_dir = $template_dir; - } - - public function assign($name, $value = null) - { - $this->vars[$name] = $value; - return true; - } - - public function display($tpl, $tpl_vars = null) - { - echo $this->render($tpl, $tpl_vars); - return true; - } - - public function render($tpl, $tpl_vars = null) - { - extract($this->vars); - if ($tpl_vars !== null) { - extract($tpl_vars); - } - ob_start(); - include $this->tpl_dir . "/" . $tpl; - return ob_get_clean(); - } - - public function setScriptPath($template_dir) - { - $this->tpl_dir = $template_dir; - return $this; - } - - public function getScriptPath() - { - return $this->tpl_dir; - } -} - -/* plug the custom view engine into the dispatcher in the bootstrap */ -class Bootstrap extends Yaf_Bootstrap_Abstract -{ - public function _initView(Yaf_Dispatcher $dispatcher) - { - $dispatcher->setView(new MyView(APPLICATION_PATH . "/views")); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_View_Interface::display - Yaf_View_Interface::render - Yaf_View_Interface::setScriptPath - Yaf_View_Interface::getScriptPath - - - - - diff --git a/reference/yaf/yaf_view_interface/display.xml b/reference/yaf/yaf_view_interface/display.xml deleted file mode 100644 index 57baf2f195d5..000000000000 --- a/reference/yaf/yaf_view_interface/display.xml +++ /dev/null @@ -1,138 +0,0 @@ - - - - - -Yaf_View_Interface::display -Render and emit a template - - - - &reftitle.description; - - abstract public boolYaf_View_Interface::display - stringtpl - arraytpl_varsNULL - - Renders a template and emits the result directly to the output. - - - - &reftitle.parameters; - - - tpl - -The path to the template, relative to the template directory. - - - - tpl_vars - -Optional variables to assign for this template only; they override assigned variables with the same name. - - - - - - &reftitle.returnvalues; -Returns &true; on success, or &false; on failure. - - - - &reftitle.examples; - - <methodname>Yaf_View_Interface::display</methodname> example - -tpl_dir = $template_dir; - } - - public function assign($name, $value = null) - { - $this->vars[$name] = $value; - return true; - } - - public function display($tpl, $tpl_vars = null) - { - echo $this->render($tpl, $tpl_vars); - return true; - } - - public function render($tpl, $tpl_vars = null) - { - extract($this->vars); - if ($tpl_vars !== null) { - extract($tpl_vars); - } - ob_start(); - include $this->tpl_dir . "/" . $tpl; - return ob_get_clean(); - } - - public function setScriptPath($template_dir) - { - $this->tpl_dir = $template_dir; - return $this; - } - - public function getScriptPath() - { - return $this->tpl_dir; - } -} - -/* plug the custom view engine into the dispatcher in the bootstrap */ -class Bootstrap extends Yaf_Bootstrap_Abstract -{ - public function _initView(Yaf_Dispatcher $dispatcher) - { - $dispatcher->setView(new MyView(APPLICATION_PATH . "/views")); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_View_Interface::render - Yaf_View_Interface::assign - Yaf_View_Interface::setScriptPath - Yaf_View_Interface::getScriptPath - - - - - diff --git a/reference/yaf/yaf_view_interface/getscriptpath.xml b/reference/yaf/yaf_view_interface/getscriptpath.xml deleted file mode 100644 index 665ca773c610..000000000000 --- a/reference/yaf/yaf_view_interface/getscriptpath.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - -Yaf_View_Interface::getScriptPath -Get the template directory - - - - &reftitle.description; - - abstract public stringYaf_View_Interface::getScriptPath - - - Gets the directory in which templates are looked up. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -The template directory as a string, or &null; if it has not been set yet. - - - - &reftitle.examples; - - <methodname>Yaf_View_Interface::getScriptPath</methodname> example - -tpl_dir = $template_dir; - } - - public function assign($name, $value = null) - { - $this->vars[$name] = $value; - return true; - } - - public function display($tpl, $tpl_vars = null) - { - echo $this->render($tpl, $tpl_vars); - return true; - } - - public function render($tpl, $tpl_vars = null) - { - extract($this->vars); - if ($tpl_vars !== null) { - extract($tpl_vars); - } - ob_start(); - include $this->tpl_dir . "/" . $tpl; - return ob_get_clean(); - } - - public function setScriptPath($template_dir) - { - $this->tpl_dir = $template_dir; - return $this; - } - - public function getScriptPath() - { - return $this->tpl_dir; - } -} - -/* plug the custom view engine into the dispatcher in the bootstrap */ -class Bootstrap extends Yaf_Bootstrap_Abstract -{ - public function _initView(Yaf_Dispatcher $dispatcher) - { - $dispatcher->setView(new MyView(APPLICATION_PATH . "/views")); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_View_Interface::setScriptPath - Yaf_View_Interface::render - Yaf_View_Interface::display - - - - - diff --git a/reference/yaf/yaf_view_interface/render.xml b/reference/yaf/yaf_view_interface/render.xml deleted file mode 100644 index 0b1a387f0b49..000000000000 --- a/reference/yaf/yaf_view_interface/render.xml +++ /dev/null @@ -1,138 +0,0 @@ - - - - - -Yaf_View_Interface::render -Render a template - - - - &reftitle.description; - - abstract public stringYaf_View_Interface::render - stringtpl - arraytpl_varsNULL - - Renders a template and returns the result as a string instead of emitting it. - - - - &reftitle.parameters; - - - tpl - -The path to the template, relative to the template directory. - - - - tpl_vars - -Optional variables to assign for this template only; they override assigned variables with the same name. - - - - - - &reftitle.returnvalues; -The rendered result as a string, or &false; on failure. - - - - &reftitle.examples; - - <methodname>Yaf_View_Interface::render</methodname> example - -tpl_dir = $template_dir; - } - - public function assign($name, $value = null) - { - $this->vars[$name] = $value; - return true; - } - - public function display($tpl, $tpl_vars = null) - { - echo $this->render($tpl, $tpl_vars); - return true; - } - - public function render($tpl, $tpl_vars = null) - { - extract($this->vars); - if ($tpl_vars !== null) { - extract($tpl_vars); - } - ob_start(); - include $this->tpl_dir . "/" . $tpl; - return ob_get_clean(); - } - - public function setScriptPath($template_dir) - { - $this->tpl_dir = $template_dir; - return $this; - } - - public function getScriptPath() - { - return $this->tpl_dir; - } -} - -/* plug the custom view engine into the dispatcher in the bootstrap */ -class Bootstrap extends Yaf_Bootstrap_Abstract -{ - public function _initView(Yaf_Dispatcher $dispatcher) - { - $dispatcher->setView(new MyView(APPLICATION_PATH . "/views")); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_View_Interface::display - Yaf_View_Interface::assign - Yaf_View_Interface::setScriptPath - Yaf_View_Interface::getScriptPath - - - - - diff --git a/reference/yaf/yaf_view_interface/setscriptpath.xml b/reference/yaf/yaf_view_interface/setscriptpath.xml deleted file mode 100644 index f12c5150b2d5..000000000000 --- a/reference/yaf/yaf_view_interface/setscriptpath.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - -Yaf_View_Interface::setScriptPath -Set the template directory - - - - &reftitle.description; - - abstract public Yaf_View_InterfaceYaf_View_Interface::setScriptPath - stringtemplate_dir - - Sets the directory in which templates are looked up. - - - - &reftitle.parameters; - - - template_dir - -The directory where the template scripts are stored. - - - - - - &reftitle.returnvalues; -Returns the view instance, or &false; if template_dir is not an absolute path. - - - - &reftitle.examples; - - <methodname>Yaf_View_Interface::setScriptPath</methodname> example - -tpl_dir = $template_dir; - } - - public function assign($name, $value = null) - { - $this->vars[$name] = $value; - return true; - } - - public function display($tpl, $tpl_vars = null) - { - echo $this->render($tpl, $tpl_vars); - return true; - } - - public function render($tpl, $tpl_vars = null) - { - extract($this->vars); - if ($tpl_vars !== null) { - extract($tpl_vars); - } - ob_start(); - include $this->tpl_dir . "/" . $tpl; - return ob_get_clean(); - } - - public function setScriptPath($template_dir) - { - $this->tpl_dir = $template_dir; - return $this; - } - - public function getScriptPath() - { - return $this->tpl_dir; - } -} - -/* plug the custom view engine into the dispatcher in the bootstrap */ -class Bootstrap extends Yaf_Bootstrap_Abstract -{ - public function _initView(Yaf_Dispatcher $dispatcher) - { - $dispatcher->setView(new MyView(APPLICATION_PATH . "/views")); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_View_Interface::getScriptPath - Yaf_View_Interface::render - Yaf_View_Interface::display - - - - - diff --git a/reference/yaf/yaf_view_simple/assign.xml b/reference/yaf/yaf_view_simple/assign.xml deleted file mode 100644 index c794ac877f74..000000000000 --- a/reference/yaf/yaf_view_simple/assign.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - -Yaf_View_Simple::assign -Assign a variable to the view - - - - &reftitle.description; - - public boolYaf_View_Simple::assign - mixedname - mixedvalueNULL - - Assigns a variable to the view. Assigned variables are available to the template under their names. - When called with a single array argument, every key/value pair is assigned, with the keys becoming the variable names. - - - - &reftitle.parameters; - - - name - -The name under which the variable becomes available to the template, or an array of variables to assign. - - - - value - -The value to assign. - - - - - - &reftitle.returnvalues; -Returns &true;. - - - - &reftitle.examples; - - <methodname>Yaf_View_Simple::assign</methodname> example - -getView()->assign("foo", "bar"); - $this->_view->assign(array("key" => "value", "name" => "value")); - } -} -?> -]]> - - - - Template example - - - - <?php echo $foo; ?> - - - _tpl_vars as $name => $value) { - echo $$name; // or echo $this->_tpl_vars[$name]; - } - ?> - - -]]> - - - - - - &reftitle.seealso; - - Yaf_View_Simple::assignRef - Yaf_View_Simple::clear - Yaf_View_Simple::get - - - - - diff --git a/reference/yaf/yaf_view_simple/assignref.xml b/reference/yaf/yaf_view_simple/assignref.xml deleted file mode 100644 index 8f4b32b94da7..000000000000 --- a/reference/yaf/yaf_view_simple/assignref.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - -Yaf_View_Simple::assignRef -Alias of Yaf_View_Simple::assign - - - - &reftitle.description; - - public boolYaf_View_Simple::assignRef - stringname - mixedvalue - - Assigns a variable to the view by reference. Unlike Yaf_View_Simple::assign, the value is passed by reference, so later changes to the caller's variable become visible to the template. - - - - &reftitle.parameters; - - - name - -The name under which the variable becomes available to the template. - - - - value - -The value to assign. - - - - - - &reftitle.returnvalues; -Returns &true;. - - - - &reftitle.examples; - - <methodname>Yaf_View_Simple::assignRef</methodname> example - -getView()->assignRef("foo", $value); - - /* later changes to $value are visible in the template, - * because the variable was assigned by reference */ - $value = "changed"; - - //prevent the auto-render - Yaf_Dispatcher::getInstance()->autoRender(false); - } -} -?> -]]> - - - - Template example - - - - <?php echo $foo; ?> - - - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_View_Simple::assign - Yaf_View_Simple::clear - Yaf_View_Simple::get - - - - - diff --git a/reference/yaf/yaf_view_simple/clear.xml b/reference/yaf/yaf_view_simple/clear.xml deleted file mode 100644 index 81d1842f328e..000000000000 --- a/reference/yaf/yaf_view_simple/clear.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - -Yaf_View_Simple::clear -Remove an assigned variable - - - - &reftitle.description; - - public boolYaf_View_Simple::clear - stringnameNULL - - Removes an assigned variable from the view. - When called without an argument, all assigned variables are removed. - - - - &reftitle.parameters; - - - name - -The name of the variable to remove, or omitted/&null; to remove all assigned variables. - - - - - - &reftitle.returnvalues; -Returns &true;. - - - - &reftitle.examples; - - <methodname>Yaf_View_Simple::clear</methodname> example - -getView()->clear("foo")->clear("bar"); // clear "foo" and "bar" - $this->_view->clear(); // clear all assigned variables - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_View_Simple::assign - Yaf_View_Simple::get - - - - - diff --git a/reference/yaf/yaf_view_simple/construct.xml b/reference/yaf/yaf_view_simple/construct.xml deleted file mode 100644 index a749d8c2f857..000000000000 --- a/reference/yaf/yaf_view_simple/construct.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - -Yaf_View_Simple::__construct -Constructor of Yaf_View_Simple - - - - &reftitle.description; - - publicYaf_View_Simple::__construct - stringtemplate_dir - arrayoptionsNULL - - Yaf_View_Simple is the default and only view engine Yaf supports out of the box. An instance is created automatically by the Yaf_Dispatcher when the application starts; instantiating it directly is only needed to render templates outside of the dispatch flow. - The template_dir argument must point to an existing directory containing the view scripts; it becomes the script path of the view and can later be changed with Yaf_View_Simple::setScriptPath. - - - - &reftitle.parameters; - - - template_dir - -The directory where the template scripts are stored. - - - - options - -Optional view options as an array. Reserved for custom view engine implementations; the built-in engine accepts but does not use it. - - - - - - &reftitle.returnvalues; -No value is returned. - - - - &reftitle.examples; - - <methodname>Yaf_View_Simple::__construct</methodname> example - -assign("name", "world"); -echo $view->render("greeting.phtml"); -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_View_Simple::render - Yaf_View_Simple::display - Yaf_View_Simple::setScriptPath - - - - - diff --git a/reference/yaf/yaf_view_simple/display.xml b/reference/yaf/yaf_view_simple/display.xml deleted file mode 100644 index 898c5afb9841..000000000000 --- a/reference/yaf/yaf_view_simple/display.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - -Yaf_View_Simple::display -Render and store a template in the response - - - - &reftitle.description; - - public boolYaf_View_Simple::display - stringtpl - arrayvarsNULL - - Renders a template and appends the result to the Yaf_Response_Abstract body. - - Unlike Yaf_View_Simple::render, the result is not returned but stored in the response, and Yaf_Application sends it when the response is emitted. - - - - - &reftitle.parameters; - - - tpl - -The path to the template, relative to the template directory set by Yaf_View_Simple::setScriptPath or application.view.directory. - - - - vars - -Optional variables to assign for this template only; they override assigned variables with the same name. - - - - - - &reftitle.returnvalues; -Returns &true; on success, or &false; on failure. - - - - &reftitle.examples; - - <methodname>Yaf_View_Simple::display</methodname> example - -getView()->assign("title", "My Homepage"); - - /* render index/index.phtml and store the result - * in the response body */ - $this->getView()->display("index/index.phtml"); - - return false; // we rendered ourselves, skip auto-rendering - } -} -?> -]]> - - - - Template example - - - - <?php echo $title; ?> - - -]]> - - - - - - &reftitle.seealso; - - Yaf_View_Simple::render - Yaf_View_Simple::assign - - - - - diff --git a/reference/yaf/yaf_view_simple/eval.xml b/reference/yaf/yaf_view_simple/eval.xml deleted file mode 100644 index aa9674994d9d..000000000000 --- a/reference/yaf/yaf_view_simple/eval.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - -Yaf_View_Simple::eval -Render a template string - - - - &reftitle.description; - - public stringYaf_View_Simple::eval - stringtpl_content - arrayvarsNULL - - Renders a template given as a string and returns the result. - - Since no template file is involved, the template directory is not consulted. - - - - - &reftitle.parameters; - - - tpl_content - -The template content as a string. - - - - vars - -Optional variables to assign for this render; they override assigned variables with the same name. - - - - - - &reftitle.returnvalues; -The rendered result as a string, or &false; on failure. - - - - &reftitle.examples; - - <methodname>Yaf_View_Simple::eval</methodname> example - -"; - - /* render the template string without touching the filesystem */ - $html = $this->getView()->eval($template, array("title" => "Breaking News")); - - $this->getResponse()->setBody($html); - return false; // skip auto-rendering - } -} -?> -]]> - - &example.outputs.similar; - -Breaking News]]> - - - - - - &reftitle.seealso; - - Yaf_View_Simple::render - Yaf_View_Simple::display - - - - - diff --git a/reference/yaf/yaf_view_simple/get.xml b/reference/yaf/yaf_view_simple/get.xml deleted file mode 100644 index 9be4ce9f0801..000000000000 --- a/reference/yaf/yaf_view_simple/get.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - -Yaf_View_Simple::get -Get an assigned variable - - - - &reftitle.description; - - public mixedYaf_View_Simple::get - stringnameNULL - - Gets a variable previously assigned to the view. - When called without an argument, all assigned variables are returned. - - - - &reftitle.parameters; - - - name - -The name of the variable to retrieve, or omitted/&null; to retrieve all assigned variables. - - - - - - &reftitle.returnvalues; -The value assigned under name, or &null; if there is no variable with that name. When called without an argument, an array of all assigned variables is returned. - - - - &reftitle.examples; - - <methodname>Yaf_View_Simple::get</methodname> example - -getView(); - $view->assign("foo", "bar"); - - var_dump($view->get("foo")); - var_dump($view->get()); // all assigned variables - } -} -?> -]]> - - &example.outputs.similar; - - - string(3) "bar" -}]]> - - - - - - &reftitle.seealso; - - Yaf_View_Simple::assign - Yaf_View_Simple::clear - - - - - diff --git a/reference/yaf/yaf_view_simple/getscriptpath.xml b/reference/yaf/yaf_view_simple/getscriptpath.xml deleted file mode 100644 index fd7190331e2e..000000000000 --- a/reference/yaf/yaf_view_simple/getscriptpath.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - -Yaf_View_Simple::getScriptPath -Get the template directory - - - - &reftitle.description; - - public stringYaf_View_Simple::getScriptPath - - - Gets the directory in which templates are looked up. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; -The template directory as a string, or &null; if it has not been set yet. - - - - &reftitle.examples; - - <methodname>Yaf_View_Simple::getScriptPath</methodname> example - -getView()->getScriptPath(); - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_View_Simple::setScriptPath - - - - - diff --git a/reference/yaf/yaf_view_simple/isset.xml b/reference/yaf/yaf_view_simple/isset.xml deleted file mode 100644 index ecc0ade1c2c5..000000000000 --- a/reference/yaf/yaf_view_simple/isset.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - -Yaf_View_Simple::__isset -Check whether a variable is assigned - - - - &reftitle.description; - - public boolYaf_View_Simple::__isset - stringname - - Checks whether a variable is assigned to the view. This method is called when isset() is used on a view object. - - - - &reftitle.parameters; - - - name - -The name of the variable to check. - - - - - - &reftitle.returnvalues; -Returns &true; if a variable is assigned under name, &false; otherwise. - - - - &reftitle.examples; - - <methodname>Yaf_View_Simple::__isset</methodname> example - -getView(); - $view->assign("title", "Welcome"); - - var_dump(isset($view->title)); - var_dump(isset($view->unknown)); - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_View_Simple::assign - Yaf_View_Simple::get - Yaf_View_Simple::clear - - - - - diff --git a/reference/yaf/yaf_view_simple/render.xml b/reference/yaf/yaf_view_simple/render.xml deleted file mode 100644 index bd850e64e7ae..000000000000 --- a/reference/yaf/yaf_view_simple/render.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - -Yaf_View_Simple::render -Render a template - - - - &reftitle.description; - - public stringYaf_View_Simple::render - stringtpl - arrayvarsNULL - - Renders a template and returns the result as a string. The template is included as a plain PHP script, so any PHP code in it is executed, and assigned variables are available under their names. - - Unlike Yaf_View_Simple::display, the result is returned instead of being appended to the Yaf_Response_Abstract body. - - - - - &reftitle.parameters; - - - tpl - -The path to the template, relative to the template directory set by Yaf_View_Simple::setScriptPath or application.view.directory. - - - - vars - -Optional variables to assign for this render; they override assigned variables with the same name. - - - - - - &reftitle.returnvalues; -The rendered result as a string, or &false; on failure. - - - - &reftitle.examples; - - <methodname>Yaf_View_Simple::render</methodname> example - -getView()->render("product/detail.phtml", array( - "name" => "Yaf in Action", - "price" => "29.90", - )); - - $this->getResponse()->setBody($html); - return false; // skip auto-rendering - } -} -?> -]]> - - - - Template example - - -

    Price: EUR

    -]]> -
    - &example.outputs.similar; - -Yaf in Action -

    Price: 29.90 EUR

    ]]> -
    -
    -
    - - - &reftitle.seealso; - - Yaf_View_Simple::display - Yaf_View_Simple::eval - Yaf_View_Simple::assign - - -
    - - diff --git a/reference/yaf/yaf_view_simple/set.xml b/reference/yaf/yaf_view_simple/set.xml deleted file mode 100644 index 93264ea8ce81..000000000000 --- a/reference/yaf/yaf_view_simple/set.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - -Yaf_View_Simple::__set -Assign a variable via property write - - - - &reftitle.description; - - public voidYaf_View_Simple::__set - stringname - mixedvalue - - Assigns a variable to the view. This method is called when writing to a property of a view object, and behaves the same as Yaf_View_Simple::assign. - - - - &reftitle.parameters; - - - name - -The name under which the variable becomes available to the template. - - - - value - -The value to assign. - - - - - - &reftitle.returnvalues; -No value is returned. - - - - &reftitle.examples; - - <methodname>Yaf_View_Simple::__set</methodname> example - -getView()->foo = "bar"; // same as assign("foo", "bar"); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_View_Simple::assign - Yaf_View_Simple::get - - - - - diff --git a/reference/yaf/yaf_view_simple/setscriptpath.xml b/reference/yaf/yaf_view_simple/setscriptpath.xml deleted file mode 100644 index 40f657ee1cc7..000000000000 --- a/reference/yaf/yaf_view_simple/setscriptpath.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - -Yaf_View_Simple::setScriptPath -Set the template directory - - - - &reftitle.description; - - public Yaf_View_SimpleYaf_View_Simple::setScriptPath - stringtemplate_dir - - Sets the directory in which templates are looked up. - - - - &reftitle.parameters; - - - template_dir - -The directory where the template scripts are stored. - - - - - - &reftitle.returnvalues; -Returns the view instance, or &false; if template_dir is not an absolute path. - - - - &reftitle.examples; - - <methodname>Yaf_View_Simple::setScriptPath</methodname> example - -getView()->setScriptPath(APPLICATION_PATH . "/modules/admin/views"); - - $this->getView()->display("dashboard/index.phtml"); - - return false; // we rendered ourselves, skip auto-rendering - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_View_Simple::getScriptPath - - - - - diff --git a/reference/yaml/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/yaml/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/yaml/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/yaml/book.xml b/reference/yaml/book.xml deleted file mode 100644 index da77f301f0f1..000000000000 --- a/reference/yaml/book.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - YAML Data Serialization - Yaml - - - - &reftitle.intro; - - This extension implements the YAML Ain't - Markup Language (YAML) data serialization standard. Parsing and - emiting are handled by the LibYAML - library. - - - - - &reference.yaml.setup; - &reference.yaml.constants; - &reference.yaml.examples; - &reference.yaml.callbacks; - &reference.yaml.reference; - - - - - diff --git a/reference/yaml/callbacks.xml b/reference/yaml/callbacks.xml deleted file mode 100644 index 17dc0ffbf96d..000000000000 --- a/reference/yaml/callbacks.xml +++ /dev/null @@ -1,162 +0,0 @@ - - - - - Callbacks - -
    - Parse callbacks - - Parse callables are invoked by - yaml_parse, yaml_parse_file or - yaml_parse_url functions when a registered YAML tag is - encountered. The callback is passed the tagged entity's value, the tag, and - flags indicating the scalar entity style. The callback must return the data - that the YAML parser should emit for this entity. - - - Parse callback example - - 'tag_callback', - )); - -var_dump($result); -?> -]]> - - &example.outputs.similar; - - - string(5) "World" - [1]=> - string(14) "!example/hello" - [2]=> - int(1) -} -array(1) { - ["greeting"]=> - string(11) "Hello World" -} -]]> - - -
    - -
    - Emit callbacks - - Emit callbacks are invoked when an instance of a registered class is - emitted by yaml_emit or - yaml_emit_file. The callback is passed the object to - be emitted. The callback must return an array having two keys: - "tag" and "data". - The value associated with the "tag" key must - be a string to be used as the YAML tag in the output. The value associated - with the "data" key will be encoded as YAML - and emitted in place of the intercepted object. - - - Emit callback example - -data = $d; - } - - /** - * Yaml emit callback function, referred on yaml_emit call by class name. - * - * Expected to return an array with 2 values: - * - 'tag': custom tag for this serialization - * - 'data': value to convert to yaml (array, string, bool, number) - * - * @param object $obj Object to be emitted - * @return array Tag and surrogate data to emit - */ - public static function yamlEmit (EmitExample $obj) { - return array( - 'tag' => '!example/emit', - 'data' => $obj->data, - ); - } -} - -$emit_callbacks = array( - 'EmitExample' => array('EmitExample', 'yamlEmit') -); - -$t = new EmitExample(array('a','b','c')); -$yaml = yaml_emit( - array( - 'example' => $t, - ), - YAML_ANY_ENCODING, - YAML_ANY_BREAK, - $emit_callbacks -); -var_dump($yaml); -?> -]]> - - &example.outputs.similar; - - - - -
    - -
    - - diff --git a/reference/yaml/constants.xml b/reference/yaml/constants.xml deleted file mode 100644 index 9d48769cd492..000000000000 --- a/reference/yaml/constants.xml +++ /dev/null @@ -1,297 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - - - - Scalar entity styles usable by <function>yaml_parse</function> - callback methods. - - - YAML_ANY_SCALAR_STYLE - (int) - - - - - - - - - YAML_PLAIN_SCALAR_STYLE - (int) - - - - - - - - - YAML_SINGLE_QUOTED_SCALAR_STYLE - (int) - - - - - - - - - YAML_DOUBLE_QUOTED_SCALAR_STYLE - (int) - - - - - - - - - YAML_LITERAL_SCALAR_STYLE - (int) - - - - - - - - - YAML_FOLDED_SCALAR_STYLE - (int) - - - - - - - - - - Common tags usable by <function>yaml_parse</function> - callback methods. - - - YAML_NULL_TAG - (string) - - - - "tag:yaml.org,2002:null" - - - - - - YAML_BOOL_TAG - (string) - - - - "tag:yaml.org,2002:bool" - - - - - - YAML_STR_TAG - (string) - - - - "tag:yaml.org,2002:str" - - - - - - YAML_INT_TAG - (string) - - - - "tag:yaml.org,2002:int" - - - - - - YAML_FLOAT_TAG - (string) - - - - "tag:yaml.org,2002:float" - - - - - - YAML_TIMESTAMP_TAG - (string) - - - - "tag:yaml.org,2002:timestamp" - - - - - - YAML_SEQ_TAG - (string) - - - - "tag:yaml.org,2002:seq" - - - - - - YAML_MAP_TAG - (string) - - - - "tag:yaml.org,2002:map" - - - - - - YAML_PHP_TAG - (string) - - - - "!php/object" - - - - - - - Encoding types for <function>yaml_emit</function> - - - YAML_ANY_ENCODING - (int) - - - - Let the emitter choose an encoding. - - - - - - YAML_UTF8_ENCODING - (int) - - - - Encode as UTF8. - - - - - - YAML_UTF16LE_ENCODING - (int) - - - - Encode as UTF16LE. - - - - - - YAML_UTF16BE_ENCODING - (int) - - - - Encode as UTF16BE. - - - - - - - Linebreak types for <function>yaml_emit</function> - - - YAML_ANY_BREAK - (int) - - - - Let emitter choose linebreak character. - - - - - - YAML_CR_BREAK - (int) - - - - Use \r as break character (Mac style). - - - - - - YAML_LN_BREAK - (int) - - - - Use \n as break character (Unix style). - - - - - - YAML_CRLN_BREAK - (int) - - - - Use \r\n as break character (DOS style). - - - - - - - - - diff --git a/reference/yaml/examples.xml b/reference/yaml/examples.xml deleted file mode 100644 index e74d3b90c504..000000000000 --- a/reference/yaml/examples.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - &reftitle.examples; - - Yaml Example - - "Chris", - "family"=> "Dumars", - "address"=> array( - "lines"=> "458 Walkman Dr. - Suite #292", - "city"=> "Royal Oak", - "state"=> "MI", - "postal"=> 48046, - ), - ); -$invoice = array ( - "invoice"=> 34843, - "date"=> "2001-01-23", - "bill-to"=> $addr, - "ship-to"=> $addr, - "product"=> array( - array( - "sku"=> "BL394D", - "quantity"=> 4, - "description"=> "Basketball", - "price"=> 450, - ), - array( - "sku"=> "BL4438H", - "quantity"=> 1, - "description"=> "Super Hoop", - "price"=> 2392, - ), - ), - "tax"=> 251.42, - "total"=> 4443.52, - "comments"=> "Late afternoon is best. Backup contact is Nancy Billsmer @ 338-4338.", - ); - -// generate a YAML representation of the invoice -$yaml = yaml_emit($invoice); -var_dump($yaml); - -// convert the YAML back into a PHP variable -$parsed = yaml_parse($yaml); - -// check that roundtrip conversion produced an equivalent structure -var_dump($parsed == $invoice); -?> -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/yaml/functions/yaml-emit-file.xml b/reference/yaml/functions/yaml-emit-file.xml deleted file mode 100644 index 84cab8c84d9c..000000000000 --- a/reference/yaml/functions/yaml-emit-file.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - yaml_emit_file - Send the YAML representation of a value to a file - - - - &reftitle.description; - - boolyaml_emit_file - stringfilename - mixeddata - intencodingYAML_ANY_ENCODING - intlinebreakYAML_ANY_BREAK - arraycallbacks&null; - - - Generate a YAML representation of the provided data - in the filename. - - - - - &reftitle.parameters; - - - - filename - - - Path to the file. - - - - - data - - - The data being encoded. Can be any type except - a resource. - - - - - encoding - - - Output character encoding chosen from - YAML_ANY_ENCODING, - YAML_UTF8_ENCODING, - YAML_UTF16LE_ENCODING, - YAML_UTF16BE_ENCODING. - - - - - linebreak - - - Output linebreak style chosen from - YAML_ANY_BREAK, - YAML_CR_BREAK, - YAML_LN_BREAK, - YAML_CRLN_BREAK. - - - - - callbacks - - - Content handlers for emitting YAML nodes. Associative array - of classname => callable mappings. See - emit callbacks for more - details. - - - - - - - - - &reftitle.returnvalues; - - Returns &true; on success. - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL yaml 1.1.0 - - The callbacks parameter was added. - - - - - - - - - - &reftitle.seealso; - - - yaml_emit - yaml_parse - - - - - - - diff --git a/reference/yaml/functions/yaml-emit.xml b/reference/yaml/functions/yaml-emit.xml deleted file mode 100644 index eef9a03e882a..000000000000 --- a/reference/yaml/functions/yaml-emit.xml +++ /dev/null @@ -1,230 +0,0 @@ - - - - - - yaml_emit - Returns the YAML representation of a value - - - - &reftitle.description; - - stringyaml_emit - mixeddata - intencodingYAML_ANY_ENCODING - intlinebreakYAML_ANY_BREAK - arraycallbacks&null; - - - Generate a YAML representation of the provided data. - - - - - &reftitle.parameters; - - - - data - - - The data being encoded. Can be any type except - a resource. - - - - - encoding - - - Output character encoding chosen from - YAML_ANY_ENCODING, - YAML_UTF8_ENCODING, - YAML_UTF16LE_ENCODING, - YAML_UTF16BE_ENCODING. - - - - - linebreak - - - Output linebreak style chosen from - YAML_ANY_BREAK, - YAML_CR_BREAK, - YAML_LN_BREAK, - YAML_CRLN_BREAK. - - - - - callbacks - - - Content handlers for emitting YAML nodes. Associative array - of classname => callable mappings. See - emit callbacks for more - details. - - - - - - - - - &reftitle.returnvalues; - - Returns a YAML encoded string on success. - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL yaml 1.1.0 - - The callbacks parameter was added. - - - - - - - - - - &reftitle.examples; - - - <function>yaml_emit</function> example - - "Chris", - "family"=> "Dumars", - "address"=> array( - "lines"=> "458 Walkman Dr. - Suite #292", - "city"=> "Royal Oak", - "state"=> "MI", - "postal"=> 48046, - ), - ); -$invoice = array ( - "invoice"=> 34843, - "date"=> 980208000, - "bill-to"=> $addr, - "ship-to"=> $addr, - "product"=> array( - array( - "sku"=> "BL394D", - "quantity"=> 4, - "description"=> "Basketball", - "price"=> 450, - ), - array( - "sku"=> "BL4438H", - "quantity"=> 1, - "description"=> "Super Hoop", - "price"=> 2392, - ), - ), - "tax"=> 251.42, - "total"=> 4443.52, - "comments"=> "Late afternoon is best. Backup contact is Nancy Billsmer @ 338-4338.", - ); -var_dump(yaml_emit($invoice)); -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - yaml_emit_file - yaml_parse - - - - - - - diff --git a/reference/yaml/functions/yaml-parse-file.xml b/reference/yaml/functions/yaml-parse-file.xml deleted file mode 100644 index a4897ac8edd7..000000000000 --- a/reference/yaml/functions/yaml-parse-file.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - yaml_parse_file - Parse a YAML stream from a file - - - - &reftitle.description; - - mixedyaml_parse_file - stringfilename - intpos0 - intndocs - arraycallbacks&null; - - - Convert all or part of a YAML document stream read from a file to a PHP variable. - - - - - &reftitle.parameters; - - - - filename - - - Path to the file. - - - - - pos - - - Document to extract from stream (-1 for all - documents, 0 for first document, ...). - - - - - ndocs - - - If ndocs is provided, then it is filled with the - number of documents found in stream. - - - - - callbacks - - - Content handlers for YAML nodes. Associative array of YAML - tag => callable mappings. See - parse callbacks for more - details. - - - - - - - - - &reftitle.returnvalues; - - Returns the value encoded in filename in the appropriate - PHP type. - - - On failure, a string containing an error message is returned. - - - If pos is -1, an array - will be returned with one entry for each document found in the stream. - - - - - &reftitle.notes; - - - Processing untrusted user input with yaml_parse_file - is dangerous if the use of unserialize is enabled for - nodes using the !php/object tag. This behavior can be - disabled by using the yaml.decode_php ini setting. - - - - - - &reftitle.seealso; - - - yaml_parse - yaml_parse_url - yaml_emit - - - - - - - diff --git a/reference/yaml/functions/yaml-parse-url.xml b/reference/yaml/functions/yaml-parse-url.xml deleted file mode 100644 index 1d05f9f73bbf..000000000000 --- a/reference/yaml/functions/yaml-parse-url.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - yaml_parse_url - Parse a Yaml stream from a URL - - - - &reftitle.description; - - mixedyaml_parse_url - stringurl - intpos0 - intndocs - arraycallbacks&null; - - - Convert all or part of a YAML document stream read from a URL to a PHP variable. - - - - - &reftitle.parameters; - - - - url - - - url should be of the form "scheme://...". PHP - will search for a protocol handler (also known as a wrapper) for that - scheme. If no wrappers for that protocol are registered, PHP will emit - a notice to help you track potential problems in your script and then - continue as though filename specifies a regular file. - - - - - pos - - - Document to extract from stream (-1 for all - documents, 0 for first document, ...). - - - - - ndocs - - - If ndocs is provided, then it is filled with the - number of documents found in stream. - - - - - callbacks - - - Content handlers for YAML nodes. Associative array of YAML - tag => callable mappings. See - parse callbacks for more details. - - - - - - - - - &reftitle.returnvalues; - - Returns the value encoded in url in appropriate - PHP type&return.falseforfailure;. If pos is - -1 an array will be returned with one entry - for each document found in the stream. - - - - - &reftitle.notes; - - - Processing untrusted user input with yaml_parse_url - is dangerous if the use of unserialize is enabled for - nodes using the !php/object tag. This behavior can be - disabled by using the yaml.decode_php ini setting. - - - - - - &reftitle.seealso; - - - yaml_parse - yaml_parse_file - yaml_emit - - - - - - - diff --git a/reference/yaml/functions/yaml-parse.xml b/reference/yaml/functions/yaml-parse.xml deleted file mode 100644 index 2b50be4c679d..000000000000 --- a/reference/yaml/functions/yaml-parse.xml +++ /dev/null @@ -1,250 +0,0 @@ - - - - - - yaml_parse - Parse a YAML stream - - - - &reftitle.description; - - mixedyaml_parse - stringinput - intpos0 - intndocs - arraycallbacks&null; - - - Convert all or part of a YAML document stream to a PHP variable. - - - - - &reftitle.parameters; - - - - input - - - The string to parse as a YAML document stream. - - - - - pos - - - Document to extract from stream (-1 for all - documents, 0 for first document, ...). - - - - - ndocs - - - If ndocs is provided, then it is filled with the - number of documents found in stream. - - - - - callbacks - - - Content handlers for YAML nodes. Associative array of YAML - tag => callable mappings. See - parse callbacks for more - details. - - - - - - - - - &reftitle.returnvalues; - - Returns the value encoded in input in appropriate - PHP type&return.falseforfailure;. If pos is -1 an - array will be returned with one entry for each document found - in the stream. - - - - - &reftitle.examples; - - - <function>yaml_parse</function> example - - -]]> - - &example.outputs.similar; - - - int(34843) - ["date"]=> - string(10) "2001-01-23" - ["bill-to"]=> - &array(3) { - ["given"]=> - string(5) "Chris" - ["family"]=> - string(6) "Dumars" - ["address"]=> - array(4) { - ["lines"]=> - string(34) "458 Walkman Dr. - Suite #292" - ["city"]=> - string(9) "Royal Oak" - ["state"]=> - string(2) "MI" - ["postal"]=> - int(48046) - } - } - ["ship-to"]=> - &array(3) { - ["given"]=> - string(5) "Chris" - ["family"]=> - string(6) "Dumars" - ["address"]=> - array(4) { - ["lines"]=> - string(34) "458 Walkman Dr. - Suite #292" - ["city"]=> - string(9) "Royal Oak" - ["state"]=> - string(2) "MI" - ["postal"]=> - int(48046) - } - } - ["product"]=> - array(2) { - [0]=> - array(4) { - ["sku"]=> - string(6) "BL394D" - ["quantity"]=> - int(4) - ["description"]=> - string(10) "Basketball" - ["price"]=> - int(450) - } - [1]=> - array(4) { - ["sku"]=> - string(7) "BL4438H" - ["quantity"]=> - int(1) - ["description"]=> - string(10) "Super Hoop" - ["price"]=> - int(2392) - } - } - ["tax"]=> - float(251.42) - ["total"]=> - float(4443.52) - ["comments"]=> - string(68) "Late afternoon is best. Backup contact is Nancy Billsmer @ 338-4338." -} -]]> - - - - - - - &reftitle.notes; - - - Processing untrusted user input with yaml_parse - is dangerous if the use of unserialize is enabled for - nodes using the !php/object tag. This behavior can be - disabled by using the yaml.decode_php ini setting. - - - - - - &reftitle.seealso; - - - yaml_parse_file - yaml_parse_url - yaml_emit - - - - - - - diff --git a/reference/yaml/ini.xml b/reference/yaml/ini.xml deleted file mode 100644 index f9ee5172b9c2..000000000000 --- a/reference/yaml/ini.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - -
    - &reftitle.runtime; - &extension.runtime; - - - Yaml &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - yaml.decode_binary - 0 - INI_ALL - - - - yaml.decode_php - 0 - INI_ALL - Added in 1.2.0, before 2.0.0 the default was 1 - - - yaml.decode_timestamp - 0 - INI_ALL - - - - yaml.output_canonical - 0 - INI_ALL - - - - yaml.output_indent - 2 - INI_ALL - - - - yaml.output_width - 80 - INI_ALL - - - - -
    -
    - - &ini.descriptions.title; - - - - - - yaml.decode_binary - bool - - - - Off by default, but can be set to on to cause base64 binary encoded entities which have the explicit tag "tag:yaml.org,2002:binary" to be decoded. - - - - - - yaml.decode_php - bool - - - - Off by default, but can be set to on to cause serialized php objects which have the explicit tag "!php/object" to be unserialized. - - - - - - yaml.decode_timestamp - int - - - - Controls the decoding of both implicit and explicit "tag:yaml.org,2002:timestamp" scalars in the YAML document stream. The default setting of 0 will not apply any decoding. A setting of 1 will use strtotime to parse the timestamp value as a Unix timestamp. A setting of 2 will use date_create to parse the timestamp value as DateTime object. - - - - - - yaml.output_canonical - bool - - - - Off by default, but can be set to on to cause canonical form output. - - - - - - yaml.output_indent - int - - - - Number of spaces to indent sections. Value should be between - 1 and 10. - - - - - - yaml.output_width - int - - - - Set the preferred line width. -1 means unlimited. - - - - - -
    diff --git a/reference/yaml/reference.xml b/reference/yaml/reference.xml deleted file mode 100644 index bb2bbaee02d4..000000000000 --- a/reference/yaml/reference.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - Yaml &Functions; - - &reference.yaml.entities.functions; - - - - - diff --git a/reference/yaml/setup.xml b/reference/yaml/setup.xml deleted file mode 100644 index 00400ab304f6..000000000000 --- a/reference/yaml/setup.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - This extension requires the LibYAML C - library version 0.1.0 or higher to be installed. - -
    - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;yaml. - -
    - - - &reference.yaml.ini; - - -
    - - - diff --git a/reference/yaml/versions.xml b/reference/yaml/versions.xml deleted file mode 100644 index 056396f8a9f3..000000000000 --- a/reference/yaml/versions.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - - - - - - - - diff --git a/reference/yar/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/yar/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/yar/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/yar/book.xml b/reference/yar/book.xml deleted file mode 100644 index 9aef1a42aa73..000000000000 --- a/reference/yar/book.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - Yet Another RPC Framework - Yar - - - &reftitle.intro; - - Yar (Yet another RPC framework) is a light, concurrent RPC framework - which aims to provide a simple and easy way to do communication - between PHP applications. It can also issue multiple calls to remote - services concurrently. - - - Yar is a native PHP extension rather than a userland library. It uses - a compact binary protocol over HTTP, HTTPS or TCP and ships with three - built-in packagers (php, json - and, when built with , - msgpack), so no extra packages or proxy processes - are required. - - - The protocol is language agnostic, so services can be consumed by any - language; see The Yar Protocol for - the details. - - - - &reference.yar.protocol; - &reference.yar.setup; - &reference.yar.constants; - &reference.yar.examples; - &reference.yar.yar-server; - &reference.yar.yar-client; - &reference.yar.yar-concurrent-client; - &reference.yar.yar-server-exception; - &reference.yar.yar-server-output-exception; - &reference.yar.yar-server-packager-exception; - &reference.yar.yar-server-protocol-exception; - &reference.yar.yar-server-request-exception; - - &reference.yar.yar-client-exception; - &reference.yar.yar-client-packager-exception; - &reference.yar.yar-client-protocol-exception; - &reference.yar.yar-client-transport-exception; - - - - diff --git a/reference/yar/configure.xml b/reference/yar/configure.xml deleted file mode 100644 index 66cc871b6625..000000000000 --- a/reference/yar/configure.xml +++ /dev/null @@ -1,34 +0,0 @@ - - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;yar - - -
    - - - diff --git a/reference/yar/constants.xml b/reference/yar/constants.xml deleted file mode 100644 index 0a09192440b1..000000000000 --- a/reference/yar/constants.xml +++ /dev/null @@ -1,349 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - - - YAR_VERSION - (string) - - - - The version of the Yar extension, e.g. - "2.4.0". - - - - - - YAR_HAS_MSGPACK - (int) - - - - 1 when Yar was built with - , otherwise - 0. - - - - - - YAR_CLIENT_PROTOCOL_HTTP - (int) - - - - Identifies the HTTP protocol, exposed through the read-only - _protocol property of - Yar_Client. - - - - - - YAR_CLIENT_PROTOCOL_TCP - (int) - - - - Identifies the TCP protocol, exposed through the read-only - _protocol property of - Yar_Client. - - - - - - YAR_CLIENT_PROTOCOL_UNIX - (int) - - - - Identifies the Unix socket protocol, exposed through the read-only - _protocol property of - Yar_Client. - - - - - - YAR_OPT_PACKAGER - (int) - - - - Client option to override the - yar.packager directive - for a single client. The value must be one of - php, json or - msgpack. - - - - - - YAR_OPT_PERSISTENT - (int) - - - - Client option to enable persistent connections. When set to a - truthy value, HTTP keep-alive is used so that repeated calls to - the same server reuse the connection for the rest of the PHP - request lifecycle. - - - - - - YAR_OPT_TIMEOUT - (int) - - - - Client option to override the - yar.timeout directive, in - milliseconds. - - - - - - YAR_OPT_CONNECT_TIMEOUT - (int) - - - - Client option to override the - yar.connect_timeout - directive, in milliseconds. - - - - - - YAR_OPT_HEADER - (int) - - - - Client option to add custom HTTP headers. The value must be an - array of strings like - "X-Custom: value". Only effective with the - HTTP and HTTPS protocols. Available as of Yar 2.0.4. - - - - - - YAR_OPT_RESOLVE - (int) - - - - Client option to override hostname resolution for HTTP calls. The - value must be an array of strings in the format - HOST:PORT:ADDRESS, following the curl - CURLOPT_RESOLVE syntax. Requires libcurl - >= 7.21.3. Available as of Yar 2.1.0. - - - - - - YAR_OPT_PROXY - (int) - - - - Client option to route HTTP calls through an HTTP proxy. The value - must be a string such as 127.0.0.1:8888. - Available as of Yar 2.2.0. - - - - - - YAR_OPT_PROVIDER - (int) - - - - Client option carrying the provider identity sent with every - request. The value must be a string of at most 32 bytes, which is - passed to the server-side __auth magic method. - Available as of Yar 2.3.0. - - - - - - YAR_OPT_TOKEN - (int) - - - - Client option carrying the authentication token sent with every - request. The value must be a string of at most 32 bytes, which is - passed to the server-side __auth magic method. - Available as of Yar 2.3.0. - - - - - - YAR_PACKAGER_PHP - (string) - - - - The identifier of the php packager, - "PHP". - - - - - - YAR_PACKAGER_JSON - (string) - - - - The identifier of the json packager, - "JSON". - - - - - - YAR_PACKAGER_MSGPACK - (string) - - - - The identifier of the msgpack packager, - "MSGPACK". - - - - - - YAR_ERR_OKEY - (int) - - - - No error; the request was processed successfully. - - - - - - YAR_ERR_PACKAGER - (int) - - - - A packager error, e.g. a body that could not be unpacked. - - - - - - YAR_ERR_PROTOCOL - (int) - - - - A protocol error, e.g. a malformed Yar header. - - - - - - YAR_ERR_REQUEST - (int) - - - - A request error, e.g. a call to an undefined or non-public - method. - - - - - - YAR_ERR_OUTPUT - (int) - - - - An output error, e.g. the server could not start its output - buffer. - - - - - - YAR_ERR_TRANSPORT - (int) - - - - A transport error, e.g. a connection failure or timeout. - - - - - - YAR_ERR_EXCEPTION - (int) - - - - The remote service threw an exception while processing the - request. - - - - - - YAR_ERR_FORBIDDEN - (int) - - - - The request was rejected by the server's authentication - (see the provider and - token fields of the - Yar protocol header). - - - - - - - diff --git a/reference/yar/examples.xml b/reference/yar/examples.xml deleted file mode 100644 index 42a99ca59fe7..000000000000 --- a/reference/yar/examples.xml +++ /dev/null @@ -1,226 +0,0 @@ - - - - - &reftitle.examples; - - The examples below walk through a complete service: a server that - exposes a few arithmetic methods, a synchronous client that calls - them, a client that fans several calls out concurrently, and a - client that talks to a server over TCP. - - - - Yar Server Example - - A Yar service is just a regular PHP class wrapped by - Yar_Server. Every public method of the - object becomes an RPC endpoint; protected and private methods, as - well as methods whose names start with an underscore, stay hidden - from clients. The doc comments of the public methods are collected - and shown on the service information page. - - - RPC requests arrive as HTTP POST requests carrying a binary Yar - protocol payload, so the script is usually mapped to a URI on a - regular web server. - - -_add($a, $b); - } - - /** - * Sub - */ - public function sub($a, $b) { - return $a - $b; - } - - /** - * Mul - */ - public function mul($a, $b) { - return $a * $b; - } - - /** - * Protected methods will not be exposed - * @param integer - * @return integer - */ - protected function _add($a, $b) { - return $a + $b; - } -} - -$server = new Yar_Server(new Operator()); -$server->handle(); -?> -]]> - - - - - Access the server in browser (GET request) - - When a GET request is issued to the service URI — for instance by - opening it in a browser — Yar does not perform an RPC call but - renders an information page listing every public method of the - executor object together with its doc comment. This is controlled - by the yar.expose_info - directive; when it is off, a GET request fails instead. - - &example.outputs.similar; - - Yar Server Info - - - - - - - - Yar Client Example - - A Yar_Client is bound to a single service - address. Calling any undefined method on it is transparently turned - into a synchronous RPC call, so remote methods look and feel like - local ones; Yar_Client::call does the same - thing explicitly by name. - - - Protected methods are not exposed: calling one fails with a - Yar_Client_Exception whose code is - YAR_ERR_REQUEST. - - -add(1, 2)); - -/* call via call() */ -var_dump($client->call("add", array(3, 2))); - -/* _add cannot be called: it is not public */ -var_dump($client->_add(1, 2)); -?> -]]> - - &example.outputs.similar; - - - - - - - Yar Concurrent Client Example - - Instead of calling services one after another, - Yar_Concurrent_Client registers several calls - first and then dispatches them all at once with - Yar_Concurrent_Client::loop. The responses - are passed to the callback in the order they arrive, not in the - order the calls were registered. - - - Right after all requests have been sent, the callback is invoked - once with &null; arguments so that the caller knows no further - request is pending; the example below checks for this notification. - - - -]]> - - &example.outputs.similar; - - - - - - - Yar TCP Client Example - - Besides HTTP, Yar_Client can talk to Yar - compatible servers over TCP or Unix sockets, for example a service - implemented with the - Yar C framework, - which serves the same binary Yar protocol that the PHP server uses. - - -add(1, 2)); -?> -]]> - - - - - - diff --git a/reference/yar/image/yar.png b/reference/yar/image/yar.png deleted file mode 100644 index 8c4708e02e9c..000000000000 Binary files a/reference/yar/image/yar.png and /dev/null differ diff --git a/reference/yar/ini.xml b/reference/yar/ini.xml deleted file mode 100644 index 297fec1c0637..000000000000 --- a/reference/yar/ini.xml +++ /dev/null @@ -1,210 +0,0 @@ - - - -
    - &reftitle.runtime; - &extension.runtime; - - - Yar &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - yar.connect_timeout - 1000 - INI_ALL - - - - yar.content_type - application/octet-stream - INI_ALL - - - - yar.debug - Off - INI_ALL - - - - yar.expose_info - On - INI_PERDIR - - - - yar.packager - php - INI_PERDIR - - - - yar.ssl_verify - Off - INI_ALL - - - - yar.timeout - 5000 - INI_ALL - - - - -
    -
    - - &ini.descriptions.title; - - - - - - yar.connect_timeout - int - - - - Connect timeout in milliseconds for HTTP calls issued through - Yar_Client and - Yar_Concurrent_Client. - - - - This value is interpreted in milliseconds. Prior to Yar 1.2.1 it - was measured in seconds (the default was - 1). - - - - - - - yar.content_type - string - - - - The value of the Content-Type response header - sent by Yar_Server. Yar speaks a binary - protocol, so the default is - application/octet-stream. - - - - - - yar.debug - bool - - - - Enables debug mode. When on, Yar emits - E_WARNING messages with protocol-level - details for every request and response, prefixed with - [Debug Yar_Server] or - [Debug Yar_Client] and a timestamp. - - - - - - yar.expose_info - bool - - - - Whether Yar_Server::handle outputs the - service information page for non-POST (usually GET) requests. - When this directive is off, such requests throw a - Yar_Server_Exception instead. - - - - - - yar.packager - string - - - - The default packager used to serialize request and response - bodies. Valid values are php (PHP - serialization), json, and - msgpack (only when Yar was built with - ). - - - When Yar is built with msgpack support, the default becomes - msgpack. - - - This value can be overridden per client with the - YAR_OPT_PACKAGER option. - - - - - - yar.ssl_verify - bool - - - - Whether to verify the TLS certificate of HTTPS servers. When on, - the curl transport sets - CURLOPT_SSL_VERIFYPEER and - CURLOPT_SSL_VERIFYHOST, and requests to - servers with invalid certificates fail. Off by default for - backward compatibility. Available as of Yar 2.4.0. - - - - - - yar.timeout - int - - - - Timeout in milliseconds for RPC calls issued by - Yar_Client and - Yar_Concurrent_Client. - - - - - - -
    - - diff --git a/reference/yar/protocol.xml b/reference/yar/protocol.xml deleted file mode 100644 index 2a6ca03e8e94..000000000000 --- a/reference/yar/protocol.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - The Yar Protocol - - Yar does not rely on a schema or IDL file: everything is exchanged on - the wire as plain bytes. Any language that can read and write bytes - can speak to a Yar service, without installing any framework at all — - build one fixed-size binary header and a serialized request body, - send them to the service URI, and parse the reply. - - - A message consists of a fixed-size header of 82 bytes followed by a - body. The header is laid out exactly like the following C structure, - packed with no padding, and is written to the wire field after field - in declaration order: - - - - - - The id, magic_num, - reserved and body_len fields - are stored in network byte order (big-endian); the remaining fields - are raw bytes. - - - The body starts with an 8-byte packager identifier — - PHP, JSON or - MSGPACK, zero-padded — telling the receiver how - the remainder was encoded, followed by the serialized content itself. - - - - - The request body decodes to an array with the keys - i (the transaction id), m - (the method being called) and p (the list of - parameters). - - - - - The response body decodes to an array with the keys - i (the transaction id), s - (the status, one of the YAR_ERR_* codes), - r (the return value), o (any - output the service method produced) and e (the - error or exception, when the call failed). - - - - - Over HTTP the message is sent as the body of a POST request, with - the response arriving as the body of the reply; over TCP or Unix - sockets it is written directly on the stream. - - - Calling a Yar service without the extension - - The following self-contained script builds a valid Yar request for - the php packager with nothing but standard - sockets, sends it to a service URI, and prints the decoded - response. Running it against the - Operator service from the - examples prints - int(3). - - - 1, "m" => "add", "p" => array(1, 2))); -$body = str_pad("PHP", 8, "\0") . $serialized; - -/* 2. the header: 82 bytes, multi-byte integers in network byte order */ -$header = pack("N", 1) /* id */ - . pack("v", 0) /* version */ - . pack("N", 0x80DFEC60) /* magic number */ - . pack("N", 0) /* reserved */ - . str_pad("", 32, "\0") /* provider */ - . str_pad("", 32, "\0") /* token */ - . pack("N", strlen($body)); /* body length */ - -/* 3. send it as the body of a POST request */ -$stream = stream_context_create(array("http" => array( - "method" => "POST", - "header" => "Content-Type: application/octet-stream\r\n", - "content" => $header . $body, -))); -$reply = file_get_contents($uri, false, $stream); - -/* 4. parse the reply: 82-byte header, then the response body */ -$response = unserialize(substr($reply, 82 + 8)); -var_dump($response["r"]); -?> -]]> - - - - A more complete client implementation in plain PHP, which also - decodes the response header and supports concurrent calls, lives in - the tools/ directory of the - Yar source - repository. - - - - diff --git a/reference/yar/setup.xml b/reference/yar/setup.xml deleted file mode 100644 index deb2031c1bf8..000000000000 --- a/reference/yar/setup.xml +++ /dev/null @@ -1,172 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - The cURL library is required for the HTTP and HTTPS transports. The - TCP transport is implemented with plain sockets and needs no extra - library. - - - The JSON extension is required, - which is bundled with PHP and always available as of PHP 8.0.0. - - - To use the msgpack packager, the - msgpack extension - must be installed and Yar must be built with the - configure option. - -
    - - -
    - &reftitle.install; - - Yar can be installed in one of three ways: via PECL, via PIE, or - by building it from source. - - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;yar. - - - &pecl.windows.download.avail; - - - Installing Yar with PECL - - - - - - As of Yar 2.4.0, the extension can be installed with - &link.pie;, the PHP Installer for Extensions, by running the - following on the command line. - - - Installing Yar with PIE - - - - - - The msgpack packager can be enabled at install time: - - - Installing Yar with PIE and msgpack - - - - - - The source code is hosted on - GitHub. To - build the extension from source, run the following on the command - line, replacing the paths with those of the local PHP - installation. - - - Building Yar from source - - - - - - The following configure options are available: - - - - - - - - - Location of the cURL installation, if it is not found in the - default include paths. - - - - - - - - - - Enables the msgpack packager and makes the - msgpack extension an optional dependency. When - Yar is built with this option, the default value of - yar.packager becomes - msgpack. - - - - - - - - - - Uses Linux epoll instead of - select() for I/O multiplexing, available as of - Yar 2.1.2. This can improve - Yar_Concurrent_Client performance under - high concurrency. It only takes effect on Linux; on other - platforms it is silently ignored. - - - - -
    - - - - &reference.yar.ini; - - -
    - &reftitle.resources; - - This extension does not define any resources. - -
    - -
    - - diff --git a/reference/yar/versions.xml b/reference/yar/versions.xml deleted file mode 100644 index 9319614bc56e..000000000000 --- a/reference/yar/versions.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/yar/yar-client-exception.xml b/reference/yar/yar-client-exception.xml deleted file mode 100644 index f32f4cde6cd7..000000000000 --- a/reference/yar/yar-client-exception.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - The Yar_Client_Exception class - Yar_Client_Exception - - - - -
    - &reftitle.intro; - - Base class of the exceptions thrown when a request fails before, - during or after reaching the remote service: a subclass is thrown - depending on where the failure occurred. The exception code is one of - the YAR_ERR_* constants. - -
    - - -
    - &reftitle.classsynopsis; - - - - - Yar_Client_Exception - - - - extends - Exception - - - &InheritedProperties; - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -
    - - &reference.yar.entities.yar-client-exception; - -
    - - diff --git a/reference/yar/yar-client-packager-exception.xml b/reference/yar/yar-client-packager-exception.xml deleted file mode 100644 index 3c5fe3ae4a12..000000000000 --- a/reference/yar/yar-client-packager-exception.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - The Yar_Client_Packager_Exception class - Yar_Client_Packager_Exception - - - -
    - &reftitle.intro; - - Thrown when the response body cannot be unpacked with the requested packager (exception code YAR_ERR_PACKAGER). - -
    - -
    - &reftitle.classsynopsis; - - - - Yar_Client_Packager_Exception - - - - extends - Yar_Client_Exception - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
    - -
    - -
    - - diff --git a/reference/yar/yar-client-protocol-exception.xml b/reference/yar/yar-client-protocol-exception.xml deleted file mode 100644 index 6020b8001000..000000000000 --- a/reference/yar/yar-client-protocol-exception.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - The Yar_Client_Protocol_Exception class - Yar_Client_Protocol_Exception - - - -
    - &reftitle.intro; - - Thrown when the response from the RPC service violates the Yar protocol, for example an unsupported protocol address or a malformed response header (exception code YAR_ERR_PROTOCOL). - - - As of Yar 2.4.0 this also includes a response whose transaction id - does not match the id of the request it answers. The client validates - the i field of each response; a response carrying - a different, non-zero transaction id (for example one misrouted by a - proxy) is rejected. Responses with a zero or missing transaction id - are still accepted for backward compatibility with older servers. - -
    - -
    - &reftitle.classsynopsis; - - - - Yar_Client_Protocol_Exception - - - - extends - Yar_Client_Exception - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
    - -
    - -
    - - diff --git a/reference/yar/yar-client-transport-exception.xml b/reference/yar/yar-client-transport-exception.xml deleted file mode 100644 index 8b5679d6a235..000000000000 --- a/reference/yar/yar-client-transport-exception.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - The Yar_Client_Transport_Exception class - Yar_Client_Transport_Exception - - - -
    - &reftitle.intro; - - Thrown when the connection to the RPC service fails: connection refused, timeout, or an empty response (exception code YAR_ERR_TRANSPORT). - -
    - -
    - &reftitle.classsynopsis; - - - - Yar_Client_Transport_Exception - - - - extends - Yar_Client_Exception - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
    - -
    - -
    - - diff --git a/reference/yar/yar-client.xml b/reference/yar/yar-client.xml deleted file mode 100644 index dca6d9d6393c..000000000000 --- a/reference/yar/yar-client.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - The Yar_Client class - Yar_Client - - - - -
    - &reftitle.intro; - - The client side of the Yar RPC framework. A client is bound to a - single service address; invoking any undefined method on it issues a - remote call with that method name and the given arguments. - -
    - - -
    - &reftitle.classsynopsis; - - - - - Yar_Client - - - &Properties; - - protected - int - _protocol - - - protected - string - _uri - - - protected - arraynull - _options - - - protected - bool - _running - - - &Methods; - - - - - -
    - - -
    - &reftitle.properties; - - - _protocol - - - Read-only. The protocol derived from the service address: one of - YAR_CLIENT_PROTOCOL_HTTP, - YAR_CLIENT_PROTOCOL_TCP or - YAR_CLIENT_PROTOCOL_UNIX. - - - - - _uri - - - Read-only. The service address the client was created with. - - - - - _options - - - Read-only. An &array; of the options set on this client, keyed by - the YAR_OPT_* constants, or &null; if none were - set. - - - - - _running - - - Read-only. Whether a call issued by this client is currently in - progress. - - - - -
    - - -
    - - &reference.yar.entities.yar-client; - -
    - - diff --git a/reference/yar/yar-concurrent-client.xml b/reference/yar/yar-concurrent-client.xml deleted file mode 100644 index d484d1c54204..000000000000 --- a/reference/yar/yar-concurrent-client.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - The Yar_Concurrent_Client class - Yar_Concurrent_Client - - - - -
    - &reftitle.intro; - - A static helper that batches remote RPC calls. Calls registered with - Yar_Concurrent_Client::call are not sent - immediately; they are all dispatched together, in parallel, by - Yar_Concurrent_Client::loop. - - - The class is meant for applications that need the results of several - remote calls. Only independent calls — ones that do not need each - other's results — can be batched this way; when one call depends on - the result of another, the two have to run sequentially. Through - Yar_Client the calls are sent one after - another, each paying its full round-trip time; with the concurrent - client they are sent at the same time, so the overall waiting time - drops to the duration of the single slowest call. - - - - Only HTTP(S) services are supported for concurrent calls. They are - sent concurrently through curl's multi-handle interface, which the - TCP/Unix socket transport does not implement. - - -
    - - -
    - &reftitle.classsynopsis; - - - - - Yar_Concurrent_Client - - - &Methods; - - - - -
    - -
    - - &reference.yar.entities.yar-concurrent-client; - -
    - - diff --git a/reference/yar/yar-server-exception.xml b/reference/yar/yar-server-exception.xml deleted file mode 100644 index c77aeeb170f6..000000000000 --- a/reference/yar/yar-server-exception.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - The Yar_Server_Exception class - Yar_Server_Exception - - - - -
    - &reftitle.intro; - - Thrown on the client side when the RPC request failed on the server. - If the remote service method itself threw an exception, its message, - code, file, line and class name are carried over, and - Yar_Server_Exception::getType returns the - class name of the original exception. - -
    - - -
    - &reftitle.classsynopsis; - - - - - Yar_Server_Exception - - - - extends - Exception - - - &Properties; - - protected - string - _type - "Yar_Exception_Server" - - - &InheritedProperties; - - - &Methods; - - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.properties; - - - _type - - - The class name of the exception thrown by the remote service, or - "Yar_Exception_Server" if the error was not - caused by a userland exception. Read via - Yar_Server_Exception::getType. - - - - -
    - - -
    - - &reference.yar.entities.yar-server-exception; - -
    - - diff --git a/reference/yar/yar-server-output-exception.xml b/reference/yar/yar-server-output-exception.xml deleted file mode 100644 index 37fb140c2b95..000000000000 --- a/reference/yar/yar-server-output-exception.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - The Yar_Server_Output_Exception class - Yar_Server_Output_Exception - - - -
    - &reftitle.intro; - - Thrown when the server cannot capture the output of the service method (exception code YAR_ERR_OUTPUT). - -
    - -
    - &reftitle.classsynopsis; - - - - Yar_Server_Output_Exception - - - - extends - Yar_Server_Exception - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
    - -
    - -
    - - diff --git a/reference/yar/yar-server-packager-exception.xml b/reference/yar/yar-server-packager-exception.xml deleted file mode 100644 index 192d4e519b4e..000000000000 --- a/reference/yar/yar-server-packager-exception.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - The Yar_Server_Packager_Exception class - Yar_Server_Packager_Exception - - - -
    - &reftitle.intro; - - Thrown when the request body cannot be unpacked with the packager announced in the request (exception code YAR_ERR_PACKAGER). - -
    - -
    - &reftitle.classsynopsis; - - - - Yar_Server_Packager_Exception - - - - extends - Yar_Server_Exception - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
    - -
    - -
    - - diff --git a/reference/yar/yar-server-protocol-exception.xml b/reference/yar/yar-server-protocol-exception.xml deleted file mode 100644 index 52d5aa9f6e4d..000000000000 --- a/reference/yar/yar-server-protocol-exception.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - The Yar_Server_Protocol_Exception class - Yar_Server_Protocol_Exception - - - -
    - &reftitle.intro; - - Thrown when the incoming request violates the Yar protocol, for example a malformed request header (exception code YAR_ERR_PROTOCOL). - -
    - -
    - &reftitle.classsynopsis; - - - - Yar_Server_Protocol_Exception - - - - extends - Yar_Server_Exception - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
    - -
    - -
    - - diff --git a/reference/yar/yar-server-request-exception.xml b/reference/yar/yar-server-request-exception.xml deleted file mode 100644 index f2eae9ff66bf..000000000000 --- a/reference/yar/yar-server-request-exception.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - The Yar_Server_Request_Exception class - Yar_Server_Request_Exception - - - -
    - &reftitle.intro; - - Thrown when the requested remote method does not exist on the server object, or is not public (exception code YAR_ERR_REQUEST). - -
    - -
    - &reftitle.classsynopsis; - - - - Yar_Server_Request_Exception - - - - extends - Yar_Server_Exception - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
    - -
    - -
    - - diff --git a/reference/yar/yar-server.xml b/reference/yar/yar-server.xml deleted file mode 100644 index 4ffdc1203f36..000000000000 --- a/reference/yar/yar-server.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - The Yar_Server class - Yar_Server - - - - -
    - &reftitle.intro; - - Wraps an object and exposes all of its public methods as a remote - service, served over HTTP by - Yar_Server::handle. - - - The PHP extension only provides an HTTP server. A TCP and Unix - socket server speaking the same Yar protocol is provided by the - Yar C framework. - -
    - - -
    - &reftitle.classsynopsis; - - - - - Yar_Server - - - &Properties; - - protected - object - _executor - null - - - &Methods; - - - - - -
    - - -
    - &reftitle.properties; - - - _executor - - - The object whose public methods are exposed as RPC services. - - - - -
    - - -
    - - &reference.yar.entities.yar-server; - -
    - - diff --git a/reference/yar/yar_client/call.xml b/reference/yar/yar_client/call.xml deleted file mode 100644 index cfb5ccc8dc2d..000000000000 --- a/reference/yar/yar_client/call.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - Yar_Client::call - Call a remote service - - - - &reftitle.description; - - public mixedYar_Client::call - stringmethod - arrayarguments - - - Issues an RPC call to the remote method method. This - is exactly what happens when a non-existent method is invoked on a - Yar_Client object (via PHP's - __call magic method); - Yar_Client::call only exists so that remote - methods literally named call or - __call can still be reached. - - - - - &reftitle.parameters; - - - method - - - The name of the remote service method. - - - - - arguments - - - The list of arguments passed to the remote method. - - - - - - - - &reftitle.returnvalues; - - Returns the return value of the remote service method. - - - - - &reftitle.errors; - - When the remote method does not exist on the server, or is not - public, the client throws a - Yar_Client_Exception with the code - YAR_ERR_REQUEST. See - Yar_Client_Exception - for the other client-side failures and their exception classes. - - - - - &reftitle.examples; - - <methodname>Yar_Client::call</methodname> example - -add(1, 2)); - -/* Equivalent: call the method explicitly by name */ -var_dump($client->call("add", array(1, 2))); - -/* Needed only when the remote service literally exposes a method - * named call (or __call), which the magic __call cannot reach */ -var_dump($client->call("call", array($some_argument))); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yar_Client::setOpt - - - - - - diff --git a/reference/yar/yar_client/construct.xml b/reference/yar/yar_client/construct.xml deleted file mode 100644 index 6e2bde9899fd..000000000000 --- a/reference/yar/yar_client/construct.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - Yar_Client::__construct - Create a client - - - - &reftitle.description; - - final public Yar_Client::__construct - stringuri - arraynulloptionsnull - - - Creates a Yar_Client for the RPC service located - at uri. - - - - - &reftitle.parameters; - - - uri - - - Address of the RPC service. The protocol is derived from the scheme: - http:// and https:// select the - HTTP transport, tcp:// selects the TCP transport, - and unix:// selects the Unix socket transport. - - - - - options - - - An &array; of client options, keyed by the - YAR_OPT_* constants, equivalent to calling - Yar_Client::setOpt for each entry. Invalid - options are silently skipped. - - - - - - - - &reftitle.returnvalues; - - A new Yar_Client instance. - - - - - &reftitle.errors; - - If the URI does not start with a supported scheme, a - Yar_Client_Protocol_Exception is thrown. - - - - - &reftitle.examples; - - <methodname>Yar_Client::__construct</methodname> example - - 1000, - YAR_OPT_PACKAGER => "json", -]); -?> -]]> - - - - - - &reftitle.seealso; - - Yar_Client::call - Yar_Client::setOpt - - - - - - diff --git a/reference/yar/yar_client/getopt.xml b/reference/yar/yar_client/getopt.xml deleted file mode 100644 index b701db0ccbe0..000000000000 --- a/reference/yar/yar_client/getopt.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Yar_Client::getOpt - Read a client option - - - - &reftitle.description; - - public mixedYar_Client::getOpt - intname - - - Returns the value previously set with - Yar_Client::setOpt, or with the - options parameter of - Yar_Client::__construct. - - - - - &reftitle.parameters; - - - name - - - One of the YAR_OPT_* constants, see - Yar_Client::setOpt. - - - - - - - - &reftitle.returnvalues; - - The option value, or &false; if the option has not been set on this - client or the option name is unknown. - - - - - &reftitle.examples; - - <methodname>Yar_Client::getOpt</methodname> example - -setOpt(YAR_OPT_TIMEOUT, 1000); - -var_dump($client->getOpt(YAR_OPT_TIMEOUT)); -var_dump($client->getOpt(YAR_OPT_PACKAGER)); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yar_Client::setOpt - - - - - - diff --git a/reference/yar/yar_client/setopt.xml b/reference/yar/yar_client/setopt.xml deleted file mode 100644 index 860c7776a5d3..000000000000 --- a/reference/yar/yar_client/setopt.xml +++ /dev/null @@ -1,156 +0,0 @@ - - - - - - Yar_Client::setOpt - Set client options - - - - &reftitle.description; - - public Yar_ClientboolYar_Client::setOpt - intname - mixedvalue - - - Sets an option on the client. Options are evaluated when a call is - issued, so they can be changed between calls. - - - - - &reftitle.parameters; - - - name - - - One of the YAR_OPT_* constants: - - - YAR_OPT_PACKAGER — a packager name: php, json or, when built with msgpack support, msgpack - YAR_OPT_PERSISTENT — a boolean persistent-connection flag (HTTP keep-alive) - YAR_OPT_TIMEOUT — a timeout in milliseconds, overriding yar.timeout - YAR_OPT_CONNECT_TIMEOUT — a connect timeout in milliseconds, overriding yar.connect_timeout - YAR_OPT_HEADER (as of 2.0.4) — an &array; of additional HTTP header lines - YAR_OPT_RESOLVE (as of 2.1.0) — an &array; of hostname resolution entries - YAR_OPT_PROXY (as of 2.2.0) — an HTTP proxy address - YAR_OPT_PROVIDER (as of 2.3.0) — the provider identity, up to 32 bytes - YAR_OPT_TOKEN (as of 2.3.0) — the authentication token, up to 32 bytes - - - - - value - - - The option value. An invalid value raises a warning and makes the call - return &false;. - - - - - - - - &reftitle.returnvalues; - - Returns the client object itself, allowing a fluent interface, or - &false; when the option name is unknown, the value is invalid, or the - option does not apply to the protocol the client was created with. - - - - - &reftitle.errors; - - Conditions that make the call return &false; also raise a warning: - - - - - YAR_OPT_HEADER, - YAR_OPT_RESOLVE and - YAR_OPT_PROXY only work with the HTTP protocol; - using them with a tcp:// or - unix:// client raises a warning. - - - - - YAR_OPT_RESOLVE additionally requires libcurl - >= 7.21.3. - - - - - Each option expects a specific value type (string, boolean, integer or - array), described on the - constants page. - - - - - - - &reftitle.examples; - - <methodname>Yar_Client::setOpt</methodname> example - -setOpt(YAR_OPT_TIMEOUT, 1000); - -/* Set packager to JSON */ -$client->setOpt(YAR_OPT_PACKAGER, "json"); - -/* Set custom headers */ -$client->setOpt(YAR_OPT_HEADER, ["X-Api-Key: value"]); - -/* Route through an HTTP proxy */ -$client->setOpt(YAR_OPT_PROXY, "127.0.0.1:8888"); - -/* call remote service */ -$result = $client->some_method("parameter"); -?> -]]> - - - - - - &reftitle.seealso; - - Yar_Client::getOpt - Yar_Client::call - - - - - - diff --git a/reference/yar/yar_client_exception/gettype.xml b/reference/yar/yar_client_exception/gettype.xml deleted file mode 100644 index 9b664bb3b641..000000000000 --- a/reference/yar/yar_client_exception/gettype.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - Yar_Client_Exception::getType - Retrieve exception's type - - - - &reftitle.description; - - public stringYar_Client_Exception::getType - - - - Returns the type of the exception. Client-side exceptions are raised by - the client itself (transport failures, protocol errors and so on), so - the type is always the fixed string - "Yar_Exception_Client". Use - Exception::getCode to tell the individual - failure apart; the code is one of the YAR_ERR_* - constants. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns "Yar_Exception_Client". - - - - - &reftitle.examples; - - <methodname>Yar_Client_Exception::getType</methodname> example - -some_method("parameter"); -} catch (Yar_Client_Exception $e) { - var_dump($e->getType()); - var_dump($e->getCode()); -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yar_Server_Exception::getType - - - - - - diff --git a/reference/yar/yar_concurrent_client/call.xml b/reference/yar/yar_concurrent_client/call.xml deleted file mode 100644 index 79d6fb89e5a0..000000000000 --- a/reference/yar/yar_concurrent_client/call.xml +++ /dev/null @@ -1,189 +0,0 @@ - - - - - - Yar_Concurrent_Client::call - Register a concurrent call - - - - &reftitle.description; - - public static intfalsenullYar_Concurrent_Client::call - stringuri - stringmethod - arraynullparametersnull - callablenullcallbacknull - callablenullerror_callbacknull - arraynulloptionsnull - - - Registers a remote RPC call. The request is not sent immediately; all - registered calls are sent together by - Yar_Concurrent_Client::loop, and the responses - are handled as they arrive. - - - - Only HTTP and HTTPS URIs are supported. Concurrent calls are sent - simultaneously using curl's multi-handle interface, and the TCP/Unix - socket transport does not provide this facility. - - - - - - &reftitle.parameters; - - - uri - - - Address of the RPC service, starting with - http:// or https://. - - - - - method - - - The name of the remote service method. - - - - - parameters - - - The list of arguments passed to the remote method. - - - - - callback - - - A callable invoked when the response for this call - arrives, with two arguments: the response value, and a - callinfo &array; describing the call: - - - sequence — the sequence number returned - when the call was registered - uri — the address of the service - method — the name of the remote method - - - If omitted, the callback of - Yar_Concurrent_Client::loop is used; - see that method for what happens when neither is given. - - - - - error_callback - - - A callable invoked when this call fails, with three - arguments: the error type (one of the YAR_ERR_* - codes), the error message, and the callinfo - &array; described above. If omitted, the - error_callback of - Yar_Concurrent_Client::loop is used; - see that method for what happens when neither is given. - - - - - options - - - An &array; of client options, keyed by the - YAR_OPT_* constants, see - Yar_Client::setOpt. Applied to this call - only. - - - - - - - - &reftitle.returnvalues; - - Returns the sequence number of the registered call, a unique ID - starting from 1 that identifies the call. Returns - &false; when the concurrent client is already inside - Yar_Concurrent_Client::loop or when the maximum - of 128 registered calls is reached; in both cases a - warning is raised. Returns &null; if the URI or method name is empty, or - the URI is not an HTTP(S) address, with a warning. - - - - - &reftitle.examples; - - - "json")); - -/* Custom timeout */ -Yar_Concurrent_Client::call("http://api.example.com/operator.php", "some_method", array("parameters"), "callback", NULL, array(YAR_OPT_TIMEOUT => 1000)); - -/* The requests are not sent yet */ -]]> - - - - - - &reftitle.seealso; - - Yar_Concurrent_Client::loop - Yar_Concurrent_Client::reset - - - - - - diff --git a/reference/yar/yar_concurrent_client/loop.xml b/reference/yar/yar_concurrent_client/loop.xml deleted file mode 100644 index 8376bc566d4f..000000000000 --- a/reference/yar/yar_concurrent_client/loop.xml +++ /dev/null @@ -1,170 +0,0 @@ - - - - - - Yar_Concurrent_Client::loop - Send and wait for all registered calls - - - - &reftitle.description; - - public static boolnullYar_Concurrent_Client::loop - callablenullcallbacknull - callablenullerror_callbacknull - arraynulloptionsnull - - - Sends all calls registered with - Yar_Concurrent_Client::call in parallel and - blocks until every response has arrived and been handled. The call list - is emptied when this method returns. - - - Because the calls run simultaneously, the loop takes only as long as - the slowest single call rather than the sum of all calls. The - callbacks, however, are not invoked in the order the calls were - registered: a callback fires as soon as its response arrives. To find - out which call a response belongs to, check the - sequence entry of the callinfo - argument against the sequence number returned by - Yar_Concurrent_Client::call. The - callinfo &array; holds the - sequence, uri and - method of the call; see - Yar_Concurrent_Client::call. - - - - - &reftitle.parameters; - - - callback - - - A callable used to handle responses for calls that were - registered without their own callback. Right after all requests have - been sent, it is additionally called once with two &null; arguments, - before any response arrives. - - - If this parameter is omitted, the return value of a successful call - is simply printed when its response arrives. - - - - - error_callback - - - A callable used to handle errors for calls that were - registered without their own error callback. It receives three - arguments: the error type (one of the YAR_ERR_* - codes), the error message, and the callinfo - &array;. - - - If this parameter is omitted, a failed call raises a PHP warning - instead; unlike the synchronous - Yar_Client, no exception is thrown. - - - - - options - - - An &array; of client options, keyed by the - YAR_OPT_* constants, applied to every registered - call that does not override them. - - - - - - - - &reftitle.returnvalues; - - Returns &true; when every registered call has been handled, or when no - calls have been registered at all. Returns &false; if the concurrent - client is already running inside another loop; in that case a warning is - raised. - - - - - &reftitle.examples; - - <methodname>Yar_Concurrent_Client::loop</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yar_Concurrent_Client::call - Yar_Concurrent_Client::reset - - - - - - diff --git a/reference/yar/yar_concurrent_client/reset.xml b/reference/yar/yar_concurrent_client/reset.xml deleted file mode 100644 index c05960ff6f98..000000000000 --- a/reference/yar/yar_concurrent_client/reset.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - Yar_Concurrent_Client::reset - Clean all registered calls - - - - &reftitle.description; - - public static boolYar_Concurrent_Client::reset - - - - Discards all calls registered with - Yar_Concurrent_Client::call that have not been - sent yet. - - - - Yar_Concurrent_Client::loop empties the call - list automatically once it has finished, so reset is only needed to - abort a batch that was never sent. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true;, or &false; when the concurrent client is currently inside - Yar_Concurrent_Client::loop, in which case an - E_WARNING-level error is raised. - - - - - &reftitle.examples; - - <function>Yar_Concurrent_Client::reset</function> example - - -]]> - - - - - - &reftitle.seealso; - - Yar_Concurrent_Client::call - Yar_Concurrent_Client::loop - - - - - - diff --git a/reference/yar/yar_server/construct.xml b/reference/yar/yar_server/construct.xml deleted file mode 100644 index c8cd795f3a78..000000000000 --- a/reference/yar/yar_server/construct.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - Yar_Server::__construct - Create an RPC server - - - - &reftitle.description; - - final public Yar_Server::__construct - objectexecutor - - - Creates a Yar HTTP RPC server. All public methods of - executor are registered as RPC services. - - - - - &reftitle.parameters; - - - executor - - - Any object whose public methods should be exposed as RPC - services. Protected and private methods, and methods whose name - starts with an underscore, are not exposed. - - - The executor can optionally define two protected magic methods, - which are recognized by - Yar_Server::handle and never exposed as - RPC endpoints: - - - - - protected function __info(string $markup): - string — as of Yar 2.3.0. Called when the service - information page is requested; it receives the markup of the - page Yar would otherwise render, and if it returns a &string;, - that string is sent to the client instead. See - Yar_Server::handle. - - - - - protected function __auth(string $provider, string - $token): bool — as of Yar 2.3.0. Called at the very - beginning of every request with the - provider and token - fields of the request header, set by the client with the - YAR_OPT_PROVIDER and - YAR_OPT_TOKEN options. Returning exactly - &false; rejects the request; any other return value lets it - proceed. See Yar_Server::handle. - - - - - Both methods only take effect when they are - protected; a public or private method with - the same name is ignored. - - - - - - - - &reftitle.returnvalues; - - An instance of Yar_Server. - - - - - &reftitle.examples; - - <methodname>Yar_Server::__construct</methodname> example - -handle(); -?> -]]> - - - - - - &reftitle.seealso; - - - Yar_Server::handle - - - - - - - diff --git a/reference/yar/yar_server/handle.xml b/reference/yar/yar_server/handle.xml deleted file mode 100644 index feaa5ef686c5..000000000000 --- a/reference/yar/yar_server/handle.xml +++ /dev/null @@ -1,210 +0,0 @@ - - - - - - Yar_Server::handle - Start the RPC server - - - - &reftitle.description; - - public boolYar_Server::handle - - - - Starts handling the incoming RPC request. - - - - Usual RPC calls are issued as HTTP POST requests. If an HTTP GET - request is issued instead, the service information page, generated - from the public methods and their doc comments of the executor - object, is printed. This behaviour can be disabled with the - yar.expose_info - directive, in which case a GET request throws a - Yar_Server_Exception. - - - - - As of Yar 2.3.0, the executor object may define the protected - magic methods __info and - __auth to customize the service information - page and to authenticate requests; see - Yar_Server::__construct for details. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true;. - - - - - &reftitle.errors; - - - <methodname>Yar_Server::handle</methodname> errors - - - - Condition - Exception - - - - - - The remote method threw an exception. - - - Yar_Server_Exception (with the - original class name in its _type property). - - - - - The remote method was not found or is not public. - - - Yar_Server_Request_Exception. - - - - - The request body could not be unpacked. - - - Yar_Server_Packager_Exception. - - - - - The request is malformed on the protocol level. - - - Yar_Server_Protocol_Exception. - - - - - The server output could not be captured. - - - Yar_Server_Output_Exception. - - - - - Authentication failed, or the info page was requested while - yar.expose_info is - off. - - - Yar_Server_Exception with code - YAR_ERR_FORBIDDEN. - - - - -
    -
    -
    - - - &reftitle.examples; - - <methodname>Yar_Server::handle</methodname> example - -handle(); -?> -]]> - - - - Customizing the service information page with - <literal>__info</literal> (as of Yar 2.3.0) - -handle(); -?> -]]> - - - - - - &reftitle.seealso; - - - Yar_Server::__construct - - - - -
    - - diff --git a/reference/yar/yar_server_exception/gettype.xml b/reference/yar/yar_server_exception/gettype.xml deleted file mode 100644 index e9edbdbad86d..000000000000 --- a/reference/yar/yar_server_exception/gettype.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - Yar_Server_Exception::getType - Retrieve exception's type - - - - &reftitle.description; - - public stringintYar_Server_Exception::getType - - - - When a remote method throws an exception, the server embeds the original - exception in the response and the client re-throws it as a - Yar_Server_Exception. This method returns the - class name of that original exception. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The class name of the exception thrown by the remote service, or - "Yar_Exception_Server" when the server-side exception - carried no class name. - - - - - &reftitle.examples; - - <methodname>Yar_Server_Exception::getType</methodname> example - -handle(); -?> -]]> - - -throw_exception("client"); -} catch (Yar_Server_Exception $e) { - var_dump($e->getType()); - var_dump($e->getMessage()); -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yar_Client_Exception::getType - - - - - - diff --git a/reference/yaz/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/yaz/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/yaz/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/yaz/book.xml b/reference/yaz/book.xml deleted file mode 100644 index 0df63a7f066f..000000000000 --- a/reference/yaz/book.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - YAZ - - - - &reftitle.intro; - - This extension offers a PHP interface to the - YAZ toolkit that implements the - Z39.50 - Protocol for Information Retrieval. - With this extension you can easily implement a Z39.50 origin (client) - that searches or scans Z39.50 targets (servers) in parallel. - - - The module hides most of the complexity of Z39.50 so it should be - fairly easy to use. It supports persistent stateless connections very - similar to those offered by the various RDB APIs that are available - for PHP. This means that sessions are stateless but shared among - users, thus saving the connect and initialize phase steps in most - cases. - - - YAZ is available at &url.yaz;. You can find news information, - example scripts, etc. for this extension at &url.yaz-phpyaz;. - - - - &pecl.moved-ver;5.0.0. - - - - - - &reference.yaz.setup; - &reference.yaz.examples; - &reference.yaz.reference; - - - - - diff --git a/reference/yaz/configure.xml b/reference/yaz/configure.xml deleted file mode 100644 index d400cd6c3c4c..000000000000 --- a/reference/yaz/configure.xml +++ /dev/null @@ -1,50 +0,0 @@ - - -
    - &reftitle.install; - - &pecl.info; - &url.pecl.package;yaz - - - &pecl.windows.download; - - - Information specific to Windows users - - php_yaz.dll depends on - yaz.dll. The yaz.dll - is part of the Win32 ZIP from the PHP site. It is also part - of the Windows YAZ install available from the - YAZ WIN32 area. - - - On windows, don't forget to add the PHP directory to the PATH, - so that the yaz.dll file can be found by the system. - - - - &warn.imaprecodeyaz; - -
    - - diff --git a/reference/yaz/examples.xml b/reference/yaz/examples.xml deleted file mode 100644 index dd1d52e7ba8d..000000000000 --- a/reference/yaz/examples.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - &reftitle.examples; - - PHP/YAZ keeps track of connections with targets - (Z-Associations). A resource represents a connection to a - target. - - - The script below demonstrates the parallel searching feature of - the API. When invoked with no arguments it prints a query form; else - (arguments are supplied) it searches the targets as given in array - host. - - - - Parallel searching using Yaz - - - - GILS test - - local test - - Library of Congress -
    - RPN Query: - - - - '; -} else { - echo 'You searched for ' . htmlspecialchars($query) . '
    '; - for ($i = 0; $i < $num_hosts; $i++) { - $id[] = yaz_connect($host[$i]); - yaz_syntax($id[$i], "usmarc"); - yaz_range($id[$i], 1, 10); - yaz_search($id[$i], "rpn", $query); - } - yaz_wait(); - for ($i = 0; $i < $num_hosts; $i++) { - echo '
    ' . $host[$i] . ':'; - $error = yaz_error($id[$i]); - if (!empty($error)) { - echo "Error: $error"; - } else { - $hits = yaz_hits($id[$i]); - echo "Result Count $hits"; - } - echo '
    '; - for ($p = 1; $p <= 10; $p++) { - $rec = yaz_record($id[$i], $p, "string"); - if (empty($rec)) continue; - echo "
    $p
    "; - echo nl2br($rec); - echo "
    "; - } - echo '
    '; - } -} -?> -]]> -
    -
    -
    -
    - - - diff --git a/reference/yaz/functions/yaz-addinfo.xml b/reference/yaz/functions/yaz-addinfo.xml deleted file mode 100644 index 9cacab957200..000000000000 --- a/reference/yaz/functions/yaz-addinfo.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - yaz_addinfo - Returns additional error information - - - &reftitle.description; - - stringyaz_addinfo - resourceid - - - Returns additional error information for the last request on the server. - - - With some servers, this function may return the same string as - yaz_error. - - - - &reftitle.parameters; - - - - id - - - The connection resource returned by yaz_connect. - - - - - - - - &reftitle.returnvalues; - - A string containing additional error information or an empty string if the - last operation was successful or if no additional information was provided - by the server. - - - - &reftitle.seealso; - - - yaz_error - yaz_errno - - - - - - diff --git a/reference/yaz/functions/yaz-ccl-conf.xml b/reference/yaz/functions/yaz-ccl-conf.xml deleted file mode 100644 index 38f7caf346cd..000000000000 --- a/reference/yaz/functions/yaz-ccl-conf.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - yaz_ccl_conf - Configure CCL parser - - - &reftitle.description; - - voidyaz_ccl_conf - resourceid - arrayconfig - - - This function configures the CCL query parser for a server with - definitions of access points (CCL qualifiers) and their mapping to RPN. - - - To map a specific CCL query to RPN afterwards call the - yaz_ccl_parse function. - - - - &reftitle.parameters; - - - - id - - - The connection resource returned by yaz_connect. - - - - - config - - - An array of configuration. Each key of the array is the name of a CCL - field and the corresponding value holds a string that specifies a - mapping to RPN. - - - The mapping is a sequence of attribute-type, attribute-value pairs. - Attribute-type and attribute-value is separated by an equal sign - (=). Each pair is separated by white space. - - - Additional information can be found on the CCL page. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.examples; - - In the example below, the CCL parser is configured to support three CCL - fields: ti, au and - isbn. Each field is mapped to their BIB-1 equivalent. - It is assumed that variable $id is the connection ID. - - - CCL configuration - - "1=4", - "au" => "1=1", - "isbn" => "1=7" -); -yaz_ccl_conf($id, $fields); -?> -]]> - - - - - &reftitle.seealso; - - - yaz_ccl_parse - - - - - - diff --git a/reference/yaz/functions/yaz-ccl-parse.xml b/reference/yaz/functions/yaz-ccl-parse.xml deleted file mode 100644 index b6b0350cf646..000000000000 --- a/reference/yaz/functions/yaz-ccl-parse.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - yaz_ccl_parse - Invoke CCL Parser - - - &reftitle.description; - - boolyaz_ccl_parse - resourceid - stringquery - arrayresult - - - This function invokes a CCL parser. It converts a given CCL FIND query to - an RPN query which may be passed to the yaz_search - function to perform a search. - - - To define a set of valid CCL fields call yaz_ccl_conf - prior to this function. - - - - &reftitle.parameters; - - - - id - - - The connection resource returned by yaz_connect. - - - - - query - - - The CCL FIND query. - - - - - result - - - If the function was executed successfully, this will be an array - containing the valid RPN query under the key rpn. - - - Upon failure, three indexes are set in this array to indicate the cause - of failure: - - - - errorcode - the CCL error code (integer) - - - - - errorstring - the CCL error string - - - - - errorpos - approximate position in query of failure - (integer is character position) - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - CCL Parsing - - We will try to search using CCL. In the example below, - $ccl is a CCL query. - - - -]]> - - - - - - diff --git a/reference/yaz/functions/yaz-close.xml b/reference/yaz/functions/yaz-close.xml deleted file mode 100644 index 898d2eea4183..000000000000 --- a/reference/yaz/functions/yaz-close.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - yaz_close - Close YAZ connection - - - &reftitle.description; - - boolyaz_close - resourceid - - - Closes the connection given by parameter id. - - - - This function will only close a non-persistent connection opened by - setting the persistent option to &false; with - yaz_connect. - - - - - &reftitle.parameters; - - - - id - - - The connection resource returned by yaz_connect. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - yaz_connect - - - - - - diff --git a/reference/yaz/functions/yaz-connect.xml b/reference/yaz/functions/yaz-connect.xml deleted file mode 100644 index cbae972fb0dc..000000000000 --- a/reference/yaz/functions/yaz-connect.xml +++ /dev/null @@ -1,222 +0,0 @@ - - - - - yaz_connect - - Prepares for a connection to a Z39.50 server - - - - &reftitle.description; - - mixedyaz_connect - stringzurl - mixedoptions - - - This function returns a connection resource on success, zero on - failure. - - - yaz_connect prepares for a connection to a - Z39.50 server. - This function is non-blocking and does not attempt to establish - a connection - it merely prepares a connect to be performed later when - yaz_wait is called. - - - - The YAZ proxy is a - freely available Z39.50 proxy. - - - - - &reftitle.parameters; - - - - zurl - - - A string that takes the form host[:port][/database]. - If port is omitted, port 210 is used. If database is omitted - Default is used. - - - - - options - - - If given as a string, it is treated as the Z39.50 V2 authentication - string (OpenAuth). - - - If given as an array, the contents of the array serves as options. - - - user - - - Username for authentication. - - - - - group - - - Group for authentication. - - - - - password - - - Password for authentication. - - - - - cookie - - - Cookie for session (YAZ proxy). - - - - - proxy - - - Proxy for connection (YAZ proxy). - - - - - persistent - - - A boolean. If &true; the connection is persistent; If &false; the - connection is not persistent. By default connections are persistent. - - - - If you open a persistent connection, you won't be able to close - it later with yaz_close. - - - - - - piggyback - - - A boolean. If &true; piggyback is enabled for searches; If &false; - piggyback is disabled. By default piggyback is enabled. - - - Enabling piggyback is more efficient and usually saves a - network-round-trip for first time fetches of records. However, a - few Z39.50 servers do not support piggyback or they ignore element - set names. For those, piggyback should be disabled. - - - - - charset - - - A string that specifies character set to be used in Z39.50 - language and character set negotiation. Use strings such as: - ISO-8859-1, UTF-8, - UTF-16. - - - Most Z39.50 servers do not support this feature (and thus, this is - ignored). Many servers use the ISO-8859-1 encoding for queries and - messages. MARC21/USMARC records are not affected by this setting. - - - - - - preferredMessageSize - - - An integer that specifies the maximum byte size of all records - to be returned by a target during retrieval. See the - Z39.50 standard for more - information. - - - - This option is supported in PECL YAZ 1.0.5 or later. - - - - - - - maximumRecordSize - - - An integer that specifies the maximum byte size of a single record - to be returned by a target during retrieval. This - entity is referred to as Exceptional-record-size in the - Z39.50 standard. - - - - This option is supported in PECL YAZ 1.0.5 or later. - - - - - - - - - - - - - - &reftitle.returnvalues; - - A connection resource on success, &false; on error. - - - - &reftitle.seealso; - - - yaz_close - - - - - - diff --git a/reference/yaz/functions/yaz-database.xml b/reference/yaz/functions/yaz-database.xml deleted file mode 100644 index 6b240dc20f8f..000000000000 --- a/reference/yaz/functions/yaz-database.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - yaz_database - - Specifies the databases within a session - - - - &reftitle.description; - - boolyaz_database - resourceid - stringdatabases - - - This function allows you to change databases within a session by - specifying one or more databases to be used in search, retrieval, etc. - - overriding databases specified in call to - yaz_connect. - - - - &reftitle.parameters; - - - - id - - - The connection resource returned by yaz_connect. - - - - - databases - - - A string containing one or more databases. Multiple databases are - separated by a plus sign +. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/yaz/functions/yaz-element.xml b/reference/yaz/functions/yaz-element.xml deleted file mode 100644 index bf5e402648bd..000000000000 --- a/reference/yaz/functions/yaz-element.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - yaz_element - - Specifies Element-Set Name for retrieval - - - - &reftitle.description; - - boolyaz_element - resourceid - stringelementset - - - This function sets the element set name for retrieval. - - - Call this function before yaz_search or - yaz_present to specify the element set name for - records to be retrieved. - - - - If this function appears to have no effect, see the description of the - piggybacking option in - yaz_connect. - - - - - &reftitle.parameters; - - - - id - - - The connection resource returned by yaz_connect. - - - - - elementset - - - Most servers support F (for full records) and - B (for brief records). - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/yaz/functions/yaz-errno.xml b/reference/yaz/functions/yaz-errno.xml deleted file mode 100644 index 7d2cd74c0d8c..000000000000 --- a/reference/yaz/functions/yaz-errno.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - yaz_errno - Returns error number - - - &reftitle.description; - - intyaz_errno - resourceid - - - Returns an error number for the server (last request) identified by - id. - - - yaz_errno should be called after network activity for - each server - (after yaz_wait returns) to determine the - success or failure of the last operation (e.g. search). - - - - &reftitle.parameters; - - - - id - - - The connection resource returned by yaz_connect. - - - - - - - - &reftitle.returnvalues; - - Returns an error code. The error code is either a Z39.50 diagnostic code - (usually a Bib-1 diagnostic) or a client side error code which is - generated by PHP/YAZ itself, such as "Connect failed", "Init Rejected", - etc. - - - - &reftitle.seealso; - - - yaz_error - yaz_addinfo - - - - - - diff --git a/reference/yaz/functions/yaz-error.xml b/reference/yaz/functions/yaz-error.xml deleted file mode 100644 index 2def601a9438..000000000000 --- a/reference/yaz/functions/yaz-error.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - yaz_error - Returns error description - - - &reftitle.description; - - stringyaz_error - resourceid - - - yaz_error returns an English text message - corresponding to the last error number as returned by - yaz_errno. - - - - &reftitle.parameters; - - - - id - - - The connection resource returned by yaz_connect. - - - - - - - - &reftitle.returnvalues; - - Returns an error text message for server (last request), identified by - parameter id. An empty string is returned if the - last operation was successful. - - - - &reftitle.seealso; - - - yaz_errno - yaz_addinfo - - - - - - diff --git a/reference/yaz/functions/yaz-es-result.xml b/reference/yaz/functions/yaz-es-result.xml deleted file mode 100644 index 8acb4fdc7b20..000000000000 --- a/reference/yaz/functions/yaz-es-result.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - yaz_es_result - - Inspects Extended Services Result - - - - &reftitle.description; - - arrayyaz_es_result - resourceid - - - - This function inspects the last returned Extended Service - result from a server. An Extended Service is initiated - by either yaz_item_order or - yaz_es. - - - - - &reftitle.parameters; - - - - id - - - The connection resource returned by yaz_connect. - - - - - - - - - &reftitle.returnvalues; - - Returns array with element targetReference - for the reference for the extended service operation (generated - and returned from the server). - - - - - &reftitle.seealso; - - - yaz_es - - - - - - - diff --git a/reference/yaz/functions/yaz-es.xml b/reference/yaz/functions/yaz-es.xml deleted file mode 100644 index bd2a9f491c7e..000000000000 --- a/reference/yaz/functions/yaz-es.xml +++ /dev/null @@ -1,146 +0,0 @@ - - - - - yaz_es - - Prepares for an Extended Service Request - - - - &reftitle.description; - - voidyaz_es - - resourceid - - - stringtype - - - arrayargs - - - - This function prepares for an Extended Service Request. - Extended Services is a family of various Z39.50 facilities, such - as Record Update, Item Order, Database administration etc. - - - - Many Z39.50 Servers do not support Extended Services. - - - - The yaz_es creates an Extended Service Request - packages and puts it into a queue of operations. - Use yaz_wait to send the request(s) to the server. - After completion of yaz_wait the result of - the Extended Service operation should be expected with - a call to yaz_es_result. - - - - &reftitle.parameters; - - - - id - - - The connection resource returned by yaz_connect. - - - - - type - - - A string which represents the type of the Extended Service: - itemorder (Item Order), - create (Create Database), - drop (Drop Database), - commit (Commit Operation), - update (Update Record), - xmlupdate (XML Update). - Each type is specified in the following section. - - - - - - args - - - An array with extended service options plus - package specific options. The options are identical to - those offered in the C API of ZOOM C. Refer to - the ZOOM Extended Services. - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Record Update - - "some title", - "syntax" => "xml", - "action" => "specialUpdate" -); -yaz_es($con, "update", $args); -yaz_wait(); -$result = yaz_es_result($id); -?> -]]> - - - - - - &reftitle.seealso; - - - yaz_es_result - - - - - - - diff --git a/reference/yaz/functions/yaz-get-option.xml b/reference/yaz/functions/yaz-get-option.xml deleted file mode 100644 index 36f0b7f60d86..000000000000 --- a/reference/yaz/functions/yaz-get-option.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - yaz_get_option - Returns value of option for connection - - - &reftitle.description; - - stringyaz_get_option - resourceid - stringname - - - Returns the value of the option specified with name. - - - - &reftitle.parameters; - - - - id - - - The connection resource returned by yaz_connect. - - - - - name - - - The option name. - - - - - - - - &reftitle.returnvalues; - - Returns the value of the specified option or an empty string if the option - wasn't set. - - - - &reftitle.seealso; - - - - The description of yaz_set_option for available - options - - - - - - - diff --git a/reference/yaz/functions/yaz-hits.xml b/reference/yaz/functions/yaz-hits.xml deleted file mode 100644 index e2b4212a71d4..000000000000 --- a/reference/yaz/functions/yaz-hits.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - yaz_hits - Returns number of hits for last search - - - &reftitle.description; - - intyaz_hits - resourceid - arraysearchresult - - - yaz_hits returns the number of hits for the last - search. - - - - &reftitle.parameters; - - - - id - - - The connection resource returned by yaz_connect. - - - - - searchresult - - - Result array for detailed search result information. - - - - - - - - &reftitle.returnvalues; - - Returns the number of hits for the last search or 0 if no search was - performed. - - - The search result array (if supplied) holds information that - is returned by a Z39.50 server in the SearchResult-1 - format part of a search response. - The SearchResult-1 format can be used to obtain information - about hit counts for various parts of the query (subquery). - In particular, it is possible to obtain hit counts for the individual - search terms in a query. Information for first - subquery is in $array[0], second subquery in $array[1], and so forth. - - - searchresult members - - - - - - Element - Description - - - - - id - Sub query ID2 (string) - - - count - Result count / hits (integer) - - - subquery.term - Sub query term (string) - - - interpretation.term - Interpretated sub query term (string) - - - recommendation.term - Recommended sub query term (string) - - - -
    - - - The SearchResult facility requires PECL YAZ 1.0.5 - or later and YAZ 2.1.9 or later. - - - - - Very few Z39.50 implementations support the SearchResult facility. - - -
    -
    - - diff --git a/reference/yaz/functions/yaz-itemorder.xml b/reference/yaz/functions/yaz-itemorder.xml deleted file mode 100644 index 507dad05de0c..000000000000 --- a/reference/yaz/functions/yaz-itemorder.xml +++ /dev/null @@ -1,175 +0,0 @@ - - - - - yaz_itemorder - - Prepares for Z39.50 Item Order with an ILL-Request package - - - - &reftitle.description; - - voidyaz_itemorder - resourceid - arrayargs - - - This function prepares for an Extended Services request using the - Profile for the Use of Z39.50 Item Order Extended Service to - Transport ILL (Profile/1). See this - and the specification. - - - - &reftitle.parameters; - - - - id - - - The connection resource returned by yaz_connect. - - - - - args - - - Must be an associative array with information about the Item Order - request to be sent. The key of the hash is the name of the - corresponding ASN.1 tag path. For example, the ISBN below the Item-ID - has the key item-id,ISBN. - - - The ILL-Request parameters are: - - -protocol-version-num -transaction-id,initial-requester-id,person-or-institution-symbol,person -transaction-id,initial-requester-id,person-or-institution-symbol,institution -transaction-id,initial-requester-id,name-of-person-or-institution,name-of-person -transaction-id,initial-requester-id,name-of-person-or-institution,name-of-institution -transaction-id,transaction-group-qualifier -transaction-id,transaction-qualifier -transaction-id,sub-transaction-qualifier -service-date-time,this,date -service-date-time,this,time -service-date-time,original,date -service-date-time,original,time -requester-id,person-or-institution-symbol,person -requester-id,person-or-institution-symbol,institution -requester-id,name-of-person-or-institution,name-of-person -requester-id,name-of-person-or-institution,name-of-institution -responder-id,person-or-institution-symbol,person -responder-id,person-or-institution-symbol,institution -responder-id,name-of-person-or-institution,name-of-person -responder-id,name-of-person-or-institution,name-of-institution -transaction-type -delivery-address,postal-address,name-of-person-or-institution,name-of-person -delivery-address,postal-address,name-of-person-or-institution,name-of-institution -delivery-address,postal-address,extended-postal-delivery-address -delivery-address,postal-address,street-and-number -delivery-address,postal-address,post-office-box -delivery-address,postal-address,city -delivery-address,postal-address,region -delivery-address,postal-address,country -delivery-address,postal-address,postal-code -delivery-address,electronic-address,telecom-service-identifier -delivery-address,electronic-address,telecom-service-addreess -billing-address,postal-address,name-of-person-or-institution,name-of-person -billing-address,postal-address,name-of-person-or-institution,name-of-institution -billing-address,postal-address,extended-postal-delivery-address -billing-address,postal-address,street-and-number -billing-address,postal-address,post-office-box -billing-address,postal-address,city -billing-address,postal-address,region -billing-address,postal-address,country -billing-address,postal-address,postal-code -billing-address,electronic-address,telecom-service-identifier -billing-address,electronic-address,telecom-service-addreess -ill-service-type -requester-optional-messages,can-send-RECEIVED -requester-optional-messages,can-send-RETURNED -requester-optional-messages,requester-SHIPPED -requester-optional-messages,requester-CHECKED-IN -search-type,level-of-service -search-type,need-before-date -search-type,expiry-date -search-type,expiry-flag -place-on-hold -client-id,client-name -client-id,client-status -client-id,client-identifier -item-id,item-type -item-id,call-number -item-id,author -item-id,title -item-id,sub-title -item-id,sponsoring-body -item-id,place-of-publication -item-id,publisher -item-id,series-title-number -item-id,volume-issue -item-id,edition -item-id,publication-date -item-id,publication-date-of-component -item-id,author-of-article -item-id,title-of-article -item-id,pagination -item-id,ISBN -item-id,ISSN -item-id,additional-no-letters -item-id,verification-reference-source -copyright-complicance -retry-flag -forward-flag -requester-note -forward-note - - - There are also a few parameters that are part of the Extended - Services Request package and the ItemOrder package: - - -package-name -user-id -contact-name -contact-phone -contact-email -itemorder-item - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/yaz/functions/yaz-present.xml b/reference/yaz/functions/yaz-present.xml deleted file mode 100644 index f4d6e18ee9a2..000000000000 --- a/reference/yaz/functions/yaz-present.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - yaz_present - - Prepares for retrieval (Z39.50 present) - - - - &reftitle.description; - - boolyaz_present - resourceid - - - This function prepares for retrieval of records after a successful search. - - - The yaz_range function should be called prior to this - function to specify the range of records to be retrieved. - - - - &reftitle.parameters; - - - - id - - - The connection resource returned by yaz_connect. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/yaz/functions/yaz-range.xml b/reference/yaz/functions/yaz-range.xml deleted file mode 100644 index 1b05e732477e..000000000000 --- a/reference/yaz/functions/yaz-range.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - yaz_range - - Specifies a range of records to retrieve - - - - &reftitle.description; - - voidyaz_range - resourceid - intstart - intnumber - - - Specifies a range of records to retrieve. - - - This function should be called before yaz_search or - yaz_present. - - - - &reftitle.parameters; - - - - id - - - The connection resource returned by yaz_connect. - - - - - start - - - Specifies the position of the first record to be retrieved. The - records numbers goes from 1 to yaz_hits. - - - - - number - - - Specifies the number of records to be retrieved. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/yaz/functions/yaz-record.xml b/reference/yaz/functions/yaz-record.xml deleted file mode 100644 index 9b4c7767ade6..000000000000 --- a/reference/yaz/functions/yaz-record.xml +++ /dev/null @@ -1,305 +0,0 @@ - - - - - yaz_record - Returns a record - - - &reftitle.description; - - stringyaz_record - resourceid - intpos - stringtype - - - The yaz_record function inspects a record in the - current result set at the position specified by parameter - pos. - - - - &reftitle.parameters; - - - - id - - - The connection resource returned by yaz_connect. - - - - - pos - - - The record position. Records positions in a result set are numbered 1, - 2, ... $hits where $hits is the count returned by yaz_hits. - - - - - type - - - The type specifies the form of the - returned record. - - - - It is the application which is responsible for actually - ensuring that the records are returned from the Z39.50/SRW server - in the proper format. The type given only specifies a conversion - to take place on the client side (in PHP/YAZ). - - - - Besides conversion of the transfer record to a string/array, PHP/YAZ - it is also possible to perform a character set conversion of the - record. Especially for USMARC/MARC21 that is recommended since - these are typically returned in the character set MARC-8 that is - not supported by browsers, etc. To specify a conversion, add - ; charset=from, - to where - from is the original character set - of the record and to is the resulting character - set (as seen by PHP). - - - - string - - - The record is returned as a string for simple display. - In this mode, all MARC records are converted to a line-by-line format - since ISO2709 is hardly readable. - XML records and SUTRS are returned in their original format. - GRS-1 are returned in a (ugly) line-by-line format. - - - This format is suitable if records are to be displayed in a quick - way - for debugging - or because it is not feasible to perform - proper display. - - - - - xml - - - The record is returned as an XML string if possible. - In this mode, all MARC records are converted to - MARCXML. - XML records and SUTRS are returned in their original format. - GRS-1 is not supported. - - - This format is similar to string except that - MARC records are converted to MARCXML - - - This format is suitable if records are processed by an XML parser - or XSLT processor afterwards. - - - - - raw - - - The record is returned as a string in its original form. - This type is suitable for MARC, XML and SUTRS. It does not - work for GRS-1. - - - MARC records are returned as a ISO2709 string. XML and SUTRS are - returned as strings. - - - - - syntax - - - The syntax of the record is returned as a string, i.e. - USmarc, GRS-1, - XML, etc. - - - - - database - - - The name of database associated with record at the position - is returned as a string. - - - - - array - - - The record is returned as an array that reflects the GRS-1 - structure. This type is suitable for MARC and GRS-1. XML, SUTRS - are not supported and if the actual record is XML or SUTRS an - empty string will be returned. - - - The array returned consists of a list corresponding to - each leaf/internal node of GRS-1. Each list item consists - a sub list with first element path and - data (if data is available). - - - The path which is a string holds a list of each tree component (of - the structured GRS-1 record) from root to leaf. Each component is - a tag type, tag value pair of the form - (type, - value - - - String tags normally has a corresponding tag type 3. - MARC can also be returned as an array (they are converted to - GRS-1 internally). - - - - - - - - - - - &reftitle.returnvalues; - - Returns the record at position pos or an empty - string if no record exists at the given position. - - - If no database record exists at the given position an empty string is - returned. - - - - &reftitle.examples; - - Array for GRS-1 record - - Consider this GRS-1 record: - - - - This record has two nodes at root level. First element at root level is - (4,52) [tag type 4, tag value 52], and has data Robert M. - Pirsig. Second element at root level (4,70) has a subtree with - a single element (4,90). (4,90) has yet another sub tree (2,7) with data - Transworld Publishers, ltd.. - - - If this record is present at position $p, then - - -]]> - - will output: - - Array - ( - [0] => (4,52) - [1] => Robert M. Pirsig - ) - [1] => Array - ( - [0] => (4,70) - ) - [2] => Array - ( - [0] => (4,70)(4,90) - ) - [3] => Array - ( - [0] => (4,70)(4,90)(2,7) - [1] => Transworld Publishers, ltd. - ) -) -]]> - - - - - Working with MARCXML - - The following PHP snippet returns a MARC21/USMARC record as MARCXML. - The original record is returned in marc-8 (unknown to most XML parsers), - so we convert it to UTF-8 (which all XML parsers must support). - - -]]> - - - - The record $rec can be processed with the - Sablotron XSLT processor as follows: - - - - $rec); -$res = xslt_process($processor, 'arg:/_xml', $xslfile, NULL, $parms); -xslt_free($processor); -$res = preg_replace("']*>'", '', $res); -echo $res; - -?> -]]> - - - - - - - diff --git a/reference/yaz/functions/yaz-scan-result.xml b/reference/yaz/functions/yaz-scan-result.xml deleted file mode 100644 index 3d8795ec7cb0..000000000000 --- a/reference/yaz/functions/yaz-scan-result.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - yaz_scan_result - Returns Scan Response result - - - &reftitle.description; - - arrayyaz_scan_result - resourceid - arrayresult - - - yaz_scan_result returns terms and associated - information as received from the server in the last performed - yaz_scan. - - - - &reftitle.parameters; - - - - id - - - The connection resource returned by yaz_connect. - - - - - result - - - If given, this array will be modified to hold additional information - taken from the Scan Response: - - - - number - Number of entries returned - - - - - stepsize - Step size - - - - - position - Position of term - - - - - status - Scan status - - - - - - - - - - - &reftitle.returnvalues; - - Returns an array (0..n-1) where n is the number of terms returned. Each - value is a pair where the first item is the term, and the second item is - the result-count. - - - - - diff --git a/reference/yaz/functions/yaz-scan.xml b/reference/yaz/functions/yaz-scan.xml deleted file mode 100644 index d2006b3be756..000000000000 --- a/reference/yaz/functions/yaz-scan.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - yaz_scan - Prepares for a scan - - - &reftitle.description; - - voidyaz_scan - resourceid - stringtype - stringstartterm - arrayflags - - - This function prepares for a Z39.50 Scan Request on the specified - connection. - - - To actually transfer the Scan Request to the server and receive the - Scan Response, yaz_wait must be called. Upon - completion of yaz_wait call - yaz_error and yaz_scan_result to - handle the response. - - - - &reftitle.parameters; - - - - id - - - The connection resource returned by yaz_connect. - - - - - type - - - Currently only type rpn is supported. - - - - - startterm - - - Starting term point for the scan. - - - The form in which the starting term is specified is given by parameter - type. - - - The syntax this parameter is similar to the RPN query as described in - yaz_search. It consists of zero or more - @attr-operator specifications, then followed by - exactly one token. - - - - - flags - - - This optional parameter specifies additional information to control - the behaviour of the scan request. Three indexes are currently read - from the flags array: - number (number of terms requested), - position (preferred position of term) and - stepSize (preferred step size). - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.examples; - - - PHP function that scans titles - - $val) { - echo "$key = $val  "; - } - echo '
    '; - while (list($key, list($k, $term, $tcount)) = each($ar)) { - if (empty($k)) continue; - echo ""; - } - echo '
    $term$tcount
    '; - } else { - echo "Scan failed. Error: " . yaz_error($id) . "
    "; - } -} -?> -]]> -
    -
    -
    -
    -
    - - diff --git a/reference/yaz/functions/yaz-schema.xml b/reference/yaz/functions/yaz-schema.xml deleted file mode 100644 index 2f59272cc491..000000000000 --- a/reference/yaz/functions/yaz-schema.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - yaz_schema - - Specifies schema for retrieval - - - - &reftitle.description; - - voidyaz_schema - resourceid - stringschema - - - yaz_schema specifies the schema for retrieval. - - - This function should be called before - yaz_search or yaz_present. - - - - &reftitle.parameters; - - - - id - - - The connection resource returned by yaz_connect. - - - - - schema - - - Must be specified as an OID (Object Identifier) in a raw dot-notation - (like 1.2.840.10003.13.4) or as one of the known - registered schemas: GILS-schema, - Holdings, Zthes, ... - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/yaz/functions/yaz-search.xml b/reference/yaz/functions/yaz-search.xml deleted file mode 100644 index 8b972d52ac1a..000000000000 --- a/reference/yaz/functions/yaz-search.xml +++ /dev/null @@ -1,205 +0,0 @@ - - - - - yaz_search - Prepares for a search - - - &reftitle.description; - - boolyaz_search - resourceid - stringtype - stringquery - - - yaz_search prepares for a search on the given - connection. - - - Like yaz_connect this function is non-blocking and - only prepares for a search to be executed later when - yaz_wait is called. - - - - &reftitle.parameters; - - - - id - - - The connection resource returned by yaz_connect. - - - - - type - - - This parameter represents the query type - only "rpn" - is supported now in which case the third argument specifies a Type-1 - query in prefix query notation. - - - - - query - - - The RPN query is a textual representation of the Type-1 query as - defined by the Z39.50 standard. However, in the text representation - as used by YAZ a prefix notation is used, that is the operator - precedes the operands. The query string is a sequence of tokens where - white space is ignored unless surrounded by double quotes. Tokens beginning - with an at-character (@) are considered operators, - otherwise they are treated as search terms. - - - RPN Operators - - - - - - Construct - Description - - - - - @and query1 query2 - intersection of query1 and query2 - - - @or query1 query2 - union of query1 and query2 - - - @not query1 query2 - query1 and not query2 - - - @set name - result set reference - - - @attrset set query - - specifies attribute-set for query. This construction is only allowed - once - in the beginning of the whole query - - - - @attr [set] type=value query - - applies attribute to query. The type and value are integers - specifying the attribute-type and attribute-value respectively. - The set, if given, specifies the attribute-set. - - - - -
    - - You can find information about attributes at the - Z39.50 Maintenance Agency - site. - - - - If you would like to use a more friendly notation, - use the CCL parser - functions yaz_ccl_conf and - yaz_ccl_parse. - - -
    -
    -
    -
    -
    - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - Query Examples - - You can search for simple terms, like this: - - - - which matches documents where "computer" occur. No attributes are - specified. - - - The query - - - - matches documents where "knuth donald" occur (provided that the - server supports phrase search). - - - This query applies two attributes for the same phrase. - @attr 1=1003 @attr 4=1 "knuth donald" - First attribute is type 1 (Bib-1 use), attribute value is 1003 - (Author). - Second attribute has is type 4 (structure), value 1 (phrase), - so this should match documents where Donald Knuth is author. - - - The query - - - - would in infix notation look like (a or b) and ((c or d) not - e). - - - Another, more complex, one: - - - - The query as a whole uses the GILS attributeset. The query matches - documents where art occur in the title (GILS,BIB-1) - and in which company occur as Distributor (GILS). - - - -
    - - diff --git a/reference/yaz/functions/yaz-set-option.xml b/reference/yaz/functions/yaz-set-option.xml deleted file mode 100644 index ab399d3c197a..000000000000 --- a/reference/yaz/functions/yaz-set-option.xml +++ /dev/null @@ -1,160 +0,0 @@ - - - - - yaz_set_option - Sets one or more options for connection - - - &reftitle.description; - - voidyaz_set_option - resourceid - stringname - stringvalue - - - voidyaz_set_option - resourceid - arrayoptions - - - Sets one or more options on the given connection. - - - - &reftitle.parameters; - - - - id - - - The connection resource returned by yaz_connect. - - - - - name or options - - - May be either a string or an array. - - - If given as a string, this will be the name of the option to set. You'll - need to give it's value. - - - If given as an array, this will be an associative array (option name - => option value). - - - PHP/YAZ Connection Options - - - - - - Name - Description - - - - - implementationName - implementation name of server - - - implementationVersion - implementation version of server - - - implementationId - implementation ID of server - - - schema - - schema for retrieval. By default, no schema is used. Setting this - option is equivalent to using function - yaz_schema - - - - preferredRecordSyntax - - record syntax for retrieval. By default, no syntax is used. Setting - this option is equivalent to using function - yaz_syntax - - - - start - - offset for first record to be retrieved via - yaz_search or yaz_present. - First record is numbered has a start value of 0. Second record has - start value 1. - Setting this option in combination with option - count has the same effect as calling - yaz_range except that records are - numbered from 1 in yaz_range - - - - count - maximum number of records to be retrieved via - yaz_search or yaz_present. - - - - elementSetName - element-set-name for retrieval. Setting this option is - equivalent to calling yaz_element. - - - - -
    -
    -
    - - value - - - The new value of the option. Use this only if the previous argument is - a string. - - - -
    -
    -
    - - &reftitle.returnvalues; - - &return.void; - - -
    - - diff --git a/reference/yaz/functions/yaz-sort.xml b/reference/yaz/functions/yaz-sort.xml deleted file mode 100644 index 6c5e7a3bb99b..000000000000 --- a/reference/yaz/functions/yaz-sort.xml +++ /dev/null @@ -1,146 +0,0 @@ - - - - - yaz_sort - Sets sorting criteria - - - &reftitle.description; - - voidyaz_sort - resourceid - stringcriteria - - - This function sets sorting criteria and enables Z39.50 Sort. - - - Call this function before yaz_search. - Using this function alone does not have any effect. When used in conjunction - with yaz_search, a Z39.50 Sort will be sent after a - search response has been received and before any records are retrieved with - Z39.50 Present (yaz_present. - - - - &reftitle.parameters; - - - - id - - - The connection resource returned by yaz_connect. - - - - - criteria - - - A string that takes the form field1 flags1 field2 - flags2 where field1 specifies the primary attributes for - sort, field2 seconds, etc.. - - - The field specifies either a numerical attribute combinations consisting - of type=value pairs separated by comma (e.g. 1=4,2=1) - ; or the field may specify a plain string criteria (e.g. - title. The flags is a sequence of the following - characters which may not be separated by any white space. - - - - Sort Flags - - a - - - Sort ascending - - - - - d - - - Sort descending - - - - - i - - - Case insensitive sorting - - - - - s - - - Case sensitive sorting - - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.examples; - - Sort Criterias - - To sort on Bib1 attribute title, case insensitive, and ascending you - would use the following sort criteria: - - - - - - If the secondary sorting criteria should be author, case sensitive and - ascending you would use: - - - - - - - - - diff --git a/reference/yaz/functions/yaz-syntax.xml b/reference/yaz/functions/yaz-syntax.xml deleted file mode 100644 index 8578c67f0df2..000000000000 --- a/reference/yaz/functions/yaz-syntax.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - yaz_syntax - - Specifies the preferred record syntax for retrieval - - - - &reftitle.description; - - voidyaz_syntax - resourceid - stringsyntax - - - yaz_syntax specifies the preferred record syntax for - retrieval - - - This function should be called before yaz_search or - yaz_present. - - - - &reftitle.parameters; - - - - id - - - The connection resource returned by yaz_connect. - - - - - syntax - - - The syntax must be specified as an OID (Object Identifier) in a raw - dot-notation (like 1.2.840.10003.5.10) or as one of - the known registered record syntaxes (sutrs, usmarc, grs1, xml, etc.). - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/yaz/functions/yaz-wait.xml b/reference/yaz/functions/yaz-wait.xml deleted file mode 100644 index 3fb05130dcdb..000000000000 --- a/reference/yaz/functions/yaz-wait.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - yaz_wait - Wait for Z39.50 requests to complete - - - &reftitle.description; - - mixedyaz_wait - arrayoptions - - - This function carries out networked (blocked) activity for outstanding - requests which have been prepared by the functions - yaz_connect, yaz_search, - yaz_present, yaz_scan and - yaz_itemorder. - - - yaz_wait returns when all servers have either - completed all requests or aborted (in case of errors). - - - - &reftitle.parameters; - - - - options - - - An associative array of options: - - - timeout - - - Sets timeout in seconds. If a server has not responded within the - timeout it is considered dead and yaz_wait - returns. The default value for timeout is 15 seconds. - - - - - event - - - A boolean. - - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - In event mode, returns resource &return.falseforfailure;. - - - - - diff --git a/reference/yaz/reference.xml b/reference/yaz/reference.xml deleted file mode 100644 index 011dd8d8df73..000000000000 --- a/reference/yaz/reference.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - YAZ &Functions; - - &reference.yaz.entities.functions; - - - - diff --git a/reference/yaz/setup.xml b/reference/yaz/setup.xml deleted file mode 100644 index 1794435d245a..000000000000 --- a/reference/yaz/setup.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - &reftitle.setup; - - -
    - &reftitle.required; - - Obtain YAZ (ANSI/NISO Z39.50 support) and install it. - YAZ can be fetched in source or in various prebuilt packages - from the YAZ archive. - Systems such as Debian GNU/Linux, Suse Linux, FreeBSD also has YAZ - as part of their distribution. - -
    - - - - &reference.yaz.configure; - - -
    - - - diff --git a/reference/yaz/versions.xml b/reference/yaz/versions.xml deleted file mode 100644 index 1803dd33d316..000000000000 --- a/reference/yaz/versions.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/zmq/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/zmq/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/zmq/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/zmq/book.xml b/reference/zmq/book.xml deleted file mode 100644 index bc7d18d235a5..000000000000 --- a/reference/zmq/book.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - ZMQ - 0MQ messaging - - - &reftitle.intro; - - &warn.experimental; - "ØMQ is a software library that lets you quickly design and implement a fast message-based application." --0MQ Website - - - For more information about 0MQ, see &url.zeromq;. - - - - &reference.zmq.setup; - - &reference.zmq.zmq; - &reference.zmq.zmqexception; - - &reference.zmq.zmqcontext; - &reference.zmq.zmqcontextexception; - - &reference.zmq.zmqsocket; - &reference.zmq.zmqsocketexception; - - &reference.zmq.zmqpoll; - &reference.zmq.zmqpollexception; - - &reference.zmq.zmqdevice; - &reference.zmq.zmqdeviceexception; - - - - - diff --git a/reference/zmq/setup.xml b/reference/zmq/setup.xml deleted file mode 100644 index fca5c22d7a67..000000000000 --- a/reference/zmq/setup.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - ZMQ extension requires 0MQ version 2.0.7 or higher. 0MQ can be acquired from &url.zeromq;area:download. - -
    - -
    - &reftitle.install; - - - &pecl.info.dead; - &url.pecl.package;zmq - - - &pecl.windows.download.avail; - -
    -
    - - diff --git a/reference/zmq/versions.xml b/reference/zmq/versions.xml deleted file mode 100644 index 39ee0e83c2c9..000000000000 --- a/reference/zmq/versions.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/zmq/zmq.xml b/reference/zmq/zmq.xml deleted file mode 100644 index f4cc7482ae82..000000000000 --- a/reference/zmq/zmq.xml +++ /dev/null @@ -1,782 +0,0 @@ - - - - - - The ZMQ class - ZMQ - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - ZMQ - - - - - ZMQ - - - - &Constants; - - const - int - ZMQ::SOCKET_PAIR - - - const - int - ZMQ::SOCKET_PUB - - - const - int - ZMQ::SOCKET_SUB - - - const - int - ZMQ::SOCKET_REQ - - - const - int - ZMQ::SOCKET_REP - - - const - int - ZMQ::SOCKET_XREQ - - - const - int - ZMQ::SOCKET_XREP - - - const - int - ZMQ::SOCKET_PUSH - - - const - int - ZMQ::SOCKET_PULL - - - const - int - ZMQ::SOCKET_ROUTER - - - const - int - ZMQ::SOCKET_DEALER - - - const - int - ZMQ::SOCKET_XPUB - - - const - int - ZMQ::SOCKET_XSUB - - - const - int - ZMQ::SOCKET_STREAM - - - const - int - ZMQ::SOCKOPT_HWM - - - const - int - ZMQ::SOCKOPT_SNDHWM - - - const - int - ZMQ::SOCKOPT_RCVHWM - - - const - int - ZMQ::SOCKOPT_AFFINITY - - - const - int - ZMQ::SOCKOPT_IDENTITY - - - const - int - ZMQ::SOCKOPT_SUBSCRIBE - - - const - int - ZMQ::SOCKOPT_UNSUBSCRIBE - - - const - int - ZMQ::SOCKOPT_RATE - - - const - int - ZMQ::SOCKOPT_RECOVERY_IVL - - - const - int - ZMQ::SOCKOPT_RECONNECT_IVL - - - const - int - ZMQ::SOCKOPT_RECONNECT_IVL_MAX - - - const - int - ZMQ::SOCKOPT_MCAST_LOOP - - - const - int - ZMQ::SOCKOPT_SNDBUF - - - const - int - ZMQ::SOCKOPT_RCVBUF - - - const - int - ZMQ::SOCKOPT_RCVMORE - - - const - int - ZMQ::SOCKOPT_TYPE - - - const - int - ZMQ::SOCKOPT_LINGER - - - const - int - ZMQ::SOCKOPT_BACKLOG - - - const - int - ZMQ::SOCKOPT_MAXMSGSIZE - - - const - int - ZMQ::SOCKOPT_SNDTIMEO - - - const - int - ZMQ::SOCKOPT_RCVTIMEO - - - const - int - ZMQ::SOCKOPT_IPV4ONLY - - - const - int - ZMQ::SOCKOPT_LAST_ENDPOINT - - - const - int - ZMQ::SOCKOPT_TCP_KEEPALIVE_IDLE - - - const - int - ZMQ::SOCKOPT_TCP_KEEPALIVE_CNT - - - const - int - ZMQ::SOCKOPT_TCP_KEEPALIVE_INTVL - - - const - int - ZMQ::SOCKOPT_TCP_ACCEPT_FILTER - - - const - int - ZMQ::SOCKOPT_TCP_ACCEPT_FILTER - - - const - int - ZMQ::SOCKOPT_DELAY_ATTACH_ON_CONNECT - - - const - int - ZMQ::SOCKOPT_XPUB_VERBOSE - - - const - int - ZMQ::SOCKOPT_ROUTER_RAW - - - const - int - ZMQ::SOCKOPT_IPV6 - - - const - int - ZMQ::CTXOPT_MAX_SOCKETS - - - const - int - ZMQ::POLL_IN - - - const - int - ZMQ::POLL_OUT - - - const - int - ZMQ::MODE_NOBLOCK - - - const - int - ZMQ::MODE_DONTWAIT - - - const - int - ZMQ::MODE_SNDMORE - - - const - int - ZMQ::ERR_INTERNAL - - - const - int - ZMQ::ERR_EAGAIN - - - const - int - ZMQ::ERR_ENOTSUP - - - const - int - ZMQ::ERR_EFSM - - - const - int - ZMQ::ERR_ETERM - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; -
    - ZMQ Constant Types - - - - ZMQ::SOCKET_PAIR - - Exclusive pair pattern - - - - - ZMQ::SOCKET_PUB - - Publisher socket - - - - - ZMQ::SOCKET_SUB - - Subscriber socket - - - - - ZMQ::SOCKET_REQ - - Request socket - - - - - ZMQ::SOCKET_REP - - Reply socket - - - - - ZMQ::SOCKET_XREQ - - Alias for SOCKET_DEALER - - - - - ZMQ::SOCKET_XREP - - Alias for SOCKET_ROUTER - - - - - ZMQ::SOCKET_PUSH - - Pipeline upstream push socket - - - - - ZMQ::SOCKET_PULL - - Pipeline downstream pull socket - - - - - ZMQ::SOCKET_ROUTER - - Extended REP socket that can route replies to requesters - - - - - ZMQ::SOCKET_DEALER - - Extended REQ socket that load balances to all connected peers - - - - - ZMQ::SOCKET_XPUB - - Similar to SOCKET_PUB, except you can receive subscriptions as messages. - The subscription message is 0 (unsubscribe) or 1 (subscribe) followed by the topic. - - - - - ZMQ::SOCKET_XSUB - - Similar to SOCKET_SUB, except you can send subscriptions as messages. See SOCKET_XPUB for format. - - - - - ZMQ::SOCKET_STREAM - - Used to send and receive TCP data from a non-ØMQ peer. Available if compiled against ZeroMQ 4.x or higher (Value: &integer;). - - - - - ZMQ::SOCKOPT_HWM - - The high water mark for inbound and outbound messages is a hard limit on the maximum number of outstanding messages ØMQ shall queue in memory for any single peer that the specified socket is communicating with. Setting this option on a socket will only affect connections made after the option has been set. On ZeroMQ 3.x this is a wrapper for setting both SNDHWM and RCVHWM. (Value: &integer;). - - - - - ZMQ::SOCKOPT_SNDHWM - - The ZMQ_SNDHWM option shall set the high water mark for outbound messages on the specified socket. Available if compiled against ZeroMQ 3.x or higher (Value: &integer;). - - - - - ZMQ::SOCKOPT_RCVHWM - - The SOCKOPT_RCVHWM option shall set the high water mark for inbound messages on the specified socket. Available if compiled against ZeroMQ 3.x or higher (Value: &integer;). - - - - - ZMQ::SOCKOPT_AFFINITY - - Set I/O thread affinity (Value: &integer;) - - - - - ZMQ::SOCKOPT_IDENTITY - - Set socket identity (Value: &string;) - - - - - ZMQ::SOCKOPT_SUBSCRIBE - - Establish message filter. Valid for subscriber socket (Value: &string;) - - - - - ZMQ::SOCKOPT_UNSUBSCRIBE - - Remove message filter. Valid for subscriber socket (Value: &string;) - - - - - ZMQ::SOCKOPT_RATE - - Set rate for multicast sockets (pgm) (Value: &integer; >= 0) - - - - - ZMQ::SOCKOPT_RECOVERY_IVL - - Set multicast recovery interval (Value: &integer; >= 0) - - - - - ZMQ::SOCKOPT_RECONNECT_IVL - - Set the initial reconnection interval (Value: &integer; >= 0) - - - - - ZMQ::SOCKOPT_RECONNECT_IVL_MAX - - Set the max reconnection interval (Value: &integer; >= 0) - - - - - ZMQ::SOCKOPT_MCAST_LOOP - - Control multicast loopback (Value: &integer; >= 0) - - - - - ZMQ::SOCKOPT_SNDBUF - - Set kernel transmit buffer size (Value: &integer; >= 0) - - - - - ZMQ::SOCKOPT_RCVBUF - - Set kernel receive buffer size (Value: &integer; >= 0) - - - - - ZMQ::SOCKOPT_RCVMORE - - Receive multi-part messages (Value: &integer;) - - - - - ZMQ::SOCKOPT_TYPE - - Get the socket type. Valid for getSockOpt (Value: &integer;) - - - - - ZMQ::SOCKOPT_LINGER - - The linger value of the socket. Specifies how long the socket blocks - trying flush messages after it has been closed (Value: &integer;) - - - - - ZMQ::SOCKOPT_BACKLOG - - The SOCKOPT_BACKLOG option shall set the maximum length of the queue of outstanding peer connections for the specified socket; this only applies to connection-oriented transports. (Value: &integer;) - - - - - ZMQ::SOCKOPT_MAXMSGSIZE - - Limits the maximum size of the inbound message. Value -1 means no limit. Available if compiled against ZeroMQ 3.x or higher (Value: &integer;) - - - - - ZMQ::SOCKOPT_SNDTIMEO - - Sets the timeout for send operation on the socket. Value -1 means no limit. Available if compiled against ZeroMQ 3.x or higher (Value: &integer;) - - - - - ZMQ::SOCKOPT_RCVTIMEO - - Sets the timeout for receive operation on the socket. Value -1 means no limit. Available if compiled against ZeroMQ 3.x or higher (Value: &integer;) - - - - - ZMQ::SOCKOPT_IPV4ONLY - - Disable IPV6 support if 1. Available if compiled against ZeroMQ 3.x (Value: &integer;) - - - - - ZMQ::SOCKOPT_LAST_ENDPOINT - - Retrieve the last connected endpoint - for use with * wildcard ports. Available if compiled against ZeroMQ 3.x or higher (Value: &string;) - - - - - ZMQ::SOCKOPT_TCP_KEEPALIVE_IDLE - - Idle time for TCP keepalive. Available if compiled against ZeroMQ 3.x or higher (Value: &integer;) - - - - - ZMQ::SOCKOPT_TCP_KEEPALIVE_CNT - - Count time for TCP keepalive. Available if compiled against ZeroMQ 3.x or higher (Value: &integer;) - - - - - ZMQ::SOCKOPT_TCP_KEEPALIVE_INTVL - - Interval for TCP keepalive. Available if compiled against ZeroMQ 3.x or higher (Value: &integer;) - - - - - ZMQ::SOCKOPT_DELAY_ATTACH_ON_CONNECT - - Set a CIDR string to match against incoming TCP connections. Available if compiled against ZeroMQ 3.x or higher (Value: &string;) - - - - - ZMQ::SOCKOPT_TCP_ACCEPT_FILTER - - Set a CIDR string to match against incoming TCP connections. Available if compiled against ZeroMQ 3.x or higher (Value: &string;) - - - - - ZMQ::SOCKOPT_XPUB_VERBOSE - - Set the XPUB to receive an application message on each instance of a subscription. Available if compiled against ZeroMQ 3.x or higher (Value: &string;) - - - - - ZMQ::SOCKOPT_ROUTER_RAW - - Sets the raw mode on the ROUTER, when set to 1. In raw mode when using tcp:// transport the socket will read and write without ZeroMQ framing. - Available if compiled against ZeroMQ 4.0 or higher (Value: &string;) - - - - - ZMQ::SOCKOPT_IPV6 - - Enable IPV6. Available if compiled against ZeroMQ 4.0 or higher (Value: &string;) - - - - - ZMQ::CTXOPT_MAX_SOCKETS - - The socket limit for this context. Available if compiled against ZeroMQ 3.x or higher (Value: &integer;) - - - - - ZMQ::POLL_IN - - Poll for incoming data - - - - - ZMQ::POLL_OUT - - Poll for outgoing data - - - - - ZMQ::MODE_NOBLOCK - - Non-blocking operation. Deprecated, use ZMQ::MODE_DONTWAIT instead - - - - - ZMQ::MODE_DONTWAIT - - Non-blocking operation - - - - - ZMQ::MODE_SNDMORE - - Send multi-part message - - - - - ZMQ::DEVICE_FORWARDER - - Forwarder device - - - - - ZMQ::DEVICE_QUEUE - - Queue device - - - - - ZMQ::DEVICE_STREAMER - - Streamer device - - - - - ZMQ::ERR_INTERNAL - - ZMQ extension internal error - - - - - ZMQ::ERR_EAGAIN - - Implies that the operation would block when ZMQ::MODE_DONTWAIT is used - - - - - ZMQ::ERR_ENOTSUP - - The operation is not supported by the socket type - - - - - ZMQ::ERR_EFSM - - The operation can not be executed because the socket is not in correct state - - - - - ZMQ::ERR_ETERM - - The context has been terminated - - - - -
    -
    - - - -
    - - &reference.zmq.entities.zmq; - -
    - - diff --git a/reference/zmq/zmq/construct.xml b/reference/zmq/zmq/construct.xml deleted file mode 100644 index b1e0db4ec21c..000000000000 --- a/reference/zmq/zmq/construct.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - ZMQ::__construct - ZMQ constructor - - - - &reftitle.description; - - private ZMQ::__construct - - - - Private constructor to prevent direct initialization. This class holds the constants for ZMQ extension. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/zmq/zmqcontext.xml b/reference/zmq/zmqcontext.xml deleted file mode 100644 index 708619fe4b8e..000000000000 --- a/reference/zmq/zmqcontext.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - The ZMQContext class - ZMQContext - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - ZMQContext - - - - - ZMQContext - - - - - &Methods; - - - - -
    - -
    - - &reference.zmq.entities.zmqcontext; - -
    - - diff --git a/reference/zmq/zmqcontext/construct.xml b/reference/zmq/zmqcontext/construct.xml deleted file mode 100644 index 1fe671965737..000000000000 --- a/reference/zmq/zmqcontext/construct.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - ZMQContext::__construct - Construct a new ZMQContext object - - - - &reftitle.description; - - public ZMQContext::__construct - intio_threads1 - boolis_persistent&true; - - - Constructs a new ZMQ context. The context is used to initialize sockets. A persistent context is required - to initialize persistent sockets. - - - - - &reftitle.parameters; - - - - io_threads - - - Number of io-threads in the context. - - - - - is_persistent - - - Whether the context is persistent. Persistent context is stored - over multiple requests and is a requirement for persistent sockets. - - - - - - - - - &reftitle.errors; - - Throws ZMQContextException if context initialization fails. - - - - - &reftitle.examples; - - - A <function>ZMQContext</function> example - - Construct a new context and allocate request socket from it - - -getSocket(ZMQ::SOCKET_REQ, 'my sock'); - -/* Connect the socket */ -$socket->connect("tcp://example.com:1234"); - -/* Send a request */ -$socket->send("Hello there"); - -/* Receive back the response */ -$message = $socket->recv(); -?> -]]> - - - - - - - - diff --git a/reference/zmq/zmqcontext/getopt.xml b/reference/zmq/zmqcontext/getopt.xml deleted file mode 100644 index 1b53bfd3e815..000000000000 --- a/reference/zmq/zmqcontext/getopt.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - ZMQContext::getOpt - Get context option - - - - &reftitle.description; - - public mixedZMQContext::getOpt - stringkey - - - Returns the value of a context option. - - - - - &reftitle.parameters; - - - - key - - - An integer representing the option. - See the ZMQ::CTXOPT_* constants. - - - - - - - - - &reftitle.returnvalues; - - Returns either a &string; or an &integer; depending on key. Throws - ZMQContextException on error. - - - - - - - diff --git a/reference/zmq/zmqcontext/getsocket.xml b/reference/zmq/zmqcontext/getsocket.xml deleted file mode 100644 index 1aa6e0dab85d..000000000000 --- a/reference/zmq/zmqcontext/getsocket.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - ZMQContext::getSocket - Create a new socket - - - - &reftitle.description; - - public ZMQSocketZMQContext::getSocket - inttype - stringpersistent_id&null; - callableon_new_socket&null; - - - Shortcut for creating new sockets from the context. If the context is not persistent the persistent_id - parameter is ignored and the socket falls back to being non-persistent. The on_new_socket is called only - when a new underlying socket structure is created. - - - - - &reftitle.parameters; - - - - type - - - ZMQ::SOCKET_* constant to specify socket type. - - - - - persistent_id - - - If persistent_id is specified the socket will be persisted over multiple requests. - - - - - on_new_socket - - - Callback function, which is executed when a new socket structure is created. This function does not get invoked - if the underlying persistent connection is re-used. The callback takes ZMQSocket and persistent_id as two arguments. - - - - - - - - - &reftitle.returnvalues; - - Returns a ZMQSocket object. - - - - - &reftitle.errors; - - Throws ZMQSocketException on error. - - - - - &reftitle.examples; - - - A <function>ZMQContext</function> example - - Basic usage - - -getSocket(ZMQ::SOCKET_REQ, 'my sock'); - -/* Connect the socket */ -$socket->connect("tcp://example.com:1234"); - -/* Send a request */ -$socket->send("Hello there"); - -/* Receive back the response */ -$message = $socket->recv(); -echo "Received message: {$message}\n"; -?> -]]> - - - - - - - - diff --git a/reference/zmq/zmqcontext/ispersistent.xml b/reference/zmq/zmqcontext/ispersistent.xml deleted file mode 100644 index 60d3d431a4e8..000000000000 --- a/reference/zmq/zmqcontext/ispersistent.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - ZMQContext::isPersistent - Whether the context is persistent - - - - &reftitle.description; - - public boolZMQContext::isPersistent - - - - Whether the context is persistent. Persistent context is needed for persistent connections as each - socket is allocated from a context. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; if the context is persistent and &false; if the context is non-persistent. - - - - - - - diff --git a/reference/zmq/zmqcontext/setopt.xml b/reference/zmq/zmqcontext/setopt.xml deleted file mode 100644 index 15a42ccb857c..000000000000 --- a/reference/zmq/zmqcontext/setopt.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - ZMQContext::setOpt - Set a socket option - - - - &reftitle.description; - - public ZMQContextZMQContext::setOpt - intkey - mixedvalue - - - Sets a ZMQ context option. The type of the value depends on the key. - See ZMQ Constant Types for more information. - - - - - &reftitle.parameters; - - - - key - - - One of the ZMQ::CTXOPT_* constants. - - - - - value - - - The value of the parameter. - - - - - - - - - &reftitle.returnvalues; - - Returns the current object. Throws ZMQContextException on error. - - - - - - - diff --git a/reference/zmq/zmqcontextexception.xml b/reference/zmq/zmqcontextexception.xml deleted file mode 100644 index 8e744abec2b1..000000000000 --- a/reference/zmq/zmqcontextexception.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - The ZMQContextException class - ZMQContextException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - ZMQContextException - - - - - ZMQContextException - - - - extends - ZMQException - - - - &Properties; - - - &InheritedMethods; - - - - - -
    - - - -
    - &reftitle.properties; - - - message - - - - - - code - - - - - - file - - - - - - line - - - - - -
    - - - -
    - -
    - - diff --git a/reference/zmq/zmqdevice.xml b/reference/zmq/zmqdevice.xml deleted file mode 100644 index 0f3c0da36af8..000000000000 --- a/reference/zmq/zmqdevice.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - The ZMQDevice class - ZMQDevice - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - ZMQDevice - - - - - ZMQDevice - - - - - &Methods; - - - - -
    - -
    - - &reference.zmq.entities.zmqdevice; - -
    - - diff --git a/reference/zmq/zmqdevice/construct.xml b/reference/zmq/zmqdevice/construct.xml deleted file mode 100644 index 98d6c044da50..000000000000 --- a/reference/zmq/zmqdevice/construct.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - ZMQDevice::__construct - Construct a new device - - - - &reftitle.description; - - public ZMQDevice::__construct - ZMQSocketfrontend - ZMQSocketbackend - ZMQSocketlistener - - - "ØMQ devices can do intermediation of addresses, services, queues, or any other abstraction you care to define above the message and socket layers." -- zguide - - - - - &reftitle.parameters; - - - frontend - - - Frontend parameter for the devices. Usually where there messages - are coming. - - - - - backend - - - Backend parameter for the devices. Usually where there messages - going to. - - - - - listener - - - Listener socket, which receives a copy of all messages going both directions. - The type of this socket should be SUB, PULL or DEALER. - - - - - - - - &reftitle.returnvalues; - - Call to this method will prepare the device. Usually devices are very long - running processes so running this method from interactive script is not recommended. This - method throw ZMQDeviceException if the device cannot be started. - - - - - - - diff --git a/reference/zmq/zmqdevice/getidletimeout.xml b/reference/zmq/zmqdevice/getidletimeout.xml deleted file mode 100644 index 90d70b05f099..000000000000 --- a/reference/zmq/zmqdevice/getidletimeout.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - ZMQDevice::getIdleTimeout - Get the idle timeout - - - - &reftitle.description; - - public ZMQDeviceZMQDevice::getIdleTimeout - - - - Gets the idle callback timeout value. Added in ZMQ extension version 1.1.0. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - This method returns the idle callback timeout value. - - - - - - diff --git a/reference/zmq/zmqdevice/gettimertimeout.xml b/reference/zmq/zmqdevice/gettimertimeout.xml deleted file mode 100644 index 535b197399cb..000000000000 --- a/reference/zmq/zmqdevice/gettimertimeout.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - ZMQDevice::getTimerTimeout - Get the timer timeout - - - - &reftitle.description; - - public ZMQDeviceZMQDevice::getTimerTimeout - - - - Gets the timer callback timeout value. Added in ZMQ extension version 1.1.0. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - This method returns the timer timeout value. - - - - - - diff --git a/reference/zmq/zmqdevice/run.xml b/reference/zmq/zmqdevice/run.xml deleted file mode 100644 index 06ff8c2f99c4..000000000000 --- a/reference/zmq/zmqdevice/run.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - ZMQDevice::run - Run the new device - - - - &reftitle.description; - - public voidZMQDevice::run - - - - Runs the device. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Call to this method will block until the device is running. It is not recommended - that devices are used from interactive scripts. On failure this method will throw - ZMQDeviceException. - - - - - - - diff --git a/reference/zmq/zmqdevice/setidlecallback.xml b/reference/zmq/zmqdevice/setidlecallback.xml deleted file mode 100644 index 0ea5342bb6dd..000000000000 --- a/reference/zmq/zmqdevice/setidlecallback.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - ZMQDevice::setIdleCallback - Set the idle callback function - - - - &reftitle.description; - - public ZMQDeviceZMQDevice::setIdleCallback - callablecb_func - inttimeout - mixeduser_data - - - Sets the idle callback function. If idle timeout is defined the idle callback function - shall be called if the internal poll loop times out without events. If the callback function - returns false or a value that evaluates to false the device is stopped. - - The callback function signature is callback (mixed $user_data). - - - - - &reftitle.parameters; - - - cb_func - - - Callback function to invoke when the device is idle. Returning false - or a value that evaluates to false from this function will cause the - device to stop. - - - - - timeout - - - How often to invoke the idle callback in milliseconds. The idle callback is invoked - periodically when there is no activity on the device. - The timeout value guarantees that there is at least this amount of milliseconds between - invocations of the callback function. - - - - - user_data - - - Additional data to pass to the callback function. - - - - - - - - &reftitle.returnvalues; - - On success this method returns the current object. - - - - - - - diff --git a/reference/zmq/zmqdevice/setidletimeout.xml b/reference/zmq/zmqdevice/setidletimeout.xml deleted file mode 100644 index 2f046330cbd6..000000000000 --- a/reference/zmq/zmqdevice/setidletimeout.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - ZMQDevice::setIdleTimeout - Set the idle timeout - - - - &reftitle.description; - - public ZMQDeviceZMQDevice::setIdleTimeout - inttimeout - - - Sets the idle callback timeout value. The idle callback is invoked periodically when the device is - idle. - - - - - &reftitle.parameters; - - - timeout - - - The idle callback timeout value. - - - - - - - - &reftitle.returnvalues; - - On success this method returns the current object. - - - - - - - diff --git a/reference/zmq/zmqdevice/settimercallback.xml b/reference/zmq/zmqdevice/settimercallback.xml deleted file mode 100644 index ee71791076dc..000000000000 --- a/reference/zmq/zmqdevice/settimercallback.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - ZMQDevice::setTimerCallback - Set the timer callback function - - - - &reftitle.description; - - public ZMQDeviceZMQDevice::setTimerCallback - callablecb_func - inttimeout - mixeduser_data - - - Sets the timer callback function. The timer callback will be invoked after timeout has - passed. The difference between idle and timer callbacks are that idle callback is invoked - only when the device is idle. - - The callback function signature is callback (mixed $user_data). Added in ZMQ extension version 1.1.0. - - - - - &reftitle.parameters; - - - cb_func - - - Callback function to invoke when the timer fires. Returning false - or a value that evaluates to false from this function will cause the - device to stop. - - - - - timeout - - - How often to invoke the timer callback in milliseconds. The timer callback is invoked - periodically. - The timeout value guarantees that there is at least this amount of milliseconds between - invocations of the callback function. - - - - - user_data - - - Additional data to pass to the callback function. - - - - - - - - &reftitle.returnvalues; - - On success this method returns the current object. - - - - - - - diff --git a/reference/zmq/zmqdevice/settimertimeout.xml b/reference/zmq/zmqdevice/settimertimeout.xml deleted file mode 100644 index 269d0e8e03c7..000000000000 --- a/reference/zmq/zmqdevice/settimertimeout.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - ZMQDevice::setTimerTimeout - Set the timer timeout - - - - &reftitle.description; - - public ZMQDeviceZMQDevice::setTimerTimeout - inttimeout - - - Sets the timer callback timeout value. The timer callback is invoked periodically if it's set. - Added in ZMQ extension version 1.1.0. - - - - - &reftitle.parameters; - - - timeout - - - The timer callback timeout value. - - - - - - - - &reftitle.returnvalues; - - On success this method returns the current object. - - - - - - - diff --git a/reference/zmq/zmqdeviceexception.xml b/reference/zmq/zmqdeviceexception.xml deleted file mode 100644 index e95f91086f7d..000000000000 --- a/reference/zmq/zmqdeviceexception.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - The ZMQDeviceException class - ZMQDeviceException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - ZMQDeviceException - - - - - ZMQDeviceException - - - - extends - ZMQException - - - - &Properties; - - - &InheritedMethods; - - - - - -
    - - - -
    - &reftitle.properties; - - - message - - - - - - code - - - - - - file - - - - - - line - - - - - -
    - - - -
    - -
    - - diff --git a/reference/zmq/zmqexception.xml b/reference/zmq/zmqexception.xml deleted file mode 100644 index 3e13057ef24e..000000000000 --- a/reference/zmq/zmqexception.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - The ZMQException class - ZMQException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - ZMQException - - - - - ZMQException - - - - extends - Exception - - - - &Properties; - - - &InheritedMethods; - - - - - -
    - - - -
    - &reftitle.properties; - - - message - - - - - - code - - - - - - file - - - - - - line - - - - - -
    - - - -
    - -
    - - diff --git a/reference/zmq/zmqpoll.xml b/reference/zmq/zmqpoll.xml deleted file mode 100644 index 512c0e41c71e..000000000000 --- a/reference/zmq/zmqpoll.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - The ZMQPoll class - ZMQPoll - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - ZMQPoll - - - - - ZMQPoll - - - - - &Methods; - - - - -
    - -
    - - &reference.zmq.entities.zmqpoll; - -
    - - diff --git a/reference/zmq/zmqpoll/add.xml b/reference/zmq/zmqpoll/add.xml deleted file mode 100644 index d75662f7c462..000000000000 --- a/reference/zmq/zmqpoll/add.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - ZMQPoll::add - Add item to the poll set - - - - &reftitle.description; - - public stringZMQPoll::add - mixedentry - inttype - - - Adds a new item to the poll set and returns the internal id of the added item. The item can be removed - from the poll set using the returned string id. - - - - - &reftitle.parameters; - - - - entry - - - ZMQSocket object or a PHP stream resource - - - - - type - - - Defines what activity the socket is polled for. - See ZMQ::POLL_IN and ZMQ::POLL_OUT constants. - - - - - - - - - &reftitle.returnvalues; - - Returns a string id of the added item which can be later used to remove the item. - Throws ZMQPollException on error. - - - - - - - diff --git a/reference/zmq/zmqpoll/clear.xml b/reference/zmq/zmqpoll/clear.xml deleted file mode 100644 index 8e78a4939a77..000000000000 --- a/reference/zmq/zmqpoll/clear.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - ZMQPoll::clear - Clear the poll set - - - - &reftitle.description; - - public ZMQPollZMQPoll::clear - - - - Clears all elements from the poll set. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the current object. - - - - - - - diff --git a/reference/zmq/zmqpoll/count.xml b/reference/zmq/zmqpoll/count.xml deleted file mode 100644 index 2bc78c0aafb6..000000000000 --- a/reference/zmq/zmqpoll/count.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - ZMQPoll::count - Count items in the poll set - - - - &reftitle.description; - - public intZMQPoll::count - - - - Count the items in the poll set. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an &integer; representing the amount of items in the poll set. - - - - - - - diff --git a/reference/zmq/zmqpoll/getlasterrors.xml b/reference/zmq/zmqpoll/getlasterrors.xml deleted file mode 100644 index fa2dbc1e6233..000000000000 --- a/reference/zmq/zmqpoll/getlasterrors.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - ZMQPoll::getLastErrors - Get poll errors - - - - &reftitle.description; - - public arrayZMQPoll::getLastErrors - - - - Returns the ids of the objects that had errors in the last poll. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an array containing ids for the items that had errors in the last poll. Empty array is - returned if there were no errors. - - - - - - - diff --git a/reference/zmq/zmqpoll/poll.xml b/reference/zmq/zmqpoll/poll.xml deleted file mode 100644 index 58325577d42f..000000000000 --- a/reference/zmq/zmqpoll/poll.xml +++ /dev/null @@ -1,172 +0,0 @@ - - - - - - ZMQPoll::poll - Poll the items - - - - &reftitle.description; - - public intZMQPoll::poll - arrayreadable - arraywritable - inttimeout-1 - - - Polls the items in the current poll set. The readable and writable items are returned in the - readable and writable parameters. - ZMQPoll::getLastErrors can be used to check if there were errors. - - - - - &reftitle.parameters; - - - - readable - - - Array where readable ZMQSockets/PHP streams are returned. The array - will be cleared at the beginning of the operation. - - - - - writable - - - Array where writable ZMQSockets/PHP streams are returned. The array - will be cleared at the beginning of the operation. - - - - - timeout - - - Timeout for the operation. -1 means that poll waits until - at least one item has activity. Please note that starting from - version 1.0.0 the poll timeout is defined in milliseconds, rather - than microseconds. - - - - - - - - - &reftitle.returnvalues; - - Returns an integer representing the amount of items with activity. - - - - - &reftitle.errors; - - Throws ZMQPollException on error. - - - - - &reftitle.examples; - - - A <function>ZMQPoll</function> example - - Create a simple poll server - - -getSocket(ZMQ::SOCKET_REP); - -/* Bind to port 5555 on 127.0.0.1 */ -$server->bind("tcp://127.0.0.1:5555"); - -/* Create new pollset for incoming/outgoing message */ -$poll = new ZMQPoll(); - -/* Add the object and listen for poll in/out */ -$id = $poll->add($server, ZMQ::POLL_IN | ZMQ::POLL_OUT); -echo "Added object with id " . $id . "\n"; - -/* Initialise readable and writable arrays */ -$readable = array(); -$writable = array(); - -while (true) { - /* Amount of events retrieved */ - $events = 0; - - try { - /* Poll until there is something to do */ - $events = $poll->poll($readable, $writable, -1); - $errors = $poll->getLastErrors(); - - if (count($errors) > 0) { - foreach ($errors as $error) { - echo "Error polling object " . $error . "\n"; - } - } - } catch (ZMQPollException $e) { - echo "poll failed: " . $e->getMessage() . "\n"; - } - - if ($events > 0) { - /* Loop through readable objects and recv messages */ - foreach ($readable as $r) { - try { - echo "Received message: " . $r->recv() . "\n"; - } catch (ZMQException $e) { - echo "recv failed: " . $e->getMessage() . "\n"; - } - } - - /* Loop through writable and send back messages */ - foreach ($writable as $w) { - try { - $w->send("Got it!"); - } catch (ZMQException $e) { - echo "send failed: " . $e->getMessage() . "\n"; - } - } - } -} -?> -]]> - - - - - - - - diff --git a/reference/zmq/zmqpoll/remove.xml b/reference/zmq/zmqpoll/remove.xml deleted file mode 100644 index f7dfdcce6172..000000000000 --- a/reference/zmq/zmqpoll/remove.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - ZMQPoll::remove - Remove item from poll set - - - - &reftitle.description; - - public boolZMQPoll::remove - mixeditem - - - Remove item from the poll set. The item parameter can be ZMQSocket object, - a stream resource or the id returned from ZMQPoll::add method. - - - - - &reftitle.parameters; - - - - item - - - The ZMQSocket object, PHP stream or &string; id of the item. - - - - - - - - - &reftitle.returnvalues; - - Returns true if the item was removed and false if the object - with given id does not exist in the poll set. - - - - - - - diff --git a/reference/zmq/zmqpollexception.xml b/reference/zmq/zmqpollexception.xml deleted file mode 100644 index ef8a93989741..000000000000 --- a/reference/zmq/zmqpollexception.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - The ZMQPollException class - ZMQPollException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - ZMQPollException - - - - - ZMQPollException - - - - extends - ZMQException - - - - &Properties; - - - &InheritedMethods; - - - - - -
    - - - -
    - &reftitle.properties; - - - message - - - - - - code - - - - - - file - - - - - - line - - - - - -
    - - - -
    - -
    - - diff --git a/reference/zmq/zmqsocket.xml b/reference/zmq/zmqsocket.xml deleted file mode 100644 index b31f6ef0b703..000000000000 --- a/reference/zmq/zmqsocket.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - The ZMQSocket class - ZMQSocket - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - ZMQSocket - - - - - ZMQSocket - - - - - &Methods; - - - - -
    - -
    - - &reference.zmq.entities.zmqsocket; - -
    - - diff --git a/reference/zmq/zmqsocket/bind.xml b/reference/zmq/zmqsocket/bind.xml deleted file mode 100644 index 92a66e3cbe11..000000000000 --- a/reference/zmq/zmqsocket/bind.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - ZMQSocket::bind - Bind the socket - - - - &reftitle.description; - - public ZMQSocketZMQSocket::bind - stringdsn - boolforce&false; - - - Bind the socket to an endpoint. The endpoint is defined in format transport://address where - transport is one of the following: inproc, ipc, tcp, pgm or epgm. - - - - - &reftitle.parameters; - - - - dsn - - - The bind dsn, for example transport://address. - - - - - force - - - Tries to bind even if the socket has already been bound to the given endpoint. - - - - - - - - - &reftitle.returnvalues; - - Returns the current object. Throws ZMQSocketException on error. - - - - - - - diff --git a/reference/zmq/zmqsocket/connect.xml b/reference/zmq/zmqsocket/connect.xml deleted file mode 100644 index fe6612f5ffed..000000000000 --- a/reference/zmq/zmqsocket/connect.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - ZMQSocket::connect - Connect the socket - - - - &reftitle.description; - - public ZMQSocketZMQSocket::connect - stringdsn - boolforce&false; - - - Connect the socket to a remote endpoint. The endpoint is defined in format transport://address where - transport is one of the following: inproc, ipc, tcp, pgm or epgm. - - - - - &reftitle.parameters; - - - - dsn - - - The connect dsn, for example transport://address. - - - - - force - - - Tries to connect even if the socket has already been connected to given endpoint. - - - - - - - - - &reftitle.returnvalues; - - Returns the current object. - - - - - &reftitle.errors; - - Throws ZMQSocketException on error. - - - - - &reftitle.examples; - - - A <function>ZMQContext</function> example - - Construct a new context and allocate request socket from it - - -getEndpoints(); - -/* Check if the socket is connected */ -if (!in_array($dsn, $endpoints['connect'])) { - echo "

    Connecting to $dsn

    "; - $socket->connect($dsn); -} else { - echo "

    Already connected to $dsn

    "; -} - -/* Send and receive */ -$socket->send("Hello!"); -$message = $socket->recv(); - -echo "

    Server said: {$message}

    "; -?> -]]> -
    -
    -
    -
    - -
    - - diff --git a/reference/zmq/zmqsocket/construct.xml b/reference/zmq/zmqsocket/construct.xml deleted file mode 100644 index b6f7a2cad176..000000000000 --- a/reference/zmq/zmqsocket/construct.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - ZMQSocket::__construct - Construct a new ZMQSocket - - - - &reftitle.description; - - public ZMQSocket::__construct - ZMQContextcontext - inttype - stringpersistent_id&null; - callableon_new_socket&null; - - - Constructs a ZMQSocket object. persistent_id parameter can be used to allocated a persistent - socket. A persistent socket has to be allocated from a persistent context and it stays connected over multiple requests. - The persistent_id parameter can be used to recall the same socket over multiple requests. The - on_new_socket is called only when a new underlying socket structure is created. - - - - - &reftitle.parameters; - - - - context - - - ZMQContext object. - - - - - type - - - The socket type. See ZMQ::SOCKET_* constants. - - - - - persistent_id - - - If persistent_id is specified the socket will be persisted over multiple requests. - If context is not persistent the socket falls back to non-persistent mode. - - - - - on_new_socket - - - Callback function, which is executed when a new socket structure is created. This function does not get invoked - if the underlying persistent connection is re-used. - - - callback - ZMQSocketsocket - stringpersistent_id&null; - - - - - - - - - &reftitle.errors; - - Throws ZMQSocketException on error. - - - - - &reftitle.examples; - - - A <function>ZMQSocket</function> example - - Using callback the bind/connect socket - - -bind("tcp://localhost:12122"); - } else { - $socket->connect("tcp://localhost:12122"); - } -} - -/* Allocate a new context */ -$context = new ZMQContext(); - -/* Create a new socket */ -$socket = $context->getSocket(ZMQ::SOCKET_REP, 'server', 'on_new_socket_cb'); - -$message = $socket->recv(); -echo "Received message: {$message}\n"; -?> -]]> - - - - - - - - diff --git a/reference/zmq/zmqsocket/disconnect.xml b/reference/zmq/zmqsocket/disconnect.xml deleted file mode 100644 index 2b499c6b164f..000000000000 --- a/reference/zmq/zmqsocket/disconnect.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - ZMQSocket::disconnect - Disconnect a socket - - - - &reftitle.description; - - public ZMQSocketZMQSocket::disconnect - stringdsn - - - Disconnect the socket from a previously connected remote endpoint. The endpoint is defined in format - transport://address where transport is one of the following: inproc, ipc, tcp, pgm or epgm. - - - - - &reftitle.parameters; - - - - dsn - - - The connect dsn, for example transport://address. - - - - - - - - - &reftitle.returnvalues; - - Returns the current object. Throws ZMQSocketException on error. - - - - - - diff --git a/reference/zmq/zmqsocket/getendpoints.xml b/reference/zmq/zmqsocket/getendpoints.xml deleted file mode 100644 index bc0a84698e39..000000000000 --- a/reference/zmq/zmqsocket/getendpoints.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - ZMQSocket::getEndpoints - Get list of endpoints - - - - &reftitle.description; - - public arrayZMQSocket::getEndpoints - - - - Returns a list of endpoints where the socket is connected or bound to. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an array containing elements 'bind' and 'connect'. - - - - - - diff --git a/reference/zmq/zmqsocket/getpersistentid.xml b/reference/zmq/zmqsocket/getpersistentid.xml deleted file mode 100644 index c05ed4293090..000000000000 --- a/reference/zmq/zmqsocket/getpersistentid.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - ZMQSocket::getPersistentId - Get the persistent id - - - - &reftitle.description; - - public stringZMQSocket::getPersistentId - - - - Returns the persistent id of the socket. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the persistent id string assigned of the object and &null; if socket is not persistent. - - - - - - - diff --git a/reference/zmq/zmqsocket/getsockettype.xml b/reference/zmq/zmqsocket/getsockettype.xml deleted file mode 100644 index c4770fd9c2c0..000000000000 --- a/reference/zmq/zmqsocket/getsockettype.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - ZMQSocket::getSocketType - Get the socket type - - - - &reftitle.description; - - public intZMQSocket::getSocketType - - - - Gets the socket type. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an integer representing the socket type. The integer can be compared against - ZMQ::SOCKET_* constants. - - - - - - - diff --git a/reference/zmq/zmqsocket/getsockopt.xml b/reference/zmq/zmqsocket/getsockopt.xml deleted file mode 100644 index 1630f353d2e7..000000000000 --- a/reference/zmq/zmqsocket/getsockopt.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - ZMQSocket::getSockOpt - Get socket option - - - - &reftitle.description; - - public mixedZMQSocket::getSockOpt - stringkey - - - Returns the value of a socket option. - - - - - &reftitle.parameters; - - - - key - - - An integer representing the option. - See the ZMQ::SOCKOPT_* constants. - - - - - - - - - &reftitle.returnvalues; - - Returns either a &string; or an &integer; depending on key. Throws - ZMQSocketException on error. - - - - - - - diff --git a/reference/zmq/zmqsocket/ispersistent.xml b/reference/zmq/zmqsocket/ispersistent.xml deleted file mode 100644 index 0d7e31c0cecf..000000000000 --- a/reference/zmq/zmqsocket/ispersistent.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - ZMQSocket::isPersistent - Whether the socket is persistent - - - - &reftitle.description; - - public boolZMQSocket::isPersistent - - - - Check whether the socket is persistent. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a &boolean; based on whether the socket is persistent or not. - - - - - - - diff --git a/reference/zmq/zmqsocket/recv.xml b/reference/zmq/zmqsocket/recv.xml deleted file mode 100644 index 1800d9aa5c3a..000000000000 --- a/reference/zmq/zmqsocket/recv.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - ZMQSocket::recv - Receives a message - - - - &reftitle.description; - - public stringZMQSocket::recv - intmode0 - - - Receive a message from a socket. By default receiving will block until a message is available unless - ZMQ::MODE_DONTWAIT flag is used. ZMQ::SOCKOPT_RCVMORE - socket option can be used for receiving multi-part messages. See ZMQSocket::setSockOpt - for more information. - - - - - &reftitle.parameters; - - - - mode - - - Pass mode flags to receive multipart messages or non-blocking operation. - See ZMQ::MODE_* constants. - - - - - - - - - &reftitle.returnvalues; - - Returns the message. If ZMQ::MODE_DONTWAIT - is used and the operation would block &false; shall be returned. - - - - - &reftitle.errors; - - Throws ZMQSocketException on error. - - - - - &reftitle.examples; - - - A send/recv example - - Non-blocking send / receive - - -connect("tcp://127.0.0.1:5555"); - -/* Assign socket 1 to the queue, send and receive */ -$retries = 5; -$sending = true; - -/* Start a loop */ -do { - try { - /* Try to send / receive */ - if ($sending) { - echo "Sending message\n"; - $queue->send("This is a message", ZMQ::MODE_DONTWAIT); - $sending = false; - } else { - echo "Got response: " . $queue->recv(ZMQ::MODE_DONTWAIT) . "\n"; - break; - } - } catch (ZMQSocketException $e) { - /* EAGAIN means that the operation would have blocked, retry */ - if ($e->getCode() === ZMQ::ERR_EAGAIN) { - echo " - Got EAGAIN, retrying ($retries)\n"; - } else { - die(" - Error: " . $e->getMessage()); - } - } - /* Sleep a bit between operations */ - usleep(5); -} while (--$retries); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/zmq/zmqsocket/recvmulti.xml b/reference/zmq/zmqsocket/recvmulti.xml deleted file mode 100644 index a080bb9f085c..000000000000 --- a/reference/zmq/zmqsocket/recvmulti.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - ZMQSocket::recvMulti - Receives a multipart message - - - - &reftitle.description; - - public arrayZMQSocket::recvMulti - intmode0 - - - Receive an array multipart message from a socket. By default receiving will block until a message is available unless - ZMQ::MODE_NOBLOCK flag is used. - - - - - &reftitle.parameters; - - - - mode - - - Pass mode flags to receive multipart messages or non-blocking operation. - See ZMQ::MODE_* constants. - - - - - - - - - &reftitle.returnvalues; - - Returns the array of message parts. Throws ZMQSocketException in error. - If ZMQ::MODE_NOBLOCK is used and the operation would - block &boolean; false shall be returned. - - - - - - - diff --git a/reference/zmq/zmqsocket/send.xml b/reference/zmq/zmqsocket/send.xml deleted file mode 100644 index f8adc4f3fd94..000000000000 --- a/reference/zmq/zmqsocket/send.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - ZMQSocket::send - Sends a message - - - - &reftitle.description; - - public ZMQSocketZMQSocket::send - stringmessage - intmode0 - - - Send a message using the socket. The operation can block unless ZMQ::MODE_NOBLOCK is used. - - - - - &reftitle.parameters; - - - - message - - - The message to send. - - - - - mode - - - Pass mode flags to receive multipart messages or non-blocking operation. - See ZMQ::MODE_* constants. - - - - - - - - - &reftitle.returnvalues; - - Returns the current object. Throws ZMQSocketException on error. - If ZMQ::MODE_NOBLOCK is used and the operation would - block &boolean; false shall be returned. - - - - - diff --git a/reference/zmq/zmqsocket/sendmulti.xml b/reference/zmq/zmqsocket/sendmulti.xml deleted file mode 100644 index 4e5b33265a15..000000000000 --- a/reference/zmq/zmqsocket/sendmulti.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - ZMQSocket::sendmulti - Sends a multipart message - - - - &reftitle.description; - - public ZMQSocketZMQSocket::sendmulti - arraymessage - intmode0 - - - Send a multipart message using the socket. The operation can block unless ZMQ::MODE_NOBLOCK is used. - - - - - &reftitle.parameters; - - - - message - - - The message to send - an array of strings - - - - - mode - - - Pass mode flags to receive multipart messages or non-blocking operation. - See ZMQ::MODE_* constants. - - - - - - - - - &reftitle.returnvalues; - - Returns the current object. Throws ZMQSocketException on error. - If ZMQ::MODE_NOBLOCK is used and the operation would - block &boolean; false shall be returned. - - - - - diff --git a/reference/zmq/zmqsocket/setsockopt.xml b/reference/zmq/zmqsocket/setsockopt.xml deleted file mode 100644 index 0a826c248252..000000000000 --- a/reference/zmq/zmqsocket/setsockopt.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - ZMQSocket::setSockOpt - Set a socket option - - - - &reftitle.description; - - public ZMQSocketZMQSocket::setSockOpt - intkey - mixedvalue - - - Sets a ZMQ socket option. The type of the value depends on the key. - See ZMQ Constant Types for more information. - - - - - &reftitle.parameters; - - - - key - - - One of the ZMQ::SOCKOPT_* constants. - - - - - value - - - The value of the parameter. - - - - - - - - - &reftitle.returnvalues; - - Returns the current object. Throws ZMQSocketException on error. - - - - - - - diff --git a/reference/zmq/zmqsocket/unbind.xml b/reference/zmq/zmqsocket/unbind.xml deleted file mode 100644 index 60eda037f379..000000000000 --- a/reference/zmq/zmqsocket/unbind.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - ZMQSocket::unbind - Unbind the socket - - - - &reftitle.description; - - public ZMQSocketZMQSocket::unbind - stringdsn - - - Unbind the socket from an endpoint. The endpoint is defined in format transport://address where - transport is one of the following: inproc, ipc, tcp, pgm or epgm. - - - - - &reftitle.parameters; - - - - dsn - - - The previously bound dsn, for example transport://address. - - - - - - - - - &reftitle.returnvalues; - - Returns the current object. Throws ZMQSocketException on error. - - - - - - - diff --git a/reference/zmq/zmqsocketexception.xml b/reference/zmq/zmqsocketexception.xml deleted file mode 100644 index edd00f49f73d..000000000000 --- a/reference/zmq/zmqsocketexception.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - The ZMQSocketException class - ZMQSocketException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - ZMQSocketException - - - - - ZMQSocketException - - - - extends - ZMQException - - - - &Properties; - - - &InheritedMethods; - - - - - -
    - - - -
    - &reftitle.properties; - - - message - - - - - - code - - - - - - file - - - - - - line - - - - - -
    - - - -
    - -
    - - diff --git a/reference/zookeeper/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md b/reference/zookeeper/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md deleted file mode 100644 index acfdeb7ed6b8..000000000000 --- a/reference/zookeeper/MOVING_TO_DOC_EXTENSIONS_DO_NOT_CHANGE_HERE.md +++ /dev/null @@ -1,11 +0,0 @@ -# This extension is moving to php/doc-extensions - -Per [the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), -the documentation for this extension is being migrated to the [php/doc-extensions](https://github.com/php/doc-extensions) repository. - -**Do not make changes to this extension's documentation in doc-en.** -Any changes made here after this file was added will be discarded during the migration. -Please direct all contributions to [php/doc-extensions](https://github.com/php/doc-extensions) instead. - -The migration plan and progress are tracked in [php/doc-extensions#13](https://github.com/php/doc-extensions/issues/13), -and the final list of migrated extensions in [php/doc-extensions#12](https://github.com/php/doc-extensions/issues/12). diff --git a/reference/zookeeper/book.xml b/reference/zookeeper/book.xml deleted file mode 100644 index e3b9a21eddbb..000000000000 --- a/reference/zookeeper/book.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - ZooKeeper - ZooKeeper - - - - &reftitle.intro; - - This extension uses libzookeeper library to provide API for communicating with ZooKeeper service. - - - ZooKeeper is an Apache project that enables centralized service for maintaining configuration information, naming, providing distributed synchronization, and providing group services. - - - - - &reference.zookeeper.setup; - - &reference.zookeeper.reference; - - &reference.zookeeper.zookeeper; - &reference.zookeeper.zookeeperconfig; - - &reference.zookeeper.zookeeperexception; - &reference.zookeeper.zookeeperauthenticationexception; - &reference.zookeeper.zookeeperconnectionexception; - &reference.zookeeper.zookeepermarshallingexception; - &reference.zookeeper.zookeepernonodeexception; - &reference.zookeeper.zookeeperoperationtimeoutexception; - &reference.zookeeper.zookeepersessionexception; - - - - - diff --git a/reference/zookeeper/configure.xml b/reference/zookeeper/configure.xml deleted file mode 100644 index dec2af8721a1..000000000000 --- a/reference/zookeeper/configure.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - -
    - &reftitle.install; - - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;zookeeper. - - - - To enable zookeeper support, configure with - . DIR is the install prefix of ZooKeeper C Binding, which must contain the include/zookeeper/zookeeper.h - - - &pecl.windows.download; - -
    - - - diff --git a/reference/zookeeper/functions/zookeeper_dispatch.xml b/reference/zookeeper/functions/zookeeper_dispatch.xml deleted file mode 100644 index 6e248f2b681e..000000000000 --- a/reference/zookeeper/functions/zookeeper_dispatch.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - zookeeper_dispatch - Calls callbacks for pending operations - - - - &reftitle.description; - - voidzookeeper_dispatch - - - - - The zookeeper_dispatch function calls the callbacks passed by operations like Zookeeper::get or Zookeeper::exists. - - - - - Since version 0.4.0, this function must be called manually to achieve asynchronous operations. If you want that to be done automatically, you also can declare ticks at the beginning of your program. - - - - - After PHP 7.1, you can ignore this function. This extension uses EG(vm_interrupt) to implement async dispatch. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - This method emits PHP warning when callback could not be invoked. - - - - - &reftitle.examples; - - <methodname>zookeeper_dispatch</methodname> example #1 - - Dispatch callbacks manually. - - -connect('localhost:2181'); -$client->get('/zookeeper', function() { - echo "Callback was called".PHP_EOL; -}); -while(true) { - sleep(1); - zookeeper_dispatch(); -} -?> -]]> - - - - - <methodname>zookeeper_dispatch</methodname> example #2 - - Declare ticks. - - -connect('localhost:2181'); -$client->get('/zookeeper', function() { - echo "Callback was called".PHP_EOL; -}); -while(true) { - sleep(1); -} -?> -]]> - - - - - - &reftitle.seealso; - - - Zookeeper::addAuth - Zookeeper::connect - Zookeeper::__construct - Zookeeper::exists - Zookeeper::get - Zookeeper::getChildren - Zookeeper::setWatcher - - - - - - - diff --git a/reference/zookeeper/ini.xml b/reference/zookeeper/ini.xml deleted file mode 100644 index 93fd72812fbe..000000000000 --- a/reference/zookeeper/ini.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - -
    - &reftitle.runtime; - &extension.runtime; - - - - Zookeeper &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - zookeeper.recv_timeout - 10000 - INI_ALL - - - - zookeeper.session_lock - 1 - INI_SYSTEM - - - - zookeeper.sess_lock_wait - 150000 - INI_ALL - - - - -
    - - &ini.php.constants; - -
    - - &ini.descriptions.title; - - - - - - - zookeeper.recv_timeout - int - - - - Default the timeout for any ZooKeeper session. - - - - - - - zookeeper.session_lock - int - - - - Enable PHP session locking. - - - - - - - zookeeper.sess_lock_wait - int - - - - PHP Session spin lock retry wait time in microseconds. Be careful when setting this value. Valid values are integers, where 0 is interpreted as the default value. Negative values result in a reduces locking to a try lock. - - - - - - -
    - - - diff --git a/reference/zookeeper/reference.xml b/reference/zookeeper/reference.xml deleted file mode 100644 index 5a88422bcbce..000000000000 --- a/reference/zookeeper/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - ZooKeeper &Functions; - - &reference.zookeeper.entities.functions; - - - - diff --git a/reference/zookeeper/setup.xml b/reference/zookeeper/setup.xml deleted file mode 100644 index 193091963ceb..000000000000 --- a/reference/zookeeper/setup.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - &reftitle.setup; - - -
    - &reftitle.required; - - This extension requires ZooKeeper C Binding (version 3.4.1 or greater). - For more information, see ZooKeeper Programmer's Guide. - -
    - - - - &reference.zookeeper.configure; - - - - - &reference.zookeeper.ini; - - -
    - - - diff --git a/reference/zookeeper/versions.xml b/reference/zookeeper/versions.xml deleted file mode 100644 index b5fe4c36a056..000000000000 --- a/reference/zookeeper/versions.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/zookeeper/zookeeper.xml b/reference/zookeeper/zookeeper.xml deleted file mode 100644 index 87c76c403e35..000000000000 --- a/reference/zookeeper/zookeeper.xml +++ /dev/null @@ -1,827 +0,0 @@ - - - - - The Zookeeper class - Zookeeper - - - - -
    - &reftitle.intro; - - Represents ZooKeeper session. - -
    - - -
    - &reftitle.classsynopsis; - - - - Zookeeper - - - - - Zookeeper - - - - - - - &Methods; - - - - - - &Constants; - - const - int - PERM_READ - 1 - - - const - int - PERM_WRITE - 2 - - - const - int - PERM_CREATE - 4 - - - const - int - PERM_DELETE - 8 - - - const - int - PERM_ADMIN - 16 - - - const - int - PERM_ALL - 31 - - - - const - int - EPHEMERAL - 1 - - - const - int - SEQUENCE - 2 - - - - const - int - LOG_LEVEL_ERROR - 1 - - - const - int - LOG_LEVEL_WARN - 2 - - - const - int - LOG_LEVEL_INFO - 3 - - - const - int - LOG_LEVEL_DEBUG - 4 - - - - const - int - EXPIRED_SESSION_STATE - -112 - - - const - int - AUTH_FAILED_STATE - -113 - - - const - int - CONNECTING_STATE - 1 - - - const - int - ASSOCIATING_STATE - 2 - - - const - int - CONNECTED_STATE - 3 - - - const - int - READONLY_STATE - 5 - - - const - int - NOTCONNECTED_STATE - 999 - - - - const - int - CREATED_EVENT - 1 - - - const - int - DELETED_EVENT - 2 - - - const - int - CHANGED_EVENT - 3 - - - const - int - CHILD_EVENT - 4 - - - const - int - SESSION_EVENT - -1 - - - const - int - NOTWATCHING_EVENT - -2 - - - - const - int - SYSTEMERROR - -1 - - - const - int - RUNTIMEINCONSISTENCY - -2 - - - const - int - DATAINCONSISTENCY - -3 - - - const - int - CONNECTIONLOSS - -4 - - - const - int - MARSHALLINGERROR - -5 - - - const - int - UNIMPLEMENTED - -6 - - - const - int - OPERATIONTIMEOUT - -7 - - - const - int - BADARGUMENTS - -8 - - - const - int - INVALIDSTATE - -9 - - - const - int - NEWCONFIGNOQUORUM - -13 - - - const - int - RECONFIGINPROGRESS - -14 - - - - const - int - OK - 0 - - - const - int - APIERROR - -100 - - - const - int - NONODE - -101 - - - const - int - NOAUTH - -102 - - - const - int - BADVERSION - -103 - - - const - int - NOCHILDRENFOREPHEMERALS - -108 - - - const - int - NODEEXISTS - -110 - - - const - int - NOTEMPTY - -111 - - - const - int - SESSIONEXPIRED - -112 - - - const - int - INVALIDCALLBACK - -113 - - - const - int - INVALIDACL - -114 - - - const - int - AUTHFAILED - -115 - - - const - int - CLOSING - -116 - - - const - int - NOTHING - -117 - - - const - int - SESSIONMOVED - -118 - - - const - int - NOTREADONLY - -119 - - - const - int - EPHEMERALONLOCALSESSION - -120 - - - const - int - NOWATCHER - -121 - - - const - int - RECONFIGDISABLED - -122 - - - - - - -
    - - -
    - &reftitle.constants; - - -
    - <acronym>ZooKeeper</acronym> Permissions - - - - Zookeeper::PERM_READ - - Can read nodes value and list its children - - - - Zookeeper::PERM_WRITE - - Can set the nodes value - - - - Zookeeper::PERM_CREATE - - Can create children - - - - Zookeeper::PERM_DELETE - - Can delete children - - - - Zookeeper::PERM_ADMIN - - Can execute set_acl() - - - - Zookeeper::PERM_ALL - - All of the above flags ORd together - - - - -
    - - - -
    - <acronym>ZooKeeper</acronym> Create Flags - - - - Zookeeper::EPHEMERAL - - If Zookeeper::EPHEMERAL flag is set, the node will automatically get removed if the client session goes away. - - - - Zookeeper::SEQUENCE - - If the Zookeeper::SEQUENCE flag is set, a unique monotonically increasing sequence number is appended to the path name. The sequence number is always fixed length of 10 digits, 0 padded. - - - -
    - - - -
    - <acronym>ZooKeeper</acronym> Log Levels - - - - Zookeeper::LOG_LEVEL_ERROR - - Outputs only error messages - - - - Zookeeper::LOG_LEVEL_WARN - - Outputs errors/warnings - - - - Zookeeper::LOG_LEVEL_INFO - - Outputs big action messages besides errors/warnings - - - - Zookeeper::LOG_LEVEL_DEBUG - - Outputs all - - - - -
    - - - -
    - <acronym>ZooKeeper</acronym> States - - - - Zookeeper::EXPIRED_SESSION_STATE - - Connected but session expired - - - - Zookeeper::AUTH_FAILED_STATE - - Connected but auth failed - - - - Zookeeper::CONNECTING_STATE - - Connecting - - - - Zookeeper::ASSOCIATING_STATE - - Associating - - - - Zookeeper::CONNECTED_STATE - - Connected - - - - Zookeeper::READONLY_STATE - - TODO: help us improve this extension. - - - - Zookeeper::NOTCONNECTED_STATE - - Connection failed - - - - -
    - - - -
    - <acronym>ZooKeeper</acronym> Watch Types - - - - Zookeeper::CREATED_EVENT - - A node has been created - This is only generated by watches on non-existent nodes. These watches are set using Zookeeper::exists. - - - - Zookeeper::DELETED_EVENT - - A node has been deleted - This is only generated by watches on nodes. These watches are set using Zookeeper::exists and Zookeeper::get. - - - - Zookeeper::CHANGED_EVENT - - A node has changed - This is only generated by watches on nodes. These watches are set using Zookeeper::exists and Zookeeper::get. - - - - Zookeeper::CHILD_EVENT - - A change has occurred in the list of children - This is only generated by watches on the child list of a node. These watches are set using Zookeeper::getChildren. - - - - Zookeeper::SESSION_EVENT - - A session has been lost - This is generated when a client loses contact or reconnects with a server. - - - - Zookeeper::NOTWATCHING_EVENT - - A watch has been removed - This is generated when the server for some reason, probably a resource constraint, will no longer watch a node for a client. - - - - -
    - - - -
    - <acronym>ZooKeeper</acronym> System and Server-side Errors - - - Zookeeper::SYSTEMERROR - - This is never thrown by the server, it shouldn't be used other than to indicate a range. Specifically error codes greater than this value, but lesser than Zookeeper::APIERROR, are system errors. - - - - Zookeeper::RUNTIMEINCONSISTENCY - - A runtime inconsistency was found. - - - - Zookeeper::DATAINCONSISTENCY - - A data inconsistency was found. - - - - Zookeeper::CONNECTIONLOSS - - Connection to the server has been lost. - - - - Zookeeper::MARSHALLINGERROR - - Error while marshalling or unmarshalling data. - - - - Zookeeper::UNIMPLEMENTED - - Operation is unimplemented. - - - - Zookeeper::OPERATIONTIMEOUT - - Operation timeout. - - - - Zookeeper::BADARGUMENTS - - Invalid arguments. - - - - Zookeeper::INVALIDSTATE - - Invalid zhandle state. - - - - Zookeeper::NEWCONFIGNOQUORUM - - No quorum of new config is connected and up-to-date with the leader of last committed config - try invoking reconfiguration after new servers are connected and synced. - Available as of ZooKeeper 3.5.0 - - - - Zookeeper::RECONFIGINPROGRESS - - Reconfiguration requested while another reconfiguration is currently in progress. This is currently not supported. Please retry. - Available as of ZooKeeper 3.5.0 - - - -
    - - - -
    - <acronym>ZooKeeper</acronym> API Errors - - - Zookeeper::OK - - Everything is OK. - - - - Zookeeper::APIERROR - - This is never thrown by the server, it shouldn't be used other than to indicate a range. Specifically error codes greater than this value are API errors (while values less than this indicate a Zookeeper::SYSTEMERROR). - - - - Zookeeper::NONODE - - Node does not exist. - - - - Zookeeper::NOAUTH - - Not authenticated. - - - - Zookeeper::BADVERSION - - Version conflict. - - - - Zookeeper::NOCHILDRENFOREPHEMERALS - - Ephemeral nodes may not have children. - - - - Zookeeper::NODEEXISTS - - The node already exists. - - - - Zookeeper::NOTEMPTY - - The node has children. - - - - Zookeeper::SESSIONEXPIRED - - The session has been expired by the server. - - - - Zookeeper::INVALIDCALLBACK - - Invalid callback specified. - - - - Zookeeper::INVALIDACL - - Invalid ACL specified. - - - - Zookeeper::AUTHFAILED - - Client authentication failed. - - - - Zookeeper::CLOSING - - ZooKeeper is closing. - - - - Zookeeper::NOTHING - - (not error) No server responses to process. - - - - Zookeeper::SESSIONMOVED - - Session moved to another server, so operation is ignored. - - - - Zookeeper::NOTREADONLY - - State-changing request is passed to read-only server. - - - - Zookeeper::EPHEMERALONLOCALSESSION - - Attempt to create ephemeral node on a local session. - - - - Zookeeper::NOWATCHER - - The watcher couldn't be found. - - - - Zookeeper::RECONFIGDISABLED - - Attempts to perform a reconfiguration operation when reconfiguration feature is disabled. - - - -
    - - -
    - - - -
    - - &reference.zookeeper.entities.zookeeper; - -
    - - - diff --git a/reference/zookeeper/zookeeper/addauth.xml b/reference/zookeeper/zookeeper/addauth.xml deleted file mode 100644 index b28095692632..000000000000 --- a/reference/zookeeper/zookeeper/addauth.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - Zookeeper::addAuth - Specify application credentials - - - - &reftitle.description; - - public - boolZookeeper::addAuth - stringscheme - stringcert - callablecompletion_cb&null; - - - The application calls this function to specify its credentials for purposes of authentication. The server will use the security provider specified by the scheme parameter to authenticate the client connection. If the authentication request has failed: - - the server connection is dropped. - - the watcher is called with the ZOO_AUTH_FAILED_STATE value as the state parameter. - - - - - &reftitle.parameters; - - - scheme - - - The id of authentication scheme. Natively supported: "digest" password-based authentication - - - - - cert - - - Application credentials. The actual value depends on the scheme. - - - - - completion_cb - - - The routine to invoke when the request completes. One of the following result codes may be passed into the completion callback: - - ZOK operation completed successfully - - ZAUTHFAILED authentication failed - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - This method emits PHP error/warning when parameters count or types are wrong or operation fails. - - - - Since version 0.3.0, this method emits ZookeeperException and its derivatives. - - - - - - &reftitle.examples; - - <methodname>Zookeeper::addAuth</methodname> example - - Add auth before requesting node value. - - -set($path, $value); - -$zookeeper->addAuth('digest', 'user0:passwd0'); -$r = $zookeeper->get($path); -if ($r) - echo $r; -else - echo 'ERR'; -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - Zookeeper::create - Zookeeper::setAcl - Zookeeper::getAcl - ZooKeeper States - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/close.xml b/reference/zookeeper/zookeeper/close.xml deleted file mode 100644 index b49f8c66da92..000000000000 --- a/reference/zookeeper/zookeeper/close.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - Zookeeper::close - Close the zookeeper handle and free up any resources - - - - &reftitle.description; - - public - voidZookeeper::close - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - This method emits ZookeeperException and its derivatives when closing an uninitialized instance. - - - - - &reftitle.seealso; - - Zookeeper::__construct - Zookeeper::connect - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/connect.xml b/reference/zookeeper/zookeeper/connect.xml deleted file mode 100644 index 3d5881b84359..000000000000 --- a/reference/zookeeper/zookeeper/connect.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - Zookeeper::connect - Create a handle used to communicate with zookeeper - - - - &reftitle.description; - - public - voidZookeeper::connect - stringhost - callablewatcher_cb&null; - intrecv_timeout10000 - - - - This method creates a new handle and a zookeeper session that corresponds to that handle. Session establishment is asynchronous, meaning that the session should not be considered established until (and unless) an event of state ZOO_CONNECTED_STATE is received. - - - - - &reftitle.parameters; - - - host - - - Comma separated host:port pairs, each corresponding to a zk server. e.g. "127.0.0.1:3000,127.0.0.1:3001,127.0.0.1:3002" - - - - - watcher_cb - - - The global watcher callback function. When notifications are triggered this function will be invoked. - - - - - recv_timeout - - - The timeout for this session, only valid if the connection is currently connected (ie. last watcher state is ZOO_CONNECTED_STATE). - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - This method emits PHP error/warning when parameters count or types are wrong or could not init instance. - - - - Since version 0.3.0, this method emits ZookeeperException and its derivatives. - - - - - - &reftitle.seealso; - - Zookeeper::__construct - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/construct.xml b/reference/zookeeper/zookeeper/construct.xml deleted file mode 100644 index 98aa2a1cac93..000000000000 --- a/reference/zookeeper/zookeeper/construct.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - Zookeeper::__construct - Create a handle to used communicate with zookeeper - - - - &reftitle.description; - - public - Zookeeper::__construct - stringhost'' - callablewatcher_cb&null; - intrecv_timeout10000 - - - This method creates a new handle and a zookeeper session that corresponds to that handle. Session establishment is asynchronous, meaning that the session should not be considered established until (and unless) an event of state ZOO_CONNECTED_STATE is received. - - - - - &reftitle.parameters; - - - host - - - comma separated host:port pairs, each corresponding to a zk server. e.g. "127.0.0.1:3000,127.0.0.1:3001,127.0.0.1:3002" - - - - - watcher_cb - - - the global watcher callback function. When notifications are triggered this function will be invoked. - - - - - recv_timeout - - - the timeout for this session, only valid if the connections is currently connected (ie. last watcher state is ZOO_CONNECTED_STATE). - - - - - - - - &reftitle.errors; - - This method emits PHP error/warning when parameters count or types are wrong or could not init instance. - - - - Since version 0.3.0, this method emits ZookeeperException and its derivatives. - - - - - - &reftitle.seealso; - - Zookeeper::connect - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/create.xml b/reference/zookeeper/zookeeper/create.xml deleted file mode 100644 index 8918f1e89fbd..000000000000 --- a/reference/zookeeper/zookeeper/create.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - Zookeeper::create - Create a node synchronously - - - - &reftitle.description; - - public - stringZookeeper::create - stringpath - stringvalue - arrayacls - intflags&null; - - - This method will create a node in ZooKeeper. A node can only be created if it does not already exists. The Create Flags affect the creation of nodes. If ZOO_EPHEMERAL flag is set, the node will automatically get removed if the client session goes away. If the ZOO_SEQUENCE flag is set, a unique monotonically increasing sequence number is appended to the path name. - - - - - &reftitle.parameters; - - - path - - - The name of the node. Expressed as a file name with slashes separating ancestors of the node. - - - - - value - - - The data to be stored in the node. - - - - - acls - - - The initial ACL of the node. The ACL must not be null or empty. - - - - - flags - - - this parameter can be set to 0 for normal create or an OR of the Create Flags - - - - - - - - &reftitle.returnvalues; - - Returns the path of the new node (this might be different than the supplied path because of the ZOO_SEQUENCE flag) on success, and false on failure. - - - - - &reftitle.errors; - - This method emits PHP error/warning when parameters count or types are wrong or fail to create node. - - - - Since version 0.3.0, this method emits ZookeeperException and its derivatives. - - - - - - &reftitle.examples; - - <methodname>Zookeeper::create</methodname> example - - Create a new node. - - - Zookeeper::PERM_ALL, - 'scheme' => 'world', - 'id' => 'anyone', - ) -); -$path = '/path/to/newnode'; -$realPath = $zookeeper->create($path, null, $aclArray); -if ($realPath) - echo $realPath; -else - echo 'ERR'; -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - Zookeeper::delete - Zookeeper::getChildren - ZooKeeper Permissions - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/delete.xml b/reference/zookeeper/zookeeper/delete.xml deleted file mode 100644 index 1640ad57e9f6..000000000000 --- a/reference/zookeeper/zookeeper/delete.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - Zookeeper::delete - Delete a node in zookeeper synchronously - - - - &reftitle.description; - - public - boolZookeeper::delete - stringpath - intversion-1 - - - - - &reftitle.parameters; - - - path - - - The name of the node. Expressed as a file name with slashes separating ancestors of the node. - - - - - version - - - The expected version of the node. The function will fail if the actual version of the node does not match the expected version. If -1 is used the version check will not take place. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - This method emits PHP error/warning when parameters count or types are wrong or fail to delete node. - - - - Since version 0.3.0, this method emits ZookeeperException and its derivatives. - - - - - - &reftitle.examples; - - <methodname>Zookeeper::delete</methodname> example - - Delete an existing node. - - -delete($path); -if ($r) - echo 'SUCCESS'; -else - echo 'ERR'; -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - Zookeeper::create - Zookeeper::getChildren - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/exists.xml b/reference/zookeeper/zookeeper/exists.xml deleted file mode 100644 index f5a655138932..000000000000 --- a/reference/zookeeper/zookeeper/exists.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - Zookeeper::exists - Checks the existence of a node in zookeeper synchronously - - - - &reftitle.description; - - public - arrayZookeeper::exists - stringpath - callablewatcher_cb&null; - - - - - &reftitle.parameters; - - - path - - - The name of the node. Expressed as a file name with slashes separating ancestors of the node. - - - - - watcher_cb - - - if nonzero, a watch will be set at the server to notify the client if the node changes. The watch will be set even if the node does not - - - - - - - - &reftitle.returnvalues; - - Returns the value of stat for the path if the given node exists, otherwise false. - - - - - &reftitle.errors; - - This method emits PHP error/warning when parameters count or types are wrong or fail to check the existence of a node. - - - - Since version 0.3.0, this method emits ZookeeperException and its derivatives. - - - - - - &reftitle.examples; - - <methodname>Zookeeper::exists</methodname> example - - Check the existence of a node. - - -exists($path); -if ($r) - echo 'EXISTS'; -else - echo 'N/A or ERR'; -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - Zookeeper::get - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/get.xml b/reference/zookeeper/zookeeper/get.xml deleted file mode 100644 index 5d5616eb6c95..000000000000 --- a/reference/zookeeper/zookeeper/get.xml +++ /dev/null @@ -1,187 +0,0 @@ - - - - - - Zookeeper::get - Gets the data associated with a node synchronously - - - - &reftitle.description; - - public - stringZookeeper::get - stringpath - callablewatcher_cb&null; - arraystat&null; - intmax_size0 - - - - - &reftitle.parameters; - - - path - - - The name of the node. Expressed as a file name with slashes separating ancestors of the node. - - - - - watcher_cb - - - If nonzero, a watch will be set at the server to notify the client if the node changes. - - - - - stat - - - If not NULL, will hold the value of stat for the path on return. - - - - - max_size - - - Max size of the data. If 0 is used, this method will return the whole data. - - - - - - - - &reftitle.returnvalues; - - Returns the data on success, and false on failure. - - - - - &reftitle.errors; - - This method emits PHP error/warning when parameters count or types are wrong or fail to get value from node. - - - - Since version 0.3.0, this method emits ZookeeperException and its derivatives. - - - - - - &reftitle.examples; - - <methodname>Zookeeper::get</methodname> example - - Get value from node. - - -set($path, $value); - -$r = $zookeeper->get($path); -if ($r) - echo $r; -else - echo 'ERR'; -?> -]]> - - &example.outputs; - - - - - - - <methodname>Zookeeper::get</methodname> stat example - - Get node stat info. - - -get($path, null, $stat); -var_dump($stat); -?> -]]> - - &example.outputs; - - - float(0) - ["mzxid"]=> - float(0) - ["ctime"]=> - float(0) - ["mtime"]=> - float(0) - ["version"]=> - int(0) - ["cversion"]=> - int(-2) - ["aversion"]=> - int(0) - ["ephemeralOwner"]=> - float(0) - ["dataLength"]=> - int(0) - ["numChildren"]=> - int(2) - ["pzxid"]=> - float(0) -} -]]> - - - - - - &reftitle.seealso; - - Zookeeper::set - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/getacl.xml b/reference/zookeeper/zookeeper/getacl.xml deleted file mode 100644 index e9b614393762..000000000000 --- a/reference/zookeeper/zookeeper/getacl.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - Zookeeper::getAcl - Gets the acl associated with a node synchronously - - - - &reftitle.description; - - public - arrayZookeeper::getAcl - stringpath - - - - - &reftitle.parameters; - - - path - - - The name of the node. Expressed as a file name with slashes separating ancestors of the node. - - - - - - - - &reftitle.returnvalues; - - Return acl array on success and false on failure. - - - - - &reftitle.errors; - - This method emits PHP error/warning when parameters count or types are wrong or fail to get ACL of a node. - - - - Since version 0.3.0, this method emits ZookeeperException and its derivatives. - - - - - - &reftitle.examples; - - <methodname>Zookeeper::getAcl</methodname> example - - Get ACL of a node. - - - Zookeeper::PERM_ALL, - 'scheme' => 'world', - 'id' => 'anyone', - ) -); -$path = '/path/to/newnode'; -$zookeeper->setAcl($path, $aclArray); - -$r = $zookeeper->getAcl($path); -if ($r) - var_dump($r); -else - echo 'ERR'; -?> -]]> - - &example.outputs; - - - array(3) { - ["perms"]=> - int(31) - ["scheme"]=> - string(5) "world" - ["id"]=> - string(6) "anyone" - } -} -]]> - - - - - - &reftitle.seealso; - - Zookeeper::create - Zookeeper::setAcl - ZooKeeper Permissions - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/getchildren.xml b/reference/zookeeper/zookeeper/getchildren.xml deleted file mode 100644 index 3a88fd1641a0..000000000000 --- a/reference/zookeeper/zookeeper/getchildren.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - Zookeeper::getChildren - Lists the children of a node synchronously - - - - &reftitle.description; - - public - arrayZookeeper::getChildren - stringpath - callablewatcher_cb&null; - - - - - &reftitle.parameters; - - - path - - - The name of the node. Expressed as a file name with slashes separating ancestors of the node. - - - - - watcher_cb - - - If nonzero, a watch will be set at the server to notify the client if the node changes. - - - - - - - - &reftitle.returnvalues; - - Returns an array with children paths on success, and false on failure. - - - - - &reftitle.errors; - - This method emits PHP error/warning when parameters count or types are wrong or fail to list children of a node. - - - - Since version 0.3.0, this method emits ZookeeperException and its derivatives. - - - - - - &reftitle.examples; - - <methodname>Zookeeper::getChildren</methodname> example - - Lists children of a node. - - -getchildren($path); - -if ($r) { - var_dump($r); -} else { - echo 'ERR'; -} - -?> -]]> - - &example.outputs; - - - string(6) "config" -} -]]> - - - - - - &reftitle.seealso; - - Zookeeper::create - Zookeeper::delete - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/getclientid.xml b/reference/zookeeper/zookeeper/getclientid.xml deleted file mode 100644 index 3972ef6aefd7..000000000000 --- a/reference/zookeeper/zookeeper/getclientid.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - Zookeeper::getClientId - Return the client session id, only valid if the connections is currently connected (ie. last watcher state is ZOO_CONNECTED_STATE) - - - - &reftitle.description; - - public - intZookeeper::getClientId - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the client session id on success, and false on failure. - - - - - &reftitle.errors; - - This method emits PHP error/warning when it could not get client session id. - - - - Since version 0.3.0, this method emits ZookeeperException and its derivatives. - - - - - - &reftitle.seealso; - - Zookeeper::__construct - Zookeeper::connect - Zookeeper::getState - ZooKeeper States - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/getconfig.xml b/reference/zookeeper/zookeeper/getconfig.xml deleted file mode 100644 index a9ed2c8fa570..000000000000 --- a/reference/zookeeper/zookeeper/getconfig.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - Zookeeper::getConfig - Get instance of ZookeeperConfig - - - - &reftitle.description; - - public - ZookeeperConfigZookeeper::getConfig - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns instance of ZookeeperConfig. - - - - - &reftitle.seealso; - - ZookeeperConfig - - - - - - diff --git a/reference/zookeeper/zookeeper/getrecvtimeout.xml b/reference/zookeeper/zookeeper/getrecvtimeout.xml deleted file mode 100644 index 11f45fe130fe..000000000000 --- a/reference/zookeeper/zookeeper/getrecvtimeout.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Zookeeper::getRecvTimeout - Return the timeout for this session, only valid if the connections is currently connected (ie. last watcher state is ZOO_CONNECTED_STATE). This value may change after a server re-connect - - - - &reftitle.description; - - public - intZookeeper::getRecvTimeout - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the timeout for this session on success, and false on failure. - - - - - &reftitle.errors; - - This method emits PHP error/warning when operation fails. - - - - Since version 0.3.0, this method emits ZookeeperException and its derivatives. - - - - - - &reftitle.seealso; - - Zookeeper::__construct - Zookeeper::connect - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/getstate.xml b/reference/zookeeper/zookeeper/getstate.xml deleted file mode 100644 index 94234acac5cb..000000000000 --- a/reference/zookeeper/zookeeper/getstate.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - Zookeeper::getState - Get the state of the zookeeper connection - - - - &reftitle.description; - - public - intZookeeper::getState - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the state of zookeeper connection on success, and false on failure. - - - - - &reftitle.errors; - - This method emits PHP error/warning when it fails to get state of zookeeper connection. - - - - Since version 0.3.0, this method emits ZookeeperException and its derivatives. - - - - - - &reftitle.seealso; - - Zookeeper::__construct - Zookeeper::connect - Zookeeper::getClientId - ZooKeeper States - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/isrecoverable.xml b/reference/zookeeper/zookeeper/isrecoverable.xml deleted file mode 100644 index 5a1984b9a7c8..000000000000 --- a/reference/zookeeper/zookeeper/isrecoverable.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - Zookeeper::isRecoverable - Checks if the current zookeeper connection state can be recovered - - - - &reftitle.description; - - public - boolZookeeper::isRecoverable - - - - The application must close the handle and try to reconnect. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns true/false on success, and false on failure. - - - - - &reftitle.errors; - - This method emits PHP error/warning when operation fails. - - - - Since version 0.3.0, this method emits ZookeeperException and its derivatives. - - - - - - &reftitle.seealso; - - Zookeeper::__construct - Zookeeper::connect - Zookeeper::getClientId - ZooKeeper States - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/set.xml b/reference/zookeeper/zookeeper/set.xml deleted file mode 100644 index 9b103f2a9308..000000000000 --- a/reference/zookeeper/zookeeper/set.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - Zookeeper::set - Sets the data associated with a node - - - - &reftitle.description; - - public - boolZookeeper::set - stringpath - stringvalue - intversion-1 - arraystat&null; - - - - - &reftitle.parameters; - - - path - - - The name of the node. Expressed as a file name with slashes separating ancestors of the node. - - - - - value - - - The data to be stored in the node. - - - - - version - - - The expected version of the node. The function will fail if the actual version of the node does not match the expected version. If -1 is used the version check will not take place. - - - - - stat - - - If not NULL, will hold the value of stat for the path on return. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - This method emits PHP error/warning when parameters count or types are wrong or fail to save value to node. - - - - Since version 0.3.0, this method emits ZookeeperException and its derivatives. - - - - - - &reftitle.examples; - - <methodname>Zookeeper::set</methodname> example - - Save value to node. - - -set($path, $value); -if ($r) - echo 'SUCCESS'; -else - echo 'ERR'; -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - Zookeeper::create - Zookeeper::get - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/setacl.xml b/reference/zookeeper/zookeeper/setacl.xml deleted file mode 100644 index a8864d223881..000000000000 --- a/reference/zookeeper/zookeeper/setacl.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - Zookeeper::setAcl - Sets the acl associated with a node synchronously - - - - &reftitle.description; - - public - boolZookeeper::setAcl - stringpath - intversion - arrayacl - - - - - &reftitle.parameters; - - - path - - - The name of the node. Expressed as a file name with slashes separating ancestors of the node. - - - - - version - - - The expected version of the path. - - - - - acl - - - The acl to be set on the path. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - This method emits PHP error/warning when parameters count or types are wrong or fail to set ACL for a node. - - - - Since version 0.3.0, this method emits ZookeeperException and its derivatives. - - - - - - &reftitle.examples; - - <methodname>Zookeeper::setAcl</methodname> example - - Set ACL for a node. - - - Zookeeper::PERM_ALL, - 'scheme' => 'world', - 'id' => 'anyone', - ) -); -$path = '/path/to/newnode'; -$zookeeper->setAcl($path, $aclArray); - -$r = $zookeeper->getAcl($path); -if ($r) - var_dump($r); -else - echo 'ERR'; -?> -]]> - - &example.outputs; - - - array(3) { - ["perms"]=> - int(31) - ["scheme"]=> - string(5) "world" - ["id"]=> - string(6) "anyone" - } -} -]]> - - - - - - &reftitle.seealso; - - Zookeeper::create - Zookeeper::getAcl - ZooKeeper Permissions - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/setdebuglevel.xml b/reference/zookeeper/zookeeper/setdebuglevel.xml deleted file mode 100644 index c3feca4533a6..000000000000 --- a/reference/zookeeper/zookeeper/setdebuglevel.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - Zookeeper::setDebugLevel - Sets the debugging level for the library - - - - &reftitle.description; - - public - static - boolZookeeper::setDebugLevel - intlogLevel - - - - - &reftitle.parameters; - - - logLevel - - - ZooKeeper log level constants. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - This method emits PHP error/warning when parameters count or types are wrong or fail to set debug level. - - - - Since version 0.3.0, this method emits ZookeeperException and its derivatives. - - - - - - &reftitle.examples; - - <methodname>Zookeeper::setDebugLevel</methodname> example - - Set debugl level. - - - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - ZooKeeper Log Levels - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/setdeterministicconnorder.xml b/reference/zookeeper/zookeeper/setdeterministicconnorder.xml deleted file mode 100644 index 75424e7357f2..000000000000 --- a/reference/zookeeper/zookeeper/setdeterministicconnorder.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - Zookeeper::setDeterministicConnOrder - Enable/disable quorum endpoint order randomization - - - - &reftitle.description; - - public - static - boolZookeeper::setDeterministicConnOrder - boolyesOrNo - - - If passed a true value, will make the client connect to quorum peers in the order as specified in the zookeeper_init() call. A false value causes zookeeper_init() to permute the peer endpoints which is good for more even client connection distribution among the quorum peers. - ZooKeeper C Client uses false by default. - - - - - &reftitle.parameters; - - - yesOrNo - - - Disable/enable quorum endpoint order randomization. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - This method emits PHP error/warning when parameters count or types are wrong or operation fails. - - - - Since version 0.3.0, this method emits ZookeeperException and its derivatives. - - - - - - &reftitle.seealso; - - Zookeeper::__construct - Zookeeper::connect - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/setlogstream.xml b/reference/zookeeper/zookeeper/setlogstream.xml deleted file mode 100644 index 40981d708774..000000000000 --- a/reference/zookeeper/zookeeper/setlogstream.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - Zookeeper::setLogStream - Sets the stream to be used by the library for logging - - - - &reftitle.description; - - public - boolZookeeper::setLogStream - resourcestream - - - The zookeeper library uses stderr as its default log stream. Application must make sure the stream is writable. Passing in NULL resets the stream to its default value (stderr). - - - - - &reftitle.parameters; - - - stream - - - The stream to be used by the library for logging. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - This method emits PHP error/warning when parameters count or types are wrong or operation fails. - - - - Since version 0.3.0, this method emits ZookeeperException and its derivatives. - - - - - - &reftitle.seealso; - - Zookeeper::setDebugLevel - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/setwatcher.xml b/reference/zookeeper/zookeeper/setwatcher.xml deleted file mode 100644 index 84bb849bd633..000000000000 --- a/reference/zookeeper/zookeeper/setwatcher.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - Zookeeper::setWatcher - Set a watcher function - - - - &reftitle.description; - - public - boolZookeeper::setWatcher - callablewatcher_cb - - - - - &reftitle.parameters; - - - watcher_cb - - - A watch will be set at the server to notify the client if the node changes. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - This method emits PHP error/warning when parameters count or types are wrong or fail to set watcher. - - - - Since version 0.3.0, this method emits ZookeeperException and its derivatives. - - - - - - &reftitle.seealso; - - Zookeeper::exists - Zookeeper::get - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeperauthenticationexception.xml b/reference/zookeeper/zookeeperauthenticationexception.xml deleted file mode 100644 index 7a4f3e6aaa60..000000000000 --- a/reference/zookeeper/zookeeperauthenticationexception.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - The ZookeeperAuthenticationException class - ZookeeperAuthenticationException - - - - -
    - &reftitle.intro; - - The ZooKeeper authentication exception handling class. - -
    - - -
    - &reftitle.classsynopsis; - - - - ZookeeperAuthenticationException - - - - - ZookeeperAuthenticationException - - - extends - ZookeeperException - - - &InheritedProperties; - - &InheritedMethods; - - - - -
    - -
    - -
    - - - diff --git a/reference/zookeeper/zookeeperconfig.xml b/reference/zookeeper/zookeeperconfig.xml deleted file mode 100644 index 152b128e5dd2..000000000000 --- a/reference/zookeeper/zookeeperconfig.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - The ZookeeperConfig class - ZookeeperConfig - - - - -
    - &reftitle.intro; - - The ZooKeeper Config handling class. - -
    - - -
    - &reftitle.classsynopsis; - - - - ZookeeperConfig - - - - - ZookeeperConfig - - - - - - &Methods; - - - - - - -
    - -
    - - &reference.zookeeper.entities.zookeeperconfig; - -
    - - diff --git a/reference/zookeeper/zookeeperconfig/add.xml b/reference/zookeeper/zookeeperconfig/add.xml deleted file mode 100644 index 18ac63bc1800..000000000000 --- a/reference/zookeeper/zookeeperconfig/add.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - ZookeeperConfig::add - Add servers to the ensemble - - - - &reftitle.description; - - public - voidZookeeperConfig::add - stringmembers - intversion-1 - arraystat&null; - - - - - &reftitle.parameters; - - - members - - - Comma separated list of servers to be added to the ensemble. Each has a configuration line for a server to be added (as would appear in a - configuration file), only for maj. quorums. - - - - - version - - - The expected version of the node. The function will fail if the actual version of the node does not match the expected version. If -1 is used the version check will not take place. - - - - - stat - - - If not NULL, will hold the value of stat for the path on return. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - This method emits ZookeeperException and its derivatives when parameters count or types are wrong or fail to save value to node. - - - - - &reftitle.examples; - - <methodname>ZookeeperConfig::add</methodname> example - - Add members. - - -connect('localhost:2181'); -$client->addAuth('digest', 'timandes:timandes'); -$zkConfig = $client->getConfig(); -$zkConfig->set("server.1=localhost:2888:3888:participant;0.0.0.0:2181"); -$zkConfig->add("server.2=localhost:2889:3889:participant;0.0.0.0:2182"); -$r = $zkConfig->get(); -if ($r) - echo $r; -else - echo 'ERR'; -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - ZookeeperConfig::get - ZookeeperConfig::set - ZookeeperConfig::remove - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeperconfig/get.xml b/reference/zookeeper/zookeeperconfig/get.xml deleted file mode 100644 index f736dc6cbf0f..000000000000 --- a/reference/zookeeper/zookeeperconfig/get.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - ZookeeperConfig::get - Gets the last committed configuration of the ZooKeeper cluster as it is known to the server to which the client is connected, synchronously - - - - &reftitle.description; - - public - stringZookeeperConfig::get - callablewatcher_cb&null; - arraystat&null; - - - - - &reftitle.parameters; - - - watcher_cb - - - If nonzero, a watch will be set at the server to notify the client if the node changes. - - - - - stat - - - If not NULL, will hold the value of stat for the path on return. - - - - - - - - &reftitle.returnvalues; - - Returns the configuration string on success, and false on failure. - - - - - &reftitle.errors; - - This method emits ZookeeperException and its derivatives when parameters count or types are wrong or fail to get configuration. - - - - - &reftitle.examples; - - <methodname>ZookeeperConfig::get</methodname> example - - Get configuration. - - -connect('localhost:2181'); -$zk->addAuth('digest', 'timandes:timandes'); -$zkConfig = $zk->getConfig(); -$r = $zkConfig->get(); -if ($r) - echo $r; -else - echo 'ERR'; -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - ZookeeperConfig::set - ZookeeperConfig::add - ZookeeperConfig::remove - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeperconfig/remove.xml b/reference/zookeeper/zookeeperconfig/remove.xml deleted file mode 100644 index e2564daf1eb3..000000000000 --- a/reference/zookeeper/zookeeperconfig/remove.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - ZookeeperConfig::remove - Remove servers from the ensemble - - - - &reftitle.description; - - public - voidZookeeperConfig::remove - stringid_list - intversion-1 - arraystat&null; - - - - - &reftitle.parameters; - - - id_list - - - Comma separated list of server IDs to be removed from the ensemble. Each has an id of a server to be removed, only for maj. quorums. - - - - - version - - - The expected version of the node. The function will fail if the actual version of the node does not match the expected version. If -1 is used the version check will not take place. - - - - - stat - - - If not NULL, will hold the value of stat for the path on return. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - This method emits ZookeeperException and its derivatives when parameters count or types are wrong or fail to save value to node. - - - - - &reftitle.examples; - - <methodname>ZookeeperConfig::remove</methodname> example - - Remove members. - - -connect('localhost:2181'); -$client->addAuth('digest', 'timandes:timandes'); -$zkConfig = $client->getConfig(); -$zkConfig->set("server.1=localhost:2888:3888:participant;0.0.0.0:2181,server.2=localhost:2889:3889:participant;0.0.0.0:2182"); -$zkConfig->remove("2"); -echo $zkConfig->get(); -if ($r) - echo $r; -else - echo 'ERR'; -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - ZookeeperConfig::get - ZookeeperConfig::add - ZookeeperConfig::set - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeperconfig/set.xml b/reference/zookeeper/zookeeperconfig/set.xml deleted file mode 100644 index e09eeaf8acba..000000000000 --- a/reference/zookeeper/zookeeperconfig/set.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - ZookeeperConfig::set - Change ZK cluster ensemble membership and roles of ensemble peers - - - - &reftitle.description; - - public - voidZookeeperConfig::set - stringmembers - intversion-1 - arraystat&null; - - - - - &reftitle.parameters; - - - members - - - Comma separated list of new membership (e.g., contents of a membership configuration file) - for use only with a non-incremental reconfiguration. - - - - - version - - - The expected version of the node. The function will fail if the actual version of the node does not match the expected version. If -1 is used the version check will not take place. - - - - - stat - - - If not NULL, will hold the value of stat for the path on return. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - This method emits ZookeeperException and its derivatives when parameters count or types are wrong or fail to save value to node. - - - - - &reftitle.examples; - - <methodname>ZookeeperConfig::set</methodname> example - - Reconfig. - - -connect('localhost:2181'); -$client->addAuth('digest', 'timandes:timandes'); -$zkConfig = $client->getConfig(); -$zkConfig->set("server.1=localhost:2888:3888:participant;0.0.0.0:2181"); -?> -]]> - - - - - - &reftitle.seealso; - - ZookeeperConfig::get - ZookeeperConfig::add - ZookeeperConfig::remove - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeperconnectionexception.xml b/reference/zookeeper/zookeeperconnectionexception.xml deleted file mode 100644 index ad72686a22e4..000000000000 --- a/reference/zookeeper/zookeeperconnectionexception.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - The ZookeeperConnectionException class - ZookeeperConnectionException - - - - -
    - &reftitle.intro; - - The ZooKeeper connection exception handling class. - -
    - - -
    - &reftitle.classsynopsis; - - - - ZookeeperConnectionException - - - - - ZookeeperConnectionException - - - extends - ZookeeperException - - - &InheritedProperties; - - &InheritedMethods; - - - - - -
    - -
    - -
    - - - diff --git a/reference/zookeeper/zookeeperexception.xml b/reference/zookeeper/zookeeperexception.xml deleted file mode 100644 index df657076bdd8..000000000000 --- a/reference/zookeeper/zookeeperexception.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - The ZookeeperException class - ZookeeperException - - - - -
    - &reftitle.intro; - - The ZooKeeper exception handling class. - -
    - - -
    - &reftitle.classsynopsis; - - - - ZookeeperException - - - - - ZookeeperException - - - extends - Exception - - - &InheritedProperties; - - &InheritedMethods; - - - - - -
    - -
    - -
    - - - diff --git a/reference/zookeeper/zookeepermarshallingexception.xml b/reference/zookeeper/zookeepermarshallingexception.xml deleted file mode 100644 index 8eb8816f8c5c..000000000000 --- a/reference/zookeeper/zookeepermarshallingexception.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - The ZookeeperMarshallingException class - ZookeeperMarshallingException - - - - -
    - &reftitle.intro; - - The ZooKeeper exception (while marshalling or unmarshalling data) handling class. - -
    - - -
    - &reftitle.classsynopsis; - - - - ZookeeperMarshallingException - - - - - ZookeeperMarshallingException - - - extends - ZookeeperException - - - &InheritedProperties; - - &InheritedMethods; - - - - - -
    - -
    - -
    - - - diff --git a/reference/zookeeper/zookeepernonodeexception.xml b/reference/zookeeper/zookeepernonodeexception.xml deleted file mode 100644 index eade14e4cfbb..000000000000 --- a/reference/zookeeper/zookeepernonodeexception.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - The ZookeeperNoNodeException class - ZookeeperNoNodeException - - - - -
    - &reftitle.intro; - - The ZooKeeper exception (when node does not exist) handling class. - -
    - - -
    - &reftitle.classsynopsis; - - - - ZookeeperNoNodeException - - - - - ZookeeperNoNodeException - - - extends - ZookeeperException - - - &InheritedProperties; - - &InheritedMethods; - - - - - -
    - -
    - -
    - - - diff --git a/reference/zookeeper/zookeeperoperationtimeoutexception.xml b/reference/zookeeper/zookeeperoperationtimeoutexception.xml deleted file mode 100644 index f7421e26f321..000000000000 --- a/reference/zookeeper/zookeeperoperationtimeoutexception.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - The ZookeeperOperationTimeoutException class - ZookeeperOperationTimeoutException - - - - -
    - &reftitle.intro; - - The ZooKeeper operation timeout exception handling class. - -
    - - -
    - &reftitle.classsynopsis; - - - - ZookeeperOperationTimeoutException - - - - - ZookeeperOperationTimeoutException - - - extends - ZookeeperException - - - &InheritedProperties; - - &InheritedMethods; - - - - - -
    - -
    - -
    - - - diff --git a/reference/zookeeper/zookeepersessionexception.xml b/reference/zookeeper/zookeepersessionexception.xml deleted file mode 100644 index a41274735807..000000000000 --- a/reference/zookeeper/zookeepersessionexception.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - The ZookeeperSessionException class - ZookeeperSessionException - - - - -
    - &reftitle.intro; - - The ZooKeeper session exception handling class. - -
    - - -
    - &reftitle.classsynopsis; - - - - ZookeeperSessionException - - - - - ZookeeperSessionException - - - extends - ZookeeperException - - - &InheritedProperties; - - &InheritedMethods; - - - - - -
    - -
    - -
    - - - diff --git a/security/database.xml b/security/database.xml index eb0b3dafb6d1..bc2af8e30ed2 100644 --- a/security/database.xml +++ b/security/database.xml @@ -336,8 +336,8 @@ $result = mssql_query($query); mssql extension, which was removed in PHP 7.0.0. It is used here only to illustrate the attack; current code connecting - to MSSQL Server should use the sqlsrv or - pdo_sqlsrv extensions instead. + to MSSQL Server should use the sqlsrv or + pdo_sqlsrv extensions instead.