4.2.0The random
number generator is seeded automatically.'>
This feature has been
DEPRECATED as of PHP 5.3.0. Relying on this feature is
highly discouraged.'>
This function has been
DEPRECATED as of PHP 5.3.0. Relying on this feature is
highly discouraged.'>
This function does not
generate cryptographically secure values, and should not be used for cryptographic purposes. If you need a
cryptographically secure value, consider using random_int, random_bytes, or
openssl_random_pseudo_bytes instead.'>
This function is
binary-safe.'>
This function is locale-aware
and will handle input according to the currently set locale. However, it only works on single-byte character sets.
If you need to use multibyte characters (most non-western-European languages) look at the
multibyte or intl extensions instead.'>
The results of this
function are cached. See clearstatcache for
more details.'>
Context support was added
with PHP 5.0.0. For a description of contexts, refer to
.'>
If a program is started with this function,
in order for it to continue running in the background, the output of the
program must be redirected to a file or another output stream. Failing to do so
will cause PHP to hang until the execution of the program ends.'>
On Windows exec
will first start cmd.exe to launch the command. If you want to start an external program without starting cmd.exe
use proc_open with the bypass_shell option set.'>
Instead of a function name, an
array containing an object reference and a method name can also be
supplied.'>
Callbacks registered
with functions such as call_user_func and call_user_func_array will not be
called if there is an uncaught exception thrown in a previous callback.'>
If the arguments are passed by reference,
any changes to the arguments will be reflected in the values returned by this function. As of PHP 7
the current values will also be returned if the arguments are passed by value.'>
Because this function depends on the
current scope to determine parameter details, it cannot be used as a
function parameter in versions prior to 5.3.0. If this value must be passed, the results should be assigned
to a variable, and that variable should be passed.'>
If PHP is not properly recognizing
the line endings when reading files either on or created by a Macintosh
computer, enabling the
auto_detect_line_endings
run-time configuration option may help resolve the problem.'>
This function will not work on
remote files as the file to
be examined must be accessible via the server's filesystem.'>
This function
is not (yet) binary safe!'>
This function
assigns new keys to the elements in array.
It will remove any existing keys that may have been assigned, rather
than just reordering the keys.'>
This function is not
implemented on Windows platforms.'>
This extension is not
available on Windows platforms.'>
This function is not
available in PHP interpreters built with ZTS (Zend Thread Safety) enabled. To check whether your copy of PHP was built with ZTS enabled, use php -i or test the built-in constant PHP_ZTS.'>
There is no need
to seed the random number generator with srand or
mt_srand as this is done automatically.
'>
This is a 'superglobal', or
automatic global, variable. This simply means that it is available in
all scopes throughout a script. There is no need to do
global $variable; to access it within functions or methods.
">
When the return parameter
is used, this function uses internal output buffering so it cannot be used inside an
ob_start callback function.'>
When the return parameter
is used, this function uses internal output buffering prior to PHP 7.1.0, so it cannot be used inside an
ob_start callback function.'>
Note that time resolution may differ
from one file system to another.'>
Using this function will use any registered
autoloaders if the class is not already known.'>
Headers will only be accessible and output when a SAPI that supports them
is in use.
'>
If PHP has been compiled with --enable-sigchild, the return value of this function is undefined.
'>
If two members compare as equal, their relative order in the sorted array is undefined.
'>
A URL can be used as a
filename with this function if the fopen wrappers have been enabled.
See fopen for more details on how to specify the
filename. See the for links to information
about what abilities the various wrappers have, notes on their usage,
and information on any predefined variables they may
provide.'>
As of PHP 5.0.0, this function
can also be used with some URL wrappers. Refer to
to determine which wrappers support
stat family of functionality.'>
As with anything that outputs
its result directly to the browser, the output-control functions can be used to capture
the output of this function, and save it in a
string (for example).'>
See also the
.'>
When allowing user-supplied data to be
passed to this function, use
escapeshellarg or escapeshellcmd
to ensure that users cannot trick the system into executing arbitrary
commands.'>
This extension is
EXPERIMENTAL. The behaviour of this extension including
the names of its functions and any other documentation surrounding this
extension may change without notice in a future release of PHP.
This extension should be used at your own risk.'>
This feature has been
DEPRECATED as of PHP 5.3.0. Relying on this feature
is highly discouraged.'>
This feature has been
DEPRECATED as of PHP 5.3.0 and REMOVED
as of PHP 5.4.0.'>
This function has been
DEPRECATED as of PHP 5.3.0 and REMOVED as of PHP 5.4.0.'>
This feature has been
DEPRECATED as of PHP 5.5.0. Relying on this feature
is highly discouraged.'>
This feature has been
DEPRECATED as of PHP 5.6.0. Relying on this feature
is highly discouraged.'>
This feature has been
DEPRECATED as of PHP 7.0.0. Relying on this feature
is highly discouraged.'>
This feature has been
DEPRECATED as of PHP 7.1.0. Relying on this feature
is highly discouraged.'>
This function has been
DEPRECATED as of PHP 7.1.0. Relying on this function
is highly discouraged.'>
This function has been
DEPRECATED as of PHP 7.1.0 and
REMOVED as of PHP 7.2.0. Relying on this function
is highly discouraged.'>
This feature has been
DEPRECATED as of PHP 7.2.0. Relying on this feature
is highly discouraged.'>
This feature has been
DEPRECATED as of PHP 7.2.0, and REMOVED as of PHP 8.0.0. Relying on this feature
is highly discouraged.'>
This function has been
DEPRECATED as of PHP 7.2.0. Relying on this function
is highly discouraged.'>
This function has been
DEPRECATED as of PHP 7.2.0, and REMOVED as of PHP 8.0.0. Relying on this function
is highly discouraged.'>
This feature has been
DEPRECATED as of PHP 7.3.0. Relying on this feature
is highly discouraged.'>
This function has been
DEPRECATED as of PHP 7.3.0. Relying on this function
is highly discouraged.'>
This function has been
DEPRECATED as of PHP 7.3.0, and REMOVED as of PHP 8.0.0. Relying on this function
is highly discouraged.'>
This feature has been
DEPRECATED as of PHP 7.4.0. Relying on this feature
is highly discouraged.'>
This function has been
DEPRECATED as of PHP 7.4.0. Relying on this function
is highly discouraged.'>
This function has been
DEPRECATED as of PHP 7.4.0, and REMOVED as of PHP 8.0.0. Relying on this function
is highly discouraged.'>
This function has been
DEPRECATED as of PHP 8.0.0. Relying on this function
is highly discouraged.'>
will
certainly be removed in the future.'>
This function has been
DEPRECATED and REMOVED as of PHP 5.3.0.'>
This function has been
DEPRECATED and REMOVED as of PHP 5.5.0.'>
This alias has been DEPRECATED as of PHP 5.3.0. Relying
on this alias is highly discouraged.'>
This function has been DEPRECATED as of PHP 5.4.0. Relying
on this function is highly discouraged.'>
This alias has been DEPRECATED as of PHP 5.4.0. Relying
on this alias is highly discouraged.'>
This function has been DEPRECATED as of PHP 5.5.0. Relying
on this function is highly discouraged.'>
This feature was
DEPRECATED in PHP 5.5.0, and REMOVED as of PHP 7.0.0.'>
This function was
DEPRECATED in PHP 5.5.0, and REMOVED as of PHP 7.0.0.'>
This function was
DEPRECATED in PHP 4.1.0, and REMOVED as of PHP 7.0.0.'>
This function was
DEPRECATED in PHP 5.3.0, and REMOVED as of PHP 7.0.0.'>
This alias was
DEPRECATED in PHP 5.3.0, and REMOVED as of PHP 7.0.0.'>
This feature was
DEPRECATED in PHP 5.6.0, and
REMOVED as of PHP 7.0.0.'>
This function was
REMOVED in PHP 7.0.0.'>
This function was
REMOVED in PHP 7.4.0.'>
This alias was
DEPRECATED in PHP 7.2.0, and REMOVED as of PHP 8.0.0.'>
This alias was
DEPRECATED in PHP 7.4.0, and REMOVED as of PHP 8.0.0.'>
This alias is
DEPRECATED as of PHP 8.0.0.'>
This alias is
REMOVED as of PHP 8.0.0.'>
This function is
EXPERIMENTAL. The behaviour of this function, its name, and
surrounding documentation may change without notice in a future release of PHP.
This function should be used at your own risk.
'>
The 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.'>
A server deployed in CGI mode is open
to several possible vulnerabilities. Please read our
CGI security section to learn how to
defend yourself from such attacks.'>
directive note: magic_quotes_gpc
The magic_quotes_gpc
directive defaults to on. It essentially runs
addslashes on all GET, POST, and COOKIE data.
stripslashes may be used to remove them.'>
It is not recommended to use this function to secure passwords,
due to the fast nature of this hashing algorithm. See the
Password Hashing FAQ
for details and best practices.
'>
When using SSL, Microsoft IIS
will violate the protocol by closing the connection without sending a
close_notify indicator. PHP will report this as "SSL: Fatal
Protocol Error" when you reach the end of the data. To work around this, the
value of error_reporting should be
lowered to a level that does not include warnings.
PHP can detect buggy IIS server software when you open
the stream using the https:// wrapper and will suppress the
warning. When using fsockopen to create an
ssl:// socket, the developer is responsible for detecting
and suppressing this warning.'>
This class is currently undocumented; only a list of its properties and
methods is available.
'>
This function is
currently not documented; only its argument list is available.
'>
This function was DEPRECATED in PHP 4.1.0, and
REMOVED in PHP 7.0.0.
Alternatives to this function include:
'>
This feature was DEPRECATED in PHP 5.3.0, and
REMOVED in PHP 7.0.0.
Alternatives to this feature include:
'>
This function was DEPRECATED in PHP 5.3.0, and
REMOVED in PHP 7.0.0.
Alternatives to this function include:
'>
This function was DEPRECATED in PHP 5.5.0, and
REMOVED in PHP 7.0.0.
Alternatives to this function include:
'>
This feature was REMOVED in PHP 7.0.0.
Alternatives to this feature include:
'>
This function was REMOVED in PHP 7.0.0.
Alternatives to this function include:
'>
This feature was DEPRECATED in PHP 7.1.0, and
REMOVED in PHP 7.2.0.
Alternatives to this feature include:
'>
This function was DEPRECATED in PHP 7.1.0, and
REMOVED in PHP 7.2.0.
Alternatives to this function include:
'>
This function has no parameters.'>
The above example will output:'>
Output of the above example in PHP 5:'>
Output of the above example in PHP 5.3:'>
Output of the above example in PHP 5.4:'>
Output of the above example in PHP 5.5:'>
Output of the above example in PHP 5.6:'>
Output of the above example in PHP 7:'>
Output of the above example in PHP 7.0:'>
Output of the above example in PHP 7.1:'>
Output of the above example in PHP 7.2:'>
Output of the above example in PHP 7.3:'>
Output of the above example in PHP 8:'>
Output of the above example in PHP 8 is similar to:'>
Output of the above example in PHP 8.0:'>
Output of the above example on 32 bit machines:'>
Output of the above example on 64 bit machines:'>
The above example will output
something similar to:'>
The above examples will output:'>
Output of the above examples on 32 bit machines:'>
Output of the above examples on 64 bit machines:'>
The above examples will output
something similar to:'>
This function will
reset the array pointer of the input array after
use.'>
comparison of array sorting functions'>
flags
The optional second parameter flags
may be used to modify the sorting behavior using these values:
Sorting type flags:
SORT_REGULAR - compare items normally;
the details are described in the comparison operators sectionSORT_NUMERIC - compare items numericallySORT_STRING - compare items as stringsSORT_LOCALE_STRING - compare items as
strings, based on the current locale. It uses the locale,
which can be changed using setlocaleSORT_NATURAL - compare items as strings
using "natural ordering" like natsortSORT_FLAG_CASE - can be combined
(bitwise OR) with
SORT_STRING or
SORT_NATURAL to sort strings case-insensitively
'>
When an int is used, the
value is measured in bytes. Shorthand notation, as described
in this FAQ, may also be used.
'>
This function alias is
deprecated and only exists for backwards compatibility reasons. The use of this
function is not recommended, as it may be removed from PHP in the future.
'>
DLL files that must be available to the Windows
system PATH. For information on how to do this, see the
FAQ entitled "How do I add my PHP directory to the PATH
on Windows". Although copying DLL
files from the PHP folder into the Windows system directory also works
(because the system directory is by default in the system's
PATH), this is not recommended.
This extension requires the following files to be in the
PATH: '>
resource'>
foreach'>
yield'>
context
section of the manual for a description of contexts.'>
include_path'>
This function may
return Boolean &false;, but may also return a non-Boolean value which
evaluates to &false;. Please read the section on Booleans for more
information. Use the ===
operator for testing the return value of this
function.'>
x509
See Key/Certificate parameters for a list of valid values.
'>
csr
See CSR parameters for a list of valid values.
'>
key
See Public/Private Key parameters for a list of valid values.
'>
This function is only available
if PHP is compiled using .
'>
This function is only available if
PHP is compiled with freetype support ()
'>
This function does not require the GD image library.'>
This function is affected by the interpolation method set by imagesetinterpolation.'>
imageAn image resource, returned by one of the image creation functions,
such as imagecreatetruecolor.'>
fontCan be 1, 2, 3, 4, 5 for built-in
fonts in latin2 encoding (where higher numbers corresponding to larger fonts) or any of your
own font identifiers registered with imageloadfont.
'>
font_indexA font resource, returned by imagepsloadfont.
'>
fontfile
The path to the TrueType font you wish to use.
Depending on which version of the GD library PHP is using, when
fontfile does not begin with a leading
/ then .ttf will be appended
to the filename and the library will attempt to search for that
filename along a library-defined font path.
When using versions of the GD library lower than 2.0.18, a space character,
rather than a semicolon, was used as the 'path separator' for different font files.
Unintentional use of this feature will result in the warning message:
Warning: Could not find/open font. For these affected versions, the
only solution is moving the font to a path which does not contain spaces.
In many cases where a font resides in the same directory as the script using it
the following trick will alleviate any include problems.
]]>
Note that open_basedir does
not apply to fontfile.
">
However, if libgd fails to output the image, this function returns &true;.'>
imagecolorallocate.">
Used as a return value by imagetypes
'>
Special color option which can be used instead of a color allocated with
imagecolorallocate or
imagecolorallocatealpha.
'>
An affine transformation type constant used by the imageaffinematrixget function.
'>
A style constant used by the imagefilledarc function.
'>
A type constant used by the imagegd2 function.
'>
Alpha blending effect used by the imagelayereffect function.
'>
Special GD filter used by the imagefilter function.
'>
Image type constant used by the image_type_to_mime_type
and image_type_to_extension functions.
'>
A special PNG filter, used by the imagepng function.
'>
Used together with imageflip, available as of PHP 5.5.0.
'>
Used together with imagesetinterpolation, available as of PHP 5.5.0.
'>
7.0.0T1Lib support was removed from PHP, thus this function was removed.
'>
The GD
and GD2 image formats are proprietary image formats of libgd. They have to be regarded
obsolete, and should only be used for development and testing
purposes.'>
dbm_identifierThe DBM link identifier,
returned by dbmopen.'>
PHP implements a superset of JSON as specified in the original
RFC 7159.
'>
handleA cURL handle returned by
curl_init.'>
multi_handleA cURL multi handle returned by
curl_multi_init.'>
share_handleA cURL share handle returned by
curl_share_init.'>
8.0.0handle expects a CurlHandle
instance now; previously, a resource was expected.
'>
8.0.0multi_handle expects a CurlMultiHandle
instance now; previously, a resource was expected.
'>
8.0.0share_handle expects a CurlShareHandle
instance now; previously, a resource was expected.
'>
Each field is converted to the appropriate PHP type, except:
Dates are left as strings.
DateTime values are converted to strings.
Integers outside the range
PHP_INT_MIN..PHP_INT_MAX are
returned as strings.
Before dbase 7.0.0, booleans (L) were converted to 1 or
0.
'>
broker
An Enchant broker returned by enchant_broker_init.
'>
dictionary
An Enchant dictionary returned by enchant_broker_request_dict
or enchant_broker_request_pwl_dict.
'>
8.0.0broker expects an EnchantBroker instance now;
previoulsy, a &resource; was expected.
'>
8.0.0dictionary expects an EnchantDictionary instance now;
previoulsy, a &resource; was expected.
'>
imapAn IMAP stream returned by
imap_open.'>
Specifies where in the mailbox hierarchy
to start searching.There are two special characters you can
pass as part of the pattern:
'*' and '%'.
'*' means to return all mailboxes. If you pass
pattern as '*', you will
get a list of the entire mailbox hierarchy.
'%'
means to return the current level only.
'%' as the pattern
parameter will return only the top level
mailboxes; '~/mail/%' on UW_IMAPD will return every mailbox in the ~/mail directory, but none in subfolders of that directory.'>
Passing untrusted data to this parameter is insecure, unless
imap.enable_insecure_rsh is disabled.
'>
The int codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}")'>
The return type will be int unless the code point was passed as a UTF-8 string, in which case a string will be returned.'>
The Unicode property to lookup (see the IntlChar::PROPERTY_* constants).'>
This function has been DEPRECATED as of PHP 7.4.0, and REMOVED as of PHP 8.0.0.
Instead the controls parameter of ldap_search should be used.
See also LDAP Controls for details.
'>
8.0.0controls is nullable now; previously, it defaulted to [].
'>
The internal encoding or the
character encoding specified by mb_regex_encoding
will be used as the character encoding for this function.'>
The
character encoding specified by mb_regex_encoding
will be used as the character encoding for this function by default.'>
The encoding
parameter is the character encoding. If it is omitted or &null;, the internal character
encoding value will be used.'>
Never use the e modifier when working on untrusted input. No automatic escaping will happen (as known from preg_replace). Not taking care of this will most likely create remote code execution vulnerabilities in your application.'>
8.0.0encoding is nullable now.
'>
One of the MCRYPT_ciphername constants, or the name of the algorithm as string.'>
Used for the initialization in CBC, CFB, OFB modes, and in some algorithms in STREAM mode. If you do not supply an IV, while it is needed for an algorithm, the function issues a warning and uses an IV with all its bytes set to "\0".'>
Used for the initialization in CBC, CFB, OFB modes, and in some algorithms in STREAM mode. If the provided IV size is not supported by the chaining mode or no IV was provided, but the chaining mode requires one, the function will emit a warning and return &false;.'>
One of the MCRYPT_MODE_modename constants, or one of the following strings: "ecb", "cbc", "cfb", "ofb", "nofb" or "stream".'>
connAn MCVE_CONN resource returned by
m_initengine.'>
Expiration Times for more info.'>
Memcached::getResultCode if necessary.'>
password algorithm constant denoting the algorithm to use when hashing the password.'>
password_hash.'>
password algorithm constants for documentation on the supported options for each algorithm.'>
8.0.0socket is a Socket instance now;
previously, it was a resource.
'>
8.0.0address is an AddressInfo instance now;
previously, it was a resource.
'>
List of Supported Timezones'>
Here you'll find the complete list of timezones supported by PHP, which are
meant to be used with e.g. date_default_timezone_set.
The behavior of timezones not listed here is undefined.The latest version of the timezone database can be
installed via PECL's timezonedb.
">
Please do not use any of the timezones
listed here (besides UTC), they only exist for backward compatible reasons, and may expose erroneous behavior.
'>
If you disregard the above warning, please also note that the IANA
timezone database that provides PHP's timezone support uses POSIX style
signs, which results in the Etc/GMT+n and
Etc/GMT-n time zones being reversed from common usage.
For example, the time zone 8 hours ahead of GMT that is used in China and
Western Australia (among other places) is actually
Etc/GMT-8 in this database, not
Etc/GMT+8 as you would normally expect.
Once again, it is strongly recommended that you use the correct time zone
for your location, such as Asia/Shanghai or
Australia/Perth for the above examples.
'>
These timezone abbreviations have to be regarded as highly volatile, i.e. they
might be different for each timezonedb release, and should not be relied upon.
It is strongly recommended to avoid timezone abbreviations.
'>
Every call to a date/time function will generate a E_NOTICE
if the time zone is not valid, and/or a E_STRICT
or E_WARNING message
if using the system settings or the TZ environment
variable. See also date_default_timezone_set'>
5.1.0
Now issues the E_STRICT and E_NOTICE
time zone errors.'>
timestamp
The optional timestamp parameter is an
int Unix timestamp that defaults to the current
local time if timestamp is omitted or &null;. In other
words, it defaults to the value of time.
'>
objectProcedural style only: A DateTime object
returned by date_create'>
objectProcedural style only: A DateTime object
returned by date_create.
The function modifies this object.'>
objectProcedural style only: A DateTimeZone object
returned by timezone_open'>
DateTime object for method chaining&return.falseforfailure;.'>
Date and Time Formats.'>
domnode_append_child.'>
DOMNode::appendChild.'>
This method may be called statically, but will issue an E_STRICT error.'>
While malformed HTML should load successfully, this function may generate E_WARNING errors when it encounters bad markup. libxml's error handling functions may be used to handle these errors.'>
The DOM extension uses UTF-8 encoding. Use utf8_encode and utf8_decode to work with texts in ISO-8859-1 encoding or iconv for other encodings.'>
When using json_encode on a DOMDocument object the result will be that of encoding an empty object.'>
The following examples use book.xml which contains the following:
]>
PHP BasicsJim SmithJane SmithPHP Basics provides an introduction to PHP.
]]]]>PHP Advanced ProgrammingJon Doe
]]>'>
Upon failure, an E_WARNING is emitted.
'>
The file pointer must be valid, and must point to
a file successfully opened by fopen or
fsockopen (and not yet closed by
fclose).'>
A file system pointer resource
that is typically created using fopen.'>
Because PHP's integer type is signed and many platforms use 32bit integers,
some filesystem functions may return unexpected results for files which
are larger than 2GB.
'>
As of PHP 5.6.1 can also be specified as INI_SCANNER_TYPED.
In this mode boolean, null and integer types are preserved when possible.
String values "true", "on" and "yes"
are converted to &true;. "false", "off", "no"
and "none" are considered &false;. "null" is converted to &null;
in typed mode. Also, all numeric strings are converted to integer type if it is possible.
'>
The gnupg identifier, from a call to
gnupg_init or gnupg.'>
The fingerprint key.'>
Throws a HaruException on error.'>
The ODBC connection identifier,
see odbc_connect for details.'>
% to match zero or more characters,
and _ to match a single character.'>
E_ERROR level
error if the callback function cannot be called, or was not specified.'>
Contains
the Oracle instance to connect to. It can be
an Easy Connect
string, or a Connect Name from
the tnsnames.ora file, or the name of a local
Oracle instance.
If not specified, PHP uses
environment variables such as TWO_TASK (on Linux)
or LOCAL (on Windows)
and ORACLE_SID to determine the
Oracle instance to connect to.
To use the Easy Connect naming method, PHP must be linked with Oracle
10g or greater Client libraries. The Easy Connect string for Oracle
10g is of the form:
[//]host_name[:port][/service_name]. From Oracle
11g, the syntax is:
[//]host_name[:port][/service_name][:server_type][/instance_name].
Further options were introduced with Oracle 19c, including timeout and keep-alive
settings. Refer to Oracle documentation. Service names can be found by running
the Oracle utility lsnrctl status on the database server
machine.
The tnsnames.ora file can be in the Oracle Net search path,
which
includes /your/path/to/instantclient/network/admin, $ORACLE_HOME/network/admin
and /etc. Alternatively set TNS_ADMIN
so that $TNS_ADMIN/tnsnames.ora is read. Make sure the web
daemon has read access to the file.
">
Determines
the character set used by the Oracle Client libraries. The character
set does not need to match the character set used by the database. If
it doesn't match, Oracle will do its best to convert data to and from
the database character set. Depending on the character sets this may
not give usable results. Conversion also adds some time overhead.
If not specified, the
Oracle Client libraries determine a character set from
the NLS_LANG environment variable.
Passing this parameter can
reduce the time taken to connect.
">
This
parameter is available since version PHP 5 (PECL OCI8 1.1) and accepts the
following values: OCI_DEFAULT,
OCI_SYSOPER and OCI_SYSDBA.
If either OCI_SYSOPER or
OCI_SYSDBA were specified, this function will try
to establish privileged connection using external credentials.
Privileged connections are disabled by default. To enable them you
need to set oci8.privileged_connect
to On.
PHP 5.3 (PECL OCI8 1.3.4) introduced the
OCI_CRED_EXT mode value. This tells Oracle to use
External or OS authentication, which must be configured in the
database. The OCI_CRED_EXT flag can only be used
with username of "/" and a empty password.
oci8.privileged_connect
may be On or Off.
OCI_CRED_EXT may be combined with the
OCI_SYSOPER or
OCI_SYSDBA modes.
OCI_CRED_EXT is not supported on Windows for
security reasons.
'>
For details on the data type mapping performed by
the OCI8 extension, see the datatypes
supported by the driver'>
An Oracle connection identifier,
returned by oci_connect, oci_pconnect,
or oci_new_connect.'>
Oracle version requirementThis function is available when PHP is linked with Oracle Database
libraries from version 10g onwards.'>
PerformanceWith older versions of
OCI8 or the Oracle Database, the client information can be set using the Oracle
DBMS_APPLICATION_INFO package. This is less efficient than
using oci_set_client_info.'>
Round-trip GotchaSome but not all OCI8 functions cause round-trips. Round-trips to the
database may not occur with queries when result caching is enabled.
'>
For
queries returning a large number of rows, performance can be
significantly improved by
increasing oci8.default_prefetch
or using oci_set_prefetch.
'>
A valid OCI8 statement
identifier created by oci_parse and executed
by oci_execute, or a REF
CURSOR statement identifier.">
The status
parameter is the status parameter supplied to a successful
call to pcntl_waitpid.'>
The note will not be visible if the document
is printed or viewed but it will show up if the document is converted to
pdf by either Acrobat Distiller™ or Ghostview.'>
&sm.disabled;'>
When safe mode is enabled, PHP checks whether
the files or directories being operated upon have the same UID (owner) as the
script that is being executed.'>
When safe mode is enabled, PHP checks whether
the directory in which the script is operating has the same UID (owner) as the
script that is being executed.'>
This function is affected by open_basedir.'>
Because this is a
language construct and not a function, it cannot be called using
variable functions.
'>
With safe mode enabled,
the command string is escaped with escapeshellcmd. Thus,
echo y | echo x becomes echo y \| echo x.'>
When
safe mode is enabled, you can only
execute files within the safe_mode_exec_dir.
For practical reasons, it is currently not allowed to have ..
components in the path to the executable.'>
safe mode.'>
This extension has no configuration directives defined in &php.ini;.'>
This extension has no resource types defined.'>
This extension has no constants defined.'>
No external libraries are needed to build this extension.'>
There is no installation needed to use these
functions; they are part of the PHP core.'>
Here's a short explanation of
the configuration directives.'>
The behaviour of these functions is affected by settings in &php.ini;.
'>
.'>
The constants below are defined by this extension, and
will only be available when the extension has either
been compiled into PHP or dynamically loaded at runtime.
'>
The constants below are always available as part of the PHP core.
'>
The classes below are defined by this extension, and
will only be available when the extension has either
been compiled into PHP or dynamically loaded at runtime.
'>
This extension requires PHP 5.'>
The constants below are defined by
this driver, and will only be available when the extension has been either
compiled into PHP or dynamically loaded at runtime. In addition, these
driver-specific constants should only be used if you are using this driver.
Using driver-specific attributes with another driver may result in
unexpected behaviour. PDO::getAttribute may be used to
obtain the PDO::ATTR_DRIVER_NAME attribute to check the
driver, if your code can run against multiple drivers.'>
An exception is raised even when the PDO::ATTR_ERRMODE attribute is not PDO::ERRMODE_EXCEPTION.'>
PECL extension
is not bundled with PHP.'>
PECL extension
is bundled with PHP.'>
Installation
of PECL extensions. Additional information such as new releases,
downloads, source files, maintainer information, and a CHANGELOG, can be
located here: '>
PECL
SVN here: '>
PECL
GIT here: '>
DLL for this
PECL extension is currently unavailable. See also the
building on Windows
section.'>
DLL files)
for this PECL extension are available from the PECL website.'>
PECL repository and is no longer bundled with
PHP as of PHP '>
The Windows version of PHP has built-in
support for this extension. You do not need to load any additional
extensions in order to use these functions.'>
safe mode'>
SQL safe mode'>
debug_levelAn integer which is formed by adding
together the XXX_TRACE constants.It is not recommended
to use MEMORY_TRACE. It is very slow and does not appear to be accurate.
ASSIGNMENT_TRACE is not implemented yet.To turn on all
functional traces (TIMING, FUNCTIONS, ARGS SUMMARY (like strace -c)) use the value 99'>
scaleThis optional parameter is used to set the number
of digits after the decimal place in the result. If omitted, it will default to the scale set
globally with the bcscale function, or fallback to 0 if
this has not been set.'>
If an int between -128 and 255 inclusive is provided, it is interpreted as
the ASCII value of a single character (negative values have 256 added in order to allow
characters in the Extended ASCII range). Any other integer is interpreted as a string
containing the decimal digits of the integer.'>
link_identifierA FrontBase link identifier
returned by fbsql_connect or
fbsql_pconnect.If optional and not specified,
the function will try to find an open link to the FrontBase server and if no
such link is found it will try to create one as if
fbsql_connect was called with no arguments.'>
resultA result identifier
returned by fbsql_query or
fbsql_db_query.'>
GMP object.'>
A GMP object, an &integer; or a numeric &string;.'>
resultProcedural style only: A result set
identifier returned by mysqli_query, mysqli_store_result,
mysqli_use_result or mysqli_stmt_get_result.'>
linkProcedural style only: A link identifier
returned by mysqli_connect or mysqli_init'>
stmtProcedural style only: A statement identifier
returned by mysqli_stmt_init.'>
mysqlnd.'>
MySQLnd always assumes the server default charset. This charset is sent during connection
hand-shake/authentication, which mysqlnd will use.Libmysqlclient uses the default charset set in the
my.cnf or by an explicit call to mysqli_options prior to
calling mysqli_real_connect, but after mysqli_init.'>
This function is supported when PHP
is installed as an Apache module webserver.
'>
SimpleXML has made a rule of adding
iterative properties to most methods. They cannot be viewed using var_dump
or anything else which can examine objects.'>
The column names returned by
SQLITE_ASSOC and SQLITE_BOTH will be
case-folded according to the value of the
sqlite.assoc_case configuration
option.'>
When the decode_binary
parameter is set to &true; (the default), PHP will decode the binary encoding
it applied to the data if it was encoded using the
sqlite_escape_string. You should normally leave this
value at its default, unless you are interoperating with databases created by
other sqlite capable applications.'>
This function cannot be used with
unbuffered result handles.'>
Two alternative syntaxes are
supported for compatibility with other database extensions (such as MySQL).
The preferred form is the first, where the dbhandle
parameter is the first parameter to the function.'>
The optional result_type
parameter accepts a constant and determines how the returned array will be
indexed. Using SQLITE_ASSOC will return only associative
indices (named fields) while SQLITE_NUM will return
only numerical indices (ordinal field numbers). SQLITE_BOTH
will return both associative and numerical indices.
SQLITE_BOTH is the default for this function.'>
Field names returned by this function
are case-sensitive.'>
This function sets NULL fields to
the PHP &null; value.'>
link_identifierThe mSQL connection.
If not specified, the last link opened by msql_connect
is assumed. If no such link is found, the function will try to establish a
link as if msql_connect was called, and use it.
'>
resultThe result resource that
is being evaluated. This result comes from a call to
msql_query.'>
field_offsetThe numerical field offset. The
field_offset starts at 1.'>
link_identifierThe MySQL connection. If the
link identifier is not specified, the last link opened by
mysql_connect is assumed. If no such link is found, it
will try to create one as if mysql_connect had been called
with no arguments. If no connection is found or established, an
E_WARNING level error is generated.
'>
link_identifierThe MySQL connection. If the
link identifier is not specified, the last link opened by
mysql_connect is assumed. If no connection is found or
established, an E_WARNING level error is
generated.'>
resultThe result resource that
is being evaluated. This result comes from a call to
mysql_query.'>
field_offsetThe numerical field offset. The
field_offset starts at 0. If
field_offset does not exist, an error of level
E_WARNING is also issued.'>
This extension was deprecated in PHP 5.5.0, and it was removed in PHP 7.0.0.
Instead, the MySQLi or PDO_MySQL extension should be used.
See also MySQL: choosing an API guide.
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.
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.
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.
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.5.0, and it
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:'>
Open non-persistent MySQL connections and result sets are automatically destroyed when a
PHP script finishes its execution. So, while explicitly closing open
connections and freeing result sets is optional, doing so is recommended.
This will immediately return resources to PHP and MySQL, which can
improve performance. For related information, see
freeing resources'>
This function is only available when
using the CT library interface to Sybase, and not with the DB library.
'>
This function is only available when
using the DB library interface to Sybase, and not with the CT library.'>
link_identifierThe Sybase connection. If the
link identifier is not specified, the last link opened by
sybase_connect is assumed. If no such link is found, it
will try to create one as if sybase_connect was called
with no arguments. If no connection is found or established, an
E_WARNING level error is generated.
'>
The optional parameter mode
determines the unit length. If it is 0 or omitted, the
default unit as specified for the page is used. In other cases, the coordinates
are measured in postscript points, disregarding the current unit.'>
modeThe optional parameter mode
determines the unit length. If it is 0 or omitted, the
default unit as specified for the page is used. In other cases, the coordinates
are measured in postscript points, disregarding the current unit.'>
pdf_documentThe document handle, returned by
cpdf_open.'>
Extended attributes have two different namespaces: user
and root. The user namespace is available to all users, while the root namespace
is available only to users with root privileges. xattr operates on the user
namespace by default, but this can be changed with the
flags parameter.'>
When specifying a numerical IPv6 address
(e.g. fe80::1), you must enclose the IP in square
brackets—for example, tcp://[fe80::1]:80.'>
IPv6 Support was added in PHP 5.0.0.
'>
Tidy object.'>
The config parameter
can be passed either as an array or as a string. If a string is passed,
it is interpreted as the name of the configuration file, otherwise, it is
interpreted as the options themselves. Check
&url.tidy.conf;
for an explanation about each option.The
encoding parameter sets the encoding for input/output
documents. The possible values for encoding are:
ascii, latin0, latin1,
raw, utf8, iso2022,
mac, win1252, ibm858,
utf16, utf16le,
utf16be, big5 and
shiftjis.'>
We do not recommend using a
threaded MPM in production with Apache 2. Use the prefork MPM, which is
the default MPM with Apache 2.0 and 2.2.
For information on why, read the related FAQ entry on using
Apache2 with a threaded MPM'>
Remember that when adding
path values in the Apache configuration files on Windows, all backslashes
such as c:\directory\file.ext should be converted to
forward slashes: c:/directory/file.ext. A trailing
slash may also be necessary for directories.'>
We highlight the currently most active
people on front page of the manual, but there are many more contributors who
currently help in our work or have provided a great amount of help to the project
in the past. There are a lot of unnamed people who help out with user
notes on manual pages, which continually get included in the references, the
work of whom we are also very thankful for. All of the lists provided below are in
alphabetical order.
'>
This function cannot
be used to manipulate the currently running (or chained) method.
'>
This function cannot
be used to manipulate the currently running (or chained) method.
'>
Sandbox support (required for
runkit_lint, runkit_lint_file,
and the Runkit_Sandbox class) is only available as of
PHP 5.1.0 or specially patched versions of PHP 5.0, and requires that thread
safety be enabled.
See the README file included in the runkit package for
more information.'>
By default, only
userspace functions may be removed, renamed, or modified. In order to
override internal functions, you must enable the
runkit.internal_override setting in &php.ini;.
'>
The public key subsystem
is used for managing public keys on a server to which the client is
already authenticated. To authenticate to a remote system
using public key authentication, use the
ssh2_auth_pubkey_file function instead.'>
writerOnly for procedural calls.
The XMLWriter instance that is being modified. This object is returned from a call to xmlwriter_open_uri or xmlwriter_open_memory.'>
8.0.0writer expects an XMLWriter
instance now; previously, a resource was expected.
'>
This function only works in WSDL mode.">
linkProcedural style only: The stomp link identifier returned by stomp_connect.">
headersAssociative array containing the additional headers (example: receipt).">
A transaction header may be specified, indicating that the message acknowledgment should be part of the named transaction.">
Stomp is inherently asynchronous. Synchronous communication can be implemented adding a receipt header. This will cause methods to not return anything until the server has acknowledged receipt of the message or until read timeout was reached.">
Relative paths will be resolved as if the current working directory was the one that contains the PHP binary. To use the calling script's working directory, use realpath or dirname(__FILE__).">
status constants for possible values.'>
type constants for possible values.'>
Neural network resource.'>
Neural network training data resource.'>
Either neural network resource or neural network trainining data resource.'>
No value is returned.'>
Returns &true; on success, or &false; otherwise.'>
Returns a neural network resource on success, or &false; on error.'>
Returns a train data resource on success, or &false; on error.'>
This function is only available if the fann extension has been build against libfann >= 2.2.'>
This function has been DEPRECATED as of Imagick 3.4.4. Relying on this function is highly discouraged.'>
Imagick::CHANNEL_DEFAULT. Refer to this list of channel constants'>
channel constants using bitwise operators. &imagick.default.channel.info;'>
ImagickException on error.'>
The behavior of the parameter bestfit changed in Imagick 3.0.0.
Before this version given dimensions 400x400 an image of dimensions 200x150 would be
left untouched. In Imagick 3.0.0 and later the image would be scaled up to size 400x300 as
this is the "best fit" for the given dimensions. If bestfit
parameter is used both width and height must be given.
'>
You need to have a valid openssl.cnf installed for
this function to operate correctly.
See the notes under the installation
section for more information.
'>
The optional parameter notext affects
the verbosity of the output; if it is &false;, then additional human-readable
information is included in the output. The default value of
notext is &true;.
'>
As with all the variant arithmetic functions, the parameters for this function
can be either a PHP native type (integer, string, floating point, boolean or
&null;), or an instance of a COM, VARIANT or DOTNET class. PHP native types
will be converted to variants using the same rules as found in the constructor
for the class. COM and DOTNET objects
will have the value of their default property taken and used as the variant value.
The variant arithmetic functions are wrappers around the similarly named
functions in the COM library; for more information on these functions, consult
the MSDN library. The PHP functions are named slightly differently; for example
variant_add in PHP corresponds to VarAdd()
in the MSDN documentation.
'>
This function does not exist in PHP 5; instead, you should use the regular
and more natural OO syntax to access properties or call methods.
'>
This
method requires the &php.ini; setting phar.readonly to be
set to 0 in order to work for Phar
objects. Otherwise, a PharException will be thrown.'>
This
method has been removed from the phar extension as of version 2.0.0. Alternative
implementations are available using Phar::compress,
Phar::decompress, Phar::compressFiles and
Phar::decompressFiles.'>
This
method has been removed from the phar extension as of version 2.0.0. Alternative
implementations are available using PharFileInfo::isCompressed,
PharFileInfo::decompress, and PharFileInfo::compress.'>
Phar::addFile, Phar::addFromString and Phar::offsetSet
save a new phar archive each time they are called. If performance is a concern,
Phar::buildFromDirectory or Phar::buildFromIterator
should be used instead.
'>
PharData::addFile, PharData::addFromString and PharData::offsetSet
save a new phar archive each time they are called. If performance is a concern,
PharData::buildFromDirectory or PharData::buildFromIterator
should be used instead.
'>
This extension requires the libxml PHP extension.
This means passing the ,
or prior to PHP 7.4 the ,
configuration flag, although this is implicitly accomplished because libxml
is enabled by default.
'>
This function is only available when PHP is compiled against libxml 20620 or later.'>
inotify_init'>
Emits
E_WARNING if call to this method fails
(i.e. not implemented).'>
The
streamWrapper::$context
property is updated if a valid context is passed to the caller function.'>
GmagickException on error.'>
return parameter
is set to &true;, then the export is returned as a string,
otherwise &null; is returned.'>
Datastructures'>
Exceptions'>
SPL provides a set of standard Exceptions.See also the '>
File Handling'>
SPL provides a number of classes to work with files.'>
Interfaces'>
SPL provides a set of interfaces.See also the '>
Interface list'>
Iterators'>
SPL provides a set of iterators to traverse over objects.'>
Miscellaneous Classes and Interfaces'>
Classes and interfaces which do not fit into the other SPL categories.'>
For maximum portability, it is recommended to always use forward slashes (/) as directory separator in ZIP filenames.'>
Win32 Error Code on failure.'>
WIN32_NO_ERROR on success&win32service.false.error;'>
The MIB defines the type of each object id. It has to be specified as a single character from the below list.
types=The type is taken from the MIBiINTEGERuINTEGERsSTRINGxHEX STRINGdDECIMAL STRINGnNULLOBJoOBJIDtTIMETICKSaIPADDRESSbBITS
If OPAQUE_SPECIAL_TYPES was defined while compiling the SNMP library, the following are also valid:
typesUunsigned int64Isigned int64FfloatDdouble
'>
Most of these will use the obvious corresponding ASN.1 type. 's', 'x', 'd' and 'b' are all different ways of specifying an OCTET STRING value, and
the 'u' unsigned type is also used for handling Gauge32 values.
'>
If the MIB-Files are loaded by into the MIB Tree with "snmp_read_mib" or by specifying it in the libsnmp config, '=' may be used as
the type parameter for all object ids as the type can then be automatically read from the MIB.
'>
Note that there are two ways to set a variable of the type BITS like e.g.
"SYNTAX BITS {telnet(0), ftp(1), http(2), icmp(3), snmp(4), ssh(5), https(6)}":
Using type "b" and a list of bit numbers. This method is not recommended since GET query for the same OID would return e.g. 0xF8.
Using type "x" and a hex number but without(!) the usual "0x" prefix.
See examples section for more details.
'>
&reftitle.errors;
This method does not throw any exceptions by default.
To enable throwing an SNMPException exception when some of library errors occur
the SNMP class parameter exceptions_enabled
should be set to a corresponding value. See
SNMP::$exceptions_enabled explanation for more details.
'>
callback function is called when the request is done.
It should match the following prototype: datais custom data passed to the request.resultrequest-specific result value; basically, the value returned by corresponding
system call.reqis optional request resource which can be used with functions like eio_get_last_error
'>
The request priority: EIO_PRI_DEFAULT, EIO_PRI_MIN, EIO_PRI_MAX, or &null;.
If &null; passed, pri internally is set to
EIO_PRI_DEFAULT.
'>
Avoid relative
paths
'>
TRADER_MA_TYPE_* series of constants should be used.'>
TRADER_MA_TYPE_* series of constants should be used.'>
TRADER_MA_TYPE_* series of constants should be used.'>
TRADER_MA_TYPE_* series of constants should be used.'>
TRADER_MA_TYPE_* series of constants should be used.'>
TRADER_MA_TYPE_* series of constants should be used.'>
TRADER_MA_TYPE_* series of constants should be used.'>
TRADER_MA_TYPE_* series of constants should be used.'>
TRADER_REAL_MIN to TRADER_REAL_MAX.'>
TRADER_REAL_MIN to TRADER_REAL_MAX.'>
read_preferenceThe read preference mode: MongoClient::RP_PRIMARY, MongoClient::RP_PRIMARY_PREFERRED, MongoClient::RP_SECONDARY, MongoClient::RP_SECONDARY_PREFERRED, or MongoClient::RP_NEAREST.tagsAn array of zero or more tag sets, where each tag set is itself an array of criteria used to match tags on replica set members.'>
Returns &true; on success, or &false; otherwise.'>
Emits E_WARNING if either parameter is invalid, or if one or more tag sets are provided with the MongoClient::RP_PRIMARY read preference mode.'>
This function returns an array describing the read preference. The array contains the values type for the string read preference mode (corresponding to the MongoClient constants), and tagsets containing a list of all tag set criteria. If no tag sets were specified, tagsets will not be present in the array.'>
wThe write concern. This may be an integer denoting the number of servers required to acknowledge the write, or a string mode (e.g. "majority").wtimeoutThe maximum number of milliseconds to wait for the server to satisfy the write concern.'>
Returns &true; on success, or &false; otherwise.'>
Emits E_WARNING if the w parameter is not an integer or string value.'>
This function returns an array describing the write concern. The array contains the values w for an integer acknowledgement level or string mode, and wtimeout denoting the maximum number of milliseconds to wait for the server to satisfy the write concern.'>
"maxTimeMS"Specifies a cumulative time limit in milliseconds for processing the operation on the server (does not include idle time). If the operation is not completed by the server within the timeout period, a MongoExecutionTimeoutException will be thrown.'>
"background"Builds the index in the background so that building an index does not block other database activities. Specify &true; to build in the background. The default value is &false;.Prior to MongoDB 2.6.0, index builds on secondaries were executed as foreground operations, irrespective of this option. See Building Indexes with Replica Sets for more information.'>
"dropDups"Specify &true; to force creation of a unique index where the collection may contain duplicate values for a key. MongoDB will index the first occurrence of a key and delete all subsequent documents from the collection that contain a duplicate value for that key. The default value is &false;."dropDups" may delete data from your database. Use with extreme caution.This option is not supported on MongoDB 2.8+. Index creation will fail if the collection contains duplicate values.'>
"expireAfterSeconds"The value of this option should specify the number of seconds after which a document should be considered expired and automatically removed from the collection. This option is only compatible with single-field indexes where the field will contain MongoDate values.This feature is available in MongoDB 2.2+. See Expire Data from Collections by Setting TTL for more information.'>
"name"A optional name that uniquely identifies the index.By default, the driver will generate an index name based on the index's field(s) and ordering or type. For example, a compound index array("x" => 1, "y" => -1) would be named "x_1_y_-1" and a geospatial index array("loc" => "2dsphere") would be named "loc_2dsphere". For indexes with many fields, it is possible that the generated name might exceed MongoDB's limit for index names. The "name" option may be used in that case to supply a shorter name.'>
"sparse"Specify &true; to create a sparse index, which only indexes documents containing a specified field. The default value is &false;.'>
"unique"Specify &true; to create a unique index. The default value is &false;. This option applies only to ascending/descending indexes.When MongoDB indexes a field, if a document does not have a value for the field, a &null; value is indexed. If multiple documents do not contain a field, a unique index will reject all but the first of those documents. The "sparse" option may be used to overcome this, since it will prevent documents without the field from being indexed.'>
This method will use the listCollections database command when communicating with MongoDB 2.8+. For previous database versions, the method will query the special system.namespaces collection.'>
"filter"Optional query criteria. If provided, this criteria will be used to filter the collections included in the result.Relevant fields that may be queried include "name" (collection name as a string, without the database name prefix) and "options" (object containing options used to create the collection)..MongoDB 2.6 and earlier versions require the "name" criteria, if specified, to be a string value (i.e. equality match). This is because the driver must prefix the value with the database name in order to query the system.namespaces collection. Later versions of MongoDB do not have this limitation, as the driver will use the listCollections command.'>
"includeSystemCollections"Boolean, defaults to &false;. Determines whether system collections should be included in the result.'>
"w"See Write Concerns. The default value for MongoClient is 1.'>
"wtimeout"Deprecated alias for "wTimeoutMS".'>
"wTimeoutMS"This option specifies the time limit, in milliseconds, for write concern acknowledgement. It is only applicable when "w" is greater than 1, as the timeout pertains to replication. If the write concern is not satisfied within the time limit, a MongoCursorException will be thrown. A value of 0 may be specified to block indefinitely. The default value for MongoClient is 10000 (ten seconds).'>
"fsync"Boolean, defaults to &false;. If journaling is enabled, it works exactly like "j". If journaling is not enabled, the write operation blocks until it is synced to database files on disk. If &true;, an acknowledged insert is implied and this option will override setting "w" to 0.If journaling is enabled, users are strongly encouraged to use the "j" option instead of "fsync". Do not use "fsync" and "j" simultaneously, as that will result in an error.'>
"socketTimeoutMS"This option specifies the time limit, in milliseconds, for socket communication. If the server does not respond within the timeout period, a MongoCursorTimeoutException will be thrown and there will be no way to determine if the server actually handled the write or not. A value of -1 may be specified to block indefinitely. The default value for MongoClient is 30000 (30 seconds).'>
"j"Boolean, defaults to &false;. Forces the write operation to block until it is synced to the journal on disk. If &true;, an acknowledged write is implied and this option will override setting "w" to 0.If this option is used and journaling is disabled, MongoDB 2.6+ will raise an error and the write will fail; older server versions will simply ignore the option.'>
"safe"Deprecated. Please use the write concern "w" option.'>
"timeout"Deprecated alias for "socketTimeoutMS".'>
Throws MongoCursorException if the "w" option is set and the write fails.Throws MongoCursorTimeoutException if the "w" option is set to a value greater than one and the operation takes longer than MongoCursor::$timeout milliseconds to complete. This does not kill the operation on the server, it is a client-side timeout. The operation in MongoCollection::$wtimeout is milliseconds.'>
Issues E_DEPRECATED warning'>
These fields may also overwrite those that would be created automatically by the driver, as described in the MongoDB core documentation for the files collection. Some practical use cases for this behavior would be to specify a custom chunkSize or _id for the file.'>
Returns the _id of the saved file document. This will be a generated MongoId unless an _id was explicitly specified in the metadata parameter.'>
An array of Write Options.keyvalue meaningw (int|string)Write concern valuewtimeout (int)Maximum time to wait for replicationorderedDetermines if MongoDB must apply this batch in order. Ordered writes execute serially (i.e. one at a time) and execution will stop after the first error. Unordered writes may execute in parallel and execution will not stop after the first error. Defaults to &true;j (bool)Wait for journaling on the primary. This value is discouraged, use WriteConcern insteadfsync (bool)Wait for fsync on the primary. This value is discouraged, use WriteConcern instead'>
The MongoCollection to execute the batch on. Its write concern will be copied and used as the default write concern if none is given as $write_options or during MongoWriteBatch::execute.'>
server An array containing the basic information about the server that was picked. keyvaluehashserver hash, example: localhost:27017;-;X;56052typeNode type (primary/secondary/mongos/arbiter): 2max_bson_sizeThe maximum BSON Size over the wire this node accepts: 16777216max_message_sizeThe maximum Message Size over the wire this node accepts: 48000000request_idThe request identifier for this message: 42 '>
writeOptionskeyvalueorderedboolean, if the operation (in case of batch operation) must be executed sequentually (ordered=true)writeConcernAn array of writeConcern options (see below)
writeConcern array valueskeyvaluefsyncboolean, force flushing to disk before returningjboolean, force journal write before returningwtimeoutinteger, milliseconds, maximum time the primary is allowed to wait to verify replicationwinteger=server count, or string=replication-tag
'>
protocolOptionskeyvaluemessage_lengthThe total size (in bytes) of the encoded message being sent over the wirerequest_idThe request identifier for this message: 42namespaceThe MongoDB namespace used for the protocol message dbname.collectionname '>
This extension that defines this class
is deprecated. Instead, the MongoDB extension should be used.
Alternatives to this class include:'>
This extension that defines this class
is deprecated. Instead, the MongoDB extension should be used.
There is no equivalent for this class in the new extension.'>
This extension that defines this method
is deprecated. Instead, the MongoDB extension should be used.
Alternatives to this method include:'>
This extension that defines this method
is deprecated. Instead, the MongoDB extension should be used.
There is no equivalent for this method in the new extension.'>
This extension that defines this method
is deprecated. Instead, the MongoDB extension should be used.
There is no equivalent for this method in the new extension, but there is an
alternative in the PHP library:'>
This extension is deprecated. Instead,
the MongoDB extension should be
used.'>
collationarrayobject
Collation allows users to specify language-specific rules for string comparison, such as rules for lettercase and accent marks. When specifying collation, the "locale" field is mandatory; all other collation fields are optional. For descriptions of the fields, see Collation Document.
If the collation is unspecified but the collection has a default collation, the operation uses the collation specified for the collection. If no collation is specified for the collection or for the operation, MongoDB uses the simple binary comparison used in prior versions for string comparisons.
This option is available in MongoDB 3.4+ and will result in an exception at execution time if specified for an older server version.
'>
keyVaultClientMongoDB\Driver\ManagerThe Manager used to route data key queries to a separate MongoDB cluster. By default, the current Manager and cluster is used.
'>
keyVaultNamespacestringA fully qualified namespace (e.g. "databaseName.collectionName") denoting the collection that contains all data keys used for encryption and decryption.
'>
kmsProvidersarray
A document containing the configuration for one or more KMS providers, which are used to encrypt data keys. Currently aws or local are supported and at least one must be specified.
The format for aws is as follows:
,
secretAccessKey:
}
]]>
The format for local is as follows:
}
]]>
'>
maxCommitTimeMSinteger
The maximum amount of time in milliseconds to allow a single
commitTransaction command to run.
If specified, maxCommitTimeMS must be a signed
32-bit integer greater than or equal to zero.
'>
readConcernMongoDB\Driver\ReadConcern
A read concern to apply to the operation.
This option is available in MongoDB 3.2+ and will result in an
exception at execution time if specified for an older server
version.
'>
readPreferenceMongoDB\Driver\ReadPreference
A read preference to use for selecting a server for the operation.
'>
sessionMongoDB\Driver\Session
A session to associate with the operation.
'>
If you are using a "session" which has a transaction
in progress, you cannot specify a "readConcern" or
"writeConcern" option. This will result in an
MongoDB\Driver\Exception\InvalidArgumentException
being thrown. Instead, you should set these two options when you create
the transaction with
MongoDB\Driver\Session::startTransaction.
'>
writeConcernMongoDB\Driver\WriteConcern
A write concern to apply to the operation.
'>
namespace (string)
A fully qualified namespace (e.g. "databaseName.collectionName").
'>
db (string)
The name of the database on which to execute the command.
'>
bulk (MongoDB\Driver\BulkWrite)
The write(s) to execute.
'>
command (MongoDB\Driver\Command)
The command to execute.
'>
query (MongoDB\Driver\Query)
The query to execute.
'>
typeMap (array)
Type map configuration.
'>
filter (arrayobject)
The query predicate.
An empty predicate will match all documents in the collection.
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).
'>
Returns MongoDB\Driver\Cursor on success.'>
Returns MongoDB\Driver\WriteResult on success.'>
Throws MongoDB\Driver\Exception\InvalidArgumentException if the "session" option is used with an associated transaction in combination with a "readConcern" or "writeConcern" option.'>
Throws MongoDB\Driver\Exception\InvalidArgumentException if the "session" option is used in combination with an unacknowledged write concern.'>
Throws MongoDB\Driver\Exception\BulkWriteException on any write failure (e.g. write error, failure to apply a write concern)'>
Throws MongoDB\Driver\Exception\InvalidArgumentException on argument parsing errors.'>
Throws MongoDB\Driver\Exception\AuthenticationException if authentication is needed and fails.'>
Throws MongoDB\Driver\Exception\ConnectionException if connection to the server fails (for reasons other than authentication).'>
Throws MongoDB\Driver\Exception\UnexpectedValueException if the input did not contain exactly one BSON document. Possible reasons include, but are not limited to, invalid BSON, extra data (after reading one BSON document), or an unexpected libbson error.'>
MongoDB\BSON\Decimal128 is only compatible with
MongoDB 3.4+. Attempting to use the BSON type with an earlier version of
MongoDB will result in an error.
'>
The output is consistent with the MongoDB\BSON\toJSON
function, which uses the driver-specific legacy extended JSON format. This
does not necessarily match the
relaxed
or canonical
extended JSON representations used by
MongoDB\BSON\toRelaxedExtendedJSON and
MongoDB\BSON\toCanonicalExtendedJSON, respectively.
'>
On Unix platforms, the MongoDB driver is sensitive to scripts that use the
fork() system call without also calling exec(). Users are advised not to
re-use MongoDB\Driver\Manager instances in a forked
child process.
'>
Because PHP's integer type is signed, some values returned by this
method may appear as negative integers on 32-bit platforms. The
"%u" formatter of sprintf may be
used to obtain a string representation of the unsigned decimal value.
'>
The "readPreference" option does not control the server
to which the driver issues the operation; it will always be executed on
this server object. Instead, it may be used when issuing the operation to a
secondary (from a replica set connection, not standalone) or mongos node to
ensure that the driver sets the wire protocol accordingly or adds the read
preference to the operation, respectively.
'>
It is the caller's responsibility to ensure that the server is capable
of executing the write operation. For example, executing a write operation
on a secondary (excluding its "local" database) will fail.
'>
A request must be created via radius_create_request before this function can be called.'>
typeThe attribute type.'>
radius_handleThe RADIUS resource.'>
optionsA bitmask of the attribute options. The available options include RADIUS_OPTION_TAGGED and RADIUS_OPTION_SALT.'>
tagThe attribute tag. This parameter is ignored unless the RADIUS_OPTION_TAGGED option is set.'>
vendorThe vendor ID.'>
fd
The file descriptor, which is expected to be either a file
resource or an int. An int
will be assumed to be a file descriptor that can be passed directly to
the underlying system call.
In almost all cases, you will want to provide a file resource.
'>
Each resource has an associated soft and hard limit. The soft
limit is the value that the kernel enforces for the corresponding
resource. The hard limit acts as a ceiling for the soft limit.
An unprivileged process may only set its soft limit to a value
from 0 to the hard limit, and irreversibly lower its hard limit.
'>
An optional argument defining the encoding used when converting characters.
If omitted, encoding defaults to the value of the
default_charset configuration
option.
Although this argument is technically optional, you are highly encouraged to
specify the correct value for your code
if the default_charset
configuration option may be set incorrectly for the given input.
'>
format
The format string is composed of zero or more directives:
ordinary characters (excluding %) that are
copied directly to the result and conversion
specifications, each of which results in fetching its
own parameter.
A conversion specification follows this prototype:
%[argnum$][flags][width][.precision]specifier.
Argnum
An integer followed by a dollar sign $,
to specify which number argument to treat in the conversion.
FlagsFlag&Description;-
Left-justify within the given field width;
Right justification is the default
+
Prefix positive numbers with a plus sign
+; Default only negative
are prefixed with a negative sign.
(space)
Pads the result with spaces.
This is the default.
0
Only left-pads numbers with zeros.
With s specifiers this can
also right-pad with zeros.
'(char)
Pads the result with the character (char).
Width
An integer that says how many characters (minimum)
this conversion should result in.
Precision
A period . followed by an integer
who's meaning depends on the specifier:
For e, E,
f and F
specifiers: this is the number of digits to be printed
after the decimal point (by default, this is 6).
For g, G,
h and H
specifiers: this is the maximum number of significant
digits to be printed.
For s specifier: it acts as a cutoff point,
setting a maximum character limit to the string.
If the period is specified without an explicit value for precision,
0 is assumed.
Attempting to use a position specifier greater than
PHP_INT_MAX will generate warnings.
SpecifiersSpecifier&Description;%
A literal percent character. No argument is required.
b
The argument is treated as an integer and presented
as a binary number.
c
The argument is treated as an integer and presented
as the character with that ASCII.
d
The argument is treated as an integer and presented
as a (signed) decimal number.
e
The argument is treated as scientific notation (e.g. 1.2e+2).
E
Like the e specifier but uses
uppercase letter (e.g. 1.2E+2).
f
The argument is treated as a float and presented
as a floating-point number (locale aware).
F
The argument is treated as a float and presented
as a floating-point number (non-locale aware).
g
General format.
Let P equal the precision if nonzero, 6 if the precision is omitted,
or 1 if the precision is zero.
Then, if a conversion with style E would have an exponent of X:
If P > X ≥ −4, the conversion is with style f and precision P − (X + 1).
Otherwise, the conversion is with style e and precision P − 1.
G
Like the g specifier but uses
E and f.
h
Like the g specifier but uses F.
Available as of PHP 8.0.0.
H
Like the g specifier but uses
E and F. Available as of PHP 8.0.0.
o
The argument is treated as an integer and presented
as an octal number.
s
The argument is treated and presented as a string.
u
The argument is treated as an integer and presented
as an unsigned decimal number.
x
The argument is treated as an integer and presented
as a hexadecimal number (with lowercase letters).
X
The argument is treated as an integer and presented
as a hexadecimal number (with uppercase letters).
The c type specifier ignores padding and width
Attempting to use a combination of the string and width specifiers with character sets that require more than one byte per character may result in unexpected results
Variables will be co-erced to a suitable type for the specifier:
Type HandlingTypeSpecifiersstringsintd,
u,
c,
o,
x,
X,
bfloate,
E,
f,
F,
g,
G,
h,
H
'>
Prior to PHP 8.0.0, if needle is not a string, it is converted
to an integer and applied as the ordinal value of a character.
This behavior is deprecated as of PHP 7.3.0, and relying on it is highly
discouraged. Depending on the intended behavior, the
needle should either be explicitly cast to string,
or an explicit call to chr should be performed.
'>
5.6.0
The default value for the encoding parameter was
changed to be the value of the
default_charset configuration
option.
'>
filter
The ID of the filter to apply. The
manual page lists the available filters.
If omitted, FILTER_DEFAULT will be used, which is
equivalent to
FILTER_UNSAFE_RAW.
This will result in no filtering taking place by default.
'>
The sources of randomness used for this function are as follows:
On Windows,
CryptGenRandom
will always be used. As of PHP 7.2.0, the
CNG-API
will always be used instead.
On Linux, the
getrandom(2)
syscall will be used if available.
On other platforms, /dev/urandom will be used.
If none of the aforementioned sources are available, then an
Exception will be thrown.
'>
If an appropriate source of randomness cannot be found,
an Exception will be thrown.
If invalid parameters are given, a TypeError
will be thrown.
'>
Although this function was added to PHP in PHP 7.0, a
userland implementation
is available for PHP 5.2 to 5.6, inclusive.
'>
This function has been
REMOVED in PECL uopz 5.0.0.'>
8.0.0parser expects an XMLParser
instance now; previously, a resource was expected.
'>
All encrypted client streams now enable peer verification by default. By
default, this will use OpenSSL's default CA bundle to verify the peer
certificate. In most cases, no changes will need to be made to communicate
with servers with valid SSL certificates, as distributors generally
configure OpenSSL to use known good CA bundles.
The default CA bundle may be overridden on a global basis by setting
either the openssl.cafile or openssl.capath configuration setting, or on a
per request basis by using the
cafile or
capath
context options.
While not recommended in general, it is possible to disable peer
certificate verification for a request by setting the
verify_peer
context option to &false;, and to disable peer name validation by setting
the verify_peer_name
context option to &false;.
'>